begriffs open source - cmsis-driver-validation/blob - docs/html/group__usbh__funcs.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>USB Host Validation</title>
   7 <title>CMSIS-Driver Validation: USB Host Validation</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <link href="drv.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="printComponentTabs.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <link href="stylsheetf" rel="stylesheet" type="text/css" />
  26 </head>
  27 <body>
  28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  29 <div id="titlearea">
  30 <table cellspacing="0" cellpadding="0">
  31  <tbody>
  32  <tr style="height: 46px;">
  33   <td id="projectlogo"><img alt="Logo" src="keilarm.png"/></td>
  34   <td style="padding-left: 0.5em;">
  35    <div id="projectname">CMSIS-Driver Validation
  36    &#160;<span id="projectnumber">Version 1.4.0</span>
  37    </div>
  38    <div id="projectbrief">Driver Validation</div>
  39   </td>
  40  </tr>
  41  </tbody>
  42 </table>
  43 </div>
  44 <!-- end header part -->
  45 <div id="DRVnav" class="tabs1">
  46     <ul class="tablist">
  47       <script type="text/javascript">
  48                 <!--
  49                 writeComponentTabs.call(this);
  50                 //-->
  51       </script>
  52           </ul>
  53 </div>
  54 <!-- Generated by Doxygen 1.8.6 -->
  55 <script type="text/javascript">
  56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  57 </script>
  58   <div id="navrow1" class="tabs">
  59     <ul class="tablist">
  60       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  61       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  62       <li><a href="modules.html"><span>Reference</span></a></li>
  63       <li>
  64         <div id="MSearchBox" class="MSearchBoxInactive">
  65         <span class="left">
  66           <img id="MSearchSelect" src="search/mag_sel.png"
  67                onmouseover="return searchBox.OnSearchSelectShow()"
  68                onmouseout="return searchBox.OnSearchSelectHide()"
  69                alt=""/>
  70           <input type="text" id="MSearchField" value="Search" accesskey="S"
  71                onfocus="searchBox.OnSearchFieldFocus(true)"
  72                onblur="searchBox.OnSearchFieldFocus(false)"
  73                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  74           </span><span class="right">
  75             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  76           </span>
  77         </div>
  78       </li>
  79     </ul>
  80   </div>
  81 </div><!-- top -->
  82 <div id="side-nav" class="ui-resizable side-nav-resizable">
  83   <div id="nav-tree">
  84     <div id="nav-tree-contents">
  85       <div id="nav-sync" class="sync"></div>
  86     </div>
  87   </div>
  88   <div id="splitbar" style="-moz-user-select:none;"
  89        class="ui-resizable-handle">
  90   </div>
  91 </div>
  92 <script type="text/javascript">
  93 $(document).ready(function(){initNavTree('group__usbh__funcs.html','');});
  94 </script>
  95 <div id="doc-content">
  96 <!-- window showing the filter options -->
  97 <div id="MSearchSelectWindow"
  98      onmouseover="return searchBox.OnSearchSelectShow()"
  99      onmouseout="return searchBox.OnSearchSelectHide()"
 100      onkeydown="return searchBox.OnSearchSelectKey(event)">
 101 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 102
 103 <!-- iframe showing the search results (closed by default) -->
 104 <div id="MSearchResultsWindow">
 105 <iframe src="javascript:void(0)" frameborder="0"
 106         name="MSearchResults" id="MSearchResults">
 107 </iframe>
 108 </div>
 109
 110 <div class="header">
 111   <div class="summary">
 112 <a href="#func-members">Functions</a>  </div>
 113   <div class="headertitle">
 114 <div class="title">USB Host Validation</div>  </div>
 115 </div><!--header-->
 116 <div class="contents">
 117
 118 <p>USB Host test cases.
 119 <a href="#details">More...</a></p>
 120 <table class="memberdecls">
 121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 122 Functions</h2></td></tr>
 123 <tr class="memitem:ga6c7b7f7cf41d007f03a0eb525ec9e6ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__funcs.html#ga6c7b7f7cf41d007f03a0eb525ec9e6ba">USBH_GetCapabilities</a> (void)</td></tr>
 124 <tr class="memdesc:ga6c7b7f7cf41d007f03a0eb525ec9e6ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBH_GetCapabilities.  <a href="#ga6c7b7f7cf41d007f03a0eb525ec9e6ba">More...</a><br/></td></tr>
 125 <tr class="separator:ga6c7b7f7cf41d007f03a0eb525ec9e6ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <tr class="memitem:gac154bc8e85e588ca5f267918ac28d919"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__funcs.html#gac154bc8e85e588ca5f267918ac28d919">USBH_Initialization</a> (void)</td></tr>
 127 <tr class="memdesc:gac154bc8e85e588ca5f267918ac28d919"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBH_Initialization.  <a href="#gac154bc8e85e588ca5f267918ac28d919">More...</a><br/></td></tr>
 128 <tr class="separator:gac154bc8e85e588ca5f267918ac28d919"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <tr class="memitem:gad52fc4cd83e77f62070c5d8482f171fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__funcs.html#gad52fc4cd83e77f62070c5d8482f171fd">USBH_CheckInvalidInit</a> (void)</td></tr>
 130 <tr class="memdesc:gad52fc4cd83e77f62070c5d8482f171fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBH_CheckInvalidInit.  <a href="#gad52fc4cd83e77f62070c5d8482f171fd">More...</a><br/></td></tr>
 131 <tr class="separator:gad52fc4cd83e77f62070c5d8482f171fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 132 <tr class="memitem:ga2411bb992c7c352a2556d2b1ee8db714"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbh__funcs.html#ga2411bb992c7c352a2556d2b1ee8db714">USBH_PowerControl</a> (void)</td></tr>
 133 <tr class="memdesc:ga2411bb992c7c352a2556d2b1ee8db714"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBH_PowerControl.  <a href="#ga2411bb992c7c352a2556d2b1ee8db714">More...</a><br/></td></tr>
 134 <tr class="separator:ga2411bb992c7c352a2556d2b1ee8db714"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 </table>
 136 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 137 <p>The USB Host validation test checks the API interface compliance only. </p>
 138 <h2 class="groupheader">Function Documentation</h2>
 139 <a class="anchor" id="gad52fc4cd83e77f62070c5d8482f171fd"></a>
 140 <div class="memitem">
 141 <div class="memproto">
 142       <table class="memname">
 143         <tr>
 144           <td class="memname">void USBH_CheckInvalidInit </td>
 145           <td>(</td>
 146           <td class="paramtype">void&#160;</td>
 147           <td class="paramname"></td><td>)</td>
 148           <td></td>
 149         </tr>
 150       </table>
 151 </div><div class="memdoc">
 152 <p>The test case <b>USBH_CheckInvalidInit</b> verifies the driver behaviour when receiving an invalid initialization sequence:</p>
 153 <ul>
 154 <li><b>Uninitialize</b> </li>
 155 <li><b>PowerControl</b> with Power off</li>
 156 <li><b>PowerControl</b> with Power on</li>
 157 <li><b>PowerControl</b> with Power off</li>
 158 <li><b>Uninitialize</b> </li>
 159 </ul>
 160
 161 </div>
 162 </div>
 163 <a class="anchor" id="ga6c7b7f7cf41d007f03a0eb525ec9e6ba"></a>
 164 <div class="memitem">
 165 <div class="memproto">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname">void USBH_GetCapabilities </td>
 169           <td>(</td>
 170           <td class="paramtype">void&#160;</td>
 171           <td class="paramname"></td><td>)</td>
 172           <td></td>
 173         </tr>
 174       </table>
 175 </div><div class="memdoc">
 176 <p>The test case <b>USBH_GetCapabilities</b> verifies the function <b>GetCapabilities</b>. </p>
 177
 178 </div>
 179 </div>
 180 <a class="anchor" id="gac154bc8e85e588ca5f267918ac28d919"></a>
 181 <div class="memitem">
 182 <div class="memproto">
 183       <table class="memname">
 184         <tr>
 185           <td class="memname">void USBH_Initialization </td>
 186           <td>(</td>
 187           <td class="paramtype">void&#160;</td>
 188           <td class="paramname"></td><td>)</td>
 189           <td></td>
 190         </tr>
 191       </table>
 192 </div><div class="memdoc">
 193 <p>The test case <b>USBH_Initialization</b> verifies the USBH functions with the sequence:</p>
 194 <ul>
 195 <li><b>Initialize</b> without callback</li>
 196 <li><b>Uninitialize</b> </li>
 197 <li><b>Initialize</b> with callback</li>
 198 <li><b>Uninitialize</b> </li>
 199 </ul>
 200
 201 </div>
 202 </div>
 203 <a class="anchor" id="ga2411bb992c7c352a2556d2b1ee8db714"></a>
 204 <div class="memitem">
 205 <div class="memproto">
 206       <table class="memname">
 207         <tr>
 208           <td class="memname">void USBH_PowerControl </td>
 209           <td>(</td>
 210           <td class="paramtype">void&#160;</td>
 211           <td class="paramname"></td><td>)</td>
 212           <td></td>
 213         </tr>
 214       </table>
 215 </div><div class="memdoc">
 216 <p>The test case <b>USBH_PowerControl</b> verifies the <b>PowerControl</b> function with the sequence:</p>
 217 <ul>
 218 <li>Initialize</li>
 219 <li>Power on</li>
 220 <li>Power low</li>
 221 <li>Power off</li>
 222 <li>Uninitialize </li>
 223 </ul>
 224
 225 </div>
 226 </div>
 227 </div><!-- contents -->
 228 </div><!-- doc-content -->
 229 <!-- start footer part -->
 230 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 231   <ul>
 232     <li class="footer">Generated on Mon Dec 2 2019 12:02:23 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 233         <!--
 234     <a href="http://www.doxygen.org/index.html">
 235     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 236         -->
 237         </li>
 238   </ul>
 239 </div>
 240 </body>
 241 </html>