drivers/pci/pcie/portdrv_pci.c

   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>
  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>
  20
  21 #include "portdrv.h"
  22 #include "aer/aerdrv.h"
  23
  24 /*
  25  * Version Information
  26  */
  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");
  33
  34 /* If this switch is set, PCIe port native services should not be enabled. */
  35 bool pcie_ports_disabled;
  36
  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  */
  41 bool pcie_ports_auto = true;
  42
  43 static int __init pcie_port_setup(char *str)
  44 {
  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;
  53         }
  54
  55         return 1;
  56 }
  57 __setup("pcie_ports=", pcie_port_setup);
  58
  59 /* global data */
  60
  61 /**
  62  * pcie_clear_root_pme_status - Clear root port PME interrupt status.
  63  * @dev: PCIe root port or event collector.
  64  */
  65 void pcie_clear_root_pme_status(struct pci_dev *dev)
  66 {
  67         int rtsta_pos;
  68         u32 rtsta;
  69
  70         rtsta_pos = pci_pcie_cap(dev) + PCI_EXP_RTSTA;
  71
  72         pci_read_config_dword(dev, rtsta_pos, &rtsta);
  73         rtsta |= PCI_EXP_RTSTA_PME;
  74         pci_write_config_dword(dev, rtsta_pos, rtsta);
  75 }
  76
  77 static int pcie_portdrv_restore_config(struct pci_dev *dev)
  78 {
  79         int retval;
  80
  81         retval = pci_enable_device(dev);
  82         if (retval)
  83                 return retval;
  84         pci_set_master(dev);
  85         return 0;
  86 }
  87
  88 #ifdef CONFIG_PM
  89 static int pcie_port_resume_noirq(struct device *dev)
  90 {
  91         struct pci_dev *pdev = to_pci_dev(dev);
  92
  93         /*
  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).
  97          */
  98         if(pdev->pcie_type == PCI_EXP_TYPE_ROOT_PORT)
  99                 pcie_clear_root_pme_status(pdev);
 100         return 0;
 101 }
 102
 103 #ifdef CONFIG_PM_RUNTIME
 104 struct d3cold_info {
 105         bool no_d3cold;
 106         unsigned int d3cold_delay;
 107 };
 108
 109 static int pci_dev_d3cold_info(struct pci_dev *pdev, void *data)
 110 {
 111         struct d3cold_info *info = data;
 112
 113         info->d3cold_delay = max_t(unsigned int, pdev->d3cold_delay,
 114                                    info->d3cold_delay);
 115         if (pdev->no_d3cold)
 116                 info->no_d3cold = true;
 117         return 0;
 118 }
 119
 120 static int pcie_port_runtime_suspend(struct device *dev)
 121 {
 122         struct pci_dev *pdev = to_pci_dev(dev);
 123         struct d3cold_info d3cold_info = {
 124                 .no_d3cold      = false,
 125                 .d3cold_delay   = PCI_PM_D3_WAIT,
 126         };
 127
 128         /*
 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.
 132          */
 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;
 136         return 0;
 137 }
 138
 139 static int pcie_port_runtime_resume(struct device *dev)
 140 {
 141         return 0;
 142 }
 143 #else
 144 #define pcie_port_runtime_suspend       NULL
 145 #define pcie_port_runtime_resume        NULL
 146 #endif
 147
 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,
 158 };
 159
 160 #define PCIE_PORTDRV_PM_OPS     (&pcie_portdrv_pm_ops)
 161
 162 #else /* !PM */
 163
 164 #define PCIE_PORTDRV_PM_OPS     NULL
 165 #endif /* !PM */
 166
 167 /*
 168  * PCIe port runtime suspend is broken for some chipsets, so use a
 169  * black list to disable runtime PM for these chipsets.
 170  */
 171 static const struct pci_device_id port_runtime_pm_black_list[] = {
 172         { /* end: all zeroes */ }
 173 };
 174
 175 /*
 176  * pcie_portdrv_probe - Probe PCI-Express port devices
 177  * @dev: PCI-Express port device being probed
 178  *
 179  * If detected invokes the pcie_port_device_register() method for
 180  * this port device.
 181  *
 182  */
 183 static int __devinit pcie_portdrv_probe(struct pci_dev *dev,
 184                                         const struct pci_device_id *id)
 185 {
 186         int status;
 187
 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)))
 192                 return -ENODEV;
 193
 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);
 197         }
 198         status = pcie_port_device_register(dev);
 199         if (status)
 200                 return status;
 201
 202         pci_save_state(dev);
 203         if (!pci_match_id(port_runtime_pm_black_list, dev))
 204                 pm_runtime_put_noidle(&dev->dev);
 205
 206         return 0;
 207 }
 208
 209 static void pcie_portdrv_remove(struct pci_dev *dev)
 210 {
 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);
 215 }
 216
 217 static int error_detected_iter(struct device *device, void *data)
 218 {
 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;
 223
 224         result_data = (struct aer_broadcast_data *) data;
 225
 226         if (device->bus == &pcie_port_bus_type && device->driver) {
 227                 driver = to_service_driver(device->driver);
 228                 if (!driver ||
 229                         !driver->err_handler ||
 230                         !driver->err_handler->error_detected)
 231                         return 0;
 232
 233                 pcie_device = to_pcie_device(device);
 234
 235                 /* Forward error detected message to service drivers */
 236                 status = driver->err_handler->error_detected(
 237                         pcie_device->port,
 238                         result_data->state);
 239                 result_data->result =
 240                         merge_result(result_data->result, status);
 241         }
 242
 243         return 0;
 244 }
 245
 246 static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
 247                                         enum pci_channel_state error)
 248 {
 249         struct aer_broadcast_data data = {error, PCI_ERS_RESULT_CAN_RECOVER};
 250         int ret;
 251
 252         /* can not fail */
 253         ret = device_for_each_child(&dev->dev, &data, error_detected_iter);
 254
 255         return data.result;
 256 }
 257
 258 static int mmio_enabled_iter(struct device *device, void *data)
 259 {
 260         struct pcie_device *pcie_device;
 261         struct pcie_port_service_driver *driver;
 262         pci_ers_result_t status, *result;
 263
 264         result = (pci_ers_result_t *) data;
 265
 266         if (device->bus == &pcie_port_bus_type && device->driver) {
 267                 driver = to_service_driver(device->driver);
 268                 if (driver &&
 269                         driver->err_handler &&
 270                         driver->err_handler->mmio_enabled) {
 271                         pcie_device = to_pcie_device(device);
 272
 273                         /* Forward error message to service drivers */
 274                         status = driver->err_handler->mmio_enabled(
 275                                         pcie_device->port);
 276                         *result = merge_result(*result, status);
 277                 }
 278         }
 279
 280         return 0;
 281 }
 282
 283 static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
 284 {
 285         pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
 286         int retval;
 287
 288         /* get true return value from &status */
 289         retval = device_for_each_child(&dev->dev, &status, mmio_enabled_iter);
 290         return status;
 291 }
 292
 293 static int slot_reset_iter(struct device *device, void *data)
 294 {
 295         struct pcie_device *pcie_device;
 296         struct pcie_port_service_driver *driver;
 297         pci_ers_result_t status, *result;
 298
 299         result = (pci_ers_result_t *) data;
 300
 301         if (device->bus == &pcie_port_bus_type && device->driver) {
 302                 driver = to_service_driver(device->driver);
 303                 if (driver &&
 304                         driver->err_handler &&
 305                         driver->err_handler->slot_reset) {
 306                         pcie_device = to_pcie_device(device);
 307
 308                         /* Forward error message to service drivers */
 309                         status = driver->err_handler->slot_reset(
 310                                         pcie_device->port);
 311                         *result = merge_result(*result, status);
 312                 }
 313         }
 314
 315         return 0;
 316 }
 317
 318 static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
 319 {
 320         pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
 321         int retval;
 322
 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);
 329         }
 330
 331         /* get true return value from &status */
 332         retval = device_for_each_child(&dev->dev, &status, slot_reset_iter);
 333
 334         return status;
 335 }
 336
 337 static int resume_iter(struct device *device, void *data)
 338 {
 339         struct pcie_device *pcie_device;
 340         struct pcie_port_service_driver *driver;
 341
 342         if (device->bus == &pcie_port_bus_type && device->driver) {
 343                 driver = to_service_driver(device->driver);
 344                 if (driver &&
 345                         driver->err_handler &&
 346                         driver->err_handler->resume) {
 347                         pcie_device = to_pcie_device(device);
 348
 349                         /* Forward error message to service drivers */
 350                         driver->err_handler->resume(pcie_device->port);
 351                 }
 352         }
 353
 354         return 0;
 355 }
 356
 357 static void pcie_portdrv_err_resume(struct pci_dev *dev)
 358 {
 359         int retval;
 360         /* nothing to do with error value, if it ever happens */
 361         retval = device_for_each_child(&dev->dev, NULL, resume_iter);
 362 }
 363
 364 /*
 365  * LINUX Device Driver Model
 366  */
 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 */ }
 371 };
 372 MODULE_DEVICE_TABLE(pci, port_pci_ids);
 373
 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,
 379 };
 380
 381 static struct pci_driver pcie_portdriver = {
 382         .name           = "pcieport",
 383         .id_table       = &port_pci_ids[0],
 384
 385         .probe          = pcie_portdrv_probe,
 386         .remove         = pcie_portdrv_remove,
 387
 388         .err_handler    = &pcie_portdrv_err_handler,
 389
 390         .driver.pm      = PCIE_PORTDRV_PM_OPS,
 391 };
 392
 393 static int __init dmi_pcie_pme_disable_msi(const struct dmi_system_id *d)
 394 {
 395         pr_notice("%s detected: will not use MSI for PCIe PME signaling\n",
 396                         d->ident);
 397         pcie_pme_disable_msi();
 398         return 0;
 399 }
 400
 401 static struct dmi_system_id __initdata pcie_portdrv_dmi_table[] = {
 402         /*
 403          * Boxes that should not use MSI for PCIe PME signaling.
 404          */
 405         {
 406          .callback = dmi_pcie_pme_disable_msi,
 407          .ident = "MSI Wind U-100",
 408          .matches = {
 409                      DMI_MATCH(DMI_SYS_VENDOR,
 410                                 "MICRO-STAR INTERNATIONAL CO., LTD"),
 411                      DMI_MATCH(DMI_PRODUCT_NAME, "U-100"),
 412                      },
 413          },
 414          {}
 415 };
 416
 417 static int __init pcie_portdrv_init(void)
 418 {
 419         int retval;
 420
 421         if (pcie_ports_disabled)
 422                 return pci_register_driver(&pcie_portdriver);
 423
 424         dmi_check_system(pcie_portdrv_dmi_table);
 425
 426         retval = pcie_port_bus_register();
 427         if (retval) {
 428                 printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
 429                 goto out;
 430         }
 431         retval = pci_register_driver(&pcie_portdriver);
 432         if (retval)
 433                 pcie_port_bus_unregister();
 434  out:
 435         return retval;
 436 }
 437
 438 module_init(pcie_portdrv_init);