xref: /openbmc/linux/arch/powerpc/kernel/pci_dn.c (revision 8e694cd2)
1 /*
2  * pci_dn.c
3  *
4  * Copyright (C) 2001 Todd Inglett, IBM Corporation
5  *
6  * PCI manipulation via device_nodes.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21  */
22 #include <linux/kernel.h>
23 #include <linux/pci.h>
24 #include <linux/string.h>
25 #include <linux/export.h>
26 #include <linux/init.h>
27 #include <linux/gfp.h>
28 
29 #include <asm/io.h>
30 #include <asm/prom.h>
31 #include <asm/pci-bridge.h>
32 #include <asm/ppc-pci.h>
33 #include <asm/firmware.h>
34 
35 /*
36  * The function is used to find the firmware data of one
37  * specific PCI device, which is attached to the indicated
38  * PCI bus. For VFs, their firmware data is linked to that
39  * one of PF's bridge. For other devices, their firmware
40  * data is linked to that of their bridge.
41  */
42 static struct pci_dn *pci_bus_to_pdn(struct pci_bus *bus)
43 {
44 	struct pci_bus *pbus;
45 	struct device_node *dn;
46 	struct pci_dn *pdn;
47 
48 	/*
49 	 * We probably have virtual bus which doesn't
50 	 * have associated bridge.
51 	 */
52 	pbus = bus;
53 	while (pbus) {
54 		if (pci_is_root_bus(pbus) || pbus->self)
55 			break;
56 
57 		pbus = pbus->parent;
58 	}
59 
60 	/*
61 	 * Except virtual bus, all PCI buses should
62 	 * have device nodes.
63 	 */
64 	dn = pci_bus_to_OF_node(pbus);
65 	pdn = dn ? PCI_DN(dn) : NULL;
66 
67 	return pdn;
68 }
69 
70 struct pci_dn *pci_get_pdn_by_devfn(struct pci_bus *bus,
71 				    int devfn)
72 {
73 	struct device_node *dn = NULL;
74 	struct pci_dn *parent, *pdn;
75 	struct pci_dev *pdev = NULL;
76 
77 	/* Fast path: fetch from PCI device */
78 	list_for_each_entry(pdev, &bus->devices, bus_list) {
79 		if (pdev->devfn == devfn) {
80 			if (pdev->dev.archdata.pci_data)
81 				return pdev->dev.archdata.pci_data;
82 
83 			dn = pci_device_to_OF_node(pdev);
84 			break;
85 		}
86 	}
87 
88 	/* Fast path: fetch from device node */
89 	pdn = dn ? PCI_DN(dn) : NULL;
90 	if (pdn)
91 		return pdn;
92 
93 	/* Slow path: fetch from firmware data hierarchy */
94 	parent = pci_bus_to_pdn(bus);
95 	if (!parent)
96 		return NULL;
97 
98 	list_for_each_entry(pdn, &parent->child_list, list) {
99 		if (pdn->busno == bus->number &&
100                     pdn->devfn == devfn)
101                         return pdn;
102         }
103 
104 	return NULL;
105 }
106 
107 struct pci_dn *pci_get_pdn(struct pci_dev *pdev)
108 {
109 	struct device_node *dn;
110 	struct pci_dn *parent, *pdn;
111 
112 	/* Search device directly */
113 	if (pdev->dev.archdata.pci_data)
114 		return pdev->dev.archdata.pci_data;
115 
116 	/* Check device node */
117 	dn = pci_device_to_OF_node(pdev);
118 	pdn = dn ? PCI_DN(dn) : NULL;
119 	if (pdn)
120 		return pdn;
121 
122 	/*
123 	 * VFs don't have device nodes. We hook their
124 	 * firmware data to PF's bridge.
125 	 */
126 	parent = pci_bus_to_pdn(pdev->bus);
127 	if (!parent)
128 		return NULL;
129 
130 	list_for_each_entry(pdn, &parent->child_list, list) {
131 		if (pdn->busno == pdev->bus->number &&
132 		    pdn->devfn == pdev->devfn)
133 			return pdn;
134 	}
135 
136 	return NULL;
137 }
138 
139 #ifdef CONFIG_PCI_IOV
140 static struct pci_dn *add_one_dev_pci_data(struct pci_dn *parent,
141 					   struct pci_dev *pdev,
142 					   int vf_index,
143 					   int busno, int devfn)
144 {
145 	struct pci_dn *pdn;
146 
147 	/* Except PHB, we always have the parent */
148 	if (!parent)
149 		return NULL;
150 
151 	pdn = kzalloc(sizeof(*pdn), GFP_KERNEL);
152 	if (!pdn) {
153 		dev_warn(&pdev->dev, "%s: Out of memory!\n", __func__);
154 		return NULL;
155 	}
156 
157 	pdn->phb = parent->phb;
158 	pdn->parent = parent;
159 	pdn->busno = busno;
160 	pdn->devfn = devfn;
161 #ifdef CONFIG_PPC_POWERNV
162 	pdn->vf_index = vf_index;
163 	pdn->pe_number = IODA_INVALID_PE;
164 #endif
165 	INIT_LIST_HEAD(&pdn->child_list);
166 	INIT_LIST_HEAD(&pdn->list);
167 	list_add_tail(&pdn->list, &parent->child_list);
168 
169 	/*
170 	 * If we already have PCI device instance, lets
171 	 * bind them.
172 	 */
173 	if (pdev)
174 		pdev->dev.archdata.pci_data = pdn;
175 
176 	return pdn;
177 }
178 #endif
179 
180 struct pci_dn *add_dev_pci_data(struct pci_dev *pdev)
181 {
182 #ifdef CONFIG_PCI_IOV
183 	struct pci_dn *parent, *pdn;
184 	struct eeh_dev *edev;
185 	int i;
186 
187 	/* Only support IOV for now */
188 	if (!pdev->is_physfn)
189 		return pci_get_pdn(pdev);
190 
191 	/* Check if VFs have been populated */
192 	pdn = pci_get_pdn(pdev);
193 	if (!pdn || (pdn->flags & PCI_DN_FLAG_IOV_VF))
194 		return NULL;
195 
196 	pdn->flags |= PCI_DN_FLAG_IOV_VF;
197 	parent = pci_bus_to_pdn(pdev->bus);
198 	if (!parent)
199 		return NULL;
200 
201 	for (i = 0; i < pci_sriov_get_totalvfs(pdev); i++) {
202 		pdn = add_one_dev_pci_data(parent, NULL, i,
203 					   pci_iov_virtfn_bus(pdev, i),
204 					   pci_iov_virtfn_devfn(pdev, i));
205 		if (!pdn) {
206 			dev_warn(&pdev->dev, "%s: Cannot create firmware data for VF#%d\n",
207 				 __func__, i);
208 			return NULL;
209 		}
210 
211 		/* Create the EEH device for the VF */
212 		eeh_dev_init(pdn, pci_bus_to_host(pdev->bus));
213 		edev = pdn_to_eeh_dev(pdn);
214 		BUG_ON(!edev);
215 		edev->physfn = pdev;
216 	}
217 #endif /* CONFIG_PCI_IOV */
218 
219 	return pci_get_pdn(pdev);
220 }
221 
222 void remove_dev_pci_data(struct pci_dev *pdev)
223 {
224 #ifdef CONFIG_PCI_IOV
225 	struct pci_dn *parent;
226 	struct pci_dn *pdn, *tmp;
227 	struct eeh_dev *edev;
228 	int i;
229 
230 	/*
231 	 * VF and VF PE are created/released dynamically, so we need to
232 	 * bind/unbind them.  Otherwise the VF and VF PE would be mismatched
233 	 * when re-enabling SR-IOV.
234 	 */
235 	if (pdev->is_virtfn) {
236 		pdn = pci_get_pdn(pdev);
237 #ifdef CONFIG_PPC_POWERNV
238 		pdn->pe_number = IODA_INVALID_PE;
239 #endif
240 		return;
241 	}
242 
243 	/* Only support IOV PF for now */
244 	if (!pdev->is_physfn)
245 		return;
246 
247 	/* Check if VFs have been populated */
248 	pdn = pci_get_pdn(pdev);
249 	if (!pdn || !(pdn->flags & PCI_DN_FLAG_IOV_VF))
250 		return;
251 
252 	pdn->flags &= ~PCI_DN_FLAG_IOV_VF;
253 	parent = pci_bus_to_pdn(pdev->bus);
254 	if (!parent)
255 		return;
256 
257 	/*
258 	 * We might introduce flag to pci_dn in future
259 	 * so that we can release VF's firmware data in
260 	 * a batch mode.
261 	 */
262 	for (i = 0; i < pci_sriov_get_totalvfs(pdev); i++) {
263 		list_for_each_entry_safe(pdn, tmp,
264 			&parent->child_list, list) {
265 			if (pdn->busno != pci_iov_virtfn_bus(pdev, i) ||
266 			    pdn->devfn != pci_iov_virtfn_devfn(pdev, i))
267 				continue;
268 
269 			/* Release EEH device for the VF */
270 			edev = pdn_to_eeh_dev(pdn);
271 			if (edev) {
272 				pdn->edev = NULL;
273 				kfree(edev);
274 			}
275 
276 			if (!list_empty(&pdn->list))
277 				list_del(&pdn->list);
278 
279 			kfree(pdn);
280 		}
281 	}
282 #endif /* CONFIG_PCI_IOV */
283 }
284 
285 struct pci_dn *pci_add_device_node_info(struct pci_controller *hose,
286 					struct device_node *dn)
287 {
288 	const __be32 *type = of_get_property(dn, "ibm,pci-config-space-type", NULL);
289 	const __be32 *regs;
290 	struct device_node *parent;
291 	struct pci_dn *pdn;
292 
293 	pdn = zalloc_maybe_bootmem(sizeof(*pdn), GFP_KERNEL);
294 	if (pdn == NULL)
295 		return NULL;
296 	dn->data = pdn;
297 	pdn->node = dn;
298 	pdn->phb = hose;
299 #ifdef CONFIG_PPC_POWERNV
300 	pdn->pe_number = IODA_INVALID_PE;
301 #endif
302 	regs = of_get_property(dn, "reg", NULL);
303 	if (regs) {
304 		u32 addr = of_read_number(regs, 1);
305 
306 		/* First register entry is addr (00BBSS00)  */
307 		pdn->busno = (addr >> 16) & 0xff;
308 		pdn->devfn = (addr >> 8) & 0xff;
309 	}
310 
311 	/* vendor/device IDs and class code */
312 	regs = of_get_property(dn, "vendor-id", NULL);
313 	pdn->vendor_id = regs ? of_read_number(regs, 1) : 0;
314 	regs = of_get_property(dn, "device-id", NULL);
315 	pdn->device_id = regs ? of_read_number(regs, 1) : 0;
316 	regs = of_get_property(dn, "class-code", NULL);
317 	pdn->class_code = regs ? of_read_number(regs, 1) : 0;
318 
319 	/* Extended config space */
320 	pdn->pci_ext_config_space = (type && of_read_number(type, 1) == 1);
321 
322 	/* Attach to parent node */
323 	INIT_LIST_HEAD(&pdn->child_list);
324 	INIT_LIST_HEAD(&pdn->list);
325 	parent = of_get_parent(dn);
326 	pdn->parent = parent ? PCI_DN(parent) : NULL;
327 	if (pdn->parent)
328 		list_add_tail(&pdn->list, &pdn->parent->child_list);
329 
330 	return pdn;
331 }
332 EXPORT_SYMBOL_GPL(pci_add_device_node_info);
333 
334 void pci_remove_device_node_info(struct device_node *dn)
335 {
336 	struct pci_dn *pdn = dn ? PCI_DN(dn) : NULL;
337 #ifdef CONFIG_EEH
338 	struct eeh_dev *edev = pdn_to_eeh_dev(pdn);
339 
340 	if (edev)
341 		edev->pdn = NULL;
342 #endif
343 
344 	if (!pdn)
345 		return;
346 
347 	WARN_ON(!list_empty(&pdn->child_list));
348 	list_del(&pdn->list);
349 	if (pdn->parent)
350 		of_node_put(pdn->parent->node);
351 
352 	dn->data = NULL;
353 	kfree(pdn);
354 }
355 EXPORT_SYMBOL_GPL(pci_remove_device_node_info);
356 
357 /*
358  * Traverse a device tree stopping each PCI device in the tree.
359  * This is done depth first.  As each node is processed, a "pre"
360  * function is called and the children are processed recursively.
361  *
362  * The "pre" func returns a value.  If non-zero is returned from
363  * the "pre" func, the traversal stops and this value is returned.
364  * This return value is useful when using traverse as a method of
365  * finding a device.
366  *
367  * NOTE: we do not run the func for devices that do not appear to
368  * be PCI except for the start node which we assume (this is good
369  * because the start node is often a phb which may be missing PCI
370  * properties).
371  * We use the class-code as an indicator. If we run into
372  * one of these nodes we also assume its siblings are non-pci for
373  * performance.
374  */
375 void *pci_traverse_device_nodes(struct device_node *start,
376 				void *(*fn)(struct device_node *, void *),
377 				void *data)
378 {
379 	struct device_node *dn, *nextdn;
380 	void *ret;
381 
382 	/* We started with a phb, iterate all childs */
383 	for (dn = start->child; dn; dn = nextdn) {
384 		const __be32 *classp;
385 		u32 class = 0;
386 
387 		nextdn = NULL;
388 		classp = of_get_property(dn, "class-code", NULL);
389 		if (classp)
390 			class = of_read_number(classp, 1);
391 
392 		if (fn) {
393 			ret = fn(dn, data);
394 			if (ret)
395 				return ret;
396 		}
397 
398 		/* If we are a PCI bridge, go down */
399 		if (dn->child && ((class >> 8) == PCI_CLASS_BRIDGE_PCI ||
400 				  (class >> 8) == PCI_CLASS_BRIDGE_CARDBUS))
401 			/* Depth first...do children */
402 			nextdn = dn->child;
403 		else if (dn->sibling)
404 			/* ok, try next sibling instead. */
405 			nextdn = dn->sibling;
406 		if (!nextdn) {
407 			/* Walk up to next valid sibling. */
408 			do {
409 				dn = dn->parent;
410 				if (dn == start)
411 					return NULL;
412 			} while (dn->sibling == NULL);
413 			nextdn = dn->sibling;
414 		}
415 	}
416 	return NULL;
417 }
418 EXPORT_SYMBOL_GPL(pci_traverse_device_nodes);
419 
420 static struct pci_dn *pci_dn_next_one(struct pci_dn *root,
421 				      struct pci_dn *pdn)
422 {
423 	struct list_head *next = pdn->child_list.next;
424 
425 	if (next != &pdn->child_list)
426 		return list_entry(next, struct pci_dn, list);
427 
428 	while (1) {
429 		if (pdn == root)
430 			return NULL;
431 
432 		next = pdn->list.next;
433 		if (next != &pdn->parent->child_list)
434 			break;
435 
436 		pdn = pdn->parent;
437 	}
438 
439 	return list_entry(next, struct pci_dn, list);
440 }
441 
442 void *traverse_pci_dn(struct pci_dn *root,
443 		      void *(*fn)(struct pci_dn *, void *),
444 		      void *data)
445 {
446 	struct pci_dn *pdn = root;
447 	void *ret;
448 
449 	/* Only scan the child nodes */
450 	for (pdn = pci_dn_next_one(root, pdn); pdn;
451 	     pdn = pci_dn_next_one(root, pdn)) {
452 		ret = fn(pdn, data);
453 		if (ret)
454 			return ret;
455 	}
456 
457 	return NULL;
458 }
459 
460 static void *add_pdn(struct device_node *dn, void *data)
461 {
462 	struct pci_controller *hose = data;
463 	struct pci_dn *pdn;
464 
465 	pdn = pci_add_device_node_info(hose, dn);
466 	if (!pdn)
467 		return ERR_PTR(-ENOMEM);
468 
469 	return NULL;
470 }
471 
472 /**
473  * pci_devs_phb_init_dynamic - setup pci devices under this PHB
474  * phb: pci-to-host bridge (top-level bridge connecting to cpu)
475  *
476  * This routine is called both during boot, (before the memory
477  * subsystem is set up, before kmalloc is valid) and during the
478  * dynamic lpar operation of adding a PHB to a running system.
479  */
480 void pci_devs_phb_init_dynamic(struct pci_controller *phb)
481 {
482 	struct device_node *dn = phb->dn;
483 	struct pci_dn *pdn;
484 
485 	/* PHB nodes themselves must not match */
486 	pdn = pci_add_device_node_info(phb, dn);
487 	if (pdn) {
488 		pdn->devfn = pdn->busno = -1;
489 		pdn->vendor_id = pdn->device_id = pdn->class_code = 0;
490 		pdn->phb = phb;
491 		phb->pci_data = pdn;
492 	}
493 
494 	/* Update dn->phb ptrs for new phb and children devices */
495 	pci_traverse_device_nodes(dn, add_pdn, phb);
496 }
497 
498 /**
499  * pci_devs_phb_init - Initialize phbs and pci devs under them.
500  *
501  * This routine walks over all phb's (pci-host bridges) on the
502  * system, and sets up assorted pci-related structures
503  * (including pci info in the device node structs) for each
504  * pci device found underneath.  This routine runs once,
505  * early in the boot sequence.
506  */
507 void __init pci_devs_phb_init(void)
508 {
509 	struct pci_controller *phb, *tmp;
510 
511 	/* This must be done first so the device nodes have valid pci info! */
512 	list_for_each_entry_safe(phb, tmp, &hose_list, list_node)
513 		pci_devs_phb_init_dynamic(phb);
514 }
515 
516 static void pci_dev_pdn_setup(struct pci_dev *pdev)
517 {
518 	struct pci_dn *pdn;
519 
520 	if (pdev->dev.archdata.pci_data)
521 		return;
522 
523 	/* Setup the fast path */
524 	pdn = pci_get_pdn(pdev);
525 	pdev->dev.archdata.pci_data = pdn;
526 }
527 DECLARE_PCI_FIXUP_EARLY(PCI_ANY_ID, PCI_ANY_ID, pci_dev_pdn_setup);
528