diff --git a/docs/en/api-reference/peripherals/i2c.rst b/docs/en/api-reference/peripherals/i2c.rst index ee290bb06d..e99206bb07 100644 --- a/docs/en/api-reference/peripherals/i2c.rst +++ b/docs/en/api-reference/peripherals/i2c.rst @@ -3,6 +3,12 @@ I2C Driver :link_to_translation:`zh_CN:[中文]` +.. only:: esp32c3 + + .. warning:: + + This document is not updated for ESP32-C3 yet. + Overview -------- diff --git a/docs/en/api-reference/peripherals/i2s.rst b/docs/en/api-reference/peripherals/i2s.rst index 825d524a43..feb582dc25 100644 --- a/docs/en/api-reference/peripherals/i2s.rst +++ b/docs/en/api-reference/peripherals/i2s.rst @@ -1,6 +1,12 @@ I2S === +.. only:: esp32c3 + + .. warning:: + + This document is not updated for ESP32-C3 yet. + Overview -------- diff --git a/docs/en/api-reference/peripherals/sd_pullup_requirements.rst b/docs/en/api-reference/peripherals/sd_pullup_requirements.rst index 38baa4c117..128fb1750a 100644 --- a/docs/en/api-reference/peripherals/sd_pullup_requirements.rst +++ b/docs/en/api-reference/peripherals/sd_pullup_requirements.rst @@ -1,6 +1,12 @@ SD Pull-up Requirements ======================= +.. only:: esp32c3 + + .. warning:: + + This document is not updated for ESP32-C3 yet. + Espressif hardware products are designed for multiple use cases which may require different pull states on pins. For this reason, the pull state of particular pins on certain products will need to be adjusted to provide the pull-ups required in the SD bus. SD pull-up requirements apply to cases where {IDF_TARGET_NAME} uses the SPI controller to communicate with SD cards. When an SD card is operating in SPI mode or 1-bit SD mode, the CMD and DATA (DAT0 - DAT3) lines of the SD bus must be pulled up by 10 kOhm resistors. Slaves should also have pull-ups on all above-mentioned lines (regardless of whether these lines are connected to the host) in order to prevent SD cards from entering a wrong state. diff --git a/docs/en/api-reference/peripherals/sdio_slave.rst b/docs/en/api-reference/peripherals/sdio_slave.rst index 836404576c..a02ed1525c 100644 --- a/docs/en/api-reference/peripherals/sdio_slave.rst +++ b/docs/en/api-reference/peripherals/sdio_slave.rst @@ -1,6 +1,12 @@ SDIO Card Slave Driver ====================== +.. only:: esp32c3 + + .. warning:: + + This document is not updated for ESP32-C3 yet. + Overview -------- @@ -94,7 +100,7 @@ The SDIO slave driver uses the following terms: - Sending: slave to host transfers. - Receiving: host to slave transfers. -.. note:: Register names in *{IDF_TARGET_NAME} Technical Reference Manual* > *SDIO Slave Controller* +.. note:: Register names in *{IDF_TARGET_NAME} Technical Reference Manual* > *SDIO Slave Controller* [`PDF <{IDF_TARGET_TRM_EN_URL}#sdioslave>`__] are oriented from the point of view of the host, i.e. 'rx' registers refer to sending, while 'tx' registers refer to receiving. We're not using `tx` or `rx` in the driver to avoid ambiguities. diff --git a/docs/en/api-reference/peripherals/sdmmc_host.rst b/docs/en/api-reference/peripherals/sdmmc_host.rst index a092c9c070..7b6ccff93e 100644 --- a/docs/en/api-reference/peripherals/sdmmc_host.rst +++ b/docs/en/api-reference/peripherals/sdmmc_host.rst @@ -1,6 +1,12 @@ SDMMC Host Driver ================= +.. only:: esp32c3 + + .. warning:: + + This document is not updated for ESP32-C3 yet. + Overview -------- diff --git a/docs/en/index.rst b/docs/en/index.rst index f89056d236..547c663db2 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -12,12 +12,6 @@ This is the documentation for Espressif IoT Development Framework (`esp-idf `_，以获取有关 I2C 控制器触发的中断描述。 +安装驱动程序时，默认情况下会安装中断处理程序。但是，您可以通过调用函数 :cpp:func:`i2c_isr_register` 来注册自己的而不是默认的中断处理程序。在运行自己的中断处理程序时，可以参考 `{IDF_TARGET_NAME} 的技术参考手册（PDF） <{IDF_TARGET_TRM_EN_URL}>`_，以获取有关 I2C 控制器触发的中断描述。 调用函数 :cpp:func:`i2c_isr_free` 删除中断处理程序。 @@ -211,16 +217,16 @@ API 为从机提供以下功能： - :cpp:func:`i2c_set_data_mode` -上述每个函数都有一个 *_get_* 对应项来检查当前设置的值。例如，调用 :cpp:func:`i2c_get_timeout` 来检查 I2C 超时值。 +上述每个函数都有一个 *_get_* 对应项来检查当前设置的值。例如，调用 :cpp:func:`i2c_get_timeout` 来检查 I2C 超时值。 -要检查在驱动程序配置过程中设置的参数默认值，请参考文件 :component_file:`driver/i2c.c` 并查找带有后缀 ``_DEFAULT`` 的定义。 +要检查在驱动程序配置过程中设置的参数默认值，请参考文件 :component_file:`driver/i2c.c` 并查找带有后缀 ``_DEFAULT`` 的定义。 通过函数 :cpp:func:`i2c_set_pin` 可以为 SDA 和 SCL 信号选择不同的管脚并改变上拉配置。如果要修改已经输入的值，请使用函数 :cpp:func:`i2c_param_config`。 .. 注解 :: - {IDF_TARGET_NAME} 的内部上拉电阻范围为几万欧姆，因此在大多数情况下，它们本身不足以用作 I2C 上拉电阻。建议用户使用阻值在 `I2C 总线协议规范 `_ 规定范围内的上拉电阻。 + {IDF_TARGET_NAME} 的内部上拉电阻范围为几万欧姆，因此在大多数情况下，它们本身不足以用作 I2C 上拉电阻。建议用户使用阻值在 `I2C 总线协议规范 `_ 规定范围内的上拉电阻。 .. _i2c-api-error-handling: @@ -240,7 +246,7 @@ API 为从机提供以下功能： 删除驱动程序 ^^^^^^^^^^^^^ -如果使用 :cpp:func:`i2c_driver_install` 建立 I2C 通信，一段时间后不再需要 I2C 通信，则可以通过调用 :cpp:func:`i2c_driver_delete` 来移除驱动程序以释放分配的资源。 +如果使用 :cpp:func:`i2c_driver_install` 建立 I2C 通信，一段时间后不再需要 I2C 通信，则可以通过调用 :cpp:func:`i2c_driver_delete` 来移除驱动程序以释放分配的资源。 应用示例 diff --git a/docs/zh_CN/api-reference/storage/sdmmc.rst b/docs/zh_CN/api-reference/storage/sdmmc.rst index 446ff64484..4d7d3400e9 100644 --- a/docs/zh_CN/api-reference/storage/sdmmc.rst +++ b/docs/zh_CN/api-reference/storage/sdmmc.rst @@ -3,6 +3,12 @@ SD/SDIO/MMC 驱动程序 :link_to_translation:`en:[English]` +.. only:: esp32c3 + + .. warning:: + + 本文档尚未针对 ESP32-C3 进行更新。 + 概述 -------- @@ -35,20 +41,20 @@ ESP-IDF :example:`storage/sd_card` 目录下提供了 SDMMC 驱动与 FatFs 库 协议层 API ------------------ -协议层具备 :cpp:class:`sdmmc_host_t` 结构体，此结构体描述了 SD/MMC 主机驱动，列出了其功能，并提供指向驱动程序函数的指针。协议层将卡信息储存于 :cpp:class:`sdmmc_card_t` 结构体中。向 SD/MMC 主机发送命令时，协议层调用时需要一个 :cpp:class:`sdmmc_command_t` 结构体来描述命令、参数、预期返回值和需传输的数据（如有）。 +协议层具备 :cpp:class:`sdmmc_host_t` 结构体，此结构体描述了 SD/MMC 主机驱动，列出了其功能，并提供指向驱动程序函数的指针。协议层将卡信息储存于 :cpp:class:`sdmmc_card_t` 结构体中。向 SD/MMC 主机发送命令时，协议层调用时需要一个 :cpp:class:`sdmmc_command_t` 结构体来描述命令、参数、预期返回值和需传输的数据（如有）。 用于 SD 存储卡的 API ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1. 初始化主机，请调用主机驱动函数，例如 :cpp:func:`sdmmc_host_init` 和 :cpp:func:`sdmmc_host_init_slot`； 2. 初始化卡，请调用 :cpp:func:`sdmmc_card_init`，并将参数 ``host`` （即主机驱动信息）和参数 ``card`` （指向 :cpp:class:`sdmmc_card_t` 结构体的指针）传递给此函数。函数运行结束后，将会向 :cpp:class:`sdmmc_card_t` 结构体填充该卡的信息； -3. 读取或写入卡的扇区，请分别调用 :cpp:func:`sdmmc_read_sectors` 和 :cpp:func:`sdmmc_write_sectors`，并将参数 ``card`` （指向卡信息结构的指针）传递给函数； +3. 读取或写入卡的扇区，请分别调用 :cpp:func:`sdmmc_read_sectors` 和 :cpp:func:`sdmmc_write_sectors`，并将参数 ``card`` （指向卡信息结构的指针）传递给函数； 4. 如果不再使用该卡，请调用主机驱动函数，例如 :cpp:func:`sdmmc_host_deinit`，以禁用主机外设，并释放驱动程序分配的资源。 用于 eMMC 芯片的 API ^^^^^^^^^^^^^^^^^^^^^^^^^ -从协议层的角度而言，eMMC 存储芯片与 SD 存储卡相同。尽管 eMMC 是芯片，不具备卡的外形，但由于协议相似 (`sdmmc_card_t`, `sdmmc_card_init`)，用于 SD 卡的一些概念同样适用于 eMMC 芯片。注意，eMMC 芯片不可通过 SPI 使用，因此它与 SD API 主机驱动不兼容。 +从协议层的角度而言，eMMC 存储芯片与 SD 存储卡相同。尽管 eMMC 是芯片，不具备卡的外形，但由于协议相似 (`sdmmc_card_t`, `sdmmc_card_init`)，用于 SD 卡的一些概念同样适用于 eMMC 芯片。注意，eMMC 芯片不可通过 SPI 使用，因此它与 SD API 主机驱动不兼容。 如需初始化 eMMC 内存并执行读/写操作，请参照上一章节 SD 卡操作步骤。 @@ -68,7 +74,7 @@ SDIO 卡初始化和检测过程与 SD 存储卡相同，唯一的区别是 SDIO 如需设置卡配置或传输数据，请根据您的具体情况选择下表中的函数： ========================================================================= ================================= ================================= -操作 读函数 写函数 +操作 读函数 写函数 ========================================================================= ================================= ================================= 使用 IO_RW_DIRECT (CMD52) 读写单个字节。 :cpp:func:`sdmmc_io_read_byte` :cpp:func:`sdmmc_io_write_byte` 使用 IO_RW_EXTENDED (CMD53) 的字节模式读写多个字节。 :cpp:func:`sdmmc_io_read_bytes` :cpp:func:`sdmmc_io_write_bytes` @@ -76,7 +82,7 @@ SDIO 卡初始化和检测过程与 SD 存储卡相同，唯一的区别是 SDIO ========================================================================= ================================= ================================= 使用 :cpp:func:`sdmmc_io_enable_int` 函数，应用程序可启用 SDIO 中断。 - + 在单线模式下使用 SDIO 时，还需要连接 D1 线来启用 SDIO 中断。 如果您需要应用程序保持等待直至发生 SDIO 中断，请使用 :cpp:func:`sdmmc_io_wait_int` 函数。 @@ -84,7 +90,7 @@ SDIO 卡初始化和检测过程与 SD 存储卡相同，唯一的区别是 SDIO 复合卡（存储 + SDIO） ^^^^^^^^^^^^^^^^^^^^^^^^^ - + 该驱动程序不支持 SDIO 复合卡，复合卡会被视为 SDIO 卡。 diff --git a/docs/zh_CN/index.rst b/docs/zh_CN/index.rst index 892b9d29df..f32f7e88b8 100644 --- a/docs/zh_CN/index.rst +++ b/docs/zh_CN/index.rst @@ -12,12 +12,6 @@ ESP-IDF 编程指南 本文档仅包含针对 {IDF_TARGET_NAME} 芯片的 ESP-IDF 使用。 -.. only:: esp32c3 - - .. warning:: - - ESP32-C3 的相关文档尚未全部更新完毕。 - ================== ================== ================== |快速入门|_ |API 参考|_ |H/W 参考|_ ------------------ ------------------ ------------------