克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

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 全速和高速设备
  • 支持端点中断注册功能,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 sizeof(struct usbh_hub) * (1+n) 16 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 bouffalolab bl_mcu_sdk latest
Essemi ES32F36xx musb es32f369_repo latest
AllwinnerTech F1C100S musb cherryusb_rtt_f1c100s 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.6.0
Phytium e2000 xhci phytium _repo latest
Raspberry pi rp2040 rp2040 rp2040_repo latest
WCH CH32V307/ch58x ch32_usbfs/ch32_usbhs/ch58x wch_repo latest
WCH CH32V307 ch32_usbfs/ch32_usbhs ch32v307_repo v0.6.0
WCH CH57x ch58x ch57x_repo v0.4.1
Nuvoton Nuc442 nuvoton nuc442_repo v0.4.1
Geehy APM32E10x APM32F0xx fsdev apm32_repo v0.4.1
Nordicsemi Nrf52840 nrf5x nrf5x_repo latest
Espressif esp32 dwc2 esp32_repo v0.4.1
Mindmotion MM32L3xx mm32 mm32_repo v0.4.1

Contact

QQ 群:642693751

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化