157 lines
14 KiB
HTML
157 lines
14 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: pkg/drivers-frst/uart/include/uart_apb.h Source File</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('uart__apb_8h_source.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">uart_apb.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (C) 2017, 2019, 2023-2024 Kernkonzept GmbH.</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Author(s): Georg Kotheimer <georg.kotheimer@kernkonzept.com></span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "uart_base.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4.html">L4</a> {</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span></div>
|
|
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html"> 17</a></span><span class="keyword">class </span><a class="code hl_function" href="classL4_1_1Uart__apb.html#a9abdedd1c9f64891bd8aefd69c17124a">Uart_apb</a> : <span class="keyword">public</span> Uart</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#a9abdedd1c9f64891bd8aefd69c17124a"> 21</a></span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#a9abdedd1c9f64891bd8aefd69c17124a">Uart_apb</a>(<span class="keywordtype">unsigned</span> freq) : _freq(freq) {}</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#a6477cf1e4ce03615dffad08b8bed0dfd"> 22</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#a6477cf1e4ce03615dffad08b8bed0dfd">startup</a>(Io_register_block <span class="keyword">const</span> *) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#afaf1d13288de75b9f19ac946f86006cc"> 23</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#afaf1d13288de75b9f19ac946f86006cc">shutdown</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#aea2ca3bc001d527837f5af2f63ba9d21"> 24</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#aea2ca3bc001d527837f5af2f63ba9d21">change_mode</a>(Transfer_mode m, Baud_rate r) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">int</span> tx_avail() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">void</span> wait_tx_done() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> out_char(<span class="keywordtype">char</span> c) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#ab57dc1ee3bf83e3bd1754d815280e9e4"> 28</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#ab57dc1ee3bf83e3bd1754d815280e9e4">write</a>(<span class="keywordtype">char</span> <span class="keyword">const</span> *s, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> count,</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">bool</span> blocking = <span class="keyword">true</span>) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#a5060273730b9d4a27a9432e3225f3077"> 31</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#a5060273730b9d4a27a9432e3225f3077">enable_rx_irq</a>(<span class="keywordtype">bool</span> enable) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#aa61b08fb092349740c445c05a0837402"> 32</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#aa61b08fb092349740c445c05a0837402">char_avail</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classL4_1_1Uart__apb.html#a906c9426f0e5b16fc1f196f376bd2236"> 33</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classL4_1_1Uart__apb.html#a906c9426f0e5b16fc1f196f376bd2236">get_char</a>(<span class="keywordtype">bool</span> blocking = <span class="keyword">true</span>) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> set_rate(Baud_rate r);</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">unsigned</span> _freq;</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>} <span class="comment">// namespace L4</span></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_a5060273730b9d4a27a9432e3225f3077"><div class="ttname"><a href="classL4_1_1Uart__apb.html#a5060273730b9d4a27a9432e3225f3077">L4::Uart_apb::enable_rx_irq</a></div><div class="ttdeci">bool enable_rx_irq(bool enable) override</div><div class="ttdoc">Enable the receive IRQ.</div></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_a6477cf1e4ce03615dffad08b8bed0dfd"><div class="ttname"><a href="classL4_1_1Uart__apb.html#a6477cf1e4ce03615dffad08b8bed0dfd">L4::Uart_apb::startup</a></div><div class="ttdeci">bool startup(Io_register_block const *) override</div><div class="ttdoc">Start the UART driver.</div></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_a906c9426f0e5b16fc1f196f376bd2236"><div class="ttname"><a href="classL4_1_1Uart__apb.html#a906c9426f0e5b16fc1f196f376bd2236">L4::Uart_apb::get_char</a></div><div class="ttdeci">int get_char(bool blocking=true) const override</div><div class="ttdoc">Read a character from the UART.</div></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_a9abdedd1c9f64891bd8aefd69c17124a"><div class="ttname"><a href="classL4_1_1Uart__apb.html#a9abdedd1c9f64891bd8aefd69c17124a">L4::Uart_apb::Uart_apb</a></div><div class="ttdeci">Uart_apb(unsigned freq)</div><div class="ttdoc">freq == 0 means unknown and don't change baud rate</div><div class="ttdef"><b>Definition</b> <a href="#l00021">uart_apb.h:21</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_aa61b08fb092349740c445c05a0837402"><div class="ttname"><a href="classL4_1_1Uart__apb.html#aa61b08fb092349740c445c05a0837402">L4::Uart_apb::char_avail</a></div><div class="ttdeci">int char_avail() const override</div><div class="ttdoc">Check if there is at least one character available for reading from the UART.</div></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_ab57dc1ee3bf83e3bd1754d815280e9e4"><div class="ttname"><a href="classL4_1_1Uart__apb.html#ab57dc1ee3bf83e3bd1754d815280e9e4">L4::Uart_apb::write</a></div><div class="ttdeci">int write(char const *s, unsigned long count, bool blocking=true) const override</div><div class="ttdoc">Transmit a number of characters.</div></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_aea2ca3bc001d527837f5af2f63ba9d21"><div class="ttname"><a href="classL4_1_1Uart__apb.html#aea2ca3bc001d527837f5af2f63ba9d21">L4::Uart_apb::change_mode</a></div><div class="ttdeci">bool change_mode(Transfer_mode m, Baud_rate r) override</div><div class="ttdoc">Set certain parameters of the UART.</div></div>
|
|
<div class="ttc" id="aclassL4_1_1Uart__apb_html_afaf1d13288de75b9f19ac946f86006cc"><div class="ttname"><a href="classL4_1_1Uart__apb.html#afaf1d13288de75b9f19ac946f86006cc">L4::Uart_apb::shutdown</a></div><div class="ttdeci">void shutdown() override</div><div class="ttdoc">Terminate the UART driver.</div></div>
|
|
<div class="ttc" id="anamespaceL4_html"><div class="ttname"><a href="namespaceL4.html">L4</a></div><div class="ttdoc">L4 low-level kernel interface.</div><div class="ttdef"><b>Definition</b> <a href="l4sys-l4f-groups_8dox_source.html#l00050">l4sys-l4f-groups.dox:50</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</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"><b>pkg</b></li><li class="navelem"><b>drivers-frst</b></li><li class="navelem"><b>uart</b></li><li class="navelem"><b>include</b></li><li class="navelem"><b>uart_apb.h</b></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>
|