diff options
Diffstat (limited to 'CMSIS/Documentation/Driver/html/group__sai__controls.html')
| -rw-r--r-- | CMSIS/Documentation/Driver/html/group__sai__controls.html | 284 |
1 files changed, 284 insertions, 0 deletions
diff --git a/CMSIS/Documentation/Driver/html/group__sai__controls.html b/CMSIS/Documentation/Driver/html/group__sai__controls.html new file mode 100644 index 0000000..16b31cf --- /dev/null +++ b/CMSIS/Documentation/Driver/html/group__sai__controls.html @@ -0,0 +1,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); +</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> +<link href="stylsheetf" rel="stylesheet" type="text/css" /> +</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 +  <span id="projectnumber">Version 2.04</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.2 --> +<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 Page</span></a></li> + <li><a href="pages.html"><span>Usage and 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </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> </div> +<div class="ingroups"><a class="el" href="group__sai__control.html">SAI Control Codes</a></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga14ac7775060e731b26bc5b3acd2f317a">ARM_SAI_CONFIGURE_TX</a>   (0x01U)</td></tr> +<tr class="memdesc:ga14ac7775060e731b26bc5b3acd2f317a"><td class="mdescLeft"> </td><td class="mdescRight">Configure Transmitter; arg1 and arg2 provide additional configuration. <a href="#ga14ac7775060e731b26bc5b3acd2f317a"></a><br/></td></tr> +<tr class="separator:ga14ac7775060e731b26bc5b3acd2f317a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gaba3e824e022fe2a5736de5dcbbd3d291">ARM_SAI_CONFIGURE_RX</a>   (0x02U)</td></tr> +<tr class="memdesc:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="mdescLeft"> </td><td class="mdescRight">Configure Receiver; arg1 and arg2 provide additional configuration. <a href="#gaba3e824e022fe2a5736de5dcbbd3d291"></a><br/></td></tr> +<tr class="separator:gaba3e824e022fe2a5736de5dcbbd3d291"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga74d7850973c095bb8dbffa880b4af1bc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga74d7850973c095bb8dbffa880b4af1bc">ARM_SAI_CONTROL_TX</a>   (0x03U)</td></tr> +<tr class="memdesc:ga74d7850973c095bb8dbffa880b4af1bc"><td class="mdescLeft"> </td><td class="mdescRight">Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute. <a href="#ga74d7850973c095bb8dbffa880b4af1bc"></a><br/></td></tr> +<tr class="separator:ga74d7850973c095bb8dbffa880b4af1bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gaa40390b6dd0df3b140fdc45bb7b1439d">ARM_SAI_CONTROL_RX</a>   (0x04U)</td></tr> +<tr class="memdesc:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="mdescLeft"> </td><td class="mdescRight">Control Receiver; arg1.0: 0=disable (default), 1=enable. <a href="#gaa40390b6dd0df3b140fdc45bb7b1439d"></a><br/></td></tr> +<tr class="separator:gaa40390b6dd0df3b140fdc45bb7b1439d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8675b9776189caf4df7d558b3e18fcba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga8675b9776189caf4df7d558b3e18fcba">ARM_SAI_MASK_SLOTS_TX</a>   (0x05U)</td></tr> +<tr class="memdesc:ga8675b9776189caf4df7d558b3e18fcba"><td class="mdescLeft"> </td><td class="mdescRight">Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. <a href="#ga8675b9776189caf4df7d558b3e18fcba"></a><br/></td></tr> +<tr class="separator:ga8675b9776189caf4df7d558b3e18fcba"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga84302d372185665852c9ed941c6545e0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga84302d372185665852c9ed941c6545e0">ARM_SAI_MASK_SLOTS_RX</a>   (0x06U)</td></tr> +<tr class="memdesc:ga84302d372185665852c9ed941c6545e0"><td class="mdescLeft"> </td><td class="mdescRight">Mask Receiver slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default. <a href="#ga84302d372185665852c9ed941c6545e0"></a><br/></td></tr> +<tr class="separator:ga84302d372185665852c9ed941c6545e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#gab3ec8ef9e5e5a190bd2131ac8c99a240">ARM_SAI_ABORT_SEND</a>   (0x07U)</td></tr> +<tr class="memdesc:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="mdescLeft"> </td><td class="mdescRight">Abort <a class="el" href="group__sai__interface__gr.html#ga8bb6866c535adeb930bc4a847d476fcd">ARM_SAI_Send</a>. <a href="#gab3ec8ef9e5e5a190bd2131ac8c99a240"></a><br/></td></tr> +<tr class="separator:gab3ec8ef9e5e5a190bd2131ac8c99a240"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sai__controls.html#ga2b8d3d85c1e60f137f8c433f319244cb">ARM_SAI_ABORT_RECEIVE</a>   (0x08U)</td></tr> +<tr class="memdesc:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="mdescLeft"> </td><td class="mdescRight">Abort <a class="el" href="group__sai__interface__gr.html#ga2d55f506cef9d2849cbe418146086d98">ARM_SAI_Receive</a>. <a href="#ga2b8d3d85c1e60f137f8c433f319244cb"></a><br/></td></tr> +<tr class="separator:ga2b8d3d85c1e60f137f8c433f319244cb"><td class="memSeparator" colspan="2"> </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   (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   (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   (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   (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   (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   (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   (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   (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 Tue Oct 27 2015 14:35:25 for CMSIS-Driver 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.2 + --> + </li> + </ul> +</div> +</body> +</html> |