stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xstreamer_8c.html

254 lines
11 KiB
HTML
Raw Normal View History

doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers llfifo,mbox,mig_7series,mutex,nandps to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 15:45:45 +05:30
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: xstreamer.c 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&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xstreamer.c File Reference</h1><code>#include &quot;<a class="el" href="xstreamer_8h.html">xstreamer.h</a>&quot;</code><br/>
<code>#include &quot;xil_assert.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#abb702d8b501669a23aa0ab3b281b9384">min</a>(x, y)&nbsp;&nbsp;&nbsp;(((x) &lt; (y)) ? (x) : (y))</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#af522443c3d427ece2a8ce4e2231eca29">xdbg_stmnt</a> (u32 _xstrm_ro_value;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a8a67c77f811a505b658e06642eb9c964">XStrm_TxInitialize</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, unsigned FifoWidth, void *FifoInstance, <a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a> WriteFn, <a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a> SetLenFn, <a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a> GetVacancyFn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a479d2eb3193ad0a5efc3c3b432a78381">XStrm_RxGetLen</a> (<a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a915d68a9cce0f2464fc7644383cb887a">XStrm_Read</a> (<a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *InstancePtr, void *BufPtr, unsigned Bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a1e99fb51e0cfab7d0e8de5e93c27fd9c">XStrm_TxSetLen</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, u32 Bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a1f43ea833af99162745ceef66849b666">XStrm_Write</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, void *BufPtr, unsigned Bytes)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="abb702d8b501669a23aa0ab3b281b9384"></a><!-- doxytag: member="xstreamer.c::min" ref="abb702d8b501669a23aa0ab3b281b9384" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define min</td>
<td>(</td>
<td class="paramtype">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">y&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;(((x) &lt; (y)) ? (x) : (y))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="af522443c3d427ece2a8ce4e2231eca29"></a><!-- doxytag: member="xstreamer.c::xdbg_stmnt" ref="af522443c3d427ece2a8ce4e2231eca29" args="(u32 _xstrm_ro_value;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xdbg_stmnt </td>
<td>(</td>
<td class="paramtype">u32 _xstrm_ro_value;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a915d68a9cce0f2464fc7644383cb887a"></a><!-- doxytag: member="xstreamer.c::XStrm_Read" ref="a915d68a9cce0f2464fc7644383cb887a" args="(XStrm_RxFifoStreamer *InstancePtr, void *BufPtr, unsigned Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_Read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a479d2eb3193ad0a5efc3c3b432a78381"></a><!-- doxytag: member="xstreamer.c::XStrm_RxGetLen" ref="a479d2eb3193ad0a5efc3c3b432a78381" args="(XStrm_RxFifoStreamer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XStrm_RxGetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8a67c77f811a505b658e06642eb9c964"></a><!-- doxytag: member="xstreamer.c::XStrm_TxInitialize" ref="a8a67c77f811a505b658e06642eb9c964" args="(XStrm_TxFifoStreamer *InstancePtr, unsigned FifoWidth, void *FifoInstance, XStrm_XferFnType WriteFn, XStrm_SetLenFnType SetLenFn, XStrm_GetVacancyFnType GetVacancyFn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_TxInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>FifoWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>FifoInstance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a>&nbsp;</td>
<td class="paramname"> <em>WriteFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a>&nbsp;</td>
<td class="paramname"> <em>SetLenFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a>&nbsp;</td>
<td class="paramname"> <em>GetVacancyFn</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e99fb51e0cfab7d0e8de5e93c27fd9c"></a><!-- doxytag: member="xstreamer.c::XStrm_TxSetLen" ref="a1e99fb51e0cfab7d0e8de5e93c27fd9c" args="(XStrm_TxFifoStreamer *InstancePtr, u32 Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_TxSetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1f43ea833af99162745ceef66849b666"></a><!-- doxytag: member="xstreamer.c::XStrm_Write" ref="a1f43ea833af99162745ceef66849b666" args="(XStrm_TxFifoStreamer *InstancePtr, void *BufPtr, unsigned Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_Write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
Reference in a new issue Copy permalink