arch/arm/include/asm/arch-mxs/dma.h

   1 /*
   2  * Freescale i.MX28 APBH DMA
   3  *
   4  * Copyright (C) 2011 Marek Vasut <marek.vasut@gmail.com>
   5  * on behalf of DENX Software Engineering GmbH
   6  *
   7  * Based on code from LTIB:
   8  * Copyright 2008-2010 Freescale Semiconductor, Inc. All Rights Reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  23  *
  24  */
  25
  26 #ifndef __DMA_H__
  27 #define __DMA_H__
  28
  29 #include <linux/list.h>
  30 #include <linux/compiler.h>
  31
  32 #ifndef CONFIG_ARCH_DMA_PIO_WORDS
  33 #define DMA_PIO_WORDS           15
  34 #else
  35 #define DMA_PIO_WORDS           CONFIG_ARCH_DMA_PIO_WORDS
  36 #endif
  37
  38 #define MXS_DMA_ALIGNMENT       32
  39
  40 /*
  41  * MXS DMA channels
  42  */
  43 enum {
  44         MXS_DMA_CHANNEL_AHB_APBH_SSP0 = 0,
  45         MXS_DMA_CHANNEL_AHB_APBH_SSP1,
  46         MXS_DMA_CHANNEL_AHB_APBH_SSP2,
  47         MXS_DMA_CHANNEL_AHB_APBH_SSP3,
  48         MXS_DMA_CHANNEL_AHB_APBH_GPMI0,
  49         MXS_DMA_CHANNEL_AHB_APBH_GPMI1,
  50         MXS_DMA_CHANNEL_AHB_APBH_GPMI2,
  51         MXS_DMA_CHANNEL_AHB_APBH_GPMI3,
  52         MXS_DMA_CHANNEL_AHB_APBH_GPMI4,
  53         MXS_DMA_CHANNEL_AHB_APBH_GPMI5,
  54         MXS_DMA_CHANNEL_AHB_APBH_GPMI6,
  55         MXS_DMA_CHANNEL_AHB_APBH_GPMI7,
  56         MXS_DMA_CHANNEL_AHB_APBH_SSP,
  57         MXS_MAX_DMA_CHANNELS,
  58 };
  59
  60 /*
  61  * MXS DMA hardware command.
  62  *
  63  * This structure describes the in-memory layout of an entire DMA command,
  64  * including space for the maximum number of PIO accesses. See the appropriate
  65  * reference manual for a detailed description of what these fields mean to the
  66  * DMA hardware.
  67  */
  68 #define MXS_DMA_DESC_COMMAND_MASK       0x3
  69 #define MXS_DMA_DESC_COMMAND_OFFSET     0
  70 #define MXS_DMA_DESC_COMMAND_NO_DMAXFER 0x0
  71 #define MXS_DMA_DESC_COMMAND_DMA_WRITE  0x1
  72 #define MXS_DMA_DESC_COMMAND_DMA_READ   0x2
  73 #define MXS_DMA_DESC_COMMAND_DMA_SENSE  0x3
  74 #define MXS_DMA_DESC_CHAIN              (1 << 2)
  75 #define MXS_DMA_DESC_IRQ                (1 << 3)
  76 #define MXS_DMA_DESC_NAND_LOCK          (1 << 4)
  77 #define MXS_DMA_DESC_NAND_WAIT_4_READY  (1 << 5)
  78 #define MXS_DMA_DESC_DEC_SEM            (1 << 6)
  79 #define MXS_DMA_DESC_WAIT4END           (1 << 7)
  80 #define MXS_DMA_DESC_HALT_ON_TERMINATE  (1 << 8)
  81 #define MXS_DMA_DESC_TERMINATE_FLUSH    (1 << 9)
  82 #define MXS_DMA_DESC_PIO_WORDS_MASK     (0xf << 12)
  83 #define MXS_DMA_DESC_PIO_WORDS_OFFSET   12
  84 #define MXS_DMA_DESC_BYTES_MASK         (0xffff << 16)
  85 #define MXS_DMA_DESC_BYTES_OFFSET       16
  86
  87 struct mxs_dma_cmd {
  88         unsigned long           next;
  89         unsigned long           data;
  90         union {
  91                 dma_addr_t      address;
  92                 unsigned long   alternate;
  93         };
  94         unsigned long           pio_words[DMA_PIO_WORDS];
  95 };
  96
  97 /*
  98  * MXS DMA command descriptor.
  99  *
 100  * This structure incorporates an MXS DMA hardware command structure, along
 101  * with metadata.
 102  */
 103 #define MXS_DMA_DESC_FIRST      (1 << 0)
 104 #define MXS_DMA_DESC_LAST       (1 << 1)
 105 #define MXS_DMA_DESC_READY      (1 << 31)
 106
 107 struct mxs_dma_desc {
 108         struct mxs_dma_cmd      cmd;
 109         unsigned int            flags;
 110         dma_addr_t              address;
 111         void                    *buffer;
 112         struct list_head        node;
 113 } __aligned(MXS_DMA_ALIGNMENT);
 114
 115 /**
 116  * MXS DMA channel
 117  *
 118  * This structure represents a single DMA channel. The MXS platform code
 119  * maintains an array of these structures to represent every DMA channel in the
 120  * system (see mxs_dma_channels).
 121  */
 122 #define MXS_DMA_FLAGS_IDLE      0
 123 #define MXS_DMA_FLAGS_BUSY      (1 << 0)
 124 #define MXS_DMA_FLAGS_FREE      0
 125 #define MXS_DMA_FLAGS_ALLOCATED (1 << 16)
 126 #define MXS_DMA_FLAGS_VALID     (1 << 31)
 127
 128 struct mxs_dma_chan {
 129         const char *name;
 130         unsigned long dev;
 131         struct mxs_dma_device *dma;
 132         unsigned int flags;
 133         unsigned int active_num;
 134         unsigned int pending_num;
 135         struct list_head active;
 136         struct list_head done;
 137 };
 138
 139 struct mxs_dma_desc *mxs_dma_desc_alloc(void);
 140 void mxs_dma_desc_free(struct mxs_dma_desc *);
 141 int mxs_dma_desc_append(int channel, struct mxs_dma_desc *pdesc);
 142
 143 int mxs_dma_go(int chan);
 144 void mxs_dma_init(void);
 145 int mxs_dma_init_channel(int chan);
 146 int mxs_dma_release(int chan);
 147
 148 #endif  /* __DMA_H__ */