summaryrefslogtreecommitdiff
path: root/docs/source/api/api_host.rst
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2022-05-14 22:50:27 +0800
committersakumisu <[email protected]>2022-05-14 23:20:13 +0800
commit5c64b99fddbfe5eb16dba5ea08800cba10023027 (patch)
treeab32a95bbc093b8b943df59a605146f36a2a57be /docs/source/api/api_host.rst
parent2ecde84a4ece1859f7d9e6c26f5c2001680b71e2 (diff)
update doc
Diffstat (limited to 'docs/source/api/api_host.rst')
-rw-r--r--docs/source/api/api_host.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/source/api/api_host.rst b/docs/source/api/api_host.rst
index fdee2c18..92c42d00 100644
--- a/docs/source/api/api_host.rst
+++ b/docs/source/api/api_host.rst
@@ -1,6 +1,11 @@
主机协议栈
=========================
+关于主机协议栈中结构体的命名、分类、成员组成,参考下面这两张图:
+
+.. figure:: img/api_host1.png
+.. figure:: img/api_host2.png
+
CORE
-----------------
@@ -94,7 +99,7 @@ hub 结构体
usbh_event_notify_handler
""""""""""""""""""""""""""""""""""""
-``usbh_event_notify_handler`` 是 USB 中断中的核心,用于处理不同的中断标志。包括复位、端点0 IN/OUT/SETUP、其他端点 IN/OUT 、SUSPEND、RESUME、SOF 中断等等。用于需要在 porting 接口中的 USB中断中调用该接口。
+``usbh_event_notify_handler`` 是 USB 中断中的核心,主要用于处理 **设备连接** 和 **设备断开** 中断,从而唤醒线程去执行枚举。
.. code-block:: C
@@ -115,7 +120,7 @@ usbh_event_notify_handler
usbh_initialize
""""""""""""""""""""""""""""""""""""
-``usbh_initialize`` 用来初始化 usb 主机协议栈,包括:创建插拔检测用的信号量和枚举线程、高低工作队列、初始化 roothub端点0 配置,初始化 usb 主机控制器。
+``usbh_initialize`` 用来初始化 usb 主机协议栈,包括:创建插拔检测用的信号量和枚举线程、高低工作队列、初始化 roothub 端点0 配置,初始化 usb 主机控制器。
.. code-block:: C
@@ -151,11 +156,8 @@ HID
MSC
-----------------
-UAC
------------------
-
-UVC
+RNDIS
-----------------
-PORTING
+PRINTER
----------------- \ No newline at end of file