mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-06 03:12:15 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/uart_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

1342 lines
78 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/services/uart.h File Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">uart.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>UART service IPC wrapper.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="event_8h_source.html">../kernel/event.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="service_8h_source.html">../sf/service.h</a>&quot;</code><br />
</div>
<p><a href="uart_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUartPortSession.html">UartPortSession</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">PortSession. <a href="structUartPortSession.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0ae332307ec2333bd3f1f22982c84848" id="r_a0ae332307ec2333bd3f1f22982c84848"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> { <br />
&#160;&#160;<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848a3455db5ae60026597702842cb51a4378">UartPort_Bluetooth</a> = 1
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848a63b663ba8afe5223e794bc2c66a17510">UartPort_JoyConR</a> = 2
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848aaad9111cbd92940d0de7ff4e339ca744">UartPort_JoyConL</a> = 3
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848a9b50e737616521a8b0d6d0500a8e5a52">UartPort_MCU</a> = 4
<br />
}</td></tr>
<tr class="memdesc:a0ae332307ec2333bd3f1f22982c84848"><td class="mdescLeft">&#160;</td><td class="mdescRight">UartPort. <a href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">More...</a><br /></td></tr>
<tr class="separator:a0ae332307ec2333bd3f1f22982c84848"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d7c3039360b3a4c66c0ef046ff18fd0" id="r_a3d7c3039360b3a4c66c0ef046ff18fd0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> { <br />
&#160;&#160;<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0af8aacf7c767a5eedb493ada75003fadc">UartPortForDev_JoyConR</a> = 1
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0a9e19d311de50b2efd04a630a6900b8c8">UartPortForDev_JoyConL</a> = 2
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0a82baa8c3f51c2ac522972e74e6a02b75">UartPortForDev_Bluetooth</a> = 3
<br />
}</td></tr>
<tr class="memdesc:a3d7c3039360b3a4c66c0ef046ff18fd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">UartPortForDev. <a href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">More...</a><br /></td></tr>
<tr class="separator:a3d7c3039360b3a4c66c0ef046ff18fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02ce1b54774c3ba4472f4ddcbecf71bd" id="r_a02ce1b54774c3ba4472f4ddcbecf71bd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> { <br />
&#160;&#160;<a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bdaec2bd31f6afca8f59c84fd8aa944a5f7">UartFlowControlMode_None</a> = 0
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bda341404f630a87ea550ab6e764edb36a8">UartFlowControlMode_Hardware</a> = 1
<br />
}</td></tr>
<tr class="memdesc:a02ce1b54774c3ba4472f4ddcbecf71bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">FlowControlMode. <a href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">More...</a><br /></td></tr>
<tr class="separator:a02ce1b54774c3ba4472f4ddcbecf71bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3a8d70f64844b2c8c7d0f20a8d7adb6" id="r_ac3a8d70f64844b2c8c7d0f20a8d7adb6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> { <br />
&#160;&#160;<a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6aedd4abf7dc2965a8c00477cf9f0e165d">UartPortEventType_SendBufferEmpty</a> = 0
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6afc0f8e0ccedbfd46ec69e543399358ba">UartPortEventType_SendBufferReady</a> = 1
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6a6024f768b48029422554643060a722ae">UartPortEventType_ReceiveBufferReady</a> = 2
, <br />
&#160;&#160;<a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6ad597c75f21f30e6497022b2f78b59cf8">UartPortEventType_ReceiveEnd</a> = 3
<br />
}</td></tr>
<tr class="memdesc:ac3a8d70f64844b2c8c7d0f20a8d7adb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">PortEventType. <a href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">More...</a><br /></td></tr>
<tr class="separator:ac3a8d70f64844b2c8c7d0f20a8d7adb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a97bc85c33285b837a4d5575947c26c2a" id="r_a97bc85c33285b837a4d5575947c26c2a"><td class="memItemLeft" align="right" valign="top"><a id="a97bc85c33285b837a4d5575947c26c2a" name="a97bc85c33285b837a4d5575947c26c2a"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>uartInitialize</b> (void)</td></tr>
<tr class="memdesc:a97bc85c33285b837a4d5575947c26c2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize uart. <br /></td></tr>
<tr class="separator:a97bc85c33285b837a4d5575947c26c2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6816678e3fecc000c660cf6bd86e3173" id="r_a6816678e3fecc000c660cf6bd86e3173"><td class="memItemLeft" align="right" valign="top"><a id="a6816678e3fecc000c660cf6bd86e3173" name="a6816678e3fecc000c660cf6bd86e3173"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>uartExit</b> (void)</td></tr>
<tr class="memdesc:a6816678e3fecc000c660cf6bd86e3173"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit uart. <br /></td></tr>
<tr class="separator:a6816678e3fecc000c660cf6bd86e3173"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c283a44928a2a4213f458076bc1cdd6" id="r_a0c283a44928a2a4213f458076bc1cdd6"><td class="memItemLeft" align="right" valign="top"><a id="a0c283a44928a2a4213f458076bc1cdd6" name="a0c283a44928a2a4213f458076bc1cdd6"></a>
<a class="el" href="structService.html">Service</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>uartGetServiceSession</b> (void)</td></tr>
<tr class="memdesc:a0c283a44928a2a4213f458076bc1cdd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the <a class="el" href="structService.html" title="Service object structure.">Service</a> object for the actual uart service session. <br /></td></tr>
<tr class="separator:a0c283a44928a2a4213f458076bc1cdd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa278955a822631ce09aa9ac71a699e7d" id="r_aa278955a822631ce09aa9ac71a699e7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#aa278955a822631ce09aa9ac71a699e7d">uartHasPort</a> (<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> port, bool *out)</td></tr>
<tr class="memdesc:aa278955a822631ce09aa9ac71a699e7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">HasPort. <br /></td></tr>
<tr class="separator:aa278955a822631ce09aa9ac71a699e7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf5b2156fef57ed8c4b551250d050625" id="r_abf5b2156fef57ed8c4b551250d050625"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#abf5b2156fef57ed8c4b551250d050625">uartHasPortForDev</a> (<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> port, bool *out)</td></tr>
<tr class="memdesc:abf5b2156fef57ed8c4b551250d050625"><td class="mdescLeft">&#160;</td><td class="mdescRight">HasPortForDev. <br /></td></tr>
<tr class="separator:abf5b2156fef57ed8c4b551250d050625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2079f1bc2b1061896139632c3385c5bf" id="r_a2079f1bc2b1061896139632c3385c5bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a2079f1bc2b1061896139632c3385c5bf">uartIsSupportedBaudRate</a> (<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> port, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> baud_rate, bool *out)</td></tr>
<tr class="memdesc:a2079f1bc2b1061896139632c3385c5bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedBaudRate. <br /></td></tr>
<tr class="separator:a2079f1bc2b1061896139632c3385c5bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00febeb633645a9b5f2a60f801496b51" id="r_a00febeb633645a9b5f2a60f801496b51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a00febeb633645a9b5f2a60f801496b51">uartIsSupportedBaudRateForDev</a> (<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> port, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> baud_rate, bool *out)</td></tr>
<tr class="memdesc:a00febeb633645a9b5f2a60f801496b51"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedBaudRateForDev. <br /></td></tr>
<tr class="separator:a00febeb633645a9b5f2a60f801496b51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3a991a09696fa49f220443c3647034c" id="r_ad3a991a09696fa49f220443c3647034c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#ad3a991a09696fa49f220443c3647034c">uartIsSupportedFlowControlMode</a> (<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> port, <a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> flow_control_mode, bool *out)</td></tr>
<tr class="memdesc:ad3a991a09696fa49f220443c3647034c"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedFlowControlMode. <br /></td></tr>
<tr class="separator:ad3a991a09696fa49f220443c3647034c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad14393fd12c33001635d4db4cb6cffc" id="r_aad14393fd12c33001635d4db4cb6cffc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#aad14393fd12c33001635d4db4cb6cffc">uartIsSupportedFlowControlModeForDev</a> (<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> port, <a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> flow_control_mode, bool *out)</td></tr>
<tr class="memdesc:aad14393fd12c33001635d4db4cb6cffc"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedFlowControlModeForDev. <br /></td></tr>
<tr class="separator:aad14393fd12c33001635d4db4cb6cffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9246c70ff633ad7a6e634ab27a5a4ec1" id="r_a9246c70ff633ad7a6e634ab27a5a4ec1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a9246c70ff633ad7a6e634ab27a5a4ec1">uartCreatePortSession</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s)</td></tr>
<tr class="memdesc:a9246c70ff633ad7a6e634ab27a5a4ec1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an <a class="el" href="structUartPortSession.html">UartPortSession</a>. <br /></td></tr>
<tr class="separator:a9246c70ff633ad7a6e634ab27a5a4ec1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adef6a7c62f607569db4ac2d3b071b504" id="r_adef6a7c62f607569db4ac2d3b071b504"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#adef6a7c62f607569db4ac2d3b071b504">uartIsSupportedPortEvent</a> (<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> port, <a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> port_event_type, bool *out)</td></tr>
<tr class="memdesc:adef6a7c62f607569db4ac2d3b071b504"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedPortEvent. <br /></td></tr>
<tr class="separator:adef6a7c62f607569db4ac2d3b071b504"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa62e3abca692d7b98a2c8a33dec8d93d" id="r_aa62e3abca692d7b98a2c8a33dec8d93d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#aa62e3abca692d7b98a2c8a33dec8d93d">uartIsSupportedPortEventForDev</a> (<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> port, <a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> port_event_type, bool *out)</td></tr>
<tr class="memdesc:aa62e3abca692d7b98a2c8a33dec8d93d"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedPortEventForDev. <br /></td></tr>
<tr class="separator:aa62e3abca692d7b98a2c8a33dec8d93d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc3f5ebd73c486a18c1c0057974d00c3" id="r_afc3f5ebd73c486a18c1c0057974d00c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#afc3f5ebd73c486a18c1c0057974d00c3">uartIsSupportedDeviceVariation</a> (<a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> port, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> device_variation, bool *out)</td></tr>
<tr class="memdesc:afc3f5ebd73c486a18c1c0057974d00c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedDeviceVariation. <br /></td></tr>
<tr class="separator:afc3f5ebd73c486a18c1c0057974d00c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a796ba56cb92824ed7002596938b96c" id="r_a3a796ba56cb92824ed7002596938b96c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a3a796ba56cb92824ed7002596938b96c">uartIsSupportedDeviceVariationForDev</a> (<a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> port, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> device_variation, bool *out)</td></tr>
<tr class="memdesc:a3a796ba56cb92824ed7002596938b96c"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsSupportedDeviceVariationForDev. <br /></td></tr>
<tr class="separator:a3a796ba56cb92824ed7002596938b96c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">IPortSession</div></td></tr>
<tr class="memitem:a95384edd81ad3d1d5d5a5b2971efe4de" id="r_a95384edd81ad3d1d5d5a5b2971efe4de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a95384edd81ad3d1d5d5a5b2971efe4de">uartPortSessionClose</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s)</td></tr>
<tr class="memdesc:a95384edd81ad3d1d5d5a5b2971efe4de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close an <a class="el" href="structUartPortSession.html">UartPortSession</a>. <br /></td></tr>
<tr class="separator:a95384edd81ad3d1d5d5a5b2971efe4de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14653d03d91d31cc64ccf291c7faaf5c" id="r_a14653d03d91d31cc64ccf291c7faaf5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a14653d03d91d31cc64ccf291c7faaf5c">uartPortSessionOpenPort</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, bool *out, <a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> port, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> baud_rate, <a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> flow_control_mode, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> device_variation, bool is_invert_tx, bool is_invert_rx, bool is_invert_rts, bool is_invert_cts, void *send_buffer, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> send_buffer_length, void *receive_buffer, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> receive_buffer_length)</td></tr>
<tr class="memdesc:a14653d03d91d31cc64ccf291c7faaf5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">OpenPort. <br /></td></tr>
<tr class="separator:a14653d03d91d31cc64ccf291c7faaf5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8bce74ab5ae513e3530424c43c6091c" id="r_ae8bce74ab5ae513e3530424c43c6091c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#ae8bce74ab5ae513e3530424c43c6091c">uartPortSessionOpenPortForDev</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, bool *out, <a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> port, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> baud_rate, <a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> flow_control_mode, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> device_variation, bool is_invert_tx, bool is_invert_rx, bool is_invert_rts, bool is_invert_cts, void *send_buffer, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> send_buffer_length, void *receive_buffer, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> receive_buffer_length)</td></tr>
<tr class="memdesc:ae8bce74ab5ae513e3530424c43c6091c"><td class="mdescLeft">&#160;</td><td class="mdescRight">OpenPortForDev. <br /></td></tr>
<tr class="separator:ae8bce74ab5ae513e3530424c43c6091c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa62ecb71cbeb1e045a9c3205a97cd575" id="r_aa62ecb71cbeb1e045a9c3205a97cd575"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#aa62ecb71cbeb1e045a9c3205a97cd575">uartPortSessionGetWritableLength</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out)</td></tr>
<tr class="memdesc:aa62ecb71cbeb1e045a9c3205a97cd575"><td class="mdescLeft">&#160;</td><td class="mdescRight">GetWritableLength. <br /></td></tr>
<tr class="separator:aa62ecb71cbeb1e045a9c3205a97cd575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3a5a82aa379ac26992fbf865b3f1885" id="r_af3a5a82aa379ac26992fbf865b3f1885"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#af3a5a82aa379ac26992fbf865b3f1885">uartPortSessionSend</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, const void *in_data, size_t size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out)</td></tr>
<tr class="memdesc:af3a5a82aa379ac26992fbf865b3f1885"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send. <br /></td></tr>
<tr class="separator:af3a5a82aa379ac26992fbf865b3f1885"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac33b0369c14cd8b0654543d83e8f4a58" id="r_ac33b0369c14cd8b0654543d83e8f4a58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#ac33b0369c14cd8b0654543d83e8f4a58">uartPortSessionGetReadableLength</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out)</td></tr>
<tr class="memdesc:ac33b0369c14cd8b0654543d83e8f4a58"><td class="mdescLeft">&#160;</td><td class="mdescRight">GetReadableLength. <br /></td></tr>
<tr class="separator:ac33b0369c14cd8b0654543d83e8f4a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b4922f7b63832aee2b82e961e2f24e3" id="r_a5b4922f7b63832aee2b82e961e2f24e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a5b4922f7b63832aee2b82e961e2f24e3">uartPortSessionReceive</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, void *out_data, size_t size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out)</td></tr>
<tr class="memdesc:a5b4922f7b63832aee2b82e961e2f24e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive. <br /></td></tr>
<tr class="separator:a5b4922f7b63832aee2b82e961e2f24e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89211ef2da7a01bc58cdb3e4bd57fca6" id="r_a89211ef2da7a01bc58cdb3e4bd57fca6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a89211ef2da7a01bc58cdb3e4bd57fca6">uartPortSessionBindPortEvent</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, <a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> port_event_type, <a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a> threshold, bool *out, <a class="el" href="structEvent.html">Event</a> *out_event)</td></tr>
<tr class="memdesc:a89211ef2da7a01bc58cdb3e4bd57fca6"><td class="mdescLeft">&#160;</td><td class="mdescRight">BindPortEvent. <br /></td></tr>
<tr class="separator:a89211ef2da7a01bc58cdb3e4bd57fca6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a759cae24e32601242dfe2df0bf55a7bb" id="r_a759cae24e32601242dfe2df0bf55a7bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uart_8h.html#a759cae24e32601242dfe2df0bf55a7bb">uartPortSessionUnbindPortEvent</a> (<a class="el" href="structUartPortSession.html">UartPortSession</a> *s, <a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> port_event_type, bool *out)</td></tr>
<tr class="memdesc:a759cae24e32601242dfe2df0bf55a7bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">UnbindPortEvent. <br /></td></tr>
<tr class="separator:a759cae24e32601242dfe2df0bf55a7bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>UART service IPC wrapper. </p>
<dl class="section author"><dt>Author</dt><dd>yellows8 </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a02ce1b54774c3ba4472f4ddcbecf71bd" name="a02ce1b54774c3ba4472f4ddcbecf71bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02ce1b54774c3ba4472f4ddcbecf71bd">&#9670;&#160;</a></span>UartFlowControlMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>FlowControlMode. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a02ce1b54774c3ba4472f4ddcbecf71bdaec2bd31f6afca8f59c84fd8aa944a5f7" name="a02ce1b54774c3ba4472f4ddcbecf71bdaec2bd31f6afca8f59c84fd8aa944a5f7"></a>UartFlowControlMode_None&#160;</td><td class="fielddoc"><p>None. </p>
</td></tr>
<tr><td class="fieldname"><a id="a02ce1b54774c3ba4472f4ddcbecf71bda341404f630a87ea550ab6e764edb36a8" name="a02ce1b54774c3ba4472f4ddcbecf71bda341404f630a87ea550ab6e764edb36a8"></a>UartFlowControlMode_Hardware&#160;</td><td class="fielddoc"><p>Hardware. </p>
</td></tr>
</table>
</div>
</div>
<a id="a0ae332307ec2333bd3f1f22982c84848" name="a0ae332307ec2333bd3f1f22982c84848"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ae332307ec2333bd3f1f22982c84848">&#9670;&#160;</a></span>UartPort</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>UartPort. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0ae332307ec2333bd3f1f22982c84848a3455db5ae60026597702842cb51a4378" name="a0ae332307ec2333bd3f1f22982c84848a3455db5ae60026597702842cb51a4378"></a>UartPort_Bluetooth&#160;</td><td class="fielddoc"><p>Bluetooth. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0ae332307ec2333bd3f1f22982c84848a63b663ba8afe5223e794bc2c66a17510" name="a0ae332307ec2333bd3f1f22982c84848a63b663ba8afe5223e794bc2c66a17510"></a>UartPort_JoyConR&#160;</td><td class="fielddoc"><p>Joy-Con(R) </p>
</td></tr>
<tr><td class="fieldname"><a id="a0ae332307ec2333bd3f1f22982c84848aaad9111cbd92940d0de7ff4e339ca744" name="a0ae332307ec2333bd3f1f22982c84848aaad9111cbd92940d0de7ff4e339ca744"></a>UartPort_JoyConL&#160;</td><td class="fielddoc"><p>Joy-Con(L) </p>
</td></tr>
<tr><td class="fieldname"><a id="a0ae332307ec2333bd3f1f22982c84848a9b50e737616521a8b0d6d0500a8e5a52" name="a0ae332307ec2333bd3f1f22982c84848a9b50e737616521a8b0d6d0500a8e5a52"></a>UartPort_MCU&#160;</td><td class="fielddoc"><p>MCU. </p>
</td></tr>
</table>
</div>
</div>
<a id="ac3a8d70f64844b2c8c7d0f20a8d7adb6" name="ac3a8d70f64844b2c8c7d0f20a8d7adb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3a8d70f64844b2c8c7d0f20a8d7adb6">&#9670;&#160;</a></span>UartPortEventType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PortEventType. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac3a8d70f64844b2c8c7d0f20a8d7adb6aedd4abf7dc2965a8c00477cf9f0e165d" name="ac3a8d70f64844b2c8c7d0f20a8d7adb6aedd4abf7dc2965a8c00477cf9f0e165d"></a>UartPortEventType_SendBufferEmpty&#160;</td><td class="fielddoc"><p>SendBufferEmpty. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac3a8d70f64844b2c8c7d0f20a8d7adb6afc0f8e0ccedbfd46ec69e543399358ba" name="ac3a8d70f64844b2c8c7d0f20a8d7adb6afc0f8e0ccedbfd46ec69e543399358ba"></a>UartPortEventType_SendBufferReady&#160;</td><td class="fielddoc"><p>SendBufferReady. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac3a8d70f64844b2c8c7d0f20a8d7adb6a6024f768b48029422554643060a722ae" name="ac3a8d70f64844b2c8c7d0f20a8d7adb6a6024f768b48029422554643060a722ae"></a>UartPortEventType_ReceiveBufferReady&#160;</td><td class="fielddoc"><p>ReceiveBufferReady. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac3a8d70f64844b2c8c7d0f20a8d7adb6ad597c75f21f30e6497022b2f78b59cf8" name="ac3a8d70f64844b2c8c7d0f20a8d7adb6ad597c75f21f30e6497022b2f78b59cf8"></a>UartPortEventType_ReceiveEnd&#160;</td><td class="fielddoc"><p>ReceiveEnd. </p>
</td></tr>
</table>
</div>
</div>
<a id="a3d7c3039360b3a4c66c0ef046ff18fd0" name="a3d7c3039360b3a4c66c0ef046ff18fd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d7c3039360b3a4c66c0ef046ff18fd0">&#9670;&#160;</a></span>UartPortForDev</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>UartPortForDev. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3d7c3039360b3a4c66c0ef046ff18fd0af8aacf7c767a5eedb493ada75003fadc" name="a3d7c3039360b3a4c66c0ef046ff18fd0af8aacf7c767a5eedb493ada75003fadc"></a>UartPortForDev_JoyConR&#160;</td><td class="fielddoc"><p>Joy-Con(R) </p>
</td></tr>
<tr><td class="fieldname"><a id="a3d7c3039360b3a4c66c0ef046ff18fd0a9e19d311de50b2efd04a630a6900b8c8" name="a3d7c3039360b3a4c66c0ef046ff18fd0a9e19d311de50b2efd04a630a6900b8c8"></a>UartPortForDev_JoyConL&#160;</td><td class="fielddoc"><p>Joy-Con(L) </p>
</td></tr>
<tr><td class="fieldname"><a id="a3d7c3039360b3a4c66c0ef046ff18fd0a82baa8c3f51c2ac522972e74e6a02b75" name="a3d7c3039360b3a4c66c0ef046ff18fd0a82baa8c3f51c2ac522972e74e6a02b75"></a>UartPortForDev_Bluetooth&#160;</td><td class="fielddoc"><p>Bluetooth. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a9246c70ff633ad7a6e634ab27a5a4ec1" name="a9246c70ff633ad7a6e634ab27a5a4ec1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9246c70ff633ad7a6e634ab27a5a4ec1">&#9670;&#160;</a></span>uartCreatePortSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartCreatePortSession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="structUartPortSession.html">UartPortSession</a>. </p>
<dl class="section note"><dt>Note</dt><dd>Use <a class="el" href="uart_8h.html#a14653d03d91d31cc64ccf291c7faaf5c">uartPortSessionOpenPort</a> or <a class="el" href="uart_8h.html#ae8bce74ab5ae513e3530424c43c6091c">uartPortSessionOpenPortForDev</a> before using any other cmds. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa278955a822631ce09aa9ac71a699e7d" name="aa278955a822631ce09aa9ac71a699e7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa278955a822631ce09aa9ac71a699e7d">&#9670;&#160;</a></span>uartHasPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartHasPort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>HasPort. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abf5b2156fef57ed8c4b551250d050625" name="abf5b2156fef57ed8c4b551250d050625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf5b2156fef57ed8c4b551250d050625">&#9670;&#160;</a></span>uartHasPortForDev()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartHasPortForDev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>HasPortForDev. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2079f1bc2b1061896139632c3385c5bf" name="a2079f1bc2b1061896139632c3385c5bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2079f1bc2b1061896139632c3385c5bf">&#9670;&#160;</a></span>uartIsSupportedBaudRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedBaudRate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>baud_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedBaudRate. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">baud_rate</td><td>BaudRate </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a00febeb633645a9b5f2a60f801496b51" name="a00febeb633645a9b5f2a60f801496b51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00febeb633645a9b5f2a60f801496b51">&#9670;&#160;</a></span>uartIsSupportedBaudRateForDev()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedBaudRateForDev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>baud_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedBaudRateForDev. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">baud_rate</td><td>BaudRate </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afc3f5ebd73c486a18c1c0057974d00c3" name="afc3f5ebd73c486a18c1c0057974d00c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc3f5ebd73c486a18c1c0057974d00c3">&#9670;&#160;</a></span>uartIsSupportedDeviceVariation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedDeviceVariation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>device_variation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedDeviceVariation. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [7.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">device_variation</td><td>DeviceVariation </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3a796ba56cb92824ed7002596938b96c" name="a3a796ba56cb92824ed7002596938b96c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a796ba56cb92824ed7002596938b96c">&#9670;&#160;</a></span>uartIsSupportedDeviceVariationForDev()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedDeviceVariationForDev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>device_variation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedDeviceVariationForDev. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [7.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">device_variation</td><td>DeviceVariation </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad3a991a09696fa49f220443c3647034c" name="ad3a991a09696fa49f220443c3647034c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3a991a09696fa49f220443c3647034c">&#9670;&#160;</a></span>uartIsSupportedFlowControlMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedFlowControlMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a>&#160;</td>
<td class="paramname"><em>flow_control_mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedFlowControlMode. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flow_control_mode</td><td><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aad14393fd12c33001635d4db4cb6cffc" name="aad14393fd12c33001635d4db4cb6cffc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad14393fd12c33001635d4db4cb6cffc">&#9670;&#160;</a></span>uartIsSupportedFlowControlModeForDev()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedFlowControlModeForDev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a>&#160;</td>
<td class="paramname"><em>flow_control_mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedFlowControlModeForDev. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flow_control_mode</td><td><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adef6a7c62f607569db4ac2d3b071b504" name="adef6a7c62f607569db4ac2d3b071b504"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adef6a7c62f607569db4ac2d3b071b504">&#9670;&#160;</a></span>uartIsSupportedPortEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedPortEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a>&#160;</td>
<td class="paramname"><em>port_event_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedPortEvent. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">port_event_type</td><td><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa62e3abca692d7b98a2c8a33dec8d93d" name="aa62e3abca692d7b98a2c8a33dec8d93d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa62e3abca692d7b98a2c8a33dec8d93d">&#9670;&#160;</a></span>uartIsSupportedPortEventForDev()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartIsSupportedPortEventForDev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a>&#160;</td>
<td class="paramname"><em>port_event_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>IsSupportedPortEventForDev. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [1.0.0-16.1.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">port_event_type</td><td><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a89211ef2da7a01bc58cdb3e4bd57fca6" name="a89211ef2da7a01bc58cdb3e4bd57fca6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89211ef2da7a01bc58cdb3e4bd57fca6">&#9670;&#160;</a></span>uartPortSessionBindPortEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionBindPortEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a>&#160;</td>
<td class="paramname"><em>port_event_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a>&#160;</td>
<td class="paramname"><em>threshold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structEvent.html">Event</a> *&#160;</td>
<td class="paramname"><em>out_event</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>BindPortEvent. </p>
<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> must be closed by the user after using <a class="el" href="uart_8h.html#a759cae24e32601242dfe2df0bf55a7bb">uartPortSessionUnbindPortEvent</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">port_event_type</td><td><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">threshold</td><td>Threshold </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_event</td><td>Output <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> with autoclear=false. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a95384edd81ad3d1d5d5a5b2971efe4de" name="a95384edd81ad3d1d5d5a5b2971efe4de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95384edd81ad3d1d5d5a5b2971efe4de">&#9670;&#160;</a></span>uartPortSessionClose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uartPortSessionClose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close an <a class="el" href="structUartPortSession.html">UartPortSession</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac33b0369c14cd8b0654543d83e8f4a58" name="ac33b0369c14cd8b0654543d83e8f4a58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac33b0369c14cd8b0654543d83e8f4a58">&#9670;&#160;</a></span>uartPortSessionGetReadableLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionGetReadableLength </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>GetReadableLength. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output ReadableLength. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa62ecb71cbeb1e045a9c3205a97cd575" name="aa62ecb71cbeb1e045a9c3205a97cd575"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa62ecb71cbeb1e045a9c3205a97cd575">&#9670;&#160;</a></span>uartPortSessionGetWritableLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionGetWritableLength </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>GetWritableLength. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output WritableLength. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a14653d03d91d31cc64ccf291c7faaf5c" name="a14653d03d91d31cc64ccf291c7faaf5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14653d03d91d31cc64ccf291c7faaf5c">&#9670;&#160;</a></span>uartPortSessionOpenPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionOpenPort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>baud_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a>&#160;</td>
<td class="paramname"><em>flow_control_mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>device_variation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_tx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_rx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_rts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_cts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>send_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>send_buffer_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>receive_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>receive_buffer_length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>OpenPort. </p>
<dl class="section note"><dt>Note</dt><dd>This is not usable when the specified <a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> is already being used. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a0ae332307ec2333bd3f1f22982c84848">UartPort</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">baud_rate</td><td>BaudRate </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flow_control_mode</td><td><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">device_variation</td><td>[7.0.0+] DeviceVariation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_tx</td><td>[6.0.0+] IsInvertTx </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_rx</td><td>[6.0.0+] IsInvertRx </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_rts</td><td>[6.0.0+] IsInvertRts </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_cts</td><td>[6.0.0+] IsInvertCts </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">send_buffer</td><td>Send buffer, must be 0x1000-byte aligned. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">send_buffer_length</td><td>Send buffer size, must be 0x1000-byte aligned. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">receive_buffer</td><td>Receive buffer, must be 0x1000-byte aligned. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">receive_buffer_length</td><td>Receive buffer size, must be 0x1000-byte aligned. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae8bce74ab5ae513e3530424c43c6091c" name="ae8bce74ab5ae513e3530424c43c6091c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8bce74ab5ae513e3530424c43c6091c">&#9670;&#160;</a></span>uartPortSessionOpenPortForDev()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionOpenPortForDev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a>&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>baud_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a>&#160;</td>
<td class="paramname"><em>flow_control_mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>device_variation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_tx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_rx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_rts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_invert_cts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>send_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>send_buffer_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>receive_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>receive_buffer_length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>OpenPortForDev. </p>
<dl class="section note"><dt>Note</dt><dd>See the notes for <a class="el" href="uart_8h.html#a14653d03d91d31cc64ccf291c7faaf5c">uartPortSessionOpenPort</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td><a class="el" href="uart_8h.html#a3d7c3039360b3a4c66c0ef046ff18fd0">UartPortForDev</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">baud_rate</td><td>BaudRate </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flow_control_mode</td><td><a class="el" href="uart_8h.html#a02ce1b54774c3ba4472f4ddcbecf71bd">UartFlowControlMode</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">device_variation</td><td>[7.0.0+] DeviceVariation </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_tx</td><td>[6.0.0+] IsInvertTx </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_rx</td><td>[6.0.0+] IsInvertRx </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_rts</td><td>[6.0.0+] IsInvertRts </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_invert_cts</td><td>[6.0.0+] IsInvertCts </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">send_buffer</td><td>Send buffer, must be 0x1000-byte aligned. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">send_buffer_length</td><td>Send buffer size, must be 0x1000-byte aligned. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">receive_buffer</td><td>Receive buffer, must be 0x1000-byte aligned. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">receive_buffer_length</td><td>Receive buffer size, must be 0x1000-byte aligned. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5b4922f7b63832aee2b82e961e2f24e3" name="a5b4922f7b63832aee2b82e961e2f24e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b4922f7b63832aee2b82e961e2f24e3">&#9670;&#160;</a></span>uartPortSessionReceive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionReceive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>out_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_data</td><td>Output data buffer. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Output data buffer size. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af3a5a82aa379ac26992fbf865b3f1885" name="af3a5a82aa379ac26992fbf865b3f1885"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3a5a82aa379ac26992fbf865b3f1885">&#9670;&#160;</a></span>uartPortSessionSend()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionSend </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>in_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">in_data</td><td>Input data buffer. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Input data buffer size. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a759cae24e32601242dfe2df0bf55a7bb" name="a759cae24e32601242dfe2df0bf55a7bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a759cae24e32601242dfe2df0bf55a7bb">&#9670;&#160;</a></span>uartPortSessionUnbindPortEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> uartPortSessionUnbindPortEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUartPortSession.html">UartPortSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a>&#160;</td>
<td class="paramname"><em>port_event_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>UnbindPortEvent. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td><a class="el" href="structUartPortSession.html">UartPortSession</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">port_event_type</td><td><a class="el" href="uart_8h.html#ac3a8d70f64844b2c8c7d0f20a8d7adb6">UartPortEventType</a> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Output success flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink