PCI: Merge multi-line quoted strings
[deliverable/linux.git] / drivers / pci / pcie / portdrv_pci.c
CommitLineData
1da177e4
LT
1/*
2 * File: portdrv_pci.c
3 * Purpose: PCI Express Port Bus Driver
4 *
5 * Copyright (C) 2004 Intel
6 * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
7 */
8
9#include <linux/module.h>
10#include <linux/pci.h>
11#include <linux/kernel.h>
12#include <linux/errno.h>
13#include <linux/pm.h>
71a83bd7 14#include <linux/pm_runtime.h>
1da177e4
LT
15#include <linux/init.h>
16#include <linux/pcieport_if.h>
4bf3392e 17#include <linux/aer.h>
c39fae14 18#include <linux/dmi.h>
28eb5f27 19#include <linux/pci-aspm.h>
1da177e4
LT
20
21#include "portdrv.h"
4bf3392e 22#include "aer/aerdrv.h"
1da177e4
LT
23
24/*
25 * Version Information
26 */
27#define DRIVER_VERSION "v1.0"
28#define DRIVER_AUTHOR "tom.l.nguyen@intel.com"
7e8af37a 29#define DRIVER_DESC "PCIe Port Bus Driver"
1da177e4
LT
30MODULE_AUTHOR(DRIVER_AUTHOR);
31MODULE_DESCRIPTION(DRIVER_DESC);
32MODULE_LICENSE("GPL");
33
79dd9182
RW
34/* If this switch is set, PCIe port native services should not be enabled. */
35bool pcie_ports_disabled;
36
28eb5f27
RW
37/*
38 * If this switch is set, ACPI _OSC will be used to determine whether or not to
39 * enable PCIe port native services.
40 */
41bool pcie_ports_auto = true;
42
79dd9182
RW
43static int __init pcie_port_setup(char *str)
44{
28eb5f27 45 if (!strncmp(str, "compat", 6)) {
79dd9182 46 pcie_ports_disabled = true;
28eb5f27
RW
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;
53 }
79dd9182
RW
54
55 return 1;
56}
57__setup("pcie_ports=", pcie_port_setup);
58
1da177e4 59/* global data */
1da177e4 60
fe31e697
RW
61/**
62 * pcie_clear_root_pme_status - Clear root port PME interrupt status.
63 * @dev: PCIe root port or event collector.
64 */
65void pcie_clear_root_pme_status(struct pci_dev *dev)
66{
2dcfaf85 67 pcie_capability_set_dword(dev, PCI_EXP_RTSTA, PCI_EXP_RTSTA_PME);
fe31e697
RW
68}
69
4bf3392e
ZY
70static int pcie_portdrv_restore_config(struct pci_dev *dev)
71{
72 int retval;
73
4bf3392e
ZY
74 retval = pci_enable_device(dev);
75 if (retval)
76 return retval;
77 pci_set_master(dev);
78 return 0;
79}
80
0bed208e 81#ifdef CONFIG_PM
fe31e697
RW
82static int pcie_port_resume_noirq(struct device *dev)
83{
84 struct pci_dev *pdev = to_pci_dev(dev);
85
86 /*
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).
90 */
62f87c0e 91 if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT)
fe31e697
RW
92 pcie_clear_root_pme_status(pdev);
93 return 0;
94}
95
71a83bd7 96#ifdef CONFIG_PM_RUNTIME
448bd857
HY
97struct d3cold_info {
98 bool no_d3cold;
99 unsigned int d3cold_delay;
100};
101
102static int pci_dev_d3cold_info(struct pci_dev *pdev, void *data)
103{
104 struct d3cold_info *info = data;
105
106 info->d3cold_delay = max_t(unsigned int, pdev->d3cold_delay,
107 info->d3cold_delay);
108 if (pdev->no_d3cold)
109 info->no_d3cold = true;
110 return 0;
111}
112
113static int pcie_port_runtime_suspend(struct device *dev)
114{
115 struct pci_dev *pdev = to_pci_dev(dev);
116 struct d3cold_info d3cold_info = {
117 .no_d3cold = false,
118 .d3cold_delay = PCI_PM_D3_WAIT,
119 };
120
121 /*
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.
125 */
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;
129 return 0;
130}
131
132static int pcie_port_runtime_resume(struct device *dev)
71a83bd7
ZY
133{
134 return 0;
135}
3d8387ef 136
c733b774
HY
137static int pci_dev_pme_poll(struct pci_dev *pdev, void *data)
138{
139 bool *pme_poll = data;
140
141 if (pdev->pme_poll)
142 *pme_poll = true;
143 return 0;
144}
145
3d8387ef
HY
146static int pcie_port_runtime_idle(struct device *dev)
147{
c733b774
HY
148 struct pci_dev *pdev = to_pci_dev(dev);
149 bool pme_poll = false;
150
151 /*
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.
154 */
155 pci_walk_bus(pdev->subordinate, pci_dev_pme_poll, &pme_poll);
3d8387ef 156 /* Delay for a short while to prevent too frequent suspend/resume */
c733b774
HY
157 if (!pme_poll)
158 pm_schedule_suspend(dev, 10);
3d8387ef
HY
159 return -EBUSY;
160}
71a83bd7 161#else
448bd857
HY
162#define pcie_port_runtime_suspend NULL
163#define pcie_port_runtime_resume NULL
3d8387ef 164#define pcie_port_runtime_idle NULL
71a83bd7
ZY
165#endif
166
47145210 167static const struct dev_pm_ops pcie_portdrv_pm_ops = {
3a3c244c
RW
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,
fe31e697 174 .resume_noirq = pcie_port_resume_noirq,
448bd857
HY
175 .runtime_suspend = pcie_port_runtime_suspend,
176 .runtime_resume = pcie_port_runtime_resume,
3d8387ef 177 .runtime_idle = pcie_port_runtime_idle,
3a3c244c 178};
4bf3392e 179
3a3c244c 180#define PCIE_PORTDRV_PM_OPS (&pcie_portdrv_pm_ops)
a79d682f 181
3a3c244c
RW
182#else /* !PM */
183
184#define PCIE_PORTDRV_PM_OPS NULL
185#endif /* !PM */
4bf3392e 186
1da177e4
LT
187/*
188 * pcie_portdrv_probe - Probe PCI-Express port devices
189 * @dev: PCI-Express port device being probed
190 *
40da4186 191 * If detected invokes the pcie_port_device_register() method for
1da177e4
LT
192 * this port device.
193 *
194 */
15856ad5 195static int pcie_portdrv_probe(struct pci_dev *dev,
898294c9 196 const struct pci_device_id *id)
1da177e4 197{
898294c9 198 int status;
1da177e4 199
898294c9 200 if (!pci_is_pcie(dev) ||
62f87c0e
YW
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)))
898294c9 204 return -ENODEV;
1da177e4 205
40da4186 206 if (!dev->irq && dev->pin) {
227f0647
RD
207 dev_warn(&dev->dev, "device [%04x:%04x] has invalid IRQ; check vendor BIOS\n",
208 dev->vendor, dev->device);
1da177e4 209 }
f118c0c3
RW
210 status = pcie_port_device_register(dev);
211 if (status)
212 return status;
1da177e4 213
87d2e2ec 214 pci_save_state(dev);
4f9c1397
HY
215 /*
216 * D3cold may not work properly on some PCIe port, so disable
217 * it by default.
218 */
219 dev->d3cold_allowed = false;
1da177e4
LT
220 return 0;
221}
222
40da4186 223static void pcie_portdrv_remove(struct pci_dev *dev)
1da177e4
LT
224{
225 pcie_port_device_remove(dev);
226}
227
4bf3392e 228static int error_detected_iter(struct device *device, void *data)
60854838 229{
4bf3392e
ZY
230 struct pcie_device *pcie_device;
231 struct pcie_port_service_driver *driver;
232 struct aer_broadcast_data *result_data;
233 pci_ers_result_t status;
234
235 result_data = (struct aer_broadcast_data *) data;
236
237 if (device->bus == &pcie_port_bus_type && device->driver) {
238 driver = to_service_driver(device->driver);
239 if (!driver ||
240 !driver->err_handler ||
241 !driver->err_handler->error_detected)
242 return 0;
243
244 pcie_device = to_pcie_device(device);
245
246 /* Forward error detected message to service drivers */
247 status = driver->err_handler->error_detected(
248 pcie_device->port,
249 result_data->state);
250 result_data->result =
251 merge_result(result_data->result, status);
252 }
253
254 return 0;
60854838
HK
255}
256
4bf3392e
ZY
257static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
258 enum pci_channel_state error)
60854838 259{
40da4186 260 struct aer_broadcast_data data = {error, PCI_ERS_RESULT_CAN_RECOVER};
4bf3392e 261
b638d7e7
BH
262 /* get true return value from &data */
263 device_for_each_child(&dev->dev, &data, error_detected_iter);
40da4186 264 return data.result;
4bf3392e
ZY
265}
266
267static int mmio_enabled_iter(struct device *device, void *data)
268{
269 struct pcie_device *pcie_device;
270 struct pcie_port_service_driver *driver;
271 pci_ers_result_t status, *result;
272
273 result = (pci_ers_result_t *) data;
274
275 if (device->bus == &pcie_port_bus_type && device->driver) {
276 driver = to_service_driver(device->driver);
277 if (driver &&
278 driver->err_handler &&
279 driver->err_handler->mmio_enabled) {
280 pcie_device = to_pcie_device(device);
281
282 /* Forward error message to service drivers */
283 status = driver->err_handler->mmio_enabled(
284 pcie_device->port);
285 *result = merge_result(*result, status);
286 }
287 }
60854838 288
60854838
HK
289 return 0;
290}
291
4bf3392e 292static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
1da177e4 293{
4bf3392e 294 pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
5823d100 295
b19441af 296 /* get true return value from &status */
b638d7e7 297 device_for_each_child(&dev->dev, &status, mmio_enabled_iter);
4bf3392e 298 return status;
1da177e4
LT
299}
300
4bf3392e 301static int slot_reset_iter(struct device *device, void *data)
1da177e4 302{
4bf3392e
ZY
303 struct pcie_device *pcie_device;
304 struct pcie_port_service_driver *driver;
305 pci_ers_result_t status, *result;
306
307 result = (pci_ers_result_t *) data;
308
309 if (device->bus == &pcie_port_bus_type && device->driver) {
310 driver = to_service_driver(device->driver);
311 if (driver &&
312 driver->err_handler &&
313 driver->err_handler->slot_reset) {
314 pcie_device = to_pcie_device(device);
315
316 /* Forward error message to service drivers */
317 status = driver->err_handler->slot_reset(
318 pcie_device->port);
319 *result = merge_result(*result, status);
320 }
321 }
322
323 return 0;
324}
325
326static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
327{
029091df 328 pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
4bf3392e
ZY
329
330 /* If fatal, restore cfg space for possible link reset at upstream */
331 if (dev->error_state == pci_channel_io_frozen) {
e9d82888 332 dev->state_saved = true;
a79d682f 333 pci_restore_state(dev);
4bf3392e
ZY
334 pcie_portdrv_restore_config(dev);
335 pci_enable_pcie_error_reporting(dev);
336 }
337
b19441af 338 /* get true return value from &status */
b638d7e7 339 device_for_each_child(&dev->dev, &status, slot_reset_iter);
4bf3392e
ZY
340 return status;
341}
342
343static int resume_iter(struct device *device, void *data)
344{
345 struct pcie_device *pcie_device;
346 struct pcie_port_service_driver *driver;
347
348 if (device->bus == &pcie_port_bus_type && device->driver) {
349 driver = to_service_driver(device->driver);
350 if (driver &&
351 driver->err_handler &&
352 driver->err_handler->resume) {
353 pcie_device = to_pcie_device(device);
354
355 /* Forward error message to service drivers */
356 driver->err_handler->resume(pcie_device->port);
357 }
358 }
359
360 return 0;
361}
362
363static void pcie_portdrv_err_resume(struct pci_dev *dev)
364{
b638d7e7 365 device_for_each_child(&dev->dev, NULL, resume_iter);
1da177e4 366}
1da177e4
LT
367
368/*
369 * LINUX Device Driver Model
370 */
371static const struct pci_device_id port_pci_ids[] = { {
372 /* handle any PCI-Express port */
373 PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0),
374 }, { /* end: all zeroes */ }
375};
376MODULE_DEVICE_TABLE(pci, port_pci_ids);
377
49453028
SH
378static const struct pci_error_handlers pcie_portdrv_err_handler = {
379 .error_detected = pcie_portdrv_error_detected,
380 .mmio_enabled = pcie_portdrv_mmio_enabled,
381 .slot_reset = pcie_portdrv_slot_reset,
382 .resume = pcie_portdrv_err_resume,
4bf3392e
ZY
383};
384
3603a6a3 385static struct pci_driver pcie_portdriver = {
e3fb20f9 386 .name = "pcieport",
1da177e4
LT
387 .id_table = &port_pci_ids[0],
388
389 .probe = pcie_portdrv_probe,
390 .remove = pcie_portdrv_remove,
391
f7625980 392 .err_handler = &pcie_portdrv_err_handler,
3a3c244c 393
f7625980 394 .driver.pm = PCIE_PORTDRV_PM_OPS,
1da177e4
LT
395};
396
c39fae14
RW
397static int __init dmi_pcie_pme_disable_msi(const struct dmi_system_id *d)
398{
399 pr_notice("%s detected: will not use MSI for PCIe PME signaling\n",
227f0647 400 d->ident);
c39fae14
RW
401 pcie_pme_disable_msi();
402 return 0;
403}
404
405static struct dmi_system_id __initdata pcie_portdrv_dmi_table[] = {
406 /*
407 * Boxes that should not use MSI for PCIe PME signaling.
408 */
409 {
410 .callback = dmi_pcie_pme_disable_msi,
411 .ident = "MSI Wind U-100",
412 .matches = {
413 DMI_MATCH(DMI_SYS_VENDOR,
f7625980 414 "MICRO-STAR INTERNATIONAL CO., LTD"),
c39fae14
RW
415 DMI_MATCH(DMI_PRODUCT_NAME, "U-100"),
416 },
417 },
418 {}
419};
420
1da177e4
LT
421static int __init pcie_portdrv_init(void)
422{
20d51660 423 int retval;
1da177e4 424
fe31e697
RW
425 if (pcie_ports_disabled)
426 return pci_register_driver(&pcie_portdriver);
79dd9182 427
c39fae14
RW
428 dmi_check_system(pcie_portdrv_dmi_table);
429
20d51660
RD
430 retval = pcie_port_bus_register();
431 if (retval) {
432 printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
433 goto out;
434 }
3603a6a3 435 retval = pci_register_driver(&pcie_portdriver);
1da177e4
LT
436 if (retval)
437 pcie_port_bus_unregister();
20d51660 438 out:
1da177e4
LT
439 return retval;
440}
441
1da177e4 442module_init(pcie_portdrv_init);
This page took 1.749937 seconds and 5 git commands to generate.