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  * assign_interrupt_mode - choose interrupt mode for PCI Express port services
  35  *                         (INTx, MSI-X, MSI) and set up vectors
  36  * @dev: PCI Express port to handle
  37  * @vectors: Array of interrupt vectors to populate
  38  * @mask: Bitmask of port capabilities returned by get_port_device_capability()
  39  *
  40  * Return value: Interrupt mode associated with the port
  41  */
  42 static int assign_interrupt_mode(struct pci_dev *dev, int *vectors, int mask)
  43 {
  44         struct pcie_port_data *port_data = pci_get_drvdata(dev);
  45         int i, pos, nvec, status = -EINVAL;
  46         int interrupt_mode = PCIE_PORT_INTx_MODE;
  47
  48         /* Set INTx as default */
  49         for (i = 0, nvec = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
  50                 if (mask & (1 << i))
  51                         nvec++;
  52                 vectors[i] = dev->irq;
  53         }
  54
  55         /* Check MSI quirk */
  56         if (port_data->port_type == PCIE_RC_PORT && pcie_mch_quirk)
  57                 return interrupt_mode;
  58
  59         /* Select MSI-X over MSI if supported */
  60         pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
  61         if (pos) {
  62                 struct msix_entry msix_entries[PCIE_PORT_DEVICE_MAXSERVICES] =
  63                         {{0, 0}, {0, 1}, {0, 2}, {0, 3}};
  64                 status = pci_enable_msix(dev, msix_entries, nvec);
  65                 if (!status) {
  66                         int j = 0;
  67
  68                         interrupt_mode = PCIE_PORT_MSIX_MODE;
  69                         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
  70                                 if (mask & (1 << i))
  71                                         vectors[i] = msix_entries[j++].vector;
  72                         }
  73                 }
  74         }
  75         if (status) {
  76                 pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
  77                 if (pos) {
  78                         status = pci_enable_msi(dev);
  79                         if (!status) {
  80                                 interrupt_mode = PCIE_PORT_MSI_MODE;
  81                                 for (i = 0;i < PCIE_PORT_DEVICE_MAXSERVICES;i++)
  82                                         vectors[i] = dev->irq;
  83                         }
  84                 }
  85         }
  86         return interrupt_mode;
  87 }
  88
  89 /**
  90  * get_port_device_capability - discover capabilities of a PCI Express port
  91  * @dev: PCI Express port to examine
  92  *
  93  * The capabilities are read from the port's PCI Express configuration registers
  94  * as described in PCI Express Base Specification 1.0a sections 7.8.2, 7.8.9 and
  95  * 7.9 - 7.11.
  96  *
  97  * Return value: Bitmask of discovered port capabilities
  98  */
  99 static int get_port_device_capability(struct pci_dev *dev)
 100 {
 101         int services = 0, pos;
 102         u16 reg16;
 103         u32 reg32;
 104
 105         pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
 106         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg16);
 107         /* Hot-Plug Capable */
 108         if (reg16 & PORT_TO_SLOT_MASK) {
 109                 pci_read_config_dword(dev,
 110                         pos + PCIE_SLOT_CAPABILITIES_REG, &reg32);
 111                 if (reg32 & SLOT_HP_CAPABLE_MASK)
 112                         services |= PCIE_PORT_SERVICE_HP;
 113         }
 114         /* AER capable */
 115         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ERR))
 116                 services |= PCIE_PORT_SERVICE_AER;
 117         /* VC support */
 118         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_VC))
 119                 services |= PCIE_PORT_SERVICE_VC;
 120
 121         return services;
 122 }
 123
 124 /**
 125  * pcie_device_init - initialize PCI Express port service device
 126  * @dev: Port service device to initialize
 127  * @parent: PCI Express port to associate the service device with
 128  * @port_type: Type of the port
 129  * @service_type: Type of service to associate with the service device
 130  * @irq: Interrupt vector to associate with the service device
 131  */
 132 static void pcie_device_init(struct pci_dev *parent, struct pcie_device *dev,
 133         int service_type, int irq)
 134 {
 135         struct pcie_port_data *port_data = pci_get_drvdata(parent);
 136         struct device *device;
 137         int port_type = port_data->port_type;
 138
 139         dev->port = parent;
 140         dev->irq = irq;
 141         dev->id.vendor = parent->vendor;
 142         dev->id.device = parent->device;
 143         dev->id.port_type = port_type;
 144         dev->id.service_type = (1 << service_type);
 145
 146         /* Initialize generic device interface */
 147         device = &dev->device;
 148         memset(device, 0, sizeof(struct device));
 149         device->bus = &pcie_port_bus_type;
 150         device->driver = NULL;
 151         device->driver_data = NULL;
 152         device->release = release_pcie_device;  /* callback to free pcie dev */
 153         dev_set_name(device, "%s:pcie%02x",
 154                  pci_name(parent), get_descriptor_id(port_type, service_type));
 155         device->parent = &parent->dev;
 156 }
 157
 158 /**
 159  * alloc_pcie_device - allocate PCI Express port service device structure
 160  * @parent: PCI Express port to associate the service device with
 161  * @port_type: Type of the port
 162  * @service_type: Type of service to associate with the service device
 163  * @irq: Interrupt vector to associate with the service device
 164  */
 165 static struct pcie_device* alloc_pcie_device(struct pci_dev *parent,
 166         int service_type, int irq)
 167 {
 168         struct pcie_device *device;
 169
 170         device = kzalloc(sizeof(struct pcie_device), GFP_KERNEL);
 171         if (!device)
 172                 return NULL;
 173
 174         pcie_device_init(parent, device, service_type, irq);
 175         return device;
 176 }
 177
 178 /**
 179  * pcie_port_device_probe - check if device is a PCI Express port
 180  * @dev: Device to check
 181  */
 182 int pcie_port_device_probe(struct pci_dev *dev)
 183 {
 184         int pos, type;
 185         u16 reg;
 186
 187         if (!(pos = pci_find_capability(dev, PCI_CAP_ID_EXP)))
 188                 return -ENODEV;
 189
 190         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, &reg);
 191         type = (reg >> 4) & PORT_TYPE_MASK;
 192         if (    type == PCIE_RC_PORT || type == PCIE_SW_UPSTREAM_PORT ||
 193                 type == PCIE_SW_DOWNSTREAM_PORT )
 194                 return 0;
 195
 196         return -ENODEV;
 197 }
 198
 199 /**
 200  * pcie_port_device_register - register PCI Express port
 201  * @dev: PCI Express port to register
 202  *
 203  * Allocate the port extension structure and register services associated with
 204  * the port.
 205  */
 206 int pcie_port_device_register(struct pci_dev *dev)
 207 {
 208         struct pcie_port_data *port_data;
 209         int status, capabilities, irq_mode, i;
 210         int vectors[PCIE_PORT_DEVICE_MAXSERVICES];
 211         u16 reg16;
 212
 213         port_data = kzalloc(sizeof(*port_data), GFP_KERNEL);
 214         if (!port_data)
 215                 return -ENOMEM;
 216         pci_set_drvdata(dev, port_data);
 217
 218         /* Get port type */
 219         pci_read_config_word(dev,
 220                 pci_find_capability(dev, PCI_CAP_ID_EXP) +
 221                 PCIE_CAPABILITIES_REG, &reg16);
 222         port_data->port_type = (reg16 >> 4) & PORT_TYPE_MASK;
 223
 224         capabilities = get_port_device_capability(dev);
 225         /* Root ports are capable of generating PME too */
 226         if (port_data->port_type == PCIE_RC_PORT)
 227                 capabilities |= PCIE_PORT_SERVICE_PME;
 228
 229         irq_mode = assign_interrupt_mode(dev, vectors, capabilities);
 230         port_data->port_irq_mode = irq_mode;
 231
 232         /* Allocate child services if any */
 233         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 234                 struct pcie_device *child;
 235
 236                 if (capabilities & (1 << i)) {
 237                         child = alloc_pcie_device(dev, i, vectors[i]);
 238                         if (child) {
 239                                 status = device_register(&child->device);
 240                                 if (status) {
 241                                         kfree(child);
 242                                         continue;
 243                                 }
 244                                 get_device(&child->device);
 245                         }
 246                 }
 247         }
 248         return 0;
 249 }
 250
 251 #ifdef CONFIG_PM
 252 static int suspend_iter(struct device *dev, void *data)
 253 {
 254         struct pcie_port_service_driver *service_driver;
 255         pm_message_t state = * (pm_message_t *) data;
 256
 257         if ((dev->bus == &pcie_port_bus_type) &&
 258             (dev->driver)) {
 259                 service_driver = to_service_driver(dev->driver);
 260                 if (service_driver->suspend)
 261                         service_driver->suspend(to_pcie_device(dev), state);
 262         }
 263         return 0;
 264 }
 265
 266 /**
 267  * pcie_port_device_suspend - suspend port services associated with a PCIe port
 268  * @dev: PCI Express port to handle
 269  * @state: Representation of system power management transition in progress
 270  */
 271 int pcie_port_device_suspend(struct pci_dev *dev, pm_message_t state)
 272 {
 273         return device_for_each_child(&dev->dev, &state, suspend_iter);
 274 }
 275
 276 static int resume_iter(struct device *dev, void *data)
 277 {
 278         struct pcie_port_service_driver *service_driver;
 279
 280         if ((dev->bus == &pcie_port_bus_type) &&
 281             (dev->driver)) {
 282                 service_driver = to_service_driver(dev->driver);
 283                 if (service_driver->resume)
 284                         service_driver->resume(to_pcie_device(dev));
 285         }
 286         return 0;
 287 }
 288
 289 /**
 290  * pcie_port_device_suspend - resume port services associated with a PCIe port
 291  * @dev: PCI Express port to handle
 292  */
 293 int pcie_port_device_resume(struct pci_dev *dev)
 294 {
 295         return device_for_each_child(&dev->dev, NULL, resume_iter);
 296 }
 297 #endif
 298
 299 static int remove_iter(struct device *dev, void *data)
 300 {
 301         struct pcie_port_service_driver *service_driver;
 302
 303         if (dev->bus == &pcie_port_bus_type) {
 304                 if (dev->driver) {
 305                         service_driver = to_service_driver(dev->driver);
 306                         if (service_driver->remove)
 307                                 service_driver->remove(to_pcie_device(dev));
 308                 }
 309                 *(unsigned long*)data = (unsigned long)dev;
 310                 return 1;
 311         }
 312         return 0;
 313 }
 314
 315 /**
 316  * pcie_port_device_remove - unregister PCI Express port service devices
 317  * @dev: PCI Express port the service devices to unregister are associated with
 318  *
 319  * Remove PCI Express port service devices associated with given port and
 320  * disable MSI-X or MSI for the port.
 321  */
 322 void pcie_port_device_remove(struct pci_dev *dev)
 323 {
 324         struct pcie_port_data *port_data = pci_get_drvdata(dev);
 325         int status;
 326
 327         do {
 328                 unsigned long device_addr;
 329
 330                 status = device_for_each_child(&dev->dev, &device_addr, remove_iter);
 331                 if (status) {
 332                         struct device *device = (struct device*)device_addr;
 333                         put_device(device);
 334                         device_unregister(device);
 335                 }
 336         } while (status);
 337
 338         switch (port_data->port_irq_mode) {
 339         case PCIE_PORT_MSIX_MODE:
 340                 pci_disable_msix(dev);
 341                 break;
 342         case PCIE_PORT_MSI_MODE:
 343                 pci_disable_msi(dev);
 344                 break;
 345         }
 346
 347         kfree(port_data);
 348 }
 349
 350 /**
 351  * pcie_port_probe_service - probe driver for given PCI Express port service
 352  * @dev: PCI Express port service device to probe against
 353  *
 354  * If PCI Express port service driver is registered with
 355  * pcie_port_service_register(), this function will be called by the driver core
 356  * whenever match is found between the driver and a port service device.
 357  */
 358 static int pcie_port_probe_service(struct device *dev)
 359 {
 360         struct pcie_device *pciedev;
 361         struct pcie_port_service_driver *driver;
 362         int status;
 363
 364         if (!dev || !dev->driver)
 365                 return -ENODEV;
 366
 367         driver = to_service_driver(dev->driver);
 368         if (!driver || !driver->probe)
 369                 return -ENODEV;
 370
 371         pciedev = to_pcie_device(dev);
 372         status = driver->probe(pciedev, driver->id_table);
 373         if (!status) {
 374                 dev_printk(KERN_DEBUG, dev, "service driver %s loaded\n",
 375                         driver->name);
 376                 get_device(dev);
 377         }
 378         return status;
 379 }
 380
 381 /**
 382  * pcie_port_remove_service - detach driver from given PCI Express port service
 383  * @dev: PCI Express port service device to handle
 384  *
 385  * If PCI Express port service driver is registered with
 386  * pcie_port_service_register(), this function will be called by the driver core
 387  * when device_unregister() is called for the port service device associated
 388  * with the driver.
 389  */
 390 static int pcie_port_remove_service(struct device *dev)
 391 {
 392         struct pcie_device *pciedev;
 393         struct pcie_port_service_driver *driver;
 394
 395         if (!dev || !dev->driver)
 396                 return 0;
 397
 398         pciedev = to_pcie_device(dev);
 399         driver = to_service_driver(dev->driver);
 400         if (driver && driver->remove) {
 401                 dev_printk(KERN_DEBUG, dev, "unloading service driver %s\n",
 402                         driver->name);
 403                 driver->remove(pciedev);
 404                 put_device(dev);
 405         }
 406         return 0;
 407 }
 408
 409 /**
 410  * pcie_port_shutdown_service - shut down given PCI Express port service
 411  * @dev: PCI Express port service device to handle
 412  *
 413  * If PCI Express port service driver is registered with
 414  * pcie_port_service_register(), this function will be called by the driver core
 415  * when device_shutdown() is called for the port service device associated
 416  * with the driver.
 417  */
 418 static void pcie_port_shutdown_service(struct device *dev) {}
 419
 420 /**
 421  * pcie_port_service_register - register PCI Express port service driver
 422  * @new: PCI Express port service driver to register
 423  */
 424 int pcie_port_service_register(struct pcie_port_service_driver *new)
 425 {
 426         new->driver.name = (char *)new->name;
 427         new->driver.bus = &pcie_port_bus_type;
 428         new->driver.probe = pcie_port_probe_service;
 429         new->driver.remove = pcie_port_remove_service;
 430         new->driver.shutdown = pcie_port_shutdown_service;
 431
 432         return driver_register(&new->driver);
 433 }
 434
 435 /**
 436  * pcie_port_service_unregister - unregister PCI Express port service driver
 437  * @drv: PCI Express port service driver to unregister
 438  */
 439 void pcie_port_service_unregister(struct pcie_port_service_driver *drv)
 440 {
 441         driver_unregister(&drv->driver);
 442 }
 443
 444 EXPORT_SYMBOL(pcie_port_service_register);
 445 EXPORT_SYMBOL(pcie_port_service_unregister);