arch/arm/plat-nomadik/include/plat/ste_dma40.h

   1 /*
   2  * arch/arm/plat-nomadik/include/plat/ste_dma40.h
   3  *
   4  * Copyright (C) ST-Ericsson 2007-2010
   5  * License terms: GNU General Public License (GPL) version 2
   6  * Author: Per Friden <per.friden@stericsson.com>
   7  * Author: Jonas Aaberg <jonas.aberg@stericsson.com>
   8  */
   9
  10
  11 #ifndef STE_DMA40_H
  12 #define STE_DMA40_H
  13
  14 #include <linux/dmaengine.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/interrupt.h>
  17
  18 /* dev types for memcpy */
  19 #define STEDMA40_DEV_DST_MEMORY (-1)
  20 #define STEDMA40_DEV_SRC_MEMORY (-1)
  21
  22 /*
  23  * Description of bitfields of channel_type variable is available in
  24  * the info structure.
  25  */
  26
  27 /* Priority */
  28 #define STEDMA40_INFO_PRIO_TYPE_POS 2
  29 #define STEDMA40_HIGH_PRIORITY_CHANNEL (0x1 << STEDMA40_INFO_PRIO_TYPE_POS)
  30 #define STEDMA40_LOW_PRIORITY_CHANNEL (0x2 << STEDMA40_INFO_PRIO_TYPE_POS)
  31
  32 /* Mode  */
  33 #define STEDMA40_INFO_CH_MODE_TYPE_POS 6
  34 #define STEDMA40_CHANNEL_IN_PHY_MODE (0x1 << STEDMA40_INFO_CH_MODE_TYPE_POS)
  35 #define STEDMA40_CHANNEL_IN_LOG_MODE (0x2 << STEDMA40_INFO_CH_MODE_TYPE_POS)
  36 #define STEDMA40_CHANNEL_IN_OPER_MODE (0x3 << STEDMA40_INFO_CH_MODE_TYPE_POS)
  37
  38 /* Mode options */
  39 #define STEDMA40_INFO_CH_MODE_OPT_POS 8
  40 #define STEDMA40_PCHAN_BASIC_MODE (0x1 << STEDMA40_INFO_CH_MODE_OPT_POS)
  41 #define STEDMA40_PCHAN_MODULO_MODE (0x2 << STEDMA40_INFO_CH_MODE_OPT_POS)
  42 #define STEDMA40_PCHAN_DOUBLE_DST_MODE (0x3 << STEDMA40_INFO_CH_MODE_OPT_POS)
  43 #define STEDMA40_LCHAN_SRC_PHY_DST_LOG (0x1 << STEDMA40_INFO_CH_MODE_OPT_POS)
  44 #define STEDMA40_LCHAN_SRC_LOG_DST_PHS (0x2 << STEDMA40_INFO_CH_MODE_OPT_POS)
  45 #define STEDMA40_LCHAN_SRC_LOG_DST_LOG (0x3 << STEDMA40_INFO_CH_MODE_OPT_POS)
  46
  47 /* Interrupt */
  48 #define STEDMA40_INFO_TIM_POS 10
  49 #define STEDMA40_NO_TIM_FOR_LINK (0x0 << STEDMA40_INFO_TIM_POS)
  50 #define STEDMA40_TIM_FOR_LINK (0x1 << STEDMA40_INFO_TIM_POS)
  51
  52 /* End of channel_type configuration */
  53
  54 #define STEDMA40_ESIZE_8_BIT  0x0
  55 #define STEDMA40_ESIZE_16_BIT 0x1
  56 #define STEDMA40_ESIZE_32_BIT 0x2
  57 #define STEDMA40_ESIZE_64_BIT 0x3
  58
  59 /* The value 4 indicates that PEN-reg shall be set to 0 */
  60 #define STEDMA40_PSIZE_PHY_1  0x4
  61 #define STEDMA40_PSIZE_PHY_2  0x0
  62 #define STEDMA40_PSIZE_PHY_4  0x1
  63 #define STEDMA40_PSIZE_PHY_8  0x2
  64 #define STEDMA40_PSIZE_PHY_16 0x3
  65
  66 /*
  67  * The number of elements differ in logical and
  68  * physical mode
  69  */
  70 #define STEDMA40_PSIZE_LOG_1  STEDMA40_PSIZE_PHY_2
  71 #define STEDMA40_PSIZE_LOG_4  STEDMA40_PSIZE_PHY_4
  72 #define STEDMA40_PSIZE_LOG_8  STEDMA40_PSIZE_PHY_8
  73 #define STEDMA40_PSIZE_LOG_16 STEDMA40_PSIZE_PHY_16
  74
  75 enum stedma40_flow_ctrl {
  76         STEDMA40_NO_FLOW_CTRL,
  77         STEDMA40_FLOW_CTRL,
  78 };
  79
  80 enum stedma40_endianess {
  81         STEDMA40_LITTLE_ENDIAN,
  82         STEDMA40_BIG_ENDIAN
  83 };
  84
  85 enum stedma40_periph_data_width {
  86         STEDMA40_BYTE_WIDTH = STEDMA40_ESIZE_8_BIT,
  87         STEDMA40_HALFWORD_WIDTH = STEDMA40_ESIZE_16_BIT,
  88         STEDMA40_WORD_WIDTH = STEDMA40_ESIZE_32_BIT,
  89         STEDMA40_DOUBLEWORD_WIDTH = STEDMA40_ESIZE_64_BIT
  90 };
  91
  92 struct stedma40_half_channel_info {
  93         enum stedma40_endianess endianess;
  94         enum stedma40_periph_data_width data_width;
  95         int psize;
  96         enum stedma40_flow_ctrl flow_ctrl;
  97 };
  98
  99 enum stedma40_xfer_dir {
 100         STEDMA40_MEM_TO_MEM,
 101         STEDMA40_MEM_TO_PERIPH,
 102         STEDMA40_PERIPH_TO_MEM,
 103         STEDMA40_PERIPH_TO_PERIPH
 104 };
 105
 106
 107 /**
 108  * struct stedma40_chan_cfg - Structure to be filled by client drivers.
 109  *
 110  * @dir: MEM 2 MEM, PERIPH 2 MEM , MEM 2 PERIPH, PERIPH 2 PERIPH
 111  * @channel_type: priority, mode, mode options and interrupt configuration.
 112  * @src_dev_type: Src device type
 113  * @dst_dev_type: Dst device type
 114  * @src_info: Parameters for dst half channel
 115  * @dst_info: Parameters for dst half channel
 116  * @pre_transfer_data: Data to be passed on to the pre_transfer() function.
 117  * @pre_transfer: Callback used if needed before preparation of transfer.
 118  * Only called if device is set. size of bytes to transfer
 119  * (in case of multiple element transfer size is size of the first element).
 120  *
 121  *
 122  * This structure has to be filled by the client drivers.
 123  * It is recommended to do all dma configurations for clients in the machine.
 124  *
 125  */
 126 struct stedma40_chan_cfg {
 127         enum stedma40_xfer_dir                   dir;
 128         unsigned int                             channel_type;
 129         int                                      src_dev_type;
 130         int                                      dst_dev_type;
 131         struct stedma40_half_channel_info        src_info;
 132         struct stedma40_half_channel_info        dst_info;
 133         void                                    *pre_transfer_data;
 134         int (*pre_transfer)                     (struct dma_chan *chan,
 135                                                  void *data,
 136                                                  int size);
 137 };
 138
 139 /**
 140  * struct stedma40_platform_data - Configuration struct for the dma device.
 141  *
 142  * @dev_len: length of dev_tx and dev_rx
 143  * @dev_tx: mapping between destination event line and io address
 144  * @dev_rx: mapping between source event line and io address
 145  * @memcpy: list of memcpy event lines
 146  * @memcpy_len: length of memcpy
 147  * @memcpy_conf_phy: default configuration of physical channel memcpy
 148  * @memcpy_conf_log: default configuration of logical channel memcpy
 149  * @llis_per_log: number of max linked list items per logical channel
 150  * @disabled_channels: A vector, ending with -1, that marks physical channels
 151  * that are for different reasons not available for the driver.
 152  */
 153 struct stedma40_platform_data {
 154         u32                              dev_len;
 155         const dma_addr_t                *dev_tx;
 156         const dma_addr_t                *dev_rx;
 157         int                             *memcpy;
 158         u32                              memcpy_len;
 159         struct stedma40_chan_cfg        *memcpy_conf_phy;
 160         struct stedma40_chan_cfg        *memcpy_conf_log;
 161         unsigned int                     llis_per_log;
 162         int                              disabled_channels[8];
 163 };
 164
 165 /**
 166  * setdma40_set_psize() - Used for changing the package size of an
 167  * already configured dma channel.
 168  *
 169  * @chan: dmaengine handle
 170  * @src_psize: new package side for src. (STEDMA40_PSIZE*)
 171  * @src_psize: new package side for dst. (STEDMA40_PSIZE*)
 172  *
 173  * returns 0 on ok, otherwise negative error number.
 174  */
 175 int stedma40_set_psize(struct dma_chan *chan,
 176                        int src_psize,
 177                        int dst_psize);
 178
 179 /**
 180  * stedma40_filter() - Provides stedma40_chan_cfg to the
 181  * ste_dma40 dma driver via the dmaengine framework.
 182  * does some checking of what's provided.
 183  *
 184  * Never directly called by client. It used by dmaengine.
 185  * @chan: dmaengine handle.
 186  * @data: Must be of type: struct stedma40_chan_cfg and is
 187  * the configuration of the framework.
 188  *
 189  *
 190  */
 191
 192 bool stedma40_filter(struct dma_chan *chan, void *data);
 193
 194 /**
 195  * stedma40_memcpy_sg() - extension of the dma framework, memcpy to/from
 196  * scattergatter lists.
 197  *
 198  * @chan: dmaengine handle
 199  * @sgl_dst: Destination scatter list
 200  * @sgl_src: Source scatter list
 201  * @sgl_len: The length of each scatterlist. Both lists must be of equal length
 202  * and each element must match the corresponding element in the other scatter
 203  * list.
 204  * @flags: is actually enum dma_ctrl_flags. See dmaengine.h
 205  */
 206
 207 struct dma_async_tx_descriptor *stedma40_memcpy_sg(struct dma_chan *chan,
 208                                                    struct scatterlist *sgl_dst,
 209                                                    struct scatterlist *sgl_src,
 210                                                    unsigned int sgl_len,
 211                                                    unsigned long flags);
 212
 213 /**
 214  * stedma40_slave_mem() - Transfers a raw data buffer to or from a slave
 215  * (=device)
 216  *
 217  * @chan: dmaengine handle
 218  * @addr: source or destination physicall address.
 219  * @size: bytes to transfer
 220  * @direction: direction of transfer
 221  * @flags: is actually enum dma_ctrl_flags. See dmaengine.h
 222  */
 223
 224 static inline struct
 225 dma_async_tx_descriptor *stedma40_slave_mem(struct dma_chan *chan,
 226                                             dma_addr_t addr,
 227                                             unsigned int size,
 228                                             enum dma_data_direction direction,
 229                                             unsigned long flags)
 230 {
 231         struct scatterlist sg;
 232         sg_init_table(&sg, 1);
 233         sg.dma_address = addr;
 234         sg.length = size;
 235
 236         return chan->device->device_prep_slave_sg(chan, &sg, 1,
 237                                                   direction, flags);
 238 }
 239
 240 #endif