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