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

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2015 - 2016 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 A53,A9,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 * @addtogroup arm_exception_apis ARM Processor Exception Handling
  42 * @{
  43 * ARM processors specific exception related APIs for cortex A53,A9 and R5 can
  44 * utilized for enabling/disabling IRQ, registering/removing handler for
  45 * exceptions or initializing exception vector table with null handler.
  46 *
  47 * <pre>
  48 * MODIFICATION HISTORY:
  49 *
  50 * Ver   Who      Date     Changes
  51 * ----- -------- -------- -----------------------------------------------
  52 * 5.2   pkp      28/05/15 First release
  53 * 6.0   mus      27/07/16 Consolidated file for a53,a9 and r5 processors
  54 * </pre>
  55 *
  56 ******************************************************************************/
  57
  58 #ifndef XIL_EXCEPTION_H /* prevent circular inclusions */
  59 #define XIL_EXCEPTION_H /* by using protection macros */
  60
  61 /***************************** Include Files ********************************/
  62
  63 #include "xil_types.h"
  64 #include "xpseudo_asm.h"
  65
  66 #ifdef __cplusplus
  67 extern "C" {
  68 #endif
  69
  70 /************************** Constant Definitions ****************************/
  71
  72 #define XIL_EXCEPTION_FIQ       XREG_CPSR_FIQ_ENABLE
  73 #define XIL_EXCEPTION_IRQ       XREG_CPSR_IRQ_ENABLE
  74 #define XIL_EXCEPTION_ALL       (XREG_CPSR_FIQ_ENABLE | XREG_CPSR_IRQ_ENABLE)
  75
  76 #define XIL_EXCEPTION_ID_FIRST                  0U
  77 #if defined (__aarch64__)
  78 #define XIL_EXCEPTION_ID_SYNC_INT               1U
  79 #define XIL_EXCEPTION_ID_IRQ_INT                2U
  80 #define XIL_EXCEPTION_ID_FIQ_INT                3U
  81 #define XIL_EXCEPTION_ID_SERROR_ABORT_INT               4U
  82 #define XIL_EXCEPTION_ID_LAST                   5U
  83 #else
  84 #define XIL_EXCEPTION_ID_RESET                  0U
  85 #define XIL_EXCEPTION_ID_UNDEFINED_INT          1U
  86 #define XIL_EXCEPTION_ID_SWI_INT                2U
  87 #define XIL_EXCEPTION_ID_PREFETCH_ABORT_INT     3U
  88 #define XIL_EXCEPTION_ID_DATA_ABORT_INT         4U
  89 #define XIL_EXCEPTION_ID_IRQ_INT                5U
  90 #define XIL_EXCEPTION_ID_FIQ_INT                6U
  91 #define XIL_EXCEPTION_ID_LAST                   6U
  92 #endif
  93
  94 /*
  95  * XIL_EXCEPTION_ID_INT is defined for all Xilinx processors.
  96  */
  97 #define XIL_EXCEPTION_ID_INT    XIL_EXCEPTION_ID_IRQ_INT
  98
  99 /**************************** Type Definitions ******************************/
 100
 101 /**
 102  * This typedef is the exception handler function.
 103  */
 104 typedef void (*Xil_ExceptionHandler)(void *data);
 105 typedef void (*Xil_InterruptHandler)(void *data);
 106
 107 /***************** Macros (Inline Functions) Definitions ********************/
 108
 109 /****************************************************************************/
 110 /**
 111 * @brief        Enable Exceptions.
 112 *
 113 * @param        Mask: Value for enabling the exceptions.
 114 *
 115 * @return       None.
 116 *
 117 * @note         If bit is 0, exception is enabled.
 118 *                       C-Style signature: void Xil_ExceptionEnableMask(Mask)
 119 *
 120 ******************************************************************************/
 121 #if defined (__GNUC__) || defined (__ICCARM__)
 122 #define Xil_ExceptionEnableMask(Mask)   \
 123                 mtcpsr(mfcpsr() & ~ ((Mask) & XIL_EXCEPTION_ALL))
 124 #else
 125 #define Xil_ExceptionEnableMask(Mask)   \
 126                 {                                                               \
 127                   register u32 Reg __asm("cpsr"); \
 128                   mtcpsr((Reg) & (~((Mask) & XIL_EXCEPTION_ALL))); \
 129                 }
 130 #endif
 131 /****************************************************************************/
 132 /**
 133 * @brief        Enable the IRQ exception.
 134 *
 135 * @return   None.
 136 *
 137 * @note     None.
 138 *
 139 ******************************************************************************/
 140 #define Xil_ExceptionEnable() \
 141                 Xil_ExceptionEnableMask(XIL_EXCEPTION_IRQ)
 142
 143 /****************************************************************************/
 144 /**
 145 * @brief        Disable Exceptions.
 146 *
 147 * @param        Mask: Value for disabling the exceptions.
 148 *
 149 * @return       None.
 150 *
 151 * @note         If bit is 1, exception is disabled.
 152 *                       C-Style signature: Xil_ExceptionDisableMask(Mask)
 153 *
 154 ******************************************************************************/
 155 #if defined (__GNUC__) || defined (__ICCARM__)
 156 #define Xil_ExceptionDisableMask(Mask)  \
 157                 mtcpsr(mfcpsr() | ((Mask) & XIL_EXCEPTION_ALL))
 158 #else
 159 #define Xil_ExceptionDisableMask(Mask)  \
 160                 {                                                                       \
 161                   register u32 Reg __asm("cpsr"); \
 162                   mtcpsr((Reg) | ((Mask) & XIL_EXCEPTION_ALL)); \
 163                 }
 164 #endif
 165 /****************************************************************************/
 166 /**
 167 * Disable the IRQ exception.
 168 *
 169 * @return   None.
 170 *
 171 * @note     None.
 172 *
 173 ******************************************************************************/
 174 #define Xil_ExceptionDisable() \
 175                 Xil_ExceptionDisableMask(XIL_EXCEPTION_IRQ)
 176
 177 #if !defined (__aarch64__) && !defined (ARMA53_32)
 178 /****************************************************************************/
 179 /**
 180 * @brief        Enable nested interrupts by clearing the I and F bits in CPSR. This
 181 *                       API is defined for cortex-a9 and cortex-r5.
 182 *
 183 * @return   None.
 184 *
 185 * @note     This macro is supposed to be used from interrupt handlers. In the
 186 *                       interrupt handler the interrupts are disabled by default (I and F
 187 *                       are 1). To allow nesting of interrupts, this macro should be
 188 *                       used. It clears the I and F bits by changing the ARM mode to
 189 *                       system mode. Once these bits are cleared and provided the
 190 *                       preemption of interrupt conditions are met in the GIC, nesting of
 191 *                       interrupts will start happening.
 192 *                       Caution: This macro must be used with caution. Before calling this
 193 *                       macro, the user must ensure that the source of the current IRQ
 194 *                       is appropriately cleared. Otherwise, as soon as we clear the I and
 195 *                       F bits, there can be an infinite loop of interrupts with an
 196 *                       eventual crash (all the stack space getting consumed).
 197 ******************************************************************************/
 198 #define Xil_EnableNestedInterrupts() \
 199                 __asm__ __volatile__ ("stmfd   sp!, {lr}"); \
 200                 __asm__ __volatile__ ("mrs     lr, spsr");  \
 201                 __asm__ __volatile__ ("stmfd   sp!, {lr}"); \
 202                 __asm__ __volatile__ ("msr     cpsr_c, #0x1F"); \
 203                 __asm__ __volatile__ ("stmfd   sp!, {lr}");
 204
 205 /****************************************************************************/
 206 /**
 207 * @brief        Disable the nested interrupts by setting the I and F bits. This API
 208 *                       is defined for cortex-a9 and cortex-r5.
 209 *
 210 * @return   None.
 211 *
 212 * @note     This macro is meant to be called in the interrupt service routines.
 213 *                       This macro cannot be used independently. It can only be used when
 214 *                       nesting of interrupts have been enabled by using the macro
 215 *                       Xil_EnableNestedInterrupts(). In a typical flow, the user first
 216 *                       calls the Xil_EnableNestedInterrupts in the ISR at the appropriate
 217 *                       point. The user then must call this macro before exiting the interrupt
 218 *                       service routine. This macro puts the ARM back in IRQ/FIQ mode and
 219 *                       hence sets back the I and F bits.
 220 ******************************************************************************/
 221 #define Xil_DisableNestedInterrupts() \
 222                 __asm__ __volatile__ ("ldmfd   sp!, {lr}");   \
 223                 __asm__ __volatile__ ("msr     cpsr_c, #0x92"); \
 224                 __asm__ __volatile__ ("ldmfd   sp!, {lr}"); \
 225                 __asm__ __volatile__ ("msr     spsr_cxsf, lr"); \
 226                 __asm__ __volatile__ ("ldmfd   sp!, {lr}"); \
 227
 228 #endif
 229 /************************** Variable Definitions ****************************/
 230
 231 /************************** Function Prototypes *****************************/
 232
 233 extern void Xil_ExceptionRegisterHandler(u32 Exception_id,
 234                                          Xil_ExceptionHandler Handler,
 235                                          void *Data);
 236
 237 extern void Xil_ExceptionRemoveHandler(u32 Exception_id);
 238
 239 extern void Xil_ExceptionInit(void);
 240 #if defined (__aarch64__)
 241 void Xil_SyncAbortHandler(void *CallBackRef);
 242 void Xil_SErrorAbortHandler(void *CallBackRef);
 243 #else
 244 extern void Xil_DataAbortHandler(void *CallBackRef);
 245 extern void Xil_PrefetchAbortHandler(void *CallBackRef);
 246 extern void Xil_UndefinedExceptionHandler(void *CallBackRef);
 247 #endif
 248
 249 #ifdef __cplusplus
 250 }
 251 #endif /* __cplusplus */
 252
 253 #endif /* XIL_EXCEPTION_H */
 254 /**
 255 * @} End of "addtogroup arm_exception_apis".
 256 */