Skip to content

Commit bfe5caf

Browse files
committed
Merge branch 'doc/update_32b_addr_limit_in_flash_doc' into 'master'
flash: updated 32bit addr support related doc See merge request espressif/esp-idf!40290
2 parents b9c2242 + bd55fc8 commit bfe5caf

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

docs/en/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,17 +164,21 @@ Restrictions
164164

165165
.. important::
166166

167-
Over 16 MB space on flash mentioned above can be only used for ``data saving``, like file system.
167+
The part of flash above 16 MB can be used for data storage, for example using a file system.
168168

169169
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.
170170

171171
.. only:: SOC_SPI_MEM_SUPPORT_CACHE_32BIT_ADDR_MAP
172172

173-
By default, space over 16 MB on flash mentioned above can be used for ``data saving``, like file system.
173+
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.
174174

175-
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``.
175+
*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``:
176+
- :ref:`CONFIG_IDF_EXPERIMENTAL_FEATURES`
177+
- :ref:`CONFIG_BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH`
176178

177-
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 <https://www.espressif.com/en/contact-us/sales-questions>`_.
179+
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 <https://www.espressif.com/en/contact-us/sales-questions>`_.
180+
181+
For Octal flash chips, this feature is enabled by default if :ref:`CONFIG_ESPTOOLPY_OCT_FLASH` is enabled.
178182

179183
.. _oct-flash-doc:
180184

docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,17 +164,21 @@ QSPI flash 芯片的 32 位地址支持
164164

165165
.. important::
166166

167-
上述超过 16 MB 内存的 flash 区域只能用于 ``数据保存``,如文件系统
167+
上述超过 16 MB 内存的 flash 区域可用于数据存储,例如使用文件系统
168168

169169
将数据或指令映射到 32 位物理地址空间(以便由 CPU 访问)需要 MMU 的支持。但 {IDF_TARGET_NAME} 并不支持此功能。目前只有 ESP32-S3 和 ESP32-P4 支持此功能。
170170

171171
.. only:: SOC_SPI_MEM_SUPPORT_CACHE_32BIT_ADDR_MAP
172172

173-
默认情况下,上述超过 16 MB 内存的 flash 区域可用于 ``数据保存``,如文件系统
173+
默认情况下,上述超过 16 MB 内存的 flash 区域可用于数据存储,例如使用文件系统
174174

175-
此外,要将数据或指令映射到 32 位物理地址空间(以便由 CPU 访问),请启用配置 ``IDF_EXPERIMENTAL_FEATURES`` 和 ``BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH``。
175+
*实验性功能*:如需在超过 16 MB 的四线 flash 区域实现完整支持(包括代码执行和数据访问),请启用以下实验性配置选项:
176+
- :ref:`CONFIG_IDF_EXPERIMENTAL_FEATURES`
177+
- :ref:`CONFIG_BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH`
176178

177-
请注意,此选项为实验性选项,无法在所有 flash 芯片上稳定使用,详情请咨询 `乐鑫商务部 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`_。
179+
请注意,此选项为实验性功能,无法在所有四线 flash 芯片上稳定使用。详情请咨询 `乐鑫商务部 <https://www.espressif.com/zh-hans/contact-us/sales-questions>`_。
180+
181+
对于八线 flash 芯片,如果启用了 :ref:`CONFIG_ESPTOOLPY_OCT_FLASH`,则该功能默认启用。
178182

179183
.. _oct-flash-doc:
180184

0 commit comments

Comments
 (0)