stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/XilinxProcessorIPLib/drivers/cfa/doc/html/api/xcfa_8h.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

1362 lines
74 KiB
HTML
Executable file
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xcfa.h 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.h File Reference</h1>
<p>
<code>#include &quot;<a class="el" href="xcfa__hw_8h.html">xcfa_hw.h</a>&quot;</code><br>
<code>#include &quot;xil_assert.h&quot;</code><br>
<code>#include &quot;xstatus.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_cfa___config.html">XCfa_Config</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_cfa.html">XCfa</a></td></tr>
<tr><td colspan="2"><br><h2>Active size range macros</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#f5f6145f9b4bfb90cbe775e79985f564">XCFA_VSIZE_FIRST</a>&nbsp;&nbsp;&nbsp;32</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#e1c5feb95ec6692242d5effdd1e8fef4">XCFA_VSIZE_LAST</a>&nbsp;&nbsp;&nbsp;7680</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#d6f341a462f862b857b034ce61c1d210">XCFA_HSIZE_FIRST</a>&nbsp;&nbsp;&nbsp;32</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#813c1f3adb7beeb8803fe34c75bdc290">XCFA_HSIZE_LAST</a>&nbsp;&nbsp;&nbsp;7680</td></tr>
<tr><td colspan="2"><br><h2>Handler Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="xcfa_8h.html#06fc87d81c62e9abb8790b6e5713c55b4efe200ce2b9d09476b88ac9c13ca34c">XCFA_HANDLER_PROCSTART</a> = 1,
<a class="el" href="xcfa_8h.html#06fc87d81c62e9abb8790b6e5713c55b9220bfc80af3333e1c39d5e04990195b">XCFA_HANDLER_FRAMEDONE</a>,
<a class="el" href="xcfa_8h.html#06fc87d81c62e9abb8790b6e5713c55bf47104882efe33db97eecdfbe6732005">XCFA_HANDLER_ERROR</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Bayer phase</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a4362">XCfa_BayerPhaseCombination</a> { <a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a43621344f0701043b93a31bbd3bcb2dfa220">XCFA_RGRG_COMBINATION</a>,
<a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a4362065a79b379aa7133d3843cbc2166a168">XCFA_GRGR_COMBINATION</a>,
<a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a4362877fcf299fdf12f854fd4836bdd0f627">XCFA_GBGB_COMBINATION</a>,
<a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a4362d49bcfa76555d078d8704371d65db911">XCFA_BGBG_COMBINATION</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#f9231d8984470c426b9007070d6751cd">XCFA_H_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#e33e6a6cfea43dce621494607950f246">XCfa_Enable</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#1e39b3456a5403d5404bd58fd04142e3">XCfa_Disable</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#b8efb3eda668c7a930c444095ac03d6d">XCfa_Start</a>&nbsp;&nbsp;&nbsp;XCfa_Enable</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#f9a56f90dd662dc6f5262da59e2a28de">XCfa_Stop</a>&nbsp;&nbsp;&nbsp;XCfa_Disable</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#9b61463553317fbf13888f08e891badd">XCfa_RegUpdateEnable</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#04ac5dc2b4b371908754f78b480d0fe3">XCfa_RegUpdateDisable</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#22ae9e4eacd467403d3cb7abdc762171">XCfa_SyncReset</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#b286a6fbb3082e5421fe490a15065986">XCfa_Reset</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#668f56e5a0aa0da629730a3b081dc6bb">XCfa_StatusGetPending</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#b39759339350709559d1bcb38992d3d2">XCfa_IntrClear</a>(InstancePtr, IntrType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#61ae031af69dab398bdf4a5488b289d8">XCfa_IntrEnable</a>(InstancePtr, IntrType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#75c9f065af86813e926a9c30fbb68a0d">XCfa_IntrDisable</a>(InstancePtr, IntrType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#1c5bf382084b875e14b4c61d2c59555c">XCfa_IntrGetPending</a>(InstancePtr)</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*)&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#d442a0e0fea25f28031d0075d5365457">XCfa_CallBack</a> (void *CallBackRef)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*)&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#d93600080025d0a2593f3a25f39eb8a2">XCfa_ErrorCallBack</a> (void *CallBackRef, u32 ErrorMask)</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_cfa___config.html">XCfa_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.html#a66ae38886661dd25bc5b5831a32fa11">XCfa_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcfa_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.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_8h.html#2456dd20b52e21211b6fb8ca071d24b4">XCfa_GetBayerPhase</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_8h.html#a5f5c003a9010f557e2f770ebcc8e19c">XCfa_SelfTest</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_8h.html#d87f5a62c5e92e497cdcb08527a3b093">XCfa_IntrHandler</a> (void *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_8h.html#befbc56c01d23f8d80c896e8664eb7ab">XCfa_SetCallBack</a> (<a class="el" href="struct_x_cfa.html">XCfa</a> *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)</td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="1e39b3456a5403d5404bd58fd04142e3"></a><!-- doxytag: member="xcfa.h::XCfa_Disable" ref="1e39b3456a5403d5404bd58fd04142e3" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_Disable </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>), \
((<a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>))) &amp; (~(<a class="code" href="xcfa__hw_8h.html#1d888e578e3393cc25588dddd0d9c892">XCFA_CTL_SW_EN_MASK</a>))))
</pre></div>This function macro disables 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>C-style signature: void <a class="el" href="xcfa_8h.html#1e39b3456a5403d5404bd58fd04142e3">XCfa_Disable(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="e33e6a6cfea43dce621494607950f246"></a><!-- doxytag: member="xcfa.h::XCfa_Enable" ref="e33e6a6cfea43dce621494607950f246" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_Enable </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>), \
((<a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>))) | (<a class="code" href="xcfa__hw_8h.html#1d888e578e3393cc25588dddd0d9c892">XCFA_CTL_SW_EN_MASK</a>)))
</pre></div>This function macro enables 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>C-style signature: void <a class="el" href="xcfa_8h.html#e33e6a6cfea43dce621494607950f246">XCfa_Enable(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f9231d8984470c426b9007070d6751cd"></a><!-- doxytag: member="xcfa.h::XCFA_H_" ref="f9231d8984470c426b9007070d6751cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCFA_H_ </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prevent circular inclusions by using protection macros
</div>
</div><p>
<a class="anchor" name="d6f341a462f862b857b034ce61c1d210"></a><!-- doxytag: member="xcfa.h::XCFA_HSIZE_FIRST" ref="d6f341a462f862b857b034ce61c1d210" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCFA_HSIZE_FIRST&nbsp;&nbsp;&nbsp;32 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Horizontal Size starting value
</div>
</div><p>
<a class="anchor" name="813c1f3adb7beeb8803fe34c75bdc290"></a><!-- doxytag: member="xcfa.h::XCFA_HSIZE_LAST" ref="813c1f3adb7beeb8803fe34c75bdc290" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCFA_HSIZE_LAST&nbsp;&nbsp;&nbsp;7680 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Horizontal Size ending value
</div>
</div><p>
<a class="anchor" name="b39759339350709559d1bcb38992d3d2"></a><!-- doxytag: member="xcfa.h::XCfa_IntrClear" ref="b39759339350709559d1bcb38992d3d2" args="(InstancePtr, IntrType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_IntrClear </td>
<td>(</td>
<td class="paramtype">InstancePtr, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IntrType&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#6a03a0f7308c710638a5d900241d4b86">XCFA_STATUS_OFFSET</a>), ((IntrType) &amp; \
((u32)(<a class="code" href="xcfa__hw_8h.html#abcd0d0167393dabda2ff1878a8ada87">XCFA_IXR_ALLINTR_MASK</a>))))
</pre></div>This function macro clears/acknowledges pending interrupts of the CFA core. in the Status register. Bit positions of 1 will be cleared.<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>IntrType</em>&nbsp;</td><td>is the pending interrupts to clear/acknowledge. Use OR'ing of XCFA_IXR_*_MASK constants defined in <a class="el" href="xcfa__hw_8h.html">xcfa_hw.h</a> to create this parameter value.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xcfa_8h.html#b39759339350709559d1bcb38992d3d2">XCfa_IntrClear(XCfa *InstancePtr, u32 IntrType)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="75c9f065af86813e926a9c30fbb68a0d"></a><!-- doxytag: member="xcfa.h::XCfa_IntrDisable" ref="75c9f065af86813e926a9c30fbb68a0d" args="(InstancePtr, IntrType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_IntrDisable </td>
<td>(</td>
<td class="paramtype">InstancePtr, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IntrType&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#23947952ab4e31e2ef2603afc003ac52">XCFA_IRQ_EN_OFFSET</a>), \
((<a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#23947952ab4e31e2ef2603afc003ac52">XCFA_IRQ_EN_OFFSET</a>))) &amp; ((~(IntrType)) &amp; \
(<a class="code" href="xcfa__hw_8h.html#abcd0d0167393dabda2ff1878a8ada87">XCFA_IXR_ALLINTR_MASK</a>))))
</pre></div>This function macro disables the given individual interrupt(s) on the CFA core by updating Irq_Enable 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>IntrType</em>&nbsp;</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 XCFA_IXR_*_MASK bits defined in <a class="el" href="xcfa__hw_8h.html">xcfa_hw.h</a>.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Any other interrupt not covered by parameter IntrType, if enabled before this macro is called, will remain enabled. C-style signature: void <a class="el" href="xcfa_8h.html#75c9f065af86813e926a9c30fbb68a0d">XCfa_IntrDisable(XCfa *InstancePtr, u32 IntrType)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="61ae031af69dab398bdf4a5488b289d8"></a><!-- doxytag: member="xcfa.h::XCfa_IntrEnable" ref="61ae031af69dab398bdf4a5488b289d8" args="(InstancePtr, IntrType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_IntrEnable </td>
<td>(</td>
<td class="paramtype">InstancePtr, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IntrType&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#23947952ab4e31e2ef2603afc003ac52">XCFA_IRQ_EN_OFFSET</a>), \
(((IntrType) &amp; (<a class="code" href="xcfa__hw_8h.html#abcd0d0167393dabda2ff1878a8ada87">XCFA_IXR_ALLINTR_MASK</a>)) | \
(<a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#23947952ab4e31e2ef2603afc003ac52">XCFA_IRQ_EN_OFFSET</a>)))))
</pre></div>This function macro enables the given individual interrupt(s) on 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>
<tr><td valign="top"></td><td valign="top"><em>IntrType</em>&nbsp;</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 XCFA_IXR_*_MASK bits defined in <a class="el" href="xcfa__hw_8h.html">xcfa_hw.h</a>.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>The existing enabled interrupt(s) will remain enabled. C-style signature: void <a class="el" href="xcfa_8h.html#61ae031af69dab398bdf4a5488b289d8">XCfa_IntrEnable(XCfa *InstancePtr, u32 IntrType)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1c5bf382084b875e14b4c61d2c59555c"></a><!-- doxytag: member="xcfa.h::XCfa_IntrGetPending" ref="1c5bf382084b875e14b4c61d2c59555c" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_IntrGetPending </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#23947952ab4e31e2ef2603afc003ac52">XCFA_IRQ_EN_OFFSET</a>)) &amp; \
((<a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#6a03a0f7308c710638a5d900241d4b86">XCFA_STATUS_OFFSET</a>))) &amp; ((u32)(<a class="code" href="xcfa__hw_8h.html#abcd0d0167393dabda2ff1878a8ada87">XCFA_IXR_ALLINTR_MASK</a>)))
</pre></div>This function macro returns the pending interrupts 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>The pending interrupts of the CFA. Use XCFA_IXR_*_MASK constants defined in <a class="el" href="xcfa__hw_8h.html">xcfa_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>
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xcfa_8h.html#1c5bf382084b875e14b4c61d2c59555c">XCfa_IntrGetPending(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="04ac5dc2b4b371908754f78b480d0fe3"></a><!-- doxytag: member="xcfa.h::XCfa_RegUpdateDisable" ref="04ac5dc2b4b371908754f78b480d0fe3" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_RegUpdateDisable </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>), \
((<a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>)))) &amp; (~(<a class="code" href="xcfa__hw_8h.html#74f3589a4e236b3b275124108b596af4">XCFA_CTL_RUE_MASK</a>)))
</pre></div>This function macro prevents the CFA core from committing recent changes made so far by the software. When disabled, changes to other configuration registers are stored, but do not effect the behavior of the 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>C-style signature: void <a class="el" href="xcfa_8h.html#04ac5dc2b4b371908754f78b480d0fe3">XCfa_RegUpdateDisable(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9b61463553317fbf13888f08e891badd"></a><!-- doxytag: member="xcfa.h::XCfa_RegUpdateEnable" ref="9b61463553317fbf13888f08e891badd" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_RegUpdateEnable </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>), \
((<a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>))) | (<a class="code" href="xcfa__hw_8h.html#74f3589a4e236b3b275124108b596af4">XCFA_CTL_RUE_MASK</a>)))
</pre></div>This function macro commits all the register value changes made so far by the software to 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>C-style signature: void <a class="el" href="xcfa_8h.html#9b61463553317fbf13888f08e891badd">XCfa_RegUpdateEnable(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b286a6fbb3082e5421fe490a15065986"></a><!-- doxytag: member="xcfa.h::XCfa_Reset" ref="b286a6fbb3082e5421fe490a15065986" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_Reset </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>), (<a class="code" href="xcfa__hw_8h.html#51983418ed95f2d8a65fc556ed0ce954">XCFA_CTL_RESET_MASK</a>))
</pre></div>This macro resets CFA core instance. This reset effects the core immediately and may cause image tearing.<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>C-style signature: void <a class="el" href="xcfa_8h.html#b286a6fbb3082e5421fe490a15065986">XCfa_Reset(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b8efb3eda668c7a930c444095ac03d6d"></a><!-- doxytag: member="xcfa.h::XCfa_Start" ref="b8efb3eda668c7a930c444095ac03d6d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_Start&nbsp;&nbsp;&nbsp;XCfa_Enable </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function macro enables/starts 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>C-style signature: void <a class="el" href="xcfa_8h.html#b8efb3eda668c7a930c444095ac03d6d">XCfa_Start(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="668f56e5a0aa0da629730a3b081dc6bb"></a><!-- doxytag: member="xcfa.h::XCfa_StatusGetPending" ref="668f56e5a0aa0da629730a3b081dc6bb" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_StatusGetPending </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#09d781729f1b6207f4bade195c0b10f7">XCfa_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#6a03a0f7308c710638a5d900241d4b86">XCFA_STATUS_OFFSET</a>)) &amp; (<a class="code" href="xcfa__hw_8h.html#abcd0d0167393dabda2ff1878a8ada87">XCFA_IXR_ALLINTR_MASK</a>)
</pre></div>This function macro returns the pending status of a 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>The pending interrupts of the CFA core. Use XCFA_IXR_*_MASK constants defined in <a class="el" href="xcfa__hw_8h.html">xcfa_hw.h</a> to interpret this value.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: u32 XCfa_StatusGePending(XCfa *InstancePtr) </dd></dl>
</div>
</div><p>
<a class="anchor" name="f9a56f90dd662dc6f5262da59e2a28de"></a><!-- doxytag: member="xcfa.h::XCfa_Stop" ref="f9a56f90dd662dc6f5262da59e2a28de" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_Stop&nbsp;&nbsp;&nbsp;XCfa_Disable </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function macro disables/stops 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>C-style signature: void <a class="el" href="xcfa_8h.html#f9a56f90dd662dc6f5262da59e2a28de">XCfa_Stop(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="22ae9e4eacd467403d3cb7abdc762171"></a><!-- doxytag: member="xcfa.h::XCfa_SyncReset" ref="22ae9e4eacd467403d3cb7abdc762171" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCfa_SyncReset </td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xcfa__hw_8h.html#2c38538d92baf9193afd133dec3aad5b">XCfa_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xcfa__hw_8h.html#4d9258611512a367a6409eb9680b281f">XCFA_CONTROL_OFFSET</a>), (<a class="code" href="xcfa__hw_8h.html#55ebebcb836c04b9d3a0aee7ab334d6d">XCFA_CTL_AUTORESET_MASK</a>))
</pre></div>This function macro resets a CFA core at the end of the frame being processed. It enables core automatically synchronizes to the SOF of the core to prevent image tearing. This function macro is differ from <a class="el" href="xcfa_8h.html#b286a6fbb3082e5421fe490a15065986">XCfa_Reset()</a>.<p>
On the next rising-edge of SOF following a call to <a class="el" href="xcfa_8h.html#22ae9e4eacd467403d3cb7abdc762171">XCfa_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>
<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>C-style signature: void <a class="el" href="xcfa_8h.html#22ae9e4eacd467403d3cb7abdc762171">XCfa_SyncReset(XCfa *InstancePtr)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f5f6145f9b4bfb90cbe775e79985f564"></a><!-- doxytag: member="xcfa.h::XCFA_VSIZE_FIRST" ref="f5f6145f9b4bfb90cbe775e79985f564" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCFA_VSIZE_FIRST&nbsp;&nbsp;&nbsp;32 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Vertical Size starting value
</div>
</div><p>
<a class="anchor" name="e1c5feb95ec6692242d5effdd1e8fef4"></a><!-- doxytag: member="xcfa.h::XCFA_VSIZE_LAST" ref="e1c5feb95ec6692242d5effdd1e8fef4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCFA_VSIZE_LAST&nbsp;&nbsp;&nbsp;7680 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Vertical Size ending value
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="d442a0e0fea25f28031d0075d5365457"></a><!-- doxytag: member="xcfa.h::XCfa_CallBack" ref="d442a0e0fea25f28031d0075d5365457" args="(void *CallBackRef)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(*) <a class="el" href="xcfa_8h.html#d442a0e0fea25f28031d0075d5365457">XCfa_CallBack</a>(void *CallBackRef) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback type for all interrupts except error interrupt.<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>CallBackRef</em>&nbsp;</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>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d93600080025d0a2593f3a25f39eb8a2"></a><!-- doxytag: member="xcfa.h::XCfa_ErrorCallBack" ref="d93600080025d0a2593f3a25f39eb8a2" args="(void *CallBackRef, u32 ErrorMask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(*) <a class="el" href="xcfa_8h.html#d93600080025d0a2593f3a25f39eb8a2">XCfa_ErrorCallBack</a>(void *CallBackRef, u32 ErrorMask) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback type for error interrupt.<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>CallBackRef</em>&nbsp;</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><td valign="top"></td><td valign="top"><em>ErrorMask</em>&nbsp;</td><td>is a bit mask indicating the cause of the error. Its value equals 'OR'ing one or more XCFA_IXR_*_MASK values defined in <a class="el" href="xcfa__hw_8h.html">xcfa_hw.h</a>. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b"></a><!-- doxytag: member="xcfa.h::@0" ref="06fc87d81c62e9abb8790b6e5713c55b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These constants specify different types of handlers and used to differentiate interrupt requests from core. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b4efe200ce2b9d09476b88ac9c13ca34c"></a><!-- doxytag: member="XCFA_HANDLER_PROCSTART" ref="06fc87d81c62e9abb8790b6e5713c55b4efe200ce2b9d09476b88ac9c13ca34c" args="" -->XCFA_HANDLER_PROCSTART</em>&nbsp;</td><td>
A processing start event interrupt type </td></tr>
<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b9220bfc80af3333e1c39d5e04990195b"></a><!-- doxytag: member="XCFA_HANDLER_FRAMEDONE" ref="06fc87d81c62e9abb8790b6e5713c55b9220bfc80af3333e1c39d5e04990195b" args="" -->XCFA_HANDLER_FRAMEDONE</em>&nbsp;</td><td>
A frame done event interrupt type </td></tr>
<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55bf47104882efe33db97eecdfbe6732005"></a><!-- doxytag: member="XCFA_HANDLER_ERROR" ref="06fc87d81c62e9abb8790b6e5713c55bf47104882efe33db97eecdfbe6732005" args="" -->XCFA_HANDLER_ERROR</em>&nbsp;</td><td>
An error condition interrupt type </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="35d3b821b350bd181c6d75ce422a4362"></a><!-- doxytag: member="xcfa.h::XCfa_BayerPhaseCombination" ref="35d3b821b350bd181c6d75ce422a4362" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="xcfa_8h.html#35d3b821b350bd181c6d75ce422a4362">XCfa_BayerPhaseCombination</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These constants specify Bayer phase combinations of the core. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="35d3b821b350bd181c6d75ce422a43621344f0701043b93a31bbd3bcb2dfa220"></a><!-- doxytag: member="XCFA_RGRG_COMBINATION" ref="35d3b821b350bd181c6d75ce422a43621344f0701043b93a31bbd3bcb2dfa220" args="" -->XCFA_RGRG_COMBINATION</em>&nbsp;</td><td>
Red green combination </td></tr>
<tr><td valign="top"><em><a class="anchor" name="35d3b821b350bd181c6d75ce422a4362065a79b379aa7133d3843cbc2166a168"></a><!-- doxytag: member="XCFA_GRGR_COMBINATION" ref="35d3b821b350bd181c6d75ce422a4362065a79b379aa7133d3843cbc2166a168" args="" -->XCFA_GRGR_COMBINATION</em>&nbsp;</td><td>
Green red combination </td></tr>
<tr><td valign="top"><em><a class="anchor" name="35d3b821b350bd181c6d75ce422a4362877fcf299fdf12f854fd4836bdd0f627"></a><!-- doxytag: member="XCFA_GBGB_COMBINATION" ref="35d3b821b350bd181c6d75ce422a4362877fcf299fdf12f854fd4836bdd0f627" args="" -->XCFA_GBGB_COMBINATION</em>&nbsp;</td><td>
Green blue combination </td></tr>
<tr><td valign="top"><em><a class="anchor" name="35d3b821b350bd181c6d75ce422a4362d49bcfa76555d078d8704371d65db911"></a><!-- doxytag: member="XCFA_BGBG_COMBINATION" ref="35d3b821b350bd181c6d75ce422a4362d49bcfa76555d078d8704371d65db911" args="" -->XCFA_BGBG_COMBINATION</em>&nbsp;</td><td>
Blue green combination </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="f21a4a9fe167729fd388e53a9ae467d9"></a><!-- doxytag: member="xcfa.h::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.h::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.h::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.h::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.h::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.h::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.h::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.h::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.h::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.h::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.h::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="d87f5a62c5e92e497cdcb08527a3b093"></a><!-- doxytag: member="xcfa.h::XCfa_IntrHandler" ref="d87f5a62c5e92e497cdcb08527a3b093" args="(void *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XCfa_IntrHandler </td>
<td>(</td>
<td class="paramtype">void *&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 is the interrupt handler for the CFA core.<p>
This handler reads the pending interrupt from the STATUS register, determines the source of the interrupts and calls the respective callbacks for the interrupts that are enabled in IRQ_ENABLE register, and finally clears the interrupts.<p>
The application is responsible for connecting this function to the interrupt system. Application beyond this core is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="xcfa_8h.html#befbc56c01d23f8d80c896e8664eb7ab">XCfa_SetCallBack()</a> during initialization phase.<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 that just interrupted.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Interrupt interface should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="20b43ecec565a3e404cf16368142775b"></a><!-- doxytag: member="xcfa.h::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.h::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="a66ae38886661dd25bc5b5831a32fa11"></a><!-- doxytag: member="xcfa.h::XCfa_LookupConfig" ref="a66ae38886661dd25bc5b5831a32fa11" args="(u16 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_cfa___config.html">XCfa_Config</a>* XCfa_LookupConfig </td>
<td>(</td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>DeviceId</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns a reference to an <a class="el" href="struct_x_cfa___config.html">XCfa_Config</a> structure based on the unique device id, <em>DeviceId</em>. The return value will refer to an entry in the device configuration table defined in the <a class="el" href="xcfa__g_8c.html">xcfa_g.c</a> file.<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>DeviceId</em>&nbsp;</td><td>is the unique device ID of the core for the lookup operation.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>CfgPtr is a reference to a config record in the configuration table (in <a class="el" href="xcfa__g_8c.html">xcfa_g.c</a>) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a5f5c003a9010f557e2f770ebcc8e19c"></a><!-- doxytag: member="xcfa.h::XCfa_SelfTest" ref="a5f5c003a9010f557e2f770ebcc8e19c" args="(XCfa *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XCfa_SelfTest </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 reads complete Version register of CFA core and compares with zero values as part of self test.<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><ul>
<li>XST_SUCCESS if the Version register read test was successful.</li><li>XST_FAILURE if the Version register read test failed.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ee423f2591247f27520ff2ed16bb566f"></a><!-- doxytag: member="xcfa.h::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.h::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="befbc56c01d23f8d80c896e8664eb7ab"></a><!-- doxytag: member="xcfa.h::XCfa_SetCallBack" ref="befbc56c01d23f8d80c896e8664eb7ab" args="(XCfa *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XCfa_SetCallBack </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">u32&nbsp;</td>
<td class="paramname"> <em>HandlerType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>CallBackFunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>CallBackRef</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>
</div>
</div><p>
<a class="anchor" name="37662371560e8ef83e5c22c6bc1f8252"></a><!-- doxytag: member="xcfa.h::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.
Reference in a new issue View git blame Copy permalink