AXI TIMER Standalone Driver

Introduction

This page gives an overview of tmrctr driver which is available as part of the Xilinx Vivado and SDK distribution.

Driver Sources

The source code for the driver is included with the Vitis Unified Software Platform installation, as well as being available in the Xilinx Github repository. 

Driver Name

Path in Vitis

Path in Github

tmrctr

<Vitis Install Directory>/data/embedded/XilinxProcessorIPLib/drivers/tmrctr

https://github.com/Xilinx/embeddedsw/tree/master/XilinxProcessorIPLib/drivers/tmrctr

Note: To view the sources for a particular release, use the rel-version tag in github.  For example, for the 2020.1 release, the proper version of the code is: https://github.com/Xilinx/embeddedsw/tree/release-2020.1/XilinxProcessorIPLib/drivers/tmrctr

The driver source code is organized into different folders.  The table below shows the tmrctr driver source organization. 

Directory
Description

doc

Provides the API and data structure details

data

Driver .tcl and .mdd file

examples

Example applications that show how to use the driver features

src

Driver source files

Driver Implementation


For a full list of features supported by this IP, please refer AXI Timer product guide.

Features Supported

  • Two identical modules each timer/counter module having two 32/64-bit counters

  • The timer/counters support polled mode, interrupt driven mode, enabling and disabling specific timers, PWM operation and the cascade mode operation to get a 64-bit timer/counter

  • Support both increment and decrement counting

  • Ability to produce output in PWM by using the two timer/counters as a pair with a specified frequency and duty factor

Known issues and Limitations

  • None

Example Applications

Refer to the driver examples directory for various example applications that exercise the different features of the driver. Each application is linked in the table below. The following sections describe the usage and expected output of the various applications.  These example applications can be imported into the Vitis IDE from the Board Support Package  settings tab. 

Links to Examples

Examples Path:
https://github.com/Xilinx/embeddedsw/tree/release-2020.1/XilinxProcessorIPLib/drivers/tmrctr

Test Name

Example Source

Description
TMRCTR Interrupt mode examples

xtmrctr_fast_intr_example.c

xtmrctr_intr_64bit_example.c

xtmrctr_intr_example.c

xtmrctr_pwm_example.c


This examples demonstrates different tmrctr features using interrupt mode.
TMRCTR polled mode examples

xtmrctr_polled_example.c

xtmrctr_low_level_example.c

This examples does basic read and write test from the flash device in Interrupt mode.
TMRCTR Self test example

xtmrctr_selftest_example.c

This example performs a self test to ensure that the hardware was built correctly.

Example Application Usage

TMRCTR fast interrupt example:


The purpose of this example is to illustrate axi timer fast interrupt mode. It initializes a timer/counter and sets it up in the compare mode in the auto reload such that the periodic interrupt is generated.
Expected output
Successfully ran Tmrctr fast interrupt Example

TMRCTR interrupt 64-bit example:


This example initializes a 64-bit timer/counter, which is only in cascade mode and sets it up in the compare mode in the auto reload such that the periodic interrupt is generated.

Expected output
Successfully ran Tmrctr interrupt 64bit Example

TMRCTR interrupt example:


This example initializes a timer/counter and sets it up in the compare mode in the auto reload such that the periodic interrupt is generated.

Expected output
Successfully ran Tmrctr interrupt Example

TMRCTR PWM example:


This example demonstrates the use of tmrctr PWM APIs.

Expected output
Successfully ran Tmrctr PWM Example

TMRCTR low level example:


This example deals with the tmrctr low level API's. It starts the timer/counter such that its incrementing by default in the polled mode and checks if the count is changed.

Expected output
Successfully ran Tmrctr lowlevel Example

TMRCTR polled example:


This example enables the auto reload mode and starts the timer/counter such that it starts incrementing  in the polled mode and confirms if the count is being changed.

Expected output
Successfully ran Tmrctr polled Example

TMRCTR selftest example:


This example performs a self test to ensure that the hardware was built correctly.