GNU Linux-libre 4.14.266-gnu1
[releases.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 #ifdef CONFIG_PPC_POWERNV
160         pdn->vf_index = vf_index;
161         pdn->pe_number = IODA_INVALID_PE;
162 #endif
163         INIT_LIST_HEAD(&pdn->child_list);
164         INIT_LIST_HEAD(&pdn->list);
165         list_add_tail(&pdn->list, &parent->child_list);
166
167         return pdn;
168 }
169 #endif
170
171 struct pci_dn *add_dev_pci_data(struct pci_dev *pdev)
172 {
173 #ifdef CONFIG_PCI_IOV
174         struct pci_dn *parent, *pdn;
175         int i;
176
177         /* Only support IOV for now */
178         if (!pdev->is_physfn)
179                 return pci_get_pdn(pdev);
180
181         /* Check if VFs have been populated */
182         pdn = pci_get_pdn(pdev);
183         if (!pdn || (pdn->flags & PCI_DN_FLAG_IOV_VF))
184                 return NULL;
185
186         pdn->flags |= PCI_DN_FLAG_IOV_VF;
187         parent = pci_bus_to_pdn(pdev->bus);
188         if (!parent)
189                 return NULL;
190
191         for (i = 0; i < pci_sriov_get_totalvfs(pdev); i++) {
192                 struct eeh_dev *edev __maybe_unused;
193
194                 pdn = add_one_dev_pci_data(parent, i,
195                                            pci_iov_virtfn_bus(pdev, i),
196                                            pci_iov_virtfn_devfn(pdev, i));
197                 if (!pdn) {
198                         dev_warn(&pdev->dev, "%s: Cannot create firmware data for VF#%d\n",
199                                  __func__, i);
200                         return NULL;
201                 }
202
203 #ifdef CONFIG_EEH
204                 /* Create the EEH device for the VF */
205                 edev = eeh_dev_init(pdn);
206                 BUG_ON(!edev);
207                 edev->physfn = pdev;
208 #endif /* CONFIG_EEH */
209         }
210 #endif /* CONFIG_PCI_IOV */
211
212         return pci_get_pdn(pdev);
213 }
214
215 void remove_dev_pci_data(struct pci_dev *pdev)
216 {
217 #ifdef CONFIG_PCI_IOV
218         struct pci_dn *parent;
219         struct pci_dn *pdn, *tmp;
220         int i;
221
222         /*
223          * VF and VF PE are created/released dynamically, so we need to
224          * bind/unbind them.  Otherwise the VF and VF PE would be mismatched
225          * when re-enabling SR-IOV.
226          */
227         if (pdev->is_virtfn) {
228                 pdn = pci_get_pdn(pdev);
229 #ifdef CONFIG_PPC_POWERNV
230                 pdn->pe_number = IODA_INVALID_PE;
231 #endif
232                 return;
233         }
234
235         /* Only support IOV PF for now */
236         if (!pdev->is_physfn)
237                 return;
238
239         /* Check if VFs have been populated */
240         pdn = pci_get_pdn(pdev);
241         if (!pdn || !(pdn->flags & PCI_DN_FLAG_IOV_VF))
242                 return;
243
244         pdn->flags &= ~PCI_DN_FLAG_IOV_VF;
245         parent = pci_bus_to_pdn(pdev->bus);
246         if (!parent)
247                 return;
248
249         /*
250          * We might introduce flag to pci_dn in future
251          * so that we can release VF's firmware data in
252          * a batch mode.
253          */
254         for (i = 0; i < pci_sriov_get_totalvfs(pdev); i++) {
255                 struct eeh_dev *edev __maybe_unused;
256
257                 list_for_each_entry_safe(pdn, tmp,
258                         &parent->child_list, list) {
259                         if (pdn->busno != pci_iov_virtfn_bus(pdev, i) ||
260                             pdn->devfn != pci_iov_virtfn_devfn(pdev, i))
261                                 continue;
262
263 #ifdef CONFIG_EEH
264                         /*
265                          * Release EEH state for this VF. The PCI core
266                          * has already torn down the pci_dev for this VF, but
267                          * we're responsible to removing the eeh_dev since it
268                          * has the same lifetime as the pci_dn that spawned it.
269                          */
270                         edev = pdn_to_eeh_dev(pdn);
271                         if (edev) {
272                                 /*
273                                  * We allocate pci_dn's for the totalvfs count,
274                                  * but only only the vfs that were activated
275                                  * have a configured PE.
276                                  */
277                                 if (edev->pe)
278                                         eeh_rmv_from_parent_pe(edev);
279
280                                 pdn->edev = NULL;
281                                 kfree(edev);
282                         }
283 #endif /* CONFIG_EEH */
284
285                         if (!list_empty(&pdn->list))
286                                 list_del(&pdn->list);
287
288                         kfree(pdn);
289                 }
290         }
291 #endif /* CONFIG_PCI_IOV */
292 }
293
294 struct pci_dn *pci_add_device_node_info(struct pci_controller *hose,
295                                         struct device_node *dn)
296 {
297         const __be32 *type = of_get_property(dn, "ibm,pci-config-space-type", NULL);
298         const __be32 *regs;
299         struct device_node *parent;
300         struct pci_dn *pdn;
301 #ifdef CONFIG_EEH
302         struct eeh_dev *edev;
303 #endif
304
305         pdn = kzalloc(sizeof(*pdn), GFP_KERNEL);
306         if (pdn == NULL)
307                 return NULL;
308         dn->data = pdn;
309         pdn->phb = hose;
310 #ifdef CONFIG_PPC_POWERNV
311         pdn->pe_number = IODA_INVALID_PE;
312 #endif
313         regs = of_get_property(dn, "reg", NULL);
314         if (regs) {
315                 u32 addr = of_read_number(regs, 1);
316
317                 /* First register entry is addr (00BBSS00)  */
318                 pdn->busno = (addr >> 16) & 0xff;
319                 pdn->devfn = (addr >> 8) & 0xff;
320         }
321
322         /* vendor/device IDs and class code */
323         regs = of_get_property(dn, "vendor-id", NULL);
324         pdn->vendor_id = regs ? of_read_number(regs, 1) : 0;
325         regs = of_get_property(dn, "device-id", NULL);
326         pdn->device_id = regs ? of_read_number(regs, 1) : 0;
327         regs = of_get_property(dn, "class-code", NULL);
328         pdn->class_code = regs ? of_read_number(regs, 1) : 0;
329
330         /* Extended config space */
331         pdn->pci_ext_config_space = (type && of_read_number(type, 1) == 1);
332
333         /* Create EEH device */
334 #ifdef CONFIG_EEH
335         edev = eeh_dev_init(pdn);
336         if (!edev) {
337                 kfree(pdn);
338                 return NULL;
339         }
340 #endif
341
342         /* Attach to parent node */
343         INIT_LIST_HEAD(&pdn->child_list);
344         INIT_LIST_HEAD(&pdn->list);
345         parent = of_get_parent(dn);
346         pdn->parent = parent ? PCI_DN(parent) : NULL;
347         if (pdn->parent)
348                 list_add_tail(&pdn->list, &pdn->parent->child_list);
349
350         return pdn;
351 }
352 EXPORT_SYMBOL_GPL(pci_add_device_node_info);
353
354 void pci_remove_device_node_info(struct device_node *dn)
355 {
356         struct pci_dn *pdn = dn ? PCI_DN(dn) : NULL;
357         struct device_node *parent;
358 #ifdef CONFIG_EEH
359         struct eeh_dev *edev = pdn_to_eeh_dev(pdn);
360
361         if (edev)
362                 edev->pdn = NULL;
363 #endif
364
365         if (!pdn)
366                 return;
367
368         WARN_ON(!list_empty(&pdn->child_list));
369         list_del(&pdn->list);
370
371         parent = of_get_parent(dn);
372         if (parent)
373                 of_node_put(parent);
374
375         dn->data = NULL;
376         kfree(pdn);
377 }
378 EXPORT_SYMBOL_GPL(pci_remove_device_node_info);
379
380 /*
381  * Traverse a device tree stopping each PCI device in the tree.
382  * This is done depth first.  As each node is processed, a "pre"
383  * function is called and the children are processed recursively.
384  *
385  * The "pre" func returns a value.  If non-zero is returned from
386  * the "pre" func, the traversal stops and this value is returned.
387  * This return value is useful when using traverse as a method of
388  * finding a device.
389  *
390  * NOTE: we do not run the func for devices that do not appear to
391  * be PCI except for the start node which we assume (this is good
392  * because the start node is often a phb which may be missing PCI
393  * properties).
394  * We use the class-code as an indicator. If we run into
395  * one of these nodes we also assume its siblings are non-pci for
396  * performance.
397  */
398 void *pci_traverse_device_nodes(struct device_node *start,
399                                 void *(*fn)(struct device_node *, void *),
400                                 void *data)
401 {
402         struct device_node *dn, *nextdn;
403         void *ret;
404
405         /* We started with a phb, iterate all childs */
406         for (dn = start->child; dn; dn = nextdn) {
407                 const __be32 *classp;
408                 u32 class = 0;
409
410                 nextdn = NULL;
411                 classp = of_get_property(dn, "class-code", NULL);
412                 if (classp)
413                         class = of_read_number(classp, 1);
414
415                 if (fn) {
416                         ret = fn(dn, data);
417                         if (ret)
418                                 return ret;
419                 }
420
421                 /* If we are a PCI bridge, go down */
422                 if (dn->child && ((class >> 8) == PCI_CLASS_BRIDGE_PCI ||
423                                   (class >> 8) == PCI_CLASS_BRIDGE_CARDBUS))
424                         /* Depth first...do children */
425                         nextdn = dn->child;
426                 else if (dn->sibling)
427                         /* ok, try next sibling instead. */
428                         nextdn = dn->sibling;
429                 if (!nextdn) {
430                         /* Walk up to next valid sibling. */
431                         do {
432                                 dn = dn->parent;
433                                 if (dn == start)
434                                         return NULL;
435                         } while (dn->sibling == NULL);
436                         nextdn = dn->sibling;
437                 }
438         }
439         return NULL;
440 }
441 EXPORT_SYMBOL_GPL(pci_traverse_device_nodes);
442
443 static struct pci_dn *pci_dn_next_one(struct pci_dn *root,
444                                       struct pci_dn *pdn)
445 {
446         struct list_head *next = pdn->child_list.next;
447
448         if (next != &pdn->child_list)
449                 return list_entry(next, struct pci_dn, list);
450
451         while (1) {
452                 if (pdn == root)
453                         return NULL;
454
455                 next = pdn->list.next;
456                 if (next != &pdn->parent->child_list)
457                         break;
458
459                 pdn = pdn->parent;
460         }
461
462         return list_entry(next, struct pci_dn, list);
463 }
464
465 void *traverse_pci_dn(struct pci_dn *root,
466                       void *(*fn)(struct pci_dn *, void *),
467                       void *data)
468 {
469         struct pci_dn *pdn = root;
470         void *ret;
471
472         /* Only scan the child nodes */
473         for (pdn = pci_dn_next_one(root, pdn); pdn;
474              pdn = pci_dn_next_one(root, pdn)) {
475                 ret = fn(pdn, data);
476                 if (ret)
477                         return ret;
478         }
479
480         return NULL;
481 }
482
483 static void *add_pdn(struct device_node *dn, void *data)
484 {
485         struct pci_controller *hose = data;
486         struct pci_dn *pdn;
487
488         pdn = pci_add_device_node_info(hose, dn);
489         if (!pdn)
490                 return ERR_PTR(-ENOMEM);
491
492         return NULL;
493 }
494
495 /** 
496  * pci_devs_phb_init_dynamic - setup pci devices under this PHB
497  * phb: pci-to-host bridge (top-level bridge connecting to cpu)
498  *
499  * This routine is called both during boot, (before the memory
500  * subsystem is set up, before kmalloc is valid) and during the 
501  * dynamic lpar operation of adding a PHB to a running system.
502  */
503 void pci_devs_phb_init_dynamic(struct pci_controller *phb)
504 {
505         struct device_node *dn = phb->dn;
506         struct pci_dn *pdn;
507
508         /* PHB nodes themselves must not match */
509         pdn = pci_add_device_node_info(phb, dn);
510         if (pdn) {
511                 pdn->devfn = pdn->busno = -1;
512                 pdn->vendor_id = pdn->device_id = pdn->class_code = 0;
513                 pdn->phb = phb;
514                 phb->pci_data = pdn;
515         }
516
517         /* Update dn->phb ptrs for new phb and children devices */
518         pci_traverse_device_nodes(dn, add_pdn, phb);
519 }
520
521 /** 
522  * pci_devs_phb_init - Initialize phbs and pci devs under them.
523  * 
524  * This routine walks over all phb's (pci-host bridges) on the
525  * system, and sets up assorted pci-related structures 
526  * (including pci info in the device node structs) for each
527  * pci device found underneath.  This routine runs once,
528  * early in the boot sequence.
529  */
530 static int __init pci_devs_phb_init(void)
531 {
532         struct pci_controller *phb, *tmp;
533
534         /* This must be done first so the device nodes have valid pci info! */
535         list_for_each_entry_safe(phb, tmp, &hose_list, list_node)
536                 pci_devs_phb_init_dynamic(phb);
537
538         return 0;
539 }
540
541 core_initcall(pci_devs_phb_init);
542
543 static void pci_dev_pdn_setup(struct pci_dev *pdev)
544 {
545         struct pci_dn *pdn;
546
547         if (pdev->dev.archdata.pci_data)
548                 return;
549
550         /* Setup the fast path */
551         pdn = pci_get_pdn(pdev);
552         pdev->dev.archdata.pci_data = pdn;
553 }
554 DECLARE_PCI_FIXUP_EARLY(PCI_ANY_ID, PCI_ANY_ID, pci_dev_pdn_setup);