alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

ble docs: Update the ble docs for esp32c6 and esp32h2

Browse Source
This commit is contained in:
Shen Weilong 2023-05-17 17:36:15 +08:00
parent cc7c851cb2
commit 0d12613ab9
16 changed files with 33 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
components/soc/esp32/include/soc/Kconfig.soc_caps.in
View File

@ -843,6 +843,10 @@ config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
bool bool
default n default n
config SOC_BLUFI_SUPPORTED
bool
default y
config SOC_ULP_HAS_ADC config SOC_ULP_HAS_ADC
bool bool
default y default y

1
components/soc/esp32/include/soc/soc_caps.h
View File

@ -413,6 +413,7 @@
#define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */ #define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */
#define SOC_BT_CLASSIC_SUPPORTED (1) /*!< Support Bluetooth Classic hardware */ #define SOC_BT_CLASSIC_SUPPORTED (1) /*!< Support Bluetooth Classic hardware */
#define SOC_BLE_DEVICE_PRIVACY_SUPPORTED (0) /*!< Support BLE device privacy mode */ #define SOC_BLE_DEVICE_PRIVACY_SUPPORTED (0) /*!< Support BLE device privacy mode */
#define SOC_BLUFI_SUPPORTED (1) /*!< Support BLUFI */
/*-------------------------- ULP CAPS ----------------------------------------*/ /*-------------------------- ULP CAPS ----------------------------------------*/
#define SOC_ULP_HAS_ADC (1) /* ADC can be accessed from ULP */ #define SOC_ULP_HAS_ADC (1) /* ADC can be accessed from ULP */

4
components/soc/esp32c2/include/soc/Kconfig.soc_caps.in
View File

@ -654,3 +654,7 @@ config SOC_BLE_50_SUPPORTED
config SOC_BLE_DEVICE_PRIVACY_SUPPORTED config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
bool bool
default y default y
config SOC_BLUFI_SUPPORTED
bool
default y

1
components/soc/esp32c2/include/soc/soc_caps.h
View File

@ -306,3 +306,4 @@
#define SOC_ESP_NIMBLE_CONTROLLER (1) /*!< Support BLE EMBEDDED controller V1 */ #define SOC_ESP_NIMBLE_CONTROLLER (1) /*!< Support BLE EMBEDDED controller V1 */
#define SOC_BLE_50_SUPPORTED (1) /*!< Support Bluetooth 5.0 */ #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_DEVICE_PRIVACY_SUPPORTED (1) /*!< Support BLE device privacy mode */
#define SOC_BLUFI_SUPPORTED (1) /*!< Support BLUFI */

4
components/soc/esp32c3/include/soc/Kconfig.soc_caps.in
View File

@ -970,3 +970,7 @@ config SOC_BLE_50_SUPPORTED
config SOC_BLE_DEVICE_PRIVACY_SUPPORTED config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
bool bool
default y default y
config SOC_BLUFI_SUPPORTED
bool
default y

1
components/soc/esp32c3/include/soc/soc_caps.h
View File

@ -420,3 +420,4 @@
#define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */ #define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */
#define SOC_BLE_50_SUPPORTED (1) /*!< Support Bluetooth 5.0 */ #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_DEVICE_PRIVACY_SUPPORTED (1) /*!< Support BLE device privacy mode */
#define SOC_BLUFI_SUPPORTED (1) /*!< Support BLUFI */

4
components/soc/esp32c6/include/soc/Kconfig.soc_caps.in
View File

@ -1222,3 +1222,7 @@ config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
config SOC_BLE_POWER_CONTROL_SUPPORTED config SOC_BLE_POWER_CONTROL_SUPPORTED
bool bool
default y default y
config SOC_BLUFI_SUPPORTED
bool
default y

1
components/soc/esp32c6/include/soc/soc_caps.h
View File

