2 * The file intends to implement the platform dependent EEH operations on pseries.
3 * Actually, the pseries platform is built based on RTAS heavily. That means the
4 * pseries platform dependent EEH operations will be built on RTAS calls. The functions
5 * are devired from arch/powerpc/platforms/pseries/eeh.c and necessary cleanup has
8 * Copyright Benjamin Herrenschmidt & Gavin Shan, IBM Corporation 2011.
9 * Copyright IBM Corporation 2001, 2005, 2006
10 * Copyright Dave Engebretsen & Todd Inglett 2001
11 * Copyright Linas Vepstas 2005, 2006
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <linux/atomic.h>
29 #include <linux/delay.h>
30 #include <linux/export.h>
31 #include <linux/init.h>
32 #include <linux/list.h>
34 #include <linux/pci.h>
35 #include <linux/proc_fs.h>
36 #include <linux/rbtree.h>
37 #include <linux/sched.h>
38 #include <linux/seq_file.h>
39 #include <linux/spinlock.h>
42 #include <asm/eeh_event.h>
44 #include <asm/machdep.h>
45 #include <asm/ppc-pci.h>
49 static int ibm_set_eeh_option;
50 static int ibm_set_slot_reset;
51 static int ibm_read_slot_reset_state;
52 static int ibm_read_slot_reset_state2;
53 static int ibm_slot_error_detail;
54 static int ibm_get_config_addr_info;
55 static int ibm_get_config_addr_info2;
56 static int ibm_configure_bridge;
57 static int ibm_configure_pe;
60 * Buffer for reporting slot-error-detail rtas calls. Its here
61 * in BSS, and not dynamically alloced, so that it ends up in
62 * RMO where RTAS can access it.
64 static unsigned char slot_errbuf[RTAS_ERROR_LOG_MAX];
65 static DEFINE_SPINLOCK(slot_errbuf_lock);
66 static int eeh_error_buf_size;
69 * pseries_eeh_init - EEH platform dependent initialization
71 * EEH platform dependent initialization on pseries.
73 static int pseries_eeh_init(void)
75 /* figure out EEH RTAS function call tokens */
76 ibm_set_eeh_option = rtas_token("ibm,set-eeh-option");
77 ibm_set_slot_reset = rtas_token("ibm,set-slot-reset");
78 ibm_read_slot_reset_state2 = rtas_token("ibm,read-slot-reset-state2");
79 ibm_read_slot_reset_state = rtas_token("ibm,read-slot-reset-state");
80 ibm_slot_error_detail = rtas_token("ibm,slot-error-detail");
81 ibm_get_config_addr_info2 = rtas_token("ibm,get-config-addr-info2");
82 ibm_get_config_addr_info = rtas_token("ibm,get-config-addr-info");
83 ibm_configure_pe = rtas_token("ibm,configure-pe");
84 ibm_configure_bridge = rtas_token("ibm,configure-bridge");
87 * Necessary sanity check. We needn't check "get-config-addr-info"
88 * and its variant since the old firmware probably support address
89 * of domain/bus/slot/function for EEH RTAS operations.
91 if (ibm_set_eeh_option == RTAS_UNKNOWN_SERVICE) {
92 pr_warn("%s: RTAS service <ibm,set-eeh-option> invalid\n",
95 } else if (ibm_set_slot_reset == RTAS_UNKNOWN_SERVICE) {
96 pr_warn("%s: RTAS service <ibm,set-slot-reset> invalid\n",
99 } else if (ibm_read_slot_reset_state2 == RTAS_UNKNOWN_SERVICE &&
100 ibm_read_slot_reset_state == RTAS_UNKNOWN_SERVICE) {
101 pr_warn("%s: RTAS service <ibm,read-slot-reset-state2> and "
102 "<ibm,read-slot-reset-state> invalid\n",
105 } else if (ibm_slot_error_detail == RTAS_UNKNOWN_SERVICE) {
106 pr_warn("%s: RTAS service <ibm,slot-error-detail> invalid\n",
109 } else if (ibm_configure_pe == RTAS_UNKNOWN_SERVICE &&
110 ibm_configure_bridge == RTAS_UNKNOWN_SERVICE) {
111 pr_warn("%s: RTAS service <ibm,configure-pe> and "
112 "<ibm,configure-bridge> invalid\n",
117 /* Initialize error log lock and size */
118 spin_lock_init(&slot_errbuf_lock);
119 eeh_error_buf_size = rtas_token("rtas-error-log-max");
120 if (eeh_error_buf_size == RTAS_UNKNOWN_SERVICE) {
121 pr_warn("%s: unknown EEH error log size\n",
123 eeh_error_buf_size = 1024;
124 } else if (eeh_error_buf_size > RTAS_ERROR_LOG_MAX) {
125 pr_warn("%s: EEH error log size %d exceeds the maximal %d\n",
126 __func__, eeh_error_buf_size, RTAS_ERROR_LOG_MAX);
127 eeh_error_buf_size = RTAS_ERROR_LOG_MAX;
130 /* Set EEH probe mode */
131 eeh_add_flag(EEH_PROBE_MODE_DEVTREE | EEH_ENABLE_IO_FOR_LOG);
136 static int pseries_eeh_cap_start(struct device_node *dn)
138 struct pci_dn *pdn = PCI_DN(dn);
144 rtas_read_config(pdn, PCI_STATUS, 2, &status);
145 if (!(status & PCI_STATUS_CAP_LIST))
148 return PCI_CAPABILITY_LIST;
152 static int pseries_eeh_find_cap(struct device_node *dn, int cap)
154 struct pci_dn *pdn = PCI_DN(dn);
155 int pos = pseries_eeh_cap_start(dn);
156 int cnt = 48; /* Maximal number of capabilities */
163 rtas_read_config(pdn, pos, 1, &pos);
167 rtas_read_config(pdn, pos + PCI_CAP_LIST_ID, 1, &id);
172 pos += PCI_CAP_LIST_NEXT;
178 static int pseries_eeh_find_ecap(struct device_node *dn, int cap)
180 struct pci_dn *pdn = PCI_DN(dn);
181 struct eeh_dev *edev = of_node_to_eeh_dev(dn);
184 int ttl = (4096 - 256) / 8;
186 if (!edev || !edev->pcie_cap)
188 if (rtas_read_config(pdn, pos, 4, &header) != PCIBIOS_SUCCESSFUL)
194 if (PCI_EXT_CAP_ID(header) == cap && pos)
197 pos = PCI_EXT_CAP_NEXT(header);
201 if (rtas_read_config(pdn, pos, 4, &header) != PCIBIOS_SUCCESSFUL)
209 * pseries_eeh_of_probe - EEH probe on the given device
213 * When EEH module is installed during system boot, all PCI devices
214 * are checked one by one to see if it supports EEH. The function
215 * is introduced for the purpose.
217 static void *pseries_eeh_of_probe(struct device_node *dn, void *flag)
219 struct eeh_dev *edev;
221 struct pci_dn *pdn = PCI_DN(dn);
222 const __be32 *classp, *vendorp, *devicep;
229 /* Retrieve OF node and eeh device */
230 edev = of_node_to_eeh_dev(dn);
231 if (edev->pe || !of_device_is_available(dn))
234 /* Retrieve class/vendor/device IDs */
235 classp = of_get_property(dn, "class-code", NULL);
236 vendorp = of_get_property(dn, "vendor-id", NULL);
237 devicep = of_get_property(dn, "device-id", NULL);
239 /* Skip for bad OF node or PCI-ISA bridge */
240 if (!classp || !vendorp || !devicep)
242 if (dn->type && !strcmp(dn->type, "isa"))
245 class_code = of_read_number(classp, 1);
248 * Update class code and mode of eeh device. We need
249 * correctly reflects that current device is root port
250 * or PCIe switch downstream port.
252 edev->class_code = class_code;
253 edev->pcix_cap = pseries_eeh_find_cap(dn, PCI_CAP_ID_PCIX);
254 edev->pcie_cap = pseries_eeh_find_cap(dn, PCI_CAP_ID_EXP);
255 edev->aer_cap = pseries_eeh_find_ecap(dn, PCI_EXT_CAP_ID_ERR);
256 edev->mode &= 0xFFFFFF00;
257 if ((edev->class_code >> 8) == PCI_CLASS_BRIDGE_PCI) {
258 edev->mode |= EEH_DEV_BRIDGE;
259 if (edev->pcie_cap) {
260 rtas_read_config(pdn, edev->pcie_cap + PCI_EXP_FLAGS,
262 pcie_flags = (pcie_flags & PCI_EXP_FLAGS_TYPE) >> 4;
263 if (pcie_flags == PCI_EXP_TYPE_ROOT_PORT)
264 edev->mode |= EEH_DEV_ROOT_PORT;
265 else if (pcie_flags == PCI_EXP_TYPE_DOWNSTREAM)
266 edev->mode |= EEH_DEV_DS_PORT;
270 /* Retrieve the device address */
271 regs = of_get_property(dn, "reg", NULL);
273 pr_warn("%s: OF node property %s::reg not found\n",
274 __func__, dn->full_name);
278 /* Initialize the fake PE */
279 memset(&pe, 0, sizeof(struct eeh_pe));
281 pe.config_addr = of_read_number(regs, 1);
283 /* Enable EEH on the device */
284 ret = eeh_ops->set_option(&pe, EEH_OPT_ENABLE);
286 edev->config_addr = of_read_number(regs, 1);
287 /* Retrieve PE address */
288 edev->pe_config_addr = eeh_ops->get_pe_addr(&pe);
289 pe.addr = edev->pe_config_addr;
291 /* Some older systems (Power4) allow the ibm,set-eeh-option
292 * call to succeed even on nodes where EEH is not supported.
293 * Verify support explicitly.
295 ret = eeh_ops->get_state(&pe, NULL);
296 if (ret > 0 && ret != EEH_STATE_NOT_SUPPORT)
300 eeh_add_flag(EEH_ENABLED);
301 eeh_add_to_parent_pe(edev);
303 pr_debug("%s: EEH enabled on %s PHB#%d-PE#%x, config addr#%x\n",
304 __func__, dn->full_name, pe.phb->global_number,
305 pe.addr, pe.config_addr);
306 } else if (dn->parent && of_node_to_eeh_dev(dn->parent) &&
307 (of_node_to_eeh_dev(dn->parent))->pe) {
308 /* This device doesn't support EEH, but it may have an
309 * EEH parent, in which case we mark it as supported.
311 edev->config_addr = of_node_to_eeh_dev(dn->parent)->config_addr;
312 edev->pe_config_addr = of_node_to_eeh_dev(dn->parent)->pe_config_addr;
313 eeh_add_to_parent_pe(edev);
317 /* Save memory bars */
324 * pseries_eeh_set_option - Initialize EEH or MMIO/DMA reenable
326 * @option: operation to be issued
328 * The function is used to control the EEH functionality globally.
329 * Currently, following options are support according to PAPR:
330 * Enable EEH, Disable EEH, Enable MMIO and Enable DMA
332 static int pseries_eeh_set_option(struct eeh_pe *pe, int option)
338 * When we're enabling or disabling EEH functioality on
339 * the particular PE, the PE config address is possibly
340 * unavailable. Therefore, we have to figure it out from
344 case EEH_OPT_DISABLE:
346 case EEH_OPT_THAW_MMIO:
347 case EEH_OPT_THAW_DMA:
348 config_addr = pe->config_addr;
350 config_addr = pe->addr;
352 case EEH_OPT_FREEZE_PE:
356 pr_err("%s: Invalid option %d\n",
361 ret = rtas_call(ibm_set_eeh_option, 4, 1, NULL,
362 config_addr, BUID_HI(pe->phb->buid),
363 BUID_LO(pe->phb->buid), option);
369 * pseries_eeh_get_pe_addr - Retrieve PE address
372 * Retrieve the assocated PE address. Actually, there're 2 RTAS
373 * function calls dedicated for the purpose. We need implement
374 * it through the new function and then the old one. Besides,
375 * you should make sure the config address is figured out from
376 * FDT node before calling the function.
378 * It's notable that zero'ed return value means invalid PE config
381 static int pseries_eeh_get_pe_addr(struct eeh_pe *pe)
386 if (ibm_get_config_addr_info2 != RTAS_UNKNOWN_SERVICE) {
388 * First of all, we need to make sure there has one PE
389 * associated with the device. Otherwise, PE address is
392 ret = rtas_call(ibm_get_config_addr_info2, 4, 2, rets,
393 pe->config_addr, BUID_HI(pe->phb->buid),
394 BUID_LO(pe->phb->buid), 1);
395 if (ret || (rets[0] == 0))
398 /* Retrieve the associated PE config address */
399 ret = rtas_call(ibm_get_config_addr_info2, 4, 2, rets,
400 pe->config_addr, BUID_HI(pe->phb->buid),
401 BUID_LO(pe->phb->buid), 0);
403 pr_warn("%s: Failed to get address for PHB#%d-PE#%x\n",
404 __func__, pe->phb->global_number, pe->config_addr);
411 if (ibm_get_config_addr_info != RTAS_UNKNOWN_SERVICE) {
412 ret = rtas_call(ibm_get_config_addr_info, 4, 2, rets,
413 pe->config_addr, BUID_HI(pe->phb->buid),
414 BUID_LO(pe->phb->buid), 0);
416 pr_warn("%s: Failed to get address for PHB#%d-PE#%x\n",
417 __func__, pe->phb->global_number, pe->config_addr);
428 * pseries_eeh_get_state - Retrieve PE state
430 * @state: return value
432 * Retrieve the state of the specified PE. On RTAS compliant
433 * pseries platform, there already has one dedicated RTAS function
434 * for the purpose. It's notable that the associated PE config address
435 * might be ready when calling the function. Therefore, endeavour to
436 * use the PE config address if possible. Further more, there're 2
437 * RTAS calls for the purpose, we need to try the new one and back
438 * to the old one if the new one couldn't work properly.
440 static int pseries_eeh_get_state(struct eeh_pe *pe, int *state)
447 /* Figure out PE config address if possible */
448 config_addr = pe->config_addr;
450 config_addr = pe->addr;
452 if (ibm_read_slot_reset_state2 != RTAS_UNKNOWN_SERVICE) {
453 ret = rtas_call(ibm_read_slot_reset_state2, 3, 4, rets,
454 config_addr, BUID_HI(pe->phb->buid),
455 BUID_LO(pe->phb->buid));
456 } else if (ibm_read_slot_reset_state != RTAS_UNKNOWN_SERVICE) {
457 /* Fake PE unavailable info */
459 ret = rtas_call(ibm_read_slot_reset_state, 3, 3, rets,
460 config_addr, BUID_HI(pe->phb->buid),
461 BUID_LO(pe->phb->buid));
463 return EEH_STATE_NOT_SUPPORT;
469 /* Parse the result out */
474 result &= ~EEH_STATE_RESET_ACTIVE;
475 result |= EEH_STATE_MMIO_ACTIVE;
476 result |= EEH_STATE_DMA_ACTIVE;
479 result |= EEH_STATE_RESET_ACTIVE;
480 result |= EEH_STATE_MMIO_ACTIVE;
481 result |= EEH_STATE_DMA_ACTIVE;
484 result &= ~EEH_STATE_RESET_ACTIVE;
485 result &= ~EEH_STATE_MMIO_ACTIVE;
486 result &= ~EEH_STATE_DMA_ACTIVE;
489 result &= ~EEH_STATE_RESET_ACTIVE;
490 result &= ~EEH_STATE_MMIO_ACTIVE;
491 result &= ~EEH_STATE_DMA_ACTIVE;
492 result |= EEH_STATE_MMIO_ENABLED;
496 if (state) *state = rets[2];
497 result = EEH_STATE_UNAVAILABLE;
499 result = EEH_STATE_NOT_SUPPORT;
503 result = EEH_STATE_NOT_SUPPORT;
506 result = EEH_STATE_NOT_SUPPORT;
513 * pseries_eeh_reset - Reset the specified PE
515 * @option: reset option
517 * Reset the specified PE
519 static int pseries_eeh_reset(struct eeh_pe *pe, int option)
524 /* Figure out PE address */
525 config_addr = pe->config_addr;
527 config_addr = pe->addr;
529 /* Reset PE through RTAS call */
530 ret = rtas_call(ibm_set_slot_reset, 4, 1, NULL,
531 config_addr, BUID_HI(pe->phb->buid),
532 BUID_LO(pe->phb->buid), option);
534 /* If fundamental-reset not supported, try hot-reset */
535 if (option == EEH_RESET_FUNDAMENTAL &&
537 option = EEH_RESET_HOT;
538 ret = rtas_call(ibm_set_slot_reset, 4, 1, NULL,
539 config_addr, BUID_HI(pe->phb->buid),
540 BUID_LO(pe->phb->buid), option);
543 /* We need reset hold or settlement delay */
544 if (option == EEH_RESET_FUNDAMENTAL ||
545 option == EEH_RESET_HOT)
546 msleep(EEH_PE_RST_HOLD_TIME);
548 msleep(EEH_PE_RST_SETTLE_TIME);
554 * pseries_eeh_wait_state - Wait for PE state
556 * @max_wait: maximal period in microsecond
558 * Wait for the state of associated PE. It might take some time
559 * to retrieve the PE's state.
561 static int pseries_eeh_wait_state(struct eeh_pe *pe, int max_wait)
567 * According to PAPR, the state of PE might be temporarily
568 * unavailable. Under the circumstance, we have to wait
569 * for indicated time determined by firmware. The maximal
570 * wait time is 5 minutes, which is acquired from the original
571 * EEH implementation. Also, the original implementation
572 * also defined the minimal wait time as 1 second.
574 #define EEH_STATE_MIN_WAIT_TIME (1000)
575 #define EEH_STATE_MAX_WAIT_TIME (300 * 1000)
578 ret = pseries_eeh_get_state(pe, &mwait);
581 * If the PE's state is temporarily unavailable,
582 * we have to wait for the specified time. Otherwise,
583 * the PE's state will be returned immediately.
585 if (ret != EEH_STATE_UNAVAILABLE)
589 pr_warn("%s: Timeout when getting PE's state (%d)\n",
591 return EEH_STATE_NOT_SUPPORT;
595 pr_warn("%s: Firmware returned bad wait value %d\n",
597 mwait = EEH_STATE_MIN_WAIT_TIME;
598 } else if (mwait > EEH_STATE_MAX_WAIT_TIME) {
599 pr_warn("%s: Firmware returned too long wait value %d\n",
601 mwait = EEH_STATE_MAX_WAIT_TIME;
608 return EEH_STATE_NOT_SUPPORT;
612 * pseries_eeh_get_log - Retrieve error log
614 * @severity: temporary or permanent error log
615 * @drv_log: driver log to be combined with retrieved error log
616 * @len: length of driver log
618 * Retrieve the temporary or permanent error from the PE.
619 * Actually, the error will be retrieved through the dedicated
622 static int pseries_eeh_get_log(struct eeh_pe *pe, int severity, char *drv_log, unsigned long len)
628 spin_lock_irqsave(&slot_errbuf_lock, flags);
629 memset(slot_errbuf, 0, eeh_error_buf_size);
631 /* Figure out the PE address */
632 config_addr = pe->config_addr;
634 config_addr = pe->addr;
636 ret = rtas_call(ibm_slot_error_detail, 8, 1, NULL, config_addr,
637 BUID_HI(pe->phb->buid), BUID_LO(pe->phb->buid),
638 virt_to_phys(drv_log), len,
639 virt_to_phys(slot_errbuf), eeh_error_buf_size,
642 log_error(slot_errbuf, ERR_TYPE_RTAS_LOG, 0);
643 spin_unlock_irqrestore(&slot_errbuf_lock, flags);
649 * pseries_eeh_configure_bridge - Configure PCI bridges in the indicated PE
652 * The function will be called to reconfigure the bridges included
653 * in the specified PE so that the mulfunctional PE would be recovered
656 static int pseries_eeh_configure_bridge(struct eeh_pe *pe)
661 /* Figure out the PE address */
662 config_addr = pe->config_addr;
664 config_addr = pe->addr;
666 /* Use new configure-pe function, if supported */
667 if (ibm_configure_pe != RTAS_UNKNOWN_SERVICE) {
668 ret = rtas_call(ibm_configure_pe, 3, 1, NULL,
669 config_addr, BUID_HI(pe->phb->buid),
670 BUID_LO(pe->phb->buid));
671 } else if (ibm_configure_bridge != RTAS_UNKNOWN_SERVICE) {
672 ret = rtas_call(ibm_configure_bridge, 3, 1, NULL,
673 config_addr, BUID_HI(pe->phb->buid),
674 BUID_LO(pe->phb->buid));
680 pr_warn("%s: Unable to configure bridge PHB#%d-PE#%x (%d)\n",
681 __func__, pe->phb->global_number, pe->addr, ret);
687 * pseries_eeh_read_config - Read PCI config space
689 * @where: PCI address
690 * @size: size to read
693 * Read config space from the speicifed device
695 static int pseries_eeh_read_config(struct device_node *dn, int where, int size, u32 *val)
701 return rtas_read_config(pdn, where, size, val);
705 * pseries_eeh_write_config - Write PCI config space
707 * @where: PCI address
708 * @size: size to write
709 * @val: value to be written
711 * Write config space to the specified device
713 static int pseries_eeh_write_config(struct device_node *dn, int where, int size, u32 val)
719 return rtas_write_config(pdn, where, size, val);
722 static struct eeh_ops pseries_eeh_ops = {
724 .init = pseries_eeh_init,
725 .of_probe = pseries_eeh_of_probe,
727 .set_option = pseries_eeh_set_option,
728 .get_pe_addr = pseries_eeh_get_pe_addr,
729 .get_state = pseries_eeh_get_state,
730 .reset = pseries_eeh_reset,
731 .wait_state = pseries_eeh_wait_state,
732 .get_log = pseries_eeh_get_log,
733 .configure_bridge = pseries_eeh_configure_bridge,
735 .read_config = pseries_eeh_read_config,
736 .write_config = pseries_eeh_write_config,
738 .restore_config = NULL
742 * eeh_pseries_init - Register platform dependent EEH operations
744 * EEH initialization on pseries platform. This function should be
745 * called before any EEH related functions.
747 static int __init eeh_pseries_init(void)
751 ret = eeh_ops_register(&pseries_eeh_ops);
753 pr_info("EEH: pSeries platform initialized\n");
755 pr_info("EEH: pSeries platform initialization failure (%d)\n",
760 machine_early_initcall(pseries, eeh_pseries_init);