modules_common.h File Reference

Modules common library header. More...

#include <zephyr/kernel.h>

Go to the source code of this file.

Data Structures
struct	module_data
	Structure that contains module metadata. More...

Macros
#define	IS_EVENT(_ptr, _mod, _evt)
	Macro that checks if an event is of a certain type.
#define	SEND_EVENT(_mod, _type)
	Macro used to submit an event.
#define	SEND_ERROR(_mod, _type, _error_code)
	Macro used to submit an error event.
#define	SEND_SHUTDOWN_ACK(_mod, _type, _id)
	Macro used to submit a shutdown event.

Functions
void	module_purge_queue (struct module_data *module)
	Purge a module's queue.
int	module_get_next_msg (struct module_data *module, void *msg)
	Get the next message in a module's queue.
int	module_enqueue_msg (struct module_data *module, void *msg)
	Enqueue message to a module's queue.
bool	modules_shutdown_register (uint32_t id_reg)
	Register that a module has performed a graceful shutdown.
int	module_start (struct module_data *module)
	Register and start a module.
uint32_t	module_active_count_get (void)
	Get the number of active modules in the application.

Detailed Description

Modules common library header.