[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 / vayu / InterruptDsp-src.html
diff --git a/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/family/vayu/InterruptDsp-src.html b/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/family/vayu/InterruptDsp-src.html
+++ /dev/null
@@ -1,140 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><title>module ti.sdo.ipc.family.vayu.InterruptDsp</title>
-<meta name="googlebot" content="noindex,nofollow">
-<link rel="stylesheet" type="text/css" href="../../../../../src.css"/>
-</head>
-<body>
-<pre class=src>
- 1 <span class="comment">/*
-</span> 2 <span class="comment"> * Copyright (c) 2012-2014 Texas Instruments Incorporated - http://www.ti.com
-</span> 3 <span class="comment"> * All rights reserved.
-</span> 4 <span class="comment"> *
-</span> 5 <span class="comment"> * Redistribution and use in source and binary forms, with or without
-</span> 6 <span class="comment"> * modification, are permitted provided that the following conditions
-</span> 7 <span class="comment"> * are met:
-</span> 8 <span class="comment"> *
-</span> 9 <span class="comment"> * * Redistributions of source code must retain the above copyright
-</span> 10 <span class="comment"> * notice, this list of conditions and the following disclaimer.
-</span> 11 <span class="comment"> *
-</span> 12 <span class="comment"> * * Redistributions in binary form must reproduce the above copyright
-</span> 13 <span class="comment"> * notice, this list of conditions and the following disclaimer in the
-</span> 14 <span class="comment"> * documentation and/or other materials provided with the distribution.
-</span> 15 <span class="comment"> *
-</span> 16 <span class="comment"> * * Neither the name of Texas Instruments Incorporated nor the names of
-</span> 17 <span class="comment"> * its contributors may be used to endorse or promote products derived
-</span> 18 <span class="comment"> * from this software without specific prior written permission.
-</span> 19 <span class="comment"> *
-</span> 20 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-</span> 21 <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-</span> 22 <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-</span> 23 <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-</span> 24 <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-</span> 25 <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-</span> 26 <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-</span> 27 <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-</span> 28 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-</span> 29 <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-</span> 30 <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-</span> 31 <span class="comment"> */</span>
- 32
- 33 <span class="comment">/*
-</span> 34 <span class="comment"> * ======== InterruptDsp.xdc ========
-</span> 35 <span class="comment"> */</span>
- 36 <span class=key>package</span> ti.sdo.ipc.family.vayu;
- 37
- 38 import ti.sdo.utils.MultiProc;
- 39 import xdc.rov.ViewInfo;
- 40
- 41 <span class="xdoc">/*!
-</span> 42 <span class="xdoc"> * ======== InterruptDsp ========
-</span> 43 <span class="xdoc"> * Vayu/DSP interrupt manager
-</span> 44 <span class="xdoc"> */</span>
- 45 <span class=key>module</span> InterruptDsp <span class=key>inherits</span> ti.sdo.ipc.notifyDrivers.IInterrupt
- 46 {
- 47 <span class="xdoc">/*! <b>@_nodoc</b> */</span>
- 48 <span class=key>metaonly</span> <span class=key>struct</span> InterruptDataView {
- 49 String remoteProcName;
- 50 Bool registered;
- 51 Bool enabled;
- 52 Bool intPending;
- 53 Ptr payload;
- 54 };
- 55
- 56 <span class="xdoc">/*! <b>@_nodoc</b> */</span>
- 57 <span class=comment>// @Facet</span>
- 58 <span class=comment>// metaonly config xdc.rov.ViewInfo.Instance rovViewInfo =</span>
- 59 <span class=comment>// xdc.rov.ViewInfo.create({</span>
- 60 <span class=comment>// viewMap: [</span>
- 61 <span class=comment>// ['IncomingInterrupts',</span>
- 62 <span class=comment>// {</span>
- 63 <span class=comment>// type: xdc.rov.ViewInfo.MODULE_DATA,</span>
- 64 <span class=comment>// viewInitFxn: 'viewInitInterrupt',</span>
- 65 <span class=comment>// structName: 'InterruptDataView'</span>
- 66 <span class=comment>// }</span>
- 67 <span class=comment>// ],</span>
- 68 <span class=comment>// ]</span>
- 69 <span class=comment>// });</span>
- 70
- 71 <span class="comment">/* Total number of cores on Vayu SoC */</span>
- 72 <span class=key>const</span> UInt8 NUM_CORES = 11;
- 73
- 74 <span class="comment">/* Number of Cores in EVE Sub-system */</span>
- 75 <span class=key>const</span> UInt8 NUM_EVES = 4;
- 76
- 77 <span class="comment">/* Number of Cores in DSP Sub-system */</span>
- 78 <span class=key>const</span> UInt8 NUM_DSP_CORES = 2;
- 79
- 80 <span class="comment">/* Number of Internal EVE mailboxes */</span>
- 81 <span class=key>const</span> UInt8 NUM_EVE_MBX = 12;
- 82
- 83 <span class="comment">/* Number of System Mailboxes */</span>
- 84 <span class=key>const</span> UInt8 NUM_SYS_MBX = 4;
- 85
- 86 <span class="comment">/* Base address for the Mailbox subsystem */</span>
- 87 <span class=key>config</span> UInt32 mailboxBaseAddr[NUM_EVE_MBX + NUM_SYS_MBX];
- 88
- 89 <span class=key>internal</span>:
- 90
- 91 <span class="comment">/*
-</span> 92 <span class="comment"> * Mailbox table for storing encoded Base Address, mailbox user Id,
-</span> 93 <span class="comment"> * and sub-mailbox index.
-</span> 94 <span class="comment"> */</span>
- 95 <span class=key>config</span> UInt32 mailboxTable[NUM_CORES * NUM_CORES];
- 96
- 97 <span class=key>config</span> UInt32 procIdTable[NUM_CORES];
- 98
- 99 <span class="xdoc">/*! Statically retrieve procIds to avoid doing this at runtime */</span>
- 100 <span class=key>config</span> UInt eve1ProcId = MultiProc.INVALIDID;
- 101 <span class=key>config</span> UInt eve2ProcId = MultiProc.INVALIDID;
- 102 <span class=key>config</span> UInt eve3ProcId = MultiProc.INVALIDID;
- 103 <span class=key>config</span> UInt eve4ProcId = MultiProc.INVALIDID;
- 104 <span class=key>config</span> UInt dsp1ProcId = MultiProc.INVALIDID;
- 105 <span class=key>config</span> UInt dsp2ProcId = MultiProc.INVALIDID;
- 106 <span class=key>config</span> UInt ipu1_0ProcId = MultiProc.INVALIDID;
- 107 <span class=key>config</span> UInt ipu2_0ProcId = MultiProc.INVALIDID;
- 108 <span class=key>config</span> UInt hostProcId = MultiProc.INVALIDID;
- 109 <span class=key>config</span> UInt ipu1_1ProcId = MultiProc.INVALIDID;
- 110 <span class=key>config</span> UInt ipu2_1ProcId = MultiProc.INVALIDID;
- 111
- 112 <span class="xdoc">/*! Function table */</span>
- 113 <span class=key>struct</span> FxnTable {
- 114 Fxn func;
- 115 UArg arg;
- 116 }
- 117
- 118 <span class="xdoc">/*!
-</span> 119 <span class="xdoc"> * ======== intShmStub ========
-</span> 120 <span class="xdoc"> * Stub to be plugged
-</span> 121 <span class="xdoc"> */</span>
- 122 Void intShmStub(UInt16 idx);
- 123
- 124 <span class=key>struct</span> Module_State {
- 125 <span class="comment">/*
-</span> 126 <span class="comment"> * Create a function table of length (Total number of cores in the
-</span> 127 <span class="comment"> * System) for each DSP core.
-</span> 128 <span class="comment"> */</span>
- 129 FxnTable fxnTable[NUM_CORES];
- 130 };
- 131 }
-</pre>
-</body></html>