PCI/DPC: Make RP PIO log size check more generic
[muen/linux.git] / drivers / pci / pcie / pcie-dpc.c
1 /*
2  * PCI Express Downstream Port Containment services driver
3  * Author: Keith Busch <keith.busch@intel.com>
4  *
5  * Copyright (C) 2016 Intel Corp.
6  *
7  * This file is subject to the terms and conditions of the GNU General Public
8  * License.  See the file "COPYING" in the main directory of this archive
9  * for more details.
10  */
11
12 #include <linux/delay.h>
13 #include <linux/interrupt.h>
14 #include <linux/init.h>
15 #include <linux/pci.h>
16 #include <linux/pcieport_if.h>
17 #include "../pci.h"
18 #include "aer/aerdrv.h"
19
20 struct rp_pio_header_log_regs {
21         u32 dw0;
22         u32 dw1;
23         u32 dw2;
24         u32 dw3;
25 };
26
27 struct dpc_rp_pio_regs {
28         u32 status;
29         u32 mask;
30         u32 severity;
31         u32 syserror;
32         u32 exception;
33
34         struct rp_pio_header_log_regs header_log;
35         u32 impspec_log;
36         u32 tlp_prefix_log[4];
37         u16 first_error;
38 };
39
40 struct dpc_dev {
41         struct pcie_device      *dev;
42         struct work_struct      work;
43         u16                     cap_pos;
44         bool                    rp_extensions;
45         u32                     rp_pio_status;
46         u8                      rp_log_size;
47 };
48
49 static const char * const rp_pio_error_string[] = {
50         "Configuration Request received UR Completion",  /* Bit Position 0  */
51         "Configuration Request received CA Completion",  /* Bit Position 1  */
52         "Configuration Request Completion Timeout",      /* Bit Position 2  */
53         NULL,
54         NULL,
55         NULL,
56         NULL,
57         NULL,
58         "I/O Request received UR Completion",            /* Bit Position 8  */
59         "I/O Request received CA Completion",            /* Bit Position 9  */
60         "I/O Request Completion Timeout",                /* Bit Position 10 */
61         NULL,
62         NULL,
63         NULL,
64         NULL,
65         NULL,
66         "Memory Request received UR Completion",         /* Bit Position 16 */
67         "Memory Request received CA Completion",         /* Bit Position 17 */
68         "Memory Request Completion Timeout",             /* Bit Position 18 */
69 };
70
71 static int dpc_wait_rp_inactive(struct dpc_dev *dpc)
72 {
73         unsigned long timeout = jiffies + HZ;
74         struct pci_dev *pdev = dpc->dev->port;
75         struct device *dev = &dpc->dev->device;
76         u16 cap = dpc->cap_pos, status;
77
78         pci_read_config_word(pdev, cap + PCI_EXP_DPC_STATUS, &status);
79         while (status & PCI_EXP_DPC_RP_BUSY &&
80                                         !time_after(jiffies, timeout)) {
81                 msleep(10);
82                 pci_read_config_word(pdev, cap + PCI_EXP_DPC_STATUS, &status);
83         }
84         if (status & PCI_EXP_DPC_RP_BUSY) {
85                 dev_warn(dev, "DPC root port still busy\n");
86                 return -EBUSY;
87         }
88         return 0;
89 }
90
91 static void dpc_wait_link_inactive(struct dpc_dev *dpc)
92 {
93         unsigned long timeout = jiffies + HZ;
94         struct pci_dev *pdev = dpc->dev->port;
95         struct device *dev = &dpc->dev->device;
96         u16 lnk_status;
97
98         pcie_capability_read_word(pdev, PCI_EXP_LNKSTA, &lnk_status);
99         while (lnk_status & PCI_EXP_LNKSTA_DLLLA &&
100                                         !time_after(jiffies, timeout)) {
101                 msleep(10);
102                 pcie_capability_read_word(pdev, PCI_EXP_LNKSTA, &lnk_status);
103         }
104         if (lnk_status & PCI_EXP_LNKSTA_DLLLA)
105                 dev_warn(dev, "Link state not disabled for DPC event\n");
106 }
107
108 static void dpc_work(struct work_struct *work)
109 {
110         struct dpc_dev *dpc = container_of(work, struct dpc_dev, work);
111         struct pci_dev *dev, *temp, *pdev = dpc->dev->port;
112         struct pci_bus *parent = pdev->subordinate;
113         u16 cap = dpc->cap_pos, ctl;
114
115         pci_lock_rescan_remove();
116         list_for_each_entry_safe_reverse(dev, temp, &parent->devices,
117                                          bus_list) {
118                 pci_dev_get(dev);
119                 pci_dev_set_disconnected(dev, NULL);
120                 if (pci_has_subordinate(dev))
121                         pci_walk_bus(dev->subordinate,
122                                      pci_dev_set_disconnected, NULL);
123                 pci_stop_and_remove_bus_device(dev);
124                 pci_dev_put(dev);
125         }
126         pci_unlock_rescan_remove();
127
128         dpc_wait_link_inactive(dpc);
129         if (dpc->rp_extensions && dpc_wait_rp_inactive(dpc))
130                 return;
131         if (dpc->rp_extensions && dpc->rp_pio_status) {
132                 pci_write_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_STATUS,
133                                        dpc->rp_pio_status);
134                 dpc->rp_pio_status = 0;
135         }
136
137         pci_write_config_word(pdev, cap + PCI_EXP_DPC_STATUS,
138                 PCI_EXP_DPC_STATUS_TRIGGER | PCI_EXP_DPC_STATUS_INTERRUPT);
139
140         pci_read_config_word(pdev, cap + PCI_EXP_DPC_CTL, &ctl);
141         pci_write_config_word(pdev, cap + PCI_EXP_DPC_CTL,
142                               ctl | PCI_EXP_DPC_CTL_INT_EN);
143 }
144
145 static void dpc_rp_pio_print_error(struct dpc_dev *dpc,
146                                    struct dpc_rp_pio_regs *rp_pio)
147 {
148         struct device *dev = &dpc->dev->device;
149         int i;
150         u32 status;
151
152         dev_err(dev, "rp_pio_status: %#010x, rp_pio_mask: %#010x\n",
153                 rp_pio->status, rp_pio->mask);
154
155         dev_err(dev, "RP PIO severity=%#010x, syserror=%#010x, exception=%#010x\n",
156                 rp_pio->severity, rp_pio->syserror, rp_pio->exception);
157
158         status = (rp_pio->status & ~rp_pio->mask);
159
160         for (i = 0; i < ARRAY_SIZE(rp_pio_error_string); i++) {
161                 if (!(status & (1 << i)))
162                         continue;
163
164                 dev_err(dev, "[%2d] %s%s\n", i, rp_pio_error_string[i],
165                         rp_pio->first_error == i ? " (First)" : "");
166         }
167
168         dev_err(dev, "TLP Header: %#010x %#010x %#010x %#010x\n",
169                 rp_pio->header_log.dw0, rp_pio->header_log.dw1,
170                 rp_pio->header_log.dw2, rp_pio->header_log.dw3);
171         if (dpc->rp_log_size == 4)
172                 return;
173
174         dev_err(dev, "RP PIO ImpSpec Log %#010x\n", rp_pio->impspec_log);
175
176         for (i = 0; i < dpc->rp_log_size - 5; i++)
177                 dev_err(dev, "TLP Prefix Header: dw%d, %#010x\n", i,
178                         rp_pio->tlp_prefix_log[i]);
179 }
180
181 static void dpc_rp_pio_get_info(struct dpc_dev *dpc,
182                                 struct dpc_rp_pio_regs *rp_pio)
183 {
184         struct pci_dev *pdev = dpc->dev->port;
185         int i;
186         u16 cap = dpc->cap_pos, dpc_status;
187
188         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_STATUS,
189                               &rp_pio->status);
190         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_MASK,
191                               &rp_pio->mask);
192
193         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_SEVERITY,
194                               &rp_pio->severity);
195         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_SYSERROR,
196                               &rp_pio->syserror);
197         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_EXCEPTION,
198                               &rp_pio->exception);
199
200         /* Get First Error Pointer */
201         pci_read_config_word(pdev, cap + PCI_EXP_DPC_STATUS, &dpc_status);
202         rp_pio->first_error = (dpc_status & 0x1f00) >> 8;
203
204         if (dpc->rp_log_size < 4)
205                 return;
206
207         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_HEADER_LOG,
208                               &rp_pio->header_log.dw0);
209         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_HEADER_LOG + 4,
210                               &rp_pio->header_log.dw1);
211         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_HEADER_LOG + 8,
212                               &rp_pio->header_log.dw2);
213         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_HEADER_LOG + 12,
214                               &rp_pio->header_log.dw3);
215
216         if (dpc->rp_log_size < 5)
217                 return;
218         pci_read_config_dword(pdev, cap + PCI_EXP_DPC_RP_PIO_IMPSPEC_LOG,
219                               &rp_pio->impspec_log);
220
221         for (i = 0; i < dpc->rp_log_size - 5; i++)
222                 pci_read_config_dword(pdev,
223                         cap + PCI_EXP_DPC_RP_PIO_TLPPREFIX_LOG,
224                         &rp_pio->tlp_prefix_log[i]);
225 }
226
227 static void dpc_process_rp_pio_error(struct dpc_dev *dpc)
228 {
229         struct dpc_rp_pio_regs rp_pio_regs;
230
231         dpc_rp_pio_get_info(dpc, &rp_pio_regs);
232         dpc_rp_pio_print_error(dpc, &rp_pio_regs);
233
234         dpc->rp_pio_status = rp_pio_regs.status;
235 }
236
237 static irqreturn_t dpc_irq(int irq, void *context)
238 {
239         struct dpc_dev *dpc = (struct dpc_dev *)context;
240         struct pci_dev *pdev = dpc->dev->port;
241         struct device *dev = &dpc->dev->device;
242         u16 cap = dpc->cap_pos, ctl, status, source, reason, ext_reason;
243
244         pci_read_config_word(pdev, cap + PCI_EXP_DPC_CTL, &ctl);
245
246         if (!(ctl & PCI_EXP_DPC_CTL_INT_EN) || ctl == (u16)(~0))
247                 return IRQ_NONE;
248
249         pci_read_config_word(pdev, cap + PCI_EXP_DPC_STATUS, &status);
250
251         if (!(status & PCI_EXP_DPC_STATUS_INTERRUPT))
252                 return IRQ_NONE;
253
254         if (!(status & PCI_EXP_DPC_STATUS_TRIGGER)) {
255                 pci_write_config_word(pdev, cap + PCI_EXP_DPC_STATUS,
256                                       PCI_EXP_DPC_STATUS_INTERRUPT);
257                 return IRQ_HANDLED;
258         }
259
260         pci_write_config_word(pdev, cap + PCI_EXP_DPC_CTL,
261                               ctl & ~PCI_EXP_DPC_CTL_INT_EN);
262
263         pci_read_config_word(pdev, cap + PCI_EXP_DPC_SOURCE_ID,
264                              &source);
265
266         dev_info(dev, "DPC containment event, status:%#06x source:%#06x\n",
267                 status, source);
268
269         reason = (status >> 1) & 0x3;
270         ext_reason = (status >> 5) & 0x3;
271
272         dev_warn(dev, "DPC %s detected, remove downstream devices\n",
273                  (reason == 0) ? "unmasked uncorrectable error" :
274                  (reason == 1) ? "ERR_NONFATAL" :
275                  (reason == 2) ? "ERR_FATAL" :
276                  (ext_reason == 0) ? "RP PIO error" :
277                  (ext_reason == 1) ? "software trigger" :
278                                      "reserved error");
279         /* show RP PIO error detail information */
280         if (dpc->rp_extensions && reason == 3 && ext_reason == 0)
281                 dpc_process_rp_pio_error(dpc);
282
283         schedule_work(&dpc->work);
284
285         return IRQ_HANDLED;
286 }
287
288 #define FLAG(x, y) (((x) & (y)) ? '+' : '-')
289 static int dpc_probe(struct pcie_device *dev)
290 {
291         struct dpc_dev *dpc;
292         struct pci_dev *pdev = dev->port;
293         struct device *device = &dev->device;
294         int status;
295         u16 ctl, cap;
296
297         if (pcie_aer_get_firmware_first(pdev))
298                 return -ENOTSUPP;
299
300         dpc = devm_kzalloc(device, sizeof(*dpc), GFP_KERNEL);
301         if (!dpc)
302                 return -ENOMEM;
303
304         dpc->cap_pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_DPC);
305         dpc->dev = dev;
306         INIT_WORK(&dpc->work, dpc_work);
307         set_service_data(dev, dpc);
308
309         status = devm_request_irq(device, dev->irq, dpc_irq, IRQF_SHARED,
310                                   "pcie-dpc", dpc);
311         if (status) {
312                 dev_warn(device, "request IRQ%d failed: %d\n", dev->irq,
313                          status);
314                 return status;
315         }
316
317         pci_read_config_word(pdev, dpc->cap_pos + PCI_EXP_DPC_CAP, &cap);
318         pci_read_config_word(pdev, dpc->cap_pos + PCI_EXP_DPC_CTL, &ctl);
319
320         dpc->rp_extensions = (cap & PCI_EXP_DPC_CAP_RP_EXT);
321         if (dpc->rp_extensions) {
322                 dpc->rp_log_size = (cap & PCI_EXP_DPC_RP_PIO_LOG_SIZE) >> 8;
323                 if (dpc->rp_log_size < 4 || dpc->rp_log_size > 9) {
324                         dev_err(device, "RP PIO log size %u is invalid\n",
325                                 dpc->rp_log_size);
326                         dpc->rp_log_size = 0;
327                 }
328         }
329
330         ctl = (ctl & 0xfff4) | PCI_EXP_DPC_CTL_EN_NONFATAL | PCI_EXP_DPC_CTL_INT_EN;
331         pci_write_config_word(pdev, dpc->cap_pos + PCI_EXP_DPC_CTL, ctl);
332
333         dev_info(device, "DPC error containment capabilities: Int Msg #%d, RPExt%c PoisonedTLP%c SwTrigger%c RP PIO Log %d, DL_ActiveErr%c\n",
334                 cap & PCI_EXP_DPC_IRQ, FLAG(cap, PCI_EXP_DPC_CAP_RP_EXT),
335                 FLAG(cap, PCI_EXP_DPC_CAP_POISONED_TLP),
336                 FLAG(cap, PCI_EXP_DPC_CAP_SW_TRIGGER), dpc->rp_log_size,
337                 FLAG(cap, PCI_EXP_DPC_CAP_DL_ACTIVE));
338         return status;
339 }
340
341 static void dpc_remove(struct pcie_device *dev)
342 {
343         struct dpc_dev *dpc = get_service_data(dev);
344         struct pci_dev *pdev = dev->port;
345         u16 ctl;
346
347         pci_read_config_word(pdev, dpc->cap_pos + PCI_EXP_DPC_CTL, &ctl);
348         ctl &= ~(PCI_EXP_DPC_CTL_EN_NONFATAL | PCI_EXP_DPC_CTL_INT_EN);
349         pci_write_config_word(pdev, dpc->cap_pos + PCI_EXP_DPC_CTL, ctl);
350 }
351
352 static struct pcie_port_service_driver dpcdriver = {
353         .name           = "dpc",
354         .port_type      = PCIE_ANY_PORT,
355         .service        = PCIE_PORT_SERVICE_DPC,
356         .probe          = dpc_probe,
357         .remove         = dpc_remove,
358 };
359
360 static int __init dpc_service_init(void)
361 {
362         return pcie_port_service_register(&dpcdriver);
363 }
364 device_initcall(dpc_service_init);