2 * pci_root.c - ACPI PCI Root Bridge Driver ($Revision: 40 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/types.h>
30 #include <linux/proc_fs.h>
31 #include <linux/spinlock.h>
33 #include <linux/pm_runtime.h>
34 #include <linux/pci.h>
35 #include <linux/pci-acpi.h>
36 #include <linux/pci-aspm.h>
37 #include <linux/acpi.h>
38 #include <linux/slab.h>
39 #include <acpi/acpi_bus.h>
40 #include <acpi/acpi_drivers.h>
42 #define PREFIX "ACPI: "
44 #define _COMPONENT ACPI_PCI_COMPONENT
45 ACPI_MODULE_NAME("pci_root");
46 #define ACPI_PCI_ROOT_CLASS "pci_bridge"
47 #define ACPI_PCI_ROOT_DEVICE_NAME "PCI Root Bridge"
48 static int acpi_pci_root_add(struct acpi_device *device);
49 static int acpi_pci_root_remove(struct acpi_device *device, int type);
50 static int acpi_pci_root_start(struct acpi_device *device);
52 static const struct acpi_device_id root_device_ids[] = {
56 MODULE_DEVICE_TABLE(acpi, root_device_ids);
58 static struct acpi_driver acpi_pci_root_driver = {
60 .class = ACPI_PCI_ROOT_CLASS,
61 .ids = root_device_ids,
63 .add = acpi_pci_root_add,
64 .remove = acpi_pci_root_remove,
65 .start = acpi_pci_root_start,
69 static LIST_HEAD(acpi_pci_roots);
71 static struct acpi_pci_driver *sub_driver;
72 static DEFINE_MUTEX(osc_lock);
74 int acpi_pci_register_driver(struct acpi_pci_driver *driver)
77 struct acpi_pci_root *root;
79 struct acpi_pci_driver **pptr = &sub_driver;
81 pptr = &(*pptr)->next;
87 list_for_each_entry(root, &acpi_pci_roots, node) {
88 driver->add(root->device->handle);
95 EXPORT_SYMBOL(acpi_pci_register_driver);
97 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver)
99 struct acpi_pci_root *root;
101 struct acpi_pci_driver **pptr = &sub_driver;
105 pptr = &(*pptr)->next;
108 *pptr = (*pptr)->next;
113 list_for_each_entry(root, &acpi_pci_roots, node)
114 driver->remove(root->device->handle);
117 EXPORT_SYMBOL(acpi_pci_unregister_driver);
119 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int seg, unsigned int bus)
121 struct acpi_pci_root *root;
123 list_for_each_entry(root, &acpi_pci_roots, node)
124 if ((root->segment == (u16) seg) &&
125 (root->secondary.start == (u16) bus))
126 return root->device->handle;
130 EXPORT_SYMBOL_GPL(acpi_get_pci_rootbridge_handle);
133 * acpi_is_root_bridge - determine whether an ACPI CA node is a PCI root bridge
134 * @handle - the ACPI CA node in question.
136 * Note: we could make this API take a struct acpi_device * instead, but
137 * for now, it's more convenient to operate on an acpi_handle.
139 int acpi_is_root_bridge(acpi_handle handle)
142 struct acpi_device *device;
144 ret = acpi_bus_get_device(handle, &device);
148 ret = acpi_match_device_ids(device, root_device_ids);
154 EXPORT_SYMBOL_GPL(acpi_is_root_bridge);
157 get_root_bridge_busnr_callback(struct acpi_resource *resource, void *data)
159 struct resource *res = data;
160 struct acpi_resource_address64 address;
162 if (resource->type != ACPI_RESOURCE_TYPE_ADDRESS16 &&
163 resource->type != ACPI_RESOURCE_TYPE_ADDRESS32 &&
164 resource->type != ACPI_RESOURCE_TYPE_ADDRESS64)
167 acpi_resource_to_address64(resource, &address);
168 if ((address.address_length > 0) &&
169 (address.resource_type == ACPI_BUS_NUMBER_RANGE)) {
170 res->start = address.minimum;
171 res->end = address.minimum + address.address_length - 1;
177 static acpi_status try_get_root_bridge_busnr(acpi_handle handle,
178 struct resource *res)
184 acpi_walk_resources(handle, METHOD_NAME__CRS,
185 get_root_bridge_busnr_callback, res);
186 if (ACPI_FAILURE(status))
188 if (res->start == -1)
193 static void acpi_pci_bridge_scan(struct acpi_device *device)
196 struct acpi_device *child = NULL;
198 if (device->flags.bus_address)
199 if (device->parent && device->parent->ops.bind) {
200 status = device->parent->ops.bind(device);
202 list_for_each_entry(child, &device->children, node)
203 acpi_pci_bridge_scan(child);
208 static u8 pci_osc_uuid_str[] = "33DB4D5B-1FF7-401C-9657-7441C03DD766";
210 static acpi_status acpi_pci_run_osc(acpi_handle handle,
211 const u32 *capbuf, u32 *retval)
213 struct acpi_osc_context context = {
214 .uuid_str = pci_osc_uuid_str,
217 .cap.pointer = (void *)capbuf,
221 status = acpi_run_osc(handle, &context);
222 if (ACPI_SUCCESS(status)) {
223 *retval = *((u32 *)(context.ret.pointer + 8));
224 kfree(context.ret.pointer);
229 static acpi_status acpi_pci_query_osc(struct acpi_pci_root *root,
234 u32 result, capbuf[3];
236 support &= OSC_PCI_SUPPORT_MASKS;
237 support |= root->osc_support_set;
239 capbuf[OSC_QUERY_TYPE] = OSC_QUERY_ENABLE;
240 capbuf[OSC_SUPPORT_TYPE] = support;
242 *control &= OSC_PCI_CONTROL_MASKS;
243 capbuf[OSC_CONTROL_TYPE] = *control | root->osc_control_set;
245 /* Run _OSC query for all possible controls. */
246 capbuf[OSC_CONTROL_TYPE] = OSC_PCI_CONTROL_MASKS;
249 status = acpi_pci_run_osc(root->device->handle, capbuf, &result);
250 if (ACPI_SUCCESS(status)) {
251 root->osc_support_set = support;
258 static acpi_status acpi_pci_osc_support(struct acpi_pci_root *root, u32 flags)
263 status = acpi_get_handle(root->device->handle, "_OSC", &tmp);
264 if (ACPI_FAILURE(status))
266 mutex_lock(&osc_lock);
267 status = acpi_pci_query_osc(root, flags, NULL);
268 mutex_unlock(&osc_lock);
272 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle)
274 struct acpi_pci_root *root;
276 list_for_each_entry(root, &acpi_pci_roots, node) {
277 if (root->device->handle == handle)
282 EXPORT_SYMBOL_GPL(acpi_pci_find_root);
284 struct acpi_handle_node {
285 struct list_head node;
290 * acpi_get_pci_dev - convert ACPI CA handle to struct pci_dev
291 * @handle: the handle in question
293 * Given an ACPI CA handle, the desired PCI device is located in the
294 * list of PCI devices.
296 * If the device is found, its reference count is increased and this
297 * function returns a pointer to its data structure. The caller must
298 * decrement the reference count by calling pci_dev_put().
299 * If no device is found, %NULL is returned.
301 struct pci_dev *acpi_get_pci_dev(acpi_handle handle)
304 unsigned long long adr;
307 struct pci_bus *pbus;
308 struct pci_dev *pdev = NULL;
309 struct acpi_handle_node *node, *tmp;
310 struct acpi_pci_root *root;
311 LIST_HEAD(device_list);
314 * Walk up the ACPI CA namespace until we reach a PCI root bridge.
317 while (!acpi_is_root_bridge(phandle)) {
318 node = kzalloc(sizeof(struct acpi_handle_node), GFP_KERNEL);
322 INIT_LIST_HEAD(&node->node);
323 node->handle = phandle;
324 list_add(&node->node, &device_list);
326 status = acpi_get_parent(phandle, &phandle);
327 if (ACPI_FAILURE(status))
331 root = acpi_pci_find_root(phandle);
338 * Now, walk back down the PCI device tree until we return to our
339 * original handle. Assumes that everything between the PCI root
340 * bridge and the device we're looking for must be a P2P bridge.
342 list_for_each_entry(node, &device_list, node) {
343 acpi_handle hnd = node->handle;
344 status = acpi_evaluate_integer(hnd, "_ADR", NULL, &adr);
345 if (ACPI_FAILURE(status))
347 dev = (adr >> 16) & 0xffff;
350 pdev = pci_get_slot(pbus, PCI_DEVFN(dev, fn));
351 if (!pdev || hnd == handle)
354 pbus = pdev->subordinate;
358 * This function may be called for a non-PCI device that has a
359 * PCI parent (eg. a disk under a PCI SATA controller). In that
360 * case pdev->subordinate will be NULL for the parent.
363 dev_dbg(&pdev->dev, "Not a PCI-to-PCI bridge\n");
369 list_for_each_entry_safe(node, tmp, &device_list, node)
374 EXPORT_SYMBOL_GPL(acpi_get_pci_dev);
377 * acpi_pci_osc_control_set - commit requested control to Firmware
378 * @handle: acpi_handle for the target ACPI object
379 * @flags: driver's requested control bits
381 * Attempt to take control from Firmware on requested control bits.
383 acpi_status acpi_pci_osc_control_set(acpi_handle handle, u32 flags)
386 u32 control_req, result, capbuf[3];
388 struct acpi_pci_root *root;
390 control_req = (flags & OSC_PCI_CONTROL_MASKS);
394 root = acpi_pci_find_root(handle);
398 status = acpi_get_handle(handle, "_OSC", &tmp);
399 if (ACPI_FAILURE(status))
402 mutex_lock(&osc_lock);
403 /* No need to evaluate _OSC if the control was already granted. */
404 if ((root->osc_control_set & control_req) == control_req)
407 /* Need to query controls first before requesting them */
409 status = acpi_pci_query_osc(root, root->osc_support_set, &flags);
410 if (ACPI_FAILURE(status))
413 if (flags != control_req) {
418 capbuf[OSC_QUERY_TYPE] = 0;
419 capbuf[OSC_SUPPORT_TYPE] = root->osc_support_set;
420 capbuf[OSC_CONTROL_TYPE] = root->osc_control_set | control_req;
421 status = acpi_pci_run_osc(handle, capbuf, &result);
422 if (ACPI_SUCCESS(status))
423 root->osc_control_set = result;
425 mutex_unlock(&osc_lock);
428 EXPORT_SYMBOL(acpi_pci_osc_control_set);
430 static int __devinit acpi_pci_root_add(struct acpi_device *device)
432 unsigned long long segment, bus;
435 struct acpi_pci_root *root;
437 struct acpi_device *child;
438 u32 flags, base_flags;
440 root = kzalloc(sizeof(struct acpi_pci_root), GFP_KERNEL);
445 status = acpi_evaluate_integer(device->handle, METHOD_NAME__SEG, NULL,
447 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
448 printk(KERN_ERR PREFIX "can't evaluate _SEG\n");
453 /* Check _CRS first, then _BBN. If no _BBN, default to zero. */
454 root->secondary.flags = IORESOURCE_BUS;
455 status = try_get_root_bridge_busnr(device->handle, &root->secondary);
456 if (ACPI_FAILURE(status)) {
458 * We need both the start and end of the downstream bus range
459 * to interpret _CBA (MMCONFIG base address), so it really is
460 * supposed to be in _CRS. If we don't find it there, all we
461 * can do is assume [_BBN-0xFF] or [0-0xFF].
463 root->secondary.end = 0xFF;
464 printk(KERN_WARNING FW_BUG PREFIX
465 "no secondary bus range in _CRS\n");
466 status = acpi_evaluate_integer(device->handle, METHOD_NAME__BBN, NULL, &bus);
467 if (ACPI_SUCCESS(status))
468 root->secondary.start = bus;
469 else if (status == AE_NOT_FOUND)
470 root->secondary.start = 0;
472 printk(KERN_ERR PREFIX "can't evaluate _BBN\n");
478 INIT_LIST_HEAD(&root->node);
479 root->device = device;
480 root->segment = segment & 0xFFFF;
481 strcpy(acpi_device_name(device), ACPI_PCI_ROOT_DEVICE_NAME);
482 strcpy(acpi_device_class(device), ACPI_PCI_ROOT_CLASS);
483 device->driver_data = root;
486 * All supported architectures that use ACPI have support for
487 * PCI domains, so we indicate this in _OSC support capabilities.
489 flags = base_flags = OSC_PCI_SEGMENT_GROUPS_SUPPORT;
490 acpi_pci_osc_support(root, flags);
493 * TBD: Need PCI interface for enumeration/configuration of roots.
497 list_add_tail(&root->node, &acpi_pci_roots);
499 printk(KERN_INFO PREFIX "%s [%s] (domain %04x %pR)\n",
500 acpi_device_name(device), acpi_device_bid(device),
501 root->segment, &root->secondary);
504 * Scan the Root Bridge
505 * --------------------
506 * Must do this prior to any attempt to bind the root device, as the
507 * PCI namespace does not get created until this call is made (and
508 * thus the root bridge's pci_dev does not exist).
510 root->bus = pci_acpi_scan_root(root);
512 printk(KERN_ERR PREFIX
513 "Bus %04x:%02x not present in PCI namespace\n",
514 root->segment, (unsigned int)root->secondary.start);
520 * Attach ACPI-PCI Context
521 * -----------------------
522 * Thus binding the ACPI and PCI devices.
524 result = acpi_pci_bind_root(device);
531 * Evaluate and parse _PRT, if exists.
533 status = acpi_get_handle(device->handle, METHOD_NAME__PRT, &handle);
534 if (ACPI_SUCCESS(status))
535 result = acpi_pci_irq_add_prt(device->handle, root->bus);
538 * Scan and bind all _ADR-Based Devices
540 list_for_each_entry(child, &device->children, node)
541 acpi_pci_bridge_scan(child);
543 /* Indicate support for various _OSC capabilities. */
544 if (pci_ext_cfg_avail(root->bus->self))
545 flags |= OSC_EXT_PCI_CONFIG_SUPPORT;
546 if (pcie_aspm_enabled())
547 flags |= OSC_ACTIVE_STATE_PWR_SUPPORT |
548 OSC_CLOCK_PWR_CAPABILITY_SUPPORT;
549 if (pci_msi_enabled())
550 flags |= OSC_MSI_SUPPORT;
551 if (flags != base_flags)
552 acpi_pci_osc_support(root, flags);
554 status = acpi_pci_osc_control_set(root->device->handle,
555 OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
557 if (ACPI_FAILURE(status)) {
558 printk(KERN_INFO "Unable to assume PCIe control: Disabling ASPM\n");
562 pci_acpi_add_bus_pm_notifier(device, root->bus);
563 if (device->wakeup.flags.run_wake)
564 device_set_run_wake(root->bus->bridge, true);
569 if (!list_empty(&root->node))
570 list_del(&root->node);
575 static int acpi_pci_root_start(struct acpi_device *device)
577 struct acpi_pci_root *root = acpi_driver_data(device);
579 pci_bus_add_devices(root->bus);
583 static int acpi_pci_root_remove(struct acpi_device *device, int type)
585 struct acpi_pci_root *root = acpi_driver_data(device);
587 device_set_run_wake(root->bus->bridge, false);
588 pci_acpi_remove_bus_pm_notifier(device);
594 static int __init acpi_pci_root_init(void)
596 if (acpi_pci_disabled)
599 pci_acpi_crs_quirks();
600 if (acpi_bus_register_driver(&acpi_pci_root_driver) < 0)
606 subsys_initcall(acpi_pci_root_init);