smp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2021 mcumgr authors
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef H_SMP_
#define H_SMP_
 
#include <zephyr/net/buf.h>
#include <zephyr/mgmt/mcumgr/transport/smp.h>
 
#include <zcbor_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum smp_mcumgr_version_t {
        SMP_MCUMGR_VERSION_1 = 0,
 
        SMP_MCUMGR_VERSION_2,
};
 
struct cbor_nb_reader {
        struct net_buf *nb;
        /* CONFIG_MCUMGR_SMP_CBOR_MAX_DECODING_LEVELS + 2 translates to minimal
         * zcbor backup states.
         */
        zcbor_state_t zs[CONFIG_MCUMGR_SMP_CBOR_MAX_DECODING_LEVELS + 2];
};
 
struct cbor_nb_writer {
        struct net_buf *nb;
        zcbor_state_t zs[CONFIG_MCUMGR_SMP_CBOR_MAX_ENCODING_LEVELS + 2];
 
#if IS_ENABLED(CONFIG_MCUMGR_SMP_SUPPORT_ORIGINAL_PROTOCOL)
        uint16_t error_group;
        uint16_t error_ret;
#endif
};
 
struct net_buf *smp_packet_alloc(void);
 
void smp_packet_free(struct net_buf *nb);
 
struct smp_streamer {
        struct smp_transport *smpt;
        struct cbor_nb_reader *reader;
        struct cbor_nb_writer *writer;
 
#ifdef CONFIG_MCUMGR_SMP_VERBOSE_ERR_RESPONSE
        const char *rc_rsn;
#endif
};
 
int smp_process_request_packet(struct smp_streamer *streamer, void *req);
 
bool smp_add_cmd_err(zcbor_state_t *zse, uint16_t group, uint16_t ret);
 
__deprecated inline bool smp_add_cmd_ret(zcbor_state_t *zse, uint16_t group, uint16_t ret)
{
        return smp_add_cmd_err(zse, group, ret);
}
 
#if IS_ENABLED(CONFIG_MCUMGR_SMP_SUPPORT_ORIGINAL_PROTOCOL)
typedef int (*smp_translate_error_fn)(uint16_t err);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* H_SMP_ */