begriffs open source - cmsis/blob - main/Driver/group__can__timeseg__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 Bit Timing 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 <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__timeseg__ctrls.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> &#124;
 132 <a href="#enum-members">Enumerations</a>  </div>
 133   <div class="headertitle"><div class="title">CAN Bit Timing 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>
 134 </div><!--header-->
 135 <div class="contents">
 136
 137 <p>Set bit timing.
 138 <a href="#details">More...</a></p>
 139 <table class="memberdecls">
 140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 141 Macros</h2></td></tr>
 142 <tr class="memitem:ga01183319a5a899eafea9ffe7af73d5ea"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga01183319a5a899eafea9ffe7af73d5ea">ARM_CAN_BIT_PROP_SEG</a>(x)&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#a71e16a70efe5e4b21e5622d2b0cb7889">ARM_CAN_BIT_PROP_SEG_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#a018bef85dc771e75a5d0f017393af01a">ARM_CAN_BIT_PROP_SEG_Msk</a>)</td></tr>
 143 <tr class="separator:ga01183319a5a899eafea9ffe7af73d5ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga03f1921ee97a7ebf5d767b6cacf40792"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga03f1921ee97a7ebf5d767b6cacf40792">ARM_CAN_BIT_PHASE_SEG1</a>(x)&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#a23658b0cb98b00c900857aef64926922">ARM_CAN_BIT_PHASE_SEG1_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#a4a661aa69c2825d9118a97695ba39546">ARM_CAN_BIT_PHASE_SEG1_Msk</a>)</td></tr>
 145 <tr class="separator:ga03f1921ee97a7ebf5d767b6cacf40792"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ga76de056d56803cb7a0d01978ee981e80"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga76de056d56803cb7a0d01978ee981e80">ARM_CAN_BIT_PHASE_SEG2</a>(x)&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#acd52b5921a5ab0ad0b251957a93a5993">ARM_CAN_BIT_PHASE_SEG2_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#ae4df531026a911d53df401a4b9eec89c">ARM_CAN_BIT_PHASE_SEG2_Msk</a>)</td></tr>
 147 <tr class="separator:ga76de056d56803cb7a0d01978ee981e80"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:gab32e97fa4edf497c111dd3f0d8779269"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#gab32e97fa4edf497c111dd3f0d8779269">ARM_CAN_BIT_SJW</a>(x)&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#ac233859cfb244895fa47c02d8df02ee8">ARM_CAN_BIT_SJW_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#ac3af13704609a6b14655f00b3d7ac419">ARM_CAN_BIT_SJW_Msk</a>)</td></tr>
 149 <tr class="separator:gab32e97fa4edf497c111dd3f0d8779269"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table><table class="memberdecls">
 151 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 152 Enumerations</h2></td></tr>
 153 <tr class="memitem:ga11c12020b81a63a73a8b53e96a7e3dea"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a> { <br />
 154 &#160;&#160;<a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a>
 155 , <br />
 156 &#160;&#160;<a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc">ARM_CAN_BITRATE_FD_DATA</a>
 157 <br />
 158  }</td></tr>
 159 <tr class="memdesc:ga11c12020b81a63a73a8b53e96a7e3dea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the bit rate.  <a href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">More...</a><br /></td></tr>
 160 <tr class="separator:ga11c12020b81a63a73a8b53e96a7e3dea"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 </table>
 162 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 163 <p>Set bit timing. </p>
 164 <p>The following codes are used with the function <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a>. </p>
 165 <h2 class="groupheader">Macro Definition Documentation</h2>
 166 <a id="ga01183319a5a899eafea9ffe7af73d5ea" name="ga01183319a5a899eafea9ffe7af73d5ea"></a>
 167 <h2 class="memtitle"><span class="permalink"><a href="#ga01183319a5a899eafea9ffe7af73d5ea">&#9670;&#160;</a></span>ARM_CAN_BIT_PROP_SEG</h2>
 168
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">#define ARM_CAN_BIT_PROP_SEG</td>
 174           <td>(</td>
 175           <td class="paramtype">&#160;</td>
 176           <td class="paramname">x</td><td>)</td>
 177           <td>&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#a71e16a70efe5e4b21e5622d2b0cb7889">ARM_CAN_BIT_PROP_SEG_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#a018bef85dc771e75a5d0f017393af01a">ARM_CAN_BIT_PROP_SEG_Msk</a>)</td>
 178         </tr>
 179       </table>
 180 </div><div class="memdoc">
 181 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
 182
 183 </div>
 184 </div>
 185 <a id="ga03f1921ee97a7ebf5d767b6cacf40792" name="ga03f1921ee97a7ebf5d767b6cacf40792"></a>
 186 <h2 class="memtitle"><span class="permalink"><a href="#ga03f1921ee97a7ebf5d767b6cacf40792">&#9670;&#160;</a></span>ARM_CAN_BIT_PHASE_SEG1</h2>
 187
 188 <div class="memitem">
 189 <div class="memproto">
 190       <table class="memname">
 191         <tr>
 192           <td class="memname">#define ARM_CAN_BIT_PHASE_SEG1</td>
 193           <td>(</td>
 194           <td class="paramtype">&#160;</td>
 195           <td class="paramname">x</td><td>)</td>
 196           <td>&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#a23658b0cb98b00c900857aef64926922">ARM_CAN_BIT_PHASE_SEG1_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#a4a661aa69c2825d9118a97695ba39546">ARM_CAN_BIT_PHASE_SEG1_Msk</a>)</td>
 197         </tr>
 198       </table>
 199 </div><div class="memdoc">
 200 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
 201
 202 </div>
 203 </div>
 204 <a id="ga76de056d56803cb7a0d01978ee981e80" name="ga76de056d56803cb7a0d01978ee981e80"></a>
 205 <h2 class="memtitle"><span class="permalink"><a href="#ga76de056d56803cb7a0d01978ee981e80">&#9670;&#160;</a></span>ARM_CAN_BIT_PHASE_SEG2</h2>
 206
 207 <div class="memitem">
 208 <div class="memproto">
 209       <table class="memname">
 210         <tr>
 211           <td class="memname">#define ARM_CAN_BIT_PHASE_SEG2</td>
 212           <td>(</td>
 213           <td class="paramtype">&#160;</td>
 214           <td class="paramname">x</td><td>)</td>
 215           <td>&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#acd52b5921a5ab0ad0b251957a93a5993">ARM_CAN_BIT_PHASE_SEG2_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#ae4df531026a911d53df401a4b9eec89c">ARM_CAN_BIT_PHASE_SEG2_Msk</a>)</td>
 216         </tr>
 217       </table>
 218 </div><div class="memdoc">
 219 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
 220
 221 </div>
 222 </div>
 223 <a id="gab32e97fa4edf497c111dd3f0d8779269" name="gab32e97fa4edf497c111dd3f0d8779269"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#gab32e97fa4edf497c111dd3f0d8779269">&#9670;&#160;</a></span>ARM_CAN_BIT_SJW</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">#define ARM_CAN_BIT_SJW</td>
 231           <td>(</td>
 232           <td class="paramtype">&#160;</td>
 233           <td class="paramname">x</td><td>)</td>
 234           <td>&#160;&#160;&#160;(((x)     &lt;&lt; <a class="el" href="Driver__CAN_8h.html#ac233859cfb244895fa47c02d8df02ee8">ARM_CAN_BIT_SJW_Pos</a>) &amp; <a class="el" href="Driver__CAN_8h.html#ac3af13704609a6b14655f00b3d7ac419">ARM_CAN_BIT_SJW_Msk</a>)</td>
 235         </tr>
 236       </table>
 237 </div><div class="memdoc">
 238 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </dd></dl>
 239
 240 </div>
 241 </div>
 242 <h2 class="groupheader">Enumeration Type Documentation</h2>
 243 <a id="ga11c12020b81a63a73a8b53e96a7e3dea" name="ga11c12020b81a63a73a8b53e96a7e3dea"></a>
 244 <h2 class="memtitle"><span class="permalink"><a href="#ga11c12020b81a63a73a8b53e96a7e3dea">&#9670;&#160;</a></span>ARM_CAN_BITRATE_SELECT</h2>
 245
 246 <div class="memitem">
 247 <div class="memproto">
 248       <table class="memname">
 249         <tr>
 250           <td class="memname">enum <a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a></td>
 251         </tr>
 252       </table>
 253 </div><div class="memdoc">
 254
 255 <p>Set the bit rate. </p>
 256 <p>Provides the typedef for setting the bit rate.</p>
 257 <p><b>Parameter for:</b></p><ul>
 258 <li><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </li>
 259 </ul>
 260 <table class="fieldtable">
 261 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3" name="ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3"></a>ARM_CAN_BITRATE_NOMINAL&#160;</td><td class="fielddoc"><p>Select nominal (flexible data-rate arbitration) bitrate. </p>
 262 </td></tr>
 263 <tr><td class="fieldname"><a id="ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc" name="ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc"></a>ARM_CAN_BITRATE_FD_DATA&#160;</td><td class="fielddoc"><p>Select flexible data-rate data bitrate. </p>
 264 </td></tr>
 265 </table>
 266
 267 </div>
 268 </div>
 269 </div><!-- contents -->
 270 </div><!-- doc-content -->
 271 <!-- start footer part -->
 272 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 273   <ul>
 274     <li class="footer">
 275       <script type="text/javascript">
 276         <!--
 277         writeFooter.call(this);
 278         //-->
 279       </script>
 280     </li>
 281   </ul>
 282 </div>
 283 </body>
 284 </html>