begriffs open source - cmsis/blob - main/Driver/group__CAN__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 Object 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__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 Object 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 objects events notified via <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</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:ga486f0f35ebc7e3b5931ee68b56703503"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__events.html#ga486f0f35ebc7e3b5931ee68b56703503">ARM_CAN_EVENT_SEND_COMPLETE</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
 139 <tr class="memdesc:ga486f0f35ebc7e3b5931ee68b56703503"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send complete.  <br /></td></tr>
 140 <tr class="separator:ga486f0f35ebc7e3b5931ee68b56703503"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ga2c1082561eeae3b2b8132e81fc241e47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__events.html#ga2c1082561eeae3b2b8132e81fc241e47">ARM_CAN_EVENT_RECEIVE</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
 142 <tr class="memdesc:ga2c1082561eeae3b2b8132e81fc241e47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message received.  <br /></td></tr>
 143 <tr class="separator:ga2c1082561eeae3b2b8132e81fc241e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga6c2d29b5c49d5cd18e97f5931157a94c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CAN__events.html#ga6c2d29b5c49d5cd18e97f5931157a94c">ARM_CAN_EVENT_RECEIVE_OVERRUN</a>&#160;&#160;&#160;(1UL &lt;&lt; 2)</td></tr>
 145 <tr class="memdesc:ga6c2d29b5c49d5cd18e97f5931157a94c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Received message overrun.  <br /></td></tr>
 146 <tr class="separator:ga6c2d29b5c49d5cd18e97f5931157a94c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 </table>
 148 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 149 <p>Callback objects events notified via <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a>. </p>
 150 <p>The CAN driver generates callback objects events that are notified via the function <a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a>.</p>
 151 <p>The following callback notification object events are generated: </p>
 152 <h2 class="groupheader">Macro Definition Documentation</h2>
 153 <a id="ga486f0f35ebc7e3b5931ee68b56703503" name="ga486f0f35ebc7e3b5931ee68b56703503"></a>
 154 <h2 class="memtitle"><span class="permalink"><a href="#ga486f0f35ebc7e3b5931ee68b56703503">&#9670;&#160;</a></span>ARM_CAN_EVENT_SEND_COMPLETE</h2>
 155
 156 <div class="memitem">
 157 <div class="memproto">
 158       <table class="memname">
 159         <tr>
 160           <td class="memname">#define ARM_CAN_EVENT_SEND_COMPLETE&#160;&#160;&#160;(1UL &lt;&lt; 0)</td>
 161         </tr>
 162       </table>
 163 </div><div class="memdoc">
 164
 165 <p>Send complete. </p>
 166 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> </dd></dl>
 167
 168 </div>
 169 </div>
 170 <a id="ga2c1082561eeae3b2b8132e81fc241e47" name="ga2c1082561eeae3b2b8132e81fc241e47"></a>
 171 <h2 class="memtitle"><span class="permalink"><a href="#ga2c1082561eeae3b2b8132e81fc241e47">&#9670;&#160;</a></span>ARM_CAN_EVENT_RECEIVE</h2>
 172
 173 <div class="memitem">
 174 <div class="memproto">
 175       <table class="memname">
 176         <tr>
 177           <td class="memname">#define ARM_CAN_EVENT_RECEIVE&#160;&#160;&#160;(1UL &lt;&lt; 1)</td>
 178         </tr>
 179       </table>
 180 </div><div class="memdoc">
 181
 182 <p>Message received. </p>
 183 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> </dd></dl>
 184
 185 </div>
 186 </div>
 187 <a id="ga6c2d29b5c49d5cd18e97f5931157a94c" name="ga6c2d29b5c49d5cd18e97f5931157a94c"></a>
 188 <h2 class="memtitle"><span class="permalink"><a href="#ga6c2d29b5c49d5cd18e97f5931157a94c">&#9670;&#160;</a></span>ARM_CAN_EVENT_RECEIVE_OVERRUN</h2>
 189
 190 <div class="memitem">
 191 <div class="memproto">
 192       <table class="memname">
 193         <tr>
 194           <td class="memname">#define ARM_CAN_EVENT_RECEIVE_OVERRUN&#160;&#160;&#160;(1UL &lt;&lt; 2)</td>
 195         </tr>
 196       </table>
 197 </div><div class="memdoc">
 198
 199 <p>Received message overrun. </p>
 200 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#gabfcaeac9e2ca25936ba5a29f2d594e7e">ARM_CAN_SignalObjectEvent</a> </dd></dl>
 201
 202 </div>
 203 </div>
 204 </div><!-- contents -->
 205 </div><!-- doc-content -->
 206 <!-- start footer part -->
 207 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 208   <ul>
 209     <li class="footer">
 210       <script type="text/javascript">
 211         <!--
 212         writeFooter.call(this);
 213         //-->
 214       </script>
 215     </li>
 216   </ul>
 217 </div>
 218 </body>
 219 </html>