589fcf6173
Added doxygen report to cresample. Signed-off-by: Durga challa <vnsldurg@xilinx.com> Acked-by: Srikanth Vemula <svemula@xilinx.com>
1738 lines
95 KiB
HTML
1738 lines
95 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
xcresample.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 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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul></div>
|
|
<h1>xcresample.h File Reference</h1>
|
|
<p>
|
|
<code>#include "xil_assert.h"</code><br>
|
|
<code>#include "xstatus.h"</code><br>
|
|
<code>#include "<a class="el" href="xcresample__hw_8h.html">xcresample_hw.h</a>"</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_cresample___config.html">XCresample_Config</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_cresample.html">XCresample</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_horizontal___coeffs.html">XHorizontal_Coeffs</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vertical___coeffs.html">XVertical_Coeffs</a></td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Active size ranges</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#f63af0982f1bd962ac5a312b828c8721">XCRE_ACT_SIZE_FIRST</a> 32</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#136d63a0178f60dde5ddac0364937cf4">XCRE_ACT_SIZE_LAST</a> 7680</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Parity valid values</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#494cc8b60107da468cb81b91257870c4">XCRE_PARITY_ODD</a> 1</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#de5ba0c5d3d48674a1353be0ef116e1a">XCRE_PARITY_EVEN</a> 0</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Coefficient ranges</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#893c2ffc0ea9e190f79bd3e5f13f8252">XCRE_COEF_FIRST</a> -2.0</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#e176b747b4a9f942f04fd66d49588506">XCRE_COEF_LAST</a> 2.0</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#130b1722acdea90f21b4b609413f045d">XCRE_OFFSET_DIFF</a> 4</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Number of phases</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#200680a2c13a7b5fe0ebdcdd749fb529">XCRE_NUM_OF_PHASES</a> 2</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Number of coefficients</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#9e78a3d9d7a6101968da7f61994ca07b">XCRE_NUM_HCOEFS</a> 24</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#769382097198ca3b9e289c17423f4474">XCRE_NUM_VCOEFS</a> 8</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Interrupt types for setting up callbacks</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="xcresample_8h.html#06fc87d81c62e9abb8790b6e5713c55b2e832b1f4fcf559e0f4332335af75f41">XCRE_HANDLER_PROCSTART</a> = 1,
|
|
<a class="el" href="xcresample_8h.html#06fc87d81c62e9abb8790b6e5713c55ba91551216aeabd02512d523ac8fb2c11">XCRE_HANDLER_FRAMEDONE</a>,
|
|
<a class="el" href="xcresample_8h.html#06fc87d81c62e9abb8790b6e5713c55b81213bb998c9b080628d6b4ba81fba82">XCRE_HANDLER_ERROR</a>
|
|
}</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#4b6e0fce9fca9a9a2de11d88c16c487f">XCRESAMPLE_H_</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#3959dfbfb1df910ec834a2822f80ddb5">XCresample_Enable</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#538198323ff4ebdaad13c9dbd18a2c48">XCresample_Disable</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#862c5f4fbabe14d1e123362c96338d79">XCresample_Start</a> XCresample_Enable</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#af714ddac2ad4276bc638c1ab7aacb68">XCresample_Stop</a> XCresample_Disable</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#dd46d2225bcce47d5fa206321bb8cab4">XCresample_RegUpdateEnable</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#270b9455b25b2c28fc69609cc5c448d8">XCresample_RegUpdateDisable</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#56d3a5b5c6a70eaba4a4bcb1bd9d5cb7">XCresample_SyncReset</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#98346f522e3aed9eb5b6e7c09416cdd7">XCresample_Reset</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#4dd2462144560958335ae4f3ca6980e4">XCresample_IntrEnable</a>(InstancePtr, IntrType)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#f6cab4f4644f86807a3ff1c38057fb75">XCresample_IntrDisable</a>(InstancePtr, IntrType)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#4d1cb2f8998ad720729b08fe8f927a51">XCresample_StatusGetPending</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#34d7b704fc70030c94820f5c59c764e3">XCresample_IntrGetPending</a>(InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#f3f4748686f455f741ad19935ab5ac26">XCresample_IntrClear</a>(InstancePtr, IntrType)</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#cfcc5b01138710a38260b9ce921f491c">XCresample_CallBack</a> (void *CallBackRef)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#a909cac5656fedc4f0ea205c823140d1">XCresample_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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#386a0f9c22e6409060fd966a66d8aa66">XCresample_CfgInitialize</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, <a class="el" href="struct_x_cresample___config.html">XCresample_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#759917fbb8599a22fdfe5619ce13a3b2">XCresample_GetVersion</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#930ea9583c5dd76de763fae86d6b1eff">XCresample_EnableDbgByPass</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#e8267377a15da7e199a393c47baf42e1">XCresample_IsDbgByPassEnabled</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#c15c402d317aea7dbcdabdae1c6d8e6c">XCresample_DisableDbgBypass</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#32b603c19c2afaee47a70dde41fdcaa1">XCresample_EnableDbgTestPattern</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#e8fb855ff8ece1b628d69f9cd0eebd5a">XCresample_IsDbgTestPatternEnabled</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#1f6adeb2af84970d6d20a70be30169dd">XCresample_DisableDbgTestPattern</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#b4f2fab7cafe12c0dd55b63f8a4f9bb2">XCresample_GetDbgFrameCount</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#81ee6e5159f9173134f5203f079c19d6">XCresample_GetDbgLineCount</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#dae07783fcaf65425e70d97648cbf04e">XCresample_GetDbgPixelCount</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#a92fd02ee15f7f102dde33a7b2d904d3">XCresample_SetActiveSize</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u16 HSize, u16 VSize)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#d8b448647610e20e45f560ed50465d15">XCresample_GetActiveSize</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u16 *HSize, u16 *VSize)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#f88e4da9bfb514e7f31550e4763b5ff1">XCresample_SetFieldParity</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u8 FieldParity)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#81bd9651d3634a4f93adc0c9aa377bd4">XCresample_SetChromaParity</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u8 ChromaParity)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#3033cdcbecf61fea37bc9b1795636bf7">XCresample_GetFieldParity</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#2871e4a4446a101e00ace372810342ce">XCresample_GetChromaParity</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#fe19dfb901944a21c9318301322075e6">XCresample_SetHCoefs</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, <a class="el" href="struct_x_horizontal___coeffs.html">XHorizontal_Coeffs</a> *Coeff, u32 Phases)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#5f9ac7e61cd69dd5843a4a95eff0ba21">XCresample_SetVCoefs</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, <a class="el" href="struct_x_vertical___coeffs.html">XVertical_Coeffs</a> *Coeff, u32 Phases)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#676b8cfd788ad69cd9c622e2a4953bed">XCresample_GetHCoefs</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, <a class="el" href="struct_x_horizontal___coeffs.html">XHorizontal_Coeffs</a> *Coeff)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#81bd4ca76afc9607d8cc69afeb957b5f">XCresample_GetVCoefs</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, <a class="el" href="struct_x_vertical___coeffs.html">XVertical_Coeffs</a> *Coeff)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_cresample___config.html">XCresample_Config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#5a31b77d26816fa1c1b5b37ff46207f6">XCresample_LookupConfig</a> (u16 DeviceId)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#120e094a3de7a49d4b5e3808ad7fadd2">XCresample_SelfTest</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#b0eaff626a3784bde0d6ac0b9e168992">XCresample_SetCallBack</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#d3db1c393abaf5003a47b95c7399d1b7">XCresample_IntrHandler</a> (void *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#1d749808d07e3987e21fb3ec7b54c3a2">XCresample_Clear_HCoef_Values</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xcresample_8h.html#d3c15e9a7607730c4d6bab0bff8af610">XCresample_Clear_VCoef_Values</a> (<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr)</td></tr>
|
|
|
|
</table>
|
|
<hr><h2>Define Documentation</h2>
|
|
<a class="anchor" name="f63af0982f1bd962ac5a312b828c8721"></a><!-- doxytag: member="xcresample.h::XCRE_ACT_SIZE_FIRST" ref="f63af0982f1bd962ac5a312b828c8721" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_ACT_SIZE_FIRST 32 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Active Size starting value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="136d63a0178f60dde5ddac0364937cf4"></a><!-- doxytag: member="xcresample.h::XCRE_ACT_SIZE_LAST" ref="136d63a0178f60dde5ddac0364937cf4" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_ACT_SIZE_LAST 7680 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Active Size ending value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="893c2ffc0ea9e190f79bd3e5f13f8252"></a><!-- doxytag: member="xcresample.h::XCRE_COEF_FIRST" ref="893c2ffc0ea9e190f79bd3e5f13f8252" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_COEF_FIRST -2.0 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Coefficient start value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e176b747b4a9f942f04fd66d49588506"></a><!-- doxytag: member="xcresample.h::XCRE_COEF_LAST" ref="e176b747b4a9f942f04fd66d49588506" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_COEF_LAST 2.0 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Coefficient end value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="9e78a3d9d7a6101968da7f61994ca07b"></a><!-- doxytag: member="xcresample.h::XCRE_NUM_HCOEFS" ref="9e78a3d9d7a6101968da7f61994ca07b" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_NUM_HCOEFS 24 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Number of horizontal coefficients
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="200680a2c13a7b5fe0ebdcdd749fb529"></a><!-- doxytag: member="xcresample.h::XCRE_NUM_OF_PHASES" ref="200680a2c13a7b5fe0ebdcdd749fb529" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_NUM_OF_PHASES 2 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Number of phases
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="769382097198ca3b9e289c17423f4474"></a><!-- doxytag: member="xcresample.h::XCRE_NUM_VCOEFS" ref="769382097198ca3b9e289c17423f4474" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_NUM_VCOEFS 8 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Number of vertical coefficients
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="130b1722acdea90f21b4b609413f045d"></a><!-- doxytag: member="xcresample.h::XCRE_OFFSET_DIFF" ref="130b1722acdea90f21b4b609413f045d" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_OFFSET_DIFF 4 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Coefficient offset difference
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="de5ba0c5d3d48674a1353be0ef116e1a"></a><!-- doxytag: member="xcresample.h::XCRE_PARITY_EVEN" ref="de5ba0c5d3d48674a1353be0ef116e1a" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_PARITY_EVEN 0 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
For even (or bottom) field it is 0
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="494cc8b60107da468cb81b91257870c4"></a><!-- doxytag: member="xcresample.h::XCRE_PARITY_ODD" ref="494cc8b60107da468cb81b91257870c4" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRE_PARITY_ODD 1 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
For odd (or top) field it is 1
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="538198323ff4ebdaad13c9dbd18a2c48"></a><!-- doxytag: member="xcresample.h::XCresample_Disable" ref="538198323ff4ebdaad13c9dbd18a2c48" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_Disable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>))) & (~(<a class="code" href="xcresample__hw_8h.html#9f8f91473ed9544ea408ab041203f53c">XCRE_CTL_SW_EN_MASK</a>))))
|
|
</pre></div>This macro disables the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#538198323ff4ebdaad13c9dbd18a2c48">XCresample_Disable(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="3959dfbfb1df910ec834a2822f80ddb5"></a><!-- doxytag: member="xcresample.h::XCresample_Enable" ref="3959dfbfb1df910ec834a2822f80ddb5" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_Enable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>))) | (<a class="code" href="xcresample__hw_8h.html#9f8f91473ed9544ea408ab041203f53c">XCRE_CTL_SW_EN_MASK</a>)))
|
|
</pre></div>This macro enables the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#3959dfbfb1df910ec834a2822f80ddb5">XCresample_Enable(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4b6e0fce9fca9a9a2de11d88c16c487f"></a><!-- doxytag: member="xcresample.h::XCRESAMPLE_H_" ref="4b6e0fce9fca9a9a2de11d88c16c487f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCRESAMPLE_H_ </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Prevent circular inclusions by using protection macros
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f3f4748686f455f741ad19935ab5ac26"></a><!-- doxytag: member="xcresample.h::XCresample_IntrClear" ref="f3f4748686f455f741ad19935ab5ac26" args="(InstancePtr, IntrType)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_IntrClear </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, <tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">IntrType </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#87730ba30704098d260a67036eaa6f01">XCRE_STATUS_OFFSET</a>), \
|
|
((IntrType) & ((u32)(<a class="code" href="xcresample__hw_8h.html#97004e97b72f36a24dc2d91e19358a99">XCRE_IXR_ALLINTR_MASK</a>))))
|
|
</pre></div>This macro clears/acknowledges pending interrupts of the Cresample 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IntrType</em> </td><td>is the pending interrupts to clear/acknowledge. Use OR'ing of XCRE_IXR_*_MASK constants defined in <a class="el" href="xcresample__hw_8h.html">xcresample_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 XCresample_IntrClear(<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u32 IntrType) </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f6cab4f4644f86807a3ff1c38057fb75"></a><!-- doxytag: member="xcresample.h::XCresample_IntrDisable" ref="f6cab4f4644f86807a3ff1c38057fb75" args="(InstancePtr, IntrType)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_IntrDisable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, <tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">IntrType </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#18c102d15e143b84399c8795212975e8">XCRE_IRQ_EN_OFFSET</a>), \
|
|
((<a class="code" href="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#18c102d15e143b84399c8795212975e8">XCRE_IRQ_EN_OFFSET</a>))) \
|
|
& ((~(IntrType)) & (<a class="code" href="xcresample__hw_8h.html#97004e97b72f36a24dc2d91e19358a99">XCRE_IXR_ALLINTR_MASK</a>))))
|
|
</pre></div>This macro disables individual interrupts of the Cresample core by updating the 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IntrType</em> </td><td>is the type of the interrupts to disable. Use OR'ing of XCRE_IXR_*_MASK constants defined in <a class="el" href="xcresample__hw_8h.html">xcresample_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>Any other interrupt not covered by parameter IntrType, if enabled before this macro is called, will remain enabled. C-style signature: void XCresample_IntrDisable(<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u32 IntrType) </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4dd2462144560958335ae4f3ca6980e4"></a><!-- doxytag: member="xcresample.h::XCresample_IntrEnable" ref="4dd2462144560958335ae4f3ca6980e4" args="(InstancePtr, IntrType)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_IntrEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, <tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">IntrType </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#18c102d15e143b84399c8795212975e8">XCRE_IRQ_EN_OFFSET</a>), \
|
|
(((IntrType) & (<a class="code" href="xcresample__hw_8h.html#97004e97b72f36a24dc2d91e19358a99">XCRE_IXR_ALLINTR_MASK</a>)) | \
|
|
(<a class="code" href="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#18c102d15e143b84399c8795212975e8">XCRE_IRQ_EN_OFFSET</a>)))))
|
|
</pre></div>This macro enables individual interrupts of the Cresample core by updating the 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>IntrType</em> </td><td>is the type of the interrupts to enable. Use OR'ing of XCRE_IXR_*_MASK constants defined in <a class="el" href="xcresample__hw_8h.html">xcresample_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>The existing enabled interrupt(s) will remain enabled. C-style signature: void XCresample_IntrEnable(<a class="el" href="struct_x_cresample.html">XCresample</a> *InstancePtr, u32 IntrType) </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="34d7b704fc70030c94820f5c59c764e3"></a><!-- doxytag: member="xcresample.h::XCresample_IntrGetPending" ref="34d7b704fc70030c94820f5c59c764e3" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_IntrGetPending </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#18c102d15e143b84399c8795212975e8">XCRE_IRQ_EN_OFFSET</a>)) & \
|
|
((<a class="code" href="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#87730ba30704098d260a67036eaa6f01">XCRE_STATUS_OFFSET</a>))) & ((u32)(<a class="code" href="xcresample__hw_8h.html#97004e97b72f36a24dc2d91e19358a99">XCRE_IXR_ALLINTR_MASK</a>)))
|
|
</pre></div>This macro returns the pending interrupts of the Cresample core for the interrupts that have been 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance to be worked on.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The pending interrupts of the Chroma Resampler. Use XCRE_IXR_*_MASK constants defined in <a class="el" href="xcresample__hw_8h.html">xcresample_hw.h</a> to interpret this value.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xcresample_8h.html#34d7b704fc70030c94820f5c59c764e3">XCresample_IntrGetPending(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="270b9455b25b2c28fc69609cc5c448d8"></a><!-- doxytag: member="xcresample.h::XCresample_RegUpdateDisable" ref="270b9455b25b2c28fc69609cc5c448d8" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_RegUpdateDisable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>))) & (u32)(~(<a class="code" href="xcresample__hw_8h.html#236624032067fc6eab9b512945e4a1dc">XCRE_CTL_RUE_MASK</a>))))
|
|
</pre></div>This macro prevents the Chroma Resampler 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>
|
|
This macro only works when the Chroma Resampler core 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#270b9455b25b2c28fc69609cc5c448d8">XCresample_RegUpdateDisable(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="dd46d2225bcce47d5fa206321bb8cab4"></a><!-- doxytag: member="xcresample.h::XCresample_RegUpdateEnable" ref="dd46d2225bcce47d5fa206321bb8cab4" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_RegUpdateEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>))) | (<a class="code" href="xcresample__hw_8h.html#236624032067fc6eab9b512945e4a1dc">XCRE_CTL_RUE_MASK</a>)))
|
|
</pre></div>This macro commits all the register value changes made so far by the software to the Chroma Resampler core.<p>
|
|
This macro only works when the Chroma Resampler core 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#dd46d2225bcce47d5fa206321bb8cab4">XCresample_RegUpdateEnable(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="98346f522e3aed9eb5b6e7c09416cdd7"></a><!-- doxytag: member="xcresample.h::XCresample_Reset" ref="98346f522e3aed9eb5b6e7c09416cdd7" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_Reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>), (<a class="code" href="xcresample__hw_8h.html#59a892889d7e272380b3187f143e2497">XCRE_CTL_RESET_MASK</a>))
|
|
</pre></div>This macro resets the Chroma Resampler core. 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#98346f522e3aed9eb5b6e7c09416cdd7">XCresample_Reset(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="862c5f4fbabe14d1e123362c96338d79"></a><!-- doxytag: member="xcresample.h::XCresample_Start" ref="862c5f4fbabe14d1e123362c96338d79" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_Start XCresample_Enable </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This macro enables/starts the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#862c5f4fbabe14d1e123362c96338d79">XCresample_Start(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4d1cb2f8998ad720729b08fe8f927a51"></a><!-- doxytag: member="xcresample.h::XCresample_StatusGetPending" ref="4d1cb2f8998ad720729b08fe8f927a51" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_StatusGetPending </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#383c98c6cf46b5c9e1c40124950e03e4">XCresample_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(XCRE_STATUS)) & (<a class="code" href="xcresample__hw_8h.html#97004e97b72f36a24dc2d91e19358a99">XCRE_IXR_ALLINTR_MASK</a>)
|
|
</pre></div>This macro returns the pending interrupt status of the Cresample core read from the Status 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance to be worked on.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The pending interrupts of the Chroma Resampler. Use XCRE_IXR_*_MASK constants defined in <a class="el" href="xcresample__hw_8h.html">xcresample_hw.h</a> to interpret this value.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: u32 XCresample_StatusGePending(XCresample *InstancePtr) </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="af714ddac2ad4276bc638c1ab7aacb68"></a><!-- doxytag: member="xcresample.h::XCresample_Stop" ref="af714ddac2ad4276bc638c1ab7aacb68" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_Stop XCresample_Disable </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This macro disables/stops the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#af714ddac2ad4276bc638c1ab7aacb68">XCresample_Stop(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="56d3a5b5c6a70eaba4a4bcb1bd9d5cb7"></a><!-- doxytag: member="xcresample.h::XCresample_SyncReset" ref="56d3a5b5c6a70eaba4a4bcb1bd9d5cb7" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCresample_SyncReset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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="xcresample__hw_8h.html#644ad0f957bb97d33f18cab706e145d5">XCresample_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xcresample__hw_8h.html#e36d057ec512e3bf6ad23aedeca87287">XCRE_CONTROL_OFFSET</a>), (<a class="code" href="xcresample__hw_8h.html#3cc43348b3242c3d57ec00b1d8a49f4b">XCRE_CTL_AUTORESET_MASK</a>))
|
|
</pre></div>This macro resets a Chroma Resampler core instance, but differs from <a class="el" href="xcresample_8h.html#98346f522e3aed9eb5b6e7c09416cdd7">XCresample_Reset()</a> in that it automatically synchronizes to the SOF input of the core to prevent tearing.<p>
|
|
On the next raising edge of SOF following a call to <a class="el" href="xcresample_8h.html#56d3a5b5c6a70eaba4a4bcb1bd9d5cb7">XCresample_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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="xcresample_8h.html#56d3a5b5c6a70eaba4a4bcb1bd9d5cb7">XCresample_SyncReset(XCresample *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Typedef Documentation</h2>
|
|
<a class="anchor" name="cfcc5b01138710a38260b9ce921f491c"></a><!-- doxytag: member="xcresample.h::XCresample_CallBack" ref="cfcc5b01138710a38260b9ce921f491c" args="(void *CallBackRef)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(*) <a class="el" href="xcresample_8h.html#cfcc5b01138710a38260b9ce921f491c">XCresample_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> </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="a909cac5656fedc4f0ea205c823140d1"></a><!-- doxytag: member="xcresample.h::XCresample_ErrorCallBack" ref="a909cac5656fedc4f0ea205c823140d1" args="(void *CallBackRef, u32 ErrorMask)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(*) <a class="el" href="xcresample_8h.html#a909cac5656fedc4f0ea205c823140d1">XCresample_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> </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> </td><td>is a bit mask indicating the cause of the error. Its value equals 'OR'ing one or more XCRE_IXR_* values defined in <a class="el" href="xcresample__hw_8h.html">xcresample_hw.h</a> </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Enumeration Type Documentation</h2>
|
|
<a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b"></a><!-- doxytag: member="xcresample.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 handler 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="06fc87d81c62e9abb8790b6e5713c55b2e832b1f4fcf559e0f4332335af75f41"></a><!-- doxytag: member="XCRE_HANDLER_PROCSTART" ref="06fc87d81c62e9abb8790b6e5713c55b2e832b1f4fcf559e0f4332335af75f41" args="" -->XCRE_HANDLER_PROCSTART</em> </td><td>
|
|
A processing start event interrupt type </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55ba91551216aeabd02512d523ac8fb2c11"></a><!-- doxytag: member="XCRE_HANDLER_FRAMEDONE" ref="06fc87d81c62e9abb8790b6e5713c55ba91551216aeabd02512d523ac8fb2c11" args="" -->XCRE_HANDLER_FRAMEDONE</em> </td><td>
|
|
A frame done event interrupt type </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b81213bb998c9b080628d6b4ba81fba82"></a><!-- doxytag: member="XCRE_HANDLER_ERROR" ref="06fc87d81c62e9abb8790b6e5713c55b81213bb998c9b080628d6b4ba81fba82" args="" -->XCRE_HANDLER_ERROR</em> </td><td>
|
|
An error condition interrupt type </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="386a0f9c22e6409060fd966a66d8aa66"></a><!-- doxytag: member="xcresample.h::XCresample_CfgInitialize" ref="386a0f9c22e6409060fd966a66d8aa66" args="(XCresample *InstancePtr, XCresample_Config *CfgPtr, u32 EffectiveAddr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCresample_CfgInitialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </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_cresample___config.html">XCresample_Config</a> * </td>
|
|
<td class="paramname"> <em>CfgPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>EffectiveAddr</em></td><td> </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 Cresample core. This function must be called prior to using the Cresample core. Initialization of the Cresample 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em> </td><td>is a reference to a structure containing information about a specific Chroma Resampler driver. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em> </td><td>is the device base address in the virtual memory address space. The caller is responsible for keeping the address mapping from EffectiveAddr to the device physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, pass in the physical address instead.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>- XST_SUCCESS if initialization was successful.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1d749808d07e3987e21fb3ec7b54c3a2"></a><!-- doxytag: member="xcresample.h::XCresample_Clear_HCoef_Values" ref="1d749808d07e3987e21fb3ec7b54c3a2" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_Clear_HCoef_Values </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function clears all horizontal coefficients of the Chroma Resampler core which are previously set.<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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</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="d3c15e9a7607730c4d6bab0bff8af610"></a><!-- doxytag: member="xcresample.h::XCresample_Clear_VCoef_Values" ref="d3c15e9a7607730c4d6bab0bff8af610" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_Clear_VCoef_Values </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function clears all vertical coefficients of a the Chroma Resampler which are previously set.<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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</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="c15c402d317aea7dbcdabdae1c6d8e6c"></a><!-- doxytag: member="xcresample.h::XCresample_DisableDbgBypass" ref="c15c402d317aea7dbcdabdae1c6d8e6c" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_DisableDbgBypass </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function disables bypass mode of the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="1f6adeb2af84970d6d20a70be30169dd"></a><!-- doxytag: member="xcresample.h::XCresample_DisableDbgTestPattern" ref="1f6adeb2af84970d6d20a70be30169dd" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_DisableDbgTestPattern </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function disables debug test pattern mode in Control register of the Chroma Resampler core, 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="930ea9583c5dd76de763fae86d6b1eff"></a><!-- doxytag: member="xcresample.h::XCresample_EnableDbgByPass" ref="930ea9583c5dd76de763fae86d6b1eff" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_EnableDbgByPass </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function enables the bypass mode by setting bypass bit of the Control register to switch the core to bypass mode if debug feature is enabled in 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="32b603c19c2afaee47a70dde41fdcaa1"></a><!-- doxytag: member="xcresample.h::XCresample_EnableDbgTestPattern" ref="32b603c19c2afaee47a70dde41fdcaa1" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_EnableDbgTestPattern </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function enables the test-pattern mode if debug feature is enabled by setting test-pattern bit of the Control register of the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="d8b448647610e20e45f560ed50465d15"></a><!-- doxytag: member="xcresample.h::XCresample_GetActiveSize" ref="d8b448647610e20e45f560ed50465d15" args="(XCresample *InstancePtr, u16 *HSize, u16 *VSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_GetActiveSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 * </td>
|
|
<td class="paramname"> <em>HSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 * </td>
|
|
<td class="paramname"> <em>VSize</em></td><td> </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 Pixels per Scan line and number of Active Lines per Frame from 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>HSize</em> </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> </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="2871e4a4446a101e00ace372810342ce"></a><!-- doxytag: member="xcresample.h::XCresample_GetChromaParity" ref="2871e4a4446a101e00ace372810342ce" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u8 XCresample_GetChromaParity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns the value of chroma parity of the Chroma Resampler core from Encoding 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Chroma parity value is returned.<ul>
|
|
<li>0 - Chroma information on Odd or First line.</li><li>1 - Chroma information on Even lines.</li></ul>
|
|
</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="b4f2fab7cafe12c0dd55b63f8a4f9bb2"></a><!-- doxytag: member="xcresample.h::XCresample_GetDbgFrameCount" ref="b4f2fab7cafe12c0dd55b63f8a4f9bb2" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCresample_GetDbgFrameCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns the 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</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="81ee6e5159f9173134f5203f079c19d6"></a><!-- doxytag: member="xcresample.h::XCresample_GetDbgLineCount" ref="81ee6e5159f9173134f5203f079c19d6" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCresample_GetDbgLineCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</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="dae07783fcaf65425e70d97648cbf04e"></a><!-- doxytag: member="xcresample.h::XCresample_GetDbgPixelCount" ref="dae07783fcaf65425e70d97648cbf04e" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCresample_GetDbgPixelCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</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="3033cdcbecf61fea37bc9b1795636bf7"></a><!-- doxytag: member="xcresample.h::XCresample_GetFieldParity" ref="3033cdcbecf61fea37bc9b1795636bf7" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u8 XCresample_GetFieldParity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns the field parity value of the Chroma Resampler core from Encoding 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Field parity value is returned. 0 - for even or bottom field. 1 - for odd or top field.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="676b8cfd788ad69cd9c622e2a4953bed"></a><!-- doxytag: member="xcresample.h::XCresample_GetHCoefs" ref="676b8cfd788ad69cd9c622e2a4953bed" args="(XCresample *InstancePtr, XHorizontal_Coeffs *Coeff)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_GetHCoefs </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </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_horizontal___coeffs.html">XHorizontal_Coeffs</a> * </td>
|
|
<td class="paramname"> <em>Coeff</em></td><td> </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 coefficient values from all the Horizontal Coefficient registers of phase0 and phase1 of the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Coeff</em> </td><td>is a pointer to the structure <a class="el" href="struct_x_horizontal___coeffs.html">XHorizontal_Coeffs</a> which has horizontal coefficients of both phases.(Phase 0 and Phase 1) in which coefficients are updated. Range of coefficient values is [-2, 2).</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>For pre defined fixed coefficients filter values, ConvertType should be set with 1. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="81bd4ca76afc9607d8cc69afeb957b5f"></a><!-- doxytag: member="xcresample.h::XCresample_GetVCoefs" ref="81bd4ca76afc9607d8cc69afeb957b5f" args="(XCresample *InstancePtr, XVertical_Coeffs *Coeff)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_GetVCoefs </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </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_vertical___coeffs.html">XVertical_Coeffs</a> * </td>
|
|
<td class="paramname"> <em>Coeff</em></td><td> </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 vertical coefficient values of the Chroma Resampler core from all Vertical Coefficient registers of phase0 and phase1.<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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Coeff</em> </td><td>is a pointer to the structure <a class="el" href="struct_x_vertical___coeffs.html">XVertical_Coeffs</a> which has vertical coefficients of both phases.(Phase 0 and Phase 1) in which coefficients are updated. Range of coefficient values is [-2, 2).</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>For pre defined fixed coefficients filter values, ConvertType should be set with 1. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="759917fbb8599a22fdfe5619ce13a3b2"></a><!-- doxytag: member="xcresample.h::XCresample_GetVersion" ref="759917fbb8599a22fdfe5619ce13a3b2" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCresample_GetVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns the version of the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Content of Version register is returned..</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d3db1c393abaf5003a47b95c7399d1b7"></a><!-- doxytag: member="xcresample.h::XCresample_IntrHandler" ref="d3db1c393abaf5003a47b95c7399d1b7" args="(void *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_IntrHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function is the interrupt handler for the Chroma Resampler driver.<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 driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using Xcresample_SetCallBack() 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="e8267377a15da7e199a393c47baf42e1"></a><!-- doxytag: member="xcresample.h::XCresample_IsDbgByPassEnabled" ref="e8267377a15da7e199a393c47baf42e1" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCresample_IsDbgByPassEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns the current bypass mode settings from Control register of the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="e8fb855ff8ece1b628d69f9cd0eebd5a"></a><!-- doxytag: member="xcresample.h::XCresample_IsDbgTestPatternEnabled" ref="e8fb855ff8ece1b628d69f9cd0eebd5a" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCresample_IsDbgTestPatternEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function returns the test-pattern mode (enabled or not) from Control register of the Chroma Resampler 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</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="5a31b77d26816fa1c1b5b37ff46207f6"></a><!-- doxytag: member="xcresample.h::XCresample_LookupConfig" ref="5a31b77d26816fa1c1b5b37ff46207f6" args="(u16 DeviceId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_x_cresample___config.html">XCresample_Config</a>* XCresample_LookupConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>DeviceId</em> </td>
|
|
<td> ) </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_cresample___config.html">XCresample_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="xcresample__g_8c.html">xcresample_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> </td><td>is the unique device ID of the device for the lookup operation.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>XCresample_LookupConfig returns a reference to a config record in the configuration table (in <a class="el" href="xcresample__g_8c.html">xcresample_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="120e094a3de7a49d4b5e3808ad7fadd2"></a><!-- doxytag: member="xcresample.h::XCresample_SelfTest" ref="120e094a3de7a49d4b5e3808ad7fadd2" args="(XCresample *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCresample_SelfTest </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function reads version register of Chroma Resampler core and compares with zero 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS if the test is successful.</li><li>XST_FAILURE if the test is failed.</li></ul>
|
|
</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a92fd02ee15f7f102dde33a7b2d904d3"></a><!-- doxytag: member="xcresample.h::XCresample_SetActiveSize" ref="a92fd02ee15f7f102dde33a7b2d904d3" args="(XCresample *InstancePtr, u16 HSize, u16 VSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_SetActiveSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>HSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u16 </td>
|
|
<td class="paramname"> <em>VSize</em></td><td> </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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>HSize</em> </td><td>specifies the number of Active Pixels per Scan Line that needs to be set (Range is 32 to 7680). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>VSize</em> </td><td>specifies the number of Active Lines per Frame that needs to be set (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="b0eaff626a3784bde0d6ac0b9e168992"></a><!-- doxytag: member="xcresample.h::XCresample_SetCallBack" ref="b0eaff626a3784bde0d6ac0b9e168992" args="(XCresample *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCresample_SetCallBack </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>HandlerType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>CallBackFunc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>CallBackRef</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This routine installs an asynchronous callback function for the given HandlerType:<p>
|
|
<pre>
|
|
HandlerType Callback Function Type
|
|
----------------------- --------------------------------------------------
|
|
XCRE_HANDLER_FRAMEDONE FrameDoneCallBack
|
|
XCRE_HANDLER_PROCSTART ProcStartCallBack
|
|
XCRE_HANDLER_ERROR ErrCallBack</pre><p>
|
|
<pre> </pre><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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>HandlerType</em> </td><td>specifies which callback is to be attached. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CallBackFunc</em> </td><td>is the address of the callback function. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CallBackRef</em> </td><td>is a user data item that will be passed to the callback function when it is invoked.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS when handler is installed.</li><li>XST_INVALID_PARAM when HandlerType is invalid.</li></ul>
|
|
</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="81bd9651d3634a4f93adc0c9aa377bd4"></a><!-- doxytag: member="xcresample.h::XCresample_SetChromaParity" ref="81bd9651d3634a4f93adc0c9aa377bd4" args="(XCresample *InstancePtr, u8 ChromaParity)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_SetChromaParity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>ChromaParity</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This functions sets the Chroma parity value of the Chroma Resampler core in the Encoding 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ChromaParity</em> </td><td>specifies the parity value which needs to be set.(0 or 1).<ul>
|
|
<li>0 - Chroma information on Odd or First line.</li><li>1 - Chroma information on Even lines.</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="f88e4da9bfb514e7f31550e4763b5ff1"></a><!-- doxytag: member="xcresample.h::XCresample_SetFieldParity" ref="f88e4da9bfb514e7f31550e4763b5ff1" args="(XCresample *InstancePtr, u8 FieldParity)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_SetFieldParity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>FieldParity</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This functions sets the field parity value of the Chroma Resampler core in the Encoding 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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>FieldParity</em> </td><td>specifies the parity value which needs to be set.(0 or 1).<ul>
|
|
<li>0 - for even or bottom field.</li><li>1 - for odd or top field.</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>To this feature need to use interlaced video. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="fe19dfb901944a21c9318301322075e6"></a><!-- doxytag: member="xcresample.h::XCresample_SetHCoefs" ref="fe19dfb901944a21c9318301322075e6" args="(XCresample *InstancePtr, XHorizontal_Coeffs *Coeff, u32 Phases)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_SetHCoefs </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </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_horizontal___coeffs.html">XHorizontal_Coeffs</a> * </td>
|
|
<td class="paramname"> <em>Coeff</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>Phases</em></td><td> </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 horizontal coefficient values of the Chroma Resampler core for phase 0 or phase 1 or both phases.<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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Coeff</em> </td><td>is a pointer to the structure <a class="el" href="struct_x_horizontal___coeffs.html">XHorizontal_Coeffs</a> which has horizontal coefficients of both phases (Phase 0 and Phase 1) which needs to be set. Range of coefficient values is [-2, 2). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Phases</em> </td><td>specifies number of phases needs to be set.<ul>
|
|
<li>0 - Phase 0.</li><li>1 - Phase 1.</li><li>2 - Phase 0 and Phase 1.</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>For pre defined fixed coefficients filter values, ConvertType should be set with 1. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="5f9ac7e61cd69dd5843a4a95eff0ba21"></a><!-- doxytag: member="xcresample.h::XCresample_SetVCoefs" ref="5f9ac7e61cd69dd5843a4a95eff0ba21" args="(XCresample *InstancePtr, XVertical_Coeffs *Coeff, u32 Phases)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCresample_SetVCoefs </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_cresample.html">XCresample</a> * </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_vertical___coeffs.html">XVertical_Coeffs</a> * </td>
|
|
<td class="paramname"> <em>Coeff</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>Phases</em></td><td> </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 vertical coefficient values of the Chroma Resampler for phase 0 or for phase 1 or for both phases.<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> </td><td>is a pointer to the <a class="el" href="struct_x_cresample.html">XCresample</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Coeff</em> </td><td>is a pointer to the structure <a class="el" href="struct_x_horizontal___coeffs.html">XHorizontal_Coeffs</a> which has vertical coefficients of both phases (Phase 0 and Phase 1) which needs to be set. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Phases</em> </td><td>specifies number of phases needs to be set.<ul>
|
|
<li>0 - Phase 0.</li><li>1 - Phase 1.</li><li>2 - Phase 0 and Phase 1.</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>For pre defined fixed coefficients filter values, ConvertType should be set with 1. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
|