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/pci.h>
34 #include <linux/pci-acpi.h>
35 #include <linux/acpi.h>
36 #include <acpi/acpi_bus.h>
37 #include <acpi/acpi_drivers.h>
39 #define _COMPONENT ACPI_PCI_COMPONENT
40 ACPI_MODULE_NAME("pci_root");
41 #define ACPI_PCI_ROOT_CLASS "pci_bridge"
42 #define ACPI_PCI_ROOT_DEVICE_NAME "PCI Root Bridge"
43 static int acpi_pci_root_add(struct acpi_device *device);
44 static int acpi_pci_root_remove(struct acpi_device *device, int type);
45 static int acpi_pci_root_start(struct acpi_device *device);
47 static struct acpi_device_id root_device_ids[] = {
51 MODULE_DEVICE_TABLE(acpi, root_device_ids);
53 static struct acpi_driver acpi_pci_root_driver = {
55 .class = ACPI_PCI_ROOT_CLASS,
56 .ids = root_device_ids,
58 .add = acpi_pci_root_add,
59 .remove = acpi_pci_root_remove,
60 .start = acpi_pci_root_start,
64 struct acpi_pci_root {
65 struct list_head node;
66 struct acpi_device * device;
67 struct acpi_pci_id id;
70 u32 osc_support_set; /* _OSC state of support bits */
71 u32 osc_control_set; /* _OSC state of control bits */
72 u32 osc_control_qry; /* the latest _OSC query result */
74 u32 osc_queried:1; /* has _OSC control been queried? */
77 static LIST_HEAD(acpi_pci_roots);
79 static struct acpi_pci_driver *sub_driver;
80 static DEFINE_MUTEX(osc_lock);
82 int acpi_pci_register_driver(struct acpi_pci_driver *driver)
85 struct list_head *entry;
87 struct acpi_pci_driver **pptr = &sub_driver;
89 pptr = &(*pptr)->next;
95 list_for_each(entry, &acpi_pci_roots) {
96 struct acpi_pci_root *root;
97 root = list_entry(entry, struct acpi_pci_root, node);
98 driver->add(root->device->handle);
105 EXPORT_SYMBOL(acpi_pci_register_driver);
107 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver)
109 struct list_head *entry;
111 struct acpi_pci_driver **pptr = &sub_driver;
115 pptr = &(*pptr)->next;
118 *pptr = (*pptr)->next;
123 list_for_each(entry, &acpi_pci_roots) {
124 struct acpi_pci_root *root;
125 root = list_entry(entry, struct acpi_pci_root, node);
126 driver->remove(root->device->handle);
130 EXPORT_SYMBOL(acpi_pci_unregister_driver);
132 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int seg, unsigned int bus)
134 struct acpi_pci_root *tmp;
136 list_for_each_entry(tmp, &acpi_pci_roots, node) {
137 if ((tmp->id.segment == (u16) seg) && (tmp->id.bus == (u16) bus))
138 return tmp->device->handle;
143 EXPORT_SYMBOL_GPL(acpi_get_pci_rootbridge_handle);
146 * acpi_is_root_bridge - determine whether an ACPI CA node is a PCI root bridge
147 * @handle - the ACPI CA node in question.
149 * Note: we could make this API take a struct acpi_device * instead, but
150 * for now, it's more convenient to operate on an acpi_handle.
152 int acpi_is_root_bridge(acpi_handle handle)
155 struct acpi_device *device;
157 ret = acpi_bus_get_device(handle, &device);
161 ret = acpi_match_device_ids(device, root_device_ids);
167 EXPORT_SYMBOL_GPL(acpi_is_root_bridge);
170 get_root_bridge_busnr_callback(struct acpi_resource *resource, void *data)
173 struct acpi_resource_address64 address;
175 if (resource->type != ACPI_RESOURCE_TYPE_ADDRESS16 &&
176 resource->type != ACPI_RESOURCE_TYPE_ADDRESS32 &&
177 resource->type != ACPI_RESOURCE_TYPE_ADDRESS64)
180 acpi_resource_to_address64(resource, &address);
181 if ((address.address_length > 0) &&
182 (address.resource_type == ACPI_BUS_NUMBER_RANGE))
183 *busnr = address.minimum;
188 static acpi_status try_get_root_bridge_busnr(acpi_handle handle, int *busnum)
194 acpi_walk_resources(handle, METHOD_NAME__CRS,
195 get_root_bridge_busnr_callback, busnum);
196 if (ACPI_FAILURE(status))
198 /* Check if we really get a bus number from _CRS */
204 static void acpi_pci_bridge_scan(struct acpi_device *device)
207 struct acpi_device *child = NULL;
209 if (device->flags.bus_address)
210 if (device->parent && device->parent->ops.bind) {
211 status = device->parent->ops.bind(device);
213 list_for_each_entry(child, &device->children, node)
214 acpi_pci_bridge_scan(child);
219 static u8 OSC_UUID[16] = {0x5B, 0x4D, 0xDB, 0x33, 0xF7, 0x1F, 0x1C, 0x40,
220 0x96, 0x57, 0x74, 0x41, 0xC0, 0x3D, 0xD7, 0x66};
222 static acpi_status acpi_pci_run_osc(acpi_handle handle,
223 const u32 *capbuf, u32 *retval)
226 struct acpi_object_list input;
227 union acpi_object in_params[4];
228 struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
229 union acpi_object *out_obj;
232 /* Setting up input parameters */
234 input.pointer = in_params;
235 in_params[0].type = ACPI_TYPE_BUFFER;
236 in_params[0].buffer.length = 16;
237 in_params[0].buffer.pointer = OSC_UUID;
238 in_params[1].type = ACPI_TYPE_INTEGER;
239 in_params[1].integer.value = 1;
240 in_params[2].type = ACPI_TYPE_INTEGER;
241 in_params[2].integer.value = 3;
242 in_params[3].type = ACPI_TYPE_BUFFER;
243 in_params[3].buffer.length = 12;
244 in_params[3].buffer.pointer = (u8 *)capbuf;
246 status = acpi_evaluate_object(handle, "_OSC", &input, &output);
247 if (ACPI_FAILURE(status))
251 return AE_NULL_OBJECT;
253 out_obj = output.pointer;
254 if (out_obj->type != ACPI_TYPE_BUFFER) {
255 printk(KERN_DEBUG "_OSC evaluation returned wrong type\n");
259 /* Need to ignore the bit0 in result code */
260 errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
262 if (errors & OSC_REQUEST_ERROR)
263 printk(KERN_DEBUG "_OSC request failed\n");
264 if (errors & OSC_INVALID_UUID_ERROR)
265 printk(KERN_DEBUG "_OSC invalid UUID\n");
266 if (errors & OSC_INVALID_REVISION_ERROR)
267 printk(KERN_DEBUG "_OSC invalid revision\n");
268 if (errors & OSC_CAPABILITIES_MASK_ERROR) {
269 if (capbuf[OSC_QUERY_TYPE] & OSC_QUERY_ENABLE)
272 "Firmware did not grant requested _OSC control\n");
280 *retval = *((u32 *)(out_obj->buffer.pointer + 8));
284 kfree(output.pointer);
288 static acpi_status acpi_pci_query_osc(struct acpi_pci_root *root, u32 flags)
291 u32 support_set, result, capbuf[3];
293 /* do _OSC query for all possible controls */
294 support_set = root->osc_support_set | (flags & OSC_SUPPORT_MASKS);
295 capbuf[OSC_QUERY_TYPE] = OSC_QUERY_ENABLE;
296 capbuf[OSC_SUPPORT_TYPE] = support_set;
297 capbuf[OSC_CONTROL_TYPE] = OSC_CONTROL_MASKS;
299 status = acpi_pci_run_osc(root->device->handle, capbuf, &result);
300 if (ACPI_SUCCESS(status)) {
301 root->osc_support_set = support_set;
302 root->osc_control_qry = result;
303 root->osc_queried = 1;
308 static acpi_status acpi_pci_osc_support(struct acpi_pci_root *root, u32 flags)
313 status = acpi_get_handle(root->device->handle, "_OSC", &tmp);
314 if (ACPI_FAILURE(status))
316 mutex_lock(&osc_lock);
317 status = acpi_pci_query_osc(root, flags);
318 mutex_unlock(&osc_lock);
322 static struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle)
324 struct acpi_pci_root *root;
325 list_for_each_entry(root, &acpi_pci_roots, node) {
326 if (root->device->handle == handle)
332 struct acpi_handle_node {
333 struct list_head node;
338 * acpi_get_pci_dev - convert ACPI CA handle to struct pci_dev
339 * @handle: the handle in question
341 * Given an ACPI CA handle, the desired PCI device is located in the
342 * list of PCI devices.
344 * If the device is found, its reference count is increased and this
345 * function returns a pointer to its data structure. The caller must
346 * decrement the reference count by calling pci_dev_put().
347 * If no device is found, %NULL is returned.
349 struct pci_dev *acpi_get_pci_dev(acpi_handle handle)
352 unsigned long long adr;
355 struct pci_bus *pbus;
356 struct pci_dev *pdev = NULL;
357 struct acpi_handle_node *node, *tmp;
358 struct acpi_pci_root *root;
359 LIST_HEAD(device_list);
362 * Walk up the ACPI CA namespace until we reach a PCI root bridge.
365 while (!acpi_is_root_bridge(phandle)) {
366 node = kzalloc(sizeof(struct acpi_handle_node), GFP_KERNEL);
370 INIT_LIST_HEAD(&node->node);
371 node->handle = phandle;
372 list_add(&node->node, &device_list);
374 status = acpi_get_parent(phandle, &phandle);
375 if (ACPI_FAILURE(status))
379 root = acpi_pci_find_root(phandle);
386 * Now, walk back down the PCI device tree until we return to our
387 * original handle. Assumes that everything between the PCI root
388 * bridge and the device we're looking for must be a P2P bridge.
390 list_for_each_entry(node, &device_list, node) {
391 acpi_handle hnd = node->handle;
392 status = acpi_evaluate_integer(hnd, "_ADR", NULL, &adr);
393 if (ACPI_FAILURE(status))
395 dev = (adr >> 16) & 0xffff;
398 pdev = pci_get_slot(pbus, PCI_DEVFN(dev, fn));
402 pbus = pdev->subordinate;
406 list_for_each_entry_safe(node, tmp, &device_list, node)
411 EXPORT_SYMBOL_GPL(acpi_get_pci_dev);
414 * acpi_pci_osc_control_set - commit requested control to Firmware
415 * @handle: acpi_handle for the target ACPI object
416 * @flags: driver's requested control bits
418 * Attempt to take control from Firmware on requested control bits.
420 acpi_status acpi_pci_osc_control_set(acpi_handle handle, u32 flags)
423 u32 control_req, result, capbuf[3];
425 struct acpi_pci_root *root;
427 status = acpi_get_handle(handle, "_OSC", &tmp);
428 if (ACPI_FAILURE(status))
431 control_req = (flags & OSC_CONTROL_MASKS);
435 root = acpi_pci_find_root(handle);
439 mutex_lock(&osc_lock);
440 /* No need to evaluate _OSC if the control was already granted. */
441 if ((root->osc_control_set & control_req) == control_req)
444 /* Need to query controls first before requesting them */
445 if (!root->osc_queried) {
446 status = acpi_pci_query_osc(root, root->osc_support_set);
447 if (ACPI_FAILURE(status))
450 if ((root->osc_control_qry & control_req) != control_req) {
452 "Firmware did not grant requested _OSC control\n");
457 capbuf[OSC_QUERY_TYPE] = 0;
458 capbuf[OSC_SUPPORT_TYPE] = root->osc_support_set;
459 capbuf[OSC_CONTROL_TYPE] = root->osc_control_set | control_req;
460 status = acpi_pci_run_osc(handle, capbuf, &result);
461 if (ACPI_SUCCESS(status))
462 root->osc_control_set = result;
464 mutex_unlock(&osc_lock);
467 EXPORT_SYMBOL(acpi_pci_osc_control_set);
469 static int __devinit acpi_pci_root_add(struct acpi_device *device)
472 struct acpi_pci_root *root = NULL;
473 struct acpi_pci_root *tmp;
474 acpi_status status = AE_OK;
475 unsigned long long value = 0;
476 acpi_handle handle = NULL;
477 struct acpi_device *child;
478 u32 flags, base_flags;
484 root = kzalloc(sizeof(struct acpi_pci_root), GFP_KERNEL);
487 INIT_LIST_HEAD(&root->node);
489 root->device = device;
490 strcpy(acpi_device_name(device), ACPI_PCI_ROOT_DEVICE_NAME);
491 strcpy(acpi_device_class(device), ACPI_PCI_ROOT_CLASS);
492 device->driver_data = root;
495 * All supported architectures that use ACPI have support for
496 * PCI domains, so we indicate this in _OSC support capabilities.
498 flags = base_flags = OSC_PCI_SEGMENT_GROUPS_SUPPORT;
499 acpi_pci_osc_support(root, flags);
504 * Obtained via _SEG, if exists, otherwise assumed to be zero (0).
506 status = acpi_evaluate_integer(device->handle, METHOD_NAME__SEG, NULL,
510 root->id.segment = (u16) value;
513 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
514 "Assuming segment 0 (no _SEG)\n"));
515 root->id.segment = 0;
518 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _SEG"));
526 * Obtained via _BBN, if exists, otherwise assumed to be zero (0).
528 status = acpi_evaluate_integer(device->handle, METHOD_NAME__BBN, NULL,
532 root->id.bus = (u16) value;
535 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Assuming bus 0 (no _BBN)\n"));
539 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _BBN"));
544 /* Some systems have wrong _BBN */
545 list_for_each_entry(tmp, &acpi_pci_roots, node) {
546 if ((tmp->id.segment == root->id.segment)
547 && (tmp->id.bus == root->id.bus)) {
551 printk(KERN_ERR PREFIX
552 "Wrong _BBN value, reboot"
553 " and use option 'pci=noacpi'\n");
555 status = try_get_root_bridge_busnr(device->handle, &bus);
556 if (ACPI_FAILURE(status))
558 if (bus != root->id.bus) {
559 printk(KERN_INFO PREFIX
560 "PCI _CRS %d overrides _BBN 0\n", bus);
569 * Obtained from _ADR (which has already been evaluated for us).
571 root->id.device = device->pnp.bus_address >> 16;
572 root->id.function = device->pnp.bus_address & 0xFFFF;
575 * TBD: Need PCI interface for enumeration/configuration of roots.
579 list_add_tail(&root->node, &acpi_pci_roots);
581 printk(KERN_INFO PREFIX "%s [%s] (%04x:%02x)\n",
582 acpi_device_name(device), acpi_device_bid(device),
583 root->id.segment, root->id.bus);
586 * Scan the Root Bridge
587 * --------------------
588 * Must do this prior to any attempt to bind the root device, as the
589 * PCI namespace does not get created until this call is made (and
590 * thus the root bridge's pci_dev does not exist).
592 root->bus = pci_acpi_scan_root(device, root->id.segment, root->id.bus);
594 printk(KERN_ERR PREFIX
595 "Bus %04x:%02x not present in PCI namespace\n",
596 root->id.segment, root->id.bus);
602 * Attach ACPI-PCI Context
603 * -----------------------
604 * Thus binding the ACPI and PCI devices.
606 result = acpi_pci_bind_root(device);
613 * Evaluate and parse _PRT, if exists.
615 status = acpi_get_handle(device->handle, METHOD_NAME__PRT, &handle);
616 if (ACPI_SUCCESS(status))
617 result = acpi_pci_irq_add_prt(device->handle, root->id.segment,
621 * Scan and bind all _ADR-Based Devices
623 list_for_each_entry(child, &device->children, node)
624 acpi_pci_bridge_scan(child);
626 /* Indicate support for various _OSC capabilities. */
627 if (pci_ext_cfg_avail(root->bus->self))
628 flags |= OSC_EXT_PCI_CONFIG_SUPPORT;
629 if (pcie_aspm_enabled())
630 flags |= OSC_ACTIVE_STATE_PWR_SUPPORT |
631 OSC_CLOCK_PWR_CAPABILITY_SUPPORT;
632 if (pci_msi_enabled())
633 flags |= OSC_MSI_SUPPORT;
634 if (flags != base_flags)
635 acpi_pci_osc_support(root, flags);
639 if (!list_empty(&root->node))
640 list_del(&root->node);
647 static int acpi_pci_root_start(struct acpi_device *device)
649 struct acpi_pci_root *root;
652 list_for_each_entry(root, &acpi_pci_roots, node) {
653 if (root->device == device) {
654 pci_bus_add_devices(root->bus);
661 static int acpi_pci_root_remove(struct acpi_device *device, int type)
663 struct acpi_pci_root *root = NULL;
666 if (!device || !acpi_driver_data(device))
669 root = acpi_driver_data(device);
676 static int __init acpi_pci_root_init(void)
678 if (acpi_pci_disabled)
681 if (acpi_bus_register_driver(&acpi_pci_root_driver) < 0)
687 subsys_initcall(acpi_pci_root_init);