| common Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

Macros | Typedefs | Functions | Variables
xbasic_types.h File Reference

## Macros
#define | XNULL NULL
| Xilinx NULL, TRUE and FALSE legacy support. More...
#define | XCOMPONENT_IS_READY 0x11111111
| component has been initialized More...
#define | XCOMPONENT_IS_STARTED 0x22222222
| component has been started More...
#define | XUINT64_MSW(x) ((x).Upper)
| Return the most significant half of the 64 bit data type. More...
#define | XUINT64_LSW(x) ((x).Lower)
| Return the least significant half of the 64 bit data type. More...
#define | XASSERT_VOID(expression)
| This assert macro is to be used for functions that do not return anything (void). More...
#define | XASSERT_NONVOID(expression)
| This assert macro is to be used for functions that do return a value. More...
#define | XASSERT_VOID_ALWAYS()
| Always assert. More...
#define | XASSERT_NONVOID_ALWAYS()
| Always assert. More...

## Typedefs
typedef void(* | XInterruptHandler )(void *InstancePtr)
| This data type defines an interrupt handler for a device. More...
typedef void(* | XExceptionHandler )(void *InstancePtr)
| This data type defines an exception handler for a processor. More...
typedef void(* | XAssertCallback )(char *FilenamePtr, int LineNumber)
| This data type defines a callback to be invoked when an assert occurs. More...
Legacy types
Deprecated legacy types.
typedef unsigned char | Xuint8
| unsigned 8-bit More...
typedef char | Xint8
| signed 8-bit More...
typedef unsigned short | Xuint16
| unsigned 16-bit More...
typedef short | Xint16
| signed 16-bit More...
typedef unsigned long | Xuint32
| unsigned 32-bit More...
typedef long | Xint32
| signed 32-bit More...
typedef float | Xfloat32
| 32-bit floating point More...
typedef double | Xfloat64
| 64-bit double precision FP More...
typedef unsigned long | Xboolean
| boolean (XTRUE or XFALSE) More...
New types
New simple types.
typedef Xuint32 | u32
typedef Xuint16 | u16
typedef Xuint8 | u8

## Functions
void | XAssert (char *File, int Line)
| Implements assert. More...
void | XAssertSetCallback (XAssertCallback Routine)
| Sets up a callback function to be invoked when an assert occurs. More...
void | XNullHandler (void *NullParameter)
| Null handler function. More...

## Variables
unsigned int | XAssertStatus
| This variable allows testing to be done easier with asserts. More...