Namespaces
namespace	internal

namespace	system

Data Structures
struct	ConfigurationFragmentPosition
	Scoped enumeration which defines location of a configuration message fragment in the whole message. More...

class	DetectorModuleInterface

struct	ErrorCode
	Scoped enumeration of common error code values which can be reported to ADSP System. More...

struct	FixedArray

struct	FwdEvent

struct	InputStreamBuffer
	Descriptor of the data stream buffer extracted from a input module pin. More...

struct	InputStreamFlags
	defines the bitfield structure of flags associated to an InputStreamBuffer More...

struct	IoPinsInfo
	holds information about pins of a module. More...

class	KpbInterface
	Version 1 KPB service interface for IADK modules. More...

class	KpbInterfaceV2
	Version 2 KPB service interface for IADK modules. More...

class	ModuleInitialSettings
	The set of settings item given for initialization of a Module instance. More...

struct	ModuleInitialSettingsInterface
	Defines the interface to retrieve untyped items based on ModuleInitialSettingsKey values. More...

struct	ModuleInitialSettingsItem
	Helps to identify type of a ModuleInitialSettings item referenced by its KEY. More...

struct	ModuleInitialSettingsItem< IN_PINS_FORMAT >
	Boilerplate to identify type of the ModuleInitialSettings item associated to the "IN_PINS_FORMAT" key. More...

struct	ModuleInitialSettingsItem< LEGACY_STRUCT >
	Boilerplate to identify type of the ModuleInitialSettings item associated to the "LEGACY_STRUCT" key. More...

struct	ModuleInitialSettingsItem< OUT_PINS_FORMAT >
	Boilerplate to identify type of the ModuleInitialSettings item associated to the "OUT_PINS_FORMAT" key. More...

struct	OutputStreamBuffer
	Descriptor of the data stream buffer to inject into an output module pin. More...

struct	ProcessingMode
	Scoped enumeration which defines processing mode values. More...

class	ProcessingModuleFactoryInterface
	The ProcessingModuleFactoryInterface class defines requirements for creating a processing module controllable by the ADSP System. More...

class	ProcessingModuleInterface
	The ProcessingModuleInterface class defines the interface that user-defined module shall comply with to be manageable by the ADSP System. More...

struct	ProcessingModulePrerequisites
	Descriptor on prerequisites for ProcessingModuleInterface instance creation. More...

struct	StreamBufferAlignment
	"Scoped enumeration" of values which specify data buffer alignment of input or output stream buffer. More...

class	SystemAgentInterface
	The SystemAgentInterface is a mediator to allow loadable module to interact with the ADSP System. More...

class	SystemAgentInterface2

class	SystemAgentInterface3

Typedefs
typedef void *	PinEndpoint
	defines type of the pin endpoint.

Enumerations
enum	ModuleInitialSettingsKey { LEGACY_STRUCT = 0 , IN_PINS_FORMAT , OUT_PINS_FORMAT }
	Enumeration values of keys to access to the ModuleInitialSettings items. More...

Functions
AdspErrorCode	GetKpbServiceInterface (uint32_t version, struct system_service_iface **iface)
	Get the IADK KPB service interface.

Typedef Documentation

◆ PinEndpoint

typedef void* intel_adsp::PinEndpoint

defines type of the pin endpoint.

A custom module is required to provide to the ADSP System some PinEndpoint value arrays. Arrays length shall be as long as it has input and output pins. (ref ProcessingModuleFactoryInterface::Create()).

Enumeration Type Documentation

◆ ModuleInitialSettingsKey

enum intel_adsp::ModuleInitialSettingsKey

Enumeration values of keys to access to the ModuleInitialSettings items.

Enumerator

LEGACY_STRUCT

Key value to retrieve the LegacyModuleInitialSettings item from the ModuleInitialSettings.

Deprecated:: New module shall not work with this item as it will be removed in next API release.

IN_PINS_FORMAT

Key value to retrieve the array of InputPinFormat item from the ModuleInitialSettings.

OUT_PINS_FORMAT

Key value to retrieve the array of OutputPinFormat item from the ModuleInitialSettings.

Function Documentation

◆ GetKpbServiceInterface()

AdspErrorCode intel_adsp::GetKpbServiceInterface	(	uint32_t	version,
		struct system_service_iface **	iface
	)

Get the IADK KPB service interface.

Parameters

version	Requested INTERFACE_VERSION_KPB_SERVICE_* version.
iface	Location for the returned KpbInterface or KpbInterfaceV2 instance.

Returns: ADSP_NO_ERROR, or ADSP_SERVICE_VERSION_UNAVAILABLE for unsupported versions.

Namespaces

Data Structures

Typedefs