562 lines
28 KiB
HTML
562 lines
28 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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">
|
|
<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.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: L4::Uart Class 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.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="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></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">
|
|
$(function(){initNavTree('classL4_1_1Uart.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<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)">
|
|
</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 class="header">
|
|
<div class="headertitle"><div class="title">L4::Uart Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classL4_1_1Uart.html" title="Uart driver abstraction.">Uart</a> driver abstraction.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="uart__base_8h_source.html">uart_base.h</a>></code></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for L4::Uart:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4_1_1Uart__inherit__graph.svg" width="140" height="530"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for L4::Uart:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4_1_1Uart__coll__graph.svg" width="140" height="276"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:acc5eb31138d00f87b3b7944cdae93b04" id="r_acc5eb31138d00f87b3b7944cdae93b04"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#acc5eb31138d00f87b3b7944cdae93b04">startup</a> (Io_register_block const *regs)=0</td></tr>
|
|
<tr class="memdesc:acc5eb31138d00f87b3b7944cdae93b04"><td class="mdescLeft"> </td><td class="mdescRight">Start the UART driver. <br /></td></tr>
|
|
<tr class="memitem:a4e88a8c8695bd7903ac37a7d3f75e207" id="r_a4e88a8c8695bd7903ac37a7d3f75e207"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e88a8c8695bd7903ac37a7d3f75e207">shutdown</a> ()=0</td></tr>
|
|
<tr class="memdesc:a4e88a8c8695bd7903ac37a7d3f75e207"><td class="mdescLeft"> </td><td class="mdescRight">Terminate the UART driver. <br /></td></tr>
|
|
<tr class="memitem:ac70a395c14b85b77b9d824c54e005bdb" id="r_ac70a395c14b85b77b9d824c54e005bdb"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac70a395c14b85b77b9d824c54e005bdb">change_mode</a> (Transfer_mode m, Baud_rate r)=0</td></tr>
|
|
<tr class="memdesc:ac70a395c14b85b77b9d824c54e005bdb"><td class="mdescLeft"> </td><td class="mdescRight">Set certain parameters of the UART. <br /></td></tr>
|
|
<tr class="memitem:a1080fa44a12850cd38c7eb851eb74f6f" id="r_a1080fa44a12850cd38c7eb851eb74f6f"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1080fa44a12850cd38c7eb851eb74f6f">write</a> (char const *s, unsigned long count, bool blocking=true) const =0</td></tr>
|
|
<tr class="memdesc:a1080fa44a12850cd38c7eb851eb74f6f"><td class="mdescLeft"> </td><td class="mdescRight">Transmit a number of characters. <br /></td></tr>
|
|
<tr class="memitem:afb3b03d44d8f32d5d90d01bba89c0760" id="r_afb3b03d44d8f32d5d90d01bba89c0760"><td class="memItemLeft" align="right" valign="top">Transfer_mode </td><td class="memItemRight" valign="bottom"><a class="el" href="#afb3b03d44d8f32d5d90d01bba89c0760">mode</a> () const</td></tr>
|
|
<tr class="memdesc:afb3b03d44d8f32d5d90d01bba89c0760"><td class="mdescLeft"> </td><td class="mdescRight">Return the transfer mode. <br /></td></tr>
|
|
<tr class="memitem:a86a4f246ca4c5f0ef1d4720d27bfd52c" id="r_a86a4f246ca4c5f0ef1d4720d27bfd52c"><td class="memItemLeft" align="right" valign="top">Baud_rate </td><td class="memItemRight" valign="bottom"><a class="el" href="#a86a4f246ca4c5f0ef1d4720d27bfd52c">rate</a> () const</td></tr>
|
|
<tr class="memdesc:a86a4f246ca4c5f0ef1d4720d27bfd52c"><td class="mdescLeft"> </td><td class="mdescRight">Return the baud rate. <br /></td></tr>
|
|
<tr class="memitem:af141560f01c73565fcaa38bda79105b7" id="r_af141560f01c73565fcaa38bda79105b7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#af141560f01c73565fcaa38bda79105b7">enable_rx_irq</a> (bool=true)</td></tr>
|
|
<tr class="memdesc:af141560f01c73565fcaa38bda79105b7"><td class="mdescLeft"> </td><td class="mdescRight">Enable the receive IRQ. <br /></td></tr>
|
|
<tr class="memitem:a0f7c45243d84a69dcb4e58c80fc34491" id="r_a0f7c45243d84a69dcb4e58c80fc34491"><td class="memItemLeft" align="right" valign="top"><a id="a0f7c45243d84a69dcb4e58c80fc34491" name="a0f7c45243d84a69dcb4e58c80fc34491"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>irq_ack</b> ()</td></tr>
|
|
<tr class="memdesc:a0f7c45243d84a69dcb4e58c80fc34491"><td class="mdescLeft"> </td><td class="mdescRight">Acknowledge a received interrupt. <br /></td></tr>
|
|
<tr class="memitem:aa44d60597fcc30a084bd4491075210c6" id="r_aa44d60597fcc30a084bd4491075210c6"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa44d60597fcc30a084bd4491075210c6">char_avail</a> () const =0</td></tr>
|
|
<tr class="memdesc:aa44d60597fcc30a084bd4491075210c6"><td class="mdescLeft"> </td><td class="mdescRight">Check if there is at least one character available for reading from the UART. <br /></td></tr>
|
|
<tr class="memitem:af213c9429844ea7713be765513619902" id="r_af213c9429844ea7713be765513619902"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="#af213c9429844ea7713be765513619902">get_char</a> (bool blocking=true) const =0</td></tr>
|
|
<tr class="memdesc:af213c9429844ea7713be765513619902"><td class="mdescLeft"> </td><td class="mdescRight">Read a character from the UART. <br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pro-methods" class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a1cef9f55c568d5197d1b676e34c4bfd2" id="r_a1cef9f55c568d5197d1b676e34c4bfd2"><td class="memTemplParams" colspan="2">template<typename Uart_driver, bool Timeout_guard = true> </td></tr>
|
|
<tr class="memitem:a1cef9f55c568d5197d1b676e34c4bfd2 template"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1cef9f55c568d5197d1b676e34c4bfd2">generic_write</a> (char const *s, unsigned long count, bool blocking=true) const</td></tr>
|
|
<tr class="memdesc:a1cef9f55c568d5197d1b676e34c4bfd2"><td class="mdescLeft"> </td><td class="mdescRight">Internal function transmitting each character one-after-another and finally waiting that the transmission did actually finish. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classL4_1_1Uart.html" title="Uart driver abstraction.">Uart</a> driver abstraction. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="uart__base_8h_source.html#l00020">20</a> of file <a class="el" href="uart__base_8h_source.html">uart_base.h</a>.</p>
|
|
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac70a395c14b85b77b9d824c54e005bdb" name="ac70a395c14b85b77b9d824c54e005bdb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac70a395c14b85b77b9d824c54e005bdb">◆ </a></span>change_mode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool L4::Uart::change_mode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Transfer_mode</td> <td class="paramname"><span class="paramname"><em>m</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Baud_rate</td> <td class="paramname"><span class="paramname"><em>r</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set certain parameters of the UART. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">m</td><td>UART mode. Depends on the hardware. </td></tr>
|
|
<tr><td class="paramname">r</td><td>Baud rate. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">true</td><td>Mode setting succeeded (or was not performed at all). </td></tr>
|
|
<tr><td class="paramname">false</td><td>Mode setting failed for some reason.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Some drivers don't perform any mode setting at all and just return true. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classL4_1_1Uart__apb.html#aea2ca3bc001d527837f5af2f63ba9d21">L4::Uart_apb</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa44d60597fcc30a084bd4491075210c6" name="aa44d60597fcc30a084bd4491075210c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa44d60597fcc30a084bd4491075210c6">◆ </a></span>char_avail()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int L4::Uart::char_avail </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if there is at least one character available for reading from the UART. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if there is no character available for reading, !=0 otherwise. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classL4_1_1Uart__apb.html#aa61b08fb092349740c445c05a0837402">L4::Uart_apb</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af141560f01c73565fcaa38bda79105b7" name="af141560f01c73565fcaa38bda79105b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af141560f01c73565fcaa38bda79105b7">◆ </a></span>enable_rx_irq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool L4::Uart::enable_rx_irq </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable the receive IRQ. </p>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">true</td><td>The RX IRQ was successfully enabled / disabled. </td></tr>
|
|
<tr><td class="paramname">false</td><td>The RX IRQ couldn't be enabled / disabled. The driver does not support this operation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classL4_1_1Uart__apb.html#a5060273730b9d4a27a9432e3225f3077">L4::Uart_apb</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="uart__base_8h_source.html#l00103">103</a> of file <a class="el" href="uart__base_8h_source.html">uart_base.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1cef9f55c568d5197d1b676e34c4bfd2" name="a1cef9f55c568d5197d1b676e34c4bfd2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1cef9f55c568d5197d1b676e34c4bfd2">◆ </a></span>generic_write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Uart_driver, bool Timeout_guard = true> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L4::Uart::generic_write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>s</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>count</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>blocking</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel protected">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Internal function transmitting each character one-after-another and finally waiting that the transmission did actually finish. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">s</td><td><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> containing the characters. </td></tr>
|
|
<tr><td class="paramname">count</td><td>The number of characters to transmit. </td></tr>
|
|
<tr><td class="paramname">blocking</td><td>If true, wait until there is space in the transmit buffer and also wait until every character was successful transmitted. Otherwise do not wait. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of successful written characters. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="uart__base_8h_source.html#l00141">141</a> of file <a class="el" href="uart__base_8h_source.html">uart_base.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="poll__timeout__counter_8h_source.html#l00061">L4::Poll_timeout_counter::test()</a>.</p>
|
|
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
|
|
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classL4_1_1Uart_a1cef9f55c568d5197d1b676e34c4bfd2_cgraph.svg" width="411" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af213c9429844ea7713be765513619902" name="af213c9429844ea7713be765513619902"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af213c9429844ea7713be765513619902">◆ </a></span>get_char()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int L4::Uart::get_char </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>blocking</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read a character from the UART. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">blocking</td><td>If true, wait until a character is available for reading. Otherwise do not wait and just return -1 if no character is available. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The actual character read from the UART. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classL4_1_1Uart__apb.html#a906c9426f0e5b16fc1f196f376bd2236">L4::Uart_apb</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb3b03d44d8f32d5d90d01bba89c0760" name="afb3b03d44d8f32d5d90d01bba89c0760"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb3b03d44d8f32d5d90d01bba89c0760">◆ </a></span>mode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Transfer_mode L4::Uart::mode </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the transfer mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The transfer mode. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="uart__base_8h_source.html#l00086">86</a> of file <a class="el" href="uart__base_8h_source.html">uart_base.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86a4f246ca4c5f0ef1d4720d27bfd52c" name="a86a4f246ca4c5f0ef1d4720d27bfd52c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86a4f246ca4c5f0ef1d4720d27bfd52c">◆ </a></span>rate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Baud_rate L4::Uart::rate </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the baud rate. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The baud rate. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="uart__base_8h_source.html#l00093">93</a> of file <a class="el" href="uart__base_8h_source.html">uart_base.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e88a8c8695bd7903ac37a7d3f75e207" name="a4e88a8c8695bd7903ac37a7d3f75e207"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e88a8c8695bd7903ac37a7d3f75e207">◆ </a></span>shutdown()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void L4::Uart::shutdown </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminate the UART driver. </p>
|
|
<p>This includes disabling of interrupts. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classL4_1_1Uart__apb.html#afaf1d13288de75b9f19ac946f86006cc">L4::Uart_apb</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acc5eb31138d00f87b3b7944cdae93b04" name="acc5eb31138d00f87b3b7944cdae93b04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc5eb31138d00f87b3b7944cdae93b04">◆ </a></span>startup()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool L4::Uart::startup </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Io_register_block const *</td> <td class="paramname"><span class="paramname"><em>regs</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start the UART driver. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">regs</td><td>IO register block of the UART. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">true</td><td>Startup succeeded. </td></tr>
|
|
<tr><td class="paramname">false</td><td>Startup failed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classL4_1_1Uart__apb.html#a6477cf1e4ce03615dffad08b8bed0dfd">L4::Uart_apb</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1080fa44a12850cd38c7eb851eb74f6f" name="a1080fa44a12850cd38c7eb851eb74f6f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1080fa44a12850cd38c7eb851eb74f6f">◆ </a></span>write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int L4::Uart::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>s</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>count</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>blocking</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Transmit a number of characters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">s</td><td><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> containing the characters. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Number of characters to transmit. </td></tr>
|
|
<tr><td class="paramname">blocking</td><td>If true, wait until there is space in the transmit buffer and also wait until every character was successful transmitted. Otherwise do not wait. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of successfully written characters. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classL4_1_1Uart__apb.html#ab57dc1ee3bf83e3bd1754d815280e9e4">L4::Uart_apb</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>pkg/drivers-frst/uart/include/<a class="el" href="uart__base_8h_source.html">uart_base.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="namespaceL4.html">L4</a></li><li class="navelem"><a href="classL4_1_1Uart.html">Uart</a></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|