diff --git a/docs/en/api-reference/peripherals/usb_host/usb_host_notes_index.rst b/docs/en/api-reference/peripherals/usb_host/usb_host_notes_index.rst index 285b6e79d7..e2011708c9 100644 --- a/docs/en/api-reference/peripherals/usb_host/usb_host_notes_index.rst +++ b/docs/en/api-reference/peripherals/usb_host/usb_host_notes_index.rst @@ -10,7 +10,6 @@ This document contains information regarding the implementation details of the U .. figure:: ../../../../_static/usb_host/stack-overview.png :align: center :alt: Diagram of Host Stack Layers - :figclass: align-center This document is split into the following sections: @@ -43,13 +42,12 @@ Features & Limitations **The Host Stack currently supports the following notable features:** -- Support FS (Full Speed) and LS (Low Speed) devices -- Support all transfer types (Control, Bulk, Isochronous, and Interrupt) +- Supports FS (Full Speed) and LS (Low Speed) devices +- Supports all transfer types (Control, Bulk, Isochronous, and Interrupt) - Automatically enumerates connected devices -- Allows multiple class drivers (i.e., Clients of the USB Host Library) to run simultaneously and share the same device (i.e., composite devices). +- Allows multiple class drivers (i.e., Clients of the USB Host Library) to run simultaneously and share the same device (i.e., composite devices) **The Host Stack currently has the following notable limitations:** - No HS (High Speed) support - No Hub support (currently only supports a single device) - diff --git a/docs/zh_CN/api-reference/peripherals/usb_host/usb_host_notes_index.rst b/docs/zh_CN/api-reference/peripherals/usb_host/usb_host_notes_index.rst index 09d410debf..d1e3c4932f 100644 --- a/docs/zh_CN/api-reference/peripherals/usb_host/usb_host_notes_index.rst +++ b/docs/zh_CN/api-reference/peripherals/usb_host/usb_host_notes_index.rst @@ -1 +1,53 @@ -.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_index.rst +USB 主机维护者注意事项(简介) +============================== + +本文档包含有关 USB 主机协议栈实现细节的信息,面向 USB 主机协议栈的维护者和第三方贡献者。USB 主机协议栈的用户请参考 :doc:`../usb_host`。 + +.. warning:: + + USB 主机协议栈的实现细节属于私有 API,因此,除 USB 主机库外的所有层均不遵循 :ref:`ESP-IDF's 版本简介` 即允许进行重大更改。 + +.. figure:: ../../../../_static/usb_host/stack-overview.png + :align: center + :alt: 主机协议栈层次结构图 + +本文档分为以下几个部分: + +.. toctree:: + :maxdepth: 1 + + usb_host_notes_design + usb_host_notes_arch + usb_host_notes_dwc_otg + +待写章节: + +- USB 主机维护者注意事项 (HAL 和 LL) +- USB 主机维护者注意事项 (HCD) +- USB 主机维护者注意事项 (USBH) +- USB 主机维护者注意事项 (Hub) +- USB 主机维护者注意事项 (USB Host Library) + +.. -------------------------------------------------- Introduction ----------------------------------------------------- + +简介 +---- + +ESP-IDF USB 主机协议栈允许 {IDF_TARGET_NAME} 作为 USB 主机运行,此时,{IDF_TARGET_NAME} 能够与各种 USB 设备通信。然而,大多数 USB 主机协议栈实现都不运行在嵌入式硬件上(即在电脑和手机端运行),因此,相对来说具有更多的资源(即,具有更高内存和 CPU 速度)。 + +ESP-IDF USB 主机协议栈(以下简称为主机协议栈)的实现考虑到了 {IDF_TARGET_NAME} 的嵌入式特性,这体现在主机协议栈设计的各个方面。 + +特性和局限性 +^^^^^^^^^^^^ + +**主机协议栈目前支持以下显著特性:** + +- 支持 FS(全速)和 LS(低速)设备 +- 支持所有传输类型(控制传输、批量传输、同步传输和中断传输) +- 自动枚举已连接设备 +- 允许多个类驱动程序(即 USB 主机库的客户端)同时运行并共享同一设备(即组合设备) + +**主机协议栈目前存在以下显著局限:** + +- 不支持 HS (高速) 设备 +- 不支持集线器 (当前仅支持单个设备)