2022-02-14 22:39:17 +08:00
|
|
|
|
.. CherryUSB 使用指南 documentation master file, created by
|
|
|
|
|
|
sphinx-quickstart on Thu Nov 21 10:50:33 2019.
|
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
|
|
|
|
|
|
CherryUSB 使用指南
|
|
|
|
|
|
======================================================
|
|
|
|
|
|
|
2022-05-02 23:08:57 +08:00
|
|
|
|
CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 USB 主从协议栈。同时 CherryUSB 具有以下优点：
|
2022-02-14 22:39:17 +08:00
|
|
|
|
|
2022-07-03 22:14:23 +08:00
|
|
|
|
- 比较全面的 class 驱动，并且 class 驱动全部模板化，方便学习和自主添加
|
|
|
|
|
|
- 树状化编程，方便理清 class 驱动与接口、端点的关系，hub、port、class 之间的关系；代码层层递进，调用关系一目了然，方便理清 usb 枚举过程和 class 驱动加载
|
2022-07-28 21:25:29 +08:00
|
|
|
|
- 设备协议栈使用等价于 uart tx/rx dma 的使用，主机协议栈的使用等价于文件的使用
|
2022-07-03 22:14:23 +08:00
|
|
|
|
- 标准化的 porting 接口，同时面向 ip 化编程，相同 ip 无需重复编写驱动
|
|
|
|
|
|
- Api 少，分类清晰：dcd/hcd api、注册 api、命令回调 api
|
2022-07-28 21:25:29 +08:00
|
|
|
|
- 协议栈代码精简，内存占用极小，ip 驱动代码也做到精简，能够达到 usb 硬件理论带宽
|
2022-04-16 21:17:56 +08:00
|
|
|
|
|
2022-05-02 23:08:57 +08:00
|
|
|
|
其他相关链接：
|
2022-04-16 21:17:56 +08:00
|
|
|
|
|
2022-05-02 23:08:57 +08:00
|
|
|
|
- **从机协议栈视频教程** https://www.bilibili.com/video/BV1Ef4y1t73d
|
|
|
|
|
|
- **主机协议栈视频教程** TODO
|
|
|
|
|
|
- **github** https://github.com/sakumisu/CherryUSB
|
2022-04-10 18:05:49 +08:00
|
|
|
|
|
2022-02-14 22:39:17 +08:00
|
|
|
|
.. toctree::
|
2022-04-04 22:33:06 +08:00
|
|
|
|
:maxdepth: 1
|
2022-03-26 21:36:56 +08:00
|
|
|
|
:caption: 快速上手
|
2022-02-14 22:39:17 +08:00
|
|
|
|
|
|
|
|
|
|
quick_start/bl702
|
2022-06-26 11:34:27 +08:00
|
|
|
|
quick_start/stm32
|
|
|
|
|
|
quick_start/es32
|
2022-04-16 21:17:56 +08:00
|
|
|
|
quick_start/rt-thread/rtthread
|
2022-04-04 22:33:06 +08:00
|
|
|
|
quick_start/other_chip
|
2022-02-14 22:39:17 +08:00
|
|
|
|
|
2022-02-15 21:07:42 +08:00
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: USB 基本知识点
|
|
|
|
|
|
|
2022-07-13 22:46:24 +08:00
|
|
|
|
usb/usb2.0_basic
|
|
|
|
|
|
usb/usb3.0_basic
|
2022-02-15 21:07:42 +08:00
|
|
|
|
usb/usb_desc
|
|
|
|
|
|
usb/usb_request
|
|
|
|
|
|
usb/usb_enum
|
2022-05-14 22:50:27 +08:00
|
|
|
|
|
2022-02-14 22:39:17 +08:00
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: API 手册
|
|
|
|
|
|
|
|
|
|
|
|
api/api_device
|
|
|
|
|
|
api/api_host
|
2022-05-14 22:50:27 +08:00
|
|
|
|
api/api_port
|
2022-02-14 22:39:17 +08:00
|
|
|
|
api/api_common
|
2022-05-14 22:50:27 +08:00
|
|
|
|
api/api_config
|
2022-02-14 22:39:17 +08:00
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: Class 指南
|
|
|
|
|
|
|
|
|
|
|
|
class/class_cdc
|
|
|
|
|
|
class/class_hid
|
|
|
|
|
|
class/class_msc
|
|
|
|
|
|
class/class_audio
|
|
|
|
|
|
class/class_video
|
|
|
|
|
|
class/winusb
|
|
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 综合例程
|
|
|
|
|
|
|
|
|
|
|
|
demo/usb2uart
|
|
|
|
|
|
demo/mouse_keyboard
|
|
|
|
|
|
demo/msc_boot
|
|
|
|
|
|
demo/video
|
|
|
|
|
|
demo/speaker_mic
|
|
|
|
|
|
demo/daplink
|
2022-02-15 21:07:42 +08:00
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: Porting 说明
|
|
|
|
|
|
|
|
|
|
|
|
porting
|
2022-04-23 18:41:05 +08:00
|
|
|
|
porting_usbip
|
2022-05-28 22:36:29 +08:00
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 工具使用
|
|
|
|
|
|
|
|
|
|
|
|
tools/index
|
