The Xilinx DisplayPort transmitter (DPTX) driver. This driver supports the Xilinx DisplayPort soft IP core in source (TX) mode. This driver follows the DisplayPort 1.2a specification.<p>
<b>Driver description</b><p>
The device driver enables higher-level software (e.g., an application) to configure and control a DisplayPort TX soft IP, communicate and control an RX device/sink monitor over the AUX channel, and to initialize and transmit data streams over the main link.<p>
This driver implements link layer functionality: a Link Policy Maker (LPM) and a Stream Policy Maker (SPM) as per the DisplayPort 1.2a specification.<ul>
<li>The LPM manages the main link and is responsible for keeping the link synchronized. It will establish a link with a downstream RX device by undergoing a link training sequence which consists of:<ul>
<li>Clock recovery: The clock needs to be recovered and PLLs need to be locked for all lanes.</li><li>Channel equalization: All lanes need to achieve channel equalization and and symbol lock, as well as for interlane alignment to take place.</li></ul>
</li><li>The SPM manages transportation of an isochronous stream. That is, it will initialize and maintain a video stream, establish a virtual channel to a sink monitor, and transmit the stream.</li></ul>
<p>
Using AUX transactions to read/write from/to the sink's DisplayPort Configuration Data (DPCD) address space, the LPM obtains the link capabilities, obtains link configuration and link and sink status, and configures and controls the link and sink. The main link is trained this way.<p>
I2C-over-AUX transactions are used to obtain the sink's Extended Display Identification Data (EDID) which give information on the display capabilities of the monitor. The SPM may use this information to determine what available screen resolutions and video timing are possible.<p>
<b>Interrupt processing</b><p>
DisplayPort interrupts occur on the HPD signal line when the DisplayPort cable is connected/disconnected or when the RX device sends a pulse. The user hardware design must contain an interrupt controller which the DisplayPort TX instance's interrupt signal is connected to. The user application must enable interrupts in the system and set up the interrupt controller such that the XDptx_HpdInterruptHandler handler will service DisplayPort interrupts. When the XDptx_HpdInterruptHandler function is invoked, the handler will identify what type of DisplayPort interrupt has occurred, and will call either the HPD event handler function or the HPD pulse handler function, depending on whether a an HPD event on an HPD pulse event occurred.<p>
The DisplayPort TX's XDPTX_INTERRUPT_STATUS register indicates the type of interrupt that has occured, and the XDptx_HpdInterruptHandler will use this information to decide which handler to call. An HPD event is identified if bit XDPTX_INTERRUPT_STATUS_HPD_EVENT_MASK is set, and an HPD pulse is identified from the XDPTX_INTERRUPT_STATUS_HPD_PULSE_DETECTED_MASK bit.<p>
The HPD event handler may be set up by using the XDptx_SetHpdEventHandler function and, for the HPD pulse handler, the XDptx_SetHpdPulseHandler function.<p>
<b>Multi-stream transport (MST) mode</b><p>
The driver handles MST mode functionality, including sideband messaging, topology discovery, virtual channel payload ID table management, and directing streams to different sinks.<p>
MST testing has been done at all possible link rate/lane count/topology/ resolution/color depth combinations with each setting using following values:<ul>
<li>Link rate: 1.62, 2.70, and 5.40Gbps per lane.</li><li>Lane count: 1, 2, and 4 lanes.</li><li>Number of sink displays: 1, 2, 3, and 4 sink displays in both a daisy-chain configuration and in a configuration using a combination of a 1-to-3 hub and daisy-chain. Each stream was using the same resolution.</li><li>Resolutions (60Hz): 640x480, 800x600, 1024x768, 1280x800, 1280x1024, 1360x768, 1400x1050, 1680x1050, 1920x1080, 1920x2160, and 3840x2160.</li><li>Color depths: 18, 24, 30, 36, and 48 bits per pixel.</li></ul>
<p>
<b>Audio</b><p>
The driver does not handle audio. For an example as to how to configure and transmit audio, examples/xdptx_audio_example.c illustrates the required sequence. The user will need to configure the audio source connected to the Displayport TX instance and set up the audio info frame as per user requirements.<p>
<b>Limitations</b><p>
<ul>
<li>For MST mode to correctly display, the current version of the driver requires that each of the DisplayPort TX streams be allocated without skipping streams (i.e. assign stream 1, stream 2, and stream 3 - problems were experienced if skipping stream 2 and assigning stream 4 instead). skipping monitors in a daisy chain is OK as long as they are assigned to streams in order.</li><li>In MST mode, the current version of the driver does not support removal of an allocated stream from the virtual channel payload ID table without clearing the entire table.</li><li>Some sideband messages have not been implemented in the current version of the driver for MST mode. Notably, reception of a CONNECTION_STATUS_NOTIFY sideband message.</li><li>The driver does not handle audio. See the audio example in the driver examples directory for the required sequence for enabling audio.</li></ul>
Callback type which represents the handler for a Hot-Plug-Detect (HPD) event interrupt.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
Callback type which represents the handler for a Hot-Plug-Detect (HPD) pulse interrupt.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
This function will allocate bandwidth for all enabled stream.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the payload ID tables were successfully updated with the new allocation.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, waiting for the payload ID table to be cleared or updated, or an AUX request timed out.</li><li>XST_BUFFER_TOO_SMALL if there is not enough free timeslots in the payload ID table for the requested Ts.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of a sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function will allocate a bandwidth for a virtual channel in the payload ID table in both the DisplayPort TX and the downstream DisplayPort devices on the path to the target device specified by LinkCountTotal and RelativeAddress.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>VcId</em> </td><td>is the unique virtual channel ID to allocate into the payload ID tables. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Ts</em> </td><td>is the number of timeslots to allocate in the payload ID tables.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the payload ID tables were successfully updated with the new allocation.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_BUFFER_TOO_SMALL if there is not enough free timeslots in the payload ID table for the requested Ts.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of a sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function issues a read request over the AUX channel that will read from the RX device's DisplayPort Configuration Data (DPCD) address space. The read message will be divided into multiple transactions which read a maximum of 16 bytes each.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DpcdAddress</em> </td><td>is the starting address to read from the RX device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToRead</em> </td><td>is the number of bytes to read from the RX device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ReadData</em> </td><td>is a pointer to the data buffer that will be filled with read data.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the AUX read request was successfully acknowledged.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_ERROR_COUNT_MAX if the AUX request timed out.</li><li>XST_FAILURE otherwise.</li></ul>
This function issues a write request over the AUX channel that will write to the RX device's DisplayPort Configuration Data (DPCD) address space. The write message will be divided into multiple transactions which write a maximum of 16 bytes each.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DpcdAddress</em> </td><td>is the starting address to write to the RX device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToWrite</em> </td><td>is the number of bytes to write to the RX device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>WriteData</em> </td><td>is a pointer to the data buffer that contains the data to be written to the RX device.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the AUX write request was successfully acknowledged.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_ERROR_COUNT_MAX if the AUX request timed out.</li><li>XST_FAILURE otherwise.</li></ul>
This function retrieves the configuration for this DisplayPort TX instance and fills in the InstancePtr->Config structure.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ConfigPtr</em> </td><td>is a pointer to the configuration structure that will be used to copy the settings from. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>EffectiveAddr</em> </td><td>is the device base address in the virtual memory space. If the address translation is not used, then the physical address is passed.</td></tr>
This function determines the common capabilities between the DisplayPort TX core and the RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if main link settings were successfully set.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function enables or disables synchronous clock mode for a video stream.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which to enable or disable synchronous clock mode. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Enable</em> </td><td>if set to 1, will enable synchronous clock mode. Otherwise, if set to 0, synchronous clock mode will be disabled.</td></tr>
This function calculates the following Main Stream Attributes (MSA):<ul>
<li>Transfer unit size</li><li>User pixel width</li><li>Horizontal start</li><li>Vertical start</li><li>Horizontal total clock</li><li>Vertical total clock</li><li>Misc0</li><li>Misc1</li><li>Data per lane</li><li>Average number of bytes per transfer unit</li><li>Number of initial wait cycles These values are derived from:</li><li>Bits per color</li><li>Horizontal resolution</li><li>Vertical resolution</li><li>Pixel clock (in KHz)</li><li>Horizontal sync polarity</li><li>Vertical sync polarity</li><li>Horizontal front porch</li><li>Horizontal sync pulse width</li><li>Horizontal back porch</li><li>Vertical front porch</li><li>Vertical sync pulse width</li><li>Vertical back porch</li></ul>
<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which to calculate the MSA values.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>The MsaConfig structure is modified with the new, calculated values. The main stream attributes that were used to derive the calculated values are untouched in the MsaConfig structure. </dd></dl>
This function sets the bits per color value of the video stream.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which to set the color depth. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BitsPerColor</em> </td><td>is the new number of bits per color to use.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>The InstancePtr->MsaConfig structure is modified to reflect the new main stream attributes associated with a new bits per color value. </dd></dl>
This function takes a the main stream attributes from MsaConfigCustom and copies them into InstancePtr->MsaConfig. If desired, given a base set of attributes, the rest of the attributes may be derived. The minimal required main stream attributes (MSA) that must be contained in the MsaConfigCustom structure are:<ul>
<li>Pixel clock (in Hz)</li><li>Frame rate</li><li>Horizontal active resolution</li><li>Horizontal front porch</li><li>Horizontal sync pulse width</li><li>Horizontal back porch</li><li>Horizontal total</li><li>Horizontal sync polarity</li><li>Vertical active resolution</li><li>Vertical back porch</li><li>Vertical sync pulse width</li><li>Vertical front porch</li><li>Vertical total</li><li>Vertical sync polarity</li></ul>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which the MSA values will be used for. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>MsaConfigCustom</em> </td><td>is the structure that will be used to copy the main stream attributes from (into InstancePtr->MsaConfig). </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Recalculate</em> </td><td>is a boolean enable that determines whether or not the main stream attributes should be recalculated.</td></tr>
This function sets the main stream attribute values in the configuration structure to match the preferred timing of the sink monitor. This Preferred Timing Mode (PTM) information is stored in the sink's Extended Display Identification Data (EDID).<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which the MSA values will be used for. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Edid</em> </td><td>is a pointer to the Edid to use for the specified stream.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>The InstancePtr->MsaConfig structure is modified to reflect the main stream attribute values associated to the preferred timing of the sink monitor. </dd></dl>
This function sets the Main Stream Attribute (MSA) values in the configuration structure to match one of the standard display mode timings from the XDptx_DmtModes[] standard Display Monitor Timing (DMT) table. The XDptx_VideoMode enumeration in <aclass="el"href="xdptx_8h.html">xdptx.h</a> lists the available video modes.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which the MSA values will be used for. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>VideoMode</em> </td><td>is one of the enumerated standard video modes that is used to determine the MSA values to be used.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>The InstancePtr->MsaConfig structure is modified to reflect the MSA values associated to the specified video mode. </dd></dl>
This function sets the pre-emphasis level value in the DisplayPort TX that will be used during link training for a given pre-emphasis training level.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Level</em> </td><td>is the pre-emphasis training level to set the DisplayPort TX level for. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>TxLevel</em> </td><td>is the DisplayPort TX pre-emphasis level value to be used during link training.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>There are 32 possible pre-emphasis levels in the DisplayPort TX core that map to 4 possible pre-emphasis training levels in the RX device. </dd></dl>
This function sets the voltage swing level value in the DisplayPort TX that will be used during link training for a given voltage swing training level.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Level</em> </td><td>is the voltage swing training level to set the DisplayPort TX level for. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>TxLevel</em> </td><td>is the DisplayPort TX voltage swing level value to be used during link training.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>There are 16 possible voltage swing levels in the DisplayPort TX core that map to 4 possible voltage swing training levels in the RX device. </dd></dl>
This function sets the voltage swing offset to use during training when no redriver exists. The offset will be added to the DisplayPort TX's voltage swing level value when pre-emphasis is used (when the pre-emphasis level not equal to 0).<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Offset</em> </td><td>is the value to set for the voltage swing offset.</td></tr>
This function checks if the reciever's DisplayPort Configuration Data (DPCD) indicates the reciever has achieved and maintained clock recovery, channel equalization, symbol lock, and interlane alignment for all lanes currently in use.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LaneCount</em> </td><td>is the number of lanes to check.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the RX device has maintained clock recovery, channel equalization, symbol lock, and interlane alignment.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function clears the main stream attributes registers of the DisplayPort TX core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which to clear the MSA values.</td></tr>
This function will clear the virtual channel payload ID table in both the DisplayPort TX and all downstream DisplayPort devices.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the payload ID tables were successfully cleared.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of a sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
This function will explore the DisplayPort topology of downstream devices connected to the DisplayPort TX. It will recursively go through each branch device, obtain its information by sending a LINK_ADDRESS sideband message, and add this information to the the topology's node table. For each sink device connected to a branch's downstream port, this function will obtain the details of the sink, add it to the topology's node table, as well as add it to the topology's sink list.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the topology discovery is successful.</li><li>XST_FAILURE otherwise - if sending a LINK_ADDRESS sideband message to one of the branch devices in the topology failed.</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>The contents of the InstancePtr->Topology structure will be modified. </dd></dl>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
This function enables or disables downshifting during the training process.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Enable</em> </td><td>controls the downshift feature in the training process.</td></tr>
This function checks if the link needs training and runs the training sequence if training is required.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS was either already trained, or has been trained successfully.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function will explore the DisplayPort topology of downstream devices starting from the branch device specified by the LinkCountTotal and RelativeAddress parameters. It will recursively go through each branch device, obtain its information by sending a LINK_ADDRESS sideband message, and add this information to the the topology's node table. For each sink device connected to a branch's downstream port, this function will obtain the details of the sink, add it to the topology's node table, as well as add it to the topology's sink list.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the total DisplayPort links connecting the DisplayPort TX to the current downstream device in the recursion. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the current target DisplayPort device in the recursion.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the topology discovery is successful.</li><li>XST_FAILURE otherwise - if sending a LINK_ADDRESS sideband message to one of the branch devices in the topology failed.</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>The contents of the InstancePtr->Topology structure will be modified. </dd></dl>
Given a section tag, search for and retrieve the appropriate section data block that is part of the specified DisplayID structure.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>DisplayIdRaw</em> </td><td>is a pointer to the DisplayID data. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>SectionTag</em> </td><td>is the tag to search for that represents the desired section data block. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DataBlockPtr</em> </td><td>will be set by this function to point to the appropriate section data block that is part of the DisplayIdRaw.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the section data block with the specified tag was found.</li><li>XST_FAILURE otherwise.</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>The DataBlockPtr argument is modified to point to the entry in DisplayIdRaw that represents the beginning of the desired section data block. </dd></dl>
This function retrieves an immediately connected RX device's Extended Display Identification Data (EDID) structure.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Edid</em> </td><td>is a pointer to the Edid buffer to save to.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the I2C transactions to read the EDID were successful.</li><li>XST_ERROR_COUNT_MAX if the EDID read request timed out.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
Retrieve an immediately connected RX device's Extended Display Identification Data (EDID) block given the block number. A block number of 0 represents the base EDID and subsequent block numbers represent EDID extension blocks.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Data</em> </td><td>is a pointer to the data buffer to save the block data to. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BlockNum</em> </td><td>is the EDID block number to retrieve.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the block read has successfully completed with no errors.</li><li>XST_ERROR_COUNT_MAX if a time out occurred while attempting to read the requested block.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function will obtain the global unique identifier (GUID) for the target DisplayPort device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Guid</em> </td><td>is a pointer to the GUID that will store the existing GUID of the target device.</td></tr>
This function retrieves a remote RX device's Extended Display Identification Data (EDID) structure.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Edid</em> </td><td>is a pointer to the Edid buffer to save to.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the I2C transactions to read the EDID were successful.</li><li>XST_ERROR_COUNT_MAX if the EDID read request timed out.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
Retrieve a downstream DisplayPort device's Extended Display Identification Data (EDID) block given the block number. A block number of 0 represents the base EDID and subsequent block numbers represent EDID extension blocks.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Data</em> </td><td>is a pointer to the data buffer to save the block data to. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BlockNum</em> </td><td>is the EDID block number to retrieve. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the total DisplayPort links connecting the DisplayPort TX to the targeted downstream device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the targeted DisplayPort device.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the block read has successfully completed with no errors.</li><li>XST_ERROR_COUNT_MAX if a time out occurred while attempting to read the requested block.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
Search for and retrieve a downstream DisplayPort device's Extended Display Identification Data (EDID) extension block of type DisplayID.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Data</em> </td><td>is a pointer to the data buffer to save the DisplayID to. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the total DisplayPort links connecting the DisplayPort TX to the targeted downstream device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the targeted DisplayPort device.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS a DisplayID extension block was found.</li><li>XST_ERROR_COUNT_MAX if a time out occurred while attempting to read an extension block.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE if no DisplayID extension block was found or some error occurred in the search.</li></ul>
Search for and retrieve a downstream DisplayPort device's Tiled Display Topology (TDT) section data block that is part of the downstream device's DisplayID structure. The DisplayID structure is part of the Extended Display Identification Data (EDID) in the form of an extension block.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>EdidExt</em> </td><td>is a pointer to the data area that will be filled by the retrieved DisplayID extension block. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the total DisplayPort links connecting the DisplayPort TX to the targeted downstream device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the targeted DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DataBlockPtr</em> </td><td>will be set by this function to point to the TDT data block that is part of the EdidExt extension block.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS a DisplayID extension block was found.</li><li>XST_ERROR_COUNT_MAX if a time out occurred while attempting to read an extension block.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE if no DisplayID extension block was found or some error occurred in the search.</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>The EdidExt will be filled with the DisplayID EDID extension block and the DataBlockPtr argument is modified to point to the EdidExt entry representing the TDT section data block. </dd></dl>
This function retrieves the RX device's capabilities from the RX device's DisplayPort Configuration Data (DPCD).<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the DisplayPort Configuration Data was read successfully.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function is the interrupt handler for the <aclass="el"href="struct_x_dptx.html">XDptx</a> driver.<p>
When an interrupt happens, it first detects what kind of interrupt happened, then decides which callback function to invoke.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
This function performs an I2C read over the AUX channel. The read message will be divided into multiple transactions if the requested data spans multiple segments. The segment pointer is automatically incremented and the offset is calibrated as needed. E.g. For an overall offset of:<ul>
<li>128, an I2C read is done on segptr=0; offset=128.</li><li>256, an I2C read is done on segptr=1; offset=0.</li><li>384, an I2C read is done on segptr=1; offset=128.</li><li>512, an I2C read is done on segptr=2; offset=0.</li><li>etc.</li></ul>
<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IicAddress</em> </td><td>is the address on the I2C bus of the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Offset</em> </td><td>is the offset at the specified address of the targeted I2C device that the read will start from. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToRead</em> </td><td>is the number of bytes to read. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ReadData</em> </td><td>is a pointer to a buffer that will be filled with the I2C read data.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the I2C read has successfully completed with no errors.</li><li>XST_ERROR_COUNT_MAX if the AUX request timed out.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function performs an I2C write over the AUX channel.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IicAddress</em> </td><td>is the address on the I2C bus of the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToWrite</em> </td><td>is the number of bytes to write. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>WriteData</em> </td><td>is a pointer to a buffer which will be used as the data source for the write.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the I2C write has successfully completed with no errors.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_ERROR_COUNT_MAX if the AUX request timed out.</li><li>XST_FAILURE otherwise.</li></ul>
This function prepares the DisplayPort TX core for use.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the DisplayPort TX core was successfully initialized.</li><li>XST_FAILURE otherwise.</li></ul>
This function checks if there is a connected RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if there is a connection.</li><li>FALSE if there is no connection. </li></ul>
This function will check if the immediate downstream RX device is capable of multi-stream transport (MST) mode. A DisplayPort Configuration Data (DPCD) version of 1.2 or higher is required and the MST capability bit in the DPCD must be set for this function to return XST_SUCCESS.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the RX device is MST capable.</li><li>XST_NO_FEATURE if the RX device does not support MST.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if an AUX read request timed out.</li><li>XST_FAILURE otherwise - if an AUX read transaction failed.</li></ul>
This function will disable multi-stream transport (MST) mode for the driver.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
This function will enable multi-stream transport (MST) mode for the driver.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
This function will configure the InstancePtr->MstStreamConfig structure to disable the specified stream.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream ID that will be disabled.</td></tr>
This function will configure the InstancePtr->MstStreamConfig structure to enable the specified stream.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream ID that will be enabled.</td></tr>
This function will disable multi-stream transport (MST) mode in both the DisplayPort TX and the immediate downstream RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if MST mode has been successful disabled in hardware.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if the AUX write request timed out.</li><li>XST_FAILURE otherwise - if the AUX write transaction failed.</li></ul>
This function will enable multi-stream transport (MST) mode in both the DisplayPort TX and the immediate downstream RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if MST mode has been successful enabled in hardware.</li><li>XST_NO_FEATURE if the immediate downstream RX device does not support MST - that is, if its DisplayPort Configuration Data (DPCD) version is less than 1.2, or if the DPCD indicates that it has no DPCD capabilities.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if an AUX request timed out.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed.</li></ul>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream ID to check for enable/disable status.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>1 if the specified stream is enabled.</li><li>0 if the specified stream is disabled.</li></ul>
This function performs a remote DisplayPort Configuration Data (DPCD) read by sending a sideband message. In case message is directed at the RX device connected immediately to the TX, the message is issued over the AUX channel. The read message will be divided into multiple transactions which read a maximum of 16 bytes each.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DpcdAddress</em> </td><td>is the starting address to read from the RX device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToRead</em> </td><td>is the number of bytes to read. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ReadData</em> </td><td>is a pointer to the data buffer that will be filled with read data.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the DPCD read has successfully completed (has been acknowledged).</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_DATA_LOST if the requested number of BytesToRead does not equal that actually received.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function performs a remote DisplayPort Configuration Data (DPCD) write by sending a sideband message. In case message is directed at the RX device connected immediately to the TX, the message is issued over the AUX channel. The write message will be divided into multiple transactions which write a maximum of 16 bytes each.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DpcdAddress</em> </td><td>is the starting address to write to the RX device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToWrite</em> </td><td>is the number of bytes to write. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>WriteData</em> </td><td>is a pointer to a buffer which will be used as the data source for the write.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the DPCD write has successfully completed (has been acknowledged).</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_DATA_LOST if the requested number of BytesToWrite does not equal that actually received.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function performs a remote I2C read by sending a sideband message. In case message is directed at the RX device connected immediately to the TX, the message is sent over the AUX channel. The read message will be divided into multiple transactions which read a maximum of 16 bytes each. The segment pointer is automatically incremented and the offset is calibrated as needed. E.g. For an overall offset of:<ul>
<li>128, an I2C read is done on segptr=0; offset=128.</li><li>256, an I2C read is done on segptr=1; offset=0.</li><li>384, an I2C read is done on segptr=1; offset=128.</li><li>512, an I2C read is done on segptr=2; offset=0.</li><li>etc.</li></ul>
<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IicAddress</em> </td><td>is the address on the I2C bus of the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Offset</em> </td><td>is the offset at the specified address of the targeted I2C device that the read will start from. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToRead</em> </td><td>is the number of bytes to read. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ReadData</em> </td><td>is a pointer to a buffer that will be filled with the I2C read data.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the I2C read has successfully completed with no errors.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_DATA_LOST if the requested number of BytesToRead does not equal that actually received.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function performs a remote I2C write by sending a sideband message. In case message is directed at the RX device connected immediately to the TX, the message is sent over the AUX channel.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IicAddress</em> </td><td>is the address on the I2C bus of the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToWrite</em> </td><td>is the number of bytes to write. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>WriteData</em> </td><td>is a pointer to a buffer which will be used as the data source for the write.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the I2C write has successfully completed with no errors.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_DATA_LOST if the requested number of BytesToWrite does not equal that actually received.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Reset</em> </td><td>is the type of reset to assert.</td></tr>
This function runs a self-test on the <aclass="el"href="struct_x_dptx.html">XDptx</a> driver/device. The sanity test checks whether or not all tested registers hold their default reset values.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the self-test passed - all tested registers hold their default reset values.</li><li>XST_FAILURE otherwise.</li></ul>
This function will send an ALLOCATE_PAYLOAD sideband message which will allocate bandwidth for a virtual channel in the payload ID tables of the downstream devices connecting the DisplayPort TX to the target device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>VcId</em> </td><td>is the unique virtual channel ID to allocate into the payload ID tables. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Pbn</em> </td><td>is the payload bandwidth number that determines how much bandwidth will be allocated for the virtual channel.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the reply to the sideband message was successfully obtained and it indicates an acknowledge.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
</li></ul>
<p>
<dlcompact><dt><b>Note:</b></dt><dd>ALLOCATE_PAYLOAD is a path message that will be serviced by all downstream DisplayPort devices connecting the DisplayPort TX and the target device. </dd></dl>
This function will send a CLEAR_PAYLOAD_ID_TABLE sideband message which will de-allocate all virtual channel payload ID tables.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the reply to the sideband message was successfully obtained and it indicates an acknowledge.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
</li></ul>
<p>
<dlcompact><dt><b>Note:</b></dt><dd>CLEAR_PAYLOAD_ID_TABLE is a broadcast message sent to all downstream devices. </dd></dl>
This function will send an ENUM_PATH_RESOURCES sideband message which will determine the available payload bandwidth number (PBN) for a path to a target device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>AvailPbn</em> </td><td>is a pointer to the available PBN of the path whose value will be filled in by this function. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>FullPbn</em> </td><td>is a pointer to the total PBN of the path whose value will be filled in by this function.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the reply to the sideband message was successfully obtained and it indicates an acknowledge.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
</li></ul>
<p>
<dlcompact><dt><b>Note:</b></dt><dd>ENUM_PATH_RESOURCES is a path message that will be serviced by all downstream DisplayPort devices connecting the DisplayPort TX and the target device. <p>
AvailPbn will be modified with the available PBN from the reply. <p>
FullPbn will be modified with the total PBN of the path from the reply. </dd></dl>
This function will send a LINK_ADDRESS sideband message to a target DisplayPort branch device. It is used to determine the resources available for that device and some device information for each of the ports connected to the branch device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort branch device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort branch device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DeviceInfo</em> </td><td>is a pointer to the device information structure whose contents will be filled in with the information obtained by the LINK_ADDRESS sideband message.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the reply to the sideband message was successfully obtained and it indicates an acknowledge.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
</li></ul>
<p>
<dlcompact><dt><b>Note:</b></dt><dd>The contents of the DeviceInfo structure will be modified with the information obtained from the LINK_ADDRESS sideband message reply. </dd></dl>
This function will send a REMOTE_DPCD_READ sideband message which will read from the specified DisplayPort Configuration Data (DPCD) address of a downstream DisplayPort device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DpcdAddress</em> </td><td>is the DPCD address of the target device that data will be read from. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToRead</em> </td><td>is the number of bytes to read from the specified DPCD address. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ReadData</em> </td><td>is a pointer to a buffer that will be filled with the DPCD read data.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the reply to the sideband message was successfully obtained and it indicates an acknowledge.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_DATA_LOST if the requested number of BytesToRead does not equal that actually received.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function will send a REMOTE_DPCD_WRITE sideband message which will write some data to the specified DisplayPort Configuration Data (DPCD) address of a downstream DisplayPort device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DpcdAddress</em> </td><td>is the DPCD address of the target device that data will be written to. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToWrite</em> </td><td>is the number of bytes to write to the specified DPCD address. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>WriteData</em> </td><td>is a pointer to a buffer that stores the data to write to the DPCD location.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the reply to the sideband message was successfully obtained and it indicates an acknowledge.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function will send a REMOTE_I2C_READ sideband message which will read from the specified I2C address of a downstream DisplayPort device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IicDeviceId</em> </td><td>is the address on the I2C bus of the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Offset</em> </td><td>is the offset at the specified address of the targeted I2C device that the read will start from. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BytesToRead</em> </td><td>is the number of bytes to read from the I2C address. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ReadData</em> </td><td>is a pointer to a buffer that will be filled with the I2C read data.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the reply to the sideband message was successfully obtained and it indicates an acknowledge.</li></ul>
</dd></dl>
<ul>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.<ul>
<li>XST_ERROR_COUNT_MAX if either waiting for a reply, or an AUX request timed out.</li><li>XST_DATA_LOST if the requested number of BytesToRead does not equal that actually received.</li><li>XST_FAILURE otherwise - if an AUX read or write transaction failed, the header or body CRC of the sideband message did not match the calculated value, or the a reply was negative acknowledged (NACK'ed).</li></ul>
This function enables or disables 0.5% spreading of the clock for both the DisplayPort and the RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Enable</em> </td><td>will downspread the main link signal if set to 1 and disable downspreading if set to 0.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if setting the downspread control enable was successful.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function enables or disables the enhanced framing symbol sequence for both the DisplayPort TX core and the RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Enable</em> </td><td>will enable enhanced frame mode if set to 1 and disable it if set to 0.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if setting the enhanced frame mode enable was successful.</li><li>XST_DEVICE_NOT_FOUND if no RX is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function sets a software switch that signifies whether or not a redriver exists on the DisplayPort output path. XDptx_SetVswingPreemp uses this switch to determine which set of voltage swing and pre-emphasis values to use in the TX core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Set</em> </td><td>establishes that a redriver exists in the DisplayPort output path.</td></tr>
This function installs a callback function for when a hot-plug-detect event interrupt occurs.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallbackFunc</em> </td><td>is the address to the callback function. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallbackRef</em> </td><td>is the user data item that will be passed to the callback function when it is invoked.</td></tr>
This function installs a callback function for when a hot-plug-detect pulse interrupt occurs.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallbackFunc</em> </td><td>is the address to the callback function. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallbackRef</em> </td><td>is the user data item that will be passed to the callback function when it is invoked.</td></tr>
This function sets the number of lanes to be used by the main link for both the DisplayPort TX core and the RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LaneCount</em> </td><td>is the number of lanes to be used over the main link.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if setting the new lane count was successful.</li><li>XST_DEVICE_NOT_FOUND if no RX is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function sets the data rate to be used by the main link for both the DisplayPort TX core and the RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkRate</em> </td><td>is the link rate to be used over the main link based on one of the following selects:<ul>
<li>XDPTX_LINK_BW_SET_162GBPS = 0x06 (for a 1.62 Gbps data rate)</li><li>XDPTX_LINK_BW_SET_270GBPS = 0x0A (for a 2.70 Gbps data rate)</li><li>XDPTX_LINK_BW_SET_540GBPS = 0x14 (for a 5.40 Gbps data rate)</li></ul>
</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if setting the new link rate was successful.</li><li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li><li>XST_FAILURE otherwise.</li></ul>
This function sets the main stream attributes registers of the DisplayPort TX core with the values specified in the main stream attributes configuration structure.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which to set the MSA values for.</td></tr>
This function enables or disables scrambling of symbols for both the DisplayPort and the RX device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Enable</em> </td><td>will enable or disable scrambling.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if setting the scrambling enable was successful.</li><li>XST_FAILURE otherwise.</li></ul>
This function will map a stream to a downstream DisplayPort TX device that is associated with a sink from the InstancePtr->Topology.SinkList.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream ID that will be mapped to a DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>SinkNum</em> </td><td>is the sink ID in the sink list that will be mapped to the stream.</td></tr>
This function will map a stream to a downstream DisplayPort TX device determined by the relative address.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number that will be mapped to a DisplayPort device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the total DisplayPort links connecting the DisplayPort TX to the targeted downstream device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the targeted DisplayPort device.</td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallbackFunc</em> </td><td>is the address to the callback function. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallbackRef</em> </td><td>is the user data item (microseconds to delay) that will be passed to the custom sleep/delay function when it is invoked.</td></tr>
This function clears the main stream attributes registers of the DisplayPort TX core and sets them to the values specified in the main stream attributes configuration structure.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Stream</em> </td><td>is the stream number for which to set the MSA values for.</td></tr>
Order the sink list with all sinks of the same tiled display being sorted by 'tile order'. Refer to the XDptx_GetDispIdTdtTileOrder macro on how to determine the 'tile order'. Sinks of a tiled display will have an index in the sink list that is lower than all indices of other sinks within that same tiled display that have a greater 'tile order'. When operations are done on the sink list, this ordering will ensure that sinks within the same tiled display will be acted upon in a consistent manner - with an incrementing sink list index, sinks with a lower 'tile order' will be acted upon first relative to the other sinks in the same tiled display. Multiple tiled displays may exist in the sink list.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance.</td></tr>
Swap the ordering of the sinks in the topology's sink list. All sink information is preserved in the node table - the swapping takes place only on the pointers to the sinks in the node table. The reason this swapping is done is so that functions that use the sink list will act on the sinks in a different order.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Index0</em> </td><td>is the sink list's index of one of the sink pointers to be swapped. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Index1</em> </td><td>is the sink list's index of the other sink pointer to be swapped.</td></tr>
This function is the delay/sleep function for the <aclass="el"href="struct_x_dptx.html">XDptx</a> driver. For the Zynq family, there exists native sleep functionality. For MicroBlaze however, there does not exist such functionality. In the MicroBlaze case, the default method for delaying is to use a predetermined amount of loop iterations. This method is prone to inaccuracy and dependent on system configuration; for greater accuracy, the user may supply their own delay/sleep handler, pointed to by InstancePtr->UserTimerWaitUs, which may have better accuracy if a hardware timer is used.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>MicroSeconds</em> </td><td>is the number of microseconds to delay/sleep for.</td></tr>
This function will write a global unique identifier (GUID) to the target DisplayPort device.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_dptx.html">XDptx</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>LinkCountTotal</em> </td><td>is the number of DisplayPort links from the DisplayPort source to the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RelativeAddress</em> </td><td>is the relative address from the DisplayPort source to the target device. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Guid</em> </td><td>is a the GUID to write to the target device.</td></tr>
