1 // SPDX-License-Identifier: GPL-2.0+
3  * PCI <-> OF mapping helpers
22  * pci_set_of_node - Find and set device's DT device_node
26  * DT. Returns -ENODEV if the device is present, but disabled in the DT.
30 	if (!dev->bus->dev.of_node)  in pci_set_of_node()
34 		of_pci_find_child_device(dev->bus->dev.of_node, dev->devfn);  in pci_set_of_node()
41 		dev->bus->dev.of_node_reused = true;  in pci_set_of_node()
43 	device_set_node(&dev->dev, of_fwnode_handle(no_free_ptr(node)));  in pci_set_of_node()
49 	of_node_put(dev->dev.of_node);  in pci_release_of_node()
50 	device_set_node(&dev->dev, NULL);  in pci_release_of_node()
53 void pci_set_bus_of_node(struct pci_bus *bus)  in pci_set_bus_of_node()  argument
57 	if (bus->self == NULL) {  in pci_set_bus_of_node()
58 		node = pcibios_get_phb_of_node(bus);  in pci_set_bus_of_node()
60 		node = of_node_get(bus->self->dev.of_node);  in pci_set_bus_of_node()
61 		if (node && of_property_read_bool(node, "external-facing"))  in pci_set_bus_of_node()
62 			bus->self->external_facing = true;  in pci_set_bus_of_node()
65 	device_set_node(&bus->dev, of_fwnode_handle(node));  in pci_set_bus_of_node()
68 void pci_release_bus_of_node(struct pci_bus *bus)  in pci_release_bus_of_node()  argument
70 	of_node_put(bus->dev.of_node);  in pci_release_bus_of_node()
71 	device_set_node(&bus->dev, NULL);  in pci_release_bus_of_node()
74 struct device_node * __weak pcibios_get_phb_of_node(struct pci_bus *bus)  in pcibios_get_phb_of_node()  argument
77 	if (WARN_ON(bus->self || bus->parent))  in pcibios_get_phb_of_node()
82 	 * create above the root bus or its own parent. Normally only  in pcibios_get_phb_of_node()
85 	if (bus->bridge->of_node)  in pcibios_get_phb_of_node()
86 		return of_node_get(bus->bridge->of_node);  in pcibios_get_phb_of_node()
87 	if (bus->bridge->parent && bus->bridge->parent->of_node)  in pcibios_get_phb_of_node()
88 		return of_node_get(bus->bridge->parent->of_node);  in pcibios_get_phb_of_node()
92 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus)  in pci_host_bridge_of_msi_domain()  argument
97 	if (!bus->dev.of_node)  in pci_host_bridge_of_msi_domain()
101 	d = of_msi_get_domain(&bus->dev, bus->dev.of_node, DOMAIN_BUS_PCI_MSI);  in pci_host_bridge_of_msi_domain()
106 	 * If we don't have an msi-parent property, look for a domain  in pci_host_bridge_of_msi_domain()
109 	d = irq_find_matching_host(bus->dev.of_node, DOMAIN_BUS_PCI_MSI);  in pci_host_bridge_of_msi_domain()
113 	return irq_find_host(bus->dev.of_node);  in pci_host_bridge_of_msi_domain()
121 	if (dev && dev->of_node)  in pci_host_of_has_msi_map()
122 		return of_get_property(dev->of_node, "msi-map", NULL);  in pci_host_of_has_msi_map()
147 		 * Some OFs create a parent node "multifunc-device" as  in of_pci_find_child_device()
148 		 * a fake root for all functions of a multi-function  in of_pci_find_child_device()
151 		if (of_node_name_eq(node, "multifunc-device")) {  in 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
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.
199 	error = of_property_read_u32_array(node, "bus-range", bus_range,  in of_pci_parse_bus_range()
204 	res->name = node->name;  in of_pci_parse_bus_range()
205 	res->start = bus_range[0];  in of_pci_parse_bus_range()
206 	res->end = bus_range[1];  in of_pci_parse_bus_range()
207 	res->flags = IORESOURCE_BUS;  in of_pci_parse_bus_range()
213  * of_get_pci_domain_nr - Find the host bridge domain number
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
234 	error = of_property_read_u32(node, "linux,pci-domain", &domain);  in of_get_pci_domain_nr()
243  * of_pci_preserve_config - Return true if the boot configuration needs to
247  * Look for "linux,pci-probe-only" property for a given PCI controller's
266 	ret = of_property_read_u32(node, "linux,pci-probe-only", &val);  in of_pci_preserve_config()
268 		if (ret == -ENODATA || ret == -EOVERFLOW) {  in of_pci_preserve_config()
269 			pr_warn("Incorrect value for linux,pci-probe-only in %pOF, ignoring\n",  in of_pci_preserve_config()
273 		if (ret == -EINVAL) {  in of_pci_preserve_config()
289  * of_pci_check_probe_only - Setup probe only mode if linux,pci-probe-only
302  * devm_of_pci_get_host_bridge_resources() - Resource-managed parsing of PCI
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
309  * address for the start of the I/O range. Can be NULL if the caller doesn't
316  * It returns zero if the range parsing has been successful or a standard error
324 	struct device_node *dev_node = dev->of_node;  in devm_of_pci_get_host_bridge_resources()
327 	struct of_pci_range range;  in devm_of_pci_get_host_bridge_resources()  local
337 		return -ENOMEM;  in devm_of_pci_get_host_bridge_resources()
343 		bus_range->start = 0;  in devm_of_pci_get_host_bridge_resources()
344 		bus_range->end = 0xff;  in devm_of_pci_get_host_bridge_resources()
345 		bus_range->flags = IORESOURCE_BUS;  in devm_of_pci_get_host_bridge_resources()
347 		if (bus_range->end > 0xff) {  in devm_of_pci_get_host_bridge_resources()
348 			dev_warn(dev, "  Invalid end bus number in %pR, defaulting to 0xff\n",  in devm_of_pci_get_host_bridge_resources()
350 			bus_range->end = 0xff;  in devm_of_pci_get_host_bridge_resources()
361 	for_each_of_pci_range(&parser, &range) {  in devm_of_pci_get_host_bridge_resources()
363 		if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_IO)  in devm_of_pci_get_host_bridge_resources()
365 		else if ((range.flags & IORESOURCE_TYPE_BITS) == IORESOURCE_MEM)  in devm_of_pci_get_host_bridge_resources()
369 		dev_info(dev, "  %6s %#012llx..%#012llx -> %#012llx\n",  in devm_of_pci_get_host_bridge_resources()
370 			 range_type, range.cpu_addr,  in devm_of_pci_get_host_bridge_resources()
371 			 range.cpu_addr + range.size - 1, range.pci_addr);  in devm_of_pci_get_host_bridge_resources()
374 		 * If we failed translation or got a zero-sized region  in devm_of_pci_get_host_bridge_resources()
375 		 * then skip this range  in devm_of_pci_get_host_bridge_resources()
377 		if (range.cpu_addr == OF_BAD_ADDR || range.size == 0)  in devm_of_pci_get_host_bridge_resources()
380 		err = of_pci_range_to_resource(&range, dev_node, &tmp_res);  in devm_of_pci_get_host_bridge_resources()
386 			err = -ENOMEM;  in devm_of_pci_get_host_bridge_resources()
392 …dev_err(dev, "I/O range found for %pOF. Please provide an io_base pointer to save CPU base address…  in devm_of_pci_get_host_bridge_resources()
394 				err = -EINVAL;  in devm_of_pci_get_host_bridge_resources()
398 …dev_warn(dev, "More than one I/O resource converted for %pOF. CPU base address for old range lost!…  in devm_of_pci_get_host_bridge_resources()
400 			*io_base = range.cpu_addr;  in devm_of_pci_get_host_bridge_resources()
402 			res->flags &= ~IORESOURCE_MEM_64;  in devm_of_pci_get_host_bridge_resources()
405 		pci_add_resource_offset(resources, res,	res->start - range.pci_addr);  in devm_of_pci_get_host_bridge_resources()
408 	/* Check for dma-ranges property */  in devm_of_pci_get_host_bridge_resources()
415 	dev_dbg(dev, "Parsing dma-ranges property...\n");  in devm_of_pci_get_host_bridge_resources()
416 	for_each_of_pci_range(&parser, &range) {  in devm_of_pci_get_host_bridge_resources()
418 		 * If we failed translation or got a zero-sized region  in devm_of_pci_get_host_bridge_resources()
419 		 * then skip this range  in devm_of_pci_get_host_bridge_resources()
421 		if (((range.flags & IORESOURCE_TYPE_BITS) != IORESOURCE_MEM) ||  in devm_of_pci_get_host_bridge_resources()
422 		    range.cpu_addr == OF_BAD_ADDR || range.size == 0)  in devm_of_pci_get_host_bridge_resources()
425 		dev_info(dev, "  %6s %#012llx..%#012llx -> %#012llx\n",  in devm_of_pci_get_host_bridge_resources()
426 			 "IB MEM", range.cpu_addr,  in devm_of_pci_get_host_bridge_resources()
427 			 range.cpu_addr + range.size - 1, range.pci_addr);  in devm_of_pci_get_host_bridge_resources()
430 		err = of_pci_range_to_resource(&range, dev_node, &tmp_res);  in devm_of_pci_get_host_bridge_resources()
436 			err = -ENOMEM;  in devm_of_pci_get_host_bridge_resources()
441 					res->start - range.pci_addr);  in devm_of_pci_get_host_bridge_resources()
453  * of_irq_parse_pci - Resolve the interrupt for a PCI device
484 	 * interrupt spec.  we assume #interrupt-cells is 1, which is standard  in of_irq_parse_pci()
492 		return -ENODEV;  in of_irq_parse_pci()
494 	/* Local interrupt-map in the device node? Use it! */  in of_irq_parse_pci()
495 	if (of_property_present(dn, "interrupt-map")) {  in of_irq_parse_pci()
503 		ppdev = pdev->bus->self;  in of_irq_parse_pci()
507 			ppnode = pci_bus_to_OF_node(pdev->bus);  in of_irq_parse_pci()
511 				rc = -EINVAL;  in of_irq_parse_pci()
524 		 * resolution. Note that we use the linux bus number which may  in of_irq_parse_pci()
525 		 * not match your firmware bus numbering.  in of_irq_parse_pci()
527 		 * Fortunately, in most cases, interrupt-map-mask doesn't  in of_irq_parse_pci()
528 		 * include the bus number as part of the matching.  in of_irq_parse_pci()
545 	out_irq->np = ppnode;  in of_irq_parse_pci()
546 	out_irq->args_count = 1;  in of_irq_parse_pci()
547 	out_irq->args[0] = pin;  in of_irq_parse_pci()
548 	laddr[0] = cpu_to_be32((pdev->bus->number << 16) | (pdev->devfn << 8));  in of_irq_parse_pci()
555 	if (rc == -ENOENT) {  in of_irq_parse_pci()
556 		dev_warn(&pdev->dev,  in of_irq_parse_pci()
557 			"%s: no interrupt-map found, INTx interrupts not available\n",  in of_irq_parse_pci()
562 		dev_err(&pdev->dev, "%s: failed with rc=%d\n", __func__, rc);  in of_irq_parse_pci()
568  * of_irq_parse_and_map_pci() - Decode a PCI IRQ from the device tree and map to a VIRQ
598 	INIT_LIST_HEAD(&bridge->windows);  in pci_parse_request_of_pci_ranges()
599 	INIT_LIST_HEAD(&bridge->dma_ranges);  in pci_parse_request_of_pci_ranges()
601 	err = devm_of_pci_get_host_bridge_resources(dev, &bridge->windows,  in pci_parse_request_of_pci_ranges()
602 						    &bridge->dma_ranges, &iobase);  in pci_parse_request_of_pci_ranges()
606 	err = devm_request_pci_bus_resources(dev, &bridge->windows);  in pci_parse_request_of_pci_ranges()
610 	resource_list_for_each_entry_safe(win, tmp, &bridge->windows) {  in pci_parse_request_of_pci_ranges()
611 		struct resource *res = win->res;  in pci_parse_request_of_pci_ranges()
623 			res_valid |= !(res->flags & IORESOURCE_PREFETCH);  in pci_parse_request_of_pci_ranges()
625 			if (!(res->flags & IORESOURCE_PREFETCH))  in pci_parse_request_of_pci_ranges()
634 		dev_warn(dev, "non-prefetchable memory resource required\n");  in pci_parse_request_of_pci_ranges()
641 	if (!dev->of_node)  in devm_of_pci_bridge_init()
644 	bridge->swizzle_irq = pci_common_swizzle;  in devm_of_pci_bridge_init()
645 	bridge->map_irq = of_irq_parse_and_map_pci;  in devm_of_pci_bridge_init()
660 	device_remove_of_node(&pdev->dev);  in of_pci_remove_node()
661 	of_changeset_revert(np->data);  in of_pci_remove_node()
662 	of_changeset_destroy(np->data);  in of_pci_remove_node()
682 	if (!pdev->bus->self)  in of_pci_make_dev_node()
683 		ppnode = pdev->bus->dev.of_node;  in of_pci_make_dev_node()
685 		ppnode = pdev->bus->self->dev.of_node;  in of_pci_make_dev_node()
695 			 PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn));  in of_pci_make_dev_node()
716 	np->data = cset;  in of_pci_make_dev_node()
718 	ret = device_add_of_node(&pdev->dev, np);  in of_pci_make_dev_node()
727 	np->data = NULL;  in of_pci_make_dev_node()
742 	np = pci_bus_to_OF_node(bridge->bus);  in of_pci_remove_host_bridge_node()
746 	device_remove_of_node(&bridge->bus->dev);  in of_pci_remove_host_bridge_node()
747 	device_remove_of_node(&bridge->dev);  in of_pci_remove_host_bridge_node()
748 	of_changeset_revert(np->data);  in of_pci_remove_host_bridge_node()
749 	of_changeset_destroy(np->data);  in of_pci_remove_host_bridge_node()
761 	 * If there is already a device tree node linked to the PCI bus handled  in of_pci_make_host_bridge_node()
762 	 * by this bridge (i.e. the PCI root bus), nothing to do.  in of_pci_make_host_bridge_node()
764 	if (pci_bus_to_OF_node(bridge->bus))  in of_pci_make_host_bridge_node()
768 	 * The root bus has no node. Check that the host bridge has no node  in of_pci_make_host_bridge_node()
771 	if (bridge->dev.of_node) {  in of_pci_make_host_bridge_node()
772 		dev_err(&bridge->dev, "PCI host bridge of_node already set");  in of_pci_make_host_bridge_node()
782 	name = kasprintf(GFP_KERNEL, "pci@%x,%x", pci_domain_nr(bridge->bus),  in of_pci_make_host_bridge_node()
783 			 bridge->bus->number);  in of_pci_make_host_bridge_node()
803 	 * bus. Avoid any new device creation.  in of_pci_make_host_bridge_node()
806 	np->fwnode.dev = &bridge->dev;  in of_pci_make_host_bridge_node()
807 	fwnode_dev_initialized(&np->fwnode, true);  in of_pci_make_host_bridge_node()
813 	np->data = cset;  in of_pci_make_host_bridge_node()
815 	/* Add the of_node to host bridge and the root bus */  in of_pci_make_host_bridge_node()
816 	ret = device_add_of_node(&bridge->dev, np);  in of_pci_make_host_bridge_node()
820 	ret = device_add_of_node(&bridge->bus->dev, np);  in of_pci_make_host_bridge_node()
829 	device_remove_of_node(&bridge->dev);  in of_pci_make_host_bridge_node()
831 	np->data = NULL;  in of_pci_make_host_bridge_node()
845  * of_pci_supply_present() - Check if the power supply is present for the PCI
863 		supply = strrchr(prop->name, '-');  in of_pci_supply_present()
864 		if (supply && !strcmp(supply, "-supply"))  in of_pci_supply_present()
874  * of_pci_get_max_link_speed - Find the maximum link speed of the given device node.
878  * a property called "max-link-speed" of the given device node.
881  * * > 0	- On success, a maximum link speed.
882  * * -EINVAL	- Invalid "max-link-speed" property value, or failure to access
892 	if (of_property_read_u32(node, "max-link-speed", &max_link_speed) ||  in of_pci_get_max_link_speed()
894 		return -EINVAL;  in of_pci_get_max_link_speed()
901  * of_pci_get_slot_power_limit - Parses the "slot-power-limit-milliwatt"
911  * and @slot_power_limit_scale pointers are non-NULL, fills in the value and
923 	if (of_property_read_u32(node, "slot-power-limit-milliwatt",  in of_pci_get_slot_power_limit()
951 		value = 0xF0 + (slot_power_limit_mw / 1000 - 250) / 25;  in of_pci_get_slot_power_limit()