-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patherpc__static__queue_8hpp_source.html
135 lines (133 loc) · 21.2 KB
/
erpc__static__queue_8hpp_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
<title>eRPC API Reference: erpc_static_queue.hpp 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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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="nxp_logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">eRPC API Reference
 <span id="projectnumber">Rev. 1.13.0</span>
</div>
<div id="projectbrief">NXP Semiconductors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>API Reference</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('erpc__static__queue_8hpp_source.html','');});
</script>
<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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">erpc_static_queue.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="erpc__static__queue_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2021 NXP</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef __embedded_rpc__static_queue__</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define __embedded_rpc__static_queue__</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <cstring></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// Classes</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceerpc.html">erpc</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, u<span class="keywordtype">int</span>32_t elementCount></div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html"> 33</a></span> <span class="keyword">class </span><a class="code" href="classerpc_1_1_static_queue.html">StaticQueue</a></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#a248662ae7d3a228d056332389739b941"> 41</a></span>  <a class="code" href="classerpc_1_1_static_queue.html#a248662ae7d3a228d056332389739b941">StaticQueue</a>(<span class="keywordtype">void</span>)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c">m_capacity</a> = elementCount;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a> = 0;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a> = 0;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  (void)memset(<a class="code" href="classerpc_1_1_static_queue.html#a2ba71c1a990bbffb6cf20ed170a02169">m_storage</a>, 0, <span class="keyword">sizeof</span>(<a class="code" href="classerpc_1_1_static_queue.html#a2ba71c1a990bbffb6cf20ed170a02169">m_storage</a>));</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#a24ddc2195588cee38e390652f9a6d070"> 54</a></span>  <a class="code" href="classerpc_1_1_static_queue.html#a24ddc2195588cee38e390652f9a6d070">~StaticQueue</a>(<span class="keywordtype">void</span>) {}</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#ab1fe280f10fdf322ae75f16d80b812cc"> 63</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classerpc_1_1_static_queue.html#ab1fe280f10fdf322ae75f16d80b812cc">add</a>(T element)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">if</span> ((<a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a> + 1U) % <a class="code" href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c">m_capacity</a> != <a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a>)</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  (void)std::memcpy(<a class="code" href="classerpc_1_1_static_queue.html#a2ba71c1a990bbffb6cf20ed170a02169">m_storage</a>[<a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a>], &element, <span class="keyword">sizeof</span>(T));</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  m_head = (m_head + 1U) % <a class="code" href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c">m_capacity</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#a50621cf1d1676983bbf95c7dbf178229"> 82</a></span>  <span class="keywordtype">bool</span> <span class="keyword">get</span>(T *element)</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">if</span> (<a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a> != <a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a>)</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  (void)std::memcpy(element, <a class="code" href="classerpc_1_1_static_queue.html#a2ba71c1a990bbffb6cf20ed170a02169">m_storage</a>[<a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a>], <span class="keyword">sizeof</span>(T));</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  m_tail = (m_tail + 1U) % <a class="code" href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c">m_capacity</a>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#a6aa550f3bbbaacfa92e2a91215c899ed"> 98</a></span>  uint32_t <a class="code" href="classerpc_1_1_static_queue.html#a6aa550f3bbbaacfa92e2a91215c899ed">size</a>(<span class="keywordtype">void</span>)</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">if</span> (<a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a> >= <a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a>)</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> <a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a> - <a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">return</span> (<a class="code" href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c">m_capacity</a> - <a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a> + <a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a>);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  uint64_t <a class="code" href="classerpc_1_1_static_queue.html#a2ba71c1a990bbffb6cf20ed170a02169">m_storage</a>[elementCount]</div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#a2ba71c1a990bbffb6cf20ed170a02169"> 109</a></span>  [(<span class="keyword">sizeof</span>(T) + <span class="keyword">sizeof</span>(uint64_t) - 1U) / <span class="keyword">sizeof</span>(uint64_t)]; </div><div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c"> 111</a></span>  uint32_t <a class="code" href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c">m_capacity</a>; </div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2"> 112</a></span>  uint32_t <span class="keyword">volatile</span> <a class="code" href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">m_head</a>; </div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8"> 113</a></span>  uint32_t <span class="keyword">volatile</span> <a class="code" href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">m_tail</a>; </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> };</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> } <span class="comment">// namespace erpc</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#endif // defined(__embedded_rpc__static_queue__)</span></div><div class="ttc" id="classerpc_1_1_static_queue_html_a2ba71c1a990bbffb6cf20ed170a02169"><div class="ttname"><a href="classerpc_1_1_static_queue.html#a2ba71c1a990bbffb6cf20ed170a02169">erpc::StaticQueue::m_storage</a></div><div class="ttdeci">uint64_t m_storage[elementCount][(sizeof(T)+sizeof(uint64_t)-1U)/sizeof(uint64_t)]</div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:109</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html_aa5b8df6fb776578ca3d8ddf5b4187af2"><div class="ttname"><a href="classerpc_1_1_static_queue.html#aa5b8df6fb776578ca3d8ddf5b4187af2">erpc::StaticQueue::m_head</a></div><div class="ttdeci">uint32_t volatile m_head</div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:112</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html_a248662ae7d3a228d056332389739b941"><div class="ttname"><a href="classerpc_1_1_static_queue.html#a248662ae7d3a228d056332389739b941">erpc::StaticQueue::StaticQueue</a></div><div class="ttdeci">StaticQueue(void)</div><div class="ttdoc">Constructor of StaticQueue class. </div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:41</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html_a6aa550f3bbbaacfa92e2a91215c899ed"><div class="ttname"><a href="classerpc_1_1_static_queue.html#a6aa550f3bbbaacfa92e2a91215c899ed">erpc::StaticQueue::size</a></div><div class="ttdeci">uint32_t size(void)</div><div class="ttdoc">This function returns number of elements in queue. </div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:98</div></div>
<div class="ttc" id="namespaceerpc_html"><div class="ttname"><a href="namespaceerpc.html">erpc</a></div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.hpp:25</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html_ab1fe280f10fdf322ae75f16d80b812cc"><div class="ttname"><a href="classerpc_1_1_static_queue.html#ab1fe280f10fdf322ae75f16d80b812cc">erpc::StaticQueue::add</a></div><div class="ttdeci">bool add(T element)</div><div class="ttdoc">This function adds element to queue. </div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:63</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html_af18992edddaa6bfb26713fde997273b8"><div class="ttname"><a href="classerpc_1_1_static_queue.html#af18992edddaa6bfb26713fde997273b8">erpc::StaticQueue::m_tail</a></div><div class="ttdeci">uint32_t volatile m_tail</div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:113</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html_a24ddc2195588cee38e390652f9a6d070"><div class="ttname"><a href="classerpc_1_1_static_queue.html#a24ddc2195588cee38e390652f9a6d070">erpc::StaticQueue::~StaticQueue</a></div><div class="ttdeci">~StaticQueue(void)</div><div class="ttdoc">Destructor of StaticQueue class. </div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:54</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html"><div class="ttname"><a href="classerpc_1_1_static_queue.html">erpc::StaticQueue</a></div><div class="ttdoc">Template class which implements static queue as ring buffer. </div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:33</div></div>
<div class="ttc" id="classerpc_1_1_static_queue_html_a0c43f1fba589c88fbb22a0e8b237d58c"><div class="ttname"><a href="classerpc_1_1_static_queue.html#a0c43f1fba589c88fbb22a0e8b237d58c">erpc::StaticQueue::m_capacity</a></div><div class="ttdeci">uint32_t m_capacity</div><div class="ttdef"><b>Definition:</b> erpc_static_queue.hpp:111</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul class="foot">
<li class="footer">Copyright 2016-2020 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
</body>
</html>