Merge tag 'block-5.11-2021-01-10' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / drivers / dma / dw / core.c
blob19a23767533ac90c690055697949de2873db6153
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Core driver for the Synopsys DesignWare DMA Controller
5 * Copyright (C) 2007-2008 Atmel Corporation
6 * Copyright (C) 2010-2011 ST Microelectronics
7 * Copyright (C) 2013 Intel Corporation
8 */
10 #include <linux/bitops.h>
11 #include <linux/delay.h>
12 #include <linux/dmaengine.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/dmapool.h>
15 #include <linux/err.h>
16 #include <linux/init.h>
17 #include <linux/interrupt.h>
18 #include <linux/io.h>
19 #include <linux/mm.h>
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/pm_runtime.h>
24 #include "../dmaengine.h"
25 #include "internal.h"
28 * This supports the Synopsys "DesignWare AHB Central DMA Controller",
29 * (DW_ahb_dmac) which is used with various AMBA 2.0 systems (not all
30 * of which use ARM any more). See the "Databook" from Synopsys for
31 * information beyond what licensees probably provide.
33 * The driver has been tested with the Atmel AT32AP7000, which does not
34 * support descriptor writeback.
37 /* The set of bus widths supported by the DMA controller */
38 #define DW_DMA_BUSWIDTHS \
39 BIT(DMA_SLAVE_BUSWIDTH_UNDEFINED) | \
40 BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) | \
41 BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) | \
42 BIT(DMA_SLAVE_BUSWIDTH_4_BYTES)
44 /*----------------------------------------------------------------------*/
46 static struct device *chan2dev(struct dma_chan *chan)
48 return &chan->dev->device;
51 static struct dw_desc *dwc_first_active(struct dw_dma_chan *dwc)
53 return to_dw_desc(dwc->active_list.next);
56 static dma_cookie_t dwc_tx_submit(struct dma_async_tx_descriptor *tx)
58 struct dw_desc *desc = txd_to_dw_desc(tx);
59 struct dw_dma_chan *dwc = to_dw_dma_chan(tx->chan);
60 dma_cookie_t cookie;
61 unsigned long flags;
63 spin_lock_irqsave(&dwc->lock, flags);
64 cookie = dma_cookie_assign(tx);
67 * REVISIT: We should attempt to chain as many descriptors as
68 * possible, perhaps even appending to those already submitted
69 * for DMA. But this is hard to do in a race-free manner.
72 list_add_tail(&desc->desc_node, &dwc->queue);
73 spin_unlock_irqrestore(&dwc->lock, flags);
74 dev_vdbg(chan2dev(tx->chan), "%s: queued %u\n",
75 __func__, desc->txd.cookie);
77 return cookie;
80 static struct dw_desc *dwc_desc_get(struct dw_dma_chan *dwc)
82 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
83 struct dw_desc *desc;
84 dma_addr_t phys;
86 desc = dma_pool_zalloc(dw->desc_pool, GFP_ATOMIC, &phys);
87 if (!desc)
88 return NULL;
90 dwc->descs_allocated++;
91 INIT_LIST_HEAD(&desc->tx_list);
92 dma_async_tx_descriptor_init(&desc->txd, &dwc->chan);
93 desc->txd.tx_submit = dwc_tx_submit;
94 desc->txd.flags = DMA_CTRL_ACK;
95 desc->txd.phys = phys;
96 return desc;
99 static void dwc_desc_put(struct dw_dma_chan *dwc, struct dw_desc *desc)
101 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
102 struct dw_desc *child, *_next;
104 if (unlikely(!desc))
105 return;
107 list_for_each_entry_safe(child, _next, &desc->tx_list, desc_node) {
108 list_del(&child->desc_node);
109 dma_pool_free(dw->desc_pool, child, child->txd.phys);
110 dwc->descs_allocated--;
113 dma_pool_free(dw->desc_pool, desc, desc->txd.phys);
114 dwc->descs_allocated--;
117 static void dwc_initialize(struct dw_dma_chan *dwc)
119 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
121 dw->initialize_chan(dwc);
123 /* Enable interrupts */
124 channel_set_bit(dw, MASK.XFER, dwc->mask);
125 channel_set_bit(dw, MASK.ERROR, dwc->mask);
128 /*----------------------------------------------------------------------*/
130 static inline void dwc_dump_chan_regs(struct dw_dma_chan *dwc)
132 dev_err(chan2dev(&dwc->chan),
133 " SAR: 0x%x DAR: 0x%x LLP: 0x%x CTL: 0x%x:%08x\n",
134 channel_readl(dwc, SAR),
135 channel_readl(dwc, DAR),
136 channel_readl(dwc, LLP),
137 channel_readl(dwc, CTL_HI),
138 channel_readl(dwc, CTL_LO));
141 static inline void dwc_chan_disable(struct dw_dma *dw, struct dw_dma_chan *dwc)
143 channel_clear_bit(dw, CH_EN, dwc->mask);
144 while (dma_readl(dw, CH_EN) & dwc->mask)
145 cpu_relax();
148 /*----------------------------------------------------------------------*/
150 /* Perform single block transfer */
151 static inline void dwc_do_single_block(struct dw_dma_chan *dwc,
152 struct dw_desc *desc)
154 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
155 u32 ctllo;
158 * Software emulation of LLP mode relies on interrupts to continue
159 * multi block transfer.
161 ctllo = lli_read(desc, ctllo) | DWC_CTLL_INT_EN;
163 channel_writel(dwc, SAR, lli_read(desc, sar));
164 channel_writel(dwc, DAR, lli_read(desc, dar));
165 channel_writel(dwc, CTL_LO, ctllo);
166 channel_writel(dwc, CTL_HI, lli_read(desc, ctlhi));
167 channel_set_bit(dw, CH_EN, dwc->mask);
169 /* Move pointer to next descriptor */
170 dwc->tx_node_active = dwc->tx_node_active->next;
173 /* Called with dwc->lock held and bh disabled */
174 static void dwc_dostart(struct dw_dma_chan *dwc, struct dw_desc *first)
176 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
177 u8 lms = DWC_LLP_LMS(dwc->dws.m_master);
178 unsigned long was_soft_llp;
180 /* ASSERT: channel is idle */
181 if (dma_readl(dw, CH_EN) & dwc->mask) {
182 dev_err(chan2dev(&dwc->chan),
183 "%s: BUG: Attempted to start non-idle channel\n",
184 __func__);
185 dwc_dump_chan_regs(dwc);
187 /* The tasklet will hopefully advance the queue... */
188 return;
191 if (dwc->nollp) {
192 was_soft_llp = test_and_set_bit(DW_DMA_IS_SOFT_LLP,
193 &dwc->flags);
194 if (was_soft_llp) {
195 dev_err(chan2dev(&dwc->chan),
196 "BUG: Attempted to start new LLP transfer inside ongoing one\n");
197 return;
200 dwc_initialize(dwc);
202 first->residue = first->total_len;
203 dwc->tx_node_active = &first->tx_list;
205 /* Submit first block */
206 dwc_do_single_block(dwc, first);
208 return;
211 dwc_initialize(dwc);
213 channel_writel(dwc, LLP, first->txd.phys | lms);
214 channel_writel(dwc, CTL_LO, DWC_CTLL_LLP_D_EN | DWC_CTLL_LLP_S_EN);
215 channel_writel(dwc, CTL_HI, 0);
216 channel_set_bit(dw, CH_EN, dwc->mask);
219 static void dwc_dostart_first_queued(struct dw_dma_chan *dwc)
221 struct dw_desc *desc;
223 if (list_empty(&dwc->queue))
224 return;
226 list_move(dwc->queue.next, &dwc->active_list);
227 desc = dwc_first_active(dwc);
228 dev_vdbg(chan2dev(&dwc->chan), "%s: started %u\n", __func__, desc->txd.cookie);
229 dwc_dostart(dwc, desc);
232 /*----------------------------------------------------------------------*/
234 static void
235 dwc_descriptor_complete(struct dw_dma_chan *dwc, struct dw_desc *desc,
236 bool callback_required)
238 struct dma_async_tx_descriptor *txd = &desc->txd;
239 struct dw_desc *child;
240 unsigned long flags;
241 struct dmaengine_desc_callback cb;
243 dev_vdbg(chan2dev(&dwc->chan), "descriptor %u complete\n", txd->cookie);
245 spin_lock_irqsave(&dwc->lock, flags);
246 dma_cookie_complete(txd);
247 if (callback_required)
248 dmaengine_desc_get_callback(txd, &cb);
249 else
250 memset(&cb, 0, sizeof(cb));
252 /* async_tx_ack */
253 list_for_each_entry(child, &desc->tx_list, desc_node)
254 async_tx_ack(&child->txd);
255 async_tx_ack(&desc->txd);
256 dwc_desc_put(dwc, desc);
257 spin_unlock_irqrestore(&dwc->lock, flags);
259 dmaengine_desc_callback_invoke(&cb, NULL);
262 static void dwc_complete_all(struct dw_dma *dw, struct dw_dma_chan *dwc)
264 struct dw_desc *desc, *_desc;
265 LIST_HEAD(list);
266 unsigned long flags;
268 spin_lock_irqsave(&dwc->lock, flags);
269 if (dma_readl(dw, CH_EN) & dwc->mask) {
270 dev_err(chan2dev(&dwc->chan),
271 "BUG: XFER bit set, but channel not idle!\n");
273 /* Try to continue after resetting the channel... */
274 dwc_chan_disable(dw, dwc);
278 * Submit queued descriptors ASAP, i.e. before we go through
279 * the completed ones.
281 list_splice_init(&dwc->active_list, &list);
282 dwc_dostart_first_queued(dwc);
284 spin_unlock_irqrestore(&dwc->lock, flags);
286 list_for_each_entry_safe(desc, _desc, &list, desc_node)
287 dwc_descriptor_complete(dwc, desc, true);
290 /* Returns how many bytes were already received from source */
291 static inline u32 dwc_get_sent(struct dw_dma_chan *dwc)
293 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
294 u32 ctlhi = channel_readl(dwc, CTL_HI);
295 u32 ctllo = channel_readl(dwc, CTL_LO);
297 return dw->block2bytes(dwc, ctlhi, ctllo >> 4 & 7);
300 static void dwc_scan_descriptors(struct dw_dma *dw, struct dw_dma_chan *dwc)
302 dma_addr_t llp;
303 struct dw_desc *desc, *_desc;
304 struct dw_desc *child;
305 u32 status_xfer;
306 unsigned long flags;
308 spin_lock_irqsave(&dwc->lock, flags);
309 llp = channel_readl(dwc, LLP);
310 status_xfer = dma_readl(dw, RAW.XFER);
312 if (status_xfer & dwc->mask) {
313 /* Everything we've submitted is done */
314 dma_writel(dw, CLEAR.XFER, dwc->mask);
316 if (test_bit(DW_DMA_IS_SOFT_LLP, &dwc->flags)) {
317 struct list_head *head, *active = dwc->tx_node_active;
320 * We are inside first active descriptor.
321 * Otherwise something is really wrong.
323 desc = dwc_first_active(dwc);
325 head = &desc->tx_list;
326 if (active != head) {
327 /* Update residue to reflect last sent descriptor */
328 if (active == head->next)
329 desc->residue -= desc->len;
330 else
331 desc->residue -= to_dw_desc(active->prev)->len;
333 child = to_dw_desc(active);
335 /* Submit next block */
336 dwc_do_single_block(dwc, child);
338 spin_unlock_irqrestore(&dwc->lock, flags);
339 return;
342 /* We are done here */
343 clear_bit(DW_DMA_IS_SOFT_LLP, &dwc->flags);
346 spin_unlock_irqrestore(&dwc->lock, flags);
348 dwc_complete_all(dw, dwc);
349 return;
352 if (list_empty(&dwc->active_list)) {
353 spin_unlock_irqrestore(&dwc->lock, flags);
354 return;
357 if (test_bit(DW_DMA_IS_SOFT_LLP, &dwc->flags)) {
358 dev_vdbg(chan2dev(&dwc->chan), "%s: soft LLP mode\n", __func__);
359 spin_unlock_irqrestore(&dwc->lock, flags);
360 return;
363 dev_vdbg(chan2dev(&dwc->chan), "%s: llp=%pad\n", __func__, &llp);
365 list_for_each_entry_safe(desc, _desc, &dwc->active_list, desc_node) {
366 /* Initial residue value */
367 desc->residue = desc->total_len;
369 /* Check first descriptors addr */
370 if (desc->txd.phys == DWC_LLP_LOC(llp)) {
371 spin_unlock_irqrestore(&dwc->lock, flags);
372 return;
375 /* Check first descriptors llp */
376 if (lli_read(desc, llp) == llp) {
377 /* This one is currently in progress */
378 desc->residue -= dwc_get_sent(dwc);
379 spin_unlock_irqrestore(&dwc->lock, flags);
380 return;
383 desc->residue -= desc->len;
384 list_for_each_entry(child, &desc->tx_list, desc_node) {
385 if (lli_read(child, llp) == llp) {
386 /* Currently in progress */
387 desc->residue -= dwc_get_sent(dwc);
388 spin_unlock_irqrestore(&dwc->lock, flags);
389 return;
391 desc->residue -= child->len;
395 * No descriptors so far seem to be in progress, i.e.
396 * this one must be done.
398 spin_unlock_irqrestore(&dwc->lock, flags);
399 dwc_descriptor_complete(dwc, desc, true);
400 spin_lock_irqsave(&dwc->lock, flags);
403 dev_err(chan2dev(&dwc->chan),
404 "BUG: All descriptors done, but channel not idle!\n");
406 /* Try to continue after resetting the channel... */
407 dwc_chan_disable(dw, dwc);
409 dwc_dostart_first_queued(dwc);
410 spin_unlock_irqrestore(&dwc->lock, flags);
413 static inline void dwc_dump_lli(struct dw_dma_chan *dwc, struct dw_desc *desc)
415 dev_crit(chan2dev(&dwc->chan), " desc: s0x%x d0x%x l0x%x c0x%x:%x\n",
416 lli_read(desc, sar),
417 lli_read(desc, dar),
418 lli_read(desc, llp),
419 lli_read(desc, ctlhi),
420 lli_read(desc, ctllo));
423 static void dwc_handle_error(struct dw_dma *dw, struct dw_dma_chan *dwc)
425 struct dw_desc *bad_desc;
426 struct dw_desc *child;
427 unsigned long flags;
429 dwc_scan_descriptors(dw, dwc);
431 spin_lock_irqsave(&dwc->lock, flags);
434 * The descriptor currently at the head of the active list is
435 * borked. Since we don't have any way to report errors, we'll
436 * just have to scream loudly and try to carry on.
438 bad_desc = dwc_first_active(dwc);
439 list_del_init(&bad_desc->desc_node);
440 list_move(dwc->queue.next, dwc->active_list.prev);
442 /* Clear the error flag and try to restart the controller */
443 dma_writel(dw, CLEAR.ERROR, dwc->mask);
444 if (!list_empty(&dwc->active_list))
445 dwc_dostart(dwc, dwc_first_active(dwc));
448 * WARN may seem harsh, but since this only happens
449 * when someone submits a bad physical address in a
450 * descriptor, we should consider ourselves lucky that the
451 * controller flagged an error instead of scribbling over
452 * random memory locations.
454 dev_WARN(chan2dev(&dwc->chan), "Bad descriptor submitted for DMA!\n"
455 " cookie: %d\n", bad_desc->txd.cookie);
456 dwc_dump_lli(dwc, bad_desc);
457 list_for_each_entry(child, &bad_desc->tx_list, desc_node)
458 dwc_dump_lli(dwc, child);
460 spin_unlock_irqrestore(&dwc->lock, flags);
462 /* Pretend the descriptor completed successfully */
463 dwc_descriptor_complete(dwc, bad_desc, true);
466 static void dw_dma_tasklet(struct tasklet_struct *t)
468 struct dw_dma *dw = from_tasklet(dw, t, tasklet);
469 struct dw_dma_chan *dwc;
470 u32 status_xfer;
471 u32 status_err;
472 unsigned int i;
474 status_xfer = dma_readl(dw, RAW.XFER);
475 status_err = dma_readl(dw, RAW.ERROR);
477 dev_vdbg(dw->dma.dev, "%s: status_err=%x\n", __func__, status_err);
479 for (i = 0; i < dw->dma.chancnt; i++) {
480 dwc = &dw->chan[i];
481 if (test_bit(DW_DMA_IS_CYCLIC, &dwc->flags))
482 dev_vdbg(dw->dma.dev, "Cyclic xfer is not implemented\n");
483 else if (status_err & (1 << i))
484 dwc_handle_error(dw, dwc);
485 else if (status_xfer & (1 << i))
486 dwc_scan_descriptors(dw, dwc);
489 /* Re-enable interrupts */
490 channel_set_bit(dw, MASK.XFER, dw->all_chan_mask);
491 channel_set_bit(dw, MASK.ERROR, dw->all_chan_mask);
494 static irqreturn_t dw_dma_interrupt(int irq, void *dev_id)
496 struct dw_dma *dw = dev_id;
497 u32 status;
499 /* Check if we have any interrupt from the DMAC which is not in use */
500 if (!dw->in_use)
501 return IRQ_NONE;
503 status = dma_readl(dw, STATUS_INT);
504 dev_vdbg(dw->dma.dev, "%s: status=0x%x\n", __func__, status);
506 /* Check if we have any interrupt from the DMAC */
507 if (!status)
508 return IRQ_NONE;
511 * Just disable the interrupts. We'll turn them back on in the
512 * softirq handler.
514 channel_clear_bit(dw, MASK.XFER, dw->all_chan_mask);
515 channel_clear_bit(dw, MASK.BLOCK, dw->all_chan_mask);
516 channel_clear_bit(dw, MASK.ERROR, dw->all_chan_mask);
518 status = dma_readl(dw, STATUS_INT);
519 if (status) {
520 dev_err(dw->dma.dev,
521 "BUG: Unexpected interrupts pending: 0x%x\n",
522 status);
524 /* Try to recover */
525 channel_clear_bit(dw, MASK.XFER, (1 << 8) - 1);
526 channel_clear_bit(dw, MASK.BLOCK, (1 << 8) - 1);
527 channel_clear_bit(dw, MASK.SRC_TRAN, (1 << 8) - 1);
528 channel_clear_bit(dw, MASK.DST_TRAN, (1 << 8) - 1);
529 channel_clear_bit(dw, MASK.ERROR, (1 << 8) - 1);
532 tasklet_schedule(&dw->tasklet);
534 return IRQ_HANDLED;
537 /*----------------------------------------------------------------------*/
539 static struct dma_async_tx_descriptor *
540 dwc_prep_dma_memcpy(struct dma_chan *chan, dma_addr_t dest, dma_addr_t src,
541 size_t len, unsigned long flags)
543 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
544 struct dw_dma *dw = to_dw_dma(chan->device);
545 struct dw_desc *desc;
546 struct dw_desc *first;
547 struct dw_desc *prev;
548 size_t xfer_count;
549 size_t offset;
550 u8 m_master = dwc->dws.m_master;
551 unsigned int src_width;
552 unsigned int dst_width;
553 unsigned int data_width = dw->pdata->data_width[m_master];
554 u32 ctllo, ctlhi;
555 u8 lms = DWC_LLP_LMS(m_master);
557 dev_vdbg(chan2dev(chan),
558 "%s: d%pad s%pad l0x%zx f0x%lx\n", __func__,
559 &dest, &src, len, flags);
561 if (unlikely(!len)) {
562 dev_dbg(chan2dev(chan), "%s: length is zero!\n", __func__);
563 return NULL;
566 dwc->direction = DMA_MEM_TO_MEM;
568 src_width = dst_width = __ffs(data_width | src | dest | len);
570 ctllo = dw->prepare_ctllo(dwc)
571 | DWC_CTLL_DST_WIDTH(dst_width)
572 | DWC_CTLL_SRC_WIDTH(src_width)
573 | DWC_CTLL_DST_INC
574 | DWC_CTLL_SRC_INC
575 | DWC_CTLL_FC_M2M;
576 prev = first = NULL;
578 for (offset = 0; offset < len; offset += xfer_count) {
579 desc = dwc_desc_get(dwc);
580 if (!desc)
581 goto err_desc_get;
583 ctlhi = dw->bytes2block(dwc, len - offset, src_width, &xfer_count);
585 lli_write(desc, sar, src + offset);
586 lli_write(desc, dar, dest + offset);
587 lli_write(desc, ctllo, ctllo);
588 lli_write(desc, ctlhi, ctlhi);
589 desc->len = xfer_count;
591 if (!first) {
592 first = desc;
593 } else {
594 lli_write(prev, llp, desc->txd.phys | lms);
595 list_add_tail(&desc->desc_node, &first->tx_list);
597 prev = desc;
600 if (flags & DMA_PREP_INTERRUPT)
601 /* Trigger interrupt after last block */
602 lli_set(prev, ctllo, DWC_CTLL_INT_EN);
604 prev->lli.llp = 0;
605 lli_clear(prev, ctllo, DWC_CTLL_LLP_D_EN | DWC_CTLL_LLP_S_EN);
606 first->txd.flags = flags;
607 first->total_len = len;
609 return &first->txd;
611 err_desc_get:
612 dwc_desc_put(dwc, first);
613 return NULL;
616 static struct dma_async_tx_descriptor *
617 dwc_prep_slave_sg(struct dma_chan *chan, struct scatterlist *sgl,
618 unsigned int sg_len, enum dma_transfer_direction direction,
619 unsigned long flags, void *context)
621 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
622 struct dw_dma *dw = to_dw_dma(chan->device);
623 struct dma_slave_config *sconfig = &dwc->dma_sconfig;
624 struct dw_desc *prev;
625 struct dw_desc *first;
626 u32 ctllo, ctlhi;
627 u8 m_master = dwc->dws.m_master;
628 u8 lms = DWC_LLP_LMS(m_master);
629 dma_addr_t reg;
630 unsigned int reg_width;
631 unsigned int mem_width;
632 unsigned int data_width = dw->pdata->data_width[m_master];
633 unsigned int i;
634 struct scatterlist *sg;
635 size_t total_len = 0;
637 dev_vdbg(chan2dev(chan), "%s\n", __func__);
639 if (unlikely(!is_slave_direction(direction) || !sg_len))
640 return NULL;
642 dwc->direction = direction;
644 prev = first = NULL;
646 switch (direction) {
647 case DMA_MEM_TO_DEV:
648 reg_width = __ffs(sconfig->dst_addr_width);
649 reg = sconfig->dst_addr;
650 ctllo = dw->prepare_ctllo(dwc)
651 | DWC_CTLL_DST_WIDTH(reg_width)
652 | DWC_CTLL_DST_FIX
653 | DWC_CTLL_SRC_INC;
655 ctllo |= sconfig->device_fc ? DWC_CTLL_FC(DW_DMA_FC_P_M2P) :
656 DWC_CTLL_FC(DW_DMA_FC_D_M2P);
658 for_each_sg(sgl, sg, sg_len, i) {
659 struct dw_desc *desc;
660 u32 len, mem;
661 size_t dlen;
663 mem = sg_dma_address(sg);
664 len = sg_dma_len(sg);
666 mem_width = __ffs(data_width | mem | len);
668 slave_sg_todev_fill_desc:
669 desc = dwc_desc_get(dwc);
670 if (!desc)
671 goto err_desc_get;
673 ctlhi = dw->bytes2block(dwc, len, mem_width, &dlen);
675 lli_write(desc, sar, mem);
676 lli_write(desc, dar, reg);
677 lli_write(desc, ctlhi, ctlhi);
678 lli_write(desc, ctllo, ctllo | DWC_CTLL_SRC_WIDTH(mem_width));
679 desc->len = dlen;
681 if (!first) {
682 first = desc;
683 } else {
684 lli_write(prev, llp, desc->txd.phys | lms);
685 list_add_tail(&desc->desc_node, &first->tx_list);
687 prev = desc;
689 mem += dlen;
690 len -= dlen;
691 total_len += dlen;
693 if (len)
694 goto slave_sg_todev_fill_desc;
696 break;
697 case DMA_DEV_TO_MEM:
698 reg_width = __ffs(sconfig->src_addr_width);
699 reg = sconfig->src_addr;
700 ctllo = dw->prepare_ctllo(dwc)
701 | DWC_CTLL_SRC_WIDTH(reg_width)
702 | DWC_CTLL_DST_INC
703 | DWC_CTLL_SRC_FIX;
705 ctllo |= sconfig->device_fc ? DWC_CTLL_FC(DW_DMA_FC_P_P2M) :
706 DWC_CTLL_FC(DW_DMA_FC_D_P2M);
708 for_each_sg(sgl, sg, sg_len, i) {
709 struct dw_desc *desc;
710 u32 len, mem;
711 size_t dlen;
713 mem = sg_dma_address(sg);
714 len = sg_dma_len(sg);
716 slave_sg_fromdev_fill_desc:
717 desc = dwc_desc_get(dwc);
718 if (!desc)
719 goto err_desc_get;
721 ctlhi = dw->bytes2block(dwc, len, reg_width, &dlen);
723 lli_write(desc, sar, reg);
724 lli_write(desc, dar, mem);
725 lli_write(desc, ctlhi, ctlhi);
726 mem_width = __ffs(data_width | mem);
727 lli_write(desc, ctllo, ctllo | DWC_CTLL_DST_WIDTH(mem_width));
728 desc->len = dlen;
730 if (!first) {
731 first = desc;
732 } else {
733 lli_write(prev, llp, desc->txd.phys | lms);
734 list_add_tail(&desc->desc_node, &first->tx_list);
736 prev = desc;
738 mem += dlen;
739 len -= dlen;
740 total_len += dlen;
742 if (len)
743 goto slave_sg_fromdev_fill_desc;
745 break;
746 default:
747 return NULL;
750 if (flags & DMA_PREP_INTERRUPT)
751 /* Trigger interrupt after last block */
752 lli_set(prev, ctllo, DWC_CTLL_INT_EN);
754 prev->lli.llp = 0;
755 lli_clear(prev, ctllo, DWC_CTLL_LLP_D_EN | DWC_CTLL_LLP_S_EN);
756 first->total_len = total_len;
758 return &first->txd;
760 err_desc_get:
761 dev_err(chan2dev(chan),
762 "not enough descriptors available. Direction %d\n", direction);
763 dwc_desc_put(dwc, first);
764 return NULL;
767 bool dw_dma_filter(struct dma_chan *chan, void *param)
769 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
770 struct dw_dma_slave *dws = param;
772 if (dws->dma_dev != chan->device->dev)
773 return false;
775 /* permit channels in accordance with the channels mask */
776 if (dws->channels && !(dws->channels & dwc->mask))
777 return false;
779 /* We have to copy data since dws can be temporary storage */
780 memcpy(&dwc->dws, dws, sizeof(struct dw_dma_slave));
782 return true;
784 EXPORT_SYMBOL_GPL(dw_dma_filter);
786 static int dwc_config(struct dma_chan *chan, struct dma_slave_config *sconfig)
788 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
789 struct dw_dma *dw = to_dw_dma(chan->device);
791 memcpy(&dwc->dma_sconfig, sconfig, sizeof(*sconfig));
793 dwc->dma_sconfig.src_maxburst =
794 clamp(dwc->dma_sconfig.src_maxburst, 0U, dwc->max_burst);
795 dwc->dma_sconfig.dst_maxburst =
796 clamp(dwc->dma_sconfig.dst_maxburst, 0U, dwc->max_burst);
798 dw->encode_maxburst(dwc, &dwc->dma_sconfig.src_maxburst);
799 dw->encode_maxburst(dwc, &dwc->dma_sconfig.dst_maxburst);
801 return 0;
804 static void dwc_chan_pause(struct dw_dma_chan *dwc, bool drain)
806 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
807 unsigned int count = 20; /* timeout iterations */
809 dw->suspend_chan(dwc, drain);
811 while (!(channel_readl(dwc, CFG_LO) & DWC_CFGL_FIFO_EMPTY) && count--)
812 udelay(2);
814 set_bit(DW_DMA_IS_PAUSED, &dwc->flags);
817 static int dwc_pause(struct dma_chan *chan)
819 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
820 unsigned long flags;
822 spin_lock_irqsave(&dwc->lock, flags);
823 dwc_chan_pause(dwc, false);
824 spin_unlock_irqrestore(&dwc->lock, flags);
826 return 0;
829 static inline void dwc_chan_resume(struct dw_dma_chan *dwc, bool drain)
831 struct dw_dma *dw = to_dw_dma(dwc->chan.device);
833 dw->resume_chan(dwc, drain);
835 clear_bit(DW_DMA_IS_PAUSED, &dwc->flags);
838 static int dwc_resume(struct dma_chan *chan)
840 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
841 unsigned long flags;
843 spin_lock_irqsave(&dwc->lock, flags);
845 if (test_bit(DW_DMA_IS_PAUSED, &dwc->flags))
846 dwc_chan_resume(dwc, false);
848 spin_unlock_irqrestore(&dwc->lock, flags);
850 return 0;
853 static int dwc_terminate_all(struct dma_chan *chan)
855 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
856 struct dw_dma *dw = to_dw_dma(chan->device);
857 struct dw_desc *desc, *_desc;
858 unsigned long flags;
859 LIST_HEAD(list);
861 spin_lock_irqsave(&dwc->lock, flags);
863 clear_bit(DW_DMA_IS_SOFT_LLP, &dwc->flags);
865 dwc_chan_pause(dwc, true);
867 dwc_chan_disable(dw, dwc);
869 dwc_chan_resume(dwc, true);
871 /* active_list entries will end up before queued entries */
872 list_splice_init(&dwc->queue, &list);
873 list_splice_init(&dwc->active_list, &list);
875 spin_unlock_irqrestore(&dwc->lock, flags);
877 /* Flush all pending and queued descriptors */
878 list_for_each_entry_safe(desc, _desc, &list, desc_node)
879 dwc_descriptor_complete(dwc, desc, false);
881 return 0;
884 static struct dw_desc *dwc_find_desc(struct dw_dma_chan *dwc, dma_cookie_t c)
886 struct dw_desc *desc;
888 list_for_each_entry(desc, &dwc->active_list, desc_node)
889 if (desc->txd.cookie == c)
890 return desc;
892 return NULL;
895 static u32 dwc_get_residue(struct dw_dma_chan *dwc, dma_cookie_t cookie)
897 struct dw_desc *desc;
898 unsigned long flags;
899 u32 residue;
901 spin_lock_irqsave(&dwc->lock, flags);
903 desc = dwc_find_desc(dwc, cookie);
904 if (desc) {
905 if (desc == dwc_first_active(dwc)) {
906 residue = desc->residue;
907 if (test_bit(DW_DMA_IS_SOFT_LLP, &dwc->flags) && residue)
908 residue -= dwc_get_sent(dwc);
909 } else {
910 residue = desc->total_len;
912 } else {
913 residue = 0;
916 spin_unlock_irqrestore(&dwc->lock, flags);
917 return residue;
920 static enum dma_status
921 dwc_tx_status(struct dma_chan *chan,
922 dma_cookie_t cookie,
923 struct dma_tx_state *txstate)
925 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
926 enum dma_status ret;
928 ret = dma_cookie_status(chan, cookie, txstate);
929 if (ret == DMA_COMPLETE)
930 return ret;
932 dwc_scan_descriptors(to_dw_dma(chan->device), dwc);
934 ret = dma_cookie_status(chan, cookie, txstate);
935 if (ret == DMA_COMPLETE)
936 return ret;
938 dma_set_residue(txstate, dwc_get_residue(dwc, cookie));
940 if (test_bit(DW_DMA_IS_PAUSED, &dwc->flags) && ret == DMA_IN_PROGRESS)
941 return DMA_PAUSED;
943 return ret;
946 static void dwc_issue_pending(struct dma_chan *chan)
948 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
949 unsigned long flags;
951 spin_lock_irqsave(&dwc->lock, flags);
952 if (list_empty(&dwc->active_list))
953 dwc_dostart_first_queued(dwc);
954 spin_unlock_irqrestore(&dwc->lock, flags);
957 /*----------------------------------------------------------------------*/
959 void do_dw_dma_off(struct dw_dma *dw)
961 dma_writel(dw, CFG, 0);
963 channel_clear_bit(dw, MASK.XFER, dw->all_chan_mask);
964 channel_clear_bit(dw, MASK.BLOCK, dw->all_chan_mask);
965 channel_clear_bit(dw, MASK.SRC_TRAN, dw->all_chan_mask);
966 channel_clear_bit(dw, MASK.DST_TRAN, dw->all_chan_mask);
967 channel_clear_bit(dw, MASK.ERROR, dw->all_chan_mask);
969 while (dma_readl(dw, CFG) & DW_CFG_DMA_EN)
970 cpu_relax();
973 void do_dw_dma_on(struct dw_dma *dw)
975 dma_writel(dw, CFG, DW_CFG_DMA_EN);
978 static int dwc_alloc_chan_resources(struct dma_chan *chan)
980 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
981 struct dw_dma *dw = to_dw_dma(chan->device);
983 dev_vdbg(chan2dev(chan), "%s\n", __func__);
985 pm_runtime_get_sync(dw->dma.dev);
987 /* ASSERT: channel is idle */
988 if (dma_readl(dw, CH_EN) & dwc->mask) {
989 pm_runtime_put_sync_suspend(dw->dma.dev);
990 dev_dbg(chan2dev(chan), "DMA channel not idle?\n");
991 return -EIO;
994 dma_cookie_init(chan);
997 * NOTE: some controllers may have additional features that we
998 * need to initialize here, like "scatter-gather" (which
999 * doesn't mean what you think it means), and status writeback.
1003 * We need controller-specific data to set up slave transfers.
1005 if (chan->private && !dw_dma_filter(chan, chan->private)) {
1006 pm_runtime_put_sync_suspend(dw->dma.dev);
1007 dev_warn(chan2dev(chan), "Wrong controller-specific data\n");
1008 return -EINVAL;
1011 /* Enable controller here if needed */
1012 if (!dw->in_use)
1013 do_dw_dma_on(dw);
1014 dw->in_use |= dwc->mask;
1016 return 0;
1019 static void dwc_free_chan_resources(struct dma_chan *chan)
1021 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
1022 struct dw_dma *dw = to_dw_dma(chan->device);
1023 unsigned long flags;
1025 dev_dbg(chan2dev(chan), "%s: descs allocated=%u\n", __func__,
1026 dwc->descs_allocated);
1028 /* ASSERT: channel is idle */
1029 BUG_ON(!list_empty(&dwc->active_list));
1030 BUG_ON(!list_empty(&dwc->queue));
1031 BUG_ON(dma_readl(to_dw_dma(chan->device), CH_EN) & dwc->mask);
1033 spin_lock_irqsave(&dwc->lock, flags);
1035 /* Clear custom channel configuration */
1036 memset(&dwc->dws, 0, sizeof(struct dw_dma_slave));
1038 /* Disable interrupts */
1039 channel_clear_bit(dw, MASK.XFER, dwc->mask);
1040 channel_clear_bit(dw, MASK.BLOCK, dwc->mask);
1041 channel_clear_bit(dw, MASK.ERROR, dwc->mask);
1043 spin_unlock_irqrestore(&dwc->lock, flags);
1045 /* Disable controller in case it was a last user */
1046 dw->in_use &= ~dwc->mask;
1047 if (!dw->in_use)
1048 do_dw_dma_off(dw);
1050 pm_runtime_put_sync_suspend(dw->dma.dev);
1052 dev_vdbg(chan2dev(chan), "%s: done\n", __func__);
1055 static void dwc_caps(struct dma_chan *chan, struct dma_slave_caps *caps)
1057 struct dw_dma_chan *dwc = to_dw_dma_chan(chan);
1059 caps->max_burst = dwc->max_burst;
1062 * It might be crucial for some devices to have the hardware
1063 * accelerated multi-block transfers supported, aka LLPs in DW DMAC
1064 * notation. So if LLPs are supported then max_sg_burst is set to
1065 * zero which means unlimited number of SG entries can be handled in a
1066 * single DMA transaction, otherwise it's just one SG entry.
1068 if (dwc->nollp)
1069 caps->max_sg_burst = 1;
1070 else
1071 caps->max_sg_burst = 0;
1074 int do_dma_probe(struct dw_dma_chip *chip)
1076 struct dw_dma *dw = chip->dw;
1077 struct dw_dma_platform_data *pdata;
1078 bool autocfg = false;
1079 unsigned int dw_params;
1080 unsigned int i;
1081 int err;
1083 dw->pdata = devm_kzalloc(chip->dev, sizeof(*dw->pdata), GFP_KERNEL);
1084 if (!dw->pdata)
1085 return -ENOMEM;
1087 dw->regs = chip->regs;
1089 pm_runtime_get_sync(chip->dev);
1091 if (!chip->pdata) {
1092 dw_params = dma_readl(dw, DW_PARAMS);
1093 dev_dbg(chip->dev, "DW_PARAMS: 0x%08x\n", dw_params);
1095 autocfg = dw_params >> DW_PARAMS_EN & 1;
1096 if (!autocfg) {
1097 err = -EINVAL;
1098 goto err_pdata;
1101 /* Reassign the platform data pointer */
1102 pdata = dw->pdata;
1104 /* Get hardware configuration parameters */
1105 pdata->nr_channels = (dw_params >> DW_PARAMS_NR_CHAN & 7) + 1;
1106 pdata->nr_masters = (dw_params >> DW_PARAMS_NR_MASTER & 3) + 1;
1107 for (i = 0; i < pdata->nr_masters; i++) {
1108 pdata->data_width[i] =
1109 4 << (dw_params >> DW_PARAMS_DATA_WIDTH(i) & 3);
1111 pdata->block_size = dma_readl(dw, MAX_BLK_SIZE);
1113 /* Fill platform data with the default values */
1114 pdata->chan_allocation_order = CHAN_ALLOCATION_ASCENDING;
1115 pdata->chan_priority = CHAN_PRIORITY_ASCENDING;
1116 } else if (chip->pdata->nr_channels > DW_DMA_MAX_NR_CHANNELS) {
1117 err = -EINVAL;
1118 goto err_pdata;
1119 } else {
1120 memcpy(dw->pdata, chip->pdata, sizeof(*dw->pdata));
1122 /* Reassign the platform data pointer */
1123 pdata = dw->pdata;
1126 dw->chan = devm_kcalloc(chip->dev, pdata->nr_channels, sizeof(*dw->chan),
1127 GFP_KERNEL);
1128 if (!dw->chan) {
1129 err = -ENOMEM;
1130 goto err_pdata;
1133 /* Calculate all channel mask before DMA setup */
1134 dw->all_chan_mask = (1 << pdata->nr_channels) - 1;
1136 /* Force dma off, just in case */
1137 dw->disable(dw);
1139 /* Device and instance ID for IRQ and DMA pool */
1140 dw->set_device_name(dw, chip->id);
1142 /* Create a pool of consistent memory blocks for hardware descriptors */
1143 dw->desc_pool = dmam_pool_create(dw->name, chip->dev,
1144 sizeof(struct dw_desc), 4, 0);
1145 if (!dw->desc_pool) {
1146 dev_err(chip->dev, "No memory for descriptors dma pool\n");
1147 err = -ENOMEM;
1148 goto err_pdata;
1151 tasklet_setup(&dw->tasklet, dw_dma_tasklet);
1153 err = request_irq(chip->irq, dw_dma_interrupt, IRQF_SHARED,
1154 dw->name, dw);
1155 if (err)
1156 goto err_pdata;
1158 INIT_LIST_HEAD(&dw->dma.channels);
1159 for (i = 0; i < pdata->nr_channels; i++) {
1160 struct dw_dma_chan *dwc = &dw->chan[i];
1162 dwc->chan.device = &dw->dma;
1163 dma_cookie_init(&dwc->chan);
1164 if (pdata->chan_allocation_order == CHAN_ALLOCATION_ASCENDING)
1165 list_add_tail(&dwc->chan.device_node,
1166 &dw->dma.channels);
1167 else
1168 list_add(&dwc->chan.device_node, &dw->dma.channels);
1170 /* 7 is highest priority & 0 is lowest. */
1171 if (pdata->chan_priority == CHAN_PRIORITY_ASCENDING)
1172 dwc->priority = pdata->nr_channels - i - 1;
1173 else
1174 dwc->priority = i;
1176 dwc->ch_regs = &__dw_regs(dw)->CHAN[i];
1177 spin_lock_init(&dwc->lock);
1178 dwc->mask = 1 << i;
1180 INIT_LIST_HEAD(&dwc->active_list);
1181 INIT_LIST_HEAD(&dwc->queue);
1183 channel_clear_bit(dw, CH_EN, dwc->mask);
1185 dwc->direction = DMA_TRANS_NONE;
1187 /* Hardware configuration */
1188 if (autocfg) {
1189 unsigned int r = DW_DMA_MAX_NR_CHANNELS - i - 1;
1190 void __iomem *addr = &__dw_regs(dw)->DWC_PARAMS[r];
1191 unsigned int dwc_params = readl(addr);
1193 dev_dbg(chip->dev, "DWC_PARAMS[%d]: 0x%08x\n", i,
1194 dwc_params);
1197 * Decode maximum block size for given channel. The
1198 * stored 4 bit value represents blocks from 0x00 for 3
1199 * up to 0x0a for 4095.
1201 dwc->block_size =
1202 (4 << ((pdata->block_size >> 4 * i) & 0xf)) - 1;
1205 * According to the DW DMA databook the true scatter-
1206 * gether LLPs aren't available if either multi-block
1207 * config is disabled (CHx_MULTI_BLK_EN == 0) or the
1208 * LLP register is hard-coded to zeros
1209 * (CHx_HC_LLP == 1).
1211 dwc->nollp =
1212 (dwc_params >> DWC_PARAMS_MBLK_EN & 0x1) == 0 ||
1213 (dwc_params >> DWC_PARAMS_HC_LLP & 0x1) == 1;
1214 dwc->max_burst =
1215 (0x4 << (dwc_params >> DWC_PARAMS_MSIZE & 0x7));
1216 } else {
1217 dwc->block_size = pdata->block_size;
1218 dwc->nollp = !pdata->multi_block[i];
1219 dwc->max_burst = pdata->max_burst[i] ?: DW_DMA_MAX_BURST;
1223 /* Clear all interrupts on all channels. */
1224 dma_writel(dw, CLEAR.XFER, dw->all_chan_mask);
1225 dma_writel(dw, CLEAR.BLOCK, dw->all_chan_mask);
1226 dma_writel(dw, CLEAR.SRC_TRAN, dw->all_chan_mask);
1227 dma_writel(dw, CLEAR.DST_TRAN, dw->all_chan_mask);
1228 dma_writel(dw, CLEAR.ERROR, dw->all_chan_mask);
1230 /* Set capabilities */
1231 dma_cap_set(DMA_SLAVE, dw->dma.cap_mask);
1232 dma_cap_set(DMA_PRIVATE, dw->dma.cap_mask);
1233 dma_cap_set(DMA_MEMCPY, dw->dma.cap_mask);
1235 dw->dma.dev = chip->dev;
1236 dw->dma.device_alloc_chan_resources = dwc_alloc_chan_resources;
1237 dw->dma.device_free_chan_resources = dwc_free_chan_resources;
1239 dw->dma.device_prep_dma_memcpy = dwc_prep_dma_memcpy;
1240 dw->dma.device_prep_slave_sg = dwc_prep_slave_sg;
1242 dw->dma.device_caps = dwc_caps;
1243 dw->dma.device_config = dwc_config;
1244 dw->dma.device_pause = dwc_pause;
1245 dw->dma.device_resume = dwc_resume;
1246 dw->dma.device_terminate_all = dwc_terminate_all;
1248 dw->dma.device_tx_status = dwc_tx_status;
1249 dw->dma.device_issue_pending = dwc_issue_pending;
1251 /* DMA capabilities */
1252 dw->dma.min_burst = DW_DMA_MIN_BURST;
1253 dw->dma.max_burst = DW_DMA_MAX_BURST;
1254 dw->dma.src_addr_widths = DW_DMA_BUSWIDTHS;
1255 dw->dma.dst_addr_widths = DW_DMA_BUSWIDTHS;
1256 dw->dma.directions = BIT(DMA_DEV_TO_MEM) | BIT(DMA_MEM_TO_DEV) |
1257 BIT(DMA_MEM_TO_MEM);
1258 dw->dma.residue_granularity = DMA_RESIDUE_GRANULARITY_BURST;
1261 * For now there is no hardware with non uniform maximum block size
1262 * across all of the device channels, so we set the maximum segment
1263 * size as the block size found for the very first channel.
1265 dma_set_max_seg_size(dw->dma.dev, dw->chan[0].block_size);
1267 err = dma_async_device_register(&dw->dma);
1268 if (err)
1269 goto err_dma_register;
1271 dev_info(chip->dev, "DesignWare DMA Controller, %d channels\n",
1272 pdata->nr_channels);
1274 pm_runtime_put_sync_suspend(chip->dev);
1276 return 0;
1278 err_dma_register:
1279 free_irq(chip->irq, dw);
1280 err_pdata:
1281 pm_runtime_put_sync_suspend(chip->dev);
1282 return err;
1285 int do_dma_remove(struct dw_dma_chip *chip)
1287 struct dw_dma *dw = chip->dw;
1288 struct dw_dma_chan *dwc, *_dwc;
1290 pm_runtime_get_sync(chip->dev);
1292 do_dw_dma_off(dw);
1293 dma_async_device_unregister(&dw->dma);
1295 free_irq(chip->irq, dw);
1296 tasklet_kill(&dw->tasklet);
1298 list_for_each_entry_safe(dwc, _dwc, &dw->dma.channels,
1299 chan.device_node) {
1300 list_del(&dwc->chan.device_node);
1301 channel_clear_bit(dw, CH_EN, dwc->mask);
1304 pm_runtime_put_sync_suspend(chip->dev);
1305 return 0;
1308 int do_dw_dma_disable(struct dw_dma_chip *chip)
1310 struct dw_dma *dw = chip->dw;
1312 dw->disable(dw);
1313 return 0;
1315 EXPORT_SYMBOL_GPL(do_dw_dma_disable);
1317 int do_dw_dma_enable(struct dw_dma_chip *chip)
1319 struct dw_dma *dw = chip->dw;
1321 dw->enable(dw);
1322 return 0;
1324 EXPORT_SYMBOL_GPL(do_dw_dma_enable);
1326 MODULE_LICENSE("GPL v2");
1327 MODULE_DESCRIPTION("Synopsys DesignWare DMA Controller core driver");
1328 MODULE_AUTHOR("Haavard Skinnemoen (Atmel)");
1329 MODULE_AUTHOR("Viresh Kumar <vireshk@kernel.org>");