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

@@ -30,12 +30,27 @@ extern "C" {
*/
#define ESP_BT_VS_COMMON_ECHO_OCF (0x0081)
/**
* @brief echo test cmd parameters
*/
struct bt_hci_vs_common_echo {
uint8_t echo; /*!< echo data */
};
/**
* @brief Set/Clear coexistence status (OCF: 0x0082)
*
* @note The init function is `bt_stack_enableCoexVsCmd(true)`
*/
#define ESP_BT_VS_SET_COEX_STATUS_OCF (0x0082)
/**
* @brief Set/Clear coexistence status cmd parameters
*/
struct bt_hci_vs_set_coex_status {
uint8_t type; /*!< WIFI, BLE or BT */
uint8_t op; /*!< clear or set status */
uint8_t status; /*!< WIFI, BLE or BT status */
};
/**
* @brief Config scanning duplicate exceptional list (OCF: 0x0108)
@@ -43,6 +58,14 @@ extern "C" {
* @note The init function is `advFilter_stack_enableDupExcListCmd(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)
@@ -51,12 +74,27 @@ extern "C" {
*/
#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)
*
* @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)
@@ -64,6 +102,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 Classic Bluetooth minimum encryption key size (OCF: 0x0182)
@@ -71,6 +115,12 @@ extern "C" {
* @note The init function is `bt_stack_enableSecCtrlVsCmd(true)`
*/
#define ESP_BT_VS_SET_MIN_ENC_KEY_SIZE_OCF (0x0182)
/**
* @brief Set bt minimum encryption key size cmd parameters
*/
struct bt_hci_vs_set_min_enc_key_size {
uint8_t size; /*!< the minimum encryption key size */
};
//
// @brief HCI VS Events for Espressif's Bluetooth Host
@@ -87,6 +137,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 This event indicates legacy authentication is completed by remote device (EVTCODE: 0xFF, SUBCODE: 0x03)
@@ -94,6 +150,12 @@ extern "C" {
* @note The init function is `bt_stack_enableSecCtrlVsCmd(true)`
*/
#define ESP_BT_VS_LEGACY_REM_AUTH_EVT_SUBCODE (0x03)
/**
* @brief legacy remote auth event parameters
*/
struct bt_hci_vs_legacy_rem_auth_evt {
uint16_t conhdl; /*!< connection handle */
};
//
// @brief HCI VS Commands for Espressif's Internal-Use Debugging