dp14txss
Xilinx Vitis Drivers API Documentation
xdptxss.h File Reference

Data Structures

struct  XDpTxSs_UsrOpt
 User input structure. More...
 
struct  XDpTxSs_VtcSubCore
 VTC Sub-core structure. More...
 
struct  XDpTxSs_DpSubCore
 DisplayPort Sub-core structure. More...
 
struct  XDpTxSs_Config
 This typedef contains configuration information for the DisplayPort Transmitter Subsystem core. More...
 
struct  XDpTxSs_UsrHpdPulseData
 HPD Pulse User Data structure. More...
 
struct  XDpTxSs_UsrHpdEventData
 HPD Event User Data structure. More...
 
struct  XDpTxSs
 The DisplayPort TX Subsystem driver instance data. More...
 

Macros

#define XDPTXSS_H_
 Prevent circular inclusions by using protection macros.
 
#define XDpTxSs_TimerHandler   XDp_TimerHandler
 Callback type which represents a custom timer wait handler.
 
#define XDpTxSs_MainStreamAttributes   XDp_TxMainStreamAttributes
 Main-Stream attributes.
 
#define XDpTxSs_CfgMsaEnSynchClkMode(InstancePtr, Stream, Enable)   XDp_TxCfgMsaEnSynchClkMode((InstancePtr)->DpPtr, (Sream), (Enable))
 This function enables or disables synchronous clock mode for a video stream.
 
#define XDpTxSs_Mst_AudioEnable(InstancePtr, StreamId)   XDp_Tx_Mst_AudioEn((InstancePtr)->DpPtr, StreamId)
 This function macro enables MST-TX audio on a given stream on the main link.
 
#define XDpTxSs_Mst_AudioDisable(InstancePtr)   XDp_TxAudioDis((InstancePtr)->DpPtr)
 This function macro disables audio on a given stream on the main link.
 
#define XDpTxSs_SendAudioInfoFrame(InstancePtr, xilInfoFrame)   XDp_TxSendAudioInfoFrame((InstancePtr)->DpPtr, xilInfoFrame)
 This function macro sends audio infoframe packets on the main link.
 

Enumerations

enum  XDpTxSs_HandlerType {
  XDPTXSS_HANDLER_DP_HPD_EVENT = 1, XDPTXSS_HANDLER_DP_HPD_PULSE, XDPTXSS_HANDLER_DP_LANE_COUNT_CHG, XDPTXSS_HANDLER_DP_LINK_RATE_CHG,
  XDPTXSS_HANDLER_DP_PE_VS_ADJUST, XDPTXSS_HANDLER_DP_SET_MSA, XDPTXSS_DRV_HANDLER_DP_HPD_EVENT, XDPTXSS_DRV_HANDLER_DP_HPD_PULSE
}
 These constants specify different types of handler and used to differentiate interrupt requests from sub-cores. More...
 
enum  XDpTxSs_HdcpProtocol { XDPTXSS_HDCP_NONE, XDPTXSS_HDCP_1X, XDPTXSS_HDCP_22, XDPTXSS_HDCP_BOTH }
 These constants specify the HDCP protection schemes. More...
 
enum  XDpTxSs_HdcpContentStreamType { XDPTXSS_HDCP_STREAMTYPE_0, XDPTXSS_HDCP_STREAMTYPE_1 }
 These constants specify HDCP repeater content stream management type. More...
 

Functions

XDpTxSs_ConfigXDpTxSs_LookupConfig (u16 DeviceId)
 This function returns a reference to an XDptxss_Config structure based on the core id, DeviceId.
 
u32 XDpTxSs_CfgInitialize (XDpTxSs *InstancePtr, XDpTxSs_Config *CfgPtr, UINTPTR EffectiveAddr)
 This function initializes the DisplayPort Transmitter Subsystem core.
 
u32 XDpTxSs_Start (XDpTxSs *InstancePtr)
 This function starts the DisplayPort Transmitter Subsystem including all sub-cores.
 
u32 XDpTxSs_StartCustomMsa (XDpTxSs *InstancePtr, XDpTxSs_MainStreamAttributes *MsaConfigCustom)
 This function starts the DisplayPort Transmitter Subsystem with custom multi-stream attributes (MSA)including all sub-cores.
 
void XDpTxSs_Stop (XDpTxSs *InstancePtr)
 This function disables the DisplayPort Transmitter Subsystem sub-cores.
 
void XDpTxSs_Reset (XDpTxSs *InstancePtr)
 This function resets the DisplayPort Transmitter Subsystem including all sub-cores.
 
void XDpTxSs_VtcAdjustBSTimingEnable (XDpTxSs *InstancePtr)
 This function enables special timing mode for BS equal timing.
 
