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