Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-09-27 16:56:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
1bbd9ee09a3cd57204dfd4b8cbc063df079db5a1
esp-idf/components/bt/include/common/btdm_le_vs.h
T

550 lines
19 KiB
C
Raw Blame History

/*
* SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include "sdkconfig.h"
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
// @brief HCI VS Commands for Espressif's Bluetooth LE Host
//
// @note The following vendor-specific HCI commands are exclusively for Espressif's Bluetooth LE Host (ESP-Bluedroid Host or ESP-NimBLE Host).
// If you are using a non-ESP host or HCI UART, these commands will remain disabled unless enabling the feature in the menuconfig (CONFIG_BT_CTRL_LE_VS_CMD_EVT_ENABLED).
// Note, these additional HCI VS commands are intended for Espressif's Bluetooth Host use only.
// Application developers **should not** enable these commands in their applications.
//
/**
* @brief Config scanning duplicate exceptional list (OCF: 0x0108)
*
*/
#define ESP_BT_VS_CONFIG_DUP_EXC_LIST_OCF (0x0108)
/**
* @brief Update exception list cmd parameters
*/
struct bt_hci_vs_update_exc_list {
uint8_t subcode; /*!< Add, remove or clear exception list */
uint32_t type; /*!< device type */
uint8_t device_info[6]; /*!< device information */
};
/**
* @brief Enable/disable advertising report flow control (OCF: 0x0109)
*
*/
#define ESP_BT_VS_SET_ADV_REPORT_FLOW_CTRL_OCF (0x0109)
/**
* @brief Init ADV flow control cmd parameters
*/
struct bt_hci_vs_init_adv_flow_ctrl {
uint8_t enable; /*!< Enable ADV flow control */
uint16_t num; /*!< ADV buffer maximum value */
uint16_t adv_lost_threshold; /*!< ADV lost event triggered threshold */
};
/**
* @brief Update the number of advertising report in ADV flow control (OCF: 0x010A)
*
*/
#define ESP_BT_VS_UPD_ADV_REPORT_FLOW_CTRL_NUM_OCF (0x010a)
/**
* @brief Update ADV flow control cmd parameters
*/
struct bt_hci_vs_update_adv_flow_ctrl {
uint16_t num; /*!< The number of ADV report processed */
};
/**
* @brief Clear legacy advertising (same as HCI_LE_Clear_Advertising_Sets) (OCF: 0x010C)
*
*/
#define ESP_BT_VS_CLR_LEGACY_ADV_OCF (0x010c)
/**
* @brief Clear legacy ADV cmd parameters
*/
struct bt_hci_vs_ble_clr_legacy_adv {
// no parameters
};
/**
* @brief Set parameters of duplicate list (OCF: 0x010D)
*
*/
#define ESP_BT_VS_SET_DUP_LIST_PARAMS_OCF (0x010d)
/**
* @brief Set duplicate list cmd parameters
*/
struct bt_hci_vs_ble_set_dup_params {
uint8_t dup_mode; /*!< Duplicate mode */
uint8_t dup_ad_type; /*!< Duplicate data type */
uint16_t ring_list_max_num; /*!< Duplicate list size */
};
/**
* @brief Enable/disable duplicate and exception list (OCF: 0x010E)
*
*/
#define ESP_BT_VS_ENABLE_DUP_EXC_LIST_OCF (0x010e)
/**
* @brief Enable duplicate and exception list cmd parameters
*/
struct bt_hci_vs_ble_enable_dup_exc {
uint8_t enable; /*!< Enable or disable */
uint8_t ring_list_reset; /*!< Reset list */
};
/**
* @brief Enable optimization of multiple connections (OCF: 0x010F)
*
*/
#define ESP_BT_VS_ENABLE_ARRANGEMENT_OCF (0x010f)
/**
* @brief Multiple connections optimization cmd parameters
*/
struct bt_hci_vs_ble_enable_arrangement {
uint32_t common_factor; /*!< The greatest common factor of connection interval */
uint8_t enable; /*!< Enable or disable */
};
/**
* @brief Set scheduling length for a certain role (OCF: 0x0110)
*
*/
#define ESP_BT_VS_SET_SCHED_ROLE_LEN_OCF (0x0110)
/**
* @brief Scheduling length cmd parameters
*/
struct bt_hci_vs_ble_set_sched_role_len {
uint8_t role; /*!< BLE role; 0: central; 1: peripheral */
uint32_t len; /*!< Length is us */
};
/**
* @brief Set RSSI threshold for automatic power control (OCF: 0x0111)
*
*/
#define ESP_BT_VS_SET_PCL_RSSI_THRESH_OCF (0x0111)
/**
* @brief PCL RSSI threshold cmd parameters
*/
struct bt_hci_vs_ble_set_pcl_rssi_thresh {
uint16_t conn_handle; /*!< Connection handle */
uint8_t rssi_thresh_min_1M; /*!< Lower limit for 1M */
uint8_t rssi_thresh_max_1M; /*!< Upper limit for 1M */
uint8_t rssi_thresh_min_2M; /*!< Lower limit for 2M */
uint8_t rssi_thresh_max_2M; /*!< Upper limit for 2M */
uint8_t rssi_thresh_min_s2coded; /*!< Lower limit for s2 coded */
uint8_t rssi_thresh_max_s2coded; /*!< Upper limit for s2 coded */
uint8_t rssi_thresh_min_s8coded; /*!< Lower limit for s8 coded */
uint8_t rssi_thresh_max_s8coded; /*!< Upper limit for s8 coded */
};
/**
* @brief Enable/disable channel selection algorithm #2 (OCF: 0x0112)
*
*/
#define ESP_BT_VS_ENABLE_CSA2_OCF (0x0112)
/**
* @brief Enable/disable channel selection algorithm #2 cmd parameters
*/
struct bt_hci_vs_ble_csa_enable {
uint8_t csa2_select; /*!< Select CSA2 */
};
/**
* @brief Set parameters of controller logs (OCF: 0x0114)
*
*/
#define ESP_BT_VS_SET_LOG_PARAMS_OCF (0x0114)
/**
* @brief Controller logs cmd parameters
*/
struct bt_hci_vs_ble_log_params {
uint8_t type; /*!< Operation type */
uint32_t output_enable; /*!< Enable/disable output */
uint8_t buffer_optoin; /*!< Select log buffers */
};
/**
* @brief Set BLE vendor events mask (OCF: 0x0116)
*
*/
#define ESP_BT_VS_SET_LE_VENDOR_EVTS_MASK_OCF (0x0116)
/**
* @brief Set BLE vendor events mask cmd parameters
*/
struct bt_hci_vs_ble_set_vs_evts_mask {
uint32_t evt_masks; /*!< BLE vendor events Mask */
};
/**
* @brief Set connection protected TX/RX threshold (OCF: 0x0117)
*
*/
#define ESP_BT_VS_SET_CONN_PROT_TX_RX_THRESH_OCF (0x0117)
/**
* @brief Set connection protected TX/RX threshold cmd parameters
*/
struct bt_hci_vs_set_conn_prot_tx_rx_thresh {
uint8_t use_default_thresh; /*!< Use default threshold */
uint8_t threshold; /*!< Threshold */
};
/**
* @brief Set peer sleep clock accuracy to a constant value (OCF: 0x0118)
*
*/
#define ESP_BT_VS_SET_CONST_PEER_SCA_OCF (0x0118)
/**
* @brief Peer constant SCA cmd parameters
*/
struct bt_hci_vs_ble_set_const_peer_sca {
uint16_t peer_sca; /*!< Peer SCA */
};
/**
* @brief Get CTE hardware information (OCF: 0x011B)
*
* @note This command is only used by internal test.
*/
#define ESP_BT_VS_GET_CTE_HW_INFO (0x011B)
/**
* @brief Set CTE calibration receive parameter (OCF: 0x011C)
*
* @note This command is only used by internal test.
*/
#define ESP_BT_VS_SET_CTE_CAL_RECV_PARAM (0x011C)
/**
* @brief Set CTE calibration transmit parameter (OCF: 0x011D)
*
* @note This command is only used by internal test.
*/
#define ESP_BT_VS_SET_CTE_CAL_TRANS_PARAM (0x011D)
/**
* @brief Set CTE calibration BB parameter (OCF: 0x011E)
*
* @note This command is only used by internal test.
*/
#define ESP_BT_VS_SET_CTE_CAL_BB_PARAM (0x011E)
/**
* @brief Set CTE calibration LC parameter (OCF: 0x011F)
*
* @note This command is only used by internal test.
*/
#define ESP_BT_VS_SET_CTE_CAL_LC_PARAM (0x011F)
/**
* @brief Set CTE calibration state (OCF: 0x0120)
*
* @note This command is only used by internal test.
*/
#define ESP_BT_VS_SET_CTE_CAL_STATE (0x0120)
/**
* @brief Set CTE calibration TX data (OCF: 0x0121)
*
* @note This command is only used by internal test.
*/
#define ESP_BT_VS_SET_CTE_CAL_TX_DATA (0x0121)
/**
* @brief Disable advertising random delay (OCF: 0x0122)
*
*/
#define ESP_BT_VS_DISABLE_ADV_RANDOM_DELAY_OCF (0x0122)
/**
* @brief Disable advertising random delay cmd parameters
*/
struct bt_hci_vs_disable_adv_random_delay {
uint8_t disable; /*!< Enable or disable */
};
/**
* @brief Set default coded PHY (OCF: 0x0123)
*
*/
#define ESP_BT_VS_SET_PREFERRED_CODED_PHY_OCF (0x0123)
/**
* @brief Set default coded PHY cmd parameters
*/
struct bt_hci_vs_set_preferred_coded_phy {
uint8_t perfer_s2_coded; /*!< 500k by default */
};
/**
* @brief Set scan forever (OCF: 0x0124)
*
*/
#define ESP_BT_VS_SET_SCAN_FOREVER_OCF (0x0124)
/**
* @brief Set scan forever cmd parameters
*/
struct bt_hci_vs_ble_set_scan_forever {
uint8_t scan_forever; /*!< Scan forever */
};
/**
* @brief Set TX power level enhanced (OCF: 0x0125)
*
*/
#define ESP_BT_VS_SET_TXPWR_LVL_ENH_OCF (0x0125)
/**
* @brief Set TX power level enhanced cmd parameters
*/
struct bt_hci_vs_set_txpwr_lvl_enhanced {
uint8_t type; /*!< Type */
int txpwr_lvl; /*!< TX power level enhancement */
uint16_t handle; /*!< Handle */
};
/**
* @brief Get TX power level enhanced (OCF: 0x0126)
*
*/
#define ESP_BT_VS_GET_TXPWR_LVL_ENH_OCF (0x0126)
/**
* @brief Get TX power level enhanced cmd parameters
*/
struct bt_hci_vs_get_txpwr_lvl_enhanced {
uint8_t type; /*!< Type */
uint16_t handle; /*!< Handle */
};
/**
* @brief Enable/disable CCA (OCF: 0x0127)
*
*/
#define ESP_BT_VS_ENABLE_CCA_OCF (0x0127)
/**
* @brief Enable/disable CCA cmd parameters
*/
struct bt_hci_vs_enable_cca {
uint8_t enable; /*!< Enable or disable */
int8_t threshold; /*!< Threshold */
};
/**
* @brief Set RX sensitivity threshold (OCF: 0x0128)
*
*/
#define ESP_BT_VS_SET_RX_SENS_THRESH_OCF (0x0128)
/**
* @brief Set RX sensitivity threshold cmd parameters
*/
struct bt_hci_vs_set_rx_sens_thresh {
uint8_t enabled; /*!< Enable or disable */
uint8_t phy; /*!< Type */
int8_t threshold_dbm; /*!< Threshold in dBm */
};
/**
* @brief Set scan backoff uplimit (OCF: 0x0129)
*
*/
#define ESP_BT_VS_SET_SCAN_BACKOFF_UPLIMIT_OCF (0x0129)
/**
* @brief Set scan backoff uplimit cmd parameters
*/
struct bt_hci_vs_set_scan_backoff_uplimit {
uint16_t max_uplimit; /*!< Maximum uplimit */
};
/**
* @brief Set extended advertising constant DID (OCF: 0x012a)
*
*/
#define ESP_BT_VS_SET_EXT_ADV_CONSTANT_DID_OCF (0x012a)
/**
* @brief Set extended advertising constant DID cmd parameters
*/
struct bt_hci_vs_set_ext_adv_constant_did {
uint16_t handle; /*!< Handle */
uint8_t enable; /*!< Enable or disable */
uint16_t did; /*!< DID */
};
/**
* @brief Set scan ADI filter (OCF: 0x012b)
*
*/
#define ESP_BT_VS_SET_SCAN_ADI_FILTER_OCF (0x012b)
/**
* @brief Scan ADI filter parameter entry
*/
struct bt_hci_vs_adi_entry {
uint8_t sid; /*!< Expected SID */
uint16_t did_cnt; /*!< DID count */
uint16_t did[0]; /*!< Expected DID list */
};
/**
* @brief Set scan ADI filter cmd parameters
*/
struct bt_hci_vs_set_scan_adi_filter {
uint8_t enable; /*!< Enable or disable ADI filter */
uint8_t dup_filter; /*!< Enable duplicate filter */
uint8_t sid_num; /*!< SID number */
struct bt_hci_vs_adi_entry adi_entry[0]; /*!< ADIs list */
};
// @brief HCI VS Events for Espressif's Bluetooth LE Host
//
// @note The following HCI VS events are exclusively for Espressif's Bluetooth LE Host (ESP-Bluedroid Host or ESP-NimBLE Host).
// If you are using a non-ESP host or HCI UART, these events will remain disabled unless the initialization function is explicitly called from the application.
// Note, these init functions as well as these additional HCI VS events are intended for Espressif's Bluetooth Host use only.
// Application developers **should not** call the init functions in their applications.
//
/**
* @brief BLE Scan/Connect Request, Aux Connect Response received event (EVTCODE: 0xFF, SUBCODE: 0xC0)
*
* @note The init function is `adv_stack_enableScanReqRxdVsEvent(true)`
*/
#define ESP_BT_VS_LE_CONN_SCAN_REQ_RXED_EVT_SUBCODE (0xC0)
/**
* @brief BLE Scan/Connect Request, Aux Connect Response received event parameters
*/
struct bt_hci_vs_le_conn_scan_req_rxed_evt {
uint8_t evt_type; /*!< Event type; 0: SCAN_REQ; 1: CONN_IND */
uint8_t handle; /*!< Advertisement handle */
uint8_t peer_addr_type; /*!< Peer address type */
uint8_t peer_addr[6]; /*!< Peer address */
};
/**
* @brief BLE Channel Map Update Completion event (EVTCODE: 0xFF, SUBCODE: 0xC1)
*
* @note The init function is `conn_stack_enableChanMapUpdCompVsEvent(true)`
*/
#define ESP_BT_VS_LE_CHAN_UPDATE_COMP_EVT_SUBCODE (0xC1)
/**
* @brief BLE Channel Map Update Completion event parameters
*/
struct bt_hci_vs_le_chan_update_comp_evt {
uint8_t status; /*!< Controller error code */
uint16_t handle; /*!< Connection handle */
uint8_t ch_map[5]; /*!< Updated channel map */
};
/**
* @brief BLE Wakeup From Sleep event (EVTCODE: 0xFF, SUBCODE: 0xC3)
*
* @note The init function is `sleep_stack_enableWakeupVsEvent(true)`
*/
#define ESP_BT_VS_LE_SLEEP_WAKEUP_EVT_SUBCODE (0xC3)
/**
* @brief BLE wakeup event parameters
*/
struct bt_hci_vs_le_sleep_wakeup_evt {
// no parameters
};
/**
* @brief BLE advertising report lost event for flow control (EVTCODE: 0x3E, SUBCODE: 0xF0)
*
* @note The init function is `scan_stack_enableAdvFlowCtrlVsCmd(true)`
*/
#define ESP_BT_VS_LE_ADV_LOST_EVT_SUBCODE (0xF0)
/**
* @brief ADV lost event parameters
*/
struct bt_hci_vs_le_adv_lost_evt {
uint32_t nb_lost; /*!< The number of ADV report discarded */
};
//
// @brief HCI VS Commands for Espressif's Internal-Use Debugging
//
// @note The following HCI VS debugging commands are implemented in Bluetooth LE controller pre-compiled libraries.
// These commands are not linked into the application binary, unless the function `esp_ble_internalTestFeaturesEnable(true)`is called from the application.
// They are intended for Espressif's internal use only. Application developers **should not** call `esp_ble_internalTestFeaturesEnable(true)` in their applications.
//
#define ESP_BT_VS_CFG_TEST_RELATED_OCF (0x0113)
#define ESP_BT_VS_CFG_TEST_ENABLE_SUBCMD (0X00)
#define ESP_BT_VS_CFG_TEST_ENABLE_ADV_DELAY_SUBCMD (0X01)
#define ESP_BT_VS_CFG_TEST_SET_PREF_CODED_SUBCMD (0X02)
#define ESP_BT_VS_CFG_TEST_SET_DEFAULT_PRIV_MODE_SUBCMD (0X03)
#define ESP_BT_VS_CFG_TEST_SET_SCAN_FOREVER_SUBCMD (0X04)
#define ESP_BT_VS_CFG_TEST_SET_EXPECTED_PEER_SUBCMD (0X05)
#define ESP_BT_VS_CFG_TEST_GET_ADV_TXED_CNT_SUBCMD (0X06)
#define ESP_BT_VS_CFG_TEST_GET_SCAN_RXED_CNT_SUBCMD (0X07)
#define ESP_BT_VS_CFG_TEST_SET_TXPWR_LVL_SUBCMD (0X08)
#define ESP_BT_VS_CFG_TEST_GET_TXPWR_LVL_SUBCMD (0X09)
#define ESP_BT_VS_CFG_TEST_SET_TXPWR_LVL_ENH_SUBCMD (0X0a)
#define ESP_BT_VS_CFG_TEST_GET_TXPWR_LVL_ENH_SUBCMD (0X0b)
#define ESP_BT_VS_CFG_TEST_IGNORE_WL_FOR_DIR_ADV_SUBCMD (0X0c)
#define ESP_BT_VS_CFG_TEST_GET_ADV_RXED_RSSI_SUBCMD (0X0d)
#define ESP_BT_VS_CFG_TEST_ENABLE_CCA_SUBCMD (0X0e)
#define ESP_BT_VS_CFG_TEST_SET_CCA_WIN_SUBCMD (0X0f)
#define ESP_BT_VS_CFG_TEST_READ_CCA_DATA_SUBCM (0X10)
#define ESP_BT_VS_CFG_TEST_CLEAR_RAND_ADDR_SUBCMD (0X11)
#define ESP_BT_VS_CFG_TEST_GET_MAX_TXPWR_SUBCMD (0X12)
#define ESP_BT_VS_CFG_TEST_GET_TXPWR_RANGE_SUBCMD (0X13)
#define ESP_BT_VS_CFG_TEST_SET_SCAN_AA_SUBCMD (0X14)
#define ESP_BT_VS_CFG_TEST_SET_ADV_AA_SUBCMD (0X15)
#define ESP_BT_VS_CFG_TEST_SET_SCAN_CHAN_SUBCMD (0X16)
#define ESP_BT_VS_CFG_TEST_SKIP_LIGHT_SLEEP_CHECK_SUBCMD (0X17)
#define ESP_BT_VS_CFG_TEST_SET_WAKEUP_OVERHEAD_SUBCMD (0X18)
#define ESP_BT_VS_CFG_TEST_GET_ADV_MIN_ITVL_SUBCMD (0X19)
#define ESP_BT_VS_CFG_TEST_GET_CTRL_STATUS_SUBCMD (0X1a)
#define ESP_BT_VS_CFG_TEST_SET_CONN_PHY_TXPWR_SUBCMD (0X1b)
#define ESP_BT_VS_CFG_TEST_GET_CONN_PHY_TXPWR_SUBCMD (0X1c)
#define ESP_BT_VS_CFG_TEST_GET_RXBUF_EMPTY_CNT_SUBCMD (0X1d)
#define ESP_BT_VS_CFG_TEST_RESTART_SUBCMD (0X1e)
#define ESP_BT_VS_CFG_TEST_ENABLE_RECODE_RX_STATE_SUBCMD (0X1f)
#define ESP_BT_VS_CFG_TEST_GET_RECODE_CNT_SUBCMD (0X20)
#define ESP_BT_VS_CFG_TEST_CLR_RECODE_CNT_SUBCMD (0X21)
#define ESP_BT_VS_CFG_TEST_GET_CTRL_COMPILE_VER_SUBCMD (0X24)
#define ESP_BT_VS_CFG_TEST_SET_AUX_ADV_OFFSET_SUBCMD (0X25)
#define ESP_BT_VS_CFG_TEST_INIT_FLEXIBLE_MODE_SUBCMD (0X26)
#define ESP_BT_VS_CFG_TEST_ENABLE_FLEXIBLE_MODE_SUBCMD (0X27)
#define ESP_BT_VS_CFG_TEST_SET_FLEXIBLE_CONN_ERR_SUBCMD (0X28)
#define ESP_BT_VS_CFG_TEST_SET_FLEXIBLE_ADV_ERR_SUBCMD (0X29)
#define ESP_BT_VS_CFG_TEST_SET_FLEXIBLE_SCAN_ERR_SUBCMD (0X2a)
#define ESP_BT_VS_CFG_TEST_GET_TXED_CRCERR_SUBCMD (0X2c)
#define ESP_BT_VS_CFG_TEST_GET_BACKOFF_UPLIMIT_SUBCMD (0X2d)
#define ESP_BT_VS_CFG_TEST_GET_RXED_ADV_ADI_SUBCMD (0X2f)
#define ESP_BT_VS_CFG_TEST_SET_SCH_RAND_MODE_SUBCMD (0X30)
#define ESP_BT_VS_CFG_TEST_SET_RX_SENS_THRESH_SUBCMD (0X31)
#define ESP_BT_VS_CFG_TEST_CHECK_MSYS_BUF_SUBCMD (0X32)
#define ESP_BT_VS_CFG_TEST_UPDATE_BLE_TIMER_SUBCMD (0X33)
#define ESP_BT_VS_CFG_TEST_UPDATE_BLE_RTC_SUBCMD (0X34)
#define ESP_BT_VS_CFG_TEST_SET_LOCKED_MEM_NUM_SUBCMD (0X35)
#define ESP_BT_VS_CFG_TEST_ALLOW_MEM_ALLOC_SUBCMD (0X36)
#define ESP_BT_VS_CFG_TEST_SET_SCH_RAND_INFO_PTR_SUBCMD (0X37)
#define ESP_BT_VS_CFG_TEST_SET_DIAG_IO_SUBCMD (0X38)
#define ESP_BT_VS_CFG_TEST_SET_AGC_MAX_GAIN_SUBCMD (0X39)
#define ESP_BT_VS_CFG_TEST_ENABLE_CHAN_ASSESS_SUBCMD (0X40)
#define ESP_BT_VS_CFG_TEST_SET_BACKOFF_UPLIMIT_SUBCMD (0X41)
#define ESP_BT_VS_CFG_TEST_SET_CONN_TOP_PRIO_RESV_THRESH_SUBCMD (0X42)
#define ESP_BT_VS_CFG_TEST_SET_TEST_EVT_MSK_SUBCMD (0X43)
#define ESP_BT_VS_CFG_TEST_GET_WAKEUP_TIMEOUT_SUBCMD (0X45)
#define ESP_BT_VS_CFG_TEST_RELATED_SUBCMD_MAX (0Xff)
//
// @brief HCI VS Events for Espressif's Internal-Use Debugging
//
// @note The following HCI VS debugging events are implemented in Bluetooth LE controller pre-compiled libraries.
// These events are not linked into the application binary, unless the function `esp_ble_internalTestFeaturesEnable(true)`is called from the application.
// Application developers **should not** call `esp_ble_internalTestFeaturesEnable(true)` in their applications.
//
#define ESP_BT_VS_LE_RUNNING_STATUS_EVT_SUBCODE (0xC3)
#ifdef __cplusplus
}
#endif
Reference in New Issue View Git Blame Copy Permalink