begriffs open source - cmsis/blob - main/Driver/html/group__USBD__dev__events.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: USBD Device Events</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('group__USBD__dev__events.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="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">USBD Device Events<div class="ingroups"><a class="el" href="group__usb__interface__gr.html">USB Interface</a> &raquo; <a class="el" href="group__usbd__interface__gr.html">USB Device Interface</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>The USB Device driver generates Device call back events that are notified via the function <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a>.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <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>
 142 <tr class="memdesc:ga32546413cfe55154351f74fb56de1045"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Device VBUS On.  <br /></td></tr>
 143 <tr class="separator:ga32546413cfe55154351f74fb56de1045"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <tr class="memdesc:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Device VBUS Off.  <br /></td></tr>
 146 <tr class="separator:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <tr class="memdesc:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Reset occurred.  <br /></td></tr>
 149 <tr class="separator:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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>
 151 <tr class="memdesc:ga689d1e031013d0e66aeef4243490d843"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB switch to High Speed occurred.  <br /></td></tr>
 152 <tr class="separator:ga689d1e031013d0e66aeef4243490d843"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <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>
 154 <tr class="memdesc:ga74dc7c0ba71baf285400d5a555224653"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Suspend occurred.  <br /></td></tr>
 155 <tr class="separator:ga74dc7c0ba71baf285400d5a555224653"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <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>
 157 <tr class="memdesc:ga5b1c9884b237ba7778f79761e5db9f45"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Resume occurred.  <br /></td></tr>
 158 <tr class="separator:ga5b1c9884b237ba7778f79761e5db9f45"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 </table>
 160 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 161 <p>The USB Device driver generates Device call back events that are notified via the function <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a>. </p>
 162 <p>This section provides the event values for the <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> callback function.</p>
 163 <p>The following call back notification events are generated: </p>
 164 <h2 class="groupheader">Macro Definition Documentation</h2>
 165 <a id="ga32546413cfe55154351f74fb56de1045" name="ga32546413cfe55154351f74fb56de1045"></a>
 166 <h2 class="memtitle"><span class="permalink"><a href="#ga32546413cfe55154351f74fb56de1045">&#9670;&#160;</a></span>ARM_USBD_EVENT_VBUS_ON</h2>
 167
 168 <div class="memitem">
 169 <div class="memproto">
 170       <table class="memname">
 171         <tr>
 172           <td class="memname">#define ARM_USBD_EVENT_VBUS_ON&#160;&#160;&#160;(1UL &lt;&lt; 0)</td>
 173         </tr>
 174       </table>
 175 </div><div class="memdoc">
 176
 177 <p>USB Device VBUS On. </p>
 178
 179 </div>
 180 </div>
 181 <a id="ga6810c08a6e6a46ba443899e5ba9c3aec" name="ga6810c08a6e6a46ba443899e5ba9c3aec"></a>
 182 <h2 class="memtitle"><span class="permalink"><a href="#ga6810c08a6e6a46ba443899e5ba9c3aec">&#9670;&#160;</a></span>ARM_USBD_EVENT_VBUS_OFF</h2>
 183
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname">#define ARM_USBD_EVENT_VBUS_OFF&#160;&#160;&#160;(1UL &lt;&lt; 1)</td>
 189         </tr>
 190       </table>
 191 </div><div class="memdoc">
 192
 193 <p>USB Device VBUS Off. </p>
 194
 195 </div>
 196 </div>
 197 <a id="ga489e1b88f7b0361494ca3a8dc73c227a" name="ga489e1b88f7b0361494ca3a8dc73c227a"></a>
 198 <h2 class="memtitle"><span class="permalink"><a href="#ga489e1b88f7b0361494ca3a8dc73c227a">&#9670;&#160;</a></span>ARM_USBD_EVENT_RESET</h2>
 199
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname">#define ARM_USBD_EVENT_RESET&#160;&#160;&#160;(1UL &lt;&lt; 2)</td>
 205         </tr>
 206       </table>
 207 </div><div class="memdoc">
 208
 209 <p>USB Reset occurred. </p>
 210
 211 </div>
 212 </div>
 213 <a id="ga689d1e031013d0e66aeef4243490d843" name="ga689d1e031013d0e66aeef4243490d843"></a>
 214 <h2 class="memtitle"><span class="permalink"><a href="#ga689d1e031013d0e66aeef4243490d843">&#9670;&#160;</a></span>ARM_USBD_EVENT_HIGH_SPEED</h2>
 215
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">#define ARM_USBD_EVENT_HIGH_SPEED&#160;&#160;&#160;(1UL &lt;&lt; 3)</td>
 221         </tr>
 222       </table>
 223 </div><div class="memdoc">
 224
 225 <p>USB switch to High Speed occurred. </p>
 226
 227 </div>
 228 </div>
 229 <a id="ga74dc7c0ba71baf285400d5a555224653" name="ga74dc7c0ba71baf285400d5a555224653"></a>
 230 <h2 class="memtitle"><span class="permalink"><a href="#ga74dc7c0ba71baf285400d5a555224653">&#9670;&#160;</a></span>ARM_USBD_EVENT_SUSPEND</h2>
 231
 232 <div class="memitem">
 233 <div class="memproto">
 234       <table class="memname">
 235         <tr>
 236           <td class="memname">#define ARM_USBD_EVENT_SUSPEND&#160;&#160;&#160;(1UL &lt;&lt; 4)</td>
 237         </tr>
 238       </table>
 239 </div><div class="memdoc">
 240
 241 <p>USB Suspend occurred. </p>
 242
 243 </div>
 244 </div>
 245 <a id="ga5b1c9884b237ba7778f79761e5db9f45" name="ga5b1c9884b237ba7778f79761e5db9f45"></a>
 246 <h2 class="memtitle"><span class="permalink"><a href="#ga5b1c9884b237ba7778f79761e5db9f45">&#9670;&#160;</a></span>ARM_USBD_EVENT_RESUME</h2>
 247
 248 <div class="memitem">
 249 <div class="memproto">
 250       <table class="memname">
 251         <tr>
 252           <td class="memname">#define ARM_USBD_EVENT_RESUME&#160;&#160;&#160;(1UL &lt;&lt; 5)</td>
 253         </tr>
 254       </table>
 255 </div><div class="memdoc">
 256
 257 <p>USB Resume occurred. </p>
 258
 259 </div>
 260 </div>
 261 </div><!-- contents -->
 262 </div><!-- doc-content -->
 263 <!-- start footer part -->
 264 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 265   <ul>
 266     <li class="footer">
 267       <script type="text/javascript">
 268         <!--
 269         writeFooter.call(this);
 270         //-->
 271       </script>
 272     </li>
 273   </ul>
 274 </div>
 275 </body>
 276 </html>