a00304.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Lightweight USB stack: usbd_driver Struct Reference</title>
  9. <link href="../../tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="../../jquery.js"></script>
  11. <script type="text/javascript" src="../../dynsections.js"></script>
  12. <link href="../../navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="../../resize.js"></script>
  14. <script type="text/javascript" src="../../navtreedata.js"></script>
  15. <script type="text/javascript" src="../../navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="../../search/search.css" rel="stylesheet" type="text/css"/>
  20. <script type="text/javascript" src="../../search/searchdata.js"></script>
  21. <script type="text/javascript" src="../../search/search.js"></script>
  22. <link href="../../doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectalign" style="padding-left: 0.5em;">
  31. <div id="projectname">Lightweight USB stack
  32. &#160;<span id="projectnumber">1.0</span>
  33. </div>
  34. </td>
  35. </tr>
  36. </tbody>
  37. </table>
  38. </div>
  39. <!-- end header part -->
  40. <!-- Generated by Doxygen 1.8.13 -->
  41. <script type="text/javascript">
  42. var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
  43. </script>
  44. <script type="text/javascript" src="../../menudata.js"></script>
  45. <script type="text/javascript" src="../../menu.js"></script>
  46. <script type="text/javascript">
  47. $(function() {
  48. initMenu('../../',true,false,'search.php','Search');
  49. $(document).ready(function() { init_search(); });
  50. });
  51. </script>
  52. <div id="main-nav"></div>
  53. </div><!-- top -->
  54. <div id="side-nav" class="ui-resizable side-nav-resizable">
  55. <div id="nav-tree">
  56. <div id="nav-tree-contents">
  57. <div id="nav-sync" class="sync"></div>
  58. </div>
  59. </div>
  60. <div id="splitbar" style="-moz-user-select:none;"
  61. class="ui-resizable-handle">
  62. </div>
  63. </div>
  64. <script type="text/javascript">
  65. $(document).ready(function(){initNavTree('d8/d17/a00304.html','../../');});
  66. </script>
  67. <div id="doc-content">
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. <div class="header">
  81. <div class="summary">
  82. <a href="#pub-attribs">Data Fields</a> </div>
  83. <div class="headertitle">
  84. <div class="title">usbd_driver Struct Reference<div class="ingroups"><a class="el" href="../../d9/dcc/a00102.html">USB Device HW driver and core API</a> &raquo; <a class="el" href="../../d5/d1e/a00103.html">USB hardware driver</a></div></div> </div>
  85. </div><!--header-->
  86. <div class="contents">
  87. <p>Represents a hardware USB driver call table.
  88. <a href="../../d8/d17/a00304.html#details">More...</a></p>
  89. <p><code>#include &lt;<a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>&gt;</code></p>
  90. <table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  92. Data Fields</h2></td></tr>
  93. <tr class="memitem:a120c65f705b6324d6bf86387301b84c1"><td class="memItemLeft" align="right" valign="top"><a id="a120c65f705b6324d6bf86387301b84c1"></a>
  94. <a class="el" href="../../d5/d1e/a00103.html#ga9a3d5b843f2cefc83d90a8da3151b3e8">usbd_hw_getinfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#a120c65f705b6324d6bf86387301b84c1">getinfo</a></td></tr>
  95. <tr class="memdesc:a120c65f705b6324d6bf86387301b84c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get USB device status and capabilities. <br /></td></tr>
  96. <tr class="separator:a120c65f705b6324d6bf86387301b84c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:aa2ff86011aadc305de6fc0e7dad3fb0d"><td class="memItemLeft" align="right" valign="top"><a id="aa2ff86011aadc305de6fc0e7dad3fb0d"></a>
  98. <a class="el" href="../../d5/d1e/a00103.html#ga521e6e03cdee1a357298e3f851698cf5">usbd_hw_enable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#aa2ff86011aadc305de6fc0e7dad3fb0d">enable</a></td></tr>
  99. <tr class="memdesc:aa2ff86011aadc305de6fc0e7dad3fb0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables USB hardware. <br /></td></tr>
  100. <tr class="separator:aa2ff86011aadc305de6fc0e7dad3fb0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a0fada49940e6a124eeaa8fccdd6af7d8"><td class="memItemLeft" align="right" valign="top"><a id="a0fada49940e6a124eeaa8fccdd6af7d8"></a>
  102. <a class="el" href="../../d5/d1e/a00103.html#ga51ab95cc32891731c1ff52acd088d374">usbd_hw_connect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#a0fada49940e6a124eeaa8fccdd6af7d8">connect</a></td></tr>
  103. <tr class="separator:a0fada49940e6a124eeaa8fccdd6af7d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ab9dcf925eac960e40dd84173fd0cc140"><td class="memItemLeft" align="right" valign="top"><a id="ab9dcf925eac960e40dd84173fd0cc140"></a>
  105. <a class="el" href="../../d5/d1e/a00103.html#ga0dfb3a13355c4775e0e1681d76585bdf">usbd_hw_setaddr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#ab9dcf925eac960e40dd84173fd0cc140">setaddr</a></td></tr>
  106. <tr class="memdesc:ab9dcf925eac960e40dd84173fd0cc140"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets USB hardware address. <br /></td></tr>
  107. <tr class="separator:ab9dcf925eac960e40dd84173fd0cc140"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:af82fea4edefd615fc44103834bd99f55"><td class="memItemLeft" align="right" valign="top"><a id="af82fea4edefd615fc44103834bd99f55"></a>
  109. <a class="el" href="../../d5/d1e/a00103.html#ga56dcaff98bac6a4c564bab6825f12da3">usbd_hw_ep_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#af82fea4edefd615fc44103834bd99f55">ep_config</a></td></tr>
  110. <tr class="memdesc:af82fea4edefd615fc44103834bd99f55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures endpoint. <br /></td></tr>
  111. <tr class="separator:af82fea4edefd615fc44103834bd99f55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ad540208811726121c69af62eb8488cb5"><td class="memItemLeft" align="right" valign="top"><a id="ad540208811726121c69af62eb8488cb5"></a>
  113. <a class="el" href="../../d5/d1e/a00103.html#ga9322c08c36d05121e7d998e1345fe46e">usbd_hw_ep_deconfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#ad540208811726121c69af62eb8488cb5">ep_deconfig</a></td></tr>
  114. <tr class="memdesc:ad540208811726121c69af62eb8488cb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-configures, cleans and disables endpoint. <br /></td></tr>
  115. <tr class="separator:ad540208811726121c69af62eb8488cb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a2138238b87c35d50b12c912cb321d6fd"><td class="memItemLeft" align="right" valign="top"><a id="a2138238b87c35d50b12c912cb321d6fd"></a>
  117. <a class="el" href="../../d5/d1e/a00103.html#ga1488f8a6dee0c985f5abd38396b3a867">usbd_hw_ep_read</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#a2138238b87c35d50b12c912cb321d6fd">ep_read</a></td></tr>
  118. <tr class="memdesc:a2138238b87c35d50b12c912cb321d6fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads data from OUT or control endpoint. <br /></td></tr>
  119. <tr class="separator:a2138238b87c35d50b12c912cb321d6fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ad6efbf9b639ed4774eb641ca6b7b406e"><td class="memItemLeft" align="right" valign="top"><a id="ad6efbf9b639ed4774eb641ca6b7b406e"></a>
  121. <a class="el" href="../../d5/d1e/a00103.html#ga17f18cf2982e5a482a39603a4dd64f03">usbd_hw_ep_write</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#ad6efbf9b639ed4774eb641ca6b7b406e">ep_write</a></td></tr>
  122. <tr class="memdesc:ad6efbf9b639ed4774eb641ca6b7b406e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes data to IN or control endpoint. <br /></td></tr>
  123. <tr class="separator:ad6efbf9b639ed4774eb641ca6b7b406e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a81e491d8b093017a58dd25985cf10279"><td class="memItemLeft" align="right" valign="top"><a id="a81e491d8b093017a58dd25985cf10279"></a>
  125. <a class="el" href="../../d5/d1e/a00103.html#gab728331c31cfbd74d48606fe754f664b">usbd_hw_ep_setstall</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#a81e491d8b093017a58dd25985cf10279">ep_setstall</a></td></tr>
  126. <tr class="separator:a81e491d8b093017a58dd25985cf10279"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:af39e2c81c0a3b6e10314c75fd788c8b4"><td class="memItemLeft" align="right" valign="top"><a id="af39e2c81c0a3b6e10314c75fd788c8b4"></a>
  128. <a class="el" href="../../d5/d1e/a00103.html#ga0d66682a43cc9a4a4657bae7b37d1721">usbd_hw_ep_isstalled</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#af39e2c81c0a3b6e10314c75fd788c8b4">ep_isstalled</a></td></tr>
  129. <tr class="memdesc:af39e2c81c0a3b6e10314c75fd788c8b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks endpoint for stalled state. <br /></td></tr>
  130. <tr class="separator:af39e2c81c0a3b6e10314c75fd788c8b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ac484a3f7f2a5c5fe1408b2e8ab916e3a"><td class="memItemLeft" align="right" valign="top"><a id="ac484a3f7f2a5c5fe1408b2e8ab916e3a"></a>
  132. <a class="el" href="../../d5/d1e/a00103.html#gad661412e0f66de317eea9c3784629096">usbd_hw_poll</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#ac484a3f7f2a5c5fe1408b2e8ab916e3a">poll</a></td></tr>
  133. <tr class="memdesc:ac484a3f7f2a5c5fe1408b2e8ab916e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Polls USB hardware for the events. <br /></td></tr>
  134. <tr class="separator:ac484a3f7f2a5c5fe1408b2e8ab916e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ad888231679960970839a7f909b6445d1"><td class="memItemLeft" align="right" valign="top"><a id="ad888231679960970839a7f909b6445d1"></a>
  136. <a class="el" href="../../d5/d1e/a00103.html#gac4c9def5578968e903439f15bc64ab5b">usbd_hw_get_frameno</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#ad888231679960970839a7f909b6445d1">frame_no</a></td></tr>
  137. <tr class="memdesc:ad888231679960970839a7f909b6445d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets frame number from usb hardware. <br /></td></tr>
  138. <tr class="separator:ad888231679960970839a7f909b6445d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a510769363d195609bd86968e6a4a1f92"><td class="memItemLeft" align="right" valign="top"><a id="a510769363d195609bd86968e6a4a1f92"></a>
  140. <a class="el" href="../../d5/d1e/a00103.html#ga521aa5ada654934cb97e12d73a315030">usbd_hw_get_serialno</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html#a510769363d195609bd86968e6a4a1f92">get_serialno_desc</a></td></tr>
  141. <tr class="memdesc:a510769363d195609bd86968e6a4a1f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes a string descriptor contains unique serial number from hardware ID's. <br /></td></tr>
  142. <tr class="separator:a510769363d195609bd86968e6a4a1f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table>
  144. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  145. <div class="textblock"><p>Represents a hardware USB driver call table. </p>
  146. <p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00307">307</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>
  147. </div><hr/>The documentation for this struct was generated from the following file:<ul>
  148. <li><a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a></li>
  149. </ul>
  150. </div><!-- contents -->
  151. </div><!-- doc-content -->
  152. <!-- start footer part -->
  153. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  154. <ul>
  155. <li class="navelem"><a class="el" href="../../d8/d17/a00304.html">usbd_driver</a></li>
  156. <li class="footer">Generated by
  157. <a href="http://www.doxygen.org/index.html">
  158. <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  159. </ul>
  160. </div>
  161. </body>
  162. </html>