begriffs open source - cmsis/blob - main/Driver/html/group__can__mode__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 Operation Codes</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, "CMSIS-Driver");
  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 <!-- 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__mode__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 Operation Codes<div class="ingroups"><a class="el" href="group__can__interface__gr.html">CAN Interface</a> &raquo; <a class="el" href="group__can__control.html">CAN Control Codes</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>Set CAN operation modes.
 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:ga978ab3e8860f644dea780e87b3478ff4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#ga978ab3e8860f644dea780e87b3478ff4">ARM_CAN_SET_FD_MODE</a>&#160;&#160;&#160;(1UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td></tr>
 139 <tr class="memdesc:ga978ab3e8860f644dea780e87b3478ff4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FD operation mode; arg: 0 = disable, 1 = enable.  <br /></td></tr>
 140 <tr class="separator:ga978ab3e8860f644dea780e87b3478ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:gae051a548bf785104a934908360529438"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#gae051a548bf785104a934908360529438">ARM_CAN_ABORT_MESSAGE_SEND</a>&#160;&#160;&#160;(2UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td></tr>
 142 <tr class="memdesc:gae051a548bf785104a934908360529438"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort sending of CAN message; arg = object.  <br /></td></tr>
 143 <tr class="separator:gae051a548bf785104a934908360529438"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga0453b8900ca3a0d5210ffd6a918a78e6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#ga0453b8900ca3a0d5210ffd6a918a78e6">ARM_CAN_CONTROL_RETRANSMISSION</a>&#160;&#160;&#160;(3UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td></tr>
 145 <tr class="memdesc:ga0453b8900ca3a0d5210ffd6a918a78e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/disable automatic retransmission; arg: 0 = disable, 1 = enable (default state)  <br /></td></tr>
 146 <tr class="separator:ga0453b8900ca3a0d5210ffd6a918a78e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga398dd25256e644cd8d6506495a06bde8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__mode__ctrls.html#ga398dd25256e644cd8d6506495a06bde8">ARM_CAN_SET_TRANSCEIVER_DELAY</a>&#160;&#160;&#160;(4UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td></tr>
 148 <tr class="memdesc:ga398dd25256e644cd8d6506495a06bde8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set transceiver delay; arg = delay in time quanta.  <br /></td></tr>
 149 <tr class="separator:ga398dd25256e644cd8d6506495a06bde8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 152 <p>Set CAN operation modes. </p>
 153 <p>These controls set the CAN operation using the function <a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a>. </p>
 154 <h2 class="groupheader">Macro Definition Documentation</h2>
 155 <a id="ga978ab3e8860f644dea780e87b3478ff4" name="ga978ab3e8860f644dea780e87b3478ff4"></a>
 156 <h2 class="memtitle"><span class="permalink"><a href="#ga978ab3e8860f644dea780e87b3478ff4">&#9670;&#160;</a></span>ARM_CAN_SET_FD_MODE</h2>
 157
 158 <div class="memitem">
 159 <div class="memproto">
 160       <table class="memname">
 161         <tr>
 162           <td class="memname">#define ARM_CAN_SET_FD_MODE&#160;&#160;&#160;(1UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td>
 163         </tr>
 164       </table>
 165 </div><div class="memdoc">
 166
 167 <p>Set FD operation mode; arg: 0 = disable, 1 = enable. </p>
 168 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
 169
 170 </div>
 171 </div>
 172 <a id="gae051a548bf785104a934908360529438" name="gae051a548bf785104a934908360529438"></a>
 173 <h2 class="memtitle"><span class="permalink"><a href="#gae051a548bf785104a934908360529438">&#9670;&#160;</a></span>ARM_CAN_ABORT_MESSAGE_SEND</h2>
 174
 175 <div class="memitem">
 176 <div class="memproto">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname">#define ARM_CAN_ABORT_MESSAGE_SEND&#160;&#160;&#160;(2UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td>
 180         </tr>
 181       </table>
 182 </div><div class="memdoc">
 183
 184 <p>Abort sending of CAN message; arg = object. </p>
 185 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
 186
 187 </div>
 188 </div>
 189 <a id="ga0453b8900ca3a0d5210ffd6a918a78e6" name="ga0453b8900ca3a0d5210ffd6a918a78e6"></a>
 190 <h2 class="memtitle"><span class="permalink"><a href="#ga0453b8900ca3a0d5210ffd6a918a78e6">&#9670;&#160;</a></span>ARM_CAN_CONTROL_RETRANSMISSION</h2>
 191
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">#define ARM_CAN_CONTROL_RETRANSMISSION&#160;&#160;&#160;(3UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td>
 197         </tr>
 198       </table>
 199 </div><div class="memdoc">
 200
 201 <p>Enable/disable automatic retransmission; arg: 0 = disable, 1 = enable (default state) </p>
 202 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
 203
 204 </div>
 205 </div>
 206 <a id="ga398dd25256e644cd8d6506495a06bde8" name="ga398dd25256e644cd8d6506495a06bde8"></a>
 207 <h2 class="memtitle"><span class="permalink"><a href="#ga398dd25256e644cd8d6506495a06bde8">&#9670;&#160;</a></span>ARM_CAN_SET_TRANSCEIVER_DELAY</h2>
 208
 209 <div class="memitem">
 210 <div class="memproto">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname">#define ARM_CAN_SET_TRANSCEIVER_DELAY&#160;&#160;&#160;(4UL    &lt;&lt; <a class="el" href="Driver__CAN_8h.html#aba948867397ee2081d82f5c6db5edd4b">ARM_CAN_CONTROL_Pos</a>)</td>
 214         </tr>
 215       </table>
 216 </div><div class="memdoc">
 217
 218 <p>Set transceiver delay; arg = delay in time quanta. </p>
 219 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga8d9f0c5f03a8a81ab062b5aa57e5dea4">ARM_CAN_Control</a> </dd></dl>
 220
 221 </div>
 222 </div>
 223 </div><!-- contents -->
 224 </div><!-- doc-content -->
 225 <!-- start footer part -->
 226 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 227   <ul>
 228     <li class="footer">
 229       <script type="text/javascript">
 230         <!--
 231         writeFooter.call(this);
 232         //-->
 233       </script>
 234     </li>
 235   </ul>
 236 </div>
 237 </body>
 238 </html>