Merge branch 'release' of git://git.kernel.org/pub/scm/linux/kernel/git/aegl/linux-2.6
[linux-2.6] / arch / powerpc / platforms / pseries / eeh_driver.c
1 /*
2  * PCI Error Recovery Driver for RPA-compliant PPC64 platform.
3  * Copyright (C) 2004, 2005 Linas Vepstas <linas@linas.org>
4  *
5  * All rights reserved.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or (at
10  * your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
15  * NON INFRINGEMENT.  See the GNU General Public License for more
16  * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
21  *
22  * Send feedback to <linas@us.ibm.com>
23  *
24  */
25 #include <linux/delay.h>
26 #include <linux/interrupt.h>
27 #include <linux/irq.h>
28 #include <linux/pci.h>
29 #include <asm/eeh.h>
30 #include <asm/eeh_event.h>
31 #include <asm/ppc-pci.h>
32 #include <asm/pci-bridge.h>
33 #include <asm/prom.h>
34 #include <asm/rtas.h>
35
36
37 static inline const char * pcid_name (struct pci_dev *pdev)
38 {
39         if (pdev && pdev->dev.driver)
40                 return pdev->dev.driver->name;
41         return "";
42 }
43
44 #ifdef DEBUG
45 static void print_device_node_tree (struct pci_dn *pdn, int dent)
46 {
47         int i;
48         if (!pdn) return;
49         for (i=0;i<dent; i++)
50                 printk(" ");
51         printk("dn=%s mode=%x \tcfg_addr=%x pe_addr=%x \tfull=%s\n",
52                 pdn->node->name, pdn->eeh_mode, pdn->eeh_config_addr,
53                 pdn->eeh_pe_config_addr, pdn->node->full_name);
54         dent += 3;
55         struct device_node *pc = pdn->node->child;
56         while (pc) {
57                 print_device_node_tree(PCI_DN(pc), dent);
58                 pc = pc->sibling;
59         }
60 }
61 #endif
62
63 /** 
64  * irq_in_use - return true if this irq is being used 
65  */
66 static int irq_in_use(unsigned int irq)
67 {
68         int rc = 0;
69         unsigned long flags;
70    struct irq_desc *desc = irq_desc + irq;
71
72         spin_lock_irqsave(&desc->lock, flags);
73         if (desc->action)
74                 rc = 1;
75         spin_unlock_irqrestore(&desc->lock, flags);
76         return rc;
77 }
78
79 /* ------------------------------------------------------- */
80 /**
81  * eeh_report_error - report pci error to each device driver
82  * 
83  * Report an EEH error to each device driver, collect up and 
84  * merge the device driver responses. Cumulative response 
85  * passed back in "userdata".
86  */
87
88 static void eeh_report_error(struct pci_dev *dev, void *userdata)
89 {
90         enum pci_ers_result rc, *res = userdata;
91         struct pci_driver *driver = dev->driver;
92
93         dev->error_state = pci_channel_io_frozen;
94
95         if (!driver)
96                 return;
97
98         if (irq_in_use (dev->irq)) {
99                 struct device_node *dn = pci_device_to_OF_node(dev);
100                 PCI_DN(dn)->eeh_mode |= EEH_MODE_IRQ_DISABLED;
101                 disable_irq_nosync(dev->irq);
102         }
103         if (!driver->err_handler ||
104             !driver->err_handler->error_detected)
105                 return;
106
107         rc = driver->err_handler->error_detected (dev, pci_channel_io_frozen);
108         if (*res == PCI_ERS_RESULT_NONE) *res = rc;
109         if (*res == PCI_ERS_RESULT_DISCONNECT &&
110              rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
111 }
112
113 /**
114  * eeh_report_mmio_enabled - tell drivers that MMIO has been enabled
115  *
116  * Report an EEH error to each device driver, collect up and
117  * merge the device driver responses. Cumulative response
118  * passed back in "userdata".
119  */
120
121 static void eeh_report_mmio_enabled(struct pci_dev *dev, void *userdata)
122 {
123         enum pci_ers_result rc, *res = userdata;
124         struct pci_driver *driver = dev->driver;
125
126         // dev->error_state = pci_channel_mmio_enabled;
127
128         if (!driver ||
129             !driver->err_handler ||
130             !driver->err_handler->mmio_enabled)
131                 return;
132
133         rc = driver->err_handler->mmio_enabled (dev);
134         if (*res == PCI_ERS_RESULT_NONE) *res = rc;
135         if (*res == PCI_ERS_RESULT_DISCONNECT &&
136              rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
137 }
138
139 /**
140  * eeh_report_reset - tell device that slot has been reset
141  */
142
143 static void eeh_report_reset(struct pci_dev *dev, void *userdata)
144 {
145         enum pci_ers_result rc, *res = userdata;
146         struct pci_driver *driver = dev->driver;
147         struct device_node *dn = pci_device_to_OF_node(dev);
148
149         if (!driver)
150                 return;
151
152         if ((PCI_DN(dn)->eeh_mode) & EEH_MODE_IRQ_DISABLED) {
153                 PCI_DN(dn)->eeh_mode &= ~EEH_MODE_IRQ_DISABLED;
154                 enable_irq(dev->irq);
155         }
156         if (!driver->err_handler ||
157             !driver->err_handler->slot_reset)
158                 return;
159
160         rc = driver->err_handler->slot_reset(dev);
161         if (*res == PCI_ERS_RESULT_NONE) *res = rc;
162         if (*res == PCI_ERS_RESULT_DISCONNECT &&
163              rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
164 }
165
166 /**
167  * eeh_report_resume - tell device to resume normal operations
168  */
169
170 static void eeh_report_resume(struct pci_dev *dev, void *userdata)
171 {
172         struct pci_driver *driver = dev->driver;
173
174         dev->error_state = pci_channel_io_normal;
175
176         if (!driver)
177                 return;
178         if (!driver->err_handler)
179                 return;
180         if (!driver->err_handler->resume)
181                 return;
182
183         driver->err_handler->resume(dev);
184 }
185
186 /**
187  * eeh_report_failure - tell device driver that device is dead.
188  *
189  * This informs the device driver that the device is permanently
190  * dead, and that no further recovery attempts will be made on it.
191  */
192
193 static void eeh_report_failure(struct pci_dev *dev, void *userdata)
194 {
195         struct pci_driver *driver = dev->driver;
196
197         dev->error_state = pci_channel_io_perm_failure;
198
199         if (!driver)
200                 return;
201
202         if (irq_in_use (dev->irq)) {
203                 struct device_node *dn = pci_device_to_OF_node(dev);
204                 PCI_DN(dn)->eeh_mode |= EEH_MODE_IRQ_DISABLED;
205                 disable_irq_nosync(dev->irq);
206         }
207         if (!driver->err_handler)
208                 return;
209         if (!driver->err_handler->error_detected)
210                 return;
211         driver->err_handler->error_detected(dev, pci_channel_io_perm_failure);
212 }
213
214 /* ------------------------------------------------------- */
215 /**
216  * handle_eeh_events -- reset a PCI device after hard lockup.
217  *
218  * pSeries systems will isolate a PCI slot if the PCI-Host
219  * bridge detects address or data parity errors, DMA's
220  * occurring to wild addresses (which usually happen due to
221  * bugs in device drivers or in PCI adapter firmware).
222  * Slot isolations also occur if #SERR, #PERR or other misc
223  * PCI-related errors are detected.
224  *
225  * Recovery process consists of unplugging the device driver
226  * (which generated hotplug events to userspace), then issuing
227  * a PCI #RST to the device, then reconfiguring the PCI config
228  * space for all bridges & devices under this slot, and then
229  * finally restarting the device drivers (which cause a second
230  * set of hotplug events to go out to userspace).
231  */
232
233 /**
234  * eeh_reset_device() -- perform actual reset of a pci slot
235  * @bus: pointer to the pci bus structure corresponding
236  *            to the isolated slot. A non-null value will
237  *            cause all devices under the bus to be removed
238  *            and then re-added.
239  * @pe_dn: pointer to a "Partionable Endpoint" device node.
240  *            This is the top-level structure on which pci
241  *            bus resets can be performed.
242  */
243
244 static int eeh_reset_device (struct pci_dn *pe_dn, struct pci_bus *bus)
245 {
246         int cnt, rc;
247
248         /* pcibios will clear the counter; save the value */
249         cnt = pe_dn->eeh_freeze_count;
250
251         if (bus)
252                 pcibios_remove_pci_devices(bus);
253
254         /* Reset the pci controller. (Asserts RST#; resets config space).
255          * Reconfigure bridges and devices. Don't try to bring the system
256          * up if the reset failed for some reason. */
257         rc = rtas_set_slot_reset(pe_dn);
258         if (rc)
259                 return rc;
260
261         /* New-style config addrs might be shared across multiple devices,
262          * Walk over all functions on this device */
263         if (pe_dn->eeh_pe_config_addr) {
264                 struct device_node *pe = pe_dn->node;
265                 pe = pe->parent->child;
266                 while (pe) {
267                         struct pci_dn *ppe = PCI_DN(pe);
268                         if (pe_dn->eeh_pe_config_addr == ppe->eeh_pe_config_addr) {
269                                 rtas_configure_bridge(ppe);
270                                 eeh_restore_bars(ppe);
271                         }
272                         pe = pe->sibling;
273                 }
274         } else {
275                 rtas_configure_bridge(pe_dn);
276                 eeh_restore_bars(pe_dn);
277         }
278
279         /* Give the system 5 seconds to finish running the user-space
280          * hotplug shutdown scripts, e.g. ifdown for ethernet.  Yes, 
281          * this is a hack, but if we don't do this, and try to bring 
282          * the device up before the scripts have taken it down, 
283          * potentially weird things happen.
284          */
285         if (bus) {
286                 ssleep (5);
287                 pcibios_add_pci_devices(bus);
288         }
289         pe_dn->eeh_freeze_count = cnt;
290
291         return 0;
292 }
293
294 /* The longest amount of time to wait for a pci device
295  * to come back on line, in seconds.
296  */
297 #define MAX_WAIT_FOR_RECOVERY 15
298
299 struct pci_dn * handle_eeh_events (struct eeh_event *event)
300 {
301         struct device_node *frozen_dn;
302         struct pci_dn *frozen_pdn;
303         struct pci_bus *frozen_bus;
304         int rc = 0;
305         enum pci_ers_result result = PCI_ERS_RESULT_NONE;
306         const char *location, *pci_str, *drv_str;
307
308         frozen_dn = find_device_pe(event->dn);
309         frozen_bus = pcibios_find_pci_bus(frozen_dn);
310
311         if (!frozen_dn) {
312
313                 location = get_property(event->dn, "ibm,loc-code", NULL);
314                 location = location ? location : "unknown";
315                 printk(KERN_ERR "EEH: Error: Cannot find partition endpoint "
316                                 "for location=%s pci addr=%s\n",
317                         location, pci_name(event->dev));
318                 return NULL;
319         }
320         location = get_property(frozen_dn, "ibm,loc-code", NULL);
321         location = location ? location : "unknown";
322
323         /* There are two different styles for coming up with the PE.
324          * In the old style, it was the highest EEH-capable device
325          * which was always an EADS pci bridge.  In the new style,
326          * there might not be any EADS bridges, and even when there are,
327          * the firmware marks them as "EEH incapable". So another
328          * two-step is needed to find the pci bus.. */
329         if (!frozen_bus)
330                 frozen_bus = pcibios_find_pci_bus (frozen_dn->parent);
331
332         if (!frozen_bus) {
333                 printk(KERN_ERR "EEH: Cannot find PCI bus "
334                         "for location=%s dn=%s\n",
335                         location, frozen_dn->full_name);
336                 return NULL;
337         }
338
339 #if 0
340         /* We may get "permanent failure" messages on empty slots.
341          * These are false alarms. Empty slots have no child dn. */
342         if ((event->state == pci_channel_io_perm_failure) && (frozen_device == NULL))
343                 return;
344 #endif
345
346         frozen_pdn = PCI_DN(frozen_dn);
347         frozen_pdn->eeh_freeze_count++;
348
349         if (frozen_pdn->pcidev) {
350                 pci_str = pci_name (frozen_pdn->pcidev);
351                 drv_str = pcid_name (frozen_pdn->pcidev);
352         } else {
353                 pci_str = pci_name (event->dev);
354                 drv_str = pcid_name (event->dev);
355         }
356         
357         if (frozen_pdn->eeh_freeze_count > EEH_MAX_ALLOWED_FREEZES)
358                 goto excess_failures;
359
360         /* If the reset state is a '5' and the time to reset is 0 (infinity)
361          * or is more then 15 seconds, then mark this as a permanent failure.
362          */
363         if ((event->state == pci_channel_io_perm_failure) &&
364             ((event->time_unavail <= 0) ||
365              (event->time_unavail > MAX_WAIT_FOR_RECOVERY*1000)))
366                 goto hard_fail;
367
368         eeh_slot_error_detail(frozen_pdn, 1 /* Temporary Error */);
369         printk(KERN_WARNING
370            "EEH: This PCI device has failed %d times since last reboot: "
371                 "location=%s driver=%s pci addr=%s\n",
372                 frozen_pdn->eeh_freeze_count, location, drv_str, pci_str);
373
374         /* Walk the various device drivers attached to this slot through
375          * a reset sequence, giving each an opportunity to do what it needs
376          * to accomplish the reset.  Each child gets a report of the
377          * status ... if any child can't handle the reset, then the entire
378          * slot is dlpar removed and added.
379          */
380         pci_walk_bus(frozen_bus, eeh_report_error, &result);
381
382         /* If all device drivers were EEH-unaware, then shut
383          * down all of the device drivers, and hope they
384          * go down willingly, without panicing the system.
385          */
386         if (result == PCI_ERS_RESULT_NONE) {
387                 rc = eeh_reset_device(frozen_pdn, frozen_bus);
388                 if (rc)
389                         goto hard_fail;
390         }
391
392         /* If all devices reported they can proceed, then re-enable MMIO */
393         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
394                 rc = rtas_pci_enable(frozen_pdn, EEH_THAW_MMIO);
395
396                 if (rc) {
397                         result = PCI_ERS_RESULT_NEED_RESET;
398                 } else {
399                         result = PCI_ERS_RESULT_NONE;
400                         pci_walk_bus(frozen_bus, eeh_report_mmio_enabled, &result);
401                 }
402         }
403
404         /* If all devices reported they can proceed, then re-enable DMA */
405         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
406                 rc = rtas_pci_enable(frozen_pdn, EEH_THAW_DMA);
407
408                 if (rc)
409                         result = PCI_ERS_RESULT_NEED_RESET;
410         }
411
412         /* If any device has a hard failure, then shut off everything. */
413         if (result == PCI_ERS_RESULT_DISCONNECT)
414                 goto hard_fail;
415
416         /* If any device called out for a reset, then reset the slot */
417         if (result == PCI_ERS_RESULT_NEED_RESET) {
418                 rc = eeh_reset_device(frozen_pdn, NULL);
419                 if (rc)
420                         goto hard_fail;
421                 result = PCI_ERS_RESULT_NONE;
422                 pci_walk_bus(frozen_bus, eeh_report_reset, &result);
423         }
424
425         /* All devices should claim they have recovered by now. */
426         if (result != PCI_ERS_RESULT_RECOVERED)
427                 goto hard_fail;
428
429         /* Tell all device drivers that they can resume operations */
430         pci_walk_bus(frozen_bus, eeh_report_resume, NULL);
431
432         return frozen_pdn;
433         
434 excess_failures:
435         /*
436          * About 90% of all real-life EEH failures in the field
437          * are due to poorly seated PCI cards. Only 10% or so are
438          * due to actual, failed cards.
439          */
440         printk(KERN_ERR
441            "EEH: PCI device at location=%s driver=%s pci addr=%s \n"
442                 "has failed %d times and has been permanently disabled. \n"
443                 "Please try reseating this device or replacing it.\n",
444                 location, drv_str, pci_str, frozen_pdn->eeh_freeze_count);
445         goto perm_error;
446
447 hard_fail:
448         printk(KERN_ERR
449            "EEH: Unable to recover from failure of PCI device "
450            "at location=%s driver=%s pci addr=%s \n"
451            "Please try reseating this device or replacing it.\n",
452                 location, drv_str, pci_str);
453
454 perm_error:
455         eeh_slot_error_detail(frozen_pdn, 2 /* Permanent Error */);
456
457         /* Notify all devices that they're about to go down. */
458         pci_walk_bus(frozen_bus, eeh_report_failure, NULL);
459
460         /* Shut down the device drivers for good. */
461         pcibios_remove_pci_devices(frozen_bus);
462
463         return NULL;
464 }
465
466 /* ---------- end of file ---------- */