complete doc outline

This commit is contained in:
sakumisu
2022-02-15 21:07:42 +08:00
parent 9f44549ac5
commit 97a80a599c
60 changed files with 1880 additions and 8 deletions

Binary file not shown.

Binary file not shown.

BIN
docs/_build/doctrees/porting.doctree vendored Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
docs/_build/html/_images/1.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/_build/html/_images/2.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

BIN
docs/_build/html/_images/3.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

View File

@@ -17,6 +17,14 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
quick_start/ch32v307
quick_start/rt-thread/rt-thread_zh
.. toctree::
:maxdepth: 1
:caption: USB 基本知识点
usb/usb_basic
usb/usb_desc
usb/usb_request
usb/usb_enum
.. toctree::
:maxdepth: 1
:caption: API 手册
@@ -46,3 +54,9 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
demo/video
demo/speaker_mic
demo/daplink
.. toctree::
:maxdepth: 1
:caption: Porting 说明
porting

View File

@@ -0,0 +1,2 @@
Porting 编写说明
==============================

View File

@@ -139,7 +139,9 @@ int main(void)
![CDC Device Demo](img/rtt_cdc_demo.png)
- host demo
![USB Host Demo](img/rtt_host_demo.png)
![USB Host Demo1](img/1.png)
![USB Host Demo2](img/2.png)
![USB Host Demo3](img/3.png)
### 视频教程

View File

@@ -0,0 +1,88 @@
USB 基本概念
===========================
本文主要对 USB 官方 usb2.0.pdf 中提供的第七章、第八章、第九章进行讲解。
简介
---------
USB 信号状态
-----------------
USB 连接与断开检测
---------------------
USB 速度识别
---------------------
USB 设备状态
---------------------
USB 编码与位填充
---------------------
USB 字段(域)
---------------------
同步字段
^^^^^^^^^^^^^^^^^^^^^^^^
包标识符字段
^^^^^^^^^^^^^^^^^^^^^^^^
地址字段
^^^^^^^^^^^^^^^^^^^^^^^^
帧号字段
^^^^^^^^^^^^^^^^^^^^^^^^
数据字段
^^^^^^^^^^^^^^^^^^^^^^^^
CRC 字段
^^^^^^^^^^^^^^^^^^^^^^^^
USB 包
---------------------
令牌包
^^^^^^^^^^^^^^^^^^^^^^^^
数据包
^^^^^^^^^^^^^^^^^^^^^^^^
握手包
^^^^^^^^^^^^^^^^^^^^^^^^
特殊数据包
^^^^^^^^^^^^^^^^^^^^^^^^
USB 事务
---------------------
SETUP 事务
^^^^^^^^^^^^^^^^^^^^^^^^
IN 事务
^^^^^^^^^^^^^^^^^^^^^^^^
OUT 事务
^^^^^^^^^^^^^^^^^^^^^^^^
特殊事务
^^^^^^^^^^^^^^^^^^^^^^^^
USB 传输
---------------------
控制传输
^^^^^^^^^^^^^^^^^^^^^^^^
批量传输
^^^^^^^^^^^^^^^^^^^^^^^^
中断传输
^^^^^^^^^^^^^^^^^^^^^^^^
同步传输
^^^^^^^^^^^^^^^^^^^^^^^^

View File

@@ -0,0 +1,2 @@
USB 描述符
===========================

View File

@@ -0,0 +1,2 @@
USB 枚举
===========================

View File

