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
)
70 rtsta_pos
= pci_pcie_cap(dev
) + PCI_EXP_RTSTA
;
72 pci_read_config_dword(dev
, rtsta_pos
, &rtsta
);
73 rtsta
|= PCI_EXP_RTSTA_PME
;
74 pci_write_config_dword(dev
, rtsta_pos
, rtsta
);
77 static int pcie_portdrv_restore_config(struct pci_dev
*dev
)
81 retval
= pci_enable_device(dev
);
89 static int pcie_port_resume_noirq(struct device
*dev
)
91 struct pci_dev
*pdev
= to_pci_dev(dev
);
94 * Some BIOSes forget to clear Root PME Status bits after system wakeup
95 * which breaks ACPI-based runtime wakeup on PCI Express, so clear those
96 * bits now just in case (shouldn't hurt).
98 if(pdev
->pcie_type
== PCI_EXP_TYPE_ROOT_PORT
)
99 pcie_clear_root_pme_status(pdev
);
103 #ifdef CONFIG_PM_RUNTIME
106 unsigned int d3cold_delay
;
109 static int pci_dev_d3cold_info(struct pci_dev
*pdev
, void *data
)
111 struct d3cold_info
*info
= data
;
113 info
->d3cold_delay
= max_t(unsigned int, pdev
->d3cold_delay
,
116 info
->no_d3cold
= true;
120 static int pcie_port_runtime_suspend(struct device
*dev
)
122 struct pci_dev
*pdev
= to_pci_dev(dev
);
123 struct d3cold_info d3cold_info
= {
125 .d3cold_delay
= PCI_PM_D3_WAIT
,
129 * If any subordinate device disable D3cold, we should not put
130 * the port into D3cold. The D3cold delay of port should be
131 * the max of that of all subordinate devices.
133 pci_walk_bus(pdev
->subordinate
, pci_dev_d3cold_info
, &d3cold_info
);
134 pdev
->no_d3cold
= d3cold_info
.no_d3cold
;
135 pdev
->d3cold_delay
= d3cold_info
.d3cold_delay
;
139 static int pcie_port_runtime_resume(struct device
*dev
)
144 #define pcie_port_runtime_suspend NULL
145 #define pcie_port_runtime_resume NULL
148 static const struct dev_pm_ops pcie_portdrv_pm_ops
= {
149 .suspend
= pcie_port_device_suspend
,
150 .resume
= pcie_port_device_resume
,
151 .freeze
= pcie_port_device_suspend
,
152 .thaw
= pcie_port_device_resume
,
153 .poweroff
= pcie_port_device_suspend
,
154 .restore
= pcie_port_device_resume
,
155 .resume_noirq
= pcie_port_resume_noirq
,
156 .runtime_suspend
= pcie_port_runtime_suspend
,
157 .runtime_resume
= pcie_port_runtime_resume
,
160 #define PCIE_PORTDRV_PM_OPS (&pcie_portdrv_pm_ops)
164 #define PCIE_PORTDRV_PM_OPS NULL
168 * PCIe port runtime suspend is broken for some chipsets, so use a
169 * black list to disable runtime PM for these chipsets.
171 static const struct pci_device_id port_runtime_pm_black_list
[] = {
172 { /* end: all zeroes */ }
176 * pcie_portdrv_probe - Probe PCI-Express port devices
177 * @dev: PCI-Express port device being probed
179 * If detected invokes the pcie_port_device_register() method for
183 static int __devinit
pcie_portdrv_probe(struct pci_dev
*dev
,
184 const struct pci_device_id
*id
)
188 if (!pci_is_pcie(dev
) ||
189 ((dev
->pcie_type
!= PCI_EXP_TYPE_ROOT_PORT
) &&
190 (dev
->pcie_type
!= PCI_EXP_TYPE_UPSTREAM
) &&
191 (dev
->pcie_type
!= PCI_EXP_TYPE_DOWNSTREAM
)))
194 if (!dev
->irq
&& dev
->pin
) {
195 dev_warn(&dev
->dev
, "device [%04x:%04x] has invalid IRQ; "
196 "check vendor BIOS\n", dev
->vendor
, dev
->device
);
198 status
= pcie_port_device_register(dev
);
203 if (!pci_match_id(port_runtime_pm_black_list
, dev
))
204 pm_runtime_put_noidle(&dev
->dev
);
209 static void pcie_portdrv_remove(struct pci_dev
*dev
)
211 if (!pci_match_id(port_runtime_pm_black_list
, dev
))
212 pm_runtime_get_noresume(&dev
->dev
);
213 pcie_port_device_remove(dev
);
214 pci_disable_device(dev
);
217 static int error_detected_iter(struct device
*device
, void *data
)
219 struct pcie_device
*pcie_device
;
220 struct pcie_port_service_driver
*driver
;
221 struct aer_broadcast_data
*result_data
;
222 pci_ers_result_t status
;
224 result_data
= (struct aer_broadcast_data
*) data
;
226 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
227 driver
= to_service_driver(device
->driver
);
229 !driver
->err_handler
||
230 !driver
->err_handler
->error_detected
)
233 pcie_device
= to_pcie_device(device
);
235 /* Forward error detected message to service drivers */
236 status
= driver
->err_handler
->error_detected(
239 result_data
->result
=
240 merge_result(result_data
->result
, status
);
246 static pci_ers_result_t
pcie_portdrv_error_detected(struct pci_dev
*dev
,
247 enum pci_channel_state error
)
249 struct aer_broadcast_data data
= {error
, PCI_ERS_RESULT_CAN_RECOVER
};
253 ret
= device_for_each_child(&dev
->dev
, &data
, error_detected_iter
);
258 static int mmio_enabled_iter(struct device
*device
, void *data
)
260 struct pcie_device
*pcie_device
;
261 struct pcie_port_service_driver
*driver
;
262 pci_ers_result_t status
, *result
;
264 result
= (pci_ers_result_t
*) data
;
266 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
267 driver
= to_service_driver(device
->driver
);
269 driver
->err_handler
&&
270 driver
->err_handler
->mmio_enabled
) {
271 pcie_device
= to_pcie_device(device
);
273 /* Forward error message to service drivers */
274 status
= driver
->err_handler
->mmio_enabled(
276 *result
= merge_result(*result
, status
);
283 static pci_ers_result_t
pcie_portdrv_mmio_enabled(struct pci_dev
*dev
)
285 pci_ers_result_t status
= PCI_ERS_RESULT_RECOVERED
;
288 /* get true return value from &status */
289 retval
= device_for_each_child(&dev
->dev
, &status
, mmio_enabled_iter
);
293 static int slot_reset_iter(struct device
*device
, void *data
)
295 struct pcie_device
*pcie_device
;
296 struct pcie_port_service_driver
*driver
;
297 pci_ers_result_t status
, *result
;
299 result
= (pci_ers_result_t
*) data
;
301 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
302 driver
= to_service_driver(device
->driver
);
304 driver
->err_handler
&&
305 driver
->err_handler
->slot_reset
) {
306 pcie_device
= to_pcie_device(device
);
308 /* Forward error message to service drivers */
309 status
= driver
->err_handler
->slot_reset(
311 *result
= merge_result(*result
, status
);
318 static pci_ers_result_t
pcie_portdrv_slot_reset(struct pci_dev
*dev
)
320 pci_ers_result_t status
= PCI_ERS_RESULT_RECOVERED
;
323 /* If fatal, restore cfg space for possible link reset at upstream */
324 if (dev
->error_state
== pci_channel_io_frozen
) {
325 dev
->state_saved
= true;
326 pci_restore_state(dev
);
327 pcie_portdrv_restore_config(dev
);
328 pci_enable_pcie_error_reporting(dev
);
331 /* get true return value from &status */
332 retval
= device_for_each_child(&dev
->dev
, &status
, slot_reset_iter
);
337 static int resume_iter(struct device
*device
, void *data
)
339 struct pcie_device
*pcie_device
;
340 struct pcie_port_service_driver
*driver
;
342 if (device
->bus
== &pcie_port_bus_type
&& device
->driver
) {
343 driver
= to_service_driver(device
->driver
);
345 driver
->err_handler
&&
346 driver
->err_handler
->resume
) {
347 pcie_device
= to_pcie_device(device
);
349 /* Forward error message to service drivers */
350 driver
->err_handler
->resume(pcie_device
->port
);
357 static void pcie_portdrv_err_resume(struct pci_dev
*dev
)
360 /* nothing to do with error value, if it ever happens */
361 retval
= device_for_each_child(&dev
->dev
, NULL
, resume_iter
);
365 * LINUX Device Driver Model
367 static const struct pci_device_id port_pci_ids
[] = { {
368 /* handle any PCI-Express port */
369 PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI
<< 8) | 0x00), ~0),
370 }, { /* end: all zeroes */ }
372 MODULE_DEVICE_TABLE(pci
, port_pci_ids
);
374 static struct pci_error_handlers pcie_portdrv_err_handler
= {
375 .error_detected
= pcie_portdrv_error_detected
,
376 .mmio_enabled
= pcie_portdrv_mmio_enabled
,
377 .slot_reset
= pcie_portdrv_slot_reset
,
378 .resume
= pcie_portdrv_err_resume
,
381 static struct pci_driver pcie_portdriver
= {
383 .id_table
= &port_pci_ids
[0],
385 .probe
= pcie_portdrv_probe
,
386 .remove
= pcie_portdrv_remove
,
388 .err_handler
= &pcie_portdrv_err_handler
,
390 .driver
.pm
= PCIE_PORTDRV_PM_OPS
,
393 static int __init
dmi_pcie_pme_disable_msi(const struct dmi_system_id
*d
)
395 pr_notice("%s detected: will not use MSI for PCIe PME signaling\n",
397 pcie_pme_disable_msi();
401 static struct dmi_system_id __initdata pcie_portdrv_dmi_table
[] = {
403 * Boxes that should not use MSI for PCIe PME signaling.
406 .callback
= dmi_pcie_pme_disable_msi
,
407 .ident
= "MSI Wind U-100",
409 DMI_MATCH(DMI_SYS_VENDOR
,
410 "MICRO-STAR INTERNATIONAL CO., LTD"),
411 DMI_MATCH(DMI_PRODUCT_NAME
, "U-100"),
417 static int __init
pcie_portdrv_init(void)
421 if (pcie_ports_disabled
)
422 return pci_register_driver(&pcie_portdriver
);
424 dmi_check_system(pcie_portdrv_dmi_table
);
426 retval
= pcie_port_bus_register();
428 printk(KERN_WARNING
"PCIE: bus_register error: %d\n", retval
);
431 retval
= pci_register_driver(&pcie_portdriver
);
433 pcie_port_bus_unregister();
438 module_init(pcie_portdrv_init
);