group__sai__frame__control.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  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>SAI Frame</title>
  7. <title>CMSIS-Driver: SAI Frame</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__sai__frame__control.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> </div>
  110. <div class="headertitle">
  111. <div class="title">SAI Frame<div class="ingroups"><a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Defines frame.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  118. Macros</h2></td></tr>
  119. <tr class="memitem:ga4c557aa02c83b8595be23a6c58d284e9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#ga4c557aa02c83b8595be23a6c58d284e9">ARM_SAI_FRAME_LENGTH</a>(n)&#160;&#160;&#160;((((n)-1UL)&amp;0x3FFUL) &lt;&lt; ARM_SAI_FRAME_LENGTH_Pos)</td></tr>
  120. <tr class="memdesc:ga4c557aa02c83b8595be23a6c58d284e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame length in bits (8..1024); default depends on protocol and data. <a href="#ga4c557aa02c83b8595be23a6c58d284e9">More...</a><br/></td></tr>
  121. <tr class="separator:ga4c557aa02c83b8595be23a6c58d284e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gae165fd96e6a5b06b362954fadeabcb7a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#gae165fd96e6a5b06b362954fadeabcb7a">ARM_SAI_FRAME_SYNC_WIDTH</a>(n)&#160;&#160;&#160;((((n)-1UL)&amp;0xFFUL) &lt;&lt; ARM_SAI_FRAME_SYNC_WIDTH_Pos)</td></tr>
  123. <tr class="memdesc:gae165fd96e6a5b06b362954fadeabcb7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame Sync width in bits (1..256); default=1; User Protocol only (ignored otherwise) <a href="#gae165fd96e6a5b06b362954fadeabcb7a">More...</a><br/></td></tr>
  124. <tr class="separator:gae165fd96e6a5b06b362954fadeabcb7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ga7be0326e15d61d6c67febb22f5b14d58"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#ga7be0326e15d61d6c67febb22f5b14d58">ARM_SAI_FRAME_SYNC_POLARITY_HIGH</a>&#160;&#160;&#160;(0UL &lt;&lt; ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td></tr>
  126. <tr class="memdesc:ga7be0326e15d61d6c67febb22f5b14d58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame Sync is active high (default); User Protocol only (ignored otherwise) <a href="#ga7be0326e15d61d6c67febb22f5b14d58">More...</a><br/></td></tr>
  127. <tr class="separator:ga7be0326e15d61d6c67febb22f5b14d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#gaf3d6bdbc05379ac30905cecf1b2d917e">ARM_SAI_FRAME_SYNC_POLARITY_LOW</a>&#160;&#160;&#160;(1UL &lt;&lt; ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td></tr>
  129. <tr class="memdesc:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame Sync is active low; User Protocol only (ignored otherwise) <a href="#gaf3d6bdbc05379ac30905cecf1b2d917e">More...</a><br/></td></tr>
  130. <tr class="separator:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:gabec3992447436a2a8ed99108908ae208"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__frame__control.html#gabec3992447436a2a8ed99108908ae208">ARM_SAI_FRAME_SYNC_EARLY</a>&#160;&#160;&#160;(1UL &lt;&lt; 19)</td></tr>
  132. <tr class="memdesc:gabec3992447436a2a8ed99108908ae208"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame Sync one bit before the first bit of the frame; User Protocol only (ignored otherwise) <a href="#gabec3992447436a2a8ed99108908ae208">More...</a><br/></td></tr>
  133. <tr class="separator:gabec3992447436a2a8ed99108908ae208"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table>
  135. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  136. <p>Defines frame. </p>
  137. <h2 class="groupheader">Macro Definition Documentation</h2>
  138. <a class="anchor" id="ga4c557aa02c83b8595be23a6c58d284e9"></a>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">#define ARM_SAI_FRAME_LENGTH</td>
  144. <td>(</td>
  145. <td class="paramtype">&#160;</td>
  146. <td class="paramname">n</td><td>)</td>
  147. <td>&#160;&#160;&#160;((((n)-1UL)&amp;0x3FFUL) &lt;&lt; ARM_SAI_FRAME_LENGTH_Pos)</td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>Frame length in bits (8..1024); default depends on protocol and data. </p>
  152. </div>
  153. </div>
  154. <a class="anchor" id="gae165fd96e6a5b06b362954fadeabcb7a"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">#define ARM_SAI_FRAME_SYNC_WIDTH</td>
  160. <td>(</td>
  161. <td class="paramtype">&#160;</td>
  162. <td class="paramname">n</td><td>)</td>
  163. <td>&#160;&#160;&#160;((((n)-1UL)&amp;0xFFUL) &lt;&lt; ARM_SAI_FRAME_SYNC_WIDTH_Pos)</td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Frame Sync width in bits (1..256); default=1; User Protocol only (ignored otherwise) </p>
  168. </div>
  169. </div>
  170. <a class="anchor" id="ga7be0326e15d61d6c67febb22f5b14d58"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">#define ARM_SAI_FRAME_SYNC_POLARITY_HIGH&#160;&#160;&#160;(0UL &lt;&lt; ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Frame Sync is active high (default); User Protocol only (ignored otherwise) </p>
  180. </div>
  181. </div>
  182. <a class="anchor" id="gaf3d6bdbc05379ac30905cecf1b2d917e"></a>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">#define ARM_SAI_FRAME_SYNC_POLARITY_LOW&#160;&#160;&#160;(1UL &lt;&lt; ARM_SAI_FRAME_SYNC_POLARITY_Pos)</td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Frame Sync is active low; User Protocol only (ignored otherwise) </p>
  192. </div>
  193. </div>
  194. <a class="anchor" id="gabec3992447436a2a8ed99108908ae208"></a>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">#define ARM_SAI_FRAME_SYNC_EARLY&#160;&#160;&#160;(1UL &lt;&lt; 19)</td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Frame Sync one bit before the first bit of the frame; User Protocol only (ignored otherwise) </p>
  204. </div>
  205. </div>
  206. </div><!-- contents -->
  207. </div><!-- doc-content -->
  208. <!-- start footer part -->
  209. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  210. <ul>
  211. <li class="footer">Generated on Thu Apr 9 2020 15:49:15 for CMSIS-Driver Version 2.8.0 by Arm Ltd. All rights reserved.
  212. <!--
  213. <a href="http://www.doxygen.org/index.html">
  214. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  215. -->
  216. </li>
  217. </ul>
  218. </div>
  219. </body>
  220. </html>