<!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.5"/>
<title>axivdma: xaxivdma_i.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">axivdma
</div>
<div id="projectbrief">Vitis Drivers API Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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 Structures</span></a></li>
<li><a href="globals.html"><span>APIs</span></a></li>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="pages.html"><span>Examples</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaxivdma__i_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xaxivdma_i.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:ga795e26fb85aa4140db060d731a19efeb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga795e26fb85aa4140db060d731a19efeb">XAxiVdma_ChannelInit</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga795e26fb85aa4140db060d731a19efeb"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a channel of a DMA engine. <a href="group__axivdma.html#ga795e26fb85aa4140db060d731a19efeb">More...</a><br/></td></tr>
<tr class="separator:ga795e26fb85aa4140db060d731a19efeb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96e2798de16d738f378458fa2b7b2f1c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga96e2798de16d738f378458fa2b7b2f1c">XAxiVdma_ChannelReset</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga96e2798de16d738f378458fa2b7b2f1c"><td class="mdescLeft"> </td><td class="mdescRight">This function resets one DMA channel. <a href="group__axivdma.html#ga96e2798de16d738f378458fa2b7b2f1c">More...</a><br/></td></tr>
<tr class="separator:ga96e2798de16d738f378458fa2b7b2f1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9b0a1008f3e30f3f031763f108f76405"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga9b0a1008f3e30f3f031763f108f76405">XAxiVdma_ChannelResetNotDone</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga9b0a1008f3e30f3f031763f108f76405"><td class="mdescLeft"> </td><td class="mdescRight">This function checks whether reset operation is done. <a href="group__axivdma.html#ga9b0a1008f3e30f3f031763f108f76405">More...</a><br/></td></tr>
<tr class="separator:ga9b0a1008f3e30f3f031763f108f76405"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaf57ab476eb91e9f41b6d166d2b2d6bb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#gaaf57ab476eb91e9f41b6d166d2b2d6bb">XAxiVdma_ChannelIsBusy</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:gaaf57ab476eb91e9f41b6d166d2b2d6bb"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a DMA channel is busy. <a href="group__axivdma.html#gaaf57ab476eb91e9f41b6d166d2b2d6bb">More...</a><br/></td></tr>
<tr class="separator:gaaf57ab476eb91e9f41b6d166d2b2d6bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae429b7acc7449fcb805ae013528c9ba0"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#gae429b7acc7449fcb805ae013528c9ba0">XAxiVdma_ChannelGetStatus</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:gae429b7acc7449fcb805ae013528c9ba0"><td class="mdescLeft"> </td><td class="mdescRight">Get the current status of a channel. <a href="group__axivdma.html#gae429b7acc7449fcb805ae013528c9ba0">More...</a><br/></td></tr>
<tr class="separator:gae429b7acc7449fcb805ae013528c9ba0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13807c40f1f871a6b2f7cbde9eeab9a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga13807c40f1f871a6b2f7cbde9eeab9a8">XAxiVdma_ChannelRegisterDump</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga13807c40f1f871a6b2f7cbde9eeab9a8"><td class="mdescLeft"> </td><td class="mdescRight">Dump registers from one DMA channel. <a href="group__axivdma.html#ga13807c40f1f871a6b2f7cbde9eeab9a8">More...</a><br/></td></tr>
<tr class="separator:ga13807c40f1f871a6b2f7cbde9eeab9a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04f4bf5ac18661ceb9c1ef047949e3d8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga04f4bf5ac18661ceb9c1ef047949e3d8">XAxiVdma_ChannelStartParking</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga04f4bf5ac18661ceb9c1ef047949e3d8"><td class="mdescLeft"> </td><td class="mdescRight">Set the channel to run in parking mode. <a href="group__axivdma.html#ga04f4bf5ac18661ceb9c1ef047949e3d8">More...</a><br/></td></tr>
<tr class="separator:ga04f4bf5ac18661ceb9c1ef047949e3d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacd5a402e30c5170d9dab22d16ff01336"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#gacd5a402e30c5170d9dab22d16ff01336">XAxiVdma_ChannelStopParking</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:gacd5a402e30c5170d9dab22d16ff01336"><td class="mdescLeft"> </td><td class="mdescRight">Set the channel to run in circular mode, exiting parking mode. <a href="group__axivdma.html#gacd5a402e30c5170d9dab22d16ff01336">More...</a><br/></td></tr>
<tr class="separator:gacd5a402e30c5170d9dab22d16ff01336"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga771725985f20173546d5555fb8806a6c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga771725985f20173546d5555fb8806a6c">XAxiVdma_ChannelStartFrmCntEnable</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga771725985f20173546d5555fb8806a6c"><td class="mdescLeft"> </td><td class="mdescRight">Set the channel to run in frame count enable mode. <a href="group__axivdma.html#ga771725985f20173546d5555fb8806a6c">More...</a><br/></td></tr>
<tr class="separator:ga771725985f20173546d5555fb8806a6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64d6b39bc9e900efe9f14c9961f4da24"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga64d6b39bc9e900efe9f14c9961f4da24">XAxiVdma_ChannelEnableIntr</a> (XAxiVdma_Channel *Channel, u32 IntrType)</td></tr>
<tr class="memdesc:ga64d6b39bc9e900efe9f14c9961f4da24"><td class="mdescLeft"> </td><td class="mdescRight">Enable interrupts for a channel. <a href="group__axivdma.html#ga64d6b39bc9e900efe9f14c9961f4da24">More...</a><br/></td></tr>
<tr class="separator:ga64d6b39bc9e900efe9f14c9961f4da24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2daa8c45a82867bedf786957b4154cdc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga2daa8c45a82867bedf786957b4154cdc">XAxiVdma_ChannelDisableIntr</a> (XAxiVdma_Channel *Channel, u32 IntrType)</td></tr>
<tr class="memdesc:ga2daa8c45a82867bedf786957b4154cdc"><td class="mdescLeft"> </td><td class="mdescRight">Disable interrupts for a channel. <a href="group__axivdma.html#ga2daa8c45a82867bedf786957b4154cdc">More...</a><br/></td></tr>
<tr class="separator:ga2daa8c45a82867bedf786957b4154cdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga361297a60672ab2552754d8a58d3f7ab"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga361297a60672ab2552754d8a58d3f7ab">XAxiVdma_ChannelGetPendingIntr</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga361297a60672ab2552754d8a58d3f7ab"><td class="mdescLeft"> </td><td class="mdescRight">Get pending interrupts of a channel. <a href="group__axivdma.html#ga361297a60672ab2552754d8a58d3f7ab">More...</a><br/></td></tr>
<tr class="separator:ga361297a60672ab2552754d8a58d3f7ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaccc8d62d87870cb43c048938e405d4e6"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#gaccc8d62d87870cb43c048938e405d4e6">XAxiVdma_ChannelGetEnabledIntr</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:gaccc8d62d87870cb43c048938e405d4e6"><td class="mdescLeft"> </td><td class="mdescRight">Get the enabled interrupts of a channel. <a href="group__axivdma.html#gaccc8d62d87870cb43c048938e405d4e6">More...</a><br/></td></tr>
<tr class="separator:gaccc8d62d87870cb43c048938e405d4e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7a8c557bce703f572d4e2dd9e362f489"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga7a8c557bce703f572d4e2dd9e362f489">XAxiVdma_ChannelIntrClear</a> (XAxiVdma_Channel *Channel, u32 IntrType)</td></tr>
<tr class="memdesc:ga7a8c557bce703f572d4e2dd9e362f489"><td class="mdescLeft"> </td><td class="mdescRight">Clear interrupts of a channel. <a href="group__axivdma.html#ga7a8c557bce703f572d4e2dd9e362f489">More...</a><br/></td></tr>
<tr class="separator:ga7a8c557bce703f572d4e2dd9e362f489"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3b9c24a02c4b4f99d40820a647de811d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga3b9c24a02c4b4f99d40820a647de811d">XAxiVdma_ChannelStartTransfer</a> (XAxiVdma_Channel *Channel, XAxiVdma_ChannelSetup *ChannelCfgPtr)</td></tr>
<tr class="memdesc:ga3b9c24a02c4b4f99d40820a647de811d"><td class="mdescLeft"> </td><td class="mdescRight">Start a transfer. <a href="group__axivdma.html#ga3b9c24a02c4b4f99d40820a647de811d">More...</a><br/></td></tr>
<tr class="separator:ga3b9c24a02c4b4f99d40820a647de811d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1703c6dcef193966f4f1db7e6e9e59ce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga1703c6dcef193966f4f1db7e6e9e59ce">XAxiVdma_ChannelSetBdAddrs</a> (XAxiVdma_Channel *Channel, UINTPTR BdAddrPhys, UINTPTR BdAddrVirt)</td></tr>
<tr class="memdesc:ga1703c6dcef193966f4f1db7e6e9e59ce"><td class="mdescLeft"> </td><td class="mdescRight">Setup BD addresses to a different memory region. <a href="group__axivdma.html#ga1703c6dcef193966f4f1db7e6e9e59ce">More...</a><br/></td></tr>
<tr class="separator:ga1703c6dcef193966f4f1db7e6e9e59ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga74ab4785d21c80a0d4501f0d985213e4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga74ab4785d21c80a0d4501f0d985213e4">XAxiVdma_ChannelConfig</a> (XAxiVdma_Channel *Channel, XAxiVdma_ChannelSetup *ChannelCfgPtr)</td></tr>
<tr class="memdesc:ga74ab4785d21c80a0d4501f0d985213e4"><td class="mdescLeft"> </td><td class="mdescRight">Configure one DMA channel using the configuration structure. <a href="group__axivdma.html#ga74ab4785d21c80a0d4501f0d985213e4">More...</a><br/></td></tr>
<tr class="separator:ga74ab4785d21c80a0d4501f0d985213e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga14da4fd85b6e6c8009479634bca8527a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga14da4fd85b6e6c8009479634bca8527a">XAxiVdma_ChannelSetBufferAddr</a> (XAxiVdma_Channel *Channel, UINTPTR *BufferAddrSet, int NumFrames)</td></tr>
<tr class="memdesc:ga14da4fd85b6e6c8009479634bca8527a"><td class="mdescLeft"> </td><td class="mdescRight">Configure buffer addresses for one DMA channel. <a href="group__axivdma.html#ga14da4fd85b6e6c8009479634bca8527a">More...</a><br/></td></tr>
<tr class="separator:ga14da4fd85b6e6c8009479634bca8527a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91cec5aee2b7126eb128169ddd2b4b4f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga91cec5aee2b7126eb128169ddd2b4b4f">XAxiVdma_ChannelStart</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga91cec5aee2b7126eb128169ddd2b4b4f"><td class="mdescLeft"> </td><td class="mdescRight">Start one DMA channel. <a href="group__axivdma.html#ga91cec5aee2b7126eb128169ddd2b4b4f">More...</a><br/></td></tr>
<tr class="separator:ga91cec5aee2b7126eb128169ddd2b4b4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12bb1b451a69ecfc70f55d4fbf7257b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga12bb1b451a69ecfc70f55d4fbf7257b0">XAxiVdma_ChannelStop</a> (XAxiVdma_Channel *Channel)</td></tr>
<tr class="memdesc:ga12bb1b451a69ecfc70f55d4fbf7257b0"><td class="mdescLeft"> </td><td class="mdescRight">Stop one DMA channel. <a href="group__axivdma.html#ga12bb1b451a69ecfc70f55d4fbf7257b0">More...</a><br/></td></tr>
<tr class="separator:ga12bb1b451a69ecfc70f55d4fbf7257b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga524861abb42dc3da2ed14d5932a3bb5b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga524861abb42dc3da2ed14d5932a3bb5b">XAxiVdma_ChannelSetFrmCnt</a> (XAxiVdma_Channel *Channel, u8 FrmCnt, u8 DlyCnt)</td></tr>
<tr class="memdesc:ga524861abb42dc3da2ed14d5932a3bb5b"><td class="mdescLeft"> </td><td class="mdescRight">Set the frame counter and delay counter for one channel. <a href="group__axivdma.html#ga524861abb42dc3da2ed14d5932a3bb5b">More...</a><br/></td></tr>
<tr class="separator:ga524861abb42dc3da2ed14d5932a3bb5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3e90ef720feb2a974511d7e2889a2198"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axivdma.html#ga3e90ef720feb2a974511d7e2889a2198">XAxiVdma_ChannelGetFrmCnt</a> (XAxiVdma_Channel *Channel, u8 *FrmCnt, u8 *DlyCnt)</td></tr>
<tr class="memdesc:ga3e90ef720feb2a974511d7e2889a2198"><td class="mdescLeft"> </td><td class="mdescRight">Get the frame counter and delay counter for both channels. <a href="group__axivdma.html#ga3e90ef720feb2a974511d7e2889a2198">More...</a><br/></td></tr>
<tr class="separator:ga3e90ef720feb2a974511d7e2889a2198"><td class="memSeparator" colspan="2"> </td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<p class="footer">© Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
<p class="footer">© Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>