]> begriffs open source - cmsis-driver-validation/blob - docs/html/group__usbd__tests.html
Update documentation hosted on github
[cmsis-driver-validation] / docs / html / group__usbd__tests.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>Tests</title>
7 <title>CMSIS-Driver Validation: Tests</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 3.0.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__tests.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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><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">Tests<div class="ingroups"><a class="el" href="group__dv__usbd.html">USB Device Validation</a></div></div>  </div>
115 </div><!--header-->
116 <div class="contents">
117 <table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
119 Functions</h2></td></tr>
120 <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__tests.html#ga7741fc91dd8d6c2753456f710c7edb8d">USBD_GetCapabilities</a> (void)</td></tr>
121 <tr class="memdesc:ga7741fc91dd8d6c2753456f710c7edb8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: USBD_GetCapabilities.  <a href="#ga7741fc91dd8d6c2753456f710c7edb8d">More...</a><br/></td></tr>
122 <tr class="separator:ga7741fc91dd8d6c2753456f710c7edb8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 <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__tests.html#gadb1bbaca0dab75366e72e0713b0be1cb">USBD_Initialization</a> (void)</td></tr>
124 <tr class="memdesc:gadb1bbaca0dab75366e72e0713b0be1cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: USBD_Initialization.  <a href="#gadb1bbaca0dab75366e72e0713b0be1cb">More...</a><br/></td></tr>
125 <tr class="separator:gadb1bbaca0dab75366e72e0713b0be1cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 <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__tests.html#gab0ea514df26091d0c0e3c6330ece2194">USBD_CheckInvalidInit</a> (void)</td></tr>
127 <tr class="memdesc:gab0ea514df26091d0c0e3c6330ece2194"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: USBD_CheckInvalidInit.  <a href="#gab0ea514df26091d0c0e3c6330ece2194">More...</a><br/></td></tr>
128 <tr class="separator:gab0ea514df26091d0c0e3c6330ece2194"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <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__tests.html#ga22da180f32f7d3c64a26a3ee5f5d0641">USBD_PowerControl</a> (void)</td></tr>
130 <tr class="memdesc:ga22da180f32f7d3c64a26a3ee5f5d0641"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: USBD_PowerControl.  <a href="#ga22da180f32f7d3c64a26a3ee5f5d0641">More...</a><br/></td></tr>
131 <tr class="separator:ga22da180f32f7d3c64a26a3ee5f5d0641"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 </table>
133 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
134 <h2 class="groupheader">Function Documentation</h2>
135 <a class="anchor" id="ga7741fc91dd8d6c2753456f710c7edb8d"></a>
136 <div class="memitem">
137 <div class="memproto">
138       <table class="memname">
139         <tr>
140           <td class="memname">void USBD_GetCapabilities </td>
141           <td>(</td>
142           <td class="paramtype">void&#160;</td>
143           <td class="paramname"></td><td>)</td>
144           <td></td>
145         </tr>
146       </table>
147 </div><div class="memdoc">
148 <p>The test function <b>USBD_GetCapabilities</b> verifies the function <b>GetCapabilities</b>. </p>
149
150 </div>
151 </div>
152 <a class="anchor" id="gadb1bbaca0dab75366e72e0713b0be1cb"></a>
153 <div class="memitem">
154 <div class="memproto">
155       <table class="memname">
156         <tr>
157           <td class="memname">void USBD_Initialization </td>
158           <td>(</td>
159           <td class="paramtype">void&#160;</td>
160           <td class="paramname"></td><td>)</td>
161           <td></td>
162         </tr>
163       </table>
164 </div><div class="memdoc">
165 <p>The test function <b>USBD_Initialization</b> verifies the USBD functions with the sequence:</p>
166 <ul>
167 <li><b>Initialize</b> without callback</li>
168 <li><b>Uninitialize</b> </li>
169 <li><b>Initialize</b> with callback</li>
170 <li><b>Uninitialize</b> </li>
171 </ul>
172
173 </div>
174 </div>
175 <a class="anchor" id="gab0ea514df26091d0c0e3c6330ece2194"></a>
176 <div class="memitem">
177 <div class="memproto">
178       <table class="memname">
179         <tr>
180           <td class="memname">void USBD_CheckInvalidInit </td>
181           <td>(</td>
182           <td class="paramtype">void&#160;</td>
183           <td class="paramname"></td><td>)</td>
184           <td></td>
185         </tr>
186       </table>
187 </div><div class="memdoc">
188 <p>The test function <b>USBD_CheckInvalidInit</b> verifies the driver behaviour when receiving an invalid initialization sequence:</p>
189 <ul>
190 <li><b>Uninitialize</b> </li>
191 <li><b>PowerControl</b> with Power off</li>
192 <li><b>PowerControl</b> with Power on</li>
193 <li><b>PowerControl</b> with Power off</li>
194 <li><b>Uninitialize</b> </li>
195 </ul>
196
197 </div>
198 </div>
199 <a class="anchor" id="ga22da180f32f7d3c64a26a3ee5f5d0641"></a>
200 <div class="memitem">
201 <div class="memproto">
202       <table class="memname">
203         <tr>
204           <td class="memname">void USBD_PowerControl </td>
205           <td>(</td>
206           <td class="paramtype">void&#160;</td>
207           <td class="paramname"></td><td>)</td>
208           <td></td>
209         </tr>
210       </table>
211 </div><div class="memdoc">
212 <p>The test function <b>USBD_PowerControl</b> verifies the <b>PowerControl</b> function with the sequence:</p>
213 <ul>
214 <li>Initialize</li>
215 <li>Power on</li>
216 <li>Power low</li>
217 <li>Power off</li>
218 <li>Uninitialize </li>
219 </ul>
220
221 </div>
222 </div>
223 </div><!-- contents -->
224 </div><!-- doc-content -->
225 <!-- start footer part -->
226 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
227   <ul>
228     <li class="footer">Generated on Fri Jul 15 2022 08:42:09 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
229         <!--
230     <a href="http://www.doxygen.org/index.html">
231     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
232         -->
233         </li>
234   </ul>
235 </div>
236 </body>
237 </html>