feat(bt): fixed some doc error and add ocf parameters description

This commit is contained in:
zhiweijian
2025-03-24 15:38:14 +08:00
committed by Shen Weilong
parent 3a71bec278
commit a24fdf2892
10 changed files with 570 additions and 56 deletions

View File

@@ -27,6 +27,14 @@ extern "C" {
* @note The init function is `advFilter_stack_eanbleDupExcListCmd(true)`
*/
#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)
@@ -34,13 +42,27 @@ extern "C" {
* @note The init function is `scan_stack_enableAdvFlowCtrlVsCmd(true)`
*/
#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 flow control (OCF: 0x010A)
* @brief Update the number of advertising report in ADV flow control (OCF: 0x010A)
*
* @note The init function is `scan_stack_enableAdvFlowCtrlVsCmd(true)`
*/
#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)
@@ -48,6 +70,12 @@ extern "C" {
* @note The init function is `adv_stack_enableClearLegacyAdvVsCmd(true)`
*/
#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)
@@ -55,6 +83,14 @@ extern "C" {
* @note The init function is `advFilter_stack_eanbleDupExcListCmd(true)`
*/
#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)
@@ -62,6 +98,13 @@ extern "C" {
* @note The init function is `advFilter_stack_eanbleDupExcListCmd(true)`
*/
#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)
@@ -69,6 +112,13 @@ extern "C" {
* @note The init function is `arr_stack_enableMultiConnVsCmd(true)`
*/
#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)
@@ -76,13 +126,34 @@ extern "C" {
* @note The init function is `arr_stack_enableMultiConnVsCmd(true)`
*/
#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 power control (OCF: 0x0111)
* @brief Set RSSI threshold for automatic power control (OCF: 0x0111)
*
* @note The init function is `pcl_stack_enableSetRssiThreshVsCmd(true)`
*/
#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)
@@ -90,6 +161,12 @@ extern "C" {
* @note The init function is `chanSel_stack_enableSetCsaVsCmd(true)`
*/
#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)
@@ -97,6 +174,14 @@ extern "C" {
* @note The init function is `log_stack_enableLogsRelatedVsCmd(true)`
*/
#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)
@@ -104,6 +189,12 @@ extern "C" {
* @note The init function is `hci_stack_enableSetVsEvtMaskVsCmd(true)`
*/
#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 peer sleep clock accuracy to a constant value (OCF: 0x0118)
@@ -111,7 +202,12 @@ extern "C" {
* @note The init function is `winWiden_stack_enableSetConstPeerScaVsCmd(true)`
*/
#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 HCI VS Events for Espressif's Bluetooth Host
//
@@ -127,6 +223,15 @@ extern "C" {
* @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)
@@ -134,6 +239,14 @@ extern "C" {
* @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)
@@ -141,6 +254,12 @@ extern "C" {
* @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)
@@ -148,6 +267,12 @@ extern "C" {
* @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