tmrctr
Xilinx SDK Drivers API Documentation
xtmrctr_intr_64bit_example.c File Reference

Overview

This file contains a design example using the timer counter driver (XTmCtr) and hardware device using interrupt mode with the counters configured in cascasde mode for a 64 bit operation.

Both the timers should enabled in HW configuration for the cascade mode of operation.

The cascade mode of operation is present in the new versions of the axi_timer IP. Please check the HW Datasheet to see whether this feature is present in the version of the IP that you are using.

This example assumes that the interrupt controller is also present as a part of the system.

  MODIFICATION HISTORY:
  Ver   Who  Date        Changes

2.04a sdm 07/15/11 Created based on the xtmrctr_intr_example 4.2 ms 01/23/17 Added xil_printf statement in main function to ensure that "Successfully ran" and "Failed" strings are available in all examples. This is a fix for CR-965028.
*

Functions

int TmrCtrCascadeIntrExample (XIntc *IntcInstancePtr, XTmrCtr *TmrCtrInstancePtr, u16 DeviceId, u16 IntrId)
 This function does a minimal test on the timer counter device and driver as a design example. More...
 
void TimerCounterHandler (void *CallBackRef, u8 TmrCtrNumber)
 This function is the handler which performs processing for the timer counter. More...
 
void TmrCtrDisableIntr (XIntc *IntcInstancePtr, u16 IntrId)
 This function disables the interrupts for the Timer. More...
 
int main (void)
 This function is the main function of the Tmrctr 64 bit example using Interrupts. More...
 

Function Documentation

◆ main()

int main ( void  )

This function is the main function of the Tmrctr 64 bit example using Interrupts.

Parameters
None.
Returns
    - XST_SUCCESS to indicate success
    - XST_FAILURE to indicate a failure.
Note
None.

References TmrCtrCascadeIntrExample().

◆ TimerCounterHandler()

void TimerCounterHandler ( void *  CallBackRef,
u8  TmrCtrNumber 
)

This function is the handler which performs processing for the timer counter.

It is called from an interrupt context such that the amount of processing performed should be minimized. It is called when the timer counter expires if interrupts are enabled.

This handler provides an example of how to handle timer counter interrupts but is application specific.

Parameters
CallBackRefis a pointer to the callback function
TmrCtrNumberis the number of the timer to which this handler is associated with.
Returns
None.
Note
None.

References XTmrCtr_IsExpired().

◆ TmrCtrCascadeIntrExample()

int TmrCtrCascadeIntrExample ( XIntc *  IntcInstancePtr,
XTmrCtr TmrCtrInstancePtr,
u16  DeviceId,
u16  IntrId 
)

This function does a minimal test on the timer counter device and driver as a design example.

The purpose of this function is to illustrate how to use the XTmrCtr driver in cascade mode of operation. It initializes a timer counter and then sets it up in compare mode with auto reload such that a periodic interrupt is generated.

This function uses interrupt driven mode of the timer counter.

Parameters
IntcInstancePtris a pointer to the Interrupt Controller driver Instance
TmrCtrInstancePtris a pointer to the XTmrCtr driver Instance
DeviceIdis the XPAR_<TmrCtr_instance>_DEVICE_ID value from xparameters.h
IntrIdis XPAR_<INTC_instance>_<TmrCtr_instance>_VEC_ID value from xparameters.h
Returns
  • XST_SUCCESS if the Test is successful.
  • XST_FAILURE if the Test is Not Successful.
Note
This function contains an infinite loop such that if interrupts are not working it may never return.

References XTmrCtr_Initialize(), and XTmrCtr_SelfTest().

Referenced by main().

◆ TmrCtrDisableIntr()

void TmrCtrDisableIntr ( XIntc *  IntcInstancePtr,
u16  IntrId 
)

This function disables the interrupts for the Timer.

Parameters
IntcInstancePtris a reference to the Interrupt Controller driver Instance.
IntrIdis XPAR_<INTC_instance>_<Timer_instance>_VEC_ID value from xparameters.h.
Returns
None.
Note
None.