embeddedsw/XilinxProcessorIPLib/drivers/cfa/doc/html/api/xcfa_8c.html
Durga challa 6c8a7204d0 cfa: Modified enum names.
Modified source files and doxygen report

Signed-off-by: Durga challa <vnsldurg@xilinx.com>
Acked-by: Srikanth Vemula <svemula@xilinx.com>
2014-09-02 11:21:16 +05:30

609 lines
30 KiB
HTML
Executable file

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xcfa.c File Reference
</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><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>xcfa.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains the implementation of the interface functions for CFA core. Refer to the header file <a class="el" href="xcfa_8h.html">xcfa.h</a> for more detailed information.<p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
----- ------ -------- --------------------------------------------------
1.00 drg/jz 01/13/10 First Release
3.00a gz 10/22/10 Updated for CFA V3.0
4.00a rc 09/11/11 Updated for CFA v4.0
5.00a se 12/01/11 Updated for CFA v5.0
7.0 adk 01/07/14 Changed the file name from
cfa.c to <a class="el" href="xcfa_8c.html">xcfa.c</a>
Implemented the following functions:
XCfa_CfgInitialize, XCfa_Setup,
XCfa_GetVersion,
XCfa_EnableDbgByPass,
XCfa_IsDbgByPassEnabled,
XCfa_DisableDbgBypass,
XCfa_EnableDbgTestPattern,
XCfa_IsDbgTestPatternEnabled,
XCfa_DisableDbgTestPattern,
XCfa_GetDbgFrameCount
XCfa_GetDbgLineCount, XCfa_GetDbgPixelCount
XCfa_SetActiveSize, XCfa_GetActiveSize
XCfa_SetBayerPhase, XCfa_GetBayerPhase,
StubCallBack, StubErrCallBack.
</pre>
<p>
<code>#include &quot;<a class="el" href="xcfa_8h.html">xcfa.h</a>&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#f21a4a9fe167729fd388e53a9ae467d9">XCfa_CfgInitialize</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr, <a class="el" href="struct_x_cfa___config.html">XCfa_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#37662371560e8ef83e5c22c6bc1f8252">XCfa_Setup</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#2950494fe006bb716d867057fa40fe84">XCfa_EnableDbgByPass</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#20b43ecec565a3e404cf16368142775b">XCfa_IsDbgByPassEnabled</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#a09e739bf44e6261b9040b1c94fa4a09">XCfa_DisableDbgBypass</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#e26d790d91c21b1af050608d074e1d14">XCfa_EnableDbgTestPattern</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#320714714f0771a74ae788d77db9c89c">XCfa_IsDbgTestPatternEnabled</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#24ee7bc8ecaa7b4a2ade87fe249dd991">XCfa_DisableDbgTestPattern</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#6eda030a6ee721c31fa2c6468379b08a">XCfa_GetVersion</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#b5c5f6192e717b7cabca4900d34ea1a6">XCfa_GetDbgFrameCount</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#c3d959e0e75b1b6d6110a2413a80dd2d">XCfa_GetDbgLineCount</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#d452cec853f944bbb0ad8af2ed46641e">XCfa_GetDbgPixelCount</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#ee423f2591247f27520ff2ed16bb566f">XCfa_SetActiveSize</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr, u16 HSize, u16 VSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#a11033dd33aa2ea4e272c8f478db9fc2">XCfa_GetActiveSize</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr, u16 *HSize, u16 *VSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#8faa20631de11e27941ddfb10e9f07cd">XCfa_SetBayerPhase</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr, enum <a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a4362">XCfa_BayerPhaseCombination</a> BayerPhase)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8c.html#2456dd20b52e21211b6fb8ca071d24b4">XCfa_GetBayerPhase</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="f21a4a9fe167729fd388e53a9ae467d9"></a><!-- doxytag: member="xcfa.c::XCfa_CfgInitialize" ref="f21a4a9fe167729fd388e53a9ae467d9" args="(XCfa *InstancePtr, XCfa_Config *CfgPtr, u32 EffectiveAddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XCfa_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_cfa___config.html">XCfa_Config</a> *&nbsp;</td>
<td class="paramname"> <em>CfgPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function initializes the CFA core. This function must be called prior to using the CFA core. Initialization of the CFA includes setting up the instance data and ensuring the hardware is in a quiescent state.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em>&nbsp;</td><td>is a reference to a configuration structure containing information about the CFA core. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em>&nbsp;</td><td>is the base address of the core. If address translation is being used then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a09e739bf44e6261b9040b1c94fa4a09"></a><!-- doxytag: member="xcfa.c::XCfa_DisableDbgBypass" ref="a09e739bf44e6261b9040b1c94fa4a09" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_DisableDbgBypass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables bypass mode of the CFA core.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="24ee7bc8ecaa7b4a2ade87fe249dd991"></a><!-- doxytag: member="xcfa.c::XCfa_DisableDbgTestPattern" ref="24ee7bc8ecaa7b4a2ade87fe249dd991" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_DisableDbgTestPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables the test pattern mode of the CFA core.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2950494fe006bb716d867057fa40fe84"></a><!-- doxytag: member="xcfa.c::XCfa_EnableDbgByPass" ref="2950494fe006bb716d867057fa40fe84" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_EnableDbgByPass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This sets the bypass bit of the control register to switch the core to bypass mode if debug is enabled in the CFA core.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e26d790d91c21b1af050608d074e1d14"></a><!-- doxytag: member="xcfa.c::XCfa_EnableDbgTestPattern" ref="e26d790d91c21b1af050608d074e1d14" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_EnableDbgTestPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the test-pattern mode of the CFA core if debug features is enabled.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a11033dd33aa2ea4e272c8f478db9fc2"></a><!-- doxytag: member="xcfa.c::XCfa_GetActiveSize" ref="a11033dd33aa2ea4e272c8f478db9fc2" args="(XCfa *InstancePtr, u16 *HSize, u16 *VSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_GetActiveSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>HSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>VSize</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the number of Active Pixel per Scan line and number of Active Lines per Frame from the Active Frame Size register.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HSize</em>&nbsp;</td><td>is a pointer to 16-bit variable in which the number of Active Pixels per Scan Line is returned. (Range is 32 to 7680). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VSize</em>&nbsp;</td><td>is a pointer to 16-bit variable in which the number of Active Lines per Frame is returned. (Range is 32 to 7680).</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2456dd20b52e21211b6fb8ca071d24b4"></a><!-- doxytag: member="xcfa.c::XCfa_GetBayerPhase" ref="2456dd20b52e21211b6fb8ca071d24b4" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XCfa_GetBayerPhase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the Bayer phase value combination from Bayer phase register.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>BayerPhase the Bayer Phase value 0 to 3. The Phase value combinations are<ul>
<li>Bayer Phase 0 is XCFA_RGRG_COMBINATION.</li><li>Bayer Phase 1 is XCFA_GRGR_COMBINATION.</li><li>Bayer Phase 2 is XCFA_GBGB_COMBINATION.</li><li>Bayer Phase 3 is XCFA_BGBG_COMBINATION.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>- It is a double buffered register. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b5c5f6192e717b7cabca4900d34ea1a6"></a><!-- doxytag: member="xcfa.c::XCfa_GetDbgFrameCount" ref="b5c5f6192e717b7cabca4900d34ea1a6" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XCfa_GetDbgFrameCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets number of frames processed since power-up or last time the core is reset.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>FrameCount is the number of frames processed since power up.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c3d959e0e75b1b6d6110a2413a80dd2d"></a><!-- doxytag: member="xcfa.c::XCfa_GetDbgLineCount" ref="c3d959e0e75b1b6d6110a2413a80dd2d" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XCfa_GetDbgLineCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the number of lines processed since power-up or last time the core is reset.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>LineCount is the number of lines processed since power up.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d452cec853f944bbb0ad8af2ed46641e"></a><!-- doxytag: member="xcfa.c::XCfa_GetDbgPixelCount" ref="d452cec853f944bbb0ad8af2ed46641e" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XCfa_GetDbgPixelCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the number of pixels processed since power-up or last time the core is reset.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>PixelCount is the number of pixels processed since power up.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6eda030a6ee721c31fa2c6468379b08a"></a><!-- doxytag: member="xcfa.c::XCfa_GetVersion" ref="6eda030a6ee721c31fa2c6468379b08a" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XCfa_GetVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the Version of the CFA core.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Returns the contents of the Version register.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="20b43ecec565a3e404cf16368142775b"></a><!-- doxytag: member="xcfa.c::XCfa_IsDbgByPassEnabled" ref="20b43ecec565a3e404cf16368142775b" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XCfa_IsDbgByPassEnabled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the current status of the bypass setting of the CFA core.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Core debug bypass mode.<ul>
<li>TRUE = Bypass mode is enabled.</li><li>FALSE = Bypass mode is not enabled.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="320714714f0771a74ae788d77db9c89c"></a><!-- doxytag: member="xcfa.c::XCfa_IsDbgTestPatternEnabled" ref="320714714f0771a74ae788d77db9c89c" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XCfa_IsDbgTestPatternEnabled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the test-pattern mode if debug feature is enabled.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Test-pattern generator mode.<ul>
<li>TRUE = Test-pattern mode is enabled.</li><li>FALSE = Test-pattern mode is not enabled.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ee423f2591247f27520ff2ed16bb566f"></a><!-- doxytag: member="xcfa.c::XCfa_SetActiveSize" ref="ee423f2591247f27520ff2ed16bb566f" args="(XCfa *InstancePtr, u16 HSize, u16 VSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_SetActiveSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>HSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>VSize</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the active H/V sizes in the Active Size register.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HSize</em>&nbsp;</td><td>is number of Active Pixels per scan line to be set. Range of HSize is 32 to 7680. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VSize</em>&nbsp;</td><td>is number of Active Lines per frame to be set. Range of VSize is 32 to 7680.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8faa20631de11e27941ddfb10e9f07cd"></a><!-- doxytag: member="xcfa.c::XCfa_SetBayerPhase" ref="8faa20631de11e27941ddfb10e9f07cd" args="(XCfa *InstancePtr, enum XCfa_BayerPhaseCombination BayerPhase)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_SetBayerPhase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a4362">XCfa_BayerPhaseCombination</a>&nbsp;</td>
<td class="paramname"> <em>BayerPhase</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function specify whether the starting position pixel(0,0) of the Bayer sampling grid is on a red-green or blue-green line and whether the first pixel is green or not.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BayerPhase</em>&nbsp;</td><td>to be set to identify starting position. Range of Phase is 0 to 3. The Phase value combinations are<ul>
<li>Bayer Phase 0 is XCFA_RGRG_COMBINATION.</li><li>Bayer Phase 1 is XCFA_GRGR_COMBINATION.</li><li>Bayer Phase 2 is XCFA_GBGB_COMBINATION.</li><li>Bayer Phase 3 is XCFA_BGBG_COMBINATION.</li><li>It is a double buffered register.</li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="37662371560e8ef83e5c22c6bc1f8252"></a><!-- doxytag: member="xcfa.c::XCfa_Setup" ref="37662371560e8ef83e5c22c6bc1f8252" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_Setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_cfa.html">XCfa</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the input/output frame size in Active Size register and enables the register update.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_cfa.html">XCfa</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.