</pre></div>This function macro disables the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</pre></div>This function macro enables the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
(IntrType) & ((u32)(<aclass="code"href="xtpg__hw_8h.html#1ea4ea36d109c8d16cfcf0ccc6c648d0">XTPG_IXR_ALLINTR_MASK</a>)))
</pre></div>This function macro clears/acknowledges pending interrupts of the TPG core in the Status register. Bit positions of 1 will be cleared.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IntrType</em> </td><td>is the pending interrupts to clear/acknowledge. Use OR'ing of XTPG_IXR_*_MASK constants defined in <aclass="el"href="xtpg__hw_8h.html">xtpg_hw.h</a> to create this parameter value.</td></tr>
</pre></div>This function macro disables individual interrupts of the TPG core by updating the IRQ_ENABLE register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IntrType</em> </td><td>is the bit-mask of the interrupts to be disabled. Bit positions of 1 will be disabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XTPG_IXR_*_MASK bits defined in <aclass="el"href="xtpg__hw_8h.html">xtpg_hw.h</a>.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>Any other interrupt not covered by parameter IntrType, if enabled before this macro is called, will remain enabled. C-style signature: void <aclass="el"href="xtpg_8h.html#d2c673d9d4963ed7219769b437355595">XTpg_IntrDisable(XTpg *InstancePtr, u32 IntrType)</a></dd></dl>
</pre></div>This function macro enables individual interrupts of the TPG core by updating the IRQ_ENABLE register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>IntrType</em> </td><td>is the bit-mask of the interrupts to be enabled. Bit positions of 1 will be enabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XTPG_IXR_*_MASK bits defined in <aclass="el"href="xtpg__hw_8h.html">xtpg_hw.h</a>.</td></tr>
(<aclass="code"href="xtpg__hw_8h.html#ac60a6adc8b96f9410f851500fbc2123">XTPG_STATUS_OFFSET</a>)) & ((u32)<aclass="code"href="xtpg__hw_8h.html#1ea4ea36d109c8d16cfcf0ccc6c648d0">XTPG_IXR_ALLINTR_MASK</a>))
</pre></div>This function macro returns the pending interrupts of the TPG core for the interrupts that have been enabled.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>The pending interrupts of the TPG. Use XTPG_IXR_*_MASK constants defined in <aclass="el"href="xtpg__hw_8h.html">xtpg_hw.h</a> to interpret this value. The returned value is a logical AND of the contents of the Status Register and the IRQ_ENABLE Register.</dd></dl>
(<aclass="code"href="xtpg__hw_8h.html#0f1e3ea3cc30cd27e6ee6d4b36647e08">XTPG_CONTROL_OFFSET</a>)) & (~(<aclass="code"href="xtpg__hw_8h.html#39e3278c5b90e6fe9cc816a1286544d4">XTPG_CTL_RUE_MASK</a>))))
</pre></div>This function macro prevents the TPG core from committing recent changes made so far by the software. When disabled, changes to other configuration registers are stored, but do not effect the behavior of the core.<p>
This function only works when the TPG core is enabled.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</pre></div>This function macro commits all the register value changes made so far by the software to the TPG core.<p>
This function only works when the TPG core is enabled.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</pre></div>This function macro resets a TPG core. This reset effects the core immediately and may cause image tearing.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
This function macro enables/starts the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</pre></div>This function macro returns the pending interrupt status of the TPG core read from the Status register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>The pending interrupts of the TPG. Use XTPG_IXR_*_MASK constants defined in <aclass="el"href="xtpg__hw_8h.html">xtpg_hw.h</a> to interpret this value.</dd></dl>
This function macro disables/stops the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</pre></div>This function macro resets a TPG core at the end of the frame being processed. It enables core automatically synchronizes to the SOF of the core to prevent image tearing. This function macro is differ from <aclass="el"href="xtpg_8h.html#984e395b9281b106ed436954edb24246">XTpg_Reset()</a>.<p>
On the next rising-edge of SOF following a call to <aclass="el"href="xtpg_8h.html#6dd8b2a9ac48323b3751a4995f05f99e">XTpg_SyncReset()</a>, all of the core's configuration registers and outputs will be reset, then the reset flag will be immediately released, allowing the core to immediately resume default operation.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
Callback type for all interrupts except error interrupt.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>CallBackRef</em> </td><td>is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallBackRef</em> </td><td>is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ErrorMask</em> </td><td>is a bit mask indicating the cause of the error. Its value equals 'OR'ing one or more XTPG_IXR_*_MASK values defined in <aclass="el"href="xtpg__hw_8h.html">xtpg_hw.h</a>. </td></tr>
These constants specify different types of handlers and used to differentiate interrupt requests from core. <dlcompact><dt><b>Enumerator: </b></dt><dd>
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>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CfgPtr</em> </td><td>is a reference to a structure containing information about a specific <aclass="el"href="struct_x_tpg.html">XTpg</a> instace. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>EffectiveAddr</em> </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>
<dlcompact><dt><b>Returns:</b></dt><dd>- XST_SUCCESS if <aclass="el"href="struct_x_tpg.html">XTpg</a> instance initialization was successful.</dd></dl>
This function disables the Moving Box feature in the Pattern Control Register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function disables the drawing of Cross Hairs feature in the Pattern Control Register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function disables the Motion feature in the Pattern Control register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function disables the Noise on the output by disabling this feature in Pattern Control register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function disables the Stuck Pixel feature in the Pattern Control register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function enables the Moving Box feature in the Pattern Control Register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function enables the drawing of Cross Hairs feature in the Pattern Control Register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function enables the Motion Feature in the Pattern Control register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function enables the Noise on the output by setting value in Pattern Control register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function enables the Stuck Pixel Feature in the Pattern Control Register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function gets the number of Active Pixel per Scan line and number of Active Lines per Frame from the Active Size register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>HSize</em> </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><tdvalign="top"></td><tdvalign="top"><em>VSize</em> </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>
This function gets the background pattern for TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><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>
This function returns the Bayer phase value which indicates starting pixel position.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>BayerPhase is the starting pixel indicator is returned. Corresponding enum values for Bayer Phase are:<ul>
This function gets the color components of the box in the Box Color register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Blue</em> </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><tdvalign="top"></td><tdvalign="top"><em>Green</em> </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><tdvalign="top"></td><tdvalign="top"><em>Red</em> </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>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>BoxSize is the size of a box in pixel.</dd></dl>
This function returns the color component mask status in the Pattern Control Register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><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>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>HPos</em> </td><td>is the row of the frame that will have horizontal line of Cross Hairs is returned. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>VPos</em> </td><td>is the column of the frame that will have vertical line of Cross Hairs is returned.</td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><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>
This function gets the noise gain of each component of TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>NoiseGain is a value to increase the noise added to each component.</dd></dl>
This function returns the contents of the Pattern Control Register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>Contents of the Pattern Control Register is returned.</dd></dl>
This function gets the stuck pixel threshold in the STUCK_PIXEL_THRESH register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>Stuck pixel threshold is an upper limit for PRNG for insertion of stuck pixel is returned.</dd></dl>
This function returns the contents of the Version register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>Content of Version register is returned.</dd></dl>
This function gets how fast (the speed of) horizontal component changes.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>ZPlateHSpeed is speed of the horizontal component changes is returned.</dd></dl>
This function gets a starting point in the ROM based sinusoidal values for the horizontal component.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>ZPlateHStart is starting point in the ROM based sinusoidal value for horizontal component is returned.</dd></dl>
This function gets how fast (the speed of) the vertical component changes.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>ZPlateVSpeed is a 16 bit variable the speed of the vertical component changes is returned.</dd></dl>
This function gets a starting point in the ROM based sinusoidal values for the vertical component.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>ZPlateVStart is starting point in the ROM based sinusoidal value for vertical component is returned.</dd></dl>
This function is the interrupt handler for the TPG driver.<p>
This handler reads the pending interrupt from the STATUS register, determines the source of the interrupts and calls the respective callbacks for the interrupts that are enabled in IRQ_ENABLE register, and finally clears the interrupts.<p>
The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <aclass="el"href="xtpg_8h.html#6ca7050dcbbe005a69bd15cf2199de11">XTpg_SetCallBack()</a> during initialization phase.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance that just interrupted.</td></tr>
This function returns a reference to an <aclass="el"href="struct_x_tpg___config.html">XTpg_Config</a> structure based on the unique device id, <em>DeviceId</em>. The return value will refer to an entry in the device configuration table defined in the <aclass="el"href="xtpg__g_8c.html">xtpg_g.c</a> file.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>DeviceId</em> </td><td>is the unique Device ID of the device for the lookup operation.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>CfgPtr is a reference to a config record in the configuration table (in <aclass="el"href="xtpg__g_8c.html">xtpg_g.c</a>) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
This function sets the active H/V sizes in the Active Size register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>HSize</em> </td><td>specifies the number of Active Pixels per Scan Line that needs to be set (Range is 32 to 7680). </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>VSize</em> </td><td>specifies the number of Active Lines per Frame that needs to be set (Range is 32 to 7680).</td></tr>
This function sets the background pattern in the Pattern Control Register.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Pattern</em> </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>
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>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BayerPhaseComb</em> </td><td>is Bayer phase value to be set to identify starting pixel position. The enum values of Bayer phase are<ul>
This function sets the color components of the box in the Box Color register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Blue</em> </td><td>is the color component of the box which needs to be set. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Green</em> </td><td>is the color component of the box which needs to be set. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Red</em> </td><td>is the color component of the box which needs to be set.</td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BoxSize</em> </td><td>is size of the box in pixel.</td></tr>
</table>
</dl>
<dlcompact><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>
<dlcompact><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>
This function installs an asynchronous callback function for the given HandlerType.<p>
<pre>
HandlerType Callback Function Type
----------------------- ----------------------
XTPG_HANDLER_FRAMEDONE FrameDoneCallBack
XTPG_HANDLER_PROCSTART ProcStartCallBack
XTPG_HANDLER_ERROR ErrCallBack</pre><p>
<pre></pre><p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance to be worked on. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>HandlerType</em> </td><td>specifies which callback is to be attached. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallBackFunc</em> </td><td>is the address of the callback function. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CallBackRef</em> </td><td>is a user data item that will be passed to the callback function when it is invoked.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS when handler is installed.</li><li>XST_INVALID_PARAM when HandlerType is invalid.</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>
This function masks out the specified color component by setting the Pattern Control Register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Mask</em> </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>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>HPos</em> </td><td>is the row of the frame that will have horizontal line of Cross Hairs that need to be set. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>VPos</em> </td><td>is the column of the frame that will have vertical line of Cross Hairs that need to be set.</td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>MotionSpeed</em> </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>
This function sets the noise gain in Noise Gain register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>NoiseGain</em> </td><td>is a value to increase the noise added to each component which needs to be set.</td></tr>
This function sets the Pattern Control Register of TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Pattern</em> </td><td>is the 32 bit value to be written to the Pattern Control Register.</td></tr>
<dlcompact><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>
This function sets the stuck pixel threshold in STUCK_PIXEL_THRESH register of the TPG core.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>PixelThreshold</em> </td><td>is an upper limit for PRNG for insertion of stuck pixel which needs to be set.</td></tr>
This function sets the input/output frame size in Active Size register and enables the register update.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance.</td></tr>
This function sets how fast (the speed of) the horizontal component changes.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ZPlateHSpeed</em> </td><td>is the speed of the horizontal component changes which need to be set.</td></tr>
This function sets a starting point in the ROM based sinusoidal values for the horizontal component.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ZPlateHStart</em> </td><td>is starting point in the ROM based sinusoidal value for horizontal component.</td></tr>
This function sets how fast (the speed of) the vertical component changes.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ZPlateVSpeed</em> </td><td>is the speed of the vertical component changes which need to be set.</td></tr>
This function sets a starting point in the ROM based sinusoidal values for the vertical component.<p>
<dlcompact><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_tpg.html">XTpg</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ZPlateVStart</em> </td><td>is starting point in the ROM based sinusoidal value for vertical component which need to be set.</td></tr>
