3 * Purpose: Provide PCI support in ACPI
7 * Copyright (C) 2004 Intel Corp.
10 #include <linux/delay.h>
11 #include <linux/init.h>
12 #include <linux/irqdomain.h>
13 #include <linux/pci.h>
14 #include <linux/msi.h>
15 #include <linux/pci_hotplug.h>
16 #include <linux/module.h>
17 #include <linux/pci-aspm.h>
18 #include <linux/pci-acpi.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/pm_qos.h>
24 * The UUID is defined in the PCI Firmware Specification available here:
25 * https://www.pcisig.com/members/downloads/pcifw_r3_1_13Dec10.pdf
27 const u8 pci_acpi_dsm_uuid[] = {
28 0xd0, 0x37, 0xc9, 0xe5, 0x53, 0x35, 0x7a, 0x4d,
29 0x91, 0x17, 0xea, 0x4d, 0x19, 0xc3, 0x43, 0x4d
32 #if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
33 static int acpi_get_rc_addr(struct acpi_device *adev, struct resource *res)
35 struct device *dev = &adev->dev;
36 struct resource_entry *entry;
37 struct list_head list;
41 INIT_LIST_HEAD(&list);
42 flags = IORESOURCE_MEM;
43 ret = acpi_dev_get_resources(adev, &list,
44 acpi_dev_filter_resource_type_cb,
47 dev_err(dev, "failed to parse _CRS method, error code %d\n",
53 dev_err(dev, "no IO and memory resources present in _CRS\n");
57 entry = list_first_entry(&list, struct resource_entry, node);
59 acpi_dev_free_resource_list(&list);
63 static acpi_status acpi_match_rc(acpi_handle handle, u32 lvl, void *context,
66 u16 *segment = context;
67 unsigned long long uid;
70 status = acpi_evaluate_integer(handle, "_UID", NULL, &uid);
71 if (ACPI_FAILURE(status) || uid != *segment)
74 *(acpi_handle *)retval = handle;
75 return AE_CTRL_TERMINATE;
78 int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
81 struct acpi_device *adev;
86 status = acpi_get_devices(hid, acpi_match_rc, &segment, &handle);
87 if (ACPI_FAILURE(status)) {
88 dev_err(dev, "can't find _HID %s device to locate resources\n",
93 ret = acpi_bus_get_device(handle, &adev);
97 ret = acpi_get_rc_addr(adev, res);
99 dev_err(dev, "can't get resource from %s\n",
100 dev_name(&adev->dev));
108 phys_addr_t acpi_pci_root_get_mcfg_addr(acpi_handle handle)
110 acpi_status status = AE_NOT_EXIST;
111 unsigned long long mcfg_addr;
114 status = acpi_evaluate_integer(handle, METHOD_NAME__CBA,
116 if (ACPI_FAILURE(status))
119 return (phys_addr_t)mcfg_addr;
122 static acpi_status decode_type0_hpx_record(union acpi_object *record,
123 struct hotplug_params *hpx)
126 union acpi_object *fields = record->package.elements;
127 u32 revision = fields[1].integer.value;
131 if (record->package.count != 6)
133 for (i = 2; i < 6; i++)
134 if (fields[i].type != ACPI_TYPE_INTEGER)
136 hpx->t0 = &hpx->type0_data;
137 hpx->t0->revision = revision;
138 hpx->t0->cache_line_size = fields[2].integer.value;
139 hpx->t0->latency_timer = fields[3].integer.value;
140 hpx->t0->enable_serr = fields[4].integer.value;
141 hpx->t0->enable_perr = fields[5].integer.value;
145 "%s: Type 0 Revision %d record not supported\n",
152 static acpi_status decode_type1_hpx_record(union acpi_object *record,
153 struct hotplug_params *hpx)
156 union acpi_object *fields = record->package.elements;
157 u32 revision = fields[1].integer.value;
161 if (record->package.count != 5)
163 for (i = 2; i < 5; i++)
164 if (fields[i].type != ACPI_TYPE_INTEGER)
166 hpx->t1 = &hpx->type1_data;
167 hpx->t1->revision = revision;
168 hpx->t1->max_mem_read = fields[2].integer.value;
169 hpx->t1->avg_max_split = fields[3].integer.value;
170 hpx->t1->tot_max_split = fields[4].integer.value;
174 "%s: Type 1 Revision %d record not supported\n",
181 static acpi_status decode_type2_hpx_record(union acpi_object *record,
182 struct hotplug_params *hpx)
185 union acpi_object *fields = record->package.elements;
186 u32 revision = fields[1].integer.value;
190 if (record->package.count != 18)
192 for (i = 2; i < 18; i++)
193 if (fields[i].type != ACPI_TYPE_INTEGER)
195 hpx->t2 = &hpx->type2_data;
196 hpx->t2->revision = revision;
197 hpx->t2->unc_err_mask_and = fields[2].integer.value;
198 hpx->t2->unc_err_mask_or = fields[3].integer.value;
199 hpx->t2->unc_err_sever_and = fields[4].integer.value;
200 hpx->t2->unc_err_sever_or = fields[5].integer.value;
201 hpx->t2->cor_err_mask_and = fields[6].integer.value;
202 hpx->t2->cor_err_mask_or = fields[7].integer.value;
203 hpx->t2->adv_err_cap_and = fields[8].integer.value;
204 hpx->t2->adv_err_cap_or = fields[9].integer.value;
205 hpx->t2->pci_exp_devctl_and = fields[10].integer.value;
206 hpx->t2->pci_exp_devctl_or = fields[11].integer.value;
207 hpx->t2->pci_exp_lnkctl_and = fields[12].integer.value;
208 hpx->t2->pci_exp_lnkctl_or = fields[13].integer.value;
209 hpx->t2->sec_unc_err_sever_and = fields[14].integer.value;
210 hpx->t2->sec_unc_err_sever_or = fields[15].integer.value;
211 hpx->t2->sec_unc_err_mask_and = fields[16].integer.value;
212 hpx->t2->sec_unc_err_mask_or = fields[17].integer.value;
216 "%s: Type 2 Revision %d record not supported\n",
223 static acpi_status acpi_run_hpx(acpi_handle handle, struct hotplug_params *hpx)
226 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
227 union acpi_object *package, *record, *fields;
231 /* Clear the return buffer with zeros */
232 memset(hpx, 0, sizeof(struct hotplug_params));
234 status = acpi_evaluate_object(handle, "_HPX", NULL, &buffer);
235 if (ACPI_FAILURE(status))
238 package = (union acpi_object *)buffer.pointer;
239 if (package->type != ACPI_TYPE_PACKAGE) {
244 for (i = 0; i < package->package.count; i++) {
245 record = &package->package.elements[i];
246 if (record->type != ACPI_TYPE_PACKAGE) {
251 fields = record->package.elements;
252 if (fields[0].type != ACPI_TYPE_INTEGER ||
253 fields[1].type != ACPI_TYPE_INTEGER) {
258 type = fields[0].integer.value;
261 status = decode_type0_hpx_record(record, hpx);
262 if (ACPI_FAILURE(status))
266 status = decode_type1_hpx_record(record, hpx);
267 if (ACPI_FAILURE(status))
271 status = decode_type2_hpx_record(record, hpx);
272 if (ACPI_FAILURE(status))
276 printk(KERN_ERR "%s: Type %d record not supported\n",
283 kfree(buffer.pointer);
287 static acpi_status acpi_run_hpp(acpi_handle handle, struct hotplug_params *hpp)
290 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
291 union acpi_object *package, *fields;
294 memset(hpp, 0, sizeof(struct hotplug_params));
296 status = acpi_evaluate_object(handle, "_HPP", NULL, &buffer);
297 if (ACPI_FAILURE(status))
300 package = (union acpi_object *) buffer.pointer;
301 if (package->type != ACPI_TYPE_PACKAGE ||
302 package->package.count != 4) {
307 fields = package->package.elements;
308 for (i = 0; i < 4; i++) {
309 if (fields[i].type != ACPI_TYPE_INTEGER) {
315 hpp->t0 = &hpp->type0_data;
316 hpp->t0->revision = 1;
317 hpp->t0->cache_line_size = fields[0].integer.value;
318 hpp->t0->latency_timer = fields[1].integer.value;
319 hpp->t0->enable_serr = fields[2].integer.value;
320 hpp->t0->enable_perr = fields[3].integer.value;
323 kfree(buffer.pointer);
329 * @dev - the pci_dev for which we want parameters
330 * @hpp - allocated by the caller
332 int pci_get_hp_params(struct pci_dev *dev, struct hotplug_params *hpp)
335 acpi_handle handle, phandle;
336 struct pci_bus *pbus;
338 if (acpi_pci_disabled)
342 for (pbus = dev->bus; pbus; pbus = pbus->parent) {
343 handle = acpi_pci_get_bridge_handle(pbus);
349 * _HPP settings apply to all child buses, until another _HPP is
350 * encountered. If we don't find an _HPP for the input pci dev,
351 * look for it in the parent device scope since that would apply to
355 status = acpi_run_hpx(handle, hpp);
356 if (ACPI_SUCCESS(status))
358 status = acpi_run_hpp(handle, hpp);
359 if (ACPI_SUCCESS(status))
361 if (acpi_is_root_bridge(handle))
363 status = acpi_get_parent(handle, &phandle);
364 if (ACPI_FAILURE(status))
370 EXPORT_SYMBOL_GPL(pci_get_hp_params);
373 * pciehp_is_native - Check whether a hotplug port is handled by the OS
374 * @pdev: Hotplug port to check
376 * Walk up from @pdev to the host bridge, obtain its cached _OSC Control Field
377 * and return the value of the "PCI Express Native Hot Plug control" bit.
378 * On failure to obtain the _OSC Control Field return %false.
380 bool pciehp_is_native(struct pci_dev *pdev)
382 struct acpi_pci_root *root;
385 handle = acpi_find_root_bridge_handle(pdev);
389 root = acpi_pci_find_root(handle);
393 return root->osc_control_set & OSC_PCI_EXPRESS_NATIVE_HP_CONTROL;
397 * pci_acpi_wake_bus - Root bus wakeup notification fork function.
398 * @work: Work item to handle.
400 static void pci_acpi_wake_bus(struct work_struct *work)
402 struct acpi_device *adev;
403 struct acpi_pci_root *root;
405 adev = container_of(work, struct acpi_device, wakeup.context.work);
406 root = acpi_driver_data(adev);
407 pci_pme_wakeup_bus(root->bus);
411 * pci_acpi_wake_dev - PCI device wakeup notification work function.
412 * @handle: ACPI handle of a device the notification is for.
413 * @work: Work item to handle.
415 static void pci_acpi_wake_dev(struct work_struct *work)
417 struct acpi_device_wakeup_context *context;
418 struct pci_dev *pci_dev;
420 context = container_of(work, struct acpi_device_wakeup_context, work);
421 pci_dev = to_pci_dev(context->dev);
423 if (pci_dev->pme_poll)
424 pci_dev->pme_poll = false;
426 if (pci_dev->current_state == PCI_D3cold) {
427 pci_wakeup_event(pci_dev);
428 pm_runtime_resume(&pci_dev->dev);
432 /* Clear PME Status if set. */
433 if (pci_dev->pme_support)
434 pci_check_pme_status(pci_dev);
436 pci_wakeup_event(pci_dev);
437 pm_runtime_resume(&pci_dev->dev);
439 pci_pme_wakeup_bus(pci_dev->subordinate);
443 * pci_acpi_add_bus_pm_notifier - Register PM notifier for root PCI bus.
444 * @dev: PCI root bridge ACPI device.
446 acpi_status pci_acpi_add_bus_pm_notifier(struct acpi_device *dev)
448 return acpi_add_pm_notifier(dev, NULL, pci_acpi_wake_bus);
452 * pci_acpi_add_pm_notifier - Register PM notifier for given PCI device.
453 * @dev: ACPI device to add the notifier for.
454 * @pci_dev: PCI device to check for the PME status if an event is signaled.
456 acpi_status pci_acpi_add_pm_notifier(struct acpi_device *dev,
457 struct pci_dev *pci_dev)
459 return acpi_add_pm_notifier(dev, &pci_dev->dev, pci_acpi_wake_dev);
463 * _SxD returns the D-state with the highest power
464 * (lowest D-state number) supported in the S-state "x".
466 * If the devices does not have a _PRW
467 * (Power Resources for Wake) supporting system wakeup from "x"
468 * then the OS is free to choose a lower power (higher number
469 * D-state) than the return value from _SxD.
471 * But if _PRW is enabled at S-state "x", the OS
472 * must not choose a power lower than _SxD --
473 * unless the device has an _SxW method specifying
474 * the lowest power (highest D-state number) the device
475 * may enter while still able to wake the system.
477 * ie. depending on global OS policy:
479 * if (_PRW at S-state x)
480 * choose from highest power _SxD to lowest power _SxW
481 * else // no _PRW at S-state x
482 * choose highest power _SxD or any lower power
485 static pci_power_t acpi_pci_choose_state(struct pci_dev *pdev)
487 int acpi_state, d_max;
490 d_max = ACPI_STATE_D3_HOT;
492 d_max = ACPI_STATE_D3_COLD;
493 acpi_state = acpi_pm_device_sleep_state(&pdev->dev, NULL, d_max);
495 return PCI_POWER_ERROR;
497 switch (acpi_state) {
504 case ACPI_STATE_D3_HOT:
506 case ACPI_STATE_D3_COLD:
509 return PCI_POWER_ERROR;
512 static bool acpi_pci_power_manageable(struct pci_dev *dev)
514 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
515 return adev ? acpi_device_power_manageable(adev) : false;
518 static int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state)
520 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
521 static const u8 state_conv[] = {
522 [PCI_D0] = ACPI_STATE_D0,
523 [PCI_D1] = ACPI_STATE_D1,
524 [PCI_D2] = ACPI_STATE_D2,
525 [PCI_D3hot] = ACPI_STATE_D3_HOT,
526 [PCI_D3cold] = ACPI_STATE_D3_COLD,
530 /* If the ACPI device has _EJ0, ignore the device */
531 if (!adev || acpi_has_method(adev->handle, "_EJ0"))
536 if (dev_pm_qos_flags(&dev->dev, PM_QOS_FLAG_NO_POWER_OFF) ==
545 error = acpi_device_set_power(adev, state_conv[state]);
549 dev_dbg(&dev->dev, "power state changed by ACPI to %s\n",
550 acpi_power_state_string(state_conv[state]));
555 static pci_power_t acpi_pci_get_power_state(struct pci_dev *dev)
557 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
558 static const pci_power_t state_conv[] = {
559 [ACPI_STATE_D0] = PCI_D0,
560 [ACPI_STATE_D1] = PCI_D1,
561 [ACPI_STATE_D2] = PCI_D2,
562 [ACPI_STATE_D3_HOT] = PCI_D3hot,
563 [ACPI_STATE_D3_COLD] = PCI_D3cold,
567 if (!adev || !acpi_device_power_manageable(adev))
570 if (acpi_device_get_power(adev, &state) || state == ACPI_STATE_UNKNOWN)
573 return state_conv[state];
576 static bool acpi_pci_can_wakeup(struct pci_dev *dev)
578 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
579 return adev ? acpi_device_can_wakeup(adev) : false;
582 static void acpi_pci_propagate_wakeup_enable(struct pci_bus *bus, bool enable)
584 while (bus->parent) {
585 if (!acpi_pm_device_sleep_wake(&bus->self->dev, enable))
590 /* We have reached the root bus. */
592 acpi_pm_device_sleep_wake(bus->bridge, enable);
595 static int acpi_pci_sleep_wake(struct pci_dev *dev, bool enable)
597 if (acpi_pci_can_wakeup(dev))
598 return acpi_pm_device_sleep_wake(&dev->dev, enable);
600 acpi_pci_propagate_wakeup_enable(dev->bus, enable);
604 static void acpi_pci_propagate_run_wake(struct pci_bus *bus, bool enable)
606 while (bus->parent) {
607 struct pci_dev *bridge = bus->self;
609 if (bridge->pme_interrupt)
611 if (!acpi_pm_device_run_wake(&bridge->dev, enable))
616 /* We have reached the root bus. */
618 acpi_pm_device_run_wake(bus->bridge, enable);
621 static int acpi_pci_run_wake(struct pci_dev *dev, bool enable)
624 * Per PCI Express Base Specification Revision 2.0 section
625 * 5.3.3.2 Link Wakeup, platform support is needed for D3cold
626 * waking up to power on the main link even if there is PME
629 if (dev->pme_interrupt && !dev->runtime_d3cold)
632 if (!acpi_pm_device_run_wake(&dev->dev, enable))
635 acpi_pci_propagate_run_wake(dev->bus, enable);
639 static bool acpi_pci_need_resume(struct pci_dev *dev)
641 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
643 if (!adev || !acpi_device_power_manageable(adev))
646 if (device_may_wakeup(&dev->dev) != !!adev->wakeup.prepare_count)
649 if (acpi_target_system_state() == ACPI_STATE_S0)
652 return !!adev->power.flags.dsw_present;
655 static const struct pci_platform_pm_ops acpi_pci_platform_pm = {
656 .is_manageable = acpi_pci_power_manageable,
657 .set_state = acpi_pci_set_power_state,
658 .get_state = acpi_pci_get_power_state,
659 .choose_state = acpi_pci_choose_state,
660 .sleep_wake = acpi_pci_sleep_wake,
661 .run_wake = acpi_pci_run_wake,
662 .need_resume = acpi_pci_need_resume,
665 void acpi_pci_add_bus(struct pci_bus *bus)
667 union acpi_object *obj;
668 struct pci_host_bridge *bridge;
670 if (acpi_pci_disabled || !bus->bridge)
673 acpi_pci_slot_enumerate(bus);
674 acpiphp_enumerate_slots(bus);
677 * For a host bridge, check its _DSM for function 8 and if
678 * that is available, mark it in pci_host_bridge.
680 if (!pci_is_root_bus(bus))
683 obj = acpi_evaluate_dsm(ACPI_HANDLE(bus->bridge), pci_acpi_dsm_uuid, 3,
684 RESET_DELAY_DSM, NULL);
688 if (obj->type == ACPI_TYPE_INTEGER && obj->integer.value == 1) {
689 bridge = pci_find_host_bridge(bus);
690 bridge->ignore_reset_delay = 1;
695 void acpi_pci_remove_bus(struct pci_bus *bus)
697 if (acpi_pci_disabled || !bus->bridge)
700 acpiphp_remove_slots(bus);
701 acpi_pci_slot_remove(bus);
705 static struct acpi_device *acpi_pci_find_companion(struct device *dev)
707 struct pci_dev *pci_dev = to_pci_dev(dev);
711 check_children = pci_is_bridge(pci_dev);
712 /* Please ref to ACPI spec for the syntax of _ADR */
713 addr = (PCI_SLOT(pci_dev->devfn) << 16) | PCI_FUNC(pci_dev->devfn);
714 return acpi_find_child_device(ACPI_COMPANION(dev->parent), addr,
719 * pci_acpi_optimize_delay - optimize PCI D3 and D3cold delay from ACPI
720 * @pdev: the PCI device whose delay is to be updated
721 * @handle: ACPI handle of this device
723 * Update the d3_delay and d3cold_delay of a PCI device from the ACPI _DSM
724 * control method of either the device itself or the PCI host bridge.
726 * Function 8, "Reset Delay," applies to the entire hierarchy below a PCI
727 * host bridge. If it returns one, the OS may assume that all devices in
728 * the hierarchy have already completed power-on reset delays.
730 * Function 9, "Device Readiness Durations," applies only to the object
731 * where it is located. It returns delay durations required after various
732 * events if the device requires less time than the spec requires. Delays
733 * from this function take precedence over the Reset Delay function.
735 * These _DSM functions are defined by the draft ECN of January 28, 2014,
736 * titled "ACPI additions for FW latency optimizations."
738 static void pci_acpi_optimize_delay(struct pci_dev *pdev,
741 struct pci_host_bridge *bridge = pci_find_host_bridge(pdev->bus);
743 union acpi_object *obj, *elements;
745 if (bridge->ignore_reset_delay)
746 pdev->d3cold_delay = 0;
748 obj = acpi_evaluate_dsm(handle, pci_acpi_dsm_uuid, 3,
749 FUNCTION_DELAY_DSM, NULL);
753 if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 5) {
754 elements = obj->package.elements;
755 if (elements[0].type == ACPI_TYPE_INTEGER) {
756 value = (int)elements[0].integer.value / 1000;
757 if (value < PCI_PM_D3COLD_WAIT)
758 pdev->d3cold_delay = value;
760 if (elements[3].type == ACPI_TYPE_INTEGER) {
761 value = (int)elements[3].integer.value / 1000;
762 if (value < PCI_PM_D3_WAIT)
763 pdev->d3_delay = value;
769 static void pci_acpi_setup(struct device *dev)
771 struct pci_dev *pci_dev = to_pci_dev(dev);
772 struct acpi_device *adev = ACPI_COMPANION(dev);
777 pci_acpi_optimize_delay(pci_dev, adev->handle);
779 pci_acpi_add_pm_notifier(adev, pci_dev);
780 if (!adev->wakeup.flags.valid)
783 device_set_wakeup_capable(dev, true);
784 acpi_pci_sleep_wake(pci_dev, false);
785 if (adev->wakeup.flags.run_wake)
786 device_set_run_wake(dev, true);
789 static void pci_acpi_cleanup(struct device *dev)
791 struct acpi_device *adev = ACPI_COMPANION(dev);
796 pci_acpi_remove_pm_notifier(adev);
797 if (adev->wakeup.flags.valid) {
798 device_set_wakeup_capable(dev, false);
799 device_set_run_wake(dev, false);
803 static bool pci_acpi_bus_match(struct device *dev)
805 return dev_is_pci(dev);
808 static struct acpi_bus_type acpi_pci_bus = {
810 .match = pci_acpi_bus_match,
811 .find_companion = acpi_pci_find_companion,
812 .setup = pci_acpi_setup,
813 .cleanup = pci_acpi_cleanup,
817 static struct fwnode_handle *(*pci_msi_get_fwnode_cb)(struct device *dev);
820 * pci_msi_register_fwnode_provider - Register callback to retrieve fwnode
821 * @fn: Callback matching a device to a fwnode that identifies a PCI
824 * This should be called by irqchip driver, which is the parent of
825 * the MSI domain to provide callback interface to query fwnode.
828 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *))
830 pci_msi_get_fwnode_cb = fn;
834 * pci_host_bridge_acpi_msi_domain - Retrieve MSI domain of a PCI host bridge
835 * @bus: The PCI host bridge bus.
837 * This function uses the callback function registered by
838 * pci_msi_register_fwnode_provider() to retrieve the irq_domain with
839 * type DOMAIN_BUS_PCI_MSI of the specified host bridge bus.
840 * This returns NULL on error or when the domain is not found.
842 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus)
844 struct fwnode_handle *fwnode;
846 if (!pci_msi_get_fwnode_cb)
849 fwnode = pci_msi_get_fwnode_cb(&bus->dev);
853 return irq_find_matching_fwnode(fwnode, DOMAIN_BUS_PCI_MSI);
856 static int __init acpi_pci_init(void)
860 if (acpi_gbl_FADT.boot_flags & ACPI_FADT_NO_MSI) {
861 pr_info("ACPI FADT declares the system doesn't support MSI, so disable it\n");
865 if (acpi_gbl_FADT.boot_flags & ACPI_FADT_NO_ASPM) {
866 pr_info("ACPI FADT declares the system doesn't support PCIe ASPM, so disable it\n");
870 ret = register_acpi_bus_type(&acpi_pci_bus);
874 pci_set_platform_pm(&acpi_pci_platform_pm);
875 acpi_pci_slot_init();
880 arch_initcall(acpi_pci_init);