begriffs open source - cmsis/blob - main/Driver/group__usbh__hci__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 OHCI/EHCI</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__hci__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="#nested-classes">Data Structures</a> &#124;
 129 <a href="#typedef-members">Typedefs</a> &#124;
 130 <a href="#func-members">Functions</a>  </div>
 131   <div class="headertitle"><div class="title">USB OHCI/EHCI<div class="ingroups"><a class="el" href="group__usb__interface__gr.html">USB Interface</a> &raquo; <a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a></div></div></div>
 132 </div><!--header-->
 133 <div class="contents">
 134
 135 <p>Driver API for USB OHCI/EHCI.
 136 <a href="#details">More...</a></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 139 Data Structures</h2></td></tr>
 140 <tr class="memitem:structARM__DRIVER__USBH__HCI"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a></td></tr>
 141 <tr class="memdesc:structARM__DRIVER__USBH__HCI"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access structure of USB Host HCI (OHCI/EHCI) Driver.  <a href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">More...</a><br /></td></tr>
 142 <tr class="separator:structARM__DRIVER__USBH__HCI"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:structARM__USBH__HCI__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a></td></tr>
 144 <tr class="memdesc:structARM__USBH__HCI__CAPABILITIES"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Host HCI (OHCI/EHCI) Driver Capabilities.  <a href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">More...</a><br /></td></tr>
 145 <tr class="separator:structARM__USBH__HCI__CAPABILITIES"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 </table><table class="memberdecls">
 147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 148 Typedefs</h2></td></tr>
 149 <tr class="memitem:gac60df9d1f2b3a769f2c30141800a9806"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a>) (void)</td></tr>
 150 <tr class="memdesc:gac60df9d1f2b3a769f2c30141800a9806"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to Interrupt Handler Routine.  <br /></td></tr>
 151 <tr class="separator:gac60df9d1f2b3a769f2c30141800a9806"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 </table><table class="memberdecls">
 153 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 154 Functions</h2></td></tr>
 155 <tr class="memitem:ga10109d0c2a9a128225b5e893d3f72d08"><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__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08">ARM_USBH_HCI_GetVersion</a> (void)</td></tr>
 156 <tr class="memdesc:ga10109d0c2a9a128225b5e893d3f72d08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get USB Host HCI (OHCI/EHCI) driver version.  <br /></td></tr>
 157 <tr class="separator:ga10109d0c2a9a128225b5e893d3f72d08"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:gae607c49ca97202500631473a901e8c2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a> (void)</td></tr>
 159 <tr class="memdesc:gae607c49ca97202500631473a901e8c2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get driver capabilities.  <br /></td></tr>
 160 <tr class="separator:gae607c49ca97202500631473a901e8c2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:gabc1392a544cb64491b5ea5ce6590d832"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> (<a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> *cb_interrupt)</td></tr>
 162 <tr class="memdesc:gabc1392a544cb64491b5ea5ce6590d832"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize USB Host HCI (OHCI/EHCI) Interface.  <br /></td></tr>
 163 <tr class="separator:gabc1392a544cb64491b5ea5ce6590d832"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:gaacb68fdf201cdb1846b31642a760f041"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> (void)</td></tr>
 165 <tr class="memdesc:gaacb68fdf201cdb1846b31642a760f041"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initialize USB Host HCI (OHCI/EHCI) Interface.  <br /></td></tr>
 166 <tr class="separator:gaacb68fdf201cdb1846b31642a760f041"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:ga27fa5ec8854cd9877bbef4abffe9a12b"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">ARM_USBH_HCI_PowerControl</a> (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 168 <tr class="memdesc:ga27fa5ec8854cd9877bbef4abffe9a12b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control USB Host HCI (OHCI/EHCI) Interface Power.  <br /></td></tr>
 169 <tr class="separator:ga27fa5ec8854cd9877bbef4abffe9a12b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:gade1e83403c6ea965fe3e6c4c21fbbded"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">ARM_USBH_HCI_PortVbusOnOff</a> (uint8_t port, bool vbus)</td></tr>
 171 <tr class="memdesc:gade1e83403c6ea965fe3e6c4c21fbbded"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off.  <br /></td></tr>
 172 <tr class="separator:gade1e83403c6ea965fe3e6c4c21fbbded"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:ga79d3c2509ed869c8d7d1485acad7b6c6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6">ARM_USBH_HCI_Interrupt</a> (void)</td></tr>
 174 <tr class="memdesc:ga79d3c2509ed869c8d7d1485acad7b6c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB Host HCI Interrupt Handler.  <br /></td></tr>
 175 <tr class="separator:ga79d3c2509ed869c8d7d1485acad7b6c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 </table>
 177 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 178 <p>Driver API for USB OHCI/EHCI. </p>
 179 <p>OHCI and EHCI compliant interfaces have memory mapped registers that are used to control the USB host.</p>
 180 <p>Only certain functionalities (interrupts, VBUS control, power control) require device specific interface which is provided through functions of the struct <a class="el" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a> (functionality accessed with the struct <a class="el" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> is not needed). </p>
 181 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 182 <a name="structARM__DRIVER__USBH__HCI" id="structARM__DRIVER__USBH__HCI"></a>
 183 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__USBH__HCI">&#9670;&#160;</a></span>ARM_DRIVER_USBH_HCI</h2>
 184
 185 <div class="memitem">
 186 <div class="memproto">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname">struct ARM_DRIVER_USBH_HCI</td>
 190         </tr>
 191       </table>
 192 </div><div class="memdoc">
 193 <div class="textblock"><p>Access structure of USB Host HCI (OHCI/EHCI) Driver. </p>
 194 <p>The functions of the USB Host HCI (OHCI/EHCI) driver are accessed by function pointers. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
 195 <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>
 196 <li><b>Driver_USBH0_HCI</b> is the name of the access struct of the first instance (no. 0).</li>
 197 <li><b>Driver_USBH1_HCI</b> is the name of the access struct of the second instance (no. 1).</li>
 198 </ul>
 199 <p>A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_USBH<em>n</em>_HCI</b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver.</p>
 200 <dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
 201 </div><table class="memberdecls">
 202 <tr><td colspan="2"><h3>Data Fields</h3></td></tr>
 203 <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__hci__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> )(void)</td></tr>
 204 <tr class="memdesc:a30afd9cb3113c037b5f1926f5ef93b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08">ARM_USBH_HCI_GetVersion</a> : Get USB Host HCI (OHCI/EHCI) driver version.  <br /></td></tr>
 205 <tr class="separator:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 206 <tr class="memitem:aa54b667c830cc3ef9e710382a65e0baa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#aa54b667c830cc3ef9e710382a65e0baa">GetCapabilities</a> )(void)</td></tr>
 207 <tr class="memdesc:aa54b667c830cc3ef9e710382a65e0baa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a> : Get driver capabilities.  <br /></td></tr>
 208 <tr class="separator:aa54b667c830cc3ef9e710382a65e0baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 209 <tr class="memitem:ade38d7e63bf159f928b6f68be9cc09dd"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__hci__gr.html#ade38d7e63bf159f928b6f68be9cc09dd">Initialize</a> )(<a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> cb_interrupt)</td></tr>
 210 <tr class="memdesc:ade38d7e63bf159f928b6f68be9cc09dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> : Initialize USB Host HCI (OHCI/EHCI) Interface.  <br /></td></tr>
 211 <tr class="separator:ade38d7e63bf159f928b6f68be9cc09dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 212 <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__hci__gr.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> )(void)</td></tr>
 213 <tr class="memdesc:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> : De-initialize USB Host HCI (OHCI/EHCI) Interface.  <br /></td></tr>
 214 <tr class="separator:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 215 <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__hci__gr.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 216 <tr class="memdesc:a24ebae5c6011631f76027f9a16eaf5ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">ARM_USBH_HCI_PowerControl</a> : Control USB Host HCI (OHCI/EHCI) Interface Power.  <br /></td></tr>
 217 <tr class="separator:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 218 <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__hci__gr.html#af876f976d36d73d4b76063a4ed217ee8">PortVbusOnOff</a> )(uint8_t port, bool vbus)</td></tr>
 219 <tr class="memdesc:af876f976d36d73d4b76063a4ed217ee8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">ARM_USBH_HCI_PortVbusOnOff</a> : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off.  <br /></td></tr>
 220 <tr class="separator:af876f976d36d73d4b76063a4ed217ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 221 </table>
 222 <h4 class="groupheader">Field Documentation</h4>
 223 <a id="a30afd9cb3113c037b5f1926f5ef93b59" name="a30afd9cb3113c037b5f1926f5ef93b59"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#a30afd9cb3113c037b5f1926f5ef93b59">&#9670;&#160;</a></span>GetVersion</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion) (void)</td>
 231         </tr>
 232       </table>
 233 </div><div class="memdoc">
 234
 235 <p>Pointer to <a class="el" href="group__usbh__hci__gr.html#ga10109d0c2a9a128225b5e893d3f72d08">ARM_USBH_HCI_GetVersion</a> : Get USB Host HCI (OHCI/EHCI) driver version. </p>
 236
 237 </div>
 238 </div>
 239 <a id="aa54b667c830cc3ef9e710382a65e0baa" name="aa54b667c830cc3ef9e710382a65e0baa"></a>
 240 <h2 class="memtitle"><span class="permalink"><a href="#aa54b667c830cc3ef9e710382a65e0baa">&#9670;&#160;</a></span>GetCapabilities</h2>
 241
 242 <div class="memitem">
 243 <div class="memproto">
 244       <table class="memname">
 245         <tr>
 246           <td class="memname"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a>(* GetCapabilities) (void)</td>
 247         </tr>
 248       </table>
 249 </div><div class="memdoc">
 250
 251 <p>Pointer to <a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a> : Get driver capabilities. </p>
 252
 253 </div>
 254 </div>
 255 <a id="ade38d7e63bf159f928b6f68be9cc09dd" name="ade38d7e63bf159f928b6f68be9cc09dd"></a>
 256 <h2 class="memtitle"><span class="permalink"><a href="#ade38d7e63bf159f928b6f68be9cc09dd">&#9670;&#160;</a></span>Initialize</h2>
 257
 258 <div class="memitem">
 259 <div class="memproto">
 260       <table class="memname">
 261         <tr>
 262           <td class="memname">int32_t(* Initialize) (<a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> cb_interrupt)</td>
 263         </tr>
 264       </table>
 265 </div><div class="memdoc">
 266
 267 <p>Pointer to <a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> : Initialize USB Host HCI (OHCI/EHCI) Interface. </p>
 268
 269 </div>
 270 </div>
 271 <a id="a5ce2b3d7a3a07099bf07d1eb253e92e3" name="a5ce2b3d7a3a07099bf07d1eb253e92e3"></a>
 272 <h2 class="memtitle"><span class="permalink"><a href="#a5ce2b3d7a3a07099bf07d1eb253e92e3">&#9670;&#160;</a></span>Uninitialize</h2>
 273
 274 <div class="memitem">
 275 <div class="memproto">
 276       <table class="memname">
 277         <tr>
 278           <td class="memname">int32_t(* Uninitialize) (void)</td>
 279         </tr>
 280       </table>
 281 </div><div class="memdoc">
 282
 283 <p>Pointer to <a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> : De-initialize USB Host HCI (OHCI/EHCI) Interface. </p>
 284
 285 </div>
 286 </div>
 287 <a id="a24ebae5c6011631f76027f9a16eaf5ce" name="a24ebae5c6011631f76027f9a16eaf5ce"></a>
 288 <h2 class="memtitle"><span class="permalink"><a href="#a24ebae5c6011631f76027f9a16eaf5ce">&#9670;&#160;</a></span>PowerControl</h2>
 289
 290 <div class="memitem">
 291 <div class="memproto">
 292       <table class="memname">
 293         <tr>
 294           <td class="memname">int32_t(* PowerControl) (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
 295         </tr>
 296       </table>
 297 </div><div class="memdoc">
 298
 299 <p>Pointer to <a class="el" href="group__usbh__hci__gr.html#ga27fa5ec8854cd9877bbef4abffe9a12b">ARM_USBH_HCI_PowerControl</a> : Control USB Host HCI (OHCI/EHCI) Interface Power. </p>
 300
 301 </div>
 302 </div>
 303 <a id="af876f976d36d73d4b76063a4ed217ee8" name="af876f976d36d73d4b76063a4ed217ee8"></a>
 304 <h2 class="memtitle"><span class="permalink"><a href="#af876f976d36d73d4b76063a4ed217ee8">&#9670;&#160;</a></span>PortVbusOnOff</h2>
 305
 306 <div class="memitem">
 307 <div class="memproto">
 308       <table class="memname">
 309         <tr>
 310           <td class="memname">int32_t(* PortVbusOnOff) (uint8_t port, bool vbus)</td>
 311         </tr>
 312       </table>
 313 </div><div class="memdoc">
 314
 315 <p>Pointer to <a class="el" href="group__usbh__hci__gr.html#gade1e83403c6ea965fe3e6c4c21fbbded">ARM_USBH_HCI_PortVbusOnOff</a> : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off. </p>
 316
 317 </div>
 318 </div>
 319
 320 </div>
 321 </div>
 322 <a name="structARM__USBH__HCI__CAPABILITIES" id="structARM__USBH__HCI__CAPABILITIES"></a>
 323 <h2 class="memtitle"><span class="permalink"><a href="#structARM__USBH__HCI__CAPABILITIES">&#9670;&#160;</a></span>ARM_USBH_HCI_CAPABILITIES</h2>
 324
 325 <div class="memitem">
 326 <div class="memproto">
 327       <table class="memname">
 328         <tr>
 329           <td class="memname">struct ARM_USBH_HCI_CAPABILITIES</td>
 330         </tr>
 331       </table>
 332 </div><div class="memdoc">
 333 <div class="textblock"><p>USB Host HCI (OHCI/EHCI) Driver Capabilities. </p>
 334 <p>A USB Host HCI (OHCI/EHCI) driver can be implemented with different capabilities. The data fields of this structure encode the capabilities implemented by this driver.</p>
 335 <p><b>Returned by:</b></p><ul>
 336 <li><a class="el" href="group__usbh__hci__gr.html#gae607c49ca97202500631473a901e8c2b">ARM_USBH_HCI_GetCapabilities</a></li>
 337 </ul>
 338 <dl class="section note"><dt>Note</dt><dd>The struct must remain unchanged. </dd></dl>
 339 </div><table class="fieldtable">
 340 <tr><th colspan="3">Data Fields</th></tr>
 341 <tr><td class="fieldtype">
 342 <a id="ac37c09b54483c2a1e41fa8a976721fc4" name="ac37c09b54483c2a1e41fa8a976721fc4"></a>uint32_t</td>
 343 <td class="fieldname">
 344 port_mask: 15</td>
 345 <td class="fielddoc">
 346 Root HUB available Ports Mask. </td></tr>
 347 <tr><td class="fieldtype">
 348 <a id="aa43c4c21b173ada1b6b7568956f0d650" name="aa43c4c21b173ada1b6b7568956f0d650"></a>uint32_t</td>
 349 <td class="fieldname">
 350 reserved: 17</td>
 351 <td class="fielddoc">
 352 Reserved (must be zero) </td></tr>
 353 </table>
 354
 355 </div>
 356 </div>
 357 <h2 class="groupheader">Typedef Documentation</h2>
 358 <a id="gac60df9d1f2b3a769f2c30141800a9806" name="gac60df9d1f2b3a769f2c30141800a9806"></a>
 359 <h2 class="memtitle"><span class="permalink"><a href="#gac60df9d1f2b3a769f2c30141800a9806">&#9670;&#160;</a></span>ARM_USBH_HCI_Interrupt_t</h2>
 360
 361 <div class="memitem">
 362 <div class="memproto">
 363       <table class="memname">
 364         <tr>
 365           <td class="memname">ARM_USBH_HCI_Interrupt_t</td>
 366         </tr>
 367       </table>
 368 </div><div class="memdoc">
 369
 370 <p>Pointer to Interrupt Handler Routine. </p>
 371 <p>Provides the typedef for the interrupt handler <a class="el" href="group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6">ARM_USBH_HCI_Interrupt</a>.</p>
 372 <p><b>Parameter for:</b></p><ul>
 373 <li><a class="el" href="group__usbh__hci__gr.html#gabc1392a544cb64491b5ea5ce6590d832">ARM_USBH_HCI_Initialize</a> </li>
 374 </ul>
 375
 376 </div>
 377 </div>
 378 <h2 class="groupheader">Function Documentation</h2>
 379 <a id="ga10109d0c2a9a128225b5e893d3f72d08" name="ga10109d0c2a9a128225b5e893d3f72d08"></a>
 380 <h2 class="memtitle"><span class="permalink"><a href="#ga10109d0c2a9a128225b5e893d3f72d08">&#9670;&#160;</a></span>ARM_USBH_HCI_GetVersion()</h2>
 381
 382 <div class="memitem">
 383 <div class="memproto">
 384       <table class="memname">
 385         <tr>
 386           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a> ARM_USBH_HCI_GetVersion </td>
 387           <td>(</td>
 388           <td class="paramtype">void&#160;</td>
 389           <td class="paramname"></td><td>)</td>
 390           <td></td>
 391         </tr>
 392       </table>
 393 </div><div class="memdoc">
 394
 395 <p>Get USB Host HCI (OHCI/EHCI) driver version. </p>
 396 <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>
 397 <p>The function <b>ARM_USBH_HCI_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>
 398 <li>API version is the version of the CMSIS-Driver specification used to implement this driver.</li>
 399 <li>Driver version is source code version of the actual driver implementation.</li>
 400 </ul>
 401 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> Driver_USBH0_HCI;</div>
 402 <div class="line"><a class="code hl_struct" href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a> *drv_info;</div>
 403 <div class="line"> </div>
 404 <div class="line"><span class="keywordtype">void</span> setup_usbh (<span class="keywordtype">void</span>)  {</div>
 405 <div class="line">  <a class="code hl_struct" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>  version;</div>
 406 <div class="line"> </div>
 407 <div class="line">  drv_info = &amp;Driver_USBH0_HCI;  </div>
 408 <div class="line">  version = drv_info-&gt;<a class="code hl_variable" href="group__usbh__host__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> ();</div>
 409 <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>
 410 <div class="line">    <span class="comment">// error handling</span></div>
 411 <div class="line">    <span class="keywordflow">return</span>;</div>
 412 <div class="line">  }</div>
 413 <div class="line">}</div>
 414 <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>
 415 <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>
 416 <div class="ttc" id="agroup__usbh__host__gr_html_a30afd9cb3113c037b5f1926f5ef93b59"><div class="ttname"><a href="group__usbh__host__gr.html#a30afd9cb3113c037b5f1926f5ef93b59">ARM_DRIVER_USBH::GetVersion</a></div><div class="ttdeci">ARM_DRIVER_VERSION(* GetVersion)(void)</div><div class="ttdoc">Pointer to ARM_USBH_GetVersion : Get driver version.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:308</div></div>
 417 <div class="ttc" id="agroup__usbh__host__gr_html_structARM__DRIVER__USBH"><div class="ttname"><a href="group__usbh__host__gr.html#structARM__DRIVER__USBH">ARM_DRIVER_USBH</a></div><div class="ttdoc">Access structure of USB Host Driver.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:307</div></div>
 418 </div><!-- fragment -->
 419 </div>
 420 </div>
 421 <a id="gae607c49ca97202500631473a901e8c2b" name="gae607c49ca97202500631473a901e8c2b"></a>
 422 <h2 class="memtitle"><span class="permalink"><a href="#gae607c49ca97202500631473a901e8c2b">&#9670;&#160;</a></span>ARM_USBH_HCI_GetCapabilities()</h2>
 423
 424 <div class="memitem">
 425 <div class="memproto">
 426       <table class="memname">
 427         <tr>
 428           <td class="memname"><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a> ARM_USBH_HCI_GetCapabilities </td>
 429           <td>(</td>
 430           <td class="paramtype">void&#160;</td>
 431           <td class="paramname"></td><td>)</td>
 432           <td></td>
 433         </tr>
 434       </table>
 435 </div><div class="memdoc">
 436
 437 <p>Get driver capabilities. </p>
 438 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a></dd></dl>
 439 <p>The function <b>ARM_USBH_HCI_GetCapabilities</b> returns information about capabilities in this driver implementation. The data fields of the structure <a class="el" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a> encode various capabilities, for example available HUB ports.</p>
 440 <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a> Driver_USBH0_HCI;</div>
 441 <div class="line"><a class="code hl_struct" href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a> *drv_info;</div>
 442 <div class="line">  </div>
 443 <div class="line"><span class="keywordtype">void</span> read_capabilities (<span class="keywordtype">void</span>)  {</div>
 444 <div class="line">  <a class="code hl_struct" href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a> drv_capabilities;</div>
 445 <div class="line"> </div>
 446 <div class="line">  drv_info = &amp;Driver_USBH0_HCI;  </div>
 447 <div class="line">  drv_capabilities = drv_info-&gt;<a class="code hl_variable" href="group__usbh__hci__gr.html#aa54b667c830cc3ef9e710382a65e0baa">GetCapabilities</a> ();</div>
 448 <div class="line">  <span class="comment">// interrogate capabilities</span></div>
 449 <div class="line"> </div>
 450 <div class="line">}</div>
 451 <div class="ttc" id="agroup__usbh__hci__gr_html_aa54b667c830cc3ef9e710382a65e0baa"><div class="ttname"><a href="group__usbh__hci__gr.html#aa54b667c830cc3ef9e710382a65e0baa">ARM_DRIVER_USBH_HCI::GetCapabilities</a></div><div class="ttdeci">ARM_USBH_HCI_CAPABILITIES(* GetCapabilities)(void)</div><div class="ttdoc">Pointer to ARM_USBH_HCI_GetCapabilities : Get driver capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:407</div></div>
 452 <div class="ttc" id="agroup__usbh__hci__gr_html_structARM__DRIVER__USBH__HCI"><div class="ttname"><a href="group__usbh__hci__gr.html#structARM__DRIVER__USBH__HCI">ARM_DRIVER_USBH_HCI</a></div><div class="ttdoc">Access structure of USB Host HCI (OHCI/EHCI) Driver.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:405</div></div>
 453 <div class="ttc" id="agroup__usbh__hci__gr_html_structARM__USBH__HCI__CAPABILITIES"><div class="ttname"><a href="group__usbh__hci__gr.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a></div><div class="ttdoc">USB Host HCI (OHCI/EHCI) Driver Capabilities.</div><div class="ttdef"><b>Definition:</b> Driver_USBH.h:396</div></div>
 454 </div><!-- fragment -->
 455 </div>
 456 </div>
 457 <a id="gabc1392a544cb64491b5ea5ce6590d832" name="gabc1392a544cb64491b5ea5ce6590d832"></a>
 458 <h2 class="memtitle"><span class="permalink"><a href="#gabc1392a544cb64491b5ea5ce6590d832">&#9670;&#160;</a></span>ARM_USBH_HCI_Initialize()</h2>
 459
 460 <div class="memitem">
 461 <div class="memproto">
 462       <table class="memname">
 463         <tr>
 464           <td class="memname">int32_t ARM_USBH_HCI_Initialize </td>
 465           <td>(</td>
 466           <td class="paramtype"><a class="el" href="group__usbh__hci__gr.html#gac60df9d1f2b3a769f2c30141800a9806">ARM_USBH_HCI_Interrupt_t</a> *&#160;</td>
 467           <td class="paramname"><em>cb_interrupt</em></td><td>)</td>
 468           <td></td>
 469         </tr>
 470       </table>
 471 </div><div class="memdoc">
 472
 473 <p>Initialize USB Host HCI (OHCI/EHCI) Interface. </p>
 474 <dl class="params"><dt>Parameters</dt><dd>
 475   <table class="params">
 476     <tr><td class="paramdir">[in]</td><td class="paramname">cb_interrupt</td><td>Pointer to Interrupt Handler Routine </td></tr>
 477   </table>
 478   </dd>
 479 </dl>
 480 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 481 <p>The function <b>ARM_USBH_HCI_Initialize</b> initializes the USB Host HCI (OHCI/EHCI) interface. It is called when the middleware component starts operation.</p>
 482 <p>The function performs the following operations:</p><ul>
 483 <li>Initializes the resources needed for the USBH interface.</li>
 484 <li>Registers the <a class="el" href="group__usbh__hci__gr.html#ga79d3c2509ed869c8d7d1485acad7b6c6">ARM_USBH_HCI_Interrupt</a> interrupt handler.</li>
 485 </ul>
 486 <p>The parameter <em>cb_interrupt</em> is a pointer to the interrupt routine of the OHCI/EHCI peripheral that needs to be registered. This function is called as ECHI Interrupt Service Handler.</p>
 487 <p><b>Example:</b> </p><ul>
 488 <li>see <a class="el" href="group__usbh__interface__gr.html">USB Host Interface</a> - Driver Functions </li>
 489 </ul>
 490
 491 </div>
 492 </div>
 493 <a id="gaacb68fdf201cdb1846b31642a760f041" name="gaacb68fdf201cdb1846b31642a760f041"></a>
 494 <h2 class="memtitle"><span class="permalink"><a href="#gaacb68fdf201cdb1846b31642a760f041">&#9670;&#160;</a></span>ARM_USBH_HCI_Uninitialize()</h2>
 495
 496 <div class="memitem">
 497 <div class="memproto">
 498       <table class="memname">
 499         <tr>
 500           <td class="memname">int32_t ARM_USBH_HCI_Uninitialize </td>
 501           <td>(</td>
 502           <td class="paramtype">void&#160;</td>
 503           <td class="paramname"></td><td>)</td>
 504           <td></td>
 505         </tr>
 506       </table>
 507 </div><div class="memdoc">
 508
 509 <p>De-initialize USB Host HCI (OHCI/EHCI) Interface. </p>
 510 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 511 <p>The function <a class="el" href="group__usbh__hci__gr.html#gaacb68fdf201cdb1846b31642a760f041">ARM_USBH_HCI_Uninitialize</a> de-initializes the resources of USB Host HCI (OHCI/EHCI) interface.</p>
 512 <p>It is called when the middleware component stops operation and releases the software resources used by the interface. </p>
 513
 514 </div>
 515 </div>
 516 <a id="ga27fa5ec8854cd9877bbef4abffe9a12b" name="ga27fa5ec8854cd9877bbef4abffe9a12b"></a>
 517 <h2 class="memtitle"><span class="permalink"><a href="#ga27fa5ec8854cd9877bbef4abffe9a12b">&#9670;&#160;</a></span>ARM_USBH_HCI_PowerControl()</h2>
 518
 519 <div class="memitem">
 520 <div class="memproto">
 521       <table class="memname">
 522         <tr>
 523           <td class="memname">int32_t ARM_USBH_HCI_PowerControl </td>
 524           <td>(</td>
 525           <td class="paramtype"><a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a>&#160;</td>
 526           <td class="paramname"><em>state</em></td><td>)</td>
 527           <td></td>
 528         </tr>
 529       </table>
 530 </div><div class="memdoc">
 531
 532 <p>Control USB Host HCI (OHCI/EHCI) Interface Power. </p>
 533 <dl class="params"><dt>Parameters</dt><dd>
 534   <table class="params">
 535     <tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>Power state </td></tr>
 536   </table>
 537   </dd>
 538 </dl>
 539 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 540 <p>The function <b>ARM_USBH_HCI_PowerControl</b> operates the power modes of the USB Host HCI (OHCI/EHCI) interface. <br  />
 541 </p>
 542 <p>The parameter <em>state</em> sets the operation and can have the following values:</p><ul>
 543 <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>
 544 <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>
 545 <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>
 546 </ul>
 547 <p>Refer to <a class="el" href="theoryOperation.html#CallSequence">Function Call Sequence</a> for more information. </p>
 548
 549 </div>
 550 </div>
 551 <a id="gade1e83403c6ea965fe3e6c4c21fbbded" name="gade1e83403c6ea965fe3e6c4c21fbbded"></a>
 552 <h2 class="memtitle"><span class="permalink"><a href="#gade1e83403c6ea965fe3e6c4c21fbbded">&#9670;&#160;</a></span>ARM_USBH_HCI_PortVbusOnOff()</h2>
 553
 554 <div class="memitem">
 555 <div class="memproto">
 556       <table class="memname">
 557         <tr>
 558           <td class="memname">int32_t ARM_USBH_HCI_PortVbusOnOff </td>
 559           <td>(</td>
 560           <td class="paramtype">uint8_t&#160;</td>
 561           <td class="paramname"><em>port</em>, </td>
 562         </tr>
 563         <tr>
 564           <td class="paramkey"></td>
 565           <td></td>
 566           <td class="paramtype">bool&#160;</td>
 567           <td class="paramname"><em>vbus</em>&#160;</td>
 568         </tr>
 569         <tr>
 570           <td></td>
 571           <td>)</td>
 572           <td></td><td></td>
 573         </tr>
 574       </table>
 575 </div><div class="memdoc">
 576
 577 <p>USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off. </p>
 578 <dl class="params"><dt>Parameters</dt><dd>
 579   <table class="params">
 580     <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>Root HUB Port Number </td></tr>
 581     <tr><td class="paramdir">[in]</td><td class="paramname">vbus</td><td><ul>
 582 <li><b>false</b> VBUS off</li>
 583 <li><b>true</b> VBUS on </li>
 584 </ul>
 585 </td></tr>
 586   </table>
 587   </dd>
 588 </dl>
 589 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
 590 <p>The function <b>ARM_USBH_HCI_PortVbusOnOff</b> controls the VBUS signal of the specified port. Most HCI complained USB Host controllers do not require this optional function. It is only required when a external VBUS interface (for example via I/O pin) is required. </p>
 591
 592 </div>
 593 </div>
 594 <a id="ga79d3c2509ed869c8d7d1485acad7b6c6" name="ga79d3c2509ed869c8d7d1485acad7b6c6"></a>
 595 <h2 class="memtitle"><span class="permalink"><a href="#ga79d3c2509ed869c8d7d1485acad7b6c6">&#9670;&#160;</a></span>ARM_USBH_HCI_Interrupt()</h2>
 596
 597 <div class="memitem">
 598 <div class="memproto">
 599       <table class="memname">
 600         <tr>
 601           <td class="memname">void ARM_USBH_HCI_Interrupt </td>
 602           <td>(</td>
 603           <td class="paramtype">void&#160;</td>
 604           <td class="paramname"></td><td>)</td>
 605           <td></td>
 606         </tr>
 607       </table>
 608 </div><div class="memdoc">
 609
 610 <p>USB Host HCI Interrupt Handler. </p>
 611 <p>The function <b>ARM_USBH_HCI_Interrupt</b> is called from the USBH HCI Interrupt Handler. </p>
 612
 613 </div>
 614 </div>
 615 </div><!-- contents -->
 616 </div><!-- doc-content -->
 617 <!-- start footer part -->
 618 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 619   <ul>
 620     <li class="footer">
 621       <script type="text/javascript">
 622         <!--
 623         writeFooter.call(this);
 624         //-->
 625       </script>
 626     </li>
 627   </ul>
 628 </div>
 629 </body>
 630 </html>