From 42123b3115e5ec510978cc70bc50b76bffcde3d9 Mon Sep 17 00:00:00 2001 From: armando Date: Wed, 2 Jul 2025 10:20:00 +0800 Subject: [PATCH] doc(flash): updated 32bit addr support doc --- .../spi_flash/spi_flash_optional_feature.rst | 14 ++++++++++---- .../spi_flash/spi_flash_optional_feature.rst | 14 ++++++++++---- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/en/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst b/docs/en/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst index 8b99de0c0a..b455d241e2 100644 --- a/docs/en/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst +++ b/docs/en/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst @@ -163,17 +163,23 @@ Restrictions .. important:: - Over 16 MB space on flash mentioned above can be only used for ``data saving``, like file system. + The part of flash above 16 MB can be used for data storage, for example using a file system. Mapping data/instructions to 32-bit physical address space (so as to be accessed by the CPU) needs the support of MMU. However {IDF_TARGET_NAME} doesn't support this feature. Only ESP32-S3 and ESP32-P4 supports this up to now. .. only:: SOC_SPI_MEM_SUPPORT_CACHE_32BIT_ADDR_MAP - By default, space over 16 MB on flash mentioned above can be used for ``data saving``, like file system. + For Quad flash chips, by default, the part of flash above 16 MB can be used for data storage, for example using a file system. - Furthermore, to map data/instructions to 32-bit physical address space (so as to be accessed by the CPU), please enable the config ``IDF_EXPERIMENTAL_FEATURES`` and ``BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH``. + *Experimental Feature*: To enable full support for Quad flash addresses above 16MB (for both code execution and data access), enable this experimental feature by setting below options to ``y``: + - :ref:`CONFIG_IDF_EXPERIMENTAL_FEATURES` + - :ref:`CONFIG_BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH` - Please note that, this option is experimental, which means that it can not be used on all flash chips stably. For more information, please contact `Espressif's business team `_. + Please note that, this option is experimental, which means that it can not be used on all Quad flash chips stably. For more information, please contact `Espressif's business team `_. + + .. only:: SOC_SPI_MEM_SUPPORT_OPI_MODE + + For Octal flash chips, this feature is enabled by default if :ref:`CONFIG_ESPTOOLPY_OCT_FLASH` is enabled. .. _oct-flash-doc: diff --git a/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst b/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst index 4123c8ea88..dab23edc7f 100644 --- a/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst +++ b/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst @@ -163,17 +163,23 @@ QSPI flash 芯片的 32 位地址支持 .. important:: - 上述超过 16 MB 内存的 flash 区域只能用于 ``数据保存``，如文件系统。 + 上述超过 16 MB 内存的 flash 区域可用于数据存储，例如使用文件系统。 将数据或指令映射到 32 位物理地址空间（以便由 CPU 访问）需要 MMU 的支持。但 {IDF_TARGET_NAME} 并不支持此功能。目前只有 ESP32-S3 和 ESP32-P4 支持此功能。 .. only:: SOC_SPI_MEM_SUPPORT_CACHE_32BIT_ADDR_MAP - 默认情况下，上述超过 16 MB 内存的 flash 区域可用于 ``数据保存``，如文件系统。 + 默认情况下，上述超过 16 MB 内存的 flash 区域可用于数据存储，例如使用文件系统。 - 此外，要将数据或指令映射到 32 位物理地址空间（以便由 CPU 访问），请启用配置 ``IDF_EXPERIMENTAL_FEATURES`` 和 ``BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH``。 + *实验性功能*：如需在超过 16 MB 的四线 flash 区域实现完整支持（包括代码执行和数据访问），请启用以下实验性配置选项： + - :ref:`CONFIG_IDF_EXPERIMENTAL_FEATURES` + - :ref:`CONFIG_BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH` - 请注意，此选项为实验性选项，无法在所有 flash 芯片上稳定使用，详情请咨询 `乐鑫商务部 `_。 + 请注意，此选项为实验性功能，无法在所有四线 flash 芯片上稳定使用。详情请咨询 `乐鑫商务部 `_。 + + .. only:: SOC_SPI_MEM_SUPPORT_OPI_MODE + + 对于八线 flash 芯片，如果启用了 :ref:`CONFIG_ESPTOOLPY_OCT_FLASH`，则该功能默认启用。 .. _oct-flash-doc: