173 lines
19 KiB
HTML
173 lines
19 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/re/mmio_space 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('mmio__space_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">mmio_space</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="mmio__space.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// -*- Mode: C++ -*-</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// vim:ft=cpp</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Copyright (C) 2017-2018, 2022, 2024 Kernkonzept GmbH.</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Author(s): Sarah Hoffmann <sarah.hoffmann@kernkonzept.com></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="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include <<a class="code" href="protocols_8h.html">l4/re/protocols.h</a>></span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include <<a class="code" href="capability.html">l4/sys/capability</a>></span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include <<a class="code" href="ipc__types.html">l4/sys/cxx/ipc_types</a>></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include <<a class="code" href="ipc__iface.html">l4/sys/cxx/ipc_iface</a>></span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4Re.html">L4Re</a></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
|
|
<div class="foldopen" id="foldopen00045" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html"> 45</a></span><span class="keyword">struct </span><a class="code hl_define" href="group__l4sys__defines.html#ga63e7f1ab50a1b3049bdd0a34e97423c2">L4_EXPORT</a> <a class="code hl_struct" href="structL4Re_1_1Mmio__space.html">Mmio_space</a></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>: <span class="keyword">public</span> <a class="code hl_class" href="classL4_1_1Kobject__t.html">L4::Kobject_t</a><Mmio_space, L4::Kobject, L4RE_PROTO_MMIO_SPACE></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>{</div>
|
|
<div class="foldopen" id="foldopen00049" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7"> 49</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7">Access_width</a></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> {</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1f1fb483db99f182cbf5c010050dd89b"> 51</a></span> <a class="code hl_enumvalue" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1f1fb483db99f182cbf5c010050dd89b">Wd_8bit</a> = 0, </div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1250c3658a92c482f4c72a8894a71d61"> 52</a></span> <a class="code hl_enumvalue" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1250c3658a92c482f4c72a8894a71d61">Wd_16bit</a> = 1, </div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1bcc475a11de577ac42baaca09865673"> 53</a></span> <a class="code hl_enumvalue" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1bcc475a11de577ac42baaca09865673">Wd_32bit</a> = 2, </div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a0b5599ce8761a8a388a24cc669770309"> 54</a></span> <a class="code hl_enumvalue" href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a0b5599ce8761a8a388a24cc669770309">Wd_64bit</a> = 3 </div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#a2ed4971f8ec0be1b5a542fd1f0691a01"> 58</a></span> <span class="keyword">typedef</span> <a class="code hl_typedef" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a> <a class="code hl_typedef" href="structL4Re_1_1Mmio__space.html#a2ed4971f8ec0be1b5a542fd1f0691a01">Addr</a>;</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#abcd7f35633be3f71b2cf2a2162e7f0eb"> 74</a></span> <a class="code hl_define" href="ipc__iface.html#a5772eb61b611f8f17bbc89e02e534ca1">L4_INLINE_RPC</a>(<span class="keywordtype">long</span>, <a class="code hl_function" href="structL4Re_1_1Mmio__space.html#abcd7f35633be3f71b2cf2a2162e7f0eb">mmio_read</a>, (<a class="code hl_typedef" href="structL4Re_1_1Mmio__space.html#a2ed4971f8ec0be1b5a542fd1f0691a01">Addr</a> addr, <span class="keywordtype">char</span> width, <a class="code hl_typedef" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a> *value));</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span></div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="structL4Re_1_1Mmio__space.html#a3b808dbe1e4db25b368fce4c46422640"> 90</a></span> <a class="code hl_define" href="ipc__iface.html#a5772eb61b611f8f17bbc89e02e534ca1">L4_INLINE_RPC</a>(<span class="keywordtype">long</span>, <a class="code hl_function" href="structL4Re_1_1Mmio__space.html#a3b808dbe1e4db25b368fce4c46422640">mmio_write</a>, (<a class="code hl_typedef" href="structL4Re_1_1Mmio__space.html#a2ed4971f8ec0be1b5a542fd1f0691a01">Addr</a> addr, <span class="keywordtype">char</span> width, <a class="code hl_typedef" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a> value));</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">typedef</span> <a class="code hl_struct" href="structL4_1_1Typeid_1_1Rpcs.html">L4::Typeid::Rpcs<mmio_read_t, mmio_write_t></a> Rpcs;</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>}</div>
|
|
<div class="ttc" id="acapability_html"><div class="ttname"><a href="capability.html">capability</a></div><div class="ttdoc">L4::Cap related definitions.</div></div>
|
|
<div class="ttc" id="aclassL4_1_1Kobject__t_html"><div class="ttname"><a href="classL4_1_1Kobject__t.html">L4::Kobject_t</a></div><div class="ttdoc">Helper class to create an L4Re interface class that is derived from a single base class.</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00749">__typeinfo.h:750</a></div></div>
|
|
<div class="ttc" id="agroup__l4__basic__types_html_gaf3331c485014bd12a9e4f9d27a55e689"><div class="ttname"><a href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a></div><div class="ttdeci">unsigned long long l4_uint64_t</div><div class="ttdoc">Unsigned 64bit value.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2l4int_8h_source.html#l00031">l4int.h:31</a></div></div>
|
|
<div class="ttc" id="agroup__l4sys__defines_html_ga63e7f1ab50a1b3049bdd0a34e97423c2"><div class="ttname"><a href="group__l4sys__defines.html#ga63e7f1ab50a1b3049bdd0a34e97423c2">L4_EXPORT</a></div><div class="ttdeci">#define L4_EXPORT</div><div class="ttdoc">Attribute to mark functions, variables, and data types as being exported from a library.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00214">compiler.h:214</a></div></div>
|
|
<div class="ttc" id="aipc__iface_html"><div class="ttname"><a href="ipc__iface.html">ipc_iface</a></div><div class="ttdoc">Interface Definition Language.</div></div>
|
|
<div class="ttc" id="aipc__iface_html_a5772eb61b611f8f17bbc89e02e534ca1"><div class="ttname"><a href="ipc__iface.html#a5772eb61b611f8f17bbc89e02e534ca1">L4_INLINE_RPC</a></div><div class="ttdeci">#define L4_INLINE_RPC(res, name, args, attr...)</div><div class="ttdoc">Define an inline RPC call (type and callable).</div><div class="ttdef"><b>Definition</b> <a href="ipc__iface_source.html#l00482">ipc_iface:482</a></div></div>
|
|
<div class="ttc" id="aipc__types_html"><div class="ttname"><a href="ipc__types.html">ipc_types</a></div></div>
|
|
<div class="ttc" id="anamespaceL4Re_html"><div class="ttname"><a href="namespaceL4Re.html">L4Re</a></div><div class="ttdoc">L4Re C++ Interfaces.</div><div class="ttdef"><b>Definition</b> <a href="cmd__control_source.html#l00014">cmd_control:14</a></div></div>
|
|
<div class="ttc" id="aprotocols_8h_html"><div class="ttname"><a href="protocols_8h.html">protocols.h</a></div><div class="ttdoc">L4Re Protocol Constants (C version).</div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html">L4Re::Mmio_space</a></div><div class="ttdoc">Interface for memory-like address space accessible via IPC.</div><div class="ttdef"><b>Definition</b> <a href="#l00045">mmio_space:47</a></div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_a2ed4971f8ec0be1b5a542fd1f0691a01"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#a2ed4971f8ec0be1b5a542fd1f0691a01">L4Re::Mmio_space::Addr</a></div><div class="ttdeci">l4_uint64_t Addr</div><div class="ttdoc">Device address.</div><div class="ttdef"><b>Definition</b> <a href="#l00058">mmio_space:58</a></div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_a3b808dbe1e4db25b368fce4c46422640"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#a3b808dbe1e4db25b368fce4c46422640">L4Re::Mmio_space::mmio_write</a></div><div class="ttdeci">long mmio_write(Addr addr, char width, l4_uint64_t value)</div><div class="ttdoc">Write a value to the given address.</div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_a4b7ca46b4304688a50b483eaffd42fb7"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7">L4Re::Mmio_space::Access_width</a></div><div class="ttdeci">Access_width</div><div class="ttdoc">Actual size of the value to read or write.</div><div class="ttdef"><b>Definition</b> <a href="#l00049">mmio_space:50</a></div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_a4b7ca46b4304688a50b483eaffd42fb7a0b5599ce8761a8a388a24cc669770309"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a0b5599ce8761a8a388a24cc669770309">L4Re::Mmio_space::Wd_64bit</a></div><div class="ttdeci">@ Wd_64bit</div><div class="ttdoc">Value is a 8-byte word.</div><div class="ttdef"><b>Definition</b> <a href="#l00054">mmio_space:54</a></div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_a4b7ca46b4304688a50b483eaffd42fb7a1250c3658a92c482f4c72a8894a71d61"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1250c3658a92c482f4c72a8894a71d61">L4Re::Mmio_space::Wd_16bit</a></div><div class="ttdeci">@ Wd_16bit</div><div class="ttdoc">Value is a 2-byte word.</div><div class="ttdef"><b>Definition</b> <a href="#l00052">mmio_space:52</a></div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_a4b7ca46b4304688a50b483eaffd42fb7a1bcc475a11de577ac42baaca09865673"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1bcc475a11de577ac42baaca09865673">L4Re::Mmio_space::Wd_32bit</a></div><div class="ttdeci">@ Wd_32bit</div><div class="ttdoc">Value is a 4-byte word.</div><div class="ttdef"><b>Definition</b> <a href="#l00053">mmio_space:53</a></div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_a4b7ca46b4304688a50b483eaffd42fb7a1f1fb483db99f182cbf5c010050dd89b"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#a4b7ca46b4304688a50b483eaffd42fb7a1f1fb483db99f182cbf5c010050dd89b">L4Re::Mmio_space::Wd_8bit</a></div><div class="ttdeci">@ Wd_8bit</div><div class="ttdoc">Value is a byte.</div><div class="ttdef"><b>Definition</b> <a href="#l00051">mmio_space:51</a></div></div>
|
|
<div class="ttc" id="astructL4Re_1_1Mmio__space_html_abcd7f35633be3f71b2cf2a2162e7f0eb"><div class="ttname"><a href="structL4Re_1_1Mmio__space.html#abcd7f35633be3f71b2cf2a2162e7f0eb">L4Re::Mmio_space::mmio_read</a></div><div class="ttdeci">long mmio_read(Addr addr, char width, l4_uint64_t *value)</div><div class="ttdoc">Read a value from the given address.</div></div>
|
|
<div class="ttc" id="astructL4_1_1Typeid_1_1Rpcs_html"><div class="ttname"><a href="structL4_1_1Typeid_1_1Rpcs.html">L4::Typeid::Rpcs</a></div><div class="ttdoc">Standard list of RPCs of an interface.</div><div class="ttdef"><b>Definition</b> <a href="____typeinfo_8h_source.html#l00428">__typeinfo.h:428</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>l4</b></li><li class="navelem"><b>re</b></li><li class="navelem"><a href="mmio__space.html">mmio_space</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>
|