begriffs open source - cmsis/blob - main/Driver/html/Driver__USBD_8h.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: Driver_USBD.h File Reference</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Driver
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('Driver__USBD_8h.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#nested-classes">Data Structures</a> &#124;
 132 <a href="#define-members">Macros</a> &#124;
 133 <a href="#typedef-members">Typedefs</a>  </div>
 134   <div class="headertitle"><div class="title">Driver_USBD.h File Reference</div></div>
 135 </div><!--header-->
 136 <div class="contents">
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 139 Data Structures</h2></td></tr>
 140 <tr class="memitem:structARM__USBD__STATE"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a></td></tr>
 141 <tr class="memdesc:structARM__USBD__STATE"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Device State.  <a href="group__usbd__interface__gr.html#structARM__USBD__STATE">More...</a><br /></td></tr>
 142 <tr class="separator:structARM__USBD__STATE"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:structARM__USBD__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a></td></tr>
 144 <tr class="memdesc:structARM__USBD__CAPABILITIES"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Device Driver Capabilities.  <a href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">More...</a><br /></td></tr>
 145 <tr class="separator:structARM__USBD__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:structARM__DRIVER__USBD"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a></td></tr>
 147 <tr class="memdesc:structARM__DRIVER__USBD"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access structure of the USB Device Driver.  <a href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">More...</a><br /></td></tr>
 148 <tr class="separator:structARM__DRIVER__USBD"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 </table><table class="memberdecls">
 150 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 151 Macros</h2></td></tr>
 152 <tr class="memitem:a71df406694e557f19cae5e43ff1960ba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__USBD_8h.html#a71df406694e557f19cae5e43ff1960ba">ARM_USBD_API_VERSION</a>&#160;&#160;&#160;<a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(2,3)  /* API version */</td></tr>
 153 <tr class="separator:a71df406694e557f19cae5e43ff1960ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:a8747f0011aa23918fa01e3511a908906"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__USBD_8h.html#a8747f0011aa23918fa01e3511a908906">_ARM_Driver_USBD_</a>(n)&#160;&#160;&#160;Driver_USBD##n</td></tr>
 155 <tr class="separator:a8747f0011aa23918fa01e3511a908906"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:a611e9367615ecbba7150cd961859ebce"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__USBD_8h.html#a611e9367615ecbba7150cd961859ebce">ARM_Driver_USBD_</a>(n)&#160;&#160;&#160;<a class="el" href="Driver__USBD_8h.html#a8747f0011aa23918fa01e3511a908906">_ARM_Driver_USBD_</a>(n)</td></tr>
 157 <tr class="separator:a611e9367615ecbba7150cd961859ebce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:ga32546413cfe55154351f74fb56de1045"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga32546413cfe55154351f74fb56de1045">ARM_USBD_EVENT_VBUS_ON</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
 159 <tr class="memdesc:ga32546413cfe55154351f74fb56de1045"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Device VBUS On.  <br /></td></tr>
 160 <tr class="separator:ga32546413cfe55154351f74fb56de1045"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga6810c08a6e6a46ba443899e5ba9c3aec">ARM_USBD_EVENT_VBUS_OFF</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
 162 <tr class="memdesc:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Device VBUS Off.  <br /></td></tr>
 163 <tr class="separator:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga489e1b88f7b0361494ca3a8dc73c227a">ARM_USBD_EVENT_RESET</a>&#160;&#160;&#160;(1UL &lt;&lt; 2)</td></tr>
 165 <tr class="memdesc:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Reset occurred.  <br /></td></tr>
 166 <tr class="separator:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:ga689d1e031013d0e66aeef4243490d843"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga689d1e031013d0e66aeef4243490d843">ARM_USBD_EVENT_HIGH_SPEED</a>&#160;&#160;&#160;(1UL &lt;&lt; 3)</td></tr>
 168 <tr class="memdesc:ga689d1e031013d0e66aeef4243490d843"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB switch to High Speed occurred.  <br /></td></tr>
 169 <tr class="separator:ga689d1e031013d0e66aeef4243490d843"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:ga74dc7c0ba71baf285400d5a555224653"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga74dc7c0ba71baf285400d5a555224653">ARM_USBD_EVENT_SUSPEND</a>&#160;&#160;&#160;(1UL &lt;&lt; 4)</td></tr>
 171 <tr class="memdesc:ga74dc7c0ba71baf285400d5a555224653"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Suspend occurred.  <br /></td></tr>
 172 <tr class="separator:ga74dc7c0ba71baf285400d5a555224653"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:ga5b1c9884b237ba7778f79761e5db9f45"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga5b1c9884b237ba7778f79761e5db9f45">ARM_USBD_EVENT_RESUME</a>&#160;&#160;&#160;(1UL &lt;&lt; 5)</td></tr>
 174 <tr class="memdesc:ga5b1c9884b237ba7778f79761e5db9f45"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Resume occurred.  <br /></td></tr>
 175 <tr class="separator:ga5b1c9884b237ba7778f79761e5db9f45"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <tr class="memitem:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739">ARM_USBD_EVENT_SETUP</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
 177 <tr class="memdesc:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="mdescLeft">&#160;</td><td class="mdescRight">SETUP Packet.  <br /></td></tr>
 178 <tr class="separator:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 <tr class="memitem:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a">ARM_USBD_EVENT_OUT</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
 180 <tr class="memdesc:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="mdescLeft">&#160;</td><td class="mdescRight">OUT Packet(s)  <br /></td></tr>
 181 <tr class="separator:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 182 <tr class="memitem:ga375d3d8f363a056ff607c5ab3b92a864"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864">ARM_USBD_EVENT_IN</a>&#160;&#160;&#160;(1UL &lt;&lt; 2)</td></tr>
 183 <tr class="memdesc:ga375d3d8f363a056ff607c5ab3b92a864"><td class="mdescLeft">&#160;</td><td class="mdescRight">IN Packet(s)  <br /></td></tr>
 184 <tr class="separator:ga375d3d8f363a056ff607c5ab3b92a864"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 </table><table class="memberdecls">
 186 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 187 Typedefs</h2></td></tr>
 188 <tr class="memitem:ga7c1878799699ddd34cec696da499f7bd"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">ARM_USBD_SignalDeviceEvent_t</a>) (uint32_t event)</td></tr>
 189 <tr class="memdesc:ga7c1878799699ddd34cec696da499f7bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> : Signal USB Device Event.  <br /></td></tr>
 190 <tr class="separator:ga7c1878799699ddd34cec696da499f7bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 <tr class="memitem:gaae754763700fc5059a6bde57ea2d4e2c"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">ARM_USBD_SignalEndpointEvent_t</a>) (uint8_t ep_addr, uint32_t event)</td></tr>
 192 <tr class="memdesc:gaae754763700fc5059a6bde57ea2d4e2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> : Signal USB Endpoint Event.  <br /></td></tr>
 193 <tr class="separator:gaae754763700fc5059a6bde57ea2d4e2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 194 </table>
 195 <h2 class="groupheader">Macro Definition Documentation</h2>
 196 <a id="a71df406694e557f19cae5e43ff1960ba" name="a71df406694e557f19cae5e43ff1960ba"></a>
 197 <h2 class="memtitle"><span class="permalink"><a href="#a71df406694e557f19cae5e43ff1960ba">&#9670;&#160;</a></span>ARM_USBD_API_VERSION</h2>
 198
 199 <div class="memitem">
 200 <div class="memproto">
 201       <table class="memname">
 202         <tr>
 203           <td class="memname">#define ARM_USBD_API_VERSION&#160;&#160;&#160;<a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(2,3)  /* API version */</td>
 204         </tr>
 205       </table>
 206 </div><div class="memdoc">
 207
 208 </div>
 209 </div>
 210 <a id="a8747f0011aa23918fa01e3511a908906" name="a8747f0011aa23918fa01e3511a908906"></a>
 211 <h2 class="memtitle"><span class="permalink"><a href="#a8747f0011aa23918fa01e3511a908906">&#9670;&#160;</a></span>_ARM_Driver_USBD_</h2>
 212
 213 <div class="memitem">
 214 <div class="memproto">
 215       <table class="memname">
 216         <tr>
 217           <td class="memname">#define _ARM_Driver_USBD_</td>
 218           <td>(</td>
 219           <td class="paramtype">&#160;</td>
 220           <td class="paramname">n</td><td>)</td>
 221           <td>&#160;&#160;&#160;Driver_USBD##n</td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 </div>
 227 </div>
 228 <a id="a611e9367615ecbba7150cd961859ebce" name="a611e9367615ecbba7150cd961859ebce"></a>
 229 <h2 class="memtitle"><span class="permalink"><a href="#a611e9367615ecbba7150cd961859ebce">&#9670;&#160;</a></span>ARM_Driver_USBD_</h2>
 230
 231 <div class="memitem">
 232 <div class="memproto">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname">#define ARM_Driver_USBD_</td>
 236           <td>(</td>
 237           <td class="paramtype">&#160;</td>
 238           <td class="paramname">n</td><td>)</td>
 239           <td>&#160;&#160;&#160;<a class="el" href="Driver__USBD_8h.html#a8747f0011aa23918fa01e3511a908906">_ARM_Driver_USBD_</a>(n)</td>
 240         </tr>
 241       </table>
 242 </div><div class="memdoc">
 243
 244 </div>
 245 </div>
 246 </div><!-- contents -->
 247 </div><!-- doc-content -->
 248 <!-- start footer part -->
 249 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 250   <ul>
 251     <li class="navelem"><a class="el" href="dir_7151b3cc910409bb744bd274374c738d.html">Driver</a></li><li class="navelem"><a class="el" href="dir_9c39448ea46a8e15f1aabc7dec307fcf.html">Include</a></li><li class="navelem"><a class="el" href="Driver__USBD_8h.html">Driver_USBD.h</a></li>
 252     <li class="footer">
 253       <script type="text/javascript">
 254         <!--
 255         writeFooter.call(this);
 256         //-->
 257       </script>
 258     </li>
 259   </ul>
 260 </div>
 261 </body>
 262 </html>