1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_OMAP_DMA_H
3 #define __LINUX_OMAP_DMA_H
4 #include <linux/omap-dmaengine.h>
7 * Legacy OMAP DMA handling defines and functions
9 * NOTE: Do not use these any longer.
11 * Use the generic dmaengine functions as defined in
12 * include/linux/dmaengine.h.
14 * Copyright (C) 2003 Nokia Corporation
15 * Author: Juha Yrjölä <juha.yrjola@nokia.com>
19 #include <linux/platform_device.h>
21 #define INT_DMA_LCD (NR_IRQS_LEGACY + 25)
23 #define OMAP1_DMA_TOUT_IRQ (1 << 0)
24 #define OMAP_DMA_DROP_IRQ (1 << 1)
25 #define OMAP_DMA_HALF_IRQ (1 << 2)
26 #define OMAP_DMA_FRAME_IRQ (1 << 3)
27 #define OMAP_DMA_LAST_IRQ (1 << 4)
28 #define OMAP_DMA_BLOCK_IRQ (1 << 5)
29 #define OMAP1_DMA_SYNC_IRQ (1 << 6)
30 #define OMAP2_DMA_PKT_IRQ (1 << 7)
31 #define OMAP2_DMA_TRANS_ERR_IRQ (1 << 8)
32 #define OMAP2_DMA_SECURE_ERR_IRQ (1 << 9)
33 #define OMAP2_DMA_SUPERVISOR_ERR_IRQ (1 << 10)
34 #define OMAP2_DMA_MISALIGNED_ERR_IRQ (1 << 11)
36 #define OMAP_DMA_CCR_EN (1 << 7)
37 #define OMAP_DMA_CCR_RD_ACTIVE (1 << 9)
38 #define OMAP_DMA_CCR_WR_ACTIVE (1 << 10)
39 #define OMAP_DMA_CCR_SEL_SRC_DST_SYNC (1 << 24)
40 #define OMAP_DMA_CCR_BUFFERING_DISABLE (1 << 25)
42 #define OMAP_DMA_DATA_TYPE_S8 0x00
43 #define OMAP_DMA_DATA_TYPE_S16 0x01
44 #define OMAP_DMA_DATA_TYPE_S32 0x02
46 #define OMAP_DMA_SYNC_ELEMENT 0x00
47 #define OMAP_DMA_SYNC_FRAME 0x01
48 #define OMAP_DMA_SYNC_BLOCK 0x02
49 #define OMAP_DMA_SYNC_PACKET 0x03
51 #define OMAP_DMA_DST_SYNC_PREFETCH 0x02
52 #define OMAP_DMA_SRC_SYNC 0x01
53 #define OMAP_DMA_DST_SYNC 0x00
55 #define OMAP_DMA_PORT_EMIFF 0x00
56 #define OMAP_DMA_PORT_EMIFS 0x01
57 #define OMAP_DMA_PORT_OCP_T1 0x02
58 #define OMAP_DMA_PORT_TIPB 0x03
59 #define OMAP_DMA_PORT_OCP_T2 0x04
60 #define OMAP_DMA_PORT_MPUI 0x05
62 #define OMAP_DMA_AMODE_CONSTANT 0x00
63 #define OMAP_DMA_AMODE_POST_INC 0x01
64 #define OMAP_DMA_AMODE_SINGLE_IDX 0x02
65 #define OMAP_DMA_AMODE_DOUBLE_IDX 0x03
67 #define DMA_DEFAULT_FIFO_DEPTH 0x10
68 #define DMA_DEFAULT_ARB_RATE 0x01
69 /* Pass THREAD_RESERVE ORed with THREAD_FIFO for tparams */
70 #define DMA_THREAD_RESERVE_NORM (0x00 << 12) /* Def */
71 #define DMA_THREAD_RESERVE_ONET (0x01 << 12)
72 #define DMA_THREAD_RESERVE_TWOT (0x02 << 12)
73 #define DMA_THREAD_RESERVE_THREET (0x03 << 12)
74 #define DMA_THREAD_FIFO_NONE (0x00 << 14) /* Def */
75 #define DMA_THREAD_FIFO_75 (0x01 << 14)
76 #define DMA_THREAD_FIFO_25 (0x02 << 14)
77 #define DMA_THREAD_FIFO_50 (0x03 << 14)
79 /* DMA4_OCP_SYSCONFIG bits */
80 #define DMA_SYSCONFIG_MIDLEMODE_MASK (3 << 12)
81 #define DMA_SYSCONFIG_CLOCKACTIVITY_MASK (3 << 8)
82 #define DMA_SYSCONFIG_EMUFREE (1 << 5)
83 #define DMA_SYSCONFIG_SIDLEMODE_MASK (3 << 3)
84 #define DMA_SYSCONFIG_SOFTRESET (1 << 2)
85 #define DMA_SYSCONFIG_AUTOIDLE (1 << 0)
87 #define DMA_SYSCONFIG_MIDLEMODE(n) ((n) << 12)
88 #define DMA_SYSCONFIG_SIDLEMODE(n) ((n) << 3)
90 #define DMA_IDLEMODE_SMARTIDLE 0x2
91 #define DMA_IDLEMODE_NO_IDLE 0x1
92 #define DMA_IDLEMODE_FORCE_IDLE 0x0
95 #ifndef CONFIG_ARCH_OMAP1
96 #define OMAP_DMA_STATIC_CHAIN 0x1
97 #define OMAP_DMA_DYNAMIC_CHAIN 0x2
98 #define OMAP_DMA_CHAIN_ACTIVE 0x1
99 #define OMAP_DMA_CHAIN_INACTIVE 0x0
102 #define DMA_CH_PRIO_HIGH 0x1
103 #define DMA_CH_PRIO_LOW 0x0 /* Def */
105 /* Errata handling */
106 #define IS_DMA_ERRATA(id) (errata & (id))
107 #define SET_DMA_ERRATA(id) (errata |= (id))
109 #define DMA_ERRATA_IFRAME_BUFFERING BIT(0x0)
110 #define DMA_ERRATA_PARALLEL_CHANNELS BIT(0x1)
111 #define DMA_ERRATA_i378 BIT(0x2)
112 #define DMA_ERRATA_i541 BIT(0x3)
113 #define DMA_ERRATA_i88 BIT(0x4)
114 #define DMA_ERRATA_3_3 BIT(0x5)
115 #define DMA_ROMCODE_BUG BIT(0x6)
117 /* Attributes for OMAP DMA Contrller */
118 #define DMA_LINKED_LCH BIT(0x0)
119 #define GLOBAL_PRIORITY BIT(0x1)
120 #define RESERVE_CHANNEL BIT(0x2)
121 #define IS_CSSA_32 BIT(0x3)
122 #define IS_CDSA_32 BIT(0x4)
123 #define IS_RW_PRIORITY BIT(0x5)
124 #define ENABLE_1510_MODE BIT(0x6)
125 #define SRC_PORT BIT(0x7)
126 #define DST_PORT BIT(0x8)
127 #define SRC_INDEX BIT(0x9)
128 #define DST_INDEX BIT(0xa)
129 #define IS_BURST_ONLY4 BIT(0xb)
130 #define CLEAR_CSR_ON_READ BIT(0xc)
131 #define IS_WORD_16 BIT(0xd)
132 #define ENABLE_16XX_MODE BIT(0xe)
133 #define HS_CHANNELS_RESERVED BIT(0xf)
134 #define DMA_ENGINE_HANDLE_IRQ BIT(0x10)
136 /* Defines for DMA Capabilities */
137 #define DMA_HAS_TRANSPARENT_CAPS (0x1 << 18)
138 #define DMA_HAS_CONSTANT_FILL_CAPS (0x1 << 19)
139 #define DMA_HAS_DESCRIPTOR_CAPS (0x3 << 20)
141 enum omap_reg_offsets {
143 GCR, GSCR, GRST1, HW_ID,
144 PCH2_ID, PCH0_ID, PCH1_ID, PCHG_ID,
145 PCHD_ID, CAPS_0, CAPS_1, CAPS_2,
146 CAPS_3, CAPS_4, PCH2_SR, PCH0_SR,
147 PCH1_SR, PCHD_SR, REVISION, IRQSTATUS_L0,
148 IRQSTATUS_L1, IRQSTATUS_L2, IRQSTATUS_L3, IRQENABLE_L0,
149 IRQENABLE_L1, IRQENABLE_L2, IRQENABLE_L3, SYSSTATUS,
152 /* omap1+ specific */
155 /* Common registers for all omap's */
156 CSDP, CCR, CICR, CSR,
157 CEN, CFN, CSFI, CSEI,
161 /* Channel specific registers */
165 /* omap3630 and omap4 specific */
170 enum omap_dma_burst_mode {
171 OMAP_DMA_DATA_BURST_DIS = 0,
172 OMAP_DMA_DATA_BURST_4,
173 OMAP_DMA_DATA_BURST_8,
174 OMAP_DMA_DATA_BURST_16,
178 OMAP_DMA_LITTLE_ENDIAN = 0,
182 enum omap_dma_color_mode {
183 OMAP_DMA_COLOR_DIS = 0,
184 OMAP_DMA_CONSTANT_FILL,
185 OMAP_DMA_TRANSPARENT_COPY
188 enum omap_dma_write_mode {
189 OMAP_DMA_WRITE_NON_POSTED = 0,
190 OMAP_DMA_WRITE_POSTED,
191 OMAP_DMA_WRITE_LAST_NON_POSTED
194 enum omap_dma_channel_mode {
201 struct omap_dma_channel_params {
202 int data_type; /* data type 8,16,32 */
203 int elem_count; /* number of elements in a frame */
204 int frame_count; /* number of frames in a element */
206 int src_port; /* Only on OMAP1 REVISIT: Is this needed? */
207 int src_amode; /* constant, post increment, indexed,
209 unsigned long src_start; /* source address : physical */
210 int src_ei; /* source element index */
211 int src_fi; /* source frame index */
213 int dst_port; /* Only on OMAP1 REVISIT: Is this needed? */
214 int dst_amode; /* constant, post increment, indexed,
216 unsigned long dst_start; /* source address : physical */
217 int dst_ei; /* source element index */
218 int dst_fi; /* source frame index */
220 int trigger; /* trigger attached if the channel is
222 int sync_mode; /* sycn on element, frame , block or packet */
223 int src_or_dst_synch; /* source synch(1) or destination synch(0) */
225 int ie; /* interrupt enabled */
227 unsigned char read_prio;/* read priority */
228 unsigned char write_prio;/* write priority */
230 #ifndef CONFIG_ARCH_OMAP1
231 enum omap_dma_burst_mode burst_mode; /* Burst mode 4/8/16 words */
235 struct omap_dma_lch {
240 const char *dev_name;
241 void (*callback)(int lch, u16 ch_status, void *data);
244 /* required for Dynamic chaining */
252 struct omap_dma_dev_attr {
261 OMAP_DMA_REG_2X16BIT,
265 struct omap_dma_reg {
271 #define SDMA_FILTER_PARAM(hw_req) ((int[]) { (hw_req) })
272 struct dma_slave_map;
274 /* System DMA platform data structure */
275 struct omap_system_dma_plat_info {
276 const struct omap_dma_reg *reg_map;
277 unsigned channel_stride;
278 struct omap_dma_dev_attr *dma_attr;
280 void (*show_dma_caps)(void);
281 void (*clear_lch_regs)(int lch);
282 void (*clear_dma)(int lch);
283 void (*dma_write)(u32 val, int reg, int lch);
284 u32 (*dma_read)(int reg, int lch);
286 const struct dma_slave_map *slave_map;
290 #ifdef CONFIG_ARCH_OMAP2PLUS
291 #define dma_omap2plus() 1
293 #define dma_omap2plus() 0
295 #define dma_omap1() (!dma_omap2plus())
296 #define __dma_omap15xx(d) (dma_omap1() && (d)->dev_caps & ENABLE_1510_MODE)
297 #define __dma_omap16xx(d) (dma_omap1() && (d)->dev_caps & ENABLE_16XX_MODE)
298 #define dma_omap15xx() __dma_omap15xx(d)
299 #define dma_omap16xx() __dma_omap16xx(d)
301 #if defined(CONFIG_ARCH_OMAP)
302 extern struct omap_system_dma_plat_info *omap_get_plat_info(void);
304 extern void omap_set_dma_priority(int lch, int dst_port, int priority);
305 extern int omap_request_dma(int dev_id, const char *dev_name,
306 void (*callback)(int lch, u16 ch_status, void *data),
307 void *data, int *dma_ch);
308 extern void omap_enable_dma_irq(int ch, u16 irq_bits);
309 extern void omap_disable_dma_irq(int ch, u16 irq_bits);
310 extern void omap_free_dma(int ch);
311 extern void omap_start_dma(int lch);
312 extern void omap_stop_dma(int lch);
313 extern void omap_set_dma_transfer_params(int lch, int data_type,
314 int elem_count, int frame_count,
316 int dma_trigger, int src_or_dst_synch);
317 extern void omap_set_dma_write_mode(int lch, enum omap_dma_write_mode mode);
318 extern void omap_set_dma_channel_mode(int lch, enum omap_dma_channel_mode mode);
320 extern void omap_set_dma_src_params(int lch, int src_port, int src_amode,
321 unsigned long src_start,
322 int src_ei, int src_fi);
323 extern void omap_set_dma_src_data_pack(int lch, int enable);
324 extern void omap_set_dma_src_burst_mode(int lch,
325 enum omap_dma_burst_mode burst_mode);
327 extern void omap_set_dma_dest_params(int lch, int dest_port, int dest_amode,
328 unsigned long dest_start,
329 int dst_ei, int dst_fi);
330 extern void omap_set_dma_dest_data_pack(int lch, int enable);
331 extern void omap_set_dma_dest_burst_mode(int lch,
332 enum omap_dma_burst_mode burst_mode);
334 extern void omap_set_dma_params(int lch,
335 struct omap_dma_channel_params *params);
337 extern void omap_dma_link_lch(int lch_head, int lch_queue);
339 extern int omap_set_dma_callback(int lch,
340 void (*callback)(int lch, u16 ch_status, void *data),
342 extern dma_addr_t omap_get_dma_src_pos(int lch);
343 extern dma_addr_t omap_get_dma_dst_pos(int lch);
344 extern int omap_get_dma_active_status(int lch);
345 extern int omap_dma_running(void);
346 extern void omap_dma_set_global_params(int arb_rate, int max_fifo_depth,
348 void omap_dma_global_context_save(void);
349 void omap_dma_global_context_restore(void);
351 #if defined(CONFIG_ARCH_OMAP1) && IS_ENABLED(CONFIG_FB_OMAP)
352 #include <mach/lcd_dma.h>
354 static inline int omap_lcd_dma_running(void)
360 #else /* CONFIG_ARCH_OMAP */
362 static inline struct omap_system_dma_plat_info *omap_get_plat_info(void)
367 static inline int omap_request_dma(int dev_id, const char *dev_name,
368 void (*callback)(int lch, u16 ch_status, void *data),
369 void *data, int *dma_ch)
374 static inline void omap_free_dma(int ch) { }
376 #endif /* CONFIG_ARCH_OMAP */
378 #endif /* __LINUX_OMAP_DMA_H */