axidma
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Groups Pages
XAxiDma_Config Struct Reference

The configuration structure for AXI DMA engine. More...

#include <xaxidma.h>

Data Fields

char * Name
 Unique name of the device. More...
 
UINTPTR BaseAddr
 Base address of the device. More...
 
int HasStsCntrlStrm
 Has status and control streams. More...
 
int HasMm2S
 Has memory to stream channel. More...
 
int HasMm2SDRE
 Has MM2S data realignment engine. More...
 
int Mm2SDataWidth
 MM2S data width in bits. More...
 
int HasS2Mm
 Has stream to memory channel. More...
 
int HasS2MmDRE
 Has S2MM data realignment engine. More...
 
int S2MmDataWidth
 S2MM data width in bits. More...
 
int HasSg
 Has scatter gather support. More...
 
int Mm2sNumChannels
 Number of MM2S channels. More...
 
int S2MmNumChannels
 Number of S2MM channels. More...
 
int Mm2SBurstSize
 Maximum burst length for MM2S channel (in beats) More...
 
int S2MmBurstSize
 Maximum burst length for S2MM channel (in beats) More...
 
int MicroDmaMode
 Micro DMA mode enable. More...
 
int AddrWidth
 Address Width. More...
 
int SgLengthWidth
 Scatter Gather transfer length field width. More...
 
u16 IntrId [2]
 Bits[11:0] Interrupt-id Bits[15:12] trigger type and level flags. More...
 
UINTPTR IntrParent
 Bit[0] Interrupt parent type Bit[64/32:1] Parent base address. More...
 

Detailed Description

The configuration structure for AXI DMA engine.

This structure passes the hardware building information to the driver

Field Documentation

int XAxiDma_Config::AddrWidth

Address Width.

Referenced by XAxiDma_CfgInitialize().

UINTPTR XAxiDma_Config::BaseAddr

Base address of the device.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::HasMm2S

Has memory to stream channel.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::HasMm2SDRE

Has MM2S data realignment engine.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::HasS2Mm

Has stream to memory channel.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::HasS2MmDRE

Has S2MM data realignment engine.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::HasSg

Has scatter gather support.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::HasStsCntrlStrm

Has status and control streams.

Referenced by XAxiDma_CfgInitialize().

u16 XAxiDma_Config::IntrId[2]

Bits[11:0] Interrupt-id Bits[15:12] trigger type and level flags.

Referenced by main().

UINTPTR XAxiDma_Config::IntrParent

Bit[0] Interrupt parent type Bit[64/32:1] Parent base address.

Referenced by main().

int XAxiDma_Config::MicroDmaMode

Micro DMA mode enable.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::Mm2SBurstSize

Maximum burst length for MM2S channel (in beats)

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::Mm2SDataWidth

MM2S data width in bits.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::Mm2sNumChannels

Number of MM2S channels.

Referenced by XAxiDma_CfgInitialize().

char* XAxiDma_Config::Name

Unique name of the device.

Referenced by XAxiDma_LookupConfig().

int XAxiDma_Config::S2MmBurstSize

Maximum burst length for S2MM channel (in beats)

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::S2MmDataWidth

S2MM data width in bits.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::S2MmNumChannels

Number of S2MM channels.

Referenced by XAxiDma_CfgInitialize().

int XAxiDma_Config::SgLengthWidth

Scatter Gather transfer length field width.

Referenced by XAxiDma_CfgInitialize().