425 lines
31 KiB
HTML
425 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>Kinetis SDK v.2.0 API Reference Manual: UART 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="nxp_logo_small.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Kinetis SDK v.2.0 API Reference Manual
|
|
 <span id="projectnumber">Rev. 0</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('group__uart__freertos__driver.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> </div>
|
|
<div class="headertitle">
|
|
<div class="title">UART FreeRTOS Driver<div class="ingroups"><a class="el" href="group__uart.html">UART: 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:structrtos__uart__config"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#structrtos__uart__config">rtos_uart_config</a></td></tr>
|
|
<tr class="memdesc:structrtos__uart__config"><td class="mdescLeft"> </td><td class="mdescRight">UART configuration structure. <a href="group__uart__freertos__driver.html#structrtos__uart__config">More...</a><br/></td></tr>
|
|
<tr class="separator:structrtos__uart__config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structuart__rtos__handle__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a></td></tr>
|
|
<tr class="memdesc:structuart__rtos__handle__t"><td class="mdescLeft"> </td><td class="mdescRight">UART FreeRTOS handle. <a href="group__uart__freertos__driver.html#structuart__rtos__handle__t">More...</a><br/></td></tr>
|
|
<tr class="separator:structuart__rtos__handle__t"><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>
|
|
UART RTOS Operation</h2></td></tr>
|
|
<tr class="memitem:ga151bb7582b8aaec316e335446e5bec0b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#ga151bb7582b8aaec316e335446e5bec0b">UART_RTOS_Init</a> (<a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a> *handle, uart_handle_t *t_handle, const struct <a class="el" href="group__uart__freertos__driver.html#structrtos__uart__config">rtos_uart_config</a> *cfg)</td></tr>
|
|
<tr class="memdesc:ga151bb7582b8aaec316e335446e5bec0b"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a UART instance for operation in RTOS. <a href="#ga151bb7582b8aaec316e335446e5bec0b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga151bb7582b8aaec316e335446e5bec0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab7ac281cb85e1d290c8f25c83a6facfc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#gab7ac281cb85e1d290c8f25c83a6facfc">UART_RTOS_Deinit</a> (<a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:gab7ac281cb85e1d290c8f25c83a6facfc"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes a UART instance for operation. <a href="#gab7ac281cb85e1d290c8f25c83a6facfc">More...</a><br/></td></tr>
|
|
<tr class="separator:gab7ac281cb85e1d290c8f25c83a6facfc"><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>
|
|
UART transactional Operation</h2></td></tr>
|
|
<tr class="memitem:gada4115d237b9517f2587a054dbdc442a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#gada4115d237b9517f2587a054dbdc442a">UART_RTOS_Send</a> (<a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a> *handle, const uint8_t *buffer, uint32_t length)</td></tr>
|
|
<tr class="memdesc:gada4115d237b9517f2587a054dbdc442a"><td class="mdescLeft"> </td><td class="mdescRight">Sends data in the background. <a href="#gada4115d237b9517f2587a054dbdc442a">More...</a><br/></td></tr>
|
|
<tr class="separator:gada4115d237b9517f2587a054dbdc442a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa8adcb11232b565985f3f5961815a00c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#gaa8adcb11232b565985f3f5961815a00c">UART_RTOS_Receive</a> (<a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a> *handle, uint8_t *buffer, uint32_t length, size_t *received)</td></tr>
|
|
<tr class="memdesc:gaa8adcb11232b565985f3f5961815a00c"><td class="mdescLeft"> </td><td class="mdescRight">Receives data. <a href="#gaa8adcb11232b565985f3f5961815a00c">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa8adcb11232b565985f3f5961815a00c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="structrtos__uart__config" id="structrtos__uart__config"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct rtos_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:a12498b3bc4f2de990b62e9b09decab46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12498b3bc4f2de990b62e9b09decab46"></a>
|
|
UART_Type * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a12498b3bc4f2de990b62e9b09decab46">base</a></td></tr>
|
|
<tr class="memdesc:a12498b3bc4f2de990b62e9b09decab46"><td class="mdescLeft"> </td><td class="mdescRight">UART base address. <br/></td></tr>
|
|
<tr class="separator:a12498b3bc4f2de990b62e9b09decab46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75c05d4047a88be9cf938fff0bb560a1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75c05d4047a88be9cf938fff0bb560a1"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a75c05d4047a88be9cf938fff0bb560a1">srcclk</a></td></tr>
|
|
<tr class="memdesc:a75c05d4047a88be9cf938fff0bb560a1"><td class="mdescLeft"> </td><td class="mdescRight">UART source clock in Hz. <br/></td></tr>
|
|
<tr class="separator:a75c05d4047a88be9cf938fff0bb560a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3cbf4c1a2c64bdc5e95668d2aaecbd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3cbf4c1a2c64bdc5e95668d2aaecbd3"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#aa3cbf4c1a2c64bdc5e95668d2aaecbd3">baudrate</a></td></tr>
|
|
<tr class="memdesc:aa3cbf4c1a2c64bdc5e95668d2aaecbd3"><td class="mdescLeft"> </td><td class="mdescRight">Desired communication speed. <br/></td></tr>
|
|
<tr class="separator:aa3cbf4c1a2c64bdc5e95668d2aaecbd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4cb1d51b43cd234b83ae70034d32221"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4cb1d51b43cd234b83ae70034d32221"></a>
|
|
<a class="el" href="group__uart__driver.html#ga436e5a7bdb5f24decb5bfb0c87a83ff4">uart_parity_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#aa4cb1d51b43cd234b83ae70034d32221">parity</a></td></tr>
|
|
<tr class="memdesc:aa4cb1d51b43cd234b83ae70034d32221"><td class="mdescLeft"> </td><td class="mdescRight">Parity setting. <br/></td></tr>
|
|
<tr class="separator:aa4cb1d51b43cd234b83ae70034d32221"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a7fe60cc718b814f010402aae866789"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a7fe60cc718b814f010402aae866789"></a>
|
|
<a class="el" href="group__uart__driver.html#gaca4f14d23735c6afefb76cbee18e1db6">uart_stop_bit_count_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a2a7fe60cc718b814f010402aae866789">stopbits</a></td></tr>
|
|
<tr class="memdesc:a2a7fe60cc718b814f010402aae866789"><td class="mdescLeft"> </td><td class="mdescRight">Number of stop bits to use. <br/></td></tr>
|
|
<tr class="separator:a2a7fe60cc718b814f010402aae866789"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24e815ce7cd2a590967700b6cf0c1cd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24e815ce7cd2a590967700b6cf0c1cd3"></a>
|
|
uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a24e815ce7cd2a590967700b6cf0c1cd3">buffer</a></td></tr>
|
|
<tr class="memdesc:a24e815ce7cd2a590967700b6cf0c1cd3"><td class="mdescLeft"> </td><td class="mdescRight">Buffer for background reception. <br/></td></tr>
|
|
<tr class="separator:a24e815ce7cd2a590967700b6cf0c1cd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cf172103fc85f470b684020778bbb04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cf172103fc85f470b684020778bbb04"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a0cf172103fc85f470b684020778bbb04">buffer_size</a></td></tr>
|
|
<tr class="memdesc:a0cf172103fc85f470b684020778bbb04"><td class="mdescLeft"> </td><td class="mdescRight">Size of buffer for background reception. <br/></td></tr>
|
|
<tr class="separator:a0cf172103fc85f470b684020778bbb04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structuart__rtos__handle__t" id="structuart__rtos__handle__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct uart_rtos_handle_t</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:a3e93df5481a3fd8cc81b1024e7d63c4d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e93df5481a3fd8cc81b1024e7d63c4d"></a>
|
|
UART_Type * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a3e93df5481a3fd8cc81b1024e7d63c4d">base</a></td></tr>
|
|
<tr class="memdesc:a3e93df5481a3fd8cc81b1024e7d63c4d"><td class="mdescLeft"> </td><td class="mdescRight">UART base address. <br/></td></tr>
|
|
<tr class="separator:a3e93df5481a3fd8cc81b1024e7d63c4d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ae76e285799dcb9bf91c6ea42e97162"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ae76e285799dcb9bf91c6ea42e97162"></a>
|
|
struct _uart_transfer </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a1ae76e285799dcb9bf91c6ea42e97162">tx_xfer</a></td></tr>
|
|
<tr class="memdesc:a1ae76e285799dcb9bf91c6ea42e97162"><td class="mdescLeft"> </td><td class="mdescRight">TX transfer structure. <br/></td></tr>
|
|
<tr class="separator:a1ae76e285799dcb9bf91c6ea42e97162"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa2a38f518786886aa286e7e12a70a5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa2a38f518786886aa286e7e12a70a5e"></a>
|
|
struct _uart_transfer </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#aaa2a38f518786886aa286e7e12a70a5e">rx_xfer</a></td></tr>
|
|
<tr class="memdesc:aaa2a38f518786886aa286e7e12a70a5e"><td class="mdescLeft"> </td><td class="mdescRight">RX transfer structure. <br/></td></tr>
|
|
<tr class="separator:aaa2a38f518786886aa286e7e12a70a5e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a790dc0dc1874320e13a2f80a928922a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a790dc0dc1874320e13a2f80a928922a6"></a>
|
|
SemaphoreHandle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a790dc0dc1874320e13a2f80a928922a6">rx_sem</a></td></tr>
|
|
<tr class="memdesc:a790dc0dc1874320e13a2f80a928922a6"><td class="mdescLeft"> </td><td class="mdescRight">RX semaphore for resource sharing. <br/></td></tr>
|
|
<tr class="separator:a790dc0dc1874320e13a2f80a928922a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3babcb2d71fdc7b7dcaf50c44bafde46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3babcb2d71fdc7b7dcaf50c44bafde46"></a>
|
|
SemaphoreHandle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a3babcb2d71fdc7b7dcaf50c44bafde46">tx_sem</a></td></tr>
|
|
<tr class="memdesc:a3babcb2d71fdc7b7dcaf50c44bafde46"><td class="mdescLeft"> </td><td class="mdescRight">TX semaphore for resource sharing. <br/></td></tr>
|
|
<tr class="separator:a3babcb2d71fdc7b7dcaf50c44bafde46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a05cd29fed89ec3fedf1a77d05f21fa8f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05cd29fed89ec3fedf1a77d05f21fa8f"></a>
|
|
EventGroupHandle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a05cd29fed89ec3fedf1a77d05f21fa8f">rx_event</a></td></tr>
|
|
<tr class="memdesc:a05cd29fed89ec3fedf1a77d05f21fa8f"><td class="mdescLeft"> </td><td class="mdescRight">RX completion event. <br/></td></tr>
|
|
<tr class="separator:a05cd29fed89ec3fedf1a77d05f21fa8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7998db9a64c32c235b6d1ff0a7d27ae9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7998db9a64c32c235b6d1ff0a7d27ae9"></a>
|
|
EventGroupHandle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a7998db9a64c32c235b6d1ff0a7d27ae9">tx_event</a></td></tr>
|
|
<tr class="memdesc:a7998db9a64c32c235b6d1ff0a7d27ae9"><td class="mdescLeft"> </td><td class="mdescRight">TX completion event. <br/></td></tr>
|
|
<tr class="separator:a7998db9a64c32c235b6d1ff0a7d27ae9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab820ed6b1fa8ac25f710ebeba2dd4aff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab820ed6b1fa8ac25f710ebeba2dd4aff"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#ab820ed6b1fa8ac25f710ebeba2dd4aff">t_state</a></td></tr>
|
|
<tr class="memdesc:ab820ed6b1fa8ac25f710ebeba2dd4aff"><td class="mdescLeft"> </td><td class="mdescRight">Transactional state of the underlying driver. <br/></td></tr>
|
|
<tr class="separator:ab820ed6b1fa8ac25f710ebeba2dd4aff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7d2323da6a0d89df4d12c4c4359acd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7d2323da6a0d89df4d12c4c4359acd1"></a>
|
|
OS_EVENT * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#af7d2323da6a0d89df4d12c4c4359acd1">rx_sem</a></td></tr>
|
|
<tr class="memdesc:af7d2323da6a0d89df4d12c4c4359acd1"><td class="mdescLeft"> </td><td class="mdescRight">RX semaphore for resource sharing. <br/></td></tr>
|
|
<tr class="separator:af7d2323da6a0d89df4d12c4c4359acd1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc653c6802f4adab3767318c2a95499e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc653c6802f4adab3767318c2a95499e"></a>
|
|
OS_EVENT * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#afc653c6802f4adab3767318c2a95499e">tx_sem</a></td></tr>
|
|
<tr class="memdesc:afc653c6802f4adab3767318c2a95499e"><td class="mdescLeft"> </td><td class="mdescRight">TX semaphore for resource sharing. <br/></td></tr>
|
|
<tr class="separator:afc653c6802f4adab3767318c2a95499e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b66aa32ca6a37312495a8cb9b88edfe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b66aa32ca6a37312495a8cb9b88edfe"></a>
|
|
OS_FLAG_GRP * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a8b66aa32ca6a37312495a8cb9b88edfe">rx_event</a></td></tr>
|
|
<tr class="memdesc:a8b66aa32ca6a37312495a8cb9b88edfe"><td class="mdescLeft"> </td><td class="mdescRight">RX completion event. <br/></td></tr>
|
|
<tr class="separator:a8b66aa32ca6a37312495a8cb9b88edfe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d50b03209293b94eeaacbc469e3a10b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d50b03209293b94eeaacbc469e3a10b"></a>
|
|
OS_FLAG_GRP * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a4d50b03209293b94eeaacbc469e3a10b">tx_event</a></td></tr>
|
|
<tr class="memdesc:a4d50b03209293b94eeaacbc469e3a10b"><td class="mdescLeft"> </td><td class="mdescRight">TX completion event. <br/></td></tr>
|
|
<tr class="separator:a4d50b03209293b94eeaacbc469e3a10b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1f215f9702891b9a76ea605ad6f7c54"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1f215f9702891b9a76ea605ad6f7c54"></a>
|
|
OS_SEM </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#ab1f215f9702891b9a76ea605ad6f7c54">rx_sem</a></td></tr>
|
|
<tr class="memdesc:ab1f215f9702891b9a76ea605ad6f7c54"><td class="mdescLeft"> </td><td class="mdescRight">RX semaphore for resource sharing. <br/></td></tr>
|
|
<tr class="separator:ab1f215f9702891b9a76ea605ad6f7c54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2a7d59c5dc4f7031026c4cd812cd6d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2a7d59c5dc4f7031026c4cd812cd6d4"></a>
|
|
OS_SEM </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#ad2a7d59c5dc4f7031026c4cd812cd6d4">tx_sem</a></td></tr>
|
|
<tr class="memdesc:ad2a7d59c5dc4f7031026c4cd812cd6d4"><td class="mdescLeft"> </td><td class="mdescRight">TX semaphore for resource sharing. <br/></td></tr>
|
|
<tr class="separator:ad2a7d59c5dc4f7031026c4cd812cd6d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03dd026d7386ed5f37edcec8bf3ec47a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03dd026d7386ed5f37edcec8bf3ec47a"></a>
|
|
OS_FLAG_GRP </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a03dd026d7386ed5f37edcec8bf3ec47a">rx_event</a></td></tr>
|
|
<tr class="memdesc:a03dd026d7386ed5f37edcec8bf3ec47a"><td class="mdescLeft"> </td><td class="mdescRight">RX completion event. <br/></td></tr>
|
|
<tr class="separator:a03dd026d7386ed5f37edcec8bf3ec47a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b8553ea48e5aebf9e413d5da29bb597"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b8553ea48e5aebf9e413d5da29bb597"></a>
|
|
OS_FLAG_GRP </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__freertos__driver.html#a3b8553ea48e5aebf9e413d5da29bb597">tx_event</a></td></tr>
|
|
<tr class="memdesc:a3b8553ea48e5aebf9e413d5da29bb597"><td class="mdescLeft"> </td><td class="mdescRight">TX completion event. <br/></td></tr>
|
|
<tr class="separator:a3b8553ea48e5aebf9e413d5da29bb597"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga151bb7582b8aaec316e335446e5bec0b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int UART_RTOS_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uart_handle_t * </td>
|
|
<td class="paramname"><em>t_handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const struct <a class="el" href="group__uart__freertos__driver.html#structrtos__uart__config">rtos_uart_config</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 UART handle, the pointer to allocated space for RTOS context. </td></tr>
|
|
<tr><td class="paramname">t_handle</td><td>The pointer to allocated space where to store transactional layer internal state. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>The pointer to the parameters required to configure the UART after initialization. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 succeed, others fail. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab7ac281cb85e1d290c8f25c83a6facfc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int UART_RTOS_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function deinitializes the UART module, sets all register values to 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 UART handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gada4115d237b9517f2587a054dbdc442a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int UART_RTOS_Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</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 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 a 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 UART 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="gaa8adcb11232b565985f3f5961815a00c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int UART_RTOS_Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__uart__freertos__driver.html#structuart__rtos__handle__t">uart_rtos_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>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 UART. It is a synchronous API. If 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 UART 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>
|
|
</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 Freescale Semiconductor, Inc. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|