1588 lines
100 KiB
HTML
1588 lines
100 KiB
HTML
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>MCUXpresso SDK API Reference Manual: I2S Driver</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.css" 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: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<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>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>API 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('a00031.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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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="#files">Files</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">I2S Driver<div class="ingroups"><a class="el" href="a00248.html">I2S: I2S Driver</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:a00169"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html">fsl_i2s.h</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00350"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a00350">_i2s_config</a></td></tr>
|
|
<tr class="memdesc:a00350"><td class="mdescLeft"> </td><td class="mdescRight">I2S configuration structure. <a href="a00031.html#a00350">More...</a><br/></td></tr>
|
|
<tr class="separator:a00350"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00353"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a00353">_i2s_transfer</a></td></tr>
|
|
<tr class="memdesc:a00353"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to transfer from or receive audio data into. <a href="a00031.html#a00353">More...</a><br/></td></tr>
|
|
<tr class="separator:a00353"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00352"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a00352">_i2s_handle</a></td></tr>
|
|
<tr class="memdesc:a00352"><td class="mdescLeft"> </td><td class="mdescRight">Members not to be accessed / modified outside of the driver. <a href="a00031.html#a00352">More...</a><br/></td></tr>
|
|
<tr class="separator:a00352"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gae17f5f49178cc3ab239917f6454792d0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gae17f5f49178cc3ab239917f6454792d0">I2S_NUM_BUFFERS</a>   (4U)</td></tr>
|
|
<tr class="memdesc:gae17f5f49178cc3ab239917f6454792d0"><td class="mdescLeft"> </td><td class="mdescRight">Number of buffers . <a href="#gae17f5f49178cc3ab239917f6454792d0">More...</a><br/></td></tr>
|
|
<tr class="separator:gae17f5f49178cc3ab239917f6454792d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga159bdb39995b1e978edbeffd7a419989"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00031.html#gadd818f4b96aee77ebab7fb143598061e">_i2s_flags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga159bdb39995b1e978edbeffd7a419989">i2s_flags_t</a></td></tr>
|
|
<tr class="memdesc:ga159bdb39995b1e978edbeffd7a419989"><td class="mdescLeft"> </td><td class="mdescRight">I2S flags. <a href="#ga159bdb39995b1e978edbeffd7a419989">More...</a><br/></td></tr>
|
|
<tr class="separator:ga159bdb39995b1e978edbeffd7a419989"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga71cbcb2a1e42b043163f90e8fd81d8e4"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00031.html#ga58fcc3bdc4a785b22d7a8f397e91911b">_i2s_master_slave</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga71cbcb2a1e42b043163f90e8fd81d8e4">i2s_master_slave_t</a></td></tr>
|
|
<tr class="memdesc:ga71cbcb2a1e42b043163f90e8fd81d8e4"><td class="mdescLeft"> </td><td class="mdescRight">Master / slave mode. <a href="#ga71cbcb2a1e42b043163f90e8fd81d8e4">More...</a><br/></td></tr>
|
|
<tr class="separator:ga71cbcb2a1e42b043163f90e8fd81d8e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3d4817f257ec38092ef6f33c0e095a94"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00031.html#ga5dd588fbfde93f136f6d27e71166f692">_i2s_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga3d4817f257ec38092ef6f33c0e095a94">i2s_mode_t</a></td></tr>
|
|
<tr class="memdesc:ga3d4817f257ec38092ef6f33c0e095a94"><td class="mdescLeft"> </td><td class="mdescRight">I2S mode. <a href="#ga3d4817f257ec38092ef6f33c0e095a94">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3d4817f257ec38092ef6f33c0e095a94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga04840f13f39a77aa775d4cd83cfd896d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00031.html#a00350">_i2s_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a></td></tr>
|
|
<tr class="memdesc:ga04840f13f39a77aa775d4cd83cfd896d"><td class="mdescLeft"> </td><td class="mdescRight">I2S configuration structure. <a href="#ga04840f13f39a77aa775d4cd83cfd896d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga04840f13f39a77aa775d4cd83cfd896d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga954fbb10efcf6b2993c1d91706835605"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00031.html#a00353">_i2s_transfer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga954fbb10efcf6b2993c1d91706835605">i2s_transfer_t</a></td></tr>
|
|
<tr class="memdesc:ga954fbb10efcf6b2993c1d91706835605"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to transfer from or receive audio data into. <a href="#ga954fbb10efcf6b2993c1d91706835605">More...</a><br/></td></tr>
|
|
<tr class="separator:ga954fbb10efcf6b2993c1d91706835605"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf0c2f3939e61c1d862a90d9e42712c6e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00031.html#a00352">_i2s_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a></td></tr>
|
|
<tr class="memdesc:gaf0c2f3939e61c1d862a90d9e42712c6e"><td class="mdescLeft"> </td><td class="mdescRight">Transactional state of the intialized transfer or receive I2S operation. <a href="#gaf0c2f3939e61c1d862a90d9e42712c6e">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf0c2f3939e61c1d862a90d9e42712c6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf04bcafbb89c4d0a47ac0acfcc958faf"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gaf04bcafbb89c4d0a47ac0acfcc958faf">i2s_transfer_callback_t</a> )(I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, <a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> completionStatus, void *userData)</td></tr>
|
|
<tr class="memdesc:gaf04bcafbb89c4d0a47ac0acfcc958faf"><td class="mdescLeft"> </td><td class="mdescRight">Callback function invoked from transactional API on completion of a single buffer transfer. <a href="#gaf04bcafbb89c4d0a47ac0acfcc958faf">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf04bcafbb89c4d0a47ac0acfcc958faf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gabc6126af1d45847bc59afa0aa3216b04"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
|
|
  <a class="el" href="a00031.html#ggabc6126af1d45847bc59afa0aa3216b04a634ef87c7515bb4037dfaaea2d75b6e1">kStatus_I2S_BufferComplete</a>,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#ggabc6126af1d45847bc59afa0aa3216b04af123c761ef2616e6f48031b3f1103e48">kStatus_I2S_Done</a> = MAKE_STATUS(kStatusGroup_I2S, 1),