@@ -0,0 +1,2 @@
USB 设备请求
===========================

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -43,7 +43,7 @@
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="next" title="主机协议栈" href="api_host.html" />
<link rel="prev" title="基于 RT-Thread 软件包开发指南" href="../quick_start/rt-thread/rt-thread_zh.html" />
<link rel="prev" title="USB 枚举" href="../usb/usb_enum.html" />
</head>
<body class="wy-body-for-nav">
@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">设备协议栈</a><ul>
@@ -129,6 +136,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>
@@ -230,7 +241,7 @@
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="api_host.html" class="btn btn-neutral float-right" title="主机协议栈" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../quick_start/rt-thread/rt-thread_zh.html" class="btn btn-neutral float-left" title="基于 RT-Thread 软件包开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
<a href="../usb/usb_enum.html" class="btn btn-neutral float-left" title="USB 枚举" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>
<hr/>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="api_device.html">设备协议栈</a></li>
@@ -129,6 +136,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -42,6 +42,7 @@
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="next" title="Porting 编写说明" href="../porting.html" />
<link rel="prev" title="USB 双通道扬声器和麦克风" href="speaker_mic.html" />
</head>
@@ -94,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -118,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>
@@ -194,6 +206,7 @@
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../porting.html" class="btn btn-neutral float-right" title="Porting 编写说明" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="speaker_mic.html" class="btn btn-neutral float-left" title="USB 双通道扬声器和麦克风" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -93,6 +93,13 @@
<li class="toctree-l1"><a class="reference internal" href="quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/api_device.html">设备协议栈</a></li>
@@ -117,6 +124,10 @@
<li class="toctree-l1"><a class="reference internal" href="demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -94,6 +94,13 @@
<li class="toctree-l1"><a class="reference internal" href="quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/api_device.html">设备协议栈</a></li>
@@ -118,6 +125,10 @@
<li class="toctree-l1"><a class="reference internal" href="demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="porting.html">Porting 编写说明</a></li>
</ul>
@@ -206,6 +217,15 @@
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_enum.html">USB 枚举</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/api_device.html">设备协议栈</a></li>
@@ -235,6 +255,12 @@
<li class="toctree-l1"><a class="reference internal" href="demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="porting.html">Porting 编写说明</a></li>
</ul>
</div>
</div>

Binary file not shown.

249
docs/_build/html/porting.html vendored Normal file
View File

@@ -0,0 +1,249 @@
<!DOCTYPE html>
<html class="writer-html5" lang="zh-CN" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Porting 编写说明 &mdash; CherryUSB 使用指南 文档</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/translations.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="prev" title="DAPLINK V2.0调试器" href="demo/daplink.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> CherryUSB 使用指南
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="在文档中搜索" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">快速入门</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick_start/bl702.html">基于 BL702 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start/stm32f429.html">基于 STM32F429 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/api_device.html">设备协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/api_host.html">主机协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/api_common.html">其他</a></li>
</ul>
<p class="caption"><span class="caption-text">Class 指南</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="class/class_cdc.html">CDC</a></li>
<li class="toctree-l1"><a class="reference internal" href="class/class_hid.html">HID</a></li>
<li class="toctree-l1"><a class="reference internal" href="class/class_msc.html">MSC</a></li>
<li class="toctree-l1"><a class="reference internal" href="class/class_audio.html">UAC</a></li>
<li class="toctree-l1"><a class="reference internal" href="class/class_video.html">UVC</a></li>
<li class="toctree-l1"><a class="reference internal" href="class/winusb.html">WINUSB</a></li>
</ul>
<p class="caption"><span class="caption-text">综合例程</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="demo/usb2uart.html">USB 转串口</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/mouse_keyboard.html">键盘与鼠标</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/msc_boot.html">U盘制作 BootLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/video.html">USB 摄像头</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Porting 编写说明</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">CherryUSB 使用指南</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Porting 编写说明</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/porting.rst.txt" rel="nofollow"> 查看页面源码</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="porting">
<h1>Porting 编写说明<a class="headerlink" href="#porting" title="永久链接至标题"></a></h1>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="demo/daplink.html" class="btn btn-neutral float-left" title="DAPLINK V2.0调试器" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 版权所有 2022, sakumisu.
</p>
</div>
利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建,使用了
<a href="https://github.com/readthedocs/sphinx_rtd_theme">主题</a>
<a href="https://readthedocs.org">Read the Docs</a>开发.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -93,6 +93,13 @@
<li class="toctree-l1"><a class="reference internal" href="../ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api/api_device.html">设备协议栈</a></li>
@@ -117,6 +124,10 @@
<li class="toctree-l1"><a class="reference internal" href="../../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -42,7 +42,7 @@
<link rel="index" title="索引" href="../../genindex.html" />
<link rel="search" title="搜索" href="../../search.html" />
<link rel="next" title="设备协议栈" href="../../api/api_device.html" />
<link rel="next" title="USB 基本概念" href="../../usb/usb_basic.html" />
<link rel="prev" title="基于 CH32V307 开发指南" href="../ch32v307.html" />
</head>
@@ -104,6 +104,13 @@
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api/api_device.html">设备协议栈</a></li>
@@ -128,6 +135,10 @@
<li class="toctree-l1"><a class="reference internal" href="../../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../porting.html">Porting 编写说明</a></li>
</ul>
@@ -330,7 +341,9 @@
<ul class="simple">
<li><p>host demo</p></li>
</ul>
<p><img alt="USB Host Demo" src="../../_images/rtt_host_demo.png" /></p>
<p><img alt="USB Host Demo1" src="../../_images/1.png" />
<img alt="USB Host Demo2" src="../../_images/2.png" />
<img alt="USB Host Demo3" src="../../_images/3.png" /></p>
</div>
<div class="section" id="id1">
<h3>视频教程<a class="headerlink" href="#id1" title="永久链接至标题"></a></h3>
@@ -345,7 +358,7 @@
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../../api/api_device.html" class="btn btn-neutral float-right" title="设备协议栈" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../../usb/usb_basic.html" class="btn btn-neutral float-right" title="USB 基本概念" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../ch32v307.html" class="btn btn-neutral float-left" title="基于 CH32V307 开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>

