589fcf6173
Added doxygen report to cresample. Signed-off-by: Durga challa <vnsldurg@xilinx.com> Acked-by: Srikanth Vemula <svemula@xilinx.com>
111 lines
8.5 KiB
HTML
Executable file
111 lines
8.5 KiB
HTML
Executable file
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
cresample v3_0
|
|
</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>cresample v4_0</h1>
|
|
<p>
|
|
This header file contains identifiers and register-level driver functions (or macros), that can be used to access the Xilinx Chroma Resampler (Cresample) core instance.<p>
|
|
The Chroma Resampler core converts between chroma sub-sampling formats of 4:4:4, 4:2:2,and 4:2:0. There are a total of six conversions available for the three supported sub-sampling formats. Conversion is achieved using a FIR filter approach. Some conversions require filtering in only the horizontal dimension, only the vertical dimension, or both. Interpolation operations are implemented using a two-phase polyphase FIR filter. Decimation operations are implemented using a low-pass FIR filter to suppress chroma aliasing.<p>
|
|
Features of Chroma Resampler core are<ul>
|
|
<li>Configurable filters sizes with programmable filter coefficients for high performance applications.</li><li>Replicate or drop pixels.</li><li>Static, predefined, powers-of-two coefficients for low-footprint applications</li><li>Converts between YCbCr: 4:4:4, 4:2:2,and 4:2:0.</li><li>Supports both progressive and interlaced video.</li></ul>
|
|
<p>
|
|
<b>Initialization & Configuration</b><p>
|
|
The device driver enables higher layer software (e.g., an application) to communicate to the Cresample core.<p>
|
|
<a class="el" href="xcresample_8c.html#386a0f9c22e6409060fd966a66d8aa66">XCresample_CfgInitialize()</a> API is used to initialize the Cresample core. The user needs to first call the <a class="el" href="xcresample_8h.html#5a31b77d26816fa1c1b5b37ff46207f6">XCresample_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="xcresample_8c.html#386a0f9c22e6409060fd966a66d8aa66">XCresample_CfgInitialize()</a> API.<p>
|
|
<b> Interrupts </b><p>
|
|
The driver provides an interrupt handler XCresample_IntrHandler for handling the interrupt from the Cresample core. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XCresample_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 Cresample 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
|
|
----- ------- -------- -------------------------------------------------------
|
|
2.00a vy 04/24/12 Updated for version 2.00.a
|
|
Converted from xio.h to xil_io.h, translating
|
|
basic type, MB cache functions, exceptions and
|
|
assertion to xil_io format.
|
|
1.00a vy 10/22/10 Initial version
|
|
3.0 adk 19/12/13 Updated as per the New Tcl API's.
|
|
4.0 adk 03/12/14 Changed the file name cresample.h to <a class="el" href="xcresample_8h.html">xcresample.h</a>.
|
|
Macros of register offsets, bit definitions,
|
|
ReadReg and WriteReg macros which are the part of
|
|
xcresample_hw.h.were moved to <a class="el" href="xcresample__hw_8h.html">xcresample_hw.h</a>.
|
|
Removed file inclusion of Xil_io.h.</pre><p>
|
|
<pre> Removed the following functional macros:
|
|
CRESAMPLE_Enable, CRESAMPLE_Disable,
|
|
CRESAMPLE_RegUpdateEnable, CRESAMPLE_RegUpdateDisable,
|
|
CRESAMPLE_Reset, CRESAMPLE_ClearReset,
|
|
CRESAMPLe_AutoSyncReset.
|
|
Defined the following functional macros:
|
|
XCresample_Enable, XCresample_Disable,
|
|
XCresample_RegUpdateEnable,XCresample_RegUpdateDisable
|
|
XCresample_Reset, XCresample_ClearReset,
|
|
XCresample_SyncReset, XCresample_IntrDisable,
|
|
XCresample_IntrEnable, XCresample_StatusGetPending
|
|
XCresample_IntrGetPending, XCresample_IntrClear.
|
|
Declared following structures:
|
|
<a class="el" href="struct_x_cresample___config.html">XCresample_Config</a> and <a class="el" href="struct_x_cresample.html">XCresample</a> of Chroma Resampler.</pre><p>
|
|
<pre> Defined the following range macros:
|
|
XCRE_VSIZE_FIRST, XCRE_VSIZE_LAST, XCRE_HSIZE_FIRST,
|
|
XCRE_HSIZE_FIRST, XCRE_HSIZE_LAST, XCRE_PARITY_ODD,
|
|
XCRE_PARITY_EVEN, XCRE_COEF_FIRST, XCRE_COEF_LAST,
|
|
XCRE_OFFSET_DIFF, XCRE_NUM_OF_PHASES, XCRE_NUM_HCOEFS,
|
|
and XCRE_NUM_VCOEFS.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xcresample__hw_8h.html">xcresample_hw.h</a> are:
|
|
Added the register offsets and bit masks for the
|
|
registers and added backward compatibility for macros.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xcresample_8c.html">xcresample.c</a> are:
|
|
Changed the filename cresample.c to <a class="el" href="xcresample_8c.html">xcresample.c</a>.
|
|
The Following functions are removed:
|
|
clear_coef_values, configure_444_to_422,
|
|
configure_422_to_444, configure_422_to_420,
|
|
configure_420_to_422, configure_444_to_420 and
|
|
configure_420_to_444.
|
|
Implemented the following functions :
|
|
StubCallBack, StubErrorCallBack,
|
|
XCresample_CfgInitialize,
|
|
XCresample_GetVersion, XCresample_EnableDbgByPass,
|
|
XCresample_IsDbgByPassEnabled,
|
|
XCresample_DisableDbgByPass,
|
|
XCresample_SetDbgTestPattern,
|
|
XCresample_IsDbgTestPatternEnabled,
|
|
XCresample_DisableDbgTestPattern
|
|
XCresample_GetDbgFrameCount,
|
|
XCresample_GetDbgLineCount,
|
|
XCresample_GetDbgPixelCount,
|
|
XCresample_SetActiveSize, XCresample_GetActiveSize,
|
|
XCresample_SetFieldParity, XCresample_GetFieldParity,
|
|
XCresample_SetChromaParity,
|
|
XCresample_GetChromaParity
|
|
XCresample_SetHCoefs, XCresample_GetHCoefs,
|
|
XCresample_SetVCoefs, XCresample_GetVCoefs,
|
|
XCresample_Clear_HCoef_Values, and
|
|
XCresample_Clear_VCoef_Values.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xcresample__intr_8c.html">xcresample_intr.c</a> are:
|
|
Implemented XCresample_IntrHandler and
|
|
XCresample_SetCallBack functions.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xcresample__selftest_8c.html">xcresample_selftest.c</a> are:
|
|
Implemented XCresample_SelfTest function.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xcresample__sinit_8c.html">xcresample_sinit.c</a> are:
|
|
Implemented XCresample_LookupConfig function.</pre><p>
|
|
<pre> </pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
|