Skip to content

Latest commit

 

History

History
154 lines (120 loc) · 8.98 KB

README_zh.md

File metadata and controls

154 lines (120 loc) · 8.98 KB
Raw

CherryUSB

English

CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统(带 USB ip)的 USB 主从协议栈。

CherryUSB

为什么选择

  • 代码精简，并且内存占用极小，详细参考下面表格，而且还可进一步的裁剪
  • 全面的 class 驱动，并且主从 class 驱动全部模板化，方便用户增加新的 class 驱动以及学习的时候查找规律
  • 可供用户使用的 API 非常少，并且分类清晰。从机：初始化 + 注册类、命令回调类、数据收发类；主机：初始化 + 查找类、数据收发类
  • 树状化编程，代码层层递进，方便用户理清函数调用关系、枚举和 class 驱动加载过程
  • 标准化的 porting 接口，相同 ip 无需重写驱动，并且 porting 驱动也进行了模板化，方便用户新增 porting。
  • 主从收发接口的使用等价于 uart tx/rx dma 的使用，长度也没有限制
  • 能够达到 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 全速和高速设备，USB3.0 超速设备
  • 支持端点中断注册功能，porting 给用户自己处理中断里的数据
  • 支持复合设备
  • 支持 Communication Device Class (CDC)
  • 支持 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)
  • 支持 Remote NDIS (RNDIS)
  • 支持 WINUSB1.0、WINUSB2.0(带 BOS )
  • 支持 Vendor 类 class

CherryUSB Device 协议栈资源占用说明（GCC 10.2 with -O2）：

file FLASH (Byte) No Cache RAM (Byte) RAM (Byte) Heap (Byte)
usbd_core.c 3263 384 17 0
usbd_cdc.c 490 0 0 0
usbd_msc.c 2772 128 + 512(default) 16 0
usbd_hid.c 501 0 0 0
usbd_audio.c 1208 0 4 0
usbd_video.c 2272 0 82 0

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)
  • Support USB Video CLASS
  • Support USB Audio CLASS
  • 支持 Remote NDIS (RNDIS)
  • 支持 Vendor 类 class

同时，CherryUSB Host 协议栈还提供了 lsusb 的功能，借助 shell 插件可以查看所有挂载设备的信息，包括外部 hub 上的设备的信息。

CherryUSB Host 协议栈资源占用说明（GCC 10.2 with -O2）：

file FLASH (Byte) No Cache RAM (Byte) RAM (Byte) Heap (Byte)
usbh_core.c 4417 512 28 sizeof(struct usbh_urb)
usbh_hub.c 4895 32 + 4* (1+n) 16 + sizeof(struct usbh_hub) * (1+n) 0
usbh_cdc_acm.c 1064 7 4 sizeof(struct usbh_cdc_acm) * x
usbh_msc.c 1776 32 4 sizeof(struct usbh_msc) * x
usbh_hid.c 922 128 4 sizeof(struct usbh_hid) * x
usbh_video.c 3592 128 4 sizeof(struct usbh_video) * x
usbh_audio.c 3230 128 4 sizeof(struct usbh_audio) * x

其中，sizeof(struct usbh_hub) 和 sizeof(struct usbh_hubport) 受以下宏影响：

#define CONFIG_USBHOST_MAX_EXTHUBS          1
#define CONFIG_USBHOST_MAX_EHPORTS          4
#define CONFIG_USBHOST_MAX_INTERFACES       6
#define CONFIG_USBHOST_MAX_INTF_ALTSETTINGS 1
#define CONFIG_USBHOST_MAX_ENDPOINTS        4

文档教程

CherryUSB 快速入门、USB 基本概念，API 手册，Class 基本概念和例程，参考 CherryUSB 文档教程

视频教程

USB 基本知识点与 CherryUSB Device 协议栈是如何编写的，参考 CherryUSB Device 协议栈教程.

图形化界面配置工具

chryusb_configurator 采用 electron + vite2 + ts 框架编写，当前用于自动化生成描述符数组，后续会增加其他功能。

示例仓库

注意：0.4.1 版本以后 dcd 驱动进行了重构，部分仓库不做长期维护，所以如果使用高版本需要自行更新

厂商 芯片或者系列 USB IP 仓库链接 对应 master 版本
Bouffalolab BL702/BL616/BL808 bouffalolab/ehci bl_mcu_sdk latest
ST STM32F103C8T6 fsdev stm32f103_repo latest
ST STM32F4 dwc2 stm32f429_device_repo stm32f429_host_repo latest
ST STM32H7 dwc2 stm32h743_device_repo stm32h743_host_repo latest
HPMicro HPM6750 hpm/ehci hpm_repo v0.7.0
Essemi ES32F36xx musb es32f369_repo latest
AllwinnerTech F1C100S musb cherryusb_rtt_f1c100s latest
Phytium e2000 xhci phytium _repo latest
Raspberry pi rp2040 rp2040 rp2040_repo latest
WCH CH32V307/ch58x ch32_usbfs/ch32_usbhs/ch58x wch_repo latest
Nordicsemi Nrf52840 nrf5x nrf5x_repo latest
Nuvoton Nuc442 nuvoton nuc442_repo v0.4.1
Geehy APM32E10x APM32F0xx fsdev apm32_repo v0.4.1
Espressif esp32 dwc2 esp32_repo v0.4.1

Contact

QQ 群:642693751