dcsub
Vitis Drivers API Documentation
xdcdma.h File Reference

Overview

MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.0 ck 03/14/25 Initial Release.

Data Structures

struct  XDcDma_FrameBuffer
 This typedef is the information needed to transfer video info. More...
 
struct  XDcDma_AudioBuffer
 This typedef is the information needed to transfer Audio info. More...
 
struct  XDcDma_SDPBuffer
 This typedef is the information needed to transfer SDP info. More...
 
struct  XDcDma_Channel_Dscr
 This typedef defines the Video/Graphics Channel attributes. More...
 
struct  XDcDma_Channel
 This typedef defines the Video/Graphics Channel attributes. More...
 
struct  XDcDma_AudioChannel
 This typedef defines the Audio Channel attributes. More...
 
struct  XDcDma_SDPChannel
 This typedef defines the SDP Channel attributes. More...
 
struct  XDcDma
 This typedef defines the DCDMA configration. More...
 

Enumerations

enum  XDcDma_VideoModes
 This data structure describes video planes. More...
 
enum  XDcDma_ChannelType
 This typedef defines the Channel types. More...
 

Functions

void XDcDma_CfgInitialize (XDcDma *InstancePtr, u32 EffectiveAddr)
 This function initializes the configuration for the DcDma Instance. More...
 
void XDcDma_WriteProtEnable (XDcDma *InstancePtr)
 This function enables the write protection for DCDMA registers. More...
 
void XDcDma_WriteProtDisable (XDcDma *InstancePtr)
 This function disables the write protection for DCDMA registers. More...
 
u32 XDCDma_GetWriteProt (XDcDma *InstancePtr)
 This function programs the DPDMA_GLBL register with trigger channels. More...
 
u32 XDcDma_SetCallBack (XDcDma *InstancePtr, XDcDma_IntHandlerType HandlerType, void *CallbackFunc, void *CallbackRef)
 This function sets the callback for different interrupt handlers. More...
 
u32 XDcDma_ConfigChannelState (XDcDma *InstancePtr, XDcDma_ChannelId Id, XDcDma_State Enable)
 This function programs the channel state as enable, disable or idle. More...
 
void XDcDma_SetupChannel (XDcDma *InstancePtr, XDcDma_ChannelType Channel)
 This function sets the descriptor address for each video stream. More...
 
u32 XDcDma_Trigger (XDcDma *InstancePtr, XDcDma_ChannelType Channel)
 This function programs the DPDMA_GLBL register with trigger channels. More...
 
u32 XDcDma_ReTrigger (XDcDma *InstancePtr, XDcDma_ChannelType Channel)
 This function programs the DPDMA_GLBL register with retrigger channels. More...
 
void XDcDma_SetDataQoS (XDcDma *InstancePtr, XDcDma_ChannelType Channel, u8 Val)
 This function programs the data QoS for a channel. More...
 
void XDcDma_SetDescQoS (XDcDma *InstancePtr, XDcDma_ChannelType Channel, u8 Val)
 This function programs the DPDMA_GLBL register with trigger channels. More...
 
void XDcDma_SetAxCache (XDcDma *InstancePtr, XDcDma_ChannelId Id, u8 Val)
 This function programs the Ax Cache register for specific channel. More...
 
void XDcDma_SetAxProt (XDcDma *InstancePtr, XDcDma_ChannelId Id, u8 Val)
 This function programs the AxProt register for specific channel. More...
 
void XDcDma_SetDescDelay (XDcDma *InstancePtr, XDcDma_ChannelId Id, u16 Val)
 This function programs the Desc Delay for required channel. More...
 
u32 XDCDma_GetOutstandingTxn (XDcDma *InstancePtr, XDcDma_ChannelId Id)
 This function programs the DPDMA_GLBL register with trigger channels. More...
 
u32 XDcDma_WaitPendingTransaction (XDcDma *InstancePtr, XDcDma_ChannelId Id)
 This function checks for any pending transactions for a given channel. More...
 
void XDcDma_InterruptEnable (XDcDma *InstancePtr, u32 Mask)
 This function enables the interrupt. More...
 
void XDcDma_InterruptDisable (XDcDma *InstancePtr, u32 Mask)
 This function disables the interrupt. More...
 
void XDcDma_InterruptHandler (XDcDma *InstancePtr)
 This function calls the VsyncInterrupt Handler. More...
 
void XDcDma_VSyncHandler (XDcDma *InstancePtr)
 This function services the VsyncInterrupt. More...
 
void XDcDma_DescInit (XDcDma_Descriptor *XDesc)
 This function creates the descriptor for the DcDma Instance. More...
 
u32 XDcDma_GetNewDescId (XDcDma *InstancePtr)
 This function incremeants the LastDescId of DcDma Instance. More...
 

Enumeration Type Documentation

This typedef defines the Channel types.

This data structure describes video planes.