1 // SPDX-License-Identifier: GPL-2.0
3 * Xilinx ZynqMP DPDMA Engine driver
5 * Copyright (C) 2015 - 2020 Xilinx, Inc.
7 * Author: Hyun Woo Kwon <hyun.kwon@xilinx.com>
10 #include <linux/bitfield.h>
11 #include <linux/bits.h>
12 #include <linux/clk.h>
13 #include <linux/debugfs.h>
14 #include <linux/delay.h>
15 #include <linux/dmaengine.h>
16 #include <linux/dmapool.h>
17 #include <linux/interrupt.h>
18 #include <linux/module.h>
20 #include <linux/of_dma.h>
21 #include <linux/platform_device.h>
22 #include <linux/sched.h>
23 #include <linux/slab.h>
24 #include <linux/spinlock.h>
25 #include <linux/wait.h>
27 #include <dt-bindings/dma/xlnx-zynqmp-dpdma.h>
29 #include "../dmaengine.h"
30 #include "../virt-dma.h"
33 #define XILINX_DPDMA_ERR_CTRL 0x000
34 #define XILINX_DPDMA_ISR 0x004
35 #define XILINX_DPDMA_IMR 0x008
36 #define XILINX_DPDMA_IEN 0x00c
37 #define XILINX_DPDMA_IDS 0x010
38 #define XILINX_DPDMA_INTR_DESC_DONE(n) BIT((n) + 0)
39 #define XILINX_DPDMA_INTR_DESC_DONE_MASK GENMASK(5, 0)
40 #define XILINX_DPDMA_INTR_NO_OSTAND(n) BIT((n) + 6)
41 #define XILINX_DPDMA_INTR_NO_OSTAND_MASK GENMASK(11, 6)
42 #define XILINX_DPDMA_INTR_AXI_ERR(n) BIT((n) + 12)
43 #define XILINX_DPDMA_INTR_AXI_ERR_MASK GENMASK(17, 12)
44 #define XILINX_DPDMA_INTR_DESC_ERR(n) BIT((n) + 16)
45 #define XILINX_DPDMA_INTR_DESC_ERR_MASK GENMASK(23, 18)
46 #define XILINX_DPDMA_INTR_WR_CMD_FIFO_FULL BIT(24)
47 #define XILINX_DPDMA_INTR_WR_DATA_FIFO_FULL BIT(25)
48 #define XILINX_DPDMA_INTR_AXI_4K_CROSS BIT(26)
49 #define XILINX_DPDMA_INTR_VSYNC BIT(27)
50 #define XILINX_DPDMA_INTR_CHAN_ERR_MASK 0x00041000
51 #define XILINX_DPDMA_INTR_CHAN_ERR 0x00fff000
52 #define XILINX_DPDMA_INTR_GLOBAL_ERR 0x07000000
53 #define XILINX_DPDMA_INTR_ERR_ALL 0x07fff000
54 #define XILINX_DPDMA_INTR_CHAN_MASK 0x00041041
55 #define XILINX_DPDMA_INTR_GLOBAL_MASK 0x0f000000
56 #define XILINX_DPDMA_INTR_ALL 0x0fffffff
57 #define XILINX_DPDMA_EISR 0x014
58 #define XILINX_DPDMA_EIMR 0x018
59 #define XILINX_DPDMA_EIEN 0x01c
60 #define XILINX_DPDMA_EIDS 0x020
61 #define XILINX_DPDMA_EINTR_INV_APB BIT(0)
62 #define XILINX_DPDMA_EINTR_RD_AXI_ERR(n) BIT((n) + 1)
63 #define XILINX_DPDMA_EINTR_RD_AXI_ERR_MASK GENMASK(6, 1)
64 #define XILINX_DPDMA_EINTR_PRE_ERR(n) BIT((n) + 7)
65 #define XILINX_DPDMA_EINTR_PRE_ERR_MASK GENMASK(12, 7)
66 #define XILINX_DPDMA_EINTR_CRC_ERR(n) BIT((n) + 13)
67 #define XILINX_DPDMA_EINTR_CRC_ERR_MASK GENMASK(18, 13)
68 #define XILINX_DPDMA_EINTR_WR_AXI_ERR(n) BIT((n) + 19)
69 #define XILINX_DPDMA_EINTR_WR_AXI_ERR_MASK GENMASK(24, 19)
70 #define XILINX_DPDMA_EINTR_DESC_DONE_ERR(n) BIT((n) + 25)
71 #define XILINX_DPDMA_EINTR_DESC_DONE_ERR_MASK GENMASK(30, 25)
72 #define XILINX_DPDMA_EINTR_RD_CMD_FIFO_FULL BIT(32)
73 #define XILINX_DPDMA_EINTR_CHAN_ERR_MASK 0x02082082
74 #define XILINX_DPDMA_EINTR_CHAN_ERR 0x7ffffffe
75 #define XILINX_DPDMA_EINTR_GLOBAL_ERR 0x80000001
76 #define XILINX_DPDMA_EINTR_ALL 0xffffffff
77 #define XILINX_DPDMA_CNTL 0x100
78 #define XILINX_DPDMA_GBL 0x104
79 #define XILINX_DPDMA_GBL_TRIG_MASK(n) ((n) << 0)
80 #define XILINX_DPDMA_GBL_RETRIG_MASK(n) ((n) << 6)
81 #define XILINX_DPDMA_ALC0_CNTL 0x108
82 #define XILINX_DPDMA_ALC0_STATUS 0x10c
83 #define XILINX_DPDMA_ALC0_MAX 0x110
84 #define XILINX_DPDMA_ALC0_MIN 0x114
85 #define XILINX_DPDMA_ALC0_ACC 0x118
86 #define XILINX_DPDMA_ALC0_ACC_TRAN 0x11c
87 #define XILINX_DPDMA_ALC1_CNTL 0x120
88 #define XILINX_DPDMA_ALC1_STATUS 0x124
89 #define XILINX_DPDMA_ALC1_MAX 0x128
90 #define XILINX_DPDMA_ALC1_MIN 0x12c
91 #define XILINX_DPDMA_ALC1_ACC 0x130
92 #define XILINX_DPDMA_ALC1_ACC_TRAN 0x134
94 /* Channel register */
95 #define XILINX_DPDMA_CH_BASE 0x200
96 #define XILINX_DPDMA_CH_OFFSET 0x100
97 #define XILINX_DPDMA_CH_DESC_START_ADDRE 0x000
98 #define XILINX_DPDMA_CH_DESC_START_ADDRE_MASK GENMASK(15, 0)
99 #define XILINX_DPDMA_CH_DESC_START_ADDR 0x004
100 #define XILINX_DPDMA_CH_DESC_NEXT_ADDRE 0x008
101 #define XILINX_DPDMA_CH_DESC_NEXT_ADDR 0x00c
102 #define XILINX_DPDMA_CH_PYLD_CUR_ADDRE 0x010
103 #define XILINX_DPDMA_CH_PYLD_CUR_ADDR 0x014
104 #define XILINX_DPDMA_CH_CNTL 0x018
105 #define XILINX_DPDMA_CH_CNTL_ENABLE BIT(0)
106 #define XILINX_DPDMA_CH_CNTL_PAUSE BIT(1)
107 #define XILINX_DPDMA_CH_CNTL_QOS_DSCR_WR_MASK GENMASK(5, 2)
108 #define XILINX_DPDMA_CH_CNTL_QOS_DSCR_RD_MASK GENMASK(9, 6)
109 #define XILINX_DPDMA_CH_CNTL_QOS_DATA_RD_MASK GENMASK(13, 10)
110 #define XILINX_DPDMA_CH_CNTL_QOS_VID_CLASS 11
111 #define XILINX_DPDMA_CH_STATUS 0x01c
112 #define XILINX_DPDMA_CH_STATUS_OTRAN_CNT_MASK GENMASK(24, 21)
113 #define XILINX_DPDMA_CH_VDO 0x020
114 #define XILINX_DPDMA_CH_PYLD_SZ 0x024
115 #define XILINX_DPDMA_CH_DESC_ID 0x028
116 #define XILINX_DPDMA_CH_DESC_ID_MASK GENMASK(15, 0)
118 /* DPDMA descriptor fields */
119 #define XILINX_DPDMA_DESC_CONTROL_PREEMBLE 0xa5
120 #define XILINX_DPDMA_DESC_CONTROL_COMPLETE_INTR BIT(8)
121 #define XILINX_DPDMA_DESC_CONTROL_DESC_UPDATE BIT(9)
122 #define XILINX_DPDMA_DESC_CONTROL_IGNORE_DONE BIT(10)
123 #define XILINX_DPDMA_DESC_CONTROL_FRAG_MODE BIT(18)
124 #define XILINX_DPDMA_DESC_CONTROL_LAST BIT(19)
125 #define XILINX_DPDMA_DESC_CONTROL_ENABLE_CRC BIT(20)
126 #define XILINX_DPDMA_DESC_CONTROL_LAST_OF_FRAME BIT(21)
127 #define XILINX_DPDMA_DESC_ID_MASK GENMASK(15, 0)
128 #define XILINX_DPDMA_DESC_HSIZE_STRIDE_HSIZE_MASK GENMASK(17, 0)
129 #define XILINX_DPDMA_DESC_HSIZE_STRIDE_STRIDE_MASK GENMASK(31, 18)
130 #define XILINX_DPDMA_DESC_ADDR_EXT_NEXT_ADDR_MASK GENMASK(15, 0)
131 #define XILINX_DPDMA_DESC_ADDR_EXT_SRC_ADDR_MASK GENMASK(31, 16)
133 #define XILINX_DPDMA_ALIGN_BYTES 256
134 #define XILINX_DPDMA_LINESIZE_ALIGN_BITS 128
136 #define XILINX_DPDMA_NUM_CHAN 6
138 struct xilinx_dpdma_chan;
141 * struct xilinx_dpdma_hw_desc - DPDMA hardware descriptor
142 * @control: control configuration field
143 * @desc_id: descriptor ID
144 * @xfer_size: transfer size
145 * @hsize_stride: horizontal size and stride
146 * @timestamp_lsb: LSB of time stamp
147 * @timestamp_msb: MSB of time stamp
148 * @addr_ext: upper 16 bit of 48 bit address (next_desc and src_addr)
149 * @next_desc: next descriptor 32 bit address
150 * @src_addr: payload source address (1st page, 32 LSB)
151 * @addr_ext_23: payload source address (3nd and 3rd pages, 16 LSBs)
152 * @addr_ext_45: payload source address (4th and 5th pages, 16 LSBs)
153 * @src_addr2: payload source address (2nd page, 32 LSB)
154 * @src_addr3: payload source address (3rd page, 32 LSB)
155 * @src_addr4: payload source address (4th page, 32 LSB)
156 * @src_addr5: payload source address (5th page, 32 LSB)
157 * @crc: descriptor CRC
159 struct xilinx_dpdma_hw_desc {
176 } __aligned(XILINX_DPDMA_ALIGN_BYTES);
179 * struct xilinx_dpdma_sw_desc - DPDMA software descriptor
180 * @hw: DPDMA hardware descriptor
181 * @node: list node for software descriptors
182 * @dma_addr: DMA address of the software descriptor
184 struct xilinx_dpdma_sw_desc {
185 struct xilinx_dpdma_hw_desc hw;
186 struct list_head node;
191 * struct xilinx_dpdma_tx_desc - DPDMA transaction descriptor
192 * @vdesc: virtual DMA descriptor
194 * @descriptors: list of software descriptors
195 * @error: an error has been detected with this descriptor
197 struct xilinx_dpdma_tx_desc {
198 struct virt_dma_desc vdesc;
199 struct xilinx_dpdma_chan *chan;
200 struct list_head descriptors;
204 #define to_dpdma_tx_desc(_desc) \
205 container_of(_desc, struct xilinx_dpdma_tx_desc, vdesc)
208 * struct xilinx_dpdma_chan - DPDMA channel
209 * @vchan: virtual DMA channel
210 * @reg: register base address
212 * @wait_to_stop: queue to wait for outstanding transacitons before stopping
213 * @running: true if the channel is running
214 * @first_frame: flag for the first frame of stream
215 * @video_group: flag if multi-channel operation is needed for video channels
216 * @lock: lock to access struct xilinx_dpdma_chan
217 * @desc_pool: descriptor allocation pool
218 * @err_task: error IRQ bottom half handler
219 * @desc: References to descriptors being processed
220 * @desc.pending: Descriptor schedule to the hardware, pending execution
221 * @desc.active: Descriptor being executed by the hardware
222 * @xdev: DPDMA device
224 struct xilinx_dpdma_chan {
225 struct virt_dma_chan vchan;
229 wait_queue_head_t wait_to_stop;
234 spinlock_t lock; /* lock to access struct xilinx_dpdma_chan */
235 struct dma_pool *desc_pool;
236 struct tasklet_struct err_task;
239 struct xilinx_dpdma_tx_desc *pending;
240 struct xilinx_dpdma_tx_desc *active;
243 struct xilinx_dpdma_device *xdev;
246 #define to_xilinx_chan(_chan) \
247 container_of(_chan, struct xilinx_dpdma_chan, vchan.chan)
250 * struct xilinx_dpdma_device - DPDMA device
251 * @common: generic dma device structure
252 * @reg: register base address
253 * @dev: generic device structure
254 * @irq: the interrupt number
255 * @axi_clk: axi clock
256 * @chan: DPDMA channels
257 * @ext_addr: flag for 64 bit system (48 bit addressing)
259 struct xilinx_dpdma_device {
260 struct dma_device common;
266 struct xilinx_dpdma_chan *chan[XILINX_DPDMA_NUM_CHAN];
271 /* -----------------------------------------------------------------------------
274 #define XILINX_DPDMA_DEBUGFS_READ_MAX_SIZE 32
275 #define XILINX_DPDMA_DEBUGFS_UINT16_MAX_STR "65535"
277 /* Match xilinx_dpdma_testcases vs dpdma_debugfs_reqs[] entry */
278 enum xilinx_dpdma_testcases {
283 struct xilinx_dpdma_debugfs {
284 enum xilinx_dpdma_testcases testcase;
285 u16 xilinx_dpdma_irq_done_count;
286 unsigned int chan_id;
289 static struct xilinx_dpdma_debugfs dpdma_debugfs;
290 struct xilinx_dpdma_debugfs_request {
292 enum xilinx_dpdma_testcases tc;
293 ssize_t (*read)(char *buf);
294 int (*write)(char *args);
297 static void xilinx_dpdma_debugfs_desc_done_irq(struct xilinx_dpdma_chan *chan)
299 if (IS_ENABLED(CONFIG_DEBUG_FS) && chan->id == dpdma_debugfs.chan_id)
300 dpdma_debugfs.xilinx_dpdma_irq_done_count++;
303 static ssize_t xilinx_dpdma_debugfs_desc_done_irq_read(char *buf)
307 dpdma_debugfs.testcase = DPDMA_TC_NONE;
309 out_str_len = strlen(XILINX_DPDMA_DEBUGFS_UINT16_MAX_STR);
310 out_str_len = min_t(size_t, XILINX_DPDMA_DEBUGFS_READ_MAX_SIZE,
312 snprintf(buf, out_str_len, "%d",
313 dpdma_debugfs.xilinx_dpdma_irq_done_count);
318 static int xilinx_dpdma_debugfs_desc_done_irq_write(char *args)
324 arg = strsep(&args, " ");
325 if (!arg || strncasecmp(arg, "start", 5))
328 arg = strsep(&args, " ");
332 ret = kstrtou32(arg, 0, &id);
336 if (id < ZYNQMP_DPDMA_VIDEO0 || id > ZYNQMP_DPDMA_AUDIO1)
339 dpdma_debugfs.testcase = DPDMA_TC_INTR_DONE;
340 dpdma_debugfs.xilinx_dpdma_irq_done_count = 0;
341 dpdma_debugfs.chan_id = id;
346 /* Match xilinx_dpdma_testcases vs dpdma_debugfs_reqs[] entry */
347 static struct xilinx_dpdma_debugfs_request dpdma_debugfs_reqs[] = {
349 .name = "DESCRIPTOR_DONE_INTR",
350 .tc = DPDMA_TC_INTR_DONE,
351 .read = xilinx_dpdma_debugfs_desc_done_irq_read,
352 .write = xilinx_dpdma_debugfs_desc_done_irq_write,
356 static ssize_t xilinx_dpdma_debugfs_read(struct file *f, char __user *buf,
357 size_t size, loff_t *pos)
359 enum xilinx_dpdma_testcases testcase;
363 if (*pos != 0 || size <= 0)
366 kern_buff = kzalloc(XILINX_DPDMA_DEBUGFS_READ_MAX_SIZE, GFP_KERNEL);
368 dpdma_debugfs.testcase = DPDMA_TC_NONE;
372 testcase = READ_ONCE(dpdma_debugfs.testcase);
373 if (testcase != DPDMA_TC_NONE) {
374 ret = dpdma_debugfs_reqs[testcase].read(kern_buff);
378 strlcpy(kern_buff, "No testcase executed",
379 XILINX_DPDMA_DEBUGFS_READ_MAX_SIZE);
382 size = min(size, strlen(kern_buff));
383 if (copy_to_user(buf, kern_buff, size))
395 static ssize_t xilinx_dpdma_debugfs_write(struct file *f,
396 const char __user *buf, size_t size,
399 char *kern_buff, *kern_buff_start;
404 if (*pos != 0 || size <= 0)
407 /* Supporting single instance of test as of now. */
408 if (dpdma_debugfs.testcase != DPDMA_TC_NONE)
411 kern_buff = kzalloc(size, GFP_KERNEL);
414 kern_buff_start = kern_buff;
416 ret = strncpy_from_user(kern_buff, buf, size);
420 /* Read the testcase name from a user request. */
421 testcase = strsep(&kern_buff, " ");
423 for (i = 0; i < ARRAY_SIZE(dpdma_debugfs_reqs); i++) {
424 if (!strcasecmp(testcase, dpdma_debugfs_reqs[i].name))
428 if (i == ARRAY_SIZE(dpdma_debugfs_reqs)) {
433 ret = dpdma_debugfs_reqs[i].write(kern_buff);
440 kfree(kern_buff_start);
444 static const struct file_operations fops_xilinx_dpdma_dbgfs = {
445 .owner = THIS_MODULE,
446 .read = xilinx_dpdma_debugfs_read,
447 .write = xilinx_dpdma_debugfs_write,
450 static void xilinx_dpdma_debugfs_init(struct xilinx_dpdma_device *xdev)
454 dpdma_debugfs.testcase = DPDMA_TC_NONE;
456 dent = debugfs_create_file("testcase", 0444, xdev->common.dbg_dev_root,
457 NULL, &fops_xilinx_dpdma_dbgfs);
459 dev_err(xdev->dev, "Failed to create debugfs testcase file\n");
462 /* -----------------------------------------------------------------------------
466 static inline u32 dpdma_read(void __iomem *base, u32 offset)
468 return ioread32(base + offset);
471 static inline void dpdma_write(void __iomem *base, u32 offset, u32 val)
473 iowrite32(val, base + offset);
476 static inline void dpdma_clr(void __iomem *base, u32 offset, u32 clr)
478 dpdma_write(base, offset, dpdma_read(base, offset) & ~clr);
481 static inline void dpdma_set(void __iomem *base, u32 offset, u32 set)
483 dpdma_write(base, offset, dpdma_read(base, offset) | set);
486 /* -----------------------------------------------------------------------------
487 * Descriptor Operations
491 * xilinx_dpdma_sw_desc_set_dma_addrs - Set DMA addresses in the descriptor
492 * @xdev: DPDMA device
493 * @sw_desc: The software descriptor in which to set DMA addresses
494 * @prev: The previous descriptor
495 * @dma_addr: array of dma addresses
496 * @num_src_addr: number of addresses in @dma_addr
498 * Set all the DMA addresses in the hardware descriptor corresponding to @dev
499 * from @dma_addr. If a previous descriptor is specified in @prev, its next
500 * descriptor DMA address is set to the DMA address of @sw_desc. @prev may be
501 * identical to @sw_desc for cyclic transfers.
503 static void xilinx_dpdma_sw_desc_set_dma_addrs(struct xilinx_dpdma_device *xdev,
504 struct xilinx_dpdma_sw_desc *sw_desc,
505 struct xilinx_dpdma_sw_desc *prev,
506 dma_addr_t dma_addr[],
507 unsigned int num_src_addr)
509 struct xilinx_dpdma_hw_desc *hw_desc = &sw_desc->hw;
512 hw_desc->src_addr = lower_32_bits(dma_addr[0]);
515 FIELD_PREP(XILINX_DPDMA_DESC_ADDR_EXT_SRC_ADDR_MASK,
516 upper_32_bits(dma_addr[0]));
518 for (i = 1; i < num_src_addr; i++) {
519 u32 *addr = &hw_desc->src_addr2;
521 addr[i - 1] = lower_32_bits(dma_addr[i]);
523 if (xdev->ext_addr) {
524 u32 *addr_ext = &hw_desc->addr_ext_23;
527 addr_msb = upper_32_bits(dma_addr[i]) & GENMASK(15, 0);
528 addr_msb <<= 16 * ((i - 1) % 2);
529 addr_ext[(i - 1) / 2] |= addr_msb;
536 prev->hw.next_desc = lower_32_bits(sw_desc->dma_addr);
539 FIELD_PREP(XILINX_DPDMA_DESC_ADDR_EXT_NEXT_ADDR_MASK,
540 upper_32_bits(sw_desc->dma_addr));
544 * xilinx_dpdma_chan_alloc_sw_desc - Allocate a software descriptor
545 * @chan: DPDMA channel
547 * Allocate a software descriptor from the channel's descriptor pool.
549 * Return: a software descriptor or NULL.
551 static struct xilinx_dpdma_sw_desc *
552 xilinx_dpdma_chan_alloc_sw_desc(struct xilinx_dpdma_chan *chan)
554 struct xilinx_dpdma_sw_desc *sw_desc;
557 sw_desc = dma_pool_zalloc(chan->desc_pool, GFP_ATOMIC, &dma_addr);
561 sw_desc->dma_addr = dma_addr;
567 * xilinx_dpdma_chan_free_sw_desc - Free a software descriptor
568 * @chan: DPDMA channel
569 * @sw_desc: software descriptor to free
571 * Free a software descriptor from the channel's descriptor pool.
574 xilinx_dpdma_chan_free_sw_desc(struct xilinx_dpdma_chan *chan,
575 struct xilinx_dpdma_sw_desc *sw_desc)
577 dma_pool_free(chan->desc_pool, sw_desc, sw_desc->dma_addr);
581 * xilinx_dpdma_chan_dump_tx_desc - Dump a tx descriptor
582 * @chan: DPDMA channel
583 * @tx_desc: tx descriptor to dump
585 * Dump contents of a tx descriptor
587 static void xilinx_dpdma_chan_dump_tx_desc(struct xilinx_dpdma_chan *chan,
588 struct xilinx_dpdma_tx_desc *tx_desc)
590 struct xilinx_dpdma_sw_desc *sw_desc;
591 struct device *dev = chan->xdev->dev;
594 dev_dbg(dev, "------- TX descriptor dump start -------\n");
595 dev_dbg(dev, "------- channel ID = %d -------\n", chan->id);
597 list_for_each_entry(sw_desc, &tx_desc->descriptors, node) {
598 struct xilinx_dpdma_hw_desc *hw_desc = &sw_desc->hw;
600 dev_dbg(dev, "------- HW descriptor %d -------\n", i++);
601 dev_dbg(dev, "descriptor DMA addr: %pad\n", &sw_desc->dma_addr);
602 dev_dbg(dev, "control: 0x%08x\n", hw_desc->control);
603 dev_dbg(dev, "desc_id: 0x%08x\n", hw_desc->desc_id);
604 dev_dbg(dev, "xfer_size: 0x%08x\n", hw_desc->xfer_size);
605 dev_dbg(dev, "hsize_stride: 0x%08x\n", hw_desc->hsize_stride);
606 dev_dbg(dev, "timestamp_lsb: 0x%08x\n", hw_desc->timestamp_lsb);
607 dev_dbg(dev, "timestamp_msb: 0x%08x\n", hw_desc->timestamp_msb);
608 dev_dbg(dev, "addr_ext: 0x%08x\n", hw_desc->addr_ext);
609 dev_dbg(dev, "next_desc: 0x%08x\n", hw_desc->next_desc);
610 dev_dbg(dev, "src_addr: 0x%08x\n", hw_desc->src_addr);
611 dev_dbg(dev, "addr_ext_23: 0x%08x\n", hw_desc->addr_ext_23);
612 dev_dbg(dev, "addr_ext_45: 0x%08x\n", hw_desc->addr_ext_45);
613 dev_dbg(dev, "src_addr2: 0x%08x\n", hw_desc->src_addr2);
614 dev_dbg(dev, "src_addr3: 0x%08x\n", hw_desc->src_addr3);
615 dev_dbg(dev, "src_addr4: 0x%08x\n", hw_desc->src_addr4);
616 dev_dbg(dev, "src_addr5: 0x%08x\n", hw_desc->src_addr5);
617 dev_dbg(dev, "crc: 0x%08x\n", hw_desc->crc);
620 dev_dbg(dev, "------- TX descriptor dump end -------\n");
624 * xilinx_dpdma_chan_alloc_tx_desc - Allocate a transaction descriptor
625 * @chan: DPDMA channel
627 * Allocate a tx descriptor.
629 * Return: a tx descriptor or NULL.
631 static struct xilinx_dpdma_tx_desc *
632 xilinx_dpdma_chan_alloc_tx_desc(struct xilinx_dpdma_chan *chan)
634 struct xilinx_dpdma_tx_desc *tx_desc;
636 tx_desc = kzalloc(sizeof(*tx_desc), GFP_NOWAIT);
640 INIT_LIST_HEAD(&tx_desc->descriptors);
641 tx_desc->chan = chan;
642 tx_desc->error = false;
648 * xilinx_dpdma_chan_free_tx_desc - Free a virtual DMA descriptor
649 * @vdesc: virtual DMA descriptor
651 * Free the virtual DMA descriptor @vdesc including its software descriptors.
653 static void xilinx_dpdma_chan_free_tx_desc(struct virt_dma_desc *vdesc)
655 struct xilinx_dpdma_sw_desc *sw_desc, *next;
656 struct xilinx_dpdma_tx_desc *desc;
661 desc = to_dpdma_tx_desc(vdesc);
663 list_for_each_entry_safe(sw_desc, next, &desc->descriptors, node) {
664 list_del(&sw_desc->node);
665 xilinx_dpdma_chan_free_sw_desc(desc->chan, sw_desc);
672 * xilinx_dpdma_chan_prep_interleaved_dma - Prepare an interleaved dma
674 * @chan: DPDMA channel
675 * @xt: dma interleaved template
677 * Prepare a tx descriptor including internal software/hardware descriptors
680 * Return: A DPDMA TX descriptor on success, or NULL.
682 static struct xilinx_dpdma_tx_desc *
683 xilinx_dpdma_chan_prep_interleaved_dma(struct xilinx_dpdma_chan *chan,
684 struct dma_interleaved_template *xt)
686 struct xilinx_dpdma_tx_desc *tx_desc;
687 struct xilinx_dpdma_sw_desc *sw_desc;
688 struct xilinx_dpdma_hw_desc *hw_desc;
689 size_t hsize = xt->sgl[0].size;
690 size_t stride = hsize + xt->sgl[0].icg;
692 if (!IS_ALIGNED(xt->src_start, XILINX_DPDMA_ALIGN_BYTES)) {
693 dev_err(chan->xdev->dev,
694 "chan%u: buffer should be aligned at %d B\n",
695 chan->id, XILINX_DPDMA_ALIGN_BYTES);
699 tx_desc = xilinx_dpdma_chan_alloc_tx_desc(chan);
703 sw_desc = xilinx_dpdma_chan_alloc_sw_desc(chan);
705 xilinx_dpdma_chan_free_tx_desc(&tx_desc->vdesc);
709 xilinx_dpdma_sw_desc_set_dma_addrs(chan->xdev, sw_desc, sw_desc,
712 hw_desc = &sw_desc->hw;
713 hsize = ALIGN(hsize, XILINX_DPDMA_LINESIZE_ALIGN_BITS / 8);
714 hw_desc->xfer_size = hsize * xt->numf;
715 hw_desc->hsize_stride =
716 FIELD_PREP(XILINX_DPDMA_DESC_HSIZE_STRIDE_HSIZE_MASK, hsize) |
717 FIELD_PREP(XILINX_DPDMA_DESC_HSIZE_STRIDE_STRIDE_MASK,
719 hw_desc->control |= XILINX_DPDMA_DESC_CONTROL_PREEMBLE;
720 hw_desc->control |= XILINX_DPDMA_DESC_CONTROL_COMPLETE_INTR;
721 hw_desc->control |= XILINX_DPDMA_DESC_CONTROL_IGNORE_DONE;
722 hw_desc->control |= XILINX_DPDMA_DESC_CONTROL_LAST_OF_FRAME;
724 list_add_tail(&sw_desc->node, &tx_desc->descriptors);
729 /* -----------------------------------------------------------------------------
730 * DPDMA Channel Operations
734 * xilinx_dpdma_chan_enable - Enable the channel
735 * @chan: DPDMA channel
737 * Enable the channel and its interrupts. Set the QoS values for video class.
739 static void xilinx_dpdma_chan_enable(struct xilinx_dpdma_chan *chan)
743 reg = (XILINX_DPDMA_INTR_CHAN_MASK << chan->id)
744 | XILINX_DPDMA_INTR_GLOBAL_MASK;
745 dpdma_write(chan->xdev->reg, XILINX_DPDMA_IEN, reg);
746 reg = (XILINX_DPDMA_EINTR_CHAN_ERR_MASK << chan->id)
747 | XILINX_DPDMA_INTR_GLOBAL_ERR;
748 dpdma_write(chan->xdev->reg, XILINX_DPDMA_EIEN, reg);
750 reg = XILINX_DPDMA_CH_CNTL_ENABLE
751 | FIELD_PREP(XILINX_DPDMA_CH_CNTL_QOS_DSCR_WR_MASK,
752 XILINX_DPDMA_CH_CNTL_QOS_VID_CLASS)
753 | FIELD_PREP(XILINX_DPDMA_CH_CNTL_QOS_DSCR_RD_MASK,
754 XILINX_DPDMA_CH_CNTL_QOS_VID_CLASS)
755 | FIELD_PREP(XILINX_DPDMA_CH_CNTL_QOS_DATA_RD_MASK,
756 XILINX_DPDMA_CH_CNTL_QOS_VID_CLASS);
757 dpdma_set(chan->reg, XILINX_DPDMA_CH_CNTL, reg);
761 * xilinx_dpdma_chan_disable - Disable the channel
762 * @chan: DPDMA channel
764 * Disable the channel and its interrupts.
766 static void xilinx_dpdma_chan_disable(struct xilinx_dpdma_chan *chan)
770 reg = XILINX_DPDMA_INTR_CHAN_MASK << chan->id;
771 dpdma_write(chan->xdev->reg, XILINX_DPDMA_IEN, reg);
772 reg = XILINX_DPDMA_EINTR_CHAN_ERR_MASK << chan->id;
773 dpdma_write(chan->xdev->reg, XILINX_DPDMA_EIEN, reg);
775 dpdma_clr(chan->reg, XILINX_DPDMA_CH_CNTL, XILINX_DPDMA_CH_CNTL_ENABLE);
779 * xilinx_dpdma_chan_pause - Pause the channel
780 * @chan: DPDMA channel
784 static void xilinx_dpdma_chan_pause(struct xilinx_dpdma_chan *chan)
786 dpdma_set(chan->reg, XILINX_DPDMA_CH_CNTL, XILINX_DPDMA_CH_CNTL_PAUSE);
790 * xilinx_dpdma_chan_unpause - Unpause the channel
791 * @chan: DPDMA channel
793 * Unpause the channel.
795 static void xilinx_dpdma_chan_unpause(struct xilinx_dpdma_chan *chan)
797 dpdma_clr(chan->reg, XILINX_DPDMA_CH_CNTL, XILINX_DPDMA_CH_CNTL_PAUSE);
800 static u32 xilinx_dpdma_chan_video_group_ready(struct xilinx_dpdma_chan *chan)
802 struct xilinx_dpdma_device *xdev = chan->xdev;
806 for (i = ZYNQMP_DPDMA_VIDEO0; i <= ZYNQMP_DPDMA_VIDEO2; i++) {
807 if (xdev->chan[i]->video_group && !xdev->chan[i]->running)
810 if (xdev->chan[i]->video_group)
818 * xilinx_dpdma_chan_queue_transfer - Queue the next transfer
819 * @chan: DPDMA channel
821 * Queue the next descriptor, if any, to the hardware. If the channel is
822 * stopped, start it first. Otherwise retrigger it with the next descriptor.
824 static void xilinx_dpdma_chan_queue_transfer(struct xilinx_dpdma_chan *chan)
826 struct xilinx_dpdma_device *xdev = chan->xdev;
827 struct xilinx_dpdma_sw_desc *sw_desc;
828 struct xilinx_dpdma_tx_desc *desc;
829 struct virt_dma_desc *vdesc;
833 lockdep_assert_held(&chan->lock);
835 if (chan->desc.pending)
838 if (!chan->running) {
839 xilinx_dpdma_chan_unpause(chan);
840 xilinx_dpdma_chan_enable(chan);
841 chan->first_frame = true;
842 chan->running = true;
845 vdesc = vchan_next_desc(&chan->vchan);
849 desc = to_dpdma_tx_desc(vdesc);
850 chan->desc.pending = desc;
851 list_del(&desc->vdesc.node);
854 * Assign the cookie to descriptors in this transaction. Only 16 bit
855 * will be used, but it should be enough.
857 list_for_each_entry(sw_desc, &desc->descriptors, node)
858 sw_desc->hw.desc_id = desc->vdesc.tx.cookie
859 & XILINX_DPDMA_CH_DESC_ID_MASK;
861 sw_desc = list_first_entry(&desc->descriptors,
862 struct xilinx_dpdma_sw_desc, node);
863 dpdma_write(chan->reg, XILINX_DPDMA_CH_DESC_START_ADDR,
864 lower_32_bits(sw_desc->dma_addr));
866 dpdma_write(chan->reg, XILINX_DPDMA_CH_DESC_START_ADDRE,
867 FIELD_PREP(XILINX_DPDMA_CH_DESC_START_ADDRE_MASK,
868 upper_32_bits(sw_desc->dma_addr)));
870 first_frame = chan->first_frame;
871 chan->first_frame = false;
873 if (chan->video_group) {
874 channels = xilinx_dpdma_chan_video_group_ready(chan);
876 * Trigger the transfer only when all channels in the group are
882 channels = BIT(chan->id);
886 reg = XILINX_DPDMA_GBL_TRIG_MASK(channels);
888 reg = XILINX_DPDMA_GBL_RETRIG_MASK(channels);
890 dpdma_write(xdev->reg, XILINX_DPDMA_GBL, reg);
894 * xilinx_dpdma_chan_ostand - Number of outstanding transactions
895 * @chan: DPDMA channel
897 * Read and return the number of outstanding transactions from register.
899 * Return: Number of outstanding transactions from the status register.
901 static u32 xilinx_dpdma_chan_ostand(struct xilinx_dpdma_chan *chan)
903 return FIELD_GET(XILINX_DPDMA_CH_STATUS_OTRAN_CNT_MASK,
904 dpdma_read(chan->reg, XILINX_DPDMA_CH_STATUS));
908 * xilinx_dpdma_chan_notify_no_ostand - Notify no outstanding transaction event
909 * @chan: DPDMA channel
911 * Notify waiters for no outstanding event, so waiters can stop the channel
912 * safely. This function is supposed to be called when 'no outstanding'
913 * interrupt is generated. The 'no outstanding' interrupt is disabled and
914 * should be re-enabled when this event is handled. If the channel status
915 * register still shows some number of outstanding transactions, the interrupt
918 * Return: 0 on success. On failure, -EWOULDBLOCK if there's still outstanding
921 static int xilinx_dpdma_chan_notify_no_ostand(struct xilinx_dpdma_chan *chan)
925 cnt = xilinx_dpdma_chan_ostand(chan);
927 dev_dbg(chan->xdev->dev,
928 "chan%u: %d outstanding transactions\n",
933 /* Disable 'no outstanding' interrupt */
934 dpdma_write(chan->xdev->reg, XILINX_DPDMA_IDS,
935 XILINX_DPDMA_INTR_NO_OSTAND(chan->id));
936 wake_up(&chan->wait_to_stop);
942 * xilinx_dpdma_chan_wait_no_ostand - Wait for the no outstanding irq
943 * @chan: DPDMA channel
945 * Wait for the no outstanding transaction interrupt. This functions can sleep
948 * Return: 0 on success. On failure, -ETIMEOUT for time out, or the error code
949 * from wait_event_interruptible_timeout().
951 static int xilinx_dpdma_chan_wait_no_ostand(struct xilinx_dpdma_chan *chan)
955 /* Wait for a no outstanding transaction interrupt upto 50msec */
956 ret = wait_event_interruptible_timeout(chan->wait_to_stop,
957 !xilinx_dpdma_chan_ostand(chan),
958 msecs_to_jiffies(50));
960 dpdma_write(chan->xdev->reg, XILINX_DPDMA_IEN,
961 XILINX_DPDMA_INTR_NO_OSTAND(chan->id));
965 dev_err(chan->xdev->dev, "chan%u: not ready to stop: %d trans\n",
966 chan->id, xilinx_dpdma_chan_ostand(chan));
975 * xilinx_dpdma_chan_poll_no_ostand - Poll the outstanding transaction status
976 * @chan: DPDMA channel
978 * Poll the outstanding transaction status, and return when there's no
979 * outstanding transaction. This functions can be used in the interrupt context
980 * or where the atomicity is required. Calling thread may wait more than 50ms.
982 * Return: 0 on success, or -ETIMEDOUT.
984 static int xilinx_dpdma_chan_poll_no_ostand(struct xilinx_dpdma_chan *chan)
986 u32 cnt, loop = 50000;
988 /* Poll at least for 50ms (20 fps). */
990 cnt = xilinx_dpdma_chan_ostand(chan);
992 } while (loop-- > 0 && cnt);
995 dpdma_write(chan->xdev->reg, XILINX_DPDMA_IEN,
996 XILINX_DPDMA_INTR_NO_OSTAND(chan->id));
1000 dev_err(chan->xdev->dev, "chan%u: not ready to stop: %d trans\n",
1001 chan->id, xilinx_dpdma_chan_ostand(chan));
1007 * xilinx_dpdma_chan_stop - Stop the channel
1008 * @chan: DPDMA channel
1010 * Stop a previously paused channel by first waiting for completion of all
1011 * outstanding transaction and then disabling the channel.
1013 * Return: 0 on success, or -ETIMEDOUT if the channel failed to stop.
1015 static int xilinx_dpdma_chan_stop(struct xilinx_dpdma_chan *chan)
1017 unsigned long flags;
1020 ret = xilinx_dpdma_chan_wait_no_ostand(chan);
1024 spin_lock_irqsave(&chan->lock, flags);
1025 xilinx_dpdma_chan_disable(chan);
1026 chan->running = false;
1027 spin_unlock_irqrestore(&chan->lock, flags);
1033 * xilinx_dpdma_chan_done_irq - Handle hardware descriptor completion
1034 * @chan: DPDMA channel
1036 * Handle completion of the currently active descriptor (@chan->desc.active). As
1037 * we currently support cyclic transfers only, this just invokes the cyclic
1038 * callback. The descriptor will be completed at the VSYNC interrupt when a new
1039 * descriptor replaces it.
1041 static void xilinx_dpdma_chan_done_irq(struct xilinx_dpdma_chan *chan)
1043 struct xilinx_dpdma_tx_desc *active;
1044 unsigned long flags;
1046 spin_lock_irqsave(&chan->lock, flags);
1048 xilinx_dpdma_debugfs_desc_done_irq(chan);
1050 active = chan->desc.active;
1052 vchan_cyclic_callback(&active->vdesc);
1054 dev_warn(chan->xdev->dev,
1055 "chan%u: DONE IRQ with no active descriptor!\n",
1058 spin_unlock_irqrestore(&chan->lock, flags);
1062 * xilinx_dpdma_chan_vsync_irq - Handle hardware descriptor scheduling
1063 * @chan: DPDMA channel
1065 * At VSYNC the active descriptor may have been replaced by the pending
1066 * descriptor. Detect this through the DESC_ID and perform appropriate
1069 static void xilinx_dpdma_chan_vsync_irq(struct xilinx_dpdma_chan *chan)
1071 struct xilinx_dpdma_tx_desc *pending;
1072 struct xilinx_dpdma_sw_desc *sw_desc;
1073 unsigned long flags;
1076 spin_lock_irqsave(&chan->lock, flags);
1078 pending = chan->desc.pending;
1079 if (!chan->running || !pending)
1082 desc_id = dpdma_read(chan->reg, XILINX_DPDMA_CH_DESC_ID)
1083 & XILINX_DPDMA_CH_DESC_ID_MASK;
1085 /* If the retrigger raced with vsync, retry at the next frame. */
1086 sw_desc = list_first_entry(&pending->descriptors,
1087 struct xilinx_dpdma_sw_desc, node);
1088 if (sw_desc->hw.desc_id != desc_id) {
1089 dev_dbg(chan->xdev->dev,
1090 "chan%u: vsync race lost (%u != %u), retrying\n",
1091 chan->id, sw_desc->hw.desc_id, desc_id);
1096 * Complete the active descriptor, if any, promote the pending
1097 * descriptor to active, and queue the next transfer, if any.
1099 if (chan->desc.active)
1100 vchan_cookie_complete(&chan->desc.active->vdesc);
1101 chan->desc.active = pending;
1102 chan->desc.pending = NULL;
1104 xilinx_dpdma_chan_queue_transfer(chan);
1107 spin_unlock_irqrestore(&chan->lock, flags);
1111 * xilinx_dpdma_chan_err - Detect any channel error
1112 * @chan: DPDMA channel
1113 * @isr: masked Interrupt Status Register
1114 * @eisr: Error Interrupt Status Register
1116 * Return: true if any channel error occurs, or false otherwise.
1119 xilinx_dpdma_chan_err(struct xilinx_dpdma_chan *chan, u32 isr, u32 eisr)
1124 if (chan->running &&
1125 ((isr & (XILINX_DPDMA_INTR_CHAN_ERR_MASK << chan->id)) ||
1126 (eisr & (XILINX_DPDMA_EINTR_CHAN_ERR_MASK << chan->id))))
1133 * xilinx_dpdma_chan_handle_err - DPDMA channel error handling
1134 * @chan: DPDMA channel
1136 * This function is called when any channel error or any global error occurs.
1137 * The function disables the paused channel by errors and determines
1138 * if the current active descriptor can be rescheduled depending on
1139 * the descriptor status.
1141 static void xilinx_dpdma_chan_handle_err(struct xilinx_dpdma_chan *chan)
1143 struct xilinx_dpdma_device *xdev = chan->xdev;
1144 struct xilinx_dpdma_tx_desc *active;
1145 unsigned long flags;
1147 spin_lock_irqsave(&chan->lock, flags);
1149 dev_dbg(xdev->dev, "chan%u: cur desc addr = 0x%04x%08x\n",
1151 dpdma_read(chan->reg, XILINX_DPDMA_CH_DESC_START_ADDRE),
1152 dpdma_read(chan->reg, XILINX_DPDMA_CH_DESC_START_ADDR));
1153 dev_dbg(xdev->dev, "chan%u: cur payload addr = 0x%04x%08x\n",
1155 dpdma_read(chan->reg, XILINX_DPDMA_CH_PYLD_CUR_ADDRE),
1156 dpdma_read(chan->reg, XILINX_DPDMA_CH_PYLD_CUR_ADDR));
1158 xilinx_dpdma_chan_disable(chan);
1159 chan->running = false;
1161 if (!chan->desc.active)
1164 active = chan->desc.active;
1165 chan->desc.active = NULL;
1167 xilinx_dpdma_chan_dump_tx_desc(chan, active);
1170 dev_dbg(xdev->dev, "chan%u: repeated error on desc\n",
1173 /* Reschedule if there's no new descriptor */
1174 if (!chan->desc.pending &&
1175 list_empty(&chan->vchan.desc_issued)) {
1176 active->error = true;
1177 list_add_tail(&active->vdesc.node,
1178 &chan->vchan.desc_issued);
1180 xilinx_dpdma_chan_free_tx_desc(&active->vdesc);
1184 spin_unlock_irqrestore(&chan->lock, flags);
1187 /* -----------------------------------------------------------------------------
1188 * DMA Engine Operations
1191 static struct dma_async_tx_descriptor *
1192 xilinx_dpdma_prep_interleaved_dma(struct dma_chan *dchan,
1193 struct dma_interleaved_template *xt,
1194 unsigned long flags)
1196 struct xilinx_dpdma_chan *chan = to_xilinx_chan(dchan);
1197 struct xilinx_dpdma_tx_desc *desc;
1199 if (xt->dir != DMA_MEM_TO_DEV)
1202 if (!xt->numf || !xt->sgl[0].size)
1205 if (!(flags & DMA_PREP_REPEAT) || !(flags & DMA_PREP_LOAD_EOT))
1208 desc = xilinx_dpdma_chan_prep_interleaved_dma(chan, xt);
1212 vchan_tx_prep(&chan->vchan, &desc->vdesc, flags | DMA_CTRL_ACK);
1214 return &desc->vdesc.tx;
1218 * xilinx_dpdma_alloc_chan_resources - Allocate resources for the channel
1219 * @dchan: DMA channel
1221 * Allocate a descriptor pool for the channel.
1223 * Return: 0 on success, or -ENOMEM if failed to allocate a pool.
1225 static int xilinx_dpdma_alloc_chan_resources(struct dma_chan *dchan)
1227 struct xilinx_dpdma_chan *chan = to_xilinx_chan(dchan);
1228 size_t align = __alignof__(struct xilinx_dpdma_sw_desc);
1230 chan->desc_pool = dma_pool_create(dev_name(chan->xdev->dev),
1232 sizeof(struct xilinx_dpdma_sw_desc),
1234 if (!chan->desc_pool) {
1235 dev_err(chan->xdev->dev,
1236 "chan%u: failed to allocate a descriptor pool\n",
1245 * xilinx_dpdma_free_chan_resources - Free all resources for the channel
1246 * @dchan: DMA channel
1248 * Free resources associated with the virtual DMA channel, and destroy the
1251 static void xilinx_dpdma_free_chan_resources(struct dma_chan *dchan)
1253 struct xilinx_dpdma_chan *chan = to_xilinx_chan(dchan);
1255 vchan_free_chan_resources(&chan->vchan);
1257 dma_pool_destroy(chan->desc_pool);
1258 chan->desc_pool = NULL;
1261 static void xilinx_dpdma_issue_pending(struct dma_chan *dchan)
1263 struct xilinx_dpdma_chan *chan = to_xilinx_chan(dchan);
1264 unsigned long flags;
1266 spin_lock_irqsave(&chan->vchan.lock, flags);
1267 if (vchan_issue_pending(&chan->vchan))
1268 xilinx_dpdma_chan_queue_transfer(chan);
1269 spin_unlock_irqrestore(&chan->vchan.lock, flags);
1272 static int xilinx_dpdma_config(struct dma_chan *dchan,
1273 struct dma_slave_config *config)
1275 struct xilinx_dpdma_chan *chan = to_xilinx_chan(dchan);
1276 unsigned long flags;
1279 * The destination address doesn't need to be specified as the DPDMA is
1280 * hardwired to the destination (the DP controller). The transfer
1281 * width, burst size and port window size are thus meaningless, they're
1282 * fixed both on the DPDMA side and on the DP controller side.
1285 spin_lock_irqsave(&chan->lock, flags);
1288 * Abuse the slave_id to indicate that the channel is part of a video
1291 if (chan->id <= ZYNQMP_DPDMA_VIDEO2)
1292 chan->video_group = config->slave_id != 0;
1294 spin_unlock_irqrestore(&chan->lock, flags);
1299 static int xilinx_dpdma_pause(struct dma_chan *dchan)
1301 xilinx_dpdma_chan_pause(to_xilinx_chan(dchan));
1306 static int xilinx_dpdma_resume(struct dma_chan *dchan)
1308 xilinx_dpdma_chan_unpause(to_xilinx_chan(dchan));
1314 * xilinx_dpdma_terminate_all - Terminate the channel and descriptors
1315 * @dchan: DMA channel
1317 * Pause the channel without waiting for ongoing transfers to complete. Waiting
1318 * for completion is performed by xilinx_dpdma_synchronize() that will disable
1319 * the channel to complete the stop.
1321 * All the descriptors associated with the channel that are guaranteed not to
1322 * be touched by the hardware. The pending and active descriptor are not
1323 * touched, and will be freed either upon completion, or by
1324 * xilinx_dpdma_synchronize().
1326 * Return: 0 on success, or -ETIMEDOUT if the channel failed to stop.
1328 static int xilinx_dpdma_terminate_all(struct dma_chan *dchan)
1330 struct xilinx_dpdma_chan *chan = to_xilinx_chan(dchan);
1331 struct xilinx_dpdma_device *xdev = chan->xdev;
1332 LIST_HEAD(descriptors);
1333 unsigned long flags;
1336 /* Pause the channel (including the whole video group if applicable). */
1337 if (chan->video_group) {
1338 for (i = ZYNQMP_DPDMA_VIDEO0; i <= ZYNQMP_DPDMA_VIDEO2; i++) {
1339 if (xdev->chan[i]->video_group &&
1340 xdev->chan[i]->running) {
1341 xilinx_dpdma_chan_pause(xdev->chan[i]);
1342 xdev->chan[i]->video_group = false;
1346 xilinx_dpdma_chan_pause(chan);
1349 /* Gather all the descriptors we can free and free them. */
1350 spin_lock_irqsave(&chan->vchan.lock, flags);
1351 vchan_get_all_descriptors(&chan->vchan, &descriptors);
1352 spin_unlock_irqrestore(&chan->vchan.lock, flags);
1354 vchan_dma_desc_free_list(&chan->vchan, &descriptors);
1360 * xilinx_dpdma_synchronize - Synchronize callback execution
1361 * @dchan: DMA channel
1363 * Synchronizing callback execution ensures that all previously issued
1364 * transfers have completed and all associated callbacks have been called and
1367 * This function waits for the DMA channel to stop. It assumes it has been
1368 * paused by a previous call to dmaengine_terminate_async(), and that no new
1369 * pending descriptors have been issued with dma_async_issue_pending(). The
1370 * behaviour is undefined otherwise.
1372 static void xilinx_dpdma_synchronize(struct dma_chan *dchan)
1374 struct xilinx_dpdma_chan *chan = to_xilinx_chan(dchan);
1375 unsigned long flags;
1377 xilinx_dpdma_chan_stop(chan);
1379 spin_lock_irqsave(&chan->vchan.lock, flags);
1380 if (chan->desc.pending) {
1381 vchan_terminate_vdesc(&chan->desc.pending->vdesc);
1382 chan->desc.pending = NULL;
1384 if (chan->desc.active) {
1385 vchan_terminate_vdesc(&chan->desc.active->vdesc);
1386 chan->desc.active = NULL;
1388 spin_unlock_irqrestore(&chan->vchan.lock, flags);
1390 vchan_synchronize(&chan->vchan);
1393 /* -----------------------------------------------------------------------------
1394 * Interrupt and Tasklet Handling
1398 * xilinx_dpdma_err - Detect any global error
1399 * @isr: Interrupt Status Register
1400 * @eisr: Error Interrupt Status Register
1402 * Return: True if any global error occurs, or false otherwise.
1404 static bool xilinx_dpdma_err(u32 isr, u32 eisr)
1406 if (isr & XILINX_DPDMA_INTR_GLOBAL_ERR ||
1407 eisr & XILINX_DPDMA_EINTR_GLOBAL_ERR)
1414 * xilinx_dpdma_handle_err_irq - Handle DPDMA error interrupt
1415 * @xdev: DPDMA device
1416 * @isr: masked Interrupt Status Register
1417 * @eisr: Error Interrupt Status Register
1419 * Handle if any error occurs based on @isr and @eisr. This function disables
1420 * corresponding error interrupts, and those should be re-enabled once handling
1423 static void xilinx_dpdma_handle_err_irq(struct xilinx_dpdma_device *xdev,
1426 bool err = xilinx_dpdma_err(isr, eisr);
1429 dev_dbg_ratelimited(xdev->dev,
1430 "error irq: isr = 0x%08x, eisr = 0x%08x\n",
1433 /* Disable channel error interrupts until errors are handled. */
1434 dpdma_write(xdev->reg, XILINX_DPDMA_IDS,
1435 isr & ~XILINX_DPDMA_INTR_GLOBAL_ERR);
1436 dpdma_write(xdev->reg, XILINX_DPDMA_EIDS,
1437 eisr & ~XILINX_DPDMA_EINTR_GLOBAL_ERR);
1439 for (i = 0; i < ARRAY_SIZE(xdev->chan); i++)
1440 if (err || xilinx_dpdma_chan_err(xdev->chan[i], isr, eisr))
1441 tasklet_schedule(&xdev->chan[i]->err_task);
1445 * xilinx_dpdma_enable_irq - Enable interrupts
1446 * @xdev: DPDMA device
1448 * Enable interrupts.
1450 static void xilinx_dpdma_enable_irq(struct xilinx_dpdma_device *xdev)
1452 dpdma_write(xdev->reg, XILINX_DPDMA_IEN, XILINX_DPDMA_INTR_ALL);
1453 dpdma_write(xdev->reg, XILINX_DPDMA_EIEN, XILINX_DPDMA_EINTR_ALL);
1457 * xilinx_dpdma_disable_irq - Disable interrupts
1458 * @xdev: DPDMA device
1460 * Disable interrupts.
1462 static void xilinx_dpdma_disable_irq(struct xilinx_dpdma_device *xdev)
1464 dpdma_write(xdev->reg, XILINX_DPDMA_IDS, XILINX_DPDMA_INTR_ALL);
1465 dpdma_write(xdev->reg, XILINX_DPDMA_EIDS, XILINX_DPDMA_EINTR_ALL);
1469 * xilinx_dpdma_chan_err_task - Per channel tasklet for error handling
1470 * @t: pointer to the tasklet associated with this handler
1472 * Per channel error handling tasklet. This function waits for the outstanding
1473 * transaction to complete and triggers error handling. After error handling,
1474 * re-enable channel error interrupts, and restart the channel if needed.
1476 static void xilinx_dpdma_chan_err_task(struct tasklet_struct *t)
1478 struct xilinx_dpdma_chan *chan = from_tasklet(chan, t, err_task);
1479 struct xilinx_dpdma_device *xdev = chan->xdev;
1480 unsigned long flags;
1482 /* Proceed error handling even when polling fails. */
1483 xilinx_dpdma_chan_poll_no_ostand(chan);
1485 xilinx_dpdma_chan_handle_err(chan);
1487 dpdma_write(xdev->reg, XILINX_DPDMA_IEN,
1488 XILINX_DPDMA_INTR_CHAN_ERR_MASK << chan->id);
1489 dpdma_write(xdev->reg, XILINX_DPDMA_EIEN,
1490 XILINX_DPDMA_EINTR_CHAN_ERR_MASK << chan->id);
1492 spin_lock_irqsave(&chan->lock, flags);
1493 xilinx_dpdma_chan_queue_transfer(chan);
1494 spin_unlock_irqrestore(&chan->lock, flags);
1497 static irqreturn_t xilinx_dpdma_irq_handler(int irq, void *data)
1499 struct xilinx_dpdma_device *xdev = data;
1505 status = dpdma_read(xdev->reg, XILINX_DPDMA_ISR);
1506 error = dpdma_read(xdev->reg, XILINX_DPDMA_EISR);
1507 if (!status && !error)
1510 dpdma_write(xdev->reg, XILINX_DPDMA_ISR, status);
1511 dpdma_write(xdev->reg, XILINX_DPDMA_EISR, error);
1513 if (status & XILINX_DPDMA_INTR_VSYNC) {
1515 * There's a single VSYNC interrupt that needs to be processed
1516 * by each running channel to update the active descriptor.
1518 for (i = 0; i < ARRAY_SIZE(xdev->chan); i++) {
1519 struct xilinx_dpdma_chan *chan = xdev->chan[i];
1522 xilinx_dpdma_chan_vsync_irq(chan);
1526 mask = FIELD_GET(XILINX_DPDMA_INTR_DESC_DONE_MASK, status);
1528 for_each_set_bit(i, &mask, ARRAY_SIZE(xdev->chan))
1529 xilinx_dpdma_chan_done_irq(xdev->chan[i]);
1532 mask = FIELD_GET(XILINX_DPDMA_INTR_NO_OSTAND_MASK, status);
1534 for_each_set_bit(i, &mask, ARRAY_SIZE(xdev->chan))
1535 xilinx_dpdma_chan_notify_no_ostand(xdev->chan[i]);
1538 mask = status & XILINX_DPDMA_INTR_ERR_ALL;
1540 xilinx_dpdma_handle_err_irq(xdev, mask, error);
1545 /* -----------------------------------------------------------------------------
1546 * Initialization & Cleanup
1549 static int xilinx_dpdma_chan_init(struct xilinx_dpdma_device *xdev,
1550 unsigned int chan_id)
1552 struct xilinx_dpdma_chan *chan;
1554 chan = devm_kzalloc(xdev->dev, sizeof(*chan), GFP_KERNEL);
1559 chan->reg = xdev->reg + XILINX_DPDMA_CH_BASE
1560 + XILINX_DPDMA_CH_OFFSET * chan->id;
1561 chan->running = false;
1564 spin_lock_init(&chan->lock);
1565 init_waitqueue_head(&chan->wait_to_stop);
1567 tasklet_setup(&chan->err_task, xilinx_dpdma_chan_err_task);
1569 chan->vchan.desc_free = xilinx_dpdma_chan_free_tx_desc;
1570 vchan_init(&chan->vchan, &xdev->common);
1572 xdev->chan[chan->id] = chan;
1577 static void xilinx_dpdma_chan_remove(struct xilinx_dpdma_chan *chan)
1582 tasklet_kill(&chan->err_task);
1583 list_del(&chan->vchan.chan.device_node);
1586 static struct dma_chan *of_dma_xilinx_xlate(struct of_phandle_args *dma_spec,
1587 struct of_dma *ofdma)
1589 struct xilinx_dpdma_device *xdev = ofdma->of_dma_data;
1590 u32 chan_id = dma_spec->args[0];
1592 if (chan_id >= ARRAY_SIZE(xdev->chan))
1595 if (!xdev->chan[chan_id])
1598 return dma_get_slave_channel(&xdev->chan[chan_id]->vchan.chan);
1601 static void dpdma_hw_init(struct xilinx_dpdma_device *xdev)
1606 /* Disable all interrupts */
1607 xilinx_dpdma_disable_irq(xdev);
1609 /* Stop all channels */
1610 for (i = 0; i < ARRAY_SIZE(xdev->chan); i++) {
1611 reg = xdev->reg + XILINX_DPDMA_CH_BASE
1612 + XILINX_DPDMA_CH_OFFSET * i;
1613 dpdma_clr(reg, XILINX_DPDMA_CH_CNTL, XILINX_DPDMA_CH_CNTL_ENABLE);
1616 /* Clear the interrupt status registers */
1617 dpdma_write(xdev->reg, XILINX_DPDMA_ISR, XILINX_DPDMA_INTR_ALL);
1618 dpdma_write(xdev->reg, XILINX_DPDMA_EISR, XILINX_DPDMA_EINTR_ALL);
1621 static int xilinx_dpdma_probe(struct platform_device *pdev)
1623 struct xilinx_dpdma_device *xdev;
1624 struct dma_device *ddev;
1628 xdev = devm_kzalloc(&pdev->dev, sizeof(*xdev), GFP_KERNEL);
1632 xdev->dev = &pdev->dev;
1633 xdev->ext_addr = sizeof(dma_addr_t) > 4;
1635 INIT_LIST_HEAD(&xdev->common.channels);
1637 platform_set_drvdata(pdev, xdev);
1639 xdev->axi_clk = devm_clk_get(xdev->dev, "axi_clk");
1640 if (IS_ERR(xdev->axi_clk))
1641 return PTR_ERR(xdev->axi_clk);
1643 xdev->reg = devm_platform_ioremap_resource(pdev, 0);
1644 if (IS_ERR(xdev->reg))
1645 return PTR_ERR(xdev->reg);
1647 dpdma_hw_init(xdev);
1649 xdev->irq = platform_get_irq(pdev, 0);
1650 if (xdev->irq < 0) {
1651 dev_err(xdev->dev, "failed to get platform irq\n");
1655 ret = request_irq(xdev->irq, xilinx_dpdma_irq_handler, IRQF_SHARED,
1656 dev_name(xdev->dev), xdev);
1658 dev_err(xdev->dev, "failed to request IRQ\n");
1662 ddev = &xdev->common;
1663 ddev->dev = &pdev->dev;
1665 dma_cap_set(DMA_SLAVE, ddev->cap_mask);
1666 dma_cap_set(DMA_PRIVATE, ddev->cap_mask);
1667 dma_cap_set(DMA_INTERLEAVE, ddev->cap_mask);
1668 dma_cap_set(DMA_REPEAT, ddev->cap_mask);
1669 dma_cap_set(DMA_LOAD_EOT, ddev->cap_mask);
1670 ddev->copy_align = fls(XILINX_DPDMA_ALIGN_BYTES - 1);
1672 ddev->device_alloc_chan_resources = xilinx_dpdma_alloc_chan_resources;
1673 ddev->device_free_chan_resources = xilinx_dpdma_free_chan_resources;
1674 ddev->device_prep_interleaved_dma = xilinx_dpdma_prep_interleaved_dma;
1675 /* TODO: Can we achieve better granularity ? */
1676 ddev->device_tx_status = dma_cookie_status;
1677 ddev->device_issue_pending = xilinx_dpdma_issue_pending;
1678 ddev->device_config = xilinx_dpdma_config;
1679 ddev->device_pause = xilinx_dpdma_pause;
1680 ddev->device_resume = xilinx_dpdma_resume;
1681 ddev->device_terminate_all = xilinx_dpdma_terminate_all;
1682 ddev->device_synchronize = xilinx_dpdma_synchronize;
1683 ddev->src_addr_widths = BIT(DMA_SLAVE_BUSWIDTH_UNDEFINED);
1684 ddev->directions = BIT(DMA_MEM_TO_DEV);
1685 ddev->residue_granularity = DMA_RESIDUE_GRANULARITY_DESCRIPTOR;
1687 for (i = 0; i < ARRAY_SIZE(xdev->chan); ++i) {
1688 ret = xilinx_dpdma_chan_init(xdev, i);
1690 dev_err(xdev->dev, "failed to initialize channel %u\n",
1696 ret = clk_prepare_enable(xdev->axi_clk);
1698 dev_err(xdev->dev, "failed to enable the axi clock\n");
1702 ret = dma_async_device_register(ddev);
1704 dev_err(xdev->dev, "failed to register the dma device\n");
1705 goto error_dma_async;
1708 ret = of_dma_controller_register(xdev->dev->of_node,
1709 of_dma_xilinx_xlate, ddev);
1711 dev_err(xdev->dev, "failed to register DMA to DT DMA helper\n");
1715 xilinx_dpdma_enable_irq(xdev);
1717 xilinx_dpdma_debugfs_init(xdev);
1719 dev_info(&pdev->dev, "Xilinx DPDMA engine is probed\n");
1724 dma_async_device_unregister(ddev);
1726 clk_disable_unprepare(xdev->axi_clk);
1728 for (i = 0; i < ARRAY_SIZE(xdev->chan); i++)
1729 xilinx_dpdma_chan_remove(xdev->chan[i]);
1731 free_irq(xdev->irq, xdev);
1736 static int xilinx_dpdma_remove(struct platform_device *pdev)
1738 struct xilinx_dpdma_device *xdev = platform_get_drvdata(pdev);
1741 /* Start by disabling the IRQ to avoid races during cleanup. */
1742 free_irq(xdev->irq, xdev);
1744 xilinx_dpdma_disable_irq(xdev);
1745 of_dma_controller_free(pdev->dev.of_node);
1746 dma_async_device_unregister(&xdev->common);
1747 clk_disable_unprepare(xdev->axi_clk);
1749 for (i = 0; i < ARRAY_SIZE(xdev->chan); i++)
1750 xilinx_dpdma_chan_remove(xdev->chan[i]);
1755 static const struct of_device_id xilinx_dpdma_of_match[] = {
1756 { .compatible = "xlnx,zynqmp-dpdma",},
1757 { /* end of table */ },
1759 MODULE_DEVICE_TABLE(of, xilinx_dpdma_of_match);
1761 static struct platform_driver xilinx_dpdma_driver = {
1762 .probe = xilinx_dpdma_probe,
1763 .remove = xilinx_dpdma_remove,
1765 .name = "xilinx-zynqmp-dpdma",
1766 .of_match_table = xilinx_dpdma_of_match,
1770 module_platform_driver(xilinx_dpdma_driver);
1772 MODULE_AUTHOR("Xilinx, Inc.");
1773 MODULE_DESCRIPTION("Xilinx ZynqMP DPDMA driver");
1774 MODULE_LICENSE("GPL v2");