opensource.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  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>官方开源项目分享 &mdash; CherryUSB 1.5.3 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=d75fd82e"></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="share.html" />
  18. <link rel="prev" title="Q &amp; A" href="q%26a.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 class="current">
  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 current"><a class="current reference internal" href="#">官方开源项目分享</a><ul>
  45. <li class="toctree-l2"><a class="reference internal" href="#daplink">DAPLINK</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="#blackmagic">Blackmagic</a></li>
  47. <li class="toctree-l2"><a class="reference internal" href="#rt-thread">RT-Thread</a></li>
  48. <li class="toctree-l2"><a class="reference internal" href="#nuttx-vela">NUTTX/VELA</a></li>
  49. <li class="toctree-l2"><a class="reference internal" href="#zephyr">Zephyr</a></li>
  50. <li class="toctree-l2"><a class="reference internal" href="#cangaroo">Cangaroo</a></li>
  51. <li class="toctree-l2"><a class="reference internal" href="#lvgl">LVGL</a></li>
  52. <li class="toctree-l2"><a class="reference internal" href="#qmk">QMK</a></li>
  53. <li class="toctree-l2"><a class="reference internal" href="#klipper">Klipper</a></li>
  54. <li class="toctree-l2"><a class="reference internal" href="#makcu-kmbox">MAKCU/KMBOX</a></li>
  55. </ul>
  56. </li>
  57. <li class="toctree-l1"><a class="reference internal" href="share.html">开发者经验/开源项目分享</a></li>
  58. </ul>
  59. <p class="caption" role="heading"><span class="caption-text">USB 基本知识点</span></p>
  60. <ul>
  61. <li class="toctree-l1"><a class="reference internal" href="usb/usb2.0_basic.html">USB 基本概念(2.0 为主)</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="usb/usb3.0_basic.html">USB 基本概念(3.0 为主)</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="usb/usb_desc.html">USB 描述符</a></li>
  64. <li class="toctree-l1"><a class="reference internal" href="usb/usb_request.html">USB 设备请求</a></li>
  65. <li class="toctree-l1"><a class="reference internal" href="usb/usb_enum.html">USB 枚举</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="usb/usb_ext.html">USB 知识点拓展</a></li>
  67. </ul>
  68. <p class="caption" role="heading"><span class="caption-text">API 手册</span></p>
  69. <ul>
  70. <li class="toctree-l1"><a class="reference internal" href="api/api_device.html">设备协议栈</a></li>
  71. <li class="toctree-l1"><a class="reference internal" href="api/api_host.html">主机协议栈</a></li>
  72. <li class="toctree-l1"><a class="reference internal" href="api/api_port.html">主从驱动</a></li>
  73. <li class="toctree-l1"><a class="reference internal" href="api/api_config.html">USB CONFIG 说明</a></li>
  74. </ul>
  75. <p class="caption" role="heading"><span class="caption-text">Class 指南</span></p>
  76. <ul>
  77. <li class="toctree-l1"><a class="reference internal" href="class/class_cdc.html">CDC</a></li>
  78. <li class="toctree-l1"><a class="reference internal" href="class/class_hid.html">HID</a></li>
  79. <li class="toctree-l1"><a class="reference internal" href="class/class_msc.html">MSC</a></li>
  80. <li class="toctree-l1"><a class="reference internal" href="class/class_audio.html">UAC</a></li>
  81. <li class="toctree-l1"><a class="reference internal" href="class/class_video.html">UVC</a></li>
  82. <li class="toctree-l1"><a class="reference internal" href="class/winusb.html">WINUSB</a></li>
  83. </ul>
  84. <p class="caption" role="heading"><span class="caption-text">例程说明</span></p>
  85. <ul>
  86. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_cdc_acm.html">usbd_cdc_acm</a></li>
  87. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_hid.html">usbd_hid</a></li>
  88. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_msc.html">usbd_msc</a></li>
  89. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_rndis.html">usbd_rndis</a></li>
  90. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
  91. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_audiov1.html">usbd_audiov1</a></li>
  92. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_audiov2.html">usbd_audiov2</a></li>
  93. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_video.html">usbd_video</a></li>
  94. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_winusb.html">usbd_winusb</a></li>
  95. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_webusb.html">usbd_webusb</a></li>
  96. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_adb.html">usbd_adb</a></li>
  97. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_serial.html">usbh_serial</a></li>
  98. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_hid.html">usbh_hid</a></li>
  99. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_msc.html">usbh_msc</a></li>
  100. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_net.html">usbh_net</a></li>
  101. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_bluetooth.html">usbh_bluetooth</a></li>
  102. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_wifi.html">usbh_wifi</a></li>
  103. <li class="toctree-l1"><a class="reference internal" href="demo/usbd_vendor.html">vendor device 驱动编写</a></li>
  104. <li class="toctree-l1"><a class="reference internal" href="demo/usbh_vendor.html">vendor host 驱动编写</a></li>
  105. </ul>
  106. <p class="caption" role="heading"><span class="caption-text">USBIP 介绍</span></p>
  107. <ul>
  108. <li class="toctree-l1"><a class="reference internal" href="usbip/ohci.html">OHCI</a></li>
  109. <li class="toctree-l1"><a class="reference internal" href="usbip/ehci.html">EHCI</a></li>
  110. <li class="toctree-l1"><a class="reference internal" href="usbip/xhci.html">XHCI</a></li>
  111. <li class="toctree-l1"><a class="reference internal" href="usbip/chipidea.html">CHIPIDEA</a></li>
  112. <li class="toctree-l1"><a class="reference internal" href="usbip/dwc2.html">DWC2</a></li>
  113. <li class="toctree-l1"><a class="reference internal" href="usbip/musb.html">MUSB</a></li>
  114. <li class="toctree-l1"><a class="reference internal" href="usbip/fotg210.html">FOTG210</a></li>
  115. <li class="toctree-l1"><a class="reference internal" href="usbip/cdns2.html">CDNS2</a></li>
  116. <li class="toctree-l1"><a class="reference internal" href="usbip/cdns3.html">CDNS3</a></li>
  117. <li class="toctree-l1"><a class="reference internal" href="usbip/dwc3.html">DWC3</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="tools/index.html">chryusb_configurator</a></li>
  122. <li class="toctree-l1"><a class="reference internal" href="tools/index.html#usb-protocol-suite">力科 USB Protocol Suite</a></li>
  123. <li class="toctree-l1"><a class="reference internal" href="tools/index.html#wireshark">Wireshark</a></li>
  124. <li class="toctree-l1"><a class="reference internal" href="tools/index.html#audacity">Audacity</a></li>
  125. </ul>
  126. <p class="caption" role="heading"><span class="caption-text">版本说明</span></p>
  127. <ul>
  128. <li class="toctree-l1"><a class="reference internal" href="version.html">版本说明</a></li>
  129. </ul>
  130. <p class="caption" role="heading"><span class="caption-text">性能展示</span></p>
  131. <ul>
  132. <li class="toctree-l1"><a class="reference internal" href="show/index.html">性能展示</a></li>
  133. </ul>
  134. <p class="caption" role="heading"><span class="caption-text">商业支持</span></p>
  135. <ul>
  136. <li class="toctree-l1"><a class="reference internal" href="support/index.html">商业支持</a></li>
  137. </ul>
  138. </div>
  139. </div>
  140. </nav>
  141. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  142. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  143. <a href="index.html">CherryUSB</a>
  144. </nav>
  145. <div class="wy-nav-content">
  146. <div class="rst-content">
  147. <div role="navigation" aria-label="Page navigation">
  148. <ul class="wy-breadcrumbs">
  149. <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
  150. <li class="breadcrumb-item active">官方开源项目分享</li>
  151. <li class="wy-breadcrumbs-aside">
  152. <a href="_sources/opensource.rst.txt" rel="nofollow"> View page source</a>
  153. </li>
  154. </ul>
  155. <hr/>
  156. </div>
  157. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  158. <div itemprop="articleBody">
  159. <section id="id1">
  160. <h1>官方开源项目分享<a class="headerlink" href="#id1" title="Link to this heading"></a></h1>
  161. <p>除了基本的厂家 SDK 支持以外,我们还对一些火热的开源项目进行了支持,以便于开发者更好的使用这些项目。下面列举适配的 demo 工程链接,具体适配层参考 <a class="reference external" href="https://github.com/cherry-embedded/CherryUSB/tree/master/platform">https://github.com/cherry-embedded/CherryUSB/tree/master/platform</a> 。</p>
  162. <section id="daplink">
  163. <h2>DAPLINK<a class="headerlink" href="#daplink" title="Link to this heading"></a></h2>
  164. <p>适配链接:<a class="reference external" href="https://github.com/cherry-embedded/CherryDAP">https://github.com/cherry-embedded/CherryDAP</a></p>
  165. </section>
  166. <section id="blackmagic">
  167. <h2>Blackmagic<a class="headerlink" href="#blackmagic" title="Link to this heading"></a></h2>
  168. <p>适配链接:<a class="reference external" href="https://github.com/zhangjiance/bmp-hpm-port">https://github.com/zhangjiance/bmp-hpm-port</a></p>
  169. </section>
  170. <section id="rt-thread">
  171. <h2>RT-Thread<a class="headerlink" href="#rt-thread" title="Link to this heading"></a></h2>
  172. <p>适配链接:<a class="reference external" href="https://github.com/RT-Thread/rt-thread">https://github.com/RT-Thread/rt-thread</a></p>
  173. </section>
  174. <section id="nuttx-vela">
  175. <h2>NUTTX/VELA<a class="headerlink" href="#nuttx-vela" title="Link to this heading"></a></h2>
  176. <p>适配链接:<a class="reference external" href="https://github.com/CherryUSB/cherryusb_nuttx">https://github.com/CherryUSB/cherryusb_nuttx</a></p>
  177. </section>
  178. <section id="zephyr">
  179. <h2>Zephyr<a class="headerlink" href="#zephyr" title="Link to this heading"></a></h2>
  180. <p>适配链接:<a class="reference external" href="https://github.com/hpmicro/zephyr_sdk_glue">https://github.com/hpmicro/zephyr_sdk_glue</a></p>
  181. </section>
  182. <section id="cangaroo">
  183. <h2>Cangaroo<a class="headerlink" href="#cangaroo" title="Link to this heading"></a></h2>
  184. <p>Cangaroo is an open source can bus analyzer software. We provide four-channel CANFD analyzer based on hpmicro hpm5361</p>
  185. <p>适配上位机链接:<a class="reference external" href="https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer">https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer</a>
  186. 适配下位机链接:<a class="reference external" href="https://github.com/RCSN/hpm_sdk_extra/tree/main/demos/cangaroo_hpmicro">https://github.com/RCSN/hpm_sdk_extra/tree/main/demos/cangaroo_hpmicro</a></p>
  187. </section>
  188. <section id="lvgl">
  189. <h2>LVGL<a class="headerlink" href="#lvgl" title="Link to this heading"></a></h2>
  190. <p>适配链接:<a class="reference external" href="https://github.com/cherry-embedded/CherryUSB/tree/master/platform/lvgl">https://github.com/cherry-embedded/CherryUSB/tree/master/platform/lvgl</a></p>
  191. </section>
  192. <section id="qmk">
  193. <h2>QMK<a class="headerlink" href="#qmk" title="Link to this heading"></a></h2>
  194. <p>QMK is an open-source keyboard firmware for Atmel AVR and Arm USB families.</p>
  195. <p>适配链接:待开放</p>
  196. </section>
  197. <section id="klipper">
  198. <h2>Klipper<a class="headerlink" href="#klipper" title="Link to this heading"></a></h2>
  199. <p>Klipper is a 3d-printer firmware.</p>
  200. <p>适配链接:待开放</p>
  201. </section>
  202. <section id="makcu-kmbox">
  203. <h2>MAKCU/KMBOX<a class="headerlink" href="#makcu-kmbox" title="Link to this heading"></a></h2>
  204. <p>懂的都懂,不开放</p>
  205. </section>
  206. </section>
  207. </div>
  208. </div>
  209. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  210. <a href="q%26a.html" class="btn btn-neutral float-left" title="Q &amp; A" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  211. <a href="share.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>
  212. </div>
  213. <hr/>
  214. <div role="contentinfo">
  215. <p>&#169; Copyright 2022 ~ 2025, sakumisu.</p>
  216. </div>
  217. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  218. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  219. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  220. </footer>
  221. </div>
  222. </div>
  223. </section>
  224. </div>
  225. <script>
  226. jQuery(function () {
  227. SphinxRtdTheme.Navigation.enable(true);
  228. });
  229. </script>
  230. </body>
  231. </html>