From 775170217b11f65b1d50b84a0fe3a3f35aa8b587 Mon Sep 17 00:00:00 2001 From: sakumisu <1203593632@qq.com> Date: Wed, 10 Aug 2022 23:27:34 +0800 Subject: [PATCH] update device api --- docs/source/api/api_device.rst | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 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,15 +157,6 @@ usbd_interface_add_endpoint - **intf** USB 设备接口的句柄 - **ep** USB 设备端点的句柄 -usbd_initialize -"""""""""""""""""""""""""""""""""""" - -``usbd_initialize`` 用来初始化 usb device 寄存器配置、usb 时钟、中断等,需要注意,此函数必须在所有列出的 API 最后。 - -.. code-block:: C - - int usbd_initialize(void); - usb_device_is_configured """""""""""""""""""""""""""""""""""" @@ -177,6 +168,26 @@ usb_device_is_configured - **return** 配置状态, 0 表示未配置, 1 表示配置成功 +usbd_configure_done_callback +"""""""""""""""""""""""""""""""""""" + +``usbd_configure_done_callback`` 在执行 set_configuration 命令后触发,表示配置完成,用户需要实现该函数, **此函数一般用作启动第一次数据接收**,如果没有使用到 out 端点,则函数为空即可。 + +.. code-block:: C + + bool usbd_configure_done_callback(void); + +.. warning:: msc 端点不需要在该函数中手动启动,协议栈会自动启动第一次接收 + +usbd_initialize +"""""""""""""""""""""""""""""""""""" + +``usbd_initialize`` 用来初始化 usb device 寄存器配置、usb 时钟、中断等,需要注意,此函数必须在所有列出的 API 最后。 + +.. code-block:: C + + int usbd_initialize(void); + CDC ACM -----------------