teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
49bd21a8e5e36f1a6d87ccd2c6d8168f23e2f91a
moslab-code/doc/source/html/group__api__l4shmc__signal.html
vreusch d959eaab98 l4re-base-25.08.0
2025-09-12 15:55:45 +02:00

367 lines
18 KiB
HTML
Raw Blame History

<!-- 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: Signals</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__api__l4shmc__signal.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">Signals <div class="ingroups"><a class="el" href="group__api__l4shm.html">Shared Memory Library</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 Signals:</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__api__l4shmc__signal.svg" width="439" height="86"><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-groups" class="groupheader"><a id="groups" name="groups"></a>
Topics</h2></td></tr>
<tr class="memitem:api_5Fl4shmc_5Fsignal_5Fprod" id="r_api_5Fl4shmc_5Fsignal_5Fprod"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__prod.html">Producer </a></td></tr>
<tr class="memitem:api_5Fl4shmc_5Fsignal_5Fcons" id="r_api_5Fl4shmc_5Fsignal_5Fcons"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__signal__cons.html">Consumer </a></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:gae05b27f98a6e59a2a8aa6856d3f9425d" id="r_gae05b27f98a6e59a2a8aa6856d3f9425d"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae05b27f98a6e59a2a8aa6856d3f9425d">l4shmc_add_signal</a> (l4shmc_area_t *shmarea, char const *signal_name, l4shmc_signal_t *signal)</td></tr>
<tr class="memdesc:gae05b27f98a6e59a2a8aa6856d3f9425d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a signal for the shared memory area. <br /></td></tr>
<tr class="memitem:ga064c2b3e6a04900e35922d157b049232" id="r_ga064c2b3e6a04900e35922d157b049232"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga064c2b3e6a04900e35922d157b049232">l4shmc_attach_signal</a> (l4shmc_area_t *shmarea, char const *signal_name, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> thread, l4shmc_signal_t *signal)</td></tr>
<tr class="memdesc:ga064c2b3e6a04900e35922d157b049232"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach to signal. <br /></td></tr>
<tr class="memitem:ga4ebf2ff8f2041c71fe967582d6f9d622" id="r_ga4ebf2ff8f2041c71fe967582d6f9d622"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4ebf2ff8f2041c71fe967582d6f9d622">l4shmc_get_signal</a> (l4shmc_area_t *shmarea, char const *signal_name, l4shmc_signal_t *signal)</td></tr>
<tr class="memdesc:ga4ebf2ff8f2041c71fe967582d6f9d622"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get signal object from the shared memory area. <br /></td></tr>
<tr class="memitem:gaa5df3aab1bb149f8225136be03ad7ec8" id="r_gaa5df3aab1bb149f8225136be03ad7ec8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa5df3aab1bb149f8225136be03ad7ec8">l4shmc_signal_cap</a> (l4shmc_signal_t const *signal)</td></tr>
<tr class="memdesc:gaa5df3aab1bb149f8225136be03ad7ec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the signal capability of a signal. <br /></td></tr>
<tr class="memitem:gaca094c1631403a80b8202c1c03286410" id="r_gaca094c1631403a80b8202c1c03286410"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaca094c1631403a80b8202c1c03286410">l4shmc_check_magic</a> (l4shmc_chunk_t const *chunk)</td></tr>
<tr class="memdesc:gaca094c1631403a80b8202c1c03286410"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check magic value of a chunk. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="gae05b27f98a6e59a2a8aa6856d3f9425d" name="gae05b27f98a6e59a2a8aa6856d3f9425d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae05b27f98a6e59a2a8aa6856d3f9425d">&#9670;&#160;</a></span>l4shmc_add_signal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_add_signal </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>signal_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4shmc_signal_t *</td> <td class="paramname"><span class="paramname"><em>signal</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a signal for the shared memory area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">shmarea</td><td>The shared memory area. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">signal_name</td><td>Name of the signal. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">signal</td><td>Signal structure to fill in.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a5">examples/libs/shmc/prodcons.c</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#l00051">L4_INLINE</a>.</p>
</div>
</div>
<a id="ga064c2b3e6a04900e35922d157b049232" name="ga064c2b3e6a04900e35922d157b049232"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga064c2b3e6a04900e35922d157b049232">&#9670;&#160;</a></span>l4shmc_attach_signal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_attach_signal </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>signal_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></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>thread</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4shmc_signal_t *</td> <td class="paramname"><span class="paramname"><em>signal</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach to signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">shmarea</td><td>Shared memory area. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">signal_name</td><td>Name of the signal. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">thread</td><td>Thread capability index to attach the signal to. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">signal</td><td>Signal data structure to fill.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a6">examples/libs/shmc/prodcons.c</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>
<a id="gaca094c1631403a80b8202c1c03286410" name="gaca094c1631403a80b8202c1c03286410"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca094c1631403a80b8202c1c03286410">&#9670;&#160;</a></span>l4shmc_check_magic()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long l4shmc_check_magic </td>
<td>(</td>
<td class="paramtype">l4shmc_chunk_t const *</td> <td class="paramname"><span class="paramname"><em>chunk</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check magic value of a chunk. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chunk</td><td>Chunk.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Magic value is not valid. </td></tr>
<tr><td class="paramname">&gt;0</td><td>Chunk is OK, the magic value is valid. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="ga4ebf2ff8f2041c71fe967582d6f9d622" name="ga4ebf2ff8f2041c71fe967582d6f9d622"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ebf2ff8f2041c71fe967582d6f9d622">&#9670;&#160;</a></span>l4shmc_get_signal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long l4shmc_get_signal </td>
<td>(</td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>signal_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4shmc_signal_t *</td> <td class="paramname"><span class="paramname"><em>signal</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get signal object from the shared memory area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">shmarea</td><td>Shared memory area. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">signal_name</td><td>Name of the signal. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">signal</td><td>Signal data structure to fill.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
</div>
</div>
<a id="gaa5df3aab1bb149f8225136be03ad7ec8" name="gaa5df3aab1bb149f8225136be03ad7ec8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5df3aab1bb149f8225136be03ad7ec8">&#9670;&#160;</a></span>l4shmc_signal_cap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> l4shmc_signal_cap </td>
<td>(</td>
<td class="paramtype">l4shmc_signal_t const *</td> <td class="paramname"><span class="paramname"><em>signal</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the signal capability of a signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signal</td><td>Signal.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Capability of the signal object. </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#l00051">L4_INLINE</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>
Reference in New Issue View Git Blame Copy Permalink