From 036cd854b9cb292947a8196c8bb69227bc0ef6b4 Mon Sep 17 00:00:00 2001 From: Chen Jichang Date: Fri, 6 Sep 2024 14:13:03 +0800 Subject: [PATCH] docs(psram): sync psram noinit description --- docs/en/api-guides/external-ram.rst | 2 +- docs/en/api-guides/memory-types.rst | 2 +- docs/zh_CN/api-guides/external-ram.rst | 2 +- docs/zh_CN/api-guides/memory-types.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/api-guides/external-ram.rst b/docs/en/api-guides/external-ram.rst index c3b0764963..881ddcae6c 100644 --- a/docs/en/api-guides/external-ram.rst +++ b/docs/en/api-guides/external-ram.rst @@ -45,7 +45,7 @@ ESP-IDF fully supports the use of external RAM in applications. Once the externa * :ref:`external_ram_config_capability_allocator` * :ref:`external_ram_config_malloc` (default) * :ref:`external_ram_config_bss` - :esp32: * :ref:`external_ram_config_noinit` + * :ref:`external_ram_config_noinit` :esp32s2 or esp32s3: * :ref:`external_ram_config_instructions` :esp32s2 or esp32s3: * :ref:`external_ram_config_rodata` diff --git a/docs/en/api-guides/memory-types.rst b/docs/en/api-guides/memory-types.rst index 0ec3cedffb..6ef4590f21 100644 --- a/docs/en/api-guides/memory-types.rst +++ b/docs/en/api-guides/memory-types.rst @@ -42,7 +42,7 @@ Constant data may also be placed into DRAM, for example if it is used in an non- The macro ``__NOINIT_ATTR`` can be used as attribute to place data into ``.noinit`` section. The values placed into this section will not be initialized at startup and should keep its value after software restart. -.. only:: esp32 +.. only:: SOC_SPIRAM_SUPPORTED By applying the ``EXT_RAM_NOINIT_ATTR`` macro, non-initialized value could also be placed in external RAM. To do this, the :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY` needs to be enabled. See :ref:`external_ram_config_noinit`. If the :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY` is not enabled, ``EXT_RAM_NOINIT_ATTR`` will behave just as ``__NOINIT_ATTR``, it will make data to be placed into ``.noinit`` segment in internal RAM. diff --git a/docs/zh_CN/api-guides/external-ram.rst b/docs/zh_CN/api-guides/external-ram.rst index 5198cf43be..0f91a09dab 100644 --- a/docs/zh_CN/api-guides/external-ram.rst +++ b/docs/zh_CN/api-guides/external-ram.rst @@ -42,7 +42,7 @@ ESP-IDF 完全支持将片外 RAM 集成到您的应用程序中。在启动并 * :ref:`external_ram_config_capability_allocator` * :ref:`external_ram_config_malloc` (default) * :ref:`external_ram_config_bss` - :esp32: * :ref:`external_ram_config_noinit` + * :ref:`external_ram_config_noinit` :esp32s2 or esp32s3: * :ref:`external_ram_config_instructions` :esp32s2 or esp32s3: * :ref:`external_ram_config_rodata` diff --git a/docs/zh_CN/api-guides/memory-types.rst b/docs/zh_CN/api-guides/memory-types.rst index ef14290f94..b4e038f1f0 100644 --- a/docs/zh_CN/api-guides/memory-types.rst +++ b/docs/zh_CN/api-guides/memory-types.rst @@ -42,7 +42,7 @@ DRAM（数据 RAM） 可以将 ``__NOINIT_ATTR`` 宏用作属性，从而将数据放入 ``.noinit`` 部分。放入该部分的值在启动时不会被初始化，在软件重启后也会保持值不变。 -.. only:: esp32 +.. only:: SOC_SPIRAM_SUPPORTED 通过使用 ``EXT_RAM_NOINIT_ATTR`` 宏，noinit 数据也可以放入外部 RAM 中。为此，需要启用 :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY`，可参考 :ref:`external_ram_config_noinit`。如果没有启用 :ref:`CONFIG_SPIRAM_ALLOW_NOINIT_SEG_EXTERNAL_MEMORY`， ``EXT_RAM_NOINIT_ATTR`` 会和 ``__NOINIT_ATTR`` 一样，将数据放入内部 RAM 的 ``.noinit`` 部分。