<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dp12txss: xdptxss_dptx.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">dp12txss
</div>
<div id="projectbrief">Vitis Drivers API Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="globals.html"><span>APIs</span></a></li>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdptxss__dptx_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xdptxss_dptx.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the header file for Xilinx DisplayPort Transmitter Subsystem sub-core, is DisplayPort in TX mode of operation. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver Who Date Changes
</p>
<hr/>
<p>
1.00 sha 01/29/15 Initial release.
1.00 sha 07/21/15 Renamed file name with prefix xdptxss_*, function
names with prefix XDpTxSs_* and macros with prefix
XDPTXSS_*
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adad4d510c1fc417549252879990486c1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdptxss__dptx_8h.html#adad4d510c1fc417549252879990486c1">XDPTXSS_DPTX_H_</a></td></tr>
<tr class="memdesc:adad4d510c1fc417549252879990486c1"><td class="mdescLeft"> </td><td class="mdescRight">Prevent circular inclusions by using protection macros. <a href="#adad4d510c1fc417549252879990486c1">More...</a><br/></td></tr>
<tr class="separator:adad4d510c1fc417549252879990486c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f557b79a4d7d8a046d331db3121f162"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdptxss__dptx_8h.html#a2f557b79a4d7d8a046d331db3121f162">XDPTXSS_DPTX_MST</a>   1</td></tr>
<tr class="memdesc:a2f557b79a4d7d8a046d331db3121f162"><td class="mdescLeft"> </td><td class="mdescRight">Multi-Stream Transport. <a href="#a2f557b79a4d7d8a046d331db3121f162">More...</a><br/></td></tr>
<tr class="separator:a2f557b79a4d7d8a046d331db3121f162"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02f2b280a1b516b73a501032ae4b68d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdptxss__dptx_8h.html#a02f2b280a1b516b73a501032ae4b68d4">XDPTXSS_DPTX_SST</a>   0</td></tr>
<tr class="memdesc:a02f2b280a1b516b73a501032ae4b68d4"><td class="mdescLeft"> </td><td class="mdescRight">Single Stream Transport. <a href="#a02f2b280a1b516b73a501032ae4b68d4">More...</a><br/></td></tr>
<tr class="separator:a02f2b280a1b516b73a501032ae4b68d4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aaa03d99159fd8797f71c448fd7bd20c9"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xdptxss__dptx_8h.html#aaa03d99159fd8797f71c448fd7bd20c9">XDpTxSs_DpTxStart</a> (XDp *InstancePtr, u8 TransportMode, u8 Bpc, XVidC_VideoMode VidMode)</td></tr>
<tr class="memdesc:aaa03d99159fd8797f71c448fd7bd20c9"><td class="mdescLeft"> </td><td class="mdescRight">This function configures DisplayPort sub-core with preferred resolution read from sink or user set resolution, bits per color in SST/MST mode. <a href="#aaa03d99159fd8797f71c448fd7bd20c9">More...</a><br/></td></tr>
<tr class="separator:aaa03d99159fd8797f71c448fd7bd20c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15749657798c249a36a4c63991129c30"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xdptxss__dptx_8h.html#a15749657798c249a36a4c63991129c30">XDpTxSs_DpTxStartLink</a> (XDp *InstancePtr, u8 TrainMaxCap)</td></tr>
<tr class="memdesc:a15749657798c249a36a4c63991129c30"><td class="mdescLeft"> </td><td class="mdescRight">This function checks if the link needs training and runs the training sequence if training is required based on the flags, indicates to use maximum RX capabilities or user specified link rate, lane count during training. <a href="#a15749657798c249a36a4c63991129c30">More...</a><br/></td></tr>
<tr class="separator:a15749657798c249a36a4c63991129c30"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="adad4d510c1fc417549252879990486c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDPTXSS_DPTX_H_</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prevent circular inclusions by using protection macros. </p>
</div>
</div>
<a class="anchor" id="a2f557b79a4d7d8a046d331db3121f162"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDPTXSS_DPTX_MST   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Multi-Stream Transport. </p>
<p>Referenced by <a class="el" href="xdptxss__dptx_8h.html#aaa03d99159fd8797f71c448fd7bd20c9">XDpTxSs_DpTxStart()</a>.</p>
</div>
</div>
<a class="anchor" id="a02f2b280a1b516b73a501032ae4b68d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDPTXSS_DPTX_SST   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Single Stream Transport. </p>
<p>Referenced by <a class="el" href="xdptxss__dptx_8h.html#aaa03d99159fd8797f71c448fd7bd20c9">XDpTxSs_DpTxStart()</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aaa03d99159fd8797f71c448fd7bd20c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XDpTxSs_DpTxStart </td>
<td>(</td>
<td class="paramtype">XDp * </td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8 </td>
<td class="paramname"><em>TransportMode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8 </td>
<td class="paramname"><em>Bpc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XVidC_VideoMode </td>
<td class="paramname"><em>VidMode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function configures DisplayPort sub-core with preferred resolution read from sink or user set resolution, bits per color in SST/MST mode. </p>
<p>In MST mode, if sinks are more than two, it re-orders the sinks if belongs to same tiled display topology. It trains the link and allocates stream payloads for single stream (SST) or multi-stream transport mode (MST). In MST mode, discovers the topology and finds the actual number of sinks to which associates streams.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the XDp instance. </td></tr>
<tr><td class="paramname">TransportMode</td><td>specifies whether multiple/single steam to be sent over the main link.<ul>
<li>TransportMode = 1 (for Multi-Stream Transport)</li>
<li>TransportMode = 0 (for Single Stream Transport) </li>
</ul>
</td></tr>
<tr><td class="paramname">Bpc</td><td>is the new number of bits per color to use. </td></tr>
<tr><td class="paramname">VidMode</td><td>is one of the enumerated standard video modes defined in xvidc.h file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS DisplayPort configured successfully.</li>
<li>XST_FAILURE if DisplayPort configuration failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
<p>< The payload bandwidth number (PBN) associated with the sink connected to this port.</p>
<p>< The available PBN of the sink connected to this port. </p>
<p>References <a class="el" href="xdptxss__dptx_8h.html#a2f557b79a4d7d8a046d331db3121f162">XDPTXSS_DPTX_MST</a>, <a class="el" href="xdptxss__dptx_8h.html#a02f2b280a1b516b73a501032ae4b68d4">XDPTXSS_DPTX_SST</a>, and <a class="el" href="xdptxss__dptx_8c.html#a15749657798c249a36a4c63991129c30">XDpTxSs_DpTxStartLink()</a>.</p>
<p>Referenced by <a class="el" href="group__dptxss.html#ga883ba3d77b48aaaee5858de1e5620c76">XDpTxSs_Start()</a>, and <a class="el" href="group__dptxss.html#ga51a71c98f5346be40c4c76e091e121f8">XDpTxSs_StartCustomMsa()</a>.</p>
</div>
</div>
<a class="anchor" id="a15749657798c249a36a4c63991129c30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XDpTxSs_DpTxStartLink </td>
<td>(</td>
<td class="paramtype">XDp * </td>
<td class="paramname"><em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8 </td>
<td class="paramname"><em>TrainMaxCap</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function checks if the link needs training and runs the training sequence if training is required based on the flags, indicates to use maximum RX capabilities or user specified link rate, lane count during training. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">InstancePtr</td><td>is a pointer to the XDp instance. </td></tr>
<tr><td class="paramname">TrainMaxCap</td><td>is a flag indicates whether maximum capabilities to be used during link training.<ul>
<li>TRUE - Use maximum RX capabilities.</li>
<li>FALSE - Use custom capabilities.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS the if main link was successfully established.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
<p>Referenced by <a class="el" href="xdptxss__dptx_8h.html#aaa03d99159fd8797f71c448fd7bd20c9">XDpTxSs_DpTxStart()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<p class="footer">© Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
<p class="footer">© Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>