[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / family / arctic / InterruptDsp.html
diff --git a/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/family/arctic/InterruptDsp.html b/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/family/arctic/InterruptDsp.html
+++ /dev/null
@@ -1,467 +0,0 @@
-<html>
-<head>
-<title>module ti.sdo.ipc.family.arctic.InterruptDsp</title>
-<meta name="description" content="TI81xx/DSP interrupt manager">
-<link rel="stylesheet" type="text/css" href="../../../../../xdoc.css" />
-</head>
-<body><div id="xdocWrapper"><div id="xdocContent">
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.sdo.ipc.family.arctic.</span><span class="xdoc-id">InterruptDsp</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptArp32.html" title="module InterruptArp32"><img class="xdocHdrArrow" src="../../../../../Arrow_left.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/package.html" title="package ti.sdo.ipc.family.arctic"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/NotifyCircSetup.html" title="module NotifyCircSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_right.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html">index URL</a></div>
-<p class="xdocHdrSummary">TI81xx/DSP interrupt manager</p>
-<ul class="xdocToc">
-<li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
-<li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
-<li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
-<li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
-</ul>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
-<td class="xdocLabelCenter">target-domain</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/arctic/InterruptDsp.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynT">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/family/arctic/InterruptDsp.h></span>
-</div>
-<table cellspacing="0" cellpadding="0" border="0">
-<tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all IInterrupt modules</div></td></tr>
-
-<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">InterruptDsp_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>
-<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">InterruptDsp_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>
-<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">InterruptDsp_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>
-<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">InterruptDsp_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>
-<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">InterruptDsp_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>
-<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">InterruptDsp_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>
-<tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
-
-<tr>
-<td></td>
-<td>
-<div class="xdocSynTblPack">
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptDsp_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptDsp_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptDsp_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptDsp_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptDsp_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">InterruptDsp_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
-</div>
-</td>
-</tr>
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
-
-<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">InterruptDsp_IntInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> ...</div></td></tr>
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
-
-<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">InterruptDsp_mailboxBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;</div></td></tr>
-</table>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".Int.Info"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">IntInfo</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#.Int.Info">index URL</a></div>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">InterruptDsp_IntInfo</span> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">localIntId</span></span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">remoteIntId</span></span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id"><span class="xdoc-id">intVectorId</span></span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>} <span class="xdoc-id">InterruptDsp_IntInfo</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="mailbox.Base.Addr"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">mailboxBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#mailbox.Base.Addr">index URL</a></div>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">InterruptDsp_mailboxBaseAddr</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="int.Clear"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">intClear</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#int.Clear">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Clear interrupt</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">InterruptDsp_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>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
-<span class="xdocChildSum">— Remote MultiProc Id</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">intInfo</span>
-<span class="xdocChildSum">— Information needed to configure interrupt line</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">RETURNS</div>
-<div class="xdocText">Value (if any) of the interrupt before
- it was cleared</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="int.Disable"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">intDisable</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#int.Disable">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Disables the interrupt corresponding to intId</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptDsp_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>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
-<span class="xdocChildSum">— Remote MultiProc Id</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">intInfo</span>
-<span class="xdocChildSum">— Information needed to configure interrupt line</span>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="int.Enable"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">intEnable</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#int.Enable">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Enables the interrupt corresponding to intId</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptDsp_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>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
-<span class="xdocChildSum">— Remote MultiProc Id</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">intInfo</span>
-<span class="xdocChildSum">— Information needed to configure interrupt line</span>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="int.Register"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">intRegister</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#int.Register">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Register an interrupt line to a remote processor</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptDsp_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>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
-<span class="xdocChildSum">— Remote MultiProc Id</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">intInfo</span>
-<span class="xdocChildSum">— Information needed to configure interrupt line</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">func</span>
-<span class="xdocChildSum">— Function to register.</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">arg</span>
-<span class="xdocChildSum">— Argument that will be passed to func</span>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="int.Send"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">intSend</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#int.Send">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Send interrupt to the remote processor</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptDsp_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>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
-<span class="xdocChildSum">— Remote MultiProc Id</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">intInfo</span>
-<span class="xdocChildSum">— Information needed to configure interrupt line</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">arg</span>
-<span class="xdocChildSum">— Argument for sending interrupt.</span>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="int.Unregister"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">InterruptDsp_</span><span class="xdoc-id">intUnregister</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#int.Unregister">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Unregister an interrupt line to a remote processor</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptDsp_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>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">remoteProcId</span>
-<span class="xdocChildSum">— Remote MultiProc Id</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">intInfo</span>
-<span class="xdocChildSum">— Information needed to configure interrupt line</span>
-</div>
-<a class="xdocAnchor" id="module-wide_built-ins"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#module-wide_built-ins">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<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">InterruptDsp_Module_id</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">InterruptDsp_Module_startupDone</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<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">InterruptDsp_Module_heap</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">InterruptDsp_Module_hasMask</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">InterruptDsp_Module_getMask</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">InterruptDsp_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/arctic/InterruptDsp.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynM">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">var</span> InterruptDsp = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.family.arctic.InterruptDsp'</span>);
-</div>
-<div class='xdocSynHdr'>module-wide constants & types</div>
-
-<div class="xdocSynCode">
-<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">InterruptDsp.<span class="xdoc-id">IntInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.sdo.ipc.family.arctic.InterruptDsp.IntInfo"><span class="xdoc-id">localIntId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.sdo.ipc.family.arctic.InterruptDsp.IntInfo"><span class="xdoc-id">remoteIntId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Int.Info" title="ti.sdo.ipc.family.arctic.InterruptDsp.IntInfo"><span class="xdoc-id">intVectorId</span></a> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
-</div>
-<div class='xdocSynHdr'>module-wide config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#metamailbox.Base.Addr">InterruptDsp.<span class="xdoc-id">mailboxBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">UInt32</span></i> 0x5908B000;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">InterruptDsp.<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>;
-</div>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocMetaElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.Int.Info"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">InterruptDsp.</span><span class="xdoc-id">IntInfo</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#.Int.Info">index URL</a></div>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> InterruptDsp.<span class="xdoc-id">IntInfo</span>;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">localIntId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">remoteIntId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">intVectorId</span> = <i><span class="xdoc-kw2">UInt</span></i><b> ...</b>
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.Int.Info" title="InterruptDsp_IntInfo">InterruptDsp_IntInfo</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metamailbox.Base.Addr"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptDsp.</span><span class="xdoc-id">mailboxBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#mailbox.Base.Addr">index URL</a></div>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>InterruptDsp.<span class="xdoc-id">mailboxBaseAddr</span> = <i><span class="xdoc-kw2">UInt32</span></i> 0x5908B000;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#mailbox.Base.Addr" title="InterruptDsp_mailboxBaseAddr">InterruptDsp_mailboxBaseAddr</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="common$"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">InterruptDsp.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/arctic/InterruptDsp.html" title="module InterruptDsp"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/arctic/InterruptDsp.html#common$">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>InterruptDsp.<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>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">All modules have this configuration parameter. Its name
- contains the '$' character to ensure it does not conflict with
- configuration parameters declared by the module. This allows
- new configuration parameters to be added in the future without
- any chance of breaking existing modules.</div>
-</div>
-<div id="xdocDate">generated on Mon, 23 May 2016 14:31:15 GMT</div>
-</div></div></body>
-</html>