git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo_bsp/ps7_cortexa9_0/libsrc/scugic_v2_1/src/xscugic.h

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2010 - 2014 Xilinx, Inc.  All rights reserved.
   4 *
   5 * Permission is hereby granted, free of charge, to any person obtaining a copy
   6 * of this software and associated documentation files (the "Software"), to deal
   7 * in the Software without restriction, including without limitation the rights
   8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 * copies of the Software, and to permit persons to whom the Software is
  10 * furnished to do so, subject to the following conditions:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  15 * Use of the Software is limited solely to applications:
  16 * (a) running on a Xilinx device, or
  17 * (b) that interact with a Xilinx device through a bus or interconnect.
  18 *
  19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22 * XILINX  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25 * SOFTWARE.
  26 *
  27 * Except as contained in this notice, the name of the Xilinx shall not be used
  28 * in advertising or otherwise to promote the sale, use or other dealings in
  29 * this Software without prior written authorization from Xilinx.
  30 *
  31 ******************************************************************************/
  32 /*****************************************************************************/
  33 /**
  34 *
  35 * @file xscugic.h
  36 * @addtogroup scugic_v2_1
  37 * @{
  38 * @details
  39 *
  40 * The generic interrupt controller driver component.
  41 *
  42 * The interrupt controller driver uses the idea of priority for the various
  43 * handlers. Priority is an integer within the range of 1 and 31 inclusive with
  44 * default of 1 being the highest priority interrupt source. The priorities
  45 * of the various sources can be dynamically altered as needed through
  46 * hardware configuration.
  47 *
  48 * The generic interrupt controller supports the following
  49 * features:
  50 *
  51 *   - specific individual interrupt enabling/disabling
  52 *   - specific individual interrupt acknowledging
  53 *   - attaching specific callback function to handle interrupt source
  54 *   - assigning desired priority to interrupt source if default is not
  55 *     acceptable.
  56 *
  57 * Details about connecting the interrupt handler of the driver are contained
  58 * in the source file specific to interrupt processing, xscugic_intr.c.
  59 *
  60 * This driver is intended to be RTOS and processor independent.  It works with
  61 * physical addresses only.  Any needs for dynamic memory management, threads
  62 * or thread mutual exclusion, virtual memory, or cache control must be
  63 * satisfied by the layer above this driver.
  64 *
  65 * <b>Interrupt Vector Tables</b>
  66 *
  67 * The device ID of the interrupt controller device is used by the driver as a
  68 * direct index into the configuration data table. The user should populate the
  69 * vector table with handlers and callbacks at run-time using the
  70 * XScuGic_Connect() and XScuGic_Disconnect() functions.
  71 *
  72 * Each vector table entry corresponds to a device that can generate an
  73 * interrupt. Each entry contains an interrupt handler function and an
  74 * argument to be passed to the handler when an interrupt occurs.  The
  75 * user must use XScuGic_Connect() when the interrupt handler takes an
  76 * argument other than the base address.
  77 *
  78 * <b>Nested Interrupts Processing</b>
  79 *
  80 * Nested interrupts are not supported by this driver.
  81 *
  82 * NOTE:
  83 * The generic interrupt controller is not a part of the snoop control unit
  84 * as indicated by the prefix "scu" in the name of the driver.
  85 * It is an independent module in APU.
  86 *
  87 * <pre>
  88 * MODIFICATION HISTORY:
  89 *
  90 * Ver   Who  Date     Changes
  91 * ----- ---- -------- ---------------------------------------------------------
  92 * 1.00a drg  01/19/00 First release
  93 * 1.01a sdm  11/09/11 The XScuGic and XScuGic_Config structures have changed.
  94 *                     The HandlerTable (of type XScuGic_VectorTableEntry) is
  95 *                     moved to XScuGic_Config structure from XScuGic structure.
  96 *
  97 *                     The "Config" entry in XScuGic structure is made as
  98 *                     pointer for better efficiency.
  99 *
 100 *                     A new file named as xscugic_hw.c is now added. It is
 101 *                     to implement low level driver routines without using
 102 *                     any xscugic instance pointer. They are useful when the
 103 *                     user wants to use xscugic through device id or
 104 *                     base address. The driver routines provided are explained
 105 *                     below.
 106 *                     XScuGic_DeviceInitialize that takes device id as
 107 *                     argument and initializes the device (without calling
 108 *                     XScuGic_CfgInitialize).
 109 *                     XScuGic_DeviceInterruptHandler that takes device id
 110 *                     as argument and calls appropriate handlers from the
 111 *                     HandlerTable.
 112 *                     XScuGic_RegisterHandler that registers a new handler
 113 *                     by taking xscugic hardware base address as argument.
 114 *                     LookupConfigByBaseAddress is used to return the
 115 *                     corresponding config structure from XScuGic_ConfigTable
 116 *                     based on the scugic base address passed.
 117 * 1.02a sdm  12/20/11 Removed AckBeforeService from the XScuGic_Config
 118 *                     structure.
 119 * 1.03a srt  02/27/13 Moved Offset calculation macros from *.c and *_hw.c to
 120 *                     *_hw.h
 121 *                     Added APIs
 122 *                       - XScuGic_SetPriTrigTypeByDistAddr()
 123 *                       - XScuGic_GetPriTrigTypeByDistAddr()
 124 *                     (CR 702687)
 125 *                       Added support to direct interrupts to the appropriate CPU. Earlier
 126 *                         interrupts were directed to CPU1 (hard coded). Now depending
 127 *                         upon the CPU selected by the user (xparameters.h), interrupts
 128 *                         will be directed to the relevant CPU. This fixes CR 699688.
 129 * 1.04a hk   05/04/13 Assigned EffectiveAddr to CpuBaseAddress in
 130 *                         XScuGic_CfgInitialize. Fix for CR#704400 to remove warnings.
 131 *                         Moved functions XScuGic_SetPriTrigTypeByDistAddr and
 132 *             XScuGic_GetPriTrigTypeByDistAddr to xscugic_hw.c.
 133 *                         This is fix for CR#705621.
 134 * 1.05a hk   06/26/13 Modified tcl to export external interrupts correctly to
 135 *                     xparameters.h. Fix for CR's 690505, 708928 & 719359.
 136 * 2.0   adk  12/10/13 Updated as per the New Tcl API's
 137 * 2.1   adk  25/04/14 Fixed the CR:789373 changes are made in the driver tcl file.
 138 *
 139 * </pre>
 140 *
 141 ******************************************************************************/
 142
 143 #ifndef XSCUGIC_H /* prevent circular inclusions */
 144 #define XSCUGIC_H /* by using protection macros */
 145
 146 #ifdef __cplusplus
 147 extern "C" {
 148 #endif
 149
 150
 151 /***************************** Include Files *********************************/
 152
 153 #include "xstatus.h"
 154 #include "xil_io.h"
 155 #include "xscugic_hw.h"
 156 #include "xil_exception.h"
 157
 158 /************************** Constant Definitions *****************************/
 159
 160
 161 /**************************** Type Definitions *******************************/
 162
 163 /* The following data type defines each entry in an interrupt vector table.
 164  * The callback reference is the base address of the interrupting device
 165  * for the low level driver and an instance pointer for the high level driver.
 166  */
 167 typedef struct
 168 {
 169         Xil_InterruptHandler Handler;
 170         void *CallBackRef;
 171 } XScuGic_VectorTableEntry;
 172
 173 /**
 174  * This typedef contains configuration information for the device.
 175  */
 176 typedef struct
 177 {
 178         u16 DeviceId;           /**< Unique ID  of device */
 179         u32 CpuBaseAddress;     /**< CPU Interface Register base address */
 180         u32 DistBaseAddress;    /**< Distributor Register base address */
 181         XScuGic_VectorTableEntry HandlerTable[XSCUGIC_MAX_NUM_INTR_INPUTS];/**<
 182                                  Vector table of interrupt handlers */
 183 } XScuGic_Config;
 184
 185 /**
 186  * The XScuGic driver instance data. The user is required to allocate a
 187  * variable of this type for every intc device in the system. A pointer
 188  * to a variable of this type is then passed to the driver API functions.
 189  */
 190 typedef struct
 191 {
 192         XScuGic_Config *Config;  /**< Configuration table entry */
 193         u32 IsReady;             /**< Device is initialized and ready */
 194         u32 UnhandledInterrupts; /**< Intc Statistics */
 195 } XScuGic;
 196
 197 /***************** Macros (Inline Functions) Definitions *********************/
 198
 199 /****************************************************************************/
 200 /**
 201 *
 202 * Write the given CPU Interface register
 203 *
 204 * @param    InstancePtr is a pointer to the instance to be worked on.
 205 * @param    RegOffset is the register offset to be written
 206 * @param    Data is the 32-bit value to write to the register
 207 *
 208 * @return   None.
 209 *
 210 * @note
 211 * C-style signature:
 212 *    void XScuGic_CPUWriteReg(XScuGic *InstancePtr, u32 RegOffset, u32 Data)
 213 *
 214 *****************************************************************************/
 215 #define XScuGic_CPUWriteReg(InstancePtr, RegOffset, Data) \
 216 (XScuGic_WriteReg(((InstancePtr)->Config->CpuBaseAddress), (RegOffset), \
 217                                         ((u32)Data)))
 218
 219 /****************************************************************************/
 220 /**
 221 *
 222 * Read the given CPU Interface register
 223 *
 224 * @param    InstancePtr is a pointer to the instance to be worked on.
 225 * @param    RegOffset is the register offset to be read
 226 *
 227 * @return   The 32-bit value of the register
 228 *
 229 * @note
 230 * C-style signature:
 231 *    u32 XScuGic_CPUReadReg(XScuGic *InstancePtr, u32 RegOffset)
 232 *
 233 *****************************************************************************/
 234 #define XScuGic_CPUReadReg(InstancePtr, RegOffset) \
 235         (XScuGic_ReadReg(((InstancePtr)->Config->CpuBaseAddress), (RegOffset)))
 236
 237 /****************************************************************************/
 238 /**
 239 *
 240 * Write the given Distributor Interface register
 241 *
 242 * @param    InstancePtr is a pointer to the instance to be worked on.
 243 * @param    RegOffset is the register offset to be written
 244 * @param    Data is the 32-bit value to write to the register
 245 *
 246 * @return   None.
 247 *
 248 * @note
 249 * C-style signature:
 250 *    void XScuGic_DistWriteReg(XScuGic *InstancePtr, u32 RegOffset, u32 Data)
 251 *
 252 *****************************************************************************/
 253 #define XScuGic_DistWriteReg(InstancePtr, RegOffset, Data) \
 254 (XScuGic_WriteReg(((InstancePtr)->Config->DistBaseAddress), (RegOffset), \
 255                                         ((u32)Data)))
 256
 257 /****************************************************************************/
 258 /**
 259 *
 260 * Read the given Distributor Interface register
 261 *
 262 * @param    InstancePtr is a pointer to the instance to be worked on.
 263 * @param    RegOffset is the register offset to be read
 264 *
 265 * @return   The 32-bit value of the register
 266 *
 267 * @note
 268 * C-style signature:
 269 *    u32 XScuGic_DistReadReg(XScuGic *InstancePtr, u32 RegOffset)
 270 *
 271 *****************************************************************************/
 272 #define XScuGic_DistReadReg(InstancePtr, RegOffset) \
 273 (XScuGic_ReadReg(((InstancePtr)->Config->DistBaseAddress), (RegOffset)))
 274
 275 /************************** Function Prototypes ******************************/
 276
 277 /*
 278  * Required functions in xscugic.c
 279  */
 280
 281 int  XScuGic_Connect(XScuGic *InstancePtr, u32 Int_Id,
 282                         Xil_InterruptHandler Handler, void *CallBackRef);
 283 void XScuGic_Disconnect(XScuGic *InstancePtr, u32 Int_Id);
 284
 285 void XScuGic_Enable(XScuGic *InstancePtr, u32 Int_Id);
 286 void XScuGic_Disable(XScuGic *InstancePtr, u32 Int_Id);
 287
 288 int  XScuGic_CfgInitialize(XScuGic *InstancePtr, XScuGic_Config *ConfigPtr,
 289                                                         u32 EffectiveAddr);
 290
 291 int  XScuGic_SoftwareIntr(XScuGic *InstancePtr, u32 Int_Id, u32 Cpu_Id);
 292
 293 void XScuGic_GetPriorityTriggerType(XScuGic *InstancePtr, u32 Int_Id,
 294                                         u8 *Priority, u8 *Trigger);
 295 void XScuGic_SetPriorityTriggerType(XScuGic *InstancePtr, u32 Int_Id,
 296                                         u8 Priority, u8 Trigger);
 297
 298 /*
 299  * Initialization functions in xscugic_sinit.c
 300  */
 301 XScuGic_Config *XScuGic_LookupConfig(u16 DeviceId);
 302
 303 /*
 304  * Interrupt functions in xscugic_intr.c
 305  */
 306 void XScuGic_InterruptHandler(XScuGic *InstancePtr);
 307
 308 /*
 309  * Self-test functions in xscugic_selftest.c
 310  */
 311 int  XScuGic_SelfTest(XScuGic *InstancePtr);
 312
 313 #ifdef __cplusplus
 314 }
 315 #endif
 316
 317 #endif            /* end of protection macro */
 318
 319 /** @} */