Merge master.kernel.org:/pub/scm/linux/kernel/git/jejb/scsi-misc-2.6
[linux-2.6] / arch / powerpc / platforms / pseries / eeh.c
1 /*
2  * eeh.c
3  * Copyright (C) 2001 Dave Engebretsen & Todd Inglett IBM Corporation
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18  */
19
20 #include <linux/delay.h>
21 #include <linux/init.h>
22 #include <linux/list.h>
23 #include <linux/pci.h>
24 #include <linux/proc_fs.h>
25 #include <linux/rbtree.h>
26 #include <linux/seq_file.h>
27 #include <linux/spinlock.h>
28 #include <asm/atomic.h>
29 #include <asm/eeh.h>
30 #include <asm/eeh_event.h>
31 #include <asm/io.h>
32 #include <asm/machdep.h>
33 #include <asm/ppc-pci.h>
34 #include <asm/rtas.h>
35
36 #undef DEBUG
37
38 /** Overview:
39  *  EEH, or "Extended Error Handling" is a PCI bridge technology for
40  *  dealing with PCI bus errors that can't be dealt with within the
41  *  usual PCI framework, except by check-stopping the CPU.  Systems
42  *  that are designed for high-availability/reliability cannot afford
43  *  to crash due to a "mere" PCI error, thus the need for EEH.
44  *  An EEH-capable bridge operates by converting a detected error
45  *  into a "slot freeze", taking the PCI adapter off-line, making
46  *  the slot behave, from the OS'es point of view, as if the slot
47  *  were "empty": all reads return 0xff's and all writes are silently
48  *  ignored.  EEH slot isolation events can be triggered by parity
49  *  errors on the address or data busses (e.g. during posted writes),
50  *  which in turn might be caused by low voltage on the bus, dust,
51  *  vibration, humidity, radioactivity or plain-old failed hardware.
52  *
53  *  Note, however, that one of the leading causes of EEH slot
54  *  freeze events are buggy device drivers, buggy device microcode,
55  *  or buggy device hardware.  This is because any attempt by the
56  *  device to bus-master data to a memory address that is not
57  *  assigned to the device will trigger a slot freeze.   (The idea
58  *  is to prevent devices-gone-wild from corrupting system memory).
59  *  Buggy hardware/drivers will have a miserable time co-existing
60  *  with EEH.
61  *
62  *  Ideally, a PCI device driver, when suspecting that an isolation
63  *  event has occured (e.g. by reading 0xff's), will then ask EEH
64  *  whether this is the case, and then take appropriate steps to
65  *  reset the PCI slot, the PCI device, and then resume operations.
66  *  However, until that day,  the checking is done here, with the
67  *  eeh_check_failure() routine embedded in the MMIO macros.  If
68  *  the slot is found to be isolated, an "EEH Event" is synthesized
69  *  and sent out for processing.
70  */
71
72 /* If a device driver keeps reading an MMIO register in an interrupt
73  * handler after a slot isolation event has occurred, we assume it
74  * is broken and panic.  This sets the threshold for how many read
75  * attempts we allow before panicking.
76  */
77 #define EEH_MAX_FAILS   2100000
78
79 /* Time to wait for a PCI slot to retport status, in milliseconds */
80 #define PCI_BUS_RESET_WAIT_MSEC (60*1000)
81
82 /* RTAS tokens */
83 static int ibm_set_eeh_option;
84 static int ibm_set_slot_reset;
85 static int ibm_read_slot_reset_state;
86 static int ibm_read_slot_reset_state2;
87 static int ibm_slot_error_detail;
88 static int ibm_get_config_addr_info;
89 static int ibm_get_config_addr_info2;
90 static int ibm_configure_bridge;
91
92 int eeh_subsystem_enabled;
93 EXPORT_SYMBOL(eeh_subsystem_enabled);
94
95 /* Lock to avoid races due to multiple reports of an error */
96 static DEFINE_SPINLOCK(confirm_error_lock);
97
98 /* Buffer for reporting slot-error-detail rtas calls */
99 static unsigned char slot_errbuf[RTAS_ERROR_LOG_MAX];
100 static DEFINE_SPINLOCK(slot_errbuf_lock);
101 static int eeh_error_buf_size;
102
103 /* System monitoring statistics */
104 static unsigned long no_device;
105 static unsigned long no_dn;
106 static unsigned long no_cfg_addr;
107 static unsigned long ignored_check;
108 static unsigned long total_mmio_ffs;
109 static unsigned long false_positives;
110 static unsigned long ignored_failures;
111 static unsigned long slot_resets;
112
113 #define IS_BRIDGE(class_code) (((class_code)<<16) == PCI_BASE_CLASS_BRIDGE)
114
115 /* --------------------------------------------------------------- */
116 /* Below lies the EEH event infrastructure */
117
118 void eeh_slot_error_detail (struct pci_dn *pdn, int severity)
119 {
120         int config_addr;
121         unsigned long flags;
122         int rc;
123
124         /* Log the error with the rtas logger */
125         spin_lock_irqsave(&slot_errbuf_lock, flags);
126         memset(slot_errbuf, 0, eeh_error_buf_size);
127
128         /* Use PE configuration address, if present */
129         config_addr = pdn->eeh_config_addr;
130         if (pdn->eeh_pe_config_addr)
131                 config_addr = pdn->eeh_pe_config_addr;
132
133         rc = rtas_call(ibm_slot_error_detail,
134                        8, 1, NULL, config_addr,
135                        BUID_HI(pdn->phb->buid),
136                        BUID_LO(pdn->phb->buid), NULL, 0,
137                        virt_to_phys(slot_errbuf),
138                        eeh_error_buf_size,
139                        severity);
140
141         if (rc == 0)
142                 log_error(slot_errbuf, ERR_TYPE_RTAS_LOG, 0);
143         spin_unlock_irqrestore(&slot_errbuf_lock, flags);
144 }
145
146 /**
147  * read_slot_reset_state - Read the reset state of a device node's slot
148  * @dn: device node to read
149  * @rets: array to return results in
150  */
151 static int read_slot_reset_state(struct pci_dn *pdn, int rets[])
152 {
153         int token, outputs;
154         int config_addr;
155
156         if (ibm_read_slot_reset_state2 != RTAS_UNKNOWN_SERVICE) {
157                 token = ibm_read_slot_reset_state2;
158                 outputs = 4;
159         } else {
160                 token = ibm_read_slot_reset_state;
161                 rets[2] = 0; /* fake PE Unavailable info */
162                 outputs = 3;
163         }
164
165         /* Use PE configuration address, if present */
166         config_addr = pdn->eeh_config_addr;
167         if (pdn->eeh_pe_config_addr)
168                 config_addr = pdn->eeh_pe_config_addr;
169
170         return rtas_call(token, 3, outputs, rets, config_addr,
171                          BUID_HI(pdn->phb->buid), BUID_LO(pdn->phb->buid));
172 }
173
174 /**
175  * eeh_wait_for_slot_status - returns error status of slot
176  * @pdn pci device node
177  * @max_wait_msecs maximum number to millisecs to wait
178  *
179  * Return negative value if a permanent error, else return
180  * Partition Endpoint (PE) status value.
181  *
182  * If @max_wait_msecs is positive, then this routine will
183  * sleep until a valid status can be obtained, or until
184  * the max allowed wait time is exceeded, in which case
185  * a -2 is returned.
186  */
187 int
188 eeh_wait_for_slot_status(struct pci_dn *pdn, int max_wait_msecs)
189 {
190         int rc;
191         int rets[3];
192         int mwait;
193
194         while (1) {
195                 rc = read_slot_reset_state(pdn, rets);
196                 if (rc) return rc;
197                 if (rets[1] == 0) return -1;  /* EEH is not supported */
198
199                 if (rets[0] != 5) return rets[0]; /* return actual status */
200
201                 if (rets[2] == 0) return -1; /* permanently unavailable */
202
203                 if (max_wait_msecs <= 0) return -1;
204
205                 mwait = rets[2];
206                 if (mwait <= 0) {
207                         printk (KERN_WARNING
208                                 "EEH: Firmware returned bad wait value=%d\n", mwait);
209                         mwait = 1000;
210                 } else if (mwait > 300*1000) {
211                         printk (KERN_WARNING
212                                 "EEH: Firmware is taking too long, time=%d\n", mwait);
213                         mwait = 300*1000;
214                 }
215                 max_wait_msecs -= mwait;
216                 msleep (mwait);
217         }
218
219         printk(KERN_WARNING "EEH: Timed out waiting for slot status\n");
220         return -2;
221 }
222
223 /**
224  * eeh_token_to_phys - convert EEH address token to phys address
225  * @token i/o token, should be address in the form 0xA....
226  */
227 static inline unsigned long eeh_token_to_phys(unsigned long token)
228 {
229         pte_t *ptep;
230         unsigned long pa;
231
232         ptep = find_linux_pte(init_mm.pgd, token);
233         if (!ptep)
234                 return token;
235         pa = pte_pfn(*ptep) << PAGE_SHIFT;
236
237         return pa | (token & (PAGE_SIZE-1));
238 }
239
240 /** 
241  * Return the "partitionable endpoint" (pe) under which this device lies
242  */
243 struct device_node * find_device_pe(struct device_node *dn)
244 {
245         while ((dn->parent) && PCI_DN(dn->parent) &&
246               (PCI_DN(dn->parent)->eeh_mode & EEH_MODE_SUPPORTED)) {
247                 dn = dn->parent;
248         }
249         return dn;
250 }
251
252 /** Mark all devices that are peers of this device as failed.
253  *  Mark the device driver too, so that it can see the failure
254  *  immediately; this is critical, since some drivers poll
255  *  status registers in interrupts ... If a driver is polling,
256  *  and the slot is frozen, then the driver can deadlock in
257  *  an interrupt context, which is bad.
258  */
259
260 static void __eeh_mark_slot (struct device_node *dn, int mode_flag)
261 {
262         while (dn) {
263                 if (PCI_DN(dn)) {
264                         /* Mark the pci device driver too */
265                         struct pci_dev *dev = PCI_DN(dn)->pcidev;
266
267                         PCI_DN(dn)->eeh_mode |= mode_flag;
268
269                         if (dev && dev->driver)
270                                 dev->error_state = pci_channel_io_frozen;
271
272                         if (dn->child)
273                                 __eeh_mark_slot (dn->child, mode_flag);
274                 }
275                 dn = dn->sibling;
276         }
277 }
278
279 void eeh_mark_slot (struct device_node *dn, int mode_flag)
280 {
281         struct pci_dev *dev;
282         dn = find_device_pe (dn);
283
284         /* Back up one, since config addrs might be shared */
285         if (!pcibios_find_pci_bus(dn) && PCI_DN(dn->parent))
286                 dn = dn->parent;
287
288         PCI_DN(dn)->eeh_mode |= mode_flag;
289
290         /* Mark the pci device too */
291         dev = PCI_DN(dn)->pcidev;
292         if (dev)
293                 dev->error_state = pci_channel_io_frozen;
294
295         __eeh_mark_slot (dn->child, mode_flag);
296 }
297
298 static void __eeh_clear_slot (struct device_node *dn, int mode_flag)
299 {
300         while (dn) {
301                 if (PCI_DN(dn)) {
302                         PCI_DN(dn)->eeh_mode &= ~mode_flag;
303                         PCI_DN(dn)->eeh_check_count = 0;
304                         if (dn->child)
305                                 __eeh_clear_slot (dn->child, mode_flag);
306                 }
307                 dn = dn->sibling;
308         }
309 }
310
311 void eeh_clear_slot (struct device_node *dn, int mode_flag)
312 {
313         unsigned long flags;
314         spin_lock_irqsave(&confirm_error_lock, flags);
315         
316         dn = find_device_pe (dn);
317         
318         /* Back up one, since config addrs might be shared */
319         if (!pcibios_find_pci_bus(dn) && PCI_DN(dn->parent))
320                 dn = dn->parent;
321
322         PCI_DN(dn)->eeh_mode &= ~mode_flag;
323         PCI_DN(dn)->eeh_check_count = 0;
324         __eeh_clear_slot (dn->child, mode_flag);
325         spin_unlock_irqrestore(&confirm_error_lock, flags);
326 }
327
328 /**
329  * eeh_dn_check_failure - check if all 1's data is due to EEH slot freeze
330  * @dn device node
331  * @dev pci device, if known
332  *
333  * Check for an EEH failure for the given device node.  Call this
334  * routine if the result of a read was all 0xff's and you want to
335  * find out if this is due to an EEH slot freeze.  This routine
336  * will query firmware for the EEH status.
337  *
338  * Returns 0 if there has not been an EEH error; otherwise returns
339  * a non-zero value and queues up a slot isolation event notification.
340  *
341  * It is safe to call this routine in an interrupt context.
342  */
343 int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev)
344 {
345         int ret;
346         int rets[3];
347         unsigned long flags;
348         struct pci_dn *pdn;
349         int rc = 0;
350
351         total_mmio_ffs++;
352
353         if (!eeh_subsystem_enabled)
354                 return 0;
355
356         if (!dn) {
357                 no_dn++;
358                 return 0;
359         }
360         pdn = PCI_DN(dn);
361
362         /* Access to IO BARs might get this far and still not want checking. */
363         if (!(pdn->eeh_mode & EEH_MODE_SUPPORTED) ||
364             pdn->eeh_mode & EEH_MODE_NOCHECK) {
365                 ignored_check++;
366 #ifdef DEBUG
367                 printk ("EEH:ignored check (%x) for %s %s\n", 
368                         pdn->eeh_mode, pci_name (dev), dn->full_name);
369 #endif
370                 return 0;
371         }
372
373         if (!pdn->eeh_config_addr && !pdn->eeh_pe_config_addr) {
374                 no_cfg_addr++;
375                 return 0;
376         }
377
378         /* If we already have a pending isolation event for this
379          * slot, we know it's bad already, we don't need to check.
380          * Do this checking under a lock; as multiple PCI devices
381          * in one slot might report errors simultaneously, and we
382          * only want one error recovery routine running.
383          */
384         spin_lock_irqsave(&confirm_error_lock, flags);
385         rc = 1;
386         if (pdn->eeh_mode & EEH_MODE_ISOLATED) {
387                 pdn->eeh_check_count ++;
388                 if (pdn->eeh_check_count >= EEH_MAX_FAILS) {
389                         printk (KERN_ERR "EEH: Device driver ignored %d bad reads, panicing\n",
390                                 pdn->eeh_check_count);
391                         dump_stack();
392                         msleep(5000);
393                         
394                         /* re-read the slot reset state */
395                         if (read_slot_reset_state(pdn, rets) != 0)
396                                 rets[0] = -1;   /* reset state unknown */
397
398                         /* If we are here, then we hit an infinite loop. Stop. */
399                         panic("EEH: MMIO halt (%d) on device:%s\n", rets[0], pci_name(dev));
400                 }
401                 goto dn_unlock;
402         }
403
404         /*
405          * Now test for an EEH failure.  This is VERY expensive.
406          * Note that the eeh_config_addr may be a parent device
407          * in the case of a device behind a bridge, or it may be
408          * function zero of a multi-function device.
409          * In any case they must share a common PHB.
410          */
411         ret = read_slot_reset_state(pdn, rets);
412
413         /* If the call to firmware failed, punt */
414         if (ret != 0) {
415                 printk(KERN_WARNING "EEH: read_slot_reset_state() failed; rc=%d dn=%s\n",
416                        ret, dn->full_name);
417                 false_positives++;
418                 rc = 0;
419                 goto dn_unlock;
420         }
421
422         /* Note that config-io to empty slots may fail;
423          * they are empty when they don't have children. */
424         if ((rets[0] == 5) && (dn->child == NULL)) {
425                 false_positives++;
426                 rc = 0;
427                 goto dn_unlock;
428         }
429
430         /* If EEH is not supported on this device, punt. */
431         if (rets[1] != 1) {
432                 printk(KERN_WARNING "EEH: event on unsupported device, rc=%d dn=%s\n",
433                        ret, dn->full_name);
434                 false_positives++;
435                 rc = 0;
436                 goto dn_unlock;
437         }
438
439         /* If not the kind of error we know about, punt. */
440         if (rets[0] != 1 && rets[0] != 2 && rets[0] != 4 && rets[0] != 5) {
441                 false_positives++;
442                 rc = 0;
443                 goto dn_unlock;
444         }
445
446         slot_resets++;
447  
448         /* Avoid repeated reports of this failure, including problems
449          * with other functions on this device, and functions under
450          * bridges. */
451         eeh_mark_slot (dn, EEH_MODE_ISOLATED);
452         spin_unlock_irqrestore(&confirm_error_lock, flags);
453
454         eeh_send_failure_event (dn, dev);
455
456         /* Most EEH events are due to device driver bugs.  Having
457          * a stack trace will help the device-driver authors figure
458          * out what happened.  So print that out. */
459         dump_stack();
460         return 1;
461
462 dn_unlock:
463         spin_unlock_irqrestore(&confirm_error_lock, flags);
464         return rc;
465 }
466
467 EXPORT_SYMBOL_GPL(eeh_dn_check_failure);
468
469 /**
470  * eeh_check_failure - check if all 1's data is due to EEH slot freeze
471  * @token i/o token, should be address in the form 0xA....
472  * @val value, should be all 1's (XXX why do we need this arg??)
473  *
474  * Check for an EEH failure at the given token address.  Call this
475  * routine if the result of a read was all 0xff's and you want to
476  * find out if this is due to an EEH slot freeze event.  This routine
477  * will query firmware for the EEH status.
478  *
479  * Note this routine is safe to call in an interrupt context.
480  */
481 unsigned long eeh_check_failure(const volatile void __iomem *token, unsigned long val)
482 {
483         unsigned long addr;
484         struct pci_dev *dev;
485         struct device_node *dn;
486
487         /* Finding the phys addr + pci device; this is pretty quick. */
488         addr = eeh_token_to_phys((unsigned long __force) token);
489         dev = pci_get_device_by_addr(addr);
490         if (!dev) {
491                 no_device++;
492                 return val;
493         }
494
495         dn = pci_device_to_OF_node(dev);
496         eeh_dn_check_failure (dn, dev);
497
498         pci_dev_put(dev);
499         return val;
500 }
501
502 EXPORT_SYMBOL(eeh_check_failure);
503
504 /* ------------------------------------------------------------- */
505 /* The code below deals with error recovery */
506
507 /**
508  * rtas_pci_enable - enable MMIO or DMA transfers for this slot
509  * @pdn pci device node
510  */
511
512 int
513 rtas_pci_enable(struct pci_dn *pdn, int function)
514 {
515         int config_addr;
516         int rc;
517
518         /* Use PE configuration address, if present */
519         config_addr = pdn->eeh_config_addr;
520         if (pdn->eeh_pe_config_addr)
521                 config_addr = pdn->eeh_pe_config_addr;
522
523         rc = rtas_call(ibm_set_eeh_option, 4, 1, NULL,
524                        config_addr,
525                        BUID_HI(pdn->phb->buid),
526                        BUID_LO(pdn->phb->buid),
527                             function);
528
529         if (rc)
530                 printk(KERN_WARNING "EEH: Unexpected state change %d, err=%d dn=%s\n",
531                         function, rc, pdn->node->full_name);
532
533         rc = eeh_wait_for_slot_status (pdn, PCI_BUS_RESET_WAIT_MSEC);
534         if ((rc == 4) && (function == EEH_THAW_MMIO))
535                 return 0;
536
537         return rc;
538 }
539
540 /**
541  * rtas_pci_slot_reset - raises/lowers the pci #RST line
542  * @pdn pci device node
543  * @state: 1/0 to raise/lower the #RST
544  *
545  * Clear the EEH-frozen condition on a slot.  This routine
546  * asserts the PCI #RST line if the 'state' argument is '1',
547  * and drops the #RST line if 'state is '0'.  This routine is
548  * safe to call in an interrupt context.
549  *
550  */
551
552 static void
553 rtas_pci_slot_reset(struct pci_dn *pdn, int state)
554 {
555         int config_addr;
556         int rc;
557
558         BUG_ON (pdn==NULL); 
559
560         if (!pdn->phb) {
561                 printk (KERN_WARNING "EEH: in slot reset, device node %s has no phb\n",
562                         pdn->node->full_name);
563                 return;
564         }
565
566         /* Use PE configuration address, if present */
567         config_addr = pdn->eeh_config_addr;
568         if (pdn->eeh_pe_config_addr)
569                 config_addr = pdn->eeh_pe_config_addr;
570
571         rc = rtas_call(ibm_set_slot_reset,4,1, NULL,
572                        config_addr,
573                        BUID_HI(pdn->phb->buid),
574                        BUID_LO(pdn->phb->buid),
575                        state);
576         if (rc)
577                 printk (KERN_WARNING "EEH: Unable to reset the failed slot,"
578                         " (%d) #RST=%d dn=%s\n",
579                         rc, state, pdn->node->full_name);
580 }
581
582 /**
583  * pcibios_set_pcie_slot_reset - Set PCI-E reset state
584  * @dev:        pci device struct
585  * @state:      reset state to enter
586  *
587  * Return value:
588  *      0 if success
589  **/
590 int pcibios_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state)
591 {
592         struct device_node *dn = pci_device_to_OF_node(dev);
593         struct pci_dn *pdn = PCI_DN(dn);
594
595         switch (state) {
596         case pcie_deassert_reset:
597                 rtas_pci_slot_reset(pdn, 0);
598                 break;
599         case pcie_hot_reset:
600                 rtas_pci_slot_reset(pdn, 1);
601                 break;
602         case pcie_warm_reset:
603                 rtas_pci_slot_reset(pdn, 3);
604                 break;
605         default:
606                 return -EINVAL;
607         };
608
609         return 0;
610 }
611
612 /**
613  * rtas_set_slot_reset -- assert the pci #RST line for 1/4 second
614  * @pdn: pci device node to be reset.
615  *
616  *  Return 0 if success, else a non-zero value.
617  */
618
619 static void __rtas_set_slot_reset(struct pci_dn *pdn)
620 {
621         rtas_pci_slot_reset (pdn, 1);
622
623         /* The PCI bus requires that the reset be held high for at least
624          * a 100 milliseconds. We wait a bit longer 'just in case'.  */
625
626 #define PCI_BUS_RST_HOLD_TIME_MSEC 250
627         msleep (PCI_BUS_RST_HOLD_TIME_MSEC);
628         
629         /* We might get hit with another EEH freeze as soon as the 
630          * pci slot reset line is dropped. Make sure we don't miss
631          * these, and clear the flag now. */
632         eeh_clear_slot (pdn->node, EEH_MODE_ISOLATED);
633
634         rtas_pci_slot_reset (pdn, 0);
635
636         /* After a PCI slot has been reset, the PCI Express spec requires
637          * a 1.5 second idle time for the bus to stabilize, before starting
638          * up traffic. */
639 #define PCI_BUS_SETTLE_TIME_MSEC 1800
640         msleep (PCI_BUS_SETTLE_TIME_MSEC);
641 }
642
643 int rtas_set_slot_reset(struct pci_dn *pdn)
644 {
645         int i, rc;
646
647         /* Take three shots at resetting the bus */
648         for (i=0; i<3; i++) {
649                 __rtas_set_slot_reset(pdn);
650
651                 rc = eeh_wait_for_slot_status(pdn, PCI_BUS_RESET_WAIT_MSEC);
652                 if (rc == 0)
653                         return 0;
654
655                 if (rc < 0) {
656                         printk (KERN_ERR "EEH: unrecoverable slot failure %s\n",
657                                 pdn->node->full_name);
658                         return -1;
659                 }
660                 printk (KERN_ERR "EEH: bus reset %d failed on slot %s\n",
661                         i+1, pdn->node->full_name);
662         }
663
664         return -1;
665 }
666
667 /* ------------------------------------------------------- */
668 /** Save and restore of PCI BARs
669  *
670  * Although firmware will set up BARs during boot, it doesn't
671  * set up device BAR's after a device reset, although it will,
672  * if requested, set up bridge configuration. Thus, we need to
673  * configure the PCI devices ourselves.  
674  */
675
676 /**
677  * __restore_bars - Restore the Base Address Registers
678  * @pdn: pci device node
679  *
680  * Loads the PCI configuration space base address registers,
681  * the expansion ROM base address, the latency timer, and etc.
682  * from the saved values in the device node.
683  */
684 static inline void __restore_bars (struct pci_dn *pdn)
685 {
686         int i;
687
688         if (NULL==pdn->phb) return;
689         for (i=4; i<10; i++) {
690                 rtas_write_config(pdn, i*4, 4, pdn->config_space[i]);
691         }
692
693         /* 12 == Expansion ROM Address */
694         rtas_write_config(pdn, 12*4, 4, pdn->config_space[12]);
695
696 #define BYTE_SWAP(OFF) (8*((OFF)/4)+3-(OFF))
697 #define SAVED_BYTE(OFF) (((u8 *)(pdn->config_space))[BYTE_SWAP(OFF)])
698
699         rtas_write_config (pdn, PCI_CACHE_LINE_SIZE, 1,
700                     SAVED_BYTE(PCI_CACHE_LINE_SIZE));
701
702         rtas_write_config (pdn, PCI_LATENCY_TIMER, 1,
703                     SAVED_BYTE(PCI_LATENCY_TIMER));
704
705         /* max latency, min grant, interrupt pin and line */
706         rtas_write_config(pdn, 15*4, 4, pdn->config_space[15]);
707 }
708
709 /**
710  * eeh_restore_bars - restore the PCI config space info
711  *
712  * This routine performs a recursive walk to the children
713  * of this device as well.
714  */
715 void eeh_restore_bars(struct pci_dn *pdn)
716 {
717         struct device_node *dn;
718         if (!pdn) 
719                 return;
720         
721         if ((pdn->eeh_mode & EEH_MODE_SUPPORTED) && !IS_BRIDGE(pdn->class_code))
722                 __restore_bars (pdn);
723
724         dn = pdn->node->child;
725         while (dn) {
726                 eeh_restore_bars (PCI_DN(dn));
727                 dn = dn->sibling;
728         }
729 }
730
731 /**
732  * eeh_save_bars - save device bars
733  *
734  * Save the values of the device bars. Unlike the restore
735  * routine, this routine is *not* recursive. This is because
736  * PCI devices are added individuallly; but, for the restore,
737  * an entire slot is reset at a time.
738  */
739 static void eeh_save_bars(struct pci_dn *pdn)
740 {
741         int i;
742
743         if (!pdn )
744                 return;
745         
746         for (i = 0; i < 16; i++)
747                 rtas_read_config(pdn, i * 4, 4, &pdn->config_space[i]);
748 }
749
750 void
751 rtas_configure_bridge(struct pci_dn *pdn)
752 {
753         int config_addr;
754         int rc;
755
756         /* Use PE configuration address, if present */
757         config_addr = pdn->eeh_config_addr;
758         if (pdn->eeh_pe_config_addr)
759                 config_addr = pdn->eeh_pe_config_addr;
760
761         rc = rtas_call(ibm_configure_bridge,3,1, NULL,
762                        config_addr,
763                        BUID_HI(pdn->phb->buid),
764                        BUID_LO(pdn->phb->buid));
765         if (rc) {
766                 printk (KERN_WARNING "EEH: Unable to configure device bridge (%d) for %s\n",
767                         rc, pdn->node->full_name);
768         }
769 }
770
771 /* ------------------------------------------------------------- */
772 /* The code below deals with enabling EEH for devices during  the
773  * early boot sequence.  EEH must be enabled before any PCI probing
774  * can be done.
775  */
776
777 #define EEH_ENABLE 1
778
779 struct eeh_early_enable_info {
780         unsigned int buid_hi;
781         unsigned int buid_lo;
782 };
783
784 static int get_pe_addr (int config_addr,
785                         struct eeh_early_enable_info *info)
786 {
787         unsigned int rets[3];
788         int ret;
789
790         /* Use latest config-addr token on power6 */
791         if (ibm_get_config_addr_info2 != RTAS_UNKNOWN_SERVICE) {
792                 /* Make sure we have a PE in hand */
793                 ret = rtas_call (ibm_get_config_addr_info2, 4, 2, rets,
794                         config_addr, info->buid_hi, info->buid_lo, 1);
795                 if (ret || (rets[0]==0))
796                         return 0;
797
798                 ret = rtas_call (ibm_get_config_addr_info2, 4, 2, rets,
799                         config_addr, info->buid_hi, info->buid_lo, 0);
800                 if (ret)
801                         return 0;
802                 return rets[0];
803         }
804
805         /* Use older config-addr token on power5 */
806         if (ibm_get_config_addr_info != RTAS_UNKNOWN_SERVICE) {
807                 ret = rtas_call (ibm_get_config_addr_info, 4, 2, rets,
808                         config_addr, info->buid_hi, info->buid_lo, 0);
809                 if (ret)
810                         return 0;
811                 return rets[0];
812         }
813         return 0;
814 }
815
816 /* Enable eeh for the given device node. */
817 static void *early_enable_eeh(struct device_node *dn, void *data)
818 {
819         unsigned int rets[3];
820         struct eeh_early_enable_info *info = data;
821         int ret;
822         const char *status = of_get_property(dn, "status", NULL);
823         const u32 *class_code = of_get_property(dn, "class-code", NULL);
824         const u32 *vendor_id = of_get_property(dn, "vendor-id", NULL);
825         const u32 *device_id = of_get_property(dn, "device-id", NULL);
826         const u32 *regs;
827         int enable;
828         struct pci_dn *pdn = PCI_DN(dn);
829
830         pdn->class_code = 0;
831         pdn->eeh_mode = 0;
832         pdn->eeh_check_count = 0;
833         pdn->eeh_freeze_count = 0;
834
835         if (status && strcmp(status, "ok") != 0)
836                 return NULL;    /* ignore devices with bad status */
837
838         /* Ignore bad nodes. */
839         if (!class_code || !vendor_id || !device_id)
840                 return NULL;
841
842         /* There is nothing to check on PCI to ISA bridges */
843         if (dn->type && !strcmp(dn->type, "isa")) {
844                 pdn->eeh_mode |= EEH_MODE_NOCHECK;
845                 return NULL;
846         }
847         pdn->class_code = *class_code;
848
849         /*
850          * Now decide if we are going to "Disable" EEH checking
851          * for this device.  We still run with the EEH hardware active,
852          * but we won't be checking for ff's.  This means a driver
853          * could return bad data (very bad!), an interrupt handler could
854          * hang waiting on status bits that won't change, etc.
855          * But there are a few cases like display devices that make sense.
856          */
857         enable = 1;     /* i.e. we will do checking */
858 #if 0
859         if ((*class_code >> 16) == PCI_BASE_CLASS_DISPLAY)
860                 enable = 0;
861 #endif
862
863         if (!enable)
864                 pdn->eeh_mode |= EEH_MODE_NOCHECK;
865
866         /* Ok... see if this device supports EEH.  Some do, some don't,
867          * and the only way to find out is to check each and every one. */
868         regs = of_get_property(dn, "reg", NULL);
869         if (regs) {
870                 /* First register entry is addr (00BBSS00)  */
871                 /* Try to enable eeh */
872                 ret = rtas_call(ibm_set_eeh_option, 4, 1, NULL,
873                                 regs[0], info->buid_hi, info->buid_lo,
874                                 EEH_ENABLE);
875
876                 enable = 0;
877                 if (ret == 0) {
878                         pdn->eeh_config_addr = regs[0];
879
880                         /* If the newer, better, ibm,get-config-addr-info is supported, 
881                          * then use that instead. */
882                         pdn->eeh_pe_config_addr = get_pe_addr(pdn->eeh_config_addr, info);
883
884                         /* Some older systems (Power4) allow the
885                          * ibm,set-eeh-option call to succeed even on nodes
886                          * where EEH is not supported. Verify support
887                          * explicitly. */
888                         ret = read_slot_reset_state(pdn, rets);
889                         if ((ret == 0) && (rets[1] == 1))
890                                 enable = 1;
891                 }
892
893                 if (enable) {
894                         eeh_subsystem_enabled = 1;
895                         pdn->eeh_mode |= EEH_MODE_SUPPORTED;
896
897 #ifdef DEBUG
898                         printk(KERN_DEBUG "EEH: %s: eeh enabled, config=%x pe_config=%x\n",
899                                dn->full_name, pdn->eeh_config_addr, pdn->eeh_pe_config_addr);
900 #endif
901                 } else {
902
903                         /* This device doesn't support EEH, but it may have an
904                          * EEH parent, in which case we mark it as supported. */
905                         if (dn->parent && PCI_DN(dn->parent)
906                             && (PCI_DN(dn->parent)->eeh_mode & EEH_MODE_SUPPORTED)) {
907                                 /* Parent supports EEH. */
908                                 pdn->eeh_mode |= EEH_MODE_SUPPORTED;
909                                 pdn->eeh_config_addr = PCI_DN(dn->parent)->eeh_config_addr;
910                                 return NULL;
911                         }
912                 }
913         } else {
914                 printk(KERN_WARNING "EEH: %s: unable to get reg property.\n",
915                        dn->full_name);
916         }
917
918         eeh_save_bars(pdn);
919         return NULL;
920 }
921
922 /*
923  * Initialize EEH by trying to enable it for all of the adapters in the system.
924  * As a side effect we can determine here if eeh is supported at all.
925  * Note that we leave EEH on so failed config cycles won't cause a machine
926  * check.  If a user turns off EEH for a particular adapter they are really
927  * telling Linux to ignore errors.  Some hardware (e.g. POWER5) won't
928  * grant access to a slot if EEH isn't enabled, and so we always enable
929  * EEH for all slots/all devices.
930  *
931  * The eeh-force-off option disables EEH checking globally, for all slots.
932  * Even if force-off is set, the EEH hardware is still enabled, so that
933  * newer systems can boot.
934  */
935 void __init eeh_init(void)
936 {
937         struct device_node *phb, *np;
938         struct eeh_early_enable_info info;
939
940         spin_lock_init(&confirm_error_lock);
941         spin_lock_init(&slot_errbuf_lock);
942
943         np = of_find_node_by_path("/rtas");
944         if (np == NULL)
945                 return;
946
947         ibm_set_eeh_option = rtas_token("ibm,set-eeh-option");
948         ibm_set_slot_reset = rtas_token("ibm,set-slot-reset");
949         ibm_read_slot_reset_state2 = rtas_token("ibm,read-slot-reset-state2");
950         ibm_read_slot_reset_state = rtas_token("ibm,read-slot-reset-state");
951         ibm_slot_error_detail = rtas_token("ibm,slot-error-detail");
952         ibm_get_config_addr_info = rtas_token("ibm,get-config-addr-info");
953         ibm_get_config_addr_info2 = rtas_token("ibm,get-config-addr-info2");
954         ibm_configure_bridge = rtas_token ("ibm,configure-bridge");
955
956         if (ibm_set_eeh_option == RTAS_UNKNOWN_SERVICE)
957                 return;
958
959         eeh_error_buf_size = rtas_token("rtas-error-log-max");
960         if (eeh_error_buf_size == RTAS_UNKNOWN_SERVICE) {
961                 eeh_error_buf_size = 1024;
962         }
963         if (eeh_error_buf_size > RTAS_ERROR_LOG_MAX) {
964                 printk(KERN_WARNING "EEH: rtas-error-log-max is bigger than allocated "
965                       "buffer ! (%d vs %d)", eeh_error_buf_size, RTAS_ERROR_LOG_MAX);
966                 eeh_error_buf_size = RTAS_ERROR_LOG_MAX;
967         }
968
969         /* Enable EEH for all adapters.  Note that eeh requires buid's */
970         for (phb = of_find_node_by_name(NULL, "pci"); phb;
971              phb = of_find_node_by_name(phb, "pci")) {
972                 unsigned long buid;
973
974                 buid = get_phb_buid(phb);
975                 if (buid == 0 || PCI_DN(phb) == NULL)
976                         continue;
977
978                 info.buid_lo = BUID_LO(buid);
979                 info.buid_hi = BUID_HI(buid);
980                 traverse_pci_devices(phb, early_enable_eeh, &info);
981         }
982
983         if (eeh_subsystem_enabled)
984                 printk(KERN_INFO "EEH: PCI Enhanced I/O Error Handling Enabled\n");
985         else
986                 printk(KERN_WARNING "EEH: No capable adapters found\n");
987 }
988
989 /**
990  * eeh_add_device_early - enable EEH for the indicated device_node
991  * @dn: device node for which to set up EEH
992  *
993  * This routine must be used to perform EEH initialization for PCI
994  * devices that were added after system boot (e.g. hotplug, dlpar).
995  * This routine must be called before any i/o is performed to the
996  * adapter (inluding any config-space i/o).
997  * Whether this actually enables EEH or not for this device depends
998  * on the CEC architecture, type of the device, on earlier boot
999  * command-line arguments & etc.
1000  */
1001 static void eeh_add_device_early(struct device_node *dn)
1002 {
1003         struct pci_controller *phb;
1004         struct eeh_early_enable_info info;
1005
1006         if (!dn || !PCI_DN(dn))
1007                 return;
1008         phb = PCI_DN(dn)->phb;
1009
1010         /* USB Bus children of PCI devices will not have BUID's */
1011         if (NULL == phb || 0 == phb->buid)
1012                 return;
1013
1014         info.buid_hi = BUID_HI(phb->buid);
1015         info.buid_lo = BUID_LO(phb->buid);
1016         early_enable_eeh(dn, &info);
1017 }
1018
1019 void eeh_add_device_tree_early(struct device_node *dn)
1020 {
1021         struct device_node *sib;
1022         for (sib = dn->child; sib; sib = sib->sibling)
1023                 eeh_add_device_tree_early(sib);
1024         eeh_add_device_early(dn);
1025 }
1026 EXPORT_SYMBOL_GPL(eeh_add_device_tree_early);
1027
1028 /**
1029  * eeh_add_device_late - perform EEH initialization for the indicated pci device
1030  * @dev: pci device for which to set up EEH
1031  *
1032  * This routine must be used to complete EEH initialization for PCI
1033  * devices that were added after system boot (e.g. hotplug, dlpar).
1034  */
1035 static void eeh_add_device_late(struct pci_dev *dev)
1036 {
1037         struct device_node *dn;
1038         struct pci_dn *pdn;
1039
1040         if (!dev || !eeh_subsystem_enabled)
1041                 return;
1042
1043 #ifdef DEBUG
1044         printk(KERN_DEBUG "EEH: adding device %s\n", pci_name(dev));
1045 #endif
1046
1047         pci_dev_get (dev);
1048         dn = pci_device_to_OF_node(dev);
1049         pdn = PCI_DN(dn);
1050         pdn->pcidev = dev;
1051
1052         pci_addr_cache_insert_device (dev);
1053 }
1054
1055 void eeh_add_device_tree_late(struct pci_bus *bus)
1056 {
1057         struct pci_dev *dev;
1058
1059         list_for_each_entry(dev, &bus->devices, bus_list) {
1060                 eeh_add_device_late(dev);
1061                 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
1062                         struct pci_bus *subbus = dev->subordinate;
1063                         if (subbus)
1064                                 eeh_add_device_tree_late(subbus);
1065                 }
1066         }
1067 }
1068 EXPORT_SYMBOL_GPL(eeh_add_device_tree_late);
1069
1070 /**
1071  * eeh_remove_device - undo EEH setup for the indicated pci device
1072  * @dev: pci device to be removed
1073  *
1074  * This routine should be called when a device is removed from
1075  * a running system (e.g. by hotplug or dlpar).  It unregisters
1076  * the PCI device from the EEH subsystem.  I/O errors affecting
1077  * this device will no longer be detected after this call; thus,
1078  * i/o errors affecting this slot may leave this device unusable.
1079  */
1080 static void eeh_remove_device(struct pci_dev *dev)
1081 {
1082         struct device_node *dn;
1083         if (!dev || !eeh_subsystem_enabled)
1084                 return;
1085
1086         /* Unregister the device with the EEH/PCI address search system */
1087 #ifdef DEBUG
1088         printk(KERN_DEBUG "EEH: remove device %s\n", pci_name(dev));
1089 #endif
1090         pci_addr_cache_remove_device(dev);
1091
1092         dn = pci_device_to_OF_node(dev);
1093         if (PCI_DN(dn)->pcidev) {
1094                 PCI_DN(dn)->pcidev = NULL;
1095                 pci_dev_put (dev);
1096         }
1097 }
1098
1099 void eeh_remove_bus_device(struct pci_dev *dev)
1100 {
1101         struct pci_bus *bus = dev->subordinate;
1102         struct pci_dev *child, *tmp;
1103
1104         eeh_remove_device(dev);
1105
1106         if (bus && dev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
1107                 list_for_each_entry_safe(child, tmp, &bus->devices, bus_list)
1108                          eeh_remove_bus_device(child);
1109         }
1110 }
1111 EXPORT_SYMBOL_GPL(eeh_remove_bus_device);
1112
1113 static int proc_eeh_show(struct seq_file *m, void *v)
1114 {
1115         if (0 == eeh_subsystem_enabled) {
1116                 seq_printf(m, "EEH Subsystem is globally disabled\n");
1117                 seq_printf(m, "eeh_total_mmio_ffs=%ld\n", total_mmio_ffs);
1118         } else {
1119                 seq_printf(m, "EEH Subsystem is enabled\n");
1120                 seq_printf(m,
1121                                 "no device=%ld\n"
1122                                 "no device node=%ld\n"
1123                                 "no config address=%ld\n"
1124                                 "check not wanted=%ld\n"
1125                                 "eeh_total_mmio_ffs=%ld\n"
1126                                 "eeh_false_positives=%ld\n"
1127                                 "eeh_ignored_failures=%ld\n"
1128                                 "eeh_slot_resets=%ld\n",
1129                                 no_device, no_dn, no_cfg_addr, 
1130                                 ignored_check, total_mmio_ffs, 
1131                                 false_positives, ignored_failures, 
1132                                 slot_resets);
1133         }
1134
1135         return 0;
1136 }
1137
1138 static int proc_eeh_open(struct inode *inode, struct file *file)
1139 {
1140         return single_open(file, proc_eeh_show, NULL);
1141 }
1142
1143 static const struct file_operations proc_eeh_operations = {
1144         .open      = proc_eeh_open,
1145         .read      = seq_read,
1146         .llseek    = seq_lseek,
1147         .release   = single_release,
1148 };
1149
1150 static int __init eeh_init_proc(void)
1151 {
1152         struct proc_dir_entry *e;
1153
1154         if (machine_is(pseries)) {
1155                 e = create_proc_entry("ppc64/eeh", 0, NULL);
1156                 if (e)
1157                         e->proc_fops = &proc_eeh_operations;
1158         }
1159
1160         return 0;
1161 }
1162 __initcall(eeh_init_proc);