index.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" data-content_root="../">
  3. <head>
  4. <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>chryusb_configurator &mdash; CherryUSB 1.4.2 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=e59714d7" />
  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=02f2166e"></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="../genindex.html" />
  16. <link rel="search" title="Search" href="../search.html" />
  17. <link rel="next" title="版本说明" href="../version.html" />
  18. <link rel="prev" title="DWC3" href="../usbip/dwc3.html" />
  19. </head>
  20. <body class="wy-body-for-nav">
  21. <div class="wy-grid-for-nav">
  22. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  23. <div class="wy-side-scroll">
  24. <div class="wy-side-nav-search" >
  25. <a href="../index.html" class="icon icon-home">
  26. CherryUSB
  27. </a>
  28. <div role="search">
  29. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  30. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  31. <input type="hidden" name="check_keywords" value="yes" />
  32. <input type="hidden" name="area" value="default" />
  33. </form>
  34. </div>
  35. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  36. <p class="caption" role="heading"><span class="caption-text">快速上手</span></p>
  37. <ul>
  38. <li class="toctree-l1"><a class="reference internal" href="../quick_start/start.html">入门必看</a></li>
  39. <li class="toctree-l1"><a class="reference internal" href="../quick_start/demo.html">基于现有 demo 快速验证</a></li>
  40. <li class="toctree-l1"><a class="reference internal" href="../quick_start/transplant.html">芯片通用移植指南</a></li>
  41. <li class="toctree-l1"><a class="reference internal" href="../quick_start/rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
  42. <li class="toctree-l1"><a class="reference internal" href="../quick_start/esp.html">基于 ESP-Registry 开发指南</a></li>
  43. <li class="toctree-l1"><a class="reference internal" href="../q%26a.html">Q &amp; A</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="../opensource.html">官方开源项目分享</a></li>
  45. <li class="toctree-l1"><a class="reference internal" href="../share.html">开发者经验/开源项目分享</a></li>
  46. </ul>
  47. <p class="caption" role="heading"><span class="caption-text">USB 基本知识点</span></p>
  48. <ul>
  49. <li class="toctree-l1"><a class="reference internal" href="../usb/usb2.0_basic.html">USB 基本概念(2.0 为主)</a></li>
  50. <li class="toctree-l1"><a class="reference internal" href="../usb/usb3.0_basic.html">USB 基本概念(3.0 为主)</a></li>
  51. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
  52. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
  53. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
  54. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_ext.html">USB 知识点拓展</a></li>
  55. </ul>
  56. <p class="caption" role="heading"><span class="caption-text">API 手册</span></p>
  57. <ul>
  58. <li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
  59. <li class="toctree-l1"><a class="reference internal" href="../api/api_host.html">主机协议栈</a></li>
  60. <li class="toctree-l1"><a class="reference internal" href="../api/api_port.html">主从驱动</a></li>
  61. <li class="toctree-l1"><a class="reference internal" href="../api/api_config.html">USB CONFIG 说明</a></li>
  62. </ul>
  63. <p class="caption" role="heading"><span class="caption-text">Class 指南</span></p>
  64. <ul>
  65. <li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
  67. <li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
  68. <li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
  69. <li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
  70. <li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
  71. </ul>
  72. <p class="caption" role="heading"><span class="caption-text">例程说明</span></p>
  73. <ul>
  74. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_cdc_acm.html">usbd_cdc_acm</a></li>
  75. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_hid.html">usbd_hid</a></li>
  76. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
  77. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
  78. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
  79. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
  80. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
  81. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
  82. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
  83. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
  84. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
  85. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
  86. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
  87. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
  88. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_bluetooth.html">usbh_bluetooth</a></li>
  89. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_wifi.html">usbh_wifi</a></li>
  90. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_vendor.html">vendor device 驱动编写</a></li>
  91. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_vendor.html">vendor host 驱动编写</a></li>
  92. </ul>
  93. <p class="caption" role="heading"><span class="caption-text">USBIP 介绍</span></p>
  94. <ul>
  95. <li class="toctree-l1"><a class="reference internal" href="../usbip/ohci.html">OHCI</a></li>
  96. <li class="toctree-l1"><a class="reference internal" href="../usbip/ehci.html">EHCI</a></li>
  97. <li class="toctree-l1"><a class="reference internal" href="../usbip/xhci.html">XHCI</a></li>
  98. <li class="toctree-l1"><a class="reference internal" href="../usbip/chipidea.html">CHIPIDEA</a></li>
  99. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc2.html">DWC2</a></li>
  100. <li class="toctree-l1"><a class="reference internal" href="../usbip/musb.html">MUSB</a></li>
  101. <li class="toctree-l1"><a class="reference internal" href="../usbip/fotg210.html">FOTG210</a></li>
  102. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns2.html">CDNS2</a></li>
  103. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns3.html">CDNS3</a></li>
  104. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc3.html">DWC3</a></li>
  105. </ul>
  106. <p class="caption" role="heading"><span class="caption-text">工具使用</span></p>
  107. <ul class="current">
  108. <li class="toctree-l1 current"><a class="current reference internal" href="#">chryusb_configurator</a></li>
  109. <li class="toctree-l1"><a class="reference internal" href="#usb-protocol-suite">力科 USB Protocol Suite</a></li>
  110. <li class="toctree-l1"><a class="reference internal" href="#wireshark">Wireshark</a></li>
  111. <li class="toctree-l1"><a class="reference internal" href="#audacity">Audacity</a></li>
  112. </ul>
  113. <p class="caption" role="heading"><span class="caption-text">版本说明</span></p>
  114. <ul>
  115. <li class="toctree-l1"><a class="reference internal" href="../version.html">版本说明</a></li>
  116. </ul>
  117. <p class="caption" role="heading"><span class="caption-text">商业支持</span></p>
  118. <ul>
  119. <li class="toctree-l1"><a class="reference internal" href="../support/index.html">商业支持</a></li>
  120. </ul>
  121. </div>
  122. </div>
  123. </nav>
  124. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  125. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  126. <a href="../index.html">CherryUSB</a>
  127. </nav>
  128. <div class="wy-nav-content">
  129. <div class="rst-content">
  130. <div role="navigation" aria-label="Page navigation">
  131. <ul class="wy-breadcrumbs">
  132. <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
  133. <li class="breadcrumb-item active">chryusb_configurator</li>
  134. <li class="wy-breadcrumbs-aside">
  135. <a href="../_sources/tools/index.rst.txt" rel="nofollow"> View page source</a>
  136. </li>
  137. </ul>
  138. <hr/>
  139. </div>
  140. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  141. <div itemprop="articleBody">
  142. <section id="chryusb-configurator">
  143. <h1>chryusb_configurator<a class="headerlink" href="#chryusb-configurator" title="Link to this heading"></a></h1>
  144. <p><a class="reference external" href="https://github.com/CherryUSB/chryusb_configurator/releases/tag/1.0.0">chryusb_configurator</a> 主要服务在使用设备协议栈时,生成描述符数组,从而调用 <cite>usbd_desc_register</cite> 进行注册。</p>
  145. <ul class="simple">
  146. <li><p>首先我们从 github 下载 chryusb_configurator.exe,然后一路安装就可以了。然后双击打开,点击 <cite>工程</cite>,并点击 <cite>新建工程</cite></p></li>
  147. </ul>
  148. <figure class="align-default">
  149. <img alt="../_images/chrytool1.png" src="../_images/chrytool1.png" />
  150. </figure>
  151. <ul class="simple">
  152. <li><p>新建完成以后,会生成默认的描述符配置,包含 <strong>设备描述符</strong>、 <strong>配置描述符</strong>、 <strong>字符串描述符</strong>,并且 <strong>字符串描述符</strong> 默认支持三个</p></li>
  153. </ul>
  154. <figure class="align-default">
  155. <img alt="../_images/chrytool2.png" src="../_images/chrytool2.png" />
  156. </figure>
  157. <ul class="simple">
  158. <li><p>然后我们可以根据需要修改相关描述符的信息,比如 <strong>设备描述符</strong> 中的 vid、pid,class 参数, <strong>配置描述符</strong> 中的 <strong>Power</strong> 等等</p></li>
  159. <li><p>然后是 class 的添加,需要点击 <cite>文件</cite>,并点击 <cite>新建文件</cite></p></li>
  160. </ul>
  161. <figure class="align-default">
  162. <img alt="../_images/chrytool3.png" src="../_images/chrytool3.png" />
  163. </figure>
  164. <ul class="simple">
  165. <li><p>然后右侧提供了一些 class 的描述符模板,选择一个进行初始化</p></li>
  166. </ul>
  167. <figure class="align-default">
  168. <img alt="../_images/chrytool4.png" src="../_images/chrytool4.png" />
  169. </figure>
  170. <ul class="simple">
  171. <li><p>如果是多个 class ,则上述两步重复操作就可以了</p></li>
  172. <li><p>然后我们根据需要修改相关端点的参数,比如方向、地址、size、interval</p></li>
  173. </ul>
  174. <figure class="align-default">
  175. <img alt="../_images/chrytool5.png" src="../_images/chrytool5.png" />
  176. </figure>
  177. <ul class="simple">
  178. <li><p>最后点击 <cite>文件</cite> 并保存文件,后缀为 <cite>.chry</cite></p></li>
  179. <li><p>切换到工程文件,后缀是 <cite>.chrybase</cite>, 然后点击 <cite>添加分组配置</cite> 导入刚刚配置好的 class 文件</p></li>
  180. </ul>
  181. <figure class="align-default">
  182. <img alt="../_images/chrytool6.png" src="../_images/chrytool6.png" />
  183. </figure>
  184. <ul class="simple">
  185. <li><p>点击 <cite>工程</cite> 并点击 <cite>保存工程</cite></p></li>
  186. <li><p>点击 <cite>编译</cite>,生成描述符数组</p></li>
  187. </ul>
  188. <figure class="align-default">
  189. <img alt="../_images/chrytool7.png" src="../_images/chrytool7.png" />
  190. </figure>
  191. <ul class="simple">
  192. <li><p>复制编译后的文件到自己的工程中使用即可</p></li>
  193. </ul>
  194. </section>
  195. <section id="usb-protocol-suite">
  196. <h1>力科 USB Protocol Suite<a class="headerlink" href="#usb-protocol-suite" title="Link to this heading"></a></h1>
  197. </section>
  198. <section id="wireshark">
  199. <h1>Wireshark<a class="headerlink" href="#wireshark" title="Link to this heading"></a></h1>
  200. </section>
  201. <section id="audacity">
  202. <h1>Audacity<a class="headerlink" href="#audacity" title="Link to this heading"></a></h1>
  203. </section>
  204. </div>
  205. </div>
  206. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  207. <a href="../usbip/dwc3.html" class="btn btn-neutral float-left" title="DWC3" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  208. <a href="../version.html" class="btn btn-neutral float-right" title="版本说明" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  209. </div>
  210. <hr/>
  211. <div role="contentinfo">
  212. <p>&#169; Copyright 2022 ~ 2024, sakumisu.</p>
  213. </div>
  214. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  215. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  216. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  217. </footer>
  218. </div>
  219. </div>
  220. </section>
  221. </div>
  222. <script>
  223. jQuery(function () {
  224. SphinxRtdTheme.Navigation.enable(true);
  225. });
  226. </script>
  227. </body>
  228. </html>