1 // SPDX-License-Identifier: GPL-2.0
3 * Implement the AER root port service driver. The driver registers an IRQ
4 * handler. When a root port triggers an AER interrupt, the IRQ handler
5 * collects root port status and schedules work.
7 * Copyright (C) 2006 Intel Corp.
8 * Tom Long Nguyen (tom.l.nguyen@intel.com)
9 * Zhang Yanmin (yanmin.zhang@intel.com)
11 * (C) Copyright 2009 Hewlett-Packard Development Company, L.P.
12 * Andrew Patterson <andrew.patterson@hp.com>
15 #define pr_fmt(fmt) "AER: " fmt
16 #define dev_fmt pr_fmt
18 #include <linux/bitops.h>
19 #include <linux/cper.h>
20 #include <linux/pci.h>
21 #include <linux/pci-acpi.h>
22 #include <linux/sched.h>
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
26 #include <linux/init.h>
27 #include <linux/interrupt.h>
28 #include <linux/delay.h>
29 #include <linux/kfifo.h>
30 #include <linux/slab.h>
31 #include <acpi/apei.h>
32 #include <ras/ras_event.h>
37 #define AER_ERROR_SOURCES_MAX 128
39 #define AER_MAX_TYPEOF_COR_ERRS 16 /* as per PCI_ERR_COR_STATUS */
40 #define AER_MAX_TYPEOF_UNCOR_ERRS 27 /* as per PCI_ERR_UNCOR_STATUS*/
42 struct aer_err_source {
48 struct pci_dev *rpd; /* Root Port device */
49 DECLARE_KFIFO(aer_fifo, struct aer_err_source, AER_ERROR_SOURCES_MAX);
52 /* AER stats for the device */
56 * Fields for all AER capable devices. They indicate the errors
57 * "as seen by this device". Note that this may mean that if an
58 * end point is causing problems, the AER counters may increment
59 * at its link partner (e.g. root port) because the errors will be
60 * "seen" by the link partner and not the the problematic end point
61 * itself (which may report all counters as 0 as it never saw any
64 /* Counters for different type of correctable errors */
65 u64 dev_cor_errs[AER_MAX_TYPEOF_COR_ERRS];
66 /* Counters for different type of fatal uncorrectable errors */
67 u64 dev_fatal_errs[AER_MAX_TYPEOF_UNCOR_ERRS];
68 /* Counters for different type of nonfatal uncorrectable errors */
69 u64 dev_nonfatal_errs[AER_MAX_TYPEOF_UNCOR_ERRS];
70 /* Total number of ERR_COR sent by this device */
71 u64 dev_total_cor_errs;
72 /* Total number of ERR_FATAL sent by this device */
73 u64 dev_total_fatal_errs;
74 /* Total number of ERR_NONFATAL sent by this device */
75 u64 dev_total_nonfatal_errs;
78 * Fields for Root ports & root complex event collectors only, these
79 * indicate the total number of ERR_COR, ERR_FATAL, and ERR_NONFATAL
80 * messages received by the root port / event collector, INCLUDING the
81 * ones that are generated internally (by the rootport itself)
83 u64 rootport_total_cor_errs;
84 u64 rootport_total_fatal_errs;
85 u64 rootport_total_nonfatal_errs;
88 #define AER_LOG_TLP_MASKS (PCI_ERR_UNC_POISON_TLP| \
91 PCI_ERR_UNC_COMP_ABORT| \
92 PCI_ERR_UNC_UNX_COMP| \
95 #define SYSTEM_ERROR_INTR_ON_MESG_MASK (PCI_EXP_RTCTL_SECEE| \
96 PCI_EXP_RTCTL_SENFEE| \
98 #define ROOT_PORT_INTR_ON_MESG_MASK (PCI_ERR_ROOT_CMD_COR_EN| \
99 PCI_ERR_ROOT_CMD_NONFATAL_EN| \
100 PCI_ERR_ROOT_CMD_FATAL_EN)
101 #define ERR_COR_ID(d) (d & 0xffff)
102 #define ERR_UNCOR_ID(d) (d >> 16)
104 static int pcie_aer_disable;
105 static pci_ers_result_t aer_root_reset(struct pci_dev *dev);
107 void pci_no_aer(void)
109 pcie_aer_disable = 1;
112 bool pci_aer_available(void)
114 return !pcie_aer_disable && pci_msi_enabled();
117 #ifdef CONFIG_PCIE_ECRC
119 #define ECRC_POLICY_DEFAULT 0 /* ECRC set by BIOS */
120 #define ECRC_POLICY_OFF 1 /* ECRC off for performance */
121 #define ECRC_POLICY_ON 2 /* ECRC on for data integrity */
123 static int ecrc_policy = ECRC_POLICY_DEFAULT;
125 static const char * const ecrc_policy_str[] = {
126 [ECRC_POLICY_DEFAULT] = "bios",
127 [ECRC_POLICY_OFF] = "off",
128 [ECRC_POLICY_ON] = "on"
132 * enable_ercr_checking - enable PCIe ECRC checking for a device
133 * @dev: the PCI device
135 * Returns 0 on success, or negative on failure.
137 static int enable_ecrc_checking(struct pci_dev *dev)
139 int aer = dev->aer_cap;
145 pci_read_config_dword(dev, aer + PCI_ERR_CAP, ®32);
146 if (reg32 & PCI_ERR_CAP_ECRC_GENC)
147 reg32 |= PCI_ERR_CAP_ECRC_GENE;
148 if (reg32 & PCI_ERR_CAP_ECRC_CHKC)
149 reg32 |= PCI_ERR_CAP_ECRC_CHKE;
150 pci_write_config_dword(dev, aer + PCI_ERR_CAP, reg32);
156 * disable_ercr_checking - disables PCIe ECRC checking for a device
157 * @dev: the PCI device
159 * Returns 0 on success, or negative on failure.
161 static int disable_ecrc_checking(struct pci_dev *dev)
163 int aer = dev->aer_cap;
169 pci_read_config_dword(dev, aer + PCI_ERR_CAP, ®32);
170 reg32 &= ~(PCI_ERR_CAP_ECRC_GENE | PCI_ERR_CAP_ECRC_CHKE);
171 pci_write_config_dword(dev, aer + PCI_ERR_CAP, reg32);
177 * pcie_set_ecrc_checking - set/unset PCIe ECRC checking for a device based on global policy
178 * @dev: the PCI device
180 void pcie_set_ecrc_checking(struct pci_dev *dev)
182 switch (ecrc_policy) {
183 case ECRC_POLICY_DEFAULT:
185 case ECRC_POLICY_OFF:
186 disable_ecrc_checking(dev);
189 enable_ecrc_checking(dev);
197 * pcie_ecrc_get_policy - parse kernel command-line ecrc option
198 * @str: ECRC policy from kernel command line to use
200 void pcie_ecrc_get_policy(char *str)
204 i = match_string(ecrc_policy_str, ARRAY_SIZE(ecrc_policy_str), str);
210 #endif /* CONFIG_PCIE_ECRC */
212 #define PCI_EXP_AER_FLAGS (PCI_EXP_DEVCTL_CERE | PCI_EXP_DEVCTL_NFERE | \
213 PCI_EXP_DEVCTL_FERE | PCI_EXP_DEVCTL_URRE)
215 int pcie_aer_is_native(struct pci_dev *dev)
217 struct pci_host_bridge *host = pci_find_host_bridge(dev->bus);
222 return pcie_ports_native || host->native_aer;
225 int pci_enable_pcie_error_reporting(struct pci_dev *dev)
229 if (!pcie_aer_is_native(dev))
232 rc = pcie_capability_set_word(dev, PCI_EXP_DEVCTL, PCI_EXP_AER_FLAGS);
233 return pcibios_err_to_errno(rc);
235 EXPORT_SYMBOL_GPL(pci_enable_pcie_error_reporting);
237 int pci_disable_pcie_error_reporting(struct pci_dev *dev)
241 if (!pcie_aer_is_native(dev))
244 rc = pcie_capability_clear_word(dev, PCI_EXP_DEVCTL, PCI_EXP_AER_FLAGS);
245 return pcibios_err_to_errno(rc);
247 EXPORT_SYMBOL_GPL(pci_disable_pcie_error_reporting);
249 int pci_aer_clear_nonfatal_status(struct pci_dev *dev)
251 int aer = dev->aer_cap;
254 if (!pcie_aer_is_native(dev))
257 /* Clear status bits for ERR_NONFATAL errors only */
258 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS, &status);
259 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_SEVER, &sev);
262 pci_write_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS, status);
266 EXPORT_SYMBOL_GPL(pci_aer_clear_nonfatal_status);
268 void pci_aer_clear_fatal_status(struct pci_dev *dev)
270 int aer = dev->aer_cap;
273 if (!pcie_aer_is_native(dev))
276 /* Clear status bits for ERR_FATAL errors only */
277 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS, &status);
278 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_SEVER, &sev);
281 pci_write_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS, status);
285 * pci_aer_raw_clear_status - Clear AER error registers.
286 * @dev: the PCI device
288 * Clearing AER error status registers unconditionally, regardless of
289 * whether they're owned by firmware or the OS.
291 * Returns 0 on success, or negative on failure.
293 int pci_aer_raw_clear_status(struct pci_dev *dev)
295 int aer = dev->aer_cap;
302 port_type = pci_pcie_type(dev);
303 if (port_type == PCI_EXP_TYPE_ROOT_PORT ||
304 port_type == PCI_EXP_TYPE_RC_EC) {
305 pci_read_config_dword(dev, aer + PCI_ERR_ROOT_STATUS, &status);
306 pci_write_config_dword(dev, aer + PCI_ERR_ROOT_STATUS, status);
309 pci_read_config_dword(dev, aer + PCI_ERR_COR_STATUS, &status);
310 pci_write_config_dword(dev, aer + PCI_ERR_COR_STATUS, status);
312 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS, &status);
313 pci_write_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS, status);
318 int pci_aer_clear_status(struct pci_dev *dev)
320 if (!pcie_aer_is_native(dev))
323 return pci_aer_raw_clear_status(dev);
326 void pci_save_aer_state(struct pci_dev *dev)
328 int aer = dev->aer_cap;
329 struct pci_cap_saved_state *save_state;
335 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_ERR);
339 cap = &save_state->cap.data[0];
340 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_MASK, cap++);
341 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_SEVER, cap++);
342 pci_read_config_dword(dev, aer + PCI_ERR_COR_MASK, cap++);
343 pci_read_config_dword(dev, aer + PCI_ERR_CAP, cap++);
344 if (pcie_cap_has_rtctl(dev))
345 pci_read_config_dword(dev, aer + PCI_ERR_ROOT_COMMAND, cap++);
348 void pci_restore_aer_state(struct pci_dev *dev)
350 int aer = dev->aer_cap;
351 struct pci_cap_saved_state *save_state;
357 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_ERR);
361 cap = &save_state->cap.data[0];
362 pci_write_config_dword(dev, aer + PCI_ERR_UNCOR_MASK, *cap++);
363 pci_write_config_dword(dev, aer + PCI_ERR_UNCOR_SEVER, *cap++);
364 pci_write_config_dword(dev, aer + PCI_ERR_COR_MASK, *cap++);
365 pci_write_config_dword(dev, aer + PCI_ERR_CAP, *cap++);
366 if (pcie_cap_has_rtctl(dev))
367 pci_write_config_dword(dev, aer + PCI_ERR_ROOT_COMMAND, *cap++);
370 void pci_aer_init(struct pci_dev *dev)
374 dev->aer_cap = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ERR);
378 dev->aer_stats = kzalloc(sizeof(struct aer_stats), GFP_KERNEL);
381 * We save/restore PCI_ERR_UNCOR_MASK, PCI_ERR_UNCOR_SEVER,
382 * PCI_ERR_COR_MASK, and PCI_ERR_CAP. Root and Root Complex Event
383 * Collectors also implement PCI_ERR_ROOT_COMMAND (PCIe r5.0, sec
386 n = pcie_cap_has_rtctl(dev) ? 5 : 4;
387 pci_add_ext_cap_save_buffer(dev, PCI_EXT_CAP_ID_ERR, sizeof(u32) * n);
389 pci_aer_clear_status(dev);
392 void pci_aer_exit(struct pci_dev *dev)
394 kfree(dev->aer_stats);
395 dev->aer_stats = NULL;
398 #define AER_AGENT_RECEIVER 0
399 #define AER_AGENT_REQUESTER 1
400 #define AER_AGENT_COMPLETER 2
401 #define AER_AGENT_TRANSMITTER 3
403 #define AER_AGENT_REQUESTER_MASK(t) ((t == AER_CORRECTABLE) ? \
404 0 : (PCI_ERR_UNC_COMP_TIME|PCI_ERR_UNC_UNSUP))
405 #define AER_AGENT_COMPLETER_MASK(t) ((t == AER_CORRECTABLE) ? \
406 0 : PCI_ERR_UNC_COMP_ABORT)
407 #define AER_AGENT_TRANSMITTER_MASK(t) ((t == AER_CORRECTABLE) ? \
408 (PCI_ERR_COR_REP_ROLL|PCI_ERR_COR_REP_TIMER) : 0)
410 #define AER_GET_AGENT(t, e) \
411 ((e & AER_AGENT_COMPLETER_MASK(t)) ? AER_AGENT_COMPLETER : \
412 (e & AER_AGENT_REQUESTER_MASK(t)) ? AER_AGENT_REQUESTER : \
413 (e & AER_AGENT_TRANSMITTER_MASK(t)) ? AER_AGENT_TRANSMITTER : \
416 #define AER_PHYSICAL_LAYER_ERROR 0
417 #define AER_DATA_LINK_LAYER_ERROR 1
418 #define AER_TRANSACTION_LAYER_ERROR 2
420 #define AER_PHYSICAL_LAYER_ERROR_MASK(t) ((t == AER_CORRECTABLE) ? \
421 PCI_ERR_COR_RCVR : 0)
422 #define AER_DATA_LINK_LAYER_ERROR_MASK(t) ((t == AER_CORRECTABLE) ? \
423 (PCI_ERR_COR_BAD_TLP| \
424 PCI_ERR_COR_BAD_DLLP| \
425 PCI_ERR_COR_REP_ROLL| \
426 PCI_ERR_COR_REP_TIMER) : PCI_ERR_UNC_DLP)
428 #define AER_GET_LAYER_ERROR(t, e) \
429 ((e & AER_PHYSICAL_LAYER_ERROR_MASK(t)) ? AER_PHYSICAL_LAYER_ERROR : \
430 (e & AER_DATA_LINK_LAYER_ERROR_MASK(t)) ? AER_DATA_LINK_LAYER_ERROR : \
431 AER_TRANSACTION_LAYER_ERROR)
436 static const char *aer_error_severity_string[] = {
437 "Uncorrected (Non-Fatal)",
438 "Uncorrected (Fatal)",
442 static const char *aer_error_layer[] = {
448 static const char *aer_correctable_error_string[] = {
449 "RxErr", /* Bit Position 0 */
455 "BadTLP", /* Bit Position 6 */
456 "BadDLLP", /* Bit Position 7 */
457 "Rollover", /* Bit Position 8 */
461 "Timeout", /* Bit Position 12 */
462 "NonFatalErr", /* Bit Position 13 */
463 "CorrIntErr", /* Bit Position 14 */
464 "HeaderOF", /* Bit Position 15 */
465 NULL, /* Bit Position 16 */
466 NULL, /* Bit Position 17 */
467 NULL, /* Bit Position 18 */
468 NULL, /* Bit Position 19 */
469 NULL, /* Bit Position 20 */
470 NULL, /* Bit Position 21 */
471 NULL, /* Bit Position 22 */
472 NULL, /* Bit Position 23 */
473 NULL, /* Bit Position 24 */
474 NULL, /* Bit Position 25 */
475 NULL, /* Bit Position 26 */
476 NULL, /* Bit Position 27 */
477 NULL, /* Bit Position 28 */
478 NULL, /* Bit Position 29 */
479 NULL, /* Bit Position 30 */
480 NULL, /* Bit Position 31 */
483 static const char *aer_uncorrectable_error_string[] = {
484 "Undefined", /* Bit Position 0 */
488 "DLP", /* Bit Position 4 */
489 "SDES", /* Bit Position 5 */
496 "TLP", /* Bit Position 12 */
497 "FCP", /* Bit Position 13 */
498 "CmpltTO", /* Bit Position 14 */
499 "CmpltAbrt", /* Bit Position 15 */
500 "UnxCmplt", /* Bit Position 16 */
501 "RxOF", /* Bit Position 17 */
502 "MalfTLP", /* Bit Position 18 */
503 "ECRC", /* Bit Position 19 */
504 "UnsupReq", /* Bit Position 20 */
505 "ACSViol", /* Bit Position 21 */
506 "UncorrIntErr", /* Bit Position 22 */
507 "BlockedTLP", /* Bit Position 23 */
508 "AtomicOpBlocked", /* Bit Position 24 */
509 "TLPBlockedErr", /* Bit Position 25 */
510 "PoisonTLPBlocked", /* Bit Position 26 */
511 NULL, /* Bit Position 27 */
512 NULL, /* Bit Position 28 */
513 NULL, /* Bit Position 29 */
514 NULL, /* Bit Position 30 */
515 NULL, /* Bit Position 31 */
518 static const char *aer_agent_string[] = {
525 #define aer_stats_dev_attr(name, stats_array, strings_array, \
526 total_string, total_field) \
528 name##_show(struct device *dev, struct device_attribute *attr, \
533 struct pci_dev *pdev = to_pci_dev(dev); \
534 u64 *stats = pdev->aer_stats->stats_array; \
536 for (i = 0; i < ARRAY_SIZE(strings_array); i++) { \
537 if (strings_array[i]) \
538 str += sprintf(str, "%s %llu\n", \
539 strings_array[i], stats[i]); \
541 str += sprintf(str, #stats_array "_bit[%d] %llu\n",\
544 str += sprintf(str, "TOTAL_%s %llu\n", total_string, \
545 pdev->aer_stats->total_field); \
548 static DEVICE_ATTR_RO(name)
550 aer_stats_dev_attr(aer_dev_correctable, dev_cor_errs,
551 aer_correctable_error_string, "ERR_COR",
553 aer_stats_dev_attr(aer_dev_fatal, dev_fatal_errs,
554 aer_uncorrectable_error_string, "ERR_FATAL",
555 dev_total_fatal_errs);
556 aer_stats_dev_attr(aer_dev_nonfatal, dev_nonfatal_errs,
557 aer_uncorrectable_error_string, "ERR_NONFATAL",
558 dev_total_nonfatal_errs);
560 #define aer_stats_rootport_attr(name, field) \
562 name##_show(struct device *dev, struct device_attribute *attr, \
565 struct pci_dev *pdev = to_pci_dev(dev); \
566 return sprintf(buf, "%llu\n", pdev->aer_stats->field); \
568 static DEVICE_ATTR_RO(name)
570 aer_stats_rootport_attr(aer_rootport_total_err_cor,
571 rootport_total_cor_errs);
572 aer_stats_rootport_attr(aer_rootport_total_err_fatal,
573 rootport_total_fatal_errs);
574 aer_stats_rootport_attr(aer_rootport_total_err_nonfatal,
575 rootport_total_nonfatal_errs);
577 static struct attribute *aer_stats_attrs[] __ro_after_init = {
578 &dev_attr_aer_dev_correctable.attr,
579 &dev_attr_aer_dev_fatal.attr,
580 &dev_attr_aer_dev_nonfatal.attr,
581 &dev_attr_aer_rootport_total_err_cor.attr,
582 &dev_attr_aer_rootport_total_err_fatal.attr,
583 &dev_attr_aer_rootport_total_err_nonfatal.attr,
587 static umode_t aer_stats_attrs_are_visible(struct kobject *kobj,
588 struct attribute *a, int n)
590 struct device *dev = kobj_to_dev(kobj);
591 struct pci_dev *pdev = to_pci_dev(dev);
593 if (!pdev->aer_stats)
596 if ((a == &dev_attr_aer_rootport_total_err_cor.attr ||
597 a == &dev_attr_aer_rootport_total_err_fatal.attr ||
598 a == &dev_attr_aer_rootport_total_err_nonfatal.attr) &&
599 ((pci_pcie_type(pdev) != PCI_EXP_TYPE_ROOT_PORT) &&
600 (pci_pcie_type(pdev) != PCI_EXP_TYPE_RC_EC)))
606 const struct attribute_group aer_stats_attr_group = {
607 .attrs = aer_stats_attrs,
608 .is_visible = aer_stats_attrs_are_visible,
611 static void pci_dev_aer_stats_incr(struct pci_dev *pdev,
612 struct aer_err_info *info)
614 unsigned long status = info->status & ~info->mask;
617 struct aer_stats *aer_stats = pdev->aer_stats;
622 switch (info->severity) {
623 case AER_CORRECTABLE:
624 aer_stats->dev_total_cor_errs++;
625 counter = &aer_stats->dev_cor_errs[0];
626 max = AER_MAX_TYPEOF_COR_ERRS;
629 aer_stats->dev_total_nonfatal_errs++;
630 counter = &aer_stats->dev_nonfatal_errs[0];
631 max = AER_MAX_TYPEOF_UNCOR_ERRS;
634 aer_stats->dev_total_fatal_errs++;
635 counter = &aer_stats->dev_fatal_errs[0];
636 max = AER_MAX_TYPEOF_UNCOR_ERRS;
640 for_each_set_bit(i, &status, max)
644 static void pci_rootport_aer_stats_incr(struct pci_dev *pdev,
645 struct aer_err_source *e_src)
647 struct aer_stats *aer_stats = pdev->aer_stats;
652 if (e_src->status & PCI_ERR_ROOT_COR_RCV)
653 aer_stats->rootport_total_cor_errs++;
655 if (e_src->status & PCI_ERR_ROOT_UNCOR_RCV) {
656 if (e_src->status & PCI_ERR_ROOT_FATAL_RCV)
657 aer_stats->rootport_total_fatal_errs++;
659 aer_stats->rootport_total_nonfatal_errs++;
663 static void __print_tlp_header(struct pci_dev *dev,
664 struct aer_header_log_regs *t)
666 pci_err(dev, " TLP Header: %08x %08x %08x %08x\n",
667 t->dw0, t->dw1, t->dw2, t->dw3);
670 static void __aer_print_error(struct pci_dev *dev,
671 struct aer_err_info *info)
673 const char **strings;
674 unsigned long status = info->status & ~info->mask;
675 const char *level, *errmsg;
678 if (info->severity == AER_CORRECTABLE) {
679 strings = aer_correctable_error_string;
680 level = KERN_WARNING;
682 strings = aer_uncorrectable_error_string;
686 for_each_set_bit(i, &status, 32) {
689 errmsg = "Unknown Error Bit";
691 pci_printk(level, dev, " [%2d] %-22s%s\n", i, errmsg,
692 info->first_error == i ? " (First)" : "");
694 pci_dev_aer_stats_incr(dev, info);
697 void aer_print_error(struct pci_dev *dev, struct aer_err_info *info)
700 int id = ((dev->bus->number << 8) | dev->devfn);
704 pci_err(dev, "PCIe Bus Error: severity=%s, type=Inaccessible, (Unregistered Agent ID)\n",
705 aer_error_severity_string[info->severity]);
709 layer = AER_GET_LAYER_ERROR(info->severity, info->status);
710 agent = AER_GET_AGENT(info->severity, info->status);
712 level = (info->severity == AER_CORRECTABLE) ? KERN_WARNING : KERN_ERR;
714 pci_printk(level, dev, "PCIe Bus Error: severity=%s, type=%s, (%s)\n",
715 aer_error_severity_string[info->severity],
716 aer_error_layer[layer], aer_agent_string[agent]);
718 pci_printk(level, dev, " device [%04x:%04x] error status/mask=%08x/%08x\n",
719 dev->vendor, dev->device, info->status, info->mask);
721 __aer_print_error(dev, info);
723 if (info->tlp_header_valid)
724 __print_tlp_header(dev, &info->tlp);
727 if (info->id && info->error_dev_num > 1 && info->id == id)
728 pci_err(dev, " Error of this Agent is reported first\n");
730 trace_aer_event(dev_name(&dev->dev), (info->status & ~info->mask),
731 info->severity, info->tlp_header_valid, &info->tlp);
734 static void aer_print_port_info(struct pci_dev *dev, struct aer_err_info *info)
736 u8 bus = info->id >> 8;
737 u8 devfn = info->id & 0xff;
739 pci_info(dev, "%s%s error received: %04x:%02x:%02x.%d\n",
740 info->multi_error_valid ? "Multiple " : "",
741 aer_error_severity_string[info->severity],
742 pci_domain_nr(dev->bus), bus, PCI_SLOT(devfn),
746 #ifdef CONFIG_ACPI_APEI_PCIEAER
747 int cper_severity_to_aer(int cper_severity)
749 switch (cper_severity) {
750 case CPER_SEV_RECOVERABLE:
755 return AER_CORRECTABLE;
758 EXPORT_SYMBOL_GPL(cper_severity_to_aer);
760 void cper_print_aer(struct pci_dev *dev, int aer_severity,
761 struct aer_capability_regs *aer)
763 int layer, agent, tlp_header_valid = 0;
765 struct aer_err_info info;
767 if (aer_severity == AER_CORRECTABLE) {
768 status = aer->cor_status;
769 mask = aer->cor_mask;
771 status = aer->uncor_status;
772 mask = aer->uncor_mask;
773 tlp_header_valid = status & AER_LOG_TLP_MASKS;
776 layer = AER_GET_LAYER_ERROR(aer_severity, status);
777 agent = AER_GET_AGENT(aer_severity, status);
779 memset(&info, 0, sizeof(info));
780 info.severity = aer_severity;
781 info.status = status;
783 info.first_error = PCI_ERR_CAP_FEP(aer->cap_control);
785 pci_err(dev, "aer_status: 0x%08x, aer_mask: 0x%08x\n", status, mask);
786 __aer_print_error(dev, &info);
787 pci_err(dev, "aer_layer=%s, aer_agent=%s\n",
788 aer_error_layer[layer], aer_agent_string[agent]);
790 if (aer_severity != AER_CORRECTABLE)
791 pci_err(dev, "aer_uncor_severity: 0x%08x\n",
792 aer->uncor_severity);
794 if (tlp_header_valid)
795 __print_tlp_header(dev, &aer->header_log);
797 trace_aer_event(dev_name(&dev->dev), (status & ~mask),
798 aer_severity, tlp_header_valid, &aer->header_log);
803 * add_error_device - list device to be handled
804 * @e_info: pointer to error info
805 * @dev: pointer to pci_dev to be added
807 static int add_error_device(struct aer_err_info *e_info, struct pci_dev *dev)
809 if (e_info->error_dev_num < AER_MAX_MULTI_ERR_DEVICES) {
810 e_info->dev[e_info->error_dev_num] = pci_dev_get(dev);
811 e_info->error_dev_num++;
818 * is_error_source - check whether the device is source of reported error
819 * @dev: pointer to pci_dev to be checked
820 * @e_info: pointer to reported error info
822 static bool is_error_source(struct pci_dev *dev, struct aer_err_info *e_info)
824 int aer = dev->aer_cap;
829 * When bus id is equal to 0, it might be a bad id
830 * reported by root port.
832 if ((PCI_BUS_NUM(e_info->id) != 0) &&
833 !(dev->bus->bus_flags & PCI_BUS_FLAGS_NO_AERSID)) {
834 /* Device ID match? */
835 if (e_info->id == ((dev->bus->number << 8) | dev->devfn))
838 /* Continue id comparing if there is no multiple error */
839 if (!e_info->multi_error_valid)
845 * 1) bus id is equal to 0. Some ports might lose the bus
846 * id of error source id;
847 * 2) bus flag PCI_BUS_FLAGS_NO_AERSID is set
848 * 3) There are multiple errors and prior ID comparing fails;
849 * We check AER status registers to find possible reporter.
851 if (atomic_read(&dev->enable_cnt) == 0)
854 /* Check if AER is enabled */
855 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, ®16);
856 if (!(reg16 & PCI_EXP_AER_FLAGS))
862 /* Check if error is recorded */
863 if (e_info->severity == AER_CORRECTABLE) {
864 pci_read_config_dword(dev, aer + PCI_ERR_COR_STATUS, &status);
865 pci_read_config_dword(dev, aer + PCI_ERR_COR_MASK, &mask);
867 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS, &status);
868 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_MASK, &mask);
876 static int find_device_iter(struct pci_dev *dev, void *data)
878 struct aer_err_info *e_info = (struct aer_err_info *)data;
880 if (is_error_source(dev, e_info)) {
881 /* List this device */
882 if (add_error_device(e_info, dev)) {
883 /* We cannot handle more... Stop iteration */
884 /* TODO: Should print error message here? */
888 /* If there is only a single error, stop iteration */
889 if (!e_info->multi_error_valid)
896 * find_source_device - search through device hierarchy for source device
897 * @parent: pointer to Root Port pci_dev data structure
898 * @e_info: including detailed error information such like id
900 * Return true if found.
902 * Invoked by DPC when error is detected at the Root Port.
903 * Caller of this function must set id, severity, and multi_error_valid of
904 * struct aer_err_info pointed by @e_info properly. This function must fill
905 * e_info->error_dev_num and e_info->dev[], based on the given information.
907 static bool find_source_device(struct pci_dev *parent,
908 struct aer_err_info *e_info)
910 struct pci_dev *dev = parent;
913 /* Must reset in this function */
914 e_info->error_dev_num = 0;
916 /* Is Root Port an agent that sends error message? */
917 result = find_device_iter(dev, e_info);
921 if (pci_pcie_type(parent) == PCI_EXP_TYPE_RC_EC)
922 pcie_walk_rcec(parent, find_device_iter, e_info);
924 pci_walk_bus(parent->subordinate, find_device_iter, e_info);
926 if (!e_info->error_dev_num) {
927 pci_info(parent, "can't find device of ID%04x\n", e_info->id);
934 * handle_error_source - handle logging error into an event log
935 * @dev: pointer to pci_dev data structure of error source device
936 * @info: comprehensive error information
938 * Invoked when an error being detected by Root Port.
940 static void handle_error_source(struct pci_dev *dev, struct aer_err_info *info)
942 int aer = dev->aer_cap;
944 if (info->severity == AER_CORRECTABLE) {
946 * Correctable error does not need software intervention.
947 * No need to go through error recovery process.
950 pci_write_config_dword(dev, aer + PCI_ERR_COR_STATUS,
952 if (pcie_aer_is_native(dev))
953 pcie_clear_device_status(dev);
954 } else if (info->severity == AER_NONFATAL)
955 pcie_do_recovery(dev, pci_channel_io_normal, aer_root_reset);
956 else if (info->severity == AER_FATAL)
957 pcie_do_recovery(dev, pci_channel_io_frozen, aer_root_reset);
961 #ifdef CONFIG_ACPI_APEI_PCIEAER
963 #define AER_RECOVER_RING_ORDER 4
964 #define AER_RECOVER_RING_SIZE (1 << AER_RECOVER_RING_ORDER)
966 struct aer_recover_entry {
971 struct aer_capability_regs *regs;
974 static DEFINE_KFIFO(aer_recover_ring, struct aer_recover_entry,
975 AER_RECOVER_RING_SIZE);
977 static void aer_recover_work_func(struct work_struct *work)
979 struct aer_recover_entry entry;
980 struct pci_dev *pdev;
982 while (kfifo_get(&aer_recover_ring, &entry)) {
983 pdev = pci_get_domain_bus_and_slot(entry.domain, entry.bus,
986 pr_err("AER recover: Can not find pci_dev for %04x:%02x:%02x:%x\n",
987 entry.domain, entry.bus,
988 PCI_SLOT(entry.devfn), PCI_FUNC(entry.devfn));
991 cper_print_aer(pdev, entry.severity, entry.regs);
992 if (entry.severity == AER_NONFATAL)
993 pcie_do_recovery(pdev, pci_channel_io_normal,
995 else if (entry.severity == AER_FATAL)
996 pcie_do_recovery(pdev, pci_channel_io_frozen,
1003 * Mutual exclusion for writers of aer_recover_ring, reader side don't
1004 * need lock, because there is only one reader and lock is not needed
1005 * between reader and writer.
1007 static DEFINE_SPINLOCK(aer_recover_ring_lock);
1008 static DECLARE_WORK(aer_recover_work, aer_recover_work_func);
1010 void aer_recover_queue(int domain, unsigned int bus, unsigned int devfn,
1011 int severity, struct aer_capability_regs *aer_regs)
1013 struct aer_recover_entry entry = {
1017 .severity = severity,
1021 if (kfifo_in_spinlocked(&aer_recover_ring, &entry, 1,
1022 &aer_recover_ring_lock))
1023 schedule_work(&aer_recover_work);
1025 pr_err("AER recover: Buffer overflow when recovering AER for %04x:%02x:%02x:%x\n",
1026 domain, bus, PCI_SLOT(devfn), PCI_FUNC(devfn));
1028 EXPORT_SYMBOL_GPL(aer_recover_queue);
1032 * aer_get_device_error_info - read error status from dev and store it to info
1033 * @dev: pointer to the device expected to have a error record
1034 * @info: pointer to structure to store the error record
1036 * Return 1 on success, 0 on error.
1038 * Note that @info is reused among all error devices. Clear fields properly.
1040 int aer_get_device_error_info(struct pci_dev *dev, struct aer_err_info *info)
1042 int type = pci_pcie_type(dev);
1043 int aer = dev->aer_cap;
1046 /* Must reset in this function */
1048 info->tlp_header_valid = 0;
1050 /* The device might not support AER */
1054 if (info->severity == AER_CORRECTABLE) {
1055 pci_read_config_dword(dev, aer + PCI_ERR_COR_STATUS,
1057 pci_read_config_dword(dev, aer + PCI_ERR_COR_MASK,
1059 if (!(info->status & ~info->mask))
1061 } else if (type == PCI_EXP_TYPE_ROOT_PORT ||
1062 type == PCI_EXP_TYPE_RC_EC ||
1063 type == PCI_EXP_TYPE_DOWNSTREAM ||
1064 info->severity == AER_NONFATAL) {
1066 /* Link is still healthy for IO reads */
1067 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_STATUS,
1069 pci_read_config_dword(dev, aer + PCI_ERR_UNCOR_MASK,
1071 if (!(info->status & ~info->mask))
1074 /* Get First Error Pointer */
1075 pci_read_config_dword(dev, aer + PCI_ERR_CAP, &temp);
1076 info->first_error = PCI_ERR_CAP_FEP(temp);
1078 if (info->status & AER_LOG_TLP_MASKS) {
1079 info->tlp_header_valid = 1;
1080 pci_read_config_dword(dev,
1081 aer + PCI_ERR_HEADER_LOG, &info->tlp.dw0);
1082 pci_read_config_dword(dev,
1083 aer + PCI_ERR_HEADER_LOG + 4, &info->tlp.dw1);
1084 pci_read_config_dword(dev,
1085 aer + PCI_ERR_HEADER_LOG + 8, &info->tlp.dw2);
1086 pci_read_config_dword(dev,
1087 aer + PCI_ERR_HEADER_LOG + 12, &info->tlp.dw3);
1094 static inline void aer_process_err_devices(struct aer_err_info *e_info)
1098 /* Report all before handle them, not to lost records by reset etc. */
1099 for (i = 0; i < e_info->error_dev_num && e_info->dev[i]; i++) {
1100 if (aer_get_device_error_info(e_info->dev[i], e_info))
1101 aer_print_error(e_info->dev[i], e_info);
1103 for (i = 0; i < e_info->error_dev_num && e_info->dev[i]; i++) {
1104 if (aer_get_device_error_info(e_info->dev[i], e_info))
1105 handle_error_source(e_info->dev[i], e_info);
1110 * aer_isr_one_error - consume an error detected by root port
1111 * @rpc: pointer to the root port which holds an error
1112 * @e_src: pointer to an error source
1114 static void aer_isr_one_error(struct aer_rpc *rpc,
1115 struct aer_err_source *e_src)
1117 struct pci_dev *pdev = rpc->rpd;
1118 struct aer_err_info e_info;
1120 pci_rootport_aer_stats_incr(pdev, e_src);
1123 * There is a possibility that both correctable error and
1124 * uncorrectable error being logged. Report correctable error first.
1126 if (e_src->status & PCI_ERR_ROOT_COR_RCV) {
1127 e_info.id = ERR_COR_ID(e_src->id);
1128 e_info.severity = AER_CORRECTABLE;
1130 if (e_src->status & PCI_ERR_ROOT_MULTI_COR_RCV)
1131 e_info.multi_error_valid = 1;
1133 e_info.multi_error_valid = 0;
1134 aer_print_port_info(pdev, &e_info);
1136 if (find_source_device(pdev, &e_info))
1137 aer_process_err_devices(&e_info);
1140 if (e_src->status & PCI_ERR_ROOT_UNCOR_RCV) {
1141 e_info.id = ERR_UNCOR_ID(e_src->id);
1143 if (e_src->status & PCI_ERR_ROOT_FATAL_RCV)
1144 e_info.severity = AER_FATAL;
1146 e_info.severity = AER_NONFATAL;
1148 if (e_src->status & PCI_ERR_ROOT_MULTI_UNCOR_RCV)
1149 e_info.multi_error_valid = 1;
1151 e_info.multi_error_valid = 0;
1153 aer_print_port_info(pdev, &e_info);
1155 if (find_source_device(pdev, &e_info))
1156 aer_process_err_devices(&e_info);
1161 * aer_isr - consume errors detected by root port
1162 * @irq: IRQ assigned to Root Port
1163 * @context: pointer to Root Port data structure
1165 * Invoked, as DPC, when root port records new detected error
1167 static irqreturn_t aer_isr(int irq, void *context)
1169 struct pcie_device *dev = (struct pcie_device *)context;
1170 struct aer_rpc *rpc = get_service_data(dev);
1171 struct aer_err_source e_src;
1173 if (kfifo_is_empty(&rpc->aer_fifo))
1176 while (kfifo_get(&rpc->aer_fifo, &e_src))
1177 aer_isr_one_error(rpc, &e_src);
1182 * aer_irq - Root Port's ISR
1183 * @irq: IRQ assigned to Root Port
1184 * @context: pointer to Root Port data structure
1186 * Invoked when Root Port detects AER messages.
1188 static irqreturn_t aer_irq(int irq, void *context)
1190 struct pcie_device *pdev = (struct pcie_device *)context;
1191 struct aer_rpc *rpc = get_service_data(pdev);
1192 struct pci_dev *rp = rpc->rpd;
1193 int aer = rp->aer_cap;
1194 struct aer_err_source e_src = {};
1196 pci_read_config_dword(rp, aer + PCI_ERR_ROOT_STATUS, &e_src.status);
1197 if (!(e_src.status & (PCI_ERR_ROOT_UNCOR_RCV|PCI_ERR_ROOT_COR_RCV)))
1200 pci_read_config_dword(rp, aer + PCI_ERR_ROOT_ERR_SRC, &e_src.id);
1201 pci_write_config_dword(rp, aer + PCI_ERR_ROOT_STATUS, e_src.status);
1203 if (!kfifo_put(&rpc->aer_fifo, e_src))
1206 return IRQ_WAKE_THREAD;
1209 static int set_device_error_reporting(struct pci_dev *dev, void *data)
1211 bool enable = *((bool *)data);
1212 int type = pci_pcie_type(dev);
1214 if ((type == PCI_EXP_TYPE_ROOT_PORT) ||
1215 (type == PCI_EXP_TYPE_RC_EC) ||
1216 (type == PCI_EXP_TYPE_UPSTREAM) ||
1217 (type == PCI_EXP_TYPE_DOWNSTREAM)) {
1219 pci_enable_pcie_error_reporting(dev);
1221 pci_disable_pcie_error_reporting(dev);
1225 pcie_set_ecrc_checking(dev);
1231 * set_downstream_devices_error_reporting - enable/disable the error reporting bits on the root port and its downstream ports.
1232 * @dev: pointer to root port's pci_dev data structure
1233 * @enable: true = enable error reporting, false = disable error reporting.
1235 static void set_downstream_devices_error_reporting(struct pci_dev *dev,
1238 set_device_error_reporting(dev, &enable);
1240 if (pci_pcie_type(dev) == PCI_EXP_TYPE_RC_EC)
1241 pcie_walk_rcec(dev, set_device_error_reporting, &enable);
1242 else if (dev->subordinate)
1243 pci_walk_bus(dev->subordinate, set_device_error_reporting,
1249 * aer_enable_rootport - enable Root Port's interrupts when receiving messages
1250 * @rpc: pointer to a Root Port data structure
1252 * Invoked when PCIe bus loads AER service driver.
1254 static void aer_enable_rootport(struct aer_rpc *rpc)
1256 struct pci_dev *pdev = rpc->rpd;
1257 int aer = pdev->aer_cap;
1261 /* Clear PCIe Capability's Device Status */
1262 pcie_capability_read_word(pdev, PCI_EXP_DEVSTA, ®16);
1263 pcie_capability_write_word(pdev, PCI_EXP_DEVSTA, reg16);
1265 /* Disable system error generation in response to error messages */
1266 pcie_capability_clear_word(pdev, PCI_EXP_RTCTL,
1267 SYSTEM_ERROR_INTR_ON_MESG_MASK);
1269 /* Clear error status */
1270 pci_read_config_dword(pdev, aer + PCI_ERR_ROOT_STATUS, ®32);
1271 pci_write_config_dword(pdev, aer + PCI_ERR_ROOT_STATUS, reg32);
1272 pci_read_config_dword(pdev, aer + PCI_ERR_COR_STATUS, ®32);
1273 pci_write_config_dword(pdev, aer + PCI_ERR_COR_STATUS, reg32);
1274 pci_read_config_dword(pdev, aer + PCI_ERR_UNCOR_STATUS, ®32);
1275 pci_write_config_dword(pdev, aer + PCI_ERR_UNCOR_STATUS, reg32);
1278 * Enable error reporting for the root port device and downstream port
1281 set_downstream_devices_error_reporting(pdev, true);
1283 /* Enable Root Port's interrupt in response to error messages */
1284 pci_read_config_dword(pdev, aer + PCI_ERR_ROOT_COMMAND, ®32);
1285 reg32 |= ROOT_PORT_INTR_ON_MESG_MASK;
1286 pci_write_config_dword(pdev, aer + PCI_ERR_ROOT_COMMAND, reg32);
1290 * aer_disable_rootport - disable Root Port's interrupts when receiving messages
1291 * @rpc: pointer to a Root Port data structure
1293 * Invoked when PCIe bus unloads AER service driver.
1295 static void aer_disable_rootport(struct aer_rpc *rpc)
1297 struct pci_dev *pdev = rpc->rpd;
1298 int aer = pdev->aer_cap;
1302 * Disable error reporting for the root port device and downstream port
1305 set_downstream_devices_error_reporting(pdev, false);
1307 /* Disable Root's interrupt in response to error messages */
1308 pci_read_config_dword(pdev, aer + PCI_ERR_ROOT_COMMAND, ®32);
1309 reg32 &= ~ROOT_PORT_INTR_ON_MESG_MASK;
1310 pci_write_config_dword(pdev, aer + PCI_ERR_ROOT_COMMAND, reg32);
1312 /* Clear Root's error status reg */
1313 pci_read_config_dword(pdev, aer + PCI_ERR_ROOT_STATUS, ®32);
1314 pci_write_config_dword(pdev, aer + PCI_ERR_ROOT_STATUS, reg32);
1318 * aer_remove - clean up resources
1319 * @dev: pointer to the pcie_dev data structure
1321 * Invoked when PCI Express bus unloads or AER probe fails.
1323 static void aer_remove(struct pcie_device *dev)
1325 struct aer_rpc *rpc = get_service_data(dev);
1327 aer_disable_rootport(rpc);
1331 * aer_probe - initialize resources
1332 * @dev: pointer to the pcie_dev data structure
1334 * Invoked when PCI Express bus loads AER service driver.
1336 static int aer_probe(struct pcie_device *dev)
1339 struct aer_rpc *rpc;
1340 struct device *device = &dev->device;
1341 struct pci_dev *port = dev->port;
1343 /* Limit to Root Ports or Root Complex Event Collectors */
1344 if ((pci_pcie_type(port) != PCI_EXP_TYPE_RC_EC) &&
1345 (pci_pcie_type(port) != PCI_EXP_TYPE_ROOT_PORT))
1348 rpc = devm_kzalloc(device, sizeof(struct aer_rpc), GFP_KERNEL);
1353 INIT_KFIFO(rpc->aer_fifo);
1354 set_service_data(dev, rpc);
1356 status = devm_request_threaded_irq(device, dev->irq, aer_irq, aer_isr,
1357 IRQF_SHARED, "aerdrv", dev);
1359 pci_err(port, "request AER IRQ %d failed\n", dev->irq);
1363 aer_enable_rootport(rpc);
1364 pci_info(port, "enabled with IRQ %d\n", dev->irq);
1369 * aer_root_reset - reset Root Port hierarchy, RCEC, or RCiEP
1370 * @dev: pointer to Root Port, RCEC, or RCiEP
1372 * Invoked by Port Bus driver when performing reset.
1374 static pci_ers_result_t aer_root_reset(struct pci_dev *dev)
1376 int type = pci_pcie_type(dev);
1377 struct pci_dev *root;
1379 struct pci_host_bridge *host = pci_find_host_bridge(dev->bus);
1384 * Only Root Ports and RCECs have AER Root Command and Root Status
1385 * registers. If "dev" is an RCiEP, the relevant registers are in
1388 if (type == PCI_EXP_TYPE_RC_END)
1394 * If the platform retained control of AER, an RCiEP may not have
1395 * an RCEC visible to us, so dev->rcec ("root") may be NULL. In
1396 * that case, firmware is responsible for these registers.
1398 aer = root ? root->aer_cap : 0;
1400 if ((host->native_aer || pcie_ports_native) && aer) {
1401 /* Disable Root's interrupt in response to error messages */
1402 pci_read_config_dword(root, aer + PCI_ERR_ROOT_COMMAND, ®32);
1403 reg32 &= ~ROOT_PORT_INTR_ON_MESG_MASK;
1404 pci_write_config_dword(root, aer + PCI_ERR_ROOT_COMMAND, reg32);
1407 if (type == PCI_EXP_TYPE_RC_EC || type == PCI_EXP_TYPE_RC_END) {
1408 if (pcie_has_flr(dev)) {
1410 pci_info(dev, "has been reset (%d)\n", rc);
1412 pci_info(dev, "not reset (no FLR support)\n");
1416 rc = pci_bus_error_reset(dev);
1417 pci_info(dev, "Root Port link has been reset (%d)\n", rc);
1420 if ((host->native_aer || pcie_ports_native) && aer) {
1421 /* Clear Root Error Status */
1422 pci_read_config_dword(root, aer + PCI_ERR_ROOT_STATUS, ®32);
1423 pci_write_config_dword(root, aer + PCI_ERR_ROOT_STATUS, reg32);
1425 /* Enable Root Port's interrupt in response to error messages */
1426 pci_read_config_dword(root, aer + PCI_ERR_ROOT_COMMAND, ®32);
1427 reg32 |= ROOT_PORT_INTR_ON_MESG_MASK;
1428 pci_write_config_dword(root, aer + PCI_ERR_ROOT_COMMAND, reg32);
1431 return rc ? PCI_ERS_RESULT_DISCONNECT : PCI_ERS_RESULT_RECOVERED;
1434 static struct pcie_port_service_driver aerdriver = {
1436 .port_type = PCIE_ANY_PORT,
1437 .service = PCIE_PORT_SERVICE_AER,
1440 .remove = aer_remove,
1444 * aer_service_init - register AER root service driver
1446 * Invoked when AER root service driver is loaded.
1448 int __init pcie_aer_init(void)
1450 if (!pci_aer_available())
1452 return pcie_port_service_register(&aerdriver);