alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/remove_c3_not_updated_warning' into 'master'

Browse Source 
docs: remove front page C3 docs not updated warning

See merge request espressif/esp-idf!13442
This commit is contained in:
Krzysztof Budzynski 2021-05-13 02:25:38 +00:00
commit cc22768863
7 changed files with 37 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/api-reference/peripherals/i2s.rst
View File

@ -1,6 +1,12 @@
I2S I2S
=== ===
.. only:: esp32c3
.. warning::
This document is not updated for ESP32-C3 yet.
Overview Overview
-------- --------

6
docs/en/api-reference/peripherals/sd_pullup_requirements.rst
View File

@ -1,6 +1,12 @@
SD Pull-up Requirements 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. 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. 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.

8
docs/en/api-reference/peripherals/sdio_slave.rst
View File

@ -1,6 +1,12 @@
SDIO Card Slave Driver SDIO Card Slave Driver
====================== ======================
.. only:: esp32c3
.. warning::
This document is not updated for ESP32-C3 yet.
Overview Overview
-------- --------
@ -94,7 +100,7 @@ The SDIO slave driver uses the following terms:
- Sending: slave to host transfers. - Sending: slave to host transfers.
- Receiving: host to slave 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' [`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 registers refer to sending, while 'tx' registers refer to receiving. We're not using `tx` or `rx` in the driver to
avoid ambiguities. avoid ambiguities.

6
docs/en/api-reference/peripherals/sdmmc_host.rst
View File

@ -1,6 +1,12 @@
SDMMC Host Driver SDMMC Host Driver
================= =================
.. only:: esp32c3
.. warning::
This document is not updated for ESP32-C3 yet.
Overview Overview
-------- --------

6
docs/en/index.rst
View File

@ -18,12 +18,6 @@ This is the documentation for Espressif IoT Development Framework (`esp-idf <htt
This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC. This document describes using ESP-IDF with the {IDF_TARGET_NAME} SoC.
.. only:: esp32c3
.. warning::
Not all documents are updated for ESP32-C3 yet.
================== ================== ================== ================== ================== ==================
|Get Started|_ |API Reference|_ |H/W Reference|_ |Get Started|_ |API Reference|_ |H/W Reference|_
------------------ ------------------ ------------------ ------------------ ------------------ ------------------

18
docs/zh_CN/api-reference/storage/sdmmc.rst
View File

@ -3,6 +3,12 @@ SD/SDIO/MMC 驱动程序
:link_to_translation:`en:[English]` :link_to_translation:`en:[English]`
.. only:: esp32c3
.. warning::
本文档尚未针对 ESP32-C3 进行更新。
概述 概述
-------- --------
@ -35,20 +41,20 @@ ESP-IDF :example:`storage/sd_card` 目录下提供了 SDMMC 驱动与 FatFs 库
协议层 API 协议层 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 用于 SD 存储卡的 API
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. 初始化主机，请调用主机驱动函数，例如 :cpp:func:`sdmmc_host_init` 和 :cpp:func:`sdmmc_host_init_slot`； 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` 结构体填充该卡的信息； 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`，以禁用主机外设，并释放驱动程序分配的资源。 4. 如果不再使用该卡，请调用主机驱动函数，例如 :cpp:func:`sdmmc_host_deinit`，以禁用主机外设，并释放驱动程序分配的资源。
用于 eMMC 芯片的 API 用于 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 卡操作步骤。 如需初始化 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_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` 使用 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 中断。 使用 :cpp:func:`sdmmc_io_enable_int` 函数，应用程序可启用 SDIO 中断。
在单线模式下使用 SDIO 时，还需要连接 D1 线来启用 SDIO 中断。 在单线模式下使用 SDIO 时，还需要连接 D1 线来启用 SDIO 中断。
如果您需要应用程序保持等待直至发生 SDIO 中断，请使用 :cpp:func:`sdmmc_io_wait_int` 函数。 如果您需要应用程序保持等待直至发生 SDIO 中断，请使用 :cpp:func:`sdmmc_io_wait_int` 函数。
@ -84,7 +90,7 @@ SDIO 卡初始化和检测过程与 SD 存储卡相同，唯一的区别是 SDIO
复合卡（存储 + SDIO） 复合卡（存储 + SDIO）
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
该驱动程序不支持 SDIO 复合卡，复合卡会被视为 SDIO 卡。 该驱动程序不支持 SDIO 复合卡，复合卡会被视为 SDIO 卡。

6
docs/zh_CN/index.rst
View File

@ -18,12 +18,6 @@ ESP-IDF 编程指南
本文档仅包含针对 {IDF_TARGET_NAME} 芯片的 ESP-IDF 使用。 本文档仅包含针对 {IDF_TARGET_NAME} 芯片的 ESP-IDF 使用。
.. only:: esp32c3
.. warning::
ESP32-C3 的相关文档尚未全部更新完毕。
================== ================== ================== ================== ================== ==================
|快速入门|_ |API 参考|_ |H/W 参考|_ |快速入门|_ |API 参考|_ |H/W 参考|_
------------------ ------------------ ------------------ ------------------ ------------------ ------------------