2 * drivers/base/power/domain.c - Common code related to device power domains.
4 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
6 * This file is released under the GPLv2.
9 #include <linux/init.h>
10 #include <linux/kernel.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/pm_domain.h>
14 #include <linux/slab.h>
15 #include <linux/err.h>
16 #include <linux/sched.h>
17 #include <linux/suspend.h>
19 static LIST_HEAD(gpd_list);
20 static DEFINE_MUTEX(gpd_list_lock);
24 static struct generic_pm_domain *dev_to_genpd(struct device *dev)
26 if (IS_ERR_OR_NULL(dev->pm_domain))
27 return ERR_PTR(-EINVAL);
29 return pd_to_genpd(dev->pm_domain);
32 static void genpd_sd_counter_dec(struct generic_pm_domain *genpd)
34 if (!WARN_ON(genpd->sd_count == 0))
38 static void genpd_acquire_lock(struct generic_pm_domain *genpd)
42 mutex_lock(&genpd->lock);
44 * Wait for the domain to transition into either the active,
45 * or the power off state.
48 prepare_to_wait(&genpd->status_wait_queue, &wait,
49 TASK_UNINTERRUPTIBLE);
50 if (genpd->status == GPD_STATE_ACTIVE
51 || genpd->status == GPD_STATE_POWER_OFF)
53 mutex_unlock(&genpd->lock);
57 mutex_lock(&genpd->lock);
59 finish_wait(&genpd->status_wait_queue, &wait);
62 static void genpd_release_lock(struct generic_pm_domain *genpd)
64 mutex_unlock(&genpd->lock);
67 static void genpd_set_active(struct generic_pm_domain *genpd)
69 if (genpd->resume_count == 0)
70 genpd->status = GPD_STATE_ACTIVE;
74 * pm_genpd_poweron - Restore power to a given PM domain and its parents.
75 * @genpd: PM domain to power up.
77 * Restore power to @genpd and all of its parents so that it is possible to
78 * resume a device belonging to it.
80 int pm_genpd_poweron(struct generic_pm_domain *genpd)
82 struct generic_pm_domain *parent = genpd->parent;
88 genpd_acquire_lock(parent);
89 mutex_lock_nested(&genpd->lock, SINGLE_DEPTH_NESTING);
91 mutex_lock(&genpd->lock);
94 if (genpd->status == GPD_STATE_ACTIVE
95 || (genpd->prepared_count > 0 && genpd->suspend_power_off))
98 if (genpd->status != GPD_STATE_POWER_OFF) {
99 genpd_set_active(genpd);
103 if (parent && parent->status != GPD_STATE_ACTIVE) {
104 mutex_unlock(&genpd->lock);
105 genpd_release_lock(parent);
107 ret = pm_genpd_poweron(parent);
114 if (genpd->power_on) {
115 int ret = genpd->power_on(genpd);
120 genpd_set_active(genpd);
125 mutex_unlock(&genpd->lock);
127 genpd_release_lock(parent);
132 #endif /* CONFIG_PM */
134 #ifdef CONFIG_PM_RUNTIME
137 * __pm_genpd_save_device - Save the pre-suspend state of a device.
138 * @dle: Device list entry of the device to save the state of.
139 * @genpd: PM domain the device belongs to.
141 static int __pm_genpd_save_device(struct dev_list_entry *dle,
142 struct generic_pm_domain *genpd)
143 __releases(&genpd->lock) __acquires(&genpd->lock)
145 struct device *dev = dle->dev;
146 struct device_driver *drv = dev->driver;
149 if (dle->need_restore)
152 mutex_unlock(&genpd->lock);
154 if (drv && drv->pm && drv->pm->runtime_suspend) {
155 if (genpd->start_device)
156 genpd->start_device(dev);
158 ret = drv->pm->runtime_suspend(dev);
160 if (genpd->stop_device)
161 genpd->stop_device(dev);
164 mutex_lock(&genpd->lock);
167 dle->need_restore = true;
173 * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
174 * @dle: Device list entry of the device to restore the state of.
175 * @genpd: PM domain the device belongs to.
177 static void __pm_genpd_restore_device(struct dev_list_entry *dle,
178 struct generic_pm_domain *genpd)
179 __releases(&genpd->lock) __acquires(&genpd->lock)
181 struct device *dev = dle->dev;
182 struct device_driver *drv = dev->driver;
184 if (!dle->need_restore)
187 mutex_unlock(&genpd->lock);
189 if (drv && drv->pm && drv->pm->runtime_resume) {
190 if (genpd->start_device)
191 genpd->start_device(dev);
193 drv->pm->runtime_resume(dev);
195 if (genpd->stop_device)
196 genpd->stop_device(dev);
199 mutex_lock(&genpd->lock);
201 dle->need_restore = false;
205 * genpd_abort_poweroff - Check if a PM domain power off should be aborted.
206 * @genpd: PM domain to check.
208 * Return true if a PM domain's status changed to GPD_STATE_ACTIVE during
209 * a "power off" operation, which means that a "power on" has occured in the
210 * meantime, or if its resume_count field is different from zero, which means
211 * that one of its devices has been resumed in the meantime.
213 static bool genpd_abort_poweroff(struct generic_pm_domain *genpd)
215 return genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
219 * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
220 * @genpd: PM domait to power off.
222 * Queue up the execution of pm_genpd_poweroff() unless it's already been done
225 void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
227 if (!work_pending(&genpd->power_off_work))
228 queue_work(pm_wq, &genpd->power_off_work);
232 * pm_genpd_poweroff - Remove power from a given PM domain.
233 * @genpd: PM domain to power down.
235 * If all of the @genpd's devices have been suspended and all of its subdomains
236 * have been powered down, run the runtime suspend callbacks provided by all of
237 * the @genpd's devices' drivers and remove power from @genpd.
239 static int pm_genpd_poweroff(struct generic_pm_domain *genpd)
240 __releases(&genpd->lock) __acquires(&genpd->lock)
242 struct generic_pm_domain *parent;
243 struct dev_list_entry *dle;
244 unsigned int not_suspended;
249 * Do not try to power off the domain in the following situations:
250 * (1) The domain is already in the "power off" state.
251 * (2) System suspend is in progress.
252 * (3) One of the domain's devices is being resumed right now.
254 if (genpd->status == GPD_STATE_POWER_OFF || genpd->prepared_count > 0
255 || genpd->resume_count > 0)
258 if (genpd->sd_count > 0)
262 list_for_each_entry(dle, &genpd->dev_list, node)
263 if (dle->dev->driver && !pm_runtime_suspended(dle->dev))
266 if (not_suspended > genpd->in_progress)
269 if (genpd->poweroff_task) {
271 * Another instance of pm_genpd_poweroff() is executing
272 * callbacks, so tell it to start over and return.
274 genpd->status = GPD_STATE_REPEAT;
278 if (genpd->gov && genpd->gov->power_down_ok) {
279 if (!genpd->gov->power_down_ok(&genpd->domain))
283 genpd->status = GPD_STATE_BUSY;
284 genpd->poweroff_task = current;
286 list_for_each_entry_reverse(dle, &genpd->dev_list, node) {
287 ret = __pm_genpd_save_device(dle, genpd);
289 genpd_set_active(genpd);
293 if (genpd_abort_poweroff(genpd))
296 if (genpd->status == GPD_STATE_REPEAT) {
297 genpd->poweroff_task = NULL;
302 parent = genpd->parent;
304 mutex_unlock(&genpd->lock);
306 genpd_acquire_lock(parent);
307 mutex_lock_nested(&genpd->lock, SINGLE_DEPTH_NESTING);
309 if (genpd_abort_poweroff(genpd)) {
310 genpd_release_lock(parent);
315 if (genpd->power_off) {
316 ret = genpd->power_off(genpd);
318 genpd_set_active(genpd);
320 genpd_release_lock(parent);
326 genpd->status = GPD_STATE_POWER_OFF;
329 genpd_sd_counter_dec(parent);
330 if (parent->sd_count == 0)
331 genpd_queue_power_off_work(parent);
333 genpd_release_lock(parent);
337 genpd->poweroff_task = NULL;
338 wake_up_all(&genpd->status_wait_queue);
343 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
344 * @work: Work structure used for scheduling the execution of this function.
346 static void genpd_power_off_work_fn(struct work_struct *work)
348 struct generic_pm_domain *genpd;
350 genpd = container_of(work, struct generic_pm_domain, power_off_work);
352 genpd_acquire_lock(genpd);
353 pm_genpd_poweroff(genpd);
354 genpd_release_lock(genpd);
358 * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
359 * @dev: Device to suspend.
361 * Carry out a runtime suspend of a device under the assumption that its
362 * pm_domain field points to the domain member of an object of type
363 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
365 static int pm_genpd_runtime_suspend(struct device *dev)
367 struct generic_pm_domain *genpd;
369 dev_dbg(dev, "%s()\n", __func__);
371 genpd = dev_to_genpd(dev);
375 if (genpd->stop_device) {
376 int ret = genpd->stop_device(dev);
381 mutex_lock(&genpd->lock);
382 genpd->in_progress++;
383 pm_genpd_poweroff(genpd);
384 genpd->in_progress--;
385 mutex_unlock(&genpd->lock);
391 * __pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
392 * @dev: Device to resume.
393 * @genpd: PM domain the device belongs to.
395 static void __pm_genpd_runtime_resume(struct device *dev,
396 struct generic_pm_domain *genpd)
398 struct dev_list_entry *dle;
400 list_for_each_entry(dle, &genpd->dev_list, node) {
401 if (dle->dev == dev) {
402 __pm_genpd_restore_device(dle, genpd);
409 * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
410 * @dev: Device to resume.
412 * Carry out a runtime resume of a device under the assumption that its
413 * pm_domain field points to the domain member of an object of type
414 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
416 static int pm_genpd_runtime_resume(struct device *dev)
418 struct generic_pm_domain *genpd;
422 dev_dbg(dev, "%s()\n", __func__);
424 genpd = dev_to_genpd(dev);
428 ret = pm_genpd_poweron(genpd);
432 mutex_lock(&genpd->lock);
433 genpd->status = GPD_STATE_BUSY;
434 genpd->resume_count++;
436 prepare_to_wait(&genpd->status_wait_queue, &wait,
437 TASK_UNINTERRUPTIBLE);
439 * If current is the powering off task, we have been called
440 * reentrantly from one of the device callbacks, so we should
443 if (!genpd->poweroff_task || genpd->poweroff_task == current)
445 mutex_unlock(&genpd->lock);
449 mutex_lock(&genpd->lock);
451 finish_wait(&genpd->status_wait_queue, &wait);
452 __pm_genpd_runtime_resume(dev, genpd);
453 genpd->resume_count--;
454 genpd_set_active(genpd);
455 wake_up_all(&genpd->status_wait_queue);
456 mutex_unlock(&genpd->lock);
458 if (genpd->start_device)
459 genpd->start_device(dev);
466 static inline void genpd_power_off_work_fn(struct work_struct *work) {}
467 static inline void __pm_genpd_runtime_resume(struct device *dev,
468 struct generic_pm_domain *genpd) {}
470 #define pm_genpd_runtime_suspend NULL
471 #define pm_genpd_runtime_resume NULL
473 #endif /* CONFIG_PM_RUNTIME */
475 #ifdef CONFIG_PM_SLEEP
478 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its parents.
479 * @genpd: PM domain to power off, if possible.
481 * Check if the given PM domain can be powered off (during system suspend or
482 * hibernation) and do that if so. Also, in that case propagate to its parent.
484 * This function is only called in "noirq" stages of system power transitions,
485 * so it need not acquire locks (all of the "noirq" callbacks are executed
486 * sequentially, so it is guaranteed that it will never run twice in parallel).
488 static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd)
490 struct generic_pm_domain *parent = genpd->parent;
492 if (genpd->status == GPD_STATE_POWER_OFF)
495 if (genpd->suspended_count != genpd->device_count || genpd->sd_count > 0)
498 if (genpd->power_off)
499 genpd->power_off(genpd);
501 genpd->status = GPD_STATE_POWER_OFF;
503 genpd_sd_counter_dec(parent);
504 pm_genpd_sync_poweroff(parent);
509 * resume_needed - Check whether to resume a device before system suspend.
510 * @dev: Device to check.
511 * @genpd: PM domain the device belongs to.
513 * There are two cases in which a device that can wake up the system from sleep
514 * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
515 * to wake up the system and it has to remain active for this purpose while the
516 * system is in the sleep state and (2) if the device is not enabled to wake up
517 * the system from sleep states and it generally doesn't generate wakeup signals
518 * by itself (those signals are generated on its behalf by other parts of the
519 * system). In the latter case it may be necessary to reconfigure the device's
520 * wakeup settings during system suspend, because it may have been set up to
521 * signal remote wakeup from the system's working state as needed by runtime PM.
522 * Return 'true' in either of the above cases.
524 static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
528 if (!device_can_wakeup(dev))
531 active_wakeup = genpd->active_wakeup && genpd->active_wakeup(dev);
532 return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
536 * pm_genpd_prepare - Start power transition of a device in a PM domain.
537 * @dev: Device to start the transition of.
539 * Start a power transition of a device (during a system-wide power transition)
540 * under the assumption that its pm_domain field points to the domain member of
541 * an object of type struct generic_pm_domain representing a PM domain
542 * consisting of I/O devices.
544 static int pm_genpd_prepare(struct device *dev)
546 struct generic_pm_domain *genpd;
549 dev_dbg(dev, "%s()\n", __func__);
551 genpd = dev_to_genpd(dev);
556 * If a wakeup request is pending for the device, it should be woken up
557 * at this point and a system wakeup event should be reported if it's
558 * set up to wake up the system from sleep states.
560 pm_runtime_get_noresume(dev);
561 if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
562 pm_wakeup_event(dev, 0);
564 if (pm_wakeup_pending()) {
565 pm_runtime_put_sync(dev);
569 if (resume_needed(dev, genpd))
570 pm_runtime_resume(dev);
572 genpd_acquire_lock(genpd);
574 if (genpd->prepared_count++ == 0)
575 genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
577 genpd_release_lock(genpd);
579 if (genpd->suspend_power_off) {
580 pm_runtime_put_noidle(dev);
585 * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
586 * so pm_genpd_poweron() will return immediately, but if the device
587 * is suspended (e.g. it's been stopped by .stop_device()), we need
588 * to make it operational.
590 pm_runtime_resume(dev);
591 __pm_runtime_disable(dev, false);
593 ret = pm_generic_prepare(dev);
595 mutex_lock(&genpd->lock);
597 if (--genpd->prepared_count == 0)
598 genpd->suspend_power_off = false;
600 mutex_unlock(&genpd->lock);
601 pm_runtime_enable(dev);
604 pm_runtime_put_sync(dev);
609 * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
610 * @dev: Device to suspend.
612 * Suspend a device under the assumption that its pm_domain field points to the
613 * domain member of an object of type struct generic_pm_domain representing
614 * a PM domain consisting of I/O devices.
616 static int pm_genpd_suspend(struct device *dev)
618 struct generic_pm_domain *genpd;
620 dev_dbg(dev, "%s()\n", __func__);
622 genpd = dev_to_genpd(dev);
626 return genpd->suspend_power_off ? 0 : pm_generic_suspend(dev);
630 * pm_genpd_suspend_noirq - Late suspend of a device from an I/O PM domain.
631 * @dev: Device to suspend.
633 * Carry out a late suspend of a device under the assumption that its
634 * pm_domain field points to the domain member of an object of type
635 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
637 static int pm_genpd_suspend_noirq(struct device *dev)
639 struct generic_pm_domain *genpd;
642 dev_dbg(dev, "%s()\n", __func__);
644 genpd = dev_to_genpd(dev);
648 if (genpd->suspend_power_off)
651 ret = pm_generic_suspend_noirq(dev);
655 if (device_may_wakeup(dev)
656 && genpd->active_wakeup && genpd->active_wakeup(dev))
659 if (genpd->stop_device)
660 genpd->stop_device(dev);
663 * Since all of the "noirq" callbacks are executed sequentially, it is
664 * guaranteed that this function will never run twice in parallel for
665 * the same PM domain, so it is not necessary to use locking here.
667 genpd->suspended_count++;
668 pm_genpd_sync_poweroff(genpd);
674 * pm_genpd_resume_noirq - Early resume of a device from an I/O power domain.
675 * @dev: Device to resume.
677 * Carry out an early resume of a device under the assumption that its
678 * pm_domain field points to the domain member of an object of type
679 * struct generic_pm_domain representing a power domain consisting of I/O
682 static int pm_genpd_resume_noirq(struct device *dev)
684 struct generic_pm_domain *genpd;
686 dev_dbg(dev, "%s()\n", __func__);
688 genpd = dev_to_genpd(dev);
692 if (genpd->suspend_power_off)
696 * Since all of the "noirq" callbacks are executed sequentially, it is
697 * guaranteed that this function will never run twice in parallel for
698 * the same PM domain, so it is not necessary to use locking here.
700 pm_genpd_poweron(genpd);
701 genpd->suspended_count--;
702 if (genpd->start_device)
703 genpd->start_device(dev);
705 return pm_generic_resume_noirq(dev);
709 * pm_genpd_resume - Resume a device belonging to an I/O power domain.
710 * @dev: Device to resume.
712 * Resume a device under the assumption that its pm_domain field points to the
713 * domain member of an object of type struct generic_pm_domain representing
714 * a power domain consisting of I/O devices.
716 static int pm_genpd_resume(struct device *dev)
718 struct generic_pm_domain *genpd;
720 dev_dbg(dev, "%s()\n", __func__);
722 genpd = dev_to_genpd(dev);
726 return genpd->suspend_power_off ? 0 : pm_generic_resume(dev);
730 * pm_genpd_freeze - Freeze a device belonging to an I/O power domain.
731 * @dev: Device to freeze.
733 * Freeze a device under the assumption that its pm_domain field points to the
734 * domain member of an object of type struct generic_pm_domain representing
735 * a power domain consisting of I/O devices.
737 static int pm_genpd_freeze(struct device *dev)
739 struct generic_pm_domain *genpd;
741 dev_dbg(dev, "%s()\n", __func__);
743 genpd = dev_to_genpd(dev);
747 return genpd->suspend_power_off ? 0 : pm_generic_freeze(dev);
751 * pm_genpd_freeze_noirq - Late freeze of a device from an I/O power domain.
752 * @dev: Device to freeze.
754 * Carry out a late freeze of a device under the assumption that its
755 * pm_domain field points to the domain member of an object of type
756 * struct generic_pm_domain representing a power domain consisting of I/O
759 static int pm_genpd_freeze_noirq(struct device *dev)
761 struct generic_pm_domain *genpd;
764 dev_dbg(dev, "%s()\n", __func__);
766 genpd = dev_to_genpd(dev);
770 if (genpd->suspend_power_off)
773 ret = pm_generic_freeze_noirq(dev);
777 if (genpd->stop_device)
778 genpd->stop_device(dev);
784 * pm_genpd_thaw_noirq - Early thaw of a device from an I/O power domain.
785 * @dev: Device to thaw.
787 * Carry out an early thaw of a device under the assumption that its
788 * pm_domain field points to the domain member of an object of type
789 * struct generic_pm_domain representing a power domain consisting of I/O
792 static int pm_genpd_thaw_noirq(struct device *dev)
794 struct generic_pm_domain *genpd;
796 dev_dbg(dev, "%s()\n", __func__);
798 genpd = dev_to_genpd(dev);
802 if (genpd->suspend_power_off)
805 if (genpd->start_device)
806 genpd->start_device(dev);
808 return pm_generic_thaw_noirq(dev);
812 * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
813 * @dev: Device to thaw.
815 * Thaw a device under the assumption that its pm_domain field points to the
816 * domain member of an object of type struct generic_pm_domain representing
817 * a power domain consisting of I/O devices.
819 static int pm_genpd_thaw(struct device *dev)
821 struct generic_pm_domain *genpd;
823 dev_dbg(dev, "%s()\n", __func__);
825 genpd = dev_to_genpd(dev);
829 return genpd->suspend_power_off ? 0 : pm_generic_thaw(dev);
833 * pm_genpd_dev_poweroff - Power off a device belonging to an I/O PM domain.
834 * @dev: Device to suspend.
836 * Power off a device under the assumption that its pm_domain field points to
837 * the domain member of an object of type struct generic_pm_domain representing
838 * a PM domain consisting of I/O devices.
840 static int pm_genpd_dev_poweroff(struct device *dev)
842 struct generic_pm_domain *genpd;
844 dev_dbg(dev, "%s()\n", __func__);
846 genpd = dev_to_genpd(dev);
850 return genpd->suspend_power_off ? 0 : pm_generic_poweroff(dev);
854 * pm_genpd_dev_poweroff_noirq - Late power off of a device from a PM domain.
855 * @dev: Device to suspend.
857 * Carry out a late powering off of a device under the assumption that its
858 * pm_domain field points to the domain member of an object of type
859 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
861 static int pm_genpd_dev_poweroff_noirq(struct device *dev)
863 struct generic_pm_domain *genpd;
866 dev_dbg(dev, "%s()\n", __func__);
868 genpd = dev_to_genpd(dev);
872 if (genpd->suspend_power_off)
875 ret = pm_generic_poweroff_noirq(dev);
879 if (device_may_wakeup(dev)
880 && genpd->active_wakeup && genpd->active_wakeup(dev))
883 if (genpd->stop_device)
884 genpd->stop_device(dev);
887 * Since all of the "noirq" callbacks are executed sequentially, it is
888 * guaranteed that this function will never run twice in parallel for
889 * the same PM domain, so it is not necessary to use locking here.
891 genpd->suspended_count++;
892 pm_genpd_sync_poweroff(genpd);
898 * pm_genpd_restore_noirq - Early restore of a device from an I/O power domain.
899 * @dev: Device to resume.
901 * Carry out an early restore of a device under the assumption that its
902 * pm_domain field points to the domain member of an object of type
903 * struct generic_pm_domain representing a power domain consisting of I/O
906 static int pm_genpd_restore_noirq(struct device *dev)
908 struct generic_pm_domain *genpd;
910 dev_dbg(dev, "%s()\n", __func__);
912 genpd = dev_to_genpd(dev);
917 * Since all of the "noirq" callbacks are executed sequentially, it is
918 * guaranteed that this function will never run twice in parallel for
919 * the same PM domain, so it is not necessary to use locking here.
921 genpd->status = GPD_STATE_POWER_OFF;
922 if (genpd->suspend_power_off) {
924 * The boot kernel might put the domain into the power on state,
925 * so make sure it really is powered off.
927 if (genpd->power_off)
928 genpd->power_off(genpd);
932 pm_genpd_poweron(genpd);
933 genpd->suspended_count--;
934 if (genpd->start_device)
935 genpd->start_device(dev);
937 return pm_generic_restore_noirq(dev);
941 * pm_genpd_restore - Restore a device belonging to an I/O power domain.
942 * @dev: Device to resume.
944 * Restore a device under the assumption that its pm_domain field points to the
945 * domain member of an object of type struct generic_pm_domain representing
946 * a power domain consisting of I/O devices.
948 static int pm_genpd_restore(struct device *dev)
950 struct generic_pm_domain *genpd;
952 dev_dbg(dev, "%s()\n", __func__);
954 genpd = dev_to_genpd(dev);
958 return genpd->suspend_power_off ? 0 : pm_generic_restore(dev);
962 * pm_genpd_complete - Complete power transition of a device in a power domain.
963 * @dev: Device to complete the transition of.
965 * Complete a power transition of a device (during a system-wide power
966 * transition) under the assumption that its pm_domain field points to the
967 * domain member of an object of type struct generic_pm_domain representing
968 * a power domain consisting of I/O devices.
970 static void pm_genpd_complete(struct device *dev)
972 struct generic_pm_domain *genpd;
975 dev_dbg(dev, "%s()\n", __func__);
977 genpd = dev_to_genpd(dev);
981 mutex_lock(&genpd->lock);
983 run_complete = !genpd->suspend_power_off;
984 if (--genpd->prepared_count == 0)
985 genpd->suspend_power_off = false;
987 mutex_unlock(&genpd->lock);
990 pm_generic_complete(dev);
991 pm_runtime_set_active(dev);
992 pm_runtime_enable(dev);
993 pm_runtime_idle(dev);
999 #define pm_genpd_prepare NULL
1000 #define pm_genpd_suspend NULL
1001 #define pm_genpd_suspend_noirq NULL
1002 #define pm_genpd_resume_noirq NULL
1003 #define pm_genpd_resume NULL
1004 #define pm_genpd_freeze NULL
1005 #define pm_genpd_freeze_noirq NULL
1006 #define pm_genpd_thaw_noirq NULL
1007 #define pm_genpd_thaw NULL
1008 #define pm_genpd_dev_poweroff_noirq NULL
1009 #define pm_genpd_dev_poweroff NULL
1010 #define pm_genpd_restore_noirq NULL
1011 #define pm_genpd_restore NULL
1012 #define pm_genpd_complete NULL
1014 #endif /* CONFIG_PM_SLEEP */
1017 * pm_genpd_add_device - Add a device to an I/O PM domain.
1018 * @genpd: PM domain to add the device to.
1019 * @dev: Device to be added.
1021 int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev)
1023 struct dev_list_entry *dle;
1026 dev_dbg(dev, "%s()\n", __func__);
1028 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1031 genpd_acquire_lock(genpd);
1033 if (genpd->status == GPD_STATE_POWER_OFF) {
1038 if (genpd->prepared_count > 0) {
1043 list_for_each_entry(dle, &genpd->dev_list, node)
1044 if (dle->dev == dev) {
1049 dle = kzalloc(sizeof(*dle), GFP_KERNEL);
1056 dle->need_restore = false;
1057 list_add_tail(&dle->node, &genpd->dev_list);
1058 genpd->device_count++;
1060 spin_lock_irq(&dev->power.lock);
1061 dev->pm_domain = &genpd->domain;
1062 spin_unlock_irq(&dev->power.lock);
1065 genpd_release_lock(genpd);
1071 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1072 * @genpd: PM domain to remove the device from.
1073 * @dev: Device to be removed.
1075 int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1078 struct dev_list_entry *dle;
1081 dev_dbg(dev, "%s()\n", __func__);
1083 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1086 genpd_acquire_lock(genpd);
1088 if (genpd->prepared_count > 0) {
1093 list_for_each_entry(dle, &genpd->dev_list, node) {
1094 if (dle->dev != dev)
1097 spin_lock_irq(&dev->power.lock);
1098 dev->pm_domain = NULL;
1099 spin_unlock_irq(&dev->power.lock);
1101 genpd->device_count--;
1102 list_del(&dle->node);
1110 genpd_release_lock(genpd);
1116 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1117 * @genpd: Master PM domain to add the subdomain to.
1118 * @new_subdomain: Subdomain to be added.
1120 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1121 struct generic_pm_domain *new_subdomain)
1123 struct generic_pm_domain *subdomain;
1126 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(new_subdomain))
1130 genpd_acquire_lock(genpd);
1131 mutex_lock_nested(&new_subdomain->lock, SINGLE_DEPTH_NESTING);
1133 if (new_subdomain->status != GPD_STATE_POWER_OFF
1134 && new_subdomain->status != GPD_STATE_ACTIVE) {
1135 mutex_unlock(&new_subdomain->lock);
1136 genpd_release_lock(genpd);
1140 if (genpd->status == GPD_STATE_POWER_OFF
1141 && new_subdomain->status != GPD_STATE_POWER_OFF) {
1146 list_for_each_entry(subdomain, &genpd->sd_list, sd_node) {
1147 if (subdomain == new_subdomain) {
1153 list_add_tail(&new_subdomain->sd_node, &genpd->sd_list);
1154 new_subdomain->parent = genpd;
1155 if (subdomain->status != GPD_STATE_POWER_OFF)
1159 mutex_unlock(&new_subdomain->lock);
1160 genpd_release_lock(genpd);
1166 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1167 * @genpd: Master PM domain to remove the subdomain from.
1168 * @target: Subdomain to be removed.
1170 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1171 struct generic_pm_domain *target)
1173 struct generic_pm_domain *subdomain;
1176 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(target))
1180 genpd_acquire_lock(genpd);
1182 list_for_each_entry(subdomain, &genpd->sd_list, sd_node) {
1183 if (subdomain != target)
1186 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1188 if (subdomain->status != GPD_STATE_POWER_OFF
1189 && subdomain->status != GPD_STATE_ACTIVE) {
1190 mutex_unlock(&subdomain->lock);
1191 genpd_release_lock(genpd);
1195 list_del(&subdomain->sd_node);
1196 subdomain->parent = NULL;
1197 if (subdomain->status != GPD_STATE_POWER_OFF)
1198 genpd_sd_counter_dec(genpd);
1200 mutex_unlock(&subdomain->lock);
1206 genpd_release_lock(genpd);
1212 * pm_genpd_init - Initialize a generic I/O PM domain object.
1213 * @genpd: PM domain object to initialize.
1214 * @gov: PM domain governor to associate with the domain (may be NULL).
1215 * @is_off: Initial value of the domain's power_is_off field.
1217 void pm_genpd_init(struct generic_pm_domain *genpd,
1218 struct dev_power_governor *gov, bool is_off)
1220 if (IS_ERR_OR_NULL(genpd))
1223 INIT_LIST_HEAD(&genpd->sd_node);
1224 genpd->parent = NULL;
1225 INIT_LIST_HEAD(&genpd->dev_list);
1226 INIT_LIST_HEAD(&genpd->sd_list);
1227 mutex_init(&genpd->lock);
1229 INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1230 genpd->in_progress = 0;
1231 genpd->sd_count = 0;
1232 genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
1233 init_waitqueue_head(&genpd->status_wait_queue);
1234 genpd->poweroff_task = NULL;
1235 genpd->resume_count = 0;
1236 genpd->device_count = 0;
1237 genpd->suspended_count = 0;
1238 genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
1239 genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
1240 genpd->domain.ops.runtime_idle = pm_generic_runtime_idle;
1241 genpd->domain.ops.prepare = pm_genpd_prepare;
1242 genpd->domain.ops.suspend = pm_genpd_suspend;
1243 genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
1244 genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1245 genpd->domain.ops.resume = pm_genpd_resume;
1246 genpd->domain.ops.freeze = pm_genpd_freeze;
1247 genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
1248 genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1249 genpd->domain.ops.thaw = pm_genpd_thaw;
1250 genpd->domain.ops.poweroff = pm_genpd_dev_poweroff;
1251 genpd->domain.ops.poweroff_noirq = pm_genpd_dev_poweroff_noirq;
1252 genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1253 genpd->domain.ops.restore = pm_genpd_restore;
1254 genpd->domain.ops.complete = pm_genpd_complete;
1255 mutex_lock(&gpd_list_lock);
1256 list_add(&genpd->gpd_list_node, &gpd_list);
1257 mutex_unlock(&gpd_list_lock);
1261 * pm_genpd_poweroff_unused - Power off all PM domains with no devices in use.
1263 void pm_genpd_poweroff_unused(void)
1265 struct generic_pm_domain *genpd;
1267 mutex_lock(&gpd_list_lock);
1269 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
1270 genpd_queue_power_off_work(genpd);
1272 mutex_unlock(&gpd_list_lock);