660 lines
38 KiB
HTML
660 lines
38 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: FlexIO eDMA UART 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('a00037.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">FlexIO eDMA UART Driver<div class="ingroups"><a class="el" href="a00036.html">FlexIO UART 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:a00392"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a00392">_flexio_uart_edma_handle</a></td></tr>
|
|
<tr class="memdesc:a00392"><td class="mdescLeft"> </td><td class="mdescRight">UART eDMA handle. <a href="a00037.html#a00392">More...</a><br/></td></tr>
|
|
<tr class="separator:a00392"><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:gab5c1a2db5ce578862b1c444884f72355"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#gab5c1a2db5ce578862b1c444884f72355">flexio_uart_edma_transfer_callback_t</a> )(<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle, <a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, void *userData)</td></tr>
|
|
<tr class="memdesc:gab5c1a2db5ce578862b1c444884f72355"><td class="mdescLeft"> </td><td class="mdescRight">UART transfer callback function. <a href="#gab5c1a2db5ce578862b1c444884f72355">More...</a><br/></td></tr>
|
|
<tr class="separator:gab5c1a2db5ce578862b1c444884f72355"><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:ga27242859be8ca56fdd8d82d7610f4a03"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#ga27242859be8ca56fdd8d82d7610f4a03">FSL_FLEXIO_UART_EDMA_DRIVER_VERSION</a>   (<a class="el" href="a00260.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 4, 1))</td></tr>
|
|
<tr class="memdesc:ga27242859be8ca56fdd8d82d7610f4a03"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO UART EDMA driver version. <a href="#ga27242859be8ca56fdd8d82d7610f4a03">More...</a><br/></td></tr>
|
|
<tr class="separator:ga27242859be8ca56fdd8d82d7610f4a03"><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:ga12598454b08aa7d100725e73c8630ae7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#ga12598454b08aa7d100725e73c8630ae7">FLEXIO_UART_TransferCreateHandleEDMA</a> (<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle, <a class="el" href="a00037.html#gab5c1a2db5ce578862b1c444884f72355">flexio_uart_edma_transfer_callback_t</a> callback, void *userData, <a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *txEdmaHandle, <a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> *rxEdmaHandle)</td></tr>
|
|
<tr class="memdesc:ga12598454b08aa7d100725e73c8630ae7"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the UART handle which is used in transactional functions. <a href="#ga12598454b08aa7d100725e73c8630ae7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga12598454b08aa7d100725e73c8630ae7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga592b71f9369576017a12ad573c8e5b47"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#ga592b71f9369576017a12ad573c8e5b47">FLEXIO_UART_TransferSendEDMA</a> (<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle, <a class="el" href="a00036.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga592b71f9369576017a12ad573c8e5b47"><td class="mdescLeft"> </td><td class="mdescRight">Sends data using eDMA. <a href="#ga592b71f9369576017a12ad573c8e5b47">More...</a><br/></td></tr>
|
|
<tr class="separator:ga592b71f9369576017a12ad573c8e5b47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga68fddc9a6831266a2c1d1830511de33a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#ga68fddc9a6831266a2c1d1830511de33a">FLEXIO_UART_TransferReceiveEDMA</a> (<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle, <a class="el" href="a00036.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:ga68fddc9a6831266a2c1d1830511de33a"><td class="mdescLeft"> </td><td class="mdescRight">Receives data using eDMA. <a href="#ga68fddc9a6831266a2c1d1830511de33a">More...</a><br/></td></tr>
|
|
<tr class="separator:ga68fddc9a6831266a2c1d1830511de33a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga32be4133e9bf853fd62697942ac7522d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#ga32be4133e9bf853fd62697942ac7522d">FLEXIO_UART_TransferAbortSendEDMA</a> (<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga32be4133e9bf853fd62697942ac7522d"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the sent data which using eDMA. <a href="#ga32be4133e9bf853fd62697942ac7522d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga32be4133e9bf853fd62697942ac7522d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab9d8120552c8ce43a1ae2a1e557e65e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#gab9d8120552c8ce43a1ae2a1e557e65e8">FLEXIO_UART_TransferAbortReceiveEDMA</a> (<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:gab9d8120552c8ce43a1ae2a1e557e65e8"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the receive data which using eDMA. <a href="#gab9d8120552c8ce43a1ae2a1e557e65e8">More...</a><br/></td></tr>
|
|
<tr class="separator:gab9d8120552c8ce43a1ae2a1e557e65e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae59921c9719237fdf057a1794b87e87b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#gae59921c9719237fdf057a1794b87e87b">FLEXIO_UART_TransferGetSendCountEDMA</a> (<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:gae59921c9719237fdf057a1794b87e87b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of bytes sent out. <a href="#gae59921c9719237fdf057a1794b87e87b">More...</a><br/></td></tr>
|
|
<tr class="separator:gae59921c9719237fdf057a1794b87e87b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga35dc8301e5049ca39a7538a4ae70585a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#ga35dc8301e5049ca39a7538a4ae70585a">FLEXIO_UART_TransferGetReceiveCountEDMA</a> (<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga35dc8301e5049ca39a7538a4ae70585a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of bytes received. <a href="#ga35dc8301e5049ca39a7538a4ae70585a">More...</a><br/></td></tr>
|
|
<tr class="separator:ga35dc8301e5049ca39a7538a4ae70585a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00392" id="a00392"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _flexio_uart_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:aef83e978f70e106922c6a720590cdae9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00037.html#gab5c1a2db5ce578862b1c444884f72355">flexio_uart_edma_transfer_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#aef83e978f70e106922c6a720590cdae9">callback</a></td></tr>
|
|
<tr class="memdesc:aef83e978f70e106922c6a720590cdae9"><td class="mdescLeft"> </td><td class="mdescRight">Callback function. <a href="#aef83e978f70e106922c6a720590cdae9">More...</a><br/></td></tr>
|
|
<tr class="separator:aef83e978f70e106922c6a720590cdae9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d83eec0c65da6fa5ed583d1ab0a35e1"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a0d83eec0c65da6fa5ed583d1ab0a35e1">userData</a></td></tr>
|
|
<tr class="memdesc:a0d83eec0c65da6fa5ed583d1ab0a35e1"><td class="mdescLeft"> </td><td class="mdescRight">UART callback function parameter. <a href="#a0d83eec0c65da6fa5ed583d1ab0a35e1">More...</a><br/></td></tr>
|
|
<tr class="separator:a0d83eec0c65da6fa5ed583d1ab0a35e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45256d7196f9b31fe7e77c72f2ca8c1a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a45256d7196f9b31fe7e77c72f2ca8c1a">txDataSizeAll</a></td></tr>
|
|
<tr class="memdesc:a45256d7196f9b31fe7e77c72f2ca8c1a"><td class="mdescLeft"> </td><td class="mdescRight">Total bytes to be sent. <a href="#a45256d7196f9b31fe7e77c72f2ca8c1a">More...</a><br/></td></tr>
|
|
<tr class="separator:a45256d7196f9b31fe7e77c72f2ca8c1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6127da74811a5723b6c7fcf9ee3ad793"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a6127da74811a5723b6c7fcf9ee3ad793">rxDataSizeAll</a></td></tr>
|
|
<tr class="memdesc:a6127da74811a5723b6c7fcf9ee3ad793"><td class="mdescLeft"> </td><td class="mdescRight">Total bytes to be received. <a href="#a6127da74811a5723b6c7fcf9ee3ad793">More...</a><br/></td></tr>
|
|
<tr class="separator:a6127da74811a5723b6c7fcf9ee3ad793"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0424ba23043913b6825196c27fa5863c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a0424ba23043913b6825196c27fa5863c">txEdmaHandle</a></td></tr>
|
|
<tr class="memdesc:a0424ba23043913b6825196c27fa5863c"><td class="mdescLeft"> </td><td class="mdescRight">The eDMA TX channel used. <a href="#a0424ba23043913b6825196c27fa5863c">More...</a><br/></td></tr>
|
|
<tr class="separator:a0424ba23043913b6825196c27fa5863c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addf127a2e5ad1aef6f63d352cee25810"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#addf127a2e5ad1aef6f63d352cee25810">rxEdmaHandle</a></td></tr>
|
|
<tr class="memdesc:addf127a2e5ad1aef6f63d352cee25810"><td class="mdescLeft"> </td><td class="mdescRight">The eDMA RX channel used. <a href="#addf127a2e5ad1aef6f63d352cee25810">More...</a><br/></td></tr>
|
|
<tr class="separator:addf127a2e5ad1aef6f63d352cee25810"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae237261bf33afdcd17114cd2b2bde92"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#aae237261bf33afdcd17114cd2b2bde92">nbytes</a></td></tr>
|
|
<tr class="memdesc:aae237261bf33afdcd17114cd2b2bde92"><td class="mdescLeft"> </td><td class="mdescRight">eDMA minor byte transfer count initially configured. <a href="#aae237261bf33afdcd17114cd2b2bde92">More...</a><br/></td></tr>
|
|
<tr class="separator:aae237261bf33afdcd17114cd2b2bde92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a048c435d538782320171effed4444e98"><td class="memItemLeft" align="right" valign="top">volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a048c435d538782320171effed4444e98">txState</a></td></tr>
|
|
<tr class="memdesc:a048c435d538782320171effed4444e98"><td class="mdescLeft"> </td><td class="mdescRight">TX transfer state. <a href="#a048c435d538782320171effed4444e98">More...</a><br/></td></tr>
|
|
<tr class="separator:a048c435d538782320171effed4444e98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1725e1b2282f1d0f9f47ab36247af11"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1725e1b2282f1d0f9f47ab36247af11"></a>
|
|
volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#ae1725e1b2282f1d0f9f47ab36247af11">rxState</a></td></tr>
|
|
<tr class="memdesc:ae1725e1b2282f1d0f9f47ab36247af11"><td class="mdescLeft"> </td><td class="mdescRight">RX transfer state. <br/></td></tr>
|
|
<tr class="separator:ae1725e1b2282f1d0f9f47ab36247af11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="aef83e978f70e106922c6a720590cdae9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00037.html#gab5c1a2db5ce578862b1c444884f72355">flexio_uart_edma_transfer_callback_t</a> _flexio_uart_edma_handle::callback</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0d83eec0c65da6fa5ed583d1ab0a35e1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* _flexio_uart_edma_handle::userData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a45256d7196f9b31fe7e77c72f2ca8c1a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _flexio_uart_edma_handle::txDataSizeAll</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6127da74811a5723b6c7fcf9ee3ad793"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _flexio_uart_edma_handle::rxDataSizeAll</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0424ba23043913b6825196c27fa5863c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a>* _flexio_uart_edma_handle::txEdmaHandle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="addf127a2e5ad1aef6f63d352cee25810"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a>* _flexio_uart_edma_handle::rxEdmaHandle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aae237261bf33afdcd17114cd2b2bde92"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _flexio_uart_edma_handle::nbytes</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a048c435d538782320171effed4444e98"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">volatile uint8_t _flexio_uart_edma_handle::txState</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga27242859be8ca56fdd8d82d7610f4a03"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_FLEXIO_UART_EDMA_DRIVER_VERSION   (<a class="el" href="a00260.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 4, 1))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="gab5c1a2db5ce578862b1c444884f72355"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* flexio_uart_edma_transfer_callback_t)(<a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00037.html#a00392">flexio_uart_edma_handle_t</a> *handle, <a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, void *userData)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga12598454b08aa7d100725e73c8630ae7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferCreateHandleEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00037.html#a00392">flexio_uart_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="a00037.html#gab5c1a2db5ce578862b1c444884f72355">flexio_uart_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 class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>txEdmaHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00021.html#ga00acb9562f35755920b20fde1bc9973e">edma_handle_t</a> * </td>
|
|
<td class="paramname"><em>rxEdmaHandle</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>Pointer to FLEXIO_UART_Type. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to flexio_uart_edma_handle_t structure. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>The callback function. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>The parameter of the callback function. </td></tr>
|
|
<tr><td class="paramname">rxEdmaHandle</td><td>User requested DMA handle for RX DMA transfer. </td></tr>
|
|
<tr><td class="paramname">txEdmaHandle</td><td>User requested DMA handle for TX DMA transfer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Successfully create the handle. </td></tr>
|
|
<tr><td class="paramname">kStatus_OutOfRange</td><td>The FlexIO SPI eDMA type/handle table out of range. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga592b71f9369576017a12ad573c8e5b47"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferSendEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00037.html#a00392">flexio_uart_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="a00036.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_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">
|
|
<p>This function sends data using eDMA. This is a non-blocking function, which returns right away. When all data is sent out, the send callback function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to FLEXIO_UART_Type </td></tr>
|
|
<tr><td class="paramname">handle</td><td>UART handle pointer. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>UART eDMA transfer structure, see <a class="el" href="a00036.html#ga92f01e08c15b9853ff72059fcbd1c64c" title="Define FlexIO UART transfer structure. ">flexio_uart_transfer_t</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>if succeed, others failed. </td></tr>
|
|
<tr><td class="paramname">kStatus_FLEXIO_UART_TxBusy</td><td>Previous transfer on going. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga68fddc9a6831266a2c1d1830511de33a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00037.html#a00392">flexio_uart_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="a00036.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_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">
|
|
<p>This function receives data using eDMA. This is a non-blocking function, which returns right away. When all data is received, the receive callback function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to FLEXIO_UART_Type </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to flexio_uart_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>UART eDMA transfer structure, see <a class="el" href="a00036.html#ga92f01e08c15b9853ff72059fcbd1c64c" title="Define FlexIO UART transfer structure. ">flexio_uart_transfer_t</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>if succeed, others failed. </td></tr>
|
|
<tr><td class="paramname">kStatus_UART_RxBusy</td><td>Previous transfer on going. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga32be4133e9bf853fd62697942ac7522d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_TransferAbortSendEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00037.html#a00392">flexio_uart_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">
|
|
<p>This function aborts sent data which using eDMA.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to FLEXIO_UART_Type </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to flexio_uart_edma_handle_t structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab9d8120552c8ce43a1ae2a1e557e65e8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_TransferAbortReceiveEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00037.html#a00392">flexio_uart_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">
|
|
<p>This function aborts the receive data which using eDMA.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to FLEXIO_UART_Type </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to flexio_uart_edma_handle_t structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae59921c9719237fdf057a1794b87e87b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferGetSendCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00037.html#a00392">flexio_uart_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">
|
|
<p>This function gets the number of bytes sent out.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to FLEXIO_UART_Type </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to flexio_uart_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">count</td><td>Number of bytes sent 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_NoTransferInProgress</td><td>transfer has finished or no transfer in progress. </td></tr>
|
|
<tr><td class="paramname">kStatus_Success</td><td>Successfully return the count. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga35dc8301e5049ca39a7538a4ae70585a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferGetReceiveCountEDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00036.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00037.html#a00392">flexio_uart_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">
|
|
<p>This function gets the number of bytes received.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to FLEXIO_UART_Type </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to flexio_uart_edma_handle_t structure </td></tr>
|
|
<tr><td class="paramname">count</td><td>Number of bytes received 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_NoTransferInProgress</td><td>transfer has finished or no transfer in progress. </td></tr>
|
|
<tr><td class="paramname">kStatus_Success</td><td>Successfully return the count. </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>
|