begriffs open source - cmsis/blob - main/Driver/group__can__status__code__ctrls.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: CAN Status Error Codes</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Driver
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__can__status__code__ctrls.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">CAN Status Error Codes<div class="ingroups"><a class="el" href="group__can__interface__gr.html">CAN Interface</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Status codes of the CAN driver.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <tr class="memitem:ga911a65cc31304d57d283a21476d9ade7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga911a65cc31304d57d283a21476d9ade7">ARM_CAN_UNIT_STATE_INACTIVE</a>&#160;&#160;&#160;(0U)</td></tr>
 142 <tr class="memdesc:ga911a65cc31304d57d283a21476d9ade7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Not active on bus (initialization)  <br /></td></tr>
 143 <tr class="separator:ga911a65cc31304d57d283a21476d9ade7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga5f72c295ee2b829a8ae33b96466cc0e8">ARM_CAN_UNIT_STATE_ACTIVE</a>&#160;&#160;&#160;(1U)</td></tr>
 145 <tr class="memdesc:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Active on bus (can generate active error frame)  <br /></td></tr>
 146 <tr class="separator:ga5f72c295ee2b829a8ae33b96466cc0e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gace2db0f930f935054c21242f735e1922"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gace2db0f930f935054c21242f735e1922">ARM_CAN_UNIT_STATE_PASSIVE</a>&#160;&#160;&#160;(2U)</td></tr>
 148 <tr class="memdesc:gace2db0f930f935054c21242f735e1922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Error passive (can not generate active error frame)  <br /></td></tr>
 149 <tr class="separator:gace2db0f930f935054c21242f735e1922"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gadd78b515410235cd77d0a10213ff4192"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gadd78b515410235cd77d0a10213ff4192">ARM_CAN_UNIT_STATE_BUS_OFF</a>&#160;&#160;&#160;(3U)</td></tr>
 151 <tr class="memdesc:gadd78b515410235cd77d0a10213ff4192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit state: Bus-off (can recover to active state)  <br /></td></tr>
 152 <tr class="separator:gadd78b515410235cd77d0a10213ff4192"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ga5332a311f44caec256d59087c705e1e9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga5332a311f44caec256d59087c705e1e9">ARM_CAN_LEC_NO_ERROR</a>&#160;&#160;&#160;(0U)</td></tr>
 154 <tr class="memdesc:ga5332a311f44caec256d59087c705e1e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: No error.  <br /></td></tr>
 155 <tr class="separator:ga5332a311f44caec256d59087c705e1e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga0571c3c3e341ac0579aa713fdfdae77e">ARM_CAN_LEC_BIT_ERROR</a>&#160;&#160;&#160;(1U)</td></tr>
 157 <tr class="memdesc:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Bit error.  <br /></td></tr>
 158 <tr class="separator:ga0571c3c3e341ac0579aa713fdfdae77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga33cbda311f4c2f2464e4070dee78b2f2">ARM_CAN_LEC_STUFF_ERROR</a>&#160;&#160;&#160;(2U)</td></tr>
 160 <tr class="memdesc:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Bit stuffing error.  <br /></td></tr>
 161 <tr class="separator:ga33cbda311f4c2f2464e4070dee78b2f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:ga1380f80b709ca921634aecdaf34a24e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga1380f80b709ca921634aecdaf34a24e5">ARM_CAN_LEC_CRC_ERROR</a>&#160;&#160;&#160;(3U)</td></tr>
 163 <tr class="memdesc:ga1380f80b709ca921634aecdaf34a24e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: CRC error.  <br /></td></tr>
 164 <tr class="separator:ga1380f80b709ca921634aecdaf34a24e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#ga9f753ba50045b28653fb3215ec2e4b8a">ARM_CAN_LEC_FORM_ERROR</a>&#160;&#160;&#160;(4U)</td></tr>
 166 <tr class="memdesc:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Illegal fixed-form bit.  <br /></td></tr>
 167 <tr class="separator:ga9f753ba50045b28653fb3215ec2e4b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:gaae6e827242137bc4d8976cd4ba73015f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__status__code__ctrls.html#gaae6e827242137bc4d8976cd4ba73015f">ARM_CAN_LEC_ACK_ERROR</a>&#160;&#160;&#160;(5U)</td></tr>
 169 <tr class="memdesc:gaae6e827242137bc4d8976cd4ba73015f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error code: Acknowledgment error.  <br /></td></tr>
 170 <tr class="separator:gaae6e827242137bc4d8976cd4ba73015f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 </table>
 172 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 173 <p>Status codes of the CAN driver. </p>
 174 <p>The following callback notification unit events are generated: </p>
 175 <h2 class="groupheader">Macro Definition Documentation</h2>
 176 <a id="ga911a65cc31304d57d283a21476d9ade7" name="ga911a65cc31304d57d283a21476d9ade7"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#ga911a65cc31304d57d283a21476d9ade7">&#9670;&#160;</a></span>ARM_CAN_UNIT_STATE_INACTIVE</h2>
 178
 179 <div class="memitem">
 180 <div class="memproto">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">#define ARM_CAN_UNIT_STATE_INACTIVE&#160;&#160;&#160;(0U)</td>
 184         </tr>
 185       </table>
 186 </div><div class="memdoc">
 187
 188 <p>Unit state: Not active on bus (initialization) </p>
 189
 190 </div>
 191 </div>
 192 <a id="ga5f72c295ee2b829a8ae33b96466cc0e8" name="ga5f72c295ee2b829a8ae33b96466cc0e8"></a>
 193 <h2 class="memtitle"><span class="permalink"><a href="#ga5f72c295ee2b829a8ae33b96466cc0e8">&#9670;&#160;</a></span>ARM_CAN_UNIT_STATE_ACTIVE</h2>
 194
 195 <div class="memitem">
 196 <div class="memproto">
 197       <table class="memname">
 198         <tr>
 199           <td class="memname">#define ARM_CAN_UNIT_STATE_ACTIVE&#160;&#160;&#160;(1U)</td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>Unit state: Active on bus (can generate active error frame) </p>
 205
 206 </div>
 207 </div>
 208 <a id="gace2db0f930f935054c21242f735e1922" name="gace2db0f930f935054c21242f735e1922"></a>
 209 <h2 class="memtitle"><span class="permalink"><a href="#gace2db0f930f935054c21242f735e1922">&#9670;&#160;</a></span>ARM_CAN_UNIT_STATE_PASSIVE</h2>
 210
 211 <div class="memitem">
 212 <div class="memproto">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname">#define ARM_CAN_UNIT_STATE_PASSIVE&#160;&#160;&#160;(2U)</td>
 216         </tr>
 217       </table>
 218 </div><div class="memdoc">
 219
 220 <p>Unit state: Error passive (can not generate active error frame) </p>
 221
 222 </div>
 223 </div>
 224 <a id="gadd78b515410235cd77d0a10213ff4192" name="gadd78b515410235cd77d0a10213ff4192"></a>
 225 <h2 class="memtitle"><span class="permalink"><a href="#gadd78b515410235cd77d0a10213ff4192">&#9670;&#160;</a></span>ARM_CAN_UNIT_STATE_BUS_OFF</h2>
 226
 227 <div class="memitem">
 228 <div class="memproto">
 229       <table class="memname">
 230         <tr>
 231           <td class="memname">#define ARM_CAN_UNIT_STATE_BUS_OFF&#160;&#160;&#160;(3U)</td>
 232         </tr>
 233       </table>
 234 </div><div class="memdoc">
 235
 236 <p>Unit state: Bus-off (can recover to active state) </p>
 237
 238 </div>
 239 </div>
 240 <a id="ga5332a311f44caec256d59087c705e1e9" name="ga5332a311f44caec256d59087c705e1e9"></a>
 241 <h2 class="memtitle"><span class="permalink"><a href="#ga5332a311f44caec256d59087c705e1e9">&#9670;&#160;</a></span>ARM_CAN_LEC_NO_ERROR</h2>
 242
 243 <div class="memitem">
 244 <div class="memproto">
 245       <table class="memname">
 246         <tr>
 247           <td class="memname">#define ARM_CAN_LEC_NO_ERROR&#160;&#160;&#160;(0U)</td>
 248         </tr>
 249       </table>
 250 </div><div class="memdoc">
 251
 252 <p>Last error code: No error. </p>
 253
 254 </div>
 255 </div>
 256 <a id="ga0571c3c3e341ac0579aa713fdfdae77e" name="ga0571c3c3e341ac0579aa713fdfdae77e"></a>
 257 <h2 class="memtitle"><span class="permalink"><a href="#ga0571c3c3e341ac0579aa713fdfdae77e">&#9670;&#160;</a></span>ARM_CAN_LEC_BIT_ERROR</h2>
 258
 259 <div class="memitem">
 260 <div class="memproto">
 261       <table class="memname">
 262         <tr>
 263           <td class="memname">#define ARM_CAN_LEC_BIT_ERROR&#160;&#160;&#160;(1U)</td>
 264         </tr>
 265       </table>
 266 </div><div class="memdoc">
 267
 268 <p>Last error code: Bit error. </p>
 269
 270 </div>
 271 </div>
 272 <a id="ga33cbda311f4c2f2464e4070dee78b2f2" name="ga33cbda311f4c2f2464e4070dee78b2f2"></a>
 273 <h2 class="memtitle"><span class="permalink"><a href="#ga33cbda311f4c2f2464e4070dee78b2f2">&#9670;&#160;</a></span>ARM_CAN_LEC_STUFF_ERROR</h2>
 274
 275 <div class="memitem">
 276 <div class="memproto">
 277       <table class="memname">
 278         <tr>
 279           <td class="memname">#define ARM_CAN_LEC_STUFF_ERROR&#160;&#160;&#160;(2U)</td>
 280         </tr>
 281       </table>
 282 </div><div class="memdoc">
 283
 284 <p>Last error code: Bit stuffing error. </p>
 285
 286 </div>
 287 </div>
 288 <a id="ga1380f80b709ca921634aecdaf34a24e5" name="ga1380f80b709ca921634aecdaf34a24e5"></a>
 289 <h2 class="memtitle"><span class="permalink"><a href="#ga1380f80b709ca921634aecdaf34a24e5">&#9670;&#160;</a></span>ARM_CAN_LEC_CRC_ERROR</h2>
 290
 291 <div class="memitem">
 292 <div class="memproto">
 293       <table class="memname">
 294         <tr>
 295           <td class="memname">#define ARM_CAN_LEC_CRC_ERROR&#160;&#160;&#160;(3U)</td>
 296         </tr>
 297       </table>
 298 </div><div class="memdoc">
 299
 300 <p>Last error code: CRC error. </p>
 301
 302 </div>
 303 </div>
 304 <a id="ga9f753ba50045b28653fb3215ec2e4b8a" name="ga9f753ba50045b28653fb3215ec2e4b8a"></a>
 305 <h2 class="memtitle"><span class="permalink"><a href="#ga9f753ba50045b28653fb3215ec2e4b8a">&#9670;&#160;</a></span>ARM_CAN_LEC_FORM_ERROR</h2>
 306
 307 <div class="memitem">
 308 <div class="memproto">
 309       <table class="memname">
 310         <tr>
 311           <td class="memname">#define ARM_CAN_LEC_FORM_ERROR&#160;&#160;&#160;(4U)</td>
 312         </tr>
 313       </table>
 314 </div><div class="memdoc">
 315
 316 <p>Last error code: Illegal fixed-form bit. </p>
 317
 318 </div>
 319 </div>
 320 <a id="gaae6e827242137bc4d8976cd4ba73015f" name="gaae6e827242137bc4d8976cd4ba73015f"></a>
 321 <h2 class="memtitle"><span class="permalink"><a href="#gaae6e827242137bc4d8976cd4ba73015f">&#9670;&#160;</a></span>ARM_CAN_LEC_ACK_ERROR</h2>
 322
 323 <div class="memitem">
 324 <div class="memproto">
 325       <table class="memname">
 326         <tr>
 327           <td class="memname">#define ARM_CAN_LEC_ACK_ERROR&#160;&#160;&#160;(5U)</td>
 328         </tr>
 329       </table>
 330 </div><div class="memdoc">
 331
 332 <p>Last error code: Acknowledgment error. </p>
 333
 334 </div>
 335 </div>
 336 </div><!-- contents -->
 337 </div><!-- doc-content -->
 338 <!-- start footer part -->
 339 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 340   <ul>
 341     <li class="footer">
 342       <script type="text/javascript">
 343         <!--
 344         writeFooter.call(this);
 345         //-->
 346       </script>
 347     </li>
 348   </ul>
 349 </div>
 350 </body>
 351 </html>