transport_mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025-2026 Nordic Semiconductor ASA
 * Copyright (c) 2026, Jamie McCrae
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_MGMT_MCUMGR_GRP_TRANSPORT_MGMT_TRANSPORT_MGMT_H_
#define ZEPHYR_INCLUDE_MGMT_MCUMGR_GRP_TRANSPORT_MGMT_TRANSPORT_MGMT_H_
 
#include <stdint.h>
#include <stdbool.h>
#include <zephyr/mgmt/mcumgr/transport/smp.h>
#include <zephyr/mgmt/mcumgr/mgmt/mgmt_defines.h>

 
#ifdef __cplusplus
extern "C" {
#endif

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,
 
        /*
         * The following are purposely at the end to be able to see if they have been excluded
         * when using enum mgmt due to being optional when using a custom derivative group ID
         */

        TRANSPORT_MGMT_ID_LIST,

        TRANSPORT_MGMT_ID_GET_MODES,

        TRANSPORT_MGMT_ID_GET_CONFIG_DETAILS,
};

#define TRANSPORT_MGMT_DIRECTION_INCOMING false

#define TRANSPORT_MGMT_DIRECTION_OUTGOING true

bool transport_mgmt_is_bridged(struct smp_transport *transport, bool direction);

struct smp_transport *transport_mgmt_get_other_transport(struct smp_transport *transport,
                                                         bool direction);

const struct smp_transport_bridge *transport_mgmt_get_bridge(struct smp_transport *transport,
                                                             bool direction);

 
#if defined(CONFIG_MCUMGR_GRP_TRANSPORT_LOCKING) || defined(__DOXYGEN__)
void transport_mgmt_lock(void);

void transport_mgmt_unlock(void);
#else
#define transport_mgmt_lock() (void)0
#define transport_mgmt_unlock() (void)0
#endif

bool transport_mgmt_is_bridged_internal(struct smp_transport *transport, bool direction);

const struct smp_transport_bridge *transport_mgmt_get_bridge_internal(
                                                        struct smp_transport *transport,
                                                        bool direction);


int transport_mgmt_disconnect_bridge(struct smp_transport_bridge *bridge);

int transport_mgmt_disconnect_transport(struct smp_transport *transport, bool incoming,
                                        bool outgoing);

int transport_mgmt_disconnect_all(void);

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,
};

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,
};
 
#if defined(CONFIG_MCUMGR_GRP_TRANSPORT_GROUP_ID_CUSTOM_FUNCTION) || defined(__DOXYGEN__)
const uint16_t transport_mgmt_group_id(void);
#elif defined(CONFIG_MCUMGR_GRP_TRANSPORT_GROUP_ID_CUSTOM_VALUE)
#define transport_mgmt_group_id() CONFIG_MCUMGR_GRP_TRANSPORT_GROUP_ID_CUSTOM_VALUE_GROUP_ID
#else
#define transport_mgmt_group_id() MGMT_GROUP_ID_TRANSPORT
#endif
 
#ifdef __cplusplus
}
#endif

 
#endif