1 /******************************************************************************
3 * Copyright (C) 2009 - 2016 Xilinx, Inc. All rights reserved.
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
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
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.
31 ******************************************************************************/
32 /*****************************************************************************/
37 * This file contains assert related functions.
40 * MODIFICATION HISTORY:
42 * Ver Who Date Changes
43 * ----- ---- -------- -------------------------------------------------------
44 * 1.00a hbm 07/14/09 First release
45 * 6.0 kvn 05/31/16 Make Xil_AsserWait a global variable
48 ******************************************************************************/
50 #ifndef XIL_ASSERT_H /* prevent circular inclusions */
51 #define XIL_ASSERT_H /* by using protection macros */
53 #include "xil_types.h"
60 /***************************** Include Files *********************************/
63 /************************** Constant Definitions *****************************/
65 #define XIL_ASSERT_NONE 0U
66 #define XIL_ASSERT_OCCURRED 1U
69 extern u32 Xil_AssertStatus;
70 extern s32 Xil_AssertWait;
71 extern void Xil_Assert(const char8 *File, s32 Line);
72 void XNullHandler(void *NullParameter);
75 * This data type defines a callback to be invoked when an
76 * assert occurs. The callback is invoked only when asserts are enabled
78 typedef void (*Xil_AssertCallback) (const char8 *File, s32 Line);
80 /***************** Macros (Inline Functions) Definitions *********************/
84 /*****************************************************************************/
86 * This assert macro is to be used for functions that do not return anything
87 * (void). This in conjunction with the Xil_AssertWait boolean can be used to
88 * accomodate tests so that asserts which fail allow execution to continue.
90 * @param Expression is the expression to evaluate. If it evaluates to
91 * false, the assert occurs.
93 * @return Returns void unless the Xil_AssertWait variable is true, in which
94 * case no return is made and an infinite loop is entered.
98 ******************************************************************************/
99 #define Xil_AssertVoid(Expression) \
102 Xil_AssertStatus = XIL_ASSERT_NONE; \
104 Xil_Assert(__FILE__, __LINE__); \
105 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
110 /*****************************************************************************/
112 * This assert macro is to be used for functions that do return a value. This in
113 * conjunction with the Xil_AssertWait boolean can be used to accomodate tests
114 * so that asserts which fail allow execution to continue.
116 * @param Expression is the expression to evaluate. If it evaluates to false,
119 * @return Returns 0 unless the Xil_AssertWait variable is true, in which
120 * case no return is made and an infinite loop is entered.
124 ******************************************************************************/
125 #define Xil_AssertNonvoid(Expression) \
128 Xil_AssertStatus = XIL_ASSERT_NONE; \
130 Xil_Assert(__FILE__, __LINE__); \
131 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
136 /*****************************************************************************/
138 * Always assert. This assert macro is to be used for functions that do not
139 * return anything (void). Use for instances where an assert should always
142 * @return Returns void unless the Xil_AssertWait variable is true, in which
143 * case no return is made and an infinite loop is entered.
147 ******************************************************************************/
148 #define Xil_AssertVoidAlways() \
150 Xil_Assert(__FILE__, __LINE__); \
151 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
155 /*****************************************************************************/
157 * Always assert. This assert macro is to be used for functions that do return
158 * a value. Use for instances where an assert should always occur.
160 * @return Returns void unless the Xil_AssertWait variable is true, in which
161 * case no return is made and an infinite loop is entered.
165 ******************************************************************************/
166 #define Xil_AssertNonvoidAlways() \
168 Xil_Assert(__FILE__, __LINE__); \
169 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
176 #define Xil_AssertVoid(Expression)
177 #define Xil_AssertVoidAlways()
178 #define Xil_AssertNonvoid(Expression)
179 #define Xil_AssertNonvoidAlways()
183 /************************** Function Prototypes ******************************/
185 void Xil_AssertSetCallback(Xil_AssertCallback Routine);
191 #endif /* end of protection macro */