embeddedsw/XilinxProcessorIPLib/drivers/axicdma/doc/html/api/xaxicdma_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

126 lines
17 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>axicdma: xaxicdma.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">axicdma
</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="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_e40864c8df86c6f5e700f41fa1051dbc.html">axicdma</a></li><li class="navelem"><a class="el" href="dir_1a47bfedaeca397204140b7ac95c62ff.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xaxicdma.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3ecc6331ed89e613e7f1fb53f45a4cb0"><td class="memItemLeft" align="right" valign="top">XAxiCdma_Config *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga3ecc6331ed89e613e7f1fb53f45a4cb0">XAxiCdma_LookupConfig</a> (u32 DeviceId)</td></tr>
<tr class="separator:ga3ecc6331ed89e613e7f1fb53f45a4cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaadefa567a30eb3ab3213919fff7d3f9b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gaadefa567a30eb3ab3213919fff7d3f9b">XAxiCdma_CfgInitialize</a> (XAxiCdma *InstancePtr, XAxiCdma_Config *CfgPtr, u32 EffectiveAddr)</td></tr>
<tr class="separator:gaadefa567a30eb3ab3213919fff7d3f9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf97cc8317af0bf1678973925beff0c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gaaf97cc8317af0bf1678973925beff0c5">XAxiCdma_Reset</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:gaaf97cc8317af0bf1678973925beff0c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2575375744593bd55425365dde7744e5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga2575375744593bd55425365dde7744e5">XAxiCdma_ResetIsDone</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:ga2575375744593bd55425365dde7744e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee6e140ed15cd9b7e49145e01220115a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gaee6e140ed15cd9b7e49145e01220115a">XAxiCdma_IsBusy</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:gaee6e140ed15cd9b7e49145e01220115a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga91adf55050cb617cee00b0ba2f0d754e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga91adf55050cb617cee00b0ba2f0d754e">XAxiCdma_SetCoalesce</a> (XAxiCdma *InstancePtr, u32 Counter, u32 Delay)</td></tr>
<tr class="separator:ga91adf55050cb617cee00b0ba2f0d754e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga92087f03877293982f895e8178557f6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga92087f03877293982f895e8178557f6a">XAxiCdma_GetCoalesce</a> (XAxiCdma *InstancePtr, u32 *CounterPtr, u32 *DelayPtr)</td></tr>
<tr class="separator:ga92087f03877293982f895e8178557f6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1fbdb8f7ad8926f744c771e07814f72"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gae1fbdb8f7ad8926f744c771e07814f72">XAxiCdma_GetError</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:gae1fbdb8f7ad8926f744c771e07814f72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f146fe224ea4c9a86477de3030dd79a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga9f146fe224ea4c9a86477de3030dd79a">XAxiCdma_IntrEnable</a> (XAxiCdma *InstancePtr, u32 Mask)</td></tr>
<tr class="separator:ga9f146fe224ea4c9a86477de3030dd79a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a269e884ce6e3552313521dea8032b6"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga1a269e884ce6e3552313521dea8032b6">XAxiCdma_IntrGetEnabled</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:ga1a269e884ce6e3552313521dea8032b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabdccf08d74f4e037b06a36a2e9db2877"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gabdccf08d74f4e037b06a36a2e9db2877">XAxiCdma_IntrDisable</a> (XAxiCdma *InstancePtr, u32 Mask)</td></tr>
<tr class="separator:gabdccf08d74f4e037b06a36a2e9db2877"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8acd5bf5f5f072c6e425a8cc1b589498"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga8acd5bf5f5f072c6e425a8cc1b589498">XAxiCdma_IntrHandler</a> (void *HandlerRef)</td></tr>
<tr class="separator:ga8acd5bf5f5f072c6e425a8cc1b589498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e81ba2046ada4a40527c50ee7fdce9a"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga1e81ba2046ada4a40527c50ee7fdce9a">XAxiCdma_SimpleTransfer</a> (XAxiCdma *InstancePtr, UINTPTR SrcAddr, UINTPTR DstAddr, int Length, XAxiCdma_CallBackFn SimpleCallBack, void *CallBackRef)</td></tr>
<tr class="separator:ga1e81ba2046ada4a40527c50ee7fdce9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga815f36efce97dba797f67f9acbbb761d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga815f36efce97dba797f67f9acbbb761d">XAxiCdma_SelectKeyHole</a> (XAxiCdma *InstancePtr, u32 Direction, u32 Select)</td></tr>
<tr class="separator:ga815f36efce97dba797f67f9acbbb761d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabf6db470a391644bdd03727d17bcb0d6"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gabf6db470a391644bdd03727d17bcb0d6">XAxiCdma_BdRingCntCalc</a> (u32 Alignment, u32 Bytes, u32 BdBuffAddr)</td></tr>
<tr class="separator:gabf6db470a391644bdd03727d17bcb0d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1525cddb18badb5737c1017f2a0d34e1"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga1525cddb18badb5737c1017f2a0d34e1">XAxiCdma_BdRingMemCalc</a> (u32 Alignment, int NumBd)</td></tr>
<tr class="separator:ga1525cddb18badb5737c1017f2a0d34e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6dda9c5b4ded0bdbf1e85d6532461ef6"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga6dda9c5b4ded0bdbf1e85d6532461ef6">XAxiCdma_BdRingGetCnt</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:ga6dda9c5b4ded0bdbf1e85d6532461ef6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga07f505ed309a6eb2172e7e8e154fa082"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga07f505ed309a6eb2172e7e8e154fa082">XAxiCdma_BdRingGetFreeCnt</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:ga07f505ed309a6eb2172e7e8e154fa082"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4677cddba8354ca3979f9b6ae386ffde"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga4677cddba8354ca3979f9b6ae386ffde">XAxiCdma_BdRingSnapShotCurrBd</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:ga4677cddba8354ca3979f9b6ae386ffde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab6f6efa84ee457f155a4c7a94e4227da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gab6f6efa84ee457f155a4c7a94e4227da">XAxiCdma_BdRingGetCurrBd</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:gab6f6efa84ee457f155a4c7a94e4227da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabfe3657b7aad9487946d6bb436aeba18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gabfe3657b7aad9487946d6bb436aeba18">XAxiCdma_BdRingNext</a> (XAxiCdma *InstancePtr, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdPtr)</td></tr>
<tr class="separator:gabfe3657b7aad9487946d6bb436aeba18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga24af2a3eacaf56c972e6313683a3f7e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga24af2a3eacaf56c972e6313683a3f7e0">XAxiCdma_BdRingPrev</a> (XAxiCdma *InstancePtr, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdPtr)</td></tr>
<tr class="separator:ga24af2a3eacaf56c972e6313683a3f7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab36598e09c09ffa680b6c0f207baf9f5"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gab36598e09c09ffa680b6c0f207baf9f5">XAxiCdma_BdRingCreate</a> (XAxiCdma *InstancePtr, UINTPTR PhysAddr, UINTPTR VirtAddr, u32 Alignment, int BdCount)</td></tr>
<tr class="separator:gab36598e09c09ffa680b6c0f207baf9f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3183f9f25654d2a066c19213f29897be"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga3183f9f25654d2a066c19213f29897be">XAxiCdma_BdRingClone</a> (XAxiCdma *InstancePtr, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *TemplateBdPtr)</td></tr>
<tr class="separator:ga3183f9f25654d2a066c19213f29897be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27dd0cdc27b7a724533db75336c4acc6"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga27dd0cdc27b7a724533db75336c4acc6">XAxiCdma_BdRingAlloc</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> **BdSetPtr)</td></tr>
<tr class="separator:ga27dd0cdc27b7a724533db75336c4acc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9be6e4072c2a17f4519ffa9f9ec3332f"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga9be6e4072c2a17f4519ffa9f9ec3332f">XAxiCdma_BdRingUnAlloc</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdSetPtr)</td></tr>
<tr class="separator:ga9be6e4072c2a17f4519ffa9f9ec3332f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c5cd26d9fd3311c2ccfa4253c587e68"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga3c5cd26d9fd3311c2ccfa4253c587e68">XAxiCdma_BdRingToHw</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdSetPtr, XAxiCdma_CallBackFn CallBackFn, void *CallBackRef)</td></tr>
<tr class="separator:ga3c5cd26d9fd3311c2ccfa4253c587e68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafce6a8283bdec8b9c35169c7cd29f4dc"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gafce6a8283bdec8b9c35169c7cd29f4dc">XAxiCdma_BdRingFromHw</a> (XAxiCdma *InstancePtr, int BdLimit, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> **BdSetPtr)</td></tr>
<tr class="separator:gafce6a8283bdec8b9c35169c7cd29f4dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab204e3f92e4edd3865ecf6b344f0b864"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gab204e3f92e4edd3865ecf6b344f0b864">XAxiCdma_BdRingFree</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma__v4__0.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdSetPtr)</td></tr>
<tr class="separator:gab204e3f92e4edd3865ecf6b344f0b864"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1333cf9309c85b0f620e026c889e01c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#gae1333cf9309c85b0f620e026c889e01c">XAxiCdma_BdSetCurBdPtr</a> (XAxiCdma *InstancePtr, UINTPTR CurBdPtr)</td></tr>
<tr class="separator:gae1333cf9309c85b0f620e026c889e01c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1141024e912e7012d2c716cef9fc791f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga1141024e912e7012d2c716cef9fc791f">XAxiCdma_BdSetTailBdPtr</a> (XAxiCdma *InstancePtr, UINTPTR TailBdPtr)</td></tr>
<tr class="separator:ga1141024e912e7012d2c716cef9fc791f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3287c31f1aa41a1e4a535af134324524"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma__v4__0.html#ga3287c31f1aa41a1e4a535af134324524">XAxiCdma_DumpRegisters</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="separator:ga3287c31f1aa41a1e4a535af134324524"><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>