511 lines
31 KiB
HTML
511 lines
31 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: LPUART FreeRTOS 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('a00052.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LPUART FreeRTOS Driver<div class="ingroups"><a class="el" href="a00274.html">LPUART: Low Power Universal Asynchronous Receiver/Transmitter Driver</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00427"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a00427">_lpuart_rtos_config</a></td></tr>
|
|
<tr class="memdesc:a00427"><td class="mdescLeft"> </td><td class="mdescRight">LPUART RTOS configuration structure. <a href="a00052.html#a00427">More...</a><br/></td></tr>
|
|
<tr class="separator:a00427"><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:gaec3e5cc86ceea303798e171e10f9163a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00052.html#a00427">_lpuart_rtos_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#gaec3e5cc86ceea303798e171e10f9163a">lpuart_rtos_config_t</a></td></tr>
|
|
<tr class="memdesc:gaec3e5cc86ceea303798e171e10f9163a"><td class="mdescLeft"> </td><td class="mdescRight">LPUART RTOS configuration structure. <a href="#gaec3e5cc86ceea303798e171e10f9163a">More...</a><br/></td></tr>
|
|
<tr class="separator:gaec3e5cc86ceea303798e171e10f9163a"><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:gae78d379ef6bde2ad08e1fe64f1f09bf5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#gae78d379ef6bde2ad08e1fe64f1f09bf5">FSL_LPUART_FREERTOS_DRIVER_VERSION</a>   (<a class="el" href="a00260.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 6, 0))</td></tr>
|
|
<tr class="memdesc:gae78d379ef6bde2ad08e1fe64f1f09bf5"><td class="mdescLeft"> </td><td class="mdescRight">LPUART FreeRTOS driver version. <a href="#gae78d379ef6bde2ad08e1fe64f1f09bf5">More...</a><br/></td></tr>
|
|
<tr class="separator:gae78d379ef6bde2ad08e1fe64f1f09bf5"><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>
|
|
LPUART RTOS Operation</h2></td></tr>
|
|
<tr class="memitem:ga5be9370b1fa0187c194475769e7138fc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ga5be9370b1fa0187c194475769e7138fc">LPUART_RTOS_Init</a> (lpuart_rtos_handle_t *handle, <a class="el" href="a00050.html#a00426">lpuart_handle_t</a> *t_handle, const <a class="el" href="a00052.html#gaec3e5cc86ceea303798e171e10f9163a">lpuart_rtos_config_t</a> *cfg)</td></tr>
|
|
<tr class="memdesc:ga5be9370b1fa0187c194475769e7138fc"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an LPUART instance for operation in RTOS. <a href="#ga5be9370b1fa0187c194475769e7138fc">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5be9370b1fa0187c194475769e7138fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga057e59dcc578ef4b303850bcd90ca50e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ga057e59dcc578ef4b303850bcd90ca50e">LPUART_RTOS_Deinit</a> (lpuart_rtos_handle_t *handle)</td></tr>
|
|
<tr class="memdesc:ga057e59dcc578ef4b303850bcd90ca50e"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes an LPUART instance for operation. <a href="#ga057e59dcc578ef4b303850bcd90ca50e">More...</a><br/></td></tr>
|
|
<tr class="separator:ga057e59dcc578ef4b303850bcd90ca50e"><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>
|
|
LPUART transactional Operation</h2></td></tr>
|
|
<tr class="memitem:ga275e067e13ecc77dde83d2d7938c038e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ga275e067e13ecc77dde83d2d7938c038e">LPUART_RTOS_Send</a> (lpuart_rtos_handle_t *handle, uint8_t *buffer, uint32_t length)</td></tr>
|
|
<tr class="memdesc:ga275e067e13ecc77dde83d2d7938c038e"><td class="mdescLeft"> </td><td class="mdescRight">Sends data in the background. <a href="#ga275e067e13ecc77dde83d2d7938c038e">More...</a><br/></td></tr>
|
|
<tr class="separator:ga275e067e13ecc77dde83d2d7938c038e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0561f87122863c6e9b20f8991a73a0fb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ga0561f87122863c6e9b20f8991a73a0fb">LPUART_RTOS_Receive</a> (lpuart_rtos_handle_t *handle, uint8_t *buffer, uint32_t length, size_t *received)</td></tr>
|
|
<tr class="memdesc:ga0561f87122863c6e9b20f8991a73a0fb"><td class="mdescLeft"> </td><td class="mdescRight">Receives data. <a href="#ga0561f87122863c6e9b20f8991a73a0fb">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0561f87122863c6e9b20f8991a73a0fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3e211e0c1a2c93d9bdd73d6ca4639a10"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ga3e211e0c1a2c93d9bdd73d6ca4639a10">LPUART_RTOS_SetRxTimeout</a> (lpuart_rtos_handle_t *handle, uint32_t rx_timeout_constant_ms, uint32_t rx_timeout_multiplier_ms)</td></tr>
|
|
<tr class="memdesc:ga3e211e0c1a2c93d9bdd73d6ca4639a10"><td class="mdescLeft"> </td><td class="mdescRight">Set RX timeout in runtime. <a href="#ga3e211e0c1a2c93d9bdd73d6ca4639a10">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3e211e0c1a2c93d9bdd73d6ca4639a10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad2317ff04710f0f4a2dc7d219f850c85"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#gad2317ff04710f0f4a2dc7d219f850c85">LPUART_RTOS_SetTxTimeout</a> (lpuart_rtos_handle_t *handle, uint32_t tx_timeout_constant_ms, uint32_t tx_timeout_multiplier_ms)</td></tr>
|
|
<tr class="memdesc:gad2317ff04710f0f4a2dc7d219f850c85"><td class="mdescLeft"> </td><td class="mdescRight">Set TX timeout in runtime. <a href="#gad2317ff04710f0f4a2dc7d219f850c85">More...</a><br/></td></tr>
|
|
<tr class="separator:gad2317ff04710f0f4a2dc7d219f850c85"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00427" id="a00427"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _lpuart_rtos_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:aa4e6cddd1beadc52a71ac5933dd47afd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4e6cddd1beadc52a71ac5933dd47afd"></a>
|
|
LPUART_Type * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#aa4e6cddd1beadc52a71ac5933dd47afd">base</a></td></tr>
|
|
<tr class="memdesc:aa4e6cddd1beadc52a71ac5933dd47afd"><td class="mdescLeft"> </td><td class="mdescRight">UART base address. <br/></td></tr>
|
|
<tr class="separator:aa4e6cddd1beadc52a71ac5933dd47afd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ad0def261b033ab202cd29804387cad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ad0def261b033ab202cd29804387cad"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a3ad0def261b033ab202cd29804387cad">srcclk</a></td></tr>
|
|
<tr class="memdesc:a3ad0def261b033ab202cd29804387cad"><td class="mdescLeft"> </td><td class="mdescRight">UART source clock in Hz. <br/></td></tr>
|
|
<tr class="separator:a3ad0def261b033ab202cd29804387cad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae145aec6fcd6a1fd8811d47f1b3d69e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae145aec6fcd6a1fd8811d47f1b3d69e7"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ae145aec6fcd6a1fd8811d47f1b3d69e7">baudrate</a></td></tr>
|
|
<tr class="memdesc:ae145aec6fcd6a1fd8811d47f1b3d69e7"><td class="mdescLeft"> </td><td class="mdescRight">Desired communication speed. <br/></td></tr>
|
|
<tr class="separator:ae145aec6fcd6a1fd8811d47f1b3d69e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a590d28ebbfe2cc5eae93559ebcd70aaa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a590d28ebbfe2cc5eae93559ebcd70aaa"></a>
|
|
<a class="el" href="a00050.html#gab5b7fa64ce57a2f68327e745f4a3e0b2">lpuart_parity_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a590d28ebbfe2cc5eae93559ebcd70aaa">parity</a></td></tr>
|
|
<tr class="memdesc:a590d28ebbfe2cc5eae93559ebcd70aaa"><td class="mdescLeft"> </td><td class="mdescRight">Parity setting. <br/></td></tr>
|
|
<tr class="separator:a590d28ebbfe2cc5eae93559ebcd70aaa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bad2260df1b2e44edba5bb1621e5c89"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bad2260df1b2e44edba5bb1621e5c89"></a>
|
|
<a class="el" href="a00050.html#ga5c25153c13c99b8c63d8e78cdfeea30f">lpuart_stop_bit_count_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a3bad2260df1b2e44edba5bb1621e5c89">stopbits</a></td></tr>
|
|
<tr class="memdesc:a3bad2260df1b2e44edba5bb1621e5c89"><td class="mdescLeft"> </td><td class="mdescRight">Number of stop bits to use. <br/></td></tr>
|
|
<tr class="separator:a3bad2260df1b2e44edba5bb1621e5c89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a421d97b8a3d56a3fbe80a439d6a12e8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a421d97b8a3d56a3fbe80a439d6a12e8b"></a>
|
|
uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a421d97b8a3d56a3fbe80a439d6a12e8b">buffer</a></td></tr>
|
|
<tr class="memdesc:a421d97b8a3d56a3fbe80a439d6a12e8b"><td class="mdescLeft"> </td><td class="mdescRight">Buffer for background reception. <br/></td></tr>
|
|
<tr class="separator:a421d97b8a3d56a3fbe80a439d6a12e8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab01354efe7fe0281ec722857d6ff9370"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab01354efe7fe0281ec722857d6ff9370"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ab01354efe7fe0281ec722857d6ff9370">buffer_size</a></td></tr>
|
|
<tr class="memdesc:ab01354efe7fe0281ec722857d6ff9370"><td class="mdescLeft"> </td><td class="mdescRight">Size of buffer for background reception. <br/></td></tr>
|
|
<tr class="separator:ab01354efe7fe0281ec722857d6ff9370"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af72c515a22bf7a4cd058fafd5ee192b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af72c515a22bf7a4cd058fafd5ee192b2"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#af72c515a22bf7a4cd058fafd5ee192b2">rx_timeout_constant_ms</a></td></tr>
|
|
<tr class="memdesc:af72c515a22bf7a4cd058fafd5ee192b2"><td class="mdescLeft"> </td><td class="mdescRight">RX timeout applied per receive. <br/></td></tr>
|
|
<tr class="separator:af72c515a22bf7a4cd058fafd5ee192b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9459f1a39d576c85bb20cc8d00c641c3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a9459f1a39d576c85bb20cc8d00c641c3">rx_timeout_multiplier_ms</a></td></tr>
|
|
<tr class="memdesc:a9459f1a39d576c85bb20cc8d00c641c3"><td class="mdescLeft"> </td><td class="mdescRight">RX timeout added for each byte of the receive. <a href="#a9459f1a39d576c85bb20cc8d00c641c3">More...</a><br/></td></tr>
|
|
<tr class="separator:a9459f1a39d576c85bb20cc8d00c641c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a321ae993de2ec70250dac9d19e2f3422"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a321ae993de2ec70250dac9d19e2f3422"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a321ae993de2ec70250dac9d19e2f3422">tx_timeout_constant_ms</a></td></tr>
|
|
<tr class="memdesc:a321ae993de2ec70250dac9d19e2f3422"><td class="mdescLeft"> </td><td class="mdescRight">TX timeout applied per transmition. <br/></td></tr>
|
|
<tr class="separator:a321ae993de2ec70250dac9d19e2f3422"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1716df2698e5e1c5df95530e90b1d0f6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a1716df2698e5e1c5df95530e90b1d0f6">tx_timeout_multiplier_ms</a></td></tr>
|
|
<tr class="memdesc:a1716df2698e5e1c5df95530e90b1d0f6"><td class="mdescLeft"> </td><td class="mdescRight">TX timeout added for each byte of the transmition. <a href="#a1716df2698e5e1c5df95530e90b1d0f6">More...</a><br/></td></tr>
|
|
<tr class="separator:a1716df2698e5e1c5df95530e90b1d0f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22f26846697fdb4a1293f8adc7f6973f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22f26846697fdb4a1293f8adc7f6973f"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a22f26846697fdb4a1293f8adc7f6973f">enableRxRTS</a></td></tr>
|
|
<tr class="memdesc:a22f26846697fdb4a1293f8adc7f6973f"><td class="mdescLeft"> </td><td class="mdescRight">RX RTS enable. <br/></td></tr>
|
|
<tr class="separator:a22f26846697fdb4a1293f8adc7f6973f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0029e97fa7a5cc92ddccc62e2a24b700"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0029e97fa7a5cc92ddccc62e2a24b700"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a0029e97fa7a5cc92ddccc62e2a24b700">enableTxCTS</a></td></tr>
|
|
<tr class="memdesc:a0029e97fa7a5cc92ddccc62e2a24b700"><td class="mdescLeft"> </td><td class="mdescRight">TX CTS enable. <br/></td></tr>
|
|
<tr class="separator:a0029e97fa7a5cc92ddccc62e2a24b700"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac33e737fd77ccad71995d979ec1602a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac33e737fd77ccad71995d979ec1602a7"></a>
|
|
<a class="el" href="a00050.html#ga36ff933c6ff4ac7a125878f03fc79831">lpuart_transmit_cts_source_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#ac33e737fd77ccad71995d979ec1602a7">txCtsSource</a></td></tr>
|
|
<tr class="memdesc:ac33e737fd77ccad71995d979ec1602a7"><td class="mdescLeft"> </td><td class="mdescRight">TX CTS source. <br/></td></tr>
|
|
<tr class="separator:ac33e737fd77ccad71995d979ec1602a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b29bd9c3c89e10dda93c37f23365632"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b29bd9c3c89e10dda93c37f23365632"></a>
|
|
<a class="el" href="a00050.html#ga5b4e2d09e452e3514e4533ee9510be97">lpuart_transmit_cts_config_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html#a3b29bd9c3c89e10dda93c37f23365632">txCtsConfig</a></td></tr>
|
|
<tr class="memdesc:a3b29bd9c3c89e10dda93c37f23365632"><td class="mdescLeft"> </td><td class="mdescRight">TX CTS configure. <br/></td></tr>
|
|
<tr class="separator:a3b29bd9c3c89e10dda93c37f23365632"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a9459f1a39d576c85bb20cc8d00c641c3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t _lpuart_rtos_config::rx_timeout_multiplier_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1716df2698e5e1c5df95530e90b1d0f6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t _lpuart_rtos_config::tx_timeout_multiplier_ms</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="gae78d379ef6bde2ad08e1fe64f1f09bf5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_LPUART_FREERTOS_DRIVER_VERSION   (<a class="el" href="a00260.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 6, 0))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="gaec3e5cc86ceea303798e171e10f9163a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00052.html#a00427">_lpuart_rtos_config</a> <a class="el" href="a00052.html#gaec3e5cc86ceea303798e171e10f9163a">lpuart_rtos_config_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga5be9370b1fa0187c194475769e7138fc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int LPUART_RTOS_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">lpuart_rtos_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00050.html#a00426">lpuart_handle_t</a> * </td>
|
|
<td class="paramname"><em>t_handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="a00052.html#gaec3e5cc86ceea303798e171e10f9163a">lpuart_rtos_config_t</a> * </td>
|
|
<td class="paramname"><em>cfg</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">handle</td><td>The RTOS LPUART handle, the pointer to an allocated space for RTOS context. </td></tr>
|
|
<tr><td class="paramname">t_handle</td><td>The pointer to an allocated space to store the transactional layer internal state. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>The pointer to the parameters required to configure the LPUART after initialization. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 succeed, others failed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga057e59dcc578ef4b303850bcd90ca50e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int LPUART_RTOS_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">lpuart_rtos_handle_t * </td>
|
|
<td class="paramname"><em>handle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function deinitializes the LPUART module, sets all register value to the reset value, and releases the resources.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The RTOS LPUART handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga275e067e13ecc77dde83d2d7938c038e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int LPUART_RTOS_Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype">lpuart_rtos_handle_t * </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>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function sends data. It is an synchronous API. If the hardware buffer is full, the task is in the blocked state.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The RTOS LPUART handle. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>The pointer to buffer to send. </td></tr>
|
|
<tr><td class="paramname">length</td><td>The number of bytes to send. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0561f87122863c6e9b20f8991a73a0fb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int LPUART_RTOS_Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">lpuart_rtos_handle_t * </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>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>received</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function receives data from LPUART. It is an synchronous API. If any data is immediately available it is returned immediately and the number of bytes received.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">handle</td><td>The RTOS LPUART handle. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>The pointer to buffer where to write received data. </td></tr>
|
|
<tr><td class="paramname">length</td><td>The number of bytes to receive. </td></tr>
|
|
<tr><td class="paramname">received</td><td>The pointer to a variable of size_t where the number of received data is filled. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3e211e0c1a2c93d9bdd73d6ca4639a10"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int LPUART_RTOS_SetRxTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">lpuart_rtos_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>rx_timeout_constant_ms</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>rx_timeout_multiplier_ms</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function can modify RX timeout between initialization and receive.</p>
|
|
<p>param handle The RTOS LPUART handle. param rx_timeout_constant_ms RX timeout applied per receive. param rx_timeout_multiplier_ms RX timeout added for each byte of the receive. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad2317ff04710f0f4a2dc7d219f850c85"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int LPUART_RTOS_SetTxTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">lpuart_rtos_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>tx_timeout_constant_ms</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>tx_timeout_multiplier_ms</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function can modify TX timeout between initialization and send.</p>
|
|
<p>param handle The RTOS LPUART handle. param tx_timeout_constant_ms TX timeout applied per transmition. param tx_timeout_multiplier_ms TX timeout added for each byte of the transmition. </p>
|
|
|
|
</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>
|