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