xref: /openbmc/linux/drivers/pci/pcie/err.c (revision bd4af432)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * This file implements the error recovery as a core part of PCIe error
4  * reporting. When a PCIe error is delivered, an error message will be
5  * collected and printed to console, then, an error recovery procedure
6  * will be executed by following the PCI error recovery rules.
7  *
8  * Copyright (C) 2006 Intel Corp.
9  *	Tom Long Nguyen (tom.l.nguyen@intel.com)
10  *	Zhang Yanmin (yanmin.zhang@intel.com)
11  */
12 
13 #define dev_fmt(fmt) "AER: " fmt
14 
15 #include <linux/pci.h>
16 #include <linux/module.h>
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/aer.h>
20 #include "portdrv.h"
21 #include "../pci.h"
22 
23 static pci_ers_result_t merge_result(enum pci_ers_result orig,
24 				  enum pci_ers_result new)
25 {
26 	if (new == PCI_ERS_RESULT_NO_AER_DRIVER)
27 		return PCI_ERS_RESULT_NO_AER_DRIVER;
28 
29 	if (new == PCI_ERS_RESULT_NONE)
30 		return orig;
31 
32 	switch (orig) {
33 	case PCI_ERS_RESULT_CAN_RECOVER:
34 	case PCI_ERS_RESULT_RECOVERED:
35 		orig = new;
36 		break;
37 	case PCI_ERS_RESULT_DISCONNECT:
38 		if (new == PCI_ERS_RESULT_NEED_RESET)
39 			orig = PCI_ERS_RESULT_NEED_RESET;
40 		break;
41 	default:
42 		break;
43 	}
44 
45 	return orig;
46 }
47 
48 static int report_error_detected(struct pci_dev *dev,
49 				 enum pci_channel_state state,
50 				 enum pci_ers_result *result)
51 {
52 	pci_ers_result_t vote;
53 	const struct pci_error_handlers *err_handler;
54 
55 	device_lock(&dev->dev);
56 	if (!pci_dev_set_io_state(dev, state) ||
57 		!dev->driver ||
58 		!dev->driver->err_handler ||
59 		!dev->driver->err_handler->error_detected) {
60 		/*
61 		 * If any device in the subtree does not have an error_detected
62 		 * callback, PCI_ERS_RESULT_NO_AER_DRIVER prevents subsequent
63 		 * error callbacks of "any" device in the subtree, and will
64 		 * exit in the disconnected error state.
65 		 */
66 		if (dev->hdr_type != PCI_HEADER_TYPE_BRIDGE) {
67 			vote = PCI_ERS_RESULT_NO_AER_DRIVER;
68 			pci_info(dev, "can't recover (no error_detected callback)\n");
69 		} else {
70 			vote = PCI_ERS_RESULT_NONE;
71 		}
72 	} else {
73 		err_handler = dev->driver->err_handler;
74 		vote = err_handler->error_detected(dev, state);
75 	}
76 	pci_uevent_ers(dev, vote);
77 	*result = merge_result(*result, vote);
78 	device_unlock(&dev->dev);
79 	return 0;
80 }
81 
82 static int report_frozen_detected(struct pci_dev *dev, void *data)
83 {
84 	return report_error_detected(dev, pci_channel_io_frozen, data);
85 }
86 
87 static int report_normal_detected(struct pci_dev *dev, void *data)
88 {
89 	return report_error_detected(dev, pci_channel_io_normal, data);
90 }
91 
92 static int report_mmio_enabled(struct pci_dev *dev, void *data)
93 {
94 	pci_ers_result_t vote, *result = data;
95 	const struct pci_error_handlers *err_handler;
96 
97 	device_lock(&dev->dev);
98 	if (!dev->driver ||
99 		!dev->driver->err_handler ||
100 		!dev->driver->err_handler->mmio_enabled)
101 		goto out;
102 
103 	err_handler = dev->driver->err_handler;
104 	vote = err_handler->mmio_enabled(dev);
105 	*result = merge_result(*result, vote);
106 out:
107 	device_unlock(&dev->dev);
108 	return 0;
109 }
110 
111 static int report_slot_reset(struct pci_dev *dev, void *data)
112 {
113 	pci_ers_result_t vote, *result = data;
114 	const struct pci_error_handlers *err_handler;
115 
116 	device_lock(&dev->dev);
117 	if (!dev->driver ||
118 		!dev->driver->err_handler ||
119 		!dev->driver->err_handler->slot_reset)
120 		goto out;
121 
122 	err_handler = dev->driver->err_handler;
123 	vote = err_handler->slot_reset(dev);
124 	*result = merge_result(*result, vote);
125 out:
126 	device_unlock(&dev->dev);
127 	return 0;
128 }
129 
130 static int report_resume(struct pci_dev *dev, void *data)
131 {
132 	const struct pci_error_handlers *err_handler;
133 
134 	device_lock(&dev->dev);
135 	if (!pci_dev_set_io_state(dev, pci_channel_io_normal) ||
136 		!dev->driver ||
137 		!dev->driver->err_handler ||
138 		!dev->driver->err_handler->resume)
139 		goto out;
140 
141 	err_handler = dev->driver->err_handler;
142 	err_handler->resume(dev);
143 out:
144 	pci_uevent_ers(dev, PCI_ERS_RESULT_RECOVERED);
145 	device_unlock(&dev->dev);
146 	return 0;
147 }
148 
149 pci_ers_result_t pcie_do_recovery(struct pci_dev *dev,
150 			enum pci_channel_state state,
151 			pci_ers_result_t (*reset_link)(struct pci_dev *pdev))
152 {
153 	pci_ers_result_t status = PCI_ERS_RESULT_CAN_RECOVER;
154 	struct pci_bus *bus;
155 
156 	/*
157 	 * Error recovery runs on all subordinates of the first downstream port.
158 	 * If the downstream port detected the error, it is cleared at the end.
159 	 */
160 	if (!(pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT ||
161 	      pci_pcie_type(dev) == PCI_EXP_TYPE_DOWNSTREAM))
162 		dev = dev->bus->self;
163 	bus = dev->subordinate;
164 
165 	pci_dbg(dev, "broadcast error_detected message\n");
166 	if (state == pci_channel_io_frozen) {
167 		pci_walk_bus(bus, report_frozen_detected, &status);
168 		status = reset_link(dev);
169 		if (status != PCI_ERS_RESULT_RECOVERED) {
170 			pci_warn(dev, "link reset failed\n");
171 			goto failed;
172 		}
173 	} else {
174 		pci_walk_bus(bus, report_normal_detected, &status);
175 	}
176 
177 	if (status == PCI_ERS_RESULT_CAN_RECOVER) {
178 		status = PCI_ERS_RESULT_RECOVERED;
179 		pci_dbg(dev, "broadcast mmio_enabled message\n");
180 		pci_walk_bus(bus, report_mmio_enabled, &status);
181 	}
182 
183 	if (status == PCI_ERS_RESULT_NEED_RESET) {
184 		/*
185 		 * TODO: Should call platform-specific
186 		 * functions to reset slot before calling
187 		 * drivers' slot_reset callbacks?
188 		 */
189 		status = PCI_ERS_RESULT_RECOVERED;
190 		pci_dbg(dev, "broadcast slot_reset message\n");
191 		pci_walk_bus(bus, report_slot_reset, &status);
192 	}
193 
194 	if (status != PCI_ERS_RESULT_RECOVERED)
195 		goto failed;
196 
197 	pci_dbg(dev, "broadcast resume message\n");
198 	pci_walk_bus(bus, report_resume, &status);
199 
200 	pci_aer_clear_device_status(dev);
201 	pci_aer_clear_nonfatal_status(dev);
202 	pci_info(dev, "device recovery successful\n");
203 	return status;
204 
205 failed:
206 	pci_uevent_ers(dev, PCI_ERS_RESULT_DISCONNECT);
207 
208 	/* TODO: Should kernel panic here? */
209 	pci_info(dev, "device recovery failed\n");
210 
211 	return status;
212 }
213