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