3 * Purpose: PCI Express Port Bus Driver
5 * Copyright (C) 2004 Intel
6 * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
9 #include <linux/module.h>
10 #include <linux/pci.h>
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/init.h>
16 #include <linux/pcieport_if.h>
17 #include <linux/aer.h>
18 #include <linux/dmi.h>
19 #include <linux/pci-aspm.h>
22 #include "aer/aerdrv.h"
27 #define DRIVER_VERSION "v1.0"
28 #define DRIVER_AUTHOR "tom.l.nguyen@intel.com"
29 #define DRIVER_DESC "PCIe Port Bus Driver"
30 MODULE_AUTHOR(DRIVER_AUTHOR
);
31 MODULE_DESCRIPTION(DRIVER_DESC
);
32 MODULE_LICENSE("GPL");
34 /* If this switch is set, PCIe port native services should not be enabled. */
35 bool pcie_ports_disabled
;
38 * If this switch is set, ACPI _OSC will be used to determine whether or not to
39 * enable PCIe port native services.
41 bool pcie_ports_auto
= true;
43 static int __init
pcie_port_setup(char *str
)
45 if (!strncmp(str
, "compat", 6)) {
46 pcie_ports_disabled
= true;
47 } else if (!strncmp(str
, "native", 6)) {
48 pcie_ports_disabled
= false;
49 pcie_ports_auto
= false;
50 } else if (!strncmp(str
, "auto", 4)) {
51 pcie_ports_disabled
= false;
52 pcie_ports_auto
= true;
57 __setup("pcie_ports=", pcie_port_setup
);
62 * pcie_clear_root_pme_status - Clear root port PME interrupt status.
63 * @dev: PCIe root port or event collector.
65 void pcie_clear_root_pme_status(struct pci_dev
*dev
)
67 pcie_capability_set_dword(dev
, PCI_EXP_RTSTA
, PCI_EXP_RTSTA_PME
);
70 static int pcie_portdrv_restore_config(struct pci_dev
*dev
)
74 retval
= pci_enable_device(dev
);
82 static int pcie_port_resume_noirq(struct device
*dev
)
84 struct pci_dev
*pdev
= to_pci_dev(dev
);
87 * Some BIOSes forget to clear Root PME Status bits after system wakeup
88 * which breaks ACPI-based runtime wakeup on PCI Express, so clear those
89 * bits now just in case (shouldn't hurt).
91 if (pci_pcie_type(pdev
) == PCI_EXP_TYPE_ROOT_PORT
)
92 pcie_clear_root_pme_status(pdev
);
96 #ifdef CONFIG_PM_RUNTIME
99 unsigned int d3cold_delay
;
102 static int pci_dev_d3cold_info(struct pci_dev
*pdev
, void *data
)
104 struct d3cold_info
*info
= data
;
106 info
->d3cold_delay
= max_t(unsigned int, pdev
->d3cold_delay
,
109 info
->no_d3cold
= true;
113 static int pcie_port_runtime_suspend(struct device
*dev
)
115 struct pci_dev
*pdev
= to_pci_dev(dev
);
116 struct d3cold_info d3cold_info
= {
118 .d3cold_delay
= PCI_PM_D3_WAIT
,
122 * If any subordinate device disable D3cold, we should not put
123 * the port into D3cold. The D3cold delay of port should be
124 * the max of that of all subordinate devices.
126 pci_walk_bus(pdev
->subordinate
, pci_dev_d3cold_info
, &d3cold_info
);
127 pdev
->no_d3cold
= d3cold_info
.no_d3cold
;
128 pdev
->d3cold_delay
= d3cold_info
.d3cold_delay
;
132 static int pcie_port_runtime_resume(struct device
*dev
)
137 static int pci_dev_pme_poll(struct pci_dev
*pdev
, void *data
)
139 bool *pme_poll
= data
;
146 static int pcie_port_runtime_idle(struct device
*dev
)
148 struct pci_dev
*pdev
= to_pci_dev(dev
);
149 bool pme_poll
= false;
152 * If any subordinate device needs pme poll, we should keep
153 * the port in D0, because we need port in D0 to poll it.
155 pci_walk_bus(pdev
->subordinate
, pci_dev_pme_poll
, &pme_poll
);
156 /* Delay for a short while to prevent too frequent suspend/resume */
158 pm_schedule_suspend(dev
, 10);
162 #define pcie_port_runtime_suspend NULL
163 #define pcie_port_runtime_resume NULL
164 #define pcie_port_runtime_idle NULL
167 static const struct dev_pm_ops pcie_portdrv_pm_ops
= {
168 .suspend
= pcie_port_device_suspend
,
169 .resume
= pcie_port_device_resume
,
170 .freeze
= pcie_port_device_suspend
,
171 .thaw
= pcie_port_device_resume
,
172 .poweroff
= pcie_port_device_suspend
,
173 .restore
= pcie_port_device_resume
,
174 .resume_noirq
= pcie_port_resume_noirq
,
175 .runtime_suspend
= pcie_port_runtime_suspend
,
176 .runtime_resume
= pcie_port_runtime_resume
,
177 .runtime_idle
= pcie_port_runtime_idle
,
180 #define PCIE_PORTDRV_PM_OPS (&pcie_portdrv_pm_ops)
184 #define PCIE_PORTDRV_PM_OPS NULL
188 * pcie_portdrv_probe - Probe PCI-Express port devices
189 * @dev: PCI-Express port device being probed
191 * If detected invokes the pcie_port_device_register() method for
195 static int pcie_portdrv_probe(struct pci_dev
*dev
,
196 const struct pci_device_id
*id
)
200 if (!pci_is_pcie(dev
) ||
201 ((pci_pcie_type(dev
) != PCI_EXP_TYPE_ROOT_PORT
) &&
202 (pci_pcie_type(dev
) != PCI_EXP_TYPE_UPSTREAM
) &&
203 (pci_pcie_type(dev
) != PCI_EXP_TYPE_DOWNSTREAM
)))
206 if (!dev
->irq
&& dev
->pin
) {
207 dev_warn(&dev
->dev
, "device [%04x:%04x] has invalid IRQ; "
208 "check vendor BIOS\n", dev
->vendor
, dev
->device
);
210 status
= pcie_port_device_register(dev
);
216 * D3cold may not work properly on some PCIe port, so disable
219 dev
->d3cold_allowed
= false;
223 static void pcie_portdrv_remove(struct pci_dev
*dev
)
225 pcie_port_device_remove(dev
);
226 pci_disable_device(dev
);
229 static int error_detected_iter(struct device
*device
, void *data
)
231 struct pcie_device
*pcie_device
;
232 struct pcie_port_service_driver
*driver
;
233 struct aer_broadcast_data
*result_data
;
234 pci_ers_result_t status
;
236 result_data
= (struct aer_broadcast_data
*) data
;
238 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
239 driver
= to_service_driver(device
->driver
);
241 !driver
->err_handler
||
242 !driver
->err_handler
->error_detected
)
245 pcie_device
= to_pcie_device(device
);
247 /* Forward error detected message to service drivers */
248 status
= driver
->err_handler
->error_detected(
251 result_data
->result
=
252 merge_result(result_data
->result
, status
);
258 static pci_ers_result_t
pcie_portdrv_error_detected(struct pci_dev
*dev
,
259 enum pci_channel_state error
)
261 struct aer_broadcast_data data
= {error
, PCI_ERS_RESULT_CAN_RECOVER
};
263 /* get true return value from &data */
264 device_for_each_child(&dev
->dev
, &data
, error_detected_iter
);
268 static int mmio_enabled_iter(struct device
*device
, void *data
)
270 struct pcie_device
*pcie_device
;
271 struct pcie_port_service_driver
*driver
;
272 pci_ers_result_t status
, *result
;
274 result
= (pci_ers_result_t
*) data
;
276 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
277 driver
= to_service_driver(device
->driver
);
279 driver
->err_handler
&&
280 driver
->err_handler
->mmio_enabled
) {
281 pcie_device
= to_pcie_device(device
);
283 /* Forward error message to service drivers */
284 status
= driver
->err_handler
->mmio_enabled(
286 *result
= merge_result(*result
, status
);
293 static pci_ers_result_t
pcie_portdrv_mmio_enabled(struct pci_dev
*dev
)
295 pci_ers_result_t status
= PCI_ERS_RESULT_RECOVERED
;
297 /* get true return value from &status */
298 device_for_each_child(&dev
->dev
, &status
, mmio_enabled_iter
);
302 static int slot_reset_iter(struct device
*device
, void *data
)
304 struct pcie_device
*pcie_device
;
305 struct pcie_port_service_driver
*driver
;
306 pci_ers_result_t status
, *result
;
308 result
= (pci_ers_result_t
*) data
;
310 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
311 driver
= to_service_driver(device
->driver
);
313 driver
->err_handler
&&
314 driver
->err_handler
->slot_reset
) {
315 pcie_device
= to_pcie_device(device
);
317 /* Forward error message to service drivers */
318 status
= driver
->err_handler
->slot_reset(
320 *result
= merge_result(*result
, status
);
327 static pci_ers_result_t
pcie_portdrv_slot_reset(struct pci_dev
*dev
)
329 pci_ers_result_t status
= PCI_ERS_RESULT_RECOVERED
;
331 /* If fatal, restore cfg space for possible link reset at upstream */
332 if (dev
->error_state
== pci_channel_io_frozen
) {
333 dev
->state_saved
= true;
334 pci_restore_state(dev
);
335 pcie_portdrv_restore_config(dev
);
336 pci_enable_pcie_error_reporting(dev
);
339 /* get true return value from &status */
340 device_for_each_child(&dev
->dev
, &status
, slot_reset_iter
);
344 static int resume_iter(struct device
*device
, void *data
)
346 struct pcie_device
*pcie_device
;
347 struct pcie_port_service_driver
*driver
;
349 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
350 driver
= to_service_driver(device
->driver
);
352 driver
->err_handler
&&
353 driver
->err_handler
->resume
) {
354 pcie_device
= to_pcie_device(device
);
356 /* Forward error message to service drivers */
357 driver
->err_handler
->resume(pcie_device
->port
);
364 static void pcie_portdrv_err_resume(struct pci_dev
*dev
)
366 device_for_each_child(&dev
->dev
, NULL
, resume_iter
);
370 * LINUX Device Driver Model
372 static const struct pci_device_id port_pci_ids
[] = { {
373 /* handle any PCI-Express port */
374 PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI
<< 8) | 0x00), ~0),
375 }, { /* end: all zeroes */ }
377 MODULE_DEVICE_TABLE(pci
, port_pci_ids
);
379 static const struct pci_error_handlers pcie_portdrv_err_handler
= {
380 .error_detected
= pcie_portdrv_error_detected
,
381 .mmio_enabled
= pcie_portdrv_mmio_enabled
,
382 .slot_reset
= pcie_portdrv_slot_reset
,
383 .resume
= pcie_portdrv_err_resume
,
386 static struct pci_driver pcie_portdriver
= {
388 .id_table
= &port_pci_ids
[0],
390 .probe
= pcie_portdrv_probe
,
391 .remove
= pcie_portdrv_remove
,
393 .err_handler
= &pcie_portdrv_err_handler
,
395 .driver
.pm
= PCIE_PORTDRV_PM_OPS
,
398 static int __init
dmi_pcie_pme_disable_msi(const struct dmi_system_id
*d
)
400 pr_notice("%s detected: will not use MSI for PCIe PME signaling\n",
402 pcie_pme_disable_msi();
406 static struct dmi_system_id __initdata pcie_portdrv_dmi_table
[] = {
408 * Boxes that should not use MSI for PCIe PME signaling.
411 .callback
= dmi_pcie_pme_disable_msi
,
412 .ident
= "MSI Wind U-100",
414 DMI_MATCH(DMI_SYS_VENDOR
,
415 "MICRO-STAR INTERNATIONAL CO., LTD"),
416 DMI_MATCH(DMI_PRODUCT_NAME
, "U-100"),
422 static int __init
pcie_portdrv_init(void)
426 if (pcie_ports_disabled
)
427 return pci_register_driver(&pcie_portdriver
);
429 dmi_check_system(pcie_portdrv_dmi_table
);
431 retval
= pcie_port_bus_register();
433 printk(KERN_WARNING
"PCIE: bus_register error: %d\n", retval
);
436 retval
= pci_register_driver(&pcie_portdriver
);
438 pcie_port_bus_unregister();
443 module_init(pcie_portdrv_init
);