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