CherryUSB 使用指南

CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 USB 主从协议栈。同时 CherryUSB 具有以下优点：

易于学习 USB

为了方便用户学习 USB 基本知识、枚举、驱动加载、IP 驱动，因此，编写的代码具备以下优点：

  • 代码精简，逻辑简单，无复杂 C 语言语法

  • 树状化编程，代码层层递进

  • Class 驱动和 porting 驱动模板化、精简化

  • API 分类清晰（从机：初始化、注册类、命令回调类、数据收发类；主机：初始化、查找类、数据收发类）

易于使用 USB

为了方便用户使用 USB 接口，考虑到用户学习过 uart 和 dma，因此，设计的数据收发类接口具备以下优点：

  • 等价于使用 uart tx dma/uart rx dma

  • 收发长度没有限制，用户不需要关心 USB 分包过程（porting 驱动做分包过程）

易于发挥 USB 性能

考虑到 USB 性能问题，尽量达到 USB 硬件理论带宽，因此，设计的数据收发类接口具备以下优点：

  • Porting 驱动直接对接寄存器，无抽象层封装

  • Memory zero copy

  • IP 如果带 DMA 则使用 DMA 模式（DMA 带硬件分包功能）

  • 长度无限制，方便对接硬件 DMA 并且发挥 DMA 的优势

  • 分包功能在中断中处理

从机协议栈整体执行流程

_images/usbdev.svg

主机协议栈整体执行流程

_images/usbhost.svg

其他相关链接

快速上手

USB 基本知识点

API 手册

Class 指南

基本例程

Porting 说明

工具使用