View File

@@ -95,6 +95,13 @@
<li class="toctree-l1"><a class="reference internal" href="ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
@@ -119,6 +126,10 @@
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>

View File

@@ -96,6 +96,13 @@
<li class="toctree-l1"><a class="reference internal" href="quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb/usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/api_device.html">设备协议栈</a></li>
@@ -120,6 +127,10 @@
<li class="toctree-l1"><a class="reference internal" href="demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="porting.html">Porting 编写说明</a></li>
</ul>

File diff suppressed because one or more lines are too long

374
docs/_build/html/usb/usb_basic.html vendored Normal file
View File

@@ -0,0 +1,374 @@
<!DOCTYPE html>
<html class="writer-html5" lang="zh-CN" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>USB 基本概念 &mdash; CherryUSB 使用指南 文档</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="next" title="USB 描述符" href="usb_desc.html" />
<link rel="prev" title="基于 RT-Thread 软件包开发指南" href="../quick_start/rt-thread/rt-thread_zh.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> CherryUSB 使用指南
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="在文档中搜索" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">快速入门</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/bl702.html">基于 BL702 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/stm32f429.html">基于 STM32F429 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">USB 基本概念</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">简介</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">USB 信号状态</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">USB 连接与断开检测</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id4">USB 速度识别</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id5">USB 设备状态</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id6">USB 编码与位填充</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id7">USB 字段(域)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id8">同步字段</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">包标识符字段</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">地址字段</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id11">帧号字段</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">数据字段</a></li>
<li class="toctree-l3"><a class="reference internal" href="#crc">CRC 字段</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id13">USB 包</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id14">令牌包</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">数据包</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id16">握手包</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id17">特殊数据包</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id18">USB 事务</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#setup">SETUP 事务</a></li>
<li class="toctree-l3"><a class="reference internal" href="#in">IN 事务</a></li>
<li class="toctree-l3"><a class="reference internal" href="#out">OUT 事务</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">特殊事务</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id20">USB 传输</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id21">控制传输</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id22">批量传输</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id23">中断传输</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id24">同步传输</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_host.html">主机协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_common.html">其他</a></li>
</ul>
<p class="caption"><span class="caption-text">Class 指南</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
</ul>
<p class="caption"><span class="caption-text">综合例程</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../demo/usb2uart.html">USB 转串口</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/mouse_keyboard.html">键盘与鼠标</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/msc_boot.html">U盘制作 BootLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/video.html">USB 摄像头</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CherryUSB 使用指南</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>USB 基本概念</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/usb/usb_basic.rst.txt" rel="nofollow"> 查看页面源码</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="usb">
<h1>USB 基本概念<a class="headerlink" href="#usb" title="永久链接至标题"></a></h1>
<p>本文主要对 USB 官方 usb2.0.pdf 中提供的第七章、第八章、第九章进行讲解。</p>
<div class="section" id="id1">
<h2>简介<a class="headerlink" href="#id1" title="永久链接至标题"></a></h2>
</div>
<div class="section" id="id2">
<h2>USB 信号状态<a class="headerlink" href="#id2" title="永久链接至标题"></a></h2>
</div>
<div class="section" id="id3">
<h2>USB 连接与断开检测<a class="headerlink" href="#id3" title="永久链接至标题"></a></h2>
</div>
<div class="section" id="id4">
<h2>USB 速度识别<a class="headerlink" href="#id4" title="永久链接至标题"></a></h2>
</div>
<div class="section" id="id5">
<h2>USB 设备状态<a class="headerlink" href="#id5" title="永久链接至标题"></a></h2>
</div>
<div class="section" id="id6">
<h2>USB 编码与位填充<a class="headerlink" href="#id6" title="永久链接至标题"></a></h2>
</div>
<div class="section" id="id7">
<h2>USB 字段(域)<a class="headerlink" href="#id7" title="永久链接至标题"></a></h2>
<div class="section" id="id8">
<h3>同步字段<a class="headerlink" href="#id8" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id9">
<h3>包标识符字段<a class="headerlink" href="#id9" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id10">
<h3>地址字段<a class="headerlink" href="#id10" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id11">
<h3>帧号字段<a class="headerlink" href="#id11" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id12">
<h3>数据字段<a class="headerlink" href="#id12" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="crc">
<h3>CRC 字段<a class="headerlink" href="#crc" title="永久链接至标题"></a></h3>
</div>
</div>
<div class="section" id="id13">
<h2>USB 包<a class="headerlink" href="#id13" title="永久链接至标题"></a></h2>
<div class="section" id="id14">
<h3>令牌包<a class="headerlink" href="#id14" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id15">
<h3>数据包<a class="headerlink" href="#id15" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id16">
<h3>握手包<a class="headerlink" href="#id16" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id17">
<h3>特殊数据包<a class="headerlink" href="#id17" title="永久链接至标题"></a></h3>
</div>
</div>
<div class="section" id="id18">
<h2>USB 事务<a class="headerlink" href="#id18" title="永久链接至标题"></a></h2>
<div class="section" id="setup">
<h3>SETUP 事务<a class="headerlink" href="#setup" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="in">
<h3>IN 事务<a class="headerlink" href="#in" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="out">
<h3>OUT 事务<a class="headerlink" href="#out" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id19">
<h3>特殊事务<a class="headerlink" href="#id19" title="永久链接至标题"></a></h3>
</div>
</div>
<div class="section" id="id20">
<h2>USB 传输<a class="headerlink" href="#id20" title="永久链接至标题"></a></h2>
<div class="section" id="id21">
<h3>控制传输<a class="headerlink" href="#id21" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id22">
<h3>批量传输<a class="headerlink" href="#id22" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id23">
<h3>中断传输<a class="headerlink" href="#id23" title="永久链接至标题"></a></h3>
</div>
<div class="section" id="id24">
<h3>同步传输<a class="headerlink" href="#id24" title="永久链接至标题"></a></h3>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="usb_desc.html" class="btn btn-neutral float-right" title="USB 描述符" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../quick_start/rt-thread/rt-thread_zh.html" class="btn btn-neutral float-left" title="基于 RT-Thread 软件包开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 版权所有 2022, sakumisu.
</p>
</div>
利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建,使用了
<a href="https://github.com/readthedocs/sphinx_rtd_theme">主题</a>
<a href="https://readthedocs.org">Read the Docs</a>开发.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

