Просмотр исходного кода

Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32' into 'master'

Doc/Make Classic BT related document links only visible for ESP32

Closes IDFGH-5008, IDFGH-6022, and AUD-3378

See merge request espressif/esp-idf!15635
Wei Tian Hua 4 лет назад
Родитель
Сommit
347e04cf73

+ 1 - 0
components/soc/esp32/include/soc/soc_caps.h

@@ -56,6 +56,7 @@
 #define SOC_MCPWM_SUPPORTED         1
 #define SOC_SDMMC_HOST_SUPPORTED    1
 #define SOC_BT_SUPPORTED            1
+#define SOC_CLASSIC_BT_SUPPORTED    1
 #define SOC_PCNT_SUPPORTED          1
 #define SOC_SDIO_SLAVE_SUPPORTED    1
 #define SOC_TWAI_SUPPORTED          1

+ 1 - 1
components/soc/esp32s3/include/soc/soc_caps.h

@@ -21,6 +21,7 @@
 #define SOC_CPU_CORES_NUM               2
 #define SOC_CACHE_SUPPORT_WRAP          1
 #define SOC_ULP_SUPPORTED               1
+#define SOC_BT_SUPPORTED                1
 #define SOC_USB_OTG_SUPPORTED           1
 #define SOC_USB_SERIAL_JTAG_SUPPORTED   1
 #define SOC_RTC_SLOW_MEM_SUPPORTED      1
@@ -37,7 +38,6 @@
 #define SOC_PSRAM_DMA_CAPABLE             1
 #define SOC_XT_WDT_SUPPORTED              1
 
-
 /*-------------------------- SOC CAPS ----------------------------------------*/
 #define SOC_APPCPU_HAS_CLOCK_GATING_BUG (1)
 

+ 24 - 1
docs/conf_common.py

@@ -20,7 +20,29 @@ if os.environ.get('IDF_PATH') is None:
 
 BT_DOCS = ['api-guides/blufi.rst',
            'api-guides/esp-ble-mesh/**',
-           'api-reference/bluetooth/**']
+           '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',
+           'api-reference/bluetooth/bt_common.rst',
+           'api-reference/bluetooth/controller_vhci.rst',
+           'api-reference/bluetooth/esp_gap_ble.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/esp-ble-mesh.rst',
+           'api-reference/bluetooth/index.rst',
+           'api-reference/bluetooth/nimble/index.rst']
+
+CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst',
+                   'api-reference/bluetooth/esp_a2dp.rst',
+                   'api-reference/bluetooth/esp_avrc.rst',
+                   'api-reference/bluetooth/esp_hf_defs.rst',
+                   'api-reference/bluetooth/esp_hf_client.rst',
+                   'api-reference/bluetooth/esp_hf_ag.rst',
+                   'api-reference/bluetooth/esp_spp.rst',
+                   'api-reference/bluetooth/esp_gap_bt.rst']
 
 SDMMC_DOCS = ['api-reference/peripherals/sdmmc_host.rst',
               'api-reference/peripherals/sd_pullup_requirements.rst']
@@ -94,6 +116,7 @@ ESP32C3_DOCS = ['hw-reference/esp32c3/**']
 
 # format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers
 conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
+                            'SOC_CLASSIC_BT_SUPPORTED':CLASSIC_BT_DOCS,
                             'SOC_SDMMC_HOST_SUPPORTED':SDMMC_DOCS,
                             'SOC_SDIO_SLAVE_SUPPORTED':SDIO_SLAVE_DOCS,
                             'SOC_MCPWM_SUPPORTED':MCPWM_DOCS,

+ 1 - 1
docs/en/api-guides/performance/speed.rst

@@ -1,7 +1,7 @@
 Maximizing Execution Speed
 ==========================
 
-{IDF_TARGET_CONTROLLER_CORE_CONFIG:default="CONFIG_BT_CTRL_PINNED_TO_CORE", esp32="CONFIG_BTDM_CTRL_PINNED_TO_CORE_CHOICE"}
+{IDF_TARGET_CONTROLLER_CORE_CONFIG:default="CONFIG_BT_CTRL_PINNED_TO_CORE", esp32="CONFIG_BTDM_CTRL_PINNED_TO_CORE_CHOICE", esp32s3="CONFIG_BT_CTRL_PINNED_TO_CORE_CHOICE"}
 {IDF_TARGET_RF_TYPE:default="Wi-Fi/BT", esp32s2="Wi-Fi"}
 
 Overview

+ 5 - 4
docs/en/api-reference/bluetooth/index.rst

@@ -9,7 +9,7 @@ Bluetooth API
     Bluetooth Controller && VHCI <controller_vhci>
     Bluetooth Common <bt_common>
     Bluetooth LE <bt_le>
-    Bluetooth Classic <classic_bt>
+    :SOC_CLASSIC_BT_SUPPORTED: Bluetooth Classic <classic_bt>
     NimBLE <nimble/index>
     ESP-BLE-MESH <esp-ble-mesh>
 
@@ -18,11 +18,12 @@ ESP-IDF currently supports two host stacks. The Bluedroid based stack (default)
 * For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.
 * For BLE-only usecases, using NimBLE is recommended. It is less demanding in terms of code footprint and runtime memory, making it suitable for such scenarios.
 
+.. only:: esp32
 
-For the overview of the ESP32 Bluetooth stack architecture, follow the links below:
+    For the overview of the ESP32 Bluetooth stack architecture, follow the links below:
 
-* `ESP32 Bluetooth Architecture (PDF) [English] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
-* `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
+       * `ESP32 Bluetooth Architecture (PDF) [English] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
+       * `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
 
 Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples.
 

+ 5 - 3
docs/zh_CN/api-reference/bluetooth/index.rst

@@ -9,13 +9,15 @@
    Bluetooth Controller && VHCI <controller_vhci>
    Bluetooth Common <bt_common>
    Bluetooth LE <bt_le>
-   Bluetooth Classic <classic_bt>
+   :SOC_CLASSIC_BT_SUPPORTED: Bluetooth Classic <classic_bt>
    NimBLE <nimble/index>
    ESP-BLE-MESH <esp-ble-mesh>
 
-请点击下方链接,查看 ESP32 蓝牙架构:
+.. only:: esp32
 
-`ESP32 蓝牙架构 (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
+   请点击下方链接,查看 ESP32 蓝牙架构:
+
+   `ESP32 蓝牙架构 (PDF) <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
 
 蓝牙 API 的示例代码存放于 ESP-IDF :example:`bluetooth/bluedroid` 示例目录下,请查看。