From f93199cb85e9a972f66d90f9f04c2e6535400f82 Mon Sep 17 00:00:00 2001 From: "C.S.M" Date: Fri, 18 Oct 2024 16:34:54 +0800 Subject: [PATCH] docs(spi_flash): Add migration guide for removing XMC-C suspend support --- components/spi_flash/Kconfig | 8 -------- docs/en/migration-guides/release-5.x/5.1/storage.rst | 5 +++++ docs/zh_CN/migration-guides/release-5.x/5.1/storage.rst | 5 +++++ 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/components/spi_flash/Kconfig b/components/spi_flash/Kconfig index 34a03b6216..29c274ee8c 100644 --- a/components/spi_flash/Kconfig +++ b/components/spi_flash/Kconfig @@ -101,14 +101,6 @@ menu "Main Flash configuration" Also refer to `Concurrency Constraints for Flash on SPI1` > `Flash Auto Suspend Feature` before enabling this option. - config SPI_FLASH_SUSPEND_TSUS_VAL_US - int "SPI flash tSUS value (refer to chapter AC CHARACTERISTICS)" - default 50 - range 20 100 - help - This config is used for setting Tsus parameter. Tsus means CS# high to next command after - suspend. You can refer to the chapter of AC CHARACTERISTICS of flash datasheet. - config SPI_FLASH_FORCE_ENABLE_XMC_C_SUSPEND bool "Enable XMC-C series flash chip suspend feature anyway" default n diff --git a/docs/en/migration-guides/release-5.x/5.1/storage.rst b/docs/en/migration-guides/release-5.x/5.1/storage.rst index efe8b075a5..94d1852139 100644 --- a/docs/en/migration-guides/release-5.x/5.1/storage.rst +++ b/docs/en/migration-guides/release-5.x/5.1/storage.rst @@ -15,3 +15,8 @@ SPI_FLASH - :cpp:func:`spi_flash_get_counters` is deprecated, please use :cpp:func:`esp_flash_get_counters` instead. - :cpp:func:`spi_flash_dump_counters` is deprecated, please use :cpp:func:`esp_flash_dump_counters` instead. - :cpp:func:`spi_flash_reset_counters` is deprecated, please use :cpp:func:`esp_flash_reset_counters` instead. + +SPI Flash Driver +^^^^^^^^^^^^^^^^ + +XMC-C series flash suspend support has been removed. According to feedback from the flash manufacturer, in some situations the XMC-C flash would require a 1ms interval between resume and next command. This is too long for a software request. Based on the above reason, in order to use suspend safely, we decide to remove flash suspend support from XMC-C series. But you can still force enable it via `CONFIG_SPI_FLASH_FORCE_ENABLE_XMC_C_SUSPEND`. If you have any questions, please contact espressif business support. \ No newline at end of file diff --git a/docs/zh_CN/migration-guides/release-5.x/5.1/storage.rst b/docs/zh_CN/migration-guides/release-5.x/5.1/storage.rst index 23bc0e9802..ed6d20a0b4 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.1/storage.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.1/storage.rst @@ -7,3 +7,8 @@ FatFs ----- ``esp_vfs_fat_sdmmc_unmount()`` 已被弃用。 您可以使用 :cpp:func:`esp_vfs_fat_sdcard_unmount()` 代替。 此接口在更早的 IDF 版本中已被弃用， 但是尚未添加弃用警告。 自 IDF v5.1 起， 调用这个 ``esp_vfs_fat_sdmmc_unmount()`` 接口将会产生 deprecation 警告。 + +SPI flash 驱动 +^^^^^^^^^^^^^^^^^^^^^^ + +XMC-C 系列闪存 suspend 功能的支持已被移除。根据闪存制造商的反馈，在某些情况下，XMC-C 闪存需要在 resume 和下一条命令之间间隔 1 毫秒。这对于软件请求来说时间太长。基于上述原因，为了安全使用 suspend 功能，我们决定取消对 XMC-C 系列闪存挂起的支持。但是你依旧可以通过打开 `CONFIG_SPI_FLASH_FORCE_ENABLE_XMC_C_SUSPEND` 来强行使能这个功能。如果您有任何疑问，请联系 espressif 商务支持。