embeddedsw/XilinxProcessorIPLib/drivers/axidma/doc/html/api/xaxidma_8h.html
Nava kishore Manne d18411f597 Drivers: Doxygen changes for 2015.4
Signed-off-by: Nava kishore Manne <navam@xilinx.com>
2015-12-01 11:51:28 +05:30

121 lines
13 KiB
HTML
Executable file

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>axidma: xaxidma.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">axidma
</div>
<div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="globals.html"><span>APIs</span></a></li>
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_77cbdaba61660bf3d37eac9737091131.html">axidma</a></li><li class="navelem"><a class="el" href="dir_d8b80b343a022500e2a21d50e293dc15.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xaxidma.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_axi_dma.html">XAxiDma</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_axi_dma___config.html">XAxiDma_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga9d91f29c6dc41f2106e097f1f9957a6e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga9d91f29c6dc41f2106e097f1f9957a6e">XAxiDma_GetTxRing</a>(InstancePtr)&#160;&#160;&#160;(&amp;((InstancePtr)-&gt;TxBdRing))</td></tr>
<tr class="separator:ga9d91f29c6dc41f2106e097f1f9957a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6373ac3baa5365607f6727f4e2ece7a5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga6373ac3baa5365607f6727f4e2ece7a5">XAxiDma_GetRxRing</a>(InstancePtr)&#160;&#160;&#160;(&amp;((InstancePtr)-&gt;RxBdRing[0]))</td></tr>
<tr class="separator:ga6373ac3baa5365607f6727f4e2ece7a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf03e87b58cf2f9800e6260fda3745631"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gaf03e87b58cf2f9800e6260fda3745631">XAxiDma_GetRxIndexRing</a>(InstancePtr, RingIndex)&#160;&#160;&#160;(&amp;((InstancePtr)-&gt;RxBdRing[RingIndex]))</td></tr>
<tr class="separator:gaf03e87b58cf2f9800e6260fda3745631"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18dd03026dd6c0ebd13526116c09ccae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga18dd03026dd6c0ebd13526116c09ccae">XAxiDma_HasSg</a>(InstancePtr)&#160;&#160;&#160;((InstancePtr)-&gt;HasSg) ? TRUE : FALSE</td></tr>
<tr class="separator:ga18dd03026dd6c0ebd13526116c09ccae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadac28afa26e2cb55bdada1ee3c016c52"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gadac28afa26e2cb55bdada1ee3c016c52">XAxiDma_IntrEnable</a>(InstancePtr, Mask, Direction)</td></tr>
<tr class="separator:gadac28afa26e2cb55bdada1ee3c016c52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadba63ad7c0a784d569736a8d1eb7c367"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gadba63ad7c0a784d569736a8d1eb7c367">XAxiDma_IntrGetEnabled</a>(InstancePtr, Direction)</td></tr>
<tr class="separator:gadba63ad7c0a784d569736a8d1eb7c367"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1936b497c0fa61d326807e5ed8dd572b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga1936b497c0fa61d326807e5ed8dd572b">XAxiDma_IntrDisable</a>(InstancePtr, Mask, Direction)</td></tr>
<tr class="separator:ga1936b497c0fa61d326807e5ed8dd572b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6a0eb17bcfcaf3331e01855d302f5f0e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga6a0eb17bcfcaf3331e01855d302f5f0e">XAxiDma_IntrGetIrq</a>(InstancePtr, Direction)</td></tr>
<tr class="separator:ga6a0eb17bcfcaf3331e01855d302f5f0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ff0d2e5b50846e4b6a2d683283c10d5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga9ff0d2e5b50846e4b6a2d683283c10d5">XAxiDma_IntrAckIrq</a>(InstancePtr, Mask, Direction)</td></tr>
<tr class="separator:ga9ff0d2e5b50846e4b6a2d683283c10d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gac08fe7cb6508a133a7ef036bba7df5b5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_x_axi_dma.html">XAxiDma</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gac08fe7cb6508a133a7ef036bba7df5b5">XAxiDma</a></td></tr>
<tr class="separator:gac08fe7cb6508a133a7ef036bba7df5b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0cbcf5259635ea3c336fe5413c98f75c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_axi_dma___config.html">XAxiDma_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga0cbcf5259635ea3c336fe5413c98f75c">XAxiDma_LookupConfig</a> (u32 DeviceId)</td></tr>
<tr class="separator:ga0cbcf5259635ea3c336fe5413c98f75c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8026e76c90d891d21c9c355ff776cb77"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga8026e76c90d891d21c9c355ff776cb77">XAxiDma_CfgInitialize</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr, <a class="el" href="struct_x_axi_dma___config.html">XAxiDma_Config</a> *Config)</td></tr>
<tr class="separator:ga8026e76c90d891d21c9c355ff776cb77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b7d1248ef065915fd8c9e8d5e00640f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga5b7d1248ef065915fd8c9e8d5e00640f">XAxiDma_Reset</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr)</td></tr>
<tr class="separator:ga5b7d1248ef065915fd8c9e8d5e00640f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf73e1329e40c8ac1ae47a7d9c104af75"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gaf73e1329e40c8ac1ae47a7d9c104af75">XAxiDma_ResetIsDone</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr)</td></tr>
<tr class="separator:gaf73e1329e40c8ac1ae47a7d9c104af75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadb572b623215a7df62b1e0468e3bd68c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gadb572b623215a7df62b1e0468e3bd68c">XAxiDma_Pause</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr)</td></tr>
<tr class="separator:gadb572b623215a7df62b1e0468e3bd68c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga847cd9a0255fcb444bce58b945de8574"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga847cd9a0255fcb444bce58b945de8574">XAxiDma_Resume</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr)</td></tr>
<tr class="separator:ga847cd9a0255fcb444bce58b945de8574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff68c0ba3e9e25dfe5e39153301862f8"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gaff68c0ba3e9e25dfe5e39153301862f8">XAxiDma_Busy</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr, int Direction)</td></tr>
<tr class="separator:gaff68c0ba3e9e25dfe5e39153301862f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga32ca6099d7926297a4c17cdb4a19511b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga32ca6099d7926297a4c17cdb4a19511b">XAxiDma_SimpleTransfer</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr, UINTPTR BuffAddr, u32 Length, int Direction)</td></tr>
<tr class="separator:ga32ca6099d7926297a4c17cdb4a19511b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5becc8b0f9945af34e372ced2b37aebb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga5becc8b0f9945af34e372ced2b37aebb">XAxiDma_SelectKeyHole</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr, int Direction, int Select)</td></tr>
<tr class="separator:ga5becc8b0f9945af34e372ced2b37aebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d93bfcf1c3e34cb9fc4a22da6148dc5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#ga2d93bfcf1c3e34cb9fc4a22da6148dc5">XAxiDma_SelectCyclicMode</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr, int Direction, int Select)</td></tr>
<tr class="separator:ga2d93bfcf1c3e34cb9fc4a22da6148dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad4ea3039216916336ae1c7598ff26afc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axidma__v9__0.html#gad4ea3039216916336ae1c7598ff26afc">XAxiDma_Selftest</a> (<a class="el" href="struct_x_axi_dma.html">XAxiDma</a> *InstancePtr)</td></tr>
<tr class="separator:gad4ea3039216916336ae1c7598ff26afc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
</ul>
</div>
</body>
</html>