smp.h

Go to the documentation of this file.

/*
 * Copyright Runtime.io 2018. All rights reserved.
 * Copyright (c) 2022 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);
/* use smp_transport_out_fn instead */
typedef int zephyr_smp_transport_out_fn(struct net_buf *nb);
 
typedef uint16_t (*smp_transport_get_mtu_fn)(const struct net_buf *nb);
/* use smp_transport_get_mtu_fn instead */
typedef uint16_t zephyr_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);
/* use smp_transport_ud_copy_fn instead */
typedef int zephyr_smp_transport_ud_copy_fn(struct net_buf *dst,
                                            const struct net_buf *src);
 
typedef void (*smp_transport_ud_free_fn)(void *ud);
/* use smp_transport_ud_free_fn instead */
typedef void zephyr_smp_transport_ud_free_fn(void *ud);
 
typedef bool (*smp_transport_query_valid_check_fn)(struct net_buf *nb, void *arg);
 
struct smp_transport {
        /* Must be the first member. */
        struct k_work work;
 
        /* FIFO containing incoming requests to be processed. */
        struct k_fifo fifo;
 
        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;
 
#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
};
 
/* Deprecated, use smp_transport instead */
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;
 
        smp_transport_out_fn zst_output;
        smp_transport_get_mtu_fn zst_get_mtu;
        smp_transport_ud_copy_fn zst_ud_copy;
        smp_transport_ud_free_fn zst_ud_free;
 
#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
};
 
void smp_transport_init(struct smp_transport *smpt,
                        smp_transport_out_fn output_func,
                        smp_transport_get_mtu_fn get_mtu_func,
                        smp_transport_ud_copy_fn ud_copy_func,
                        smp_transport_ud_free_fn ud_free_func,
                        smp_transport_query_valid_check_fn query_valid_check_func);
 
__deprecated static inline
void zephyr_smp_transport_init(struct zephyr_smp_transport *smpt,
                               zephyr_smp_transport_out_fn *output_func,
                               zephyr_smp_transport_get_mtu_fn *get_mtu_func,
                               zephyr_smp_transport_ud_copy_fn *ud_copy_func,
                               zephyr_smp_transport_ud_free_fn *ud_free_func)
{
        smp_transport_init((struct smp_transport *)smpt,
                           (smp_transport_out_fn)output_func,
                           (smp_transport_get_mtu_fn)get_mtu_func,
                           (smp_transport_ud_copy_fn)ud_copy_func,
                           (smp_transport_ud_free_fn)ud_free_func, NULL);
}
 
void smp_rx_remove_invalid(struct smp_transport *zst, void *arg);
 
void smp_rx_clear(struct smp_transport *zst);
 
#ifdef __cplusplus
}
#endif
 
#endif