void XDpTxSs_VtcAdjustBSTimingDisable (XDpTxSs *InstancePtr)
 This function disables special timing mode for BS equal timing.
 
u32 XDpTxSs_SetBpc (XDpTxSs *InstancePtr, u8 Bpc)
 This function sets the bits per color value of the video stream.
 
u32 XDpTxSs_SetVidMode (XDpTxSs *InstancePtr, XVidC_VideoMode VidMode)
 This function sets the standard display mode.
 
u32 XDpTxSs_SetLinkRate (XDpTxSs *InstancePtr, u8 LinkRate)
 This function sets the data rate to be used by the DisplayPort TX Subsystem core.
 
u32 XDpTxSs_SetLaneCount (XDpTxSs *InstancePtr, u8 LaneCount)
 This function sets the number of lanes to be used by DisplayPort TX Subsystem core.
 
u32 XDpTxSs_SetTransportMode (XDpTxSs *InstancePtr, u8 Mode)
 This function sets transport mode (SST/MST).
 
u32 XDpTxSs_IsConnected (XDpTxSs *InstancePtr)
 This function checks if there is a connected RX device to DisplayPort TX Subsystem.
 
u32 XDpTxSs_CheckLinkStatus (XDpTxSs *InstancePtr)
 This function checks if the receiver's DisplayPort Configuration Data (DPCD) indicates the receiver has achieved and maintained clock recovery, channel equalization, symbol lock, and interlane alignment for all lanes currently in use.
 
u32 XDpTxSs_IsMstCapable (XDpTxSs *InstancePtr)
 This function determines whether downstream RX device is MST/SST capable.
 
u32 XDpTxSs_GetRxCapabilities (XDpTxSs *InstancePtr)
 This function retrieves the RX device's capabilities from the RX device's DisplayPort Configuration Data (DPCD).
 
u32 XDpTxSs_GetEdid (XDpTxSs *InstancePtr, u8 *Edid)
 This function retrieves an immediately connected RX device's Extended Display Identification Data (EDID) structure.
 
u32 XDpTxSs_GetRemoteEdid (XDpTxSs *InstancePtr, u8 SinkNum, u8 *Edid)
 This function retrieves a remote RX device's Extended Display Identification Data (EDID) structure.
 
void XDpTxSs_SetHasRedriverInPath (XDpTxSs *InstancePtr, u8 Set)
 This function sets software switch that specify whether or not a redriver exits on the DisplayPort output path.
 
void XDpTxSs_SetUserPixelWidth (XDpTxSs *InstancePtr, u8 UserPixelWidth, u8 StreamId)
 This function configures the number of pixels output through the user data interface.
 
void XDpTxSs_ReportCoreInfo (XDpTxSs *InstancePtr)
 This function reports list of sub-cores included in DisplayPort TX Subsystem.
 
void XDpTxSs_ReportLinkInfo (XDpTxSs *InstancePtr)
 This function prints the link status, selected resolution, bits per color and link/lane count symbol error.
 
void XDpTxSs_ReportMsaInfo (XDpTxSs *InstancePtr)
 This function prints the current main stream attributes from the DisplayPort TX core.
 
void XDpTxSs_ReportSinkCapInfo (XDpTxSs *InstancePtr)
 This function prints the capabilities of the DisplayPort sink.
 
void XDpTxSs_ReportSplitterInfo (XDpTxSs *InstancePtr)
 This function prints the current Dual Splitter information.
 
void XDpTxSs_ReportVtcInfo (XDpTxSs *InstancePtr)
 This function prints the current VTC timing information.
 
void XDpTxSs_ReportHdcpInfo (XDpTxSs *InstancePtr)
 This function prints the debug display info of the HDCP interface.
 
u32 XDpTxSs_SelfTest (XDpTxSs *InstancePtr)
 This function performs self test on DisplayPort Transmitter Subsystem sub-cores.
 
void XDpTxSs_DpIntrHandler (void *InstancePtr)
 This function is the interrupt handler for the DisplayPort TX core operating in TX mode.
 
u32 XDpTxSs_SetCallBack (XDpTxSs *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef)
 This function installs an asynchronous callback function for the given HandlerType:
 
void XDpTxSs_SetUserTimerHandler (XDpTxSs *InstancePtr, XDpTxSs_TimerHandler CallbackFunc, void *CallbackRef)
 This function installs a custom delay/sleep function to be used by the DisplayPort TX Subsystem.
 
void XDpTxSs_HpdEventProcess (void *InstancePtr)
 This function is process some DP driver read as per DP spec on HPD EVENT.
 
void XDpTxSs_HpdPulseProcess (void *InstancePtr)
 This function is process some DP driver read as per DP spec on HPD Pulse.