teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

l4re-base-25.08.0

Browse Source
This commit is contained in:
Viktor Reusch
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

278
doc/source/html/io_8h.html Normal file
View File

@@ -0,0 +1,278 @@
<!-- 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: contrib/libio-io/l4/io/io.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="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('io_8h.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">io.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="compiler_8h_source.html">l4/sys/compiler.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.h</a>&gt;</code><br />
<code>#include &lt;l4/sys/linkage.h&gt;</code><br />
<code>#include &lt;l4/io/types.h&gt;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Include dependency graph for io.h:</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="io_8h__incl.svg" width="644" height="491"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="io_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae5d97c62f824acf7d7b8572dac1a122b" id="r_ae5d97c62f824acf7d7b8572dac1a122b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5d97c62f824acf7d7b8572dac1a122b">l4io_request_icu</a> (void)</td></tr>
<tr class="memdesc:ae5d97c62f824acf7d7b8572dac1a122b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the ICU object of the client. <br /></td></tr>
<tr class="memitem:ga5a5ac16d0a8a479a864027900e4f3374" id="r_ga5a5ac16d0a8a479a864027900e4f3374"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#ga5a5ac16d0a8a479a864027900e4f3374">l4io_request_iomem</a> (<a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> phys, unsigned long size, int flags, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> *virt)</td></tr>
<tr class="memdesc:ga5a5ac16d0a8a479a864027900e4f3374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an IO memory region. <br /></td></tr>
<tr class="memitem:gaee2262febf0fdc1619cabb1091ed6936" id="r_gaee2262febf0fdc1619cabb1091ed6936"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#gaee2262febf0fdc1619cabb1091ed6936">l4io_request_iomem_region</a> (<a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> phys, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> virt, unsigned long size, int flags)</td></tr>
<tr class="memdesc:gaee2262febf0fdc1619cabb1091ed6936"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an IO memory region and map it to a specified region. <br /></td></tr>
<tr class="memitem:ga53ec000ff724338cf0caf5cc8eaf9847" id="r_ga53ec000ff724338cf0caf5cc8eaf9847"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#ga53ec000ff724338cf0caf5cc8eaf9847">l4io_release_iomem</a> (<a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> virt, unsigned long size)</td></tr>
<tr class="memdesc:ga53ec000ff724338cf0caf5cc8eaf9847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release an IO memory region. <br /></td></tr>
<tr class="memitem:ga4157f860899b502fa9679797a0a513b6" id="r_ga4157f860899b502fa9679797a0a513b6"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#ga4157f860899b502fa9679797a0a513b6">l4io_request_ioport</a> (unsigned portnum, unsigned len)</td></tr>
<tr class="memdesc:ga4157f860899b502fa9679797a0a513b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an IO port region. <br /></td></tr>
<tr class="memitem:ga7b69f6794cd08221f1725db7660a6646" id="r_ga7b69f6794cd08221f1725db7660a6646"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#ga7b69f6794cd08221f1725db7660a6646">l4io_release_ioport</a> (unsigned portnum, unsigned len)</td></tr>
<tr class="memdesc:ga7b69f6794cd08221f1725db7660a6646"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release an IO port region. <br /></td></tr>
<tr class="memitem:ad8f22376fafcdfed90c94f4f58e38da9" id="r_ad8f22376fafcdfed90c94f4f58e38da9"><td class="memItemLeft" align="right" valign="top">l4io_device_handle_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad8f22376fafcdfed90c94f4f58e38da9">l4io_get_root_device</a> (void)</td></tr>
<tr class="memdesc:ad8f22376fafcdfed90c94f4f58e38da9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get root device handle of the device bus. <br /></td></tr>
<tr class="memitem:ae8dc887d2eb9fb31cc7d2008fd23e9e7" id="r_ae8dc887d2eb9fb31cc7d2008fd23e9e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8dc887d2eb9fb31cc7d2008fd23e9e7">l4io_iterate_devices</a> (l4io_device_handle_t *devhandle, <a class="el" href="group__api__l4io.html#gad0f2866fa8c00afd55565cc4495093f7">l4io_device_t</a> *dev, l4io_resource_handle_t *reshandle)</td></tr>
<tr class="memdesc:ae8dc887d2eb9fb31cc7d2008fd23e9e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate over the device bus. <br /></td></tr>
<tr class="memitem:gaa127162dc0e8edd5e09c4ef1abfd12d2" id="r_gaa127162dc0e8edd5e09c4ef1abfd12d2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#gaa127162dc0e8edd5e09c4ef1abfd12d2">l4io_lookup_device</a> (const char *devname, l4io_device_handle_t *dev_handle, <a class="el" href="group__api__l4io.html#gad0f2866fa8c00afd55565cc4495093f7">l4io_device_t</a> *dev, l4io_resource_handle_t *res_handle)</td></tr>
<tr class="memdesc:gaa127162dc0e8edd5e09c4ef1abfd12d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a device by name. <br /></td></tr>
<tr class="memitem:ga74ad87dcf2e70388651b23c7d51d3ed1" id="r_ga74ad87dcf2e70388651b23c7d51d3ed1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#ga74ad87dcf2e70388651b23c7d51d3ed1">l4io_lookup_resource</a> (l4io_device_handle_t devhandle, enum <a class="el" href="group__api__l4io.html#gacf9118b0abd79afae218d87c3998706e">l4io_resource_types_t</a> type, l4io_resource_handle_t *reshandle, <a class="el" href="group__api__l4io.html#ga670971c40db8bf19d59ec27554c16846">l4io_resource_t</a> *res)</td></tr>
<tr class="memdesc:ga74ad87dcf2e70388651b23c7d51d3ed1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request a specific resource from a device description. <br /></td></tr>
<tr class="memitem:gac2ec7fad588b7d3d64090651aff6fd50" id="r_gac2ec7fad588b7d3d64090651aff6fd50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#gac2ec7fad588b7d3d64090651aff6fd50">l4io_request_resource_iomem</a> (l4io_device_handle_t devhandle, l4io_resource_handle_t *reshandle)</td></tr>
<tr class="memdesc:gac2ec7fad588b7d3d64090651aff6fd50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request IO memory. <br /></td></tr>
<tr class="memitem:ad9a75cbf4ecca278279a4d5a7e4b9e93" id="r_ad9a75cbf4ecca278279a4d5a7e4b9e93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad9a75cbf4ecca278279a4d5a7e4b9e93">l4io_request_all_ioports</a> (void(*res_cb)(<a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> const *res))</td></tr>
<tr class="memdesc:ad9a75cbf4ecca278279a4d5a7e4b9e93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request all available IO-port resources. <br /></td></tr>
<tr class="memitem:gaa1c8b03a2c57a4365f0cf366549e6ed9" id="r_gaa1c8b03a2c57a4365f0cf366549e6ed9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4io.html#gaa1c8b03a2c57a4365f0cf366549e6ed9">l4io_has_resource</a> (enum <a class="el" href="group__api__l4io.html#gacf9118b0abd79afae218d87c3998706e">l4io_resource_types_t</a> type, <a class="el" href="vbus__types_8h.html#ad8368693052dd0e492223f4751c48ca1">l4vbus_paddr_t</a> start, <a class="el" href="vbus__types_8h.html#ad8368693052dd0e492223f4751c48ca1">l4vbus_paddr_t</a> end)</td></tr>
<tr class="memdesc:gaa1c8b03a2c57a4365f0cf366549e6ed9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a resource is available. <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="ad8f22376fafcdfed90c94f4f58e38da9" name="ad8f22376fafcdfed90c94f4f58e38da9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8f22376fafcdfed90c94f4f58e38da9">&#9670;&#160;</a></span>l4io_get_root_device()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">l4io_device_handle_t l4io_get_root_device </td>
<td>(</td>
<td class="paramtype">void</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 inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get root device handle of the device bus. </p>
<dl class="section return"><dt>Returns</dt><dd>root device handle </dd></dl>
<p class="definition">Definition at line <a class="el" href="io_8h_source.html#l00257">257</a> of file <a class="el" href="io_8h_source.html">io.h</a>.</p>
</div>
</div>
<a id="ae8dc887d2eb9fb31cc7d2008fd23e9e7" name="ae8dc887d2eb9fb31cc7d2008fd23e9e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8dc887d2eb9fb31cc7d2008fd23e9e7">&#9670;&#160;</a></span>l4io_iterate_devices()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4io_iterate_devices </td>
<td>(</td>
<td class="paramtype">l4io_device_handle_t *</td> <td class="paramname"><span class="paramname"><em>devhandle</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__api__l4io.html#gad0f2866fa8c00afd55565cc4495093f7">l4io_device_t</a> *</td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4io_resource_handle_t *</td> <td class="paramname"><span class="paramname"><em>reshandle</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterate over the device bus. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">devhandle</td><td>Device handle to start iterating at. The next device handle is returned here. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dev</td><td>Device information, may be NULL. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">reshandle</td><td>Resource handle.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error code otherwise </dd></dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, and <a class="el" href="compiler_8h_source.html#l00214">L4_EXPORT</a>.</p>
</div>
</div>
<a id="ad9a75cbf4ecca278279a4d5a7e4b9e93" name="ad9a75cbf4ecca278279a4d5a7e4b9e93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9a75cbf4ecca278279a4d5a7e4b9e93">&#9670;&#160;</a></span>l4io_request_all_ioports()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void l4io_request_all_ioports </td>
<td>(</td>
<td class="paramtype">void(*</td> <td class="paramname"><span class="paramname"><em>res_cb&#160;</em></span>)(<a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> const *res)</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request all available IO-port resources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">res_cb</td><td>Callback function called for every port resource found, give NULL for no callback. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, and <a class="el" href="compiler_8h_source.html#l00214">L4_EXPORT</a>.</p>
</div>
</div>
<a id="ae5d97c62f824acf7d7b8572dac1a122b" name="ae5d97c62f824acf7d7b8572dac1a122b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5d97c62f824acf7d7b8572dac1a122b">&#9670;&#160;</a></span>l4io_request_icu()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> l4io_request_icu </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request the ICU object of the client. </p>
<dl class="section return"><dt>Returns</dt><dd>Client ICU object, an invalid capability selector is returned if no ICU is available. </dd></dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, and <a class="el" href="compiler_8h_source.html#l00214">L4_EXPORT</a>.</p>
</div>
</div>
</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"><b>contrib</b></li><li class="navelem"><b>libio-io</b></li><li class="navelem"><b>l4</b></li><li class="navelem"><b>io</b></li><li class="navelem"><a href="io_8h.html">io.h</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>