Merge branch 'feature/update_ble_doc_for_esp32c6_esp32h2_v5.1' into 'release/v5.1'

ble docs: Update ble doc for esp32c6 and esp32h2 See merge request espressif/esp-idf!23801
2023-05-23 15:33:51 +08:00 · 2023-05-23 15:33:51 +08:00 · 6ad6fb9755
commit 6ad6fb9755
--- a/components/soc/esp32/include/soc/Kconfig.soc_caps.in
+++ b/components/soc/esp32/include/soc/Kconfig.soc_caps.in
@ -843,6 +843,10 @@ config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
    bool
    default n

+config SOC_BLUFI_SUPPORTED
+    bool
+    default y
+
 config SOC_ULP_HAS_ADC
    bool
    default y
--- a/components/soc/esp32/include/soc/soc_caps.h
+++ b/components/soc/esp32/include/soc/soc_caps.h
@ -413,6 +413,7 @@
 #define SOC_BLE_MESH_SUPPORTED          (1)    /*!< Support BLE MESH */
 #define SOC_BT_CLASSIC_SUPPORTED        (1)    /*!< Support Bluetooth Classic hardware */
 #define SOC_BLE_DEVICE_PRIVACY_SUPPORTED (0)   /*!< Support BLE device privacy mode */
+#define SOC_BLUFI_SUPPORTED             (1)    /*!< Support BLUFI */

 /*-------------------------- ULP CAPS ----------------------------------------*/
 #define SOC_ULP_HAS_ADC                     (1)    /* ADC can be accessed from ULP */
--- a/components/soc/esp32c2/include/soc/Kconfig.soc_caps.in
+++ b/components/soc/esp32c2/include/soc/Kconfig.soc_caps.in
@ -654,3 +654,7 @@ config SOC_BLE_50_SUPPORTED
 config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
    bool
    default y
+
+config SOC_BLUFI_SUPPORTED
+    bool
+    default y
--- a/components/soc/esp32c2/include/soc/soc_caps.h
+++ b/components/soc/esp32c2/include/soc/soc_caps.h
@ -306,3 +306,4 @@
 #define SOC_ESP_NIMBLE_CONTROLLER       (1)    /*!< Support BLE EMBEDDED controller V1 */
 #define SOC_BLE_50_SUPPORTED            (1)    /*!< Support Bluetooth 5.0 */
 #define SOC_BLE_DEVICE_PRIVACY_SUPPORTED (1)   /*!< Support BLE device privacy mode */
+#define SOC_BLUFI_SUPPORTED             (1)    /*!< Support BLUFI */
--- a/components/soc/esp32c3/include/soc/Kconfig.soc_caps.in
+++ b/components/soc/esp32c3/include/soc/Kconfig.soc_caps.in
@ -970,3 +970,7 @@ config SOC_BLE_50_SUPPORTED
 config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
    bool
    default y
+
+config SOC_BLUFI_SUPPORTED
+    bool
+    default y
--- a/components/soc/esp32c3/include/soc/soc_caps.h
+++ b/components/soc/esp32c3/include/soc/soc_caps.h
@ -420,3 +420,4 @@
 #define SOC_BLE_MESH_SUPPORTED          (1)    /*!< Support BLE MESH */
 #define SOC_BLE_50_SUPPORTED		(1)    /*!< Support Bluetooth 5.0 */
 #define SOC_BLE_DEVICE_PRIVACY_SUPPORTED (1)   /*!< Support BLE device privacy mode */
+#define SOC_BLUFI_SUPPORTED             (1)    /*!< Support BLUFI */
--- a/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in
+++ b/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in
@ -1234,3 +1234,7 @@ config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
 config SOC_BLE_POWER_CONTROL_SUPPORTED
    bool
    default y
+
+config SOC_BLUFI_SUPPORTED
+    bool
+    default y
--- a/components/soc/esp32c6/include/soc/soc_caps.h
+++ b/components/soc/esp32c6/include/soc/soc_caps.h
@ -507,3 +507,4 @@
 #define SOC_BLE_50_SUPPORTED            (1)    /*!< Support Bluetooth 5.0 */
 #define SOC_BLE_DEVICE_PRIVACY_SUPPORTED (1)   /*!< Support BLE device privacy mode */
 #define SOC_BLE_POWER_CONTROL_SUPPORTED (1)    /*!< Support Bluetooth Power Control */
+#define SOC_BLUFI_SUPPORTED             (1)    /*!< Support BLUFI */
--- a/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in
+++ b/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in
@ -1251,6 +1251,10 @@ config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
    bool
    default y

+config SOC_BLUFI_SUPPORTED
+    bool
+    default y
+
 config SOC_ULP_HAS_ADC
    bool
    default y
