group__sai__protocol__control.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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 Protocol</title>
  7. <title>CMSIS-Driver: SAI Protocol</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.7.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__protocol__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 Protocol<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 Transmitter/Receiver protocol.
  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:gacef87941052c21ebacd3dde6ce9d6925"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gacef87941052c21ebacd3dde6ce9d6925">ARM_SAI_PROTOCOL_USER</a>&#160;&#160;&#160;(0U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td></tr>
  120. <tr class="memdesc:gacef87941052c21ebacd3dde6ce9d6925"><td class="mdescLeft">&#160;</td><td class="mdescRight">User defined (default) <a href="#gacef87941052c21ebacd3dde6ce9d6925">More...</a><br/></td></tr>
  121. <tr class="separator:gacef87941052c21ebacd3dde6ce9d6925"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gaaaf423bbe59920b3c7813e22ce083ddc">ARM_SAI_PROTOCOL_I2S</a>&#160;&#160;&#160;(1U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td></tr>
  123. <tr class="memdesc:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S. <a href="#gaaaf423bbe59920b3c7813e22ce083ddc">More...</a><br/></td></tr>
  124. <tr class="separator:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:gad931f9e8aedff4e6040d726d707862f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gad931f9e8aedff4e6040d726d707862f0">ARM_SAI_PROTOCOL_MSB_JUSTIFIED</a>&#160;&#160;&#160;(2U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td></tr>
  126. <tr class="memdesc:gad931f9e8aedff4e6040d726d707862f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">MSB (left) justified. <a href="#gad931f9e8aedff4e6040d726d707862f0">More...</a><br/></td></tr>
  127. <tr class="separator:gad931f9e8aedff4e6040d726d707862f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gab88b6f9b61a20927ac8f8d39e46c6349">ARM_SAI_PROTOCOL_LSB_JUSTIFIED</a>&#160;&#160;&#160;(3U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td></tr>
  129. <tr class="memdesc:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="mdescLeft">&#160;</td><td class="mdescRight">LSB (right) justified. <a href="#gab88b6f9b61a20927ac8f8d39e46c6349">More...</a><br/></td></tr>
  130. <tr class="separator:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga3762437e0b1402b5d4fd293ae745f103"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#ga3762437e0b1402b5d4fd293ae745f103">ARM_SAI_PROTOCOL_PCM_SHORT</a>&#160;&#160;&#160;(4U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td></tr>
  132. <tr class="memdesc:ga3762437e0b1402b5d4fd293ae745f103"><td class="mdescLeft">&#160;</td><td class="mdescRight">PCM with short frame. <a href="#ga3762437e0b1402b5d4fd293ae745f103">More...</a><br/></td></tr>
  133. <tr class="separator:ga3762437e0b1402b5d4fd293ae745f103"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:gad43530c5b6ae1e89db587b20d71440b4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#gad43530c5b6ae1e89db587b20d71440b4">ARM_SAI_PROTOCOL_PCM_LONG</a>&#160;&#160;&#160;(5U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td></tr>
  135. <tr class="memdesc:gad43530c5b6ae1e89db587b20d71440b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">PCM with long frame. <a href="#gad43530c5b6ae1e89db587b20d71440b4">More...</a><br/></td></tr>
  136. <tr class="separator:gad43530c5b6ae1e89db587b20d71440b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__protocol__control.html#ga8b1669910f4db4bb3584543e7eb04d7a">ARM_SAI_PROTOCOL_AC97</a>&#160;&#160;&#160;(6U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td></tr>
  138. <tr class="memdesc:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">AC'97. <a href="#ga8b1669910f4db4bb3584543e7eb04d7a">More...</a><br/></td></tr>
  139. <tr class="separator:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table>
  141. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  142. <p>Defines Transmitter/Receiver protocol. </p>
  143. <h2 class="groupheader">Macro Definition Documentation</h2>
  144. <a class="anchor" id="gacef87941052c21ebacd3dde6ce9d6925"></a>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">#define ARM_SAI_PROTOCOL_USER&#160;&#160;&#160;(0U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>User defined (default) </p>
  154. </div>
  155. </div>
  156. <a class="anchor" id="gaaaf423bbe59920b3c7813e22ce083ddc"></a>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">#define ARM_SAI_PROTOCOL_I2S&#160;&#160;&#160;(1U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>I2S. </p>
  166. </div>
  167. </div>
  168. <a class="anchor" id="gad931f9e8aedff4e6040d726d707862f0"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">#define ARM_SAI_PROTOCOL_MSB_JUSTIFIED&#160;&#160;&#160;(2U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>MSB (left) justified. </p>
  178. </div>
  179. </div>
  180. <a class="anchor" id="gab88b6f9b61a20927ac8f8d39e46c6349"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">#define ARM_SAI_PROTOCOL_LSB_JUSTIFIED&#160;&#160;&#160;(3U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>LSB (right) justified. </p>
  190. </div>
  191. </div>
  192. <a class="anchor" id="ga3762437e0b1402b5d4fd293ae745f103"></a>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">#define ARM_SAI_PROTOCOL_PCM_SHORT&#160;&#160;&#160;(4U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>PCM with short frame. </p>
  202. </div>
  203. </div>
  204. <a class="anchor" id="gad43530c5b6ae1e89db587b20d71440b4"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">#define ARM_SAI_PROTOCOL_PCM_LONG&#160;&#160;&#160;(5U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>PCM with long frame. </p>
  214. </div>
  215. </div>
  216. <a class="anchor" id="ga8b1669910f4db4bb3584543e7eb04d7a"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">#define ARM_SAI_PROTOCOL_AC97&#160;&#160;&#160;(6U &lt;&lt; ARM_SAI_PROTOCOL_Pos)</td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>AC'97. </p>
  226. </div>
  227. </div>
  228. </div><!-- contents -->
  229. </div><!-- doc-content -->
  230. <!-- start footer part -->
  231. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  232. <ul>
  233. <li class="footer">Generated on Mon Mar 18 2019 16:05:36 for CMSIS-Driver by Arm Ltd. All rights reserved.
  234. <!--
  235. <a href="http://www.doxygen.org/index.html">
  236. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  237. -->
  238. </li>
  239. </ul>
  240. </div>
  241. </body>
  242. </html>