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