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/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/apei.h> /* for acpi_hest_init() */
42 #define _COMPONENT ACPI_PCI_COMPONENT
43 ACPI_MODULE_NAME("pci_root");
44 #define ACPI_PCI_ROOT_CLASS "pci_bridge"
45 #define ACPI_PCI_ROOT_DEVICE_NAME "PCI Root Bridge"
46 static int acpi_pci_root_add(struct acpi_device
*device
,
47 const struct acpi_device_id
*not_used
);
48 static void acpi_pci_root_remove(struct acpi_device
*device
);
50 static int acpi_pci_root_scan_dependent(struct acpi_device
*adev
)
52 acpiphp_check_host_bridge(adev
);
56 #define ACPI_PCIE_REQ_SUPPORT (OSC_PCI_EXT_CONFIG_SUPPORT \
57 | OSC_PCI_ASPM_SUPPORT \
58 | OSC_PCI_CLOCK_PM_SUPPORT \
59 | OSC_PCI_MSI_SUPPORT)
61 static const struct acpi_device_id root_device_ids
[] = {
66 static struct acpi_scan_handler pci_root_handler
= {
67 .ids
= root_device_ids
,
68 .attach
= acpi_pci_root_add
,
69 .detach
= acpi_pci_root_remove
,
72 .scan_dependent
= acpi_pci_root_scan_dependent
,
76 static DEFINE_MUTEX(osc_lock
);
79 * acpi_is_root_bridge - determine whether an ACPI CA node is a PCI root bridge
80 * @handle - the ACPI CA node in question.
82 * Note: we could make this API take a struct acpi_device * instead, but
83 * for now, it's more convenient to operate on an acpi_handle.
85 int acpi_is_root_bridge(acpi_handle handle
)
88 struct acpi_device
*device
;
90 ret
= acpi_bus_get_device(handle
, &device
);
94 ret
= acpi_match_device_ids(device
, root_device_ids
);
100 EXPORT_SYMBOL_GPL(acpi_is_root_bridge
);
103 get_root_bridge_busnr_callback(struct acpi_resource
*resource
, void *data
)
105 struct resource
*res
= data
;
106 struct acpi_resource_address64 address
;
109 status
= acpi_resource_to_address64(resource
, &address
);
110 if (ACPI_FAILURE(status
))
113 if ((address
.address_length
> 0) &&
114 (address
.resource_type
== ACPI_BUS_NUMBER_RANGE
)) {
115 res
->start
= address
.minimum
;
116 res
->end
= address
.minimum
+ address
.address_length
- 1;
122 static acpi_status
try_get_root_bridge_busnr(acpi_handle handle
,
123 struct resource
*res
)
129 acpi_walk_resources(handle
, METHOD_NAME__CRS
,
130 get_root_bridge_busnr_callback
, res
);
131 if (ACPI_FAILURE(status
))
133 if (res
->start
== -1)
138 struct pci_osc_bit_struct
{
143 static struct pci_osc_bit_struct pci_osc_support_bit
[] = {
144 { OSC_PCI_EXT_CONFIG_SUPPORT
, "ExtendedConfig" },
145 { OSC_PCI_ASPM_SUPPORT
, "ASPM" },
146 { OSC_PCI_CLOCK_PM_SUPPORT
, "ClockPM" },
147 { OSC_PCI_SEGMENT_GROUPS_SUPPORT
, "Segments" },
148 { OSC_PCI_MSI_SUPPORT
, "MSI" },
151 static struct pci_osc_bit_struct pci_osc_control_bit
[] = {
152 { OSC_PCI_EXPRESS_NATIVE_HP_CONTROL
, "PCIeHotplug" },
153 { OSC_PCI_SHPC_NATIVE_HP_CONTROL
, "SHPCHotplug" },
154 { OSC_PCI_EXPRESS_PME_CONTROL
, "PME" },
155 { OSC_PCI_EXPRESS_AER_CONTROL
, "AER" },
156 { OSC_PCI_EXPRESS_CAPABILITY_CONTROL
, "PCIeCapability" },
159 static void decode_osc_bits(struct acpi_pci_root
*root
, char *msg
, u32 word
,
160 struct pci_osc_bit_struct
*table
, int size
)
164 struct pci_osc_bit_struct
*entry
;
167 for (i
= 0, entry
= table
; i
< size
; i
++, entry
++)
168 if (word
& entry
->bit
)
169 len
+= snprintf(buf
+ len
, sizeof(buf
) - len
, "%s%s",
170 len
? " " : "", entry
->desc
);
172 dev_info(&root
->device
->dev
, "_OSC: %s [%s]\n", msg
, buf
);
175 static void decode_osc_support(struct acpi_pci_root
*root
, char *msg
, u32 word
)
177 decode_osc_bits(root
, msg
, word
, pci_osc_support_bit
,
178 ARRAY_SIZE(pci_osc_support_bit
));
181 static void decode_osc_control(struct acpi_pci_root
*root
, char *msg
, u32 word
)
183 decode_osc_bits(root
, msg
, word
, pci_osc_control_bit
,
184 ARRAY_SIZE(pci_osc_control_bit
));
187 static u8 pci_osc_uuid_str
[] = "33DB4D5B-1FF7-401C-9657-7441C03DD766";
189 static acpi_status
acpi_pci_run_osc(acpi_handle handle
,
190 const u32
*capbuf
, u32
*retval
)
192 struct acpi_osc_context context
= {
193 .uuid_str
= pci_osc_uuid_str
,
196 .cap
.pointer
= (void *)capbuf
,
200 status
= acpi_run_osc(handle
, &context
);
201 if (ACPI_SUCCESS(status
)) {
202 *retval
= *((u32
*)(context
.ret
.pointer
+ 8));
203 kfree(context
.ret
.pointer
);
208 static acpi_status
acpi_pci_query_osc(struct acpi_pci_root
*root
,
213 u32 result
, capbuf
[3];
215 support
&= OSC_PCI_SUPPORT_MASKS
;
216 support
|= root
->osc_support_set
;
218 capbuf
[OSC_QUERY_DWORD
] = OSC_QUERY_ENABLE
;
219 capbuf
[OSC_SUPPORT_DWORD
] = support
;
221 *control
&= OSC_PCI_CONTROL_MASKS
;
222 capbuf
[OSC_CONTROL_DWORD
] = *control
| root
->osc_control_set
;
224 /* Run _OSC query only with existing controls. */
225 capbuf
[OSC_CONTROL_DWORD
] = root
->osc_control_set
;
228 status
= acpi_pci_run_osc(root
->device
->handle
, capbuf
, &result
);
229 if (ACPI_SUCCESS(status
)) {
230 root
->osc_support_set
= support
;
237 static acpi_status
acpi_pci_osc_support(struct acpi_pci_root
*root
, u32 flags
)
241 mutex_lock(&osc_lock
);
242 status
= acpi_pci_query_osc(root
, flags
, NULL
);
243 mutex_unlock(&osc_lock
);
247 struct acpi_pci_root
*acpi_pci_find_root(acpi_handle handle
)
249 struct acpi_pci_root
*root
;
250 struct acpi_device
*device
;
252 if (acpi_bus_get_device(handle
, &device
) ||
253 acpi_match_device_ids(device
, root_device_ids
))
256 root
= acpi_driver_data(device
);
260 EXPORT_SYMBOL_GPL(acpi_pci_find_root
);
262 struct acpi_handle_node
{
263 struct list_head node
;
268 * acpi_get_pci_dev - convert ACPI CA handle to struct pci_dev
269 * @handle: the handle in question
271 * Given an ACPI CA handle, the desired PCI device is located in the
272 * list of PCI devices.
274 * If the device is found, its reference count is increased and this
275 * function returns a pointer to its data structure. The caller must
276 * decrement the reference count by calling pci_dev_put().
277 * If no device is found, %NULL is returned.
279 struct pci_dev
*acpi_get_pci_dev(acpi_handle handle
)
282 unsigned long long adr
;
285 struct pci_bus
*pbus
;
286 struct pci_dev
*pdev
= NULL
;
287 struct acpi_handle_node
*node
, *tmp
;
288 struct acpi_pci_root
*root
;
289 LIST_HEAD(device_list
);
292 * Walk up the ACPI CA namespace until we reach a PCI root bridge.
295 while (!acpi_is_root_bridge(phandle
)) {
296 node
= kzalloc(sizeof(struct acpi_handle_node
), GFP_KERNEL
);
300 INIT_LIST_HEAD(&node
->node
);
301 node
->handle
= phandle
;
302 list_add(&node
->node
, &device_list
);
304 status
= acpi_get_parent(phandle
, &phandle
);
305 if (ACPI_FAILURE(status
))
309 root
= acpi_pci_find_root(phandle
);
316 * Now, walk back down the PCI device tree until we return to our
317 * original handle. Assumes that everything between the PCI root
318 * bridge and the device we're looking for must be a P2P bridge.
320 list_for_each_entry(node
, &device_list
, node
) {
321 acpi_handle hnd
= node
->handle
;
322 status
= acpi_evaluate_integer(hnd
, "_ADR", NULL
, &adr
);
323 if (ACPI_FAILURE(status
))
325 dev
= (adr
>> 16) & 0xffff;
328 pdev
= pci_get_slot(pbus
, PCI_DEVFN(dev
, fn
));
329 if (!pdev
|| hnd
== handle
)
332 pbus
= pdev
->subordinate
;
336 * This function may be called for a non-PCI device that has a
337 * PCI parent (eg. a disk under a PCI SATA controller). In that
338 * case pdev->subordinate will be NULL for the parent.
341 dev_dbg(&pdev
->dev
, "Not a PCI-to-PCI bridge\n");
347 list_for_each_entry_safe(node
, tmp
, &device_list
, node
)
352 EXPORT_SYMBOL_GPL(acpi_get_pci_dev
);
355 * acpi_pci_osc_control_set - Request control of PCI root _OSC features.
356 * @handle: ACPI handle of a PCI root bridge (or PCIe Root Complex).
357 * @mask: Mask of _OSC bits to request control of, place to store control mask.
358 * @req: Mask of _OSC bits the control of is essential to the caller.
360 * Run _OSC query for @mask and if that is successful, compare the returned
361 * mask of control bits with @req. If all of the @req bits are set in the
362 * returned mask, run _OSC request for it.
364 * The variable at the @mask address may be modified regardless of whether or
365 * not the function returns success. On success it will contain the mask of
366 * _OSC bits the BIOS has granted control of, but its contents are meaningless
369 acpi_status
acpi_pci_osc_control_set(acpi_handle handle
, u32
*mask
, u32 req
)
371 struct acpi_pci_root
*root
;
372 acpi_status status
= AE_OK
;
376 return AE_BAD_PARAMETER
;
378 ctrl
= *mask
& OSC_PCI_CONTROL_MASKS
;
379 if ((ctrl
& req
) != req
)
382 root
= acpi_pci_find_root(handle
);
386 mutex_lock(&osc_lock
);
388 *mask
= ctrl
| root
->osc_control_set
;
389 /* No need to evaluate _OSC if the control was already granted. */
390 if ((root
->osc_control_set
& ctrl
) == ctrl
)
393 /* Need to check the available controls bits before requesting them. */
395 status
= acpi_pci_query_osc(root
, root
->osc_support_set
, mask
);
396 if (ACPI_FAILURE(status
))
400 decode_osc_control(root
, "platform does not support",
405 if ((ctrl
& req
) != req
) {
406 decode_osc_control(root
, "not requesting control; platform does not support",
412 capbuf
[OSC_QUERY_DWORD
] = 0;
413 capbuf
[OSC_SUPPORT_DWORD
] = root
->osc_support_set
;
414 capbuf
[OSC_CONTROL_DWORD
] = ctrl
;
415 status
= acpi_pci_run_osc(handle
, capbuf
, mask
);
416 if (ACPI_SUCCESS(status
))
417 root
->osc_control_set
= *mask
;
419 mutex_unlock(&osc_lock
);
422 EXPORT_SYMBOL(acpi_pci_osc_control_set
);
424 static void negotiate_os_control(struct acpi_pci_root
*root
, int *no_aspm
,
427 u32 support
, control
, requested
;
429 struct acpi_device
*device
= root
->device
;
430 acpi_handle handle
= device
->handle
;
433 * All supported architectures that use ACPI have support for
434 * PCI domains, so we indicate this in _OSC support capabilities.
436 support
= OSC_PCI_SEGMENT_GROUPS_SUPPORT
;
437 if (pci_ext_cfg_avail())
438 support
|= OSC_PCI_EXT_CONFIG_SUPPORT
;
439 if (pcie_aspm_support_enabled())
440 support
|= OSC_PCI_ASPM_SUPPORT
| OSC_PCI_CLOCK_PM_SUPPORT
;
441 if (pci_msi_enabled())
442 support
|= OSC_PCI_MSI_SUPPORT
;
444 decode_osc_support(root
, "OS supports", support
);
445 status
= acpi_pci_osc_support(root
, support
);
446 if (ACPI_FAILURE(status
)) {
447 dev_info(&device
->dev
, "_OSC failed (%s); disabling ASPM\n",
448 acpi_format_exception(status
));
453 if (pcie_ports_disabled
) {
454 dev_info(&device
->dev
, "PCIe port services disabled; not requesting _OSC control\n");
458 if ((support
& ACPI_PCIE_REQ_SUPPORT
) != ACPI_PCIE_REQ_SUPPORT
) {
459 decode_osc_support(root
, "not requesting OS control; OS requires",
460 ACPI_PCIE_REQ_SUPPORT
);
464 control
= OSC_PCI_EXPRESS_CAPABILITY_CONTROL
465 | OSC_PCI_EXPRESS_NATIVE_HP_CONTROL
466 | OSC_PCI_EXPRESS_PME_CONTROL
;
468 if (pci_aer_available()) {
469 if (aer_acpi_firmware_first())
470 dev_info(&device
->dev
,
471 "PCIe AER handled by firmware\n");
473 control
|= OSC_PCI_EXPRESS_AER_CONTROL
;
477 status
= acpi_pci_osc_control_set(handle
, &control
,
478 OSC_PCI_EXPRESS_CAPABILITY_CONTROL
);
479 if (ACPI_SUCCESS(status
)) {
480 decode_osc_control(root
, "OS now controls", control
);
481 if (acpi_gbl_FADT
.boot_flags
& ACPI_FADT_NO_ASPM
) {
483 * We have ASPM control, but the FADT indicates
484 * that it's unsupported. Clear it.
489 decode_osc_control(root
, "OS requested", requested
);
490 decode_osc_control(root
, "platform willing to grant", control
);
491 dev_info(&device
->dev
, "_OSC failed (%s); disabling ASPM\n",
492 acpi_format_exception(status
));
495 * We want to disable ASPM here, but aspm_disabled
496 * needs to remain in its state from boot so that we
497 * properly handle PCIe 1.1 devices. So we set this
498 * flag here, to defer the action until after the ACPI
505 static int acpi_pci_root_add(struct acpi_device
*device
,
506 const struct acpi_device_id
*not_used
)
508 unsigned long long segment
, bus
;
511 struct acpi_pci_root
*root
;
512 acpi_handle handle
= device
->handle
;
513 int no_aspm
= 0, clear_aspm
= 0;
515 root
= kzalloc(sizeof(struct acpi_pci_root
), GFP_KERNEL
);
520 status
= acpi_evaluate_integer(handle
, METHOD_NAME__SEG
, NULL
,
522 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
523 dev_err(&device
->dev
, "can't evaluate _SEG\n");
528 /* Check _CRS first, then _BBN. If no _BBN, default to zero. */
529 root
->secondary
.flags
= IORESOURCE_BUS
;
530 status
= try_get_root_bridge_busnr(handle
, &root
->secondary
);
531 if (ACPI_FAILURE(status
)) {
533 * We need both the start and end of the downstream bus range
534 * to interpret _CBA (MMCONFIG base address), so it really is
535 * supposed to be in _CRS. If we don't find it there, all we
536 * can do is assume [_BBN-0xFF] or [0-0xFF].
538 root
->secondary
.end
= 0xFF;
539 dev_warn(&device
->dev
,
540 FW_BUG
"no secondary bus range in _CRS\n");
541 status
= acpi_evaluate_integer(handle
, METHOD_NAME__BBN
,
543 if (ACPI_SUCCESS(status
))
544 root
->secondary
.start
= bus
;
545 else if (status
== AE_NOT_FOUND
)
546 root
->secondary
.start
= 0;
548 dev_err(&device
->dev
, "can't evaluate _BBN\n");
554 root
->device
= device
;
555 root
->segment
= segment
& 0xFFFF;
556 strcpy(acpi_device_name(device
), ACPI_PCI_ROOT_DEVICE_NAME
);
557 strcpy(acpi_device_class(device
), ACPI_PCI_ROOT_CLASS
);
558 device
->driver_data
= root
;
560 pr_info(PREFIX
"%s [%s] (domain %04x %pR)\n",
561 acpi_device_name(device
), acpi_device_bid(device
),
562 root
->segment
, &root
->secondary
);
564 root
->mcfg_addr
= acpi_pci_root_get_mcfg_addr(handle
);
566 negotiate_os_control(root
, &no_aspm
, &clear_aspm
);
569 * TBD: Need PCI interface for enumeration/configuration of roots.
573 * Scan the Root Bridge
574 * --------------------
575 * Must do this prior to any attempt to bind the root device, as the
576 * PCI namespace does not get created until this call is made (and
577 * thus the root bridge's pci_dev does not exist).
579 root
->bus
= pci_acpi_scan_root(root
);
581 dev_err(&device
->dev
,
582 "Bus %04x:%02x not present in PCI namespace\n",
583 root
->segment
, (unsigned int)root
->secondary
.start
);
584 device
->driver_data
= NULL
;
590 dev_info(&device
->dev
, "Disabling ASPM (FADT indicates it is unsupported)\n");
591 pcie_clear_aspm(root
->bus
);
596 pci_acpi_add_bus_pm_notifier(device
);
597 if (device
->wakeup
.flags
.run_wake
)
598 device_set_run_wake(root
->bus
->bridge
, true);
600 if (system_state
!= SYSTEM_BOOTING
) {
601 pcibios_resource_survey_bus(root
->bus
);
602 pci_assign_unassigned_root_bus_resources(root
->bus
);
605 pci_lock_rescan_remove();
606 pci_bus_add_devices(root
->bus
);
607 pci_unlock_rescan_remove();
615 static void acpi_pci_root_remove(struct acpi_device
*device
)
617 struct acpi_pci_root
*root
= acpi_driver_data(device
);
619 pci_lock_rescan_remove();
621 pci_stop_root_bus(root
->bus
);
623 device_set_run_wake(root
->bus
->bridge
, false);
624 pci_acpi_remove_bus_pm_notifier(device
);
626 pci_remove_root_bus(root
->bus
);
628 pci_unlock_rescan_remove();
633 void __init
acpi_pci_root_init(void)
636 if (acpi_pci_disabled
)
639 pci_acpi_crs_quirks();
640 acpi_scan_add_handler_with_hotplug(&pci_root_handler
, "pci_root");