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