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

docs: Updated api_guides/performance chapters for esp32c6 and esp32h2

This commit updates the api_guides/performance chapters for esp32c6 and
esp32h2.
Sudeep Mohanty 2 лет назад
Родитель
Сommit
372d2310c9

+ 0 - 5
docs/docs_not_updated/esp32c6.txt

@@ -1,8 +1,3 @@
-api-guides/performance
-api-guides/performance/speed
-api-guides/performance/size
-api-guides/performance/ram-usage
-api-guides/performance/index
 api-guides/blufi
 api-guides/coexist
 api-guides/usb-serial-jtag-console

+ 0 - 4
docs/docs_not_updated/esp32h2.txt

@@ -7,10 +7,6 @@ contribute/style-guide
 contribute/copyright-guide
 contribute/install-pre-commit-hook
 contribute/index
-api-guides/performance/speed
-api-guides/performance/size
-api-guides/performance/ram-usage
-api-guides/performance/index
 api-guides/RF_calibration
 api-guides/blufi
 api-guides/coexist

+ 1 - 1
docs/en/api-guides/performance/ram-usage.rst

@@ -1,7 +1,7 @@
 Minimizing RAM Usage
 ====================
 
-{IDF_TARGET_STATIC_MEANS_HEAP:default="Wi-Fi library, Bluetooth controller", esp32s2="Wi-Fi library"}
+{IDF_TARGET_STATIC_MEANS_HEAP:default="Wi-Fi library, Bluetooth controller", esp32s2="Wi-Fi library", esp32c6="Wi-Fi library, Bluetooth controller, IEEE 802.15.4 library", esp32h2="Bluetooth controller, IEEE 802.15.4 library"}
 
 In some cases, a firmware application's available RAM may run low or run out entirely. In these cases, it's necessary to tune the memory usage of the firmware application.
 

+ 6 - 4
docs/en/api-guides/performance/size.rst

@@ -316,11 +316,13 @@ Targeted Optimizations
 
 The following binary size optimizations apply to a particular component or a function:
 
-Wi-Fi
-@@@@@
+.. only:: SOC_WIFI_SUPPORTED
 
-- Disabling :ref:`CONFIG_ESP_WIFI_ENABLE_WPA3_SAE` will save some Wi-Fi binary size if WPA3 support is not needed. (Note that WPA3 is mandatory for new Wi-Fi device certifications.)
-- Disabling :ref:`CONFIG_ESP_WIFI_SOFTAP_SUPPORT` will save some Wi-Fi binary size if soft-AP support is not needed.
+    Wi-Fi
+    @@@@@
+
+    - Disabling :ref:`CONFIG_ESP_WIFI_ENABLE_WPA3_SAE` will save some Wi-Fi binary size if WPA3 support is not needed. (Note that WPA3 is mandatory for new Wi-Fi device certifications.)
+    - Disabling :ref:`CONFIG_ESP_WIFI_SOFTAP_SUPPORT` will save some Wi-Fi binary size if soft-AP support is not needed.
 
 .. only:: esp32
 

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

@@ -2,7 +2,7 @@ Maximizing Execution Speed
 ==========================
 
 {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"}
+{IDF_TARGET_RF_TYPE:default="Wi-Fi/BT", esp32s2="Wi-Fi", esp32c6="Wi-Fi/BT/802.15.4", esp32h2="BT/802.15.4"}
 
 Overview
 --------
@@ -56,7 +56,7 @@ Executing the target multiple times can help average out factors like RTOS conte
 
       The CPU cycles are counted per-core, so only use this method from an interrupt handler, or a task that is pinned to a single core.
 
-- If making "microbenchmarks" (i.e. benchmarking only a very small routine of code that runs in less than 1-2 milliseconds) then flash cache performance can sometimes cause big variations in timing measurements depending on the binary. This happens because binary layout can cause different patterns of cache misses in a particular sequence of execution. If the test code is larger then this effect usually averages out. Executing a small function multiple times when benchmarking can help reduce the impact of flash cache misses. Alternatively, move this code to IRAM (see :ref:`speed-targeted-optimizations`).
+- While performing "microbenchmarks" (i.e. benchmarking only a very small routine of code that runs in less than 1-2 milliseconds), the flash cache performance can sometimes cause big variations in timing measurements depending on the binary. This happens because binary layout can cause different patterns of cache misses in a particular sequence of execution. If the test code is larger then this effect usually averages out. Executing a small function multiple times when benchmarking can help reduce the impact of flash cache misses. Alternatively, move this code to IRAM (see :ref:`speed-targeted-optimizations`).
 
 External Tracing
 ^^^^^^^^^^^^^^^^
@@ -149,7 +149,7 @@ ESP-IDF starts a number of system tasks at fixed priority levels. Some are autom
 
 This may require splitting up a particular task. For example, perform a time-critical operation in a high priority task or an interrupt handler and do the non-time-critical part in a lower priority task.
 
-Header :idf_file:`components/esp_system/include/esp_task.h` contains macros for the priority levels used for built-in ESP-IDF tasks system.
+Header :idf_file:`components/esp_system/include/esp_task.h` contains macros for the priority levels used for built-in ESP-IDF tasks system. See :ref:`freertos_system_tasks` for more details about the system tasks.
 
 Common priorities are:
 

+ 2 - 0
docs/en/api-reference/system/freertos.rst

@@ -68,6 +68,8 @@ Unlike Vanilla FreeRTOS, users of FreeRTOS in ESP-IDF **must never call** :cpp:f
 - The ``app_main`` function is allowed to return at any point (i.e., before the application terminates).
 - The ``app_main`` function is called from the ``main`` task.
 
+.. _freertos_system_tasks:
+
 Background Tasks
 ^^^^^^^^^^^^^^^^