conn.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2015-2016 Intel Corporation
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_CONN_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_CONN_H_

 
#include <stdbool.h>
#include <stdint.h>
 
#include <zephyr/bluetooth/addr.h>
#include <zephyr/bluetooth/bluetooth.h>
#include <zephyr/bluetooth/direction.h>
#include <zephyr/bluetooth/gap.h>
#include <zephyr/bluetooth/hci_types.h>
#include <zephyr/net_buf.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/sys/slist.h>
#include <zephyr/sys/util_macro.h>
#include <zephyr/toolchain.h>
 
#ifdef __cplusplus
extern "C" {
#endif

struct bt_conn;

struct bt_le_conn_param {
        uint16_t interval_min;
        uint16_t interval_max;
        uint16_t latency;
        uint16_t timeout;
};

#define BT_LE_CONN_PARAM_INIT(int_min, int_max, lat, to) \
{ \
        .interval_min = (int_min), \
        .interval_max = (int_max), \
        .latency = (lat), \
        .timeout = (to), \
}

#define BT_LE_CONN_PARAM(int_min, int_max, lat, to) \
        ((struct bt_le_conn_param[]) { \
                BT_LE_CONN_PARAM_INIT(int_min, int_max, lat, to) \
         })

#define BT_LE_CONN_PARAM_DEFAULT                                                                   \
        BT_LE_CONN_PARAM(BT_GAP_INIT_CONN_INT_MIN, BT_GAP_INIT_CONN_INT_MAX, 0,                    \
                         BT_GAP_MS_TO_CONN_TIMEOUT(4000))

struct bt_conn_le_phy_info {
        uint8_t tx_phy; 
        uint8_t rx_phy; 
};

enum {
        BT_CONN_LE_PHY_OPT_NONE = 0,

        BT_CONN_LE_PHY_OPT_CODED_S2  = BIT(0),

        BT_CONN_LE_PHY_OPT_CODED_S8  = BIT(1),
};

struct bt_conn_le_phy_param {
        uint16_t options; 
        uint8_t  pref_tx_phy; 
        uint8_t  pref_rx_phy; 
};

#define BT_CONN_LE_PHY_PARAM_INIT(_pref_tx_phy, _pref_rx_phy) \
{ \
        .options = BT_CONN_LE_PHY_OPT_NONE, \
        .pref_tx_phy = (_pref_tx_phy), \
        .pref_rx_phy = (_pref_rx_phy), \
}

#define BT_CONN_LE_PHY_PARAM(_pref_tx_phy, _pref_rx_phy) \
        ((struct bt_conn_le_phy_param []) { \
                BT_CONN_LE_PHY_PARAM_INIT(_pref_tx_phy, _pref_rx_phy) \
         })

#define BT_CONN_LE_PHY_PARAM_1M BT_CONN_LE_PHY_PARAM(BT_GAP_LE_PHY_1M, \
                                                     BT_GAP_LE_PHY_1M)

#define BT_CONN_LE_PHY_PARAM_2M BT_CONN_LE_PHY_PARAM(BT_GAP_LE_PHY_2M, \
                                                     BT_GAP_LE_PHY_2M)

#define BT_CONN_LE_PHY_PARAM_CODED BT_CONN_LE_PHY_PARAM(BT_GAP_LE_PHY_CODED, \
                                                        BT_GAP_LE_PHY_CODED)

#define BT_CONN_LE_PHY_PARAM_ALL BT_CONN_LE_PHY_PARAM(BT_GAP_LE_PHY_1M |   \
                                                      BT_GAP_LE_PHY_2M |   \
                                                      BT_GAP_LE_PHY_CODED, \
                                                      BT_GAP_LE_PHY_1M |   \
                                                      BT_GAP_LE_PHY_2M |   \
                                                      BT_GAP_LE_PHY_CODED)

struct bt_conn_le_data_len_info {
        uint16_t tx_max_len;
        uint16_t tx_max_time;
        uint16_t rx_max_len;
        uint16_t rx_max_time;
};

struct bt_conn_le_data_len_param {
        uint16_t tx_max_len;
        uint16_t tx_max_time;
};

#define BT_CONN_LE_DATA_LEN_PARAM_INIT(_tx_max_len, _tx_max_time) \
{ \
        .tx_max_len = (_tx_max_len), \
        .tx_max_time = (_tx_max_time), \
}

#define BT_CONN_LE_DATA_LEN_PARAM(_tx_max_len, _tx_max_time) \
        ((struct bt_conn_le_data_len_param[]) { \
                BT_CONN_LE_DATA_LEN_PARAM_INIT(_tx_max_len, _tx_max_time) \
         })

#define BT_LE_DATA_LEN_PARAM_DEFAULT \
        BT_CONN_LE_DATA_LEN_PARAM(BT_GAP_DATA_LEN_DEFAULT, \
                                  BT_GAP_DATA_TIME_DEFAULT)

#define BT_LE_DATA_LEN_PARAM_MAX \
        BT_CONN_LE_DATA_LEN_PARAM(BT_GAP_DATA_LEN_MAX, \
                                  BT_GAP_DATA_TIME_MAX)

struct bt_conn_le_subrate_param {
        uint16_t subrate_min;
        uint16_t subrate_max;
        uint16_t max_latency;
        uint16_t continuation_number;
        uint16_t supervision_timeout;
};

struct bt_conn_le_subrating_info {
        uint16_t factor;
        uint16_t continuation_number;
};

struct bt_conn_le_subrate_changed {
        uint8_t status;
        uint16_t factor;
        uint16_t continuation_number;
        uint16_t peripheral_latency;
        uint16_t supervision_timeout;
};

#define BT_CONN_LE_MAX_CONN_INTERVAL_GROUPS 41

struct bt_conn_le_min_conn_interval_group {
        uint16_t min_125us;
        uint16_t max_125us;
        uint16_t stride_125us;
};

struct bt_conn_le_min_conn_interval_info {
        uint16_t min_supported_conn_interval_us;
        uint8_t num_groups;
        struct bt_conn_le_min_conn_interval_group groups[BT_CONN_LE_MAX_CONN_INTERVAL_GROUPS];
};

