stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Deinterlacer: Updated doxygen report

Browse source 
Doxygen report has been updated.

Signed-off-by: Durga challa <vnsldurg@xilinx.com>
This commit is contained in:
Durga challa 2014-09-03 15:43:55 +05:30 • committed by Suneel Garapati
parent 0946e1fa38
commit 0d9a4eb454
4 changed files with 25 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
XilinxProcessorIPLib/drivers/deinterlacer/doc/html/api/index.html
View file

@ -2,7 +2,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Deinterlacer
Deinterlacer v3_2
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
</head>
@ -16,7 +16,7 @@
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<h1>Deinterlacer</h1>
<h1>Deinterlacer v3_2</h1>
<p>
This is the main header file of Xilinx Video Deinterlacer core.<p>
<b>Interrupt Service </b><p>
@ -35,7 +35,9 @@ Example(s) are provided with this driver to demonstrate the self test.<p>
1.00a rjh 07/10/11 First release
2.00a rjh 18/01/12 Updated for v_deinterlacer 2.00
3.0 adk 19/12/13 Updated as per the New Tcl API's.
3.2 adk 02/13/14 Added Doxygen support, adherence to Xilinx
3.2 adk 02/13/14 Modified XDeint_IntrDisable macro replace ISR_OFFSET
with IER OFFSET, XDeint_InReset.
Added Doxygen support, adherence to Xilinx
coding standards.</pre><p>
<pre> Modification history of <a class="el" href="xdeint__sinit_8c.html">xdeint_sinit.c</a>:
Added Doxygen support, adherence to Xilinx

10
XilinxProcessorIPLib/drivers/deinterlacer/doc/html/api/xdeint_8h.html
View file

@ -223,14 +223,14 @@
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xdeint__hw_8h.html#23f0a76b05af8e52c359a2330f0785e1">XDeint_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xdeint__hw_8h.html#a4ddf97ec440161ec497fbc15a072e59">XDEINT_MODE_OFFSET</a>)) &amp; (<a class="code" href="xdeint__hw_8h.html#95dc03a814c7f9ff2800b5949e0e5f05">XDEINT_MODE_COLOUR_YUV</a>)
(<a class="code" href="xdeint__hw_8h.html#a4ddf97ec440161ec497fbc15a072e59">XDEINT_MODE_OFFSET</a>)) &amp; (<a class="code" href="xdeint__hw_8h.html#4ba135e2728b4eafc68280dae1bd0f7d">XDEINT_MODE_COL</a>)
</pre></div>This macro gets the Deinterlacer's color space.<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 <a class="el" href="struct_x_deint.html">XDeint</a> instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Returns the color space. 0x00000004 - YUV color space, 0x00000000 - RGB color space.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>Returns the color space. 0x00000004 - RGB color space, 0x00000000 - YUV color space.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xdeint_8h.html#6600d1eb9d04bbd03edf2bfc046545f3">XDeint_GetColorSpace(XDeint *InstancePtr)</a> </dd></dl>
</div>
@ -282,8 +282,8 @@ Internal Register update done
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xdeint__hw_8h.html#23f0a76b05af8e52c359a2330f0785e1">XDeint_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xdeint__hw_8h.html#8535b5f3d0aa09f4283330f3d8fc5b84">XDEINT_RESET_OFFSET</a>))
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xdeint__hw_8h.html#23f0a76b05af8e52c359a2330f0785e1">XDeint_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xdeint__hw_8h.html#8535b5f3d0aa09f4283330f3d8fc5b84">XDEINT_RESET_OFFSET</a>)) &amp; (<a class="code" href="xdeint__hw_8h.html#29cda40e0d5cccf062e9af72a58af84c">XDEINT_RESET_RESET_MASK</a>))
</pre></div>This macro returns the current soft-reset state.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
@ -353,7 +353,7 @@ Internal Register update done
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xdeint__hw_8h.html#8fcf5f5163b0b7e0e2bdf9a2aa3a63df">XDeint_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddress, \
(<a class="code" href="xdeint__hw_8h.html#064dfe4f2be460786dbe3839dc2c5548">XDEINT_IER_OFFSET</a>), ((~(IntrType)) &amp; \
(<a class="code" href="xdeint__hw_8h.html#f766950c11d76b491d2817e7b71132d5">XDEINT_IXR_ALLINTR_MASK</a>)) &amp; \
<a class="code" href="xdeint__hw_8h.html#23f0a76b05af8e52c359a2330f0785e1">XDeint_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="xdeint__hw_8h.html#dd2b35c78b464c2e7ae57774ae739a11">XDEINT_ISR_OFFSET</a>)))
<a class="code" href="xdeint__hw_8h.html#23f0a76b05af8e52c359a2330f0785e1">XDeint_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddress, (<a class="code" href="xdeint__hw_8h.html#064dfe4f2be460786dbe3839dc2c5548">XDEINT_IER_OFFSET</a>)))
</pre></div>This macro disables the given individual interrupt(s) on the Deinterlacer core.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">

4
XilinxProcessorIPLib/drivers/deinterlacer/doc/html/api/xdeint__g_8c.html
View file

@ -55,8 +55,8 @@ This file contains a template for configuration table of Xilinx Video Deinterlac
<p>
<b>Initial value:</b><div class="fragment"><pre class="fragment"> {
{
XPAR_FMC_SENSOR_INPUT_V_DEINTERLACER_1_DEVICE_ID,
XPAR_FMC_SENSOR_INPUT_V_DEINTERLACER_1__BASEADDR
0,
0x4300000
}
}
</pre></div>The configuration table for Video Deinterlacers devices

