xiltimer
Vitis Drivers API Documentation
xiltimer.h File Reference

Data Structures

struct  XTimerTag
 Structure to the XFpga instance. More...
 

Macros

#define XTIMER_MAJOR_VERSION   1U
 Library Major version info. More...
 
#define XTIMER_MINOR_VERSION   4U
 Library Minor version info. More...
 

Typedefs

typedef struct XTimerTag XTimer
 Structure to the XFpga instance. More...
 

Enumerations

enum  XTimer_DelayType { XTIMER_DELAY_SEC = 1, XTIMER_DELAY_MSEC = 1000, XTIMER_DELAY_USEC = 1000 * 1000 }
 This typedef contains different measures of time for the device. More...
 

Functions

u32 XilSleepTimer_Init (XTimer *InstancePtr)
 This API is used for initializing sleep timer. More...
 
u32 XilTickTimer_Init (XTimer *InstancePtr)
 This API is used for initializing Tick timer. More...
 
void XTime_GetTime (XTime *Xtime_Global)
 Get the time. More...
 
void XTimer_SetInterval (unsigned long delay)
 This API sets the elapse interval for the timer instance. More...
 
void XTimer_SetHandler (XTimer_TickHandler FuncPtr, void *CallBackRef, u8 Priority)
 This routine installs an asynchronous callback function for the given FuncPtr. More...
 
void XTimer_ClearTickInterrupt (void)
 This API clears the interrupt status of the tick timer instance. More...
 

Macro Definition Documentation

#define XTIMER_MAJOR_VERSION   1U

Library Major version info.

#define XTIMER_MINOR_VERSION   4U

Library Minor version info.

Typedef Documentation

typedef struct XTimerTag XTimer

Structure to the XFpga instance.

Parameters
XTimer_ModifyIntervalModifies the timer interval
XTimer_TickIntrHandlerTick interrupt handler
XTimer_TickIntervalConfigures the tick interval
XSleepTimer_StopStops the sleep timer
XTickTimer_StopStops the tick timer
XTickTimer_ClearInterruptClears the Tick timer interrupt status
HandlerTick Handler
CallBackRefCallback reference for handler
AxiTimer_SleepInstSleep Instance for AxiTimer
AxiTimer_TickInstTick Instance for AxiTimer
TtcPs_SleepInstSleep Instance for TTCPS
TtcPs_TickInstTick Instance for TTCPS
ScuTimer_SleepInstSleep Instance for Scutimer
ScuTimer_TickInstTick Instance for Scutimer

Enumeration Type Documentation

This typedef contains different measures of time for the device.

Enumerator
XTIMER_DELAY_SEC 

Time delay in seconds.

XTIMER_DELAY_MSEC 

Time delay in milliseconds.

XTIMER_DELAY_USEC 

Time delay in microseconds.

Function Documentation

u32 XilSleepTimer_Init ( XTimer InstancePtr)

This API is used for initializing sleep timer.

Referenced by __attribute__().

u32 XilTickTimer_Init ( XTimer InstancePtr)

This API is used for initializing Tick timer.

Referenced by __attribute__().

void XTime_GetTime ( XTime *  Xtime_Global)

Get the time.