105 lines
4.4 KiB
Markdown
105 lines
4.4 KiB
Markdown
# CherryUSB
|
||
|
||
[English](./README.md)
|
||
|
||
CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统(带 USB ip)的 USB 主从协议栈。
|
||
|
||
|
||
|
||
## 为什么选择
|
||
|
||
- 面向 ip 编程，相同 usb ip 驱动无需重复编写，仅需实现不相同的部分
|
||
- 代码树状化编写，轻松理解 usb 概念、枚举过程、class 驱动加载
|
||
- Class 驱动模板化，轻松实现复合设备和自定义添加驱动
|
||
- 将 usb 的复杂传输简单化，使得用户能够像 uart、dma 一样轻松使用 usb
|
||
- 少量的目录结构，少量的 api，少量的 codesize，极致的 usb 带宽
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
.
|
||
├── class
|
||
├── common
|
||
├── core
|
||
├── demo
|
||
├── docs
|
||
├── osal
|
||
├── packet capture
|
||
└── port
|
||
└── tools
|
||
```
|
||
|
||
| 目录名 | 描述 |
|
||
|:-------------:|:------------------------------:|
|
||
|class | usb class 类主从驱动 |
|
||
|common | usb spec 定义、常用宏、标准接口定义 |
|
||
|core | usb 主从协议栈核心实现 |
|
||
|demo | 示例 |
|
||
|docs | 文档 |
|
||
|osal | os 封装层 |
|
||
|packet capture | 抓包文件（需要使用力科软件打开）|
|
||
|port | usb 主从需要实现的 porting 接口 |
|
||
|tools | 工具链接 |
|
||
|
||
## Device 协议栈简介
|
||
|
||
CherryUSB Device 协议栈对标准设备请求、CLASS 请求、VENDOR 请求以及 custom 特殊请求规范了一套统一的函数框架，采用面向对象和链表的方式，能够使得用户快速上手复合设备，不用管底层的逻辑。同时，规范了一套标准的 dcd porting 接口，用于适配不同的 USB IP，达到面向 ip 编程。
|
||
|
||
CherryUSB Device 协议栈当前实现以下功能：
|
||
|
||
- 支持 USB2.0 全速和高速设备
|
||
- 支持端点中断注册功能，porting 给用户自己处理中断里的数据
|
||
- 支持复合设备
|
||
- 支持 Communication Device Class (CDC)
|
||
- 支持 Human Interface Device (HID)
|
||
- 支持 Custom human Interface Device (HID)
|
||
- 支持 Mass Storage Class (MSC)
|
||
- 支持 USB VIDEO CLASS (UVC1.0、UVC1.5)
|
||
- 支持 USB AUDIO CLASS (UAC1.0、UAC2.0)
|
||
- 支持 Device Firmware Upgrade CLASS (DFU)
|
||
- 支持 USB MIDI CLASS (MIDI)
|
||
- 支持 Test and Measurement CLASS (TMC)
|
||
- 支持 Remote NDIS (RNDIS)
|
||
- 支持 WINUSB1.0、WINUSB2.0(带 BOS )
|
||
- 支持 Vendor 类 class
|
||
|
||
CherryUSB Device 协议栈资源占用说明（GCC 10.2 with -O2）：
|
||
|
||
| file | FLASH (Byte) | RAM (Byte) |
|
||
|:-----------:|:--------------:|:------------:|
|
||
|usbd_core.c | 3045 | 373 |
|
||
|usbd_cdc.c | 302 | 20 |
|
||
|usbd_msc.c | 2452 | 132 |
|
||
|usbd_hid.c | 784 | 201 |
|
||
|usbd_audio.c | 438 | 14 |
|
||
|usbd_video.c | 402 | 4 |
|
||
|
||
## Host 协议栈简介
|
||
|
||
CherryUSB Host 协议栈对挂载在 roothub、外部 hub 上的设备规范了一套标准的枚举实现，对不同的 Class 类也规范了一套标准接口，用来指示在枚举后和断开连接后该 Class 驱动需要做的事情。同时，规范了一套标准的 hcd porting 接口，用于适配不同的 USB IP，达到面向 IP 编程。最后，协议栈使用 OS 管理，并提供了 osal 用来适配不同的 os。
|
||
|
||
CherryUSB Host 协议栈当前实现以下功能：
|
||
|
||
- 自动加载支持的Class 驱动
|
||
- 支持阻塞式传输和异步传输
|
||
- 支持复合设备
|
||
- 支持多级 HUB,最高可拓展到 7 级
|
||
- 支持 Communication Device Class (CDC)
|
||
- 支持 Human Interface Device (HID)
|
||
- 支持 Mass Storage Class (MSC)
|
||
- 支持 Remote NDIS (RNDIS)
|
||
- 支持 Vendor 类 class
|
||
|
||
同时，CherryUSB Host 协议栈还提供了 lsusb 的功能，借助 shell 插件可以查看所有挂载设备的信息，包括外部 hub 上的设备的信息。
|
||
|
||
## 文档教程
|
||
|
||
CherryUSB 快速入门、USB 基本概念，API 手册，Class 基本概念和例程，参考 [CherryUSB 文档教程](https://cherryusb.readthedocs.io/)
|
||
|
||
## 视频教程
|
||
|
||
USB 基本知识点与 CherryUSB Device 协议栈是如何编写的，参考 [CherryUSB Device 协议栈教程](https://www.bilibili.com/video/BV1Ef4y1t73d).
|
||
|
||
## 图形化界面配置工具
|
||
|
||
[chryusb_configurator](https://github.com/Egahp/chryusb_configurator) 采用 **electron + vite2 + ts** 框架编写，当前用于自动化生成描述符数组，后续会增加其他功能。 |