2 * Renesas SuperH DMA Engine support
4 * base is drivers/dma/flsdma.c
6 * Copyright (C) 2009 Nobuhiro Iwamatsu <iwamatsu.nobuhiro@renesas.com>
7 * Copyright (C) 2009 Renesas Solutions, Inc. All rights reserved.
8 * Copyright (C) 2007 Freescale Semiconductor, Inc. All rights reserved.
10 * This is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * - DMA of SuperH does not have Hardware DMA chain mode.
16 * - MAX DMA size is 16MB.
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/dmaengine.h>
25 #include <linux/delay.h>
26 #include <linux/platform_device.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/sh_dma.h>
29 #include <linux/notifier.h>
30 #include <linux/kdebug.h>
31 #include <linux/spinlock.h>
32 #include <linux/rculist.h>
34 #include "dmaengine.h"
37 /* DMA descriptor control */
38 enum sh_dmae_desc_status {
42 DESC_COMPLETED, /* completed, have to call callback */
43 DESC_WAITING, /* callback called, waiting for ack / re-submit */
46 #define NR_DESCS_PER_CHANNEL 32
47 /* Default MEMCPY transfer size = 2^2 = 4 bytes */
48 #define LOG2_DEFAULT_XFER_SIZE 2
51 * Used for write-side mutual exclusion for the global device list,
52 * read-side synchronization by way of RCU, and per-controller data.
54 static DEFINE_SPINLOCK(sh_dmae_lock);
55 static LIST_HEAD(sh_dmae_devices);
57 /* A bitmask with bits enough for enum sh_dmae_slave_chan_id */
58 static unsigned long sh_dmae_slave_used[BITS_TO_LONGS(SH_DMA_SLAVE_NUMBER)];
60 static void sh_dmae_chan_ld_cleanup(struct sh_dmae_chan *sh_chan, bool all);
61 static void sh_chan_xfer_ld_queue(struct sh_dmae_chan *sh_chan);
63 static void chclr_write(struct sh_dmae_chan *sh_dc, u32 data)
65 struct sh_dmae_device *shdev = to_sh_dev(sh_dc);
67 __raw_writel(data, shdev->chan_reg +
68 shdev->pdata->channel[sh_dc->id].chclr_offset);
71 static void sh_dmae_writel(struct sh_dmae_chan *sh_dc, u32 data, u32 reg)
73 __raw_writel(data, sh_dc->base + reg / sizeof(u32));
76 static u32 sh_dmae_readl(struct sh_dmae_chan *sh_dc, u32 reg)
78 return __raw_readl(sh_dc->base + reg / sizeof(u32));
81 static u16 dmaor_read(struct sh_dmae_device *shdev)
83 u32 __iomem *addr = shdev->chan_reg + DMAOR / sizeof(u32);
85 if (shdev->pdata->dmaor_is_32bit)
86 return __raw_readl(addr);
88 return __raw_readw(addr);
91 static void dmaor_write(struct sh_dmae_device *shdev, u16 data)
93 u32 __iomem *addr = shdev->chan_reg + DMAOR / sizeof(u32);
95 if (shdev->pdata->dmaor_is_32bit)
96 __raw_writel(data, addr);
98 __raw_writew(data, addr);
101 static void chcr_write(struct sh_dmae_chan *sh_dc, u32 data)
103 struct sh_dmae_device *shdev = to_sh_dev(sh_dc);
105 __raw_writel(data, sh_dc->base + shdev->chcr_offset / sizeof(u32));
108 static u32 chcr_read(struct sh_dmae_chan *sh_dc)
110 struct sh_dmae_device *shdev = to_sh_dev(sh_dc);
112 return __raw_readl(sh_dc->base + shdev->chcr_offset / sizeof(u32));
116 * Reset DMA controller
118 * SH7780 has two DMAOR register
120 static void sh_dmae_ctl_stop(struct sh_dmae_device *shdev)
122 unsigned short dmaor;
125 spin_lock_irqsave(&sh_dmae_lock, flags);
127 dmaor = dmaor_read(shdev);
128 dmaor_write(shdev, dmaor & ~(DMAOR_NMIF | DMAOR_AE | DMAOR_DME));
130 spin_unlock_irqrestore(&sh_dmae_lock, flags);
133 static int sh_dmae_rst(struct sh_dmae_device *shdev)
135 unsigned short dmaor;
138 spin_lock_irqsave(&sh_dmae_lock, flags);
140 dmaor = dmaor_read(shdev) & ~(DMAOR_NMIF | DMAOR_AE | DMAOR_DME);
142 if (shdev->pdata->chclr_present) {
144 for (i = 0; i < shdev->pdata->channel_num; i++) {
145 struct sh_dmae_chan *sh_chan = shdev->chan[i];
147 chclr_write(sh_chan, 0);
151 dmaor_write(shdev, dmaor | shdev->pdata->dmaor_init);
153 dmaor = dmaor_read(shdev);
155 spin_unlock_irqrestore(&sh_dmae_lock, flags);
157 if (dmaor & (DMAOR_AE | DMAOR_NMIF)) {
158 dev_warn(shdev->common.dev, "Can't initialize DMAOR.\n");
161 if (shdev->pdata->dmaor_init & ~dmaor)
162 dev_warn(shdev->common.dev,
163 "DMAOR=0x%x hasn't latched the initial value 0x%x.\n",
164 dmaor, shdev->pdata->dmaor_init);
168 static bool dmae_is_busy(struct sh_dmae_chan *sh_chan)
170 u32 chcr = chcr_read(sh_chan);
172 if ((chcr & (CHCR_DE | CHCR_TE)) == CHCR_DE)
173 return true; /* working */
175 return false; /* waiting */
178 static unsigned int calc_xmit_shift(struct sh_dmae_chan *sh_chan, u32 chcr)
180 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
181 struct sh_dmae_pdata *pdata = shdev->pdata;
182 int cnt = ((chcr & pdata->ts_low_mask) >> pdata->ts_low_shift) |
183 ((chcr & pdata->ts_high_mask) >> pdata->ts_high_shift);
185 if (cnt >= pdata->ts_shift_num)
188 return pdata->ts_shift[cnt];
191 static u32 log2size_to_chcr(struct sh_dmae_chan *sh_chan, int l2size)
193 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
194 struct sh_dmae_pdata *pdata = shdev->pdata;
197 for (i = 0; i < pdata->ts_shift_num; i++)
198 if (pdata->ts_shift[i] == l2size)
201 if (i == pdata->ts_shift_num)
204 return ((i << pdata->ts_low_shift) & pdata->ts_low_mask) |
205 ((i << pdata->ts_high_shift) & pdata->ts_high_mask);
208 static void dmae_set_reg(struct sh_dmae_chan *sh_chan, struct sh_dmae_regs *hw)
210 sh_dmae_writel(sh_chan, hw->sar, SAR);
211 sh_dmae_writel(sh_chan, hw->dar, DAR);
212 sh_dmae_writel(sh_chan, hw->tcr >> sh_chan->xmit_shift, TCR);
215 static void dmae_start(struct sh_dmae_chan *sh_chan)
217 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
218 u32 chcr = chcr_read(sh_chan);
220 if (shdev->pdata->needs_tend_set)
221 sh_dmae_writel(sh_chan, 0xFFFFFFFF, TEND);
223 chcr |= CHCR_DE | shdev->chcr_ie_bit;
224 chcr_write(sh_chan, chcr & ~CHCR_TE);
227 static void dmae_halt(struct sh_dmae_chan *sh_chan)
229 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
230 u32 chcr = chcr_read(sh_chan);
232 chcr &= ~(CHCR_DE | CHCR_TE | shdev->chcr_ie_bit);
233 chcr_write(sh_chan, chcr);
236 static void dmae_init(struct sh_dmae_chan *sh_chan)
239 * Default configuration for dual address memory-memory transfer.
240 * 0x400 represents auto-request.
242 u32 chcr = DM_INC | SM_INC | 0x400 | log2size_to_chcr(sh_chan,
243 LOG2_DEFAULT_XFER_SIZE);
244 sh_chan->xmit_shift = calc_xmit_shift(sh_chan, chcr);
245 chcr_write(sh_chan, chcr);
248 static int dmae_set_chcr(struct sh_dmae_chan *sh_chan, u32 val)
250 /* If DMA is active, cannot set CHCR. TODO: remove this superfluous check */
251 if (dmae_is_busy(sh_chan))
254 sh_chan->xmit_shift = calc_xmit_shift(sh_chan, val);
255 chcr_write(sh_chan, val);
260 static int dmae_set_dmars(struct sh_dmae_chan *sh_chan, u16 val)
262 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
263 struct sh_dmae_pdata *pdata = shdev->pdata;
264 const struct sh_dmae_channel *chan_pdata = &pdata->channel[sh_chan->id];
265 u16 __iomem *addr = shdev->dmars;
266 unsigned int shift = chan_pdata->dmars_bit;
268 if (dmae_is_busy(sh_chan))
274 /* in the case of a missing DMARS resource use first memory window */
276 addr = (u16 __iomem *)shdev->chan_reg;
277 addr += chan_pdata->dmars / sizeof(u16);
279 __raw_writew((__raw_readw(addr) & (0xff00 >> shift)) | (val << shift),
285 static dma_cookie_t sh_dmae_tx_submit(struct dma_async_tx_descriptor *tx)
287 struct sh_desc *desc = tx_to_sh_desc(tx), *chunk, *last = desc, *c;
288 struct sh_dmae_chan *sh_chan = to_sh_chan(tx->chan);
289 struct sh_dmae_slave *param = tx->chan->private;
290 dma_async_tx_callback callback = tx->callback;
294 spin_lock_irq(&sh_chan->desc_lock);
296 if (list_empty(&sh_chan->ld_queue))
301 cookie = dma_cookie_assign(tx);
303 /* Mark all chunks of this descriptor as submitted, move to the queue */
304 list_for_each_entry_safe(chunk, c, desc->node.prev, node) {
306 * All chunks are on the global ld_free, so, we have to find
307 * the end of the chain ourselves
309 if (chunk != desc && (chunk->mark == DESC_IDLE ||
310 chunk->async_tx.cookie > 0 ||
311 chunk->async_tx.cookie == -EBUSY ||
312 &chunk->node == &sh_chan->ld_free))
314 chunk->mark = DESC_SUBMITTED;
315 /* Callback goes to the last chunk */
316 chunk->async_tx.callback = NULL;
317 chunk->cookie = cookie;
318 list_move_tail(&chunk->node, &sh_chan->ld_queue);
322 last->async_tx.callback = callback;
323 last->async_tx.callback_param = tx->callback_param;
325 dev_dbg(sh_chan->dev, "submit #%d@%p on %d: %x[%d] -> %x\n",
326 tx->cookie, &last->async_tx, sh_chan->id,
327 desc->hw.sar, desc->hw.tcr, desc->hw.dar);
330 sh_chan->pm_state = DMAE_PM_BUSY;
332 pm_runtime_get(sh_chan->dev);
334 spin_unlock_irq(&sh_chan->desc_lock);
336 pm_runtime_barrier(sh_chan->dev);
338 spin_lock_irq(&sh_chan->desc_lock);
340 /* Have we been reset, while waiting? */
341 if (sh_chan->pm_state != DMAE_PM_ESTABLISHED) {
342 dev_dbg(sh_chan->dev, "Bring up channel %d\n",
345 const struct sh_dmae_slave_config *cfg =
348 dmae_set_dmars(sh_chan, cfg->mid_rid);
349 dmae_set_chcr(sh_chan, cfg->chcr);
354 if (sh_chan->pm_state == DMAE_PM_PENDING)
355 sh_chan_xfer_ld_queue(sh_chan);
356 sh_chan->pm_state = DMAE_PM_ESTABLISHED;
359 sh_chan->pm_state = DMAE_PM_PENDING;
362 spin_unlock_irq(&sh_chan->desc_lock);
367 /* Called with desc_lock held */
368 static struct sh_desc *sh_dmae_get_desc(struct sh_dmae_chan *sh_chan)
370 struct sh_desc *desc;
372 list_for_each_entry(desc, &sh_chan->ld_free, node)
373 if (desc->mark != DESC_PREPARED) {
374 BUG_ON(desc->mark != DESC_IDLE);
375 list_del(&desc->node);
382 static const struct sh_dmae_slave_config *sh_dmae_find_slave(
383 struct sh_dmae_chan *sh_chan, struct sh_dmae_slave *param)
385 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
386 struct sh_dmae_pdata *pdata = shdev->pdata;
389 if (param->slave_id >= SH_DMA_SLAVE_NUMBER)
392 for (i = 0; i < pdata->slave_num; i++)
393 if (pdata->slave[i].slave_id == param->slave_id)
394 return pdata->slave + i;
399 static int sh_dmae_alloc_chan_resources(struct dma_chan *chan)
401 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
402 struct sh_desc *desc;
403 struct sh_dmae_slave *param = chan->private;
407 * This relies on the guarantee from dmaengine that alloc_chan_resources
408 * never runs concurrently with itself or free_chan_resources.
411 const struct sh_dmae_slave_config *cfg;
413 cfg = sh_dmae_find_slave(sh_chan, param);
419 if (test_and_set_bit(param->slave_id, sh_dmae_slave_used)) {
427 while (sh_chan->descs_allocated < NR_DESCS_PER_CHANNEL) {
428 desc = kzalloc(sizeof(struct sh_desc), GFP_KERNEL);
431 dma_async_tx_descriptor_init(&desc->async_tx,
433 desc->async_tx.tx_submit = sh_dmae_tx_submit;
434 desc->mark = DESC_IDLE;
436 list_add(&desc->node, &sh_chan->ld_free);
437 sh_chan->descs_allocated++;
440 if (!sh_chan->descs_allocated) {
445 return sh_chan->descs_allocated;
449 clear_bit(param->slave_id, sh_dmae_slave_used);
452 chan->private = NULL;
457 * sh_dma_free_chan_resources - Free all resources of the channel.
459 static void sh_dmae_free_chan_resources(struct dma_chan *chan)
461 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
462 struct sh_desc *desc, *_desc;
465 /* Protect against ISR */
466 spin_lock_irq(&sh_chan->desc_lock);
468 spin_unlock_irq(&sh_chan->desc_lock);
470 /* Now no new interrupts will occur */
472 /* Prepared and not submitted descriptors can still be on the queue */
473 if (!list_empty(&sh_chan->ld_queue))
474 sh_dmae_chan_ld_cleanup(sh_chan, true);
477 /* The caller is holding dma_list_mutex */
478 struct sh_dmae_slave *param = chan->private;
479 clear_bit(param->slave_id, sh_dmae_slave_used);
480 chan->private = NULL;
483 spin_lock_irq(&sh_chan->desc_lock);
485 list_splice_init(&sh_chan->ld_free, &list);
486 sh_chan->descs_allocated = 0;
488 spin_unlock_irq(&sh_chan->desc_lock);
490 list_for_each_entry_safe(desc, _desc, &list, node)
495 * sh_dmae_add_desc - get, set up and return one transfer descriptor
496 * @sh_chan: DMA channel
497 * @flags: DMA transfer flags
498 * @dest: destination DMA address, incremented when direction equals
500 * @src: source DMA address, incremented when direction equals
502 * @len: DMA transfer length
503 * @first: if NULL, set to the current descriptor and cookie set to -EBUSY
504 * @direction: needed for slave DMA to decide which address to keep constant,
505 * equals DMA_MEM_TO_MEM for MEMCPY
506 * Returns 0 or an error
507 * Locks: called with desc_lock held
509 static struct sh_desc *sh_dmae_add_desc(struct sh_dmae_chan *sh_chan,
510 unsigned long flags, dma_addr_t *dest, dma_addr_t *src, size_t *len,
511 struct sh_desc **first, enum dma_transfer_direction direction)
519 /* Allocate the link descriptor from the free list */
520 new = sh_dmae_get_desc(sh_chan);
522 dev_err(sh_chan->dev, "No free link descriptor available\n");
526 copy_size = min(*len, (size_t)SH_DMA_TCR_MAX + 1);
530 new->hw.tcr = copy_size;
534 new->async_tx.cookie = -EBUSY;
537 /* Other desc - invisible to the user */
538 new->async_tx.cookie = -EINVAL;
541 dev_dbg(sh_chan->dev,
542 "chaining (%u/%u)@%x -> %x with %p, cookie %d, shift %d\n",
543 copy_size, *len, *src, *dest, &new->async_tx,
544 new->async_tx.cookie, sh_chan->xmit_shift);
546 new->mark = DESC_PREPARED;
547 new->async_tx.flags = flags;
548 new->direction = direction;
551 if (direction == DMA_MEM_TO_MEM || direction == DMA_MEM_TO_DEV)
553 if (direction == DMA_MEM_TO_MEM || direction == DMA_DEV_TO_MEM)
560 * sh_dmae_prep_sg - prepare transfer descriptors from an SG list
562 * Common routine for public (MEMCPY) and slave DMA. The MEMCPY case is also
563 * converted to scatter-gather to guarantee consistent locking and a correct
564 * list manipulation. For slave DMA direction carries the usual meaning, and,
565 * logically, the SG list is RAM and the addr variable contains slave address,
566 * e.g., the FIFO I/O register. For MEMCPY direction equals DMA_MEM_TO_MEM
567 * and the SG list contains only one element and points at the source buffer.
569 static struct dma_async_tx_descriptor *sh_dmae_prep_sg(struct sh_dmae_chan *sh_chan,
570 struct scatterlist *sgl, unsigned int sg_len, dma_addr_t *addr,
571 enum dma_transfer_direction direction, unsigned long flags)
573 struct scatterlist *sg;
574 struct sh_desc *first = NULL, *new = NULL /* compiler... */;
577 unsigned long irq_flags;
583 for_each_sg(sgl, sg, sg_len, i)
584 chunks += (sg_dma_len(sg) + SH_DMA_TCR_MAX) /
585 (SH_DMA_TCR_MAX + 1);
587 /* Have to lock the whole loop to protect against concurrent release */
588 spin_lock_irqsave(&sh_chan->desc_lock, irq_flags);
592 * first descriptor is what user is dealing with in all API calls, its
593 * cookie is at first set to -EBUSY, at tx-submit to a positive
595 * if more than one chunk is needed further chunks have cookie = -EINVAL
596 * the last chunk, if not equal to the first, has cookie = -ENOSPC
597 * all chunks are linked onto the tx_list head with their .node heads
598 * only during this function, then they are immediately spliced
599 * back onto the free list in form of a chain
601 for_each_sg(sgl, sg, sg_len, i) {
602 dma_addr_t sg_addr = sg_dma_address(sg);
603 size_t len = sg_dma_len(sg);
609 dev_dbg(sh_chan->dev, "Add SG #%d@%p[%d], dma %llx\n",
610 i, sg, len, (unsigned long long)sg_addr);
612 if (direction == DMA_DEV_TO_MEM)
613 new = sh_dmae_add_desc(sh_chan, flags,
614 &sg_addr, addr, &len, &first,
617 new = sh_dmae_add_desc(sh_chan, flags,
618 addr, &sg_addr, &len, &first,
623 new->chunks = chunks--;
624 list_add_tail(&new->node, &tx_list);
629 new->async_tx.cookie = -ENOSPC;
631 /* Put them back on the free list, so, they don't get lost */
632 list_splice_tail(&tx_list, &sh_chan->ld_free);
634 spin_unlock_irqrestore(&sh_chan->desc_lock, irq_flags);
636 return &first->async_tx;
639 list_for_each_entry(new, &tx_list, node)
640 new->mark = DESC_IDLE;
641 list_splice(&tx_list, &sh_chan->ld_free);
643 spin_unlock_irqrestore(&sh_chan->desc_lock, irq_flags);
648 static struct dma_async_tx_descriptor *sh_dmae_prep_memcpy(
649 struct dma_chan *chan, dma_addr_t dma_dest, dma_addr_t dma_src,
650 size_t len, unsigned long flags)
652 struct sh_dmae_chan *sh_chan;
653 struct scatterlist sg;
658 sh_chan = to_sh_chan(chan);
660 sg_init_table(&sg, 1);
661 sg_set_page(&sg, pfn_to_page(PFN_DOWN(dma_src)), len,
662 offset_in_page(dma_src));
663 sg_dma_address(&sg) = dma_src;
664 sg_dma_len(&sg) = len;
666 return sh_dmae_prep_sg(sh_chan, &sg, 1, &dma_dest, DMA_MEM_TO_MEM,
670 static struct dma_async_tx_descriptor *sh_dmae_prep_slave_sg(
671 struct dma_chan *chan, struct scatterlist *sgl, unsigned int sg_len,
672 enum dma_transfer_direction direction, unsigned long flags)
674 struct sh_dmae_slave *param;
675 struct sh_dmae_chan *sh_chan;
676 dma_addr_t slave_addr;
681 sh_chan = to_sh_chan(chan);
682 param = chan->private;
684 /* Someone calling slave DMA on a public channel? */
685 if (!param || !sg_len) {
686 dev_warn(sh_chan->dev, "%s: bad parameter: %p, %d, %d\n",
687 __func__, param, sg_len, param ? param->slave_id : -1);
691 slave_addr = param->config->addr;
694 * if (param != NULL), this is a successfully requested slave channel,
695 * therefore param->config != NULL too.
697 return sh_dmae_prep_sg(sh_chan, sgl, sg_len, &slave_addr,
701 static int sh_dmae_control(struct dma_chan *chan, enum dma_ctrl_cmd cmd,
704 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
707 /* Only supports DMA_TERMINATE_ALL */
708 if (cmd != DMA_TERMINATE_ALL)
714 spin_lock_irqsave(&sh_chan->desc_lock, flags);
717 if (!list_empty(&sh_chan->ld_queue)) {
718 /* Record partial transfer */
719 struct sh_desc *desc = list_entry(sh_chan->ld_queue.next,
720 struct sh_desc, node);
721 desc->partial = (desc->hw.tcr - sh_dmae_readl(sh_chan, TCR)) <<
724 spin_unlock_irqrestore(&sh_chan->desc_lock, flags);
726 sh_dmae_chan_ld_cleanup(sh_chan, true);
731 static dma_async_tx_callback __ld_cleanup(struct sh_dmae_chan *sh_chan, bool all)
733 struct sh_desc *desc, *_desc;
734 /* Is the "exposed" head of a chain acked? */
735 bool head_acked = false;
736 dma_cookie_t cookie = 0;
737 dma_async_tx_callback callback = NULL;
741 spin_lock_irqsave(&sh_chan->desc_lock, flags);
742 list_for_each_entry_safe(desc, _desc, &sh_chan->ld_queue, node) {
743 struct dma_async_tx_descriptor *tx = &desc->async_tx;
745 BUG_ON(tx->cookie > 0 && tx->cookie != desc->cookie);
746 BUG_ON(desc->mark != DESC_SUBMITTED &&
747 desc->mark != DESC_COMPLETED &&
748 desc->mark != DESC_WAITING);
751 * queue is ordered, and we use this loop to (1) clean up all
752 * completed descriptors, and to (2) update descriptor flags of
753 * any chunks in a (partially) completed chain
755 if (!all && desc->mark == DESC_SUBMITTED &&
756 desc->cookie != cookie)
762 if (desc->mark == DESC_COMPLETED && desc->chunks == 1) {
763 if (sh_chan->common.completed_cookie != desc->cookie - 1)
764 dev_dbg(sh_chan->dev,
765 "Completing cookie %d, expected %d\n",
767 sh_chan->common.completed_cookie + 1);
768 sh_chan->common.completed_cookie = desc->cookie;
771 /* Call callback on the last chunk */
772 if (desc->mark == DESC_COMPLETED && tx->callback) {
773 desc->mark = DESC_WAITING;
774 callback = tx->callback;
775 param = tx->callback_param;
776 dev_dbg(sh_chan->dev, "descriptor #%d@%p on %d callback\n",
777 tx->cookie, tx, sh_chan->id);
778 BUG_ON(desc->chunks != 1);
782 if (tx->cookie > 0 || tx->cookie == -EBUSY) {
783 if (desc->mark == DESC_COMPLETED) {
784 BUG_ON(tx->cookie < 0);
785 desc->mark = DESC_WAITING;
787 head_acked = async_tx_test_ack(tx);
789 switch (desc->mark) {
791 desc->mark = DESC_WAITING;
795 async_tx_ack(&desc->async_tx);
799 dev_dbg(sh_chan->dev, "descriptor %p #%d completed.\n",
802 if (((desc->mark == DESC_COMPLETED ||
803 desc->mark == DESC_WAITING) &&
804 async_tx_test_ack(&desc->async_tx)) || all) {
805 /* Remove from ld_queue list */
806 desc->mark = DESC_IDLE;
808 list_move(&desc->node, &sh_chan->ld_free);
810 if (list_empty(&sh_chan->ld_queue)) {
811 dev_dbg(sh_chan->dev, "Bring down channel %d\n", sh_chan->id);
812 pm_runtime_put(sh_chan->dev);
817 if (all && !callback)
819 * Terminating and the loop completed normally: forgive
820 * uncompleted cookies
822 sh_chan->common.completed_cookie = sh_chan->common.cookie;
824 spin_unlock_irqrestore(&sh_chan->desc_lock, flags);
833 * sh_chan_ld_cleanup - Clean up link descriptors
835 * This function cleans up the ld_queue of DMA channel.
837 static void sh_dmae_chan_ld_cleanup(struct sh_dmae_chan *sh_chan, bool all)
839 while (__ld_cleanup(sh_chan, all))
843 /* Called under spin_lock_irq(&sh_chan->desc_lock) */
844 static void sh_chan_xfer_ld_queue(struct sh_dmae_chan *sh_chan)
846 struct sh_desc *desc;
849 if (dmae_is_busy(sh_chan))
852 /* Find the first not transferred descriptor */
853 list_for_each_entry(desc, &sh_chan->ld_queue, node)
854 if (desc->mark == DESC_SUBMITTED) {
855 dev_dbg(sh_chan->dev, "Queue #%d to %d: %u@%x -> %x\n",
856 desc->async_tx.cookie, sh_chan->id,
857 desc->hw.tcr, desc->hw.sar, desc->hw.dar);
858 /* Get the ld start address from ld_queue */
859 dmae_set_reg(sh_chan, &desc->hw);
865 static void sh_dmae_memcpy_issue_pending(struct dma_chan *chan)
867 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
869 spin_lock_irq(&sh_chan->desc_lock);
870 if (sh_chan->pm_state == DMAE_PM_ESTABLISHED)
871 sh_chan_xfer_ld_queue(sh_chan);
873 sh_chan->pm_state = DMAE_PM_PENDING;
874 spin_unlock_irq(&sh_chan->desc_lock);
877 static enum dma_status sh_dmae_tx_status(struct dma_chan *chan,
879 struct dma_tx_state *txstate)
881 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
882 dma_cookie_t last_used;
883 dma_cookie_t last_complete;
884 enum dma_status status;
887 sh_dmae_chan_ld_cleanup(sh_chan, false);
889 /* First read completed cookie to avoid a skew */
890 last_complete = chan->completed_cookie;
892 last_used = chan->cookie;
893 BUG_ON(last_complete < 0);
894 dma_set_tx_state(txstate, last_complete, last_used, 0);
896 spin_lock_irqsave(&sh_chan->desc_lock, flags);
898 status = dma_async_is_complete(cookie, last_complete, last_used);
901 * If we don't find cookie on the queue, it has been aborted and we have
904 if (status != DMA_SUCCESS) {
905 struct sh_desc *desc;
907 list_for_each_entry(desc, &sh_chan->ld_queue, node)
908 if (desc->cookie == cookie) {
909 status = DMA_IN_PROGRESS;
914 spin_unlock_irqrestore(&sh_chan->desc_lock, flags);
919 static irqreturn_t sh_dmae_interrupt(int irq, void *data)
921 irqreturn_t ret = IRQ_NONE;
922 struct sh_dmae_chan *sh_chan = data;
925 spin_lock(&sh_chan->desc_lock);
927 chcr = chcr_read(sh_chan);
929 if (chcr & CHCR_TE) {
934 tasklet_schedule(&sh_chan->tasklet);
937 spin_unlock(&sh_chan->desc_lock);
942 /* Called from error IRQ or NMI */
943 static bool sh_dmae_reset(struct sh_dmae_device *shdev)
945 unsigned int handled = 0;
948 /* halt the dma controller */
949 sh_dmae_ctl_stop(shdev);
951 /* We cannot detect, which channel caused the error, have to reset all */
952 for (i = 0; i < SH_DMAC_MAX_CHANNELS; i++) {
953 struct sh_dmae_chan *sh_chan = shdev->chan[i];
954 struct sh_desc *desc;
960 spin_lock(&sh_chan->desc_lock);
962 /* Stop the channel */
965 list_splice_init(&sh_chan->ld_queue, &dl);
967 if (!list_empty(&dl)) {
968 dev_dbg(sh_chan->dev, "Bring down channel %d\n", sh_chan->id);
969 pm_runtime_put(sh_chan->dev);
971 sh_chan->pm_state = DMAE_PM_ESTABLISHED;
973 spin_unlock(&sh_chan->desc_lock);
976 list_for_each_entry(desc, &dl, node) {
977 struct dma_async_tx_descriptor *tx = &desc->async_tx;
978 desc->mark = DESC_IDLE;
980 tx->callback(tx->callback_param);
983 spin_lock(&sh_chan->desc_lock);
984 list_splice(&dl, &sh_chan->ld_free);
985 spin_unlock(&sh_chan->desc_lock);
995 static irqreturn_t sh_dmae_err(int irq, void *data)
997 struct sh_dmae_device *shdev = data;
999 if (!(dmaor_read(shdev) & DMAOR_AE))
1002 sh_dmae_reset(data);
1006 static void dmae_do_tasklet(unsigned long data)
1008 struct sh_dmae_chan *sh_chan = (struct sh_dmae_chan *)data;
1009 struct sh_desc *desc;
1010 u32 sar_buf = sh_dmae_readl(sh_chan, SAR);
1011 u32 dar_buf = sh_dmae_readl(sh_chan, DAR);
1013 spin_lock_irq(&sh_chan->desc_lock);
1014 list_for_each_entry(desc, &sh_chan->ld_queue, node) {
1015 if (desc->mark == DESC_SUBMITTED &&
1016 ((desc->direction == DMA_DEV_TO_MEM &&
1017 (desc->hw.dar + desc->hw.tcr) == dar_buf) ||
1018 (desc->hw.sar + desc->hw.tcr) == sar_buf)) {
1019 dev_dbg(sh_chan->dev, "done #%d@%p dst %u\n",
1020 desc->async_tx.cookie, &desc->async_tx,
1022 desc->mark = DESC_COMPLETED;
1027 sh_chan_xfer_ld_queue(sh_chan);
1028 spin_unlock_irq(&sh_chan->desc_lock);
1030 sh_dmae_chan_ld_cleanup(sh_chan, false);
1033 static bool sh_dmae_nmi_notify(struct sh_dmae_device *shdev)
1035 /* Fast path out if NMIF is not asserted for this controller */
1036 if ((dmaor_read(shdev) & DMAOR_NMIF) == 0)
1039 return sh_dmae_reset(shdev);
1042 static int sh_dmae_nmi_handler(struct notifier_block *self,
1043 unsigned long cmd, void *data)
1045 struct sh_dmae_device *shdev;
1046 int ret = NOTIFY_DONE;
1050 * Only concern ourselves with NMI events.
1052 * Normally we would check the die chain value, but as this needs
1053 * to be architecture independent, check for NMI context instead.
1059 list_for_each_entry_rcu(shdev, &sh_dmae_devices, node) {
1061 * Only stop if one of the controllers has NMIF asserted,
1062 * we do not want to interfere with regular address error
1063 * handling or NMI events that don't concern the DMACs.
1065 triggered = sh_dmae_nmi_notify(shdev);
1066 if (triggered == true)
1074 static struct notifier_block sh_dmae_nmi_notifier __read_mostly = {
1075 .notifier_call = sh_dmae_nmi_handler,
1077 /* Run before NMI debug handler and KGDB */
1081 static int __devinit sh_dmae_chan_probe(struct sh_dmae_device *shdev, int id,
1082 int irq, unsigned long flags)
1085 const struct sh_dmae_channel *chan_pdata = &shdev->pdata->channel[id];
1086 struct platform_device *pdev = to_platform_device(shdev->common.dev);
1087 struct sh_dmae_chan *new_sh_chan;
1090 new_sh_chan = kzalloc(sizeof(struct sh_dmae_chan), GFP_KERNEL);
1092 dev_err(shdev->common.dev,
1093 "No free memory for allocating dma channels!\n");
1097 new_sh_chan->pm_state = DMAE_PM_ESTABLISHED;
1099 /* reference struct dma_device */
1100 new_sh_chan->common.device = &shdev->common;
1102 new_sh_chan->dev = shdev->common.dev;
1103 new_sh_chan->id = id;
1104 new_sh_chan->irq = irq;
1105 new_sh_chan->base = shdev->chan_reg + chan_pdata->offset / sizeof(u32);
1107 /* Init DMA tasklet */
1108 tasklet_init(&new_sh_chan->tasklet, dmae_do_tasklet,
1109 (unsigned long)new_sh_chan);
1111 spin_lock_init(&new_sh_chan->desc_lock);
1113 /* Init descripter manage list */
1114 INIT_LIST_HEAD(&new_sh_chan->ld_queue);
1115 INIT_LIST_HEAD(&new_sh_chan->ld_free);
1117 /* Add the channel to DMA device channel list */
1118 list_add_tail(&new_sh_chan->common.device_node,
1119 &shdev->common.channels);
1120 shdev->common.chancnt++;
1123 snprintf(new_sh_chan->dev_id, sizeof(new_sh_chan->dev_id),
1124 "sh-dmae%d.%d", pdev->id, new_sh_chan->id);
1126 snprintf(new_sh_chan->dev_id, sizeof(new_sh_chan->dev_id),
1127 "sh-dma%d", new_sh_chan->id);
1129 /* set up channel irq */
1130 err = request_irq(irq, &sh_dmae_interrupt, flags,
1131 new_sh_chan->dev_id, new_sh_chan);
1133 dev_err(shdev->common.dev, "DMA channel %d request_irq error "
1134 "with return %d\n", id, err);
1138 shdev->chan[id] = new_sh_chan;
1142 /* remove from dmaengine device node */
1143 list_del(&new_sh_chan->common.device_node);
1148 static void sh_dmae_chan_remove(struct sh_dmae_device *shdev)
1152 for (i = shdev->common.chancnt - 1 ; i >= 0 ; i--) {
1153 if (shdev->chan[i]) {
1154 struct sh_dmae_chan *sh_chan = shdev->chan[i];
1156 free_irq(sh_chan->irq, sh_chan);
1158 list_del(&sh_chan->common.device_node);
1160 shdev->chan[i] = NULL;
1163 shdev->common.chancnt = 0;
1166 static int __init sh_dmae_probe(struct platform_device *pdev)
1168 struct sh_dmae_pdata *pdata = pdev->dev.platform_data;
1169 unsigned long irqflags = IRQF_DISABLED,
1170 chan_flag[SH_DMAC_MAX_CHANNELS] = {};
1171 int errirq, chan_irq[SH_DMAC_MAX_CHANNELS];
1172 int err, i, irq_cnt = 0, irqres = 0, irq_cap = 0;
1173 struct sh_dmae_device *shdev;
1174 struct resource *chan, *dmars, *errirq_res, *chanirq_res;
1176 /* get platform data */
1177 if (!pdata || !pdata->channel_num)
1180 chan = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1181 /* DMARS area is optional */
1182 dmars = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1185 * 1. there always must be at least one IRQ IO-resource. On SH4 it is
1186 * the error IRQ, in which case it is the only IRQ in this resource:
1187 * start == end. If it is the only IRQ resource, all channels also
1189 * 2. DMA channel IRQ resources can be specified one per resource or in
1190 * ranges (start != end)
1191 * 3. iff all events (channels and, optionally, error) on this
1192 * controller use the same IRQ, only one IRQ resource can be
1193 * specified, otherwise there must be one IRQ per channel, even if
1194 * some of them are equal
1195 * 4. if all IRQs on this controller are equal or if some specific IRQs
1196 * specify IORESOURCE_IRQ_SHAREABLE in their resources, they will be
1197 * requested with the IRQF_SHARED flag
1199 errirq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1200 if (!chan || !errirq_res)
1203 if (!request_mem_region(chan->start, resource_size(chan), pdev->name)) {
1204 dev_err(&pdev->dev, "DMAC register region already claimed\n");
1208 if (dmars && !request_mem_region(dmars->start, resource_size(dmars), pdev->name)) {
1209 dev_err(&pdev->dev, "DMAC DMARS region already claimed\n");
1215 shdev = kzalloc(sizeof(struct sh_dmae_device), GFP_KERNEL);
1217 dev_err(&pdev->dev, "Not enough memory\n");
1221 shdev->chan_reg = ioremap(chan->start, resource_size(chan));
1222 if (!shdev->chan_reg)
1225 shdev->dmars = ioremap(dmars->start, resource_size(dmars));
1231 shdev->pdata = pdata;
1233 if (pdata->chcr_offset)
1234 shdev->chcr_offset = pdata->chcr_offset;
1236 shdev->chcr_offset = CHCR;
1238 if (pdata->chcr_ie_bit)
1239 shdev->chcr_ie_bit = pdata->chcr_ie_bit;
1241 shdev->chcr_ie_bit = CHCR_IE;
1243 platform_set_drvdata(pdev, shdev);
1245 shdev->common.dev = &pdev->dev;
1247 pm_runtime_enable(&pdev->dev);
1248 pm_runtime_get_sync(&pdev->dev);
1250 spin_lock_irq(&sh_dmae_lock);
1251 list_add_tail_rcu(&shdev->node, &sh_dmae_devices);
1252 spin_unlock_irq(&sh_dmae_lock);
1254 /* reset dma controller - only needed as a test */
1255 err = sh_dmae_rst(shdev);
1259 INIT_LIST_HEAD(&shdev->common.channels);
1261 if (!pdata->slave_only)
1262 dma_cap_set(DMA_MEMCPY, shdev->common.cap_mask);
1263 if (pdata->slave && pdata->slave_num)
1264 dma_cap_set(DMA_SLAVE, shdev->common.cap_mask);
1266 shdev->common.device_alloc_chan_resources
1267 = sh_dmae_alloc_chan_resources;
1268 shdev->common.device_free_chan_resources = sh_dmae_free_chan_resources;
1269 shdev->common.device_prep_dma_memcpy = sh_dmae_prep_memcpy;
1270 shdev->common.device_tx_status = sh_dmae_tx_status;
1271 shdev->common.device_issue_pending = sh_dmae_memcpy_issue_pending;
1273 /* Compulsory for DMA_SLAVE fields */
1274 shdev->common.device_prep_slave_sg = sh_dmae_prep_slave_sg;
1275 shdev->common.device_control = sh_dmae_control;
1277 /* Default transfer size of 32 bytes requires 32-byte alignment */
1278 shdev->common.copy_align = LOG2_DEFAULT_XFER_SIZE;
1280 #if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
1281 chanirq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 1);
1284 chanirq_res = errirq_res;
1288 if (chanirq_res == errirq_res ||
1289 (errirq_res->flags & IORESOURCE_BITS) == IORESOURCE_IRQ_SHAREABLE)
1290 irqflags = IRQF_SHARED;
1292 errirq = errirq_res->start;
1294 err = request_irq(errirq, sh_dmae_err, irqflags,
1295 "DMAC Address Error", shdev);
1298 "DMA failed requesting irq #%d, error %d\n",
1304 chanirq_res = errirq_res;
1305 #endif /* CONFIG_CPU_SH4 || CONFIG_ARCH_SHMOBILE */
1307 if (chanirq_res->start == chanirq_res->end &&
1308 !platform_get_resource(pdev, IORESOURCE_IRQ, 1)) {
1309 /* Special case - all multiplexed */
1310 for (; irq_cnt < pdata->channel_num; irq_cnt++) {
1311 if (irq_cnt < SH_DMAC_MAX_CHANNELS) {
1312 chan_irq[irq_cnt] = chanirq_res->start;
1313 chan_flag[irq_cnt] = IRQF_SHARED;
1321 for (i = chanirq_res->start; i <= chanirq_res->end; i++) {
1322 if (irq_cnt >= SH_DMAC_MAX_CHANNELS) {
1327 if ((errirq_res->flags & IORESOURCE_BITS) ==
1328 IORESOURCE_IRQ_SHAREABLE)
1329 chan_flag[irq_cnt] = IRQF_SHARED;
1331 chan_flag[irq_cnt] = IRQF_DISABLED;
1333 "Found IRQ %d for channel %d\n",
1335 chan_irq[irq_cnt++] = i;
1338 if (irq_cnt >= SH_DMAC_MAX_CHANNELS)
1341 chanirq_res = platform_get_resource(pdev,
1342 IORESOURCE_IRQ, ++irqres);
1343 } while (irq_cnt < pdata->channel_num && chanirq_res);
1346 /* Create DMA Channel */
1347 for (i = 0; i < irq_cnt; i++) {
1348 err = sh_dmae_chan_probe(shdev, i, chan_irq[i], chan_flag[i]);
1350 goto chan_probe_err;
1354 dev_notice(&pdev->dev, "Attempting to register %d DMA "
1355 "channels when a maximum of %d are supported.\n",
1356 pdata->channel_num, SH_DMAC_MAX_CHANNELS);
1358 pm_runtime_put(&pdev->dev);
1360 dma_async_device_register(&shdev->common);
1365 sh_dmae_chan_remove(shdev);
1367 #if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
1368 free_irq(errirq, shdev);
1372 spin_lock_irq(&sh_dmae_lock);
1373 list_del_rcu(&shdev->node);
1374 spin_unlock_irq(&sh_dmae_lock);
1376 pm_runtime_put(&pdev->dev);
1377 pm_runtime_disable(&pdev->dev);
1380 iounmap(shdev->dmars);
1382 platform_set_drvdata(pdev, NULL);
1384 iounmap(shdev->chan_reg);
1390 release_mem_region(dmars->start, resource_size(dmars));
1392 release_mem_region(chan->start, resource_size(chan));
1397 static int __exit sh_dmae_remove(struct platform_device *pdev)
1399 struct sh_dmae_device *shdev = platform_get_drvdata(pdev);
1400 struct resource *res;
1401 int errirq = platform_get_irq(pdev, 0);
1403 dma_async_device_unregister(&shdev->common);
1406 free_irq(errirq, shdev);
1408 spin_lock_irq(&sh_dmae_lock);
1409 list_del_rcu(&shdev->node);
1410 spin_unlock_irq(&sh_dmae_lock);
1412 /* channel data remove */
1413 sh_dmae_chan_remove(shdev);
1415 pm_runtime_disable(&pdev->dev);
1418 iounmap(shdev->dmars);
1419 iounmap(shdev->chan_reg);
1421 platform_set_drvdata(pdev, NULL);
1426 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1428 release_mem_region(res->start, resource_size(res));
1429 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1431 release_mem_region(res->start, resource_size(res));
1436 static void sh_dmae_shutdown(struct platform_device *pdev)
1438 struct sh_dmae_device *shdev = platform_get_drvdata(pdev);
1439 sh_dmae_ctl_stop(shdev);
1442 static int sh_dmae_runtime_suspend(struct device *dev)
1447 static int sh_dmae_runtime_resume(struct device *dev)
1449 struct sh_dmae_device *shdev = dev_get_drvdata(dev);
1451 return sh_dmae_rst(shdev);
1455 static int sh_dmae_suspend(struct device *dev)
1460 static int sh_dmae_resume(struct device *dev)
1462 struct sh_dmae_device *shdev = dev_get_drvdata(dev);
1465 ret = sh_dmae_rst(shdev);
1467 dev_err(dev, "Failed to reset!\n");
1469 for (i = 0; i < shdev->pdata->channel_num; i++) {
1470 struct sh_dmae_chan *sh_chan = shdev->chan[i];
1471 struct sh_dmae_slave *param = sh_chan->common.private;
1473 if (!sh_chan->descs_allocated)
1477 const struct sh_dmae_slave_config *cfg = param->config;
1478 dmae_set_dmars(sh_chan, cfg->mid_rid);
1479 dmae_set_chcr(sh_chan, cfg->chcr);
1488 #define sh_dmae_suspend NULL
1489 #define sh_dmae_resume NULL
1492 const struct dev_pm_ops sh_dmae_pm = {
1493 .suspend = sh_dmae_suspend,
1494 .resume = sh_dmae_resume,
1495 .runtime_suspend = sh_dmae_runtime_suspend,
1496 .runtime_resume = sh_dmae_runtime_resume,
1499 static struct platform_driver sh_dmae_driver = {
1500 .remove = __exit_p(sh_dmae_remove),
1501 .shutdown = sh_dmae_shutdown,
1503 .owner = THIS_MODULE,
1504 .name = "sh-dma-engine",
1509 static int __init sh_dmae_init(void)
1511 /* Wire up NMI handling */
1512 int err = register_die_notifier(&sh_dmae_nmi_notifier);
1516 return platform_driver_probe(&sh_dmae_driver, sh_dmae_probe);
1518 module_init(sh_dmae_init);
1520 static void __exit sh_dmae_exit(void)
1522 platform_driver_unregister(&sh_dmae_driver);
1524 unregister_die_notifier(&sh_dmae_nmi_notifier);
1526 module_exit(sh_dmae_exit);
1528 MODULE_AUTHOR("Nobuhiro Iwamatsu <iwamatsu.nobuhiro@renesas.com>");
1529 MODULE_DESCRIPTION("Renesas SH DMA Engine driver");
1530 MODULE_LICENSE("GPL");
1531 MODULE_ALIAS("platform:sh-dma-engine");