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

docs: Makes the description for RTC fast as heap explicit

Browse Source 
Makes it explicit that to use rtc memory fast as heap,
ESP32 needs to be configured in single core mode.
This commit is contained in:
Euripedes Rocha 2023-07-31 14:48:59 +02:00
parent 02f5b9a898
commit c79d1afb24
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -175,9 +175,9 @@ The ``DRAM_ATTR`` attribute can be used to force constants from DROM into the :r
.. only:: esp32
RTC FAST memory can only be accessed by the PRO CPU.
In single core mode (:ref:`CONFIG_FREERTOS_UNICORE`), remaining RTC FAST memory is be 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, 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 ESP32, RTC FAST memory can only be accessed by the PRO CPU.
.. only:: not esp32