Merge branch 'fix/soundcore' into for-linus
[pandora-kernel.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/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 #if 0
45 static void print_device_node_tree(struct pci_dn *pdn, int dent)
46 {
47         int i;
48         struct device_node *pc;
49
50         if (!pdn)
51                 return;
52         for (i = 0; i < dent; i++)
53                 printk(" ");
54         printk("dn=%s mode=%x \tcfg_addr=%x pe_addr=%x \tfull=%s\n",
55                 pdn->node->name, pdn->eeh_mode, pdn->eeh_config_addr,
56                 pdn->eeh_pe_config_addr, pdn->node->full_name);
57         dent += 3;
58         pc = pdn->node->child;
59         while (pc) {
60                 print_device_node_tree(PCI_DN(pc), dent);
61                 pc = pc->sibling;
62         }
63 }
64 #endif
65
66 /** 
67  * irq_in_use - return true if this irq is being used 
68  */
69 static int irq_in_use(unsigned int irq)
70 {
71         int rc = 0;
72         unsigned long flags;
73    struct irq_desc *desc = irq_desc + irq;
74
75         spin_lock_irqsave(&desc->lock, flags);
76         if (desc->action)
77                 rc = 1;
78         spin_unlock_irqrestore(&desc->lock, flags);
79         return rc;
80 }
81
82 /**
83  * eeh_disable_irq - disable interrupt for the recovering device
84  */
85 static void eeh_disable_irq(struct pci_dev *dev)
86 {
87         struct device_node *dn = pci_device_to_OF_node(dev);
88
89         /* Don't disable MSI and MSI-X interrupts. They are
90          * effectively disabled by the DMA Stopped state
91          * when an EEH error occurs.
92         */
93         if (dev->msi_enabled || dev->msix_enabled)
94                 return;
95
96         if (!irq_in_use(dev->irq))
97                 return;
98
99         PCI_DN(dn)->eeh_mode |= EEH_MODE_IRQ_DISABLED;
100         disable_irq_nosync(dev->irq);
101 }
102
103 /**
104  * eeh_enable_irq - enable interrupt for the recovering device
105  */
106 static void eeh_enable_irq(struct pci_dev *dev)
107 {
108         struct device_node *dn = pci_device_to_OF_node(dev);
109
110         if ((PCI_DN(dn)->eeh_mode) & EEH_MODE_IRQ_DISABLED) {
111                 PCI_DN(dn)->eeh_mode &= ~EEH_MODE_IRQ_DISABLED;
112                 enable_irq(dev->irq);
113         }
114 }
115
116 /* ------------------------------------------------------- */
117 /**
118  * eeh_report_error - report pci error to each device driver
119  * 
120  * Report an EEH error to each device driver, collect up and 
121  * merge the device driver responses. Cumulative response 
122  * passed back in "userdata".
123  */
124
125 static int eeh_report_error(struct pci_dev *dev, void *userdata)
126 {
127         enum pci_ers_result rc, *res = userdata;
128         struct pci_driver *driver = dev->driver;
129
130         dev->error_state = pci_channel_io_frozen;
131
132         if (!driver)
133                 return 0;
134
135         eeh_disable_irq(dev);
136
137         if (!driver->err_handler ||
138             !driver->err_handler->error_detected)
139                 return 0;
140
141         rc = driver->err_handler->error_detected (dev, pci_channel_io_frozen);
142
143         /* A driver that needs a reset trumps all others */
144         if (rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
145         if (*res == PCI_ERS_RESULT_NONE) *res = rc;
146
147         return 0;
148 }
149
150 /**
151  * eeh_report_mmio_enabled - tell drivers that MMIO has been enabled
152  *
153  * Tells each device driver that IO ports, MMIO and config space I/O
154  * are now enabled. Collects up and merges the device driver responses.
155  * Cumulative response passed back in "userdata".
156  */
157
158 static int eeh_report_mmio_enabled(struct pci_dev *dev, void *userdata)
159 {
160         enum pci_ers_result rc, *res = userdata;
161         struct pci_driver *driver = dev->driver;
162
163         if (!driver ||
164             !driver->err_handler ||
165             !driver->err_handler->mmio_enabled)
166                 return 0;
167
168         rc = driver->err_handler->mmio_enabled (dev);
169
170         /* A driver that needs a reset trumps all others */
171         if (rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
172         if (*res == PCI_ERS_RESULT_NONE) *res = rc;
173
174         return 0;
175 }
176
177 /**
178  * eeh_report_reset - tell device that slot has been reset
179  */
180
181 static int eeh_report_reset(struct pci_dev *dev, void *userdata)
182 {
183         enum pci_ers_result rc, *res = userdata;
184         struct pci_driver *driver = dev->driver;
185
186         if (!driver)
187                 return 0;
188
189         dev->error_state = pci_channel_io_normal;
190
191         eeh_enable_irq(dev);
192
193         if (!driver->err_handler ||
194             !driver->err_handler->slot_reset)
195                 return 0;
196
197         rc = driver->err_handler->slot_reset(dev);
198         if ((*res == PCI_ERS_RESULT_NONE) ||
199             (*res == PCI_ERS_RESULT_RECOVERED)) *res = rc;
200         if (*res == PCI_ERS_RESULT_DISCONNECT &&
201              rc == PCI_ERS_RESULT_NEED_RESET) *res = rc;
202
203         return 0;
204 }
205
206 /**
207  * eeh_report_resume - tell device to resume normal operations
208  */
209
210 static int eeh_report_resume(struct pci_dev *dev, void *userdata)
211 {
212         struct pci_driver *driver = dev->driver;
213
214         dev->error_state = pci_channel_io_normal;
215
216         if (!driver)
217                 return 0;
218
219         eeh_enable_irq(dev);
220
221         if (!driver->err_handler ||
222             !driver->err_handler->resume)
223                 return 0;
224
225         driver->err_handler->resume(dev);
226
227         return 0;
228 }
229
230 /**
231  * eeh_report_failure - tell device driver that device is dead.
232  *
233  * This informs the device driver that the device is permanently
234  * dead, and that no further recovery attempts will be made on it.
235  */
236
237 static int eeh_report_failure(struct pci_dev *dev, void *userdata)
238 {
239         struct pci_driver *driver = dev->driver;
240
241         dev->error_state = pci_channel_io_perm_failure;
242
243         if (!driver)
244                 return 0;
245
246         eeh_disable_irq(dev);
247
248         if (!driver->err_handler ||
249             !driver->err_handler->error_detected)
250                 return 0;
251
252         driver->err_handler->error_detected(dev, pci_channel_io_perm_failure);
253
254         return 0;
255 }
256
257 /* ------------------------------------------------------- */
258 /**
259  * handle_eeh_events -- reset a PCI device after hard lockup.
260  *
261  * pSeries systems will isolate a PCI slot if the PCI-Host
262  * bridge detects address or data parity errors, DMA's
263  * occurring to wild addresses (which usually happen due to
264  * bugs in device drivers or in PCI adapter firmware).
265  * Slot isolations also occur if #SERR, #PERR or other misc
266  * PCI-related errors are detected.
267  *
268  * Recovery process consists of unplugging the device driver
269  * (which generated hotplug events to userspace), then issuing
270  * a PCI #RST to the device, then reconfiguring the PCI config
271  * space for all bridges & devices under this slot, and then
272  * finally restarting the device drivers (which cause a second
273  * set of hotplug events to go out to userspace).
274  */
275
276 /**
277  * eeh_reset_device() -- perform actual reset of a pci slot
278  * @bus: pointer to the pci bus structure corresponding
279  *            to the isolated slot. A non-null value will
280  *            cause all devices under the bus to be removed
281  *            and then re-added.
282  * @pe_dn: pointer to a "Partionable Endpoint" device node.
283  *            This is the top-level structure on which pci
284  *            bus resets can be performed.
285  */
286
287 static int eeh_reset_device (struct pci_dn *pe_dn, struct pci_bus *bus)
288 {
289         struct device_node *dn;
290         int cnt, rc;
291
292         /* pcibios will clear the counter; save the value */
293         cnt = pe_dn->eeh_freeze_count;
294
295         if (bus)
296                 pcibios_remove_pci_devices(bus);
297
298         /* Reset the pci controller. (Asserts RST#; resets config space).
299          * Reconfigure bridges and devices. Don't try to bring the system
300          * up if the reset failed for some reason. */
301         rc = rtas_set_slot_reset(pe_dn);
302         if (rc)
303                 return rc;
304
305         /* Walk over all functions on this device.  */
306         dn = pe_dn->node;
307         if (!pcibios_find_pci_bus(dn) && PCI_DN(dn->parent))
308                 dn = dn->parent->child;
309
310         while (dn) {
311                 struct pci_dn *ppe = PCI_DN(dn);
312                 /* On Power4, always true because eeh_pe_config_addr=0 */
313                 if (pe_dn->eeh_pe_config_addr == ppe->eeh_pe_config_addr) {
314                         rtas_configure_bridge(ppe);
315                         eeh_restore_bars(ppe);
316                 }
317                 dn = dn->sibling;
318         }
319
320         /* Give the system 5 seconds to finish running the user-space
321          * hotplug shutdown scripts, e.g. ifdown for ethernet.  Yes, 
322          * this is a hack, but if we don't do this, and try to bring 
323          * the device up before the scripts have taken it down, 
324          * potentially weird things happen.
325          */
326         if (bus) {
327                 ssleep (5);
328                 pcibios_add_pci_devices(bus);
329         }
330         pe_dn->eeh_freeze_count = cnt;
331
332         return 0;
333 }
334
335 /* The longest amount of time to wait for a pci device
336  * to come back on line, in seconds.
337  */
338 #define MAX_WAIT_FOR_RECOVERY 150
339
340 struct pci_dn * handle_eeh_events (struct eeh_event *event)
341 {
342         struct device_node *frozen_dn;
343         struct pci_dn *frozen_pdn;
344         struct pci_bus *frozen_bus;
345         int rc = 0;
346         enum pci_ers_result result = PCI_ERS_RESULT_NONE;
347         const char *location, *pci_str, *drv_str;
348
349         frozen_dn = find_device_pe(event->dn);
350         if (!frozen_dn) {
351
352                 location = of_get_property(event->dn, "ibm,loc-code", NULL);
353                 location = location ? location : "unknown";
354                 printk(KERN_ERR "EEH: Error: Cannot find partition endpoint "
355                                 "for location=%s pci addr=%s\n",
356                         location, pci_name(event->dev));
357                 return NULL;
358         }
359
360         frozen_bus = pcibios_find_pci_bus(frozen_dn);
361         location = of_get_property(frozen_dn, "ibm,loc-code", NULL);
362         location = location ? location : "unknown";
363
364         /* There are two different styles for coming up with the PE.
365          * In the old style, it was the highest EEH-capable device
366          * which was always an EADS pci bridge.  In the new style,
367          * there might not be any EADS bridges, and even when there are,
368          * the firmware marks them as "EEH incapable". So another
369          * two-step is needed to find the pci bus.. */
370         if (!frozen_bus)
371                 frozen_bus = pcibios_find_pci_bus (frozen_dn->parent);
372
373         if (!frozen_bus) {
374                 printk(KERN_ERR "EEH: Cannot find PCI bus "
375                         "for location=%s dn=%s\n",
376                         location, frozen_dn->full_name);
377                 return NULL;
378         }
379
380         frozen_pdn = PCI_DN(frozen_dn);
381         frozen_pdn->eeh_freeze_count++;
382
383         if (frozen_pdn->pcidev) {
384                 pci_str = pci_name (frozen_pdn->pcidev);
385                 drv_str = pcid_name (frozen_pdn->pcidev);
386         } else {
387                 pci_str = pci_name (event->dev);
388                 drv_str = pcid_name (event->dev);
389         }
390         
391         if (frozen_pdn->eeh_freeze_count > EEH_MAX_ALLOWED_FREEZES)
392                 goto excess_failures;
393
394         printk(KERN_WARNING
395            "EEH: This PCI device has failed %d times in the last hour:\n",
396                 frozen_pdn->eeh_freeze_count);
397         printk(KERN_WARNING
398                 "EEH: location=%s driver=%s pci addr=%s\n",
399                 location, drv_str, pci_str);
400
401         /* Walk the various device drivers attached to this slot through
402          * a reset sequence, giving each an opportunity to do what it needs
403          * to accomplish the reset.  Each child gets a report of the
404          * status ... if any child can't handle the reset, then the entire
405          * slot is dlpar removed and added.
406          */
407         pci_walk_bus(frozen_bus, eeh_report_error, &result);
408
409         /* Get the current PCI slot state. This can take a long time,
410          * sometimes over 3 seconds for certain systems. */
411         rc = eeh_wait_for_slot_status (frozen_pdn, MAX_WAIT_FOR_RECOVERY*1000);
412         if (rc < 0) {
413                 printk(KERN_WARNING "EEH: Permanent failure\n");
414                 goto hard_fail;
415         }
416
417         /* Since rtas may enable MMIO when posting the error log,
418          * don't post the error log until after all dev drivers
419          * have been informed.
420          */
421         eeh_slot_error_detail(frozen_pdn, EEH_LOG_TEMP_FAILURE);
422
423         /* If all device drivers were EEH-unaware, then shut
424          * down all of the device drivers, and hope they
425          * go down willingly, without panicing the system.
426          */
427         if (result == PCI_ERS_RESULT_NONE) {
428                 rc = eeh_reset_device(frozen_pdn, frozen_bus);
429                 if (rc) {
430                         printk(KERN_WARNING "EEH: Unable to reset, rc=%d\n", rc);
431                         goto hard_fail;
432                 }
433         }
434
435         /* If all devices reported they can proceed, then re-enable MMIO */
436         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
437                 rc = rtas_pci_enable(frozen_pdn, EEH_THAW_MMIO);
438
439                 if (rc < 0)
440                         goto hard_fail;
441                 if (rc) {
442                         result = PCI_ERS_RESULT_NEED_RESET;
443                 } else {
444                         result = PCI_ERS_RESULT_NONE;
445                         pci_walk_bus(frozen_bus, eeh_report_mmio_enabled, &result);
446                 }
447         }
448
449         /* If all devices reported they can proceed, then re-enable DMA */
450         if (result == PCI_ERS_RESULT_CAN_RECOVER) {
451                 rc = rtas_pci_enable(frozen_pdn, EEH_THAW_DMA);
452
453                 if (rc < 0)
454                         goto hard_fail;
455                 if (rc)
456                         result = PCI_ERS_RESULT_NEED_RESET;
457                 else
458                         result = PCI_ERS_RESULT_RECOVERED;
459         }
460
461         /* If any device has a hard failure, then shut off everything. */
462         if (result == PCI_ERS_RESULT_DISCONNECT) {
463                 printk(KERN_WARNING "EEH: Device driver gave up\n");
464                 goto hard_fail;
465         }
466
467         /* If any device called out for a reset, then reset the slot */
468         if (result == PCI_ERS_RESULT_NEED_RESET) {
469                 rc = eeh_reset_device(frozen_pdn, NULL);
470                 if (rc) {
471                         printk(KERN_WARNING "EEH: Cannot reset, rc=%d\n", rc);
472                         goto hard_fail;
473                 }
474                 result = PCI_ERS_RESULT_NONE;
475                 pci_walk_bus(frozen_bus, eeh_report_reset, &result);
476         }
477
478         /* All devices should claim they have recovered by now. */
479         if ((result != PCI_ERS_RESULT_RECOVERED) &&
480             (result != PCI_ERS_RESULT_NONE)) {
481                 printk(KERN_WARNING "EEH: Not recovered\n");
482                 goto hard_fail;
483         }
484
485         /* Tell all device drivers that they can resume operations */
486         pci_walk_bus(frozen_bus, eeh_report_resume, NULL);
487
488         return frozen_pdn;
489         
490 excess_failures:
491         /*
492          * About 90% of all real-life EEH failures in the field
493          * are due to poorly seated PCI cards. Only 10% or so are
494          * due to actual, failed cards.
495          */
496         printk(KERN_ERR
497            "EEH: PCI device at location=%s driver=%s pci addr=%s \n"
498                 "has failed %d times in the last hour "
499                 "and has been permanently disabled. \n"
500                 "Please try reseating this device or replacing it.\n",
501                 location, drv_str, pci_str, frozen_pdn->eeh_freeze_count);
502         goto perm_error;
503
504 hard_fail:
505         printk(KERN_ERR
506            "EEH: Unable to recover from failure of PCI device "
507            "at location=%s driver=%s pci addr=%s \n"
508            "Please try reseating this device or replacing it.\n",
509                 location, drv_str, pci_str);
510
511 perm_error:
512         eeh_slot_error_detail(frozen_pdn, EEH_LOG_PERM_FAILURE);
513
514         /* Notify all devices that they're about to go down. */
515         pci_walk_bus(frozen_bus, eeh_report_failure, NULL);
516
517         /* Shut down the device drivers for good. */
518         pcibios_remove_pci_devices(frozen_bus);
519
520         return NULL;
521 }
522
523 /* ---------- end of file ---------- */