[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / doxygen / html / _list_m_p_8h_source.html
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.9.1"/>
8 <title>IPC API: ti/ipc/ListMP.h Source File</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <script type="text/javascript">
16 $(document).ready(function() { init_search(); });
17 </script>
18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
19 </head>
20 <body>
21 <table width="100%">
22 <tr>
23 <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
24 <td bgcolor="red"><img src="titagline.gif" /></td>
25 </tr>
26 </table>
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
28 <div id="titlearea">
29 <table cellspacing="0" cellpadding="0">
30 <tbody>
31 <tr style="height: 56px;">
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">IPC API
34  <span id="projectnumber">3.43.00.00_eng</span>
35 </div>
36 </td>
37 </tr>
38 </tbody>
39 </table>
40 </div>
41 <!-- end header part -->
42 <!-- Generated by Doxygen 1.8.9.1 -->
43 <script type="text/javascript">
44 var searchBox = new SearchBox("searchBox", "search",false,'Search');
45 </script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main Page</span></a></li>
49 <li><a href="modules.html"><span>Modules</span></a></li>
50 <li><a href="annotated.html"><span>Data Structures</span></a></li>
51 <li class="current"><a href="files.html"><span>Files</span></a></li>
52 <li><a href="pages.html"><span>Related Pages</span></a></li>
53 <li>
54 <div id="MSearchBox" class="MSearchBoxInactive">
55 <span class="left">
56 <img id="MSearchSelect" src="search/mag_sel.png"
57 onmouseover="return searchBox.OnSearchSelectShow()"
58 onmouseout="return searchBox.OnSearchSelectHide()"
59 alt=""/>
60 <input type="text" id="MSearchField" value="Search" accesskey="S"
61 onfocus="searchBox.OnSearchFieldFocus(true)"
62 onblur="searchBox.OnSearchFieldFocus(false)"
63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
64 </span><span class="right">
65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
66 </span>
67 </div>
68 </li>
69 </ul>
70 </div>
71 <div id="navrow2" class="tabs2">
72 <ul class="tablist">
73 <li><a href="files.html"><span>File List</span></a></li>
74 <li><a href="globals.html"><span>Globals</span></a></li>
75 </ul>
76 </div>
77 <!-- window showing the filter options -->
78 <div id="MSearchSelectWindow"
79 onmouseover="return searchBox.OnSearchSelectShow()"
80 onmouseout="return searchBox.OnSearchSelectHide()"
81 onkeydown="return searchBox.OnSearchSelectKey(event)">
82 </div>
84 <!-- iframe showing the search results (closed by default) -->
85 <div id="MSearchResultsWindow">
86 <iframe src="javascript:void(0)" frameborder="0"
87 name="MSearchResults" id="MSearchResults">
88 </iframe>
89 </div>
91 <div id="nav-path" class="navpath">
92 <ul>
93 <li class="navelem"><a class="el" href="dir_46079174fecd82ead33d8fa28082a6fc.html">ti</a></li><li class="navelem"><a class="el" href="dir_d15d182bf14778c656928067305f92ce.html">ipc</a></li> </ul>
94 </div>
95 </div><!-- top -->
96 <div class="header">
97 <div class="headertitle">
98 <div class="title">ListMP.h</div> </div>
99 </div><!--header-->
100 <div class="contents">
101 <a href="_list_m_p_8h.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>
102 <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2012-2013, Texas Instruments Incorporated</span></div>
103 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
104 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
105 <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
106 <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modification, are permitted provided that the following conditions</span></div>
107 <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * are met:</span></div>
108 <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
109 <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * * Redistributions of source code must retain the above copyright</span></div>
110 <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
111 <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
112 <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * * Redistributions in binary form must reproduce the above copyright</span></div>
113 <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>
114 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>
115 <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
116 <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * * Neither the name of Texas Instruments Incorporated nor the names of</span></div>
117 <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * its contributors may be used to endorse or promote products derived</span></div>
118 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * from this software without specific prior written permission.</span></div>
119 <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
120 <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
121 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,</span></div>
122 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span></div>
123 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span></div>
124 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
125 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
126 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
127 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
128 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
129 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,</span></div>
130 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
131 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
132 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#ifndef ti_ipc_ListMP__include</span></div>
133 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#define ti_ipc_ListMP__include</span></div>
134 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
135 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#include <<a class="code" href="_shared_region_8h.html">ti/ipc/SharedRegion.h</a>></span></div>
136 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#include <<a class="code" href="_gate_m_p_8h.html">ti/ipc/GateMP.h</a>></span></div>
137 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
138 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#if defined (__cplusplus)</span></div>
139 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
140 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif</span></div>
141 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
142 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/* =============================================================================</span></div>
143 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * All success and failure codes for the module</span></div>
144 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * =============================================================================</span></div>
145 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> */</span></div>
146 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
147 <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#aae3ea24c5161e44b42c0a2c6f73fd3d2"> 86</a></span> <span class="preprocessor">#define ListMP_S_BUSY 2</span></div>
148 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
149 <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#ae2dbc4743a0ddc0c4aaded37551cf25e"> 91</a></span> <span class="preprocessor">#define ListMP_S_ALREADYSETUP 1</span></div>
150 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
151 <div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a67e97f10cd480f457375e9a20bb41e27"> 96</a></span> <span class="preprocessor">#define ListMP_S_SUCCESS 0</span></div>
152 <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
153 <div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a4aa4e08eddd7d36b42395070f21125df"> 101</a></span> <span class="preprocessor">#define ListMP_E_FAIL -1</span></div>
154 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
155 <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a0cfe16cd038629372772230866ef681f"> 106</a></span> <span class="preprocessor">#define ListMP_E_INVALIDARG -2</span></div>
156 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
157 <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#ae855742ffb668b39109633d3a3fe552c"> 111</a></span> <span class="preprocessor">#define ListMP_E_MEMORY -3</span></div>
158 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
159 <div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#aa943a6dd86b5cd4092faa9a2c3650678"> 116</a></span> <span class="preprocessor">#define ListMP_E_ALREADYEXISTS -4</span></div>
160 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
161 <div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#ad1094272ac41cf2b022d6c514beaceac"> 121</a></span> <span class="preprocessor">#define ListMP_E_NOTFOUND -5</span></div>
162 <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
163 <div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a163b8195b54eab051c94c37b6f76a3c0"> 126</a></span> <span class="preprocessor">#define ListMP_E_TIMEOUT -6</span></div>
164 <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
165 <div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a1f5136445766b775f24f09fbc1e77531"> 131</a></span> <span class="preprocessor">#define ListMP_E_INVALIDSTATE -7</span></div>
166 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
167 <div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a71a0081f7de24109c2b91f209b3d9d3d"> 136</a></span> <span class="preprocessor">#define ListMP_E_OSFAILURE -8</span></div>
168 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
169 <div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a17bd29505d65eb1130a9526bb842507c"> 141</a></span> <span class="preprocessor">#define ListMP_E_RESOURCE -9</span></div>
170 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div>
171 <div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#a6fd9b6b57f38d4be617d2fdae5f4d4e8"> 146</a></span> <span class="preprocessor">#define ListMP_E_RESTART -10</span></div>
172 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
173 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/* =============================================================================</span></div>
174 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * Structures & Enums</span></div>
175 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * =============================================================================</span></div>
176 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> */</span></div>
177 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div>
178 <div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="_list_m_p_8h.html#abf5a0381ce9dab133382015abaf7fe6b"> 156</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>ListMP_Object *<a class="code" href="_list_m_p_8h.html#abf5a0381ce9dab133382015abaf7fe6b">ListMP_Handle</a>;</div>
179 <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
180 <div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="struct_list_m_p___elem.html"> 161</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> {</div>
181 <div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="struct_list_m_p___elem.html#a8412a4ab0e165caa517a2b6b36ee718a"> 162</a></span>  <span class="keyword">volatile</span> <a class="code" href="_shared_region_8h.html#a3efe06da0fa1fcbb3b271278ddd9b410">SharedRegion_SRPtr</a> <a class="code" href="struct_list_m_p___elem.html#a8412a4ab0e165caa517a2b6b36ee718a">next</a>;</div>
182 <div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="struct_list_m_p___elem.html#af77ecd85f8df18db6bfcbbd55dcc99ab"> 165</a></span>  <span class="keyword">volatile</span> <a class="code" href="_shared_region_8h.html#a3efe06da0fa1fcbb3b271278ddd9b410">SharedRegion_SRPtr</a> <a class="code" href="struct_list_m_p___elem.html#af77ecd85f8df18db6bfcbbd55dcc99ab">prev</a>;</div>
183 <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> } <a class="code" href="_list_m_p_8h.html#a848cf7dfe687e86045808fca1c561ea0">ListMP_Elem</a>;</div>
184 <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div>
185 <div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="struct_list_m_p___params.html"> 173</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_list_m_p___params.html">ListMP_Params</a> {</div>
186 <div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="struct_list_m_p___params.html#a4808f5c75029b059fa388a33e158c2f4"> 174</a></span>  <a class="code" href="_gate_m_p_8h.html#a3c46c6ae9c6feac86b8b8872ee52f587">GateMP_Handle</a> <a class="code" href="struct_list_m_p___params.html#a4808f5c75029b059fa388a33e158c2f4">gate</a>;</div>
187 <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  Ptr sharedAddr;</div>
188 <div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="struct_list_m_p___params.html#a4ac70f37c8b5584fa115d6d7f412daba"> 192</a></span>  String <a class="code" href="struct_list_m_p___params.html#a4ac70f37c8b5584fa115d6d7f412daba">name</a>;</div>
189 <div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="struct_list_m_p___params.html#af812a3b0ea4698b841bfbf83eada903a"> 203</a></span>  UInt16 <a class="code" href="struct_list_m_p___params.html#af812a3b0ea4698b841bfbf83eada903a">regionId</a>;</div>
190 <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> } <a class="code" href="_list_m_p_8h.html#ad2f3144c55c1f05df600bc6f37290b8f">ListMP_Params</a>;</div>
191 <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div>
192 <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">/* =============================================================================</span></div>
193 <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * ListMP Module-wide Functions</span></div>
194 <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * =============================================================================</span></div>
195 <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> */</span></div>
196 <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div>
197 <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> Void <a class="code" href="_list_m_p_8h.html#a051127fdcd75440808d0fed31c6e8b4b">ListMP_Params_init</a>(<a class="code" href="struct_list_m_p___params.html">ListMP_Params</a> *params);</div>
198 <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div>
199 <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> ListMP_Handle <a class="code" href="_list_m_p_8h.html#a71fdd7f30d377065fb70dd095a186d3e">ListMP_create</a>(<span class="keyword">const</span> <a class="code" href="struct_list_m_p___params.html">ListMP_Params</a> *params);</div>
200 <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div>
201 <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> Int <a class="code" href="_list_m_p_8h.html#a9f9045344d095a9829ba601d74d39c93">ListMP_close</a>(ListMP_Handle *handlePtr);</div>
202 <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div>
203 <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> Int <a class="code" href="_list_m_p_8h.html#a9a3875bf334cbc6d692e9053e7e4152b">ListMP_delete</a>(ListMP_Handle *handlePtr);</div>
204 <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> </div>
205 <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> Int <a class="code" href="_list_m_p_8h.html#aeae2eea832b0f2f8cf45ea297bb1c7d0">ListMP_open</a>(String name, ListMP_Handle *handlePtr);</div>
206 <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> </div>
207 <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> Int ListMP_openByAddr(Ptr sharedAddr, ListMP_Handle *handlePtr);</div>
208 <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div>
209 <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> SizeT ListMP_sharedMemReq(<span class="keyword">const</span> <a class="code" href="struct_list_m_p___params.html">ListMP_Params</a> *params);</div>
210 <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> </div>
211 <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment">/* =============================================================================</span></div>
212 <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> * ListMP Per-instance Functions</span></div>
213 <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * =============================================================================</span></div>
214 <div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> */</span></div>
215 <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> </div>
216 <div class="line"><a name="l00362"></a><span class="lineno"> 362</span> Bool <a class="code" href="_list_m_p_8h.html#a87f3489e92331dd7e3a2ca7315d6ae88">ListMP_empty</a>(ListMP_Handle handle);</div>
217 <div class="line"><a name="l00363"></a><span class="lineno"> 363</span> </div>
218 <div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <a class="code" href="_gate_m_p_8h.html#a3c46c6ae9c6feac86b8b8872ee52f587">GateMP_Handle</a> <a class="code" href="_list_m_p_8h.html#abcbcfa3aa97f94f1559c94e3de56a445">ListMP_getGate</a>(ListMP_Handle handle);</div>
219 <div class="line"><a name="l00372"></a><span class="lineno"> 372</span> </div>
220 <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> Ptr <a class="code" href="_list_m_p_8h.html#a3f94c683617f51b4e9de75d87c729524">ListMP_getHead</a>(ListMP_Handle handle);</div>
221 <div class="line"><a name="l00385"></a><span class="lineno"> 385</span> </div>
222 <div class="line"><a name="l00397"></a><span class="lineno"> 397</span> Ptr <a class="code" href="_list_m_p_8h.html#a75ac818a89cae66a10fb200f691c3949">ListMP_getTail</a>(ListMP_Handle handle);</div>
223 <div class="line"><a name="l00398"></a><span class="lineno"> 398</span> </div>
224 <div class="line"><a name="l00423"></a><span class="lineno"> 423</span> Int <a class="code" href="_list_m_p_8h.html#a202b294a05f5be8b909c38e592978e8b">ListMP_insert</a>(ListMP_Handle handle,</div>
225 <div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  <a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> *newElem,</div>
226 <div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  <a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> *curElem);</div>
227 <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> </div>
228 <div class="line"><a name="l00466"></a><span class="lineno"> 466</span> Ptr <a class="code" href="_list_m_p_8h.html#a1c9b826d5b17a55a8ddbe231db1b8f36">ListMP_next</a>(ListMP_Handle handle, <a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> *elem);</div>
229 <div class="line"><a name="l00467"></a><span class="lineno"> 467</span> </div>
230 <div class="line"><a name="l00506"></a><span class="lineno"> 506</span> Ptr <a class="code" href="_list_m_p_8h.html#aab4e8c1ad68b0d4908ea6221b889cf14">ListMP_prev</a>(ListMP_Handle handle, <a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> *elem);</div>
231 <div class="line"><a name="l00507"></a><span class="lineno"> 507</span> </div>
232 <div class="line"><a name="l00521"></a><span class="lineno"> 521</span> Int <a class="code" href="_list_m_p_8h.html#aed19b5eadd7b9007c948c1343934e251">ListMP_putHead</a>(ListMP_Handle handle, <a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> *elem);</div>
233 <div class="line"><a name="l00522"></a><span class="lineno"> 522</span> </div>
234 <div class="line"><a name="l00536"></a><span class="lineno"> 536</span> Int <a class="code" href="_list_m_p_8h.html#ab97d069db0de6f8116acb262989b8441">ListMP_putTail</a>(ListMP_Handle handle, <a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> *elem);</div>
235 <div class="line"><a name="l00537"></a><span class="lineno"> 537</span> </div>
236 <div class="line"><a name="l00553"></a><span class="lineno"> 553</span> Int <a class="code" href="_list_m_p_8h.html#ab66a123f8234c4eb218fa81407c06c3c">ListMP_remove</a>(ListMP_Handle handle, <a class="code" href="struct_list_m_p___elem.html">ListMP_Elem</a> *elem);</div>
237 <div class="line"><a name="l00554"></a><span class="lineno"> 554</span> </div>
238 <div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="preprocessor">#if defined (__cplusplus)</span></div>
239 <div class="line"><a name="l00556"></a><span class="lineno"> 556</span> }</div>
240 <div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="preprocessor">#endif </span><span class="comment">/* defined (__cplusplus) */</span><span class="preprocessor"></span></div>
241 <div class="line"><a name="l00558"></a><span class="lineno"> 558</span> </div>
242 <div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="preprocessor">#endif </span><span class="comment">/* ti_ipc_ListMP__include */</span><span class="preprocessor"></span></div>
243 <div class="ttc" id="_list_m_p_8h_html_ad2f3144c55c1f05df600bc6f37290b8f"><div class="ttname"><a href="_list_m_p_8h.html#ad2f3144c55c1f05df600bc6f37290b8f">ListMP_Params</a></div><div class="ttdeci">struct ListMP_Params ListMP_Params</div><div class="ttdoc">Structure defining parameter structure for ListMP_create(). </div></div>
244 <div class="ttc" id="_list_m_p_8h_html_a848cf7dfe687e86045808fca1c561ea0"><div class="ttname"><a href="_list_m_p_8h.html#a848cf7dfe687e86045808fca1c561ea0">ListMP_Elem</a></div><div class="ttdeci">struct ListMP_Elem ListMP_Elem</div><div class="ttdoc">Structure defining a ListMP element. </div></div>
245 <div class="ttc" id="struct_list_m_p___elem_html_af77ecd85f8df18db6bfcbbd55dcc99ab"><div class="ttname"><a href="struct_list_m_p___elem.html#af77ecd85f8df18db6bfcbbd55dcc99ab">ListMP_Elem::prev</a></div><div class="ttdeci">volatile SharedRegion_SRPtr prev</div><div class="ttdef"><b>Definition:</b> ListMP.h:165</div></div>
246 <div class="ttc" id="_list_m_p_8h_html_a3f94c683617f51b4e9de75d87c729524"><div class="ttname"><a href="_list_m_p_8h.html#a3f94c683617f51b4e9de75d87c729524">ListMP_getHead</a></div><div class="ttdeci">Ptr ListMP_getHead(ListMP_Handle handle)</div><div class="ttdoc">Get an element from front of a ListMP instance. </div></div>
247 <div class="ttc" id="_list_m_p_8h_html_a1c9b826d5b17a55a8ddbe231db1b8f36"><div class="ttname"><a href="_list_m_p_8h.html#a1c9b826d5b17a55a8ddbe231db1b8f36">ListMP_next</a></div><div class="ttdeci">Ptr ListMP_next(ListMP_Handle handle, ListMP_Elem *elem)</div><div class="ttdoc">Return the next element in a ListMP instance (non-atomic) </div></div>
248 <div class="ttc" id="_list_m_p_8h_html_a71fdd7f30d377065fb70dd095a186d3e"><div class="ttname"><a href="_list_m_p_8h.html#a71fdd7f30d377065fb70dd095a186d3e">ListMP_create</a></div><div class="ttdeci">ListMP_Handle ListMP_create(const ListMP_Params *params)</div><div class="ttdoc">Creates and initializes ListMP module. </div></div>
249 <div class="ttc" id="_list_m_p_8h_html_a87f3489e92331dd7e3a2ca7315d6ae88"><div class="ttname"><a href="_list_m_p_8h.html#a87f3489e92331dd7e3a2ca7315d6ae88">ListMP_empty</a></div><div class="ttdeci">Bool ListMP_empty(ListMP_Handle handle)</div><div class="ttdoc">Determines if a ListMP instance is empty. </div></div>
250 <div class="ttc" id="_shared_region_8h_html_a3efe06da0fa1fcbb3b271278ddd9b410"><div class="ttname"><a href="_shared_region_8h.html#a3efe06da0fa1fcbb3b271278ddd9b410">SharedRegion_SRPtr</a></div><div class="ttdeci">Bits32 SharedRegion_SRPtr</div><div class="ttdoc">SharedRegion pointer type. </div><div class="ttdef"><b>Definition:</b> SharedRegion.h:197</div></div>
251 <div class="ttc" id="_list_m_p_8h_html_a051127fdcd75440808d0fed31c6e8b4b"><div class="ttname"><a href="_list_m_p_8h.html#a051127fdcd75440808d0fed31c6e8b4b">ListMP_Params_init</a></div><div class="ttdeci">Void ListMP_Params_init(ListMP_Params *params)</div><div class="ttdoc">Initializes ListMP parameters. </div></div>
252 <div class="ttc" id="_gate_m_p_8h_html"><div class="ttname"><a href="_gate_m_p_8h.html">GateMP.h</a></div><div class="ttdoc">Multiple processor gate that provides local and remote context protection. </div></div>
253 <div class="ttc" id="_list_m_p_8h_html_a202b294a05f5be8b909c38e592978e8b"><div class="ttname"><a href="_list_m_p_8h.html#a202b294a05f5be8b909c38e592978e8b">ListMP_insert</a></div><div class="ttdeci">Int ListMP_insert(ListMP_Handle handle, ListMP_Elem *newElem, ListMP_Elem *curElem)</div><div class="ttdoc">Insert an element into a ListMP instance. </div></div>
254 <div class="ttc" id="struct_list_m_p___params_html"><div class="ttname"><a href="struct_list_m_p___params.html">ListMP_Params</a></div><div class="ttdoc">Structure defining parameter structure for ListMP_create(). </div><div class="ttdef"><b>Definition:</b> ListMP.h:173</div></div>
255 <div class="ttc" id="_list_m_p_8h_html_a75ac818a89cae66a10fb200f691c3949"><div class="ttname"><a href="_list_m_p_8h.html#a75ac818a89cae66a10fb200f691c3949">ListMP_getTail</a></div><div class="ttdeci">Ptr ListMP_getTail(ListMP_Handle handle)</div><div class="ttdoc">Get an element from back of a ListMP instance. </div></div>
256 <div class="ttc" id="_list_m_p_8h_html_a9a3875bf334cbc6d692e9053e7e4152b"><div class="ttname"><a href="_list_m_p_8h.html#a9a3875bf334cbc6d692e9053e7e4152b">ListMP_delete</a></div><div class="ttdeci">Int ListMP_delete(ListMP_Handle *handlePtr)</div><div class="ttdoc">Deletes a ListMP instance. </div></div>
257 <div class="ttc" id="_gate_m_p_8h_html_a3c46c6ae9c6feac86b8b8872ee52f587"><div class="ttname"><a href="_gate_m_p_8h.html#a3c46c6ae9c6feac86b8b8872ee52f587">GateMP_Handle</a></div><div class="ttdeci">struct GateMP_Object_tag * GateMP_Handle</div><div class="ttdoc">GateMP_Handle type. </div><div class="ttdef"><b>Definition:</b> GateMP.h:222</div></div>
258 <div class="ttc" id="struct_list_m_p___params_html_a4ac70f37c8b5584fa115d6d7f412daba"><div class="ttname"><a href="struct_list_m_p___params.html#a4ac70f37c8b5584fa115d6d7f412daba">ListMP_Params::name</a></div><div class="ttdeci">String name</div><div class="ttdef"><b>Definition:</b> ListMP.h:192</div></div>
259 <div class="ttc" id="_list_m_p_8h_html_a9f9045344d095a9829ba601d74d39c93"><div class="ttname"><a href="_list_m_p_8h.html#a9f9045344d095a9829ba601d74d39c93">ListMP_close</a></div><div class="ttdeci">Int ListMP_close(ListMP_Handle *handlePtr)</div><div class="ttdoc">Close an opened ListMP instance. </div></div>
260 <div class="ttc" id="_list_m_p_8h_html_aab4e8c1ad68b0d4908ea6221b889cf14"><div class="ttname"><a href="_list_m_p_8h.html#aab4e8c1ad68b0d4908ea6221b889cf14">ListMP_prev</a></div><div class="ttdeci">Ptr ListMP_prev(ListMP_Handle handle, ListMP_Elem *elem)</div><div class="ttdoc">Return the previous element in ListMP instance (non-atomic) </div></div>
261 <div class="ttc" id="_list_m_p_8h_html_ab66a123f8234c4eb218fa81407c06c3c"><div class="ttname"><a href="_list_m_p_8h.html#ab66a123f8234c4eb218fa81407c06c3c">ListMP_remove</a></div><div class="ttdeci">Int ListMP_remove(ListMP_Handle handle, ListMP_Elem *elem)</div><div class="ttdoc">Remove an element from a ListMP instance. </div></div>
262 <div class="ttc" id="_list_m_p_8h_html_ab97d069db0de6f8116acb262989b8441"><div class="ttname"><a href="_list_m_p_8h.html#ab97d069db0de6f8116acb262989b8441">ListMP_putTail</a></div><div class="ttdeci">Int ListMP_putTail(ListMP_Handle handle, ListMP_Elem *elem)</div><div class="ttdoc">Put an element at back of a ListMP instance. </div></div>
263 <div class="ttc" id="_list_m_p_8h_html_abf5a0381ce9dab133382015abaf7fe6b"><div class="ttname"><a href="_list_m_p_8h.html#abf5a0381ce9dab133382015abaf7fe6b">ListMP_Handle</a></div><div class="ttdeci">struct ListMP_Object * ListMP_Handle</div><div class="ttdoc">ListMP_Handle type. </div><div class="ttdef"><b>Definition:</b> ListMP.h:156</div></div>
264 <div class="ttc" id="struct_list_m_p___params_html_af812a3b0ea4698b841bfbf83eada903a"><div class="ttname"><a href="struct_list_m_p___params.html#af812a3b0ea4698b841bfbf83eada903a">ListMP_Params::regionId</a></div><div class="ttdeci">UInt16 regionId</div><div class="ttdef"><b>Definition:</b> ListMP.h:203</div></div>
265 <div class="ttc" id="_list_m_p_8h_html_aed19b5eadd7b9007c948c1343934e251"><div class="ttname"><a href="_list_m_p_8h.html#aed19b5eadd7b9007c948c1343934e251">ListMP_putHead</a></div><div class="ttdeci">Int ListMP_putHead(ListMP_Handle handle, ListMP_Elem *elem)</div><div class="ttdoc">Put an element at head of a ListMP instance. </div></div>
266 <div class="ttc" id="_shared_region_8h_html"><div class="ttname"><a href="_shared_region_8h.html">SharedRegion.h</a></div><div class="ttdoc">Shared memory manager and address translator. </div></div>
267 <div class="ttc" id="struct_list_m_p___elem_html"><div class="ttname"><a href="struct_list_m_p___elem.html">ListMP_Elem</a></div><div class="ttdoc">Structure defining a ListMP element. </div><div class="ttdef"><b>Definition:</b> ListMP.h:161</div></div>
268 <div class="ttc" id="struct_list_m_p___elem_html_a8412a4ab0e165caa517a2b6b36ee718a"><div class="ttname"><a href="struct_list_m_p___elem.html#a8412a4ab0e165caa517a2b6b36ee718a">ListMP_Elem::next</a></div><div class="ttdeci">volatile SharedRegion_SRPtr next</div><div class="ttdef"><b>Definition:</b> ListMP.h:162</div></div>
269 <div class="ttc" id="struct_list_m_p___params_html_a4808f5c75029b059fa388a33e158c2f4"><div class="ttname"><a href="struct_list_m_p___params.html#a4808f5c75029b059fa388a33e158c2f4">ListMP_Params::gate</a></div><div class="ttdeci">GateMP_Handle gate</div><div class="ttdef"><b>Definition:</b> ListMP.h:174</div></div>
270 <div class="ttc" id="_list_m_p_8h_html_abcbcfa3aa97f94f1559c94e3de56a445"><div class="ttname"><a href="_list_m_p_8h.html#abcbcfa3aa97f94f1559c94e3de56a445">ListMP_getGate</a></div><div class="ttdeci">GateMP_Handle ListMP_getGate(ListMP_Handle handle)</div><div class="ttdoc">Retrieves the GateMP handle associated with the ListMP instance. </div></div>
271 <div class="ttc" id="_list_m_p_8h_html_aeae2eea832b0f2f8cf45ea297bb1c7d0"><div class="ttname"><a href="_list_m_p_8h.html#aeae2eea832b0f2f8cf45ea297bb1c7d0">ListMP_open</a></div><div class="ttdeci">Int ListMP_open(String name, ListMP_Handle *handlePtr)</div><div class="ttdoc">Open a created ListMP instance. </div></div>
272 </div><!-- fragment --></div><!-- contents -->
273 <!-- HTML footer for doxygen 1.8.9.1-->
274 <!-- start footer part -->
275 <hr class="footer"/><small>
276 Copyright 2016, Texas Instruments Incorporated
277 </small>
278 </body>
279 </html>