[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / family / c647x / NotifySetup.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.family.c647x.NotifySetup</title>
4 <meta name="description" content="Manages setup of the default Notify driver handles">
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.family.c647x.</span><span class="xdoc-id">NotifySetup</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifyCircSetup.html" title="module NotifyCircSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/package.html" title="package ti.sdo.ipc.family.c647x"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
14 </table>
15 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html">index URL</a></div>
16 <p class="xdocHdrSummary">Manages setup of the default Notify driver handles</p>
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 <div class="xdocBrief">
24 Creates the default notify drivers for each pair of processors.
25 </div>
26 <span id='targ-synop'></span>
27 <table class="xdocLabel"><tr>
28 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
29 <td class="xdocLabelCenter">target-domain</td>
30 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/c647x/NotifySetup.xdc</span></a></td>
31 </tr></table>
32 <div class="xdocSynT">
33 <div class="xdocSynCode">
34 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/family/c647x/NotifySetup.h></span>
35 </div>
36 <table cellspacing="0" cellpadding="0" border="0">
37 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all INotifySetup modules</div></td></tr>
39 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#attach"><span class="xdoc-id">NotifySetup_attach</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Function that will be called in Notify_attach</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);</div></td></tr>
40 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">UInt16</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#num.Int.Lines"><span class="xdoc-id">NotifySetup_numIntLines</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns number of interrupt lines to the processor</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);</div></td></tr>
41 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">SizeT</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#shared.Mem.Req"><span class="xdoc-id">NotifySetup_sharedMemReq</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Shared Memory Required for a single notification line</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);</div></td></tr>
42 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
44 <tr>
45 <td></td>
46 <td>
47 <div class="xdocSynTblPack">
48 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifySetup_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
49 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifySetup_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
50 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifySetup_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
51 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifySetup_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
52 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifySetup_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
53 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifySetup_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
54 </div>
55 </td>
56 </tr>
57 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
59 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#dsp.Int.Vect.Id"><span class="xdoc-id">NotifySetup_dspIntVectId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;</div></td></tr>
60 </table>
61 <div class="xdocSynSpacer"> </div>
62 </div>
63 <div id="xdocSep">
64 </div>
65 <div id="xdocElems">
66 <div class="xdocSynSpacer"> </div>
67 <a class="xdocAnchor" id="dsp.Int.Vect.Id"></a>
68 <table class="xdocHdr"><tr>
69 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifySetup_</span><span class="xdoc-id">dspIntVectId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
70 <td class="xdocHdrArrow">
71 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup.html" title="module NotifySetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
72 </table>
73 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html#dsp.Int.Vect.Id">index URL</a></div>
74 <span id='targ-synop'></span>
75 <table class="xdocLabel"><tr>
76 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
77 <td class="xdocLabelRight">target-domain</td>
78 </tr></table>
79 <div class="xdocSynTdcl">
80 <div class="xdocSynCode">
81 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">NotifySetup_dspIntVectId</span>;
82 </div>
83 </div>
84 <div class="xdocSynSpacer"> </div>
85 <div class="xdocSynSpacer"> </div>
86 <a class="xdocAnchor" id="attach"></a>
87 <table class="xdocHdr"><tr>
88 <td class="xdocHdrTitle"><span class="xdoc-id">NotifySetup_</span><span class="xdoc-id">attach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
89 <td class="xdocHdrArrow">
90 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup.html" title="module NotifySetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
91 </table>
92 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html#attach">index URL</a></div>
93 <p class="xdocHdrSummaryDcl">Function that will be called in Notify_attach</p>
94 <span id='targ-synop'></span>
95 <table class="xdocLabel"><tr>
96 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
97 <td class="xdocLabelRight">target-domain</td>
98 </tr></table>
99 <div class="xdocSynTdcl">
100 <div class="xdocSynCode">
101 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NotifySetup_attach</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
102 </div>
103 </div>
104 <div class="xdocSynSpacer"> </div>
105 <div class="xdocSynSpacer"> </div>
106 <a class="xdocAnchor" id="num.Int.Lines"></a>
107 <table class="xdocHdr"><tr>
108 <td class="xdocHdrTitle"><span class="xdoc-id">NotifySetup_</span><span class="xdoc-id">numIntLines</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
109 <td class="xdocHdrArrow">
110 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup.html" title="module NotifySetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
111 </table>
112 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html#num.Int.Lines">index URL</a></div>
113 <p class="xdocHdrSummaryDcl">Returns number of interrupt lines to the processor</p>
114 <span id='targ-synop'></span>
115 <table class="xdocLabel"><tr>
116 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
117 <td class="xdocLabelRight">target-domain</td>
118 </tr></table>
119 <div class="xdocSynTdcl">
120 <div class="xdocSynCode">
121 <tt></tt><tt></tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">NotifySetup_numIntLines</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);
122 </div>
123 </div>
124 <div class="xdocSynSpacer"> </div>
125 <div class="xdocSynSpacer"> </div>
126 <a class="xdocAnchor" id="shared.Mem.Req"></a>
127 <table class="xdocHdr"><tr>
128 <td class="xdocHdrTitle"><span class="xdoc-id">NotifySetup_</span><span class="xdoc-id">sharedMemReq</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
129 <td class="xdocHdrArrow">
130 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup.html" title="module NotifySetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
131 </table>
132 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html#shared.Mem.Req">index URL</a></div>
133 <p class="xdocHdrSummaryDcl">Shared Memory Required for a single notification line</p>
134 <span id='targ-synop'></span>
135 <table class="xdocLabel"><tr>
136 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
137 <td class="xdocLabelRight">target-domain</td>
138 </tr></table>
139 <div class="xdocSynTdcl">
140 <div class="xdocSynCode">
141 <tt></tt><tt></tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">NotifySetup_sharedMemReq</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
142 </div>
143 </div>
144 <div class="xdocSynSpacer"> </div>
145 <a class="xdocAnchor" id="module-wide_built-ins"></a>
146 <table class="xdocHdr"><tr>
147 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
148 <td class="xdocHdrArrow">
149 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup.html" title="module NotifySetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
150 </table>
151 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html#module-wide_built-ins">index URL</a></div>
152 <p class="xdocHdrSummary"></p>
153 <span id='targ-synop'></span>
154 <table class="xdocLabel"><tr>
155 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
156 <td class="xdocLabelRight">target-domain</td>
157 </tr></table>
158 <div class="xdocSynTdcl">
159 <div class="xdocSynCode">
160 <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">NotifySetup_Module_id</span>();
161 </div>
162 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
163 <div class="xdocSynSpacer"> </div>
164 <div class="xdocSynCode">
165 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NotifySetup_Module_startupDone</span>();
166 </div>
167 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
168 <div class="xdocSynSpacer"> </div>
169 <div class="xdocSynCode">
170 <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">NotifySetup_Module_heap</span>();
171 </div>
172 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
173 <div class="xdocSynSpacer"> </div>
174 <div class="xdocSynCode">
175 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NotifySetup_Module_hasMask</span>();
176 </div>
177 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
178 <div class="xdocSynSpacer"> </div>
179 <div class="xdocSynCode">
180 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">NotifySetup_Module_getMask</span>();
181 </div>
182 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
183 <div class="xdocSynSpacer"> </div>
184 <div class="xdocSynCode">
185 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifySetup_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
186 </div>
187 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
188 </div>
189 </div>
190 <div class="xdocSynSpacer"> </div>
191 <span id='meta-synop'></span>
192 <table class="xdocLabel"><tr>
193 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
194 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/c647x/NotifySetup.xdc</span></a></td>
195 </tr></table>
196 <div class="xdocSynM">
197 <div class="xdocSynCode">
198 <tt></tt><span class="xdoc-kw1">var</span> NotifySetup = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.family.c647x.NotifySetup'</span>);
199 </div>
200 <div class='xdocSynHdr'>module-wide config parameters</div>
202 <div class="xdocSynCode">
203 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metadsp.Int.Vect.Id">NotifySetup.<span class="xdoc-id">dspIntVectId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 5;
204 </div>
205 <div class="xdocSynSpacer"> </div>
206 <div class="xdocSynCode">
207 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">NotifySetup.<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>;
208 </div>
209 <div class="xdocSynSpacer"> </div>
210 </div>
211 <div id="xdocSep">
212 </div>
213 <div id="xdocMetaElems">
214 <div class="xdocSynSpacer"> </div>
215 <a class="xdocAnchor" id="metadsp.Int.Vect.Id"></a>
216 <table class="xdocHdr"><tr>
217 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifySetup.</span><span class="xdoc-id">dspIntVectId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
218 <td class="xdocHdrArrow">
219 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup.html" title="module NotifySetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
220 </table>
221 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html#dsp.Int.Vect.Id">index URL</a></div>
222 <span id='meta-synop'></span>
223 <table class="xdocLabel"><tr>
224 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
225 <td class="xdocLabelRight"></td>
226 </tr></table>
227 <div class="xdocSynMdcl">
228 <div class="xdocSynCode">
229 <tt></tt><tt></tt>NotifySetup.<span class="xdoc-id">dspIntVectId</span> = <i><span class="xdoc-kw2">UInt</span></i> 5;
230 </div>
231 </div>
232 <div class="xdocSynSpacer"> </div>
233 <div class="xdocSect">C SYNOPSIS</div>
234 <div class="xdocText"><a class="xdoc-link" href="#dsp.Int.Vect.Id" title="NotifySetup_dspIntVectId">NotifySetup_dspIntVectId</a></div>
235 <div class="xdocSynSpacer"> </div>
236 <a class="xdocAnchor" id="common$"></a>
237 <table class="xdocHdr"><tr>
238 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifySetup.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
239 <td class="xdocHdrArrow">
240 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c647x/NotifySetup.html" title="module NotifySetup"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
241 </table>
242 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c647x/NotifySetup.html#common$">index URL</a></div>
243 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
244 <span id='meta-synop'></span>
245 <table class="xdocLabel"><tr>
246 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
247 <td class="xdocLabelRight"></td>
248 </tr></table>
249 <div class="xdocSynMdcl">
250 <div class="xdocSynCode">
251 <tt></tt><tt></tt>NotifySetup.<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>;
252 </div>
253 </div>
254 <div class="xdocSynSpacer"> </div>
255 <span id="xdoc-sect-1"></span>
256 <div class="xdocSect">DETAILS</div>
257 <div class="xdocText">All modules have this configuration parameter. Its name
258 contains the '$' character to ensure it does not conflict with
259 configuration parameters declared by the module. This allows
260 new configuration parameters to be added in the future without
261 any chance of breaking existing modules.</div>
262 </div>
263 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:18 GMT</div>
264 </div></div></body>
265 </html>