PCI/portdrv: Rename and reverse sense of pcie_ports_auto
[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         int services = 0;
197
198         if (dev->is_hotplug_bridge &&
199             (pcie_ports_native || host->native_hotplug)) {
200                 services |= PCIE_PORT_SERVICE_HP;
201
202                 /*
203                  * Disable hot-plug interrupts in case they have been enabled
204                  * by the BIOS and the hot-plug service driver is not loaded.
205                  */
206                 pcie_capability_clear_word(dev, PCI_EXP_SLTCTL,
207                           PCI_EXP_SLTCTL_CCIE | PCI_EXP_SLTCTL_HPIE);
208         }
209
210         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ERR) &&
211             pci_aer_available() && (pcie_ports_native || host->native_aer)) {
212                 services |= PCIE_PORT_SERVICE_AER;
213
214                 /*
215                  * Disable AER on this port in case it's been enabled by the
216                  * BIOS (the AER service driver will enable it when necessary).
217                  */
218                 pci_disable_pcie_error_reporting(dev);
219         }
220
221         /*
222          * Root ports are capable of generating PME too.  Root Complex
223          * Event Collectors can also generate PMEs, but we don't handle
224          * those yet.
225          */
226         if (pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT &&
227             (pcie_ports_native || host->native_pme)) {
228                 services |= PCIE_PORT_SERVICE_PME;
229
230                 /*
231                  * Disable PME interrupt on this port in case it's been enabled
232                  * by the BIOS (the PME service driver will enable it when
233                  * necessary).
234                  */
235                 pcie_pme_interrupt_enable(dev, false);
236         }
237
238         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_DPC) &&
239             pci_aer_available())
240                 services |= PCIE_PORT_SERVICE_DPC;
241
242         return services;
243 }
244
245 /**
246  * pcie_device_init - allocate and initialize PCI Express port service device
247  * @pdev: PCI Express port to associate the service device with
248  * @service: Type of service to associate with the service device
249  * @irq: Interrupt vector to associate with the service device
250  */
251 static int pcie_device_init(struct pci_dev *pdev, int service, int irq)
252 {
253         int retval;
254         struct pcie_device *pcie;
255         struct device *device;
256
257         pcie = kzalloc(sizeof(*pcie), GFP_KERNEL);
258         if (!pcie)
259                 return -ENOMEM;
260         pcie->port = pdev;
261         pcie->irq = irq;
262         pcie->service = service;
263
264         /* Initialize generic device interface */
265         device = &pcie->device;
266         device->bus = &pcie_port_bus_type;
267         device->release = release_pcie_device;  /* callback to free pcie dev */
268         dev_set_name(device, "%s:pcie%03x",
269                      pci_name(pdev),
270                      get_descriptor_id(pci_pcie_type(pdev), service));
271         device->parent = &pdev->dev;
272         device_enable_async_suspend(device);
273
274         retval = device_register(device);
275         if (retval) {
276                 put_device(device);
277                 return retval;
278         }
279
280         pm_runtime_no_callbacks(device);
281
282         return 0;
283 }
284
285 /**
286  * pcie_port_device_register - register PCI Express port
287  * @dev: PCI Express port to register
288  *
289  * Allocate the port extension structure and register services associated with
290  * the port.
291  */
292 int pcie_port_device_register(struct pci_dev *dev)
293 {
294         int status, capabilities, i, nr_service;
295         int irqs[PCIE_PORT_DEVICE_MAXSERVICES];
296
297         /* Enable PCI Express port device */
298         status = pci_enable_device(dev);
299         if (status)
300                 return status;
301
302         /* Get and check PCI Express port services */
303         capabilities = get_port_device_capability(dev);
304         if (!capabilities)
305                 return 0;
306
307         pci_set_master(dev);
308         /*
309          * Initialize service irqs. Don't use service devices that
310          * require interrupts if there is no way to generate them.
311          * However, some drivers may have a polling mode (e.g. pciehp_poll_mode)
312          * that can be used in the absence of irqs.  Allow them to determine
313          * if that is to be used.
314          */
315         status = pcie_init_service_irqs(dev, irqs, capabilities);
316         if (status) {
317                 capabilities &= PCIE_PORT_SERVICE_HP;
318                 if (!capabilities)
319                         goto error_disable;
320         }
321
322         /* Allocate child services if any */
323         status = -ENODEV;
324         nr_service = 0;
325         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
326                 int service = 1 << i;
327                 if (!(capabilities & service))
328                         continue;
329                 if (!pcie_device_init(dev, service, irqs[i]))
330                         nr_service++;
331         }
332         if (!nr_service)
333                 goto error_cleanup_irqs;
334
335         return 0;
336
337 error_cleanup_irqs:
338         pci_free_irq_vectors(dev);
339 error_disable:
340         pci_disable_device(dev);
341         return status;
342 }
343
344 #ifdef CONFIG_PM
345 static int suspend_iter(struct device *dev, void *data)
346 {
347         struct pcie_port_service_driver *service_driver;
348
349         if ((dev->bus == &pcie_port_bus_type) && dev->driver) {
350                 service_driver = to_service_driver(dev->driver);
351                 if (service_driver->suspend)
352                         service_driver->suspend(to_pcie_device(dev));
353         }
354         return 0;
355 }
356
357 /**
358  * pcie_port_device_suspend - suspend port services associated with a PCIe port
359  * @dev: PCI Express port to handle
360  */
361 int pcie_port_device_suspend(struct device *dev)
362 {
363         return device_for_each_child(dev, NULL, suspend_iter);
364 }
365
366 static int resume_iter(struct device *dev, void *data)
367 {
368         struct pcie_port_service_driver *service_driver;
369
370         if ((dev->bus == &pcie_port_bus_type) &&
371             (dev->driver)) {
372                 service_driver = to_service_driver(dev->driver);
373                 if (service_driver->resume)
374                         service_driver->resume(to_pcie_device(dev));
375         }
376         return 0;
377 }
378
379 /**
380  * pcie_port_device_resume - resume port services associated with a PCIe port
381  * @dev: PCI Express port to handle
382  */
383 int pcie_port_device_resume(struct device *dev)
384 {
385         return device_for_each_child(dev, NULL, resume_iter);
386 }
387 #endif /* PM */
388
389 static int remove_iter(struct device *dev, void *data)
390 {
391         if (dev->bus == &pcie_port_bus_type)
392                 device_unregister(dev);
393         return 0;
394 }
395
396 /**
397  * pcie_port_device_remove - unregister PCI Express port service devices
398  * @dev: PCI Express port the service devices to unregister are associated with
399  *
400  * Remove PCI Express port service devices associated with given port and
401  * disable MSI-X or MSI for the port.
402  */
403 void pcie_port_device_remove(struct pci_dev *dev)
404 {
405         device_for_each_child(&dev->dev, NULL, remove_iter);
406         pci_free_irq_vectors(dev);
407         pci_disable_device(dev);
408 }
409
410 /**
411  * pcie_port_probe_service - probe driver for given PCI Express port service
412  * @dev: PCI Express port service device to probe against
413  *
414  * If PCI Express port service driver is registered with
415  * pcie_port_service_register(), this function will be called by the driver core
416  * whenever match is found between the driver and a port service device.
417  */
418 static int pcie_port_probe_service(struct device *dev)
419 {
420         struct pcie_device *pciedev;
421         struct pcie_port_service_driver *driver;
422         int status;
423
424         if (!dev || !dev->driver)
425                 return -ENODEV;
426
427         driver = to_service_driver(dev->driver);
428         if (!driver || !driver->probe)
429                 return -ENODEV;
430
431         pciedev = to_pcie_device(dev);
432         status = driver->probe(pciedev);
433         if (status)
434                 return status;
435
436         get_device(dev);
437         return 0;
438 }
439
440 /**
441  * pcie_port_remove_service - detach driver from given PCI Express port service
442  * @dev: PCI Express port service device to handle
443  *
444  * If PCI Express port service driver is registered with
445  * pcie_port_service_register(), this function will be called by the driver core
446  * when device_unregister() is called for the port service device associated
447  * with the driver.
448  */
449 static int pcie_port_remove_service(struct device *dev)
450 {
451         struct pcie_device *pciedev;
452         struct pcie_port_service_driver *driver;
453
454         if (!dev || !dev->driver)
455                 return 0;
456
457         pciedev = to_pcie_device(dev);
458         driver = to_service_driver(dev->driver);
459         if (driver && driver->remove) {
460                 driver->remove(pciedev);
461                 put_device(dev);
462         }
463         return 0;
464 }
465
466 /**
467  * pcie_port_shutdown_service - shut down given PCI Express port service
468  * @dev: PCI Express port service device to handle
469  *
470  * If PCI Express port service driver is registered with
471  * pcie_port_service_register(), this function will be called by the driver core
472  * when device_shutdown() is called for the port service device associated
473  * with the driver.
474  */
475 static void pcie_port_shutdown_service(struct device *dev) {}
476
477 /**
478  * pcie_port_service_register - register PCI Express port service driver
479  * @new: PCI Express port service driver to register
480  */
481 int pcie_port_service_register(struct pcie_port_service_driver *new)
482 {
483         if (pcie_ports_disabled)
484                 return -ENODEV;
485
486         new->driver.name = new->name;
487         new->driver.bus = &pcie_port_bus_type;
488         new->driver.probe = pcie_port_probe_service;
489         new->driver.remove = pcie_port_remove_service;
490         new->driver.shutdown = pcie_port_shutdown_service;
491
492         return driver_register(&new->driver);
493 }
494 EXPORT_SYMBOL(pcie_port_service_register);
495
496 /**
497  * pcie_port_service_unregister - unregister PCI Express port service driver
498  * @drv: PCI Express port service driver to unregister
499  */
500 void pcie_port_service_unregister(struct pcie_port_service_driver *drv)
501 {
502         driver_unregister(&drv->driver);
503 }
504 EXPORT_SYMBOL(pcie_port_service_unregister);