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