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/init.h>
  15 #include <linux/slab.h>
  16 #include <linux/pcieport_if.h>
  17 #include <linux/aer.h>
  18
  19 #include "portdrv.h"
  20 #include "aer/aerdrv.h"
  21
  22 /*
  23  * Version Information
  24  */
  25 #define DRIVER_VERSION "v1.0"
  26 #define DRIVER_AUTHOR "tom.l.nguyen@intel.com"
  27 #define DRIVER_DESC "PCIe Port Bus Driver"
  28 MODULE_AUTHOR(DRIVER_AUTHOR);
  29 MODULE_DESCRIPTION(DRIVER_DESC);
  30 MODULE_LICENSE("GPL");
  31
  32 /* global data */
  33
  34 static int pcie_portdrv_restore_config(struct pci_dev *dev)
  35 {
  36         int retval;
  37
  38         retval = pci_enable_device(dev);
  39         if (retval)
  40                 return retval;
  41         pci_set_master(dev);
  42         return 0;
  43 }
  44
  45 #ifdef CONFIG_PM
  46 static const struct dev_pm_ops pcie_portdrv_pm_ops = {
  47         .suspend        = pcie_port_device_suspend,
  48         .resume         = pcie_port_device_resume,
  49         .freeze         = pcie_port_device_suspend,
  50         .thaw           = pcie_port_device_resume,
  51         .poweroff       = pcie_port_device_suspend,
  52         .restore        = pcie_port_device_resume,
  53 };
  54
  55 #define PCIE_PORTDRV_PM_OPS     (&pcie_portdrv_pm_ops)
  56
  57 #else /* !PM */
  58
  59 #define PCIE_PORTDRV_PM_OPS     NULL
  60 #endif /* !PM */
  61
  62 /*
  63  * pcie_portdrv_probe - Probe PCI-Express port devices
  64  * @dev: PCI-Express port device being probed
  65  *
  66  * If detected invokes the pcie_port_device_register() method for
  67  * this port device.
  68  *
  69  */
  70 static int __devinit pcie_portdrv_probe(struct pci_dev *dev,
  71                                         const struct pci_device_id *id)
  72 {
  73         int status;
  74
  75         if (!pci_is_pcie(dev) ||
  76             ((dev->pcie_type != PCI_EXP_TYPE_ROOT_PORT) &&
  77              (dev->pcie_type != PCI_EXP_TYPE_UPSTREAM) &&
  78              (dev->pcie_type != PCI_EXP_TYPE_DOWNSTREAM)))
  79                 return -ENODEV;
  80
  81         if (!dev->irq && dev->pin) {
  82                 dev_warn(&dev->dev, "device [%04x:%04x] has invalid IRQ; "
  83                          "check vendor BIOS\n", dev->vendor, dev->device);
  84         }
  85         status = pcie_port_device_register(dev);
  86         if (status)
  87                 return status;
  88
  89         pci_save_state(dev);
  90
  91         return 0;
  92 }
  93
  94 static void pcie_portdrv_remove (struct pci_dev *dev)
  95 {
  96         pcie_port_device_remove(dev);
  97         pci_disable_device(dev);
  98 }
  99
 100 static int error_detected_iter(struct device *device, void *data)
 101 {
 102         struct pcie_device *pcie_device;
 103         struct pcie_port_service_driver *driver;
 104         struct aer_broadcast_data *result_data;
 105         pci_ers_result_t status;
 106
 107         result_data = (struct aer_broadcast_data *) data;
 108
 109         if (device->bus == &pcie_port_bus_type && device->driver) {
 110                 driver = to_service_driver(device->driver);
 111                 if (!driver ||
 112                         !driver->err_handler ||
 113                         !driver->err_handler->error_detected)
 114                         return 0;
 115
 116                 pcie_device = to_pcie_device(device);
 117
 118                 /* Forward error detected message to service drivers */
 119                 status = driver->err_handler->error_detected(
 120                         pcie_device->port,
 121                         result_data->state);
 122                 result_data->result =
 123                         merge_result(result_data->result, status);
 124         }
 125
 126         return 0;
 127 }
 128
 129 static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
 130                                         enum pci_channel_state error)
 131 {
 132         struct aer_broadcast_data result_data =
 133                         {error, PCI_ERS_RESULT_CAN_RECOVER};
 134         int retval;
 135
 136         /* can not fail */
 137         retval = device_for_each_child(&dev->dev, &result_data, error_detected_iter);
 138
 139         return result_data.result;
 140 }
 141
 142 static int mmio_enabled_iter(struct device *device, void *data)
 143 {
 144         struct pcie_device *pcie_device;
 145         struct pcie_port_service_driver *driver;
 146         pci_ers_result_t status, *result;
 147
 148         result = (pci_ers_result_t *) data;
 149
 150         if (device->bus == &pcie_port_bus_type && device->driver) {
 151                 driver = to_service_driver(device->driver);
 152                 if (driver &&
 153                         driver->err_handler &&
 154                         driver->err_handler->mmio_enabled) {
 155                         pcie_device = to_pcie_device(device);
 156
 157                         /* Forward error message to service drivers */
 158                         status = driver->err_handler->mmio_enabled(
 159                                         pcie_device->port);
 160                         *result = merge_result(*result, status);
 161                 }
 162         }
 163
 164         return 0;
 165 }
 166
 167 static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
 168 {
 169         pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
 170         int retval;
 171
 172         /* get true return value from &status */
 173         retval = device_for_each_child(&dev->dev, &status, mmio_enabled_iter);
 174         return status;
 175 }
 176
 177 static int slot_reset_iter(struct device *device, void *data)
 178 {
 179         struct pcie_device *pcie_device;
 180         struct pcie_port_service_driver *driver;
 181         pci_ers_result_t status, *result;
 182
 183         result = (pci_ers_result_t *) data;
 184
 185         if (device->bus == &pcie_port_bus_type && device->driver) {
 186                 driver = to_service_driver(device->driver);
 187                 if (driver &&
 188                         driver->err_handler &&
 189                         driver->err_handler->slot_reset) {
 190                         pcie_device = to_pcie_device(device);
 191
 192                         /* Forward error message to service drivers */
 193                         status = driver->err_handler->slot_reset(
 194                                         pcie_device->port);
 195                         *result = merge_result(*result, status);
 196                 }
 197         }
 198
 199         return 0;
 200 }
 201
 202 static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
 203 {
 204         pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
 205         int retval;
 206
 207         /* If fatal, restore cfg space for possible link reset at upstream */
 208         if (dev->error_state == pci_channel_io_frozen) {
 209                 dev->state_saved = true;
 210                 pci_restore_state(dev);
 211                 pcie_portdrv_restore_config(dev);
 212                 pci_enable_pcie_error_reporting(dev);
 213         }
 214
 215         /* get true return value from &status */
 216         retval = device_for_each_child(&dev->dev, &status, slot_reset_iter);
 217
 218         return status;
 219 }
 220
 221 static int resume_iter(struct device *device, void *data)
 222 {
 223         struct pcie_device *pcie_device;
 224         struct pcie_port_service_driver *driver;
 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->resume) {
 231                         pcie_device = to_pcie_device(device);
 232
 233                         /* Forward error message to service drivers */
 234                         driver->err_handler->resume(pcie_device->port);
 235                 }
 236         }
 237
 238         return 0;
 239 }
 240
 241 static void pcie_portdrv_err_resume(struct pci_dev *dev)
 242 {
 243         int retval;
 244         /* nothing to do with error value, if it ever happens */
 245         retval = device_for_each_child(&dev->dev, NULL, resume_iter);
 246 }
 247
 248 /*
 249  * LINUX Device Driver Model
 250  */
 251 static const struct pci_device_id port_pci_ids[] = { {
 252         /* handle any PCI-Express port */
 253         PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0),
 254         }, { /* end: all zeroes */ }
 255 };
 256 MODULE_DEVICE_TABLE(pci, port_pci_ids);
 257
 258 static struct pci_error_handlers pcie_portdrv_err_handler = {
 259                 .error_detected = pcie_portdrv_error_detected,
 260                 .mmio_enabled = pcie_portdrv_mmio_enabled,
 261                 .slot_reset = pcie_portdrv_slot_reset,
 262                 .resume = pcie_portdrv_err_resume,
 263 };
 264
 265 static struct pci_driver pcie_portdriver = {
 266         .name           = "pcieport",
 267         .id_table       = &port_pci_ids[0],
 268
 269         .probe          = pcie_portdrv_probe,
 270         .remove         = pcie_portdrv_remove,
 271
 272         .err_handler    = &pcie_portdrv_err_handler,
 273
 274         .driver.pm      = PCIE_PORTDRV_PM_OPS,
 275 };
 276
 277 static int __init pcie_portdrv_init(void)
 278 {
 279         int retval;
 280
 281         retval = pcie_port_bus_register();
 282         if (retval) {
 283                 printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
 284                 goto out;
 285         }
 286         retval = pci_register_driver(&pcie_portdriver);
 287         if (retval)
 288                 pcie_port_bus_unregister();
 289  out:
 290         return retval;
 291 }
 292
 293 static void __exit pcie_portdrv_exit(void)
 294 {
 295         pci_unregister_driver(&pcie_portdriver);
 296         pcie_port_bus_unregister();
 297 }
 298
 299 module_init(pcie_portdrv_init);
 300 module_exit(pcie_portdrv_exit);