273 lines
16 KiB
HTML
273 lines
16 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/c/inhibitor.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('inhibitor_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">inhibitor.h File Reference<div class="ingroups"><a class="el" href="group__api__l4re__c.html">L4Re C Interface</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Inhibitor C interface.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="compiler_8h_source.html">l4/sys/compiler.h</a>></code><br />
|
|
<code>#include <<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.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 inhibitor.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="inhibitor_8h__incl.svg" width="558" 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>
|
|
<p><a href="inhibitor_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:a499aa622a366bdc72423d9f821722503" id="r_a499aa622a366bdc72423d9f821722503"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a499aa622a366bdc72423d9f821722503">l4re_inhibitor_acquire</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> id, char const *reason)</td></tr>
|
|
<tr class="memdesc:a499aa622a366bdc72423d9f821722503"><td class="mdescLeft"> </td><td class="mdescRight">Acquire an inhibitor lock. <br /></td></tr>
|
|
<tr class="memitem:a24106cbb2f626319992ddc01d9117711" id="r_a24106cbb2f626319992ddc01d9117711"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a24106cbb2f626319992ddc01d9117711">l4re_inhibitor_release</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> id)</td></tr>
|
|
<tr class="memdesc:a24106cbb2f626319992ddc01d9117711"><td class="mdescLeft"> </td><td class="mdescRight">Release an inhibitor lock. <br /></td></tr>
|
|
<tr class="memitem:a098f97b9b7f41e53c35c4415b97660fa" id="r_a098f97b9b7f41e53c35c4415b97660fa"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#a098f97b9b7f41e53c35c4415b97660fa">l4re_inhibitor_next_lock_info</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap, char *name, unsigned len, <a class="el" href="group__l4__basic__types.html#ga51d9492e7700d70ed35838154ca9b279">l4_mword_t</a> current_id)</td></tr>
|
|
<tr class="memdesc:a098f97b9b7f41e53c35c4415b97660fa"><td class="mdescLeft"> </td><td class="mdescRight">Get information for the next available inhibitor lock. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Inhibitor C interface. </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="inhibitor_8h_source.html">inhibitor.h</a>.</p>
|
|
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
|
|
<a id="a499aa622a366bdc72423d9f821722503" name="a499aa622a366bdc72423d9f821722503"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a499aa622a366bdc72423d9f821722503">◆ </a></span>l4re_inhibitor_acquire()</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> long l4re_inhibitor_acquire </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a></td> <td class="paramname"><span class="paramname"><em>id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>reason</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Acquire an inhibitor lock. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cap</td><td>Capability for the Inhibitor object (see <a class="el" href="classL4Re_1_1Inhibitor.html" title="Set of inhibitor locks, which inhibit specific actions when held.">L4Re::Inhibitor</a>) </td></tr>
|
|
<tr><td class="paramname">id</td><td>ID of the inhibitor lock that shall be acquired. </td></tr>
|
|
<tr><td class="paramname">reason</td><td>Reason why the inhibitor lock is acquired. (Used for informing the user or debugging.) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 for success, <0 on error. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classL4Re_1_1Inhibitor.html#ab220aac3d51cc9c422c04e8b18409179" title="Acquire a specific inhibitor lock.">L4Re::Inhibitor::acquire()</a>. </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#l00214">L4_EXPORT</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a098f97b9b7f41e53c35c4415b97660fa" name="a098f97b9b7f41e53c35c4415b97660fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a098f97b9b7f41e53c35c4415b97660fa">◆ </a></span>l4re_inhibitor_next_lock_info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long l4re_inhibitor_next_lock_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>len</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga51d9492e7700d70ed35838154ca9b279">l4_mword_t</a></td> <td class="paramname"><span class="paramname"><em>current_id</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get information for the next available inhibitor lock. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cap</td><td>Capability to the Inhibitor object (see <a class="el" href="classL4Re_1_1Inhibitor.html" title="Set of inhibitor locks, which inhibit specific actions when held.">L4Re::Inhibitor</a>) </td></tr>
|
|
<tr><td class="paramname">name</td><td>A pointer to a buffer for the name of the lock. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The length of the available buffer (usually <a class="el" href="classL4Re_1_1Inhibitor.html#a854ddc23caaf4f72157f7878e4a17fffad10674dcf6cde6eb7acb89dd77bb2bc3" title="The maximum length of a lock's name.">L4Re::Inhibitor::Name_max</a> is used). </td></tr>
|
|
<tr><td class="paramname">current_id</td><td>The ID of the last available lock, use -1 to get the first lock. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">>0</td><td>The ID of the next available lock if there is one (in this case name shall contain the name of the inhibitor lock). </td></tr>
|
|
<tr><td class="paramname">-L4_ENODEV</td><td>if there are no more locks. </td></tr>
|
|
<tr><td class="paramname"><0</td><td>Any other negative failure value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classL4Re_1_1Inhibitor.html#aa524589a81a491df8cad60939373d0da" title="Get information for the next available inhibitor lock.">L4Re::Inhibitor::next_lock_info()</a>. </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00166">L4_END_DECLS</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a24106cbb2f626319992ddc01d9117711" name="a24106cbb2f626319992ddc01d9117711"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24106cbb2f626319992ddc01d9117711">◆ </a></span>l4re_inhibitor_release()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long l4re_inhibitor_release </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a></td> <td class="paramname"><span class="paramname"><em>id</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Release an inhibitor lock. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cap</td><td>Capability for the Inhibitor object (see <a class="el" href="classL4Re_1_1Inhibitor.html" title="Set of inhibitor locks, which inhibit specific actions when held.">L4Re::Inhibitor</a>). </td></tr>
|
|
<tr><td class="paramname">id</td><td>ID of inhibitor that shall be released. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 for success, <0 on error. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classL4Re_1_1Inhibitor.html#ac228e6e7ba816c85eec1826c65e149d6" title="Release a specific inhibitor lock.">L4Re::Inhibitor::release()</a>. </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#l00214">L4_EXPORT</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="navelem"><b>l4</b></li><li class="navelem"><b>re</b></li><li class="navelem"><b>c</b></li><li class="navelem"><a href="inhibitor_8h.html">inhibitor.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>
|