Merge tag 'regmap-fix-v5.11-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux/fpc-iii.git] / drivers / dma / xilinx / zynqmp_dma.c
blobd8419565b92ccda520202cb6a40ddab8e6c4717f
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * DMA driver for Xilinx ZynqMP DMA Engine
5 * Copyright (C) 2016 Xilinx, Inc. All rights reserved.
6 */
8 #include <linux/bitops.h>
9 #include <linux/dmapool.h>
10 #include <linux/dma/xilinx_dma.h>
11 #include <linux/init.h>
12 #include <linux/interrupt.h>
13 #include <linux/io.h>
14 #include <linux/module.h>
15 #include <linux/of_address.h>
16 #include <linux/of_dma.h>
17 #include <linux/of_irq.h>
18 #include <linux/of_platform.h>
19 #include <linux/slab.h>
20 #include <linux/clk.h>
21 #include <linux/io-64-nonatomic-lo-hi.h>
22 #include <linux/pm_runtime.h>
24 #include "../dmaengine.h"
26 /* Register Offsets */
27 #define ZYNQMP_DMA_ISR 0x100
28 #define ZYNQMP_DMA_IMR 0x104
29 #define ZYNQMP_DMA_IER 0x108
30 #define ZYNQMP_DMA_IDS 0x10C
31 #define ZYNQMP_DMA_CTRL0 0x110
32 #define ZYNQMP_DMA_CTRL1 0x114
33 #define ZYNQMP_DMA_DATA_ATTR 0x120
34 #define ZYNQMP_DMA_DSCR_ATTR 0x124
35 #define ZYNQMP_DMA_SRC_DSCR_WRD0 0x128
36 #define ZYNQMP_DMA_SRC_DSCR_WRD1 0x12C
37 #define ZYNQMP_DMA_SRC_DSCR_WRD2 0x130
38 #define ZYNQMP_DMA_SRC_DSCR_WRD3 0x134
39 #define ZYNQMP_DMA_DST_DSCR_WRD0 0x138
40 #define ZYNQMP_DMA_DST_DSCR_WRD1 0x13C
41 #define ZYNQMP_DMA_DST_DSCR_WRD2 0x140
42 #define ZYNQMP_DMA_DST_DSCR_WRD3 0x144
43 #define ZYNQMP_DMA_SRC_START_LSB 0x158
44 #define ZYNQMP_DMA_SRC_START_MSB 0x15C
45 #define ZYNQMP_DMA_DST_START_LSB 0x160
46 #define ZYNQMP_DMA_DST_START_MSB 0x164
47 #define ZYNQMP_DMA_TOTAL_BYTE 0x188
48 #define ZYNQMP_DMA_RATE_CTRL 0x18C
49 #define ZYNQMP_DMA_IRQ_SRC_ACCT 0x190
50 #define ZYNQMP_DMA_IRQ_DST_ACCT 0x194
51 #define ZYNQMP_DMA_CTRL2 0x200
53 /* Interrupt registers bit field definitions */
54 #define ZYNQMP_DMA_DONE BIT(10)
55 #define ZYNQMP_DMA_AXI_WR_DATA BIT(9)
56 #define ZYNQMP_DMA_AXI_RD_DATA BIT(8)
57 #define ZYNQMP_DMA_AXI_RD_DST_DSCR BIT(7)
58 #define ZYNQMP_DMA_AXI_RD_SRC_DSCR BIT(6)
59 #define ZYNQMP_DMA_IRQ_DST_ACCT_ERR BIT(5)
60 #define ZYNQMP_DMA_IRQ_SRC_ACCT_ERR BIT(4)
61 #define ZYNQMP_DMA_BYTE_CNT_OVRFL BIT(3)
62 #define ZYNQMP_DMA_DST_DSCR_DONE BIT(2)
63 #define ZYNQMP_DMA_INV_APB BIT(0)
65 /* Control 0 register bit field definitions */
66 #define ZYNQMP_DMA_OVR_FETCH BIT(7)
67 #define ZYNQMP_DMA_POINT_TYPE_SG BIT(6)
68 #define ZYNQMP_DMA_RATE_CTRL_EN BIT(3)
70 /* Control 1 register bit field definitions */
71 #define ZYNQMP_DMA_SRC_ISSUE GENMASK(4, 0)
73 /* Data Attribute register bit field definitions */
74 #define ZYNQMP_DMA_ARBURST GENMASK(27, 26)
75 #define ZYNQMP_DMA_ARCACHE GENMASK(25, 22)
76 #define ZYNQMP_DMA_ARCACHE_OFST 22
77 #define ZYNQMP_DMA_ARQOS GENMASK(21, 18)
78 #define ZYNQMP_DMA_ARQOS_OFST 18
79 #define ZYNQMP_DMA_ARLEN GENMASK(17, 14)
80 #define ZYNQMP_DMA_ARLEN_OFST 14
81 #define ZYNQMP_DMA_AWBURST GENMASK(13, 12)
82 #define ZYNQMP_DMA_AWCACHE GENMASK(11, 8)
83 #define ZYNQMP_DMA_AWCACHE_OFST 8
84 #define ZYNQMP_DMA_AWQOS GENMASK(7, 4)
85 #define ZYNQMP_DMA_AWQOS_OFST 4
86 #define ZYNQMP_DMA_AWLEN GENMASK(3, 0)
87 #define ZYNQMP_DMA_AWLEN_OFST 0
89 /* Descriptor Attribute register bit field definitions */
90 #define ZYNQMP_DMA_AXCOHRNT BIT(8)
91 #define ZYNQMP_DMA_AXCACHE GENMASK(7, 4)
92 #define ZYNQMP_DMA_AXCACHE_OFST 4
93 #define ZYNQMP_DMA_AXQOS GENMASK(3, 0)
94 #define ZYNQMP_DMA_AXQOS_OFST 0
96 /* Control register 2 bit field definitions */
97 #define ZYNQMP_DMA_ENABLE BIT(0)
99 /* Buffer Descriptor definitions */
100 #define ZYNQMP_DMA_DESC_CTRL_STOP 0x10
101 #define ZYNQMP_DMA_DESC_CTRL_COMP_INT 0x4
102 #define ZYNQMP_DMA_DESC_CTRL_SIZE_256 0x2
103 #define ZYNQMP_DMA_DESC_CTRL_COHRNT 0x1
105 /* Interrupt Mask specific definitions */
106 #define ZYNQMP_DMA_INT_ERR (ZYNQMP_DMA_AXI_RD_DATA | \
107 ZYNQMP_DMA_AXI_WR_DATA | \
108 ZYNQMP_DMA_AXI_RD_DST_DSCR | \
109 ZYNQMP_DMA_AXI_RD_SRC_DSCR | \
110 ZYNQMP_DMA_INV_APB)
111 #define ZYNQMP_DMA_INT_OVRFL (ZYNQMP_DMA_BYTE_CNT_OVRFL | \
112 ZYNQMP_DMA_IRQ_SRC_ACCT_ERR | \
113 ZYNQMP_DMA_IRQ_DST_ACCT_ERR)
114 #define ZYNQMP_DMA_INT_DONE (ZYNQMP_DMA_DONE | ZYNQMP_DMA_DST_DSCR_DONE)
115 #define ZYNQMP_DMA_INT_EN_DEFAULT_MASK (ZYNQMP_DMA_INT_DONE | \
116 ZYNQMP_DMA_INT_ERR | \
117 ZYNQMP_DMA_INT_OVRFL | \
118 ZYNQMP_DMA_DST_DSCR_DONE)
120 /* Max number of descriptors per channel */
121 #define ZYNQMP_DMA_NUM_DESCS 32
123 /* Max transfer size per descriptor */
124 #define ZYNQMP_DMA_MAX_TRANS_LEN 0x40000000
126 /* Max burst lengths */
127 #define ZYNQMP_DMA_MAX_DST_BURST_LEN 32768U
128 #define ZYNQMP_DMA_MAX_SRC_BURST_LEN 32768U
130 /* Reset values for data attributes */
131 #define ZYNQMP_DMA_AXCACHE_VAL 0xF
133 #define ZYNQMP_DMA_SRC_ISSUE_RST_VAL 0x1F
135 #define ZYNQMP_DMA_IDS_DEFAULT_MASK 0xFFF
137 /* Bus width in bits */
138 #define ZYNQMP_DMA_BUS_WIDTH_64 64
139 #define ZYNQMP_DMA_BUS_WIDTH_128 128
141 #define ZDMA_PM_TIMEOUT 100
143 #define ZYNQMP_DMA_DESC_SIZE(chan) (chan->desc_size)
145 #define to_chan(chan) container_of(chan, struct zynqmp_dma_chan, \
146 common)
147 #define tx_to_desc(tx) container_of(tx, struct zynqmp_dma_desc_sw, \
148 async_tx)
151 * struct zynqmp_dma_desc_ll - Hw linked list descriptor
152 * @addr: Buffer address
153 * @size: Size of the buffer
154 * @ctrl: Control word
155 * @nxtdscraddr: Next descriptor base address
156 * @rsvd: Reserved field and for Hw internal use.
158 struct zynqmp_dma_desc_ll {
159 u64 addr;
160 u32 size;
161 u32 ctrl;
162 u64 nxtdscraddr;
163 u64 rsvd;
167 * struct zynqmp_dma_desc_sw - Per Transaction structure
168 * @src: Source address for simple mode dma
169 * @dst: Destination address for simple mode dma
170 * @len: Transfer length for simple mode dma
171 * @node: Node in the channel descriptor list
172 * @tx_list: List head for the current transfer
173 * @async_tx: Async transaction descriptor
174 * @src_v: Virtual address of the src descriptor
175 * @src_p: Physical address of the src descriptor
176 * @dst_v: Virtual address of the dst descriptor
177 * @dst_p: Physical address of the dst descriptor
179 struct zynqmp_dma_desc_sw {
180 u64 src;
181 u64 dst;
182 u32 len;
183 struct list_head node;
184 struct list_head tx_list;
185 struct dma_async_tx_descriptor async_tx;
186 struct zynqmp_dma_desc_ll *src_v;
187 dma_addr_t src_p;
188 struct zynqmp_dma_desc_ll *dst_v;
189 dma_addr_t dst_p;
193 * struct zynqmp_dma_chan - Driver specific DMA channel structure
194 * @zdev: Driver specific device structure
195 * @regs: Control registers offset
196 * @lock: Descriptor operation lock
197 * @pending_list: Descriptors waiting
198 * @free_list: Descriptors free
199 * @active_list: Descriptors active
200 * @sw_desc_pool: SW descriptor pool
201 * @done_list: Complete descriptors
202 * @common: DMA common channel
203 * @desc_pool_v: Statically allocated descriptor base
204 * @desc_pool_p: Physical allocated descriptor base
205 * @desc_free_cnt: Descriptor available count
206 * @dev: The dma device
207 * @irq: Channel IRQ
208 * @is_dmacoherent: Tells whether dma operations are coherent or not
209 * @tasklet: Cleanup work after irq
210 * @idle : Channel status;
211 * @desc_size: Size of the low level descriptor
212 * @err: Channel has errors
213 * @bus_width: Bus width
214 * @src_burst_len: Source burst length
215 * @dst_burst_len: Dest burst length
217 struct zynqmp_dma_chan {
218 struct zynqmp_dma_device *zdev;
219 void __iomem *regs;
220 spinlock_t lock;
221 struct list_head pending_list;
222 struct list_head free_list;
223 struct list_head active_list;
224 struct zynqmp_dma_desc_sw *sw_desc_pool;
225 struct list_head done_list;
226 struct dma_chan common;
227 void *desc_pool_v;
228 dma_addr_t desc_pool_p;
229 u32 desc_free_cnt;
230 struct device *dev;
231 int irq;
232 bool is_dmacoherent;
233 struct tasklet_struct tasklet;
234 bool idle;
235 u32 desc_size;
236 bool err;
237 u32 bus_width;
238 u32 src_burst_len;
239 u32 dst_burst_len;
243 * struct zynqmp_dma_device - DMA device structure
244 * @dev: Device Structure
245 * @common: DMA device structure
246 * @chan: Driver specific DMA channel
247 * @clk_main: Pointer to main clock
248 * @clk_apb: Pointer to apb clock
250 struct zynqmp_dma_device {
251 struct device *dev;
252 struct dma_device common;
253 struct zynqmp_dma_chan *chan;
254 struct clk *clk_main;
255 struct clk *clk_apb;
258 static inline void zynqmp_dma_writeq(struct zynqmp_dma_chan *chan, u32 reg,
259 u64 value)
261 lo_hi_writeq(value, chan->regs + reg);
265 * zynqmp_dma_update_desc_to_ctrlr - Updates descriptor to the controller
266 * @chan: ZynqMP DMA DMA channel pointer
267 * @desc: Transaction descriptor pointer
269 static void zynqmp_dma_update_desc_to_ctrlr(struct zynqmp_dma_chan *chan,
270 struct zynqmp_dma_desc_sw *desc)
272 dma_addr_t addr;
274 addr = desc->src_p;
275 zynqmp_dma_writeq(chan, ZYNQMP_DMA_SRC_START_LSB, addr);
276 addr = desc->dst_p;
277 zynqmp_dma_writeq(chan, ZYNQMP_DMA_DST_START_LSB, addr);
281 * zynqmp_dma_desc_config_eod - Mark the descriptor as end descriptor
282 * @chan: ZynqMP DMA channel pointer
283 * @desc: Hw descriptor pointer
285 static void zynqmp_dma_desc_config_eod(struct zynqmp_dma_chan *chan,
286 void *desc)
288 struct zynqmp_dma_desc_ll *hw = (struct zynqmp_dma_desc_ll *)desc;
290 hw->ctrl |= ZYNQMP_DMA_DESC_CTRL_STOP;
291 hw++;
292 hw->ctrl |= ZYNQMP_DMA_DESC_CTRL_COMP_INT | ZYNQMP_DMA_DESC_CTRL_STOP;
296 * zynqmp_dma_config_sg_ll_desc - Configure the linked list descriptor
297 * @chan: ZynqMP DMA channel pointer
298 * @sdesc: Hw descriptor pointer
299 * @src: Source buffer address
300 * @dst: Destination buffer address
301 * @len: Transfer length
302 * @prev: Previous hw descriptor pointer
304 static void zynqmp_dma_config_sg_ll_desc(struct zynqmp_dma_chan *chan,
305 struct zynqmp_dma_desc_ll *sdesc,
306 dma_addr_t src, dma_addr_t dst, size_t len,
307 struct zynqmp_dma_desc_ll *prev)
309 struct zynqmp_dma_desc_ll *ddesc = sdesc + 1;
311 sdesc->size = ddesc->size = len;
312 sdesc->addr = src;
313 ddesc->addr = dst;
315 sdesc->ctrl = ddesc->ctrl = ZYNQMP_DMA_DESC_CTRL_SIZE_256;
316 if (chan->is_dmacoherent) {
317 sdesc->ctrl |= ZYNQMP_DMA_DESC_CTRL_COHRNT;
318 ddesc->ctrl |= ZYNQMP_DMA_DESC_CTRL_COHRNT;
321 if (prev) {
322 dma_addr_t addr = chan->desc_pool_p +
323 ((uintptr_t)sdesc - (uintptr_t)chan->desc_pool_v);
324 ddesc = prev + 1;
325 prev->nxtdscraddr = addr;
326 ddesc->nxtdscraddr = addr + ZYNQMP_DMA_DESC_SIZE(chan);
331 * zynqmp_dma_init - Initialize the channel
332 * @chan: ZynqMP DMA channel pointer
334 static void zynqmp_dma_init(struct zynqmp_dma_chan *chan)
336 u32 val;
338 writel(ZYNQMP_DMA_IDS_DEFAULT_MASK, chan->regs + ZYNQMP_DMA_IDS);
339 val = readl(chan->regs + ZYNQMP_DMA_ISR);
340 writel(val, chan->regs + ZYNQMP_DMA_ISR);
342 if (chan->is_dmacoherent) {
343 val = ZYNQMP_DMA_AXCOHRNT;
344 val = (val & ~ZYNQMP_DMA_AXCACHE) |
345 (ZYNQMP_DMA_AXCACHE_VAL << ZYNQMP_DMA_AXCACHE_OFST);
346 writel(val, chan->regs + ZYNQMP_DMA_DSCR_ATTR);
349 val = readl(chan->regs + ZYNQMP_DMA_DATA_ATTR);
350 if (chan->is_dmacoherent) {
351 val = (val & ~ZYNQMP_DMA_ARCACHE) |
352 (ZYNQMP_DMA_AXCACHE_VAL << ZYNQMP_DMA_ARCACHE_OFST);
353 val = (val & ~ZYNQMP_DMA_AWCACHE) |
354 (ZYNQMP_DMA_AXCACHE_VAL << ZYNQMP_DMA_AWCACHE_OFST);
356 writel(val, chan->regs + ZYNQMP_DMA_DATA_ATTR);
358 /* Clearing the interrupt account rgisters */
359 val = readl(chan->regs + ZYNQMP_DMA_IRQ_SRC_ACCT);
360 val = readl(chan->regs + ZYNQMP_DMA_IRQ_DST_ACCT);
362 chan->idle = true;
366 * zynqmp_dma_tx_submit - Submit DMA transaction
367 * @tx: Async transaction descriptor pointer
369 * Return: cookie value
371 static dma_cookie_t zynqmp_dma_tx_submit(struct dma_async_tx_descriptor *tx)
373 struct zynqmp_dma_chan *chan = to_chan(tx->chan);
374 struct zynqmp_dma_desc_sw *desc, *new;
375 dma_cookie_t cookie;
376 unsigned long irqflags;
378 new = tx_to_desc(tx);
379 spin_lock_irqsave(&chan->lock, irqflags);
380 cookie = dma_cookie_assign(tx);
382 if (!list_empty(&chan->pending_list)) {
383 desc = list_last_entry(&chan->pending_list,
384 struct zynqmp_dma_desc_sw, node);
385 if (!list_empty(&desc->tx_list))
386 desc = list_last_entry(&desc->tx_list,
387 struct zynqmp_dma_desc_sw, node);
388 desc->src_v->nxtdscraddr = new->src_p;
389 desc->src_v->ctrl &= ~ZYNQMP_DMA_DESC_CTRL_STOP;
390 desc->dst_v->nxtdscraddr = new->dst_p;
391 desc->dst_v->ctrl &= ~ZYNQMP_DMA_DESC_CTRL_STOP;
394 list_add_tail(&new->node, &chan->pending_list);
395 spin_unlock_irqrestore(&chan->lock, irqflags);
397 return cookie;
401 * zynqmp_dma_get_descriptor - Get the sw descriptor from the pool
402 * @chan: ZynqMP DMA channel pointer
404 * Return: The sw descriptor
406 static struct zynqmp_dma_desc_sw *
407 zynqmp_dma_get_descriptor(struct zynqmp_dma_chan *chan)
409 struct zynqmp_dma_desc_sw *desc;
410 unsigned long irqflags;
412 spin_lock_irqsave(&chan->lock, irqflags);
413 desc = list_first_entry(&chan->free_list,
414 struct zynqmp_dma_desc_sw, node);
415 list_del(&desc->node);
416 spin_unlock_irqrestore(&chan->lock, irqflags);
418 INIT_LIST_HEAD(&desc->tx_list);
419 /* Clear the src and dst descriptor memory */
420 memset((void *)desc->src_v, 0, ZYNQMP_DMA_DESC_SIZE(chan));
421 memset((void *)desc->dst_v, 0, ZYNQMP_DMA_DESC_SIZE(chan));
423 return desc;
427 * zynqmp_dma_free_descriptor - Issue pending transactions
428 * @chan: ZynqMP DMA channel pointer
429 * @sdesc: Transaction descriptor pointer
431 static void zynqmp_dma_free_descriptor(struct zynqmp_dma_chan *chan,
432 struct zynqmp_dma_desc_sw *sdesc)
434 struct zynqmp_dma_desc_sw *child, *next;
436 chan->desc_free_cnt++;
437 list_del(&sdesc->node);
438 list_add_tail(&sdesc->node, &chan->free_list);
439 list_for_each_entry_safe(child, next, &sdesc->tx_list, node) {
440 chan->desc_free_cnt++;
441 list_move_tail(&child->node, &chan->free_list);
446 * zynqmp_dma_free_desc_list - Free descriptors list
447 * @chan: ZynqMP DMA channel pointer
448 * @list: List to parse and delete the descriptor
450 static void zynqmp_dma_free_desc_list(struct zynqmp_dma_chan *chan,
451 struct list_head *list)
453 struct zynqmp_dma_desc_sw *desc, *next;
455 list_for_each_entry_safe(desc, next, list, node)
456 zynqmp_dma_free_descriptor(chan, desc);
460 * zynqmp_dma_alloc_chan_resources - Allocate channel resources
461 * @dchan: DMA channel
463 * Return: Number of descriptors on success and failure value on error
465 static int zynqmp_dma_alloc_chan_resources(struct dma_chan *dchan)
467 struct zynqmp_dma_chan *chan = to_chan(dchan);
468 struct zynqmp_dma_desc_sw *desc;
469 int i, ret;
471 ret = pm_runtime_get_sync(chan->dev);
472 if (ret < 0)
473 return ret;
475 chan->sw_desc_pool = kcalloc(ZYNQMP_DMA_NUM_DESCS, sizeof(*desc),
476 GFP_KERNEL);
477 if (!chan->sw_desc_pool)
478 return -ENOMEM;
480 chan->idle = true;
481 chan->desc_free_cnt = ZYNQMP_DMA_NUM_DESCS;
483 INIT_LIST_HEAD(&chan->free_list);
485 for (i = 0; i < ZYNQMP_DMA_NUM_DESCS; i++) {
486 desc = chan->sw_desc_pool + i;
487 dma_async_tx_descriptor_init(&desc->async_tx, &chan->common);
488 desc->async_tx.tx_submit = zynqmp_dma_tx_submit;
489 list_add_tail(&desc->node, &chan->free_list);
492 chan->desc_pool_v = dma_alloc_coherent(chan->dev,
493 (2 * chan->desc_size * ZYNQMP_DMA_NUM_DESCS),
494 &chan->desc_pool_p, GFP_KERNEL);
495 if (!chan->desc_pool_v)
496 return -ENOMEM;
498 for (i = 0; i < ZYNQMP_DMA_NUM_DESCS; i++) {
499 desc = chan->sw_desc_pool + i;
500 desc->src_v = (struct zynqmp_dma_desc_ll *) (chan->desc_pool_v +
501 (i * ZYNQMP_DMA_DESC_SIZE(chan) * 2));
502 desc->dst_v = (struct zynqmp_dma_desc_ll *) (desc->src_v + 1);
503 desc->src_p = chan->desc_pool_p +
504 (i * ZYNQMP_DMA_DESC_SIZE(chan) * 2);
505 desc->dst_p = desc->src_p + ZYNQMP_DMA_DESC_SIZE(chan);
508 return ZYNQMP_DMA_NUM_DESCS;
512 * zynqmp_dma_start - Start DMA channel
513 * @chan: ZynqMP DMA channel pointer
515 static void zynqmp_dma_start(struct zynqmp_dma_chan *chan)
517 writel(ZYNQMP_DMA_INT_EN_DEFAULT_MASK, chan->regs + ZYNQMP_DMA_IER);
518 writel(0, chan->regs + ZYNQMP_DMA_TOTAL_BYTE);
519 chan->idle = false;
520 writel(ZYNQMP_DMA_ENABLE, chan->regs + ZYNQMP_DMA_CTRL2);
524 * zynqmp_dma_handle_ovfl_int - Process the overflow interrupt
525 * @chan: ZynqMP DMA channel pointer
526 * @status: Interrupt status value
528 static void zynqmp_dma_handle_ovfl_int(struct zynqmp_dma_chan *chan, u32 status)
530 if (status & ZYNQMP_DMA_BYTE_CNT_OVRFL)
531 writel(0, chan->regs + ZYNQMP_DMA_TOTAL_BYTE);
532 if (status & ZYNQMP_DMA_IRQ_DST_ACCT_ERR)
533 readl(chan->regs + ZYNQMP_DMA_IRQ_DST_ACCT);
534 if (status & ZYNQMP_DMA_IRQ_SRC_ACCT_ERR)
535 readl(chan->regs + ZYNQMP_DMA_IRQ_SRC_ACCT);
538 static void zynqmp_dma_config(struct zynqmp_dma_chan *chan)
540 u32 val, burst_val;
542 val = readl(chan->regs + ZYNQMP_DMA_CTRL0);
543 val |= ZYNQMP_DMA_POINT_TYPE_SG;
544 writel(val, chan->regs + ZYNQMP_DMA_CTRL0);
546 val = readl(chan->regs + ZYNQMP_DMA_DATA_ATTR);
547 burst_val = __ilog2_u32(chan->src_burst_len);
548 val = (val & ~ZYNQMP_DMA_ARLEN) |
549 ((burst_val << ZYNQMP_DMA_ARLEN_OFST) & ZYNQMP_DMA_ARLEN);
550 burst_val = __ilog2_u32(chan->dst_burst_len);
551 val = (val & ~ZYNQMP_DMA_AWLEN) |
552 ((burst_val << ZYNQMP_DMA_AWLEN_OFST) & ZYNQMP_DMA_AWLEN);
553 writel(val, chan->regs + ZYNQMP_DMA_DATA_ATTR);
557 * zynqmp_dma_device_config - Zynqmp dma device configuration
558 * @dchan: DMA channel
559 * @config: DMA device config
561 * Return: 0 always
563 static int zynqmp_dma_device_config(struct dma_chan *dchan,
564 struct dma_slave_config *config)
566 struct zynqmp_dma_chan *chan = to_chan(dchan);
568 chan->src_burst_len = clamp(config->src_maxburst, 1U,
569 ZYNQMP_DMA_MAX_SRC_BURST_LEN);
570 chan->dst_burst_len = clamp(config->dst_maxburst, 1U,
571 ZYNQMP_DMA_MAX_DST_BURST_LEN);
573 return 0;
577 * zynqmp_dma_start_transfer - Initiate the new transfer
578 * @chan: ZynqMP DMA channel pointer
580 static void zynqmp_dma_start_transfer(struct zynqmp_dma_chan *chan)
582 struct zynqmp_dma_desc_sw *desc;
584 if (!chan->idle)
585 return;
587 zynqmp_dma_config(chan);
589 desc = list_first_entry_or_null(&chan->pending_list,
590 struct zynqmp_dma_desc_sw, node);
591 if (!desc)
592 return;
594 list_splice_tail_init(&chan->pending_list, &chan->active_list);
595 zynqmp_dma_update_desc_to_ctrlr(chan, desc);
596 zynqmp_dma_start(chan);
601 * zynqmp_dma_chan_desc_cleanup - Cleanup the completed descriptors
602 * @chan: ZynqMP DMA channel
604 static void zynqmp_dma_chan_desc_cleanup(struct zynqmp_dma_chan *chan)
606 struct zynqmp_dma_desc_sw *desc, *next;
608 list_for_each_entry_safe(desc, next, &chan->done_list, node) {
609 dma_async_tx_callback callback;
610 void *callback_param;
612 callback = desc->async_tx.callback;
613 callback_param = desc->async_tx.callback_param;
614 if (callback) {
615 spin_unlock(&chan->lock);
616 callback(callback_param);
617 spin_lock(&chan->lock);
620 /* Run any dependencies, then free the descriptor */
621 zynqmp_dma_free_descriptor(chan, desc);
626 * zynqmp_dma_complete_descriptor - Mark the active descriptor as complete
627 * @chan: ZynqMP DMA channel pointer
629 static void zynqmp_dma_complete_descriptor(struct zynqmp_dma_chan *chan)
631 struct zynqmp_dma_desc_sw *desc;
633 desc = list_first_entry_or_null(&chan->active_list,
634 struct zynqmp_dma_desc_sw, node);
635 if (!desc)
636 return;
637 list_del(&desc->node);
638 dma_cookie_complete(&desc->async_tx);
639 list_add_tail(&desc->node, &chan->done_list);
643 * zynqmp_dma_issue_pending - Issue pending transactions
644 * @dchan: DMA channel pointer
646 static void zynqmp_dma_issue_pending(struct dma_chan *dchan)
648 struct zynqmp_dma_chan *chan = to_chan(dchan);
649 unsigned long irqflags;
651 spin_lock_irqsave(&chan->lock, irqflags);
652 zynqmp_dma_start_transfer(chan);
653 spin_unlock_irqrestore(&chan->lock, irqflags);
657 * zynqmp_dma_free_descriptors - Free channel descriptors
658 * @chan: ZynqMP DMA channel pointer
660 static void zynqmp_dma_free_descriptors(struct zynqmp_dma_chan *chan)
662 zynqmp_dma_free_desc_list(chan, &chan->active_list);
663 zynqmp_dma_free_desc_list(chan, &chan->pending_list);
664 zynqmp_dma_free_desc_list(chan, &chan->done_list);
668 * zynqmp_dma_free_chan_resources - Free channel resources
669 * @dchan: DMA channel pointer
671 static void zynqmp_dma_free_chan_resources(struct dma_chan *dchan)
673 struct zynqmp_dma_chan *chan = to_chan(dchan);
674 unsigned long irqflags;
676 spin_lock_irqsave(&chan->lock, irqflags);
677 zynqmp_dma_free_descriptors(chan);
678 spin_unlock_irqrestore(&chan->lock, irqflags);
679 dma_free_coherent(chan->dev,
680 (2 * ZYNQMP_DMA_DESC_SIZE(chan) * ZYNQMP_DMA_NUM_DESCS),
681 chan->desc_pool_v, chan->desc_pool_p);
682 kfree(chan->sw_desc_pool);
683 pm_runtime_mark_last_busy(chan->dev);
684 pm_runtime_put_autosuspend(chan->dev);
688 * zynqmp_dma_reset - Reset the channel
689 * @chan: ZynqMP DMA channel pointer
691 static void zynqmp_dma_reset(struct zynqmp_dma_chan *chan)
693 writel(ZYNQMP_DMA_IDS_DEFAULT_MASK, chan->regs + ZYNQMP_DMA_IDS);
695 zynqmp_dma_complete_descriptor(chan);
696 zynqmp_dma_chan_desc_cleanup(chan);
697 zynqmp_dma_free_descriptors(chan);
698 zynqmp_dma_init(chan);
702 * zynqmp_dma_irq_handler - ZynqMP DMA Interrupt handler
703 * @irq: IRQ number
704 * @data: Pointer to the ZynqMP DMA channel structure
706 * Return: IRQ_HANDLED/IRQ_NONE
708 static irqreturn_t zynqmp_dma_irq_handler(int irq, void *data)
710 struct zynqmp_dma_chan *chan = (struct zynqmp_dma_chan *)data;
711 u32 isr, imr, status;
712 irqreturn_t ret = IRQ_NONE;
714 isr = readl(chan->regs + ZYNQMP_DMA_ISR);
715 imr = readl(chan->regs + ZYNQMP_DMA_IMR);
716 status = isr & ~imr;
718 writel(isr, chan->regs + ZYNQMP_DMA_ISR);
719 if (status & ZYNQMP_DMA_INT_DONE) {
720 tasklet_schedule(&chan->tasklet);
721 ret = IRQ_HANDLED;
724 if (status & ZYNQMP_DMA_DONE)
725 chan->idle = true;
727 if (status & ZYNQMP_DMA_INT_ERR) {
728 chan->err = true;
729 tasklet_schedule(&chan->tasklet);
730 dev_err(chan->dev, "Channel %p has errors\n", chan);
731 ret = IRQ_HANDLED;
734 if (status & ZYNQMP_DMA_INT_OVRFL) {
735 zynqmp_dma_handle_ovfl_int(chan, status);
736 dev_dbg(chan->dev, "Channel %p overflow interrupt\n", chan);
737 ret = IRQ_HANDLED;
740 return ret;
744 * zynqmp_dma_do_tasklet - Schedule completion tasklet
745 * @t: Pointer to the ZynqMP DMA channel structure
747 static void zynqmp_dma_do_tasklet(struct tasklet_struct *t)
749 struct zynqmp_dma_chan *chan = from_tasklet(chan, t, tasklet);
750 u32 count;
751 unsigned long irqflags;
753 spin_lock_irqsave(&chan->lock, irqflags);
755 if (chan->err) {
756 zynqmp_dma_reset(chan);
757 chan->err = false;
758 goto unlock;
761 count = readl(chan->regs + ZYNQMP_DMA_IRQ_DST_ACCT);
763 while (count) {
764 zynqmp_dma_complete_descriptor(chan);
765 zynqmp_dma_chan_desc_cleanup(chan);
766 count--;
769 if (chan->idle)
770 zynqmp_dma_start_transfer(chan);
772 unlock:
773 spin_unlock_irqrestore(&chan->lock, irqflags);
777 * zynqmp_dma_device_terminate_all - Aborts all transfers on a channel
778 * @dchan: DMA channel pointer
780 * Return: Always '0'
782 static int zynqmp_dma_device_terminate_all(struct dma_chan *dchan)
784 struct zynqmp_dma_chan *chan = to_chan(dchan);
785 unsigned long irqflags;
787 spin_lock_irqsave(&chan->lock, irqflags);
788 writel(ZYNQMP_DMA_IDS_DEFAULT_MASK, chan->regs + ZYNQMP_DMA_IDS);
789 zynqmp_dma_free_descriptors(chan);
790 spin_unlock_irqrestore(&chan->lock, irqflags);
792 return 0;
796 * zynqmp_dma_prep_memcpy - prepare descriptors for memcpy transaction
797 * @dchan: DMA channel
798 * @dma_dst: Destination buffer address
799 * @dma_src: Source buffer address
800 * @len: Transfer length
801 * @flags: transfer ack flags
803 * Return: Async transaction descriptor on success and NULL on failure
805 static struct dma_async_tx_descriptor *zynqmp_dma_prep_memcpy(
806 struct dma_chan *dchan, dma_addr_t dma_dst,
807 dma_addr_t dma_src, size_t len, ulong flags)
809 struct zynqmp_dma_chan *chan;
810 struct zynqmp_dma_desc_sw *new, *first = NULL;
811 void *desc = NULL, *prev = NULL;
812 size_t copy;
813 u32 desc_cnt;
814 unsigned long irqflags;
816 chan = to_chan(dchan);
818 desc_cnt = DIV_ROUND_UP(len, ZYNQMP_DMA_MAX_TRANS_LEN);
820 spin_lock_irqsave(&chan->lock, irqflags);
821 if (desc_cnt > chan->desc_free_cnt) {
822 spin_unlock_irqrestore(&chan->lock, irqflags);
823 dev_dbg(chan->dev, "chan %p descs are not available\n", chan);
824 return NULL;
826 chan->desc_free_cnt = chan->desc_free_cnt - desc_cnt;
827 spin_unlock_irqrestore(&chan->lock, irqflags);
829 do {
830 /* Allocate and populate the descriptor */
831 new = zynqmp_dma_get_descriptor(chan);
833 copy = min_t(size_t, len, ZYNQMP_DMA_MAX_TRANS_LEN);
834 desc = (struct zynqmp_dma_desc_ll *)new->src_v;
835 zynqmp_dma_config_sg_ll_desc(chan, desc, dma_src,
836 dma_dst, copy, prev);
837 prev = desc;
838 len -= copy;
839 dma_src += copy;
840 dma_dst += copy;
841 if (!first)
842 first = new;
843 else
844 list_add_tail(&new->node, &first->tx_list);
845 } while (len);
847 zynqmp_dma_desc_config_eod(chan, desc);
848 async_tx_ack(&first->async_tx);
849 first->async_tx.flags = flags;
850 return &first->async_tx;
854 * zynqmp_dma_chan_remove - Channel remove function
855 * @chan: ZynqMP DMA channel pointer
857 static void zynqmp_dma_chan_remove(struct zynqmp_dma_chan *chan)
859 if (!chan)
860 return;
862 if (chan->irq)
863 devm_free_irq(chan->zdev->dev, chan->irq, chan);
864 tasklet_kill(&chan->tasklet);
865 list_del(&chan->common.device_node);
869 * zynqmp_dma_chan_probe - Per Channel Probing
870 * @zdev: Driver specific device structure
871 * @pdev: Pointer to the platform_device structure
873 * Return: '0' on success and failure value on error
875 static int zynqmp_dma_chan_probe(struct zynqmp_dma_device *zdev,
876 struct platform_device *pdev)
878 struct zynqmp_dma_chan *chan;
879 struct resource *res;
880 struct device_node *node = pdev->dev.of_node;
881 int err;
883 chan = devm_kzalloc(zdev->dev, sizeof(*chan), GFP_KERNEL);
884 if (!chan)
885 return -ENOMEM;
886 chan->dev = zdev->dev;
887 chan->zdev = zdev;
889 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
890 chan->regs = devm_ioremap_resource(&pdev->dev, res);
891 if (IS_ERR(chan->regs))
892 return PTR_ERR(chan->regs);
894 chan->bus_width = ZYNQMP_DMA_BUS_WIDTH_64;
895 chan->dst_burst_len = ZYNQMP_DMA_MAX_DST_BURST_LEN;
896 chan->src_burst_len = ZYNQMP_DMA_MAX_SRC_BURST_LEN;
897 err = of_property_read_u32(node, "xlnx,bus-width", &chan->bus_width);
898 if (err < 0) {
899 dev_err(&pdev->dev, "missing xlnx,bus-width property\n");
900 return err;
903 if (chan->bus_width != ZYNQMP_DMA_BUS_WIDTH_64 &&
904 chan->bus_width != ZYNQMP_DMA_BUS_WIDTH_128) {
905 dev_err(zdev->dev, "invalid bus-width value");
906 return -EINVAL;
909 chan->is_dmacoherent = of_property_read_bool(node, "dma-coherent");
910 zdev->chan = chan;
911 tasklet_setup(&chan->tasklet, zynqmp_dma_do_tasklet);
912 spin_lock_init(&chan->lock);
913 INIT_LIST_HEAD(&chan->active_list);
914 INIT_LIST_HEAD(&chan->pending_list);
915 INIT_LIST_HEAD(&chan->done_list);
916 INIT_LIST_HEAD(&chan->free_list);
918 dma_cookie_init(&chan->common);
919 chan->common.device = &zdev->common;
920 list_add_tail(&chan->common.device_node, &zdev->common.channels);
922 zynqmp_dma_init(chan);
923 chan->irq = platform_get_irq(pdev, 0);
924 if (chan->irq < 0)
925 return -ENXIO;
926 err = devm_request_irq(&pdev->dev, chan->irq, zynqmp_dma_irq_handler, 0,
927 "zynqmp-dma", chan);
928 if (err)
929 return err;
931 chan->desc_size = sizeof(struct zynqmp_dma_desc_ll);
932 chan->idle = true;
933 return 0;
937 * of_zynqmp_dma_xlate - Translation function
938 * @dma_spec: Pointer to DMA specifier as found in the device tree
939 * @ofdma: Pointer to DMA controller data
941 * Return: DMA channel pointer on success and NULL on error
943 static struct dma_chan *of_zynqmp_dma_xlate(struct of_phandle_args *dma_spec,
944 struct of_dma *ofdma)
946 struct zynqmp_dma_device *zdev = ofdma->of_dma_data;
948 return dma_get_slave_channel(&zdev->chan->common);
952 * zynqmp_dma_suspend - Suspend method for the driver
953 * @dev: Address of the device structure
955 * Put the driver into low power mode.
956 * Return: 0 on success and failure value on error
958 static int __maybe_unused zynqmp_dma_suspend(struct device *dev)
960 if (!device_may_wakeup(dev))
961 return pm_runtime_force_suspend(dev);
963 return 0;
967 * zynqmp_dma_resume - Resume from suspend
968 * @dev: Address of the device structure
970 * Resume operation after suspend.
971 * Return: 0 on success and failure value on error
973 static int __maybe_unused zynqmp_dma_resume(struct device *dev)
975 if (!device_may_wakeup(dev))
976 return pm_runtime_force_resume(dev);
978 return 0;
982 * zynqmp_dma_runtime_suspend - Runtime suspend method for the driver
983 * @dev: Address of the device structure
985 * Put the driver into low power mode.
986 * Return: 0 always
988 static int __maybe_unused zynqmp_dma_runtime_suspend(struct device *dev)
990 struct zynqmp_dma_device *zdev = dev_get_drvdata(dev);
992 clk_disable_unprepare(zdev->clk_main);
993 clk_disable_unprepare(zdev->clk_apb);
995 return 0;
999 * zynqmp_dma_runtime_resume - Runtime suspend method for the driver
1000 * @dev: Address of the device structure
1002 * Put the driver into low power mode.
1003 * Return: 0 always
1005 static int __maybe_unused zynqmp_dma_runtime_resume(struct device *dev)
1007 struct zynqmp_dma_device *zdev = dev_get_drvdata(dev);
1008 int err;
1010 err = clk_prepare_enable(zdev->clk_main);
1011 if (err) {
1012 dev_err(dev, "Unable to enable main clock.\n");
1013 return err;
1016 err = clk_prepare_enable(zdev->clk_apb);
1017 if (err) {
1018 dev_err(dev, "Unable to enable apb clock.\n");
1019 clk_disable_unprepare(zdev->clk_main);
1020 return err;
1023 return 0;
1026 static const struct dev_pm_ops zynqmp_dma_dev_pm_ops = {
1027 SET_SYSTEM_SLEEP_PM_OPS(zynqmp_dma_suspend, zynqmp_dma_resume)
1028 SET_RUNTIME_PM_OPS(zynqmp_dma_runtime_suspend,
1029 zynqmp_dma_runtime_resume, NULL)
1033 * zynqmp_dma_probe - Driver probe function
1034 * @pdev: Pointer to the platform_device structure
1036 * Return: '0' on success and failure value on error
1038 static int zynqmp_dma_probe(struct platform_device *pdev)
1040 struct zynqmp_dma_device *zdev;
1041 struct dma_device *p;
1042 int ret;
1044 zdev = devm_kzalloc(&pdev->dev, sizeof(*zdev), GFP_KERNEL);
1045 if (!zdev)
1046 return -ENOMEM;
1048 zdev->dev = &pdev->dev;
1049 INIT_LIST_HEAD(&zdev->common.channels);
1051 dma_set_mask(&pdev->dev, DMA_BIT_MASK(44));
1052 dma_cap_set(DMA_MEMCPY, zdev->common.cap_mask);
1054 p = &zdev->common;
1055 p->device_prep_dma_memcpy = zynqmp_dma_prep_memcpy;
1056 p->device_terminate_all = zynqmp_dma_device_terminate_all;
1057 p->device_issue_pending = zynqmp_dma_issue_pending;
1058 p->device_alloc_chan_resources = zynqmp_dma_alloc_chan_resources;
1059 p->device_free_chan_resources = zynqmp_dma_free_chan_resources;
1060 p->device_tx_status = dma_cookie_status;
1061 p->device_config = zynqmp_dma_device_config;
1062 p->dev = &pdev->dev;
1064 zdev->clk_main = devm_clk_get(&pdev->dev, "clk_main");
1065 if (IS_ERR(zdev->clk_main)) {
1066 dev_err(&pdev->dev, "main clock not found.\n");
1067 return PTR_ERR(zdev->clk_main);
1070 zdev->clk_apb = devm_clk_get(&pdev->dev, "clk_apb");
1071 if (IS_ERR(zdev->clk_apb)) {
1072 dev_err(&pdev->dev, "apb clock not found.\n");
1073 return PTR_ERR(zdev->clk_apb);
1076 platform_set_drvdata(pdev, zdev);
1077 pm_runtime_set_autosuspend_delay(zdev->dev, ZDMA_PM_TIMEOUT);
1078 pm_runtime_use_autosuspend(zdev->dev);
1079 pm_runtime_enable(zdev->dev);
1080 pm_runtime_get_sync(zdev->dev);
1081 if (!pm_runtime_enabled(zdev->dev)) {
1082 ret = zynqmp_dma_runtime_resume(zdev->dev);
1083 if (ret)
1084 return ret;
1087 ret = zynqmp_dma_chan_probe(zdev, pdev);
1088 if (ret) {
1089 dev_err(&pdev->dev, "Probing channel failed\n");
1090 goto err_disable_pm;
1093 p->dst_addr_widths = BIT(zdev->chan->bus_width / 8);
1094 p->src_addr_widths = BIT(zdev->chan->bus_width / 8);
1096 dma_async_device_register(&zdev->common);
1098 ret = of_dma_controller_register(pdev->dev.of_node,
1099 of_zynqmp_dma_xlate, zdev);
1100 if (ret) {
1101 dev_err(&pdev->dev, "Unable to register DMA to DT\n");
1102 dma_async_device_unregister(&zdev->common);
1103 goto free_chan_resources;
1106 pm_runtime_mark_last_busy(zdev->dev);
1107 pm_runtime_put_sync_autosuspend(zdev->dev);
1109 dev_info(&pdev->dev, "ZynqMP DMA driver Probe success\n");
1111 return 0;
1113 free_chan_resources:
1114 zynqmp_dma_chan_remove(zdev->chan);
1115 err_disable_pm:
1116 if (!pm_runtime_enabled(zdev->dev))
1117 zynqmp_dma_runtime_suspend(zdev->dev);
1118 pm_runtime_disable(zdev->dev);
1119 return ret;
1123 * zynqmp_dma_remove - Driver remove function
1124 * @pdev: Pointer to the platform_device structure
1126 * Return: Always '0'
1128 static int zynqmp_dma_remove(struct platform_device *pdev)
1130 struct zynqmp_dma_device *zdev = platform_get_drvdata(pdev);
1132 of_dma_controller_free(pdev->dev.of_node);
1133 dma_async_device_unregister(&zdev->common);
1135 zynqmp_dma_chan_remove(zdev->chan);
1136 pm_runtime_disable(zdev->dev);
1137 if (!pm_runtime_enabled(zdev->dev))
1138 zynqmp_dma_runtime_suspend(zdev->dev);
1140 return 0;
1143 static const struct of_device_id zynqmp_dma_of_match[] = {
1144 { .compatible = "xlnx,zynqmp-dma-1.0", },
1147 MODULE_DEVICE_TABLE(of, zynqmp_dma_of_match);
1149 static struct platform_driver zynqmp_dma_driver = {
1150 .driver = {
1151 .name = "xilinx-zynqmp-dma",
1152 .of_match_table = zynqmp_dma_of_match,
1153 .pm = &zynqmp_dma_dev_pm_ops,
1155 .probe = zynqmp_dma_probe,
1156 .remove = zynqmp_dma_remove,
1159 module_platform_driver(zynqmp_dma_driver);
1161 MODULE_LICENSE("GPL");
1162 MODULE_AUTHOR("Xilinx, Inc.");
1163 MODULE_DESCRIPTION("Xilinx ZynqMP DMA driver");