git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 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 A53 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  05/29/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_SYNC_INT               1U
  71 #define XIL_EXCEPTION_ID_IRQ_INT                2U
  72 #define XIL_EXCEPTION_ID_FIQ_INT                3U
  73 #define XIL_EXCEPTION_ID_SERROR_ABORT_INT               4U
  74 #define XIL_EXCEPTION_ID_LAST                   5U
  75
  76 /*
  77  * XIL_EXCEPTION_ID_INT is defined for all Xilinx processors.
  78  */
  79 #define XIL_EXCEPTION_ID_INT    XIL_EXCEPTION_ID_IRQ_INT
  80
  81 /**************************** Type Definitions ******************************/
  82
  83 /**
  84  * This typedef is the exception handler function.
  85  */
  86 typedef void (*Xil_ExceptionHandler)(void *data);
  87 typedef void (*Xil_InterruptHandler)(void *data);
  88
  89 /***************** Macros (Inline Functions) Definitions ********************/
  90
  91 /****************************************************************************/
  92 /**
  93 * Enable Exceptions.
  94 *
  95 * @param        Mask for exceptions to be enabled.
  96 *
  97 * @return       None.
  98 *
  99 * @note         If bit is 0, exception is enabled.
 100 *               C-Style signature: void Xil_ExceptionEnableMask(Mask)
 101 *
 102 ******************************************************************************/
 103
 104 #define Xil_ExceptionEnableMask(Mask)   \
 105                 mtcpsr(mfcpsr() & ~ ((Mask) & XIL_EXCEPTION_ALL))
 106
 107 /****************************************************************************/
 108 /**
 109 * Enable the IRQ exception.
 110 *
 111 * @return   None.
 112 *
 113 * @note     None.
 114 *
 115 ******************************************************************************/
 116 #define Xil_ExceptionEnable() \
 117                 Xil_ExceptionEnableMask(XIL_EXCEPTION_IRQ)
 118
 119 /****************************************************************************/
 120 /**
 121 * Disable Exceptions.
 122 *
 123 * @param        Mask for exceptions to be enabled.
 124 *
 125 * @return       None.
 126 *
 127 * @note         If bit is 1, exception is disabled.
 128 *               C-Style signature: Xil_ExceptionDisableMask(Mask)
 129 *
 130 ******************************************************************************/
 131
 132 #define Xil_ExceptionDisableMask(Mask)  \
 133                 mtcpsr(mfcpsr() | ((Mask) & XIL_EXCEPTION_ALL))
 134
 135 /****************************************************************************/
 136 /**
 137 * Disable the IRQ exception.
 138 *
 139 * @return   None.
 140 *
 141 * @note     None.
 142 *
 143 ******************************************************************************/
 144 #define Xil_ExceptionDisable() \
 145                 Xil_ExceptionDisableMask(XIL_EXCEPTION_IRQ)
 146
 147
 148 /************************** Variable Definitions ****************************/
 149
 150 /************************** Function Prototypes *****************************/
 151
 152 extern void Xil_ExceptionRegisterHandler(u32 Exception_id,
 153                                          Xil_ExceptionHandler Handler,
 154                                          void *Data);
 155
 156 extern void Xil_ExceptionRemoveHandler(u32 Exception_id);
 157
 158 extern void Xil_ExceptionInit(void);
 159
 160 void Xil_SyncAbortHandler(void *CallBackRef);
 161
 162 void Xil_SErrorAbortHandler(void *CallBackRef);
 163
 164 #ifdef __cplusplus
 165 }
 166 #endif /* __cplusplus */
 167
 168 #endif /* XIL_EXCEPTION_H */