Merge branch 'tda998x-devel' of git://ftp.arm.linux.org.uk/~rmk/linux-cubox into...
[firefly-linux-kernel-4.4.55.git] / include / linux / omap-dma.h
1 #ifndef __LINUX_OMAP_DMA_H
2 #define __LINUX_OMAP_DMA_H
3 #include <linux/omap-dmaengine.h>
4
5 /*
6  *  Legacy OMAP DMA handling defines and functions
7  *
8  *  NOTE: Do not use these any longer.
9  *
10  *  Use the generic dmaengine functions as defined in
11  *  include/linux/dmaengine.h.
12  *
13  *  Copyright (C) 2003 Nokia Corporation
14  *  Author: Juha Yrjölä <juha.yrjola@nokia.com>
15  *
16  */
17
18 #include <linux/platform_device.h>
19
20 #define INT_DMA_LCD                     25
21
22 #define OMAP1_DMA_TOUT_IRQ              (1 << 0)
23 #define OMAP_DMA_DROP_IRQ               (1 << 1)
24 #define OMAP_DMA_HALF_IRQ               (1 << 2)
25 #define OMAP_DMA_FRAME_IRQ              (1 << 3)
26 #define OMAP_DMA_LAST_IRQ               (1 << 4)
27 #define OMAP_DMA_BLOCK_IRQ              (1 << 5)
28 #define OMAP1_DMA_SYNC_IRQ              (1 << 6)
29 #define OMAP2_DMA_PKT_IRQ               (1 << 7)
30 #define OMAP2_DMA_TRANS_ERR_IRQ         (1 << 8)
31 #define OMAP2_DMA_SECURE_ERR_IRQ        (1 << 9)
32 #define OMAP2_DMA_SUPERVISOR_ERR_IRQ    (1 << 10)
33 #define OMAP2_DMA_MISALIGNED_ERR_IRQ    (1 << 11)
34
35 #define OMAP_DMA_CCR_EN                 (1 << 7)
36 #define OMAP_DMA_CCR_RD_ACTIVE          (1 << 9)
37 #define OMAP_DMA_CCR_WR_ACTIVE          (1 << 10)
38 #define OMAP_DMA_CCR_SEL_SRC_DST_SYNC   (1 << 24)
39 #define OMAP_DMA_CCR_BUFFERING_DISABLE  (1 << 25)
40
41 #define OMAP_DMA_DATA_TYPE_S8           0x00
42 #define OMAP_DMA_DATA_TYPE_S16          0x01
43 #define OMAP_DMA_DATA_TYPE_S32          0x02
44
45 #define OMAP_DMA_SYNC_ELEMENT           0x00
46 #define OMAP_DMA_SYNC_FRAME             0x01
47 #define OMAP_DMA_SYNC_BLOCK             0x02
48 #define OMAP_DMA_SYNC_PACKET            0x03
49
50 #define OMAP_DMA_DST_SYNC_PREFETCH      0x02
51 #define OMAP_DMA_SRC_SYNC               0x01
52 #define OMAP_DMA_DST_SYNC               0x00
53
54 #define OMAP_DMA_PORT_EMIFF             0x00
55 #define OMAP_DMA_PORT_EMIFS             0x01
56 #define OMAP_DMA_PORT_OCP_T1            0x02
57 #define OMAP_DMA_PORT_TIPB              0x03
58 #define OMAP_DMA_PORT_OCP_T2            0x04
59 #define OMAP_DMA_PORT_MPUI              0x05
60
61 #define OMAP_DMA_AMODE_CONSTANT         0x00
62 #define OMAP_DMA_AMODE_POST_INC         0x01
63 #define OMAP_DMA_AMODE_SINGLE_IDX       0x02
64 #define OMAP_DMA_AMODE_DOUBLE_IDX       0x03
65
66 #define DMA_DEFAULT_FIFO_DEPTH          0x10
67 #define DMA_DEFAULT_ARB_RATE            0x01
68 /* Pass THREAD_RESERVE ORed with THREAD_FIFO for tparams */
69 #define DMA_THREAD_RESERVE_NORM         (0x00 << 12) /* Def */
70 #define DMA_THREAD_RESERVE_ONET         (0x01 << 12)
71 #define DMA_THREAD_RESERVE_TWOT         (0x02 << 12)
72 #define DMA_THREAD_RESERVE_THREET       (0x03 << 12)
73 #define DMA_THREAD_FIFO_NONE            (0x00 << 14) /* Def */
74 #define DMA_THREAD_FIFO_75              (0x01 << 14)
75 #define DMA_THREAD_FIFO_25              (0x02 << 14)
76 #define DMA_THREAD_FIFO_50              (0x03 << 14)
77
78 /* DMA4_OCP_SYSCONFIG bits */
79 #define DMA_SYSCONFIG_MIDLEMODE_MASK            (3 << 12)
80 #define DMA_SYSCONFIG_CLOCKACTIVITY_MASK        (3 << 8)
81 #define DMA_SYSCONFIG_EMUFREE                   (1 << 5)
82 #define DMA_SYSCONFIG_SIDLEMODE_MASK            (3 << 3)
83 #define DMA_SYSCONFIG_SOFTRESET                 (1 << 2)
84 #define DMA_SYSCONFIG_AUTOIDLE                  (1 << 0)
85
86 #define DMA_SYSCONFIG_MIDLEMODE(n)              ((n) << 12)
87 #define DMA_SYSCONFIG_SIDLEMODE(n)              ((n) << 3)
88
89 #define DMA_IDLEMODE_SMARTIDLE                  0x2
90 #define DMA_IDLEMODE_NO_IDLE                    0x1
91 #define DMA_IDLEMODE_FORCE_IDLE                 0x0
92
93 /* Chaining modes*/
94 #ifndef CONFIG_ARCH_OMAP1
95 #define OMAP_DMA_STATIC_CHAIN           0x1
96 #define OMAP_DMA_DYNAMIC_CHAIN          0x2
97 #define OMAP_DMA_CHAIN_ACTIVE           0x1
98 #define OMAP_DMA_CHAIN_INACTIVE         0x0
99 #endif
100
101 #define DMA_CH_PRIO_HIGH                0x1
102 #define DMA_CH_PRIO_LOW                 0x0 /* Def */
103
104 /* Errata handling */
105 #define IS_DMA_ERRATA(id)               (errata & (id))
106 #define SET_DMA_ERRATA(id)              (errata |= (id))
107
108 #define DMA_ERRATA_IFRAME_BUFFERING     BIT(0x0)
109 #define DMA_ERRATA_PARALLEL_CHANNELS    BIT(0x1)
110 #define DMA_ERRATA_i378                 BIT(0x2)
111 #define DMA_ERRATA_i541                 BIT(0x3)
112 #define DMA_ERRATA_i88                  BIT(0x4)
113 #define DMA_ERRATA_3_3                  BIT(0x5)
114 #define DMA_ROMCODE_BUG                 BIT(0x6)
115
116 /* Attributes for OMAP DMA Contrller */
117 #define DMA_LINKED_LCH                  BIT(0x0)
118 #define GLOBAL_PRIORITY                 BIT(0x1)
119 #define RESERVE_CHANNEL                 BIT(0x2)
120 #define IS_CSSA_32                      BIT(0x3)
121 #define IS_CDSA_32                      BIT(0x4)
122 #define IS_RW_PRIORITY                  BIT(0x5)
123 #define ENABLE_1510_MODE                BIT(0x6)
124 #define SRC_PORT                        BIT(0x7)
125 #define DST_PORT                        BIT(0x8)
126 #define SRC_INDEX                       BIT(0x9)
127 #define DST_INDEX                       BIT(0xa)
128 #define IS_BURST_ONLY4                  BIT(0xb)
129 #define CLEAR_CSR_ON_READ               BIT(0xc)
130 #define IS_WORD_16                      BIT(0xd)
131 #define ENABLE_16XX_MODE                BIT(0xe)
132 #define HS_CHANNELS_RESERVED            BIT(0xf)
133
134 /* Defines for DMA Capabilities */
135 #define DMA_HAS_TRANSPARENT_CAPS        (0x1 << 18)
136 #define DMA_HAS_CONSTANT_FILL_CAPS      (0x1 << 19)
137 #define DMA_HAS_DESCRIPTOR_CAPS         (0x3 << 20)
138
139 enum omap_reg_offsets {
140
141 GCR,            GSCR,           GRST1,          HW_ID,
142 PCH2_ID,        PCH0_ID,        PCH1_ID,        PCHG_ID,
143 PCHD_ID,        CAPS_0,         CAPS_1,         CAPS_2,
144 CAPS_3,         CAPS_4,         PCH2_SR,        PCH0_SR,
145 PCH1_SR,        PCHD_SR,        REVISION,       IRQSTATUS_L0,
146 IRQSTATUS_L1,   IRQSTATUS_L2,   IRQSTATUS_L3,   IRQENABLE_L0,
147 IRQENABLE_L1,   IRQENABLE_L2,   IRQENABLE_L3,   SYSSTATUS,
148 OCP_SYSCONFIG,
149
150 /* omap1+ specific */
151 CPC, CCR2, LCH_CTRL,
152
153 /* Common registers for all omap's */
154 CSDP,           CCR,            CICR,           CSR,
155 CEN,            CFN,            CSFI,           CSEI,
156 CSAC,           CDAC,           CDEI,
157 CDFI,           CLNK_CTRL,
158
159 /* Channel specific registers */
160 CSSA,           CDSA,           COLOR,
161 CCEN,           CCFN,
162
163 /* omap3630 and omap4 specific */
164 CDP,            CNDP,           CCDN,
165
166 };
167
168 enum omap_dma_burst_mode {
169         OMAP_DMA_DATA_BURST_DIS = 0,
170         OMAP_DMA_DATA_BURST_4,
171         OMAP_DMA_DATA_BURST_8,
172         OMAP_DMA_DATA_BURST_16,
173 };
174
175 enum end_type {
176         OMAP_DMA_LITTLE_ENDIAN = 0,
177         OMAP_DMA_BIG_ENDIAN
178 };
179
180 enum omap_dma_color_mode {
181         OMAP_DMA_COLOR_DIS = 0,
182         OMAP_DMA_CONSTANT_FILL,
183         OMAP_DMA_TRANSPARENT_COPY
184 };
185
186 enum omap_dma_write_mode {
187         OMAP_DMA_WRITE_NON_POSTED = 0,
188         OMAP_DMA_WRITE_POSTED,
189         OMAP_DMA_WRITE_LAST_NON_POSTED
190 };
191
192 enum omap_dma_channel_mode {
193         OMAP_DMA_LCH_2D = 0,
194         OMAP_DMA_LCH_G,
195         OMAP_DMA_LCH_P,
196         OMAP_DMA_LCH_PD
197 };
198
199 struct omap_dma_channel_params {
200         int data_type;          /* data type 8,16,32 */
201         int elem_count;         /* number of elements in a frame */
202         int frame_count;        /* number of frames in a element */
203
204         int src_port;           /* Only on OMAP1 REVISIT: Is this needed? */
205         int src_amode;          /* constant, post increment, indexed,
206                                         double indexed */
207         unsigned long src_start;        /* source address : physical */
208         int src_ei;             /* source element index */
209         int src_fi;             /* source frame index */
210
211         int dst_port;           /* Only on OMAP1 REVISIT: Is this needed? */
212         int dst_amode;          /* constant, post increment, indexed,
213                                         double indexed */
214         unsigned long dst_start;        /* source address : physical */
215         int dst_ei;             /* source element index */
216         int dst_fi;             /* source frame index */
217
218         int trigger;            /* trigger attached if the channel is
219                                         synchronized */
220         int sync_mode;          /* sycn on element, frame , block or packet */
221         int src_or_dst_synch;   /* source synch(1) or destination synch(0) */
222
223         int ie;                 /* interrupt enabled */
224
225         unsigned char read_prio;/* read priority */
226         unsigned char write_prio;/* write priority */
227
228 #ifndef CONFIG_ARCH_OMAP1
229         enum omap_dma_burst_mode burst_mode; /* Burst mode 4/8/16 words */
230 #endif
231 };
232
233 struct omap_dma_lch {
234         int next_lch;
235         int dev_id;
236         u16 saved_csr;
237         u16 enabled_irqs;
238         const char *dev_name;
239         void (*callback)(int lch, u16 ch_status, void *data);
240         void *data;
241         long flags;
242         /* required for Dynamic chaining */
243         int prev_linked_ch;
244         int next_linked_ch;
245         int state;
246         int chain_id;
247         int status;
248 };
249
250 struct omap_dma_dev_attr {
251         u32 dev_caps;
252         u16 lch_count;
253         u16 chan_count;
254 };
255
256 enum {
257         OMAP_DMA_REG_NONE,
258         OMAP_DMA_REG_16BIT,
259         OMAP_DMA_REG_2X16BIT,
260         OMAP_DMA_REG_32BIT,
261 };
262
263 struct omap_dma_reg {
264         u16     offset;
265         u8      stride;
266         u8      type;
267 };
268
269 /* System DMA platform data structure */
270 struct omap_system_dma_plat_info {
271         const struct omap_dma_reg *reg_map;
272         unsigned channel_stride;
273         struct omap_dma_dev_attr *dma_attr;
274         u32 errata;
275         void (*show_dma_caps)(void);
276         void (*clear_lch_regs)(int lch);
277         void (*clear_dma)(int lch);
278         void (*dma_write)(u32 val, int reg, int lch);
279         u32 (*dma_read)(int reg, int lch);
280 };
281
282 #ifdef CONFIG_ARCH_OMAP2PLUS
283 #define dma_omap2plus() 1
284 #else
285 #define dma_omap2plus() 0
286 #endif
287 #define dma_omap1()     (!dma_omap2plus())
288 #define __dma_omap15xx(d) (dma_omap1() && (d)->dev_caps & ENABLE_1510_MODE)
289 #define __dma_omap16xx(d) (dma_omap1() && (d)->dev_caps & ENABLE_16XX_MODE)
290 #define dma_omap15xx()  __dma_omap15xx(d)
291 #define dma_omap16xx()  __dma_omap16xx(d)
292
293 extern struct omap_system_dma_plat_info *omap_get_plat_info(void);
294
295 extern void omap_set_dma_priority(int lch, int dst_port, int priority);
296 extern int omap_request_dma(int dev_id, const char *dev_name,
297                         void (*callback)(int lch, u16 ch_status, void *data),
298                         void *data, int *dma_ch);
299 extern void omap_enable_dma_irq(int ch, u16 irq_bits);
300 extern void omap_disable_dma_irq(int ch, u16 irq_bits);
301 extern void omap_free_dma(int ch);
302 extern void omap_start_dma(int lch);
303 extern void omap_stop_dma(int lch);
304 extern void omap_set_dma_transfer_params(int lch, int data_type,
305                                          int elem_count, int frame_count,
306                                          int sync_mode,
307                                          int dma_trigger, int src_or_dst_synch);
308 extern void omap_set_dma_color_mode(int lch, enum omap_dma_color_mode mode,
309                                     u32 color);
310 extern void omap_set_dma_write_mode(int lch, enum omap_dma_write_mode mode);
311 extern void omap_set_dma_channel_mode(int lch, enum omap_dma_channel_mode mode);
312
313 extern void omap_set_dma_src_params(int lch, int src_port, int src_amode,
314                                     unsigned long src_start,
315                                     int src_ei, int src_fi);
316 extern void omap_set_dma_src_index(int lch, int eidx, int fidx);
317 extern void omap_set_dma_src_data_pack(int lch, int enable);
318 extern void omap_set_dma_src_burst_mode(int lch,
319                                         enum omap_dma_burst_mode burst_mode);
320
321 extern void omap_set_dma_dest_params(int lch, int dest_port, int dest_amode,
322                                      unsigned long dest_start,
323                                      int dst_ei, int dst_fi);
324 extern void omap_set_dma_dest_index(int lch, int eidx, int fidx);
325 extern void omap_set_dma_dest_data_pack(int lch, int enable);
326 extern void omap_set_dma_dest_burst_mode(int lch,
327                                          enum omap_dma_burst_mode burst_mode);
328
329 extern void omap_set_dma_params(int lch,
330                                 struct omap_dma_channel_params *params);
331
332 extern void omap_dma_link_lch(int lch_head, int lch_queue);
333 extern void omap_dma_unlink_lch(int lch_head, int lch_queue);
334
335 extern int omap_set_dma_callback(int lch,
336                         void (*callback)(int lch, u16 ch_status, void *data),
337                         void *data);
338 extern dma_addr_t omap_get_dma_src_pos(int lch);
339 extern dma_addr_t omap_get_dma_dst_pos(int lch);
340 extern void omap_clear_dma(int lch);
341 extern int omap_get_dma_active_status(int lch);
342 extern int omap_dma_running(void);
343 extern void omap_dma_set_global_params(int arb_rate, int max_fifo_depth,
344                                        int tparams);
345 extern int omap_dma_set_prio_lch(int lch, unsigned char read_prio,
346                                  unsigned char write_prio);
347 extern void omap_set_dma_dst_endian_type(int lch, enum end_type etype);
348 extern void omap_set_dma_src_endian_type(int lch, enum end_type etype);
349 extern int omap_get_dma_index(int lch, int *ei, int *fi);
350
351 void omap_dma_global_context_save(void);
352 void omap_dma_global_context_restore(void);
353
354 extern void omap_dma_disable_irq(int lch);
355
356 /* Chaining APIs */
357 #ifndef CONFIG_ARCH_OMAP1
358 extern int omap_request_dma_chain(int dev_id, const char *dev_name,
359                                   void (*callback) (int lch, u16 ch_status,
360                                                     void *data),
361                                   int *chain_id, int no_of_chans,
362                                   int chain_mode,
363                                   struct omap_dma_channel_params params);
364 extern int omap_free_dma_chain(int chain_id);
365 extern int omap_dma_chain_a_transfer(int chain_id, int src_start,
366                                      int dest_start, int elem_count,
367                                      int frame_count, void *callbk_data);
368 extern int omap_start_dma_chain_transfers(int chain_id);
369 extern int omap_stop_dma_chain_transfers(int chain_id);
370 extern int omap_get_dma_chain_index(int chain_id, int *ei, int *fi);
371 extern int omap_get_dma_chain_dst_pos(int chain_id);
372 extern int omap_get_dma_chain_src_pos(int chain_id);
373
374 extern int omap_modify_dma_chain_params(int chain_id,
375                                         struct omap_dma_channel_params params);
376 extern int omap_dma_chain_status(int chain_id);
377 #endif
378
379 #if defined(CONFIG_ARCH_OMAP1) && IS_ENABLED(CONFIG_FB_OMAP)
380 #include <mach/lcd_dma.h>
381 #else
382 static inline int omap_lcd_dma_running(void)
383 {
384         return 0;
385 }
386 #endif
387
388 #endif /* __LINUX_OMAP_DMA_H */