scutimer: xscutimer.h File Reference

| scutimer Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Data Structures | Macros | Functions
xscutimer.h File Reference

## Data Structures
struct | XScuTimer_Config
| This typedef contains configuration information for the device. More...
struct | XScuTimer
| The XScuTimer driver instance data. More...

## Macros
#define | XScuTimer_IsExpired(InstancePtr)
| Check if the timer has expired. More...
#define | XScuTimer_RestartTimer(InstancePtr)
| Re-start the timer. More...
#define | XScuTimer_LoadTimer(InstancePtr, Value)
| Write to the timer load register. More...
#define | XScuTimer_GetCounterValue(InstancePtr)
| Returns the current timer counter register value. More...
#define | XScuTimer_EnableAutoReload(InstancePtr)
| Enable auto-reload mode. More...
#define | XScuTimer_DisableAutoReload(InstancePtr)
| Disable auto-reload mode. More...
#define | XScuTimer_EnableInterrupt(InstancePtr)
| Enable the Timer interrupt. More...
#define | XScuTimer_DisableInterrupt(InstancePtr)
| Disable the Timer interrupt. More...
#define | XScuTimer_GetInterruptStatus(InstancePtr)
| This function reads the interrupt status. More...
#define | XScuTimer_ClearInterruptStatus(InstancePtr)
| This function clears the interrupt status. More...

## Functions
XScuTimer_Config * | XScuTimer_LookupConfig (u16 DeviceId)
| Lookup the device configuration based on the unique device ID. More...
s32 | XScuTimer_SelfTest (XScuTimer *InstancePtr)
| Run a self-test on the timer. More...
s32 | XScuTimer_CfgInitialize (XScuTimer *InstancePtr, XScuTimer_Config *ConfigPtr, u32 EffectiveAddress)
| Initialize a specific timer instance/driver. More...
void | XScuTimer_Start (XScuTimer *InstancePtr)
| Start the timer. More...
void | XScuTimer_Stop (XScuTimer *InstancePtr)
| Stop the timer. More...
void | XScuTimer_SetPrescaler (XScuTimer *InstancePtr, u8 PrescalerValue)
| This function sets the prescaler bits in the timer control register. More...
u8 | XScuTimer_GetPrescaler (XScuTimer *InstancePtr)
| This function returns the current prescaler value. More...