1**[English](README.md) | 简体中文** 2 3<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">CherryUSB</h1> 4<p align="center"> 5 <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg"></a> 6 <a href="https://github.com/cherry-embedded/CherryUSB/blob/master/LICENSE"><img src="https://img.shields.io/github/license/cherry-embedded/CherryUSB.svg?style=flat-square"></a> 7 <a href="https://github.com/cherry-embedded/CherryUSB/actions/workflows/deploy-docs.yml"><img src="https://github.com/cherry-embedded/CherryUSB/actions/workflows/deploy-docs.yml/badge.svg"> </a> 8 <a href="https://discord.com/invite/wFfvrSAey8"><img src="https://img.shields.io/badge/Discord-blue?logo=discord&style=flat-square"> </a> 9</p> 10 11CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统（带 USB IP）的高性能 USB 主从协议栈。 12 13 14 15## 为什么选择 CherryUSB 16 17### 易于学习 USB 18 19为了方便用户学习 USB 基本知识、枚举、驱动加载、IP 驱动，因此，编写的代码具备以下优点： 20 21- 代码精简，逻辑简单，无复杂 C 语言语法 22- 树状化编程，代码层层递进 23- Class 驱动和 porting 驱动模板化、精简化 24- API 分类清晰（从机：初始化、注册类、命令回调类、数据收发类；主机：初始化、查找类、数据收发类） 25 26### 易于使用 USB 27 28为了方便用户使用 USB 接口，考虑到用户学习过 uart 和 dma，因此，设计的数据收发类接口具备以下优点： 29 30- 等价于使用 uart tx dma/uart rx dma 31- 收发长度没有限制，用户不需要关心 USB 分包过程（分包过程在 porting 中处理） 32 33### 易于发挥 USB 性能 34 35考虑到 USB 性能问题，尽量达到 USB 硬件理论带宽，因此，设计的数据收发类接口具备以下优点： 36 37- Porting 驱动直接对接寄存器，无抽象层封装 38- Memory zero copy 39- IP 如果带 DMA 则使用 DMA 模式（DMA 带硬件分包功能） 40- 长度无限制，方便对接硬件 DMA 并且发挥 DMA 的优势 41- 分包过程在中断中执行 42 43性能展示：https://cherryusb.cherry-embedded.org/show/ 44 45## 目录结构 46 47| 目录名 | 描述 | 48|:-------------:|:-------------------------------:| 49|class | usb class 类主从驱动 | 50|common | usb spec 定义、常用宏、标准接口定义 | 51|core | usb 主从协议栈核心实现 | 52|demo | 主从 class demo | 53|docs | 文档 | 54|osal | os 封装层 | 55|platform | 其他 os 全家桶适配 | 56|port | usb 主从需要实现的 porting 接口 | 57|tools | 工具链接 | 58 59## Device 协议栈简介 60 61CherryUSB Device 协议栈对标准设备请求、CLASS 请求、VENDOR 请求以及 custom 特殊请求规范了一套统一的函数框架，采用面向对象和链表的方式，能够使得用户快速上手复合设备，不用管底层的逻辑。同时，规范了一套标准的 dcd porting 接口，用于适配不同的 USB IP，达到面向 ip 编程。 62 63CherryUSB Device 协议栈当前实现以下功能： 64 65- 支持 USB2.0 全速和高速设备（USB3.0 超高速 TODO） 66- 支持端点中断注册功能，porting 给用户自己处理中断里的数据 67- 支持复合设备 68- 支持 Communication Device Class (CDC_ACM, CDC_ECM) 69- 支持 Human Interface Device (HID) 70- 支持 Mass Storage Class (MSC) 71- 支持 USB VIDEO CLASS (UVC1.0、UVC1.5) 72- 支持 USB AUDIO CLASS (UAC1.0、UAC2.0) 73- 支持 Device Firmware Upgrade CLASS (DFU) 74- 支持 USB MIDI CLASS (MIDI) 75- 支持 Remote NDIS (RNDIS) 76- 支持 Media Transfer Protocol (MTP) 77- 支持 WINUSB1.0、WINUSB2.0、WEBUSB、BOS 78- 支持 Vendor 类 class 79- 支持 UF2 80- 支持 Android Debug Bridge (Only support shell) 81- 支持相同 USB IP 的多从机 82 83CherryUSB Device 协议栈资源占用说明（GCC 10.2 with -O2）： 84 85| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) | 86|:-------------:|:--------------:|:-------------------------:|:-------------:|:----------------:| 87|usbd_core.c | ~4500 | (512(default) + 320) * bus | 0 | 0 | 88|usbd_cdc_acm.c | ~900 | 0 | 0 | 0 | 89|usbd_msc.c | ~5000 | (128 + 512(default)) * bus | 16 * bus | 0 | 90|usbd_hid.c | ~300 | 0 | 0 | 0 | 91|usbd_audio.c | ~4000 | 0 | 0 | 0 | 92|usbd_video.c | ~7000 | 0 | 132 * bus | 0 | 93|usbd_rndis.c | ~2500 | 2 * 1580(default)+156+8 | 80 | 0 | 94|usbd_cdc_ecm.c | ~900 | 2 * 1514(default)+16 | 42 | 0 | 95|usbd_mtp.c | ~9000 | 2048(default)+128 | sizeof(struct mtp_object) * n| 0 | 96 97## Host 协议栈简介 98 99CherryUSB Host 协议栈对挂载在 root hub、外部 hub 上的设备规范了一套标准的枚举实现，对不同的 Class 类也规范了一套标准接口，用来指示在枚举后和断开连接后该 Class 驱动需要做的事情。同时，规范了一套标准的 hcd porting 接口，用于适配不同的 USB IP，达到面向 IP 编程。最后，协议栈使用 OS 管理，并提供了 osal 用来适配不同的 os。 100 101CherryUSB Host 协议栈当前实现以下功能： 102 103- 支持 low speed，full speed，high speed 和 super speed 设备 104- 自动加载支持的Class 驱动 105- 支持阻塞式传输和异步传输 106- 支持复合设备 107- 支持多级 HUB，最高可拓展到 7 级(目前测试 1拖 10 没有问题，仅支持 dwc2/ehci/xhci/rp2040) 108- 支持 Communication Device Class (CDC_ACM, CDC_ECM, CDC_NCM) 109- 支持 Human Interface Device (HID) 110- 支持 Mass Storage Class (MSC) 111- Support USB Video CLASS (UVC1.0、UVC1.5) 112- Support USB Audio CLASS (UAC1.0) 113- 支持 Remote NDIS (RNDIS) 114- 支持 USB Bluetooth (支持 nimble and zephyr bluetooth 协议栈，支持 **CLASS: 0xE0** 或者厂家自定义类，类似于 cdc acm 功能) 115- 支持 Vendor 类 class (serial, net, wifi) 116- 支持 USB modeswitch 117- 支持 Android Open Accessory 118- 支持相同 USB IP 的多主机 119 120同时，CherryUSB Host 协议栈还提供了 lsusb 的功能，借助 shell 插件可以查看所有挂载设备的信息，包括外部 hub 上的设备的信息。 121 122CherryUSB Host 协议栈资源占用说明（GCC 10.2 with -O2，关闭 log）： 123 124| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) | 125|:-------------:|:--------------:|:-------------------------------:|:---------------------------:|:------------:| 126|usbh_core.c | ~4500 | (512(default) + 8 * (1+x) *n) * bus | sizeof(struct usbh_hub) * bus | raw_config_desc | 127|usbh_hub.c | ~3500 | (32 + 4 * (1+x)) * bus | 12 + sizeof(struct usbh_hub) * x | 0 | 128|usbh_cdc_acm.c | ~600 | 7 * x | 4 + sizeof(struct usbh_cdc_acm) * x | 0 | 129|usbh_msc.c | ~2000 | 128 * x | 4 + sizeof(struct usbh_msc) * x | 0 | 130|usbh_hid.c | ~800 | 64 * x | 4 + sizeof(struct usbh_hid) * x | 0 | 131|usbh_video.c | ~5000 | 128 * x | 4 + sizeof(struct usbh_video) * x | 0 | 132|usbh_audio.c | ~4000 | 128 * x | 4 + sizeof(struct usbh_audio) * x | 0 | 133|usbh_rndis.c | ~3000 | 512 + 2 * 2048(default)| sizeof(struct usbh_rndis) * 1 | 0 | 134|usbh_cdc_ecm.c | ~1500 | 2 * 1514 + 16 | sizeof(struct usbh_cdc_ecm) * 1 | 0 | 135|usbh_cdc_ncm.c | ~2000 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_cdc_ncm) * 1| 0 | 136|usbh_bluetooth.c | ~1000 | 2 * 2048(default) | sizeof(struct usbh_bluetooth) * 1 | 0 | 137|usbh_asix.c | ~7000 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_asix) * 1 | 0 | 138|usbh_rtl8152.c | ~9000 | 16K+ 2K(default) + 2 + 32 | sizeof(struct usbh_rtl8152) * 1 | 0 | 139 140其中，`sizeof(struct usbh_hub)` 和 `sizeof(struct usbh_hubport)` 受以下宏影响： 141 142``` 143#define CONFIG_USBHOST_MAX_EXTHUBS 1 144#define CONFIG_USBHOST_MAX_EHPORTS 4 145#define CONFIG_USBHOST_MAX_INTERFACES 8 146#define CONFIG_USBHOST_MAX_INTF_ALTSETTINGS 2 147#define CONFIG_USBHOST_MAX_ENDPOINTS 4 148``` 149 150x 受以下宏影响： 151 152``` 153#define CONFIG_USBHOST_MAX_CDC_ACM_CLASS 4 154#define CONFIG_USBHOST_MAX_HID_CLASS 4 155#define CONFIG_USBHOST_MAX_MSC_CLASS 2 156#define CONFIG_USBHOST_MAX_AUDIO_CLASS 1 157#define CONFIG_USBHOST_MAX_VIDEO_CLASS 1 158``` 159 160## USB IP 支持情况 161 162仅列举标准 USB IP 和商业性 USB IP 163 164| IP | device | host | Support status | 165|:----------------:|:----------:|:--------:|:--------------:| 166| OHCI(intel) | none | OHCI | √ | 167| EHCI(intel) | none | EHCI | √ | 168| XHCI(intel) | none | XHCI | √ | 169| UHCI(intel) | none | UHCI | × | 170| DWC2(synopsys) | DWC2 | DWC2 | √ | 171| MUSB(mentor) | MUSB | MUSB | √ | 172| FOTG210(faraday)| FOTG210 | EHCI | √ | 173| CHIPIDEA(synopsys)| CHIPIDEA | EHCI | √ | 174| CDNS2(cadence) | CDNS2 | CDNS2 | √ | 175| CDNS3(cadence) | CDNS3 | XHCI | × | 176| DWC3(synopsys) | DWC3 | XHCI | × | 177 178## 文档教程 179 180CherryUSB 快速入门、USB 基本概念、API 手册、Class 基本概念和例程，参考 [CherryUSB Documentation Tutorial](https://cherryusb.readthedocs.io/)。 181 182## 视频教程 183 184CherryUSB 课程（基于 V1.4.3）：https://www.bilibili.com/cheese/play/ss707687201 。 185 186## 描述符生成工具 187 188TODO 189 190## 示例仓库 191 192| Manufacturer | CHIP or Series | USB IP| Repo Url | Support version | Note | 193|:--------------------:|:------------------:|:-----:|:--------:|:------------------:|:-------------:| 194|Bouffalolab | BL702/BL616/BL808 | bouffalolab/ehci|[bouffalo_sdk](https://github.com/CherryUSB/bouffalo_sdk)|<= latest | Official | 195|ST | STM32F1x/STM32F4/STM32H7 | fsdev/dwc2 |[stm32_repo](https://github.com/CherryUSB/cherryusb_stm32)|<= latest | Community | 196|HPMicro | HPM6000/HPM5000 | hpm/ehci |[hpm_sdk](https://github.com/CherryUSB/hpm_sdk)|<= latest | Official | 197|Essemi | ES32F36xx | musb |[es32f369_repo](https://github.com/CherryUSB/cherryusb_es32)|<= latest | Official | 198|Phytium | e2000 | pusb2/xhci |[phytium_repo](https://gitee.com/phytium_embedded/phytium-free-rtos-sdk)|>=1.4.0 | Official | 199|Artinchip | d12x/d13x/d21x | aic/ehci/ohci |[luban-lite](https://gitee.com/artinchip/luban-lite)|<= latest | Official | 200|Espressif | esp32s2/esp32s3/esp32p4 | dwc2 |[esp32_repo](https://github.com/CherryUSB/cherryusb_esp32)|<= latest | Official ongoing | 201|Kendryte | k230 | dwc2 |[k230_repo](https://github.com/CherryUSB/k230_sdk)|v1.2.0 | Official | 202|Actionstech | ATS30xx | dwc2 |[action_zephyr_repo](https://github.com/CherryUSB/lv_port_actions_technology/tree/master/action_technology_sdk)|>=1.4.0 | Official | 203|SiFli | SF32LB5x | musb |[SiFli_sdk](https://github.com/OpenSiFli/SiFli-SDK)|>=1.5.0 | Official | 204|NXP | mcx | kinetis/chipidea/ehci |[nxp_mcx_repo](https://github.com/CherryUSB/cherryusb_mcx)|<= latest | Community | 205|Nationstech | n32h4x | dwc2 |[nation_repo](https://github.com/CherryUSB/cherryusb_nation)|>=1.5.0 | Official ongoing | 206|Raspberry pi | rp2040/rp2350 | rp2040 |[pico-sdk](https://github.com/CherryUSB/pico-sdk)|<= latest | Official ongoing | 207|AllwinnerTech | F1C100S/F1C200S | musb |[cherryusb_rtt_f1c100s](https://github.com/CherryUSB/cherryusb_rtt_f1c100s)|<= latest | no more update | 208|Bekencorp | bk7256/bk7258 | musb |[bk_idk](https://github.com/CherryUSB/bk_idk)| v0.7.0 | Official | 209|Sophgo | cv18xx | dwc2 |[cvi_alios_open](https://github.com/CherryUSB/cvi_alios_open)| v0.7.0 | Official | 210|WCH | CH32V307/ch58x | ch32_usbfs/ch32_usbhs/ch58x |[wch_repo](https://github.com/CherryUSB/cherryusb_wch)|<= v0.10.2/>=v1.5.0 | no more update | 211 212## 软件包支持 213 214CherryUSB 软件包可以通过以下方式获取： 215 216- [RT-Thread](https://packages.rt-thread.org/detail.html?package=CherryUSB) 217- [YOC](https://www.xrvm.cn/document?temp=usb-host-protocol-stack-device-driver-adaptation-instructions&slug=yocbook) 218- [ESP-Registry](https://components.espressif.com/components/cherry-embedded/cherryusb) 219 220## 商业支持 221 222参考 https://cherryusb.readthedocs.io/zh-cn/latest/support/index.html 。 223 224## 联系 225 226CherryUSB QQ群：642693751 227 228CherryUSB 微信群：与我联系后邀请加入 229 230## 支持企业 231 232感谢以下企业支持（顺序不分先后）： 233 234<img src="docs/assets/bouffalolab.jpg" width="100" height="80"/> <img src="docs/assets/hpmicro.jpg" width="100" height="80" /> <img src="docs/assets/eastsoft.jpg" width="100" height="80" /> <img src="docs/assets/rtthread.jpg" width="100" height="80" /> <img src="docs/assets/sophgo.jpg" width="100" height="80" /> <img src="docs/assets/phytium.jpg" width="100" height="80" /> <img src="docs/assets/thead.jpg" width="100" height="80" /> <img src="docs/assets/nuvoton.jpg" width="100" height="80" /> <img src="docs/assets/artinchip.jpg" width="100" height="80" /> <img src="docs/assets/bekencorp.jpg" width="100" height="80" /> <img src="docs/assets/nxp.png" width="100" height="80" /> <img src="docs/assets/espressif.png" width="100" height="80" /> <img src="docs/assets/canaan.jpg" width="100" height="80" /> <img src="docs/assets/actions.jpg" width="100" height="80" /> <img src="docs/assets/sifli.jpg" width="100" height="80" /> <img src="docs/assets/nationstech.jpg" width="100" height="80" /> 235
