2 * pci_root.c - ACPI PCI Root Bridge Driver ($Revision: 40 $)
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/mutex.h>
32 #include <linux/pm_runtime.h>
33 #include <linux/pci.h>
34 #include <linux/pci-acpi.h>
35 #include <linux/pci-aspm.h>
36 #include <linux/acpi.h>
37 #include <linux/slab.h>
38 #include <acpi/acpi_bus.h>
39 #include <acpi/acpi_drivers.h>
40 #include <acpi/apei.h>
44 #define PREFIX "ACPI: "
46 #define _COMPONENT ACPI_PCI_COMPONENT
47 ACPI_MODULE_NAME("pci_root");
48 #define ACPI_PCI_ROOT_CLASS "pci_bridge"
49 #define ACPI_PCI_ROOT_DEVICE_NAME "PCI Root Bridge"
50 static int acpi_pci_root_add(struct acpi_device *device,
51 const struct acpi_device_id *not_used);
52 static void acpi_pci_root_remove(struct acpi_device *device);
54 #define ACPI_PCIE_REQ_SUPPORT (OSC_PCI_EXT_CONFIG_SUPPORT \
55 | OSC_PCI_ASPM_SUPPORT \
56 | OSC_PCI_CLOCK_PM_SUPPORT \
57 | OSC_PCI_MSI_SUPPORT)
59 static const struct acpi_device_id root_device_ids[] = {
64 static struct acpi_scan_handler pci_root_handler = {
65 .ids = root_device_ids,
66 .attach = acpi_pci_root_add,
67 .detach = acpi_pci_root_remove,
70 static DEFINE_MUTEX(osc_lock);
73 * acpi_is_root_bridge - determine whether an ACPI CA node is a PCI root bridge
74 * @handle - the ACPI CA node in question.
76 * Note: we could make this API take a struct acpi_device * instead, but
77 * for now, it's more convenient to operate on an acpi_handle.
79 int acpi_is_root_bridge(acpi_handle handle)
82 struct acpi_device *device;
84 ret = acpi_bus_get_device(handle, &device);
88 ret = acpi_match_device_ids(device, root_device_ids);
94 EXPORT_SYMBOL_GPL(acpi_is_root_bridge);
97 get_root_bridge_busnr_callback(struct acpi_resource *resource, void *data)
99 struct resource *res = data;
100 struct acpi_resource_address64 address;
103 status = acpi_resource_to_address64(resource, &address);
104 if (ACPI_FAILURE(status))
107 if ((address.address_length > 0) &&
108 (address.resource_type == ACPI_BUS_NUMBER_RANGE)) {
109 res->start = address.minimum;
110 res->end = address.minimum + address.address_length - 1;
116 static acpi_status try_get_root_bridge_busnr(acpi_handle handle,
117 struct resource *res)
123 acpi_walk_resources(handle, METHOD_NAME__CRS,
124 get_root_bridge_busnr_callback, res);
125 if (ACPI_FAILURE(status))
127 if (res->start == -1)
132 struct pci_osc_bit_struct {
137 static struct pci_osc_bit_struct pci_osc_support_bit[] = {
138 { OSC_PCI_EXT_CONFIG_SUPPORT, "ExtendedConfig" },
139 { OSC_PCI_ASPM_SUPPORT, "ASPM" },
140 { OSC_PCI_CLOCK_PM_SUPPORT, "ClockPM" },
141 { OSC_PCI_SEGMENT_GROUPS_SUPPORT, "Segments" },
142 { OSC_PCI_MSI_SUPPORT, "MSI" },
145 static struct pci_osc_bit_struct pci_osc_control_bit[] = {
146 { OSC_PCI_EXPRESS_NATIVE_HP_CONTROL, "PCIeHotplug" },
147 { OSC_PCI_SHPC_NATIVE_HP_CONTROL, "SHPCHotplug" },
148 { OSC_PCI_EXPRESS_PME_CONTROL, "PME" },
149 { OSC_PCI_EXPRESS_AER_CONTROL, "AER" },
150 { OSC_PCI_EXPRESS_CAPABILITY_CONTROL, "PCIeCapability" },
153 static void decode_osc_bits(struct acpi_pci_root *root, char *msg, u32 word,
154 struct pci_osc_bit_struct *table, int size)
158 struct pci_osc_bit_struct *entry;
161 for (i = 0, entry = table; i < size; i++, entry++)
162 if (word & entry->bit)
163 len += snprintf(buf + len, sizeof(buf) - len, "%s%s",
164 len ? " " : "", entry->desc);
166 dev_info(&root->device->dev, "_OSC: %s [%s]\n", msg, buf);
169 static void decode_osc_support(struct acpi_pci_root *root, char *msg, u32 word)
171 decode_osc_bits(root, msg, word, pci_osc_support_bit,
172 ARRAY_SIZE(pci_osc_support_bit));
175 static void decode_osc_control(struct acpi_pci_root *root, char *msg, u32 word)
177 decode_osc_bits(root, msg, word, pci_osc_control_bit,
178 ARRAY_SIZE(pci_osc_control_bit));
181 static u8 pci_osc_uuid_str[] = "33DB4D5B-1FF7-401C-9657-7441C03DD766";
183 static acpi_status acpi_pci_run_osc(acpi_handle handle,
184 const u32 *capbuf, u32 *retval)
186 struct acpi_osc_context context = {
187 .uuid_str = pci_osc_uuid_str,
190 .cap.pointer = (void *)capbuf,
194 status = acpi_run_osc(handle, &context);
195 if (ACPI_SUCCESS(status)) {
196 *retval = *((u32 *)(context.ret.pointer + 8));
197 kfree(context.ret.pointer);
202 static acpi_status acpi_pci_query_osc(struct acpi_pci_root *root,
207 u32 result, capbuf[3];
209 support &= OSC_PCI_SUPPORT_MASKS;
210 support |= root->osc_support_set;
212 capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
213 capbuf[OSC_SUPPORT_DWORD] = support;
215 *control &= OSC_PCI_CONTROL_MASKS;
216 capbuf[OSC_CONTROL_DWORD] = *control | root->osc_control_set;
218 /* Run _OSC query only with existing controls. */
219 capbuf[OSC_CONTROL_DWORD] = root->osc_control_set;
222 status = acpi_pci_run_osc(root->device->handle, capbuf, &result);
223 if (ACPI_SUCCESS(status)) {
224 root->osc_support_set = support;
231 static acpi_status acpi_pci_osc_support(struct acpi_pci_root *root, u32 flags)
235 mutex_lock(&osc_lock);
236 status = acpi_pci_query_osc(root, flags, NULL);
237 mutex_unlock(&osc_lock);
241 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle)
243 struct acpi_pci_root *root;
244 struct acpi_device *device;
246 if (acpi_bus_get_device(handle, &device) ||
247 acpi_match_device_ids(device, root_device_ids))
250 root = acpi_driver_data(device);
254 EXPORT_SYMBOL_GPL(acpi_pci_find_root);
256 struct acpi_handle_node {
257 struct list_head node;
262 * acpi_get_pci_dev - convert ACPI CA handle to struct pci_dev
263 * @handle: the handle in question
265 * Given an ACPI CA handle, the desired PCI device is located in the
266 * list of PCI devices.
268 * If the device is found, its reference count is increased and this
269 * function returns a pointer to its data structure. The caller must
270 * decrement the reference count by calling pci_dev_put().
271 * If no device is found, %NULL is returned.
273 struct pci_dev *acpi_get_pci_dev(acpi_handle handle)
276 unsigned long long adr;
279 struct pci_bus *pbus;
280 struct pci_dev *pdev = NULL;
281 struct acpi_handle_node *node, *tmp;
282 struct acpi_pci_root *root;
283 LIST_HEAD(device_list);
286 * Walk up the ACPI CA namespace until we reach a PCI root bridge.
289 while (!acpi_is_root_bridge(phandle)) {
290 node = kzalloc(sizeof(struct acpi_handle_node), GFP_KERNEL);
294 INIT_LIST_HEAD(&node->node);
295 node->handle = phandle;
296 list_add(&node->node, &device_list);
298 status = acpi_get_parent(phandle, &phandle);
299 if (ACPI_FAILURE(status))
303 root = acpi_pci_find_root(phandle);
310 * Now, walk back down the PCI device tree until we return to our
311 * original handle. Assumes that everything between the PCI root
312 * bridge and the device we're looking for must be a P2P bridge.
314 list_for_each_entry(node, &device_list, node) {
315 acpi_handle hnd = node->handle;
316 status = acpi_evaluate_integer(hnd, "_ADR", NULL, &adr);
317 if (ACPI_FAILURE(status))
319 dev = (adr >> 16) & 0xffff;
322 pdev = pci_get_slot(pbus, PCI_DEVFN(dev, fn));
323 if (!pdev || hnd == handle)
326 pbus = pdev->subordinate;
330 * This function may be called for a non-PCI device that has a
331 * PCI parent (eg. a disk under a PCI SATA controller). In that
332 * case pdev->subordinate will be NULL for the parent.
335 dev_dbg(&pdev->dev, "Not a PCI-to-PCI bridge\n");
341 list_for_each_entry_safe(node, tmp, &device_list, node)
346 EXPORT_SYMBOL_GPL(acpi_get_pci_dev);
349 * acpi_pci_osc_control_set - Request control of PCI root _OSC features.
350 * @handle: ACPI handle of a PCI root bridge (or PCIe Root Complex).
351 * @mask: Mask of _OSC bits to request control of, place to store control mask.
352 * @req: Mask of _OSC bits the control of is essential to the caller.
354 * Run _OSC query for @mask and if that is successful, compare the returned
355 * mask of control bits with @req. If all of the @req bits are set in the
356 * returned mask, run _OSC request for it.
358 * The variable at the @mask address may be modified regardless of whether or
359 * not the function returns success. On success it will contain the mask of
360 * _OSC bits the BIOS has granted control of, but its contents are meaningless
363 acpi_status acpi_pci_osc_control_set(acpi_handle handle, u32 *mask, u32 req)
365 struct acpi_pci_root *root;
366 acpi_status status = AE_OK;
370 return AE_BAD_PARAMETER;
372 ctrl = *mask & OSC_PCI_CONTROL_MASKS;
373 if ((ctrl & req) != req)
376 root = acpi_pci_find_root(handle);
380 mutex_lock(&osc_lock);
382 *mask = ctrl | root->osc_control_set;
383 /* No need to evaluate _OSC if the control was already granted. */
384 if ((root->osc_control_set & ctrl) == ctrl)
387 /* Need to check the available controls bits before requesting them. */
389 status = acpi_pci_query_osc(root, root->osc_support_set, mask);
390 if (ACPI_FAILURE(status))
394 decode_osc_control(root, "platform does not support",
399 if ((ctrl & req) != req) {
400 decode_osc_control(root, "not requesting control; platform does not support",
406 capbuf[OSC_QUERY_DWORD] = 0;
407 capbuf[OSC_SUPPORT_DWORD] = root->osc_support_set;
408 capbuf[OSC_CONTROL_DWORD] = ctrl;
409 status = acpi_pci_run_osc(handle, capbuf, mask);
410 if (ACPI_SUCCESS(status))
411 root->osc_control_set = *mask;
413 mutex_unlock(&osc_lock);
416 EXPORT_SYMBOL(acpi_pci_osc_control_set);
418 static void negotiate_os_control(struct acpi_pci_root *root, int *no_aspm,
421 u32 support, control, requested;
423 struct acpi_device *device = root->device;
424 acpi_handle handle = device->handle;
427 * All supported architectures that use ACPI have support for
428 * PCI domains, so we indicate this in _OSC support capabilities.
430 support = OSC_PCI_SEGMENT_GROUPS_SUPPORT;
431 if (pci_ext_cfg_avail())
432 support |= OSC_PCI_EXT_CONFIG_SUPPORT;
433 if (pcie_aspm_support_enabled())
434 support |= OSC_PCI_ASPM_SUPPORT | OSC_PCI_CLOCK_PM_SUPPORT;
435 if (pci_msi_enabled())
436 support |= OSC_PCI_MSI_SUPPORT;
438 decode_osc_support(root, "OS supports", support);
439 status = acpi_pci_osc_support(root, support);
440 if (ACPI_FAILURE(status)) {
441 dev_info(&device->dev, "_OSC failed (%s); disabling ASPM\n",
442 acpi_format_exception(status));
447 if (pcie_ports_disabled) {
448 dev_info(&device->dev, "PCIe port services disabled; not requesting _OSC control\n");
452 if ((support & ACPI_PCIE_REQ_SUPPORT) != ACPI_PCIE_REQ_SUPPORT) {
453 decode_osc_support(root, "not requesting OS control; OS requires",
454 ACPI_PCIE_REQ_SUPPORT);
458 control = OSC_PCI_EXPRESS_CAPABILITY_CONTROL
459 | OSC_PCI_EXPRESS_NATIVE_HP_CONTROL
460 | OSC_PCI_EXPRESS_PME_CONTROL;
462 if (pci_aer_available()) {
463 if (aer_acpi_firmware_first())
464 dev_info(&device->dev,
465 "PCIe AER handled by firmware\n");
467 control |= OSC_PCI_EXPRESS_AER_CONTROL;
471 status = acpi_pci_osc_control_set(handle, &control,
472 OSC_PCI_EXPRESS_CAPABILITY_CONTROL);
473 if (ACPI_SUCCESS(status)) {
474 decode_osc_control(root, "OS now controls", control);
475 if (acpi_gbl_FADT.boot_flags & ACPI_FADT_NO_ASPM) {
477 * We have ASPM control, but the FADT indicates
478 * that it's unsupported. Clear it.
483 decode_osc_control(root, "OS requested", requested);
484 decode_osc_control(root, "platform willing to grant", control);
485 dev_info(&device->dev, "_OSC failed (%s); disabling ASPM\n",
486 acpi_format_exception(status));
489 * We want to disable ASPM here, but aspm_disabled
490 * needs to remain in its state from boot so that we
491 * properly handle PCIe 1.1 devices. So we set this
492 * flag here, to defer the action until after the ACPI
499 static int acpi_pci_root_add(struct acpi_device *device,
500 const struct acpi_device_id *not_used)
502 unsigned long long segment, bus;
505 struct acpi_pci_root *root;
506 acpi_handle handle = device->handle;
507 int no_aspm = 0, clear_aspm = 0;
509 root = kzalloc(sizeof(struct acpi_pci_root), GFP_KERNEL);
514 status = acpi_evaluate_integer(handle, METHOD_NAME__SEG, NULL,
516 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
517 dev_err(&device->dev, "can't evaluate _SEG\n");
522 /* Check _CRS first, then _BBN. If no _BBN, default to zero. */
523 root->secondary.flags = IORESOURCE_BUS;
524 status = try_get_root_bridge_busnr(handle, &root->secondary);
525 if (ACPI_FAILURE(status)) {
527 * We need both the start and end of the downstream bus range
528 * to interpret _CBA (MMCONFIG base address), so it really is
529 * supposed to be in _CRS. If we don't find it there, all we
530 * can do is assume [_BBN-0xFF] or [0-0xFF].
532 root->secondary.end = 0xFF;
533 dev_warn(&device->dev,
534 FW_BUG "no secondary bus range in _CRS\n");
535 status = acpi_evaluate_integer(handle, METHOD_NAME__BBN,
537 if (ACPI_SUCCESS(status))
538 root->secondary.start = bus;
539 else if (status == AE_NOT_FOUND)
540 root->secondary.start = 0;
542 dev_err(&device->dev, "can't evaluate _BBN\n");
548 root->device = device;
549 root->segment = segment & 0xFFFF;
550 strcpy(acpi_device_name(device), ACPI_PCI_ROOT_DEVICE_NAME);
551 strcpy(acpi_device_class(device), ACPI_PCI_ROOT_CLASS);
552 device->driver_data = root;
554 pr_info(PREFIX "%s [%s] (domain %04x %pR)\n",
555 acpi_device_name(device), acpi_device_bid(device),
556 root->segment, &root->secondary);
558 root->mcfg_addr = acpi_pci_root_get_mcfg_addr(handle);
560 negotiate_os_control(root, &no_aspm, &clear_aspm);
563 * TBD: Need PCI interface for enumeration/configuration of roots.
567 * Scan the Root Bridge
568 * --------------------
569 * Must do this prior to any attempt to bind the root device, as the
570 * PCI namespace does not get created until this call is made (and
571 * thus the root bridge's pci_dev does not exist).
573 root->bus = pci_acpi_scan_root(root);
575 dev_err(&device->dev,
576 "Bus %04x:%02x not present in PCI namespace\n",
577 root->segment, (unsigned int)root->secondary.start);
578 device->driver_data = NULL;
584 dev_info(&device->dev, "Disabling ASPM (FADT indicates it is unsupported)\n");
585 pcie_clear_aspm(root->bus);
590 pci_acpi_add_bus_pm_notifier(device, root->bus);
591 if (device->wakeup.flags.run_wake)
592 device_set_run_wake(root->bus->bridge, true);
594 if (system_state != SYSTEM_BOOTING) {
595 pcibios_resource_survey_bus(root->bus);
596 pci_assign_unassigned_root_bus_resources(root->bus);
599 pci_bus_add_devices(root->bus);
607 static void acpi_pci_root_remove(struct acpi_device *device)
609 struct acpi_pci_root *root = acpi_driver_data(device);
611 pci_stop_root_bus(root->bus);
613 device_set_run_wake(root->bus->bridge, false);
614 pci_acpi_remove_bus_pm_notifier(device);
616 pci_remove_root_bus(root->bus);
621 void __init acpi_pci_root_init(void)
625 if (!acpi_pci_disabled) {
626 pci_acpi_crs_quirks();
627 acpi_scan_add_handler(&pci_root_handler);
630 /* Support root bridge hotplug */
632 static void handle_root_bridge_insertion(acpi_handle handle)
634 struct acpi_device *device;
636 if (!acpi_bus_get_device(handle, &device)) {
637 dev_printk(KERN_DEBUG, &device->dev,
638 "acpi device already exists; ignoring notify\n");
642 if (acpi_bus_scan(handle))
643 acpi_handle_err(handle, "cannot add bridge to acpi list\n");
646 static void hotplug_event_root(void *data, u32 type)
648 acpi_handle handle = data;
649 struct acpi_pci_root *root;
651 acpi_scan_lock_acquire();
653 root = acpi_pci_find_root(handle);
656 case ACPI_NOTIFY_BUS_CHECK:
658 acpi_handle_printk(KERN_DEBUG, handle,
659 "Bus check notify on %s\n", __func__);
661 acpiphp_check_host_bridge(handle);
663 handle_root_bridge_insertion(handle);
667 case ACPI_NOTIFY_DEVICE_CHECK:
669 acpi_handle_printk(KERN_DEBUG, handle,
670 "Device check notify on %s\n", __func__);
672 handle_root_bridge_insertion(handle);
675 case ACPI_NOTIFY_EJECT_REQUEST:
676 /* request device eject */
677 acpi_handle_printk(KERN_DEBUG, handle,
678 "Device eject notify on %s\n", __func__);
682 get_device(&root->device->dev);
684 acpi_scan_lock_release();
686 acpi_bus_device_eject(root->device, ACPI_NOTIFY_EJECT_REQUEST);
689 acpi_handle_warn(handle,
690 "notify_handler: unknown event type 0x%x\n",
695 acpi_scan_lock_release();
698 static void handle_hotplug_event_root(acpi_handle handle, u32 type,
701 acpi_hotplug_execute(hotplug_event_root, handle, type);
704 static acpi_status __init
705 find_root_bridges(acpi_handle handle, u32 lvl, void *context, void **rv)
708 int *count = (int *)context;
710 if (!acpi_is_root_bridge(handle))
715 status = acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
716 handle_hotplug_event_root, NULL);
717 if (ACPI_FAILURE(status))
718 acpi_handle_printk(KERN_DEBUG, handle,
719 "notify handler is not installed, exit status: %u\n",
720 (unsigned int)status);
722 acpi_handle_printk(KERN_DEBUG, handle,
723 "notify handler is installed\n");
728 void __init acpi_pci_root_hp_init(void)
732 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
733 ACPI_UINT32_MAX, find_root_bridges, NULL, &num, NULL);
735 printk(KERN_DEBUG "Found %d acpi root devices\n", num);