1 // SPDX-License-Identifier: GPL-2.0-only
3 * drivers/acpi/device_pm.c - ACPI device power management routines.
5 * Copyright (C) 2012, Intel Corp.
6 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13 #define pr_fmt(fmt) "PM: " fmt
15 #include <linux/acpi.h>
16 #include <linux/export.h>
17 #include <linux/mutex.h>
18 #include <linux/pm_qos.h>
19 #include <linux/pm_domain.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/suspend.h>
27 * acpi_power_state_string - String representation of ACPI device power state.
28 * @state: ACPI device power state to return the string representation of.
30 const char *acpi_power_state_string(int state)
39 case ACPI_STATE_D3_HOT:
41 case ACPI_STATE_D3_COLD:
48 static int acpi_dev_pm_explicit_get(struct acpi_device *device, int *state)
50 unsigned long long psc;
53 status = acpi_evaluate_integer(device->handle, "_PSC", NULL, &psc);
54 if (ACPI_FAILURE(status))
62 * acpi_device_get_power - Get power state of an ACPI device.
63 * @device: Device to get the power state of.
64 * @state: Place to store the power state of the device.
66 * This function does not update the device's power.state field, but it may
67 * update its parent's power.state field (when the parent's power state is
68 * unknown and the device's power state turns out to be D0).
70 * Also, it does not update power resource reference counters to ensure that
71 * the power state returned by it will be persistent and it may return a power
72 * state shallower than previously set by acpi_device_set_power() for @device
73 * (if that power state depends on any power resources).
75 int acpi_device_get_power(struct acpi_device *device, int *state)
77 int result = ACPI_STATE_UNKNOWN;
80 if (!device || !state)
83 if (!device->flags.power_manageable) {
84 /* TBD: Non-recursive algorithm for walking up hierarchy. */
85 *state = device->parent ?
86 device->parent->power.state : ACPI_STATE_D0;
91 * Get the device's power state from power resources settings and _PSC,
94 if (device->power.flags.power_resources) {
95 error = acpi_power_get_inferred_state(device, &result);
99 if (device->power.flags.explicit_get) {
102 error = acpi_dev_pm_explicit_get(device, &psc);
107 * The power resources settings may indicate a power state
108 * shallower than the actual power state of the device, because
109 * the same power resources may be referenced by other devices.
111 * For systems predating ACPI 4.0 we assume that D3hot is the
112 * deepest state that can be supported.
114 if (psc > result && psc < ACPI_STATE_D3_COLD)
116 else if (result == ACPI_STATE_UNKNOWN)
117 result = psc > ACPI_STATE_D2 ? ACPI_STATE_D3_HOT : psc;
121 * If we were unsure about the device parent's power state up to this
122 * point, the fact that the device is in D0 implies that the parent has
123 * to be in D0 too, except if ignore_parent is set.
125 if (!device->power.flags.ignore_parent && device->parent
126 && device->parent->power.state == ACPI_STATE_UNKNOWN
127 && result == ACPI_STATE_D0)
128 device->parent->power.state = ACPI_STATE_D0;
133 acpi_handle_debug(device->handle, "Power state: %s\n",
134 acpi_power_state_string(*state));
139 static int acpi_dev_pm_explicit_set(struct acpi_device *adev, int state)
141 if (adev->power.states[state].flags.explicit_set) {
142 char method[5] = { '_', 'P', 'S', '0' + state, '\0' };
145 status = acpi_evaluate_object(adev->handle, method, NULL, NULL);
146 if (ACPI_FAILURE(status))
153 * acpi_device_set_power - Set power state of an ACPI device.
154 * @device: Device to set the power state of.
155 * @state: New power state to set.
157 * Callers must ensure that the device is power manageable before using this
160 int acpi_device_set_power(struct acpi_device *device, int state)
162 int target_state = state;
165 if (!device || !device->flags.power_manageable
166 || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
169 acpi_handle_debug(device->handle, "Power state change: %s -> %s\n",
170 acpi_power_state_string(device->power.state),
171 acpi_power_state_string(state));
173 /* Make sure this is a valid target state */
175 /* There is a special case for D0 addressed below. */
176 if (state > ACPI_STATE_D0 && state == device->power.state)
179 if (state == ACPI_STATE_D3_COLD) {
181 * For transitions to D3cold we need to execute _PS3 and then
182 * possibly drop references to the power resources in use.
184 state = ACPI_STATE_D3_HOT;
185 /* If D3cold is not supported, use D3hot as the target state. */
186 if (!device->power.states[ACPI_STATE_D3_COLD].flags.valid)
187 target_state = state;
188 } else if (!device->power.states[state].flags.valid) {
189 acpi_handle_debug(device->handle, "Power state %s not supported\n",
190 acpi_power_state_string(state));
194 if (!device->power.flags.ignore_parent && device->parent &&
195 state < device->parent->power.state) {
196 acpi_handle_debug(device->handle,
197 "Cannot transition to %s for parent in %s\n",
198 acpi_power_state_string(state),
199 acpi_power_state_string(device->parent->power.state));
206 * In accordance with ACPI 6, _PSx is executed before manipulating power
207 * resources, unless the target state is D0, in which case _PS0 is
208 * supposed to be executed after turning the power resources on.
210 if (state > ACPI_STATE_D0) {
212 * According to ACPI 6, devices cannot go from lower-power
213 * (deeper) states to higher-power (shallower) states.
215 if (state < device->power.state) {
216 acpi_handle_debug(device->handle,
217 "Cannot transition from %s to %s\n",
218 acpi_power_state_string(device->power.state),
219 acpi_power_state_string(state));
224 * If the device goes from D3hot to D3cold, _PS3 has been
225 * evaluated for it already, so skip it in that case.
227 if (device->power.state < ACPI_STATE_D3_HOT) {
228 result = acpi_dev_pm_explicit_set(device, state);
233 if (device->power.flags.power_resources)
234 result = acpi_power_transition(device, target_state);
236 int cur_state = device->power.state;
238 if (device->power.flags.power_resources) {
239 result = acpi_power_transition(device, ACPI_STATE_D0);
244 if (cur_state == ACPI_STATE_D0) {
247 /* Nothing to do here if _PSC is not present. */
248 if (!device->power.flags.explicit_get)
252 * The power state of the device was set to D0 last
253 * time, but that might have happened before a
254 * system-wide transition involving the platform
255 * firmware, so it may be necessary to evaluate _PS0
256 * for the device here. However, use extra care here
257 * and evaluate _PSC to check the device's current power
258 * state, and only invoke _PS0 if the evaluation of _PSC
259 * is successful and it returns a power state different
262 result = acpi_dev_pm_explicit_get(device, &psc);
263 if (result || psc == ACPI_STATE_D0)
267 result = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0);
272 acpi_handle_debug(device->handle,
273 "Failed to change power state to %s\n",
274 acpi_power_state_string(target_state));
276 device->power.state = target_state;
277 acpi_handle_debug(device->handle, "Power state changed to %s\n",
278 acpi_power_state_string(target_state));
284 acpi_handle_debug(device->handle, "Already in %s\n",
285 acpi_power_state_string(state));
288 EXPORT_SYMBOL(acpi_device_set_power);
290 int acpi_bus_set_power(acpi_handle handle, int state)
292 struct acpi_device *device = acpi_fetch_acpi_dev(handle);
295 return acpi_device_set_power(device, state);
299 EXPORT_SYMBOL(acpi_bus_set_power);
301 int acpi_bus_init_power(struct acpi_device *device)
309 device->power.state = ACPI_STATE_UNKNOWN;
310 if (!acpi_device_is_present(device)) {
311 device->flags.initialized = false;
315 result = acpi_device_get_power(device, &state);
319 if (state < ACPI_STATE_D3_COLD && device->power.flags.power_resources) {
320 /* Reference count the power resources. */
321 result = acpi_power_on_resources(device, state);
325 if (state == ACPI_STATE_D0) {
327 * If _PSC is not present and the state inferred from
328 * power resources appears to be D0, it still may be
329 * necessary to execute _PS0 at this point, because
330 * another device using the same power resources may
331 * have been put into D0 previously and that's why we
334 result = acpi_dev_pm_explicit_set(device, state);
338 } else if (state == ACPI_STATE_UNKNOWN) {
340 * No power resources and missing _PSC? Cross fingers and make
341 * it D0 in hope that this is what the BIOS put the device into.
342 * [We tried to force D0 here by executing _PS0, but that broke
343 * Toshiba P870-303 in a nasty way.]
345 state = ACPI_STATE_D0;
347 device->power.state = state;
352 * acpi_device_fix_up_power - Force device with missing _PSC into D0.
353 * @device: Device object whose power state is to be fixed up.
355 * Devices without power resources and _PSC, but having _PS0 and _PS3 defined,
356 * are assumed to be put into D0 by the BIOS. However, in some cases that may
357 * not be the case and this function should be used then.
359 int acpi_device_fix_up_power(struct acpi_device *device)
363 if (!device->power.flags.power_resources
364 && !device->power.flags.explicit_get
365 && device->power.state == ACPI_STATE_D0)
366 ret = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0);
370 EXPORT_SYMBOL_GPL(acpi_device_fix_up_power);
372 int acpi_device_update_power(struct acpi_device *device, int *state_p)
377 if (device->power.state == ACPI_STATE_UNKNOWN) {
378 result = acpi_bus_init_power(device);
379 if (!result && state_p)
380 *state_p = device->power.state;
385 result = acpi_device_get_power(device, &state);
389 if (state == ACPI_STATE_UNKNOWN) {
390 state = ACPI_STATE_D0;
391 result = acpi_device_set_power(device, state);
395 if (device->power.flags.power_resources) {
397 * We don't need to really switch the state, bu we need
398 * to update the power resources' reference counters.
400 result = acpi_power_transition(device, state);
404 device->power.state = state;
411 EXPORT_SYMBOL_GPL(acpi_device_update_power);
413 int acpi_bus_update_power(acpi_handle handle, int *state_p)
415 struct acpi_device *device = acpi_fetch_acpi_dev(handle);
418 return acpi_device_update_power(device, state_p);
422 EXPORT_SYMBOL_GPL(acpi_bus_update_power);
424 bool acpi_bus_power_manageable(acpi_handle handle)
426 struct acpi_device *device = acpi_fetch_acpi_dev(handle);
428 return device && device->flags.power_manageable;
430 EXPORT_SYMBOL(acpi_bus_power_manageable);
432 static int acpi_power_up_if_adr_present(struct acpi_device *adev, void *not_used)
434 if (!(adev->flags.power_manageable && adev->pnp.type.bus_address))
437 acpi_handle_debug(adev->handle, "Power state: %s\n",
438 acpi_power_state_string(adev->power.state));
440 if (adev->power.state == ACPI_STATE_D3_COLD)
441 return acpi_device_set_power(adev, ACPI_STATE_D0);
447 * acpi_dev_power_up_children_with_adr - Power up childres with valid _ADR
448 * @adev: Parent ACPI device object.
450 * Change the power states of the direct children of @adev that are in D3cold
451 * and hold valid _ADR objects to D0 in order to allow bus (e.g. PCI)
452 * enumeration code to access them.
454 void acpi_dev_power_up_children_with_adr(struct acpi_device *adev)
456 acpi_dev_for_each_child(adev, acpi_power_up_if_adr_present, NULL);
460 static DEFINE_MUTEX(acpi_pm_notifier_lock);
461 static DEFINE_MUTEX(acpi_pm_notifier_install_lock);
463 void acpi_pm_wakeup_event(struct device *dev)
465 pm_wakeup_dev_event(dev, 0, acpi_s2idle_wakeup());
467 EXPORT_SYMBOL_GPL(acpi_pm_wakeup_event);
469 static void acpi_pm_notify_handler(acpi_handle handle, u32 val, void *not_used)
471 struct acpi_device *adev;
473 if (val != ACPI_NOTIFY_DEVICE_WAKE)
476 acpi_handle_debug(handle, "Wake notify\n");
478 adev = acpi_bus_get_acpi_device(handle);
482 mutex_lock(&acpi_pm_notifier_lock);
484 if (adev->wakeup.flags.notifier_present) {
485 pm_wakeup_ws_event(adev->wakeup.ws, 0, acpi_s2idle_wakeup());
486 if (adev->wakeup.context.func) {
487 acpi_handle_debug(handle, "Running %pS for %s\n",
488 adev->wakeup.context.func,
489 dev_name(adev->wakeup.context.dev));
490 adev->wakeup.context.func(&adev->wakeup.context);
494 mutex_unlock(&acpi_pm_notifier_lock);
496 acpi_bus_put_acpi_device(adev);
500 * acpi_add_pm_notifier - Register PM notify handler for given ACPI device.
501 * @adev: ACPI device to add the notify handler for.
502 * @dev: Device to generate a wakeup event for while handling the notification.
503 * @func: Work function to execute when handling the notification.
505 * NOTE: @adev need not be a run-wake or wakeup device to be a valid source of
506 * PM wakeup events. For example, wakeup events may be generated for bridges
507 * if one of the devices below the bridge is signaling wakeup, even if the
508 * bridge itself doesn't have a wakeup GPE associated with it.
510 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
511 void (*func)(struct acpi_device_wakeup_context *context))
513 acpi_status status = AE_ALREADY_EXISTS;
516 return AE_BAD_PARAMETER;
518 mutex_lock(&acpi_pm_notifier_install_lock);
520 if (adev->wakeup.flags.notifier_present)
523 status = acpi_install_notify_handler(adev->handle, ACPI_SYSTEM_NOTIFY,
524 acpi_pm_notify_handler, NULL);
525 if (ACPI_FAILURE(status))
528 mutex_lock(&acpi_pm_notifier_lock);
529 adev->wakeup.ws = wakeup_source_register(&adev->dev,
530 dev_name(&adev->dev));
531 adev->wakeup.context.dev = dev;
532 adev->wakeup.context.func = func;
533 adev->wakeup.flags.notifier_present = true;
534 mutex_unlock(&acpi_pm_notifier_lock);
537 mutex_unlock(&acpi_pm_notifier_install_lock);
542 * acpi_remove_pm_notifier - Unregister PM notifier from given ACPI device.
543 * @adev: ACPI device to remove the notifier from.
545 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
547 acpi_status status = AE_BAD_PARAMETER;
549 mutex_lock(&acpi_pm_notifier_install_lock);
551 if (!adev->wakeup.flags.notifier_present)
554 status = acpi_remove_notify_handler(adev->handle,
556 acpi_pm_notify_handler);
557 if (ACPI_FAILURE(status))
560 mutex_lock(&acpi_pm_notifier_lock);
561 adev->wakeup.context.func = NULL;
562 adev->wakeup.context.dev = NULL;
563 wakeup_source_unregister(adev->wakeup.ws);
564 adev->wakeup.flags.notifier_present = false;
565 mutex_unlock(&acpi_pm_notifier_lock);
568 mutex_unlock(&acpi_pm_notifier_install_lock);
572 bool acpi_bus_can_wakeup(acpi_handle handle)
574 struct acpi_device *device = acpi_fetch_acpi_dev(handle);
576 return device && device->wakeup.flags.valid;
578 EXPORT_SYMBOL(acpi_bus_can_wakeup);
580 bool acpi_pm_device_can_wakeup(struct device *dev)
582 struct acpi_device *adev = ACPI_COMPANION(dev);
584 return adev ? acpi_device_can_wakeup(adev) : false;
588 * acpi_dev_pm_get_state - Get preferred power state of ACPI device.
589 * @dev: Device whose preferred target power state to return.
590 * @adev: ACPI device node corresponding to @dev.
591 * @target_state: System state to match the resultant device state.
592 * @d_min_p: Location to store the highest power state available to the device.
593 * @d_max_p: Location to store the lowest power state available to the device.
595 * Find the lowest power (highest number) and highest power (lowest number) ACPI
596 * device power states that the device can be in while the system is in the
597 * state represented by @target_state. Store the integer numbers representing
598 * those stats in the memory locations pointed to by @d_max_p and @d_min_p,
601 * Callers must ensure that @dev and @adev are valid pointers and that @adev
602 * actually corresponds to @dev before using this function.
604 * Returns 0 on success or -ENODATA when one of the ACPI methods fails or
605 * returns a value that doesn't make sense. The memory locations pointed to by
606 * @d_max_p and @d_min_p are only modified on success.
608 static int acpi_dev_pm_get_state(struct device *dev, struct acpi_device *adev,
609 u32 target_state, int *d_min_p, int *d_max_p)
611 char method[] = { '_', 'S', '0' + target_state, 'D', '\0' };
612 acpi_handle handle = adev->handle;
613 unsigned long long ret;
616 bool has_sxd = false;
620 * If the system state is S0, the lowest power state the device can be
621 * in is D3cold, unless the device has _S0W and is supposed to signal
622 * wakeup, in which case the return value of _S0W has to be used as the
623 * lowest power state available to the device.
625 d_min = ACPI_STATE_D0;
626 d_max = ACPI_STATE_D3_COLD;
629 * If present, _SxD methods return the minimum D-state (highest power
630 * state) we can use for the corresponding S-states. Otherwise, the
631 * minimum D-state is D0 (ACPI 3.x).
633 if (target_state > ACPI_STATE_S0) {
635 * We rely on acpi_evaluate_integer() not clobbering the integer
636 * provided if AE_NOT_FOUND is returned.
639 status = acpi_evaluate_integer(handle, method, NULL, &ret);
640 if ((ACPI_FAILURE(status) && status != AE_NOT_FOUND)
641 || ret > ACPI_STATE_D3_COLD)
645 * We need to handle legacy systems where D3hot and D3cold are
646 * the same and 3 is returned in both cases, so fall back to
647 * D3cold if D3hot is not a valid state.
649 if (!adev->power.states[ret].flags.valid) {
650 if (ret == ACPI_STATE_D3_HOT)
651 ret = ACPI_STATE_D3_COLD;
660 wakeup = device_may_wakeup(dev) && adev->wakeup.flags.valid
661 && adev->wakeup.sleep_state >= target_state;
663 wakeup = adev->wakeup.flags.valid;
667 * If _PRW says we can wake up the system from the target sleep state,
668 * the D-state returned by _SxD is sufficient for that (we assume a
669 * wakeup-aware driver if wake is set). Still, if _SxW exists
670 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
671 * can wake the system. _S0W may be valid, too.
675 status = acpi_evaluate_integer(handle, method, NULL, &ret);
676 if (status == AE_NOT_FOUND) {
677 /* No _SxW. In this case, the ACPI spec says that we
678 * must not go into any power state deeper than the
679 * value returned from _SxD.
681 if (has_sxd && target_state > ACPI_STATE_S0)
683 } else if (ACPI_SUCCESS(status) && ret <= ACPI_STATE_D3_COLD) {
684 /* Fall back to D3cold if ret is not a valid state. */
685 if (!adev->power.states[ret].flags.valid)
686 ret = ACPI_STATE_D3_COLD;
688 d_max = ret > d_min ? ret : d_min;
704 * acpi_pm_device_sleep_state - Get preferred power state of ACPI device.
705 * @dev: Device whose preferred target power state to return.
706 * @d_min_p: Location to store the upper limit of the allowed states range.
707 * @d_max_in: Deepest low-power state to take into consideration.
708 * Return value: Preferred power state of the device on success, -ENODEV
709 * if there's no 'struct acpi_device' for @dev, -EINVAL if @d_max_in is
710 * incorrect, or -ENODATA on ACPI method failure.
712 * The caller must ensure that @dev is valid before using this function.
714 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p, int d_max_in)
716 struct acpi_device *adev;
717 int ret, d_min, d_max;
719 if (d_max_in < ACPI_STATE_D0 || d_max_in > ACPI_STATE_D3_COLD)
722 if (d_max_in > ACPI_STATE_D2) {
723 enum pm_qos_flags_status stat;
725 stat = dev_pm_qos_flags(dev, PM_QOS_FLAG_NO_POWER_OFF);
726 if (stat == PM_QOS_FLAGS_ALL)
727 d_max_in = ACPI_STATE_D2;
730 adev = ACPI_COMPANION(dev);
732 dev_dbg(dev, "ACPI companion missing in %s!\n", __func__);
736 ret = acpi_dev_pm_get_state(dev, adev, acpi_target_system_state(),
741 if (d_max_in < d_min)
744 if (d_max > d_max_in) {
745 for (d_max = d_max_in; d_max > d_min; d_max--) {
746 if (adev->power.states[d_max].flags.valid)
756 EXPORT_SYMBOL(acpi_pm_device_sleep_state);
759 * acpi_pm_notify_work_func - ACPI devices wakeup notification work function.
760 * @context: Device wakeup context.
762 static void acpi_pm_notify_work_func(struct acpi_device_wakeup_context *context)
764 struct device *dev = context->dev;
767 pm_wakeup_event(dev, 0);
768 pm_request_resume(dev);
772 static DEFINE_MUTEX(acpi_wakeup_lock);
774 static int __acpi_device_wakeup_enable(struct acpi_device *adev,
777 struct acpi_device_wakeup *wakeup = &adev->wakeup;
781 mutex_lock(&acpi_wakeup_lock);
784 * If the device wakeup power is already enabled, disable it and enable
785 * it again in case it depends on the configuration of subordinate
786 * devices and the conditions have changed since it was enabled last
789 if (wakeup->enable_count > 0)
790 acpi_disable_wakeup_device_power(adev);
792 error = acpi_enable_wakeup_device_power(adev, target_state);
794 if (wakeup->enable_count > 0) {
795 acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number);
796 wakeup->enable_count = 0;
801 if (wakeup->enable_count > 0)
804 status = acpi_enable_gpe(wakeup->gpe_device, wakeup->gpe_number);
805 if (ACPI_FAILURE(status)) {
806 acpi_disable_wakeup_device_power(adev);
811 acpi_handle_debug(adev->handle, "GPE%2X enabled for wakeup\n",
812 (unsigned int)wakeup->gpe_number);
815 if (wakeup->enable_count < INT_MAX)
816 wakeup->enable_count++;
818 acpi_handle_info(adev->handle, "Wakeup enable count out of bounds!\n");
821 mutex_unlock(&acpi_wakeup_lock);
826 * acpi_device_wakeup_enable - Enable wakeup functionality for device.
827 * @adev: ACPI device to enable wakeup functionality for.
828 * @target_state: State the system is transitioning into.
830 * Enable the GPE associated with @adev so that it can generate wakeup signals
831 * for the device in response to external (remote) events and enable wakeup
834 * Callers must ensure that @adev is a valid ACPI device node before executing
837 static int acpi_device_wakeup_enable(struct acpi_device *adev, u32 target_state)
839 return __acpi_device_wakeup_enable(adev, target_state);
843 * acpi_device_wakeup_disable - Disable wakeup functionality for device.
844 * @adev: ACPI device to disable wakeup functionality for.
846 * Disable the GPE associated with @adev and disable wakeup power for it.
848 * Callers must ensure that @adev is a valid ACPI device node before executing
851 static void acpi_device_wakeup_disable(struct acpi_device *adev)
853 struct acpi_device_wakeup *wakeup = &adev->wakeup;
855 mutex_lock(&acpi_wakeup_lock);
857 if (!wakeup->enable_count)
860 acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number);
861 acpi_disable_wakeup_device_power(adev);
863 wakeup->enable_count--;
866 mutex_unlock(&acpi_wakeup_lock);
870 * acpi_pm_set_device_wakeup - Enable/disable remote wakeup for given device.
871 * @dev: Device to enable/disable to generate wakeup events.
872 * @enable: Whether to enable or disable the wakeup functionality.
874 int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
876 struct acpi_device *adev;
879 adev = ACPI_COMPANION(dev);
881 dev_dbg(dev, "ACPI companion missing in %s!\n", __func__);
885 if (!acpi_device_can_wakeup(adev))
889 acpi_device_wakeup_disable(adev);
890 dev_dbg(dev, "Wakeup disabled by ACPI\n");
894 error = __acpi_device_wakeup_enable(adev, acpi_target_system_state());
896 dev_dbg(dev, "Wakeup enabled by ACPI\n");
900 EXPORT_SYMBOL_GPL(acpi_pm_set_device_wakeup);
903 * acpi_dev_pm_low_power - Put ACPI device into a low-power state.
904 * @dev: Device to put into a low-power state.
905 * @adev: ACPI device node corresponding to @dev.
906 * @system_state: System state to choose the device state for.
908 static int acpi_dev_pm_low_power(struct device *dev, struct acpi_device *adev,
913 if (!acpi_device_power_manageable(adev))
916 ret = acpi_dev_pm_get_state(dev, adev, system_state, NULL, &state);
917 return ret ? ret : acpi_device_set_power(adev, state);
921 * acpi_dev_pm_full_power - Put ACPI device into the full-power state.
922 * @adev: ACPI device node to put into the full-power state.
924 static int acpi_dev_pm_full_power(struct acpi_device *adev)
926 return acpi_device_power_manageable(adev) ?
927 acpi_device_set_power(adev, ACPI_STATE_D0) : 0;
931 * acpi_dev_suspend - Put device into a low-power state using ACPI.
932 * @dev: Device to put into a low-power state.
933 * @wakeup: Whether or not to enable wakeup for the device.
935 * Put the given device into a low-power state using the standard ACPI
936 * mechanism. Set up remote wakeup if desired, choose the state to put the
937 * device into (this checks if remote wakeup is expected to work too), and set
938 * the power state of the device.
940 int acpi_dev_suspend(struct device *dev, bool wakeup)
942 struct acpi_device *adev = ACPI_COMPANION(dev);
943 u32 target_state = acpi_target_system_state();
949 if (wakeup && acpi_device_can_wakeup(adev)) {
950 error = acpi_device_wakeup_enable(adev, target_state);
957 error = acpi_dev_pm_low_power(dev, adev, target_state);
959 acpi_device_wakeup_disable(adev);
963 EXPORT_SYMBOL_GPL(acpi_dev_suspend);
966 * acpi_dev_resume - Put device into the full-power state using ACPI.
967 * @dev: Device to put into the full-power state.
969 * Put the given device into the full-power state using the standard ACPI
970 * mechanism. Set the power state of the device to ACPI D0 and disable wakeup.
972 int acpi_dev_resume(struct device *dev)
974 struct acpi_device *adev = ACPI_COMPANION(dev);
980 error = acpi_dev_pm_full_power(adev);
981 acpi_device_wakeup_disable(adev);
984 EXPORT_SYMBOL_GPL(acpi_dev_resume);
987 * acpi_subsys_runtime_suspend - Suspend device using ACPI.
988 * @dev: Device to suspend.
990 * Carry out the generic runtime suspend procedure for @dev and use ACPI to put
991 * it into a runtime low-power state.
993 int acpi_subsys_runtime_suspend(struct device *dev)
995 int ret = pm_generic_runtime_suspend(dev);
997 return ret ? ret : acpi_dev_suspend(dev, true);
999 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_suspend);
1002 * acpi_subsys_runtime_resume - Resume device using ACPI.
1003 * @dev: Device to Resume.
1005 * Use ACPI to put the given device into the full-power state and carry out the
1006 * generic runtime resume procedure for it.
1008 int acpi_subsys_runtime_resume(struct device *dev)
1010 int ret = acpi_dev_resume(dev);
1012 return ret ? ret : pm_generic_runtime_resume(dev);
1014 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_resume);
1016 #ifdef CONFIG_PM_SLEEP
1017 static bool acpi_dev_needs_resume(struct device *dev, struct acpi_device *adev)
1019 u32 sys_target = acpi_target_system_state();
1022 if (!pm_runtime_suspended(dev) || !adev || (adev->wakeup.flags.valid &&
1023 device_may_wakeup(dev) != !!adev->wakeup.prepare_count))
1026 if (sys_target == ACPI_STATE_S0)
1029 if (adev->power.flags.dsw_present)
1032 ret = acpi_dev_pm_get_state(dev, adev, sys_target, NULL, &state);
1036 return state != adev->power.state;
1040 * acpi_subsys_prepare - Prepare device for system transition to a sleep state.
1041 * @dev: Device to prepare.
1043 int acpi_subsys_prepare(struct device *dev)
1045 struct acpi_device *adev = ACPI_COMPANION(dev);
1047 if (dev->driver && dev->driver->pm && dev->driver->pm->prepare) {
1048 int ret = dev->driver->pm->prepare(dev);
1053 if (!ret && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
1057 return !acpi_dev_needs_resume(dev, adev);
1059 EXPORT_SYMBOL_GPL(acpi_subsys_prepare);
1062 * acpi_subsys_complete - Finalize device's resume during system resume.
1063 * @dev: Device to handle.
1065 void acpi_subsys_complete(struct device *dev)
1067 pm_generic_complete(dev);
1069 * If the device had been runtime-suspended before the system went into
1070 * the sleep state it is going out of and it has never been resumed till
1071 * now, resume it in case the firmware powered it up.
1073 if (pm_runtime_suspended(dev) && pm_resume_via_firmware())
1074 pm_request_resume(dev);
1076 EXPORT_SYMBOL_GPL(acpi_subsys_complete);
1079 * acpi_subsys_suspend - Run the device driver's suspend callback.
1080 * @dev: Device to handle.
1082 * Follow PCI and resume devices from runtime suspend before running their
1083 * system suspend callbacks, unless the driver can cope with runtime-suspended
1084 * devices during system suspend and there are no ACPI-specific reasons for
1087 int acpi_subsys_suspend(struct device *dev)
1089 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1090 acpi_dev_needs_resume(dev, ACPI_COMPANION(dev)))
1091 pm_runtime_resume(dev);
1093 return pm_generic_suspend(dev);
1095 EXPORT_SYMBOL_GPL(acpi_subsys_suspend);
1098 * acpi_subsys_suspend_late - Suspend device using ACPI.
1099 * @dev: Device to suspend.
1101 * Carry out the generic late suspend procedure for @dev and use ACPI to put
1102 * it into a low-power state during system transition into a sleep state.
1104 int acpi_subsys_suspend_late(struct device *dev)
1108 if (dev_pm_skip_suspend(dev))
1111 ret = pm_generic_suspend_late(dev);
1112 return ret ? ret : acpi_dev_suspend(dev, device_may_wakeup(dev));
1114 EXPORT_SYMBOL_GPL(acpi_subsys_suspend_late);
1117 * acpi_subsys_suspend_noirq - Run the device driver's "noirq" suspend callback.
1118 * @dev: Device to suspend.
1120 int acpi_subsys_suspend_noirq(struct device *dev)
1124 if (dev_pm_skip_suspend(dev))
1127 ret = pm_generic_suspend_noirq(dev);
1132 * If the target system sleep state is suspend-to-idle, it is sufficient
1133 * to check whether or not the device's wakeup settings are good for
1134 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
1135 * acpi_subsys_complete() to take care of fixing up the device's state
1136 * anyway, if need be.
1138 if (device_can_wakeup(dev) && !device_may_wakeup(dev))
1139 dev->power.may_skip_resume = false;
1143 EXPORT_SYMBOL_GPL(acpi_subsys_suspend_noirq);
1146 * acpi_subsys_resume_noirq - Run the device driver's "noirq" resume callback.
1147 * @dev: Device to handle.
1149 static int acpi_subsys_resume_noirq(struct device *dev)
1151 if (dev_pm_skip_resume(dev))
1154 return pm_generic_resume_noirq(dev);
1158 * acpi_subsys_resume_early - Resume device using ACPI.
1159 * @dev: Device to Resume.
1161 * Use ACPI to put the given device into the full-power state and carry out the
1162 * generic early resume procedure for it during system transition into the
1163 * working state, but only do that if device either defines early resume
1164 * handler, or does not define power operations at all. Otherwise powering up
1165 * of the device is postponed to the normal resume phase.
1167 static int acpi_subsys_resume_early(struct device *dev)
1169 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1172 if (dev_pm_skip_resume(dev))
1175 if (pm && !pm->resume_early) {
1176 dev_dbg(dev, "postponing D0 transition to normal resume stage\n");
1180 ret = acpi_dev_resume(dev);
1181 return ret ? ret : pm_generic_resume_early(dev);
1185 * acpi_subsys_resume - Resume device using ACPI.
1186 * @dev: Device to Resume.
1188 * Use ACPI to put the given device into the full-power state if it has not been
1189 * powered up during early resume phase, and carry out the generic resume
1190 * procedure for it during system transition into the working state.
1192 static int acpi_subsys_resume(struct device *dev)
1194 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1197 if (!dev_pm_skip_resume(dev) && pm && !pm->resume_early) {
1198 dev_dbg(dev, "executing postponed D0 transition\n");
1199 ret = acpi_dev_resume(dev);
1202 return ret ? ret : pm_generic_resume(dev);
1206 * acpi_subsys_freeze - Run the device driver's freeze callback.
1207 * @dev: Device to handle.
1209 int acpi_subsys_freeze(struct device *dev)
1212 * Resume all runtime-suspended devices before creating a snapshot
1213 * image of system memory, because the restore kernel generally cannot
1214 * be expected to always handle them consistently and they need to be
1215 * put into the runtime-active metastate during system resume anyway,
1216 * so it is better to ensure that the state saved in the image will be
1217 * always consistent with that.
1219 pm_runtime_resume(dev);
1221 return pm_generic_freeze(dev);
1223 EXPORT_SYMBOL_GPL(acpi_subsys_freeze);
1226 * acpi_subsys_restore_early - Restore device using ACPI.
1227 * @dev: Device to restore.
1229 int acpi_subsys_restore_early(struct device *dev)
1231 int ret = acpi_dev_resume(dev);
1233 return ret ? ret : pm_generic_restore_early(dev);
1235 EXPORT_SYMBOL_GPL(acpi_subsys_restore_early);
1238 * acpi_subsys_poweroff - Run the device driver's poweroff callback.
1239 * @dev: Device to handle.
1241 * Follow PCI and resume devices from runtime suspend before running their
1242 * system poweroff callbacks, unless the driver can cope with runtime-suspended
1243 * devices during system suspend and there are no ACPI-specific reasons for
1246 int acpi_subsys_poweroff(struct device *dev)
1248 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1249 acpi_dev_needs_resume(dev, ACPI_COMPANION(dev)))
1250 pm_runtime_resume(dev);
1252 return pm_generic_poweroff(dev);
1254 EXPORT_SYMBOL_GPL(acpi_subsys_poweroff);
1257 * acpi_subsys_poweroff_late - Run the device driver's poweroff callback.
1258 * @dev: Device to handle.
1260 * Carry out the generic late poweroff procedure for @dev and use ACPI to put
1261 * it into a low-power state during system transition into a sleep state.
1263 static int acpi_subsys_poweroff_late(struct device *dev)
1267 if (dev_pm_skip_suspend(dev))
1270 ret = pm_generic_poweroff_late(dev);
1274 return acpi_dev_suspend(dev, device_may_wakeup(dev));
1278 * acpi_subsys_poweroff_noirq - Run the driver's "noirq" poweroff callback.
1279 * @dev: Device to suspend.
1281 static int acpi_subsys_poweroff_noirq(struct device *dev)
1283 if (dev_pm_skip_suspend(dev))
1286 return pm_generic_poweroff_noirq(dev);
1288 #endif /* CONFIG_PM_SLEEP */
1290 static struct dev_pm_domain acpi_general_pm_domain = {
1292 .runtime_suspend = acpi_subsys_runtime_suspend,
1293 .runtime_resume = acpi_subsys_runtime_resume,
1294 #ifdef CONFIG_PM_SLEEP
1295 .prepare = acpi_subsys_prepare,
1296 .complete = acpi_subsys_complete,
1297 .suspend = acpi_subsys_suspend,
1298 .resume = acpi_subsys_resume,
1299 .suspend_late = acpi_subsys_suspend_late,
1300 .suspend_noirq = acpi_subsys_suspend_noirq,
1301 .resume_noirq = acpi_subsys_resume_noirq,
1302 .resume_early = acpi_subsys_resume_early,
1303 .freeze = acpi_subsys_freeze,
1304 .poweroff = acpi_subsys_poweroff,
1305 .poweroff_late = acpi_subsys_poweroff_late,
1306 .poweroff_noirq = acpi_subsys_poweroff_noirq,
1307 .restore_early = acpi_subsys_restore_early,
1313 * acpi_dev_pm_detach - Remove ACPI power management from the device.
1314 * @dev: Device to take care of.
1315 * @power_off: Whether or not to try to remove power from the device.
1317 * Remove the device from the general ACPI PM domain and remove its wakeup
1318 * notifier. If @power_off is set, additionally remove power from the device if
1321 * Callers must ensure proper synchronization of this function with power
1322 * management callbacks.
1324 static void acpi_dev_pm_detach(struct device *dev, bool power_off)
1326 struct acpi_device *adev = ACPI_COMPANION(dev);
1328 if (adev && dev->pm_domain == &acpi_general_pm_domain) {
1329 dev_pm_domain_set(dev, NULL);
1330 acpi_remove_pm_notifier(adev);
1333 * If the device's PM QoS resume latency limit or flags
1334 * have been exposed to user space, they have to be
1335 * hidden at this point, so that they don't affect the
1336 * choice of the low-power state to put the device into.
1338 dev_pm_qos_hide_latency_limit(dev);
1339 dev_pm_qos_hide_flags(dev);
1340 acpi_device_wakeup_disable(adev);
1341 acpi_dev_pm_low_power(dev, adev, ACPI_STATE_S0);
1347 * acpi_dev_pm_attach - Prepare device for ACPI power management.
1348 * @dev: Device to prepare.
1349 * @power_on: Whether or not to power on the device.
1351 * If @dev has a valid ACPI handle that has a valid struct acpi_device object
1352 * attached to it, install a wakeup notification handler for the device and
1353 * add it to the general ACPI PM domain. If @power_on is set, the device will
1354 * be put into the ACPI D0 state before the function returns.
1356 * This assumes that the @dev's bus type uses generic power management callbacks
1357 * (or doesn't use any power management callbacks at all).
1359 * Callers must ensure proper synchronization of this function with power
1360 * management callbacks.
1362 int acpi_dev_pm_attach(struct device *dev, bool power_on)
1365 * Skip devices whose ACPI companions match the device IDs below,
1366 * because they require special power management handling incompatible
1367 * with the generic ACPI PM domain.
1369 static const struct acpi_device_id special_pm_ids[] = {
1370 ACPI_FAN_DEVICE_IDS,
1373 struct acpi_device *adev = ACPI_COMPANION(dev);
1375 if (!adev || !acpi_match_device_ids(adev, special_pm_ids))
1379 * Only attach the power domain to the first device if the
1380 * companion is shared by multiple. This is to prevent doing power
1383 if (!acpi_device_is_first_physical_node(adev, dev))
1386 acpi_add_pm_notifier(adev, dev, acpi_pm_notify_work_func);
1387 dev_pm_domain_set(dev, &acpi_general_pm_domain);
1389 acpi_dev_pm_full_power(adev);
1390 acpi_device_wakeup_disable(adev);
1393 dev->pm_domain->detach = acpi_dev_pm_detach;
1396 EXPORT_SYMBOL_GPL(acpi_dev_pm_attach);
1399 * acpi_storage_d3 - Check if D3 should be used in the suspend path
1400 * @dev: Device to check
1402 * Return %true if the platform firmware wants @dev to be programmed
1403 * into D3hot or D3cold (if supported) in the suspend path, or %false
1404 * when there is no specific preference. On some platforms, if this
1405 * hint is ignored, @dev may remain unresponsive after suspending the
1406 * platform as a whole.
1408 * Although the property has storage in the name it actually is
1409 * applied to the PCIe slot and plugging in a non-storage device the
1410 * same platform restrictions will likely apply.
1412 bool acpi_storage_d3(struct device *dev)
1414 struct acpi_device *adev = ACPI_COMPANION(dev);
1417 if (force_storage_d3())
1422 if (fwnode_property_read_u8(acpi_fwnode_handle(adev), "StorageD3Enable",
1427 EXPORT_SYMBOL_GPL(acpi_storage_d3);
1430 * acpi_dev_state_d0 - Tell if the device is in D0 power state
1431 * @dev: Physical device the ACPI power state of which to check
1433 * On a system without ACPI, return true. On a system with ACPI, return true if
1434 * the current ACPI power state of the device is D0, or false otherwise.
1436 * Note that the power state of a device is not well-defined after it has been
1437 * passed to acpi_device_set_power() and before that function returns, so it is
1438 * not valid to ask for the ACPI power state of the device in that time frame.
1440 * This function is intended to be used in a driver's probe or remove
1441 * function. See Documentation/firmware-guide/acpi/low-power-probe.rst for
1444 bool acpi_dev_state_d0(struct device *dev)
1446 struct acpi_device *adev = ACPI_COMPANION(dev);
1451 return adev->power.state == ACPI_STATE_D0;
1453 EXPORT_SYMBOL_GPL(acpi_dev_state_d0);
1455 #endif /* CONFIG_PM */