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) "ACPI: 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>
26 * acpi_power_state_string - String representation of ACPI device power state.
27 * @state: ACPI device power state to return the string representation of.
29 const char *acpi_power_state_string(int state)
38 case ACPI_STATE_D3_HOT:
40 case ACPI_STATE_D3_COLD:
47 static int acpi_dev_pm_explicit_get(struct acpi_device *device, int *state)
49 unsigned long long psc;
52 status = acpi_evaluate_integer(device->handle, "_PSC", NULL, &psc);
53 if (ACPI_FAILURE(status))
61 * acpi_device_get_power - Get power state of an ACPI device.
62 * @device: Device to get the power state of.
63 * @state: Place to store the power state of the device.
65 * This function does not update the device's power.state field, but it may
66 * update its parent's power.state field (when the parent's power state is
67 * unknown and the device's power state turns out to be D0).
69 * Also, it does not update power resource reference counters to ensure that
70 * the power state returned by it will be persistent and it may return a power
71 * state shallower than previously set by acpi_device_set_power() for @device
72 * (if that power state depends on any power resources).
74 int acpi_device_get_power(struct acpi_device *device, int *state)
76 int result = ACPI_STATE_UNKNOWN;
79 if (!device || !state)
82 if (!device->flags.power_manageable) {
83 /* TBD: Non-recursive algorithm for walking up hierarchy. */
84 *state = device->parent ?
85 device->parent->power.state : ACPI_STATE_D0;
90 * Get the device's power state from power resources settings and _PSC,
93 if (device->power.flags.power_resources) {
94 error = acpi_power_get_inferred_state(device, &result);
98 if (device->power.flags.explicit_get) {
101 error = acpi_dev_pm_explicit_get(device, &psc);
106 * The power resources settings may indicate a power state
107 * shallower than the actual power state of the device, because
108 * the same power resources may be referenced by other devices.
110 * For systems predating ACPI 4.0 we assume that D3hot is the
111 * deepest state that can be supported.
113 if (psc > result && psc < ACPI_STATE_D3_COLD)
115 else if (result == ACPI_STATE_UNKNOWN)
116 result = psc > ACPI_STATE_D2 ? ACPI_STATE_D3_HOT : psc;
120 * If we were unsure about the device parent's power state up to this
121 * point, the fact that the device is in D0 implies that the parent has
122 * to be in D0 too, except if ignore_parent is set.
124 if (!device->power.flags.ignore_parent && device->parent
125 && device->parent->power.state == ACPI_STATE_UNKNOWN
126 && result == ACPI_STATE_D0)
127 device->parent->power.state = ACPI_STATE_D0;
132 dev_dbg(&device->dev, "Device power state is %s\n",
133 acpi_power_state_string(*state));
138 static int acpi_dev_pm_explicit_set(struct acpi_device *adev, int state)
140 if (adev->power.states[state].flags.explicit_set) {
141 char method[5] = { '_', 'P', 'S', '0' + state, '\0' };
144 status = acpi_evaluate_object(adev->handle, method, NULL, NULL);
145 if (ACPI_FAILURE(status))
152 * acpi_device_set_power - Set power state of an ACPI device.
153 * @device: Device to set the power state of.
154 * @state: New power state to set.
156 * Callers must ensure that the device is power manageable before using this
159 int acpi_device_set_power(struct acpi_device *device, int state)
161 int target_state = state;
164 if (!device || !device->flags.power_manageable
165 || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
168 acpi_handle_debug(device->handle, "Power state change: %s -> %s\n",
169 acpi_power_state_string(device->power.state),
170 acpi_power_state_string(state));
172 /* Make sure this is a valid target state */
174 /* There is a special case for D0 addressed below. */
175 if (state > ACPI_STATE_D0 && state == device->power.state) {
176 dev_dbg(&device->dev, "Device already in %s\n",
177 acpi_power_state_string(state));
181 if (state == ACPI_STATE_D3_COLD) {
183 * For transitions to D3cold we need to execute _PS3 and then
184 * possibly drop references to the power resources in use.
186 state = ACPI_STATE_D3_HOT;
187 /* If D3cold is not supported, use D3hot as the target state. */
188 if (!device->power.states[ACPI_STATE_D3_COLD].flags.valid)
189 target_state = state;
190 } else if (!device->power.states[state].flags.valid) {
191 dev_warn(&device->dev, "Power state %s not supported\n",
192 acpi_power_state_string(state));
196 if (!device->power.flags.ignore_parent &&
197 device->parent && (state < device->parent->power.state)) {
198 dev_warn(&device->dev,
199 "Cannot transition to power state %s for parent in %s\n",
200 acpi_power_state_string(state),
201 acpi_power_state_string(device->parent->power.state));
208 * In accordance with ACPI 6, _PSx is executed before manipulating power
209 * resources, unless the target state is D0, in which case _PS0 is
210 * supposed to be executed after turning the power resources on.
212 if (state > ACPI_STATE_D0) {
214 * According to ACPI 6, devices cannot go from lower-power
215 * (deeper) states to higher-power (shallower) states.
217 if (state < device->power.state) {
218 dev_warn(&device->dev, "Cannot transition from %s to %s\n",
219 acpi_power_state_string(device->power.state),
220 acpi_power_state_string(state));
225 * If the device goes from D3hot to D3cold, _PS3 has been
226 * evaluated for it already, so skip it in that case.
228 if (device->power.state < ACPI_STATE_D3_HOT) {
229 result = acpi_dev_pm_explicit_set(device, state);
234 if (device->power.flags.power_resources)
235 result = acpi_power_transition(device, target_state);
237 int cur_state = device->power.state;
239 if (device->power.flags.power_resources) {
240 result = acpi_power_transition(device, ACPI_STATE_D0);
245 if (cur_state == ACPI_STATE_D0) {
248 /* Nothing to do here if _PSC is not present. */
249 if (!device->power.flags.explicit_get)
253 * The power state of the device was set to D0 last
254 * time, but that might have happened before a
255 * system-wide transition involving the platform
256 * firmware, so it may be necessary to evaluate _PS0
257 * for the device here. However, use extra care here
258 * and evaluate _PSC to check the device's current power
259 * state, and only invoke _PS0 if the evaluation of _PSC
260 * is successful and it returns a power state different
263 result = acpi_dev_pm_explicit_get(device, &psc);
264 if (result || psc == ACPI_STATE_D0)
268 result = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0);
273 dev_warn(&device->dev, "Failed to change power state to %s\n",
274 acpi_power_state_string(target_state));
276 device->power.state = target_state;
277 dev_dbg(&device->dev, "Power state changed to %s\n",
278 acpi_power_state_string(target_state));
283 EXPORT_SYMBOL(acpi_device_set_power);
285 int acpi_bus_set_power(acpi_handle handle, int state)
287 struct acpi_device *device;
290 result = acpi_bus_get_device(handle, &device);
294 return acpi_device_set_power(device, state);
296 EXPORT_SYMBOL(acpi_bus_set_power);
298 int acpi_bus_init_power(struct acpi_device *device)
306 device->power.state = ACPI_STATE_UNKNOWN;
307 if (!acpi_device_is_present(device)) {
308 device->flags.initialized = false;
312 result = acpi_device_get_power(device, &state);
316 if (state < ACPI_STATE_D3_COLD && device->power.flags.power_resources) {
317 /* Reference count the power resources. */
318 result = acpi_power_on_resources(device, state);
322 if (state == ACPI_STATE_D0) {
324 * If _PSC is not present and the state inferred from
325 * power resources appears to be D0, it still may be
326 * necessary to execute _PS0 at this point, because
327 * another device using the same power resources may
328 * have been put into D0 previously and that's why we
331 result = acpi_dev_pm_explicit_set(device, state);
335 } else if (state == ACPI_STATE_UNKNOWN) {
337 * No power resources and missing _PSC? Cross fingers and make
338 * it D0 in hope that this is what the BIOS put the device into.
339 * [We tried to force D0 here by executing _PS0, but that broke
340 * Toshiba P870-303 in a nasty way.]
342 state = ACPI_STATE_D0;
344 device->power.state = state;
349 * acpi_device_fix_up_power - Force device with missing _PSC into D0.
350 * @device: Device object whose power state is to be fixed up.
352 * Devices without power resources and _PSC, but having _PS0 and _PS3 defined,
353 * are assumed to be put into D0 by the BIOS. However, in some cases that may
354 * not be the case and this function should be used then.
356 int acpi_device_fix_up_power(struct acpi_device *device)
360 if (!device->power.flags.power_resources
361 && !device->power.flags.explicit_get
362 && device->power.state == ACPI_STATE_D0)
363 ret = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0);
367 EXPORT_SYMBOL_GPL(acpi_device_fix_up_power);
369 int acpi_device_update_power(struct acpi_device *device, int *state_p)
374 if (device->power.state == ACPI_STATE_UNKNOWN) {
375 result = acpi_bus_init_power(device);
376 if (!result && state_p)
377 *state_p = device->power.state;
382 result = acpi_device_get_power(device, &state);
386 if (state == ACPI_STATE_UNKNOWN) {
387 state = ACPI_STATE_D0;
388 result = acpi_device_set_power(device, state);
392 if (device->power.flags.power_resources) {
394 * We don't need to really switch the state, bu we need
395 * to update the power resources' reference counters.
397 result = acpi_power_transition(device, state);
401 device->power.state = state;
408 EXPORT_SYMBOL_GPL(acpi_device_update_power);
410 int acpi_bus_update_power(acpi_handle handle, int *state_p)
412 struct acpi_device *device;
415 result = acpi_bus_get_device(handle, &device);
416 return result ? result : acpi_device_update_power(device, state_p);
418 EXPORT_SYMBOL_GPL(acpi_bus_update_power);
420 bool acpi_bus_power_manageable(acpi_handle handle)
422 struct acpi_device *device;
425 result = acpi_bus_get_device(handle, &device);
426 return result ? false : device->flags.power_manageable;
428 EXPORT_SYMBOL(acpi_bus_power_manageable);
431 static DEFINE_MUTEX(acpi_pm_notifier_lock);
432 static DEFINE_MUTEX(acpi_pm_notifier_install_lock);
434 void acpi_pm_wakeup_event(struct device *dev)
436 pm_wakeup_dev_event(dev, 0, acpi_s2idle_wakeup());
438 EXPORT_SYMBOL_GPL(acpi_pm_wakeup_event);
440 static void acpi_pm_notify_handler(acpi_handle handle, u32 val, void *not_used)
442 struct acpi_device *adev;
444 if (val != ACPI_NOTIFY_DEVICE_WAKE)
447 acpi_handle_debug(handle, "Wake notify\n");
449 adev = acpi_bus_get_acpi_device(handle);
453 mutex_lock(&acpi_pm_notifier_lock);
455 if (adev->wakeup.flags.notifier_present) {
456 pm_wakeup_ws_event(adev->wakeup.ws, 0, acpi_s2idle_wakeup());
457 if (adev->wakeup.context.func) {
458 acpi_handle_debug(handle, "Running %pS for %s\n",
459 adev->wakeup.context.func,
460 dev_name(adev->wakeup.context.dev));
461 adev->wakeup.context.func(&adev->wakeup.context);
465 mutex_unlock(&acpi_pm_notifier_lock);
467 acpi_bus_put_acpi_device(adev);
471 * acpi_add_pm_notifier - Register PM notify handler for given ACPI device.
472 * @adev: ACPI device to add the notify handler for.
473 * @dev: Device to generate a wakeup event for while handling the notification.
474 * @func: Work function to execute when handling the notification.
476 * NOTE: @adev need not be a run-wake or wakeup device to be a valid source of
477 * PM wakeup events. For example, wakeup events may be generated for bridges
478 * if one of the devices below the bridge is signaling wakeup, even if the
479 * bridge itself doesn't have a wakeup GPE associated with it.
481 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
482 void (*func)(struct acpi_device_wakeup_context *context))
484 acpi_status status = AE_ALREADY_EXISTS;
487 return AE_BAD_PARAMETER;
489 mutex_lock(&acpi_pm_notifier_install_lock);
491 if (adev->wakeup.flags.notifier_present)
494 status = acpi_install_notify_handler(adev->handle, ACPI_SYSTEM_NOTIFY,
495 acpi_pm_notify_handler, NULL);
496 if (ACPI_FAILURE(status))
499 mutex_lock(&acpi_pm_notifier_lock);
500 adev->wakeup.ws = wakeup_source_register(&adev->dev,
501 dev_name(&adev->dev));
502 adev->wakeup.context.dev = dev;
503 adev->wakeup.context.func = func;
504 adev->wakeup.flags.notifier_present = true;
505 mutex_unlock(&acpi_pm_notifier_lock);
508 mutex_unlock(&acpi_pm_notifier_install_lock);
513 * acpi_remove_pm_notifier - Unregister PM notifier from given ACPI device.
514 * @adev: ACPI device to remove the notifier from.
516 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
518 acpi_status status = AE_BAD_PARAMETER;
520 mutex_lock(&acpi_pm_notifier_install_lock);
522 if (!adev->wakeup.flags.notifier_present)
525 status = acpi_remove_notify_handler(adev->handle,
527 acpi_pm_notify_handler);
528 if (ACPI_FAILURE(status))
531 mutex_lock(&acpi_pm_notifier_lock);
532 adev->wakeup.context.func = NULL;
533 adev->wakeup.context.dev = NULL;
534 wakeup_source_unregister(adev->wakeup.ws);
535 adev->wakeup.flags.notifier_present = false;
536 mutex_unlock(&acpi_pm_notifier_lock);
539 mutex_unlock(&acpi_pm_notifier_install_lock);
543 bool acpi_bus_can_wakeup(acpi_handle handle)
545 struct acpi_device *device;
548 result = acpi_bus_get_device(handle, &device);
549 return result ? false : device->wakeup.flags.valid;
551 EXPORT_SYMBOL(acpi_bus_can_wakeup);
553 bool acpi_pm_device_can_wakeup(struct device *dev)
555 struct acpi_device *adev = ACPI_COMPANION(dev);
557 return adev ? acpi_device_can_wakeup(adev) : false;
561 * acpi_dev_pm_get_state - Get preferred power state of ACPI device.
562 * @dev: Device whose preferred target power state to return.
563 * @adev: ACPI device node corresponding to @dev.
564 * @target_state: System state to match the resultant device state.
565 * @d_min_p: Location to store the highest power state available to the device.
566 * @d_max_p: Location to store the lowest power state available to the device.
568 * Find the lowest power (highest number) and highest power (lowest number) ACPI
569 * device power states that the device can be in while the system is in the
570 * state represented by @target_state. Store the integer numbers representing
571 * those stats in the memory locations pointed to by @d_max_p and @d_min_p,
574 * Callers must ensure that @dev and @adev are valid pointers and that @adev
575 * actually corresponds to @dev before using this function.
577 * Returns 0 on success or -ENODATA when one of the ACPI methods fails or
578 * returns a value that doesn't make sense. The memory locations pointed to by
579 * @d_max_p and @d_min_p are only modified on success.
581 static int acpi_dev_pm_get_state(struct device *dev, struct acpi_device *adev,
582 u32 target_state, int *d_min_p, int *d_max_p)
584 char method[] = { '_', 'S', '0' + target_state, 'D', '\0' };
585 acpi_handle handle = adev->handle;
586 unsigned long long ret;
589 bool has_sxd = false;
593 * If the system state is S0, the lowest power state the device can be
594 * in is D3cold, unless the device has _S0W and is supposed to signal
595 * wakeup, in which case the return value of _S0W has to be used as the
596 * lowest power state available to the device.
598 d_min = ACPI_STATE_D0;
599 d_max = ACPI_STATE_D3_COLD;
602 * If present, _SxD methods return the minimum D-state (highest power
603 * state) we can use for the corresponding S-states. Otherwise, the
604 * minimum D-state is D0 (ACPI 3.x).
606 if (target_state > ACPI_STATE_S0) {
608 * We rely on acpi_evaluate_integer() not clobbering the integer
609 * provided if AE_NOT_FOUND is returned.
612 status = acpi_evaluate_integer(handle, method, NULL, &ret);
613 if ((ACPI_FAILURE(status) && status != AE_NOT_FOUND)
614 || ret > ACPI_STATE_D3_COLD)
618 * We need to handle legacy systems where D3hot and D3cold are
619 * the same and 3 is returned in both cases, so fall back to
620 * D3cold if D3hot is not a valid state.
622 if (!adev->power.states[ret].flags.valid) {
623 if (ret == ACPI_STATE_D3_HOT)
624 ret = ACPI_STATE_D3_COLD;
633 wakeup = device_may_wakeup(dev) && adev->wakeup.flags.valid
634 && adev->wakeup.sleep_state >= target_state;
636 wakeup = adev->wakeup.flags.valid;
640 * If _PRW says we can wake up the system from the target sleep state,
641 * the D-state returned by _SxD is sufficient for that (we assume a
642 * wakeup-aware driver if wake is set). Still, if _SxW exists
643 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
644 * can wake the system. _S0W may be valid, too.
648 status = acpi_evaluate_integer(handle, method, NULL, &ret);
649 if (status == AE_NOT_FOUND) {
650 /* No _SxW. In this case, the ACPI spec says that we
651 * must not go into any power state deeper than the
652 * value returned from _SxD.
654 if (has_sxd && target_state > ACPI_STATE_S0)
656 } else if (ACPI_SUCCESS(status) && ret <= ACPI_STATE_D3_COLD) {
657 /* Fall back to D3cold if ret is not a valid state. */
658 if (!adev->power.states[ret].flags.valid)
659 ret = ACPI_STATE_D3_COLD;
661 d_max = ret > d_min ? ret : d_min;
677 * acpi_pm_device_sleep_state - Get preferred power state of ACPI device.
678 * @dev: Device whose preferred target power state to return.
679 * @d_min_p: Location to store the upper limit of the allowed states range.
680 * @d_max_in: Deepest low-power state to take into consideration.
681 * Return value: Preferred power state of the device on success, -ENODEV
682 * if there's no 'struct acpi_device' for @dev, -EINVAL if @d_max_in is
683 * incorrect, or -ENODATA on ACPI method failure.
685 * The caller must ensure that @dev is valid before using this function.
687 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p, int d_max_in)
689 struct acpi_device *adev;
690 int ret, d_min, d_max;
692 if (d_max_in < ACPI_STATE_D0 || d_max_in > ACPI_STATE_D3_COLD)
695 if (d_max_in > ACPI_STATE_D2) {
696 enum pm_qos_flags_status stat;
698 stat = dev_pm_qos_flags(dev, PM_QOS_FLAG_NO_POWER_OFF);
699 if (stat == PM_QOS_FLAGS_ALL)
700 d_max_in = ACPI_STATE_D2;
703 adev = ACPI_COMPANION(dev);
705 dev_dbg(dev, "ACPI companion missing in %s!\n", __func__);
709 ret = acpi_dev_pm_get_state(dev, adev, acpi_target_system_state(),
714 if (d_max_in < d_min)
717 if (d_max > d_max_in) {
718 for (d_max = d_max_in; d_max > d_min; d_max--) {
719 if (adev->power.states[d_max].flags.valid)
729 EXPORT_SYMBOL(acpi_pm_device_sleep_state);
732 * acpi_pm_notify_work_func - ACPI devices wakeup notification work function.
733 * @context: Device wakeup context.
735 static void acpi_pm_notify_work_func(struct acpi_device_wakeup_context *context)
737 struct device *dev = context->dev;
740 pm_wakeup_event(dev, 0);
741 pm_request_resume(dev);
745 static DEFINE_MUTEX(acpi_wakeup_lock);
747 static int __acpi_device_wakeup_enable(struct acpi_device *adev,
750 struct acpi_device_wakeup *wakeup = &adev->wakeup;
754 mutex_lock(&acpi_wakeup_lock);
757 * If the device wakeup power is already enabled, disable it and enable
758 * it again in case it depends on the configuration of subordinate
759 * devices and the conditions have changed since it was enabled last
762 if (wakeup->enable_count > 0)
763 acpi_disable_wakeup_device_power(adev);
765 error = acpi_enable_wakeup_device_power(adev, target_state);
767 if (wakeup->enable_count > 0) {
768 acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number);
769 wakeup->enable_count = 0;
774 if (wakeup->enable_count > 0)
777 status = acpi_enable_gpe(wakeup->gpe_device, wakeup->gpe_number);
778 if (ACPI_FAILURE(status)) {
779 acpi_disable_wakeup_device_power(adev);
784 acpi_handle_debug(adev->handle, "GPE%2X enabled for wakeup\n",
785 (unsigned int)wakeup->gpe_number);
788 if (wakeup->enable_count < INT_MAX)
789 wakeup->enable_count++;
791 acpi_handle_info(adev->handle, "Wakeup enable count out of bounds!\n");
794 mutex_unlock(&acpi_wakeup_lock);
799 * acpi_device_wakeup_enable - Enable wakeup functionality for device.
800 * @adev: ACPI device to enable wakeup functionality for.
801 * @target_state: State the system is transitioning into.
803 * Enable the GPE associated with @adev so that it can generate wakeup signals
804 * for the device in response to external (remote) events and enable wakeup
807 * Callers must ensure that @adev is a valid ACPI device node before executing
810 static int acpi_device_wakeup_enable(struct acpi_device *adev, u32 target_state)
812 return __acpi_device_wakeup_enable(adev, target_state);
816 * acpi_device_wakeup_disable - Disable wakeup functionality for device.
817 * @adev: ACPI device to disable wakeup functionality for.
819 * Disable the GPE associated with @adev and disable wakeup power for it.
821 * Callers must ensure that @adev is a valid ACPI device node before executing
824 static void acpi_device_wakeup_disable(struct acpi_device *adev)
826 struct acpi_device_wakeup *wakeup = &adev->wakeup;
828 mutex_lock(&acpi_wakeup_lock);
830 if (!wakeup->enable_count)
833 acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number);
834 acpi_disable_wakeup_device_power(adev);
836 wakeup->enable_count--;
839 mutex_unlock(&acpi_wakeup_lock);
843 * acpi_pm_set_device_wakeup - Enable/disable remote wakeup for given device.
844 * @dev: Device to enable/disable to generate wakeup events.
845 * @enable: Whether to enable or disable the wakeup functionality.
847 int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
849 struct acpi_device *adev;
852 adev = ACPI_COMPANION(dev);
854 dev_dbg(dev, "ACPI companion missing in %s!\n", __func__);
858 if (!acpi_device_can_wakeup(adev))
862 acpi_device_wakeup_disable(adev);
863 dev_dbg(dev, "Wakeup disabled by ACPI\n");
867 error = __acpi_device_wakeup_enable(adev, acpi_target_system_state());
869 dev_dbg(dev, "Wakeup enabled by ACPI\n");
873 EXPORT_SYMBOL_GPL(acpi_pm_set_device_wakeup);
876 * acpi_dev_pm_low_power - Put ACPI device into a low-power state.
877 * @dev: Device to put into a low-power state.
878 * @adev: ACPI device node corresponding to @dev.
879 * @system_state: System state to choose the device state for.
881 static int acpi_dev_pm_low_power(struct device *dev, struct acpi_device *adev,
886 if (!acpi_device_power_manageable(adev))
889 ret = acpi_dev_pm_get_state(dev, adev, system_state, NULL, &state);
890 return ret ? ret : acpi_device_set_power(adev, state);
894 * acpi_dev_pm_full_power - Put ACPI device into the full-power state.
895 * @adev: ACPI device node to put into the full-power state.
897 static int acpi_dev_pm_full_power(struct acpi_device *adev)
899 return acpi_device_power_manageable(adev) ?
900 acpi_device_set_power(adev, ACPI_STATE_D0) : 0;
904 * acpi_dev_suspend - Put device into a low-power state using ACPI.
905 * @dev: Device to put into a low-power state.
906 * @wakeup: Whether or not to enable wakeup for the device.
908 * Put the given device into a low-power state using the standard ACPI
909 * mechanism. Set up remote wakeup if desired, choose the state to put the
910 * device into (this checks if remote wakeup is expected to work too), and set
911 * the power state of the device.
913 int acpi_dev_suspend(struct device *dev, bool wakeup)
915 struct acpi_device *adev = ACPI_COMPANION(dev);
916 u32 target_state = acpi_target_system_state();
922 if (wakeup && acpi_device_can_wakeup(adev)) {
923 error = acpi_device_wakeup_enable(adev, target_state);
930 error = acpi_dev_pm_low_power(dev, adev, target_state);
932 acpi_device_wakeup_disable(adev);
936 EXPORT_SYMBOL_GPL(acpi_dev_suspend);
939 * acpi_dev_resume - Put device into the full-power state using ACPI.
940 * @dev: Device to put into the full-power state.
942 * Put the given device into the full-power state using the standard ACPI
943 * mechanism. Set the power state of the device to ACPI D0 and disable wakeup.
945 int acpi_dev_resume(struct device *dev)
947 struct acpi_device *adev = ACPI_COMPANION(dev);
953 error = acpi_dev_pm_full_power(adev);
954 acpi_device_wakeup_disable(adev);
957 EXPORT_SYMBOL_GPL(acpi_dev_resume);
960 * acpi_subsys_runtime_suspend - Suspend device using ACPI.
961 * @dev: Device to suspend.
963 * Carry out the generic runtime suspend procedure for @dev and use ACPI to put
964 * it into a runtime low-power state.
966 int acpi_subsys_runtime_suspend(struct device *dev)
968 int ret = pm_generic_runtime_suspend(dev);
970 return ret ? ret : acpi_dev_suspend(dev, true);
972 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_suspend);
975 * acpi_subsys_runtime_resume - Resume device using ACPI.
976 * @dev: Device to Resume.
978 * Use ACPI to put the given device into the full-power state and carry out the
979 * generic runtime resume procedure for it.
981 int acpi_subsys_runtime_resume(struct device *dev)
983 int ret = acpi_dev_resume(dev);
985 return ret ? ret : pm_generic_runtime_resume(dev);
987 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_resume);
989 #ifdef CONFIG_PM_SLEEP
990 static bool acpi_dev_needs_resume(struct device *dev, struct acpi_device *adev)
992 u32 sys_target = acpi_target_system_state();
995 if (!pm_runtime_suspended(dev) || !adev || (adev->wakeup.flags.valid &&
996 device_may_wakeup(dev) != !!adev->wakeup.prepare_count))
999 if (sys_target == ACPI_STATE_S0)
1002 if (adev->power.flags.dsw_present)
1005 ret = acpi_dev_pm_get_state(dev, adev, sys_target, NULL, &state);
1009 return state != adev->power.state;
1013 * acpi_subsys_prepare - Prepare device for system transition to a sleep state.
1014 * @dev: Device to prepare.
1016 int acpi_subsys_prepare(struct device *dev)
1018 struct acpi_device *adev = ACPI_COMPANION(dev);
1020 if (dev->driver && dev->driver->pm && dev->driver->pm->prepare) {
1021 int ret = dev->driver->pm->prepare(dev);
1026 if (!ret && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
1030 return !acpi_dev_needs_resume(dev, adev);
1032 EXPORT_SYMBOL_GPL(acpi_subsys_prepare);
1035 * acpi_subsys_complete - Finalize device's resume during system resume.
1036 * @dev: Device to handle.
1038 void acpi_subsys_complete(struct device *dev)
1040 pm_generic_complete(dev);
1042 * If the device had been runtime-suspended before the system went into
1043 * the sleep state it is going out of and it has never been resumed till
1044 * now, resume it in case the firmware powered it up.
1046 if (pm_runtime_suspended(dev) && pm_resume_via_firmware())
1047 pm_request_resume(dev);
1049 EXPORT_SYMBOL_GPL(acpi_subsys_complete);
1052 * acpi_subsys_suspend - Run the device driver's suspend callback.
1053 * @dev: Device to handle.
1055 * Follow PCI and resume devices from runtime suspend before running their
1056 * system suspend callbacks, unless the driver can cope with runtime-suspended
1057 * devices during system suspend and there are no ACPI-specific reasons for
1060 int acpi_subsys_suspend(struct device *dev)
1062 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1063 acpi_dev_needs_resume(dev, ACPI_COMPANION(dev)))
1064 pm_runtime_resume(dev);
1066 return pm_generic_suspend(dev);
1068 EXPORT_SYMBOL_GPL(acpi_subsys_suspend);
1071 * acpi_subsys_suspend_late - Suspend device using ACPI.
1072 * @dev: Device to suspend.
1074 * Carry out the generic late suspend procedure for @dev and use ACPI to put
1075 * it into a low-power state during system transition into a sleep state.
1077 int acpi_subsys_suspend_late(struct device *dev)
1081 if (dev_pm_skip_suspend(dev))
1084 ret = pm_generic_suspend_late(dev);
1085 return ret ? ret : acpi_dev_suspend(dev, device_may_wakeup(dev));
1087 EXPORT_SYMBOL_GPL(acpi_subsys_suspend_late);
1090 * acpi_subsys_suspend_noirq - Run the device driver's "noirq" suspend callback.
1091 * @dev: Device to suspend.
1093 int acpi_subsys_suspend_noirq(struct device *dev)
1097 if (dev_pm_skip_suspend(dev))
1100 ret = pm_generic_suspend_noirq(dev);
1105 * If the target system sleep state is suspend-to-idle, it is sufficient
1106 * to check whether or not the device's wakeup settings are good for
1107 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
1108 * acpi_subsys_complete() to take care of fixing up the device's state
1109 * anyway, if need be.
1111 if (device_can_wakeup(dev) && !device_may_wakeup(dev))
1112 dev->power.may_skip_resume = false;
1116 EXPORT_SYMBOL_GPL(acpi_subsys_suspend_noirq);
1119 * acpi_subsys_resume_noirq - Run the device driver's "noirq" resume callback.
1120 * @dev: Device to handle.
1122 static int acpi_subsys_resume_noirq(struct device *dev)
1124 if (dev_pm_skip_resume(dev))
1127 return pm_generic_resume_noirq(dev);
1131 * acpi_subsys_resume_early - Resume device using ACPI.
1132 * @dev: Device to Resume.
1134 * Use ACPI to put the given device into the full-power state and carry out the
1135 * generic early resume procedure for it during system transition into the
1138 static int acpi_subsys_resume_early(struct device *dev)
1142 if (dev_pm_skip_resume(dev))
1145 ret = acpi_dev_resume(dev);
1146 return ret ? ret : pm_generic_resume_early(dev);
1150 * acpi_subsys_freeze - Run the device driver's freeze callback.
1151 * @dev: Device to handle.
1153 int acpi_subsys_freeze(struct device *dev)
1156 * Resume all runtime-suspended devices before creating a snapshot
1157 * image of system memory, because the restore kernel generally cannot
1158 * be expected to always handle them consistently and they need to be
1159 * put into the runtime-active metastate during system resume anyway,
1160 * so it is better to ensure that the state saved in the image will be
1161 * always consistent with that.
1163 pm_runtime_resume(dev);
1165 return pm_generic_freeze(dev);
1167 EXPORT_SYMBOL_GPL(acpi_subsys_freeze);
1170 * acpi_subsys_restore_early - Restore device using ACPI.
1171 * @dev: Device to restore.
1173 int acpi_subsys_restore_early(struct device *dev)
1175 int ret = acpi_dev_resume(dev);
1177 return ret ? ret : pm_generic_restore_early(dev);
1179 EXPORT_SYMBOL_GPL(acpi_subsys_restore_early);
1182 * acpi_subsys_poweroff - Run the device driver's poweroff callback.
1183 * @dev: Device to handle.
1185 * Follow PCI and resume devices from runtime suspend before running their
1186 * system poweroff callbacks, unless the driver can cope with runtime-suspended
1187 * devices during system suspend and there are no ACPI-specific reasons for
1190 int acpi_subsys_poweroff(struct device *dev)
1192 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1193 acpi_dev_needs_resume(dev, ACPI_COMPANION(dev)))
1194 pm_runtime_resume(dev);
1196 return pm_generic_poweroff(dev);
1198 EXPORT_SYMBOL_GPL(acpi_subsys_poweroff);
1201 * acpi_subsys_poweroff_late - Run the device driver's poweroff callback.
1202 * @dev: Device to handle.
1204 * Carry out the generic late poweroff procedure for @dev and use ACPI to put
1205 * it into a low-power state during system transition into a sleep state.
1207 static int acpi_subsys_poweroff_late(struct device *dev)
1211 if (dev_pm_skip_suspend(dev))
1214 ret = pm_generic_poweroff_late(dev);
1218 return acpi_dev_suspend(dev, device_may_wakeup(dev));
1222 * acpi_subsys_poweroff_noirq - Run the driver's "noirq" poweroff callback.
1223 * @dev: Device to suspend.
1225 static int acpi_subsys_poweroff_noirq(struct device *dev)
1227 if (dev_pm_skip_suspend(dev))
1230 return pm_generic_poweroff_noirq(dev);
1232 #endif /* CONFIG_PM_SLEEP */
1234 static struct dev_pm_domain acpi_general_pm_domain = {
1236 .runtime_suspend = acpi_subsys_runtime_suspend,
1237 .runtime_resume = acpi_subsys_runtime_resume,
1238 #ifdef CONFIG_PM_SLEEP
1239 .prepare = acpi_subsys_prepare,
1240 .complete = acpi_subsys_complete,
1241 .suspend = acpi_subsys_suspend,
1242 .suspend_late = acpi_subsys_suspend_late,
1243 .suspend_noirq = acpi_subsys_suspend_noirq,
1244 .resume_noirq = acpi_subsys_resume_noirq,
1245 .resume_early = acpi_subsys_resume_early,
1246 .freeze = acpi_subsys_freeze,
1247 .poweroff = acpi_subsys_poweroff,
1248 .poweroff_late = acpi_subsys_poweroff_late,
1249 .poweroff_noirq = acpi_subsys_poweroff_noirq,
1250 .restore_early = acpi_subsys_restore_early,
1256 * acpi_dev_pm_detach - Remove ACPI power management from the device.
1257 * @dev: Device to take care of.
1258 * @power_off: Whether or not to try to remove power from the device.
1260 * Remove the device from the general ACPI PM domain and remove its wakeup
1261 * notifier. If @power_off is set, additionally remove power from the device if
1264 * Callers must ensure proper synchronization of this function with power
1265 * management callbacks.
1267 static void acpi_dev_pm_detach(struct device *dev, bool power_off)
1269 struct acpi_device *adev = ACPI_COMPANION(dev);
1271 if (adev && dev->pm_domain == &acpi_general_pm_domain) {
1272 dev_pm_domain_set(dev, NULL);
1273 acpi_remove_pm_notifier(adev);
1276 * If the device's PM QoS resume latency limit or flags
1277 * have been exposed to user space, they have to be
1278 * hidden at this point, so that they don't affect the
1279 * choice of the low-power state to put the device into.
1281 dev_pm_qos_hide_latency_limit(dev);
1282 dev_pm_qos_hide_flags(dev);
1283 acpi_device_wakeup_disable(adev);
1284 acpi_dev_pm_low_power(dev, adev, ACPI_STATE_S0);
1290 * acpi_dev_pm_attach - Prepare device for ACPI power management.
1291 * @dev: Device to prepare.
1292 * @power_on: Whether or not to power on the device.
1294 * If @dev has a valid ACPI handle that has a valid struct acpi_device object
1295 * attached to it, install a wakeup notification handler for the device and
1296 * add it to the general ACPI PM domain. If @power_on is set, the device will
1297 * be put into the ACPI D0 state before the function returns.
1299 * This assumes that the @dev's bus type uses generic power management callbacks
1300 * (or doesn't use any power management callbacks at all).
1302 * Callers must ensure proper synchronization of this function with power
1303 * management callbacks.
1305 int acpi_dev_pm_attach(struct device *dev, bool power_on)
1308 * Skip devices whose ACPI companions match the device IDs below,
1309 * because they require special power management handling incompatible
1310 * with the generic ACPI PM domain.
1312 static const struct acpi_device_id special_pm_ids[] = {
1313 {"PNP0C0B", }, /* Generic ACPI fan */
1314 {"INT3404", }, /* Fan */
1315 {"INTC1044", }, /* Fan for Tiger Lake generation */
1318 struct acpi_device *adev = ACPI_COMPANION(dev);
1320 if (!adev || !acpi_match_device_ids(adev, special_pm_ids))
1324 * Only attach the power domain to the first device if the
1325 * companion is shared by multiple. This is to prevent doing power
1328 if (!acpi_device_is_first_physical_node(adev, dev))
1331 acpi_add_pm_notifier(adev, dev, acpi_pm_notify_work_func);
1332 dev_pm_domain_set(dev, &acpi_general_pm_domain);
1334 acpi_dev_pm_full_power(adev);
1335 acpi_device_wakeup_disable(adev);
1338 dev->pm_domain->detach = acpi_dev_pm_detach;
1341 EXPORT_SYMBOL_GPL(acpi_dev_pm_attach);
1342 #endif /* CONFIG_PM */