begriffs open source - cmsis/blob - main/Driver/structARM__DRIVER__USBH__HCI.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: ARM_DRIVER_USBH_HCI Struct Reference</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('structARM__DRIVER__USBH__HCI.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="#pub-attribs">Data Fields</a>  </div>
 129   <div class="headertitle"><div class="title">ARM_DRIVER_USBH_HCI Struct Reference</div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>Access structure of USB Host HCI (OHCI/EHCI) Driver.
 134  <a href="structARM__DRIVER__USBH__HCI.html#details">More...</a></p>
 135
 136 <p><code>#include &lt;Driver_USBH.h&gt;</code></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
 139 Data Fields</h2></td></tr>
 140 <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="structARM__DRIVER__USBH__HCI.html#a30afd9cb3113c037b5f1926f5ef93b59">GetVersion</a> )(void)</td></tr>
 141 <tr class="memdesc:a30afd9cb3113c037b5f1926f5ef93b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to ARM_USBH_HCI_GetVersion : Get USB Host HCI (OHCI/EHCI) driver version.  <br /></td></tr>
 142 <tr class="separator:a30afd9cb3113c037b5f1926f5ef93b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:aa54b667c830cc3ef9e710382a65e0baa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Driver__USBH_8h.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structARM__DRIVER__USBH__HCI.html#aa54b667c830cc3ef9e710382a65e0baa">GetCapabilities</a> )(void)</td></tr>
 144 <tr class="memdesc:aa54b667c830cc3ef9e710382a65e0baa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to ARM_USBH_HCI_GetCapabilities : Get driver capabilities.  <br /></td></tr>
 145 <tr class="separator:aa54b667c830cc3ef9e710382a65e0baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ade38d7e63bf159f928b6f68be9cc09dd"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structARM__DRIVER__USBH__HCI.html#ade38d7e63bf159f928b6f68be9cc09dd">Initialize</a> )(<a class="el" href="Driver__USBH_8h.html#aa84c7c85b6d7a3bf09bf711ed16d6af6">ARM_USBH_HCI_Interrupt_t</a> cb_interrupt)</td></tr>
 147 <tr class="memdesc:ade38d7e63bf159f928b6f68be9cc09dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to ARM_USBH_HCI_Initialize : Initialize USB Host HCI (OHCI/EHCI) Interface.  <br /></td></tr>
 148 <tr class="separator:ade38d7e63bf159f928b6f68be9cc09dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structARM__DRIVER__USBH__HCI.html#a5ce2b3d7a3a07099bf07d1eb253e92e3">Uninitialize</a> )(void)</td></tr>
 150 <tr class="memdesc:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to ARM_USBH_HCI_Uninitialize : De-initialize USB Host HCI (OHCI/EHCI) Interface.  <br /></td></tr>
 151 <tr class="separator:a5ce2b3d7a3a07099bf07d1eb253e92e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structARM__DRIVER__USBH__HCI.html#a24ebae5c6011631f76027f9a16eaf5ce">PowerControl</a> )(<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td></tr>
 153 <tr class="memdesc:a24ebae5c6011631f76027f9a16eaf5ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to ARM_USBH_HCI_PowerControl : Control USB Host HCI (OHCI/EHCI) Interface Power.  <br /></td></tr>
 154 <tr class="separator:a24ebae5c6011631f76027f9a16eaf5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:af876f976d36d73d4b76063a4ed217ee8"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structARM__DRIVER__USBH__HCI.html#af876f976d36d73d4b76063a4ed217ee8">PortVbusOnOff</a> )(uint8_t port, bool vbus)</td></tr>
 156 <tr class="memdesc:af876f976d36d73d4b76063a4ed217ee8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to ARM_USBH_HCI_PortVbusOnOff : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off.  <br /></td></tr>
 157 <tr class="separator:af876f976d36d73d4b76063a4ed217ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 </table>
 159 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 160 <div class="textblock"><p>Access structure of USB Host HCI (OHCI/EHCI) Driver. </p>
 161 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>HCI driver has been deprecated </dd></dl>
 162 </div><h2 class="groupheader">Field Documentation</h2>
 163 <a id="a30afd9cb3113c037b5f1926f5ef93b59" name="a30afd9cb3113c037b5f1926f5ef93b59"></a>
 164 <h2 class="memtitle"><span class="permalink"><a href="#a30afd9cb3113c037b5f1926f5ef93b59">&#9670;&#160;</a></span>GetVersion</h2>
 165
 166 <div class="memitem">
 167 <div class="memproto">
 168       <table class="memname">
 169         <tr>
 170           <td class="memname"><a class="el" href="group__common__drv__gr.html#structARM__DRIVER__VERSION">ARM_DRIVER_VERSION</a>(* GetVersion) (void)</td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174
 175 <p>Pointer to ARM_USBH_HCI_GetVersion : Get USB Host HCI (OHCI/EHCI) driver version. </p>
 176
 177 </div>
 178 </div>
 179 <a id="aa54b667c830cc3ef9e710382a65e0baa" name="aa54b667c830cc3ef9e710382a65e0baa"></a>
 180 <h2 class="memtitle"><span class="permalink"><a href="#aa54b667c830cc3ef9e710382a65e0baa">&#9670;&#160;</a></span>GetCapabilities</h2>
 181
 182 <div class="memitem">
 183 <div class="memproto">
 184       <table class="memname">
 185         <tr>
 186           <td class="memname"><a class="el" href="Driver__USBH_8h.html#structARM__USBH__HCI__CAPABILITIES">ARM_USBH_HCI_CAPABILITIES</a>(* GetCapabilities) (void)</td>
 187         </tr>
 188       </table>
 189 </div><div class="memdoc">
 190
 191 <p>Pointer to ARM_USBH_HCI_GetCapabilities : Get driver capabilities. </p>
 192
 193 </div>
 194 </div>
 195 <a id="ade38d7e63bf159f928b6f68be9cc09dd" name="ade38d7e63bf159f928b6f68be9cc09dd"></a>
 196 <h2 class="memtitle"><span class="permalink"><a href="#ade38d7e63bf159f928b6f68be9cc09dd">&#9670;&#160;</a></span>Initialize</h2>
 197
 198 <div class="memitem">
 199 <div class="memproto">
 200       <table class="memname">
 201         <tr>
 202           <td class="memname">int32_t(* Initialize) (<a class="el" href="Driver__USBH_8h.html#aa84c7c85b6d7a3bf09bf711ed16d6af6">ARM_USBH_HCI_Interrupt_t</a> cb_interrupt)</td>
 203         </tr>
 204       </table>
 205 </div><div class="memdoc">
 206
 207 <p>Pointer to ARM_USBH_HCI_Initialize : Initialize USB Host HCI (OHCI/EHCI) Interface. </p>
 208
 209 </div>
 210 </div>
 211 <a id="a5ce2b3d7a3a07099bf07d1eb253e92e3" name="a5ce2b3d7a3a07099bf07d1eb253e92e3"></a>
 212 <h2 class="memtitle"><span class="permalink"><a href="#a5ce2b3d7a3a07099bf07d1eb253e92e3">&#9670;&#160;</a></span>Uninitialize</h2>
 213
 214 <div class="memitem">
 215 <div class="memproto">
 216       <table class="memname">
 217         <tr>
 218           <td class="memname">int32_t(* Uninitialize) (void)</td>
 219         </tr>
 220       </table>
 221 </div><div class="memdoc">
 222
 223 <p>Pointer to ARM_USBH_HCI_Uninitialize : De-initialize USB Host HCI (OHCI/EHCI) Interface. </p>
 224
 225 </div>
 226 </div>
 227 <a id="a24ebae5c6011631f76027f9a16eaf5ce" name="a24ebae5c6011631f76027f9a16eaf5ce"></a>
 228 <h2 class="memtitle"><span class="permalink"><a href="#a24ebae5c6011631f76027f9a16eaf5ce">&#9670;&#160;</a></span>PowerControl</h2>
 229
 230 <div class="memitem">
 231 <div class="memproto">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname">int32_t(* PowerControl) (<a class="el" href="group__common__drv__gr.html#ga47d6d7c31f88f3b8ae4aaf9d8444afa5">ARM_POWER_STATE</a> state)</td>
 235         </tr>
 236       </table>
 237 </div><div class="memdoc">
 238
 239 <p>Pointer to ARM_USBH_HCI_PowerControl : Control USB Host HCI (OHCI/EHCI) Interface Power. </p>
 240
 241 </div>
 242 </div>
 243 <a id="af876f976d36d73d4b76063a4ed217ee8" name="af876f976d36d73d4b76063a4ed217ee8"></a>
 244 <h2 class="memtitle"><span class="permalink"><a href="#af876f976d36d73d4b76063a4ed217ee8">&#9670;&#160;</a></span>PortVbusOnOff</h2>
 245
 246 <div class="memitem">
 247 <div class="memproto">
 248       <table class="memname">
 249         <tr>
 250           <td class="memname">int32_t(* PortVbusOnOff) (uint8_t port, bool vbus)</td>
 251         </tr>
 252       </table>
 253 </div><div class="memdoc">
 254
 255 <p>Pointer to ARM_USBH_HCI_PortVbusOnOff : USB Host HCI (OHCI/EHCI) Root HUB Port VBUS on/off. </p>
 256
 257 </div>
 258 </div>
 259 </div><!-- contents -->
 260 </div><!-- doc-content -->
 261 <!-- start footer part -->
 262 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 263   <ul>
 264     <li class="navelem"><a class="el" href="structARM__DRIVER__USBH__HCI.html">ARM_DRIVER_USBH_HCI</a></li>
 265     <li class="footer">
 266       <script type="text/javascript">
 267         <!--
 268         writeFooter.call(this);
 269         //-->
 270       </script>
 271     </li>
 272   </ul>
 273 </div>
 274 </body>
 275 </html>