arch/mips/include/asm/mach-au1x00/au1xxx_dbdma.h

   1 /*
   2  *
   3  * BRIEF MODULE DESCRIPTION
   4  *      Include file for Alchemy Semiconductor's Au1550 Descriptor
   5  *      Based DMA Controller.
   6  *
   7  * Copyright 2004 Embedded Edge, LLC
   8  *      dan@embeddededge.com
   9  *
  10  *  This program is free software; you can redistribute  it and/or modify it
  11  *  under  the terms of  the GNU General  Public License as published by the
  12  *  Free Software Foundation;  either version 2 of the  License, or (at your
  13  *  option) any later version.
  14  *
  15  *  THIS  SOFTWARE  IS PROVIDED   ``AS  IS'' AND   ANY  EXPRESS OR IMPLIED
  16  *  WARRANTIES,   INCLUDING, BUT NOT  LIMITED  TO, THE IMPLIED WARRANTIES OF
  17  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  18  *  NO  EVENT  SHALL   THE AUTHOR  BE    LIABLE FOR ANY   DIRECT, INDIRECT,
  19  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  *  NOT LIMITED   TO, PROCUREMENT OF  SUBSTITUTE GOODS  OR SERVICES; LOSS OF
  21  *  USE, DATA,  OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  22  *  ANY THEORY OF LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY, OR TORT
  23  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  *  You should have received a copy of the  GNU General Public License along
  27  *  with this program; if not, write  to the Free Software Foundation, Inc.,
  28  *  675 Mass Ave, Cambridge, MA 02139, USA.
  29  */
  30
  31 /*
  32  * Specifics for the Au1xxx Descriptor-Based DMA Controller,
  33  * first seen in the AU1550 part.
  34  */
  35 #ifndef _AU1000_DBDMA_H_
  36 #define _AU1000_DBDMA_H_
  37
  38 #ifndef _LANGUAGE_ASSEMBLY
  39
  40 typedef volatile struct dbdma_global {
  41         u32     ddma_config;
  42         u32     ddma_intstat;
  43         u32     ddma_throttle;
  44         u32     ddma_inten;
  45 } dbdma_global_t;
  46
  47 /* General Configuration. */
  48 #define DDMA_CONFIG_AF          (1 << 2)
  49 #define DDMA_CONFIG_AH          (1 << 1)
  50 #define DDMA_CONFIG_AL          (1 << 0)
  51
  52 #define DDMA_THROTTLE_EN        (1 << 31)
  53
  54 /* The structure of a DMA Channel. */
  55 typedef volatile struct au1xxx_dma_channel {
  56         u32     ddma_cfg;       /* See below */
  57         u32     ddma_desptr;    /* 32-byte aligned pointer to descriptor */
  58         u32     ddma_statptr;   /* word aligned pointer to status word */
  59         u32     ddma_dbell;     /* A write activates channel operation */
  60         u32     ddma_irq;       /* If bit 0 set, interrupt pending */
  61         u32     ddma_stat;      /* See below */
  62         u32     ddma_bytecnt;   /* Byte count, valid only when chan idle */
  63         /* Remainder, up to the 256 byte boundary, is reserved. */
  64 } au1x_dma_chan_t;
  65
  66 #define DDMA_CFG_SED    (1 << 9)        /* source DMA level/edge detect */
  67 #define DDMA_CFG_SP     (1 << 8)        /* source DMA polarity */
  68 #define DDMA_CFG_DED    (1 << 7)        /* destination DMA level/edge detect */
  69 #define DDMA_CFG_DP     (1 << 6)        /* destination DMA polarity */
  70 #define DDMA_CFG_SYNC   (1 << 5)        /* Sync static bus controller */
  71 #define DDMA_CFG_PPR    (1 << 4)        /* PCI posted read/write control */
  72 #define DDMA_CFG_DFN    (1 << 3)        /* Descriptor fetch non-coherent */
  73 #define DDMA_CFG_SBE    (1 << 2)        /* Source big endian */
  74 #define DDMA_CFG_DBE    (1 << 1)        /* Destination big endian */
  75 #define DDMA_CFG_EN     (1 << 0)        /* Channel enable */
  76
  77 /*
  78  * Always set when descriptor processing done, regardless of
  79  * interrupt enable state.  Reflected in global intstat, don't
  80  * clear this until global intstat is read/used.
  81  */
  82 #define DDMA_IRQ_IN     (1 << 0)
  83
  84 #define DDMA_STAT_DB    (1 << 2)        /* Doorbell pushed */
  85 #define DDMA_STAT_V     (1 << 1)        /* Descriptor valid */
  86 #define DDMA_STAT_H     (1 << 0)        /* Channel Halted */
  87
  88 /*
  89  * "Standard" DDMA Descriptor.
  90  * Must be 32-byte aligned.
  91  */
  92 typedef volatile struct au1xxx_ddma_desc {
  93         u32     dscr_cmd0;              /* See below */
  94         u32     dscr_cmd1;              /* See below */
  95         u32     dscr_source0;           /* source phys address */
  96         u32     dscr_source1;           /* See below */
  97         u32     dscr_dest0;             /* Destination address */
  98         u32     dscr_dest1;             /* See below */
  99         u32     dscr_stat;              /* completion status */
 100         u32     dscr_nxtptr;            /* Next descriptor pointer (mostly) */
 101         /*
 102          * First 32 bytes are HW specific!!!
 103          * Lets have some SW data following -- make sure it's 32 bytes.
 104          */
 105         u32     sw_status;
 106         u32     sw_context;
 107         u32     sw_reserved[6];
 108 } au1x_ddma_desc_t;
 109
 110 #define DSCR_CMD0_V             (1 << 31)       /* Descriptor valid */
 111 #define DSCR_CMD0_MEM           (1 << 30)       /* mem-mem transfer */
 112 #define DSCR_CMD0_SID_MASK      (0x1f << 25)    /* Source ID */
 113 #define DSCR_CMD0_DID_MASK      (0x1f << 20)    /* Destination ID */
 114 #define DSCR_CMD0_SW_MASK       (0x3 << 18)     /* Source Width */
 115 #define DSCR_CMD0_DW_MASK       (0x3 << 16)     /* Destination Width */
 116 #define DSCR_CMD0_ARB           (0x1 << 15)     /* Set for Hi Pri */
 117 #define DSCR_CMD0_DT_MASK       (0x3 << 13)     /* Descriptor Type */
 118 #define DSCR_CMD0_SN            (0x1 << 12)     /* Source non-coherent */
 119 #define DSCR_CMD0_DN            (0x1 << 11)     /* Destination non-coherent */
 120 #define DSCR_CMD0_SM            (0x1 << 10)     /* Stride mode */
 121 #define DSCR_CMD0_IE            (0x1 << 8)      /* Interrupt Enable */
 122 #define DSCR_CMD0_SP            (0x1 << 4)      /* Status pointer select */
 123 #define DSCR_CMD0_CV            (0x1 << 2)      /* Clear Valid when done */
 124 #define DSCR_CMD0_ST_MASK       (0x3 << 0)      /* Status instruction */
 125
 126 #define SW_STATUS_INUSE         (1 << 0)
 127
 128 /* Command 0 device IDs. */
 129 #ifdef CONFIG_SOC_AU1550
 130 #define DSCR_CMD0_UART0_TX      0
 131 #define DSCR_CMD0_UART0_RX      1
 132 #define DSCR_CMD0_UART3_TX      2
 133 #define DSCR_CMD0_UART3_RX      3
 134 #define DSCR_CMD0_DMA_REQ0      4
 135 #define DSCR_CMD0_DMA_REQ1      5
 136 #define DSCR_CMD0_DMA_REQ2      6
 137 #define DSCR_CMD0_DMA_REQ3      7
 138 #define DSCR_CMD0_USBDEV_RX0    8
 139 #define DSCR_CMD0_USBDEV_TX0    9
 140 #define DSCR_CMD0_USBDEV_TX1    10
 141 #define DSCR_CMD0_USBDEV_TX2    11
 142 #define DSCR_CMD0_USBDEV_RX3    12
 143 #define DSCR_CMD0_USBDEV_RX4    13
 144 #define DSCR_CMD0_PSC0_TX       14
 145 #define DSCR_CMD0_PSC0_RX       15
 146 #define DSCR_CMD0_PSC1_TX       16
 147 #define DSCR_CMD0_PSC1_RX       17
 148 #define DSCR_CMD0_PSC2_TX       18
 149 #define DSCR_CMD0_PSC2_RX       19
 150 #define DSCR_CMD0_PSC3_TX       20
 151 #define DSCR_CMD0_PSC3_RX       21
 152 #define DSCR_CMD0_PCI_WRITE     22
 153 #define DSCR_CMD0_NAND_FLASH    23
 154 #define DSCR_CMD0_MAC0_RX       24
 155 #define DSCR_CMD0_MAC0_TX       25
 156 #define DSCR_CMD0_MAC1_RX       26
 157 #define DSCR_CMD0_MAC1_TX       27
 158 #endif /* CONFIG_SOC_AU1550 */
 159
 160 #ifdef CONFIG_SOC_AU1200
 161 #define DSCR_CMD0_UART0_TX      0
 162 #define DSCR_CMD0_UART0_RX      1
 163 #define DSCR_CMD0_UART1_TX      2
 164 #define DSCR_CMD0_UART1_RX      3
 165 #define DSCR_CMD0_DMA_REQ0      4
 166 #define DSCR_CMD0_DMA_REQ1      5
 167 #define DSCR_CMD0_MAE_BE        6
 168 #define DSCR_CMD0_MAE_FE        7
 169 #define DSCR_CMD0_SDMS_TX0      8
 170 #define DSCR_CMD0_SDMS_RX0      9
 171 #define DSCR_CMD0_SDMS_TX1      10
 172 #define DSCR_CMD0_SDMS_RX1      11
 173 #define DSCR_CMD0_AES_TX        13
 174 #define DSCR_CMD0_AES_RX        12
 175 #define DSCR_CMD0_PSC0_TX       14
 176 #define DSCR_CMD0_PSC0_RX       15
 177 #define DSCR_CMD0_PSC1_TX       16
 178 #define DSCR_CMD0_PSC1_RX       17
 179 #define DSCR_CMD0_CIM_RXA       18
 180 #define DSCR_CMD0_CIM_RXB       19
 181 #define DSCR_CMD0_CIM_RXC       20
 182 #define DSCR_CMD0_MAE_BOTH      21
 183 #define DSCR_CMD0_LCD           22
 184 #define DSCR_CMD0_NAND_FLASH    23
 185 #define DSCR_CMD0_PSC0_SYNC     24
 186 #define DSCR_CMD0_PSC1_SYNC     25
 187 #define DSCR_CMD0_CIM_SYNC      26
 188 #endif /* CONFIG_SOC_AU1200 */
 189
 190 #define DSCR_CMD0_THROTTLE      30
 191 #define DSCR_CMD0_ALWAYS        31
 192 #define DSCR_NDEV_IDS           32
 193 /* This macro is used to find/create custom device types */
 194 #define DSCR_DEV2CUSTOM_ID(x, d) (((((x) & 0xFFFF) << 8) | 0x32000000) | \
 195                                   ((d) & 0xFF))
 196 #define DSCR_CUSTOM2DEV_ID(x)   ((x) & 0xFF)
 197
 198 #define DSCR_CMD0_SID(x)        (((x) & 0x1f) << 25)
 199 #define DSCR_CMD0_DID(x)        (((x) & 0x1f) << 20)
 200
 201 /* Source/Destination transfer width. */
 202 #define DSCR_CMD0_BYTE          0
 203 #define DSCR_CMD0_HALFWORD      1
 204 #define DSCR_CMD0_WORD          2
 205
 206 #define DSCR_CMD0_SW(x)         (((x) & 0x3) << 18)
 207 #define DSCR_CMD0_DW(x)         (((x) & 0x3) << 16)
 208
 209 /* DDMA Descriptor Type. */
 210 #define DSCR_CMD0_STANDARD      0
 211 #define DSCR_CMD0_LITERAL       1
 212 #define DSCR_CMD0_CMP_BRANCH    2
 213
 214 #define DSCR_CMD0_DT(x)         (((x) & 0x3) << 13)
 215
 216 /* Status Instruction. */
 217 #define DSCR_CMD0_ST_NOCHANGE   0       /* Don't change */
 218 #define DSCR_CMD0_ST_CURRENT    1       /* Write current status */
 219 #define DSCR_CMD0_ST_CMD0       2       /* Write cmd0 with V cleared */
 220 #define DSCR_CMD0_ST_BYTECNT    3       /* Write remaining byte count */
 221
 222 #define DSCR_CMD0_ST(x)         (((x) & 0x3) << 0)
 223
 224 /* Descriptor Command 1. */
 225 #define DSCR_CMD1_SUPTR_MASK    (0xf << 28)     /* upper 4 bits of src addr */
 226 #define DSCR_CMD1_DUPTR_MASK    (0xf << 24)     /* upper 4 bits of dest addr */
 227 #define DSCR_CMD1_FL_MASK       (0x3 << 22)     /* Flag bits */
 228 #define DSCR_CMD1_BC_MASK       (0x3fffff)      /* Byte count */
 229
 230 /* Flag description. */
 231 #define DSCR_CMD1_FL_MEM_STRIDE0        0
 232 #define DSCR_CMD1_FL_MEM_STRIDE1        1
 233 #define DSCR_CMD1_FL_MEM_STRIDE2        2
 234
 235 #define DSCR_CMD1_FL(x)         (((x) & 0x3) << 22)
 236
 237 /* Source1, 1-dimensional stride. */
 238 #define DSCR_SRC1_STS_MASK      (3 << 30)       /* Src xfer size */
 239 #define DSCR_SRC1_SAM_MASK      (3 << 28)       /* Src xfer movement */
 240 #define DSCR_SRC1_SB_MASK       (0x3fff << 14)  /* Block size */
 241 #define DSCR_SRC1_SB(x)         (((x) & 0x3fff) << 14)
 242 #define DSCR_SRC1_SS_MASK       (0x3fff << 0)   /* Stride */
 243 #define DSCR_SRC1_SS(x)         (((x) & 0x3fff) << 0)
 244
 245 /* Dest1, 1-dimensional stride. */
 246 #define DSCR_DEST1_DTS_MASK     (3 << 30)       /* Dest xfer size */
 247 #define DSCR_DEST1_DAM_MASK     (3 << 28)       /* Dest xfer movement */
 248 #define DSCR_DEST1_DB_MASK      (0x3fff << 14)  /* Block size */
 249 #define DSCR_DEST1_DB(x)        (((x) & 0x3fff) << 14)
 250 #define DSCR_DEST1_DS_MASK      (0x3fff << 0)   /* Stride */
 251 #define DSCR_DEST1_DS(x)        (((x) & 0x3fff) << 0)
 252
 253 #define DSCR_xTS_SIZE1          0
 254 #define DSCR_xTS_SIZE2          1
 255 #define DSCR_xTS_SIZE4          2
 256 #define DSCR_xTS_SIZE8          3
 257 #define DSCR_SRC1_STS(x)        (((x) & 3) << 30)
 258 #define DSCR_DEST1_DTS(x)       (((x) & 3) << 30)
 259
 260 #define DSCR_xAM_INCREMENT      0
 261 #define DSCR_xAM_DECREMENT      1
 262 #define DSCR_xAM_STATIC         2
 263 #define DSCR_xAM_BURST          3
 264 #define DSCR_SRC1_SAM(x)        (((x) & 3) << 28)
 265 #define DSCR_DEST1_DAM(x)       (((x) & 3) << 28)
 266
 267 /* The next descriptor pointer. */
 268 #define DSCR_NXTPTR_MASK        (0x07ffffff)
 269 #define DSCR_NXTPTR(x)          ((x) >> 5)
 270 #define DSCR_GET_NXTPTR(x)      ((x) << 5)
 271 #define DSCR_NXTPTR_MS          (1 << 27)
 272
 273 /* The number of DBDMA channels. */
 274 #define NUM_DBDMA_CHANS 16
 275
 276 /*
 277  * DDMA API definitions
 278  * FIXME: may not fit to this header file
 279  */
 280 typedef struct dbdma_device_table {
 281         u32     dev_id;
 282         u32     dev_flags;
 283         u32     dev_tsize;
 284         u32     dev_devwidth;
 285         u32     dev_physaddr;           /* If FIFO */
 286         u32     dev_intlevel;
 287         u32     dev_intpolarity;
 288 } dbdev_tab_t;
 289
 290
 291 typedef struct dbdma_chan_config {
 292         spinlock_t      lock;
 293
 294         u32                     chan_flags;
 295         u32                     chan_index;
 296         dbdev_tab_t             *chan_src;
 297         dbdev_tab_t             *chan_dest;
 298         au1x_dma_chan_t         *chan_ptr;
 299         au1x_ddma_desc_t        *chan_desc_base;
 300         u32                     cdb_membase; /* kmalloc base of above */
 301         au1x_ddma_desc_t        *get_ptr, *put_ptr, *cur_ptr;
 302         void                    *chan_callparam;
 303         void                    (*chan_callback)(int, void *);
 304 } chan_tab_t;
 305
 306 #define DEV_FLAGS_INUSE         (1 << 0)
 307 #define DEV_FLAGS_ANYUSE        (1 << 1)
 308 #define DEV_FLAGS_OUT           (1 << 2)
 309 #define DEV_FLAGS_IN            (1 << 3)
 310 #define DEV_FLAGS_BURSTABLE     (1 << 4)
 311 #define DEV_FLAGS_SYNC          (1 << 5)
 312 /* end DDMA API definitions */
 313
 314 /*
 315  * External functions for drivers to use.
 316  * Use this to allocate a DBDMA channel.  The device IDs are one of
 317  * the DSCR_CMD0 devices IDs, which is usually redefined to a more
 318  * meaningful name.  The 'callback' is called during DMA completion
 319  * interrupt.
 320  */
 321 extern u32 au1xxx_dbdma_chan_alloc(u32 srcid, u32 destid,
 322                                    void (*callback)(int, void *),
 323                                    void *callparam);
 324
 325 #define DBDMA_MEM_CHAN  DSCR_CMD0_ALWAYS
 326
 327 /* Set the device width of an in/out FIFO. */
 328 u32 au1xxx_dbdma_set_devwidth(u32 chanid, int bits);
 329
 330 /* Allocate a ring of descriptors for DBDMA. */
 331 u32 au1xxx_dbdma_ring_alloc(u32 chanid, int entries);
 332
 333 /* Put buffers on source/destination descriptors. */
 334 u32 au1xxx_dbdma_put_source(u32 chanid, dma_addr_t buf, int nbytes, u32 flags);
 335 u32 au1xxx_dbdma_put_dest(u32 chanid, dma_addr_t buf, int nbytes, u32 flags);
 336
 337 /* Get a buffer from the destination descriptor. */
 338 u32 au1xxx_dbdma_get_dest(u32 chanid, void **buf, int *nbytes);
 339
 340 void au1xxx_dbdma_stop(u32 chanid);
 341 void au1xxx_dbdma_start(u32 chanid);
 342 void au1xxx_dbdma_reset(u32 chanid);
 343 u32 au1xxx_get_dma_residue(u32 chanid);
 344
 345 void au1xxx_dbdma_chan_free(u32 chanid);
 346 void au1xxx_dbdma_dump(u32 chanid);
 347
 348 u32 au1xxx_dbdma_put_dscr(u32 chanid, au1x_ddma_desc_t *dscr);
 349
 350 u32 au1xxx_ddma_add_device(dbdev_tab_t *dev);
 351 extern void au1xxx_ddma_del_device(u32 devid);
 352 void *au1xxx_ddma_get_nextptr_virt(au1x_ddma_desc_t *dp);
 353
 354 /*
 355  *      Flags for the put_source/put_dest functions.
 356  */
 357 #define DDMA_FLAGS_IE   (1 << 0)
 358 #define DDMA_FLAGS_NOIE (1 << 1)
 359
 360 #endif /* _LANGUAGE_ASSEMBLY */
 361 #endif /* _AU1000_DBDMA_H_ */