struct bt_conn_le_conn_rate_param {
        uint16_t interval_min_125us;
        uint16_t interval_max_125us;
        uint16_t subrate_min;
        uint16_t subrate_max;
        uint16_t max_latency;
        uint16_t continuation_number;
        uint16_t supervision_timeout_10ms;
        uint16_t min_ce_len_125us;
        uint16_t max_ce_len_125us;
};

struct bt_conn_le_conn_rate_changed {
        uint32_t interval_us;
        uint16_t subrate_factor;
        uint16_t peripheral_latency;
        uint16_t continuation_number;
        uint16_t supervision_timeout_10ms;
};

struct bt_conn_le_read_all_remote_feat_complete {
        uint8_t status;
        uint8_t max_remote_page;
        uint8_t max_valid_page;
        const uint8_t *features;
};
 
#define BT_CONN_LE_FRAME_SPACE_TYPES_MASK_ACL_IFS                    \
        (BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_IFS_ACL_CP_MASK | \
         BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_IFS_ACL_PC_MASK)
 
#define BT_CONN_LE_FRAME_SPACE_TYPES_MASK_ACL                        \
        (BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_IFS_ACL_CP_MASK | \
         BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_IFS_ACL_PC_MASK | \
         BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_MCES_MASK)
 
#define BT_CONN_LE_FRAME_SPACE_TYPES_MASK_CIS                     \
        (BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_IFS_CIS_MASK | \
         BT_HCI_LE_FRAME_SPACE_UPDATE_SPACING_TYPE_MSS_CIS_MASK)

#define BT_CONN_LE_FRAME_SPACE_MAX (10000U)

enum bt_conn_le_frame_space_update_initiator {
        BT_CONN_LE_FRAME_SPACE_UPDATE_INITIATOR_LOCAL_HOST =
                BT_HCI_LE_FRAME_SPACE_UPDATE_INITIATOR_LOCAL_HOST,
        BT_CONN_LE_FRAME_SPACE_UPDATE_INITIATOR_LOCAL_CONTROLLER =
                BT_HCI_LE_FRAME_SPACE_UPDATE_INITIATOR_LOCAL_CONTROLLER,
        BT_CONN_LE_FRAME_SPACE_UPDATE_INITIATOR_PEER =
                BT_HCI_LE_FRAME_SPACE_UPDATE_INITIATOR_PEER
};

struct bt_conn_le_frame_space_update_param {
        uint8_t phys;
        uint16_t spacing_types;
        uint16_t frame_space_min;
        uint16_t frame_space_max;
};

struct bt_conn_le_frame_space_updated {
        uint8_t status;
        enum bt_conn_le_frame_space_update_initiator initiator;
        uint16_t frame_space;
        uint8_t phys;
        uint16_t spacing_types;
};

enum __packed bt_conn_type {
        BT_CONN_TYPE_LE = BIT(0),
        BT_CONN_TYPE_BR = BIT(1),
        BT_CONN_TYPE_SCO = BIT(2),
        BT_CONN_TYPE_ISO = BIT(3),
        BT_CONN_TYPE_ALL = BT_CONN_TYPE_LE | BT_CONN_TYPE_BR |
                           BT_CONN_TYPE_SCO | BT_CONN_TYPE_ISO,
};

enum bt_conn_le_cs_capability_rtt_aa_only {
        BT_CONN_LE_CS_RTT_AA_ONLY_NOT_SUPP = 0,
        BT_CONN_LE_CS_RTT_AA_ONLY_10NS,
        BT_CONN_LE_CS_RTT_AA_ONLY_150NS,
};

enum bt_conn_le_cs_capability_rtt_sounding {
        BT_CONN_LE_CS_RTT_SOUNDING_NOT_SUPP = 0,
        BT_CONN_LE_CS_RTT_SOUNDING_10NS,
        BT_CONN_LE_CS_RTT_SOUNDING_150NS,
};

enum bt_conn_le_cs_capability_rtt_random_payload {
        BT_CONN_LE_CS_RTT_RANDOM_PAYLOAD_NOT_SUPP = 0,
        BT_CONN_LE_CS_RTT_RANDOM_PAYLOAD_10NS,
        BT_CONN_LE_CS_RTT_RANDOM_PAYLOAD_150NS,
};

struct bt_conn_le_cs_capabilities {
        uint8_t num_config_supported;
        uint16_t max_consecutive_procedures_supported;
        uint8_t num_antennas_supported;
        uint8_t max_antenna_paths_supported;
        bool initiator_supported;
        bool reflector_supported;
        bool mode_3_supported;
        enum bt_conn_le_cs_capability_rtt_aa_only rtt_aa_only_precision;
        enum bt_conn_le_cs_capability_rtt_sounding rtt_sounding_precision;
        enum bt_conn_le_cs_capability_rtt_random_payload rtt_random_payload_precision;
        uint8_t rtt_aa_only_n;
        uint8_t rtt_sounding_n;
        uint8_t rtt_random_payload_n;
        bool phase_based_nadm_sounding_supported;
        bool phase_based_nadm_random_supported;
        bool cs_sync_2m_phy_supported;
        bool cs_sync_2m_2bt_phy_supported;
        bool cs_without_fae_supported;
        bool chsel_alg_3c_supported;
        bool pbr_from_rtt_sounding_seq_supported;
        bool cs_ipt_reflector;
        uint16_t t_ip1_times_supported;
        uint16_t t_ip2_times_supported;
        uint16_t t_fcs_times_supported;
        uint16_t t_pm_times_supported;
        uint8_t t_sw_time;
        uint8_t tx_snr_capability;
        uint16_t t_ip2_ipt_times_supported;
        uint8_t t_sw_ipt_time_supported;
};

struct bt_conn_le_cs_fae_table {
        int8_t *remote_fae_table;
};

#define BT_CONN_LE_CS_MODE_MAIN_MODE_PART(x) ((x) & 0x3)

#define BT_CONN_LE_CS_MODE_SUB_MODE_PART(x)  (((x) >> 4) & 0x3)

