dp
Xilinx SDK Drivers API Documentation
XDp_Tx Struct Reference

The XDp driver instance data representing the TX mode of operation. More...

Data Fields

u32 MstEnable
 Multi-stream transport (MST) mode. More...
 
u8 TrainAdaptive
 Downshift lane count and link rate if necessary during training. More...
 
XDp_TxSinkConfig RxConfig
 Configuration structure for the RX device. More...
 
XDp_TxLinkConfig LinkConfig
 Configuration structure for the main link. More...
 
XDp_TxBoardChar BoardChar
 Some board characteristics information that affects link training. More...
 
XDp_TxMainStreamAttributes MsaConfig [4]
 Configuration structure for the main stream attributes (MSA). More...
 
XDp_TxMstStream MstStreamConfig [4]
 Configuration structure for a multi-stream transport (MST) stream. More...
 
XDp_TxTopology Topology
 The topology of connected downstream DisplayPort devices when the driver is running in MST mode. More...
 
u32 AuxDelayUs
 Amount of latency in micro- seconds to use between AUX transactions. More...
 
u32 SbMsgDelayUs
 Amount of latency in micro- seconds to use between sideband messages for multi-stream transport (MST) mode. More...
 
XDp_IntrHandler TxSetMsaCallback
 Callback function for setting the TX MSA. More...
 
void * TxMsaCallbackRef
 A pointer to the user data passed to the TX MSA callback function. More...
 
XDp_IntrHandler HpdEventHandler
 Callback function for Hot- Plug-Detect (HPD) event interrupts. More...
 
void * HpdEventCallbackRef
 A pointer to the user data passed to the HPD event callback function. More...
 
XDp_IntrHandler DrvHpdEventHandler
 Callback function for Hot- Plug-Detect (HPD) event interrupts. More...
 
void * DrvHpdEventCallbackRef
 A pointer to the user data passed to the HPD event callback function. More...
 
XDp_IntrHandler HpdPulseHandler
 Callback function for Hot- Plug-Detect (HPD) pulse interrupts. More...
 
void * HpdPulseCallbackRef
 A pointer to the user data passed to the HPD pulse callback function. More...
 
XDp_IntrHandler DrvHpdPulseHandler
 Callback function for Hot- Plug-Detect (HPD) pulse interrupts. More...
 
void * DrvHpdPulseCallbackRef
 A pointer to the user data passed to the HPD pulse callback function. More...
 
void * LaneCountChangeCallbackRef
 Callback function to be invoked once a lane count change has occurred within the driver. More...
 
XDp_IntrHandler LinkRateChangeCallback
 A pointer to the user data passed to the lane count change callback function. More...
 
XDp_IntrHandler PeVsAdjustCallback
 A pointer to the user data passed to the link rate change callback function. More...
 
void * PeVsAdjustCallbackRef
 Callback function to be invoked once a voltage swing and pre-emphasis adjust request has been handled within the driver. More...
 

Detailed Description

The XDp driver instance data representing the TX mode of operation.

Field Documentation

◆ AuxDelayUs

u32 XDp_Tx::AuxDelayUs

Amount of latency in micro- seconds to use between AUX transactions.

◆ BoardChar

XDp_TxBoardChar XDp_Tx::BoardChar

Some board characteristics information that affects link training.

◆ DrvHpdEventCallbackRef

void* XDp_Tx::DrvHpdEventCallbackRef

A pointer to the user data passed to the HPD event callback function.

◆ DrvHpdEventHandler

XDp_IntrHandler XDp_Tx::DrvHpdEventHandler

Callback function for Hot- Plug-Detect (HPD) event interrupts.

◆ DrvHpdPulseCallbackRef

void* XDp_Tx::DrvHpdPulseCallbackRef

A pointer to the user data passed to the HPD pulse callback function.

◆ DrvHpdPulseHandler

XDp_IntrHandler XDp_Tx::DrvHpdPulseHandler

Callback function for Hot- Plug-Detect (HPD) pulse interrupts.

◆ HpdEventCallbackRef

void* XDp_Tx::HpdEventCallbackRef

A pointer to the user data passed to the HPD event callback function.

◆ HpdEventHandler

XDp_IntrHandler XDp_Tx::HpdEventHandler

Callback function for Hot- Plug-Detect (HPD) event interrupts.

◆ HpdPulseCallbackRef

void* XDp_Tx::HpdPulseCallbackRef

A pointer to the user data passed to the HPD pulse callback function.

◆ HpdPulseHandler

XDp_IntrHandler XDp_Tx::HpdPulseHandler

Callback function for Hot- Plug-Detect (HPD) pulse interrupts.

◆ LaneCountChangeCallbackRef

void* XDp_Tx::LaneCountChangeCallbackRef

Callback function to be invoked once a lane count change has occurred within the driver.

◆ LinkConfig

XDp_TxLinkConfig XDp_Tx::LinkConfig

Configuration structure for the main link.

Referenced by Dptx_StartLink(), XDp_TxCfgMainLinkMax(), XDp_TxEstablishLink(), and XDp_TxGetRxCapabilities().

◆ LinkRateChangeCallback

XDp_IntrHandler XDp_Tx::LinkRateChangeCallback

A pointer to the user data passed to the lane count change callback function.

Callback function to be invoked once a link rate change has occurred within the driver.

◆ MsaConfig

XDp_TxMainStreamAttributes XDp_Tx::MsaConfig[4]

Configuration structure for the main stream attributes (MSA).

Each stream has its own set of attributes. When MST mode is disabled, only MsaConfig[0] is used.

◆ MstEnable

u32 XDp_Tx::MstEnable

Multi-stream transport (MST) mode.

Enables functionality, allowing multiple streams to be sent over the main link.

◆ MstStreamConfig

XDp_TxMstStream XDp_Tx::MstStreamConfig[4]

Configuration structure for a multi-stream transport (MST) stream.

◆ PeVsAdjustCallback

XDp_IntrHandler XDp_Tx::PeVsAdjustCallback

A pointer to the user data passed to the link rate change callback function.

◆ PeVsAdjustCallbackRef

void* XDp_Tx::PeVsAdjustCallbackRef

Callback function to be invoked once a voltage swing and pre-emphasis adjust request has been handled within the driver.

◆ RxConfig

XDp_TxSinkConfig XDp_Tx::RxConfig

Configuration structure for the RX device.

Referenced by XDp_TxGetRxCapabilities().

◆ SbMsgDelayUs

u32 XDp_Tx::SbMsgDelayUs

Amount of latency in micro- seconds to use between sideband messages for multi-stream transport (MST) mode.

◆ Topology

XDp_TxTopology XDp_Tx::Topology

The topology of connected downstream DisplayPort devices when the driver is running in MST mode.

◆ TrainAdaptive

u8 XDp_Tx::TrainAdaptive

Downshift lane count and link rate if necessary during training.

◆ TxMsaCallbackRef

void* XDp_Tx::TxMsaCallbackRef

A pointer to the user data passed to the TX MSA callback function.

◆ TxSetMsaCallback

XDp_IntrHandler XDp_Tx::TxSetMsaCallback

Callback function for setting the TX MSA.