[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / family / tci6638 / Interrupt.html
1 <html>
2 <head>
3 <title>module ti.ipc.family.tci6638.Interrupt</title>
4 <meta name="description" content="TCI66xx IPC interrupt manager">
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.ipc.family.tci6638.</span><span class="xdoc-id">Interrupt</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/package.html" title="package ti.ipc.family.tci6638"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/NotifyCircSetup.html" title="module NotifyCircSetup"><img class="xdocHdrArrow" src="../../../../Arrow_right.png"/></a></td>
14 </table>
15 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html">index URL</a></div>
16 <p class="xdocHdrSummary">TCI66xx IPC interrupt manager</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 <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/ipc/family/tci6638/Interrupt-src.html"><span class="xdocLabelFile">ti/ipc/family/tci6638/Interrupt.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/ipc/family/tci6638/Interrupt.h></span>
32 </div>
33 <table cellspacing="0" cellpadding="0" border="0">
34 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
36 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#check.And.Clear"><span class="xdoc-id">Interrupt_checkAndClear</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Check to see that interrupt is set, if so clear it and return 1</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/ipc/family/tci6638/Interrupt.html#.Int.Info" title="ti.ipc.family.tci6638.Interrupt.IntInfo">Interrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);</div></td></tr>
37 <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="#int.Clear.All"><span class="xdoc-id">Interrupt_intClearAll</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Clear all pending interrupts</span></span></a>();</div></td></tr>
38 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all IInterrupt modules</div></td></tr>
40 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#int.Clear"><span class="xdoc-id">Interrupt_intClear</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Clear interrupt</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);</div></td></tr>
41 <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="#int.Disable"><span class="xdoc-id">Interrupt_intDisable</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Disables the interrupt corresponding to intId</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);</div></td></tr>
42 <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="#int.Enable"><span class="xdoc-id">Interrupt_intEnable</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Enables the interrupt corresponding to intId</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);</div></td></tr>
43 <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="#int.Register"><span class="xdoc-id">Interrupt_intRegister</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Register an interrupt line to a remote processor</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>, <span class="xdoc-kw2">Fxn</span> <span class="xdoc-id">func</span>, <span class="xdoc-kw2">UArg</span> <span class="xdoc-id">arg</span>);</div></td></tr>
44 <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="#int.Send"><span class="xdoc-id">Interrupt_intSend</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Send interrupt to the remote processor</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>, <span class="xdoc-kw2">UArg</span> <span class="xdoc-id">arg</span>);</div></td></tr>
45 <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="#int.Unregister"><span class="xdoc-id">Interrupt_intUnregister</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Unregister an interrupt line to a remote processor</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);</div></td></tr>
46 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
48 <tr>
49 <td></td>
50 <td>
51 <div class="xdocSynTblPack">
52 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Interrupt_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
53 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Interrupt_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
54 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Interrupt_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
55 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Interrupt_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
56 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Interrupt_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
57 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">Interrupt_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
58 </div>
59 </td>
60 </tr>
61 <tr><td colspan='2'><div class='xdocSynTblHdr'>Defines</div></td></tr>
63 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw3">#define</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.I.N.V.A.L.I.D.P.A.Y.L.O.A.D"><span class="xdoc-id">Interrupt_INVALIDPAYLOAD</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> (<i><span class="xdoc-kw2">UInt</span></i>)0xFFFFFFFF</div></td></tr>
64 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
66 <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="#.Int.Info"><span class="xdoc-id">Interrupt_IntInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> ...</div></td></tr>
67 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
69 <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_not.Implemented"><span class="xdoc-id">Interrupt_A_notImplemented</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Function not implemented</span></span></a>;</div></td></tr>
70 <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="#enable.Kick"><span class="xdoc-id">Interrupt_enableKick</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// If set to 'true' IPC will unlock the KICK registers on C66x devices</span></span></a>;</div></td></tr>
71 </table>
72 <div class="xdocSynSpacer"> </div>
73 </div>
74 <div id="xdocSep">
75 </div>
76 <div id="xdocElems">
77 <div class="xdocSynSpacer"> </div>
78 <a class="xdocAnchor" id=".I.N.V.A.L.I.D.P.A.Y.L.O.A.D"></a>
79 <table class="xdocHdr"><tr>
80 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">Interrupt_</span><span class="xdoc-id">INVALIDPAYLOAD</span></td>
81 <td class="xdocHdrArrow">
82 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
83 </table>
84 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#.I.N.V.A.L.I.D.P.A.Y.L.O.A.D">index URL</a></div>
85 <span id='targ-synop'></span>
86 <table class="xdocLabel"><tr>
87 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
88 <td class="xdocLabelRight">target-domain</td>
89 </tr></table>
90 <div class="xdocSynTdcl">
91 <div class="xdocSynCode">
92 <tt></tt><tt></tt><span class="xdoc-kw3">#define</span> <span class="xdoc-id">Interrupt_INVALIDPAYLOAD</span> (<i><span class="xdoc-kw2">UInt</span></i>)0xFFFFFFFF
93 </div>
94 </div>
95 <div class="xdocSynSpacer"> </div>
96 <div class="xdocSynSpacer"> </div>
97 <a class="xdocAnchor" id=".Int.Info"></a>
98 <table class="xdocHdr"><tr>
99 <td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">Interrupt_</span><span class="xdoc-id">IntInfo</span></td>
100 <td class="xdocHdrArrow">
101 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
102 </table>
103 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#.Int.Info">index URL</a></div>
104 <span id='targ-synop'></span>
105 <table class="xdocLabel"><tr>
106 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
107 <td class="xdocLabelRight">target-domain</td>
108 </tr></table>
109 <div class="xdocSynTdcl">
110 <div class="xdocSynCode">
111 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">Interrupt_IntInfo</span> {
112 </div>
113 <div class="xdocSynCode">
114 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">localIntId</span></span>;
115 </div>
116 <div class="xdocSynCode">
117 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">remoteIntId</span></span>;
118 </div>
119 <div class="xdocSynCode">
120 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">intVectorId</span></span>;
121 </div>
122 <div class="xdocSynCode">
123 <tt></tt><tt></tt>} <span class="xdoc-id">Interrupt_IntInfo</span>;
124 </div>
125 </div>
126 <div class="xdocSynSpacer"> </div>
127 <div class="xdocSynSpacer"> </div>
128 <a class="xdocAnchor" id=".A_not.Implemented"></a>
129 <table class="xdocHdr"><tr>
130 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Interrupt_</span><span class="xdoc-id">A_notImplemented</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
131 <td class="xdocHdrArrow">
132 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
133 </table>
134 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#.A_not.Implemented">index URL</a></div>
135 <p class="xdocHdrSummaryDcl">Function not implemented</p>
136 <span id='targ-synop'></span>
137 <table class="xdocLabel"><tr>
138 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
139 <td class="xdocLabelRight">target-domain</td>
140 </tr></table>
141 <div class="xdocSynTdcl">
142 <div class="xdocSynCode">
143 <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">Interrupt_A_notImplemented</span>;
144 </div>
145 </div>
146 <div class="xdocSynSpacer"> </div>
147 <div class="xdocSynSpacer"> </div>
148 <a class="xdocAnchor" id="enable.Kick"></a>
149 <table class="xdocHdr"><tr>
150 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Interrupt_</span><span class="xdoc-id">enableKick</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
151 <td class="xdocHdrArrow">
152 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><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/ipc/family/tci6638/Interrupt.html#enable.Kick">index URL</a></div>
155 <p class="xdocHdrSummaryDcl">If set to 'true' IPC will unlock the KICK registers on C66x devices</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">extern const</span> <span class="xdoc-kw2">Bool</span> <span class="xdoc-id">Interrupt_enableKick</span>;
164 </div>
165 </div>
166 <div class="xdocSynSpacer"> </div>
167 <span id="xdoc-sect-1"></span>
168 <div class="xdocSect">DETAILS</div>
169 <div class="xdocText">IPC unlocks the KICK registers on the local core if (and only if) all
170 the following conditions are met:
171 - This configuration is set to 'true'
172 - SharedRegion #0 is valid and the local core is its owner
173 - SharedRegion #0 is not valid and the local core is CORE0</div>
174 <div class="xdocSynSpacer"> </div>
175 <a class="xdocAnchor" id="check.And.Clear"></a>
176 <table class="xdocHdr"><tr>
177 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">checkAndClear</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
178 <td class="xdocHdrArrow">
179 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
180 </table>
181 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#check.And.Clear">index URL</a></div>
182 <p class="xdocHdrSummaryDcl">Check to see that interrupt is set, if so clear it and return 1</p>
183 <span id='targ-synop'></span>
184 <table class="xdocLabel"><tr>
185 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
186 <td class="xdocLabelRight">target-domain</td>
187 </tr></table>
188 <div class="xdocSynTdcl">
189 <div class="xdocSynCode">
190 <tt></tt><tt></tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">Interrupt_checkAndClear</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/ipc/family/tci6638/Interrupt.html#.Int.Info" title="ti.ipc.family.tci6638.Interrupt.IntInfo">Interrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);
191 </div>
192 </div>
193 <div class="xdocSynSpacer"> </div>
194 <div class="xdocSynSpacer"> </div>
195 <a class="xdocAnchor" id="int.Clear"></a>
196 <table class="xdocHdr"><tr>
197 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">intClear</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
198 <td class="xdocHdrArrow">
199 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
200 </table>
201 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#int.Clear">index URL</a></div>
202 <p class="xdocHdrSummaryDcl">Clear interrupt</p>
203 <span id='targ-synop'></span>
204 <table class="xdocLabel"><tr>
205 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
206 <td class="xdocLabelRight">target-domain</td>
207 </tr></table>
208 <div class="xdocSynTdcl">
209 <div class="xdocSynCode">
210 <tt></tt><tt></tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">Interrupt_intClear</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);
211 </div>
212 </div>
213 <div class="xdocSynSpacer"> </div>
214 <span id="xdoc-sect-1"></span>
215 <div class="xdocSect">ARGUMENTS</div>
216 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
217 <span class="xdocChildSum">— Remote MultiProc Id</span>
218 </div>
219 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
220 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
221 </div>
222 <span id="xdoc-sect-2"></span>
223 <div class="xdocSect">RETURNS</div>
224 <div class="xdocText">Value (if any) of the interrupt before
225 it was cleared</div>
226 <div class="xdocSynSpacer"> </div>
227 <a class="xdocAnchor" id="int.Clear.All"></a>
228 <table class="xdocHdr"><tr>
229 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">intClearAll</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
230 <td class="xdocHdrArrow">
231 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
232 </table>
233 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#int.Clear.All">index URL</a></div>
234 <p class="xdocHdrSummaryDcl">Clear all pending interrupts</p>
235 <span id='targ-synop'></span>
236 <table class="xdocLabel"><tr>
237 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
238 <td class="xdocLabelRight">target-domain</td>
239 </tr></table>
240 <div class="xdocSynTdcl">
241 <div class="xdocSynCode">
242 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Interrupt_intClearAll</span>();
243 </div>
244 </div>
245 <div class="xdocSynSpacer"> </div>
246 <div class="xdocSynSpacer"> </div>
247 <a class="xdocAnchor" id="int.Disable"></a>
248 <table class="xdocHdr"><tr>
249 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">intDisable</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
250 <td class="xdocHdrArrow">
251 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
252 </table>
253 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#int.Disable">index URL</a></div>
254 <p class="xdocHdrSummaryDcl">Disables the interrupt corresponding to intId</p>
255 <span id='targ-synop'></span>
256 <table class="xdocLabel"><tr>
257 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
258 <td class="xdocLabelRight">target-domain</td>
259 </tr></table>
260 <div class="xdocSynTdcl">
261 <div class="xdocSynCode">
262 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Interrupt_intDisable</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);
263 </div>
264 </div>
265 <div class="xdocSynSpacer"> </div>
266 <span id="xdoc-sect-1"></span>
267 <div class="xdocSect">ARGUMENTS</div>
268 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
269 <span class="xdocChildSum">— Remote MultiProc Id</span>
270 </div>
271 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
272 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
273 </div>
274 <div class="xdocSynSpacer"> </div>
275 <a class="xdocAnchor" id="int.Enable"></a>
276 <table class="xdocHdr"><tr>
277 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">intEnable</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
278 <td class="xdocHdrArrow">
279 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
280 </table>
281 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#int.Enable">index URL</a></div>
282 <p class="xdocHdrSummaryDcl">Enables the interrupt corresponding to intId</p>
283 <span id='targ-synop'></span>
284 <table class="xdocLabel"><tr>
285 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
286 <td class="xdocLabelRight">target-domain</td>
287 </tr></table>
288 <div class="xdocSynTdcl">
289 <div class="xdocSynCode">
290 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Interrupt_intEnable</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);
291 </div>
292 </div>
293 <div class="xdocSynSpacer"> </div>
294 <span id="xdoc-sect-1"></span>
295 <div class="xdocSect">ARGUMENTS</div>
296 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
297 <span class="xdocChildSum">— Remote MultiProc Id</span>
298 </div>
299 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
300 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
301 </div>
302 <div class="xdocSynSpacer"> </div>
303 <a class="xdocAnchor" id="int.Register"></a>
304 <table class="xdocHdr"><tr>
305 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">intRegister</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
306 <td class="xdocHdrArrow">
307 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
308 </table>
309 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#int.Register">index URL</a></div>
310 <p class="xdocHdrSummaryDcl">Register an interrupt line to a remote processor</p>
311 <span id='targ-synop'></span>
312 <table class="xdocLabel"><tr>
313 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
314 <td class="xdocLabelRight">target-domain</td>
315 </tr></table>
316 <div class="xdocSynTdcl">
317 <div class="xdocSynCode">
318 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Interrupt_intRegister</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>, <span class="xdoc-kw2">Fxn</span> <span class="xdoc-id">func</span>, <span class="xdoc-kw2">UArg</span> <span class="xdoc-id">arg</span>);
319 </div>
320 </div>
321 <div class="xdocSynSpacer"> </div>
322 <span id="xdoc-sect-1"></span>
323 <div class="xdocSect">ARGUMENTS</div>
324 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
325 <span class="xdocChildSum">— Remote MultiProc Id</span>
326 </div>
327 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
328 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
329 </div>
330 <div class="xdocChild"><span class="xdocChildId">func</span>
331 <span class="xdocChildSum">— Function to register.</span>
332 </div>
333 <div class="xdocChild"><span class="xdocChildId">arg</span>
334 <span class="xdocChildSum">— Argument that will be passed to func</span>
335 </div>
336 <div class="xdocSynSpacer"> </div>
337 <a class="xdocAnchor" id="int.Send"></a>
338 <table class="xdocHdr"><tr>
339 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">intSend</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
340 <td class="xdocHdrArrow">
341 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
342 </table>
343 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#int.Send">index URL</a></div>
344 <p class="xdocHdrSummaryDcl">Send interrupt to the remote processor</p>
345 <span id='targ-synop'></span>
346 <table class="xdocLabel"><tr>
347 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
348 <td class="xdocLabelRight">target-domain</td>
349 </tr></table>
350 <div class="xdocSynTdcl">
351 <div class="xdocSynCode">
352 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Interrupt_intSend</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>, <span class="xdoc-kw2">UArg</span> <span class="xdoc-id">arg</span>);
353 </div>
354 </div>
355 <div class="xdocSynSpacer"> </div>
356 <span id="xdoc-sect-1"></span>
357 <div class="xdocSect">ARGUMENTS</div>
358 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
359 <span class="xdocChildSum">— Remote MultiProc Id</span>
360 </div>
361 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
362 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
363 </div>
364 <div class="xdocChild"><span class="xdocChildId">arg</span>
365 <span class="xdocChildSum">— Argument for sending interrupt.</span>
366 </div>
367 <div class="xdocSynSpacer"> </div>
368 <a class="xdocAnchor" id="int.Unregister"></a>
369 <table class="xdocHdr"><tr>
370 <td class="xdocHdrTitle"><span class="xdoc-id">Interrupt_</span><span class="xdoc-id">intUnregister</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
371 <td class="xdocHdrArrow">
372 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
373 </table>
374 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#int.Unregister">index URL</a></div>
375 <p class="xdocHdrSummaryDcl">Unregister an interrupt line to a remote processor</p>
376 <span id='targ-synop'></span>
377 <table class="xdocLabel"><tr>
378 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
379 <td class="xdocLabelRight">target-domain</td>
380 </tr></table>
381 <div class="xdocSynTdcl">
382 <div class="xdocSynCode">
383 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Interrupt_intUnregister</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html#.Int.Info" title="ti.sdo.ipc.notifyDrivers.IInterrupt.IntInfo">IInterrupt_IntInfo</a> *<span class="xdoc-id">intInfo</span>);
384 </div>
385 </div>
386 <div class="xdocSynSpacer"> </div>
387 <span id="xdoc-sect-1"></span>
388 <div class="xdocSect">ARGUMENTS</div>
389 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
390 <span class="xdocChildSum">— Remote MultiProc Id</span>
391 </div>
392 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
393 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
394 </div>
395 <a class="xdocAnchor" id="module-wide_built-ins"></a>
396 <table class="xdocHdr"><tr>
397 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
398 <td class="xdocHdrArrow">
399 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
400 </table>
401 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#module-wide_built-ins">index URL</a></div>
402 <p class="xdocHdrSummary"></p>
403 <span id='targ-synop'></span>
404 <table class="xdocLabel"><tr>
405 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
406 <td class="xdocLabelRight">target-domain</td>
407 </tr></table>
408 <div class="xdocSynTdcl">
409 <div class="xdocSynCode">
410 <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">Interrupt_Module_id</span>();
411 </div>
412 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
413 <div class="xdocSynSpacer"> </div>
414 <div class="xdocSynCode">
415 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">Interrupt_Module_startupDone</span>();
416 </div>
417 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
418 <div class="xdocSynSpacer"> </div>
419 <div class="xdocSynCode">
420 <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">Interrupt_Module_heap</span>();
421 </div>
422 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
423 <div class="xdocSynSpacer"> </div>
424 <div class="xdocSynCode">
425 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">Interrupt_Module_hasMask</span>();
426 </div>
427 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
428 <div class="xdocSynSpacer"> </div>
429 <div class="xdocSynCode">
430 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">Interrupt_Module_getMask</span>();
431 </div>
432 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
433 <div class="xdocSynSpacer"> </div>
434 <div class="xdocSynCode">
435 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">Interrupt_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
436 </div>
437 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
438 </div>
439 </div>
440 <div class="xdocSynSpacer"> </div>
441 <span id='meta-synop'></span>
442 <table class="xdocLabel"><tr>
443 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
444 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/ipc/family/tci6638/Interrupt-src.html"><span class="xdocLabelFile">ti/ipc/family/tci6638/Interrupt.xdc</span></a></td>
445 </tr></table>
446 <div class="xdocSynM">
447 <div class="xdocSynCode">
448 <tt></tt><span class="xdoc-kw1">var</span> Interrupt = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.ipc.family.tci6638.Interrupt'</span>);
449 </div>
450 <div class='xdocSynHdr'>module-wide constants & types</div>
452 <div class="xdocSynCode">
453 <tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.I.N.V.A.L.I.D.P.A.Y.L.O.A.D">Interrupt.<span class="xdoc-id">INVALIDPAYLOAD</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = 0xFFFFFFFF;
454 </div>
455 <div class="xdocSynSpacer"> </div>
456 <div class="xdocSynCode">
457 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> <a class="xdocSynGo" href="#meta.Int.Info">Interrupt.<span class="xdoc-id">IntInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;
458 </div>
459 <div class="xdocSynCode">
460 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.ipc.family.tci6638.Interrupt.IntInfo"><span class="xdoc-id">localIntId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
461 </div>
462 <div class="xdocSynCode">
463 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.ipc.family.tci6638.Interrupt.IntInfo"><span class="xdoc-id">remoteIntId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
464 </div>
465 <div class="xdocSynCode">
466 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.ipc.family.tci6638.Interrupt.IntInfo"><span class="xdoc-id">intVectorId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
467 </div>
468 <div class='xdocSynHdr'>module-wide config parameters</div>
470 <div class="xdocSynCode">
471 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_not.Implemented">Interrupt.<span class="xdoc-id">A_notImplemented</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Function not implemented</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
472 </div>
473 <div class="xdocSynCode">
474 <tt> </tt><tt> </tt>msg: "A_notImplemented: this function is not implemented"
475 </div>
476 <div class="xdocSynCode">
477 <tt> </tt><tt></tt>};
478 </div>
479 <div class="xdocSynCode">
480 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metaenable.Kick">Interrupt.<span class="xdoc-id">enableKick</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// If set to 'true' IPC will unlock the KICK registers on C66x devices</span></span></a> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
481 </div>
482 <div class="xdocSynSpacer"> </div>
483 <div class="xdocSynCode">
484 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">Interrupt.<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>;
485 </div>
486 <div class="xdocSynSpacer"> </div>
487 </div>
488 <div id="xdocSep">
489 </div>
490 <div id="xdocMetaElems">
491 <div class="xdocSynSpacer"> </div>
492 <a class="xdocAnchor" id="meta.I.N.V.A.L.I.D.P.A.Y.L.O.A.D"></a>
493 <table class="xdocHdr"><tr>
494 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">Interrupt.</span><span class="xdoc-id">INVALIDPAYLOAD</span></td>
495 <td class="xdocHdrArrow">
496 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
497 </table>
498 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#.I.N.V.A.L.I.D.P.A.Y.L.O.A.D">index URL</a></div>
499 <span id='meta-synop'></span>
500 <table class="xdocLabel"><tr>
501 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
502 <td class="xdocLabelRight"></td>
503 </tr></table>
504 <div class="xdocSynMdcl">
505 <div class="xdocSynCode">
506 <tt></tt><tt></tt><span class="xdoc-kw1">const</span> Interrupt.<span class="xdoc-id">INVALIDPAYLOAD</span> = 0xFFFFFFFF;
507 </div>
508 </div>
509 <div class="xdocSynSpacer"> </div>
510 <div class="xdocSect">C SYNOPSIS</div>
511 <div class="xdocText"><a class="xdoc-link" href="#.I.N.V.A.L.I.D.P.A.Y.L.O.A.D" title="Interrupt_INVALIDPAYLOAD">Interrupt_INVALIDPAYLOAD</a></div>
512 <div class="xdocSynSpacer"> </div>
513 <a class="xdocAnchor" id="meta.Int.Info"></a>
514 <table class="xdocHdr"><tr>
515 <td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">Interrupt.</span><span class="xdoc-id">IntInfo</span></td>
516 <td class="xdocHdrArrow">
517 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
518 </table>
519 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#.Int.Info">index URL</a></div>
520 <span id='meta-synop'></span>
521 <table class="xdocLabel"><tr>
522 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
523 <td class="xdocLabelRight"></td>
524 </tr></table>
525 <div class="xdocSynMdcl">
526 <div class="xdocSynCode">
527 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> Interrupt.<span class="xdoc-id">IntInfo</span>;
528 </div>
529 <div class="xdocSynSpacer"> </div>
530 <div class="xdocSynCode">
531 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">localIntId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
532 </div>
533 <div class="xdocSynCode">
534 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">remoteIntId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
535 </div>
536 <div class="xdocSynCode">
537 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">intVectorId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
538 </div>
539 </div>
540 <div class="xdocSynSpacer"> </div>
541 <div class="xdocSect">C SYNOPSIS</div>
542 <div class="xdocText"><a class="xdoc-link" href="#.Int.Info" title="Interrupt_IntInfo">Interrupt_IntInfo</a></div>
543 <div class="xdocSynSpacer"> </div>
544 <a class="xdocAnchor" id="meta.A_not.Implemented"></a>
545 <table class="xdocHdr"><tr>
546 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Interrupt.</span><span class="xdoc-id">A_notImplemented</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
547 <td class="xdocHdrArrow">
548 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
549 </table>
550 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#.A_not.Implemented">index URL</a></div>
551 <p class="xdocHdrSummaryDcl">Function not implemented</p>
552 <span id='meta-synop'></span>
553 <table class="xdocLabel"><tr>
554 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
555 <td class="xdocLabelRight"></td>
556 </tr></table>
557 <div class="xdocSynMdcl">
558 <div class="xdocSynCode">
559 <tt></tt><tt></tt>Interrupt.<span class="xdoc-id">A_notImplemented</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
560 </div>
561 <div class="xdocSynCode">
562 <tt></tt><tt> </tt>msg: "A_notImplemented: this function is not implemented"
563 </div>
564 <div class="xdocSynCode">
565 <tt></tt><tt></tt>};
566 </div>
567 </div>
568 <div class="xdocSynSpacer"> </div>
569 <div class="xdocSect">C SYNOPSIS</div>
570 <div class="xdocText"><a class="xdoc-link" href="#.A_not.Implemented" title="Interrupt_A_notImplemented">Interrupt_A_notImplemented</a></div>
571 <div class="xdocSynSpacer"> </div>
572 <a class="xdocAnchor" id="metaenable.Kick"></a>
573 <table class="xdocHdr"><tr>
574 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Interrupt.</span><span class="xdoc-id">enableKick</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
575 <td class="xdocHdrArrow">
576 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
577 </table>
578 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/tci6638/Interrupt.html#enable.Kick">index URL</a></div>
579 <p class="xdocHdrSummaryDcl">If set to 'true' IPC will unlock the KICK registers on C66x devices</p>
580 <span id='meta-synop'></span>
581 <table class="xdocLabel"><tr>
582 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
583 <td class="xdocLabelRight"></td>
584 </tr></table>
585 <div class="xdocSynMdcl">
586 <div class="xdocSynCode">
587 <tt></tt><tt></tt>Interrupt.<span class="xdoc-id">enableKick</span> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
588 </div>
589 </div>
590 <div class="xdocSynSpacer"> </div>
591 <span id="xdoc-sect-1"></span>
592 <div class="xdocSect">DETAILS</div>
593 <div class="xdocText">IPC unlocks the KICK registers on the local core if (and only if) all
594 the following conditions are met:
595 - This configuration is set to 'true'
596 - SharedRegion #0 is valid and the local core is its owner
597 - SharedRegion #0 is not valid and the local core is CORE0</div>
598 <div class="xdocSect">C SYNOPSIS</div>
599 <div class="xdocText"><a class="xdoc-link" href="#enable.Kick" title="Interrupt_enableKick">Interrupt_enableKick</a></div>
600 <div class="xdocSynSpacer"> </div>
601 <a class="xdocAnchor" id="common$"></a>
602 <table class="xdocHdr"><tr>
603 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">Interrupt.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
604 <td class="xdocHdrArrow">
605 <a class="xdocHdrLink" href="../../../../ti/ipc/family/tci6638/Interrupt.html" title="module Interrupt"><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/ipc/family/tci6638/Interrupt.html#common$">index URL</a></div>
608 <p class="xdocHdrSummaryDcl">Common module configuration parameters</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>Interrupt.<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>;
617 </div>
618 </div>
619 <div class="xdocSynSpacer"> </div>
620 <span id="xdoc-sect-1"></span>
621 <div class="xdocSect">DETAILS</div>
622 <div class="xdocText">All modules have this configuration parameter. Its name
623 contains the '$' character to ensure it does not conflict with
624 configuration parameters declared by the module. This allows
625 new configuration parameters to be added in the future without
626 any chance of breaking existing modules.</div>
627 </div>
628 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:25 GMT</div>
629 </div></div></body>
630 </html>