421 lines
21 KiB
HTML
421 lines
21 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
xdprx.c File 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 Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li id="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul></div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul></div>
|
|
<h1>xdprx.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Contains a minimal set of functions for the <a class="el" href="struct_x_dprx.html">XDprx</a> driver that allow access to all of the DisplayPort RX core's functionality. See <a class="el" href="xdprx_8h.html">xdprx.h</a> for a detailed description of the driver.<p>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None.</dd></dl>
|
|
<pre>
|
|
MODIFICATION HISTORY:</pre><p>
|
|
<pre> Ver Who Date Changes
|
|
----- ---- -------- -----------------------------------------------
|
|
1.0 als 01/20/14 Initial release.
|
|
</pre>
|
|
<p>
|
|
<code>#include "<a class="el" href="xdprx_8h.html">xdprx.h</a>"</code><br>
|
|
<code>#include "xstatus.h"</code><br>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#bcccfaff08a86c7c9dcb021457d97e8f">XDprx_CfgInitialize</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr, <a class="el" href="struct_x_dp___config.html">XDp_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#1cbc5cd2400f422b152271c3c4e771ce">XDprx_InitializeRx</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#cde778795d716815d43ce5166e7ebf38">XDprx_CheckLinkStatus</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#8c2acf2eed3f2c829ab943b626d79d91">XDprx_DtgEn</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#f0d8ec6701744a023b12158633b0dc84">XDprx_DtgDis</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#ad78f1951da1be560ff5286601e3fab2">XDprx_SetLinkRate</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr, u8 LinkRate)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#e3e69667dede66128aac5c2788f9a9eb">XDprx_SetLaneCount</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr, u8 LaneCount)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#4cabca03e6a328c433dc21302a49ba69">XDprx_SetUserPixelWidth</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr, u8 UserPixelWidth)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#1e67d4a2a6f504663e8c3471219cc9ca">XDprx_SetUserTimerHandler</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr, <a class="el" href="xdp_8h.html#b2ee8cde914736409c4b04146aa84462">XDp_TimerHandler</a> CallbackFunc, void *CallbackRef)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdprx_8c.html#6d13f667c29e0352d44f652dc7142ae8">XDprx_WaitUs</a> (<a class="el" href="struct_x_dprx.html">XDprx</a> *InstancePtr, u32 MicroSeconds)</td></tr>
|
|
|
|
</table>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="bcccfaff08a86c7c9dcb021457d97e8f"></a><!-- doxytag: member="xdprx.c::XDprx_CfgInitialize" ref="bcccfaff08a86c7c9dcb021457d97e8f" args="(XDprx *InstancePtr, XDp_Config *ConfigPtr, u32 EffectiveAddr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_CfgInitialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dp___config.html">XDp_Config</a> * </td>
|
|
<td class="paramname"> <em>ConfigPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>EffectiveAddr</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function retrieves the configuration for this DisplayPort RX instance and fills in the InstancePtr->Config structure.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="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><td valign="top"></td><td valign="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>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>Unexpected errors may occur if the address mapping is changed after this function is invoked. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="cde778795d716815d43ce5166e7ebf38"></a><!-- doxytag: member="xdprx.c::XDprx_CheckLinkStatus" ref="cde778795d716815d43ce5166e7ebf38" args="(XDprx *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XDprx_CheckLinkStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function checks if the reciever's internal registers indicate that link training has complete. That is, training has achieved channel equalization, symbol lock, and interlane alignment for all lanes currently in use.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS if the RX device has achieved clock recovery, channel equalization, symbol lock, and interlane alignment.</li><li>XST_FAILURE otherwise.</li></ul>
|
|
</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f0d8ec6701744a023b12158633b0dc84"></a><!-- doxytag: member="xdprx.c::XDprx_DtgDis" ref="f0d8ec6701744a023b12158633b0dc84" args="(XDprx *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_DtgDis </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function disables the display timing generator (DTG).<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8c2acf2eed3f2c829ab943b626d79d91"></a><!-- doxytag: member="xdprx.c::XDprx_DtgEn" ref="8c2acf2eed3f2c829ab943b626d79d91" args="(XDprx *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_DtgEn </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function enables the display timing generator (DTG).<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1cbc5cd2400f422b152271c3c4e771ce"></a><!-- doxytag: member="xdprx.c::XDprx_InitializeRx" ref="1cbc5cd2400f422b152271c3c4e771ce" args="(XDprx *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XDprx_InitializeRx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function prepares the DisplayPort RX core for use.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS if the DisplayPort RX core was successfully initialized.</li><li>XST_FAILURE otherwise.</li></ul>
|
|
</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e3e69667dede66128aac5c2788f9a9eb"></a><!-- doxytag: member="xdprx.c::XDprx_SetLaneCount" ref="e3e69667dede66128aac5c2788f9a9eb" args="(XDprx *InstancePtr, u8 LaneCount)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_SetLaneCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </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>LaneCount</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function sets the maximum lane count to be exposed in the RX device's DisplayPort Configuration Data (DPCD) registers.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LaneCount</em> </td><td>is the number of lanes to be used over the main link.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ad78f1951da1be560ff5286601e3fab2"></a><!-- doxytag: member="xdprx.c::XDprx_SetLinkRate" ref="ad78f1951da1be560ff5286601e3fab2" args="(XDprx *InstancePtr, u8 LinkRate)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_SetLinkRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </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>LinkRate</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function sets the maximum data rate to be exposed in the RX device's DisplayPort Configuration Data (DPCD) registers.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="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>XDPRX_LINK_BW_SET_162GBPS = 0x06 (for a 1.62 Gbps data rate)</li><li>XDPRX_LINK_BW_SET_270GBPS = 0x0A (for a 2.70 Gbps data rate)</li><li>XDPRX_LINK_BW_SET_540GBPS = 0x14 (for a 5.40 Gbps data rate)</li></ul>
|
|
</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4cabca03e6a328c433dc21302a49ba69"></a><!-- doxytag: member="xdprx.c::XDprx_SetUserPixelWidth" ref="4cabca03e6a328c433dc21302a49ba69" args="(XDprx *InstancePtr, u8 UserPixelWidth)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_SetUserPixelWidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </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>UserPixelWidth</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function configures the number of pixels output through the user data interface.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>UserPixelWidth</em> </td><td>is the user pixel width to be configured.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1e67d4a2a6f504663e8c3471219cc9ca"></a><!-- doxytag: member="xdprx.c::XDprx_SetUserTimerHandler" ref="1e67d4a2a6f504663e8c3471219cc9ca" args="(XDprx *InstancePtr, XDp_TimerHandler CallbackFunc, void *CallbackRef)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_SetUserTimerHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="xdp_8h.html#b2ee8cde914736409c4b04146aa84462">XDp_TimerHandler</a> </td>
|
|
<td class="paramname"> <em>CallbackFunc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>CallbackRef</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function installs a custom delay/sleep function to be used by the <a class="el" href="struct_x_dprx.html">XDprx</a> driver.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CallbackFunc</em> </td><td>is the address to the callback function. </td></tr>
|
|
<tr><td valign="top"></td><td valign="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>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6d13f667c29e0352d44f652dc7142ae8"></a><!-- doxytag: member="xdprx.c::XDprx_WaitUs" ref="6d13f667c29e0352d44f652dc7142ae8" args="(XDprx *InstancePtr, u32 MicroSeconds)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDprx_WaitUs </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dprx.html">XDprx</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>MicroSeconds</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function is the delay/sleep function for the <a class="el" href="struct_x_dprx.html">XDprx</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>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dprx.html">XDprx</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>MicroSeconds</em> </td><td>is the number of microseconds to delay/sleep for.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
|