a2978ad90f
Added source files,ccm_selftest_example,doxygen report. Signed-off-by: Durga challa <vnsldurg@xilinx.com> Acked-by: Srikanth Vemula <svemula@xilinx.com>
1711 lines
90 KiB
HTML
1711 lines
90 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
xccm.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>xccm.h File Reference</h1>
|
|
<p>
|
|
<code>#include "<a class="el" href="xccm__hw_8h.html">xccm_hw.h</a>"</code><br>
|
|
<code>#include "xil_assert.h"</code><br>
|
|
<code>#include "xstatus.h"</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_ccm___config.html">XCcm_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_ccm.html">XCcm</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_ccm___coefs.html">XCcm_Coefs</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="xccm_8h.html#a53a022bb1cb27955f7657b777dd7999">XCCM_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="xccm_8h.html#0a91a2e37931c2dabd69a72bc861209d">XCCM_ACT_SIZE_LAST</a> 7680</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="xccm_8h.html#1740bbd170767daae443a19ab4c833d7">XCCM_COEF_FIRST</a> -8.0</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#6de672c15afb670ced9d6d0a7761a53b">XCCM_COEF_LAST</a> 8.0</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Offset ranges</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#f43e08e4b2d196e8eb1504668b98c519">XCCM_OFFSET_FIRST</a> 0xFFFFFF00</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#a22b944144cb2e27613016b4bb39b925">XCCM_OFFSET_LAST</a> 255</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Clamp ranges</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#b3562ab10708065f6ee78a769279634d">XCCM_CLAMP_FIRST</a> 0</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#f944e9fe78742398a98d2373696a97cc">XCCM_CLAMP_LAST</a> 255</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Clip ranges</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#ade3f5c3f5c8c2017eb71d9e0b4f57d9">XCCM_CLIP_FIRST</a> 0</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#804187bf41abef218306a7f845ebada8">XCCM_CLIP_LAST</a> 255</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Handler Types</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="xccm_8h.html#06fc87d81c62e9abb8790b6e5713c55bb6935a9446b873400c4c84e5ce152a96">XCCM_HANDLER_PROCSTART</a> = 1,
|
|
<a class="el" href="xccm_8h.html#06fc87d81c62e9abb8790b6e5713c55ba25a3e90c8d6c1938222e4cf7f1b42a9">XCCM_HANDLER_FRAMEDONE</a>,
|
|
<a class="el" href="xccm_8h.html#06fc87d81c62e9abb8790b6e5713c55bd9c3cae466b8d2ad28aeb203160a98cb">XCCM_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="xccm_8h.html#b6e5621d054e87e169370a01cbe1aae0">XCCM_H_</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#44dd617379ea49c8b6032f57803e51a6">XCcm_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="xccm_8h.html#e34dac640b9c67038c4d059de0e05d86">XCcm_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="xccm_8h.html#24c7db54b2b13e8ffb63bc3fd0260da4">XCcm_Start</a> XCcm_Enable</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#4510319aacbbd3599957848a2c9d1542">XCcm_Stop</a> XCcm_Disable</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#ad5c437a6299fd7c287459f9d067671b">XCcm_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="xccm_8h.html#69cd1858570d3746f65e766ad9757ad2">XCcm_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="xccm_8h.html#6d78c69e8a0f58522666aa83dc819302">XCcm_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="xccm_8h.html#6f34f75f603c5e5381d5613480273388">XCcm_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="xccm_8h.html#e0ac6ebb3f4c50599c12cc896ba89a62">XCcm_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="xccm_8h.html#74a96e15ef236c069779cc3fc99475f1">XCcm_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="xccm_8h.html#d26becf7ddfc98a5b699854c33eb035e">XCcm_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="xccm_8h.html#e519d4699af5078a9429a9f3924d5b18">XCcm_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="xccm_8h.html#5dfff1039f9dd0f102d1dfa9707d9c40">XCcm_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="xccm_8h.html#943a44f8476f130b782a04b04aa85b2b">XCcm_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="xccm_8h.html#0e510b3fb050893cae0bf8a4b679fcf4">XCcm_ErrorCallBack</a> (void *CallBackRef, u32 ErrorMask)</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_ccm___config.html">XCcm_Config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#cf6a99204033596f4dd3ffa4b61b2b6a">XCcm_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="xccm_8h.html#143aa8c29bd2eaf103f17d6b76dbdc17">XCcm_CfgInitialize</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, <a class="el" href="struct_x_ccm___config.html">XCcm_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="xccm_8h.html#83ecf706f9ade5b0e93ae9090575cf50">XCcm_GetVersion</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#546464be1a867f0b4b9f53ad66492934">XCcm_Setup</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#2a70f04c8f36653e03c1bd686bffa3c1">XCcm_EnableDbgByPass</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#b8eb8d5a2fdd146a9bc131b048297542">XCcm_IsDbgByPassEnabled</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#3e03d09bb600f53118cafec64d928e0a">XCcm_DisableDbgByPass</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#8c3162630daeaf89ddb735ea239b0c95">XCcm_EnableDbgTestPattern</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#69b1f82193d2228f2563d2f7c4cdb6f8">XCcm_IsDbgTestPatternEnabled</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#f8361b47f63677cef55f44c1d48dc7d6">XCcm_DisableDbgTestPattern</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#ac56c13b67436c4c46a283613806335b">XCcm_GetDbgFrameCount</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#0327a7362e192e594dccb105d115e0aa">XCcm_GetDbgLineCount</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#113f2027e7a6980373b0abb408966fda">XCcm_GetDbgPixelCount</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#bf2c81724c104e2bd08ff1dd3c3c9970">XCcm_SetActiveSize</a> (<a class="el" href="struct_x_ccm.html">XCcm</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="xccm_8h.html#8b33698dab5bc2ecd53e018b278c8228">XCcm_GetActiveSize</a> (<a class="el" href="struct_x_ccm.html">XCcm</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="xccm_8h.html#1bb87c37f2d3465e53a0043c93015f2a">XCcm_SetCoefMatrix</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, <a class="el" href="struct_x_ccm___coefs.html">XCcm_Coefs</a> *CoefValues)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#1c3191c4b436c133e9a313eb5564ab4c">XCcm_GetCoefMatrix</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, <a class="el" href="struct_x_ccm___coefs.html">XCcm_Coefs</a> *CoefValues)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#c824f9b8427a9255d10412c403f99400">XCcm_SetRgbOffset</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, s32 ROffset, s32 GOffset, s32 BOffset)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#d2f6868700e0ac1fbc0bb9927e0772fa">XCcm_GetRgbOffset</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, s32 *ROffset, s32 *GOffset, s32 *BOffset)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#536cb130f1afac75c357fdba2738a713">XCcm_SetClip</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, u32 Clip)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#e1b1241c01cdd2c15bdb4d02e5c92f8a">XCcm_GetClip</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#37a55012b238fd48bd4f25f937b85c6d">XCcm_SetClamp</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, u32 Clamp)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#3e86118b540b675b069095a41aec4cc7">XCcm_GetClamp</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#f70e8e5ef3de9bb3c58fb1c0fd6136fa">XCcm_SelfTest</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#03c6cda14c481d1b72742aa036e57339">XCcm_IntrHandler</a> (void *InstancePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xccm_8h.html#c10d6d33dad41db29c2d16cf7124191d">XCcm_SetCallBack</a> (<a class="el" href="struct_x_ccm.html">XCcm</a> *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)</td></tr>
|
|
|
|
</table>
|
|
<hr><h2>Define Documentation</h2>
|
|
<a class="anchor" name="a53a022bb1cb27955f7657b777dd7999"></a><!-- doxytag: member="xccm.h::XCCM_ACT_SIZE_FIRST" ref="a53a022bb1cb27955f7657b777dd7999" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_ACT_SIZE_FIRST 32 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Active Size starting value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0a91a2e37931c2dabd69a72bc861209d"></a><!-- doxytag: member="xccm.h::XCCM_ACT_SIZE_LAST" ref="0a91a2e37931c2dabd69a72bc861209d" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_ACT_SIZE_LAST 7680 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Active Size ending value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="b3562ab10708065f6ee78a769279634d"></a><!-- doxytag: member="xccm.h::XCCM_CLAMP_FIRST" ref="b3562ab10708065f6ee78a769279634d" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_CLAMP_FIRST 0 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Clamp starting value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f944e9fe78742398a98d2373696a97cc"></a><!-- doxytag: member="xccm.h::XCCM_CLAMP_LAST" ref="f944e9fe78742398a98d2373696a97cc" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_CLAMP_LAST 255 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Clamp ending value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ade3f5c3f5c8c2017eb71d9e0b4f57d9"></a><!-- doxytag: member="xccm.h::XCCM_CLIP_FIRST" ref="ade3f5c3f5c8c2017eb71d9e0b4f57d9" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_CLIP_FIRST 0 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Clip starting value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="804187bf41abef218306a7f845ebada8"></a><!-- doxytag: member="xccm.h::XCCM_CLIP_LAST" ref="804187bf41abef218306a7f845ebada8" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_CLIP_LAST 255 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Clip ending value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1740bbd170767daae443a19ab4c833d7"></a><!-- doxytag: member="xccm.h::XCCM_COEF_FIRST" ref="1740bbd170767daae443a19ab4c833d7" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_COEF_FIRST -8.0 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Coefficient starting value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6de672c15afb670ced9d6d0a7761a53b"></a><!-- doxytag: member="xccm.h::XCCM_COEF_LAST" ref="6de672c15afb670ced9d6d0a7761a53b" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_COEF_LAST 8.0 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Coefficient ending value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e34dac640b9c67038c4d059de0e05d86"></a><!-- doxytag: member="xccm.h::XCcm_Disable" ref="e34dac640b9c67038c4d059de0e05d86" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>))) & (~(<a class="code" href="xccm__hw_8h.html#63b70b6df2fc85fe35d4e99112277214">XCCM_CTL_SW_EN_MASK</a>))))
|
|
</pre></div>This macro disables the CCM 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_ccm.html">XCcm</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="xccm_8h.html#e34dac640b9c67038c4d059de0e05d86">XCcm_Disable(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="44dd617379ea49c8b6032f57803e51a6"></a><!-- doxytag: member="xccm.h::XCcm_Enable" ref="44dd617379ea49c8b6032f57803e51a6" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>))) | (<a class="code" href="xccm__hw_8h.html#63b70b6df2fc85fe35d4e99112277214">XCCM_CTL_SW_EN_MASK</a>)))
|
|
</pre></div>This macro enables the CCM 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_ccm.html">XCcm</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="xccm_8h.html#44dd617379ea49c8b6032f57803e51a6">XCcm_Enable(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="b6e5621d054e87e169370a01cbe1aae0"></a><!-- doxytag: member="xccm.h::XCCM_H_" ref="b6e5621d054e87e169370a01cbe1aae0" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_H_ </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Prevent circular inclusions by using protection macros
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="5dfff1039f9dd0f102d1dfa9707d9c40"></a><!-- doxytag: member="xccm.h::XCcm_IntrClear" ref="5dfff1039f9dd0f102d1dfa9707d9c40" args="(InstancePtr, IntrType)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#04be2e2e5700af4a8c46747813c8d2e0">XCCM_STATUS_OFFSET</a>), ((IntrType) & (<a class="code" href="xccm__hw_8h.html#dbf717e734df9bd371b1681df3808068">XCCM_IXR_ALLINTR_MASK</a>)))
|
|
</pre></div>This macro clears/acknowledges pending interrupts of the CCM core in the Status register. Bit positions to 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_ccm.html">XCcm</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 XCCM_IXR_*_MASK constants defined in <a class="el" href="xccm__hw_8h.html">xccm_hw.h</a> to create this parameter value.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xccm_8h.html#5dfff1039f9dd0f102d1dfa9707d9c40">XCcm_IntrClear(XCcm *InstancePtr, u32 IntrType)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="74a96e15ef236c069779cc3fc99475f1"></a><!-- doxytag: member="xccm.h::XCcm_IntrDisable" ref="74a96e15ef236c069779cc3fc99475f1" args="(InstancePtr, IntrType)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#74964a30a5783d967b5efb378414fcb3">XCCM_IRQ_EN_OFFSET</a>), \
|
|
((<a class="code" href="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#74964a30a5783d967b5efb378414fcb3">XCCM_IRQ_EN_OFFSET</a>))) & ((~(IntrType)) & \
|
|
(<a class="code" href="xccm__hw_8h.html#dbf717e734df9bd371b1681df3808068">XCCM_IXR_ALLINTR_MASK</a>))))
|
|
</pre></div>This macro disables individual interrupts of the CCM 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_ccm.html">XCcm</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 XCCM_IXR_*_MASK constants defined in <a class="el" href="xccm__hw_8h.html">xccm_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 <a class="el" href="xccm_8h.html#74a96e15ef236c069779cc3fc99475f1">XCcm_IntrDisable(XCcm *InstancePtr, u32 IntrType)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e0ac6ebb3f4c50599c12cc896ba89a62"></a><!-- doxytag: member="xccm.h::XCcm_IntrEnable" ref="e0ac6ebb3f4c50599c12cc896ba89a62" args="(InstancePtr, IntrType)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#74964a30a5783d967b5efb378414fcb3">XCCM_IRQ_EN_OFFSET</a>), \
|
|
(((IntrType) & (<a class="code" href="xccm__hw_8h.html#dbf717e734df9bd371b1681df3808068">XCCM_IXR_ALLINTR_MASK</a>)) | \
|
|
(<a class="code" href="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#74964a30a5783d967b5efb378414fcb3">XCCM_IRQ_EN_OFFSET</a>)))))
|
|
</pre></div>This macro enables individual interrupts of the CCM 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_ccm.html">XCcm</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 XCCM_IXR_*_MASK constants defined in <a class="el" href="xccm__hw_8h.html">xccm_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 <a class="el" href="xccm_8h.html#e0ac6ebb3f4c50599c12cc896ba89a62">XCcm_IntrEnable(XCcm *InstancePtr, u32 IntrType)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e519d4699af5078a9429a9f3924d5b18"></a><!-- doxytag: member="xccm.h::XCcm_IntrGetPending" ref="e519d4699af5078a9429a9f3924d5b18" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#74964a30a5783d967b5efb378414fcb3">XCCM_IRQ_EN_OFFSET</a>)) & \
|
|
((<a class="code" href="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#04be2e2e5700af4a8c46747813c8d2e0">XCCM_STATUS_OFFSET</a>))) & (<a class="code" href="xccm__hw_8h.html#dbf717e734df9bd371b1681df3808068">XCCM_IXR_ALLINTR_MASK</a>))
|
|
</pre></div>This macro returns the pending interrupts of the CCM 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_ccm.html">XCcm</a> instance to be worked on.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The pending interrupts of the CCM. Use XCCM_IXR_*_MASK constants defined in <a class="el" href="xccm__hw_8h.html">xccm_hw.h</a> to interpret this value. The returned value is a logical AND of the contents of the STATUS Register and the IRQ_ENABLE Register.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xccm_8h.html#e519d4699af5078a9429a9f3924d5b18">XCcm_IntrGetPending(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f43e08e4b2d196e8eb1504668b98c519"></a><!-- doxytag: member="xccm.h::XCCM_OFFSET_FIRST" ref="f43e08e4b2d196e8eb1504668b98c519" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_OFFSET_FIRST 0xFFFFFF00 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Offset starting value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a22b944144cb2e27613016b4bb39b925"></a><!-- doxytag: member="xccm.h::XCCM_OFFSET_LAST" ref="a22b944144cb2e27613016b4bb39b925" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCCM_OFFSET_LAST 255 </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Offset ending value
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="69cd1858570d3746f65e766ad9757ad2"></a><!-- doxytag: member="xccm.h::XCcm_RegUpdateDisable" ref="69cd1858570d3746f65e766ad9757ad2" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>))) & (~(<a class="code" href="xccm__hw_8h.html#d085d38be602872e68d1247df53c804a">XCCM_CTL_RUE_MASK</a>))))
|
|
</pre></div>This macro prevents the CCM core instance 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 CCM 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_ccm.html">XCcm</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="xccm_8h.html#69cd1858570d3746f65e766ad9757ad2">XCcm_RegUpdateDisable(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ad5c437a6299fd7c287459f9d067671b"></a><!-- doxytag: member="xccm.h::XCcm_RegUpdateEnable" ref="ad5c437a6299fd7c287459f9d067671b" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>), \
|
|
((<a class="code" href="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>))) | (<a class="code" href="xccm__hw_8h.html#d085d38be602872e68d1247df53c804a">XCCM_CTL_RUE_MASK</a>)))
|
|
</pre></div>This macro commits all the register value changes made so far by the software to the CCM core instance.<p>
|
|
This macro only works when the CCM 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_ccm.html">XCcm</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="xccm_8h.html#ad5c437a6299fd7c287459f9d067671b">XCcm_RegUpdateEnable(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6f34f75f603c5e5381d5613480273388"></a><!-- doxytag: member="xccm.h::XCcm_Reset" ref="6f34f75f603c5e5381d5613480273388" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>), \
|
|
(<a class="code" href="xccm__hw_8h.html#3e0c60bee5a7c3b445101bf5afac190e">XCCM_CTL_RESET_MASK</a>))
|
|
</pre></div>This macro resets a CCM 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_ccm.html">XCcm</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="xccm_8h.html#6f34f75f603c5e5381d5613480273388">XCcm_Reset(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="24c7db54b2b13e8ffb63bc3fd0260da4"></a><!-- doxytag: member="xccm.h::XCcm_Start" ref="24c7db54b2b13e8ffb63bc3fd0260da4" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_Start XCcm_Enable </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This macro enables/starts the CCM 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_ccm.html">XCcm</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="xccm_8h.html#24c7db54b2b13e8ffb63bc3fd0260da4">XCcm_Start(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d26becf7ddfc98a5b699854c33eb035e"></a><!-- doxytag: member="xccm.h::XCcm_StatusGetPending" ref="d26becf7ddfc98a5b699854c33eb035e" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6b0c6cad5ad55d36600f805d862cfb0d">XCcm_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#04be2e2e5700af4a8c46747813c8d2e0">XCCM_STATUS_OFFSET</a>)) & (<a class="code" href="xccm__hw_8h.html#dbf717e734df9bd371b1681df3808068">XCCM_IXR_ALLINTR_MASK</a>)
|
|
</pre></div>This macro returns the pending interrupt status of the CCM core by reading from 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_ccm.html">XCcm</a> instance to be worked on.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The pending interrupts of the CCM. Use XCCM_IXR_*_MASK constants defined in <a class="el" href="xccm__hw_8h.html">xccm_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="xccm_8h.html#d26becf7ddfc98a5b699854c33eb035e">XCcm_StatusGetPending(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="4510319aacbbd3599957848a2c9d1542"></a><!-- doxytag: member="xccm.h::XCcm_Stop" ref="4510319aacbbd3599957848a2c9d1542" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_Stop XCcm_Disable </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This macro disables/stops the CCM 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_ccm.html">XCcm</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="xccm_8h.html#4510319aacbbd3599957848a2c9d1542">XCcm_Stop(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6d78c69e8a0f58522666aa83dc819302"></a><!-- doxytag: member="xccm.h::XCcm_SyncReset" ref="6d78c69e8a0f58522666aa83dc819302" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XCcm_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="xccm__hw_8h.html#6891f64d4cf42385c911cef4ff8d8a76">XCcm_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
(<a class="code" href="xccm__hw_8h.html#64ca584588045e2c39cd9e757a5637bf">XCCM_CONTROL_OFFSET</a>), \
|
|
(<a class="code" href="xccm__hw_8h.html#a4104d70736060d0580f08a66191333a">XCCM_CTL_AUTORESET_MASK</a>))
|
|
</pre></div>This macro resets a CCM core at the end of the frame being processed. It enables core automatically synchronizes to the SOF of the core to prevent image tearing. This macro is differ from <a class="el" href="xccm_8h.html#6f34f75f603c5e5381d5613480273388">XCcm_Reset()</a>.<p>
|
|
On the next rising-edge of SOF following a call to XCcm_SyncReset, 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_ccm.html">XCcm</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="xccm_8h.html#6d78c69e8a0f58522666aa83dc819302">XCcm_SyncReset(XCcm *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Typedef Documentation</h2>
|
|
<a class="anchor" name="943a44f8476f130b782a04b04aa85b2b"></a><!-- doxytag: member="xccm.h::XCcm_CallBack" ref="943a44f8476f130b782a04b04aa85b2b" args="(void *CallBackRef)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(*) <a class="el" href="xccm_8h.html#943a44f8476f130b782a04b04aa85b2b">XCcm_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="0e510b3fb050893cae0bf8a4b679fcf4"></a><!-- doxytag: member="xccm.h::XCcm_ErrorCallBack" ref="0e510b3fb050893cae0bf8a4b679fcf4" args="(void *CallBackRef, u32 ErrorMask)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(*) <a class="el" href="xccm_8h.html#0e510b3fb050893cae0bf8a4b679fcf4">XCcm_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 XCCM_IXR_*_MASK values defined in <a class="el" href="xccm__hw_8h.html">xccm_hw.h</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Enumeration Type Documentation</h2>
|
|
<a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b"></a><!-- doxytag: member="xccm.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="06fc87d81c62e9abb8790b6e5713c55bb6935a9446b873400c4c84e5ce152a96"></a><!-- doxytag: member="XCCM_HANDLER_PROCSTART" ref="06fc87d81c62e9abb8790b6e5713c55bb6935a9446b873400c4c84e5ce152a96" args="" -->XCCM_HANDLER_PROCSTART</em> </td><td>
|
|
A processing start event interrupt type </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55ba25a3e90c8d6c1938222e4cf7f1b42a9"></a><!-- doxytag: member="XCCM_HANDLER_FRAMEDONE" ref="06fc87d81c62e9abb8790b6e5713c55ba25a3e90c8d6c1938222e4cf7f1b42a9" args="" -->XCCM_HANDLER_FRAMEDONE</em> </td><td>
|
|
A frame done event interrupt type </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55bd9c3cae466b8d2ad28aeb203160a98cb"></a><!-- doxytag: member="XCCM_HANDLER_ERROR" ref="06fc87d81c62e9abb8790b6e5713c55bd9c3cae466b8d2ad28aeb203160a98cb" args="" -->XCCM_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="143aa8c29bd2eaf103f17d6b76dbdc17"></a><!-- doxytag: member="xccm.h::XCcm_CfgInitialize" ref="143aa8c29bd2eaf103f17d6b76dbdc17" args="(XCcm *InstancePtr, XCcm_Config *CfgPtr, u32 EffectiveAddr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCcm_CfgInitialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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_ccm___config.html">XCcm_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 an CCM core. This function must be called prior to using an CCM core. Initialization of an CCM 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_ccm.html">XCcm</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 <a class="el" href="struct_x_ccm.html">XCcm</a> instance. </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="3e03d09bb600f53118cafec64d928e0a"></a><!-- doxytag: member="xccm.h::XCcm_DisableDbgByPass" ref="3e03d09bb600f53118cafec64d928e0a" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_DisableDbgByPass </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 the Bypass mode of the CCM 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_ccm.html">XCcm</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="f8361b47f63677cef55f44c1d48dc7d6"></a><!-- doxytag: member="xccm.h::XCcm_DisableDbgTestPattern" ref="f8361b47f63677cef55f44c1d48dc7d6" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_DisableDbgTestPattern </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 CCM 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_ccm.html">XCcm</a> core 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="2a70f04c8f36653e03c1bd686bffa3c1"></a><!-- doxytag: member="xccm.h::XCcm_EnableDbgByPass" ref="2a70f04c8f36653e03c1bd686bffa3c1" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_EnableDbgByPass </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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_ccm.html">XCcm</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="8c3162630daeaf89ddb735ea239b0c95"></a><!-- doxytag: member="xccm.h::XCcm_EnableDbgTestPattern" ref="8c3162630daeaf89ddb735ea239b0c95" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_EnableDbgTestPattern </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 CCM 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_ccm.html">XCcm</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>Debug functionality should be enabled. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8b33698dab5bc2ecd53e018b278c8228"></a><!-- doxytag: member="xccm.h::XCcm_GetActiveSize" ref="8b33698dab5bc2ecd53e018b278c8228" args="(XCcm *InstancePtr, u16 *HSize, u16 *VSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_GetActiveSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 Frame Size register.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_ccm.html">XCcm</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="3e86118b540b675b069095a41aec4cc7"></a><!-- doxytag: member="xccm.h::XCcm_GetClamp" ref="3e86118b540b675b069095a41aec4cc7" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCcm_GetClamp </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 clamp value from the Clamp 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 CCM instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Clamp Value is returned.(Range is 0 to 255).</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>If Output value smaller than this clamp value it will be replaced by this value. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="e1b1241c01cdd2c15bdb4d02e5c92f8a"></a><!-- doxytag: member="xccm.h::XCcm_GetClip" ref="e1b1241c01cdd2c15bdb4d02e5c92f8a" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCcm_GetClip </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function gets the clip value from Clip register of the CCM 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 CCM instance.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Clip value is returned.(Range is 0 to 255).</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>If Output value greater than this Clip value it will be replaced by this Clip value. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1c3191c4b436c133e9a313eb5564ab4c"></a><!-- doxytag: member="xccm.h::XCcm_GetCoefMatrix" ref="1c3191c4b436c133e9a313eb5564ab4c" args="(XCcm *InstancePtr, XCcm_Coefs *CoefValues)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_GetCoefMatrix </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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_ccm___coefs.html">XCcm_Coefs</a> * </td>
|
|
<td class="paramname"> <em>CoefValues</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 of color correction matrix from K11 to K33 registers of the CCM 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 CCM instance </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CoefValues</em> </td><td>is a pointer to <a class="el" href="struct_x_ccm___coefs.html">XCcm_Coefs</a> structure which has matrix coefficients is updated with coefficient values. (Range is floating point numbers [-8, 8)).</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="ac56c13b67436c4c46a283613806335b"></a><!-- doxytag: member="xccm.h::XCcm_GetDbgFrameCount" ref="ac56c13b67436c4c46a283613806335b" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCcm_GetDbgFrameCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function gets number of frames processed since power-up or last time the core is reset.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_ccm.html">XCcm</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="0327a7362e192e594dccb105d115e0aa"></a><!-- doxytag: member="xccm.h::XCcm_GetDbgLineCount" ref="0327a7362e192e594dccb105d115e0aa" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCcm_GetDbgLineCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function gets the number of lines processed since power-up or last time the core is reset.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_ccm.html">XCcm</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="113f2027e7a6980373b0abb408966fda"></a><!-- doxytag: member="xccm.h::XCcm_GetDbgPixelCount" ref="113f2027e7a6980373b0abb408966fda" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCcm_GetDbgPixelCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function gets the number of pixels processed since power-up or last time the core is reset.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_ccm.html">XCcm</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="d2f6868700e0ac1fbc0bb9927e0772fa"></a><!-- doxytag: member="xccm.h::XCcm_GetRgbOffset" ref="d2f6868700e0ac1fbc0bb9927e0772fa" args="(XCcm *InstancePtr, s32 *ROffset, s32 *GOffset, s32 *BOffset)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_GetRgbOffset </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">s32 * </td>
|
|
<td class="paramname"> <em>ROffset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">s32 * </td>
|
|
<td class="paramname"> <em>GOffset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">s32 * </td>
|
|
<td class="paramname"> <em>BOffset</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 offset compensation values of red, blue, green colors from Roffset, Goffset and Boffset registers.<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 CCM instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ROffset</em> </td><td>is a pointer of signed 32 bit variable in which offset of red color value is returned. (Range of offset is [-256 255]). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GOffset</em> </td><td>is a pointer of signed 32 bit variable in which offset of green color value is returned. (Range of offset is [-256 255]). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BOffset</em> </td><td>is a pointer of signed 32 bit variable in which offset of blue color value is returned. (Range of offset is [-256 255]).</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="83ecf706f9ade5b0e93ae9090575cf50"></a><!-- doxytag: member="xccm.h::XCcm_GetVersion" ref="83ecf706f9ade5b0e93ae9090575cf50" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XCcm_GetVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function gets the Version of the CCM 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_ccm.html">XCcm</a> instance to be worked on.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Returns the contents of the Version register.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="03c6cda14c481d1b72742aa036e57339"></a><!-- doxytag: member="xccm.h::XCcm_IntrHandler" ref="03c6cda14c481d1b72742aa036e57339" args="(void *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_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 CCM core.<p>
|
|
This handler reads the pending interrupt from 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 <a class="el" href="xccm_8h.html#c10d6d33dad41db29c2d16cf7124191d">XCcm_SetCallBack()</a> during initialization phase. .<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_ccm.html">XCcm</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="b8eb8d5a2fdd146a9bc131b048297542"></a><!-- doxytag: member="xccm.h::XCcm_IsDbgByPassEnabled" ref="b8eb8d5a2fdd146a9bc131b048297542" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCcm_IsDbgByPassEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 CCM 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_ccm.html">XCcm</a> instance.</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="69b1f82193d2228f2563d2f7c4cdb6f8"></a><!-- doxytag: member="xccm.h::XCcm_IsDbgTestPatternEnabled" ref="69b1f82193d2228f2563d2f7c4cdb6f8" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCcm_IsDbgTestPatternEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 CCM core, if debug feature was 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_ccm.html">XCcm</a> instance.</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="cf6a99204033596f4dd3ffa4b61b2b6a"></a><!-- doxytag: member="xccm.h::XCcm_LookupConfig" ref="cf6a99204033596f4dd3ffa4b61b2b6a" args="(u16 DeviceId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_x_ccm___config.html">XCcm_Config</a>* XCcm_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>
|
|
XCcm_LookupConfig returns a reference to an <a class="el" href="struct_x_ccm___config.html">XCcm_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="xccm__g_8c.html">xccm_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>CfgPtr is a reference to a config record in the configuration table (in <a class="el" href="xccm__g_8c.html">xccm_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="f70e8e5ef3de9bb3c58fb1c0fd6136fa"></a><!-- doxytag: member="xccm.h::XCcm_SelfTest" ref="f70e8e5ef3de9bb3c58fb1c0fd6136fa" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCcm_SelfTest </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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 CCM 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 <a class="el" href="struct_x_ccm.html">XCcm</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="bf2c81724c104e2bd08ff1dd3c3c9970"></a><!-- doxytag: member="xccm.h::XCcm_SetActiveSize" ref="bf2c81724c104e2bd08ff1dd3c3c9970" args="(XCcm *InstancePtr, u16 HSize, u16 VSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_SetActiveSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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_ccm.html">XCcm</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="c10d6d33dad41db29c2d16cf7124191d"></a><!-- doxytag: member="xccm.h::XCcm_SetCallBack" ref="c10d6d33dad41db29c2d16cf7124191d" args="(XCcm *InstancePtr, u32 HandlerType, void *CallBackFunc, void *CallBackRef)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XCcm_SetCallBack </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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
|
|
----------------------- --------------------------------------------------
|
|
XCCM_HANDLER_FRAMEDONE FrameDoneCallBack
|
|
XCCM_HANDLER_PROCSTART ProcStartCallBack
|
|
XCCM_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 Xccm 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="37a55012b238fd48bd4f25f937b85c6d"></a><!-- doxytag: member="xccm.h::XCcm_SetClamp" ref="37a55012b238fd48bd4f25f937b85c6d" args="(XCcm *InstancePtr, u32 Clamp)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_SetClamp </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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>Clamp</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 clamp value in the Clamp 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 CCM instance </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Clamp</em> </td><td>is the minimum output value which needs to be set. (Range of Clamping value is 0 to 255).</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>If Output value smaller than this Clamp value it will be replaced by this value. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="536cb130f1afac75c357fdba2738a713"></a><!-- doxytag: member="xccm.h::XCcm_SetClip" ref="536cb130f1afac75c357fdba2738a713" args="(XCcm *InstancePtr, u32 Clip)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_SetClip </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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>Clip</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 clip value in the Clip register of the CCM 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 CCM instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Clip</em> </td><td>is the maximum output value which needs to be set. (Range of Clip value is 0 to 255).</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>If Output value greater than this Clip value it will be replaced by this Clip value. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1bb87c37f2d3465e53a0043c93015f2a"></a><!-- doxytag: member="xccm.h::XCcm_SetCoefMatrix" ref="1bb87c37f2d3465e53a0043c93015f2a" args="(XCcm *InstancePtr, XCcm_Coefs *CoefValues)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_SetCoefMatrix </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</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_ccm___coefs.html">XCcm_Coefs</a> * </td>
|
|
<td class="paramname"> <em>CoefValues</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 coefficients of color correction matrix in K11 to K33 registers of the CCM 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 CCM instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CoefValues</em> </td><td>is a pointer to <a class="el" href="struct_x_ccm___coefs.html">XCcm_Coefs</a> structure which has matrix coefficients that needs to be set. (Range is floating point numbers [-8, 8)).</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="c824f9b8427a9255d10412c403f99400"></a><!-- doxytag: member="xccm.h::XCcm_SetRgbOffset" ref="c824f9b8427a9255d10412c403f99400" args="(XCcm *InstancePtr, s32 ROffset, s32 GOffset, s32 BOffset)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_SetRgbOffset </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">s32 </td>
|
|
<td class="paramname"> <em>ROffset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">s32 </td>
|
|
<td class="paramname"> <em>GOffset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">s32 </td>
|
|
<td class="paramname"> <em>BOffset</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 offset compensation for red, blue and green colors in corresponding Roffset, Goffset and Boffset registers of the CCM 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 CCM instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ROffset</em> </td><td>specifies offset value of red color component which needs to be set. (Range of offset is [-256 255]). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GOffset</em> </td><td>specifies offset value of green color component which needs to be set. (Range of offset is [-256 255]). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BOffset</em> </td><td>specifies offset value of blue color component which needs to be set. (Range of offset is [-256 255]).</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="546464be1a867f0b4b9f53ad66492934"></a><!-- doxytag: member="xccm.h::XCcm_Setup" ref="546464be1a867f0b4b9f53ad66492934" args="(XCcm *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XCcm_Setup </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_ccm.html">XCcm</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
This function sets the input/output frame size in Active Size register and enables the register update.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the Xccm 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>
|
|
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
|