@ -500,3 +500,4 @@
#define SOC_BLE_50_SUPPORTED (1) /*!< Support Bluetooth 5.0 */ #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_DEVICE_PRIVACY_SUPPORTED (1) /*!< Support BLE device privacy mode */
#define SOC_BLE_POWER_CONTROL_SUPPORTED (1) /*!< Support Bluetooth Power Control */ #define SOC_BLE_POWER_CONTROL_SUPPORTED (1) /*!< Support Bluetooth Power Control */
#define SOC_BLUFI_SUPPORTED (1) /*!< Support BLUFI */

4
components/soc/esp32s3/include/soc/Kconfig.soc_caps.in
View File

@ -1251,6 +1251,10 @@ config SOC_BLE_DEVICE_PRIVACY_SUPPORTED
bool bool
default y default y
config SOC_BLUFI_SUPPORTED
bool
default y
config SOC_ULP_HAS_ADC config SOC_ULP_HAS_ADC
bool bool
default y default y

1
components/soc/esp32s3/include/soc/soc_caps.h
View File

@ -506,6 +506,7 @@
#define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */ #define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */
#define SOC_BLE_50_SUPPORTED (1) /*!< Support Bluetooth 5.0 */ #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_DEVICE_PRIVACY_SUPPORTED (1) /*!< Support BLE device privacy mode */
#define SOC_BLUFI_SUPPORTED (1) /*!< Support BLUFI */
/*-------------------------- ULP CAPS ----------------------------------------*/ /*-------------------------- ULP CAPS ----------------------------------------*/
#define SOC_ULP_HAS_ADC (1) /* ADC can be accessed from ULP */ #define SOC_ULP_HAS_ADC (1) /* ADC can be accessed from ULP */

8
docs/conf_common.py
View File

