begriffs open source - cmsis/blob - main/Driver/group__USBH__pipe__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: USBH Pipe Events</title>
   9 <link href="doxygen.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 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></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 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Driver
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Driver");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__USBH__pipe__events.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#define-members">Macros</a>  </div>
 129   <div class="headertitle"><div class="title">USBH Pipe Events<div class="ingroups"><a class="el" href="group__usb__interface__gr.html">USB Interface</a> &raquo; <a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>The USB Host driver generates Pipe call back events that are notified via the function <a class="el" href="group__usbh__interface__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 137 Macros</h2></td></tr>
 138 <tr class="memitem:gab161955b1ab0b7928befe446ef78634b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">ARM_USBH_EVENT_TRANSFER_COMPLETE</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
 139 <tr class="memdesc:gab161955b1ab0b7928befe446ef78634b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transfer completed.  <br /></td></tr>
 140 <tr class="separator:gab161955b1ab0b7928befe446ef78634b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga3895b82193855d9a6f0b7e8a9b65e2c0">ARM_USBH_EVENT_HANDSHAKE_NAK</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
 142 <tr class="memdesc:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">NAK Handshake received.  <br /></td></tr>
 143 <tr class="separator:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga62ae214576c923ce737a16098e9836e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga62ae214576c923ce737a16098e9836e5">ARM_USBH_EVENT_HANDSHAKE_NYET</a>&#160;&#160;&#160;(1UL &lt;&lt; 2)</td></tr>
 145 <tr class="memdesc:ga62ae214576c923ce737a16098e9836e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">NYET Handshake received.  <br /></td></tr>
 146 <tr class="separator:ga62ae214576c923ce737a16098e9836e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga681ce0983f8c77c41f3cc5df1af8d010">ARM_USBH_EVENT_HANDSHAKE_MDATA</a>&#160;&#160;&#160;(1UL &lt;&lt; 3)</td></tr>
 148 <tr class="memdesc:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="mdescLeft">&#160;</td><td class="mdescRight">MDATA Handshake received.  <br /></td></tr>
 149 <tr class="separator:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga4fdc44fc78f342576dd11ad7cb84b4b8">ARM_USBH_EVENT_HANDSHAKE_STALL</a>&#160;&#160;&#160;(1UL &lt;&lt; 4)</td></tr>
 151 <tr class="memdesc:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">STALL Handshake received.  <br /></td></tr>
 152 <tr class="separator:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:gac7cc573f879fbab678dc7d1347c68614"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#gac7cc573f879fbab678dc7d1347c68614">ARM_USBH_EVENT_HANDSHAKE_ERR</a>&#160;&#160;&#160;(1UL &lt;&lt; 5)</td></tr>
 154 <tr class="memdesc:gac7cc573f879fbab678dc7d1347c68614"><td class="mdescLeft">&#160;</td><td class="mdescRight">ERR Handshake received.  <br /></td></tr>
 155 <tr class="separator:gac7cc573f879fbab678dc7d1347c68614"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga7bd871b1e5c059bee398c32429370724"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html#ga7bd871b1e5c059bee398c32429370724">ARM_USBH_EVENT_BUS_ERROR</a>&#160;&#160;&#160;(1UL &lt;&lt; 6)</td></tr>
 157 <tr class="memdesc:ga7bd871b1e5c059bee398c32429370724"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bus Error detected.  <br /></td></tr>
 158 <tr class="separator:ga7bd871b1e5c059bee398c32429370724"><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 Host driver generates Pipe call back events that are notified via the function <a class="el" href="group__usbh__interface__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>. </p>
 162 <p>This section provides the event values for the <a class="el" href="group__usbh__interface__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</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="gab161955b1ab0b7928befe446ef78634b" name="gab161955b1ab0b7928befe446ef78634b"></a>
 166 <h2 class="memtitle"><span class="permalink"><a href="#gab161955b1ab0b7928befe446ef78634b">&#9670;&#160;</a></span>ARM_USBH_EVENT_TRANSFER_COMPLETE</h2>
 167
 168 <div class="memitem">
 169 <div class="memproto">
 170       <table class="memname">
 171         <tr>
 172           <td class="memname">#define ARM_USBH_EVENT_TRANSFER_COMPLETE&#160;&#160;&#160;(1UL &lt;&lt; 0)</td>
 173         </tr>
 174       </table>
 175 </div><div class="memdoc">
 176
 177 <p>Transfer completed. </p>
 178
 179 </div>
 180 </div>
 181 <a id="ga3895b82193855d9a6f0b7e8a9b65e2c0" name="ga3895b82193855d9a6f0b7e8a9b65e2c0"></a>
 182 <h2 class="memtitle"><span class="permalink"><a href="#ga3895b82193855d9a6f0b7e8a9b65e2c0">&#9670;&#160;</a></span>ARM_USBH_EVENT_HANDSHAKE_NAK</h2>
 183
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_NAK&#160;&#160;&#160;(1UL &lt;&lt; 1)</td>
 189         </tr>
 190       </table>
 191 </div><div class="memdoc">
 192
 193 <p>NAK Handshake received. </p>
 194
 195 </div>
 196 </div>
 197 <a id="ga62ae214576c923ce737a16098e9836e5" name="ga62ae214576c923ce737a16098e9836e5"></a>
 198 <h2 class="memtitle"><span class="permalink"><a href="#ga62ae214576c923ce737a16098e9836e5">&#9670;&#160;</a></span>ARM_USBH_EVENT_HANDSHAKE_NYET</h2>
 199
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_NYET&#160;&#160;&#160;(1UL &lt;&lt; 2)</td>
 205         </tr>
 206       </table>
 207 </div><div class="memdoc">
 208
 209 <p>NYET Handshake received. </p>
 210
 211 </div>
 212 </div>
 213 <a id="ga681ce0983f8c77c41f3cc5df1af8d010" name="ga681ce0983f8c77c41f3cc5df1af8d010"></a>
 214 <h2 class="memtitle"><span class="permalink"><a href="#ga681ce0983f8c77c41f3cc5df1af8d010">&#9670;&#160;</a></span>ARM_USBH_EVENT_HANDSHAKE_MDATA</h2>
 215
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_MDATA&#160;&#160;&#160;(1UL &lt;&lt; 3)</td>
 221         </tr>
 222       </table>
 223 </div><div class="memdoc">
 224
 225 <p>MDATA Handshake received. </p>
 226
 227 </div>
 228 </div>
 229 <a id="ga4fdc44fc78f342576dd11ad7cb84b4b8" name="ga4fdc44fc78f342576dd11ad7cb84b4b8"></a>
 230 <h2 class="memtitle"><span class="permalink"><a href="#ga4fdc44fc78f342576dd11ad7cb84b4b8">&#9670;&#160;</a></span>ARM_USBH_EVENT_HANDSHAKE_STALL</h2>
 231
 232 <div class="memitem">
 233 <div class="memproto">
 234       <table class="memname">
 235         <tr>
 236           <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_STALL&#160;&#160;&#160;(1UL &lt;&lt; 4)</td>
 237         </tr>
 238       </table>
 239 </div><div class="memdoc">
 240
 241 <p>STALL Handshake received. </p>
 242
 243 </div>
 244 </div>
 245 <a id="gac7cc573f879fbab678dc7d1347c68614" name="gac7cc573f879fbab678dc7d1347c68614"></a>
 246 <h2 class="memtitle"><span class="permalink"><a href="#gac7cc573f879fbab678dc7d1347c68614">&#9670;&#160;</a></span>ARM_USBH_EVENT_HANDSHAKE_ERR</h2>
 247
 248 <div class="memitem">
 249 <div class="memproto">
 250       <table class="memname">
 251         <tr>
 252           <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_ERR&#160;&#160;&#160;(1UL &lt;&lt; 5)</td>
 253         </tr>
 254       </table>
 255 </div><div class="memdoc">
 256
 257 <p>ERR Handshake received. </p>
 258
 259 </div>
 260 </div>
 261 <a id="ga7bd871b1e5c059bee398c32429370724" name="ga7bd871b1e5c059bee398c32429370724"></a>
 262 <h2 class="memtitle"><span class="permalink"><a href="#ga7bd871b1e5c059bee398c32429370724">&#9670;&#160;</a></span>ARM_USBH_EVENT_BUS_ERROR</h2>
 263
 264 <div class="memitem">
 265 <div class="memproto">
 266       <table class="memname">
 267         <tr>
 268           <td class="memname">#define ARM_USBH_EVENT_BUS_ERROR&#160;&#160;&#160;(1UL &lt;&lt; 6)</td>
 269         </tr>
 270       </table>
 271 </div><div class="memdoc">
 272
 273 <p>Bus Error detected. </p>
 274
 275 </div>
 276 </div>
 277 </div><!-- contents -->
 278 </div><!-- doc-content -->
 279 <!-- start footer part -->
 280 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 281   <ul>
 282     <li class="footer">
 283       <script type="text/javascript">
 284         <!--
 285         writeFooter.call(this);
 286         //-->
 287       </script>
 288     </li>
 289   </ul>
 290 </div>
 291 </body>
 292 </html>