1419 lines
81 KiB
HTML
1419 lines
81 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||
|
|
<title>
|
||
|
|
Xilinx Driver hwicap v10_0: xhwicap.h File Reference
|
||
|
|
</title>
|
||
|
|
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" 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.6.1 -->
|
||
|
|
<div class="navigation" id="top">
|
||
|
|
<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 class="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>
|
||
|
|
</div>
|
||
|
|
<div class="contents">
|
||
|
|
<h1>xhwicap.h File Reference</h1><code>#include "<a class="el" href="xhwicap__i_8h.html">xhwicap_i.h</a>"</code><br/>
|
||
|
|
<code>#include "<a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a>"</code><br/>
|
||
|
|
<code>#include <xstatus.h></code><br/>
|
||
|
|
<code>#include "xparameters.h"</code><br/>
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
||
|
|
<tr><td colspan="2"><h2>Classes</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hw_icap___config.html">XHwIcap_Config</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a></td></tr>
|
||
|
|
<tr><td colspan="2"><h2>Defines</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a75fde643d815baa515db2757414b27e3">XHWICAP_H_</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a578d555615b032cd9675c91f60dfb2bd">XHwIcap_FifoWrite</a>(InstancePtr, Data)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ab24c5878ebb17d6bb12e6e6f00a70ccc">XHwIcap_FifoRead</a>(InstancePtr) (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_RF_OFFSET))</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a55440f403fc15d562124e9abe8ddbc61">XHwIcap_SetSizeReg</a>(InstancePtr, Data)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ae175cdfd7a3fd2a9c0a68c1e4968572f">XHwIcap_GetControlReg</a>(InstancePtr) (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_CR_OFFSET))</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ac688a85edeec278c8b0c88d00268e19e">XHwIcap_StartConfig</a>(InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a1d43f1b9f75258d0b29b1877a107536b">XHwIcap_StartReadBack</a>(InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a656dcfd3edf2dd7e5733af4db36bf69c">XHwIcap_GetStatusReg</a>(InstancePtr) (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_SR_OFFSET))</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a6515e336f30e4f6b3285035a7f939567">XHwIcap_IsTransferDone</a>(InstancePtr) ((InstancePtr->IsTransferInProgress) ? FALSE : TRUE)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ac1d1213b70d3c503aa0ccd27c0a57857">XHwIcap_IsDeviceBusy</a>(InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#aa952277368fc2024057861071922661f">XHwIcap_IntrGlobalEnable</a>(InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ad2dd5620c4ac7d9dee393f4e38446685">XHwIcap_IntrGlobalDisable</a>(InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a9ea29151eef34461b2a964bba048c22f">XHwIcap_IntrGetStatus</a>(InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#add39ee74d909817a0ecd1d5145f36920">XHwIcap_IntrDisable</a>(InstancePtr, IntrMask)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#abf5d9b150a34fa3759415531b833f81a">XHwIcap_IntrEnable</a>(InstancePtr, IntrMask)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a50e8cae31685b6c7e2bb880fd1138209">XHwIcap_IntrGetEnabled</a>(InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a161e6cb1deac088c298c11c6400da295">XHwIcap_IntrClear</a>(InstancePtr, IntrMask)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ada2fee3cdacf928be46488879f32bf8a">XHwIcap_GetWrFifoVacancy</a>(InstancePtr) XHwIcap_ReadReg((InstancePtr)->HwIcapConfig.BaseAddress, XHI_WFV_OFFSET)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#aa5372c712425f6f8c3cc116a79f29cf3">XHwIcap_GetRdFifoOccupancy</a>(InstancePtr) XHwIcap_ReadReg((InstancePtr)->HwIcapConfig.BaseAddress, XHI_RFO_OFFSET)</td></tr>
|
||
|
|
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ac66fc3c032512dfc47f97bc87d97ca4b">XHwIcap_StatusHandler</a> )(void *CallBackRef, u32 StatusEvent, u32 WordCount)</td></tr>
|
||
|
|
<tr><td colspan="2"><h2>Functions</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, <a class="el" href="struct_x_hw_icap___config.html">XHwIcap_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#aab446328af0c5b397eeaee15088bf8e8">XHwIcap_DeviceWrite</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, u32 *FrameBuffer, u32 NumWords)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a27e9ac291323ef043303367460b70de0">XHwIcap_DeviceRead</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, u32 *FrameBuffer, u32 NumWords)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a6c516a5e0cb9f928e591a152cd567dca">XHwIcap_Reset</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a92dbad9de7f4a4e41fcde30fc2ebda1c">XHwIcap_FlushFifo</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a2493ca18331cba6eb2162449b7dab66e">XHwIcap_Abort</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_hw_icap___config.html">XHwIcap_Config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a8966aa32e3b990dc44e6cfcbdfbf2f2d">XHwIcap_LookupConfig</a> (u16 DeviceId)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a7c4b2410acc62af539dac03005668754">XHwIcap_CommandDesync</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#aff2a2db509296264ad44270798b4bed2">XHwIcap_CommandCapture</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a305707eb013da39d038183c7f0d8fed9">XHwIcap_GetConfigReg</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, u32 ConfigReg, u32 *RegData)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a0716d6a3c65aabb73344bee9c4c9cfc7">XHwIcap_SelfTest</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a9cf1ff1dd1056a11f65a903c47492842">XHwIcap_IntrHandler</a> (void *InstancePtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#aa2f2f23cf842c10f443509f8861a194a">XHwIcap_SetInterruptHandler</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, void *CallBackRef, <a class="el" href="xhwicap_8h.html#ac66fc3c032512dfc47f97bc87d97ca4b">XHwIcap_StatusHandler</a> FuncPtr)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#afdb7b9947a1e1610a214814c1b19a0a1">XHwIcap_DeviceReadFrame</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, long Top, long Block, long HClkRow, long MajorFrame, long MinorFrame, u32 *FrameBuffer)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a7b2b996ebb5c5268a07d39e9add552dc">XHwIcap_DeviceWriteFrame</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, long Top, long Block, long HClkRow, long MajorFrame, long MinorFrame, u32 *FrameData)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#ace333a5fa0524552e1f931a20a383b02">XHwIcap_SetClbBits</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, long Row, long Col, const u8 Resource[][2], const u8 Value[], long NumBits)</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap_8h.html#a5ba7825248dfb330bed8c2777a5e4bb5">XHwIcap_GetClbBits</a> (<a class="el" href="struct_x_hw_icap.html">XHwIcap</a> *InstancePtr, long Row, long Col, const u8 Resource[][2], u8 Value[], long NumBits)</td></tr>
|
||
|
|
</table>
|
||
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
|
<hr/><h2>Define Documentation</h2>
|
||
|
|
<a class="anchor" id="ab24c5878ebb17d6bb12e6e6f00a70ccc"></a><!-- doxytag: member="xhwicap.h::XHwIcap_FifoRead" ref="ab24c5878ebb17d6bb12e6e6f00a70ccc" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_FifoRead</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td> (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_RF_OFFSET))</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Read data from the Read FIFO.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The 32-bit Data read from the FIFO.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style Signature: u32 <a class="el" href="xhwicap_8h.html#ab24c5878ebb17d6bb12e6e6f00a70ccc">XHwIcap_FifoRead(XHwIcap *InstancePtr)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a578d555615b032cd9675c91f60dfb2bd"></a><!-- doxytag: member="xhwicap.h::XHwIcap_FifoWrite" ref="a578d555615b032cd9675c91f60dfb2bd" args="(InstancePtr, Data)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_FifoWrite</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Data </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>(((InstancePtr)->HwIcapConfig.BaseAddress), \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a9f823f835a5a4cc52bb93dd31f88c62c">XHI_WF_OFFSET</a>, (Data)))
|
||
|
|
</pre></div><p>Write data to the Write FIFO.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Data</em> </td><td>is the 32-bit value to be written to the FIFO.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style Signature: void <a class="el" href="xhwicap_8h.html#a578d555615b032cd9675c91f60dfb2bd">XHwIcap_FifoWrite(XHwIcap *InstancePtr, u32 Data)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ae175cdfd7a3fd2a9c0a68c1e4968572f"></a><!-- doxytag: member="xhwicap.h::XHwIcap_GetControlReg" ref="ae175cdfd7a3fd2a9c0a68c1e4968572f" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_GetControlReg</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td> (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_CR_OFFSET))</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Get the contents of the Control register.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>A 32-bit value representing the contents of the Control register.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>u32 <a class="el" href="xhwicap_8h.html#ae175cdfd7a3fd2a9c0a68c1e4968572f">XHwIcap_GetControlReg(XHwIcap *InstancePtr)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa5372c712425f6f8c3cc116a79f29cf3"></a><!-- doxytag: member="xhwicap.h::XHwIcap_GetRdFifoOccupancy" ref="aa5372c712425f6f8c3cc116a79f29cf3" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_GetRdFifoOccupancy</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td> XHwIcap_ReadReg((InstancePtr)->HwIcapConfig.BaseAddress, XHI_RFO_OFFSET)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This macro returns the occupancy of the Read FIFO.</p>
|
||
|
|
<dl><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 HwIcap instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The contents read from the Read FIFO Occupancy Register.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: u32 <a class="el" href="xhwicap_8h.html#aa5372c712425f6f8c3cc116a79f29cf3">XHwIcap_GetRdFifoOccupancy(InstancePtr)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a656dcfd3edf2dd7e5733af4db36bf69c"></a><!-- doxytag: member="xhwicap.h::XHwIcap_GetStatusReg" ref="a656dcfd3edf2dd7e5733af4db36bf69c" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_GetStatusReg</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td> (XHwIcap_ReadReg(((InstancePtr)->HwIcapConfig.BaseAddress), XHI_SR_OFFSET))</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Get the contents of the status register.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>A 32-bit value representing the contents of the status register.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>u32 <a class="el" href="xhwicap_8h.html#a656dcfd3edf2dd7e5733af4db36bf69c">XHwIcap_GetStatusReg(XHwIcap *InstancePtr)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ada2fee3cdacf928be46488879f32bf8a"></a><!-- doxytag: member="xhwicap.h::XHwIcap_GetWrFifoVacancy" ref="ada2fee3cdacf928be46488879f32bf8a" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_GetWrFifoVacancy</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td> XHwIcap_ReadReg((InstancePtr)->HwIcapConfig.BaseAddress, XHI_WFV_OFFSET)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This macro returns the vacancy of the Write FIFO. This indicates the number of words that can be written to the Write FIFO before it becomes full.</p>
|
||
|
|
<dl><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 HwIcap instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The contents read from the Write FIFO Vacancy Register.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: u32 <a class="el" href="xhwicap_8h.html#ada2fee3cdacf928be46488879f32bf8a">XHwIcap_GetWrFifoVacancy(InstancePtr)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a75fde643d815baa515db2757414b27e3"></a><!-- doxytag: member="xhwicap.h::XHWICAP_H_" ref="a75fde643d815baa515db2757414b27e3" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHWICAP_H_</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a161e6cb1deac088c298c11c6400da295"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrClear" ref="a161e6cb1deac088c298c11c6400da295" args="(InstancePtr, IntrMask)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IntrClear</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">IntrMask </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a4ff2b0721655b2764bff81449b368478">XHI_IPISR_OFFSET</a>, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a7061e53605486f268a5e2205828d5921">XHwIcap_ReadReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a4ff2b0721655b2764bff81449b368478">XHI_IPISR_OFFSET</a>) | ((IntrMask) & <a class="code" href="xhwicap__l_8h.html#a796c30e8bebadbe5c18ce0af9b10d30a">XHI_IPIXR_ALL_MASK</a>))
|
||
|
|
</pre></div><p>This macro clears the specified interrupts in the Interrupt Status Register (IPISR).</p>
|
||
|
|
<dl><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 HwIcap instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>IntrMask</em> </td><td>contains the interrupts to be cleared.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Signature: void XHwIcap_DisableIntr(XHwIcap *InstancePtr, u32 IntrMask) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="add39ee74d909817a0ecd1d5145f36920"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrDisable" ref="add39ee74d909817a0ecd1d5145f36920" args="(InstancePtr, IntrMask)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IntrDisable</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">IntrMask </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a8723cf72ecf20356371e6f6d2ce55543">XHI_IPIER_OFFSET</a>, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a7061e53605486f268a5e2205828d5921">XHwIcap_ReadReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a8723cf72ecf20356371e6f6d2ce55543">XHI_IPIER_OFFSET</a>) & (~ (IntrMask & <a class="code" href="xhwicap__l_8h.html#a796c30e8bebadbe5c18ce0af9b10d30a">XHI_IPIXR_ALL_MASK</a>)));\
|
||
|
|
(InstancePtr)->IsPolled = TRUE;
|
||
|
|
</pre></div><p>This macro disables the specified interrupts in the Interrupt Enable Register. It is non-destructive in that the register is read and only the interrupts specified is changed.</p>
|
||
|
|
<dl><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 HwIcap instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>IntrMask</em> </td><td>is the bit-mask of the interrupts to be disabled. Bit positions of 1 will be disabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XHI_IPIXR_*_MASK bits defined in <a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a>.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Signature: void <a class="el" href="xhwicap_8h.html#add39ee74d909817a0ecd1d5145f36920">XHwIcap_IntrDisable(XHwIcap *InstancePtr, u32 IntrMask)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="abf5d9b150a34fa3759415531b833f81a"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrEnable" ref="abf5d9b150a34fa3759415531b833f81a" args="(InstancePtr, IntrMask)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IntrEnable</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">IntrMask </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a8723cf72ecf20356371e6f6d2ce55543">XHI_IPIER_OFFSET</a>, \
|
||
|
|
(<a class="code" href="xhwicap__l_8h.html#a7061e53605486f268a5e2205828d5921">XHwIcap_ReadReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a8723cf72ecf20356371e6f6d2ce55543">XHI_IPIER_OFFSET</a>) | ((IntrMask) & <a class="code" href="xhwicap__l_8h.html#a796c30e8bebadbe5c18ce0af9b10d30a">XHI_IPIXR_ALL_MASK</a>))); \
|
||
|
|
(InstancePtr)->IsPolled = FALSE;
|
||
|
|
</pre></div><p>This macro enables the specified interrupts in the Interrupt Enable Register. It is non-destructive in that the register is read and only the interrupts specified is changed.</p>
|
||
|
|
<dl><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 HwIcap instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>IntrMask</em> </td><td>is the bit-mask of the interrupts to be enabled. Bit positions of 1 will be enabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XHI_IPIXR_*_MASK bits defined in <a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a>.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Signature: void <a class="el" href="xhwicap_8h.html#abf5d9b150a34fa3759415531b833f81a">XHwIcap_IntrEnable(XHwIcap *InstancePtr, u32 IntrMask)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a50e8cae31685b6c7e2bb880fd1138209"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrGetEnabled" ref="a50e8cae31685b6c7e2bb880fd1138209" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IntrGetEnabled</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xhwicap__l_8h.html#a7061e53605486f268a5e2205828d5921">XHwIcap_ReadReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a8723cf72ecf20356371e6f6d2ce55543">XHI_IPIER_OFFSET</a>)
|
||
|
|
</pre></div><p>This macro returns the interrupt status read from Interrupt Enable Register(IIER). Use the XHI_IPIXR_* constants defined in <a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a> to interpret the returned value.</p>
|
||
|
|
<dl><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 HwIcap instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The contents read from the Interrupt Enable Register.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: u32 <a class="el" href="xhwicap_8h.html#a50e8cae31685b6c7e2bb880fd1138209">XHwIcap_IntrGetEnabled(InstancePtr)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9ea29151eef34461b2a964bba048c22f"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrGetStatus" ref="a9ea29151eef34461b2a964bba048c22f" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IntrGetStatus</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xhwicap__l_8h.html#a7061e53605486f268a5e2205828d5921">XHwIcap_ReadReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a4ff2b0721655b2764bff81449b368478">XHI_IPISR_OFFSET</a>)
|
||
|
|
</pre></div><p>This macro returns the interrupt status read from Interrupt Status Register(IPISR). Use the XHI_IPIXR_* constants defined in <a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a> to interpret the returned value.</p>
|
||
|
|
<dl><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 HwIcap instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The contents read from the Interrupt Status Register.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: u32 <a class="el" href="xhwicap_8h.html#a9ea29151eef34461b2a964bba048c22f">XHwIcap_IntrGetStatus(InstancePtr)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ad2dd5620c4ac7d9dee393f4e38446685"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrGlobalDisable" ref="ad2dd5620c4ac7d9dee393f4e38446685" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IntrGlobalDisable</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#acc55662e7438a63d17100c391701bca0">XHI_GIER_OFFSET</a>, 0x0)
|
||
|
|
</pre></div><p>This macro disables the global interrupt in the Global Interrupt Enable Register (GIER) so that the interrupt output from the HwIcap device is disabled.</p>
|
||
|
|
<dl><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 HwIcap instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: void <a class="el" href="xhwicap_8h.html#ad2dd5620c4ac7d9dee393f4e38446685">XHwIcap_IntrGlobalDisable(InstancePtr)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa952277368fc2024057861071922661f"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrGlobalEnable" ref="aa952277368fc2024057861071922661f" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IntrGlobalEnable</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>((InstancePtr)->HwIcapConfig.BaseAddress, \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#acc55662e7438a63d17100c391701bca0">XHI_GIER_OFFSET</a>, <a class="code" href="xhwicap__l_8h.html#a312f920dfd13871dfc397bb734e81542">XHI_GIER_GIE_MASK</a>)
|
||
|
|
</pre></div><p>This macro enables the global interrupt in the Global Interrupt Enable Register (GIER) so that the interrupt output from the HwIcap device is enabled. Interrupts enabled using <a class="el" href="xhwicap_8h.html#abf5d9b150a34fa3759415531b833f81a">XHwIcap_IntrEnable()</a> will not occur until the global interrupt enable bit is set by using this macro.</p>
|
||
|
|
<dl><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 HwIcap instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: void <a class="el" href="xhwicap_8h.html#aa952277368fc2024057861071922661f">XHwIcap_IntrGlobalEnable(InstancePtr)</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ac1d1213b70d3c503aa0ccd27c0a57857"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IsDeviceBusy" ref="ac1d1213b70d3c503aa0ccd27c0a57857" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IsDeviceBusy</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xhwicap_8h.html#a656dcfd3edf2dd7e5733af4db36bf69c">XHwIcap_GetStatusReg</a>(InstancePtr) & <a class="code" href="xhwicap__l_8h.html#a5f6dfed1a6cda2d244f7b58ccf734eb3">XHI_SR_DONE_MASK</a>) ? \
|
||
|
|
FALSE : TRUE)
|
||
|
|
</pre></div><p>This macro checks if the last Read/Write to the ICAP device in the FPGA is completed.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
||
|
|
<li>TRUE if the last Read/Write(Config) to the ICAP is NOT completed.</li>
|
||
|
|
<li>FALSE if the Read/Write(Config) to the ICAP is completed..</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: int <a class="el" href="xhwicap_8h.html#ac1d1213b70d3c503aa0ccd27c0a57857">XHwIcap_IsDeviceBusy(XHwIcap *InstancePtr)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6515e336f30e4f6b3285035a7f939567"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IsTransferDone" ref="a6515e336f30e4f6b3285035a7f939567" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_IsTransferDone</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td> ((InstancePtr->IsTransferInProgress) ? FALSE : TRUE)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This macro checks if the last Read/Write of the data to the Read/Write FIFO of the HwIcap device is completed.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
||
|
|
<li>TRUE if the Read/Write to the FIFO's is completed.</li>
|
||
|
|
<li>FALSE if the Read/Write to the FIFO's is NOT completed..</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-Style signature: int <a class="el" href="xhwicap_8h.html#a6515e336f30e4f6b3285035a7f939567">XHwIcap_IsTransferDone(XHwIcap *InstancePtr)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a55440f403fc15d562124e9abe8ddbc61"></a><!-- doxytag: member="xhwicap.h::XHwIcap_SetSizeReg" ref="a55440f403fc15d562124e9abe8ddbc61" args="(InstancePtr, Data)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_SetSizeReg</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Data </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>(((InstancePtr)->HwIcapConfig.BaseAddress), \
|
||
|
|
<a class="code" href="xhwicap__l_8h.html#a61e8525d9e209cad45122af264f276f0">XHI_SZ_OFFSET</a>, (Data)))
|
||
|
|
</pre></div><p>Set the number of words to be read from the Icap in the Size register.</p>
|
||
|
|
<p>The Size Register holds the number of 32 bit words to transfer from the the Icap to the Read FIFO of the HwIcap device.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Data</em> </td><td>is the size in words.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style Signature: void <a class="el" href="xhwicap_8h.html#a55440f403fc15d562124e9abe8ddbc61">XHwIcap_SetSizeReg(XHwIcap *InstancePtr, u32 Data)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ac688a85edeec278c8b0c88d00268e19e"></a><!-- doxytag: member="xhwicap.h::XHwIcap_StartConfig" ref="ac688a85edeec278c8b0c88d00268e19e" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_StartConfig</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>(((InstancePtr)->HwIcapConfig.BaseAddress), <a class="code" href="xhwicap__l_8h.html#ad7d94ec59e14347684d309b0b6406ab2">XHI_CR_OFFSET</a>, \
|
||
|
|
(<a class="code" href="xhwicap_8h.html#ae175cdfd7a3fd2a9c0a68c1e4968572f">XHwIcap_GetControlReg</a>(InstancePtr) & \
|
||
|
|
(~ <a class="code" href="xhwicap__l_8h.html#a5f79a1af0d4909378342da1723568653">XHI_CR_READ_MASK</a>)) | <a class="code" href="xhwicap__l_8h.html#aef1da3487a4b5b56304445dd5892855b">XHI_CR_WRITE_MASK</a>))
|
||
|
|
</pre></div><p>Set the Control Register to initiate a configuration (write) to the device.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style Signature: void <a class="el" href="xhwicap_8h.html#ac688a85edeec278c8b0c88d00268e19e">XHwIcap_StartConfig(XHwIcap *InstancePtr)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a1d43f1b9f75258d0b29b1877a107536b"></a><!-- doxytag: member="xhwicap.h::XHwIcap_StartReadBack" ref="a1d43f1b9f75258d0b29b1877a107536b" args="(InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define XHwIcap_StartReadBack</td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">InstancePtr </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xhwicap__l_8h.html#a8abfb8a13021622966d96781cb1a0f86">XHwIcap_WriteReg</a>(((InstancePtr)->HwIcapConfig.BaseAddress) , <a class="code" href="xhwicap__l_8h.html#ad7d94ec59e14347684d309b0b6406ab2">XHI_CR_OFFSET</a>, \
|
||
|
|
(<a class="code" href="xhwicap_8h.html#ae175cdfd7a3fd2a9c0a68c1e4968572f">XHwIcap_GetControlReg</a>(InstancePtr) & \
|
||
|
|
(~ <a class="code" href="xhwicap__l_8h.html#aef1da3487a4b5b56304445dd5892855b">XHI_CR_WRITE_MASK</a>)) | <a class="code" href="xhwicap__l_8h.html#a5f79a1af0d4909378342da1723568653">XHI_CR_READ_MASK</a>))
|
||
|
|
</pre></div><p>Set the Control Register to initiate a ReadBack from the device.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style Signature: void <a class="el" href="xhwicap_8h.html#a1d43f1b9f75258d0b29b1877a107536b">XHwIcap_StartReadBack(XHwIcap *InstancePtr)</a>; </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/><h2>Typedef Documentation</h2>
|
||
|
|
<a class="anchor" id="ac66fc3c032512dfc47f97bc87d97ca4b"></a><!-- doxytag: member="xhwicap.h::XHwIcap_StatusHandler" ref="ac66fc3c032512dfc47f97bc87d97ca4b" args=")(void *CallBackRef, u32 StatusEvent, u32 WordCount)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">typedef void(* <a class="el" href="xhwicap_8h.html#ac66fc3c032512dfc47f97bc87d97ca4b">XHwIcap_StatusHandler</a>)(void *CallBackRef, u32 StatusEvent, u32 WordCount)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>The handler data type allows the user to define a callback function to handle the asynchronous processing of the HwIcap driver. The application using this driver is expected to define a handler of this type to support interrupt driven mode. The handler executes in an interrupt context such that minimal processing should be performed.</p>
|
||
|
|
<dl><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 application layer when setting the callback functions, and passed back to the upper layer when the callback is invoked. Its type is unimportant to the driver component, so it is a void pointer. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>StatusEvent</em> </td><td>indicates one or more status events that occurred. See the XHwIcap_SetInterruptHandler for details on the status events that can be passed in the callback. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>WordCount</em> </td><td>indicates how many words of data were successfully transferred. This may be less than the number of words requested if there was an error. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/><h2>Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a2493ca18331cba6eb2162449b7dab66e"></a><!-- doxytag: member="xhwicap.h::XHwIcap_Abort" ref="a2493ca18331cba6eb2162449b7dab66e" args="(XHwIcap *InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void XHwIcap_Abort </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This function initiates the Abort Sequence by setting the Abort bit in the control register.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a928bb0618a3f4bab3264eceb7b898d6d"></a><!-- doxytag: member="xhwicap.h::XHwIcap_CfgInitialize" ref="a928bb0618a3f4bab3264eceb7b898d6d" args="(XHwIcap *InstancePtr, XHwIcap_Config *ConfigPtr, u32 EffectiveAddr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_CfgInitialize </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</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_hw_icap___config.html">XHwIcap_Config</a> * </td>
|
||
|
|
<td class="paramname"> <em>ConfigPtr</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></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This function initializes a specific <a class="el" href="struct_x_hw_icap.html">XHwIcap</a> instance. The IDCODE is read from the FPGA and based on the IDCODE the information about the resources in the FPGA is filled in the instance structure.</p>
|
||
|
|
<p>The HwIcap device will be in put in a reset state before exiting this function.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em> </td><td>points to the <a class="el" href="struct_x_hw_icap.html">XHwIcap</a> device configuration structure. </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. If the address translation is not used then the physical address is passed. Unexpected errors may occur if the address mapping is changed after this function is invoked.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS else XST_FAILURE</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
<p><p>Set IcapWidth</p>
|
||
|
|
<p>Set IsLiteMode </p>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aff2a2db509296264ad44270798b4bed2"></a><!-- doxytag: member="xhwicap.h::XHwIcap_CommandCapture" ref="aff2a2db509296264ad44270798b4bed2" args="(XHwIcap *InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_CommandCapture </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Sends a CAPTURE command to the ICAP port. This command captures all of the flip flop states so they will be available during readback. One can use this command instead of enabling the CAPTURE block in the design.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS or XST_FAILURE</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a7c4b2410acc62af539dac03005668754"></a><!-- doxytag: member="xhwicap.h::XHwIcap_CommandDesync" ref="a7c4b2410acc62af539dac03005668754" args="(XHwIcap *InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_CommandDesync </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Sends a DESYNC command to the ICAP port.</p>
|
||
|
|
<dl><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>- a pointer to the <a class="el" href="struct_x_hw_icap.html">XHwIcap</a> instance to be worked on</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS else XST_FAILURE</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a27e9ac291323ef043303367460b70de0"></a><!-- doxytag: member="xhwicap.h::XHwIcap_DeviceRead" ref="a27e9ac291323ef043303367460b70de0" args="(XHwIcap *InstancePtr, u32 *FrameBuffer, u32 NumWords)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_DeviceRead </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</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>FrameBuffer</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u32 </td>
|
||
|
|
<td class="paramname"> <em>NumWords</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This function reads the specified number of words from the ICAP device in the polled mode. Interrupt mode is not supported in reading data from the ICAP device.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>FrameBuffer</em> </td><td>is a pointer to the memory where the frame read from the ICAP device is stored. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>NumWords</em> </td><td>is the number of words (16 bit for S6 and 32 bit for all other devices) to write to the ICAP device.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
||
|
|
<li>XST_SUCCESS if the specified number of words have been read from the ICAP device</li>
|
||
|
|
<li>XST_FAILURE if the device is busy with the last Read/Write or if the requested number of words have not been read from the ICAP device, or there is a timeout.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is a blocking function. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="afdb7b9947a1e1610a214814c1b19a0a1"></a><!-- doxytag: member="xhwicap.h::XHwIcap_DeviceReadFrame" ref="afdb7b9947a1e1610a214814c1b19a0a1" args="(XHwIcap *InstancePtr, long Top, long Block, long HClkRow, long MajorFrame, long MinorFrame, u32 *FrameBuffer)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_DeviceReadFrame </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Top</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Block</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>HClkRow</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>MajorFrame</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>MinorFrame</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u32 * </td>
|
||
|
|
<td class="paramname"> <em>FrameBuffer</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Reads one frame from the device and puts it in memory specified by the user.</p>
|
||
|
|
<dl><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>- a pointer to the <a class="el" href="struct_x_hw_icap.html">XHwIcap</a> instance to be worked on. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Top</em> </td><td>- top (0) or bottom (1) half of device </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Block</em> </td><td>- Block Address (XHI_FAR_CLB_BLOCK, XHI_FAR_BRAM_BLOCK, XHI_FAR_BRAM_INT_BLOCK) </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>HClkRow</em> </td><td>- selects the HClk Row </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>MajorFrame</em> </td><td>- selects the column </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>MinorFrame</em> </td><td>- selects frame inside column </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>FrameBuffer</em> </td><td>is a pointer to the memory where the frame read from the device is stored</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS else XST_FAILURE.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is a blocking call. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aab446328af0c5b397eeaee15088bf8e8"></a><!-- doxytag: member="xhwicap.h::XHwIcap_DeviceWrite" ref="aab446328af0c5b397eeaee15088bf8e8" args="(XHwIcap *InstancePtr, u32 *FrameBuffer, u32 NumWords)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_DeviceWrite </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</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>FrameBuffer</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u32 </td>
|
||
|
|
<td class="paramname"> <em>NumWords</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This function writes the given user data to the Write FIFO in both the polled mode and the interrupt mode and starts the transfer of the data to the ICAP device.</p>
|
||
|
|
<p>In the polled mode, this function will write the specified number of words into the FIFO before returning.</p>
|
||
|
|
<p>In the interrupt mode, this function will write the words upto the size of the Write FIFO and starts the transfer, then subsequent transfer of the data is performed by the interrupt service routine until the entire buffer has been transferred. The status callback function is called when the entire buffer has been sent. In order to use interrupts, it is necessary for the user to connect the driver interrupt handler, <a class="el" href="xhwicap_8h.html#a9cf1ff1dd1056a11f65a903c47492842">XHwIcap_IntrHandler()</a>, to the interrupt system of the application and enable the interrupts associated with the Write FIFO. The user has to enable the interrupts each time this function is called using the XHwIcap_IntrEnable macro.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>FrameBuffer</em> </td><td>is a pointer to the data to be written to the ICAP device. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>NumWords</em> </td><td>is the number of words (16 bit for S6 and 32 bit for all other devices)to write to the ICAP device.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS or XST_FAILURE</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This function is a blocking for the polled mode of operation and is non-blocking for the interrupt mode of operation. Use the function XHwIcap_DeviceWriteFrame for writing a frame of data to the ICAP device. </dd></dl>
|
||
|
|
|
||
|
|
<p><p>Icap Width of 32 does not use Fifo but declared to overcome compilation error. Size of 4 is used to overcome compiler warnings </p>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a7b2b996ebb5c5268a07d39e9add552dc"></a><!-- doxytag: member="xhwicap.h::XHwIcap_DeviceWriteFrame" ref="a7b2b996ebb5c5268a07d39e9add552dc" args="(XHwIcap *InstancePtr, long Top, long Block, long HClkRow, long MajorFrame, long MinorFrame, u32 *FrameData)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_DeviceWriteFrame </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Top</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Block</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>HClkRow</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>MajorFrame</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>MinorFrame</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u32 * </td>
|
||
|
|
<td class="paramname"> <em>FrameData</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Writes one frame from the specified buffer and puts it in the device (ICAP).</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Top</em> </td><td>- top (0) or bottom (1) half of device </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Block</em> </td><td>- Block Address (XHI_FAR_CLB_BLOCK, XHI_FAR_BRAM_BLOCK, XHI_FAR_BRAM_INT_BLOCK) </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>HClkRow</em> </td><td>- selects the HClk Row </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>MajorFrame</em> </td><td>- selects the column </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>MinorFrame</em> </td><td>- selects frame inside column </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>FrameData</em> </td><td>is a pointer to the frame that is to be written to the device.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS else XST_FAILURE.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is a blocking function. This function is used in conjunction with the function XHwIcap_DeviceReadFrame. This function is used to write back the frame of data read using the XHwIcap_DeviceReadFrame. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a92dbad9de7f4a4e41fcde30fc2ebda1c"></a><!-- doxytag: member="xhwicap.h::XHwIcap_FlushFifo" ref="a92dbad9de7f4a4e41fcde30fc2ebda1c" args="(XHwIcap *InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void XHwIcap_FlushFifo </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This function flushes the FIFOs in the device.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a5ba7825248dfb330bed8c2777a5e4bb5"></a><!-- doxytag: member="xhwicap.h::XHwIcap_GetClbBits" ref="a5ba7825248dfb330bed8c2777a5e4bb5" args="(XHwIcap *InstancePtr, long Row, long Col, const u8 Resource[][2], u8 Value[], long NumBits)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_GetClbBits </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Row</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Col</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const u8 </td>
|
||
|
|
<td class="paramname"> <em>Resource</em>[][2], </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u8 </td>
|
||
|
|
<td class="paramname"> <em>Value</em>[], </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>NumBits</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Gets bits contained in a Center tile specified by the CLB row and col coordinates. The coordinate system lables the upper left CLB as (1,1).</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Row</em> </td><td>is the CLB row. (1,1) is the upper left CLB. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Col</em> </td><td>is the CLB col. (1,1) is the upper left CLB. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Resource</em> </td><td>is the Target bits (first dimension length will be the number of bits to set and must match the numBits parameter) (second dimension contains two value -- one for minor row and one for col information from within the Center tile targetted by the above row and col coords). </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the values to set each of the targets bits to. The size of this array must be euqal to NumBits. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>NumBits</em> </td><td>is the number of Bits to change in this method.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS, XST_BUFFER_TOO_SMALL or XST_INVALID_PARAM.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>The source code for this function is not included. This function is delivered as .o file. Libgen uses the appropriate .o file for the target processor. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a305707eb013da39d038183c7f0d8fed9"></a><!-- doxytag: member="xhwicap.h::XHwIcap_GetConfigReg" ref="a305707eb013da39d038183c7f0d8fed9" args="(XHwIcap *InstancePtr, u32 ConfigReg, u32 *RegData)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">u32 XHwIcap_GetConfigReg </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</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>ConfigReg</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u32 * </td>
|
||
|
|
<td class="paramname"> <em>RegData</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This function returns the value of the specified configuration register.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>ConfigReg</em> </td><td>is a constant which represents the configuration register value to be returned. Constants specified in <a class="el" href="xhwicap__i_8h.html">xhwicap_i.h</a>. Examples: XHI_IDCODE, XHI_FLR. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>RegData</em> </td><td>is the value of the specified configuration register.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS or XST_FAILURE</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is a blocking call. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9cf1ff1dd1056a11f65a903c47492842"></a><!-- doxytag: member="xhwicap.h::XHwIcap_IntrHandler" ref="a9cf1ff1dd1056a11f65a903c47492842" args="(void *InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void XHwIcap_IntrHandler </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>The interrupt handler for HwIcap interrupts. This function must be connected by the user to an interrupt source.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>The interrupts are being used only while writing data to the ICAP device. The reading of the data from the ICAP device is done in polled mode. In a worst case scenario the interrupt handler can be busy writing large amount of data to the Write FIFO. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8966aa32e3b990dc44e6cfcbdfbf2f2d"></a><!-- doxytag: member="xhwicap.h::XHwIcap_LookupConfig" ref="a8966aa32e3b990dc44e6cfcbdfbf2f2d" args="(u16 DeviceId)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="struct_x_hw_icap___config.html">XHwIcap_Config</a>* XHwIcap_LookupConfig </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">u16 </td>
|
||
|
|
<td class="paramname"> <em>DeviceId</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Looks up the device configuration based on the unique device ID. A table contains the configuration info for each device in the system.</p>
|
||
|
|
<dl><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>contains the ID of the device for which the device configuration pointer is to be returned.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
||
|
|
<li>A pointer to the configuration found.</li>
|
||
|
|
<li>NULL if the specified device ID was not found.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6c516a5e0cb9f928e591a152cd567dca"></a><!-- doxytag: member="xhwicap.h::XHwIcap_Reset" ref="a6c516a5e0cb9f928e591a152cd567dca" args="(XHwIcap *InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void XHwIcap_Reset </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>This function forces the software reset of the complete HWICAP device. All the registers will return to the default value and the FIFO is also flushed as a part of this software reset.</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a0716d6a3c65aabb73344bee9c4c9cfc7"></a><!-- doxytag: member="xhwicap.h::XHwIcap_SelfTest" ref="a0716d6a3c65aabb73344bee9c4c9cfc7" args="(XHwIcap *InstancePtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_SelfTest </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Run a self-test on the driver/device. The test</p>
|
||
|
|
<ul>
|
||
|
|
<li>Writes to the Interrupt Enable Register and reads it back for comparison.</li>
|
||
|
|
</ul>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
||
|
|
<li>XST_SUCCESS if the value read from the register is the same as the value written.</li>
|
||
|
|
<li>XST_FAILURE otherwise</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ace333a5fa0524552e1f931a20a383b02"></a><!-- doxytag: member="xhwicap.h::XHwIcap_SetClbBits" ref="ace333a5fa0524552e1f931a20a383b02" args="(XHwIcap *InstancePtr, long Row, long Col, const u8 Resource[][2], const u8 Value[], long NumBits)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int XHwIcap_SetClbBits </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Row</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>Col</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const u8 </td>
|
||
|
|
<td class="paramname"> <em>Resource</em>[][2], </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const u8 </td>
|
||
|
|
<td class="paramname"> <em>Value</em>[], </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">long </td>
|
||
|
|
<td class="paramname"> <em>NumBits</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Sets bits contained in a Center tile specified by the CLB row and col coordinates. The coordinate system lables the upper left CLB as (1,1).</p>
|
||
|
|
<dl><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_hw_icap.html">XHwIcap</a> instance to be worked on </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Row</em> </td><td>is the CLB row. (1,1) is the upper left CLB. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Col</em> </td><td>is the CLB col. (1,1) is the upper left CLB. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Resource</em> </td><td>is the Target bits (first dimension length will be the number of bits to set and must match the numBits parameter) (second dimension contains two value -- one for minor row and one for col information from within the Center tile targetted by the above row and col coords). </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the values to set each of the targets bits to. The size of this array must be euqal to NumBits. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>NumBits</em> </td><td>is the number of Bits to change in this method.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS, XST_BUFFER_TOO_SMALL or XST_INVALID_PARAM.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>The source code for this function is not included. This function is delivered as .o file. Libgen uses the appropriate .o file for the target processor. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa2f2f23cf842c10f443509f8861a194a"></a><!-- doxytag: member="xhwicap.h::XHwIcap_SetInterruptHandler" ref="aa2f2f23cf842c10f443509f8861a194a" args="(XHwIcap *InstancePtr, void *CallBackRef, XHwIcap_StatusHandler FuncPtr)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void XHwIcap_SetInterruptHandler </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="struct_x_hw_icap.html">XHwIcap</a> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">void * </td>
|
||
|
|
<td class="paramname"> <em>CallBackRef</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="xhwicap_8h.html#ac66fc3c032512dfc47f97bc87d97ca4b">XHwIcap_StatusHandler</a> </td>
|
||
|
|
<td class="paramname"> <em>FuncPtr</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Sets the status callback function, the status handler, which the driver calls when it encounters conditions that should be reported to the higher layer software. The handler executes in an interrupt context, so it must minimize the amount of processing performed such as transferring data to a thread context. One of the following status events is passed to the status handler. </p>
|
||
|
|
<pre></pre><pre> </pre> <dl><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_hw_icap.html">XHwIcap</a> instance. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>CallBackRef</em> </td><td>is the upper layer callback reference passed back when the callback function is invoked. </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>FuncPtr</em> </td><td>is the pointer to the callback function.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
||
|
|
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
|
||
|
|
<p>The handler is called within interrupt context, so it should do its work quickly and queue potentially time-consuming work to a task-level thread. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<p class="Copyright">
|
||
|
|
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
|
||
|
|
</p>
|
||
|
|
</body>
|
||
|
|
</html>
|