begriffs open source - cmsis-driver-validation/blob - docs/html/group__usbd__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 Device Validation</title>
   7 <title>CMSIS-Driver Validation: USB Device 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.2.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__usbd__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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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="#groups">Content</a> &#124;
 113 <a href="#func-members">Functions</a>  </div>
 114   <div class="headertitle">
 115 <div class="title">USB Device Validation</div>  </div>
 116 </div><!--header-->
 117 <div class="contents">
 118
 119 <p>USB Device test cases.
 120 <a href="#details">More...</a></p>
 121 <table class="memberdecls">
 122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
 123 Content</h2></td></tr>
 124 <tr class="memitem:group__usbd__comp__test"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__comp__test.html">USB Compliance Tests</a></td></tr>
 125 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 </table><table class="memberdecls">
 127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 128 Functions</h2></td></tr>
 129 <tr class="memitem:ga7741fc91dd8d6c2753456f710c7edb8d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__funcs.html#ga7741fc91dd8d6c2753456f710c7edb8d">USBD_GetCapabilities</a> (void)</td></tr>
 130 <tr class="memdesc:ga7741fc91dd8d6c2753456f710c7edb8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBD_GetCapabilities.  <a href="#ga7741fc91dd8d6c2753456f710c7edb8d">More...</a><br/></td></tr>
 131 <tr class="separator:ga7741fc91dd8d6c2753456f710c7edb8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 132 <tr class="memitem:gadb1bbaca0dab75366e72e0713b0be1cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__funcs.html#gadb1bbaca0dab75366e72e0713b0be1cb">USBD_Initialization</a> (void)</td></tr>
 133 <tr class="memdesc:gadb1bbaca0dab75366e72e0713b0be1cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBD_Initialization.  <a href="#gadb1bbaca0dab75366e72e0713b0be1cb">More...</a><br/></td></tr>
 134 <tr class="separator:gadb1bbaca0dab75366e72e0713b0be1cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:gab0ea514df26091d0c0e3c6330ece2194"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__funcs.html#gab0ea514df26091d0c0e3c6330ece2194">USBD_CheckInvalidInit</a> (void)</td></tr>
 136 <tr class="memdesc:gab0ea514df26091d0c0e3c6330ece2194"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBD_CheckInvalidInit.  <a href="#gab0ea514df26091d0c0e3c6330ece2194">More...</a><br/></td></tr>
 137 <tr class="separator:gab0ea514df26091d0c0e3c6330ece2194"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:ga22da180f32f7d3c64a26a3ee5f5d0641"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__funcs.html#ga22da180f32f7d3c64a26a3ee5f5d0641">USBD_PowerControl</a> (void)</td></tr>
 139 <tr class="memdesc:ga22da180f32f7d3c64a26a3ee5f5d0641"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: USBD_PowerControl.  <a href="#ga22da180f32f7d3c64a26a3ee5f5d0641">More...</a><br/></td></tr>
 140 <tr class="separator:ga22da180f32f7d3c64a26a3ee5f5d0641"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 </table>
 142 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 143 <p>The USB Device validation test checks the API interface compliance only. The section <a class="el" href="group__usbd__comp__test.html">USB Compliance Tests</a> explains how to run the USB compliance tests. These tests check USB devices for conformance to the USB Device Framework which is required in order to gain USB certification. </p>
 144 <h2 class="groupheader">Function Documentation</h2>
 145 <a class="anchor" id="gab0ea514df26091d0c0e3c6330ece2194"></a>
 146 <div class="memitem">
 147 <div class="memproto">
 148       <table class="memname">
 149         <tr>
 150           <td class="memname">void USBD_CheckInvalidInit </td>
 151           <td>(</td>
 152           <td class="paramtype">void&#160;</td>
 153           <td class="paramname"></td><td>)</td>
 154           <td></td>
 155         </tr>
 156       </table>
 157 </div><div class="memdoc">
 158 <p>The test case <b>USBD_CheckInvalidInit</b> verifies the driver behaviour when receiving an invalid initialization sequence:</p>
 159 <ul>
 160 <li><b>Uninitialize</b> </li>
 161 <li><b>PowerControl</b> with Power off</li>
 162 <li><b>PowerControl</b> with Power on</li>
 163 <li><b>PowerControl</b> with Power off</li>
 164 <li><b>Uninitialize</b> </li>
 165 </ul>
 166
 167 </div>
 168 </div>
 169 <a class="anchor" id="ga7741fc91dd8d6c2753456f710c7edb8d"></a>
 170 <div class="memitem">
 171 <div class="memproto">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname">void USBD_GetCapabilities </td>
 175           <td>(</td>
 176           <td class="paramtype">void&#160;</td>
 177           <td class="paramname"></td><td>)</td>
 178           <td></td>
 179         </tr>
 180       </table>
 181 </div><div class="memdoc">
 182 <p>The test case <b>USBD_GetCapabilities</b> verifies the function <b>GetCapabilities</b>. </p>
 183
 184 </div>
 185 </div>
 186 <a class="anchor" id="gadb1bbaca0dab75366e72e0713b0be1cb"></a>
 187 <div class="memitem">
 188 <div class="memproto">
 189       <table class="memname">
 190         <tr>
 191           <td class="memname">void USBD_Initialization </td>
 192           <td>(</td>
 193           <td class="paramtype">void&#160;</td>
 194           <td class="paramname"></td><td>)</td>
 195           <td></td>
 196         </tr>
 197       </table>
 198 </div><div class="memdoc">
 199 <p>The test case <b>USBD_Initialization</b> verifies the USBD functions with the sequence:</p>
 200 <ul>
 201 <li><b>Initialize</b> without callback</li>
 202 <li><b>Uninitialize</b> </li>
 203 <li><b>Initialize</b> with callback</li>
 204 <li><b>Uninitialize</b> </li>
 205 </ul>
 206
 207 </div>
 208 </div>
 209 <a class="anchor" id="ga22da180f32f7d3c64a26a3ee5f5d0641"></a>
 210 <div class="memitem">
 211 <div class="memproto">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname">void USBD_PowerControl </td>
 215           <td>(</td>
 216           <td class="paramtype">void&#160;</td>
 217           <td class="paramname"></td><td>)</td>
 218           <td></td>
 219         </tr>
 220       </table>
 221 </div><div class="memdoc">
 222 <p>The test case <b>USBD_PowerControl</b> verifies the <b>PowerControl</b> function with the sequence:</p>
 223 <ul>
 224 <li>Initialize</li>
 225 <li>Power on</li>
 226 <li>Power low</li>
 227 <li>Power off</li>
 228 <li>Uninitialize </li>
 229 </ul>
 230
 231 </div>
 232 </div>
 233 </div><!-- contents -->
 234 </div><!-- doc-content -->
 235 <!-- start footer part -->
 236 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 237   <ul>
 238     <li class="footer">Generated on Thu Feb 21 2019 15:24:48 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 239         <!--
 240     <a href="http://www.doxygen.org/index.html">
 241     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 242         -->
 243         </li>
 244   </ul>
 245 </div>
 246 </body>
 247 </html>