| dp12rxss Vitis Drivers API Documentation

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

Data Structures | Macros | Typedefs | Enumerations | Functions
xdprxss.h File Reference

## Data Structures
struct | XDpRxSs_UsrOpt
| User input structure. More...
struct | XDpRxSs_DpSubCore
| DisplayPort Sub-core structure. More...
struct | XDpRxSs_IicSubCore
| IIC Sub-core structure. More...
struct | XDpRxSs_SubCoreConfig
| This typedef contains configuration information for the DpRxSs subcore instances. More...
struct | XDpRxSs_Config
| This typedef contains configuration information for the DisplayPort Receiver Subsystem core. More...
struct | XDpRxSs
| The DisplayPort RX Subsystem driver instance data. More...

## Macros
#define | XDPRXSS_H_
| Prevent circular inclusions by using protection macros. More...
#define | XDpRxSs_TimerHandler XDp_TimerHandler
| Callback type which represents a custom timer wait handler. More...
#define | XDpRxSs_DtgEnable(InstancePtr) XDp_RxDtgEn((InstancePtr)->DpPtr)
| This function macro enables the display timing generator (DTG). More...
#define | XDpRxSs_DtgDisable(InstancePtr) XDp_RxDtgDis((InstancePtr)->DpPtr)
| This function macro disables the display timing generator (DTG). More...
#define | XDpRxSs_AudioEnable(InstancePtr) XDp_RxAudioEn((InstancePtr)->DpPtr)
| This function macro enables audio stream packets on the main link. More...
#define | XDpRxSs_AudioDisable(InstancePtr) XDp_RxAudioDis((InstancePtr)->DpPtr)
| This function macro disables audio stream packets on the main link. More...
#define | XDpRxSs_AudioReset(InstancePtr) XDp_RxAudioReset((InstancePtr)->DpPtr)
| This function macro resets the reception of audio stream packets on the main link. More...
#define | XDpRxSs_WaitUs(InstancePtr, MicroSeconds) XDp_WaitUs((InstancePtr)->DpPtr, MicroSeconds)
| This function macro is the delay/sleep function for the XDpRxSs driver. More...

## Typedefs
typedef void(* | XDpRxSs_Callback )(void *InstancePtr)
| Callback type which represents the handler for events. More...

## Enumerations
enum | XDpRxSs_HandlerType { XDPRXSS_HANDLER_DP_VM_CHG_EVENT = 1, XDPRXSS_HANDLER_DP_PWR_CHG_EVENT, XDPRXSS_HANDLER_DP_NO_VID_EVENT, XDPRXSS_HANDLER_DP_VBLANK_EVENT, XDPRXSS_HANDLER_DP_TLOST_EVENT, XDPRXSS_HANDLER_DP_VID_EVENT, XDPRXSS_HANDLER_DP_INFO_PKT_EVENT, XDPRXSS_HANDLER_DP_EXT_PKT_EVENT, XDPRXSS_HANDLER_DP_TDONE_EVENT, XDPRXSS_HANDLER_DP_BW_CHG_EVENT, XDPRXSS_HANDLER_DP_DWN_REQ_EVENT, XDPRXSS_HANDLER_DP_DWN_REP_EVENT, XDPRXSS_HANDLER_DP_AUD_OVRFLW_EVENT, XDPRXSS_HANDLER_DP_PAYLOAD_ALLOC_EVENT, XDPRXSS_HANDLER_DP_ACT_RX_EVENT, XDPRXSS_HANDLER_DP_CRC_TEST_EVENT, XDPRXSS_HANDLER_UNPLUG_EVENT, XDPRXSS_HANDLER_LINKBW_EVENT, XDPRXSS_HANDLER_PLL_RESET_EVENT, XDPRXSS_DRV_HANDLER_DP_PWR_CHG_EVENT, XDPRXSS_DRV_HANDLER_DP_VID_EVENT, XDPRXSS_DRV_HANDLER_DP_NO_VID_EVENT }
| These constants specify different types of handler and used to differentiate interrupt requests from sub-cores. More...

