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/cleanup.h>
10 #include <linux/irqdomain.h>
11 #include <linux/kernel.h>
12 #include <linux/pci.h>
14 #include <linux/of_irq.h>
15 #include <linux/of_address.h>
16 #include <linux/of_pci.h>
17 #include <linux/platform_device.h>
22 * pci_set_of_node - Find and set device's DT device_node
23 * @dev: the PCI device structure to fill
25 * Returns 0 on success with of_node set or when no device is described in the
26 * DT. Returns -ENODEV if the device is present, but disabled in the DT.
28 int pci_set_of_node(struct pci_dev *dev)
30 if (!dev->bus->dev.of_node)
33 struct device_node *node __free(device_node) =
34 of_pci_find_child_device(dev->bus->dev.of_node, dev->devfn);
38 struct device *pdev __free(put_device) =
39 bus_find_device_by_of_node(&platform_bus_type, node);
41 dev->bus->dev.of_node_reused = true;
43 device_set_node(&dev->dev, of_fwnode_handle(no_free_ptr(node)));
47 void pci_release_of_node(struct pci_dev *dev)
49 of_node_put(dev->dev.of_node);
50 device_set_node(&dev->dev, NULL);
53 void pci_set_bus_of_node(struct pci_bus *bus)
55 struct device_node *node;
57 if (bus->self == NULL) {
58 node = pcibios_get_phb_of_node(bus);
60 node = of_node_get(bus->self->dev.of_node);
61 if (node && of_property_read_bool(node, "external-facing"))
62 bus->self->external_facing = true;
65 device_set_node(&bus->dev, of_fwnode_handle(node));
68 void pci_release_bus_of_node(struct pci_bus *bus)
70 of_node_put(bus->dev.of_node);
71 device_set_node(&bus->dev, NULL);
74 struct device_node * __weak pcibios_get_phb_of_node(struct pci_bus *bus)
76 /* This should only be called for PHBs */
77 if (WARN_ON(bus->self || bus->parent))
81 * Look for a node pointer in either the intermediary device we
82 * create above the root bus or its own parent. Normally only
83 * the later is populated.
85 if (bus->bridge->of_node)
86 return of_node_get(bus->bridge->of_node);
87 if (bus->bridge->parent && bus->bridge->parent->of_node)
88 return of_node_get(bus->bridge->parent->of_node);
92 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus)
94 #ifdef CONFIG_IRQ_DOMAIN
97 if (!bus->dev.of_node)
100 /* Start looking for a phandle to an MSI controller. */
101 d = of_msi_get_domain(&bus->dev, bus->dev.of_node, DOMAIN_BUS_PCI_MSI);
106 * If we don't have an msi-parent property, look for a domain
107 * directly attached to the host bridge.
109 d = irq_find_matching_host(bus->dev.of_node, DOMAIN_BUS_PCI_MSI);
113 return irq_find_host(bus->dev.of_node);
119 bool pci_host_of_has_msi_map(struct device *dev)
121 if (dev && dev->of_node)
122 return of_get_property(dev->of_node, "msi-map", NULL);
126 static inline int __of_pci_pci_compare(struct device_node *node,
131 devfn = of_pci_get_devfn(node);
135 return devfn == data;
138 struct device_node *of_pci_find_child_device(struct device_node *parent,
141 struct device_node *node, *node2;
143 for_each_child_of_node(parent, node) {
144 if (__of_pci_pci_compare(node, devfn))
147 * Some OFs create a parent node "multifunc-device" as
148 * a fake root for all functions of a multi-function
149 * device we go down them as well.
151 if (of_node_name_eq(node, "multifunc-device")) {
152 for_each_child_of_node(node, node2) {
153 if (__of_pci_pci_compare(node2, devfn)) {
162 EXPORT_SYMBOL_GPL(of_pci_find_child_device);
165 * of_pci_get_devfn() - Get device and function numbers for a device node
168 * Parses a standard 5-cell PCI resource and returns an 8-bit value that can
169 * be passed to the PCI_SLOT() and PCI_FUNC() macros to extract the device
170 * and function numbers respectively. On error a negative error code is
173 int of_pci_get_devfn(struct device_node *np)
178 error = of_property_read_u32_array(np, "reg", reg, ARRAY_SIZE(reg));
182 return (reg[0] >> 8) & 0xff;
184 EXPORT_SYMBOL_GPL(of_pci_get_devfn);
187 * of_pci_parse_bus_range() - parse the bus-range property of a PCI device
189 * @res: address to a struct resource to return the bus-range
191 * Returns 0 on success or a negative error-code on failure.
193 static int of_pci_parse_bus_range(struct device_node *node,
194 struct resource *res)
199 error = of_property_read_u32_array(node, "bus-range", bus_range,
200 ARRAY_SIZE(bus_range));
204 res->name = node->name;
205 res->start = bus_range[0];
206 res->end = bus_range[1];
207 res->flags = IORESOURCE_BUS;
213 * of_get_pci_domain_nr - Find the host bridge domain number
214 * of the given device node.
215 * @node: Device tree node with the domain information.
217 * This function will try to obtain the host bridge domain number by finding
218 * a property called "linux,pci-domain" of the given device node.
221 * * > 0 - On success, an associated domain number.
222 * * -EINVAL - The property "linux,pci-domain" does not exist.
223 * * -ENODATA - The linux,pci-domain" property does not have value.
224 * * -EOVERFLOW - Invalid "linux,pci-domain" property value.
226 * Returns the associated domain number from DT in the range [0-0xffff], or
227 * a negative value if the required property is not found.
229 int of_get_pci_domain_nr(struct device_node *node)
234 error = of_property_read_u32(node, "linux,pci-domain", &domain);
240 EXPORT_SYMBOL_GPL(of_get_pci_domain_nr);
243 * of_pci_preserve_config - Return true if the boot configuration needs to
245 * @node: Device tree node.
247 * Look for "linux,pci-probe-only" property for a given PCI controller's
248 * node and return true if found. Also look in the chosen node if the
249 * property is not found in the given controller's node. Having this
250 * property ensures that the kernel doesn't reconfigure the BARs and bridge
251 * windows that are already done by the platform firmware.
253 * Return: true if the property exists; false otherwise.
255 bool of_pci_preserve_config(struct device_node *node)
261 pr_warn("device node is NULL, trying with of_chosen\n");
266 ret = of_property_read_u32(node, "linux,pci-probe-only", &val);
268 if (ret == -ENODATA || ret == -EOVERFLOW) {
269 pr_warn("Incorrect value for linux,pci-probe-only in %pOF, ignoring\n",
273 if (ret == -EINVAL) {
274 if (node == of_chosen)
289 * of_pci_check_probe_only - Setup probe only mode if linux,pci-probe-only
290 * is present and valid
292 void of_pci_check_probe_only(void)
294 if (of_pci_preserve_config(of_chosen))
295 pci_add_flags(PCI_PROBE_ONLY);
297 pci_clear_flags(PCI_PROBE_ONLY);
299 EXPORT_SYMBOL_GPL(of_pci_check_probe_only);
302 * devm_of_pci_get_host_bridge_resources() - Resource-managed parsing of PCI
303 * host bridge resources from DT
304 * @dev: host bridge device
305 * @resources: list where the range of resources will be added after DT parsing
306 * @ib_resources: list where the range of inbound resources (with addresses
307 * from 'dma-ranges') will be added after DT parsing
308 * @io_base: pointer to a variable that will contain on return the physical
309 * address for the start of the I/O range. Can be NULL if the caller doesn't
310 * expect I/O ranges to be present in the device tree.
312 * This function will parse the "ranges" property of a PCI host bridge device
313 * node and setup the resource mapping based on its content. It is expected
314 * that the property conforms with the Power ePAPR document.
316 * It returns zero if the range parsing has been successful or a standard error
317 * value if it failed.
319 static int devm_of_pci_get_host_bridge_resources(struct device *dev,
320 struct list_head *resources,
321 struct list_head *ib_resources,
322 resource_size_t *io_base)
324 struct device_node *dev_node = dev->of_node;
325 struct resource *res, tmp_res;
326 struct resource *bus_range;
327 struct of_pci_range range;
328 struct of_pci_range_parser parser;
329 const char *range_type;
333 *io_base = (resource_size_t)OF_BAD_ADDR;
335 bus_range = devm_kzalloc(dev, sizeof(*bus_range), GFP_KERNEL);
339 dev_info(dev, "host bridge %pOF ranges:\n", dev_node);
341 err = of_pci_parse_bus_range(dev_node, bus_range);
343 bus_range->start = 0;
344 bus_range->end = 0xff;
345 bus_range->flags = IORESOURCE_BUS;
347 if (bus_range->end > 0xff) {
348 dev_warn(dev, " Invalid end bus number in %pR, defaulting to 0xff\n",
350 bus_range->end = 0xff;
353 pci_add_resource(resources, bus_range);
355 /* Check for ranges property */
356 err = of_pci_range_parser_init(&parser, dev_node);
360 dev_dbg(dev, "Parsing ranges property...\n");
361 for_each_of_pci_range(&parser, &range) {
362 /* Read next ranges element */
363 if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_IO)
365 else if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_MEM)
369 dev_info(dev, " %6s %#012llx..%#012llx -> %#012llx\n",
370 range_type, range.cpu_addr,
371 range.cpu_addr + range.size - 1, range.pci_addr);
374 * If we failed translation or got a zero-sized region
375 * then skip this range
377 if (range.cpu_addr == OF_BAD_ADDR || range.size == 0)
380 err = of_pci_range_to_resource(&range, dev_node, &tmp_res);
384 res = devm_kmemdup(dev, &tmp_res, sizeof(tmp_res), GFP_KERNEL);
390 if (resource_type(res) == IORESOURCE_IO) {
392 dev_err(dev, "I/O range found for %pOF. Please provide an io_base pointer to save CPU base address\n",
397 if (*io_base != (resource_size_t)OF_BAD_ADDR)
398 dev_warn(dev, "More than one I/O resource converted for %pOF. CPU base address for old range lost!\n",
400 *io_base = range.cpu_addr;
401 } else if (resource_type(res) == IORESOURCE_MEM) {
402 res->flags &= ~IORESOURCE_MEM_64;
405 pci_add_resource_offset(resources, res, res->start - range.pci_addr);
408 /* Check for dma-ranges property */
411 err = of_pci_dma_range_parser_init(&parser, dev_node);
415 dev_dbg(dev, "Parsing dma-ranges property...\n");
416 for_each_of_pci_range(&parser, &range) {
418 * If we failed translation or got a zero-sized region
419 * then skip this range
421 if (((range.flags & IORESOURCE_TYPE_BITS) != IORESOURCE_MEM) ||
422 range.cpu_addr == OF_BAD_ADDR || range.size == 0)
425 dev_info(dev, " %6s %#012llx..%#012llx -> %#012llx\n",
426 "IB MEM", range.cpu_addr,
427 range.cpu_addr + range.size - 1, range.pci_addr);
430 err = of_pci_range_to_resource(&range, dev_node, &tmp_res);
434 res = devm_kmemdup(dev, &tmp_res, sizeof(tmp_res), GFP_KERNEL);
440 pci_add_resource_offset(ib_resources, res,
441 res->start - range.pci_addr);
447 pci_free_resource_list(resources);
451 #if IS_ENABLED(CONFIG_OF_IRQ)
453 * of_irq_parse_pci - Resolve the interrupt for a PCI device
454 * @pdev: the device whose interrupt is to be resolved
455 * @out_irq: structure of_phandle_args filled by this function
457 * This function resolves the PCI interrupt for a given PCI device. If a
458 * device-node exists for a given pci_dev, it will use normal OF tree
459 * walking. If not, it will implement standard swizzling and walk up the
460 * PCI tree until an device-node is found, at which point it will finish
461 * resolving using the OF tree walking.
463 static int of_irq_parse_pci(const struct pci_dev *pdev, struct of_phandle_args *out_irq)
465 struct device_node *dn, *ppnode = NULL;
466 struct pci_dev *ppdev;
472 * Check if we have a device node, if yes, fallback to standard
473 * device tree parsing
475 dn = pci_device_to_OF_node(pdev);
477 rc = of_irq_parse_one(dn, 0, out_irq);
483 * Ok, we don't, time to have fun. Let's start by building up an
484 * interrupt spec. we assume #interrupt-cells is 1, which is standard
485 * for PCI. If you do different, then don't use that routine.
487 rc = pci_read_config_byte(pdev, PCI_INTERRUPT_PIN, &pin);
490 /* No pin, exit with no error message. */
494 /* Local interrupt-map in the device node? Use it! */
495 if (of_property_present(dn, "interrupt-map")) {
496 pin = pci_swizzle_interrupt_pin(pdev, pin);
500 /* Now we walk up the PCI tree */
502 /* Get the pci_dev of our parent */
503 ppdev = pdev->bus->self;
505 /* Ouch, it's a host bridge... */
507 ppnode = pci_bus_to_OF_node(pdev->bus);
509 /* No node for host bridge ? give up */
510 if (ppnode == NULL) {
515 /* We found a P2P bridge, check if it has a node */
516 ppnode = pci_device_to_OF_node(ppdev);
520 * Ok, we have found a parent with a device-node, hand over to
521 * the OF parsing code.
522 * We build a unit address from the linux device to be used for
523 * resolution. Note that we use the linux bus number which may
524 * not match your firmware bus numbering.
525 * Fortunately, in most cases, interrupt-map-mask doesn't
526 * include the bus number as part of the matching.
527 * You should still be careful about that though if you intend
528 * to rely on this function (you ship a firmware that doesn't
529 * create device nodes for all PCI devices).
535 * We can only get here if we hit a P2P bridge with no node;
536 * let's do standard swizzling and try again
538 pin = pci_swizzle_interrupt_pin(pdev, pin);
542 out_irq->np = ppnode;
543 out_irq->args_count = 1;
544 out_irq->args[0] = pin;
545 laddr[0] = cpu_to_be32((pdev->bus->number << 16) | (pdev->devfn << 8));
546 laddr[1] = laddr[2] = cpu_to_be32(0);
547 rc = of_irq_parse_raw(laddr, out_irq);
554 "%s: no interrupt-map found, INTx interrupts not available\n",
556 pr_warn_once("%s: possibly some PCI slots don't have level triggered interrupts capability\n",
559 dev_err(&pdev->dev, "%s: failed with rc=%d\n", __func__, rc);
565 * of_irq_parse_and_map_pci() - Decode a PCI IRQ from the device tree and map to a VIRQ
566 * @dev: The PCI device needing an IRQ
567 * @slot: PCI slot number; passed when used as map_irq callback. Unused
568 * @pin: PCI IRQ pin number; passed when used as map_irq callback. Unused
570 * @slot and @pin are unused, but included in the function so that this
571 * function can be used directly as the map_irq callback to
572 * pci_assign_irq() and struct pci_host_bridge.map_irq pointer
574 int of_irq_parse_and_map_pci(const struct pci_dev *dev, u8 slot, u8 pin)
576 struct of_phandle_args oirq;
579 ret = of_irq_parse_pci(dev, &oirq);
581 return 0; /* Proper return code 0 == NO_IRQ */
583 return irq_create_of_mapping(&oirq);
585 EXPORT_SYMBOL_GPL(of_irq_parse_and_map_pci);
586 #endif /* CONFIG_OF_IRQ */
588 static int pci_parse_request_of_pci_ranges(struct device *dev,
589 struct pci_host_bridge *bridge)
591 int err, res_valid = 0;
592 resource_size_t iobase;
593 struct resource_entry *win, *tmp;
595 INIT_LIST_HEAD(&bridge->windows);
596 INIT_LIST_HEAD(&bridge->dma_ranges);
598 err = devm_of_pci_get_host_bridge_resources(dev, &bridge->windows,
599 &bridge->dma_ranges, &iobase);
603 err = devm_request_pci_bus_resources(dev, &bridge->windows);
607 resource_list_for_each_entry_safe(win, tmp, &bridge->windows) {
608 struct resource *res = win->res;
610 switch (resource_type(res)) {
612 err = devm_pci_remap_iospace(dev, res, iobase);
614 dev_warn(dev, "error %d: failed to map resource %pR\n",
616 resource_list_destroy_entry(win);
620 res_valid |= !(res->flags & IORESOURCE_PREFETCH);
622 if (!(res->flags & IORESOURCE_PREFETCH))
623 if (upper_32_bits(resource_size(res)))
624 dev_warn(dev, "Memory resource size exceeds max for 32 bits\n");
631 dev_warn(dev, "non-prefetchable memory resource required\n");
636 int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge)
641 bridge->swizzle_irq = pci_common_swizzle;
642 bridge->map_irq = of_irq_parse_and_map_pci;
644 return pci_parse_request_of_pci_ranges(dev, bridge);
647 #ifdef CONFIG_PCI_DYNAMIC_OF_NODES
649 void of_pci_remove_node(struct pci_dev *pdev)
651 struct device_node *np;
653 np = pci_device_to_OF_node(pdev);
654 if (!np || !of_node_check_flag(np, OF_DYNAMIC))
656 pdev->dev.of_node = NULL;
658 of_changeset_revert(np->data);
659 of_changeset_destroy(np->data);
663 void of_pci_make_dev_node(struct pci_dev *pdev)
665 struct device_node *ppnode, *np = NULL;
666 const char *pci_type;
667 struct of_changeset *cset;
672 * If there is already a device tree node linked to this device,
673 * return immediately.
675 if (pci_device_to_OF_node(pdev))
678 /* Check if there is device tree node for parent device */
679 if (!pdev->bus->self)
680 ppnode = pdev->bus->dev.of_node;
682 ppnode = pdev->bus->self->dev.of_node;
686 if (pci_is_bridge(pdev))
691 name = kasprintf(GFP_KERNEL, "%s@%x,%x", pci_type,
692 PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn));
696 cset = kmalloc(sizeof(*cset), GFP_KERNEL);
699 of_changeset_init(cset);
701 np = of_changeset_create_node(cset, ppnode, name);
703 goto out_destroy_cset;
705 ret = of_pci_add_properties(pdev, cset, np);
709 ret = of_changeset_apply(cset);
714 pdev->dev.of_node = np;
722 of_changeset_destroy(cset);
730 * of_pci_supply_present() - Check if the power supply is present for the PCI
732 * @np: Device tree node
734 * Check if the power supply for the PCI device is present in the device tree
737 * Return: true if at least one power supply exists; false otherwise.
739 bool of_pci_supply_present(struct device_node *np)
741 struct property *prop;
747 for_each_property_of_node(np, prop) {
748 supply = strrchr(prop->name, '-');
749 if (supply && !strcmp(supply, "-supply"))
756 #endif /* CONFIG_PCI */
759 * of_pci_get_max_link_speed - Find the maximum link speed of the given device node.
760 * @node: Device tree node with the maximum link speed information.
762 * This function will try to find the limitation of link speed by finding
763 * a property called "max-link-speed" of the given device node.
766 * * > 0 - On success, a maximum link speed.
767 * * -EINVAL - Invalid "max-link-speed" property value, or failure to access
768 * the property of the device tree node.
770 * Returns the associated max link speed from DT, or a negative value if the
771 * required property is not found or is invalid.
773 int of_pci_get_max_link_speed(struct device_node *node)
777 if (of_property_read_u32(node, "max-link-speed", &max_link_speed) ||
778 max_link_speed == 0 || max_link_speed > 4)
781 return max_link_speed;
783 EXPORT_SYMBOL_GPL(of_pci_get_max_link_speed);
786 * of_pci_get_slot_power_limit - Parses the "slot-power-limit-milliwatt"
789 * @node: device tree node with the slot power limit information
790 * @slot_power_limit_value: pointer where the value should be stored in PCIe
791 * Slot Capabilities Register format
792 * @slot_power_limit_scale: pointer where the scale should be stored in PCIe
793 * Slot Capabilities Register format
795 * Returns the slot power limit in milliwatts and if @slot_power_limit_value
796 * and @slot_power_limit_scale pointers are non-NULL, fills in the value and
797 * scale in format used by PCIe Slot Capabilities Register.
799 * If the property is not found or is invalid, returns 0.
801 u32 of_pci_get_slot_power_limit(struct device_node *node,
802 u8 *slot_power_limit_value,
803 u8 *slot_power_limit_scale)
805 u32 slot_power_limit_mw;
808 if (of_property_read_u32(node, "slot-power-limit-milliwatt",
809 &slot_power_limit_mw))
810 slot_power_limit_mw = 0;
812 /* Calculate Slot Power Limit Value and Slot Power Limit Scale */
813 if (slot_power_limit_mw == 0) {
816 } else if (slot_power_limit_mw <= 255) {
817 value = slot_power_limit_mw;
819 } else if (slot_power_limit_mw <= 255*10) {
820 value = slot_power_limit_mw / 10;
822 slot_power_limit_mw = slot_power_limit_mw / 10 * 10;
823 } else if (slot_power_limit_mw <= 255*100) {
824 value = slot_power_limit_mw / 100;
826 slot_power_limit_mw = slot_power_limit_mw / 100 * 100;
827 } else if (slot_power_limit_mw <= 239*1000) {
828 value = slot_power_limit_mw / 1000;
830 slot_power_limit_mw = slot_power_limit_mw / 1000 * 1000;
831 } else if (slot_power_limit_mw < 250*1000) {
834 slot_power_limit_mw = 239*1000;
835 } else if (slot_power_limit_mw <= 600*1000) {
836 value = 0xF0 + (slot_power_limit_mw / 1000 - 250) / 25;
838 slot_power_limit_mw = slot_power_limit_mw / (1000*25) * (1000*25);
842 slot_power_limit_mw = 600*1000;
845 if (slot_power_limit_value)
846 *slot_power_limit_value = value;
848 if (slot_power_limit_scale)
849 *slot_power_limit_scale = scale;
851 return slot_power_limit_mw;
853 EXPORT_SYMBOL_GPL(of_pci_get_slot_power_limit);