1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/arch/arm/plat-omap/dma.c
5 * Copyright (C) 2003 - 2008 Nokia Corporation
6 * Author: Juha Yrjölä <juha.yrjola@nokia.com>
7 * DMA channel linking for 1610 by Samuel Ortiz <samuel.ortiz@nokia.com>
8 * Graphics DMA and LCD DMA graphics tranformations
9 * by Imre Deak <imre.deak@nokia.com>
10 * OMAP2/3 support Copyright (C) 2004-2007 Texas Instruments, Inc.
11 * Merged to support both OMAP1 and OMAP2 by Tony Lindgren <tony@atomide.com>
12 * Some functions based on earlier dma-omap.c Copyright (C) 2001 RidgeRun, Inc.
14 * Copyright (C) 2009 Texas Instruments
15 * Added OMAP4 support - Santosh Shilimkar <santosh.shilimkar@ti.com>
17 * Support functions for the OMAP internal DMA channels.
19 * Copyright (C) 2010 Texas Instruments Incorporated - https://www.ti.com/
20 * Converted DMA library into DMA platform driver.
21 * - G, Manjunath Kondaiah <manjugk@ti.com>
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/sched.h>
27 #include <linux/spinlock.h>
28 #include <linux/errno.h>
29 #include <linux/interrupt.h>
30 #include <linux/irq.h>
32 #include <linux/slab.h>
33 #include <linux/delay.h>
35 #include <linux/omap-dma.h>
37 #include <linux/soc/ti/omap1-io.h>
38 #include <linux/soc/ti/omap1-soc.h>
43 * MAX_LOGICAL_DMA_CH_COUNT: the maximum number of logical DMA
44 * channels that an instance of the SDMA IP block can support. Used
45 * to size arrays. (The actual maximum on a particular SoC may be less
46 * than this -- for example, OMAP1 SDMA instances only support 17 logical
49 #define MAX_LOGICAL_DMA_CH_COUNT 32
53 #define OMAP_DMA_ACTIVE 0x01
55 #define OMAP_FUNC_MUX_ARM_BASE (0xfffe1000 + 0xec)
57 static struct omap_system_dma_plat_info *p;
58 static struct omap_dma_dev_attr *d;
59 static int enable_1510_mode;
62 struct dma_link_info {
64 int no_of_lchs_linked;
75 static int dma_lch_count;
76 static int dma_chan_count;
77 static int omap_dma_reserve_channels;
79 static DEFINE_SPINLOCK(dma_chan_lock);
80 static struct omap_dma_lch *dma_chan;
82 static inline void omap_disable_channel_irq(int lch)
84 /* disable channel interrupts */
85 p->dma_write(0, CICR, lch);
87 p->dma_read(CSR, lch);
90 static inline void set_gdma_dev(int req, int dev)
92 u32 reg = OMAP_FUNC_MUX_ARM_BASE + ((req - 1) / 5) * 4;
93 int shift = ((req - 1) % 5) * 6;
97 l &= ~(0x3f << shift);
98 l |= (dev - 1) << shift;
102 #if IS_ENABLED(CONFIG_FB_OMAP)
103 void omap_set_dma_priority(int lch, int dst_port, int priority)
110 case OMAP_DMA_PORT_OCP_T1: /* FFFECC00 */
111 reg = OMAP_TC_OCPT1_PRIOR;
113 case OMAP_DMA_PORT_OCP_T2: /* FFFECCD0 */
114 reg = OMAP_TC_OCPT2_PRIOR;
116 case OMAP_DMA_PORT_EMIFF: /* FFFECC08 */
117 reg = OMAP_TC_EMIFF_PRIOR;
119 case OMAP_DMA_PORT_EMIFS: /* FFFECC04 */
120 reg = OMAP_TC_EMIFS_PRIOR;
128 l |= (priority & 0xf) << 8;
132 EXPORT_SYMBOL(omap_set_dma_priority);
135 #if IS_ENABLED(CONFIG_USB_OMAP)
136 #ifdef CONFIG_ARCH_OMAP15XX
137 /* Returns 1 if the DMA module is in OMAP1510-compatible mode, 0 otherwise */
138 static int omap_dma_in_1510_mode(void)
140 return enable_1510_mode;
143 #define omap_dma_in_1510_mode() 0
146 void omap_set_dma_transfer_params(int lch, int data_type, int elem_count,
147 int frame_count, int sync_mode,
148 int dma_trigger, int src_or_dst_synch)
153 l = p->dma_read(CSDP, lch);
156 p->dma_write(l, CSDP, lch);
158 ccr = p->dma_read(CCR, lch);
160 if (sync_mode == OMAP_DMA_SYNC_FRAME)
162 p->dma_write(ccr, CCR, lch);
164 ccr = p->dma_read(CCR2, lch);
166 if (sync_mode == OMAP_DMA_SYNC_BLOCK)
168 p->dma_write(ccr, CCR2, lch);
169 p->dma_write(elem_count, CEN, lch);
170 p->dma_write(frame_count, CFN, lch);
172 EXPORT_SYMBOL(omap_set_dma_transfer_params);
174 void omap_set_dma_channel_mode(int lch, enum omap_dma_channel_mode mode)
176 if (!dma_omap15xx()) {
179 l = p->dma_read(LCH_CTRL, lch);
182 p->dma_write(l, LCH_CTRL, lch);
185 EXPORT_SYMBOL(omap_set_dma_channel_mode);
187 /* Note that src_port is only for omap1 */
188 void omap_set_dma_src_params(int lch, int src_port, int src_amode,
189 unsigned long src_start,
190 int src_ei, int src_fi)
195 w = p->dma_read(CSDP, lch);
198 p->dma_write(w, CSDP, lch);
200 l = p->dma_read(CCR, lch);
202 l |= src_amode << 12;
203 p->dma_write(l, CCR, lch);
205 p->dma_write(src_start, CSSA, lch);
207 p->dma_write(src_ei, CSEI, lch);
208 p->dma_write(src_fi, CSFI, lch);
210 EXPORT_SYMBOL(omap_set_dma_src_params);
212 void omap_set_dma_src_data_pack(int lch, int enable)
216 l = p->dma_read(CSDP, lch);
220 p->dma_write(l, CSDP, lch);
222 EXPORT_SYMBOL(omap_set_dma_src_data_pack);
224 void omap_set_dma_src_burst_mode(int lch, enum omap_dma_burst_mode burst_mode)
226 unsigned int burst = 0;
229 l = p->dma_read(CSDP, lch);
232 switch (burst_mode) {
233 case OMAP_DMA_DATA_BURST_DIS:
235 case OMAP_DMA_DATA_BURST_4:
238 case OMAP_DMA_DATA_BURST_8:
240 * not supported by current hardware on OMAP1
244 case OMAP_DMA_DATA_BURST_16:
245 /* OMAP1 don't support burst 16 */
252 p->dma_write(l, CSDP, lch);
254 EXPORT_SYMBOL(omap_set_dma_src_burst_mode);
256 /* Note that dest_port is only for OMAP1 */
257 void omap_set_dma_dest_params(int lch, int dest_port, int dest_amode,
258 unsigned long dest_start,
259 int dst_ei, int dst_fi)
263 l = p->dma_read(CSDP, lch);
266 p->dma_write(l, CSDP, lch);
268 l = p->dma_read(CCR, lch);
270 l |= dest_amode << 14;
271 p->dma_write(l, CCR, lch);
273 p->dma_write(dest_start, CDSA, lch);
275 p->dma_write(dst_ei, CDEI, lch);
276 p->dma_write(dst_fi, CDFI, lch);
278 EXPORT_SYMBOL(omap_set_dma_dest_params);
280 void omap_set_dma_dest_data_pack(int lch, int enable)
284 l = p->dma_read(CSDP, lch);
288 p->dma_write(l, CSDP, lch);
290 EXPORT_SYMBOL(omap_set_dma_dest_data_pack);
292 void omap_set_dma_dest_burst_mode(int lch, enum omap_dma_burst_mode burst_mode)
294 unsigned int burst = 0;
297 l = p->dma_read(CSDP, lch);
300 switch (burst_mode) {
301 case OMAP_DMA_DATA_BURST_DIS:
303 case OMAP_DMA_DATA_BURST_4:
306 case OMAP_DMA_DATA_BURST_8:
309 case OMAP_DMA_DATA_BURST_16:
310 /* OMAP1 don't support burst 16 */
313 printk(KERN_ERR "Invalid DMA burst mode\n");
318 p->dma_write(l, CSDP, lch);
320 EXPORT_SYMBOL(omap_set_dma_dest_burst_mode);
322 static inline void omap_enable_channel_irq(int lch)
325 p->dma_read(CSR, lch);
327 /* Enable some nice interrupts. */
328 p->dma_write(dma_chan[lch].enabled_irqs, CICR, lch);
331 void omap_disable_dma_irq(int lch, u16 bits)
333 dma_chan[lch].enabled_irqs &= ~bits;
335 EXPORT_SYMBOL(omap_disable_dma_irq);
337 static inline void enable_lnk(int lch)
341 l = p->dma_read(CLNK_CTRL, lch);
345 /* Set the ENABLE_LNK bits */
346 if (dma_chan[lch].next_lch != -1)
347 l = dma_chan[lch].next_lch | (1 << 15);
349 p->dma_write(l, CLNK_CTRL, lch);
352 static inline void disable_lnk(int lch)
356 l = p->dma_read(CLNK_CTRL, lch);
358 /* Disable interrupts */
359 omap_disable_channel_irq(lch);
361 /* Set the STOP_LNK bit */
364 p->dma_write(l, CLNK_CTRL, lch);
365 dma_chan[lch].flags &= ~OMAP_DMA_ACTIVE;
369 int omap_request_dma(int dev_id, const char *dev_name,
370 void (*callback)(int lch, u16 ch_status, void *data),
371 void *data, int *dma_ch_out)
373 int ch, free_ch = -1;
375 struct omap_dma_lch *chan;
377 WARN(strcmp(dev_name, "DMA engine"), "Using deprecated platform DMA API - please update to DMA engine");
379 spin_lock_irqsave(&dma_chan_lock, flags);
380 for (ch = 0; ch < dma_chan_count; ch++) {
381 if (free_ch == -1 && dma_chan[ch].dev_id == -1) {
383 /* Exit after first free channel found */
388 spin_unlock_irqrestore(&dma_chan_lock, flags);
391 chan = dma_chan + free_ch;
392 chan->dev_id = dev_id;
394 if (p->clear_lch_regs)
395 p->clear_lch_regs(free_ch);
397 spin_unlock_irqrestore(&dma_chan_lock, flags);
399 chan->dev_name = dev_name;
400 chan->callback = callback;
404 chan->enabled_irqs = OMAP_DMA_DROP_IRQ | OMAP_DMA_BLOCK_IRQ;
406 chan->enabled_irqs |= OMAP1_DMA_TOUT_IRQ;
408 if (dma_omap16xx()) {
409 /* If the sync device is set, configure it dynamically. */
411 set_gdma_dev(free_ch + 1, dev_id);
412 dev_id = free_ch + 1;
415 * Disable the 1510 compatibility mode and set the sync device
418 p->dma_write(dev_id | (1 << 10), CCR, free_ch);
420 p->dma_write(dev_id, CCR, free_ch);
423 *dma_ch_out = free_ch;
427 EXPORT_SYMBOL(omap_request_dma);
429 void omap_free_dma(int lch)
433 if (dma_chan[lch].dev_id == -1) {
434 pr_err("omap_dma: trying to free unallocated DMA channel %d\n",
439 /* Disable all DMA interrupts for the channel. */
440 omap_disable_channel_irq(lch);
442 /* Make sure the DMA transfer is stopped. */
443 p->dma_write(0, CCR, lch);
445 spin_lock_irqsave(&dma_chan_lock, flags);
446 dma_chan[lch].dev_id = -1;
447 dma_chan[lch].next_lch = -1;
448 dma_chan[lch].callback = NULL;
449 spin_unlock_irqrestore(&dma_chan_lock, flags);
451 EXPORT_SYMBOL(omap_free_dma);
454 * Clears any DMA state so the DMA engine is ready to restart with new buffers
455 * through omap_start_dma(). Any buffers in flight are discarded.
457 static void omap_clear_dma(int lch)
461 local_irq_save(flags);
463 local_irq_restore(flags);
466 #if IS_ENABLED(CONFIG_USB_OMAP)
467 void omap_start_dma(int lch)
472 * The CPC/CDAC register needs to be initialized to zero
473 * before starting dma transfer.
476 p->dma_write(0, CPC, lch);
478 p->dma_write(0, CDAC, lch);
480 if (!omap_dma_in_1510_mode() && dma_chan[lch].next_lch != -1) {
481 int next_lch, cur_lch;
482 char dma_chan_link_map[MAX_LOGICAL_DMA_CH_COUNT];
484 /* Set the link register of the first channel */
487 memset(dma_chan_link_map, 0, sizeof(dma_chan_link_map));
488 dma_chan_link_map[lch] = 1;
490 cur_lch = dma_chan[lch].next_lch;
492 next_lch = dma_chan[cur_lch].next_lch;
494 /* The loop case: we've been here already */
495 if (dma_chan_link_map[cur_lch])
497 /* Mark the current channel */
498 dma_chan_link_map[cur_lch] = 1;
501 omap_enable_channel_irq(cur_lch);
504 } while (next_lch != -1);
505 } else if (IS_DMA_ERRATA(DMA_ERRATA_PARALLEL_CHANNELS))
506 p->dma_write(lch, CLNK_CTRL, lch);
508 omap_enable_channel_irq(lch);
510 l = p->dma_read(CCR, lch);
512 if (IS_DMA_ERRATA(DMA_ERRATA_IFRAME_BUFFERING))
513 l |= OMAP_DMA_CCR_BUFFERING_DISABLE;
514 l |= OMAP_DMA_CCR_EN;
517 * As dma_write() uses IO accessors which are weakly ordered, there
518 * is no guarantee that data in coherent DMA memory will be visible
519 * to the DMA device. Add a memory barrier here to ensure that any
520 * such data is visible prior to enabling DMA.
523 p->dma_write(l, CCR, lch);
525 dma_chan[lch].flags |= OMAP_DMA_ACTIVE;
527 EXPORT_SYMBOL(omap_start_dma);
529 void omap_stop_dma(int lch)
533 /* Disable all interrupts on the channel */
534 omap_disable_channel_irq(lch);
536 l = p->dma_read(CCR, lch);
537 if (IS_DMA_ERRATA(DMA_ERRATA_i541) &&
538 (l & OMAP_DMA_CCR_SEL_SRC_DST_SYNC)) {
542 /* Configure No-Standby */
543 l = p->dma_read(OCP_SYSCONFIG, lch);
545 l &= ~DMA_SYSCONFIG_MIDLEMODE_MASK;
546 l |= DMA_SYSCONFIG_MIDLEMODE(DMA_IDLEMODE_NO_IDLE);
547 p->dma_write(l , OCP_SYSCONFIG, 0);
549 l = p->dma_read(CCR, lch);
550 l &= ~OMAP_DMA_CCR_EN;
551 p->dma_write(l, CCR, lch);
553 /* Wait for sDMA FIFO drain */
554 l = p->dma_read(CCR, lch);
555 while (i < 100 && (l & (OMAP_DMA_CCR_RD_ACTIVE |
556 OMAP_DMA_CCR_WR_ACTIVE))) {
559 l = p->dma_read(CCR, lch);
562 pr_err("DMA drain did not complete on lch %d\n", lch);
563 /* Restore OCP_SYSCONFIG */
564 p->dma_write(sys_cf, OCP_SYSCONFIG, lch);
566 l &= ~OMAP_DMA_CCR_EN;
567 p->dma_write(l, CCR, lch);
571 * Ensure that data transferred by DMA is visible to any access
572 * after DMA has been disabled. This is important for coherent
577 if (!omap_dma_in_1510_mode() && dma_chan[lch].next_lch != -1) {
578 int next_lch, cur_lch = lch;
579 char dma_chan_link_map[MAX_LOGICAL_DMA_CH_COUNT];
581 memset(dma_chan_link_map, 0, sizeof(dma_chan_link_map));
583 /* The loop case: we've been here already */
584 if (dma_chan_link_map[cur_lch])
586 /* Mark the current channel */
587 dma_chan_link_map[cur_lch] = 1;
589 disable_lnk(cur_lch);
591 next_lch = dma_chan[cur_lch].next_lch;
593 } while (next_lch != -1);
596 dma_chan[lch].flags &= ~OMAP_DMA_ACTIVE;
598 EXPORT_SYMBOL(omap_stop_dma);
601 * Allows changing the DMA callback function or data. This may be needed if
602 * the driver shares a single DMA channel for multiple dma triggers.
605 * Returns current physical source address for the given DMA channel.
606 * If the channel is running the caller must disable interrupts prior calling
607 * this function and process the returned value before re-enabling interrupt to
608 * prevent races with the interrupt handler. Note that in continuous mode there
609 * is a chance for CSSA_L register overflow between the two reads resulting
610 * in incorrect return value.
612 dma_addr_t omap_get_dma_src_pos(int lch)
614 dma_addr_t offset = 0;
617 offset = p->dma_read(CPC, lch);
619 offset = p->dma_read(CSAC, lch);
621 if (IS_DMA_ERRATA(DMA_ERRATA_3_3) && offset == 0)
622 offset = p->dma_read(CSAC, lch);
624 if (!dma_omap15xx()) {
626 * CDAC == 0 indicates that the DMA transfer on the channel has
627 * not been started (no data has been transferred so far).
628 * Return the programmed source start address in this case.
630 if (likely(p->dma_read(CDAC, lch)))
631 offset = p->dma_read(CSAC, lch);
633 offset = p->dma_read(CSSA, lch);
636 offset |= (p->dma_read(CSSA, lch) & 0xFFFF0000);
640 EXPORT_SYMBOL(omap_get_dma_src_pos);
643 * Returns current physical destination address for the given DMA channel.
644 * If the channel is running the caller must disable interrupts prior calling
645 * this function and process the returned value before re-enabling interrupt to
646 * prevent races with the interrupt handler. Note that in continuous mode there
647 * is a chance for CDSA_L register overflow between the two reads resulting
648 * in incorrect return value.
650 dma_addr_t omap_get_dma_dst_pos(int lch)
652 dma_addr_t offset = 0;
655 offset = p->dma_read(CPC, lch);
657 offset = p->dma_read(CDAC, lch);
660 * omap 3.2/3.3 erratum: sometimes 0 is returned if CSAC/CDAC is
661 * read before the DMA controller finished disabling the channel.
663 if (!dma_omap15xx() && offset == 0) {
664 offset = p->dma_read(CDAC, lch);
666 * CDAC == 0 indicates that the DMA transfer on the channel has
667 * not been started (no data has been transferred so far).
668 * Return the programmed destination start address in this case.
670 if (unlikely(!offset))
671 offset = p->dma_read(CDSA, lch);
674 offset |= (p->dma_read(CDSA, lch) & 0xFFFF0000);
678 EXPORT_SYMBOL(omap_get_dma_dst_pos);
680 int omap_get_dma_active_status(int lch)
682 return (p->dma_read(CCR, lch) & OMAP_DMA_CCR_EN) != 0;
684 EXPORT_SYMBOL(omap_get_dma_active_status);
687 int omap_dma_running(void)
691 if (omap_lcd_dma_running())
694 for (lch = 0; lch < dma_chan_count; lch++)
695 if (p->dma_read(CCR, lch) & OMAP_DMA_CCR_EN)
701 /*----------------------------------------------------------------------------*/
703 static int omap1_dma_handle_ch(int ch)
707 if (enable_1510_mode && ch >= 6) {
708 csr = dma_chan[ch].saved_csr;
709 dma_chan[ch].saved_csr = 0;
711 csr = p->dma_read(CSR, ch);
712 if (enable_1510_mode && ch <= 2 && (csr >> 7) != 0) {
713 dma_chan[ch + 6].saved_csr = csr >> 7;
716 if ((csr & 0x3f) == 0)
718 if (unlikely(dma_chan[ch].dev_id == -1)) {
719 pr_warn("Spurious interrupt from DMA channel %d (CSR %04x)\n",
723 if (unlikely(csr & OMAP1_DMA_TOUT_IRQ))
724 pr_warn("DMA timeout with device %d\n", dma_chan[ch].dev_id);
725 if (unlikely(csr & OMAP_DMA_DROP_IRQ))
726 pr_warn("DMA synchronization event drop occurred with device %d\n",
727 dma_chan[ch].dev_id);
728 if (likely(csr & OMAP_DMA_BLOCK_IRQ))
729 dma_chan[ch].flags &= ~OMAP_DMA_ACTIVE;
730 if (likely(dma_chan[ch].callback != NULL))
731 dma_chan[ch].callback(ch, csr, dma_chan[ch].data);
736 static irqreturn_t omap1_dma_irq_handler(int irq, void *dev_id)
738 int ch = ((int) dev_id) - 1;
744 handled_now += omap1_dma_handle_ch(ch);
745 if (enable_1510_mode && dma_chan[ch + 6].saved_csr)
746 handled_now += omap1_dma_handle_ch(ch + 6);
749 handled += handled_now;
752 return handled ? IRQ_HANDLED : IRQ_NONE;
755 struct omap_system_dma_plat_info *omap_get_plat_info(void)
759 EXPORT_SYMBOL_GPL(omap_get_plat_info);
761 static int omap_system_dma_probe(struct platform_device *pdev)
767 p = pdev->dev.platform_data;
770 "%s: System DMA initialized without platform data\n",
778 if ((d->dev_caps & RESERVE_CHANNEL) && omap_dma_reserve_channels
779 && (omap_dma_reserve_channels < d->lch_count))
780 d->lch_count = omap_dma_reserve_channels;
782 dma_lch_count = d->lch_count;
783 dma_chan_count = dma_lch_count;
784 enable_1510_mode = d->dev_caps & ENABLE_1510_MODE;
786 dma_chan = devm_kcalloc(&pdev->dev, dma_lch_count,
787 sizeof(*dma_chan), GFP_KERNEL);
791 for (ch = 0; ch < dma_chan_count; ch++) {
794 dma_chan[ch].dev_id = -1;
795 dma_chan[ch].next_lch = -1;
797 if (ch >= 6 && enable_1510_mode)
801 * request_irq() doesn't like dev_id (ie. ch) being
802 * zero, so we have to kludge around this.
804 sprintf(&irq_name[0], "%d", ch);
805 dma_irq = platform_get_irq_byname(pdev, irq_name);
809 goto exit_dma_irq_fail;
812 /* INT_DMA_LCD is handled in lcd_dma.c */
813 if (dma_irq == INT_DMA_LCD)
816 ret = request_irq(dma_irq,
817 omap1_dma_irq_handler, 0, "DMA",
820 goto exit_dma_irq_fail;
823 /* reserve dma channels 0 and 1 in high security devices on 34xx */
824 if (d->dev_caps & HS_CHANNELS_RESERVED) {
825 pr_info("Reserving DMA channels 0 and 1 for HS ROM code\n");
826 dma_chan[0].dev_id = 0;
827 dma_chan[1].dev_id = 1;
836 static int omap_system_dma_remove(struct platform_device *pdev)
838 int dma_irq, irq_rel = 0;
840 for ( ; irq_rel < dma_chan_count; irq_rel++) {
841 dma_irq = platform_get_irq(pdev, irq_rel);
842 free_irq(dma_irq, (void *)(irq_rel + 1));
848 static struct platform_driver omap_system_dma_driver = {
849 .probe = omap_system_dma_probe,
850 .remove = omap_system_dma_remove,
852 .name = "omap_dma_system"
856 static int __init omap_system_dma_init(void)
858 return platform_driver_register(&omap_system_dma_driver);
860 arch_initcall(omap_system_dma_init);
862 static void __exit omap_system_dma_exit(void)
864 platform_driver_unregister(&omap_system_dma_driver);
867 MODULE_DESCRIPTION("OMAP SYSTEM DMA DRIVER");
868 MODULE_LICENSE("GPL");
869 MODULE_AUTHOR("Texas Instruments Inc");
872 * Reserve the omap SDMA channels using cmdline bootarg
873 * "omap_dma_reserve_ch=". The valid range is 1 to 32
875 static int __init omap_dma_cmdline_reserve_ch(char *str)
877 if (get_option(&str, &omap_dma_reserve_channels) != 1)
878 omap_dma_reserve_channels = 0;
882 __setup("omap_dma_reserve_ch=", omap_dma_cmdline_reserve_ch);