23
XilinxProcessorIPLib/drivers/deinterlacer/doc/html/api/xdeint__hw_8h.html
View file

@ -33,6 +33,9 @@ For more information about the operation of this core, see the hardware specific
3.2 adk 02/13/14 Suffixed "_OFFSET" to all register offset macros.
Added bit masks for the registers and added
backward compatibility for macros.
Swapped bit definitions of XDEINT_MODE_COLOUR_YUV
and XDEINT_MODE_COLOUR_RGB.
Modified bit definitions of version register.
</pre>
<p>
<code>#include &quot;xil_io.h&quot;</code><br>
@ -106,11 +109,11 @@ For more information about the operation of this core, see the hardware specific
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#025d2faf550c2294aa9c3fa46ffc31c1">XDEINT_STS_FS_RD_FRAME_ERROR</a>&nbsp;&nbsp;&nbsp;0x00000800</td></tr>
<tr><td colspan="2"><br><h2>Deinterlacer Control Fields:</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#2d2bb014d89e424d8d75e6517fc22e65">XDEINT_VER_MAJOR_MASK</a>&nbsp;&nbsp;&nbsp;0xF0000000</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#2d2bb014d89e424d8d75e6517fc22e65">XDEINT_VER_MAJOR_MASK</a>&nbsp;&nbsp;&nbsp;0xFF000000</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#242adae9cf3d19d888a7dba37825101f">XDEINT_VER_MAJOR_SHIFT</a>&nbsp;&nbsp;&nbsp;28</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#242adae9cf3d19d888a7dba37825101f">XDEINT_VER_MAJOR_SHIFT</a>&nbsp;&nbsp;&nbsp;24</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#d642c1f4a5c822380bd42fdccff84609">XDEINT_VER_MINOR_MASK</a>&nbsp;&nbsp;&nbsp;0x0FF00000</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#d642c1f4a5c822380bd42fdccff84609">XDEINT_VER_MINOR_MASK</a>&nbsp;&nbsp;&nbsp;0x00F00000</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#eb1fa591fc484a947fa092a6e4122df3">XDEINT_VER_MINOR_SHIFT</a>&nbsp;&nbsp;&nbsp;20</td></tr>
@ -146,9 +149,9 @@ For more information about the operation of this core, see the hardware specific
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#80ea288bb53f964b7c6434f5c167c17d">XDEINT_MODE_PULL_22_FIELDP</a>&nbsp;&nbsp;&nbsp;0x00000200</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#0a3b9c44cc615bd2a23a7bd364f6a2b1">XDEINT_MODE_COLOUR_RGB</a>&nbsp;&nbsp;&nbsp;0x00000000</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#95dc03a814c7f9ff2800b5949e0e5f05">XDEINT_MODE_COLOUR_YUV</a>&nbsp;&nbsp;&nbsp;0x00000000</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#95dc03a814c7f9ff2800b5949e0e5f05">XDEINT_MODE_COLOUR_YUV</a>&nbsp;&nbsp;&nbsp;0x00000004</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#0a3b9c44cc615bd2a23a7bd364f6a2b1">XDEINT_MODE_COLOUR_RGB</a>&nbsp;&nbsp;&nbsp;0x00000004</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdeint__hw_8h.html#6404ad7d41d8f173f028d177f029c19d">XDEINT_MODE_ALGORITHM_RAW</a>&nbsp;&nbsp;&nbsp;0x00000000</td></tr>
@ -950,7 +953,7 @@ Color Space
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDEINT_MODE_COLOUR_RGB&nbsp;&nbsp;&nbsp;0x00000000 </td>
<td class="memname">#define XDEINT_MODE_COLOUR_RGB&nbsp;&nbsp;&nbsp;0x00000004 </td>
</tr>
</table>
</div>
@ -965,7 +968,7 @@ Deinterlacer color space
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDEINT_MODE_COLOUR_YUV&nbsp;&nbsp;&nbsp;0x00000004 </td>
<td class="memname">#define XDEINT_MODE_COLOUR_YUV&nbsp;&nbsp;&nbsp;0x00000000 </td>
</tr>
</table>
</div>
@ -1492,7 +1495,7 @@ Deinterlacer threshold
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDEINT_VER_MAJOR_MASK&nbsp;&nbsp;&nbsp;0xF0000000 </td>
<td class="memname">#define XDEINT_VER_MAJOR_MASK&nbsp;&nbsp;&nbsp;0xFF000000 </td>
</tr>
</table>
</div>
@ -1507,7 +1510,7 @@ Major Version
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDEINT_VER_MAJOR_SHIFT&nbsp;&nbsp;&nbsp;28 </td>
<td class="memname">#define XDEINT_VER_MAJOR_SHIFT&nbsp;&nbsp;&nbsp;24 </td>
</tr>
</table>
</div>
@ -1522,7 +1525,7 @@ Major Bit Shift
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XDEINT_VER_MINOR_MASK&nbsp;&nbsp;&nbsp;0x0FF00000 </td>
<td class="memname">#define XDEINT_VER_MINOR_MASK&nbsp;&nbsp;&nbsp;0x00F00000 </td>
</tr>
</table>
</div>