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

[docs] Update API Reference of SPI Flash for AR2023-003

Browse Source
This commit is contained in:
Krzysztof 2023-08-22 11:35:46 +08:00
parent a63e067d64
commit 290ca75ae0
4 changed files with 25 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
components/spi_flash/Kconfig
View File

@ -158,15 +158,18 @@ menu "SPI Flash driver"
default n
depends on SPI_FLASH_SUSPEND_QVL_SUPPORTED && !SPI_FLASH_ROM_IMPL
help
This option is default n because it can't be used in every situation. You need to
evaluate this feature through suspend part in `SPI Flash API` document.
This option is disabled by default because it is supported only
for specific flash chips and for specific Espressif chips.
To evaluate if you can use this feature refer to
`Optional Features for Flash` > `Auto Suspend & Resume` of the `ESP-IDF Programming Guide`.
CAUTION: If you want to OTA to an app with this feature turned on, please make
sure the bootloader has the support for it. (later than IDF v4.3)
Auto-suspend feature only supported by specific flash chips.
If you are using an official module, please contact Espressif Business support.
Also reading auto suspend part in `SPI Flash API` document before you enable this function.
If you are using an official Espressif module, please contact Espressif Business support
to check if the module has the flash that support this feature installed.
Also refer to `Concurrency Constraints for Flash on SPI1` > `Flash Auto Suspend Feature`
before enabling this option.
config SPI_FLASH_WRITE_CHUNK_SIZE
int "Flash write chunk size"

15
docs/en/api-reference/peripherals/spi_flash/index.rst
View File

@ -250,19 +250,20 @@ Additionally, all API functions are protected with a mutex (``s_flash_op_mutex``
In a single core environment (:ref:`CONFIG_FREERTOS_UNICORE` enabled), you need to disable both caches, so that no inter-CPU communication can take place.
Related Documents
------------------
.. list::
- :doc:`spi_flash_optional_feature`
- :doc:`spi_flash_concurrency`
:CONFIG_ESP_ROM_HAS_SPI_FLASH: - :doc:`spi_flash_idf_vs_rom`
.. toctree::
:hidden:
spi_flash_idf_vs_rom
.. only:: CONFIG_ESP_ROM_HAS_SPI_FLASH
ESP-IDF vs Chip-ROM SPI Flash Driver
------------------------------------
Refer to :doc:`spi_flash_idf_vs_rom`.
API Reference - SPI Flash
-------------------------

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

@ -1,4 +1,4 @@
Optional features for flash
Optional Features for Flash
===========================
Some features are not supported on all ESP chips and Flash chips. You can check the list below for more information.

15
docs/zh_CN/api-reference/peripherals/spi_flash/index.rst
View File

@ -250,19 +250,20 @@ Flash 操作完成后，CPU A 上的函数将设置另一标志位，即 ``s_fla
在单核环境中（启用 :ref:`CONFIG_FREERTOS_UNICORE`），您需要禁用上述两个 cache 以防发生 CPU 间通信。
相关文档
-----------------
.. list::
- :doc:`spi_flash_optional_feature`
- :doc:`spi_flash_concurrency`
:CONFIG_ESP_ROM_HAS_SPI_FLASH: - :doc:`spi_flash_idf_vs_rom`
.. toctree::
:hidden:
spi_flash_idf_vs_rom
.. only:: CONFIG_ESP_ROM_HAS_SPI_FLASH
ESP-IDF 和 Chip-ROM 版本 SPI Flash 驱动对比
-----------------------------------------------------------------
请参考 :doc:`spi_flash_idf_vs_rom`.
SPI Flash API 参考
-------------------------