This page gives an overview of PS UART BareMetal 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 |
---|---|---|
uartps | <Vitis Install Directory>/data/embedded/XilinxProcessorIPLib/drivers/uartps | https://github.com/Xilinx/embeddedsw/tree/master/XilinxProcessorIPLib/drivers/uartps |
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/xilinx-v2020.1/XilinxProcessorIPLib/drivers/uartps |
The driver source code is organized into different folders. The table below shows the uartps driver source organization.
Directory | Description |
---|---|
doc | Provides the API and data structure details |
data | Driver .tcl, .yaml and .mdd file |
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 link Porting embeddedsw components to system device tree (SDT) based flow
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.
For a full list of features supported by this IP, please refer zynqmp TRM which includes link s to the official documentation and resource utilization.
Examples Path:
https://github.com/Xilinx/embeddedsw/tree/master/XilinxProcessorIPLib/drivers/uartps/examples
Test name | Example Source | Description |
---|---|---|
Uart Interrupt example | xuartps_intr_example.c | This example does basic read and write test with interrupts. |
Uart polled example | xuartps_polled_example.c | This example does basic read and write test using polling. |
Uart hello world example | xuartps_hello_world_example.c | This example prints a string. |
This example does basic read and write test with interrupts.
Expected Output
Successfully ran UART Interrupt Example Test |
Successfully ran UART Polled Mode Example Test |
HelloWorld Successfully ran Uartps hello world Example |
NA
https://github.com/Xilinx/embeddedsw/blob/xlnx_rel_v2023.2/doc/ChangeLog#L141
https://github.com/Xilinx/embeddedsw/blob/xilinx_v2023.1/doc/ChangeLog#L141
None