(<aclass="code"href="xrgb2ycrcb__hw_8h.html#223ec96a988716a0ea51ec6b71c2fcc9">XRGB_CONTROL_OFFSET</a>))) & (~(<aclass="code"href="xrgb2ycrcb__hw_8h.html#02ae9c4683a1b222240379c6859e3fde">XRGB_CTL_SW_EN_MASK</a>))))
</pre></div>This macro disables the Rgb2YCrCb device/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 Rgb2YCrCb core instance to be worked on. </td></tr>
</pre></div>This function macro clears/acknowledges pending interrupts of the RGB2YCRCB 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 Rgb2YCrCb core 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 XRGB_IXR_*_MASK constants defined in <aclass="el"href="xrgb2ycrcb__hw_8h.html">xrgb2ycrcb_hw.h</a> to create this parameter value.</td></tr>
</pre></div>This function macro disables individual interrupts of the RGB2YCRCB 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 Rgb2YCrCb core 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 XRGB_IXR_*_MASK bits defined in <aclass="el"href="xrgb2ycrcb__hw_8h.html">xrgb2ycrcb_hw.h</a>.</td></tr>
</pre></div>This function macro enables individual interrupts of the RGB2YCRCB 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 Rgb2YCrCb core 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 XRGB_IXR_*_MASK bits defined in <aclass="el"href="xrgb2ycrcb__hw_8h.html">xrgb2ycrcb_hw.h</a>.</td></tr>
(<aclass="code"href="xrgb2ycrcb__hw_8h.html#439a6a780982bf5728b836b25566c6c0">XRGB_STATUS_OFFSET</a>))) & ((u32)(<aclass="code"href="xrgb2ycrcb__hw_8h.html#6ff85638bb879e7f6c46fb606b5a9282">XRGB_IXR_ALLINTR_MASK</a>)))
</pre></div>This function macro returns the pending interrupts of the RGB2YCRCB 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 Rgb2YCrCb core instance to be worked on.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>The pending interrupts of the Rgb2YCrCb core. Use XRGB_IXR_*_MASK constants defined in <aclass="el"href="xrgb2ycrcb__hw_8h.html">xrgb2ycrcb_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="xrgb2ycrcb__hw_8h.html#223ec96a988716a0ea51ec6b71c2fcc9">XRGB_CONTROL_OFFSET</a>)))) & (~(<aclass="code"href="xrgb2ycrcb__hw_8h.html#b10ae42723b22077647e7ab976310b39">XRGB_CTL_RUE_MASK</a>)))
</pre></div>This macro disables copying from updated processor register values to the active set at the end of each AXI-Stream frame.<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 Rgb2YCrCb core instance to be worked on.</td></tr>
(<aclass="code"href="xrgb2ycrcb__hw_8h.html#439a6a780982bf5728b836b25566c6c0">XRGB_STATUS_OFFSET</a>)) & (XRgb2YCrCb_IXR_ALLINTR_MASK)
</pre></div>This function macro returns the pending interrupt status of the RGB2YCRCB 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 Rgb2YCrCb core instance to be worked on.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>The status of pending interrupts of the Rgb2YCrCb core. Use XRGB_IXR_*_MASK constants defined in <aclass="el"href="xrgb2ycrcb__hw_8h.html">xrgb2ycrcb_hw.h</a> to interpret this value.</dd></dl>
</pre></div>This macro resets the Rgb2YCrCb device, but differs from XRgb_Reset() in that it automatically synchronizes to the VBlank_in input of the core to prevent tearing.<p>
On the next rising-edge of VBlank_in following a call to <aclass="el"href="xrgb2ycrcb_8h.html#3039aaaeb592a374e5a932d3b49d89c3">XRgb2YCrCb_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 Rgb2YCrCb core 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>
This data type defines a handler that an application defines to communicate with interrupt system to retrieve error information while processing video frame.<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>ErrorMask</em> </td><td>is a bit mask indicating the cause of the error. Its value equals 'OR'ing one or more XRGB_IXR_*_MASK values defined in <aclass="el"href="xrgb2ycrcb__hw_8h.html">xrgb2ycrcb_hw.h</a>.</td></tr>
These constants specify different ranges used for studio equipment, television and computer graphics respectively. <dlcompact><dt><b>Enumerator: </b></dt><dd>
This function initializes the Rgb2YCrCb core. This function must be called prior to using the Rgb2YCrCb core. Initialization of the Rgb2YCrCb 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_rgb2_y_cr_cb.html">XRgb2YCrCb</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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> driver. </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 initialization was successful.</dd></dl>
This function translates the <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure into the <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> structure that can be used to program the core's registers. The <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure uses the same values as the core's GUIs. The <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> structure uses the values that can be programmed into the core's registers.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CoefIn</em> </td><td>specifies a pointer to a <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure to be translated. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CoefOut</em> </td><td>specifies a pointer to a <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> structure with translated values. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DataWidth</em> </td><td>specifies a valid range of [8,10,12,16] that needs to be set.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>RetVal, returns the 32-bit value with following bit information:<ul>
<li>bit(0)= ACoef + BCoef > 1.0.</li><li>bit(1)= Y Offset outside data width range as [-2^Data_Width, (2^Data_Width)-1].</li><li>bit(2)= Cb Offset outside data width range as [-2^Data_Width, (2^Data_Width)-1].</li><li>bit(3)= Cr Offset outside data width range as [-2^Data_Width, (2^Data_Width)-1].</li><li>bit(4)= Y Max outside data width range as [0, (2^Data_Width)-1].</li><li>bit(5)= Y Min outside data width range as [0, (2^Data_Width)-1].</li><li>bit(6)= Cb Max outside data width range as [0, (2^Data_Width)-1].</li><li>bit(7)= Cb Min outside data width range as [0, (2^Data_Width)-1].</li><li>bit(8)= Cr Max outside data width range as [0, (2^Data_Width)-1].</li><li>bit(9)= Cr Min outside data width range as [0, (2^Data_Width)-1].</li></ul>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> core instance to be worked on.</td></tr>
This function disables debug test pattern mode.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> core instance to be worked on.</td></tr>
This function sets the bypass bit of control register to switch the core to bypass mode if debug is enabled in the IP.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
This function switches the core to test-pattern generator mode if debug feature 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
This function gets the active H/V sizes of the Rgb2YCrCb core from 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_rgb2_y_cr_cb.html">XRgb2YCrCb</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 scanline is returned within the range [32, 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 within the range [32, 7680].</td></tr>
This function returns the maximum value on the Cb Chroma channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>CbMax, maximum value within range [0, 255] of the Cb Chroma Channel.</dd></dl>
This function returns the minimum value on the Cb Chroma channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>CbMin, minimum value within range [0, 255] on the Cb Chroma Channel.</dd></dl>
This function returns the offset compensation value for the Cb Chroma channel.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>CbOffset is the compensation value within range [0, 255] for the Cb Chroma channel.</dd></dl>
This function returns A, B, C and D coefficients.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ACoef</em> </td><td>is a pointer to double variable in which A coefficient is returned within the range [0.0 to 1.0]. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BCoef</em> </td><td>is a pointer to double variable in which B coefficient is returned within the range [0.0 to 1.0]. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CCoef</em> </td><td>is a pointer to double variable in which C coefficient is returned within the range [0.0 to 1.0]. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DCoef</em> </td><td>is a pointer to double variable in which D coefficient is returned within the range [0.0 to 1.0].</td></tr>
This function returns the maximum value on the Cr Chroma channel of the output<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>CrMax, maximum value within range [0, 255] on the Cr Chroma Channel.</dd></dl>
This function returns the minimum value on the Cr Chroma channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>CrMin, minimum value within range [0, 255] on the Cr Chroma Channel.</dd></dl>
This function returns the offset compensation value of the Cr Chroma channel.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>CrOffset is the compensation value within range [0, 255] of the Cr Chroma channel.</dd></dl>
This function returns the frame count, the number of frames processed since power-up. This is available only if the debugging feature 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>DbgFrameCount, number of frames processed since power-up.</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>The SYSDEBUG0, or Frame Throughput Monitor register indicates the number of frames processed since power-up or the last time the core was reset. The SYSDEBUG registers can be useful to identify external memory / frame buffer/ throughput bottlenecks in a video system. Debug functionality should be enabled. </dd></dl>
This function returns Line count, the number of lines processed since power-up. This is available only if the debugging feature 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>DbgLineCount, number of lines processed since power-up.</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>The SYSDEBUG1 or Line Throughput Monitor register indicates the number of lines processed since power-up or the last time the core was reset. The SYSDEBUG registers can be useful to identify external memory / Frame buffer / throughput bottlenecks in a video system. Debug functionality should be enabled. </dd></dl>
This function returns the pixel count, the number of pixels processed since power up. This is available only if the debugging feature 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>DbgPixelCount, number of pixels processed since power-up.</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>The SYSDEBUG2, or Pixel Throughput Monitor register indicates the number of pixel processed since power-up or the last time the core was reset. The SYSDEBUG registers can be useful to identify external memory / Frame buffer / throughput bottlenecks in a video system. Debug functionality should be enabled. </dd></dl>
This function facilitates software identification of exact version of the RGB2YCrCb hardware (h/w).<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>Version, contents of a Version register.</dd></dl>
This function returns the maximum value of the Luma (Y) channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>YMax, Maximum value within range [0, 255] of the Luma channel.</dd></dl>
This function returns the minimum value of the Luma (Y) channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>YMin, minimum value within range [0, 255] of the Luma channel.</dd></dl>
This function returns the offset compensation value for the Luma (Y) channel.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>YOffset is compensation value within range [0, 255] for the Luma (Y) channel.</dd></dl>
This function is the interrupt handler for the RGB2YCRCB driver.<p>
This handler reads the pending interrupt from the IER(IRQ_ENABLE register) or ISR (STATUS register), determines the source of the interrupts, calls according callbacks, 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="xrgb2ycrcb_8h.html#74f4b7d3e369d6d0fa5559096028b27c">XRgb2YCrCb_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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance that just interrupted.</td></tr>
This function returns the current bypass mode of a 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if ByPass mode is enabled.</li><li>FALSE if ByPpass mode is not enabled.</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
This function returns the test-pattern generator mode (enabled or not), if debug feature 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if Test-pattern mode is enabled.</li><li>FALSE if Test-pattern mode is not enabled.</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
This function returns a reference to an <aclass="el"href="struct_x_rgb2_y_cr_cb___config.html">XRgb2YCrCb_Config</a> structure based on the unique core id, <em>DeviceId</em>. The return value will refer to an entry in the core configuration table defined in the <aclass="el"href="xrgb2ycrcb__g_8c.html">xrgb2ycrcb_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 core ID of the core for the lookup operation.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>XRgb2YCrCb_LookupConfig returns a reference to a config record in the configuration table (in <aclass="el"href="xrgb2ycrcb__g_8c.html">xrgb2ycrcb_g.c</a>) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
This function governs the range of outputs Y, Cr and Cb by affecting the conversion coefficients as well as the clipping and clamping values.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Range</em> </td><td>needs to be set from the enum XRgb_OutputRanges values as: 0 = XRGB_TV_16_TO_240, 1 = XRGB_STUDIO_16_TO_235, 2 = XRGB_GRAPHICS_0_TO_255.</td></tr>
This function populates an <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure with the values from the selected video standard.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>StandardSel</em> </td><td>needs to be set from enum XRgb_Standards value as : 0 = XRGB_STANDARD_ITU_601_SD 1 = XRGB_STANDARD_ITU_709_NTSC 2 = XRGB_STANDARD_ITU_709_PAL 3 = XRGB_STANDARD_YUV. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InputRange</em> </td><td>needs to be set from enum XRgb_OutputRanges value as: 0 = XRGB_TV_16_TO_240, 1 = XRGB_STUDIO_16_TO_235, 2 = XRGB_GRAPHICS_0_TO_255. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DataWidth</em> </td><td>specifies the valid range of [8,10,12,16] that needs to be set. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CoefIn</em> </td><td>specifies a pointer to a <aclass="el"href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure which is populated with the values from selected video standard.</td></tr>
This function reads version register of RGB2YCRCB core and compares with zero as part of self test.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the version register read test was successful.</li><li>XST_FAILURE if the version register read test failed.</li></ul>
This function sets 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>HSize</em> </td><td>specifies the number of Active Pixels per scanline that needs to be set within the range [32, 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 within the range [32, 7680].</td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</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 sets the maximum value allowed on the Cb Chroma channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CbMax</em> </td><td>specifies the maximum value within range [0, 255] of Cb Chroma channel that needs to be set.</td></tr>
This function sets the minimum value allowed on the Cb Chroma channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CbMin</em> </td><td>specifies the maximum value within range [0, 255] of Cb Chroma channel needs to set.</td></tr>
This function sets the offset compensation value for the Cb Chroma channel.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CbOffset</em> </td><td>specifies the compensation value within range [0, 255] of Cb Chroma channel that 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ACoef</em> </td><td>specifies the A coefficient value within the range [0.0 to 1.0] that needs to be set. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BCoef</em> </td><td>specifies the B coefficient value within the range [0.0 to 1.0] that needs to be set. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CCoef</em> </td><td>specifies the C coefficient value within the range [0.0 to 1.0] that needs to be set. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>DCoef</em> </td><td>specifies the D coefficient value within the range [0.0 to 1.0] that needs to be set.</td></tr>
This function sets the maximum value allowed on the Cr Chroma channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CrMax</em> </td><td>specifies the maximum value within range [0, 255] of Cr Chroma channel that needs to be set.</td></tr>
This function sets the minimum value allowed on the Cr Chroma channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CrMin</em> </td><td>specifies the minimum value within range [0, 255] of Cr Chroma channel that needs to be set.</td></tr>
This function sets the offset compensation value for the Cr Chroma channel.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CrOffset</em> </td><td>specifies the compensation value within range [0, 255] of Cr Chroma channel that needs to be set.</td></tr>
This function sets up double buffered 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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
This function sets the maximum value allowed on the Luma (Y) channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>YMax</em> </td><td>specifies the maximum value within range [0, 255] of Luma channel that needs to be set.</td></tr>
This function sets the minimum value allowed on the Luma (Y) channel of the output.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>YMin</em> </td><td>specifies the minimum value within range [0, 255] of Luma channel that needs to be set.</td></tr>
This function sets the offset compensation value for the Luma (Y) channel.<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_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>YOffset</em> </td><td>specifies the compensation value within range [0, 255] of Luma channel that needs to be set.</td></tr>
