Jelajahi Sumber

Merge branch 'doc/make_classic_bt_API_ref_only_for_esp32_4.3' into 'release/v4.3'

Doc/make classic bt api ref only for esp32 [backport v4.3]

See merge request espressif/esp-idf!15726
Jiang Jiang Jian 4 tahun lalu
induk
melakukan
daf9cbbb01

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

@@ -63,6 +63,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

@@ -13,6 +13,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_RTC_SLOW_MEM_SUPPORTED      1
 #define SOC_CCOMP_TIMER_SUPPORTED       1
 #define SOC_DIG_SIGN_SUPPORTED          1
@@ -20,7 +21,6 @@
 #define SOC_ASYNC_MEMCPY_SUPPORTED      1
 #define SOC_EFUSE_SECURE_BOOT_KEY_DIGESTS 3
 
-
 /*-------------------------- ADC CAPS ----------------------------------------*/
 #include "adc_caps.h"
 

+ 24 - 1
docs/conf_common.py

@@ -136,7 +136,29 @@ exclude_patterns = ['**/inc/**', '_static/', '_build/**']
 
 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']
@@ -205,6 +227,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,

+ 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` 示例目录下,请查看。