![]() |
axicdma
Vitis Drivers API Documentation
|
Data Structures | |
| struct | XAxiCdma_IntrHandlerList |
| Interrupt handler list entry for scatter gather transfers. More... | |
| struct | XAxiCdma_Config |
| Hardware configuration structure for the CDMA engine. More... | |
| struct | XAxiCdma |
| Driver instance data for one CDMA engine. More... | |
Macros | |
| #define | XAXICDMA_MAXIMUM_MAX_HANDLER 20 |
| Maximum active SG interrupt handlers this driver manages. More... | |
Coalesce and buffer descriptor constants | |
| #define | XAXICDMA_COALESCE_NO_CHANGE 0xFFFFFFFF |
| Leaves coalesce unchanged. More... | |
| #define | XAXICDMA_ALL_BDS 0x7FFFFFFF |
| Maximum BD count value. More... | |
Engine mode constants | |
| #define | XAXICDMA_SG_MODE 1 |
| Scatter gather mode. More... | |
| #define | XAXICDMA_SIMPLE_MODE 2 |
| Simple DMA mode. More... | |
KeyHole feature selection | |
| #define | XAXICDMA_KEYHOLE_READ 0 |
| KeyHole read direction. More... | |
| #define | XAXICDMA_KEYHOLE_WRITE 1 |
| KeyHole write direction. More... | |
Buffer descriptor cache maintenance macros | |
| #define | XAXICDMA_CACHE_FLUSH(BdPtr) Xil_DCacheFlushRange((BdPtr), XAXICDMA_BD_HW_NUM_BYTES); |
| Flushes the data cache for a buffer descriptor. More... | |
| #define | XAXICDMA_CACHE_INVALIDATE(BdPtr) Xil_DCacheInvalidateRange((BdPtr), XAXICDMA_BD_HW_NUM_BYTES) |
| Invalidates the data cache for a buffer descriptor. More... | |
Typedefs | |
| typedef void(* | XAxiCdma_CallBackFn )(void *CallBackRef, u32 IrqMask, int *NumBdPtr) |
| Defines the callback function type for transfer completion notification. More... | |
Functions | |
| XAxiCdma_Config * | XAxiCdma_LookupConfig (UINTPTR BaseAddress) |
| Looks up device configuration by device ID or base address. More... | |
| u32 | XAxiCdma_CfgInitialize (XAxiCdma *InstancePtr, XAxiCdma_Config *CfgPtr, UINTPTR EffectiveAddr) |
| Initializes the driver. More... | |
| void | XAxiCdma_Reset (XAxiCdma *InstancePtr) |
| Resets the hardware. More... | |
| int | XAxiCdma_ResetIsDone (XAxiCdma *InstancePtr) |
| Checks whether hardware reset completed. More... | |
| int | XAxiCdma_IsBusy (XAxiCdma *InstancePtr) |
| Checks whether the hardware is doing transfer. More... | |
| int | XAxiCdma_SetCoalesce (XAxiCdma *InstancePtr, u32 Counter, u32 Delay) |
| Sets the interrupt coalescing threshold and delay counters. More... | |
| void | XAxiCdma_GetCoalesce (XAxiCdma *InstancePtr, u32 *CounterPtr, u32 *DelayPtr) |
| Reads the interrupt coalescing threshold and delay counter settings. More... | |
| u32 | XAxiCdma_GetError (XAxiCdma *InstancePtr) |
| Reads error status bits from the hardware. More... | |
| void | XAxiCdma_IntrEnable (XAxiCdma *InstancePtr, u32 Mask) |
| Enables interrupts specified by the Mask. More... | |
| u32 | XAxiCdma_IntrGetEnabled (XAxiCdma *InstancePtr) |
| Reads the mask for currently enabled interrupts. More... | |
| void | XAxiCdma_IntrDisable (XAxiCdma *InstancePtr, u32 Mask) |
| Disables interrupts specified by the Mask. More... | |
| void | XAxiCdma_IntrHandler (void *HandlerRef) |
| Handles driver interrupts, it handles all the interrupts. More... | |
| u32 | XAxiCdma_SimpleTransfer (XAxiCdma *InstancePtr, UINTPTR SrcAddr, UINTPTR DstAddr, int Length, XAxiCdma_CallBackFn SimpleCallBack, void *CallBackRef) |
| Performs one simple transfer submission. More... | |
| int | XAxiCdma_SelectKeyHole (XAxiCdma *InstancePtr, u32 Direction, u32 Select) |
| Configures the KeyHole read or write feature. More... | |
| u32 | XAxiCdma_BdRingCntCalc (u32 Alignment, u32 Bytes, UINTPTR BdBuffAddr) |
| Calculates how many BDs fit in the given memory size and alignment. More... | |
| u32 | XAxiCdma_BdRingMemCalc (u32 Alignment, int NumBd) |
| Calculates memory required for the requested number of BDs. More... | |
| u32 | XAxiCdma_BdRingGetCnt (XAxiCdma *InstancePtr) |
| Reads the total number of BDs in the BD ring. More... | |
| u32 | XAxiCdma_BdRingGetFreeCnt (XAxiCdma *InstancePtr) |
| Reads the number of free BDs. More... | |
| void | XAxiCdma_BdRingSnapShotCurrBd (XAxiCdma *InstancePtr) |
| Reads and saves the current BD pointer from the hardware. More... | |
| XAxiCdma_Bd * | XAxiCdma_BdRingGetCurrBd (XAxiCdma *InstancePtr) |
| Reads the current BD pointer from the hardware. More... | |
| XAxiCdma_Bd * | XAxiCdma_BdRingNext (XAxiCdma *InstancePtr, XAxiCdma_Bd *BdPtr) |
| Reads the next BD on the BD ring. More... | |
| XAxiCdma_Bd * | XAxiCdma_BdRingPrev (XAxiCdma *InstancePtr, XAxiCdma_Bd *BdPtr) |
| Reads the previous BD on the BD ring. More... | |
| LONG | XAxiCdma_BdRingCreate (XAxiCdma *InstancePtr, UINTPTR PhysAddr, UINTPTR VirtAddr, u32 Alignment, int BdCount) |
| Creates the BD ring for the driver instance. More... | |
| LONG | XAxiCdma_BdRingClone (XAxiCdma *InstancePtr, XAxiCdma_Bd *TemplateBdPtr) |
| Clones all BDs in the ring from a template BD. More... | |
| LONG | XAxiCdma_BdRingAlloc (XAxiCdma *InstancePtr, int NumBd, XAxiCdma_Bd **BdSetPtr) |
| Allocates BDs from the BD ring. More... | |
| LONG | XAxiCdma_BdRingUnAlloc (XAxiCdma *InstancePtr, int NumBd, XAxiCdma_Bd *BdSetPtr) |
| Returns BDs to the free pool in the ring. More... | |
| LONG | XAxiCdma_BdRingToHw (XAxiCdma *InstancePtr, int NumBd, XAxiCdma_Bd *BdSetPtr, XAxiCdma_CallBackFn CallBackFn, void *CallBackRef) |
| Enqueues prepared BDs to the hardware. More... | |
| u32 | XAxiCdma_BdRingFromHw (XAxiCdma *InstancePtr, int BdLimit, XAxiCdma_Bd **BdSetPtr) |
| Retrieves completed BDs from the hardware. More... | |
| u32 | XAxiCdma_BdRingFree (XAxiCdma *InstancePtr, int NumBd, XAxiCdma_Bd *BdSetPtr) |
| Returns the BDs back to the free pool of the BD ring. More... | |
| void | XAxiCdma_BdSetCurBdPtr (XAxiCdma *InstancePtr, UINTPTR CurBdPtr) |
| Sets the current BD pointer in the hardware. More... | |
| void | XAxiCdma_BdSetTailBdPtr (XAxiCdma *InstancePtr, UINTPTR TailBdPtr) |
| Sets the tail BD pointer in the hardware. More... | |
| void | XAxiCdma_DumpRegisters (XAxiCdma *InstancePtr) |
| Dumps the registers of this DMA instance. More... | |