begriffs open source - cmsis/blob - main/Driver/html/group__sai__frame__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 Frame</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__frame__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 Frame<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 frame.
 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: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; <a class="el" href="Driver__SAI_8h.html#a330fef2eea5b47e38951600c36ee2a1b">ARM_SAI_FRAME_LENGTH_Pos</a>)</td></tr>
 142 <tr class="memdesc:ga4c557aa02c83b8595be23a6c58d284e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame length in bits (8..1024); default depends on protocol and data.  <br /></td></tr>
 143 <tr class="separator:ga4c557aa02c83b8595be23a6c58d284e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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; <a class="el" href="Driver__SAI_8h.html#a1012f372276699c44b38b5e093802864">ARM_SAI_FRAME_SYNC_WIDTH_Pos</a>)</td></tr>
 145 <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)  <br /></td></tr>
 146 <tr class="separator:gae165fd96e6a5b06b362954fadeabcb7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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; <a class="el" href="Driver__SAI_8h.html#abc50a101bbf53b0fb438ad6682b2745d">ARM_SAI_FRAME_SYNC_POLARITY_Pos</a>)</td></tr>
 148 <tr class="memdesc:ga7be0326e15d61d6c67febb22f5b14d58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame Sync is active high (default); User Protocol only (ignored otherwise)  <br /></td></tr>
 149 <tr class="separator:ga7be0326e15d61d6c67febb22f5b14d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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; <a class="el" href="Driver__SAI_8h.html#abc50a101bbf53b0fb438ad6682b2745d">ARM_SAI_FRAME_SYNC_POLARITY_Pos</a>)</td></tr>
 151 <tr class="memdesc:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame Sync is active low; User Protocol only (ignored otherwise)  <br /></td></tr>
 152 <tr class="separator:gaf3d6bdbc05379ac30905cecf1b2d917e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <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>
 154 <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)  <br /></td></tr>
 155 <tr class="separator:gabec3992447436a2a8ed99108908ae208"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 </table>
 157 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 158 <p>Defines frame. </p>
 159 <h2 class="groupheader">Macro Definition Documentation</h2>
 160 <a id="ga4c557aa02c83b8595be23a6c58d284e9" name="ga4c557aa02c83b8595be23a6c58d284e9"></a>
 161 <h2 class="memtitle"><span class="permalink"><a href="#ga4c557aa02c83b8595be23a6c58d284e9">&#9670;&#160;</a></span>ARM_SAI_FRAME_LENGTH</h2>
 162
 163 <div class="memitem">
 164 <div class="memproto">
 165       <table class="memname">
 166         <tr>
 167           <td class="memname">#define ARM_SAI_FRAME_LENGTH</td>
 168           <td>(</td>
 169           <td class="paramtype">&#160;</td>
 170           <td class="paramname">n</td><td>)</td>
 171           <td>&#160;&#160;&#160;((((n)-1UL)&amp;0x3FFUL) &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a330fef2eea5b47e38951600c36ee2a1b">ARM_SAI_FRAME_LENGTH_Pos</a>)</td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 <p>Frame length in bits (8..1024); default depends on protocol and data. </p>
 177
 178 </div>
 179 </div>
 180 <a id="gae165fd96e6a5b06b362954fadeabcb7a" name="gae165fd96e6a5b06b362954fadeabcb7a"></a>
 181 <h2 class="memtitle"><span class="permalink"><a href="#gae165fd96e6a5b06b362954fadeabcb7a">&#9670;&#160;</a></span>ARM_SAI_FRAME_SYNC_WIDTH</h2>
 182
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">#define ARM_SAI_FRAME_SYNC_WIDTH</td>
 188           <td>(</td>
 189           <td class="paramtype">&#160;</td>
 190           <td class="paramname">n</td><td>)</td>
 191           <td>&#160;&#160;&#160;((((n)-1UL)&amp;0xFFUL) &lt;&lt; <a class="el" href="Driver__SAI_8h.html#a1012f372276699c44b38b5e093802864">ARM_SAI_FRAME_SYNC_WIDTH_Pos</a>)</td>
 192         </tr>
 193       </table>
 194 </div><div class="memdoc">
 195
 196 <p>Frame Sync width in bits (1..256); default=1; User Protocol only (ignored otherwise) </p>
 197
 198 </div>
 199 </div>
 200 <a id="ga7be0326e15d61d6c67febb22f5b14d58" name="ga7be0326e15d61d6c67febb22f5b14d58"></a>
 201 <h2 class="memtitle"><span class="permalink"><a href="#ga7be0326e15d61d6c67febb22f5b14d58">&#9670;&#160;</a></span>ARM_SAI_FRAME_SYNC_POLARITY_HIGH</h2>
 202
 203 <div class="memitem">
 204 <div class="memproto">
 205       <table class="memname">
 206         <tr>
 207           <td class="memname">#define ARM_SAI_FRAME_SYNC_POLARITY_HIGH&#160;&#160;&#160;(0UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#abc50a101bbf53b0fb438ad6682b2745d">ARM_SAI_FRAME_SYNC_POLARITY_Pos</a>)</td>
 208         </tr>
 209       </table>
 210 </div><div class="memdoc">
 211
 212 <p>Frame Sync is active high (default); User Protocol only (ignored otherwise) </p>
 213
 214 </div>
 215 </div>
 216 <a id="gaf3d6bdbc05379ac30905cecf1b2d917e" name="gaf3d6bdbc05379ac30905cecf1b2d917e"></a>
 217 <h2 class="memtitle"><span class="permalink"><a href="#gaf3d6bdbc05379ac30905cecf1b2d917e">&#9670;&#160;</a></span>ARM_SAI_FRAME_SYNC_POLARITY_LOW</h2>
 218
 219 <div class="memitem">
 220 <div class="memproto">
 221       <table class="memname">
 222         <tr>
 223           <td class="memname">#define ARM_SAI_FRAME_SYNC_POLARITY_LOW&#160;&#160;&#160;(1UL &lt;&lt; <a class="el" href="Driver__SAI_8h.html#abc50a101bbf53b0fb438ad6682b2745d">ARM_SAI_FRAME_SYNC_POLARITY_Pos</a>)</td>
 224         </tr>
 225       </table>
 226 </div><div class="memdoc">
 227
 228 <p>Frame Sync is active low; User Protocol only (ignored otherwise) </p>
 229
 230 </div>
 231 </div>
 232 <a id="gabec3992447436a2a8ed99108908ae208" name="gabec3992447436a2a8ed99108908ae208"></a>
 233 <h2 class="memtitle"><span class="permalink"><a href="#gabec3992447436a2a8ed99108908ae208">&#9670;&#160;</a></span>ARM_SAI_FRAME_SYNC_EARLY</h2>
 234
 235 <div class="memitem">
 236 <div class="memproto">
 237       <table class="memname">
 238         <tr>
 239           <td class="memname">#define ARM_SAI_FRAME_SYNC_EARLY&#160;&#160;&#160;(1UL &lt;&lt; 19)</td>
 240         </tr>
 241       </table>
 242 </div><div class="memdoc">
 243
 244 <p>Frame Sync one bit before the first bit of the frame; User Protocol only (ignored otherwise) </p>
 245
 246 </div>
 247 </div>
 248 </div><!-- contents -->
 249 </div><!-- doc-content -->
 250 <!-- start footer part -->
 251 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 252   <ul>
 253     <li class="footer">
 254       <script type="text/javascript">
 255         <!--
 256         writeFooter.call(this);
 257         //-->
 258       </script>
 259     </li>
 260   </ul>
 261 </div>
 262 </body>
 263 </html>