summaryrefslogtreecommitdiff
path: root/docs/source/api
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2022-08-10 23:27:34 +0800
committersakumisu <[email protected]>2022-08-10 23:27:34 +0800
commit775170217b11f65b1d50b84a0fe3a3f35aa8b587 (patch)
tree06780b3bed2d389169b4f934ed5054c7b0413c05 /docs/source/api
parent7ade4dfc9880d837dcd9dbf4157f9c627d0e8b64 (diff)
update device api
Diffstat (limited to 'docs/source/api')
-rw-r--r--docs/source/api/api_device.rst27
1 files changed, 19 insertions, 8 deletions
diff --git a/docs/source/api/api_device.rst b/docs/source/api/api_device.rst
index c63e03b8..3500eee1 100644
--- a/docs/source/api/api_device.rst
+++ b/docs/source/api/api_device.rst
@@ -29,7 +29,7 @@ CORE
- **ep_addr** 端点地址(带方向)
- **ep_cb** 端点完成中断回调函数。
-.. note:: 总结一句话:in 回调函数等价于 dma 发送完成中断;out 回调函数等价于 dma 接收完成中断
+.. note:: 总结一句话:in 回调函数等价于 dma 发送完成中断回调函数;out 回调函数等价于 dma 接收完成中断回调函数
接口结构体
""""""""""""""""""""""""""""""""""""
@@ -157,25 +157,36 @@ usbd_interface_add_endpoint
- **intf** USB 设备接口的句柄
- **ep** USB 设备端点的句柄
-usbd_initialize
+usb_device_is_configured
""""""""""""""""""""""""""""""""""""
-``usbd_initialize`` 用来初始化 usb device 寄存器配置、usb 时钟、中断等,需要注意,此函数必须在所有列出的 API 最后。
+``usb_device_is_configured`` 用来检查 USB 设备是否被配置(枚举)。
.. code-block:: C
- int usbd_initialize(void);
+ bool usb_device_is_configured(void);
-usb_device_is_configured
+- **return** 配置状态, 0 表示未配置, 1 表示配置成功
+
+usbd_configure_done_callback
""""""""""""""""""""""""""""""""""""
-``usb_device_is_configured`` 用来检查 USB 设备是否被配置(枚举)。
+``usbd_configure_done_callback`` 在执行 set_configuration 命令后触发,表示配置完成,用户需要实现该函数, **此函数一般用作启动第一次数据接收**,如果没有使用到 out 端点,则函数为空即可。
.. code-block:: C
- bool usb_device_is_configured(void);
+ bool usbd_configure_done_callback(void);
-- **return** 配置状态, 0 表示未配置, 1 表示配置成功
+.. warning:: msc 端点不需要在该函数中手动启动,协议栈会自动启动第一次接收
+
+usbd_initialize
+""""""""""""""""""""""""""""""""""""
+
+``usbd_initialize`` 用来初始化 usb device 寄存器配置、usb 时钟、中断等,需要注意,此函数必须在所有列出的 API 最后。
+
+.. code-block:: C
+
+ int usbd_initialize(void);
CDC ACM
-----------------