PCI/PM: Move pcie_clear_root_pme_status() to core
[muen/linux.git] / drivers / pci / pcie / portdrv_pci.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * File:        portdrv_pci.c
4  * Purpose:     PCI Express Port Bus Driver
5  * Author:      Tom Nguyen <tom.l.nguyen@intel.com>
6  * Version:     v1.0
7  *
8  * Copyright (C) 2004 Intel
9  * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
10  */
11
12 #include <linux/pci.h>
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/pm.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/init.h>
18 #include <linux/aer.h>
19 #include <linux/dmi.h>
20 #include <linux/pci-aspm.h>
21
22 #include "../pci.h"
23 #include "portdrv.h"
24
25 /* If this switch is set, PCIe port native services should not be enabled. */
26 bool pcie_ports_disabled;
27
28 /*
29  * If this switch is set, ACPI _OSC will be used to determine whether or not to
30  * enable PCIe port native services.
31  */
32 bool pcie_ports_auto = true;
33
34 static int __init pcie_port_setup(char *str)
35 {
36         if (!strncmp(str, "compat", 6)) {
37                 pcie_ports_disabled = true;
38         } else if (!strncmp(str, "native", 6)) {
39                 pcie_ports_disabled = false;
40                 pcie_ports_auto = false;
41         } else if (!strncmp(str, "auto", 4)) {
42                 pcie_ports_disabled = false;
43                 pcie_ports_auto = true;
44         }
45
46         return 1;
47 }
48 __setup("pcie_ports=", pcie_port_setup);
49
50 /* global data */
51
52 static int pcie_portdrv_restore_config(struct pci_dev *dev)
53 {
54         int retval;
55
56         retval = pci_enable_device(dev);
57         if (retval)
58                 return retval;
59         pci_set_master(dev);
60         return 0;
61 }
62
63 #ifdef CONFIG_PM
64 static int pcie_port_resume_noirq(struct device *dev)
65 {
66         struct pci_dev *pdev = to_pci_dev(dev);
67
68         /*
69          * Some BIOSes forget to clear Root PME Status bits after system wakeup
70          * which breaks ACPI-based runtime wakeup on PCI Express, so clear those
71          * bits now just in case (shouldn't hurt).
72          */
73         if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT)
74                 pcie_clear_root_pme_status(pdev);
75         return 0;
76 }
77
78 static int pcie_port_runtime_suspend(struct device *dev)
79 {
80         return to_pci_dev(dev)->bridge_d3 ? 0 : -EBUSY;
81 }
82
83 static int pcie_port_runtime_resume(struct device *dev)
84 {
85         return 0;
86 }
87
88 static int pcie_port_runtime_idle(struct device *dev)
89 {
90         /*
91          * Assume the PCI core has set bridge_d3 whenever it thinks the port
92          * should be good to go to D3.  Everything else, including moving
93          * the port to D3, is handled by the PCI core.
94          */
95         return to_pci_dev(dev)->bridge_d3 ? 0 : -EBUSY;
96 }
97
98 static const struct dev_pm_ops pcie_portdrv_pm_ops = {
99         .suspend        = pcie_port_device_suspend,
100         .resume         = pcie_port_device_resume,
101         .freeze         = pcie_port_device_suspend,
102         .thaw           = pcie_port_device_resume,
103         .poweroff       = pcie_port_device_suspend,
104         .restore        = pcie_port_device_resume,
105         .resume_noirq   = pcie_port_resume_noirq,
106         .runtime_suspend = pcie_port_runtime_suspend,
107         .runtime_resume = pcie_port_runtime_resume,
108         .runtime_idle   = pcie_port_runtime_idle,
109 };
110
111 #define PCIE_PORTDRV_PM_OPS     (&pcie_portdrv_pm_ops)
112
113 #else /* !PM */
114
115 #define PCIE_PORTDRV_PM_OPS     NULL
116 #endif /* !PM */
117
118 /*
119  * pcie_portdrv_probe - Probe PCI-Express port devices
120  * @dev: PCI-Express port device being probed
121  *
122  * If detected invokes the pcie_port_device_register() method for
123  * this port device.
124  *
125  */
126 static int pcie_portdrv_probe(struct pci_dev *dev,
127                                         const struct pci_device_id *id)
128 {
129         int status;
130
131         if (!pci_is_pcie(dev) ||
132             ((pci_pcie_type(dev) != PCI_EXP_TYPE_ROOT_PORT) &&
133              (pci_pcie_type(dev) != PCI_EXP_TYPE_UPSTREAM) &&
134              (pci_pcie_type(dev) != PCI_EXP_TYPE_DOWNSTREAM)))
135                 return -ENODEV;
136
137         status = pcie_port_device_register(dev);
138         if (status)
139                 return status;
140
141         pci_save_state(dev);
142
143         dev_pm_set_driver_flags(&dev->dev, DPM_FLAG_SMART_SUSPEND |
144                                            DPM_FLAG_LEAVE_SUSPENDED);
145
146         if (pci_bridge_d3_possible(dev)) {
147                 /*
148                  * Keep the port resumed 100ms to make sure things like
149                  * config space accesses from userspace (lspci) will not
150                  * cause the port to repeatedly suspend and resume.
151                  */
152                 pm_runtime_set_autosuspend_delay(&dev->dev, 100);
153                 pm_runtime_use_autosuspend(&dev->dev);
154                 pm_runtime_mark_last_busy(&dev->dev);
155                 pm_runtime_put_autosuspend(&dev->dev);
156                 pm_runtime_allow(&dev->dev);
157         }
158
159         return 0;
160 }
161
162 static void pcie_portdrv_remove(struct pci_dev *dev)
163 {
164         if (pci_bridge_d3_possible(dev)) {
165                 pm_runtime_forbid(&dev->dev);
166                 pm_runtime_get_noresume(&dev->dev);
167                 pm_runtime_dont_use_autosuspend(&dev->dev);
168         }
169
170         pcie_port_device_remove(dev);
171 }
172
173 static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
174                                         enum pci_channel_state error)
175 {
176         /* Root Port has no impact. Always recovers. */
177         return PCI_ERS_RESULT_CAN_RECOVER;
178 }
179
180 static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
181 {
182         return PCI_ERS_RESULT_RECOVERED;
183 }
184
185 static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
186 {
187         /* If fatal, restore cfg space for possible link reset at upstream */
188         if (dev->error_state == pci_channel_io_frozen) {
189                 dev->state_saved = true;
190                 pci_restore_state(dev);
191                 pcie_portdrv_restore_config(dev);
192                 pci_enable_pcie_error_reporting(dev);
193         }
194
195         return PCI_ERS_RESULT_RECOVERED;
196 }
197
198 static int resume_iter(struct device *device, void *data)
199 {
200         struct pcie_device *pcie_device;
201         struct pcie_port_service_driver *driver;
202
203         if (device->bus == &pcie_port_bus_type && device->driver) {
204                 driver = to_service_driver(device->driver);
205                 if (driver && driver->error_resume) {
206                         pcie_device = to_pcie_device(device);
207
208                         /* Forward error message to service drivers */
209                         driver->error_resume(pcie_device->port);
210                 }
211         }
212
213         return 0;
214 }
215
216 static void pcie_portdrv_err_resume(struct pci_dev *dev)
217 {
218         device_for_each_child(&dev->dev, NULL, resume_iter);
219 }
220
221 /*
222  * LINUX Device Driver Model
223  */
224 static const struct pci_device_id port_pci_ids[] = { {
225         /* handle any PCI-Express port */
226         PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0),
227         }, { /* end: all zeroes */ }
228 };
229
230 static const struct pci_error_handlers pcie_portdrv_err_handler = {
231         .error_detected = pcie_portdrv_error_detected,
232         .mmio_enabled = pcie_portdrv_mmio_enabled,
233         .slot_reset = pcie_portdrv_slot_reset,
234         .resume = pcie_portdrv_err_resume,
235 };
236
237 static struct pci_driver pcie_portdriver = {
238         .name           = "pcieport",
239         .id_table       = &port_pci_ids[0],
240
241         .probe          = pcie_portdrv_probe,
242         .remove         = pcie_portdrv_remove,
243         .shutdown       = pcie_portdrv_remove,
244
245         .err_handler    = &pcie_portdrv_err_handler,
246
247         .driver.pm      = PCIE_PORTDRV_PM_OPS,
248 };
249
250 static int __init dmi_pcie_pme_disable_msi(const struct dmi_system_id *d)
251 {
252         pr_notice("%s detected: will not use MSI for PCIe PME signaling\n",
253                   d->ident);
254         pcie_pme_disable_msi();
255         return 0;
256 }
257
258 static const struct dmi_system_id pcie_portdrv_dmi_table[] __initconst = {
259         /*
260          * Boxes that should not use MSI for PCIe PME signaling.
261          */
262         {
263          .callback = dmi_pcie_pme_disable_msi,
264          .ident = "MSI Wind U-100",
265          .matches = {
266                      DMI_MATCH(DMI_SYS_VENDOR,
267                                 "MICRO-STAR INTERNATIONAL CO., LTD"),
268                      DMI_MATCH(DMI_PRODUCT_NAME, "U-100"),
269                      },
270          },
271          {}
272 };
273
274 static int __init pcie_portdrv_init(void)
275 {
276         int retval;
277
278         if (pcie_ports_disabled)
279                 return pci_register_driver(&pcie_portdriver);
280
281         dmi_check_system(pcie_portdrv_dmi_table);
282
283         retval = pcie_port_bus_register();
284         if (retval) {
285                 printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
286                 goto out;
287         }
288         retval = pci_register_driver(&pcie_portdriver);
289         if (retval)
290                 pcie_port_bus_unregister();
291  out:
292         return retval;
293 }
294 device_initcall(pcie_portdrv_init);