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 zephyr_smp_transport;
struct net_buf;
 
typedef int zephyr_smp_transport_out_fn(struct net_buf *nb);
 
typedef uint16_t zephyr_smp_transport_get_mtu_fn(const struct net_buf *nb);
 
typedef int zephyr_smp_transport_ud_copy_fn(struct net_buf *dst,
                                            const struct net_buf *src);
 
typedef void zephyr_smp_transport_ud_free_fn(void *ud);
 
typedef bool zephyr_smp_transport_query_valid_check_fn(struct net_buf *nb, void *arg);
 
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;
        zephyr_smp_transport_ud_copy_fn *zst_ud_copy;
        zephyr_smp_transport_ud_free_fn *zst_ud_free;
        zephyr_smp_transport_query_valid_check_fn *zst_query_valid_check;
 
#ifdef CONFIG_MCUMGR_SMP_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 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,
                               zephyr_smp_transport_ud_copy_fn *ud_copy_func,
                               zephyr_smp_transport_ud_free_fn *ud_free_func,
                               zephyr_smp_transport_query_valid_check_fn *query_valid_check_func);
 
void smp_rx_remove_invalid(struct zephyr_smp_transport *zst, void *arg);
 
#ifdef __cplusplus
}
#endif
 
#endif