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