enum bt_conn_le_cs_mode {
        BT_CONN_LE_CS_MAIN_MODE_1_NO_SUB_MODE = BT_HCI_OP_LE_CS_MAIN_MODE_1,
        BT_CONN_LE_CS_MAIN_MODE_2_NO_SUB_MODE = BT_HCI_OP_LE_CS_MAIN_MODE_2,
        BT_CONN_LE_CS_MAIN_MODE_3_NO_SUB_MODE = BT_HCI_OP_LE_CS_MAIN_MODE_3,
        BT_CONN_LE_CS_MAIN_MODE_2_SUB_MODE_1 = BT_HCI_OP_LE_CS_MAIN_MODE_2 |
                                              (BT_HCI_OP_LE_CS_SUB_MODE_1 << 4),
        BT_CONN_LE_CS_MAIN_MODE_2_SUB_MODE_3 = BT_HCI_OP_LE_CS_MAIN_MODE_2 |
                                              (BT_HCI_OP_LE_CS_SUB_MODE_3 << 4),
        BT_CONN_LE_CS_MAIN_MODE_3_SUB_MODE_2 = BT_HCI_OP_LE_CS_MAIN_MODE_3 |
                                              (BT_HCI_OP_LE_CS_SUB_MODE_2 << 4),
};

enum bt_conn_le_cs_role {
        BT_CONN_LE_CS_ROLE_INITIATOR,
        BT_CONN_LE_CS_ROLE_REFLECTOR,
};

enum bt_conn_le_cs_rtt_type {
        BT_CONN_LE_CS_RTT_TYPE_AA_ONLY = BT_HCI_OP_LE_CS_RTT_TYPE_AA_ONLY,
        BT_CONN_LE_CS_RTT_TYPE_32_BIT_SOUNDING = BT_HCI_OP_LE_CS_RTT_TYPE_32BIT_SOUND,
        BT_CONN_LE_CS_RTT_TYPE_96_BIT_SOUNDING = BT_HCI_OP_LE_CS_RTT_TYPE_96BIT_SOUND,
        BT_CONN_LE_CS_RTT_TYPE_32_BIT_RANDOM = BT_HCI_OP_LE_CS_RTT_TYPE_32BIT_RAND,
        BT_CONN_LE_CS_RTT_TYPE_64_BIT_RANDOM = BT_HCI_OP_LE_CS_RTT_TYPE_64BIT_RAND,
        BT_CONN_LE_CS_RTT_TYPE_96_BIT_RANDOM = BT_HCI_OP_LE_CS_RTT_TYPE_96BIT_RAND,
        BT_CONN_LE_CS_RTT_TYPE_128_BIT_RANDOM = BT_HCI_OP_LE_CS_RTT_TYPE_128BIT_RAND,
};

enum bt_conn_le_cs_sync_phy {
        BT_CONN_LE_CS_SYNC_1M_PHY = BT_HCI_OP_LE_CS_CS_SYNC_1M,
        BT_CONN_LE_CS_SYNC_2M_PHY = BT_HCI_OP_LE_CS_CS_SYNC_2M,
        BT_CONN_LE_CS_SYNC_2M_2BT_PHY = BT_HCI_OP_LE_CS_CS_SYNC_2M_2BT,
};

enum bt_conn_le_cs_chsel_type {
        BT_CONN_LE_CS_CHSEL_TYPE_3B = BT_HCI_OP_LE_CS_TEST_CHSEL_TYPE_3B,
        BT_CONN_LE_CS_CHSEL_TYPE_3C = BT_HCI_OP_LE_CS_TEST_CHSEL_TYPE_3C,
};

enum bt_conn_le_cs_ch3c_shape {
        BT_CONN_LE_CS_CH3C_SHAPE_HAT = BT_HCI_OP_LE_CS_TEST_CH3C_SHAPE_HAT,
        BT_CONN_LE_CS_CH3C_SHAPE_X = BT_HCI_OP_LE_CS_TEST_CH3C_SHAPE_X,
};

struct bt_conn_le_cs_config {
        uint8_t id;
        enum bt_conn_le_cs_mode mode;
        uint8_t min_main_mode_steps;
        uint8_t max_main_mode_steps;
        uint8_t main_mode_repetition;
        uint8_t mode_0_steps;
        enum bt_conn_le_cs_role role;
        enum bt_conn_le_cs_rtt_type rtt_type;
        enum bt_conn_le_cs_sync_phy cs_sync_phy;
        uint8_t channel_map_repetition;
        enum bt_conn_le_cs_chsel_type channel_selection_type;
        enum bt_conn_le_cs_ch3c_shape ch3c_shape;
        uint8_t ch3c_jump;
        uint8_t cs_enhancements_1;
        uint8_t t_ip1_time_us;
        uint8_t t_ip2_time_us;
        uint8_t t_fcs_time_us;
        uint8_t t_pm_time_us;
        uint8_t channel_map[10];
};

enum bt_conn_le_cs_procedure_done_status {
        BT_CONN_LE_CS_PROCEDURE_COMPLETE = BT_HCI_LE_CS_PROCEDURE_DONE_STATUS_COMPLETE,
        BT_CONN_LE_CS_PROCEDURE_INCOMPLETE = BT_HCI_LE_CS_PROCEDURE_DONE_STATUS_PARTIAL,
        BT_CONN_LE_CS_PROCEDURE_ABORTED = BT_HCI_LE_CS_PROCEDURE_DONE_STATUS_ABORTED,
};

enum bt_conn_le_cs_subevent_done_status {
        BT_CONN_LE_CS_SUBEVENT_COMPLETE = BT_HCI_LE_CS_SUBEVENT_DONE_STATUS_COMPLETE,
        BT_CONN_LE_CS_SUBEVENT_ABORTED = BT_HCI_LE_CS_SUBEVENT_DONE_STATUS_ABORTED,
};