@ -19,8 +19,7 @@ from esp_docs.conf_docs import * # noqa: F403,F401
if os.environ.get('IDF_PATH') is None: if os.environ.get('IDF_PATH') is None:
raise RuntimeError('IDF_PATH should be set, run export.sh before building docs') raise RuntimeError('IDF_PATH should be set, run export.sh before building docs')
BT_DOCS = ['api-guides/blufi.rst', BT_DOCS = ['api-reference/bluetooth/bt_le.rst',
'api-reference/bluetooth/bt_le.rst',
'api-reference/bluetooth/esp_bt_defs.rst', 'api-reference/bluetooth/esp_bt_defs.rst',
'api-reference/bluetooth/esp_bt_device.rst', 'api-reference/bluetooth/esp_bt_device.rst',
'api-reference/bluetooth/esp_bt_main.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_gatt_defs.rst',
'api-reference/bluetooth/esp_gatts.rst', 'api-reference/bluetooth/esp_gatts.rst',
'api-reference/bluetooth/esp_gattc.rst', 'api-reference/bluetooth/esp_gattc.rst',
'api-reference/bluetooth/esp_blufi.rst',
'api-reference/bluetooth/index.rst', 'api-reference/bluetooth/index.rst',
'api-reference/bluetooth/nimble/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', 'api-reference/bluetooth/esp_gap_bt.rst',
'migration-guides/release-5.x/5.0/bluetooth-classic.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', WIFI_DOCS = ['api-guides/wifi.rst',
'api-guides/wifi-security.rst', 'api-guides/wifi-security.rst',
'api-guides/wireshark-user-guide.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, conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
'SOC_BLE_SUPPORTED':BLE_DOCS, 'SOC_BLE_SUPPORTED':BLE_DOCS,
'SOC_BLE_MESH_SUPPORTED':BLE_MESH_DOCS, 'SOC_BLE_MESH_SUPPORTED':BLE_MESH_DOCS,
'SOC_BLUFI_SUPPORTED':BLUFI_DOCS,
'SOC_WIFI_SUPPORTED':WIFI_DOCS, 'SOC_WIFI_SUPPORTED':WIFI_DOCS,
'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS, 'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS,
'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS, 'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS,

34
docs/docs_not_updated/esp32c6.txt
View File

@ -1,15 +1,8 @@
api-guides/blufi
api-guides/coexist api-guides/coexist
api-guides/usb-serial-jtag-console api-guides/usb-serial-jtag-console
api-guides/wifi api-guides/wifi
api-guides/esp-wifi-mesh api-guides/esp-wifi-mesh
api-guides/dfu 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/wifi-security
api-guides/openthread api-guides/openthread
api-reference/storage/vfs api-reference/storage/vfs
@ -41,33 +34,6 @@ api-reference/system/inc/show-efuse-table_ESP32-C6
api-reference/system/inc/power_management_esp32s2_and_later api-reference/system/inc/power_management_esp32s2_and_later
api-reference/system/inc/espefuse_summary_ESP32-C6 api-reference/system/inc/espefuse_summary_ESP32-C6
api-reference/system/ulp-risc-v 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_serial_slave_link
api-reference/protocols/esp_spi_slave_protocol api-reference/protocols/esp_spi_slave_protocol
api-reference/protocols/index api-reference/protocols/index

34
docs/docs_not_updated/esp32h2.txt
View File

@ -8,17 +8,11 @@ contribute/copyright-guide
contribute/install-pre-commit-hook contribute/install-pre-commit-hook
contribute/index contribute/index
api-guides/RF_calibration api-guides/RF_calibration
api-guides/blufi
api-guides/coexist api-guides/coexist
api-guides/wifi api-guides/wifi
api-guides/esp-wifi-mesh api-guides/esp-wifi-mesh
api-guides/cplusplus api-guides/cplusplus
api-guides/dfu 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/wifi-security
api-guides/index api-guides/index
api-guides/openthread api-guides/openthread
@ -68,32 +62,6 @@ api-reference/system/inc/espefuse_summary_ESP32-H2
api-reference/system/inc/revisions_ESP32-H2 api-reference/system/inc/revisions_ESP32-H2
api-reference/system/inc/show-efuse-table_ESP32-H2 api-reference/system/inc/show-efuse-table_ESP32-H2
api-reference/system/inc/power_management_esp32s2_and_later 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_serial_slave_link
api-reference/protocols/esp_sdio_slave_protocol api-reference/protocols/esp_sdio_slave_protocol
api-reference/protocols/esp_spi_slave_protocol api-reference/protocols/esp_spi_slave_protocol
@ -103,9 +71,7 @@ about
resources resources
migration-guides/release-5.x/5.1/index migration-guides/release-5.x/5.1/index
migration-guides/release-5.x/5.1/peripherals 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/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/removed-components
migration-guides/release-5.x/5.0/protocols migration-guides/release-5.x/5.0/protocols
migration-guides/release-5.x/5.0/networking migration-guides/release-5.x/5.0/networking

2
docs/en/api-guides/index.rst
View File

@ -7,7 +7,7 @@ API Guides
app_trace app_trace
startup startup
:SOC_BT_SUPPORTED: blufi :SOC_BLUFI_SUPPORTED: blufi
bootloader bootloader
build-system build-system
:SOC_SUPPORT_COEXISTENCE: coexist :SOC_SUPPORT_COEXISTENCE: coexist

2
docs/en/api-reference/bluetooth/bt_le.rst
View File

@ -8,4 +8,4 @@ BT LE
BLE GATT DEFINE <esp_gatt_defs> BLE GATT DEFINE <esp_gatt_defs>
BLE GATT SERVER <esp_gatts> BLE GATT SERVER <esp_gatts>
BLE GATT CLIENT <esp_gattc> BLE GATT CLIENT <esp_gattc>
BLE BLUFI <esp_blufi> :SOC_BLUFI_SUPPORTED: BLE BLUFI <esp_blufi>

2
docs/zh_CN/api-guides/index.rst
View File

@ -7,7 +7,7 @@ API 指南
app_trace app_trace
startup startup
:SOC_BT_SUPPORTED: blufi :SOC_BLUFI_SUPPORTED: blufi
bootloader bootloader
build-system build-system
:SOC_SUPPORT_COEXISTENCE: coexist :SOC_SUPPORT_COEXISTENCE: coexist