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

Inheritance diagram for intel_adsp::SystemAgentInterface:

Data Structures
struct	ErrorCode
	Scoped enumeration of error code value which can be reported by a SystemAgentInterface object. More...

Public Member Functions
virtual void	CheckIn (ProcessingModuleInterface &processing_module, ModuleHandle &module_handle, LogHandle *&log_handle)=0
	Allows a ProcessingModuleInterface instance to be registered in the ADSP System.
virtual int	CheckIn (ProcessingModuleFactoryInterface &module_factory, ModulePlaceholder module_placeholder, size_t, uint32_t, const void , void , void *)=0
	Allows a ProcessingModuleFactoryInterface instance to be registered in the ADSP System.
virtual SystemService const &	GetSystemService (void)=0
	Gets the SystemService instance which contains all the service functions.
virtual LogHandle const &	GetLogHandle (void)=0
	Gets the LogHandle required to send some log message.

Detailed Description

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

It allows loadable module and factory to register themselves and provide the list of the service functions exposed by the ADSP System.

Note: user-defined code should not directly interact with the SystemAgentInterface and rather should take leverage of the ProcessingModule and ProcessingModuleInterface base classes.

Member Function Documentation

virtual int intel_adsp::SystemAgentInterface::CheckIn	(	ProcessingModuleFactoryInterface &	module_factory,
		ModulePlaceholder *	module_placeholder,
		size_t	,
		uint32_t	,
		const void *	,
		void *	,
		void **	)

pure virtual

Allows a ProcessingModuleFactoryInterface instance to be registered in the ADSP System.

internal purpose.

Parameters

module_factory	the instance to register
module_placeholder	the place holder in memory for instantiation of a ProcessingModuleInterface instance

virtual void intel_adsp::SystemAgentInterface::CheckIn	(	ProcessingModuleInterface &	processing_module,
		ModuleHandle &	module_handle,
		LogHandle *&	log_handle )

pure virtual

Allows a ProcessingModuleInterface instance to be registered in the ADSP System.

internal purpose.

Parameters

processing_module	the instance to register for later use in processing pipeline
module_handle	the object that is required by the ADSP System to handle the module
log_handle	module logging context

virtual LogHandle const & intel_adsp::SystemAgentInterface::GetLogHandle ( void )

pure virtual

Gets the LogHandle required to send some log message.

virtual SystemService const & intel_adsp::SystemAgentInterface::GetSystemService ( void )

pure virtual

Gets the SystemService instance which contains all the service functions.

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

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