-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
index.html
135 lines (135 loc) · 6.89 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!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>dp14txss: Main Page</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">dp14txss
</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 class="current"><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('index.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">dp14txss Documentation</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This is the main header file for Xilinx DisplayPort Transmitter Subsystem core. It abstracts Subsystem cores and provides high level API's to application developer.</p>
<p><b>Core Features</b></p>
<p>For a full description of DisplayPort Transmitter Subsystem core, please see the hardware specification.</p>
<p><b>Software Initialization & Configuration</b></p>
<p>The application needs to do following steps in order for preparing the DisplayPort Transmitter Subsystem core to be ready.</p>
<ul>
<li>Call XDpTxSs_LookupConfig using a device ID to find the core configuration.</li>
<li>Call XDpTxSs_CfgInitialize to initialize the device and the driver instance associated with it.</li>
</ul>
<p><b>Interrupts</b></p>
<p>The DisplayPort TX Subsystem driver provides the interrupt handlers</p>
<ul>
<li>XDpTxSs_DpIntrHandler</li>
<li>XDpTxSs_HdcpIntrHandler</li>
<li>XDpTxSs_TmrCtrIntrHandler, for handling the interrupt from the DisplayPort, optional HDCP and Timer Counter sub-cores respectively. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XDpTxSs_SetCallBack API.</li>
</ul>
<p><b>Virtual Memory</b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b>Threads</b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b>Asserts</b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
<p><b>Building the driver</b></p>
<p>The DisplayPort Transmitter Subsystem driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</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 Included renamed sub-cores header files.
2.00 sha 08/07/15 Added new handler types: lane count, link rate,
pre-emphasis voltage swing adjust and set MSA.
Added support for customized main stream attributes.
Added function: XDpTxSs_SetHasRedriverInPath.
Added HDCP support data structure.
2.00 sha 09/28/15 Added HDCP and Timer Counter functions.
3.0 sha 02/19/16 Added handler type as enums for HDCP:
XDPTXSS_HANDLER_HDCP_RPTR_DWN_STRM_RDY,
XDPTXSS_HANDLER_HDCP_RPTR_EXCHG.
Added function: XDpTxSs_ReadDownstream,
XDpTxSs_HandleTimeout.
4.0 aad 05/13/16 Expose API to set (a)synchronous clock mode from DP driver.
4.1 als 08/08/16 Synchronize with new HDCP APIs.
aad 09/06/16 Updates to support 64-bit base addresses.
ms 01/23/17 Modified xil_printf statement in main function for all
examples to ensure that "Successfully ran" and "Failed"
strings are available in all examples. This is a fix
for CR-965028.
ms 03/17/17 Modified readme.txt file in examples folder for doxygen
generation.
5.0 tu 08/10/17 Adjusted BS symbol for equal timing
5.0 tu 09/08/17 Added two interrupt handler that addresses driver's
internal callback function of application
DrvHpdEventHandler and DrvHpdPulseHandler
Added HPD user data stucture <a class="el" href="struct_x_dp_tx_ss___usr_hpd_pulse_data.html" title="HPD Pulse User Data structure. ">XDpTxSs_UsrHpdPulseData</a>
and <a class="el" href="struct_x_dp_tx_ss___usr_hpd_event_data.html" title="HPD Event User Data structure. ">XDpTxSs_UsrHpdEventData</a>
5.0 jb 02/21/19 Added HDCP22 support.
Made the Timer counter available for both HDCP1x and 22.
6.4 rg 09/01/20 Added handler type as enum for extended packet transmit
done interrupt.
6.4 rg 09/26/20 Added support for YUV420 color format.</pre><pre></pre> </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>