xil_assert.c File Reference

#include "xil_types.h"
#include "xil_assert.h"

Functions
void	Xil_Assert (const char *File, int Line)
void	Xil_AssertSetCallback (Xil_AssertCallback Routine)
void	XNullHandler (void *NullParameter)
Variables
unsigned int	Xil_AssertStatus
int	Xil_AssertWait = TRUE

---

Detailed Description

This file contains basic assert related functions for Xilinx software IP.

 MODIFICATION HISTORY:

 Ver   Who    Date   Changes
 ----- ---- -------- -------------------------------------------------------
 1.00a hbm  07/14/09 Initial release
 

---

Function Documentation

void Xil_Assert (  const char *  File, int  Line )

Implement assert. Currently, it calls a user-defined callback function if one has been set. Then, it potentially enters an infinite loop depending on the value of the Xil_AssertWait variable. Parameters: file  is the name of the filename of the source line  is the linenumber within File Returns: None. Note: None.

void Xil_AssertSetCallback (  Xil_AssertCallback  Routine  )

Set up a callback function to be invoked when an assert occurs. If there was already a callback installed, then it is replaced. Parameters: routine  is the callback to be invoked when an assert is taken Returns: None. Note: This function has no effect if NDEBUG is set

void XNullHandler (  void *  NullParameter  )

Null handler function. This follows the XInterruptHandler signature for interrupt handlers. It can be used to assign a null handler (a stub) to an interrupt controller vector table. Parameters: NullParameter  is an arbitrary void pointer and not used. Returns: None. Note: None.

---

Variable Documentation

unsigned int Xil_AssertStatus

This variable allows testing to be done easier with asserts. An assert sets this variable such that a driver can evaluate this variable to determine if an assert occurred.

int Xil_AssertWait = TRUE

This variable allows the assert functionality to be changed for testing such that it does not wait infinitely. Use the debugger to disable the waiting during testing of asserts.

---