modules_common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _MODULES_COMMON_H_
#define _MODULES_COMMON_H_
 
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define IS_EVENT(_ptr, _mod, _evt) \
                is_ ## _mod ## _module_event(&_ptr->module._mod.header) &&              \
                _ptr->module._mod.type == _evt
 
#define SEND_EVENT(_mod, _type)                                                         \
        struct _mod ## _module_event *event = new_ ## _mod ## _module_event();          \
        __ASSERT(event, "Not enough heap left to allocate event");                      \
        event->type = _type;                                                            \
        APP_EVENT_SUBMIT(event)
 
#define SEND_ERROR(_mod, _type, _error_code)                                            \
        struct _mod ## _module_event *event = new_ ## _mod ## _module_event();          \
        __ASSERT(event, "Not enough heap left to allocate event");                      \
        event->type = _type;                                                            \
        event->data.err = _error_code;                                                  \
        APP_EVENT_SUBMIT(event)
 
#define SEND_SHUTDOWN_ACK(_mod, _type, _id)                                             \
        struct _mod ## _module_event *event = new_ ## _mod ## _module_event();          \
        __ASSERT(event, "Not enough heap left to allocate event");                      \
        event->type = _type;                                                            \
        event->data.id = _id;                                                           \
        APP_EVENT_SUBMIT(event)
 
struct module_data {
        /* Variable used to construct a linked list of module metadata. */
        sys_snode_t header;
        /* ID specific to each module. Internally assigned when calling module_start(). */
        uint32_t id;
        /* The ID of the module thread. */
        k_tid_t thread_id;
        /* Name of the module. */
        char *name;
        /* Pointer to the internal message queue in the module. */
        struct k_msgq *msg_q;
        /* Flag signifying if the module supports shutdown. */
        bool supports_shutdown;
};
 
void module_purge_queue(struct module_data *module);
 
int module_get_next_msg(struct module_data *module, void *msg);
 
int module_enqueue_msg(struct module_data *module, void *msg);
 
bool modules_shutdown_register(uint32_t id_reg);
 
int module_start(struct module_data *module);
 
uint32_t module_active_count_get(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _MODULES_COMMON_H_ */