dcsub
Vitis Drivers API Documentation
xdc.h File Reference

Overview

MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.0 ck 03/14/25 Initial Release.

Data Structures

struct  XDc_Config
 This structure stores the XDC configuration information. More...
 
struct  XDc_ChromaKey
 This structure stores the Chroma keys max, min value for each component. More...
 
struct  XDc_AVModes
 This typedef stores the data associated with the Audio Video input modes. More...
 
struct  XDc_Cursor
 This typedef describes the cursor blend coords. More...
 
struct  XDc_PartialBlend
 This typedef describes the parital blend coords. More...
 
struct  XDc_VideoTiming
 This structure stores the XDC Timing configuration. More...
 
struct  XDc_Blender
 This typedef stores all the attributes associated to the Blender block of the DisplayPort Subsystem. More...
 

Enumerations

enum  XDc_VideoFormat
 This typedef describes all the Video Formats supported by the driver. More...
 
enum  XDc_VidInterface
 This typedef describes the DC operational modes. More...
 
enum  XDc_AudInterface
 This typedef describes the DC operational modes. More...
 
enum  XDc_VideoStream1
 This typedef describes the video source list. More...
 
enum  XDc_VideoStream2
 This typedef describes the graphics source list. More...
 
enum  XDc_AudioStream
 This typedef describes the audio source list. More...
 
enum  XDc_AlphaBlend
 This typedef enables alpha blend. More...
 
enum  XDc_ChromaBlend
 This typedef enables chroma keying. More...
 
enum  XDc_ChromaMaster
 This typedef enables chroma key master stream. More...
 
enum  XDc_Sdp
 This typedef describes the SDP source list. More...
 
enum  XDc_PartialBlendEn
 This typedef enables partial blend. More...
 
enum  XDc_CursorBlend
 This typedef enables cursor blend. More...
 

Functions

void XDc_CfgInitialize (XDc *InstancePtr, u32 BaseAddr)
 This function intializes the configuration for the DC Instance. More...
 
void XDc_Initialize (XDc *InstancePtr)
 This function initializes all the data structures of the XDc Instance. More...
 
void XDc_WriteProtEnable (XDc *InstancePtr)
 This function disables writes to DC. More...
 
void XDc_WriteProtDisable (XDc *InstancePtr)
 This function enables writes to DC. More...
 
void XDc_SetVidInterfaceMode (XDc *InstancePtr)
 This function sets the mode for DC Instance. More...
 
void XDc_SetBlenderBgColor (XDc *InstancePtr)
 This function sets the blender background color. More...
 
void XDc_SetGlobalAlpha (XDc *InstancePtr)
 This function enables or disables global alpha. More...
 
void XDc_SetInputVideoSelect (XDc *InstancePtr)
 This function selects the source type for the Video and Graphics input streams that are passed on to the blender block. More...
 
void XDc_SetInputAudioSelect (XDc *InstancePtr)
 This function selects the source type for audio stream. More...
 
XDc_VideoAttribute * XDc_GetNonLiveVideoAttribute (XDc_VideoFormat Format)
 This function looks up if the video format is valid NonLiveVideo format or not and returns a pointer to the attributes of the video. More...
 
void XDc_SetNonLiveInputFormat (XDc *InstancePtr, u8 VideoSrc, XDc_VideoAttribute *Video)
 This function applies Attributes for Non - Live source(Stream1/Stream2). More...
 
XDc_VideoAttribute * XDc_GetLiveVideoAttribute (XDc_VideoFormat Format)
 This function looks up if the video format is valid LiveVideo format or not and returns a pointer to the attributes of the video. More...
 
void XDc_SetOutputVideoFormat (XDc *InstancePtr)
 This function configures the Output of the Video Pipeline. More...
 
XDc_VideoAttribute * XDc_GetOutputVideoAttribute (XDc_VideoFormat Format, XDc_VidInterface Mode)
 This function looks up if the output video format is valid or not and returns a pointer to the attributes of the video. More...
 
void XDc_EnablePartialBlend (XDc *InstancePtr)
 This function enables Partial Blend for corresponding video stream. More...
 
