genindex.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" data-content_root="./">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Index &mdash; CherryUSB 1.6.0 documentation</title>
  7. <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
  8. <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
  9. <script src="_static/jquery.js?v=5d32c60e"></script>
  10. <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
  11. <script src="_static/documentation_options.js?v=72d88caf"></script>
  12. <script src="_static/doctools.js?v=9a2dae69"></script>
  13. <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  14. <script src="_static/js/theme.js"></script>
  15. <link rel="index" title="Index" href="#" />
  16. <link rel="search" title="Search" href="search.html" />
  17. </head>
  18. <body class="wy-body-for-nav">
  19. <div class="wy-grid-for-nav">
  20. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  21. <div class="wy-side-scroll">
  22. <div class="wy-side-nav-search" >
  23. <a href="index.html" class="icon icon-home">
  24. CherryUSB
  25. </a>
  26. <div role="search">
  27. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  28. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  29. <input type="hidden" name="check_keywords" value="yes" />
  30. <input type="hidden" name="area" value="default" />
  31. </form>
  32. </div>
  33. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  34. <p class="caption" role="heading"><span class="caption-text">快速上手</span></p>
  35. <ul>
  36. <li class="toctree-l1"><a class="reference internal" href="quick_start/start.html">入门必看</a></li>
  37. <li class="toctree-l1"><a class="reference internal" href="quick_start/demo.html">基于现有 demo 快速验证</a></li>
  38. <li class="toctree-l1"><a class="reference internal" href="quick_start/transplant.html">芯片通用移植指南</a></li>
  39. <li class="toctree-l1"><a class="reference internal" href="quick_start/rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
  40. <li class="toctree-l1"><a class="reference internal" href="quick_start/q%26a.html">Q &amp; A</a></li>
  41. <li class="toctree-l1"><a class="reference internal" href="quick_start/migration.html">部分改动迁移指南</a></li>
  42. <li class="toctree-l1"><a class="reference internal" href="quick_start/opensource.html">基于 CherryUSB 的开源项目</a></li>
  43. </ul>
  44. <p class="caption" role="heading"><span class="caption-text">USB 基本知识点</span></p>
  45. <ul>
  46. <li class="toctree-l1"><a class="reference internal" href="usb/usb2.0_basic.html">USB 基本概念(2.0 为主)</a></li>
  47. <li class="toctree-l1"><a class="reference internal" href="usb/usb3.0_basic.html">USB 基本概念(3.0 为主)</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="usb/usb_desc.html">USB 描述符</a></li>
  49. <li class="toctree-l1"><a class="reference internal" href="usb/usb_request.html">USB 设备请求</a></li>
  50. <li class="toctree-l1"><a class="reference internal" href="usb/usb_enum.html">USB 枚举</a></li>
  51. <li class="toctree-l1"><a class="reference internal" href="usb/usb_ext.html">USB 知识点拓展</a></li>
  52. </ul>
  53. <p class="caption" role="heading"><span class="caption-text">API 手册</span></p>
  54. <ul>
  55. <li class="toctree-l1"><a class="reference internal" href="api/api_device.html">设备协议栈</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="api/api_host.html">主机协议栈</a></li>
  57. <li class="toctree-l1"><a class="reference internal" href="api/api_port.html">主从驱动</a></li>
  58. <li class="toctree-l1"><a class="reference internal" href="api/api_config.html">USB CONFIG 说明</a></li>
  59. </ul>
  60. <p class="caption" role="heading"><span class="caption-text">Class 指南</span></p>
  61. <ul>
  62. <li class="toctree-l1"><a class="reference internal" href="class/class_cdc.html">CDC</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="class/class_hid.html">HID</a></li>
  64. <li class="toctree-l1"><a class="reference internal" href="class/class_msc.html">MSC</a></li>
  65. <li class="toctree-l1"><a class="reference internal" href="class/class_audio.html">UAC</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="class/class_video.html">UVC</a></li>
  67. <li class="toctree-l1"><a class="reference internal" href="class/winusb.html">WINUSB</a></li>
  68. </ul>
  69. <p class="caption" role="heading"><span class="caption-text">例程</span></p>
  70. <ul>
  71. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_cdc_acm.html">CDC ACM Device</a></li>
  72. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_hid.html">HID Device</a></li>
  73. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_msc.html">MSC Device</a></li>
  74. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_audiov1.html">AudioV1 Device</a></li>
  75. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_audiov2.html">AudioV2 Device</a></li>
  76. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_video.html">USB Video Device</a></li>
  77. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_winusb.html">WinUSB Device</a></li>
  78. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_webusb.html">WebUSB Device</a></li>
  79. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_rndis.html">CDC RNDIS Device</a></li>
  80. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_ecm.html">CDC ECM Device</a></li>
  81. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_adb.html">ADB Device</a></li>
  82. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_mtp.html">MTP Device</a></li>
  83. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_serial.html">Serial Host</a></li>
  84. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_hid.html">HID Host</a></li>
  85. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_msc.html">MSC Host</a></li>
  86. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_net.html">Network Host</a></li>
  87. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_bluetooth.html">BTBLE Host</a></li>
  88. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_wifi.html">WIFI Host</a></li>
  89. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_audio.html">Audio Host</a></li>
  90. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_video.html">Video Host</a></li>
  91. <li class="toctree-l1"><a class="reference internal" href="demo/usb_otg.html">USB OTG</a></li>
  92. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_vendor.html">Vendor Device 驱动编写</a></li>
  93. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_vendor.html">Vendor Host 驱动编写</a></li>
  94. </ul>
  95. <p class="caption" role="heading"><span class="caption-text">USBIP 介绍</span></p>
  96. <ul>
  97. <li class="toctree-l1"><a class="reference internal" href="usbip/ohci.html">OHCI</a></li>
  98. <li class="toctree-l1"><a class="reference internal" href="usbip/ehci.html">EHCI</a></li>
  99. <li class="toctree-l1"><a class="reference internal" href="usbip/xhci.html">XHCI</a></li>
  100. <li class="toctree-l1"><a class="reference internal" href="usbip/chipidea.html">CHIPIDEA</a></li>
  101. <li class="toctree-l1"><a class="reference internal" href="usbip/dwc2.html">DWC2</a></li>
  102. <li class="toctree-l1"><a class="reference internal" href="usbip/musb.html">MUSB</a></li>
  103. <li class="toctree-l1"><a class="reference internal" href="usbip/fotg210.html">FOTG210</a></li>
  104. <li class="toctree-l1"><a class="reference internal" href="usbip/cdns2.html">CDNS2</a></li>
  105. <li class="toctree-l1"><a class="reference internal" href="usbip/cdns3.html">CDNS3</a></li>
  106. <li class="toctree-l1"><a class="reference internal" href="usbip/dwc3.html">DWC3</a></li>
  107. </ul>
  108. <p class="caption" role="heading"><span class="caption-text">工具使用</span></p>
  109. <ul>
  110. <li class="toctree-l1"><a class="reference internal" href="tools/index.html">chryusb_configurator</a></li>
  111. <li class="toctree-l1"><a class="reference internal" href="tools/index.html#usb-protocol-suite">力科 USB Protocol Suite</a></li>
  112. <li class="toctree-l1"><a class="reference internal" href="tools/index.html#wireshark">Wireshark</a></li>
  113. <li class="toctree-l1"><a class="reference internal" href="tools/index.html#audacity">Audacity</a></li>
  114. </ul>
  115. <p class="caption" role="heading"><span class="caption-text">Release Notes</span></p>
  116. <ul>
  117. <li class="toctree-l1"><a class="reference internal" href="version.html">版本说明</a></li>
  118. </ul>
  119. <p class="caption" role="heading"><span class="caption-text">性能展示</span></p>
  120. <ul>
  121. <li class="toctree-l1"><a class="reference internal" href="show/index.html">性能展示</a></li>
  122. </ul>
  123. <p class="caption" role="heading"><span class="caption-text">商业支持</span></p>
  124. <ul>
  125. <li class="toctree-l1"><a class="reference internal" href="support/index.html">商业支持</a></li>
  126. </ul>
  127. </div>
  128. </div>
  129. </nav>
  130. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  131. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  132. <a href="index.html">CherryUSB</a>
  133. </nav>
  134. <div class="wy-nav-content">
  135. <div class="rst-content">
  136. <div role="navigation" aria-label="Page navigation">
  137. <ul class="wy-breadcrumbs">
  138. <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
  139. <li class="breadcrumb-item active">Index</li>
  140. <li class="wy-breadcrumbs-aside">
  141. </li>
  142. </ul>
  143. <hr/>
  144. </div>
  145. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  146. <div itemprop="articleBody">
  147. <h1 id="index">Index</h1>
  148. <div class="genindex-jumpbox">
  149. </div>
  150. </div>
  151. </div>
  152. <footer>
  153. <hr/>
  154. <div role="contentinfo">
  155. <p>&#169; Copyright 2022 ~ 2026, sakumisu.</p>
  156. </div>
  157. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  158. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  159. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  160. </footer>
  161. </div>
  162. </div>
  163. </section>
  164. </div>
  165. <script>
  166. jQuery(function () {
  167. SphinxRtdTheme.Navigation.enable(true);
  168. });
  169. </script>
  170. </body>
  171. </html>