]> begriffs open source - cmsis-driver-validation/blob - docs/html/group__can__tests.html
Merge branch 'develop'
[cmsis-driver-validation] / docs / html / group__can__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 2.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__can__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>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="#func-members">Functions</a>  </div>
113   <div class="headertitle">
114 <div class="title">Tests<div class="ingroups"><a class="el" href="group__dv__can.html">CAN 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:ga4d770ed38d9ceffea0efa93647ae3bd5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#ga4d770ed38d9ceffea0efa93647ae3bd5">CAN_GetCapabilities</a> (void)</td></tr>
121 <tr class="memdesc:ga4d770ed38d9ceffea0efa93647ae3bd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_GetCapabilities.  <a href="#ga4d770ed38d9ceffea0efa93647ae3bd5">More...</a><br/></td></tr>
122 <tr class="separator:ga4d770ed38d9ceffea0efa93647ae3bd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 <tr class="memitem:ga4c93a718e622e8dd98ecdd6f892b793f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#ga4c93a718e622e8dd98ecdd6f892b793f">CAN_Initialization</a> (void)</td></tr>
124 <tr class="memdesc:ga4c93a718e622e8dd98ecdd6f892b793f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_Initialization.  <a href="#ga4c93a718e622e8dd98ecdd6f892b793f">More...</a><br/></td></tr>
125 <tr class="separator:ga4c93a718e622e8dd98ecdd6f892b793f"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 <tr class="memitem:ga9eb648cf67e1004f73cbd8222a7fe870"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#ga9eb648cf67e1004f73cbd8222a7fe870">CAN_CheckInvalidInit</a> (void)</td></tr>
127 <tr class="memdesc:ga9eb648cf67e1004f73cbd8222a7fe870"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_CheckInvalidInit.  <a href="#ga9eb648cf67e1004f73cbd8222a7fe870">More...</a><br/></td></tr>
128 <tr class="separator:ga9eb648cf67e1004f73cbd8222a7fe870"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <tr class="memitem:ga24ea6e524e87e05af02b52f5896f0db7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#ga24ea6e524e87e05af02b52f5896f0db7">CAN_PowerControl</a> (void)</td></tr>
130 <tr class="memdesc:ga24ea6e524e87e05af02b52f5896f0db7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_PowerControl.  <a href="#ga24ea6e524e87e05af02b52f5896f0db7">More...</a><br/></td></tr>
131 <tr class="separator:ga24ea6e524e87e05af02b52f5896f0db7"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 <tr class="memitem:ga495f70c896f1720d5ebb7cc716cf06a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#ga495f70c896f1720d5ebb7cc716cf06a3">CAN_Loopback_CheckBitrate</a> (void)</td></tr>
133 <tr class="memdesc:ga495f70c896f1720d5ebb7cc716cf06a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_Loopback_CheckBitrate.  <a href="#ga495f70c896f1720d5ebb7cc716cf06a3">More...</a><br/></td></tr>
134 <tr class="separator:ga495f70c896f1720d5ebb7cc716cf06a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:gaf76073c1c77f6633296c33750dac77d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#gaf76073c1c77f6633296c33750dac77d1">CAN_Loopback_CheckBitrateFD</a> (void)</td></tr>
136 <tr class="memdesc:gaf76073c1c77f6633296c33750dac77d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_Loopback_CheckBitrateFD.  <a href="#gaf76073c1c77f6633296c33750dac77d1">More...</a><br/></td></tr>
137 <tr class="separator:gaf76073c1c77f6633296c33750dac77d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:ga4e4d206b95ce1b46d37c246f20ff9390"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#ga4e4d206b95ce1b46d37c246f20ff9390">CAN_Loopback_Transfer</a> (void)</td></tr>
139 <tr class="memdesc:ga4e4d206b95ce1b46d37c246f20ff9390"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_Loopback_Transfer.  <a href="#ga4e4d206b95ce1b46d37c246f20ff9390">More...</a><br/></td></tr>
140 <tr class="separator:ga4e4d206b95ce1b46d37c246f20ff9390"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:gad619f0a6a779d4a069d381b95ef60521"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__tests.html#gad619f0a6a779d4a069d381b95ef60521">CAN_Loopback_TransferFD</a> (void)</td></tr>
142 <tr class="memdesc:gad619f0a6a779d4a069d381b95ef60521"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function: CAN_Loopback_TransferFD.  <a href="#gad619f0a6a779d4a069d381b95ef60521">More...</a><br/></td></tr>
143 <tr class="separator:gad619f0a6a779d4a069d381b95ef60521"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 </table>
145 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
146 <h2 class="groupheader">Function Documentation</h2>
147 <a class="anchor" id="ga4d770ed38d9ceffea0efa93647ae3bd5"></a>
148 <div class="memitem">
149 <div class="memproto">
150       <table class="memname">
151         <tr>
152           <td class="memname">void CAN_GetCapabilities </td>
153           <td>(</td>
154           <td class="paramtype">void&#160;</td>
155           <td class="paramname"></td><td>)</td>
156           <td></td>
157         </tr>
158       </table>
159 </div><div class="memdoc">
160 <p>The test function <b>CAN_GetCapabilities</b> verifies the function <b>GetCapabilities</b>. </p>
161
162 </div>
163 </div>
164 <a class="anchor" id="ga4c93a718e622e8dd98ecdd6f892b793f"></a>
165 <div class="memitem">
166 <div class="memproto">
167       <table class="memname">
168         <tr>
169           <td class="memname">void CAN_Initialization </td>
170           <td>(</td>
171           <td class="paramtype">void&#160;</td>
172           <td class="paramname"></td><td>)</td>
173           <td></td>
174         </tr>
175       </table>
176 </div><div class="memdoc">
177 <p>The test function <b>CAN_Initialization</b> verifies the CAN functions with the sequence:</p>
178 <ul>
179 <li>Initialize without callback</li>
180 <li>Uninitialize</li>
181 <li>Initialize with callback</li>
182 <li>Uninitialize </li>
183 </ul>
184
185 </div>
186 </div>
187 <a class="anchor" id="ga9eb648cf67e1004f73cbd8222a7fe870"></a>
188 <div class="memitem">
189 <div class="memproto">
190       <table class="memname">
191         <tr>
192           <td class="memname">void CAN_CheckInvalidInit </td>
193           <td>(</td>
194           <td class="paramtype">void&#160;</td>
195           <td class="paramname"></td><td>)</td>
196           <td></td>
197         </tr>
198       </table>
199 </div><div class="memdoc">
200 <p>The test function <b>CAN_CheckInvalidInit</b> verifies the driver behaviour when receiving an invalid initialization sequence:</p>
201 <ul>
202 <li>Uninitialize</li>
203 <li>PowerControl with Power off</li>
204 <li>PowerControl with Power on</li>
205 <li>Set Mode</li>
206 <li>PowerControl with Power off</li>
207 <li>Uninitialize </li>
208 </ul>
209
210 </div>
211 </div>
212 <a class="anchor" id="ga24ea6e524e87e05af02b52f5896f0db7"></a>
213 <div class="memitem">
214 <div class="memproto">
215       <table class="memname">
216         <tr>
217           <td class="memname">void CAN_PowerControl </td>
218           <td>(</td>
219           <td class="paramtype">void&#160;</td>
220           <td class="paramname"></td><td>)</td>
221           <td></td>
222         </tr>
223       </table>
224 </div><div class="memdoc">
225 <p>The test function <b>CAN_PowerControl</b> verifies the <b>PowerControl</b> function with the sequence:</p>
226 <ul>
227 <li>Initialize</li>
228 <li>Power on</li>
229 <li>Power low</li>
230 <li>Power off</li>
231 <li>Uninitialize </li>
232 </ul>
233
234 </div>
235 </div>
236 <a class="anchor" id="ga495f70c896f1720d5ebb7cc716cf06a3"></a>
237 <div class="memitem">
238 <div class="memproto">
239       <table class="memname">
240         <tr>
241           <td class="memname">void CAN_Loopback_CheckBitrate </td>
242           <td>(</td>
243           <td class="paramtype">void&#160;</td>
244           <td class="paramname"></td><td>)</td>
245           <td></td>
246         </tr>
247       </table>
248 </div><div class="memdoc">
249 <p>The test function <b>CAN_Loopback_CheckBitrate</b> verifies different bitrates with the sequence:</p>
250 <ul>
251 <li>Initialize</li>
252 <li>Power on</li>
253 <li>Change bitrate</li>
254 <li>Transfer and measure transfer time</li>
255 <li>Check received data against sent data</li>
256 <li>Power off</li>
257 <li>Uninitialize </li>
258 </ul>
259
260 </div>
261 </div>
262 <a class="anchor" id="gaf76073c1c77f6633296c33750dac77d1"></a>
263 <div class="memitem">
264 <div class="memproto">
265       <table class="memname">
266         <tr>
267           <td class="memname">void CAN_Loopback_CheckBitrateFD </td>
268           <td>(</td>
269           <td class="paramtype">void&#160;</td>
270           <td class="paramname"></td><td>)</td>
271           <td></td>
272         </tr>
273       </table>
274 </div><div class="memdoc">
275 <p>The test function <b>CAN_Loopback_CheckBitrateFD</b> verifies different bitrates with the sequence:</p>
276 <ul>
277 <li>Initialize</li>
278 <li>Power on</li>
279 <li>Change bitrate</li>
280 <li>Transfer and measure transfer time</li>
281 <li>Check received data against sent data</li>
282 <li>Power off</li>
283 <li>Uninitialize </li>
284 </ul>
285
286 </div>
287 </div>
288 <a class="anchor" id="ga4e4d206b95ce1b46d37c246f20ff9390"></a>
289 <div class="memitem">
290 <div class="memproto">
291       <table class="memname">
292         <tr>
293           <td class="memname">void CAN_Loopback_Transfer </td>
294           <td>(</td>
295           <td class="paramtype">void&#160;</td>
296           <td class="paramname"></td><td>)</td>
297           <td></td>
298         </tr>
299       </table>
300 </div><div class="memdoc">
301 <p>The test function <b>CAN_Loopback_Transfer</b> verifies the data transfers with the sequence:</p>
302 <ul>
303 <li>Initialize</li>
304 <li>Power on</li>
305 <li>Set filter with standard ID</li>
306 <li>Transfer and check received data against sent data</li>
307 <li>Check filter with standard ID and remove it</li>
308 <li>Set filter with extended ID</li>
309 <li>Transfer and check received data against sent data</li>
310 <li>Check filter with extended ID and remove it</li>
311 <li>Power off</li>
312 <li>Uninitialize </li>
313 </ul>
314
315 </div>
316 </div>
317 <a class="anchor" id="gad619f0a6a779d4a069d381b95ef60521"></a>
318 <div class="memitem">
319 <div class="memproto">
320       <table class="memname">
321         <tr>
322           <td class="memname">void CAN_Loopback_TransferFD </td>
323           <td>(</td>
324           <td class="paramtype">void&#160;</td>
325           <td class="paramname"></td><td>)</td>
326           <td></td>
327         </tr>
328       </table>
329 </div><div class="memdoc">
330 <p>The test function <b>CAN_Loopback_TransferFD</b> verifies the data transfers with the sequence:</p>
331 <ul>
332 <li>Initialize</li>
333 <li>Power on</li>
334 <li>Set filter with standard ID</li>
335 <li>Transfer and check received data against sent data</li>
336 <li>Check filter with standard ID and remove it</li>
337 <li>Set filter with extended ID</li>
338 <li>Transfer and check received data against sent data</li>
339 <li>Check filter with extended ID and remove it</li>
340 <li>Power off</li>
341 <li>Uninitialize </li>
342 </ul>
343
344 </div>
345 </div>
346 </div><!-- contents -->
347 </div><!-- doc-content -->
348 <!-- start footer part -->
349 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
350   <ul>
351     <li class="footer">Generated on Wed Jul 15 2020 10:47:11 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
352         <!--
353     <a href="http://www.doxygen.org/index.html">
354     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
355         -->
356         </li>
357   </ul>
358 </div>
359 </body>
360 </html>