xref: /openbmc/linux/include/linux/omap-dma.h (revision 3932b9ca)
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 #define DMA_ENGINE_HANDLE_IRQ		BIT(0x10)
134 
135 /* Defines for DMA Capabilities */
136 #define DMA_HAS_TRANSPARENT_CAPS	(0x1 << 18)
137 #define DMA_HAS_CONSTANT_FILL_CAPS	(0x1 << 19)
138 #define DMA_HAS_DESCRIPTOR_CAPS		(0x3 << 20)
139 
140 enum omap_reg_offsets {
141 
142 GCR,		GSCR,		GRST1,		HW_ID,
143 PCH2_ID,	PCH0_ID,	PCH1_ID,	PCHG_ID,
144 PCHD_ID,	CAPS_0,		CAPS_1,		CAPS_2,
145 CAPS_3,		CAPS_4,		PCH2_SR,	PCH0_SR,
146 PCH1_SR,	PCHD_SR,	REVISION,	IRQSTATUS_L0,
147 IRQSTATUS_L1,	IRQSTATUS_L2,	IRQSTATUS_L3,	IRQENABLE_L0,
148 IRQENABLE_L1,	IRQENABLE_L2,	IRQENABLE_L3,	SYSSTATUS,
149 OCP_SYSCONFIG,
150 
151 /* omap1+ specific */
152 CPC, CCR2, LCH_CTRL,
153 
154 /* Common registers for all omap's */
155 CSDP,		CCR,		CICR,		CSR,
156 CEN,		CFN,		CSFI,		CSEI,
157 CSAC,		CDAC,		CDEI,
158 CDFI,		CLNK_CTRL,
159 
160 /* Channel specific registers */
161 CSSA,		CDSA,		COLOR,
162 CCEN,		CCFN,
163 
164 /* omap3630 and omap4 specific */
165 CDP,		CNDP,		CCDN,
166 
167 };
168 
169 enum omap_dma_burst_mode {
170 	OMAP_DMA_DATA_BURST_DIS = 0,
171 	OMAP_DMA_DATA_BURST_4,
172 	OMAP_DMA_DATA_BURST_8,
173 	OMAP_DMA_DATA_BURST_16,
174 };
175 
176 enum end_type {
177 	OMAP_DMA_LITTLE_ENDIAN = 0,
178 	OMAP_DMA_BIG_ENDIAN
179 };
180 
181 enum omap_dma_color_mode {
182 	OMAP_DMA_COLOR_DIS = 0,
183 	OMAP_DMA_CONSTANT_FILL,
184 	OMAP_DMA_TRANSPARENT_COPY
185 };
186 
187 enum omap_dma_write_mode {
188 	OMAP_DMA_WRITE_NON_POSTED = 0,
189 	OMAP_DMA_WRITE_POSTED,
190 	OMAP_DMA_WRITE_LAST_NON_POSTED
191 };
192 
193 enum omap_dma_channel_mode {
194 	OMAP_DMA_LCH_2D = 0,
195 	OMAP_DMA_LCH_G,
196 	OMAP_DMA_LCH_P,
197 	OMAP_DMA_LCH_PD
198 };
199 
200 struct omap_dma_channel_params {
201 	int data_type;		/* data type 8,16,32 */
202 	int elem_count;		/* number of elements in a frame */
203 	int frame_count;	/* number of frames in a element */
204 
205 	int src_port;		/* Only on OMAP1 REVISIT: Is this needed? */
206 	int src_amode;		/* constant, post increment, indexed,
207 					double indexed */
208 	unsigned long src_start;	/* source address : physical */
209 	int src_ei;		/* source element index */
210 	int src_fi;		/* source frame index */
211 
212 	int dst_port;		/* Only on OMAP1 REVISIT: Is this needed? */
213 	int dst_amode;		/* constant, post increment, indexed,
214 					double indexed */
215 	unsigned long dst_start;	/* source address : physical */
216 	int dst_ei;		/* source element index */
217 	int dst_fi;		/* source frame index */
218 
219 	int trigger;		/* trigger attached if the channel is
220 					synchronized */
221 	int sync_mode;		/* sycn on element, frame , block or packet */
222 	int src_or_dst_synch;	/* source synch(1) or destination synch(0) */
223 
224 	int ie;			/* interrupt enabled */
225 
226 	unsigned char read_prio;/* read priority */
227 	unsigned char write_prio;/* write priority */
228 
229 #ifndef CONFIG_ARCH_OMAP1
230 	enum omap_dma_burst_mode burst_mode; /* Burst mode 4/8/16 words */
231 #endif
232 };
233 
234 struct omap_dma_lch {
235 	int next_lch;
236 	int dev_id;
237 	u16 saved_csr;
238 	u16 enabled_irqs;
239 	const char *dev_name;
240 	void (*callback)(int lch, u16 ch_status, void *data);
241 	void *data;
242 	long flags;
243 	/* required for Dynamic chaining */
244 	int prev_linked_ch;
245 	int next_linked_ch;
246 	int state;
247 	int chain_id;
248 	int status;
249 };
250 
251 struct omap_dma_dev_attr {
252 	u32 dev_caps;
253 	u16 lch_count;
254 	u16 chan_count;
255 };
256 
257 enum {
258 	OMAP_DMA_REG_NONE,
259 	OMAP_DMA_REG_16BIT,
260 	OMAP_DMA_REG_2X16BIT,
261 	OMAP_DMA_REG_32BIT,
262 };
263 
264 struct omap_dma_reg {
265 	u16	offset;
266 	u8	stride;
267 	u8	type;
268 };
269 
270 /* System DMA platform data structure */
271 struct omap_system_dma_plat_info {
272 	const struct omap_dma_reg *reg_map;
273 	unsigned channel_stride;
274 	struct omap_dma_dev_attr *dma_attr;
275 	u32 errata;
276 	void (*show_dma_caps)(void);
277 	void (*clear_lch_regs)(int lch);
278 	void (*clear_dma)(int lch);
279 	void (*dma_write)(u32 val, int reg, int lch);
280 	u32 (*dma_read)(int reg, int lch);
281 };
282 
283 #ifdef CONFIG_ARCH_OMAP2PLUS
284 #define dma_omap2plus()	1
285 #else
286 #define dma_omap2plus()	0
287 #endif
288 #define dma_omap1()	(!dma_omap2plus())
289 #define __dma_omap15xx(d) (dma_omap1() && (d)->dev_caps & ENABLE_1510_MODE)
290 #define __dma_omap16xx(d) (dma_omap1() && (d)->dev_caps & ENABLE_16XX_MODE)
291 #define dma_omap15xx()	__dma_omap15xx(d)
292 #define dma_omap16xx()	__dma_omap16xx(d)
293 
294 extern struct omap_system_dma_plat_info *omap_get_plat_info(void);
295 
296 extern void omap_set_dma_priority(int lch, int dst_port, int priority);
297 extern int omap_request_dma(int dev_id, const char *dev_name,
298 			void (*callback)(int lch, u16 ch_status, void *data),
299 			void *data, int *dma_ch);
300 extern void omap_enable_dma_irq(int ch, u16 irq_bits);
301 extern void omap_disable_dma_irq(int ch, u16 irq_bits);
302 extern void omap_free_dma(int ch);
303 extern void omap_start_dma(int lch);
304 extern void omap_stop_dma(int lch);
305 extern void omap_set_dma_transfer_params(int lch, int data_type,
306 					 int elem_count, int frame_count,
307 					 int sync_mode,
308 					 int dma_trigger, int src_or_dst_synch);
309 extern void omap_set_dma_color_mode(int lch, enum omap_dma_color_mode mode,
310 				    u32 color);
311 extern void omap_set_dma_write_mode(int lch, enum omap_dma_write_mode mode);
312 extern void omap_set_dma_channel_mode(int lch, enum omap_dma_channel_mode mode);
313 
314 extern void omap_set_dma_src_params(int lch, int src_port, int src_amode,
315 				    unsigned long src_start,
316 				    int src_ei, int src_fi);
317 extern void omap_set_dma_src_index(int lch, int eidx, int fidx);
318 extern void omap_set_dma_src_data_pack(int lch, int enable);
319 extern void omap_set_dma_src_burst_mode(int lch,
320 					enum omap_dma_burst_mode burst_mode);
321 
322 extern void omap_set_dma_dest_params(int lch, int dest_port, int dest_amode,
323 				     unsigned long dest_start,
324 				     int dst_ei, int dst_fi);
325 extern void omap_set_dma_dest_index(int lch, int eidx, int fidx);
326 extern void omap_set_dma_dest_data_pack(int lch, int enable);
327 extern void omap_set_dma_dest_burst_mode(int lch,
328 					 enum omap_dma_burst_mode burst_mode);
329 
330 extern void omap_set_dma_params(int lch,
331 				struct omap_dma_channel_params *params);
332 
333 extern void omap_dma_link_lch(int lch_head, int lch_queue);
334 extern void omap_dma_unlink_lch(int lch_head, int lch_queue);
335 
336 extern int omap_set_dma_callback(int lch,
337 			void (*callback)(int lch, u16 ch_status, void *data),
338 			void *data);
339 extern dma_addr_t omap_get_dma_src_pos(int lch);
340 extern dma_addr_t omap_get_dma_dst_pos(int lch);
341 extern void omap_clear_dma(int lch);
342 extern int omap_get_dma_active_status(int lch);
343 extern int omap_dma_running(void);
344 extern void omap_dma_set_global_params(int arb_rate, int max_fifo_depth,
345 				       int tparams);
346 extern int omap_dma_set_prio_lch(int lch, unsigned char read_prio,
347 				 unsigned char write_prio);
348 extern void omap_set_dma_dst_endian_type(int lch, enum end_type etype);
349 extern void omap_set_dma_src_endian_type(int lch, enum end_type etype);
350 extern int omap_get_dma_index(int lch, int *ei, int *fi);
351 
352 void omap_dma_global_context_save(void);
353 void omap_dma_global_context_restore(void);
354 
355 extern void omap_dma_disable_irq(int lch);
356 
357 /* Chaining APIs */
358 #ifndef CONFIG_ARCH_OMAP1
359 extern int omap_request_dma_chain(int dev_id, const char *dev_name,
360 				  void (*callback) (int lch, u16 ch_status,
361 						    void *data),
362 				  int *chain_id, int no_of_chans,
363 				  int chain_mode,
364 				  struct omap_dma_channel_params params);
365 extern int omap_free_dma_chain(int chain_id);
366 extern int omap_dma_chain_a_transfer(int chain_id, int src_start,
367 				     int dest_start, int elem_count,
368 				     int frame_count, void *callbk_data);
369 extern int omap_start_dma_chain_transfers(int chain_id);
370 extern int omap_stop_dma_chain_transfers(int chain_id);
371 extern int omap_get_dma_chain_index(int chain_id, int *ei, int *fi);
372 extern int omap_get_dma_chain_dst_pos(int chain_id);
373 extern int omap_get_dma_chain_src_pos(int chain_id);
374 
375 extern int omap_modify_dma_chain_params(int chain_id,
376 					struct omap_dma_channel_params params);
377 extern int omap_dma_chain_status(int chain_id);
378 #endif
379 
380 #if defined(CONFIG_ARCH_OMAP1) && IS_ENABLED(CONFIG_FB_OMAP)
381 #include <mach/lcd_dma.h>
382 #else
383 static inline int omap_lcd_dma_running(void)
384 {
385 	return 0;
386 }
387 #endif
388 
389 #endif /* __LINUX_OMAP_DMA_H */
390