659fb81abd
This patch updates the doxygen for the drivers emaclite,dmaps, emacps,gpio,gpiops to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
1466 lines
72 KiB
HTML
Executable file
1466 lines
72 KiB
HTML
Executable file
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
Xilinx Driver dmaps v2_1: xdmaps.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 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>xdmaps.c File Reference</h1><code>#include <string.h></code><br/>
|
|
<code>#include "xstatus.h"</code><br/>
|
|
<code>#include "<a class="el" href="xdmaps_8h.html">xdmaps.h</a>"</code><br/>
|
|
<code>#include "xil_io.h"</code><br/>
|
|
<code>#include "xil_cache.h"</code><br/>
|
|
<code>#include "xil_printf.h"</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a2eb6f9e0395b47b8d5e3eeae4fe0c116">INLINE</a> __inline</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a0da5f3a4101306a3fafc78fe68fdc5ba">XDMAPS_MOV_SAR</a> 0x0</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a0ff96edc3262017cb5a534e0f40666b9">XDMAPS_MOV_CCR</a> 0x1</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a17d867b1d1c22303bbefc876df00eb44">XDMAPS_MOV_DAR</a> 0x2</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#afda974c51436dbd4826f8cb43257382c">XDMAPS_CCR_SINGLE_BYTE</a> (0x0)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a016fc795bc9dee437f8264d95b4538dd">XDMAPS_CCR_M2M_SINGLE_BYTE</a> ((0x1 << 14) | 0x1)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a3bab9e663ba55d9f176d60c4a0b5ab33">XDMAPS_MAX_WAIT</a> 4000</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="xdmaps_8c.html#a2fed90dfba1ff9f472b40ed492d78b4c">XDmaPs_CfgInitialize</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, <a class="el" href="struct_x_dma_ps___config.html">XDmaPs_Config</a> *Config, u32 EffectiveAddr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a65cc22a994eb1ca6a9c56d86d469242e">XDmaPs_ResetManager</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a593458e8f6ac55566fc235e8a93b9890">XDmaPs_ResetChannel</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, unsigned int Channel)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#ae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#accf32b08856fbe62745a4d0552aa1bff">XDmaPs_SetDoneHandler</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, unsigned Channel, <a class="el" href="xdmaps_8h.html#ad59232da2016e1a60744cc6e11a04a98">XDmaPsDoneHandler</a> DoneHandler, void *CallbackRef)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#acda5c5523ed24451a7efacc7b9257fa3">XDmaPs_SetFaultHandler</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, <a class="el" href="xdmaps_8h.html#a5dba8cc7cd39c53eed1dabac803ce74f">XDmaPsFaultHandler</a> FaultHandler, void *CallbackRef)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#ac52c9c76aa4156ff548888bcc1f58a48">XDmaPs_Instr_DMAEND</a> (char *DmaProg)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#ae5e86294a76de3ffcfe48791f16af147">XDmaPs_Memcpy4</a> (char *Dst, char *Src)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a3e3b15e05e4fe2cb176d817bcf1bc581">XDmaPs_Instr_DMAGO</a> (char *DmaProg, unsigned int Cn, u32 Imm, unsigned int Ns)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a6fa933fa3f1dae9ea5e282b490bdecd8">XDmaPs_Instr_DMALD</a> (char *DmaProg)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a736929d9196deddf645520b662236169">XDmaPs_Instr_DMALP</a> (char *DmaProg, unsigned Lc, unsigned LoopIterations)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#abac6fc101265846e9d1073f27d1c8e59">XDmaPs_Instr_DMALPEND</a> (char *DmaProg, char *BodyStart, unsigned Lc)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a6316882a34a6c0564c4c1416b6002ba7">XDmaPs_Instr_DMAMOV</a> (char *DmaProg, unsigned Rd, u32 Imm)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a0c98113bdd84ac7e77f5e5f5681537f7">XDmaPs_Instr_DMANOP</a> (char *DmaProg)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a35f1c4fac1addecaac884eaf7985b4fd">XDmaPs_Instr_DMARMB</a> (char *DmaProg)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#abaa591ca22aef7df43ecd5e90cbcde7f">XDmaPs_Instr_DMASEV</a> (char *DmaProg, unsigned int EventNumber)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a2a75eccd5e0a59732df4b4fc985f5d2a">XDmaPs_Instr_DMAST</a> (char *DmaProg)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a4e0cc9a3c922b98413f236ee5fd296f3">XDmaPs_Instr_DMAWMB</a> (char *DmaProg)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#ae109c6697d070147c066e38658372416">XDmaPs_ToEndianSwapSizeBits</a> (unsigned int EndianSwapSize)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">INLINE unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#afa935ca1aca9b232b0d6c1b03cb50cc7">XDmaPs_ToBurstSizeBits</a> (unsigned BurstSize)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a68a8d4fbf7cf6154ad2c58df0479d329">XDmaPs_ToCCRValue</a> (<a class="el" href="struct_x_dma_ps___chan_ctrl.html">XDmaPs_ChanCtrl</a> *ChanCtrl)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#ada17404db9934447c93bae5a66a71282">XDmaPs_ConstructSingleLoop</a> (char *DmaProgStart, int CacheLength, char *DmaProgLoopStart, int LoopCount)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#aecba56f06526fe2ad0c8af65ff4237bb">XDmaPs_ConstructNestedLoop</a> (char *DmaProgStart, int CacheLength, char *DmaProgLoopStart, unsigned int LoopCountOuter, unsigned int LoopCountInner)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#abc2e04f69037f0bdba33275ae017af8a">XDmaPs_GenDmaProg</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, unsigned int Channel, <a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> *Cmd)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a96c4c2e45ab31a22f05767c24db425ea">XDmaPs_FreeDmaProg</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, unsigned int Channel, <a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> *Cmd)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a3691ba115c788c4f68a05cf05c486eeb">XDmaPs_Start</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, unsigned int Channel, <a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> *Cmd, int HoldDmaProg)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a05047e523efd0dcc0e1f3ba16a32a796">XDmaPs_IsActive</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr, unsigned int Channel)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a20b05e6795a86f3381e6850a0ada0c6d">XDmaPs_DoneISR_0</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a766bb579aeee8b0914fcb258a4057259">XDmaPs_DoneISR_1</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#ada1623174e9c5bbb4bf247a650987dbd">XDmaPs_DoneISR_2</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a6b98da80d55e109b0cb57a34f9baa5a9">XDmaPs_DoneISR_3</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a1a1f8340c3a0a64e8a2363c5fe752707">XDmaPs_DoneISR_4</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#afbb8e861538769798d48350dd885dc65">XDmaPs_DoneISR_5</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a2946a438ecf5fd79ca346254c69ba208">XDmaPs_DoneISR_6</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a42bc1b1e99ac5ea705d1a707f4618fc3">XDmaPs_DoneISR_7</a> (<a class="el" href="struct_x_dma_ps.html">XDmaPs</a> *InstPtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xdmaps_8c.html#a24d151e510be2f13777cc85a563c6bbd">XDmaPs_Print_DmaProg</a> (<a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> *Cmd)</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>This file contains the implementation of the interface functions for <a class="el" href="struct_x_dma_ps.html">XDmaPs</a> driver. Refer to the header file <a class="el" href="xdmaps_8h.html">xdmaps.h</a> for more detailed information.</p>
|
|
<pre>
|
|
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
|
|
----- ------ -------- ----------------------------------------------
|
|
1.00 hbm 08/19/2010 First Release
|
|
1.00 nm 05/25/2011 Updated for minor doxygen corrections
|
|
1.02a sg 05/16/2012 Made changes for doxygen and moved some function
|
|
header from the <a class="el" href="xdmaps_8h.html">xdmaps.h</a> file to <a class="el" href="xdmaps_8c.html">xdmaps.c</a> file
|
|
Other cleanup for coding guidelines and CR 657109
|
|
and CR 657898
|
|
1.03a sg 07/16/2012 changed inline to __inline for CR665681
|
|
1.04a nm 10/22/2012 Fixed CR# 681671.
|
|
1.05a nm 04/15/2013 Fixed CR# 704396. Removed warnings when compiled
|
|
with -Wall and -Wextra option in bsp.
|
|
05/01/2013 Fixed CR# 700189. Changed XDmaPs_BuildDmaProg()
|
|
function description.
|
|
Fixed CR# 704396. Removed unused variables
|
|
UseM2MByte & MemBurstLen from XDmaPs_BuildDmaProg()
|
|
function.
|
|
1.07a asa 11/02/13. Made changes to fix compilation issues for iarcc.
|
|
Removed the PDBG prints. By default they were always
|
|
defined out and never used. The PDBG is non-standard for
|
|
Xilinx drivers and no other driver does something similar.
|
|
Since there is no easy way to fix compilation issues with
|
|
the IARCC compiler around PDBG, it is better to remove it.
|
|
Users can always use xil_printfs if they want to debug.
|
|
</pre> <hr/><h2>Define Documentation</h2>
|
|
<a class="anchor" id="a2eb6f9e0395b47b8d5e3eeae4fe0c116"></a><!-- doxytag: member="xdmaps.c::INLINE" ref="a2eb6f9e0395b47b8d5e3eeae4fe0c116" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define INLINE __inline</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a016fc795bc9dee437f8264d95b4538dd"></a><!-- doxytag: member="xdmaps.c::XDMAPS_CCR_M2M_SINGLE_BYTE" ref="a016fc795bc9dee437f8264d95b4538dd" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XDMAPS_CCR_M2M_SINGLE_BYTE ((0x1 << 14) | 0x1)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afda974c51436dbd4826f8cb43257382c"></a><!-- doxytag: member="xdmaps.c::XDMAPS_CCR_SINGLE_BYTE" ref="afda974c51436dbd4826f8cb43257382c" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XDMAPS_CCR_SINGLE_BYTE (0x0)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3bab9e663ba55d9f176d60c4a0b5ab33"></a><!-- doxytag: member="xdmaps.c::XDMAPS_MAX_WAIT" ref="a3bab9e663ba55d9f176d60c4a0b5ab33" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XDMAPS_MAX_WAIT 4000</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0ff96edc3262017cb5a534e0f40666b9"></a><!-- doxytag: member="xdmaps.c::XDMAPS_MOV_CCR" ref="a0ff96edc3262017cb5a534e0f40666b9" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XDMAPS_MOV_CCR 0x1</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a17d867b1d1c22303bbefc876df00eb44"></a><!-- doxytag: member="xdmaps.c::XDMAPS_MOV_DAR" ref="a17d867b1d1c22303bbefc876df00eb44" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XDMAPS_MOV_DAR 0x2</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0da5f3a4101306a3fafc78fe68fdc5ba"></a><!-- doxytag: member="xdmaps.c::XDMAPS_MOV_SAR" ref="a0da5f3a4101306a3fafc78fe68fdc5ba" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XDMAPS_MOV_SAR 0x0</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="a2fed90dfba1ff9f472b40ed492d78b4c"></a><!-- doxytag: member="xdmaps.c::XDmaPs_CfgInitialize" ref="a2fed90dfba1ff9f472b40ed492d78b4c" args="(XDmaPs *InstPtr, XDmaPs_Config *Config, u32 EffectiveAddr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_CfgInitialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps___config.html">XDmaPs_Config</a> * </td>
|
|
<td class="paramname"> <em>Config</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>Initializes a specific <a class="el" href="struct_x_dma_ps.html">XDmaPs</a> instance such that it is ready to be used. The data format of the device is setup for 8 data bits, 1 stop bit, and no parity by default. The baud rate is set to a default value specified by Config->DefaultBaudRate if set, otherwise it is set to 19.2K baud. The receive FIFO threshold is set for 8 bytes. The default operating mode of the driver is polled mode.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is a pointer to the <a class="el" href="struct_x_dma_ps.html">XDmaPs</a> instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Config</em> </td><td>is a reference to a structure containing information about a specific <a class="el" href="struct_x_dma_ps.html">XDmaPs</a> driver. </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. The caller is responsible for keeping the address mapping from EffectiveAddr to the device physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, pass in the physical address instead.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
<ul>
|
|
<li>XST_SUCCESS on initialization completion</li>
|
|
</ul>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aecba56f06526fe2ad0c8af65ff4237bb"></a><!-- doxytag: member="xdmaps.c::XDmaPs_ConstructNestedLoop" ref="aecba56f06526fe2ad0c8af65ff4237bb" args="(char *DmaProgStart, int CacheLength, char *DmaProgLoopStart, unsigned int LoopCountOuter, unsigned int LoopCountInner)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_ConstructNestedLoop </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProgStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>CacheLength</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProgLoopStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>LoopCountOuter</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>LoopCountInner</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construct a nested loop with only DMALD and DMAST in the inner loop body. It uses loop counter 1 for the outer loop and loop counter 0 for the inner loop.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProgStart</em> </td><td>is the very start address of the DMA program. This is used to calculate whether the loop is in a cache line. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CacheLength</em> </td><td>is the icache line length, in terms of bytes. If it's zero, the performance enhancement feature will be turned off. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProgLoopStart</em> </td><td>The starting address of the loop (DMALP). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LoopCountOuter</em> </td><td>The outer loop count. Loop count - 1 will be used to initialize the loop counter. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LoopCountInner</em> </td><td>The inner loop count. Loop count - 1 will be used to initialize the loop counter.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number byes the nested loop program has.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ada17404db9934447c93bae5a66a71282"></a><!-- doxytag: member="xdmaps.c::XDmaPs_ConstructSingleLoop" ref="ada17404db9934447c93bae5a66a71282" args="(char *DmaProgStart, int CacheLength, char *DmaProgLoopStart, int LoopCount)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_ConstructSingleLoop </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProgStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>CacheLength</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProgLoopStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>LoopCount</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construct a loop with only DMALD and DMAST as the body using loop counter 0. The function also makes sure the loop body and the lpend is in the same cache line.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProgStart</em> </td><td>is the very start address of the DMA program. This is used to calculate whether the loop is in a cache line. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CacheLength</em> </td><td>is the icache line length, in terms of bytes. If it's zero, the performance enhancement feature will be turned off. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProgLoopStart</em> </td><td>The starting address of the loop (DMALP). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LoopCount</em> </td><td>The inner loop count. Loop count - 1 will be used to initialize the loop counter.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes the loop has.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a20b05e6795a86f3381e6850a0ada0c6d"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_0" ref="a20b05e6795a86f3381e6850a0ada0c6d" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_0 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 0. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="a766bb579aeee8b0914fcb258a4057259"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_1" ref="a766bb579aeee8b0914fcb258a4057259" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 1. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="ada1623174e9c5bbb4bf247a650987dbd"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_2" ref="ada1623174e9c5bbb4bf247a650987dbd" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 2. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="a6b98da80d55e109b0cb57a34f9baa5a9"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_3" ref="a6b98da80d55e109b0cb57a34f9baa5a9" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_3 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 3. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="a1a1f8340c3a0a64e8a2363c5fe752707"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_4" ref="a1a1f8340c3a0a64e8a2363c5fe752707" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_4 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 4. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="afbb8e861538769798d48350dd885dc65"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_5" ref="afbb8e861538769798d48350dd885dc65" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_5 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 5. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="a2946a438ecf5fd79ca346254c69ba208"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_6" ref="a2946a438ecf5fd79ca346254c69ba208" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_6 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 6. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="a42bc1b1e99ac5ea705d1a707f4618fc3"></a><!-- doxytag: member="xdmaps.c::XDmaPs_DoneISR_7" ref="a42bc1b1e99ac5ea705d1a707f4618fc3" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_DoneISR_7 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver done interrupt service routine for channel 7. We need this done ISR mainly because the driver needs to release the DMA program buffer. This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="ae1f2b39fb5e2e8d369c3286aeada67be"></a><!-- doxytag: member="xdmaps.c::XDmaPs_FaultISR" ref="ae1f2b39fb5e2e8d369c3286aeada67be" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_FaultISR </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Driver fault interrupt service routine This is the one that connects the GIC</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA 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="a96c4c2e45ab31a22f05767c24db425ea"></a><!-- doxytag: member="xdmaps.c::XDmaPs_FreeDmaProg" ref="a96c4c2e45ab31a22f05767c24db425ea" args="(XDmaPs *InstPtr, unsigned int Channel, XDmaPs_Cmd *Cmd)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_FreeDmaProg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>Channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> * </td>
|
|
<td class="paramname"> <em>Cmd</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Free the DMA program buffer that is pointed by the GeneratedDmaProg field of the command.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is then DMA instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Channel</em> </td><td>is the DMA channel number. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Cmd</em> </td><td>is the DMA command.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>XST_SUCCESS on success. XST_FAILURE if there is any error.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abc2e04f69037f0bdba33275ae017af8a"></a><!-- doxytag: member="xdmaps.c::XDmaPs_GenDmaProg" ref="abc2e04f69037f0bdba33275ae017af8a" args="(XDmaPs *InstPtr, unsigned int Channel, XDmaPs_Cmd *Cmd)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_GenDmaProg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>Channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> * </td>
|
|
<td class="paramname"> <em>Cmd</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Generate a DMA program based for the DMA command, the buffer will be pointed by the GeneratedDmaProg field of the command.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is then DMA instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Channel</em> </td><td>is the DMA channel number. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Cmd</em> </td><td>is the DMA command.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>- XST_SUCCESS on success.<ul>
|
|
<li>XST_FAILURE if it fails</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac52c9c76aa4156ff548888bcc1f58a48"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMAEND" ref="ac52c9c76aa4156ff548888bcc1f58a48" args="(char *DmaProg)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMAEND </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMAEND instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>the DMA program buffer, it's the starting address for the instruction being constructed</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 1.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3e3b15e05e4fe2cb176d817bcf1bc581"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMAGO" ref="a3e3b15e05e4fe2cb176d817bcf1bc581" args="(char *DmaProg, unsigned int Cn, u32 Imm, unsigned int Ns)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMAGO </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>Cn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>Imm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>Ns</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMAGO instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Cn</em> </td><td>is the Channel number, 0 - 7 </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Imm</em> </td><td>is 32-bit immediate number written to the Channel Program Counter. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Ns</em> </td><td>is Non-secure flag. If Ns is 1, the DMA channel operates in the Non-secure state. If Ns is 0, the execution depends on the security state of the DMA manager: DMA manager is in the Secure state, DMA channel operates in the Secure state. DMA manager is in the Non-secure state, DMAC aborts.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 6.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6fa933fa3f1dae9ea5e282b490bdecd8"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMALD" ref="a6fa933fa3f1dae9ea5e282b490bdecd8" args="(char *DmaProg)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMALD </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMALD instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>the DMA program buffer, it's the starting address for the instruction being constructed</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 1.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a736929d9196deddf645520b662236169"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMALP" ref="a736929d9196deddf645520b662236169" args="(char *DmaProg, unsigned Lc, unsigned LoopIterations)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMALP </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"> <em>Lc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"> <em>LoopIterations</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMALP instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Lc</em> </td><td>is the Loop counter register, can either be 0 or 1. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LoopIterations,:</em> </td><td>the number of interations, LoopInterations - 1 will be encoded in the DMALP instruction.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 2.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abac6fc101265846e9d1073f27d1c8e59"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMALPEND" ref="abac6fc101265846e9d1073f27d1c8e59" args="(char *DmaProg, char *BodyStart, unsigned Lc)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMALPEND </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>BodyStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"> <em>Lc</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMALPEND instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BodyStart</em> </td><td>is the starting address of the loop body. It is used to calculate the bytes of backward jump. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Lc</em> </td><td>is the Loop counter register, can either be 0 or 1.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 2.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6316882a34a6c0564c4c1416b6002ba7"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMAMOV" ref="a6316882a34a6c0564c4c1416b6002ba7" args="(char *DmaProg, unsigned Rd, u32 Imm)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMAMOV </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"> <em>Rd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>Imm</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMAMOV instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Rd</em> </td><td>is the register id, 0 for SAR, 1 for CCR, and 2 for DAR </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Imm</em> </td><td>is the 32-bit immediate number</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 6.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0c98113bdd84ac7e77f5e5f5681537f7"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMANOP" ref="a0c98113bdd84ac7e77f5e5f5681537f7" args="(char *DmaProg)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMANOP </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMANOP instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 1.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a35f1c4fac1addecaac884eaf7985b4fd"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMARMB" ref="a35f1c4fac1addecaac884eaf7985b4fd" args="(char *DmaProg)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMARMB </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMARMB instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 1.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abaa591ca22aef7df43ecd5e90cbcde7f"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMASEV" ref="abaa591ca22aef7df43ecd5e90cbcde7f" args="(char *DmaProg, unsigned int EventNumber)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMASEV </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>EventNumber</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMASEV instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>EventNumber</em> </td><td>is the Event number to signal.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 2.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2a75eccd5e0a59732df4b4fc985f5d2a"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMAST" ref="a2a75eccd5e0a59732df4b4fc985f5d2a" args="(char *DmaProg)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMAST </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMAST instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 1.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4e0cc9a3c922b98413f236ee5fd296f3"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Instr_DMAWMB" ref="a4e0cc9a3c922b98413f236ee5fd296f3" args="(char *DmaProg)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE int XDmaPs_Instr_DMAWMB </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>DmaProg</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Construction function for DMAWMB instruction. This function fills the program buffer with the constructed instruction.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DmaProg</em> </td><td>is the DMA program buffer, it's the starting address for the instruction being constructed</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes for this instruction which is 1.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a05047e523efd0dcc0e1f3ba16a32a796"></a><!-- doxytag: member="xdmaps.c::XDmaPs_IsActive" ref="a05047e523efd0dcc0e1f3ba16a32a796" args="(XDmaPs *InstPtr, unsigned int Channel)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_IsActive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>Channel</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Checks whether the DMA channel is active or idle.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Channel</em> </td><td>is the DMA channel number.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0: if the channel is idle 1: otherwise</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae5e86294a76de3ffcfe48791f16af147"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Memcpy4" ref="ae5e86294a76de3ffcfe48791f16af147" args="(char *Dst, char *Src)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE void XDmaPs_Memcpy4 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>Dst</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"> <em>Src</em></td><td> </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="a24d151e510be2f13777cc85a563c6bbd"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Print_DmaProg" ref="a24d151e510be2f13777cc85a563c6bbd" args="(XDmaPs_Cmd *Cmd)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XDmaPs_Print_DmaProg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> * </td>
|
|
<td class="paramname"> <em>Cmd</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Print the Dma Prog Contents.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>Cmd</em> </td><td>is the command buffer.</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="a593458e8f6ac55566fc235e8a93b9890"></a><!-- doxytag: member="xdmaps.c::XDmaPs_ResetChannel" ref="a593458e8f6ac55566fc235e8a93b9890" args="(XDmaPs *InstPtr, unsigned int Channel)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_ResetChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>Channel</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Reset the specified DMA Channel.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Channel</em> </td><td>is the channel to be reset.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on time out</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a65cc22a994eb1ca6a9c56d86d469242e"></a><!-- doxytag: member="xdmaps.c::XDmaPs_ResetManager" ref="a65cc22a994eb1ca6a9c56d86d469242e" args="(XDmaPs *InstPtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_ResetManager </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Reset the DMA Manager.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA instance.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on time out</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="accf32b08856fbe62745a4d0552aa1bff"></a><!-- doxytag: member="xdmaps.c::XDmaPs_SetDoneHandler" ref="accf32b08856fbe62745a4d0552aa1bff" args="(XDmaPs *InstPtr, unsigned Channel, XDmaPsDoneHandler DoneHandler, void *CallbackRef)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_SetDoneHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"> <em>Channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="xdmaps_8h.html#ad59232da2016e1a60744cc6e11a04a98">XDmaPsDoneHandler</a> </td>
|
|
<td class="paramname"> <em>DoneHandler</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>CallbackRef</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Set the done handler for a channel.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Channel</em> </td><td>is the channel number. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>DoneHandler</em> </td><td>is the done interrupt handler. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CallbackRef</em> </td><td>is the callback reference data.</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="acda5c5523ed24451a7efacc7b9257fa3"></a><!-- doxytag: member="xdmaps.c::XDmaPs_SetFaultHandler" ref="acda5c5523ed24451a7efacc7b9257fa3" args="(XDmaPs *InstPtr, XDmaPsFaultHandler FaultHandler, void *CallbackRef)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_SetFaultHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="xdmaps_8h.html#a5dba8cc7cd39c53eed1dabac803ce74f">XDmaPsFaultHandler</a> </td>
|
|
<td class="paramname"> <em>FaultHandler</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>CallbackRef</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Set the fault handler for a channel.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is the DMA instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>FaultHandler</em> </td><td>is the fault interrupt handler. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CallbackRef</em> </td><td>is the callback reference data.</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="a3691ba115c788c4f68a05cf05c486eeb"></a><!-- doxytag: member="xdmaps.c::XDmaPs_Start" ref="a3691ba115c788c4f68a05cf05c486eeb" args="(XDmaPs *InstPtr, unsigned int Channel, XDmaPs_Cmd *Cmd, int HoldDmaProg)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XDmaPs_Start </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps.html">XDmaPs</a> * </td>
|
|
<td class="paramname"> <em>InstPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>Channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> * </td>
|
|
<td class="paramname"> <em>Cmd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>HoldDmaProg</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Start a DMA command. The command can only be invoked when the channel is idle. The driver takes the command, generates DMA program if needed, then pass the program to DMAC to execute.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstPtr</em> </td><td>is then DMA instance. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Channel</em> </td><td>is the DMA channel number. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Cmd</em> </td><td>is the DMA command. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>HoldDmaProg</em> </td><td>is tag indicating whether the driver can release the allocated DMA buffer or not. If a user wants to examine the generated DMA program, the flag should be set to 1. After the DMA program is finished, a user needs to explicity free the buffer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS on success</li>
|
|
<li>XST_DEVICE_BUSY if DMA is busy</li>
|
|
<li>XST_FAILURE on other failures</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afa935ca1aca9b232b0d6c1b03cb50cc7"></a><!-- doxytag: member="xdmaps.c::XDmaPs_ToBurstSizeBits" ref="afa935ca1aca9b232b0d6c1b03cb50cc7" args="(unsigned BurstSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE unsigned XDmaPs_ToBurstSizeBits </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"> <em>BurstSize</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Conversion function from the burst size to the bit encoding of the CCR</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>BurstSize</em> </td><td>is the burst size. It's the data width. In terms of bytes, it could be 1, 2, 4, 8, 16, 32, 64, or 128. It must be no larger than the bus width. (We are using DMA assembly syntax.)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a68a8d4fbf7cf6154ad2c58df0479d329"></a><!-- doxytag: member="xdmaps.c::XDmaPs_ToCCRValue" ref="a68a8d4fbf7cf6154ad2c58df0479d329" args="(XDmaPs_ChanCtrl *ChanCtrl)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u32 XDmaPs_ToCCRValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_dma_ps___chan_ctrl.html">XDmaPs_ChanCtrl</a> * </td>
|
|
<td class="paramname"> <em>ChanCtrl</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Conversion function from PL330 bus transfer descriptors to CCR value. All the values passed to the functions are in terms of assembly languages, not in terms of the register bit encoding.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>ChanCtrl</em> </td><td>is the Instance of <a class="el" href="struct_x_dma_ps___chan_ctrl.html">XDmaPs_ChanCtrl</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The 32-bit CCR value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae109c6697d070147c066e38658372416"></a><!-- doxytag: member="xdmaps.c::XDmaPs_ToEndianSwapSizeBits" ref="ae109c6697d070147c066e38658372416" args="(unsigned int EndianSwapSize)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">INLINE unsigned XDmaPs_ToEndianSwapSizeBits </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>EndianSwapSize</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Conversion function from the endian swap size to the bit encoding of the CCR</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>EndianSwapSize</em> </td><td>is the endian swap size, in terms of bits, it could be 8, 16, 32, 64, or 128(We are using DMA assembly syntax)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The endian swap size bit encoding for the CCR.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p class="Copyright">
|
|
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
|
|
</p>
|
|
</body>
|
|
</html>
|