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 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 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);
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 pcie_port *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 pcie_port *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 pcie_port *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 pcie_port *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 pcie_port *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 pcie_port *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 pcie_port *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 pcie_port *pp)
261 irq_set_chained_handler_and_data(pp->msi_irq, NULL, NULL);
263 irq_domain_remove(pp->msi_domain);
264 irq_domain_remove(pp->irq_domain);
267 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
268 struct device *dev = pci->dev;
270 dma_unmap_single_attrs(dev, pp->msi_data, sizeof(pp->msi_msg),
271 DMA_FROM_DEVICE, DMA_ATTR_SKIP_CPU_SYNC);
275 static void dw_pcie_msi_init(struct pcie_port *pp)
277 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
278 u64 msi_target = (u64)pp->msi_data;
280 if (!pci_msi_enabled() || !pp->has_msi_ctrl)
283 /* Program the msi_data */
284 dw_pcie_writel_dbi(pci, PCIE_MSI_ADDR_LO, lower_32_bits(msi_target));
285 dw_pcie_writel_dbi(pci, PCIE_MSI_ADDR_HI, upper_32_bits(msi_target));
288 int dw_pcie_host_init(struct pcie_port *pp)
290 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
291 struct device *dev = pci->dev;
292 struct device_node *np = dev->of_node;
293 struct platform_device *pdev = to_platform_device(dev);
294 struct resource_entry *win;
295 struct pci_host_bridge *bridge;
296 struct resource *cfg_res;
299 raw_spin_lock_init(&pci->pp.lock);
301 cfg_res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "config");
303 pp->cfg0_size = resource_size(cfg_res);
304 pp->cfg0_base = cfg_res->start;
306 pp->va_cfg0_base = devm_pci_remap_cfg_resource(dev, cfg_res);
307 if (IS_ERR(pp->va_cfg0_base))
308 return PTR_ERR(pp->va_cfg0_base);
310 dev_err(dev, "Missing *config* reg space\n");
314 if (!pci->dbi_base) {
315 struct resource *dbi_res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dbi");
316 pci->dbi_base = devm_pci_remap_cfg_resource(dev, dbi_res);
317 if (IS_ERR(pci->dbi_base))
318 return PTR_ERR(pci->dbi_base);
321 bridge = devm_pci_alloc_host_bridge(dev, 0);
327 /* Get the I/O range from DT */
328 win = resource_list_first_type(&bridge->windows, IORESOURCE_IO);
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 if (pci->link_gen < 1)
336 pci->link_gen = of_pci_get_max_link_speed(np);
338 /* Set default bus ops */
339 bridge->ops = &dw_pcie_ops;
340 bridge->child_ops = &dw_child_pcie_ops;
342 if (pp->ops->host_init) {
343 ret = pp->ops->host_init(pp);
348 if (pci_msi_enabled()) {
349 pp->has_msi_ctrl = !(pp->ops->msi_host_init ||
350 of_property_read_bool(np, "msi-parent") ||
351 of_property_read_bool(np, "msi-map"));
353 if (!pp->num_vectors) {
354 pp->num_vectors = MSI_DEF_NUM_VECTORS;
355 } else if (pp->num_vectors > MAX_MSI_IRQS) {
356 dev_err(dev, "Invalid number of vectors\n");
360 if (pp->ops->msi_host_init) {
361 ret = pp->ops->msi_host_init(pp);
364 } else if (pp->has_msi_ctrl) {
367 num_ctrls = pp->num_vectors / MAX_MSI_IRQS_PER_CTRL;
368 for (ctrl = 0; ctrl < num_ctrls; ctrl++)
369 pp->irq_mask[ctrl] = ~0;
372 pp->msi_irq = platform_get_irq_byname_optional(pdev, "msi");
373 if (pp->msi_irq < 0) {
374 pp->msi_irq = platform_get_irq(pdev, 0);
380 pp->msi_irq_chip = &dw_pci_msi_bottom_irq_chip;
382 ret = dw_pcie_allocate_domains(pp);
387 irq_set_chained_handler_and_data(pp->msi_irq,
391 ret = dma_set_mask(pci->dev, DMA_BIT_MASK(32));
393 dev_warn(pci->dev, "Failed to set DMA mask to 32-bit. Devices with only 32-bit MSI support may not work properly\n");
395 pp->msi_data = dma_map_single_attrs(pci->dev, &pp->msi_msg,
398 DMA_ATTR_SKIP_CPU_SYNC);
399 ret = dma_mapping_error(pci->dev, pp->msi_data);
401 dev_err(pci->dev, "Failed to map MSI data\n");
408 dw_pcie_iatu_detect(pci);
410 dw_pcie_setup_rc(pp);
412 if (!dw_pcie_link_up(pci) && pci->ops && pci->ops->start_link) {
413 ret = pci->ops->start_link(pci);
418 /* Ignore errors, the link may come up later */
419 dw_pcie_wait_for_link(pci);
421 bridge->sysdata = pp;
423 ret = pci_host_probe(bridge);
428 if (pp->has_msi_ctrl)
429 dw_pcie_free_msi(pp);
432 EXPORT_SYMBOL_GPL(dw_pcie_host_init);
434 void dw_pcie_host_deinit(struct pcie_port *pp)
436 pci_stop_root_bus(pp->bridge->bus);
437 pci_remove_root_bus(pp->bridge->bus);
438 if (pp->has_msi_ctrl)
439 dw_pcie_free_msi(pp);
441 EXPORT_SYMBOL_GPL(dw_pcie_host_deinit);
443 static void __iomem *dw_pcie_other_conf_map_bus(struct pci_bus *bus,
444 unsigned int devfn, int where)
448 struct pcie_port *pp = bus->sysdata;
449 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
452 * Checking whether the link is up here is a last line of defense
453 * against platforms that forward errors on the system bus as
454 * SError upon PCI configuration transactions issued when the link
455 * is down. This check is racy by definition and does not stop
456 * the system from triggering an SError if the link goes down
457 * after this check is performed.
459 if (!dw_pcie_link_up(pci))
462 busdev = PCIE_ATU_BUS(bus->number) | PCIE_ATU_DEV(PCI_SLOT(devfn)) |
463 PCIE_ATU_FUNC(PCI_FUNC(devfn));
465 if (pci_is_root_bus(bus->parent))
466 type = PCIE_ATU_TYPE_CFG0;
468 type = PCIE_ATU_TYPE_CFG1;
471 dw_pcie_prog_outbound_atu(pci, 0, type, pp->cfg0_base, busdev, pp->cfg0_size);
473 return pp->va_cfg0_base + where;
476 static int dw_pcie_rd_other_conf(struct pci_bus *bus, unsigned int devfn,
477 int where, int size, u32 *val)
480 struct pcie_port *pp = bus->sysdata;
481 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
483 ret = pci_generic_config_read(bus, devfn, where, size, val);
485 if (!ret && pci->io_cfg_atu_shared)
486 dw_pcie_prog_outbound_atu(pci, 0, PCIE_ATU_TYPE_IO, pp->io_base,
487 pp->io_bus_addr, pp->io_size);
492 static int dw_pcie_wr_other_conf(struct pci_bus *bus, unsigned int devfn,
493 int where, int size, u32 val)
496 struct pcie_port *pp = bus->sysdata;
497 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
499 ret = pci_generic_config_write(bus, devfn, where, size, val);
501 if (!ret && pci->io_cfg_atu_shared)
502 dw_pcie_prog_outbound_atu(pci, 0, PCIE_ATU_TYPE_IO, pp->io_base,
503 pp->io_bus_addr, pp->io_size);
508 static struct pci_ops dw_child_pcie_ops = {
509 .map_bus = dw_pcie_other_conf_map_bus,
510 .read = dw_pcie_rd_other_conf,
511 .write = dw_pcie_wr_other_conf,
514 void __iomem *dw_pcie_own_conf_map_bus(struct pci_bus *bus, unsigned int devfn, int where)
516 struct pcie_port *pp = bus->sysdata;
517 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
519 if (PCI_SLOT(devfn) > 0)
522 return pci->dbi_base + where;
524 EXPORT_SYMBOL_GPL(dw_pcie_own_conf_map_bus);
526 static struct pci_ops dw_pcie_ops = {
527 .map_bus = dw_pcie_own_conf_map_bus,
528 .read = pci_generic_config_read,
529 .write = pci_generic_config_write,
532 void dw_pcie_setup_rc(struct pcie_port *pp)
535 u32 val, ctrl, num_ctrls;
536 struct dw_pcie *pci = to_dw_pcie_from_pp(pp);
539 * Enable DBI read-only registers for writing/updating configuration.
540 * Write permission gets disabled towards the end of this function.
542 dw_pcie_dbi_ro_wr_en(pci);
546 if (pp->has_msi_ctrl) {
547 num_ctrls = pp->num_vectors / MAX_MSI_IRQS_PER_CTRL;
549 /* Initialize IRQ Status array */
550 for (ctrl = 0; ctrl < num_ctrls; ctrl++) {
551 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_MASK +
552 (ctrl * MSI_REG_CTRL_BLOCK_SIZE),
554 dw_pcie_writel_dbi(pci, PCIE_MSI_INTR0_ENABLE +
555 (ctrl * MSI_REG_CTRL_BLOCK_SIZE),
560 dw_pcie_msi_init(pp);
563 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 0x00000004);
564 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_1, 0x00000000);
566 /* Setup interrupt pins */
567 val = dw_pcie_readl_dbi(pci, PCI_INTERRUPT_LINE);
570 dw_pcie_writel_dbi(pci, PCI_INTERRUPT_LINE, val);
572 /* Setup bus numbers */
573 val = dw_pcie_readl_dbi(pci, PCI_PRIMARY_BUS);
576 dw_pcie_writel_dbi(pci, PCI_PRIMARY_BUS, val);
578 /* Setup command register */
579 val = dw_pcie_readl_dbi(pci, PCI_COMMAND);
581 val |= PCI_COMMAND_IO | PCI_COMMAND_MEMORY |
582 PCI_COMMAND_MASTER | PCI_COMMAND_SERR;
583 dw_pcie_writel_dbi(pci, PCI_COMMAND, val);
585 /* Ensure all outbound windows are disabled so there are multiple matches */
586 for (i = 0; i < pci->num_ob_windows; i++)
587 dw_pcie_disable_atu(pci, i, DW_PCIE_REGION_OUTBOUND);
590 * If the platform provides its own child bus config accesses, it means
591 * the platform uses its own address translation component rather than
592 * ATU, so we should not program the ATU here.
594 if (pp->bridge->child_ops == &dw_child_pcie_ops) {
596 struct resource_entry *entry;
598 /* Get last memory resource entry */
599 resource_list_for_each_entry(entry, &pp->bridge->windows) {
600 if (resource_type(entry->res) != IORESOURCE_MEM)
603 if (pci->num_ob_windows <= ++atu_idx)
606 dw_pcie_prog_outbound_atu(pci, atu_idx,
607 PCIE_ATU_TYPE_MEM, entry->res->start,
608 entry->res->start - entry->offset,
609 resource_size(entry->res));
613 if (pci->num_ob_windows > ++atu_idx)
614 dw_pcie_prog_outbound_atu(pci, atu_idx,
615 PCIE_ATU_TYPE_IO, pp->io_base,
616 pp->io_bus_addr, pp->io_size);
618 pci->io_cfg_atu_shared = true;
621 if (pci->num_ob_windows <= atu_idx)
622 dev_warn(pci->dev, "Resources exceed number of ATU entries (%d)",
623 pci->num_ob_windows);
626 dw_pcie_writel_dbi(pci, PCI_BASE_ADDRESS_0, 0);
628 /* Program correct class for RC */
629 dw_pcie_writew_dbi(pci, PCI_CLASS_DEVICE, PCI_CLASS_BRIDGE_PCI);
631 val = dw_pcie_readl_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL);
632 val |= PORT_LOGIC_SPEED_CHANGE;
633 dw_pcie_writel_dbi(pci, PCIE_LINK_WIDTH_SPEED_CONTROL, val);
635 dw_pcie_dbi_ro_wr_dis(pci);
637 EXPORT_SYMBOL_GPL(dw_pcie_setup_rc);