docs(spi_flash): Add migration guide for removing XMC-C suspend support

This commit is contained in:
C.S.M
2024-10-18 16:12:14 +08:00
parent 922777118b
commit 5239bd2879
2 changed files with 11 additions and 0 deletions

View File

@@ -16,3 +16,8 @@ APIs with `esp_vfs_dev_uart_` prefix are all deprecated, replaced with new APIs
- ``esp_vfs_dev_uart_use_driver`` has been renamed to ``uart_vfs_dev_use_driver``
For compatibility, `vfs` component still registers `esp_driver_uart` as its private dependency. In other words, you do not need to modify the CMake file of an existing project.
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.

View File

@@ -16,3 +16,9 @@ VFS 操作符的 UART 具体实现函数从 `vfs` 组件挪到了 `esp_driver_ua
- ``esp_vfs_dev_uart_use_driver`` 更名为 ``uart_vfs_dev_use_driver``
为了兼容性,`vfs` 组件依旧将 `esp_driver_uart` 注册成了其私有依赖。换句话说,你无需修改既有项目的 CMake 文件。
SPI flash 驱动
^^^^^^^^^^^^^^^^^^^^^^
XMC-C 系列闪存 suspend 功能的支持已被移除。根据闪存制造商的反馈在某些情况下XMC-C 闪存需要在 resume 和下一条命令之间间隔 1 毫秒。这对于软件请求来说时间太长。基于上述原因,为了安全使用 suspend 功能,我们决定取消对 XMC-C 系列闪存挂起的支持。但是你依旧可以通过打开 `CONFIG_SPI_FLASH_FORCE_ENABLE_XMC_C_SUSPEND` 来强行使能这个功能。如果您有任何疑问,请联系 espressif 商务支持。