refactor dcd api and ep in/out irq callback process
This commit is contained in:
sakumisu
@@ -27,11 +27,9 @@ CORE
|
||||
|
||||
- **list** 端点的链表节点
|
||||
- **ep_addr** 端点地址（带方向）
|
||||
- **ep_cb** 端点中断回调函数。
|
||||
- **ep_cb** 端点完成中断回调函数。
|
||||
|
||||
.. note:: 总结就是注册 IN 方向则表示发送完成后触发，等价于 dma 完成中断。注册 OUT 中断则表示有数据就触发，等价于 fifo 不为空中断。
|
||||
|
||||
.. note:: 如果 ip 支持 dma 接收功能，并启用了 dma 接收的宏，则 out 中断表示 dma 接收完成中断，而不是 fifo 不为空中断（0.4.1版本之前无此实现）
|
||||
.. note:: 总结一句话：in 回调函数等价于 dma 发送完成中断；out 回调函数等价于 dma 接收完成中断
|
||||
|
||||
接口结构体
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -79,64 +77,6 @@ CORE
|
||||
- **name** 类的名称
|
||||
- **intf_list** 接口的链表节点
|
||||
|
||||
usbd_event_notify_handler
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_event_notify_handler`` 是 USB 中断中的核心，用于处理不同的中断标志。包括复位、端点0 IN/OUT/SETUP、其他端点 IN/OUT 、SUSPEND、RESUME、SOF 中断等等。用户需要在 porting 接口中的 USB中断中调用该接口。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_event_notify_handler(uint8_t event, void *arg);
|
||||
|
||||
- **event** 中断事件
|
||||
- **arg** 端点号
|
||||
|
||||
其中 ``event`` 有如下类型：
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum usbd_event_type {
|
||||
/** USB error reported by the controller */
|
||||
USBD_EVENT_ERROR,
|
||||
/** USB reset */
|
||||
USBD_EVENT_RESET,
|
||||
/** Start of Frame received */
|
||||
USBD_EVENT_SOF,
|
||||
/** USB connection established, hardware enumeration is completed */
|
||||
USBD_EVENT_CONNECTED,
|
||||
/** USB configuration done */
|
||||
USBD_EVENT_CONFIGURED,
|
||||
/** USB connection suspended by the HOST */
|
||||
USBD_EVENT_SUSPEND,
|
||||
/** USB connection lost */
|
||||
USBD_EVENT_DISCONNECTED,
|
||||
/** USB connection resumed by the HOST */
|
||||
USBD_EVENT_RESUME,
|
||||
|
||||
/** USB interface selected */
|
||||
USBD_EVENT_SET_INTERFACE,
|
||||
/** USB interface selected */
|
||||
USBD_EVENT_SET_REMOTE_WAKEUP,
|
||||
/** USB interface selected */
|
||||
USBD_EVENT_CLEAR_REMOTE_WAKEUP,
|
||||
/** Set Feature ENDPOINT_HALT received */
|
||||
USBD_EVENT_SET_HALT,
|
||||
/** Clear Feature ENDPOINT_HALT received */
|
||||
USBD_EVENT_CLEAR_HALT,
|
||||
/** setup packet received */
|
||||
USBD_EVENT_SETUP_NOTIFY,
|
||||
/** ep0 in packet received */
|
||||
USBD_EVENT_EP0_IN_NOTIFY,
|
||||
/** ep0 out packet received */
|
||||
USBD_EVENT_EP0_OUT_NOTIFY,
|
||||
/** ep in packet except ep0 received */
|
||||
USBD_EVENT_EP_IN_NOTIFY,
|
||||
/** ep out packet except ep0 received */
|
||||
USBD_EVENT_EP_OUT_NOTIFY,
|
||||
/** Initial USB connection status */
|
||||
USBD_EVENT_UNKNOWN
|
||||
};
|
||||
|
||||
usbd_desc_register
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ usb_dc_init
|
||||
|
||||
int usb_dc_init(void);
|
||||
|
||||
- **return**
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usb_dc_deinit
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -24,29 +24,7 @@ usb_dc_deinit
|
||||
|
||||
int usb_dc_deinit(void);
|
||||
|
||||
- **return**
|
||||
|
||||
usb_dc_attach
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usb_dc_attach`` 使能上拉或者下拉电阻，从而能够让设备被主机枚举。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int usb_dc_attach(void);
|
||||
|
||||
- **return**
|
||||
|
||||
usb_dc_detach
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usb_dc_detach``断开设备与主机的连接。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int usb_dc_detach(void);
|
||||
|
||||
- **return**
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_set_address
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -57,7 +35,7 @@ usbd_set_address
|
||||
|
||||
int usbd_set_address(const uint8_t addr);
|
||||
|
||||
- **return**
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_open
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -68,7 +46,7 @@ usbd_ep_open
|
||||
|
||||
int usbd_ep_open(const struct usbd_endpoint_cfg *ep_cfg);
|
||||
|
||||
- **return**
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_close
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -80,6 +58,7 @@ usbd_ep_close
|
||||
int usbd_ep_close(const uint8_t ep);
|
||||
|
||||
- **event**
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_set_stall
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -91,6 +70,7 @@ usbd_ep_set_stall
|
||||
int usbd_ep_set_stall(const uint8_t ep);
|
||||
|
||||
- **ep** 端点地址
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_clear_stall
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -102,6 +82,7 @@ usbd_ep_clear_stall
|
||||
int usbd_ep_clear_stall(const uint8_t ep);
|
||||
|
||||
- **ep** 端点地址
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_is_stalled
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
@@ -115,89 +96,35 @@ usbd_ep_is_stalled
|
||||
- **ep** 端点地址
|
||||
- **return** 返回 1 表示 stalled，0 表示没有 stall
|
||||
|
||||
usbd_ep_write
|
||||
usbd_ep_start_write
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_ep_write`` 向某个端点发送数据， **如果该函数在中断中使用则是异步传输，否则是阻塞传输**。 **此函数对用户开放**。
|
||||
``usbd_ep_start_write`` 启动端点发送，发送完成以后，会调用注册的 in 端点传输完成中断回调函数。该函数为异步发送。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int usbd_ep_write(const uint8_t ep, const uint8_t *data, uint32_t data_len, uint32_t *ret_bytes);
|
||||
int usbd_ep_start_write(const uint8_t ep, const uint8_t *data, uint32_t data_len);
|
||||
|
||||
- **ep** in 端点地址
|
||||
- **data** 要发送的数据缓冲区
|
||||
- **data_len** 发送长度，需要小于等于端点最大包长
|
||||
- **ret_bytes** 实际发送的长度，异步传输该参数无效。 **如果长度为 0，表示发送 0 长数据包（zero length packet）**
|
||||
- **data** 发送数据缓冲区
|
||||
- **data_len** 发送长度，原则上无限长，推荐 16K 字节以内
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
.. note:: 如果第一次在非中使用，该函数也是异步的哦，只有第二次调用会变成阻塞，所以可以配合完成中断当非阻塞用
|
||||
|
||||
usbd_ep_read
|
||||
usbd_ep_start_read
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_ep_read`` 从某个端点接收数据， **该函数仅能在 usb out 中断中使用**。 **此函数对用户开放**。
|
||||
``usbd_ep_start_read`` 启动端点接收，接收完成以后，会调用注册的 out 端点传输完成中断回调函数。该函数为异步接收。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int usbd_ep_read(const uint8_t ep, uint8_t *data, uint32_t max_data_len, uint32_t *read_bytes);
|
||||
int usbd_ep_start_read(const uint8_t ep, uint8_t *data, uint32_t data_len);
|
||||
|
||||
- **ep** out 端点地址
|
||||
- **data** 要接收的数据缓冲区
|
||||
- **data_len** 接收长度，需要小于等于端点最大包长，推荐直接设置成最大包长。 **如果长度为 0 表示启动下次接收**
|
||||
- **ret_bytes** 实际接收的长度
|
||||
- **data** 接收数据缓冲区
|
||||
- **data_len** 接收长度，原则上无限长，推荐 16K 字节以内
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_write_async(todo)
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_ep_write_async`` 向某个端点发送数据， 该函数为异步传输。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int usbd_ep_write_async(const uint8_t ep, const uint8_t *data, uint32_t data_len);
|
||||
|
||||
- **ep** in 端点地址
|
||||
- **data** 要发送的数据缓冲区
|
||||
- **data_len** 发送长度，需要小于等于端点最大包长
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_read_async(todo)
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_ep_read_async`` 预先设置一块内存，并启动接收，通常配合 dma 使用，接收完成以后，触发注册的 out 中断。此函数一般在支持高速或者超高速的 ip 中使用，达到极致的带宽，如果 ip 没有该功能，则禁止使用。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int usbd_ep_read_async(const uint8_t ep, uint8_t *data, uint32_t max_data_len);
|
||||
|
||||
- **ep** out 端点地址
|
||||
- **data** 要接收的数据缓冲区
|
||||
- **data_len** 接收长度，需要小于等于端点最大包长，推荐直接设置成最大包长。 **如果长度为 0 表示准备接收 0 包**
|
||||
- **return** 返回 0 表示正确，其他表示错误
|
||||
|
||||
usbd_ep_get_read_len(todo)
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_ep_get_read_len`` 获取实际接收长度，此函数搭配 ``usbd_ep_read_async`` 使用。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
uint32_t usbd_ep_get_read_len(const uint8_t ep);
|
||||
|
||||
- **ep** out 端点地址
|
||||
- **return** 实际接收长度
|
||||
|
||||
usbd_ep_get_mps(todo)
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_ep_get_mps`` 查询端点最大数据包长。 **此函数对用户开放**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
uint16_t usbd_ep_get_mps(const uint8_t ep);
|
||||
|
||||
- **ep** 端点地址
|
||||
- **return** 返回端点最大数据包长
|
||||
.. note:: 启动接收以后，以下两种情况，会进入传输完成中断：1、最后一包为短包；2、接收总长度等于 data_len
|
||||
|
||||
host controller(hcd)
|
||||
------------------------
|
||||
|
||||
@@ -10,10 +10,10 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
|
||||
|
||||
- 比较全面的 class 驱动，并且 class 驱动全部模板化，方便学习和自主添加
|
||||
- 树状化编程，方便理清 class 驱动与接口、端点的关系，hub、port、class 之间的关系；代码层层递进，调用关系一目了然，方便理清 usb 枚举过程和 class 驱动加载
|
||||
- 设备协议栈的使用简化到类如 uart 、dma 的使用，主机协议栈的使用简化到文件的使用
|
||||
- 设备协议栈使用等价于 uart tx/rx dma 的使用，主机协议栈的使用等价于文件的使用
|
||||
- 标准化的 porting 接口，同时面向 ip 化编程，相同 ip 无需重复编写驱动
|
||||
- Api 少，分类清晰：dcd/hcd api、注册 api、命令回调 api
|
||||
- 代码精简，内存占用极小，同时能够达到 usb 硬件能够达到的最大带宽
|
||||
- 协议栈代码精简，内存占用极小，ip 驱动代码也做到精简，能够达到 usb 硬件理论带宽
|
||||
|
||||
其他相关链接：
|
||||
|
||||
|
||||
Reference in New Issue
Block a user