OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

module: interface: Mark functions whose implementation is optional 

Add the label "(optional)" in the function documentation for functions
whose implementation by a module is optional. The module adapter checks
whether the function is provided by the module before calling it.

Signed-off-by: Adrian Warecki <adrian.warecki@intel.com>
This commit is contained in:
Adrian Warecki 2024-07-25 17:53:41 +02:00 committed by Kai Vehmanen
parent 013a7c94e3
commit ff0635ee84
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/include/module/module/interface.h
View File

@ -155,7 +155,7 @@ struct module_interface {
int num_output_buffers);
/**
* Set module configuration for the given configuration ID
* (optional) Set module configuration for the given configuration ID
*
* If the complete configuration message is greater than MAX_BLOB_SIZE bytes, the
* transmission will be split into several smaller fragments.
@ -171,7 +171,7 @@ struct module_interface {
size_t response_size);
/**
* Get module runtime configuration for the given configuration ID
* (optional) Get module runtime configuration for the given configuration ID
*
* If the complete configuration message is greater than MAX_BLOB_SIZE bytes, the
* transmission will be split into several smaller fragments.
@ -185,13 +185,13 @@ struct module_interface {
uint8_t *fragment, size_t fragment_size);
/**
* Set processing mode for the module
* (unused) Set processing mode for the module
*/
int (*set_processing_mode)(struct processing_module *mod,
enum module_processing_mode mode);
/**
* Get the current processing mode for the module
* (unused) Get the current processing mode for the module
*/
enum module_processing_mode (*get_processing_mode)(struct processing_module *mod);
@ -207,16 +207,17 @@ struct module_interface {
*/
int (*free)(struct processing_module *mod);
/**
* Module specific bind procedure, called when modules are bound with each other
* (optional) Module specific bind procedure, called when modules are bound with each other
*/
int (*bind)(struct processing_module *mod, void *data);
/**
* Module specific unbind procedure, called when modules are disconnected from one another
* (optional) Module specific unbind procedure, called when modules are disconnected from
* one another
*/
int (*unbind)(struct processing_module *mod, void *data);
/**
* Module specific trigger procedure, called when modules are triggered
* (optional) Module specific trigger procedure, called when modules are triggered
*/
int (*trigger)(struct processing_module *mod, int cmd);