251
docs/_build/html/usb/usb_desc.html vendored Normal file
View File

@@ -0,0 +1,251 @@
<!DOCTYPE html>
<html class="writer-html5" lang="zh-CN" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>USB 描述符 &mdash; CherryUSB 使用指南 文档</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="next" title="USB 设备请求" href="usb_request.html" />
<link rel="prev" title="USB 基本概念" href="usb_basic.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> CherryUSB 使用指南
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="在文档中搜索" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">快速入门</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/bl702.html">基于 BL702 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/stm32f429.html">基于 STM32F429 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_host.html">主机协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_common.html">其他</a></li>
</ul>
<p class="caption"><span class="caption-text">Class 指南</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
</ul>
<p class="caption"><span class="caption-text">综合例程</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../demo/usb2uart.html">USB 转串口</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/mouse_keyboard.html">键盘与鼠标</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/msc_boot.html">U盘制作 BootLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/video.html">USB 摄像头</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CherryUSB 使用指南</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>USB 描述符</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/usb/usb_desc.rst.txt" rel="nofollow"> 查看页面源码</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="usb">
<h1>USB 描述符<a class="headerlink" href="#usb" title="永久链接至标题"></a></h1>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="usb_request.html" class="btn btn-neutral float-right" title="USB 设备请求" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="usb_basic.html" class="btn btn-neutral float-left" title="USB 基本概念" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 版权所有 2022, sakumisu.
</p>
</div>
利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建,使用了
<a href="https://github.com/readthedocs/sphinx_rtd_theme">主题</a>
<a href="https://readthedocs.org">Read the Docs</a>开发.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

