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

312 lines
49 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: l4/shmc/ringbuf.h Source File</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_source.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</div></div>
</div><!--header-->
<div class="contents">
<a href="ringbuf_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * (c) 2010 Björn Döbel &lt;doebel@os.inf.tu-dresden.de&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * economic rights: Technische Universität Dresden (Germany)</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * This file is part of TUD:OS and distributed under the terms of the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * GNU Lesser General Public License 2.1.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * Please see the COPYING-LGPL-2.1 file for details.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;<a class="code" href="shmc_8h.html">l4/shmc/shmc.h</a>&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &lt;<a class="code" href="util_2assert_8h.html">l4/util/assert.h</a>&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;<a class="code" href="compiler_8h.html">l4/sys/compiler.h</a>&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;<a class="code" href="l4_2sys_2thread_8h.html">l4/sys/thread.h</a>&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><a class="code hl_define" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">/*</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * Turn on ringbuf poisoning. This will add magic values to the ringbuf</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * header as well as each packet header and check that these values are</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * valid all the time.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> */</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#define L4SHMC_RINGBUF_POISONING 1</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span></div>
<div class="foldopen" id="foldopen00059" data-start="{" data-end="};">
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__head__t.html"> 59</a></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>{</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__l4__basic__types.html#gac1d09f3e382e711b776931f10e6e1e5a">l4_uint32_t</a> lock;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">unsigned</span> data_size;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#if L4SHMC_RINGBUF_POISONING</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">char</span> magic1;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__head__t.html#a57864542886b78981e32fc82854143fe"> 66</a></span> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="structl4shmc__ringbuf__head__t.html#a57864542886b78981e32fc82854143fe">next_read</a>; </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__head__t.html#a64b27ee32a4c9ad27de2ac063d8852a8"> 67</a></span> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="structl4shmc__ringbuf__head__t.html#a64b27ee32a4c9ad27de2ac063d8852a8">next_write</a>; </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#if L4SHMC_RINGBUF_POISONING</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">char</span> magic2;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__head__t.html#aa977bd0fc13e54d03620ea3d3abebfe5"> 71</a></span> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="structl4shmc__ringbuf__head__t.html#aa977bd0fc13e54d03620ea3d3abebfe5">bytes_filled</a>; </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__head__t.html#a046fe5362d1873a9476c457357689c16"> 72</a></span> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="structl4shmc__ringbuf__head__t.html#a046fe5362d1873a9476c457357689c16">sender_waits</a>; </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="preprocessor">#if L4SHMC_RINGBUF_POISONING</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">char</span> magic3;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__head__t.html#a6cc78713c78ac00cf2660d1ed4e03be5"> 76</a></span> <span class="keywordtype">char</span> <a class="code hl_variable" href="structl4shmc__ringbuf__head__t.html#a6cc78713c78ac00cf2660d1ed4e03be5">data</a>[]; </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>} <a class="code hl_struct" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a>;</div>
</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span></div>
<div class="foldopen" id="foldopen00085" data-start="{" data-end="};">
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html"> 85</a></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>{</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a382c625788eb10a55ffdcfac73f9cf3d"> 87</a></span> l4shmc_area_t *<a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a382c625788eb10a55ffdcfac73f9cf3d">_area</a>; </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a597c7952cb89dc695330096bcea8d165"> 88</a></span> <a class="code hl_typedef" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> <a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a597c7952cb89dc695330096bcea8d165">_owner</a>; </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a3862bfc8e3336eabc1bd7bd92d376143"> 89</a></span> l4shmc_chunk_t <a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a3862bfc8e3336eabc1bd7bd92d376143">_chunk</a>; </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a66f84d52e916ec45c49837dc0d68eee9"> 90</a></span> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a66f84d52e916ec45c49837dc0d68eee9">_size</a>; </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a97e53b757b1ba7ed92a4ecd05f269223"> 91</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a97e53b757b1ba7ed92a4ecd05f269223">_chunkname</a>; </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a2ce44d3c35cf8e541d933b0a1580b594"> 92</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a2ce44d3c35cf8e541d933b0a1580b594">_signame</a>; </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a527d7c00a87b135908a6c578f2a43969"> 93</a></span> <a class="code hl_struct" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *<a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a527d7c00a87b135908a6c578f2a43969">_addr</a>; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#a50a33214a3a63c74386d7e85d0f5b6bf"> 94</a></span> l4shmc_signal_t <a class="code hl_variable" href="structl4shmc__ringbuf__t.html#a50a33214a3a63c74386d7e85d0f5b6bf">_signal_full</a>; </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="structl4shmc__ringbuf__t.html#ae833494bf78923e982bbc8da08cc512f"> 95</a></span> l4shmc_signal_t <a class="code hl_variable" href="structl4shmc__ringbuf__t.html#ae833494bf78923e982bbc8da08cc512f">_signal_empty</a>; </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>} <a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a>;</div>
</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="group__api__l4shm__ringbuf__internal.html#ga75dc43d355685aac61623e1e7d3c2d73"> 105</a></span><span class="preprocessor">#define L4SHMC_RINGBUF_HEAD(ringbuf) ((l4shmc_ringbuf_head_t*)((ringbuf)-&gt;_addr))</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="group__api__l4shm__ringbuf__internal.html#gaad2b2ff15bf620c4fb587ef97c389a97"> 114</a></span><span class="preprocessor">#define L4SHMC_RINGBUF_DATA(ringbuf) (L4SHMC_RINGBUF_HEAD(ringbuf)-&gt;data)</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="group__api__l4shm__ringbuf__internal.html#ga110e33bc1a57463cc5e77372bf140fee"> 123</a></span><span class="preprocessor">#define L4SHMC_RINGBUF_DATA_SIZE(ringbuf) ((ringbuf)-&gt;_size - sizeof(l4shmc_ringbuf_head_t))</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="keyword">enum</span> lock_content</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>{</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> lock_cont_min = 4,</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> locked = 5,</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> unlocked = 6,</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> lock_cont_max = 7,</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>};</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="keyword">static</span> <a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> l4shmc_rb_lock(<a class="code hl_struct" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head)</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>{</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> ASSERT_NOT_NULL(head);</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> ASSERT_ASSERT(head-&gt;lock &gt; lock_cont_min);</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> ASSERT_ASSERT(head-&gt;lock &lt; lock_cont_max);</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordflow">while</span> (!<a class="code hl_function" href="group__l4util__atomic.html#ga8fabd69989ed49da101f8806e3e95567">l4util_cmpxchg32</a>(&amp;head-&gt;lock, unlocked, locked))</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <a class="code hl_function" href="group__l4__thread__api.html#ga5e47131f486f920826b5f72dad82bafe">l4_thread_yield</a>();</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span>}</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="keyword">static</span> <a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> l4shmc_rb_unlock(<a class="code hl_struct" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head)</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span>{</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> ASSERT_NOT_NULL(head);</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> ASSERT_ASSERT(head-&gt;lock &gt; lock_cont_min);</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> ASSERT_ASSERT(head-&gt;lock &lt; lock_cont_max);</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> head-&gt;lock = unlocked;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span>}</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span><span class="comment">/******************</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span><span class="comment"> * Initialization *</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span><span class="comment"> ******************/</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#aa8e882c21e24feb6f20c4be02c11c313"> 173</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">int</span> <a class="code hl_function" href="ringbuf_8h.html#aa8e882c21e24feb6f20c4be02c11c313">l4shmc_rb_init_buffer</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, l4shmc_area_t *area,</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *chunk_name,</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *signal_name, <span class="keywordtype">unsigned</span> size);</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a4dcaf502abe1d08070ce59f384e90330"> 182</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">void</span> <a class="code hl_function" href="ringbuf_8h.html#a4dcaf502abe1d08070ce59f384e90330">l4shmc_rb_deinit_buffer</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf);</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> </div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span><span class="comment">/***************************</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span><span class="comment"> * RINGBUF SENDER *</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span><span class="comment"> ***************************/</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a2cecfddbe9f68848aa14cd9c0b5e2cb8"> 206</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">int</span> <a class="code hl_function" href="ringbuf_8h.html#a2cecfddbe9f68848aa14cd9c0b5e2cb8">l4shmc_rb_attach_sender</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, <span class="keywordtype">char</span> <span class="keyword">const</span> *signal_name,</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <a class="code hl_typedef" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> owner);</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> </div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a2c68578859e87f953c52c8fe156758ea"> 222</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">char</span> *<a class="code hl_function" href="ringbuf_8h.html#a2c68578859e87f953c52c8fe156758ea">l4shmc_rb_sender_alloc_packet</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head,</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <span class="keywordtype">unsigned</span> psize);</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#ae107e455abc31164a63faef3bda193f0"> 236</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">void</span> <a class="code hl_function" href="ringbuf_8h.html#ae107e455abc31164a63faef3bda193f0">l4shmc_rb_sender_put_data</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, <span class="keywordtype">char</span> *addr,</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> dsize);</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> </div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#ac9293e26d9f56811c83a3a2a4b13e4b8"> 254</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">int</span> <a class="code hl_function" href="ringbuf_8h.html#ac9293e26d9f56811c83a3a2a4b13e4b8">l4shmc_rb_sender_next_copy_in</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, <span class="keywordtype">char</span> *data,</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> <span class="keywordtype">unsigned</span> size, <span class="keywordtype">int</span> block_if_necessary);</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> </div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a067b3060edda0c1183fadc7d85581f8c"> 263</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">void</span> <a class="code hl_function" href="ringbuf_8h.html#a067b3060edda0c1183fadc7d85581f8c">l4shmc_rb_sender_commit_packet</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf);</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> </div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> </div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span><span class="comment">/***************************</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span><span class="comment"> * RINGBUF RECEIVER *</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span><span class="comment"> ***************************/</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a640fa0f85fb48f0abf08050d1e7146ef"> 286</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">int</span> <a class="code hl_function" href="ringbuf_8h.html#a640fa0f85fb48f0abf08050d1e7146ef">l4shmc_rb_init_receiver</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, l4shmc_area_t *area,</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *chunk_name,</div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *signal_name);</div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span> </div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a3c648282472c29b707914c41de240994"> 303</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">void</span> <a class="code hl_function" href="ringbuf_8h.html#a3c648282472c29b707914c41de240994">l4shmc_rb_attach_receiver</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, <a class="code hl_typedef" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> owner);</div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno"> 304</span> </div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno"> 305</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a9663fd56713d5676e7a3b4913a156243"> 316</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">int</span> <a class="code hl_function" href="ringbuf_8h.html#a9663fd56713d5676e7a3b4913a156243">l4shmc_rb_receiver_wait_for_data</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf, <span class="keywordtype">int</span> blocking);</div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span> </div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#a48cf63519da43e07ba6df3fc4c15f151"> 328</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">int</span> <a class="code hl_function" href="ringbuf_8h.html#a48cf63519da43e07ba6df3fc4c15f151">l4shmc_rb_receiver_copy_out</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head, <span class="keywordtype">char</span> *target,</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <span class="keywordtype">unsigned</span> *tsize);</div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> </div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#ad4cc4e9b7197077819945e3256eb6254"> 337</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">void</span> <a class="code hl_function" href="ringbuf_8h.html#ad4cc4e9b7197077819945e3256eb6254">l4shmc_rb_receiver_notify_done</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a> *buf);</div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span> </div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno"><a class="line" href="ringbuf_8h.html#abbfdfa3474442e1b250a0a59eb5bac7d"> 346</a></span><a class="code hl_define" href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a> <span class="keywordtype">int</span> <a class="code hl_function" href="ringbuf_8h.html#abbfdfa3474442e1b250a0a59eb5bac7d">l4shmc_rb_receiver_read_next_size</a>(<a class="code hl_struct" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> *head);</div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno"> 347</span> </div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno"> 348</span><a class="code hl_define" href="group__l4sys__defines.html#ga7b3d88f2118cbb7b8057a860dbdd0381">L4_END_DECLS</a></div>
<div class="ttc" id="acompiler_8h_html"><div class="ttname"><a href="compiler_8h.html">compiler.h</a></div><div class="ttdoc">L4 compiler related defines.</div></div>
<div class="ttc" id="agroup__l4__basic__types_html_gac1d09f3e382e711b776931f10e6e1e5a"><div class="ttname"><a href="group__l4__basic__types.html#gac1d09f3e382e711b776931f10e6e1e5a">l4_uint32_t</a></div><div class="ttdeci">unsigned int l4_uint32_t</div><div class="ttdoc">Unsigned 32bit value.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2l4int_8h_source.html#l00029">l4int.h:29</a></div></div>
<div class="ttc" id="agroup__l4__cap__api_html_ga1445e923ce73029130d569d6e69a4dd8"><div class="ttname"><a href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></div><div class="ttdeci">unsigned long l4_cap_idx_t</div><div class="ttdoc">Capability selector type.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2types_8h_source.html#l00336">types.h:336</a></div></div>
<div class="ttc" id="agroup__l4__thread__api_html_ga5e47131f486f920826b5f72dad82bafe"><div class="ttname"><a href="group__l4__thread__api.html#ga5e47131f486f920826b5f72dad82bafe">l4_thread_yield</a></div><div class="ttdeci">l4_msgtag_t l4_thread_yield(void) L4_NOTHROW</div><div class="ttdoc">Yield current time slice.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2thread_8h_source.html#l00891">thread.h:891</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga2469cd44710705e9f0a5832e060ec48a"><div class="ttname"><a href="group__l4sys__defines.html#ga2469cd44710705e9f0a5832e060ec48a">L4_CV</a></div><div class="ttdeci">#define L4_CV</div><div class="ttdoc">Define calling convention.</div><div class="ttdef"><b>Definition</b> <a href="arm_2l4_2sys_2linkage_8h_source.html#l00033">linkage.h:33</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga5f022ce5422df9cc6ed415e2bfc90f59"><div class="ttname"><a href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a></div><div class="ttdeci">#define L4_BEGIN_DECLS</div><div class="ttdoc">Start section with C types and functions.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00165">compiler.h:165</a></div></div>
<div class="ttc" id="agroup__l4sys__defines_html_ga7b3d88f2118cbb7b8057a860dbdd0381"><div class="ttname"><a href="group__l4sys__defines.html#ga7b3d88f2118cbb7b8057a860dbdd0381">L4_END_DECLS</a></div><div class="ttdeci">#define L4_END_DECLS</div><div class="ttdoc">End section with C types and functions.</div><div class="ttdef"><b>Definition</b> <a href="compiler_8h_source.html#l00166">compiler.h:166</a></div></div>
<div class="ttc" id="agroup__l4util__atomic_html_ga8fabd69989ed49da101f8806e3e95567"><div class="ttname"><a href="group__l4util__atomic.html#ga8fabd69989ed49da101f8806e3e95567">l4util_cmpxchg32</a></div><div class="ttdeci">int l4util_cmpxchg32(volatile l4_uint32_t *dest, l4_uint32_t cmp_val, l4_uint32_t new_val)</div><div class="ttdoc">Atomic compare and exchange (32 bit version).</div><div class="ttdef"><b>Definition</b> <a href="l4_2util_2atomic_8h_source.html#l00355">atomic.h:355</a></div></div>
<div class="ttc" id="al4_2sys_2thread_8h_html"><div class="ttname"><a href="l4_2sys_2thread_8h.html">thread.h</a></div><div class="ttdoc">Common thread related definitions.</div></div>
<div class="ttc" id="aringbuf_8h_html_a067b3060edda0c1183fadc7d85581f8c"><div class="ttname"><a href="ringbuf_8h.html#a067b3060edda0c1183fadc7d85581f8c">l4shmc_rb_sender_commit_packet</a></div><div class="ttdeci">void l4shmc_rb_sender_commit_packet(l4shmc_ringbuf_t *buf)</div><div class="ttdoc">Tell the consumer that new data is available.</div></div>
<div class="ttc" id="aringbuf_8h_html_a2c68578859e87f953c52c8fe156758ea"><div class="ttname"><a href="ringbuf_8h.html#a2c68578859e87f953c52c8fe156758ea">l4shmc_rb_sender_alloc_packet</a></div><div class="ttdeci">char * l4shmc_rb_sender_alloc_packet(l4shmc_ringbuf_head_t *head, unsigned psize)</div><div class="ttdoc">Allocate a packet of a given size within the ring buffer.</div></div>
<div class="ttc" id="aringbuf_8h_html_a2cecfddbe9f68848aa14cd9c0b5e2cb8"><div class="ttname"><a href="ringbuf_8h.html#a2cecfddbe9f68848aa14cd9c0b5e2cb8">l4shmc_rb_attach_sender</a></div><div class="ttdeci">int l4shmc_rb_attach_sender(l4shmc_ringbuf_t *buf, char const *signal_name, l4_cap_idx_t owner)</div><div class="ttdoc">Attach to sender signal of a ring buffer.</div></div>
<div class="ttc" id="aringbuf_8h_html_a3c648282472c29b707914c41de240994"><div class="ttname"><a href="ringbuf_8h.html#a3c648282472c29b707914c41de240994">l4shmc_rb_attach_receiver</a></div><div class="ttdeci">void l4shmc_rb_attach_receiver(l4shmc_ringbuf_t *buf, l4_cap_idx_t owner)</div><div class="ttdoc">Attach to receiver signal of a ring buffer.</div></div>
<div class="ttc" id="aringbuf_8h_html_a48cf63519da43e07ba6df3fc4c15f151"><div class="ttname"><a href="ringbuf_8h.html#a48cf63519da43e07ba6df3fc4c15f151">l4shmc_rb_receiver_copy_out</a></div><div class="ttdeci">int l4shmc_rb_receiver_copy_out(l4shmc_ringbuf_head_t *head, char *target, unsigned *tsize)</div><div class="ttdoc">Copy data out of the buffer.</div></div>
<div class="ttc" id="aringbuf_8h_html_a4dcaf502abe1d08070ce59f384e90330"><div class="ttname"><a href="ringbuf_8h.html#a4dcaf502abe1d08070ce59f384e90330">l4shmc_rb_deinit_buffer</a></div><div class="ttdeci">void l4shmc_rb_deinit_buffer(l4shmc_ringbuf_t *buf)</div><div class="ttdoc">De-init a ring buffer.</div></div>
<div class="ttc" id="aringbuf_8h_html_a640fa0f85fb48f0abf08050d1e7146ef"><div class="ttname"><a href="ringbuf_8h.html#a640fa0f85fb48f0abf08050d1e7146ef">l4shmc_rb_init_receiver</a></div><div class="ttdeci">int l4shmc_rb_init_receiver(l4shmc_ringbuf_t *buf, l4shmc_area_t *area, char const *chunk_name, char const *signal_name)</div><div class="ttdoc">Initialize receive buffer.</div></div>
<div class="ttc" id="aringbuf_8h_html_a9663fd56713d5676e7a3b4913a156243"><div class="ttname"><a href="ringbuf_8h.html#a9663fd56713d5676e7a3b4913a156243">l4shmc_rb_receiver_wait_for_data</a></div><div class="ttdeci">int l4shmc_rb_receiver_wait_for_data(l4shmc_ringbuf_t *buf, int blocking)</div><div class="ttdoc">Check if (and optionally block until) new data is ready.</div></div>
<div class="ttc" id="aringbuf_8h_html_aa8e882c21e24feb6f20c4be02c11c313"><div class="ttname"><a href="ringbuf_8h.html#aa8e882c21e24feb6f20c4be02c11c313">l4shmc_rb_init_buffer</a></div><div class="ttdeci">int l4shmc_rb_init_buffer(l4shmc_ringbuf_t *buf, l4shmc_area_t *area, char const *chunk_name, char const *signal_name, unsigned size)</div><div class="ttdoc">Initialize a ring buffer by creating an SHMC chunk and the corresponding signals.</div></div>
<div class="ttc" id="aringbuf_8h_html_abbfdfa3474442e1b250a0a59eb5bac7d"><div class="ttname"><a href="ringbuf_8h.html#abbfdfa3474442e1b250a0a59eb5bac7d">l4shmc_rb_receiver_read_next_size</a></div><div class="ttdeci">int l4shmc_rb_receiver_read_next_size(l4shmc_ringbuf_head_t *head)</div><div class="ttdoc">Have a look at the ring buffer and see which size the next packet to be read has.</div></div>
<div class="ttc" id="aringbuf_8h_html_ac9293e26d9f56811c83a3a2a4b13e4b8"><div class="ttname"><a href="ringbuf_8h.html#ac9293e26d9f56811c83a3a2a4b13e4b8">l4shmc_rb_sender_next_copy_in</a></div><div class="ttdeci">int l4shmc_rb_sender_next_copy_in(l4shmc_ringbuf_t *buf, char *data, unsigned size, int block_if_necessary)</div><div class="ttdoc">Copy in packet from an external data source.</div></div>
<div class="ttc" id="aringbuf_8h_html_ad4cc4e9b7197077819945e3256eb6254"><div class="ttname"><a href="ringbuf_8h.html#ad4cc4e9b7197077819945e3256eb6254">l4shmc_rb_receiver_notify_done</a></div><div class="ttdeci">void l4shmc_rb_receiver_notify_done(l4shmc_ringbuf_t *buf)</div><div class="ttdoc">Notify producer that space is available.</div></div>
<div class="ttc" id="aringbuf_8h_html_ae107e455abc31164a63faef3bda193f0"><div class="ttname"><a href="ringbuf_8h.html#ae107e455abc31164a63faef3bda193f0">l4shmc_rb_sender_put_data</a></div><div class="ttdeci">void l4shmc_rb_sender_put_data(l4shmc_ringbuf_t *buf, char *addr, char *data, unsigned dsize)</div><div class="ttdoc">Copy data into a previously allocated packet.</div></div>
<div class="ttc" id="ashmc_8h_html"><div class="ttname"><a href="shmc_8h.html">shmc.h</a></div><div class="ttdoc">Shared memory library header file.</div></div>
<div class="ttc" id="astructl4shmc__ringbuf__head__t_html"><div class="ttname"><a href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a></div><div class="ttdoc">Head field of a ring buffer.</div><div class="ttdef"><b>Definition</b> <a href="#l00059">ringbuf.h:60</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__head__t_html_a046fe5362d1873a9476c457357689c16"><div class="ttname"><a href="structl4shmc__ringbuf__head__t.html#a046fe5362d1873a9476c457357689c16">l4shmc_ringbuf_head_t::sender_waits</a></div><div class="ttdeci">unsigned sender_waits</div><div class="ttdoc">sender waiting?</div><div class="ttdef"><b>Definition</b> <a href="#l00072">ringbuf.h:72</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__head__t_html_a57864542886b78981e32fc82854143fe"><div class="ttname"><a href="structl4shmc__ringbuf__head__t.html#a57864542886b78981e32fc82854143fe">l4shmc_ringbuf_head_t::next_read</a></div><div class="ttdeci">unsigned next_read</div><div class="ttdoc">offset to next read packet</div><div class="ttdef"><b>Definition</b> <a href="#l00066">ringbuf.h:66</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__head__t_html_a64b27ee32a4c9ad27de2ac063d8852a8"><div class="ttname"><a href="structl4shmc__ringbuf__head__t.html#a64b27ee32a4c9ad27de2ac063d8852a8">l4shmc_ringbuf_head_t::next_write</a></div><div class="ttdeci">unsigned next_write</div><div class="ttdoc">offset to next write packet</div><div class="ttdef"><b>Definition</b> <a href="#l00067">ringbuf.h:67</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__head__t_html_a6cc78713c78ac00cf2660d1ed4e03be5"><div class="ttname"><a href="structl4shmc__ringbuf__head__t.html#a6cc78713c78ac00cf2660d1ed4e03be5">l4shmc_ringbuf_head_t::data</a></div><div class="ttdeci">char data[]</div><div class="ttdoc">tail pointer -&gt; data</div><div class="ttdef"><b>Definition</b> <a href="#l00076">ringbuf.h:76</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__head__t_html_aa977bd0fc13e54d03620ea3d3abebfe5"><div class="ttname"><a href="structl4shmc__ringbuf__head__t.html#aa977bd0fc13e54d03620ea3d3abebfe5">l4shmc_ringbuf_head_t::bytes_filled</a></div><div class="ttdeci">unsigned bytes_filled</div><div class="ttdoc">bytes filled in buffer</div><div class="ttdef"><b>Definition</b> <a href="#l00071">ringbuf.h:71</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html"><div class="ttname"><a href="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</a></div><div class="ttdoc">Ring buffer.</div><div class="ttdef"><b>Definition</b> <a href="#l00085">ringbuf.h:86</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a2ce44d3c35cf8e541d933b0a1580b594"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a2ce44d3c35cf8e541d933b0a1580b594">l4shmc_ringbuf_t::_signame</a></div><div class="ttdeci">char * _signame</div><div class="ttdoc">base name of the ring buffer signals</div><div class="ttdef"><b>Definition</b> <a href="#l00092">ringbuf.h:92</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a382c625788eb10a55ffdcfac73f9cf3d"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a382c625788eb10a55ffdcfac73f9cf3d">l4shmc_ringbuf_t::_area</a></div><div class="ttdeci">l4shmc_area_t * _area</div><div class="ttdoc">L4SHM area this buffer is located in.</div><div class="ttdef"><b>Definition</b> <a href="#l00087">ringbuf.h:87</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a3862bfc8e3336eabc1bd7bd92d376143"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a3862bfc8e3336eabc1bd7bd92d376143">l4shmc_ringbuf_t::_chunk</a></div><div class="ttdeci">l4shmc_chunk_t _chunk</div><div class="ttdoc">chunk descriptor</div><div class="ttdef"><b>Definition</b> <a href="#l00089">ringbuf.h:89</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a50a33214a3a63c74386d7e85d0f5b6bf"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a50a33214a3a63c74386d7e85d0f5b6bf">l4shmc_ringbuf_t::_signal_full</a></div><div class="ttdeci">l4shmc_signal_t _signal_full</div><div class="ttdoc">&quot;full&quot; signal - triggered when data is produced</div><div class="ttdef"><b>Definition</b> <a href="#l00094">ringbuf.h:94</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a527d7c00a87b135908a6c578f2a43969"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a527d7c00a87b135908a6c578f2a43969">l4shmc_ringbuf_t::_addr</a></div><div class="ttdeci">l4shmc_ringbuf_head_t * _addr</div><div class="ttdoc">pointer to ring buffer head</div><div class="ttdef"><b>Definition</b> <a href="#l00093">ringbuf.h:93</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a597c7952cb89dc695330096bcea8d165"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a597c7952cb89dc695330096bcea8d165">l4shmc_ringbuf_t::_owner</a></div><div class="ttdeci">l4_cap_idx_t _owner</div><div class="ttdoc">owner (attached to send/recv signal)</div><div class="ttdef"><b>Definition</b> <a href="#l00088">ringbuf.h:88</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a66f84d52e916ec45c49837dc0d68eee9"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a66f84d52e916ec45c49837dc0d68eee9">l4shmc_ringbuf_t::_size</a></div><div class="ttdeci">unsigned _size</div><div class="ttdoc">chunk size // XXX do we need this?</div><div class="ttdef"><b>Definition</b> <a href="#l00090">ringbuf.h:90</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_a97e53b757b1ba7ed92a4ecd05f269223"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#a97e53b757b1ba7ed92a4ecd05f269223">l4shmc_ringbuf_t::_chunkname</a></div><div class="ttdeci">char * _chunkname</div><div class="ttdoc">name of the ring buffer chunk</div><div class="ttdef"><b>Definition</b> <a href="#l00091">ringbuf.h:91</a></div></div>
<div class="ttc" id="astructl4shmc__ringbuf__t_html_ae833494bf78923e982bbc8da08cc512f"><div class="ttname"><a href="structl4shmc__ringbuf__t.html#ae833494bf78923e982bbc8da08cc512f">l4shmc_ringbuf_t::_signal_empty</a></div><div class="ttdeci">l4shmc_signal_t _signal_empty</div><div class="ttdoc">&quot;empty&quot; signal - triggered when data is consumed</div><div class="ttdef"><b>Definition</b> <a href="#l00095">ringbuf.h:95</a></div></div>
<div class="ttc" id="autil_2assert_8h_html"><div class="ttname"><a href="util_2assert_8h.html">assert.h</a></div><div class="ttdoc">Some useful assert-style macros.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</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>
Reference in New Issue View Git Blame Copy Permalink