From 6ae9acb3456a4711748aa24e4054906d378006f7 Mon Sep 17 00:00:00 2001 From: Wang Fang Date: Thu, 6 Jul 2023 11:15:31 +0800 Subject: [PATCH] docs: fixed formatting issues in spi_flash_concurrency document --- .../peripherals/spi_flash/spi_flash_concurrency.rst | 2 ++ docs/zh_CN/api-reference/peripherals/spi_flash/auto_suspend.inc | 2 +- .../peripherals/spi_flash/spi_flash_concurrency.rst | 2 ++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/en/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst b/docs/en/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst index 3885e71285..25efd3b195 100644 --- a/docs/en/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst +++ b/docs/en/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst @@ -3,6 +3,8 @@ Concurrency Constraints for Flash on SPI1 ========================================= +:link_to_translation:`zh_CN:[中文]` + The SPI0/1 bus is shared between the instruction & data cache (for firmware execution) and the SPI1 peripheral (controlled by the drivers including this SPI Flash driver). Hence, operations to SPI1 will cause significant influence to the whole system. This kind of operations include calling SPI Flash API or other drivers on SPI1 bus, any operations like read/write/erase or other user defined SPI operations, regardless to the main flash or other SPI slave devices. .. only:: not (esp32c3 or SOC_SPIRAM_XIP_SUPPORTED) diff --git a/docs/zh_CN/api-reference/peripherals/spi_flash/auto_suspend.inc b/docs/zh_CN/api-reference/peripherals/spi_flash/auto_suspend.inc index d719263909..47f0543d18 100644 --- a/docs/zh_CN/api-reference/peripherals/spi_flash/auto_suspend.inc +++ b/docs/zh_CN/api-reference/peripherals/spi_flash/auto_suspend.inc @@ -4,7 +4,7 @@ 当使能 flash 擦除的自动暂停 -------------------------------------- -.. important: +.. important:: 您使用的 flash 需要有 suspend/resume 功能，而且不是所有具备 suspend/resume 的 flash 都可以在 {IDF_TARGET_NAME} 上使用自动暂停功能。如果您在不支持自动暂停的 flash 上使用该功能，可能会造成严重的程序崩溃。因此，我们强烈建议您在使用前阅读对应的 flash 的数据手册，确保您的 flash 可以满足如下条件, 即使这样，我们也建议您对 flash 做完整的测试： diff --git a/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst b/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst index ffb387f4e5..cf7debbf97 100644 --- a/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst +++ b/docs/zh_CN/api-reference/peripherals/spi_flash/spi_flash_concurrency.rst @@ -3,6 +3,8 @@ SPI1 flash 并发约束 ========================================= +:link_to_translation:`en:[English]` + 指令/数据 cache（用以执行固件）与 SPI1 外设（由像 SPI flash 驱动一样的驱动程序控制）共享 SPI0/1 总线。因此，SPI1 外设上的操作会对整个系统造成显著的影响。这类操作包括调用 SPI flash API 或者 SPI1 总线上的其他驱动、任何 flash 操作（如读取、写入、擦除）或是由其他用户定义的 SPI 操作（对主 flash 或是其他 SPI 从机）。 .. only:: not (esp32c3 or SOC_SPIRAM_XIP_SUPPORTED)