Contains a minimal set of functions for the <aclass="el"href="struct_x_dptx.html">XDptx</a> driver that allow access to all of the DisplayPort TX core's functionality. See <aclass="el"href="xdptx_8h.html">xdptx.h</a> for a detailed description of the driver.<p>
This typedef enumerates the list of training states used in the state machine during the link training process. <dlcompact><dt><b>Enumerator: </b></dt><dd>
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 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>
<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>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 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 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>
<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 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 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 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>
<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 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>
