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