RTEMS 6.1-rc1
Macros | Typedefs
Basic Data types for Xilinx® Software IP

Macros

#define XIL_TYPES_H   /* by using protection macros */
 
#define TRUE   1U
 
#define FALSE   0U
 
#define XIL_COMPONENT_IS_READY   0x11111111U
 
#define XIL_COMPONENT_IS_STARTED   0x22222222U
 
#define UPPER_32_BITS(n)   0U
 Returns 32-63 bits of a number. More...
 
#define LOWER_32_BITS(n)   ((u32)(n))
 Returns 0-31 bits of a number. More...
 

Typedefs

typedef uint8_t u8
 
typedef uint16_t u16
 
typedef uint32_t u32
 
typedef char char8
 
typedef int8_t s8
 
typedef int16_t s16
 
typedef int32_t s32
 
typedef int64_t s64
 
typedef uint64_t u64
 
typedef int sint32
 
typedef intptr_t INTPTR
 
typedef uintptr_t UINTPTR
 
typedef ptrdiff_t PTRDIFF
 
typedef void(* XInterruptHandler) (void *InstancePtr)
 
typedef void(* XExceptionHandler) (void *InstancePtr)
 

gpio Usage

#define NULL   0U
 Requests a GPIO pin group configuration. More...
 

Detailed Description

The xil_types.h file contains basic types for Xilinx software IP. These data types are applicable for all processors supported by Xilinx.

MODIFICATION HISTORY:

Ver   Who    Date   Changes
----- ---- -------- -------------------------------------------------------
1.00a hbm  07/14/09 First release
3.03a sdm  05/30/11 Added Xuint64 typedef and XUINT64_MSW/XUINT64_LSW macros
5.00    pkp  05/29/14 Made changes for 64 bit architecture
  srt  07/14/14 Use standard definitions from stdint.h and stddef.h
          Define LONG and ULONG datatypes and mask values
7.00  mus  01/07/19 Add cpp extern macro
7.1   aru  08/19/19 Shift the value in UPPER_32_BITS only if it
                    is 64-bit processor

Macro Definition Documentation

◆ LOWER_32_BITS

#define LOWER_32_BITS (   n)    ((u32)(n))

Returns 0-31 bits of a number.

Parameters
n: Number being accessed.
Returns
Bits 0-31 of number

◆ NULL

pins array is NULL   0U

Requests a GPIO pin group configuration.

Parameters
[in]group_definitionrtems_gpio_group_definition structure filled with the group pins configurations.
[out]groupReference to the created group.
Return values
RTEMS_SUCCESSFULPin group was configured successfully.
RTEMS_UNSATISFIEDthe
*
See also
rtems_gpio_release_pin().

◆ UPPER_32_BITS

#define UPPER_32_BITS (   n)    0U

Returns 32-63 bits of a number.

Parameters
n: Number being accessed.
Returns
Bits 32-63 of number.
Note
A basic shift-right of a 64- or 32-bit quantity. Use this to suppress the "right shift count >= width of type" warning when that quantity is 32-bits.

◆ XIL_COMPONENT_IS_READY

#define XIL_COMPONENT_IS_READY   0x11111111U

In device drivers, This macro will be assigend to "IsReady" member of driver instance to indicate that driver instance is initialized and ready to use.

◆ XIL_COMPONENT_IS_STARTED

#define XIL_COMPONENT_IS_STARTED   0x22222222U

In device drivers, This macro will be assigend to "IsStarted" member of driver instance to indicate that driver instance is started and it can be enabled.

Typedef Documentation

◆ XExceptionHandler

typedef void(* XExceptionHandler) (void *InstancePtr)

This data type defines an exception handler for a processor. The argument points to the instance of the component

◆ XInterruptHandler

typedef void(* XInterruptHandler) (void *InstancePtr)

This data type defines an interrupt handler for a device. The argument points to the instance of the component