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