Merge branch 'docs/translate_usb_host_notes_index' into 'master'

docs: Provide translation for usb_host_notes_index.rst in api-reference

Closes DOC-7527

See merge request espressif/esp-idf!29877
This commit is contained in:
Shen Meng Jing 2024-04-09 17:38:04 +08:00
commit 35c4b059e4
2 changed files with 60 additions and 6 deletions

View File

@ -1,6 +1,8 @@
USB Host Maintainers Notes (Introduction)
=========================================
:link_to_translation:`zh_CN:[中文]`
This document contains information regarding the implementation details of the USB Host stack. This document is intended for the maintainers and third-party contributors of the USB Host stack. Users of the USB Host stack should refer to :doc:`../usb_host` instead.
.. warning::
@ -10,7 +12,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 +44,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)

View File

@ -1 +1,55 @@
.. include:: ../../../../en/api-reference/peripherals/usb_host/usb_host_notes_index.rst
USB 主机维护者注意事项(简介)
==============================
:link_to_translation:`en:[English]`
本文档包含有关 USB 主机协议栈实现细节的信息,面向 USB 主机协议栈的维护者和第三方贡献者。USB 主机协议栈的用户请参考 :doc:`../usb_host`
.. warning::
USB 主机协议栈的实现细节属于私有 API因此除 USB 主机库外的所有层均不遵循 :ref:`ESP-IDF 版本简介 <versioning-scheme>`,即允许进行重大更改。
.. 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高速设备
- 不支持集线器(当前仅支持单个设备)