1 // SPDX-License-Identifier: GPL-2.0+
3 * PCI <-> OF mapping helpers
5 * Copyright 2011 IBM Corp.
7 #define pr_fmt(fmt) "PCI: OF: " fmt
9 #include <linux/irqdomain.h>
10 #include <linux/kernel.h>
11 #include <linux/pci.h>
13 #include <linux/of_irq.h>
14 #include <linux/of_address.h>
15 #include <linux/of_pci.h>
20 * pci_set_of_node - Find and set device's DT device_node
21 * @dev: the PCI device structure to fill
23 * Returns 0 on success with of_node set or when no device is described in the
24 * DT. Returns -ENODEV if the device is present, but disabled in the DT.
26 int pci_set_of_node(struct pci_dev *dev)
28 struct device_node *node;
30 if (!dev->bus->dev.of_node)
33 node = of_pci_find_child_device(dev->bus->dev.of_node, dev->devfn);
37 device_set_node(&dev->dev, of_fwnode_handle(node));
41 void pci_release_of_node(struct pci_dev *dev)
43 of_node_put(dev->dev.of_node);
44 device_set_node(&dev->dev, NULL);
47 void pci_set_bus_of_node(struct pci_bus *bus)
49 struct device_node *node;
51 if (bus->self == NULL) {
52 node = pcibios_get_phb_of_node(bus);
54 node = of_node_get(bus->self->dev.of_node);
55 if (node && of_property_read_bool(node, "external-facing"))
56 bus->self->external_facing = true;
59 device_set_node(&bus->dev, of_fwnode_handle(node));
62 void pci_release_bus_of_node(struct pci_bus *bus)
64 of_node_put(bus->dev.of_node);
65 device_set_node(&bus->dev, NULL);
68 struct device_node * __weak pcibios_get_phb_of_node(struct pci_bus *bus)
70 /* This should only be called for PHBs */
71 if (WARN_ON(bus->self || bus->parent))
75 * Look for a node pointer in either the intermediary device we
76 * create above the root bus or its own parent. Normally only
77 * the later is populated.
79 if (bus->bridge->of_node)
80 return of_node_get(bus->bridge->of_node);
81 if (bus->bridge->parent && bus->bridge->parent->of_node)
82 return of_node_get(bus->bridge->parent->of_node);
86 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus)
88 #ifdef CONFIG_IRQ_DOMAIN
91 if (!bus->dev.of_node)
94 /* Start looking for a phandle to an MSI controller. */
95 d = of_msi_get_domain(&bus->dev, bus->dev.of_node, DOMAIN_BUS_PCI_MSI);
100 * If we don't have an msi-parent property, look for a domain
101 * directly attached to the host bridge.
103 d = irq_find_matching_host(bus->dev.of_node, DOMAIN_BUS_PCI_MSI);
107 return irq_find_host(bus->dev.of_node);
113 bool pci_host_of_has_msi_map(struct device *dev)
115 if (dev && dev->of_node)
116 return of_get_property(dev->of_node, "msi-map", NULL);
120 static inline int __of_pci_pci_compare(struct device_node *node,
125 devfn = of_pci_get_devfn(node);
129 return devfn == data;
132 struct device_node *of_pci_find_child_device(struct device_node *parent,
135 struct device_node *node, *node2;
137 for_each_child_of_node(parent, node) {
138 if (__of_pci_pci_compare(node, devfn))
141 * Some OFs create a parent node "multifunc-device" as
142 * a fake root for all functions of a multi-function
143 * device we go down them as well.
145 if (of_node_name_eq(node, "multifunc-device")) {
146 for_each_child_of_node(node, node2) {
147 if (__of_pci_pci_compare(node2, devfn)) {
156 EXPORT_SYMBOL_GPL(of_pci_find_child_device);
159 * of_pci_get_devfn() - Get device and function numbers for a device node
162 * Parses a standard 5-cell PCI resource and returns an 8-bit value that can
163 * be passed to the PCI_SLOT() and PCI_FUNC() macros to extract the device
164 * and function numbers respectively. On error a negative error code is
167 int of_pci_get_devfn(struct device_node *np)
172 error = of_property_read_u32_array(np, "reg", reg, ARRAY_SIZE(reg));
176 return (reg[0] >> 8) & 0xff;
178 EXPORT_SYMBOL_GPL(of_pci_get_devfn);
181 * of_pci_parse_bus_range() - parse the bus-range property of a PCI device
183 * @res: address to a struct resource to return the bus-range
185 * Returns 0 on success or a negative error-code on failure.
187 int of_pci_parse_bus_range(struct device_node *node, struct resource *res)
192 error = of_property_read_u32_array(node, "bus-range", bus_range,
193 ARRAY_SIZE(bus_range));
197 res->name = node->name;
198 res->start = bus_range[0];
199 res->end = bus_range[1];
200 res->flags = IORESOURCE_BUS;
204 EXPORT_SYMBOL_GPL(of_pci_parse_bus_range);
207 * of_get_pci_domain_nr - Find the host bridge domain number
208 * of the given device node.
209 * @node: Device tree node with the domain information.
211 * This function will try to obtain the host bridge domain number by finding
212 * a property called "linux,pci-domain" of the given device node.
215 * * > 0 - On success, an associated domain number.
216 * * -EINVAL - The property "linux,pci-domain" does not exist.
217 * * -ENODATA - The linux,pci-domain" property does not have value.
218 * * -EOVERFLOW - Invalid "linux,pci-domain" property value.
220 * Returns the associated domain number from DT in the range [0-0xffff], or
221 * a negative value if the required property is not found.
223 int of_get_pci_domain_nr(struct device_node *node)
228 error = of_property_read_u32(node, "linux,pci-domain", &domain);
234 EXPORT_SYMBOL_GPL(of_get_pci_domain_nr);
237 * of_pci_check_probe_only - Setup probe only mode if linux,pci-probe-only
238 * is present and valid
240 void of_pci_check_probe_only(void)
245 ret = of_property_read_u32(of_chosen, "linux,pci-probe-only", &val);
247 if (ret == -ENODATA || ret == -EOVERFLOW)
248 pr_warn("linux,pci-probe-only without valid value, ignoring\n");
253 pci_add_flags(PCI_PROBE_ONLY);
255 pci_clear_flags(PCI_PROBE_ONLY);
257 pr_info("PROBE_ONLY %s\n", val ? "enabled" : "disabled");
259 EXPORT_SYMBOL_GPL(of_pci_check_probe_only);
262 * devm_of_pci_get_host_bridge_resources() - Resource-managed parsing of PCI
263 * host bridge resources from DT
264 * @dev: host bridge device
265 * @busno: bus number associated with the bridge root bus
266 * @bus_max: maximum number of buses for this bridge
267 * @resources: list where the range of resources will be added after DT parsing
268 * @ib_resources: list where the range of inbound resources (with addresses
269 * from 'dma-ranges') will be added after DT parsing
270 * @io_base: pointer to a variable that will contain on return the physical
271 * address for the start of the I/O range. Can be NULL if the caller doesn't
272 * expect I/O ranges to be present in the device tree.
274 * This function will parse the "ranges" property of a PCI host bridge device
275 * node and setup the resource mapping based on its content. It is expected
276 * that the property conforms with the Power ePAPR document.
278 * It returns zero if the range parsing has been successful or a standard error
279 * value if it failed.
281 static int devm_of_pci_get_host_bridge_resources(struct device *dev,
282 unsigned char busno, unsigned char bus_max,
283 struct list_head *resources,
284 struct list_head *ib_resources,
285 resource_size_t *io_base)
287 struct device_node *dev_node = dev->of_node;
288 struct resource *res, tmp_res;
289 struct resource *bus_range;
290 struct of_pci_range range;
291 struct of_pci_range_parser parser;
292 const char *range_type;
296 *io_base = (resource_size_t)OF_BAD_ADDR;
298 bus_range = devm_kzalloc(dev, sizeof(*bus_range), GFP_KERNEL);
302 dev_info(dev, "host bridge %pOF ranges:\n", dev_node);
304 err = of_pci_parse_bus_range(dev_node, bus_range);
306 bus_range->start = busno;
307 bus_range->end = bus_max;
308 bus_range->flags = IORESOURCE_BUS;
309 dev_info(dev, " No bus range found for %pOF, using %pR\n",
310 dev_node, bus_range);
312 if (bus_range->end > bus_range->start + bus_max)
313 bus_range->end = bus_range->start + bus_max;
315 pci_add_resource(resources, bus_range);
317 /* Check for ranges property */
318 err = of_pci_range_parser_init(&parser, dev_node);
322 dev_dbg(dev, "Parsing ranges property...\n");
323 for_each_of_pci_range(&parser, &range) {
324 /* Read next ranges element */
325 if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_IO)
327 else if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_MEM)
331 dev_info(dev, " %6s %#012llx..%#012llx -> %#012llx\n",
332 range_type, range.cpu_addr,
333 range.cpu_addr + range.size - 1, range.pci_addr);
336 * If we failed translation or got a zero-sized region
337 * then skip this range
339 if (range.cpu_addr == OF_BAD_ADDR || range.size == 0)
342 err = of_pci_range_to_resource(&range, dev_node, &tmp_res);
346 res = devm_kmemdup(dev, &tmp_res, sizeof(tmp_res), GFP_KERNEL);
352 if (resource_type(res) == IORESOURCE_IO) {
354 dev_err(dev, "I/O range found for %pOF. Please provide an io_base pointer to save CPU base address\n",
359 if (*io_base != (resource_size_t)OF_BAD_ADDR)
360 dev_warn(dev, "More than one I/O resource converted for %pOF. CPU base address for old range lost!\n",
362 *io_base = range.cpu_addr;
363 } else if (resource_type(res) == IORESOURCE_MEM) {
364 res->flags &= ~IORESOURCE_MEM_64;
367 pci_add_resource_offset(resources, res, res->start - range.pci_addr);
370 /* Check for dma-ranges property */
373 err = of_pci_dma_range_parser_init(&parser, dev_node);
377 dev_dbg(dev, "Parsing dma-ranges property...\n");
378 for_each_of_pci_range(&parser, &range) {
380 * If we failed translation or got a zero-sized region
381 * then skip this range
383 if (((range.flags & IORESOURCE_TYPE_BITS) != IORESOURCE_MEM) ||
384 range.cpu_addr == OF_BAD_ADDR || range.size == 0)
387 dev_info(dev, " %6s %#012llx..%#012llx -> %#012llx\n",
388 "IB MEM", range.cpu_addr,
389 range.cpu_addr + range.size - 1, range.pci_addr);
392 err = of_pci_range_to_resource(&range, dev_node, &tmp_res);
396 res = devm_kmemdup(dev, &tmp_res, sizeof(tmp_res), GFP_KERNEL);
402 pci_add_resource_offset(ib_resources, res,
403 res->start - range.pci_addr);
409 pci_free_resource_list(resources);
413 #if IS_ENABLED(CONFIG_OF_IRQ)
415 * of_irq_parse_pci - Resolve the interrupt for a PCI device
416 * @pdev: the device whose interrupt is to be resolved
417 * @out_irq: structure of_phandle_args filled by this function
419 * This function resolves the PCI interrupt for a given PCI device. If a
420 * device-node exists for a given pci_dev, it will use normal OF tree
421 * walking. If not, it will implement standard swizzling and walk up the
422 * PCI tree until an device-node is found, at which point it will finish
423 * resolving using the OF tree walking.
425 static int of_irq_parse_pci(const struct pci_dev *pdev, struct of_phandle_args *out_irq)
427 struct device_node *dn, *ppnode = NULL;
428 struct pci_dev *ppdev;
434 * Check if we have a device node, if yes, fallback to standard
435 * device tree parsing
437 dn = pci_device_to_OF_node(pdev);
439 rc = of_irq_parse_one(dn, 0, out_irq);
445 * Ok, we don't, time to have fun. Let's start by building up an
446 * interrupt spec. we assume #interrupt-cells is 1, which is standard
447 * for PCI. If you do different, then don't use that routine.
449 rc = pci_read_config_byte(pdev, PCI_INTERRUPT_PIN, &pin);
452 /* No pin, exit with no error message. */
456 /* Local interrupt-map in the device node? Use it! */
457 if (of_property_present(dn, "interrupt-map")) {
458 pin = pci_swizzle_interrupt_pin(pdev, pin);
462 /* Now we walk up the PCI tree */
464 /* Get the pci_dev of our parent */
465 ppdev = pdev->bus->self;
467 /* Ouch, it's a host bridge... */
469 ppnode = pci_bus_to_OF_node(pdev->bus);
471 /* No node for host bridge ? give up */
472 if (ppnode == NULL) {
477 /* We found a P2P bridge, check if it has a node */
478 ppnode = pci_device_to_OF_node(ppdev);
482 * Ok, we have found a parent with a device-node, hand over to
483 * the OF parsing code.
484 * We build a unit address from the linux device to be used for
485 * resolution. Note that we use the linux bus number which may
486 * not match your firmware bus numbering.
487 * Fortunately, in most cases, interrupt-map-mask doesn't
488 * include the bus number as part of the matching.
489 * You should still be careful about that though if you intend
490 * to rely on this function (you ship a firmware that doesn't
491 * create device nodes for all PCI devices).
497 * We can only get here if we hit a P2P bridge with no node;
498 * let's do standard swizzling and try again
500 pin = pci_swizzle_interrupt_pin(pdev, pin);
504 out_irq->np = ppnode;
505 out_irq->args_count = 1;
506 out_irq->args[0] = pin;
507 laddr[0] = cpu_to_be32((pdev->bus->number << 16) | (pdev->devfn << 8));
508 laddr[1] = laddr[2] = cpu_to_be32(0);
509 rc = of_irq_parse_raw(laddr, out_irq);
516 "%s: no interrupt-map found, INTx interrupts not available\n",
518 pr_warn_once("%s: possibly some PCI slots don't have level triggered interrupts capability\n",
521 dev_err(&pdev->dev, "%s: failed with rc=%d\n", __func__, rc);
527 * of_irq_parse_and_map_pci() - Decode a PCI IRQ from the device tree and map to a VIRQ
528 * @dev: The PCI device needing an IRQ
529 * @slot: PCI slot number; passed when used as map_irq callback. Unused
530 * @pin: PCI IRQ pin number; passed when used as map_irq callback. Unused
532 * @slot and @pin are unused, but included in the function so that this
533 * function can be used directly as the map_irq callback to
534 * pci_assign_irq() and struct pci_host_bridge.map_irq pointer
536 int of_irq_parse_and_map_pci(const struct pci_dev *dev, u8 slot, u8 pin)
538 struct of_phandle_args oirq;
541 ret = of_irq_parse_pci(dev, &oirq);
543 return 0; /* Proper return code 0 == NO_IRQ */
545 return irq_create_of_mapping(&oirq);
547 EXPORT_SYMBOL_GPL(of_irq_parse_and_map_pci);
548 #endif /* CONFIG_OF_IRQ */
550 static int pci_parse_request_of_pci_ranges(struct device *dev,
551 struct pci_host_bridge *bridge)
553 int err, res_valid = 0;
554 resource_size_t iobase;
555 struct resource_entry *win, *tmp;
557 INIT_LIST_HEAD(&bridge->windows);
558 INIT_LIST_HEAD(&bridge->dma_ranges);
560 err = devm_of_pci_get_host_bridge_resources(dev, 0, 0xff, &bridge->windows,
561 &bridge->dma_ranges, &iobase);
565 err = devm_request_pci_bus_resources(dev, &bridge->windows);
569 resource_list_for_each_entry_safe(win, tmp, &bridge->windows) {
570 struct resource *res = win->res;
572 switch (resource_type(res)) {
574 err = devm_pci_remap_iospace(dev, res, iobase);
576 dev_warn(dev, "error %d: failed to map resource %pR\n",
578 resource_list_destroy_entry(win);
582 res_valid |= !(res->flags & IORESOURCE_PREFETCH);
584 if (!(res->flags & IORESOURCE_PREFETCH))
585 if (upper_32_bits(resource_size(res)))
586 dev_warn(dev, "Memory resource size exceeds max for 32 bits\n");
593 dev_warn(dev, "non-prefetchable memory resource required\n");
598 int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge)
603 bridge->swizzle_irq = pci_common_swizzle;
604 bridge->map_irq = of_irq_parse_and_map_pci;
606 return pci_parse_request_of_pci_ranges(dev, bridge);
609 #ifdef CONFIG_PCI_DYNAMIC_OF_NODES
611 void of_pci_remove_node(struct pci_dev *pdev)
613 struct device_node *np;
615 np = pci_device_to_OF_node(pdev);
616 if (!np || !of_node_check_flag(np, OF_DYNAMIC))
618 pdev->dev.of_node = NULL;
620 of_changeset_revert(np->data);
621 of_changeset_destroy(np->data);
625 void of_pci_make_dev_node(struct pci_dev *pdev)
627 struct device_node *ppnode, *np = NULL;
628 const char *pci_type;
629 struct of_changeset *cset;
634 * If there is already a device tree node linked to this device,
635 * return immediately.
637 if (pci_device_to_OF_node(pdev))
640 /* Check if there is device tree node for parent device */
641 if (!pdev->bus->self)
642 ppnode = pdev->bus->dev.of_node;
644 ppnode = pdev->bus->self->dev.of_node;
648 if (pci_is_bridge(pdev))
653 name = kasprintf(GFP_KERNEL, "%s@%x,%x", pci_type,
654 PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn));
658 cset = kmalloc(sizeof(*cset), GFP_KERNEL);
661 of_changeset_init(cset);
663 np = of_changeset_create_node(cset, ppnode, name);
665 goto out_destroy_cset;
667 ret = of_pci_add_properties(pdev, cset, np);
671 ret = of_changeset_apply(cset);
676 pdev->dev.of_node = np;
684 of_changeset_destroy(cset);
691 #endif /* CONFIG_PCI */
694 * of_pci_get_max_link_speed - Find the maximum link speed of the given device node.
695 * @node: Device tree node with the maximum link speed information.
697 * This function will try to find the limitation of link speed by finding
698 * a property called "max-link-speed" of the given device node.
701 * * > 0 - On success, a maximum link speed.
702 * * -EINVAL - Invalid "max-link-speed" property value, or failure to access
703 * the property of the device tree node.
705 * Returns the associated max link speed from DT, or a negative value if the
706 * required property is not found or is invalid.
708 int of_pci_get_max_link_speed(struct device_node *node)
712 if (of_property_read_u32(node, "max-link-speed", &max_link_speed) ||
713 max_link_speed == 0 || max_link_speed > 4)
716 return max_link_speed;
718 EXPORT_SYMBOL_GPL(of_pci_get_max_link_speed);
721 * of_pci_get_slot_power_limit - Parses the "slot-power-limit-milliwatt"
724 * @node: device tree node with the slot power limit information
725 * @slot_power_limit_value: pointer where the value should be stored in PCIe
726 * Slot Capabilities Register format
727 * @slot_power_limit_scale: pointer where the scale should be stored in PCIe
728 * Slot Capabilities Register format
730 * Returns the slot power limit in milliwatts and if @slot_power_limit_value
731 * and @slot_power_limit_scale pointers are non-NULL, fills in the value and
732 * scale in format used by PCIe Slot Capabilities Register.
734 * If the property is not found or is invalid, returns 0.
736 u32 of_pci_get_slot_power_limit(struct device_node *node,
737 u8 *slot_power_limit_value,
738 u8 *slot_power_limit_scale)
740 u32 slot_power_limit_mw;
743 if (of_property_read_u32(node, "slot-power-limit-milliwatt",
744 &slot_power_limit_mw))
745 slot_power_limit_mw = 0;
747 /* Calculate Slot Power Limit Value and Slot Power Limit Scale */
748 if (slot_power_limit_mw == 0) {
751 } else if (slot_power_limit_mw <= 255) {
752 value = slot_power_limit_mw;
754 } else if (slot_power_limit_mw <= 255*10) {
755 value = slot_power_limit_mw / 10;
757 slot_power_limit_mw = slot_power_limit_mw / 10 * 10;
758 } else if (slot_power_limit_mw <= 255*100) {
759 value = slot_power_limit_mw / 100;
761 slot_power_limit_mw = slot_power_limit_mw / 100 * 100;
762 } else if (slot_power_limit_mw <= 239*1000) {
763 value = slot_power_limit_mw / 1000;
765 slot_power_limit_mw = slot_power_limit_mw / 1000 * 1000;
766 } else if (slot_power_limit_mw < 250*1000) {
769 slot_power_limit_mw = 239*1000;
770 } else if (slot_power_limit_mw <= 600*1000) {
771 value = 0xF0 + (slot_power_limit_mw / 1000 - 250) / 25;
773 slot_power_limit_mw = slot_power_limit_mw / (1000*25) * (1000*25);
777 slot_power_limit_mw = 600*1000;
780 if (slot_power_limit_value)
781 *slot_power_limit_value = value;
783 if (slot_power_limit_scale)
784 *slot_power_limit_scale = scale;
786 return slot_power_limit_mw;
788 EXPORT_SYMBOL_GPL(of_pci_get_slot_power_limit);