| dp12 Vitis Drivers API Documentation

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

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

## Data Structures
struct | XDp_Config
| This typedef contains configuration information for the DisplayPort core. More...
struct | XDp_TxSinkConfig
| This typedef contains configuration information about the RX device. More...
struct | XDp_TxLinkConfig
| This typedef contains configuration information about the main link settings. More...
struct | XDp_TxMainStreamAttributes
| This typedef contains the main stream attributes which determine how the video will be displayed. More...
struct | XDp_TxMstStream
| This typedef describes a stream when the driver is running in multi-stream transport (MST) mode. More...
struct | XDp_TxBoardChar
| This typedef describes some board characteristics information that affects link training. More...
struct | XDp_TxTopologyNode
| This typedef describes a downstream DisplayPort device when the driver is running in multi-stream transport (MST) mode. More...
struct | XDp_TxTopology
| This typedef describes a the entire topology of connected downstream DisplayPort devices (from the DisplayPort TX) when the driver is operating in multi-stream transport (MST) mode. More...
struct | XDp_SbMsgLinkAddressReplyPortDetail
| This typedef describes a port that is connected to a DisplayPort branch device. More...
struct | XDp_SbMsgLinkAddressReplyDeviceInfo
| This typedef describes a DisplayPort branch device. More...
struct | XDp_RxLinkConfig
| This typedef contains configuration information about the main link settings. More...
struct | XDp_RxIicMapEntry
| This typedef represents one I2C map entry for a device. More...
struct | XDp_RxDpcdMap
| This typedef represents the DPCD address map for a device. More...
struct | XDp_RxPort
| This typedef contains information on the directly connected ports to the RX branch. More...
struct | XDp_RxTopology
| This typedef contains topology information on directly connected sinks and of the RX branch itself. More...
struct | XDp_Tx
| The XDp driver instance data representing the TX mode of operation. More...
struct | XDp_Rx
| The XDp driver instance data representing the RX mode of operation. More...
struct | XDp
| The XDp instance data. More...

## Macros
#define | XDp_GetCoreType(InstancePtr)
| This is function determines whether the DisplayPort core, represented by the XDp structure pointed to, is a transmitter (TX) or a receiver (RX). More...
#define | XDp_TxCfgSetRGB(InstancePtr, Stream)
| The following functions set the color encoding scheme for a given stream. More...

## Typedefs
typedef void(* | XDp_TimerHandler )(void *InstancePtr, u32 MicroSeconds)
| Callback type which represents a custom timer wait handler. More...
typedef void(* | XDp_IntrHandler )(void *InstancePtr)
| Callback type which represents the handler for interrupts. More...

## Enumerations
enum | XDp_CoreType
| This typedef enumerates the RX and TX modes of operation for the DisplayPort core. More...
enum | XDp_DynamicRange
| This typedef enumerates the dynamic ranges available to the DisplayPort core. More...
enum | Dp_Rx_HandlerType
| This typedef enumerates the handlers for the the DisplayPort Receiver. More...
enum | XDp_Tx_HandlerType
| This typedef enumerates the handlers for the the DisplayPort Transmitter. More...

## Functions
XDp_Config * | XDp_LookupConfig (u16 DeviceId)
| This function looks for the device configuration based on the unique device ID. More...
void | XDp_CfgInitialize (XDp *InstancePtr, XDp_Config *ConfigPtr, UINTPTR EffectiveAddr)
| This function retrieves the configuration for this DisplayPort instance and fills in the InstancePtr->Config structure. More...
u32 | XDp_Initialize (XDp *InstancePtr)
| This function prepares the DisplayPort core for use depending on whether the core is operating in TX or RX mode. More...
void | XDp_SetUserTimerHandler (XDp *InstancePtr, XDp_TimerHandler CallbackFunc, void *CallbackRef)
| This function installs a custom delay/sleep function to be used by the XDp driver. More...
void | XDp_WaitUs (XDp *InstancePtr, u32 MicroSeconds)
| This function is the delay/sleep function for the XDp driver. More...
u8 | XDp_IsLaneCountValid (XDp *InstancePtr, u8 LaneCount)
| This function checks the validity of the lane count. More...
u8 | XDp_IsLinkRateValid (XDp *InstancePtr, u8 LinkRate)
| This function checks the validity of the link rate. More...
void | XDp_InterruptHandler (XDp *InstancePtr)
| This function is the interrupt handler for the XDp driver. More...
u32 | XDp_SelfTest (XDp *InstancePtr)
| This function runs a self-test on the XDp driver/device depending on whether the core is operating in TX or RX mode. More...