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 "../pci.h"
  19 #include "portdrv.h"
  20
  21 /**
  22  * release_pcie_device - free PCI Express port service device structure
  23  * @dev: Port service device to release
  24  *
  25  * Invoked automatically when device is being removed in response to
  26  * device_unregister(dev).  Release all resources being claimed.
  27  */
  28 static void release_pcie_device(struct device *dev)
  29 {
  30         kfree(to_pcie_device(dev));
  31 }
  32
  33 /**
  34  * pcie_port_msix_add_entry - add entry to given array of MSI-X entries
  35  * @entries: Array of MSI-X entries
  36  * @new_entry: Index of the entry to add to the array
  37  * @nr_entries: Number of entries aleady in the array
  38  *
  39  * Return value: Position of the added entry in the array
  40  */
  41 static int pcie_port_msix_add_entry(
  42         struct msix_entry *entries, int new_entry, int nr_entries)
  43 {
  44         int j;
  45
  46         for (j = 0; j < nr_entries; j++)
  47                 if (entries[j].entry == new_entry)
  48                         return j;
  49
  50         entries[j].entry = new_entry;
  51         return j;
  52 }
  53
  54 /**
  55  * pcie_port_enable_msix - try to set up MSI-X as interrupt mode for given port
  56  * @dev: PCI Express port to handle
  57  * @vectors: Array of interrupt vectors to populate
  58  * @mask: Bitmask of port capabilities returned by get_port_device_capability()
  59  *
  60  * Return value: 0 on success, error code on failure
  61  */
  62 static int pcie_port_enable_msix(struct pci_dev *dev, int *vectors, int mask)
  63 {
  64         struct msix_entry *msix_entries;
  65         int idx[PCIE_PORT_DEVICE_MAXSERVICES];
  66         int nr_entries, status, pos, i, nvec;
  67         u16 reg16;
  68         u32 reg32;
  69
  70         nr_entries = pci_msix_table_size(dev);
  71         if (!nr_entries)
  72                 return -EINVAL;
  73         if (nr_entries > PCIE_PORT_MAX_MSIX_ENTRIES)
  74                 nr_entries = PCIE_PORT_MAX_MSIX_ENTRIES;
  75
  76         msix_entries = kzalloc(sizeof(*msix_entries) * nr_entries, GFP_KERNEL);
  77         if (!msix_entries)
  78                 return -ENOMEM;
  79
  80         /*
  81          * Allocate as many entries as the port wants, so that we can check
  82          * which of them will be useful.  Moreover, if nr_entries is correctly
  83          * equal to the number of entries this port actually uses, we'll happily
  84          * go through without any tricks.
  85          */
  86         for (i = 0; i < nr_entries; i++)
  87                 msix_entries[i].entry = i;
  88
  89         status = pci_enable_msix(dev, msix_entries, nr_entries);
  90         if (status)
  91                 goto Exit;
  92
  93         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++)
  94                 idx[i] = -1;
  95         status = -EIO;
  96         nvec = 0;
  97
  98         if (mask & (PCIE_PORT_SERVICE_PME | PCIE_PORT_SERVICE_HP)) {
  99                 int entry;
 100
 101                 /*
 102                  * The code below follows the PCI Express Base Specification 2.0
 103                  * stating in Section 6.1.6 that "PME and Hot-Plug Event
 104                  * interrupts (when both are implemented) always share the same
 105                  * MSI or MSI-X vector, as indicated by the Interrupt Message
 106                  * Number field in the PCI Express Capabilities register", where
 107                  * according to Section 7.8.2 of the specification "For MSI-X,
 108                  * the value in this field indicates which MSI-X Table entry is
 109                  * used to generate the interrupt message."
 110                  */
 111                 pos = pci_pcie_cap(dev);
 112                 pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg16);
 113                 entry = (reg16 >> 9) & PCIE_PORT_MSI_VECTOR_MASK;
 114                 if (entry >= nr_entries)
 115                         goto Error;
 116
 117                 i = pcie_port_msix_add_entry(msix_entries, entry, nvec);
 118                 if (i == nvec)
 119                         nvec++;
 120
 121                 idx[PCIE_PORT_SERVICE_PME_SHIFT] = i;
 122                 idx[PCIE_PORT_SERVICE_HP_SHIFT] = i;
 123         }
 124
 125         if (mask & PCIE_PORT_SERVICE_AER) {
 126                 int entry;
 127
 128                 /*
 129                  * The code below follows Section 7.10.10 of the PCI Express
 130                  * Base Specification 2.0 stating that bits 31-27 of the Root
 131                  * Error Status Register contain a value indicating which of the
 132                  * MSI/MSI-X vectors assigned to the port is going to be used
 133                  * for AER, where "For MSI-X, the value in this register
 134                  * indicates which MSI-X Table entry is used to generate the
 135                  * interrupt message."
 136                  */
 137                 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ERR);
 138                 pci_read_config_dword(dev, pos + PCI_ERR_ROOT_STATUS, &reg32);
 139                 entry = reg32 >> 27;
 140                 if (entry >= nr_entries)
 141                         goto Error;
 142
 143                 i = pcie_port_msix_add_entry(msix_entries, entry, nvec);
 144                 if (i == nvec)
 145                         nvec++;
 146
 147                 idx[PCIE_PORT_SERVICE_AER_SHIFT] = i;
 148         }
 149
 150         /*
 151          * If nvec is equal to the allocated number of entries, we can just use
 152          * what we have.  Otherwise, the port has some extra entries not for the
 153          * services we know and we need to work around that.
 154          */
 155         if (nvec == nr_entries) {
 156                 status = 0;
 157         } else {
 158                 /* Drop the temporary MSI-X setup */
 159                 pci_disable_msix(dev);
 160
 161                 /* Now allocate the MSI-X vectors for real */
 162                 status = pci_enable_msix(dev, msix_entries, nvec);
 163                 if (status)
 164                         goto Exit;
 165         }
 166
 167         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++)
 168                 vectors[i] = idx[i] >= 0 ? msix_entries[idx[i]].vector : -1;
 169
 170  Exit:
 171         kfree(msix_entries);
 172         return status;
 173
 174  Error:
 175         pci_disable_msix(dev);
 176         goto Exit;
 177 }
 178
 179 /**
 180  * assign_interrupt_mode - choose interrupt mode for PCI Express port services
 181  *                         (INTx, MSI-X, MSI) and set up vectors
 182  * @dev: PCI Express port to handle
 183  * @vectors: Array of interrupt vectors to populate
 184  * @mask: Bitmask of port capabilities returned by get_port_device_capability()
 185  *
 186  * Return value: Interrupt mode associated with the port
 187  */
 188 static int assign_interrupt_mode(struct pci_dev *dev, int *vectors, int mask)
 189 {
 190         int irq, interrupt_mode = PCIE_PORT_NO_IRQ;
 191         int i;
 192
 193         /* Try to use MSI-X if supported */
 194         if (!pcie_port_enable_msix(dev, vectors, mask))
 195                 return PCIE_PORT_MSIX_MODE;
 196
 197         /* We're not going to use MSI-X, so try MSI and fall back to INTx */
 198         if (!pci_enable_msi(dev))
 199                 interrupt_mode = PCIE_PORT_MSI_MODE;
 200
 201         if (interrupt_mode == PCIE_PORT_NO_IRQ && dev->pin)
 202                 interrupt_mode = PCIE_PORT_INTx_MODE;
 203
 204         irq = interrupt_mode != PCIE_PORT_NO_IRQ ? dev->irq : -1;
 205         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++)
 206                 vectors[i] = irq;
 207
 208         vectors[PCIE_PORT_SERVICE_VC_SHIFT] = -1;
 209
 210         return interrupt_mode;
 211 }
 212
 213 /**
 214  * get_port_device_capability - discover capabilities of a PCI Express port
 215  * @dev: PCI Express port to examine
 216  *
 217  * The capabilities are read from the port's PCI Express configuration registers
 218  * as described in PCI Express Base Specification 1.0a sections 7.8.2, 7.8.9 and
 219  * 7.9 - 7.11.
 220  *
 221  * Return value: Bitmask of discovered port capabilities
 222  */
 223 static int get_port_device_capability(struct pci_dev *dev)
 224 {
 225         int services = 0, pos;
 226         u16 reg16;
 227         u32 reg32;
 228
 229         pos = pci_pcie_cap(dev);
 230         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg16);
 231         /* Hot-Plug Capable */
 232         if (reg16 & PORT_TO_SLOT_MASK) {
 233                 pci_read_config_dword(dev,
 234                         pos + PCIE_SLOT_CAPABILITIES_REG, &reg32);
 235                 if (reg32 & SLOT_HP_CAPABLE_MASK)
 236                         services |= PCIE_PORT_SERVICE_HP;
 237         }
 238         /* AER capable */
 239         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ERR))
 240                 services |= PCIE_PORT_SERVICE_AER;
 241         /* VC support */
 242         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_VC))
 243                 services |= PCIE_PORT_SERVICE_VC;
 244
 245         return services;
 246 }
 247
 248 /**
 249  * pcie_device_init - initialize PCI Express port service device
 250  * @dev: Port service device to initialize
 251  * @parent: PCI Express port to associate the service device with
 252  * @port_type: Type of the port
 253  * @service_type: Type of service to associate with the service device
 254  * @irq: Interrupt vector to associate with the service device
 255  */
 256 static void pcie_device_init(struct pci_dev *parent, struct pcie_device *dev,
 257         int service_type, int irq)
 258 {
 259         struct pcie_port_data *port_data = pci_get_drvdata(parent);
 260         struct device *device;
 261         int port_type = port_data->port_type;
 262
 263         dev->port = parent;
 264         dev->irq = irq;
 265         dev->service = service_type;
 266
 267         /* Initialize generic device interface */
 268         device = &dev->device;
 269         memset(device, 0, sizeof(struct device));
 270         device->bus = &pcie_port_bus_type;
 271         device->driver = NULL;
 272         dev_set_drvdata(device, NULL);
 273         device->release = release_pcie_device;  /* callback to free pcie dev */
 274         dev_set_name(device, "%s:pcie%02x",
 275                  pci_name(parent), get_descriptor_id(port_type, service_type));
 276         device->parent = &parent->dev;
 277 }
 278
 279 /**
 280  * alloc_pcie_device - allocate PCI Express port service device structure
 281  * @parent: PCI Express port to associate the service device with
 282  * @port_type: Type of the port
 283  * @service_type: Type of service to associate with the service device
 284  * @irq: Interrupt vector to associate with the service device
 285  */
 286 static struct pcie_device* alloc_pcie_device(struct pci_dev *parent,
 287         int service_type, int irq)
 288 {
 289         struct pcie_device *device;
 290
 291         device = kzalloc(sizeof(struct pcie_device), GFP_KERNEL);
 292         if (!device)
 293                 return NULL;
 294
 295         pcie_device_init(parent, device, service_type, irq);
 296         return device;
 297 }
 298
 299 /**
 300  * pcie_port_device_register - register PCI Express port
 301  * @dev: PCI Express port to register
 302  *
 303  * Allocate the port extension structure and register services associated with
 304  * the port.
 305  */
 306 int pcie_port_device_register(struct pci_dev *dev)
 307 {
 308         struct pcie_port_data *port_data;
 309         int status, capabilities, irq_mode, i, nr_serv, pos;
 310         int vectors[PCIE_PORT_DEVICE_MAXSERVICES];
 311         u16 reg16;
 312
 313         port_data = kzalloc(sizeof(*port_data), GFP_KERNEL);
 314         if (!port_data)
 315                 return -ENOMEM;
 316         pci_set_drvdata(dev, port_data);
 317
 318         /* Get port type */
 319         pos = pci_pcie_cap(dev);
 320         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg16);
 321         port_data->port_type = (reg16 >> 4) & PORT_TYPE_MASK;
 322
 323         capabilities = get_port_device_capability(dev);
 324         /* Root ports are capable of generating PME too */
 325         if (port_data->port_type == PCIE_RC_PORT)
 326                 capabilities |= PCIE_PORT_SERVICE_PME;
 327
 328         irq_mode = assign_interrupt_mode(dev, vectors, capabilities);
 329         if (irq_mode == PCIE_PORT_NO_IRQ) {
 330                 /*
 331                  * Don't use service devices that require interrupts if there is
 332                  * no way to generate them.
 333                  */
 334                 if (!(capabilities & PCIE_PORT_SERVICE_VC)) {
 335                         status = -ENODEV;
 336                         goto Error;
 337                 }
 338                 capabilities = PCIE_PORT_SERVICE_VC;
 339         }
 340         port_data->port_irq_mode = irq_mode;
 341
 342         status = pci_enable_device(dev);
 343         if (status)
 344                 goto Error;
 345         pci_set_master(dev);
 346
 347         /* Allocate child services if any */
 348         for (i = 0, nr_serv = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 349                 struct pcie_device *child;
 350                 int service = 1 << i;
 351
 352                 if (!(capabilities & service))
 353                         continue;
 354
 355                 child = alloc_pcie_device(dev, service, vectors[i]);
 356                 if (!child)
 357                         continue;
 358
 359                 status = device_register(&child->device);
 360                 if (status) {
 361                         kfree(child);
 362                         continue;
 363                 }
 364
 365                 get_device(&child->device);
 366                 nr_serv++;
 367         }
 368         if (!nr_serv) {
 369                 pci_disable_device(dev);
 370                 status = -ENODEV;
 371                 goto Error;
 372         }
 373
 374         return 0;
 375
 376  Error:
 377         kfree(port_data);
 378         return status;
 379 }
 380
 381 #ifdef CONFIG_PM
 382 static int suspend_iter(struct device *dev, void *data)
 383 {
 384         struct pcie_port_service_driver *service_driver;
 385
 386         if ((dev->bus == &pcie_port_bus_type) &&
 387             (dev->driver)) {
 388                 service_driver = to_service_driver(dev->driver);
 389                 if (service_driver->suspend)
 390                         service_driver->suspend(to_pcie_device(dev));
 391         }
 392         return 0;
 393 }
 394
 395 /**
 396  * pcie_port_device_suspend - suspend port services associated with a PCIe port
 397  * @dev: PCI Express port to handle
 398  */
 399 int pcie_port_device_suspend(struct device *dev)
 400 {
 401         return device_for_each_child(dev, NULL, suspend_iter);
 402 }
 403
 404 static int resume_iter(struct device *dev, void *data)
 405 {
 406         struct pcie_port_service_driver *service_driver;
 407
 408         if ((dev->bus == &pcie_port_bus_type) &&
 409             (dev->driver)) {
 410                 service_driver = to_service_driver(dev->driver);
 411                 if (service_driver->resume)
 412                         service_driver->resume(to_pcie_device(dev));
 413         }
 414         return 0;
 415 }
 416
 417 /**
 418  * pcie_port_device_suspend - resume port services associated with a PCIe port
 419  * @dev: PCI Express port to handle
 420  */
 421 int pcie_port_device_resume(struct device *dev)
 422 {
 423         return device_for_each_child(dev, NULL, resume_iter);
 424 }
 425 #endif /* PM */
 426
 427 static int remove_iter(struct device *dev, void *data)
 428 {
 429         if (dev->bus == &pcie_port_bus_type) {
 430                 put_device(dev);
 431                 device_unregister(dev);
 432         }
 433         return 0;
 434 }
 435
 436 /**
 437  * pcie_port_device_remove - unregister PCI Express port service devices
 438  * @dev: PCI Express port the service devices to unregister are associated with
 439  *
 440  * Remove PCI Express port service devices associated with given port and
 441  * disable MSI-X or MSI for the port.
 442  */
 443 void pcie_port_device_remove(struct pci_dev *dev)
 444 {
 445         struct pcie_port_data *port_data = pci_get_drvdata(dev);
 446
 447         device_for_each_child(&dev->dev, NULL, remove_iter);
 448         pci_disable_device(dev);
 449
 450         switch (port_data->port_irq_mode) {
 451         case PCIE_PORT_MSIX_MODE:
 452                 pci_disable_msix(dev);
 453                 break;
 454         case PCIE_PORT_MSI_MODE:
 455                 pci_disable_msi(dev);
 456                 break;
 457         }
 458
 459         kfree(port_data);
 460 }
 461
 462 /**
 463  * pcie_port_probe_service - probe driver for given PCI Express port service
 464  * @dev: PCI Express port service device to probe against
 465  *
 466  * If PCI Express port service driver is registered with
 467  * pcie_port_service_register(), this function will be called by the driver core
 468  * whenever match is found between the driver and a port service device.
 469  */
 470 static int pcie_port_probe_service(struct device *dev)
 471 {
 472         struct pcie_device *pciedev;
 473         struct pcie_port_service_driver *driver;
 474         int status;
 475
 476         if (!dev || !dev->driver)
 477                 return -ENODEV;
 478
 479         driver = to_service_driver(dev->driver);
 480         if (!driver || !driver->probe)
 481                 return -ENODEV;
 482
 483         pciedev = to_pcie_device(dev);
 484         status = driver->probe(pciedev);
 485         if (!status) {
 486                 dev_printk(KERN_DEBUG, dev, "service driver %s loaded\n",
 487                         driver->name);
 488                 get_device(dev);
 489         }
 490         return status;
 491 }
 492
 493 /**
 494  * pcie_port_remove_service - detach driver from given PCI Express port service
 495  * @dev: PCI Express port service device to handle
 496  *
 497  * If PCI Express port service driver is registered with
 498  * pcie_port_service_register(), this function will be called by the driver core
 499  * when device_unregister() is called for the port service device associated
 500  * with the driver.
 501  */
 502 static int pcie_port_remove_service(struct device *dev)
 503 {
 504         struct pcie_device *pciedev;
 505         struct pcie_port_service_driver *driver;
 506
 507         if (!dev || !dev->driver)
 508                 return 0;
 509
 510         pciedev = to_pcie_device(dev);
 511         driver = to_service_driver(dev->driver);
 512         if (driver && driver->remove) {
 513                 dev_printk(KERN_DEBUG, dev, "unloading service driver %s\n",
 514                         driver->name);
 515                 driver->remove(pciedev);
 516                 put_device(dev);
 517         }
 518         return 0;
 519 }
 520
 521 /**
 522  * pcie_port_shutdown_service - shut down given PCI Express port service
 523  * @dev: PCI Express port service device to handle
 524  *
 525  * If PCI Express port service driver is registered with
 526  * pcie_port_service_register(), this function will be called by the driver core
 527  * when device_shutdown() is called for the port service device associated
 528  * with the driver.
 529  */
 530 static void pcie_port_shutdown_service(struct device *dev) {}
 531
 532 /**
 533  * pcie_port_service_register - register PCI Express port service driver
 534  * @new: PCI Express port service driver to register
 535  */
 536 int pcie_port_service_register(struct pcie_port_service_driver *new)
 537 {
 538         new->driver.name = (char *)new->name;
 539         new->driver.bus = &pcie_port_bus_type;
 540         new->driver.probe = pcie_port_probe_service;
 541         new->driver.remove = pcie_port_remove_service;
 542         new->driver.shutdown = pcie_port_shutdown_service;
 543
 544         return driver_register(&new->driver);
 545 }
 546
 547 /**
 548  * pcie_port_service_unregister - unregister PCI Express port service driver
 549  * @drv: PCI Express port service driver to unregister
 550  */
 551 void pcie_port_service_unregister(struct pcie_port_service_driver *drv)
 552 {
 553         driver_unregister(&drv->driver);
 554 }
 555
 556 EXPORT_SYMBOL(pcie_port_service_register);
 557 EXPORT_SYMBOL(pcie_port_service_unregister);