git.sur5r.net Git - freertos/blob

   1 /* $Id: xemacps_bdring.h,v 1.1.2.1 2011/01/20 03:39:02 sadanan Exp $ */
   2 /******************************************************************************
   3 *
   4 * Copyright (C) 2010 - 2014 Xilinx, Inc.  All rights reserved.
   5 *
   6 * Permission is hereby granted, free of charge, to any person obtaining a copy
   7 * of this software and associated documentation files (the "Software"), to deal
   8 * in the Software without restriction, including without limitation the rights
   9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 * copies of the Software, and to permit persons to whom the Software is
  11 * furnished to do so, subject to the following conditions:
  12 *
  13 * The above copyright notice and this permission notice shall be included in
  14 * all copies or substantial portions of the Software.
  15 *
  16 * Use of the Software is limited solely to applications:
  17 * (a) running on a Xilinx device, or
  18 * (b) that interact with a Xilinx device through a bus or interconnect.
  19 *
  20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  23 * XILINX  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  24 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  25 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26 * SOFTWARE.
  27 *
  28 * Except as contained in this notice, the name of the Xilinx shall not be used
  29 * in advertising or otherwise to promote the sale, use or other dealings in
  30 * this Software without prior written authorization from Xilinx.
  31 *
  32 ******************************************************************************/
  33 /*****************************************************************************/
  34 /**
  35 *
  36 * @file xemacps_bdring.h
  37 * @addtogroup emacps_v2_0
  38 * @{
  39 *
  40 * The Xiline EmacPs Buffer Descriptor ring driver. This is part of EmacPs
  41 * DMA functionalities.
  42 *
  43 * <pre>
  44 * MODIFICATION HISTORY:
  45 *
  46 * Ver   Who  Date     Changes
  47 * ----- ---- -------- -------------------------------------------------------
  48 * 1.00a wsy  01/10/10 First release
  49 * </pre>
  50 *
  51 ******************************************************************************/
  52
  53 #ifndef XEMACPS_BDRING_H        /* prevent curcular inclusions */
  54 #define XEMACPS_BDRING_H        /* by using protection macros */
  55
  56 #ifdef __cplusplus
  57 extern "C" {
  58 #endif
  59
  60
  61 /**************************** Type Definitions *******************************/
  62
  63 /** This is an internal structure used to maintain the DMA list */
  64 typedef struct {
  65         u32 PhysBaseAddr;/**< Physical address of 1st BD in list */
  66         u32 BaseBdAddr;  /**< Virtual address of 1st BD in list */
  67         u32 HighBdAddr;  /**< Virtual address of last BD in the list */
  68         u32 Length;      /**< Total size of ring in bytes */
  69         u32 RunState;    /**< Flag to indicate DMA is started */
  70         u32 Separation;  /**< Number of bytes between the starting address
  71                                   of adjacent BDs */
  72         XEmacPs_Bd *FreeHead;
  73                              /**< First BD in the free group */
  74         XEmacPs_Bd *PreHead;/**< First BD in the pre-work group */
  75         XEmacPs_Bd *HwHead; /**< First BD in the work group */
  76         XEmacPs_Bd *HwTail; /**< Last BD in the work group */
  77         XEmacPs_Bd *PostHead;
  78                              /**< First BD in the post-work group */
  79         XEmacPs_Bd *BdaRestart;
  80                              /**< BDA to load when channel is started */
  81         unsigned HwCnt;      /**< Number of BDs in work group */
  82         unsigned PreCnt;     /**< Number of BDs in pre-work group */
  83         unsigned FreeCnt;    /**< Number of allocatable BDs in the free group */
  84         unsigned PostCnt;    /**< Number of BDs in post-work group */
  85         unsigned AllCnt;     /**< Total Number of BDs for channel */
  86 } XEmacPs_BdRing;
  87
  88
  89 /***************** Macros (Inline Functions) Definitions *********************/
  90
  91 /*****************************************************************************/
  92 /**
  93 * Use this macro at initialization time to determine how many BDs will fit
  94 * in a BD list within the given memory constraints.
  95 *
  96 * The results of this macro can be provided to XEmacPs_BdRingCreate().
  97 *
  98 * @param Alignment specifies what byte alignment the BDs must fall on and
  99 *        must be a power of 2 to get an accurate calculation (32, 64, 128,...)
 100 * @param Bytes is the number of bytes to be used to store BDs.
 101 *
 102 * @return Number of BDs that can fit in the given memory area
 103 *
 104 * @note
 105 * C-style signature:
 106 *    u32 XEmacPs_BdRingCntCalc(u32 Alignment, u32 Bytes)
 107 *
 108 ******************************************************************************/
 109 #define XEmacPs_BdRingCntCalc(Alignment, Bytes)                    \
 110     (u32)((Bytes) / ((sizeof(XEmacPs_Bd) + ((Alignment)-1)) &   \
 111     ~((Alignment)-1)))
 112
 113 /*****************************************************************************/
 114 /**
 115 * Use this macro at initialization time to determine how many bytes of memory
 116 * is required to contain a given number of BDs at a given alignment.
 117 *
 118 * @param Alignment specifies what byte alignment the BDs must fall on. This
 119 *        parameter must be a power of 2 to get an accurate calculation (32, 64,
 120 *        128,...)
 121 * @param NumBd is the number of BDs to calculate memory size requirements for
 122 *
 123 * @return The number of bytes of memory required to create a BD list with the
 124 *         given memory constraints.
 125 *
 126 * @note
 127 * C-style signature:
 128 *    u32 XEmacPs_BdRingMemCalc(u32 Alignment, u32 NumBd)
 129 *
 130 ******************************************************************************/
 131 #define XEmacPs_BdRingMemCalc(Alignment, NumBd)                    \
 132     (u32)((sizeof(XEmacPs_Bd) + ((Alignment)-1)) &              \
 133     ~((Alignment)-1)) * (NumBd)
 134
 135 /****************************************************************************/
 136 /**
 137 * Return the total number of BDs allocated by this channel with
 138 * XEmacPs_BdRingCreate().
 139 *
 140 * @param  RingPtr is the DMA channel to operate on.
 141 *
 142 * @return The total number of BDs allocated for this channel.
 143 *
 144 * @note
 145 * C-style signature:
 146 *    u32 XEmacPs_BdRingGetCnt(XEmacPs_BdRing* RingPtr)
 147 *
 148 *****************************************************************************/
 149 #define XEmacPs_BdRingGetCnt(RingPtr) ((RingPtr)->AllCnt)
 150
 151 /****************************************************************************/
 152 /**
 153 * Return the number of BDs allocatable with XEmacPs_BdRingAlloc() for pre-
 154 * processing.
 155 *
 156 * @param  RingPtr is the DMA channel to operate on.
 157 *
 158 * @return The number of BDs currently allocatable.
 159 *
 160 * @note
 161 * C-style signature:
 162 *    u32 XEmacPs_BdRingGetFreeCnt(XEmacPs_BdRing* RingPtr)
 163 *
 164 *****************************************************************************/
 165 #define XEmacPs_BdRingGetFreeCnt(RingPtr)   ((RingPtr)->FreeCnt)
 166
 167 /****************************************************************************/
 168 /**
 169 * Return the next BD from BdPtr in a list.
 170 *
 171 * @param  RingPtr is the DMA channel to operate on.
 172 * @param  BdPtr is the BD to operate on.
 173 *
 174 * @return The next BD in the list relative to the BdPtr parameter.
 175 *
 176 * @note
 177 * C-style signature:
 178 *    XEmacPs_Bd *XEmacPs_BdRingNext(XEmacPs_BdRing* RingPtr,
 179 *                                      XEmacPs_Bd *BdPtr)
 180 *
 181 *****************************************************************************/
 182 #define XEmacPs_BdRingNext(RingPtr, BdPtr)                           \
 183     (((u32)(BdPtr) >= (RingPtr)->HighBdAddr) ?                     \
 184     (XEmacPs_Bd*)(RingPtr)->BaseBdAddr :                              \
 185     (XEmacPs_Bd*)((u32)(BdPtr) + (RingPtr)->Separation))
 186
 187 /****************************************************************************/
 188 /**
 189 * Return the previous BD from BdPtr in the list.
 190 *
 191 * @param  RingPtr is the DMA channel to operate on.
 192 * @param  BdPtr is the BD to operate on
 193 *
 194 * @return The previous BD in the list relative to the BdPtr parameter.
 195 *
 196 * @note
 197 * C-style signature:
 198 *    XEmacPs_Bd *XEmacPs_BdRingPrev(XEmacPs_BdRing* RingPtr,
 199 *                                      XEmacPs_Bd *BdPtr)
 200 *
 201 *****************************************************************************/
 202 #define XEmacPs_BdRingPrev(RingPtr, BdPtr)                           \
 203     (((u32)(BdPtr) <= (RingPtr)->BaseBdAddr) ?                     \
 204     (XEmacPs_Bd*)(RingPtr)->HighBdAddr :                              \
 205     (XEmacPs_Bd*)((u32)(BdPtr) - (RingPtr)->Separation))
 206
 207 /************************** Function Prototypes ******************************/
 208
 209 /*
 210  * Scatter gather DMA related functions in xemacps_bdring.c
 211  */
 212 int XEmacPs_BdRingCreate(XEmacPs_BdRing * RingPtr, u32 PhysAddr,
 213                           u32 VirtAddr, u32 Alignment, unsigned BdCount);
 214 int XEmacPs_BdRingClone(XEmacPs_BdRing * RingPtr, XEmacPs_Bd * SrcBdPtr,
 215                          u8 Direction);
 216 int XEmacPs_BdRingAlloc(XEmacPs_BdRing * RingPtr, unsigned NumBd,
 217                          XEmacPs_Bd ** BdSetPtr);
 218 int XEmacPs_BdRingUnAlloc(XEmacPs_BdRing * RingPtr, unsigned NumBd,
 219                            XEmacPs_Bd * BdSetPtr);
 220 int XEmacPs_BdRingToHw(XEmacPs_BdRing * RingPtr, unsigned NumBd,
 221                         XEmacPs_Bd * BdSetPtr);
 222 int XEmacPs_BdRingFree(XEmacPs_BdRing * RingPtr, unsigned NumBd,
 223                         XEmacPs_Bd * BdSetPtr);
 224 unsigned XEmacPs_BdRingFromHwTx(XEmacPs_BdRing * RingPtr, unsigned BdLimit,
 225                                  XEmacPs_Bd ** BdSetPtr);
 226 unsigned XEmacPs_BdRingFromHwRx(XEmacPs_BdRing * RingPtr, unsigned BdLimit,
 227                                  XEmacPs_Bd ** BdSetPtr);
 228 int XEmacPs_BdRingCheck(XEmacPs_BdRing * RingPtr, u8 Direction);
 229
 230 #ifdef __cplusplus
 231 }
 232 #endif
 233
 234
 235 #endif /* end of protection macros */
 236 /** @} */