| /****************************************************************************** |
| * |
| * Copyright (C) 2010 - 2015 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 xemacps_bdring.h |
| * @addtogroup emacps_v3_1 |
| * @{ |
| * |
| * The Xiline EmacPs Buffer Descriptor ring driver. This is part of EmacPs |
| * DMA functionalities. |
| * |
| * <pre> |
| * MODIFICATION HISTORY: |
| * |
| * Ver Who Date Changes |
| * ----- ---- -------- ------------------------------------------------------- |
| * 1.00a wsy 01/10/10 First release |
| * 2.1 srt 07/15/14 Add support for Zynq Ultrascale Mp architecture. |
| * 3.0 kvn 02/13/15 Modified code for MISRA-C:2012 compliance. |
| * |
| * </pre> |
| * |
| ******************************************************************************/ |
| |
| #ifndef XEMACPS_BDRING_H /* prevent curcular inclusions */ |
| #define XEMACPS_BDRING_H /* by using protection macros */ |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| |
| /**************************** Type Definitions *******************************/ |
| |
| /** This is an internal structure used to maintain the DMA list */ |
| typedef struct { |
| UINTPTR PhysBaseAddr;/**< Physical address of 1st BD in list */ |
| UINTPTR BaseBdAddr; /**< Virtual address of 1st BD in list */ |
| UINTPTR HighBdAddr; /**< Virtual address of last BD in the list */ |
| u32 Length; /**< Total size of ring in bytes */ |
| u32 RunState; /**< Flag to indicate DMA is started */ |
| u32 Separation; /**< Number of bytes between the starting address |
| of adjacent BDs */ |
| XEmacPs_Bd *FreeHead; |
| /**< First BD in the free group */ |
| XEmacPs_Bd *PreHead;/**< First BD in the pre-work group */ |
| XEmacPs_Bd *HwHead; /**< First BD in the work group */ |
| XEmacPs_Bd *HwTail; /**< Last BD in the work group */ |
| XEmacPs_Bd *PostHead; |
| /**< First BD in the post-work group */ |
| XEmacPs_Bd *BdaRestart; |
| /**< BDA to load when channel is started */ |
| |
| u32 HwCnt; /**< Number of BDs in work group */ |
| u32 PreCnt; /**< Number of BDs in pre-work group */ |
| u32 FreeCnt; /**< Number of allocatable BDs in the free group */ |
| u32 PostCnt; /**< Number of BDs in post-work group */ |
| u32 AllCnt; /**< Total Number of BDs for channel */ |
| } XEmacPs_BdRing; |
| |
| |
| /***************** Macros (Inline Functions) Definitions *********************/ |
| |
| /*****************************************************************************/ |
| /** |
| * Use this macro at initialization time to determine how many BDs will fit |
| * in a BD list within the given memory constraints. |
| * |
| * The results of this macro can be provided to XEmacPs_BdRingCreate(). |
| * |
| * @param Alignment specifies what byte alignment the BDs must fall on and |
| * must be a power of 2 to get an accurate calculation (32, 64, 128,...) |
| * @param Bytes is the number of bytes to be used to store BDs. |
| * |
| * @return Number of BDs that can fit in the given memory area |
| * |
| * @note |
| * C-style signature: |
| * u32 XEmacPs_BdRingCntCalc(u32 Alignment, u32 Bytes) |
| * |
| ******************************************************************************/ |
| #define XEmacPs_BdRingCntCalc(Alignment, Bytes) \ |
| (u32)((Bytes) / (sizeof(XEmacPs_Bd))) |
| |
| /*****************************************************************************/ |
| /** |
| * Use this macro at initialization time to determine how many bytes of memory |
| * is required to contain a given number of BDs at a given alignment. |
| * |
| * @param Alignment specifies what byte alignment the BDs must fall on. This |
| * parameter must be a power of 2 to get an accurate calculation (32, 64, |
| * 128,...) |
| * @param NumBd is the number of BDs to calculate memory size requirements for |
| * |
| * @return The number of bytes of memory required to create a BD list with the |
| * given memory constraints. |
| * |
| * @note |
| * C-style signature: |
| * u32 XEmacPs_BdRingMemCalc(u32 Alignment, u32 NumBd) |
| * |
| ******************************************************************************/ |
| #define XEmacPs_BdRingMemCalc(Alignment, NumBd) \ |
| (u32)(sizeof(XEmacPs_Bd) * (NumBd)) |
| |
| /****************************************************************************/ |
| /** |
| * Return the total number of BDs allocated by this channel with |
| * XEmacPs_BdRingCreate(). |
| * |
| * @param RingPtr is the DMA channel to operate on. |
| * |
| * @return The total number of BDs allocated for this channel. |
| * |
| * @note |
| * C-style signature: |
| * u32 XEmacPs_BdRingGetCnt(XEmacPs_BdRing* RingPtr) |
| * |
| *****************************************************************************/ |
| #define XEmacPs_BdRingGetCnt(RingPtr) ((RingPtr)->AllCnt) |
| |
| /****************************************************************************/ |
| /** |
| * Return the number of BDs allocatable with XEmacPs_BdRingAlloc() for pre- |
| * processing. |
| * |
| * @param RingPtr is the DMA channel to operate on. |
| * |
| * @return The number of BDs currently allocatable. |
| * |
| * @note |
| * C-style signature: |
| * u32 XEmacPs_BdRingGetFreeCnt(XEmacPs_BdRing* RingPtr) |
| * |
| *****************************************************************************/ |
| #define XEmacPs_BdRingGetFreeCnt(RingPtr) ((RingPtr)->FreeCnt) |
| |
| /****************************************************************************/ |
| /** |
| * Return the next BD from BdPtr in a list. |
| * |
| * @param RingPtr is the DMA channel to operate on. |
| * @param BdPtr is the BD to operate on. |
| * |
| * @return The next BD in the list relative to the BdPtr parameter. |
| * |
| * @note |
| * C-style signature: |
| * XEmacPs_Bd *XEmacPs_BdRingNext(XEmacPs_BdRing* RingPtr, |
| * XEmacPs_Bd *BdPtr) |
| * |
| *****************************************************************************/ |
| #define XEmacPs_BdRingNext(RingPtr, BdPtr) \ |
| (((UINTPTR)((void *)(BdPtr)) >= (RingPtr)->HighBdAddr) ? \ |
| (XEmacPs_Bd*)((void*)(RingPtr)->BaseBdAddr) : \ |
| (XEmacPs_Bd*)((UINTPTR)((void *)(BdPtr)) + (RingPtr)->Separation)) |
| |
| /****************************************************************************/ |
| /** |
| * Return the previous BD from BdPtr in the list. |
| * |
| * @param RingPtr is the DMA channel to operate on. |
| * @param BdPtr is the BD to operate on |
| * |
| * @return The previous BD in the list relative to the BdPtr parameter. |
| * |
| * @note |
| * C-style signature: |
| * XEmacPs_Bd *XEmacPs_BdRingPrev(XEmacPs_BdRing* RingPtr, |
| * XEmacPs_Bd *BdPtr) |
| * |
| *****************************************************************************/ |
| #define XEmacPs_BdRingPrev(RingPtr, BdPtr) \ |
| (((UINTPTR)(BdPtr) <= (RingPtr)->BaseBdAddr) ? \ |
| (XEmacPs_Bd*)(RingPtr)->HighBdAddr : \ |
| (XEmacPs_Bd*)((UINTPTR)(BdPtr) - (RingPtr)->Separation)) |
| |
| /************************** Function Prototypes ******************************/ |
| |
| /* |
| * Scatter gather DMA related functions in xemacps_bdring.c |
| */ |
| LONG XEmacPs_BdRingCreate(XEmacPs_BdRing * RingPtr, UINTPTR PhysAddr, |
| UINTPTR VirtAddr, u32 Alignment, u32 BdCount); |
| LONG XEmacPs_BdRingClone(XEmacPs_BdRing * RingPtr, XEmacPs_Bd * SrcBdPtr, |
| u8 Direction); |
| LONG XEmacPs_BdRingAlloc(XEmacPs_BdRing * RingPtr, u32 NumBd, |
| XEmacPs_Bd ** BdSetPtr); |
| LONG XEmacPs_BdRingUnAlloc(XEmacPs_BdRing * RingPtr, u32 NumBd, |
| XEmacPs_Bd * BdSetPtr); |
| LONG XEmacPs_BdRingToHw(XEmacPs_BdRing * RingPtr, u32 NumBd, |
| XEmacPs_Bd * BdSetPtr); |
| LONG XEmacPs_BdRingFree(XEmacPs_BdRing * RingPtr, u32 NumBd, |
| XEmacPs_Bd * BdSetPtr); |
| u32 XEmacPs_BdRingFromHwTx(XEmacPs_BdRing * RingPtr, u32 BdLimit, |
| XEmacPs_Bd ** BdSetPtr); |
| u32 XEmacPs_BdRingFromHwRx(XEmacPs_BdRing * RingPtr, u32 BdLimit, |
| XEmacPs_Bd ** BdSetPtr); |
| LONG XEmacPs_BdRingCheck(XEmacPs_BdRing * RingPtr, u8 Direction); |
| |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| |
| #endif /* end of protection macros */ |
| /** @} */ |