ZynqMP/Versal DMA Standalone driver

Introduction

This page gives an overview of zdma driver which is available as part of the Xilinx Vivado and Vitis distribution. ZDMA is a general purpose DMA designed to support memory to memory and memory to IO buffer transfers.

Zynq Ultrascale+ MPSOC has two instance of general purpose ZDMA.
One is located in FPD (full power domain) which usually called as GDMA and other is located in LPD (low power domain) which usually called as ADMA.

Versal has one instance of general purpose DMA in LPD (low power domain) known as ADMA.

For more information, please refer to ADMA/GDMA chapter in ZynqMP TRM (UG1085) or Versal TRM (AM011).

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

emapcs

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

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


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_v2021.1/XilinxProcessorIPLib/drivers/zdma


The driver source code is organized into different folders.  The table below shows the ZDMA 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 to ADMA/GDMA chapter in ZynqMP TRM (UG1085) or Versal TRM (AM011) for respective devices.

Features

Controller/Driver features supported

  • GMDA & ADMA are configured each with 8 DMA channels and and each channel can be programmed secure or non-secure.

  • It support two DMA Modes

    • Simple DMA mode

      • Normal data transfer from source to destination

      • Write Only Mode

      • Read Only Mode

    • Scatter Gather DMA mode

      • Normal data transfer from source to destination

  • In Scatter gather Mode it supports 2 types of descriptors out of 3 that h/w supports

    • Linear descriptor

    • Linked list descriptor

  • Interrupt Accounting Support

  • INCR and Fixed burst are supported.

Known Issues and Limitations

  • Hybrid list descriptors are not supported.

  • Flow controller feature is not supported

  • Peripheral DMA is not tested/supported.

Example Applications

ZDMA driver supports a interrupt examples in various operating modes describing how its different features can be exercised. 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/master/XilinxProcessorIPLib/drivers/zdma/examples

Test Name

Example Source

Description

ZDMA Selftest example

xzdma_selftest_example.c

Basic ZDMA selftest example to check sanity and use core APIs.

ZDMA Write-only example

xzdma_writeonlymode_example.c

ZDMA example demonstrating write-only feature.

ZDMA Read-only example

xzdma_readonlymode_example.c

ZDMA example demonstrating read-only feature.

ZDMA SG Linear example

xzdma_linear_example.c

ZDMA example demonstrating Scatter Gather Linear descriptor mode.

ZDMA SG Linked list example

xzdma_linkedlist_example.c

ZDMA example demonstrating Scatter Gather Linked list descriptor mode.

ZDMA Simple DMA example

xzdma_simple_example.c

ZDMA example demonstrating Simple DMA mode.

Example Application Usage

ZDMA Selftest example

Basic ZDMA selftest example to check sanity and use core APIs.

Expected Output

Successfully ran ZDMA Selftest Example

ZDMA Write-only example

ZDMA example demonstrating write-only feature.

Expected Output

Successfully ran Write Only mode ZDMA Example

ZDMA Read-only example

ZDMA example demonstrating read-only feature.

Expected Output

Successfully ran ZDMA Read Only Example

ZDMA SG Linear example

ZDMA example demonstrating Scatter Gather Linear descriptor mode.

Expected Output

Successfully ran ZDMA Linear mode Example

ZDMA SG Linked list example

ZDMA example demonstrating Scatter Gather Linked list descriptor mode.

Expected Output

Successfully ran ZDMA Linked list Example

ZDMA Simple DMA example

ZDMA example demonstrating Simple DMA mode.

Expected Output

Successfully ran ZDMA Simple Example

Example Design Architecture

NA

Performance

NA

Change Log

2021.1

https://github.com/Xilinx/embeddedsw/blob/xilinx_v2021.1/doc/ChangeLog#L326

2020.2

https://github.com/Xilinx/embeddedsw/blob/release-2020.2/doc/ChangeLog#L234

2020.1

No functional changes

https://github.com/Xilinx/embeddedsw/blob/release-2020.1/doc/ChangeLog#L569

2019.2

https://github.com/Xilinx/embeddedsw/blob/release-2019.2/doc/ChangeLog#L93

2019.1

https://github.com/Xilinx/embeddedsw/blob/release-2019.1/doc/ChangeLog#L290

2018.3

https://github.com/Xilinx/embeddedsw/blob/release-2018.3/doc/ChangeLog#L419

2018.2

None

2018.1

https://github.com/Xilinx/embeddedsw/blob/release-2018.1/doc/ChangeLog#L287

Related Links