AXI CDMA Standalone Driver

Introduction

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

The Xilinx LogiCORE™ IP AXI Central Direct Memory Access (CDMA) core is a soft Xilinx Intellectual Property (IP) core for use with the Vivado® Design Suite. The AXI CDMA provides high-bandwidth Direct Memory Access (DMA) between a memory-mapped source address and a memory-mapped destination address using the AXI4 protocol. An optional Scatter Gather (SG) feature can be used to offload control and sequencing tasks from the system CPU. Initialization, status, and control registers are accessed through an AXI4-Lite slave interface.

How to enable

Source Path for the driver
https://github.com/Xilinx/embeddedsw/tree/master/XilinxProcessorIPLib/drivers/axicdma

Driver source code is organized into different folders. Below diagram shows the axicdma driver source organization

AXI CDMA
|
- doc - Provides the API and data structure details

|

- data - Driver tcl and MDD file.

|
- examples - Reference application to show how to use the driver APIs and calling sequence
|
- src- Driver source files

Features Supported

Controller Features

AXI4 interface for data transfer
Independent AXI4-Lite slave interface for register access
Independent AXI4 Master interface for
Optional Scatter/Gather(SG) function
Optional Data Realignment Engine
Register Direct Mode
Optional Scatter-Gather DMA support
Optional Store and Forward support
Parameterized Read and Write Address Pipeline depths
Fixed-address and incrementing-address burst support
Support for up to 64-bit addressing

Standalone Driver Supported Features

The AXI CDMA Standalone driver supports the below things.

Supports Simple DMA mode
Supports Scatter/Gather Direct Memory Access (DMA)
Supports 64-bit Addressing
Supports Optional Data Re-Alignment Feature
Supports Register Direct mode

Test cases

Refer below pah for testing different examples for each feature of the IP.

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

xaxicdma_example_sg_intr.c : This example demonstrates how to transfer packets in interrupt mode when the core is configured in SG Mode.
xaxicdma_example_sg_poll.c : This example demonstrates how to transfer packets in the polled mode when the core is configured in SG Mode.
xaxicdma_example_simple_intr.c : This example demonstrates how to transfer packets in interrupt mode when the core is configured in simple DMA Mode.
xaxicdma_example_simple_poll.c : This example demonstrates how to transfer packets in the polled mode when the core is configured in simple DMA Mode.
xaxicdma_example_hybrid_intr.c : This example demonstrates how to transfer packets in interrupt mode when the core is configured in hybrid(SG + simple) transfer Mode.
xaxicdma_example_hybrid_poll.c : This example demonstrates how to transfer packets in the polled mode when the core is configured in hybrid(SG + simple) transfer Mode.

Known issues and Limitations

All IP features are supported

Change Log

2020.2

Consolidate debug header files.
Fix axicdma hybrid interrupt/poll example failures.
Support parallel make execution.

257c0d9e3742 BSP: Consolidate and add the drivers xdebug.h data to common xdebug.h
4dc85994d6fb Makefile: Remove realpath command
bc81851ae0d5 axicdma: Fix axicdma hybrid interrupt example failure
7b40e2e94d9b axicdma: Fix xreg_cortexa9.h compilation error on R5 processor
73ffe7217f1c axicdma: Update Makefile to support parallel make execution
fab4922c382d axicdma: Fix xaxicdma_example_hybrid_poll example failure
d6191ca046d2 axicdma: To fix the compilation error

2020.1

Fix race condition in driver tcl.
Cleanup old axicdma driver version.
Fix gcc warning in peripheral test and examples.
Support 26bit dma transfer length.

097fb0b drivers: axicdma: Fix race condition in the test app tcl
f70c6fc axicdma: Clean up old versions for axicdma driver
985f002 axicdma: Fix gcc warning in peripheral test and examples
952386c axicdma: Support 26bit dma transfer length

2019.2

Fix cache maintenance operation for data buffers in examples.
Enable debug prints in examples.

Commit Id's

67fe31f axicdma: examples: Fix cache maintenance operation for data buffers
320aa07 axicdma: examples: Add errors prints for failing scenarios

2019.1

None

2018.3

Fix typos in peripheral app tcl.
Reset error and done states before starting DMA.
Fix compilation error in examples DEBUG mode.
Fix gcc and cppcheck warnings.

Commit Id's

20df53d Fix typos in peripheral app generation tcl
394e44f examples: Reset error and done states before starting DMA
5e68393 examples: Fix compilation error in DEBUG mode
da70e17 Fix gcc warning in peripheral test application
f80f1ad Fix cppcheck warning
cd5bc3d Include missing initializers for 'XAxiCdma_Config' fields

2018.2

None

2018.1

Extend AXI CDMA examples to support data buffers above 4GB

Commit Id's
9fab83a axicdma: Extend AXI CDMA examples to support data buffers above 4GB
2017.4

None

2017.3

None

Table of Contents