axicdma
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Groups Pages
XAxiCdma Struct Reference

Driver instance data for one CDMA engine. More...

#include <xaxicdma.h>

Data Fields

UINTPTR BaseAddr
 Virtual base address of the DMA engine. More...
 
int Initialized
 The driver/engine in working state. More...
 
int SimpleOnlyBuild
 Whether hardware is simple only build. More...
 
int HasDRE
 Whether support unaligned transfers. More...
 
int IsLite
 Whether hardware is in lite mode. More...
 
int WordLength
 Length of a word in bytes. More...
 
int MaxTransLen
 Length hardware supports. More...
 
int SimpleNotDone
 Flag that a simple transfer is ongoing. More...
 
int SGWaiting
 Flag that SG transfers are waiting. More...
 
UINTPTR FirstBdPhysAddr
 Physical address of 1st BD in list. More...
 
UINTPTR FirstBdAddr
 Virtual address of 1st BD in list. More...
 
UINTPTR LastBdAddr
 Virtual address of last BD in the list. More...
 
u32 BdRingTotalLen
 Total size of ring in bytes. More...
 
u32 BdSeparation
 Distance between adjacent BDs in bytes. More...
 
XAxiCdma_Bd * FreeBdHead
 First BD in the free group. More...
 
XAxiCdma_Bd * PreBdHead
 First BD in the pre-work group. More...
 
XAxiCdma_Bd * HwBdHead
 First BD in the work group. More...
 
XAxiCdma_Bd * HwBdTail
 Last BD in the work group. More...
 
XAxiCdma_Bd * PostBdHead
 First BD in the post-work group. More...
 
XAxiCdma_Bd * BdaRestart
 BD to load when hardware restarted. More...
 
int FreeBdCnt
 Number of allocatable BDs. More...
 
int PreBdCnt
 Number of BDs in pre-work group. More...
 
int HwBdCnt
 Number of BDs in work group. More...
 
int PostBdCnt
 Number of BDs in post-work group. More...
 
int AllBdCnt
 Total Number of BDs. More...
 
int BurstLen
 Burst length. More...
 
XAxiCdma_CallBackFn SimpleCallBackFn
 
Callback function for simple

transfer More...

 
void * SimpleCallBackRef
 Callback reference pointer. More...
 
int SgHandlerHead
 First active sg transfer handler. More...
 
int SgHandlerTail
 Last active sg transfer handler. More...
 
XAxiCdma_IntrHandlerList Handlers [XAXICDMA_MAXIMUM_MAX_HANDLER]
 List of interrupt handlers. More...
 
int AddrWidth
 Address Width. More...
 

Detailed Description

Driver instance data for one CDMA engine.

Field Documentation

int XAxiCdma::AllBdCnt
XAxiCdma_Bd* XAxiCdma::BdaRestart

BD to load when hardware restarted.

Referenced by XAxiCdma_BdRingCreate(), XAxiCdma_BdRingSnapShotCurrBd(), and XAxiCdma_SwitchMode().

u32 XAxiCdma::BdRingTotalLen

Total size of ring in bytes.

Referenced by XAxiCdma_BdRingCreate().

u32 XAxiCdma::BdSeparation

Distance between adjacent BDs in bytes.

Referenced by XAxiCdma_BdRingClone(), XAxiCdma_BdRingCreate(), XAxiCdma_BdRingNext(), and XAxiCdma_BdRingPrev().

int XAxiCdma::BurstLen

Burst length.

Referenced by XAxiCdma_CfgInitialize(), and XAxiCdma_SelectKeyHole().

UINTPTR XAxiCdma::FirstBdAddr

Virtual address of 1st BD in list.

Referenced by XAxiCdma_BdRingClone(), XAxiCdma_BdRingCreate(), XAxiCdma_BdRingNext(), and XAxiCdma_BdRingPrev().

UINTPTR XAxiCdma::FirstBdPhysAddr

Physical address of 1st BD in list.

Referenced by XAxiCdma_BdRingCreate().

XAxiCdma_Bd* XAxiCdma::FreeBdHead

First BD in the free group.

Referenced by XAxiCdma_BdRingAlloc(), XAxiCdma_BdRingCreate(), and XAxiCdma_BdRingUnAlloc().

List of interrupt handlers.

Referenced by XAxiCdma_BdRingToHw(), and XAxiCdma_IntrHandler().

int XAxiCdma::HasDRE

Whether support unaligned transfers.

Referenced by XAxiCdma_BdRingCreate(), XAxiCdma_CfgInitialize(), and XAxiCdma_SimpleTransfer().

XAxiCdma_Bd* XAxiCdma::HwBdHead

First BD in the work group.

Referenced by XAxiCdma_BdRingCreate(), and XAxiCdma_BdRingFromHw().

XAxiCdma_Bd* XAxiCdma::HwBdTail
int XAxiCdma::Initialized
int XAxiCdma::IsLite

Whether hardware is in lite mode.

Referenced by XAxiCdma_BdRingCreate(), and XAxiCdma_CfgInitialize().

UINTPTR XAxiCdma::LastBdAddr

Virtual address of last BD in the list.

Referenced by XAxiCdma_BdRingCreate(), XAxiCdma_BdRingNext(), and XAxiCdma_BdRingPrev().

int XAxiCdma::MaxTransLen

Length hardware supports.

Referenced by XAxiCdma_BdRingCreate(), XAxiCdma_CfgInitialize(), and XAxiCdma_SimpleTransfer().

int XAxiCdma::PostBdCnt

Number of BDs in post-work group.

Referenced by XAxiCdma_BdRingCreate(), XAxiCdma_BdRingFree(), XAxiCdma_BdRingFromHw(), and XAxiCdma_CfgInitialize().

XAxiCdma_Bd* XAxiCdma::PostBdHead

First BD in the post-work group.

Referenced by XAxiCdma_BdRingCreate(), and XAxiCdma_BdRingFree().

int XAxiCdma::PreBdCnt
XAxiCdma_Bd* XAxiCdma::PreBdHead

First BD in the pre-work group.

Referenced by XAxiCdma_BdRingCreate(), and XAxiCdma_BdRingToHw().

int XAxiCdma::SgHandlerHead

First active sg transfer handler.

Referenced by XAxiCdma_BdRingToHw(), XAxiCdma_IntrHandler(), and XAxiCdma_Reset().

int XAxiCdma::SgHandlerTail

Last active sg transfer handler.

Referenced by XAxiCdma_BdRingToHw(), XAxiCdma_IntrHandler(), and XAxiCdma_Reset().

int XAxiCdma::SGWaiting

Flag that SG transfers are waiting.

Referenced by XAxiCdma_BdRingStartTransfer(), XAxiCdma_BdRingToHw(), XAxiCdma_IntrHandler(), and XAxiCdma_Reset().

XAxiCdma_CallBackFn XAxiCdma::SimpleCallBackFn

Callback function for simple

transfer

Referenced by XAxiCdma_IntrHandler(), XAxiCdma_Reset(), and XAxiCdma_SimpleTransfer().

void* XAxiCdma::SimpleCallBackRef

Callback reference pointer.

Referenced by XAxiCdma_IntrHandler(), XAxiCdma_Reset(), and XAxiCdma_SimpleTransfer().

int XAxiCdma::SimpleNotDone
int XAxiCdma::SimpleOnlyBuild
int XAxiCdma::WordLength

Length of a word in bytes.

Referenced by XAxiCdma_BdRingCreate(), XAxiCdma_CfgInitialize(), and XAxiCdma_SimpleTransfer().