PCI/AER: Use cached AER Capability offset
[muen/linux.git] / drivers / pci / pcie / portdrv_core.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * File:        portdrv_core.c
4  * Purpose:     PCI Express Port Bus Driver's Core Functions
5  *
6  * Copyright (C) 2004 Intel
7  * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
8  */
9
10 #include <linux/module.h>
11 #include <linux/pci.h>
12 #include <linux/kernel.h>
13 #include <linux/errno.h>
14 #include <linux/pm.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/string.h>
17 #include <linux/slab.h>
18 #include <linux/aer.h>
19
20 #include "../pci.h"
21 #include "portdrv.h"
22
23 /**
24  * release_pcie_device - free PCI Express port service device structure
25  * @dev: Port service device to release
26  *
27  * Invoked automatically when device is being removed in response to
28  * device_unregister(dev).  Release all resources being claimed.
29  */
30 static void release_pcie_device(struct device *dev)
31 {
32         kfree(to_pcie_device(dev));
33 }
34
35 /*
36  * Fill in *pme, *aer, *dpc with the relevant Interrupt Message Numbers if
37  * services are enabled in "mask".  Return the number of MSI/MSI-X vectors
38  * required to accommodate the largest Message Number.
39  */
40 static int pcie_message_numbers(struct pci_dev *dev, int mask,
41                                 u32 *pme, u32 *aer, u32 *dpc)
42 {
43         u32 nvec = 0, pos;
44         u16 reg16;
45
46         /*
47          * The Interrupt Message Number indicates which vector is used, i.e.,
48          * the MSI-X table entry or the MSI offset between the base Message
49          * Data and the generated interrupt message.  See PCIe r3.1, sec
50          * 7.8.2, 7.10.10, 7.31.2.
51          */
52
53         if (mask & (PCIE_PORT_SERVICE_PME | PCIE_PORT_SERVICE_HP)) {
54                 pcie_capability_read_word(dev, PCI_EXP_FLAGS, &reg16);
55                 *pme = (reg16 & PCI_EXP_FLAGS_IRQ) >> 9;
56                 nvec = *pme + 1;
57         }
58
59 #ifdef CONFIG_PCIEAER
60         if (mask & PCIE_PORT_SERVICE_AER) {
61                 u32 reg32;
62
63                 pos = dev->aer_cap;
64                 if (pos) {
65                         pci_read_config_dword(dev, pos + PCI_ERR_ROOT_STATUS,
66                                               &reg32);
67                         *aer = (reg32 & PCI_ERR_ROOT_AER_IRQ) >> 27;
68                         nvec = max(nvec, *aer + 1);
69                 }
70         }
71 #endif
72
73         if (mask & PCIE_PORT_SERVICE_DPC) {
74                 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_DPC);
75                 if (pos) {
76                         pci_read_config_word(dev, pos + PCI_EXP_DPC_CAP,
77                                              &reg16);
78                         *dpc = reg16 & PCI_EXP_DPC_IRQ;
79                         nvec = max(nvec, *dpc + 1);
80                 }
81         }
82
83         return nvec;
84 }
85
86 /**
87  * pcie_port_enable_irq_vec - try to set up MSI-X or MSI as interrupt mode
88  * for given port
89  * @dev: PCI Express port to handle
90  * @irqs: Array of interrupt vectors to populate
91  * @mask: Bitmask of port capabilities returned by get_port_device_capability()
92  *
93  * Return value: 0 on success, error code on failure
94  */
95 static int pcie_port_enable_irq_vec(struct pci_dev *dev, int *irqs, int mask)
96 {
97         int nr_entries, nvec;
98         u32 pme = 0, aer = 0, dpc = 0;
99
100         /* Allocate the maximum possible number of MSI/MSI-X vectors */
101         nr_entries = pci_alloc_irq_vectors(dev, 1, PCIE_PORT_MAX_MSI_ENTRIES,
102                         PCI_IRQ_MSIX | PCI_IRQ_MSI);
103         if (nr_entries < 0)
104                 return nr_entries;
105
106         /* See how many and which Interrupt Message Numbers we actually use */
107         nvec = pcie_message_numbers(dev, mask, &pme, &aer, &dpc);
108         if (nvec > nr_entries) {
109                 pci_free_irq_vectors(dev);
110                 return -EIO;
111         }
112
113         /*
114          * If we allocated more than we need, free them and reallocate fewer.
115          *
116          * Reallocating may change the specific vectors we get, so
117          * pci_irq_vector() must be done *after* the reallocation.
118          *
119          * If we're using MSI, hardware is *allowed* to change the Interrupt
120          * Message Numbers when we free and reallocate the vectors, but we
121          * assume it won't because we allocate enough vectors for the
122          * biggest Message Number we found.
123          */
124         if (nvec != nr_entries) {
125                 pci_free_irq_vectors(dev);
126
127                 nr_entries = pci_alloc_irq_vectors(dev, nvec, nvec,
128                                 PCI_IRQ_MSIX | PCI_IRQ_MSI);
129                 if (nr_entries < 0)
130                         return nr_entries;
131         }
132
133         /* PME and hotplug share an MSI/MSI-X vector */
134         if (mask & (PCIE_PORT_SERVICE_PME | PCIE_PORT_SERVICE_HP)) {
135                 irqs[PCIE_PORT_SERVICE_PME_SHIFT] = pci_irq_vector(dev, pme);
136                 irqs[PCIE_PORT_SERVICE_HP_SHIFT] = pci_irq_vector(dev, pme);
137         }
138
139         if (mask & PCIE_PORT_SERVICE_AER)
140                 irqs[PCIE_PORT_SERVICE_AER_SHIFT] = pci_irq_vector(dev, aer);
141
142         if (mask & PCIE_PORT_SERVICE_DPC)
143                 irqs[PCIE_PORT_SERVICE_DPC_SHIFT] = pci_irq_vector(dev, dpc);
144
145         return 0;
146 }
147
148 /**
149  * pcie_init_service_irqs - initialize irqs for PCI Express port services
150  * @dev: PCI Express port to handle
151  * @irqs: Array of irqs to populate
152  * @mask: Bitmask of port capabilities returned by get_port_device_capability()
153  *
154  * Return value: Interrupt mode associated with the port
155  */
156 static int pcie_init_service_irqs(struct pci_dev *dev, int *irqs, int mask)
157 {
158         int ret, i;
159
160         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++)
161                 irqs[i] = -1;
162
163         /*
164          * If we support PME but can't use MSI/MSI-X for it, we have to
165          * fall back to INTx or other interrupts, e.g., a system shared
166          * interrupt.
167          */
168         if ((mask & PCIE_PORT_SERVICE_PME) && pcie_pme_no_msi())
169                 goto legacy_irq;
170
171         /* Try to use MSI-X or MSI if supported */
172         if (pcie_port_enable_irq_vec(dev, irqs, mask) == 0)
173                 return 0;
174
175 legacy_irq:
176         /* fall back to legacy IRQ */
177         ret = pci_alloc_irq_vectors(dev, 1, 1, PCI_IRQ_LEGACY);
178         if (ret < 0)
179                 return -ENODEV;
180
181         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++)
182                 irqs[i] = pci_irq_vector(dev, 0);
183
184         return 0;
185 }
186
187 /**
188  * get_port_device_capability - discover capabilities of a PCI Express port
189  * @dev: PCI Express port to examine
190  *
191  * The capabilities are read from the port's PCI Express configuration registers
192  * as described in PCI Express Base Specification 1.0a sections 7.8.2, 7.8.9 and
193  * 7.9 - 7.11.
194  *
195  * Return value: Bitmask of discovered port capabilities
196  */
197 static int get_port_device_capability(struct pci_dev *dev)
198 {
199         struct pci_host_bridge *host = pci_find_host_bridge(dev->bus);
200         int services = 0;
201
202         if (dev->is_hotplug_bridge &&
203             (pcie_ports_native || host->native_hotplug)) {
204                 services |= PCIE_PORT_SERVICE_HP;
205
206                 /*
207                  * Disable hot-plug interrupts in case they have been enabled
208                  * by the BIOS and the hot-plug service driver is not loaded.
209                  */
210                 pcie_capability_clear_word(dev, PCI_EXP_SLTCTL,
211                           PCI_EXP_SLTCTL_CCIE | PCI_EXP_SLTCTL_HPIE);
212         }
213
214 #ifdef CONFIG_PCIEAER
215         if (dev->aer_cap && pci_aer_available() &&
216             (pcie_ports_native || host->native_aer)) {
217                 services |= PCIE_PORT_SERVICE_AER;
218
219                 /*
220                  * Disable AER on this port in case it's been enabled by the
221                  * BIOS (the AER service driver will enable it when necessary).
222                  */
223                 pci_disable_pcie_error_reporting(dev);
224         }
225 #endif
226
227         /*
228          * Root ports are capable of generating PME too.  Root Complex
229          * Event Collectors can also generate PMEs, but we don't handle
230          * those yet.
231          */
232         if (pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT &&
233             (pcie_ports_native || host->native_pme)) {
234                 services |= PCIE_PORT_SERVICE_PME;
235
236                 /*
237                  * Disable PME interrupt on this port in case it's been enabled
238                  * by the BIOS (the PME service driver will enable it when
239                  * necessary).
240                  */
241                 pcie_pme_interrupt_enable(dev, false);
242         }
243
244         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_DPC) &&
245             pci_aer_available())
246                 services |= PCIE_PORT_SERVICE_DPC;
247
248         return services;
249 }
250
251 /**
252  * pcie_device_init - allocate and initialize PCI Express port service device
253  * @pdev: PCI Express port to associate the service device with
254  * @service: Type of service to associate with the service device
255  * @irq: Interrupt vector to associate with the service device
256  */
257 static int pcie_device_init(struct pci_dev *pdev, int service, int irq)
258 {
259         int retval;
260         struct pcie_device *pcie;
261         struct device *device;
262
263         pcie = kzalloc(sizeof(*pcie), GFP_KERNEL);
264         if (!pcie)
265                 return -ENOMEM;
266         pcie->port = pdev;
267         pcie->irq = irq;
268         pcie->service = service;
269
270         /* Initialize generic device interface */
271         device = &pcie->device;
272         device->bus = &pcie_port_bus_type;
273         device->release = release_pcie_device;  /* callback to free pcie dev */
274         dev_set_name(device, "%s:pcie%03x",
275                      pci_name(pdev),
276                      get_descriptor_id(pci_pcie_type(pdev), service));
277         device->parent = &pdev->dev;
278         device_enable_async_suspend(device);
279
280         retval = device_register(device);
281         if (retval) {
282                 put_device(device);
283                 return retval;
284         }
285
286         pm_runtime_no_callbacks(device);
287
288         return 0;
289 }
290
291 /**
292  * pcie_port_device_register - register PCI Express port
293  * @dev: PCI Express port to register
294  *
295  * Allocate the port extension structure and register services associated with
296  * the port.
297  */
298 int pcie_port_device_register(struct pci_dev *dev)
299 {
300         int status, capabilities, i, nr_service;
301         int irqs[PCIE_PORT_DEVICE_MAXSERVICES];
302
303         /* Enable PCI Express port device */
304         status = pci_enable_device(dev);
305         if (status)
306                 return status;
307
308         /* Get and check PCI Express port services */
309         capabilities = get_port_device_capability(dev);
310         if (!capabilities)
311                 return 0;
312
313         pci_set_master(dev);
314         /*
315          * Initialize service irqs. Don't use service devices that
316          * require interrupts if there is no way to generate them.
317          * However, some drivers may have a polling mode (e.g. pciehp_poll_mode)
318          * that can be used in the absence of irqs.  Allow them to determine
319          * if that is to be used.
320          */
321         status = pcie_init_service_irqs(dev, irqs, capabilities);
322         if (status) {
323                 capabilities &= PCIE_PORT_SERVICE_HP;
324                 if (!capabilities)
325                         goto error_disable;
326         }
327
328         /* Allocate child services if any */
329         status = -ENODEV;
330         nr_service = 0;
331         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
332                 int service = 1 << i;
333                 if (!(capabilities & service))
334                         continue;
335                 if (!pcie_device_init(dev, service, irqs[i]))
336                         nr_service++;
337         }
338         if (!nr_service)
339                 goto error_cleanup_irqs;
340
341         return 0;
342
343 error_cleanup_irqs:
344         pci_free_irq_vectors(dev);
345 error_disable:
346         pci_disable_device(dev);
347         return status;
348 }
349
350 #ifdef CONFIG_PM
351 static int suspend_iter(struct device *dev, void *data)
352 {
353         struct pcie_port_service_driver *service_driver;
354
355         if ((dev->bus == &pcie_port_bus_type) && dev->driver) {
356                 service_driver = to_service_driver(dev->driver);
357                 if (service_driver->suspend)
358                         service_driver->suspend(to_pcie_device(dev));
359         }
360         return 0;
361 }
362
363 /**
364  * pcie_port_device_suspend - suspend port services associated with a PCIe port
365  * @dev: PCI Express port to handle
366  */
367 int pcie_port_device_suspend(struct device *dev)
368 {
369         return device_for_each_child(dev, NULL, suspend_iter);
370 }
371
372 static int resume_iter(struct device *dev, void *data)
373 {
374         struct pcie_port_service_driver *service_driver;
375
376         if ((dev->bus == &pcie_port_bus_type) &&
377             (dev->driver)) {
378                 service_driver = to_service_driver(dev->driver);
379                 if (service_driver->resume)
380                         service_driver->resume(to_pcie_device(dev));
381         }
382         return 0;
383 }
384
385 /**
386  * pcie_port_device_resume - resume port services associated with a PCIe port
387  * @dev: PCI Express port to handle
388  */
389 int pcie_port_device_resume(struct device *dev)
390 {
391         return device_for_each_child(dev, NULL, resume_iter);
392 }
393 #endif /* PM */
394
395 static int remove_iter(struct device *dev, void *data)
396 {
397         if (dev->bus == &pcie_port_bus_type)
398                 device_unregister(dev);
399         return 0;
400 }
401
402 /**
403  * pcie_port_device_remove - unregister PCI Express port service devices
404  * @dev: PCI Express port the service devices to unregister are associated with
405  *
406  * Remove PCI Express port service devices associated with given port and
407  * disable MSI-X or MSI for the port.
408  */
409 void pcie_port_device_remove(struct pci_dev *dev)
410 {
411         device_for_each_child(&dev->dev, NULL, remove_iter);
412         pci_free_irq_vectors(dev);
413         pci_disable_device(dev);
414 }
415
416 /**
417  * pcie_port_probe_service - probe driver for given PCI Express port service
418  * @dev: PCI Express port service device to probe against
419  *
420  * If PCI Express port service driver is registered with
421  * pcie_port_service_register(), this function will be called by the driver core
422  * whenever match is found between the driver and a port service device.
423  */
424 static int pcie_port_probe_service(struct device *dev)
425 {
426         struct pcie_device *pciedev;
427         struct pcie_port_service_driver *driver;
428         int status;
429
430         if (!dev || !dev->driver)
431                 return -ENODEV;
432
433         driver = to_service_driver(dev->driver);
434         if (!driver || !driver->probe)
435                 return -ENODEV;
436
437         pciedev = to_pcie_device(dev);
438         status = driver->probe(pciedev);
439         if (status)
440                 return status;
441
442         get_device(dev);
443         return 0;
444 }
445
446 /**
447  * pcie_port_remove_service - detach driver from given PCI Express port service
448  * @dev: PCI Express port service device to handle
449  *
450  * If PCI Express port service driver is registered with
451  * pcie_port_service_register(), this function will be called by the driver core
452  * when device_unregister() is called for the port service device associated
453  * with the driver.
454  */
455 static int pcie_port_remove_service(struct device *dev)
456 {
457         struct pcie_device *pciedev;
458         struct pcie_port_service_driver *driver;
459
460         if (!dev || !dev->driver)
461                 return 0;
462
463         pciedev = to_pcie_device(dev);
464         driver = to_service_driver(dev->driver);
465         if (driver && driver->remove) {
466                 driver->remove(pciedev);
467                 put_device(dev);
468         }
469         return 0;
470 }
471
472 /**
473  * pcie_port_shutdown_service - shut down given PCI Express port service
474  * @dev: PCI Express port service device to handle
475  *
476  * If PCI Express port service driver is registered with
477  * pcie_port_service_register(), this function will be called by the driver core
478  * when device_shutdown() is called for the port service device associated
479  * with the driver.
480  */
481 static void pcie_port_shutdown_service(struct device *dev) {}
482
483 /**
484  * pcie_port_service_register - register PCI Express port service driver
485  * @new: PCI Express port service driver to register
486  */
487 int pcie_port_service_register(struct pcie_port_service_driver *new)
488 {
489         if (pcie_ports_disabled)
490                 return -ENODEV;
491
492         new->driver.name = new->name;
493         new->driver.bus = &pcie_port_bus_type;
494         new->driver.probe = pcie_port_probe_service;
495         new->driver.remove = pcie_port_remove_service;
496         new->driver.shutdown = pcie_port_shutdown_service;
497
498         return driver_register(&new->driver);
499 }
500 EXPORT_SYMBOL(pcie_port_service_register);
501
502 /**
503  * pcie_port_service_unregister - unregister PCI Express port service driver
504  * @drv: PCI Express port service driver to unregister
505  */
506 void pcie_port_service_unregister(struct pcie_port_service_driver *drv)
507 {
508         driver_unregister(&drv->driver);
509 }
510 EXPORT_SYMBOL(pcie_port_service_unregister);