1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2018-2019 Synopsys, Inc. and/or its affiliates.
4 * Synopsys DesignWare eDMA PCIe driver
6 * Author: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/pci.h>
12 #include <linux/device.h>
13 #include <linux/dma/edma.h>
14 #include <linux/pci-epf.h>
15 #include <linux/msi.h>
16 #include <linux/bitfield.h>
18 #include "dw-edma-core.h"
20 #define DW_PCIE_VSEC_DMA_ID 0x6
21 #define DW_PCIE_VSEC_DMA_BAR GENMASK(10, 8)
22 #define DW_PCIE_VSEC_DMA_MAP GENMASK(2, 0)
23 #define DW_PCIE_VSEC_DMA_WR_CH GENMASK(9, 0)
24 #define DW_PCIE_VSEC_DMA_RD_CH GENMASK(25, 16)
26 #define DW_BLOCK(a, b, c) \
33 struct dw_edma_block {
39 struct dw_edma_pcie_data {
40 /* eDMA registers location */
41 struct dw_edma_block rg;
42 /* eDMA memory linked list location */
43 struct dw_edma_block ll_wr[EDMA_MAX_WR_CH];
44 struct dw_edma_block ll_rd[EDMA_MAX_RD_CH];
45 /* eDMA memory data location */
46 struct dw_edma_block dt_wr[EDMA_MAX_WR_CH];
47 struct dw_edma_block dt_rd[EDMA_MAX_RD_CH];
49 enum dw_edma_map_format mf;
55 static const struct dw_edma_pcie_data snps_edda_data = {
56 /* eDMA registers location */
58 .rg.off = 0x00001000, /* 4 Kbytes */
59 .rg.sz = 0x00002000, /* 8 Kbytes */
60 /* eDMA memory linked list location */
62 /* Channel 0 - BAR 2, offset 0 Mbytes, size 2 Kbytes */
63 DW_BLOCK(BAR_2, 0x00000000, 0x00000800)
64 /* Channel 1 - BAR 2, offset 2 Mbytes, size 2 Kbytes */
65 DW_BLOCK(BAR_2, 0x00200000, 0x00000800)
68 /* Channel 0 - BAR 2, offset 4 Mbytes, size 2 Kbytes */
69 DW_BLOCK(BAR_2, 0x00400000, 0x00000800)
70 /* Channel 1 - BAR 2, offset 6 Mbytes, size 2 Kbytes */
71 DW_BLOCK(BAR_2, 0x00600000, 0x00000800)
73 /* eDMA memory data location */
75 /* Channel 0 - BAR 2, offset 8 Mbytes, size 2 Kbytes */
76 DW_BLOCK(BAR_2, 0x00800000, 0x00000800)
77 /* Channel 1 - BAR 2, offset 9 Mbytes, size 2 Kbytes */
78 DW_BLOCK(BAR_2, 0x00900000, 0x00000800)
81 /* Channel 0 - BAR 2, offset 10 Mbytes, size 2 Kbytes */
82 DW_BLOCK(BAR_2, 0x00a00000, 0x00000800)
83 /* Channel 1 - BAR 2, offset 11 Mbytes, size 2 Kbytes */
84 DW_BLOCK(BAR_2, 0x00b00000, 0x00000800)
87 .mf = EDMA_MF_EDMA_UNROLL,
93 static int dw_edma_pcie_irq_vector(struct device *dev, unsigned int nr)
95 return pci_irq_vector(to_pci_dev(dev), nr);
98 static const struct dw_edma_core_ops dw_edma_pcie_core_ops = {
99 .irq_vector = dw_edma_pcie_irq_vector,
102 static void dw_edma_pcie_get_vsec_dma_data(struct pci_dev *pdev,
103 struct dw_edma_pcie_data *pdata)
109 vsec = pci_find_vsec_capability(pdev, PCI_VENDOR_ID_SYNOPSYS,
110 DW_PCIE_VSEC_DMA_ID);
114 pci_read_config_dword(pdev, vsec + PCI_VNDR_HEADER, &val);
115 if (PCI_VNDR_HEADER_REV(val) != 0x00 ||
116 PCI_VNDR_HEADER_LEN(val) != 0x18)
119 pci_dbg(pdev, "Detected PCIe Vendor-Specific Extended Capability DMA\n");
120 pci_read_config_dword(pdev, vsec + 0x8, &val);
121 map = FIELD_GET(DW_PCIE_VSEC_DMA_MAP, val);
122 if (map != EDMA_MF_EDMA_LEGACY &&
123 map != EDMA_MF_EDMA_UNROLL &&
124 map != EDMA_MF_HDMA_COMPAT)
128 pdata->rg.bar = FIELD_GET(DW_PCIE_VSEC_DMA_BAR, val);
130 pci_read_config_dword(pdev, vsec + 0xc, &val);
131 pdata->wr_ch_cnt = min_t(u16, pdata->wr_ch_cnt,
132 FIELD_GET(DW_PCIE_VSEC_DMA_WR_CH, val));
133 pdata->rd_ch_cnt = min_t(u16, pdata->rd_ch_cnt,
134 FIELD_GET(DW_PCIE_VSEC_DMA_RD_CH, val));
136 pci_read_config_dword(pdev, vsec + 0x14, &val);
138 pci_read_config_dword(pdev, vsec + 0x10, &val);
144 static int dw_edma_pcie_probe(struct pci_dev *pdev,
145 const struct pci_device_id *pid)
147 struct dw_edma_pcie_data *pdata = (void *)pid->driver_data;
148 struct dw_edma_pcie_data vsec_data;
149 struct device *dev = &pdev->dev;
150 struct dw_edma_chip *chip;
155 /* Enable PCI device */
156 err = pcim_enable_device(pdev);
158 pci_err(pdev, "enabling device failed\n");
162 memcpy(&vsec_data, pdata, sizeof(struct dw_edma_pcie_data));
165 * Tries to find if exists a PCIe Vendor-Specific Extended Capability
166 * for the DMA, if one exists, then reconfigures it.
168 dw_edma_pcie_get_vsec_dma_data(pdev, &vsec_data);
170 /* Mapping PCI BAR regions */
171 mask = BIT(vsec_data.rg.bar);
172 for (i = 0; i < vsec_data.wr_ch_cnt; i++) {
173 mask |= BIT(vsec_data.ll_wr[i].bar);
174 mask |= BIT(vsec_data.dt_wr[i].bar);
176 for (i = 0; i < vsec_data.rd_ch_cnt; i++) {
177 mask |= BIT(vsec_data.ll_rd[i].bar);
178 mask |= BIT(vsec_data.dt_rd[i].bar);
180 err = pcim_iomap_regions(pdev, mask, pci_name(pdev));
182 pci_err(pdev, "eDMA BAR I/O remapping failed\n");
186 pci_set_master(pdev);
188 /* DMA configuration */
189 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
191 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
193 pci_err(pdev, "consistent DMA mask 64 set failed\n");
197 pci_err(pdev, "DMA mask 64 set failed\n");
199 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
201 pci_err(pdev, "DMA mask 32 set failed\n");
205 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
207 pci_err(pdev, "consistent DMA mask 32 set failed\n");
212 /* Data structure allocation */
213 chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
217 dw = devm_kzalloc(dev, sizeof(*dw), GFP_KERNEL);
221 /* IRQs allocation */
222 nr_irqs = pci_alloc_irq_vectors(pdev, 1, vsec_data.irqs,
223 PCI_IRQ_MSI | PCI_IRQ_MSIX);
225 pci_err(pdev, "fail to alloc IRQ vector (number of IRQs=%u)\n",
230 /* Data structure initialization */
233 chip->id = pdev->devfn;
234 chip->irq = pdev->irq;
236 dw->mf = vsec_data.mf;
237 dw->nr_irqs = nr_irqs;
238 dw->ops = &dw_edma_pcie_core_ops;
239 dw->wr_ch_cnt = vsec_data.wr_ch_cnt;
240 dw->rd_ch_cnt = vsec_data.rd_ch_cnt;
242 dw->rg_region.vaddr = pcim_iomap_table(pdev)[vsec_data.rg.bar];
243 if (!dw->rg_region.vaddr)
246 dw->rg_region.vaddr += vsec_data.rg.off;
247 dw->rg_region.paddr = pdev->resource[vsec_data.rg.bar].start;
248 dw->rg_region.paddr += vsec_data.rg.off;
249 dw->rg_region.sz = vsec_data.rg.sz;
251 for (i = 0; i < dw->wr_ch_cnt; i++) {
252 struct dw_edma_region *ll_region = &dw->ll_region_wr[i];
253 struct dw_edma_region *dt_region = &dw->dt_region_wr[i];
254 struct dw_edma_block *ll_block = &vsec_data.ll_wr[i];
255 struct dw_edma_block *dt_block = &vsec_data.dt_wr[i];
257 ll_region->vaddr = pcim_iomap_table(pdev)[ll_block->bar];
258 if (!ll_region->vaddr)
261 ll_region->vaddr += ll_block->off;
262 ll_region->paddr = pdev->resource[ll_block->bar].start;
263 ll_region->paddr += ll_block->off;
264 ll_region->sz = ll_block->sz;
266 dt_region->vaddr = pcim_iomap_table(pdev)[dt_block->bar];
267 if (!dt_region->vaddr)
270 dt_region->vaddr += dt_block->off;
271 dt_region->paddr = pdev->resource[dt_block->bar].start;
272 dt_region->paddr += dt_block->off;
273 dt_region->sz = dt_block->sz;
276 for (i = 0; i < dw->rd_ch_cnt; i++) {
277 struct dw_edma_region *ll_region = &dw->ll_region_rd[i];
278 struct dw_edma_region *dt_region = &dw->dt_region_rd[i];
279 struct dw_edma_block *ll_block = &vsec_data.ll_rd[i];
280 struct dw_edma_block *dt_block = &vsec_data.dt_rd[i];
282 ll_region->vaddr = pcim_iomap_table(pdev)[ll_block->bar];
283 if (!ll_region->vaddr)
286 ll_region->vaddr += ll_block->off;
287 ll_region->paddr = pdev->resource[ll_block->bar].start;
288 ll_region->paddr += ll_block->off;
289 ll_region->sz = ll_block->sz;
291 dt_region->vaddr = pcim_iomap_table(pdev)[dt_block->bar];
292 if (!dt_region->vaddr)
295 dt_region->vaddr += dt_block->off;
296 dt_region->paddr = pdev->resource[dt_block->bar].start;
297 dt_region->paddr += dt_block->off;
298 dt_region->sz = dt_block->sz;
302 if (dw->mf == EDMA_MF_EDMA_LEGACY)
303 pci_dbg(pdev, "Version:\teDMA Port Logic (0x%x)\n", dw->mf);
304 else if (dw->mf == EDMA_MF_EDMA_UNROLL)
305 pci_dbg(pdev, "Version:\teDMA Unroll (0x%x)\n", dw->mf);
306 else if (dw->mf == EDMA_MF_HDMA_COMPAT)
307 pci_dbg(pdev, "Version:\tHDMA Compatible (0x%x)\n", dw->mf);
309 pci_dbg(pdev, "Version:\tUnknown (0x%x)\n", dw->mf);
311 pci_dbg(pdev, "Registers:\tBAR=%u, off=0x%.8lx, sz=0x%zx bytes, addr(v=%p, p=%pa)\n",
312 vsec_data.rg.bar, vsec_data.rg.off, vsec_data.rg.sz,
313 dw->rg_region.vaddr, &dw->rg_region.paddr);
316 for (i = 0; i < dw->wr_ch_cnt; i++) {
317 pci_dbg(pdev, "L. List:\tWRITE CH%.2u, BAR=%u, off=0x%.8lx, sz=0x%zx bytes, addr(v=%p, p=%pa)\n",
318 i, vsec_data.ll_wr[i].bar,
319 vsec_data.ll_wr[i].off, dw->ll_region_wr[i].sz,
320 dw->ll_region_wr[i].vaddr, &dw->ll_region_wr[i].paddr);
322 pci_dbg(pdev, "Data:\tWRITE CH%.2u, BAR=%u, off=0x%.8lx, sz=0x%zx bytes, addr(v=%p, p=%pa)\n",
323 i, vsec_data.dt_wr[i].bar,
324 vsec_data.dt_wr[i].off, dw->dt_region_wr[i].sz,
325 dw->dt_region_wr[i].vaddr, &dw->dt_region_wr[i].paddr);
328 for (i = 0; i < dw->rd_ch_cnt; i++) {
329 pci_dbg(pdev, "L. List:\tREAD CH%.2u, BAR=%u, off=0x%.8lx, sz=0x%zx bytes, addr(v=%p, p=%pa)\n",
330 i, vsec_data.ll_rd[i].bar,
331 vsec_data.ll_rd[i].off, dw->ll_region_rd[i].sz,
332 dw->ll_region_rd[i].vaddr, &dw->ll_region_rd[i].paddr);
334 pci_dbg(pdev, "Data:\tREAD CH%.2u, BAR=%u, off=0x%.8lx, sz=0x%zx bytes, addr(v=%p, p=%pa)\n",
335 i, vsec_data.dt_rd[i].bar,
336 vsec_data.dt_rd[i].off, dw->dt_region_rd[i].sz,
337 dw->dt_region_rd[i].vaddr, &dw->dt_region_rd[i].paddr);
340 pci_dbg(pdev, "Nr. IRQs:\t%u\n", dw->nr_irqs);
342 /* Validating if PCI interrupts were enabled */
343 if (!pci_dev_msi_enabled(pdev)) {
344 pci_err(pdev, "enable interrupt failed\n");
348 dw->irq = devm_kcalloc(dev, nr_irqs, sizeof(*dw->irq), GFP_KERNEL);
352 /* Starting eDMA driver */
353 err = dw_edma_probe(chip);
355 pci_err(pdev, "eDMA probe failed\n");
359 /* Saving data structure reference */
360 pci_set_drvdata(pdev, chip);
365 static void dw_edma_pcie_remove(struct pci_dev *pdev)
367 struct dw_edma_chip *chip = pci_get_drvdata(pdev);
370 /* Stopping eDMA driver */
371 err = dw_edma_remove(chip);
373 pci_warn(pdev, "can't remove device properly: %d\n", err);
376 pci_free_irq_vectors(pdev);
379 static const struct pci_device_id dw_edma_pcie_id_table[] = {
380 { PCI_DEVICE_DATA(SYNOPSYS, EDDA, &snps_edda_data) },
383 MODULE_DEVICE_TABLE(pci, dw_edma_pcie_id_table);
385 static struct pci_driver dw_edma_pcie_driver = {
386 .name = "dw-edma-pcie",
387 .id_table = dw_edma_pcie_id_table,
388 .probe = dw_edma_pcie_probe,
389 .remove = dw_edma_pcie_remove,
392 module_pci_driver(dw_edma_pcie_driver);
394 MODULE_LICENSE("GPL v2");
395 MODULE_DESCRIPTION("Synopsys DesignWare eDMA PCIe driver");
396 MODULE_AUTHOR("Gustavo Pimentel <gustavo.pimentel@synopsys.com>");