axicdma
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Groups Pages
xaxicdma_bd.h File Reference
#include "xstatus.h"
#include "xaxicdma_hw.h"
#include "xdebug.h"

Macros

#define XAxiCdma_BdRead(BdPtr, Offset)   (*(u32 *)((UINTPTR)((void *)(BdPtr)) + (u32)(Offset)))
 Reads a word from a buffer descriptor. More...
 
#define XAxiCdma_BdWrite(BdPtr, Offset, Value)   (*(u32 *)((UINTPTR)(void *)(BdPtr) + (u32)(Offset))) = (u32)(Value)
 Writes a word to a buffer descriptor. More...
 
#define XAxiCdma_BdSetAddrLen(BdPtr, AddrLen)   XAxiCdma_BdWrite(BdPtr, XAXICDMA_BD_ADDRLEN_OFFSET, AddrLen);
 Sets the address length field of a BD. More...
 
#define XAxiCdma_BdGetAddrLength(BdPtr)   XAxiCdma_BdRead(BdPtr, XAXICDMA_BD_ADDRLEN_OFFSET);
 Reads the address length field of a BD. More...
 

Typedefs

typedef UINTPTR XAxiCdma_Bd [XAXICDMA_BD_NUM_WORDS]
 Buffer descriptor shared by hardware and software. More...
 

Functions

void XAxiCdma_BdClear (XAxiCdma_Bd *BdPtr)
 Clears the content of the BD. More...
 
void XAxiCdma_BdClone (XAxiCdma_Bd *BdPtr, XAxiCdma_Bd *TmpBd)
 Clones the content from the template BD. More...
 
LONG XAxiCdma_BdGetNextPtr (XAxiCdma_Bd *BdPtr)
 Reads the next BD pointer from the BD. More...
 
void XAxiCdma_BdSetNextPtr (XAxiCdma_Bd *BdPtr, UINTPTR NextBdPtr)
 Sets the next BD pointer in the BD. More...
 
u32 XAxiCdma_BdGetSts (XAxiCdma_Bd *BdPtr)
 Reads the completion status of the BD. More...
 
void XAxiCdma_BdClearSts (XAxiCdma_Bd *BdPtr)
 Clears the status bits of the BD. More...
 
u32 XAxiCdma_BdSetSrcBufAddr (XAxiCdma_Bd *BdPtr, UINTPTR Addr)
 Sets the source address of the BD. More...
 
LONG XAxiCdma_BdGetSrcBufAddr (XAxiCdma_Bd *BdPtr)
 Reads the source address of the BD. More...
 
u32 XAxiCdma_BdSetDstBufAddr (XAxiCdma_Bd *BdPtr, UINTPTR Addr)
 Sets the destination address of the BD. More...
 
LONG XAxiCdma_BdGetDstBufAddr (XAxiCdma_Bd *BdPtr)
 Reads the destination address of the BD. More...
 
u32 XAxiCdma_BdSetLength (XAxiCdma_Bd *BdPtr, int LenBytes)
 Sets the length of the BD. More...
 
u32 XAxiCdma_BdGetLength (XAxiCdma_Bd *BdPtr)
 Reads the length of the BD. More...
 
void XAxiCdma_BdSetPhysAddr (XAxiCdma_Bd *BdPtr, UINTPTR PhysAddr)
 Sets the physical address of the BD. More...
 
void XAxiCdma_BdSetIsLite (XAxiCdma_Bd *BdPtr, int IsLite)
 Sets the lite mode field of the BD. More...
 
void XAxiCdma_BdSetHasDRE (XAxiCdma_Bd *BdPtr, int HasDRE)
 Sets the DRE field of the BD. More...
 
void XAxiCdma_BdSetWordLen (XAxiCdma_Bd *BdPtr, int WordLen)
 Sets the word length field of the BD. More...
 
void XAxiCdma_BdSetMaxLen (XAxiCdma_Bd *BdPtr, int MaxLen)
 Sets the maximum transfer length field of the BD. More...
 
LONG XAxiCdma_BdGetPhysAddr (XAxiCdma_Bd *BdPtr)
 Reads the physical address of the BD. More...
 
void XAxiCdma_DumpBd (XAxiCdma_Bd *BdPtr)
 Dumps the BD for debug purposes. More...