michaelh/zephyr
1
0
Fork 0
Code Releases Activity

subsys: mgmt: SMP protocol for mcumgr.

Browse source 
The Simple Management Protocol (SMP) is a basic protocol that sits on
top of mcumgr's mgmt layer.  This commit adds the functionality needed
to hook into mcumgr's SMP layer.

More information about SMP can be found at:
`ext/lib/mgmt/mcumgr/smp/include/smp/smp.h`.

Signed-off-by: Christopher Collins <ccollins@apache.org>
This commit is contained in:
Christopher Collins 2018-01-17 17:57:25 -08:00 • committed by Carles Cufí
commit 6721d64735
5 changed files with 598 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

58
include/mgmt/buf.h Normal file
View file

@ -0,0 +1,58 @@
/*
* Copyright Runtime.io 2018. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef H_MGMT_BUF
#define H_MGMT_BUF
#include <inttypes.h>
#include "cbor_encoder_writer.h"
#include "cbor_decoder_reader.h"
struct net_buf;
struct cbor_nb_reader {
struct cbor_decoder_reader r;
struct net_buf *nb;
};
struct cbor_nb_writer {
struct cbor_encoder_writer enc;
struct net_buf *nb;
};
/**
* @brief Allocates a net_buf for holding an mcumgr request or response.
*
* @return A newly-allocated buffer net_buf on success;
* NULL on failure.
*/
struct net_buf *mcumgr_buf_alloc(void);
/**
* @brief Frees an mcumgr net_buf
*
* @param nb The net_buf to free.
*/
void mcumgr_buf_free(struct net_buf *nb);
/**
* @brief Initializes a CBOR writer with the specified net_buf.
*
* @param cnw The writer to initialize.
* @param nb The net_buf that the writer will write to.
*/
void cbor_nb_writer_init(struct cbor_nb_writer *cnw,
struct net_buf *nb);
/**
* @brief Initializes a CBOR reader with the specified net_buf.
*
* @param cnr The reader to initialize.
* @param nb The net_buf that the reader will read from.
*/
void cbor_nb_reader_init(struct cbor_nb_reader *cnr,
struct net_buf *nb);
#endif

87
include/mgmt/smp.h Normal file
View file

@ -0,0 +1,87 @@
/*
* Copyright Runtime.io 2018. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef H_ZEPHYR_SMP_
#define H_ZEPHYR_SMP_
#ifdef __cplusplus
extern "C" {
#endif
struct zephyr_smp_transport;
struct net_buf;
/** @typedef zephyr_smp_transport_out_fn
* @brief SMP transmit function for Zephyr.
*
* The supplied net_buf is always consumed, regardless of return code.
*
* @param mst The transport to send via.
* @param nb The net_buf to transmit.
*
* @return 0 on success, MGMT_ERR_[...] code on failure.
*/
typedef int zephyr_smp_transport_out_fn(struct zephyr_smp_transport *zst,
struct net_buf *nb);
/** @typedef zephyr_smp_transport_get_mtu_fn
* @brief SMP MTU query function for Zephyr.
*
* The supplied net_buf should contain a request received from the peer whose
* MTU is being queried. This function takes a net_buf parameter because some
* transports store connection-specific information in the net_buf user header
* (e.g., the BLE transport stores the peer address).
*
* @param nb Contains a request from the relevant peer.
*
* @return The transport's MTU;
* 0 if transmission is currently not possible.
*/
typedef uint16_t zephyr_smp_transport_get_mtu_fn(const struct net_buf *nb);
/**
* @brief Provides Zephyr-specific functionality for sending SMP responses.
*/
struct zephyr_smp_transport {
/* Must be the first member. */
struct k_work zst_work;
/* FIFO containing incoming requests to be processed. */
struct k_fifo zst_fifo;
zephyr_smp_transport_out_fn *zst_output;
zephyr_smp_transport_get_mtu_fn *zst_get_mtu;
};
/**
* @brief Initializes a Zephyr SMP transport object.
*
* @param zst The transport to construct.
* @param output_func The transport's send function.
* @param get_mtu_func The transport's get-MTU function.
*
* @return 0 on success, MGMT_ERR_[...] code on failure.
*/
void zephyr_smp_transport_init(struct zephyr_smp_transport *zst,
zephyr_smp_transport_out_fn *output_func,
zephyr_smp_transport_get_mtu_fn *get_mtu_func);
/**
* @brief Enqueues an incoming SMP request packet for processing.
*
* This function always consumes the supplied net_buf.
*
* @param zst The transport to use to send the corresponding
* response(s).
* @param nb The request packet to process.
*/
void zephyr_smp_rx_req(struct zephyr_smp_transport *zst, struct net_buf *nb);
#ifdef __cplusplus
}
#endif
#endif