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
;
117 dma_addr_t fifo_addr
;
118 unsigned int transfer_shift
;
120 struct jz4740_dma_desc
*desc
;
121 unsigned int next_sg
;
124 struct jz4740_dma_dev
{
125 struct dma_device ddev
;
129 struct jz4740_dmaengine_chan chan
[JZ_DMA_NR_CHANS
];
132 static struct jz4740_dma_dev
*jz4740_dma_chan_get_dev(
133 struct jz4740_dmaengine_chan
*chan
)
135 return container_of(chan
->vchan
.chan
.device
, struct jz4740_dma_dev
,
139 static struct jz4740_dmaengine_chan
*to_jz4740_dma_chan(struct dma_chan
*c
)
141 return container_of(c
, struct jz4740_dmaengine_chan
, vchan
.chan
);
144 static struct jz4740_dma_desc
*to_jz4740_dma_desc(struct virt_dma_desc
*vdesc
)
146 return container_of(vdesc
, struct jz4740_dma_desc
, vdesc
);
149 static inline uint32_t jz4740_dma_read(struct jz4740_dma_dev
*dmadev
,
152 return readl(dmadev
->base
+ reg
);
155 static inline void jz4740_dma_write(struct jz4740_dma_dev
*dmadev
,
156 unsigned reg
, uint32_t val
)
158 writel(val
, dmadev
->base
+ reg
);
161 static inline void jz4740_dma_write_mask(struct jz4740_dma_dev
*dmadev
,
162 unsigned int reg
, uint32_t val
, uint32_t mask
)
166 tmp
= jz4740_dma_read(dmadev
, reg
);
169 jz4740_dma_write(dmadev
, reg
, tmp
);
172 static struct jz4740_dma_desc
*jz4740_dma_alloc_desc(unsigned int num_sgs
)
174 return kzalloc(sizeof(struct jz4740_dma_desc
) +
175 sizeof(struct jz4740_dma_sg
) * num_sgs
, GFP_ATOMIC
);
178 static enum jz4740_dma_width
jz4740_dma_width(enum dma_slave_buswidth width
)
181 case DMA_SLAVE_BUSWIDTH_1_BYTE
:
182 return JZ4740_DMA_WIDTH_8BIT
;
183 case DMA_SLAVE_BUSWIDTH_2_BYTES
:
184 return JZ4740_DMA_WIDTH_16BIT
;
185 case DMA_SLAVE_BUSWIDTH_4_BYTES
:
186 return JZ4740_DMA_WIDTH_32BIT
;
188 return JZ4740_DMA_WIDTH_32BIT
;
192 static enum jz4740_dma_transfer_size
jz4740_dma_maxburst(u32 maxburst
)
195 return JZ4740_DMA_TRANSFER_SIZE_1BYTE
;
196 else if (maxburst
<= 3)
197 return JZ4740_DMA_TRANSFER_SIZE_2BYTE
;
198 else if (maxburst
<= 15)
199 return JZ4740_DMA_TRANSFER_SIZE_4BYTE
;
200 else if (maxburst
<= 31)
201 return JZ4740_DMA_TRANSFER_SIZE_16BYTE
;
203 return JZ4740_DMA_TRANSFER_SIZE_32BYTE
;
206 static int jz4740_dma_slave_config(struct dma_chan
*c
,
207 struct dma_slave_config
*config
)
209 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
210 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
211 enum jz4740_dma_width src_width
;
212 enum jz4740_dma_width dst_width
;
213 enum jz4740_dma_transfer_size transfer_size
;
214 enum jz4740_dma_flags flags
;
217 switch (config
->direction
) {
219 flags
= JZ4740_DMA_SRC_AUTOINC
;
220 transfer_size
= jz4740_dma_maxburst(config
->dst_maxburst
);
221 chan
->fifo_addr
= config
->dst_addr
;
224 flags
= JZ4740_DMA_DST_AUTOINC
;
225 transfer_size
= jz4740_dma_maxburst(config
->src_maxburst
);
226 chan
->fifo_addr
= config
->src_addr
;
232 src_width
= jz4740_dma_width(config
->src_addr_width
);
233 dst_width
= jz4740_dma_width(config
->dst_addr_width
);
235 switch (transfer_size
) {
236 case JZ4740_DMA_TRANSFER_SIZE_2BYTE
:
237 chan
->transfer_shift
= 1;
239 case JZ4740_DMA_TRANSFER_SIZE_4BYTE
:
240 chan
->transfer_shift
= 2;
242 case JZ4740_DMA_TRANSFER_SIZE_16BYTE
:
243 chan
->transfer_shift
= 4;
245 case JZ4740_DMA_TRANSFER_SIZE_32BYTE
:
246 chan
->transfer_shift
= 5;
249 chan
->transfer_shift
= 0;
253 cmd
= flags
<< JZ_DMA_CMD_FLAGS_OFFSET
;
254 cmd
|= src_width
<< JZ_DMA_CMD_SRC_WIDTH_OFFSET
;
255 cmd
|= dst_width
<< JZ_DMA_CMD_DST_WIDTH_OFFSET
;
256 cmd
|= transfer_size
<< JZ_DMA_CMD_TRANSFER_SIZE_OFFSET
;
257 cmd
|= JZ4740_DMA_MODE_SINGLE
<< JZ_DMA_CMD_MODE_OFFSET
;
258 cmd
|= JZ_DMA_CMD_TRANSFER_IRQ_ENABLE
;
260 jz4740_dma_write(dmadev
, JZ_REG_DMA_CMD(chan
->id
), cmd
);
261 jz4740_dma_write(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
), 0);
262 jz4740_dma_write(dmadev
, JZ_REG_DMA_REQ_TYPE(chan
->id
),
268 static int jz4740_dma_terminate_all(struct dma_chan
*c
)
270 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
271 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
275 spin_lock_irqsave(&chan
->vchan
.lock
, flags
);
276 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
), 0,
277 JZ_DMA_STATUS_CTRL_ENABLE
);
279 vchan_get_all_descriptors(&chan
->vchan
, &head
);
280 spin_unlock_irqrestore(&chan
->vchan
.lock
, flags
);
282 vchan_dma_desc_free_list(&chan
->vchan
, &head
);
287 static int jz4740_dma_start_transfer(struct jz4740_dmaengine_chan
*chan
)
289 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
290 dma_addr_t src_addr
, dst_addr
;
291 struct virt_dma_desc
*vdesc
;
292 struct jz4740_dma_sg
*sg
;
294 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
), 0,
295 JZ_DMA_STATUS_CTRL_ENABLE
);
298 vdesc
= vchan_next_desc(&chan
->vchan
);
301 chan
->desc
= to_jz4740_dma_desc(vdesc
);
305 if (chan
->next_sg
== chan
->desc
->num_sgs
)
308 sg
= &chan
->desc
->sg
[chan
->next_sg
];
310 if (chan
->desc
->direction
== DMA_MEM_TO_DEV
) {
312 dst_addr
= chan
->fifo_addr
;
314 src_addr
= chan
->fifo_addr
;
317 jz4740_dma_write(dmadev
, JZ_REG_DMA_SRC_ADDR(chan
->id
), src_addr
);
318 jz4740_dma_write(dmadev
, JZ_REG_DMA_DST_ADDR(chan
->id
), dst_addr
);
319 jz4740_dma_write(dmadev
, JZ_REG_DMA_TRANSFER_COUNT(chan
->id
),
320 sg
->len
>> chan
->transfer_shift
);
324 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_STATUS_CTRL(chan
->id
),
325 JZ_DMA_STATUS_CTRL_NO_DESC
| JZ_DMA_STATUS_CTRL_ENABLE
,
326 JZ_DMA_STATUS_CTRL_HALT
| JZ_DMA_STATUS_CTRL_NO_DESC
|
327 JZ_DMA_STATUS_CTRL_ENABLE
);
329 jz4740_dma_write_mask(dmadev
, JZ_REG_DMA_CTRL
,
331 JZ_DMA_CTRL_HALT
| JZ_DMA_CTRL_ENABLE
);
336 static void jz4740_dma_chan_irq(struct jz4740_dmaengine_chan
*chan
)
338 spin_lock(&chan
->vchan
.lock
);
340 if (chan
->desc
->cyclic
) {
341 vchan_cyclic_callback(&chan
->desc
->vdesc
);
343 if (chan
->next_sg
== chan
->desc
->num_sgs
) {
344 list_del(&chan
->desc
->vdesc
.node
);
345 vchan_cookie_complete(&chan
->desc
->vdesc
);
350 jz4740_dma_start_transfer(chan
);
351 spin_unlock(&chan
->vchan
.lock
);
354 static irqreturn_t
jz4740_dma_irq(int irq
, void *devid
)
356 struct jz4740_dma_dev
*dmadev
= devid
;
360 irq_status
= readl(dmadev
->base
+ JZ_REG_DMA_IRQ
);
362 for (i
= 0; i
< 6; ++i
) {
363 if (irq_status
& (1 << i
)) {
364 jz4740_dma_write_mask(dmadev
,
365 JZ_REG_DMA_STATUS_CTRL(i
), 0,
366 JZ_DMA_STATUS_CTRL_ENABLE
|
367 JZ_DMA_STATUS_CTRL_TRANSFER_DONE
);
369 jz4740_dma_chan_irq(&dmadev
->chan
[i
]);
376 static void jz4740_dma_issue_pending(struct dma_chan
*c
)
378 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
381 spin_lock_irqsave(&chan
->vchan
.lock
, flags
);
382 if (vchan_issue_pending(&chan
->vchan
) && !chan
->desc
)
383 jz4740_dma_start_transfer(chan
);
384 spin_unlock_irqrestore(&chan
->vchan
.lock
, flags
);
387 static struct dma_async_tx_descriptor
*jz4740_dma_prep_slave_sg(
388 struct dma_chan
*c
, struct scatterlist
*sgl
,
389 unsigned int sg_len
, enum dma_transfer_direction direction
,
390 unsigned long flags
, void *context
)
392 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
393 struct jz4740_dma_desc
*desc
;
394 struct scatterlist
*sg
;
397 desc
= jz4740_dma_alloc_desc(sg_len
);
401 for_each_sg(sgl
, sg
, sg_len
, i
) {
402 desc
->sg
[i
].addr
= sg_dma_address(sg
);
403 desc
->sg
[i
].len
= sg_dma_len(sg
);
406 desc
->num_sgs
= sg_len
;
407 desc
->direction
= direction
;
408 desc
->cyclic
= false;
410 return vchan_tx_prep(&chan
->vchan
, &desc
->vdesc
, flags
);
413 static struct dma_async_tx_descriptor
*jz4740_dma_prep_dma_cyclic(
414 struct dma_chan
*c
, dma_addr_t buf_addr
, size_t buf_len
,
415 size_t period_len
, enum dma_transfer_direction direction
,
418 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
419 struct jz4740_dma_desc
*desc
;
420 unsigned int num_periods
, i
;
422 if (buf_len
% period_len
)
425 num_periods
= buf_len
/ period_len
;
427 desc
= jz4740_dma_alloc_desc(num_periods
);
431 for (i
= 0; i
< num_periods
; i
++) {
432 desc
->sg
[i
].addr
= buf_addr
;
433 desc
->sg
[i
].len
= period_len
;
434 buf_addr
+= period_len
;
437 desc
->num_sgs
= num_periods
;
438 desc
->direction
= direction
;
441 return vchan_tx_prep(&chan
->vchan
, &desc
->vdesc
, flags
);
444 static size_t jz4740_dma_desc_residue(struct jz4740_dmaengine_chan
*chan
,
445 struct jz4740_dma_desc
*desc
, unsigned int next_sg
)
447 struct jz4740_dma_dev
*dmadev
= jz4740_dma_chan_get_dev(chan
);
448 unsigned int residue
, count
;
453 for (i
= next_sg
; i
< desc
->num_sgs
; i
++)
454 residue
+= desc
->sg
[i
].len
;
457 count
= jz4740_dma_read(dmadev
,
458 JZ_REG_DMA_TRANSFER_COUNT(chan
->id
));
459 residue
+= count
<< chan
->transfer_shift
;
465 static enum dma_status
jz4740_dma_tx_status(struct dma_chan
*c
,
466 dma_cookie_t cookie
, struct dma_tx_state
*state
)
468 struct jz4740_dmaengine_chan
*chan
= to_jz4740_dma_chan(c
);
469 struct virt_dma_desc
*vdesc
;
470 enum dma_status status
;
473 status
= dma_cookie_status(c
, cookie
, state
);
474 if (status
== DMA_COMPLETE
|| !state
)
477 spin_lock_irqsave(&chan
->vchan
.lock
, flags
);
478 vdesc
= vchan_find_desc(&chan
->vchan
, cookie
);
479 if (cookie
== chan
->desc
->vdesc
.tx
.cookie
) {
480 state
->residue
= jz4740_dma_desc_residue(chan
, chan
->desc
,
483 state
->residue
= jz4740_dma_desc_residue(chan
,
484 to_jz4740_dma_desc(vdesc
), 0);
488 spin_unlock_irqrestore(&chan
->vchan
.lock
, flags
);
493 static void jz4740_dma_free_chan_resources(struct dma_chan
*c
)
495 vchan_free_chan_resources(to_virt_chan(c
));
498 static void jz4740_dma_desc_free(struct virt_dma_desc
*vdesc
)
500 kfree(container_of(vdesc
, struct jz4740_dma_desc
, vdesc
));
503 #define JZ4740_DMA_BUSWIDTHS (BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) | \
504 BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) | BIT(DMA_SLAVE_BUSWIDTH_4_BYTES))
506 static int jz4740_dma_probe(struct platform_device
*pdev
)
508 struct jz4740_dmaengine_chan
*chan
;
509 struct jz4740_dma_dev
*dmadev
;
510 struct dma_device
*dd
;
512 struct resource
*res
;
516 dmadev
= devm_kzalloc(&pdev
->dev
, sizeof(*dmadev
), GFP_KERNEL
);
522 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
523 dmadev
->base
= devm_ioremap_resource(&pdev
->dev
, res
);
524 if (IS_ERR(dmadev
->base
))
525 return PTR_ERR(dmadev
->base
);
527 dmadev
->clk
= clk_get(&pdev
->dev
, "dma");
528 if (IS_ERR(dmadev
->clk
))
529 return PTR_ERR(dmadev
->clk
);
531 clk_prepare_enable(dmadev
->clk
);
533 dma_cap_set(DMA_SLAVE
, dd
->cap_mask
);
534 dma_cap_set(DMA_CYCLIC
, dd
->cap_mask
);
535 dd
->device_free_chan_resources
= jz4740_dma_free_chan_resources
;
536 dd
->device_tx_status
= jz4740_dma_tx_status
;
537 dd
->device_issue_pending
= jz4740_dma_issue_pending
;
538 dd
->device_prep_slave_sg
= jz4740_dma_prep_slave_sg
;
539 dd
->device_prep_dma_cyclic
= jz4740_dma_prep_dma_cyclic
;
540 dd
->device_config
= jz4740_dma_slave_config
;
541 dd
->device_terminate_all
= jz4740_dma_terminate_all
;
542 dd
->src_addr_widths
= JZ4740_DMA_BUSWIDTHS
;
543 dd
->dst_addr_widths
= JZ4740_DMA_BUSWIDTHS
;
544 dd
->directions
= BIT(DMA_DEV_TO_MEM
) | BIT(DMA_MEM_TO_DEV
);
545 dd
->residue_granularity
= DMA_RESIDUE_GRANULARITY_BURST
;
546 dd
->dev
= &pdev
->dev
;
547 INIT_LIST_HEAD(&dd
->channels
);
549 for (i
= 0; i
< JZ_DMA_NR_CHANS
; i
++) {
550 chan
= &dmadev
->chan
[i
];
552 chan
->vchan
.desc_free
= jz4740_dma_desc_free
;
553 vchan_init(&chan
->vchan
, dd
);
556 ret
= dma_async_device_register(dd
);
560 irq
= platform_get_irq(pdev
, 0);
561 ret
= request_irq(irq
, jz4740_dma_irq
, 0, dev_name(&pdev
->dev
), dmadev
);
565 platform_set_drvdata(pdev
, dmadev
);
570 dma_async_device_unregister(dd
);
572 clk_disable_unprepare(dmadev
->clk
);
576 static void jz4740_cleanup_vchan(struct dma_device
*dmadev
)
578 struct jz4740_dmaengine_chan
*chan
, *_chan
;
580 list_for_each_entry_safe(chan
, _chan
,
581 &dmadev
->channels
, vchan
.chan
.device_node
) {
582 list_del(&chan
->vchan
.chan
.device_node
);
583 tasklet_kill(&chan
->vchan
.task
);
588 static int jz4740_dma_remove(struct platform_device
*pdev
)
590 struct jz4740_dma_dev
*dmadev
= platform_get_drvdata(pdev
);
591 int irq
= platform_get_irq(pdev
, 0);
593 free_irq(irq
, dmadev
);
595 jz4740_cleanup_vchan(&dmadev
->ddev
);
596 dma_async_device_unregister(&dmadev
->ddev
);
597 clk_disable_unprepare(dmadev
->clk
);
602 static struct platform_driver jz4740_dma_driver
= {
603 .probe
= jz4740_dma_probe
,
604 .remove
= jz4740_dma_remove
,
606 .name
= "jz4740-dma",
609 module_platform_driver(jz4740_dma_driver
);
611 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
612 MODULE_DESCRIPTION("JZ4740 DMA driver");
613 MODULE_LICENSE("GPL v2");