git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2014 - 2015 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 R5 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 * 5.00  pkp  02/20/14 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                  0U
  70 #define XIL_EXCEPTION_ID_RESET                  0U
  71 #define XIL_EXCEPTION_ID_UNDEFINED_INT          1U
  72 #define XIL_EXCEPTION_ID_SWI_INT                2U
  73 #define XIL_EXCEPTION_ID_PREFETCH_ABORT_INT     3U
  74 #define XIL_EXCEPTION_ID_DATA_ABORT_INT         4U
  75 #define XIL_EXCEPTION_ID_IRQ_INT                5U
  76 #define XIL_EXCEPTION_ID_FIQ_INT                6U
  77 #define XIL_EXCEPTION_ID_LAST                   6U
  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 #define Xil_ExceptionEnableMask(Mask)   \
 107                 mtcpsr(mfcpsr() & ~ ((Mask) & XIL_EXCEPTION_ALL))
 108
 109
 110 /****************************************************************************/
 111 /**
 112 * Enable the IRQ exception.
 113 *
 114 * @return   None.
 115 *
 116 * @note     None.
 117 *
 118 ******************************************************************************/
 119 #define Xil_ExceptionEnable() \
 120                 Xil_ExceptionEnableMask(XIL_EXCEPTION_IRQ)
 121
 122 /****************************************************************************/
 123 /**
 124 * Disable Exceptions.
 125 *
 126 * @param        Mask for exceptions to be enabled.
 127 *
 128 * @return       None.
 129 *
 130 * @note         If bit is 1, exception is disabled.
 131 *               C-Style signature: Xil_ExceptionDisableMask(Mask)
 132 *
 133 ******************************************************************************/
 134 #define Xil_ExceptionDisableMask(Mask)  \
 135                 mtcpsr(mfcpsr() | ((Mask) & XIL_EXCEPTION_ALL))
 136
 137 /****************************************************************************/
 138 /**
 139 * Disable the IRQ exception.
 140 *
 141 * @return   None.
 142 *
 143 * @note     None.
 144 *
 145 ******************************************************************************/
 146 #define Xil_ExceptionDisable() \
 147                 Xil_ExceptionDisableMask(XIL_EXCEPTION_IRQ)
 148
 149 /****************************************************************************/
 150 /**
 151 * Enable nested interrupts by clearing the I and F bits it CPSR
 152 *
 153 * @return   None.
 154 *
 155 * @note     This macro is supposed to be used from interrupt handlers. In the
 156 *                       interrupt handler the interrupts are disabled by default (I and F
 157 *                       are 1). To allow nesting of interrupts, this macro should be
 158 *                       used. It clears the I and F bits by changing the ARM mode to
 159 *                       system mode. Once these bits are cleared and provided the
 160 *                       preemption of interrupt conditions are met in the GIC, nesting of
 161 *                       interrupts will start happening.
 162 *                       Caution: This macro must be used with caution. Before calling this
 163 *                       macro, the user must ensure that the source of the current IRQ
 164 *                       is appropriately cleared. Otherwise, as soon as we clear the I and
 165 *                       F bits, there can be an infinite loop of interrupts with an
 166 *                       eventual crash (all the stack space getting consumed).
 167 ******************************************************************************/
 168 #define Xil_EnableNestedInterrupts() \
 169                 __asm__ __volatile__ ("mrs     lr, spsr");  \
 170                 __asm__ __volatile__ ("stmfd   sp!, {lr}"); \
 171                 __asm__ __volatile__ ("msr     cpsr_c, #0x1F"); \
 172                 __asm__ __volatile__ ("stmfd   sp!, {lr}");
 173
 174 /****************************************************************************/
 175 /**
 176 * Disable the nested interrupts by setting the I and F bits.
 177 *
 178 * @return   None.
 179 *
 180 * @note     This macro is meant to be called in the interrupt service routines.
 181 *                       This macro cannot be used independently. It can only be used when
 182 *                       nesting of interrupts have been enabled by using the macro
 183 *                       Xil_EnableNestedInterrupts(). In a typical flow, the user first
 184 *                       calls the Xil_EnableNestedInterrupts in the ISR at the appropriate
 185 *                       point. The user then must call this macro before exiting the interrupt
 186 *                       service routine. This macro puts the ARM back in IRQ/FIQ mode and
 187 *                       hence sets back the I and F bits.
 188 ******************************************************************************/
 189 #define Xil_DisableNestedInterrupts() \
 190                 __asm__ __volatile__ ("ldmfd   sp!, {lr}");   \
 191                 __asm__ __volatile__ ("msr     cpsr_c, #0x92"); \
 192                 __asm__ __volatile__ ("ldmfd   sp!, {lr}"); \
 193                 __asm__ __volatile__ ("msr     spsr_cxsf, lr");
 194
 195 /************************** Variable Definitions ****************************/
 196
 197 /************************** Function Prototypes *****************************/
 198
 199 extern void Xil_ExceptionRegisterHandler(u32 Exception_id,
 200                                          Xil_ExceptionHandler Handler,
 201                                          void *Data);
 202
 203 extern void Xil_ExceptionRemoveHandler(u32 Exception_id);
 204
 205 extern void Xil_ExceptionInit(void);
 206
 207 extern void Xil_DataAbortHandler(void *CallBackRef);
 208
 209 extern void Xil_PrefetchAbortHandler(void *CallBackRef);
 210
 211 #ifdef __cplusplus
 212 }
 213 #endif /* __cplusplus */
 214
 215 #endif /* XIL_EXCEPTION_H */