enum bt_conn_le_cs_procedure_abort_reason {
        BT_CONN_LE_CS_PROCEDURE_NOT_ABORTED = BT_HCI_LE_CS_PROCEDURE_ABORT_REASON_NO_ABORT,
        BT_CONN_LE_CS_PROCEDURE_ABORT_REQUESTED =
                BT_HCI_LE_CS_PROCEDURE_ABORT_REASON_LOCAL_HOST_OR_REMOTE_REQUEST,
        BT_CONN_LE_CS_PROCEDURE_ABORT_TOO_FEW_CHANNELS =
                BT_HCI_LE_CS_PROCEDURE_ABORT_REASON_TOO_FEW_CHANNELS,
        BT_CONN_LE_CS_PROCEDURE_ABORT_CHMAP_INSTANT_PASSED =
                BT_HCI_LE_CS_PROCEDURE_ABORT_REASON_CHMAP_INSTANT_PASSED,
        BT_CONN_LE_CS_PROCEDURE_ABORT_UNSPECIFIED = BT_HCI_LE_CS_PROCEDURE_ABORT_REASON_UNSPECIFIED,
};

enum bt_conn_le_cs_subevent_abort_reason {
        BT_CONN_LE_CS_SUBEVENT_NOT_ABORTED = BT_HCI_LE_CS_SUBEVENT_ABORT_REASON_NO_ABORT,
        BT_CONN_LE_CS_SUBEVENT_ABORT_REQUESTED =
                BT_HCI_LE_CS_SUBEVENT_ABORT_REASON_LOCAL_HOST_OR_REMOTE_REQUEST,
        BT_CONN_LE_CS_SUBEVENT_ABORT_NO_CS_SYNC =
                BT_HCI_LE_CS_SUBEVENT_ABORT_REASON_NO_CS_SYNC_RECEIVED,
        BT_CONN_LE_CS_SUBEVENT_ABORT_SCHED_CONFLICT =
                BT_HCI_LE_CS_SUBEVENT_ABORT_REASON_SCHED_CONFLICT,
        BT_CONN_LE_CS_SUBEVENT_ABORT_UNSPECIFIED = BT_HCI_LE_CS_SUBEVENT_ABORT_REASON_UNSPECIFIED,
};

struct bt_conn_le_cs_subevent_result {
        struct {
                uint8_t config_id;
                uint16_t start_acl_conn_event;
                uint16_t procedure_counter;
                uint16_t frequency_compensation;
                int8_t reference_power_level;
                enum bt_conn_le_cs_procedure_done_status procedure_done_status;
                enum bt_conn_le_cs_subevent_done_status subevent_done_status;
                enum bt_conn_le_cs_procedure_abort_reason procedure_abort_reason;
                enum bt_conn_le_cs_subevent_abort_reason subevent_abort_reason;
                uint8_t num_antenna_paths;
                uint8_t num_steps_reported;
                uint8_t abort_step;
        } header;
        struct net_buf_simple *step_data_buf;
};

struct bt_conn *bt_conn_ref(struct bt_conn *conn);

void bt_conn_unref(struct bt_conn *conn);

void bt_conn_foreach(enum bt_conn_type type,
                     void (*func)(struct bt_conn *conn, void *data),
                     void *data);

struct bt_conn *bt_conn_lookup_addr_le(uint8_t id, const bt_addr_le_t *peer);

const bt_addr_le_t *bt_conn_get_dst(const struct bt_conn *conn);

uint8_t bt_conn_index(const struct bt_conn *conn);

struct bt_conn_le_info {
        const bt_addr_le_t *src;
        const bt_addr_le_t *dst;
        const bt_addr_le_t *local;
        const bt_addr_le_t *remote;
        uint32_t interval_us;
#if !defined(CONFIG_BT_SHORTER_CONNECTION_INTERVALS) || defined(__DOXYGEN__)
        union {
                __deprecated uint16_t interval;
                uint16_t _interval;
        };
#endif /* !CONFIG_BT_SHORTER_CONNECTION_INTERVALS */
 
        uint16_t latency; 
        uint16_t timeout; 
 
#if defined(CONFIG_BT_USER_PHY_UPDATE)
        const struct bt_conn_le_phy_info      *phy;
#endif /* defined(CONFIG_BT_USER_PHY_UPDATE) */
 
#if defined(CONFIG_BT_USER_DATA_LEN_UPDATE)
        /* Connection maximum single fragment parameters */
        const struct bt_conn_le_data_len_info *data_len;
#endif /* defined(CONFIG_BT_USER_DATA_LEN_UPDATE) */
 
#if defined(CONFIG_BT_SUBRATING)
        /* Connection subrating parameters */
        const struct bt_conn_le_subrating_info *subrate;
#endif /* defined(CONFIG_BT_SUBRATING) */
};

#define BT_CONN_INTERVAL_TO_MS(interval) ((interval) * 5U / 4U)

#define BT_CONN_INTERVAL_TO_US(interval) ((interval) * 1250U)

#define BT_CONN_SCI_INTERVAL_TO_US(_interval) ((_interval) * BT_HCI_LE_SCI_INTERVAL_UNIT_US)

struct bt_conn_br_info {
        const bt_addr_t *dst; 
};

struct bt_conn_sco_info {
        uint8_t link_type; 
        uint8_t air_mode;  
};
 
enum {
        BT_CONN_ROLE_CENTRAL = 0,
        BT_CONN_ROLE_PERIPHERAL = 1,
};
 
enum bt_conn_state {
        BT_CONN_STATE_DISCONNECTED,
        BT_CONN_STATE_CONNECTING,
        BT_CONN_STATE_CONNECTED,
        BT_CONN_STATE_DISCONNECTING,
};

typedef enum __packed {
        BT_SECURITY_L0,
        BT_SECURITY_L1,
        BT_SECURITY_L2,
        BT_SECURITY_L3,
        BT_SECURITY_L4,
        BT_SECURITY_FORCE_PAIR = BIT(7),
} bt_security_t;

enum bt_security_flag {
        BT_SECURITY_FLAG_SC = BIT(0),
        BT_SECURITY_FLAG_OOB = BIT(1),
};

struct bt_security_info {
        bt_security_t level;
        uint8_t enc_key_size;
        enum bt_security_flag flags;
};

