callbacks.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef H_MCUMGR_CALLBACKS_
#define H_MCUMGR_CALLBACKS_
 
#include <inttypes.h>
#include <zephyr/sys/slist.h>
#include <zephyr/mgmt/mcumgr/mgmt/mgmt.h>
 
#ifdef CONFIG_MCUMGR_GRP_FS
#include <zephyr/mgmt/mcumgr/grp/fs_mgmt/fs_mgmt_callbacks.h>
#endif
 
#ifdef CONFIG_MCUMGR_GRP_IMG
#include <zephyr/mgmt/mcumgr/grp/img_mgmt/img_mgmt_callbacks.h>
#endif
 
#ifdef CONFIG_MCUMGR_GRP_OS
#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt_callbacks.h>
#endif
 
#ifdef CONFIG_MCUMGR_GRP_SETTINGS
#include <zephyr/mgmt/mcumgr/grp/settings_mgmt/settings_mgmt_callbacks.h>
#endif
 
#ifdef CONFIG_MCUMGR_GRP_ENUM
#include <zephyr/mgmt/mcumgr/grp/enum_mgmt/enum_mgmt_callbacks.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MGMT_EVT_OP_ID_ALL 0xffff
 
#define MGMT_DEF_EVT_OP_ID(group, event_id) ((group << 16) | BIT(event_id))
 
#define MGMT_DEF_EVT_OP_ALL(group) ((group << 16) | MGMT_EVT_OP_ID_ALL)
#define MGMT_EVT_GET_GROUP(event) ((event >> 16) & MGMT_EVT_OP_ID_ALL)
 
#define MGMT_EVT_GET_ID(event) (event & MGMT_EVT_OP_ID_ALL)
 
enum mgmt_cb_return {
        MGMT_CB_OK,
 
        MGMT_CB_ERROR_RC,
 
        MGMT_CB_ERROR_ERR,
};
 
/* Deprecated after Zephyr 3.4, use MGMT_CB_ERROR_ERR instead */
#define MGMT_CB_ERROR_RET __DEPRECATED_MACRO MGMT_CB_ERROR_ERR
 
typedef enum mgmt_cb_return (*mgmt_cb)(uint32_t event, enum mgmt_cb_return prev_status,
                                       int32_t *rc, uint16_t *group, bool *abort_more, void *data,
                                       size_t data_size);
 
enum mgmt_cb_groups {
        MGMT_EVT_GRP_ALL                        = 0,
        MGMT_EVT_GRP_SMP,
        MGMT_EVT_GRP_OS,
        MGMT_EVT_GRP_IMG,
        MGMT_EVT_GRP_FS,
        MGMT_EVT_GRP_SETTINGS,
        MGMT_EVT_GRP_ENUM,
 
        MGMT_EVT_GRP_USER_CUSTOM_START          = MGMT_GROUP_ID_PERUSER,
};
 
enum smp_all_events {
        MGMT_EVT_OP_ALL                         = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_ALL),
};
 
enum smp_group_events {
        MGMT_EVT_OP_CMD_RECV                    = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_SMP, 0),
 
        MGMT_EVT_OP_CMD_STATUS                  = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_SMP, 1),
 
        MGMT_EVT_OP_CMD_DONE                    = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_SMP, 2),
 
        MGMT_EVT_OP_CMD_ALL                     = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_SMP),
};
 
enum fs_mgmt_group_events {
        MGMT_EVT_OP_FS_MGMT_FILE_ACCESS         = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_FS, 0),
 
        MGMT_EVT_OP_FS_MGMT_ALL                 = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_FS),
};
 
enum img_mgmt_group_events {
        MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK                  = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 0),
 
        MGMT_EVT_OP_IMG_MGMT_DFU_STOPPED                = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 1),
 
        MGMT_EVT_OP_IMG_MGMT_DFU_STARTED                = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 2),
 
        MGMT_EVT_OP_IMG_MGMT_DFU_PENDING                = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 3),
 
        MGMT_EVT_OP_IMG_MGMT_DFU_CONFIRMED              = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 4),
 
        MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK_WRITE_COMPLETE   = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 5),
 
        MGMT_EVT_OP_IMG_MGMT_IMAGE_SLOT_STATE           = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 6),
 
        MGMT_EVT_OP_IMG_MGMT_ALL                        = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_IMG),
};
 
enum os_mgmt_group_events {
        MGMT_EVT_OP_OS_MGMT_RESET               = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 0),
 
        MGMT_EVT_OP_OS_MGMT_INFO_CHECK          = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 1),
 
        MGMT_EVT_OP_OS_MGMT_INFO_APPEND         = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 2),
 
        MGMT_EVT_OP_OS_MGMT_DATETIME_GET        = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 3),
 
        MGMT_EVT_OP_OS_MGMT_DATETIME_SET        = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 4),
 
        MGMT_EVT_OP_OS_MGMT_BOOTLOADER_INFO     = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_OS, 5),
 
        MGMT_EVT_OP_OS_MGMT_ALL                 = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_OS),
};
 
enum settings_mgmt_group_events {
        MGMT_EVT_OP_SETTINGS_MGMT_ACCESS        = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_SETTINGS, 0),
 
        MGMT_EVT_OP_SETTINGS_MGMT_ALL           = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_SETTINGS),
};
 
enum enum_mgmt_group_events {
        MGMT_EVT_OP_ENUM_MGMT_DETAILS           = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_ENUM, 0),
 
        MGMT_EVT_OP_ENUM_MGMT_ALL               = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_ENUM),
};
 
struct mgmt_callback {
        sys_snode_t node;
 
        mgmt_cb callback;
 
        uint32_t event_id;
};
 
struct mgmt_evt_op_cmd_arg {
        uint16_t group;
 
        uint8_t id;
 
        union {
                uint8_t op;
 
                int err;
 
                int status;
        };
};
 
uint8_t mgmt_evt_get_index(uint32_t event);
 
enum mgmt_cb_return mgmt_callback_notify(uint32_t event, void *data, size_t data_size,
                                         int32_t *err_rc, uint16_t *err_group);
 
void mgmt_callback_register(struct mgmt_callback *callback);
 
void mgmt_callback_unregister(struct mgmt_callback *callback);
 
#ifdef __cplusplus
}
#endif
 
#endif /* H_MCUMGR_CALLBACKS_ */