XTimerTag - 2022.2 English

Xilinx Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2022-10-19
Version
2022.2 English

This is the library instance data structure. A pointer to an instance data structure is passed around by functions. 

Declaration

typedef struct
{
void(* XTimer_ModifyInterval)(struct XTimerTag *InstancePtr, u32 delay, XTimer_DelayType Delaytype),
void(* XTimer_TickIntrHandler)(struct XTimerTag *InstancePtr, u8 Priority),
void(* XTimer_TickInterval)(struct XTimerTag *InstancePtr, u32 Delay),
void(* XSleepTimer_Stop)(struct XTimerTag *InstancePtr),
void(* XTickTimer_Stop)(struct XTimerTag *InstancePtr),
void(* XTickTimer_ClearInterrupt)(struct XTimerTag *InstancePtr),
XTimer_TickHandler Handler,
void * CallBackRef,
XTmrCtr AxiTimer_SleepInst,
XTmrCtr AxiTimer_TickInst,
XTtcPs TtcPs_SleepInst,
XTtcPs TtcPs_TickInst,
XScuTimer ScuTimer_SleepInst,
XScuTimer ScuTimer_TickInst
} XTimerTag;
Table 1. Structure XTimerTag Member Description
Member Description
XTimer_ModifyInterval XTimer_ModifyInterval Modifies the timer interval 
XTimer_TickIntrHandler XTimer_TickIntrHandler Tick interrupt handler 
XTimer_TickInterval XTimer_TickInterval Configures the tick interval 
XSleepTimer_Stop Stops the sleep timer 
XTickTimer_Stop Stops the tick timer 
XTickTimer_ClearInterrupt XTickTimer_ClearInterrupt Clears the Tick timer interrupt status 
Handler Callback function

Sets the Tick Interrupt Handler 

CallBackRef Callback reference for handler

CallBackRef is Callback reference for handler

AxiTimer_SleepInst Sleep Instance for AxiTimer 
AxiTimer_TickInst Tick Instance for AxiTimer 
TtcPs_SleepInst Sleep Instance for TTCPS 
TtcPs_TickInst Tick Instance for TTCPS 
ScuTimer_SleepInst Sleep Instance for Scutimer 
ScuTimer_TickInst Tick Instance for Scutimer