ipc4_module_init_instance Struct Reference

Module instance creation command structure (SOF_IPC4_MOD_INIT_INSTANCE). 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
	Module class ID index from the FW manifest. More...
uint32_t   instance_id: 8
	Module instance ID unique within the module class (0..max_instances-1). More...
uint32_t   type: 5
	Opcode: SOF_IPC4_MOD_INIT_INSTANCE (0). 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   param_block_size: 16
	Size of initialization payload in 32-bit DWORDs. More...
uint32_t   ppl_instance_id: 8
	ID of parent pipeline, or IPC4_INVALID_PIPELINE_ID. More...
uint32_t   core_id: 4
	Target DSP core ID on which this instance will execute (platform-dependent, 0..CONFIG_CORE_COUNT - 1). More...
uint32_t   proc_domain: 1
	Processing domain (0 = Low-Latency LL, 1 = Data Processing DP). More...
uint32_t   extended_init: 1
	1 if extended initialization structures follow. More...
uint32_t   _hw_reserved_2: 2
	Reserved hardware bits. More...
}   r
}	extension

Detailed Description

Module instance creation command structure (SOF_IPC4_MOD_INIT_INSTANCE).

Field Documentation

_hw_reserved_2

uint32_t ipc4_module_init_instance::_hw_reserved_2

Reserved hardware bits.

_reserved_0

uint32_t ipc4_module_init_instance::_reserved_0

Reserved hardware control bit.

core_id

uint32_t ipc4_module_init_instance::core_id

Target DSP core ID on which this instance will execute (platform-dependent, 0..CONFIG_CORE_COUNT - 1).

dat

uint32_t ipc4_module_init_instance::dat

Raw 32-bit Primary register value.

Raw 32-bit Extension register value.

extended_init

uint32_t ipc4_module_init_instance::extended_init

1 if extended initialization structures follow.

[union]

union { ... } ipc4_module_init_instance::extension

instance_id

uint32_t ipc4_module_init_instance::instance_id

Module instance ID unique within the module class (0..max_instances-1).

module_id

uint32_t ipc4_module_init_instance::module_id

Module class ID index from the FW manifest.

msg_tgt

uint32_t ipc4_module_init_instance::msg_tgt

Target: 1 for module message (SOF_IPC4_MESSAGE_TARGET_MODULE_MSG).

param_block_size

uint32_t ipc4_module_init_instance::param_block_size

Size of initialization payload in 32-bit DWORDs.

ppl_instance_id

uint32_t ipc4_module_init_instance::ppl_instance_id

ID of parent pipeline, or IPC4_INVALID_PIPELINE_ID.

[union]

union { ... } ipc4_module_init_instance::primary

proc_domain

uint32_t ipc4_module_init_instance::proc_domain

Processing domain (0 = Low-Latency LL, 1 = Data Processing DP).

[struct] [1/2]

struct { ... } ipc4_module_init_instance::r

[struct] [2/2]

struct { ... } ipc4_module_init_instance::r

rsp

uint32_t ipc4_module_init_instance::rsp

Direction: 0 for request (SOF_IPC4_MESSAGE_DIR_MSG_REQUEST).

type

uint32_t ipc4_module_init_instance::type

Opcode: SOF_IPC4_MOD_INIT_INSTANCE (0).

---

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

• src/include/ipc4/module.h