1 // SPDX-License-Identifier: GPL-2.0
3 * Synopsys DesignWare PCIe host controller driver
5 * Copyright (C) 2013 Samsung Electronics Co., Ltd.
6 * https://www.samsung.com
8 * Author: Jingoo Han <jg1.han@samsung.com>
11 #include <linux/irqchip/chained_irq.h>
12 #include <linux/irqdomain.h>
13 #include <linux/msi.h>
14 #include <linux/of_address.h>
15 #include <linux/of_pci.h>
16 #include <linux/pci_regs.h>
17 #include <linux/platform_device.h>
19 #include "../../pci.h"
20 #include "pcie-designware.h"
22 static struct pci_ops dw_pcie_ops;
23 static struct pci_ops dw_child_pcie_ops;
25 static void dw_msi_ack_irq(struct irq_data *d)
27 irq_chip_ack_parent(d);
30 static void dw_msi_mask_irq(struct irq_data *d)
33 irq_chip_mask_parent(d);
36 static void dw_msi_unmask_irq(struct irq_data *d)
38 pci_msi_unmask_irq(d);
39 irq_chip_unmask_parent(d);
42 static struct irq_chip dw_pcie_msi_irq_chip = {
44 .irq_ack = dw_msi_ack_irq,
45 .irq_mask = dw_msi_mask_irq,
46 .irq_unmask = dw_msi_unmask_irq,
49 static struct msi_domain_info dw_pcie_msi_domain_info = {
50 .flags = (MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
51 MSI_FLAG_PCI_MSIX | MSI_FLAG_MULTI_PCI_MSI),
52 .chip = &dw_pcie_msi_irq_chip,
56 irqreturn_t dw_handle_msi_irq(struct pcie_port *pp)
60 u32 status, num_ctrls;
61 irqreturn_t ret = IRQ_NONE;
62 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
64 num_ctrls = pp->num_vectors / MAX_MSI_IRQS_PER_CTRL;
66 for (i = 0; i < num_ctrls; i++) {
67 status = dw_pcie_readl_dbi(pci, PCIE_MSI_INTR0_STATUS +
68 (i * MSI_REG_CTRL_BLOCK_SIZE));
75 while ((pos = find_next_bit(&val, MAX_MSI_IRQS_PER_CTRL,
76 pos)) != MAX_MSI_IRQS_PER_CTRL) {
77 irq = irq_find_mapping(pp->irq_domain,
78 (i * MAX_MSI_IRQS_PER_CTRL) +
80 generic_handle_irq(irq);
88 /* Chained MSI interrupt service routine */
89 static void dw_chained_msi_isr(struct irq_desc *desc)
91 struct irq_chip *chip = irq_desc_get_chip(desc);
94 chained_irq_enter(chip, desc);
96 pp = irq_desc_get_handler_data(desc);
97 dw_handle_msi_irq(pp);
99 chained_irq_exit(chip, desc);
102 static void dw_pci_setup_msi_msg(struct irq_data *d, struct msi_msg *msg)
104 struct pcie_port *pp = irq_data_get_irq_chip_data(d);
105 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
108 msi_target = (u64)pp->msi_data;
110 msg->address_lo = lower_32_bits(msi_target);
111 msg->address_hi = upper_32_bits(msi_target);
113 msg->data = d->hwirq;
115 dev_dbg(pci->dev, "msi#%d address_hi %#x address_lo %#x\n",
116 (int)d->hwirq, msg->address_hi, msg->address_lo);
119 static int dw_pci_msi_set_affinity(struct irq_data *d,
120 const struct cpumask *mask, bool force)
125 static void dw_pci_bottom_mask(struct irq_data *d)
127 struct pcie_port *pp = irq_data_get_irq_chip_data(d);
128 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
129 unsigned int res, bit, ctrl;
132 raw_spin_lock_irqsave(&pp->lock, flags);
134 ctrl = d->hwirq / MAX_MSI_IRQS_PER_CTRL;
135 res = ctrl * MSI_REG_CTRL_BLOCK_SIZE;
136 bit = d->hwirq % MAX_MSI_IRQS_PER_CTRL;
138 pp->irq_mask[ctrl] |= BIT(bit);
139 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_MASK + res, pp->irq_mask[ctrl]);
141 raw_spin_unlock_irqrestore(&pp->lock, flags);
144 static void dw_pci_bottom_unmask(struct irq_data *d)
146 struct pcie_port *pp = irq_data_get_irq_chip_data(d);
147 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
148 unsigned int res, bit, ctrl;
151 raw_spin_lock_irqsave(&pp->lock, flags);
153 ctrl = d->hwirq / MAX_MSI_IRQS_PER_CTRL;
154 res = ctrl * MSI_REG_CTRL_BLOCK_SIZE;
155 bit = d->hwirq % MAX_MSI_IRQS_PER_CTRL;
157 pp->irq_mask[ctrl] &= ~BIT(bit);
158 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_MASK + res, pp->irq_mask[ctrl]);
160 raw_spin_unlock_irqrestore(&pp->lock, flags);
163 static void dw_pci_bottom_ack(struct irq_data *d)
165 struct pcie_port *pp = irq_data_get_irq_chip_data(d);
166 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
167 unsigned int res, bit, ctrl;
169 ctrl = d->hwirq / MAX_MSI_IRQS_PER_CTRL;
170 res = ctrl * MSI_REG_CTRL_BLOCK_SIZE;
171 bit = d->hwirq % MAX_MSI_IRQS_PER_CTRL;
173 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_STATUS + res, BIT(bit));
176 static struct irq_chip dw_pci_msi_bottom_irq_chip = {
178 .irq_ack = dw_pci_bottom_ack,
179 .irq_compose_msi_msg = dw_pci_setup_msi_msg,
180 .irq_set_affinity = dw_pci_msi_set_affinity,
181 .irq_mask = dw_pci_bottom_mask,
182 .irq_unmask = dw_pci_bottom_unmask,
185 static int dw_pcie_irq_domain_alloc(struct irq_domain *domain,
186 unsigned int virq, unsigned int nr_irqs,
189 struct pcie_port *pp = domain->host_data;
194 raw_spin_lock_irqsave(&pp->lock, flags);
196 bit = bitmap_find_free_region(pp->msi_irq_in_use, pp->num_vectors,
197 order_base_2(nr_irqs));
199 raw_spin_unlock_irqrestore(&pp->lock, flags);
204 for (i = 0; i < nr_irqs; i++)
205 irq_domain_set_info(domain, virq + i, bit + i,
213 static void dw_pcie_irq_domain_free(struct irq_domain *domain,
214 unsigned int virq, unsigned int nr_irqs)
216 struct irq_data *d = irq_domain_get_irq_data(domain, virq);
217 struct pcie_port *pp = domain->host_data;
220 raw_spin_lock_irqsave(&pp->lock, flags);
222 bitmap_release_region(pp->msi_irq_in_use, d->hwirq,
223 order_base_2(nr_irqs));
225 raw_spin_unlock_irqrestore(&pp->lock, flags);
228 static const struct irq_domain_ops dw_pcie_msi_domain_ops = {
229 .alloc = dw_pcie_irq_domain_alloc,
230 .free = dw_pcie_irq_domain_free,
233 int dw_pcie_allocate_domains(struct pcie_port *pp)
235 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
236 struct fwnode_handle *fwnode = of_node_to_fwnode(pci->dev->of_node);
238 pp->irq_domain = irq_domain_create_linear(fwnode, pp->num_vectors,
239 &dw_pcie_msi_domain_ops, pp);
240 if (!pp->irq_domain) {
241 dev_err(pci->dev, "Failed to create IRQ domain\n");
245 irq_domain_update_bus_token(pp->irq_domain, DOMAIN_BUS_NEXUS);
247 pp->msi_domain = pci_msi_create_irq_domain(fwnode,
248 &dw_pcie_msi_domain_info,
250 if (!pp->msi_domain) {
251 dev_err(pci->dev, "Failed to create MSI domain\n");
252 irq_domain_remove(pp->irq_domain);
259 void dw_pcie_free_msi(struct pcie_port *pp)
262 irq_set_chained_handler(pp->msi_irq, NULL);
263 irq_set_handler_data(pp->msi_irq, NULL);
266 irq_domain_remove(pp->msi_domain);
267 irq_domain_remove(pp->irq_domain);
270 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
271 struct device *dev = pci->dev;
273 dma_unmap_single_attrs(dev, pp->msi_data, sizeof(pp->msi_msg),
274 DMA_FROM_DEVICE, DMA_ATTR_SKIP_CPU_SYNC);
278 void dw_pcie_msi_init(struct pcie_port *pp)
280 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
281 u64 msi_target = (u64)pp->msi_data;
283 if (!IS_ENABLED(CONFIG_PCI_MSI))
286 /* Program the msi_data */
287 dw_pcie_writel_dbi(pci, PCIE_MSI_ADDR_LO, lower_32_bits(msi_target));
288 dw_pcie_writel_dbi(pci, PCIE_MSI_ADDR_HI, upper_32_bits(msi_target));
290 EXPORT_SYMBOL_GPL(dw_pcie_msi_init);
292 int dw_pcie_host_init(struct pcie_port *pp)
294 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
295 struct device *dev = pci->dev;
296 struct device_node *np = dev->of_node;
297 struct platform_device *pdev = to_platform_device(dev);
298 struct resource_entry *win;
299 struct pci_host_bridge *bridge;
300 struct resource *cfg_res;
303 raw_spin_lock_init(&pci->pp.lock);
305 cfg_res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "config");
307 pp->cfg0_size = resource_size(cfg_res);
308 pp->cfg0_base = cfg_res->start;
309 } else if (!pp->va_cfg0_base) {
310 dev_err(dev, "Missing *config* reg space\n");
313 if (!pci->dbi_base) {
314 struct resource *dbi_res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dbi");
315 pci->dbi_base = devm_pci_remap_cfg_resource(dev, dbi_res);
316 if (IS_ERR(pci->dbi_base))
317 return PTR_ERR(pci->dbi_base);
320 bridge = devm_pci_alloc_host_bridge(dev, 0);
326 /* Get the I/O and memory ranges from DT */
327 resource_list_for_each_entry(win, &bridge->windows) {
328 switch (resource_type(win->res)) {
330 pp->io_size = resource_size(win->res);
331 pp->io_bus_addr = win->res->start - win->offset;
332 pp->io_base = pci_pio_to_address(win->res->start);
335 dev_err(dev, "Missing *config* reg space\n");
336 pp->cfg0_size = resource_size(win->res);
337 pp->cfg0_base = win->res->start;
338 if (!pci->dbi_base) {
339 pci->dbi_base = devm_pci_remap_cfgspace(dev,
342 if (!pci->dbi_base) {
343 dev_err(dev, "Error with ioremap\n");
351 if (!pp->va_cfg0_base) {
352 pp->va_cfg0_base = devm_pci_remap_cfgspace(dev,
353 pp->cfg0_base, pp->cfg0_size);
354 if (!pp->va_cfg0_base) {
355 dev_err(dev, "Error with ioremap in function\n");
360 ret = of_property_read_u32(np, "num-viewport", &pci->num_viewport);
362 pci->num_viewport = 2;
364 if (pci->link_gen < 1)
365 pci->link_gen = of_pci_get_max_link_speed(np);
367 if (pci_msi_enabled()) {
369 * If a specific SoC driver needs to change the
370 * default number of vectors, it needs to implement
371 * the set_num_vectors callback.
373 if (!pp->ops->set_num_vectors) {
374 pp->num_vectors = MSI_DEF_NUM_VECTORS;
376 pp->ops->set_num_vectors(pp);
378 if (pp->num_vectors > MAX_MSI_IRQS ||
379 pp->num_vectors == 0) {
381 "Invalid number of vectors\n");
386 if (!pp->ops->msi_host_init) {
387 pp->msi_irq_chip = &dw_pci_msi_bottom_irq_chip;
389 ret = dw_pcie_allocate_domains(pp);
394 irq_set_chained_handler_and_data(pp->msi_irq,
398 pp->msi_data = dma_map_single_attrs(pci->dev, &pp->msi_msg,
401 DMA_ATTR_SKIP_CPU_SYNC);
402 if (dma_mapping_error(pci->dev, pp->msi_data)) {
403 dev_err(pci->dev, "Failed to map MSI data\n");
408 ret = pp->ops->msi_host_init(pp);
414 /* Set default bus ops */
415 bridge->ops = &dw_pcie_ops;
416 bridge->child_ops = &dw_child_pcie_ops;
418 if (pp->ops->host_init) {
419 ret = pp->ops->host_init(pp);
424 bridge->sysdata = pp;
426 ret = pci_host_probe(bridge);
431 if (pci_msi_enabled() && !pp->ops->msi_host_init)
432 dw_pcie_free_msi(pp);
435 EXPORT_SYMBOL_GPL(dw_pcie_host_init);
437 void dw_pcie_host_deinit(struct pcie_port *pp)
439 pci_stop_root_bus(pp->bridge->bus);
440 pci_remove_root_bus(pp->bridge->bus);
441 if (pci_msi_enabled() && !pp->ops->msi_host_init)
442 dw_pcie_free_msi(pp);
444 EXPORT_SYMBOL_GPL(dw_pcie_host_deinit);
446 static void __iomem *dw_pcie_other_conf_map_bus(struct pci_bus *bus,
447 unsigned int devfn, int where)
451 struct pcie_port *pp = bus->sysdata;
452 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
455 * Checking whether the link is up here is a last line of defense
456 * against platforms that forward errors on the system bus as
457 * SError upon PCI configuration transactions issued when the link
458 * is down. This check is racy by definition and does not stop
459 * the system from triggering an SError if the link goes down
460 * after this check is performed.
462 if (!dw_pcie_link_up(pci))
465 busdev = PCIE_ATU_BUS(bus->number) | PCIE_ATU_DEV(PCI_SLOT(devfn)) |
466 PCIE_ATU_FUNC(PCI_FUNC(devfn));
468 if (pci_is_root_bus(bus->parent))
469 type = PCIE_ATU_TYPE_CFG0;
471 type = PCIE_ATU_TYPE_CFG1;
474 dw_pcie_prog_outbound_atu(pci, 0, type, pp->cfg0_base, busdev, pp->cfg0_size);
476 return pp->va_cfg0_base + where;
479 static int dw_pcie_rd_other_conf(struct pci_bus *bus, unsigned int devfn,
480 int where, int size, u32 *val)
483 struct pcie_port *pp = bus->sysdata;
484 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
486 ret = pci_generic_config_read(bus, devfn, where, size, val);
488 if (!ret && pci->io_cfg_atu_shared)
489 dw_pcie_prog_outbound_atu(pci, 0, PCIE_ATU_TYPE_IO, pp->io_base,
490 pp->io_bus_addr, pp->io_size);
495 static int dw_pcie_wr_other_conf(struct pci_bus *bus, unsigned int devfn,
496 int where, int size, u32 val)
499 struct pcie_port *pp = bus->sysdata;
500 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
502 ret = pci_generic_config_write(bus, devfn, where, size, val);
504 if (!ret && pci->io_cfg_atu_shared)
505 dw_pcie_prog_outbound_atu(pci, 0, PCIE_ATU_TYPE_IO, pp->io_base,
506 pp->io_bus_addr, pp->io_size);
511 static struct pci_ops dw_child_pcie_ops = {
512 .map_bus = dw_pcie_other_conf_map_bus,
513 .read = dw_pcie_rd_other_conf,
514 .write = dw_pcie_wr_other_conf,
517 void __iomem *dw_pcie_own_conf_map_bus(struct pci_bus *bus, unsigned int devfn, int where)
519 struct pcie_port *pp = bus->sysdata;
520 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
522 if (PCI_SLOT(devfn) > 0)
525 return pci->dbi_base + where;
527 EXPORT_SYMBOL_GPL(dw_pcie_own_conf_map_bus);
529 static struct pci_ops dw_pcie_ops = {
530 .map_bus = dw_pcie_own_conf_map_bus,
531 .read = pci_generic_config_read,
532 .write = pci_generic_config_write,
535 void dw_pcie_setup_rc(struct pcie_port *pp)
537 u32 val, ctrl, num_ctrls;
538 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
541 * Enable DBI read-only registers for writing/updating configuration.
542 * Write permission gets disabled towards the end of this function.
544 dw_pcie_dbi_ro_wr_en(pci);
548 if (pci_msi_enabled() && !pp->ops->msi_host_init) {
549 num_ctrls = pp->num_vectors / MAX_MSI_IRQS_PER_CTRL;
551 /* Initialize IRQ Status array */
552 for (ctrl = 0; ctrl < num_ctrls; ctrl++) {
553 pp->irq_mask[ctrl] = ~0;
554 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_MASK +
555 (ctrl * MSI_REG_CTRL_BLOCK_SIZE),
557 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_ENABLE +
558 (ctrl * MSI_REG_CTRL_BLOCK_SIZE),
564 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 0x00000004);
565 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_1, 0x00000000);
567 /* Setup interrupt pins */
568 val = dw_pcie_readl_dbi(pci, PCI_INTERRUPT_LINE);
571 dw_pcie_writel_dbi(pci, PCI_INTERRUPT_LINE, val);
573 /* Setup bus numbers */
574 val = dw_pcie_readl_dbi(pci, PCI_PRIMARY_BUS);
577 dw_pcie_writel_dbi(pci, PCI_PRIMARY_BUS, val);
579 /* Setup command register */
580 val = dw_pcie_readl_dbi(pci, PCI_COMMAND);
582 val |= PCI_COMMAND_IO | PCI_COMMAND_MEMORY |
583 PCI_COMMAND_MASTER | PCI_COMMAND_SERR;
584 dw_pcie_writel_dbi(pci, PCI_COMMAND, val);
587 * If the platform provides its own child bus config accesses, it means
588 * the platform uses its own address translation component rather than
589 * ATU, so we should not program the ATU here.
591 if (pp->bridge->child_ops == &dw_child_pcie_ops) {
593 struct resource_entry *entry;
595 /* Get last memory resource entry */
596 resource_list_for_each_entry(entry, &pp->bridge->windows) {
597 if (resource_type(entry->res) != IORESOURCE_MEM)
600 if (pci->num_viewport <= ++atu_idx)
603 dw_pcie_prog_outbound_atu(pci, atu_idx,
604 PCIE_ATU_TYPE_MEM, entry->res->start,
605 entry->res->start - entry->offset,
606 resource_size(entry->res));
610 if (pci->num_viewport > ++atu_idx)
611 dw_pcie_prog_outbound_atu(pci, atu_idx,
612 PCIE_ATU_TYPE_IO, pp->io_base,
613 pp->io_bus_addr, pp->io_size);
615 pci->io_cfg_atu_shared = true;
618 if (pci->num_viewport <= atu_idx)
619 dev_warn(pci->dev, "Resources exceed number of ATU entries (%d)",
623 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 0);
625 /* Program correct class for RC */
626 dw_pcie_writew_dbi(pci, PCI_CLASS_DEVICE, PCI_CLASS_BRIDGE_PCI);
628 val = dw_pcie_readl_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL);
629 val |= PORT_LOGIC_SPEED_CHANGE;
630 dw_pcie_writel_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL, val);
632 dw_pcie_dbi_ro_wr_dis(pci);
634 EXPORT_SYMBOL_GPL(dw_pcie_setup_rc);