From c79d1afb24f378fb2fb34c825c44a67847428c68 Mon Sep 17 00:00:00 2001 From: Euripedes Rocha Date: Mon, 31 Jul 2023 14:48:59 +0200 Subject: [PATCH 1/2] 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 From 303585638162284a86e170c691d2c6efbfc9f548 Mon Sep 17 00:00:00 2001 From: mofeifei Date: Fri, 18 Aug 2023 17:16:45 +0800 Subject: [PATCH 2/2] docs: update cn trans for memory-types --- docs/en/api-guides/memory-types.rst | 6 +++--- docs/zh_CN/api-guides/memory-types.rst | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/en/api-guides/memory-types.rst b/docs/en/api-guides/memory-types.rst index 3a0d8e0121..9ea167aa15 100644 --- a/docs/en/api-guides/memory-types.rst +++ b/docs/en/api-guides/memory-types.rst @@ -175,16 +175,16 @@ The ``DRAM_ATTR`` attribute can be used to force constants from DROM into the :r .. only:: esp32 - 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 (: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 ESP32, RTC FAST memory can only be accessed by the PRO CPU. + 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. .. only:: not esp32 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. -DMA Capable Requirement +DMA-Capable Requirement ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. highlight:: c diff --git a/docs/zh_CN/api-guides/memory-types.rst b/docs/zh_CN/api-guides/memory-types.rst index f900a6e679..040712690a 100644 --- a/docs/zh_CN/api-guides/memory-types.rst +++ b/docs/zh_CN/api-guides/memory-types.rst @@ -175,9 +175,9 @@ DROM（数据存储在 flash 中） .. only:: esp32 - RTC FAST memory 只可以被 PRO CPU 访问。 + 在单核模式下 (: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` 选项，否则剩余的 RTC FAST memory 会被添加到堆中。该部分内存可以和 :ref:`DRAM` 互换使用，但是访问速度稍慢，且不具备 DMA 功能。 + :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` 选项在双核模式下不可用，因为 {IDF_TARGET_NAME} 的 RTC FAST memory 只能由 PRO CPU 访问。 .. only:: not esp32