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         return 0;
 101 }
 102
 103 static void pcie_portdrv_remove (struct pci_dev *dev)
 104 {
 105         pcie_port_device_remove(dev);
 106         kfree(pci_get_drvdata(dev));
 107 }
 108
 109 static int error_detected_iter(struct device *device, void *data)
 110 {
 111         struct pcie_device *pcie_device;
 112         struct pcie_port_service_driver *driver;
 113         struct aer_broadcast_data *result_data;
 114         pci_ers_result_t status;
 115
 116         result_data = (struct aer_broadcast_data *) data;
 117
 118         if (device->bus == &pcie_port_bus_type && device->driver) {
 119                 driver = to_service_driver(device->driver);
 120                 if (!driver ||
 121                         !driver->err_handler ||
 122                         !driver->err_handler->error_detected)
 123                         return 0;
 124
 125                 pcie_device = to_pcie_device(device);
 126
 127                 /* Forward error detected message to service drivers */
 128                 status = driver->err_handler->error_detected(
 129                         pcie_device->port,
 130                         result_data->state);
 131                 result_data->result =
 132                         merge_result(result_data->result, status);
 133         }
 134
 135         return 0;
 136 }
 137
 138 static pci_ers_result_t pcie_portdrv_error_detected(struct pci_dev *dev,
 139                                         enum pci_channel_state error)
 140 {
 141         struct aer_broadcast_data result_data =
 142                         {error, PCI_ERS_RESULT_CAN_RECOVER};
 143         int retval;
 144
 145         /* can not fail */
 146         retval = device_for_each_child(&dev->dev, &result_data, error_detected_iter);
 147
 148         return result_data.result;
 149 }
 150
 151 static int mmio_enabled_iter(struct device *device, void *data)
 152 {
 153         struct pcie_device *pcie_device;
 154         struct pcie_port_service_driver *driver;
 155         pci_ers_result_t status, *result;
 156
 157         result = (pci_ers_result_t *) data;
 158
 159         if (device->bus == &pcie_port_bus_type && device->driver) {
 160                 driver = to_service_driver(device->driver);
 161                 if (driver &&
 162                         driver->err_handler &&
 163                         driver->err_handler->mmio_enabled) {
 164                         pcie_device = to_pcie_device(device);
 165
 166                         /* Forward error message to service drivers */
 167                         status = driver->err_handler->mmio_enabled(
 168                                         pcie_device->port);
 169                         *result = merge_result(*result, status);
 170                 }
 171         }
 172
 173         return 0;
 174 }
 175
 176 static pci_ers_result_t pcie_portdrv_mmio_enabled(struct pci_dev *dev)
 177 {
 178         pci_ers_result_t status = PCI_ERS_RESULT_RECOVERED;
 179         int retval;
 180
 181         /* get true return value from &status */
 182         retval = device_for_each_child(&dev->dev, &status, mmio_enabled_iter);
 183         return status;
 184 }
 185
 186 static int slot_reset_iter(struct device *device, void *data)
 187 {
 188         struct pcie_device *pcie_device;
 189         struct pcie_port_service_driver *driver;
 190         pci_ers_result_t status, *result;
 191
 192         result = (pci_ers_result_t *) data;
 193
 194         if (device->bus == &pcie_port_bus_type && device->driver) {
 195                 driver = to_service_driver(device->driver);
 196                 if (driver &&
 197                         driver->err_handler &&
 198                         driver->err_handler->slot_reset) {
 199                         pcie_device = to_pcie_device(device);
 200
 201                         /* Forward error message to service drivers */
 202                         status = driver->err_handler->slot_reset(
 203                                         pcie_device->port);
 204                         *result = merge_result(*result, status);
 205                 }
 206         }
 207
 208         return 0;
 209 }
 210
 211 static pci_ers_result_t pcie_portdrv_slot_reset(struct pci_dev *dev)
 212 {
 213         pci_ers_result_t status = PCI_ERS_RESULT_NONE;
 214         int retval;
 215
 216         /* If fatal, restore cfg space for possible link reset at upstream */
 217         if (dev->error_state == pci_channel_io_frozen) {
 218                 pci_restore_state(dev);
 219                 pcie_portdrv_restore_config(dev);
 220                 pci_enable_pcie_error_reporting(dev);
 221         }
 222
 223         /* get true return value from &status */
 224         retval = device_for_each_child(&dev->dev, &status, slot_reset_iter);
 225
 226         return status;
 227 }
 228
 229 static int resume_iter(struct device *device, void *data)
 230 {
 231         struct pcie_device *pcie_device;
 232         struct pcie_port_service_driver *driver;
 233
 234         if (device->bus == &pcie_port_bus_type && device->driver) {
 235                 driver = to_service_driver(device->driver);
 236                 if (driver &&
 237                         driver->err_handler &&
 238                         driver->err_handler->resume) {
 239                         pcie_device = to_pcie_device(device);
 240
 241                         /* Forward error message to service drivers */
 242                         driver->err_handler->resume(pcie_device->port);
 243                 }
 244         }
 245
 246         return 0;
 247 }
 248
 249 static void pcie_portdrv_err_resume(struct pci_dev *dev)
 250 {
 251         int retval;
 252         /* nothing to do with error value, if it ever happens */
 253         retval = device_for_each_child(&dev->dev, NULL, resume_iter);
 254 }
 255
 256 /*
 257  * LINUX Device Driver Model
 258  */
 259 static const struct pci_device_id port_pci_ids[] = { {
 260         /* handle any PCI-Express port */
 261         PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0),
 262         }, { /* end: all zeroes */ }
 263 };
 264 MODULE_DEVICE_TABLE(pci, port_pci_ids);
 265
 266 static struct pci_error_handlers pcie_portdrv_err_handler = {
 267                 .error_detected = pcie_portdrv_error_detected,
 268                 .mmio_enabled = pcie_portdrv_mmio_enabled,
 269                 .slot_reset = pcie_portdrv_slot_reset,
 270                 .resume = pcie_portdrv_err_resume,
 271 };
 272
 273 static struct pci_driver pcie_portdriver = {
 274         .name           = (char *)device_name,
 275         .id_table       = &port_pci_ids[0],
 276
 277         .probe          = pcie_portdrv_probe,
 278         .remove         = pcie_portdrv_remove,
 279
 280         .suspend        = pcie_portdrv_suspend,
 281         .resume         = pcie_portdrv_resume,
 282
 283         .err_handler    = &pcie_portdrv_err_handler,
 284 };
 285
 286 static int __init pcie_portdrv_init(void)
 287 {
 288         int retval;
 289
 290         retval = pcie_port_bus_register();
 291         if (retval) {
 292                 printk(KERN_WARNING "PCIE: bus_register error: %d\n", retval);
 293                 goto out;
 294         }
 295         retval = pci_register_driver(&pcie_portdriver);
 296         if (retval)
 297                 pcie_port_bus_unregister();
 298  out:
 299         return retval;
 300 }
 301
 302 static void __exit pcie_portdrv_exit(void)
 303 {
 304         pci_unregister_driver(&pcie_portdriver);
 305         pcie_port_bus_unregister();
 306 }
 307
 308 module_init(pcie_portdrv_init);
 309 module_exit(pcie_portdrv_exit);