1 // SPDX-License-Identifier: GPL-2.0-only
3 * Helper routines to scan the device tree for PCI devices and busses
5 * Migrated out of PowerPC architecture pci_64.c file by Grant Likely
6 * <grant.likely@secretlab.ca> so that these routines are available for
9 * Copyright (C) 2003 Anton Blanchard <anton@au.ibm.com>, IBM
10 * Rework, based on alpha PCI code.
11 * Copyright (c) 2009 Secret Lab Technologies Ltd.
14 #include <linux/pci.h>
15 #include <linux/export.h>
16 #include <asm/pci-bridge.h>
20 * get_int_prop - Decode a u32 from a device tree property
22 static u32 get_int_prop(struct device_node *np, const char *name, u32 def)
27 prop = of_get_property(np, name, &len);
29 return of_read_number(prop, 1);
34 * pci_parse_of_flags - Parse the flags cell of a device tree PCI address
35 * @addr0: value of 1st cell of a device tree PCI address.
36 * @bridge: Set this flag if the address is from a bridge 'ranges' property
38 unsigned int pci_parse_of_flags(u32 addr0, int bridge)
40 unsigned int flags = 0;
42 if (addr0 & 0x02000000) {
43 flags = IORESOURCE_MEM | PCI_BASE_ADDRESS_SPACE_MEMORY;
44 flags |= (addr0 >> 22) & PCI_BASE_ADDRESS_MEM_TYPE_64;
45 if (flags & PCI_BASE_ADDRESS_MEM_TYPE_64)
46 flags |= IORESOURCE_MEM_64;
47 flags |= (addr0 >> 28) & PCI_BASE_ADDRESS_MEM_TYPE_1M;
48 if (addr0 & 0x40000000)
49 flags |= IORESOURCE_PREFETCH
50 | PCI_BASE_ADDRESS_MEM_PREFETCH;
51 /* Note: We don't know whether the ROM has been left enabled
52 * by the firmware or not. We mark it as disabled (ie, we do
53 * not set the IORESOURCE_ROM_ENABLE flag) for now rather than
54 * do a config space read, it will be force-enabled if needed
56 if (!bridge && (addr0 & 0xff) == 0x30)
57 flags |= IORESOURCE_READONLY;
58 } else if (addr0 & 0x01000000)
59 flags = IORESOURCE_IO | PCI_BASE_ADDRESS_SPACE_IO;
61 flags |= IORESOURCE_SIZEALIGN;
66 * of_pci_parse_addrs - Parse PCI addresses assigned in the device tree node
67 * @node: device tree node for the PCI device
68 * @dev: pci_dev structure for the device
70 * This function parses the 'assigned-addresses' property of a PCI devices'
71 * device tree node and writes them into the associated pci_dev structure.
73 static void of_pci_parse_addrs(struct device_node *node, struct pci_dev *dev)
77 struct pci_bus_region region;
82 bool mark_unset = false;
84 addrs = of_get_property(node, "assigned-addresses", &proplen);
85 if (!addrs || !proplen) {
86 addrs = of_get_property(node, "reg", &proplen);
87 if (!addrs || !proplen)
92 pr_debug(" parse addresses (%d bytes) @ %p\n", proplen, addrs);
93 for (; proplen >= 20; proplen -= 20, addrs += 5) {
94 flags = pci_parse_of_flags(of_read_number(addrs, 1), 0);
97 base = of_read_number(&addrs[1], 2);
98 size = of_read_number(&addrs[3], 2);
101 i = of_read_number(addrs, 1) & 0xff;
102 pr_debug(" base: %llx, size: %llx, i: %x\n",
103 (unsigned long long)base,
104 (unsigned long long)size, i);
106 if (PCI_BASE_ADDRESS_0 <= i && i <= PCI_BASE_ADDRESS_5) {
107 res = &dev->resource[(i - PCI_BASE_ADDRESS_0) >> 2];
108 } else if (i == dev->rom_base_reg) {
109 res = &dev->resource[PCI_ROM_RESOURCE];
110 flags |= IORESOURCE_READONLY;
112 printk(KERN_ERR "PCI: bad cfg reg num 0x%x\n", i);
117 res->flags |= IORESOURCE_UNSET;
118 res->name = pci_name(dev);
120 region.end = base + size - 1;
121 pcibios_bus_to_resource(dev->bus, res, ®ion);
126 * of_create_pci_dev - Given a device tree node on a pci bus, create a pci_dev
127 * @node: device tree node pointer
128 * @bus: bus the device is sitting on
129 * @devfn: PCI function number, extracted from device tree by caller.
131 struct pci_dev *of_create_pci_dev(struct device_node *node,
132 struct pci_bus *bus, int devfn)
136 dev = pci_alloc_dev(bus);
140 pr_debug(" create device, devfn: %x, type: %s\n", devfn,
141 of_node_get_device_type(node));
143 dev->dev.of_node = of_node_get(node);
144 dev->dev.parent = bus->bridge;
145 dev->dev.bus = &pci_bus_type;
147 dev->multifunction = 0; /* maybe a lie? */
148 dev->needs_freset = 0; /* pcie fundamental reset required */
149 set_pcie_port_type(dev);
151 pci_dev_assign_slot(dev);
152 dev->vendor = get_int_prop(node, "vendor-id", 0xffff);
153 dev->device = get_int_prop(node, "device-id", 0xffff);
154 dev->subsystem_vendor = get_int_prop(node, "subsystem-vendor-id", 0);
155 dev->subsystem_device = get_int_prop(node, "subsystem-id", 0);
157 dev->cfg_size = pci_cfg_space_size(dev);
159 dev_set_name(&dev->dev, "%04x:%02x:%02x.%d", pci_domain_nr(bus),
160 dev->bus->number, PCI_SLOT(devfn), PCI_FUNC(devfn));
161 dev->class = get_int_prop(node, "class-code", 0);
162 dev->revision = get_int_prop(node, "revision-id", 0);
164 pr_debug(" class: 0x%x\n", dev->class);
165 pr_debug(" revision: 0x%x\n", dev->revision);
167 dev->current_state = PCI_UNKNOWN; /* unknown power state */
168 dev->error_state = pci_channel_io_normal;
169 dev->dma_mask = 0xffffffff;
171 /* Early fixups, before probing the BARs */
172 pci_fixup_device(pci_fixup_early, dev);
174 if (of_node_is_type(node, "pci") || of_node_is_type(node, "pciex")) {
175 /* a PCI-PCI bridge */
176 dev->hdr_type = PCI_HEADER_TYPE_BRIDGE;
177 dev->rom_base_reg = PCI_ROM_ADDRESS1;
178 set_pcie_hotplug_bridge(dev);
179 } else if (of_node_is_type(node, "cardbus")) {
180 dev->hdr_type = PCI_HEADER_TYPE_CARDBUS;
182 dev->hdr_type = PCI_HEADER_TYPE_NORMAL;
183 dev->rom_base_reg = PCI_ROM_ADDRESS;
184 /* Maybe do a default OF mapping here */
188 of_pci_parse_addrs(node, dev);
190 pr_debug(" adding to system ...\n");
192 pci_device_add(dev, bus);
196 EXPORT_SYMBOL(of_create_pci_dev);
199 * of_scan_pci_bridge - Set up a PCI bridge and scan for child nodes
200 * @dev: pci_dev structure for the bridge
202 * of_scan_bus() calls this routine for each PCI bridge that it finds, and
203 * this routine in turn call of_scan_bus() recusively to scan for more child
206 void of_scan_pci_bridge(struct pci_dev *dev)
208 struct device_node *node = dev->dev.of_node;
210 struct pci_controller *phb;
211 const __be32 *busrange, *ranges;
213 struct pci_bus_region region;
214 struct resource *res;
218 pr_debug("of_scan_pci_bridge(%pOF)\n", node);
220 /* parse bus-range property */
221 busrange = of_get_property(node, "bus-range", &len);
222 if (busrange == NULL || len != 8) {
223 printk(KERN_DEBUG "Can't get bus-range for PCI-PCI bridge %pOF\n",
227 ranges = of_get_property(node, "ranges", &len);
228 if (ranges == NULL) {
229 printk(KERN_DEBUG "Can't get ranges for PCI-PCI bridge %pOF\n",
234 bus = pci_find_bus(pci_domain_nr(dev->bus),
235 of_read_number(busrange, 1));
237 bus = pci_add_new_bus(dev->bus, dev,
238 of_read_number(busrange, 1));
240 printk(KERN_ERR "Failed to create pci bus for %pOF\n",
246 bus->primary = dev->bus->number;
247 pci_bus_insert_busn_res(bus, of_read_number(busrange, 1),
248 of_read_number(busrange+1, 1));
251 /* parse ranges property */
252 /* PCI #address-cells == 3 and #size-cells == 2 always */
253 res = &dev->resource[PCI_BRIDGE_RESOURCES];
254 for (i = 0; i < PCI_NUM_RESOURCES - PCI_BRIDGE_RESOURCES; ++i) {
256 bus->resource[i] = res;
260 for (; len >= 32; len -= 32, ranges += 8) {
261 flags = pci_parse_of_flags(of_read_number(ranges, 1), 1);
262 size = of_read_number(&ranges[6], 2);
263 if (flags == 0 || size == 0)
265 if (flags & IORESOURCE_IO) {
266 res = bus->resource[0];
268 printk(KERN_ERR "PCI: ignoring extra I/O range"
269 " for bridge %pOF\n", node);
273 if (i >= PCI_NUM_RESOURCES - PCI_BRIDGE_RESOURCES) {
274 printk(KERN_ERR "PCI: too many memory ranges"
275 " for bridge %pOF\n", node);
278 res = bus->resource[i];
282 region.start = of_read_number(&ranges[1], 2);
283 region.end = region.start + size - 1;
284 pcibios_bus_to_resource(dev->bus, res, ®ion);
286 sprintf(bus->name, "PCI Bus %04x:%02x", pci_domain_nr(bus),
288 pr_debug(" bus name: %s\n", bus->name);
290 phb = pci_bus_to_host(bus);
292 mode = PCI_PROBE_NORMAL;
293 if (phb->controller_ops.probe_mode)
294 mode = phb->controller_ops.probe_mode(bus);
295 pr_debug(" probe mode: %d\n", mode);
297 if (mode == PCI_PROBE_DEVTREE)
298 of_scan_bus(node, bus);
299 else if (mode == PCI_PROBE_NORMAL)
300 pci_scan_child_bus(bus);
302 EXPORT_SYMBOL(of_scan_pci_bridge);
304 static struct pci_dev *of_scan_pci_dev(struct pci_bus *bus,
305 struct device_node *dn)
307 struct pci_dev *dev = NULL;
311 struct eeh_dev *edev = pdn_to_eeh_dev(PCI_DN(dn));
314 pr_debug(" * %pOF\n", dn);
315 if (!of_device_is_available(dn))
318 reg = of_get_property(dn, "reg", ®len);
319 if (reg == NULL || reglen < 20)
321 devfn = (of_read_number(reg, 1) >> 8) & 0xff;
323 /* Check if the PCI device is already there */
324 dev = pci_get_slot(bus, devfn);
330 /* Device removed permanently ? */
332 if (edev && (edev->mode & EEH_DEV_REMOVED))
336 /* create a new pci_dev for this device */
337 dev = of_create_pci_dev(dn, bus, devfn);
341 pr_debug(" dev header type: %x\n", dev->hdr_type);
346 * __of_scan_bus - given a PCI bus node, setup bus and scan for child devices
347 * @node: device tree node for the PCI bus
348 * @bus: pci_bus structure for the PCI bus
349 * @rescan_existing: Flag indicating bus has already been set up
351 static void __of_scan_bus(struct device_node *node, struct pci_bus *bus,
354 struct device_node *child;
357 pr_debug("of_scan_bus(%pOF) bus no %d...\n",
360 /* Scan direct children */
361 for_each_child_of_node(node, child) {
362 dev = of_scan_pci_dev(bus, child);
365 pr_debug(" dev header type: %x\n", dev->hdr_type);
368 /* Apply all fixups necessary. We don't fixup the bus "self"
369 * for an existing bridge that is being rescanned
371 if (!rescan_existing)
372 pcibios_setup_bus_self(bus);
373 pcibios_setup_bus_devices(bus);
375 /* Now scan child busses */
376 for_each_pci_bridge(dev, bus)
377 of_scan_pci_bridge(dev);
381 * of_scan_bus - given a PCI bus node, setup bus and scan for child devices
382 * @node: device tree node for the PCI bus
383 * @bus: pci_bus structure for the PCI bus
385 void of_scan_bus(struct device_node *node, struct pci_bus *bus)
387 __of_scan_bus(node, bus, 0);
389 EXPORT_SYMBOL_GPL(of_scan_bus);
392 * of_rescan_bus - given a PCI bus node, scan for child devices
393 * @node: device tree node for the PCI bus
394 * @bus: pci_bus structure for the PCI bus
396 * Same as of_scan_bus, but for a pci_bus structure that has already been
399 void of_rescan_bus(struct device_node *node, struct pci_bus *bus)
401 __of_scan_bus(node, bus, 1);
403 EXPORT_SYMBOL_GPL(of_rescan_bus);