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/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 phys_addr_t
acpi_pci_root_get_mcfg_addr(acpi_handle handle
)
34 acpi_status status
= AE_NOT_EXIST
;
35 unsigned long long mcfg_addr
;
38 status
= acpi_evaluate_integer(handle
, METHOD_NAME__CBA
,
40 if (ACPI_FAILURE(status
))
43 return (phys_addr_t
)mcfg_addr
;
46 static acpi_status
decode_type0_hpx_record(union acpi_object
*record
,
47 struct hotplug_params
*hpx
)
50 union acpi_object
*fields
= record
->package
.elements
;
51 u32 revision
= fields
[1].integer
.value
;
55 if (record
->package
.count
!= 6)
57 for (i
= 2; i
< 6; i
++)
58 if (fields
[i
].type
!= ACPI_TYPE_INTEGER
)
60 hpx
->t0
= &hpx
->type0_data
;
61 hpx
->t0
->revision
= revision
;
62 hpx
->t0
->cache_line_size
= fields
[2].integer
.value
;
63 hpx
->t0
->latency_timer
= fields
[3].integer
.value
;
64 hpx
->t0
->enable_serr
= fields
[4].integer
.value
;
65 hpx
->t0
->enable_perr
= fields
[5].integer
.value
;
69 "%s: Type 0 Revision %d record not supported\n",
76 static acpi_status
decode_type1_hpx_record(union acpi_object
*record
,
77 struct hotplug_params
*hpx
)
80 union acpi_object
*fields
= record
->package
.elements
;
81 u32 revision
= fields
[1].integer
.value
;
85 if (record
->package
.count
!= 5)
87 for (i
= 2; i
< 5; i
++)
88 if (fields
[i
].type
!= ACPI_TYPE_INTEGER
)
90 hpx
->t1
= &hpx
->type1_data
;
91 hpx
->t1
->revision
= revision
;
92 hpx
->t1
->max_mem_read
= fields
[2].integer
.value
;
93 hpx
->t1
->avg_max_split
= fields
[3].integer
.value
;
94 hpx
->t1
->tot_max_split
= fields
[4].integer
.value
;
98 "%s: Type 1 Revision %d record not supported\n",
105 static acpi_status
decode_type2_hpx_record(union acpi_object
*record
,
106 struct hotplug_params
*hpx
)
109 union acpi_object
*fields
= record
->package
.elements
;
110 u32 revision
= fields
[1].integer
.value
;
114 if (record
->package
.count
!= 18)
116 for (i
= 2; i
< 18; i
++)
117 if (fields
[i
].type
!= ACPI_TYPE_INTEGER
)
119 hpx
->t2
= &hpx
->type2_data
;
120 hpx
->t2
->revision
= revision
;
121 hpx
->t2
->unc_err_mask_and
= fields
[2].integer
.value
;
122 hpx
->t2
->unc_err_mask_or
= fields
[3].integer
.value
;
123 hpx
->t2
->unc_err_sever_and
= fields
[4].integer
.value
;
124 hpx
->t2
->unc_err_sever_or
= fields
[5].integer
.value
;
125 hpx
->t2
->cor_err_mask_and
= fields
[6].integer
.value
;
126 hpx
->t2
->cor_err_mask_or
= fields
[7].integer
.value
;
127 hpx
->t2
->adv_err_cap_and
= fields
[8].integer
.value
;
128 hpx
->t2
->adv_err_cap_or
= fields
[9].integer
.value
;
129 hpx
->t2
->pci_exp_devctl_and
= fields
[10].integer
.value
;
130 hpx
->t2
->pci_exp_devctl_or
= fields
[11].integer
.value
;
131 hpx
->t2
->pci_exp_lnkctl_and
= fields
[12].integer
.value
;
132 hpx
->t2
->pci_exp_lnkctl_or
= fields
[13].integer
.value
;
133 hpx
->t2
->sec_unc_err_sever_and
= fields
[14].integer
.value
;
134 hpx
->t2
->sec_unc_err_sever_or
= fields
[15].integer
.value
;
135 hpx
->t2
->sec_unc_err_mask_and
= fields
[16].integer
.value
;
136 hpx
->t2
->sec_unc_err_mask_or
= fields
[17].integer
.value
;
140 "%s: Type 2 Revision %d record not supported\n",
147 static acpi_status
acpi_run_hpx(acpi_handle handle
, struct hotplug_params
*hpx
)
150 struct acpi_buffer buffer
= {ACPI_ALLOCATE_BUFFER
, NULL
};
151 union acpi_object
*package
, *record
, *fields
;
155 /* Clear the return buffer with zeros */
156 memset(hpx
, 0, sizeof(struct hotplug_params
));
158 status
= acpi_evaluate_object(handle
, "_HPX", NULL
, &buffer
);
159 if (ACPI_FAILURE(status
))
162 package
= (union acpi_object
*)buffer
.pointer
;
163 if (package
->type
!= ACPI_TYPE_PACKAGE
) {
168 for (i
= 0; i
< package
->package
.count
; i
++) {
169 record
= &package
->package
.elements
[i
];
170 if (record
->type
!= ACPI_TYPE_PACKAGE
) {
175 fields
= record
->package
.elements
;
176 if (fields
[0].type
!= ACPI_TYPE_INTEGER
||
177 fields
[1].type
!= ACPI_TYPE_INTEGER
) {
182 type
= fields
[0].integer
.value
;
185 status
= decode_type0_hpx_record(record
, hpx
);
186 if (ACPI_FAILURE(status
))
190 status
= decode_type1_hpx_record(record
, hpx
);
191 if (ACPI_FAILURE(status
))
195 status
= decode_type2_hpx_record(record
, hpx
);
196 if (ACPI_FAILURE(status
))
200 printk(KERN_ERR
"%s: Type %d record not supported\n",
207 kfree(buffer
.pointer
);
211 static acpi_status
acpi_run_hpp(acpi_handle handle
, struct hotplug_params
*hpp
)
214 struct acpi_buffer buffer
= { ACPI_ALLOCATE_BUFFER
, NULL
};
215 union acpi_object
*package
, *fields
;
218 memset(hpp
, 0, sizeof(struct hotplug_params
));
220 status
= acpi_evaluate_object(handle
, "_HPP", NULL
, &buffer
);
221 if (ACPI_FAILURE(status
))
224 package
= (union acpi_object
*) buffer
.pointer
;
225 if (package
->type
!= ACPI_TYPE_PACKAGE
||
226 package
->package
.count
!= 4) {
231 fields
= package
->package
.elements
;
232 for (i
= 0; i
< 4; i
++) {
233 if (fields
[i
].type
!= ACPI_TYPE_INTEGER
) {
239 hpp
->t0
= &hpp
->type0_data
;
240 hpp
->t0
->revision
= 1;
241 hpp
->t0
->cache_line_size
= fields
[0].integer
.value
;
242 hpp
->t0
->latency_timer
= fields
[1].integer
.value
;
243 hpp
->t0
->enable_serr
= fields
[2].integer
.value
;
244 hpp
->t0
->enable_perr
= fields
[3].integer
.value
;
247 kfree(buffer
.pointer
);
253 * @dev - the pci_dev for which we want parameters
254 * @hpp - allocated by the caller
256 int pci_get_hp_params(struct pci_dev
*dev
, struct hotplug_params
*hpp
)
259 acpi_handle handle
, phandle
;
260 struct pci_bus
*pbus
;
262 if (acpi_pci_disabled
)
266 for (pbus
= dev
->bus
; pbus
; pbus
= pbus
->parent
) {
267 handle
= acpi_pci_get_bridge_handle(pbus
);
273 * _HPP settings apply to all child buses, until another _HPP is
274 * encountered. If we don't find an _HPP for the input pci dev,
275 * look for it in the parent device scope since that would apply to
279 status
= acpi_run_hpx(handle
, hpp
);
280 if (ACPI_SUCCESS(status
))
282 status
= acpi_run_hpp(handle
, hpp
);
283 if (ACPI_SUCCESS(status
))
285 if (acpi_is_root_bridge(handle
))
287 status
= acpi_get_parent(handle
, &phandle
);
288 if (ACPI_FAILURE(status
))
294 EXPORT_SYMBOL_GPL(pci_get_hp_params
);
297 * pci_acpi_wake_bus - Root bus wakeup notification fork function.
298 * @work: Work item to handle.
300 static void pci_acpi_wake_bus(struct work_struct
*work
)
302 struct acpi_device
*adev
;
303 struct acpi_pci_root
*root
;
305 adev
= container_of(work
, struct acpi_device
, wakeup
.context
.work
);
306 root
= acpi_driver_data(adev
);
307 pci_pme_wakeup_bus(root
->bus
);
311 * pci_acpi_wake_dev - PCI device wakeup notification work function.
312 * @handle: ACPI handle of a device the notification is for.
313 * @work: Work item to handle.
315 static void pci_acpi_wake_dev(struct work_struct
*work
)
317 struct acpi_device_wakeup_context
*context
;
318 struct pci_dev
*pci_dev
;
320 context
= container_of(work
, struct acpi_device_wakeup_context
, work
);
321 pci_dev
= to_pci_dev(context
->dev
);
323 if (pci_dev
->pme_poll
)
324 pci_dev
->pme_poll
= false;
326 if (pci_dev
->current_state
== PCI_D3cold
) {
327 pci_wakeup_event(pci_dev
);
328 pm_runtime_resume(&pci_dev
->dev
);
332 /* Clear PME Status if set. */
333 if (pci_dev
->pme_support
)
334 pci_check_pme_status(pci_dev
);
336 pci_wakeup_event(pci_dev
);
337 pm_runtime_resume(&pci_dev
->dev
);
339 pci_pme_wakeup_bus(pci_dev
->subordinate
);
343 * pci_acpi_add_bus_pm_notifier - Register PM notifier for root PCI bus.
344 * @dev: PCI root bridge ACPI device.
346 acpi_status
pci_acpi_add_bus_pm_notifier(struct acpi_device
*dev
)
348 return acpi_add_pm_notifier(dev
, NULL
, pci_acpi_wake_bus
);
352 * pci_acpi_add_pm_notifier - Register PM notifier for given PCI device.
353 * @dev: ACPI device to add the notifier for.
354 * @pci_dev: PCI device to check for the PME status if an event is signaled.
356 acpi_status
pci_acpi_add_pm_notifier(struct acpi_device
*dev
,
357 struct pci_dev
*pci_dev
)
359 return acpi_add_pm_notifier(dev
, &pci_dev
->dev
, pci_acpi_wake_dev
);
363 * _SxD returns the D-state with the highest power
364 * (lowest D-state number) supported in the S-state "x".
366 * If the devices does not have a _PRW
367 * (Power Resources for Wake) supporting system wakeup from "x"
368 * then the OS is free to choose a lower power (higher number
369 * D-state) than the return value from _SxD.
371 * But if _PRW is enabled at S-state "x", the OS
372 * must not choose a power lower than _SxD --
373 * unless the device has an _SxW method specifying
374 * the lowest power (highest D-state number) the device
375 * may enter while still able to wake the system.
377 * ie. depending on global OS policy:
379 * if (_PRW at S-state x)
380 * choose from highest power _SxD to lowest power _SxW
381 * else // no _PRW at S-state x
382 * choose highest power _SxD or any lower power
385 static pci_power_t
acpi_pci_choose_state(struct pci_dev
*pdev
)
387 int acpi_state
, d_max
;
390 d_max
= ACPI_STATE_D3_HOT
;
392 d_max
= ACPI_STATE_D3_COLD
;
393 acpi_state
= acpi_pm_device_sleep_state(&pdev
->dev
, NULL
, d_max
);
395 return PCI_POWER_ERROR
;
397 switch (acpi_state
) {
404 case ACPI_STATE_D3_HOT
:
406 case ACPI_STATE_D3_COLD
:
409 return PCI_POWER_ERROR
;
412 static bool acpi_pci_power_manageable(struct pci_dev
*dev
)
414 struct acpi_device
*adev
= ACPI_COMPANION(&dev
->dev
);
415 return adev
? acpi_device_power_manageable(adev
) : false;
418 static int acpi_pci_set_power_state(struct pci_dev
*dev
, pci_power_t state
)
420 struct acpi_device
*adev
= ACPI_COMPANION(&dev
->dev
);
421 static const u8 state_conv
[] = {
422 [PCI_D0
] = ACPI_STATE_D0
,
423 [PCI_D1
] = ACPI_STATE_D1
,
424 [PCI_D2
] = ACPI_STATE_D2
,
425 [PCI_D3hot
] = ACPI_STATE_D3_HOT
,
426 [PCI_D3cold
] = ACPI_STATE_D3_COLD
,
430 /* If the ACPI device has _EJ0, ignore the device */
431 if (!adev
|| acpi_has_method(adev
->handle
, "_EJ0"))
436 if (dev_pm_qos_flags(&dev
->dev
, PM_QOS_FLAG_NO_POWER_OFF
) ==
445 error
= acpi_device_set_power(adev
, state_conv
[state
]);
449 dev_dbg(&dev
->dev
, "power state changed by ACPI to %s\n",
450 acpi_power_state_string(state_conv
[state
]));
455 static pci_power_t
acpi_pci_get_power_state(struct pci_dev
*dev
)
457 struct acpi_device
*adev
= ACPI_COMPANION(&dev
->dev
);
458 static const pci_power_t state_conv
[] = {
459 [ACPI_STATE_D0
] = PCI_D0
,
460 [ACPI_STATE_D1
] = PCI_D1
,
461 [ACPI_STATE_D2
] = PCI_D2
,
462 [ACPI_STATE_D3_HOT
] = PCI_D3hot
,
463 [ACPI_STATE_D3_COLD
] = PCI_D3cold
,
467 if (!adev
|| !acpi_device_power_manageable(adev
))
470 if (acpi_device_get_power(adev
, &state
) || state
== ACPI_STATE_UNKNOWN
)
473 return state_conv
[state
];
476 static bool acpi_pci_can_wakeup(struct pci_dev
*dev
)
478 struct acpi_device
*adev
= ACPI_COMPANION(&dev
->dev
);
479 return adev
? acpi_device_can_wakeup(adev
) : false;
482 static void acpi_pci_propagate_wakeup_enable(struct pci_bus
*bus
, bool enable
)
484 while (bus
->parent
) {
485 if (!acpi_pm_device_sleep_wake(&bus
->self
->dev
, enable
))
490 /* We have reached the root bus. */
492 acpi_pm_device_sleep_wake(bus
->bridge
, enable
);
495 static int acpi_pci_sleep_wake(struct pci_dev
*dev
, bool enable
)
497 if (acpi_pci_can_wakeup(dev
))
498 return acpi_pm_device_sleep_wake(&dev
->dev
, enable
);
500 acpi_pci_propagate_wakeup_enable(dev
->bus
, enable
);
504 static void acpi_pci_propagate_run_wake(struct pci_bus
*bus
, bool enable
)
506 while (bus
->parent
) {
507 struct pci_dev
*bridge
= bus
->self
;
509 if (bridge
->pme_interrupt
)
511 if (!acpi_pm_device_run_wake(&bridge
->dev
, enable
))
516 /* We have reached the root bus. */
518 acpi_pm_device_run_wake(bus
->bridge
, enable
);
521 static int acpi_pci_run_wake(struct pci_dev
*dev
, bool enable
)
524 * Per PCI Express Base Specification Revision 2.0 section
525 * 5.3.3.2 Link Wakeup, platform support is needed for D3cold
526 * waking up to power on the main link even if there is PME
529 if (dev
->pme_interrupt
&& !dev
->runtime_d3cold
)
532 if (!acpi_pm_device_run_wake(&dev
->dev
, enable
))
535 acpi_pci_propagate_run_wake(dev
->bus
, enable
);
539 static bool acpi_pci_need_resume(struct pci_dev
*dev
)
541 struct acpi_device
*adev
= ACPI_COMPANION(&dev
->dev
);
543 if (!adev
|| !acpi_device_power_manageable(adev
))
546 if (device_may_wakeup(&dev
->dev
) != !!adev
->wakeup
.prepare_count
)
549 if (acpi_target_system_state() == ACPI_STATE_S0
)
552 return !!adev
->power
.flags
.dsw_present
;
555 static const struct pci_platform_pm_ops acpi_pci_platform_pm
= {
556 .is_manageable
= acpi_pci_power_manageable
,
557 .set_state
= acpi_pci_set_power_state
,
558 .get_state
= acpi_pci_get_power_state
,
559 .choose_state
= acpi_pci_choose_state
,
560 .sleep_wake
= acpi_pci_sleep_wake
,
561 .run_wake
= acpi_pci_run_wake
,
562 .need_resume
= acpi_pci_need_resume
,
565 void acpi_pci_add_bus(struct pci_bus
*bus
)
567 union acpi_object
*obj
;
568 struct pci_host_bridge
*bridge
;
570 if (acpi_pci_disabled
|| !bus
->bridge
)
573 acpi_pci_slot_enumerate(bus
);
574 acpiphp_enumerate_slots(bus
);
577 * For a host bridge, check its _DSM for function 8 and if
578 * that is available, mark it in pci_host_bridge.
580 if (!pci_is_root_bus(bus
))
583 obj
= acpi_evaluate_dsm(ACPI_HANDLE(bus
->bridge
), pci_acpi_dsm_uuid
, 3,
584 RESET_DELAY_DSM
, NULL
);
588 if (obj
->type
== ACPI_TYPE_INTEGER
&& obj
->integer
.value
== 1) {
589 bridge
= pci_find_host_bridge(bus
);
590 bridge
->ignore_reset_delay
= 1;
595 void acpi_pci_remove_bus(struct pci_bus
*bus
)
597 if (acpi_pci_disabled
|| !bus
->bridge
)
600 acpiphp_remove_slots(bus
);
601 acpi_pci_slot_remove(bus
);
605 static struct acpi_device
*acpi_pci_find_companion(struct device
*dev
)
607 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
611 check_children
= pci_is_bridge(pci_dev
);
612 /* Please ref to ACPI spec for the syntax of _ADR */
613 addr
= (PCI_SLOT(pci_dev
->devfn
) << 16) | PCI_FUNC(pci_dev
->devfn
);
614 return acpi_find_child_device(ACPI_COMPANION(dev
->parent
), addr
,
619 * pci_acpi_optimize_delay - optimize PCI D3 and D3cold delay from ACPI
620 * @pdev: the PCI device whose delay is to be updated
621 * @handle: ACPI handle of this device
623 * Update the d3_delay and d3cold_delay of a PCI device from the ACPI _DSM
624 * control method of either the device itself or the PCI host bridge.
626 * Function 8, "Reset Delay," applies to the entire hierarchy below a PCI
627 * host bridge. If it returns one, the OS may assume that all devices in
628 * the hierarchy have already completed power-on reset delays.
630 * Function 9, "Device Readiness Durations," applies only to the object
631 * where it is located. It returns delay durations required after various
632 * events if the device requires less time than the spec requires. Delays
633 * from this function take precedence over the Reset Delay function.
635 * These _DSM functions are defined by the draft ECN of January 28, 2014,
636 * titled "ACPI additions for FW latency optimizations."
638 static void pci_acpi_optimize_delay(struct pci_dev
*pdev
,
641 struct pci_host_bridge
*bridge
= pci_find_host_bridge(pdev
->bus
);
643 union acpi_object
*obj
, *elements
;
645 if (bridge
->ignore_reset_delay
)
646 pdev
->d3cold_delay
= 0;
648 obj
= acpi_evaluate_dsm(handle
, pci_acpi_dsm_uuid
, 3,
649 FUNCTION_DELAY_DSM
, NULL
);
653 if (obj
->type
== ACPI_TYPE_PACKAGE
&& obj
->package
.count
== 5) {
654 elements
= obj
->package
.elements
;
655 if (elements
[0].type
== ACPI_TYPE_INTEGER
) {
656 value
= (int)elements
[0].integer
.value
/ 1000;
657 if (value
< PCI_PM_D3COLD_WAIT
)
658 pdev
->d3cold_delay
= value
;
660 if (elements
[3].type
== ACPI_TYPE_INTEGER
) {
661 value
= (int)elements
[3].integer
.value
/ 1000;
662 if (value
< PCI_PM_D3_WAIT
)
663 pdev
->d3_delay
= value
;
669 static void pci_acpi_setup(struct device
*dev
)
671 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
672 struct acpi_device
*adev
= ACPI_COMPANION(dev
);
677 pci_acpi_optimize_delay(pci_dev
, adev
->handle
);
679 pci_acpi_add_pm_notifier(adev
, pci_dev
);
680 if (!adev
->wakeup
.flags
.valid
)
683 device_set_wakeup_capable(dev
, true);
684 acpi_pci_sleep_wake(pci_dev
, false);
685 if (adev
->wakeup
.flags
.run_wake
)
686 device_set_run_wake(dev
, true);
689 static void pci_acpi_cleanup(struct device
*dev
)
691 struct acpi_device
*adev
= ACPI_COMPANION(dev
);
696 pci_acpi_remove_pm_notifier(adev
);
697 if (adev
->wakeup
.flags
.valid
) {
698 device_set_wakeup_capable(dev
, false);
699 device_set_run_wake(dev
, false);
703 static bool pci_acpi_bus_match(struct device
*dev
)
705 return dev_is_pci(dev
);
708 static struct acpi_bus_type acpi_pci_bus
= {
710 .match
= pci_acpi_bus_match
,
711 .find_companion
= acpi_pci_find_companion
,
712 .setup
= pci_acpi_setup
,
713 .cleanup
= pci_acpi_cleanup
,
717 static struct fwnode_handle
*(*pci_msi_get_fwnode_cb
)(struct device
*dev
);
720 * pci_msi_register_fwnode_provider - Register callback to retrieve fwnode
721 * @fn: Callback matching a device to a fwnode that identifies a PCI
724 * This should be called by irqchip driver, which is the parent of
725 * the MSI domain to provide callback interface to query fwnode.
728 pci_msi_register_fwnode_provider(struct fwnode_handle
*(*fn
)(struct device
*))
730 pci_msi_get_fwnode_cb
= fn
;
734 * pci_host_bridge_acpi_msi_domain - Retrieve MSI domain of a PCI host bridge
735 * @bus: The PCI host bridge bus.
737 * This function uses the callback function registered by
738 * pci_msi_register_fwnode_provider() to retrieve the irq_domain with
739 * type DOMAIN_BUS_PCI_MSI of the specified host bridge bus.
740 * This returns NULL on error or when the domain is not found.
742 struct irq_domain
*pci_host_bridge_acpi_msi_domain(struct pci_bus
*bus
)
744 struct fwnode_handle
*fwnode
;
746 if (!pci_msi_get_fwnode_cb
)
749 fwnode
= pci_msi_get_fwnode_cb(&bus
->dev
);
753 return irq_find_matching_fwnode(fwnode
, DOMAIN_BUS_PCI_MSI
);
756 static int __init
acpi_pci_init(void)
760 if (acpi_gbl_FADT
.boot_flags
& ACPI_FADT_NO_MSI
) {
761 pr_info("ACPI FADT declares the system doesn't support MSI, so disable it\n");
765 if (acpi_gbl_FADT
.boot_flags
& ACPI_FADT_NO_ASPM
) {
766 pr_info("ACPI FADT declares the system doesn't support PCIe ASPM, so disable it\n");
770 ret
= register_acpi_bus_type(&acpi_pci_bus
);
774 pci_set_platform_pm(&acpi_pci_platform_pm
);
775 acpi_pci_slot_init();
780 arch_initcall(acpi_pci_init
);