summaryrefslogtreecommitdiff
path: root/docs/Driver/html/group__sai__controls.html
blob: 0d073e86d12fdceb6be4b555bae561d506983003 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SAI Controls</title>
<title>CMSIS-Driver: SAI Controls</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 46px;">
  <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">CMSIS-Driver
   &#160;<span id="projectnumber">Version 2.7.1</span>
   </div>
   <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
    <ul class="tablist">
      <script type="text/javascript">
		<!--
		writeComponentTabs.call(this);
		//-->
      </script>
	  </ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
      <li><a href="modules.html"><span>Reference</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__sai__controls.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">SAI Controls<div class="ingroups"><a class="el" href="group__sai__control.html">SAI Control Codes</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Specifies controls.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<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;(0x01U)</td></tr>
<tr class="memdesc:ga14ac7775060e731b26bc5b3acd2f317a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure Transmitter; arg1 and arg2 provide additional configuration.  <a href="#ga14ac7775060e731b26bc5b3acd2f317a">More...</a><br/></td></tr>
<tr class="separator:ga14ac7775060e731b26bc5b3acd2f317a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x02U)</td></tr>
<tr class="memdesc:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure Receiver; arg1 and arg2 provide additional configuration.  <a href="#gaba3e824e022fe2a5736de5dcbbd3d291">More...</a><br/></td></tr>
<tr class="separator:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x03U)</td></tr>
<tr class="memdesc:ga74d7850973c095bb8dbffa880b4af1bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute.  <a href="#ga74d7850973c095bb8dbffa880b4af1bc">More...</a><br/></td></tr>
<tr class="separator:ga74d7850973c095bb8dbffa880b4af1bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x04U)</td></tr>
<tr class="memdesc:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control Receiver; arg1.0: 0=disable (default), 1=enable.  <a href="#gaa40390b6dd0df3b140fdc45bb7b1439d">More...</a><br/></td></tr>
<tr class="separator:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x05U)</td></tr>
<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.  <a href="#ga8675b9776189caf4df7d558b3e18fcba">More...</a><br/></td></tr>
<tr class="separator:ga8675b9776189caf4df7d558b3e18fcba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x06U)</td></tr>
<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.  <a href="#ga84302d372185665852c9ed941c6545e0">More...</a><br/></td></tr>
<tr class="separator:ga84302d372185665852c9ed941c6545e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x07U)</td></tr>
<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>.  <a href="#gab3ec8ef9e5e5a190bd2131ac8c99a240">More...</a><br/></td></tr>
<tr class="separator:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x08U)</td></tr>
<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>.  <a href="#ga2b8d3d85c1e60f137f8c433f319244cb">More...</a><br/></td></tr>
<tr class="separator:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specifies controls. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga14ac7775060e731b26bc5b3acd2f317a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_CONFIGURE_TX&#160;&#160;&#160;(0x01U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configure Transmitter; arg1 and arg2 provide additional configuration. </p>
<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>

</div>
</div>
<a class="anchor" id="gaba3e824e022fe2a5736de5dcbbd3d291"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_CONFIGURE_RX&#160;&#160;&#160;(0x02U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configure Receiver; arg1 and arg2 provide additional configuration. </p>
<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>

</div>
</div>
<a class="anchor" id="ga74d7850973c095bb8dbffa880b4af1bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_CONTROL_TX&#160;&#160;&#160;(0x03U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute. </p>
<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>

</div>
</div>
<a class="anchor" id="gaa40390b6dd0df3b140fdc45bb7b1439d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_CONTROL_RX&#160;&#160;&#160;(0x04U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Control Receiver; arg1.0: 0=disable (default), 1=enable. </p>
<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>

</div>
</div>
<a class="anchor" id="ga8675b9776189caf4df7d558b3e18fcba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_MASK_SLOTS_TX&#160;&#160;&#160;(0x05U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. </p>
<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>

</div>
</div>
<a class="anchor" id="ga84302d372185665852c9ed941c6545e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_MASK_SLOTS_RX&#160;&#160;&#160;(0x06U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mask Receiver slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. </p>
<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>

</div>
</div>
<a class="anchor" id="gab3ec8ef9e5e5a190bd2131ac8c99a240"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_ABORT_SEND&#160;&#160;&#160;(0x07U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Abort <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>. </p>
<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>

</div>
</div>
<a class="anchor" id="ga2b8d3d85c1e60f137f8c433f319244cb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ARM_SAI_ABORT_RECEIVE&#160;&#160;&#160;(0x08U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Abort <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>. </p>
<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>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Wed Jul 10 2019 15:20:31 for CMSIS-Driver Version 2.7.1 by Arm Ltd. All rights reserved.
	<!--
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
	-->
	</li>
  </ul>
</div>
</body>
</html>