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

#include <processing_module_factory_interface.h>

Collaboration diagram for intel_adsp::IoPinsInfo:

Data Fields
PinEndpoint *	sources
	pointer on a PinEndpoint array with "sources_count" elements
PinEndpoint *	sinks
	pointer on a PinEndpoint array with "sinks_count" elements
FwdEvent *	events
	pointer on a FwdEvents array with "events_count" elements
uint8_t *	pins_mem_pool
	description of buffer reserved for DP queue objects and buffers used for all additional input and output pins (e.g. reference pin)
size_t	pins_mem_pool_size

Detailed Description

holds information about pins of a module.

For each custom module, input pins of a module are associated to some "sources" PinEndPoint and output pins are associated to some sinks "PinEndPoint" objects. Those sinks and sources objects shall be instantiated by the custom module and delivered to the ADSP System with this IoPinsInfo structure (through ProcessingModuleFactoryInterface::Create()).

Note: The "pin" of a module is purely conceptual and has no programmatic correspondence. A module has as many input/output pins as input/output streams which can be driven through it.

Field Documentation

◆ events

FwdEvent* intel_adsp::IoPinsInfo::events

pointer on a FwdEvents array with "events_count" elements

A module is required to provide some FwdEvents arrays to allow the ADSP System to handle key phrase detection.

◆ pins_mem_pool

uint8_t* intel_adsp::IoPinsInfo::pins_mem_pool

description of buffer reserved for DP queue objects and buffers used for all additional input and output pins (e.g. reference pin)

◆ pins_mem_pool_size

size_t intel_adsp::IoPinsInfo::pins_mem_pool_size

◆ sinks

PinEndpoint* intel_adsp::IoPinsInfo::sinks

pointer on a PinEndpoint array with "sinks_count" elements

A module is required to provide some PinEndpoint arrays to allow the ADSP System to drive stream out of the module.

◆ sources

PinEndpoint* intel_adsp::IoPinsInfo::sources

pointer on a PinEndpoint array with "sources_count" elements

A module is required to provide some PinEndpoint arrays to allow the ADSP System to drive streams into the module.

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

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