update host stack readme
This commit is contained in:
25
README.md
25
README.md
@@ -32,6 +32,7 @@ USB Stack is a tiny, beautiful and portable USB host and device stack for embedd
|
|||||||
├── bouffalolab
|
├── bouffalolab
|
||||||
│ └── bl702
|
│ └── bl702
|
||||||
├── ch32
|
├── ch32
|
||||||
|
├── ehci
|
||||||
├── fsdev
|
├── fsdev
|
||||||
├── mm32
|
├── mm32
|
||||||
├── synopsys
|
├── synopsys
|
||||||
@@ -60,8 +61,8 @@ USB Device Stack has the following functions:
|
|||||||
|
|
||||||
- Support USB2.0 full and high speed
|
- Support USB2.0 full and high speed
|
||||||
- Support endpoint irq callback register by users, let users do whatever they wants in endpoint irq callback.
|
- Support endpoint irq callback register by users, let users do whatever they wants in endpoint irq callback.
|
||||||
- Support Composite class
|
- Support Compound and Composite Device
|
||||||
- Support Communication Class (CDC)
|
- Support Communication Device Class (CDC)
|
||||||
- Support Human Interface Device (HID)
|
- Support Human Interface Device (HID)
|
||||||
- Support Custom human Interface Device (HID)
|
- Support Custom human Interface Device (HID)
|
||||||
- Support Mass Storage Class (MSC)
|
- Support Mass Storage Class (MSC)
|
||||||
@@ -86,7 +87,25 @@ USB Device Stack resource usage:
|
|||||||
|
|
||||||
## USB Host Stack Overview
|
## USB Host Stack Overview
|
||||||
|
|
||||||
waiting....
|
The USB Host Stack has a standard enumeration implementation for devices mounted on roothubs and external hubs, and a standard interface for the different Class to indicate what the Class driver needs to do after enumeration and after disconnection. A standard hcd porting interface has also been standardised for adapting different USB IPs for IP-oriented programming. Finally, the protocol stack is managed using os, and provides osal to make a adaptation to different os.
|
||||||
|
|
||||||
|
How USB Host Stack is implemented, the video will be provided in future.
|
||||||
|
|
||||||
|
USB Host Stack has the following functions:
|
||||||
|
|
||||||
|
- Automatic loading of supported Class drivers
|
||||||
|
- Support blocking transfers and asynchronous transfers
|
||||||
|
- Support Compound and Composite Device
|
||||||
|
- Multi-level HUB support, expandable up to 7 levels
|
||||||
|
- Support Communication Device Class (CDC)
|
||||||
|
- Support Human Interface Device (HID)
|
||||||
|
- Support Mass Storage Class (MSC)
|
||||||
|
- Support Vendor class
|
||||||
|
- Support Andriod AOA Communication
|
||||||
|
|
||||||
|
The USB Host stack also provides the lsusb function, which allows you to view information about all mounted devices, including those on external hubs, with the help of a shell plugin.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## USB Device API
|
## USB Device API
|
||||||
|
|
||||||
|
|||||||
28
README_zh.md
28
README_zh.md
@@ -32,6 +32,7 @@ USB Stack 是一个小而美的、可移植性高的、用于嵌入式系统的
|
|||||||
├── bouffalolab
|
├── bouffalolab
|
||||||
│ └── bl702
|
│ └── bl702
|
||||||
├── ch32
|
├── ch32
|
||||||
|
├── ehci
|
||||||
├── fsdev
|
├── fsdev
|
||||||
├── mm32
|
├── mm32
|
||||||
├── synopsys
|
├── synopsys
|
||||||
@@ -42,8 +43,8 @@ USB Stack 是一个小而美的、可移植性高的、用于嵌入式系统的
|
|||||||
| 目录名 | 描述 |
|
| 目录名 | 描述 |
|
||||||
|:-------------:|:------------------------------:|
|
|:-------------:|:------------------------------:|
|
||||||
|class | usb class 类主从驱动 |
|
|class | usb class 类主从驱动 |
|
||||||
|common | usb spec 定义和一些常用函数 |
|
|common | usb spec 定义、常用宏、标准接口定义 |
|
||||||
|core | usb 主从核心实现 |
|
|core | usb 主从协议栈核心实现 |
|
||||||
|demo | 示例 |
|
|demo | 示例 |
|
||||||
|docs | 文档 |
|
|docs | 文档 |
|
||||||
|osal | os 封装层 |
|
|osal | os 封装层 |
|
||||||
@@ -60,8 +61,8 @@ USB Device 协议栈当前实现以下功能:
|
|||||||
|
|
||||||
- 支持 USB2.0 全速和高速设备
|
- 支持 USB2.0 全速和高速设备
|
||||||
- 支持端点中断注册功能,porting 给用户自己处理中断里的数据
|
- 支持端点中断注册功能,porting 给用户自己处理中断里的数据
|
||||||
- 支持复合设备
|
- 支持复合设备和组合设备
|
||||||
- 支持 Communication Class (CDC)
|
- 支持 Communication Device Class (CDC)
|
||||||
- 支持 Human Interface Device (HID)
|
- 支持 Human Interface Device (HID)
|
||||||
- 支持 Custom human Interface Device (HID)
|
- 支持 Custom human Interface Device (HID)
|
||||||
- 支持 Mass Storage Class (MSC)
|
- 支持 Mass Storage Class (MSC)
|
||||||
@@ -86,7 +87,24 @@ USB Device 协议栈资源占用说明:
|
|||||||
|
|
||||||
## USB Host 协议栈简介
|
## USB Host 协议栈简介
|
||||||
|
|
||||||
waiting....
|
USB Host 协议栈对挂载在 roothub、外部 hub 上的设备规范了一套标准的枚举实现,对不同的 Class 类也规范了一套标准接口,用来指示在枚举后和断开连接后该 Class 驱动需要做的事情。同时,规范了一套标准的 hcd porting 接口,用于适配不同的 USB IP,达到面向 IP 编程。最后,协议栈使用 OS 管理,并提供了 osal 用来适配不同的 os。
|
||||||
|
|
||||||
|
USB Host 协议栈的代码实现过程参考:视频后续发布。
|
||||||
|
|
||||||
|
USB Host 协议栈当前实现以下功能:
|
||||||
|
|
||||||
|
- 自动加载支持的Class 驱动
|
||||||
|
- 支持阻塞式传输和异步传输
|
||||||
|
- 支持复合设备和组合设备
|
||||||
|
- 支持多级 HUB,最高可拓展到 7 级
|
||||||
|
- 支持 Communication Device Class (CDC)
|
||||||
|
- 支持 Human Interface Device (HID)
|
||||||
|
- 支持 Mass Storage Class (MSC)
|
||||||
|
- 支持安卓 AOA Communication
|
||||||
|
|
||||||
|
同时,USB Host 协议栈还提供了 lsusb 的功能,借助 shell 插件可以查看所有挂载设备的信息,包括外部 hub 上的设备的信息。
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## USB Device API
|
## USB Device API
|
||||||
|
|
||||||
|
|||||||
BIN
docs/img/lsusb.png
Normal file
BIN
docs/img/lsusb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
Reference in New Issue
Block a user