a2978ad90f
Added source files,ccm_selftest_example,doxygen report. Signed-off-by: Durga challa <vnsldurg@xilinx.com> Acked-by: Srikanth Vemula <svemula@xilinx.com>
101 lines
7 KiB
HTML
Executable file
101 lines
7 KiB
HTML
Executable file
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
ccm
|
|
</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>ccm</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 Color Correction Matrix (CCM) core instance.<p>
|
|
The Color Correction Matrix core offers a 3x3 matrix multiplication for a variety of color correction applications. CCM core provides following features:<ul>
|
|
<li>Fully programmable coefficient matrix.</li><li>Offset compensation.</li><li>Clipping and</li><li>Clamping of the output.</li></ul>
|
|
<p>
|
|
<b>Initialization & Configuration</b><p>
|
|
The device driver enables higher layer software (e.g., an application) to communicate to the CCM core.<p>
|
|
<a class="el" href="xccm_8c.html#143aa8c29bd2eaf103f17d6b76dbdc17">XCcm_CfgInitialize()</a> API is used to initialize the CCM core. The user needs to first call the <a class="el" href="xccm_8h.html#cf6a99204033596f4dd3ffa4b61b2b6a">XCcm_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="xccm_8c.html#143aa8c29bd2eaf103f17d6b76dbdc17">XCcm_CfgInitialize()</a> API.<p>
|
|
<b> Interrupts </b><p>
|
|
The driver provides an interrupt handler XCcm_IntrHandler for handling the interrupt from the CCM core. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XCcm_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_ccm.html">XCcm</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
|
|
----- ------ -------- ---------------------------------------------------
|
|
2.00a jo 05/1/10 Updated for CCM V2.0.
|
|
3.00a ren 09/11/11 Updated for CCM V3.0.
|
|
4.00a jj 12/18/12 Converted from xio.h to xil_io.h,translating
|
|
basic types,MB cache functions, exceptions
|
|
and assertions to xil_io format.
|
|
5.0 adk 19/12/13 Updated as per the New Tcl API's.
|
|
6.0 adk 03/06/14 Changed file name ccm.h to <a class="el" href="xccm_8h.html">xccm.h</a>.
|
|
Moved register offsets and bit definitions to
|
|
<a class="el" href="xccm__hw_8h.html">xccm_hw.h</a> file.
|
|
Defined the following handler types as enum values:
|
|
XCCM_HANDLER_PROCSTART ,XCCM_HANDLER_FRAMEDONE and
|
|
XCCM_HANDLER_ERROR.</pre><p>
|
|
<pre> Added the following range macros:
|
|
XCCM_VSIZE_FIRST, XCCM_VSIZE_LAST
|
|
XCCM_HSIZE_FIRST, XCCM_HSIZE_LAST
|
|
XCCM_COEF_FIRST,XCCM_COEF_LAST
|
|
XCCM_OFFSET_FIRST,XCCM_OFFSET_LAST
|
|
XCCM_CLAMP_FIRST,XCCM_CLAMP_LAST
|
|
XCCM_CLIP_FIRST,XCCM_CLIP_LAST.</pre><p>
|
|
<pre> Added the following structure type definitions:
|
|
<a class="el" href="struct_x_ccm___config.html">XCcm_Config</a> and <a class="el" href="struct_x_ccm.html">XCcm</a>.</pre><p>
|
|
<pre> Removed the following functional macros:
|
|
CCM_Enable, CCM_Disable, CCM_RegUpdateEnable
|
|
CCM_RegUpdateDisable, CCM_Reset, CCM_AutoSyncReset
|
|
CCM_ClearReset.</pre><p>
|
|
<pre> Added the following macros:
|
|
XCcm_Enable, XCcm_Disable,XCcm_RegUpdateEnable,
|
|
XCcm_SyncReset, XCcm_Reset, XCcm_IntrGetPending,
|
|
XCcm_IntrEnable, XCcm_IntrDisable,
|
|
XCcm_StatusGetPending, XCcm_IntrClear, XCcm_Start,
|
|
XCcm_Stop.</pre><p>
|
|
<pre> Modification history from <a class="el" href="xccm__hw_8h.html">xccm_hw.h</a>
|
|
First release.
|
|
Added the register offsets and bit masks for the
|
|
registers.
|
|
Added backward compatibility macros.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xccm_8c.html">xccm.c</a> are:
|
|
Changed filename ccm to <a class="el" href="xccm_8c.html">xccm.c</a>.
|
|
Implemented the following functions:
|
|
XCcm_CfgInitialize, XCcm_Setup, XCcm_GetVersion,
|
|
XCcm_EnableDbgByPass, XCcm_IsDbgByPassEnabled,
|
|
XCcm_DisableDbgByPass, XCcm_EnableDbgTestPattern,
|
|
XCcm_IsDbgTestPatternEnabled,
|
|
XCcm_DisableDbgTestPattern, XCcm_GetDbgFrameCount,
|
|
XCcm_GetDbgLineCount, XCcm_GetDbgPixelCount,
|
|
XCcm_SetActiveSize, XCcm_GetActiveSize,
|
|
XCcm_SetCoefMatrix, XCcm_GetCoefMatrix,
|
|
XCcm_SetRgbOffset, XCcm_GetRgbOffset,
|
|
XCcm_SetClip, XCcm_GetClip,
|
|
XCcm_SetClamp XCcm_GetClamp XCcm_FloatToFixedConv,
|
|
and XCcm_FixedToFloatConv.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xccm__selftest_8c.html">xccm_selftest.c</a> are:
|
|
Implemented XCcm_SelfTest function.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xccm__sinit_8c.html">xccm_sinit.c</a> are:
|
|
Implemented XCcm_LookupConfig function.</pre><p>
|
|
<pre> Modifications in the file <a class="el" href="xccm__intr_8c.html">xccm_intr.c</a> are:
|
|
Implemented the following functions:
|
|
XCcm_IntrHandler
|
|
XCcm_SetCallBack</pre><p>
|
|
<pre> </pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
|