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
|
- examples - Reference application to show how to use the driver APIs and calling sequence
|
- source - 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 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 use axi cdma driver on axi cdma core to transfer packets in interrupt mode
when the core is configured in Scatter Gather Mode.
xaxicdma_example_sg_poll.c : This example demonstrates how to use axi cdma driver on axi cdma core to transfer packets in the polled mode when the core is configured in Scatter Gather Mode.
xaxicdma_example_simple_intr.c : This example demonstrates how to use axi cdma driver on axi cdma core 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 use axi cdma driver on axi cdma core 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 use axi cdma driver on axi cdma core to transfer packets in interrupt mode when the core is configured in hybrid transfer Mode.
xaxicdma_example_hybrid_poll.c : This example demonstrates how to use axi cdma driver on axi cdma core to transfer packets in the polled mode when the core is configured in hybrid transfer Mode.

Known issues and Limitations

  • All IP features are supported

Change Log

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

Related Links