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);
98 * release_pcie_device - free PCI Express port service device structure
99 * @dev: Port service device to release
101 * Invoked automatically when device is being removed in response to
102 * device_unregister(dev). Release all resources being claimed.
104 static void release_pcie_device(struct device *dev)
106 kfree(to_pcie_device(dev));
109 static int is_msi_quirked(struct pci_dev *dev)
111 int port_type, quirk = 0;
114 pci_read_config_word(dev,
115 pci_find_capability(dev, PCI_CAP_ID_EXP) +
116 PCIE_CAPABILITIES_REG, ®16);
117 port_type = (reg16 >> 4) & PORT_TYPE_MASK;
120 if (pcie_mch_quirk == 1)
123 case PCIE_SW_UPSTREAM_PORT:
124 case PCIE_SW_DOWNSTREAM_PORT:
132 * assign_interrupt_mode - choose interrupt mode for PCI Express port services
133 * (INTx, MSI-X, MSI) and set up vectors
134 * @dev: PCI Express port to handle
135 * @vectors: Array of interrupt vectors to populate
136 * @mask: Bitmask of port capabilities returned by get_port_device_capability()
138 * Return value: Interrupt mode associated with the port
140 static int assign_interrupt_mode(struct pci_dev *dev, int *vectors, int mask)
142 int i, pos, nvec, status = -EINVAL;
143 int interrupt_mode = PCIE_PORT_INTx_MODE;
145 /* Set INTx as default */
146 for (i = 0, nvec = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
149 vectors[i] = dev->irq;
152 /* Check MSI quirk */
153 if (is_msi_quirked(dev))
154 return interrupt_mode;
156 /* Select MSI-X over MSI if supported */
157 pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
159 struct msix_entry msix_entries[PCIE_PORT_DEVICE_MAXSERVICES] =
160 {{0, 0}, {0, 1}, {0, 2}, {0, 3}};
161 status = pci_enable_msix(dev, msix_entries, nvec);
165 interrupt_mode = PCIE_PORT_MSIX_MODE;
166 for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
168 vectors[i] = msix_entries[j++].vector;
173 pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
175 status = pci_enable_msi(dev);
177 interrupt_mode = PCIE_PORT_MSI_MODE;
178 for (i = 0;i < PCIE_PORT_DEVICE_MAXSERVICES;i++)
179 vectors[i] = dev->irq;
183 return interrupt_mode;
187 * get_port_device_capability - discover capabilities of a PCI Express port
188 * @dev: PCI Express port to examine
190 * The capabilities are read from the port's PCI Express configuration registers
191 * as described in PCI Express Base Specification 1.0a sections 7.8.2, 7.8.9 and
194 * Return value: Bitmask of discovered port capabilities
196 static int get_port_device_capability(struct pci_dev *dev)
198 int services = 0, pos;
202 pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
203 pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, ®16);
204 /* Hot-Plug Capable */
205 if (reg16 & PORT_TO_SLOT_MASK) {
206 pci_read_config_dword(dev,
207 pos + PCIE_SLOT_CAPABILITIES_REG, ®32);
208 if (reg32 & SLOT_HP_CAPABLE_MASK)
209 services |= PCIE_PORT_SERVICE_HP;
211 /* PME Capable - root port capability */
212 if (((reg16 >> 4) & PORT_TYPE_MASK) == PCIE_RC_PORT)
213 services |= PCIE_PORT_SERVICE_PME;
215 if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ERR))
216 services |= PCIE_PORT_SERVICE_AER;
217 if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_VC))
218 services |= PCIE_PORT_SERVICE_VC;
224 * pcie_device_init - initialize PCI Express port service device
225 * @dev: Port service device to initialize
226 * @parent: PCI Express port to associate the service device with
227 * @port_type: Type of the port
228 * @service_type: Type of service to associate with the service device
229 * @irq: Interrupt vector to associate with the service device
230 * @irq_mode: Interrupt mode of the service (INTx, MSI-X, MSI)
232 static void pcie_device_init(struct pci_dev *parent, struct pcie_device *dev,
233 int port_type, int service_type, int irq, int irq_mode)
235 struct device *device;
238 dev->interrupt_mode = irq_mode;
240 dev->id.vendor = parent->vendor;
241 dev->id.device = parent->device;
242 dev->id.port_type = port_type;
243 dev->id.service_type = (1 << service_type);
245 /* Initialize generic device interface */
246 device = &dev->device;
247 memset(device, 0, sizeof(struct device));
248 device->bus = &pcie_port_bus_type;
249 device->driver = NULL;
250 device->driver_data = NULL;
251 device->release = release_pcie_device; /* callback to free pcie dev */
252 dev_set_name(device, "%s:pcie%02x",
253 pci_name(parent), get_descriptor_id(port_type, service_type));
254 device->parent = &parent->dev;
258 * alloc_pcie_device - allocate PCI Express port service device structure
259 * @parent: PCI Express port to associate the service device with
260 * @port_type: Type of the port
261 * @service_type: Type of service to associate with the service device
262 * @irq: Interrupt vector to associate with the service device
263 * @irq_mode: Interrupt mode of the service (INTx, MSI-X, MSI)
265 static struct pcie_device* alloc_pcie_device(struct pci_dev *parent,
266 int port_type, int service_type, int irq, int irq_mode)
268 struct pcie_device *device;
270 device = kzalloc(sizeof(struct pcie_device), GFP_KERNEL);
274 pcie_device_init(parent, device, port_type, service_type, irq,irq_mode);
279 * pcie_port_device_probe - check if device is a PCI Express port
280 * @dev: Device to check
282 int pcie_port_device_probe(struct pci_dev *dev)
287 if (!(pos = pci_find_capability(dev, PCI_CAP_ID_EXP)))
290 pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, ®);
291 type = (reg >> 4) & PORT_TYPE_MASK;
292 if ( type == PCIE_RC_PORT || type == PCIE_SW_UPSTREAM_PORT ||
293 type == PCIE_SW_DOWNSTREAM_PORT )
300 * pcie_port_device_register - register PCI Express port
301 * @dev: PCI Express port to register
303 * Allocate the port extension structure and register services associated with
306 int pcie_port_device_register(struct pci_dev *dev)
308 struct pcie_port_device_ext *p_ext;
309 int status, type, capabilities, irq_mode, i;
310 int vectors[PCIE_PORT_DEVICE_MAXSERVICES];
313 /* Allocate port device extension */
314 if (!(p_ext = kmalloc(sizeof(struct pcie_port_device_ext), GFP_KERNEL)))
317 pci_set_drvdata(dev, p_ext);
320 pci_read_config_word(dev,
321 pci_find_capability(dev, PCI_CAP_ID_EXP) +
322 PCIE_CAPABILITIES_REG, ®16);
323 type = (reg16 >> 4) & PORT_TYPE_MASK;
325 /* Now get port services */
326 capabilities = get_port_device_capability(dev);
327 irq_mode = assign_interrupt_mode(dev, vectors, capabilities);
328 p_ext->interrupt_mode = irq_mode;
330 /* Allocate child services if any */
331 for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
332 struct pcie_device *child;
334 if (capabilities & (1 << i)) {
335 child = alloc_pcie_device(
337 type, /* port type */
338 i, /* service type */
339 vectors[i], /* irq */
340 irq_mode /* interrupt mode */);
342 status = device_register(&child->device);
347 get_device(&child->device);
355 static int suspend_iter(struct device *dev, void *data)
357 struct pcie_port_service_driver *service_driver;
358 pm_message_t state = * (pm_message_t *) data;
360 if ((dev->bus == &pcie_port_bus_type) &&
362 service_driver = to_service_driver(dev->driver);
363 if (service_driver->suspend)
364 service_driver->suspend(to_pcie_device(dev), state);
370 * pcie_port_device_suspend - suspend port services associated with a PCIe port
371 * @dev: PCI Express port to handle
372 * @state: Representation of system power management transition in progress
374 int pcie_port_device_suspend(struct pci_dev *dev, pm_message_t state)
376 return device_for_each_child(&dev->dev, &state, suspend_iter);
379 static int resume_iter(struct device *dev, void *data)
381 struct pcie_port_service_driver *service_driver;
383 if ((dev->bus == &pcie_port_bus_type) &&
385 service_driver = to_service_driver(dev->driver);
386 if (service_driver->resume)
387 service_driver->resume(to_pcie_device(dev));
393 * pcie_port_device_suspend - resume port services associated with a PCIe port
394 * @dev: PCI Express port to handle
396 int pcie_port_device_resume(struct pci_dev *dev)
398 return device_for_each_child(&dev->dev, NULL, resume_iter);
402 static int remove_iter(struct device *dev, void *data)
404 struct pcie_port_service_driver *service_driver;
406 if (dev->bus == &pcie_port_bus_type) {
408 service_driver = to_service_driver(dev->driver);
409 if (service_driver->remove)
410 service_driver->remove(to_pcie_device(dev));
412 *(unsigned long*)data = (unsigned long)dev;
419 * pcie_port_device_remove - unregister PCI Express port service devices
420 * @dev: PCI Express port the service devices to unregister are associated with
422 * Remove PCI Express port service devices associated with given port and
423 * disable MSI-X or MSI for the port.
425 void pcie_port_device_remove(struct pci_dev *dev)
427 struct device *device;
428 unsigned long device_addr;
429 int interrupt_mode = PCIE_PORT_INTx_MODE;
433 status = device_for_each_child(&dev->dev, &device_addr, remove_iter);
435 device = (struct device*)device_addr;
436 interrupt_mode = (to_pcie_device(device))->interrupt_mode;
438 device_unregister(device);
441 /* Switch to INTx by default if MSI enabled */
442 if (interrupt_mode == PCIE_PORT_MSIX_MODE)
443 pci_disable_msix(dev);
444 else if (interrupt_mode == PCIE_PORT_MSI_MODE)
445 pci_disable_msi(dev);
448 int pcie_port_bus_register(void)
450 return bus_register(&pcie_port_bus_type);
453 void pcie_port_bus_unregister(void)
455 bus_unregister(&pcie_port_bus_type);
458 int pcie_port_service_register(struct pcie_port_service_driver *new)
460 new->driver.name = (char *)new->name;
461 new->driver.bus = &pcie_port_bus_type;
462 new->driver.probe = pcie_port_probe_service;
463 new->driver.remove = pcie_port_remove_service;
464 new->driver.shutdown = pcie_port_shutdown_service;
465 new->driver.suspend = pcie_port_suspend_service;
466 new->driver.resume = pcie_port_resume_service;
468 return driver_register(&new->driver);
471 void pcie_port_service_unregister(struct pcie_port_service_driver *new)
473 driver_unregister(&new->driver);
476 EXPORT_SYMBOL(pcie_port_service_register);
477 EXPORT_SYMBOL(pcie_port_service_unregister);