diff --git a/components/esp_common/.build-test-rules.yml b/components/esp_common/.build-test-rules.yml index 04fd48936f06..c52d810e1520 100644 --- a/components/esp_common/.build-test-rules.yml +++ b/components/esp_common/.build-test-rules.yml @@ -3,3 +3,4 @@ components/esp_common/test_apps/esp_common: disable: - if: CONFIG_NAME == "psram" and SOC_SPIRAM_SUPPORTED != 1 + - if: CONFIG_NAME == "psram_noinit" and SOC_SPIRAM_SUPPORTED != 1 diff --git a/components/esp_common/test_apps/esp_common/main/CMakeLists.txt b/components/esp_common/test_apps/esp_common/main/CMakeLists.txt index 44a5ed32a21a..d1e953e63823 100644 --- a/components/esp_common/test_apps/esp_common/main/CMakeLists.txt +++ b/components/esp_common/test_apps/esp_common/main/CMakeLists.txt @@ -1,4 +1,4 @@ idf_component_register(SRCS "test_app_main.c" "test_attr.c" INCLUDE_DIRS "." - PRIV_REQUIRES unity esp_psram + PRIV_REQUIRES unity esp_mm esp_psram WHOLE_ARCHIVE) diff --git a/components/esp_common/test_apps/esp_common/main/test_attr.c b/components/esp_common/test_apps/esp_common/main/test_attr.c index 6b1d7520a2b8..563e6079bb17 100644 --- a/components/esp_common/test_apps/esp_common/main/test_attr.c +++ b/components/esp_common/test_apps/esp_common/main/test_attr.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2017-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -10,10 +10,17 @@ #include "esp_log.h" #include "soc/soc.h" #include "esp_system.h" +#include "hal/cache_ll.h" +#include "hal/cache_hal.h" +#include "esp_cache.h" #if CONFIG_IDF_TARGET_ESP32 #include "esp_private/esp_psram_extram.h" #endif +#define ALIGN_UP(num, align) (((num) + ((align) - 1)) & ~((align) - 1)) + +static const char *TAG = "attr_test"; + extern int _rtc_noinit_start; extern int _rtc_noinit_end; extern int _rtc_data_start; @@ -45,6 +52,7 @@ static EXT_RAM_NOINIT_ATTR uint32_t s_noinit_ext; static bool data_in_segment(void *ptr, int *seg_start, int *seg_end) { + ESP_LOGV(TAG, "ptr:%p seg_start:%p seg_end:%p", ptr, seg_start, seg_end); return ((intptr_t)ptr < (intptr_t)seg_end) && \ ((intptr_t)ptr >= (intptr_t)seg_start); } @@ -95,7 +103,13 @@ static void write_spiram_and_reset(void) } printf("Flushing cache\n"); // Flush the cache out to SPIRAM before resetting. +#if CONFIG_IDF_TARGET_ESP32 esp_psram_extram_writeback_cache(); +#else + size_t psram_alignment = cache_hal_get_cache_line_size(CACHE_TYPE_DATA); + uint32_t ext_noinit_size = sizeof(s_noinit_buffer); + TEST_ESP_OK(esp_cache_msync(&s_noinit_buffer, ALIGN_UP(ext_noinit_size, psram_alignment), 0)); +#endif printf("Restarting\n"); // Reset to test that noinit memory is left intact. diff --git a/components/esp_common/test_apps/esp_common/pytest_esp_common.py b/components/esp_common/test_apps/esp_common/pytest_esp_common.py index 983220995f67..a22484686f12 100644 --- a/components/esp_common/test_apps/esp_common/pytest_esp_common.py +++ b/components/esp_common/test_apps/esp_common/pytest_esp_common.py @@ -1,5 +1,6 @@ -# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD +# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: CC0-1.0 +from typing import Any import pytest from pytest_embedded import Dut @@ -20,6 +21,8 @@ def test_esp_common(dut: Dut) -> None: # psram noinit attr tests with psram enabled @pytest.mark.esp32 +@pytest.mark.esp32s2 +@pytest.mark.esp32s3 @pytest.mark.generic @pytest.mark.parametrize( 'config', @@ -34,8 +37,9 @@ def test_esp_attr_psram_noinit(dut: Dut) -> None: # psram noinit memory tests with psram enabled @pytest.mark.esp32 +@pytest.mark.esp32s2 +@pytest.mark.esp32s3 @pytest.mark.generic -@pytest.mark.supported_targets @pytest.mark.parametrize( 'config', [ @@ -43,8 +47,8 @@ def test_esp_attr_psram_noinit(dut: Dut) -> None: ], indirect=True, ) -def run_multiple_stages(dut: Dut, test_case_num: int, stages: int) -> None: - dut.run_all_single_board_cases() +def test_esp_attr_psram_noinit_multiple_stages(case_tester: Any) -> None: + case_tester.run_all_multi_stage_cases() # psram attr tests with psram enabled diff --git a/components/esp_common/test_apps/esp_common/sdkconfig.ci.psram_noinit b/components/esp_common/test_apps/esp_common/sdkconfig.ci.psram_noinit index b3e109b8af4e..dbbc267982b3 100644 --- a/components/esp_common/test_apps/esp_common/sdkconfig.ci.psram_noinit +++ b/components/esp_common/test_apps/esp_common/sdkconfig.ci.psram_noinit @@ -1,6 +1,5 @@ # For EXT_RAM_NOINIT_ATTR -CONFIG_IDF_TARGET="esp32" CONFIG_SPIRAM=y CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY=y CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY=y diff --git a/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s2 b/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s2 index 0e7812b975e3..fd9b7e865c3c 100644 --- a/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s2 +++ b/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s2 @@ -3,5 +3,6 @@ CONFIG_IDF_TARGET="esp32s2" CONFIG_SPIRAM=y CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY=y +CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY=y CONFIG_SPIRAM_RODATA=y CONFIG_SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY=y diff --git a/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s3 b/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s3 index b774ddf1fd20..3b1db1f233fd 100644 --- a/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s3 +++ b/components/esp_common/test_apps/esp_common/sdkconfig.ci.xip_psram_esp32s3 @@ -3,5 +3,6 @@ CONFIG_IDF_TARGET="esp32s3" CONFIG_SPIRAM=y CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY=y +CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY=y CONFIG_SPIRAM_RODATA=y CONFIG_SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY=y diff --git a/components/esp_psram/Kconfig.spiram.common b/components/esp_psram/Kconfig.spiram.common index 9fb2a6bb9da6..65956e820d4b 100644 --- a/components/esp_psram/Kconfig.spiram.common +++ b/components/esp_psram/Kconfig.spiram.common @@ -110,7 +110,7 @@ config SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY config SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY bool "Allow .noinit segment placed in external memory" default n - depends on SPIRAM && IDF_TARGET_ESP32 + depends on SPIRAM help If enabled, noinit variables can be placed in PSRAM using EXT_RAM_NOINIT_ATTR. diff --git a/components/esp_system/ld/esp32s2/memory.ld.in b/components/esp_system/ld/esp32s2/memory.ld.in index 86ef48f6003f..e9d6819065f6 100644 --- a/components/esp_system/ld/esp32s2/memory.ld.in +++ b/components/esp_system/ld/esp32s2/memory.ld.in @@ -127,8 +127,7 @@ _data_seg_org = ORIGIN(rtc_data_seg); /* The lines below define location alias for .rtc.data section based on Kconfig option. When the option is not defined then use slow memory segment - else the data will be placed in fast memory segment - TODO: check whether the rtc_data_location is correct for esp32s2 - IDF-761 */ + else the data will be placed in fast memory segment */ #ifndef CONFIG_ESP32S2_RTCDATA_IN_FAST_MEM REGION_ALIAS("rtc_data_location", rtc_slow_seg ); #else diff --git a/components/esp_system/ld/esp32s2/sections.ld.in b/components/esp_system/ld/esp32s2/sections.ld.in index 681e686c8514..be8cb8636748 100644 --- a/components/esp_system/ld/esp32s2/sections.ld.in +++ b/components/esp_system/ld/esp32s2/sections.ld.in @@ -247,7 +247,7 @@ SECTIONS _noinit_end = ABSOLUTE(.); } > dram0_0_seg - /* external memory bss, from any global variable with EXT_RAM_BSS_ATTR attribute*/ + /* External Memory BSS. (Variables with EXT_RAM_BSS_ATTR attribute). */ .ext_ram.bss (NOLOAD) : { _ext_ram_bss_start = ABSOLUTE(.); @@ -258,6 +258,20 @@ SECTIONS _ext_ram_bss_end = ABSOLUTE(.); } > extern_ram_seg + /** + * This section holds data that won't be initialised when startup. + * This section locates in External RAM region. + */ + .ext_ram_noinit (NOLOAD) : + { + _ext_ram_noinit_start = ABSOLUTE(.); + + *(.ext_ram_noinit*) + + . = ALIGN(4); + _ext_ram_noinit_end = ABSOLUTE(.); + } > extern_ram_seg + /* Shared RAM */ .dram0.bss (NOLOAD) : { diff --git a/components/esp_system/ld/esp32s3/sections.ld.in b/components/esp_system/ld/esp32s3/sections.ld.in index 850305ee69cc..23780af5c464 100644 --- a/components/esp_system/ld/esp32s3/sections.ld.in +++ b/components/esp_system/ld/esp32s3/sections.ld.in @@ -421,6 +421,20 @@ SECTIONS _ext_ram_bss_end = ABSOLUTE(.); } > extern_ram_seg + /** + * This section holds data that won't be initialised when startup. + * This section locates in External RAM region. + */ + .ext_ram_noinit (NOLOAD) : + { + _ext_ram_noinit_start = ABSOLUTE(.); + + *(.ext_ram_noinit*) + + . = ALIGN(4); + _ext_ram_noinit_end = ABSOLUTE(.); + } > extern_ram_seg + /* Marks the end of IRAM code segment */ .iram0.text_end (NOLOAD) : { diff --git a/docs/en/api-guides/external-ram.rst b/docs/en/api-guides/external-ram.rst index 0d2d1dce223d..c3b0764963a3 100644 --- a/docs/en/api-guides/external-ram.rst +++ b/docs/en/api-guides/external-ram.rst @@ -115,16 +115,14 @@ This option reduces the internal static memory used by the BSS segment. Remaining external RAM can also be added to the capability heap allocator using the method shown above. -.. only:: esp32 - - .. _external_ram_config_noinit: +.. _external_ram_config_noinit: - Allow .noinit Segment to Be Placed in External Memory - -------------------------------------------------------------- +Allow .noinit Segment to Be Placed in External Memory +-------------------------------------------------------------- - Enable this option by checking :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY`. If enabled, a region of the address space provided in external RAM will be used to store non-initialized data. The values placed in this segment will not be initialized or modified even during startup or restart. +Enable this option by checking :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY`. If enabled, the region of the data virtual address space where the PSRAM is mapped to will be used to store non-initialized data. The values placed in this segment will not be initialized or modified even during startup or restart. - By applying the macro ``EXT_RAM_NOINIT_ATTR``, data could be moved from the internal NOINIT segment to external RAM. Remaining external RAM can still be added to the capability heap allocator using the method shown above, :ref:`external_ram_config_capability_allocator`. +By applying the macro ``EXT_RAM_NOINIT_ATTR``, data could be moved from the internal NOINIT segment to external RAM. Remaining external RAM can still be added to the capability heap allocator using the method shown above, :ref:`external_ram_config_capability_allocator`. .. only:: SOC_SPIRAM_XIP_SUPPORTED diff --git a/docs/zh_CN/api-guides/external-ram.rst b/docs/zh_CN/api-guides/external-ram.rst index 4b8fcb720d1c..5198cf43bec7 100644 --- a/docs/zh_CN/api-guides/external-ram.rst +++ b/docs/zh_CN/api-guides/external-ram.rst @@ -112,16 +112,14 @@ ESP-IDF 启动过程中,片外 RAM 被映射到以 {IDF_TARGET_PSRAM_ADDR_STAR 剩余的片外 RAM 也可以通过上述方法添加到堆分配器中。 -.. only:: esp32 - - .. _external_ram_config_noinit: +.. _external_ram_config_noinit: - 允许 .noinit 段放入片外存储器 - ------------------------------------- +允许 .noinit 段放入片外存储器 +------------------------------------- - 通过勾选 :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY` 启用该选项。启用该选项后,外部 RAM 中提供的地址空间区域将用于存储未初始化的数据。即使在启动或重新启动期间,放置在该段中的值也不会被初始化或修改。 +通过勾选 :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY` 启用该选项。启用该选项后,PSRAM 被映射到的数据虚拟地址空间将用于存储未初始化的数据。即使在启动或重新启动期间,放置在该段中的值也不会被初始化或修改。 - 通过应用 ``EXT_RAM_NOINIT_ATTR`` 宏,可以将数据从内部 NOINIT 段移到片外 RAM。剩余的片外 RAM 也可以通过上述方法添加到堆分配器中,具体请参考 :ref:`external_ram_config_capability_allocator`。 +通过应用 ``EXT_RAM_NOINIT_ATTR`` 宏,可以将数据从内部 NOINIT 段移到片外 RAM。剩余的片外 RAM 也可以通过上述方法添加到堆分配器中,具体请参考 :ref:`external_ram_config_capability_allocator`。 .. only:: SOC_SPIRAM_XIP_SUPPORTED