group__CAN__unit__events.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  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 Unit Events</title>
  7. <title>CMSIS-Driver: CAN Unit Events</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Driver
  35. &#160;<span id="projectnumber">Version 2.8.0</span>
  36. </div>
  37. <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__CAN__unit__events.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#define-members">Macros</a> </div>
  110. <div class="headertitle">
  111. <div class="title">CAN Unit Events<div class="ingroups"><a class="el" href="group__can__interface__gr.html">CAN Interface</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Callback unit events notified via <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  118. Macros</h2></td></tr>
  119. <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>
  120. <tr class="memdesc:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Inactive state. <a href="#gaa2347c172c8a8f42ac66cb42cd7a08db">More...</a><br/></td></tr>
  121. <tr class="separator:gaa2347c172c8a8f42ac66cb42cd7a08db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="memdesc:ga0e65231ccb20684d7c8eac80385f8c18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Error Active state. <a href="#ga0e65231ccb20684d7c8eac80385f8c18">More...</a><br/></td></tr>
  124. <tr class="separator:ga0e65231ccb20684d7c8eac80385f8c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="memdesc:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Error Warning state (one or both error counters &gt;= 96) <a href="#ga3690f864edd2e124f4f9875fdde9a2eb">More...</a><br/></td></tr>
  127. <tr class="separator:ga3690f864edd2e124f4f9875fdde9a2eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="memdesc:ga9c529d6697fe21e69639224322f8c4b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Error Passive state. <a href="#ga9c529d6697fe21e69639224322f8c4b4">More...</a><br/></td></tr>
  130. <tr class="separator:ga9c529d6697fe21e69639224322f8c4b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <tr class="memdesc:gafa4f992a97b4ca0f079aec2990a69bed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unit entered Bus-off state. <a href="#gafa4f992a97b4ca0f079aec2990a69bed">More...</a><br/></td></tr>
  133. <tr class="separator:gafa4f992a97b4ca0f079aec2990a69bed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table>
  135. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  136. <p>Callback unit events notified via <a class="el" href="group__can__interface__gr.html#ga38795d1ed135ce3bd87f31ef1596bccf">ARM_CAN_SignalUnitEvent</a>. </p>
  137. <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>
  138. <p>The following callback notification unit events are generated: </p>
  139. <h2 class="groupheader">Macro Definition Documentation</h2>
  140. <a class="anchor" id="gaa2347c172c8a8f42ac66cb42cd7a08db"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">#define ARM_CAN_EVENT_UNIT_INACTIVE&#160;&#160;&#160;(0U)</td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Unit entered Inactive state. </p>
  150. <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>
  151. </div>
  152. </div>
  153. <a class="anchor" id="ga0e65231ccb20684d7c8eac80385f8c18"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">#define ARM_CAN_EVENT_UNIT_ACTIVE&#160;&#160;&#160;(1U)</td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Unit entered Error Active state. </p>
  163. <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>
  164. </div>
  165. </div>
  166. <a class="anchor" id="ga3690f864edd2e124f4f9875fdde9a2eb"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">#define ARM_CAN_EVENT_UNIT_WARNING&#160;&#160;&#160;(2U)</td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Unit entered Error Warning state (one or both error counters &gt;= 96) </p>
  176. <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>
  177. </div>
  178. </div>
  179. <a class="anchor" id="ga9c529d6697fe21e69639224322f8c4b4"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">#define ARM_CAN_EVENT_UNIT_PASSIVE&#160;&#160;&#160;(3U)</td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Unit entered Error Passive 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. </div>
  191. </div>
  192. <a class="anchor" id="gafa4f992a97b4ca0f079aec2990a69bed"></a>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">#define ARM_CAN_EVENT_UNIT_BUS_OFF&#160;&#160;&#160;(4U)</td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Unit entered Bus-off state. </p>
  202. <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>
  203. </div>
  204. </div>
  205. </div><!-- contents -->
  206. </div><!-- doc-content -->
  207. <!-- start footer part -->
  208. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  209. <ul>
  210. <li class="footer">Generated on Thu Apr 9 2020 15:49:14 for CMSIS-Driver Version 2.8.0 by Arm Ltd. All rights reserved.
  211. <!--
  212. <a href="http://www.doxygen.org/index.html">
  213. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  214. -->
  215. </li>
  216. </ul>
  217. </div>
  218. </body>
  219. </html>