165 lines
13 KiB
HTML
165 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: l4/vcpu/vcpu.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('vcpu_2vcpu_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">vcpu.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>vCPU support library (C interface).
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="sys_2vcpu_8h_source.html">l4/sys/vcpu.h</a>></code><br />
|
|
<code>#include <<a class="el" href="l4_2sys_2utcb_8h_source.html">l4/sys/utcb.h</a>></code><br />
|
|
<code>#include <<a class="el" href="l4_2sys_2ipc_8h_source.html">l4/sys/ipc.h</a>></code><br />
|
|
<code>#include <l4/vcpu/vcpu_arch.h></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 vcpu.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="vcpu_2vcpu_8h__incl.svg" width="723" height="476"><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="vcpu_2vcpu_8h__dep__incl.svg" width="127" height="110"><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="vcpu_2vcpu_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:gac8dd177f5382328e3922754cc9d36b28" id="r_gac8dd177f5382328e3922754cc9d36b28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#gac8dd177f5382328e3922754cc9d36b28">l4vcpu_irq_disable</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gac8dd177f5382328e3922754cc9d36b28"><td class="mdescLeft"> </td><td class="mdescRight">Disable a vCPU for event delivery. <br /></td></tr>
|
|
<tr class="memitem:gaa1e7797e4ed8b7dabd40c9849f5c362c" id="r_gaa1e7797e4ed8b7dabd40c9849f5c362c"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#gaa1e7797e4ed8b7dabd40c9849f5c362c">l4vcpu_irq_disable_save</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gaa1e7797e4ed8b7dabd40c9849f5c362c"><td class="mdescLeft"> </td><td class="mdescRight">Disable a vCPU for event delivery and return previous state. <br /></td></tr>
|
|
<tr class="memitem:ga58a61ec0b02bed0a03f708e1594cf8a5" id="r_ga58a61ec0b02bed0a03f708e1594cf8a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#ga58a61ec0b02bed0a03f708e1594cf8a5">l4vcpu_irq_enable</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb, l4vcpu_event_hndl_t do_event_work_cb, l4vcpu_setup_ipc_t setup_ipc) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga58a61ec0b02bed0a03f708e1594cf8a5"><td class="mdescLeft"> </td><td class="mdescRight">Enable a vCPU for event delivery. <br /></td></tr>
|
|
<tr class="memitem:ga68cccc12b6542f9413afb281d8bdffcc" id="r_ga68cccc12b6542f9413afb281d8bdffcc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#ga68cccc12b6542f9413afb281d8bdffcc">l4vcpu_irq_restore</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, unsigned s, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb, l4vcpu_event_hndl_t do_event_work_cb, l4vcpu_setup_ipc_t setup_ipc) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga68cccc12b6542f9413afb281d8bdffcc"><td class="mdescLeft"> </td><td class="mdescRight">Restore a previously saved IRQ/event state. <br /></td></tr>
|
|
<tr class="memitem:gaf305894f807867f8a5b1a99b22c05587" id="r_gaf305894f807867f8a5b1a99b22c05587"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#gaf305894f807867f8a5b1a99b22c05587">l4vcpu_wait_for_event</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb, l4vcpu_event_hndl_t do_event_work_cb, l4vcpu_setup_ipc_t setup_ipc) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gaf305894f807867f8a5b1a99b22c05587"><td class="mdescLeft"> </td><td class="mdescRight">Wait for event. <br /></td></tr>
|
|
<tr class="memitem:gaed55cde10e914bfc8be9760a0fd90b0e" id="r_gaed55cde10e914bfc8be9760a0fd90b0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#gaed55cde10e914bfc8be9760a0fd90b0e">l4vcpu_print_state</a> (const <a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> *vcpu, const char *prefix) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gaed55cde10e914bfc8be9760a0fd90b0e"><td class="mdescLeft"> </td><td class="mdescRight">Print the state of a vCPU. <br /></td></tr>
|
|
<tr class="memitem:ga55f7fc7f6496002375240e2354ecb807" id="r_ga55f7fc7f6496002375240e2354ecb807"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#ga55f7fc7f6496002375240e2354ecb807">l4vcpu_is_irq_entry</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> const *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga55f7fc7f6496002375240e2354ecb807"><td class="mdescLeft"> </td><td class="mdescRight">Return whether the entry reason was an IRQ/IPC message. <br /></td></tr>
|
|
<tr class="memitem:gab5156a117efc0b4760e81e99938a2dc1" id="r_gab5156a117efc0b4760e81e99938a2dc1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu.html#gab5156a117efc0b4760e81e99938a2dc1">l4vcpu_is_page_fault_entry</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> const *vcpu) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:gab5156a117efc0b4760e81e99938a2dc1"><td class="mdescLeft"> </td><td class="mdescRight">Return whether the entry reason was a page fault. <br /></td></tr>
|
|
<tr class="memitem:ga1421d3effdb0e3fd7f11eee39025cfc8" id="r_ga1421d3effdb0e3fd7f11eee39025cfc8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__libvcpu__ext.html#ga1421d3effdb0e3fd7f11eee39025cfc8">l4vcpu_ext_alloc</a> (<a class="el" href="structl4__vcpu__state__t.html">l4_vcpu_state_t</a> **vcpu, <a class="el" href="group__l4__basic__types.html#ga4087b991c40c0d2fcde9ca331049a4d4">l4_addr_t</a> *ext_state, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> task, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> regmgr) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga1421d3effdb0e3fd7f11eee39025cfc8"><td class="mdescLeft"> </td><td class="mdescRight">Allocate state area for an extended vCPU. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>vCPU support library (C interface). </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="vcpu_2vcpu_8h_source.html">vcpu.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>vcpu</b></li><li class="navelem"><a href="vcpu_2vcpu_8h.html">vcpu.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>
|