git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * (c) Copyright 2009 Xilinx, Inc. All rights reserved.
   4 *
   5 * This file contains confidential and proprietary information of Xilinx, Inc.
   6 * and is protected under U.S. and international copyright and other
   7 * intellectual property laws.
   8 *
   9 * DISCLAIMER
  10 * This disclaimer is not a license and does not grant any rights to the
  11 * materials distributed herewith. Except as otherwise provided in a valid
  12 * license issued to you by Xilinx, and to the maximum extent permitted by
  13 * applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND WITH ALL
  14 * FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS,
  15 * IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
  16 * MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE;
  17 * and (2) Xilinx shall not be liable (whether in contract or tort, including
  18 * negligence, or under any other theory of liability) for any loss or damage
  19 * of any kind or nature related to, arising under or in connection with these
  20 * materials, including for any direct, or any indirect, special, incidental,
  21 * or consequential loss or damage (including loss of data, profits, goodwill,
  22 * or any type of loss or damage suffered as a result of any action brought by
  23 * a third party) even if such damage or loss was reasonably foreseeable or
  24 * Xilinx had been advised of the possibility of the same.
  25 *
  26 * CRITICAL APPLICATIONS
  27 * Xilinx products are not designed or intended to be fail-safe, or for use in
  28 * any application requiring fail-safe performance, such as life-support or
  29 * safety devices or systems, Class III medical devices, nuclear facilities,
  30 * applications related to the deployment of airbags, or any other applications
  31 * that could lead to death, personal injury, or severe property or
  32 * environmental damage (individually and collectively, "Critical
  33 * Applications"). Customer assumes the sole risk and liability of any use of
  34 * Xilinx products in Critical Applications, subject only to applicable laws
  35 * and regulations governing limitations on product liability.
  36 *
  37 * THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE
  38 * AT ALL TIMES.
  39 *
  40 ******************************************************************************/
  41 /*****************************************************************************/
  42 /**
  43 *
  44 * @file xil_assert.h
  45 *
  46 * This file contains assert related functions.
  47 *
  48 * <pre>
  49 * MODIFICATION HISTORY:
  50 *
  51 * Ver   Who    Date   Changes
  52 * ----- ---- -------- -------------------------------------------------------
  53 * 1.00a hbm  07/14/09 First release
  54 * </pre>
  55 *
  56 ******************************************************************************/
  57
  58 #ifndef XIL_ASSERT_H    /* prevent circular inclusions */
  59 #define XIL_ASSERT_H    /* by using protection macros */
  60
  61 #ifdef __cplusplus
  62 extern "C" {
  63 #endif
  64
  65
  66 /***************************** Include Files *********************************/
  67
  68
  69 /************************** Constant Definitions *****************************/
  70
  71 #define XIL_ASSERT_NONE     0
  72 #define XIL_ASSERT_OCCURRED 1
  73 #define XNULL NULL
  74
  75 extern unsigned int Xil_AssertStatus;
  76 extern void Xil_Assert(const char *, int);
  77 void XNullHandler(void *NullParameter);
  78
  79 /**
  80  * This data type defines a callback to be invoked when an
  81  * assert occurs. The callback is invoked only when asserts are enabled
  82  */
  83 typedef void (*Xil_AssertCallback) (const char *File, int Line);
  84
  85 /***************** Macros (Inline Functions) Definitions *********************/
  86
  87 #ifndef NDEBUG
  88
  89 /*****************************************************************************/
  90 /**
  91 * This assert macro is to be used for functions that do not return anything
  92 * (void). This in conjunction with the Xil_AssertWait boolean can be used to
  93 * accomodate tests so that asserts which fail allow execution to continue.
  94 *
  95 * @param    expression is the expression to evaluate. If it evaluates to
  96 *           false, the assert occurs.
  97 *
  98 * @return   Returns void unless the Xil_AssertWait variable is true, in which
  99 *           case no return is made and an infinite loop is entered.
 100 *
 101 * @note     None.
 102 *
 103 ******************************************************************************/
 104 #define Xil_AssertVoid(Expression)                \
 105 {                                                  \
 106     if (Expression) {                              \
 107         Xil_AssertStatus = XIL_ASSERT_NONE;       \
 108     } else {                                       \
 109         Xil_Assert(__FILE__, __LINE__);            \
 110         Xil_AssertStatus = XIL_ASSERT_OCCURRED;   \
 111         return;                                    \
 112     }                                              \
 113 }
 114
 115 /*****************************************************************************/
 116 /**
 117 * This assert macro is to be used for functions that do return a value. This in
 118 * conjunction with the Xil_AssertWait boolean can be used to accomodate tests
 119 * so that asserts which fail allow execution to continue.
 120 *
 121 * @param    expression is the expression to evaluate. If it evaluates to false,
 122 *           the assert occurs.
 123 *
 124 * @return   Returns 0 unless the Xil_AssertWait variable is true, in which
 125 *           case no return is made and an infinite loop is entered.
 126 *
 127 * @note     None.
 128 *
 129 ******************************************************************************/
 130 #define Xil_AssertNonvoid(Expression)             \
 131 {                                                  \
 132     if (Expression) {                              \
 133         Xil_AssertStatus = XIL_ASSERT_NONE;       \
 134     } else {                                       \
 135         Xil_Assert(__FILE__, __LINE__);            \
 136         Xil_AssertStatus = XIL_ASSERT_OCCURRED;   \
 137         return 0;                                  \
 138     }                                              \
 139 }
 140
 141 /*****************************************************************************/
 142 /**
 143 * Always assert. This assert macro is to be used for functions that do not
 144 * return anything (void). Use for instances where an assert should always
 145 * occur.
 146 *
 147 * @return Returns void unless the Xil_AssertWait variable is true, in which
 148 *         case no return is made and an infinite loop is entered.
 149 *
 150 * @note   None.
 151 *
 152 ******************************************************************************/
 153 #define Xil_AssertVoidAlways()                   \
 154 {                                                  \
 155    Xil_Assert(__FILE__, __LINE__);                 \
 156    Xil_AssertStatus = XIL_ASSERT_OCCURRED;        \
 157    return;                                         \
 158 }
 159
 160 /*****************************************************************************/
 161 /**
 162 * Always assert. This assert macro is to be used for functions that do return
 163 * a value. Use for instances where an assert should always occur.
 164 *
 165 * @return Returns void unless the Xil_AssertWait variable is true, in which
 166 *         case no return is made and an infinite loop is entered.
 167 *
 168 * @note   None.
 169 *
 170 ******************************************************************************/
 171 #define Xil_AssertNonvoidAlways()                \
 172 {                                                  \
 173    Xil_Assert(__FILE__, __LINE__);                 \
 174    Xil_AssertStatus = XIL_ASSERT_OCCURRED;        \
 175    return 0;                                       \
 176 }
 177
 178
 179 #else
 180
 181 #define Xil_AssertVoid(Expression)
 182 #define Xil_AssertVoidAlways()
 183 #define Xil_AssertNonvoid(Expression)
 184 #define Xil_AssertNonvoidAlways()
 185
 186 #endif
 187
 188 /************************** Function Prototypes ******************************/
 189
 190 void Xil_AssertSetCallback(Xil_AssertCallback Routine);
 191
 192 #ifdef __cplusplus
 193 }
 194 #endif
 195
 196 #endif  /* end of protection macro */