blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-31 03:41:07 -04:00
Code Issues Projects Releases Wiki Activity

Merge branch 'docs/add_rf_calib_docs_v4.2' into 'release/v4.2'

Browse Source 
docs: add RF calibration docs for ESP32-S2(v4.2)

See merge request espressif/esp-idf!13723
This commit is contained in:
Jiang Jiang Jian 2021-05-27 08:06:12 +00:00
commit e8e6021ada
4 changed files with 3 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/conf_common.py
View File

@ -153,7 +153,6 @@ LEGACY_DOCS = ['api-guides/build-system-legacy.rst',
ESP32_DOCS = ['api-guides/ulp_instruction_set.rst', ESP32_DOCS = ['api-guides/ulp_instruction_set.rst',
'api-reference/system/himem.rst', 'api-reference/system/himem.rst',
'api-guides/RF_calibration.rst',
'api-reference/system/ipc.rst', 'api-reference/system/ipc.rst',
'security/secure-boot-v1.rst', 'security/secure-boot-v1.rst',
'api-reference/peripherals/secure_element.rst', 'api-reference/peripherals/secure_element.rst',

8
docs/en/api-guides/RF_calibration.rst
View File

@ -48,13 +48,7 @@ PHY initialization data
The PHY initialization data is used for RF calibration. The PHY initialization data is used for RF calibration.
There are two ways to get the PHY initialization data. There are two ways to get the PHY initialization data.
.. only:: esp32 One is the default initialization data which is located in the header file :idf_file:`components/esp_wifi/esp32/include/phy_init_data.h`.
One is the default initialization data which is located in the header file :idf_file:`components/esp_wifi/esp32/include/phy_init_data.h`.
.. only:: esp32s2
One is the default initialization data which is located in the header file :idf_file:`components/esp_wifi/esp32s2/include/phy_init_data.h`.
It is embedded into the application binary after compiling and then stored into read-only memory (DROM). It is embedded into the application binary after compiling and then stored into read-only memory (DROM).
To use the default initialization data, please go to ``menuconfig`` and disable :ref:`CONFIG_ESP32_PHY_INIT_DATA_IN_PARTITION`. To use the default initialization data, please go to ``menuconfig`` and disable :ref:`CONFIG_ESP32_PHY_INIT_DATA_IN_PARTITION`.

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

@ -27,7 +27,7 @@ API Guides
Linker Script Generation <linker-script-generation> Linker Script Generation <linker-script-generation>
lwIP TCP/IP Stack <lwip> lwIP TCP/IP Stack <lwip>
Partition Tables <partition-tables> Partition Tables <partition-tables>
:esp32: RF Calibration <RF_calibration> RF Calibration <RF_calibration>
ROM debug console <romconsole> ROM debug console <romconsole>
:esp32: Secure Boot <../security/secure-boot-v1> :esp32: Secure Boot <../security/secure-boot-v1>
Secure Boot V2 <../security/secure-boot-v2> Secure Boot V2 <../security/secure-boot-v2>

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

@ -29,7 +29,7 @@ API 指南
:esp32: 单元测试 (传统 GNU Make) <unit-tests-legacy> :esp32: 单元测试 (传统 GNU Make) <unit-tests-legacy>
应用层跟踪 <app_trace> 应用层跟踪 <app_trace>
ROM debug console <romconsole> ROM debug console <romconsole>
:esp32: RF Calibration <RF_calibration> RF Calibration <RF_calibration>
WiFi Driver <wifi> WiFi Driver <wifi>
:SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index> :SOC_BT_SUPPORTED: ESP-BLE-MESH <esp-ble-mesh/ble-mesh-index>
ESP-MESH (Wi-Fi) <mesh> ESP-MESH (Wi-Fi) <mesh>