| axidma Vitis Drivers API Documentation

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

Data Structures | Macros | Typedefs | Functions
xaxidma.h File Reference

## Data Structures
struct | XAxiDma
| The XAxiDma driver instance data. More...
struct | XAxiDma_Config
| The configuration structure for AXI DMA engine. More...

## Macros
#define | XAxiDma_GetTxRing(InstancePtr) (&((InstancePtr)->TxBdRing))
| Get Transmit (Tx) Ring ptr. More...
#define | XAxiDma_GetRxRing(InstancePtr) (&((InstancePtr)->RxBdRing[0]))
| Get Receive (Rx) Ring ptr. More...
#define | XAxiDma_GetRxIndexRing(InstancePtr, RingIndex) (&((InstancePtr)->RxBdRing[RingIndex]))
| Get Receive (Rx) Ring ptr of a Index. More...
#define | XAxiDma_HasSg(InstancePtr) ((InstancePtr)->HasSg) ? TRUE : FALSE
| This function checks whether system is configured as Simple or Scatter Gather mode. More...
#define | XAxiDma_IntrEnable(InstancePtr, Mask, Direction)
| This function enables interrupts specified by the Mask in specified direction, Interrupts that are not in the mask are not affected. More...
#define | XAxiDma_IntrGetEnabled(InstancePtr, Direction)
| This function gets the mask for the interrupts that are currently enabled. More...
#define | XAxiDma_IntrDisable(InstancePtr, Mask, Direction)
| This function disables interrupts specified by the Mask. More...
#define | XAxiDma_IntrGetIrq(InstancePtr, Direction)
| This function gets the interrupts that are asserted. More...
#define | XAxiDma_IntrAckIrq(InstancePtr, Mask, Direction)
| This function acknowledges the interrupts that are specified in Mask. More...

## Typedefs
typedef struct XAxiDma | XAxiDma
| The XAxiDma driver instance data. More...

## Functions
XAxiDma_Config * | XAxiDma_LookupConfig (u32 DeviceId)
| Look up the hardware configuration for a device instance. More...
XAxiDma_Config * | XAxiDma_LookupConfigBaseAddr (UINTPTR Baseaddr)
| Look up the hardware configuration for a device instance based on base address. More...
int | XAxiDma_CfgInitialize (XAxiDma *InstancePtr, XAxiDma_Config *Config)
| This function initializes a DMA engine. More...
void | XAxiDma_Reset (XAxiDma *InstancePtr)
| Reset both TX and RX channels of a DMA engine. More...
int | XAxiDma_ResetIsDone (XAxiDma *InstancePtr)
| Check whether reset is done. More...
int | XAxiDma_Pause (XAxiDma *InstancePtr)
| Pause DMA transactions on both channels. More...
int | XAxiDma_Resume (XAxiDma *InstancePtr)
| Resume DMA transactions on both channels. More...
u32 | XAxiDma_Busy (XAxiDma *InstancePtr, int Direction)
| This function checks whether specified DMA channel is busy. More...
u32 | XAxiDma_SimpleTransfer (XAxiDma *InstancePtr, UINTPTR BuffAddr, u32 Length, int Direction)
| This function does one simple transfer submission. More...
int | XAxiDma_SelectKeyHole (XAxiDma *InstancePtr, int Direction, int Select)
| This function Enable or Disable KeyHole Feature. More...
int | XAxiDma_SelectCyclicMode (XAxiDma *InstancePtr, int Direction, int Select)
| This function Enable or Disable Cyclic Mode Feature. More...
int | XAxiDma_Selftest (XAxiDma *InstancePtr)
| Runs a self-test on the driver/device. More...