struct bt_conn_info {
        enum bt_conn_type type;
        uint8_t role;
        uint8_t id;
        union {
                struct bt_conn_le_info le;
                struct bt_conn_br_info br;
                struct bt_conn_sco_info sco;
        };
        enum bt_conn_state state;
        struct bt_security_info security;
};

struct bt_conn_le_remote_info {

        const uint8_t *features;
};

struct bt_conn_br_remote_info {

        const uint8_t *features;

        uint8_t num_pages;
};

struct bt_conn_remote_info {
        uint8_t  type;

        uint8_t  version;

        uint16_t manufacturer;

        uint16_t subversion;
 
        union {
                struct bt_conn_le_remote_info le;

                struct bt_conn_br_remote_info br;
        };
};
 
enum bt_conn_le_tx_power_phy {
        BT_CONN_LE_TX_POWER_PHY_NONE,
        BT_CONN_LE_TX_POWER_PHY_1M,
        BT_CONN_LE_TX_POWER_PHY_2M,
        BT_CONN_LE_TX_POWER_PHY_CODED_S8,
        BT_CONN_LE_TX_POWER_PHY_CODED_S2,
};

struct bt_conn_le_tx_power {

        uint8_t phy;

        int8_t current_level;

        int8_t max_level;
};
 

struct bt_conn_le_tx_power_report {

        uint8_t reason;

        enum bt_conn_le_tx_power_phy phy;

        int8_t tx_power_level;

        uint8_t tx_power_level_flag;

        int8_t delta;
};

enum bt_conn_le_path_loss_zone {
        BT_CONN_LE_PATH_LOSS_ZONE_ENTERED_LOW,
        BT_CONN_LE_PATH_LOSS_ZONE_ENTERED_MIDDLE,
        BT_CONN_LE_PATH_LOSS_ZONE_ENTERED_HIGH,
        BT_CONN_LE_PATH_LOSS_ZONE_UNAVAILABLE,
};
 
BUILD_ASSERT(BT_CONN_LE_PATH_LOSS_ZONE_ENTERED_LOW == BT_HCI_LE_ZONE_ENTERED_LOW);
BUILD_ASSERT(BT_CONN_LE_PATH_LOSS_ZONE_ENTERED_MIDDLE == BT_HCI_LE_ZONE_ENTERED_MIDDLE);
BUILD_ASSERT(BT_CONN_LE_PATH_LOSS_ZONE_ENTERED_HIGH == BT_HCI_LE_ZONE_ENTERED_HIGH);

struct bt_conn_le_path_loss_threshold_report {

        enum bt_conn_le_path_loss_zone zone;

        uint8_t path_loss;
};

struct bt_conn_le_path_loss_reporting_param {
        uint8_t high_threshold;
        uint8_t high_hysteresis;
        uint8_t low_threshold;
        uint8_t low_hysteresis;
        uint16_t min_time_spent;
};

enum bt_conn_auth_keypress {
        BT_CONN_AUTH_KEYPRESS_ENTRY_STARTED = 0x00,
        BT_CONN_AUTH_KEYPRESS_DIGIT_ENTERED = 0x01,
        BT_CONN_AUTH_KEYPRESS_DIGIT_ERASED = 0x02,
        BT_CONN_AUTH_KEYPRESS_CLEARED = 0x03,
        BT_CONN_AUTH_KEYPRESS_ENTRY_COMPLETED = 0x04,
};

int bt_conn_get_info(const struct bt_conn *conn, struct bt_conn_info *info);

struct bt_conn_tmp_str {
        /* BT_ADDR_LE_STR_LEN covers both BR/EDR and LE string lengths */
        char str[BT_ADDR_LE_STR_LEN];
};
 
struct bt_conn_tmp_str bt_conn_dst_tmp_str(const struct bt_conn *conn);

#define bt_conn_dst_str(_conn) bt_conn_dst_tmp_str(_conn).str

bool bt_conn_is_type(const struct bt_conn *conn, enum bt_conn_type type);

int bt_conn_get_remote_info(const struct bt_conn *conn, struct bt_conn_remote_info *remote_info);

int bt_conn_le_get_tx_power_level(struct bt_conn *conn,
                                  struct bt_conn_le_tx_power *tx_power_level);

int bt_conn_le_enhanced_get_tx_power_level(struct bt_conn *conn,
                                           struct bt_conn_le_tx_power *tx_power);

int bt_conn_le_get_remote_tx_power_level(struct bt_conn *conn,
                                         enum bt_conn_le_tx_power_phy phy);

int bt_conn_le_set_tx_power_report_enable(struct bt_conn *conn,
                                          bool local_enable,
                                          bool remote_enable);

int bt_conn_le_set_path_loss_mon_param(struct bt_conn *conn,
                                       const struct bt_conn_le_path_loss_reporting_param *param);

int bt_conn_le_set_path_loss_mon_enable(struct bt_conn *conn, bool enable);

int bt_conn_le_subrate_set_defaults(const struct bt_conn_le_subrate_param *params);

int bt_conn_le_subrate_request(struct bt_conn *conn,
                               const struct bt_conn_le_subrate_param *params);

int bt_conn_le_read_min_conn_interval_groups(struct bt_conn_le_min_conn_interval_info *info);

int bt_conn_le_read_min_conn_interval(uint16_t *min_interval_us);

int bt_conn_le_conn_rate_set_defaults(const struct bt_conn_le_conn_rate_param *params);

int bt_conn_le_conn_rate_request(struct bt_conn *conn,
                                 const struct bt_conn_le_conn_rate_param *params);

int bt_conn_le_read_all_remote_features(struct bt_conn *conn, uint8_t pages_requested);

int bt_conn_le_frame_space_update(struct bt_conn *conn,
                                  const struct bt_conn_le_frame_space_update_param *params);

int bt_conn_le_param_update(struct bt_conn *conn,
                            const struct bt_le_conn_param *param);

int bt_conn_le_data_len_update(struct bt_conn *conn,
                               const struct bt_conn_le_data_len_param *param);

int bt_conn_le_phy_update(struct bt_conn *conn,
                          const struct bt_conn_le_phy_param *param);

int bt_conn_le_set_default_phy(uint8_t pref_tx_phy, uint8_t pref_rx_phy);