|
|
<br/>
|
|
  <a class="el" href="a00031.html#ggabc6126af1d45847bc59afa0aa3216b04af73f348e9a8fe5cdf3c1ad097378d5b2">kStatus_I2S_Busy</a>
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gabc6126af1d45847bc59afa0aa3216b04"><td class="mdescLeft"> </td><td class="mdescRight">_i2s_status I2S status codes. <a href="a00031.html#gabc6126af1d45847bc59afa0aa3216b04">More...</a><br/></td></tr>
|
|
<tr class="separator:gabc6126af1d45847bc59afa0aa3216b04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadd818f4b96aee77ebab7fb143598061e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gadd818f4b96aee77ebab7fb143598061e">_i2s_flags</a> { <br/>
|
|
  <a class="el" href="a00031.html#ggadd818f4b96aee77ebab7fb143598061ea4de8d6343bcebc3f15243732806fc564">kI2S_TxErrorFlag</a> = I2S_FIFOINTENSET_TXERR_MASK,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#ggadd818f4b96aee77ebab7fb143598061eac3daa0c88fabb995e62e7f2803db4155">kI2S_TxLevelFlag</a> = I2S_FIFOINTENSET_TXLVL_MASK,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#ggadd818f4b96aee77ebab7fb143598061eaf26884847511b34b0197bb70c7c36989">kI2S_RxErrorFlag</a> = I2S_FIFOINTENSET_RXERR_MASK,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#ggadd818f4b96aee77ebab7fb143598061eac29fb67960b694a776c8159a7b4487db">kI2S_RxLevelFlag</a> = I2S_FIFOINTENSET_RXLVL_MASK
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gadd818f4b96aee77ebab7fb143598061e"><td class="mdescLeft"> </td><td class="mdescRight">I2S flags. <a href="a00031.html#gadd818f4b96aee77ebab7fb143598061e">More...</a><br/></td></tr>
|
|
<tr class="separator:gadd818f4b96aee77ebab7fb143598061e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga58fcc3bdc4a785b22d7a8f397e91911b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga58fcc3bdc4a785b22d7a8f397e91911b">_i2s_master_slave</a> { <br/>
|
|
  <a class="el" href="a00031.html#gga58fcc3bdc4a785b22d7a8f397e91911ba84bedf24f43a46b87a774e479da5b82b">kI2S_MasterSlaveNormalSlave</a> = 0x0,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#gga58fcc3bdc4a785b22d7a8f397e91911ba2d7515b2fc53986d17636f3e16412b08">kI2S_MasterSlaveWsSyncMaster</a> = 0x1,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#gga58fcc3bdc4a785b22d7a8f397e91911bad0b9c4656a3d40c936a7369d75c8d346">kI2S_MasterSlaveExtSckMaster</a> = 0x2,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#gga58fcc3bdc4a785b22d7a8f397e91911ba13ab2820eda5d509bb3ceff6fb28758b">kI2S_MasterSlaveNormalMaster</a> = 0x3
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga58fcc3bdc4a785b22d7a8f397e91911b"><td class="mdescLeft"> </td><td class="mdescRight">Master / slave mode. <a href="a00031.html#ga58fcc3bdc4a785b22d7a8f397e91911b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga58fcc3bdc4a785b22d7a8f397e91911b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5dd588fbfde93f136f6d27e71166f692"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga5dd588fbfde93f136f6d27e71166f692">_i2s_mode</a> { <br/>
|
|
  <a class="el" href="a00031.html#gga5dd588fbfde93f136f6d27e71166f692ac0e4769e50d6318229c2dc31cd99bae3">kI2S_ModeI2sClassic</a> = 0x0,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#gga5dd588fbfde93f136f6d27e71166f692a11364b25e57662ef4d1fc288ab12ddb1">kI2S_ModeDspWs50</a> = 0x1,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#gga5dd588fbfde93f136f6d27e71166f692a6a42cbdc569ac3c30706fb6ba61db9d9">kI2S_ModeDspWsShort</a> = 0x2,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#gga5dd588fbfde93f136f6d27e71166f692a3bb54e6d9b9d1793637e1b82e323e829">kI2S_ModeDspWsLong</a> = 0x3
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga5dd588fbfde93f136f6d27e71166f692"><td class="mdescLeft"> </td><td class="mdescRight">I2S mode. <a href="a00031.html#ga5dd588fbfde93f136f6d27e71166f692">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5dd588fbfde93f136f6d27e71166f692"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadc29c2ff13d900c2f185ee95427fb06c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
|
|
  <a class="el" href="a00031.html#ggadc29c2ff13d900c2f185ee95427fb06ca61732beb4a722233e97ee814f949eb1d">kI2S_SecondaryChannel1</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#ggadc29c2ff13d900c2f185ee95427fb06ca916a9db0c16edbddbe7dc96f578948b0">kI2S_SecondaryChannel2</a> = 1U,
|
|
<br/>
|
|
  <a class="el" href="a00031.html#ggadc29c2ff13d900c2f185ee95427fb06ca1e1a62b1c4e0ab9966f18d1a81c2362a">kI2S_SecondaryChannel3</a> = 2U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gadc29c2ff13d900c2f185ee95427fb06c"><td class="mdescLeft"> </td><td class="mdescRight">_i2s_secondary_channel I2S secondary channel. <a href="a00031.html#gadc29c2ff13d900c2f185ee95427fb06c">More...</a><br/></td></tr>
|
|
<tr class="separator:gadc29c2ff13d900c2f185ee95427fb06c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Driver version</h2></td></tr>
|
|
<tr class="memitem:gaf19f85eb3c13d6b8b839a62c30009710"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gaf19f85eb3c13d6b8b839a62c30009710">FSL_I2S_DRIVER_VERSION</a>   (<a class="el" href="a00242.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 3, 2))</td></tr>
|
|
<tr class="memdesc:gaf19f85eb3c13d6b8b839a62c30009710"><td class="mdescLeft"> </td><td class="mdescRight">I2S driver version 2.3.2. <a href="#gaf19f85eb3c13d6b8b839a62c30009710">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf19f85eb3c13d6b8b839a62c30009710"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Initialization and deinitialization</h2></td></tr>
|
|
<tr class="memitem:ga5d68b2f69b625a753d498dab6758c5b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga5d68b2f69b625a753d498dab6758c5b9">I2S_TxInit</a> (I2S_Type *base, const <a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga5d68b2f69b625a753d498dab6758c5b9"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the FLEXCOMM peripheral for I2S transmit functionality. <a href="#ga5d68b2f69b625a753d498dab6758c5b9">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5d68b2f69b625a753d498dab6758c5b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa71e9b55c275d5469c1e3f723dc55213"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gaa71e9b55c275d5469c1e3f723dc55213">I2S_RxInit</a> (I2S_Type *base, const <a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:gaa71e9b55c275d5469c1e3f723dc55213"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the FLEXCOMM peripheral for I2S receive functionality. <a href="#gaa71e9b55c275d5469c1e3f723dc55213">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa71e9b55c275d5469c1e3f723dc55213"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga905cb886175d4a1f9ac2fbf8d2722cf6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga905cb886175d4a1f9ac2fbf8d2722cf6">I2S_TxGetDefaultConfig</a> (<a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga905cb886175d4a1f9ac2fbf8d2722cf6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the I2S Tx configuration structure to default values. <a href="#ga905cb886175d4a1f9ac2fbf8d2722cf6">More...</a><br/></td></tr>
|
|
<tr class="separator:ga905cb886175d4a1f9ac2fbf8d2722cf6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8356de62fea66f67a9803ee89a78805a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga8356de62fea66f67a9803ee89a78805a">I2S_RxGetDefaultConfig</a> (<a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga8356de62fea66f67a9803ee89a78805a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the I2S Rx configuration structure to default values. <a href="#ga8356de62fea66f67a9803ee89a78805a">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8356de62fea66f67a9803ee89a78805a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga68e9243ae7345a144668c7e04f1f52ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga68e9243ae7345a144668c7e04f1f52ac">I2S_Deinit</a> (I2S_Type *base)</td></tr>
|
|
<tr class="memdesc:ga68e9243ae7345a144668c7e04f1f52ac"><td class="mdescLeft"> </td><td class="mdescRight">De-initializes the I2S peripheral. <a href="#ga68e9243ae7345a144668c7e04f1f52ac">More...</a><br/></td></tr>
|
|
<tr class="separator:ga68e9243ae7345a144668c7e04f1f52ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga06dba1e2ecbb367719f60c9470ddd1fa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga06dba1e2ecbb367719f60c9470ddd1fa">I2S_SetBitClockRate</a> (I2S_Type *base, uint32_t sourceClockHz, uint32_t sampleRate, uint32_t bitWidth, uint32_t channelNumbers)</td></tr>
|
|
<tr class="memdesc:ga06dba1e2ecbb367719f60c9470ddd1fa"><td class="mdescLeft"> </td><td class="mdescRight">Transmitter/Receiver bit clock rate configurations. <a href="#ga06dba1e2ecbb367719f60c9470ddd1fa">More...</a><br/></td></tr>
|
|
<tr class="separator:ga06dba1e2ecbb367719f60c9470ddd1fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Non-blocking API</h2></td></tr>
|
|
<tr class="memitem:ga0e630bdd0adb5a39b52e374ede7bc07f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga0e630bdd0adb5a39b52e374ede7bc07f">I2S_TxTransferCreateHandle</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, <a class="el" href="a00031.html#gaf04bcafbb89c4d0a47ac0acfcc958faf">i2s_transfer_callback_t</a> callback, void *userData)</td></tr>
|
|
<tr class="memdesc:ga0e630bdd0adb5a39b52e374ede7bc07f"><td class="mdescLeft"> </td><td class="mdescRight">Initializes handle for transfer of audio data. <a href="#ga0e630bdd0adb5a39b52e374ede7bc07f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0e630bdd0adb5a39b52e374ede7bc07f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8e341c9ce48e5be03e120ea332758048"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga8e341c9ce48e5be03e120ea332758048">I2S_TxTransferNonBlocking</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, <a class="el" href="a00031.html#ga954fbb10efcf6b2993c1d91706835605">i2s_transfer_t</a> transfer)</td></tr>
|
|
<tr class="memdesc:ga8e341c9ce48e5be03e120ea332758048"><td class="mdescLeft"> </td><td class="mdescRight">Begins or queue sending of the given data. <a href="#ga8e341c9ce48e5be03e120ea332758048">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8e341c9ce48e5be03e120ea332758048"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga25659519f70757bf2db3831f7e807bd8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga25659519f70757bf2db3831f7e807bd8">I2S_TxTransferAbort</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga25659519f70757bf2db3831f7e807bd8"><td class="mdescLeft"> </td><td class="mdescRight">Aborts sending of data. <a href="#ga25659519f70757bf2db3831f7e807bd8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga25659519f70757bf2db3831f7e807bd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabd8c54c9689fd89024c83bb883693c16"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gabd8c54c9689fd89024c83bb883693c16">I2S_RxTransferCreateHandle</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, <a class="el" href="a00031.html#gaf04bcafbb89c4d0a47ac0acfcc958faf">i2s_transfer_callback_t</a> callback, void *userData)</td></tr>
|
|
<tr class="memdesc:gabd8c54c9689fd89024c83bb883693c16"><td class="mdescLeft"> </td><td class="mdescRight">Initializes handle for reception of audio data. <a href="#gabd8c54c9689fd89024c83bb883693c16">More...</a><br/></td></tr>
|
|
<tr class="separator:gabd8c54c9689fd89024c83bb883693c16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga454cba72bec3ebeecf865570ce6ed900"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga454cba72bec3ebeecf865570ce6ed900">I2S_RxTransferNonBlocking</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, <a class="el" href="a00031.html#ga954fbb10efcf6b2993c1d91706835605">i2s_transfer_t</a> transfer)</td></tr>
|
|
<tr class="memdesc:ga454cba72bec3ebeecf865570ce6ed900"><td class="mdescLeft"> </td><td class="mdescRight">Begins or queue reception of data into given buffer. <a href="#ga454cba72bec3ebeecf865570ce6ed900">More...</a><br/></td></tr>
|
|
<tr class="separator:ga454cba72bec3ebeecf865570ce6ed900"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga32eb018b43745a695ef26cec1ff73a73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga32eb018b43745a695ef26cec1ff73a73">I2S_RxTransferAbort</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga32eb018b43745a695ef26cec1ff73a73"><td class="mdescLeft"> </td><td class="mdescRight">Aborts receiving of data. <a href="#ga32eb018b43745a695ef26cec1ff73a73">More...</a><br/></td></tr>
|
|
<tr class="separator:ga32eb018b43745a695ef26cec1ff73a73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga14ef749f4300fe7b1fd38277f0ef167f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga14ef749f4300fe7b1fd38277f0ef167f">I2S_TransferGetCount</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga14ef749f4300fe7b1fd38277f0ef167f"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of bytes transferred so far. <a href="#ga14ef749f4300fe7b1fd38277f0ef167f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga14ef749f4300fe7b1fd38277f0ef167f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae3d210a830859e93103931b4baf83586"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gae3d210a830859e93103931b4baf83586">I2S_TransferGetErrorCount</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:gae3d210a830859e93103931b4baf83586"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of buffer underruns or overruns. <a href="#gae3d210a830859e93103931b4baf83586">More...</a><br/></td></tr>
|
|
<tr class="separator:gae3d210a830859e93103931b4baf83586"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Enable / disable</h2></td></tr>
|
|
<tr class="memitem:gac109aadc23d6f31e6f8420fa3f4018fd"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gac109aadc23d6f31e6f8420fa3f4018fd">I2S_Enable</a> (I2S_Type *base)</td></tr>
|
|
<tr class="memdesc:gac109aadc23d6f31e6f8420fa3f4018fd"><td class="mdescLeft"> </td><td class="mdescRight">Enables I2S operation. <a href="#gac109aadc23d6f31e6f8420fa3f4018fd">More...</a><br/></td></tr>
|
|
<tr class="separator:gac109aadc23d6f31e6f8420fa3f4018fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4b393781ae83a07d4d3e99972429cfa1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga4b393781ae83a07d4d3e99972429cfa1">I2S_Disable</a> (I2S_Type *base)</td></tr>
|
|
<tr class="memdesc:ga4b393781ae83a07d4d3e99972429cfa1"><td class="mdescLeft"> </td><td class="mdescRight">Disables I2S operation. <a href="#ga4b393781ae83a07d4d3e99972429cfa1">More...</a><br/></td></tr>
|
|
<tr class="separator:ga4b393781ae83a07d4d3e99972429cfa1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Interrupts</h2></td></tr>
|
|
<tr class="memitem:ga435263725c056eccaa82eb1947e162aa"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga435263725c056eccaa82eb1947e162aa">I2S_EnableInterrupts</a> (I2S_Type *base, uint32_t interruptMask)</td></tr>
|
|
<tr class="memdesc:ga435263725c056eccaa82eb1947e162aa"><td class="mdescLeft"> </td><td class="mdescRight">Enables I2S FIFO interrupts. <a href="#ga435263725c056eccaa82eb1947e162aa">More...</a><br/></td></tr>
|
|
<tr class="separator:ga435263725c056eccaa82eb1947e162aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa6f8ed52f3cd5c63b3a3716a70c77223"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gaa6f8ed52f3cd5c63b3a3716a70c77223">I2S_DisableInterrupts</a> (I2S_Type *base, uint32_t interruptMask)</td></tr>
|
|
<tr class="memdesc:gaa6f8ed52f3cd5c63b3a3716a70c77223"><td class="mdescLeft"> </td><td class="mdescRight">Disables I2S FIFO interrupts. <a href="#gaa6f8ed52f3cd5c63b3a3716a70c77223">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa6f8ed52f3cd5c63b3a3716a70c77223"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2d96a8f63e454de7225a98541b6461b9"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga2d96a8f63e454de7225a98541b6461b9">I2S_GetEnabledInterrupts</a> (I2S_Type *base)</td></tr>
|
|
<tr class="memdesc:ga2d96a8f63e454de7225a98541b6461b9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of currently enabled I2S FIFO interrupts. <a href="#ga2d96a8f63e454de7225a98541b6461b9">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2d96a8f63e454de7225a98541b6461b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8d8c443026cca28ef0c8f9890a894829"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga8d8c443026cca28ef0c8f9890a894829">I2S_EmptyTxFifo</a> (I2S_Type *base)</td></tr>
|
|
<tr class="memdesc:ga8d8c443026cca28ef0c8f9890a894829"><td class="mdescLeft"> </td><td class="mdescRight">Flush the valid data in TX fifo. <a href="#ga8d8c443026cca28ef0c8f9890a894829">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8d8c443026cca28ef0c8f9890a894829"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2423f95dc2c00bce6a9de6d868d1fde2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ga2423f95dc2c00bce6a9de6d868d1fde2">I2S_TxHandleIRQ</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga2423f95dc2c00bce6a9de6d868d1fde2"><td class="mdescLeft"> </td><td class="mdescRight">Invoked from interrupt handler when transmit FIFO level decreases. <a href="#ga2423f95dc2c00bce6a9de6d868d1fde2">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2423f95dc2c00bce6a9de6d868d1fde2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaeff61f8cbd780c881c593ad059f98338"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#gaeff61f8cbd780c881c593ad059f98338">I2S_RxHandleIRQ</a> (I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:gaeff61f8cbd780c881c593ad059f98338"><td class="mdescLeft"> </td><td class="mdescRight">Invoked from interrupt handler when receive FIFO level decreases. <a href="#gaeff61f8cbd780c881c593ad059f98338">More...</a><br/></td></tr>
|
|
<tr class="separator:gaeff61f8cbd780c881c593ad059f98338"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00350" id="a00350"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _i2s_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a1c5e1132f4c7132d5b9406c686ccf0cb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c5e1132f4c7132d5b9406c686ccf0cb"></a>
|
|
<a class="el" href="a00031.html#ga71cbcb2a1e42b043163f90e8fd81d8e4">i2s_master_slave_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a1c5e1132f4c7132d5b9406c686ccf0cb">masterSlave</a></td></tr>
|
|
<tr class="memdesc:a1c5e1132f4c7132d5b9406c686ccf0cb"><td class="mdescLeft"> </td><td class="mdescRight">Master / slave configuration. <br/></td></tr>
|
|
<tr class="separator:a1c5e1132f4c7132d5b9406c686ccf0cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12ec668a6228f392a06560c8e8274726"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12ec668a6228f392a06560c8e8274726"></a>
|
|
<a class="el" href="a00031.html#ga3d4817f257ec38092ef6f33c0e095a94">i2s_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a12ec668a6228f392a06560c8e8274726">mode</a></td></tr>
|
|
<tr class="memdesc:a12ec668a6228f392a06560c8e8274726"><td class="mdescLeft"> </td><td class="mdescRight">I2S mode. <br/></td></tr>
|
|
<tr class="separator:a12ec668a6228f392a06560c8e8274726"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5503468829bb449771c8496dacfe6fb6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5503468829bb449771c8496dacfe6fb6"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a5503468829bb449771c8496dacfe6fb6">rightLow</a></td></tr>
|
|
<tr class="memdesc:a5503468829bb449771c8496dacfe6fb6"><td class="mdescLeft"> </td><td class="mdescRight">Right channel data in low portion of FIFO. <br/></td></tr>
|
|
<tr class="separator:a5503468829bb449771c8496dacfe6fb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75a8cbc12136ef74916f71209e21113b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75a8cbc12136ef74916f71209e21113b"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a75a8cbc12136ef74916f71209e21113b">leftJust</a></td></tr>
|
|
<tr class="memdesc:a75a8cbc12136ef74916f71209e21113b"><td class="mdescLeft"> </td><td class="mdescRight">Left justify data in FIFO. <br/></td></tr>
|
|
<tr class="separator:a75a8cbc12136ef74916f71209e21113b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee2971273bdc7d60a8d07a84d5b0f314"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee2971273bdc7d60a8d07a84d5b0f314"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#aee2971273bdc7d60a8d07a84d5b0f314">sckPol</a></td></tr>
|
|
<tr class="memdesc:aee2971273bdc7d60a8d07a84d5b0f314"><td class="mdescLeft"> </td><td class="mdescRight">SCK polarity. <br/></td></tr>
|
|
<tr class="separator:aee2971273bdc7d60a8d07a84d5b0f314"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3cc74d91fe51abeae7a5bbb77fd83920"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cc74d91fe51abeae7a5bbb77fd83920"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a3cc74d91fe51abeae7a5bbb77fd83920">wsPol</a></td></tr>
|
|
<tr class="memdesc:a3cc74d91fe51abeae7a5bbb77fd83920"><td class="mdescLeft"> </td><td class="mdescRight">WS polarity. <br/></td></tr>
|
|
<tr class="separator:a3cc74d91fe51abeae7a5bbb77fd83920"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae54489ab2f0a78b1271d04f69c64494d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae54489ab2f0a78b1271d04f69c64494d"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ae54489ab2f0a78b1271d04f69c64494d">divider</a></td></tr>
|
|
<tr class="memdesc:ae54489ab2f0a78b1271d04f69c64494d"><td class="mdescLeft"> </td><td class="mdescRight">Flexcomm function clock divider (1 - 4096) <br/></td></tr>
|
|
<tr class="separator:ae54489ab2f0a78b1271d04f69c64494d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08c393f7fb7985c1469fc27eece2f444"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08c393f7fb7985c1469fc27eece2f444"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a08c393f7fb7985c1469fc27eece2f444">oneChannel</a></td></tr>
|
|
<tr class="memdesc:a08c393f7fb7985c1469fc27eece2f444"><td class="mdescLeft"> </td><td class="mdescRight">true mono, false stereo <br/></td></tr>
|
|
<tr class="separator:a08c393f7fb7985c1469fc27eece2f444"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7804296c524c18b636be8af8e627cc8a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7804296c524c18b636be8af8e627cc8a"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a7804296c524c18b636be8af8e627cc8a">dataLength</a></td></tr>
|
|
<tr class="memdesc:a7804296c524c18b636be8af8e627cc8a"><td class="mdescLeft"> </td><td class="mdescRight">Data length (4 - 32) <br/></td></tr>
|
|
<tr class="separator:a7804296c524c18b636be8af8e627cc8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae26048f5d1121ab49a35fd47035fce12"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae26048f5d1121ab49a35fd47035fce12"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ae26048f5d1121ab49a35fd47035fce12">frameLength</a></td></tr>
|
|
<tr class="memdesc:ae26048f5d1121ab49a35fd47035fce12"><td class="mdescLeft"> </td><td class="mdescRight">Frame width (4 - 512) <br/></td></tr>
|
|
<tr class="separator:ae26048f5d1121ab49a35fd47035fce12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ac2cff50b7b6cf4009c8285c7cc5894"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ac2cff50b7b6cf4009c8285c7cc5894"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a3ac2cff50b7b6cf4009c8285c7cc5894">position</a></td></tr>
|
|
<tr class="memdesc:a3ac2cff50b7b6cf4009c8285c7cc5894"><td class="mdescLeft"> </td><td class="mdescRight">Data position in the frame. <br/></td></tr>
|
|
<tr class="separator:a3ac2cff50b7b6cf4009c8285c7cc5894"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1838b2325574097b2b83ceb531a04561"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1838b2325574097b2b83ceb531a04561"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a1838b2325574097b2b83ceb531a04561">watermark</a></td></tr>
|
|
<tr class="memdesc:a1838b2325574097b2b83ceb531a04561"><td class="mdescLeft"> </td><td class="mdescRight">FIFO trigger level. <br/></td></tr>
|
|
<tr class="separator:a1838b2325574097b2b83ceb531a04561"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5248d3e8f8f464f85d13695e5b51450"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5248d3e8f8f464f85d13695e5b51450"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ac5248d3e8f8f464f85d13695e5b51450">txEmptyZero</a></td></tr>
|
|
<tr class="memdesc:ac5248d3e8f8f464f85d13695e5b51450"><td class="mdescLeft"> </td><td class="mdescRight">Transmit zero when buffer becomes empty or last item. <br/></td></tr>
|
|
<tr class="separator:ac5248d3e8f8f464f85d13695e5b51450"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81806913aaa20f7a6204d215c9510fdf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81806913aaa20f7a6204d215c9510fdf"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a81806913aaa20f7a6204d215c9510fdf">pack48</a></td></tr>
|
|
<tr class="memdesc:a81806913aaa20f7a6204d215c9510fdf"><td class="mdescLeft"> </td><td class="mdescRight">Packing format for 48-bit data (false - 24 bit values, true - alternating 32-bit and 16-bit values) <br/></td></tr>
|
|
<tr class="separator:a81806913aaa20f7a6204d215c9510fdf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00353" id="a00353"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _i2s_transfer</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a7e1639769facb3330f554448901824c7"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a7e1639769facb3330f554448901824c7">data</a></td></tr>
|
|
<tr class="memdesc:a7e1639769facb3330f554448901824c7"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to data buffer. <a href="#a7e1639769facb3330f554448901824c7">More...</a><br/></td></tr>
|
|
<tr class="separator:a7e1639769facb3330f554448901824c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20eea1329988a3a572c92b630cd3c589"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a20eea1329988a3a572c92b630cd3c589">dataSize</a></td></tr>
|
|
<tr class="memdesc:a20eea1329988a3a572c92b630cd3c589"><td class="mdescLeft"> </td><td class="mdescRight">Buffer size in bytes. <a href="#a20eea1329988a3a572c92b630cd3c589">More...</a><br/></td></tr>
|
|
<tr class="separator:a20eea1329988a3a572c92b630cd3c589"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a7e1639769facb3330f554448901824c7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* _i2s_transfer::data</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a20eea1329988a3a572c92b630cd3c589"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _i2s_transfer::dataSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00352" id="a00352"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _i2s_handle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a2b6ba4838ea585a669d8e9ab6f63fc36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b6ba4838ea585a669d8e9ab6f63fc36"></a>
|
|
volatile uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a2b6ba4838ea585a669d8e9ab6f63fc36">state</a></td></tr>
|
|
<tr class="memdesc:a2b6ba4838ea585a669d8e9ab6f63fc36"><td class="mdescLeft"> </td><td class="mdescRight">State of transfer. <br/></td></tr>
|
|
<tr class="separator:a2b6ba4838ea585a669d8e9ab6f63fc36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78f7fa243f3c5be356c346bd975abdaa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78f7fa243f3c5be356c346bd975abdaa"></a>
|
|
<a class="el" href="a00031.html#gaf04bcafbb89c4d0a47ac0acfcc958faf">i2s_transfer_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a78f7fa243f3c5be356c346bd975abdaa">completionCallback</a></td></tr>
|
|
<tr class="memdesc:a78f7fa243f3c5be356c346bd975abdaa"><td class="mdescLeft"> </td><td class="mdescRight">Callback function pointer. <br/></td></tr>
|
|
<tr class="separator:a78f7fa243f3c5be356c346bd975abdaa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45a62e2e9f73d1eecb7d502f7f10c120"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45a62e2e9f73d1eecb7d502f7f10c120"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a45a62e2e9f73d1eecb7d502f7f10c120">userData</a></td></tr>
|
|
<tr class="memdesc:a45a62e2e9f73d1eecb7d502f7f10c120"><td class="mdescLeft"> </td><td class="mdescRight">Application data passed to callback. <br/></td></tr>
|
|
<tr class="separator:a45a62e2e9f73d1eecb7d502f7f10c120"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f1bd07030d0e210ff1e6f6ad6d719bf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f1bd07030d0e210ff1e6f6ad6d719bf"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a8f1bd07030d0e210ff1e6f6ad6d719bf">oneChannel</a></td></tr>
|
|
<tr class="memdesc:a8f1bd07030d0e210ff1e6f6ad6d719bf"><td class="mdescLeft"> </td><td class="mdescRight">true mono, false stereo <br/></td></tr>
|
|
<tr class="separator:a8f1bd07030d0e210ff1e6f6ad6d719bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68dc6d1db2522cb65afc39aee85d8d05"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68dc6d1db2522cb65afc39aee85d8d05"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a68dc6d1db2522cb65afc39aee85d8d05">dataLength</a></td></tr>
|
|
<tr class="memdesc:a68dc6d1db2522cb65afc39aee85d8d05"><td class="mdescLeft"> </td><td class="mdescRight">Data length (4 - 32) <br/></td></tr>
|
|
<tr class="separator:a68dc6d1db2522cb65afc39aee85d8d05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a891c81c9139910e7cbe6f4e00f4ff4ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a891c81c9139910e7cbe6f4e00f4ff4ef"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a891c81c9139910e7cbe6f4e00f4ff4ef">pack48</a></td></tr>
|
|
<tr class="memdesc:a891c81c9139910e7cbe6f4e00f4ff4ef"><td class="mdescLeft"> </td><td class="mdescRight">Packing format for 48-bit data (false - 24 bit values, true - alternating 32-bit and 16-bit values) <br/></td></tr>
|
|
<tr class="separator:a891c81c9139910e7cbe6f4e00f4ff4ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab65e366698b7ce5ec4143521d67ed864"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab65e366698b7ce5ec4143521d67ed864"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ab65e366698b7ce5ec4143521d67ed864">watermark</a></td></tr>
|
|
<tr class="memdesc:ab65e366698b7ce5ec4143521d67ed864"><td class="mdescLeft"> </td><td class="mdescRight">FIFO trigger level. <br/></td></tr>
|
|
<tr class="separator:ab65e366698b7ce5ec4143521d67ed864"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7d2ae4a2d1b017d66bc187519a5950a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7d2ae4a2d1b017d66bc187519a5950a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ad7d2ae4a2d1b017d66bc187519a5950a">useFifo48H</a></td></tr>
|
|
<tr class="memdesc:ad7d2ae4a2d1b017d66bc187519a5950a"><td class="mdescLeft"> </td><td class="mdescRight">When dataLength 17-24: true use FIFOWR48H, false use FIFOWR. <br/></td></tr>
|
|
<tr class="separator:ad7d2ae4a2d1b017d66bc187519a5950a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18d68d3f43b4fb681e93b0b8ef9461e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18d68d3f43b4fb681e93b0b8ef9461e9"></a>
|
|
volatile <a class="el" href="a00031.html#ga954fbb10efcf6b2993c1d91706835605">i2s_transfer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a18d68d3f43b4fb681e93b0b8ef9461e9">i2sQueue</a> [<a class="el" href="a00031.html#gae17f5f49178cc3ab239917f6454792d0">I2S_NUM_BUFFERS</a>]</td></tr>
|
|
<tr class="memdesc:a18d68d3f43b4fb681e93b0b8ef9461e9"><td class="mdescLeft"> </td><td class="mdescRight">Transfer queue storing transfer buffers. <br/></td></tr>
|
|
<tr class="separator:a18d68d3f43b4fb681e93b0b8ef9461e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa981d5d76a9c81a37200b0dfa72cf11b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa981d5d76a9c81a37200b0dfa72cf11b"></a>
|
|
volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#aa981d5d76a9c81a37200b0dfa72cf11b">queueUser</a></td></tr>
|
|
<tr class="memdesc:aa981d5d76a9c81a37200b0dfa72cf11b"><td class="mdescLeft"> </td><td class="mdescRight">Queue index where user's next transfer will be stored. <br/></td></tr>
|
|
<tr class="separator:aa981d5d76a9c81a37200b0dfa72cf11b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62800d42eef97ffcd6faafa8bd30ade0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62800d42eef97ffcd6faafa8bd30ade0"></a>
|
|
volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a62800d42eef97ffcd6faafa8bd30ade0">queueDriver</a></td></tr>
|
|
<tr class="memdesc:a62800d42eef97ffcd6faafa8bd30ade0"><td class="mdescLeft"> </td><td class="mdescRight">Queue index of buffer actually used by the driver. <br/></td></tr>
|
|
<tr class="separator:a62800d42eef97ffcd6faafa8bd30ade0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad01a19333ff3f3409990b09d808aa927"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad01a19333ff3f3409990b09d808aa927"></a>
|
|
volatile uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ad01a19333ff3f3409990b09d808aa927">errorCount</a></td></tr>
|
|
<tr class="memdesc:ad01a19333ff3f3409990b09d808aa927"><td class="mdescLeft"> </td><td class="mdescRight">Number of buffer underruns/overruns. <br/></td></tr>
|
|
<tr class="separator:ad01a19333ff3f3409990b09d808aa927"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03fb54228cba22c367cee351c4d871e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03fb54228cba22c367cee351c4d871e1"></a>
|
|
volatile uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a03fb54228cba22c367cee351c4d871e1">transferCount</a></td></tr>
|
|
<tr class="memdesc:a03fb54228cba22c367cee351c4d871e1"><td class="mdescLeft"> </td><td class="mdescRight">Number of bytes transferred. <br/></td></tr>
|
|
<tr class="separator:a03fb54228cba22c367cee351c4d871e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="gaf19f85eb3c13d6b8b839a62c30009710"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_I2S_DRIVER_VERSION   (<a class="el" href="a00242.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 3, 2))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae17f5f49178cc3ab239917f6454792d0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define I2S_NUM_BUFFERS   (4U)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga159bdb39995b1e978edbeffd7a419989"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00031.html#gadd818f4b96aee77ebab7fb143598061e">_i2s_flags</a> <a class="el" href="a00031.html#ga159bdb39995b1e978edbeffd7a419989">i2s_flags_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>These enums are meant to be OR'd together to form a bit mask. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga71cbcb2a1e42b043163f90e8fd81d8e4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00031.html#ga58fcc3bdc4a785b22d7a8f397e91911b">_i2s_master_slave</a> <a class="el" href="a00031.html#ga71cbcb2a1e42b043163f90e8fd81d8e4">i2s_master_slave_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3d4817f257ec38092ef6f33c0e095a94"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00031.html#ga5dd588fbfde93f136f6d27e71166f692">_i2s_mode</a> <a class="el" href="a00031.html#ga3d4817f257ec38092ef6f33c0e095a94">i2s_mode_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga04840f13f39a77aa775d4cd83cfd896d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00031.html#a00350">_i2s_config</a> <a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga954fbb10efcf6b2993c1d91706835605"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00031.html#a00353">_i2s_transfer</a> <a class="el" href="a00031.html#ga954fbb10efcf6b2993c1d91706835605">i2s_transfer_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf0c2f3939e61c1d862a90d9e42712c6e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00031.html#a00352">_i2s_handle</a> <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf04bcafbb89c4d0a47ac0acfcc958faf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* i2s_transfer_callback_t)(I2S_Type *base, <a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> *handle, <a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> completionStatus, void *userData)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to I2S transaction. </td></tr>
|
|
<tr><td class="paramname">completionStatus</td><td>status of the transaction. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>optional pointer to user arguments data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="gabc6126af1d45847bc59afa0aa3216b04"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggabc6126af1d45847bc59afa0aa3216b04a634ef87c7515bb4037dfaaea2d75b6e1"></a>kStatus_I2S_BufferComplete</em> </td><td class="fielddoc">
|
|
<p>Transfer from/into a single buffer has completed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabc6126af1d45847bc59afa0aa3216b04af123c761ef2616e6f48031b3f1103e48"></a>kStatus_I2S_Done</em> </td><td class="fielddoc">
|
|
<p>All buffers transfers have completed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabc6126af1d45847bc59afa0aa3216b04af73f348e9a8fe5cdf3c1ad097378d5b2"></a>kStatus_I2S_Busy</em> </td><td class="fielddoc">
|
|
<p>Already performing a transfer and cannot queue another buffer. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadd818f4b96aee77ebab7fb143598061e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00031.html#gadd818f4b96aee77ebab7fb143598061e">_i2s_flags</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>These enums are meant to be OR'd together to form a bit mask. </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggadd818f4b96aee77ebab7fb143598061ea4de8d6343bcebc3f15243732806fc564"></a>kI2S_TxErrorFlag</em> </td><td class="fielddoc">
|
|
<p>TX error interrupt. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggadd818f4b96aee77ebab7fb143598061eac3daa0c88fabb995e62e7f2803db4155"></a>kI2S_TxLevelFlag</em> </td><td class="fielddoc">
|
|
<p>TX level interrupt. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggadd818f4b96aee77ebab7fb143598061eaf26884847511b34b0197bb70c7c36989"></a>kI2S_RxErrorFlag</em> </td><td class="fielddoc">
|
|
<p>RX error interrupt. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggadd818f4b96aee77ebab7fb143598061eac29fb67960b694a776c8159a7b4487db"></a>kI2S_RxLevelFlag</em> </td><td class="fielddoc">
|
|
<p>RX level interrupt. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga58fcc3bdc4a785b22d7a8f397e91911b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00031.html#ga58fcc3bdc4a785b22d7a8f397e91911b">_i2s_master_slave</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga58fcc3bdc4a785b22d7a8f397e91911ba84bedf24f43a46b87a774e479da5b82b"></a>kI2S_MasterSlaveNormalSlave</em> </td><td class="fielddoc">
|
|
<p>Normal slave. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga58fcc3bdc4a785b22d7a8f397e91911ba2d7515b2fc53986d17636f3e16412b08"></a>kI2S_MasterSlaveWsSyncMaster</em> </td><td class="fielddoc">
|
|
<p>WS synchronized master. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga58fcc3bdc4a785b22d7a8f397e91911bad0b9c4656a3d40c936a7369d75c8d346"></a>kI2S_MasterSlaveExtSckMaster</em> </td><td class="fielddoc">
|
|
<p>Master using existing SCK. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga58fcc3bdc4a785b22d7a8f397e91911ba13ab2820eda5d509bb3ceff6fb28758b"></a>kI2S_MasterSlaveNormalMaster</em> </td><td class="fielddoc">
|
|
<p>Normal master. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5dd588fbfde93f136f6d27e71166f692"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00031.html#ga5dd588fbfde93f136f6d27e71166f692">_i2s_mode</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga5dd588fbfde93f136f6d27e71166f692ac0e4769e50d6318229c2dc31cd99bae3"></a>kI2S_ModeI2sClassic</em> </td><td class="fielddoc">
|
|
<p>I2S classic mode. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga5dd588fbfde93f136f6d27e71166f692a11364b25e57662ef4d1fc288ab12ddb1"></a>kI2S_ModeDspWs50</em> </td><td class="fielddoc">
|
|
<p>DSP mode, WS having 50% duty cycle. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga5dd588fbfde93f136f6d27e71166f692a6a42cbdc569ac3c30706fb6ba61db9d9"></a>kI2S_ModeDspWsShort</em> </td><td class="fielddoc">
|
|
<p>DSP mode, WS having one clock long pulse. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga5dd588fbfde93f136f6d27e71166f692a3bb54e6d9b9d1793637e1b82e323e829"></a>kI2S_ModeDspWsLong</em> </td><td class="fielddoc">
|
|
<p>DSP mode, WS having one data slot long pulse. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadc29c2ff13d900c2f185ee95427fb06c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggadc29c2ff13d900c2f185ee95427fb06ca61732beb4a722233e97ee814f949eb1d"></a>kI2S_SecondaryChannel1</em> </td><td class="fielddoc">
|
|
<p>secondary channel 1 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggadc29c2ff13d900c2f185ee95427fb06ca916a9db0c16edbddbe7dc96f578948b0"></a>kI2S_SecondaryChannel2</em> </td><td class="fielddoc">
|
|
<p>secondary channel 2 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggadc29c2ff13d900c2f185ee95427fb06ca1e1a62b1c4e0ab9966f18d1a81c2362a"></a>kI2S_SecondaryChannel3</em> </td><td class="fielddoc">
|
|
<p>secondary channel 3 </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga5d68b2f69b625a753d498dab6758c5b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_TxInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Ungates the FLEXCOMM clock and configures the module for I2S transmission using a configuration structure. The configuration structure can be custom filled or set with default values by <a class="el" href="a00031.html#ga905cb886175d4a1f9ac2fbf8d2722cf6" title="Sets the I2S Tx configuration structure to default values. ">I2S_TxGetDefaultConfig()</a>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This API should be called at the beginning of the application to use the I2S driver.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">config</td><td>pointer to I2S configuration structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa71e9b55c275d5469c1e3f723dc55213"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_RxInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Ungates the FLEXCOMM clock and configures the module for I2S receive using a configuration structure. The configuration structure can be custom filled or set with default values by <a class="el" href="a00031.html#ga8356de62fea66f67a9803ee89a78805a" title="Sets the I2S Rx configuration structure to default values. ">I2S_RxGetDefaultConfig()</a>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This API should be called at the beginning of the application to use the I2S driver.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">config</td><td>pointer to I2S configuration structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga905cb886175d4a1f9ac2fbf8d2722cf6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_TxGetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This API initializes the configuration structure for use in <a class="el" href="a00031.html#ga5d68b2f69b625a753d498dab6758c5b9" title="Initializes the FLEXCOMM peripheral for I2S transmit functionality. ">I2S_TxInit()</a>. The initialized structure can remain unchanged in <a class="el" href="a00031.html#ga5d68b2f69b625a753d498dab6758c5b9" title="Initializes the FLEXCOMM peripheral for I2S transmit functionality. ">I2S_TxInit()</a>, or it can be modified before calling <a class="el" href="a00031.html#ga5d68b2f69b625a753d498dab6758c5b9" title="Initializes the FLEXCOMM peripheral for I2S transmit functionality. ">I2S_TxInit()</a>. Example: </p>
|
|
<div class="fragment"><div class="line"><a class="code" href="a00031.html#a00350">i2s_config_t</a> config;</div>
|
|
<div class="line"><a class="code" href="a00031.html#ga905cb886175d4a1f9ac2fbf8d2722cf6">I2S_TxGetDefaultConfig</a>(&config);</div>
|
|
</div><!-- fragment --><p>Default values: </p>
|
|
<div class="fragment"><div class="line">* config-><a class="code" href="a00031.html#a1c5e1132f4c7132d5b9406c686ccf0cb">masterSlave</a> = <a class="code" href="a00031.html#gga58fcc3bdc4a785b22d7a8f397e91911ba13ab2820eda5d509bb3ceff6fb28758b">kI2S_MasterSlaveNormalMaster</a>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a12ec668a6228f392a06560c8e8274726">mode</a> = <a class="code" href="a00031.html#gga5dd588fbfde93f136f6d27e71166f692ac0e4769e50d6318229c2dc31cd99bae3">kI2S_ModeI2sClassic</a>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a5503468829bb449771c8496dacfe6fb6">rightLow</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a75a8cbc12136ef74916f71209e21113b">leftJust</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config->pdmData = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#aee2971273bdc7d60a8d07a84d5b0f314">sckPol</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a3cc74d91fe51abeae7a5bbb77fd83920">wsPol</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#ae54489ab2f0a78b1271d04f69c64494d">divider</a> = 1;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a08c393f7fb7985c1469fc27eece2f444">oneChannel</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a7804296c524c18b636be8af8e627cc8a">dataLength</a> = 16;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#ae26048f5d1121ab49a35fd47035fce12">frameLength</a> = 32;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a3ac2cff50b7b6cf4009c8285c7cc5894">position</a> = 0;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a1838b2325574097b2b83ceb531a04561">watermark</a> = 4;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#ac5248d3e8f8f464f85d13695e5b51450">txEmptyZero</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a81806913aaa20f7a6204d215c9510fdf">pack48</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>pointer to I2S configuration structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8356de62fea66f67a9803ee89a78805a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_RxGetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#ga04840f13f39a77aa775d4cd83cfd896d">i2s_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This API initializes the configuration structure for use in <a class="el" href="a00031.html#gaa71e9b55c275d5469c1e3f723dc55213" title="Initializes the FLEXCOMM peripheral for I2S receive functionality. ">I2S_RxInit()</a>. The initialized structure can remain unchanged in <a class="el" href="a00031.html#gaa71e9b55c275d5469c1e3f723dc55213" title="Initializes the FLEXCOMM peripheral for I2S receive functionality. ">I2S_RxInit()</a>, or it can be modified before calling <a class="el" href="a00031.html#gaa71e9b55c275d5469c1e3f723dc55213" title="Initializes the FLEXCOMM peripheral for I2S receive functionality. ">I2S_RxInit()</a>. Example: </p>
|
|
<div class="fragment"><div class="line"><a class="code" href="a00031.html#a00350">i2s_config_t</a> config;</div>
|
|
<div class="line"><a class="code" href="a00031.html#ga8356de62fea66f67a9803ee89a78805a">I2S_RxGetDefaultConfig</a>(&config);</div>
|
|
</div><!-- fragment --><p>Default values: </p>
|
|
<div class="fragment"><div class="line">* config-><a class="code" href="a00031.html#a1c5e1132f4c7132d5b9406c686ccf0cb">masterSlave</a> = <a class="code" href="a00031.html#gga58fcc3bdc4a785b22d7a8f397e91911ba84bedf24f43a46b87a774e479da5b82b">kI2S_MasterSlaveNormalSlave</a>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a12ec668a6228f392a06560c8e8274726">mode</a> = <a class="code" href="a00031.html#gga5dd588fbfde93f136f6d27e71166f692ac0e4769e50d6318229c2dc31cd99bae3">kI2S_ModeI2sClassic</a>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a5503468829bb449771c8496dacfe6fb6">rightLow</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a75a8cbc12136ef74916f71209e21113b">leftJust</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config->pdmData = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#aee2971273bdc7d60a8d07a84d5b0f314">sckPol</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a3cc74d91fe51abeae7a5bbb77fd83920">wsPol</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#ae54489ab2f0a78b1271d04f69c64494d">divider</a> = 1;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a08c393f7fb7985c1469fc27eece2f444">oneChannel</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a7804296c524c18b636be8af8e627cc8a">dataLength</a> = 16;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#ae26048f5d1121ab49a35fd47035fce12">frameLength</a> = 32;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a3ac2cff50b7b6cf4009c8285c7cc5894">position</a> = 0;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a1838b2325574097b2b83ceb531a04561">watermark</a> = 4;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#ac5248d3e8f8f464f85d13695e5b51450">txEmptyZero</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config-><a class="code" href="a00031.html#a81806913aaa20f7a6204d215c9510fdf">pack48</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>pointer to I2S configuration structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga68e9243ae7345a144668c7e04f1f52ac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This API gates the FLEXCOMM clock. The I2S module can't operate unless I2S_TxInit or I2S_RxInit is called to enable the clock.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga06dba1e2ecbb367719f60c9470ddd1fa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_SetBitClockRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>sourceClockHz</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>sampleRate</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>bitWidth</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>channelNumbers</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SAI base pointer. </td></tr>
|
|
<tr><td class="paramname">sourceClockHz</td><td>bit clock source frequency. </td></tr>
|
|
<tr><td class="paramname">sampleRate</td><td>audio data sample rate. </td></tr>
|
|
<tr><td class="paramname">bitWidth</td><td>audio data bitWidth. </td></tr>
|
|
<tr><td class="paramname">channelNumbers</td><td>audio channel numbers. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0e630bdd0adb5a39b52e374ede7bc07f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_TxTransferCreateHandle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf04bcafbb89c4d0a47ac0acfcc958faf">i2s_transfer_callback_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>userData</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>function to be called back when transfer is done or fails. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>pointer to data passed to callback. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8e341c9ce48e5be03e120ea332758048"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> I2S_TxTransferNonBlocking </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#ga954fbb10efcf6b2993c1d91706835605">i2s_transfer_t</a> </td>
|
|
<td class="paramname"><em>transfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
<tr><td class="paramname">transfer</td><td>data buffer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td></td></tr>
|
|
<tr><td class="paramname">kStatus_I2S_Busy</td><td>if all queue slots are occupied with unsent buffers. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga25659519f70757bf2db3831f7e807bd8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_TxTransferAbort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabd8c54c9689fd89024c83bb883693c16"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_RxTransferCreateHandle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf04bcafbb89c4d0a47ac0acfcc958faf">i2s_transfer_callback_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>userData</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>function to be called back when transfer is done or fails. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>pointer to data passed to callback. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga454cba72bec3ebeecf865570ce6ed900"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> I2S_RxTransferNonBlocking </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#ga954fbb10efcf6b2993c1d91706835605">i2s_transfer_t</a> </td>
|
|
<td class="paramname"><em>transfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
<tr><td class="paramname">transfer</td><td>data buffer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td></td></tr>
|
|
<tr><td class="paramname">kStatus_I2S_Busy</td><td>if all queue slots are occupied with buffers which are not full. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga32eb018b43745a695ef26cec1ff73a73"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_RxTransferAbort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga14ef749f4300fe7b1fd38277f0ef167f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> I2S_TransferGetCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>number of bytes transferred so far by the non-blocking transaction.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td></td></tr>
|
|
<tr><td class="paramname">kStatus_NoTransferInProgress</td><td>there is no non-blocking transaction currently in progress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae3d210a830859e93103931b4baf83586"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> I2S_TransferGetErrorCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>number of transmit errors encountered so far by the non-blocking transaction.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td></td></tr>
|
|
<tr><td class="paramname">kStatus_NoTransferInProgress</td><td>there is no non-blocking transaction currently in progress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac109aadc23d6f31e6f8420fa3f4018fd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void I2S_Enable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4b393781ae83a07d4d3e99972429cfa1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void I2S_Disable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga435263725c056eccaa82eb1947e162aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void I2S_EnableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>interruptMask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">interruptMask</td><td>bit mask of interrupts to enable. See <a class="el" href="a00031.html#ga159bdb39995b1e978edbeffd7a419989" title="I2S flags. ">i2s_flags_t</a> for the set of constants that should be OR'd together to form the bit mask. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa6f8ed52f3cd5c63b3a3716a70c77223"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void I2S_DisableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>interruptMask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">interruptMask</td><td>bit mask of interrupts to enable. See <a class="el" href="a00031.html#ga159bdb39995b1e978edbeffd7a419989" title="I2S flags. ">i2s_flags_t</a> for the set of constants that should be OR'd together to form the bit mask. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2d96a8f63e454de7225a98541b6461b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t I2S_GetEnabledInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A bitmask composed of <a class="el" href="a00031.html#ga159bdb39995b1e978edbeffd7a419989" title="I2S flags. ">i2s_flags_t</a> enumerators OR'd together to indicate the set of enabled interrupts. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8d8c443026cca28ef0c8f9890a894829"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> I2S_EmptyTxFifo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>kStatus_Fail empty TX fifo failed, kStatus_Success empty tx fifo success. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2423f95dc2c00bce6a9de6d868d1fde2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_TxHandleIRQ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaeff61f8cbd780c881c593ad059f98338"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2S_RxHandleIRQ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">I2S_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00031.html#gaf0c2f3939e61c1d862a90d9e42712c6e">i2s_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>I2S base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>pointer to handle structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|