1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright(c) 2019 HiSilicon Limited. */
3 #include <linux/bitfield.h>
4 #include <linux/dmaengine.h>
5 #include <linux/init.h>
6 #include <linux/iopoll.h>
7 #include <linux/module.h>
9 #include <linux/spinlock.h>
12 #define HISI_DMA_SQ_BASE_L 0x0
13 #define HISI_DMA_SQ_BASE_H 0x4
14 #define HISI_DMA_SQ_DEPTH 0x8
15 #define HISI_DMA_SQ_TAIL_PTR 0xc
16 #define HISI_DMA_CQ_BASE_L 0x10
17 #define HISI_DMA_CQ_BASE_H 0x14
18 #define HISI_DMA_CQ_DEPTH 0x18
19 #define HISI_DMA_CQ_HEAD_PTR 0x1c
20 #define HISI_DMA_CTRL0 0x20
21 #define HISI_DMA_CTRL0_QUEUE_EN_S 0
22 #define HISI_DMA_CTRL0_QUEUE_PAUSE_S 4
23 #define HISI_DMA_CTRL1 0x24
24 #define HISI_DMA_CTRL1_QUEUE_RESET_S 0
25 #define HISI_DMA_Q_FSM_STS 0x30
26 #define HISI_DMA_FSM_STS_MASK GENMASK(3, 0)
27 #define HISI_DMA_INT_STS 0x40
28 #define HISI_DMA_INT_STS_MASK GENMASK(12, 0)
29 #define HISI_DMA_INT_MSK 0x44
30 #define HISI_DMA_MODE 0x217c
31 #define HISI_DMA_OFFSET 0x100
33 #define HISI_DMA_MSI_NUM 32
34 #define HISI_DMA_CHAN_NUM 30
35 #define HISI_DMA_Q_DEPTH_VAL 1024
44 enum hisi_dma_chan_status {
58 #define OPCODE_MASK GENMASK(3, 0)
59 #define OPCODE_SMALL_PACKAGE 0x1
60 #define OPCODE_M2M 0x4
61 #define LOCAL_IRQ_EN BIT(8)
62 #define ATTR_SRC_MASK GENMASK(14, 12)
65 #define ATTR_DST_MASK GENMASK(26, 24)
78 #define STATUS_MASK GENMASK(15, 1)
79 #define STATUS_SUCC 0x0
80 #define VALID_BIT BIT(0)
83 struct hisi_dma_desc {
84 struct virt_dma_desc vd;
85 struct hisi_dma_sqe sqe;
88 struct hisi_dma_chan {
89 struct virt_dma_chan vc;
90 struct hisi_dma_dev *hdma_dev;
91 struct hisi_dma_sqe *sq;
92 struct hisi_dma_cqe *cq;
98 enum hisi_dma_chan_status status;
99 struct hisi_dma_desc *desc;
102 struct hisi_dma_dev {
103 struct pci_dev *pdev;
105 struct dma_device dma_dev;
108 struct hisi_dma_chan chan[];
111 static inline struct hisi_dma_chan *to_hisi_dma_chan(struct dma_chan *c)
113 return container_of(c, struct hisi_dma_chan, vc.chan);
116 static inline struct hisi_dma_desc *to_hisi_dma_desc(struct virt_dma_desc *vd)
118 return container_of(vd, struct hisi_dma_desc, vd);
121 static inline void hisi_dma_chan_write(void __iomem *base, u32 reg, u32 index,
124 writel_relaxed(val, base + reg + index * HISI_DMA_OFFSET);
127 static inline void hisi_dma_update_bit(void __iomem *addr, u32 pos, bool val)
131 tmp = readl_relaxed(addr);
132 tmp = val ? tmp | BIT(pos) : tmp & ~BIT(pos);
133 writel_relaxed(tmp, addr);
136 static void hisi_dma_pause_dma(struct hisi_dma_dev *hdma_dev, u32 index,
139 void __iomem *addr = hdma_dev->base + HISI_DMA_CTRL0 + index *
142 hisi_dma_update_bit(addr, HISI_DMA_CTRL0_QUEUE_PAUSE_S, pause);
145 static void hisi_dma_enable_dma(struct hisi_dma_dev *hdma_dev, u32 index,
148 void __iomem *addr = hdma_dev->base + HISI_DMA_CTRL0 + index *
151 hisi_dma_update_bit(addr, HISI_DMA_CTRL0_QUEUE_EN_S, enable);
154 static void hisi_dma_mask_irq(struct hisi_dma_dev *hdma_dev, u32 qp_index)
156 hisi_dma_chan_write(hdma_dev->base, HISI_DMA_INT_MSK, qp_index,
157 HISI_DMA_INT_STS_MASK);
160 static void hisi_dma_unmask_irq(struct hisi_dma_dev *hdma_dev, u32 qp_index)
162 void __iomem *base = hdma_dev->base;
164 hisi_dma_chan_write(base, HISI_DMA_INT_STS, qp_index,
165 HISI_DMA_INT_STS_MASK);
166 hisi_dma_chan_write(base, HISI_DMA_INT_MSK, qp_index, 0);
169 static void hisi_dma_do_reset(struct hisi_dma_dev *hdma_dev, u32 index)
171 void __iomem *addr = hdma_dev->base + HISI_DMA_CTRL1 + index *
174 hisi_dma_update_bit(addr, HISI_DMA_CTRL1_QUEUE_RESET_S, 1);
177 static void hisi_dma_reset_qp_point(struct hisi_dma_dev *hdma_dev, u32 index)
179 hisi_dma_chan_write(hdma_dev->base, HISI_DMA_SQ_TAIL_PTR, index, 0);
180 hisi_dma_chan_write(hdma_dev->base, HISI_DMA_CQ_HEAD_PTR, index, 0);
183 static void hisi_dma_reset_or_disable_hw_chan(struct hisi_dma_chan *chan,
186 struct hisi_dma_dev *hdma_dev = chan->hdma_dev;
187 u32 index = chan->qp_num, tmp;
190 hisi_dma_pause_dma(hdma_dev, index, true);
191 hisi_dma_enable_dma(hdma_dev, index, false);
192 hisi_dma_mask_irq(hdma_dev, index);
194 ret = readl_relaxed_poll_timeout(hdma_dev->base +
195 HISI_DMA_Q_FSM_STS + index * HISI_DMA_OFFSET, tmp,
196 FIELD_GET(HISI_DMA_FSM_STS_MASK, tmp) != RUN, 10, 1000);
198 dev_err(&hdma_dev->pdev->dev, "disable channel timeout!\n");
202 hisi_dma_do_reset(hdma_dev, index);
203 hisi_dma_reset_qp_point(hdma_dev, index);
204 hisi_dma_pause_dma(hdma_dev, index, false);
207 hisi_dma_enable_dma(hdma_dev, index, true);
208 hisi_dma_unmask_irq(hdma_dev, index);
211 ret = readl_relaxed_poll_timeout(hdma_dev->base +
212 HISI_DMA_Q_FSM_STS + index * HISI_DMA_OFFSET, tmp,
213 FIELD_GET(HISI_DMA_FSM_STS_MASK, tmp) == IDLE, 10, 1000);
215 dev_err(&hdma_dev->pdev->dev, "reset channel timeout!\n");
220 static void hisi_dma_free_chan_resources(struct dma_chan *c)
222 struct hisi_dma_chan *chan = to_hisi_dma_chan(c);
223 struct hisi_dma_dev *hdma_dev = chan->hdma_dev;
225 hisi_dma_reset_or_disable_hw_chan(chan, false);
226 vchan_free_chan_resources(&chan->vc);
228 memset(chan->sq, 0, sizeof(struct hisi_dma_sqe) * hdma_dev->chan_depth);
229 memset(chan->cq, 0, sizeof(struct hisi_dma_cqe) * hdma_dev->chan_depth);
232 chan->status = DISABLE;
235 static void hisi_dma_desc_free(struct virt_dma_desc *vd)
237 kfree(to_hisi_dma_desc(vd));
240 static struct dma_async_tx_descriptor *
241 hisi_dma_prep_dma_memcpy(struct dma_chan *c, dma_addr_t dst, dma_addr_t src,
242 size_t len, unsigned long flags)
244 struct hisi_dma_chan *chan = to_hisi_dma_chan(c);
245 struct hisi_dma_desc *desc;
247 desc = kzalloc(sizeof(*desc), GFP_NOWAIT);
251 desc->sqe.length = cpu_to_le32(len);
252 desc->sqe.src_addr = cpu_to_le64(src);
253 desc->sqe.dst_addr = cpu_to_le64(dst);
255 return vchan_tx_prep(&chan->vc, &desc->vd, flags);
258 static enum dma_status
259 hisi_dma_tx_status(struct dma_chan *c, dma_cookie_t cookie,
260 struct dma_tx_state *txstate)
262 return dma_cookie_status(c, cookie, txstate);
265 static void hisi_dma_start_transfer(struct hisi_dma_chan *chan)
267 struct hisi_dma_sqe *sqe = chan->sq + chan->sq_tail;
268 struct hisi_dma_dev *hdma_dev = chan->hdma_dev;
269 struct hisi_dma_desc *desc;
270 struct virt_dma_desc *vd;
272 vd = vchan_next_desc(&chan->vc);
278 desc = to_hisi_dma_desc(vd);
281 memcpy(sqe, &desc->sqe, sizeof(struct hisi_dma_sqe));
283 /* update other field in sqe */
284 sqe->dw0 = cpu_to_le32(FIELD_PREP(OPCODE_MASK, OPCODE_M2M));
285 sqe->dw0 |= cpu_to_le32(LOCAL_IRQ_EN);
287 /* make sure data has been updated in sqe */
290 /* update sq tail, point to new sqe position */
291 chan->sq_tail = (chan->sq_tail + 1) % hdma_dev->chan_depth;
293 /* update sq_tail to trigger a new task */
294 hisi_dma_chan_write(hdma_dev->base, HISI_DMA_SQ_TAIL_PTR, chan->qp_num,
298 static void hisi_dma_issue_pending(struct dma_chan *c)
300 struct hisi_dma_chan *chan = to_hisi_dma_chan(c);
303 spin_lock_irqsave(&chan->vc.lock, flags);
305 if (vchan_issue_pending(&chan->vc) && !chan->desc)
306 hisi_dma_start_transfer(chan);
308 spin_unlock_irqrestore(&chan->vc.lock, flags);
311 static int hisi_dma_terminate_all(struct dma_chan *c)
313 struct hisi_dma_chan *chan = to_hisi_dma_chan(c);
317 spin_lock_irqsave(&chan->vc.lock, flags);
319 hisi_dma_pause_dma(chan->hdma_dev, chan->qp_num, true);
321 vchan_terminate_vdesc(&chan->desc->vd);
325 vchan_get_all_descriptors(&chan->vc, &head);
327 spin_unlock_irqrestore(&chan->vc.lock, flags);
329 vchan_dma_desc_free_list(&chan->vc, &head);
330 hisi_dma_pause_dma(chan->hdma_dev, chan->qp_num, false);
335 static void hisi_dma_synchronize(struct dma_chan *c)
337 struct hisi_dma_chan *chan = to_hisi_dma_chan(c);
339 vchan_synchronize(&chan->vc);
342 static int hisi_dma_alloc_qps_mem(struct hisi_dma_dev *hdma_dev)
344 size_t sq_size = sizeof(struct hisi_dma_sqe) * hdma_dev->chan_depth;
345 size_t cq_size = sizeof(struct hisi_dma_cqe) * hdma_dev->chan_depth;
346 struct device *dev = &hdma_dev->pdev->dev;
347 struct hisi_dma_chan *chan;
350 for (i = 0; i < hdma_dev->chan_num; i++) {
351 chan = &hdma_dev->chan[i];
352 chan->sq = dmam_alloc_coherent(dev, sq_size, &chan->sq_dma,
357 chan->cq = dmam_alloc_coherent(dev, cq_size, &chan->cq_dma,
366 static void hisi_dma_init_hw_qp(struct hisi_dma_dev *hdma_dev, u32 index)
368 struct hisi_dma_chan *chan = &hdma_dev->chan[index];
369 u32 hw_depth = hdma_dev->chan_depth - 1;
370 void __iomem *base = hdma_dev->base;
372 /* set sq, cq base */
373 hisi_dma_chan_write(base, HISI_DMA_SQ_BASE_L, index,
374 lower_32_bits(chan->sq_dma));
375 hisi_dma_chan_write(base, HISI_DMA_SQ_BASE_H, index,
376 upper_32_bits(chan->sq_dma));
377 hisi_dma_chan_write(base, HISI_DMA_CQ_BASE_L, index,
378 lower_32_bits(chan->cq_dma));
379 hisi_dma_chan_write(base, HISI_DMA_CQ_BASE_H, index,
380 upper_32_bits(chan->cq_dma));
382 /* set sq, cq depth */
383 hisi_dma_chan_write(base, HISI_DMA_SQ_DEPTH, index, hw_depth);
384 hisi_dma_chan_write(base, HISI_DMA_CQ_DEPTH, index, hw_depth);
386 /* init sq tail and cq head */
387 hisi_dma_chan_write(base, HISI_DMA_SQ_TAIL_PTR, index, 0);
388 hisi_dma_chan_write(base, HISI_DMA_CQ_HEAD_PTR, index, 0);
391 static void hisi_dma_enable_qp(struct hisi_dma_dev *hdma_dev, u32 qp_index)
393 hisi_dma_init_hw_qp(hdma_dev, qp_index);
394 hisi_dma_unmask_irq(hdma_dev, qp_index);
395 hisi_dma_enable_dma(hdma_dev, qp_index, true);
398 static void hisi_dma_disable_qp(struct hisi_dma_dev *hdma_dev, u32 qp_index)
400 hisi_dma_reset_or_disable_hw_chan(&hdma_dev->chan[qp_index], true);
403 static void hisi_dma_enable_qps(struct hisi_dma_dev *hdma_dev)
407 for (i = 0; i < hdma_dev->chan_num; i++) {
408 hdma_dev->chan[i].qp_num = i;
409 hdma_dev->chan[i].hdma_dev = hdma_dev;
410 hdma_dev->chan[i].vc.desc_free = hisi_dma_desc_free;
411 vchan_init(&hdma_dev->chan[i].vc, &hdma_dev->dma_dev);
412 hisi_dma_enable_qp(hdma_dev, i);
416 static void hisi_dma_disable_qps(struct hisi_dma_dev *hdma_dev)
420 for (i = 0; i < hdma_dev->chan_num; i++) {
421 hisi_dma_disable_qp(hdma_dev, i);
422 tasklet_kill(&hdma_dev->chan[i].vc.task);
426 static irqreturn_t hisi_dma_irq(int irq, void *data)
428 struct hisi_dma_chan *chan = data;
429 struct hisi_dma_dev *hdma_dev = chan->hdma_dev;
430 struct hisi_dma_desc *desc;
431 struct hisi_dma_cqe *cqe;
433 spin_lock(&chan->vc.lock);
436 cqe = chan->cq + chan->cq_head;
438 chan->cq_head = (chan->cq_head + 1) % hdma_dev->chan_depth;
439 hisi_dma_chan_write(hdma_dev->base, HISI_DMA_CQ_HEAD_PTR,
440 chan->qp_num, chan->cq_head);
441 if (FIELD_GET(STATUS_MASK, cqe->w0) == STATUS_SUCC) {
442 vchan_cookie_complete(&desc->vd);
443 hisi_dma_start_transfer(chan);
445 dev_err(&hdma_dev->pdev->dev, "task error!\n");
449 spin_unlock(&chan->vc.lock);
454 static int hisi_dma_request_qps_irq(struct hisi_dma_dev *hdma_dev)
456 struct pci_dev *pdev = hdma_dev->pdev;
459 for (i = 0; i < hdma_dev->chan_num; i++) {
460 ret = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, i),
461 hisi_dma_irq, IRQF_SHARED, "hisi_dma",
470 /* This function enables all hw channels in a device */
471 static int hisi_dma_enable_hw_channels(struct hisi_dma_dev *hdma_dev)
475 ret = hisi_dma_alloc_qps_mem(hdma_dev);
477 dev_err(&hdma_dev->pdev->dev, "fail to allocate qp memory!\n");
481 ret = hisi_dma_request_qps_irq(hdma_dev);
483 dev_err(&hdma_dev->pdev->dev, "fail to request qp irq!\n");
487 hisi_dma_enable_qps(hdma_dev);
492 static void hisi_dma_disable_hw_channels(void *data)
494 hisi_dma_disable_qps(data);
497 static void hisi_dma_set_mode(struct hisi_dma_dev *hdma_dev,
498 enum hisi_dma_mode mode)
500 writel_relaxed(mode == RC ? 1 : 0, hdma_dev->base + HISI_DMA_MODE);
503 static int hisi_dma_probe(struct pci_dev *pdev, const struct pci_device_id *id)
505 struct device *dev = &pdev->dev;
506 struct hisi_dma_dev *hdma_dev;
507 struct dma_device *dma_dev;
510 ret = pcim_enable_device(pdev);
512 dev_err(dev, "failed to enable device mem!\n");
516 ret = pcim_iomap_regions(pdev, 1 << PCI_BAR_2, pci_name(pdev));
518 dev_err(dev, "failed to remap I/O region!\n");
522 ret = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
526 ret = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
530 hdma_dev = devm_kzalloc(dev, struct_size(hdma_dev, chan, HISI_DMA_CHAN_NUM), GFP_KERNEL);
534 hdma_dev->base = pcim_iomap_table(pdev)[PCI_BAR_2];
535 hdma_dev->pdev = pdev;
536 hdma_dev->chan_num = HISI_DMA_CHAN_NUM;
537 hdma_dev->chan_depth = HISI_DMA_Q_DEPTH_VAL;
539 pci_set_drvdata(pdev, hdma_dev);
540 pci_set_master(pdev);
542 /* This will be freed by 'pcim_release()'. See 'pcim_enable_device()' */
543 ret = pci_alloc_irq_vectors(pdev, HISI_DMA_MSI_NUM, HISI_DMA_MSI_NUM,
546 dev_err(dev, "Failed to allocate MSI vectors!\n");
550 dma_dev = &hdma_dev->dma_dev;
551 dma_cap_set(DMA_MEMCPY, dma_dev->cap_mask);
552 dma_dev->device_free_chan_resources = hisi_dma_free_chan_resources;
553 dma_dev->device_prep_dma_memcpy = hisi_dma_prep_dma_memcpy;
554 dma_dev->device_tx_status = hisi_dma_tx_status;
555 dma_dev->device_issue_pending = hisi_dma_issue_pending;
556 dma_dev->device_terminate_all = hisi_dma_terminate_all;
557 dma_dev->device_synchronize = hisi_dma_synchronize;
558 dma_dev->directions = BIT(DMA_MEM_TO_MEM);
560 INIT_LIST_HEAD(&dma_dev->channels);
562 hisi_dma_set_mode(hdma_dev, RC);
564 ret = hisi_dma_enable_hw_channels(hdma_dev);
566 dev_err(dev, "failed to enable hw channel!\n");
570 ret = devm_add_action_or_reset(dev, hisi_dma_disable_hw_channels,
575 ret = dmaenginem_async_device_register(dma_dev);
577 dev_err(dev, "failed to register device!\n");
582 static const struct pci_device_id hisi_dma_pci_tbl[] = {
583 { PCI_DEVICE(PCI_VENDOR_ID_HUAWEI, 0xa122) },
587 static struct pci_driver hisi_dma_pci_driver = {
589 .id_table = hisi_dma_pci_tbl,
590 .probe = hisi_dma_probe,
593 module_pci_driver(hisi_dma_pci_driver);
595 MODULE_AUTHOR("Zhou Wang <wangzhou1@hisilicon.com>");
596 MODULE_AUTHOR("Zhenfa Qiu <qiuzhenfa@hisilicon.com>");
597 MODULE_DESCRIPTION("HiSilicon Kunpeng DMA controller driver");
598 MODULE_LICENSE("GPL v2");
599 MODULE_DEVICE_TABLE(pci, hisi_dma_pci_tbl);