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/dma-mapping.h>
27 #include <linux/platform_device.h>
28 #include <linux/pm_runtime.h>
29 #include <linux/sh_dma.h>
30 #include <linux/notifier.h>
31 #include <linux/kdebug.h>
32 #include <linux/spinlock.h>
33 #include <linux/rculist.h>
36 /* DMA descriptor control */
37 enum sh_dmae_desc_status {
41 DESC_COMPLETED, /* completed, have to call callback */
42 DESC_WAITING, /* callback called, waiting for ack / re-submit */
45 #define NR_DESCS_PER_CHANNEL 32
46 /* Default MEMCPY transfer size = 2^2 = 4 bytes */
47 #define LOG2_DEFAULT_XFER_SIZE 2
50 * Used for write-side mutual exclusion for the global device list,
51 * read-side synchronization by way of RCU, and per-controller data.
53 static DEFINE_SPINLOCK(sh_dmae_lock);
54 static LIST_HEAD(sh_dmae_devices);
56 /* A bitmask with bits enough for enum sh_dmae_slave_chan_id */
57 static unsigned long sh_dmae_slave_used[BITS_TO_LONGS(SH_DMA_SLAVE_NUMBER)];
59 static void sh_dmae_chan_ld_cleanup(struct sh_dmae_chan *sh_chan, bool all);
61 static void sh_dmae_writel(struct sh_dmae_chan *sh_dc, u32 data, u32 reg)
63 __raw_writel(data, sh_dc->base + reg / sizeof(u32));
66 static u32 sh_dmae_readl(struct sh_dmae_chan *sh_dc, u32 reg)
68 return __raw_readl(sh_dc->base + reg / sizeof(u32));
71 static u16 dmaor_read(struct sh_dmae_device *shdev)
73 u32 __iomem *addr = shdev->chan_reg + DMAOR / sizeof(u32);
75 if (shdev->pdata->dmaor_is_32bit)
76 return __raw_readl(addr);
78 return __raw_readw(addr);
81 static void dmaor_write(struct sh_dmae_device *shdev, u16 data)
83 u32 __iomem *addr = shdev->chan_reg + DMAOR / sizeof(u32);
85 if (shdev->pdata->dmaor_is_32bit)
86 __raw_writel(data, addr);
88 __raw_writew(data, addr);
91 static void chcr_write(struct sh_dmae_chan *sh_dc, u32 data)
93 struct sh_dmae_device *shdev = to_sh_dev(sh_dc);
95 __raw_writel(data, sh_dc->base + shdev->chcr_offset / sizeof(u32));
98 static u32 chcr_read(struct sh_dmae_chan *sh_dc)
100 struct sh_dmae_device *shdev = to_sh_dev(sh_dc);
102 return __raw_readl(sh_dc->base + shdev->chcr_offset / sizeof(u32));
106 * Reset DMA controller
108 * SH7780 has two DMAOR register
110 static void sh_dmae_ctl_stop(struct sh_dmae_device *shdev)
112 unsigned short dmaor;
115 spin_lock_irqsave(&sh_dmae_lock, flags);
117 dmaor = dmaor_read(shdev);
118 dmaor_write(shdev, dmaor & ~(DMAOR_NMIF | DMAOR_AE | DMAOR_DME));
120 spin_unlock_irqrestore(&sh_dmae_lock, flags);
123 static int sh_dmae_rst(struct sh_dmae_device *shdev)
125 unsigned short dmaor;
128 spin_lock_irqsave(&sh_dmae_lock, flags);
130 dmaor = dmaor_read(shdev) & ~(DMAOR_NMIF | DMAOR_AE | DMAOR_DME);
132 dmaor_write(shdev, dmaor | shdev->pdata->dmaor_init);
134 dmaor = dmaor_read(shdev);
136 spin_unlock_irqrestore(&sh_dmae_lock, flags);
138 if (dmaor & (DMAOR_AE | DMAOR_NMIF)) {
139 dev_warn(shdev->common.dev, "Can't initialize DMAOR.\n");
145 static bool dmae_is_busy(struct sh_dmae_chan *sh_chan)
147 u32 chcr = chcr_read(sh_chan);
149 if ((chcr & (CHCR_DE | CHCR_TE)) == CHCR_DE)
150 return true; /* working */
152 return false; /* waiting */
155 static unsigned int calc_xmit_shift(struct sh_dmae_chan *sh_chan, u32 chcr)
157 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
158 struct sh_dmae_pdata *pdata = shdev->pdata;
159 int cnt = ((chcr & pdata->ts_low_mask) >> pdata->ts_low_shift) |
160 ((chcr & pdata->ts_high_mask) >> pdata->ts_high_shift);
162 if (cnt >= pdata->ts_shift_num)
165 return pdata->ts_shift[cnt];
168 static u32 log2size_to_chcr(struct sh_dmae_chan *sh_chan, int l2size)
170 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
171 struct sh_dmae_pdata *pdata = shdev->pdata;
174 for (i = 0; i < pdata->ts_shift_num; i++)
175 if (pdata->ts_shift[i] == l2size)
178 if (i == pdata->ts_shift_num)
181 return ((i << pdata->ts_low_shift) & pdata->ts_low_mask) |
182 ((i << pdata->ts_high_shift) & pdata->ts_high_mask);
185 static void dmae_set_reg(struct sh_dmae_chan *sh_chan, struct sh_dmae_regs *hw)
187 sh_dmae_writel(sh_chan, hw->sar, SAR);
188 sh_dmae_writel(sh_chan, hw->dar, DAR);
189 sh_dmae_writel(sh_chan, hw->tcr >> sh_chan->xmit_shift, TCR);
192 static void dmae_start(struct sh_dmae_chan *sh_chan)
194 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
195 u32 chcr = chcr_read(sh_chan);
197 chcr |= CHCR_DE | shdev->chcr_ie_bit;
198 chcr_write(sh_chan, chcr & ~CHCR_TE);
201 static void dmae_halt(struct sh_dmae_chan *sh_chan)
203 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
204 u32 chcr = chcr_read(sh_chan);
206 chcr &= ~(CHCR_DE | CHCR_TE | shdev->chcr_ie_bit);
207 chcr_write(sh_chan, chcr);
210 static void dmae_init(struct sh_dmae_chan *sh_chan)
213 * Default configuration for dual address memory-memory transfer.
214 * 0x400 represents auto-request.
216 u32 chcr = DM_INC | SM_INC | 0x400 | log2size_to_chcr(sh_chan,
217 LOG2_DEFAULT_XFER_SIZE);
218 sh_chan->xmit_shift = calc_xmit_shift(sh_chan, chcr);
219 chcr_write(sh_chan, chcr);
222 static int dmae_set_chcr(struct sh_dmae_chan *sh_chan, u32 val)
224 /* If DMA is active, cannot set CHCR. TODO: remove this superfluous check */
225 if (dmae_is_busy(sh_chan))
228 sh_chan->xmit_shift = calc_xmit_shift(sh_chan, val);
229 chcr_write(sh_chan, val);
234 static int dmae_set_dmars(struct sh_dmae_chan *sh_chan, u16 val)
236 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
237 struct sh_dmae_pdata *pdata = shdev->pdata;
238 const struct sh_dmae_channel *chan_pdata = &pdata->channel[sh_chan->id];
239 u16 __iomem *addr = shdev->dmars;
240 unsigned int shift = chan_pdata->dmars_bit;
242 if (dmae_is_busy(sh_chan))
245 /* in the case of a missing DMARS resource use first memory window */
247 addr = (u16 __iomem *)shdev->chan_reg;
248 addr += chan_pdata->dmars / sizeof(u16);
250 __raw_writew((__raw_readw(addr) & (0xff00 >> shift)) | (val << shift),
256 static dma_cookie_t sh_dmae_tx_submit(struct dma_async_tx_descriptor *tx)
258 struct sh_desc *desc = tx_to_sh_desc(tx), *chunk, *last = desc, *c;
259 struct sh_dmae_chan *sh_chan = to_sh_chan(tx->chan);
260 dma_async_tx_callback callback = tx->callback;
263 spin_lock_bh(&sh_chan->desc_lock);
265 cookie = sh_chan->common.cookie;
270 sh_chan->common.cookie = cookie;
273 /* Mark all chunks of this descriptor as submitted, move to the queue */
274 list_for_each_entry_safe(chunk, c, desc->node.prev, node) {
276 * All chunks are on the global ld_free, so, we have to find
277 * the end of the chain ourselves
279 if (chunk != desc && (chunk->mark == DESC_IDLE ||
280 chunk->async_tx.cookie > 0 ||
281 chunk->async_tx.cookie == -EBUSY ||
282 &chunk->node == &sh_chan->ld_free))
284 chunk->mark = DESC_SUBMITTED;
285 /* Callback goes to the last chunk */
286 chunk->async_tx.callback = NULL;
287 chunk->cookie = cookie;
288 list_move_tail(&chunk->node, &sh_chan->ld_queue);
292 last->async_tx.callback = callback;
293 last->async_tx.callback_param = tx->callback_param;
295 dev_dbg(sh_chan->dev, "submit #%d@%p on %d: %x[%d] -> %x\n",
296 tx->cookie, &last->async_tx, sh_chan->id,
297 desc->hw.sar, desc->hw.tcr, desc->hw.dar);
299 spin_unlock_bh(&sh_chan->desc_lock);
304 /* Called with desc_lock held */
305 static struct sh_desc *sh_dmae_get_desc(struct sh_dmae_chan *sh_chan)
307 struct sh_desc *desc;
309 list_for_each_entry(desc, &sh_chan->ld_free, node)
310 if (desc->mark != DESC_PREPARED) {
311 BUG_ON(desc->mark != DESC_IDLE);
312 list_del(&desc->node);
319 static const struct sh_dmae_slave_config *sh_dmae_find_slave(
320 struct sh_dmae_chan *sh_chan, struct sh_dmae_slave *param)
322 struct sh_dmae_device *shdev = to_sh_dev(sh_chan);
323 struct sh_dmae_pdata *pdata = shdev->pdata;
326 if (param->slave_id >= SH_DMA_SLAVE_NUMBER)
329 for (i = 0; i < pdata->slave_num; i++)
330 if (pdata->slave[i].slave_id == param->slave_id)
331 return pdata->slave + i;
336 static int sh_dmae_alloc_chan_resources(struct dma_chan *chan)
338 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
339 struct sh_desc *desc;
340 struct sh_dmae_slave *param = chan->private;
343 pm_runtime_get_sync(sh_chan->dev);
346 * This relies on the guarantee from dmaengine that alloc_chan_resources
347 * never runs concurrently with itself or free_chan_resources.
350 const struct sh_dmae_slave_config *cfg;
352 cfg = sh_dmae_find_slave(sh_chan, param);
358 if (test_and_set_bit(param->slave_id, sh_dmae_slave_used)) {
365 dmae_set_dmars(sh_chan, cfg->mid_rid);
366 dmae_set_chcr(sh_chan, cfg->chcr);
371 spin_lock_bh(&sh_chan->desc_lock);
372 while (sh_chan->descs_allocated < NR_DESCS_PER_CHANNEL) {
373 spin_unlock_bh(&sh_chan->desc_lock);
374 desc = kzalloc(sizeof(struct sh_desc), GFP_KERNEL);
376 spin_lock_bh(&sh_chan->desc_lock);
379 dma_async_tx_descriptor_init(&desc->async_tx,
381 desc->async_tx.tx_submit = sh_dmae_tx_submit;
382 desc->mark = DESC_IDLE;
384 spin_lock_bh(&sh_chan->desc_lock);
385 list_add(&desc->node, &sh_chan->ld_free);
386 sh_chan->descs_allocated++;
388 spin_unlock_bh(&sh_chan->desc_lock);
390 if (!sh_chan->descs_allocated) {
395 return sh_chan->descs_allocated;
399 clear_bit(param->slave_id, sh_dmae_slave_used);
402 pm_runtime_put(sh_chan->dev);
407 * sh_dma_free_chan_resources - Free all resources of the channel.
409 static void sh_dmae_free_chan_resources(struct dma_chan *chan)
411 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
412 struct sh_desc *desc, *_desc;
414 int descs = sh_chan->descs_allocated;
416 /* Protect against ISR */
417 spin_lock_irq(&sh_chan->desc_lock);
419 spin_unlock_irq(&sh_chan->desc_lock);
421 /* Now no new interrupts will occur */
423 /* Prepared and not submitted descriptors can still be on the queue */
424 if (!list_empty(&sh_chan->ld_queue))
425 sh_dmae_chan_ld_cleanup(sh_chan, true);
428 /* The caller is holding dma_list_mutex */
429 struct sh_dmae_slave *param = chan->private;
430 clear_bit(param->slave_id, sh_dmae_slave_used);
431 chan->private = NULL;
434 spin_lock_bh(&sh_chan->desc_lock);
436 list_splice_init(&sh_chan->ld_free, &list);
437 sh_chan->descs_allocated = 0;
439 spin_unlock_bh(&sh_chan->desc_lock);
442 pm_runtime_put(sh_chan->dev);
444 list_for_each_entry_safe(desc, _desc, &list, node)
449 * sh_dmae_add_desc - get, set up and return one transfer descriptor
450 * @sh_chan: DMA channel
451 * @flags: DMA transfer flags
452 * @dest: destination DMA address, incremented when direction equals
453 * DMA_FROM_DEVICE or DMA_BIDIRECTIONAL
454 * @src: source DMA address, incremented when direction equals
455 * DMA_TO_DEVICE or DMA_BIDIRECTIONAL
456 * @len: DMA transfer length
457 * @first: if NULL, set to the current descriptor and cookie set to -EBUSY
458 * @direction: needed for slave DMA to decide which address to keep constant,
459 * equals DMA_BIDIRECTIONAL for MEMCPY
460 * Returns 0 or an error
461 * Locks: called with desc_lock held
463 static struct sh_desc *sh_dmae_add_desc(struct sh_dmae_chan *sh_chan,
464 unsigned long flags, dma_addr_t *dest, dma_addr_t *src, size_t *len,
465 struct sh_desc **first, enum dma_data_direction direction)
473 /* Allocate the link descriptor from the free list */
474 new = sh_dmae_get_desc(sh_chan);
476 dev_err(sh_chan->dev, "No free link descriptor available\n");
480 copy_size = min(*len, (size_t)SH_DMA_TCR_MAX + 1);
484 new->hw.tcr = copy_size;
488 new->async_tx.cookie = -EBUSY;
491 /* Other desc - invisible to the user */
492 new->async_tx.cookie = -EINVAL;
495 dev_dbg(sh_chan->dev,
496 "chaining (%u/%u)@%x -> %x with %p, cookie %d, shift %d\n",
497 copy_size, *len, *src, *dest, &new->async_tx,
498 new->async_tx.cookie, sh_chan->xmit_shift);
500 new->mark = DESC_PREPARED;
501 new->async_tx.flags = flags;
502 new->direction = direction;
505 if (direction == DMA_BIDIRECTIONAL || direction == DMA_TO_DEVICE)
507 if (direction == DMA_BIDIRECTIONAL || direction == DMA_FROM_DEVICE)
514 * sh_dmae_prep_sg - prepare transfer descriptors from an SG list
516 * Common routine for public (MEMCPY) and slave DMA. The MEMCPY case is also
517 * converted to scatter-gather to guarantee consistent locking and a correct
518 * list manipulation. For slave DMA direction carries the usual meaning, and,
519 * logically, the SG list is RAM and the addr variable contains slave address,
520 * e.g., the FIFO I/O register. For MEMCPY direction equals DMA_BIDIRECTIONAL
521 * and the SG list contains only one element and points at the source buffer.
523 static struct dma_async_tx_descriptor *sh_dmae_prep_sg(struct sh_dmae_chan *sh_chan,
524 struct scatterlist *sgl, unsigned int sg_len, dma_addr_t *addr,
525 enum dma_data_direction direction, unsigned long flags)
527 struct scatterlist *sg;
528 struct sh_desc *first = NULL, *new = NULL /* compiler... */;
536 for_each_sg(sgl, sg, sg_len, i)
537 chunks += (sg_dma_len(sg) + SH_DMA_TCR_MAX) /
538 (SH_DMA_TCR_MAX + 1);
540 /* Have to lock the whole loop to protect against concurrent release */
541 spin_lock_bh(&sh_chan->desc_lock);
545 * first descriptor is what user is dealing with in all API calls, its
546 * cookie is at first set to -EBUSY, at tx-submit to a positive
548 * if more than one chunk is needed further chunks have cookie = -EINVAL
549 * the last chunk, if not equal to the first, has cookie = -ENOSPC
550 * all chunks are linked onto the tx_list head with their .node heads
551 * only during this function, then they are immediately spliced
552 * back onto the free list in form of a chain
554 for_each_sg(sgl, sg, sg_len, i) {
555 dma_addr_t sg_addr = sg_dma_address(sg);
556 size_t len = sg_dma_len(sg);
562 dev_dbg(sh_chan->dev, "Add SG #%d@%p[%d], dma %llx\n",
563 i, sg, len, (unsigned long long)sg_addr);
565 if (direction == DMA_FROM_DEVICE)
566 new = sh_dmae_add_desc(sh_chan, flags,
567 &sg_addr, addr, &len, &first,
570 new = sh_dmae_add_desc(sh_chan, flags,
571 addr, &sg_addr, &len, &first,
576 new->chunks = chunks--;
577 list_add_tail(&new->node, &tx_list);
582 new->async_tx.cookie = -ENOSPC;
584 /* Put them back on the free list, so, they don't get lost */
585 list_splice_tail(&tx_list, &sh_chan->ld_free);
587 spin_unlock_bh(&sh_chan->desc_lock);
589 return &first->async_tx;
592 list_for_each_entry(new, &tx_list, node)
593 new->mark = DESC_IDLE;
594 list_splice(&tx_list, &sh_chan->ld_free);
596 spin_unlock_bh(&sh_chan->desc_lock);
601 static struct dma_async_tx_descriptor *sh_dmae_prep_memcpy(
602 struct dma_chan *chan, dma_addr_t dma_dest, dma_addr_t dma_src,
603 size_t len, unsigned long flags)
605 struct sh_dmae_chan *sh_chan;
606 struct scatterlist sg;
611 sh_chan = to_sh_chan(chan);
613 sg_init_table(&sg, 1);
614 sg_set_page(&sg, pfn_to_page(PFN_DOWN(dma_src)), len,
615 offset_in_page(dma_src));
616 sg_dma_address(&sg) = dma_src;
617 sg_dma_len(&sg) = len;
619 return sh_dmae_prep_sg(sh_chan, &sg, 1, &dma_dest, DMA_BIDIRECTIONAL,
623 static struct dma_async_tx_descriptor *sh_dmae_prep_slave_sg(
624 struct dma_chan *chan, struct scatterlist *sgl, unsigned int sg_len,
625 enum dma_data_direction direction, unsigned long flags)
627 struct sh_dmae_slave *param;
628 struct sh_dmae_chan *sh_chan;
629 dma_addr_t slave_addr;
634 sh_chan = to_sh_chan(chan);
635 param = chan->private;
637 /* Someone calling slave DMA on a public channel? */
638 if (!param || !sg_len) {
639 dev_warn(sh_chan->dev, "%s: bad parameter: %p, %d, %d\n",
640 __func__, param, sg_len, param ? param->slave_id : -1);
644 slave_addr = param->config->addr;
647 * if (param != NULL), this is a successfully requested slave channel,
648 * therefore param->config != NULL too.
650 return sh_dmae_prep_sg(sh_chan, sgl, sg_len, &slave_addr,
654 static int sh_dmae_control(struct dma_chan *chan, enum dma_ctrl_cmd cmd,
657 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
659 /* Only supports DMA_TERMINATE_ALL */
660 if (cmd != DMA_TERMINATE_ALL)
666 spin_lock_bh(&sh_chan->desc_lock);
669 if (!list_empty(&sh_chan->ld_queue)) {
670 /* Record partial transfer */
671 struct sh_desc *desc = list_entry(sh_chan->ld_queue.next,
672 struct sh_desc, node);
673 desc->partial = (desc->hw.tcr - sh_dmae_readl(sh_chan, TCR)) <<
677 spin_unlock_bh(&sh_chan->desc_lock);
679 sh_dmae_chan_ld_cleanup(sh_chan, true);
684 static dma_async_tx_callback __ld_cleanup(struct sh_dmae_chan *sh_chan, bool all)
686 struct sh_desc *desc, *_desc;
687 /* Is the "exposed" head of a chain acked? */
688 bool head_acked = false;
689 dma_cookie_t cookie = 0;
690 dma_async_tx_callback callback = NULL;
693 spin_lock_bh(&sh_chan->desc_lock);
694 list_for_each_entry_safe(desc, _desc, &sh_chan->ld_queue, node) {
695 struct dma_async_tx_descriptor *tx = &desc->async_tx;
697 BUG_ON(tx->cookie > 0 && tx->cookie != desc->cookie);
698 BUG_ON(desc->mark != DESC_SUBMITTED &&
699 desc->mark != DESC_COMPLETED &&
700 desc->mark != DESC_WAITING);
703 * queue is ordered, and we use this loop to (1) clean up all
704 * completed descriptors, and to (2) update descriptor flags of
705 * any chunks in a (partially) completed chain
707 if (!all && desc->mark == DESC_SUBMITTED &&
708 desc->cookie != cookie)
714 if (desc->mark == DESC_COMPLETED && desc->chunks == 1) {
715 if (sh_chan->completed_cookie != desc->cookie - 1)
716 dev_dbg(sh_chan->dev,
717 "Completing cookie %d, expected %d\n",
719 sh_chan->completed_cookie + 1);
720 sh_chan->completed_cookie = desc->cookie;
723 /* Call callback on the last chunk */
724 if (desc->mark == DESC_COMPLETED && tx->callback) {
725 desc->mark = DESC_WAITING;
726 callback = tx->callback;
727 param = tx->callback_param;
728 dev_dbg(sh_chan->dev, "descriptor #%d@%p on %d callback\n",
729 tx->cookie, tx, sh_chan->id);
730 BUG_ON(desc->chunks != 1);
734 if (tx->cookie > 0 || tx->cookie == -EBUSY) {
735 if (desc->mark == DESC_COMPLETED) {
736 BUG_ON(tx->cookie < 0);
737 desc->mark = DESC_WAITING;
739 head_acked = async_tx_test_ack(tx);
741 switch (desc->mark) {
743 desc->mark = DESC_WAITING;
747 async_tx_ack(&desc->async_tx);
751 dev_dbg(sh_chan->dev, "descriptor %p #%d completed.\n",
754 if (((desc->mark == DESC_COMPLETED ||
755 desc->mark == DESC_WAITING) &&
756 async_tx_test_ack(&desc->async_tx)) || all) {
757 /* Remove from ld_queue list */
758 desc->mark = DESC_IDLE;
759 list_move(&desc->node, &sh_chan->ld_free);
763 if (all && !callback)
765 * Terminating and the loop completed normally: forgive
766 * uncompleted cookies
768 sh_chan->completed_cookie = sh_chan->common.cookie;
770 spin_unlock_bh(&sh_chan->desc_lock);
779 * sh_chan_ld_cleanup - Clean up link descriptors
781 * This function cleans up the ld_queue of DMA channel.
783 static void sh_dmae_chan_ld_cleanup(struct sh_dmae_chan *sh_chan, bool all)
785 while (__ld_cleanup(sh_chan, all))
789 static void sh_chan_xfer_ld_queue(struct sh_dmae_chan *sh_chan)
791 struct sh_desc *desc;
793 spin_lock_bh(&sh_chan->desc_lock);
795 if (dmae_is_busy(sh_chan))
796 goto sh_chan_xfer_ld_queue_end;
798 /* Find the first not transferred descriptor */
799 list_for_each_entry(desc, &sh_chan->ld_queue, node)
800 if (desc->mark == DESC_SUBMITTED) {
801 dev_dbg(sh_chan->dev, "Queue #%d to %d: %u@%x -> %x\n",
802 desc->async_tx.cookie, sh_chan->id,
803 desc->hw.tcr, desc->hw.sar, desc->hw.dar);
804 /* Get the ld start address from ld_queue */
805 dmae_set_reg(sh_chan, &desc->hw);
810 sh_chan_xfer_ld_queue_end:
811 spin_unlock_bh(&sh_chan->desc_lock);
814 static void sh_dmae_memcpy_issue_pending(struct dma_chan *chan)
816 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
817 sh_chan_xfer_ld_queue(sh_chan);
820 static enum dma_status sh_dmae_tx_status(struct dma_chan *chan,
822 struct dma_tx_state *txstate)
824 struct sh_dmae_chan *sh_chan = to_sh_chan(chan);
825 dma_cookie_t last_used;
826 dma_cookie_t last_complete;
827 enum dma_status status;
829 sh_dmae_chan_ld_cleanup(sh_chan, false);
831 /* First read completed cookie to avoid a skew */
832 last_complete = sh_chan->completed_cookie;
834 last_used = chan->cookie;
835 BUG_ON(last_complete < 0);
836 dma_set_tx_state(txstate, last_complete, last_used, 0);
838 spin_lock_bh(&sh_chan->desc_lock);
840 status = dma_async_is_complete(cookie, last_complete, last_used);
843 * If we don't find cookie on the queue, it has been aborted and we have
846 if (status != DMA_SUCCESS) {
847 struct sh_desc *desc;
849 list_for_each_entry(desc, &sh_chan->ld_queue, node)
850 if (desc->cookie == cookie) {
851 status = DMA_IN_PROGRESS;
856 spin_unlock_bh(&sh_chan->desc_lock);
861 static irqreturn_t sh_dmae_interrupt(int irq, void *data)
863 irqreturn_t ret = IRQ_NONE;
864 struct sh_dmae_chan *sh_chan = data;
867 spin_lock(&sh_chan->desc_lock);
869 chcr = chcr_read(sh_chan);
871 if (chcr & CHCR_TE) {
876 tasklet_schedule(&sh_chan->tasklet);
879 spin_unlock(&sh_chan->desc_lock);
884 /* Called from error IRQ or NMI */
885 static bool sh_dmae_reset(struct sh_dmae_device *shdev)
887 unsigned int handled = 0;
890 /* halt the dma controller */
891 sh_dmae_ctl_stop(shdev);
893 /* We cannot detect, which channel caused the error, have to reset all */
894 for (i = 0; i < SH_DMAC_MAX_CHANNELS; i++) {
895 struct sh_dmae_chan *sh_chan = shdev->chan[i];
896 struct sh_desc *desc;
902 spin_lock(&sh_chan->desc_lock);
904 /* Stop the channel */
907 list_splice_init(&sh_chan->ld_queue, &dl);
909 spin_unlock(&sh_chan->desc_lock);
912 list_for_each_entry(desc, &dl, node) {
913 struct dma_async_tx_descriptor *tx = &desc->async_tx;
914 desc->mark = DESC_IDLE;
916 tx->callback(tx->callback_param);
919 spin_lock(&sh_chan->desc_lock);
920 list_splice(&dl, &sh_chan->ld_free);
921 spin_unlock(&sh_chan->desc_lock);
931 static irqreturn_t sh_dmae_err(int irq, void *data)
933 struct sh_dmae_device *shdev = data;
935 if (!(dmaor_read(shdev) & DMAOR_AE))
942 static void dmae_do_tasklet(unsigned long data)
944 struct sh_dmae_chan *sh_chan = (struct sh_dmae_chan *)data;
945 struct sh_desc *desc;
946 u32 sar_buf = sh_dmae_readl(sh_chan, SAR);
947 u32 dar_buf = sh_dmae_readl(sh_chan, DAR);
949 spin_lock(&sh_chan->desc_lock);
950 list_for_each_entry(desc, &sh_chan->ld_queue, node) {
951 if (desc->mark == DESC_SUBMITTED &&
952 ((desc->direction == DMA_FROM_DEVICE &&
953 (desc->hw.dar + desc->hw.tcr) == dar_buf) ||
954 (desc->hw.sar + desc->hw.tcr) == sar_buf)) {
955 dev_dbg(sh_chan->dev, "done #%d@%p dst %u\n",
956 desc->async_tx.cookie, &desc->async_tx,
958 desc->mark = DESC_COMPLETED;
962 spin_unlock(&sh_chan->desc_lock);
965 sh_chan_xfer_ld_queue(sh_chan);
966 sh_dmae_chan_ld_cleanup(sh_chan, false);
969 static bool sh_dmae_nmi_notify(struct sh_dmae_device *shdev)
971 /* Fast path out if NMIF is not asserted for this controller */
972 if ((dmaor_read(shdev) & DMAOR_NMIF) == 0)
975 return sh_dmae_reset(shdev);
978 static int sh_dmae_nmi_handler(struct notifier_block *self,
979 unsigned long cmd, void *data)
981 struct sh_dmae_device *shdev;
982 int ret = NOTIFY_DONE;
986 * Only concern ourselves with NMI events.
988 * Normally we would check the die chain value, but as this needs
989 * to be architecture independent, check for NMI context instead.
995 list_for_each_entry_rcu(shdev, &sh_dmae_devices, node) {
997 * Only stop if one of the controllers has NMIF asserted,
998 * we do not want to interfere with regular address error
999 * handling or NMI events that don't concern the DMACs.
1001 triggered = sh_dmae_nmi_notify(shdev);
1002 if (triggered == true)
1010 static struct notifier_block sh_dmae_nmi_notifier __read_mostly = {
1011 .notifier_call = sh_dmae_nmi_handler,
1013 /* Run before NMI debug handler and KGDB */
1017 static int __devinit sh_dmae_chan_probe(struct sh_dmae_device *shdev, int id,
1018 int irq, unsigned long flags)
1021 const struct sh_dmae_channel *chan_pdata = &shdev->pdata->channel[id];
1022 struct platform_device *pdev = to_platform_device(shdev->common.dev);
1023 struct sh_dmae_chan *new_sh_chan;
1026 new_sh_chan = kzalloc(sizeof(struct sh_dmae_chan), GFP_KERNEL);
1028 dev_err(shdev->common.dev,
1029 "No free memory for allocating dma channels!\n");
1033 /* copy struct dma_device */
1034 new_sh_chan->common.device = &shdev->common;
1036 new_sh_chan->dev = shdev->common.dev;
1037 new_sh_chan->id = id;
1038 new_sh_chan->irq = irq;
1039 new_sh_chan->base = shdev->chan_reg + chan_pdata->offset / sizeof(u32);
1041 /* Init DMA tasklet */
1042 tasklet_init(&new_sh_chan->tasklet, dmae_do_tasklet,
1043 (unsigned long)new_sh_chan);
1045 spin_lock_init(&new_sh_chan->desc_lock);
1047 /* Init descripter manage list */
1048 INIT_LIST_HEAD(&new_sh_chan->ld_queue);
1049 INIT_LIST_HEAD(&new_sh_chan->ld_free);
1051 /* Add the channel to DMA device channel list */
1052 list_add_tail(&new_sh_chan->common.device_node,
1053 &shdev->common.channels);
1054 shdev->common.chancnt++;
1057 snprintf(new_sh_chan->dev_id, sizeof(new_sh_chan->dev_id),
1058 "sh-dmae%d.%d", pdev->id, new_sh_chan->id);
1060 snprintf(new_sh_chan->dev_id, sizeof(new_sh_chan->dev_id),
1061 "sh-dma%d", new_sh_chan->id);
1063 /* set up channel irq */
1064 err = request_irq(irq, &sh_dmae_interrupt, flags,
1065 new_sh_chan->dev_id, new_sh_chan);
1067 dev_err(shdev->common.dev, "DMA channel %d request_irq error "
1068 "with return %d\n", id, err);
1072 shdev->chan[id] = new_sh_chan;
1076 /* remove from dmaengine device node */
1077 list_del(&new_sh_chan->common.device_node);
1082 static void sh_dmae_chan_remove(struct sh_dmae_device *shdev)
1086 for (i = shdev->common.chancnt - 1 ; i >= 0 ; i--) {
1087 if (shdev->chan[i]) {
1088 struct sh_dmae_chan *sh_chan = shdev->chan[i];
1090 free_irq(sh_chan->irq, sh_chan);
1092 list_del(&sh_chan->common.device_node);
1094 shdev->chan[i] = NULL;
1097 shdev->common.chancnt = 0;
1100 static int __init sh_dmae_probe(struct platform_device *pdev)
1102 struct sh_dmae_pdata *pdata = pdev->dev.platform_data;
1103 unsigned long irqflags = IRQF_DISABLED,
1104 chan_flag[SH_DMAC_MAX_CHANNELS] = {};
1105 int errirq, chan_irq[SH_DMAC_MAX_CHANNELS];
1106 int err, i, irq_cnt = 0, irqres = 0, irq_cap = 0;
1107 struct sh_dmae_device *shdev;
1108 struct resource *chan, *dmars, *errirq_res, *chanirq_res;
1110 /* get platform data */
1111 if (!pdata || !pdata->channel_num)
1114 chan = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1115 /* DMARS area is optional */
1116 dmars = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1119 * 1. there always must be at least one IRQ IO-resource. On SH4 it is
1120 * the error IRQ, in which case it is the only IRQ in this resource:
1121 * start == end. If it is the only IRQ resource, all channels also
1123 * 2. DMA channel IRQ resources can be specified one per resource or in
1124 * ranges (start != end)
1125 * 3. iff all events (channels and, optionally, error) on this
1126 * controller use the same IRQ, only one IRQ resource can be
1127 * specified, otherwise there must be one IRQ per channel, even if
1128 * some of them are equal
1129 * 4. if all IRQs on this controller are equal or if some specific IRQs
1130 * specify IORESOURCE_IRQ_SHAREABLE in their resources, they will be
1131 * requested with the IRQF_SHARED flag
1133 errirq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1134 if (!chan || !errirq_res)
1137 if (!request_mem_region(chan->start, resource_size(chan), pdev->name)) {
1138 dev_err(&pdev->dev, "DMAC register region already claimed\n");
1142 if (dmars && !request_mem_region(dmars->start, resource_size(dmars), pdev->name)) {
1143 dev_err(&pdev->dev, "DMAC DMARS region already claimed\n");
1149 shdev = kzalloc(sizeof(struct sh_dmae_device), GFP_KERNEL);
1151 dev_err(&pdev->dev, "Not enough memory\n");
1155 shdev->chan_reg = ioremap(chan->start, resource_size(chan));
1156 if (!shdev->chan_reg)
1159 shdev->dmars = ioremap(dmars->start, resource_size(dmars));
1165 shdev->pdata = pdata;
1167 if (pdata->chcr_offset)
1168 shdev->chcr_offset = pdata->chcr_offset;
1170 shdev->chcr_offset = CHCR;
1172 if (pdata->chcr_ie_bit)
1173 shdev->chcr_ie_bit = pdata->chcr_ie_bit;
1175 shdev->chcr_ie_bit = CHCR_IE;
1177 platform_set_drvdata(pdev, shdev);
1179 pm_runtime_enable(&pdev->dev);
1180 pm_runtime_get_sync(&pdev->dev);
1182 spin_lock_irq(&sh_dmae_lock);
1183 list_add_tail_rcu(&shdev->node, &sh_dmae_devices);
1184 spin_unlock_irq(&sh_dmae_lock);
1186 /* reset dma controller - only needed as a test */
1187 err = sh_dmae_rst(shdev);
1191 INIT_LIST_HEAD(&shdev->common.channels);
1193 dma_cap_set(DMA_MEMCPY, shdev->common.cap_mask);
1194 if (pdata->slave && pdata->slave_num)
1195 dma_cap_set(DMA_SLAVE, shdev->common.cap_mask);
1197 shdev->common.device_alloc_chan_resources
1198 = sh_dmae_alloc_chan_resources;
1199 shdev->common.device_free_chan_resources = sh_dmae_free_chan_resources;
1200 shdev->common.device_prep_dma_memcpy = sh_dmae_prep_memcpy;
1201 shdev->common.device_tx_status = sh_dmae_tx_status;
1202 shdev->common.device_issue_pending = sh_dmae_memcpy_issue_pending;
1204 /* Compulsory for DMA_SLAVE fields */
1205 shdev->common.device_prep_slave_sg = sh_dmae_prep_slave_sg;
1206 shdev->common.device_control = sh_dmae_control;
1208 shdev->common.dev = &pdev->dev;
1209 /* Default transfer size of 32 bytes requires 32-byte alignment */
1210 shdev->common.copy_align = LOG2_DEFAULT_XFER_SIZE;
1212 #if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
1213 chanirq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 1);
1216 chanirq_res = errirq_res;
1220 if (chanirq_res == errirq_res ||
1221 (errirq_res->flags & IORESOURCE_BITS) == IORESOURCE_IRQ_SHAREABLE)
1222 irqflags = IRQF_SHARED;
1224 errirq = errirq_res->start;
1226 err = request_irq(errirq, sh_dmae_err, irqflags,
1227 "DMAC Address Error", shdev);
1230 "DMA failed requesting irq #%d, error %d\n",
1236 chanirq_res = errirq_res;
1237 #endif /* CONFIG_CPU_SH4 || CONFIG_ARCH_SHMOBILE */
1239 if (chanirq_res->start == chanirq_res->end &&
1240 !platform_get_resource(pdev, IORESOURCE_IRQ, 1)) {
1241 /* Special case - all multiplexed */
1242 for (; irq_cnt < pdata->channel_num; irq_cnt++) {
1243 if (irq_cnt < SH_DMAC_MAX_CHANNELS) {
1244 chan_irq[irq_cnt] = chanirq_res->start;
1245 chan_flag[irq_cnt] = IRQF_SHARED;
1253 for (i = chanirq_res->start; i <= chanirq_res->end; i++) {
1254 if ((errirq_res->flags & IORESOURCE_BITS) ==
1255 IORESOURCE_IRQ_SHAREABLE)
1256 chan_flag[irq_cnt] = IRQF_SHARED;
1258 chan_flag[irq_cnt] = IRQF_DISABLED;
1260 "Found IRQ %d for channel %d\n",
1262 chan_irq[irq_cnt++] = i;
1264 if (irq_cnt >= SH_DMAC_MAX_CHANNELS)
1268 if (irq_cnt >= SH_DMAC_MAX_CHANNELS) {
1272 chanirq_res = platform_get_resource(pdev,
1273 IORESOURCE_IRQ, ++irqres);
1274 } while (irq_cnt < pdata->channel_num && chanirq_res);
1277 /* Create DMA Channel */
1278 for (i = 0; i < irq_cnt; i++) {
1279 err = sh_dmae_chan_probe(shdev, i, chan_irq[i], chan_flag[i]);
1281 goto chan_probe_err;
1285 dev_notice(&pdev->dev, "Attempting to register %d DMA "
1286 "channels when a maximum of %d are supported.\n",
1287 pdata->channel_num, SH_DMAC_MAX_CHANNELS);
1289 pm_runtime_put(&pdev->dev);
1291 dma_async_device_register(&shdev->common);
1296 sh_dmae_chan_remove(shdev);
1298 #if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
1299 free_irq(errirq, shdev);
1303 spin_lock_irq(&sh_dmae_lock);
1304 list_del_rcu(&shdev->node);
1305 spin_unlock_irq(&sh_dmae_lock);
1307 pm_runtime_put(&pdev->dev);
1308 pm_runtime_disable(&pdev->dev);
1311 iounmap(shdev->dmars);
1313 platform_set_drvdata(pdev, NULL);
1315 iounmap(shdev->chan_reg);
1321 release_mem_region(dmars->start, resource_size(dmars));
1323 release_mem_region(chan->start, resource_size(chan));
1328 static int __exit sh_dmae_remove(struct platform_device *pdev)
1330 struct sh_dmae_device *shdev = platform_get_drvdata(pdev);
1331 struct resource *res;
1332 int errirq = platform_get_irq(pdev, 0);
1334 dma_async_device_unregister(&shdev->common);
1337 free_irq(errirq, shdev);
1339 spin_lock_irq(&sh_dmae_lock);
1340 list_del_rcu(&shdev->node);
1341 spin_unlock_irq(&sh_dmae_lock);
1343 /* channel data remove */
1344 sh_dmae_chan_remove(shdev);
1346 pm_runtime_disable(&pdev->dev);
1349 iounmap(shdev->dmars);
1350 iounmap(shdev->chan_reg);
1352 platform_set_drvdata(pdev, NULL);
1357 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1359 release_mem_region(res->start, resource_size(res));
1360 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1362 release_mem_region(res->start, resource_size(res));
1367 static void sh_dmae_shutdown(struct platform_device *pdev)
1369 struct sh_dmae_device *shdev = platform_get_drvdata(pdev);
1370 sh_dmae_ctl_stop(shdev);
1373 static int sh_dmae_runtime_suspend(struct device *dev)
1378 static int sh_dmae_runtime_resume(struct device *dev)
1380 struct sh_dmae_device *shdev = dev_get_drvdata(dev);
1382 return sh_dmae_rst(shdev);
1386 static int sh_dmae_suspend(struct device *dev)
1388 struct sh_dmae_device *shdev = dev_get_drvdata(dev);
1391 for (i = 0; i < shdev->pdata->channel_num; i++) {
1392 struct sh_dmae_chan *sh_chan = shdev->chan[i];
1393 if (sh_chan->descs_allocated)
1394 sh_chan->pm_error = pm_runtime_put_sync(dev);
1400 static int sh_dmae_resume(struct device *dev)
1402 struct sh_dmae_device *shdev = dev_get_drvdata(dev);
1405 for (i = 0; i < shdev->pdata->channel_num; i++) {
1406 struct sh_dmae_chan *sh_chan = shdev->chan[i];
1407 struct sh_dmae_slave *param = sh_chan->common.private;
1409 if (!sh_chan->descs_allocated)
1412 if (!sh_chan->pm_error)
1413 pm_runtime_get_sync(dev);
1416 const struct sh_dmae_slave_config *cfg = param->config;
1417 dmae_set_dmars(sh_chan, cfg->mid_rid);
1418 dmae_set_chcr(sh_chan, cfg->chcr);
1427 #define sh_dmae_suspend NULL
1428 #define sh_dmae_resume NULL
1431 const struct dev_pm_ops sh_dmae_pm = {
1432 .suspend = sh_dmae_suspend,
1433 .resume = sh_dmae_resume,
1434 .runtime_suspend = sh_dmae_runtime_suspend,
1435 .runtime_resume = sh_dmae_runtime_resume,
1438 static struct platform_driver sh_dmae_driver = {
1439 .remove = __exit_p(sh_dmae_remove),
1440 .shutdown = sh_dmae_shutdown,
1442 .owner = THIS_MODULE,
1443 .name = "sh-dma-engine",
1448 static int __init sh_dmae_init(void)
1450 /* Wire up NMI handling */
1451 int err = register_die_notifier(&sh_dmae_nmi_notifier);
1455 return platform_driver_probe(&sh_dmae_driver, sh_dmae_probe);
1457 module_init(sh_dmae_init);
1459 static void __exit sh_dmae_exit(void)
1461 platform_driver_unregister(&sh_dmae_driver);
1463 unregister_die_notifier(&sh_dmae_nmi_notifier);
1465 module_exit(sh_dmae_exit);
1467 MODULE_AUTHOR("Nobuhiro Iwamatsu <iwamatsu.nobuhiro@renesas.com>");
1468 MODULE_DESCRIPTION("Renesas SH DMA Engine driver");
1469 MODULE_LICENSE("GPL");
1470 MODULE_ALIAS("platform:sh-dma-engine");