From 89b9c480cc9544ff0b73dbc45bb8fadb96ca9161 Mon Sep 17 00:00:00 2001 From: "C.S.M" Date: Wed, 16 Oct 2024 16:06:58 +0800 Subject: [PATCH] docs(spi_flash): Add migration guide for removing XMC-C suspend support --- docs/en/migration-guides/release-5.x/5.4/index.rst | 1 + docs/en/migration-guides/release-5.x/5.4/storage.rst | 7 +++++++ docs/zh_CN/migration-guides/release-5.x/5.4/index.rst | 1 + docs/zh_CN/migration-guides/release-5.x/5.4/storage.rst | 7 +++++++ 4 files changed, 16 insertions(+) create mode 100644 docs/en/migration-guides/release-5.x/5.4/storage.rst create mode 100644 docs/zh_CN/migration-guides/release-5.x/5.4/storage.rst diff --git a/docs/en/migration-guides/release-5.x/5.4/index.rst b/docs/en/migration-guides/release-5.x/5.4/index.rst index cab9e7ac4e..08ce135e44 100644 --- a/docs/en/migration-guides/release-5.x/5.4/index.rst +++ b/docs/en/migration-guides/release-5.x/5.4/index.rst @@ -9,3 +9,4 @@ Migration from 5.3 to 5.4 gcc system bluetooth-classic + storage diff --git a/docs/en/migration-guides/release-5.x/5.4/storage.rst b/docs/en/migration-guides/release-5.x/5.4/storage.rst new file mode 100644 index 0000000000..41360c019e --- /dev/null +++ b/docs/en/migration-guides/release-5.x/5.4/storage.rst @@ -0,0 +1,7 @@ +Storage +======= + +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. diff --git a/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst index 156a9900b6..5d15a086f3 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.4/index.rst @@ -9,3 +9,4 @@ gcc system bluetooth-classic + storage diff --git a/docs/zh_CN/migration-guides/release-5.x/5.4/storage.rst b/docs/zh_CN/migration-guides/release-5.x/5.4/storage.rst new file mode 100644 index 0000000000..edb535412a --- /dev/null +++ b/docs/zh_CN/migration-guides/release-5.x/5.4/storage.rst @@ -0,0 +1,7 @@ +存储 +======= + +SPI flash 驱动 +^^^^^^^^^^^^^^^^^^^^^^ + +XMC-C 系列闪存 suspend 功能的支持已被移除。根据闪存制造商的反馈，在某些情况下，XMC-C 闪存需要在 resume 和下一条命令之间间隔 1 毫秒。这对于软件请求来说时间太长。基于上述原因，为了安全使用 suspend 功能，我们决定取消 XMC-C 系列的闪存挂起支持。但是你依旧可以强行通过 `CONFIG_SPI_FLASH_FORCE_ENABLE_XMC_C_SUSPEND` 的配置使能这个功能。如果您有任何疑问，请联系 espressif 业务支持。