From da170ae1779503b33ca642199359ee5a7495d694 Mon Sep 17 00:00:00 2001 From: sakumisu <1203593632@qq.com> Date: Fri, 8 Jul 2022 22:48:07 +0800 Subject: update port rst --- docs/source/api/api_device.rst | 4 +++- docs/source/api/api_port.rst | 14 +------------- 2 files changed, 4 insertions(+), 14 deletions(-) (limited to 'docs/source') diff --git a/docs/source/api/api_device.rst b/docs/source/api/api_device.rst index 708659d7..3af0e72f 100644 --- a/docs/source/api/api_device.rst +++ b/docs/source/api/api_device.rst @@ -29,7 +29,9 @@ CORE - **ep_addr** 端点地址(带方向) - **ep_cb** 端点中断回调函数。 -.. note:: 注册 IN 方向则表示发送完成后触发,类似于 dma 完成中断。注册 OUT 中断则表示有数据就触发,类似于 fifo 不为空中断。 +.. note:: 总结就是注册 IN 方向则表示发送完成后触发,等价于 dma 完成中断。注册 OUT 中断则表示有数据就触发,等价于 fifo 不为空中断。 + +.. note:: 如果 ip 支持 dma 接收功能,并启用了 dma 接收的宏,则 out 中断表示 dma 接收完成中断,而不是 fifo 不为空中断(0.4.1版本之前无此实现) 接口结构体 """""""""""""""""""""""""""""""""""" diff --git a/docs/source/api/api_port.rst b/docs/source/api/api_port.rst index 05c8ad22..ddb80fa4 100644 --- a/docs/source/api/api_port.rst +++ b/docs/source/api/api_port.rst @@ -162,7 +162,7 @@ usbd_ep_write_async usbd_ep_read_async """""""""""""""""""""""""""""""""""" -``usbd_ep_read_async`` 启动某个端点接收,该函数配合 dma 使用,当 dma 完成时,会进入注册的 out 中断。如果硬件没有该功能,则无法使用。 **此函数对用户开放**。 +``usbd_ep_read_async`` 预先设置一块内存,并启动接收,通常配合 dma 使用,接收完成以后,触发注册的 out 中断。此函数一般在支持高速或者超高速的 ip 中使用,达到极致的带宽,如果 ip 没有该功能,则禁止使用。 **此函数对用户开放**。 .. code-block:: C @@ -185,18 +185,6 @@ usbd_ep_get_read_len - **ep** out 端点地址 - **return** 实际接收长度 -usbd_ep_is_complete -"""""""""""""""""""""""""""""""""""" - -``usbd_ep_is_complete`` 查询端点发送是否完成,搭配 ``usbd_ep_write_async`` 使用。 **此函数对用户开放**。 - -.. code-block:: C - - bool usbd_ep_is_complete(const uint8_t ep); - -- **ep** in 端点地址 -- **return** 返回 true 表示传输完成 - usbd_ep_get_mps """""""""""""""""""""""""""""""""""" -- cgit v1.3.1