Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Header file for the MCUmgr transport management group API. More...

Go to the source code of this file.

Macros

#define TRANSPORT_MGMT_DIRECTION_INCOMING   false
 Incoming transport whereby the device will forward read/write request packets on the specified transport and send them out on the transport it is bridged with.
#define TRANSPORT_MGMT_DIRECTION_OUTGOING   true
 Outgoing transport whereby the device will forward read/write response packets on the specified transport and send them out on the transport it is bridged with.

Enumerations

enum  transport_mgmt_ids {
  TRANSPORT_MGMT_ID_CONNECT , TRANSPORT_MGMT_ID_DISCONNECT , TRANSPORT_MGMT_ID_STATUS , TRANSPORT_MGMT_ID_RESERVED_1 ,
  TRANSPORT_MGMT_ID_RESERVED_2 , TRANSPORT_MGMT_ID_RESERVED_3 , TRANSPORT_MGMT_ID_LIST , TRANSPORT_MGMT_ID_GET_MODES ,
  TRANSPORT_MGMT_ID_GET_CONFIG_DETAILS
}
 Command IDs for transport management group. More...
enum  transport_mgmt_ret_code_t {
  TRANSPORT_MGMT_ERR_OK = 0 , TRANSPORT_MGMT_ERR_UNKNOWN , TRANSPORT_MGMT_ERR_TRANSPORT_MISSING_REQUIRED_FUNCTIONS , TRANSPORT_MGMT_ERR_TRANSPORT_MISSING_INFO_FUNCTIONS ,
  TRANSPORT_MGMT_ERR_INVALID_TRANSPORT , TRANSPORT_MGMT_ERR_INVALID_MODE , TRANSPORT_MGMT_ERR_ALL_CONTEXTS_USED , TRANSPORT_MGMT_ERR_BOTH_TRANSPORT_AND_ALL_PARAMETERS ,
  TRANSPORT_MGMT_ERR_NOT_BRIDGED , TRANSPORT_MGMT_ERR_SAME_BRIDGE_DEVICE_DISALLOWED , TRANSPORT_MGMT_ERR_TRANSPORT_INGOING_NOT_SUPPORTED , TRANSPORT_MGMT_ERR_TRANSPORT_OUTGOING_NOT_SUPPORTED ,
  TRANSPORT_MGMT_ERR_TRANSPORT_INCOMING_TRANSPORT_ALREADY_BRIDGED , TRANSPORT_MGMT_ERR_TRANSPORT_OUTGOING_TRANSPORT_ALREADY_BRIDGED
}
 Command result codes for transport management group. More...
enum  transport_mgmt_config_type_t {
  TRANSPORT_MGMT_CONFIG_TYPE_UINT = 0 , TRANSPORT_MGMT_CONFIG_TYPE_INT , TRANSPORT_MGMT_CONFIG_TYPE_BOOL , TRANSPORT_MGMT_CONFIG_TYPE_STRING ,
  TRANSPORT_MGMT_CONFIG_TYPE_BYTE_STRING
}
 Config types. More...

Functions

bool transport_mgmt_is_bridged (struct smp_transport *transport, bool direction)
 Checks if a given transport is bridged or not.
struct smp_transporttransport_mgmt_get_other_transport (struct smp_transport *transport, bool direction)
 Gets the other transport which is part of a bridge.
const struct smp_transport_bridgetransport_mgmt_get_bridge (struct smp_transport *transport, bool direction)
 Gets a transport bridge context.
int transport_mgmt_disconnect_bridge (struct smp_transport_bridge *bridge)
 Disconnects an active bridge.
int transport_mgmt_disconnect_transport (struct smp_transport *transport, bool incoming, bool outgoing)
 Disconnects an active bridge.
int transport_mgmt_disconnect_all (void)
 Disconnects all active bridges.
const uint16_t transport_mgmt_group_id (void)
 Gets the group ID for transport management group.

Detailed Description

Header file for the MCUmgr transport management group API.