251
docs/_build/html/usb/usb_enum.html vendored Normal file
View File

@@ -0,0 +1,251 @@
<!DOCTYPE html>
<html class="writer-html5" lang="zh-CN" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>USB 枚举 &mdash; CherryUSB 使用指南 文档</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="next" title="设备协议栈" href="../api/api_device.html" />
<link rel="prev" title="USB 设备请求" href="usb_request.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> CherryUSB 使用指南
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="在文档中搜索" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">快速入门</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/bl702.html">基于 BL702 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/stm32f429.html">基于 STM32F429 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_request.html">USB 设备请求</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_host.html">主机协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_common.html">其他</a></li>
</ul>
<p class="caption"><span class="caption-text">Class 指南</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
</ul>
<p class="caption"><span class="caption-text">综合例程</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../demo/usb2uart.html">USB 转串口</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/mouse_keyboard.html">键盘与鼠标</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/msc_boot.html">U盘制作 BootLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/video.html">USB 摄像头</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CherryUSB 使用指南</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>USB 枚举</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/usb/usb_enum.rst.txt" rel="nofollow"> 查看页面源码</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="usb">
<h1>USB 枚举<a class="headerlink" href="#usb" title="永久链接至标题"></a></h1>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../api/api_device.html" class="btn btn-neutral float-right" title="设备协议栈" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="usb_request.html" class="btn btn-neutral float-left" title="USB 设备请求" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 版权所有 2022, sakumisu.
</p>
</div>
利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建,使用了
<a href="https://github.com/readthedocs/sphinx_rtd_theme">主题</a>
<a href="https://readthedocs.org">Read the Docs</a>开发.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

251
docs/_build/html/usb/usb_request.html vendored Normal file
View File

@@ -0,0 +1,251 @@
<!DOCTYPE html>
<html class="writer-html5" lang="zh-CN" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>USB 设备请求 &mdash; CherryUSB 使用指南 文档</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="next" title="USB 枚举" href="usb_enum.html" />
<link rel="prev" title="USB 描述符" href="usb_desc.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> CherryUSB 使用指南
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="在文档中搜索" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">快速入门</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/bl702.html">基于 BL702 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/stm32f429.html">基于 STM32F429 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/ch32v307.html">基于 CH32V307 开发指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/rt-thread/rt-thread_zh.html">基于 RT-Thread 软件包开发指南</a></li>
</ul>
<p class="caption"><span class="caption-text">USB 基本知识点</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="usb_basic.html">USB 基本概念</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_desc.html">USB 描述符</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">USB 设备请求</a></li>
<li class="toctree-l1"><a class="reference internal" href="usb_enum.html">USB 枚举</a></li>
</ul>
<p class="caption"><span class="caption-text">API 手册</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_host.html">主机协议栈</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/api_common.html">其他</a></li>
</ul>
<p class="caption"><span class="caption-text">Class 指南</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
</ul>
<p class="caption"><span class="caption-text">综合例程</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../demo/usb2uart.html">USB 转串口</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/mouse_keyboard.html">键盘与鼠标</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/msc_boot.html">U盘制作 BootLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/video.html">USB 摄像头</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/speaker_mic.html">USB 双通道扬声器和麦克风</a></li>
<li class="toctree-l1"><a class="reference internal" href="../demo/daplink.html">DAPLINK V2.0调试器</a></li>
</ul>
<p class="caption"><span class="caption-text">Porting 说明</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting 编写说明</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CherryUSB 使用指南</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>USB 设备请求</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/usb/usb_request.rst.txt" rel="nofollow"> 查看页面源码</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="usb">
<h1>USB 设备请求<a class="headerlink" href="#usb" title="永久链接至标题"></a></h1>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="usb_enum.html" class="btn btn-neutral float-right" title="USB 枚举" accesskey="n" rel="next">下一页 <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="usb_desc.html" class="btn btn-neutral float-left" title="USB 描述符" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> 上一页</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 版权所有 2022, sakumisu.
</p>
</div>
利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建,使用了
<a href="https://github.com/readthedocs/sphinx_rtd_theme">主题</a>
<a href="https://readthedocs.org">Read the Docs</a>开发.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@@ -17,6 +17,14 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
quick_start/ch32v307
quick_start/rt-thread/rt-thread_zh
.. toctree::
:maxdepth: 1
:caption: USB 基本知识点
usb/usb_basic
usb/usb_desc
usb/usb_request
usb/usb_enum
.. toctree::
:maxdepth: 1
:caption: API 手册
@@ -46,3 +54,9 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
demo/video
demo/speaker_mic
demo/daplink
.. toctree::
:maxdepth: 1
:caption: Porting 说明
porting

