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_SMP_H_
#define ZEPHYR_INCLUDE_MGMT_SMP_H_
 
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct smp_transport;
struct zephyr_smp_transport;
struct net_buf;
 
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);
 
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;
};
 
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
};
 
enum smp_transport_type {
        SMP_SERIAL_TRANSPORT = 0,
        SMP_BLUETOOTH_TRANSPORT,
        SMP_SHELL_TRANSPORT,
        SMP_UDP_IPV4_TRANSPORT,
        SMP_UDP_IPV6_TRANSPORT,
        SMP_LORAWAN_TRANSPORT,
        SMP_USER_DEFINED_TRANSPORT
};
 
struct smp_client_transport_entry {
        sys_snode_t node;
        struct smp_transport *smpt;
        int smpt_type;
};
 
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);
 
#ifdef __cplusplus
}
#endif
 
#endif