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