begriffs open source - cmsis/blob - main/Driver/html/group__sai__controls.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 Controls</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 <!-- 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__controls.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 Controls<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></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>Specifies controls.
 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:ga14ac7775060e731b26bc5b3acd2f317a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga14ac7775060e731b26bc5b3acd2f317a">ARM_SAI_CONFIGURE_TX</a>&#160;&#160;&#160;(0x01UL)</td></tr>
 139 <tr class="memdesc:ga14ac7775060e731b26bc5b3acd2f317a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure Transmitter; arg1 and arg2 provide additional configuration.  <br /></td></tr>
 140 <tr class="separator:ga14ac7775060e731b26bc5b3acd2f317a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gaba3e824e022fe2a5736de5dcbbd3d291">ARM_SAI_CONFIGURE_RX</a>&#160;&#160;&#160;(0x02UL)</td></tr>
 142 <tr class="memdesc:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure Receiver; arg1 and arg2 provide additional configuration.  <br /></td></tr>
 143 <tr class="separator:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga74d7850973c095bb8dbffa880b4af1bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga74d7850973c095bb8dbffa880b4af1bc">ARM_SAI_CONTROL_TX</a>&#160;&#160;&#160;(0x03UL)</td></tr>
 145 <tr class="memdesc:ga74d7850973c095bb8dbffa880b4af1bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute.  <br /></td></tr>
 146 <tr class="separator:ga74d7850973c095bb8dbffa880b4af1bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gaa40390b6dd0df3b140fdc45bb7b1439d">ARM_SAI_CONTROL_RX</a>&#160;&#160;&#160;(0x04UL)</td></tr>
 148 <tr class="memdesc:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Receiver; arg1.0: 0=disable (default), 1=enable.  <br /></td></tr>
 149 <tr class="separator:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga8675b9776189caf4df7d558b3e18fcba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga8675b9776189caf4df7d558b3e18fcba">ARM_SAI_MASK_SLOTS_TX</a>&#160;&#160;&#160;(0x05UL)</td></tr>
 151 <tr class="memdesc:ga8675b9776189caf4df7d558b3e18fcba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default.  <br /></td></tr>
 152 <tr class="separator:ga8675b9776189caf4df7d558b3e18fcba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ga84302d372185665852c9ed941c6545e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga84302d372185665852c9ed941c6545e0">ARM_SAI_MASK_SLOTS_RX</a>&#160;&#160;&#160;(0x06UL)</td></tr>
 154 <tr class="memdesc:ga84302d372185665852c9ed941c6545e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask Receiver slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default.  <br /></td></tr>
 155 <tr class="separator:ga84302d372185665852c9ed941c6545e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gab3ec8ef9e5e5a190bd2131ac8c99a240">ARM_SAI_ABORT_SEND</a>&#160;&#160;&#160;(0x07UL)</td></tr>
 157 <tr class="memdesc:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>.  <br /></td></tr>
 158 <tr class="separator:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga2b8d3d85c1e60f137f8c433f319244cb">ARM_SAI_ABORT_RECEIVE</a>&#160;&#160;&#160;(0x08UL)</td></tr>
 160 <tr class="memdesc:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>.  <br /></td></tr>
 161 <tr class="separator:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 </table>
 163 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 164 <p>Specifies controls. </p>
 165 <h2 class="groupheader">Macro Definition Documentation</h2>
 166 <a id="ga14ac7775060e731b26bc5b3acd2f317a" name="ga14ac7775060e731b26bc5b3acd2f317a"></a>
 167 <h2 class="memtitle"><span class="permalink"><a href="#ga14ac7775060e731b26bc5b3acd2f317a">&#9670;&#160;</a></span>ARM_SAI_CONFIGURE_TX</h2>
 168
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">#define ARM_SAI_CONFIGURE_TX&#160;&#160;&#160;(0x01UL)</td>
 174         </tr>
 175       </table>
 176 </div><div class="memdoc">
 177
 178 <p>Configure Transmitter; arg1 and arg2 provide additional configuration. </p>
 179 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a> </dd></dl>
 180
 181 </div>
 182 </div>
 183 <a id="gaba3e824e022fe2a5736de5dcbbd3d291" name="gaba3e824e022fe2a5736de5dcbbd3d291"></a>
 184 <h2 class="memtitle"><span class="permalink"><a href="#gaba3e824e022fe2a5736de5dcbbd3d291">&#9670;&#160;</a></span>ARM_SAI_CONFIGURE_RX</h2>
 185
 186 <div class="memitem">
 187 <div class="memproto">
 188       <table class="memname">
 189         <tr>
 190           <td class="memname">#define ARM_SAI_CONFIGURE_RX&#160;&#160;&#160;(0x02UL)</td>
 191         </tr>
 192       </table>
 193 </div><div class="memdoc">
 194
 195 <p>Configure Receiver; arg1 and arg2 provide additional configuration. </p>
 196 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a> </dd></dl>
 197
 198 </div>
 199 </div>
 200 <a id="ga74d7850973c095bb8dbffa880b4af1bc" name="ga74d7850973c095bb8dbffa880b4af1bc"></a>
 201 <h2 class="memtitle"><span class="permalink"><a href="#ga74d7850973c095bb8dbffa880b4af1bc">&#9670;&#160;</a></span>ARM_SAI_CONTROL_TX</h2>
 202
 203 <div class="memitem">
 204 <div class="memproto">
 205       <table class="memname">
 206         <tr>
 207           <td class="memname">#define ARM_SAI_CONTROL_TX&#160;&#160;&#160;(0x03UL)</td>
 208         </tr>
 209       </table>
 210 </div><div class="memdoc">
 211
 212 <p>Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute. </p>
 213 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd" title="Start sending data to SAI transmitter.">ARM_SAI_Send</a> </dd></dl>
 214
 215 </div>
 216 </div>
 217 <a id="gaa40390b6dd0df3b140fdc45bb7b1439d" name="gaa40390b6dd0df3b140fdc45bb7b1439d"></a>
 218 <h2 class="memtitle"><span class="permalink"><a href="#gaa40390b6dd0df3b140fdc45bb7b1439d">&#9670;&#160;</a></span>ARM_SAI_CONTROL_RX</h2>
 219
 220 <div class="memitem">
 221 <div class="memproto">
 222       <table class="memname">
 223         <tr>
 224           <td class="memname">#define ARM_SAI_CONTROL_RX&#160;&#160;&#160;(0x04UL)</td>
 225         </tr>
 226       </table>
 227 </div><div class="memdoc">
 228
 229 <p>Control Receiver; arg1.0: 0=disable (default), 1=enable. </p>
 230 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98" title="Start receiving data from SAI receiver.">ARM_SAI_Receive</a> </dd></dl>
 231
 232 </div>
 233 </div>
 234 <a id="ga8675b9776189caf4df7d558b3e18fcba" name="ga8675b9776189caf4df7d558b3e18fcba"></a>
 235 <h2 class="memtitle"><span class="permalink"><a href="#ga8675b9776189caf4df7d558b3e18fcba">&#9670;&#160;</a></span>ARM_SAI_MASK_SLOTS_TX</h2>
 236
 237 <div class="memitem">
 238 <div class="memproto">
 239       <table class="memname">
 240         <tr>
 241           <td class="memname">#define ARM_SAI_MASK_SLOTS_TX&#160;&#160;&#160;(0x05UL)</td>
 242         </tr>
 243       </table>
 244 </div><div class="memdoc">
 245
 246 <p>Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. </p>
 247 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd" title="Start sending data to SAI transmitter.">ARM_SAI_Send</a> </dd></dl>
 248
 249 </div>
 250 </div>
 251 <a id="ga84302d372185665852c9ed941c6545e0" name="ga84302d372185665852c9ed941c6545e0"></a>
 252 <h2 class="memtitle"><span class="permalink"><a href="#ga84302d372185665852c9ed941c6545e0">&#9670;&#160;</a></span>ARM_SAI_MASK_SLOTS_RX</h2>
 253
 254 <div class="memitem">
 255 <div class="memproto">
 256       <table class="memname">
 257         <tr>
 258           <td class="memname">#define ARM_SAI_MASK_SLOTS_RX&#160;&#160;&#160;(0x06UL)</td>
 259         </tr>
 260       </table>
 261 </div><div class="memdoc">
 262
 263 <p>Mask Receiver slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. </p>
 264 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98" title="Start receiving data from SAI receiver.">ARM_SAI_Receive</a> </dd></dl>
 265
 266 </div>
 267 </div>
 268 <a id="gab3ec8ef9e5e5a190bd2131ac8c99a240" name="gab3ec8ef9e5e5a190bd2131ac8c99a240"></a>
 269 <h2 class="memtitle"><span class="permalink"><a href="#gab3ec8ef9e5e5a190bd2131ac8c99a240">&#9670;&#160;</a></span>ARM_SAI_ABORT_SEND</h2>
 270
 271 <div class="memitem">
 272 <div class="memproto">
 273       <table class="memname">
 274         <tr>
 275           <td class="memname">#define ARM_SAI_ABORT_SEND&#160;&#160;&#160;(0x07UL)</td>
 276         </tr>
 277       </table>
 278 </div><div class="memdoc">
 279
 280 <p>Abort <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>. </p>
 281 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd" title="Start sending data to SAI transmitter.">ARM_SAI_Send</a> </dd></dl>
 282
 283 </div>
 284 </div>
 285 <a id="ga2b8d3d85c1e60f137f8c433f319244cb" name="ga2b8d3d85c1e60f137f8c433f319244cb"></a>
 286 <h2 class="memtitle"><span class="permalink"><a href="#ga2b8d3d85c1e60f137f8c433f319244cb">&#9670;&#160;</a></span>ARM_SAI_ABORT_RECEIVE</h2>
 287
 288 <div class="memitem">
 289 <div class="memproto">
 290       <table class="memname">
 291         <tr>
 292           <td class="memname">#define ARM_SAI_ABORT_RECEIVE&#160;&#160;&#160;(0x08UL)</td>
 293         </tr>
 294       </table>
 295 </div><div class="memdoc">
 296
 297 <p>Abort <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>. </p>
 298 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__sai__interface__gr.html#ga405a0769c33da6801055db0fb9b6c869" title="Control SAI Interface.">ARM_SAI_Control</a>; <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98" title="Start receiving data from SAI receiver.">ARM_SAI_Receive</a> </dd></dl>
 299
 300 </div>
 301 </div>
 302 </div><!-- contents -->
 303 </div><!-- doc-content -->
 304 <!-- start footer part -->
 305 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 306   <ul>
 307     <li class="footer">
 308       <script type="text/javascript">
 309         <!--
 310         writeFooter.call(this);
 311         //-->
 312       </script>
 313     </li>
 314   </ul>
 315 </div>
 316 </body>
 317 </html>