feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

docs(freertos): revert usage of hidden option CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE when :ref: is used

Browse Source
This commit is contained in:
Omar Chebib
2023-11-30 16:33:28 +08:00
parent d149c1b26f
commit dc8fdae31b
4 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-guides/memory-types.rst
View File

@@ -175,7 +175,7 @@ The ``DRAM_ATTR`` attribute can be used to force constants from DROM into the :r
.. only:: esp32
In single core mode (:ref:`CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE`), remaining RTC FAST memory is added to the heap, unless the option :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` is disabled. This memory can be used interchangeably with :ref:`DRAM`, but is slightly slower to access and not DMA-capable.
In single core mode (:ref:`CONFIG_FREERTOS_UNICORE`), remaining RTC FAST memory is added to the heap, unless the option :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` is disabled. This memory can be used interchangeably with :ref:`DRAM`, but is slightly slower to access and not DMA-capable.
This option is not available in dual core mode, because on {IDF_TARGET_NAME}, RTC FAST memory can only be accessed by the PRO CPU.

2
docs/en/api-reference/peripherals/spi_flash/index.rst
View File

@@ -251,7 +251,7 @@ Once the flash operation is complete, the function on CPU A sets another flag, `
Additionally, all API functions are protected with a mutex (``s_flash_op_mutex``).
In a single core environment (:ref:`CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE` enabled), you need to disable both caches, so that no inter-CPU communication can take place.
In a single core environment (:ref:`CONFIG_FREERTOS_UNICORE` enabled), you need to disable both caches, so that no inter-CPU communication can take place.
Related Documents
------------------

2
docs/zh_CN/api-guides/memory-types.rst
View File

@@ -175,7 +175,7 @@ DROM（数据存储在 flash 中）
.. only:: esp32
在单核模式下 (:ref:`CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE`)，除非禁用 :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` 选项，否则剩余的 RTC FAST memory 会被添加到堆中。该部分内存可以和 :ref:`DRAM` 互换使用，但是访问速度稍慢，且不具备 DMA 功能。
在单核模式下 (:ref:`CONFIG_FREERTOS_UNICORE`)，除非禁用 :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` 选项，否则剩余的 RTC FAST memory 会被添加到堆中。该部分内存可以和 :ref:`DRAM` 互换使用，但是访问速度稍慢，且不具备 DMA 功能。
:ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` 选项在双核模式下不可用，因为 {IDF_TARGET_NAME} 的 RTC FAST memory 只能由 PRO CPU 访问。

2
docs/zh_CN/api-reference/peripherals/spi_flash/index.rst
View File

@@ -251,7 +251,7 @@ flash 操作完成后，CPU A 上的函数将设置另一标志位，即 ``s_fla
另外，所有 API 函数均受互斥量 ``s_flash_op_mutex`` 保护。
在单核环境中（启用 :ref:`CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE`），需要禁用上述两个 cache，以防发生 CPU 间通信。
在单核环境中（启用 :ref:`CONFIG_FREERTOS_UNICORE`），需要禁用上述两个 cache，以防发生 CPU 间通信。
相关文档
-----------------