ipc4_message_reply Struct Reference

Standard 64-bit IPC4 message reply envelope. More...

#include <src/include/ipc4/header.h>

Data Fields
union {
uint32_t   dat
	Raw 32-bit Primary register value. More...
struct {
uint32_t   status: 24
	Command processing status (one of enum ipc4_status). More...
uint32_t   type: 5
	Message type, symmetric to the incoming request. More...
uint32_t   rsp: 1
	Direction: 1 for reply (SOF_IPC4_MESSAGE_DIR_MSG_REPLY). More...
uint32_t   msg_tgt: 1
	Target: symmetric to request (FW_GEN_MSG or MODULE_MSG). More...
uint32_t   _reserved_0: 1
	Hardware control reserved bit. More...
}   r
}	primary
union {
uint32_t   dat
	Raw 32-bit Extension register value. More...
struct {
uint32_t   rsvd1: 30
	Extension reply data, transfer length, or additional status information. More...
uint32_t   _reserved_2: 2
	Hardware control reserved bits. More...
}   r
}	extension

Detailed Description

Standard 64-bit IPC4 message reply envelope.

Written to the mailbox registers by the DSP firmware upon command completion. The primary register contains the processing status code in its lower 24 bits.

Field Documentation

_reserved_0

uint32_t ipc4_message_reply::_reserved_0

Hardware control reserved bit.

_reserved_2

uint32_t ipc4_message_reply::_reserved_2

Hardware control reserved bits.

dat

uint32_t ipc4_message_reply::dat

Raw 32-bit Primary register value.

Raw 32-bit Extension register value.

[union]

union { ... } ipc4_message_reply::extension

msg_tgt

uint32_t ipc4_message_reply::msg_tgt

Target: symmetric to request (FW_GEN_MSG or MODULE_MSG).

[union]

union { ... } ipc4_message_reply::primary

[struct] [1/2]

struct { ... } ipc4_message_reply::r

[struct] [2/2]

struct { ... } ipc4_message_reply::r

rsp

uint32_t ipc4_message_reply::rsp

Direction: 1 for reply (SOF_IPC4_MESSAGE_DIR_MSG_REPLY).

rsvd1

uint32_t ipc4_message_reply::rsvd1

Extension reply data, transfer length, or additional status information.

status

uint32_t ipc4_message_reply::status

Command processing status (one of enum ipc4_status).

type

uint32_t ipc4_message_reply::type

Message type, symmetric to the incoming request.

---

The documentation for this struct was generated from the following file:

• src/include/ipc4/header.h