mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2021 mcumgr authors
 * Copyright (c) 2022-2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef H_MGMT_MGMT_
#define H_MGMT_MGMT_
 
#include <inttypes.h>
#include <zephyr/sys/slist.h>
#include <zephyr/mgmt/mcumgr/smp/smp.h>
#include <zephyr/mgmt/mcumgr/mgmt/mgmt_defines.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void *(*mgmt_alloc_rsp_fn)(const void *src_buf, void *arg);
 
typedef void (*mgmt_reset_buf_fn)(void *buf, void *arg);
 
#ifdef CONFIG_MCUMGR_SMP_VERBOSE_ERR_RESPONSE
#define MGMT_CTXT_SET_RC_RSN(mc, rsn) ((mc->rc_rsn) = (rsn))
#define MGMT_CTXT_RC_RSN(mc) ((mc)->rc_rsn)
#else
#define MGMT_CTXT_SET_RC_RSN(mc, rsn)
#define MGMT_CTXT_RC_RSN(mc) NULL
#endif
 
typedef int (*mgmt_handler_fn)(struct smp_streamer *ctxt);
 
struct mgmt_handler {
        mgmt_handler_fn mh_read;
        mgmt_handler_fn mh_write;
#if defined(CONFIG_MCUMGR_MGMT_HANDLER_USER_DATA)
        void *user_data;
#endif
};
 
struct mgmt_group {
        sys_snode_t node;
 
        const struct mgmt_handler *mg_handlers;
        uint16_t mg_handlers_count;
 
        uint16_t mg_group_id;
 
#if defined(CONFIG_MCUMGR_SMP_SUPPORT_ORIGINAL_PROTOCOL)
        smp_translate_error_fn mg_translate_error;
#endif
 
#if defined(CONFIG_MCUMGR_MGMT_CUSTOM_PAYLOAD)
        bool custom_payload;
#endif
 
#if IS_ENABLED(CONFIG_MCUMGR_GRP_ENUM_DETAILS_NAME)
        const char *mg_group_name;
#endif
};
 
void mgmt_register_group(struct mgmt_group *group);
 
void mgmt_unregister_group(struct mgmt_group *group);
 
typedef bool (*mgmt_groups_cb_t)(const struct mgmt_group *group, void *user_data);
 
void mgmt_groups_foreach(mgmt_groups_cb_t user_cb, void *user_data);
 
const struct mgmt_handler *mgmt_find_handler(uint16_t group_id, uint16_t command_id);
 
const struct mgmt_group *mgmt_find_group(uint16_t group_id);
 
const struct mgmt_handler *mgmt_get_handler(const struct mgmt_group *group, uint16_t command_id);
 
#if defined(CONFIG_MCUMGR_SMP_SUPPORT_ORIGINAL_PROTOCOL)
smp_translate_error_fn mgmt_find_error_translation_function(uint16_t group_id);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* MGMT_MGMT_H_ */