demo.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  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>基于现有 demo 快速验证 &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="transplant.html" />
  18. <link rel="prev" title="入门必看" href="start.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="start.html">入门必看</a></li>
  39. <li class="toctree-l1 current"><a class="current reference internal" href="#">基于现有 demo 快速验证</a><ul>
  40. <li class="toctree-l2"><a class="reference internal" href="#bouffalolab-sdk">基于 bouffalolab 系列芯片(官方 SDK 支持)</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="#hpmicro-sdk">基于 HPMicro 系列芯片(官方 SDK 支持)</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="#esp32s2-s3-p4-sdk">基于 esp32s2/s3/p4 系列芯片(官方 SDK 即将支持)</a></li>
  43. <li class="toctree-l2"><a class="reference internal" href="#sdk">基于飞腾派系列芯片(官方 SDK 支持)</a></li>
  44. <li class="toctree-l2"><a class="reference internal" href="#essemi-sdk">基于 Essemi 系列芯片(官方 SDK 支持)</a></li>
  45. <li class="toctree-l2"><a class="reference internal" href="#artinchip-sdk">基于 Artinchip 系列芯片(官方 SDK 支持)</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="#canmv-k230-sdk">基于 canmv-k230 芯片(官方 SDK 支持)</a></li>
  47. <li class="toctree-l2"><a class="reference internal" href="#nxp-mcx">基于 NXP MCX系列芯片</a></li>
  48. <li class="toctree-l2"><a class="reference internal" href="#rp2040-rp2035-sdk">基于 RP2040/RP2035 芯片(官方 SDK 即将支持)</a></li>
  49. <li class="toctree-l2"><a class="reference internal" href="#st">基于 ST 系列芯片</a><ul>
  50. <li class="toctree-l3"><a class="reference internal" href="#usb-device">USB Device 移植要点</a></li>
  51. <li class="toctree-l3"><a class="reference internal" href="#usb-host">USB Host 移植要点</a></li>
  52. </ul>
  53. </li>
  54. </ul>
  55. </li>
  56. <li class="toctree-l1"><a class="reference internal" href="transplant.html">芯片通用移植指南</a></li>
  57. <li class="toctree-l1"><a class="reference internal" href="rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
  58. <li class="toctree-l1"><a class="reference internal" href="q%26a.html">Q &amp; A</a></li>
  59. <li class="toctree-l1"><a class="reference internal" href="share.html">开发者经验/开源项目分享</a></li>
  60. <li class="toctree-l1"><a class="reference internal" href="opensource.html">官方开源项目分享</a></li>
  61. </ul>
  62. <p class="caption" role="heading"><span class="caption-text">USB 基本知识点</span></p>
  63. <ul>
  64. <li class="toctree-l1"><a class="reference internal" href="../usb/usb2.0_basic.html">USB 基本概念(2.0 为主)</a></li>
  65. <li class="toctree-l1"><a class="reference internal" href="../usb/usb3.0_basic.html">USB 基本概念(3.0 为主)</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
  67. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
  68. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
  69. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_ext.html">USB 知识点拓展</a></li>
  70. </ul>
  71. <p class="caption" role="heading"><span class="caption-text">API 手册</span></p>
  72. <ul>
  73. <li class="toctree-l1"><a class="reference internal" href="../api/api_device.html">设备协议栈</a></li>
  74. <li class="toctree-l1"><a class="reference internal" href="../api/api_host.html">主机协议栈</a></li>
  75. <li class="toctree-l1"><a class="reference internal" href="../api/api_port.html">主从驱动</a></li>
  76. <li class="toctree-l1"><a class="reference internal" href="../api/api_config.html">USB CONFIG 说明</a></li>
  77. </ul>
  78. <p class="caption" role="heading"><span class="caption-text">Class 指南</span></p>
  79. <ul>
  80. <li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
  81. <li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
  82. <li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
  83. <li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
  84. <li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
  85. <li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
  86. </ul>
  87. <p class="caption" role="heading"><span class="caption-text">例程说明</span></p>
  88. <ul>
  89. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_cdc_acm.html">usbd_cdc_acm</a></li>
  90. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_hid.html">usbd_hid</a></li>
  91. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
  92. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
  93. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
  94. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
  95. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
  96. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
  97. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
  98. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
  99. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_adb.html">usbd_adb</a></li>
  100. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
  101. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
  102. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
  103. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
  104. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_bluetooth.html">usbh_bluetooth</a></li>
  105. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_wifi.html">usbh_wifi</a></li>
  106. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_vendor.html">vendor device 驱动编写</a></li>
  107. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_vendor.html">vendor host 驱动编写</a></li>
  108. <li class="toctree-l1"><a class="reference internal" href="../demo/usb_otg.html">OTG 功能的使用</a></li>
  109. </ul>
  110. <p class="caption" role="heading"><span class="caption-text">USBIP 介绍</span></p>
  111. <ul>
  112. <li class="toctree-l1"><a class="reference internal" href="../usbip/ohci.html">OHCI</a></li>
  113. <li class="toctree-l1"><a class="reference internal" href="../usbip/ehci.html">EHCI</a></li>
  114. <li class="toctree-l1"><a class="reference internal" href="../usbip/xhci.html">XHCI</a></li>
  115. <li class="toctree-l1"><a class="reference internal" href="../usbip/chipidea.html">CHIPIDEA</a></li>
  116. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc2.html">DWC2</a></li>
  117. <li class="toctree-l1"><a class="reference internal" href="../usbip/musb.html">MUSB</a></li>
  118. <li class="toctree-l1"><a class="reference internal" href="../usbip/fotg210.html">FOTG210</a></li>
  119. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns2.html">CDNS2</a></li>
  120. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns3.html">CDNS3</a></li>
  121. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc3.html">DWC3</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="../tools/index.html">chryusb_configurator</a></li>
  126. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#usb-protocol-suite">力科 USB Protocol Suite</a></li>
  127. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#wireshark">Wireshark</a></li>
  128. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#audacity">Audacity</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="../version.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="../show/index.html">性能展示</a></li>
  137. </ul>
  138. <p class="caption" role="heading"><span class="caption-text">商业支持</span></p>
  139. <ul>
  140. <li class="toctree-l1"><a class="reference internal" href="../support/index.html">商业支持</a></li>
  141. </ul>
  142. </div>
  143. </div>
  144. </nav>
  145. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  146. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  147. <a href="../index.html">CherryUSB</a>
  148. </nav>
  149. <div class="wy-nav-content">
  150. <div class="rst-content">
  151. <div role="navigation" aria-label="Page navigation">
  152. <ul class="wy-breadcrumbs">
  153. <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
  154. <li class="breadcrumb-item active">基于现有 demo 快速验证</li>
  155. <li class="wy-breadcrumbs-aside">
  156. <a href="../_sources/quick_start/demo.rst.txt" rel="nofollow"> View page source</a>
  157. </li>
  158. </ul>
  159. <hr/>
  160. </div>
  161. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  162. <div itemprop="articleBody">
  163. <section id="demo">
  164. <h1>基于现有 demo 快速验证<a class="headerlink" href="#demo" title="Link to this heading"></a></h1>
  165. <p>在学习 USB 或者是学习 CherryUSB 代码之前,我们需要先基于现有的 demo 进行快速验证,为什么?是为了提升对 USB 的兴趣,能有信心进行下一步的动作,如果 demo 都跑不起来,或者自己摸索写代码,或者先看 USB 基本概念,结果看到最后,
  166. 发现一点都看不懂,概念好多,根本记不住,从而丧失对 USB 的兴趣。因此,先跑 demo 非常重要。下面我将给大家罗列目前支持的 demo 仓库。</p>
  167. <section id="bouffalolab-sdk">
  168. <h2>基于 bouffalolab 系列芯片(官方 SDK 支持)<a class="headerlink" href="#bouffalolab-sdk" title="Link to this heading"></a></h2>
  169. <p>仓库参考:<a class="reference external" href="https://github.com/CherryUSB/cherryusb_bouffalolab">https://github.com/CherryUSB/cherryusb_bouffalolab</a></p>
  170. <ul class="simple">
  171. <li><p>BL616/BL808:USB2.0 内置 HS phy 芯片,支持主从机。device 支持 5 个端点(包括端点0),不支持双向同时使用。</p></li>
  172. <li><p>USB 的相关应用位于 <cite>examples/usbdev</cite> 和 <cite>examples/usbhost</cite> 目录下,根据官方环境搭建完成后,即可编译使用。</p></li>
  173. </ul>
  174. </section>
  175. <section id="hpmicro-sdk">
  176. <h2>基于 HPMicro 系列芯片(官方 SDK 支持)<a class="headerlink" href="#hpmicro-sdk" title="Link to this heading"></a></h2>
  177. <p>仓库参考:<a class="reference external" href="https://github.com/CherryUSB/cherryusb_hpmicro">https://github.com/CherryUSB/cherryusb_hpmicro</a></p>
  178. <ul class="simple">
  179. <li><p>HPM 系列: USB2.0 内置 HS phy 芯片,支持主从机。device 支持 8/16 端点(包括端点0),并且可以同时使用双向,不同芯片个数有差异。</p></li>
  180. <li><p>USB 的相关应用位于 <cite>samples/cherryusb</cite> ,根据官方环境搭建完成后,即可编译使用。</p></li>
  181. </ul>
  182. </section>
  183. <section id="esp32s2-s3-p4-sdk">
  184. <h2>基于 esp32s2/s3/p4 系列芯片(官方 SDK 即将支持)<a class="headerlink" href="#esp32s2-s3-p4-sdk" title="Link to this heading"></a></h2>
  185. <p>仓库参考:<a class="reference external" href="https://github.com/CherryUSB/cherryusb_esp32">https://github.com/CherryUSB/cherryusb_esp32</a></p>
  186. <ul class="simple">
  187. <li><p>esp32s2/s3:USB2.0 内置全速 PHY 芯片,支持主从机,device 支持 7 个端点(包括端点0),并且可以同时使用双向。</p></li>
  188. <li><p>esp32p4:一个 USB2.0 内置全速 PHY 芯片,一个 USB2.0 内置高速 PHY 芯片,支持主从机。</p></li>
  189. <li><p>默认 demo 采用组件库安装的形式,在 <a class="reference external" href="https://components.espressif.com/">https://components.espressif.com/</a> 中搜索 cherryusb 即可</p></li>
  190. </ul>
  191. <p>ESP-Registry 可以参考官方文档,推荐使用 vscode + esp-idf 的开发环境。</p>
  192. <ul class="simple">
  193. <li><p>ctrl + shift + p 选择 ESP-IDF 欢迎界面,然后选择 Component mananger</p></li>
  194. </ul>
  195. <figure class="align-default">
  196. <img alt="../_images/esp1.png" src="../_images/esp1.png" />
  197. </figure>
  198. <ul class="simple">
  199. <li><p>找到 cherryusb 并安装</p></li>
  200. </ul>
  201. <figure class="align-default">
  202. <img alt="../_images/esp2.png" src="../_images/esp2.png" />
  203. </figure>
  204. <ul class="simple">
  205. <li><p>打开 menuconfig,并打开 cherryusb 的配置,根据实际情况选择主机或者从机模式</p></li>
  206. </ul>
  207. <figure class="align-default">
  208. <img alt="../_images/esp3.png" src="../_images/esp3.png" />
  209. </figure>
  210. <figure class="align-default">
  211. <img alt="../_images/esp4.png" src="../_images/esp4.png" />
  212. </figure>
  213. </section>
  214. <section id="sdk">
  215. <h2>基于飞腾派系列芯片(官方 SDK 支持)<a class="headerlink" href="#sdk" title="Link to this heading"></a></h2>
  216. <p>仓库参考:<a class="reference external" href="https://gitee.com/phytium_embedded/phytium-free-rtos-sdk">https://gitee.com/phytium_embedded/phytium-free-rtos-sdk</a></p>
  217. <ul class="simple">
  218. <li><p>飞腾派支持两个 USB3.0 主机(采用 XHCI), 两个 USB2.0 主从机</p></li>
  219. <li><p>USB 的相关应用位于 <cite>example/peripheral/usb</cite> ,根据官方环境搭建完成后,即可编译使用。</p></li>
  220. </ul>
  221. </section>
  222. <section id="essemi-sdk">
  223. <h2>基于 Essemi 系列芯片(官方 SDK 支持)<a class="headerlink" href="#essemi-sdk" title="Link to this heading"></a></h2>
  224. <p>仓库参考:<a class="reference external" href="https://github.com/CherryUSB/cherryusb_es32">https://github.com/CherryUSB/cherryusb_es32</a></p>
  225. <ul class="simple">
  226. <li><p>支持全速和高速主从机。device 支持 6 个端点(包括端点0),并且可以同时使用双向。</p></li>
  227. </ul>
  228. </section>
  229. <section id="artinchip-sdk">
  230. <h2>基于 Artinchip 系列芯片(官方 SDK 支持)<a class="headerlink" href="#artinchip-sdk" title="Link to this heading"></a></h2>
  231. <p>仓库参考:<a class="reference external" href="https://gitee.com/artinchip/luban-lite">https://gitee.com/artinchip/luban-lite</a></p>
  232. <ul class="simple">
  233. <li><p>支持全速和高速主从机,主机采用 EHCI + OHCI。device 支持 8 个端点(包括端点0),并且可以同时使用双向。</p></li>
  234. </ul>
  235. </section>
  236. <section id="canmv-k230-sdk">
  237. <h2>基于 canmv-k230 芯片(官方 SDK 支持)<a class="headerlink" href="#canmv-k230-sdk" title="Link to this heading"></a></h2>
  238. <p>仓库参考:<a class="reference external" href="https://github.com/CherryUSB/k230_sdk">https://github.com/CherryUSB/k230_sdk</a></p>
  239. <ul class="simple">
  240. <li><p>K230: 两个 USB2.0 内置 HS PHY 芯片,支持主从机。device 支持 16 个端点(包括端点0),并且可以同时使用双向。</p></li>
  241. </ul>
  242. </section>
  243. <section id="nxp-mcx">
  244. <h2>基于 NXP MCX系列芯片<a class="headerlink" href="#nxp-mcx" title="Link to this heading"></a></h2>
  245. <p>仓库参考:<a class="reference external" href="https://github.com/CherryUSB/cherryusb_mcx">https://github.com/CherryUSB/cherryusb_mcx</a> 或者 <a class="reference external" href="https://github.com/RT-Thread/rt-thread/tree/master/bsp/nxp/mcx">https://github.com/RT-Thread/rt-thread/tree/master/bsp/nxp/mcx</a></p>
  246. <ul class="simple">
  247. <li><p>支持全速 IP 和高速 IP, 高速 IP 支持主机和从机。device 支持 8 个端点(包括端点0),并且可以同时使用双向。</p></li>
  248. </ul>
  249. </section>
  250. <section id="rp2040-rp2035-sdk">
  251. <h2>基于 RP2040/RP2035 芯片(官方 SDK 即将支持)<a class="headerlink" href="#rp2040-rp2035-sdk" title="Link to this heading"></a></h2>
  252. <p>仓库参考: <a class="reference external" href="https://github.com/CherryUSB/pico-examples">https://github.com/CherryUSB/pico-examples</a> 和 <a class="reference external" href="https://github.com/CherryUSB/pico-sdk">https://github.com/CherryUSB/pico-sdk</a></p>
  253. </section>
  254. <section id="st">
  255. <h2>基于 ST 系列芯片<a class="headerlink" href="#st" title="Link to this heading"></a></h2>
  256. <p>仓库参考:<a class="reference external" href="https://github.com/CherryUSB/cherryusb_stm32">https://github.com/CherryUSB/cherryusb_stm32</a></p>
  257. <p>默认提供以下 demo 工程:</p>
  258. <ul class="simple">
  259. <li><p>F103 使用 fsdev ip</p></li>
  260. <li><p>F429 主从使用 USB1, 引脚 pb14/pb15, 默认从机没有开启 DMA 模式</p></li>
  261. <li><p>H7 设备使用 USB0, 引脚 pa11/pa12,没有开 DMA 模式。主机使用 USB1 ,引脚 pb14/pb15,并且需要做 nocache 处理</p></li>
  262. </ul>
  263. <p>demo 底下提供了 <strong>stm32xxx.ioc</strong> 文件,双击打开,点击 <strong>Generate Code</strong> 即可。</p>
  264. <div class="admonition caution">
  265. <p class="admonition-title">Caution</p>
  266. <p>生成完以后,请使用 git reset 功能将被覆盖的 <cite>main.c</cite> 和 <cite>stm32xxx_it.c</cite> 文件撤回,禁止被 cubemx 覆盖。</p>
  267. </div>
  268. <p>涵盖 F1/F4/H7,其余芯片基本类似,不再赘述,具体区别有:</p>
  269. <ul class="simple">
  270. <li><p>usb ip 区别:F1使用 fsdev,F4/H7使用 dwc2</p></li>
  271. <li><p>dwc2 ip 区别: USB0 (引脚是 PA11/PA12) 和 USB1 (引脚是 PB14/PB15), 其中 USB1 默认全速,可以接外部PHY 形成高速主机,并且带 dma 功能</p></li>
  272. <li><p>F4 无 cache,H7 有 cache</p></li>
  273. </ul>
  274. <p>如果是 STM32F7/STM32H7 这种带 cache 功能,需要将 usb 使用到的 ram 定位到 no cache ram 区域。举例如下</p>
  275. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">cpu_mpu_config</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">MPU_Normal_NonCache</span><span class="p">,</span><span class="w"> </span><span class="mh">0x24070000</span><span class="p">,</span><span class="w"> </span><span class="n">MPU_REGION_SIZE_64KB</span><span class="p">);</span>
  276. </pre></div>
  277. </div>
  278. <p>对应 keil 中的 sct 脚本修改:</p>
  279. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">LR_IROM1</span><span class="w"> </span><span class="mh">0x08000000</span><span class="w"> </span><span class="mh">0x00200000</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">load</span><span class="w"> </span><span class="n">region</span><span class="w"> </span><span class="n">size_region</span>
  280. <span class="n">ER_IROM1</span><span class="w"> </span><span class="mh">0x08000000</span><span class="w"> </span><span class="mh">0x00200000</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">load</span><span class="w"> </span><span class="n">address</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">execution</span><span class="w"> </span><span class="n">address</span>
  281. <span class="o">*</span><span class="p">.</span><span class="n">o</span><span class="w"> </span><span class="p">(</span><span class="n">RESET</span><span class="p">,</span><span class="w"> </span><span class="o">+</span><span class="n">First</span><span class="p">)</span>
  282. <span class="o">*</span><span class="p">(</span><span class="n">InRoot$$Sections</span><span class="p">)</span>
  283. <span class="p">.</span><span class="n">ANY</span><span class="w"> </span><span class="p">(</span><span class="o">+</span><span class="n">RO</span><span class="p">)</span>
  284. <span class="p">.</span><span class="n">ANY</span><span class="w"> </span><span class="p">(</span><span class="o">+</span><span class="n">XO</span><span class="p">)</span>
  285. <span class="p">}</span>
  286. <span class="n">RW_IRAM2</span><span class="w"> </span><span class="mh">0x24000000</span><span class="w"> </span><span class="mh">0x00070000</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">RW</span><span class="w"> </span><span class="n">data</span>
  287. <span class="p">.</span><span class="n">ANY</span><span class="w"> </span><span class="p">(</span><span class="o">+</span><span class="n">RW</span><span class="w"> </span><span class="o">+</span><span class="n">ZI</span><span class="p">)</span>
  288. <span class="p">}</span>
  289. <span class="n">USB_NOCACHERAM</span><span class="w"> </span><span class="mh">0x24070000</span><span class="w"> </span><span class="mh">0x00010000</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">RW</span><span class="w"> </span><span class="n">data</span>
  290. <span class="o">*</span><span class="p">(.</span><span class="n">noncacheable</span><span class="p">)</span>
  291. <span class="p">}</span>
  292. <span class="p">}</span>
  293. </pre></div>
  294. </div>
  295. <section id="usb-device">
  296. <h3>USB Device 移植要点<a class="headerlink" href="#usb-device" title="Link to this heading"></a></h3>
  297. <ul class="simple">
  298. <li><p>使用 <strong>stm32cubemx</strong> 创建工程,配置基本的 RCC、UART (作为log使用)</p></li>
  299. </ul>
  300. <figure class="align-default">
  301. <img alt="../_images/stm32_1.png" src="../_images/stm32_1.png" />
  302. </figure>
  303. <figure class="align-default">
  304. <img alt="../_images/stm32_2.png" src="../_images/stm32_2.png" />
  305. </figure>
  306. <ul class="simple">
  307. <li><p>如果使用 fsdev ip,勾选 <strong>USB</strong> 。如果使用 dwc2 ip,勾选 <strong>USB_OTG_FS</strong> 或者勾选 <strong>USB_OTG_HS</strong>。开启 USB 中断,其他配置对我们没用,代码中不会使用任何 st 的 usb 库。</p></li>
  308. </ul>
  309. <figure class="align-default">
  310. <img alt="../_images/stm32_3_1.png" src="../_images/stm32_3_1.png" />
  311. </figure>
  312. <figure class="align-default">
  313. <img alt="../_images/stm32_3_2.png" src="../_images/stm32_3_2.png" />
  314. </figure>
  315. <ul class="simple">
  316. <li><p>配置 usb clock 为 48M</p></li>
  317. </ul>
  318. <figure class="align-default">
  319. <img alt="../_images/stm32_4_1.png" src="../_images/stm32_4_1.png" />
  320. </figure>
  321. <figure class="align-default">
  322. <img alt="../_images/stm32_4_2.png" src="../_images/stm32_4_2.png" />
  323. </figure>
  324. <ul class="simple">
  325. <li><p>选择好工程,这里我们选择 keil,设置好 stack 和 heap,如果使用 msc 可以推荐设置大点,然后点击 <strong>Generate Code</strong>。</p></li>
  326. </ul>
  327. <figure class="align-default">
  328. <img alt="../_images/stm32_5.png" src="../_images/stm32_5.png" />
  329. </figure>
  330. <ul class="simple">
  331. <li><p>添加 CherryUSB 必须要的源码( <strong>usbd_core.c</strong> 、 <strong>dwc2/usb_dc_dwc2.c</strong> 或者是 <strong>fsdev/usb_dc_fsdev.c</strong> ),以及想要使用的 class 驱动,可以将对应的 class template 添加方便测试。</p></li>
  332. </ul>
  333. <figure class="align-default">
  334. <img alt="../_images/stm32_6.png" src="../_images/stm32_6.png" />
  335. </figure>
  336. <ul class="simple">
  337. <li><p>头文件该加的加</p></li>
  338. </ul>
  339. <figure class="align-default">
  340. <img alt="../_images/stm32_7.png" src="../_images/stm32_7.png" />
  341. </figure>
  342. <ul class="simple">
  343. <li><p>复制一份 <strong>cherryusb_config_template.h</strong>,放到 <cite>Core/Inc</cite> 目录下,并命名为 <cite>usb_config.h</cite></p></li>
  344. </ul>
  345. <figure class="align-default">
  346. <img alt="../_images/stm32_8.png" src="../_images/stm32_8.png" />
  347. </figure>
  348. <ul class="simple">
  349. <li><p>如果使用 fsdev ip,(V1.5.0 开始需要增加 <strong>fsdev/usb_glue_st.c</strong>) 在 <cite>usb_config.h</cite> 中实现以下宏,具体数值不同芯片不一样:</p></li>
  350. </ul>
  351. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cp">#define CONFIG_USBDEV_FSDEV_PMA_ACCESS 2</span>
  352. </pre></div>
  353. </div>
  354. <ul class="simple">
  355. <li><p>编译器推荐使用 <strong>AC6</strong>。勾选 <strong>Microlib</strong>,并实现 <strong>printf</strong> ,方便后续查看 log。</p></li>
  356. </ul>
  357. <figure class="align-default">
  358. <img alt="../_images/stm32_10.png" src="../_images/stm32_10.png" />
  359. </figure>
  360. <figure class="align-default">
  361. <img alt="../_images/stm32_11.png" src="../_images/stm32_11.png" />
  362. </figure>
  363. <div class="admonition note">
  364. <p class="admonition-title">Note</p>
  365. <p>以下两个步骤从 V1.5.0 开始不再需要,<strong>fsdev/usb_glue_st.c</strong>, <strong>dwc2/usb_glue_st.c</strong> 文件中已经实现</p>
  366. </div>
  367. <ul class="simple">
  368. <li><p>拷贝 <strong>xxx_msp.c</strong> 中的 <strong>HAL_PCD_MspInit</strong> 函数中的内容到 <strong>usb_dc_low_level_init</strong> 函数中,屏蔽 st 生成的 usb 初始化</p></li>
  369. </ul>
  370. <figure class="align-default">
  371. <img alt="../_images/stm32_12.png" src="../_images/stm32_12.png" />
  372. </figure>
  373. <figure class="align-default">
  374. <img alt="../_images/stm32_14.png" src="../_images/stm32_14.png" />
  375. </figure>
  376. <ul class="simple">
  377. <li><p>在中断函数中调用 <cite>USBD_IRQHandler</cite>,并传入 <cite>busid</cite></p></li>
  378. </ul>
  379. <figure class="align-default">
  380. <img alt="../_images/stm32_13.png" src="../_images/stm32_13.png" />
  381. </figure>
  382. <ul class="simple">
  383. <li><p>如果芯片带 cache,cache 修改参考 <a class="reference internal" href="transplant.html#usb-cache"><span class="std std-ref">cache 配置修改</span></a> 章节</p></li>
  384. <li><p>调用 template 的内容初始化,并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite>, <cite>busid</cite> 从 0 开始,不能超过 <cite>CONFIG_USBDEV_MAX_BUS</cite></p></li>
  385. </ul>
  386. <figure class="align-default">
  387. <img alt="../_images/stm32_15.png" src="../_images/stm32_15.png" />
  388. </figure>
  389. </section>
  390. <section id="usb-host">
  391. <h3>USB Host 移植要点<a class="headerlink" href="#usb-host" title="Link to this heading"></a></h3>
  392. <p>前面 6 步与 Device 一样。需要注意,host 驱动只支持带 dma 的 hs port (引脚是 PB14/PB15),所以 fs port (引脚是 PA11/PA12)不做支持(没有 dma 你玩什么主机)。</p>
  393. <ul class="simple">
  394. <li><p>添加 CherryUSB 必须要的源码( <strong>usbh_core.c</strong> 、 <strong>usbh_hub.c</strong> 、 <strong>usb_hc_dwc2.c</strong> 、 <strong>usb_glue_st.c</strong> 以及 <strong>osal</strong> 目录下的适配层文件),以及想要使用的 class 驱动,并且可以将对应的 <strong>usb host.c</strong> 添加方便测试。</p></li>
  395. </ul>
  396. <figure class="align-default">
  397. <img alt="../_images/stm32_16.png" src="../_images/stm32_16.png" />
  398. </figure>
  399. <ul class="simple">
  400. <li><p>编译器推荐使用 <strong>AC6</strong>。勾选 <strong>Microlib</strong>,并实现 <strong>printf</strong> ,方便后续查看 log。</p></li>
  401. </ul>
  402. <figure class="align-default">
  403. <img alt="../_images/stm32_10.png" src="../_images/stm32_10.png" />
  404. </figure>
  405. <figure class="align-default">
  406. <img alt="../_images/stm32_11.png" src="../_images/stm32_11.png" />
  407. </figure>
  408. <ul class="simple">
  409. <li><p>复制一份 <strong>cherryusb_config_template.h</strong>,放到 <cite>Core/Inc</cite> 目录下,并命名为 <cite>usb_config.h</cite></p></li>
  410. </ul>
  411. <div class="admonition note">
  412. <p class="admonition-title">Note</p>
  413. <p>以下两个步骤从 V1.5.0 开始不再需要,<strong>fsdev/usb_glue_st.c</strong>, <strong>dwc2/usb_glue_st.c</strong> 文件中已经实现</p>
  414. </div>
  415. <ul class="simple">
  416. <li><p>拷贝 <strong>xxx_msp.c</strong> 中的 <cite>HAL_HCD_MspInit</cite> 函数中的内容到 <cite>usb_hc_low_level_init</cite> 函数中,屏蔽 st 生成的 usb 初始化</p></li>
  417. <li><p>在中断函数中调用 <cite>USBH_IRQHandler</cite>,并传入 <cite>busid</cite></p></li>
  418. </ul>
  419. <figure class="align-default">
  420. <img alt="../_images/stm32_19.png" src="../_images/stm32_19.png" />
  421. </figure>
  422. <ul class="simple">
  423. <li><p>链接脚本修改参考 <a class="reference internal" href="transplant.html#usbh-link-script"><span class="std std-ref">主机链接脚本修改</span></a> 章节</p></li>
  424. <li><p>如果芯片带 cache,cache 修改参考 <a class="reference internal" href="transplant.html#usb-cache"><span class="std std-ref">cache 配置修改</span></a> 章节</p></li>
  425. <li><p>调用 <cite>usbh_initialize</cite> 并填入 <cite>busid</cite> 和 USB IP 的 <cite>reg base</cite> 还有 <cite>event_handler</cite> 可缺省为NULL, <cite>busid</cite> 从 0 开始,不能超过 <cite>CONFIG_USBHOST_MAX_BUS</cite></p></li>
  426. <li><p>启动线程</p></li>
  427. </ul>
  428. <figure class="align-default">
  429. <img alt="../_images/stm32_18.png" src="../_images/stm32_18.png" />
  430. </figure>
  431. </section>
  432. </section>
  433. </section>
  434. </div>
  435. </div>
  436. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  437. <a href="start.html" class="btn btn-neutral float-left" title="入门必看" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  438. <a href="transplant.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>
  439. </div>
  440. <hr/>
  441. <div role="contentinfo">
  442. <p>&#169; Copyright 2022 ~ 2025, sakumisu.</p>
  443. </div>
  444. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  445. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  446. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  447. </footer>
  448. </div>
  449. </div>
  450. </section>
  451. </div>
  452. <script>
  453. jQuery(function () {
  454. SphinxRtdTheme.Navigation.enable(true);
  455. });
  456. </script>
  457. </body>
  458. </html>