1 /*
2 * Copyright (c) 2013-2015 Texas Instruments Incorporated - http://www.ti.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
33 /*
34 * ======== Interrupt.xdc ========
35 */
36 package ti.ipc.family.tci6638;
38 import xdc.runtime.Assert;
40 /*!
41 * ======== Interrupt ========
42 * TCI66xx IPC interrupt manager
43 */
44 module Interrupt inherits ti.sdo.ipc.notifyDrivers.IInterrupt
45 {
47 const UInt INVALIDPAYLOAD = 0xFFFFFFFF;
49 /*!
50 * ======== enableKick ========
51 * If set to 'true' IPC will unlock the KICK registers on C66x devices
52 *
53 * IPC unlocks the KICK registers on the local core if (and only if) all
54 * the following conditions are met:
55 * - This configuration is set to 'true'
56 * - SharedRegion #0 is valid and the local core is its owner
57 * - SharedRegion #0 is not valid and the local core is CORE0
58 */
59 config Bool enableKick = true;
61 /*! Function not implemented
62 */
63 config Assert.Id A_notImplemented = {
64 msg: "A_notImplemented: this function is not implemented"
65 };
67 /*!
68 * ======== Interrupt_intClearAll ========
69 * Clear all pending interrupts.
70 */
71 Void intClearAll();
73 /*!
74 * ======== Interrupt_checkAndClear =======
75 * Check to see that interrupt is set, if so clear it and return 1.
76 */
77 UInt checkAndClear(UInt16 remoteProcId, IntInfo *intInfo);
79 internal:
81 /*! Source ID bit position for CORE0 */
82 const UInt SRCS_BITPOS_CORE0 = 4;
84 /*! Source ID bit position for HOST */
85 const UInt SRCS_BITPOS_HOST = 31;
87 /*! Ptr to the IPC Generation Registers */
88 config Ptr IPCGR0 = null;
90 /*! Ptr to the IPC Acknowledgment Registers */
91 config Ptr IPCAR0 = null;
93 /*! Ptr to the IPC Host Generation Host Register */
94 config Ptr IPCGRH = null;
96 /*! Ptr to the IPC Acknowledgement Host Register */
97 config Ptr IPCARH = null;
99 /*! Ptr to the KICK0 Bootcfg Registers */
100 config Ptr KICK0 = null;
102 /*! Ptr to the KICK1 Bootcfg Registers */
103 config Ptr KICK1 = null;
105 /*! Inter-processor interrupt id (varies per device) */
106 config UInt INTERDSPINT = -1;
108 /*! Vector interrupt id for Hwi_create */
109 config UInt DSPINT = -1;
111 }