From 97a80a599c04e852e3e57ce2dc758aeeb32e24d5 Mon Sep 17 00:00:00 2001 From: sakumisu <1203593632@qq.com> Date: Tue, 15 Feb 2022 21:07:42 +0800 Subject: complete doc outline --- docs/_build/doctrees/environment.pickle | Bin 40355 -> 57831 bytes docs/_build/doctrees/index.doctree | Bin 4552 -> 5052 bytes docs/_build/doctrees/porting.doctree | Bin 0 -> 2303 bytes .../quick_start/rt-thread/rt-thread_zh.doctree | Bin 30917 -> 31403 bytes docs/_build/doctrees/usb/usb_basic.doctree | Bin 0 -> 9403 bytes docs/_build/doctrees/usb/usb_desc.doctree | Bin 0 -> 2283 bytes docs/_build/doctrees/usb/usb_enum.doctree | Bin 0 -> 2274 bytes docs/_build/doctrees/usb/usb_request.doctree | Bin 0 -> 2295 bytes docs/_build/html/_images/1.png | Bin 0 -> 28842 bytes docs/_build/html/_images/2.png | Bin 0 -> 27620 bytes docs/_build/html/_images/3.png | Bin 0 -> 22701 bytes docs/_build/html/_images/rtt_host_demo.png | Bin 5497 -> 0 bytes docs/_build/html/_sources/index.rst.txt | 14 + docs/_build/html/_sources/porting.rst.txt | 2 + .../quick_start/rt-thread/rt-thread_zh.md.txt | 4 +- docs/_build/html/_sources/usb/usb_basic.rst.txt | 88 +++++ docs/_build/html/_sources/usb/usb_desc.rst.txt | 2 + docs/_build/html/_sources/usb/usb_enum.rst.txt | 2 + docs/_build/html/_sources/usb/usb_request.rst.txt | 2 + docs/_build/html/api/api_common.html | 11 + docs/_build/html/api/api_device.html | 15 +- docs/_build/html/api/api_host.html | 11 + docs/_build/html/class/class_audio.html | 11 + docs/_build/html/class/class_cdc.html | 11 + docs/_build/html/class/class_hid.html | 11 + docs/_build/html/class/class_msc.html | 11 + docs/_build/html/class/class_video.html | 11 + docs/_build/html/class/winusb.html | 11 + docs/_build/html/demo/daplink.html | 13 + docs/_build/html/demo/mouse_keyboard.html | 11 + docs/_build/html/demo/msc_boot.html | 11 + docs/_build/html/demo/speaker_mic.html | 11 + docs/_build/html/demo/usb2uart.html | 11 + docs/_build/html/demo/video.html | 11 + docs/_build/html/genindex.html | 11 + docs/_build/html/index.html | 26 ++ docs/_build/html/objects.inv | Bin 1527 -> 2053 bytes docs/_build/html/porting.html | 249 ++++++++++++++ docs/_build/html/quick_start/bl702.html | 11 + docs/_build/html/quick_start/ch32v307.html | 11 + .../html/quick_start/rt-thread/rt-thread.html | 11 + .../html/quick_start/rt-thread/rt-thread_zh.html | 19 +- docs/_build/html/quick_start/stm32f429.html | 11 + docs/_build/html/search.html | 11 + docs/_build/html/searchindex.js | 2 +- docs/_build/html/usb/usb_basic.html | 374 +++++++++++++++++++++ docs/_build/html/usb/usb_desc.html | 251 ++++++++++++++ docs/_build/html/usb/usb_enum.html | 251 ++++++++++++++ docs/_build/html/usb/usb_request.html | 251 ++++++++++++++ docs/index.rst | 14 + docs/porting.rst | 2 + docs/quick_start/rt-thread/img/1.png | Bin 0 -> 28842 bytes docs/quick_start/rt-thread/img/2.png | Bin 0 -> 27620 bytes docs/quick_start/rt-thread/img/3.png | Bin 0 -> 22701 bytes docs/quick_start/rt-thread/img/rtt_host_demo.png | Bin 5497 -> 0 bytes docs/quick_start/rt-thread/rt-thread_zh.md | 4 +- docs/usb/usb_basic.rst | 88 +++++ docs/usb/usb_desc.rst | 2 + docs/usb/usb_enum.rst | 2 + docs/usb/usb_request.rst | 2 + 60 files changed, 1880 insertions(+), 8 deletions(-) create mode 100644 docs/_build/doctrees/porting.doctree create mode 100644 docs/_build/doctrees/usb/usb_basic.doctree create mode 100644 docs/_build/doctrees/usb/usb_desc.doctree create mode 100644 docs/_build/doctrees/usb/usb_enum.doctree create mode 100644 docs/_build/doctrees/usb/usb_request.doctree create mode 100644 docs/_build/html/_images/1.png create mode 100644 docs/_build/html/_images/2.png create mode 100644 docs/_build/html/_images/3.png delete mode 100644 docs/_build/html/_images/rtt_host_demo.png create mode 100644 docs/_build/html/_sources/porting.rst.txt create mode 100644 docs/_build/html/_sources/usb/usb_basic.rst.txt create mode 100644 docs/_build/html/_sources/usb/usb_desc.rst.txt create mode 100644 docs/_build/html/_sources/usb/usb_enum.rst.txt create mode 100644 docs/_build/html/_sources/usb/usb_request.rst.txt create mode 100644 docs/_build/html/porting.html create mode 100644 docs/_build/html/usb/usb_basic.html create mode 100644 docs/_build/html/usb/usb_desc.html create mode 100644 docs/_build/html/usb/usb_enum.html create mode 100644 docs/_build/html/usb/usb_request.html create mode 100644 docs/porting.rst create mode 100644 docs/quick_start/rt-thread/img/1.png create mode 100644 docs/quick_start/rt-thread/img/2.png create mode 100644 docs/quick_start/rt-thread/img/3.png delete mode 100644 docs/quick_start/rt-thread/img/rtt_host_demo.png create mode 100644 docs/usb/usb_basic.rst create mode 100644 docs/usb/usb_desc.rst create mode 100644 docs/usb/usb_enum.rst create mode 100644 docs/usb/usb_request.rst diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 88c1c2a5..34fde38f 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index c70a2ee4..9e5649aa 100644 Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/doctrees/porting.doctree b/docs/_build/doctrees/porting.doctree new file mode 100644 index 00000000..3fc2c4a0 Binary files /dev/null and b/docs/_build/doctrees/porting.doctree differ 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 index 65d5baf7..c1738de9 100644 Binary files a/docs/_build/doctrees/quick_start/rt-thread/rt-thread_zh.doctree and b/docs/_build/doctrees/quick_start/rt-thread/rt-thread_zh.doctree differ diff --git a/docs/_build/doctrees/usb/usb_basic.doctree b/docs/_build/doctrees/usb/usb_basic.doctree new file mode 100644 index 00000000..d0524317 Binary files /dev/null and b/docs/_build/doctrees/usb/usb_basic.doctree differ diff --git a/docs/_build/doctrees/usb/usb_desc.doctree b/docs/_build/doctrees/usb/usb_desc.doctree new file mode 100644 index 00000000..b6dc914c Binary files /dev/null and b/docs/_build/doctrees/usb/usb_desc.doctree differ diff --git a/docs/_build/doctrees/usb/usb_enum.doctree b/docs/_build/doctrees/usb/usb_enum.doctree new file mode 100644 index 00000000..868b9c2a Binary files /dev/null and b/docs/_build/doctrees/usb/usb_enum.doctree differ diff --git a/docs/_build/doctrees/usb/usb_request.doctree b/docs/_build/doctrees/usb/usb_request.doctree new file mode 100644 index 00000000..f57724a3 Binary files /dev/null and b/docs/_build/doctrees/usb/usb_request.doctree differ diff --git a/docs/_build/html/_images/1.png b/docs/_build/html/_images/1.png new file mode 100644 index 00000000..5176a02c Binary files /dev/null and b/docs/_build/html/_images/1.png differ diff --git a/docs/_build/html/_images/2.png b/docs/_build/html/_images/2.png new file mode 100644 index 00000000..29d30734 Binary files /dev/null and b/docs/_build/html/_images/2.png differ diff --git a/docs/_build/html/_images/3.png b/docs/_build/html/_images/3.png new file mode 100644 index 00000000..82bb35ff Binary files /dev/null and b/docs/_build/html/_images/3.png differ diff --git a/docs/_build/html/_images/rtt_host_demo.png b/docs/_build/html/_images/rtt_host_demo.png deleted file mode 100644 index c8fc41f1..00000000 Binary files a/docs/_build/html/_images/rtt_host_demo.png and /dev/null differ 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 @@ -17,6 +17,14 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 quick_start/ch32v307 quick_start/rt-thread/rt-thread_zh +.. toctree:: + :maxdepth: 1 + :caption: USB 基本知识点 + + usb/usb_basic + usb/usb_desc + usb/usb_request + usb/usb_enum .. toctree:: :maxdepth: 1 :caption: API 手册 @@ -46,3 +54,9 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的 demo/video demo/speaker_mic demo/daplink + +.. toctree:: + :maxdepth: 1 + :caption: Porting 说明 + + porting 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) ![CDC Device Demo](img/rtt_cdc_demo.png) - host demo -![USB Host Demo](img/rtt_host_demo.png) +![USB Host Demo1](img/1.png) +![USB Host Demo2](img/2.png) +![USB Host Demo3](img/3.png) ### 视频教程 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 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@ - + @@ -95,6 +95,13 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + 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 @@ + @@ -94,6 +95,13 @@
  • 基于 CH32V307 开发指南
  • 基于 RT-Thread 软件包开发指南
    • +

    USB 基本知识点

    +

    API 手册

    +

    Porting 说明

    + @@ -194,6 +206,7 @@