3  * Purpose:     PCI Express Port Bus Driver's Core Functions
 
   5  * Copyright (C) 2004 Intel
 
   6  * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
 
   9 #include <linux/module.h>
 
  10 #include <linux/pci.h>
 
  11 #include <linux/kernel.h>
 
  12 #include <linux/errno.h>
 
  14 #include <linux/string.h>
 
  15 #include <linux/slab.h>
 
  16 #include <linux/pcieport_if.h>
 
  20 extern int pcie_mch_quirk;      /* MSI-quirk Indicator */
 
  22 static int pcie_port_probe_service(struct device *dev)
 
  24         struct pcie_device *pciedev;
 
  25         struct pcie_port_service_driver *driver;
 
  28         if (!dev || !dev->driver)
 
  31         driver = to_service_driver(dev->driver);
 
  32         if (!driver || !driver->probe)
 
  35         pciedev = to_pcie_device(dev);
 
  36         status = driver->probe(pciedev, driver->id_table);
 
  38                 dev_printk(KERN_DEBUG, dev, "service driver %s loaded\n",
 
  45 static int pcie_port_remove_service(struct device *dev)
 
  47         struct pcie_device *pciedev;
 
  48         struct pcie_port_service_driver *driver;
 
  50         if (!dev || !dev->driver)
 
  53         pciedev = to_pcie_device(dev);
 
  54         driver = to_service_driver(dev->driver);
 
  55         if (driver && driver->remove) { 
 
  56                 dev_printk(KERN_DEBUG, dev, "unloading service driver %s\n",
 
  58                 driver->remove(pciedev);
 
  64 static void pcie_port_shutdown_service(struct device *dev) {}
 
  66 static int pcie_port_suspend_service(struct device *dev, pm_message_t state)
 
  68         struct pcie_device *pciedev;
 
  69         struct pcie_port_service_driver *driver;
 
  71         if (!dev || !dev->driver)
 
  74         pciedev = to_pcie_device(dev);
 
  75         driver = to_service_driver(dev->driver);
 
  76         if (driver && driver->suspend)
 
  77                 driver->suspend(pciedev, state);
 
  81 static int pcie_port_resume_service(struct device *dev)
 
  83         struct pcie_device *pciedev;
 
  84         struct pcie_port_service_driver *driver;
 
  86         if (!dev || !dev->driver)
 
  89         pciedev = to_pcie_device(dev);
 
  90         driver = to_service_driver(dev->driver);
 
  92         if (driver && driver->resume)
 
  93                 driver->resume(pciedev);
 
 100  *      Being invoked automatically when device is being removed 
 
 101  *      in response to device_unregister(dev) call.
 
 102  *      Release all resources being claimed.
 
 104 static void release_pcie_device(struct device *dev)
 
 106         dev_printk(KERN_DEBUG, dev, "free port service\n");
 
 107         kfree(to_pcie_device(dev));                     
 
 110 static int is_msi_quirked(struct pci_dev *dev)
 
 112         int port_type, quirk = 0;
 
 115         pci_read_config_word(dev, 
 
 116                 pci_find_capability(dev, PCI_CAP_ID_EXP) + 
 
 117                 PCIE_CAPABILITIES_REG, ®16);
 
 118         port_type = (reg16 >> 4) & PORT_TYPE_MASK;
 
 121                 if (pcie_mch_quirk == 1)
 
 124         case PCIE_SW_UPSTREAM_PORT:
 
 125         case PCIE_SW_DOWNSTREAM_PORT:
 
 132 static int assign_interrupt_mode(struct pci_dev *dev, int *vectors, int mask)
 
 134         int i, pos, nvec, status = -EINVAL;
 
 135         int interrupt_mode = PCIE_PORT_INTx_MODE;
 
 137         /* Set INTx as default */
 
 138         for (i = 0, nvec = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 
 141                 vectors[i] = dev->irq;
 
 144         /* Check MSI quirk */
 
 145         if (is_msi_quirked(dev))
 
 146                 return interrupt_mode;
 
 148         /* Select MSI-X over MSI if supported */                
 
 149         pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
 
 151                 struct msix_entry msix_entries[PCIE_PORT_DEVICE_MAXSERVICES] = 
 
 152                         {{0, 0}, {0, 1}, {0, 2}, {0, 3}};
 
 153                 dev_info(&dev->dev, "found MSI-X capability\n");
 
 154                 status = pci_enable_msix(dev, msix_entries, nvec);
 
 158                         interrupt_mode = PCIE_PORT_MSIX_MODE;
 
 159                         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 
 161                                         vectors[i] = msix_entries[j++].vector;
 
 166                 pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
 
 168                         dev_info(&dev->dev, "found MSI capability\n");
 
 169                         status = pci_enable_msi(dev);
 
 171                                 interrupt_mode = PCIE_PORT_MSI_MODE;
 
 172                                 for (i = 0;i < PCIE_PORT_DEVICE_MAXSERVICES;i++)
 
 173                                         vectors[i] = dev->irq;
 
 177         return interrupt_mode;
 
 180 static int get_port_device_capability(struct pci_dev *dev)
 
 182         int services = 0, pos;
 
 186         pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
 
 187         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, ®16);
 
 188         /* Hot-Plug Capable */
 
 189         if (reg16 & PORT_TO_SLOT_MASK) {
 
 190                 pci_read_config_dword(dev, 
 
 191                         pos + PCIE_SLOT_CAPABILITIES_REG, ®32);
 
 192                 if (reg32 & SLOT_HP_CAPABLE_MASK)
 
 193                         services |= PCIE_PORT_SERVICE_HP;
 
 195         /* PME Capable - root port capability */
 
 196         if (((reg16 >> 4) & PORT_TYPE_MASK) == PCIE_RC_PORT)
 
 197                 services |= PCIE_PORT_SERVICE_PME;
 
 199         pos = PCI_CFG_SPACE_SIZE;
 
 201                 pci_read_config_dword(dev, pos, ®32);
 
 202                 switch (reg32 & 0xffff) {
 
 203                 case PCI_EXT_CAP_ID_ERR:
 
 204                         services |= PCIE_PORT_SERVICE_AER;
 
 207                 case PCI_EXT_CAP_ID_VC:
 
 208                         services |= PCIE_PORT_SERVICE_VC;
 
 220 static void pcie_device_init(struct pci_dev *parent, struct pcie_device *dev, 
 
 221         int port_type, int service_type, int irq, int irq_mode)
 
 223         struct device *device;
 
 226         dev->interrupt_mode = irq_mode;
 
 228         dev->id.vendor = parent->vendor;
 
 229         dev->id.device = parent->device;
 
 230         dev->id.port_type = port_type;
 
 231         dev->id.service_type = (1 << service_type);
 
 233         /* Initialize generic device interface */
 
 234         device = &dev->device;
 
 235         memset(device, 0, sizeof(struct device));
 
 236         device->bus = &pcie_port_bus_type;
 
 237         device->driver = NULL;
 
 238         device->driver_data = NULL;
 
 239         device->release = release_pcie_device;  /* callback to free pcie dev */
 
 240         snprintf(device->bus_id, sizeof(device->bus_id), "%s:pcie%02x",
 
 241                  pci_name(parent), get_descriptor_id(port_type, service_type));
 
 242         device->parent = &parent->dev;
 
 245 static struct pcie_device* alloc_pcie_device(struct pci_dev *parent,
 
 246         int port_type, int service_type, int irq, int irq_mode)
 
 248         struct pcie_device *device;
 
 250         device = kzalloc(sizeof(struct pcie_device), GFP_KERNEL);
 
 254         pcie_device_init(parent, device, port_type, service_type, irq,irq_mode);
 
 255         dev_printk(KERN_DEBUG, &device->device, "allocate port service\n");
 
 259 int pcie_port_device_probe(struct pci_dev *dev)
 
 264         if (!(pos = pci_find_capability(dev, PCI_CAP_ID_EXP)))
 
 267         pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, ®);
 
 268         type = (reg >> 4) & PORT_TYPE_MASK;
 
 269         if (    type == PCIE_RC_PORT || type == PCIE_SW_UPSTREAM_PORT ||
 
 270                 type == PCIE_SW_DOWNSTREAM_PORT )
 
 276 int pcie_port_device_register(struct pci_dev *dev)
 
 278         struct pcie_port_device_ext *p_ext;
 
 279         int status, type, capabilities, irq_mode, i;
 
 280         int vectors[PCIE_PORT_DEVICE_MAXSERVICES];
 
 283         /* Allocate port device extension */
 
 284         if (!(p_ext = kmalloc(sizeof(struct pcie_port_device_ext), GFP_KERNEL)))
 
 287         pci_set_drvdata(dev, p_ext);
 
 290         pci_read_config_word(dev,
 
 291                 pci_find_capability(dev, PCI_CAP_ID_EXP) +
 
 292                 PCIE_CAPABILITIES_REG, ®16);
 
 293         type = (reg16 >> 4) & PORT_TYPE_MASK;
 
 295         /* Now get port services */
 
 296         capabilities = get_port_device_capability(dev);
 
 297         irq_mode = assign_interrupt_mode(dev, vectors, capabilities);
 
 298         p_ext->interrupt_mode = irq_mode;
 
 300         /* Allocate child services if any */
 
 301         for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
 
 302                 struct pcie_device *child;
 
 304                 if (capabilities & (1 << i)) {
 
 305                         child = alloc_pcie_device(
 
 307                                 type,           /* port type */
 
 308                                 i,              /* service type */
 
 309                                 vectors[i],     /* irq */
 
 310                                 irq_mode        /* interrupt mode */);
 
 312                                 status = device_register(&child->device);
 
 317                                 get_device(&child->device);
 
 325 static int suspend_iter(struct device *dev, void *data)
 
 327         struct pcie_port_service_driver *service_driver;
 
 328         pm_message_t state = * (pm_message_t *) data;
 
 330         if ((dev->bus == &pcie_port_bus_type) &&
 
 332                 service_driver = to_service_driver(dev->driver);
 
 333                 if (service_driver->suspend)
 
 334                         service_driver->suspend(to_pcie_device(dev), state);
 
 339 int pcie_port_device_suspend(struct pci_dev *dev, pm_message_t state)
 
 341         return device_for_each_child(&dev->dev, &state, suspend_iter);
 
 344 static int resume_iter(struct device *dev, void *data)
 
 346         struct pcie_port_service_driver *service_driver;
 
 348         if ((dev->bus == &pcie_port_bus_type) &&
 
 350                 service_driver = to_service_driver(dev->driver);
 
 351                 if (service_driver->resume)
 
 352                         service_driver->resume(to_pcie_device(dev));
 
 357 int pcie_port_device_resume(struct pci_dev *dev)
 
 359         return device_for_each_child(&dev->dev, NULL, resume_iter);
 
 363 static int remove_iter(struct device *dev, void *data)
 
 365         struct pcie_port_service_driver *service_driver;
 
 367         if (dev->bus == &pcie_port_bus_type) {
 
 369                         service_driver = to_service_driver(dev->driver);
 
 370                         if (service_driver->remove)
 
 371                                 service_driver->remove(to_pcie_device(dev));
 
 373                 *(unsigned long*)data = (unsigned long)dev;
 
 379 void pcie_port_device_remove(struct pci_dev *dev)
 
 381         struct device *device;
 
 382         unsigned long device_addr;
 
 383         int interrupt_mode = PCIE_PORT_INTx_MODE;
 
 387                 status = device_for_each_child(&dev->dev, &device_addr, remove_iter);
 
 389                         device = (struct device*)device_addr;
 
 390                         interrupt_mode = (to_pcie_device(device))->interrupt_mode;
 
 392                         device_unregister(device);
 
 395         /* Switch to INTx by default if MSI enabled */
 
 396         if (interrupt_mode == PCIE_PORT_MSIX_MODE)
 
 397                 pci_disable_msix(dev);
 
 398         else if (interrupt_mode == PCIE_PORT_MSI_MODE)
 
 399                 pci_disable_msi(dev);
 
 402 int pcie_port_bus_register(void)
 
 404         return bus_register(&pcie_port_bus_type);
 
 407 void pcie_port_bus_unregister(void)
 
 409         bus_unregister(&pcie_port_bus_type);
 
 412 int pcie_port_service_register(struct pcie_port_service_driver *new)
 
 414         new->driver.name = (char *)new->name;
 
 415         new->driver.bus = &pcie_port_bus_type;
 
 416         new->driver.probe = pcie_port_probe_service;
 
 417         new->driver.remove = pcie_port_remove_service;
 
 418         new->driver.shutdown = pcie_port_shutdown_service;
 
 419         new->driver.suspend = pcie_port_suspend_service;
 
 420         new->driver.resume = pcie_port_resume_service;
 
 422         return driver_register(&new->driver);
 
 425 void pcie_port_service_unregister(struct pcie_port_service_driver *new)
 
 427         driver_unregister(&new->driver);
 
 430 EXPORT_SYMBOL(pcie_port_service_register);
 
 431 EXPORT_SYMBOL(pcie_port_service_unregister);