This page gives an overview of tmrctr driver which is available as part of the Xilinx Vivado and SDK distribution.
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 , .mdd and .yaml 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.
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
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.
Examples Path:
https://github.com/Xilinx/embeddedsw/tree/xlnx_rel_v2023.2/XilinxProcessorIPLib/drivers/tmrctr/examples
Test Name | Example Source | Description |
---|---|---|
TMRCTR Interrupt mode examples | This examples demonstrates different tmrctr features using interrupt mode. | |
TMRCTR polled mode examples | This examples does basic read and write test from the flash device in Interrupt mode. | |
TMRCTR Self test example | This example performs a self test to ensure that the hardware was built correctly. |
Successfully ran Tmrctr fast interrupt Example |
Successfully ran Tmrctr interrupt 64bit Example |
Successfully ran Tmrctr interrupt Example |
Successfully ran Tmrctr PWM Example |
Successfully ran Tmrctr lowlevel Example |
Successfully ran Tmrctr polled Example |
Successfully ran Tmrctr selftest Example |
2023.2
2023.1
2022.2
2022.1
2021.2
2021.1
2020.2
2020.1 - 2019.1
2018.3
2018.2-2018.1
2017.3