smp.h

Go to the documentation of this file.

/*
 * Copyright Runtime.io 2018. All rights reserved.
 * Copyright (c) 2022-2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_MGMT_MCUMGR_TRANSPORT_SMP_H_
#define ZEPHYR_INCLUDE_MGMT_MCUMGR_TRANSPORT_SMP_H_
 
#include <zephyr/kernel.h>
#include <zcbor_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
struct smp_transport;
struct zephyr_smp_transport;
struct net_buf;
struct smp_transport_bridge;
struct smp_client_transport_entry;

typedef int (*smp_transport_out_fn)(struct net_buf *nb);

typedef uint16_t (*smp_transport_get_mtu_fn)(const struct net_buf *nb);

typedef int (*smp_transport_ud_copy_fn)(struct net_buf *dst,
                                        const struct net_buf *src);

typedef void (*smp_transport_ud_free_fn)(void *ud);

typedef bool (*smp_transport_query_valid_check_fn)(struct net_buf *nb, void *arg);

typedef void (*smp_transport_ud_req_init_fn)(struct net_buf *nb, void *priv);

typedef bool (*smp_transport_bridge_connect_fn)(struct smp_transport_bridge *bridge,
                                                bool direction, uint32_t mode, bool same_transport,
                                                zcbor_state_t *input_data,
                                                zcbor_state_t *output_data);

typedef void (*smp_transport_bridge_disconnect_fn)(struct smp_transport_bridge *bridge,
                                                   bool direction);

typedef int (*smp_transport_bridge_out_fn)(const struct smp_transport_bridge *bridge,
                                           struct net_buf *nb, bool direction);

typedef bool (*mgmt_client_transport_cb_t)(const struct smp_client_transport_entry *transport,
                                           void *user_data);

typedef bool (*smp_transport_bridge_modes_fn)(zcbor_state_t *output_data, int *rc);

typedef bool (*smp_transport_bridge_config_details_fn)(uint32_t mode, zcbor_state_t *output_data,
                                                       int *rc);

struct smp_transport_api_t {
        smp_transport_out_fn output;

        smp_transport_get_mtu_fn get_mtu;

        smp_transport_ud_copy_fn ud_copy;

        smp_transport_ud_free_fn ud_free;

        smp_transport_query_valid_check_fn query_valid_check;

        smp_transport_ud_req_init_fn ud_init;
 
#if defined(CONFIG_MCUMGR_GRP_TRANSPORT) || defined(__DOXYGEN__)
        smp_transport_bridge_connect_fn bridge_connect;

        smp_transport_bridge_disconnect_fn bridge_disconnect;

        smp_transport_bridge_out_fn bridge_output;
 
#if defined(CONFIG_MCUMGR_GRP_TRANSPORT_INFO_FUNCTIONS) || defined(__DOXYGEN__)
        smp_transport_bridge_modes_fn bridge_modes;

        smp_transport_bridge_config_details_fn bridge_config_details;
#endif
#endif
};

struct smp_transport {
        /* Must be the first member. */
        struct k_work work;
 
        /* FIFO containing incoming requests to be processed. */
        struct k_fifo fifo;
 
        /* Function pointers */
        struct smp_transport_api_t functions;
 
#ifdef CONFIG_MCUMGR_TRANSPORT_REASSEMBLY
        /* Packet reassembly internal data, API access only */
        struct {
                struct net_buf *current;        /* net_buf used for reassembly */
                uint16_t expected;              /* expected bytes to come */
        } __reassembly;
#endif
};

struct smp_transport_bridge {
        uint8_t status;

        struct smp_transport *incoming_transport;

        struct smp_transport *outgoing_transport;
};

enum smp_transport_type {
        SMP_SERIAL_TRANSPORT = 0,
        SMP_RAW_SERIAL_TRANSPORT,
        SMP_BLUETOOTH_TRANSPORT,
        SMP_SHELL_TRANSPORT,
        SMP_UDP_IPV4_TRANSPORT,
        SMP_UDP_IPV6_TRANSPORT,
        SMP_LORAWAN_TRANSPORT,
        SMP_SPI_TRANSPORT,


        SMP_USER_DEFINED_TRANSPORT = 64,
};

struct smp_client_transport_entry {
        sys_snode_t node;
        struct smp_transport *smpt;
        int smpt_type;
 
#if defined(CONFIG_MCUMGR_GRP_TRANSPORT_INFO_FUNCTIONS) || defined(__DOXYGEN__)
        char *name;
#endif
};

int smp_transport_init(struct smp_transport *smpt);

void smp_rx_remove_invalid(struct smp_transport *zst, void *arg);

void smp_rx_clear(struct smp_transport *zst);

void smp_client_transport_register(struct smp_client_transport_entry *entry);

struct smp_transport *smp_client_transport_get(int smpt_type);

bool smp_client_transport_foreach(mgmt_client_transport_cb_t user_cb, void *user_data);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_MGMT_MCUMGR_TRANSPORT_SMP_H_ */