begriffs open source - cmsis/blob - main/Driver/group__CAN__unit__events.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 Unit Events</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__unit__events.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 Unit Events<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>Callback unit events notified via <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>.
 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:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#gaa2347c172c8a8f42ac66cb42cd7a08db">ARM_CAN_EVENT_UNIT_INACTIVE</a>&#160;&#160;&#160;(0U)</td></tr>
 139 <tr class="memdesc:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Inactive state.  <br /></td></tr>
 140 <tr class="separator:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ga0e65231ccb20684d7c8eac80385f8c18"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#ga0e65231ccb20684d7c8eac80385f8c18">ARM_CAN_EVENT_UNIT_ACTIVE</a>&#160;&#160;&#160;(1U)</td></tr>
 142 <tr class="memdesc:ga0e65231ccb20684d7c8eac80385f8c18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Error Active state.  <br /></td></tr>
 143 <tr class="separator:ga0e65231ccb20684d7c8eac80385f8c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#ga3690f864edd2e124f4f9875fdde9a2eb">ARM_CAN_EVENT_UNIT_WARNING</a>&#160;&#160;&#160;(2U)</td></tr>
 145 <tr class="memdesc:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Error Warning state (one or both error counters &gt;= 96)  <br /></td></tr>
 146 <tr class="separator:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga9c529d6697fe21e69639224322f8c4b4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#ga9c529d6697fe21e69639224322f8c4b4">ARM_CAN_EVENT_UNIT_PASSIVE</a>&#160;&#160;&#160;(3U)</td></tr>
 148 <tr class="memdesc:ga9c529d6697fe21e69639224322f8c4b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Error Passive state.  <br /></td></tr>
 149 <tr class="separator:ga9c529d6697fe21e69639224322f8c4b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gafa4f992a97b4ca0f079aec2990a69bed"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__unit__events.html#gafa4f992a97b4ca0f079aec2990a69bed">ARM_CAN_EVENT_UNIT_BUS_OFF</a>&#160;&#160;&#160;(4U)</td></tr>
 151 <tr class="memdesc:gafa4f992a97b4ca0f079aec2990a69bed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Bus-off state.  <br /></td></tr>
 152 <tr class="separator:gafa4f992a97b4ca0f079aec2990a69bed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 155 <p>Callback unit events notified via <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>. </p>
 156 <p>The CAN driver generates callback unit events that are notified via the function <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>.</p>
 157 <p>The following callback notification unit events are generated: </p>
 158 <h2 class="groupheader">Macro Definition Documentation</h2>
 159 <a id="gaa2347c172c8a8f42ac66cb42cd7a08db" name="gaa2347c172c8a8f42ac66cb42cd7a08db"></a>
 160 <h2 class="memtitle"><span class="permalink"><a href="#gaa2347c172c8a8f42ac66cb42cd7a08db">&#9670;&#160;</a></span>ARM_CAN_EVENT_UNIT_INACTIVE</h2>
 161
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname">#define ARM_CAN_EVENT_UNIT_INACTIVE&#160;&#160;&#160;(0U)</td>
 167         </tr>
 168       </table>
 169 </div><div class="memdoc">
 170
 171 <p>Unit entered Inactive state. </p>
 172 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
 173
 174 </div>
 175 </div>
 176 <a id="ga0e65231ccb20684d7c8eac80385f8c18" name="ga0e65231ccb20684d7c8eac80385f8c18"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#ga0e65231ccb20684d7c8eac80385f8c18">&#9670;&#160;</a></span>ARM_CAN_EVENT_UNIT_ACTIVE</h2>
 178
 179 <div class="memitem">
 180 <div class="memproto">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">#define ARM_CAN_EVENT_UNIT_ACTIVE&#160;&#160;&#160;(1U)</td>
 184         </tr>
 185       </table>
 186 </div><div class="memdoc">
 187
 188 <p>Unit entered Error Active state. </p>
 189 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
 190
 191 </div>
 192 </div>
 193 <a id="ga3690f864edd2e124f4f9875fdde9a2eb" name="ga3690f864edd2e124f4f9875fdde9a2eb"></a>
 194 <h2 class="memtitle"><span class="permalink"><a href="#ga3690f864edd2e124f4f9875fdde9a2eb">&#9670;&#160;</a></span>ARM_CAN_EVENT_UNIT_WARNING</h2>
 195
 196 <div class="memitem">
 197 <div class="memproto">
 198       <table class="memname">
 199         <tr>
 200           <td class="memname">#define ARM_CAN_EVENT_UNIT_WARNING&#160;&#160;&#160;(2U)</td>
 201         </tr>
 202       </table>
 203 </div><div class="memdoc">
 204
 205 <p>Unit entered Error Warning state (one or both error counters &gt;= 96) </p>
 206 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
 207
 208 </div>
 209 </div>
 210 <a id="ga9c529d6697fe21e69639224322f8c4b4" name="ga9c529d6697fe21e69639224322f8c4b4"></a>
 211 <h2 class="memtitle"><span class="permalink"><a href="#ga9c529d6697fe21e69639224322f8c4b4">&#9670;&#160;</a></span>ARM_CAN_EVENT_UNIT_PASSIVE</h2>
 212
 213 <div class="memitem">
 214 <div class="memproto">
 215       <table class="memname">
 216         <tr>
 217           <td class="memname">#define ARM_CAN_EVENT_UNIT_PASSIVE&#160;&#160;&#160;(3U)</td>
 218         </tr>
 219       </table>
 220 </div><div class="memdoc">
 221
 222 <p>Unit entered Error Passive state. </p>
 223 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
 224
 225 </div>
 226 </div>
 227 <a id="gafa4f992a97b4ca0f079aec2990a69bed" name="gafa4f992a97b4ca0f079aec2990a69bed"></a>
 228 <h2 class="memtitle"><span class="permalink"><a href="#gafa4f992a97b4ca0f079aec2990a69bed">&#9670;&#160;</a></span>ARM_CAN_EVENT_UNIT_BUS_OFF</h2>
 229
 230 <div class="memitem">
 231 <div class="memproto">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname">#define ARM_CAN_EVENT_UNIT_BUS_OFF&#160;&#160;&#160;(4U)</td>
 235         </tr>
 236       </table>
 237 </div><div class="memdoc">
 238
 239 <p>Unit entered Bus-off state. </p>
 240 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a> </dd></dl>
 241
 242 </div>
 243 </div>
 244 </div><!-- contents -->
 245 </div><!-- doc-content -->
 246 <!-- start footer part -->
 247 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 248   <ul>
 249     <li class="footer">
 250       <script type="text/javascript">
 251         <!--
 252         writeFooter.call(this);
 253         //-->
 254       </script>
 255     </li>
 256   </ul>
 257 </div>
 258 </body>
 259 </html>