dsp_fw::ModuleInitialSettingsConcrete Struct Reference

concrete implementation of the intel_adsp::ModuleInitialSettingsInterface More...

#include <module_initial_settings_concrete.h>

Inheritance diagram for dsp_fw::ModuleInitialSettingsConcrete:

Collaboration diagram for dsp_fw::ModuleInitialSettingsConcrete:

Public Member Functions
	ModuleInitialSettingsConcrete (DwordArray const &cfg_ipc_msg)
	Initializes a new ModuleInitialSettingsConcrete instance given an INIT_INSTANCE IPC message blob.
void	DeduceBaseModuleCfgExt (size_t in_pins_count, size_t out_pins_count)
	Extrapolates some hard-coded BaseModuleCfgExt based on the legacy BaseModuleCfg and the given input count and output count.
virtual void const *	GetUntypedItem (intel_adsp::ModuleInitialSettingsKey key, size_t &length)
	Gets the untyped value array of the settings item for the given key.
bool	IsParsable (void) const
	Indicates if the given INIT_INSTANCE IPC message is parse-able.
BaseModuleCfg const *	GetBaseModuleCfg (void) const
	Gets pointer on the BaseModuleCfg data retrieved from the IPC message.
BaseModuleCfgExt const *	GetBaseModuleCfgExt (void) const
	Gets pointer on the BaseModuleCfgExt data retrieved from the IPC message.

Detailed Description

concrete implementation of the intel_adsp::ModuleInitialSettingsInterface

Allow to retrieve the settings items in the INIT_INSTANCE IPC message

Constructor & Destructor Documentation

ModuleInitialSettingsConcrete()

dsp_fw::ModuleInitialSettingsConcrete::ModuleInitialSettingsConcrete ( DwordArray const & cfg_ipc_msg )

explicit

Initializes a new ModuleInitialSettingsConcrete instance given an INIT_INSTANCE IPC message blob.

Member Function Documentation

DeduceBaseModuleCfgExt()

void dsp_fw::ModuleInitialSettingsConcrete::DeduceBaseModuleCfgExt	(	size_t	in_pins_count,
		size_t	out_pins_count )

Extrapolates some hard-coded BaseModuleCfgExt based on the legacy BaseModuleCfg and the given input count and output count.

Remarks

If BaseModuleCfgExt was actually already part of the INIT_INSTANCE IPC message, nothing is performed.

GetBaseModuleCfg()

BaseModuleCfg const * dsp_fw::ModuleInitialSettingsConcrete::GetBaseModuleCfg ( void ) const

inline

Gets pointer on the BaseModuleCfg data retrieved from the IPC message.

GetBaseModuleCfgExt()

BaseModuleCfgExt const * dsp_fw::ModuleInitialSettingsConcrete::GetBaseModuleCfgExt ( void ) const

inline

Gets pointer on the BaseModuleCfgExt data retrieved from the IPC message.

GetUntypedItem()

virtual void const * dsp_fw::ModuleInitialSettingsConcrete::GetUntypedItem ( intel_adsp::ModuleInitialSettingsKey key, size_t & length )

virtual

Gets the untyped value array of the settings item for the given key.

Note

In this methods it is assumed that the given INIT_INSTANCE IPC message has a valid content

Warning

IsParsable() result shall have been checked before invoking this method.

Implements intel_adsp::ModuleInitialSettingsInterface.

IsParsable()

bool dsp_fw::ModuleInitialSettingsConcrete::IsParsable ( void ) const

inline

Indicates if the given INIT_INSTANCE IPC message is parse-able.

Field Documentation

do_not_use1

uint16_t dsp_fw::ModuleInitialSettingsConcrete::do_not_use1

do_not_use2

uint16_t dsp_fw::ModuleInitialSettingsConcrete::do_not_use2

do_not_use3

uint8_t dsp_fw::ModuleInitialSettingsConcrete::do_not_use3[8]

do_not_use4

uint32_t dsp_fw::ModuleInitialSettingsConcrete::do_not_use4

do_not_use5

InputPinFormat dsp_fw::ModuleInitialSettingsConcrete::do_not_use5[INPUT_PIN_COUNT]

do_not_use6

OutputPinFormat dsp_fw::ModuleInitialSettingsConcrete::do_not_use6[OUTPUT_PIN_COUNT]

[struct]

struct { ... } dsp_fw::ModuleInitialSettingsConcrete::placeholder

tlv

BaseModuleCfgExt dsp_fw::ModuleInitialSettingsConcrete::tlv

---

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

• /home/lrg/work/sof-dox-work/src/include/sof/audio/module_adapter/iadk/module_initial_settings_concrete.h