2
docs/porting.rst Normal file
View File

@@ -0,0 +1,2 @@
Porting 编写说明
==============================

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

View File

@@ -139,7 +139,9 @@ int main(void)
![CDC Device Demo](img/rtt_cdc_demo.png)
- host demo
![USB Host Demo](img/rtt_host_demo.png)
![USB Host Demo1](img/1.png)
![USB Host Demo2](img/2.png)
![USB Host Demo3](img/3.png)
### 视频教程

88
docs/usb/usb_basic.rst Normal file
View File

@@ -0,0 +1,88 @@
USB 基本概念
===========================
本文主要对 USB 官方 usb2.0.pdf 中提供的第七章、第八章、第九章进行讲解。
简介
---------
USB 信号状态
-----------------
USB 连接与断开检测
---------------------
USB 速度识别
---------------------
USB 设备状态
---------------------
USB 编码与位填充
---------------------
USB 字段(域)
---------------------
同步字段
^^^^^^^^^^^^^^^^^^^^^^^^
包标识符字段
^^^^^^^^^^^^^^^^^^^^^^^^
地址字段
^^^^^^^^^^^^^^^^^^^^^^^^
帧号字段
^^^^^^^^^^^^^^^^^^^^^^^^
数据字段
^^^^^^^^^^^^^^^^^^^^^^^^
CRC 字段
^^^^^^^^^^^^^^^^^^^^^^^^
USB 包
---------------------
令牌包
^^^^^^^^^^^^^^^^^^^^^^^^
数据包
^^^^^^^^^^^^^^^^^^^^^^^^
握手包
^^^^^^^^^^^^^^^^^^^^^^^^
特殊数据包
^^^^^^^^^^^^^^^^^^^^^^^^
USB 事务
---------------------
SETUP 事务
^^^^^^^^^^^^^^^^^^^^^^^^
IN 事务
^^^^^^^^^^^^^^^^^^^^^^^^
OUT 事务
^^^^^^^^^^^^^^^^^^^^^^^^
特殊事务
^^^^^^^^^^^^^^^^^^^^^^^^
USB 传输
---------------------
控制传输
^^^^^^^^^^^^^^^^^^^^^^^^
批量传输
^^^^^^^^^^^^^^^^^^^^^^^^
中断传输
^^^^^^^^^^^^^^^^^^^^^^^^
同步传输
^^^^^^^^^^^^^^^^^^^^^^^^

2
docs/usb/usb_desc.rst Normal file
View File

@@ -0,0 +1,2 @@
USB 描述符
===========================

2
docs/usb/usb_enum.rst Normal file
View File

@@ -0,0 +1,2 @@
USB 枚举
===========================

2
docs/usb/usb_request.rst Normal file
View File

@@ -0,0 +1,2 @@
USB 设备请求
===========================