Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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



Info

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 , .mdd and .mdd fileyaml files

examples

Example applications that show how to use the driver features

src

Driver source files, make and cmakelists file

Note: AMD Xilinx embeddedsw build flow has been changed from 2023.2 release to adapt to the new system device tree based flow. For further information, refer to the wiki page Porting embeddedsw components to system device tree (SDT) based flow - Xilinx Wiki - Confluence (atlassian.net).

The .yaml(in data folder) and CMakeLists.txt(in src folder) files are needed for the System Device Tree based flow. The Driver .tcl and .mdd files are for the older build flow which will be deprecated in future.

Driver Implementation


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

...

Links to Examples

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


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.


...

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
Code Block
themeMidnight
Successfully ran Tmrctr interrupt Example

TMRCTR PWM example:


This example demonstrates the use of tmrctr PWM APIs.

Expected output
Code Block
themeMidnight
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.

...