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