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/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/string.h>
  15 #include <linux/slab.h>
  16 #include <linux/pcieport_if.h>
  17
  18 #include "portdrv.h"
  19
  20 extern int pcie_mch_quirk;      /* MSI-quirk Indicator */
  21
  22 static int pcie_port_probe_service(struct device *dev)
  23 {
  24         struct pcie_device *pciedev;
  25         struct pcie_port_service_driver *driver;
  26         int status = -ENODEV;
  27
  28         if (!dev || !dev->driver)
  29                 return status;
  30
  31         driver = to_service_driver(dev->driver);
  32         if (!driver || !driver->probe)
  33                 return status;
  34
  35         pciedev = to_pcie_device(dev);
  36         status = driver->probe(pciedev, driver->id_table);
  37         if (!status) {
  38                 printk(KERN_DEBUG "Load service driver %s on pcie device %s\n",
  39                         driver->name, dev->bus_id);
  40                 get_device(dev);
  41         }
  42         return status;
  43 }
  44
  45 static int pcie_port_remove_service(struct device *dev)
  46 {
  47         struct pcie_device *pciedev;
  48         struct pcie_port_service_driver *driver;
  49
  50         if (!dev || !dev->driver)
  51                 return 0;
  52
  53         pciedev = to_pcie_device(dev);
  54         driver = to_service_driver(dev->driver);
  55         if (driver && driver->remove) {
  56                 printk(KERN_DEBUG "Unload service driver %s on pcie device %s\n",
  57                         driver->name, dev->bus_id);
  58                 driver->remove(pciedev);
  59                 put_device(dev);
  60         }
  61         return 0;
  62 }
  63
  64 static void pcie_port_shutdown_service(struct device *dev) {}
  65
  66 static int pcie_port_suspend_service(struct device *dev, pm_message_t state)
  67 {
  68         struct pcie_device *pciedev;
  69         struct pcie_port_service_driver *driver;
  70
  71         if (!dev || !dev->driver)
  72                 return 0;
  73
  74         pciedev = to_pcie_device(dev);
  75         driver = to_service_driver(dev->driver);
  76         if (driver && driver->suspend)
  77                 driver->suspend(pciedev, state);
  78         return 0;
  79 }
  80
  81 static int pcie_port_resume_service(struct device *dev)
  82 {
  83         struct pcie_device *pciedev;
  84         struct pcie_port_service_driver *driver;
  85
  86         if (!dev || !dev->driver)
  87                 return 0;
  88
  89         pciedev = to_pcie_device(dev);
  90         driver = to_service_driver(dev->driver);
  91
  92         if (driver && driver->resume)
  93                 driver->resume(pciedev);
  94         return 0;
  95 }
  96
  97 /*
  98  * release_pcie_device
  99  *
 100  *      Being invoked automatically when device is being removed
 101  *      in response to device_unregister(dev) call.
 102  *      Release all resources being claimed.
 103  */
 104 static void release_pcie_device(struct device *dev)
 105 {
 106         printk(KERN_DEBUG "Free Port Service[%s]\n", dev->bus_id);
 107         kfree(to_pcie_device(dev));
 108 }
 109
 110 static int is_msi_quirked(struct pci_dev *dev)
 111 {
 112         int port_type, quirk = 0;
 113         u16 reg16;
 114
 115         pci_read_config_word(dev,
 116                 pci_find_capability(dev, PCI_CAP_ID_EXP) +
 117                 PCIE_CAPABILITIES_REG, &reg16);
 118         port_type = (reg16 >> 4) & PORT_TYPE_MASK;
 119         switch(port_type) {
 120         case PCIE_RC_PORT:
 121                 if (pcie_mch_quirk == 1)
 122                         quirk = 1;
 123                 break;
 124         case PCIE_SW_UPSTREAM_PORT:
 125         case PCIE_SW_DOWNSTREAM_PORT:
 126         default:
 127                 break;
 128         }
 129         return quirk;
 130 }
 131
 132 static int assign_interrupt_mode(struct pci_dev *dev, int *vectors, int mask)
 133 {
 134         int i, pos, nvec, status = -EINVAL;
 135         int interrupt_mode = PCIE_PORT_INTx_MODE;
 136
 137         /* Set INTx as default */
 138         for (i = 0, nvec = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 139                 if (mask & (1 << i))
 140                         nvec++;
 141                 vectors[i] = dev->irq;
 142         }
 143
 144         /* Check MSI quirk */
 145         if (is_msi_quirked(dev))
 146                 return interrupt_mode;
 147
 148         /* Select MSI-X over MSI if supported */
 149         pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
 150         if (pos) {
 151                 struct msix_entry msix_entries[PCIE_PORT_DEVICE_MAXSERVICES] =
 152                         {{0, 0}, {0, 1}, {0, 2}, {0, 3}};
 153                 printk("%s Found MSIX capability\n", __FUNCTION__);
 154                 status = pci_enable_msix(dev, msix_entries, nvec);
 155                 if (!status) {
 156                         int j = 0;
 157
 158                         interrupt_mode = PCIE_PORT_MSIX_MODE;
 159                         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 160                                 if (mask & (1 << i))
 161                                         vectors[i] = msix_entries[j++].vector;
 162                         }
 163                 }
 164         }
 165         if (status) {
 166                 pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
 167                 if (pos) {
 168                         printk("%s Found MSI capability\n", __FUNCTION__);
 169                         status = pci_enable_msi(dev);
 170                         if (!status) {
 171                                 interrupt_mode = PCIE_PORT_MSI_MODE;
 172                                 for (i = 0;i < PCIE_PORT_DEVICE_MAXSERVICES;i++)
 173                                         vectors[i] = dev->irq;
 174                         }
 175                 }
 176         }
 177         return interrupt_mode;
 178 }
 179
 180 static int get_port_device_capability(struct pci_dev *dev)
 181 {
 182         int services = 0, pos;
 183         u16 reg16;
 184         u32 reg32;
 185
 186         pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
 187         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg16);
 188         /* Hot-Plug Capable */
 189         if (reg16 & PORT_TO_SLOT_MASK) {
 190                 pci_read_config_dword(dev,
 191                         pos + PCIE_SLOT_CAPABILITIES_REG, &reg32);
 192                 if (reg32 & SLOT_HP_CAPABLE_MASK)
 193                         services |= PCIE_PORT_SERVICE_HP;
 194         }
 195         /* PME Capable */
 196         pos = pci_find_capability(dev, PCI_CAP_ID_PME);
 197         if (pos)
 198                 services |= PCIE_PORT_SERVICE_PME;
 199
 200         pos = PCI_CFG_SPACE_SIZE;
 201         while (pos) {
 202                 pci_read_config_dword(dev, pos, &reg32);
 203                 switch (reg32 & 0xffff) {
 204                 case PCI_EXT_CAP_ID_ERR:
 205                         services |= PCIE_PORT_SERVICE_AER;
 206                         pos = reg32 >> 20;
 207                         break;
 208                 case PCI_EXT_CAP_ID_VC:
 209                         services |= PCIE_PORT_SERVICE_VC;
 210                         pos = reg32 >> 20;
 211                         break;
 212                 default:
 213                         pos = 0;
 214                         break;
 215                 }
 216         }
 217
 218         return services;
 219 }
 220
 221 static void pcie_device_init(struct pci_dev *parent, struct pcie_device *dev,
 222         int port_type, int service_type, int irq, int irq_mode)
 223 {
 224         struct device *device;
 225
 226         dev->port = parent;
 227         dev->interrupt_mode = irq_mode;
 228         dev->irq = irq;
 229         dev->id.vendor = parent->vendor;
 230         dev->id.device = parent->device;
 231         dev->id.port_type = port_type;
 232         dev->id.service_type = (1 << service_type);
 233
 234         /* Initialize generic device interface */
 235         device = &dev->device;
 236         memset(device, 0, sizeof(struct device));
 237         device->bus = &pcie_port_bus_type;
 238         device->driver = NULL;
 239         device->driver_data = NULL;
 240         device->release = release_pcie_device;  /* callback to free pcie dev */
 241         snprintf(device->bus_id, sizeof(device->bus_id), "%s:pcie%02x",
 242                  pci_name(parent), get_descriptor_id(port_type, service_type));
 243         device->parent = &parent->dev;
 244 }
 245
 246 static struct pcie_device* alloc_pcie_device(struct pci_dev *parent,
 247         int port_type, int service_type, int irq, int irq_mode)
 248 {
 249         struct pcie_device *device;
 250
 251         device = kmalloc(sizeof(struct pcie_device), GFP_KERNEL);
 252         if (!device)
 253                 return NULL;
 254
 255         memset(device, 0, sizeof(struct pcie_device));
 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         device_for_each_child(&dev->dev, &state, suspend_iter);
 344         return 0;
 345 }
 346
 347 static int resume_iter(struct device *dev, void *data)
 348 {
 349         struct pcie_port_service_driver *service_driver;
 350
 351         if ((dev->bus == &pcie_port_bus_type) &&
 352             (dev->driver)) {
 353                 service_driver = to_service_driver(dev->driver);
 354                 if (service_driver->resume)
 355                         service_driver->resume(to_pcie_device(dev));
 356         }
 357         return 0;
 358 }
 359
 360 int pcie_port_device_resume(struct pci_dev *dev)
 361 {
 362         device_for_each_child(&dev->dev, NULL, resume_iter);
 363         return 0;
 364 }
 365 #endif
 366
 367 static int remove_iter(struct device *dev, void *data)
 368 {
 369         struct pcie_port_service_driver *service_driver;
 370
 371         if (dev->bus == &pcie_port_bus_type) {
 372                 if (dev->driver) {
 373                         service_driver = to_service_driver(dev->driver);
 374                         if (service_driver->remove)
 375                                 service_driver->remove(to_pcie_device(dev));
 376                 }
 377                 *(unsigned long*)data = (unsigned long)dev;
 378                 return 1;
 379         }
 380         return 0;
 381 }
 382
 383 void pcie_port_device_remove(struct pci_dev *dev)
 384 {
 385         struct device *device;
 386         unsigned long device_addr;
 387         int interrupt_mode = PCIE_PORT_INTx_MODE;
 388         int status;
 389
 390         do {
 391                 status = device_for_each_child(&dev->dev, &device_addr, remove_iter);
 392                 if (status) {
 393                         device = (struct device*)device_addr;
 394                         interrupt_mode = (to_pcie_device(device))->interrupt_mode;
 395                         put_device(device);
 396                         device_unregister(device);
 397                 }
 398         } while (status);
 399         /* Switch to INTx by default if MSI enabled */
 400         if (interrupt_mode == PCIE_PORT_MSIX_MODE)
 401                 pci_disable_msix(dev);
 402         else if (interrupt_mode == PCIE_PORT_MSI_MODE)
 403                 pci_disable_msi(dev);
 404 }
 405
 406 void pcie_port_bus_register(void)
 407 {
 408         bus_register(&pcie_port_bus_type);
 409 }
 410
 411 void pcie_port_bus_unregister(void)
 412 {
 413         bus_unregister(&pcie_port_bus_type);
 414 }
 415
 416 int pcie_port_service_register(struct pcie_port_service_driver *new)
 417 {
 418         new->driver.name = (char *)new->name;
 419         new->driver.bus = &pcie_port_bus_type;
 420         new->driver.probe = pcie_port_probe_service;
 421         new->driver.remove = pcie_port_remove_service;
 422         new->driver.shutdown = pcie_port_shutdown_service;
 423         new->driver.suspend = pcie_port_suspend_service;
 424         new->driver.resume = pcie_port_resume_service;
 425
 426         return driver_register(&new->driver);
 427 }
 428
 429 void pcie_port_service_unregister(struct pcie_port_service_driver *new)
 430 {
 431         driver_unregister(&new->driver);
 432 }
 433
 434 EXPORT_SYMBOL(pcie_port_service_register);
 435 EXPORT_SYMBOL(pcie_port_service_unregister);