stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/XilinxProcessorIPLib/drivers/tpg/doc/html/api/xtpg_8c.html
Durga challa eccc20c71e tpg: Modified doxygen report 
Doxygen report is updated.

Signed-off-by: Durga challa <vnsldurg@xilinx.com>
Acked-by: Srikanth Vemula <svemula@xilinx.com>
2014-09-02 11:21:15 +05:30

1622 lines
81 KiB
HTML
Executable file
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xtpg.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&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>xtpg.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains the implementation of the interface functions for Test Pattern Generator (TPG) driver. Refer to the header file <a class="el" href="xtpg_8h.html">xtpg.h</a> for more detailed information.<p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
----- ------ -------- -------------------------------------------------------
1.00a se 10/01/12 Initial creation.
2.0 se 01/24/13 Cleaned up comments.
3.0 adk 02/19/14 Changed the file name form "tpg.c" to "xtpg.c".
Implemented the following functions:
XTpg_CfgInitialize, XTpg_Setup, XTpg_GetVersion,
XTpg_SetActiveSize, XTpg_GetActiveSize,
XTpg_SetBackground, XTpg_GetBackground,
XTpg_EnableCrossHair, XTpg_DisableCrossHair,
XTpg_EnableBox, XTpg_DisableBox, XTpg_SetComponentMask,
XTpg_GetComponentMask, XTpg_EnableStuckPixel,
XTpg_DisableStuckPixel, XTPg_EnableNoise,
XTPg_DisableNoise, XTpg_EnableMotion,
XTpg_DisableMotion, XTpg_SetMotionSpeed,
XTpg_GetMotionSpeed, XTpg_SetCrosshairPosition,
XTpg_GetCrosshairPosition, XTpg_SetZPlateHStart,
XTpg_GetZPlateHStart, XTpg_SetZPlateHSpeed,
XTpg_GetZPlateHSpeed, XTpg_SetZPlateVStart,
XTpg_GetZPlateVStart, XTpg_SetZPlateVSpeed,
XTpg_GetZPlateVSpeed, XTpg_SetBoxSize, XTpg_GetBoxSize,
XTpg_SetBoxColor, XTpg_GetBoxColor,
XTpg_SetStuckPixelThreshold,
XTpg_GetStuckPixelThreshold, XTpg_SetNoiseGain,
XTpg_GetNoiseGain, XTpg_SetBayerPhase,
XTpg_GetBayerPhase, XTpg_SetPattern, XTpg_GetPattern.</pre><p>
<pre> </pre>
<p>
<code>#include &quot;<a class="el" href="xtpg_8h.html">xtpg.h</a>&quot;</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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#698faaf2415afa23731f5b300dffd10f">XTpg_CfgInitialize</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, <a class="el" href="struct_x_tpg___config.html">XTpg_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#8d2a1715d79178d882947242bdadc6de">XTpg_Setup</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#55a55de9bc8e45cbd6cb6ccd914e6a7f">XTpg_GetVersion</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#443d73019e3e8f29e6ad1e661678f467">XTpg_SetActiveSize</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 HSize, u16 VSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#57155013bf0bb1be8a723b3fc3c36291">XTpg_GetActiveSize</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 *HSize, u16 *VSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#bbd4255a15fdc65701ac1f510d9a686e">XTpg_SetBackground</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, enum <a class="el" href="xtpg_8h.html#2e143ee9595509e9f14a379fd271606d">XTpg_BackgroundPattern</a> Pattern)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#926545a06de67862ef7e47f150398b1d">XTpg_GetBackground</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#bc862dbfd1852b1dad5b0d002a301d44">XTpg_EnableCrossHair</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#ce96009eea6ebfcd71bb91b5ff16ee93">XTpg_DisableCrossHair</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#bd33abd48691073cd4c97e8e8ecabe6c">XTpg_EnableBox</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#32b89243e5f5ef7a81178b8ac7a5c839">XTpg_DisableBox</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#f56158886e9a7035ca278a3f09719a35">XTpg_SetComponentMask</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, enum <a class="el" href="xtpg_8h.html#1f1917d8a17d4c602c86ebb711b50910">XTpg_ComponentMask</a> Mask)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#a64c3c09f85d0a9be69f95a55042f1a6">XTpg_GetComponentMask</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#1bed92a1e708eaba60da6422de9a39b6">XTpg_EnableStuckPixel</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#6a1145da55323ef7110e3b223550a1d4">XTpg_DisableStuckPixel</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#6ef195afeba30f1bd5e0161642053f4b">XTPg_EnableNoise</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#b970215d34b5a634debc562aac9b8160">XTPg_DisableNoise</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#d2cf13af361a9ee4a209bb1f6ed416d2">XTpg_EnableMotion</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#eaf136930153d53e9c409cbd678aff48">XTpg_DisableMotion</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#d60e72ebf07cb299f40c8d62b33035f7">XTpg_SetMotionSpeed</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u32 MotionSpeed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#0a97328739804518e64475233ae98103">XTpg_GetMotionSpeed</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#1a75c9bdad3e12c77b33a34f4caeaad8">XTpg_SetCrosshairPosition</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 HPos, u16 VPos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#dc3232cd715ac67bc7ac687b7eccc160">XTpg_GetCrosshairPosition</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 *HPos, u16 *VPos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#bdbd51a634cf14b6e4aecd4d10bb02d2">XTpg_SetZPlateHStart</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 ZPlateHStart)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#3c2504055b1745d04914578d2751c7b1">XTpg_GetZPlateHStart</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#3f8e4cb9ba82d5e0cd795115a90be70c">XTpg_SetZPlateHSpeed</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 ZPlateHSpeed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#cf98040119054a473c4142be893bac7e">XTpg_GetZPlateHSpeed</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#e65b702fac1b48c6a8c9a6c7cd4d300a">XTpg_SetZPlateVStart</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 ZPlateVStart)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#a87dda13d4eed857bff5e652d6b8c86c">XTpg_GetZPlateVStart</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#40326b8e25f4fe2d5f270f841bc47ece">XTpg_SetZPlateVSpeed</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 ZPlateVSpeed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#8b60fc34e62837b38f417e71885377ca">XTpg_GetZPlateVSpeed</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#a27f2faddfd8c184687a7cd70ac71ad4">XTpg_SetBoxSize</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u32 BoxSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#06ff7179299fcc305e52b0c70527caba">XTpg_GetBoxSize</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#b37f41e5b55568b965bac4adbd8212ab">XTpg_SetBoxColor</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 Blue, u16 Green, u16 Red)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#5959231490808cb1d84528f8157b077b">XTpg_GetBoxColor</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u16 *Blue, u16 *Green, u16 *Red)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#5fd07581e1d4d647153f6f7aceac999d">XTpg_SetStuckPixelThreshold</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u32 PixelThreshold)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#cb1f626ac7c66c678fc21fe9bdcb9e02">XTpg_GetStuckPixelThreshold</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#fe20be225a9b43e342e0ccd11f0ae3c9">XTpg_SetNoiseGain</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u32 NoiseGain)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#d1c4aa5543691d012b272a1527ebccac">XTpg_GetNoiseGain</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#a0212da7460aae9993a9624dfa7a9006">XTpg_SetBayerPhase</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, enum <a class="el" href="xtpg_8h.html#cd31acaea34a0ee434bb96a76ab6c519">XTpg_BayerPhaseCombination</a> BayerPhaseComb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#5bb2f302ceb32b9862de7a9f4e034e0c">XTpg_GetBayerPhase</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#f6783b9a514ab1b0c6221e417052844c">XTpg_SetPattern</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr, u32 Pattern)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtpg_8c.html#6256661f2a9ab5e37bf4cf9be1992599">XTpg_GetPattern</a> (<a class="el" href="struct_x_tpg.html">XTpg</a> *InstancePtr)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="698faaf2415afa23731f5b300dffd10f"></a><!-- doxytag: member="xtpg.c::XTpg_CfgInitialize" ref="698faaf2415afa23731f5b300dffd10f" args="(XTpg *InstancePtr, XTpg_Config *CfgPtr, u32 EffectiveAddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XTpg_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</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_tpg___config.html">XTpg_Config</a> *&nbsp;</td>
<td class="paramname"> <em>CfgPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function initializes the TPG core. This function must be called prior to using the TPG core. Initialization of the TPG includes setting up the instance data and ensuring the hardware is in a quiescent state.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em>&nbsp;</td><td>is a reference to a structure containing information about a specific <a class="el" href="struct_x_tpg.html">XTpg</a> instace. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em>&nbsp;</td><td>is the core base address in the virtual memory address space. The caller is responsible for keeping the address mapping from EffectiveAddr to the core physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, pass in the physical address instead.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>- XST_SUCCESS if <a class="el" href="struct_x_tpg.html">XTpg</a> instance initialization was successful.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="32b89243e5f5ef7a81178b8ac7a5c839"></a><!-- doxytag: member="xtpg.c::XTpg_DisableBox" ref="32b89243e5f5ef7a81178b8ac7a5c839" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_DisableBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables the Moving Box feature in the Pattern Control Register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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="ce96009eea6ebfcd71bb91b5ff16ee93"></a><!-- doxytag: member="xtpg.c::XTpg_DisableCrossHair" ref="ce96009eea6ebfcd71bb91b5ff16ee93" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_DisableCrossHair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables the drawing of Cross Hairs feature in the Pattern Control Register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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="eaf136930153d53e9c409cbd678aff48"></a><!-- doxytag: member="xtpg.c::XTpg_DisableMotion" ref="eaf136930153d53e9c409cbd678aff48" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_DisableMotion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables the Motion feature in the Pattern Control register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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="b970215d34b5a634debc562aac9b8160"></a><!-- doxytag: member="xtpg.c::XTPg_DisableNoise" ref="b970215d34b5a634debc562aac9b8160" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTPg_DisableNoise </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables the Noise on the output by disabling this feature in Pattern Control register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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="6a1145da55323ef7110e3b223550a1d4"></a><!-- doxytag: member="xtpg.c::XTpg_DisableStuckPixel" ref="6a1145da55323ef7110e3b223550a1d4" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_DisableStuckPixel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables the Stuck Pixel feature in the Pattern Control register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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="bd33abd48691073cd4c97e8e8ecabe6c"></a><!-- doxytag: member="xtpg.c::XTpg_EnableBox" ref="bd33abd48691073cd4c97e8e8ecabe6c" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_EnableBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function enables the Moving Box feature in the Pattern Control Register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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><ul>
<li>XTpg_SetBoxSize API should be used for setting box size.</li><li>XTpg_SetBoxColor API should be used for setting box color. </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="bc862dbfd1852b1dad5b0d002a301d44"></a><!-- doxytag: member="xtpg.c::XTpg_EnableCrossHair" ref="bc862dbfd1852b1dad5b0d002a301d44" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_EnableCrossHair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function enables the drawing of Cross Hairs feature in the Pattern Control Register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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>To draw the Cross Hairs, the position of drawing must be set by using XTpg_SetCrosshairPosition. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d2cf13af361a9ee4a209bb1f6ed416d2"></a><!-- doxytag: member="xtpg.c::XTpg_EnableMotion" ref="d2cf13af361a9ee4a209bb1f6ed416d2" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_EnableMotion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function enables the Motion Feature in the Pattern Control register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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="6ef195afeba30f1bd5e0161642053f4b"></a><!-- doxytag: member="xtpg.c::XTPg_EnableNoise" ref="6ef195afeba30f1bd5e0161642053f4b" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTPg_EnableNoise </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function enables the Noise on the output by setting value in Pattern Control register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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>XTpg_SetNoiseGain API should be used to increase or decrease the noise produced on the output. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1bed92a1e708eaba60da6422de9a39b6"></a><!-- doxytag: member="xtpg.c::XTpg_EnableStuckPixel" ref="1bed92a1e708eaba60da6422de9a39b6" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_EnableStuckPixel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function enables the Stuck Pixel Feature in the Pattern Control Register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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>XTpg_SetStuckPixelThreshold API should be used to set Stuck Pixel threshold value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="57155013bf0bb1be8a723b3fc3c36291"></a><!-- doxytag: member="xtpg.c::XTpg_GetActiveSize" ref="57155013bf0bb1be8a723b3fc3c36291" args="(XTpg *InstancePtr, u16 *HSize, u16 *VSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_GetActiveSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>HSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>VSize</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the number of Active Pixel per Scan line and number of Active Lines per Frame from the Active Size register.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HSize</em>&nbsp;</td><td>is a pointer to 16-bit variable in which the number of Active Pixels per Scan Line is returned. (Range is 32 to 7680). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VSize</em>&nbsp;</td><td>is a pointer to 16-bit variable in which the number of Active Lines per Frame is returned. (Range is 32 to 7680). </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="926545a06de67862ef7e47f150398b1d"></a><!-- doxytag: member="xtpg.c::XTpg_GetBackground" ref="926545a06de67862ef7e47f150398b1d" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetBackground </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the background pattern for TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Background pattern is returned. The enum values for corresponding Background pattern value is<ul>
<li>0x0 XTPG_PASS_THROUGH- Pass video input straight video output</li><li>0x1 XTPG_H_RAMP - Horizontal ramp</li><li>0x2 XTPG_V_RAMP - Vertical ramp</li><li>0x3 XTPG_R_RAMP - Temporal ramp</li><li>0x4 XTPG_RED_PLANE - Solid red output</li><li>0x5 XTPG_GREEN_PLANE - Solid green output</li><li>0x6 XTPG_BLUE_PLANE - Solid blue output</li><li>0x7 XTPG_BLACK_PLANE - Solid black output</li><li>0x8 XTPG_WHITE_PLANE - Solid white output</li><li>0x9 XTPG_COLOR_BARS - Color bars</li><li>0xA XTPG_ZONE_PLATE - Zone plate output (sinusoidal)</li><li>0xB XTPG_TARAN_BARS - Tartan color bars</li><li>0xC XTPG_CROSS_HATCH - Cross hatch pattern</li><li>0xE XTPG_HV_RAMP - Horizontal vertical ramp</li><li>0xF XTPG_BLACK_AND_WHITE_CHECKERBOARD - Black and white checker board</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5bb2f302ceb32b9862de7a9f4e034e0c"></a><!-- doxytag: member="xtpg.c::XTpg_GetBayerPhase" ref="5bb2f302ceb32b9862de7a9f4e034e0c" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetBayerPhase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the Bayer phase value which indicates starting pixel position.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>BayerPhase is the starting pixel indicator is returned. Corresponding enum values for Bayer Phase are:<ul>
<li>Bayer Phase 0 - XTPG_BAYER_PHASE_RGRG.</li><li>Bayer Phase 1 - XTPG_BAYER_PHASE_GRGR.</li><li>Bayer Phase 2 - XTPG_BAYER_PHASE_GBGB.</li><li>Bayer Phase 3 - XTPG_BAYER_PHASE_BGBG.</li><li>Bayer Phase 4 - XTPG_BAYER_PHASE_TURNOFF.</li><li>It is a double buffered register.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5959231490808cb1d84528f8157b077b"></a><!-- doxytag: member="xtpg.c::XTpg_GetBoxColor" ref="5959231490808cb1d84528f8157b077b" args="(XTpg *InstancePtr, u16 *Blue, u16 *Green, u16 *Red)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_GetBoxColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>Blue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>Green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>Red</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the color components of the box in the Box Color register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Blue</em>&nbsp;</td><td>is a pointer to 16 bit color component of the box in which blue or Y (for YCbCr mode) is returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Green</em>&nbsp;</td><td>is a pointer to 16 bit color component of the box in which Green or Cr (for YCbCr mode) is returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Red</em>&nbsp;</td><td>is a pointer to 16 bit color component of the box in which Red or Cb (for YCbCr mode) is returned.</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="06ff7179299fcc305e52b0c70527caba"></a><!-- doxytag: member="xtpg.c::XTpg_GetBoxSize" ref="06ff7179299fcc305e52b0c70527caba" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetBoxSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the Box Size in pixel.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>BoxSize is the size of a box in pixel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a64c3c09f85d0a9be69f95a55042f1a6"></a><!-- doxytag: member="xtpg.c::XTpg_GetComponentMask" ref="a64c3c09f85d0a9be69f95a55042f1a6" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetComponentMask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the color component mask status in the Pattern Control Register.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Color component value is returned. Corresponding enum values for Color component value is<ul>
<li>0x0 XTPG_NOMASK - No masking.</li><li>0x1 XTPG_MASKOUT_RED - Mask out red, Cr(for YCbCr mode) component.</li><li>0x2 XTPG_MASKOUT_GREE- Mask out green,N Y(for YCbCr mode) component.</li><li>0x4 XTPG_MASKOUT_BLUE- Mask out blue, Cb(for YCbCr mode) component.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="dc3232cd715ac67bc7ac687b7eccc160"></a><!-- doxytag: member="xtpg.c::XTpg_GetCrosshairPosition" ref="dc3232cd715ac67bc7ac687b7eccc160" args="(XTpg *InstancePtr, u16 *HPos, u16 *VPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_GetCrosshairPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>HPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>VPos</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the cross hair positions.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HPos</em>&nbsp;</td><td>is the row of the frame that will have horizontal line of Cross Hairs is returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VPos</em>&nbsp;</td><td>is the column of the frame that will have vertical line of Cross Hairs is returned.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0a97328739804518e64475233ae98103"></a><!-- doxytag: member="xtpg.c::XTpg_GetMotionSpeed" ref="0a97328739804518e64475233ae98103" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetMotionSpeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the Motion Speed.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>MotionSpeed, which indicates the speed that affects on test pattern changes from frame to frame is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d1c4aa5543691d012b272a1527ebccac"></a><!-- doxytag: member="xtpg.c::XTpg_GetNoiseGain" ref="d1c4aa5543691d012b272a1527ebccac" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetNoiseGain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the noise gain of each component of TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>NoiseGain is a value to increase the noise added to each component.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6256661f2a9ab5e37bf4cf9be1992599"></a><!-- doxytag: member="xtpg.c::XTpg_GetPattern" ref="6256661f2a9ab5e37bf4cf9be1992599" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the contents of the Pattern Control Register.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Contents of the Pattern Control Register is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cb1f626ac7c66c678fc21fe9bdcb9e02"></a><!-- doxytag: member="xtpg.c::XTpg_GetStuckPixelThreshold" ref="cb1f626ac7c66c678fc21fe9bdcb9e02" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetStuckPixelThreshold </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the stuck pixel threshold in the STUCK_PIXEL_THRESH register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Stuck pixel threshold is an upper limit for PRNG for insertion of stuck pixel is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="55a55de9bc8e45cbd6cb6ccd914e6a7f"></a><!-- doxytag: member="xtpg.c::XTpg_GetVersion" ref="55a55de9bc8e45cbd6cb6ccd914e6a7f" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XTpg_GetVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the contents of the Version register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Content of Version register is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cf98040119054a473c4142be893bac7e"></a><!-- doxytag: member="xtpg.c::XTpg_GetZPlateHSpeed" ref="cf98040119054a473c4142be893bac7e" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XTpg_GetZPlateHSpeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets how fast (the speed of) horizontal component changes.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>ZPlateHSpeed is speed of the horizontal component changes is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3c2504055b1745d04914578d2751c7b1"></a><!-- doxytag: member="xtpg.c::XTpg_GetZPlateHStart" ref="3c2504055b1745d04914578d2751c7b1" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XTpg_GetZPlateHStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets a starting point in the ROM based sinusoidal values for the horizontal component.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>ZPlateHStart is starting point in the ROM based sinusoidal value for horizontal component is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8b60fc34e62837b38f417e71885377ca"></a><!-- doxytag: member="xtpg.c::XTpg_GetZPlateVSpeed" ref="8b60fc34e62837b38f417e71885377ca" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XTpg_GetZPlateVSpeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets how fast (the speed of) the vertical component changes.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>ZPlateVSpeed is a 16 bit variable the speed of the vertical component changes is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a87dda13d4eed857bff5e652d6b8c86c"></a><!-- doxytag: member="xtpg.c::XTpg_GetZPlateVStart" ref="a87dda13d4eed857bff5e652d6b8c86c" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 XTpg_GetZPlateVStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets a starting point in the ROM based sinusoidal values for the vertical component.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>ZPlateVStart is starting point in the ROM based sinusoidal value for vertical component is returned.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="443d73019e3e8f29e6ad1e661678f467"></a><!-- doxytag: member="xtpg.c::XTpg_SetActiveSize" ref="443d73019e3e8f29e6ad1e661678f467" args="(XTpg *InstancePtr, u16 HSize, u16 VSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetActiveSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>HSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>VSize</em></td><td>&nbsp;</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 active H/V sizes in the Active Size register.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HSize</em>&nbsp;</td><td>specifies the number of Active Pixels per Scan Line that needs to be set (Range is 32 to 7680). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VSize</em>&nbsp;</td><td>specifies the number of Active Lines per Frame that needs to be set (Range is 32 to 7680).</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="bbd4255a15fdc65701ac1f510d9a686e"></a><!-- doxytag: member="xtpg.c::XTpg_SetBackground" ref="bbd4255a15fdc65701ac1f510d9a686e" args="(XTpg *InstancePtr, enum XTpg_BackgroundPattern Pattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetBackground </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="xtpg_8h.html#2e143ee9595509e9f14a379fd271606d">XTpg_BackgroundPattern</a>&nbsp;</td>
<td class="paramname"> <em>Pattern</em></td><td>&nbsp;</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 background pattern in the Pattern Control Register.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Pattern</em>&nbsp;</td><td>is the pattern to be generated. The enum values to be used for the patterns are :<ul>
<li>XTPG_PASS_THROUGH- Pass video input straight through the video output</li><li>XTPG_H_RAMP - Horizontal ramp</li><li>XTPG_V_RAMP - Vertical ramp</li><li>XTPG_R_RAMP - Temporal ramp</li><li>XTPG_RED_PLANE - Solid red output</li><li>XTPG_GREEN_PLANE - Solid green output</li><li>XTPG_BLUE_PLANE - Solid blue output</li><li>XTPG_BLACK_PLANE - Solid black output</li><li>XTPG_WHITE_PLANE - Solid white output</li><li>XTPG_COLOR_BARS - Color bars</li><li>XTPG_ZONE_PLATE - Zone plate output(sinusoidal)</li><li>XTPG_TARAN_BARS - Tartan color bars</li><li>XTPG_CROSS_HATCH - Cross hatch pattern</li><li>XTPG_HV_RAMP - Horizontal vertical ramp</li><li>XTPG_BLACK_AND_WHITE_CHECKERBOARD - Black and white checker board</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="a0212da7460aae9993a9624dfa7a9006"></a><!-- doxytag: member="xtpg.c::XTpg_SetBayerPhase" ref="a0212da7460aae9993a9624dfa7a9006" args="(XTpg *InstancePtr, enum XTpg_BayerPhaseCombination BayerPhaseComb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetBayerPhase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="xtpg_8h.html#cd31acaea34a0ee434bb96a76ab6c519">XTpg_BayerPhaseCombination</a>&nbsp;</td>
<td class="paramname"> <em>BayerPhaseComb</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function specifies or sets whether the starting position pixel(0,0) of the Bayer sampling grid is on a red-green or blue-green line and whether the first pixel is green or not.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BayerPhaseComb</em>&nbsp;</td><td>is Bayer phase value to be set to identify starting pixel position. The enum values of Bayer phase are<ul>
<li>Bayer Phase 0 - XTPG_BAYER_PHASE_RGRG.</li><li>Bayer Phase 1 - XTPG_BAYER_PHASE_GRGR.</li><li>Bayer Phase 2 - XTPG_BAYER_PHASE_GBGB.</li><li>Bayer Phase 3 - XTPG_BAYER_PHASE_BGBG.</li><li>Bayer Phase 4 - XTPG_BAYER_PHASE_TURNOFF.</li><li>It is a double buffered register.</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="b37f41e5b55568b965bac4adbd8212ab"></a><!-- doxytag: member="xtpg.c::XTpg_SetBoxColor" ref="b37f41e5b55568b965bac4adbd8212ab" args="(XTpg *InstancePtr, u16 Blue, u16 Green, u16 Red)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetBoxColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>Blue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>Green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>Red</em></td><td>&nbsp;</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 color components of the box in the Box Color register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Blue</em>&nbsp;</td><td>is the color component of the box which needs to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Green</em>&nbsp;</td><td>is the color component of the box which needs to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Red</em>&nbsp;</td><td>is the color component of the box which needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>XTpg_EnableBox API should be used to enable the Box feature. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a27f2faddfd8c184687a7cd70ac71ad4"></a><!-- doxytag: member="xtpg.c::XTpg_SetBoxSize" ref="a27f2faddfd8c184687a7cd70ac71ad4" args="(XTpg *InstancePtr, u32 BoxSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XTpg_SetBoxSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>BoxSize</em></td><td>&nbsp;</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 Box Size.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BoxSize</em>&nbsp;</td><td>is size of the box in pixel.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>-XST_SUCCESS if BoxSize is less than active size. -XST_FAILURE if BoxSize is greater than active size.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>The size of the box has to be set smaller than the frame size that is set in the ACTIVE_SIZE register.</li><li>XTpg_EnableBox API should be used to enable the Box feature. </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="f56158886e9a7035ca278a3f09719a35"></a><!-- doxytag: member="xtpg.c::XTpg_SetComponentMask" ref="f56158886e9a7035ca278a3f09719a35" args="(XTpg *InstancePtr, enum XTpg_ComponentMask Mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetComponentMask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="xtpg_8h.html#1f1917d8a17d4c602c86ebb711b50910">XTpg_ComponentMask</a>&nbsp;</td>
<td class="paramname"> <em>Mask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function masks out the specified color component by setting the Pattern Control Register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mask</em>&nbsp;</td><td>specifies the ComponentMask that needs to be set. the enum values as<ul>
<li>XTPG_NOMASK, - No masking.</li><li>XTPG_MASKOUT_RED, - Mask out red, Cr(for YCbCr mode) component.</li><li>XTPG_MASKOUT_GREEN, - Mask out green, Y(for YCbCr mode) component.</li><li>XTPG_MASKOUT_BLUE - Mask out blue, Cb(for YCbCr mode) component.</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="1a75c9bdad3e12c77b33a34f4caeaad8"></a><!-- doxytag: member="xtpg.c::XTpg_SetCrosshairPosition" ref="1a75c9bdad3e12c77b33a34f4caeaad8" args="(XTpg *InstancePtr, u16 HPos, u16 VPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetCrosshairPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>HPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>VPos</em></td><td>&nbsp;</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 Cross Hairs Positions.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HPos</em>&nbsp;</td><td>is the row of the frame that will have horizontal line of Cross Hairs that need to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VPos</em>&nbsp;</td><td>is the column of the frame that will have vertical line of Cross Hairs that need to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Cross hair feature should be enabled by using the API XTpg_EnableCrossHair </dd></dl>
</div>
</div><p>
<a class="anchor" name="d60e72ebf07cb299f40c8d62b33035f7"></a><!-- doxytag: member="xtpg.c::XTpg_SetMotionSpeed" ref="d60e72ebf07cb299f40c8d62b33035f7" args="(XTpg *InstancePtr, u32 MotionSpeed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetMotionSpeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>MotionSpeed</em></td><td>&nbsp;</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 Motion Speed.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MotionSpeed</em>&nbsp;</td><td>is how fast the temporal features of supported test pattern changes from frame to frame which need to be set. Range is 0 to 255.</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="fe20be225a9b43e342e0ccd11f0ae3c9"></a><!-- doxytag: member="xtpg.c::XTpg_SetNoiseGain" ref="fe20be225a9b43e342e0ccd11f0ae3c9" args="(XTpg *InstancePtr, u32 NoiseGain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetNoiseGain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>NoiseGain</em></td><td>&nbsp;</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 noise gain in Noise Gain register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>NoiseGain</em>&nbsp;</td><td>is a value to increase the noise added to each component which needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>- XTPg_EnableNoise API should be used to enable Noise feature. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f6783b9a514ab1b0c6221e417052844c"></a><!-- doxytag: member="xtpg.c::XTpg_SetPattern" ref="f6783b9a514ab1b0c6221e417052844c" args="(XTpg *InstancePtr, u32 Pattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Pattern</em></td><td>&nbsp;</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 Pattern Control Register of TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Pattern</em>&nbsp;</td><td>is the 32 bit value to be written to the Pattern Control Register.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This API is used for writing the complete Pattern Control Register. Use the following APIs for the individual patterns separately<ul>
<li>XTpg_SetBackground</li><li>XTpg_EnableCrossHair</li><li>XTpg_DisableCrossHair</li><li>XTpg_EnableBox</li><li>XTpg_DisableBox</li><li>XTpg_SetComponentMask</li><li>XTpg_EnableStuckPixel</li><li>XTpg_DisableStuckPixel</li><li>XTPg_EnableNoise</li><li>XTPg_DisableNoise</li><li>XTpg_EnableMotion</li><li>XTpg_DisableMotion </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="5fd07581e1d4d647153f6f7aceac999d"></a><!-- doxytag: member="xtpg.c::XTpg_SetStuckPixelThreshold" ref="5fd07581e1d4d647153f6f7aceac999d" args="(XTpg *InstancePtr, u32 PixelThreshold)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetStuckPixelThreshold </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>PixelThreshold</em></td><td>&nbsp;</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 stuck pixel threshold in STUCK_PIXEL_THRESH register of the TPG core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>PixelThreshold</em>&nbsp;</td><td>is an upper limit for PRNG for insertion of stuck pixel which needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>- XTpg_EnableStuckPixel API should be used to enable Stuck Pixel threshold value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8d2a1715d79178d882947242bdadc6de"></a><!-- doxytag: member="xtpg.c::XTpg_Setup" ref="8d2a1715d79178d882947242bdadc6de" args="(XTpg *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_Setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the input/output frame size in Active Size register and enables the register update.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</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="3f8e4cb9ba82d5e0cd795115a90be70c"></a><!-- doxytag: member="xtpg.c::XTpg_SetZPlateHSpeed" ref="3f8e4cb9ba82d5e0cd795115a90be70c" args="(XTpg *InstancePtr, u16 ZPlateHSpeed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetZPlateHSpeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>ZPlateHSpeed</em></td><td>&nbsp;</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 how fast (the speed of) the horizontal component changes.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ZPlateHSpeed</em>&nbsp;</td><td>is the speed of the horizontal component changes which need to be set.</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="bdbd51a634cf14b6e4aecd4d10bb02d2"></a><!-- doxytag: member="xtpg.c::XTpg_SetZPlateHStart" ref="bdbd51a634cf14b6e4aecd4d10bb02d2" args="(XTpg *InstancePtr, u16 ZPlateHStart)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetZPlateHStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>ZPlateHStart</em></td><td>&nbsp;</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 a starting point in the ROM based sinusoidal values for the horizontal component.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ZPlateHStart</em>&nbsp;</td><td>is starting point in the ROM based sinusoidal value for horizontal component.</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="40326b8e25f4fe2d5f270f841bc47ece"></a><!-- doxytag: member="xtpg.c::XTpg_SetZPlateVSpeed" ref="40326b8e25f4fe2d5f270f841bc47ece" args="(XTpg *InstancePtr, u16 ZPlateVSpeed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetZPlateVSpeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>ZPlateVSpeed</em></td><td>&nbsp;</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 how fast (the speed of) the vertical component changes.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ZPlateVSpeed</em>&nbsp;</td><td>is the speed of the vertical component changes which need to be set.</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="e65b702fac1b48c6a8c9a6c7cd4d300a"></a><!-- doxytag: member="xtpg.c::XTpg_SetZPlateVStart" ref="e65b702fac1b48c6a8c9a6c7cd4d300a" args="(XTpg *InstancePtr, u16 ZPlateVStart)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XTpg_SetZPlateVStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_tpg.html">XTpg</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>ZPlateVStart</em></td><td>&nbsp;</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 a starting point in the ROM based sinusoidal values for the vertical component.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ZPlateVStart</em>&nbsp;</td><td>is starting point in the ROM based sinusoidal value for vertical component which need to be set.</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.
Reference in a new issue View git blame Copy permalink