This header file contains identifiers and register-level driver functions (or macros), range macros, structure typedefs that can be used to access the Xilinx YCRCB2RGB core.<p>
The YCrCb to RGB Color-Space Convertor core is a simplified 3x3 matrix multiplier converts three input color samples to three output samples in a single clock cycle. The core supports four common format conversions as well as a custom mode that allows for a user-defined transform. The core is capable of a maximum resolution of 7680 columns by 7680 rows with 8, 10, 12, or 16 bits per pixel.<p>
<b>Initialization & Configuration</b><p>
The device driver enables higher layer software (e.g., an application) to communicate to the YCRCB2RGB core.<p>
<aclass="el"href="xycrcb2rgb_8c.html#c5025d0ba54b65adaa027af5fb417af6">XYCrCb2Rgb_CfgInitialize()</a> API is used to initialize the YCRCB2RGB core. The user needs to first call the <aclass="el"href="xycrcb2rgb_8h.html#efc2983c39179e4c195f7aac035ec77a">XYCrCb2Rgb_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <aclass="el"href="xycrcb2rgb_8c.html#c5025d0ba54b65adaa027af5fb417af6">XYCrCb2Rgb_CfgInitialize()</a> API.<p>
<b> Interrupts </b><p>
The driver provides an interrupt handler XYCrCb2Rgb_IntrHandler for handling the interrupt from the YCRCB2RGB core. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XYCrCb2Rgb_SetCallBack API.<p>
<b> Virtual Memory </b><p>
This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.<p>
<b> Threads </b><p>
This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.<p>
<b> Asserts </b><p>
Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.<p>
<b> Building the driver </b><p>
The <aclass="el"href="struct_x_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.<p>
(<aclass="code"href="xycrcb2rgb__hw_8h.html#5c8de676cb5b905e8cd43083bd96aa55">XYCC_CONTROL_OFFSET</a>)) & (~(<aclass="code"href="xycrcb2rgb__hw_8h.html#42da08e6deb2d6b690acefaa4aaaf864">XYCC_CTL_SW_EN_MASK</a>))))
</pre></div>This macro disables the YCrCb2Rgb 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</pre></div>This macro enables the YCrCb2Rgb 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
(IntrType) & (<aclass="code"href="xycrcb2rgb__hw_8h.html#32a32794d05ffded1cfca5bcf4e6c584">XYCC_IXR_ALLINTR_MASK</a>))
</pre></div>This function macro clears/acknowledges pending interrupts of the YCRCB2RGB 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 YCRCB2RGB 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 XYCC_IXR_*_MASK constants defined in <aclass="el"href="xycrcb2rgb__hw_8h.html">xycrcb2rgb_hw.h</a> to create this parameter value.</td></tr>
(<aclass="code"href="xycrcb2rgb__hw_8h.html#a43d65750de71e672b57f0237b4e3eb9">XYCC_IRQ_EN_OFFSET</a>)) & \
((~(IntrType)) & (<aclass="code"href="xycrcb2rgb__hw_8h.html#32a32794d05ffded1cfca5bcf4e6c584">XYCC_IXR_ALLINTR_MASK</a>)))
</pre></div>This function macro disables individual interrupts of the YCRCB2RGB 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 YCrCb2Rgb 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 XYCC_IXR_*_MASK bits defined in <aclass="el"href="xycrcb2rgb__hw_8h.html">xycrcb2rgb_hw.h</a>.</td></tr>
</pre></div>This function macro enables individual interrupts of the YCRCB2RGB 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 YCrCb2Rgb 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 XYCC_IXR_*_MASK bits defined in <aclass="el"href="xycrcb2rgb__hw_8h.html">xycrcb2rgb_hw.h</a>.</td></tr>
</pre></div>This function macro returns the pending interrupts of the YCRCB2RGB 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 YCrCb2Rgb core instance to be worked on.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>The pending interrupts of the YCRCB2RGB core. Use XYCC_IXR_*_MASK constants defined in <aclass="el"href="xycrcb2rgb__hw_8h.html">xycrcb2rgb_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="xycrcb2rgb__hw_8h.html#5c8de676cb5b905e8cd43083bd96aa55">XYCC_CONTROL_OFFSET</a>)) & (~(<aclass="code"href="xycrcb2rgb__hw_8h.html#5aa7286067cc510c25e70c0c3ef12f69">XYCC_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 <aclass="el"href="struct_x_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</pre></div>This macro enables 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 <aclass="el"href="struct_x_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</pre></div>This macro resets the YCrCb2Rgb 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
(<aclass="code"href="xycrcb2rgb__hw_8h.html#463abde173122e160b253acc53b214bc">XYCC_STATUS_OFFSET</a>)) & (<aclass="code"href="xycrcb2rgb__hw_8h.html#32a32794d05ffded1cfca5bcf4e6c584">XYCC_IXR_ALLINTR_MASK</a>)
</pre></div>This function macro returns the pending interrupt status of the YCRCB2RGB 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 YCrCb2Rgb core instance to be worked on.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>The status of pending interrupts of the YCRCB2RGB core. Use XYCC_IXR_*_MASK constants defined in <aclass="el"href="xycrcb2rgb__hw_8h.html">xycrcb2rgb_hw.h</a> to interpret this value.</dd></dl>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</pre></div>This macro resets a the YCrCb2Rgb core, but differs from <aclass="el"href="xycrcb2rgb_8h.html#fa57224777e579de5c753215d4d88c90">XYCrCb2Rgb_Reset()</a> 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="xycrcb2rgb_8h.html#bdebf6613e02140b75a0ba30c2bdc445">XYCrCb2Rgb_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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</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 XYCC_IXR_*_MASK values defined in <aclass="el"href="xycrcb2rgb__hw_8h.html">xycrcb2rgb_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 YCrCb2Rgb core. This function must be called prior to using the YCrCb2Rgb core. Initialization of the YCrCb2Rgb 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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_y_cr_cb2_rgb___coef___inputs.html">XYCrCb2Rgb_Coef_Inputs</a> structure into the <aclass="el"href="struct_x_y_cr_cb2_rgb___coef___outputs.html">XYCrCb2Rgb_Coef_Outputs</a> structure that can be used to program the core's registers. The <aclass="el"href="struct_x_y_cr_cb2_rgb___coef___inputs.html">XYCrCb2Rgb_Coef_Inputs</a> structure uses the same values as the core's GUIs. The <aclass="el"href="struct_x_y_cr_cb2_rgb___coef___outputs.html">XYCrCb2Rgb_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 XYCrCb2Rgbb instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>CoefIn</em> </td><td>specifies a pointer to a <aclass="el"href="struct_x_y_cr_cb2_rgb___coef___inputs.html">XYCrCb2Rgb_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_y_cr_cb2_rgb___coef___outputs.html">XYCrCb2Rgb_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>
<tr><tdvalign="top"></td><tdvalign="top"><em>MWidth</em> </td><td>specifies a valid range from min(32, DataWidth + 17)</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>RetVal, returns value with following bit information:<ul>
<li>bit(0) = 1 = data width outside range [8, 10, 12, 16]</li><li>bit(1) = Acoef + Bcoef > 1.0</li><li>bit(2) = Y Offset outside data width range: [-2^DataWidth, (2^DataWidth)-1].</li><li>bit(3) = Cb Offset outside data width range: [-2^DataWidth, (2^DataWidth)-1].</li><li>bit(4) = Cr Offset outside data width range: [-2^DataWidth, (2^DataWidth)-1].</li><li>bit(5) = RGB Max outside data width range: [0, (2^DataWidth)-1].</li><li>bit(6) = RGB Min outside data width range: [0, (2^DataWidth)-1].</li></ul>
</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>Floating point coefficients are represented in 17-bit fixed point format where 17 bits indicates integer portion (Mantissa) of the number exclusive of sign bit. </dd></dl>
This function disables Bypass mode of the 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
This function gets the active H/V sizes of the YCrCb2Rgb 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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, 8192]. </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, 8192].</td></tr>
This function gets offset compensation value from the Blue 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>BOffset is a compensation value within the range [0, 255] from the Blue 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 XYCrCb2Rgbb instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Coef</em> </td><td>specifies a pointer to <aclass="el"href="struct_x_y_cr_cb2_rgb___coefficients.html">XYCrCb2Rgb_Coefficients</a> structure in which ACoef, BCoef, CCoef, DCoef members value will be updated within the range [0.0, 1.0].</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>Floating point coefficients are represented in 17-bit fixed point format where 17 bits indicates integer portion (Mantissa) of the number exclusive of sign bit. </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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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>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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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>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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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>Debug functionality should be enabled. </dd></dl>
This function gets offset compensation value from the Green 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>GOffset is a compensation value within the range [0, 255] from the Green channel.</dd></dl>
This function gets the maximum value on RGB channels 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>RGBMax is the maximum value within the range [0, 255] from RGB channels of the output.</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>Clipping functionality should be enabled. </dd></dl>
This function gets the minimum value on RGB channels 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>RGBMin is the minimum value within the range [0, 255] from RGB channels of the output.</dd></dl>
<dlcompact><dt><b>Note:</b></dt><dd>Clamping functionality should be enabled. </dd></dl>
This function gets offset compensation value from the Red 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>ROffset is a compensation value within the range [0, 255] from the Red channel.</dd></dl>
This function facilitates software identification of exact version of the YCrCb2rGB 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
</table>
</dl>
<dlcompact><dt><b>Returns:</b></dt><dd>Version, contents of a Version register.</dd></dl>
This function is the interrupt handler for the YCRCB2RGB core.<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="xycrcb2rgb_8h.html#7fdc1b162fb009351199c45ffb7dc1c5">XYCrCb2Rgb_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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance that just interrupted.</td></tr>
This function returns the current bypass mode of the 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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 Bypass 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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_y_cr_cb2_rgb___config.html">XYCrCb2Rgb_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="xycrcb2rgb__g_8c.html">xycrcb2rgb_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>XYCrCb2Rgb_LookupConfig returns a reference to a config record in the configuration table (in <aclass="el"href="xycrcb2rgb__g_8c.html">xycrcb2rgb_g.c</a>) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
This function governs the range of outputs R, G and B 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Range</em> </td><td>needs to be set from the enum OutputRanges values as: 0 = XYCC_TV_16_TO_240, 1 = XYCC_STUDIO_16_TO_235, 2 = XYCC_GRAPHICS_0_TO_255.</td></tr>
This function populates an <aclass="el"href="struct_x_y_cr_cb2_rgb___coef___inputs.html">XYCrCb2Rgb_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 XYCrCb2Rgbb instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>StandardSel</em> </td><td>needs to be set from enum Standards value as : 0 = XYCC_STANDARD_ITU_601_SD 1 = XYCC_STANDARD_ITU_709_NTSC 2 = XYCC_STANDARD_ITU_709_PAL 3 = XYCC_STANDARD_YUV. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InputRange</em> </td><td>needs to be set from enum OutputRanges value as: 0 = XYCC_TV_16_TO_240, 1 = XYCC_STUDIO_16_TO_235, 2 = XYCC_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_y_cr_cb2_rgb___coef___inputs.html">XYCrCb2Rgb_Coef_Inputs</a> structure which is populated with the values from selected video standard.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>Floating point coefficients are represented in 17-bit fixed point format where 17 bits indicates integer portion (Mantissa) of the number exclusive of sign bit. </dd></dl>
This function sets active H/V sizes in the active frame 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</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, 8192]. </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, 8192].</td></tr>
This function sets offset compensation value on the Blue 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>BOffset</em> </td><td>is a compensation value within the range [0, 255] to be set on the Blue channel.</td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_y_cr_cb2_rgb.html">XYCrCb2Rgb</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>
<tr><tdvalign="top"></td><tdvalign="top"><em>InstancePtr</em> </td><td>is a pointer to the <aclass="el"href="struct_x_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>Coef</em> </td><td>specifies a pointer to <aclass="el"href="struct_x_y_cr_cb2_rgb___coefficients.html">XYCrCb2Rgb_Coefficients</a> structure in which ACoef, BCoef, CCoef, DCoef members value within the range [0.0, 1.0] that needs to be set.</td></tr>
<dlcompact><dt><b>Note:</b></dt><dd>Floating point coefficients are represented in 17-bit fixed point format where 17 bits indicates integer portion (Mantissa) of the number exclusive of sign bit. </dd></dl>
This function sets offset compensation value on the Green 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>GOffset</em> </td><td>is a compensation value within the range [0, 255] to be set on the Green channel.</td></tr>
This function sets the RGB maximum value on YCrCb2Rgb channels 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RGBMax</em> </td><td>is the maximum value within the range [0, 255] on the RGB channels of the output.</td></tr>
This function sets minimum value on RGB channels 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>RGBMin</em> </td><td>is the minimum value within the range [0, 255] on RGB channels of the output.</td></tr>
This function sets offset compensation value on the Red 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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance. </td></tr>
<tr><tdvalign="top"></td><tdvalign="top"><em>ROffset</em> </td><td>is compensation value within the range [0, 255] to be set on the Red channel.</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_y_cr_cb2_rgb.html">XYCrCb2Rgb</a> instance.</td></tr>
