188 lines
17 KiB
HTML
188 lines
17 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/sys/memdesc.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('memdesc_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">memdesc.h File Reference<div class="ingroups"><a class="el" href="group__l4__api.html">Base API</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Memory description functions.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="sys_2kip_8h_source.html">l4/sys/kip.h</a>></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 memdesc.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="memdesc_8h__incl.svg" width="439" height="256"><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="memdesc_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-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:l4_5Fkernel_5Finfo_5Fmem_5Fdesc_5Ft" id="r_l4_5Fkernel_5Finfo_5Fmem_5Fdesc_5Ft"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Memory descriptor data structure. <a href="structl4__kernel__info__mem__desc__t.html#details">More...</a><br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gac2ed8842c9285f9781141050ab2de75c" id="r_gac2ed8842c9285f9781141050ab2de75c"><td class="memItemLeft" align="right" valign="top">typedef struct l4_kernel_info_mem_desc_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gac2ed8842c9285f9781141050ab2de75c">l4_kernel_info_mem_desc_t</a></td></tr>
|
|
<tr class="memdesc:gac2ed8842c9285f9781141050ab2de75c"><td class="mdescLeft"> </td><td class="mdescRight">Memory descriptor data structure. <br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gade2e30698fdf159a213391296470b66b" id="r_gade2e30698fdf159a213391296470b66b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gade2e30698fdf159a213391296470b66b">l4_mem_type_t</a> { <br />
|
|
  <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66ba5a80d0781c72440a97e99ac31d50dc0d">l4_mem_type_undefined</a> = 0x0
|
|
, <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66ba0a528b961b5306702737fa2513d08726">l4_mem_type_conventional</a> = 0x1
|
|
, <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66baa731eee37b51d5afcd312e8536b72f3d">l4_mem_type_reserved</a> = 0x2
|
|
, <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66ba89695a50b016f3bd9e118fa76c229d63">l4_mem_type_dedicated</a> = 0x3
|
|
, <br />
|
|
  <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66bac56accc8d1672c5d5ef1f82fec961ec5">l4_mem_type_shared</a> = 0x4
|
|
, <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66ba0c072c06b5c182d9b47026fe81e3b7e9">l4_mem_type_info</a> = 0xd
|
|
, <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66bab276bd6ba483df0e945431758ccd443d">l4_mem_type_bootloader</a> = 0xe
|
|
, <a class="el" href="group__l4__kip__memdesc__api.html#ggade2e30698fdf159a213391296470b66ba01a6d2415ad480095295162d760be352">l4_mem_type_archspecific</a> = 0xf
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:gade2e30698fdf159a213391296470b66b"><td class="mdescLeft"> </td><td class="mdescRight">Type of a memory descriptor. <a href="group__l4__kip__memdesc__api.html#gade2e30698fdf159a213391296470b66b">More...</a><br /></td></tr>
|
|
<tr class="memitem:ga3e23431fa7b2cca1b0f5b99d4370d2a8" id="r_ga3e23431fa7b2cca1b0f5b99d4370d2a8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#ga3e23431fa7b2cca1b0f5b99d4370d2a8">l4_mem_info_sub_type_t</a> { <a class="el" href="group__l4__kip__memdesc__api.html#gga3e23431fa7b2cca1b0f5b99d4370d2a8adfe99c5ff69ffe0b45e79fcf1797ee28">l4_mem_info_acpi_rsdp</a> = 0
|
|
}</td></tr>
|
|
<tr class="memdesc:ga3e23431fa7b2cca1b0f5b99d4370d2a8"><td class="mdescLeft"> </td><td class="mdescRight">Memory sub types for l4_mem_type_info descriptors. <a href="group__l4__kip__memdesc__api.html#ga3e23431fa7b2cca1b0f5b99d4370d2a8">More...</a><br /></td></tr>
|
|
<tr class="memitem:ga3a81e9530e9f049a2c6a7d1443ff8e58" id="r_ga3a81e9530e9f049a2c6a7d1443ff8e58"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#ga3a81e9530e9f049a2c6a7d1443ff8e58">l4_mem_archspecific_sub_type_common_t</a> { <a class="el" href="group__l4__kip__memdesc__api.html#gga3a81e9530e9f049a2c6a7d1443ff8e58a35f38d1248b8fb665446e69d8084c95b">l4_mem_archspecific_acpi_tables</a> = 3
|
|
, <a class="el" href="group__l4__kip__memdesc__api.html#gga3a81e9530e9f049a2c6a7d1443ff8e58a6a8b772d4a2a4e1eed19f485252a1631">l4_mem_archspecific_acpi_nvs</a> = 4
|
|
}</td></tr>
|
|
<tr class="memdesc:ga3a81e9530e9f049a2c6a7d1443ff8e58"><td class="mdescLeft"> </td><td class="mdescRight">Memory sub types for l4_mem_type_archspecific descriptors. <a href="group__l4__kip__memdesc__api.html#ga3a81e9530e9f049a2c6a7d1443ff8e58">More...</a><br /></td></tr>
|
|
</table><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:ga3aa63a101c52c16c7bc50aeb329fb3fb" id="r_ga3aa63a101c52c16c7bc50aeb329fb3fb"><td class="memItemLeft" align="right" valign="top">
|
|
<a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a> * </td><td class="memItemRight" valign="bottom"><b>l4_kernel_info_get_mem_descs</b> (<a class="el" href="structl4__kernel__info__t.html">l4_kernel_info_t</a> *kip) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga3aa63a101c52c16c7bc50aeb329fb3fb"><td class="mdescLeft"> </td><td class="mdescRight">Get pointer to memory descriptors from KIP. <br /></td></tr>
|
|
<tr class="memitem:gad6337d000b10118b6e100a1479a5c242" id="r_gad6337d000b10118b6e100a1479a5c242"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gad6337d000b10118b6e100a1479a5c242">l4_kernel_info_get_num_mem_descs</a> (<a class="el" href="structl4__kernel__info__t.html">l4_kernel_info_t</a> *kip) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gad6337d000b10118b6e100a1479a5c242"><td class="mdescLeft"> </td><td class="mdescRight">Get number of memory descriptors in KIP. <br /></td></tr>
|
|
<tr class="memitem:gab0d8c5ee1f94e2cc2d41bc8c76ec88ac" id="r_gab0d8c5ee1f94e2cc2d41bc8c76ec88ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gab0d8c5ee1f94e2cc2d41bc8c76ec88ac">l4_kernel_info_set_mem_desc</a> (<a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a> *md, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> start, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> end, unsigned type, unsigned virt, unsigned sub_type) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gab0d8c5ee1f94e2cc2d41bc8c76ec88ac"><td class="mdescLeft"> </td><td class="mdescRight">Populate a memory descriptor. <br /></td></tr>
|
|
<tr class="memitem:gaf9f75dac1dcdf469e6ccd837540cf484" id="r_gaf9f75dac1dcdf469e6ccd837540cf484"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gaf9f75dac1dcdf469e6ccd837540cf484">l4_kernel_info_get_mem_desc_start</a> (<a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a> *md) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gaf9f75dac1dcdf469e6ccd837540cf484"><td class="mdescLeft"> </td><td class="mdescRight">Get start address of the region described by the memory descriptor. <br /></td></tr>
|
|
<tr class="memitem:gad12dfe24624121c647f678f04d9d1867" id="r_gad12dfe24624121c647f678f04d9d1867"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gad12dfe24624121c647f678f04d9d1867">l4_kernel_info_get_mem_desc_end</a> (<a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a> *md) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gad12dfe24624121c647f678f04d9d1867"><td class="mdescLeft"> </td><td class="mdescRight">Get end address of the region described by the memory descriptor. <br /></td></tr>
|
|
<tr class="memitem:gae58b7d2202c79808fe5f92aae6a3af16" id="r_gae58b7d2202c79808fe5f92aae6a3af16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gae58b7d2202c79808fe5f92aae6a3af16">l4_kernel_info_get_mem_desc_type</a> (<a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a> *md) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gae58b7d2202c79808fe5f92aae6a3af16"><td class="mdescLeft"> </td><td class="mdescRight">Get type of the memory region. <br /></td></tr>
|
|
<tr class="memitem:ga22f234f45b8531794c467523e88061b3" id="r_ga22f234f45b8531794c467523e88061b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#ga22f234f45b8531794c467523e88061b3">l4_kernel_info_get_mem_desc_subtype</a> (<a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a> *md) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga22f234f45b8531794c467523e88061b3"><td class="mdescLeft"> </td><td class="mdescRight">Get sub-type of memory region. <br /></td></tr>
|
|
<tr class="memitem:gaa068e882421ffe2913a5d0b4a4954a49" id="r_gaa068e882421ffe2913a5d0b4a4954a49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__kip__memdesc__api.html#gaa068e882421ffe2913a5d0b4a4954a49">l4_kernel_info_get_mem_desc_is_virtual</a> (<a class="el" href="structl4__kernel__info__mem__desc__t.html">l4_kernel_info_mem_desc_t</a> *md) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gaa068e882421ffe2913a5d0b4a4954a49"><td class="mdescLeft"> </td><td class="mdescRight">Get virtual flag of the memory descriptor. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Memory description functions. </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="memdesc_8h_source.html">memdesc.h</a>.</p>
|
|
</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>l4</b></li><li class="navelem"><b>sys</b></li><li class="navelem"><a href="memdesc_8h.html">memdesc.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>
|