l4re-base-25.08.0

This commit is contained in:
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions

View File

@@ -0,0 +1,200 @@
<!-- 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/utcb.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('l4_2sys_2utcb_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">utcb.h File Reference<div class="ingroups"><a class="el" href="group__l4__api.html">Base API</a> &raquo; <a class="el" href="group__l4__ipc__api.html">Object Invocation</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>UTCB definitions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.h</a>&gt;</code><br />
<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_2l4int_8h_source.html">l4/sys/l4int.h</a>&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 utcb.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="l4_2sys_2utcb_8h__incl.svg" width="544" height="330"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="l4_2sys_2utcb_8h__dep__incl.svg" width="6640" height="1180"><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="l4_2sys_2utcb_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_5Fmsg_5Fregs_5Ft" id="r_l4_5Fmsg_5Fregs_5Ft"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionl4__msg__regs__t.html">l4_msg_regs_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encapsulation of the message-register block in the UTCB. <a href="unionl4__msg__regs__t.html#details">More...</a><br /></td></tr>
<tr class="memitem:l4_5Fbuf_5Fregs_5Ft" id="r_l4_5Fbuf_5Fregs_5Ft"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structl4__buf__regs__t.html">l4_buf_regs_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encapsulation of the buffer-registers block in the UTCB. <a href="structl4__buf__regs__t.html#details">More...</a><br /></td></tr>
<tr class="memitem:l4_5Fthread_5Fregs_5Ft" id="r_l4_5Fthread_5Fregs_5Ft"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structl4__thread__regs__t.html">l4_thread_regs_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encapsulation of the thread-control-register block of the UTCB. <a href="structl4__thread__regs__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:ga89be8a86d11c1d532b636cc2df1330fb" id="r_ga89be8a86d11c1d532b636cc2df1330fb"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a></td></tr>
<tr class="memdesc:ga89be8a86d11c1d532b636cc2df1330fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque type for the UTCB. <br /></td></tr>
<tr class="memitem:ga3501fc9601dfb2fd7b49d04607d2ac84" id="r_ga3501fc9601dfb2fd7b49d04607d2ac84"><td class="memItemLeft" align="right" valign="top">
typedef union l4_msg_regs_t&#160;</td><td class="memItemRight" valign="bottom"><b>l4_msg_regs_t</b></td></tr>
<tr class="memdesc:ga3501fc9601dfb2fd7b49d04607d2ac84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encapsulation of the message-register block in the UTCB. <br /></td></tr>
<tr class="memitem:gae166f923e400efff8f39be3425641fc5" id="r_gae166f923e400efff8f39be3425641fc5"><td class="memItemLeft" align="right" valign="top">
typedef struct l4_buf_regs_t&#160;</td><td class="memItemRight" valign="bottom"><b>l4_buf_regs_t</b></td></tr>
<tr class="memdesc:gae166f923e400efff8f39be3425641fc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encapsulation of the buffer-registers block in the UTCB. <br /></td></tr>
<tr class="memitem:gacdbcfef25e66bdcc9e65c3a0207c8520" id="r_gacdbcfef25e66bdcc9e65c3a0207c8520"><td class="memItemLeft" align="right" valign="top">
typedef struct l4_thread_regs_t&#160;</td><td class="memItemRight" valign="bottom"><b>l4_thread_regs_t</b></td></tr>
<tr class="memdesc:gacdbcfef25e66bdcc9e65c3a0207c8520"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encapsulation of the thread-control-register block of the UTCB. <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:gadc099b4a59e1d99638c72c11a8c8b644" id="r_gadc099b4a59e1d99638c72c11a8c8b644"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>l4_utcb</b> (void) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:gadc099b4a59e1d99638c72c11a8c8b644"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UTCB address. <br /></td></tr>
<tr class="memitem:ga090bdcc433d5ce568b22ec9ab4f3357b" id="r_ga090bdcc433d5ce568b22ec9ab4f3357b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionl4__msg__regs__t.html">l4_msg_regs_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__api.html#ga090bdcc433d5ce568b22ec9ab4f3357b">l4_utcb_mr</a> (void) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:ga090bdcc433d5ce568b22ec9ab4f3357b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the message-register block of a UTCB. <br /></td></tr>
<tr class="memitem:gae35044c9bae188ccffb2fd90781c60a5" id="r_gae35044c9bae188ccffb2fd90781c60a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__buf__regs__t.html">l4_buf_regs_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__api.html#gae35044c9bae188ccffb2fd90781c60a5">l4_utcb_br</a> (void) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:gae35044c9bae188ccffb2fd90781c60a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the buffer-register block of a UTCB. <br /></td></tr>
<tr class="memitem:ga78ce6eec1d9b19af0f87119c6ac72716" id="r_ga78ce6eec1d9b19af0f87119c6ac72716"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__thread__regs__t.html">l4_thread_regs_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__api.html#ga78ce6eec1d9b19af0f87119c6ac72716">l4_utcb_tcr</a> (void) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:ga78ce6eec1d9b19af0f87119c6ac72716"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the thread-control-register block of a UTCB. <br /></td></tr>
<tr class="memitem:ga3d957c3c28e526804e2c1a2e183df88f" id="r_ga3d957c3c28e526804e2c1a2e183df88f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__exc__regs__t.html">l4_exc_regs_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__exc__api.html#ga3d957c3c28e526804e2c1a2e183df88f">l4_utcb_exc</a> (void) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:ga3d957c3c28e526804e2c1a2e183df88f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the message-register block of a UTCB (for an exception IPC). <br /></td></tr>
<tr class="memitem:gab921a807cb317813976ab53f7fca5be5" id="r_gab921a807cb317813976ab53f7fca5be5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__exc__api.html#gab921a807cb317813976ab53f7fca5be5">l4_utcb_exc_pc</a> (<a class="el" href="structl4__exc__regs__t.html">l4_exc_regs_t</a> const *u) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:gab921a807cb317813976ab53f7fca5be5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access function to get the program counter of the exception state. <br /></td></tr>
<tr class="memitem:gaf5c4da380dfe89136d5b509e5a3afde2" id="r_gaf5c4da380dfe89136d5b509e5a3afde2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__exc__api.html#gaf5c4da380dfe89136d5b509e5a3afde2">l4_utcb_exc_pc_set</a> (<a class="el" href="structl4__exc__regs__t.html">l4_exc_regs_t</a> *u, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> pc) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gaf5c4da380dfe89136d5b509e5a3afde2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the program counter register in the exception state. <br /></td></tr>
<tr class="memitem:gad1b2921ad31b2d59b2e80feb42d6f4f3" id="r_gad1b2921ad31b2d59b2e80feb42d6f4f3"><td class="memItemLeft" align="right" valign="top">
unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>l4_utcb_exc_typeval</b> (<a class="el" href="structl4__exc__regs__t.html">l4_exc_regs_t</a> const *u) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:gad1b2921ad31b2d59b2e80feb42d6f4f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value out of an exception UTCB that describes the type of exception. <br /></td></tr>
<tr class="memitem:gaa2cfac5dedec0954915dc8e846fda70d" id="r_gaa2cfac5dedec0954915dc8e846fda70d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__exc__api.html#gaa2cfac5dedec0954915dc8e846fda70d">l4_utcb_exc_is_pf</a> (<a class="el" href="structl4__exc__regs__t.html">l4_exc_regs_t</a> const *u) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:gaa2cfac5dedec0954915dc8e846fda70d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether an exception IPC is a page fault. <br /></td></tr>
<tr class="memitem:ga0e11bd9dad8df6d98020621afa8fc292" id="r_ga0e11bd9dad8df6d98020621afa8fc292"><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"><b>l4_utcb_exc_pfa</b> (<a class="el" href="structl4__exc__regs__t.html">l4_exc_regs_t</a> const *u) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:ga0e11bd9dad8df6d98020621afa8fc292"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to get the <a class="el" href="namespaceL4.html" title="L4 low-level kernel interface.">L4</a> style page fault address out of an exception. <br /></td></tr>
<tr class="memitem:ga3d8d1479a472e7f21d5d5092b4f94770" id="r_ga3d8d1479a472e7f21d5d5092b4f94770"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__utcb__exc__api.html#ga3d8d1479a472e7f21d5d5092b4f94770">l4_utcb_exc_is_ex_regs_exception</a> (<a class="el" href="structl4__exc__regs__t.html">l4_exc_regs_t</a> const *u) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a> L4_PURE</td></tr>
<tr class="memdesc:ga3d8d1479a472e7f21d5d5092b4f94770"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether an exception IPC was triggered via <a class="el" href="group__l4__thread__api.html#ga1ea29499c679caeae810516d16f4347c" title="Exchange basic thread registers.">l4_thread_ex_regs()</a>. <br /></td></tr>
<tr class="memitem:gacebc13d69883825a309b381a6aabe7b7" id="r_gacebc13d69883825a309b381a6aabe7b7"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>l4_utcb_inherit_fpu</b> (int switch_on) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gacebc13d69883825a309b381a6aabe7b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable or disable inheritance of FPU state to receiver. <br /></td></tr>
<tr class="memitem:gab3eeabba0542c7723fbd5628c6e4d6c3" id="r_gab3eeabba0542c7723fbd5628c6e4d6c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structl4__timeout__s.html">l4_timeout_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__timeout__api.html#gab3eeabba0542c7723fbd5628c6e4d6c3">l4_timeout_abs</a> (<a class="el" href="group__l4__basic__types.html#gab71da24eb7cda2c035f18b862309b101">l4_kernel_clock_t</a> pint, int br) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gab3eeabba0542c7723fbd5628c6e4d6c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set an absolute timeout. <br /></td></tr>
<tr class="memitem:gab6180d7a9aacb569666fea7aa8800c31" id="r_gab6180d7a9aacb569666fea7aa8800c31"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4__timeout__api.html#gab6180d7a9aacb569666fea7aa8800c31">l4_utcb_mr64_idx</a> (unsigned idx) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
<tr class="memdesc:gab6180d7a9aacb569666fea7aa8800c31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get index into 64bit message registers alias from native-sized index. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>UTCB definitions. </p>
<p class="definition">Definition in file <a class="el" href="l4_2sys_2utcb_8h_source.html">utcb.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="l4_2sys_2utcb_8h.html">utcb.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>