int bt_conn_disconnect(struct bt_conn *conn, uint8_t reason);
 
enum {
        BT_CONN_LE_OPT_NONE = 0,

        BT_CONN_LE_OPT_CODED = BIT(0),

        BT_CONN_LE_OPT_NO_1M = BIT(1),
};
 
struct bt_conn_le_create_param {

        uint32_t options;

        uint16_t interval;

        uint16_t window;

        uint16_t interval_coded;

        uint16_t window_coded;

        uint16_t timeout;
};

#define BT_CONN_LE_CREATE_PARAM_INIT(_options, _interval, _window) \
{ \
        .options = (_options), \
        .interval = (_interval), \
        .window = (_window), \
        .interval_coded = 0, \
        .window_coded = 0, \
        .timeout = 0, \
}

#define BT_CONN_LE_CREATE_PARAM(_options, _interval, _window) \
        ((struct bt_conn_le_create_param[]) { \
                BT_CONN_LE_CREATE_PARAM_INIT(_options, _interval, _window) \
         })

#define BT_CONN_LE_CREATE_CONN \
        BT_CONN_LE_CREATE_PARAM(BT_CONN_LE_OPT_NONE, \
                                BT_GAP_SCAN_FAST_INTERVAL, \
                                BT_GAP_SCAN_FAST_INTERVAL)

#define BT_CONN_LE_CREATE_CONN_AUTO \
        BT_CONN_LE_CREATE_PARAM(BT_CONN_LE_OPT_NONE, \
                                BT_GAP_SCAN_FAST_INTERVAL, \
                                BT_GAP_SCAN_FAST_WINDOW)

int bt_conn_le_create(const bt_addr_le_t *peer,
                      const struct bt_conn_le_create_param *create_param,
                      const struct bt_le_conn_param *conn_param,
                      struct bt_conn **conn);
 
struct bt_conn_le_create_synced_param {

        const bt_addr_le_t *peer;

        uint8_t subevent;
};

int bt_conn_le_create_synced(const struct bt_le_ext_adv *adv,
                             const struct bt_conn_le_create_synced_param *synced_param,
                             const struct bt_le_conn_param *conn_param, struct bt_conn **conn);

int bt_conn_le_create_auto(const struct bt_conn_le_create_param *create_param,
                           const struct bt_le_conn_param *conn_param);

int bt_conn_create_auto_stop(void);

int bt_conn_set_security(struct bt_conn *conn, bt_security_t sec);

bt_security_t bt_conn_get_security(const struct bt_conn *conn);

uint8_t bt_conn_enc_key_size(const struct bt_conn *conn);
 
enum bt_security_err {
        BT_SECURITY_ERR_SUCCESS,

        BT_SECURITY_ERR_AUTH_FAIL,

        BT_SECURITY_ERR_PIN_OR_KEY_MISSING,

        BT_SECURITY_ERR_OOB_NOT_AVAILABLE,

        BT_SECURITY_ERR_AUTH_REQUIREMENT,

        BT_SECURITY_ERR_PAIR_NOT_SUPPORTED,

        BT_SECURITY_ERR_PAIR_NOT_ALLOWED,

        BT_SECURITY_ERR_INVALID_PARAM,

        BT_SECURITY_ERR_KEY_REJECTED,

        BT_SECURITY_ERR_UNSPECIFIED,
};
 
enum bt_conn_le_cs_procedure_enable_state {
        BT_CONN_LE_CS_PROCEDURES_DISABLED = BT_HCI_OP_LE_CS_PROCEDURES_DISABLED,
        BT_CONN_LE_CS_PROCEDURES_ENABLED = BT_HCI_OP_LE_CS_PROCEDURES_ENABLED,
};

enum bt_conn_le_cs_tone_antenna_config_selection {
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A1_B1 = BT_HCI_OP_LE_CS_ACI_0,
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A2_B1 = BT_HCI_OP_LE_CS_ACI_1,
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A3_B1 = BT_HCI_OP_LE_CS_ACI_2,
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A4_B1 = BT_HCI_OP_LE_CS_ACI_3,
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A1_B2 = BT_HCI_OP_LE_CS_ACI_4,
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A1_B3 = BT_HCI_OP_LE_CS_ACI_5,
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A1_B4 = BT_HCI_OP_LE_CS_ACI_6,
        BT_LE_CS_TONE_ANTENNA_CONFIGURATION_A2_B2 = BT_HCI_OP_LE_CS_ACI_7,
};
 
struct bt_conn_le_cs_procedure_enable_complete {
        /* The ID associated with the desired configuration (0 to 3) */
        uint8_t config_id;
 
        /* State of the CS procedure */
        enum bt_conn_le_cs_procedure_enable_state state;
 
        /* Antenna configuration index */
        enum bt_conn_le_cs_tone_antenna_config_selection tone_antenna_config_selection;
 
        /* Transmit power level used for CS procedures (-127 to 20 dB; 0x7F if unavailable) */
        int8_t selected_tx_power;
 
        /* Duration of each CS subevent in microseconds (1250 us to 4 s) */
        uint32_t subevent_len;
 
        /* Number of CS subevents anchored off the same ACL connection event (0x01 to 0x20) */
        uint8_t subevents_per_event;
 
        /* Time between consecutive CS subevents anchored off the same ACL connection event in
         * units of 0.625 ms
         */
        uint16_t subevent_interval;
 
        /* Number of ACL connection events between consecutive CS event anchor points */
        uint16_t event_interval;
 
        /* Number of ACL connection events between consecutive CS procedure anchor points */
        uint16_t procedure_interval;
 
        /* Number of CS procedures to be scheduled (0 if procedures to continue until disabled) */
        uint16_t procedure_count;
 
        /* Maximum duration for each procedure in units of 0.625 ms (0x0001 to 0xFFFF) */
        uint16_t max_procedure_len;
};

struct bt_conn_cb {
        void (*connected)(struct bt_conn *conn, uint8_t err);

        void (*disconnected)(struct bt_conn *conn, uint8_t reason);

        void (*recycled)(void);

