2 * Copyright (C) 2013, Lars-Peter Clausen <lars@metafoo.de>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
12 #include <linux/dmaengine.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/list.h>
17 #include <linux/module.h>
18 #include <linux/platform_device.h>
19 #include <linux/slab.h>
20 #include <linux/spinlock.h>
21 #include <linux/irq.h>
22 #include <linux/clk.h>
26 #define JZ_DMA_NR_CHANS 6
28 #define JZ_REG_DMA_SRC_ADDR(x) (0x00 + (x) * 0x20)
29 #define JZ_REG_DMA_DST_ADDR(x) (0x04 + (x) * 0x20)
30 #define JZ_REG_DMA_TRANSFER_COUNT(x) (0x08 + (x) * 0x20)
31 #define JZ_REG_DMA_REQ_TYPE(x) (0x0C + (x) * 0x20)
32 #define JZ_REG_DMA_STATUS_CTRL(x) (0x10 + (x) * 0x20)
33 #define JZ_REG_DMA_CMD(x) (0x14 + (x) * 0x20)
34 #define JZ_REG_DMA_DESC_ADDR(x) (0x18 + (x) * 0x20)
36 #define JZ_REG_DMA_CTRL 0x300
37 #define JZ_REG_DMA_IRQ 0x304
38 #define JZ_REG_DMA_DOORBELL 0x308
39 #define JZ_REG_DMA_DOORBELL_SET 0x30C
41 #define JZ_DMA_STATUS_CTRL_NO_DESC BIT(31)
42 #define JZ_DMA_STATUS_CTRL_DESC_INV BIT(6)
43 #define JZ_DMA_STATUS_CTRL_ADDR_ERR BIT(4)
44 #define JZ_DMA_STATUS_CTRL_TRANSFER_DONE BIT(3)
45 #define JZ_DMA_STATUS_CTRL_HALT BIT(2)
46 #define JZ_DMA_STATUS_CTRL_COUNT_TERMINATE BIT(1)
47 #define JZ_DMA_STATUS_CTRL_ENABLE BIT(0)
49 #define JZ_DMA_CMD_SRC_INC BIT(23)
50 #define JZ_DMA_CMD_DST_INC BIT(22)
51 #define JZ_DMA_CMD_RDIL_MASK (0xf << 16)
52 #define JZ_DMA_CMD_SRC_WIDTH_MASK (0x3 << 14)
53 #define JZ_DMA_CMD_DST_WIDTH_MASK (0x3 << 12)
54 #define JZ_DMA_CMD_INTERVAL_LENGTH_MASK (0x7 << 8)
55 #define JZ_DMA_CMD_BLOCK_MODE BIT(7)
56 #define JZ_DMA_CMD_DESC_VALID BIT(4)
57 #define JZ_DMA_CMD_DESC_VALID_MODE BIT(3)
58 #define JZ_DMA_CMD_VALID_IRQ_ENABLE BIT(2)
59 #define JZ_DMA_CMD_TRANSFER_IRQ_ENABLE BIT(1)
60 #define JZ_DMA_CMD_LINK_ENABLE BIT(0)
62 #define JZ_DMA_CMD_FLAGS_OFFSET 22
63 #define JZ_DMA_CMD_RDIL_OFFSET 16
64 #define JZ_DMA_CMD_SRC_WIDTH_OFFSET 14
65 #define JZ_DMA_CMD_DST_WIDTH_OFFSET 12
66 #define JZ_DMA_CMD_TRANSFER_SIZE_OFFSET 8
67 #define JZ_DMA_CMD_MODE_OFFSET 7
69 #define JZ_DMA_CTRL_PRIORITY_MASK (0x3 << 8)
70 #define JZ_DMA_CTRL_HALT BIT(3)
71 #define JZ_DMA_CTRL_ADDRESS_ERROR BIT(2)
72 #define JZ_DMA_CTRL_ENABLE BIT(0)
74 enum jz4740_dma_width
{
75 JZ4740_DMA_WIDTH_32BIT
= 0,
76 JZ4740_DMA_WIDTH_8BIT
= 1,
77 JZ4740_DMA_WIDTH_16BIT
= 2,
80 enum jz4740_dma_transfer_size
{
81 JZ4740_DMA_TRANSFER_SIZE_4BYTE
= 0,
82 JZ4740_DMA_TRANSFER_SIZE_1BYTE
= 1,
83 JZ4740_DMA_TRANSFER_SIZE_2BYTE
= 2,
84 JZ4740_DMA_TRANSFER_SIZE_16BYTE
= 3,
85 JZ4740_DMA_TRANSFER_SIZE_32BYTE
= 4,
88 enum jz4740_dma_flags
{
89 JZ4740_DMA_SRC_AUTOINC
= 0x2,
90 JZ4740_DMA_DST_AUTOINC
= 0x1,
93 enum jz4740_dma_mode
{
94 JZ4740_DMA_MODE_SINGLE
= 0,
95 JZ4740_DMA_MODE_BLOCK
= 1,
98 struct jz4740_dma_sg
{
103 struct jz4740_dma_desc
{
104 struct virt_dma_desc vdesc
;
106 enum dma_transfer_direction direction
;
109 unsigned int num_sgs
;
110 struct jz4740_dma_sg sg
[];
113 struct jz4740_dmaengine_chan
{
114 struct virt_dma_chan vchan
;
116 struct dma_slave_config config
;
118 dma_addr_t fifo_addr
;
119 unsigned int transfer_shift
;
121 struct jz4740_dma_desc
*desc
;
122 unsigned int next_sg
;
125 struct jz4740_dma_dev
{
126 struct dma_device ddev
;
130 struct jz4740_dmaengine_chan chan
[JZ_DMA_NR_CHANS
];
133 static struct jz4740_dma_dev
*jz4740_dma_chan_get_dev(
134 struct jz4740_dmaengine_chan
*chan
)
136 return container_of(chan
->vchan
.chan
.device
, struct jz4740_dma_dev
,
140 static struct jz4740_dmaengine_chan
*to_jz4740_dma_chan(struct dma_chan
*c
)
142 return container_of(c
, struct jz4740_dmaengine_chan
, vchan
.chan
);
145 static struct jz4740_dma_desc
*to_jz4740_dma_desc(struct virt_dma_desc
*vdesc
)
147 return container_of(vdesc
, struct jz4740_dma_desc
, vdesc
);
150 static inline uint32_t jz4740_dma_read(struct jz4740_dma_dev
*dmadev
,
153 return readl(dmadev
->base
+ reg
);
156 static inline void jz4740_dma_write(struct jz4740_dma_dev
*dmadev
,
157 unsigned reg
, uint32_t val
)
159 writel(val
, dmadev
->base
+ reg
);
162 static inline void jz4740_dma_write_mask(struct jz4740_dma_dev
*dmadev
,
163 unsigned int reg
, uint32_t val
, uint32_t mask
)
167 tmp
= jz4740_dma_read(dmadev
, reg
);
170 jz4740_dma_write(dmadev
, reg
, tmp
);
173 static struct jz4740_dma_desc
*jz4740_dma_alloc_desc(unsigned int num_sgs
)
175 return kzalloc(sizeof(struct jz4740_dma_desc
) +
176 sizeof(struct jz4740_dma_sg
) * num_sgs
, GFP_ATOMIC
);
179 static enum jz4740_dma_width
jz4740_dma_width(enum dma_slave_buswidth width
)
182 case DMA_SLAVE_BUSWIDTH_1_BYTE
:
183 return JZ4740_DMA_WIDTH_8BIT
;
184 case DMA_SLAVE_BUSWIDTH_2_BYTES
:
185 return JZ4740_DMA_WIDTH_16BIT
;
186 case DMA_SLAVE_BUSWIDTH_4_BYTES
:
187 return JZ4740_DMA_WIDTH_32BIT
;
189 return JZ4740_DMA_WIDTH_32BIT
;
193 static enum jz4740_dma_transfer_size
jz4740_dma_maxburst(u32 maxburst
)
196 return JZ4740_DMA_TRANSFER_SIZE_1BYTE
;
197 else if (maxburst
<= 3)
198 return JZ4740_DMA_TRANSFER_SIZE_2BYTE
;
199 else if (maxburst
<= 15)
200 return JZ4740_DMA_TRANSFER_SIZE_4BYTE
;
201 else if (maxburst
<= 31)
202 return JZ4740_DMA_TRANSFER_SIZE_16BYTE
;
204 return JZ4740_DMA_TRANSFER_SIZE_32BYTE
;
207 static int jz4740_dma_slave_config_write(struct dma_chan
*c
,
208 struct dma_slave_config
*config
,
209 enum dma_transfer_direction direction
)
211 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
212 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
213 enum jz4740_dma_width src_width
;
214 enum jz4740_dma_width dst_width
;
215 enum jz4740_dma_transfer_size transfer_size
;
216 enum jz4740_dma_flags flags
;
221 flags
= JZ4740_DMA_SRC_AUTOINC
;
222 transfer_size
= jz4740_dma_maxburst(config
->dst_maxburst
);
223 chan
->fifo_addr
= config
->dst_addr
;
226 flags
= JZ4740_DMA_DST_AUTOINC
;
227 transfer_size
= jz4740_dma_maxburst(config
->src_maxburst
);
228 chan
->fifo_addr
= config
->src_addr
;
234 src_width
= jz4740_dma_width(config
->src_addr_width
);
235 dst_width
= jz4740_dma_width(config
->dst_addr_width
);
237 switch (transfer_size
) {
238 case JZ4740_DMA_TRANSFER_SIZE_2BYTE
:
239 chan
->transfer_shift
= 1;
241 case JZ4740_DMA_TRANSFER_SIZE_4BYTE
:
242 chan
->transfer_shift
= 2;
244 case JZ4740_DMA_TRANSFER_SIZE_16BYTE
:
245 chan
->transfer_shift
= 4;
247 case JZ4740_DMA_TRANSFER_SIZE_32BYTE
:
248 chan
->transfer_shift
= 5;
251 chan
->transfer_shift
= 0;
255 cmd
= flags
<< JZ_DMA_CMD_FLAGS_OFFSET
;
256 cmd
|= src_width
<< JZ_DMA_CMD_SRC_WIDTH_OFFSET
;
257 cmd
|= dst_width
<< JZ_DMA_CMD_DST_WIDTH_OFFSET
;
258 cmd
|= transfer_size
<< JZ_DMA_CMD_TRANSFER_SIZE_OFFSET
;
259 cmd
|= JZ4740_DMA_MODE_SINGLE
<< JZ_DMA_CMD_MODE_OFFSET
;
260 cmd
|= JZ_DMA_CMD_TRANSFER_IRQ_ENABLE
;
262 jz4740_dma_write(dmadev
, JZ_REG_DMA_CMD(chan
->id
), cmd
);
263 jz4740_dma_write(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
), 0);
264 jz4740_dma_write(dmadev
, JZ_REG_DMA_REQ_TYPE(chan
->id
),
270 static int jz4740_dma_slave_config(struct dma_chan
*c
,
271 struct dma_slave_config
*config
)
273 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
275 memcpy(&chan
->config
, config
, sizeof(*config
));
279 static int jz4740_dma_terminate_all(struct dma_chan
*c
)
281 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
282 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
286 spin_lock_irqsave(&chan
->vchan
.lock
, flags
);
287 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
), 0,
288 JZ_DMA_STATUS_CTRL_ENABLE
);
290 vchan_get_all_descriptors(&chan
->vchan
, &head
);
291 spin_unlock_irqrestore(&chan
->vchan
.lock
, flags
);
293 vchan_dma_desc_free_list(&chan
->vchan
, &head
);
298 static int jz4740_dma_start_transfer(struct jz4740_dmaengine_chan
*chan
)
300 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
301 dma_addr_t src_addr
, dst_addr
;
302 struct virt_dma_desc
*vdesc
;
303 struct jz4740_dma_sg
*sg
;
305 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
), 0,
306 JZ_DMA_STATUS_CTRL_ENABLE
);
309 vdesc
= vchan_next_desc(&chan
->vchan
);
312 chan
->desc
= to_jz4740_dma_desc(vdesc
);
316 if (chan
->next_sg
== chan
->desc
->num_sgs
)
319 sg
= &chan
->desc
->sg
[chan
->next_sg
];
321 if (chan
->desc
->direction
== DMA_MEM_TO_DEV
) {
323 dst_addr
= chan
->fifo_addr
;
325 src_addr
= chan
->fifo_addr
;
328 jz4740_dma_write(dmadev
, JZ_REG_DMA_SRC_ADDR(chan
->id
), src_addr
);
329 jz4740_dma_write(dmadev
, JZ_REG_DMA_DST_ADDR(chan
->id
), dst_addr
);
330 jz4740_dma_write(dmadev
, JZ_REG_DMA_TRANSFER_COUNT(chan
->id
),
331 sg
->len
>> chan
->transfer_shift
);
335 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
),
336 JZ_DMA_STATUS_CTRL_NO_DESC
| JZ_DMA_STATUS_CTRL_ENABLE
,
337 JZ_DMA_STATUS_CTRL_HALT
| JZ_DMA_STATUS_CTRL_NO_DESC
|
338 JZ_DMA_STATUS_CTRL_ENABLE
);
340 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_CTRL
,
342 JZ_DMA_CTRL_HALT
| JZ_DMA_CTRL_ENABLE
);
347 static void jz4740_dma_chan_irq(struct jz4740_dmaengine_chan
*chan
)
349 spin_lock(&chan
->vchan
.lock
);
351 if (chan
->desc
->cyclic
) {
352 vchan_cyclic_callback(&chan
->desc
->vdesc
);
354 if (chan
->next_sg
== chan
->desc
->num_sgs
) {
355 list_del(&chan
->desc
->vdesc
.node
);
356 vchan_cookie_complete(&chan
->desc
->vdesc
);
361 jz4740_dma_start_transfer(chan
);
362 spin_unlock(&chan
->vchan
.lock
);
365 static irqreturn_t
jz4740_dma_irq(int irq
, void *devid
)
367 struct jz4740_dma_dev
*dmadev
= devid
;
371 irq_status
= readl(dmadev
->base
+ JZ_REG_DMA_IRQ
);
373 for (i
= 0; i
< 6; ++i
) {
374 if (irq_status
& (1 << i
)) {
375 jz4740_dma_write_mask(dmadev
,
376 JZ_REG_DMA_STATUS_CTRL(i
), 0,
377 JZ_DMA_STATUS_CTRL_ENABLE
|
378 JZ_DMA_STATUS_CTRL_TRANSFER_DONE
);
380 jz4740_dma_chan_irq(&dmadev
->chan
[i
]);
387 static void jz4740_dma_issue_pending(struct dma_chan
*c
)
389 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
392 spin_lock_irqsave(&chan
->vchan
.lock
, flags
);
393 if (vchan_issue_pending(&chan
->vchan
) && !chan
->desc
)
394 jz4740_dma_start_transfer(chan
);
395 spin_unlock_irqrestore(&chan
->vchan
.lock
, flags
);
398 static struct dma_async_tx_descriptor
*jz4740_dma_prep_slave_sg(
399 struct dma_chan
*c
, struct scatterlist
*sgl
,
400 unsigned int sg_len
, enum dma_transfer_direction direction
,
401 unsigned long flags
, void *context
)
403 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
404 struct jz4740_dma_desc
*desc
;
405 struct scatterlist
*sg
;
408 desc
= jz4740_dma_alloc_desc(sg_len
);
412 for_each_sg(sgl
, sg
, sg_len
, i
) {
413 desc
->sg
[i
].addr
= sg_dma_address(sg
);
414 desc
->sg
[i
].len
= sg_dma_len(sg
);
417 desc
->num_sgs
= sg_len
;
418 desc
->direction
= direction
;
419 desc
->cyclic
= false;
421 jz4740_dma_slave_config_write(c
, &chan
->config
, direction
);
423 return vchan_tx_prep(&chan
->vchan
, &desc
->vdesc
, flags
);
426 static struct dma_async_tx_descriptor
*jz4740_dma_prep_dma_cyclic(
427 struct dma_chan
*c
, dma_addr_t buf_addr
, size_t buf_len
,
428 size_t period_len
, enum dma_transfer_direction direction
,
431 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
432 struct jz4740_dma_desc
*desc
;
433 unsigned int num_periods
, i
;
435 if (buf_len
% period_len
)
438 num_periods
= buf_len
/ period_len
;
440 desc
= jz4740_dma_alloc_desc(num_periods
);
444 for (i
= 0; i
< num_periods
; i
++) {
445 desc
->sg
[i
].addr
= buf_addr
;
446 desc
->sg
[i
].len
= period_len
;
447 buf_addr
+= period_len
;
450 desc
->num_sgs
= num_periods
;
451 desc
->direction
= direction
;
454 jz4740_dma_slave_config_write(c
, &chan
->config
, direction
);
456 return vchan_tx_prep(&chan
->vchan
, &desc
->vdesc
, flags
);
459 static size_t jz4740_dma_desc_residue(struct jz4740_dmaengine_chan
*chan
,
460 struct jz4740_dma_desc
*desc
, unsigned int next_sg
)
462 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
463 unsigned int residue
, count
;
468 for (i
= next_sg
; i
< desc
->num_sgs
; i
++)
469 residue
+= desc
->sg
[i
].len
;
472 count
= jz4740_dma_read(dmadev
,
473 JZ_REG_DMA_TRANSFER_COUNT(chan
->id
));
474 residue
+= count
<< chan
->transfer_shift
;
480 static enum dma_status
jz4740_dma_tx_status(struct dma_chan
*c
,
481 dma_cookie_t cookie
, struct dma_tx_state
*state
)
483 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
484 struct virt_dma_desc
*vdesc
;
485 enum dma_status status
;
488 status
= dma_cookie_status(c
, cookie
, state
);
489 if (status
== DMA_COMPLETE
|| !state
)
492 spin_lock_irqsave(&chan
->vchan
.lock
, flags
);
493 vdesc
= vchan_find_desc(&chan
->vchan
, cookie
);
494 if (cookie
== chan
->desc
->vdesc
.tx
.cookie
) {
495 state
->residue
= jz4740_dma_desc_residue(chan
, chan
->desc
,
498 state
->residue
= jz4740_dma_desc_residue(chan
,
499 to_jz4740_dma_desc(vdesc
), 0);
503 spin_unlock_irqrestore(&chan
->vchan
.lock
, flags
);
508 static void jz4740_dma_free_chan_resources(struct dma_chan
*c
)
510 vchan_free_chan_resources(to_virt_chan(c
));
513 static void jz4740_dma_desc_free(struct virt_dma_desc
*vdesc
)
515 kfree(container_of(vdesc
, struct jz4740_dma_desc
, vdesc
));
518 #define JZ4740_DMA_BUSWIDTHS (BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) | \
519 BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) | BIT(DMA_SLAVE_BUSWIDTH_4_BYTES))
521 static int jz4740_dma_probe(struct platform_device
*pdev
)
523 struct jz4740_dmaengine_chan
*chan
;
524 struct jz4740_dma_dev
*dmadev
;
525 struct dma_device
*dd
;
527 struct resource
*res
;
531 dmadev
= devm_kzalloc(&pdev
->dev
, sizeof(*dmadev
), GFP_KERNEL
);
537 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
538 dmadev
->base
= devm_ioremap_resource(&pdev
->dev
, res
);
539 if (IS_ERR(dmadev
->base
))
540 return PTR_ERR(dmadev
->base
);
542 dmadev
->clk
= clk_get(&pdev
->dev
, "dma");
543 if (IS_ERR(dmadev
->clk
))
544 return PTR_ERR(dmadev
->clk
);
546 clk_prepare_enable(dmadev
->clk
);
548 dma_cap_set(DMA_SLAVE
, dd
->cap_mask
);
549 dma_cap_set(DMA_CYCLIC
, dd
->cap_mask
);
550 dd
->device_free_chan_resources
= jz4740_dma_free_chan_resources
;
551 dd
->device_tx_status
= jz4740_dma_tx_status
;
552 dd
->device_issue_pending
= jz4740_dma_issue_pending
;
553 dd
->device_prep_slave_sg
= jz4740_dma_prep_slave_sg
;
554 dd
->device_prep_dma_cyclic
= jz4740_dma_prep_dma_cyclic
;
555 dd
->device_config
= jz4740_dma_slave_config
;
556 dd
->device_terminate_all
= jz4740_dma_terminate_all
;
557 dd
->src_addr_widths
= JZ4740_DMA_BUSWIDTHS
;
558 dd
->dst_addr_widths
= JZ4740_DMA_BUSWIDTHS
;
559 dd
->directions
= BIT(DMA_DEV_TO_MEM
) | BIT(DMA_MEM_TO_DEV
);
560 dd
->residue_granularity
= DMA_RESIDUE_GRANULARITY_BURST
;
561 dd
->dev
= &pdev
->dev
;
562 INIT_LIST_HEAD(&dd
->channels
);
564 for (i
= 0; i
< JZ_DMA_NR_CHANS
; i
++) {
565 chan
= &dmadev
->chan
[i
];
567 chan
->vchan
.desc_free
= jz4740_dma_desc_free
;
568 vchan_init(&chan
->vchan
, dd
);
571 ret
= dma_async_device_register(dd
);
575 irq
= platform_get_irq(pdev
, 0);
576 ret
= request_irq(irq
, jz4740_dma_irq
, 0, dev_name(&pdev
->dev
), dmadev
);
580 platform_set_drvdata(pdev
, dmadev
);
585 dma_async_device_unregister(dd
);
587 clk_disable_unprepare(dmadev
->clk
);
591 static void jz4740_cleanup_vchan(struct dma_device
*dmadev
)
593 struct jz4740_dmaengine_chan
*chan
, *_chan
;
595 list_for_each_entry_safe(chan
, _chan
,
596 &dmadev
->channels
, vchan
.chan
.device_node
) {
597 list_del(&chan
->vchan
.chan
.device_node
);
598 tasklet_kill(&chan
->vchan
.task
);
603 static int jz4740_dma_remove(struct platform_device
*pdev
)
605 struct jz4740_dma_dev
*dmadev
= platform_get_drvdata(pdev
);
606 int irq
= platform_get_irq(pdev
, 0);
608 free_irq(irq
, dmadev
);
610 jz4740_cleanup_vchan(&dmadev
->ddev
);
611 dma_async_device_unregister(&dmadev
->ddev
);
612 clk_disable_unprepare(dmadev
->clk
);
617 static struct platform_driver jz4740_dma_driver
= {
618 .probe
= jz4740_dma_probe
,
619 .remove
= jz4740_dma_remove
,
621 .name
= "jz4740-dma",
624 module_platform_driver(jz4740_dma_driver
);
626 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
627 MODULE_DESCRIPTION("JZ4740 DMA driver");
628 MODULE_LICENSE("GPL v2");