u32 XDc_ConfigureStream (XDc *InstancePtr, u8 StreamSrc)
 This function configures DC Blender. More...
 
void XDc_SetOutputCSC (XDc *InstancePtr)
 This function converts the Blender output to the desired output format. More...
 
void XDc_SetChromaKey (XDc *InstancePtr)
 This function enables Chroma Keying. More...
 
void XDc_SetCursorBlend (XDc *InstancePtr)
 This function enables Cursor blending. More...
 
void XDc_SetAudioVideoClkSrc (XDc *InstancePtr)
 This function sets the Audio and Video Clock Source and the video timing source. More...
 
void XDc_VideoSoftReset (XDc *InstancePtr)
 This function applies a soft reset to the Video pipeline. More...
 
void XDc_VidClkSelect (XDc *InstancePtr)
 This function configures DC Video Clock Select. More...
 
void XDc_EnableStream1Buffers (XDc *InstancePtr)
 This function enables the video channel interface between the DCDMA and the DC. More...
 
void XDc_EnableStream2Buffers (XDc *InstancePtr)
 This function enables the video channel interface between the DCDMA and the DC. More...
 
void XDc_AudLineResetDisable (XDc *InstancePtr)
 This function enables End of Line Reset for reduced blanking resolutions. More...
 
void XDc_AudioSoftReset (XDc *InstancePtr)
 This function applies a soft reset to the Audio pipeline. More...
 
void XDc_AudExtraBSControl (XDc *InstancePtr)
 This function enables Extra BS Control for AUDIO_SOFT_RESET. More...
 
void XDc_SetSdpSource (XDc *InstancePtr)
 This function enables SDP from DMA or PL. More...
 
void XDc_SetSdpEmptyThreshold (XDc *InstancePtr)
 This function sets SDP Empty Threshold value. More...
 
void XDc_SetSdpCursorBuffers (XDc *InstancePtr)
 This function enables SDP & Cursor buffers. More...
 
void XDc_SetVidFrameSwitch (XDc *InstancePtr)
 This function configures the register to gate input video on/off at video frame boundary. More...
 
void XDc_SetNonLiveLatency (XDc *InstancePtr)
 This function configures the memory fetch latency. More...
 
void XDc_SetStcCtrl (XDc *InstancePtr)
 This function enables STC Control. More...
 
void XDc_SetStcLoad (XDc *InstancePtr)
 This function loads STC Init value. More...
 
void XDc_SetStcAdjust (XDc *InstancePtr)
 This function Adjusts STC Control value. More...
 
u64 XDc_GetStcCustomEventTs (XDc *InstancePtr)
 This function reads Custom Event STC value and returns it. More...
 
u64 XDc_GetStcCustomEvent2Ts (XDc *InstancePtr)
 This function reads Custom Event2 STC value and returns it. More...
 
u64 XDc_GetStcSnapshot (XDc *InstancePtr)
 This function reads STC Snapshot value and returns it. More...
 
void XDc_EnableAudioBuffer (XDc *InstancePtr)
 This function Enable Audio Buffer channel and sets the burst length. More...
 
void XDc_AudioChannelSelect (XDc *InstancePtr)
 This function enables audio channel select and programs sample rate. More...
 
void XDc_AudClkSelect (XDc *InstancePtr)
 This function configures DC Audio Clock Select. More...
 
void XDc_EnableAudio (XDc *InstancePtr)
 This function enables audio to DC. More...
 
void XDc_DisableAudio (XDc *InstancePtr)
 This function disables audio to DC. More...
 
void XDc_SetVideoTiming (XDc *InstancePtr)
 This function configures DC Timings register. More...
 

Enumeration Type Documentation

This typedef enables alpha blend.

This typedef describes the DC operational modes.

This typedef describes the audio source list.

This typedef enables chroma keying.

This typedef enables chroma key master stream.

This typedef enables cursor blend.

This typedef enables partial blend.

enum XDc_Sdp

This typedef describes the SDP source list.

This typedef describes all the Video Formats supported by the driver.

This typedef describes the video source list.

This typedef describes the graphics source list.

This typedef describes the DC operational modes.