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