teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

l4re-base-25.08.0

Browse Source
This commit is contained in:
Viktor Reusch
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

665
doc/source/html/ringbuf_8h.html Normal file
View File

@@ -0,0 +1,665 @@
<!-- 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/shmc/ringbuf.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('ringbuf_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">ringbuf.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="shmc_8h_source.html">l4/shmc/shmc.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="util_2assert_8h_source.html">l4/util/assert.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_2thread_8h_source.html">l4/sys/thread.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 ringbuf.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="ringbuf_8h__incl.svg" width="1015" height="550"><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="ringbuf_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:l4shmc_5Fringbuf_5Fhead_5Ft" id="r_l4shmc_5Fringbuf_5Fhead_5Ft"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Head field of a ring buffer. <a href="structl4shmc__ringbuf__head__t.html#details">More...</a><br /></td></tr>
<tr class="memitem:l4shmc_5Fringbuf_5Ft" id="r_l4shmc_5Fringbuf_5Ft"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ring buffer. <a href="structl4shmc__ringbuf__t.html#details">More...</a><br /></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:ga75dc43d355685aac61623e1e7d3c2d73" id="r_ga75dc43d355685aac61623e1e7d3c2d73"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm__ringbuf__internal.html#ga75dc43d355685aac61623e1e7d3c2d73">L4SHMC_RINGBUF_HEAD</a>(ringbuf)</td></tr>
<tr class="memdesc:ga75dc43d355685aac61623e1e7d3c2d73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get ring buffer head pointer. <br /></td></tr>
<tr class="memitem:gaad2b2ff15bf620c4fb587ef97c389a97" id="r_gaad2b2ff15bf620c4fb587ef97c389a97"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm__ringbuf__internal.html#gaad2b2ff15bf620c4fb587ef97c389a97">L4SHMC_RINGBUF_DATA</a>(ringbuf)</td></tr>
<tr class="memdesc:gaad2b2ff15bf620c4fb587ef97c389a97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get ring buffer data pointer. <br /></td></tr>
<tr class="memitem:ga110e33bc1a57463cc5e77372bf140fee" id="r_ga110e33bc1a57463cc5e77372bf140fee"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shm__ringbuf__internal.html#ga110e33bc1a57463cc5e77372bf140fee">L4SHMC_RINGBUF_DATA_SIZE</a>(ringbuf)</td></tr>
<tr class="memdesc:ga110e33bc1a57463cc5e77372bf140fee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get size of data area. <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:aa8e882c21e24feb6f20c4be02c11c313" id="r_aa8e882c21e24feb6f20c4be02c11c313"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8e882c21e24feb6f20c4be02c11c313">l4shmc_rb_init_buffer</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, l4shmc_area_t *area, char const *chunk_name, char const *signal_name, unsigned size)</td></tr>
<tr class="memdesc:aa8e882c21e24feb6f20c4be02c11c313"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a ring buffer by creating an SHMC chunk and the corresponding signals. <br /></td></tr>
<tr class="memitem:a4dcaf502abe1d08070ce59f384e90330" id="r_a4dcaf502abe1d08070ce59f384e90330"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4dcaf502abe1d08070ce59f384e90330">l4shmc_rb_deinit_buffer</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf)</td></tr>
<tr class="memdesc:a4dcaf502abe1d08070ce59f384e90330"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-init a ring buffer. <br /></td></tr>
<tr class="memitem:a2cecfddbe9f68848aa14cd9c0b5e2cb8" id="r_a2cecfddbe9f68848aa14cd9c0b5e2cb8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2cecfddbe9f68848aa14cd9c0b5e2cb8">l4shmc_rb_attach_sender</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, char const *signal_name, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> owner)</td></tr>
<tr class="memdesc:a2cecfddbe9f68848aa14cd9c0b5e2cb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach to sender signal of a ring buffer. <br /></td></tr>
<tr class="memitem:a2c68578859e87f953c52c8fe156758ea" id="r_a2c68578859e87f953c52c8fe156758ea"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c68578859e87f953c52c8fe156758ea">l4shmc_rb_sender_alloc_packet</a> (<a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head, unsigned psize)</td></tr>
<tr class="memdesc:a2c68578859e87f953c52c8fe156758ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a packet of a given size within the ring buffer. <br /></td></tr>
<tr class="memitem:ae107e455abc31164a63faef3bda193f0" id="r_ae107e455abc31164a63faef3bda193f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae107e455abc31164a63faef3bda193f0">l4shmc_rb_sender_put_data</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, char *addr, char *data, unsigned dsize)</td></tr>
<tr class="memdesc:ae107e455abc31164a63faef3bda193f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy data into a previously allocated packet. <br /></td></tr>
<tr class="memitem:ac9293e26d9f56811c83a3a2a4b13e4b8" id="r_ac9293e26d9f56811c83a3a2a4b13e4b8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9293e26d9f56811c83a3a2a4b13e4b8">l4shmc_rb_sender_next_copy_in</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, char *data, unsigned size, int block_if_necessary)</td></tr>
<tr class="memdesc:ac9293e26d9f56811c83a3a2a4b13e4b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy in packet from an external data source. <br /></td></tr>
<tr class="memitem:a067b3060edda0c1183fadc7d85581f8c" id="r_a067b3060edda0c1183fadc7d85581f8c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a067b3060edda0c1183fadc7d85581f8c">l4shmc_rb_sender_commit_packet</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf)</td></tr>
<tr class="memdesc:a067b3060edda0c1183fadc7d85581f8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell the consumer that new data is available. <br /></td></tr>
<tr class="memitem:a640fa0f85fb48f0abf08050d1e7146ef" id="r_a640fa0f85fb48f0abf08050d1e7146ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a640fa0f85fb48f0abf08050d1e7146ef">l4shmc_rb_init_receiver</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, l4shmc_area_t *area, char const *chunk_name, char const *signal_name)</td></tr>
<tr class="memdesc:a640fa0f85fb48f0abf08050d1e7146ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize receive buffer. <br /></td></tr>
<tr class="memitem:a3c648282472c29b707914c41de240994" id="r_a3c648282472c29b707914c41de240994"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c648282472c29b707914c41de240994">l4shmc_rb_attach_receiver</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> owner)</td></tr>
<tr class="memdesc:a3c648282472c29b707914c41de240994"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach to receiver signal of a ring buffer. <br /></td></tr>
<tr class="memitem:a9663fd56713d5676e7a3b4913a156243" id="r_a9663fd56713d5676e7a3b4913a156243"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9663fd56713d5676e7a3b4913a156243">l4shmc_rb_receiver_wait_for_data</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, int blocking)</td></tr>
<tr class="memdesc:a9663fd56713d5676e7a3b4913a156243"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if (and optionally block until) new data is ready. <br /></td></tr>
<tr class="memitem:a48cf63519da43e07ba6df3fc4c15f151" id="r_a48cf63519da43e07ba6df3fc4c15f151"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a48cf63519da43e07ba6df3fc4c15f151">l4shmc_rb_receiver_copy_out</a> (<a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head, char *target, unsigned *tsize)</td></tr>
<tr class="memdesc:a48cf63519da43e07ba6df3fc4c15f151"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy data out of the buffer. <br /></td></tr>
<tr class="memitem:ad4cc4e9b7197077819945e3256eb6254" id="r_ad4cc4e9b7197077819945e3256eb6254"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad4cc4e9b7197077819945e3256eb6254">l4shmc_rb_receiver_notify_done</a> (<a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf)</td></tr>
<tr class="memdesc:ad4cc4e9b7197077819945e3256eb6254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify producer that space is available. <br /></td></tr>
<tr class="memitem:abbfdfa3474442e1b250a0a59eb5bac7d" id="r_abbfdfa3474442e1b250a0a59eb5bac7d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abbfdfa3474442e1b250a0a59eb5bac7d">l4shmc_rb_receiver_read_next_size</a> (<a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head)</td></tr>
<tr class="memdesc:abbfdfa3474442e1b250a0a59eb5bac7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Have a look at the ring buffer and see which size the next packet to be read has. <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="a3c648282472c29b707914c41de240994" name="a3c648282472c29b707914c41de240994"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c648282472c29b707914c41de240994">&#9670;&#160;</a></span>l4shmc_rb_attach_receiver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void l4shmc_rb_attach_receiver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</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>owner</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach to receiver signal of a ring buffer. </p>
<p>Attach owner to the receiver-side signal of a ring buffer, which is triggered whenever new data has been produced.</p>
<p>This is split from initialization, because you may not know the owner cap when initializing the buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </td></tr>
<tr><td class="paramname">owner</td><td>owner thread </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="a2cecfddbe9f68848aa14cd9c0b5e2cb8" name="a2cecfddbe9f68848aa14cd9c0b5e2cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cecfddbe9f68848aa14cd9c0b5e2cb8">&#9670;&#160;</a></span>l4shmc_rb_attach_sender()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4shmc_rb_attach_sender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</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>owner</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attach to sender signal of a ring buffer. </p>
<p>Attach owner to the sender-side signal of a ring buffer, which is triggered whenever new space has been freed in the buffer for the sender to write to.</p>
<p>This is split from initialization, because you may not know the owner cap when initializing the buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </td></tr>
<tr><td class="paramname">signal_name</td><td>signal base name </td></tr>
<tr><td class="paramname">owner</td><td>owner thread</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error otherwise </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="a4dcaf502abe1d08070ce59f384e90330" name="a4dcaf502abe1d08070ce59f384e90330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dcaf502abe1d08070ce59f384e90330">&#9670;&#160;</a></span>l4shmc_rb_deinit_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void l4shmc_rb_deinit_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-init a ring buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </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="aa8e882c21e24feb6f20c4be02c11c313" name="aa8e882c21e24feb6f20c4be02c11c313"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8e882c21e24feb6f20c4be02c11c313">&#9670;&#160;</a></span>l4shmc_rb_init_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4shmc_rb_init_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>area</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>chunk_name</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">unsigned</td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a ring buffer by creating an SHMC chunk and the corresponding signals. </p>
<p>This needs to be done by one of the participating parties when setting up communication channel.</p>
<dl class="section pre"><dt>Precondition</dt><dd>area has been attached using <a class="el" href="group__api__l4shm.html#gabce1c28a48bc887ebd2923681ab524b2" title="Attach to a shared memory area.">l4shmc_attach()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </td></tr>
<tr><td class="paramname">area</td><td>pointer to SHMC area </td></tr>
<tr><td class="paramname">chunk_name</td><td>name of SHMC chunk to create in area </td></tr>
<tr><td class="paramname">signal_name</td><td>base name for SHMC signals to create </td></tr>
<tr><td class="paramname">size</td><td>chunk size</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error otherwise </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="a640fa0f85fb48f0abf08050d1e7146ef" name="a640fa0f85fb48f0abf08050d1e7146ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a640fa0f85fb48f0abf08050d1e7146ef">&#9670;&#160;</a></span>l4shmc_rb_init_receiver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4shmc_rb_init_receiver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>area</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>chunk_name</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize receive buffer. </p>
<p>Initialize the receiver-side of a ring buffer. This requires the underlying SHMC chunk and the corresponding signals to be valid already (read: to be initialized by the sender).</p>
<dl class="section pre"><dt>Precondition</dt><dd>chunk &amp; signals have been created and initialized by the sender side</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </td></tr>
<tr><td class="paramname">area</td><td>pointer to SHMC area </td></tr>
<tr><td class="paramname">chunk_name</td><td>name of SHMC chunk to create in area </td></tr>
<tr><td class="paramname">signal_name</td><td>base name for SHMC signals to create</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error otherwise </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="a48cf63519da43e07ba6df3fc4c15f151" name="a48cf63519da43e07ba6df3fc4c15f151"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48cf63519da43e07ba6df3fc4c15f151">&#9670;&#160;</a></span>l4shmc_rb_receiver_copy_out()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4shmc_rb_receiver_copy_out </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *</td> <td class="paramname"><span class="paramname"><em>head</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>target</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>tsize</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy data out of the buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">head</td><td>ring buffer head pointer </td></tr>
<tr><td class="paramdir"></td><td class="paramname">target</td><td>valid target buffer </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">tsize</td><td>size of target buffer (must be &gt;= packet size!); contains the real data size </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, negative error otherwise </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="ad4cc4e9b7197077819945e3256eb6254" name="ad4cc4e9b7197077819945e3256eb6254"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4cc4e9b7197077819945e3256eb6254">&#9670;&#160;</a></span>l4shmc_rb_receiver_notify_done()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void l4shmc_rb_receiver_notify_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notify producer that space is available. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </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="abbfdfa3474442e1b250a0a59eb5bac7d" name="abbfdfa3474442e1b250a0a59eb5bac7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbfdfa3474442e1b250a0a59eb5bac7d">&#9670;&#160;</a></span>l4shmc_rb_receiver_read_next_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4shmc_rb_receiver_read_next_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *</td> <td class="paramname"><span class="paramname"><em>head</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Have a look at the ring buffer and see which size the next packet to be read has. </p>
<p>Does not modify anything.</p>
<dl class="section return"><dt>Returns</dt><dd>size of next buffer or -1 if no data available </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="a9663fd56713d5676e7a3b4913a156243" name="a9663fd56713d5676e7a3b4913a156243"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9663fd56713d5676e7a3b4913a156243">&#9670;&#160;</a></span>l4shmc_rb_receiver_wait_for_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4shmc_rb_receiver_wait_for_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>blocking</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if (and optionally block until) new data is ready. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </td></tr>
<tr><td class="paramname">blocking</td><td>block if data is not available immediately</td></tr>
</table>
</dd>
</dl>
<p>Returns immediately, if data is available.</p>
<dl class="section return"><dt>Returns</dt><dd>0 success, data available, != 0 otherwise </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="a2c68578859e87f953c52c8fe156758ea" name="a2c68578859e87f953c52c8fe156758ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c68578859e87f953c52c8fe156758ea">&#9670;&#160;</a></span>l4shmc_rb_sender_alloc_packet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * l4shmc_rb_sender_alloc_packet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *</td> <td class="paramname"><span class="paramname"><em>head</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>psize</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a packet of a given size within the ring buffer. </p>
<p>This packet may wrap around at the end of the buffer. Users need to be aware of that.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">head</td><td>ring buffer head pointer </td></tr>
<tr><td class="paramname">psize</td><td>packet size</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>valid address on success </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">NULL</td><td>if not enough space available </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="a067b3060edda0c1183fadc7d85581f8c" name="a067b3060edda0c1183fadc7d85581f8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a067b3060edda0c1183fadc7d85581f8c">&#9670;&#160;</a></span>l4shmc_rb_sender_commit_packet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void l4shmc_rb_sender_commit_packet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the consumer that new data is available. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </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="ac9293e26d9f56811c83a3a2a4b13e4b8" name="ac9293e26d9f56811c83a3a2a4b13e4b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9293e26d9f56811c83a3a2a4b13e4b8">&#9670;&#160;</a></span>l4shmc_rb_sender_next_copy_in()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int l4shmc_rb_sender_next_copy_in </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>block_if_necessary</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy in packet from an external data source. </p>
<p>This is the function you'll want to use. Just pass it a buffer pointer and let the lib do the work.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </td></tr>
<tr><td class="paramname">data</td><td>valid buffer </td></tr>
<tr><td class="paramname">size</td><td>data size </td></tr>
<tr><td class="paramname">block_if_necessary</td><td>bool: block if buffer currently full</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success </td></tr>
<tr><td class="paramname">-L4_ENOMEM</td><td>if block == false and no space available </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="ae107e455abc31164a63faef3bda193f0" name="ae107e455abc31164a63faef3bda193f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae107e455abc31164a63faef3bda193f0">&#9670;&#160;</a></span>l4shmc_rb_sender_put_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void l4shmc_rb_sender_put_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *</td> <td class="paramname"><span class="paramname"><em>buf</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>addr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>dsize</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy data into a previously allocated packet. </p>
<p>This function is wrap-around aware.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>pointer to ring buffer struct </td></tr>
<tr><td class="paramname">addr</td><td>valid destination (allocate with alloc_packet()) </td></tr>
<tr><td class="paramname">data</td><td>data source </td></tr>
<tr><td class="paramname">dsize</td><td>data size </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>
</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>shmc</b></li><li class="navelem"><a href="ringbuf_8h.html">ringbuf.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>