1# CherryUSB 2 3[English](./README.md) 4 5CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统(带 USB IP)的 USB 主从协议栈。 6 7 8 9## 为什么选择 10 11### 易于学习 USB 12 13为了方便用户学习 USB 基本知识、枚举、驱动加载、IP 驱动，因此，编写的代码具备以下优点： 14 15- 代码精简，逻辑简单，无复杂 C 语言语法 16- 树状化编程，代码层层递进 17- Class 驱动和 porting 驱动模板化、精简化 18- API 分类清晰（从机：初始化、注册类、命令回调类、数据收发类；主机：初始化、查找类、数据收发类） 19 20### 易于使用 USB 21 22为了方便用户使用 USB 接口，考虑到用户学习过 uart 和 dma，因此，设计的数据收发类接口具备以下优点： 23 24- 等价于使用 uart tx dma/uart rx dma 25- 收发长度没有限制，用户不需要关心 USB 分包过程（porting 驱动做分包过程） 26 27### 易于发挥 USB 性能 28 29考虑到 USB 性能问题，尽量达到 USB 硬件理论带宽，因此，设计的数据收发类接口具备以下优点： 30 31- Porting 驱动直接对接寄存器，无抽象层封装 32- Memory zero copy 33- IP 如果带 DMA 则使用 DMA 模式（DMA 带硬件分包功能） 34- 长度无限制，方便对接硬件 DMA 并且发挥 DMA 的优势 35- 分包功能在中断中处理 36 37## 目录结构 38 39``` 40. 41├── class 42├── common 43├── core 44├── demo 45├── docs 46├── osal 47└── port 48└── tools 49``` 50 51| 目录名 | 描述 | 52|:-------------:|:-------------------------------:| 53|class | usb class 类主从驱动 | 54|common | usb spec 定义、常用宏、标准接口定义 | 55|core | usb 主从协议栈核心实现 | 56|demo | 示例 | 57|docs | 文档 | 58|osal | os 封装层 | 59|port | usb 主从需要实现的 porting 接口 | 60|tools | 工具链接 | 61 62## Device 协议栈简介 63 64CherryUSB Device 协议栈对标准设备请求、CLASS 请求、VENDOR 请求以及 custom 特殊请求规范了一套统一的函数框架，采用面向对象和链表的方式，能够使得用户快速上手复合设备，不用管底层的逻辑。同时，规范了一套标准的 dcd porting 接口，用于适配不同的 USB IP，达到面向 ip 编程。 65 66CherryUSB Device 协议栈当前实现以下功能： 67 68- 支持 USB2.0 全速和高速设备，USB3.0 超速设备 69- 支持端点中断注册功能，porting 给用户自己处理中断里的数据 70- 支持复合设备 71- 支持 Communication Device Class (CDC) 72- 支持 Human Interface Device (HID) 73- 支持 Mass Storage Class (MSC) 74- 支持 USB VIDEO CLASS (UVC1.0、UVC1.5) 75- 支持 USB AUDIO CLASS (UAC1.0、UAC2.0) 76- 支持 Device Firmware Upgrade CLASS (DFU) 77- 支持 USB MIDI CLASS (MIDI) 78- 支持 Remote NDIS (RNDIS) 79- 支持 WINUSB1.0、WINUSB2.0(带 BOS ) 80- 支持 Vendor 类 class 81 82CherryUSB Device 协议栈资源占用说明（GCC 10.2 with -O2）： 83 84| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) | 85|:-------------:|:--------------:|:-------------------------:|:-------------:|:----------------:| 86|usbd_core.c | 3516 | 256(default) + 320 | 0 | 0 | 87|usbd_cdc.c | 392 | 0 | 0 | 0 | 88|usbd_msc.c | 2839 | 128 + 512(default) | 16 | 0 | 89|usbd_hid.c | 364 | 0 | 0 | 0 | 90|usbd_audio.c | 1455 | 0 | 0 | 0 | 91|usbd_video.c | 2494 | 0 | 84 | 0 | 92|usbd_rndis.c | 2109 | 3340 | 76 | 0 | 93 94## Host 协议栈简介 95 96CherryUSB Host 协议栈对挂载在 roothub、外部 hub 上的设备规范了一套标准的枚举实现，对不同的 Class 类也规范了一套标准接口，用来指示在枚举后和断开连接后该 Class 驱动需要做的事情。同时，规范了一套标准的 hcd porting 接口，用于适配不同的 USB IP，达到面向 IP 编程。最后，协议栈使用 OS 管理，并提供了 osal 用来适配不同的 os。 97 98CherryUSB Host 协议栈当前实现以下功能： 99 100- 自动加载支持的Class 驱动 101- 支持阻塞式传输和异步传输 102- 支持复合设备 103- 支持多级 HUB,最高可拓展到 7 级 104- 支持 Communication Device Class (CDC) 105- 支持 Human Interface Device (HID) 106- 支持 Mass Storage Class (MSC) 107- Support USB Video CLASS 108- Support USB Audio CLASS 109- 支持 Remote NDIS (RNDIS) 110- 支持 Vendor 类 class 111 112同时，CherryUSB Host 协议栈还提供了 lsusb 的功能，借助 shell 插件可以查看所有挂载设备的信息，包括外部 hub 上的设备的信息。 113 114CherryUSB Host 协议栈资源占用说明（GCC 10.2 with -O2）： 115 116| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) | 117|:-------------:|:--------------:|:-------------------------------:|:---------------------------:|:-------------------------------:| 118|usbh_core.c | 4237 | 512 + 8 * (1+x) *n | 28 | sizeof(struct usbh_urb) | 119|usbh_hub.c | 2919 | 32 + 4* (1+x) | 12 + sizeof(struct usbh_hub) * (1+x) | 0 | 120|usbh_cdc_acm.c | 1099 | 7 | 4 + sizeof(struct usbh_cdc_acm) * x | 0 | 121|usbh_msc.c | 2502 | 32 | 4 + sizeof(struct usbh_msc) * x | 0 | 122|usbh_hid.c | 956 | 128 | 4 + sizeof(struct usbh_hid) * x | 0 | 123|usbh_video.c | 2330 | 128 | 4 + sizeof(struct usbh_video) * x | 0 | 124|usbh_audio.c | 3168 | 128 | 4 + sizeof(struct usbh_audio) * x | 0 | 125|usbh_rndis.c | 3030 | 4096 | 4 + sizeof(struct usbh_rndis) * x | 0 | 126 127其中，`sizeof(struct usbh_hub)` 和 `sizeof(struct usbh_hubport)` 受以下宏影响： 128 129``` 130#define CONFIG_USBHOST_MAX_EXTHUBS 1 131#define CONFIG_USBHOST_MAX_EHPORTS 4 132#define CONFIG_USBHOST_MAX_INTERFACES 6 133#define CONFIG_USBHOST_MAX_INTF_ALTSETTINGS 1 134#define CONFIG_USBHOST_MAX_ENDPOINTS 4 135``` 136 137x 受以下宏影响： 138 139``` 140#define CONFIG_USBHOST_MAX_CDC_ACM_CLASS 4 141#define CONFIG_USBHOST_MAX_HID_CLASS 4 142#define CONFIG_USBHOST_MAX_MSC_CLASS 2 143#define CONFIG_USBHOST_MAX_AUDIO_CLASS 1 144#define CONFIG_USBHOST_MAX_VIDEO_CLASS 1 145#define CONFIG_USBHOST_MAX_RNDIS_CLASS 1 146 147``` 148 149## 文档教程 150 151CherryUSB 快速入门、USB 基本概念，API 手册，Class 基本概念和例程，参考 [CherryUSB 文档教程](https://cherryusb.readthedocs.io/) 152 153## 视频教程 154 155USB 基本知识点与 CherryUSB Device 协议栈是如何编写的，参考 [CherryUSB Device 协议栈教程](https://www.bilibili.com/video/BV1Ef4y1t73d). 156 157## 图形化界面配置工具 158 159[chryusb_configurator](https://github.com/Egahp/chryusb_configurator) 采用 **electron + vite2 + ts** 框架编写，当前用于自动化生成描述符数组，后续会增加其他功能。 160 161## 示例仓库 162 163| 厂商 | 芯片或者系列 | USB IP| 仓库链接 | 当前版本 | 164|:--------------------:|:------------------:|:-----:|:--------:|:---------------------------:| 165|Bouffalolab | BL702/BL616/BL808 | bouffalolab/ehci|[bouffalo_sdk](https://github.com/CherryUSB/cherryusb_bouffalolab)| v0.10.1 | 166|ST | STM32F1x | fsdev |[stm32_repo](https://github.com/CherryUSB/cherryusb_stm32)|≤ v0.10.1 | 167|ST | STM32F4/STM32H7 | dwc2 |[stm32_repo](https://github.com/CherryUSB/cherryusb_stm32)|≤ v0.10.1 | 168|HPMicro | HPM6750 | hpm/ehci |[hpm_sdk](https://github.com/CherryUSB/cherryusb_hpmicro)| v0.10.1 | 169|Essemi | ES32F36xx | musb |[es32f369_repo](https://github.com/CherryUSB/cherryusb_es32)|≤ v0.10.1 | 170|AllwinnerTech | F1C100S/F1C200S | musb |[cherryusb_rtt_f1c100s](https://github.com/CherryUSB/cherryusb_rtt_f1c100s)|≤ v0.10.1 | 171|Phytium | e2000 | xhci |[phytium_repo](https://gitee.com/phytium_embedded/phytium-free-rtos-sdk)|v0.9.0 | 172|Raspberry pi | rp2040 | rp2040 |[pico-examples](https://github.com/CherryUSB/pico-examples)|≤ v0.10.1 | 173|WCH | CH32V307/ch58x | ch32_usbfs/ch32_usbhs/ch58x |[wch_repo](https://github.com/CherryUSB/cherryusb_wch)|≤ v0.10.1 | 174|Nordicsemi | Nrf52840 | nrf5x |[nrf5x_repo](https://github.com/CherryUSB/cherryusb_nrf5x)|≤ v0.10.1 | 175|Espressif | esp32s3 | dwc2 |[esp32_repo](https://github.com/CherryUSB/cherryusb_esp32)|≤ v0.10.1 | 176|Bekencorp | BK72xx | musb |[armino](https://github.com/CherryUSB/armino)|v0.7.0 | 177|Sophgo | cv18xx | dwc2 |[cvi_alios_open](https://github.com/CherryUSB/cvi_alios_open)|v0.7.0 | 178 179## Contact 180 181QQ 群:642693751
