| /****************************************************************************** |
| * |
| * Copyright (C) 2009 - 2016 Xilinx, Inc. All rights reserved. |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a copy |
| * of this software and associated documentation files (the "Software"), to deal |
| * in the Software without restriction, including without limitation the rights |
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| * copies of the Software, and to permit persons to whom the Software is |
| * furnished to do so, subject to the following conditions: |
| * |
| * The above copyright notice and this permission notice shall be included in |
| * all copies or substantial portions of the Software. |
| * |
| * Use of the Software is limited solely to applications: |
| * (a) running on a Xilinx device, or |
| * (b) that interact with a Xilinx device through a bus or interconnect. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| * XILINX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
| * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF |
| * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| * SOFTWARE. |
| * |
| * Except as contained in this notice, the name of the Xilinx shall not be used |
| * in advertising or otherwise to promote the sale, use or other dealings in |
| * this Software without prior written authorization from Xilinx. |
| * |
| ******************************************************************************/ |
| /****************************************************************************/ |
| /** |
| * |
| * @file xdmaps.h |
| * @addtogroup dmaps_v2_3 |
| * @{ |
| * @details |
| * |
| * |
| * <pre> |
| * MODIFICATION HISTORY: |
| * |
| * Ver Who Date Changes |
| * ----- ------ -------- ---------------------------------------------- |
| * 1.00 hbm 08/19/10 First Release |
| * 1.01a nm 12/20/12 Added definition XDMAPS_CHANNELS_PER_DEV which specifies |
| * the maximum number of channels. |
| * Replaced the usage of XPAR_XDMAPS_CHANNELS_PER_DEV |
| * with XDMAPS_CHANNELS_PER_DEV defined in xdmaps_hw.h. |
| * Added the tcl file to automatically generate the |
| * xparameters.h |
| * 1.02a sg 05/16/12 Made changes for doxygen and moved some function |
| * header from the xdmaps.h file to xdmaps.c file |
| * Other cleanup for coding guidelines and CR 657109 |
| * and CR 657898 |
| * The xdmaps_example_no_intr.c example is removed |
| * as it is using interrupts and is similar to |
| * the interrupt example - CR 652477 |
| * 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. |
| * 2.0 adk 10/12/13 Updated as per the New Tcl API's |
| * 2.01 kpc 08/23/14 Fixed the IAR compiler reported errors |
| * 2.2 mus 08/12/16 Declared all inline functions in xdmaps.c as extern, to avoid |
| * linker error for IAR compiler |
| * 2.3 ms 01/23/17 Modified xil_printf statement in main function for all |
| * examples to ensure that "Successfully ran" and "Failed" |
| * strings are available in all examples. This is a fix |
| * for CR-965028. |
| * ms 03/17/17 Added readme.txt file in examples folder for doxygen |
| * generation. |
| * </pre> |
| * |
| *****************************************************************************/ |
| |
| #ifndef XDMAPS_H /* prevent circular inclusions */ |
| #define XDMAPS_H /* by using protection macros */ |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /***************************** Include Files ********************************/ |
| |
| #include "xparameters.h" |
| #include "xil_types.h" |
| #include "xil_assert.h" |
| #include "xstatus.h" |
| |
| #include "xdmaps_hw.h" |
| |
| /************************** Constant Definitions ****************************/ |
| |
| /**************************** Type Definitions ******************************/ |
| |
| /** |
| * This typedef contains configuration information for the device. |
| */ |
| typedef struct { |
| u16 DeviceId; /**< Unique ID of device */ |
| u32 BaseAddress; /**< Base address of device (IPIF) */ |
| } XDmaPs_Config; |
| |
| |
| /** DMA channle control structure. It's for AXI bus transaction. |
| * This struct will be translated into a 32-bit channel control register value. |
| */ |
| typedef struct { |
| unsigned int EndianSwapSize; /**< Endian swap size. */ |
| unsigned int DstCacheCtrl; /**< Destination cache control */ |
| unsigned int DstProtCtrl; /**< Destination protection control */ |
| unsigned int DstBurstLen; /**< Destination burst length */ |
| unsigned int DstBurstSize; /**< Destination burst size */ |
| unsigned int DstInc; /**< Destination incrementing or fixed |
| * address */ |
| unsigned int SrcCacheCtrl; /**< Source cache control */ |
| unsigned int SrcProtCtrl; /**< Source protection control */ |
| unsigned int SrcBurstLen; /**< Source burst length */ |
| unsigned int SrcBurstSize; /**< Source burst size */ |
| unsigned int SrcInc; /**< Source incrementing or fixed |
| * address */ |
| } XDmaPs_ChanCtrl; |
| |
| /** DMA block descriptor stucture. |
| */ |
| typedef struct { |
| u32 SrcAddr; /**< Source starting address */ |
| u32 DstAddr; /**< Destination starting address */ |
| unsigned int Length; /**< Number of bytes for the block */ |
| } XDmaPs_BD; |
| |
| /** |
| * A DMA command consisits of a channel control struct, a block descriptor, |
| * a user defined program, a pointer pointing to generated DMA program, and |
| * execution result. |
| * |
| */ |
| typedef struct { |
| XDmaPs_ChanCtrl ChanCtrl; /**< Channel Control Struct */ |
| XDmaPs_BD BD; /**< Together with SgLength field, |
| * it's a scatter-gather list. |
| */ |
| void *UserDmaProg; /**< If user wants the driver to |
| * execute their own DMA program, |
| * this field points to the DMA |
| * program. |
| */ |
| int UserDmaProgLength; /**< The length of user defined |
| * DMA program. |
| */ |
| |
| void *GeneratedDmaProg; /**< The DMA program genreated |
| * by the driver. This field will be |
| * set if a user invokes the DMA |
| * program generation function. Or |
| * the DMA command is finished and |
| * a user informs the driver not to |
| * release the program buffer. |
| * This field has two purposes, one |
| * is to ask the driver to generate |
| * a DMA program while the DMAC is |
| * performaning DMA transactions. The |
| * other purpose is to debug the |
| * driver. |
| */ |
| int GeneratedDmaProgLength; /**< The length of the DMA program |
| * generated by the driver |
| */ |
| int DmaStatus; /**< 0 on success, otherwise error code |
| */ |
| u32 ChanFaultType; /**< Channel fault type in case of fault |
| */ |
| u32 ChanFaultPCAddr; /**< Channel fault PC address |
| */ |
| } XDmaPs_Cmd; |
| |
| /** |
| * It's the done handler a user can set for a channel |
| */ |
| typedef void (*XDmaPsDoneHandler) (unsigned int Channel, |
| XDmaPs_Cmd *DmaCmd, |
| void *CallbackRef); |
| |
| /** |
| * It's the fault handler a user can set for a channel |
| */ |
| typedef void (*XDmaPsFaultHandler) (unsigned int Channel, |
| XDmaPs_Cmd *DmaCmd, |
| void *CallbackRef); |
| |
| #define XDMAPS_MAX_CHAN_BUFS 2 |
| #define XDMAPS_CHAN_BUF_LEN 128 |
| |
| /** |
| * The XDmaPs_ProgBuf is the struct for a DMA program buffer. |
| */ |
| typedef struct { |
| char Buf[XDMAPS_CHAN_BUF_LEN]; /**< The actual buffer the holds the |
| * content */ |
| unsigned Len; /**< The actual length of the DMA |
| * program in bytes. */ |
| int Allocated; /**< A tag indicating whether the |
| * buffer is allocated or not */ |
| } XDmaPs_ProgBuf; |
| |
| /** |
| * The XDmaPs_ChannelData is a struct to book keep individual channel of |
| * the DMAC. |
| */ |
| typedef struct { |
| unsigned DevId; /**< Device id indicating which DMAC */ |
| unsigned ChanId; /**< Channel number of the DMAC */ |
| XDmaPs_ProgBuf ProgBufPool[XDMAPS_MAX_CHAN_BUFS]; /**< A pool of |
| program buffers*/ |
| XDmaPsDoneHandler DoneHandler; /**< Done interrupt handler */ |
| void *DoneRef; /**< Done interrupt callback data */ |
| XDmaPs_Cmd *DmaCmdToHw; /**< DMA command being executed */ |
| XDmaPs_Cmd *DmaCmdFromHw; /**< DMA command that is finished. |
| * This field is for debugging purpose |
| */ |
| int HoldDmaProg; /**< A tag indicating whether to hold the |
| * DMA program after the DMA is done. |
| */ |
| |
| } XDmaPs_ChannelData; |
| |
| /** |
| * The XDmaPs driver instance data structure. A pointer to an instance data |
| * structure is passed around by functions to refer to a specific driver |
| * instance. |
| */ |
| typedef struct { |
| XDmaPs_Config Config; /**< Configuration data structure */ |
| int IsReady; /**< Device is Ready */ |
| int CacheLength; /**< icache length */ |
| XDmaPsFaultHandler FaultHandler; /**< fault interrupt handler */ |
| void *FaultRef; /**< fault call back data */ |
| XDmaPs_ChannelData Chans[XDMAPS_CHANNELS_PER_DEV]; |
| /**< |
| * channel data |
| */ |
| } XDmaPs; |
| |
| /* |
| * Functions implemented in xdmaps.c |
| */ |
| int XDmaPs_CfgInitialize(XDmaPs *InstPtr, |
| XDmaPs_Config *Config, |
| u32 EffectiveAddr); |
| |
| int XDmaPs_Start(XDmaPs *InstPtr, unsigned int Channel, |
| XDmaPs_Cmd *Cmd, |
| int HoldDmaProg); |
| |
| int XDmaPs_IsActive(XDmaPs *InstPtr, unsigned int Channel); |
| int XDmaPs_GenDmaProg(XDmaPs *InstPtr, unsigned int Channel, |
| XDmaPs_Cmd *Cmd); |
| int XDmaPs_FreeDmaProg(XDmaPs *InstPtr, unsigned int Channel, |
| XDmaPs_Cmd *Cmd); |
| void XDmaPs_Print_DmaProg(XDmaPs_Cmd *Cmd); |
| |
| |
| int XDmaPs_ResetManager(XDmaPs *InstPtr); |
| int XDmaPs_ResetChannel(XDmaPs *InstPtr, unsigned int Channel); |
| |
| |
| int XDmaPs_SetDoneHandler(XDmaPs *InstPtr, |
| unsigned Channel, |
| XDmaPsDoneHandler DoneHandler, |
| void *CallbackRef); |
| |
| int XDmaPs_SetFaultHandler(XDmaPs *InstPtr, |
| XDmaPsFaultHandler FaultHandler, |
| void *CallbackRef); |
| |
| void XDmaPs_Print_DmaProg(XDmaPs_Cmd *Cmd); |
| |
| /** |
| * To avoid linking error,Declare all inline functions as extern for |
| * IAR compiler |
| */ |
| #ifdef __ICCARM__ |
| extern INLINE int XDmaPs_Instr_DMAEND(char *DmaProg); |
| extern INLINE void XDmaPs_Memcpy4(char *Dst, char *Src); |
| extern INLINE int XDmaPs_Instr_DMAGO(char *DmaProg, unsigned int Cn, |
| u32 Imm, unsigned int Ns); |
| extern INLINE int XDmaPs_Instr_DMALD(char *DmaProg); |
| extern INLINE int XDmaPs_Instr_DMALP(char *DmaProg, unsigned Lc, |
| unsigned LoopIterations); |
| extern INLINE int XDmaPs_Instr_DMALPEND(char *DmaProg, char *BodyStart, unsigned Lc); |
| extern INLINE int XDmaPs_Instr_DMAMOV(char *DmaProg, unsigned Rd, u32 Imm); |
| extern INLINE int XDmaPs_Instr_DMANOP(char *DmaProg); |
| extern INLINE int XDmaPs_Instr_DMARMB(char *DmaProg); |
| extern INLINE int XDmaPs_Instr_DMASEV(char *DmaProg, unsigned int EventNumber); |
| extern INLINE int XDmaPs_Instr_DMAST(char *DmaProg); |
| extern INLINE int XDmaPs_Instr_DMAWMB(char *DmaProg); |
| extern INLINE unsigned XDmaPs_ToEndianSwapSizeBits(unsigned int EndianSwapSize); |
| extern INLINE unsigned XDmaPs_ToBurstSizeBits(unsigned BurstSize); |
| #endif |
| |
| /** |
| * Driver done interrupt service routines for the channels. |
| * We need this done ISR mainly because the driver needs to release the |
| * DMA program buffer. This is the one that connects the GIC |
| */ |
| void XDmaPs_DoneISR_0(XDmaPs *InstPtr); |
| void XDmaPs_DoneISR_1(XDmaPs *InstPtr); |
| void XDmaPs_DoneISR_2(XDmaPs *InstPtr); |
| void XDmaPs_DoneISR_3(XDmaPs *InstPtr); |
| void XDmaPs_DoneISR_4(XDmaPs *InstPtr); |
| void XDmaPs_DoneISR_5(XDmaPs *InstPtr); |
| void XDmaPs_DoneISR_6(XDmaPs *InstPtr); |
| void XDmaPs_DoneISR_7(XDmaPs *InstPtr); |
| |
| /** |
| * Driver fault interrupt service routine |
| */ |
| void XDmaPs_FaultISR(XDmaPs *InstPtr); |
| |
| |
| /* |
| * Static loopup function implemented in xdmaps_sinit.c |
| */ |
| XDmaPs_Config *XDmaPs_LookupConfig(u16 DeviceId); |
| |
| |
| /* |
| * self-test functions in xdmaps_selftest.c |
| */ |
| int XDmaPs_SelfTest(XDmaPs *InstPtr); |
| |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* end of protection macro */ |
| /** @} */ |
