[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / family / tda3xx / InterruptIpu.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.family.tda3xx.InterruptIpu</title>
4 <meta name="description" content="IPU 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.sdo.ipc.family.tda3xx.</span><span class="xdoc-id">InterruptIpu</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/package.html" title="package ti.sdo.ipc.family.tda3xx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
14 <td class="xdocHdrArrow">
15 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/NotifyDriverMbx.html" title="module NotifyDriverMbx"><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/family/tda3xx/InterruptIpu.html">index URL</a></div>
18 <p class="xdocHdrSummary">IPU interrupt manager</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 <span id='targ-synop'></span>
26 <table class="xdocLabel"><tr>
27 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
28 <td class="xdocLabelCenter">target-domain</td>
29 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/tda3xx/InterruptIpu.xdc</span></a></td>
30 </tr></table>
31 <div class="xdocSynT">
32 <div class="xdocSynCode">
33 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/family/tda3xx/InterruptIpu.h></span>
34 </div>
35 <table cellspacing="0" cellpadding="0" border="0">
36 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all IInterrupt modules</div></td></tr>
38 <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">InterruptIpu_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>
39 <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">InterruptIpu_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>
40 <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">InterruptIpu_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>
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.Register"><span class="xdoc-id">InterruptIpu_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>
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.Send"><span class="xdoc-id">InterruptIpu_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>
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.Unregister"><span class="xdoc-id">InterruptIpu_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>
44 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
46 <tr>
47 <td></td>
48 <td>
49 <div class="xdocSynTblPack">
50 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptIpu_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
51 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptIpu_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
52 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptIpu_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
53 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptIpu_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
54 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptIpu_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
55 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptIpu_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
56 </div>
57 </td>
58 </tr>
59 <tr><td colspan='2'><div class='xdocSynTblHdr'>Defines</div></td></tr>
61 <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="#.N.U.M_.E.V.E.S"><span class="xdoc-id">InterruptIpu_NUM_EVES</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum number of EVE cores</span></span></a> (<i><span class="xdoc-kw2">UInt8</span></i>)1</div></td></tr>
62 <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="#.N.U.M_.E.V.E_.M.B.X"><span class="xdoc-id">InterruptIpu_NUM_EVE_MBX</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of internal EVE mailboxes</span></span></a> (<i><span class="xdoc-kw2">UInt8</span></i>)<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E.S" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVES">InterruptIpu.NUM_EVES</a> * 2</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="#.N.U.M_.S.Y.S_.M.B.X"><span class="xdoc-id">InterruptIpu_NUM_SYS_MBX</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of System mailboxes used by IPC</span></span></a> (<i><span class="xdoc-kw2">UInt8</span></i>)1</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">InterruptIpu_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> <span class="xdoc-kw2">UInt32</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#ducati.Ctrl.Base.Addr"><span class="xdoc-id">InterruptIpu_ducatiCtrlBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Base address for the Ducati CTRL register</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">UInt32</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#mailbox.Base.Addr"><span class="xdoc-id">InterruptIpu_mailboxBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Base address for the mailbox subsystems</span></span></a>[<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVE_MBX">InterruptIpu_NUM_EVE_MBX</a> + <a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.S.Y.S_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_SYS_MBX">InterruptIpu_NUM_SYS_MBX</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=".N.U.M_.E.V.E.S"></a>
79 <table class="xdocHdr"><tr>
80 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">NUM_EVES</span></td>
81 <td class="xdocHdrArrow">
82 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><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/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E.S">index URL</a></div>
85 <p class="xdocHdrSummaryDcl">Maximum number of EVE cores</p>
86 <span id='targ-synop'></span>
87 <table class="xdocLabel"><tr>
88 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
89 <td class="xdocLabelRight">target-domain</td>
90 </tr></table>
91 <div class="xdocSynTdcl">
92 <div class="xdocSynCode">
93 <tt></tt><tt></tt><span class="xdoc-kw3">#define</span> <span class="xdoc-id">InterruptIpu_NUM_EVES</span> (<i><span class="xdoc-kw2">UInt8</span></i>)1
94 </div>
95 </div>
96 <div class="xdocSynSpacer"> </div>
97 <span id="xdoc-sect-1"></span>
98 <div class="xdocSect">DETAILS</div>
99 <div class="xdocText">Although your device may have fewer EVE cores, <tt>NUM_EVES</tt> represents
100 the maximum number of EVEs that may be present on a system.</div>
101 <div class="xdocSynSpacer"> </div>
102 <a class="xdocAnchor" id=".N.U.M_.E.V.E_.M.B.X"></a>
103 <table class="xdocHdr"><tr>
104 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">NUM_EVE_MBX</span></td>
105 <td class="xdocHdrArrow">
106 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><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/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E_.M.B.X">index URL</a></div>
109 <p class="xdocHdrSummaryDcl">Number of internal EVE mailboxes</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><span class="xdoc-kw3">#define</span> <span class="xdoc-id">InterruptIpu_NUM_EVE_MBX</span> (<i><span class="xdoc-kw2">UInt8</span></i>)<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E.S" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVES">InterruptIpu.NUM_EVES</a> * 2
118 </div>
119 </div>
120 <div class="xdocSynSpacer"> </div>
121 <span id="xdoc-sect-1"></span>
122 <div class="xdocSect">DETAILS</div>
123 <div class="xdocText">Each EVE core has 3 mailboxes.</div>
124 <div class="xdocText">Although your device may have fewer EVE cores, <tt>NUM_EVE_MBX</tt> represents
125 the maximum number of EVE mailboxes (including all EVE cores) that may
126 be present.</div>
127 <div class="xdocSynSpacer"> </div>
128 <a class="xdocAnchor" id=".N.U.M_.S.Y.S_.M.B.X"></a>
129 <table class="xdocHdr"><tr>
130 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">NUM_SYS_MBX</span></td>
131 <td class="xdocHdrArrow">
132 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><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/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.S.Y.S_.M.B.X">index URL</a></div>
135 <p class="xdocHdrSummaryDcl">Number of System mailboxes used by IPC</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-kw3">#define</span> <span class="xdoc-id">InterruptIpu_NUM_SYS_MBX</span> (<i><span class="xdoc-kw2">UInt8</span></i>)1
144 </div>
145 </div>
146 <div class="xdocSynSpacer"> </div>
147 <span id="xdoc-sect-1"></span>
148 <div class="xdocSect">DETAILS</div>
149 <div class="xdocText">This represents the number of System mailboxes used by IPC. IPC
150 currently uses system mailboxes 5, 6, 7 and 8.</div>
151 <div class="xdocSynSpacer"> </div>
152 <a class="xdocAnchor" id=".Int.Info"></a>
153 <table class="xdocHdr"><tr>
154 <td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">IntInfo</span></td>
155 <td class="xdocHdrArrow">
156 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
157 </table>
158 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.Int.Info">index URL</a></div>
159 <span id='targ-synop'></span>
160 <table class="xdocLabel"><tr>
161 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
162 <td class="xdocLabelRight">target-domain</td>
163 </tr></table>
164 <div class="xdocSynTdcl">
165 <div class="xdocSynCode">
166 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">InterruptIpu_IntInfo</span> {
167 </div>
168 <div class="xdocSynCode">
169 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">localIntId</span></span>;
170 </div>
171 <div class="xdocSynCode">
172 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">remoteIntId</span></span>;
173 </div>
174 <div class="xdocSynCode">
175 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">intVectorId</span></span>;
176 </div>
177 <div class="xdocSynCode">
178 <tt></tt><tt></tt>} <span class="xdoc-id">InterruptIpu_IntInfo</span>;
179 </div>
180 </div>
181 <div class="xdocSynSpacer"> </div>
182 <div class="xdocSynSpacer"> </div>
183 <a class="xdocAnchor" id="ducati.Ctrl.Base.Addr"></a>
184 <table class="xdocHdr"><tr>
185 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">ducatiCtrlBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
186 <td class="xdocHdrArrow">
187 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
188 </table>
189 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#ducati.Ctrl.Base.Addr">index URL</a></div>
190 <p class="xdocHdrSummaryDcl">Base address for the Ducati CTRL register</p>
191 <span id='targ-synop'></span>
192 <table class="xdocLabel"><tr>
193 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
194 <td class="xdocLabelRight">target-domain</td>
195 </tr></table>
196 <div class="xdocSynTdcl">
197 <div class="xdocSynCode">
198 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">InterruptIpu_ducatiCtrlBaseAddr</span>;
199 </div>
200 </div>
201 <div class="xdocSynSpacer"> </div>
202 <div class="xdocSynSpacer"> </div>
203 <a class="xdocAnchor" id="mailbox.Base.Addr"></a>
204 <table class="xdocHdr"><tr>
205 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">mailboxBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
206 <td class="xdocHdrArrow">
207 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
208 </table>
209 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#mailbox.Base.Addr">index URL</a></div>
210 <p class="xdocHdrSummaryDcl">Base address for the mailbox subsystems</p>
211 <span id='targ-synop'></span>
212 <table class="xdocLabel"><tr>
213 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
214 <td class="xdocLabelRight">target-domain</td>
215 </tr></table>
216 <div class="xdocSynTdcl">
217 <div class="xdocSynCode">
218 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">InterruptIpu_mailboxBaseAddr</span>[<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVE_MBX">InterruptIpu_NUM_EVE_MBX</a> + <a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.S.Y.S_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_SYS_MBX">InterruptIpu_NUM_SYS_MBX</a>];
219 </div>
220 </div>
221 <div class="xdocSynSpacer"> </div>
222 <span id="xdoc-sect-1"></span>
223 <div class="xdocSect">DETAILS</div>
224 <div class="xdocText">The <tt>mailboxBaseAddr</tt> array indicates the virtual addresses through
225 which IPC will access various mailboxes.</div>
226 <div class="xdocText">Note that these mailboxes are not accessible at their physical
227 addresses (in the 0x4XXX_XXXX range). So default virtual addresses
228 through which these mailboxes will be accessed are assigned in the
229 0x6XXX_XXXX range. Users must ensure these virtual addresses are
230 correctly mapped to the 0x4XXX_XXXX-based phys addrs in each IPUs AMMU.</div>
231 <div class="xdocSynSpacer"> </div>
232 <a class="xdocAnchor" id="int.Clear"></a>
233 <table class="xdocHdr"><tr>
234 <td class="xdocHdrTitle"><span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">intClear</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
235 <td class="xdocHdrArrow">
236 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
237 </table>
238 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#int.Clear">index URL</a></div>
239 <p class="xdocHdrSummaryDcl">Clear interrupt</p>
240 <span id='targ-synop'></span>
241 <table class="xdocLabel"><tr>
242 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
243 <td class="xdocLabelRight">target-domain</td>
244 </tr></table>
245 <div class="xdocSynTdcl">
246 <div class="xdocSynCode">
247 <tt></tt><tt></tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">InterruptIpu_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>);
248 </div>
249 </div>
250 <div class="xdocSynSpacer"> </div>
251 <span id="xdoc-sect-1"></span>
252 <div class="xdocSect">ARGUMENTS</div>
253 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
254 <span class="xdocChildSum">— Remote MultiProc Id</span>
255 </div>
256 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
257 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
258 </div>
259 <span id="xdoc-sect-2"></span>
260 <div class="xdocSect">RETURNS</div>
261 <div class="xdocText">Value (if any) of the interrupt before
262 it was cleared</div>
263 <div class="xdocSynSpacer"> </div>
264 <a class="xdocAnchor" id="int.Disable"></a>
265 <table class="xdocHdr"><tr>
266 <td class="xdocHdrTitle"><span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">intDisable</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
267 <td class="xdocHdrArrow">
268 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
269 </table>
270 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#int.Disable">index URL</a></div>
271 <p class="xdocHdrSummaryDcl">Disables the interrupt corresponding to intId</p>
272 <span id='targ-synop'></span>
273 <table class="xdocLabel"><tr>
274 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
275 <td class="xdocLabelRight">target-domain</td>
276 </tr></table>
277 <div class="xdocSynTdcl">
278 <div class="xdocSynCode">
279 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptIpu_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>);
280 </div>
281 </div>
282 <div class="xdocSynSpacer"> </div>
283 <span id="xdoc-sect-1"></span>
284 <div class="xdocSect">ARGUMENTS</div>
285 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
286 <span class="xdocChildSum">— Remote MultiProc Id</span>
287 </div>
288 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
289 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
290 </div>
291 <div class="xdocSynSpacer"> </div>
292 <a class="xdocAnchor" id="int.Enable"></a>
293 <table class="xdocHdr"><tr>
294 <td class="xdocHdrTitle"><span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">intEnable</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
295 <td class="xdocHdrArrow">
296 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><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/family/tda3xx/InterruptIpu.html#int.Enable">index URL</a></div>
299 <p class="xdocHdrSummaryDcl">Enables the interrupt corresponding to intId</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-kw2">Void</span> <span class="xdoc-id">InterruptIpu_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>);
308 </div>
309 </div>
310 <div class="xdocSynSpacer"> </div>
311 <span id="xdoc-sect-1"></span>
312 <div class="xdocSect">ARGUMENTS</div>
313 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
314 <span class="xdocChildSum">— Remote MultiProc Id</span>
315 </div>
316 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
317 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
318 </div>
319 <div class="xdocSynSpacer"> </div>
320 <a class="xdocAnchor" id="int.Register"></a>
321 <table class="xdocHdr"><tr>
322 <td class="xdocHdrTitle"><span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">intRegister</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
323 <td class="xdocHdrArrow">
324 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
325 </table>
326 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#int.Register">index URL</a></div>
327 <p class="xdocHdrSummaryDcl">Register an interrupt line to a remote processor</p>
328 <span id='targ-synop'></span>
329 <table class="xdocLabel"><tr>
330 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
331 <td class="xdocLabelRight">target-domain</td>
332 </tr></table>
333 <div class="xdocSynTdcl">
334 <div class="xdocSynCode">
335 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptIpu_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>);
336 </div>
337 </div>
338 <div class="xdocSynSpacer"> </div>
339 <span id="xdoc-sect-1"></span>
340 <div class="xdocSect">ARGUMENTS</div>
341 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
342 <span class="xdocChildSum">— Remote MultiProc Id</span>
343 </div>
344 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
345 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
346 </div>
347 <div class="xdocChild"><span class="xdocChildId">func</span>
348 <span class="xdocChildSum">— Function to register.</span>
349 </div>
350 <div class="xdocChild"><span class="xdocChildId">arg</span>
351 <span class="xdocChildSum">— Argument that will be passed to func</span>
352 </div>
353 <div class="xdocSynSpacer"> </div>
354 <a class="xdocAnchor" id="int.Send"></a>
355 <table class="xdocHdr"><tr>
356 <td class="xdocHdrTitle"><span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">intSend</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
357 <td class="xdocHdrArrow">
358 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
359 </table>
360 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#int.Send">index URL</a></div>
361 <p class="xdocHdrSummaryDcl">Send interrupt to the remote processor</p>
362 <span id='targ-synop'></span>
363 <table class="xdocLabel"><tr>
364 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
365 <td class="xdocLabelRight">target-domain</td>
366 </tr></table>
367 <div class="xdocSynTdcl">
368 <div class="xdocSynCode">
369 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptIpu_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>);
370 </div>
371 </div>
372 <div class="xdocSynSpacer"> </div>
373 <span id="xdoc-sect-1"></span>
374 <div class="xdocSect">ARGUMENTS</div>
375 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
376 <span class="xdocChildSum">— Remote MultiProc Id</span>
377 </div>
378 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
379 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
380 </div>
381 <div class="xdocChild"><span class="xdocChildId">arg</span>
382 <span class="xdocChildSum">— Argument for sending interrupt.</span>
383 </div>
384 <div class="xdocSynSpacer"> </div>
385 <a class="xdocAnchor" id="int.Unregister"></a>
386 <table class="xdocHdr"><tr>
387 <td class="xdocHdrTitle"><span class="xdoc-id">InterruptIpu_</span><span class="xdoc-id">intUnregister</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
388 <td class="xdocHdrArrow">
389 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
390 </table>
391 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#int.Unregister">index URL</a></div>
392 <p class="xdocHdrSummaryDcl">Unregister an interrupt line to a remote processor</p>
393 <span id='targ-synop'></span>
394 <table class="xdocLabel"><tr>
395 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
396 <td class="xdocLabelRight">target-domain</td>
397 </tr></table>
398 <div class="xdocSynTdcl">
399 <div class="xdocSynCode">
400 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptIpu_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>);
401 </div>
402 </div>
403 <div class="xdocSynSpacer"> </div>
404 <span id="xdoc-sect-1"></span>
405 <div class="xdocSect">ARGUMENTS</div>
406 <div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
407 <span class="xdocChildSum">— Remote MultiProc Id</span>
408 </div>
409 <div class="xdocChild"><span class="xdocChildId">intInfo</span>
410 <span class="xdocChildSum">— Information needed to configure interrupt line</span>
411 </div>
412 <a class="xdocAnchor" id="module-wide_built-ins"></a>
413 <table class="xdocHdr"><tr>
414 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
415 <td class="xdocHdrArrow">
416 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
417 </table>
418 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#module-wide_built-ins">index URL</a></div>
419 <p class="xdocHdrSummary"></p>
420 <span id='targ-synop'></span>
421 <table class="xdocLabel"><tr>
422 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
423 <td class="xdocLabelRight">target-domain</td>
424 </tr></table>
425 <div class="xdocSynTdcl">
426 <div class="xdocSynCode">
427 <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">InterruptIpu_Module_id</span>();
428 </div>
429 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
430 <div class="xdocSynSpacer"> </div>
431 <div class="xdocSynCode">
432 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">InterruptIpu_Module_startupDone</span>();
433 </div>
434 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
435 <div class="xdocSynSpacer"> </div>
436 <div class="xdocSynCode">
437 <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">InterruptIpu_Module_heap</span>();
438 </div>
439 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
440 <div class="xdocSynSpacer"> </div>
441 <div class="xdocSynCode">
442 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">InterruptIpu_Module_hasMask</span>();
443 </div>
444 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
445 <div class="xdocSynSpacer"> </div>
446 <div class="xdocSynCode">
447 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">InterruptIpu_Module_getMask</span>();
448 </div>
449 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
450 <div class="xdocSynSpacer"> </div>
451 <div class="xdocSynCode">
452 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptIpu_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
453 </div>
454 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
455 </div>
456 </div>
457 <div class="xdocSynSpacer"> </div>
458 <span id='meta-synop'></span>
459 <table class="xdocLabel"><tr>
460 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
461 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/tda3xx/InterruptIpu.xdc</span></a></td>
462 </tr></table>
463 <div class="xdocSynM">
464 <div class="xdocSynCode">
465 <tt></tt><span class="xdoc-kw1">var</span> InterruptIpu = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.family.tda3xx.InterruptIpu'</span>);
466 </div>
467 <div class='xdocSynHdr'>module-wide constants & types</div>
469 <div class="xdocSynCode">
470 <tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.N.U.M_.E.V.E.S">InterruptIpu.<span class="xdoc-id">NUM_EVES</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum number of EVE cores</span></span></a> = 1;
471 </div>
472 <div class="xdocSynCode">
473 <tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.N.U.M_.E.V.E_.M.B.X">InterruptIpu.<span class="xdoc-id">NUM_EVE_MBX</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of internal EVE mailboxes</span></span></a> = <a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E.S" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVES">InterruptIpu.NUM_EVES</a> * 2;
474 </div>
475 <div class="xdocSynCode">
476 <tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.N.U.M_.S.Y.S_.M.B.X">InterruptIpu.<span class="xdoc-id">NUM_SYS_MBX</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Number of System mailboxes used by IPC</span></span></a> = 1;
477 </div>
478 <div class="xdocSynSpacer"> </div>
479 <div class="xdocSynCode">
480 <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">InterruptIpu.<span class="xdoc-id">IntInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;
481 </div>
482 <div class="xdocSynCode">
483 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.IntInfo"><span class="xdoc-id">localIntId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
484 </div>
485 <div class="xdocSynCode">
486 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.IntInfo"><span class="xdoc-id">remoteIntId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
487 </div>
488 <div class="xdocSynCode">
489 <tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.IntInfo"><span class="xdoc-id">intVectorId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
490 </div>
491 <div class='xdocSynHdr'>module-wide config parameters</div>
493 <div class="xdocSynCode">
494 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metaducati.Ctrl.Base.Addr">InterruptIpu.<span class="xdoc-id">ducatiCtrlBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Base address for the Ducati CTRL register</span></span></a> = <i><span class="xdoc-kw2">UInt32</span></i> 0x40001000;
495 </div>
496 <div class="xdocSynCode">
497 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metamailbox.Base.Addr">InterruptIpu.<span class="xdoc-id">mailboxBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Base address for the mailbox subsystems</span></span></a> = <i><span class="xdoc-kw2">UInt32</span>[<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVE_MBX">InterruptIpu.NUM_EVE_MBX</a>+<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.S.Y.S_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_SYS_MBX">InterruptIpu.NUM_SYS_MBX</a>]</i> <span class="xdoc-kw2">undefined</span>;
498 </div>
499 <div class="xdocSynSpacer"> </div>
500 <div class="xdocSynCode">
501 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">InterruptIpu.<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>;
502 </div>
503 <div class="xdocSynSpacer"> </div>
504 </div>
505 <div id="xdocSep">
506 </div>
507 <div id="xdocMetaElems">
508 <div class="xdocSynSpacer"> </div>
509 <a class="xdocAnchor" id="meta.N.U.M_.E.V.E.S"></a>
510 <table class="xdocHdr"><tr>
511 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">InterruptIpu.</span><span class="xdoc-id">NUM_EVES</span></td>
512 <td class="xdocHdrArrow">
513 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
514 </table>
515 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E.S">index URL</a></div>
516 <p class="xdocHdrSummaryDcl">Maximum number of EVE cores</p>
517 <span id='meta-synop'></span>
518 <table class="xdocLabel"><tr>
519 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
520 <td class="xdocLabelRight"></td>
521 </tr></table>
522 <div class="xdocSynMdcl">
523 <div class="xdocSynCode">
524 <tt></tt><tt></tt><span class="xdoc-kw1">const</span> InterruptIpu.<span class="xdoc-id">NUM_EVES</span> = 1;
525 </div>
526 </div>
527 <div class="xdocSynSpacer"> </div>
528 <span id="xdoc-sect-1"></span>
529 <div class="xdocSect">DETAILS</div>
530 <div class="xdocText">Although your device may have fewer EVE cores, <tt>NUM_EVES</tt> represents
531 the maximum number of EVEs that may be present on a system.</div>
532 <div class="xdocSect">C SYNOPSIS</div>
533 <div class="xdocText"><a class="xdoc-link" href="#.N.U.M_.E.V.E.S" title="InterruptIpu_NUM_EVES">InterruptIpu_NUM_EVES</a></div>
534 <div class="xdocSynSpacer"> </div>
535 <a class="xdocAnchor" id="meta.N.U.M_.E.V.E_.M.B.X"></a>
536 <table class="xdocHdr"><tr>
537 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">InterruptIpu.</span><span class="xdoc-id">NUM_EVE_MBX</span></td>
538 <td class="xdocHdrArrow">
539 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
540 </table>
541 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E_.M.B.X">index URL</a></div>
542 <p class="xdocHdrSummaryDcl">Number of internal EVE mailboxes</p>
543 <span id='meta-synop'></span>
544 <table class="xdocLabel"><tr>
545 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
546 <td class="xdocLabelRight"></td>
547 </tr></table>
548 <div class="xdocSynMdcl">
549 <div class="xdocSynCode">
550 <tt></tt><tt></tt><span class="xdoc-kw1">const</span> InterruptIpu.<span class="xdoc-id">NUM_EVE_MBX</span> = <a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E.S" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVES">InterruptIpu.NUM_EVES</a> * 2;
551 </div>
552 </div>
553 <div class="xdocSynSpacer"> </div>
554 <span id="xdoc-sect-1"></span>
555 <div class="xdocSect">DETAILS</div>
556 <div class="xdocText">Each EVE core has 3 mailboxes.</div>
557 <div class="xdocText">Although your device may have fewer EVE cores, <tt>NUM_EVE_MBX</tt> represents
558 the maximum number of EVE mailboxes (including all EVE cores) that may
559 be present.</div>
560 <div class="xdocSect">C SYNOPSIS</div>
561 <div class="xdocText"><a class="xdoc-link" href="#.N.U.M_.E.V.E_.M.B.X" title="InterruptIpu_NUM_EVE_MBX">InterruptIpu_NUM_EVE_MBX</a></div>
562 <div class="xdocSynSpacer"> </div>
563 <a class="xdocAnchor" id="meta.N.U.M_.S.Y.S_.M.B.X"></a>
564 <table class="xdocHdr"><tr>
565 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">InterruptIpu.</span><span class="xdoc-id">NUM_SYS_MBX</span></td>
566 <td class="xdocHdrArrow">
567 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
568 </table>
569 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.S.Y.S_.M.B.X">index URL</a></div>
570 <p class="xdocHdrSummaryDcl">Number of System mailboxes used by IPC</p>
571 <span id='meta-synop'></span>
572 <table class="xdocLabel"><tr>
573 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
574 <td class="xdocLabelRight"></td>
575 </tr></table>
576 <div class="xdocSynMdcl">
577 <div class="xdocSynCode">
578 <tt></tt><tt></tt><span class="xdoc-kw1">const</span> InterruptIpu.<span class="xdoc-id">NUM_SYS_MBX</span> = 1;
579 </div>
580 </div>
581 <div class="xdocSynSpacer"> </div>
582 <span id="xdoc-sect-1"></span>
583 <div class="xdocSect">DETAILS</div>
584 <div class="xdocText">This represents the number of System mailboxes used by IPC. IPC
585 currently uses system mailboxes 5, 6, 7 and 8.</div>
586 <div class="xdocSect">C SYNOPSIS</div>
587 <div class="xdocText"><a class="xdoc-link" href="#.N.U.M_.S.Y.S_.M.B.X" title="InterruptIpu_NUM_SYS_MBX">InterruptIpu_NUM_SYS_MBX</a></div>
588 <div class="xdocSynSpacer"> </div>
589 <a class="xdocAnchor" id="meta.Int.Info"></a>
590 <table class="xdocHdr"><tr>
591 <td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">InterruptIpu.</span><span class="xdoc-id">IntInfo</span></td>
592 <td class="xdocHdrArrow">
593 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
594 </table>
595 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.Int.Info">index URL</a></div>
596 <span id='meta-synop'></span>
597 <table class="xdocLabel"><tr>
598 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
599 <td class="xdocLabelRight"></td>
600 </tr></table>
601 <div class="xdocSynMdcl">
602 <div class="xdocSynCode">
603 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> InterruptIpu.<span class="xdoc-id">IntInfo</span>;
604 </div>
605 <div class="xdocSynSpacer"> </div>
606 <div class="xdocSynCode">
607 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">localIntId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
608 </div>
609 <div class="xdocSynCode">
610 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">remoteIntId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
611 </div>
612 <div class="xdocSynCode">
613 <tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">intVectorId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
614 </div>
615 </div>
616 <div class="xdocSynSpacer"> </div>
617 <div class="xdocSect">C SYNOPSIS</div>
618 <div class="xdocText"><a class="xdoc-link" href="#.Int.Info" title="InterruptIpu_IntInfo">InterruptIpu_IntInfo</a></div>
619 <div class="xdocSynSpacer"> </div>
620 <a class="xdocAnchor" id="metaducati.Ctrl.Base.Addr"></a>
621 <table class="xdocHdr"><tr>
622 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptIpu.</span><span class="xdoc-id">ducatiCtrlBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
623 <td class="xdocHdrArrow">
624 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
625 </table>
626 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#ducati.Ctrl.Base.Addr">index URL</a></div>
627 <p class="xdocHdrSummaryDcl">Base address for the Ducati CTRL register</p>
628 <span id='meta-synop'></span>
629 <table class="xdocLabel"><tr>
630 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
631 <td class="xdocLabelRight"></td>
632 </tr></table>
633 <div class="xdocSynMdcl">
634 <div class="xdocSynCode">
635 <tt></tt><tt></tt>InterruptIpu.<span class="xdoc-id">ducatiCtrlBaseAddr</span> = <i><span class="xdoc-kw2">UInt32</span></i> 0x40001000;
636 </div>
637 </div>
638 <div class="xdocSynSpacer"> </div>
639 <div class="xdocSect">C SYNOPSIS</div>
640 <div class="xdocText"><a class="xdoc-link" href="#ducati.Ctrl.Base.Addr" title="InterruptIpu_ducatiCtrlBaseAddr">InterruptIpu_ducatiCtrlBaseAddr</a></div>
641 <div class="xdocSynSpacer"> </div>
642 <a class="xdocAnchor" id="metamailbox.Base.Addr"></a>
643 <table class="xdocHdr"><tr>
644 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptIpu.</span><span class="xdoc-id">mailboxBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
645 <td class="xdocHdrArrow">
646 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
647 </table>
648 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#mailbox.Base.Addr">index URL</a></div>
649 <p class="xdocHdrSummaryDcl">Base address for the mailbox subsystems</p>
650 <span id='meta-synop'></span>
651 <table class="xdocLabel"><tr>
652 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
653 <td class="xdocLabelRight"></td>
654 </tr></table>
655 <div class="xdocSynMdcl">
656 <div class="xdocSynCode">
657 <tt></tt><tt></tt>InterruptIpu.<span class="xdoc-id">mailboxBaseAddr</span> = <i><span class="xdoc-kw2">UInt32</span>[<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.E.V.E_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_EVE_MBX">InterruptIpu.NUM_EVE_MBX</a>+<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html#.N.U.M_.S.Y.S_.M.B.X" title="ti.sdo.ipc.family.tda3xx.InterruptIpu.NUM_SYS_MBX">InterruptIpu.NUM_SYS_MBX</a>]</i> <span class="xdoc-kw2">undefined</span>;
658 </div>
659 </div>
660 <div class="xdocSynSpacer"> </div>
661 <span id="xdoc-sect-1"></span>
662 <div class="xdocSect">DETAILS</div>
663 <div class="xdocText">The <tt>mailboxBaseAddr</tt> array indicates the virtual addresses through
664 which IPC will access various mailboxes.</div>
665 <div class="xdocText">Note that these mailboxes are not accessible at their physical
666 addresses (in the 0x4XXX_XXXX range). So default virtual addresses
667 through which these mailboxes will be accessed are assigned in the
668 0x6XXX_XXXX range. Users must ensure these virtual addresses are
669 correctly mapped to the 0x4XXX_XXXX-based phys addrs in each IPUs AMMU.</div>
670 <div class="xdocSect">C SYNOPSIS</div>
671 <div class="xdocText"><a class="xdoc-link" href="#mailbox.Base.Addr" title="InterruptIpu_mailboxBaseAddr">InterruptIpu_mailboxBaseAddr</a></div>
672 <div class="xdocSynSpacer"> </div>
673 <a class="xdocAnchor" id="common$"></a>
674 <table class="xdocHdr"><tr>
675 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptIpu.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
676 <td class="xdocHdrArrow">
677 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/tda3xx/InterruptIpu.html" title="module InterruptIpu"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
678 </table>
679 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/tda3xx/InterruptIpu.html#common$">index URL</a></div>
680 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
681 <span id='meta-synop'></span>
682 <table class="xdocLabel"><tr>
683 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
684 <td class="xdocLabelRight"></td>
685 </tr></table>
686 <div class="xdocSynMdcl">
687 <div class="xdocSynCode">
688 <tt></tt><tt></tt>InterruptIpu.<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>;
689 </div>
690 </div>
691 <div class="xdocSynSpacer"> </div>
692 <span id="xdoc-sect-1"></span>
693 <div class="xdocSect">DETAILS</div>
694 <div class="xdocText">All modules have this configuration parameter. Its name
695 contains the '$' character to ensure it does not conflict with
696 configuration parameters declared by the module. This allows
697 new configuration parameters to be added in the future without
698 any chance of breaking existing modules.</div>
699 </div>
700 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:18 GMT</div>
701 </div></div></body>
702 </html>