diff options
| author | sakumisu <[email protected]> | 2022-02-15 21:07:42 +0800 |
|---|---|---|
| committer | sakumisu <[email protected]> | 2022-02-15 21:07:42 +0800 |
| commit | 97a80a599c04e852e3e57ce2dc758aeeb32e24d5 (patch) | |
| tree | 36c57ff880ca3cb1a173f73997f6376dec81993c | |
| parent | 9f44549ac5cb46719310910f9195a6b27fe6bcfe (diff) | |
complete doc outline
60 files changed, 1880 insertions, 8 deletions
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle Binary files differindex 88c1c2a5..34fde38f 100644 --- a/docs/_build/doctrees/environment.pickle +++ b/docs/_build/doctrees/environment.pickle diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree Binary files differindex c70a2ee4..9e5649aa 100644 --- a/docs/_build/doctrees/index.doctree +++ b/docs/_build/doctrees/index.doctree diff --git a/docs/_build/doctrees/porting.doctree b/docs/_build/doctrees/porting.doctree Binary files differnew file mode 100644 index 00000000..3fc2c4a0 --- /dev/null +++ b/docs/_build/doctrees/porting.doctree diff --git a/docs/_build/doctrees/quick_start/rt-thread/rt-thread_zh.doctree b/docs/_build/doctrees/quick_start/rt-thread/rt-thread_zh.doctree Binary files differindex 65d5baf7..c1738de9 100644 --- a/docs/_build/doctrees/quick_start/rt-thread/rt-thread_zh.doctree +++ b/docs/_build/doctrees/quick_start/rt-thread/rt-thread_zh.doctree diff --git a/docs/_build/doctrees/usb/usb_basic.doctree b/docs/_build/doctrees/usb/usb_basic.doctree Binary files differnew file mode 100644 index 00000000..d0524317 --- /dev/null +++ b/docs/_build/doctrees/usb/usb_basic.doctree diff --git a/docs/_build/doctrees/usb/usb_desc.doctree b/docs/_build/doctrees/usb/usb_desc.doctree Binary files differnew file mode 100644 index 00000000..b6dc914c --- /dev/null +++ b/docs/_build/doctrees/usb/usb_desc.doctree diff --git a/docs/_build/doctrees/usb/usb_enum.doctree b/docs/_build/doctrees/usb/usb_enum.doctree Binary files differnew file mode 100644 index 00000000..868b9c2a --- /dev/null +++ b/docs/_build/doctrees/usb/usb_enum.doctree diff --git a/docs/_build/doctrees/usb/usb_request.doctree b/docs/_build/doctrees/usb/usb_request.doctree Binary files differnew file mode 100644 index 00000000..f57724a3 --- /dev/null +++ b/docs/_build/doctrees/usb/usb_request.doctree diff --git a/docs/_build/html/_images/1.png b/docs/_build/html/_images/1.png Binary files differnew file mode 100644 index 00000000..5176a02c --- /dev/null +++ b/docs/_build/html/_images/1.png diff --git a/docs/_build/html/_images/2.png b/docs/_build/html/_images/2.png Binary files differnew file mode 100644 index 00000000..29d30734 --- /dev/null +++ b/docs/_build/html/_images/2.png diff --git a/docs/_build/html/_images/3.png b/docs/_build/html/_images/3.png Binary files differnew file mode 100644 index 00000000..82bb35ff --- /dev/null +++ b/docs/_build/html/_images/3.png diff --git a/docs/_build/html/_images/rtt_host_demo.png b/docs/_build/html/_images/rtt_host_demo.png Binary files differdeleted file mode 100644 index c8fc41f1..00000000 --- a/docs/_build/html/_images/rtt_host_demo.png +++ /dev/null diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt index a097f8d0..36890796 100644 --- a/docs/_build/html/_sources/index.rst.txt +++ b/docs/_build/html/_sources/index.rst.txt @@ -19,6 +19,14 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 .. toctree:: :maxdepth: 1 + :caption: USB 基本知识点 + + usb/usb_basic + usb/usb_desc + usb/usb_request + usb/usb_enum +.. toctree:: + :maxdepth: 1 :caption: API 手册 api/api_device @@ -46,3 +54,9 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 demo/video demo/speaker_mic demo/daplink + +.. toctree:: + :maxdepth: 1 + :caption: Porting 说明 + + porting diff --git a/docs/_build/html/_sources/porting.rst.txt b/docs/_build/html/_sources/porting.rst.txt new file mode 100644 index 00000000..869fddcd --- /dev/null +++ b/docs/_build/html/_sources/porting.rst.txt @@ -0,0 +1,2 @@ +Porting 编写说明 +==============================
\ No newline at end of file diff --git a/docs/_build/html/_sources/quick_start/rt-thread/rt-thread_zh.md.txt b/docs/_build/html/_sources/quick_start/rt-thread/rt-thread_zh.md.txt index fa038aaf..561f657d 100644 --- a/docs/_build/html/_sources/quick_start/rt-thread/rt-thread_zh.md.txt +++ b/docs/_build/html/_sources/quick_start/rt-thread/rt-thread_zh.md.txt @@ -139,7 +139,9 @@ int main(void)  - host demo - + + + ### 视频教程 diff --git a/docs/_build/html/_sources/usb/usb_basic.rst.txt b/docs/_build/html/_sources/usb/usb_basic.rst.txt new file mode 100644 index 00000000..c2528795 --- /dev/null +++ b/docs/_build/html/_sources/usb/usb_basic.rst.txt @@ -0,0 +1,88 @@ +USB 基本概念 +=========================== + +本文主要对 USB 官方 usb2.0.pdf 中提供的第七章、第八章、第九章进行讲解。 + +简介 +--------- + +USB 信号状态 +----------------- + +USB 连接与断开检测 +--------------------- + +USB 速度识别 +--------------------- + +USB 设备状态 +--------------------- + +USB 编码与位填充 +--------------------- + +USB 字段(域) +--------------------- + +同步字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +包标识符字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +地址字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +帧号字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +数据字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +CRC 字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +USB 包 +--------------------- + +令牌包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +数据包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +握手包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +特殊数据包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +USB 事务 +--------------------- + +SETUP 事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +IN 事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +OUT 事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +特殊事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +USB 传输 +--------------------- + +控制传输 +^^^^^^^^^^^^^^^^^^^^^^^^ + +批量传输 +^^^^^^^^^^^^^^^^^^^^^^^^ + +中断传输 +^^^^^^^^^^^^^^^^^^^^^^^^ + +同步传输 +^^^^^^^^^^^^^^^^^^^^^^^^
\ No newline at end of file diff --git a/docs/_build/html/_sources/usb/usb_desc.rst.txt b/docs/_build/html/_sources/usb/usb_desc.rst.txt new file mode 100644 index 00000000..25e4b08e --- /dev/null +++ b/docs/_build/html/_sources/usb/usb_desc.rst.txt @@ -0,0 +1,2 @@ +USB 描述符 +===========================
\ No newline at end of file diff --git a/docs/_build/html/_sources/usb/usb_enum.rst.txt b/docs/_build/html/_sources/usb/usb_enum.rst.txt new file mode 100644 index 00000000..e15d68c1 --- /dev/null +++ b/docs/_build/html/_sources/usb/usb_enum.rst.txt @@ -0,0 +1,2 @@ +USB 枚举 +===========================
\ No newline at end of file diff --git a/docs/_build/html/_sources/usb/usb_request.rst.txt b/docs/_build/html/_sources/usb/usb_request.rst.txt new file mode 100644 index 00000000..8ee9121a --- /dev/null +++ b/docs/_build/html/_sources/usb/usb_request.rst.txt @@ -0,0 +1,2 @@ +USB 设备请求 +===========================
\ No newline at end of file diff --git a/docs/_build/html/api/api_common.html b/docs/_build/html/api/api_common.html index 4367a2c6..052b5fe8 100644 --- a/docs/_build/html/api/api_common.html +++ b/docs/_build/html/api/api_common.html @@ -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> diff --git a/docs/_build/html/api/api_device.html b/docs/_build/html/api/api_device.html index ff409c5b..e6d8c8ec 100644 --- a/docs/_build/html/api/api_device.html +++ b/docs/_build/html/api/api_device.html @@ -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/> diff --git a/docs/_build/html/api/api_host.html b/docs/_build/html/api/api_host.html index 8b023c9f..fd989b32 100644 --- a/docs/_build/html/api/api_host.html +++ b/docs/_build/html/api/api_host.html @@ -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> diff --git a/docs/_build/html/class/class_audio.html b/docs/_build/html/class/class_audio.html index 8b83301c..94cc7e72 100644 --- a/docs/_build/html/class/class_audio.html +++ b/docs/_build/html/class/class_audio.html @@ -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> diff --git a/docs/_build/html/class/class_cdc.html b/docs/_build/html/class/class_cdc.html index cb932897..ecc3ad20 100644 --- a/docs/_build/html/class/class_cdc.html +++ b/docs/_build/html/class/class_cdc.html @@ -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> diff --git a/docs/_build/html/class/class_hid.html b/docs/_build/html/class/class_hid.html index aea1378a..8b04cba3 100644 --- a/docs/_build/html/class/class_hid.html +++ b/docs/_build/html/class/class_hid.html @@ -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> diff --git a/docs/_build/html/class/class_msc.html b/docs/_build/html/class/class_msc.html index cfc51b89..74706141 100644 --- a/docs/_build/html/class/class_msc.html +++ b/docs/_build/html/class/class_msc.html @@ -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> diff --git a/docs/_build/html/class/class_video.html b/docs/_build/html/class/class_video.html index 62cc655f..30422dc2 100644 --- a/docs/_build/html/class/class_video.html +++ b/docs/_build/html/class/class_video.html @@ -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> diff --git a/docs/_build/html/class/winusb.html b/docs/_build/html/class/winusb.html index c12aae5d..21e47e9e 100644 --- a/docs/_build/html/class/winusb.html +++ b/docs/_build/html/class/winusb.html @@ -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> diff --git a/docs/_build/html/demo/daplink.html b/docs/_build/html/demo/daplink.html index 18bc67fe..3e830138 100644 --- a/docs/_build/html/demo/daplink.html +++ b/docs/_build/html/demo/daplink.html @@ -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> diff --git a/docs/_build/html/demo/mouse_keyboard.html b/docs/_build/html/demo/mouse_keyboard.html index 5aa9fd2a..1a2fac7f 100644 --- a/docs/_build/html/demo/mouse_keyboard.html +++ b/docs/_build/html/demo/mouse_keyboard.html @@ -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> diff --git a/docs/_build/html/demo/msc_boot.html b/docs/_build/html/demo/msc_boot.html index caeeb5ac..ee810b02 100644 --- a/docs/_build/html/demo/msc_boot.html +++ b/docs/_build/html/demo/msc_boot.html @@ -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> diff --git a/docs/_build/html/demo/speaker_mic.html b/docs/_build/html/demo/speaker_mic.html index e598c61f..eb39ec28 100644 --- a/docs/_build/html/demo/speaker_mic.html +++ b/docs/_build/html/demo/speaker_mic.html @@ -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> diff --git a/docs/_build/html/demo/usb2uart.html b/docs/_build/html/demo/usb2uart.html index 66fe014b..7f9cc870 100644 --- a/docs/_build/html/demo/usb2uart.html +++ b/docs/_build/html/demo/usb2uart.html @@ -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> diff --git a/docs/_build/html/demo/video.html b/docs/_build/html/demo/video.html index cee5488d..99d3fff0 100644 --- a/docs/_build/html/demo/video.html +++ b/docs/_build/html/demo/video.html @@ -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> diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index fcaa8bfb..0fddf452 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -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> diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 04520910..1be46280 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -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> diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv Binary files differindex b23f2f6e..d11a5453 100644 --- a/docs/_build/html/objects.inv +++ b/docs/_build/html/objects.inv diff --git a/docs/_build/html/porting.html b/docs/_build/html/porting.html new file mode 100644 index 00000000..138b7fb8 --- /dev/null +++ b/docs/_build/html/porting.html @@ -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 编写说明 — 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> »</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> + © 版权所有 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>
\ No newline at end of file diff --git a/docs/_build/html/quick_start/bl702.html b/docs/_build/html/quick_start/bl702.html index 11002f9e..9bc7e3fa 100644 --- a/docs/_build/html/quick_start/bl702.html +++ b/docs/_build/html/quick_start/bl702.html @@ -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> diff --git a/docs/_build/html/quick_start/ch32v307.html b/docs/_build/html/quick_start/ch32v307.html index 4e9645f1..f361952b 100644 --- a/docs/_build/html/quick_start/ch32v307.html +++ b/docs/_build/html/quick_start/ch32v307.html @@ -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> diff --git a/docs/_build/html/quick_start/rt-thread/rt-thread.html b/docs/_build/html/quick_start/rt-thread/rt-thread.html index dc5f4976..792eb8bb 100644 --- a/docs/_build/html/quick_start/rt-thread/rt-thread.html +++ b/docs/_build/html/quick_start/rt-thread/rt-thread.html @@ -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> diff --git a/docs/_build/html/quick_start/rt-thread/rt-thread_zh.html b/docs/_build/html/quick_start/rt-thread/rt-thread_zh.html index d0326d34..83358842 100644 --- a/docs/_build/html/quick_start/rt-thread/rt-thread_zh.html +++ b/docs/_build/html/quick_start/rt-thread/rt-thread_zh.html @@ -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> diff --git a/docs/_build/html/quick_start/stm32f429.html b/docs/_build/html/quick_start/stm32f429.html index c5e44578..d336b451 100644 --- a/docs/_build/html/quick_start/stm32f429.html +++ b/docs/_build/html/quick_start/stm32f429.html @@ -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> diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index b64d9840..a1580421 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -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> diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 33720f59..ac990277 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["api/api_common","api/api_device","api/api_host","class/class_audio","class/class_cdc","class/class_hid","class/class_msc","class/class_video","class/winusb","demo/daplink","demo/mouse_keyboard","demo/msc_boot","demo/speaker_mic","demo/usb2uart","demo/video","index","quick_start/bl702","quick_start/ch32v307","quick_start/rt-thread/rt-thread","quick_start/rt-thread/rt-thread_zh","quick_start/stm32f429"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["api\\api_common.rst","api\\api_device.rst","api\\api_host.rst","class\\class_audio.rst","class\\class_cdc.rst","class\\class_hid.rst","class\\class_msc.rst","class\\class_video.rst","class\\winusb.rst","demo\\daplink.rst","demo\\mouse_keyboard.rst","demo\\msc_boot.rst","demo\\speaker_mic.rst","demo\\usb2uart.rst","demo\\video.rst","index.rst","quick_start\\bl702.rst","quick_start\\ch32v307.rst","quick_start\\rt-thread\\rt-thread.md","quick_start\\rt-thread\\rt-thread_zh.md","quick_start\\stm32f429.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x31":[18,19],"0x32":[18,19],"0x33":[18,19],"0x34":[18,19],"0x35":[18,19],"0x81":[18,19],"10":[18,19],"48mhz":[18,19],"500":[18,19],"class":[18,19],"for":[18,19],"function":18,"if":18,"in":18,"int":[18,19],"null":[18,19],"void":[18,19],"while":[18,19],"with":[18,19],__hal_rcc_usb_clk_en:[18,19],abov:18,acm:[18,19],also:18,and:[18,19],as:18,audio:[18,19],bl702:15,board:[18,19],bootload:15,bsp:[18,19],by:18,call:18,callback:18,can:18,cdc:[15,19],cdc_init:[18,19],ch32v307:15,cherryusb:[18,19],clock:[18,19],code:[18,19],config:[18,19],configur:[18,19],connect:[18,19],copi:18,cubemx_config:[18,19],daplink:15,data_buff:[18,19],dc:18,defin:19,demo:15,descriptor:18,devic:15,dfu:[18,19],directori:18,embed:[18,19],enabl:[18,19],endpoint:18,english:19,exampl:[18,19],extern:[18,19],file:18,firstli:18,follow:18,free:19,from:18,fs:[18,19],fsdev:19,gener:[18,19],get_pin:19,global:19,go:18,hal:[18,19],hal_nvic_enableirq:[18,19],hal_nvic_setprior:[18,19],hal_pcd_mspinit:[18,19],have:18,hc:19,hcd:19,hid:[15,18,19],host:15,how:18,hs:[18,19],hub:[18,19],implement:18,includ:19,init:[18,19],interfac:18,interrupt:[18,19],into:18,ioc:[18,19],ip:[18,19],irq:18,is:18,it:18,know:18,kprintf:18,latest:[18,19],led0:19,led0_pin:19,level:18,libc:19,like:18,list:18,ll:19,low:18,main:[18,19],malloc:19,manag:18,menuconfig:19,mode:[18,19],modifi:18,msc:[15,18,19],mx:18,name:18,need:18,note:18,now:18,nvic:[18,19],onli:19,onlin:[18,19],open:18,option:[18,19],or:18,otg:[18,19],output:19,packag:19,path:18,pcd:18,peripher:[18,19],ph10:19,pin:19,pin_high:19,pin_low:19,pin_mode_output:19,pleas:18,port:19,portabl:[18,19],printf:[18,19],problem:18,project:18,provid:18,refer:18,regist:18,rt:15,rt_pin_mod:19,rt_pin_writ:19,rt_thread_mdelai:[18,19],rtdevic:19,rtthread:19,same:18,see:18,select:18,seri:18,set:[18,19],should:18,so:18,some:18,specif:18,speed:[18,19],stack:[18,19],stdio:19,step:18,stm32:15,stm32cubemx:[18,19],stm32f0:[18,19],stm32f1:[18,19],stm32f3:[18,19],stm32f429:15,stm32f4:[18,19],stm32f4xx_hal:19,stm32f7:[18,19],stm32h7:19,suffix:18,synopsi:[18,19],system:[18,19],systemclock:[18,19],that:18,the:[18,19],then:18,thi:18,thread:15,tini:[18,19],to:[18,19],two:18,uac:15,uint8_t:[18,19],usb:15,usb_dc_init:[18,19],usb_dc_low_level_init:[18,19],usb_lp_can1_rx0_irqn:[18,19],usbd_ep_writ:[18,19],usbh_cor:19,usbh_initi:19,util:18,uvc:15,v2:15,version:[18,19],video:19,we:18,winusb:15,xxx:19,you:18,your:18},titles:["\u5176\u4ed6","\u8bbe\u5907\u534f\u8bae\u6808","\u4e3b\u673a\u534f\u8bae\u6808","UAC","CDC","HID","MSC","UVC","WINUSB","DAPLINK V2.0\u8c03\u8bd5\u5668","\u952e\u76d8\u4e0e\u9f20\u6807","U\u76d8\u5236\u4f5c BootLoader","USB \u53cc\u901a\u9053\u626c\u58f0\u5668\u548c\u9ea6\u514b\u98ce","USB \u8f6c\u4e32\u53e3","USB \u6444\u50cf\u5934","CherryUSB \u4f7f\u7528\u6307\u5357","\u57fa\u4e8e BL702 \u5f00\u53d1\u6307\u5357","\u57fa\u4e8e CH32V307 \u5f00\u53d1\u6307\u5357","RT-Thread based Software Package Development Guide","\u57fa\u4e8e RT-Thread \u8f6f\u4ef6\u5305\u5f00\u53d1\u6307\u5357","\u57fa\u4e8e STM32F429 \u5f00\u53d1\u6307\u5357"],titleterms:{"class":15,api:15,audio:[1,2],base:18,bl702:16,bootload:11,cdc:[1,2,4,18],ch32v307:17,cherryusb:15,core:[1,2],daplink:9,demo:[18,19],demonstr:18,develop:18,devic:[18,19],dfu:[1,2],guid:18,hid:[1,2,5],host:19,manual:18,msc:[1,2,6],on:18,packag:18,platform:18,port:[1,2],rt:[18,19],softwar:18,stm32:[18,19],stm32f429:20,thread:[18,19],uac:3,usb:[12,13,14,18,19],use:18,uvc:7,v2:9,video:[1,2,18],winusb:8}})
\ No newline at end of file +Search.setIndex({docnames:["api/api_common","api/api_device","api/api_host","class/class_audio","class/class_cdc","class/class_hid","class/class_msc","class/class_video","class/winusb","demo/daplink","demo/mouse_keyboard","demo/msc_boot","demo/speaker_mic","demo/usb2uart","demo/video","index","porting","quick_start/bl702","quick_start/ch32v307","quick_start/rt-thread/rt-thread","quick_start/rt-thread/rt-thread_zh","quick_start/stm32f429","usb/usb_basic","usb/usb_desc","usb/usb_enum","usb/usb_request"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["api\\api_common.rst","api\\api_device.rst","api\\api_host.rst","class\\class_audio.rst","class\\class_cdc.rst","class\\class_hid.rst","class\\class_msc.rst","class\\class_video.rst","class\\winusb.rst","demo\\daplink.rst","demo\\mouse_keyboard.rst","demo\\msc_boot.rst","demo\\speaker_mic.rst","demo\\usb2uart.rst","demo\\video.rst","index.rst","porting.rst","quick_start\\bl702.rst","quick_start\\ch32v307.rst","quick_start\\rt-thread\\rt-thread.md","quick_start\\rt-thread\\rt-thread_zh.md","quick_start\\stm32f429.rst","usb\\usb_basic.rst","usb\\usb_desc.rst","usb\\usb_enum.rst","usb\\usb_request.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x31":[19,20],"0x32":[19,20],"0x33":[19,20],"0x34":[19,20],"0x35":[19,20],"0x81":[19,20],"10":[19,20],"48mhz":[19,20],"500":[19,20],"class":[19,20],"for":[19,20],"function":19,"if":19,"in":19,"int":[19,20],"null":[19,20],"void":[19,20],"while":[19,20],"with":[19,20],__hal_rcc_usb_clk_en:[19,20],abov:19,acm:[19,20],also:19,and:[19,20],as:19,audio:[19,20],bl702:15,board:[19,20],bootload:15,bsp:[19,20],by:19,call:19,callback:19,can:19,cdc:[15,20],cdc_init:[19,20],ch32v307:15,cherryusb:[19,20],clock:[19,20],code:[19,20],config:[19,20],configur:[19,20],connect:[19,20],copi:19,cubemx_config:[19,20],daplink:15,data_buff:[19,20],dc:19,defin:20,demo:15,descriptor:19,devic:15,dfu:[19,20],directori:19,embed:[19,20],enabl:[19,20],endpoint:19,english:20,exampl:[19,20],extern:[19,20],file:19,firstli:19,follow:19,free:20,from:19,fs:[19,20],fsdev:20,gener:[19,20],get_pin:20,global:20,go:19,hal:[19,20],hal_nvic_enableirq:[19,20],hal_nvic_setprior:[19,20],hal_pcd_mspinit:[19,20],have:19,hc:20,hcd:20,hid:[15,19,20],host:15,how:19,hs:[19,20],hub:[19,20],implement:19,includ:20,init:[19,20],interfac:19,interrupt:[19,20],into:19,ioc:[19,20],ip:[19,20],irq:19,is:19,it:19,know:19,kprintf:19,latest:[19,20],led0:20,led0_pin:20,level:19,libc:20,like:19,list:19,ll:20,low:19,main:[19,20],malloc:20,manag:19,menuconfig:20,mode:[19,20],modifi:19,msc:[15,19,20],mx:19,name:19,need:19,note:19,now:19,nvic:[19,20],onli:20,onlin:[19,20],open:19,option:[19,20],or:19,otg:[19,20],output:20,packag:20,path:19,pcd:19,pdf:22,peripher:[19,20],ph10:20,pin:20,pin_high:20,pin_low:20,pin_mode_output:20,pleas:19,port:20,portabl:[19,20],printf:[19,20],problem:19,project:19,provid:19,refer:19,regist:19,rt:15,rt_pin_mod:20,rt_pin_writ:20,rt_thread_mdelai:[19,20],rtdevic:20,rtthread:20,same:19,see:19,select:19,seri:19,set:[19,20],should:19,so:19,some:19,specif:19,speed:[19,20],stack:[19,20],stdio:20,step:19,stm32:15,stm32cubemx:[19,20],stm32f0:[19,20],stm32f1:[19,20],stm32f3:[19,20],stm32f429:15,stm32f4:[19,20],stm32f4xx_hal:20,stm32f7:[19,20],stm32h7:20,suffix:19,synopsi:[19,20],system:[19,20],systemclock:[19,20],that:19,the:[19,20],then:19,thi:19,thread:15,tini:[19,20],to:[19,20],two:19,uac:15,uint8_t:[19,20],usb2:22,usb_dc_init:[19,20],usb_dc_low_level_init:[19,20],usb_lp_can1_rx0_irqn:[19,20],usbd_ep_writ:[19,20],usbh_cor:20,usbh_initi:20,util:19,uvc:15,v2:15,version:[19,20],video:20,we:19,winusb:15,xxx:20,you:19,your:19},titles:["\u5176\u4ed6","\u8bbe\u5907\u534f\u8bae\u6808","\u4e3b\u673a\u534f\u8bae\u6808","UAC","CDC","HID","MSC","UVC","WINUSB","DAPLINK V2.0\u8c03\u8bd5\u5668","\u952e\u76d8\u4e0e\u9f20\u6807","U\u76d8\u5236\u4f5c BootLoader","USB \u53cc\u901a\u9053\u626c\u58f0\u5668\u548c\u9ea6\u514b\u98ce","USB \u8f6c\u4e32\u53e3","USB \u6444\u50cf\u5934","CherryUSB \u4f7f\u7528\u6307\u5357","Porting \u7f16\u5199\u8bf4\u660e","\u57fa\u4e8e BL702 \u5f00\u53d1\u6307\u5357","\u57fa\u4e8e CH32V307 \u5f00\u53d1\u6307\u5357","RT-Thread based Software Package Development Guide","\u57fa\u4e8e RT-Thread \u8f6f\u4ef6\u5305\u5f00\u53d1\u6307\u5357","\u57fa\u4e8e STM32F429 \u5f00\u53d1\u6307\u5357","USB \u57fa\u672c\u6982\u5ff5","USB \u63cf\u8ff0\u7b26","USB \u679a\u4e3e","USB \u8bbe\u5907\u8bf7\u6c42"],titleterms:{"class":15,"in":22,api:15,audio:[1,2],base:19,bl702:17,bootload:11,cdc:[1,2,4,19],ch32v307:18,cherryusb:15,core:[1,2],crc:22,daplink:9,demo:[19,20],demonstr:19,develop:19,devic:[19,20],dfu:[1,2],guid:19,hid:[1,2,5],host:20,manual:19,msc:[1,2,6],on:19,out:22,packag:19,platform:19,port:[1,2,15,16],rt:[19,20],setup:22,softwar:19,stm32:[19,20],stm32f429:21,thread:[19,20],uac:3,usb:[12,13,14,15,19,20,22,23,24,25],use:19,uvc:7,v2:9,video:[1,2,19],winusb:8}})
\ No newline at end of file diff --git a/docs/_build/html/usb/usb_basic.html b/docs/_build/html/usb/usb_basic.html new file mode 100644 index 00000000..e5b266ac --- /dev/null +++ b/docs/_build/html/usb/usb_basic.html @@ -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 基本概念 — 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> »</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> + © 版权所有 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>
\ No newline at end of file diff --git a/docs/_build/html/usb/usb_desc.html b/docs/_build/html/usb/usb_desc.html new file mode 100644 index 00000000..2f2bba37 --- /dev/null +++ b/docs/_build/html/usb/usb_desc.html @@ -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 描述符 — 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> »</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> + © 版权所有 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>
\ No newline at end of file diff --git a/docs/_build/html/usb/usb_enum.html b/docs/_build/html/usb/usb_enum.html new file mode 100644 index 00000000..09f2f278 --- /dev/null +++ b/docs/_build/html/usb/usb_enum.html @@ -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 枚举 — 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> »</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> + © 版权所有 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>
\ No newline at end of file diff --git a/docs/_build/html/usb/usb_request.html b/docs/_build/html/usb/usb_request.html new file mode 100644 index 00000000..8d166bfd --- /dev/null +++ b/docs/_build/html/usb/usb_request.html @@ -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 设备请求 — 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> »</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> + © 版权所有 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>
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index a097f8d0..36890796 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,14 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 .. toctree:: :maxdepth: 1 + :caption: USB 基本知识点 + + usb/usb_basic + usb/usb_desc + usb/usb_request + usb/usb_enum +.. toctree:: + :maxdepth: 1 :caption: API 手册 api/api_device @@ -46,3 +54,9 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 demo/video demo/speaker_mic demo/daplink + +.. toctree:: + :maxdepth: 1 + :caption: Porting 说明 + + porting diff --git a/docs/porting.rst b/docs/porting.rst new file mode 100644 index 00000000..869fddcd --- /dev/null +++ b/docs/porting.rst @@ -0,0 +1,2 @@ +Porting 编写说明 +==============================
\ No newline at end of file diff --git a/docs/quick_start/rt-thread/img/1.png b/docs/quick_start/rt-thread/img/1.png Binary files differnew file mode 100644 index 00000000..5176a02c --- /dev/null +++ b/docs/quick_start/rt-thread/img/1.png diff --git a/docs/quick_start/rt-thread/img/2.png b/docs/quick_start/rt-thread/img/2.png Binary files differnew file mode 100644 index 00000000..29d30734 --- /dev/null +++ b/docs/quick_start/rt-thread/img/2.png diff --git a/docs/quick_start/rt-thread/img/3.png b/docs/quick_start/rt-thread/img/3.png Binary files differnew file mode 100644 index 00000000..82bb35ff --- /dev/null +++ b/docs/quick_start/rt-thread/img/3.png diff --git a/docs/quick_start/rt-thread/img/rtt_host_demo.png b/docs/quick_start/rt-thread/img/rtt_host_demo.png Binary files differdeleted file mode 100644 index c8fc41f1..00000000 --- a/docs/quick_start/rt-thread/img/rtt_host_demo.png +++ /dev/null diff --git a/docs/quick_start/rt-thread/rt-thread_zh.md b/docs/quick_start/rt-thread/rt-thread_zh.md index fa038aaf..561f657d 100644 --- a/docs/quick_start/rt-thread/rt-thread_zh.md +++ b/docs/quick_start/rt-thread/rt-thread_zh.md @@ -139,7 +139,9 @@ int main(void)  - host demo - + + + ### 视频教程 diff --git a/docs/usb/usb_basic.rst b/docs/usb/usb_basic.rst new file mode 100644 index 00000000..c2528795 --- /dev/null +++ b/docs/usb/usb_basic.rst @@ -0,0 +1,88 @@ +USB 基本概念 +=========================== + +本文主要对 USB 官方 usb2.0.pdf 中提供的第七章、第八章、第九章进行讲解。 + +简介 +--------- + +USB 信号状态 +----------------- + +USB 连接与断开检测 +--------------------- + +USB 速度识别 +--------------------- + +USB 设备状态 +--------------------- + +USB 编码与位填充 +--------------------- + +USB 字段(域) +--------------------- + +同步字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +包标识符字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +地址字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +帧号字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +数据字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +CRC 字段 +^^^^^^^^^^^^^^^^^^^^^^^^ + +USB 包 +--------------------- + +令牌包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +数据包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +握手包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +特殊数据包 +^^^^^^^^^^^^^^^^^^^^^^^^ + +USB 事务 +--------------------- + +SETUP 事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +IN 事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +OUT 事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +特殊事务 +^^^^^^^^^^^^^^^^^^^^^^^^ + +USB 传输 +--------------------- + +控制传输 +^^^^^^^^^^^^^^^^^^^^^^^^ + +批量传输 +^^^^^^^^^^^^^^^^^^^^^^^^ + +中断传输 +^^^^^^^^^^^^^^^^^^^^^^^^ + +同步传输 +^^^^^^^^^^^^^^^^^^^^^^^^
\ No newline at end of file diff --git a/docs/usb/usb_desc.rst b/docs/usb/usb_desc.rst new file mode 100644 index 00000000..25e4b08e --- /dev/null +++ b/docs/usb/usb_desc.rst @@ -0,0 +1,2 @@ +USB 描述符 +===========================
\ No newline at end of file diff --git a/docs/usb/usb_enum.rst b/docs/usb/usb_enum.rst new file mode 100644 index 00000000..e15d68c1 --- /dev/null +++ b/docs/usb/usb_enum.rst @@ -0,0 +1,2 @@ +USB 枚举 +===========================
\ No newline at end of file diff --git a/docs/usb/usb_request.rst b/docs/usb/usb_request.rst new file mode 100644 index 00000000..8ee9121a --- /dev/null +++ b/docs/usb/usb_request.rst @@ -0,0 +1,2 @@ +USB 设备请求 +===========================
\ No newline at end of file |
