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;
71 u32 osc_support_set; /* _OSC state of support bits */
72 u32 osc_control_set; /* _OSC state of control bits */
73 u32 osc_control_qry; /* the latest _OSC query result */
75 u32 osc_queried:1; /* has _OSC control been queried? */
78 static LIST_HEAD(acpi_pci_roots);
80 static struct acpi_pci_driver *sub_driver;
81 static DEFINE_MUTEX(osc_lock);
83 int acpi_pci_register_driver(struct acpi_pci_driver *driver)
86 struct acpi_pci_root *root;
88 struct acpi_pci_driver **pptr = &sub_driver;
90 pptr = &(*pptr)->next;
96 list_for_each_entry(root, &acpi_pci_roots, node) {
97 driver->add(root->device->handle);
104 EXPORT_SYMBOL(acpi_pci_register_driver);
106 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver)
108 struct acpi_pci_root *root;
110 struct acpi_pci_driver **pptr = &sub_driver;
114 pptr = &(*pptr)->next;
117 *pptr = (*pptr)->next;
122 list_for_each_entry(root, &acpi_pci_roots, node)
123 driver->remove(root->device->handle);
126 EXPORT_SYMBOL(acpi_pci_unregister_driver);
128 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int seg, unsigned int bus)
130 struct acpi_pci_root *root;
132 list_for_each_entry(root, &acpi_pci_roots, node)
133 if ((root->segment == (u16) seg) && (root->bus_nr == (u16) bus))
134 return root->device->handle;
138 EXPORT_SYMBOL_GPL(acpi_get_pci_rootbridge_handle);
141 get_root_bridge_busnr_callback(struct acpi_resource *resource, void *data)
144 struct acpi_resource_address64 address;
146 if (resource->type != ACPI_RESOURCE_TYPE_ADDRESS16 &&
147 resource->type != ACPI_RESOURCE_TYPE_ADDRESS32 &&
148 resource->type != ACPI_RESOURCE_TYPE_ADDRESS64)
151 acpi_resource_to_address64(resource, &address);
152 if ((address.address_length > 0) &&
153 (address.resource_type == ACPI_BUS_NUMBER_RANGE))
154 *busnr = address.minimum;
159 static acpi_status try_get_root_bridge_busnr(acpi_handle handle,
160 unsigned long long *bus)
167 acpi_walk_resources(handle, METHOD_NAME__CRS,
168 get_root_bridge_busnr_callback, &busnum);
169 if (ACPI_FAILURE(status))
171 /* Check if we really get a bus number from _CRS */
178 static void acpi_pci_bridge_scan(struct acpi_device *device)
181 struct acpi_device *child = NULL;
183 if (device->flags.bus_address)
184 if (device->parent && device->parent->ops.bind) {
185 status = device->parent->ops.bind(device);
187 list_for_each_entry(child, &device->children, node)
188 acpi_pci_bridge_scan(child);
193 static u8 OSC_UUID[16] = {0x5B, 0x4D, 0xDB, 0x33, 0xF7, 0x1F, 0x1C, 0x40,
194 0x96, 0x57, 0x74, 0x41, 0xC0, 0x3D, 0xD7, 0x66};
196 static acpi_status acpi_pci_run_osc(acpi_handle handle,
197 const u32 *capbuf, u32 *retval)
200 struct acpi_object_list input;
201 union acpi_object in_params[4];
202 struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
203 union acpi_object *out_obj;
206 /* Setting up input parameters */
208 input.pointer = in_params;
209 in_params[0].type = ACPI_TYPE_BUFFER;
210 in_params[0].buffer.length = 16;
211 in_params[0].buffer.pointer = OSC_UUID;
212 in_params[1].type = ACPI_TYPE_INTEGER;
213 in_params[1].integer.value = 1;
214 in_params[2].type = ACPI_TYPE_INTEGER;
215 in_params[2].integer.value = 3;
216 in_params[3].type = ACPI_TYPE_BUFFER;
217 in_params[3].buffer.length = 12;
218 in_params[3].buffer.pointer = (u8 *)capbuf;
220 status = acpi_evaluate_object(handle, "_OSC", &input, &output);
221 if (ACPI_FAILURE(status))
225 return AE_NULL_OBJECT;
227 out_obj = output.pointer;
228 if (out_obj->type != ACPI_TYPE_BUFFER) {
229 printk(KERN_DEBUG "_OSC evaluation returned wrong type\n");
233 /* Need to ignore the bit0 in result code */
234 errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
236 if (errors & OSC_REQUEST_ERROR)
237 printk(KERN_DEBUG "_OSC request failed\n");
238 if (errors & OSC_INVALID_UUID_ERROR)
239 printk(KERN_DEBUG "_OSC invalid UUID\n");
240 if (errors & OSC_INVALID_REVISION_ERROR)
241 printk(KERN_DEBUG "_OSC invalid revision\n");
242 if (errors & OSC_CAPABILITIES_MASK_ERROR) {
243 if (capbuf[OSC_QUERY_TYPE] & OSC_QUERY_ENABLE)
246 "Firmware did not grant requested _OSC control\n");
254 *retval = *((u32 *)(out_obj->buffer.pointer + 8));
258 kfree(output.pointer);
262 static acpi_status acpi_pci_query_osc(struct acpi_pci_root *root, u32 flags)
265 u32 support_set, result, capbuf[3];
267 /* do _OSC query for all possible controls */
268 support_set = root->osc_support_set | (flags & OSC_SUPPORT_MASKS);
269 capbuf[OSC_QUERY_TYPE] = OSC_QUERY_ENABLE;
270 capbuf[OSC_SUPPORT_TYPE] = support_set;
271 capbuf[OSC_CONTROL_TYPE] = OSC_CONTROL_MASKS;
273 status = acpi_pci_run_osc(root->device->handle, capbuf, &result);
274 if (ACPI_SUCCESS(status)) {
275 root->osc_support_set = support_set;
276 root->osc_control_qry = result;
277 root->osc_queried = 1;
282 static acpi_status acpi_pci_osc_support(struct acpi_pci_root *root, u32 flags)
287 status = acpi_get_handle(root->device->handle, "_OSC", &tmp);
288 if (ACPI_FAILURE(status))
290 mutex_lock(&osc_lock);
291 status = acpi_pci_query_osc(root, flags);
292 mutex_unlock(&osc_lock);
296 static struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle)
298 struct acpi_pci_root *root;
300 list_for_each_entry(root, &acpi_pci_roots, node) {
301 if (root->device->handle == handle)
308 * acpi_pci_osc_control_set - commit requested control to Firmware
309 * @handle: acpi_handle for the target ACPI object
310 * @flags: driver's requested control bits
312 * Attempt to take control from Firmware on requested control bits.
314 acpi_status acpi_pci_osc_control_set(acpi_handle handle, u32 flags)
317 u32 control_req, result, capbuf[3];
319 struct acpi_pci_root *root;
321 status = acpi_get_handle(handle, "_OSC", &tmp);
322 if (ACPI_FAILURE(status))
325 control_req = (flags & OSC_CONTROL_MASKS);
329 root = acpi_pci_find_root(handle);
333 mutex_lock(&osc_lock);
334 /* No need to evaluate _OSC if the control was already granted. */
335 if ((root->osc_control_set & control_req) == control_req)
338 /* Need to query controls first before requesting them */
339 if (!root->osc_queried) {
340 status = acpi_pci_query_osc(root, root->osc_support_set);
341 if (ACPI_FAILURE(status))
344 if ((root->osc_control_qry & control_req) != control_req) {
346 "Firmware did not grant requested _OSC control\n");
351 capbuf[OSC_QUERY_TYPE] = 0;
352 capbuf[OSC_SUPPORT_TYPE] = root->osc_support_set;
353 capbuf[OSC_CONTROL_TYPE] = root->osc_control_set | control_req;
354 status = acpi_pci_run_osc(handle, capbuf, &result);
355 if (ACPI_SUCCESS(status))
356 root->osc_control_set = result;
358 mutex_unlock(&osc_lock);
361 EXPORT_SYMBOL(acpi_pci_osc_control_set);
363 static int __devinit acpi_pci_root_add(struct acpi_device *device)
365 unsigned long long segment, bus;
368 struct acpi_pci_root *root;
370 struct acpi_device *child;
371 u32 flags, base_flags;
374 status = acpi_evaluate_integer(device->handle, METHOD_NAME__SEG, NULL,
376 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
377 printk(KERN_ERR PREFIX "can't evaluate _SEG\n");
381 /* Check _CRS first, then _BBN. If no _BBN, default to zero. */
383 status = try_get_root_bridge_busnr(device->handle, &bus);
384 if (ACPI_FAILURE(status)) {
385 status = acpi_evaluate_integer(device->handle, METHOD_NAME__BBN, NULL, &bus);
386 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
387 printk(KERN_ERR PREFIX
388 "no bus number in _CRS and can't evaluate _BBN\n");
393 root = kzalloc(sizeof(struct acpi_pci_root), GFP_KERNEL);
397 INIT_LIST_HEAD(&root->node);
398 root->device = device;
399 root->segment = segment & 0xFFFF;
400 root->bus_nr = bus & 0xFF;
401 strcpy(acpi_device_name(device), ACPI_PCI_ROOT_DEVICE_NAME);
402 strcpy(acpi_device_class(device), ACPI_PCI_ROOT_CLASS);
403 device->driver_data = root;
405 device->ops.bind = acpi_pci_bind;
408 * All supported architectures that use ACPI have support for
409 * PCI domains, so we indicate this in _OSC support capabilities.
411 flags = base_flags = OSC_PCI_SEGMENT_GROUPS_SUPPORT;
412 acpi_pci_osc_support(root, flags);
415 * TBD: Need PCI interface for enumeration/configuration of roots.
419 list_add_tail(&root->node, &acpi_pci_roots);
421 printk(KERN_INFO PREFIX "%s [%s] (%04x:%02x)\n",
422 acpi_device_name(device), acpi_device_bid(device),
423 root->segment, root->bus_nr);
426 * Scan the Root Bridge
427 * --------------------
428 * Must do this prior to any attempt to bind the root device, as the
429 * PCI namespace does not get created until this call is made (and
430 * thus the root bridge's pci_dev does not exist).
432 root->bus = pci_acpi_scan_root(device, segment, bus);
434 printk(KERN_ERR PREFIX
435 "Bus %04x:%02x not present in PCI namespace\n",
436 root->segment, root->bus_nr);
442 * Attach ACPI-PCI Context
443 * -----------------------
444 * Thus binding the ACPI and PCI devices.
446 result = acpi_pci_bind_root(device, &root->id, root->bus);
453 * Evaluate and parse _PRT, if exists.
455 status = acpi_get_handle(device->handle, METHOD_NAME__PRT, &handle);
456 if (ACPI_SUCCESS(status))
457 result = acpi_pci_irq_add_prt(device->handle, root->id.segment,
461 * Scan and bind all _ADR-Based Devices
463 list_for_each_entry(child, &device->children, node)
464 acpi_pci_bridge_scan(child);
466 /* Indicate support for various _OSC capabilities. */
467 if (pci_ext_cfg_avail(root->bus->self))
468 flags |= OSC_EXT_PCI_CONFIG_SUPPORT;
469 if (pcie_aspm_enabled())
470 flags |= OSC_ACTIVE_STATE_PWR_SUPPORT |
471 OSC_CLOCK_PWR_CAPABILITY_SUPPORT;
472 if (pci_msi_enabled())
473 flags |= OSC_MSI_SUPPORT;
474 if (flags != base_flags)
475 acpi_pci_osc_support(root, flags);
480 if (!list_empty(&root->node))
481 list_del(&root->node);
486 static int acpi_pci_root_start(struct acpi_device *device)
488 struct acpi_pci_root *root = acpi_driver_data(device);
490 pci_bus_add_devices(root->bus);
494 static int acpi_pci_root_remove(struct acpi_device *device, int type)
496 struct acpi_pci_root *root = acpi_driver_data(device);
502 static int __init acpi_pci_root_init(void)
504 if (acpi_pci_disabled)
507 if (acpi_bus_register_driver(&acpi_pci_root_driver) < 0)
513 subsys_initcall(acpi_pci_root_init);