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>
22 * release_pcie_device - free PCI Express port service device structure
23 * @dev: Port service device to release
25 * Invoked automatically when device is being removed in response to
26 * device_unregister(dev). Release all resources being claimed.
28 static void release_pcie_device(struct device *dev)
30 kfree(to_pcie_device(dev));
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()
40 * Return value: Interrupt mode associated with the port
42 static int assign_interrupt_mode(struct pci_dev *dev, int *vectors, int mask)
44 struct pcie_port_data *port_data = pci_get_drvdata(dev);
45 int i, pos, nvec, status = -EINVAL;
46 int interrupt_mode = PCIE_PORT_NO_IRQ;
48 /* Set INTx as default */
49 for (i = 0, nvec = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
52 vectors[i] = dev->irq;
55 interrupt_mode = PCIE_PORT_INTx_MODE;
58 if (port_data->port_type == PCIE_RC_PORT && pcie_mch_quirk)
59 return interrupt_mode;
61 /* Select MSI-X over MSI if supported */
62 pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
64 struct msix_entry msix_entries[PCIE_PORT_DEVICE_MAXSERVICES] =
65 {{0, 0}, {0, 1}, {0, 2}, {0, 3}};
66 status = pci_enable_msix(dev, msix_entries, nvec);
70 interrupt_mode = PCIE_PORT_MSIX_MODE;
71 for (i = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
73 vectors[i] = msix_entries[j++].vector;
78 pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
80 status = pci_enable_msi(dev);
82 interrupt_mode = PCIE_PORT_MSI_MODE;
83 for (i = 0;i < PCIE_PORT_DEVICE_MAXSERVICES;i++)
84 vectors[i] = dev->irq;
88 return interrupt_mode;
92 * get_port_device_capability - discover capabilities of a PCI Express port
93 * @dev: PCI Express port to examine
95 * The capabilities are read from the port's PCI Express configuration registers
96 * as described in PCI Express Base Specification 1.0a sections 7.8.2, 7.8.9 and
99 * Return value: Bitmask of discovered port capabilities
101 static int get_port_device_capability(struct pci_dev *dev)
103 int services = 0, pos;
107 pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
108 pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, ®16);
109 /* Hot-Plug Capable */
110 if (reg16 & PORT_TO_SLOT_MASK) {
111 pci_read_config_dword(dev,
112 pos + PCIE_SLOT_CAPABILITIES_REG, ®32);
113 if (reg32 & SLOT_HP_CAPABLE_MASK)
114 services |= PCIE_PORT_SERVICE_HP;
117 if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ERR))
118 services |= PCIE_PORT_SERVICE_AER;
120 if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_VC))
121 services |= PCIE_PORT_SERVICE_VC;
127 * pcie_device_init - initialize PCI Express port service device
128 * @dev: Port service device to initialize
129 * @parent: PCI Express port to associate the service device with
130 * @port_type: Type of the port
131 * @service_type: Type of service to associate with the service device
132 * @irq: Interrupt vector to associate with the service device
134 static void pcie_device_init(struct pci_dev *parent, struct pcie_device *dev,
135 int service_type, int irq)
137 struct pcie_port_data *port_data = pci_get_drvdata(parent);
138 struct device *device;
139 int port_type = port_data->port_type;
143 dev->id.vendor = parent->vendor;
144 dev->id.device = parent->device;
145 dev->id.port_type = port_type;
146 dev->id.service_type = service_type;
148 /* Initialize generic device interface */
149 device = &dev->device;
150 memset(device, 0, sizeof(struct device));
151 device->bus = &pcie_port_bus_type;
152 device->driver = NULL;
153 device->driver_data = NULL;
154 device->release = release_pcie_device; /* callback to free pcie dev */
155 dev_set_name(device, "%s:pcie%02x",
156 pci_name(parent), get_descriptor_id(port_type, service_type));
157 device->parent = &parent->dev;
161 * alloc_pcie_device - allocate PCI Express port service device structure
162 * @parent: PCI Express port to associate the service device with
163 * @port_type: Type of the port
164 * @service_type: Type of service to associate with the service device
165 * @irq: Interrupt vector to associate with the service device
167 static struct pcie_device* alloc_pcie_device(struct pci_dev *parent,
168 int service_type, int irq)
170 struct pcie_device *device;
172 device = kzalloc(sizeof(struct pcie_device), GFP_KERNEL);
176 pcie_device_init(parent, device, service_type, irq);
181 * pcie_port_device_probe - check if device is a PCI Express port
182 * @dev: Device to check
184 int pcie_port_device_probe(struct pci_dev *dev)
189 if (!(pos = pci_find_capability(dev, PCI_CAP_ID_EXP)))
192 pci_read_config_word(dev, pos + PCIE_CAPABILITIES_REG, ®);
193 type = (reg >> 4) & PORT_TYPE_MASK;
194 if ( type == PCIE_RC_PORT || type == PCIE_SW_UPSTREAM_PORT ||
195 type == PCIE_SW_DOWNSTREAM_PORT )
202 * pcie_port_device_register - register PCI Express port
203 * @dev: PCI Express port to register
205 * Allocate the port extension structure and register services associated with
208 int pcie_port_device_register(struct pci_dev *dev)
210 struct pcie_port_data *port_data;
211 int status, capabilities, irq_mode, i, nr_serv;
212 int vectors[PCIE_PORT_DEVICE_MAXSERVICES];
215 port_data = kzalloc(sizeof(*port_data), GFP_KERNEL);
218 pci_set_drvdata(dev, port_data);
221 pci_read_config_word(dev,
222 pci_find_capability(dev, PCI_CAP_ID_EXP) +
223 PCIE_CAPABILITIES_REG, ®16);
224 port_data->port_type = (reg16 >> 4) & PORT_TYPE_MASK;
226 capabilities = get_port_device_capability(dev);
227 /* Root ports are capable of generating PME too */
228 if (port_data->port_type == PCIE_RC_PORT)
229 capabilities |= PCIE_PORT_SERVICE_PME;
231 irq_mode = assign_interrupt_mode(dev, vectors, capabilities);
232 if (irq_mode == PCIE_PORT_NO_IRQ) {
234 * Don't use service devices that require interrupts if there is
235 * no way to generate them.
237 if (!(capabilities & PCIE_PORT_SERVICE_VC)) {
241 capabilities = PCIE_PORT_SERVICE_VC;
243 port_data->port_irq_mode = irq_mode;
245 status = pci_enable_device(dev);
250 /* Allocate child services if any */
251 for (i = 0, nr_serv = 0; i < PCIE_PORT_DEVICE_MAXSERVICES; i++) {
252 struct pcie_device *child;
253 int service = 1 << i;
255 if (!(capabilities & service))
258 child = alloc_pcie_device(dev, service, vectors[i]);
262 status = device_register(&child->device);
268 get_device(&child->device);
272 pci_disable_device(dev);
285 static int suspend_iter(struct device *dev, void *data)
287 struct pcie_port_service_driver *service_driver;
288 pm_message_t state = * (pm_message_t *) data;
290 if ((dev->bus == &pcie_port_bus_type) &&
292 service_driver = to_service_driver(dev->driver);
293 if (service_driver->suspend)
294 service_driver->suspend(to_pcie_device(dev), state);
300 * pcie_port_device_suspend - suspend port services associated with a PCIe port
301 * @dev: PCI Express port to handle
302 * @state: Representation of system power management transition in progress
304 int pcie_port_device_suspend(struct pci_dev *dev, pm_message_t state)
306 return device_for_each_child(&dev->dev, &state, suspend_iter);
309 static int resume_iter(struct device *dev, void *data)
311 struct pcie_port_service_driver *service_driver;
313 if ((dev->bus == &pcie_port_bus_type) &&
315 service_driver = to_service_driver(dev->driver);
316 if (service_driver->resume)
317 service_driver->resume(to_pcie_device(dev));
323 * pcie_port_device_suspend - resume port services associated with a PCIe port
324 * @dev: PCI Express port to handle
326 int pcie_port_device_resume(struct pci_dev *dev)
328 return device_for_each_child(&dev->dev, NULL, resume_iter);
332 static int remove_iter(struct device *dev, void *data)
334 struct pcie_port_service_driver *service_driver;
336 if (dev->bus == &pcie_port_bus_type) {
338 service_driver = to_service_driver(dev->driver);
339 if (service_driver->remove)
340 service_driver->remove(to_pcie_device(dev));
342 *(unsigned long*)data = (unsigned long)dev;
349 * pcie_port_device_remove - unregister PCI Express port service devices
350 * @dev: PCI Express port the service devices to unregister are associated with
352 * Remove PCI Express port service devices associated with given port and
353 * disable MSI-X or MSI for the port.
355 void pcie_port_device_remove(struct pci_dev *dev)
357 struct pcie_port_data *port_data = pci_get_drvdata(dev);
361 unsigned long device_addr;
363 status = device_for_each_child(&dev->dev, &device_addr, remove_iter);
365 struct device *device = (struct device*)device_addr;
367 device_unregister(device);
371 switch (port_data->port_irq_mode) {
372 case PCIE_PORT_MSIX_MODE:
373 pci_disable_msix(dev);
375 case PCIE_PORT_MSI_MODE:
376 pci_disable_msi(dev);
384 * pcie_port_probe_service - probe driver for given PCI Express port service
385 * @dev: PCI Express port service device to probe against
387 * If PCI Express port service driver is registered with
388 * pcie_port_service_register(), this function will be called by the driver core
389 * whenever match is found between the driver and a port service device.
391 static int pcie_port_probe_service(struct device *dev)
393 struct pcie_device *pciedev;
394 struct pcie_port_service_driver *driver;
397 if (!dev || !dev->driver)
400 driver = to_service_driver(dev->driver);
401 if (!driver || !driver->probe)
404 pciedev = to_pcie_device(dev);
405 status = driver->probe(pciedev);
407 dev_printk(KERN_DEBUG, dev, "service driver %s loaded\n",
415 * pcie_port_remove_service - detach driver from given PCI Express port service
416 * @dev: PCI Express port service device to handle
418 * If PCI Express port service driver is registered with
419 * pcie_port_service_register(), this function will be called by the driver core
420 * when device_unregister() is called for the port service device associated
423 static int pcie_port_remove_service(struct device *dev)
425 struct pcie_device *pciedev;
426 struct pcie_port_service_driver *driver;
428 if (!dev || !dev->driver)
431 pciedev = to_pcie_device(dev);
432 driver = to_service_driver(dev->driver);
433 if (driver && driver->remove) {
434 dev_printk(KERN_DEBUG, dev, "unloading service driver %s\n",
436 driver->remove(pciedev);
443 * pcie_port_shutdown_service - shut down given PCI Express port service
444 * @dev: PCI Express port service device to handle
446 * If PCI Express port service driver is registered with
447 * pcie_port_service_register(), this function will be called by the driver core
448 * when device_shutdown() is called for the port service device associated
451 static void pcie_port_shutdown_service(struct device *dev) {}
454 * pcie_port_service_register - register PCI Express port service driver
455 * @new: PCI Express port service driver to register
457 int pcie_port_service_register(struct pcie_port_service_driver *new)
459 new->driver.name = (char *)new->name;
460 new->driver.bus = &pcie_port_bus_type;
461 new->driver.probe = pcie_port_probe_service;
462 new->driver.remove = pcie_port_remove_service;
463 new->driver.shutdown = pcie_port_shutdown_service;
465 return driver_register(&new->driver);
469 * pcie_port_service_unregister - unregister PCI Express port service driver
470 * @drv: PCI Express port service driver to unregister
472 void pcie_port_service_unregister(struct pcie_port_service_driver *drv)
474 driver_unregister(&drv->driver);
477 EXPORT_SYMBOL(pcie_port_service_register);
478 EXPORT_SYMBOL(pcie_port_service_unregister);