axidma: xaxidma_bd.h File Reference

| axidma Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Macros | Typedefs | Functions
xaxidma_bd.h File Reference

## Macros
#define | XAxiDma_BdRead(BaseAddress, Offset) (*(u32 *)((UINTPTR)(BaseAddress) + (u32)(Offset)))
| Read the given Buffer Descriptor word. More...
#define | XAxiDma_BdWrite(BaseAddress, Offset, Data) (*(u32 *)((UINTPTR)(void *)(BaseAddress) + (u32)(Offset))) = (u32)(Data)
| Write the given Buffer Descriptor word. More...
#define | XAxiDma_BdWrite64(BaseAddress, Offset, Data) (*(u64 *)((UINTPTR)(void *)(BaseAddress) + (u32)(Offset))) = (u64)(Data)
| Write the given Buffer Descriptor word. More...
#define | XAxiDma_BdClear(BdPtr)
| Zero out BD specific fields. More...
#define | XAxiDma_BdGetCtrl(BdPtr)
| Get the control bits for the BD. More...
#define | XAxiDma_BdGetSts(BdPtr)
| Retrieve the status of a BD. More...
#define | XAxiDma_BdGetLength(BdPtr, LengthMask)
| Retrieve the length field value from the given BD. More...
#define | XAxiDma_BdSetId(BdPtr, Id) (XAxiDma_BdWrite((BdPtr), XAXIDMA_BD_ID_OFFSET, (UINTPTR)(Id)))
| Set the ID field of the given BD. More...
#define | XAxiDma_BdGetId(BdPtr) (XAxiDma_BdRead((BdPtr), XAXIDMA_BD_ID_OFFSET))
| Retrieve the ID field of the given BD previously set with XAxiDma_BdSetId. More...
#define | XAxiDma_BdGetBufAddr(BdPtr) (XAxiDma_BdRead((BdPtr), XAXIDMA_BD_BUFA_OFFSET))
| Get the BD's buffer address. More...
#define | XAxiDma_BdHwCompleted(BdPtr)
| Check whether a BD has completed in hardware. More...
#define | XAxiDma_BdGetActualLength(BdPtr, LengthMask)
| Get the actual transfer length of a BD. More...
#define | XAxiDma_BdSetTId(BdPtr, TId)
| Set the TID field of the TX BD. More...
#define | XAxiDma_BdGetTId(BdPtr)
| Retrieve the TID field of the RX BD previously set with XAxiDma_BdSetTId. More...
#define | XAxiDma_BdSetTDest(BdPtr, TDest)
| Set the TDEST field of the TX BD. More...
#define | XAxiDma_BdGetTDest(BdPtr)
| Retrieve the TDest field of the RX BD previously set with i XAxiDma_BdSetTDest. More...
#define | XAxiDma_BdSetTUser(BdPtr, TUser)
| Set the TUSER field of the TX BD. More...
#define | XAxiDma_BdGetTUser(BdPtr)
| Retrieve the TUSER field of the RX BD previously set with XAxiDma_BdSetTUser. More...
#define | XAxiDma_BdSetARCache(BdPtr, ARCache)
| Set the ARCACHE field of the given BD. More...
#define | XAxiDma_BdGetARCache(BdPtr)
| Retrieve the ARCACHE field of the given BD previously set with XAxiDma_BdSetARCache. More...
#define | XAxiDma_BdSetARUser(BdPtr, ARUser)
| Set the ARUSER field of the given BD. More...
#define | XAxiDma_BdGetARUser(BdPtr)
| Retrieve the ARUSER field of the given BD previously set with XAxiDma_BdSetARUser. More...
#define | XAxiDma_BdSetStride(BdPtr, Stride)
| Set the STRIDE field of the given BD. More...
#define | XAxiDma_BdGetStride(BdPtr)
| Retrieve the STRIDE field of the given BD previously set with XAxiDma_BdSetStride. More...
#define | XAxiDma_BdSetVSize(BdPtr, VSize)
| Set the VSIZE field of the given BD. More...
#define | XAxiDma_BdGetVSize(BdPtr)
| Retrieve the STRIDE field of the given BD previously set with XAxiDma_BdSetVSize. More...

## Typedefs
typedef u32 | XAxiDma_Bd [XAXIDMA_BD_NUM_WORDS]
| The XAxiDma_Bd is the type for a buffer descriptor (BD). More...

## Functions
int | XAxiDma_BdSetLength (XAxiDma_Bd *BdPtr, u32 LenBytes, u32 LengthMask)
| Set the length field for the given BD. More...
u32 | XAxiDma_BdSetBufAddr (XAxiDma_Bd *BdPtr, UINTPTR Addr)
| Set the BD's buffer address. More...
u32 | XAxiDma_BdSetBufAddrMicroMode (XAxiDma_Bd *BdPtr, UINTPTR Addr)
| Set the BD's buffer address when configured for Micro Mode. More...
int | XAxiDma_BdSetAppWord (XAxiDma_Bd *BdPtr, int Offset, u32 Word)
| Set the APP word at the specified APP word offset for a BD. More...
u32 | XAxiDma_BdGetAppWord (XAxiDma_Bd *BdPtr, int Offset, int *Valid)
| Get the APP word at the specified APP word offset for a BD. More...
void | XAxiDma_BdSetCtrl (XAxiDma_Bd *BdPtr, u32 Data)
| Set the control bits for a BD. More...
void | XAxiDma_DumpBd (XAxiDma_Bd *BdPtr)
| Dump the fields of a BD. More...