begriffs open source - cmsis/blob - main/Driver/group__sai__protocol__control.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: SAI Protocol</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__sai__protocol__control.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>  </div>
 132   <div class="headertitle"><div class="title">SAI Protocol<div class="ingroups"><a class="el" href="group__sai__interface__gr.html">SAI Interface</a> &raquo; <a class="el" href="group__sai__control.html">SAI Control Codes</a> &raquo; <a class="el" href="group__sai__configure__control.html">SAI Configuration</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Defines Transmitter/Receiver protocol.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <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;(0UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td></tr>
 142 <tr class="memdesc:gacef87941052c21ebacd3dde6ce9d6925"><td class="mdescLeft">&#160;</td><td class="mdescRight">User defined (default)  <br /></td></tr>
 143 <tr class="separator:gacef87941052c21ebacd3dde6ce9d6925"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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;(1UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td></tr>
 145 <tr class="memdesc:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S.  <br /></td></tr>
 146 <tr class="separator:gaaaf423bbe59920b3c7813e22ce083ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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;(2UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td></tr>
 148 <tr class="memdesc:gad931f9e8aedff4e6040d726d707862f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">MSB (left) justified.  <br /></td></tr>
 149 <tr class="separator:gad931f9e8aedff4e6040d726d707862f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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;(3UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td></tr>
 151 <tr class="memdesc:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="mdescLeft">&#160;</td><td class="mdescRight">LSB (right) justified.  <br /></td></tr>
 152 <tr class="separator:gab88b6f9b61a20927ac8f8d39e46c6349"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <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;(4UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td></tr>
 154 <tr class="memdesc:ga3762437e0b1402b5d4fd293ae745f103"><td class="mdescLeft">&#160;</td><td class="mdescRight">PCM with short frame.  <br /></td></tr>
 155 <tr class="separator:ga3762437e0b1402b5d4fd293ae745f103"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <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;(5UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td></tr>
 157 <tr class="memdesc:gad43530c5b6ae1e89db587b20d71440b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">PCM with long frame.  <br /></td></tr>
 158 <tr class="separator:gad43530c5b6ae1e89db587b20d71440b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <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;(6UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td></tr>
 160 <tr class="memdesc:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">AC'97.  <br /></td></tr>
 161 <tr class="separator:ga8b1669910f4db4bb3584543e7eb04d7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 </table>
 163 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 164 <p>Defines Transmitter/Receiver protocol. </p>
 165 <h2 class="groupheader">Macro Definition Documentation</h2>
 166 <a id="gacef87941052c21ebacd3dde6ce9d6925" name="gacef87941052c21ebacd3dde6ce9d6925"></a>
 167 <h2 class="memtitle"><span class="permalink"><a href="#gacef87941052c21ebacd3dde6ce9d6925">&#9670;&#160;</a></span>ARM_SAI_PROTOCOL_USER</h2>
 168
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">#define ARM_SAI_PROTOCOL_USER&#160;&#160;&#160;(0UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td>
 174         </tr>
 175       </table>
 176 </div><div class="memdoc">
 177
 178 <p>User defined (default) </p>
 179
 180 </div>
 181 </div>
 182 <a id="gaaaf423bbe59920b3c7813e22ce083ddc" name="gaaaf423bbe59920b3c7813e22ce083ddc"></a>
 183 <h2 class="memtitle"><span class="permalink"><a href="#gaaaf423bbe59920b3c7813e22ce083ddc">&#9670;&#160;</a></span>ARM_SAI_PROTOCOL_I2S</h2>
 184
 185 <div class="memitem">
 186 <div class="memproto">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname">#define ARM_SAI_PROTOCOL_I2S&#160;&#160;&#160;(1UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td>
 190         </tr>
 191       </table>
 192 </div><div class="memdoc">
 193
 194 <p>I2S. </p>
 195
 196 </div>
 197 </div>
 198 <a id="gad931f9e8aedff4e6040d726d707862f0" name="gad931f9e8aedff4e6040d726d707862f0"></a>
 199 <h2 class="memtitle"><span class="permalink"><a href="#gad931f9e8aedff4e6040d726d707862f0">&#9670;&#160;</a></span>ARM_SAI_PROTOCOL_MSB_JUSTIFIED</h2>
 200
 201 <div class="memitem">
 202 <div class="memproto">
 203       <table class="memname">
 204         <tr>
 205           <td class="memname">#define ARM_SAI_PROTOCOL_MSB_JUSTIFIED&#160;&#160;&#160;(2UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 <p>MSB (left) justified. </p>
 211
 212 </div>
 213 </div>
 214 <a id="gab88b6f9b61a20927ac8f8d39e46c6349" name="gab88b6f9b61a20927ac8f8d39e46c6349"></a>
 215 <h2 class="memtitle"><span class="permalink"><a href="#gab88b6f9b61a20927ac8f8d39e46c6349">&#9670;&#160;</a></span>ARM_SAI_PROTOCOL_LSB_JUSTIFIED</h2>
 216
 217 <div class="memitem">
 218 <div class="memproto">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname">#define ARM_SAI_PROTOCOL_LSB_JUSTIFIED&#160;&#160;&#160;(3UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 <p>LSB (right) justified. </p>
 227
 228 </div>
 229 </div>
 230 <a id="ga3762437e0b1402b5d4fd293ae745f103" name="ga3762437e0b1402b5d4fd293ae745f103"></a>
 231 <h2 class="memtitle"><span class="permalink"><a href="#ga3762437e0b1402b5d4fd293ae745f103">&#9670;&#160;</a></span>ARM_SAI_PROTOCOL_PCM_SHORT</h2>
 232
 233 <div class="memitem">
 234 <div class="memproto">
 235       <table class="memname">
 236         <tr>
 237           <td class="memname">#define ARM_SAI_PROTOCOL_PCM_SHORT&#160;&#160;&#160;(4UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td>
 238         </tr>
 239       </table>
 240 </div><div class="memdoc">
 241
 242 <p>PCM with short frame. </p>
 243
 244 </div>
 245 </div>
 246 <a id="gad43530c5b6ae1e89db587b20d71440b4" name="gad43530c5b6ae1e89db587b20d71440b4"></a>
 247 <h2 class="memtitle"><span class="permalink"><a href="#gad43530c5b6ae1e89db587b20d71440b4">&#9670;&#160;</a></span>ARM_SAI_PROTOCOL_PCM_LONG</h2>
 248
 249 <div class="memitem">
 250 <div class="memproto">
 251       <table class="memname">
 252         <tr>
 253           <td class="memname">#define ARM_SAI_PROTOCOL_PCM_LONG&#160;&#160;&#160;(5UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td>
 254         </tr>
 255       </table>
 256 </div><div class="memdoc">
 257
 258 <p>PCM with long frame. </p>
 259
 260 </div>
 261 </div>
 262 <a id="ga8b1669910f4db4bb3584543e7eb04d7a" name="ga8b1669910f4db4bb3584543e7eb04d7a"></a>
 263 <h2 class="memtitle"><span class="permalink"><a href="#ga8b1669910f4db4bb3584543e7eb04d7a">&#9670;&#160;</a></span>ARM_SAI_PROTOCOL_AC97</h2>
 264
 265 <div class="memitem">
 266 <div class="memproto">
 267       <table class="memname">
 268         <tr>
 269           <td class="memname">#define ARM_SAI_PROTOCOL_AC97&#160;&#160;&#160;(6UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a9d46c20d74fc28cd23c61efec5d7e264">ARM_SAI_PROTOCOL_Pos</a>)</td>
 270         </tr>
 271       </table>
 272 </div><div class="memdoc">
 273
 274 <p>AC'97. </p>
 275
 276 </div>
 277 </div>
 278 </div><!-- contents -->
 279 </div><!-- doc-content -->
 280 <!-- start footer part -->
 281 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 282   <ul>
 283     <li class="footer">
 284       <script type="text/javascript">
 285         <!--
 286         writeFooter.call(this);
 287         //-->
 288       </script>
 289     </li>
 290   </ul>
 291 </div>
 292 </body>
 293 </html>