From 4c4ee7f0031ffbffb9e684d72d03bdda3c824b99 Mon Sep 17 00:00:00 2001 From: sakumisu <1203593632@qq.com> Date: Tue, 23 Jul 2024 20:13:28 +0800 Subject: chore(docs): update rst --- docs/source/api/api_device.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'docs/source/api/api_device.rst') diff --git a/docs/source/api/api_device.rst b/docs/source/api/api_device.rst index f5d5be02..49502c15 100644 --- a/docs/source/api/api_device.rst +++ b/docs/source/api/api_device.rst @@ -1,10 +1,10 @@ 设备协议栈 ========================= -设备协议栈主要负责枚举和驱动加载，枚举这边就不说了，驱动加载，也就是接口驱动加载，主要是依靠 `usbd_add_interface` 函数，记录传入的接口驱动保存到链表中，当主机进行类请求时就可以查找链表进行访问了。 +设备协议栈主要负责枚举和驱动加载，枚举这边就不说了，驱动加载，也就是接口驱动加载，主要是依靠 `usbd_add_interface` 函数，用于记录传入的接口驱动并保存到接口数组表，当主机进行类请求时就可以查找接口表进行访问了。 在调用 `usbd_desc_register` 以后需要进行接口注册和端点注册，口诀如下： -- 有多少个接口就调用多少次 `usbd_add_interface`，参数填相关 `xxx_init_intf`, 如果没有支持的，手动创建一个填入 +- 有多少个接口就调用多少次 `usbd_add_interface`，参数填相关 `xxx_init_intf`, 如果没有支持的，手动创建一个 intf 填入 - 有多少个端点就调用多少次 `usbd_add_endpoint`，当中断完成时，会调用到注册的端点回调中。 CORE @@ -38,7 +38,6 @@ CORE .. code-block:: C struct usbd_interface { - usb_slist_t list; usbd_request_handler class_interface_handler; usbd_request_handler class_endpoint_handler; usbd_request_handler vendor_handler; @@ -48,7 +47,6 @@ CORE uint8_t intf_num; }; -- **list** 接口的链表节点 - **class_interface_handler** class setup 请求回调函数,接收者为接口 - **class_endpoint_handler** class setup 请求回调函数,接收者为端点 - **vendor_handler** vendor setup 请求回调函数 @@ -69,6 +67,9 @@ usbd_desc_register - **desc** 描述符的句柄 +.. note:: 当前 API 仅支持一种速度，如果需要更高级的速度切换功能，请开启 CONFIG_USBDEV_ADVANCE_DESC，并且包含了下面所有描述符注册功能 + + usbd_msosv1_desc_register """""""""""""""""""""""""""""""""""" @@ -284,7 +285,7 @@ usbd_msc_sector_read - **sector** 扇区偏移 - **buffer** 存储读取的数据的指针 -- **length** 读取长度，当前为1个扇区的大小 +- **length** 读取长度 usbd_msc_sector_write @@ -298,7 +299,7 @@ usbd_msc_sector_write - **sector** 扇区偏移 - **buffer** 写入数据指针 -- **length** 写入长度，当前为1个扇区的大小 +- **length** 写入长度 UAC ----------------- -- cgit v1.3.1