2356 lines
149 KiB
HTML
2356 lines
149 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 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('a00038.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="#groups">Modules</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FlexIO UART Driver<div class="ingroups"><a class="el" href="a00278.html">FlexIO: FlexIO Driver</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<p>The MCUXpresso SDK provides a peripheral driver for the Universal Asynchronous Receiver/Transmitter (UART) function using the Flexible I/O.</p>
|
|
<p>FlexIO UART driver includes functional APIs and transactional APIs. Functional APIs target low-level APIs. Functional APIs can be used for the FlexIO UART initialization/configuration/operation for optimization/customization purpose. Using the functional APIs requires the knowledge of the FlexIO UART peripheral and how to organize functional APIs to meet the application requirements. All functional API use the FLEXIO_UART_Type * as the first parameter. FlexIO UART functional operation groups provide the functional APIs set.</p>
|
|
<p>Transactional APIs target high-level APIs. Transactional APIs can be used to enable the peripheral and also in the application if the code size and performance of transactional APIs satisfy requirements. If the code size and performance are critical requirements, see the transactional API implementation and write custom code. All transactional APIs use the flexio_uart_handle_t as the second parameter. Initialize the handle by calling the <a class="el" href="a00038.html#gadf3c35f0256cb25b15cb4005393b3431" title="Initializes the UART handle. ">FLEXIO_UART_TransferCreateHandle()</a> API.</p>
|
|
<p>Transactional APIs support asynchronous transfer. This means that the functions FLEXIO_UART_SendNonBlocking() and FLEXIO_UART_ReceiveNonBlocking() set up an interrupt for data transfer. When the transfer is complete, the upper layer is notified through a callback function with the kStatus_FLEXIO_UART_TxIdle and kStatus_FLEXIO_UART_RxIdle status.</p>
|
|
<p>Transactional receive APIs support the ring buffer. Prepare the memory for the ring buffer and pass in the start address and size through calling the FLEXIO_UART_InstallRingBuffer(). When the ring buffer is enabled, the received data is saved to the ring buffer in the background. The function FLEXIO_UART_ReceiveNonBlocking() first gets data the from the ring buffer. If ring buffer does not have enough data, the function returns the data to the ring buffer and saves the received data to user memory. When all data is received, the upper layer is informed through a callback with the statuskStatus_FLEXIO_UART_RxIdle status.</p>
|
|
<p>If the receive ring buffer is full, the upper layer is informed through a callback with status kStatus_FLEXIO_UART_RxRingBufferOverrun. In the callback function, the upper layer reads data from the ring buffer. If not, the oldest data is overwritten by the new data.</p>
|
|
<p>The ring buffer size is specified when calling the FLEXIO_UART_InstallRingBuffer. Note that one byte is reserved for the ring buffer maintenance. Create a handle as follows.</p>
|
|
<div class="fragment"><div class="line">FLEXIO_UART_InstallRingBuffer(&uartDev, &handle, &ringBuffer, 32);</div>
|
|
</div><!-- fragment --><p>In this example, the buffer size is 32. However, only 31 bytes are used for saving data.</p>
|
|
<h1><a class="anchor" id="FLEXIO_UARTCase"></a>
|
|
Typical use case</h1>
|
|
<h2><a class="anchor" id="FLEXIO_UARTCasePolling"></a>
|
|
FlexIO UART send/receive using a polling method</h2>
|
|
<div class="fragment"><div class="line">uint8_t ch;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> uartDev;</div>
|
|
<div class="line"><a class="code" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> result = <a class="code" href="a00272.html#ggabed82baf7f470b522273a3e37c24c600a829bee76c6b02225d9c891ae8ef70881">kStatus_Success</a>;</div>
|
|
<div class="line">flexio_uart_user_config user_config;</div>
|
|
<div class="line"><a class="code" href="a00038.html#gab705f673f07da7b1b385be7edfd2385e">FLEXIO_UART_GetDefaultConfig</a>(&user_config);</div>
|
|
<div class="line">user_config.baudRate_Bps = 115200U;</div>
|
|
<div class="line">user_config.enableUart = <span class="keyword">true</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line">uartDev.<a class="code" href="a00038.html#ae80333106e2b3ed8723a1ba780e3db0e">flexioBase</a> = BOARD_FLEXIO_BASE;</div>
|
|
<div class="line">uartDev.<a class="code" href="a00038.html#aa876273f088e8eebc92c3ae4be4614a1">TxPinIndex</a> = FLEXIO_UART_TX_PIN;</div>
|
|
<div class="line">uartDev.<a class="code" href="a00038.html#a85438b6f4b7d88017d4c05dba6f3d83e">RxPinIndex</a> = FLEXIO_UART_RX_PIN;</div>
|
|
<div class="line">uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[0] = 0U;</div>
|
|
<div class="line">uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[1] = 1U;</div>
|
|
<div class="line">uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[0] = 0U;</div>
|
|
<div class="line">uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[1] = 1U;</div>
|
|
<div class="line"></div>
|
|
<div class="line">result = <a class="code" href="a00038.html#ga8c9e0ca8c3517e21a27f7710d7d4f580">FLEXIO_UART_Init</a>(&uartDev, &user_config, 48000000U);</div>
|
|
<div class="line"><span class="comment">//Check if configuration is correct.</span></div>
|
|
<div class="line"><span class="keywordflow">if</span>(result != <a class="code" href="a00272.html#ggabed82baf7f470b522273a3e37c24c600a829bee76c6b02225d9c891ae8ef70881">kStatus_Success</a>)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keywordflow">return</span>;</div>
|
|
<div class="line">}</div>
|
|
<div class="line"><a class="code" href="a00038.html#gaa97558027d7fdf1475e46b65f0dd4d76">FLEXIO_UART_WriteBlocking</a>(&uartDev, txbuff, <span class="keyword">sizeof</span>(txbuff));</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="keywordflow">while</span>(1)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <a class="code" href="a00038.html#ga8c6339871092770c2e7409eac3803fa8">FLEXIO_UART_ReadBlocking</a>(&uartDev, &ch, 1);</div>
|
|
<div class="line"> <a class="code" href="a00038.html#gaa97558027d7fdf1475e46b65f0dd4d76">FLEXIO_UART_WriteBlocking</a>(&uartDev, &ch, 1);</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="FLEXIO_UARTCaseInterrupt"></a>
|
|
FlexIO UART send/receive using an interrupt method</h2>
|
|
<div class="fragment"><div class="line"><a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> uartDev;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00413">flexio_uart_handle_t</a> g_uartHandle;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00411">flexio_uart_config_t</a> user_config;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00414">flexio_uart_transfer_t</a> sendXfer;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00414">flexio_uart_transfer_t</a> receiveXfer;</div>
|
|
<div class="line"><span class="keyword">volatile</span> <span class="keywordtype">bool</span> txFinished;</div>
|
|
<div class="line"><span class="keyword">volatile</span> <span class="keywordtype">bool</span> rxFinished;</div>
|
|
<div class="line">uint8_t sendData[] = [<span class="charliteral">'H'</span>, <span class="charliteral">'e'</span>, <span class="charliteral">'l'</span>, <span class="charliteral">'l'</span>, <span class="charliteral">'o'</span>];</div>
|
|
<div class="line">uint8_t receiveData[32];</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="keywordtype">void</span> FLEXIO_UART_UserCallback(<a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> *base, <a class="code" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="code" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, <span class="keywordtype">void</span> *userData)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> userData = userData;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="a00038.html#gga16685eea158879e41b101ca3634de462a828da21609507716299bfc8640c57ec3">kStatus_FLEXIO_UART_TxIdle</a> == status)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> txFinished = <span class="keyword">true</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="a00038.html#gga16685eea158879e41b101ca3634de462a451ebbdc82bffc6c0205c7c9bd539046">kStatus_FLEXIO_UART_RxIdle</a> == status)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> rxFinished = <span class="keyword">true</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line">}</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="keywordtype">void</span> main(<span class="keywordtype">void</span>)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">//...</span></div>
|
|
<div class="line"></div>
|
|
<div class="line"> <a class="code" href="a00038.html#gab705f673f07da7b1b385be7edfd2385e">FLEXIO_UART_GetDefaultConfig</a>(&user_config);</div>
|
|
<div class="line"> user_config.<a class="code" href="a00038.html#a64b1a3cad4cefb854fb89bb0159fe47a">baudRate_Bps</a> = 115200U;</div>
|
|
<div class="line"> user_config.<a class="code" href="a00038.html#aed8115cbc75de0df22c5dba0f0875291">enableUart</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#ae80333106e2b3ed8723a1ba780e3db0e">flexioBase</a> = BOARD_FLEXIO_BASE;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#aa876273f088e8eebc92c3ae4be4614a1">TxPinIndex</a> = FLEXIO_UART_TX_PIN;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a85438b6f4b7d88017d4c05dba6f3d83e">RxPinIndex</a> = FLEXIO_UART_RX_PIN;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[0] = 0U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[1] = 1U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[0] = 0U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[1] = 1U;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> result = <a class="code" href="a00038.html#ga8c9e0ca8c3517e21a27f7710d7d4f580">FLEXIO_UART_Init</a>(&uartDev, &user_config, 120000000U);</div>
|
|
<div class="line"> <span class="comment">//Check if configuration is correct.</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span>(result != <a class="code" href="a00272.html#ggabed82baf7f470b522273a3e37c24c600a829bee76c6b02225d9c891ae8ef70881">kStatus_Success</a>)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> <span class="keywordflow">return</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <a class="code" href="a00038.html#gadf3c35f0256cb25b15cb4005393b3431">FLEXIO_UART_TransferCreateHandle</a>(&uartDev, &g_uartHandle, FLEXIO_UART_UserCallback, NULL);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Prepares to send.</span></div>
|
|
<div class="line"> sendXfer.<a class="code" href="a00038.html#a9e9b2de91956c9b4b118fb7b43a99a27">data</a> = sendData;</div>
|
|
<div class="line"> sendXfer.<a class="code" href="a00038.html#aa4c221e57175b9ef6882283f202acb41">dataSize</a> = <span class="keyword">sizeof</span>(sendData)/<span class="keyword">sizeof</span>(sendData[0]);</div>
|
|
<div class="line"> txFinished = <span class="keyword">false</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Sends out.</span></div>
|
|
<div class="line"> FLEXIO_UART_SendNonBlocking(&uartDev, &g_uartHandle, &sendXfer);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Send finished.</span></div>
|
|
<div class="line"> <span class="keywordflow">while</span> (!txFinished)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Prepares to receive.</span></div>
|
|
<div class="line"> receiveXfer.<a class="code" href="a00038.html#a9e9b2de91956c9b4b118fb7b43a99a27">data</a> = receiveData;</div>
|
|
<div class="line"> receiveXfer.<a class="code" href="a00038.html#aa4c221e57175b9ef6882283f202acb41">dataSize</a> = <span class="keyword">sizeof</span>(receiveData)/<span class="keyword">sizeof</span>(receiveData[0]);</div>
|
|
<div class="line"> rxFinished = <span class="keyword">false</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Receives.</span></div>
|
|
<div class="line"> FLEXIO_UART_ReceiveNonBlocking(&uartDev, &g_uartHandle, &receiveXfer, NULL);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Receive finished.</span></div>
|
|
<div class="line"> <span class="keywordflow">while</span> (!rxFinished)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// ...</span></div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="FLEXIO_UARTCaseRing"></a>
|
|
FlexIO UART receive using the ringbuffer feature</h2>
|
|
<div class="fragment"><div class="line"><span class="preprocessor">#define RING_BUFFER_SIZE 64</span></div>
|
|
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define RX_DATA_SIZE 32</span></div>
|
|
<div class="line"><span class="preprocessor"></span></div>
|
|
<div class="line"><a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> uartDev;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00413">flexio_uart_handle_t</a> g_uartHandle;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00411">flexio_uart_config_t</a> user_config;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00414">flexio_uart_transfer_t</a> sendXfer;</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00414">flexio_uart_transfer_t</a> receiveXfer;</div>
|
|
<div class="line"><span class="keyword">volatile</span> <span class="keywordtype">bool</span> txFinished;</div>
|
|
<div class="line"><span class="keyword">volatile</span> <span class="keywordtype">bool</span> rxFinished;</div>
|
|
<div class="line">uint8_t receiveData[RX_DATA_SIZE];</div>
|
|
<div class="line">uint8_t ringBuffer[RING_BUFFER_SIZE];</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="keywordtype">void</span> FLEXIO_UART_UserCallback(<a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> *base, <a class="code" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="code" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, <span class="keywordtype">void</span> *userData)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> userData = userData;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="a00038.html#gga16685eea158879e41b101ca3634de462a451ebbdc82bffc6c0205c7c9bd539046">kStatus_FLEXIO_UART_RxIdle</a> == status)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> rxFinished = <span class="keyword">true</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line">}</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="keywordtype">void</span> main(<span class="keywordtype">void</span>)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keywordtype">size_t</span> bytesRead;</div>
|
|
<div class="line"> <span class="comment">//...</span></div>
|
|
<div class="line"></div>
|
|
<div class="line"> <a class="code" href="a00038.html#gab705f673f07da7b1b385be7edfd2385e">FLEXIO_UART_GetDefaultConfig</a>(&user_config);</div>
|
|
<div class="line"> user_config.<a class="code" href="a00038.html#a64b1a3cad4cefb854fb89bb0159fe47a">baudRate_Bps</a> = 115200U;</div>
|
|
<div class="line"> user_config.<a class="code" href="a00038.html#aed8115cbc75de0df22c5dba0f0875291">enableUart</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#ae80333106e2b3ed8723a1ba780e3db0e">flexioBase</a> = BOARD_FLEXIO_BASE;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#aa876273f088e8eebc92c3ae4be4614a1">TxPinIndex</a> = FLEXIO_UART_TX_PIN;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a85438b6f4b7d88017d4c05dba6f3d83e">RxPinIndex</a> = FLEXIO_UART_RX_PIN;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[0] = 0U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[1] = 1U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[0] = 0U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[1] = 1U;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> result = <a class="code" href="a00038.html#ga8c9e0ca8c3517e21a27f7710d7d4f580">FLEXIO_UART_Init</a>(&uartDev, &user_config, 48000000U);</div>
|
|
<div class="line"> <span class="comment">//Check if configuration is correct.</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span>(result != <a class="code" href="a00272.html#ggabed82baf7f470b522273a3e37c24c600a829bee76c6b02225d9c891ae8ef70881">kStatus_Success</a>)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> <span class="keywordflow">return</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <a class="code" href="a00038.html#gadf3c35f0256cb25b15cb4005393b3431">FLEXIO_UART_TransferCreateHandle</a>(&uartDev, &g_uartHandle, FLEXIO_UART_UserCallback, NULL);</div>
|
|
<div class="line"> FLEXIO_UART_InstallRingBuffer(&uartDev, &g_uartHandle, ringBuffer, RING_BUFFER_SIZE);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Receive is working in the background to the ring buffer.</span></div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Prepares to receive.</span></div>
|
|
<div class="line"> receiveXfer.<a class="code" href="a00038.html#a9e9b2de91956c9b4b118fb7b43a99a27">data</a> = receiveData;</div>
|
|
<div class="line"> receiveXfer.<a class="code" href="a00038.html#aa4c221e57175b9ef6882283f202acb41">dataSize</a> = RX_DATA_SIZE;</div>
|
|
<div class="line"> rxFinished = <span class="keyword">false</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Receives.</span></div>
|
|
<div class="line"> FLEXIO_UART_ReceiveNonBlocking(&uartDev, &g_uartHandle, &receiveXfer, &bytesRead);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (bytesRead = RX_DATA_SIZE) <span class="comment">/* Have read enough data. */</span></div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> ;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">else</span></div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> <span class="keywordflow">if</span> (bytesRead) <span class="comment">/* Received some data, process first. */</span></div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> ;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Receive finished.</span></div>
|
|
<div class="line"> <span class="keywordflow">while</span> (!rxFinished)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// ...</span></div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="FLEXIO_UARTCaseDma"></a>
|
|
FlexIO UART send/receive using a DMA method</h2>
|
|
<div class="fragment"><div class="line"> <a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> uartDev;</div>
|
|
<div class="line"> <a class="code" href="a00038.html#a00413">flexio_uart_handle_t</a> g_uartHandle;</div>
|
|
<div class="line"> dma_handle_t g_uartTxDmaHandle;</div>
|
|
<div class="line"> dma_handle_t g_uartRxDmaHandle;</div>
|
|
<div class="line"> <a class="code" href="a00038.html#a00411">flexio_uart_config_t</a> user_config;</div>
|
|
<div class="line"> <a class="code" href="a00038.html#a00414">flexio_uart_transfer_t</a> sendXfer;</div>
|
|
<div class="line"> <a class="code" href="a00038.html#a00414">flexio_uart_transfer_t</a> receiveXfer;</div>
|
|
<div class="line"> <span class="keyword">volatile</span> <span class="keywordtype">bool</span> txFinished;</div>
|
|
<div class="line"> <span class="keyword">volatile</span> <span class="keywordtype">bool</span> rxFinished;</div>
|
|
<div class="line"> uint8_t sendData[] = [<span class="charliteral">'H'</span>, <span class="charliteral">'e'</span>, <span class="charliteral">'l'</span>, <span class="charliteral">'l'</span>, <span class="charliteral">'o'</span>];</div>
|
|
<div class="line"> uint8_t receiveData[32];</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordtype">void</span> FLEXIO_UART_UserCallback(<a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> *base, <a class="code" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="code" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, <span class="keywordtype">void</span> *userData)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> userData = userData;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="a00038.html#gga16685eea158879e41b101ca3634de462a828da21609507716299bfc8640c57ec3">kStatus_FLEXIO_UART_TxIdle</a> == status)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> txFinished = <span class="keyword">true</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="a00038.html#gga16685eea158879e41b101ca3634de462a451ebbdc82bffc6c0205c7c9bd539046">kStatus_FLEXIO_UART_RxIdle</a> == status)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> rxFinished = <span class="keyword">true</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="keywordtype">void</span> main(<span class="keywordtype">void</span>)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> <span class="comment">//...</span></div>
|
|
<div class="line"></div>
|
|
<div class="line"> <a class="code" href="a00038.html#gab705f673f07da7b1b385be7edfd2385e">FLEXIO_UART_GetDefaultConfig</a>(&user_config);</div>
|
|
<div class="line"> user_config.<a class="code" href="a00038.html#a64b1a3cad4cefb854fb89bb0159fe47a">baudRate_Bps</a> = 115200U;</div>
|
|
<div class="line"> user_config.<a class="code" href="a00038.html#aed8115cbc75de0df22c5dba0f0875291">enableUart</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#ae80333106e2b3ed8723a1ba780e3db0e">flexioBase</a> = BOARD_FLEXIO_BASE;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#aa876273f088e8eebc92c3ae4be4614a1">TxPinIndex</a> = FLEXIO_UART_TX_PIN;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a85438b6f4b7d88017d4c05dba6f3d83e">RxPinIndex</a> = FLEXIO_UART_RX_PIN;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[0] = 0U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[1] = 1U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[0] = 0U;</div>
|
|
<div class="line"> uartDev.<a class="code" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a>[1] = 1U;</div>
|
|
<div class="line"> result = <a class="code" href="a00038.html#ga8c9e0ca8c3517e21a27f7710d7d4f580">FLEXIO_UART_Init</a>(&uartDev, &user_config, 48000000U);</div>
|
|
<div class="line"> <span class="comment">//Check if configuration is correct.</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span>(result != <a class="code" href="a00272.html#ggabed82baf7f470b522273a3e37c24c600a829bee76c6b02225d9c891ae8ef70881">kStatus_Success</a>)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> <span class="keywordflow">return</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">/* Init DMAMUX. */</span></div>
|
|
<div class="line"> <a class="code" href="a00275.html#ga850545ac61a004df8ca312db2ca9db73">DMAMUX_Init</a>(EXAMPLE_FLEXIO_UART_DMAMUX_BASEADDR)</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">/* Init the DMA/EDMA module */</span></div>
|
|
<div class="line"><span class="preprocessor">#if defined(FSL_FEATURE_SOC_DMA_COUNT) && FSL_FEATURE_SOC_DMA_COUNT > 0U</span></div>
|
|
<div class="line"><span class="preprocessor"></span> DMA_Init(EXAMPLE_FLEXIO_UART_DMA_BASEADDR);</div>
|
|
<div class="line"> DMA_CreateHandle(&g_uartTxDmaHandle, EXAMPLE_FLEXIO_UART_DMA_BASEADDR, FLEXIO_UART_TX_DMA_CHANNEL);</div>
|
|
<div class="line"> DMA_CreateHandle(&g_uartRxDmaHandle, EXAMPLE_FLEXIO_UART_DMA_BASEADDR, FLEXIO_UART_RX_DMA_CHANNEL);</div>
|
|
<div class="line"><span class="preprocessor">#endif </span><span class="comment">/* FSL_FEATURE_SOC_DMA_COUNT */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><span class="preprocessor"></span></div>
|
|
<div class="line"><span class="preprocessor">#if defined(FSL_FEATURE_SOC_EDMA_COUNT) && FSL_FEATURE_SOC_EDMA_COUNT > 0U</span></div>
|
|
<div class="line"><span class="preprocessor"></span> <a class="code" href="a00022.html#a00351">edma_config_t</a> edmaConfig;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <a class="code" href="a00022.html#ga9851dc5addd6a1fc557bfdb625aa5c19">EDMA_GetDefaultConfig</a>(&edmaConfig);</div>
|
|
<div class="line"> <a class="code" href="a00022.html#gaf7588eb4b54499f0f55c698bd98bc1bb">EDMA_Init</a>(EXAMPLE_FLEXIO_UART_DMA_BASEADDR, &edmaConfig);</div>
|
|
<div class="line"> <a class="code" href="a00022.html#gae71842684e693908395784e8b7f7ef55">EDMA_CreateHandle</a>(&g_uartTxDmaHandle, EXAMPLE_FLEXIO_UART_DMA_BASEADDR, FLEXIO_UART_TX_DMA_CHANNEL);</div>
|
|
<div class="line"> <a class="code" href="a00022.html#gae71842684e693908395784e8b7f7ef55">EDMA_CreateHandle</a>(&g_uartRxDmaHandle, EXAMPLE_FLEXIO_UART_DMA_BASEADDR, FLEXIO_UART_RX_DMA_CHANNEL);</div>
|
|
<div class="line"><span class="preprocessor">#endif </span><span class="comment">/* FSL_FEATURE_SOC_EDMA_COUNT */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><span class="preprocessor"></span></div>
|
|
<div class="line"> dma_request_source_tx = (dma_request_source_t)(FLEXIO_DMA_REQUEST_BASE + uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[0]);</div>
|
|
<div class="line"> dma_request_source_rx = (dma_request_source_t)(FLEXIO_DMA_REQUEST_BASE + uartDev.<a class="code" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a>[1]);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">/* Requests DMA channels for transmit and receive. */</span></div>
|
|
<div class="line"> <a class="code" href="a00275.html#gab4cfa329d636dc52dffb7fedef84367e">DMAMUX_SetSource</a>(EXAMPLE_FLEXIO_UART_DMAMUX_BASEADDR, FLEXIO_UART_TX_DMA_CHANNEL, (dma_request_source_t)dma_request_source_tx);</div>
|
|
<div class="line"> <a class="code" href="a00275.html#gab4cfa329d636dc52dffb7fedef84367e">DMAMUX_SetSource</a>(EXAMPLE_FLEXIO_UART_DMAMUX_BASEADDR, FLEXIO_UART_RX_DMA_CHANNEL, (dma_request_source_t)dma_request_source_rx);</div>
|
|
<div class="line"> <a class="code" href="a00275.html#gaecac68802d961c31a06389caa97387f5">DMAMUX_EnableChannel</a>(EXAMPLE_FLEXIO_UART_DMAMUX_BASEADDR, FLEXIO_UART_TX_DMA_CHANNEL);</div>
|
|
<div class="line"> <a class="code" href="a00275.html#gaecac68802d961c31a06389caa97387f5">DMAMUX_EnableChannel</a>(EXAMPLE_FLEXIO_UART_DMAMUX_BASEADDR, FLEXIO_UART_RX_DMA_CHANNEL);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> FLEXIO_UART_TransferCreateHandleDMA(&uartDev, &g_uartHandle, FLEXIO_UART_UserCallback, NULL, &g_uartTxDmaHandle, &g_uartRxDmaHandle);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Prepares to send.</span></div>
|
|
<div class="line"> sendXfer.<a class="code" href="a00038.html#a9e9b2de91956c9b4b118fb7b43a99a27">data</a> = sendData</div>
|
|
<div class="line"> sendXfer.<a class="code" href="a00038.html#aa4c221e57175b9ef6882283f202acb41">dataSize</a> = <span class="keyword">sizeof</span>(sendData)/<span class="keyword">sizeof</span>(sendData[0]);</div>
|
|
<div class="line"> txFinished = <span class="keyword">false</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Sends out.</span></div>
|
|
<div class="line"> FLEXIO_UART_SendDMA(&uartDev, &g_uartHandle, &sendXfer);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Send finished.</span></div>
|
|
<div class="line"> <span class="keywordflow">while</span> (!txFinished)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Prepares to receive.</span></div>
|
|
<div class="line"> receiveXfer.<a class="code" href="a00038.html#a9e9b2de91956c9b4b118fb7b43a99a27">data</a> = receiveData;</div>
|
|
<div class="line"> receiveXfer.<a class="code" href="a00038.html#aa4c221e57175b9ef6882283f202acb41">dataSize</a> = <span class="keyword">sizeof</span>(receiveData)/<span class="keyword">sizeof</span>(receiveData[0]);</div>
|
|
<div class="line"> rxFinished = <span class="keyword">false</span>;</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Receives.</span></div>
|
|
<div class="line"> FLEXIO_UART_ReceiveDMA(&uartDev, &g_uartHandle, &receiveXfer, NULL);</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// Receive finished.</span></div>
|
|
<div class="line"> <span class="keywordflow">while</span> (!rxFinished)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"></div>
|
|
<div class="line"> <span class="comment">// ...</span></div>
|
|
<div class="line"> }</div>
|
|
</div><!-- fragment --> <table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:a00039"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html">FlexIO eDMA UART Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00415"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a00415">_flexio_uart_type</a></td></tr>
|
|
<tr class="memdesc:a00415"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART access structure typedef. <a href="a00038.html#a00415">More...</a><br/></td></tr>
|
|
<tr class="separator:a00415"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00411"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a00411">_flexio_uart_config</a></td></tr>
|
|
<tr class="memdesc:a00411"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART user configuration structure. <a href="a00038.html#a00411">More...</a><br/></td></tr>
|
|
<tr class="separator:a00411"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00414"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a00414">_flexio_uart_transfer</a></td></tr>
|
|
<tr class="memdesc:a00414"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART transfer structure. <a href="a00038.html#a00414">More...</a><br/></td></tr>
|
|
<tr class="separator:a00414"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00413"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a00413">_flexio_uart_handle</a></td></tr>
|
|
<tr class="memdesc:a00413"><td class="mdescLeft"> </td><td class="mdescRight">Define FLEXIO UART handle structure. <a href="a00038.html#a00413">More...</a><br/></td></tr>
|
|
<tr class="separator:a00413"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gac0f88b67f77fd05f186a5ec940c340bd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gac0f88b67f77fd05f186a5ec940c340bd">UART_RETRY_TIMES</a>   0U /* Defining to zero means to keep waiting for the flag until it is assert/deassert. */</td></tr>
|
|
<tr class="memdesc:gac0f88b67f77fd05f186a5ec940c340bd"><td class="mdescLeft"> </td><td class="mdescRight">Retry times for waiting flag. <a href="#gac0f88b67f77fd05f186a5ec940c340bd">More...</a><br/></td></tr>
|
|
<tr class="separator:gac0f88b67f77fd05f186a5ec940c340bd"><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:ga570c5a5d74da006d4a6da255ed4eed13"><td class="memItemLeft" align="right" valign="top">typedef enum <br class="typebreak"/>
|
|
<a class="el" href="a00038.html#gab9e78879dcbbeda98283f2ab8914b501">_flexio_uart_bit_count_per_char</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga570c5a5d74da006d4a6da255ed4eed13">flexio_uart_bit_count_per_char_t</a></td></tr>
|
|
<tr class="memdesc:ga570c5a5d74da006d4a6da255ed4eed13"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO UART bit count per char. <a href="#ga570c5a5d74da006d4a6da255ed4eed13">More...</a><br/></td></tr>
|
|
<tr class="separator:ga570c5a5d74da006d4a6da255ed4eed13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga30185969a31768efa7b63fe6abda7b95"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00038.html#a00415">_flexio_uart_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a></td></tr>
|
|
<tr class="memdesc:ga30185969a31768efa7b63fe6abda7b95"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART access structure typedef. <a href="#ga30185969a31768efa7b63fe6abda7b95">More...</a><br/></td></tr>
|
|
<tr class="separator:ga30185969a31768efa7b63fe6abda7b95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2a19c298dba82980c3f1c8063f02a3d1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00038.html#a00411">_flexio_uart_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga2a19c298dba82980c3f1c8063f02a3d1">flexio_uart_config_t</a></td></tr>
|
|
<tr class="memdesc:ga2a19c298dba82980c3f1c8063f02a3d1"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART user configuration structure. <a href="#ga2a19c298dba82980c3f1c8063f02a3d1">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2a19c298dba82980c3f1c8063f02a3d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga92f01e08c15b9853ff72059fcbd1c64c"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
|
|
<a class="el" href="a00038.html#a00414">_flexio_uart_transfer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_transfer_t</a></td></tr>
|
|
<tr class="memdesc:ga92f01e08c15b9853ff72059fcbd1c64c"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART transfer structure. <a href="#ga92f01e08c15b9853ff72059fcbd1c64c">More...</a><br/></td></tr>
|
|
<tr class="separator:ga92f01e08c15b9853ff72059fcbd1c64c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga47ba0f819db72b1dc4c043205ba7cb18"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga47ba0f819db72b1dc4c043205ba7cb18">flexio_uart_transfer_callback_t</a> )(<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, void *userData)</td></tr>
|
|
<tr class="memdesc:ga47ba0f819db72b1dc4c043205ba7cb18"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO UART transfer callback function. <a href="#ga47ba0f819db72b1dc4c043205ba7cb18">More...</a><br/></td></tr>
|
|
<tr class="separator:ga47ba0f819db72b1dc4c043205ba7cb18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga16685eea158879e41b101ca3634de462"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a741e184e1ca8ef870d70da2be537a6ab">kStatus_FLEXIO_UART_TxBusy</a> = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 0),
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a8dcfa64158a113e9ed598ac23c9df021">kStatus_FLEXIO_UART_RxBusy</a> = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 1),
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a828da21609507716299bfc8640c57ec3">kStatus_FLEXIO_UART_TxIdle</a> = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 2),
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a451ebbdc82bffc6c0205c7c9bd539046">kStatus_FLEXIO_UART_RxIdle</a> = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 3),
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a3b7dca7a2a8364d24c686bbfc22aa2bc">kStatus_FLEXIO_UART_ERROR</a> = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 4),
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a565cdecf3ec56df0f889e2e49d31b34f">kStatus_FLEXIO_UART_RxRingBufferOverrun</a>,
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462ab892c50df6c586138fe1b37fde07e4ca">kStatus_FLEXIO_UART_RxHardwareOverrun</a> = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 6),
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a71d490f8194635bf02969343de023a71">kStatus_FLEXIO_UART_Timeout</a> = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 7),
|
|
<br/>
|
|
  <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a0b5de1470583ff444473745f1888fa14">kStatus_FLEXIO_UART_BaudrateNotSupport</a>
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga16685eea158879e41b101ca3634de462"><td class="mdescLeft"> </td><td class="mdescRight">Error codes for the UART driver. <a href="a00038.html#ga16685eea158879e41b101ca3634de462">More...</a><br/></td></tr>
|
|
<tr class="separator:ga16685eea158879e41b101ca3634de462"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab9e78879dcbbeda98283f2ab8914b501"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gab9e78879dcbbeda98283f2ab8914b501">_flexio_uart_bit_count_per_char</a> { <br/>
|
|
  <a class="el" href="a00038.html#ggab9e78879dcbbeda98283f2ab8914b501ad9818673f2a8abacdb73e6f323fa4c42">kFLEXIO_UART_7BitsPerChar</a> = 7U,
|
|
<br/>
|
|
  <a class="el" href="a00038.html#ggab9e78879dcbbeda98283f2ab8914b501aa2563f1b9bbacb425bd892eedda0a161">kFLEXIO_UART_8BitsPerChar</a> = 8U,
|
|
<br/>
|
|
  <a class="el" href="a00038.html#ggab9e78879dcbbeda98283f2ab8914b501a8f9d374fa26cfa27dff950fca3e404a5">kFLEXIO_UART_9BitsPerChar</a> = 9U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gab9e78879dcbbeda98283f2ab8914b501"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO UART bit count per char. <a href="a00038.html#gab9e78879dcbbeda98283f2ab8914b501">More...</a><br/></td></tr>
|
|
<tr class="separator:gab9e78879dcbbeda98283f2ab8914b501"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaacbc60527c13c7135ab8cdeb379e72fb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaacbc60527c13c7135ab8cdeb379e72fb">_flexio_uart_interrupt_enable</a> { <br/>
|
|
  <a class="el" href="a00038.html#ggaacbc60527c13c7135ab8cdeb379e72fba41d4cc3f3cf42008e68fe819a9a3da14">kFLEXIO_UART_TxDataRegEmptyInterruptEnable</a> = 0x1U,
|
|
<br/>
|
|
  <a class="el" href="a00038.html#ggaacbc60527c13c7135ab8cdeb379e72fba8228cbdfa6b84d76cd2e658ae4df09c0">kFLEXIO_UART_RxDataRegFullInterruptEnable</a> = 0x2U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gaacbc60527c13c7135ab8cdeb379e72fb"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART interrupt mask. <a href="a00038.html#gaacbc60527c13c7135ab8cdeb379e72fb">More...</a><br/></td></tr>
|
|
<tr class="separator:gaacbc60527c13c7135ab8cdeb379e72fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab80096f9e757f4083565dd183ce8c491"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gab80096f9e757f4083565dd183ce8c491">_flexio_uart_status_flags</a> { <br/>
|
|
  <a class="el" href="a00038.html#ggab80096f9e757f4083565dd183ce8c491a8fd298132aa5ee69800dfba7a224a252">kFLEXIO_UART_TxDataRegEmptyFlag</a> = 0x1U,
|
|
<br/>
|
|
  <a class="el" href="a00038.html#ggab80096f9e757f4083565dd183ce8c491a3bc49d5b480f3a37acfcf82234c6f48b">kFLEXIO_UART_RxDataRegFullFlag</a> = 0x2U,
|
|
<br/>
|
|
  <a class="el" href="a00038.html#ggab80096f9e757f4083565dd183ce8c491a139fb91d122113f9fde834253d930e26">kFLEXIO_UART_RxOverRunFlag</a> = 0x4U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gab80096f9e757f4083565dd183ce8c491"><td class="mdescLeft"> </td><td class="mdescRight">Define FlexIO UART status mask. <a href="a00038.html#gab80096f9e757f4083565dd183ce8c491">More...</a><br/></td></tr>
|
|
<tr class="separator:gab80096f9e757f4083565dd183ce8c491"><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:gaa668f10e7e0820c4d504f124ef506b59"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaa668f10e7e0820c4d504f124ef506b59">FSL_FLEXIO_UART_DRIVER_VERSION</a>   (<a class="el" href="a00272.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 5, 0))</td></tr>
|
|
<tr class="memdesc:gaa668f10e7e0820c4d504f124ef506b59"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO UART driver version. <a href="#gaa668f10e7e0820c4d504f124ef506b59">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa668f10e7e0820c4d504f124ef506b59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Initialization and deinitialization</h2></td></tr>
|
|
<tr class="memitem:ga8c9e0ca8c3517e21a27f7710d7d4f580"><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="a00038.html#ga8c9e0ca8c3517e21a27f7710d7d4f580">FLEXIO_UART_Init</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, const <a class="el" href="a00038.html#ga2a19c298dba82980c3f1c8063f02a3d1">flexio_uart_config_t</a> *userConfig, uint32_t srcClock_Hz)</td></tr>
|
|
<tr class="memdesc:ga8c9e0ca8c3517e21a27f7710d7d4f580"><td class="mdescLeft"> </td><td class="mdescRight">Ungates the FlexIO clock, resets the FlexIO module, configures FlexIO UART hardware, and configures the FlexIO UART with FlexIO UART configuration. <a href="#ga8c9e0ca8c3517e21a27f7710d7d4f580">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8c9e0ca8c3517e21a27f7710d7d4f580"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga641ed5c6b8588064d82e5690e1994724"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga641ed5c6b8588064d82e5690e1994724">FLEXIO_UART_Deinit</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base)</td></tr>
|
|
<tr class="memdesc:ga641ed5c6b8588064d82e5690e1994724"><td class="mdescLeft"> </td><td class="mdescRight">Resets the FlexIO UART shifter and timer config. <a href="#ga641ed5c6b8588064d82e5690e1994724">More...</a><br/></td></tr>
|
|
<tr class="separator:ga641ed5c6b8588064d82e5690e1994724"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab705f673f07da7b1b385be7edfd2385e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gab705f673f07da7b1b385be7edfd2385e">FLEXIO_UART_GetDefaultConfig</a> (<a class="el" href="a00038.html#ga2a19c298dba82980c3f1c8063f02a3d1">flexio_uart_config_t</a> *userConfig)</td></tr>
|
|
<tr class="memdesc:gab705f673f07da7b1b385be7edfd2385e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the default configuration to configure the FlexIO UART. <a href="#gab705f673f07da7b1b385be7edfd2385e">More...</a><br/></td></tr>
|
|
<tr class="separator:gab705f673f07da7b1b385be7edfd2385e"><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>
|
|
Status</h2></td></tr>
|
|
<tr class="memitem:gaefea3702f5a53a82246aaba191605716"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaefea3702f5a53a82246aaba191605716">FLEXIO_UART_GetStatusFlags</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base)</td></tr>
|
|
<tr class="memdesc:gaefea3702f5a53a82246aaba191605716"><td class="mdescLeft"> </td><td class="mdescRight">Gets the FlexIO UART status flags. <a href="#gaefea3702f5a53a82246aaba191605716">More...</a><br/></td></tr>
|
|
<tr class="separator:gaefea3702f5a53a82246aaba191605716"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga22b879f2d9e08524999a98c7a743c3b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga22b879f2d9e08524999a98c7a743c3b0">FLEXIO_UART_ClearStatusFlags</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:ga22b879f2d9e08524999a98c7a743c3b0"><td class="mdescLeft"> </td><td class="mdescRight">Gets the FlexIO UART status flags. <a href="#ga22b879f2d9e08524999a98c7a743c3b0">More...</a><br/></td></tr>
|
|
<tr class="separator:ga22b879f2d9e08524999a98c7a743c3b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Interrupts</h2></td></tr>
|
|
<tr class="memitem:ga7f48f0a283e6458db7ff72c433e8a325"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga7f48f0a283e6458db7ff72c433e8a325">FLEXIO_UART_EnableInterrupts</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:ga7f48f0a283e6458db7ff72c433e8a325"><td class="mdescLeft"> </td><td class="mdescRight">Enables the FlexIO UART interrupt. <a href="#ga7f48f0a283e6458db7ff72c433e8a325">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7f48f0a283e6458db7ff72c433e8a325"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf4e18aa7772ae63d2eef7030cfa67175"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaf4e18aa7772ae63d2eef7030cfa67175">FLEXIO_UART_DisableInterrupts</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:gaf4e18aa7772ae63d2eef7030cfa67175"><td class="mdescLeft"> </td><td class="mdescRight">Disables the FlexIO UART interrupt. <a href="#gaf4e18aa7772ae63d2eef7030cfa67175">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf4e18aa7772ae63d2eef7030cfa67175"><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>
|
|
DMA Control</h2></td></tr>
|
|
<tr class="memitem:ga06b2b751b69190006ddbd4783abd5135"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga06b2b751b69190006ddbd4783abd5135">FLEXIO_UART_GetTxDataRegisterAddress</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base)</td></tr>
|
|
<tr class="memdesc:ga06b2b751b69190006ddbd4783abd5135"><td class="mdescLeft"> </td><td class="mdescRight">Gets the FlexIO UARt transmit data register address. <a href="#ga06b2b751b69190006ddbd4783abd5135">More...</a><br/></td></tr>
|
|
<tr class="separator:ga06b2b751b69190006ddbd4783abd5135"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa2b438423a09911bdc122109f2d11ced"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaa2b438423a09911bdc122109f2d11ced">FLEXIO_UART_GetRxDataRegisterAddress</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base)</td></tr>
|
|
<tr class="memdesc:gaa2b438423a09911bdc122109f2d11ced"><td class="mdescLeft"> </td><td class="mdescRight">Gets the FlexIO UART receive data register address. <a href="#gaa2b438423a09911bdc122109f2d11ced">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa2b438423a09911bdc122109f2d11ced"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa23cdab45bc3ed89eb9ac2998f7f339b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaa23cdab45bc3ed89eb9ac2998f7f339b">FLEXIO_UART_EnableTxDMA</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, bool enable)</td></tr>
|
|
<tr class="memdesc:gaa23cdab45bc3ed89eb9ac2998f7f339b"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables the FlexIO UART transmit DMA. <a href="#gaa23cdab45bc3ed89eb9ac2998f7f339b">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa23cdab45bc3ed89eb9ac2998f7f339b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0d005d0a785cdc80bdc77a0232533706"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga0d005d0a785cdc80bdc77a0232533706">FLEXIO_UART_EnableRxDMA</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, bool enable)</td></tr>
|
|
<tr class="memdesc:ga0d005d0a785cdc80bdc77a0232533706"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables the FlexIO UART receive DMA. <a href="#ga0d005d0a785cdc80bdc77a0232533706">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0d005d0a785cdc80bdc77a0232533706"><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>
|
|
Bus Operations</h2></td></tr>
|
|
<tr class="memitem:ga23a9bf703cf1c371fd362759ad1c66f9"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga23a9bf703cf1c371fd362759ad1c66f9">FLEXIO_UART_Enable</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, bool enable)</td></tr>
|
|
<tr class="memdesc:ga23a9bf703cf1c371fd362759ad1c66f9"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables the FlexIO UART module operation. <a href="#ga23a9bf703cf1c371fd362759ad1c66f9">More...</a><br/></td></tr>
|
|
<tr class="separator:ga23a9bf703cf1c371fd362759ad1c66f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaca10cded3e2fe4fb41af031874385775"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaca10cded3e2fe4fb41af031874385775">FLEXIO_UART_WriteByte</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, const uint8_t *buffer)</td></tr>
|
|
<tr class="memdesc:gaca10cded3e2fe4fb41af031874385775"><td class="mdescLeft"> </td><td class="mdescRight">Writes one byte of data. <a href="#gaca10cded3e2fe4fb41af031874385775">More...</a><br/></td></tr>
|
|
<tr class="separator:gaca10cded3e2fe4fb41af031874385775"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga19a7990926d6e3ed6e5799ce9c060c7d"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga19a7990926d6e3ed6e5799ce9c060c7d">FLEXIO_UART_ReadByte</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, uint8_t *buffer)</td></tr>
|
|
<tr class="memdesc:ga19a7990926d6e3ed6e5799ce9c060c7d"><td class="mdescLeft"> </td><td class="mdescRight">Reads one byte of data. <a href="#ga19a7990926d6e3ed6e5799ce9c060c7d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga19a7990926d6e3ed6e5799ce9c060c7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa97558027d7fdf1475e46b65f0dd4d76"><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="a00038.html#gaa97558027d7fdf1475e46b65f0dd4d76">FLEXIO_UART_WriteBlocking</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, const uint8_t *txData, size_t txSize)</td></tr>
|
|
<tr class="memdesc:gaa97558027d7fdf1475e46b65f0dd4d76"><td class="mdescLeft"> </td><td class="mdescRight">Sends a buffer of data bytes. <a href="#gaa97558027d7fdf1475e46b65f0dd4d76">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa97558027d7fdf1475e46b65f0dd4d76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8c6339871092770c2e7409eac3803fa8"><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="a00038.html#ga8c6339871092770c2e7409eac3803fa8">FLEXIO_UART_ReadBlocking</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, uint8_t *rxData, size_t rxSize)</td></tr>
|
|
<tr class="memdesc:ga8c6339871092770c2e7409eac3803fa8"><td class="mdescLeft"> </td><td class="mdescRight">Receives a buffer of bytes. <a href="#ga8c6339871092770c2e7409eac3803fa8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8c6339871092770c2e7409eac3803fa8"><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>
|
|
Transactional</h2></td></tr>
|
|
<tr class="memitem:gadf3c35f0256cb25b15cb4005393b3431"><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="a00038.html#gadf3c35f0256cb25b15cb4005393b3431">FLEXIO_UART_TransferCreateHandle</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="el" href="a00038.html#ga47ba0f819db72b1dc4c043205ba7cb18">flexio_uart_transfer_callback_t</a> callback, void *userData)</td></tr>
|
|
<tr class="memdesc:gadf3c35f0256cb25b15cb4005393b3431"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the UART handle. <a href="#gadf3c35f0256cb25b15cb4005393b3431">More...</a><br/></td></tr>
|
|
<tr class="separator:gadf3c35f0256cb25b15cb4005393b3431"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1c52d22628dd2ed7e843fc1cd5fb304c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga1c52d22628dd2ed7e843fc1cd5fb304c">FLEXIO_UART_TransferStartRingBuffer</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, uint8_t *ringBuffer, size_t ringBufferSize)</td></tr>
|
|
<tr class="memdesc:ga1c52d22628dd2ed7e843fc1cd5fb304c"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the RX ring buffer. <a href="#ga1c52d22628dd2ed7e843fc1cd5fb304c">More...</a><br/></td></tr>
|
|
<tr class="separator:ga1c52d22628dd2ed7e843fc1cd5fb304c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaabdc1cafc996c709cb5fc29b5de31bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#gaaabdc1cafc996c709cb5fc29b5de31bc">FLEXIO_UART_TransferStopRingBuffer</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:gaaabdc1cafc996c709cb5fc29b5de31bc"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the background transfer and uninstalls the ring buffer. <a href="#gaaabdc1cafc996c709cb5fc29b5de31bc">More...</a><br/></td></tr>
|
|
<tr class="separator:gaaabdc1cafc996c709cb5fc29b5de31bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab1b90ca93c8e65eac0e1e62ce93e3b9d"><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="a00038.html#gab1b90ca93c8e65eac0e1e62ce93e3b9d">FLEXIO_UART_TransferSendNonBlocking</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="el" href="a00038.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_transfer_t</a> *xfer)</td></tr>
|
|
<tr class="memdesc:gab1b90ca93c8e65eac0e1e62ce93e3b9d"><td class="mdescLeft"> </td><td class="mdescRight">Transmits a buffer of data using the interrupt method. <a href="#gab1b90ca93c8e65eac0e1e62ce93e3b9d">More...</a><br/></td></tr>
|
|
<tr class="separator:gab1b90ca93c8e65eac0e1e62ce93e3b9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga141086618b4642de97e46fb92ce297be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga141086618b4642de97e46fb92ce297be">FLEXIO_UART_TransferAbortSend</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga141086618b4642de97e46fb92ce297be"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the interrupt-driven data transmit. <a href="#ga141086618b4642de97e46fb92ce297be">More...</a><br/></td></tr>
|
|
<tr class="separator:ga141086618b4642de97e46fb92ce297be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3e5937c17d139c33470e80c33db082bd"><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="a00038.html#ga3e5937c17d139c33470e80c33db082bd">FLEXIO_UART_TransferGetSendCount</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga3e5937c17d139c33470e80c33db082bd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of bytes sent. <a href="#ga3e5937c17d139c33470e80c33db082bd">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3e5937c17d139c33470e80c33db082bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab42bbc26c0a6a8186d7b0d7373861bd4"><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="a00038.html#gab42bbc26c0a6a8186d7b0d7373861bd4">FLEXIO_UART_TransferReceiveNonBlocking</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="el" href="a00038.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_transfer_t</a> *xfer, size_t *receivedBytes)</td></tr>
|
|
<tr class="memdesc:gab42bbc26c0a6a8186d7b0d7373861bd4"><td class="mdescLeft"> </td><td class="mdescRight">Receives a buffer of data using the interrupt method. <a href="#gab42bbc26c0a6a8186d7b0d7373861bd4">More...</a><br/></td></tr>
|
|
<tr class="separator:gab42bbc26c0a6a8186d7b0d7373861bd4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3530ff683b0a4a0c2c2822c1e3626aab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga3530ff683b0a4a0c2c2822c1e3626aab">FLEXIO_UART_TransferAbortReceive</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga3530ff683b0a4a0c2c2822c1e3626aab"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the receive data which was using IRQ. <a href="#ga3530ff683b0a4a0c2c2822c1e3626aab">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3530ff683b0a4a0c2c2822c1e3626aab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3bc3658a7fb5825e12d2a74e879b9930"><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="a00038.html#ga3bc3658a7fb5825e12d2a74e879b9930">FLEXIO_UART_TransferGetReceiveCount</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga3bc3658a7fb5825e12d2a74e879b9930"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of bytes received. <a href="#ga3bc3658a7fb5825e12d2a74e879b9930">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3bc3658a7fb5825e12d2a74e879b9930"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3c30d66f4471bfebd2021a8a3f1a1f04"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga3c30d66f4471bfebd2021a8a3f1a1f04">FLEXIO_UART_TransferHandleIRQ</a> (void *uartType, void *uartHandle)</td></tr>
|
|
<tr class="memdesc:ga3c30d66f4471bfebd2021a8a3f1a1f04"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO UART IRQ handler function. <a href="#ga3c30d66f4471bfebd2021a8a3f1a1f04">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3c30d66f4471bfebd2021a8a3f1a1f04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4825d566bedb5d350a95f08fe926085b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ga4825d566bedb5d350a95f08fe926085b">FLEXIO_UART_FlushShifters</a> (<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base)</td></tr>
|
|
<tr class="memdesc:ga4825d566bedb5d350a95f08fe926085b"><td class="mdescLeft"> </td><td class="mdescRight">Flush tx/rx shifters. <a href="#ga4825d566bedb5d350a95f08fe926085b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga4825d566bedb5d350a95f08fe926085b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00415" id="a00415"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _flexio_uart_type</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:ae80333106e2b3ed8723a1ba780e3db0e"><td class="memItemLeft" align="right" valign="top">FLEXIO_Type * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ae80333106e2b3ed8723a1ba780e3db0e">flexioBase</a></td></tr>
|
|
<tr class="memdesc:ae80333106e2b3ed8723a1ba780e3db0e"><td class="mdescLeft"> </td><td class="mdescRight">FlexIO base pointer. <a href="#ae80333106e2b3ed8723a1ba780e3db0e">More...</a><br/></td></tr>
|
|
<tr class="separator:ae80333106e2b3ed8723a1ba780e3db0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa876273f088e8eebc92c3ae4be4614a1"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#aa876273f088e8eebc92c3ae4be4614a1">TxPinIndex</a></td></tr>
|
|
<tr class="memdesc:aa876273f088e8eebc92c3ae4be4614a1"><td class="mdescLeft"> </td><td class="mdescRight">Pin select for UART_Tx. <a href="#aa876273f088e8eebc92c3ae4be4614a1">More...</a><br/></td></tr>
|
|
<tr class="separator:aa876273f088e8eebc92c3ae4be4614a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85438b6f4b7d88017d4c05dba6f3d83e"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a85438b6f4b7d88017d4c05dba6f3d83e">RxPinIndex</a></td></tr>
|
|
<tr class="memdesc:a85438b6f4b7d88017d4c05dba6f3d83e"><td class="mdescLeft"> </td><td class="mdescRight">Pin select for UART_Rx. <a href="#a85438b6f4b7d88017d4c05dba6f3d83e">More...</a><br/></td></tr>
|
|
<tr class="separator:a85438b6f4b7d88017d4c05dba6f3d83e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6881347e0fb8615205715d39066d4965"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a6881347e0fb8615205715d39066d4965">shifterIndex</a> [2]</td></tr>
|
|
<tr class="memdesc:a6881347e0fb8615205715d39066d4965"><td class="mdescLeft"> </td><td class="mdescRight">Shifter index used in FlexIO UART. <a href="#a6881347e0fb8615205715d39066d4965">More...</a><br/></td></tr>
|
|
<tr class="separator:a6881347e0fb8615205715d39066d4965"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af763098e90a19b0fb54079bffc418c22"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#af763098e90a19b0fb54079bffc418c22">timerIndex</a> [2]</td></tr>
|
|
<tr class="memdesc:af763098e90a19b0fb54079bffc418c22"><td class="mdescLeft"> </td><td class="mdescRight">Timer index used in FlexIO UART. <a href="#af763098e90a19b0fb54079bffc418c22">More...</a><br/></td></tr>
|
|
<tr class="separator:af763098e90a19b0fb54079bffc418c22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="ae80333106e2b3ed8723a1ba780e3db0e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FLEXIO_Type* _flexio_uart_type::flexioBase</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa876273f088e8eebc92c3ae4be4614a1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _flexio_uart_type::TxPinIndex</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a85438b6f4b7d88017d4c05dba6f3d83e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _flexio_uart_type::RxPinIndex</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6881347e0fb8615205715d39066d4965"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _flexio_uart_type::shifterIndex[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af763098e90a19b0fb54079bffc418c22"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _flexio_uart_type::timerIndex[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00411" id="a00411"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _flexio_uart_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:aed8115cbc75de0df22c5dba0f0875291"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#aed8115cbc75de0df22c5dba0f0875291">enableUart</a></td></tr>
|
|
<tr class="memdesc:aed8115cbc75de0df22c5dba0f0875291"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable FlexIO UART TX & RX. <a href="#aed8115cbc75de0df22c5dba0f0875291">More...</a><br/></td></tr>
|
|
<tr class="separator:aed8115cbc75de0df22c5dba0f0875291"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada3d4a23a3c835d20a2477886dd9a282"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada3d4a23a3c835d20a2477886dd9a282"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ada3d4a23a3c835d20a2477886dd9a282">enableInDoze</a></td></tr>
|
|
<tr class="memdesc:ada3d4a23a3c835d20a2477886dd9a282"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable FlexIO operation in doze mode. <br/></td></tr>
|
|
<tr class="separator:ada3d4a23a3c835d20a2477886dd9a282"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5fccdf7ef415464341bd923023ce85d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5fccdf7ef415464341bd923023ce85d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#aa5fccdf7ef415464341bd923023ce85d">enableInDebug</a></td></tr>
|
|
<tr class="memdesc:aa5fccdf7ef415464341bd923023ce85d"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable FlexIO operation in debug mode. <br/></td></tr>
|
|
<tr class="separator:aa5fccdf7ef415464341bd923023ce85d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03e80a4e0bb6d8b967424d3db194cb8c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a03e80a4e0bb6d8b967424d3db194cb8c">enableFastAccess</a></td></tr>
|
|
<tr class="memdesc:a03e80a4e0bb6d8b967424d3db194cb8c"><td class="mdescLeft"> </td><td class="mdescRight"><pre class="fragment">Enable/disable fast access to FlexIO registers,
|
|
</pre><p> fast access requires the FlexIO clock to be at least twice the frequency of the bus clock. <a href="#a03e80a4e0bb6d8b967424d3db194cb8c">More...</a><br/></td></tr>
|
|
<tr class="separator:a03e80a4e0bb6d8b967424d3db194cb8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a64b1a3cad4cefb854fb89bb0159fe47a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a64b1a3cad4cefb854fb89bb0159fe47a">baudRate_Bps</a></td></tr>
|
|
<tr class="memdesc:a64b1a3cad4cefb854fb89bb0159fe47a"><td class="mdescLeft"> </td><td class="mdescRight">Baud rate in Bps. <a href="#a64b1a3cad4cefb854fb89bb0159fe47a">More...</a><br/></td></tr>
|
|
<tr class="separator:a64b1a3cad4cefb854fb89bb0159fe47a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6595a9f387022b3561c7fe1314e59150"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6595a9f387022b3561c7fe1314e59150"></a>
|
|
<a class="el" href="a00038.html#ga570c5a5d74da006d4a6da255ed4eed13">flexio_uart_bit_count_per_char_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a6595a9f387022b3561c7fe1314e59150">bitCountPerChar</a></td></tr>
|
|
<tr class="memdesc:a6595a9f387022b3561c7fe1314e59150"><td class="mdescLeft"> </td><td class="mdescRight">number of bits, 7/8/9 -bit <br/></td></tr>
|
|
<tr class="separator:a6595a9f387022b3561c7fe1314e59150"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="aed8115cbc75de0df22c5dba0f0875291"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool _flexio_uart_config::enableUart</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a03e80a4e0bb6d8b967424d3db194cb8c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool _flexio_uart_config::enableFastAccess</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a64b1a3cad4cefb854fb89bb0159fe47a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t _flexio_uart_config::baudRate_Bps</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00414" id="a00414"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _flexio_uart_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:aa4c221e57175b9ef6882283f202acb41"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4c221e57175b9ef6882283f202acb41"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#aa4c221e57175b9ef6882283f202acb41">dataSize</a></td></tr>
|
|
<tr class="memdesc:aa4c221e57175b9ef6882283f202acb41"><td class="mdescLeft"> </td><td class="mdescRight">Transfer size. <br/></td></tr>
|
|
<tr class="separator:aa4c221e57175b9ef6882283f202acb41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e9b2de91956c9b4b118fb7b43a99a27"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a9e9b2de91956c9b4b118fb7b43a99a27">data</a></td></tr>
|
|
<tr class="memdesc:a9e9b2de91956c9b4b118fb7b43a99a27"><td class="mdescLeft"> </td><td class="mdescRight">The buffer of data to be transfer. <a href="#a9e9b2de91956c9b4b118fb7b43a99a27">More...</a><br/></td></tr>
|
|
<tr class="separator:a9e9b2de91956c9b4b118fb7b43a99a27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f8647dc4309a84459e92ac486409e15"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a6f8647dc4309a84459e92ac486409e15">rxData</a></td></tr>
|
|
<tr class="memdesc:a6f8647dc4309a84459e92ac486409e15"><td class="mdescLeft"> </td><td class="mdescRight">The buffer to receive data. <a href="#a6f8647dc4309a84459e92ac486409e15">More...</a><br/></td></tr>
|
|
<tr class="separator:a6f8647dc4309a84459e92ac486409e15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a150732435e866d36bdfaa37e4b9d4a20"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a150732435e866d36bdfaa37e4b9d4a20">txData</a></td></tr>
|
|
<tr class="memdesc:a150732435e866d36bdfaa37e4b9d4a20"><td class="mdescLeft"> </td><td class="mdescRight">The buffer of data to be sent. <a href="#a150732435e866d36bdfaa37e4b9d4a20">More...</a><br/></td></tr>
|
|
<tr class="separator:a150732435e866d36bdfaa37e4b9d4a20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a9e9b2de91956c9b4b118fb7b43a99a27"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* _flexio_uart_transfer::data</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6f8647dc4309a84459e92ac486409e15"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* _flexio_uart_transfer::rxData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a150732435e866d36bdfaa37e4b9d4a20"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t* _flexio_uart_transfer::txData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00413" id="a00413"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _flexio_uart_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:a3a1998eca5506e4c4cd4f7c719e04911"><td class="memItemLeft" align="right" valign="top">const uint8_t *volatile </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a3a1998eca5506e4c4cd4f7c719e04911">txData</a></td></tr>
|
|
<tr class="memdesc:a3a1998eca5506e4c4cd4f7c719e04911"><td class="mdescLeft"> </td><td class="mdescRight">Address of remaining data to send. <a href="#a3a1998eca5506e4c4cd4f7c719e04911">More...</a><br/></td></tr>
|
|
<tr class="separator:a3a1998eca5506e4c4cd4f7c719e04911"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99ff65a22c359bc978b7b6315595124b"><td class="memItemLeft" align="right" valign="top">volatile size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a99ff65a22c359bc978b7b6315595124b">txDataSize</a></td></tr>
|
|
<tr class="memdesc:a99ff65a22c359bc978b7b6315595124b"><td class="mdescLeft"> </td><td class="mdescRight">Size of the remaining data to send. <a href="#a99ff65a22c359bc978b7b6315595124b">More...</a><br/></td></tr>
|
|
<tr class="separator:a99ff65a22c359bc978b7b6315595124b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0c9d76cedee59dc8f0c352eee94ae5c"><td class="memItemLeft" align="right" valign="top">uint8_t *volatile </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ab0c9d76cedee59dc8f0c352eee94ae5c">rxData</a></td></tr>
|
|
<tr class="memdesc:ab0c9d76cedee59dc8f0c352eee94ae5c"><td class="mdescLeft"> </td><td class="mdescRight">Address of remaining data to receive. <a href="#ab0c9d76cedee59dc8f0c352eee94ae5c">More...</a><br/></td></tr>
|
|
<tr class="separator:ab0c9d76cedee59dc8f0c352eee94ae5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9f3dde77d2fc9047a58095f19a80cb9"><td class="memItemLeft" align="right" valign="top">volatile size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ae9f3dde77d2fc9047a58095f19a80cb9">rxDataSize</a></td></tr>
|
|
<tr class="memdesc:ae9f3dde77d2fc9047a58095f19a80cb9"><td class="mdescLeft"> </td><td class="mdescRight">Size of the remaining data to receive. <a href="#ae9f3dde77d2fc9047a58095f19a80cb9">More...</a><br/></td></tr>
|
|
<tr class="separator:ae9f3dde77d2fc9047a58095f19a80cb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cb9d22dc7633c16b0f54c5315a6611a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a8cb9d22dc7633c16b0f54c5315a6611a">txDataSizeAll</a></td></tr>
|
|
<tr class="memdesc:a8cb9d22dc7633c16b0f54c5315a6611a"><td class="mdescLeft"> </td><td class="mdescRight">Total bytes to be sent. <a href="#a8cb9d22dc7633c16b0f54c5315a6611a">More...</a><br/></td></tr>
|
|
<tr class="separator:a8cb9d22dc7633c16b0f54c5315a6611a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d7c107772ba9dc3e700e11bfe67a12f"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a3d7c107772ba9dc3e700e11bfe67a12f">rxDataSizeAll</a></td></tr>
|
|
<tr class="memdesc:a3d7c107772ba9dc3e700e11bfe67a12f"><td class="mdescLeft"> </td><td class="mdescRight">Total bytes to be received. <a href="#a3d7c107772ba9dc3e700e11bfe67a12f">More...</a><br/></td></tr>
|
|
<tr class="separator:a3d7c107772ba9dc3e700e11bfe67a12f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2b712572f62e436b5651c7c8056e6ad"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ac2b712572f62e436b5651c7c8056e6ad">rxRingBuffer</a></td></tr>
|
|
<tr class="memdesc:ac2b712572f62e436b5651c7c8056e6ad"><td class="mdescLeft"> </td><td class="mdescRight">Start address of the receiver ring buffer. <a href="#ac2b712572f62e436b5651c7c8056e6ad">More...</a><br/></td></tr>
|
|
<tr class="separator:ac2b712572f62e436b5651c7c8056e6ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c2ced8bc92f2445f6c5880132738a58"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a7c2ced8bc92f2445f6c5880132738a58">rxRingBufferSize</a></td></tr>
|
|
<tr class="memdesc:a7c2ced8bc92f2445f6c5880132738a58"><td class="mdescLeft"> </td><td class="mdescRight">Size of the ring buffer. <a href="#a7c2ced8bc92f2445f6c5880132738a58">More...</a><br/></td></tr>
|
|
<tr class="separator:a7c2ced8bc92f2445f6c5880132738a58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22f29f51f9083c4514c26016a320d3ad"><td class="memItemLeft" align="right" valign="top">volatile uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a22f29f51f9083c4514c26016a320d3ad">rxRingBufferHead</a></td></tr>
|
|
<tr class="memdesc:a22f29f51f9083c4514c26016a320d3ad"><td class="mdescLeft"> </td><td class="mdescRight">Index for the driver to store received data into ring buffer. <a href="#a22f29f51f9083c4514c26016a320d3ad">More...</a><br/></td></tr>
|
|
<tr class="separator:a22f29f51f9083c4514c26016a320d3ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61c1052b93e2613f5276091e98fb42b8"><td class="memItemLeft" align="right" valign="top">volatile uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a61c1052b93e2613f5276091e98fb42b8">rxRingBufferTail</a></td></tr>
|
|
<tr class="memdesc:a61c1052b93e2613f5276091e98fb42b8"><td class="mdescLeft"> </td><td class="mdescRight">Index for the user to get data from the ring buffer. <a href="#a61c1052b93e2613f5276091e98fb42b8">More...</a><br/></td></tr>
|
|
<tr class="separator:a61c1052b93e2613f5276091e98fb42b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ac9a9cd0024d6103a468685c804f736"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00038.html#ga47ba0f819db72b1dc4c043205ba7cb18">flexio_uart_transfer_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a9ac9a9cd0024d6103a468685c804f736">callback</a></td></tr>
|
|
<tr class="memdesc:a9ac9a9cd0024d6103a468685c804f736"><td class="mdescLeft"> </td><td class="mdescRight">Callback function. <a href="#a9ac9a9cd0024d6103a468685c804f736">More...</a><br/></td></tr>
|
|
<tr class="separator:a9ac9a9cd0024d6103a468685c804f736"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a228e878644ad785e5bf56055bd052bb0"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a228e878644ad785e5bf56055bd052bb0">userData</a></td></tr>
|
|
<tr class="memdesc:a228e878644ad785e5bf56055bd052bb0"><td class="mdescLeft"> </td><td class="mdescRight">UART callback function parameter. <a href="#a228e878644ad785e5bf56055bd052bb0">More...</a><br/></td></tr>
|
|
<tr class="separator:a228e878644ad785e5bf56055bd052bb0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff1d8c22c51647163392bc6b12ef717c"><td class="memItemLeft" align="right" valign="top">volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#aff1d8c22c51647163392bc6b12ef717c">txState</a></td></tr>
|
|
<tr class="memdesc:aff1d8c22c51647163392bc6b12ef717c"><td class="mdescLeft"> </td><td class="mdescRight">TX transfer state. <a href="#aff1d8c22c51647163392bc6b12ef717c">More...</a><br/></td></tr>
|
|
<tr class="separator:aff1d8c22c51647163392bc6b12ef717c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bb96c5ee20f71404b4c01928943717a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bb96c5ee20f71404b4c01928943717a"></a>
|
|
volatile uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a3bb96c5ee20f71404b4c01928943717a">rxState</a></td></tr>
|
|
<tr class="memdesc:a3bb96c5ee20f71404b4c01928943717a"><td class="mdescLeft"> </td><td class="mdescRight">RX transfer state. <br/></td></tr>
|
|
<tr class="separator:a3bb96c5ee20f71404b4c01928943717a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a3a1998eca5506e4c4cd4f7c719e04911"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t* volatile _flexio_uart_handle::txData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a99ff65a22c359bc978b7b6315595124b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">volatile size_t _flexio_uart_handle::txDataSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab0c9d76cedee59dc8f0c352eee94ae5c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* volatile _flexio_uart_handle::rxData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae9f3dde77d2fc9047a58095f19a80cb9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">volatile size_t _flexio_uart_handle::rxDataSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8cb9d22dc7633c16b0f54c5315a6611a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _flexio_uart_handle::txDataSizeAll</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3d7c107772ba9dc3e700e11bfe67a12f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _flexio_uart_handle::rxDataSizeAll</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac2b712572f62e436b5651c7c8056e6ad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t* _flexio_uart_handle::rxRingBuffer</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7c2ced8bc92f2445f6c5880132738a58"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t _flexio_uart_handle::rxRingBufferSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a22f29f51f9083c4514c26016a320d3ad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">volatile uint16_t _flexio_uart_handle::rxRingBufferHead</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a61c1052b93e2613f5276091e98fb42b8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">volatile uint16_t _flexio_uart_handle::rxRingBufferTail</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9ac9a9cd0024d6103a468685c804f736"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00038.html#ga47ba0f819db72b1dc4c043205ba7cb18">flexio_uart_transfer_callback_t</a> _flexio_uart_handle::callback</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a228e878644ad785e5bf56055bd052bb0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* _flexio_uart_handle::userData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aff1d8c22c51647163392bc6b12ef717c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">volatile uint8_t _flexio_uart_handle::txState</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="gaa668f10e7e0820c4d504f124ef506b59"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_FLEXIO_UART_DRIVER_VERSION   (<a class="el" href="a00272.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 5, 0))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac0f88b67f77fd05f186a5ec940c340bd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define UART_RETRY_TIMES   0U /* Defining to zero means to keep waiting for the flag until it is assert/deassert. */</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga570c5a5d74da006d4a6da255ed4eed13"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00038.html#gab9e78879dcbbeda98283f2ab8914b501">_flexio_uart_bit_count_per_char</a> <a class="el" href="a00038.html#ga570c5a5d74da006d4a6da255ed4eed13">flexio_uart_bit_count_per_char_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga30185969a31768efa7b63fe6abda7b95"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00038.html#a00415">_flexio_uart_type</a> <a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2a19c298dba82980c3f1c8063f02a3d1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00038.html#a00411">_flexio_uart_config</a> <a class="el" href="a00038.html#ga2a19c298dba82980c3f1c8063f02a3d1">flexio_uart_config_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga92f01e08c15b9853ff72059fcbd1c64c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00038.html#a00414">_flexio_uart_transfer</a> <a class="el" href="a00038.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_transfer_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga47ba0f819db72b1dc4c043205ba7cb18"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* flexio_uart_transfer_callback_t)(<a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> *base, <a class="el" href="a00038.html#a00413">flexio_uart_handle_t</a> *handle, <a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> status, void *userData)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga16685eea158879e41b101ca3634de462"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a741e184e1ca8ef870d70da2be537a6ab"></a>kStatus_FLEXIO_UART_TxBusy</em> </td><td class="fielddoc">
|
|
<p>Transmitter is busy. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a8dcfa64158a113e9ed598ac23c9df021"></a>kStatus_FLEXIO_UART_RxBusy</em> </td><td class="fielddoc">
|
|
<p>Receiver is busy. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a828da21609507716299bfc8640c57ec3"></a>kStatus_FLEXIO_UART_TxIdle</em> </td><td class="fielddoc">
|
|
<p>UART transmitter is idle. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a451ebbdc82bffc6c0205c7c9bd539046"></a>kStatus_FLEXIO_UART_RxIdle</em> </td><td class="fielddoc">
|
|
<p>UART receiver is idle. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a3b7dca7a2a8364d24c686bbfc22aa2bc"></a>kStatus_FLEXIO_UART_ERROR</em> </td><td class="fielddoc">
|
|
<p>ERROR happens on UART. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a565cdecf3ec56df0f889e2e49d31b34f"></a>kStatus_FLEXIO_UART_RxRingBufferOverrun</em> </td><td class="fielddoc">
|
|
<p>UART RX software ring buffer overrun. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462ab892c50df6c586138fe1b37fde07e4ca"></a>kStatus_FLEXIO_UART_RxHardwareOverrun</em> </td><td class="fielddoc">
|
|
<p>UART RX receiver overrun. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a71d490f8194635bf02969343de023a71"></a>kStatus_FLEXIO_UART_Timeout</em> </td><td class="fielddoc">
|
|
<p>UART times out. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga16685eea158879e41b101ca3634de462a0b5de1470583ff444473745f1888fa14"></a>kStatus_FLEXIO_UART_BaudrateNotSupport</em> </td><td class="fielddoc">
|
|
<p>Baudrate is not supported in current clock source. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab9e78879dcbbeda98283f2ab8914b501"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00038.html#gab9e78879dcbbeda98283f2ab8914b501">_flexio_uart_bit_count_per_char</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggab9e78879dcbbeda98283f2ab8914b501ad9818673f2a8abacdb73e6f323fa4c42"></a>kFLEXIO_UART_7BitsPerChar</em> </td><td class="fielddoc">
|
|
<p>7-bit data characters </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggab9e78879dcbbeda98283f2ab8914b501aa2563f1b9bbacb425bd892eedda0a161"></a>kFLEXIO_UART_8BitsPerChar</em> </td><td class="fielddoc">
|
|
<p>8-bit data characters </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggab9e78879dcbbeda98283f2ab8914b501a8f9d374fa26cfa27dff950fca3e404a5"></a>kFLEXIO_UART_9BitsPerChar</em> </td><td class="fielddoc">
|
|
<p>9-bit data characters </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaacbc60527c13c7135ab8cdeb379e72fb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00038.html#gaacbc60527c13c7135ab8cdeb379e72fb">_flexio_uart_interrupt_enable</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaacbc60527c13c7135ab8cdeb379e72fba41d4cc3f3cf42008e68fe819a9a3da14"></a>kFLEXIO_UART_TxDataRegEmptyInterruptEnable</em> </td><td class="fielddoc">
|
|
<p>Transmit buffer empty interrupt enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaacbc60527c13c7135ab8cdeb379e72fba8228cbdfa6b84d76cd2e658ae4df09c0"></a>kFLEXIO_UART_RxDataRegFullInterruptEnable</em> </td><td class="fielddoc">
|
|
<p>Receive buffer full interrupt enable. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab80096f9e757f4083565dd183ce8c491"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00038.html#gab80096f9e757f4083565dd183ce8c491">_flexio_uart_status_flags</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggab80096f9e757f4083565dd183ce8c491a8fd298132aa5ee69800dfba7a224a252"></a>kFLEXIO_UART_TxDataRegEmptyFlag</em> </td><td class="fielddoc">
|
|
<p>Transmit buffer empty flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggab80096f9e757f4083565dd183ce8c491a3bc49d5b480f3a37acfcf82234c6f48b"></a>kFLEXIO_UART_RxDataRegFullFlag</em> </td><td class="fielddoc">
|
|
<p>Receive buffer full flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggab80096f9e757f4083565dd183ce8c491a139fb91d122113f9fde834253d930e26"></a>kFLEXIO_UART_RxOverRunFlag</em> </td><td class="fielddoc">
|
|
<p>Receive buffer over run flag. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga8c9e0ca8c3517e21a27f7710d7d4f580"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">const <a class="el" href="a00038.html#ga2a19c298dba82980c3f1c8063f02a3d1">flexio_uart_config_t</a> * </td>
|
|
<td class="paramname"><em>userConfig</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>srcClock_Hz</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The configuration structure can be filled by the user or be set with default values by <a class="el" href="a00038.html#gab705f673f07da7b1b385be7edfd2385e" title="Gets the default configuration to configure the FlexIO UART. ">FLEXIO_UART_GetDefaultConfig()</a>.</p>
|
|
<p>Example </p>
|
|
<div class="fragment"><div class="line"><a class="code" href="a00038.html#a00415">FLEXIO_UART_Type</a> base = {</div>
|
|
<div class="line">.<a class="code" href="a00038.html#ae80333106e2b3ed8723a1ba780e3db0e">flexioBase</a> = FLEXIO,</div>
|
|
<div class="line">.TxPinIndex = 0,</div>
|
|
<div class="line">.RxPinIndex = 1,</div>
|
|
<div class="line">.shifterIndex = {0,1},</div>
|
|
<div class="line">.timerIndex = {0,1}</div>
|
|
<div class="line">};</div>
|
|
<div class="line"><a class="code" href="a00038.html#a00411">flexio_uart_config_t</a> config = {</div>
|
|
<div class="line">.<a class="code" href="a00036.html#aa9fca18ad65df7eb3b2391d780def4eb">enableInDoze</a> = <span class="keyword">false</span>,</div>
|
|
<div class="line">.enableInDebug = <span class="keyword">true</span>,</div>
|
|
<div class="line">.enableFastAccess = <span class="keyword">false</span>,</div>
|
|
<div class="line">.baudRate_Bps = 115200U,</div>
|
|
<div class="line">.bitCountPerChar = 8</div>
|
|
<div class="line">};</div>
|
|
<div class="line"><a class="code" href="a00038.html#ga8c9e0ca8c3517e21a27f7710d7d4f580">FLEXIO_UART_Init</a>(base, &config, srcClock_Hz);</div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">userConfig</td><td>Pointer to the flexio_uart_config_t structure. </td></tr>
|
|
<tr><td class="paramname">srcClock_Hz</td><td>FlexIO source clock in Hz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_Success</td><td>Configuration success. </td></tr>
|
|
<tr><td class="paramname">kStatus_FLEXIO_UART_BaudrateNotSupport</td><td>Baudrate is not supported for current clock source frequency. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga641ed5c6b8588064d82e5690e1994724"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>After calling this API, call the FLEXO_UART_Init to use the FlexIO UART module.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to FLEXIO_UART_Type structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab705f673f07da7b1b385be7edfd2385e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_GetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.html#ga2a19c298dba82980c3f1c8063f02a3d1">flexio_uart_config_t</a> * </td>
|
|
<td class="paramname"><em>userConfig</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The configuration can be used directly for calling the <a class="el" href="a00038.html#ga8c9e0ca8c3517e21a27f7710d7d4f580" title="Ungates the FlexIO clock, resets the FlexIO module, configures FlexIO UART hardware, and configures the FlexIO UART with FlexIO UART configuration. ">FLEXIO_UART_Init()</a>. Example: </p>
|
|
<div class="fragment"><div class="line"><a class="code" href="a00038.html#a00411">flexio_uart_config_t</a> config;</div>
|
|
<div class="line"><a class="code" href="a00038.html#gab705f673f07da7b1b385be7edfd2385e">FLEXIO_UART_GetDefaultConfig</a>(&userConfig);</div>
|
|
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">userConfig</td><td>Pointer to the flexio_uart_config_t structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaefea3702f5a53a82246aaba191605716"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t FLEXIO_UART_GetStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>FlexIO UART status flags. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga22b879f2d9e08524999a98c7a743c3b0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_ClearStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">uint32_t </td>
|
|
<td class="paramname"><em>mask</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 the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>Status flag. The parameter can be any combination of the following values: <ul>
|
|
<li>kFLEXIO_UART_TxDataRegEmptyFlag </li>
|
|
<li>kFLEXIO_UART_RxEmptyFlag </li>
|
|
<li>kFLEXIO_UART_RxOverRunFlag </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7f48f0a283e6458db7ff72c433e8a325"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_EnableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">uint32_t </td>
|
|
<td class="paramname"><em>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function enables the FlexIO UART interrupt.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>Interrupt source. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf4e18aa7772ae63d2eef7030cfa67175"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_DisableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">uint32_t </td>
|
|
<td class="paramname"><em>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function disables the FlexIO UART interrupt.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>Interrupt source. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga06b2b751b69190006ddbd4783abd5135"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t FLEXIO_UART_GetTxDataRegisterAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function returns the UART data register address, which is mainly used by DMA/eDMA.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>FlexIO UART transmit data register address. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa2b438423a09911bdc122109f2d11ced"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t FLEXIO_UART_GetRxDataRegisterAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function returns the UART data register address, which is mainly used by DMA/eDMA.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>FlexIO UART receive data register address. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa23cdab45bc3ed89eb9ac2998f7f339b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void FLEXIO_UART_EnableTxDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function enables/disables the FlexIO UART Tx DMA, which means asserting the kFLEXIO_UART_TxDataRegEmptyFlag does/doesn't trigger the DMA request.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">enable</td><td>True to enable, false to disable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0d005d0a785cdc80bdc77a0232533706"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void FLEXIO_UART_EnableRxDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function enables/disables the FlexIO UART Rx DMA, which means asserting kFLEXIO_UART_RxDataRegFullFlag does/doesn't trigger the DMA request.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">enable</td><td>True to enable, false to disable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga23a9bf703cf1c371fd362759ad1c66f9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void FLEXIO_UART_Enable </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type. </td></tr>
|
|
<tr><td class="paramname">enable</td><td>True to enable, false does not have any effect. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaca10cded3e2fe4fb41af031874385775"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void FLEXIO_UART_WriteByte </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">const uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This is a non-blocking API, which returns directly after the data is put into the data register. Ensure that the TxEmptyFlag is asserted before calling this API.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>The data bytes to send. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga19a7990926d6e3ed6e5799ce9c060c7d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void FLEXIO_UART_ReadByte </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This is a non-blocking API, which returns directly after the data is read from the data register. Ensure that the RxFullFlag is asserted before calling this API.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>The buffer to store the received bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa97558027d7fdf1475e46b65f0dd4d76"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_WriteBlocking </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">const uint8_t * </td>
|
|
<td class="paramname"><em>txData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>txSize</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 function blocks using the polling method until all bytes have been sent.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">txData</td><td>The data bytes to send. </td></tr>
|
|
<tr><td class="paramname">txSize</td><td>The number of data bytes to send. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_FLEXIO_UART_Timeout</td><td>Transmission timed out and was aborted. </td></tr>
|
|
<tr><td class="paramname">kStatus_Success</td><td>Successfully wrote all data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8c6339871092770c2e7409eac3803fa8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_ReadBlocking </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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">uint8_t * </td>
|
|
<td class="paramname"><em>rxData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>rxSize</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 function blocks using the polling method until all bytes have been received.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">rxData</td><td>The buffer to store the received bytes. </td></tr>
|
|
<tr><td class="paramname">rxSize</td><td>The number of data bytes to be received. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">kStatus_FLEXIO_UART_Timeout</td><td>Transmission timed out and was aborted. </td></tr>
|
|
<tr><td class="paramname">kStatus_Success</td><td>Successfully received all data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadf3c35f0256cb25b15cb4005393b3431"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferCreateHandle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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="a00038.html#ga47ba0f819db72b1dc4c043205ba7cb18">flexio_uart_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>This function initializes the FlexIO UART handle, which can be used for other FlexIO UART transactional APIs. Call this API once to get the initialized handle.</p>
|
|
<p>The UART driver supports the "background" receiving, which means that users can set up a RX ring buffer optionally. Data received is stored into the ring buffer even when the user doesn't call the <a class="el" href="a00038.html#gab42bbc26c0a6a8186d7b0d7373861bd4" title="Receives a buffer of data using the interrupt method. ">FLEXIO_UART_TransferReceiveNonBlocking()</a> API. If there is already data received in the ring buffer, users can get the received data from the ring buffer directly. The ring buffer is disabled if passing NULL as <code>ringBuffer</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>to FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </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>
|
|
</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 type/handle/ISR table out of range. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1c52d22628dd2ed7e843fc1cd5fb304c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_TransferStartRingBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>ringBuffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>ringBufferSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function sets up the RX ring buffer to a specific UART handle.</p>
|
|
<p>When the RX ring buffer is used, data received is stored into the ring buffer even when the user doesn't call the UART_ReceiveNonBlocking() API. If there is already data received in the ring buffer, users can get the received data from the ring buffer directly.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>When using the RX ring buffer, one byte is reserved for internal use. In other words, if <code>ringBufferSize</code> is 32, only 31 bytes are used for saving data.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </td></tr>
|
|
<tr><td class="paramname">ringBuffer</td><td>Start address of ring buffer for background receiving. Pass NULL to disable the ring buffer. </td></tr>
|
|
<tr><td class="paramname">ringBufferSize</td><td>Size of the ring buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaaabdc1cafc996c709cb5fc29b5de31bc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_TransferStopRingBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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 background transfer and uninstalls the ring buffer.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab1b90ca93c8e65eac0e1e62ce93e3b9d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferSendNonBlocking </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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="a00038.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 an interrupt method. This is a non-blocking function, which returns directly without waiting for all data to be written to the TX register. When all data is written to the TX register in ISR, the FlexIO UART driver calls the callback function and passes the <a class="el" href="a00038.html#gga16685eea158879e41b101ca3634de462a828da21609507716299bfc8640c57ec3">kStatus_FLEXIO_UART_TxIdle</a> as status parameter.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The kStatus_FLEXIO_UART_TxIdle is passed to the upper layer when all data is written to the TX register. However, it does not ensure that all data is sent out.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>FlexIO UART transfer structure. See <a class="el" href="a00038.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>Successfully starts the data transmission. </td></tr>
|
|
<tr><td class="paramname">kStatus_UART_TxBusy</td><td>Previous transmission still not finished, data not written to the TX register. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga141086618b4642de97e46fb92ce297be"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_TransferAbortSend </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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 interrupt-driven data sending. Get the remainBytes to find out how many bytes are still not sent out.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3e5937c17d139c33470e80c33db082bd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferGetSendCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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 driven by interrupt.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </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="gab42bbc26c0a6a8186d7b0d7373861bd4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferReceiveNonBlocking </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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="a00038.html#ga92f01e08c15b9853ff72059fcbd1c64c">flexio_uart_transfer_t</a> * </td>
|
|
<td class="paramname"><em>xfer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>receivedBytes</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function receives data using the interrupt method. This is a non-blocking function, which returns without waiting for all data to be received. If the RX ring buffer is used and not empty, the data in ring buffer is copied and the parameter <code>receivedBytes</code> shows how many bytes are copied from the ring buffer. After copying, if the data in ring buffer is not enough to read, the receive request is saved by the UART driver. When new data arrives, the receive request is serviced first. When all data is received, the UART driver notifies the upper layer through a callback function and passes the status parameter kStatus_UART_RxIdle. For example, if the upper layer needs 10 bytes but there are only 5 bytes in the ring buffer, the 5 bytes are copied to xfer->data. This function returns with the parameter <code>receivedBytes</code> set to 5. For the last 5 bytes, newly arrived data is saved from the xfer->data[5]. When 5 bytes are received, the UART driver notifies upper layer. If the RX ring buffer is not enabled, this function enables the RX and RX interrupt to receive data to xfer->data. When all data is received, the upper layer is notified.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </td></tr>
|
|
<tr><td class="paramname">xfer</td><td>UART transfer structure. See <a class="el" href="a00038.html#ga92f01e08c15b9853ff72059fcbd1c64c" title="Define FlexIO UART transfer structure. ">flexio_uart_transfer_t</a>. </td></tr>
|
|
<tr><td class="paramname">receivedBytes</td><td>Bytes received from the ring buffer directly. </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 queue the transfer into the transmit queue. </td></tr>
|
|
<tr><td class="paramname">kStatus_FLEXIO_UART_RxBusy</td><td>Previous receive request is not finished. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3530ff683b0a4a0c2c2822c1e3626aab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_TransferAbortReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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 was using IRQ.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3bc3658a7fb5825e12d2a74e879b9930"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXIO_UART_TransferGetReceiveCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.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="a00038.html#a00413">flexio_uart_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 driven by interrupt.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </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>
|
|
<a class="anchor" id="ga3c30d66f4471bfebd2021a8a3f1a1f04"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_TransferHandleIRQ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>uartType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>uartHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function processes the FlexIO UART transmit and receives the IRQ request.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">uartType</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
<tr><td class="paramname">uartHandle</td><td>Pointer to the flexio_uart_handle_t structure to store the transfer state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4825d566bedb5d350a95f08fe926085b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXIO_UART_FlushShifters </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00038.html#ga30185969a31768efa7b63fe6abda7b95">FLEXIO_UART_Type</a> * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Pointer to the FLEXIO_UART_Type structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|