3 * Purpose: Provide PCI support in ACPI
5 * Copyright (C) 2005 David Shaohua Li <shaohua.li@intel.com>
6 * Copyright (C) 2004 Tom Long Nguyen <tom.l.nguyen@intel.com>
7 * Copyright (C) 2004 Intel Corp.
10 #include <linux/delay.h>
11 #include <linux/init.h>
12 #include <linux/pci.h>
13 #include <linux/pci_hotplug.h>
14 #include <linux/module.h>
15 #include <linux/pci-aspm.h>
16 #include <linux/pci-acpi.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/pm_qos.h>
22 * The UUID is defined in the PCI Firmware Specification available here:
23 * https://www.pcisig.com/members/downloads/pcifw_r3_1_13Dec10.pdf
25 const u8 pci_acpi_dsm_uuid[] = {
26 0xd0, 0x37, 0xc9, 0xe5, 0x53, 0x35, 0x7a, 0x4d,
27 0x91, 0x17, 0xea, 0x4d, 0x19, 0xc3, 0x43, 0x4d
30 phys_addr_t acpi_pci_root_get_mcfg_addr(acpi_handle handle)
32 acpi_status status = AE_NOT_EXIST;
33 unsigned long long mcfg_addr;
36 status = acpi_evaluate_integer(handle, METHOD_NAME__CBA,
38 if (ACPI_FAILURE(status))
41 return (phys_addr_t)mcfg_addr;
44 static acpi_status decode_type0_hpx_record(union acpi_object *record,
45 struct hotplug_params *hpx)
48 union acpi_object *fields = record->package.elements;
49 u32 revision = fields[1].integer.value;
53 if (record->package.count != 6)
55 for (i = 2; i < 6; i++)
56 if (fields[i].type != ACPI_TYPE_INTEGER)
58 hpx->t0 = &hpx->type0_data;
59 hpx->t0->revision = revision;
60 hpx->t0->cache_line_size = fields[2].integer.value;
61 hpx->t0->latency_timer = fields[3].integer.value;
62 hpx->t0->enable_serr = fields[4].integer.value;
63 hpx->t0->enable_perr = fields[5].integer.value;
67 "%s: Type 0 Revision %d record not supported\n",
74 static acpi_status decode_type1_hpx_record(union acpi_object *record,
75 struct hotplug_params *hpx)
78 union acpi_object *fields = record->package.elements;
79 u32 revision = fields[1].integer.value;
83 if (record->package.count != 5)
85 for (i = 2; i < 5; i++)
86 if (fields[i].type != ACPI_TYPE_INTEGER)
88 hpx->t1 = &hpx->type1_data;
89 hpx->t1->revision = revision;
90 hpx->t1->max_mem_read = fields[2].integer.value;
91 hpx->t1->avg_max_split = fields[3].integer.value;
92 hpx->t1->tot_max_split = fields[4].integer.value;
96 "%s: Type 1 Revision %d record not supported\n",
103 static acpi_status decode_type2_hpx_record(union acpi_object *record,
104 struct hotplug_params *hpx)
107 union acpi_object *fields = record->package.elements;
108 u32 revision = fields[1].integer.value;
112 if (record->package.count != 18)
114 for (i = 2; i < 18; i++)
115 if (fields[i].type != ACPI_TYPE_INTEGER)
117 hpx->t2 = &hpx->type2_data;
118 hpx->t2->revision = revision;
119 hpx->t2->unc_err_mask_and = fields[2].integer.value;
120 hpx->t2->unc_err_mask_or = fields[3].integer.value;
121 hpx->t2->unc_err_sever_and = fields[4].integer.value;
122 hpx->t2->unc_err_sever_or = fields[5].integer.value;
123 hpx->t2->cor_err_mask_and = fields[6].integer.value;
124 hpx->t2->cor_err_mask_or = fields[7].integer.value;
125 hpx->t2->adv_err_cap_and = fields[8].integer.value;
126 hpx->t2->adv_err_cap_or = fields[9].integer.value;
127 hpx->t2->pci_exp_devctl_and = fields[10].integer.value;
128 hpx->t2->pci_exp_devctl_or = fields[11].integer.value;
129 hpx->t2->pci_exp_lnkctl_and = fields[12].integer.value;
130 hpx->t2->pci_exp_lnkctl_or = fields[13].integer.value;
131 hpx->t2->sec_unc_err_sever_and = fields[14].integer.value;
132 hpx->t2->sec_unc_err_sever_or = fields[15].integer.value;
133 hpx->t2->sec_unc_err_mask_and = fields[16].integer.value;
134 hpx->t2->sec_unc_err_mask_or = fields[17].integer.value;
138 "%s: Type 2 Revision %d record not supported\n",
145 static acpi_status acpi_run_hpx(acpi_handle handle, struct hotplug_params *hpx)
148 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
149 union acpi_object *package, *record, *fields;
153 /* Clear the return buffer with zeros */
154 memset(hpx, 0, sizeof(struct hotplug_params));
156 status = acpi_evaluate_object(handle, "_HPX", NULL, &buffer);
157 if (ACPI_FAILURE(status))
160 package = (union acpi_object *)buffer.pointer;
161 if (package->type != ACPI_TYPE_PACKAGE) {
166 for (i = 0; i < package->package.count; i++) {
167 record = &package->package.elements[i];
168 if (record->type != ACPI_TYPE_PACKAGE) {
173 fields = record->package.elements;
174 if (fields[0].type != ACPI_TYPE_INTEGER ||
175 fields[1].type != ACPI_TYPE_INTEGER) {
180 type = fields[0].integer.value;
183 status = decode_type0_hpx_record(record, hpx);
184 if (ACPI_FAILURE(status))
188 status = decode_type1_hpx_record(record, hpx);
189 if (ACPI_FAILURE(status))
193 status = decode_type2_hpx_record(record, hpx);
194 if (ACPI_FAILURE(status))
198 printk(KERN_ERR "%s: Type %d record not supported\n",
205 kfree(buffer.pointer);
209 static acpi_status acpi_run_hpp(acpi_handle handle, struct hotplug_params *hpp)
212 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
213 union acpi_object *package, *fields;
216 memset(hpp, 0, sizeof(struct hotplug_params));
218 status = acpi_evaluate_object(handle, "_HPP", NULL, &buffer);
219 if (ACPI_FAILURE(status))
222 package = (union acpi_object *) buffer.pointer;
223 if (package->type != ACPI_TYPE_PACKAGE ||
224 package->package.count != 4) {
229 fields = package->package.elements;
230 for (i = 0; i < 4; i++) {
231 if (fields[i].type != ACPI_TYPE_INTEGER) {
237 hpp->t0 = &hpp->type0_data;
238 hpp->t0->revision = 1;
239 hpp->t0->cache_line_size = fields[0].integer.value;
240 hpp->t0->latency_timer = fields[1].integer.value;
241 hpp->t0->enable_serr = fields[2].integer.value;
242 hpp->t0->enable_perr = fields[3].integer.value;
245 kfree(buffer.pointer);
251 * @dev - the pci_dev for which we want parameters
252 * @hpp - allocated by the caller
254 int pci_get_hp_params(struct pci_dev *dev, struct hotplug_params *hpp)
257 acpi_handle handle, phandle;
258 struct pci_bus *pbus;
260 if (acpi_pci_disabled)
264 for (pbus = dev->bus; pbus; pbus = pbus->parent) {
265 handle = acpi_pci_get_bridge_handle(pbus);
271 * _HPP settings apply to all child buses, until another _HPP is
272 * encountered. If we don't find an _HPP for the input pci dev,
273 * look for it in the parent device scope since that would apply to
277 status = acpi_run_hpx(handle, hpp);
278 if (ACPI_SUCCESS(status))
280 status = acpi_run_hpp(handle, hpp);
281 if (ACPI_SUCCESS(status))
283 if (acpi_is_root_bridge(handle))
285 status = acpi_get_parent(handle, &phandle);
286 if (ACPI_FAILURE(status))
292 EXPORT_SYMBOL_GPL(pci_get_hp_params);
295 * pci_acpi_wake_bus - Root bus wakeup notification fork function.
296 * @work: Work item to handle.
298 static void pci_acpi_wake_bus(struct work_struct *work)
300 struct acpi_device *adev;
301 struct acpi_pci_root *root;
303 adev = container_of(work, struct acpi_device, wakeup.context.work);
304 root = acpi_driver_data(adev);
305 pci_pme_wakeup_bus(root->bus);
309 * pci_acpi_wake_dev - PCI device wakeup notification work function.
310 * @handle: ACPI handle of a device the notification is for.
311 * @work: Work item to handle.
313 static void pci_acpi_wake_dev(struct work_struct *work)
315 struct acpi_device_wakeup_context *context;
316 struct pci_dev *pci_dev;
318 context = container_of(work, struct acpi_device_wakeup_context, work);
319 pci_dev = to_pci_dev(context->dev);
321 if (pci_dev->pme_poll)
322 pci_dev->pme_poll = false;
324 if (pci_dev->current_state == PCI_D3cold) {
325 pci_wakeup_event(pci_dev);
326 pm_runtime_resume(&pci_dev->dev);
330 /* Clear PME Status if set. */
331 if (pci_dev->pme_support)
332 pci_check_pme_status(pci_dev);
334 pci_wakeup_event(pci_dev);
335 pm_runtime_resume(&pci_dev->dev);
337 pci_pme_wakeup_bus(pci_dev->subordinate);
341 * pci_acpi_add_bus_pm_notifier - Register PM notifier for root PCI bus.
342 * @dev: PCI root bridge ACPI device.
344 acpi_status pci_acpi_add_bus_pm_notifier(struct acpi_device *dev)
346 return acpi_add_pm_notifier(dev, NULL, pci_acpi_wake_bus);
350 * pci_acpi_add_pm_notifier - Register PM notifier for given PCI device.
351 * @dev: ACPI device to add the notifier for.
352 * @pci_dev: PCI device to check for the PME status if an event is signaled.
354 acpi_status pci_acpi_add_pm_notifier(struct acpi_device *dev,
355 struct pci_dev *pci_dev)
357 return acpi_add_pm_notifier(dev, &pci_dev->dev, pci_acpi_wake_dev);
361 * _SxD returns the D-state with the highest power
362 * (lowest D-state number) supported in the S-state "x".
364 * If the devices does not have a _PRW
365 * (Power Resources for Wake) supporting system wakeup from "x"
366 * then the OS is free to choose a lower power (higher number
367 * D-state) than the return value from _SxD.
369 * But if _PRW is enabled at S-state "x", the OS
370 * must not choose a power lower than _SxD --
371 * unless the device has an _SxW method specifying
372 * the lowest power (highest D-state number) the device
373 * may enter while still able to wake the system.
375 * ie. depending on global OS policy:
377 * if (_PRW at S-state x)
378 * choose from highest power _SxD to lowest power _SxW
379 * else // no _PRW at S-state x
380 * choose highest power _SxD or any lower power
383 static pci_power_t acpi_pci_choose_state(struct pci_dev *pdev)
385 int acpi_state, d_max;
388 d_max = ACPI_STATE_D3_HOT;
390 d_max = ACPI_STATE_D3_COLD;
391 acpi_state = acpi_pm_device_sleep_state(&pdev->dev, NULL, d_max);
393 return PCI_POWER_ERROR;
395 switch (acpi_state) {
402 case ACPI_STATE_D3_HOT:
404 case ACPI_STATE_D3_COLD:
407 return PCI_POWER_ERROR;
410 static bool acpi_pci_power_manageable(struct pci_dev *dev)
412 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
413 return adev ? acpi_device_power_manageable(adev) : false;
416 static int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state)
418 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
419 static const u8 state_conv[] = {
420 [PCI_D0] = ACPI_STATE_D0,
421 [PCI_D1] = ACPI_STATE_D1,
422 [PCI_D2] = ACPI_STATE_D2,
423 [PCI_D3hot] = ACPI_STATE_D3_COLD,
424 [PCI_D3cold] = ACPI_STATE_D3_COLD,
428 /* If the ACPI device has _EJ0, ignore the device */
429 if (!adev || acpi_has_method(adev->handle, "_EJ0"))
434 if (dev_pm_qos_flags(&dev->dev, PM_QOS_FLAG_NO_POWER_OFF) ==
443 error = acpi_device_set_power(adev, state_conv[state]);
447 dev_dbg(&dev->dev, "power state changed by ACPI to %s\n",
448 acpi_power_state_string(state_conv[state]));
453 static bool acpi_pci_can_wakeup(struct pci_dev *dev)
455 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
456 return adev ? acpi_device_can_wakeup(adev) : false;
459 static void acpi_pci_propagate_wakeup_enable(struct pci_bus *bus, bool enable)
461 while (bus->parent) {
462 if (!acpi_pm_device_sleep_wake(&bus->self->dev, enable))
467 /* We have reached the root bus. */
469 acpi_pm_device_sleep_wake(bus->bridge, enable);
472 static int acpi_pci_sleep_wake(struct pci_dev *dev, bool enable)
474 if (acpi_pci_can_wakeup(dev))
475 return acpi_pm_device_sleep_wake(&dev->dev, enable);
477 acpi_pci_propagate_wakeup_enable(dev->bus, enable);
481 static void acpi_pci_propagate_run_wake(struct pci_bus *bus, bool enable)
483 while (bus->parent) {
484 struct pci_dev *bridge = bus->self;
486 if (bridge->pme_interrupt)
488 if (!acpi_pm_device_run_wake(&bridge->dev, enable))
493 /* We have reached the root bus. */
495 acpi_pm_device_run_wake(bus->bridge, enable);
498 static int acpi_pci_run_wake(struct pci_dev *dev, bool enable)
501 * Per PCI Express Base Specification Revision 2.0 section
502 * 5.3.3.2 Link Wakeup, platform support is needed for D3cold
503 * waking up to power on the main link even if there is PME
506 if (dev->pme_interrupt && !dev->runtime_d3cold)
509 if (!acpi_pm_device_run_wake(&dev->dev, enable))
512 acpi_pci_propagate_run_wake(dev->bus, enable);
516 static bool acpi_pci_need_resume(struct pci_dev *dev)
518 struct acpi_device *adev = ACPI_COMPANION(&dev->dev);
520 if (!adev || !acpi_device_power_manageable(adev))
523 if (device_may_wakeup(&dev->dev) != !!adev->wakeup.prepare_count)
526 if (acpi_target_system_state() == ACPI_STATE_S0)
529 return !!adev->power.flags.dsw_present;
532 static struct pci_platform_pm_ops acpi_pci_platform_pm = {
533 .is_manageable = acpi_pci_power_manageable,
534 .set_state = acpi_pci_set_power_state,
535 .choose_state = acpi_pci_choose_state,
536 .sleep_wake = acpi_pci_sleep_wake,
537 .run_wake = acpi_pci_run_wake,
538 .need_resume = acpi_pci_need_resume,
541 void acpi_pci_add_bus(struct pci_bus *bus)
543 union acpi_object *obj;
544 struct pci_host_bridge *bridge;
546 if (acpi_pci_disabled || !bus->bridge)
549 acpi_pci_slot_enumerate(bus);
550 acpiphp_enumerate_slots(bus);
553 * For a host bridge, check its _DSM for function 8 and if
554 * that is available, mark it in pci_host_bridge.
556 if (!pci_is_root_bus(bus))
559 obj = acpi_evaluate_dsm(ACPI_HANDLE(bus->bridge), pci_acpi_dsm_uuid, 3,
560 RESET_DELAY_DSM, NULL);
564 if (obj->type == ACPI_TYPE_INTEGER && obj->integer.value == 1) {
565 bridge = pci_find_host_bridge(bus);
566 bridge->ignore_reset_delay = 1;
571 void acpi_pci_remove_bus(struct pci_bus *bus)
573 if (acpi_pci_disabled || !bus->bridge)
576 acpiphp_remove_slots(bus);
577 acpi_pci_slot_remove(bus);
581 static struct acpi_device *acpi_pci_find_companion(struct device *dev)
583 struct pci_dev *pci_dev = to_pci_dev(dev);
587 check_children = pci_is_bridge(pci_dev);
588 /* Please ref to ACPI spec for the syntax of _ADR */
589 addr = (PCI_SLOT(pci_dev->devfn) << 16) | PCI_FUNC(pci_dev->devfn);
590 return acpi_find_child_device(ACPI_COMPANION(dev->parent), addr,
595 * pci_acpi_optimize_delay - optimize PCI D3 and D3cold delay from ACPI
596 * @pdev: the PCI device whose delay is to be updated
597 * @adev: the companion ACPI device of this PCI device
599 * Update the d3_delay and d3cold_delay of a PCI device from the ACPI _DSM
600 * control method of either the device itself or the PCI host bridge.
602 * Function 8, "Reset Delay," applies to the entire hierarchy below a PCI
603 * host bridge. If it returns one, the OS may assume that all devices in
604 * the hierarchy have already completed power-on reset delays.
606 * Function 9, "Device Readiness Durations," applies only to the object
607 * where it is located. It returns delay durations required after various
608 * events if the device requires less time than the spec requires. Delays
609 * from this function take precedence over the Reset Delay function.
611 * These _DSM functions are defined by the draft ECN of January 28, 2014,
612 * titled "ACPI additions for FW latency optimizations."
614 static void pci_acpi_optimize_delay(struct pci_dev *pdev,
617 struct pci_host_bridge *bridge = pci_find_host_bridge(pdev->bus);
619 union acpi_object *obj, *elements;
621 if (bridge->ignore_reset_delay)
622 pdev->d3cold_delay = 0;
624 obj = acpi_evaluate_dsm(handle, pci_acpi_dsm_uuid, 3,
625 FUNCTION_DELAY_DSM, NULL);
629 if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 5) {
630 elements = obj->package.elements;
631 if (elements[0].type == ACPI_TYPE_INTEGER) {
632 value = (int)elements[0].integer.value / 1000;
633 if (value < PCI_PM_D3COLD_WAIT)
634 pdev->d3cold_delay = value;
636 if (elements[3].type == ACPI_TYPE_INTEGER) {
637 value = (int)elements[3].integer.value / 1000;
638 if (value < PCI_PM_D3_WAIT)
639 pdev->d3_delay = value;
645 static void pci_acpi_setup(struct device *dev)
647 struct pci_dev *pci_dev = to_pci_dev(dev);
648 struct acpi_device *adev = ACPI_COMPANION(dev);
653 pci_acpi_optimize_delay(pci_dev, adev->handle);
655 pci_acpi_add_pm_notifier(adev, pci_dev);
656 if (!adev->wakeup.flags.valid)
659 device_set_wakeup_capable(dev, true);
660 acpi_pci_sleep_wake(pci_dev, false);
661 if (adev->wakeup.flags.run_wake)
662 device_set_run_wake(dev, true);
665 static void pci_acpi_cleanup(struct device *dev)
667 struct acpi_device *adev = ACPI_COMPANION(dev);
672 pci_acpi_remove_pm_notifier(adev);
673 if (adev->wakeup.flags.valid) {
674 device_set_wakeup_capable(dev, false);
675 device_set_run_wake(dev, false);
679 static bool pci_acpi_bus_match(struct device *dev)
681 return dev_is_pci(dev);
684 static struct acpi_bus_type acpi_pci_bus = {
686 .match = pci_acpi_bus_match,
687 .find_companion = acpi_pci_find_companion,
688 .setup = pci_acpi_setup,
689 .cleanup = pci_acpi_cleanup,
692 static int __init acpi_pci_init(void)
696 if (acpi_gbl_FADT.boot_flags & ACPI_FADT_NO_MSI) {
697 pr_info("ACPI FADT declares the system doesn't support MSI, so disable it\n");
701 if (acpi_gbl_FADT.boot_flags & ACPI_FADT_NO_ASPM) {
702 pr_info("ACPI FADT declares the system doesn't support PCIe ASPM, so disable it\n");
706 ret = register_acpi_bus_type(&acpi_pci_bus);
710 pci_set_platform_pm(&acpi_pci_platform_pm);
711 acpi_pci_slot_init();
716 arch_initcall(acpi_pci_init);