Zephyr Project API 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
MCUmgr transport SMP API

MCUmgr transport SMP API. More...

Data Structures

struct  smp_transport_api_t
 Function pointers of SMP transport functions, if a handler is NULL then it is not supported/implemented. More...
 
struct  smp_transport
 SMP transport object for sending SMP responses. More...
 
struct  smp_client_transport_entry
 SMP Client transport structure. More...
 

Typedefs

typedef int(* smp_transport_out_fn) (struct net_buf *nb)
 SMP transmit callback for transport.
 
typedef uint16_t(* smp_transport_get_mtu_fn) (const struct net_buf *nb)
 SMP MTU query callback for transport.
 
typedef int(* smp_transport_ud_copy_fn) (struct net_buf *dst, const struct net_buf *src)
 SMP copy user_data callback.
 
typedef void(* smp_transport_ud_free_fn) (void *ud)
 SMP free user_data callback.
 
typedef bool(* smp_transport_query_valid_check_fn) (struct net_buf *nb, void *arg)
 Function for checking if queued data is still valid.
 

Enumerations

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
}
 SMP transport type for client registration. More...
 

Functions

int smp_transport_init (struct smp_transport *smpt)
 Initializes a Zephyr SMP transport object.
 
void smp_rx_remove_invalid (struct smp_transport *zst, void *arg)
 Used to remove queued requests for an SMP transport that are no longer valid.
 
void smp_rx_clear (struct smp_transport *zst)
 Used to clear pending queued requests for an SMP transport.
 
void smp_client_transport_register (struct smp_client_transport_entry *entry)
 Register a Zephyr SMP transport object for client.
 
struct smp_transportsmp_client_transport_get (int smpt_type)
 Discover a registered SMP transport client object.
 

Detailed Description

MCUmgr transport SMP API.

Typedef Documentation

◆ smp_transport_get_mtu_fn

smp_transport_get_mtu_fn

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

SMP MTU query callback for transport.

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).

Parameters
nbContains a request from the relevant peer.
Returns
The transport's MTU; 0 if transmission is currently not possible.

◆ smp_transport_out_fn

smp_transport_out_fn

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

SMP transmit callback for transport.

The supplied net_buf is always consumed, regardless of return code.

Parameters
nbThe net_buf to transmit.
Returns
0 on success, mcumgr_err_t code on failure.

◆ smp_transport_query_valid_check_fn

smp_transport_query_valid_check_fn

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

Function for checking if queued data is still valid.

This function is used to check if queued SMP data is still valid e.g. on a remote device disconnecting, this is triggered when smp_rx_remove_invalid() is called.

Parameters
nbnet buf containing queued request.
argArgument provided when calling smp_rx_remove_invalid() function.
Returns
false if data is no longer valid/should be freed, true otherwise.

◆ smp_transport_ud_copy_fn

smp_transport_ud_copy_fn

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

SMP copy user_data callback.

The supplied src net_buf should contain a user_data that cannot be copied using regular memcpy function (e.g., the BLE transport net_buf user_data stores the connection reference that has to be incremented when is going to be used by another buffer).

Parameters
dstSource buffer user_data pointer.
srcDestination buffer user_data pointer.
Returns
0 on success, mcumgr_err_t code on failure.

◆ smp_transport_ud_free_fn

smp_transport_ud_free_fn

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

SMP free user_data callback.

This function frees net_buf user data, because some transports store connection-specific information in the net_buf user data (e.g., the BLE transport stores the connection reference that has to be decreased).

Parameters
udContains a user_data pointer to be freed.

Enumeration Type Documentation

◆ smp_transport_type

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

SMP transport type for client registration.

Enumerator
SMP_SERIAL_TRANSPORT 

SMP serial.

SMP_BLUETOOTH_TRANSPORT 

SMP bluetooth.

SMP_SHELL_TRANSPORT 

SMP shell.

SMP_UDP_IPV4_TRANSPORT 

SMP UDP IPv4.

SMP_UDP_IPV6_TRANSPORT 

SMP UDP IPv6.

SMP_LORAWAN_TRANSPORT 

SMP LoRaWAN.

SMP_USER_DEFINED_TRANSPORT 

SMP user defined type.

Function Documentation

◆ smp_client_transport_get()

struct smp_transport * smp_client_transport_get ( int  smpt_type)

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

Discover a registered SMP transport client object.

Parameters
smpt_typeType of transport
Returns
Pointer to registered object. Unknown type return NULL.

◆ smp_client_transport_register()

void smp_client_transport_register ( struct smp_client_transport_entry entry)

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

Register a Zephyr SMP transport object for client.

Parameters
entryThe transport to construct.

◆ smp_rx_clear()

void smp_rx_clear ( struct smp_transport zst)

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

Used to clear pending queued requests for an SMP transport.

Parameters
zstThe transport to use.

◆ smp_rx_remove_invalid()

void smp_rx_remove_invalid ( struct smp_transport zst,
void *  arg 
)

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

Used to remove queued requests for an SMP transport that are no longer valid.

A smp_transport_query_valid_check_fn() function must be registered for this to function. If the smp_transport_query_valid_check_fn() function returns false during a callback, the queried command will classed as invalid and dropped.

Parameters
zstThe transport to use.
argArgument provided to callback smp_transport_query_valid_check_fn() function.

◆ smp_transport_init()

int smp_transport_init ( struct smp_transport smpt)

#include <include/zephyr/mgmt/mcumgr/transport/smp.h>

Initializes a Zephyr SMP transport object.

Parameters
smptThe transport to construct.
Returns
0 If successful
Negative errno code if failure.