begriffs open source - cmsis/blob - v6.1.0-rc0/Driver/group__usbh__host__gr.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: USB Host</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__host__gr.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="#groups">Content</a> &#124;
 129 <a href="#nested-classes">Data Structures</a> &#124;
 130 <a href="#typedef-members">Typedefs</a> &#124;
 131 <a href="#func-members">Functions</a>  </div>
 132   <div class="headertitle"><div class="title">USB Host<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>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Driver API for USB Host.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 140 Content</h2></td></tr>
 141 <tr class="memitem:group__USBH__port__events"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__port__events.html">USBH Port Events</a></td></tr>
 142 <tr class="memdesc:group__USBH__port__events"><td class="mdescLeft">&#160;</td><td class="mdescRight">The USB Host driver generates Port call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a>. <br /></td></tr>
 143 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:group__USBH__pipe__events"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__pipe__events.html">USBH Pipe Events</a></td></tr>
 145 <tr class="memdesc:group__USBH__pipe__events"><td class="mdescLeft">&#160;</td><td class="mdescRight">The USB Host driver generates Pipe call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>. <br /></td></tr>
 146 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:group__USBH__packets"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBH__packets.html">USBH Packet Information</a></td></tr>
 148 <tr class="memdesc:group__USBH__packets"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify USB packet information used by the function <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a>. <br /></td></tr>
 149 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table><table class="memberdecls">
 151 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 152 Data Structures</h2></td></tr>
 153 <tr class="memitem:structARM__DRIVER__USBH"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a></td></tr>
 154 <tr class="memdesc:structARM__DRIVER__USBH"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access structure of USB Host Driver.  <a href="group__usbh__host__gr.html#structARM__DRIVER__USBH">More...</a><br /></td></tr>
 155 <tr class="separator:structARM__DRIVER__USBH"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:structARM__USBH__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a></td></tr>
 157 <tr class="memdesc:structARM__USBH__CAPABILITIES"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Host Driver Capabilities.  <a href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">More...</a><br /></td></tr>
 158 <tr class="separator:structARM__USBH__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:structARM__USBH__PORT__STATE"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a></td></tr>
 160 <tr class="memdesc:structARM__USBH__PORT__STATE"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Host Port State.  <a href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">More...</a><br /></td></tr>
 161 <tr class="separator:structARM__USBH__PORT__STATE"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 </table><table class="memberdecls">
 163 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 164 Typedefs</h2></td></tr>
 165 <tr class="memitem:ga2e4d0ebd0851ba7bf364ae1d8948672c"><td class="memItemLeft" align="right" valign="top">typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a></td></tr>
 166 <tr class="memdesc:ga2e4d0ebd0851ba7bf364ae1d8948672c"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Host Pipe Handle.  <br /></td></tr>
 167 <tr class="separator:ga2e4d0ebd0851ba7bf364ae1d8948672c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:ga61edcbb6ee863fe87abee488d78e1051"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a>) (uint8_t port, uint32_t event)</td></tr>
 169 <tr class="memdesc:ga61edcbb6ee863fe87abee488d78e1051"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> : Signal Root HUB Port Event.  <br /></td></tr>
 170 <tr class="separator:ga61edcbb6ee863fe87abee488d78e1051"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:ga1a32ebfe0db4a002aae2b0c0f8ece30c"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a>) (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t event)</td></tr>
 172 <tr class="memdesc:ga1a32ebfe0db4a002aae2b0c0f8ece30c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> : Signal Pipe Event.  <br /></td></tr>
 173 <tr class="separator:ga1a32ebfe0db4a002aae2b0c0f8ece30c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 </table><table class="memberdecls">
 175 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 176 Functions</h2></td></tr>
 177 <tr class="memitem:gab11e67e11e7a0edbc8a1afa86b971784"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784">ARM_USBH_GetVersion</a> (void)</td></tr>
 178 <tr class="memdesc:gab11e67e11e7a0edbc8a1afa86b971784"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver version.  <br /></td></tr>
 179 <tr class="separator:gab11e67e11e7a0edbc8a1afa86b971784"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:gadb509db50fdccfc7198dfd7ac54530d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a> (void)</td></tr>
 181 <tr class="memdesc:gadb509db50fdccfc7198dfd7ac54530d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver capabilities.  <br /></td></tr>
 182 <tr class="separator:gadb509db50fdccfc7198dfd7ac54530d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:gad1e73f778c95dd46d4396e7741a97f0b"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> (<a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> cb_port_event, <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> cb_pipe_event)</td></tr>
 184 <tr class="memdesc:gad1e73f778c95dd46d4396e7741a97f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize USB Host Interface.  <br /></td></tr>
 185 <tr class="separator:gad1e73f778c95dd46d4396e7741a97f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:gafc2f18bc12bb0019f9cd1836dcca408d"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">ARM_USBH_Uninitialize</a> (void)</td></tr>
 187 <tr class="memdesc:gafc2f18bc12bb0019f9cd1836dcca408d"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize USB Host Interface.  <br /></td></tr>
 188 <tr class="separator:gafc2f18bc12bb0019f9cd1836dcca408d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:ga290a5e2e491da784e63be94699974d4a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">ARM_USBH_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 190 <tr class="memdesc:ga290a5e2e491da784e63be94699974d4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control USB Host Interface Power.  <br /></td></tr>
 191 <tr class="separator:ga290a5e2e491da784e63be94699974d4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 192 <tr class="memitem:gaccca5ddd4a9d04388e7678a3aed3f6e4"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">ARM_USBH_PortVbusOnOff</a> (uint8_t port, bool vbus)</td></tr>
 193 <tr class="memdesc:gaccca5ddd4a9d04388e7678a3aed3f6e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Root HUB Port VBUS on/off.  <br /></td></tr>
 194 <tr class="separator:gaccca5ddd4a9d04388e7678a3aed3f6e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 195 <tr class="memitem:gab99882e11ee03018da9ebe33797cc5ff"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a> (uint8_t port)</td></tr>
 196 <tr class="memdesc:gab99882e11ee03018da9ebe33797cc5ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Do Root HUB Port Reset.  <br /></td></tr>
 197 <tr class="separator:gab99882e11ee03018da9ebe33797cc5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 198 <tr class="memitem:ga620f8852a70a47a581001ed3050436d6"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">ARM_USBH_PortSuspend</a> (uint8_t port)</td></tr>
 199 <tr class="memdesc:ga620f8852a70a47a581001ed3050436d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend Root HUB Port (stop generating SOFs).  <br /></td></tr>
 200 <tr class="separator:ga620f8852a70a47a581001ed3050436d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 201 <tr class="memitem:gab438b55ada37e2987e77e105f061f2de"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">ARM_USBH_PortResume</a> (uint8_t port)</td></tr>
 202 <tr class="memdesc:gab438b55ada37e2987e77e105f061f2de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resume Root HUB Port (start generating SOFs).  <br /></td></tr>
 203 <tr class="separator:gab438b55ada37e2987e77e105f061f2de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 204 <tr class="memitem:gaea4ec5453c1d5fe37a2507d3cb4713bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> (uint8_t port)</td></tr>
 205 <tr class="memdesc:gaea4ec5453c1d5fe37a2507d3cb4713bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current Root HUB Port State.  <br /></td></tr>
 206 <tr class="separator:gaea4ec5453c1d5fe37a2507d3cb4713bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 207 <tr class="memitem:ga30dcc05151a98c5a8f6fe17e83777fe0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> (uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)</td></tr>
 208 <tr class="memdesc:ga30dcc05151a98c5a8f6fe17e83777fe0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create Pipe in System.  <br /></td></tr>
 209 <tr class="separator:ga30dcc05151a98c5a8f6fe17e83777fe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 210 <tr class="memitem:ga2076a7ae55f603859c726e57b061ac73"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)</td></tr>
 211 <tr class="memdesc:ga2076a7ae55f603859c726e57b061ac73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modify Pipe in System.  <br /></td></tr>
 212 <tr class="separator:ga2076a7ae55f603859c726e57b061ac73"><td class="memSeparator" colspan="2">&#160;</td></tr>
 213 <tr class="memitem:gab2135041e6d481f186015f36fa0d0521"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 214 <tr class="memdesc:gab2135041e6d481f186015f36fa0d0521"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete Pipe from System.  <br /></td></tr>
 215 <tr class="separator:gab2135041e6d481f186015f36fa0d0521"><td class="memSeparator" colspan="2">&#160;</td></tr>
 216 <tr class="memitem:ga7f5a605dbe98e450e6965d515fde65a7"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 217 <tr class="memdesc:ga7f5a605dbe98e450e6965d515fde65a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset Pipe.  <br /></td></tr>
 218 <tr class="separator:ga7f5a605dbe98e450e6965d515fde65a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 219 <tr class="memitem:ga817d503a24ad8927fa362c8f6394920d"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t packet, uint8_t *data, uint32_t num)</td></tr>
 220 <tr class="memdesc:ga817d503a24ad8927fa362c8f6394920d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transfer packets through USB Pipe.  <br /></td></tr>
 221 <tr class="separator:ga817d503a24ad8927fa362c8f6394920d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 222 <tr class="memitem:ga85baa421345a5b92881ad190d72ca47f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 223 <tr class="memdesc:ga85baa421345a5b92881ad190d72ca47f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get result of USB Pipe transfer.  <br /></td></tr>
 224 <tr class="separator:ga85baa421345a5b92881ad190d72ca47f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 225 <tr class="memitem:ga1d4048a076aed71e585cea96a21f0afb"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 226 <tr class="memdesc:ga1d4048a076aed71e585cea96a21f0afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort current USB Pipe transfer.  <br /></td></tr>
 227 <tr class="separator:ga1d4048a076aed71e585cea96a21f0afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 228 <tr class="memitem:ga9dc305fc234c9987b9efd679b5042cc9"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9">ARM_USBH_GetFrameNumber</a> (void)</td></tr>
 229 <tr class="memdesc:ga9dc305fc234c9987b9efd679b5042cc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current USB Frame Number.  <br /></td></tr>
 230 <tr class="separator:ga9dc305fc234c9987b9efd679b5042cc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 231 <tr class="memitem:ga53619da2a3d56934629084b0d5c4700c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> (uint8_t port, uint32_t event)</td></tr>
 232 <tr class="memdesc:ga53619da2a3d56934629084b0d5c4700c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal Root HUB Port Event.  <br /></td></tr>
 233 <tr class="separator:ga53619da2a3d56934629084b0d5c4700c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 234 <tr class="memitem:gae58d36afd83a0e32b07e89fb7145c9de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t event)</td></tr>
 235 <tr class="memdesc:gae58d36afd83a0e32b07e89fb7145c9de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal Pipe Event.  <br /></td></tr>
 236 <tr class="separator:gae58d36afd83a0e32b07e89fb7145c9de"><td class="memSeparator" colspan="2">&#160;</td></tr>
 237 </table>
 238 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 239 <p>Driver API for USB Host. </p>
 240 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 241 <a name="structARM__DRIVER__USBH" id="structARM__DRIVER__USBH"></a>
 242 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__USBH">&#9670;&#160;</a></span>ARM_DRIVER_USBH</h2>
 243
 244 <div class="memitem">
 245 <div class="memproto">
 246       <table class="memname">
 247         <tr>
 248           <td class="memname">struct ARM_DRIVER_USBH</td>
 249         </tr>
 250       </table>
 251 </div><div class="memdoc">
 252 <div class="textblock"><p>Access structure of USB Host Driver. </p>
 253 <p>The functions of the USB Host driver are accessed by function pointers. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
 254 <p>Each instance of an USBH provides such an access struct. The instance is indicated by a postfix in the symbol name of the access struct, for example:</p><ul>
 255 <li><b>Driver_USBH0</b> is the name of the access struct of the first instance (no. 0).</li>
 256 <li><b>Driver_USBH1</b> is the name of the access struct of the second instance (no. 1).</li>
 257 </ul>
 258 <p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_USBH<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver.</p>
 259 <dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
 260 </div><table class="memberdecls">
 261 <tr><td colspan="2"><h3>Data Fields</h3></td></tr>
 262 <tr class="memitem:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> )(void)</td></tr>
 263 <tr class="memdesc:a30afd9cb3113c037b5f1926f5ef93b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784">ARM_USBH_GetVersion</a> : Get driver version.  <br /></td></tr>
 264 <tr class="separator:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 265 <tr class="memitem:a20c55f083ed276d37e70c2aff09b48ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a20c55f083ed276d37e70c2aff09b48ac">GetCapabilities</a> )(void)</td></tr>
 266 <tr class="memdesc:a20c55f083ed276d37e70c2aff09b48ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a> : Get driver capabilities.  <br /></td></tr>
 267 <tr class="separator:a20c55f083ed276d37e70c2aff09b48ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
 268 <tr class="memitem:ae84aabf2a4396ec0f3e04d7d525f44ba"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ae84aabf2a4396ec0f3e04d7d525f44ba">Initialize</a> )(<a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> cb_port_event, <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> cb_pipe_event)</td></tr>
 269 <tr class="memdesc:ae84aabf2a4396ec0f3e04d7d525f44ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> : Initialize USB Host Interface.  <br /></td></tr>
 270 <tr class="separator:ae84aabf2a4396ec0f3e04d7d525f44ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 271 <tr class="memitem:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> )(void)</td></tr>
 272 <tr class="memdesc:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">ARM_USBH_Uninitialize</a> : De-initialize USB Host Interface.  <br /></td></tr>
 273 <tr class="separator:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 274 <tr class="memitem:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 275 <tr class="memdesc:a24ebae5c6011631f76027f9a16eaf5ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">ARM_USBH_PowerControl</a> : Control USB Host Interface Power.  <br /></td></tr>
 276 <tr class="separator:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 277 <tr class="memitem:af876f976d36d73d4b76063a4ed217ee8"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#af876f976d36d73d4b76063a4ed217ee8">PortVbusOnOff</a> )(uint8_t port, bool vbus)</td></tr>
 278 <tr class="memdesc:af876f976d36d73d4b76063a4ed217ee8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">ARM_USBH_PortVbusOnOff</a> : Root HUB Port VBUS on/off.  <br /></td></tr>
 279 <tr class="separator:af876f976d36d73d4b76063a4ed217ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 280 <tr class="memitem:acfb6b864bcb54660030938f629eeac12"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#acfb6b864bcb54660030938f629eeac12">PortReset</a> )(uint8_t port)</td></tr>
 281 <tr class="memdesc:acfb6b864bcb54660030938f629eeac12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a> : Do Root HUB Port Reset.  <br /></td></tr>
 282 <tr class="separator:acfb6b864bcb54660030938f629eeac12"><td class="memSeparator" colspan="2">&#160;</td></tr>
 283 <tr class="memitem:a4e64f8408f249af857f2dbafd0b93715"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a4e64f8408f249af857f2dbafd0b93715">PortSuspend</a> )(uint8_t port)</td></tr>
 284 <tr class="memdesc:a4e64f8408f249af857f2dbafd0b93715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">ARM_USBH_PortSuspend</a> : Suspend Root HUB Port (stop generating SOFs).  <br /></td></tr>
 285 <tr class="separator:a4e64f8408f249af857f2dbafd0b93715"><td class="memSeparator" colspan="2">&#160;</td></tr>
 286 <tr class="memitem:a0025da0ad65f1a048708254c84dbab35"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a0025da0ad65f1a048708254c84dbab35">PortResume</a> )(uint8_t port)</td></tr>
 287 <tr class="memdesc:a0025da0ad65f1a048708254c84dbab35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">ARM_USBH_PortResume</a> : Resume Root HUB Port (start generating SOFs).  <br /></td></tr>
 288 <tr class="separator:a0025da0ad65f1a048708254c84dbab35"><td class="memSeparator" colspan="2">&#160;</td></tr>
 289 <tr class="memitem:af2d2117bf8ab55f787ad0ddcc6ad5728"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#af2d2117bf8ab55f787ad0ddcc6ad5728">PortGetState</a> )(uint8_t port)</td></tr>
 290 <tr class="memdesc:af2d2117bf8ab55f787ad0ddcc6ad5728"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> : Get current Root HUB Port State.  <br /></td></tr>
 291 <tr class="separator:af2d2117bf8ab55f787ad0ddcc6ad5728"><td class="memSeparator" colspan="2">&#160;</td></tr>
 292 <tr class="memitem:af2c270ec993acaad391c6d9000657749"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#af2c270ec993acaad391c6d9000657749">PipeCreate</a> )(uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)</td></tr>
 293 <tr class="memdesc:af2c270ec993acaad391c6d9000657749"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> : Create Pipe in System.  <br /></td></tr>
 294 <tr class="separator:af2c270ec993acaad391c6d9000657749"><td class="memSeparator" colspan="2">&#160;</td></tr>
 295 <tr class="memitem:ae3fd2d1f1f6b8244568edc09384a80af"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ae3fd2d1f1f6b8244568edc09384a80af">PipeModify</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)</td></tr>
 296 <tr class="memdesc:ae3fd2d1f1f6b8244568edc09384a80af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a> : Modify Pipe in System.  <br /></td></tr>
 297 <tr class="separator:ae3fd2d1f1f6b8244568edc09384a80af"><td class="memSeparator" colspan="2">&#160;</td></tr>
 298 <tr class="memitem:ac0a9c135d8cd7db58b4a5da630acb74e"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ac0a9c135d8cd7db58b4a5da630acb74e">PipeDelete</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 299 <tr class="memdesc:ac0a9c135d8cd7db58b4a5da630acb74e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</a> : Delete Pipe from System.  <br /></td></tr>
 300 <tr class="separator:ac0a9c135d8cd7db58b4a5da630acb74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 301 <tr class="memitem:ac7ef58d18cdd21307ef9838a79d2fabf"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ac7ef58d18cdd21307ef9838a79d2fabf">PipeReset</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 302 <tr class="memdesc:ac7ef58d18cdd21307ef9838a79d2fabf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset</a> : Reset Pipe.  <br /></td></tr>
 303 <tr class="separator:ac7ef58d18cdd21307ef9838a79d2fabf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 304 <tr class="memitem:a064749bc52afd1cf591a8b09a9837098"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a064749bc52afd1cf591a8b09a9837098">PipeTransfer</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t packet, uint8_t *data, uint32_t num)</td></tr>
 305 <tr class="memdesc:a064749bc52afd1cf591a8b09a9837098"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> : Transfer packets through USB Pipe.  <br /></td></tr>
 306 <tr class="separator:a064749bc52afd1cf591a8b09a9837098"><td class="memSeparator" colspan="2">&#160;</td></tr>
 307 <tr class="memitem:a19a6bdae64cc0cef60576eb1ff003830"><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a19a6bdae64cc0cef60576eb1ff003830">PipeTransferGetResult</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 308 <tr class="memdesc:a19a6bdae64cc0cef60576eb1ff003830"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a> : Get result of USB Pipe transfer.  <br /></td></tr>
 309 <tr class="separator:a19a6bdae64cc0cef60576eb1ff003830"><td class="memSeparator" colspan="2">&#160;</td></tr>
 310 <tr class="memitem:a2bda35ea3792f396a43e4d56e36ed777"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#a2bda35ea3792f396a43e4d56e36ed777">PipeTransferAbort</a> )(<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td></tr>
 311 <tr class="memdesc:a2bda35ea3792f396a43e4d56e36ed777"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a> : Abort current USB Pipe transfer.  <br /></td></tr>
 312 <tr class="separator:a2bda35ea3792f396a43e4d56e36ed777"><td class="memSeparator" colspan="2">&#160;</td></tr>
 313 <tr class="memitem:ab459c9ca3d6dd6969cb410ac965fa1f6"><td class="memItemLeft" align="right" valign="top">uint16_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__host__gr.html#ab459c9ca3d6dd6969cb410ac965fa1f6">GetFrameNumber</a> )(void)</td></tr>
 314 <tr class="memdesc:ab459c9ca3d6dd6969cb410ac965fa1f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9">ARM_USBH_GetFrameNumber</a> : Get current USB Frame Number. <br  />
 315   <br /></td></tr>
 316 <tr class="separator:ab459c9ca3d6dd6969cb410ac965fa1f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 317 </table>
 318 <h4 class="groupheader">Field Documentation</h4>
 319 <a id="a30afd9cb3113c037b5f1926f5ef93b59" name="a30afd9cb3113c037b5f1926f5ef93b59"></a>
 320 <h2 class="memtitle"><span class="permalink"><a href="#a30afd9cb3113c037b5f1926f5ef93b59">&#9670;&#160;</a></span>GetVersion</h2>
 321
 322 <div class="memitem">
 323 <div class="memproto">
 324       <table class="memname">
 325         <tr>
 326           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion) (void)</td>
 327         </tr>
 328       </table>
 329 </div><div class="memdoc">
 330
 331 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gab11e67e11e7a0edbc8a1afa86b971784">ARM_USBH_GetVersion</a> : Get driver version. </p>
 332
 333 </div>
 334 </div>
 335 <a id="a20c55f083ed276d37e70c2aff09b48ac" name="a20c55f083ed276d37e70c2aff09b48ac"></a>
 336 <h2 class="memtitle"><span class="permalink"><a href="#a20c55f083ed276d37e70c2aff09b48ac">&#9670;&#160;</a></span>GetCapabilities</h2>
 337
 338 <div class="memitem">
 339 <div class="memproto">
 340       <table class="memname">
 341         <tr>
 342           <td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a>(* GetCapabilities) (void)</td>
 343         </tr>
 344       </table>
 345 </div><div class="memdoc">
 346
 347 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a> : Get driver capabilities. </p>
 348
 349 </div>
 350 </div>
 351 <a id="ae84aabf2a4396ec0f3e04d7d525f44ba" name="ae84aabf2a4396ec0f3e04d7d525f44ba"></a>
 352 <h2 class="memtitle"><span class="permalink"><a href="#ae84aabf2a4396ec0f3e04d7d525f44ba">&#9670;&#160;</a></span>Initialize</h2>
 353
 354 <div class="memitem">
 355 <div class="memproto">
 356       <table class="memname">
 357         <tr>
 358           <td class="memname">int32_t(* Initialize) (<a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a> cb_port_event, <a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a> cb_pipe_event)</td>
 359         </tr>
 360       </table>
 361 </div><div class="memdoc">
 362
 363 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> : Initialize USB Host Interface. </p>
 364
 365 </div>
 366 </div>
 367 <a id="a5ce2b3d7a3a07099bf07d1eb253e92e3" name="a5ce2b3d7a3a07099bf07d1eb253e92e3"></a>
 368 <h2 class="memtitle"><span class="permalink"><a href="#a5ce2b3d7a3a07099bf07d1eb253e92e3">&#9670;&#160;</a></span>Uninitialize</h2>
 369
 370 <div class="memitem">
 371 <div class="memproto">
 372       <table class="memname">
 373         <tr>
 374           <td class="memname">int32_t(* Uninitialize) (void)</td>
 375         </tr>
 376       </table>
 377 </div><div class="memdoc">
 378
 379 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gafc2f18bc12bb0019f9cd1836dcca408d">ARM_USBH_Uninitialize</a> : De-initialize USB Host Interface. </p>
 380
 381 </div>
 382 </div>
 383 <a id="a24ebae5c6011631f76027f9a16eaf5ce" name="a24ebae5c6011631f76027f9a16eaf5ce"></a>
 384 <h2 class="memtitle"><span class="permalink"><a href="#a24ebae5c6011631f76027f9a16eaf5ce">&#9670;&#160;</a></span>PowerControl</h2>
 385
 386 <div class="memitem">
 387 <div class="memproto">
 388       <table class="memname">
 389         <tr>
 390           <td class="memname">int32_t(* PowerControl) (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
 391         </tr>
 392       </table>
 393 </div><div class="memdoc">
 394
 395 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga290a5e2e491da784e63be94699974d4a">ARM_USBH_PowerControl</a> : Control USB Host Interface Power. </p>
 396
 397 </div>
 398 </div>
 399 <a id="af876f976d36d73d4b76063a4ed217ee8" name="af876f976d36d73d4b76063a4ed217ee8"></a>
 400 <h2 class="memtitle"><span class="permalink"><a href="#af876f976d36d73d4b76063a4ed217ee8">&#9670;&#160;</a></span>PortVbusOnOff</h2>
 401
 402 <div class="memitem">
 403 <div class="memproto">
 404       <table class="memname">
 405         <tr>
 406           <td class="memname">int32_t(* PortVbusOnOff) (uint8_t port, bool vbus)</td>
 407         </tr>
 408       </table>
 409 </div><div class="memdoc">
 410
 411 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gaccca5ddd4a9d04388e7678a3aed3f6e4">ARM_USBH_PortVbusOnOff</a> : Root HUB Port VBUS on/off. </p>
 412
 413 </div>
 414 </div>
 415 <a id="acfb6b864bcb54660030938f629eeac12" name="acfb6b864bcb54660030938f629eeac12"></a>
 416 <h2 class="memtitle"><span class="permalink"><a href="#acfb6b864bcb54660030938f629eeac12">&#9670;&#160;</a></span>PortReset</h2>
 417
 418 <div class="memitem">
 419 <div class="memproto">
 420       <table class="memname">
 421         <tr>
 422           <td class="memname">int32_t(* PortReset) (uint8_t port)</td>
 423         </tr>
 424       </table>
 425 </div><div class="memdoc">
 426
 427 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a> : Do Root HUB Port Reset. </p>
 428
 429 </div>
 430 </div>
 431 <a id="a4e64f8408f249af857f2dbafd0b93715" name="a4e64f8408f249af857f2dbafd0b93715"></a>
 432 <h2 class="memtitle"><span class="permalink"><a href="#a4e64f8408f249af857f2dbafd0b93715">&#9670;&#160;</a></span>PortSuspend</h2>
 433
 434 <div class="memitem">
 435 <div class="memproto">
 436       <table class="memname">
 437         <tr>
 438           <td class="memname">int32_t(* PortSuspend) (uint8_t port)</td>
 439         </tr>
 440       </table>
 441 </div><div class="memdoc">
 442
 443 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga620f8852a70a47a581001ed3050436d6">ARM_USBH_PortSuspend</a> : Suspend Root HUB Port (stop generating SOFs). </p>
 444
 445 </div>
 446 </div>
 447 <a id="a0025da0ad65f1a048708254c84dbab35" name="a0025da0ad65f1a048708254c84dbab35"></a>
 448 <h2 class="memtitle"><span class="permalink"><a href="#a0025da0ad65f1a048708254c84dbab35">&#9670;&#160;</a></span>PortResume</h2>
 449
 450 <div class="memitem">
 451 <div class="memproto">
 452       <table class="memname">
 453         <tr>
 454           <td class="memname">int32_t(* PortResume) (uint8_t port)</td>
 455         </tr>
 456       </table>
 457 </div><div class="memdoc">
 458
 459 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gab438b55ada37e2987e77e105f061f2de">ARM_USBH_PortResume</a> : Resume Root HUB Port (start generating SOFs). </p>
 460
 461 </div>
 462 </div>
 463 <a id="af2d2117bf8ab55f787ad0ddcc6ad5728" name="af2d2117bf8ab55f787ad0ddcc6ad5728"></a>
 464 <h2 class="memtitle"><span class="permalink"><a href="#af2d2117bf8ab55f787ad0ddcc6ad5728">&#9670;&#160;</a></span>PortGetState</h2>
 465
 466 <div class="memitem">
 467 <div class="memproto">
 468       <table class="memname">
 469         <tr>
 470           <td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a>(* PortGetState) (uint8_t port)</td>
 471         </tr>
 472       </table>
 473 </div><div class="memdoc">
 474
 475 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> : Get current Root HUB Port State. </p>
 476
 477 </div>
 478 </div>
 479 <a id="af2c270ec993acaad391c6d9000657749" name="af2c270ec993acaad391c6d9000657749"></a>
 480 <h2 class="memtitle"><span class="permalink"><a href="#af2c270ec993acaad391c6d9000657749">&#9670;&#160;</a></span>PipeCreate</h2>
 481
 482 <div class="memitem">
 483 <div class="memproto">
 484       <table class="memname">
 485         <tr>
 486           <td class="memname"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>(* PipeCreate) (uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)</td>
 487         </tr>
 488       </table>
 489 </div><div class="memdoc">
 490
 491 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> : Create Pipe in System. </p>
 492
 493 </div>
 494 </div>
 495 <a id="ae3fd2d1f1f6b8244568edc09384a80af" name="ae3fd2d1f1f6b8244568edc09384a80af"></a>
 496 <h2 class="memtitle"><span class="permalink"><a href="#ae3fd2d1f1f6b8244568edc09384a80af">&#9670;&#160;</a></span>PipeModify</h2>
 497
 498 <div class="memitem">
 499 <div class="memproto">
 500       <table class="memname">
 501         <tr>
 502           <td class="memname">int32_t(* PipeModify) (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)</td>
 503         </tr>
 504       </table>
 505 </div><div class="memdoc">
 506
 507 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a> : Modify Pipe in System. </p>
 508
 509 </div>
 510 </div>
 511 <a id="ac0a9c135d8cd7db58b4a5da630acb74e" name="ac0a9c135d8cd7db58b4a5da630acb74e"></a>
 512 <h2 class="memtitle"><span class="permalink"><a href="#ac0a9c135d8cd7db58b4a5da630acb74e">&#9670;&#160;</a></span>PipeDelete</h2>
 513
 514 <div class="memitem">
 515 <div class="memproto">
 516       <table class="memname">
 517         <tr>
 518           <td class="memname">int32_t(* PipeDelete) (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
 519         </tr>
 520       </table>
 521 </div><div class="memdoc">
 522
 523 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</a> : Delete Pipe from System. </p>
 524
 525 </div>
 526 </div>
 527 <a id="ac7ef58d18cdd21307ef9838a79d2fabf" name="ac7ef58d18cdd21307ef9838a79d2fabf"></a>
 528 <h2 class="memtitle"><span class="permalink"><a href="#ac7ef58d18cdd21307ef9838a79d2fabf">&#9670;&#160;</a></span>PipeReset</h2>
 529
 530 <div class="memitem">
 531 <div class="memproto">
 532       <table class="memname">
 533         <tr>
 534           <td class="memname">int32_t(* PipeReset) (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
 535         </tr>
 536       </table>
 537 </div><div class="memdoc">
 538
 539 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset</a> : Reset Pipe. </p>
 540
 541 </div>
 542 </div>
 543 <a id="a064749bc52afd1cf591a8b09a9837098" name="a064749bc52afd1cf591a8b09a9837098"></a>
 544 <h2 class="memtitle"><span class="permalink"><a href="#a064749bc52afd1cf591a8b09a9837098">&#9670;&#160;</a></span>PipeTransfer</h2>
 545
 546 <div class="memitem">
 547 <div class="memproto">
 548       <table class="memname">
 549         <tr>
 550           <td class="memname">int32_t(* PipeTransfer) (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl, uint32_t packet, uint8_t *data, uint32_t num)</td>
 551         </tr>
 552       </table>
 553 </div><div class="memdoc">
 554
 555 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> : Transfer packets through USB Pipe. </p>
 556
 557 </div>
 558 </div>
 559 <a id="a19a6bdae64cc0cef60576eb1ff003830" name="a19a6bdae64cc0cef60576eb1ff003830"></a>
 560 <h2 class="memtitle"><span class="permalink"><a href="#a19a6bdae64cc0cef60576eb1ff003830">&#9670;&#160;</a></span>PipeTransferGetResult</h2>
 561
 562 <div class="memitem">
 563 <div class="memproto">
 564       <table class="memname">
 565         <tr>
 566           <td class="memname">uint32_t(* PipeTransferGetResult) (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
 567         </tr>
 568       </table>
 569 </div><div class="memdoc">
 570
 571 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a> : Get result of USB Pipe transfer. </p>
 572
 573 </div>
 574 </div>
 575 <a id="a2bda35ea3792f396a43e4d56e36ed777" name="a2bda35ea3792f396a43e4d56e36ed777"></a>
 576 <h2 class="memtitle"><span class="permalink"><a href="#a2bda35ea3792f396a43e4d56e36ed777">&#9670;&#160;</a></span>PipeTransferAbort</h2>
 577
 578 <div class="memitem">
 579 <div class="memproto">
 580       <table class="memname">
 581         <tr>
 582           <td class="memname">int32_t(* PipeTransferAbort) (<a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> pipe_hndl)</td>
 583         </tr>
 584       </table>
 585 </div><div class="memdoc">
 586
 587 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a> : Abort current USB Pipe transfer. </p>
 588
 589 </div>
 590 </div>
 591 <a id="ab459c9ca3d6dd6969cb410ac965fa1f6" name="ab459c9ca3d6dd6969cb410ac965fa1f6"></a>
 592 <h2 class="memtitle"><span class="permalink"><a href="#ab459c9ca3d6dd6969cb410ac965fa1f6">&#9670;&#160;</a></span>GetFrameNumber</h2>
 593
 594 <div class="memitem">
 595 <div class="memproto">
 596       <table class="memname">
 597         <tr>
 598           <td class="memname">uint16_t(* GetFrameNumber) (void)</td>
 599         </tr>
 600       </table>
 601 </div><div class="memdoc">
 602
 603 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga9dc305fc234c9987b9efd679b5042cc9">ARM_USBH_GetFrameNumber</a> : Get current USB Frame Number. <br  />
 604  </p>
 605
 606 </div>
 607 </div>
 608
 609 </div>
 610 </div>
 611 <a name="structARM__USBH__CAPABILITIES" id="structARM__USBH__CAPABILITIES"></a>
 612 <h2 class="memtitle"><span class="permalink"><a href="#structARM__USBH__CAPABILITIES">&#9670;&#160;</a></span>ARM_USBH_CAPABILITIES</h2>
 613
 614 <div class="memitem">
 615 <div class="memproto">
 616       <table class="memname">
 617         <tr>
 618           <td class="memname">struct ARM_USBH_CAPABILITIES</td>
 619         </tr>
 620       </table>
 621 </div><div class="memdoc">
 622 <div class="textblock"><p>USB Host Driver Capabilities. </p>
 623 <p><br  />
 624  A USB Host driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
 625 <p><b>Returned by:</b></p><ul>
 626 <li><a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a></li>
 627 </ul>
 628 <dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
 629 </div><table class="fieldtable">
 630 <tr><th colspan="3">Data Fields</th></tr>
 631 <tr><td class="fieldtype">
 632 <a id="ac37c09b54483c2a1e41fa8a976721fc4" name="ac37c09b54483c2a1e41fa8a976721fc4"></a>uint32_t</td>
 633 <td class="fieldname">
 634 port_mask: 15</td>
 635 <td class="fielddoc">
 636 Root HUB available Ports Mask. </td></tr>
 637 <tr><td class="fieldtype">
 638 <a id="a37eab684b9a8aa496bfec9fede42fe27" name="a37eab684b9a8aa496bfec9fede42fe27"></a>uint32_t</td>
 639 <td class="fieldname">
 640 auto_split: 1</td>
 641 <td class="fielddoc">
 642 Automatic SPLIT packet handling. </td></tr>
 643 <tr><td class="fieldtype">
 644 <a id="ae76b779cb9fdf447b20c8b6beed2d534" name="ae76b779cb9fdf447b20c8b6beed2d534"></a>uint32_t</td>
 645 <td class="fieldname">
 646 event_connect: 1</td>
 647 <td class="fielddoc">
 648 Signal Connect event. </td></tr>
 649 <tr><td class="fieldtype">
 650 <a id="ab83941051cac8e19807b887354dc42fc" name="ab83941051cac8e19807b887354dc42fc"></a>uint32_t</td>
 651 <td class="fieldname">
 652 event_disconnect: 1</td>
 653 <td class="fielddoc">
 654 Signal Disconnect event. </td></tr>
 655 <tr><td class="fieldtype">
 656 <a id="acd3087b3a4a7691595dd75568c12d696" name="acd3087b3a4a7691595dd75568c12d696"></a>uint32_t</td>
 657 <td class="fieldname">
 658 event_overcurrent: 1</td>
 659 <td class="fielddoc">
 660 Signal Overcurrent event. </td></tr>
 661 <tr><td class="fieldtype">
 662 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
 663 <td class="fieldname">
 664 reserved: 13</td>
 665 <td class="fielddoc">
 666 Reserved (must be zero) </td></tr>
 667 </table>
 668
 669 </div>
 670 </div>
 671 <a name="structARM__USBH__PORT__STATE" id="structARM__USBH__PORT__STATE"></a>
 672 <h2 class="memtitle"><span class="permalink"><a href="#structARM__USBH__PORT__STATE">&#9670;&#160;</a></span>ARM_USBH_PORT_STATE</h2>
 673
 674 <div class="memitem">
 675 <div class="memproto">
 676       <table class="memname">
 677         <tr>
 678           <td class="memname">struct ARM_USBH_PORT_STATE</td>
 679         </tr>
 680       </table>
 681 </div><div class="memdoc">
 682 <div class="textblock"><p>USB Host Port State. </p>
 683 <p><br  />
 684  This structure stores information about the state of the USB Host Port. The data fields encode whether a device is connected to the port, if port overcurrent is detected, and the port speed.</p>
 685 <p><b>Returned by:</b></p><ul>
 686 <li><a class="el" href="group__usbh__host__gr.html#gaea4ec5453c1d5fe37a2507d3cb4713bc">ARM_USBH_PortGetState</a> </li>
 687 </ul>
 688 </div><table class="fieldtable">
 689 <tr><th colspan="3">Data Fields</th></tr>
 690 <tr><td class="fieldtype">
 691 <a id="abf1a0792d6af28877b0abd141d5524ac" name="abf1a0792d6af28877b0abd141d5524ac"></a>uint32_t</td>
 692 <td class="fieldname">
 693 connected: 1</td>
 694 <td class="fielddoc">
 695 USB Host Port connected flag. </td></tr>
 696 <tr><td class="fieldtype">
 697 <a id="ae4b5761b8d095bee008a94856ceca46b" name="ae4b5761b8d095bee008a94856ceca46b"></a>uint32_t</td>
 698 <td class="fieldname">
 699 overcurrent: 1</td>
 700 <td class="fielddoc">
 701 USB Host Port overcurrent flag. </td></tr>
 702 <tr><td class="fieldtype">
 703 <a id="a220859a8b5da0232739a11cbe7f79fc5" name="a220859a8b5da0232739a11cbe7f79fc5"></a>uint32_t</td>
 704 <td class="fieldname">
 705 speed: 2</td>
 706 <td class="fielddoc">
 707 USB Host Port speed setting (ARM_USB_SPEED_xxx) </td></tr>
 708 <tr><td class="fieldtype">
 709 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
 710 <td class="fieldname">
 711 reserved: 28</td>
 712 <td class="fielddoc">
 713 </td></tr>
 714 </table>
 715
 716 </div>
 717 </div>
 718 <h2 class="groupheader">Typedef Documentation</h2>
 719 <a id="ga2e4d0ebd0851ba7bf364ae1d8948672c" name="ga2e4d0ebd0851ba7bf364ae1d8948672c"></a>
 720 <h2 class="memtitle"><span class="permalink"><a href="#ga2e4d0ebd0851ba7bf364ae1d8948672c">&#9670;&#160;</a></span>ARM_USBH_PIPE_HANDLE</h2>
 721
 722 <div class="memitem">
 723 <div class="memproto">
 724       <table class="memname">
 725         <tr>
 726           <td class="memname">uint32_t <a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a></td>
 727         </tr>
 728       </table>
 729 </div><div class="memdoc">
 730
 731 <p>USB Host Pipe Handle. </p>
 732 <p>Each pipe is identified through a unique number, which is created by the function <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a>.</p>
 733 <p><b>Parameter for:</b></p><ul>
 734 <li><a class="el" href="group__usbh__host__gr.html#ga2076a7ae55f603859c726e57b061ac73">ARM_USBH_PipeModify</a>, <a class="el" href="group__usbh__host__gr.html#gab2135041e6d481f186015f36fa0d0521">ARM_USBH_PipeDelete</a>, <a class="el" href="group__usbh__host__gr.html#ga7f5a605dbe98e450e6965d515fde65a7">ARM_USBH_PipeReset</a>, <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a>, <a class="el" href="group__usbh__host__gr.html#ga85baa421345a5b92881ad190d72ca47f">ARM_USBH_PipeTransferGetResult</a>, <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a>, <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a></li>
 735 </ul>
 736 <p><b>Retruned by:</b></p><ul>
 737 <li><a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> </li>
 738 </ul>
 739
 740 </div>
 741 </div>
 742 <a id="ga61edcbb6ee863fe87abee488d78e1051" name="ga61edcbb6ee863fe87abee488d78e1051"></a>
 743 <h2 class="memtitle"><span class="permalink"><a href="#ga61edcbb6ee863fe87abee488d78e1051">&#9670;&#160;</a></span>ARM_USBH_SignalPortEvent_t</h2>
 744
 745 <div class="memitem">
 746 <div class="memproto">
 747       <table class="memname">
 748         <tr>
 749           <td class="memname">ARM_USBH_SignalPortEvent_t</td>
 750         </tr>
 751       </table>
 752 </div><div class="memdoc">
 753
 754 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> : Signal Root HUB Port Event. </p>
 755 <p>Provides the typedef for the callback function <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a>.</p>
 756 <p><b>Parameter for:</b></p><ul>
 757 <li><a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> </li>
 758 </ul>
 759
 760 </div>
 761 </div>
 762 <a id="ga1a32ebfe0db4a002aae2b0c0f8ece30c" name="ga1a32ebfe0db4a002aae2b0c0f8ece30c"></a>
 763 <h2 class="memtitle"><span class="permalink"><a href="#ga1a32ebfe0db4a002aae2b0c0f8ece30c">&#9670;&#160;</a></span>ARM_USBH_SignalPipeEvent_t</h2>
 764
 765 <div class="memitem">
 766 <div class="memproto">
 767       <table class="memname">
 768         <tr>
 769           <td class="memname">ARM_USBH_SignalPipeEvent_t</td>
 770         </tr>
 771       </table>
 772 </div><div class="memdoc">
 773
 774 <p>Pointer to <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> : Signal Pipe Event. </p>
 775 <p>Provides the typedef for the callback function <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>.</p>
 776 <p><b>Parameter for:</b></p><ul>
 777 <li><a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a> </li>
 778 </ul>
 779
 780 </div>
 781 </div>
 782 <h2 class="groupheader">Function Documentation</h2>
 783 <a id="gab11e67e11e7a0edbc8a1afa86b971784" name="gab11e67e11e7a0edbc8a1afa86b971784"></a>
 784 <h2 class="memtitle"><span class="permalink"><a href="#gab11e67e11e7a0edbc8a1afa86b971784">&#9670;&#160;</a></span>ARM_USBH_GetVersion()</h2>
 785
 786 <div class="memitem">
 787 <div class="memproto">
 788       <table class="memname">
 789         <tr>
 790           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_USBH_GetVersion </td>
 791           <td>(</td>
 792           <td class="paramtype">void&#160;</td>
 793           <td class="paramname"></td><td>)</td>
 794           <td></td>
 795         </tr>
 796       </table>
 797 </div><div class="memdoc">
 798
 799 <p>Get driver version. </p>
 800 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></dd></dl>
 801 <p>The function <b>ARM_USBH_GetVersion</b> returns version information of the driver implementation in <a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></p><ul>
 802 <li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
 803 <li>Driver version is source code version of the actual driver implementation.</li>
 804 </ul>
 805 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> Driver_USBH0;</div>
 806 <div class="line"><a class="code hl_struct" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> *drv_info;</div>
 807 <div class="line"> </div>
 808 <div class="line"><span class="keywordtype">void</span> setup_usbh (<span class="keywordtype">void</span>)  {</div>
 809 <div class="line">  <a class="code hl_struct" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>  version;</div>
 810 <div class="line"> </div>
 811 <div class="line">  drv_info = &amp;Driver_USBH0;  </div>
 812 <div class="line">  version = drv_info-&gt;<a class="code hl_variable" href="group__usbh__host__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> ();</div>
 813 <div class="line">  <span class="keywordflow">if</span> (version.<a class="code hl_variable" href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">api</a> &lt; 0x10A)   {      <span class="comment">// requires at minimum API version 1.10 or higher</span></div>
 814 <div class="line">    <span class="comment">// error handling</span></div>
 815 <div class="line">    <span class="keywordflow">return</span>;</div>
 816 <div class="line">  }</div>
 817 <div class="line">}</div>
 818 <div class="ttc" id="agroup__common__drv__gr_html_ad180da20fbde1d3dafc074af87c19540"><div class="ttname"><a href="group__common__drv__gr.html#ad180da20fbde1d3dafc074af87c19540">ARM_DRIVER_VERSION::api</a></div><div class="ttdeci">uint16_t api</div><div class="ttdoc">API version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:47</div></div>
 819 <div class="ttc" id="agroup__common__drv__gr_html_structARM__DRIVER__VERSION"><div class="ttname"><a href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a></div><div class="ttdoc">Driver Version.</div><div class="ttdef"><b>Definition:</b> Driver_Common.h:46</div></div>
 820 <div class="ttc" id="agroup__usbh__host__gr_html_a30afd9cb3113c037b5f1926f5ef93b59"><div class="ttname"><a href="group__usbh__host__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">ARM_DRIVER_USBH::GetVersion</a></div><div class="ttdeci">ARM_DRIVER_VERSION(* GetVersion)(void)</div><div class="ttdoc">Pointer to ARM_USBH_GetVersion : Get driver version.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:308</div></div>
 821 <div class="ttc" id="agroup__usbh__host__gr_html_structARM__DRIVER__USBH"><div class="ttname"><a href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a></div><div class="ttdoc">Access structure of USB Host Driver.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:307</div></div>
 822 </div><!-- fragment -->
 823 </div>
 824 </div>
 825 <a id="gadb509db50fdccfc7198dfd7ac54530d7" name="gadb509db50fdccfc7198dfd7ac54530d7"></a>
 826 <h2 class="memtitle"><span class="permalink"><a href="#gadb509db50fdccfc7198dfd7ac54530d7">&#9670;&#160;</a></span>ARM_USBH_GetCapabilities()</h2>
 827
 828 <div class="memitem">
 829 <div class="memproto">
 830       <table class="memname">
 831         <tr>
 832           <td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a> ARM_USBH_GetCapabilities </td>
 833           <td>(</td>
 834           <td class="paramtype">void&#160;</td>
 835           <td class="paramname"></td><td>)</td>
 836           <td></td>
 837         </tr>
 838       </table>
 839 </div><div class="memdoc">
 840
 841 <p>Get driver capabilities. </p>
 842 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a></dd></dl>
 843 <p>The function <b>ARM_USBH_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a> encode various capabilities, for example available HUB ports or if the hardware can generate signal events using the <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> callback function.</p>
 844 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> Driver_USBH0;</div>
 845 <div class="line"><a class="code hl_struct" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> *drv_info;</div>
 846 <div class="line">  </div>
 847 <div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>)  {</div>
 848 <div class="line">  <a class="code hl_struct" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a> drv_capabilities;</div>
 849 <div class="line"> </div>
 850 <div class="line">  drv_info = &amp;Driver_USBH0;  </div>
 851 <div class="line">  drv_capabilities = drv_info-&gt;<a class="code hl_variable" href="group__usbh__host__gr.html#a20c55f083ed276d37e70c2aff09b48ac">GetCapabilities</a> ();</div>
 852 <div class="line">  <span class="comment">// interrogate capabilities</span></div>
 853 <div class="line"> </div>
 854 <div class="line">}</div>
 855 <div class="ttc" id="agroup__usbh__host__gr_html_a20c55f083ed276d37e70c2aff09b48ac"><div class="ttname"><a href="group__usbh__host__gr.html#a20c55f083ed276d37e70c2aff09b48ac">ARM_DRIVER_USBH::GetCapabilities</a></div><div class="ttdeci">ARM_USBH_CAPABILITIES(* GetCapabilities)(void)</div><div class="ttdoc">Pointer to ARM_USBH_GetCapabilities : Get driver capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:309</div></div>
 856 <div class="ttc" id="agroup__usbh__host__gr_html_structARM__USBH__CAPABILITIES"><div class="ttname"><a href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a></div><div class="ttdoc">USB Host Driver Capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:294</div></div>
 857 </div><!-- fragment -->
 858 </div>
 859 </div>
 860 <a id="gad1e73f778c95dd46d4396e7741a97f0b" name="gad1e73f778c95dd46d4396e7741a97f0b"></a>
 861 <h2 class="memtitle"><span class="permalink"><a href="#gad1e73f778c95dd46d4396e7741a97f0b">&#9670;&#160;</a></span>ARM_USBH_Initialize()</h2>
 862
 863 <div class="memitem">
 864 <div class="memproto">
 865       <table class="memname">
 866         <tr>
 867           <td class="memname">int32_t ARM_USBH_Initialize </td>
 868           <td>(</td>
 869           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga61edcbb6ee863fe87abee488d78e1051">ARM_USBH_SignalPortEvent_t</a>&#160;</td>
 870           <td class="paramname"><em>cb_port_event</em>, </td>
 871         </tr>
 872         <tr>
 873           <td class="paramkey"></td>
 874           <td></td>
 875           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga1a32ebfe0db4a002aae2b0c0f8ece30c">ARM_USBH_SignalPipeEvent_t</a>&#160;</td>
 876           <td class="paramname"><em>cb_pipe_event</em>&#160;</td>
 877         </tr>
 878         <tr>
 879           <td></td>
 880           <td>)</td>
 881           <td></td><td></td>
 882         </tr>
 883       </table>
 884 </div><div class="memdoc">
 885
 886 <p>Initialize USB Host Interface. </p>
 887 <dl class="params"><dt>Parameters</dt><dd>
 888   <table class="params">
 889     <tr><td class="paramdir">[in]</td><td class="paramname">cb_port_event</td><td>Pointer to <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> </td></tr>
 890     <tr><td class="paramdir">[in]</td><td class="paramname">cb_pipe_event</td><td>Pointer to <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> </td></tr>
 891   </table>
 892   </dd>
 893 </dl>
 894 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 895 <p>The function <b>ARM_USBH_Initialize</b> initializes the USB Host interface. It is called when the middleware component starts operation.</p>
 896 <p>The function performs the following operations:</p><ul>
 897 <li>Initializes the resources needed for the USBH interface.</li>
 898 <li>Registers the <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> callback function.</li>
 899 <li>Registers the <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> callback function.</li>
 900 </ul>
 901 <p>The parameter <em>cb_port_event</em> is a pointer to the <a class="el" href="group__usbh__host__gr.html#ga53619da2a3d56934629084b0d5c4700c">ARM_USBH_SignalPortEvent</a> callback function; use a NULL pointer when no port callback signals are required.</p>
 902 <p>The parameter <em>cb_pipe_event</em> is a pointer to the <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> callback function.</p>
 903 <p><b>Example:</b> </p><ul>
 904 <li>see <a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> - Driver Functions </li>
 905 </ul>
 906
 907 </div>
 908 </div>
 909 <a id="gafc2f18bc12bb0019f9cd1836dcca408d" name="gafc2f18bc12bb0019f9cd1836dcca408d"></a>
 910 <h2 class="memtitle"><span class="permalink"><a href="#gafc2f18bc12bb0019f9cd1836dcca408d">&#9670;&#160;</a></span>ARM_USBH_Uninitialize()</h2>
 911
 912 <div class="memitem">
 913 <div class="memproto">
 914       <table class="memname">
 915         <tr>
 916           <td class="memname">int32_t ARM_USBH_Uninitialize </td>
 917           <td>(</td>
 918           <td class="paramtype">void&#160;</td>
 919           <td class="paramname"></td><td>)</td>
 920           <td></td>
 921         </tr>
 922       </table>
 923 </div><div class="memdoc">
 924
 925 <p>De-initialize USB Host Interface. </p>
 926 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 927 <p>The function <b>ARM_USBH_Uninitialize</b> de-initializes the resources of USB Host interface.</p>
 928 <p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
 929
 930 </div>
 931 </div>
 932 <a id="ga290a5e2e491da784e63be94699974d4a" name="ga290a5e2e491da784e63be94699974d4a"></a>
 933 <h2 class="memtitle"><span class="permalink"><a href="#ga290a5e2e491da784e63be94699974d4a">&#9670;&#160;</a></span>ARM_USBH_PowerControl()</h2>
 934
 935 <div class="memitem">
 936 <div class="memproto">
 937       <table class="memname">
 938         <tr>
 939           <td class="memname">int32_t ARM_USBH_PowerControl </td>
 940           <td>(</td>
 941           <td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>&#160;</td>
 942           <td class="paramname"><em>state</em></td><td>)</td>
 943           <td></td>
 944         </tr>
 945       </table>
 946 </div><div class="memdoc">
 947
 948 <p>Control USB Host Interface Power. </p>
 949 <dl class="params"><dt>Parameters</dt><dd>
 950   <table class="params">
 951     <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
 952   </table>
 953   </dd>
 954 </dl>
 955 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 956 <p>The function <b>ARM_USBH_PowerControl</b> operates the power modes of the USB Host interface.</p>
 957 <p>The parameter <em>state</em> sets the operation and can have the following values:</p><ul>
 958 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5abed52b77a9ce4775570e44a842b1295e">ARM_POWER_FULL</a> : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA. Can be called multiple times. If the peripheral is already in this mode the function performs no operation and returns with <a class="el" href="group__execution__status.html#ga85752c5de59e8adeb001e35ff5be6be7">ARM_DRIVER_OK</a>.</li>
 959 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5a9ef9e57cbcc948d0e22314e73dc8c434">ARM_POWER_LOW</a> : may use power saving. Returns <a class="el" href="group__execution__status.html#ga2efa59e480d82697795439220e6884e4">ARM_DRIVER_ERROR_UNSUPPORTED</a> when not implemented.</li>
 960 <li><a class="el" href="Driver__Common_8h.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5ab6f5becc85ebd51c3dd2524a95d2ca35">ARM_POWER_OFF</a> : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.</li>
 961 </ul>
 962 <p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
 963
 964 </div>
 965 </div>
 966 <a id="gaccca5ddd4a9d04388e7678a3aed3f6e4" name="gaccca5ddd4a9d04388e7678a3aed3f6e4"></a>
 967 <h2 class="memtitle"><span class="permalink"><a href="#gaccca5ddd4a9d04388e7678a3aed3f6e4">&#9670;&#160;</a></span>ARM_USBH_PortVbusOnOff()</h2>
 968
 969 <div class="memitem">
 970 <div class="memproto">
 971       <table class="memname">
 972         <tr>
 973           <td class="memname">int32_t ARM_USBH_PortVbusOnOff </td>
 974           <td>(</td>
 975           <td class="paramtype">uint8_t&#160;</td>
 976           <td class="paramname"><em>port</em>, </td>
 977         </tr>
 978         <tr>
 979           <td class="paramkey"></td>
 980           <td></td>
 981           <td class="paramtype">bool&#160;</td>
 982           <td class="paramname"><em>vbus</em>&#160;</td>
 983         </tr>
 984         <tr>
 985           <td></td>
 986           <td>)</td>
 987           <td></td><td></td>
 988         </tr>
 989       </table>
 990 </div><div class="memdoc">
 991
 992 <p>Root HUB Port VBUS on/off. </p>
 993 <dl class="params"><dt>Parameters</dt><dd>
 994   <table class="params">
 995     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
 996     <tr><td class="paramdir">[in]</td><td class="paramname">vbus</td><td><ul>
 997 <li><b>false</b> VBUS off</li>
 998 <li><b>true</b> VBUS on </li>
 999 </ul>
1000 </td></tr>
1001   </table>
1002   </dd>
1003 </dl>
1004 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1005 <p>The function <b>ARM_USBH_PortVbusOnOff</b> controls the VBUS signal of the specified port. <br  />
1006  </p>
1007
1008 </div>
1009 </div>
1010 <a id="gab99882e11ee03018da9ebe33797cc5ff" name="gab99882e11ee03018da9ebe33797cc5ff"></a>
1011 <h2 class="memtitle"><span class="permalink"><a href="#gab99882e11ee03018da9ebe33797cc5ff">&#9670;&#160;</a></span>ARM_USBH_PortReset()</h2>
1012
1013 <div class="memitem">
1014 <div class="memproto">
1015       <table class="memname">
1016         <tr>
1017           <td class="memname">int32_t ARM_USBH_PortReset </td>
1018           <td>(</td>
1019           <td class="paramtype">uint8_t&#160;</td>
1020           <td class="paramname"><em>port</em></td><td>)</td>
1021           <td></td>
1022         </tr>
1023       </table>
1024 </div><div class="memdoc">
1025
1026 <p>Do Root HUB Port Reset. </p>
1027 <dl class="params"><dt>Parameters</dt><dd>
1028   <table class="params">
1029     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
1030   </table>
1031   </dd>
1032 </dl>
1033 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1034 <p>Executes reset signalling on the specified port. </p>
1035
1036 </div>
1037 </div>
1038 <a id="ga620f8852a70a47a581001ed3050436d6" name="ga620f8852a70a47a581001ed3050436d6"></a>
1039 <h2 class="memtitle"><span class="permalink"><a href="#ga620f8852a70a47a581001ed3050436d6">&#9670;&#160;</a></span>ARM_USBH_PortSuspend()</h2>
1040
1041 <div class="memitem">
1042 <div class="memproto">
1043       <table class="memname">
1044         <tr>
1045           <td class="memname">int32_t ARM_USBH_PortSuspend </td>
1046           <td>(</td>
1047           <td class="paramtype">uint8_t&#160;</td>
1048           <td class="paramname"><em>port</em></td><td>)</td>
1049           <td></td>
1050         </tr>
1051       </table>
1052 </div><div class="memdoc">
1053
1054 <p>Suspend Root HUB Port (stop generating SOFs). </p>
1055 <dl class="params"><dt>Parameters</dt><dd>
1056   <table class="params">
1057     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
1058   </table>
1059   </dd>
1060 </dl>
1061 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1062 <p>The function <b>ARM_USBH_PortSuspend</b> auspends USB signaling on the specified port. </p>
1063
1064 </div>
1065 </div>
1066 <a id="gab438b55ada37e2987e77e105f061f2de" name="gab438b55ada37e2987e77e105f061f2de"></a>
1067 <h2 class="memtitle"><span class="permalink"><a href="#gab438b55ada37e2987e77e105f061f2de">&#9670;&#160;</a></span>ARM_USBH_PortResume()</h2>
1068
1069 <div class="memitem">
1070 <div class="memproto">
1071       <table class="memname">
1072         <tr>
1073           <td class="memname">int32_t ARM_USBH_PortResume </td>
1074           <td>(</td>
1075           <td class="paramtype">uint8_t&#160;</td>
1076           <td class="paramname"><em>port</em></td><td>)</td>
1077           <td></td>
1078         </tr>
1079       </table>
1080 </div><div class="memdoc">
1081
1082 <p>Resume Root HUB Port (start generating SOFs). </p>
1083 <dl class="params"><dt>Parameters</dt><dd>
1084   <table class="params">
1085     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
1086   </table>
1087   </dd>
1088 </dl>
1089 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1090 <p>The function <b>ARM_USBH_PortResume</b> resumes USB signaling on the specified port. </p>
1091
1092 </div>
1093 </div>
1094 <a id="gaea4ec5453c1d5fe37a2507d3cb4713bc" name="gaea4ec5453c1d5fe37a2507d3cb4713bc"></a>
1095 <h2 class="memtitle"><span class="permalink"><a href="#gaea4ec5453c1d5fe37a2507d3cb4713bc">&#9670;&#160;</a></span>ARM_USBH_PortGetState()</h2>
1096
1097 <div class="memitem">
1098 <div class="memproto">
1099       <table class="memname">
1100         <tr>
1101           <td class="memname"><a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a> ARM_USBH_PortGetState </td>
1102           <td>(</td>
1103           <td class="paramtype">uint8_t&#160;</td>
1104           <td class="paramname"><em>port</em></td><td>)</td>
1105           <td></td>
1106         </tr>
1107       </table>
1108 </div><div class="memdoc">
1109
1110 <p>Get current Root HUB Port State. </p>
1111 <dl class="params"><dt>Parameters</dt><dd>
1112   <table class="params">
1113     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
1114   </table>
1115   </dd>
1116 </dl>
1117 <dl class="section return"><dt>Returns</dt><dd>Port State <a class="el" href="group__usbh__host__gr.html#structARM__USBH__PORT__STATE">ARM_USBH_PORT_STATE</a></dd></dl>
1118 <p>The function <b>ARM_USBH_PortGetState</b> returns the current state of the specified port. </p>
1119
1120 </div>
1121 </div>
1122 <a id="ga30dcc05151a98c5a8f6fe17e83777fe0" name="ga30dcc05151a98c5a8f6fe17e83777fe0"></a>
1123 <h2 class="memtitle"><span class="permalink"><a href="#ga30dcc05151a98c5a8f6fe17e83777fe0">&#9670;&#160;</a></span>ARM_USBH_PipeCreate()</h2>
1124
1125 <div class="memitem">
1126 <div class="memproto">
1127       <table class="memname">
1128         <tr>
1129           <td class="memname"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a> ARM_USBH_PipeCreate </td>
1130           <td>(</td>
1131           <td class="paramtype">uint8_t&#160;</td>
1132           <td class="paramname"><em>dev_addr</em>, </td>
1133         </tr>
1134         <tr>
1135           <td class="paramkey"></td>
1136           <td></td>
1137           <td class="paramtype">uint8_t&#160;</td>
1138           <td class="paramname"><em>dev_speed</em>, </td>
1139         </tr>
1140         <tr>
1141           <td class="paramkey"></td>
1142           <td></td>
1143           <td class="paramtype">uint8_t&#160;</td>
1144           <td class="paramname"><em>hub_addr</em>, </td>
1145         </tr>
1146         <tr>
1147           <td class="paramkey"></td>
1148           <td></td>
1149           <td class="paramtype">uint8_t&#160;</td>
1150           <td class="paramname"><em>hub_port</em>, </td>
1151         </tr>
1152         <tr>
1153           <td class="paramkey"></td>
1154           <td></td>
1155           <td class="paramtype">uint8_t&#160;</td>
1156           <td class="paramname"><em>ep_addr</em>, </td>
1157         </tr>
1158         <tr>
1159           <td class="paramkey"></td>
1160           <td></td>
1161           <td class="paramtype">uint8_t&#160;</td>
1162           <td class="paramname"><em>ep_type</em>, </td>
1163         </tr>
1164         <tr>
1165           <td class="paramkey"></td>
1166           <td></td>
1167           <td class="paramtype">uint16_t&#160;</td>
1168           <td class="paramname"><em>ep_max_packet_size</em>, </td>
1169         </tr>
1170         <tr>
1171           <td class="paramkey"></td>
1172           <td></td>
1173           <td class="paramtype">uint8_t&#160;</td>
1174           <td class="paramname"><em>ep_interval</em>&#160;</td>
1175         </tr>
1176         <tr>
1177           <td></td>
1178           <td>)</td>
1179           <td></td><td></td>
1180         </tr>
1181       </table>
1182 </div><div class="memdoc">
1183
1184 <p>Create Pipe in System. </p>
1185 <dl class="params"><dt>Parameters</dt><dd>
1186   <table class="params">
1187     <tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Device Address </td></tr>
1188     <tr><td class="paramdir">[in]</td><td class="paramname">dev_speed</td><td>Device Speed </td></tr>
1189     <tr><td class="paramdir">[in]</td><td class="paramname">hub_addr</td><td>Hub Address </td></tr>
1190     <tr><td class="paramdir">[in]</td><td class="paramname">hub_port</td><td>Hub Port </td></tr>
1191     <tr><td class="paramdir">[in]</td><td class="paramname">ep_addr</td><td>Endpoint Address<ul>
1192 <li>ep_addr.0..3: Address</li>
1193 <li>ep_addr.7: Direction </li>
1194 </ul>
1195 </td></tr>
1196     <tr><td class="paramdir">[in]</td><td class="paramname">ep_type</td><td>Endpoint Type (ARM_USB_ENDPOINT_xxx) </td></tr>
1197     <tr><td class="paramdir">[in]</td><td class="paramname">ep_max_packet_size</td><td>Endpoint Maximum Packet Size </td></tr>
1198     <tr><td class="paramdir">[in]</td><td class="paramname">ep_interval</td><td>Endpoint Polling Interval </td></tr>
1199   </table>
1200   </dd>
1201 </dl>
1202 <dl class="section return"><dt>Returns</dt><dd>Pipe Handle <a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a></dd></dl>
1203 <p>The function <b>ARM_USBH_PipeCreate</b> creates a pipe for transfers (allocates required resources and configures the pipe).</p>
1204 <p>The parameters specify pipe information (connection between host and device endpoint):</p><ul>
1205 <li>device: address and speed</li>
1206 <li>hub (optional): hub address and number of the hub port to which the device is connected</li>
1207 <li>endpoint: address, type, maximum packet size and polling interval</li>
1208 </ul>
1209 <p>The function returns an pipe handle that is used for all subsequent operations on that pipe. In case of errors an invalid handle (<em>NULL</em>) is returned. <br  />
1210  </p>
1211
1212 </div>
1213 </div>
1214 <a id="ga2076a7ae55f603859c726e57b061ac73" name="ga2076a7ae55f603859c726e57b061ac73"></a>
1215 <h2 class="memtitle"><span class="permalink"><a href="#ga2076a7ae55f603859c726e57b061ac73">&#9670;&#160;</a></span>ARM_USBH_PipeModify()</h2>
1216
1217 <div class="memitem">
1218 <div class="memproto">
1219       <table class="memname">
1220         <tr>
1221           <td class="memname">int32_t ARM_USBH_PipeModify </td>
1222           <td>(</td>
1223           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td>
1224           <td class="paramname"><em>pipe_hndl</em>, </td>
1225         </tr>
1226         <tr>
1227           <td class="paramkey"></td>
1228           <td></td>
1229           <td class="paramtype">uint8_t&#160;</td>
1230           <td class="paramname"><em>dev_addr</em>, </td>
1231         </tr>
1232         <tr>
1233           <td class="paramkey"></td>
1234           <td></td>
1235           <td class="paramtype">uint8_t&#160;</td>
1236           <td class="paramname"><em>dev_speed</em>, </td>
1237         </tr>
1238         <tr>
1239           <td class="paramkey"></td>
1240           <td></td>
1241           <td class="paramtype">uint8_t&#160;</td>
1242           <td class="paramname"><em>hub_addr</em>, </td>
1243         </tr>
1244         <tr>
1245           <td class="paramkey"></td>
1246           <td></td>
1247           <td class="paramtype">uint8_t&#160;</td>
1248           <td class="paramname"><em>hub_port</em>, </td>
1249         </tr>
1250         <tr>
1251           <td class="paramkey"></td>
1252           <td></td>
1253           <td class="paramtype">uint16_t&#160;</td>
1254           <td class="paramname"><em>ep_max_packet_size</em>&#160;</td>
1255         </tr>
1256         <tr>
1257           <td></td>
1258           <td>)</td>
1259           <td></td><td></td>
1260         </tr>
1261       </table>
1262 </div><div class="memdoc">
1263
1264 <p>Modify Pipe in System. </p>
1265 <dl class="params"><dt>Parameters</dt><dd>
1266   <table class="params">
1267     <tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
1268     <tr><td class="paramdir">[in]</td><td class="paramname">dev_addr</td><td>Device Address </td></tr>
1269     <tr><td class="paramdir">[in]</td><td class="paramname">dev_speed</td><td>Device Speed </td></tr>
1270     <tr><td class="paramdir">[in]</td><td class="paramname">hub_addr</td><td>Hub Address </td></tr>
1271     <tr><td class="paramdir">[in]</td><td class="paramname">hub_port</td><td>Hub Port </td></tr>
1272     <tr><td class="paramdir">[in]</td><td class="paramname">ep_max_packet_size</td><td>Endpoint Maximum Packet Size </td></tr>
1273   </table>
1274   </dd>
1275 </dl>
1276 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1277 <p>The function <b>ARM_USBH_PipeModify</b> modifies a pipe configuration that was created with <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a>. </p>
1278
1279 </div>
1280 </div>
1281 <a id="gab2135041e6d481f186015f36fa0d0521" name="gab2135041e6d481f186015f36fa0d0521"></a>
1282 <h2 class="memtitle"><span class="permalink"><a href="#gab2135041e6d481f186015f36fa0d0521">&#9670;&#160;</a></span>ARM_USBH_PipeDelete()</h2>
1283
1284 <div class="memitem">
1285 <div class="memproto">
1286       <table class="memname">
1287         <tr>
1288           <td class="memname">int32_t ARM_USBH_PipeDelete </td>
1289           <td>(</td>
1290           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td>
1291           <td class="paramname"><em>pipe_hndl</em></td><td>)</td>
1292           <td></td>
1293         </tr>
1294       </table>
1295 </div><div class="memdoc">
1296
1297 <p>Delete Pipe from System. </p>
1298 <dl class="params"><dt>Parameters</dt><dd>
1299   <table class="params">
1300     <tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
1301   </table>
1302   </dd>
1303 </dl>
1304 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1305 <p>The function <b>ARM_USBH_PipeDelete</b> deletes a pipe that was created with <a class="el" href="group__usbh__host__gr.html#ga30dcc05151a98c5a8f6fe17e83777fe0">ARM_USBH_PipeCreate</a> (deactivates the pipe and releases used resources). </p>
1306
1307 </div>
1308 </div>
1309 <a id="ga7f5a605dbe98e450e6965d515fde65a7" name="ga7f5a605dbe98e450e6965d515fde65a7"></a>
1310 <h2 class="memtitle"><span class="permalink"><a href="#ga7f5a605dbe98e450e6965d515fde65a7">&#9670;&#160;</a></span>ARM_USBH_PipeReset()</h2>
1311
1312 <div class="memitem">
1313 <div class="memproto">
1314       <table class="memname">
1315         <tr>
1316           <td class="memname">int32_t ARM_USBH_PipeReset </td>
1317           <td>(</td>
1318           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td>
1319           <td class="paramname"><em>pipe_hndl</em></td><td>)</td>
1320           <td></td>
1321         </tr>
1322       </table>
1323 </div><div class="memdoc">
1324
1325 <p>Reset Pipe. </p>
1326 <dl class="params"><dt>Parameters</dt><dd>
1327   <table class="params">
1328     <tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
1329   </table>
1330   </dd>
1331 </dl>
1332 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1333 <p>The function <b>ARM_USBH_PipeReset</b> clears Halt condition and resets data toggle on the specified pipe. </p>
1334
1335 </div>
1336 </div>
1337 <a id="ga817d503a24ad8927fa362c8f6394920d" name="ga817d503a24ad8927fa362c8f6394920d"></a>
1338 <h2 class="memtitle"><span class="permalink"><a href="#ga817d503a24ad8927fa362c8f6394920d">&#9670;&#160;</a></span>ARM_USBH_PipeTransfer()</h2>
1339
1340 <div class="memitem">
1341 <div class="memproto">
1342       <table class="memname">
1343         <tr>
1344           <td class="memname">int32_t ARM_USBH_PipeTransfer </td>
1345           <td>(</td>
1346           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td>
1347           <td class="paramname"><em>pipe_hndl</em>, </td>
1348         </tr>
1349         <tr>
1350           <td class="paramkey"></td>
1351           <td></td>
1352           <td class="paramtype">uint32_t&#160;</td>
1353           <td class="paramname"><em>packet</em>, </td>
1354         </tr>
1355         <tr>
1356           <td class="paramkey"></td>
1357           <td></td>
1358           <td class="paramtype">uint8_t *&#160;</td>
1359           <td class="paramname"><em>data</em>, </td>
1360         </tr>
1361         <tr>
1362           <td class="paramkey"></td>
1363           <td></td>
1364           <td class="paramtype">uint32_t&#160;</td>
1365           <td class="paramname"><em>num</em>&#160;</td>
1366         </tr>
1367         <tr>
1368           <td></td>
1369           <td>)</td>
1370           <td></td><td></td>
1371         </tr>
1372       </table>
1373 </div><div class="memdoc">
1374
1375 <p>Transfer packets through USB Pipe. </p>
1376 <dl class="params"><dt>Parameters</dt><dd>
1377   <table class="params">
1378     <tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
1379     <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>Packet information </td></tr>
1380     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to buffer with data to send or for data to receive </td></tr>
1381     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Number of data bytes to transfer </td></tr>
1382   </table>
1383   </dd>
1384 </dl>
1385 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1386 <p>The function <b>ARM_USBH_PipeTransfer</b> generates packets for sending or receiving data from an USB Endpoint.</p>
1387 <p>The function specifies the buffer with data to send or for data to receive and the number of bytes to transfer (must be multiple of device endpoint maximum packet size for receive). It also specifies <a class="el" href="group__USBH__packets.html">USBH Packet Information</a> with parameter <em>packet</em>.</p>
1388 <p>The function is non-blocking and returns as soon as the driver starts the operation on the specified pipe. During the operation it is not allowed to call this function again on the same pipe. Also the data buffer must stay allocated and the contents of data must not be modified.</p>
1389 <p>Operation is completed when the the requested number of data bytes have been transferred and is indicated with <a class="el" href="group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">ARM_USBH_EVENT_TRANSFER_COMPLETE</a> event. It can also finish earlier on reception of different handshake tokens which are also indicated through <a class="el" href="group__USBH__pipe__events.html">USBH Pipe Events</a>.</p>
1390 <p>Transfer operation can be aborted by calling <a class="el" href="group__usbh__host__gr.html#ga1d4048a076aed71e585cea96a21f0afb">ARM_USBH_PipeTransferAbort</a>. </p>
1391
1392 </div>
1393 </div>
1394 <a id="ga85baa421345a5b92881ad190d72ca47f" name="ga85baa421345a5b92881ad190d72ca47f"></a>
1395 <h2 class="memtitle"><span class="permalink"><a href="#ga85baa421345a5b92881ad190d72ca47f">&#9670;&#160;</a></span>ARM_USBH_PipeTransferGetResult()</h2>
1396
1397 <div class="memitem">
1398 <div class="memproto">
1399       <table class="memname">
1400         <tr>
1401           <td class="memname">uint32_t ARM_USBH_PipeTransferGetResult </td>
1402           <td>(</td>
1403           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td>
1404           <td class="paramname"><em>pipe_hndl</em></td><td>)</td>
1405           <td></td>
1406         </tr>
1407       </table>
1408 </div><div class="memdoc">
1409
1410 <p>Get result of USB Pipe transfer. </p>
1411 <dl class="params"><dt>Parameters</dt><dd>
1412   <table class="params">
1413     <tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
1414   </table>
1415   </dd>
1416 </dl>
1417 <dl class="section return"><dt>Returns</dt><dd>number of successfully transferred data bytes</dd></dl>
1418 <p><br  />
1419  The function <b>ARM_USBH_PipeTransferGetResult</b> returns the number of successfully transferred data bytes started by <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a> operation. </p>
1420
1421 </div>
1422 </div>
1423 <a id="ga1d4048a076aed71e585cea96a21f0afb" name="ga1d4048a076aed71e585cea96a21f0afb"></a>
1424 <h2 class="memtitle"><span class="permalink"><a href="#ga1d4048a076aed71e585cea96a21f0afb">&#9670;&#160;</a></span>ARM_USBH_PipeTransferAbort()</h2>
1425
1426 <div class="memitem">
1427 <div class="memproto">
1428       <table class="memname">
1429         <tr>
1430           <td class="memname">int32_t ARM_USBH_PipeTransferAbort </td>
1431           <td>(</td>
1432           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td>
1433           <td class="paramname"><em>pipe_hndl</em></td><td>)</td>
1434           <td></td>
1435         </tr>
1436       </table>
1437 </div><div class="memdoc">
1438
1439 <p>Abort current USB Pipe transfer. </p>
1440 <dl class="params"><dt>Parameters</dt><dd>
1441   <table class="params">
1442     <tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
1443   </table>
1444   </dd>
1445 </dl>
1446 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
1447 <p>The function <b>ARM_USBH_PipeTransferAbort</b> aborts an active pipe transfer started by <a class="el" href="group__usbh__host__gr.html#ga817d503a24ad8927fa362c8f6394920d">ARM_USBH_PipeTransfer</a>. </p>
1448
1449 </div>
1450 </div>
1451 <a id="ga9dc305fc234c9987b9efd679b5042cc9" name="ga9dc305fc234c9987b9efd679b5042cc9"></a>
1452 <h2 class="memtitle"><span class="permalink"><a href="#ga9dc305fc234c9987b9efd679b5042cc9">&#9670;&#160;</a></span>ARM_USBH_GetFrameNumber()</h2>
1453
1454 <div class="memitem">
1455 <div class="memproto">
1456       <table class="memname">
1457         <tr>
1458           <td class="memname">uint16_t ARM_USBH_GetFrameNumber </td>
1459           <td>(</td>
1460           <td class="paramtype">void&#160;</td>
1461           <td class="paramname"></td><td>)</td>
1462           <td></td>
1463         </tr>
1464       </table>
1465 </div><div class="memdoc">
1466
1467 <p>Get current USB Frame Number. </p>
1468 <dl class="section return"><dt>Returns</dt><dd>Frame Number</dd></dl>
1469 <p>The function <b>ARM_USBH_GetFrameNumber</b> returns the sequential 11-bit frame number of the last Start of Frame (SOF) packet. </p>
1470
1471 </div>
1472 </div>
1473 <a id="ga53619da2a3d56934629084b0d5c4700c" name="ga53619da2a3d56934629084b0d5c4700c"></a>
1474 <h2 class="memtitle"><span class="permalink"><a href="#ga53619da2a3d56934629084b0d5c4700c">&#9670;&#160;</a></span>ARM_USBH_SignalPortEvent()</h2>
1475
1476 <div class="memitem">
1477 <div class="memproto">
1478       <table class="memname">
1479         <tr>
1480           <td class="memname">void ARM_USBH_SignalPortEvent </td>
1481           <td>(</td>
1482           <td class="paramtype">uint8_t&#160;</td>
1483           <td class="paramname"><em>port</em>, </td>
1484         </tr>
1485         <tr>
1486           <td class="paramkey"></td>
1487           <td></td>
1488           <td class="paramtype">uint32_t&#160;</td>
1489           <td class="paramname"><em>event</em>&#160;</td>
1490         </tr>
1491         <tr>
1492           <td></td>
1493           <td>)</td>
1494           <td></td><td></td>
1495         </tr>
1496       </table>
1497 </div><div class="memdoc">
1498
1499 <p>Signal Root HUB Port Event. </p>
1500 <dl class="params"><dt>Parameters</dt><dd>
1501   <table class="params">
1502     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
1503     <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__USBH__port__events.html">USBH Port Events</a></td></tr>
1504   </table>
1505   </dd>
1506 </dl>
1507 <p>The function <b>ARM_USBH_SignalPortEvent</b> is a callback function registered by the function <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a>.</p>
1508 <p>The parameter <em>port</em> specifies the root hub port number. <br  />
1509 The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
1510 <p>Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the data fields of the structure <a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES">ARM_USBH_CAPABILITIES</a>, which can be retrieved with the function <a class="el" href="group__usbh__host__gr.html#gadb509db50fdccfc7198dfd7ac54530d7">ARM_USBH_GetCapabilities</a>.</p>
1511 <p>The following events can be generated:</p>
1512 <table class="markdownTable">
1513 <tr class="markdownTableHead">
1514 <th class="markdownTableHeadLeft">Parameter <em>event</em>   </th><th class="markdownTableHeadCenter">Bit   </th><th class="markdownTableHeadLeft">Description   </th><th class="markdownTableHeadNone">supported when <a class="el" href="group__usbh__host__gr.html#structARM__USBH__CAPABILITIES" title="USB Host Driver Capabilities.">ARM_USBH_CAPABILITIES</a>    </th></tr>
1515 <tr class="markdownTableRowOdd">
1516 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__port__events.html#ga71bfd8b8cd41b8aa6303d5d3a91597e6">ARM_USBH_EVENT_CONNECT</a>   </td><td class="markdownTableBodyCenter">0   </td><td class="markdownTableBodyLeft">Occurs when USB Device connects to the Host.   </td><td class="markdownTableBodyNone">data field <em>event_connect=</em> <span class="XML-Token">1</span>    </td></tr>
1517 <tr class="markdownTableRowEven">
1518 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__port__events.html#gaba67919f64e9a08ba1264363b2710d20">ARM_USBH_EVENT_DISCONNECT</a>   </td><td class="markdownTableBodyCenter">1   </td><td class="markdownTableBodyLeft">Occurs when USB Device disconnects from the Host.   </td><td class="markdownTableBodyNone">data field <em>event_disconnect=</em> <span class="XML-Token">1</span>    </td></tr>
1519 <tr class="markdownTableRowOdd">
1520 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__port__events.html#ga0955fdc2aedd2c5aa2be6cd782b3f2a8">ARM_USBH_EVENT_OVERCURRENT</a>   </td><td class="markdownTableBodyCenter">2   </td><td class="markdownTableBodyLeft">Occurs when USB Overcurrent it detected.   </td><td class="markdownTableBodyNone">data field <em>event_overcurrent=</em> <span class="XML-Token">1</span>    </td></tr>
1521 <tr class="markdownTableRowEven">
1522 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__port__events.html#ga70ae1e0a7872556d302a7f7840843c4a">ARM_USBH_EVENT_RESET</a>   </td><td class="markdownTableBodyCenter">3   </td><td class="markdownTableBodyLeft">Occurs when USB Reset is completed after calling <a class="el" href="group__usbh__host__gr.html#gab99882e11ee03018da9ebe33797cc5ff">ARM_USBH_PortReset</a>.   </td><td class="markdownTableBodyNone"><em>always supported</em>    </td></tr>
1523 <tr class="markdownTableRowOdd">
1524 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__port__events.html#gae1f91db7d31bcebbf60a23fb04cf7eb5">ARM_USBH_EVENT_SUSPEND</a>   </td><td class="markdownTableBodyCenter">4   </td><td class="markdownTableBodyLeft">Occurs when USB Suspend is detected.   </td><td class="markdownTableBodyNone"><em>always supported</em>    </td></tr>
1525 <tr class="markdownTableRowEven">
1526 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__port__events.html#ga42f62bdf6dd639f9f3dffc6c127456e3">ARM_USBH_EVENT_RESUME</a>   </td><td class="markdownTableBodyCenter">5   </td><td class="markdownTableBodyLeft">Occurs when USB Resume is detected.   </td><td class="markdownTableBodyNone"><em>always supported</em>    </td></tr>
1527 <tr class="markdownTableRowOdd">
1528 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__port__events.html#ga2b61e9df3c63fd78fc08f79280a7066e">ARM_USBH_EVENT_REMOTE_WAKEUP</a>   </td><td class="markdownTableBodyCenter">6   </td><td class="markdownTableBodyLeft">Occurs when USB Remote wakeup is detected.   </td><td class="markdownTableBodyNone"><em>always supported</em>   </td></tr>
1529 </table>
1530
1531 </div>
1532 </div>
1533 <a id="gae58d36afd83a0e32b07e89fb7145c9de" name="gae58d36afd83a0e32b07e89fb7145c9de"></a>
1534 <h2 class="memtitle"><span class="permalink"><a href="#gae58d36afd83a0e32b07e89fb7145c9de">&#9670;&#160;</a></span>ARM_USBH_SignalPipeEvent()</h2>
1535
1536 <div class="memitem">
1537 <div class="memproto">
1538       <table class="memname">
1539         <tr>
1540           <td class="memname">void ARM_USBH_SignalPipeEvent </td>
1541           <td>(</td>
1542           <td class="paramtype"><a class="el" href="group__usbh__host__gr.html#ga2e4d0ebd0851ba7bf364ae1d8948672c">ARM_USBH_PIPE_HANDLE</a>&#160;</td>
1543           <td class="paramname"><em>pipe_hndl</em>, </td>
1544         </tr>
1545         <tr>
1546           <td class="paramkey"></td>
1547           <td></td>
1548           <td class="paramtype">uint32_t&#160;</td>
1549           <td class="paramname"><em>event</em>&#160;</td>
1550         </tr>
1551         <tr>
1552           <td></td>
1553           <td>)</td>
1554           <td></td><td></td>
1555         </tr>
1556       </table>
1557 </div><div class="memdoc">
1558
1559 <p>Signal Pipe Event. </p>
1560 <dl class="params"><dt>Parameters</dt><dd>
1561   <table class="params">
1562     <tr><td class="paramdir">[in]</td><td class="paramname">pipe_hndl</td><td>Pipe Handle </td></tr>
1563     <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__USBH__pipe__events.html">USBH Pipe Events</a></td></tr>
1564   </table>
1565   </dd>
1566 </dl>
1567 <p>The function <b>ARM_USBH_SignalPipeEvent</b> is a callback function registered by the function <a class="el" href="group__usbh__host__gr.html#gad1e73f778c95dd46d4396e7741a97f0b">ARM_USBH_Initialize</a>.</p>
1568 <p>The parameter <em>pipe_hndl</em> specifies the pipe handle. <br  />
1569 The parameter <em>event</em> indicates one or more events that occurred during driver operation. Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.</p>
1570 <p>The following events can be generated:</p>
1571 <table class="markdownTable">
1572 <tr class="markdownTableHead">
1573 <th class="markdownTableHeadLeft">Parameter <em>event</em>   </th><th class="markdownTableHeadRight">Bit   </th><th class="markdownTableHeadLeft">Description    </th></tr>
1574 <tr class="markdownTableRowOdd">
1575 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">ARM_USBH_EVENT_TRANSFER_COMPLETE</a>   </td><td class="markdownTableBodyRight">0   </td><td class="markdownTableBodyLeft">Occurs after all the data has been transferred without errors.    </td></tr>
1576 <tr class="markdownTableRowEven">
1577 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__pipe__events.html#ga3895b82193855d9a6f0b7e8a9b65e2c0">ARM_USBH_EVENT_HANDSHAKE_NAK</a>   </td><td class="markdownTableBodyRight">1   </td><td class="markdownTableBodyLeft">Occurs when NAK Handshake is received before all the data is transferred.    </td></tr>
1578 <tr class="markdownTableRowOdd">
1579 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__pipe__events.html#ga62ae214576c923ce737a16098e9836e5">ARM_USBH_EVENT_HANDSHAKE_NYET</a>   </td><td class="markdownTableBodyRight">2   </td><td class="markdownTableBodyLeft">Occurs when NYET Handshake is received before all the data is transferred.    </td></tr>
1580 <tr class="markdownTableRowEven">
1581 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__pipe__events.html#ga681ce0983f8c77c41f3cc5df1af8d010">ARM_USBH_EVENT_HANDSHAKE_MDATA</a>   </td><td class="markdownTableBodyRight">3   </td><td class="markdownTableBodyLeft">Occurs when MDATA Handshake is received before all the data is transferred.    </td></tr>
1582 <tr class="markdownTableRowOdd">
1583 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__pipe__events.html#ga4fdc44fc78f342576dd11ad7cb84b4b8">ARM_USBH_EVENT_HANDSHAKE_STALL</a>   </td><td class="markdownTableBodyRight">4   </td><td class="markdownTableBodyLeft">Occurs when STALL Handshake is received before all the data is transferred.    </td></tr>
1584 <tr class="markdownTableRowEven">
1585 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__pipe__events.html#gac7cc573f879fbab678dc7d1347c68614">ARM_USBH_EVENT_HANDSHAKE_ERR</a>   </td><td class="markdownTableBodyRight">5   </td><td class="markdownTableBodyLeft">Occurs when ERR Handshake is received before all the data is transferred.    </td></tr>
1586 <tr class="markdownTableRowOdd">
1587 <td class="markdownTableBodyLeft"><a class="el" href="group__USBH__pipe__events.html#ga7bd871b1e5c059bee398c32429370724">ARM_USBH_EVENT_BUS_ERROR</a>   </td><td class="markdownTableBodyRight">6   </td><td class="markdownTableBodyLeft">Occurs when bus error is detected before all the data is transferred.   </td></tr>
1588 </table>
1589 <p><b>See also:</b></p><ul>
1590 <li>ARM_USBH_PipeCreate </li>
1591 </ul>
1592
1593 </div>
1594 </div>
1595 </div><!-- contents -->
1596 </div><!-- doc-content -->
1597 <!-- start footer part -->
1598 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1599   <ul>
1600     <li class="footer">
1601       <script type="text/javascript">
1602         <!--
1603         writeFooter.call(this);
1604         //-->
1605       </script>
1606     </li>
1607   </ul>
1608 </div>
1609 </body>
1610 </html>