2af219004c508ec455f0229c4f3005b03f4341ec
[ipc/ipcdev.git] / packages / ti / sdo / ipc / family / tci663x / Interrupt.xdc
1 /*
2  * Copyright (c) 2012-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  */
32 /*
33  *  ======== Interrupt.xdc ========
34  */
36 import xdc.rov.ViewInfo;
38 /*!
39  *  ======== Interrupt ========
40  *  TCI663x based interrupt manager
41  */
42 @ModuleStartup
44 module Interrupt inherits ti.sdo.ipc.notifyDrivers.IInterrupt
45 {
46     /* @_nodoc */
47     metaonly struct InterruptDataStruct {
48         UInt    remoteCoreId;
49         String  isrFxn;
50         String  isrArg;
51         Bool    isFlagged;
52     }
54     /*!
55      *  ======== rovViewInfo ========
56      */
57     @Facet
58     metaonly config ViewInfo.Instance rovViewInfo =
59         ViewInfo.create({
60             viewMap: [
61                 ['Registered Interrupts',
62                     {
63                         type: ViewInfo.MODULE_DATA,
64                         viewInitFxn: 'viewInterruptsData',
65                         structName: 'InterruptDataStruct'
66                     }
67                 ]
68             ]
69         });
71 internal:
73     /*! Shift value used for setting/identifying interrupt source */
74     const UInt SRCSx_SHIFT = 4;
76     /*! Ptr to the IPC Generation Registers */
77     config Ptr IPCGR0;
79     /*! Ptr to the IPC Acknowledgment Registers */
80     config Ptr IPCAR0;
82     /*! Inter-processor interrupt id (varies per device) */
83     config UInt INTERDSPINT;
85     /*!
86      *  ======== intShmStub ========
87      *  Stub function plugged as interrupt handler
88      */
89     Void intShmStub(UArg arg);
91     struct Module_State {
92         Fxn     func;
93         UInt    numPlugged;     /* # of times the interrupt was registered */
94         UArg    args[];         /* one entry for each core (in cluster) */
95     };
96 }