744 lines
45 KiB
HTML
744 lines
45 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: SPDIF eDMA 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('a00078.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="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SPDIF eDMA Driver<div class="ingroups"><a class="el" href="a00077.html">SPDIF: Sony/Philips Digital Interface</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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00529"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a00529">_spdif_edma_transfer</a></td></tr>
|
|
<tr class="memdesc:a00529"><td class="mdescLeft"> </td><td class="mdescRight">SPDIF transfer structure. <a href="a00078.html#a00529">More...</a><br/></td></tr>
|
|
<tr class="separator:a00529"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00528"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a00528">_spdif_edma_handle</a></td></tr>
|
|
<tr class="memdesc:a00528"><td class="mdescLeft"> </td><td class="mdescRight">SPDIF DMA transfer handle, users should not touch the content of the handle. <a href="a00078.html#a00528">More...</a><br/></td></tr>
|
|
<tr class="separator:a00528"><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:ga301f2d0b9a199636f3c105f26ebe0f57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga301f2d0b9a199636f3c105f26ebe0f57"></a>
|
|
typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga301f2d0b9a199636f3c105f26ebe0f57">spdif_edma_callback_t</a> )(SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle, <a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, void *userData)</td></tr>
|
|
<tr class="memdesc:ga301f2d0b9a199636f3c105f26ebe0f57"><td class="mdescLeft"> </td><td class="mdescRight">SPDIF eDMA transfer callback function for finish and error. <br/></td></tr>
|
|
<tr class="separator:ga301f2d0b9a199636f3c105f26ebe0f57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7bee16bc8fce0bfe7917d082f92ac27e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7bee16bc8fce0bfe7917d082f92ac27e"></a>
|
|
typedef struct <a class="el" href="a00078.html#a00529">_spdif_edma_transfer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga7bee16bc8fce0bfe7917d082f92ac27e">spdif_edma_transfer_t</a></td></tr>
|
|
<tr class="memdesc:ga7bee16bc8fce0bfe7917d082f92ac27e"><td class="mdescLeft"> </td><td class="mdescRight">SPDIF transfer structure. <br/></td></tr>
|
|
<tr class="separator:ga7bee16bc8fce0bfe7917d082f92ac27e"><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:ga0d52f502d4b64dc5587a12289e6738e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0d52f502d4b64dc5587a12289e6738e4"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga0d52f502d4b64dc5587a12289e6738e4">FSL_SPDIF_EDMA_DRIVER_VERSION</a>   (<a class="el" href="a00272.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 0, 6))</td></tr>
|
|
<tr class="memdesc:ga0d52f502d4b64dc5587a12289e6738e4"><td class="mdescLeft"> </td><td class="mdescRight">Version 2.0.6. <br/></td></tr>
|
|
<tr class="separator:ga0d52f502d4b64dc5587a12289e6738e4"><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>
|
|
eDMA Transactional</h2></td></tr>
|
|
<tr class="memitem:ga9b81a6190c5cc57120dae24864d17b78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga9b81a6190c5cc57120dae24864d17b78">SPDIF_TransferTxCreateHandleEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle, <a class="el" href="a00078.html#ga301f2d0b9a199636f3c105f26ebe0f57">spdif_edma_callback_t</a> callback, void *userData, <a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *dmaLeftHandle, <a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *dmaRightHandle)</td></tr>
|
|
<tr class="memdesc:ga9b81a6190c5cc57120dae24864d17b78"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the SPDIF eDMA handle. <a href="#ga9b81a6190c5cc57120dae24864d17b78">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9b81a6190c5cc57120dae24864d17b78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga997c6e8067aabb31c06d62dda8e18201"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga997c6e8067aabb31c06d62dda8e18201">SPDIF_TransferRxCreateHandleEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle, <a class="el" href="a00078.html#ga301f2d0b9a199636f3c105f26ebe0f57">spdif_edma_callback_t</a> callback, void *userData, <a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *dmaLeftHandle, <a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *dmaRightHandle)</td></tr>
|
|
<tr class="memdesc:ga997c6e8067aabb31c06d62dda8e18201"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the SPDIF Rx eDMA handle. <a href="#ga997c6e8067aabb31c06d62dda8e18201">More...</a><br/></td></tr>
|
|
<tr class="separator:ga997c6e8067aabb31c06d62dda8e18201"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8f6d1ca1ea0d14799cc268bc0d403b52"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga8f6d1ca1ea0d14799cc268bc0d403b52">SPDIF_TransferSendEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle, <a class="el" href="a00078.html#ga7bee16bc8fce0bfe7917d082f92ac27e">spdif_edma_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga8f6d1ca1ea0d14799cc268bc0d403b52"><td class="mdescLeft"> </td><td class="mdescRight">Performs a non-blocking SPDIF transfer using DMA. <a href="#ga8f6d1ca1ea0d14799cc268bc0d403b52">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8f6d1ca1ea0d14799cc268bc0d403b52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6a9055e2562ac1a740005a235add28d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga6a9055e2562ac1a740005a235add28d2">SPDIF_TransferReceiveEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle, <a class="el" href="a00078.html#ga7bee16bc8fce0bfe7917d082f92ac27e">spdif_edma_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga6a9055e2562ac1a740005a235add28d2"><td class="mdescLeft"> </td><td class="mdescRight">Performs a non-blocking SPDIF receive using eDMA. <a href="#ga6a9055e2562ac1a740005a235add28d2">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6a9055e2562ac1a740005a235add28d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga427c4b16d4f1fdea087e2ee2bb515565"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga427c4b16d4f1fdea087e2ee2bb515565">SPDIF_TransferAbortSendEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga427c4b16d4f1fdea087e2ee2bb515565"><td class="mdescLeft"> </td><td class="mdescRight">Aborts a SPDIF transfer using eDMA. <a href="#ga427c4b16d4f1fdea087e2ee2bb515565">More...</a><br/></td></tr>
|
|
<tr class="separator:ga427c4b16d4f1fdea087e2ee2bb515565"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga258da7096dcb32609e5bf8a6ca862ff7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga258da7096dcb32609e5bf8a6ca862ff7">SPDIF_TransferAbortReceiveEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga258da7096dcb32609e5bf8a6ca862ff7"><td class="mdescLeft"> </td><td class="mdescRight">Aborts a SPDIF receive using eDMA. <a href="#ga258da7096dcb32609e5bf8a6ca862ff7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga258da7096dcb32609e5bf8a6ca862ff7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac8a656d32c96ce22f86298daf8702449"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#gac8a656d32c96ce22f86298daf8702449">SPDIF_TransferGetSendCountEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:gac8a656d32c96ce22f86298daf8702449"><td class="mdescLeft"> </td><td class="mdescRight">Gets byte count sent by SPDIF. <a href="#gac8a656d32c96ce22f86298daf8702449">More...</a><br/></td></tr>
|
|
<tr class="separator:gac8a656d32c96ce22f86298daf8702449"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2372914f14224175a5d10130ce56b779"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ga2372914f14224175a5d10130ce56b779">SPDIF_TransferGetReceiveCountEDMA</a> (SPDIF_Type *base, <a class="el" href="a00078.html#a00528">spdif_edma_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga2372914f14224175a5d10130ce56b779"><td class="mdescLeft"> </td><td class="mdescRight">Gets byte count received by SPDIF. <a href="#ga2372914f14224175a5d10130ce56b779">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2372914f14224175a5d10130ce56b779"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00529" id="a00529"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _spdif_edma_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:a73cf51a860d8b2a0802021e2d2b00dc0"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a73cf51a860d8b2a0802021e2d2b00dc0">leftData</a></td></tr>
|
|
<tr class="memdesc:a73cf51a860d8b2a0802021e2d2b00dc0"><td class="mdescLeft"> </td><td class="mdescRight">Data start address to transfer. <a href="#a73cf51a860d8b2a0802021e2d2b00dc0">More...</a><br/></td></tr>
|
|
<tr class="separator:a73cf51a860d8b2a0802021e2d2b00dc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65eaecba74933b7d202426c1ba10acfc"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a65eaecba74933b7d202426c1ba10acfc">rightData</a></td></tr>
|
|
<tr class="memdesc:a65eaecba74933b7d202426c1ba10acfc"><td class="mdescLeft"> </td><td class="mdescRight">Data start address to transfer. <a href="#a65eaecba74933b7d202426c1ba10acfc">More...</a><br/></td></tr>
|
|
<tr class="separator:a65eaecba74933b7d202426c1ba10acfc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0029a1324de139d229a94c97cf7264d7"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a0029a1324de139d229a94c97cf7264d7">dataSize</a></td></tr>
|
|
<tr class="memdesc:a0029a1324de139d229a94c97cf7264d7"><td class="mdescLeft"> </td><td class="mdescRight">Transfer size. <a href="#a0029a1324de139d229a94c97cf7264d7">More...</a><br/></td></tr>
|
|
<tr class="separator:a0029a1324de139d229a94c97cf7264d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a73cf51a860d8b2a0802021e2d2b00dc0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* _spdif_edma_transfer::leftData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a65eaecba74933b7d202426c1ba10acfc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* _spdif_edma_transfer::rightData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0029a1324de139d229a94c97cf7264d7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _spdif_edma_transfer::dataSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00528" id="a00528"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _spdif_edma_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:ad53fcc5f37dcd780b5ed46592d2a2d43"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad53fcc5f37dcd780b5ed46592d2a2d43"></a>
|
|
<a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ad53fcc5f37dcd780b5ed46592d2a2d43">dmaLeftHandle</a></td></tr>
|
|
<tr class="memdesc:ad53fcc5f37dcd780b5ed46592d2a2d43"><td class="mdescLeft"> </td><td class="mdescRight">DMA handler for SPDIF left channel. <br/></td></tr>
|
|
<tr class="separator:ad53fcc5f37dcd780b5ed46592d2a2d43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14ff820b157940e28d96b619b44e5835"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14ff820b157940e28d96b619b44e5835"></a>
|
|
<a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a14ff820b157940e28d96b619b44e5835">dmaRightHandle</a></td></tr>
|
|
<tr class="memdesc:a14ff820b157940e28d96b619b44e5835"><td class="mdescLeft"> </td><td class="mdescRight">DMA handler for SPDIF right channel. <br/></td></tr>
|
|
<tr class="separator:a14ff820b157940e28d96b619b44e5835"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2da0a7b6e0edb696a64b4cd5e811fd5"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ab2da0a7b6e0edb696a64b4cd5e811fd5">nbytes</a></td></tr>
|
|
<tr class="memdesc:ab2da0a7b6e0edb696a64b4cd5e811fd5"><td class="mdescLeft"> </td><td class="mdescRight">eDMA minor byte transfer count initially configured. <a href="#ab2da0a7b6e0edb696a64b4cd5e811fd5">More...</a><br/></td></tr>
|
|
<tr class="separator:ab2da0a7b6e0edb696a64b4cd5e811fd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab782e2b28e2cdd342a94f9c3f4db3d67"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab782e2b28e2cdd342a94f9c3f4db3d67"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ab782e2b28e2cdd342a94f9c3f4db3d67">count</a></td></tr>
|
|
<tr class="memdesc:ab782e2b28e2cdd342a94f9c3f4db3d67"><td class="mdescLeft"> </td><td class="mdescRight">The transfer data count in a DMA request. <br/></td></tr>
|
|
<tr class="separator:ab782e2b28e2cdd342a94f9c3f4db3d67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c83c226450e040294b7465ab90bc9f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c83c226450e040294b7465ab90bc9f6"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a2c83c226450e040294b7465ab90bc9f6">state</a></td></tr>
|
|
<tr class="memdesc:a2c83c226450e040294b7465ab90bc9f6"><td class="mdescLeft"> </td><td class="mdescRight">Internal state for SPDIF eDMA transfer. <br/></td></tr>
|
|
<tr class="separator:a2c83c226450e040294b7465ab90bc9f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67abdc63adafff37d7f54bb13ac48a59"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67abdc63adafff37d7f54bb13ac48a59"></a>
|
|
<a class="el" href="a00078.html#ga301f2d0b9a199636f3c105f26ebe0f57">spdif_edma_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a67abdc63adafff37d7f54bb13ac48a59">callback</a></td></tr>
|
|
<tr class="memdesc:a67abdc63adafff37d7f54bb13ac48a59"><td class="mdescLeft"> </td><td class="mdescRight">Callback for users while transfer finish or error occurs. <br/></td></tr>
|
|
<tr class="separator:a67abdc63adafff37d7f54bb13ac48a59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a406a65f0685838550655890f1517f6b8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a406a65f0685838550655890f1517f6b8"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a406a65f0685838550655890f1517f6b8">userData</a></td></tr>
|
|
<tr class="memdesc:a406a65f0685838550655890f1517f6b8"><td class="mdescLeft"> </td><td class="mdescRight">User callback parameter. <br/></td></tr>
|
|
<tr class="separator:a406a65f0685838550655890f1517f6b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8bcc7f9aac0741bbaa7bad15364b6966"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#gacff054f9816fb678fc49f5e66a4d7649">edma_tcd_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a8bcc7f9aac0741bbaa7bad15364b6966">leftTcd</a> [<a class="el" href="a00077.html#ga3e78a3155b1291a9fa00d0461d6e490c">SPDIF_XFER_QUEUE_SIZE</a>+1U]</td></tr>
|
|
<tr class="memdesc:a8bcc7f9aac0741bbaa7bad15364b6966"><td class="mdescLeft"> </td><td class="mdescRight">TCD pool for eDMA transfer. <a href="#a8bcc7f9aac0741bbaa7bad15364b6966">More...</a><br/></td></tr>
|
|
<tr class="separator:a8bcc7f9aac0741bbaa7bad15364b6966"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bb2ffffc310417bf133ff190909224f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#gacff054f9816fb678fc49f5e66a4d7649">edma_tcd_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a6bb2ffffc310417bf133ff190909224f">rightTcd</a> [<a class="el" href="a00077.html#ga3e78a3155b1291a9fa00d0461d6e490c">SPDIF_XFER_QUEUE_SIZE</a>+1U]</td></tr>
|
|
<tr class="memdesc:a6bb2ffffc310417bf133ff190909224f"><td class="mdescLeft"> </td><td class="mdescRight">TCD pool for eDMA transfer. <a href="#a6bb2ffffc310417bf133ff190909224f">More...</a><br/></td></tr>
|
|
<tr class="separator:a6bb2ffffc310417bf133ff190909224f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab444c7c84f3be88f478507d13edf0e57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00078.html#ga7bee16bc8fce0bfe7917d082f92ac27e">spdif_edma_transfer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ab444c7c84f3be88f478507d13edf0e57">spdifQueue</a> [<a class="el" href="a00077.html#ga3e78a3155b1291a9fa00d0461d6e490c">SPDIF_XFER_QUEUE_SIZE</a>]</td></tr>
|
|
<tr class="memdesc:ab444c7c84f3be88f478507d13edf0e57"><td class="mdescLeft"> </td><td class="mdescRight">Transfer queue storing queued transfer. <a href="#ab444c7c84f3be88f478507d13edf0e57">More...</a><br/></td></tr>
|
|
<tr class="separator:ab444c7c84f3be88f478507d13edf0e57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a690ce6df7b6cd35d3665031951bb1f0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a690ce6df7b6cd35d3665031951bb1f0c"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a690ce6df7b6cd35d3665031951bb1f0c">transferSize</a> [<a class="el" href="a00077.html#ga3e78a3155b1291a9fa00d0461d6e490c">SPDIF_XFER_QUEUE_SIZE</a>]</td></tr>
|
|
<tr class="memdesc:a690ce6df7b6cd35d3665031951bb1f0c"><td class="mdescLeft"> </td><td class="mdescRight">Data bytes need to transfer, left and right are the same, so use one. <br/></td></tr>
|
|
<tr class="separator:a690ce6df7b6cd35d3665031951bb1f0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0222731e27952445ac95faf435651e72"><td class="memItemLeft" align="right" valign="top">volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a0222731e27952445ac95faf435651e72">queueUser</a></td></tr>
|
|
<tr class="memdesc:a0222731e27952445ac95faf435651e72"><td class="mdescLeft"> </td><td class="mdescRight">Index for user to queue transfer. <a href="#a0222731e27952445ac95faf435651e72">More...</a><br/></td></tr>
|
|
<tr class="separator:a0222731e27952445ac95faf435651e72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af918a94ea924a39a8780b9cdd2e99ded"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af918a94ea924a39a8780b9cdd2e99ded"></a>
|
|
volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#af918a94ea924a39a8780b9cdd2e99ded">queueDriver</a></td></tr>
|
|
<tr class="memdesc:af918a94ea924a39a8780b9cdd2e99ded"><td class="mdescLeft"> </td><td class="mdescRight">Index for driver to get the transfer data and size. <br/></td></tr>
|
|
<tr class="separator:af918a94ea924a39a8780b9cdd2e99ded"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="ab2da0a7b6e0edb696a64b4cd5e811fd5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _spdif_edma_handle::nbytes</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8bcc7f9aac0741bbaa7bad15364b6966"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#gacff054f9816fb678fc49f5e66a4d7649">edma_tcd_t</a> _spdif_edma_handle::leftTcd[<a class="el" href="a00077.html#ga3e78a3155b1291a9fa00d0461d6e490c">SPDIF_XFER_QUEUE_SIZE</a>+1U]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6bb2ffffc310417bf133ff190909224f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#gacff054f9816fb678fc49f5e66a4d7649">edma_tcd_t</a> _spdif_edma_handle::rightTcd[<a class="el" href="a00077.html#ga3e78a3155b1291a9fa00d0461d6e490c">SPDIF_XFER_QUEUE_SIZE</a>+1U]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab444c7c84f3be88f478507d13edf0e57"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00078.html#ga7bee16bc8fce0bfe7917d082f92ac27e">spdif_edma_transfer_t</a> _spdif_edma_handle::spdifQueue[<a class="el" href="a00077.html#ga3e78a3155b1291a9fa00d0461d6e490c">SPDIF_XFER_QUEUE_SIZE</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0222731e27952445ac95faf435651e72"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">volatile uint8_t _spdif_edma_handle::queueUser</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga9b81a6190c5cc57120dae24864d17b78"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SPDIF_TransferTxCreateHandleEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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="a00078.html#ga301f2d0b9a199636f3c105f26ebe0f57">spdif_edma_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 class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>dmaLeftHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>dmaRightHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes the SPDIF master DMA handle, which can be used for other SPDIF master transactional APIs. Usually, for a specified SPDIF instance, call this API once to get the initialized handle.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPDIF base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>Pointer to user callback function. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>User parameter passed to the callback function. </td></tr>
|
|
<tr><td class="paramname">dmaLeftHandle</td><td>eDMA handle pointer for left channel, this handle shall be static allocated by users. </td></tr>
|
|
<tr><td class="paramname">dmaRightHandle</td><td>eDMA handle pointer for right channel, this handle shall be static allocated by users. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga997c6e8067aabb31c06d62dda8e18201"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SPDIF_TransferRxCreateHandleEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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="a00078.html#ga301f2d0b9a199636f3c105f26ebe0f57">spdif_edma_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 class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>dmaLeftHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>dmaRightHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes the SPDIF slave DMA handle, which can be used for other SPDIF master transactional APIs. Usually, for a specified SPDIF instance, call this API once to get the initialized handle.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPDIF base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>Pointer to user callback function. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>User parameter passed to the callback function. </td></tr>
|
|
<tr><td class="paramname">dmaLeftHandle</td><td>eDMA handle pointer for left channel, this handle shall be static allocated by users. </td></tr>
|
|
<tr><td class="paramname">dmaRightHandle</td><td>eDMA handle pointer for right channel, this handle shall be static allocated by users. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8f6d1ca1ea0d14799cc268bc0d403b52"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> SPDIF_TransferSendEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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="a00078.html#ga7bee16bc8fce0bfe7917d082f92ac27e">spdif_edma_transfer_t</a> * </td>
|
|
<td class="paramname"><em>xfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This interface returns immediately after the transfer initiates. Call SPDIF_GetTransferStatus to poll the transfer status and check whether the SPDIF transfer is finished.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPDIF base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>Pointer to the DMA transfer structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Start a SPDIF eDMA send successfully. </td></tr>
|
|
<tr><td class="paramname">kStatus_InvalidArgument</td><td>The input argument is invalid. </td></tr>
|
|
<tr><td class="paramname">kStatus_TxBusy</td><td>SPDIF is busy sending data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6a9055e2562ac1a740005a235add28d2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> SPDIF_TransferReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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="a00078.html#ga7bee16bc8fce0bfe7917d082f92ac27e">spdif_edma_transfer_t</a> * </td>
|
|
<td class="paramname"><em>xfer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This interface returns immediately after the transfer initiates. Call the SPDIF_GetReceiveRemainingBytes to poll the transfer status and check whether the SPDIF transfer is finished.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>SPDIF base pointer </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>Pointer to DMA transfer structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Start a SPDIF eDMA receive successfully. </td></tr>
|
|
<tr><td class="paramname">kStatus_InvalidArgument</td><td>The input argument is invalid. </td></tr>
|
|
<tr><td class="paramname">kStatus_RxBusy</td><td>SPDIF is busy receiving data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga427c4b16d4f1fdea087e2ee2bb515565"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SPDIF_TransferAbortSendEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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>SPDIF base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga258da7096dcb32609e5bf8a6ca862ff7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SPDIF_TransferAbortReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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>SPDIF base pointer </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac8a656d32c96ce22f86298daf8702449"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> SPDIF_TransferGetSendCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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="paramname">base</td><td>SPDIF base pointer. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Bytes count sent by SPDIF. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Succeed get the transfer count. </td></tr>
|
|
<tr><td class="paramname">kStatus_NoTransferInProgress</td><td>There is no non-blocking transaction in progress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2372914f14224175a5d10130ce56b779"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> SPDIF_TransferGetReceiveCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SPDIF_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00078.html#a00528">spdif_edma_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="paramname">base</td><td>SPDIF base pointer </td></tr>
|
|
<tr><td class="paramname">handle</td><td>SPDIF eDMA handle pointer. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Bytes count received by SPDIF. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Succeed get the transfer count. </td></tr>
|
|
<tr><td class="paramname">kStatus_NoTransferInProgress</td><td>There is no non-blocking transaction in progress. </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>
|