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 * @addtogroup common_assert_apis Assert APIs and Macros
39 * The xil_assert.h file contains assert related functions and macros.
40 * Assert APIs/Macros specifies that a application program satisfies certain
41 * conditions at particular points in its execution. These function can be
42 * used by application programs to ensure that, application code is satisfying
47 * MODIFICATION HISTORY:
49 * Ver Who Date Changes
50 * ----- ---- -------- -------------------------------------------------------
51 * 1.00a hbm 07/14/09 First release
52 * 6.0 kvn 05/31/16 Make Xil_AsserWait a global variable
55 ******************************************************************************/
57 #ifndef XIL_ASSERT_H /* prevent circular inclusions */
58 #define XIL_ASSERT_H /* by using protection macros */
60 #include "xil_types.h"
67 /***************************** Include Files *********************************/
70 /************************** Constant Definitions *****************************/
72 #define XIL_ASSERT_NONE 0U
73 #define XIL_ASSERT_OCCURRED 1U
76 extern u32 Xil_AssertStatus;
77 extern s32 Xil_AssertWait;
78 extern void Xil_Assert(const char8 *File, s32 Line);
79 void XNullHandler(void *NullParameter);
82 * This data type defines a callback to be invoked when an
83 * assert occurs. The callback is invoked only when asserts are enabled
85 typedef void (*Xil_AssertCallback) (const char8 *File, s32 Line);
87 /***************** Macros (Inline Functions) Definitions *********************/
91 /*****************************************************************************/
93 * @brief This assert macro is to be used for void functions. This in
94 * conjunction with the Xil_AssertWait boolean can be used to
95 * accomodate tests so that asserts which fail allow execution to
98 * @param Expression: expression to be evaluated. If it evaluates to
99 * false, the assert occurs.
101 * @return Returns void unless the Xil_AssertWait variable is true, in which
102 * case no return is made and an infinite loop is entered.
104 ******************************************************************************/
105 #define Xil_AssertVoid(Expression) \
108 Xil_AssertStatus = XIL_ASSERT_NONE; \
110 Xil_Assert(__FILE__, __LINE__); \
111 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
116 /*****************************************************************************/
118 * @brief This assert macro is to be used for functions that do return a
119 * value. This in conjunction with the Xil_AssertWait boolean can be
120 * used to accomodate tests so that asserts which fail allow execution
123 * @param Expression: expression to be evaluated. If it evaluates to false,
126 * @return Returns 0 unless the Xil_AssertWait variable is true, in which
127 * case no return is made and an infinite loop is entered.
129 ******************************************************************************/
130 #define Xil_AssertNonvoid(Expression) \
133 Xil_AssertStatus = XIL_ASSERT_NONE; \
135 Xil_Assert(__FILE__, __LINE__); \
136 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
141 /*****************************************************************************/
143 * @brief Always assert. This assert macro is to be used for void functions.
144 * Use for instances where an assert should always occur.
146 * @return Returns void unless the Xil_AssertWait variable is true, in which
147 * case no return is made and an infinite loop is entered.
149 ******************************************************************************/
150 #define Xil_AssertVoidAlways() \
152 Xil_Assert(__FILE__, __LINE__); \
153 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
157 /*****************************************************************************/
159 * @brief Always assert. This assert macro is to be used for functions that
160 * do return a value. Use for instances where an assert should always
163 * @return Returns void unless the Xil_AssertWait variable is true, in which
164 * case no return is made and an infinite loop is entered.
166 ******************************************************************************/
167 #define Xil_AssertNonvoidAlways() \
169 Xil_Assert(__FILE__, __LINE__); \
170 Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
177 #define Xil_AssertVoid(Expression)
178 #define Xil_AssertVoidAlways()
179 #define Xil_AssertNonvoid(Expression)
180 #define Xil_AssertNonvoidAlways()
184 /************************** Function Prototypes ******************************/
186 void Xil_AssertSetCallback(Xil_AssertCallback Routine);
192 #endif /* end of protection macro */
194 * @} End of "addtogroup common_assert_apis".