7921deaf6c
Removed Haddress in TCL file under config structure and Modified doxygen report, modified enum names in xrgb2ycrcb.c and xrgb2ycrcb.c files. Signed-off-by: Durga challa <vnsldurg@xilinx.com> Acked-by: Srikanth Vemula <svemula@xilinx.com>
113 lines
8.1 KiB
HTML
113 lines
8.1 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
RGB2YCRCB
|
|
</title>
|
|
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
|
|
</head>
|
|
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
|
|
<hl>Software Drivers</hl>
|
|
<hr class="whs1">
|
|
<!-- Generated by Doxygen 1.4.7 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li id="current"><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul></div>
|
|
<h1>RGB2YCRCB</h1>
|
|
<p>
|
|
This header file contains identifiers and register-level driver functions (or macros), range macros, structure typedefs that can be used to access the Xilinx Rgb2YCrCb core instance.<p>
|
|
The RGB to YCrCb 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 RGB2YCRCB core.<p>
|
|
<a class="el" href="xrgb2ycrcb_8c.html#584a818bca95b80de513294519c54ee2">XRgb2YCrCb_CfgInitialize()</a> API is used to initialize the RGB2YCRCB core. The user needs to first call the <a class="el" href="xrgb2ycrcb_8h.html#2759e34bb0b2134ec1f694334ba92b77">XRgb2YCrCb_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="xrgb2ycrcb_8c.html#584a818bca95b80de513294519c54ee2">XRgb2YCrCb_CfgInitialize()</a> API.<p>
|
|
<b> Interrupts </b><p>
|
|
The driver provides an interrupt handler XRgb2YCrCb_IntrHandler for handling the interrupt from the RGB2YCRCB core. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XRgb2YCrCb_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 <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</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>
|
|
<pre>
|
|
MODIFICATION HISTORY:</pre><p>
|
|
<pre> Ver Who Date Changes
|
|
----- ------ -------- -------------------------------------------------------
|
|
5.00a tb 02/27/12 Updated for RGB2YCRCB V5.00.a
|
|
5.01a bao 12/28/12 Converted from xio.h to xil_io.h, translating basic
|
|
types, MB cache functions, exceptions and assertions
|
|
to xil_io format.
|
|
6.0 adk 19/12/13 Updated as per the New Tcl API's.
|
|
7.0 adk 01/07/14 Changed the file name from "rgb2ycrcb.h" to
|
|
"xrgb2ycrcb.h".
|
|
Moved register offsets and bit definitions from
|
|
rgb2ycrcb.h file to <a class="el" href="xrgb2ycrcb__hw_8h.html">xrgb2ycrcb_hw.h</a> file.</pre><p>
|
|
<pre> Removed RGB_TIMING_STATUS register offset because this
|
|
register is not present in latest product guide.</pre><p>
|
|
<pre> Removed following function macros:
|
|
RGB_Enable, RGB_Disable, RGB_RegUpdateEnable,
|
|
RGB_RegUpdateDisable, RGB_Reset, RGB_ClearReset,
|
|
RGB_AutoSyncReset.</pre><p>
|
|
<pre> Removed following functions:
|
|
RGB_select_standard, RGB_coefficient_translation,
|
|
RGB_set_coefficients, RGB_get_coefficients.</pre><p>
|
|
<pre> Added following handler types as enum:
|
|
XRGB_HANDLER_PROCSTART, XRGB_HANDLER_FRAMEDONE,
|
|
XRGB_HANDLER_ERROR.</pre><p>
|
|
<pre> Added following standard types as enum:
|
|
XRGB_STANDARD_ITU_601_SD, XRGB_STANDARD_ITU_709_NTSC,
|
|
XRGB_STANDARD_ITU_709_PAL, XRGB_STANDARD_YUV,
|
|
XRGB_STANDARD_CUSTOM.</pre><p>
|
|
<pre> Added following output ranges as enum:
|
|
XRGB_TV_16_TO_240, XRGB_STUDIO_16_TO_235,
|
|
XRGB_GRAPHICS_0_TO_255.</pre><p>
|
|
<pre> Added range macros for ActiveSize, YMAX, YMIN, YOFFSET,
|
|
CBMAX, CBMIN, CBOFFSET, CRMAX, CRMIN, CROFFSET
|
|
registers.</pre><p>
|
|
<pre> Added following function macros:
|
|
XRgb2YCrCb_IntrEnable, XRgb2YCrCb_SyncReset,
|
|
XRgb2YCrCb_IntrDisable, XRgb2YCrCb_StatusGetPending,
|
|
XRgb2YCrCb_IntrGetPending, XRgb2YCrCb_IntrClear,
|
|
XRgb2YCrCb_RegUpdateEnable,
|
|
XRgb2YCrCb_RegUpdateDisable, XRgb2YCrCb_Reset,
|
|
XRgb2YCrCb_Enable, XRgb2YCrCb_Disable,
|
|
XRgb2YCrCb_Start, XRgb2YCrCb_Stop.</pre><p>
|
|
<pre> Added core and configuration structure.
|
|
Renamed rgb_coef_inputs -> <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> and
|
|
rgb_coef_outputs - > <a class="el" href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a>.</pre><p>
|
|
<pre> Added callback functions typedef.</pre><p>
|
|
<pre> Implemented XRgb2YCrCb_LookupConfig in
|
|
<a class="el" href="xrgb2ycrcb__sinit_8c.html">xrgb2ycrcb_sinit.c</a>
|
|
Implemented XRgb2YCrCb_SelfTest in
|
|
<a class="el" href="xrgb2ycrcb__selftest_8c.html">xrgb2ycrcb_selftest.c</a>
|
|
Implemented XRgb2YCrCb_IntrHandler,
|
|
XRgb2YCrCb_SetCallBack in <a class="el" href="xrgb2ycrcb__intr_8c.html">xrgb2ycrcb_intr.c</a>.</pre><p>
|
|
<pre> Implemented following functions in <a class="el" href="xrgb2ycrcb_8c.html">xrgb2ycrcb.c</a>:
|
|
XRgb2YCrCb_CfgInitialize, XRgb2YCrCb_EnableDbgByPass,
|
|
XRgb2YCrCb_IsDbgByPassEnabled,
|
|
XRgb2YCrCb_DisableDbgBypass,
|
|
XRgb2YCrCb_EnableDbgTestPattern,
|
|
XRgb2YCrCb_IsDbgTestPatternEnabled,
|
|
XRgb2YCrCb_DisableDbgTestPattern,
|
|
XRgb2YCrCb_GetVersion, XRgb2YCrCb_GetDbgFrameCount,
|
|
XRgb2YCrCb_GetDbgLineCount,
|
|
XRgb2YCrCb_GetDbgPixelCount, XRgb2YCrCb_Setup,
|
|
XRgb2YCrCb_SetActiveSize, XRgb2YCrCb_GetActiveSize,
|
|
XRgb2YCrCb_SetYMax, XRgb2YCrCb_GetYMax,
|
|
XRgb2YCrCb_SetYMin, XRgb2YCrCb_GetYMin,
|
|
XRgb2YCrCb_SetCbMax, XRgb2YCrCb_GetCbMax,
|
|
XRgb2YCrCb_SetCbMin, XRgb2YCrCb_GetCbMin,
|
|
XRgb2YCrCb_SetCrMax, XRgb2YCrCb_GetCrMax,
|
|
XRgb2YCrCb_SetCrMin, XRgb2YCrCb_GetCrMin,
|
|
XRgb2YCrCb_SetYOffset, XRgb2YCrCb_GetYOffset,
|
|
XRgb2YCrCb_SetCbOffset, XRgb2YCrCb_GetCbOffset,
|
|
XRgb2YCrCb_SetCrOffset, XRgb2YCrCb_GetCrOffset,
|
|
XRgb2YCrCb_SetCoefs, XRgb2YCrCb_GetCoefs,
|
|
XRgb2YCrCb_Select_Standard,
|
|
XRgb2YCrCb_Coefficient_Translation,
|
|
XRgb2YCrCb_Select_OutputRange.
|
|
*</pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
|