[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / family / tci663x / MultiProcSetup.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.family.tci663x.MultiProcSetup</title>
4 <link rel="stylesheet" type="text/css" href="../../../../../xdoc.css" />
5 </head>
6 <body><div id="xdocWrapper"><div id="xdocContent">
7 <table class="xdocHdr"><tr>
8 <td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.sdo.ipc.family.tci663x.</span><span class="xdoc-id">MultiProcSetup</span></td>
9 <td class="xdocHdrArrow">
10 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../../Arrow_left.png"/></a></td>
11 <td class="xdocHdrArrow">
12 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/package.html" title="package ti.sdo.ipc.family.tci663x"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
13 <td class="xdocHdrArrow">
14 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/NotifyCircSetup.html" title="module NotifyCircSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_right.png"/></a></td>
15 </table>
16 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tci663x/MultiProcSetup.html">index URL</a></div>
17 <ul class="xdocToc">
18 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
19 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
20 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
21 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
22 </ul>
23 <span id='targ-synop'></span>
24 <table class="xdocLabel"><tr>
25 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
26 <td class="xdocLabelCenter">target-domain</td>
27 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/tci663x/MultiProcSetup.xdc</span></a></td>
28 </tr></table>
29 <div class="xdocSynT">
30 <div class="xdocSynCode">
31 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/family/tci663x/MultiProcSetup.h></span>
32 </div>
33 <table cellspacing="0" cellpadding="0" border="0">
34 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
36 <tr>
37 <td></td>
38 <td>
39 <div class="xdocSynTblPack">
40 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">MultiProcSetup_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
41 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">MultiProcSetup_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
42 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">MultiProcSetup_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
43 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">MultiProcSetup_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
44 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">MultiProcSetup_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
45 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">MultiProcSetup_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
46 </div>
47 </td>
48 </tr>
49 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
51 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_invalid.Processor"><span class="xdoc-id">MultiProcSetup_A_invalidProcessor</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the target core is not in the MultiProc name list</span></span></a>;</div></td></tr>
52 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">Bool</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#configure.Proc.Id"><span class="xdoc-id">MultiProcSetup_configureProcId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// By default the MultiProcSetup module will set the ID at startup</span></span></a>;</div></td></tr>
53 </table>
54 <div class="xdocSynSpacer"> </div>
55 </div>
56 <div id="xdocSep">
57 </div>
58 <div id="xdocElems">
59 <div class="xdocSynSpacer"> </div>
60 <a class="xdocAnchor" id=".A_invalid.Processor"></a>
61 <table class="xdocHdr"><tr>
62 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">MultiProcSetup_</span><span class="xdoc-id">A_invalidProcessor</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
63 <td class="xdocHdrArrow">
64 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup.html" title="module MultiProcSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
65 </table>
66 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tci663x/MultiProcSetup.html#.A_invalid.Processor">index URL</a></div>
67 <p class="xdocHdrSummaryDcl">Assert raised when the target core is not in the MultiProc name list</p>
68 <span id='targ-synop'></span>
69 <table class="xdocLabel"><tr>
70 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
71 <td class="xdocLabelRight">target-domain</td>
72 </tr></table>
73 <div class="xdocSynTdcl">
74 <div class="xdocSynCode">
75 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">MultiProcSetup_A_invalidProcessor</span>;
76 </div>
77 </div>
78 <div class="xdocSynSpacer"> </div>
79 <div class="xdocSynSpacer"> </div>
80 <a class="xdocAnchor" id="configure.Proc.Id"></a>
81 <table class="xdocHdr"><tr>
82 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">MultiProcSetup_</span><span class="xdoc-id">configureProcId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
83 <td class="xdocHdrArrow">
84 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup.html" title="module MultiProcSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
85 </table>
86 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tci663x/MultiProcSetup.html#configure.Proc.Id">index URL</a></div>
87 <p class="xdocHdrSummaryDcl">By default the MultiProcSetup module will set the ID at startup</p>
88 <span id='targ-synop'></span>
89 <table class="xdocLabel"><tr>
90 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
91 <td class="xdocLabelRight">target-domain</td>
92 </tr></table>
93 <div class="xdocSynTdcl">
94 <div class="xdocSynCode">
95 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">Bool</span> <span class="xdoc-id">MultiProcSetup_configureProcId</span>;
96 </div>
97 </div>
98 <div class="xdocSynSpacer"> </div>
99 <span id="xdoc-sect-1"></span>
100 <div class="xdocSect">DETAILS</div>
101 <div class="xdocText">By setting this flag to false, the initialization step is suppressed.</div>
102 <a class="xdocAnchor" id="module-wide_built-ins"></a>
103 <table class="xdocHdr"><tr>
104 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
105 <td class="xdocHdrArrow">
106 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup.html" title="module MultiProcSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
107 </table>
108 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tci663x/MultiProcSetup.html#module-wide_built-ins">index URL</a></div>
109 <p class="xdocHdrSummary"></p>
110 <span id='targ-synop'></span>
111 <table class="xdocLabel"><tr>
112 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
113 <td class="xdocLabelRight">target-domain</td>
114 </tr></table>
115 <div class="xdocSynTdcl">
116 <div class="xdocSynCode">
117 <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">MultiProcSetup_Module_id</span>();
118 </div>
119 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
120 <div class="xdocSynSpacer"> </div>
121 <div class="xdocSynCode">
122 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">MultiProcSetup_Module_startupDone</span>();
123 </div>
124 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
125 <div class="xdocSynSpacer"> </div>
126 <div class="xdocSynCode">
127 <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">MultiProcSetup_Module_heap</span>();
128 </div>
129 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
130 <div class="xdocSynSpacer"> </div>
131 <div class="xdocSynCode">
132 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">MultiProcSetup_Module_hasMask</span>();
133 </div>
134 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
135 <div class="xdocSynSpacer"> </div>
136 <div class="xdocSynCode">
137 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">MultiProcSetup_Module_getMask</span>();
138 </div>
139 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
140 <div class="xdocSynSpacer"> </div>
141 <div class="xdocSynCode">
142 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">MultiProcSetup_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
143 </div>
144 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
145 </div>
146 </div>
147 <div class="xdocSynSpacer"> </div>
148 <span id='meta-synop'></span>
149 <table class="xdocLabel"><tr>
150 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
151 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/tci663x/MultiProcSetup.xdc</span></a></td>
152 </tr></table>
153 <div class="xdocSynM">
154 <div class="xdocSynCode">
155 <tt></tt><span class="xdoc-kw1">var</span> MultiProcSetup = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.family.tci663x.MultiProcSetup'</span>);
156 </div>
157 <div class='xdocSynHdr'>module-wide config parameters</div>
159 <div class="xdocSynCode">
160 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_invalid.Processor">MultiProcSetup.<span class="xdoc-id">A_invalidProcessor</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the target core is not in the MultiProc name list</span></span></a> = <i><a class="xdoc-link" href="../../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
161 </div>
162 <div class="xdocSynCode">
163 <tt> </tt><tt> </tt>msg: "A_invalidProcessor: This core is not present in the MultiProc name list"
164 </div>
165 <div class="xdocSynCode">
166 <tt> </tt><tt></tt>};
167 </div>
168 <div class="xdocSynCode">
169 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metaconfigure.Proc.Id">MultiProcSetup.<span class="xdoc-id">configureProcId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// By default the MultiProcSetup module will set the ID at startup</span></span></a> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
170 </div>
171 <div class="xdocSynSpacer"> </div>
172 <div class="xdocSynCode">
173 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">MultiProcSetup.<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>;
174 </div>
175 <div class="xdocSynSpacer"> </div>
176 </div>
177 <div id="xdocSep">
178 </div>
179 <div id="xdocMetaElems">
180 <div class="xdocSynSpacer"> </div>
181 <a class="xdocAnchor" id="meta.A_invalid.Processor"></a>
182 <table class="xdocHdr"><tr>
183 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">MultiProcSetup.</span><span class="xdoc-id">A_invalidProcessor</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
184 <td class="xdocHdrArrow">
185 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup.html" title="module MultiProcSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
186 </table>
187 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tci663x/MultiProcSetup.html#.A_invalid.Processor">index URL</a></div>
188 <p class="xdocHdrSummaryDcl">Assert raised when the target core is not in the MultiProc name list</p>
189 <span id='meta-synop'></span>
190 <table class="xdocLabel"><tr>
191 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
192 <td class="xdocLabelRight"></td>
193 </tr></table>
194 <div class="xdocSynMdcl">
195 <div class="xdocSynCode">
196 <tt></tt><tt></tt>MultiProcSetup.<span class="xdoc-id">A_invalidProcessor</span> = <i><a class="xdoc-link" href="../../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
197 </div>
198 <div class="xdocSynCode">
199 <tt></tt><tt> </tt>msg: "A_invalidProcessor: This core is not present in the MultiProc name list"
200 </div>
201 <div class="xdocSynCode">
202 <tt></tt><tt></tt>};
203 </div>
204 </div>
205 <div class="xdocSynSpacer"> </div>
206 <div class="xdocSect">C SYNOPSIS</div>
207 <div class="xdocText"><a class="xdoc-link" href="#.A_invalid.Processor" title="MultiProcSetup_A_invalidProcessor">MultiProcSetup_A_invalidProcessor</a></div>
208 <div class="xdocSynSpacer"> </div>
209 <a class="xdocAnchor" id="metaconfigure.Proc.Id"></a>
210 <table class="xdocHdr"><tr>
211 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">MultiProcSetup.</span><span class="xdoc-id">configureProcId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
212 <td class="xdocHdrArrow">
213 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup.html" title="module MultiProcSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
214 </table>
215 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tci663x/MultiProcSetup.html#configure.Proc.Id">index URL</a></div>
216 <p class="xdocHdrSummaryDcl">By default the MultiProcSetup module will set the ID at startup</p>
217 <span id='meta-synop'></span>
218 <table class="xdocLabel"><tr>
219 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
220 <td class="xdocLabelRight"></td>
221 </tr></table>
222 <div class="xdocSynMdcl">
223 <div class="xdocSynCode">
224 <tt></tt><tt></tt>MultiProcSetup.<span class="xdoc-id">configureProcId</span> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
225 </div>
226 </div>
227 <div class="xdocSynSpacer"> </div>
228 <span id="xdoc-sect-1"></span>
229 <div class="xdocSect">DETAILS</div>
230 <div class="xdocText">By setting this flag to false, the initialization step is suppressed.</div>
231 <div class="xdocSect">C SYNOPSIS</div>
232 <div class="xdocText"><a class="xdoc-link" href="#configure.Proc.Id" title="MultiProcSetup_configureProcId">MultiProcSetup_configureProcId</a></div>
233 <div class="xdocSynSpacer"> </div>
234 <a class="xdocAnchor" id="common$"></a>
235 <table class="xdocHdr"><tr>
236 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">MultiProcSetup.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
237 <td class="xdocHdrArrow">
238 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tci663x/MultiProcSetup.html" title="module MultiProcSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
239 </table>
240 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tci663x/MultiProcSetup.html#common$">index URL</a></div>
241 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
242 <span id='meta-synop'></span>
243 <table class="xdocLabel"><tr>
244 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
245 <td class="xdocLabelRight"></td>
246 </tr></table>
247 <div class="xdocSynMdcl">
248 <div class="xdocSynCode">
249 <tt></tt><tt></tt>MultiProcSetup.<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>;
250 </div>
251 </div>
252 <div class="xdocSynSpacer"> </div>
253 <span id="xdoc-sect-1"></span>
254 <div class="xdocSect">DETAILS</div>
255 <div class="xdocText">All modules have this configuration parameter. Its name
256 contains the '$' character to ensure it does not conflict with
257 configuration parameters declared by the module. This allows
258 new configuration parameters to be added in the future without
259 any chance of breaking existing modules.</div>
260 </div>
261 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:17 GMT</div>
262 </div></div></body>
263 </html>