api_host.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  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="api_port.html" />
  18. <link rel="prev" title="设备协议栈" href="api_device.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 class="current">
  58. <li class="toctree-l1"><a class="reference internal" href="api_device.html">设备协议栈</a></li>
  59. <li class="toctree-l1 current"><a class="current reference internal" href="#">主机协议栈</a><ul>
  60. <li class="toctree-l2"><a class="reference internal" href="#core">CORE</a><ul>
  61. <li class="toctree-l3"><a class="reference internal" href="#class">CLASS 驱动信息结构体</a></li>
  62. <li class="toctree-l3"><a class="reference internal" href="#id2">端点结构体</a></li>
  63. <li class="toctree-l3"><a class="reference internal" href="#id3">接口备用结构体</a></li>
  64. <li class="toctree-l3"><a class="reference internal" href="#id4">接口结构体</a></li>
  65. <li class="toctree-l3"><a class="reference internal" href="#id5">配置结构体</a></li>
  66. <li class="toctree-l3"><a class="reference internal" href="#hubport">hubport 结构体</a></li>
  67. <li class="toctree-l3"><a class="reference internal" href="#hub">hub 结构体</a></li>
  68. <li class="toctree-l3"><a class="reference internal" href="#usbh-initialize">usbh_initialize</a></li>
  69. <li class="toctree-l3"><a class="reference internal" href="#usbh-find-class-instance">usbh_find_class_instance</a></li>
  70. <li class="toctree-l3"><a class="reference internal" href="#lsusb">lsusb</a></li>
  71. </ul>
  72. </li>
  73. <li class="toctree-l2"><a class="reference internal" href="#cdc-acm">CDC ACM</a></li>
  74. <li class="toctree-l2"><a class="reference internal" href="#hid">HID</a></li>
  75. <li class="toctree-l2"><a class="reference internal" href="#msc">MSC</a></li>
  76. <li class="toctree-l2"><a class="reference internal" href="#rndis">RNDIS</a></li>
  77. </ul>
  78. </li>
  79. <li class="toctree-l1"><a class="reference internal" href="api_port.html">主从驱动</a></li>
  80. <li class="toctree-l1"><a class="reference internal" href="api_config.html">USB CONFIG 说明</a></li>
  81. </ul>
  82. <p class="caption" role="heading"><span class="caption-text">Class 指南</span></p>
  83. <ul>
  84. <li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
  85. <li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
  86. <li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
  87. <li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
  88. <li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
  89. <li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
  90. </ul>
  91. <p class="caption" role="heading"><span class="caption-text">例程说明</span></p>
  92. <ul>
  93. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_cdc_acm.html">usbd_cdc_acm</a></li>
  94. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_hid.html">usbd_hid</a></li>
  95. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
  96. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
  97. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
  98. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
  99. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
  100. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
  101. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
  102. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
  103. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_adb.html">usbd_adb</a></li>
  104. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
  105. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
  106. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
  107. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
  108. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_bluetooth.html">usbh_bluetooth</a></li>
  109. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_wifi.html">usbh_wifi</a></li>
  110. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_vendor.html">vendor device 驱动编写</a></li>
  111. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_vendor.html">vendor host 驱动编写</a></li>
  112. </ul>
  113. <p class="caption" role="heading"><span class="caption-text">USBIP 介绍</span></p>
  114. <ul>
  115. <li class="toctree-l1"><a class="reference internal" href="../usbip/ohci.html">OHCI</a></li>
  116. <li class="toctree-l1"><a class="reference internal" href="../usbip/ehci.html">EHCI</a></li>
  117. <li class="toctree-l1"><a class="reference internal" href="../usbip/xhci.html">XHCI</a></li>
  118. <li class="toctree-l1"><a class="reference internal" href="../usbip/chipidea.html">CHIPIDEA</a></li>
  119. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc2.html">DWC2</a></li>
  120. <li class="toctree-l1"><a class="reference internal" href="../usbip/musb.html">MUSB</a></li>
  121. <li class="toctree-l1"><a class="reference internal" href="../usbip/fotg210.html">FOTG210</a></li>
  122. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns2.html">CDNS2</a></li>
  123. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns3.html">CDNS3</a></li>
  124. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc3.html">DWC3</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="../tools/index.html">chryusb_configurator</a></li>
  129. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#usb-protocol-suite">力科 USB Protocol Suite</a></li>
  130. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#wireshark">Wireshark</a></li>
  131. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#audacity">Audacity</a></li>
  132. </ul>
  133. <p class="caption" role="heading"><span class="caption-text">版本说明</span></p>
  134. <ul>
  135. <li class="toctree-l1"><a class="reference internal" href="../version.html">版本说明</a></li>
  136. </ul>
  137. <p class="caption" role="heading"><span class="caption-text">性能展示</span></p>
  138. <ul>
  139. <li class="toctree-l1"><a class="reference internal" href="../show/index.html">性能展示</a></li>
  140. </ul>
  141. <p class="caption" role="heading"><span class="caption-text">商业支持</span></p>
  142. <ul>
  143. <li class="toctree-l1"><a class="reference internal" href="../support/index.html">商业支持</a></li>
  144. </ul>
  145. </div>
  146. </div>
  147. </nav>
  148. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  149. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  150. <a href="../index.html">CherryUSB</a>
  151. </nav>
  152. <div class="wy-nav-content">
  153. <div class="rst-content">
  154. <div role="navigation" aria-label="Page navigation">
  155. <ul class="wy-breadcrumbs">
  156. <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
  157. <li class="breadcrumb-item active">主机协议栈</li>
  158. <li class="wy-breadcrumbs-aside">
  159. <a href="../_sources/api/api_host.rst.txt" rel="nofollow"> View page source</a>
  160. </li>
  161. </ul>
  162. <hr/>
  163. </div>
  164. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  165. <div itemprop="articleBody">
  166. <section id="id1">
  167. <h1>主机协议栈<a class="headerlink" href="#id1" title="Link to this heading"></a></h1>
  168. <p>关于主机协议栈中结构体的命名、分类、成员组成,参考下面这两张图:</p>
  169. <figure class="align-default">
  170. <img alt="../_images/api_host1.png" src="../_images/api_host1.png" />
  171. </figure>
  172. <figure class="align-default">
  173. <img alt="../_images/api_host2.png" src="../_images/api_host2.png" />
  174. </figure>
  175. <section id="core">
  176. <h2>CORE<a class="headerlink" href="#core" title="Link to this heading"></a></h2>
  177. <section id="class">
  178. <h3>CLASS 驱动信息结构体<a class="headerlink" href="#class" title="Link to this heading"></a></h3>
  179. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_class_info</span><span class="w"> </span><span class="p">{</span>
  180. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">match_flags</span><span class="p">;</span><span class="w"> </span><span class="cm">/* Used for product specific matches; range is inclusive */</span>
  181. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">bInterfaceClass</span><span class="p">;</span><span class="w"> </span><span class="cm">/* Base device class code */</span>
  182. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">bInterfaceSubClass</span><span class="p">;</span><span class="w"> </span><span class="cm">/* Sub-class, depends on base class. Eg. */</span>
  183. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">bInterfaceProtocol</span><span class="p">;</span><span class="w"> </span><span class="cm">/* Protocol, depends on base class. Eg. */</span>
  184. <span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">uint16_t</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">id_table</span><span class="p">)[</span><span class="mi">2</span><span class="p">];</span><span class="w"> </span><span class="cm">/* List of Vendor/Product ID pairs */</span>
  185. <span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_class_driver</span><span class="w"> </span><span class="o">*</span><span class="n">class_driver</span><span class="p">;</span>
  186. <span class="p">};</span>
  187. </pre></div>
  188. </div>
  189. </section>
  190. <section id="id2">
  191. <h3>端点结构体<a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
  192. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_endpoint</span><span class="w"> </span><span class="p">{</span>
  193. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_endpoint_descriptor</span><span class="w"> </span><span class="n">ep_desc</span><span class="p">;</span>
  194. <span class="p">};</span>
  195. </pre></div>
  196. </div>
  197. </section>
  198. <section id="id3">
  199. <h3>接口备用结构体<a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
  200. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_interface_altsetting</span><span class="w"> </span><span class="p">{</span>
  201. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_interface_descriptor</span><span class="w"> </span><span class="n">intf_desc</span><span class="p">;</span>
  202. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_endpoint</span><span class="w"> </span><span class="n">ep</span><span class="p">[</span><span class="n">CONFIG_USBHOST_MAX_ENDPOINTS</span><span class="p">];</span>
  203. <span class="p">};</span>
  204. </pre></div>
  205. </div>
  206. </section>
  207. <section id="id4">
  208. <h3>接口结构体<a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
  209. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_interface</span><span class="w"> </span><span class="p">{</span>
  210. <span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">devname</span><span class="p">[</span><span class="n">CONFIG_USBHOST_DEV_NAMELEN</span><span class="p">];</span>
  211. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_class_driver</span><span class="w"> </span><span class="o">*</span><span class="n">class_driver</span><span class="p">;</span>
  212. <span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="n">priv</span><span class="p">;</span>
  213. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_interface_altsetting</span><span class="w"> </span><span class="n">altsetting</span><span class="p">[</span><span class="n">CONFIG_USBHOST_MAX_INTF_ALTSETTINGS</span><span class="p">];</span>
  214. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">altsetting_num</span><span class="p">;</span>
  215. <span class="p">};</span>
  216. </pre></div>
  217. </div>
  218. </section>
  219. <section id="id5">
  220. <h3>配置结构体<a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
  221. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_configuration</span><span class="w"> </span><span class="p">{</span>
  222. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_configuration_descriptor</span><span class="w"> </span><span class="n">config_desc</span><span class="p">;</span>
  223. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_interface</span><span class="w"> </span><span class="n">intf</span><span class="p">[</span><span class="n">CONFIG_USBHOST_MAX_INTERFACES</span><span class="p">];</span>
  224. <span class="p">};</span>
  225. </pre></div>
  226. </div>
  227. </section>
  228. <section id="hubport">
  229. <h3>hubport 结构体<a class="headerlink" href="#hubport" title="Link to this heading"></a></h3>
  230. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_hubport</span><span class="w"> </span><span class="p">{</span>
  231. <span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">connected</span><span class="p">;</span><span class="w"> </span><span class="cm">/* True: device connected; false: disconnected */</span>
  232. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">port</span><span class="p">;</span><span class="w"> </span><span class="cm">/* Hub port index */</span>
  233. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">dev_addr</span><span class="p">;</span><span class="w"> </span><span class="cm">/* device address */</span>
  234. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">speed</span><span class="p">;</span><span class="w"> </span><span class="cm">/* device speed */</span>
  235. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">depth</span><span class="p">;</span><span class="w"> </span><span class="cm">/* distance from root hub */</span>
  236. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">route</span><span class="p">;</span><span class="w"> </span><span class="cm">/* route string */</span>
  237. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">slot_id</span><span class="p">;</span><span class="w"> </span><span class="cm">/* slot id */</span>
  238. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_device_descriptor</span><span class="w"> </span><span class="n">device_desc</span><span class="p">;</span>
  239. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_configuration</span><span class="w"> </span><span class="n">config</span><span class="p">;</span>
  240. <span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">iManufacturer</span><span class="p">;</span>
  241. <span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">iProduct</span><span class="p">;</span>
  242. <span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">iSerialNumber</span><span class="p">;</span>
  243. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">raw_config_desc</span><span class="p">;</span>
  244. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_setup_packet</span><span class="w"> </span><span class="o">*</span><span class="n">setup</span><span class="p">;</span>
  245. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_hub</span><span class="w"> </span><span class="o">*</span><span class="n">parent</span><span class="p">;</span>
  246. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_hub</span><span class="w"> </span><span class="o">*</span><span class="n">self</span><span class="p">;</span><span class="w"> </span><span class="cm">/* if this hubport is a hub */</span>
  247. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_bus</span><span class="w"> </span><span class="o">*</span><span class="n">bus</span><span class="p">;</span>
  248. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_endpoint_descriptor</span><span class="w"> </span><span class="n">ep0</span><span class="p">;</span>
  249. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_urb</span><span class="w"> </span><span class="n">ep0_urb</span><span class="p">;</span>
  250. <span class="w"> </span><span class="n">usb_osal_mutex_t</span><span class="w"> </span><span class="n">mutex</span><span class="p">;</span>
  251. <span class="p">};</span>
  252. </pre></div>
  253. </div>
  254. </section>
  255. <section id="hub">
  256. <h3>hub 结构体<a class="headerlink" href="#hub" title="Link to this heading"></a></h3>
  257. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_hub</span><span class="w"> </span><span class="p">{</span>
  258. <span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">connected</span><span class="p">;</span>
  259. <span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">is_roothub</span><span class="p">;</span>
  260. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">index</span><span class="p">;</span>
  261. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">hub_addr</span><span class="p">;</span>
  262. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">speed</span><span class="p">;</span>
  263. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">nports</span><span class="p">;</span>
  264. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">powerdelay</span><span class="p">;</span>
  265. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">tt_think</span><span class="p">;</span>
  266. <span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">ismtt</span><span class="p">;</span>
  267. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_hub_descriptor</span><span class="w"> </span><span class="n">hub_desc</span><span class="p">;</span><span class="w"> </span><span class="cm">/* USB 2.0 only */</span>
  268. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_hub_ss_descriptor</span><span class="w"> </span><span class="n">hub_ss_desc</span><span class="p">;</span><span class="w"> </span><span class="cm">/* USB 3.0 only */</span>
  269. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_hubport</span><span class="w"> </span><span class="n">child</span><span class="p">[</span><span class="n">CONFIG_USBHOST_MAX_EHPORTS</span><span class="p">];</span>
  270. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_hubport</span><span class="w"> </span><span class="o">*</span><span class="n">parent</span><span class="p">;</span>
  271. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_bus</span><span class="w"> </span><span class="o">*</span><span class="n">bus</span><span class="p">;</span>
  272. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_endpoint_descriptor</span><span class="w"> </span><span class="o">*</span><span class="n">intin</span><span class="p">;</span>
  273. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usbh_urb</span><span class="w"> </span><span class="n">intin_urb</span><span class="p">;</span>
  274. <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">int_buffer</span><span class="p">;</span>
  275. <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">usb_osal_timer</span><span class="w"> </span><span class="o">*</span><span class="n">int_timer</span><span class="p">;</span>
  276. <span class="p">};</span>
  277. </pre></div>
  278. </div>
  279. </section>
  280. <section id="usbh-initialize">
  281. <h3>usbh_initialize<a class="headerlink" href="#usbh-initialize" title="Link to this heading"></a></h3>
  282. <p><code class="docutils literal notranslate"><span class="pre">usbh_initialize</span></code> 用来初始化 usb 主机协议栈,包括:初始化 usb 主机控制器,创建 roothub 设备,创建 hub 检测线程。</p>
  283. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span><span class="w"> </span><span class="nf">usbh_initialize</span><span class="p">(</span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">busid</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">reg_base</span><span class="p">,</span><span class="w"> </span><span class="n">usbh_event_handler_t</span><span class="w"> </span><span class="n">event_handler</span><span class="p">);</span>
  284. </pre></div>
  285. </div>
  286. <ul class="simple">
  287. <li><p><strong>busid</strong> bus id,从 0开始,不能超过 <cite>CONFIG_USBHOST_MAX_BUS</cite></p></li>
  288. <li><p><strong>reg_base</strong> hcd 寄存器基地址</p></li>
  289. <li><p><strong>event_handler</strong> host 事件回调函数,可以为NULL</p></li>
  290. <li><p><strong>return</strong> 0 表示正常其他表示错误</p></li>
  291. </ul>
  292. </section>
  293. <section id="usbh-find-class-instance">
  294. <h3>usbh_find_class_instance<a class="headerlink" href="#usbh-find-class-instance" title="Link to this heading"></a></h3>
  295. <p><code class="docutils literal notranslate"><span class="pre">usbh_find_class_instance</span></code> 根据注册的 class 名称查找对应的 class 结构体句柄。</p>
  296. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="nf">usbh_find_class_instance</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">devname</span><span class="p">);</span>
  297. </pre></div>
  298. </div>
  299. <ul class="simple">
  300. <li><p><strong>devname</strong> class 名称</p></li>
  301. <li><p><strong>return</strong> class 结构体句柄</p></li>
  302. </ul>
  303. </section>
  304. <section id="lsusb">
  305. <h3>lsusb<a class="headerlink" href="#lsusb" title="Link to this heading"></a></h3>
  306. <p><code class="docutils literal notranslate"><span class="pre">lsusb</span></code> 用来查看和操作 hub 上的设备信息。需要借助 shell 插件使用。</p>
  307. <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span><span class="w"> </span><span class="nf">lsusb</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">argc</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">argv</span><span class="p">);</span>
  308. </pre></div>
  309. </div>
  310. </section>
  311. </section>
  312. <section id="cdc-acm">
  313. <h2>CDC ACM<a class="headerlink" href="#cdc-acm" title="Link to this heading"></a></h2>
  314. </section>
  315. <section id="hid">
  316. <h2>HID<a class="headerlink" href="#hid" title="Link to this heading"></a></h2>
  317. </section>
  318. <section id="msc">
  319. <h2>MSC<a class="headerlink" href="#msc" title="Link to this heading"></a></h2>
  320. </section>
  321. <section id="rndis">
  322. <h2>RNDIS<a class="headerlink" href="#rndis" title="Link to this heading"></a></h2>
  323. </section>
  324. </section>
  325. </div>
  326. </div>
  327. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  328. <a href="api_device.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>
  329. <a href="api_port.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>
  330. </div>
  331. <hr/>
  332. <div role="contentinfo">
  333. <p>&#169; Copyright 2022 ~ 2025, sakumisu.</p>
  334. </div>
  335. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  336. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  337. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  338. </footer>
  339. </div>
  340. </div>
  341. </section>
  342. </div>
  343. <script>
  344. jQuery(function () {
  345. SphinxRtdTheme.Navigation.enable(true);
  346. });
  347. </script>
  348. </body>
  349. </html>