scutimer
Vitis Drivers API Documentation
xscutimer_hw.h File Reference

Macros

#define XScuTimer_SetLoadReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_LOAD_OFFSET, (Value))
 Write to the timer load register. More...
 
#define XScuTimer_GetLoadReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_LOAD_OFFSET)
 Returns the current timer load register value. More...
 
#define XScuTimer_SetCounterReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET, (Value))
 Write to the timer counter register. More...
 
#define XScuTimer_GetCounterReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_COUNTER_OFFSET)
 Returns the current timer counter register value. More...
 
#define XScuTimer_SetControlReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET, (Value))
 Write to the timer load register. More...
 
#define XScuTimer_GetControlReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_CONTROL_OFFSET)
 Returns the current timer load register value. More...
 
#define XScuTimer_SetIntrReg(BaseAddr, Value)   XScuTimer_WriteReg(BaseAddr, XSCUTIMER_ISR_OFFSET, (Value))
 Write to the timer counter register. More...
 
#define XScuTimer_GetIntrReg(BaseAddr)   XScuTimer_ReadReg(BaseAddr, XSCUTIMER_ISR_OFFSET)
 Returns the current timer counter register value. More...
 
#define XScuTimer_ReadReg(BaseAddr, RegOffset)   Xil_In32((BaseAddr) + (RegOffset))
 Read from the given Timer register. More...
 
#define XScuTimer_WriteReg(BaseAddr, RegOffset, Data)   Xil_Out32((BaseAddr) + (RegOffset), (Data))
 Write to the given Timer register. More...
 
Register Map

Offsets of registers from the start of the device

#define XSCUTIMER_LOAD_OFFSET   0x00U
 Timer Load Register. More...
 
#define XSCUTIMER_COUNTER_OFFSET   0x04U
 Timer Counter Register. More...
 
#define XSCUTIMER_CONTROL_OFFSET   0x08U
 Timer Control Register. More...
 
#define XSCUTIMER_ISR_OFFSET   0x0CU
 Timer Interrupt Status Register. More...
 
Timer Control register

This register bits control the prescaler, Intr enable, auto-reload and timer enable.

#define XSCUTIMER_CONTROL_PRESCALER_MASK   0x0000FF00U
 Prescaler. More...
 
#define XSCUTIMER_CONTROL_PRESCALER_SHIFT   8U
 
#define XSCUTIMER_CONTROL_IRQ_ENABLE_MASK   0x00000004U
 Intr enable. More...
 
#define XSCUTIMER_CONTROL_AUTO_RELOAD_MASK   0x00000002U
 Auto-reload. More...
 
#define XSCUTIMER_CONTROL_ENABLE_MASK   0x00000001U
 Timer enable. More...
 
Interrupt Status register

This register indicates the Timer counter register has reached zero.

#define XSCUTIMER_ISR_EVENT_FLAG_MASK   0x00000001U
 Event flag. More...