drivers/pci/pcie/portdrv_core.c

   1 /*
   2  * File:        portdrv_core.c
   3  * Purpose:     PCI Express Port Bus Driver's Core Functions
   4  *
   5  * Copyright (C) 2004 Intel
   6  * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
   7  */
   8
   9 #include <linux/compiler.h>
  10 #include <linux/module.h>
  11 #include <linux/pci.h>
  12 #include <linux/kernel.h>
  13 #include <linux/errno.h>
  14 #include <linux/pm.h>
  15 #include <linux/string.h>
  16 #include <linux/slab.h>
  17 #include <linux/pcieport_if.h>
  18
  19 #include "portdrv.h"
  20
  21 extern int pcie_mch_quirk;      /* MSI-quirk Indicator */
  22
  23 static int pcie_port_probe_service(struct device *dev)
  24 {
  25         struct pcie_device *pciedev;
  26         struct pcie_port_service_driver *driver;
  27         int status = -ENODEV;
  28
  29         if (!dev || !dev->driver)
  30                 return status;
  31
  32         driver = to_service_driver(dev->driver);
  33         if (!driver || !driver->probe)
  34                 return status;
  35
  36         pciedev = to_pcie_device(dev);
  37         status = driver->probe(pciedev, driver->id_table);
  38         if (!status) {
  39                 printk(KERN_DEBUG "Load service driver %s on pcie device %s\n",
  40                         driver->name, dev->bus_id);
  41                 get_device(dev);
  42         }
  43         return status;
  44 }
  45
  46 static int pcie_port_remove_service(struct device *dev)
  47 {
  48         struct pcie_device *pciedev;
  49         struct pcie_port_service_driver *driver;
  50
  51         if (!dev || !dev->driver)
  52                 return 0;
  53
  54         pciedev = to_pcie_device(dev);
  55         driver = to_service_driver(dev->driver);
  56         if (driver && driver->remove) {
  57                 printk(KERN_DEBUG "Unload service driver %s on pcie device %s\n",
  58                         driver->name, dev->bus_id);
  59                 driver->remove(pciedev);
  60                 put_device(dev);
  61         }
  62         return 0;
  63 }
  64
  65 static void pcie_port_shutdown_service(struct device *dev) {}
  66
  67 static int pcie_port_suspend_service(struct device *dev, pm_message_t state)
  68 {
  69         struct pcie_device *pciedev;
  70         struct pcie_port_service_driver *driver;
  71
  72         if (!dev || !dev->driver)
  73                 return 0;
  74
  75         pciedev = to_pcie_device(dev);
  76         driver = to_service_driver(dev->driver);
  77         if (driver && driver->suspend)
  78                 driver->suspend(pciedev, state);
  79         return 0;
  80 }
  81
  82 static int pcie_port_resume_service(struct device *dev)
  83 {
  84         struct pcie_device *pciedev;
  85         struct pcie_port_service_driver *driver;
  86
  87         if (!dev || !dev->driver)
  88                 return 0;
  89
  90         pciedev = to_pcie_device(dev);
  91         driver = to_service_driver(dev->driver);
  92
  93         if (driver && driver->resume)
  94                 driver->resume(pciedev);
  95         return 0;
  96 }
  97
  98 /*
  99  * release_pcie_device
 100  *
 101  *      Being invoked automatically when device is being removed
 102  *      in response to device_unregister(dev) call.
 103  *      Release all resources being claimed.
 104  */
 105 static void release_pcie_device(struct device *dev)
 106 {
 107         printk(KERN_DEBUG "Free Port Service[%s]\n", dev->bus_id);
 108         kfree(to_pcie_device(dev));
 109 }
 110
 111 static int is_msi_quirked(struct pci_dev *dev)
 112 {
 113         int port_type, quirk = 0;
 114         u16 reg16;
 115
 116         pci_read_config_word(dev,
 117                 pci_find_capability(dev, PCI_CAP_ID_EXP) +
 118                 PCIE_CAPABILITIES_REG, &reg16);
 119         port_type = (reg16 >> 4) & PORT_TYPE_MASK;
 120         switch(port_type) {
 121         case PCIE_RC_PORT:
 122                 if (pcie_mch_quirk == 1)
 123                         quirk = 1;
 124                 break;
 125         case PCIE_SW_UPSTREAM_PORT:
 126         case PCIE_SW_DOWNSTREAM_PORT:
 127         default:
 128                 break;
 129         }
 130         return quirk;
 131 }
 132
 133 static int assign_interrupt_mode(struct pci_dev *dev, int *vectors, int mask)
 134 {
 135         int i, pos, nvec, status = -EINVAL;
 136         int interrupt_mode = PCIE_PORT_INTx_MODE;
 137
 138         /* Set INTx as default */
 139         for (i = 0, nvec = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 140                 if (mask & (1 << i))
 141                         nvec++;
 142                 vectors[i] = dev->irq;
 143         }
 144
 145         /* Check MSI quirk */
 146         if (is_msi_quirked(dev))
 147                 return interrupt_mode;
 148
 149         /* Select MSI-X over MSI if supported */
 150         pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
 151         if (pos) {
 152                 struct msix_entry msix_entries[PCIE_PORT_DEVICE_MAXSERVICES] =
 153                         {{0, 0}, {0, 1}, {0, 2}, {0, 3}};
 154                 printk("%s Found MSIX capability\n", __FUNCTION__);
 155                 status = pci_enable_msix(dev, msix_entries, nvec);
 156                 if (!status) {
 157                         int j = 0;
 158
 159                         interrupt_mode = PCIE_PORT_MSIX_MODE;
 160                         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 161                                 if (mask & (1 << i))
 162                                         vectors[i] = msix_entries[j++].vector;
 163                         }
 164                 }
 165         }
 166         if (status) {
 167                 pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
 168                 if (pos) {
 169                         printk("%s Found MSI capability\n", __FUNCTION__);
 170                         status = pci_enable_msi(dev);
 171                         if (!status) {
 172                                 interrupt_mode = PCIE_PORT_MSI_MODE;
 173                                 for (i = 0;i < PCIE_PORT_DEVICE_MAXSERVICES;i++)
 174                                         vectors[i] = dev->irq;
 175                         }
 176                 }
 177         }
 178         return interrupt_mode;
 179 }
 180
 181 static int get_port_device_capability(struct pci_dev *dev)
 182 {
 183         int services = 0, pos;
 184         u16 reg16;
 185         u32 reg32;
 186
 187         pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
 188         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg16);
 189         /* Hot-Plug Capable */
 190         if (reg16 & PORT_TO_SLOT_MASK) {
 191                 pci_read_config_dword(dev,
 192                         pos + PCIE_SLOT_CAPABILITIES_REG, &reg32);
 193                 if (reg32 & SLOT_HP_CAPABLE_MASK)
 194                         services |= PCIE_PORT_SERVICE_HP;
 195         }
 196         /* PME Capable */
 197         pos = pci_find_capability(dev, PCI_CAP_ID_PME);
 198         if (pos)
 199                 services |= PCIE_PORT_SERVICE_PME;
 200
 201         pos = PCI_CFG_SPACE_SIZE;
 202         while (pos) {
 203                 pci_read_config_dword(dev, pos, &reg32);
 204                 switch (reg32 & 0xffff) {
 205                 case PCI_EXT_CAP_ID_ERR:
 206                         services |= PCIE_PORT_SERVICE_AER;
 207                         pos = reg32 >> 20;
 208                         break;
 209                 case PCI_EXT_CAP_ID_VC:
 210                         services |= PCIE_PORT_SERVICE_VC;
 211                         pos = reg32 >> 20;
 212                         break;
 213                 default:
 214                         pos = 0;
 215                         break;
 216                 }
 217         }
 218
 219         return services;
 220 }
 221
 222 static void pcie_device_init(struct pci_dev *parent, struct pcie_device *dev,
 223         int port_type, int service_type, int irq, int irq_mode)
 224 {
 225         struct device *device;
 226
 227         dev->port = parent;
 228         dev->interrupt_mode = irq_mode;
 229         dev->irq = irq;
 230         dev->id.vendor = parent->vendor;
 231         dev->id.device = parent->device;
 232         dev->id.port_type = port_type;
 233         dev->id.service_type = (1 << service_type);
 234
 235         /* Initialize generic device interface */
 236         device = &dev->device;
 237         memset(device, 0, sizeof(struct device));
 238         device->bus = &pcie_port_bus_type;
 239         device->driver = NULL;
 240         device->driver_data = NULL;
 241         device->release = release_pcie_device;  /* callback to free pcie dev */
 242         snprintf(device->bus_id, sizeof(device->bus_id), "%s:pcie%02x",
 243                  pci_name(parent), get_descriptor_id(port_type, service_type));
 244         device->parent = &parent->dev;
 245 }
 246
 247 static struct pcie_device* alloc_pcie_device(struct pci_dev *parent,
 248         int port_type, int service_type, int irq, int irq_mode)
 249 {
 250         struct pcie_device *device;
 251
 252         device = kzalloc(sizeof(struct pcie_device), GFP_KERNEL);
 253         if (!device)
 254                 return NULL;
 255
 256         pcie_device_init(parent, device, port_type, service_type, irq,irq_mode);
 257         printk(KERN_DEBUG "Allocate Port Service[%s]\n", device->device.bus_id);
 258         return device;
 259 }
 260
 261 int pcie_port_device_probe(struct pci_dev *dev)
 262 {
 263         int pos, type;
 264         u16 reg;
 265
 266         if (!(pos = pci_find_capability(dev, PCI_CAP_ID_EXP)))
 267                 return -ENODEV;
 268
 269         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg);
 270         type = (reg >> 4) & PORT_TYPE_MASK;
 271         if (    type == PCIE_RC_PORT || type == PCIE_SW_UPSTREAM_PORT ||
 272                 type == PCIE_SW_DOWNSTREAM_PORT )
 273                 return 0;
 274
 275         return -ENODEV;
 276 }
 277
 278 int pcie_port_device_register(struct pci_dev *dev)
 279 {
 280         struct pcie_port_device_ext *p_ext;
 281         int status, type, capabilities, irq_mode, i;
 282         int vectors[PCIE_PORT_DEVICE_MAXSERVICES];
 283         u16 reg16;
 284
 285         /* Allocate port device extension */
 286         if (!(p_ext = kmalloc(sizeof(struct pcie_port_device_ext), GFP_KERNEL)))
 287                 return -ENOMEM;
 288
 289         pci_set_drvdata(dev, p_ext);
 290
 291         /* Get port type */
 292         pci_read_config_word(dev,
 293                 pci_find_capability(dev, PCI_CAP_ID_EXP) +
 294                 PCIE_CAPABILITIES_REG, &reg16);
 295         type = (reg16 >> 4) & PORT_TYPE_MASK;
 296
 297         /* Now get port services */
 298         capabilities = get_port_device_capability(dev);
 299         irq_mode = assign_interrupt_mode(dev, vectors, capabilities);
 300         p_ext->interrupt_mode = irq_mode;
 301
 302         /* Allocate child services if any */
 303         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 304                 struct pcie_device *child;
 305
 306                 if (capabilities & (1 << i)) {
 307                         child = alloc_pcie_device(
 308                                 dev,            /* parent */
 309                                 type,           /* port type */
 310                                 i,              /* service type */
 311                                 vectors[i],     /* irq */
 312                                 irq_mode        /* interrupt mode */);
 313                         if (child) {
 314                                 status = device_register(&child->device);
 315                                 if (status) {
 316                                         kfree(child);
 317                                         continue;
 318                                 }
 319                                 get_device(&child->device);
 320                         }
 321                 }
 322         }
 323         return 0;
 324 }
 325
 326 #ifdef CONFIG_PM
 327 static int suspend_iter(struct device *dev, void *data)
 328 {
 329         struct pcie_port_service_driver *service_driver;
 330         pm_message_t state = * (pm_message_t *) data;
 331
 332         if ((dev->bus == &pcie_port_bus_type) &&
 333             (dev->driver)) {
 334                 service_driver = to_service_driver(dev->driver);
 335                 if (service_driver->suspend)
 336                         service_driver->suspend(to_pcie_device(dev), state);
 337         }
 338         return 0;
 339 }
 340
 341 int pcie_port_device_suspend(struct pci_dev *dev, pm_message_t state)
 342 {
 343         return device_for_each_child(&dev->dev, &state, suspend_iter);
 344 }
 345
 346 static int resume_iter(struct device *dev, void *data)
 347 {
 348         struct pcie_port_service_driver *service_driver;
 349
 350         if ((dev->bus == &pcie_port_bus_type) &&
 351             (dev->driver)) {
 352                 service_driver = to_service_driver(dev->driver);
 353                 if (service_driver->resume)
 354                         service_driver->resume(to_pcie_device(dev));
 355         }
 356         return 0;
 357 }
 358
 359 int pcie_port_device_resume(struct pci_dev *dev)
 360 {
 361         return device_for_each_child(&dev->dev, NULL, resume_iter);
 362 }
 363 #endif
 364
 365 static int remove_iter(struct device *dev, void *data)
 366 {
 367         struct pcie_port_service_driver *service_driver;
 368
 369         if (dev->bus == &pcie_port_bus_type) {
 370                 if (dev->driver) {
 371                         service_driver = to_service_driver(dev->driver);
 372                         if (service_driver->remove)
 373                                 service_driver->remove(to_pcie_device(dev));
 374                 }
 375                 *(unsigned long*)data = (unsigned long)dev;
 376                 return 1;
 377         }
 378         return 0;
 379 }
 380
 381 void pcie_port_device_remove(struct pci_dev *dev)
 382 {
 383         struct device *device;
 384         unsigned long device_addr;
 385         int interrupt_mode = PCIE_PORT_INTx_MODE;
 386         int status;
 387
 388         do {
 389                 status = device_for_each_child(&dev->dev, &device_addr, remove_iter);
 390                 if (status) {
 391                         device = (struct device*)device_addr;
 392                         interrupt_mode = (to_pcie_device(device))->interrupt_mode;
 393                         put_device(device);
 394                         device_unregister(device);
 395                 }
 396         } while (status);
 397         /* Switch to INTx by default if MSI enabled */
 398         if (interrupt_mode == PCIE_PORT_MSIX_MODE)
 399                 pci_disable_msix(dev);
 400         else if (interrupt_mode == PCIE_PORT_MSI_MODE)
 401                 pci_disable_msi(dev);
 402 }
 403
 404 int __must_check pcie_port_bus_register(void)
 405 {
 406         return bus_register(&pcie_port_bus_type);
 407 }
 408
 409 void pcie_port_bus_unregister(void)
 410 {
 411         bus_unregister(&pcie_port_bus_type);
 412 }
 413
 414 int pcie_port_service_register(struct pcie_port_service_driver *new)
 415 {
 416         new->driver.name = (char *)new->name;
 417         new->driver.bus = &pcie_port_bus_type;
 418         new->driver.probe = pcie_port_probe_service;
 419         new->driver.remove = pcie_port_remove_service;
 420         new->driver.shutdown = pcie_port_shutdown_service;
 421         new->driver.suspend = pcie_port_suspend_service;
 422         new->driver.resume = pcie_port_resume_service;
 423
 424         return driver_register(&new->driver);
 425 }
 426
 427 void pcie_port_service_unregister(struct pcie_port_service_driver *new)
 428 {
 429         driver_unregister(&new->driver);
 430 }
 431
 432 EXPORT_SYMBOL(pcie_port_service_register);
 433 EXPORT_SYMBOL(pcie_port_service_unregister);