2 * Core driver for the Intel integrated DMA 64-bit
4 * Copyright (C) 2015 Intel Corporation
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/bitops.h>
13 #include <linux/delay.h>
14 #include <linux/dmaengine.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/dmapool.h>
17 #include <linux/init.h>
18 #include <linux/module.h>
19 #include <linux/platform_device.h>
20 #include <linux/slab.h>
22 #include <linux/dma/idma64.h>
26 /* For now we support only two channels */
27 #define IDMA64_NR_CHAN 2
29 /* ---------------------------------------------------------------------- */
31 static struct device *chan2dev(struct dma_chan *chan)
33 return &chan->dev->device;
36 /* ---------------------------------------------------------------------- */
38 static void idma64_off(struct idma64 *idma64)
40 unsigned short count = 100;
42 dma_writel(idma64, CFG, 0);
44 channel_clear_bit(idma64, MASK(XFER), idma64->all_chan_mask);
45 channel_clear_bit(idma64, MASK(BLOCK), idma64->all_chan_mask);
46 channel_clear_bit(idma64, MASK(SRC_TRAN), idma64->all_chan_mask);
47 channel_clear_bit(idma64, MASK(DST_TRAN), idma64->all_chan_mask);
48 channel_clear_bit(idma64, MASK(ERROR), idma64->all_chan_mask);
52 } while (dma_readl(idma64, CFG) & IDMA64_CFG_DMA_EN && --count);
55 static void idma64_on(struct idma64 *idma64)
57 dma_writel(idma64, CFG, IDMA64_CFG_DMA_EN);
60 /* ---------------------------------------------------------------------- */
62 static void idma64_chan_init(struct idma64 *idma64, struct idma64_chan *idma64c)
64 u32 cfghi = IDMA64C_CFGH_SRC_PER(1) | IDMA64C_CFGH_DST_PER(0);
67 /* Set default burst alignment */
68 cfglo |= IDMA64C_CFGL_DST_BURST_ALIGN | IDMA64C_CFGL_SRC_BURST_ALIGN;
70 channel_writel(idma64c, CFG_LO, cfglo);
71 channel_writel(idma64c, CFG_HI, cfghi);
73 /* Enable interrupts */
74 channel_set_bit(idma64, MASK(XFER), idma64c->mask);
75 channel_set_bit(idma64, MASK(ERROR), idma64c->mask);
78 * Enforce the controller to be turned on.
80 * The iDMA is turned off in ->probe() and looses context during system
81 * suspend / resume cycle. That's why we have to enable it each time we
87 static void idma64_chan_stop(struct idma64 *idma64, struct idma64_chan *idma64c)
89 channel_clear_bit(idma64, CH_EN, idma64c->mask);
92 static void idma64_chan_start(struct idma64 *idma64, struct idma64_chan *idma64c)
94 struct idma64_desc *desc = idma64c->desc;
95 struct idma64_hw_desc *hw = &desc->hw[0];
97 channel_writeq(idma64c, SAR, 0);
98 channel_writeq(idma64c, DAR, 0);
100 channel_writel(idma64c, CTL_HI, IDMA64C_CTLH_BLOCK_TS(~0UL));
101 channel_writel(idma64c, CTL_LO, IDMA64C_CTLL_LLP_S_EN | IDMA64C_CTLL_LLP_D_EN);
103 channel_writeq(idma64c, LLP, hw->llp);
105 channel_set_bit(idma64, CH_EN, idma64c->mask);
108 static void idma64_stop_transfer(struct idma64_chan *idma64c)
110 struct idma64 *idma64 = to_idma64(idma64c->vchan.chan.device);
112 idma64_chan_stop(idma64, idma64c);
115 static void idma64_start_transfer(struct idma64_chan *idma64c)
117 struct idma64 *idma64 = to_idma64(idma64c->vchan.chan.device);
118 struct virt_dma_desc *vdesc;
120 /* Get the next descriptor */
121 vdesc = vchan_next_desc(&idma64c->vchan);
123 idma64c->desc = NULL;
127 list_del(&vdesc->node);
128 idma64c->desc = to_idma64_desc(vdesc);
130 /* Configure the channel */
131 idma64_chan_init(idma64, idma64c);
133 /* Start the channel with a new descriptor */
134 idma64_chan_start(idma64, idma64c);
137 /* ---------------------------------------------------------------------- */
139 static void idma64_chan_irq(struct idma64 *idma64, unsigned short c,
140 u32 status_err, u32 status_xfer)
142 struct idma64_chan *idma64c = &idma64->chan[c];
143 struct idma64_desc *desc;
145 spin_lock(&idma64c->vchan.lock);
146 desc = idma64c->desc;
148 if (status_err & (1 << c)) {
149 dma_writel(idma64, CLEAR(ERROR), idma64c->mask);
150 desc->status = DMA_ERROR;
151 } else if (status_xfer & (1 << c)) {
152 dma_writel(idma64, CLEAR(XFER), idma64c->mask);
153 desc->status = DMA_COMPLETE;
154 vchan_cookie_complete(&desc->vdesc);
155 idma64_start_transfer(idma64c);
158 /* idma64_start_transfer() updates idma64c->desc */
159 if (idma64c->desc == NULL || desc->status == DMA_ERROR)
160 idma64_stop_transfer(idma64c);
162 spin_unlock(&idma64c->vchan.lock);
165 static irqreturn_t idma64_irq(int irq, void *dev)
167 struct idma64 *idma64 = dev;
168 u32 status = dma_readl(idma64, STATUS_INT);
173 dev_vdbg(idma64->dma.dev, "%s: status=%#x\n", __func__, status);
175 /* Check if we have any interrupt from the DMA controller */
179 status_xfer = dma_readl(idma64, RAW(XFER));
180 status_err = dma_readl(idma64, RAW(ERROR));
182 for (i = 0; i < idma64->dma.chancnt; i++)
183 idma64_chan_irq(idma64, i, status_err, status_xfer);
188 /* ---------------------------------------------------------------------- */
190 static struct idma64_desc *idma64_alloc_desc(unsigned int ndesc)
192 struct idma64_desc *desc;
194 desc = kzalloc(sizeof(*desc), GFP_NOWAIT);
198 desc->hw = kcalloc(ndesc, sizeof(*desc->hw), GFP_NOWAIT);
207 static void idma64_desc_free(struct idma64_chan *idma64c,
208 struct idma64_desc *desc)
210 struct idma64_hw_desc *hw;
213 unsigned int i = desc->ndesc;
217 dma_pool_free(idma64c->pool, hw->lli, hw->llp);
225 static void idma64_vdesc_free(struct virt_dma_desc *vdesc)
227 struct idma64_chan *idma64c = to_idma64_chan(vdesc->tx.chan);
229 idma64_desc_free(idma64c, to_idma64_desc(vdesc));
232 static void idma64_hw_desc_fill(struct idma64_hw_desc *hw,
233 struct dma_slave_config *config,
234 enum dma_transfer_direction direction, u64 llp)
236 struct idma64_lli *lli = hw->lli;
238 u32 ctlhi = IDMA64C_CTLH_BLOCK_TS(hw->len);
239 u32 ctllo = IDMA64C_CTLL_LLP_S_EN | IDMA64C_CTLL_LLP_D_EN;
240 u32 src_width, dst_width;
242 if (direction == DMA_MEM_TO_DEV) {
244 dar = config->dst_addr;
245 ctllo |= IDMA64C_CTLL_DST_FIX | IDMA64C_CTLL_SRC_INC |
247 src_width = __ffs(sar | hw->len | 4);
248 dst_width = __ffs(config->dst_addr_width);
249 } else { /* DMA_DEV_TO_MEM */
250 sar = config->src_addr;
252 ctllo |= IDMA64C_CTLL_DST_INC | IDMA64C_CTLL_SRC_FIX |
254 src_width = __ffs(config->src_addr_width);
255 dst_width = __ffs(dar | hw->len | 4);
263 IDMA64C_CTLL_SRC_MSIZE(config->src_maxburst) |
264 IDMA64C_CTLL_DST_MSIZE(config->dst_maxburst) |
265 IDMA64C_CTLL_DST_WIDTH(dst_width) |
266 IDMA64C_CTLL_SRC_WIDTH(src_width);
271 static void idma64_desc_fill(struct idma64_chan *idma64c,
272 struct idma64_desc *desc)
274 struct dma_slave_config *config = &idma64c->config;
275 unsigned int i = desc->ndesc;
276 struct idma64_hw_desc *hw = &desc->hw[i - 1];
277 struct idma64_lli *lli = hw->lli;
280 /* Fill the hardware descriptors and link them to a list */
283 idma64_hw_desc_fill(hw, config, desc->direction, llp);
285 desc->length += hw->len;
288 /* Trigger an interrupt after the last block is transfered */
289 lli->ctllo |= IDMA64C_CTLL_INT_EN;
291 /* Disable LLP transfer in the last block */
292 lli->ctllo &= ~(IDMA64C_CTLL_LLP_S_EN | IDMA64C_CTLL_LLP_D_EN);
295 static struct dma_async_tx_descriptor *idma64_prep_slave_sg(
296 struct dma_chan *chan, struct scatterlist *sgl,
297 unsigned int sg_len, enum dma_transfer_direction direction,
298 unsigned long flags, void *context)
300 struct idma64_chan *idma64c = to_idma64_chan(chan);
301 struct idma64_desc *desc;
302 struct scatterlist *sg;
305 desc = idma64_alloc_desc(sg_len);
309 for_each_sg(sgl, sg, sg_len, i) {
310 struct idma64_hw_desc *hw = &desc->hw[i];
312 /* Allocate DMA capable memory for hardware descriptor */
313 hw->lli = dma_pool_alloc(idma64c->pool, GFP_NOWAIT, &hw->llp);
316 idma64_desc_free(idma64c, desc);
320 hw->phys = sg_dma_address(sg);
321 hw->len = sg_dma_len(sg);
324 desc->ndesc = sg_len;
325 desc->direction = direction;
326 desc->status = DMA_IN_PROGRESS;
328 idma64_desc_fill(idma64c, desc);
329 return vchan_tx_prep(&idma64c->vchan, &desc->vdesc, flags);
332 static void idma64_issue_pending(struct dma_chan *chan)
334 struct idma64_chan *idma64c = to_idma64_chan(chan);
337 spin_lock_irqsave(&idma64c->vchan.lock, flags);
338 if (vchan_issue_pending(&idma64c->vchan) && !idma64c->desc)
339 idma64_start_transfer(idma64c);
340 spin_unlock_irqrestore(&idma64c->vchan.lock, flags);
343 static size_t idma64_active_desc_size(struct idma64_chan *idma64c)
345 struct idma64_desc *desc = idma64c->desc;
346 struct idma64_hw_desc *hw;
347 size_t bytes = desc->length;
348 u64 llp = channel_readq(idma64c, LLP);
349 u32 ctlhi = channel_readl(idma64c, CTL_HI);
357 } while (++i < desc->ndesc);
362 /* The current chunk is not fully transfered yet */
363 bytes += desc->hw[--i].len;
365 return bytes - IDMA64C_CTLH_BLOCK_TS(ctlhi);
368 static enum dma_status idma64_tx_status(struct dma_chan *chan,
369 dma_cookie_t cookie, struct dma_tx_state *state)
371 struct idma64_chan *idma64c = to_idma64_chan(chan);
372 struct virt_dma_desc *vdesc;
373 enum dma_status status;
377 status = dma_cookie_status(chan, cookie, state);
378 if (status == DMA_COMPLETE)
381 spin_lock_irqsave(&idma64c->vchan.lock, flags);
382 vdesc = vchan_find_desc(&idma64c->vchan, cookie);
383 if (idma64c->desc && cookie == idma64c->desc->vdesc.tx.cookie) {
384 bytes = idma64_active_desc_size(idma64c);
385 dma_set_residue(state, bytes);
386 status = idma64c->desc->status;
388 bytes = to_idma64_desc(vdesc)->length;
389 dma_set_residue(state, bytes);
391 spin_unlock_irqrestore(&idma64c->vchan.lock, flags);
396 static void convert_burst(u32 *maxburst)
399 *maxburst = __fls(*maxburst);
404 static int idma64_slave_config(struct dma_chan *chan,
405 struct dma_slave_config *config)
407 struct idma64_chan *idma64c = to_idma64_chan(chan);
409 memcpy(&idma64c->config, config, sizeof(idma64c->config));
411 convert_burst(&idma64c->config.src_maxburst);
412 convert_burst(&idma64c->config.dst_maxburst);
417 static void idma64_chan_deactivate(struct idma64_chan *idma64c, bool drain)
419 unsigned short count = 100;
422 cfglo = channel_readl(idma64c, CFG_LO);
424 cfglo |= IDMA64C_CFGL_CH_DRAIN;
426 cfglo &= ~IDMA64C_CFGL_CH_DRAIN;
428 channel_writel(idma64c, CFG_LO, cfglo | IDMA64C_CFGL_CH_SUSP);
431 cfglo = channel_readl(idma64c, CFG_LO);
432 } while (!(cfglo & IDMA64C_CFGL_FIFO_EMPTY) && --count);
435 static void idma64_chan_activate(struct idma64_chan *idma64c)
439 cfglo = channel_readl(idma64c, CFG_LO);
440 channel_writel(idma64c, CFG_LO, cfglo & ~IDMA64C_CFGL_CH_SUSP);
443 static int idma64_pause(struct dma_chan *chan)
445 struct idma64_chan *idma64c = to_idma64_chan(chan);
448 spin_lock_irqsave(&idma64c->vchan.lock, flags);
449 if (idma64c->desc && idma64c->desc->status == DMA_IN_PROGRESS) {
450 idma64_chan_deactivate(idma64c, false);
451 idma64c->desc->status = DMA_PAUSED;
453 spin_unlock_irqrestore(&idma64c->vchan.lock, flags);
458 static int idma64_resume(struct dma_chan *chan)
460 struct idma64_chan *idma64c = to_idma64_chan(chan);
463 spin_lock_irqsave(&idma64c->vchan.lock, flags);
464 if (idma64c->desc && idma64c->desc->status == DMA_PAUSED) {
465 idma64c->desc->status = DMA_IN_PROGRESS;
466 idma64_chan_activate(idma64c);
468 spin_unlock_irqrestore(&idma64c->vchan.lock, flags);
473 static int idma64_terminate_all(struct dma_chan *chan)
475 struct idma64_chan *idma64c = to_idma64_chan(chan);
479 spin_lock_irqsave(&idma64c->vchan.lock, flags);
480 idma64_chan_deactivate(idma64c, true);
481 idma64_stop_transfer(idma64c);
483 idma64_vdesc_free(&idma64c->desc->vdesc);
484 idma64c->desc = NULL;
486 vchan_get_all_descriptors(&idma64c->vchan, &head);
487 spin_unlock_irqrestore(&idma64c->vchan.lock, flags);
489 vchan_dma_desc_free_list(&idma64c->vchan, &head);
493 static void idma64_synchronize(struct dma_chan *chan)
495 struct idma64_chan *idma64c = to_idma64_chan(chan);
497 vchan_synchronize(&idma64c->vchan);
500 static int idma64_alloc_chan_resources(struct dma_chan *chan)
502 struct idma64_chan *idma64c = to_idma64_chan(chan);
504 /* Create a pool of consistent memory blocks for hardware descriptors */
505 idma64c->pool = dma_pool_create(dev_name(chan2dev(chan)),
507 sizeof(struct idma64_lli), 8, 0);
508 if (!idma64c->pool) {
509 dev_err(chan2dev(chan), "No memory for descriptors\n");
516 static void idma64_free_chan_resources(struct dma_chan *chan)
518 struct idma64_chan *idma64c = to_idma64_chan(chan);
520 vchan_free_chan_resources(to_virt_chan(chan));
521 dma_pool_destroy(idma64c->pool);
522 idma64c->pool = NULL;
525 /* ---------------------------------------------------------------------- */
527 #define IDMA64_BUSWIDTHS \
528 BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) | \
529 BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) | \
530 BIT(DMA_SLAVE_BUSWIDTH_4_BYTES)
532 static int idma64_probe(struct idma64_chip *chip)
534 struct idma64 *idma64;
535 unsigned short nr_chan = IDMA64_NR_CHAN;
539 idma64 = devm_kzalloc(chip->dev, sizeof(*idma64), GFP_KERNEL);
543 idma64->regs = chip->regs;
544 chip->idma64 = idma64;
546 idma64->chan = devm_kcalloc(chip->dev, nr_chan, sizeof(*idma64->chan),
551 idma64->all_chan_mask = (1 << nr_chan) - 1;
553 /* Turn off iDMA controller */
556 ret = devm_request_irq(chip->dev, chip->irq, idma64_irq, IRQF_SHARED,
557 dev_name(chip->dev), idma64);
561 INIT_LIST_HEAD(&idma64->dma.channels);
562 for (i = 0; i < nr_chan; i++) {
563 struct idma64_chan *idma64c = &idma64->chan[i];
565 idma64c->vchan.desc_free = idma64_vdesc_free;
566 vchan_init(&idma64c->vchan, &idma64->dma);
568 idma64c->regs = idma64->regs + i * IDMA64_CH_LENGTH;
569 idma64c->mask = BIT(i);
572 dma_cap_set(DMA_SLAVE, idma64->dma.cap_mask);
573 dma_cap_set(DMA_PRIVATE, idma64->dma.cap_mask);
575 idma64->dma.device_alloc_chan_resources = idma64_alloc_chan_resources;
576 idma64->dma.device_free_chan_resources = idma64_free_chan_resources;
578 idma64->dma.device_prep_slave_sg = idma64_prep_slave_sg;
580 idma64->dma.device_issue_pending = idma64_issue_pending;
581 idma64->dma.device_tx_status = idma64_tx_status;
583 idma64->dma.device_config = idma64_slave_config;
584 idma64->dma.device_pause = idma64_pause;
585 idma64->dma.device_resume = idma64_resume;
586 idma64->dma.device_terminate_all = idma64_terminate_all;
587 idma64->dma.device_synchronize = idma64_synchronize;
589 idma64->dma.src_addr_widths = IDMA64_BUSWIDTHS;
590 idma64->dma.dst_addr_widths = IDMA64_BUSWIDTHS;
591 idma64->dma.directions = BIT(DMA_DEV_TO_MEM) | BIT(DMA_MEM_TO_DEV);
592 idma64->dma.residue_granularity = DMA_RESIDUE_GRANULARITY_BURST;
594 idma64->dma.dev = chip->sysdev;
596 dma_set_max_seg_size(idma64->dma.dev, IDMA64C_CTLH_BLOCK_TS_MASK);
598 ret = dma_async_device_register(&idma64->dma);
602 dev_info(chip->dev, "Found Intel integrated DMA 64-bit\n");
606 static int idma64_remove(struct idma64_chip *chip)
608 struct idma64 *idma64 = chip->idma64;
611 dma_async_device_unregister(&idma64->dma);
614 * Explicitly call devm_request_irq() to avoid the side effects with
615 * the scheduled tasklets.
617 devm_free_irq(chip->dev, chip->irq, idma64);
619 for (i = 0; i < idma64->dma.chancnt; i++) {
620 struct idma64_chan *idma64c = &idma64->chan[i];
622 tasklet_kill(&idma64c->vchan.task);
628 /* ---------------------------------------------------------------------- */
630 static int idma64_platform_probe(struct platform_device *pdev)
632 struct idma64_chip *chip;
633 struct device *dev = &pdev->dev;
634 struct device *sysdev = dev->parent;
635 struct resource *mem;
638 chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
642 chip->irq = platform_get_irq(pdev, 0);
646 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
647 chip->regs = devm_ioremap_resource(dev, mem);
648 if (IS_ERR(chip->regs))
649 return PTR_ERR(chip->regs);
651 ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
656 chip->sysdev = sysdev;
658 ret = idma64_probe(chip);
662 platform_set_drvdata(pdev, chip);
666 static int idma64_platform_remove(struct platform_device *pdev)
668 struct idma64_chip *chip = platform_get_drvdata(pdev);
670 return idma64_remove(chip);
673 #ifdef CONFIG_PM_SLEEP
675 static int idma64_pm_suspend(struct device *dev)
677 struct idma64_chip *chip = dev_get_drvdata(dev);
679 idma64_off(chip->idma64);
683 static int idma64_pm_resume(struct device *dev)
685 struct idma64_chip *chip = dev_get_drvdata(dev);
687 idma64_on(chip->idma64);
691 #endif /* CONFIG_PM_SLEEP */
693 static const struct dev_pm_ops idma64_dev_pm_ops = {
694 SET_SYSTEM_SLEEP_PM_OPS(idma64_pm_suspend, idma64_pm_resume)
697 static struct platform_driver idma64_platform_driver = {
698 .probe = idma64_platform_probe,
699 .remove = idma64_platform_remove,
701 .name = LPSS_IDMA64_DRIVER_NAME,
702 .pm = &idma64_dev_pm_ops,
706 module_platform_driver(idma64_platform_driver);
708 MODULE_LICENSE("GPL v2");
709 MODULE_DESCRIPTION("iDMA64 core driver");
711 MODULE_ALIAS("platform:" LPSS_IDMA64_DRIVER_NAME);