mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2021 mcumgr authors
 * Copyright (c) 2022 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>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum mcumgr_op_t {
        MGMT_OP_READ            = 0,
 
        MGMT_OP_READ_RSP,
 
        MGMT_OP_WRITE,
 
        MGMT_OP_WRITE_RSP,
};
 
enum mcumgr_group_t {
        MGMT_GROUP_ID_OS        = 0,
 
        MGMT_GROUP_ID_IMAGE,
 
        MGMT_GROUP_ID_STAT,
 
        MGMT_GROUP_ID_CONFIG,
 
        MGMT_GROUP_ID_LOG,
 
        MGMT_GROUP_ID_CRASH,
 
        MGMT_GROUP_ID_SPLIT,
 
        MGMT_GROUP_ID_RUN,
 
        MGMT_GROUP_ID_FS,
 
        MGMT_GROUP_ID_SHELL,
 
        MGMT_GROUP_ID_PERUSER   = 64,
 
        ZEPHYR_MGMT_GRP_BASIC   = (MGMT_GROUP_ID_PERUSER - 1),
};
 
enum mcumgr_err_t {
        MGMT_ERR_EOK            = 0,
 
        MGMT_ERR_EUNKNOWN,
 
        MGMT_ERR_ENOMEM,
 
        MGMT_ERR_EINVAL,
 
        MGMT_ERR_ETIMEOUT,
 
        MGMT_ERR_ENOENT,
 
        MGMT_ERR_EBADSTATE,
 
        MGMT_ERR_EMSGSIZE,
 
        MGMT_ERR_ENOTSUP,
 
        MGMT_ERR_ECORRUPT,
 
        MGMT_ERR_EBUSY,
 
        MGMT_ERR_EACCESSDENIED,
 
        MGMT_ERR_EPERUSER       = 256
};
 
#define MGMT_HDR_SIZE           8
 
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;
};
 
struct mgmt_group {
        sys_snode_t node;
 
        const struct mgmt_handler *mg_handlers;
        uint16_t mg_handlers_count;
 
        /* The numeric ID of this group. */
        uint16_t mg_group_id;
};
 
void mgmt_register_group(struct mgmt_group *group);
 
void mgmt_unregister_group(struct mgmt_group *group);
 
const struct mgmt_handler *mgmt_find_handler(uint16_t group_id, uint16_t command_id);
 
#ifdef __cplusplus
}
#endif
 
#endif /* MGMT_MGMT_H_ */