558 lines
33 KiB
HTML
558 lines
33 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: LPI2C Master DMA 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('a00048.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">LPI2C Master DMA Driver<div class="ingroups"><a class="el" href="a00280.html">LPI2C: Low Power Inter-Integrated Circuit 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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00430"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a00430">_lpi2c_master_edma_handle</a></td></tr>
|
|
<tr class="memdesc:a00430"><td class="mdescLeft"> </td><td class="mdescRight">Driver handle for master DMA APIs. <a href="a00048.html#a00430">More...</a><br/></td></tr>
|
|
<tr class="separator:a00430"><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:ga16012d2064164c596b78c1cbbde8b683"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
|
|
<a class="el" href="a00048.html#a00430">_lpi2c_master_edma_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a></td></tr>
|
|
<tr class="memdesc:ga16012d2064164c596b78c1cbbde8b683"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C master EDMA handle of the transfer. <a href="#ga16012d2064164c596b78c1cbbde8b683">More...</a><br/></td></tr>
|
|
<tr class="separator:ga16012d2064164c596b78c1cbbde8b683"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga912fd1b24e90d46f274ea60152967df3"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ga912fd1b24e90d46f274ea60152967df3">lpi2c_master_edma_transfer_callback_t</a> )(LPI2C_Type *base, <a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a> *handle, <a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> completionStatus, void *userData)</td></tr>
|
|
<tr class="memdesc:ga912fd1b24e90d46f274ea60152967df3"><td class="mdescLeft"> </td><td class="mdescRight">Master DMA completion callback function pointer type. <a href="#ga912fd1b24e90d46f274ea60152967df3">More...</a><br/></td></tr>
|
|
<tr class="separator:ga912fd1b24e90d46f274ea60152967df3"><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>
|
|
Master DMA</h2></td></tr>
|
|
<tr class="memitem:ga6c1e29ea2310a600be54440afe2cb908"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ga6c1e29ea2310a600be54440afe2cb908">LPI2C_MasterCreateEDMAHandle</a> (LPI2C_Type *base, <a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a> *handle, <a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *rxDmaHandle, <a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *txDmaHandle, <a class="el" href="a00048.html#ga912fd1b24e90d46f274ea60152967df3">lpi2c_master_edma_transfer_callback_t</a> callback, void *userData)</td></tr>
|
|
<tr class="memdesc:ga6c1e29ea2310a600be54440afe2cb908"><td class="mdescLeft"> </td><td class="mdescRight">Create a new handle for the LPI2C master DMA APIs. <a href="#ga6c1e29ea2310a600be54440afe2cb908">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6c1e29ea2310a600be54440afe2cb908"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga476b7cc660bb47d8e587319c4eb8cc81"><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="a00048.html#ga476b7cc660bb47d8e587319c4eb8cc81">LPI2C_MasterTransferEDMA</a> (LPI2C_Type *base, <a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a> *handle, <a class="el" href="a00047.html#ga3ca84881363fc4223677496feefecb93">lpi2c_master_transfer_t</a> *transfer)</td></tr>
|
|
<tr class="memdesc:ga476b7cc660bb47d8e587319c4eb8cc81"><td class="mdescLeft"> </td><td class="mdescRight">Performs a non-blocking DMA-based transaction on the I2C bus. <a href="#ga476b7cc660bb47d8e587319c4eb8cc81">More...</a><br/></td></tr>
|
|
<tr class="separator:ga476b7cc660bb47d8e587319c4eb8cc81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8562c2ad1d79fb4bc573adfec9d6d28f"><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="a00048.html#ga8562c2ad1d79fb4bc573adfec9d6d28f">LPI2C_MasterTransferGetCountEDMA</a> (LPI2C_Type *base, <a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga8562c2ad1d79fb4bc573adfec9d6d28f"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of bytes transferred so far. <a href="#ga8562c2ad1d79fb4bc573adfec9d6d28f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8562c2ad1d79fb4bc573adfec9d6d28f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga45434e05020c1859a83f7c06c9ba173e"><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="a00048.html#ga45434e05020c1859a83f7c06c9ba173e">LPI2C_MasterTransferAbortEDMA</a> (LPI2C_Type *base, <a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga45434e05020c1859a83f7c06c9ba173e"><td class="mdescLeft"> </td><td class="mdescRight">Terminates a non-blocking LPI2C master transmission early. <a href="#ga45434e05020c1859a83f7c06c9ba173e">More...</a><br/></td></tr>
|
|
<tr class="separator:ga45434e05020c1859a83f7c06c9ba173e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00430" id="a00430"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _lpi2c_master_edma_handle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>The contents of this structure are private and subject to change. </dd></dl>
|
|
</div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a79e883a9efa5e0b825bc699dd10d1dc6"><td class="memItemLeft" align="right" valign="top">LPI2C_Type * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a79e883a9efa5e0b825bc699dd10d1dc6">base</a></td></tr>
|
|
<tr class="memdesc:a79e883a9efa5e0b825bc699dd10d1dc6"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C base pointer. <a href="#a79e883a9efa5e0b825bc699dd10d1dc6">More...</a><br/></td></tr>
|
|
<tr class="separator:a79e883a9efa5e0b825bc699dd10d1dc6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08e8f2b5f4c0757a25ade119161dd58a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a08e8f2b5f4c0757a25ade119161dd58a">isBusy</a></td></tr>
|
|
<tr class="memdesc:a08e8f2b5f4c0757a25ade119161dd58a"><td class="mdescLeft"> </td><td class="mdescRight">Transfer state machine current state. <a href="#a08e8f2b5f4c0757a25ade119161dd58a">More...</a><br/></td></tr>
|
|
<tr class="separator:a08e8f2b5f4c0757a25ade119161dd58a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a528a576ba6e3e6821d8e35ce82f20342"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a528a576ba6e3e6821d8e35ce82f20342">nbytes</a></td></tr>
|
|
<tr class="memdesc:a528a576ba6e3e6821d8e35ce82f20342"><td class="mdescLeft"> </td><td class="mdescRight">eDMA minor byte transfer count initially configured. <a href="#a528a576ba6e3e6821d8e35ce82f20342">More...</a><br/></td></tr>
|
|
<tr class="separator:a528a576ba6e3e6821d8e35ce82f20342"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee22948462f4ad7aa1d20049ab898469"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#aee22948462f4ad7aa1d20049ab898469">commandBuffer</a> [10]</td></tr>
|
|
<tr class="memdesc:aee22948462f4ad7aa1d20049ab898469"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C command sequence. <a href="#aee22948462f4ad7aa1d20049ab898469">More...</a><br/></td></tr>
|
|
<tr class="separator:aee22948462f4ad7aa1d20049ab898469"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3692092e64a6abd1f7061f9c8aa4f28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00047.html#ga3ca84881363fc4223677496feefecb93">lpi2c_master_transfer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ac3692092e64a6abd1f7061f9c8aa4f28">transfer</a></td></tr>
|
|
<tr class="memdesc:ac3692092e64a6abd1f7061f9c8aa4f28"><td class="mdescLeft"> </td><td class="mdescRight">Copy of the current transfer info. <a href="#ac3692092e64a6abd1f7061f9c8aa4f28">More...</a><br/></td></tr>
|
|
<tr class="separator:ac3692092e64a6abd1f7061f9c8aa4f28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c8e3d407fa7821028634295e893da29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00048.html#ga912fd1b24e90d46f274ea60152967df3">lpi2c_master_edma_transfer_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a0c8e3d407fa7821028634295e893da29">completionCallback</a></td></tr>
|
|
<tr class="memdesc:a0c8e3d407fa7821028634295e893da29"><td class="mdescLeft"> </td><td class="mdescRight">Callback function pointer. <a href="#a0c8e3d407fa7821028634295e893da29">More...</a><br/></td></tr>
|
|
<tr class="separator:a0c8e3d407fa7821028634295e893da29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cf5da6ed536fb9e4c545fea8596ad18"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a9cf5da6ed536fb9e4c545fea8596ad18">userData</a></td></tr>
|
|
<tr class="memdesc:a9cf5da6ed536fb9e4c545fea8596ad18"><td class="mdescLeft"> </td><td class="mdescRight">Application data passed to callback. <a href="#a9cf5da6ed536fb9e4c545fea8596ad18">More...</a><br/></td></tr>
|
|
<tr class="separator:a9cf5da6ed536fb9e4c545fea8596ad18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade69bccbfde1d55336f07ab7643c6956"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ade69bccbfde1d55336f07ab7643c6956">rx</a></td></tr>
|
|
<tr class="memdesc:ade69bccbfde1d55336f07ab7643c6956"><td class="mdescLeft"> </td><td class="mdescRight">Handle for receive DMA channel. <a href="#ade69bccbfde1d55336f07ab7643c6956">More...</a><br/></td></tr>
|
|
<tr class="separator:ade69bccbfde1d55336f07ab7643c6956"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad62364612f4fb146ff6bfea59dd2a8df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ad62364612f4fb146ff6bfea59dd2a8df">tx</a></td></tr>
|
|
<tr class="memdesc:ad62364612f4fb146ff6bfea59dd2a8df"><td class="mdescLeft"> </td><td class="mdescRight">Handle for transmit DMA channel. <a href="#ad62364612f4fb146ff6bfea59dd2a8df">More...</a><br/></td></tr>
|
|
<tr class="separator:ad62364612f4fb146ff6bfea59dd2a8df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5cb445d84f400e6b83380685e1c08479"><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="a00048.html#a5cb445d84f400e6b83380685e1c08479">tcds</a> [3]</td></tr>
|
|
<tr class="memdesc:a5cb445d84f400e6b83380685e1c08479"><td class="mdescLeft"> </td><td class="mdescRight">Software TCD. <a href="#a5cb445d84f400e6b83380685e1c08479">More...</a><br/></td></tr>
|
|
<tr class="separator:a5cb445d84f400e6b83380685e1c08479"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a79e883a9efa5e0b825bc699dd10d1dc6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LPI2C_Type* _lpi2c_master_edma_handle::base</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a08e8f2b5f4c0757a25ade119161dd58a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool _lpi2c_master_edma_handle::isBusy</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a528a576ba6e3e6821d8e35ce82f20342"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _lpi2c_master_edma_handle::nbytes</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aee22948462f4ad7aa1d20049ab898469"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t _lpi2c_master_edma_handle::commandBuffer[10]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>When all 10 command words are used: Start&addr&write[1 word] + subaddr[4 words] + restart&addr&read[1 word] + receive&Size[4 words] </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac3692092e64a6abd1f7061f9c8aa4f28"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00047.html#ga3ca84881363fc4223677496feefecb93">lpi2c_master_transfer_t</a> _lpi2c_master_edma_handle::transfer</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0c8e3d407fa7821028634295e893da29"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00048.html#ga912fd1b24e90d46f274ea60152967df3">lpi2c_master_edma_transfer_callback_t</a> _lpi2c_master_edma_handle::completionCallback</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9cf5da6ed536fb9e4c545fea8596ad18"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* _lpi2c_master_edma_handle::userData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ade69bccbfde1d55336f07ab7643c6956"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a>* _lpi2c_master_edma_handle::rx</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad62364612f4fb146ff6bfea59dd2a8df"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a>* _lpi2c_master_edma_handle::tx</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5cb445d84f400e6b83380685e1c08479"></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> _lpi2c_master_edma_handle::tcds[3]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Three are allocated to provide enough room to align to 32-bytes. </p>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga16012d2064164c596b78c1cbbde8b683"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00048.html#a00430">_lpi2c_master_edma_handle</a> <a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga912fd1b24e90d46f274ea60152967df3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* lpi2c_master_edma_transfer_callback_t)(LPI2C_Type *base, <a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_edma_handle_t</a> *handle, <a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> completionStatus, void *userData)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This callback is used only for the non-blocking master transfer API. Specify the callback you wish to use in the call to <a class="el" href="a00048.html#ga6c1e29ea2310a600be54440afe2cb908" title="Create a new handle for the LPI2C master DMA APIs. ">LPI2C_MasterCreateEDMAHandle()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Handle associated with the completed transfer. </td></tr>
|
|
<tr><td class="paramname">completionStatus</td><td>Either kStatus_Success or an error code describing how the transfer completed. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>Arbitrary pointer-sized value passed from the application. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga6c1e29ea2310a600be54440afe2cb908"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LPI2C_MasterCreateEDMAHandle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_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="a00022.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>rxDmaHandle</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>txDmaHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00048.html#ga912fd1b24e90d46f274ea60152967df3">lpi2c_master_edma_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">
|
|
<p>The creation of a handle is for use with the DMA APIs. Once a handle is created, there is not a corresponding destroy handle. If the user wants to terminate a transfer, the <a class="el" href="a00048.html#ga45434e05020c1859a83f7c06c9ba173e" title="Terminates a non-blocking LPI2C master transmission early. ">LPI2C_MasterTransferAbortEDMA()</a> API shall be called.</p>
|
|
<p>For devices where the LPI2C send and receive DMA requests are OR'd together, the <em>txDmaHandle</em> parameter is ignored and may be set to NULL.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">handle</td><td>Pointer to the LPI2C master driver handle. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">rxDmaHandle</td><td>Handle for the eDMA receive channel. Created by the user prior to calling this function. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">txDmaHandle</td><td>Handle for the eDMA transmit channel. Created by the user prior to calling this function. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">callback</td><td>User provided pointer to the asynchronous callback function. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">userData</td><td>User provided pointer to the application callback data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga476b7cc660bb47d8e587319c4eb8cc81"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> LPI2C_MasterTransferEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_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="a00047.html#ga3ca84881363fc4223677496feefecb93">lpi2c_master_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">
|
|
<p>The callback specified when the <em>handle</em> was created is invoked when the transaction has completed.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the LPI2C master driver handle. </td></tr>
|
|
<tr><td class="paramname">transfer</td><td>The pointer to the transfer descriptor. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>The transaction was started successfully. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="a00280.html#ggae8a3b6a5d0d3244ed73924ab2421a0d0af52a270e301641b8855edf3fcc843814" title="The master is already performing a transfer. ">kStatus_LPI2C_Busy</a></td><td>Either another master is currently utilizing the bus, or another DMA transaction is already in progress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8562c2ad1d79fb4bc573adfec9d6d28f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> LPI2C_MasterTransferGetCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_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="paramdir"></td><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>Pointer to the LPI2C master driver handle. </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 not a DMA transaction currently in progress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga45434e05020c1859a83f7c06c9ba173e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> LPI2C_MasterTransferAbortEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00048.html#ga16012d2064164c596b78c1cbbde8b683">lpi2c_master_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="section note"><dt>Note</dt><dd>It is not safe to call this function from an IRQ handler that has a higher priority than the eDMA peripheral's IRQ priority.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the LPI2C master driver handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>A transaction was successfully aborted. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="a00280.html#ggae8a3b6a5d0d3244ed73924ab2421a0d0a6603ec1135f58532c9d4accc3661bc27" title="The slave driver is idle. ">kStatus_LPI2C_Idle</a></td><td>There is not a DMA transaction currently 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>
|