stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/XilinxProcessorIPLib/drivers/dptx/doc/html/struct_x_dptx.html
Andrei Simion faa2628852 dptx: Intial commit. 
Initial DisplayPort TX driver submission. Currently, only supporting SST.

Signed-off-by: Andrei-Liviu Simion <andrei.simion@xilinx.com>
2014-09-02 11:20:52 +05:30

257 lines
12 KiB
HTML
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
XDptx Struct Reference
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul></div>
<h1>XDptx Struct Reference</h1><!-- doxytag: class="XDptx" --><code>#include &lt;xdptx.h&gt;</code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="struct_x_dptx.html">XDptx</a> driver instance data. The user is required to allocate a variable of this type for every <a class="el" href="struct_x_dptx.html">XDptx</a> device in the system. A pointer to a variable of this type is then passed to the driver API functions.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#fd956a307a852de5554532ee69c05189">IsReady</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#cec7536fbd35b65e8ef4bba747753408">TrainAdaptive</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#b730a9890ab4e02b36bdf615bd5882f1">HasRedriverInPath</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_dptx___config.html">XDptx_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#276d2ab25040fac62fbffaafe4ae023b">TxConfig</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_dptx___sink_config.html">XDptx_SinkConfig</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#939b973272c6b24c902ea836517440b2">RxConfig</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_dptx___link_config.html">XDptx_LinkConfig</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#c9d9cfcf43fc735b778a4e0b8248d8c6">LinkConfig</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_dptx___main_stream_attributes.html">XDptx_MainStreamAttributes</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#b3e96d1c28a2813865576ff5cbf9f8c2">MsaConfig</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XDptx_TimerHandler&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#67a7c4a7e698ddb155ceaccbf196e82d">UserTimerWaitUs</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#fbdd98ca9563d3f2fc595ea2d6f6053b">UserTimerPtr</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XDptx_HpdEventHandler&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#4bd8c670700d25dac8b2afa8fbce70d4">HpdEventHandler</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#c27591bcf8d7e13e7b3fdbeb1f968c63">HpdEventCallbackRef</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XDptx_HpdPulseHandler&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#519eb0dcb081b7253765ab9593d43b35">HpdPulseHandler</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dptx.html#2828e9b3c75f6941d4771aadc156a644">HpdPulseCallbackRef</a></td></tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="b730a9890ab4e02b36bdf615bd5882f1"></a><!-- doxytag: member="XDptx::HasRedriverInPath" ref="b730a9890ab4e02b36bdf615bd5882f1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 <a class="el" href="struct_x_dptx.html#b730a9890ab4e02b36bdf615bd5882f1">XDptx::HasRedriverInPath</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Redriver in path requires different voltage swing and pre-emphasis.
</div>
</div><p>
<a class="anchor" name="c27591bcf8d7e13e7b3fdbeb1f968c63"></a><!-- doxytag: member="XDptx::HpdEventCallbackRef" ref="c27591bcf8d7e13e7b3fdbeb1f968c63" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="struct_x_dptx.html#c27591bcf8d7e13e7b3fdbeb1f968c63">XDptx::HpdEventCallbackRef</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A pointer to the user data passed to the HPD event callback function.
</div>
</div><p>
<a class="anchor" name="4bd8c670700d25dac8b2afa8fbce70d4"></a><!-- doxytag: member="XDptx::HpdEventHandler" ref="4bd8c670700d25dac8b2afa8fbce70d4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XDptx_HpdEventHandler <a class="el" href="struct_x_dptx.html#4bd8c670700d25dac8b2afa8fbce70d4">XDptx::HpdEventHandler</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback function for hot- plug-detect event interrupts.
</div>
</div><p>
<a class="anchor" name="2828e9b3c75f6941d4771aadc156a644"></a><!-- doxytag: member="XDptx::HpdPulseCallbackRef" ref="2828e9b3c75f6941d4771aadc156a644" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="struct_x_dptx.html#2828e9b3c75f6941d4771aadc156a644">XDptx::HpdPulseCallbackRef</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A pointer to the user data passed to the HPD pulse callback function.
</div>
</div><p>
<a class="anchor" name="519eb0dcb081b7253765ab9593d43b35"></a><!-- doxytag: member="XDptx::HpdPulseHandler" ref="519eb0dcb081b7253765ab9593d43b35" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XDptx_HpdPulseHandler <a class="el" href="struct_x_dptx.html#519eb0dcb081b7253765ab9593d43b35">XDptx::HpdPulseHandler</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback function for hot- plug-detect pulse interrupts.
</div>
</div><p>
<a class="anchor" name="fd956a307a852de5554532ee69c05189"></a><!-- doxytag: member="XDptx::IsReady" ref="fd956a307a852de5554532ee69c05189" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="struct_x_dptx.html#fd956a307a852de5554532ee69c05189">XDptx::IsReady</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Device is initialized and ready.
</div>
</div><p>
<a class="anchor" name="c9d9cfcf43fc735b778a4e0b8248d8c6"></a><!-- doxytag: member="XDptx::LinkConfig" ref="c9d9cfcf43fc735b778a4e0b8248d8c6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_dptx___link_config.html">XDptx_LinkConfig</a> <a class="el" href="struct_x_dptx.html#c9d9cfcf43fc735b778a4e0b8248d8c6">XDptx::LinkConfig</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Configuration structure for the main link.
</div>
</div><p>
<a class="anchor" name="b3e96d1c28a2813865576ff5cbf9f8c2"></a><!-- doxytag: member="XDptx::MsaConfig" ref="b3e96d1c28a2813865576ff5cbf9f8c2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_dptx___main_stream_attributes.html">XDptx_MainStreamAttributes</a> <a class="el" href="struct_x_dptx.html#b3e96d1c28a2813865576ff5cbf9f8c2">XDptx::MsaConfig</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Configuration structure for the main stream attributes.
</div>
</div><p>
<a class="anchor" name="939b973272c6b24c902ea836517440b2"></a><!-- doxytag: member="XDptx::RxConfig" ref="939b973272c6b24c902ea836517440b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_dptx___sink_config.html">XDptx_SinkConfig</a> <a class="el" href="struct_x_dptx.html#939b973272c6b24c902ea836517440b2">XDptx::RxConfig</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Configuration structure for the sink.
</div>
</div><p>
<a class="anchor" name="cec7536fbd35b65e8ef4bba747753408"></a><!-- doxytag: member="XDptx::TrainAdaptive" ref="cec7536fbd35b65e8ef4bba747753408" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 <a class="el" href="struct_x_dptx.html#cec7536fbd35b65e8ef4bba747753408">XDptx::TrainAdaptive</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Downshift lane count and link rate if necessary during training.
</div>
</div><p>
<a class="anchor" name="276d2ab25040fac62fbffaafe4ae023b"></a><!-- doxytag: member="XDptx::TxConfig" ref="276d2ab25040fac62fbffaafe4ae023b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_dptx___config.html">XDptx_Config</a> <a class="el" href="struct_x_dptx.html#276d2ab25040fac62fbffaafe4ae023b">XDptx::TxConfig</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Configuration structure for the core.
</div>
</div><p>
<a class="anchor" name="fbdd98ca9563d3f2fc595ea2d6f6053b"></a><!-- doxytag: member="XDptx::UserTimerPtr" ref="fbdd98ca9563d3f2fc595ea2d6f6053b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="struct_x_dptx.html#fbdd98ca9563d3f2fc595ea2d6f6053b">XDptx::UserTimerPtr</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pointer to a timer instance used by the custom user delay/sleep function.
</div>
</div><p>
<a class="anchor" name="67a7c4a7e698ddb155ceaccbf196e82d"></a><!-- doxytag: member="XDptx::UserTimerWaitUs" ref="67a7c4a7e698ddb155ceaccbf196e82d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XDptx_TimerHandler <a class="el" href="struct_x_dptx.html#67a7c4a7e698ddb155ceaccbf196e82d">XDptx::UserTimerWaitUs</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Custom user function for delay/sleep.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xdptx.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
Reference in a new issue View git blame Copy permalink