group__can__timeseg__ctrls.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  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 Bit Timing Codes</title>
  7. <title>CMSIS-Driver: CAN Bit Timing Codes</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__timeseg__ctrls.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> &#124;
  110. <a href="#enum-members">Enumerations</a> </div>
  111. <div class="headertitle">
  112. <div class="title">CAN Bit Timing Codes<div class="ingroups"><a class="el" href="group__can__control.html">CAN Control Codes</a></div></div> </div>
  113. </div><!--header-->
  114. <div class="contents">
  115. <p>Set bit timing.
  116. <a href="#details">More...</a></p>
  117. <table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  119. Macros</h2></td></tr>
  120. <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>
  121. <tr class="separator:ga01183319a5a899eafea9ffe7af73d5ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:ga03f1921ee97a7ebf5d767b6cacf40792"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:ga76de056d56803cb7a0d01978ee981e80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:gab32e97fa4edf497c111dd3f0d8779269"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table><table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  130. Enumerations</h2></td></tr>
  131. <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/>
  132. &#160;&#160;<a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3">ARM_CAN_BITRATE_NOMINAL</a>,
  133. <br/>
  134. &#160;&#160;<a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc">ARM_CAN_BITRATE_FD_DATA</a>
  135. <br/>
  136. }</td></tr>
  137. <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>
  138. <tr class="separator:ga11c12020b81a63a73a8b53e96a7e3dea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table>
  140. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  141. <p>Set bit timing. </p>
  142. <p>The following codes are used with the function <a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a>. </p>
  143. <h2 class="groupheader">Macro Definition Documentation</h2>
  144. <a class="anchor" id="ga01183319a5a899eafea9ffe7af73d5ea"></a>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">#define ARM_CAN_BIT_PROP_SEG</td>
  150. <td>(</td>
  151. <td class="paramtype">&#160;</td>
  152. <td class="paramname">x</td><td>)</td>
  153. <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>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <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>
  158. </div>
  159. </div>
  160. <a class="anchor" id="ga03f1921ee97a7ebf5d767b6cacf40792"></a>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">#define ARM_CAN_BIT_PHASE_SEG1</td>
  166. <td>(</td>
  167. <td class="paramtype">&#160;</td>
  168. <td class="paramname">x</td><td>)</td>
  169. <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>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <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>
  174. </div>
  175. </div>
  176. <a class="anchor" id="ga76de056d56803cb7a0d01978ee981e80"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">#define ARM_CAN_BIT_PHASE_SEG2</td>
  182. <td>(</td>
  183. <td class="paramtype">&#160;</td>
  184. <td class="paramname">x</td><td>)</td>
  185. <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>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <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>
  190. </div>
  191. </div>
  192. <a class="anchor" id="gab32e97fa4edf497c111dd3f0d8779269"></a>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">#define ARM_CAN_BIT_SJW</td>
  198. <td>(</td>
  199. <td class="paramtype">&#160;</td>
  200. <td class="paramname">x</td><td>)</td>
  201. <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>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <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>
  206. </div>
  207. </div>
  208. <h2 class="groupheader">Enumeration Type Documentation</h2>
  209. <a class="anchor" id="ga11c12020b81a63a73a8b53e96a7e3dea"></a>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">enum <a class="el" href="group__can__timeseg__ctrls.html#ga11c12020b81a63a73a8b53e96a7e3dea">ARM_CAN_BITRATE_SELECT</a></td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>Set the bit rate. </p>
  219. <p>Provides the typedef for setting the bit rate.</p>
  220. <p><b>Parameter for:</b></p>
  221. <ul>
  222. <li><a class="el" href="group__can__interface__gr.html#ga88bb27a8525503a250cca7a2c4a5d07a">ARM_CAN_SetBitrate</a> </li>
  223. </ul>
  224. <table class="fieldtable">
  225. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ga11c12020b81a63a73a8b53e96a7e3deaa3b6d191c99f1eba4f01bcc5fbfaf67f3"></a>ARM_CAN_BITRATE_NOMINAL</em>&#160;</td><td class="fielddoc">
  226. <p>Select nominal (flexible data-rate arbitration) bitrate. </p>
  227. </td></tr>
  228. <tr><td class="fieldname"><em><a class="anchor" id="ga11c12020b81a63a73a8b53e96a7e3deaaa6c9996de0cdf42da5c02086cd8f16dc"></a>ARM_CAN_BITRATE_FD_DATA</em>&#160;</td><td class="fielddoc">
  229. <p>Select flexible data-rate data bitrate. </p>
  230. </td></tr>
  231. </table>
  232. </div>
  233. </div>
  234. </div><!-- contents -->
  235. </div><!-- doc-content -->
  236. <!-- start footer part -->
  237. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  238. <ul>
  239. <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.
  240. <!--
  241. <a href="http://www.doxygen.org/index.html">
  242. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  243. -->
  244. </li>
  245. </ul>
  246. </div>
  247. </body>
  248. </html>