Inicio Explorar Axuda
Iniciar sesión
cherry-embedded
/
CherryUSB
réplica de https://github-proxy.rt-thread.io/cherry-embedded/CherryUSB.git
2
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: 41a9842018
Ramas Etiquetas
CherryUSB
/
api
/
api_host.html

api_host.html 30 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <html class="writer-html5" lang="en" data-content_root="../">
    5. 

  5. <head>
    6. 

  6.   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    7. 

  7. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    9. 

  9.   <title>主机协议栈 &mdash; CherryUSB 1.5.3 documentation</title>
    10. 

  10.       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
    11. 

  11.       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
    12. 

  12. 

  13.   
    14. 

  14.       <script src="../_static/jquery.js?v=5d32c60e"></script>
    15. 

  15.       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
    16. 

  16.       <script src="../_static/documentation_options.js?v=d75fd82e"></script>
    17. 

  17.       <script src="../_static/doctools.js?v=9a2dae69"></script>
    18. 

  18.       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    19. 

  19.     <script src="../_static/js/theme.js"></script>
    20. 

  20.     <link rel="index" title="Index" href="../genindex.html" />
    21. 

  21.     <link rel="search" title="Search" href="../search.html" />
    22. 

  22.     <link rel="next" title="主从驱动" href="api_port.html" />
    23. 

  23.     <link rel="prev" title="设备协议栈" href="api_device.html" /> 
    24. 

  24. </head>
    25. 

  25. 

  26. <body class="wy-body-for-nav"> 
    27. 

  27.   <div class="wy-grid-for-nav">
    28. 

  28.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    29. 

  29.       <div class="wy-side-scroll">
    30. 

  30.         <div class="wy-side-nav-search" >
    31. 

  31. 

  32.           
    33. 

  33.           
    34. 

  34.           <a href="../index.html" class="icon icon-home">
    35. 

  35.             CherryUSB
    36. 

  36.           </a>
    37. 

  37. <div role="search">
    38. 

  38.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    39. 

  39.     <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    40. 

  40.     <input type="hidden" name="check_keywords" value="yes" />
    41. 

  41.     <input type="hidden" name="area" value="default" />
    42. 

  42.   </form>
    43. 

  43. </div>
    44. 

  44.         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    45. 

  45.               <p class="caption" role="heading"><span class="caption-text">快速上手</span></p>
    46. 

  46. <ul>
    47. 

  47. <li class="toctree-l1"><a class="reference internal" href="../quick_start/start.html">入门必看</a></li>
    48. 

  48. <li class="toctree-l1"><a class="reference internal" href="../quick_start/demo.html">基于现有 demo 快速验证</a></li>
    49. 

  49. <li class="toctree-l1"><a class="reference internal" href="../quick_start/transplant.html">芯片通用移植指南</a></li>
    50. 

  50. <li class="toctree-l1"><a class="reference internal" href="../quick_start/rtthread.html">基于 RT-Thread 软件包开发指南</a></li>
    51. 

  51. <li class="toctree-l1"><a class="reference internal" href="../quick_start/q%26a.html">Q &amp; A</a></li>
    52. 

  52. <li class="toctree-l1"><a class="reference internal" href="../quick_start/share.html">开发者经验/开源项目分享</a></li>
    53. 

  53. <li class="toctree-l1"><a class="reference internal" href="../quick_start/opensource.html">官方开源项目分享</a></li>
    54. 

  54. </ul>
    55. 

  55. <p class="caption" role="heading"><span class="caption-text">USB 基本知识点</span></p>
    56. 

  56. <ul>
    57. 

  57. <li class="toctree-l1"><a class="reference internal" href="../usb/usb2.0_basic.html">USB 基本概念(2.0 为主)</a></li>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="../usb/usb3.0_basic.html">USB 基本概念(3.0 为主)</a></li>
    59. 

  59. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_desc.html">USB 描述符</a></li>
    60. 

  60. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_request.html">USB 设备请求</a></li>
    61. 

  61. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_enum.html">USB 枚举</a></li>
    62. 

  62. <li class="toctree-l1"><a class="reference internal" href="../usb/usb_ext.html">USB 知识点拓展</a></li>
    63. 

  63. </ul>
    64. 

  64. <p class="caption" role="heading"><span class="caption-text">API 手册</span></p>
    65. 

  65. <ul class="current">
    66. 

  66. <li class="toctree-l1"><a class="reference internal" href="api_device.html">设备协议栈</a></li>
    67. 

  67. <li class="toctree-l1 current"><a class="current reference internal" href="#">主机协议栈</a><ul>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="#core">CORE</a><ul>
    69. 

  69. <li class="toctree-l3"><a class="reference internal" href="#class">CLASS 驱动信息结构体</a></li>
    70. 

  70. <li class="toctree-l3"><a class="reference internal" href="#id2">端点结构体</a></li>
    71. 

  71. <li class="toctree-l3"><a class="reference internal" href="#id3">接口备用结构体</a></li>
    72. 

  72. <li class="toctree-l3"><a class="reference internal" href="#id4">接口结构体</a></li>
    73. 

  73. <li class="toctree-l3"><a class="reference internal" href="#id5">配置结构体</a></li>
    74. 

  74. <li class="toctree-l3"><a class="reference internal" href="#hubport">hubport 结构体</a></li>
    75. 

  75. <li class="toctree-l3"><a class="reference internal" href="#hub">hub 结构体</a></li>
    76. 

  76. <li class="toctree-l3"><a class="reference internal" href="#usbh-initialize">usbh_initialize</a></li>
    77. 

  77. <li class="toctree-l3"><a class="reference internal" href="#usbh-find-class-instance">usbh_find_class_instance</a></li>
    78. 

  78. <li class="toctree-l3"><a class="reference internal" href="#lsusb">lsusb</a></li>
    79. 

  79. </ul>
    80. 

  80. </li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="#cdc-acm">CDC ACM</a></li>
    82. 

  82. <li class="toctree-l2"><a class="reference internal" href="#hid">HID</a></li>
    83. 

  83. <li class="toctree-l2"><a class="reference internal" href="#msc">MSC</a></li>
    84. 

  84. <li class="toctree-l2"><a class="reference internal" href="#rndis">RNDIS</a></li>
    85. 

  85. </ul>
    86. 

  86. </li>
    87. 

  87. <li class="toctree-l1"><a class="reference internal" href="api_port.html">主从驱动</a></li>
    88. 

  88. <li class="toctree-l1"><a class="reference internal" href="api_config.html">USB CONFIG 说明</a></li>
    89. 

  89. </ul>
    90. 

  90. <p class="caption" role="heading"><span class="caption-text">Class 指南</span></p>
    91. 

  91. <ul>
    92. 

  92. <li class="toctree-l1"><a class="reference internal" href="../class/class_cdc.html">CDC</a></li>
    93. 

  93. <li class="toctree-l1"><a class="reference internal" href="../class/class_hid.html">HID</a></li>
    94. 

  94. <li class="toctree-l1"><a class="reference internal" href="../class/class_msc.html">MSC</a></li>
    95. 

  95. <li class="toctree-l1"><a class="reference internal" href="../class/class_audio.html">UAC</a></li>
    96. 

  96. <li class="toctree-l1"><a class="reference internal" href="../class/class_video.html">UVC</a></li>
    97. 

  97. <li class="toctree-l1"><a class="reference internal" href="../class/winusb.html">WINUSB</a></li>
    98. 

  98. </ul>
    99. 

  99. <p class="caption" role="heading"><span class="caption-text">例程说明</span></p>
    100. 

  100. <ul>
    101. 

  101. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_cdc_acm.html">usbd_cdc_acm</a></li>
    102. 

  102. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_hid.html">usbd_hid</a></li>
    103. 

  103. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_msc.html">usbd_msc</a></li>
    104. 

  104. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_rndis.html">usbd_rndis</a></li>
    105. 

  105. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_ecm.html">usbd_cdc_ecm</a></li>
    106. 

  106. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov1.html">usbd_audiov1</a></li>
    107. 

  107. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_audiov2.html">usbd_audiov2</a></li>
    108. 

  108. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_video.html">usbd_video</a></li>
    109. 

  109. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_winusb.html">usbd_winusb</a></li>
    110. 

  110. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_webusb.html">usbd_webusb</a></li>
    111. 

  111. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_adb.html">usbd_adb</a></li>
    112. 

  112. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_serial.html">usbh_serial</a></li>
    113. 

  113. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_hid.html">usbh_hid</a></li>
    114. 

  114. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_msc.html">usbh_msc</a></li>
    115. 

  115. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_net.html">usbh_net</a></li>
    116. 

  116. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_bluetooth.html">usbh_bluetooth</a></li>
    117. 

  117. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_wifi.html">usbh_wifi</a></li>
    118. 

  118. <li class="toctree-l1"><a class="reference internal" href="../demo/usbd_vendor.html">vendor device 驱动编写</a></li>
    119. 

  119. <li class="toctree-l1"><a class="reference internal" href="../demo/usbh_vendor.html">vendor host 驱动编写</a></li>
    120. 

  120. <li class="toctree-l1"><a class="reference internal" href="../demo/usb_otg.html">OTG 功能的使用</a></li>
    121. 

  121. </ul>
    122. 

  122. <p class="caption" role="heading"><span class="caption-text">USBIP 介绍</span></p>
    123. 

  123. <ul>
    124. 

  124. <li class="toctree-l1"><a class="reference internal" href="../usbip/ohci.html">OHCI</a></li>
    125. 

  125. <li class="toctree-l1"><a class="reference internal" href="../usbip/ehci.html">EHCI</a></li>
    126. 

  126. <li class="toctree-l1"><a class="reference internal" href="../usbip/xhci.html">XHCI</a></li>
    127. 

  127. <li class="toctree-l1"><a class="reference internal" href="../usbip/chipidea.html">CHIPIDEA</a></li>
    128. 

  128. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc2.html">DWC2</a></li>
    129. 

  129. <li class="toctree-l1"><a class="reference internal" href="../usbip/musb.html">MUSB</a></li>
    130. 

  130. <li class="toctree-l1"><a class="reference internal" href="../usbip/fotg210.html">FOTG210</a></li>
    131. 

  131. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns2.html">CDNS2</a></li>
    132. 

  132. <li class="toctree-l1"><a class="reference internal" href="../usbip/cdns3.html">CDNS3</a></li>
    133. 

  133. <li class="toctree-l1"><a class="reference internal" href="../usbip/dwc3.html">DWC3</a></li>
    134. 

  134. </ul>
    135. 

  135. <p class="caption" role="heading"><span class="caption-text">工具使用</span></p>
    136. 

  136. <ul>
    137. 

  137. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">chryusb_configurator</a></li>
    138. 

  138. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#usb-protocol-suite">力科 USB Protocol Suite</a></li>
    139. 

  139. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#wireshark">Wireshark</a></li>
    140. 

  140. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html#audacity">Audacity</a></li>
    141. 

  141. </ul>
    142. 

  142. <p class="caption" role="heading"><span class="caption-text">版本说明</span></p>
    143. 

  143. <ul>
    144. 

  144. <li class="toctree-l1"><a class="reference internal" href="../version.html">版本说明</a></li>
    145. 

  145. </ul>
    146. 

  146. <p class="caption" role="heading"><span class="caption-text">性能展示</span></p>
    147. 

  147. <ul>
    148. 

  148. <li class="toctree-l1"><a class="reference internal" href="../show/index.html">性能展示</a></li>
    149. 

  149. </ul>
    150. 

  150. <p class="caption" role="heading"><span class="caption-text">商业支持</span></p>
    151. 

  151. <ul>
    152. 

  152. <li class="toctree-l1"><a class="reference internal" href="../support/index.html">商业支持</a></li>
    153. 

  153. </ul>
    154. 

  154. 

  155.         </div>
    156. 

  156.       </div>
    157. 

  157.     </nav>
    158. 

  158. 

  159.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
    160. 

  160.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    161. 

  161.           <a href="../index.html">CherryUSB</a>
    162. 

  162.       </nav>
    163. 

  163. 

  164.       <div class="wy-nav-content">
    165. 

  165.         <div class="rst-content">
    166. 

  166.           <div role="navigation" aria-label="Page navigation">
    167. 

  167.   <ul class="wy-breadcrumbs">
    168. 

  168.       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
    169. 

  169.       <li class="breadcrumb-item active">主机协议栈</li>
    170. 

  170.       <li class="wy-breadcrumbs-aside">
    171. 

  171.             <a href="../_sources/api/api_host.rst.txt" rel="nofollow"> View page source</a>
    172. 

  172.       </li>
    173. 

  173.   </ul>
    174. 

  174.   <hr/>
    175. 

  175. </div>
    176. 

  176.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
    177. 

  177.            <div itemprop="articleBody">
    178. 

  178.              
    179. 

  179.   <section id="id1">
    180. 

  180. <h1>主机协议栈<a class="headerlink" href="#id1" title="Link to this heading"></a></h1>
    181. 

  181. <p>关于主机协议栈中结构体的命名、分类、成员组成，参考下面这两张图：</p>
    182. 

  182. <figure class="align-default">
    183. 

  183. <img alt="../_images/api_host1.png" src="../_images/api_host1.png" />
    184. 

  184. </figure>
    185. 

  185. <figure class="align-default">
    186. 

  186. <img alt="../_images/api_host2.png" src="../_images/api_host2.png" />
    187. 

  187. </figure>
    188. 

  188. <section id="core">
    189. 

  189. <h2>CORE<a class="headerlink" href="#core" title="Link to this heading"></a></h2>
    190. 

  190. <section id="class">
    191. 

  191. <h3>CLASS 驱动信息结构体<a class="headerlink" href="#class" title="Link to this heading"></a></h3>
    192. 

  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_class_info</span><span class="w"> </span><span class="p">{</span>
    193. 

  193. <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>
    194. 

  194. <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>
    195. 

  195. <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>
    196. 

  196. <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>
    197. 

  197. <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>
    198. 

  198. <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>
    199. 

  199. <span class="p">};</span>
    200. 

  200. </pre></div>
    201. 

  201. </div>
    202. 

  202. </section>
    203. 

  203. <section id="id2">
    204. 

  204. <h3>端点结构体<a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
    205. 

  205. <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>
    206. 

  206. <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>
    207. 

  207. <span class="p">};</span>
    208. 

  208. </pre></div>
    209. 

  209. </div>
    210. 

  210. </section>
    211. 

  211. <section id="id3">
    212. 

  212. <h3>接口备用结构体<a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
    213. 

  213. <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>
    214. 

  214. <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>
    215. 

  215. <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>
    216. 

  216. <span class="p">};</span>
    217. 

  217. </pre></div>
    218. 

  218. </div>
    219. 

  219. </section>
    220. 

  220. <section id="id4">
    221. 

  221. <h3>接口结构体<a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
    222. 

  222. <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>
    223. 

  223. <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>
    224. 

  224. <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>
    225. 

  225. <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>
    226. 

  226. <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>
    227. 

  227. <span class="w">    </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">altsetting_num</span><span class="p">;</span>
    228. 

  228. <span class="p">};</span>
    229. 

  229. </pre></div>
    230. 

  230. </div>
    231. 

  231. </section>
    232. 

  232. <section id="id5">
    233. 

  233. <h3>配置结构体<a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
    234. 

  234. <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>
    235. 

  235. <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>
    236. 

  236. <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>
    237. 

  237. <span class="p">};</span>
    238. 

  238. </pre></div>
    239. 

  239. </div>
    240. 

  240. </section>
    241. 

  241. <section id="hubport">
    242. 

  242. <h3>hubport 结构体<a class="headerlink" href="#hubport" title="Link to this heading"></a></h3>
    243. 

  243. <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>
    244. 

  244. <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>
    245. 

  245. <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>
    246. 

  246. <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>
    247. 

  247. <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>
    248. 

  248. <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>
    249. 

  249. <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>
    250. 

  250. <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>
    251. 

  251. <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>
    252. 

  252. <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>
    253. 

  253. <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>
    254. 

  254. <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>
    255. 

  255. <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>
    256. 

  256. <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>
    257. 

  257. <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>
    258. 

  258. <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>
    259. 

  259. <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>
    260. 

  260. <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>
    261. 

  261. <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>
    262. 

  262. <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>
    263. 

  263. <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>
    264. 

  264. <span class="p">};</span>
    265. 

  265. </pre></div>
    266. 

  266. </div>
    267. 

  267. </section>
    268. 

  268. <section id="hub">
    269. 

  269. <h3>hub 结构体<a class="headerlink" href="#hub" title="Link to this heading"></a></h3>
    270. 

  270. <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>
    271. 

  271. <span class="w">    </span><span class="kt">bool</span><span class="w"> </span><span class="n">connected</span><span class="p">;</span>
    272. 

  272. <span class="w">    </span><span class="kt">bool</span><span class="w"> </span><span class="n">is_roothub</span><span class="p">;</span>
    273. 

  273. <span class="w">    </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">index</span><span class="p">;</span>
    274. 

  274. <span class="w">    </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">hub_addr</span><span class="p">;</span>
    275. 

  275. <span class="w">    </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">speed</span><span class="p">;</span>
    276. 

  276. <span class="w">    </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">nports</span><span class="p">;</span>
    277. 

  277. <span class="w">    </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">powerdelay</span><span class="p">;</span>
    278. 

  278. <span class="w">    </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">tt_think</span><span class="p">;</span>
    279. 

  279. <span class="w">    </span><span class="kt">bool</span><span class="w"> </span><span class="n">ismtt</span><span class="p">;</span>
    280. 

  280. <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>
    281. 

  281. <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>
    282. 

  282. <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>
    283. 

  283. <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>
    284. 

  284. <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>
    285. 

  285. <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>
    286. 

  286. <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>
    287. 

  287. <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>
    288. 

  288. <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>
    289. 

  289. <span class="p">};</span>
    290. 

  290. </pre></div>
    291. 

  291. </div>
    292. 

  292. </section>
    293. 

  293. <section id="usbh-initialize">
    294. 

  294. <h3>usbh_initialize<a class="headerlink" href="#usbh-initialize" title="Link to this heading"></a></h3>
    295. 

  295. <p><code class="docutils literal notranslate"><span class="pre">usbh_initialize</span></code> 用来初始化 usb 主机协议栈，包括：初始化 usb 主机控制器，创建 roothub 设备，创建 hub 检测线程。</p>
    296. 

  296. <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>
    297. 

  297. </pre></div>
    298. 

  298. </div>
    299. 

  299. <ul class="simple">
    300. 

  300. <li><p><strong>busid</strong>  bus id，从 0开始，不能超过 <cite>CONFIG_USBHOST_MAX_BUS</cite></p></li>
    301. 

  301. <li><p><strong>reg_base</strong>  hcd 寄存器基地址</p></li>
    302. 

  302. <li><p><strong>event_handler</strong>  host 事件回调函数，可以为NULL</p></li>
    303. 

  303. <li><p><strong>return</strong>  0 表示正常其他表示错误</p></li>
    304. 

  304. </ul>
    305. 

  305. </section>
    306. 

  306. <section id="usbh-find-class-instance">
    307. 

  307. <h3>usbh_find_class_instance<a class="headerlink" href="#usbh-find-class-instance" title="Link to this heading"></a></h3>
    308. 

  308. <p><code class="docutils literal notranslate"><span class="pre">usbh_find_class_instance</span></code> 根据注册的 class 名称查找对应的 class 结构体句柄。</p>
    309. 

  309. <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>
    310. 

  310. </pre></div>
    311. 

  311. </div>
    312. 

  312. <ul class="simple">
    313. 

  313. <li><p><strong>devname</strong>  class 名称</p></li>
    314. 

  314. <li><p><strong>return</strong>  class 结构体句柄</p></li>
    315. 

  315. </ul>
    316. 

  316. </section>
    317. 

  317. <section id="lsusb">
    318. 

  318. <h3>lsusb<a class="headerlink" href="#lsusb" title="Link to this heading"></a></h3>
    319. 

  319. <p><code class="docutils literal notranslate"><span class="pre">lsusb</span></code> 用来查看和操作 hub 上的设备信息。需要借助 shell 插件使用。</p>
    320. 

  320. <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>
    321. 

  321. </pre></div>
    322. 

  322. </div>
    323. 

  323. </section>
    324. 

  324. </section>
    325. 

  325. <section id="cdc-acm">
    326. 

  326. <h2>CDC ACM<a class="headerlink" href="#cdc-acm" title="Link to this heading"></a></h2>
    327. 

  327. </section>
    328. 

  328. <section id="hid">
    329. 

  329. <h2>HID<a class="headerlink" href="#hid" title="Link to this heading"></a></h2>
    330. 

  330. </section>
    331. 

  331. <section id="msc">
    332. 

  332. <h2>MSC<a class="headerlink" href="#msc" title="Link to this heading"></a></h2>
    333. 

  333. </section>
    334. 

  334. <section id="rndis">
    335. 

  335. <h2>RNDIS<a class="headerlink" href="#rndis" title="Link to this heading"></a></h2>
    336. 

  336. </section>
    337. 

  337. </section>
    338. 

  338. 

  339. 

  340.            </div>
    341. 

  341.           </div>
    342. 

  342.           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
    343. 

  343.         <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>
    344. 

  344.         <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>
    345. 

  345.     </div>
    346. 

  346. 

  347.   <hr/>
    348. 

  348. 

  349.   <div role="contentinfo">
    350. 

  350.     <p>&#169; Copyright 2022 ~ 2025, sakumisu.</p>
    351. 

  351.   </div>
    352. 

  352. 

  353.   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    354. 

  354.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    355. 

  355.     provided by <a href="https://readthedocs.org">Read the Docs</a>.
    356. 

  356.    
    357. 

  357. 

  358. </footer>
    359. 

  359.         </div>
    360. 

  360.       </div>
    361. 

  361.     </section>
    362. 

  362.   </div>
    363. 

  363.   <script>
    364. 

  364.       jQuery(function () {
    365. 

  365.           SphinxRtdTheme.Navigation.enable(true);
    366. 

  366.       });
    367. 

  367.   </script> 
    368. 

  368. 

  369. </body>
    370. 

  370. </html>
    371.