alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'feature/add_flash_suspend_to_idf_vs_rom_doc' into 'master'

Browse Source 
spi_flash: added auto suspend feature in idf vs rom doc

See merge request espressif/esp-idf!24416
This commit is contained in:
Armando (Dou Yiwen) 2023-06-27 14:43:07 +08:00
commit bbc43393e5
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en/api-reference/peripherals/spi_flash/spi_flash_idf_vs_rom.rst
View File

@ -13,7 +13,7 @@ Feature Supported by ESP-IDF but not in Chip-ROM
.. list::
- Octal Flash chip support. See :ref:`oct-flash-doc` for details.
- 32-bit-address support for GD25Q256. See :ref:`32-bit-flash-doc` for details.
- 32-bit-address support for GD25Q256. Note this feature is an optional feature, please do read :ref:`32-bit-flash-doc` for details.
- TH Flash chip support.
- Kconfig option :ref:`CONFIG_SPI_FLASH_CHECK_ERASE_TIMEOUT_DISABLED`.
- :ref:`CONFIG_SPI_FLASH_VERIFY_WRITE`, enabling this option helps you detect bad writing.
@ -21,6 +21,7 @@ Feature Supported by ESP-IDF but not in Chip-ROM
- :ref:`CONFIG_SPI_FLASH_WARN_SETTING_ZERO_TO_ONE`, enabling this option will check if you're writing zero to one.
- :ref:`CONFIG_SPI_FLASH_DANGEROUS_WRITE`, enabling this option will check for flash programming to certain protected regions like bootloader, partition table or application itself.
- :ref:`CONFIG_SPI_FLASH_ENABLE_COUNTERS`, enabling this option to collect performance data for ESP-IDF SPI Flash driver APIs.
- :ref:`CONFIG_SPI_FLASH_AUTO_SUSPEND`, enabling this option to automatically suspend / resume a long Flash operation when short Flash operation happens. Note this feature is an optional feature, please do read :ref:`auto-suspend-intro` for more limitations.
Bugfixes Introduced in ESP-IDF but not in Chip-ROM
--------------------------------------------------

4
docs/en/api-reference/peripherals/spi_flash/spi_flash_optional_feature.rst
View File

@ -25,6 +25,8 @@ Some features are not supported on all ESP chips and Flash chips. You can check
This document only shows that IDF code has supported the features of those flash chips. It's not a list of stable flash chips certified by Espressif. If you build your own hardware from flash chips with your own brought flash chips (even with flash listed in this page), you need to validate the reliability of flash chips yourself.
.. _auto-suspend-intro:
Auto Suspend & Resume
---------------------
@ -137,4 +139,4 @@ Flash Chips List:
1. This option only valid for 4-line flash. Octal flash doesn't need this.
2. Only MMU on ESP chip that supports mapping to a range over 16MB memory supports this config. (Only ESP32S3 supports this up to now)
3. This option is experimental, which means it can't use on all flash chips stable, for more information, please contact Espressif Business support.
3. This option is experimental, which means it can't use on all flash chips stable, for more information, please contact Espressif Business support.