Skip to content

Commit 4f51c43

Browse files
committed
module: generic.h: add some comments and align doxygen comments
Add a descriptive comment and align some doxygen comments. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
1 parent 391b2c7 commit 4f51c43

File tree

1 file changed

+16
-6
lines changed
  • src/include/sof/audio/module_adapter/module

1 file changed

+16
-6
lines changed

src/include/sof/audio/module_adapter/module/generic.h

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@
3333
#define IPC_MOD_CMD(v) .cmd = v,
3434
#endif
3535

36+
/*
37+
* \brief Macro to declare a module adapter component.
38+
* \param adapter - name of the module.
39+
* \param uuid - UUID of the module.
40+
* \param tr - trace context for the module.
41+
*
42+
* This macro declares a module component with the specified name, UUID, and trace context.
43+
* It initializes the component module structure with the appropriate type, UID, and
44+
* struct module_interface operations.
45+
*/
3646
#define DECLARE_MODULE_ADAPTER(adapter, uuid, tr) \
3747
static const struct comp_driver comp_##adapter##_module = { \
3848
.type = SOF_COMP_MODULE_ADAPTER, \
@@ -81,10 +91,10 @@ DECLARE_MODULE(sys_comp_module_##adapter##_init)
8191
* \brief Module-specific states
8292
*/
8393
enum module_state {
84-
MODULE_DISABLED, /**< Module isn't initialized yet or has been freed.*/
85-
MODULE_INITIALIZED, /**< Module initialized or reset. */
86-
MODULE_IDLE, /**< Module is idle now. */
87-
MODULE_PROCESSING, /**< Module is processing samples now. */
94+
MODULE_DISABLED, /**< Module isn't initialized yet or has been freed.*/
95+
MODULE_INITIALIZED, /**< Module initialized or reset. */
96+
MODULE_IDLE, /**< Module is idle now. */
97+
MODULE_PROCESSING, /**< Module is processing samples now. */
8898
};
8999

90100
/**
@@ -101,8 +111,8 @@ struct module_param {
101111
* sample_rate may have an id of 0x01.
102112
*/
103113
uint32_t id;
104-
uint32_t size; /**< The size of whole parameter - id + size + data */
105-
int32_t data[]; /**< A pointer to memory where config is stored.*/
114+
uint32_t size; /**< The size of whole parameter - id + size + data */
115+
int32_t data[]; /**< A pointer to memory where config is stored.*/
106116
};
107117

108118
/**

0 commit comments

Comments
 (0)