ipc4_module_bind_unbind Struct Reference

Module pin binding and unbinding command structure (SOF_IPC4_MOD_BIND / UNBIND). More...

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

Data Fields
union {
uint32_t   dat
	Raw 32-bit Primary register value. More...
struct {
uint32_t   module_id: 16
	Source module class identifier. More...
uint32_t   instance_id: 8
	Source module instance identifier. More...
uint32_t   type: 5
	Opcode: SOF_IPC4_MOD_BIND (5) or SOF_IPC4_MOD_UNBIND (6). More...
uint32_t   rsp: 1
	Direction: 0 for request (SOF_IPC4_MESSAGE_DIR_MSG_REQUEST). More...
uint32_t   msg_tgt: 1
	Target: 1 for module message (SOF_IPC4_MESSAGE_TARGET_MODULE_MSG). More...
uint32_t   _reserved_0: 1
	Reserved hardware control bit. More...
}   r
}	primary
union {
uint32_t   dat
	Raw 32-bit Extension register value. More...
struct {
uint32_t   dst_module_id: 16
	Destination module class identifier. More...
uint32_t   dst_instance_id: 8
	Destination module instance identifier. More...
uint32_t   dst_queue: SOF_IPC4_DST_QUEUE_ID_BITFIELD_SIZE
	Destination input queue/pin index (0..7). More...
uint32_t   src_queue: SOF_IPC4_SRC_QUEUE_ID_BITFIELD_SIZE
	Source output queue/pin index (0..7). More...
uint32_t   _reserved_2: 2
	Reserved hardware control bits. More...
}   r
}	extension

Detailed Description

Module pin binding and unbinding command structure (SOF_IPC4_MOD_BIND / UNBIND).

Sent by host to connect two module instances across pins (queues), or sever an existing link.

Field Documentation

_reserved_0

uint32_t ipc4_module_bind_unbind::_reserved_0

Reserved hardware control bit.

_reserved_2

uint32_t ipc4_module_bind_unbind::_reserved_2

Reserved hardware control bits.

dat

uint32_t ipc4_module_bind_unbind::dat

Raw 32-bit Primary register value.

Raw 32-bit Extension register value.

dst_instance_id

uint32_t ipc4_module_bind_unbind::dst_instance_id

Destination module instance identifier.

dst_module_id

uint32_t ipc4_module_bind_unbind::dst_module_id

Destination module class identifier.

dst_queue

uint32_t ipc4_module_bind_unbind::dst_queue

Destination input queue/pin index (0..7).

[union]

union { ... } ipc4_module_bind_unbind::extension

instance_id

uint32_t ipc4_module_bind_unbind::instance_id

Source module instance identifier.

module_id

uint32_t ipc4_module_bind_unbind::module_id

Source module class identifier.

msg_tgt

uint32_t ipc4_module_bind_unbind::msg_tgt

Target: 1 for module message (SOF_IPC4_MESSAGE_TARGET_MODULE_MSG).

[union]

union { ... } ipc4_module_bind_unbind::primary

[struct] [1/2]

struct { ... } ipc4_module_bind_unbind::r

[struct] [2/2]

struct { ... } ipc4_module_bind_unbind::r

rsp

uint32_t ipc4_module_bind_unbind::rsp

Direction: 0 for request (SOF_IPC4_MESSAGE_DIR_MSG_REQUEST).

src_queue

uint32_t ipc4_module_bind_unbind::src_queue

Source output queue/pin index (0..7).

type

uint32_t ipc4_module_bind_unbind::type

Opcode: SOF_IPC4_MOD_BIND (5) or SOF_IPC4_MOD_UNBIND (6).

---

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

• src/include/ipc4/module.h