--- a/components/soc/esp32s3/include/soc/soc_caps.h
+++ b/components/soc/esp32s3/include/soc/soc_caps.h
@ -506,6 +506,7 @@
 #define SOC_BLE_MESH_SUPPORTED          (1)    /*!< Support BLE MESH */
 #define SOC_BLE_50_SUPPORTED            (1)    /*!< Support Bluetooth 5.0 */
 #define SOC_BLE_DEVICE_PRIVACY_SUPPORTED (1)   /*!< Support BLE device privacy mode */
+#define SOC_BLUFI_SUPPORTED             (1)    /*!< Support BLUFI */

 /*-------------------------- ULP CAPS ----------------------------------------*/
 #define SOC_ULP_HAS_ADC                     (1)    /* ADC can be accessed from ULP */
--- a/docs/conf_common.py
+++ b/docs/conf_common.py
@ -19,8 +19,7 @@ from esp_docs.conf_docs import *  # noqa: F403,F401
 if os.environ.get('IDF_PATH') is None:
    raise RuntimeError('IDF_PATH should be set, run export.sh before building docs')

-BT_DOCS = ['api-guides/blufi.rst',
-           'api-reference/bluetooth/bt_le.rst',
+BT_DOCS = ['api-reference/bluetooth/bt_le.rst',
           'api-reference/bluetooth/esp_bt_defs.rst',
           'api-reference/bluetooth/esp_bt_device.rst',
           'api-reference/bluetooth/esp_bt_main.rst',
@ -30,7 +29,6 @@ BT_DOCS = ['api-guides/blufi.rst',
           'api-reference/bluetooth/esp_gatt_defs.rst',
           'api-reference/bluetooth/esp_gatts.rst',
           'api-reference/bluetooth/esp_gattc.rst',
-           'api-reference/bluetooth/esp_blufi.rst',
           'api-reference/bluetooth/index.rst',
           'api-reference/bluetooth/nimble/index.rst']

@ -56,6 +54,9 @@ CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst',
                   'api-reference/bluetooth/esp_gap_bt.rst',
                   'migration-guides/release-5.x/5.0/bluetooth-classic.rst']

+BLUFI_DOCS = ['api-guides/blufi.rst',
+              'api-reference/bluetooth/esp_blufi.rst']
+
 WIFI_DOCS = ['api-guides/wifi.rst',
             'api-guides/wifi-security.rst',
             'api-guides/wireshark-user-guide.rst']
@ -167,6 +168,7 @@ ESP32C6_DOCS = ['api-guides/RF_calibration.rst',
 conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
                            'SOC_BLE_SUPPORTED':BLE_DOCS,
                            'SOC_BLE_MESH_SUPPORTED':BLE_MESH_DOCS,
+                            'SOC_BLUFI_SUPPORTED':BLUFI_DOCS,
                            'SOC_WIFI_SUPPORTED':WIFI_DOCS,
                            'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS,
                            'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS,
--- a/docs/docs_not_updated/esp32c6.txt
+++ b/docs/docs_not_updated/esp32c6.txt
@ -1,15 +1,8 @@
-api-guides/blufi
 api-guides/coexist
 api-guides/usb-serial-jtag-console
 api-guides/wifi
 api-guides/esp-wifi-mesh
 api-guides/dfu
-api-guides/esp-ble-mesh
-api-guides/esp-ble-mesh/ble-mesh-index
-api-guides/esp-ble-mesh/ble-mesh-feature-list
-api-guides/esp-ble-mesh/ble-mesh-terminology
-api-guides/esp-ble-mesh/ble-mesh-architecture
-api-guides/esp-ble-mesh/ble-mesh-faq
 api-guides/wifi-security
 api-guides/openthread
 api-reference/storage/vfs
@ -38,33 +31,6 @@ api-reference/system/ulp_instruction_set
 api-reference/system/power_management
 api-reference/system/inc/power_management_esp32s2_and_later
 api-reference/system/ulp-risc-v
-api-reference/bluetooth
-api-reference/bluetooth/esp_spp
-api-reference/bluetooth/esp_l2cap_bt
-api-reference/bluetooth/esp_hidd
-api-reference/bluetooth/esp_avrc
-api-reference/bluetooth/controller_vhci
-api-reference/bluetooth/esp_bt_defs
-api-reference/bluetooth/esp_hf_ag
-api-reference/bluetooth/esp_bt_main
-api-reference/bluetooth/esp_bt_device
-api-reference/bluetooth/esp_gatts
-api-reference/bluetooth/esp_gattc
-api-reference/bluetooth/esp_sdp
-api-reference/bluetooth/bt_common
-api-reference/bluetooth/nimble
-api-reference/bluetooth/nimble/index
-api-reference/bluetooth/esp_hf_client
-api-reference/bluetooth/esp_a2dp
-api-reference/bluetooth/esp_blufi
-api-reference/bluetooth/bt_le
-api-reference/bluetooth/esp_hf_defs
-api-reference/bluetooth/esp_gap_bt
-api-reference/bluetooth/esp_gatt_defs
-api-reference/bluetooth/esp-ble-mesh
-api-reference/bluetooth/index
-api-reference/bluetooth/esp_gap_ble
-api-reference/bluetooth/classic_bt
 api-reference/protocols/esp_serial_slave_link
 api-reference/protocols/esp_spi_slave_protocol
 api-reference/protocols/index
--- a/docs/docs_not_updated/esp32h2.txt
+++ b/docs/docs_not_updated/esp32h2.txt
@ -8,17 +8,11 @@ contribute/copyright-guide
 contribute/install-pre-commit-hook
 contribute/index
 api-guides/RF_calibration
-api-guides/blufi
 api-guides/coexist
 api-guides/wifi
 api-guides/esp-wifi-mesh
 api-guides/cplusplus
 api-guides/dfu
-api-guides/esp-ble-mesh/ble-mesh-index
-api-guides/esp-ble-mesh/ble-mesh-feature-list
-api-guides/esp-ble-mesh/ble-mesh-terminology
-api-guides/esp-ble-mesh/ble-mesh-architecture
-api-guides/esp-ble-mesh/ble-mesh-faq
 api-guides/wifi-security
 api-guides/index
 api-guides/openthread
@ -64,32 +58,6 @@ api-reference/system/system_time
 api-reference/system/power_management
 api-reference/system/inc/power_management_esp32
 api-reference/system/inc/power_management_esp32s2_and_later
-api-reference/bluetooth/esp_spp
-api-reference/bluetooth/esp_l2cap_bt
-api-reference/bluetooth/esp_hidd
-api-reference/bluetooth/esp_avrc
-api-reference/bluetooth/controller_vhci
-api-reference/bluetooth/esp_bt_defs
-api-reference/bluetooth/esp_hf_ag
-api-reference/bluetooth/esp_bt_main
-api-reference/bluetooth/esp_bt_device
-api-reference/bluetooth/esp_gatts
-api-reference/bluetooth/esp_gattc
-api-reference/bluetooth/esp_sdp
-api-reference/bluetooth/bt_common
-api-reference/bluetooth/nimble
-api-reference/bluetooth/nimble/index
-api-reference/bluetooth/esp_hf_client
-api-reference/bluetooth/esp_a2dp
-api-reference/bluetooth/esp_blufi
-api-reference/bluetooth/bt_le
-api-reference/bluetooth/esp_hf_defs
-api-reference/bluetooth/esp_gap_bt
-api-reference/bluetooth/esp_gatt_defs
-api-reference/bluetooth/esp-ble-mesh
-api-reference/bluetooth/index
-api-reference/bluetooth/esp_gap_ble
-api-reference/bluetooth/classic_bt
 api-reference/protocols/esp_serial_slave_link
 api-reference/protocols/esp_sdio_slave_protocol
 api-reference/protocols/esp_spi_slave_protocol
@ -99,9 +67,7 @@ about
 resources
 migration-guides/release-5.x/5.1/index
 migration-guides/release-5.x/5.1/peripherals
-migration-guides/release-5.x/5.0/bluetooth-classic
 migration-guides/release-5.x/5.0/gcc
-migration-guides/release-5.x/5.0/bluetooth-low-energy
 migration-guides/release-5.x/5.0/removed-components
 migration-guides/release-5.x/5.0/protocols
 migration-guides/release-5.x/5.0/networking
--- a/docs/en/api-guides/index.rst
+++ b/docs/en/api-guides/index.rst
@ -7,7 +7,7 @@ API Guides

   app_trace
   startup
-   :SOC_BT_SUPPORTED: blufi
+   :SOC_BLUFI_SUPPORTED: blufi
   bootloader
   build-system
   :SOC_SUPPORT_COEXISTENCE: coexist
--- a/docs/en/api-reference/bluetooth/bt_le.rst
+++ b/docs/en/api-reference/bluetooth/bt_le.rst
@ -8,4 +8,4 @@ BT LE
   BLE GATT DEFINE <esp_gatt_defs>
   BLE GATT SERVER <esp_gatts>
   BLE GATT CLIENT <esp_gattc>
-   BLE BLUFI <esp_blufi>
+   :SOC_BLUFI_SUPPORTED: BLE BLUFI <esp_blufi>
--- a/docs/zh_CN/api-guides/index.rst
+++ b/docs/zh_CN/api-guides/index.rst
@ -7,7 +7,7 @@ API 指南

   app_trace
   startup
-   :SOC_BT_SUPPORTED: blufi
+   :SOC_BLUFI_SUPPORTED: blufi
   bootloader
   build-system
   :SOC_SUPPORT_COEXISTENCE: coexist