a00102.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  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: USB Device HW driver and core API</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('d9/dcc/a00102.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="#groups">Modules</a> </div>
  83. <div class="headertitle">
  84. <div class="title">USB Device HW driver and core API</div> </div>
  85. </div><!--header-->
  86. <div class="contents">
  87. <table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  89. Modules</h2></td></tr>
  90. <tr class="memitem:d5/d1e/a00103"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html">USB hardware driver</a></td></tr>
  91. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:d0/dc2/a00104"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dc2/a00104.html">USB device core</a></td></tr>
  93. <tr class="memdesc:d0/dc2/a00104"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains core API. <br /></td></tr>
  94. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  97. Compile-time control macros</h2></td></tr>
  98. <tr class="memitem:gabe4304eaa079882d869171e05b9710f0"><td class="memItemLeft" align="right" valign="top"><a id="gabe4304eaa079882d869171e05b9710f0"></a>
  99. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#gabe4304eaa079882d869171e05b9710f0">USBD_PINS_REMAP</a></td></tr>
  100. <tr class="memdesc:gabe4304eaa079882d869171e05b9710f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remap USB pins for uC with low pin count packages. <br /></td></tr>
  101. <tr class="separator:gabe4304eaa079882d869171e05b9710f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ga62b824189c01d9e502a534198795cdae"><td class="memItemLeft" align="right" valign="top"><a id="ga62b824189c01d9e502a534198795cdae"></a>
  103. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#ga62b824189c01d9e502a534198795cdae">USBD_SOF_DISABLED</a></td></tr>
  104. <tr class="memdesc:ga62b824189c01d9e502a534198795cdae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables SOF handling. <br /></td></tr>
  105. <tr class="separator:ga62b824189c01d9e502a534198795cdae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ga873cf10751ceec91547247332cc977a8"><td class="memItemLeft" align="right" valign="top"><a id="ga873cf10751ceec91547247332cc977a8"></a>
  107. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#ga873cf10751ceec91547247332cc977a8">USBD_VBUS_DETECT</a></td></tr>
  108. <tr class="memdesc:ga873cf10751ceec91547247332cc977a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables Vbus detection for L4/F4 driver. <br /></td></tr>
  109. <tr class="separator:ga873cf10751ceec91547247332cc977a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:gaf35b09cfd8fd06e58d72d047d65266a1"><td class="memItemLeft" align="right" valign="top"><a id="gaf35b09cfd8fd06e58d72d047d65266a1"></a>
  111. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#gaf35b09cfd8fd06e58d72d047d65266a1">USBD_DP_PORT</a></td></tr>
  112. <tr class="memdesc:gaf35b09cfd8fd06e58d72d047d65266a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">DP pullup port for F103/F303 driver. <br /></td></tr>
  113. <tr class="separator:gaf35b09cfd8fd06e58d72d047d65266a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ga30da8a7864e777a2601488f43b7b0a7f"><td class="memItemLeft" align="right" valign="top"><a id="ga30da8a7864e777a2601488f43b7b0a7f"></a>
  115. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#ga30da8a7864e777a2601488f43b7b0a7f">USBD_DP_PIN</a></td></tr>
  116. <tr class="memdesc:ga30da8a7864e777a2601488f43b7b0a7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">DP pullup pin for F103/F303 driver. <br /></td></tr>
  117. <tr class="separator:ga30da8a7864e777a2601488f43b7b0a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ga99347cd77b51aa21e408de471843fd75"><td class="memItemLeft" align="right" valign="top"><a id="ga99347cd77b51aa21e408de471843fd75"></a>
  119. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#ga99347cd77b51aa21e408de471843fd75">USBD_SOF_OUT</a></td></tr>
  120. <tr class="memdesc:ga99347cd77b51aa21e408de471843fd75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables SOF output pin for F4 OTGFS. <br /></td></tr>
  121. <tr class="separator:ga99347cd77b51aa21e408de471843fd75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gac74ab6e936f3b13bc4967578a42a57fc"><td class="memItemLeft" align="right" valign="top"><a id="gac74ab6e936f3b13bc4967578a42a57fc"></a>
  123. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#gac74ab6e936f3b13bc4967578a42a57fc">USBD_PRIMARY_OTGHS</a></td></tr>
  124. <tr class="memdesc:gac74ab6e936f3b13bc4967578a42a57fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets OTGHS as primary interface for F4. <br /></td></tr>
  125. <tr class="separator:gac74ab6e936f3b13bc4967578a42a57fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:gaea5f5ff04a7046b5407b1aef103763c0"><td class="memItemLeft" align="right" valign="top"><a id="gaea5f5ff04a7046b5407b1aef103763c0"></a>
  127. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#gaea5f5ff04a7046b5407b1aef103763c0">USBD_USE_EXT_ULPI</a></td></tr>
  128. <tr class="memdesc:gaea5f5ff04a7046b5407b1aef103763c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables external ULPI interface for OTGHS. <br /></td></tr>
  129. <tr class="separator:gaea5f5ff04a7046b5407b1aef103763c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:gac140f26a668f33d7efea2558c3adcde5"><td class="memItemLeft" align="right" valign="top"><a id="gac140f26a668f33d7efea2558c3adcde5"></a>
  131. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dcc/a00102.html#gac140f26a668f33d7efea2558c3adcde5">USB_PMA_SIZE</a></td></tr>
  132. <tr class="memdesc:gac140f26a668f33d7efea2558c3adcde5"><td class="mdescLeft">&#160;</td><td class="mdescRight">PMA memoty size in bytes. Adjust this for the devices that shares PMA memory with CAN in case of both USB and CAN in use to avoid data corruption. <br /></td></tr>
  133. <tr class="separator:gac140f26a668f33d7efea2558c3adcde5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table>
  135. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  136. </div><!-- contents -->
  137. </div><!-- doc-content -->
  138. <!-- start footer part -->
  139. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  140. <ul>
  141. <li class="footer">Generated by
  142. <a href="http://www.doxygen.org/index.html">
  143. <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  144. </ul>
  145. </div>
  146. </body>
  147. </html>