        bool (*le_param_req)(struct bt_conn *conn,
                             struct bt_le_conn_param *param);

        void (*le_param_updated)(struct bt_conn *conn, uint16_t interval,
                                 uint16_t latency, uint16_t timeout);
#if defined(CONFIG_BT_SMP)
        void (*identity_resolved)(struct bt_conn *conn,
                                  const bt_addr_le_t *rpa,
                                  const bt_addr_le_t *identity);
#endif /* CONFIG_BT_SMP */
#if defined(CONFIG_BT_SMP) || defined(CONFIG_BT_CLASSIC)
        void (*security_changed)(struct bt_conn *conn, bt_security_t level,
                                 enum bt_security_err err);
#endif /* defined(CONFIG_BT_SMP) || defined(CONFIG_BT_CLASSIC) */
 
#if defined(CONFIG_BT_REMOTE_INFO)
        void (*remote_info_available)(struct bt_conn *conn,
                                      struct bt_conn_remote_info *remote_info);
#endif /* defined(CONFIG_BT_REMOTE_INFO) */
 
#if defined(CONFIG_BT_POWER_MODE_CONTROL)
        void (*br_mode_changed)(struct bt_conn *conn, uint8_t mode, uint16_t interval);
#endif /* CONFIG_BT_POWER_MODE_CONTROL */
 
#if defined(CONFIG_BT_USER_PHY_UPDATE)
        void (*le_phy_updated)(struct bt_conn *conn,
                               struct bt_conn_le_phy_info *param);
#endif /* defined(CONFIG_BT_USER_PHY_UPDATE) */
 
#if defined(CONFIG_BT_USER_DATA_LEN_UPDATE)
        void (*le_data_len_updated)(struct bt_conn *conn,
                                    struct bt_conn_le_data_len_info *info);
#endif /* defined(CONFIG_BT_USER_DATA_LEN_UPDATE) */
 
#if defined(CONFIG_BT_DF_CONNECTION_CTE_RX)
        void (*cte_report_cb)(struct bt_conn *conn,
                              const struct bt_df_conn_iq_samples_report *iq_report);
#endif /* CONFIG_BT_DF_CONNECTION_CTE_RX */
 
#if defined(CONFIG_BT_TRANSMIT_POWER_CONTROL)
        void (*tx_power_report)(struct bt_conn *conn,
                                const struct bt_conn_le_tx_power_report *report);
#endif /* CONFIG_BT_TRANSMIT_POWER_CONTROL */
 
#if defined(CONFIG_BT_PATH_LOSS_MONITORING)
        void (*path_loss_threshold_report)(struct bt_conn *conn,
                                const struct bt_conn_le_path_loss_threshold_report *report);
#endif /* CONFIG_BT_PATH_LOSS_MONITORING */
 
#if defined(CONFIG_BT_SUBRATING)
        void (*subrate_changed)(struct bt_conn *conn,
                                const struct bt_conn_le_subrate_changed *params);
#endif /* CONFIG_BT_SUBRATING */
 
#if defined(CONFIG_BT_SHORTER_CONNECTION_INTERVALS) || defined(__DOXYGEN__)
        void (*conn_rate_changed)(struct bt_conn *conn, uint8_t status,
                                  const struct bt_conn_le_conn_rate_changed *params);
#endif /* CONFIG_BT_SHORTER_CONNECTION_INTERVALS */
 
#if defined(CONFIG_BT_LE_EXTENDED_FEAT_SET)
        void (*read_all_remote_feat_complete)(
                struct bt_conn *conn,
                const struct bt_conn_le_read_all_remote_feat_complete *params);
#endif /* CONFIG_BT_LE_EXTENDED_FEAT_SET */
 
#if defined(CONFIG_BT_FRAME_SPACE_UPDATE)
        void (*frame_space_updated)(
                struct bt_conn *conn,
                const struct bt_conn_le_frame_space_updated *params);
#endif /* CONFIG_BT_FRAME_SPACE_UPDATE */
 
#if defined(CONFIG_BT_CHANNEL_SOUNDING)
        void (*le_cs_read_remote_capabilities_complete)(struct bt_conn *conn,
                                                        uint8_t status,
                                                        struct bt_conn_le_cs_capabilities *params);

        void (*le_cs_read_remote_fae_table_complete)(struct bt_conn *conn,
                                                     uint8_t status,
                                                     struct bt_conn_le_cs_fae_table *params);

        void (*le_cs_config_complete)(struct bt_conn *conn,
                                      uint8_t status,
                                      struct bt_conn_le_cs_config *config);

        void (*le_cs_config_removed)(struct bt_conn *conn, uint8_t config_id);

        void (*le_cs_subevent_data_available)(struct bt_conn *conn,
                                              struct bt_conn_le_cs_subevent_result *result);

        void (*le_cs_security_enable_complete)(struct bt_conn *conn, uint8_t status);

        void (*le_cs_procedure_enable_complete)(
                struct bt_conn *conn, uint8_t status,
                struct bt_conn_le_cs_procedure_enable_complete *params);
 
#endif
 
#if defined(CONFIG_BT_CLASSIC)
        void (*role_changed)(struct bt_conn *conn, uint8_t status);
#endif
 
#if defined(CONFIG_BT_CONN_DYNAMIC_CALLBACKS)
        sys_snode_t _node;
#endif
};

int bt_conn_cb_register(struct bt_conn_cb *cb);

int bt_conn_cb_unregister(struct bt_conn_cb *cb);

#define BT_CONN_CB_DEFINE(_name)                                        \
        static const STRUCT_SECTION_ITERABLE(bt_conn_cb,                \
                                                _CONCAT(bt_conn_cb_,    \
                                                        _name))

#if defined(CONFIG_BT_SECURITY_ERR_TO_STR)
const char *bt_security_err_to_str(enum bt_security_err err);
#else
static inline const char *bt_security_err_to_str(enum bt_security_err err)
{
        ARG_UNUSED(err);
 
        return "";
}
#endif

void bt_set_bondable(bool enable);

bool bt_get_bondable(void);

int bt_conn_set_bondable(struct bt_conn *conn, bool enable);

