powerpc/eeh: Lock module while handling EEH event
[linux-2.6.git] / arch / powerpc / platforms / pseries / eeh_driver.c
1 /*
2  * PCI Error Recovery Driver for RPA-compliant PPC64 platform.
3  * Copyright IBM Corp. 2004 2005
4  * Copyright Linas Vepstas <linas@linas.org> 2004, 2005
5  *
6  * All rights reserved.
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 (at
11  * your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
16  * NON INFRINGEMENT.  See the GNU General Public License for more
17  * details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  *
23  * Send comments and feedback to Linas Vepstas <linas@austin.ibm.com>
24  */
25 #include <linux/delay.h>
26 #include <linux/interrupt.h>
27 #include <linux/irq.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30 #include <asm/eeh.h>
31 #include <asm/eeh_event.h>
32 #include <asm/ppc-pci.h>
33 #include <asm/pci-bridge.h>
34 #include <asm/prom.h>
35 #include <asm/rtas.h>
36
37 /**
38  * eeh_pcid_name - Retrieve name of PCI device driver
39  * @pdev: PCI device
40  *
41  * This routine is used to retrieve the name of PCI device driver
42  * if that's valid.
43  */
44 static inline const char *eeh_pcid_name(struct pci_dev *pdev)
45 {
46         if (pdev && pdev->dev.driver)
47                 return pdev->dev.driver->name;
48         return "";
49 }
50
51 /**
52  * eeh_pcid_get - Get the PCI device driver
53  * @pdev: PCI device
54  *
55  * The function is used to retrieve the PCI device driver for
56  * the indicated PCI device. Besides, we will increase the reference
57  * of the PCI device driver to prevent that being unloaded on
58  * the fly. Otherwise, kernel crash would be seen.
59  */
60 static inline struct pci_driver *eeh_pcid_get(struct pci_dev *pdev)
61 {
62         if (!pdev || !pdev->driver)
63                 return NULL;
64
65         if (!try_module_get(pdev->driver->driver.owner))
66                 return NULL;
67
68         return pdev->driver;
69 }
70
71 /**
72  * eeh_pcid_put - Dereference on the PCI device driver
73  * @pdev: PCI device
74  *
75  * The function is called to do dereference on the PCI device
76  * driver of the indicated PCI device.
77  */
78 static inline void eeh_pcid_put(struct pci_dev *pdev)
79 {
80         if (!pdev || !pdev->driver)
81                 return;
82
83         module_put(pdev->driver->driver.owner);
84 }
85
86 #if 0
87 static void print_device_node_tree(struct pci_dn *pdn, int dent)
88 {
89         int i;
90         struct device_node *pc;
91
92         if (!pdn)
93                 return;
94         for (i = 0; i < dent; i++)
95                 printk(" ");
96         printk("dn=%s mode=%x \tcfg_addr=%x pe_addr=%x \tfull=%s\n",
97                 pdn->node->name, pdn->eeh_mode, pdn->eeh_config_addr,
98                 pdn->eeh_pe_config_addr, pdn->node->full_name);
99         dent += 3;
100         pc = pdn->node->child;
101         while (pc) {
102                 print_device_node_tree(PCI_DN(pc), dent);
103                 pc = pc->sibling;
104         }
105 }
106 #endif
107
108 /**
109  * eeh_disable_irq - Disable interrupt for the recovering device
110  * @dev: PCI device
111  *
112  * This routine must be called when reporting temporary or permanent
113  * error to the particular PCI device to disable interrupt of that
114  * device. If the device has enabled MSI or MSI-X interrupt, we needn't
115  * do real work because EEH should freeze DMA transfers for those PCI
116  * devices encountering EEH errors, which includes MSI or MSI-X.
117  */
118 static void eeh_disable_irq(struct pci_dev *dev)
119 {
120         struct eeh_dev *edev = pci_dev_to_eeh_dev(dev);
121
122         /* Don't disable MSI and MSI-X interrupts. They are
123          * effectively disabled by the DMA Stopped state
124          * when an EEH error occurs.
125          */
126         if (dev->msi_enabled || dev->msix_enabled)
127                 return;
128
129         if (!irq_has_action(dev->irq))
130                 return;
131
132         edev->mode |= EEH_MODE_IRQ_DISABLED;
133         disable_irq_nosync(dev->irq);
134 }
135
136 /**
137  * eeh_enable_irq - Enable interrupt for the recovering device
138  * @dev: PCI device
139  *
140  * This routine must be called to enable interrupt while failed
141  * device could be resumed.
142  */
143 static void eeh_enable_irq(struct pci_dev *dev)
144 {
145         struct eeh_dev *edev = pci_dev_to_eeh_dev(dev);
146
147         if ((edev->mode) & EEH_MODE_IRQ_DISABLED) {
148                 edev->mode &= ~EEH_MODE_IRQ_DISABLED;
149                 enable_irq(dev->irq);
150         }
151 }
152
153 /**
154  * eeh_report_error - Report pci error to each device driver
155  * @dev: PCI device
156  * @userdata: return value
157  * 
158  * Report an EEH error to each device driver, collect up and 
159  * merge the device driver responses. Cumulative response 
160  * passed back in "userdata".
161  */
162 static int eeh_report_error(struct pci_dev *dev, void *userdata)
163 {
164         enum pci_ers_result rc, *res = userdata;
165         struct pci_driver *driver;
166
167         dev->error_state = pci_channel_io_frozen;
168
169         driver = eeh_pcid_get(dev);
170         if (!driver) return 0;
171
172         eeh_disable_irq(dev);
173
174         if (!driver->err_handler ||
175             !driver->err_handler->error_detected) {
176                 eeh_pcid_put(dev);
177                 return 0;
178         }
179
180         rc = driver->err_handler->error_detected(dev, pci_channel_io_frozen);
181
182         /* A driver that needs a reset trumps all others */
183         if (rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
184         if (*res == PCI_ERS_RESULT_NONE) *res = rc;
185
186         eeh_pcid_put(dev);
187         return 0;
188 }
189
190 /**
191  * eeh_report_mmio_enabled - Tell drivers that MMIO has been enabled
192  * @dev: PCI device
193  * @userdata: return value
194  *
195  * Tells each device driver that IO ports, MMIO and config space I/O
196  * are now enabled. Collects up and merges the device driver responses.
197  * Cumulative response passed back in "userdata".
198  */
199 static int eeh_report_mmio_enabled(struct pci_dev *dev, void *userdata)
200 {
201         enum pci_ers_result rc, *res = userdata;
202         struct pci_driver *driver;
203
204         driver = eeh_pcid_get(dev);
205         if (!driver) return 0;
206
207         if (!driver->err_handler ||
208             !driver->err_handler->mmio_enabled) {
209                 eeh_pcid_put(dev);
210                 return 0;
211         }
212
213         rc = driver->err_handler->mmio_enabled(dev);
214
215         /* A driver that needs a reset trumps all others */
216         if (rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
217         if (*res == PCI_ERS_RESULT_NONE) *res = rc;
218
219         eeh_pcid_put(dev);
220         return 0;
221 }
222
223 /**
224  * eeh_report_reset - Tell device that slot has been reset
225  * @dev: PCI device
226  * @userdata: return value
227  *
228  * This routine must be called while EEH tries to reset particular
229  * PCI device so that the associated PCI device driver could take
230  * some actions, usually to save data the driver needs so that the
231  * driver can work again while the device is recovered.
232  */
233 static int eeh_report_reset(struct pci_dev *dev, void *userdata)
234 {
235         enum pci_ers_result rc, *res = userdata;
236         struct pci_driver *driver;
237
238         dev->error_state = pci_channel_io_normal;
239
240         driver = eeh_pcid_get(dev);
241         if (!driver) return 0;
242
243         eeh_enable_irq(dev);
244
245         if (!driver->err_handler ||
246             !driver->err_handler->slot_reset) {
247                 eeh_pcid_put(dev);
248                 return 0;
249         }
250
251         rc = driver->err_handler->slot_reset(dev);
252         if ((*res == PCI_ERS_RESULT_NONE) ||
253             (*res == PCI_ERS_RESULT_RECOVERED)) *res = rc;
254         if (*res == PCI_ERS_RESULT_DISCONNECT &&
255              rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
256
257         eeh_pcid_put(dev);
258         return 0;
259 }
260
261 /**
262  * eeh_report_resume - Tell device to resume normal operations
263  * @dev: PCI device
264  * @userdata: return value
265  *
266  * This routine must be called to notify the device driver that it
267  * could resume so that the device driver can do some initialization
268  * to make the recovered device work again.
269  */
270 static int eeh_report_resume(struct pci_dev *dev, void *userdata)
271 {
272         struct pci_driver *driver;
273
274         dev->error_state = pci_channel_io_normal;
275
276         driver = eeh_pcid_get(dev);
277         if (!driver) return 0;
278
279         eeh_enable_irq(dev);
280
281         if (!driver->err_handler ||
282             !driver->err_handler->resume) {
283                 eeh_pcid_put(dev);
284                 return 0;
285         }
286
287         driver->err_handler->resume(dev);
288
289         eeh_pcid_put(dev);
290         return 0;
291 }
292
293 /**
294  * eeh_report_failure - Tell device driver that device is dead.
295  * @dev: PCI device
296  * @userdata: return value
297  *
298  * This informs the device driver that the device is permanently
299  * dead, and that no further recovery attempts will be made on it.
300  */
301 static int eeh_report_failure(struct pci_dev *dev, void *userdata)
302 {
303         struct pci_driver *driver;
304
305         dev->error_state = pci_channel_io_perm_failure;
306
307         driver = eeh_pcid_get(dev);
308         if (!driver) return 0;
309
310         eeh_disable_irq(dev);
311
312         if (!driver->err_handler ||
313             !driver->err_handler->error_detected) {
314                 eeh_pcid_put(dev);
315                 return 0;
316         }
317
318         driver->err_handler->error_detected(dev, pci_channel_io_perm_failure);
319
320         eeh_pcid_put(dev);
321         return 0;
322 }
323
324 /**
325  * eeh_reset_device - Perform actual reset of a pci slot
326  * @edev: PE associated EEH device
327  * @bus: PCI bus corresponding to the isolcated slot
328  *
329  * This routine must be called to do reset on the indicated PE.
330  * During the reset, udev might be invoked because those affected
331  * PCI devices will be removed and then added.
332  */
333 static int eeh_reset_device(struct eeh_dev *edev, struct pci_bus *bus)
334 {
335         struct device_node *dn;
336         int cnt, rc;
337
338         /* pcibios will clear the counter; save the value */
339         cnt = edev->freeze_count;
340
341         if (bus)
342                 pcibios_remove_pci_devices(bus);
343
344         /* Reset the pci controller. (Asserts RST#; resets config space).
345          * Reconfigure bridges and devices. Don't try to bring the system
346          * up if the reset failed for some reason.
347          */
348         rc = eeh_reset_pe(edev);
349         if (rc)
350                 return rc;
351
352         /* Walk over all functions on this device. */
353         dn = eeh_dev_to_of_node(edev);
354         if (!pcibios_find_pci_bus(dn) && of_node_to_eeh_dev(dn->parent))
355                 dn = dn->parent->child;
356
357         while (dn) {
358                 struct eeh_dev *pedev = of_node_to_eeh_dev(dn);
359
360                 /* On Power4, always true because eeh_pe_config_addr=0 */
361                 if (edev->pe_config_addr == pedev->pe_config_addr) {
362                         eeh_ops->configure_bridge(dn);
363                         eeh_restore_bars(pedev);
364                 }
365                 dn = dn->sibling;
366         }
367
368         /* Give the system 5 seconds to finish running the user-space
369          * hotplug shutdown scripts, e.g. ifdown for ethernet.  Yes, 
370          * this is a hack, but if we don't do this, and try to bring 
371          * the device up before the scripts have taken it down, 
372          * potentially weird things happen.
373          */
374         if (bus) {
375                 ssleep(5);
376                 pcibios_add_pci_devices(bus);
377         }
378         edev->freeze_count = cnt;
379
380         return 0;
381 }
382
383 /* The longest amount of time to wait for a pci device
384  * to come back on line, in seconds.
385  */
386 #define MAX_WAIT_FOR_RECOVERY 150
387
388 /**
389  * eeh_handle_event - Reset a PCI device after hard lockup.
390  * @event: EEH event
391  *
392  * While PHB detects address or data parity errors on particular PCI
393  * slot, the associated PE will be frozen. Besides, DMA's occurring
394  * to wild addresses (which usually happen due to bugs in device
395  * drivers or in PCI adapter firmware) can cause EEH error. #SERR,
396  * #PERR or other misc PCI-related errors also can trigger EEH errors.
397  *
398  * Recovery process consists of unplugging the device driver (which
399  * generated hotplug events to userspace), then issuing a PCI #RST to
400  * the device, then reconfiguring the PCI config space for all bridges
401  * & devices under this slot, and then finally restarting the device
402  * drivers (which cause a second set of hotplug events to go out to
403  * userspace).
404  */
405 struct eeh_dev *handle_eeh_events(struct eeh_event *event)
406 {
407         struct device_node *frozen_dn;
408         struct eeh_dev *frozen_edev;
409         struct pci_bus *frozen_bus;
410         int rc = 0;
411         enum pci_ers_result result = PCI_ERS_RESULT_NONE;
412         const char *location, *pci_str, *drv_str, *bus_pci_str, *bus_drv_str;
413
414         frozen_dn = eeh_find_device_pe(eeh_dev_to_of_node(event->edev));
415         if (!frozen_dn) {
416                 location = of_get_property(eeh_dev_to_of_node(event->edev), "ibm,loc-code", NULL);
417                 location = location ? location : "unknown";
418                 printk(KERN_ERR "EEH: Error: Cannot find partition endpoint "
419                                 "for location=%s pci addr=%s\n",
420                         location, eeh_pci_name(eeh_dev_to_pci_dev(event->edev)));
421                 return NULL;
422         }
423
424         frozen_bus = pcibios_find_pci_bus(frozen_dn);
425         location = of_get_property(frozen_dn, "ibm,loc-code", NULL);
426         location = location ? location : "unknown";
427
428         /* There are two different styles for coming up with the PE.
429          * In the old style, it was the highest EEH-capable device
430          * which was always an EADS pci bridge.  In the new style,
431          * there might not be any EADS bridges, and even when there are,
432          * the firmware marks them as "EEH incapable". So another
433          * two-step is needed to find the pci bus..
434          */
435         if (!frozen_bus)
436                 frozen_bus = pcibios_find_pci_bus(frozen_dn->parent);
437
438         if (!frozen_bus) {
439                 printk(KERN_ERR "EEH: Cannot find PCI bus "
440                         "for location=%s dn=%s\n",
441                         location, frozen_dn->full_name);
442                 return NULL;
443         }
444
445         frozen_edev = of_node_to_eeh_dev(frozen_dn);
446         frozen_edev->freeze_count++;
447         pci_str = eeh_pci_name(eeh_dev_to_pci_dev(event->edev));
448         drv_str = eeh_pcid_name(eeh_dev_to_pci_dev(event->edev));
449
450         if (frozen_edev->freeze_count > EEH_MAX_ALLOWED_FREEZES)
451                 goto excess_failures;
452
453         printk(KERN_WARNING
454            "EEH: This PCI device has failed %d times in the last hour:\n",
455                 frozen_edev->freeze_count);
456
457         if (frozen_edev->pdev) {
458                 bus_pci_str = pci_name(frozen_edev->pdev);
459                 bus_drv_str = eeh_pcid_name(frozen_edev->pdev);
460                 printk(KERN_WARNING
461                         "EEH: Bus location=%s driver=%s pci addr=%s\n",
462                         location, bus_drv_str, bus_pci_str);
463         }
464
465         printk(KERN_WARNING
466                 "EEH: Device location=%s driver=%s pci addr=%s\n",
467                 location, drv_str, pci_str);
468
469         /* Walk the various device drivers attached to this slot through
470          * a reset sequence, giving each an opportunity to do what it needs
471          * to accomplish the reset.  Each child gets a report of the
472          * status ... if any child can't handle the reset, then the entire
473          * slot is dlpar removed and added.
474          */
475         pci_walk_bus(frozen_bus, eeh_report_error, &result);
476
477         /* Get the current PCI slot state. This can take a long time,
478          * sometimes over 3 seconds for certain systems.
479          */
480         rc = eeh_ops->wait_state(eeh_dev_to_of_node(frozen_edev), MAX_WAIT_FOR_RECOVERY*1000);
481         if (rc < 0 || rc == EEH_STATE_NOT_SUPPORT) {
482                 printk(KERN_WARNING "EEH: Permanent failure\n");
483                 goto hard_fail;
484         }
485
486         /* Since rtas may enable MMIO when posting the error log,
487          * don't post the error log until after all dev drivers
488          * have been informed.
489          */
490         eeh_slot_error_detail(frozen_edev, EEH_LOG_TEMP);
491
492         /* If all device drivers were EEH-unaware, then shut
493          * down all of the device drivers, and hope they
494          * go down willingly, without panicing the system.
495          */
496         if (result == PCI_ERS_RESULT_NONE) {
497                 rc = eeh_reset_device(frozen_edev, frozen_bus);
498                 if (rc) {
499                         printk(KERN_WARNING "EEH: Unable to reset, rc=%d\n", rc);
500                         goto hard_fail;
501                 }
502         }
503
504         /* If all devices reported they can proceed, then re-enable MMIO */
505         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
506                 rc = eeh_pci_enable(frozen_edev, EEH_OPT_THAW_MMIO);
507
508                 if (rc < 0)
509                         goto hard_fail;
510                 if (rc) {
511                         result = PCI_ERS_RESULT_NEED_RESET;
512                 } else {
513                         result = PCI_ERS_RESULT_NONE;
514                         pci_walk_bus(frozen_bus, eeh_report_mmio_enabled, &result);
515                 }
516         }
517
518         /* If all devices reported they can proceed, then re-enable DMA */
519         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
520                 rc = eeh_pci_enable(frozen_edev, EEH_OPT_THAW_DMA);
521
522                 if (rc < 0)
523                         goto hard_fail;
524                 if (rc)
525                         result = PCI_ERS_RESULT_NEED_RESET;
526                 else
527                         result = PCI_ERS_RESULT_RECOVERED;
528         }
529
530         /* If any device has a hard failure, then shut off everything. */
531         if (result == PCI_ERS_RESULT_DISCONNECT) {
532                 printk(KERN_WARNING "EEH: Device driver gave up\n");
533                 goto hard_fail;
534         }
535
536         /* If any device called out for a reset, then reset the slot */
537         if (result == PCI_ERS_RESULT_NEED_RESET) {
538                 rc = eeh_reset_device(frozen_edev, NULL);
539                 if (rc) {
540                         printk(KERN_WARNING "EEH: Cannot reset, rc=%d\n", rc);
541                         goto hard_fail;
542                 }
543                 result = PCI_ERS_RESULT_NONE;
544                 pci_walk_bus(frozen_bus, eeh_report_reset, &result);
545         }
546
547         /* All devices should claim they have recovered by now. */
548         if ((result != PCI_ERS_RESULT_RECOVERED) &&
549             (result != PCI_ERS_RESULT_NONE)) {
550                 printk(KERN_WARNING "EEH: Not recovered\n");
551                 goto hard_fail;
552         }
553
554         /* Tell all device drivers that they can resume operations */
555         pci_walk_bus(frozen_bus, eeh_report_resume, NULL);
556
557         return frozen_edev;
558         
559 excess_failures:
560         /*
561          * About 90% of all real-life EEH failures in the field
562          * are due to poorly seated PCI cards. Only 10% or so are
563          * due to actual, failed cards.
564          */
565         printk(KERN_ERR
566            "EEH: PCI device at location=%s driver=%s pci addr=%s\n"
567                 "has failed %d times in the last hour "
568                 "and has been permanently disabled.\n"
569                 "Please try reseating this device or replacing it.\n",
570                 location, drv_str, pci_str, frozen_edev->freeze_count);
571         goto perm_error;
572
573 hard_fail:
574         printk(KERN_ERR
575            "EEH: Unable to recover from failure of PCI device "
576            "at location=%s driver=%s pci addr=%s\n"
577            "Please try reseating this device or replacing it.\n",
578                 location, drv_str, pci_str);
579
580 perm_error:
581         eeh_slot_error_detail(frozen_edev, EEH_LOG_PERM);
582
583         /* Notify all devices that they're about to go down. */
584         pci_walk_bus(frozen_bus, eeh_report_failure, NULL);
585
586         /* Shut down the device drivers for good. */
587         pcibios_remove_pci_devices(frozen_bus);
588
589         return NULL;
590 }
591