[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / ListMP.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.ListMP</title>
4 <meta name="description" content="Shared memory linked list">
5 <link rel="stylesheet" type="text/css" href="../../../xdoc.css" />
6 </head>
7 <body><div id="xdocWrapper"><div id="xdocContent">
8 <table class="xdocHdr"><tr>
9 <td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.sdo.ipc.</span><span class="xdoc-id">ListMP</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/Ipc.html" title="module Ipc"><img class="xdocHdrArrow" src="../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/package.html" title="package ti.sdo.ipc"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
14 <td class="xdocHdrArrow">
15 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/MessageQ.html" title="module MessageQ"><img class="xdocHdrArrow" src="../../../Arrow_right.png"/></a></td>
16 </table>
17 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html">index URL</a></div>
18 <p class="xdocHdrSummary">Shared memory linked list</p>
19 <ul class="xdocToc">
20 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
21 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
22 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
23 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
24 </ul>
25 <div class="xdocBrief">
26 This module has a common header that can be found in the <a class="xdoc-link" href="../../../ti/ipc/package.html" title="ti.ipc">ti.ipc</a>
27 package. Application code should include the common header file (not the
28 RTSC-generated one):
30 <PRE>#include <ti/ipc/ListMP.h></PRE>
32 The RTSC module must be used in the application's RTSC configuration file
33 (.cfg):
35 <PRE>ListMP = xdc.useModule('ti.sdo.ipc.ListMP');</PRE>
37 Documentation for all runtime APIs, instance configuration parameters,
38 error codes macros and type definitions available to the application
39 integrator can be found in the
40 <A HREF="../../../../doxygen/html/files.html">Doxygen documenation</A>
41 for the IPC product. However, the documentation presented on this page
42 should be referred to for information specific to the RTSC module, such as
43 module configuration, Errors, and Asserts.
44 </div>
45 <span id='targ-synop'></span>
46 <table class="xdocLabel"><tr>
47 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
48 <td class="xdocLabelCenter">target-domain</td>
49 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/ipc/ListMP-src.html"><span class="xdocLabelFile">ti/sdo/ipc/ListMP.xdc</span></a></td>
50 </tr></table>
51 <div class="xdocSynT">
52 <div class="xdocSynCode">
53 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/ListMP.h></span>
54 </div>
55 <table cellspacing="0" cellpadding="0" border="0">
56 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
58 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">ListMP_Params_init</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Initialize this config-params structure with supplier-specified defaults before instance creation</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_config_parameters" title="ti.sdo.ipc.ListMP.Params">ListMP_Params</a> *params);</div></td></tr>
59 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
61 <tr>
62 <td></td>
63 <td>
64 <div class="xdocSynTblPack">
65 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">ListMP_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
66 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">ListMP_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
67 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">ListMP_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
68 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">ListMP_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
69 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">ListMP_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
70 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">ListMP_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
71 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">ListMP_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
72 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">ListMP_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
73 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">ListMP_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
74 </div>
75 </td>
76 </tr>
77 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
79 <tr>
80 <td></td>
81 <td>
82 <div class="xdocSynTblPack">
83 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">ListMP_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
84 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">ListMP_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
85 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">ListMP_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
86 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">ListMP_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
87 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">ListMP_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
88 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">ListMP_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
89 </div>
90 </td>
91 </tr>
92 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
94 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Object">ListMP_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">ListMP_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
95 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">ListMP_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">ListMP_Object</span>;</div></td></tr>
96 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">ListMP_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
97 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">ListMP_Struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque client structure large enough to hold an instance object</span></span></a> <span class="xdoc-id">ListMP_Struct</span>;</div></td></tr>
98 </table>
99 <div class="xdocSynSpacer"> </div>
100 </div>
101 <div id="xdocSep">
102 </div>
103 <div id="xdocElems">
104 <a class="xdocAnchor" id="module-wide_built-ins"></a>
105 <table class="xdocHdr"><tr>
106 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
107 <td class="xdocHdrArrow">
108 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
109 </table>
110 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#module-wide_built-ins">index URL</a></div>
111 <p class="xdocHdrSummary"></p>
112 <span id='targ-synop'></span>
113 <table class="xdocLabel"><tr>
114 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
115 <td class="xdocLabelRight">target-domain</td>
116 </tr></table>
117 <div class="xdocSynTdcl">
118 <div class="xdocSynCode">
119 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Module.Id" title="xdc.runtime.Types.ModuleId">Types_ModuleId</a> <span class="xdoc-id">ListMP_Module_id</span>();
120 </div>
121 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
122 <div class="xdocSynSpacer"> </div>
123 <div class="xdocSynCode">
124 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">ListMP_Module_startupDone</span>();
125 </div>
126 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
127 <div class="xdocSynSpacer"> </div>
128 <div class="xdocSynCode">
129 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">ListMP_Module_heap</span>();
130 </div>
131 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
132 <div class="xdocSynSpacer"> </div>
133 <div class="xdocSynCode">
134 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">ListMP_Module_hasMask</span>();
135 </div>
136 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
137 <div class="xdocSynSpacer"> </div>
138 <div class="xdocSynCode">
139 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">ListMP_Module_getMask</span>();
140 </div>
141 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
142 <div class="xdocSynSpacer"> </div>
143 <div class="xdocSynCode">
144 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">ListMP_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
145 </div>
146 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
147 </div>
148 <a class="xdocAnchor" id="per-instance_object_types"></a>
149 <table class="xdocHdr"><tr>
150 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
151 <td class="xdocHdrArrow">
152 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
153 </table>
154 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#per-instance_object_types">index URL</a></div>
155 <p class="xdocHdrSummary"></p>
156 <span id='targ-synop'></span>
157 <table class="xdocLabel"><tr>
158 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
159 <td class="xdocLabelRight">target-domain</td>
160 </tr></table>
161 <div class="xdocSynTdcl">
162 <div class="xdocSynCode">
163 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">ListMP_Object</span> <span class="xdoc-id">ListMP_Object</span>;
164 </div>
165 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
166 <div class="xdocSynSpacer"> </div>
167 <div class="xdocSynCode">
168 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Object">ListMP_Object</a> *<span class="xdoc-id">ListMP_Handle</span>;
169 </div>
170 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
171 <div class="xdocSynSpacer"> </div>
172 <div class="xdocSynCode">
173 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">ListMP_Struct</span> <span class="xdoc-id">ListMP_Struct</span>;
174 </div>
175 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
176 <div class="xdocSynSpacer"> </div>
177 <div class="xdocSynCode">
178 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> <span class="xdoc-id">ListMP_handle</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Struct">ListMP_Struct</a> *structP);
179 </div>
180 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
181 <div class="xdocSynSpacer"> </div>
182 <div class="xdocSynCode">
183 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Struct">ListMP_Struct</a> *<span class="xdoc-id">ListMP_struct</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> handle);
184 </div>
185 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
186 </div>
187 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
188 <table class="xdocHdr"><tr>
189 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
190 <td class="xdocHdrArrow">
191 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
192 </table>
193 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#per-instance_config_parameters">index URL</a></div>
194 <p class="xdocHdrSummary"></p>
195 <span id='targ-synop'></span>
196 <table class="xdocLabel"><tr>
197 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
198 <td class="xdocLabelRight">target-domain</td>
199 </tr></table>
200 <div class="xdocSynTdcl">
201 <div class="xdocSynCode">
202 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">ListMP_Params</span> {
203 </div>
204 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
205 <div class="xdocSynCode">
206 <tt></tt><tt> </tt><a class="xdoc-link" href="../../../xdc/runtime/IInstance.html#per-instance_config_parameters" title="xdc.runtime.IInstance.Params">IInstance_Params</a> *instance;
207 </div>
208 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
209 <div class="xdocSynCode">
210 <tt></tt><tt> </tt><a class="xdoc-link" href="../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP_Handle</a> <span class="xdoc-id">gate</span>;
211 </div>
212 <div class='xdocSynSum'><tt></tt><tt> </tt>// GateMP used for critical region management of the shared memory</div>
213 <div class="xdocSynCode">
214 <tt></tt><tt> </tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">name</span>;
215 </div>
216 <div class='xdocSynSum'><tt></tt><tt> </tt>// Name of the instance</div>
217 <div class="xdocSynCode">
218 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">regionId</span>;
219 </div>
220 <div class='xdocSynSum'><tt></tt><tt> </tt>// SharedRegion ID</div>
221 <div class="xdocSynCode">
222 <tt></tt><tt></tt>} <span class="xdoc-id">ListMP_Params</span>;
223 </div>
224 <div class="xdocSynSpacer"> </div>
225 <div class="xdocSynCode">
226 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">ListMP_Params_init</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_config_parameters" title="ti.sdo.ipc.ListMP.Params">ListMP_Params</a> *params);
227 </div>
228 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
229 </div>
230 <div class="xdocSynSpacer"> </div>
231 <a class="xdocAnchor" id="gate"></a>
232 <table class="xdocHdr"><tr>
233 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP_Params.</span><span class="xdoc-id">gate</span> <small><span class="xdocSynSum">// instance</span></small></td>
234 <td class="xdocHdrArrow">
235 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
236 </table>
237 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#gate">index URL</a></div>
238 <p class="xdocHdrSummaryDcl">GateMP used for critical region management of the shared memory</p>
239 <span id='targ-synop'></span>
240 <table class="xdocLabel"><tr>
241 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
242 <td class="xdocLabelRight">target-domain</td>
243 </tr></table>
244 <div class="xdocSynTdcl">
245 <div class="xdocSynCode">
246 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_config_parameters" title="ti.sdo.ipc.ListMP.Params">ListMP_Params</a> {
247 </div>
248 <div class="xdocSynCode">
249 <tt></tt><tt> </tt><b> ...</b>
250 </div>
251 <div class="xdocSynCode">
252 <tt></tt><tt> </tt><a class="xdoc-link" href="../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP_Handle</a> <span class="xdoc-id">gate</span>;
253 </div>
254 </div>
255 <div class="xdocSynSpacer"> </div>
256 <span id="xdoc-sect-1"></span>
257 <div class="xdocSect">DETAILS</div>
258 <div class="xdocText">Using the default value of NULL will result in the default GateMP
259 being used for context protection.</div>
260 <div class="xdocSynSpacer"> </div>
261 <a class="xdocAnchor" id="name"></a>
262 <table class="xdocHdr"><tr>
263 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP_Params.</span><span class="xdoc-id">name</span> <small><span class="xdocSynSum">// instance</span></small></td>
264 <td class="xdocHdrArrow">
265 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
266 </table>
267 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#name">index URL</a></div>
268 <p class="xdocHdrSummaryDcl">Name of the instance</p>
269 <span id='targ-synop'></span>
270 <table class="xdocLabel"><tr>
271 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
272 <td class="xdocLabelRight">target-domain</td>
273 </tr></table>
274 <div class="xdocSynTdcl">
275 <div class="xdocSynCode">
276 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_config_parameters" title="ti.sdo.ipc.ListMP.Params">ListMP_Params</a> {
277 </div>
278 <div class="xdocSynCode">
279 <tt></tt><tt> </tt><b> ...</b>
280 </div>
281 <div class="xdocSynCode">
282 <tt></tt><tt> </tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">name</span>;
283 </div>
284 </div>
285 <div class="xdocSynSpacer"> </div>
286 <span id="xdoc-sect-1"></span>
287 <div class="xdocSect">DETAILS</div>
288 <div class="xdocText">The name must be unique among all ListMP instances in the sytem.
289 When using <a class="xdoc-link" href="ListMP.html#region.Id" title="regionId">regionId</a> to create a new instance, the name must
290 not be null.</div>
291 <div class="xdocSynSpacer"> </div>
292 <a class="xdocAnchor" id="region.Id"></a>
293 <table class="xdocHdr"><tr>
294 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP_Params.</span><span class="xdoc-id">regionId</span> <small><span class="xdocSynSum">// instance</span></small></td>
295 <td class="xdocHdrArrow">
296 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
297 </table>
298 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#region.Id">index URL</a></div>
299 <p class="xdocHdrSummaryDcl">SharedRegion ID</p>
300 <span id='targ-synop'></span>
301 <table class="xdocLabel"><tr>
302 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
303 <td class="xdocLabelRight">target-domain</td>
304 </tr></table>
305 <div class="xdocSynTdcl">
306 <div class="xdocSynCode">
307 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_config_parameters" title="ti.sdo.ipc.ListMP.Params">ListMP_Params</a> {
308 </div>
309 <div class="xdocSynCode">
310 <tt></tt><tt> </tt><b> ...</b>
311 </div>
312 <div class="xdocSynCode">
313 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">regionId</span>;
314 </div>
315 </div>
316 <div class="xdocSynSpacer"> </div>
317 <span id="xdoc-sect-1"></span>
318 <div class="xdocSect">DETAILS</div>
319 <div class="xdocText">The ID corresponding to the index of the shared region in which this
320 shared instance is to be placed. This is used in create() only when
321 <a class="xdoc-link" href="ListMP.html#name" title="name">name</a> is not null.</div>
322 <a class="xdocAnchor" id="per-instance_built-ins"></a>
323 <table class="xdocHdr"><tr>
324 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
325 <td class="xdocHdrArrow">
326 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
327 </table>
328 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#per-instance_built-ins">index URL</a></div>
329 <p class="xdocHdrSummary"></p>
330 <span id='targ-synop'></span>
331 <table class="xdocLabel"><tr>
332 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
333 <td class="xdocLabelRight">target-domain</td>
334 </tr></table>
335 <div class="xdocSynTdcl">
336 <div class="xdocSynCode">
337 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">ListMP_Object_count</span>();
338 </div>
339 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
340 <div class="xdocSynSpacer"> </div>
341 <div class="xdocSynCode">
342 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> <span class="xdoc-id">ListMP_Object_get</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Object">ListMP_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
343 </div>
344 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
345 <div class="xdocSynSpacer"> </div>
346 <div class="xdocSynCode">
347 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> <span class="xdoc-id">ListMP_Object_first</span>();
348 </div>
349 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
350 <div class="xdocSynSpacer"> </div>
351 <div class="xdocSynCode">
352 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> <span class="xdoc-id">ListMP_Object_next</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> handle);
353 </div>
354 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
355 <div class="xdocSynSpacer"> </div>
356 <div class="xdocSynCode">
357 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">ListMP_Object_heap</span>();
358 </div>
359 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
360 <div class="xdocSynSpacer"> </div>
361 <div class="xdocSynCode">
362 <tt></tt><tt></tt><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *<span class="xdoc-id">ListMP_Handle_label</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> handle, <a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
363 </div>
364 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
365 <div class="xdocSynSpacer"> </div>
366 <div class="xdocSynCode">
367 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">ListMP_Handle_name</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/ListMP.html#per-instance_object_types" title="ti.sdo.ipc.ListMP.Handle">ListMP_Handle</a> handle);
368 </div>
369 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
370 </div>
371 </div>
372 <div class="xdocSynSpacer"> </div>
373 <span id='meta-synop'></span>
374 <table class="xdocLabel"><tr>
375 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
376 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/sdo/ipc/ListMP-src.html"><span class="xdocLabelFile">ti/sdo/ipc/ListMP.xdc</span></a></td>
377 </tr></table>
378 <div class="xdocSynM">
379 <div class="xdocSynCode">
380 <tt></tt><span class="xdoc-kw1">var</span> ListMP = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.ListMP'</span>);
381 </div>
382 <div class='xdocSynHdr'>module-wide config parameters</div>
384 <div class="xdocSynCode">
385 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">ListMP.<span class="xdoc-id">common$</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Common module configuration parameters</span></span></a> = <i><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
386 </div>
387 <div class="xdocSynCode">
388 <tt> </tt><tt></tt><a class="xdocSynGo" href="#max.Name.Len">ListMP.<span class="xdoc-id">maxNameLen</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum length for names</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 32;
389 </div>
390 <div class="xdocSynCode">
391 <tt> </tt><tt></tt><a class="xdocSynGo" href="#max.Runtime.Entries">ListMP.<span class="xdoc-id">maxRuntimeEntries</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum number of ListMP's that can be dynamically created
392 and added to the NameServer</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> <a class="xdoc-link" href="../../../ti/sdo/utils/NameServer.html#.A.L.L.O.W.G.R.O.W.T.H" title="ti.sdo.utils.NameServer.ALLOWGROWTH">NameServer.ALLOWGROWTH</a>;
393 </div>
394 <div class="xdocSynCode">
395 <tt> </tt><tt></tt><a class="xdocSynGo" href="#table.Section">ListMP.<span class="xdoc-id">tableSection</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Section name is used to place the names table</span></span></a> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
396 </div>
397 <div class='xdocSynHdr'>per-instance config parameters</div>
399 <div class="xdocSynCode">
400 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> ListMP.<a class="xdocSynGo" href="#metaper-instance_config_parameters"><span class="xdoc-id">Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params object</span></span></a>;
401 </div>
402 <div class="xdocSynCode">
403 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metagate"><span class="xdoc-id">gate</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// GateMP used for critical region management of the shared memory</span></span></a> = <i><a class="xdoc-link" href="../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP.Handle</a></i> <span class="xdoc-kw2">null</span>;
404 </div>
405 <div class="xdocSynCode">
406 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaname"><span class="xdoc-id">name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Name of the instance</span></span></a> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
407 </div>
408 <div class="xdocSynCode">
409 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaregion.Id"><span class="xdoc-id">regionId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// SharedRegion ID</span></span></a> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
410 </div>
411 <div class="xdocSynSpacer"> </div>
412 </div>
413 <div id="xdocSep">
414 </div>
415 <div id="xdocMetaElems">
416 <div class="xdocSynSpacer"> </div>
417 <a class="xdocAnchor" id="common$"></a>
418 <table class="xdocHdr"><tr>
419 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
420 <td class="xdocHdrArrow">
421 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
422 </table>
423 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#common$">index URL</a></div>
424 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
425 <span id='meta-synop'></span>
426 <table class="xdocLabel"><tr>
427 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
428 <td class="xdocLabelRight"></td>
429 </tr></table>
430 <div class="xdocSynMdcl">
431 <div class="xdocSynCode">
432 <tt></tt><tt></tt>ListMP.<span class="xdoc-id">common$</span> = <i><a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
433 </div>
434 </div>
435 <div class="xdocSynSpacer"> </div>
436 <span id="xdoc-sect-1"></span>
437 <div class="xdocSect">DETAILS</div>
438 <div class="xdocText">All modules have this configuration parameter. Its name
439 contains the '$' character to ensure it does not conflict with
440 configuration parameters declared by the module. This allows
441 new configuration parameters to be added in the future without
442 any chance of breaking existing modules.</div>
443 <div class="xdocSynSpacer"> </div>
444 <a class="xdocAnchor" id="max.Name.Len"></a>
445 <table class="xdocHdr"><tr>
446 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP.</span><span class="xdoc-id">maxNameLen</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
447 <td class="xdocHdrArrow">
448 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
449 </table>
450 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#max.Name.Len">index URL</a></div>
451 <p class="xdocHdrSummaryDcl">Maximum length for names</p>
452 <span id='meta-synop'></span>
453 <table class="xdocLabel"><tr>
454 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
455 <td class="xdocLabelRight"></td>
456 </tr></table>
457 <div class="xdocSynMdcl">
458 <div class="xdocSynCode">
459 <tt></tt><tt></tt>ListMP.<span class="xdoc-id">maxNameLen</span> = <i><span class="xdoc-kw2">UInt</span></i> 32;
460 </div>
461 </div>
462 <div class="xdocSynSpacer"> </div>
463 <div class="xdocSynSpacer"> </div>
464 <a class="xdocAnchor" id="max.Runtime.Entries"></a>
465 <table class="xdocHdr"><tr>
466 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP.</span><span class="xdoc-id">maxRuntimeEntries</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
467 <td class="xdocHdrArrow">
468 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
469 </table>
470 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#max.Runtime.Entries">index URL</a></div>
471 <p class="xdocHdrSummaryDcl">Maximum number of ListMP's that can be dynamically created
472 and added to the NameServer</p>
473 <span id='meta-synop'></span>
474 <table class="xdocLabel"><tr>
475 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
476 <td class="xdocLabelRight"></td>
477 </tr></table>
478 <div class="xdocSynMdcl">
479 <div class="xdocSynCode">
480 <tt></tt><tt></tt>ListMP.<span class="xdoc-id">maxRuntimeEntries</span> = <i><span class="xdoc-kw2">UInt</span></i> <a class="xdoc-link" href="../../../ti/sdo/utils/NameServer.html#.A.L.L.O.W.G.R.O.W.T.H" title="ti.sdo.utils.NameServer.ALLOWGROWTH">NameServer.ALLOWGROWTH</a>;
481 </div>
482 </div>
483 <div class="xdocSynSpacer"> </div>
484 <div class="xdocSynSpacer"> </div>
485 <a class="xdocAnchor" id="table.Section"></a>
486 <table class="xdocHdr"><tr>
487 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP.</span><span class="xdoc-id">tableSection</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
488 <td class="xdocHdrArrow">
489 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
490 </table>
491 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#table.Section">index URL</a></div>
492 <p class="xdocHdrSummaryDcl">Section name is used to place the names table</p>
493 <span id='meta-synop'></span>
494 <table class="xdocLabel"><tr>
495 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
496 <td class="xdocLabelRight"></td>
497 </tr></table>
498 <div class="xdocSynMdcl">
499 <div class="xdocSynCode">
500 <tt></tt><tt></tt>ListMP.<span class="xdoc-id">tableSection</span> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
501 </div>
502 </div>
503 <div class="xdocSynSpacer"> </div>
504 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
505 <table class="xdocHdr"><tr>
506 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
507 <td class="xdocHdrArrow">
508 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
509 </table>
510 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#per-instance_config_parameters">index URL</a></div>
511 <p class="xdocHdrSummary"></p>
512 <span id='meta-synop'></span>
513 <table class="xdocLabel"><tr>
514 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
515 <td class="xdocLabelRight"></td>
516 </tr></table>
517 <div class="xdocSynMdcl">
518 <div class="xdocSynCode">
519 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> ListMP.<span class="xdoc-id">Params</span>;
520 </div>
521 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
522 <div class="xdocSynCode">
523 <tt></tt><tt> </tt>params.<span class="xdoc-id">gate</span> = <i><a class="xdoc-link" href="../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP.Handle</a></i> <span class="xdoc-kw2">null</span>;
524 </div>
525 <div class='xdocSynSum'><tt></tt><tt> </tt>// GateMP used for critical region management of the shared memory</div>
526 <div class="xdocSynCode">
527 <tt></tt><tt> </tt>params.<span class="xdoc-id">name</span> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
528 </div>
529 <div class='xdocSynSum'><tt></tt><tt> </tt>// Name of the instance</div>
530 <div class="xdocSynCode">
531 <tt></tt><tt> </tt>params.<span class="xdoc-id">regionId</span> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
532 </div>
533 <div class='xdocSynSum'><tt></tt><tt> </tt>// SharedRegion ID</div>
534 </div>
535 <div class="xdocSynSpacer"> </div>
536 <a class="xdocAnchor" id="metagate"></a>
537 <table class="xdocHdr"><tr>
538 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP.Params.</span><span class="xdoc-id">gate</span> <small><span class="xdocSynSum">// instance</span></small></td>
539 <td class="xdocHdrArrow">
540 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
541 </table>
542 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#gate">index URL</a></div>
543 <p class="xdocHdrSummaryDcl">GateMP used for critical region management of the shared memory</p>
544 <span id='meta-synop'></span>
545 <table class="xdocLabel"><tr>
546 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
547 <td class="xdocLabelRight"></td>
548 </tr></table>
549 <div class="xdocSynMdcl">
550 <div class="xdocSynCode">
551 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> ListMP.<span class="xdoc-id">Params</span>;
552 </div>
553 <div class="xdocSynCode">
554 <tt></tt><tt></tt><b> ...</b>
555 </div>
556 <div class="xdocSynCode">
557 <tt></tt><tt></tt>params.<span class="xdoc-id">gate</span> = <i><a class="xdoc-link" href="../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP.Handle</a></i> <span class="xdoc-kw2">null</span>;
558 </div>
559 </div>
560 <div class="xdocSynSpacer"> </div>
561 <span id="xdoc-sect-1"></span>
562 <div class="xdocSect">DETAILS</div>
563 <div class="xdocText">Using the default value of NULL will result in the default GateMP
564 being used for context protection.</div>
565 <div class="xdocSect">C SYNOPSIS</div>
566 <div class="xdocText"><a class="xdoc-link" href="#gate" title="ListMP_Params.gate">ListMP_Params.gate</a></div>
567 <div class="xdocSynSpacer"> </div>
568 <a class="xdocAnchor" id="metaname"></a>
569 <table class="xdocHdr"><tr>
570 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP.Params.</span><span class="xdoc-id">name</span> <small><span class="xdocSynSum">// instance</span></small></td>
571 <td class="xdocHdrArrow">
572 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
573 </table>
574 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#name">index URL</a></div>
575 <p class="xdocHdrSummaryDcl">Name of the instance</p>
576 <span id='meta-synop'></span>
577 <table class="xdocLabel"><tr>
578 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
579 <td class="xdocLabelRight"></td>
580 </tr></table>
581 <div class="xdocSynMdcl">
582 <div class="xdocSynCode">
583 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> ListMP.<span class="xdoc-id">Params</span>;
584 </div>
585 <div class="xdocSynCode">
586 <tt></tt><tt></tt><b> ...</b>
587 </div>
588 <div class="xdocSynCode">
589 <tt></tt><tt></tt>params.<span class="xdoc-id">name</span> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
590 </div>
591 </div>
592 <div class="xdocSynSpacer"> </div>
593 <span id="xdoc-sect-1"></span>
594 <div class="xdocSect">DETAILS</div>
595 <div class="xdocText">The name must be unique among all ListMP instances in the sytem.
596 When using <a class="xdoc-link" href="ListMP.html#region.Id" title="regionId">regionId</a> to create a new instance, the name must
597 not be null.</div>
598 <div class="xdocSect">C SYNOPSIS</div>
599 <div class="xdocText"><a class="xdoc-link" href="#name" title="ListMP_Params.name">ListMP_Params.name</a></div>
600 <div class="xdocSynSpacer"> </div>
601 <a class="xdocAnchor" id="metaregion.Id"></a>
602 <table class="xdocHdr"><tr>
603 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">ListMP.Params.</span><span class="xdoc-id">regionId</span> <small><span class="xdocSynSum">// instance</span></small></td>
604 <td class="xdocHdrArrow">
605 <a class="xdocHdrLink" href="../../../ti/sdo/ipc/ListMP.html" title="module ListMP"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
606 </table>
607 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/sdo/ipc/ListMP.html#region.Id">index URL</a></div>
608 <p class="xdocHdrSummaryDcl">SharedRegion ID</p>
609 <span id='meta-synop'></span>
610 <table class="xdocLabel"><tr>
611 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
612 <td class="xdocLabelRight"></td>
613 </tr></table>
614 <div class="xdocSynMdcl">
615 <div class="xdocSynCode">
616 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> ListMP.<span class="xdoc-id">Params</span>;
617 </div>
618 <div class="xdocSynCode">
619 <tt></tt><tt></tt><b> ...</b>
620 </div>
621 <div class="xdocSynCode">
622 <tt></tt><tt></tt>params.<span class="xdoc-id">regionId</span> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
623 </div>
624 </div>
625 <div class="xdocSynSpacer"> </div>
626 <span id="xdoc-sect-1"></span>
627 <div class="xdocSect">DETAILS</div>
628 <div class="xdocText">The ID corresponding to the index of the shared region in which this
629 shared instance is to be placed. This is used in create() only when
630 <a class="xdoc-link" href="ListMP.html#name" title="name">name</a> is not null.</div>
631 <div class="xdocSect">C SYNOPSIS</div>
632 <div class="xdocText"><a class="xdoc-link" href="#region.Id" title="ListMP_Params.regionId">ListMP_Params.regionId</a></div>
633 </div>
634 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:24 GMT</div>
635 </div></div></body>
636 </html>