packages/ti/sdo/ipc/family/c647x/Interrupt.xdc

   1 /*
   2  * Copyright (c) 2012-2013, Texas Instruments Incorporated
   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  */
  35
  36 import xdc.rov.ViewInfo;
  37
  38 /*!
  39  *  ======== Interrupt ========
  40  *  C647x/C667x based interrupt manager
  41  */
  42 @ModuleStartup
  43
  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     }
  53
  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         });
  70
  71     /*!
  72      *  ======== enableKick ========
  73      *  If set to 'true' IPC will unlock the KICK registers on C66x devices
  74      *
  75      *  IPC unlocks the KICK registers on the local core if (and only if) all
  76      *  the following conditions are met:
  77      *  - This configuration is set to 'true'
  78      *  - SharedRegion #0 is valid and the local core is its owner
  79      *  - SharedRegion #0 is not valid and the local core is CORE0
  80      */
  81     config Bool enableKick = true;
  82
  83 internal:
  84
  85     /*! Shift value used for setting/identifying interrupt source */
  86     const UInt SRCSx_SHIFT = 4;
  87
  88     /*! Ptr to the IPC Generation Registers */
  89     config Ptr IPCGR0;
  90
  91     /*! Ptr to the IPC Acknowledgment Registers */
  92     config Ptr IPCAR0;
  93
  94     /*! Ptr to the KICK0 Bootcfg Registers */
  95     config Ptr KICK0;
  96
  97     /*! Ptr to the KICK1 Bootcfg Registers */
  98     config Ptr KICK1;
  99
 100     /*! Inter-processor interrupt id (varies per device) */
 101     config UInt INTERDSPINT;
 102
 103     /*!
 104      *  ======== intShmStub ========
 105      *  Stub function plugged as interrupt handler
 106      */
 107     Void intShmStub(UArg arg);
 108
 109     struct Module_State {
 110         Fxn    func;
 111         UArg   args[];  /* One entry for each core */
 112         UInt   numPlugged;  /* # of times the interrupt was registered */
 113     };
 114 }