Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[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         struct device_node *dn = pci_device_to_OF_node(dev);
174
175         dev->error_state = pci_channel_io_normal;
176
177         if (!driver)
178                 return;
179
180         if ((PCI_DN(dn)->eeh_mode) & EEH_MODE_IRQ_DISABLED) {
181                 PCI_DN(dn)->eeh_mode &= ~EEH_MODE_IRQ_DISABLED;
182                 enable_irq(dev->irq);
183         }
184         if (!driver->err_handler ||
185             !driver->err_handler->resume)
186                 return;
187
188         driver->err_handler->resume(dev);
189 }
190
191 /**
192  * eeh_report_failure - tell device driver that device is dead.
193  *
194  * This informs the device driver that the device is permanently
195  * dead, and that no further recovery attempts will be made on it.
196  */
197
198 static void eeh_report_failure(struct pci_dev *dev, void *userdata)
199 {
200         struct pci_driver *driver = dev->driver;
201
202         dev->error_state = pci_channel_io_perm_failure;
203
204         if (!driver)
205                 return;
206
207         if (irq_in_use (dev->irq)) {
208                 struct device_node *dn = pci_device_to_OF_node(dev);
209                 PCI_DN(dn)->eeh_mode |= EEH_MODE_IRQ_DISABLED;
210                 disable_irq_nosync(dev->irq);
211         }
212         if (!driver->err_handler)
213                 return;
214         if (!driver->err_handler->error_detected)
215                 return;
216         driver->err_handler->error_detected(dev, pci_channel_io_perm_failure);
217 }
218
219 /* ------------------------------------------------------- */
220 /**
221  * handle_eeh_events -- reset a PCI device after hard lockup.
222  *
223  * pSeries systems will isolate a PCI slot if the PCI-Host
224  * bridge detects address or data parity errors, DMA's
225  * occurring to wild addresses (which usually happen due to
226  * bugs in device drivers or in PCI adapter firmware).
227  * Slot isolations also occur if #SERR, #PERR or other misc
228  * PCI-related errors are detected.
229  *
230  * Recovery process consists of unplugging the device driver
231  * (which generated hotplug events to userspace), then issuing
232  * a PCI #RST to the device, then reconfiguring the PCI config
233  * space for all bridges & devices under this slot, and then
234  * finally restarting the device drivers (which cause a second
235  * set of hotplug events to go out to userspace).
236  */
237
238 /**
239  * eeh_reset_device() -- perform actual reset of a pci slot
240  * @bus: pointer to the pci bus structure corresponding
241  *            to the isolated slot. A non-null value will
242  *            cause all devices under the bus to be removed
243  *            and then re-added.
244  * @pe_dn: pointer to a "Partionable Endpoint" device node.
245  *            This is the top-level structure on which pci
246  *            bus resets can be performed.
247  */
248
249 static int eeh_reset_device (struct pci_dn *pe_dn, struct pci_bus *bus)
250 {
251         int cnt, rc;
252
253         /* pcibios will clear the counter; save the value */
254         cnt = pe_dn->eeh_freeze_count;
255
256         if (bus)
257                 pcibios_remove_pci_devices(bus);
258
259         /* Reset the pci controller. (Asserts RST#; resets config space).
260          * Reconfigure bridges and devices. Don't try to bring the system
261          * up if the reset failed for some reason. */
262         rc = rtas_set_slot_reset(pe_dn);
263         if (rc)
264                 return rc;
265
266         /* New-style config addrs might be shared across multiple devices,
267          * Walk over all functions on this device */
268         if (pe_dn->eeh_pe_config_addr) {
269                 struct device_node *pe = pe_dn->node;
270                 pe = pe->parent->child;
271                 while (pe) {
272                         struct pci_dn *ppe = PCI_DN(pe);
273                         if (pe_dn->eeh_pe_config_addr == ppe->eeh_pe_config_addr) {
274                                 rtas_configure_bridge(ppe);
275                                 eeh_restore_bars(ppe);
276                         }
277                         pe = pe->sibling;
278                 }
279         } else {
280                 rtas_configure_bridge(pe_dn);
281                 eeh_restore_bars(pe_dn);
282         }
283
284         /* Give the system 5 seconds to finish running the user-space
285          * hotplug shutdown scripts, e.g. ifdown for ethernet.  Yes, 
286          * this is a hack, but if we don't do this, and try to bring 
287          * the device up before the scripts have taken it down, 
288          * potentially weird things happen.
289          */
290         if (bus) {
291                 ssleep (5);
292                 pcibios_add_pci_devices(bus);
293         }
294         pe_dn->eeh_freeze_count = cnt;
295
296         return 0;
297 }
298
299 /* The longest amount of time to wait for a pci device
300  * to come back on line, in seconds.
301  */
302 #define MAX_WAIT_FOR_RECOVERY 15
303
304 struct pci_dn * handle_eeh_events (struct eeh_event *event)
305 {
306         struct device_node *frozen_dn;
307         struct pci_dn *frozen_pdn;
308         struct pci_bus *frozen_bus;
309         int rc = 0;
310         enum pci_ers_result result = PCI_ERS_RESULT_NONE;
311         const char *location, *pci_str, *drv_str;
312
313         frozen_dn = find_device_pe(event->dn);
314         frozen_bus = pcibios_find_pci_bus(frozen_dn);
315
316         if (!frozen_dn) {
317
318                 location = get_property(event->dn, "ibm,loc-code", NULL);
319                 location = location ? location : "unknown";
320                 printk(KERN_ERR "EEH: Error: Cannot find partition endpoint "
321                                 "for location=%s pci addr=%s\n",
322                         location, pci_name(event->dev));
323                 return NULL;
324         }
325         location = get_property(frozen_dn, "ibm,loc-code", NULL);
326         location = location ? location : "unknown";
327
328         /* There are two different styles for coming up with the PE.
329          * In the old style, it was the highest EEH-capable device
330          * which was always an EADS pci bridge.  In the new style,
331          * there might not be any EADS bridges, and even when there are,
332          * the firmware marks them as "EEH incapable". So another
333          * two-step is needed to find the pci bus.. */
334         if (!frozen_bus)
335                 frozen_bus = pcibios_find_pci_bus (frozen_dn->parent);
336
337         if (!frozen_bus) {
338                 printk(KERN_ERR "EEH: Cannot find PCI bus "
339                         "for location=%s dn=%s\n",
340                         location, frozen_dn->full_name);
341                 return NULL;
342         }
343
344 #if 0
345         /* We may get "permanent failure" messages on empty slots.
346          * These are false alarms. Empty slots have no child dn. */
347         if ((event->state == pci_channel_io_perm_failure) && (frozen_device == NULL))
348                 return;
349 #endif
350
351         frozen_pdn = PCI_DN(frozen_dn);
352         frozen_pdn->eeh_freeze_count++;
353
354         if (frozen_pdn->pcidev) {
355                 pci_str = pci_name (frozen_pdn->pcidev);
356                 drv_str = pcid_name (frozen_pdn->pcidev);
357         } else {
358                 pci_str = pci_name (event->dev);
359                 drv_str = pcid_name (event->dev);
360         }
361         
362         if (frozen_pdn->eeh_freeze_count > EEH_MAX_ALLOWED_FREEZES)
363                 goto excess_failures;
364
365         /* If the reset state is a '5' and the time to reset is 0 (infinity)
366          * or is more then 15 seconds, then mark this as a permanent failure.
367          */
368         if ((event->state == pci_channel_io_perm_failure) &&
369             ((event->time_unavail <= 0) ||
370              (event->time_unavail > MAX_WAIT_FOR_RECOVERY*1000)))
371                 goto hard_fail;
372
373         eeh_slot_error_detail(frozen_pdn, 1 /* Temporary Error */);
374         printk(KERN_WARNING
375            "EEH: This PCI device has failed %d times since last reboot: "
376                 "location=%s driver=%s pci addr=%s\n",
377                 frozen_pdn->eeh_freeze_count, location, drv_str, pci_str);
378
379         /* Walk the various device drivers attached to this slot through
380          * a reset sequence, giving each an opportunity to do what it needs
381          * to accomplish the reset.  Each child gets a report of the
382          * status ... if any child can't handle the reset, then the entire
383          * slot is dlpar removed and added.
384          */
385         pci_walk_bus(frozen_bus, eeh_report_error, &result);
386
387         /* If all device drivers were EEH-unaware, then shut
388          * down all of the device drivers, and hope they
389          * go down willingly, without panicing the system.
390          */
391         if (result == PCI_ERS_RESULT_NONE) {
392                 rc = eeh_reset_device(frozen_pdn, frozen_bus);
393                 if (rc)
394                         goto hard_fail;
395         }
396
397         /* If all devices reported they can proceed, then re-enable MMIO */
398         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
399                 rc = rtas_pci_enable(frozen_pdn, EEH_THAW_MMIO);
400
401                 if (rc) {
402                         result = PCI_ERS_RESULT_NEED_RESET;
403                 } else {
404                         result = PCI_ERS_RESULT_NONE;
405                         pci_walk_bus(frozen_bus, eeh_report_mmio_enabled, &result);
406                 }
407         }
408
409         /* If all devices reported they can proceed, then re-enable DMA */
410         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
411                 rc = rtas_pci_enable(frozen_pdn, EEH_THAW_DMA);
412
413                 if (rc)
414                         result = PCI_ERS_RESULT_NEED_RESET;
415                 else
416                         result = PCI_ERS_RESULT_RECOVERED;
417         }
418
419         /* If any device has a hard failure, then shut off everything. */
420         if (result == PCI_ERS_RESULT_DISCONNECT)
421                 goto hard_fail;
422
423         /* If any device called out for a reset, then reset the slot */
424         if (result == PCI_ERS_RESULT_NEED_RESET) {
425                 rc = eeh_reset_device(frozen_pdn, NULL);
426                 if (rc)
427                         goto hard_fail;
428                 result = PCI_ERS_RESULT_NONE;
429                 pci_walk_bus(frozen_bus, eeh_report_reset, &result);
430         }
431
432         /* All devices should claim they have recovered by now. */
433         if (result != PCI_ERS_RESULT_RECOVERED)
434                 goto hard_fail;
435
436         /* Tell all device drivers that they can resume operations */
437         pci_walk_bus(frozen_bus, eeh_report_resume, NULL);
438
439         return frozen_pdn;
440         
441 excess_failures:
442         /*
443          * About 90% of all real-life EEH failures in the field
444          * are due to poorly seated PCI cards. Only 10% or so are
445          * due to actual, failed cards.
446          */
447         printk(KERN_ERR
448            "EEH: PCI device at location=%s driver=%s pci addr=%s \n"
449                 "has failed %d times in the last hour "
450                 "and has been permanently disabled. \n"
451                 "Please try reseating this device or replacing it.\n",
452                 location, drv_str, pci_str, frozen_pdn->eeh_freeze_count);
453         goto perm_error;
454
455 hard_fail:
456         printk(KERN_ERR
457            "EEH: Unable to recover from failure of PCI device "
458            "at location=%s driver=%s pci addr=%s \n"
459            "Please try reseating this device or replacing it.\n",
460                 location, drv_str, pci_str);
461
462 perm_error:
463         eeh_slot_error_detail(frozen_pdn, 2 /* Permanent Error */);
464
465         /* Notify all devices that they're about to go down. */
466         pci_walk_bus(frozen_bus, eeh_report_failure, NULL);
467
468         /* Shut down the device drivers for good. */
469         pcibios_remove_pci_devices(frozen_bus);
470
471         return NULL;
472 }
473
474 /* ---------- end of file ---------- */