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
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 dw_pcie_rp *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 generic_handle_domain_irq(pp->irq_domain,
78 (i * MAX_MSI_IRQS_PER_CTRL) +
87 /* Chained MSI interrupt service routine */
88 static void dw_chained_msi_isr(struct irq_desc *desc)
90 struct irq_chip *chip = irq_desc_get_chip(desc);
91 struct dw_pcie_rp *pp;
93 chained_irq_enter(chip, desc);
95 pp = irq_desc_get_handler_data(desc);
96 dw_handle_msi_irq(pp);
98 chained_irq_exit(chip, desc);
101 static void dw_pci_setup_msi_msg(struct irq_data *d, struct msi_msg *msg)
103 struct dw_pcie_rp *pp = irq_data_get_irq_chip_data(d);
104 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
107 msi_target = (u64)pp->msi_data;
109 msg->address_lo = lower_32_bits(msi_target);
110 msg->address_hi = upper_32_bits(msi_target);
112 msg->data = d->hwirq;
114 dev_dbg(pci->dev, "msi#%d address_hi %#x address_lo %#x\n",
115 (int)d->hwirq, msg->address_hi, msg->address_lo);
118 static int dw_pci_msi_set_affinity(struct irq_data *d,
119 const struct cpumask *mask, bool force)
124 static void dw_pci_bottom_mask(struct irq_data *d)
126 struct dw_pcie_rp *pp = irq_data_get_irq_chip_data(d);
127 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
128 unsigned int res, bit, ctrl;
131 raw_spin_lock_irqsave(&pp->lock, flags);
133 ctrl = d->hwirq / MAX_MSI_IRQS_PER_CTRL;
134 res = ctrl * MSI_REG_CTRL_BLOCK_SIZE;
135 bit = d->hwirq % MAX_MSI_IRQS_PER_CTRL;
137 pp->irq_mask[ctrl] |= BIT(bit);
138 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_MASK + res, pp->irq_mask[ctrl]);
140 raw_spin_unlock_irqrestore(&pp->lock, flags);
143 static void dw_pci_bottom_unmask(struct irq_data *d)
145 struct dw_pcie_rp *pp = irq_data_get_irq_chip_data(d);
146 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
147 unsigned int res, bit, ctrl;
150 raw_spin_lock_irqsave(&pp->lock, flags);
152 ctrl = d->hwirq / MAX_MSI_IRQS_PER_CTRL;
153 res = ctrl * MSI_REG_CTRL_BLOCK_SIZE;
154 bit = d->hwirq % MAX_MSI_IRQS_PER_CTRL;
156 pp->irq_mask[ctrl] &= ~BIT(bit);
157 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_MASK + res, pp->irq_mask[ctrl]);
159 raw_spin_unlock_irqrestore(&pp->lock, flags);
162 static void dw_pci_bottom_ack(struct irq_data *d)
164 struct dw_pcie_rp *pp = irq_data_get_irq_chip_data(d);
165 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
166 unsigned int res, bit, ctrl;
168 ctrl = d->hwirq / MAX_MSI_IRQS_PER_CTRL;
169 res = ctrl * MSI_REG_CTRL_BLOCK_SIZE;
170 bit = d->hwirq % MAX_MSI_IRQS_PER_CTRL;
172 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_STATUS + res, BIT(bit));
175 static struct irq_chip dw_pci_msi_bottom_irq_chip = {
177 .irq_ack = dw_pci_bottom_ack,
178 .irq_compose_msi_msg = dw_pci_setup_msi_msg,
179 .irq_set_affinity = dw_pci_msi_set_affinity,
180 .irq_mask = dw_pci_bottom_mask,
181 .irq_unmask = dw_pci_bottom_unmask,
184 static int dw_pcie_irq_domain_alloc(struct irq_domain *domain,
185 unsigned int virq, unsigned int nr_irqs,
188 struct dw_pcie_rp *pp = domain->host_data;
193 raw_spin_lock_irqsave(&pp->lock, flags);
195 bit = bitmap_find_free_region(pp->msi_irq_in_use, pp->num_vectors,
196 order_base_2(nr_irqs));
198 raw_spin_unlock_irqrestore(&pp->lock, flags);
203 for (i = 0; i < nr_irqs; i++)
204 irq_domain_set_info(domain, virq + i, bit + i,
212 static void dw_pcie_irq_domain_free(struct irq_domain *domain,
213 unsigned int virq, unsigned int nr_irqs)
215 struct irq_data *d = irq_domain_get_irq_data(domain, virq);
216 struct dw_pcie_rp *pp = domain->host_data;
219 raw_spin_lock_irqsave(&pp->lock, flags);
221 bitmap_release_region(pp->msi_irq_in_use, d->hwirq,
222 order_base_2(nr_irqs));
224 raw_spin_unlock_irqrestore(&pp->lock, flags);
227 static const struct irq_domain_ops dw_pcie_msi_domain_ops = {
228 .alloc = dw_pcie_irq_domain_alloc,
229 .free = dw_pcie_irq_domain_free,
232 int dw_pcie_allocate_domains(struct dw_pcie_rp *pp)
234 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
235 struct fwnode_handle *fwnode = of_node_to_fwnode(pci->dev->of_node);
237 pp->irq_domain = irq_domain_create_linear(fwnode, pp->num_vectors,
238 &dw_pcie_msi_domain_ops, pp);
239 if (!pp->irq_domain) {
240 dev_err(pci->dev, "Failed to create IRQ domain\n");
244 irq_domain_update_bus_token(pp->irq_domain, DOMAIN_BUS_NEXUS);
246 pp->msi_domain = pci_msi_create_irq_domain(fwnode,
247 &dw_pcie_msi_domain_info,
249 if (!pp->msi_domain) {
250 dev_err(pci->dev, "Failed to create MSI domain\n");
251 irq_domain_remove(pp->irq_domain);
258 static void dw_pcie_free_msi(struct dw_pcie_rp *pp)
262 for (ctrl = 0; ctrl < MAX_MSI_CTRLS; ctrl++) {
263 if (pp->msi_irq[ctrl] > 0)
264 irq_set_chained_handler_and_data(pp->msi_irq[ctrl],
268 irq_domain_remove(pp->msi_domain);
269 irq_domain_remove(pp->irq_domain);
272 static void dw_pcie_msi_init(struct dw_pcie_rp *pp)
274 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
275 u64 msi_target = (u64)pp->msi_data;
277 if (!pci_msi_enabled() || !pp->has_msi_ctrl)
280 /* Program the msi_data */
281 dw_pcie_writel_dbi(pci, PCIE_MSI_ADDR_LO, lower_32_bits(msi_target));
282 dw_pcie_writel_dbi(pci, PCIE_MSI_ADDR_HI, upper_32_bits(msi_target));
285 static int dw_pcie_parse_split_msi_irq(struct dw_pcie_rp *pp)
287 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
288 struct device *dev = pci->dev;
289 struct platform_device *pdev = to_platform_device(dev);
290 u32 ctrl, max_vectors;
293 /* Parse any "msiX" IRQs described in the devicetree */
294 for (ctrl = 0; ctrl < MAX_MSI_CTRLS; ctrl++) {
295 char msi_name[] = "msiX";
297 msi_name[3] = '0' + ctrl;
298 irq = platform_get_irq_byname_optional(pdev, msi_name);
302 return dev_err_probe(dev, irq,
303 "Failed to parse MSI IRQ '%s'\n",
306 pp->msi_irq[ctrl] = irq;
309 /* If no "msiX" IRQs, caller should fallback to "msi" IRQ */
313 max_vectors = ctrl * MAX_MSI_IRQS_PER_CTRL;
314 if (pp->num_vectors > max_vectors) {
315 dev_warn(dev, "Exceeding number of MSI vectors, limiting to %u\n",
317 pp->num_vectors = max_vectors;
319 if (!pp->num_vectors)
320 pp->num_vectors = max_vectors;
325 static int dw_pcie_msi_host_init(struct dw_pcie_rp *pp)
327 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
328 struct device *dev = pci->dev;
329 struct platform_device *pdev = to_platform_device(dev);
334 for (ctrl = 0; ctrl < MAX_MSI_CTRLS; ctrl++)
335 pp->irq_mask[ctrl] = ~0;
337 if (!pp->msi_irq[0]) {
338 ret = dw_pcie_parse_split_msi_irq(pp);
339 if (ret < 0 && ret != -ENXIO)
343 if (!pp->num_vectors)
344 pp->num_vectors = MSI_DEF_NUM_VECTORS;
345 num_ctrls = pp->num_vectors / MAX_MSI_IRQS_PER_CTRL;
347 if (!pp->msi_irq[0]) {
348 pp->msi_irq[0] = platform_get_irq_byname_optional(pdev, "msi");
349 if (pp->msi_irq[0] < 0) {
350 pp->msi_irq[0] = platform_get_irq(pdev, 0);
351 if (pp->msi_irq[0] < 0)
352 return pp->msi_irq[0];
356 dev_dbg(dev, "Using %d MSI vectors\n", pp->num_vectors);
358 pp->msi_irq_chip = &dw_pci_msi_bottom_irq_chip;
360 ret = dw_pcie_allocate_domains(pp);
364 for (ctrl = 0; ctrl < num_ctrls; ctrl++) {
365 if (pp->msi_irq[ctrl] > 0)
366 irq_set_chained_handler_and_data(pp->msi_irq[ctrl],
367 dw_chained_msi_isr, pp);
370 ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
372 dev_warn(dev, "Failed to set DMA mask to 32-bit. Devices with only 32-bit MSI support may not work properly\n");
374 msi_vaddr = dmam_alloc_coherent(dev, sizeof(u64), &pp->msi_data,
377 dev_err(dev, "Failed to alloc and map MSI data\n");
378 dw_pcie_free_msi(pp);
385 int dw_pcie_host_init(struct dw_pcie_rp *pp)
387 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
388 struct device *dev = pci->dev;
389 struct device_node *np = dev->of_node;
390 struct platform_device *pdev = to_platform_device(dev);
391 struct resource_entry *win;
392 struct pci_host_bridge *bridge;
393 struct resource *res;
396 raw_spin_lock_init(&pp->lock);
398 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "config");
400 pp->cfg0_size = resource_size(res);
401 pp->cfg0_base = res->start;
403 pp->va_cfg0_base = devm_pci_remap_cfg_resource(dev, res);
404 if (IS_ERR(pp->va_cfg0_base))
405 return PTR_ERR(pp->va_cfg0_base);
407 dev_err(dev, "Missing *config* reg space\n");
411 if (!pci->dbi_base) {
412 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dbi");
413 pci->dbi_base = devm_pci_remap_cfg_resource(dev, res);
414 if (IS_ERR(pci->dbi_base))
415 return PTR_ERR(pci->dbi_base);
418 bridge = devm_pci_alloc_host_bridge(dev, 0);
424 /* Get the I/O range from DT */
425 win = resource_list_first_type(&bridge->windows, IORESOURCE_IO);
427 pp->io_size = resource_size(win->res);
428 pp->io_bus_addr = win->res->start - win->offset;
429 pp->io_base = pci_pio_to_address(win->res->start);
432 if (pci->link_gen < 1)
433 pci->link_gen = of_pci_get_max_link_speed(np);
435 /* Set default bus ops */
436 bridge->ops = &dw_pcie_ops;
437 bridge->child_ops = &dw_child_pcie_ops;
439 if (pp->ops->host_init) {
440 ret = pp->ops->host_init(pp);
445 if (pci_msi_enabled()) {
446 pp->has_msi_ctrl = !(pp->ops->msi_host_init ||
447 of_property_read_bool(np, "msi-parent") ||
448 of_property_read_bool(np, "msi-map"));
451 * For the has_msi_ctrl case the default assignment is handled
452 * in the dw_pcie_msi_host_init().
454 if (!pp->has_msi_ctrl && !pp->num_vectors) {
455 pp->num_vectors = MSI_DEF_NUM_VECTORS;
456 } else if (pp->num_vectors > MAX_MSI_IRQS) {
457 dev_err(dev, "Invalid number of vectors\n");
459 goto err_deinit_host;
462 if (pp->ops->msi_host_init) {
463 ret = pp->ops->msi_host_init(pp);
465 goto err_deinit_host;
466 } else if (pp->has_msi_ctrl) {
467 ret = dw_pcie_msi_host_init(pp);
469 goto err_deinit_host;
473 dw_pcie_version_detect(pci);
475 dw_pcie_iatu_detect(pci);
477 ret = dw_pcie_setup_rc(pp);
481 if (!dw_pcie_link_up(pci)) {
482 ret = dw_pcie_start_link(pci);
487 /* Ignore errors, the link may come up later */
488 dw_pcie_wait_for_link(pci);
490 bridge->sysdata = pp;
492 ret = pci_host_probe(bridge);
499 dw_pcie_stop_link(pci);
502 if (pp->has_msi_ctrl)
503 dw_pcie_free_msi(pp);
506 if (pp->ops->host_deinit)
507 pp->ops->host_deinit(pp);
511 EXPORT_SYMBOL_GPL(dw_pcie_host_init);
513 void dw_pcie_host_deinit(struct dw_pcie_rp *pp)
515 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
517 pci_stop_root_bus(pp->bridge->bus);
518 pci_remove_root_bus(pp->bridge->bus);
520 dw_pcie_stop_link(pci);
522 if (pp->has_msi_ctrl)
523 dw_pcie_free_msi(pp);
525 if (pp->ops->host_deinit)
526 pp->ops->host_deinit(pp);
528 EXPORT_SYMBOL_GPL(dw_pcie_host_deinit);
530 static void __iomem *dw_pcie_other_conf_map_bus(struct pci_bus *bus,
531 unsigned int devfn, int where)
533 struct dw_pcie_rp *pp = bus->sysdata;
534 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
539 * Checking whether the link is up here is a last line of defense
540 * against platforms that forward errors on the system bus as
541 * SError upon PCI configuration transactions issued when the link
542 * is down. This check is racy by definition and does not stop
543 * the system from triggering an SError if the link goes down
544 * after this check is performed.
546 if (!dw_pcie_link_up(pci))
549 busdev = PCIE_ATU_BUS(bus->number) | PCIE_ATU_DEV(PCI_SLOT(devfn)) |
550 PCIE_ATU_FUNC(PCI_FUNC(devfn));
552 if (pci_is_root_bus(bus->parent))
553 type = PCIE_ATU_TYPE_CFG0;
555 type = PCIE_ATU_TYPE_CFG1;
557 ret = dw_pcie_prog_outbound_atu(pci, 0, type, pp->cfg0_base, busdev,
562 return pp->va_cfg0_base + where;
565 static int dw_pcie_rd_other_conf(struct pci_bus *bus, unsigned int devfn,
566 int where, int size, u32 *val)
568 struct dw_pcie_rp *pp = bus->sysdata;
569 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
572 ret = pci_generic_config_read(bus, devfn, where, size, val);
573 if (ret != PCIBIOS_SUCCESSFUL)
576 if (pp->cfg0_io_shared) {
577 ret = dw_pcie_prog_outbound_atu(pci, 0, PCIE_ATU_TYPE_IO,
578 pp->io_base, pp->io_bus_addr,
581 return PCIBIOS_SET_FAILED;
584 return PCIBIOS_SUCCESSFUL;
587 static int dw_pcie_wr_other_conf(struct pci_bus *bus, unsigned int devfn,
588 int where, int size, u32 val)
590 struct dw_pcie_rp *pp = bus->sysdata;
591 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
594 ret = pci_generic_config_write(bus, devfn, where, size, val);
595 if (ret != PCIBIOS_SUCCESSFUL)
598 if (pp->cfg0_io_shared) {
599 ret = dw_pcie_prog_outbound_atu(pci, 0, PCIE_ATU_TYPE_IO,
600 pp->io_base, pp->io_bus_addr,
603 return PCIBIOS_SET_FAILED;
606 return PCIBIOS_SUCCESSFUL;
609 static struct pci_ops dw_child_pcie_ops = {
610 .map_bus = dw_pcie_other_conf_map_bus,
611 .read = dw_pcie_rd_other_conf,
612 .write = dw_pcie_wr_other_conf,
615 void __iomem *dw_pcie_own_conf_map_bus(struct pci_bus *bus, unsigned int devfn, int where)
617 struct dw_pcie_rp *pp = bus->sysdata;
618 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
620 if (PCI_SLOT(devfn) > 0)
623 return pci->dbi_base + where;
625 EXPORT_SYMBOL_GPL(dw_pcie_own_conf_map_bus);
627 static struct pci_ops dw_pcie_ops = {
628 .map_bus = dw_pcie_own_conf_map_bus,
629 .read = pci_generic_config_read,
630 .write = pci_generic_config_write,
633 static int dw_pcie_iatu_setup(struct dw_pcie_rp *pp)
635 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
636 struct resource_entry *entry;
639 /* Note the very first outbound ATU is used for CFG IOs */
640 if (!pci->num_ob_windows) {
641 dev_err(pci->dev, "No outbound iATU found\n");
646 * Ensure all outbound windows are disabled before proceeding with
647 * the MEM/IO ranges setups.
649 for (i = 0; i < pci->num_ob_windows; i++)
650 dw_pcie_disable_atu(pci, PCIE_ATU_REGION_DIR_OB, i);
653 resource_list_for_each_entry(entry, &pp->bridge->windows) {
654 if (resource_type(entry->res) != IORESOURCE_MEM)
657 if (pci->num_ob_windows <= ++i)
660 ret = dw_pcie_prog_outbound_atu(pci, i, PCIE_ATU_TYPE_MEM,
662 entry->res->start - entry->offset,
663 resource_size(entry->res));
665 dev_err(pci->dev, "Failed to set MEM range %pr\n",
672 if (pci->num_ob_windows > ++i) {
673 ret = dw_pcie_prog_outbound_atu(pci, i, PCIE_ATU_TYPE_IO,
678 dev_err(pci->dev, "Failed to set IO range %pr\n",
683 pp->cfg0_io_shared = true;
687 if (pci->num_ob_windows <= i)
688 dev_warn(pci->dev, "Resources exceed number of ATU entries (%d)\n",
689 pci->num_ob_windows);
694 int dw_pcie_setup_rc(struct dw_pcie_rp *pp)
696 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
697 u32 val, ctrl, num_ctrls;
701 * Enable DBI read-only registers for writing/updating configuration.
702 * Write permission gets disabled towards the end of this function.
704 dw_pcie_dbi_ro_wr_en(pci);
708 if (pp->has_msi_ctrl) {
709 num_ctrls = pp->num_vectors / MAX_MSI_IRQS_PER_CTRL;
711 /* Initialize IRQ Status array */
712 for (ctrl = 0; ctrl < num_ctrls; ctrl++) {
713 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_MASK +
714 (ctrl * MSI_REG_CTRL_BLOCK_SIZE),
716 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_ENABLE +
717 (ctrl * MSI_REG_CTRL_BLOCK_SIZE),
722 dw_pcie_msi_init(pp);
725 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 0x00000004);
726 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_1, 0x00000000);
728 /* Setup interrupt pins */
729 val = dw_pcie_readl_dbi(pci, PCI_INTERRUPT_LINE);
732 dw_pcie_writel_dbi(pci, PCI_INTERRUPT_LINE, val);
734 /* Setup bus numbers */
735 val = dw_pcie_readl_dbi(pci, PCI_PRIMARY_BUS);
738 dw_pcie_writel_dbi(pci, PCI_PRIMARY_BUS, val);
740 /* Setup command register */
741 val = dw_pcie_readl_dbi(pci, PCI_COMMAND);
743 val |= PCI_COMMAND_IO | PCI_COMMAND_MEMORY |
744 PCI_COMMAND_MASTER | PCI_COMMAND_SERR;
745 dw_pcie_writel_dbi(pci, PCI_COMMAND, val);
748 * If the platform provides its own child bus config accesses, it means
749 * the platform uses its own address translation component rather than
750 * ATU, so we should not program the ATU here.
752 if (pp->bridge->child_ops == &dw_child_pcie_ops) {
753 ret = dw_pcie_iatu_setup(pp);
758 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 0);
760 /* Program correct class for RC */
761 dw_pcie_writew_dbi(pci, PCI_CLASS_DEVICE, PCI_CLASS_BRIDGE_PCI);
763 val = dw_pcie_readl_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL);
764 val |= PORT_LOGIC_SPEED_CHANGE;
765 dw_pcie_writel_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL, val);
767 dw_pcie_dbi_ro_wr_dis(pci);
771 EXPORT_SYMBOL_GPL(dw_pcie_setup_rc);