From c79d1afb24f378fb2fb34c825c44a67847428c68 Mon Sep 17 00:00:00 2001 From: Euripedes Rocha Date: Mon, 31 Jul 2023 14:48:59 +0200 Subject: [PATCH] docs: Makes the description for RTC fast as heap explicit Makes it explicit that to use rtc memory fast as heap, ESP32 needs to be configured in single core mode. --- docs/en/api-guides/memory-types.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/memory-types.rst b/docs/en/api-guides/memory-types.rst index d7c94fc6b4..3a0d8e0121 100644 --- a/docs/en/api-guides/memory-types.rst +++ b/docs/en/api-guides/memory-types.rst @@ -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