]> begriffs open source - cmsis-driver-validation/blob - docs/html/group__mci__funcs.html
Merge branch 'develop'
[cmsis-driver-validation] / docs / html / group__mci__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>MCI Validation</title>
7 <title>CMSIS-Driver Validation: MCI 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__mci__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">MCI Validation</div>  </div>
115 </div><!--header-->
116 <div class="contents">
117
118 <p>MCI 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:ga4445f77f0524673fb7e1a206f6c0886a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#ga4445f77f0524673fb7e1a206f6c0886a">MCI_GetCapabilities</a> (void)</td></tr>
124 <tr class="memdesc:ga4445f77f0524673fb7e1a206f6c0886a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_GetCapabilities.  <a href="#ga4445f77f0524673fb7e1a206f6c0886a">More...</a><br/></td></tr>
125 <tr class="separator:ga4445f77f0524673fb7e1a206f6c0886a"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 <tr class="memitem:ga1fbbdddda0f9ea5c393aa22fd14a2203"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#ga1fbbdddda0f9ea5c393aa22fd14a2203">MCI_Initialization</a> (void)</td></tr>
127 <tr class="memdesc:ga1fbbdddda0f9ea5c393aa22fd14a2203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_Initialization.  <a href="#ga1fbbdddda0f9ea5c393aa22fd14a2203">More...</a><br/></td></tr>
128 <tr class="separator:ga1fbbdddda0f9ea5c393aa22fd14a2203"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <tr class="memitem:ga6a8da0da1e1948d041df83dadcf040fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#ga6a8da0da1e1948d041df83dadcf040fa">MCI_CheckInvalidInit</a> (void)</td></tr>
130 <tr class="memdesc:ga6a8da0da1e1948d041df83dadcf040fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_CheckInvalidInit.  <a href="#ga6a8da0da1e1948d041df83dadcf040fa">More...</a><br/></td></tr>
131 <tr class="separator:ga6a8da0da1e1948d041df83dadcf040fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 <tr class="memitem:gae0bacb3721a19527d6c8be03a806731d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#gae0bacb3721a19527d6c8be03a806731d">MCI_PowerControl</a> (void)</td></tr>
133 <tr class="memdesc:gae0bacb3721a19527d6c8be03a806731d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_PowerControl.  <a href="#gae0bacb3721a19527d6c8be03a806731d">More...</a><br/></td></tr>
134 <tr class="separator:gae0bacb3721a19527d6c8be03a806731d"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:ga9ba9cbcc5c0f22f8ad1089453e0794d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#ga9ba9cbcc5c0f22f8ad1089453e0794d4">MCI_SetBusSpeedMode</a> (void)</td></tr>
136 <tr class="memdesc:ga9ba9cbcc5c0f22f8ad1089453e0794d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_SetBusSpeedMode.  <a href="#ga9ba9cbcc5c0f22f8ad1089453e0794d4">More...</a><br/></td></tr>
137 <tr class="separator:ga9ba9cbcc5c0f22f8ad1089453e0794d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:ga58de415fa79b7e1561a1567d20a09110"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#ga58de415fa79b7e1561a1567d20a09110">MCI_Config_DataWidth</a> (void)</td></tr>
139 <tr class="memdesc:ga58de415fa79b7e1561a1567d20a09110"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_Config_DataWidth.  <a href="#ga58de415fa79b7e1561a1567d20a09110">More...</a><br/></td></tr>
140 <tr class="separator:ga58de415fa79b7e1561a1567d20a09110"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:gaebafd712cb91fc240e5acb2a7a968675"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#gaebafd712cb91fc240e5acb2a7a968675">MCI_Config_CmdLineMode</a> (void)</td></tr>
142 <tr class="memdesc:gaebafd712cb91fc240e5acb2a7a968675"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_Config_CmdLineMode.  <a href="#gaebafd712cb91fc240e5acb2a7a968675">More...</a><br/></td></tr>
143 <tr class="separator:gaebafd712cb91fc240e5acb2a7a968675"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:ga5aee0627cfc07f89e4ed4bd4e19eb519"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mci__funcs.html#ga5aee0627cfc07f89e4ed4bd4e19eb519">MCI_Config_DriverStrength</a> (void)</td></tr>
145 <tr class="memdesc:ga5aee0627cfc07f89e4ed4bd4e19eb519"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: MCI_Config_DriverStrength.  <a href="#ga5aee0627cfc07f89e4ed4bd4e19eb519">More...</a><br/></td></tr>
146 <tr class="separator:ga5aee0627cfc07f89e4ed4bd4e19eb519"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 </table>
148 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
149 <p>The MCI validation test checks the API interface compliance only. </p>
150 <h2 class="groupheader">Function Documentation</h2>
151 <a class="anchor" id="ga6a8da0da1e1948d041df83dadcf040fa"></a>
152 <div class="memitem">
153 <div class="memproto">
154       <table class="memname">
155         <tr>
156           <td class="memname">void MCI_CheckInvalidInit </td>
157           <td>(</td>
158           <td class="paramtype">void&#160;</td>
159           <td class="paramname"></td><td>)</td>
160           <td></td>
161         </tr>
162       </table>
163 </div><div class="memdoc">
164 <p>The test case <b>MCI_CheckInvalidInit</b> verifies the driver behaviour when receiving an invalid initialization sequence:</p>
165 <ul>
166 <li><b>Uninitialize</b> </li>
167 <li><b>PowerControl</b> with Power off</li>
168 <li><b>PowerControl</b> with Power on</li>
169 <li><b>PowerControl</b> with Power off</li>
170 <li><b>Uninitialize</b> </li>
171 </ul>
172
173 </div>
174 </div>
175 <a class="anchor" id="gaebafd712cb91fc240e5acb2a7a968675"></a>
176 <div class="memitem">
177 <div class="memproto">
178       <table class="memname">
179         <tr>
180           <td class="memname">void MCI_Config_CmdLineMode </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 case <b>MCI_Config_CmdLineMode</b> verifies the <b>Control</b> function with the sequence:</p>
189 <ul>
190 <li>Initialize</li>
191 <li>Power on</li>
192 <li>Default push-pull</li>
193 <li>Open Drain</li>
194 <li>Power off</li>
195 <li>Uninitialize </li>
196 </ul>
197
198 </div>
199 </div>
200 <a class="anchor" id="ga58de415fa79b7e1561a1567d20a09110"></a>
201 <div class="memitem">
202 <div class="memproto">
203       <table class="memname">
204         <tr>
205           <td class="memname">void MCI_Config_DataWidth </td>
206           <td>(</td>
207           <td class="paramtype">void&#160;</td>
208           <td class="paramname"></td><td>)</td>
209           <td></td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213 <p>The test case <b>MCI_Config_DataWidth</b> verifies the <b>Control</b> function and set the data width with the sequence:</p>
214 <ul>
215 <li>Initialize</li>
216 <li>Power on</li>
217 <li>Default data width <span class="XML-Token">1</span></li>
218 <li>Data width <span class="XML-Token">4</span></li>
219 <li>Data width <span class="XML-Token">8</span></li>
220 <li>Data width <span class="XML-Token">4 DDR</span></li>
221 <li>Data width <span class="XML-Token">8 DDR</span></li>
222 <li>Power off</li>
223 <li>Uninitialize </li>
224 </ul>
225
226 </div>
227 </div>
228 <a class="anchor" id="ga5aee0627cfc07f89e4ed4bd4e19eb519"></a>
229 <div class="memitem">
230 <div class="memproto">
231       <table class="memname">
232         <tr>
233           <td class="memname">void MCI_Config_DriverStrength </td>
234           <td>(</td>
235           <td class="paramtype">void&#160;</td>
236           <td class="paramname"></td><td>)</td>
237           <td></td>
238         </tr>
239       </table>
240 </div><div class="memdoc">
241 <p>The test case <b>MCI_Config_DriverStrength</b> verifies the <b>Control</b> function and sets the driver strength with the sequence:</p>
242 <ul>
243 <li>Initialize</li>
244 <li>Power on</li>
245 <li>Type A</li>
246 <li>Type B</li>
247 <li>Type C</li>
248 <li>Type D</li>
249 <li>Power off</li>
250 <li>Uninitialize </li>
251 </ul>
252
253 </div>
254 </div>
255 <a class="anchor" id="ga4445f77f0524673fb7e1a206f6c0886a"></a>
256 <div class="memitem">
257 <div class="memproto">
258       <table class="memname">
259         <tr>
260           <td class="memname">void MCI_GetCapabilities </td>
261           <td>(</td>
262           <td class="paramtype">void&#160;</td>
263           <td class="paramname"></td><td>)</td>
264           <td></td>
265         </tr>
266       </table>
267 </div><div class="memdoc">
268 <p>The test case <b>MCI_GetCapabilities</b> verifies the function <b>GetCapabilities</b>. </p>
269
270 </div>
271 </div>
272 <a class="anchor" id="ga1fbbdddda0f9ea5c393aa22fd14a2203"></a>
273 <div class="memitem">
274 <div class="memproto">
275       <table class="memname">
276         <tr>
277           <td class="memname">void MCI_Initialization </td>
278           <td>(</td>
279           <td class="paramtype">void&#160;</td>
280           <td class="paramname"></td><td>)</td>
281           <td></td>
282         </tr>
283       </table>
284 </div><div class="memdoc">
285 <p>The test case <b>MCI_Initialization</b> verifies the MCI functions with the sequence:</p>
286 <ul>
287 <li><b>Initialize</b> without callback</li>
288 <li><b>Uninitialize</b> </li>
289 <li><b>Initialize</b> with callback</li>
290 <li><b>Uninitialize</b> </li>
291 </ul>
292
293 </div>
294 </div>
295 <a class="anchor" id="gae0bacb3721a19527d6c8be03a806731d"></a>
296 <div class="memitem">
297 <div class="memproto">
298       <table class="memname">
299         <tr>
300           <td class="memname">void MCI_PowerControl </td>
301           <td>(</td>
302           <td class="paramtype">void&#160;</td>
303           <td class="paramname"></td><td>)</td>
304           <td></td>
305         </tr>
306       </table>
307 </div><div class="memdoc">
308 <p>The test case <b>MCI_PowerControl</b> verifies the <b>PowerControl</b> function with the sequence:</p>
309 <ul>
310 <li>Initialize</li>
311 <li>Power on</li>
312 <li>Power low</li>
313 <li>Power off</li>
314 <li>Uninitialize </li>
315 </ul>
316
317 </div>
318 </div>
319 <a class="anchor" id="ga9ba9cbcc5c0f22f8ad1089453e0794d4"></a>
320 <div class="memitem">
321 <div class="memproto">
322       <table class="memname">
323         <tr>
324           <td class="memname">void MCI_SetBusSpeedMode </td>
325           <td>(</td>
326           <td class="paramtype">void&#160;</td>
327           <td class="paramname"></td><td>)</td>
328           <td></td>
329         </tr>
330       </table>
331 </div><div class="memdoc">
332 <p>The test case <b>MCI_SetBusSpeedMode</b> verifies the <b>Control</b> function and sets the bus speed with the sequence:</p>
333 <ul>
334 <li>Initialize</li>
335 <li>Power on</li>
336 <li>default speed</li>
337 <li>high speed</li>
338 <li>SDR12 speed</li>
339 <li>SDR25 speed</li>
340 <li>SDR50 speed</li>
341 <li>SDR104 speed</li>
342 <li>DDR50 speed</li>
343 <li>Power off</li>
344 <li>Uninitialize </li>
345 </ul>
346
347 </div>
348 </div>
349 </div><!-- contents -->
350 </div><!-- doc-content -->
351 <!-- start footer part -->
352 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
353   <ul>
354     <li class="footer">Generated on Mon Dec 2 2019 12:02:23 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
355         <!--
356     <a href="http://www.doxygen.org/index.html">
357     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
358         -->
359         </li>
360   </ul>
361 </div>
362 </body>
363 </html>