## Functions
XDpRxSs_Config * | XDpRxSs_LookupConfig (u16 DeviceId)
| This function returns a reference to an XDpRxSs_Config structure based on the core id, DeviceId. More...
u32 | XDpRxSs_CfgInitialize (XDpRxSs *InstancePtr, XDpRxSs_Config *CfgPtr, UINTPTR EffectiveAddr)
| This function initializes the DisplayPort Receiver Subsystem core. More...
u32 | XDpRxSs_Start (XDpRxSs *InstancePtr)
| This function starts the DisplayPort Receiver Subsystem including all sub-cores. More...
void | XDpRxSs_Reset (XDpRxSs *InstancePtr)
| This function resets the DisplayPort Receiver Subsystem including all sub-cores. More...
u32 | XDpRxSs_SetLinkRate (XDpRxSs *InstancePtr, u8 LinkRate)
| This function sets the data rate to be used by the DisplayPort RX Subsystem core. More...
u32 | XDpRxSs_SetLaneCount (XDpRxSs *InstancePtr, u8 LaneCount)
| This function sets the number of lanes to be used by DisplayPort RX Subsystem core. More...
u32 | XDpRxSs_ExposePort (XDpRxSs *InstancePtr, u8 Port)
| This function allows the user to select number of ports to be exposed when replying to a LINK_ADDRESS sideband message and hides rest of the ports. More...
u32 | XDpRxSs_CheckLinkStatus (XDpRxSs *InstancePtr)
| This function checks if the receiver's DisplayPort Configuration Data (DPCD) indicates that the receiver has achieved clock recovery, channel equalization, symbol lock, and interlane alignment for all lanes currently in use. More...
u32 | XDpRxSs_HandleDownReq (XDpRxSs *InstancePtr)
| This function handles incoming sideband messages. More...
void | XDpRxSs_SetUserPixelWidth (XDpRxSs *InstancePtr, u8 UserPixelWidth)
| This function configures the number of pixels output through the user data interface. More...
void | XDpRxSs_ReportCoreInfo (XDpRxSs *InstancePtr)
| This function reports list of sub-cores included in DisplayPort RX Subsystem. More...
void | XDpRxSs_ReportLinkInfo (XDpRxSs *InstancePtr)
| This function prints the link status, selected resolution, link rate /lane count symbol error. More...
void | XDpRxSs_ReportMsaInfo (XDpRxSs *InstancePtr)
| This function prints the current main stream attributes from the DisplayPort RX core. More...
void | XDpRxSs_ReportDp159BitErrCount (XDpRxSs *InstancePtr)
| This function prints the bit error encountered in DP159. More...
void | XDpRxSs_ReportHdcpInfo (XDpRxSs *InstancePtr)
| This function prints the debug display info of the HDCP interface. More...
u32 | XDpRxSs_SelfTest (XDpRxSs *InstancePtr)
| This function performs self test on DisplayPort Receiver Subsystem sub-cores. More...
void | XDpRxSs_DpIntrHandler (void *InstancePtr)
| This function is the interrupt handler for the DisplayPort RX core operating in RX mode. More...
u32 | XDpRxSs_SetCallBack (XDpRxSs *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef)
| This function installs an asynchronous callback function for the given HandlerType: More...
void | XDpRxSs_SetUserTimerHandler (XDpRxSs *InstancePtr, XDpRxSs_TimerHandler CallbackFunc, void *CallbackRef)
| This function installs a custom delay/sleep function to be used by the DisplayPort RX Subsystem. More...
void | XDpRxSs_DrvNoVideoHandler (void *InstancePtr)
| This function is the interrupt handler for No Video. More...
void | XDpRxSs_DrvVideoHandler (void *InstancePtr)
| This function is for the video interrupt handler. More...
void | XDpRxSs_DrvPowerChangeHandler (void *InstancePtr)
| This function is for the power change interrupt handler. More...