From c2e098c10ed9ecc4c7edbdf696327d82009cd97a Mon Sep 17 00:00:00 2001 From: Darian Leung Date: Mon, 20 Jun 2022 22:29:56 +0800 Subject: [PATCH 1/2] bluedroid: Fix breaking change typos This commit fixes typos that are breaking changes (i.e., macros, types, and functions) in the bluedroid API. Migration notes for v5.0 have also been added. Closes https://github.com/espressif/esp-idf/issues/6887 --- .../bt/host/bluedroid/api/esp_gap_ble_api.c | 4 +- .../api/include/api/esp_gap_ble_api.h | 28 +++++++------- .../bluedroid/api/include/api/esp_gatt_defs.h | 4 +- .../bluedroid/api/include/api/esp_hf_defs.h | 4 +- .../btc/profile/std/gap/btc_gap_ble.c | 14 +++---- docs/conf_common.py | 3 +- docs/en/migration-guides/bluetooth.rst | 37 +++++++++++++++++++ docs/en/migration-guides/index.rst | 1 + docs/zh_CN/migration-guides/bluetooth.rst | 1 + docs/zh_CN/migration-guides/index.rst | 1 + 10 files changed, 69 insertions(+), 28 deletions(-) create mode 100644 docs/en/migration-guides/bluetooth.rst create mode 100644 docs/zh_CN/migration-guides/bluetooth.rst diff --git a/components/bt/host/bluedroid/api/esp_gap_ble_api.c b/components/bt/host/bluedroid/api/esp_gap_ble_api.c index b709f9e1f2..e076b48a5f 100644 --- a/components/bt/host/bluedroid/api/esp_gap_ble_api.c +++ b/components/bt/host/bluedroid/api/esp_gap_ble_api.c @@ -787,7 +787,7 @@ esp_err_t esp_ble_gap_read_phy(esp_bd_addr_t bd_addr) == BT_STATUS_SUCCESS ? ESP_OK : ESP_FAIL); } -esp_err_t esp_ble_gap_set_prefered_default_phy(esp_ble_gap_phy_mask_t tx_phy_mask, +esp_err_t esp_ble_gap_set_preferred_default_phy(esp_ble_gap_phy_mask_t tx_phy_mask, esp_ble_gap_phy_mask_t rx_phy_mask) { btc_msg_t msg; @@ -805,7 +805,7 @@ esp_err_t esp_ble_gap_set_prefered_default_phy(esp_ble_gap_phy_mask_t tx_phy_mas == BT_STATUS_SUCCESS ? ESP_OK : ESP_FAIL); } -esp_err_t esp_ble_gap_set_prefered_phy(esp_bd_addr_t bd_addr, +esp_err_t esp_ble_gap_set_preferred_phy(esp_bd_addr_t bd_addr, esp_ble_gap_all_phys_t all_phys_mask, esp_ble_gap_phy_mask_t tx_phy_mask, esp_ble_gap_phy_mask_t rx_phy_mask, diff --git a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h index 730dd6ac1c..24b146f879 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h @@ -167,8 +167,8 @@ typedef enum { ESP_GAP_BLE_SET_CHANNELS_EVT = 29, /*!< When setting BLE channels complete, the event comes */ #if (BLE_50_FEATURE_SUPPORT == TRUE) ESP_GAP_BLE_READ_PHY_COMPLETE_EVT, - ESP_GAP_BLE_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT, - ESP_GAP_BLE_SET_PREFERED_PHY_COMPLETE_EVT, + ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT, + ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT, ESP_GAP_BLE_EXT_ADV_SET_RAND_ADDR_COMPLETE_EVT, ESP_GAP_BLE_EXT_ADV_SET_PARAMS_COMPLETE_EVT, ESP_GAP_BLE_EXT_ADV_DATA_SET_COMPLETE_EVT, @@ -196,7 +196,7 @@ typedef enum { ESP_GAP_BLE_SCAN_TIMEOUT_EVT, ESP_GAP_BLE_ADV_TERMINATED_EVT, ESP_GAP_BLE_SCAN_REQ_RECEIVED_EVT, - ESP_GAP_BLE_CHANNEL_SELETE_ALGORITHM_EVT, + ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT, ESP_GAP_BLE_PERIODIC_ADV_REPORT_EVT, ESP_GAP_BLE_PERIODIC_ADV_SYNC_LOST_EVT, ESP_GAP_BLE_PERIODIC_ADV_SYNC_ESTAB_EVT, @@ -640,7 +640,7 @@ typedef enum { typedef enum{ ESP_BLE_WHITELIST_REMOVE = 0X00, /*!< remove mac from whitelist */ ESP_BLE_WHITELIST_ADD = 0X01, /*!< add address to whitelist */ -} esp_ble_wl_opration_t; +} esp_ble_wl_operation_t; #if (BLE_42_FEATURE_SUPPORT == TRUE) typedef enum { ESP_BLE_DUPLICATE_EXCEPTIONAL_LIST_ADD = 0, /*!< Add device info into duplicate scan exceptional list */ @@ -997,7 +997,7 @@ typedef union { struct ble_pkt_data_length_cmpl_evt_param { esp_bt_status_t status; /*!< Indicate the set pkt data length operation success status */ esp_ble_pkt_data_length_params_t params; /*!< pkt data length value */ - } pkt_data_lenth_cmpl; /*!< Event parameter of ESP_GAP_BLE_SET_PKT_LENGTH_COMPLETE_EVT */ + } pkt_data_length_cmpl; /*!< Event parameter of ESP_GAP_BLE_SET_PKT_LENGTH_COMPLETE_EVT */ /** * @brief ESP_GAP_BLE_SET_LOCAL_PRIVACY_COMPLETE_EVT */ @@ -1039,7 +1039,7 @@ typedef union { */ struct ble_update_whitelist_cmpl_evt_param { esp_bt_status_t status; /*!< Indicate the add or remove whitelist operation success status */ - esp_ble_wl_opration_t wl_opration; /*!< The value is ESP_BLE_WHITELIST_ADD if add address to whitelist operation success, ESP_BLE_WHITELIST_REMOVE if remove address from the whitelist operation success */ + esp_ble_wl_operation_t wl_operation; /*!< The value is ESP_BLE_WHITELIST_ADD if add address to whitelist operation success, ESP_BLE_WHITELIST_REMOVE if remove address from the whitelist operation success */ } update_whitelist_cmpl; /*!< Event parameter of ESP_GAP_BLE_UPDATE_WHITELIST_COMPLETE_EVT */ #if (BLE_42_FEATURE_SUPPORT == TRUE) /** @@ -1070,17 +1070,17 @@ typedef union { esp_ble_gap_phy_t rx_phy; /*!< rx phy type */ } read_phy; /*!< Event parameter of ESP_GAP_BLE_READ_PHY_COMPLETE_EVT */ /** - * @brief ESP_GAP_BLE_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT + * @brief ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT */ struct ble_set_perf_def_phy_cmpl_evt_param { esp_bt_status_t status; /*!< Indicate perf default phy set status */ - } set_perf_def_phy; /*!< Event parameter of ESP_GAP_BLE_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT */ + } set_perf_def_phy; /*!< Event parameter of ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT */ /** - * @brief ESP_GAP_BLE_SET_PREFERED_PHY_COMPLETE_EVT + * @brief ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT */ struct ble_set_perf_phy_cmpl_evt_param { esp_bt_status_t status; /*!< Indicate perf phy set status */ - } set_perf_phy; /*!< Event parameter of ESP_GAP_BLE_SET_PREFERED_PHY_COMPLETE_EVT */ + } set_perf_phy; /*!< Event parameter of ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT */ /** * @brief ESP_GAP_BLE_EXT_ADV_SET_RAND_ADDR_COMPLETE_EVT */ @@ -1236,12 +1236,12 @@ typedef union { esp_bd_addr_t scan_addr; /*!< scanner address */ } scan_req_received; /*!< Event parameter of ESP_GAP_BLE_SCAN_REQ_RECEIVED_EVT */ /** - * @brief ESP_GAP_BLE_CHANNEL_SELETE_ALGORITHM_EVT + * @brief ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT */ struct ble_channel_sel_alg_param { uint16_t conn_handle; /*!< connection handle */ uint8_t channel_sel_alg; /*!< channel selection algorithm */ - } channel_sel_alg; /*!< Event parameter of ESP_GAP_BLE_CHANNEL_SELETE_ALGORITHM_EVT */ + } channel_sel_alg; /*!< Event parameter of ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT */ /** * @brief ESP_GAP_BLE_PERIODIC_ADV_SYNC_LOST_EVT */ @@ -1849,7 +1849,7 @@ esp_err_t esp_ble_gap_read_phy(esp_bd_addr_t bd_addr); * - other : failed * */ -esp_err_t esp_ble_gap_set_prefered_default_phy(esp_ble_gap_phy_mask_t tx_phy_mask, esp_ble_gap_phy_mask_t rx_phy_mask); +esp_err_t esp_ble_gap_set_preferred_default_phy(esp_ble_gap_phy_mask_t tx_phy_mask, esp_ble_gap_phy_mask_t rx_phy_mask); /** * @brief This function is used to set the PHY preferences for the connection identified by the remote address. * The Controller might not be able to make the change (e.g. because the peer does not support the requested PHY) @@ -1865,7 +1865,7 @@ esp_err_t esp_ble_gap_set_prefered_default_phy(esp_ble_gap_phy_mask_t tx_phy_mas * - other : failed * */ -esp_err_t esp_ble_gap_set_prefered_phy(esp_bd_addr_t bd_addr, +esp_err_t esp_ble_gap_set_preferred_phy(esp_bd_addr_t bd_addr, esp_ble_gap_all_phys_t all_phys_mask, esp_ble_gap_phy_mask_t tx_phy_mask, esp_ble_gap_phy_mask_t rx_phy_mask, diff --git a/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h b/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h index 7bb71251e9..4a6ccbecf8 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h @@ -201,8 +201,8 @@ typedef enum { ESP_GATT_MORE = 0x8a, /* 0x8a */ /* relate to BTA_GATT_MORE in bta/bta_gatt_api.h */ ESP_GATT_INVALID_CFG = 0x8b, /* 0x8b */ /* relate to BTA_GATT_INVALID_CFG in bta/bta_gatt_api.h */ ESP_GATT_SERVICE_STARTED = 0x8c, /* 0x8c */ /* relate to BTA_GATT_SERVICE_STARTED in bta/bta_gatt_api.h */ - ESP_GATT_ENCRYPED_MITM = ESP_GATT_OK, /* relate to BTA_GATT_ENCRYPED_MITM in bta/bta_gatt_api.h */ - ESP_GATT_ENCRYPED_NO_MITM = 0x8d, /* 0x8d */ /* relate to BTA_GATT_ENCRYPED_NO_MITM in bta/bta_gatt_api.h */ + ESP_GATT_ENCRYPTED_MITM = ESP_GATT_OK, /* relate to BTA_GATT_ENCRYPED_MITM in bta/bta_gatt_api.h */ + ESP_GATT_ENCRYPTED_NO_MITM = 0x8d, /* 0x8d */ /* relate to BTA_GATT_ENCRYPED_NO_MITM in bta/bta_gatt_api.h */ ESP_GATT_NOT_ENCRYPTED = 0x8e, /* 0x8e */ /* relate to BTA_GATT_NOT_ENCRYPTED in bta/bta_gatt_api.h */ ESP_GATT_CONGESTED = 0x8f, /* 0x8f */ /* relate to BTA_GATT_CONGESTED in bta/bta_gatt_api.h */ ESP_GATT_DUP_REG = 0x90, /* 0x90 */ /* relate to BTA_GATT_DUP_REG in bta/bta_gatt_api.h */ diff --git a/components/bt/host/bluedroid/api/include/api/esp_hf_defs.h b/components/bt/host/bluedroid/api/include/api/esp_hf_defs.h index fc2e192262..98c1d11165 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_hf_defs.h +++ b/components/bt/host/bluedroid/api/include/api/esp_hf_defs.h @@ -243,9 +243,9 @@ typedef enum { ESP_HF_CME_INCORRECT_PASSWORD = 16, /*!< incorrect password */ ESP_HF_CME_SIM_PIN2_REQUIRED = 17, /*!< SIM PIN2 required */ ESP_HF_CME_SIM_PUK2_REQUIRED = 18, /*!< SIM PUK2 required */ - ESP_HF_CME_MEMEORY_FULL = 20, /*!< memory full */ + ESP_HF_CME_MEMORY_FULL = 20, /*!< memory full */ ESP_HF_CME_INVALID_INDEX = 21, /*!< invalid index */ - ESP_HF_CME_MEMEORY_FAILURE = 23, /*!< memory failure */ + ESP_HF_CME_MEMORY_FAILURE = 23, /*!< memory failure */ ESP_HF_CME_TEXT_STRING_TOO_LONG = 24, /*!< test string too long */ ESP_HF_CME_INVALID_CHARACTERS_IN_TEXT_STRING = 25, /*!< invalid characters in text string */ ESP_HF_CME_DIAL_STRING_TOO_LONG = 26, /*!< dial string too long*/ diff --git a/components/bt/host/bluedroid/btc/profile/std/gap/btc_gap_ble.c b/components/bt/host/bluedroid/btc/profile/std/gap/btc_gap_ble.c index cde7652825..6e4795821a 100644 --- a/components/bt/host/bluedroid/btc/profile/std/gap/btc_gap_ble.c +++ b/components/bt/host/bluedroid/btc/profile/std/gap/btc_gap_ble.c @@ -687,9 +687,9 @@ static void btc_set_pkt_length_callback(UINT8 status, tBTM_LE_SET_PKT_DATA_LENGT msg.sig = BTC_SIG_API_CB; msg.pid = BTC_PID_GAP_BLE; msg.act = ESP_GAP_BLE_SET_PKT_LENGTH_COMPLETE_EVT; - param.pkt_data_lenth_cmpl.status = btc_btm_status_to_esp_status(status); - param.pkt_data_lenth_cmpl.params.rx_len = data_len_params->rx_len; - param.pkt_data_lenth_cmpl.params.tx_len = data_len_params->tx_len; + param.pkt_data_length_cmpl.status = btc_btm_status_to_esp_status(status); + param.pkt_data_length_cmpl.params.rx_len = data_len_params->rx_len; + param.pkt_data_length_cmpl.params.tx_len = data_len_params->tx_len; ret = btc_transfer_context(&msg, ¶m, sizeof(esp_ble_gap_cb_param_t), NULL); @@ -728,7 +728,7 @@ static void btc_add_whitelist_complete_callback(UINT8 status, tBTM_WL_OPERATION msg.pid = BTC_PID_GAP_BLE; msg.act = ESP_GAP_BLE_UPDATE_WHITELIST_COMPLETE_EVT; param.update_whitelist_cmpl.status = btc_hci_to_esp_status(status); - param.update_whitelist_cmpl.wl_opration = wl_opration; + param.update_whitelist_cmpl.wl_operation = wl_opration; ret = btc_transfer_context(&msg, ¶m, sizeof(esp_ble_gap_cb_param_t), NULL); @@ -824,12 +824,12 @@ static void btc_ble_5_gap_callback(tBTA_DM_BLE_5_GAP_EVENT event, break; } case BTA_DM_BLE_5_GAP_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT: { - msg.act = ESP_GAP_BLE_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT; + msg.act = ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT; param.set_perf_def_phy.status = btc_btm_status_to_esp_status(params->set_perf_def_phy.status); break; } case BTA_DM_BLE_5_GAP_SET_PREFERED_PHY_COMPLETE_EVT: { - msg.act = ESP_GAP_BLE_SET_PREFERED_PHY_COMPLETE_EVT; + msg.act = ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT; param.set_perf_phy.status = btc_btm_status_to_esp_status(params->set_perf_phy.status); break; } @@ -971,7 +971,7 @@ static void btc_ble_5_gap_callback(tBTA_DM_BLE_5_GAP_EVENT event, break; } case BTA_DM_BLE_5_GAP_CHANNEL_SELETE_ALGORITHM_EVT: { - msg.act = ESP_GAP_BLE_CHANNEL_SELETE_ALGORITHM_EVT; + msg.act = ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT; param.channel_sel_alg.conn_handle = params->channel_sel.conn_handle; param.channel_sel_alg.channel_sel_alg = params->channel_sel.channel_sel_alg; break; diff --git a/docs/conf_common.py b/docs/conf_common.py index 5d25b718c2..0cb80ff1ee 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -34,7 +34,8 @@ BT_DOCS = ['api-guides/blufi.rst', 'api-reference/bluetooth/esp_blufi.rst', 'api-reference/bluetooth/esp-ble-mesh.rst', 'api-reference/bluetooth/index.rst', - 'api-reference/bluetooth/nimble/index.rst'] + 'api-reference/bluetooth/nimble/index.rst', + 'migration-guides/bluetooth.rst'] CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst', 'api-reference/bluetooth/esp_a2dp.rst', diff --git a/docs/en/migration-guides/bluetooth.rst b/docs/en/migration-guides/bluetooth.rst new file mode 100644 index 0000000000..87f34ee998 --- /dev/null +++ b/docs/en/migration-guides/bluetooth.rst @@ -0,0 +1,37 @@ +Migrate Bluetooth to ESP-IDF 5.0 +================================ + +.. only:: SOC_CLASSIC_BT_SUPPORTED + + Bluedroid + --------- + + The following Bluedroid macros, types, and functions have been renamed: + + - :component_file:`bt/host/bluedroid/api/include/api/esp_gap_ble_api.h` + + - In :cpp:enum:`esp_gap_ble_cb_event_t` + + - ``ESP_GAP_BLE_SET_PREFERED_DEFAULT_PHY_COMPLETE_EVT`` renamed to ``ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT`` + - ``ESP_GAP_BLE_SET_PREFERED_PHY_COMPLETE_EVT`` renamed to ``ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT`` + - ``ESP_GAP_BLE_CHANNEL_SELETE_ALGORITHM_EVT`` renamed to ``ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT`` + + - ``esp_ble_wl_opration_t`` renamed to :cpp:enum:`esp_ble_wl_operation_t` + - ``esp_ble_gap_cb_param_t.pkt_data_lenth_cmpl`` renamed to ``pkt_data_length_cmpl`` + - ``esp_ble_gap_cb_param_t.update_whitelist_cmpl.wl_opration`` renamed to ``wl_operation`` + - ``esp_ble_gap_set_prefered_default_phy`` renamed to :cpp:func:`esp_ble_gap_set_preferred_default_phy` + - ``esp_ble_gap_set_prefered_phy`` renamed to :cpp:func:`esp_ble_gap_set_preferred_phy` + + - :component_file:`bt/host/bluedroid/api/include/api/esp_gatt_defs.h` + + - In :cpp:enum:`esp_gatt_status_t` + + - ``ESP_GATT_ENCRYPED_MITM`` renamed to ``ESP_GATT_ENCRYPTED_MITM`` + - ``ESP_GATT_ENCRYPED_NO_MITM`` renamed to ``ESP_GATT_ENCRYPTED_NO_MITM`` + + - :component_file:`bt/host/bluedroid/api/include/api/esp_hf_defs.h` + + - In :cpp:enum:`esp_hf_cme_err_t` + + - ``ESP_HF_CME_MEMEORY_FULL`` renamed to ``ESP_HF_CME_MEMORY_FULL`` + - ``ESP_HF_CME_MEMEORY_FAILURE`` renamed to ``ESP_HF_CME_MEMORY_FAILURE`` \ No newline at end of file diff --git a/docs/en/migration-guides/index.rst b/docs/en/migration-guides/index.rst index 55cd234eb6..6c7fc2ef45 100644 --- a/docs/en/migration-guides/index.rst +++ b/docs/en/migration-guides/index.rst @@ -7,6 +7,7 @@ ESP-IDF 5.0 Migration Guides build-system windows-env + :SOC_BT_SUPPORTED: bluetooth ethernet freertos peripherals diff --git a/docs/zh_CN/migration-guides/bluetooth.rst b/docs/zh_CN/migration-guides/bluetooth.rst new file mode 100644 index 0000000000..6a892d9a7a --- /dev/null +++ b/docs/zh_CN/migration-guides/bluetooth.rst @@ -0,0 +1 @@ +.. include:: ../../en/migration-guides/bluetooth.rst diff --git a/docs/zh_CN/migration-guides/index.rst b/docs/zh_CN/migration-guides/index.rst index f4181d1fbe..b7e7ff26cf 100644 --- a/docs/zh_CN/migration-guides/index.rst +++ b/docs/zh_CN/migration-guides/index.rst @@ -7,6 +7,7 @@ ESP-IDF 5.0 迁移指南 build-system windows-env + :SOC_BT_SUPPORTED: bluetooth ethernet freertos peripherals From a8805e5b01901dfe328c455de3a89afd0b02d3bb Mon Sep 17 00:00:00 2001 From: Darian Leung Date: Mon, 20 Jun 2022 22:46:02 +0800 Subject: [PATCH 2/2] bluedroid: Fix non breaking typos --- .../bluedroid/api/include/api/esp_avrc_api.h | 8 ++++---- .../api/include/api/esp_gap_ble_api.h | 14 +++++++------- .../bluedroid/api/include/api/esp_gap_bt_api.h | 2 +- .../bluedroid/api/include/api/esp_gatt_defs.h | 2 +- .../bluedroid/api/include/api/esp_gattc_api.h | 2 +- .../bluedroid/api/include/api/esp_hf_ag_api.h | 14 +++++++------- .../api/include/api/esp_hf_client_api.h | 2 +- .../bluedroid/api/include/api/esp_hidd_api.h | 12 ++++++------ .../bluedroid/api/include/api/esp_hidh_api.h | 12 ++++++------ .../api/include/api/esp_l2cap_bt_api.h | 16 ++++++++-------- .../bluedroid/api/include/api/esp_sdp_api.h | 10 +++++----- .../bluedroid/api/include/api/esp_spp_api.h | 18 +++++++++--------- 12 files changed, 56 insertions(+), 56 deletions(-) diff --git a/components/bt/host/bluedroid/api/include/api/esp_avrc_api.h b/components/bt/host/bluedroid/api/include/api/esp_avrc_api.h index 81b0aa855a..1c86600356 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_avrc_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_avrc_api.h @@ -25,7 +25,7 @@ typedef enum { ESP_AVRC_FEAT_VENDOR = 0x0008, /*!< remote control vendor dependent commands */ ESP_AVRC_FEAT_BROWSE = 0x0010, /*!< use browsing channel */ ESP_AVRC_FEAT_META_DATA = 0x0040, /*!< remote control metadata transfer command/response */ - ESP_AVRC_FEAT_ADV_CTRL = 0x0200, /*!< remote control advanced control commmand/response */ + ESP_AVRC_FEAT_ADV_CTRL = 0x0200, /*!< remote control advanced control command/response */ } esp_avrc_features_t; /// AVRC supported features flag retrieved in SDP record @@ -103,7 +103,7 @@ typedef enum { /// AVRC passthrough command filter typedef enum { - ESP_AVRC_PSTH_FILTER_ALLOWED_CMD = 0, /*!< all of the PASSTHROUGH commands that can possibly be used, immuateble */ + ESP_AVRC_PSTH_FILTER_ALLOWED_CMD = 0, /*!< all of the PASSTHROUGH commands that can possibly be used, immutable */ ESP_AVRC_PSTH_FILTER_SUPPORTED_CMD = 1, /*!< PASSTHROUGH commands selectively supported according to the current configuration */ ESP_AVRC_PSTH_FILTER_SUPPORT_MAX, } esp_avrc_psth_filter_t; @@ -144,7 +144,7 @@ typedef enum { ESP_AVRC_TG_PASSTHROUGH_CMD_EVT = 2, /*!< passthrough command event */ ESP_AVRC_TG_SET_ABSOLUTE_VOLUME_CMD_EVT = 3, /*!< set absolute volume command from remote device */ ESP_AVRC_TG_REGISTER_NOTIFICATION_EVT = 4, /*!< register notification event */ - ESP_AVRC_TG_SET_PLAYER_APP_VALUE_EVT = 5, /*!< set applicaton attribute value, attribute refer to esp_avrc_ps_attr_ids_t */ + ESP_AVRC_TG_SET_PLAYER_APP_VALUE_EVT = 5, /*!< set application attribute value, attribute refer to esp_avrc_ps_attr_ids_t */ } esp_avrc_tg_cb_event_t; /// AVRC metadata attribute mask @@ -631,7 +631,7 @@ esp_err_t esp_avrc_tg_get_psth_cmd_filter(esp_avrc_psth_filter_t filter, esp_avr * - ESP_ERR_INVALID_STATE: if bluetooth stack is not enabled * - ESP_ERR_INVALID_ARG: if filter type is invalid or cmd_set is NULL * - ESP_ERR_NOT_SUPPORTED:: if filter type is ESP_AVRC_PSTH_FILTER_ALLOWED_CMD, or cmd_set - * includes unallowed commands + * includes commands that are not allowed * */ esp_err_t esp_avrc_tg_set_psth_cmd_filter(esp_avrc_psth_filter_t filter, const esp_avrc_psth_bit_mask_t *cmd_set); diff --git a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h index 24b146f879..a313e5ce7a 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h @@ -677,7 +677,7 @@ typedef uint8_t esp_duplicate_info_t[ESP_BD_ADDR_LEN]; #define ESP_BLE_GAP_SET_EXT_ADV_PROP_CONNECTABLE (1 << 0) // Connectable advertising #define ESP_BLE_GAP_SET_EXT_ADV_PROP_SCANNABLE (1 << 1) // Scannable advertising #define ESP_BLE_GAP_SET_EXT_ADV_PROP_DIRECTED (1 << 2) // Directed advertising -#define ESP_BLE_GAP_SET_EXT_ADV_PROP_HD_DIRECTED (1 << 3) // High Duty Cycle Directed Connectable advertising (<= 3.75 ms Advertis- ing Interval) +#define ESP_BLE_GAP_SET_EXT_ADV_PROP_HD_DIRECTED (1 << 3) // High Duty Cycle Directed Connectable advertising (<= 3.75 ms Advertising Interval) #define ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY (1 << 4) // Use legacy advertising PDUs #define ESP_BLE_GAP_SET_EXT_ADV_PROP_ANON_ADV (1 << 5) // Omit advertiser's address from all PDUs ("anonymous advertising") #define ESP_BLE_GAP_SET_EXT_ADV_PROP_INCLUDE_TX_PWR (1 << 6) // Include TxPower in the extended header of the advertising PDU @@ -765,7 +765,7 @@ typedef struct { uint32_t interval_min; /*!< ext adv minimum interval */ uint32_t interval_max; /*!< ext adv maximum interval */ esp_ble_adv_channel_t channel_map; /*!< ext adv channel map */ - esp_ble_addr_type_t own_addr_type; /*!< ext adv own addresss type */ + esp_ble_addr_type_t own_addr_type; /*!< ext adv own address type */ esp_ble_addr_type_t peer_addr_type; /*!< ext adv peer address type */ esp_bd_addr_t peer_addr; /*!< ext adv peer address */ esp_ble_adv_filter_t filter_policy; /*!< ext adv filter policy */ @@ -774,7 +774,7 @@ typedef struct { uint8_t max_skip; /*!< ext adv maximum skip */ esp_ble_gap_phy_t secondary_phy; /*!< ext adv secondary phy */ uint8_t sid; /*!< ext adv sid */ - bool scan_req_notif; /*!< ext adv sacn request event notify */ + bool scan_req_notif; /*!< ext adv scan request event notify */ } esp_ble_gap_ext_adv_params_t; /** @@ -790,7 +790,7 @@ typedef struct { * @brief ext scan parameters */ typedef struct { - esp_ble_addr_type_t own_addr_type; /*!< ext scan own addresss type */ + esp_ble_addr_type_t own_addr_type; /*!< ext scan own address type */ esp_ble_scan_filter_t filter_policy; /*!< ext scan filter policy */ esp_ble_scan_duplicate_t scan_duplicate; /*!< ext scan duplicate scan */ esp_ble_ext_scan_cfg_mask_t cfg_mask; /*!< ext scan config mask */ @@ -1103,7 +1103,7 @@ typedef union { * @brief ESP_GAP_BLE_EXT_SCAN_RSP_DATA_SET_COMPLETE_EVT */ struct ble_ext_adv_scan_rsp_set_cmpl_evt_param { - esp_bt_status_t status; /*!< Indicate extend advertising sacn response data set status */ + esp_bt_status_t status; /*!< Indicate extend advertising scan response data set status */ } scan_rsp_set; /*!< Event parameter of ESP_GAP_BLE_EXT_SCAN_RSP_DATA_SET_COMPLETE_EVT */ /** * @brief ESP_GAP_BLE_EXT_ADV_START_COMPLETE_EVT @@ -1163,7 +1163,7 @@ typedef union { * @brief ESP_GAP_BLE_PERIODIC_ADV_SYNC_CANCEL_COMPLETE_EVT */ struct ble_period_adv_sync_cancel_cmpl_param { - esp_bt_status_t status; /*!< Indicate periodic advertising sync cancle status */ + esp_bt_status_t status; /*!< Indicate periodic advertising sync cancel status */ } period_adv_sync_cancel; /*!< Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SYNC_CANCEL_COMPLETE_EVT */ /** * @brief ESP_GAP_BLE_PERIODIC_ADV_SYNC_TERMINATE_COMPLETE_EVT @@ -1523,7 +1523,7 @@ esp_err_t esp_ble_gap_set_prefer_conn_params(esp_bd_addr_t bd_addr, esp_err_t esp_ble_gap_set_device_name(const char *name); /** - * @brief This function is called to get local used address and adress type. + * @brief This function is called to get local used address and address type. * uint8_t *esp_bt_dev_get_address(void) get the public address * * @param[in] local_used_addr - current local used ble address (six bytes) diff --git a/components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h b/components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h index 41967471e3..d3e8c90314 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h @@ -474,7 +474,7 @@ esp_err_t esp_bt_gap_set_scan_mode(esp_bt_connection_mode_t c_mode, esp_bt_disco /** * @brief This function starts Inquiry and Name Discovery. This function should be called after esp_bluedroid_enable() completes successfully. * When Inquiry is halted and cached results do not contain device name, then Name Discovery will connect to the peer target to get the device name. - * esp_bt_gap_cb_t will be called with ESP_BT_GAP_DISC_STATE_CHANGED_EVT when Inquriry is started or Name Discovery is completed. + * esp_bt_gap_cb_t will be called with ESP_BT_GAP_DISC_STATE_CHANGED_EVT when Inquiry is started or Name Discovery is completed. * esp_bt_gap_cb_t will be called with ESP_BT_GAP_DISC_RES_EVT each time the two types of discovery results are got. * * @param[in] mode - Inquiry mode diff --git a/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h b/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h index 4a6ccbecf8..bf9546feba 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h @@ -215,7 +215,7 @@ typedef enum { ESP_GATT_UNKNOWN_ERROR = 0xef, /* 0xef */ /* relate to BTA_GATT_UNKNOWN_ERROR in bta/bta_gatt_api.h */ ESP_GATT_CCC_CFG_ERR = 0xfd, /* 0xFD Client Characteristic Configuration Descriptor Improperly Configured */ /* relate to BTA_GATT_CCC_CFG_ERR in bta/bta_gatt_api.h */ ESP_GATT_PRC_IN_PROGRESS = 0xfe, /* 0xFE Procedure Already in progress */ /* relate to BTA_GATT_PRC_IN_PROGRESS in bta/bta_gatt_api.h */ - ESP_GATT_OUT_OF_RANGE = 0xff, /* 0xFFAttribute value out of range */ /* relate to BTA_GATT_OUT_OF_RANGE in bta/bta_gatt_api.h */ + ESP_GATT_OUT_OF_RANGE = 0xff, /* 0xFF Attribute value out of range */ /* relate to BTA_GATT_OUT_OF_RANGE in bta/bta_gatt_api.h */ } esp_gatt_status_t; /* relate to BTA_GATT_CONN_xxx in bta/bta_gatt_api.h */ diff --git a/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h b/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h index b1b54cf18b..48edd89aed 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h @@ -699,7 +699,7 @@ esp_err_t esp_ble_gattc_write_char( esp_gatt_if_t gattc_if, * * @param[in] gattc_if: Gatt client access interface. * @param[in] conn_id : connection ID - * @param[in] handle : descriptor hadle to write. + * @param[in] handle : descriptor handle to write. * @param[in] value_len: length of the value to be written. * @param[in] value : the value to be written. * @param[in] write_type : the type of attribute write operation. diff --git a/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h b/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h index cc0c6bec0c..dad4bcef1f 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h @@ -102,7 +102,7 @@ typedef union } volume_control; /*!< AG callback param of ESP_HF_VOLUME_CONTROL_EVT */ /** - * @brief ESP_HF_UNAT_RESPOSNE_EVT + * @brief ESP_HF_UNAT_RESPONSE_EVT */ struct hf_unat_rep_param { char *unat; /*!< Unknown AT command string */ @@ -130,14 +130,14 @@ typedef union } out_call; /*!< AG callback param of ESP_HF_DIAL_EVT */ /** - * @brief ESP_HF_VTS_RESPOSNE_EVT + * @brief ESP_HF_VTS_RESPONSE_EVT */ struct hf_vts_rep_param { char *code; /*!< MTF code from HF Client */ }vts_rep; /*!< AG callback param of ESP_HF_VTS_RESPONSE_EVT */ /** - * @brief ESP_HF_NREC_RESPOSNE_EVT + * @brief ESP_HF_NREC_RESPONSE_EVT */ struct hf_nrec_param { esp_hf_nrec_t state; /*!< NREC enabled or disabled */ @@ -309,7 +309,7 @@ esp_err_t esp_bt_hf_disconnect_audio(esp_bd_addr_t remote_bda); * @brief Response of Volume Recognition Command(AT+VRA) from HFP client. * As a precondition to use this API, Service Level Connection shall exist with HFP client. * - * @param[in] remote_bda: the device address of voice recognization initiator + * @param[in] remote_bda: the device address of voice recognition initiator * * @param[in] value: 0 - voice recognition disabled, 1- voice recognition enabled * @@ -375,7 +375,7 @@ esp_err_t esp_bt_hf_cmee_response(esp_bd_addr_t remote_bda, esp_hf_at_response_c /** * - * @brief Usolicited send device status notificationto HFP Client. + * @brief Unsolicited send device status notification to HFP Client. * As a precondition to use this API, Service Level Connection shall exist with HFP client. * * @param[in] remote_addr: remote bluetooth device address @@ -395,7 +395,7 @@ esp_err_t esp_bt_hf_indchange_notification(esp_bd_addr_t remote_addr, esp_hf_cal /** * - * @brief Response to device individual indicatiors to HFP Client. + * @brief Response to device individual indicators to HFP Client. * As a precondition to use this API, Service Level Connection shall exist with HFP client. * * @param[in] remote_addr: remote bluetooth device address @@ -404,7 +404,7 @@ esp_err_t esp_bt_hf_indchange_notification(esp_bd_addr_t remote_addr, esp_hf_cal * @param[in] ntk_state: network service state * @param[in] signal: signal strength from 0 to 5 * @param[in] roam: roam state - * @param[in] batt_lev: batery level from 0 to 5 + * @param[in] batt_lev: battery level from 0 to 5 * @param[in] call_held_status: call held status * @return * - ESP_OK: disconnect request is sent to lower layer diff --git a/components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h b/components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h index 08ddbb3864..449941fba7 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h @@ -575,7 +575,7 @@ esp_err_t esp_hf_client_send_dtmf(char code); /** * - * @brief Send command to enable Vendor sepecific feature to indicate battery level + * @brief Send command to enable Vendor specific feature to indicate battery level * and docker status * This is Apple-specific commands, but used by most device, including Android and Windows * diff --git a/components/bt/host/bluedroid/api/include/api/esp_hidd_api.h b/components/bt/host/bluedroid/api/include/api/esp_hidd_api.h index 7a0913235a..ad3ed97eba 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_hidd_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_hidd_api.h @@ -116,8 +116,8 @@ typedef struct { * @brief HID device callback function events */ typedef enum { - ESP_HIDD_INIT_EVT = 0, /*!< When HID device is inited, the event comes */ - ESP_HIDD_DEINIT_EVT, /*!< When HID device is deinited, the event comes */ + ESP_HIDD_INIT_EVT = 0, /*!< When HID device is initialized, the event comes */ + ESP_HIDD_DEINIT_EVT, /*!< When HID device is deinitialized, the event comes */ ESP_HIDD_REGISTER_APP_EVT, /*!< When HID device application registered, the event comes */ ESP_HIDD_UNREGISTER_APP_EVT, /*!< When HID device application unregistered, the event comes */ ESP_HIDD_OPEN_EVT, /*!< When HID device connection to host opened, the event comes */ @@ -278,7 +278,7 @@ esp_err_t esp_bt_hid_device_register_callback(esp_hd_cb_t callback); /** * @brief This function initializes HIDD. This function should be called after esp_bluedroid_enable and - * esp_blueroid_init success, and should be called after esp_bt_hid_device_register_callback. + * esp_bluedroid_init success, and should be called after esp_bt_hid_device_register_callback. * When the operation is complete the callback function will be called with ESP_HIDD_INIT_EVT. * * @return @@ -289,7 +289,7 @@ esp_err_t esp_bt_hid_device_init(void); /** * @brief This function de-initializes HIDD interface. This function should be called after esp_bluedroid_enable() and - * esp_blueroid_init() success, and should be called after esp_bt_hid_device_init(). When the operation is complete the callback + * esp_bluedroid_init() success, and should be called after esp_bt_hid_device_init(). When the operation is complete the callback * function will be called with ESP_HIDD_DEINIT_EVT. * * @return - ESP_OK: success @@ -299,7 +299,7 @@ esp_err_t esp_bt_hid_device_deinit(void); /** * @brief Registers HIDD parameters with SDP and sets l2cap Quality of Service. This function should be called after - * esp_bluedroid_enable and esp_blueroid_init success, and must be done after esp_bt_hid_device_init. When the operation is complete the callback + * esp_bluedroid_enable and esp_bluedroid_init success, and must be done after esp_bt_hid_device_init. When the operation is complete the callback * function will be called with ESP_HIDD_REGISTER_APP_EVT. * * @param[in] app_param: HIDD parameters @@ -314,7 +314,7 @@ esp_err_t esp_bt_hid_device_register_app(esp_hidd_app_param_t *app_param, esp_hi /** * @brief Removes HIDD parameters from SDP and resets l2cap Quality of Service. This function should be called after esp_bluedroid_enable and - * esp_blueroid_init success, and should be called after esp_bt_hid_device_init. When the operation is complete the callback + * esp_bluedroid_init success, and should be called after esp_bt_hid_device_init. When the operation is complete the callback * function will be called with ESP_HIDD_UNREGISTER_APP_EVT. * * @return - ESP_OK: success diff --git a/components/bt/host/bluedroid/api/include/api/esp_hidh_api.h b/components/bt/host/bluedroid/api/include/api/esp_hidh_api.h index 9579c9228c..c0e3a6441e 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_hidh_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_hidh_api.h @@ -34,7 +34,7 @@ typedef enum { ESP_HIDH_HS_HID_NOT_READY, /*!< handshake error : device not ready */ ESP_HIDH_HS_INVALID_RPT_ID, /*!< handshake error : invalid report ID */ ESP_HIDH_HS_TRANS_NOT_SPT, /*!< handshake error : transaction not spt */ - ESP_HIDH_HS_INVALID_PARAM, /*!< handshake error : invalid paremter */ + ESP_HIDH_HS_INVALID_PARAM, /*!< handshake error : invalid paremeter */ ESP_HIDH_HS_ERROR, /*!< handshake error : unspecified HS error */ ESP_HIDH_ERR, /*!< general ESP HH error */ ESP_HIDH_ERR_SDP, /*!< SDP error */ @@ -79,8 +79,8 @@ typedef enum { * @brief HID host callback function events */ typedef enum { - ESP_HIDH_INIT_EVT = 0, /*!< When HID host is inited, the event comes */ - ESP_HIDH_DEINIT_EVT, /*!< When HID host is deinited, the event comes */ + ESP_HIDH_INIT_EVT = 0, /*!< When HID host is initialized, the event comes */ + ESP_HIDH_DEINIT_EVT, /*!< When HID host is deinitialized, the event comes */ ESP_HIDH_OPEN_EVT, /*!< When HID host connection opened, the event comes */ ESP_HIDH_CLOSE_EVT, /*!< When HID host connection closed, the event comes */ ESP_HIDH_GET_RPT_EVT, /*!< When Get_Report command is called, the event comes */ @@ -89,7 +89,7 @@ typedef enum { ESP_HIDH_SET_PROTO_EVT, /*!< When Set_Protocol command is called, the event comes */ ESP_HIDH_GET_IDLE_EVT, /*!< When Get_Idle command is called, the event comes */ ESP_HIDH_SET_IDLE_EVT, /*!< When Set_Idle command is called, the event comes */ - ESP_HIDH_GET_DSCP_EVT, /*!< When HIDH is inited, the event comes */ + ESP_HIDH_GET_DSCP_EVT, /*!< When HIDH is initialized, the event comes */ ESP_HIDH_ADD_DEV_EVT, /*!< When a device is added, the event comes */ ESP_HIDH_RMV_DEV_EVT, /*!< When a device is removed, the event comes */ ESP_HIDH_VC_UNPLUG_EVT, /*!< When virtually unplugged, the event comes */ @@ -295,7 +295,7 @@ esp_err_t esp_bt_hid_host_register_callback(esp_hh_cb_t callback); /** * @brief This function initializes HID host. This function should be called after esp_bluedroid_enable() and - * esp_blueroid_init() success, and should be called after esp_bt_hid_host_register_callback(). + * esp_bluedroid_init() success, and should be called after esp_bt_hid_host_register_callback(). * When the operation is complete the callback function will be called with ESP_HIDH_INIT_EVT. * * @return @@ -306,7 +306,7 @@ esp_err_t esp_bt_hid_host_init(void); /** * @brief Closes the interface. This function should be called after esp_bluedroid_enable() and - * esp_blueroid_init() success, and should be called after esp_bt_hid_host_init(). + * esp_bluedroid_init() success, and should be called after esp_bt_hid_host_init(). * When the operation is complete the callback function will be called with ESP_HIDH_DEINIT_EVT. * * @return - ESP_OK: success diff --git a/components/bt/host/bluedroid/api/include/api/esp_l2cap_bt_api.h b/components/bt/host/bluedroid/api/include/api/esp_l2cap_bt_api.h index 1a3ee98bf7..f11c932f1c 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_l2cap_bt_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_l2cap_bt_api.h @@ -44,8 +44,8 @@ typedef uint32_t esp_bt_l2cap_cntl_flags_t; * @brief L2CAP callback function events */ typedef enum { - ESP_BT_L2CAP_INIT_EVT = 0, /*!< When L2CAP is inited, the event comes */ - ESP_BT_L2CAP_UNINIT_EVT = 1, /*!< When L2CAP is uninited, the event comes */ + ESP_BT_L2CAP_INIT_EVT = 0, /*!< When L2CAP is initialized, the event comes */ + ESP_BT_L2CAP_UNINIT_EVT = 1, /*!< When L2CAP is deinitialized, the event comes */ ESP_BT_L2CAP_OPEN_EVT = 16, /*!< When L2CAP Client connection open, the event comes */ ESP_BT_L2CAP_CLOSE_EVT = 17, /*!< When L2CAP connection closed, the event comes */ ESP_BT_L2CAP_START_EVT = 18, /*!< When L2CAP server started, the event comes */ @@ -166,7 +166,7 @@ esp_err_t esp_bt_l2cap_deinit(void); * @brief This function makes an L2CAP connection to a remote BD Address. * When the connection is initiated or failed to initiate, the callback is called with ESP_BT_L2CAP_CL_INIT_EVT. * When the connection is established or failed, the callback is called with ESP_BT_L2CAP_OPEN_EVT. - * This funciton must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). + * This function must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). * * @param[in] cntl_flag: Lower 16-bit security settings mask. * @param[in] remote_psm: Remote device bluetooth Profile PSM. @@ -183,7 +183,7 @@ esp_err_t esp_bt_l2cap_connect(esp_bt_l2cap_cntl_flags_t cntl_flag, uint16_t rem * L2CAP connection request from a remote Bluetooth device. * When the server is started successfully, the callback is called with ESP_BT_L2CAP_START_EVT. * When the connection is established, the callback is called with ESP_BT_L2CAP_OPEN_EVT. - * This funciton must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). + * This function must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). * * @param[in] cntl_flag: Lower 16-bit security settings mask. * @param[in] local_psm: Dynamic PSM. @@ -199,7 +199,7 @@ esp_err_t esp_bt_l2cap_start_srv(esp_bt_l2cap_cntl_flags_t cntl_flag, uint16_t l * The operation will close all active L2CAP connection first, then the callback function will be called * with ESP_BT_L2CAP_CLOSE_EVT, and the number of ESP_BT_L2CAP_CLOSE_EVT is equal to the number of connection. * When the operation is completed, the callback is called with ESP_BT_L2CAP_SRV_STOP_EVT. - * This funciton must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). + * This function must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). * * @return * - ESP_OK: success @@ -213,7 +213,7 @@ esp_err_t esp_bt_l2cap_stop_all_srv(void); * The operation will close all active L2CAP connection first on the specific L2CAP server, then the callback function will * be called with ESP_BT_L2CAP_CLOSE_EVT, and the number of ESP_BT_L2CAP_CLOSE_EVT is equal to the number of connection. * When the operation is completed, the callback is called with ESP_BT_L2CAP_SRV_STOP_EVT. - * This funciton must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). + * This function must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). * * @param[in] local_psm: Dynamic PSM. * @@ -226,7 +226,7 @@ esp_err_t esp_bt_l2cap_stop_srv(uint16_t local_psm); /** * @brief This function is used to register VFS. * Only supports write, read and close. - * This funciton must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). + * This function must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). * * @return * - ESP_OK: success @@ -236,7 +236,7 @@ esp_err_t esp_bt_l2cap_vfs_register(void); /** * @brief This function is used to unregister VFS. - * This funciton must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). + * This function must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit(). * * @return * - ESP_OK: success diff --git a/components/bt/host/bluedroid/api/include/api/esp_sdp_api.h b/components/bt/host/bluedroid/api/include/api/esp_sdp_api.h index cb944a5ced..14741e7471 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_sdp_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_sdp_api.h @@ -30,8 +30,8 @@ typedef enum { * @brief SDP callback function events */ typedef enum { - ESP_SDP_INIT_EVT = 0, /*!< When SDP is inited, the event comes */ - ESP_SDP_DEINIT_EVT = 1, /*!< When SDP is deinited, the event comes */ + ESP_SDP_INIT_EVT = 0, /*!< When SDP is initialized, the event comes */ + ESP_SDP_DEINIT_EVT = 1, /*!< When SDP is deinitialized, the event comes */ ESP_SDP_SEARCH_COMP_EVT = 2, /*!< When SDP search complete, the event comes */ ESP_SDP_CREATE_RECORD_COMP_EVT = 3, /*!< When create SDP records complete, the event comes */ ESP_SDP_REMOVE_RECORD_COMP_EVT = 4, /*!< When remove a SDP record complete, the event comes */ @@ -227,7 +227,7 @@ esp_err_t esp_sdp_deinit(void); /** * @brief This function is called to performs service discovery for the services provided by the given peer device. * When the operation is completed, the callback function will be called with ESP_SDP_SEARCH_COMP_EVT. - * This funciton must be called after esp_sdp_init() successful and before esp_sdp_deinit(). + * This function must be called after esp_sdp_init() successful and before esp_sdp_deinit(). * * @param[in] bd_addr: Remote device bluetooth device address. * @param[in] uuid: Service UUID of the remote device. @@ -241,7 +241,7 @@ esp_err_t esp_sdp_search_record(esp_bd_addr_t bd_addr, esp_bt_uuid_t uuid); /** * @brief This function is called to create SDP records. * When the operation is completed, the callback function will be called with ESP_SDP_CREATE_RECORD_COMP_EVT. - * This funciton must be called after esp_sdp_init() successful and before esp_sdp_deinit(). + * This function must be called after esp_sdp_init() successful and before esp_sdp_deinit(). * * @param[in] record: The SDP record to create. * @@ -254,7 +254,7 @@ esp_err_t esp_sdp_create_record(esp_bluetooth_sdp_record_t *record); /** * @brief This function is called to remove a SDP record. * When the operation is completed, the callback function will be called with ESP_SDP_REMOVE_RECORD_COMP_EVT. - * This funciton must be called after esp_sdp_init() successful and before esp_sdp_deinit(). + * This function must be called after esp_sdp_init() successful and before esp_sdp_deinit(). * * @param[in] record_handle: The SDP record handle. * diff --git a/components/bt/host/bluedroid/api/include/api/esp_spp_api.h b/components/bt/host/bluedroid/api/include/api/esp_spp_api.h index 4eaa1f4012..67cbe969c2 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_spp_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_spp_api.h @@ -57,8 +57,8 @@ typedef enum { * @brief SPP callback function events */ typedef enum { - ESP_SPP_INIT_EVT = 0, /*!< When SPP is inited, the event comes */ - ESP_SPP_UNINIT_EVT = 1, /*!< When SPP is uninited, the event comes */ + ESP_SPP_INIT_EVT = 0, /*!< When SPP is initialized, the event comes */ + ESP_SPP_UNINIT_EVT = 1, /*!< When SPP is deinitialized, the event comes */ ESP_SPP_DISCOVERY_COMP_EVT = 8, /*!< When SDP discovery complete, the event comes */ ESP_SPP_OPEN_EVT = 26, /*!< When SPP Client connection open, the event comes */ ESP_SPP_CLOSE_EVT = 27, /*!< When SPP connection closed, the event comes */ @@ -240,7 +240,7 @@ esp_err_t esp_spp_deinit(void); /** * @brief This function is called to performs service discovery for the services provided by the given peer device. * When the operation is completed, the callback function will be called with ESP_SPP_DISCOVERY_COMP_EVT. - * This funciton must be called after esp_spp_init() successful and before esp_spp_deinit(). + * This function must be called after esp_spp_init() successful and before esp_spp_deinit(). * * @param[in] bd_addr: Remote device bluetooth device address. * @@ -254,7 +254,7 @@ esp_err_t esp_spp_start_discovery(esp_bd_addr_t bd_addr); * @brief This function makes an SPP connection to a remote BD Address. * When the connection is initiated or failed to initiate, the callback is called with ESP_SPP_CL_INIT_EVT. * When the connection is established or failed, the callback is called with ESP_SPP_OPEN_EVT. - * This funciton must be called after esp_spp_init() successful and before esp_spp_deinit(). + * This function must be called after esp_spp_init() successful and before esp_spp_deinit(). * * @param[in] sec_mask: Security Setting Mask. Suggest to use ESP_SPP_SEC_NONE, ESP_SPP_SEC_AUTHORIZE or ESP_SPP_SEC_AUTHENTICATE only. * @param[in] role: Master or slave. @@ -270,7 +270,7 @@ esp_err_t esp_spp_connect(esp_spp_sec_t sec_mask, esp_spp_role_t role, uint8_t r /** * @brief This function closes an SPP connection. * When the operation is completed, the callback function will be called with ESP_SPP_CLOSE_EVT. - * This funciton must be called after esp_spp_init() successful and before esp_spp_deinit(). + * This function must be called after esp_spp_init() successful and before esp_spp_deinit(). * * @param[in] handle: The connection handle. * @@ -285,7 +285,7 @@ esp_err_t esp_spp_disconnect(uint32_t handle); * SPP connection request from a remote Bluetooth device. * When the server is started successfully, the callback is called with ESP_SPP_START_EVT. * When the connection is established, the callback is called with ESP_SPP_SRV_OPEN_EVT. - * This funciton must be called after esp_spp_init() successful and before esp_spp_deinit(). + * This function must be called after esp_spp_init() successful and before esp_spp_deinit(). * * @param[in] sec_mask: Security Setting Mask. Suggest to use ESP_SPP_SEC_NONE, ESP_SPP_SEC_AUTHORIZE or ESP_SPP_SEC_AUTHENTICATE only. * @param[in] role: Master or slave. @@ -304,7 +304,7 @@ esp_err_t esp_spp_start_srv(esp_spp_sec_t sec_mask, esp_spp_role_t role, uint8_t * The operation will close all active SPP connection first, then the callback function will be called * with ESP_SPP_CLOSE_EVT, and the number of ESP_SPP_CLOSE_EVT is equal to the number of connection. * When the operation is completed, the callback is called with ESP_SPP_SRV_STOP_EVT. - * This funciton must be called after esp_spp_init() successful and before esp_spp_deinit(). + * This function must be called after esp_spp_init() successful and before esp_spp_deinit(). * * @return * - ESP_OK: success @@ -318,7 +318,7 @@ esp_err_t esp_spp_stop_srv(void); * The operation will close all active SPP connection first on the specific SPP server, then the callback function will be called * with ESP_SPP_CLOSE_EVT, and the number of ESP_SPP_CLOSE_EVT is equal to the number of connection. * When the operation is completed, the callback is called with ESP_SPP_SRV_STOP_EVT. - * This funciton must be called after esp_spp_init() successful and before esp_spp_deinit(). + * This function must be called after esp_spp_init() successful and before esp_spp_deinit(). * * @param[in] scn: Server channel number. * @@ -334,7 +334,7 @@ esp_err_t esp_spp_stop_srv_scn(uint8_t scn); * the previous event ESP_SPP_WRITE_EVT is received and the parameter 'cong' is equal to false. If the previous event * ESP_SPP_WRITE_EVT with parameter 'cong' is equal to true, the function can only be called again when the event * ESP_SPP_CONG_EVT with parameter 'cong' equal to false is received. - * This funciton must be called after an connection between initiator and acceptor has been established. + * This function must be called after an connection between initiator and acceptor has been established. * * @param[in] handle: The connection handle. * @param[in] len: The length of the data written.