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 <mach/hardware.h>
38 #include <linux/soc/ti/omap1-io.h>
39 #include <linux/soc/ti/omap1-soc.h>
42 * MAX_LOGICAL_DMA_CH_COUNT: the maximum number of logical DMA
43 * channels that an instance of the SDMA IP block can support. Used
44 * to size arrays. (The actual maximum on a particular SoC may be less
45 * than this -- for example, OMAP1 SDMA instances only support 17 logical
48 #define MAX_LOGICAL_DMA_CH_COUNT 32
52 #define OMAP_DMA_ACTIVE 0x01
54 #define OMAP_FUNC_MUX_ARM_BASE (0xfffe1000 + 0xec)
56 static struct omap_system_dma_plat_info *p;
57 static struct omap_dma_dev_attr *d;
58 static int enable_1510_mode;
61 struct dma_link_info {
63 int no_of_lchs_linked;
74 static int dma_lch_count;
75 static int dma_chan_count;
76 static int omap_dma_reserve_channels;
78 static DEFINE_SPINLOCK(dma_chan_lock);
79 static struct omap_dma_lch *dma_chan;
81 static inline void omap_disable_channel_irq(int lch)
83 /* disable channel interrupts */
84 p->dma_write(0, CICR, lch);
86 p->dma_read(CSR, lch);
89 static inline void set_gdma_dev(int req, int dev)
91 u32 reg = OMAP_FUNC_MUX_ARM_BASE + ((req - 1) / 5) * 4;
92 int shift = ((req - 1) % 5) * 6;
96 l &= ~(0x3f << shift);
97 l |= (dev - 1) << shift;
101 #ifdef CONFIG_ARCH_OMAP1
102 void omap_set_dma_priority(int lch, int dst_port, int priority)
109 case OMAP_DMA_PORT_OCP_T1: /* FFFECC00 */
110 reg = OMAP_TC_OCPT1_PRIOR;
112 case OMAP_DMA_PORT_OCP_T2: /* FFFECCD0 */
113 reg = OMAP_TC_OCPT2_PRIOR;
115 case OMAP_DMA_PORT_EMIFF: /* FFFECC08 */
116 reg = OMAP_TC_EMIFF_PRIOR;
118 case OMAP_DMA_PORT_EMIFS: /* FFFECC04 */
119 reg = OMAP_TC_EMIFS_PRIOR;
127 l |= (priority & 0xf) << 8;
133 #ifdef CONFIG_ARCH_OMAP2PLUS
134 void omap_set_dma_priority(int lch, int dst_port, int priority)
138 ccr = p->dma_read(CCR, lch);
143 p->dma_write(ccr, CCR, lch);
146 EXPORT_SYMBOL(omap_set_dma_priority);
148 #if IS_ENABLED(CONFIG_USB_OMAP)
149 #ifdef CONFIG_ARCH_OMAP15XX
150 /* Returns 1 if the DMA module is in OMAP1510-compatible mode, 0 otherwise */
151 static int omap_dma_in_1510_mode(void)
153 return enable_1510_mode;
156 #define omap_dma_in_1510_mode() 0
159 void omap_set_dma_transfer_params(int lch, int data_type, int elem_count,
160 int frame_count, int sync_mode,
161 int dma_trigger, int src_or_dst_synch)
166 l = p->dma_read(CSDP, lch);
169 p->dma_write(l, CSDP, lch);
171 ccr = p->dma_read(CCR, lch);
173 if (sync_mode == OMAP_DMA_SYNC_FRAME)
175 p->dma_write(ccr, CCR, lch);
177 ccr = p->dma_read(CCR2, lch);
179 if (sync_mode == OMAP_DMA_SYNC_BLOCK)
181 p->dma_write(ccr, CCR2, lch);
182 p->dma_write(elem_count, CEN, lch);
183 p->dma_write(frame_count, CFN, lch);
185 EXPORT_SYMBOL(omap_set_dma_transfer_params);
187 void omap_set_dma_channel_mode(int lch, enum omap_dma_channel_mode mode)
189 if (!dma_omap15xx()) {
192 l = p->dma_read(LCH_CTRL, lch);
195 p->dma_write(l, LCH_CTRL, lch);
198 EXPORT_SYMBOL(omap_set_dma_channel_mode);
200 /* Note that src_port is only for omap1 */
201 void omap_set_dma_src_params(int lch, int src_port, int src_amode,
202 unsigned long src_start,
203 int src_ei, int src_fi)
208 w = p->dma_read(CSDP, lch);
211 p->dma_write(w, CSDP, lch);
213 l = p->dma_read(CCR, lch);
215 l |= src_amode << 12;
216 p->dma_write(l, CCR, lch);
218 p->dma_write(src_start, CSSA, lch);
220 p->dma_write(src_ei, CSEI, lch);
221 p->dma_write(src_fi, CSFI, lch);
223 EXPORT_SYMBOL(omap_set_dma_src_params);
225 void omap_set_dma_src_data_pack(int lch, int enable)
229 l = p->dma_read(CSDP, lch);
233 p->dma_write(l, CSDP, lch);
235 EXPORT_SYMBOL(omap_set_dma_src_data_pack);
237 void omap_set_dma_src_burst_mode(int lch, enum omap_dma_burst_mode burst_mode)
239 unsigned int burst = 0;
242 l = p->dma_read(CSDP, lch);
245 switch (burst_mode) {
246 case OMAP_DMA_DATA_BURST_DIS:
248 case OMAP_DMA_DATA_BURST_4:
251 case OMAP_DMA_DATA_BURST_8:
253 * not supported by current hardware on OMAP1
257 case OMAP_DMA_DATA_BURST_16:
258 /* OMAP1 don't support burst 16 */
265 p->dma_write(l, CSDP, lch);
267 EXPORT_SYMBOL(omap_set_dma_src_burst_mode);
269 /* Note that dest_port is only for OMAP1 */
270 void omap_set_dma_dest_params(int lch, int dest_port, int dest_amode,
271 unsigned long dest_start,
272 int dst_ei, int dst_fi)
276 l = p->dma_read(CSDP, lch);
279 p->dma_write(l, CSDP, lch);
281 l = p->dma_read(CCR, lch);
283 l |= dest_amode << 14;
284 p->dma_write(l, CCR, lch);
286 p->dma_write(dest_start, CDSA, lch);
288 p->dma_write(dst_ei, CDEI, lch);
289 p->dma_write(dst_fi, CDFI, lch);
291 EXPORT_SYMBOL(omap_set_dma_dest_params);
293 void omap_set_dma_dest_data_pack(int lch, int enable)
297 l = p->dma_read(CSDP, lch);
301 p->dma_write(l, CSDP, lch);
303 EXPORT_SYMBOL(omap_set_dma_dest_data_pack);
305 void omap_set_dma_dest_burst_mode(int lch, enum omap_dma_burst_mode burst_mode)
307 unsigned int burst = 0;
310 l = p->dma_read(CSDP, lch);
313 switch (burst_mode) {
314 case OMAP_DMA_DATA_BURST_DIS:
316 case OMAP_DMA_DATA_BURST_4:
319 case OMAP_DMA_DATA_BURST_8:
322 case OMAP_DMA_DATA_BURST_16:
323 /* OMAP1 don't support burst 16 */
326 printk(KERN_ERR "Invalid DMA burst mode\n");
331 p->dma_write(l, CSDP, lch);
333 EXPORT_SYMBOL(omap_set_dma_dest_burst_mode);
335 static inline void omap_enable_channel_irq(int lch)
338 p->dma_read(CSR, lch);
340 /* Enable some nice interrupts. */
341 p->dma_write(dma_chan[lch].enabled_irqs, CICR, lch);
344 void omap_disable_dma_irq(int lch, u16 bits)
346 dma_chan[lch].enabled_irqs &= ~bits;
348 EXPORT_SYMBOL(omap_disable_dma_irq);
350 static inline void enable_lnk(int lch)
354 l = p->dma_read(CLNK_CTRL, lch);
358 /* Set the ENABLE_LNK bits */
359 if (dma_chan[lch].next_lch != -1)
360 l = dma_chan[lch].next_lch | (1 << 15);
362 p->dma_write(l, CLNK_CTRL, lch);
365 static inline void disable_lnk(int lch)
369 l = p->dma_read(CLNK_CTRL, lch);
371 /* Disable interrupts */
372 omap_disable_channel_irq(lch);
374 /* Set the STOP_LNK bit */
377 p->dma_write(l, CLNK_CTRL, lch);
378 dma_chan[lch].flags &= ~OMAP_DMA_ACTIVE;
382 int omap_request_dma(int dev_id, const char *dev_name,
383 void (*callback)(int lch, u16 ch_status, void *data),
384 void *data, int *dma_ch_out)
386 int ch, free_ch = -1;
388 struct omap_dma_lch *chan;
390 WARN(strcmp(dev_name, "DMA engine"), "Using deprecated platform DMA API - please update to DMA engine");
392 spin_lock_irqsave(&dma_chan_lock, flags);
393 for (ch = 0; ch < dma_chan_count; ch++) {
394 if (free_ch == -1 && dma_chan[ch].dev_id == -1) {
396 /* Exit after first free channel found */
401 spin_unlock_irqrestore(&dma_chan_lock, flags);
404 chan = dma_chan + free_ch;
405 chan->dev_id = dev_id;
407 if (p->clear_lch_regs)
408 p->clear_lch_regs(free_ch);
410 spin_unlock_irqrestore(&dma_chan_lock, flags);
412 chan->dev_name = dev_name;
413 chan->callback = callback;
417 chan->enabled_irqs = OMAP_DMA_DROP_IRQ | OMAP_DMA_BLOCK_IRQ;
419 chan->enabled_irqs |= OMAP1_DMA_TOUT_IRQ;
421 if (dma_omap16xx()) {
422 /* If the sync device is set, configure it dynamically. */
424 set_gdma_dev(free_ch + 1, dev_id);
425 dev_id = free_ch + 1;
428 * Disable the 1510 compatibility mode and set the sync device
431 p->dma_write(dev_id | (1 << 10), CCR, free_ch);
433 p->dma_write(dev_id, CCR, free_ch);
436 *dma_ch_out = free_ch;
440 EXPORT_SYMBOL(omap_request_dma);
442 void omap_free_dma(int lch)
446 if (dma_chan[lch].dev_id == -1) {
447 pr_err("omap_dma: trying to free unallocated DMA channel %d\n",
452 /* Disable all DMA interrupts for the channel. */
453 omap_disable_channel_irq(lch);
455 /* Make sure the DMA transfer is stopped. */
456 p->dma_write(0, CCR, lch);
458 spin_lock_irqsave(&dma_chan_lock, flags);
459 dma_chan[lch].dev_id = -1;
460 dma_chan[lch].next_lch = -1;
461 dma_chan[lch].callback = NULL;
462 spin_unlock_irqrestore(&dma_chan_lock, flags);
464 EXPORT_SYMBOL(omap_free_dma);
467 * Clears any DMA state so the DMA engine is ready to restart with new buffers
468 * through omap_start_dma(). Any buffers in flight are discarded.
470 static void omap_clear_dma(int lch)
474 local_irq_save(flags);
476 local_irq_restore(flags);
479 #if IS_ENABLED(CONFIG_USB_OMAP)
480 void omap_start_dma(int lch)
485 * The CPC/CDAC register needs to be initialized to zero
486 * before starting dma transfer.
489 p->dma_write(0, CPC, lch);
491 p->dma_write(0, CDAC, lch);
493 if (!omap_dma_in_1510_mode() && dma_chan[lch].next_lch != -1) {
494 int next_lch, cur_lch;
495 char dma_chan_link_map[MAX_LOGICAL_DMA_CH_COUNT];
497 /* Set the link register of the first channel */
500 memset(dma_chan_link_map, 0, sizeof(dma_chan_link_map));
501 dma_chan_link_map[lch] = 1;
503 cur_lch = dma_chan[lch].next_lch;
505 next_lch = dma_chan[cur_lch].next_lch;
507 /* The loop case: we've been here already */
508 if (dma_chan_link_map[cur_lch])
510 /* Mark the current channel */
511 dma_chan_link_map[cur_lch] = 1;
514 omap_enable_channel_irq(cur_lch);
517 } while (next_lch != -1);
518 } else if (IS_DMA_ERRATA(DMA_ERRATA_PARALLEL_CHANNELS))
519 p->dma_write(lch, CLNK_CTRL, lch);
521 omap_enable_channel_irq(lch);
523 l = p->dma_read(CCR, lch);
525 if (IS_DMA_ERRATA(DMA_ERRATA_IFRAME_BUFFERING))
526 l |= OMAP_DMA_CCR_BUFFERING_DISABLE;
527 l |= OMAP_DMA_CCR_EN;
530 * As dma_write() uses IO accessors which are weakly ordered, there
531 * is no guarantee that data in coherent DMA memory will be visible
532 * to the DMA device. Add a memory barrier here to ensure that any
533 * such data is visible prior to enabling DMA.
536 p->dma_write(l, CCR, lch);
538 dma_chan[lch].flags |= OMAP_DMA_ACTIVE;
540 EXPORT_SYMBOL(omap_start_dma);
542 void omap_stop_dma(int lch)
546 /* Disable all interrupts on the channel */
547 omap_disable_channel_irq(lch);
549 l = p->dma_read(CCR, lch);
550 if (IS_DMA_ERRATA(DMA_ERRATA_i541) &&
551 (l & OMAP_DMA_CCR_SEL_SRC_DST_SYNC)) {
555 /* Configure No-Standby */
556 l = p->dma_read(OCP_SYSCONFIG, lch);
558 l &= ~DMA_SYSCONFIG_MIDLEMODE_MASK;
559 l |= DMA_SYSCONFIG_MIDLEMODE(DMA_IDLEMODE_NO_IDLE);
560 p->dma_write(l , OCP_SYSCONFIG, 0);
562 l = p->dma_read(CCR, lch);
563 l &= ~OMAP_DMA_CCR_EN;
564 p->dma_write(l, CCR, lch);
566 /* Wait for sDMA FIFO drain */
567 l = p->dma_read(CCR, lch);
568 while (i < 100 && (l & (OMAP_DMA_CCR_RD_ACTIVE |
569 OMAP_DMA_CCR_WR_ACTIVE))) {
572 l = p->dma_read(CCR, lch);
575 pr_err("DMA drain did not complete on lch %d\n", lch);
576 /* Restore OCP_SYSCONFIG */
577 p->dma_write(sys_cf, OCP_SYSCONFIG, lch);
579 l &= ~OMAP_DMA_CCR_EN;
580 p->dma_write(l, CCR, lch);
584 * Ensure that data transferred by DMA is visible to any access
585 * after DMA has been disabled. This is important for coherent
590 if (!omap_dma_in_1510_mode() && dma_chan[lch].next_lch != -1) {
591 int next_lch, cur_lch = lch;
592 char dma_chan_link_map[MAX_LOGICAL_DMA_CH_COUNT];
594 memset(dma_chan_link_map, 0, sizeof(dma_chan_link_map));
596 /* The loop case: we've been here already */
597 if (dma_chan_link_map[cur_lch])
599 /* Mark the current channel */
600 dma_chan_link_map[cur_lch] = 1;
602 disable_lnk(cur_lch);
604 next_lch = dma_chan[cur_lch].next_lch;
606 } while (next_lch != -1);
609 dma_chan[lch].flags &= ~OMAP_DMA_ACTIVE;
611 EXPORT_SYMBOL(omap_stop_dma);
614 * Allows changing the DMA callback function or data. This may be needed if
615 * the driver shares a single DMA channel for multiple dma triggers.
618 * Returns current physical source address for the given DMA channel.
619 * If the channel is running the caller must disable interrupts prior calling
620 * this function and process the returned value before re-enabling interrupt to
621 * prevent races with the interrupt handler. Note that in continuous mode there
622 * is a chance for CSSA_L register overflow between the two reads resulting
623 * in incorrect return value.
625 dma_addr_t omap_get_dma_src_pos(int lch)
627 dma_addr_t offset = 0;
630 offset = p->dma_read(CPC, lch);
632 offset = p->dma_read(CSAC, lch);
634 if (IS_DMA_ERRATA(DMA_ERRATA_3_3) && offset == 0)
635 offset = p->dma_read(CSAC, lch);
637 if (!dma_omap15xx()) {
639 * CDAC == 0 indicates that the DMA transfer on the channel has
640 * not been started (no data has been transferred so far).
641 * Return the programmed source start address in this case.
643 if (likely(p->dma_read(CDAC, lch)))
644 offset = p->dma_read(CSAC, lch);
646 offset = p->dma_read(CSSA, lch);
649 offset |= (p->dma_read(CSSA, lch) & 0xFFFF0000);
653 EXPORT_SYMBOL(omap_get_dma_src_pos);
656 * Returns current physical destination address for the given DMA channel.
657 * If the channel is running the caller must disable interrupts prior calling
658 * this function and process the returned value before re-enabling interrupt to
659 * prevent races with the interrupt handler. Note that in continuous mode there
660 * is a chance for CDSA_L register overflow between the two reads resulting
661 * in incorrect return value.
663 dma_addr_t omap_get_dma_dst_pos(int lch)
665 dma_addr_t offset = 0;
668 offset = p->dma_read(CPC, lch);
670 offset = p->dma_read(CDAC, lch);
673 * omap 3.2/3.3 erratum: sometimes 0 is returned if CSAC/CDAC is
674 * read before the DMA controller finished disabling the channel.
676 if (!dma_omap15xx() && offset == 0) {
677 offset = p->dma_read(CDAC, lch);
679 * CDAC == 0 indicates that the DMA transfer on the channel has
680 * not been started (no data has been transferred so far).
681 * Return the programmed destination start address in this case.
683 if (unlikely(!offset))
684 offset = p->dma_read(CDSA, lch);
687 offset |= (p->dma_read(CDSA, lch) & 0xFFFF0000);
691 EXPORT_SYMBOL(omap_get_dma_dst_pos);
693 int omap_get_dma_active_status(int lch)
695 return (p->dma_read(CCR, lch) & OMAP_DMA_CCR_EN) != 0;
697 EXPORT_SYMBOL(omap_get_dma_active_status);
700 int omap_dma_running(void)
704 if (omap_lcd_dma_running())
707 for (lch = 0; lch < dma_chan_count; lch++)
708 if (p->dma_read(CCR, lch) & OMAP_DMA_CCR_EN)
714 /*----------------------------------------------------------------------------*/
716 static int omap1_dma_handle_ch(int ch)
720 if (enable_1510_mode && ch >= 6) {
721 csr = dma_chan[ch].saved_csr;
722 dma_chan[ch].saved_csr = 0;
724 csr = p->dma_read(CSR, ch);
725 if (enable_1510_mode && ch <= 2 && (csr >> 7) != 0) {
726 dma_chan[ch + 6].saved_csr = csr >> 7;
729 if ((csr & 0x3f) == 0)
731 if (unlikely(dma_chan[ch].dev_id == -1)) {
732 pr_warn("Spurious interrupt from DMA channel %d (CSR %04x)\n",
736 if (unlikely(csr & OMAP1_DMA_TOUT_IRQ))
737 pr_warn("DMA timeout with device %d\n", dma_chan[ch].dev_id);
738 if (unlikely(csr & OMAP_DMA_DROP_IRQ))
739 pr_warn("DMA synchronization event drop occurred with device %d\n",
740 dma_chan[ch].dev_id);
741 if (likely(csr & OMAP_DMA_BLOCK_IRQ))
742 dma_chan[ch].flags &= ~OMAP_DMA_ACTIVE;
743 if (likely(dma_chan[ch].callback != NULL))
744 dma_chan[ch].callback(ch, csr, dma_chan[ch].data);
749 static irqreturn_t omap1_dma_irq_handler(int irq, void *dev_id)
751 int ch = ((int) dev_id) - 1;
757 handled_now += omap1_dma_handle_ch(ch);
758 if (enable_1510_mode && dma_chan[ch + 6].saved_csr)
759 handled_now += omap1_dma_handle_ch(ch + 6);
762 handled += handled_now;
765 return handled ? IRQ_HANDLED : IRQ_NONE;
768 struct omap_system_dma_plat_info *omap_get_plat_info(void)
772 EXPORT_SYMBOL_GPL(omap_get_plat_info);
774 static int omap_system_dma_probe(struct platform_device *pdev)
780 p = pdev->dev.platform_data;
783 "%s: System DMA initialized without platform data\n",
791 if ((d->dev_caps & RESERVE_CHANNEL) && omap_dma_reserve_channels
792 && (omap_dma_reserve_channels < d->lch_count))
793 d->lch_count = omap_dma_reserve_channels;
795 dma_lch_count = d->lch_count;
796 dma_chan_count = dma_lch_count;
797 enable_1510_mode = d->dev_caps & ENABLE_1510_MODE;
799 dma_chan = devm_kcalloc(&pdev->dev, dma_lch_count,
800 sizeof(*dma_chan), GFP_KERNEL);
804 for (ch = 0; ch < dma_chan_count; ch++) {
807 dma_chan[ch].dev_id = -1;
808 dma_chan[ch].next_lch = -1;
810 if (ch >= 6 && enable_1510_mode)
814 * request_irq() doesn't like dev_id (ie. ch) being
815 * zero, so we have to kludge around this.
817 sprintf(&irq_name[0], "%d", ch);
818 dma_irq = platform_get_irq_byname(pdev, irq_name);
822 goto exit_dma_irq_fail;
825 /* INT_DMA_LCD is handled in lcd_dma.c */
826 if (dma_irq == INT_DMA_LCD)
829 ret = request_irq(dma_irq,
830 omap1_dma_irq_handler, 0, "DMA",
833 goto exit_dma_irq_fail;
836 /* reserve dma channels 0 and 1 in high security devices on 34xx */
837 if (d->dev_caps & HS_CHANNELS_RESERVED) {
838 pr_info("Reserving DMA channels 0 and 1 for HS ROM code\n");
839 dma_chan[0].dev_id = 0;
840 dma_chan[1].dev_id = 1;
849 static int omap_system_dma_remove(struct platform_device *pdev)
851 int dma_irq, irq_rel = 0;
853 for ( ; irq_rel < dma_chan_count; irq_rel++) {
854 dma_irq = platform_get_irq(pdev, irq_rel);
855 free_irq(dma_irq, (void *)(irq_rel + 1));
861 static struct platform_driver omap_system_dma_driver = {
862 .probe = omap_system_dma_probe,
863 .remove = omap_system_dma_remove,
865 .name = "omap_dma_system"
869 static int __init omap_system_dma_init(void)
871 return platform_driver_register(&omap_system_dma_driver);
873 arch_initcall(omap_system_dma_init);
875 static void __exit omap_system_dma_exit(void)
877 platform_driver_unregister(&omap_system_dma_driver);
880 MODULE_DESCRIPTION("OMAP SYSTEM DMA DRIVER");
881 MODULE_LICENSE("GPL");
882 MODULE_AUTHOR("Texas Instruments Inc");
885 * Reserve the omap SDMA channels using cmdline bootarg
886 * "omap_dma_reserve_ch=". The valid range is 1 to 32
888 static int __init omap_dma_cmdline_reserve_ch(char *str)
890 if (get_option(&str, &omap_dma_reserve_channels) != 1)
891 omap_dma_reserve_channels = 0;
895 __setup("omap_dma_reserve_ch=", omap_dma_cmdline_reserve_ch);