git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo_bsp/ps7_cortexa9_0/include/xil_exception.h

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2009 - 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 xil_exception.h
  36 *
  37 * This header file contains ARM Cortex A9 specific exception related APIs.
  38 * For exception related functions that can be used across all Xilinx supported
  39 * processors, please use xil_exception.h.
  40 *
  41 * <pre>
  42 * MODIFICATION HISTORY:
  43 *
  44 * Ver   Who      Date     Changes
  45 * ----- -------- -------- -----------------------------------------------
  46 * 1.00a ecm/sdm  11/04/09 First release
  47 * </pre>
  48 *
  49 ******************************************************************************/
  50
  51 #ifndef XIL_EXCEPTION_H /* prevent circular inclusions */
  52 #define XIL_EXCEPTION_H /* by using protection macros */
  53
  54 /***************************** Include Files ********************************/
  55
  56 #include "xil_types.h"
  57 #include "xpseudo_asm.h"
  58
  59 #ifdef __cplusplus
  60 extern "C" {
  61 #endif
  62
  63 /************************** Constant Definitions ****************************/
  64
  65 #define XIL_EXCEPTION_FIQ       XREG_CPSR_FIQ_ENABLE
  66 #define XIL_EXCEPTION_IRQ       XREG_CPSR_IRQ_ENABLE
  67 #define XIL_EXCEPTION_ALL       (XREG_CPSR_FIQ_ENABLE | XREG_CPSR_IRQ_ENABLE)
  68
  69 #define XIL_EXCEPTION_ID_FIRST                  0
  70 #define XIL_EXCEPTION_ID_RESET                  0
  71 #define XIL_EXCEPTION_ID_UNDEFINED_INT          1
  72 #define XIL_EXCEPTION_ID_SWI_INT                2
  73 #define XIL_EXCEPTION_ID_PREFETCH_ABORT_INT     3
  74 #define XIL_EXCEPTION_ID_DATA_ABORT_INT         4
  75 #define XIL_EXCEPTION_ID_IRQ_INT                5
  76 #define XIL_EXCEPTION_ID_FIQ_INT                6
  77 #define XIL_EXCEPTION_ID_LAST                   6
  78
  79 /*
  80  * XIL_EXCEPTION_ID_INT is defined for all Xilinx processors.
  81  */
  82 #define XIL_EXCEPTION_ID_INT    XIL_EXCEPTION_ID_IRQ_INT
  83
  84 /**************************** Type Definitions ******************************/
  85
  86 /**
  87  * This typedef is the exception handler function.
  88  */
  89 typedef void (*Xil_ExceptionHandler)(void *data);
  90 typedef void (*Xil_InterruptHandler)(void *data);
  91
  92 /***************** Macros (Inline Functions) Definitions ********************/
  93
  94 /****************************************************************************/
  95 /**
  96 * Enable Exceptions.
  97 *
  98 * @param        Mask for exceptions to be enabled.
  99 *
 100 * @return       None.
 101 *
 102 * @note         If bit is 0, exception is enabled.
 103 *               C-Style signature: void Xil_ExceptionEnableMask(Mask);
 104 *
 105 ******************************************************************************/
 106 #ifdef __GNUC__
 107 #define Xil_ExceptionEnableMask(Mask)   \
 108                 mtcpsr(mfcpsr() & ~ (Mask & XIL_EXCEPTION_ALL))
 109 #else
 110 #define Xil_ExceptionEnableMask(Mask)   \
 111                 { register unsigned int Reg __asm("cpsr"); \
 112                   mtcpsr(Reg & ~ (Mask & XIL_EXCEPTION_ALL)) }
 113 #endif
 114
 115 /****************************************************************************/
 116 /**
 117 * Enable the IRQ exception.
 118 *
 119 * @return   None.
 120 *
 121 * @note     None.
 122 *
 123 ******************************************************************************/
 124 #define Xil_ExceptionEnable() \
 125                 Xil_ExceptionEnableMask(XIL_EXCEPTION_IRQ)
 126
 127 /****************************************************************************/
 128 /**
 129 * Disable Exceptions.
 130 *
 131 * @param        Mask for exceptions to be enabled.
 132 *
 133 * @return       None.
 134 *
 135 * @note         If bit is 1, exception is disabled.
 136 *               C-Style signature: Xil_ExceptionDisableMask(Mask);
 137 *
 138 ******************************************************************************/
 139 #ifdef __GNUC__
 140 #define Xil_ExceptionDisableMask(Mask)  \
 141                 mtcpsr(mfcpsr() | (Mask & XIL_EXCEPTION_ALL))
 142 #else
 143 #define Xil_ExceptionDisableMask(Mask)  \
 144                 { register unsigned int Reg __asm("cpsr"); \
 145                   mtcpsr(Reg | (Mask & XIL_EXCEPTION_ALL)) }
 146 #endif
 147
 148 /****************************************************************************/
 149 /**
 150 * Disable the IRQ exception.
 151 *
 152 * @return   None.
 153 *
 154 * @note     None.
 155 *
 156 ******************************************************************************/
 157 #define Xil_ExceptionDisable() \
 158                 Xil_ExceptionDisableMask(XIL_EXCEPTION_IRQ)
 159
 160 /****************************************************************************/
 161 /**
 162 * Enable nested interrupts by clearing the I and F bits it CPSR
 163 *
 164 * @return   None.
 165 *
 166 * @note     This macro is supposed to be used from interrupt handlers. In the
 167 *                       interrupt handler the interrupts are disabled by default (I and F
 168 *                       are 1). To allow nesting of interrupts, this macro should be
 169 *                       used. It clears the I and F bits by changing the ARM mode to
 170 *                       system mode. Once these bits are cleared and provided the
 171 *                       preemption of interrupt conditions are met in the GIC, nesting of
 172 *                       interrupts will start happening.
 173 *                       Caution: This macro must be used with caution. Before calling this
 174 *                       macro, the user must ensure that the source of the current IRQ
 175 *                       is appropriately cleared. Otherwise, as soon as we clear the I and
 176 *                       F bits, there can be an infinite loop of interrupts with an
 177 *                       eventual crash (all the stack space getting consumed).
 178 ******************************************************************************/
 179 #define Xil_EnableNestedInterrupts() \
 180                 __asm__ __volatile__ ("mrs     lr, spsr");  \
 181                 __asm__ __volatile__ ("stmfd   sp!, {lr}"); \
 182                 __asm__ __volatile__ ("msr     cpsr_c, #0x1F"); \
 183                 __asm__ __volatile__ ("stmfd   sp!, {lr}");
 184
 185 /****************************************************************************/
 186 /**
 187 * Disable the nested interrupts by setting the I and F bits.
 188 *
 189 * @return   None.
 190 *
 191 * @note     This macro is meant to be called in the interrupt service routines.
 192 *                       This macro cannot be used independently. It can only be used when
 193 *                       nesting of interrupts have been enabled by using the macro
 194 *                       Xil_EnableNestedInterrupts(). In a typical flow, the user first
 195 *                       calls the Xil_EnableNestedInterrupts in the ISR at the appropriate
 196 *                       point. The user then must call this macro before exiting the interrupt
 197 *                       service routine. This macro puts the ARM back in IRQ/FIQ mode and
 198 *                       hence sets back the I and F bits.
 199 ******************************************************************************/
 200 #define Xil_DisableNestedInterrupts() \
 201                 __asm__ __volatile__ ("ldmfd   sp!, {lr}");   \
 202                 __asm__ __volatile__ ("msr     cpsr_c, #0x92"); \
 203                 __asm__ __volatile__ ("ldmfd   sp!, {lr}"); \
 204                 __asm__ __volatile__ ("msr     spsr_cxsf, lr");
 205
 206 /************************** Variable Definitions ****************************/
 207
 208 /************************** Function Prototypes *****************************/
 209
 210 extern void Xil_ExceptionRegisterHandler(u32 id,
 211                                          Xil_ExceptionHandler handler,
 212                                          void *data);
 213
 214 extern void Xil_ExceptionRemoveHandler(u32 id);
 215
 216 extern void Xil_ExceptionInit(void);
 217
 218 #ifdef __cplusplus
 219 }
 220 #endif /* __cplusplus */
 221
 222 #endif /* XIL_EXCEPTION_H */