196 lines
7.4 KiB
C
Executable File
196 lines
7.4 KiB
C
Executable File
/******************************************************************************
|
|
*
|
|
* (c) Copyright 2009 Xilinx, Inc. All rights reserved.
|
|
*
|
|
* This file contains confidential and proprietary information of Xilinx, Inc.
|
|
* and is protected under U.S. and international copyright and other
|
|
* intellectual property laws.
|
|
*
|
|
* DISCLAIMER
|
|
* This disclaimer is not a license and does not grant any rights to the
|
|
* materials distributed herewith. Except as otherwise provided in a valid
|
|
* license issued to you by Xilinx, and to the maximum extent permitted by
|
|
* applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND WITH ALL
|
|
* FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS,
|
|
* IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
|
|
* MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE;
|
|
* and (2) Xilinx shall not be liable (whether in contract or tort, including
|
|
* negligence, or under any other theory of liability) for any loss or damage
|
|
* of any kind or nature related to, arising under or in connection with these
|
|
* materials, including for any direct, or any indirect, special, incidental,
|
|
* or consequential loss or damage (including loss of data, profits, goodwill,
|
|
* or any type of loss or damage suffered as a result of any action brought by
|
|
* a third party) even if such damage or loss was reasonably foreseeable or
|
|
* Xilinx had been advised of the possibility of the same.
|
|
*
|
|
* CRITICAL APPLICATIONS
|
|
* Xilinx products are not designed or intended to be fail-safe, or for use in
|
|
* any application requiring fail-safe performance, such as life-support or
|
|
* safety devices or systems, Class III medical devices, nuclear facilities,
|
|
* applications related to the deployment of airbags, or any other applications
|
|
* that could lead to death, personal injury, or severe property or
|
|
* environmental damage (individually and collectively, "Critical
|
|
* Applications"). Customer assumes the sole risk and liability of any use of
|
|
* Xilinx products in Critical Applications, subject only to applicable laws
|
|
* and regulations governing limitations on product liability.
|
|
*
|
|
* THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE
|
|
* AT ALL TIMES.
|
|
*
|
|
******************************************************************************/
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* @file xil_assert.h
|
|
*
|
|
* This file contains assert related functions.
|
|
*
|
|
* <pre>
|
|
* MODIFICATION HISTORY:
|
|
*
|
|
* Ver Who Date Changes
|
|
* ----- ---- -------- -------------------------------------------------------
|
|
* 1.00a hbm 07/14/09 First release
|
|
* </pre>
|
|
*
|
|
******************************************************************************/
|
|
|
|
#ifndef XIL_ASSERT_H /* prevent circular inclusions */
|
|
#define XIL_ASSERT_H /* by using protection macros */
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/***************************** Include Files *********************************/
|
|
|
|
|
|
/************************** Constant Definitions *****************************/
|
|
|
|
#define XIL_ASSERT_NONE 0
|
|
#define XIL_ASSERT_OCCURRED 1
|
|
|
|
extern unsigned int Xil_AssertStatus;
|
|
extern void Xil_Assert(const char *, int);
|
|
|
|
|
|
/**
|
|
* This data type defines a callback to be invoked when an
|
|
* assert occurs. The callback is invoked only when asserts are enabled
|
|
*/
|
|
typedef void (*Xil_AssertCallback) (const char *File, int Line);
|
|
|
|
/***************** Macros (Inline Functions) Definitions *********************/
|
|
|
|
#ifndef NDEBUG
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
* This assert macro is to be used for functions that do not return anything
|
|
* (void). This in conjunction with the Xil_AssertWait boolean can be used to
|
|
* accomodate tests so that asserts which fail allow execution to continue.
|
|
*
|
|
* @param expression is the expression to evaluate. If it evaluates to
|
|
* false, the assert occurs.
|
|
*
|
|
* @return Returns void unless the Xil_AssertWait variable is true, in which
|
|
* case no return is made and an infinite loop is entered.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_AssertVoid(Expression) \
|
|
{ \
|
|
if (Expression) { \
|
|
Xil_AssertStatus = XIL_ASSERT_NONE; \
|
|
} else { \
|
|
Xil_Assert(__FILE__, __LINE__); \
|
|
Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
|
|
return; \
|
|
} \
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
* This assert macro is to be used for functions that do return a value. This in
|
|
* conjunction with the Xil_AssertWait boolean can be used to accomodate tests
|
|
* so that asserts which fail allow execution to continue.
|
|
*
|
|
* @param expression is the expression to evaluate. If it evaluates to false,
|
|
* the assert occurs.
|
|
*
|
|
* @return Returns 0 unless the Xil_AssertWait variable is true, in which
|
|
* case no return is made and an infinite loop is entered.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_AssertNonvoid(Expression) \
|
|
{ \
|
|
if (Expression) { \
|
|
Xil_AssertStatus = XIL_ASSERT_NONE; \
|
|
} else { \
|
|
Xil_Assert(__FILE__, __LINE__); \
|
|
Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
|
|
return 0; \
|
|
} \
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
* Always assert. This assert macro is to be used for functions that do not
|
|
* return anything (void). Use for instances where an assert should always
|
|
* occur.
|
|
*
|
|
* @return Returns void unless the Xil_AssertWait variable is true, in which
|
|
* case no return is made and an infinite loop is entered.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_AssertVoidAlways() \
|
|
{ \
|
|
Xil_Assert(__FILE__, __LINE__); \
|
|
Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
|
|
return; \
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
* Always assert. This assert macro is to be used for functions that do return
|
|
* a value. Use for instances where an assert should always occur.
|
|
*
|
|
* @return Returns void unless the Xil_AssertWait variable is true, in which
|
|
* case no return is made and an infinite loop is entered.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_AssertNonvoidAlways() \
|
|
{ \
|
|
Xil_Assert(__FILE__, __LINE__); \
|
|
Xil_AssertStatus = XIL_ASSERT_OCCURRED; \
|
|
return 0; \
|
|
}
|
|
|
|
|
|
#else
|
|
|
|
#define Xil_AssertVoid(Expression)
|
|
#define Xil_AssertVoidAlways()
|
|
#define Xil_AssertNonvoid(Expression)
|
|
#define Xil_AssertNonvoidAlways()
|
|
|
|
#endif
|
|
|
|
/************************** Function Prototypes ******************************/
|
|
|
|
void Xil_AssertSetCallback(Xil_AssertCallback Routine);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* end of protection macro */
|