Files
moslab-code/doc/source/html/group__l4util__kip__api.html
2025-09-12 15:55:45 +02:00

231 lines
13 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: Kernel Interface Page API</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('group__l4util__kip__api.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">Kernel Interface Page API <div class="ingroups"><a class="el" href="group__l4util__api.html">Utility Functions</a></div></div></div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for Kernel Interface Page API:</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="group__l4util__kip__api.svg" width="372" height="36"><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-files" class="groupheader"><a id="files" name="files"></a>
Files</h2></td></tr>
<tr class="memitem:kip_2Eh" id="r_kip_2Eh"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="util_2kip_8h.html">kip.h</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa4aa45346c8942c626e73e43bbee8aa3" id="r_gaa4aa45346c8942c626e73e43bbee8aa3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa4aa45346c8942c626e73e43bbee8aa3">l4util_kip_for_each_feature</a>(s)</td></tr>
<tr class="memdesc:gaa4aa45346c8942c626e73e43bbee8aa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cycle through kernel features given in the KIP. <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:ga5f85f4f3111f2b7057ece98747b987ed" id="r_ga5f85f4f3111f2b7057ece98747b987ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5f85f4f3111f2b7057ece98747b987ed">l4util_kip_kernel_has_feature</a> (<a class="el" href="structl4__kernel__info__t.html">l4_kernel_info_t</a> const *k, char const *str)</td></tr>
<tr class="memdesc:ga5f85f4f3111f2b7057ece98747b987ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if kernel supports a feature. <br /></td></tr>
<tr class="memitem:gabb39cbc849671199be3f4548b3de1144" id="r_gabb39cbc849671199be3f4548b3de1144"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gabb39cbc849671199be3f4548b3de1144">l4util_kip_kernel_abi_version</a> (<a class="el" href="structl4__kernel__info__t.html">l4_kernel_info_t</a> const *k)</td></tr>
<tr class="memdesc:gabb39cbc849671199be3f4548b3de1144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return kernel ABI version. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2>
<a id="gaa4aa45346c8942c626e73e43bbee8aa3" name="gaa4aa45346c8942c626e73e43bbee8aa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4aa45346c8942c626e73e43bbee8aa3">&#9670;&#160;</a></span>l4util_kip_for_each_feature</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define l4util_kip_for_each_feature</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="sys_2kip_8h.html#ab98233bd115fcc7f039168bdb636edbc">l4_kip_for_each_feature</a>(s)</div>
<div class="ttc" id="asys_2kip_8h_html_ab98233bd115fcc7f039168bdb636edbc"><div class="ttname"><a href="sys_2kip_8h.html#ab98233bd115fcc7f039168bdb636edbc">l4_kip_for_each_feature</a></div><div class="ttdeci">#define l4_kip_for_each_feature(s)</div><div class="ttdoc">Cycle through kernel features given in the KIP.</div><div class="ttdef"><b>Definition</b> <a href="sys_2kip_8h_source.html#l00272">kip.h:272</a></div></div>
</div><!-- fragment -->
<p>Cycle through kernel features given in the KIP. </p>
<p>Cycles through all KIP kernel feature strings. s must be a character pointer (char const *) initialized with <a class="el" href="group__l4__kip__api.html#ga93a1b85e22b798e46f7608f59153895c" title="Get the kernel version string.">l4_kip_version_string()</a>.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated</a></b></dt><dd>Use <a class="el" href="sys_2kip_8h.html#ab98233bd115fcc7f039168bdb636edbc" title="Cycle through kernel features given in the KIP.">l4_kip_for_each_feature()</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="util_2kip_8h_source.html#l00058">58</a> of file <a class="el" href="util_2kip_8h_source.html">kip.h</a>.</p>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="gabb39cbc849671199be3f4548b3de1144" name="gabb39cbc849671199be3f4548b3de1144"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb39cbc849671199be3f4548b3de1144">&#9670;&#160;</a></span>l4util_kip_kernel_abi_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long l4util_kip_kernel_abi_version </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__kernel__info__t.html">l4_kernel_info_t</a> const *</td> <td class="paramname"><span class="paramname"><em>k</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return kernel ABI version. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">k</td><td>Pointer to the kernel info page (KIP). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Kernel ABI version. </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#l00166">L4_END_DECLS</a>.</p>
</div>
</div>
<a id="ga5f85f4f3111f2b7057ece98747b987ed" name="ga5f85f4f3111f2b7057ece98747b987ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5f85f4f3111f2b7057ece98747b987ed">&#9670;&#160;</a></span>l4util_kip_kernel_has_feature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> int l4util_kip_kernel_has_feature </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__kernel__info__t.html">l4_kernel_info_t</a> const *</td> <td class="paramname"><span class="paramname"><em>k</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>str</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if kernel supports a feature. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">k</td><td>Pointer to the kernel info page (KIP). </td></tr>
<tr><td class="paramname">str</td><td>Feature name to check.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the kernel supports the feature, 0 if not.</dd></dl>
<p>Checks the feature field in the KIP for the given string.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated</a></b></dt><dd>Use <a class="el" href="sys_2kip_8h.html#a7a4e7e53bf5bb8939c64dd9f2b9e458a" title="Check if kernel supports a feature.">l4_kip_kernel_has_feature()</a>. </dd></dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</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="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>