void bt_le_oob_set_sc_flag(bool enable);

void bt_le_oob_set_legacy_flag(bool enable);

int bt_le_oob_set_legacy_tk(struct bt_conn *conn, const uint8_t *tk);

int bt_le_oob_set_sc_data(struct bt_conn *conn,
                          const struct bt_le_oob_sc_data *oobd_local,
                          const struct bt_le_oob_sc_data *oobd_remote);

int bt_le_oob_get_sc_data(struct bt_conn *conn,
                          const struct bt_le_oob_sc_data **oobd_local,
                          const struct bt_le_oob_sc_data **oobd_remote);

#define BT_PASSKEY_INVALID 0xffffffff

__deprecated int bt_passkey_set(unsigned int passkey);

struct bt_conn_oob_info {
        enum {
                BT_CONN_OOB_LE_LEGACY,

                BT_CONN_OOB_LE_SC,
        } type;
 
        union {
                struct {
                        enum {
                                BT_CONN_OOB_LOCAL_ONLY,

                                BT_CONN_OOB_REMOTE_ONLY,

                                BT_CONN_OOB_BOTH_PEERS,

                                BT_CONN_OOB_NO_DATA,
                        } oob_config;
                } lesc;
        };
};
 
#if defined(CONFIG_BT_SMP_APP_PAIRING_ACCEPT)
struct bt_conn_pairing_feat {
        uint8_t io_capability;

        uint8_t oob_data_flag;

        uint8_t auth_req;

        uint8_t max_enc_key_size;

        uint8_t init_key_dist;

        uint8_t resp_key_dist;
};
#endif /* CONFIG_BT_SMP_APP_PAIRING_ACCEPT */

#define BT_PASSKEY_RAND 0xffffffff

struct bt_conn_auth_cb {
#if defined(CONFIG_BT_SMP_APP_PAIRING_ACCEPT)
        enum bt_security_err (*pairing_accept)(struct bt_conn *conn,
                              const struct bt_conn_pairing_feat *const feat);
#endif /* CONFIG_BT_SMP_APP_PAIRING_ACCEPT */

        void (*passkey_display)(struct bt_conn *conn, unsigned int passkey);
 
#if defined(CONFIG_BT_PASSKEY_KEYPRESS)
        void (*passkey_display_keypress)(struct bt_conn *conn,
                                         enum bt_conn_auth_keypress type);
#endif

        void (*passkey_entry)(struct bt_conn *conn);

        void (*passkey_confirm)(struct bt_conn *conn, unsigned int passkey);

        void (*oob_data_request)(struct bt_conn *conn,
                                 struct bt_conn_oob_info *info);

        void (*cancel)(struct bt_conn *conn);

        void (*pairing_confirm)(struct bt_conn *conn);
 
#if defined(CONFIG_BT_CLASSIC)
        void (*pincode_entry)(struct bt_conn *conn, bool highsec);
#endif
 
#if defined(CONFIG_BT_APP_PASSKEY)
        uint32_t (*app_passkey)(struct bt_conn *conn);
#endif /* CONFIG_BT_APP_PASSKEY */
};

struct bt_conn_auth_info_cb {
        void (*pairing_complete)(struct bt_conn *conn, bool bonded);

        void (*pairing_failed)(struct bt_conn *conn,
                               enum bt_security_err reason);

        void (*bond_deleted)(uint8_t id, const bt_addr_le_t *peer);
 
#if defined(CONFIG_BT_CLASSIC)
        void (*br_bond_deleted)(const bt_addr_t *peer);
#endif /* CONFIG_BT_CLASSIC */

        sys_snode_t node;
};

int bt_conn_auth_cb_register(const struct bt_conn_auth_cb *cb);

int bt_conn_auth_cb_overlay(struct bt_conn *conn, const struct bt_conn_auth_cb *cb);

int bt_conn_auth_info_cb_register(struct bt_conn_auth_info_cb *cb);

int bt_conn_auth_info_cb_unregister(struct bt_conn_auth_info_cb *cb);

int bt_conn_auth_passkey_entry(struct bt_conn *conn, unsigned int passkey);

int bt_conn_auth_keypress_notify(struct bt_conn *conn, enum bt_conn_auth_keypress type);

int bt_conn_auth_cancel(struct bt_conn *conn);

int bt_conn_auth_passkey_confirm(struct bt_conn *conn);

int bt_conn_auth_pairing_confirm(struct bt_conn *conn);

int bt_conn_auth_pincode_entry(struct bt_conn *conn, const char *pin);

struct bt_br_conn_param {
        bool allow_role_switch;
};

#define BT_BR_CONN_PARAM_INIT(role_switch) \
{ \
        .allow_role_switch = (role_switch), \
}

#define BT_BR_CONN_PARAM(role_switch) \
        ((struct bt_br_conn_param[]) { \
                BT_BR_CONN_PARAM_INIT(role_switch) \
         })

#define BT_BR_CONN_PARAM_DEFAULT BT_BR_CONN_PARAM(true)
 

struct bt_conn *bt_conn_create_br(const bt_addr_t *peer,
                                  const struct bt_br_conn_param *param);

struct bt_conn *bt_conn_lookup_addr_br(const bt_addr_t *peer);

const bt_addr_t *bt_conn_get_dst_br(const struct bt_conn *conn);

int bt_conn_br_switch_role(const struct bt_conn *conn, uint8_t role);

int bt_conn_br_set_role_switch_enable(const struct bt_conn *conn, bool enable);
 
#if defined(CONFIG_BT_POWER_MODE_CONTROL)
int bt_conn_br_enter_sniff_mode(struct bt_conn *conn, uint16_t min_interval,
                                 uint16_t max_interval, uint16_t attempt, uint16_t timeout);

int bt_conn_br_exit_sniff_mode(struct bt_conn *conn);
#endif /* CONFIG_BT_POWER_MODE_CONTROL */

int bt_conn_br_get_supervision_timeout(struct bt_conn *conn, uint16_t *timeout);

int bt_conn_br_set_supervision_timeout(struct bt_conn *conn, uint16_t timeout);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_CONN_H_ */