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/delay.h>
10 #include <linux/kernel.h>
12 #include <linux/platform_device.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/pm_domain.h>
15 #include <linux/pm_qos.h>
16 #include <linux/pm_clock.h>
17 #include <linux/slab.h>
18 #include <linux/err.h>
19 #include <linux/sched.h>
20 #include <linux/suspend.h>
21 #include <linux/export.h>
23 #define GENPD_RETRY_MAX_MS 250 /* Approximate */
25 #define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
27 type (*__routine)(struct device *__d); \
28 type __ret = (type)0; \
30 __routine = genpd->dev_ops.callback; \
32 __ret = __routine(dev); \
37 #define GENPD_DEV_TIMED_CALLBACK(genpd, type, callback, dev, field, name) \
39 ktime_t __start = ktime_get(); \
40 type __retval = GENPD_DEV_CALLBACK(genpd, type, callback, dev); \
41 s64 __elapsed = ktime_to_ns(ktime_sub(ktime_get(), __start)); \
42 struct gpd_timing_data *__td = &dev_gpd_data(dev)->td; \
43 if (!__retval && __elapsed > __td->field) { \
44 __td->field = __elapsed; \
45 dev_dbg(dev, name " latency exceeded, new value %lld ns\n", \
47 genpd->max_off_time_changed = true; \
48 __td->constraint_changed = true; \
53 static LIST_HEAD(gpd_list);
54 static DEFINE_MUTEX(gpd_list_lock);
57 * Get the generic PM domain for a particular struct device.
58 * This validates the struct device pointer, the PM domain pointer,
59 * and checks that the PM domain pointer is a real generic PM domain.
60 * Any failure results in NULL being returned.
62 struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
64 struct generic_pm_domain *genpd = NULL, *gpd;
66 if (IS_ERR_OR_NULL(dev) || IS_ERR_OR_NULL(dev->pm_domain))
69 mutex_lock(&gpd_list_lock);
70 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
71 if (&gpd->domain == dev->pm_domain) {
76 mutex_unlock(&gpd_list_lock);
82 * This should only be used where we are certain that the pm_domain
83 * attached to the device is a genpd domain.
85 static struct generic_pm_domain *dev_to_genpd(struct device *dev)
87 if (IS_ERR_OR_NULL(dev->pm_domain))
88 return ERR_PTR(-EINVAL);
90 return pd_to_genpd(dev->pm_domain);
93 static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
95 return GENPD_DEV_TIMED_CALLBACK(genpd, int, stop, dev,
96 stop_latency_ns, "stop");
99 static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev,
103 return GENPD_DEV_CALLBACK(genpd, int, start, dev);
105 return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
106 start_latency_ns, "start");
109 static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
113 if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
114 ret = !!atomic_dec_and_test(&genpd->sd_count);
119 static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
121 atomic_inc(&genpd->sd_count);
122 smp_mb__after_atomic();
125 static void genpd_recalc_cpu_exit_latency(struct generic_pm_domain *genpd)
129 if (!genpd->cpuidle_data)
132 usecs64 = genpd->power_on_latency_ns;
133 do_div(usecs64, NSEC_PER_USEC);
134 usecs64 += genpd->cpuidle_data->saved_exit_latency;
135 genpd->cpuidle_data->idle_state->exit_latency = usecs64;
138 static int genpd_power_on(struct generic_pm_domain *genpd, bool timed)
144 if (!genpd->power_on)
148 return genpd->power_on(genpd);
150 time_start = ktime_get();
151 ret = genpd->power_on(genpd);
155 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
156 if (elapsed_ns <= genpd->power_on_latency_ns)
159 genpd->power_on_latency_ns = elapsed_ns;
160 genpd->max_off_time_changed = true;
161 genpd_recalc_cpu_exit_latency(genpd);
162 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
163 genpd->name, "on", elapsed_ns);
168 static int genpd_power_off(struct generic_pm_domain *genpd, bool timed)
174 if (!genpd->power_off)
178 return genpd->power_off(genpd);
180 time_start = ktime_get();
181 ret = genpd->power_off(genpd);
185 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
186 if (elapsed_ns <= genpd->power_off_latency_ns)
189 genpd->power_off_latency_ns = elapsed_ns;
190 genpd->max_off_time_changed = true;
191 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
192 genpd->name, "off", elapsed_ns);
198 * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
199 * @genpd: PM domait to power off.
201 * Queue up the execution of pm_genpd_poweroff() unless it's already been done
204 static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
206 queue_work(pm_wq, &genpd->power_off_work);
210 * __pm_genpd_poweron - Restore power to a given PM domain and its masters.
211 * @genpd: PM domain to power up.
213 * Restore power to @genpd and all of its masters so that it is possible to
214 * resume a device belonging to it.
216 static int __pm_genpd_poweron(struct generic_pm_domain *genpd)
218 struct gpd_link *link;
221 if (genpd->status == GPD_STATE_ACTIVE
222 || (genpd->prepared_count > 0 && genpd->suspend_power_off))
225 if (genpd->cpuidle_data) {
226 cpuidle_pause_and_lock();
227 genpd->cpuidle_data->idle_state->disabled = true;
228 cpuidle_resume_and_unlock();
233 * The list is guaranteed not to change while the loop below is being
234 * executed, unless one of the masters' .power_on() callbacks fiddles
237 list_for_each_entry(link, &genpd->slave_links, slave_node) {
238 genpd_sd_counter_inc(link->master);
240 ret = pm_genpd_poweron(link->master);
242 genpd_sd_counter_dec(link->master);
247 ret = genpd_power_on(genpd, true);
252 genpd->status = GPD_STATE_ACTIVE;
256 list_for_each_entry_continue_reverse(link,
259 genpd_sd_counter_dec(link->master);
260 genpd_queue_power_off_work(link->master);
267 * pm_genpd_poweron - Restore power to a given PM domain and its masters.
268 * @genpd: PM domain to power up.
270 int pm_genpd_poweron(struct generic_pm_domain *genpd)
274 mutex_lock(&genpd->lock);
275 ret = __pm_genpd_poweron(genpd);
276 mutex_unlock(&genpd->lock);
280 static int genpd_save_dev(struct generic_pm_domain *genpd, struct device *dev)
282 return GENPD_DEV_TIMED_CALLBACK(genpd, int, save_state, dev,
283 save_state_latency_ns, "state save");
286 static int genpd_restore_dev(struct generic_pm_domain *genpd,
287 struct device *dev, bool timed)
290 return GENPD_DEV_CALLBACK(genpd, int, restore_state, dev);
292 return GENPD_DEV_TIMED_CALLBACK(genpd, int, restore_state, dev,
293 restore_state_latency_ns,
297 static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
298 unsigned long val, void *ptr)
300 struct generic_pm_domain_data *gpd_data;
303 gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
304 dev = gpd_data->base.dev;
307 struct generic_pm_domain *genpd;
308 struct pm_domain_data *pdd;
310 spin_lock_irq(&dev->power.lock);
312 pdd = dev->power.subsys_data ?
313 dev->power.subsys_data->domain_data : NULL;
314 if (pdd && pdd->dev) {
315 to_gpd_data(pdd)->td.constraint_changed = true;
316 genpd = dev_to_genpd(dev);
318 genpd = ERR_PTR(-ENODATA);
321 spin_unlock_irq(&dev->power.lock);
323 if (!IS_ERR(genpd)) {
324 mutex_lock(&genpd->lock);
325 genpd->max_off_time_changed = true;
326 mutex_unlock(&genpd->lock);
330 if (!dev || dev->power.ignore_children)
338 * pm_genpd_poweroff - Remove power from a given PM domain.
339 * @genpd: PM domain to power down.
341 * If all of the @genpd's devices have been suspended and all of its subdomains
342 * have been powered down, remove power from @genpd.
344 static int pm_genpd_poweroff(struct generic_pm_domain *genpd)
346 struct pm_domain_data *pdd;
347 struct gpd_link *link;
348 unsigned int not_suspended = 0;
351 * Do not try to power off the domain in the following situations:
352 * (1) The domain is already in the "power off" state.
353 * (2) System suspend is in progress.
355 if (genpd->status == GPD_STATE_POWER_OFF
356 || genpd->prepared_count > 0)
359 if (atomic_read(&genpd->sd_count) > 0)
362 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
363 enum pm_qos_flags_status stat;
365 stat = dev_pm_qos_flags(pdd->dev,
366 PM_QOS_FLAG_NO_POWER_OFF
367 | PM_QOS_FLAG_REMOTE_WAKEUP);
368 if (stat > PM_QOS_FLAGS_NONE)
371 if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
372 || pdd->dev->power.irq_safe))
376 if (not_suspended > genpd->in_progress)
379 if (genpd->gov && genpd->gov->power_down_ok) {
380 if (!genpd->gov->power_down_ok(&genpd->domain))
384 if (genpd->cpuidle_data) {
386 * If cpuidle_data is set, cpuidle should turn the domain off
387 * when the CPU in it is idle. In that case we don't decrement
388 * the subdomain counts of the master domains, so that power is
389 * not removed from the current domain prematurely as a result
390 * of cutting off the masters' power.
392 genpd->status = GPD_STATE_POWER_OFF;
393 cpuidle_pause_and_lock();
394 genpd->cpuidle_data->idle_state->disabled = false;
395 cpuidle_resume_and_unlock();
399 if (genpd->power_off) {
402 if (atomic_read(&genpd->sd_count) > 0)
406 * If sd_count > 0 at this point, one of the subdomains hasn't
407 * managed to call pm_genpd_poweron() for the master yet after
408 * incrementing it. In that case pm_genpd_poweron() will wait
409 * for us to drop the lock, so we can call .power_off() and let
410 * the pm_genpd_poweron() restore power for us (this shouldn't
411 * happen very often).
413 ret = genpd_power_off(genpd, true);
418 genpd->status = GPD_STATE_POWER_OFF;
420 list_for_each_entry(link, &genpd->slave_links, slave_node) {
421 genpd_sd_counter_dec(link->master);
422 genpd_queue_power_off_work(link->master);
429 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
430 * @work: Work structure used for scheduling the execution of this function.
432 static void genpd_power_off_work_fn(struct work_struct *work)
434 struct generic_pm_domain *genpd;
436 genpd = container_of(work, struct generic_pm_domain, power_off_work);
438 mutex_lock(&genpd->lock);
439 pm_genpd_poweroff(genpd);
440 mutex_unlock(&genpd->lock);
444 * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
445 * @dev: Device to suspend.
447 * Carry out a runtime suspend of a device under the assumption that its
448 * pm_domain field points to the domain member of an object of type
449 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
451 static int pm_genpd_runtime_suspend(struct device *dev)
453 struct generic_pm_domain *genpd;
454 bool (*stop_ok)(struct device *__dev);
457 dev_dbg(dev, "%s()\n", __func__);
459 genpd = dev_to_genpd(dev);
463 stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
464 if (stop_ok && !stop_ok(dev))
467 ret = genpd_save_dev(genpd, dev);
471 ret = genpd_stop_dev(genpd, dev);
473 genpd_restore_dev(genpd, dev, true);
478 * If power.irq_safe is set, this routine will be run with interrupts
479 * off, so it can't use mutexes.
481 if (dev->power.irq_safe)
484 mutex_lock(&genpd->lock);
485 genpd->in_progress++;
486 pm_genpd_poweroff(genpd);
487 genpd->in_progress--;
488 mutex_unlock(&genpd->lock);
494 * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
495 * @dev: Device to resume.
497 * Carry out a runtime resume of a device under the assumption that its
498 * pm_domain field points to the domain member of an object of type
499 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
501 static int pm_genpd_runtime_resume(struct device *dev)
503 struct generic_pm_domain *genpd;
507 dev_dbg(dev, "%s()\n", __func__);
509 genpd = dev_to_genpd(dev);
513 /* If power.irq_safe, the PM domain is never powered off. */
514 if (dev->power.irq_safe) {
519 mutex_lock(&genpd->lock);
520 ret = __pm_genpd_poweron(genpd);
521 mutex_unlock(&genpd->lock);
527 genpd_start_dev(genpd, dev, timed);
528 genpd_restore_dev(genpd, dev, timed);
533 static bool pd_ignore_unused;
534 static int __init pd_ignore_unused_setup(char *__unused)
536 pd_ignore_unused = true;
539 __setup("pd_ignore_unused", pd_ignore_unused_setup);
542 * pm_genpd_poweroff_unused - Power off all PM domains with no devices in use.
544 void pm_genpd_poweroff_unused(void)
546 struct generic_pm_domain *genpd;
548 if (pd_ignore_unused) {
549 pr_warn("genpd: Not disabling unused power domains\n");
553 mutex_lock(&gpd_list_lock);
555 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
556 genpd_queue_power_off_work(genpd);
558 mutex_unlock(&gpd_list_lock);
561 static int __init genpd_poweroff_unused(void)
563 pm_genpd_poweroff_unused();
566 late_initcall(genpd_poweroff_unused);
568 #ifdef CONFIG_PM_SLEEP
571 * pm_genpd_present - Check if the given PM domain has been initialized.
572 * @genpd: PM domain to check.
574 static bool pm_genpd_present(const struct generic_pm_domain *genpd)
576 const struct generic_pm_domain *gpd;
578 if (IS_ERR_OR_NULL(genpd))
581 list_for_each_entry(gpd, &gpd_list, gpd_list_node)
588 static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
591 return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
595 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
596 * @genpd: PM domain to power off, if possible.
597 * @timed: True if latency measurements are allowed.
599 * Check if the given PM domain can be powered off (during system suspend or
600 * hibernation) and do that if so. Also, in that case propagate to its masters.
602 * This function is only called in "noirq" and "syscore" stages of system power
603 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
604 * executed sequentially, so it is guaranteed that it will never run twice in
607 static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd,
610 struct gpd_link *link;
612 if (genpd->status == GPD_STATE_POWER_OFF)
615 if (genpd->suspended_count != genpd->device_count
616 || atomic_read(&genpd->sd_count) > 0)
619 genpd_power_off(genpd, timed);
621 genpd->status = GPD_STATE_POWER_OFF;
623 list_for_each_entry(link, &genpd->slave_links, slave_node) {
624 genpd_sd_counter_dec(link->master);
625 pm_genpd_sync_poweroff(link->master, timed);
630 * pm_genpd_sync_poweron - Synchronously power on a PM domain and its masters.
631 * @genpd: PM domain to power on.
632 * @timed: True if latency measurements are allowed.
634 * This function is only called in "noirq" and "syscore" stages of system power
635 * transitions, so it need not acquire locks (all of the "noirq" callbacks are
636 * executed sequentially, so it is guaranteed that it will never run twice in
639 static void pm_genpd_sync_poweron(struct generic_pm_domain *genpd,
642 struct gpd_link *link;
644 if (genpd->status == GPD_STATE_ACTIVE)
647 list_for_each_entry(link, &genpd->slave_links, slave_node) {
648 pm_genpd_sync_poweron(link->master, timed);
649 genpd_sd_counter_inc(link->master);
652 genpd_power_on(genpd, timed);
654 genpd->status = GPD_STATE_ACTIVE;
658 * resume_needed - Check whether to resume a device before system suspend.
659 * @dev: Device to check.
660 * @genpd: PM domain the device belongs to.
662 * There are two cases in which a device that can wake up the system from sleep
663 * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
664 * to wake up the system and it has to remain active for this purpose while the
665 * system is in the sleep state and (2) if the device is not enabled to wake up
666 * the system from sleep states and it generally doesn't generate wakeup signals
667 * by itself (those signals are generated on its behalf by other parts of the
668 * system). In the latter case it may be necessary to reconfigure the device's
669 * wakeup settings during system suspend, because it may have been set up to
670 * signal remote wakeup from the system's working state as needed by runtime PM.
671 * Return 'true' in either of the above cases.
673 static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
677 if (!device_can_wakeup(dev))
680 active_wakeup = genpd_dev_active_wakeup(genpd, dev);
681 return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
685 * pm_genpd_prepare - Start power transition of a device in a PM domain.
686 * @dev: Device to start the transition of.
688 * Start a power transition of a device (during a system-wide power transition)
689 * under the assumption that its pm_domain field points to the domain member of
690 * an object of type struct generic_pm_domain representing a PM domain
691 * consisting of I/O devices.
693 static int pm_genpd_prepare(struct device *dev)
695 struct generic_pm_domain *genpd;
698 dev_dbg(dev, "%s()\n", __func__);
700 genpd = dev_to_genpd(dev);
705 * If a wakeup request is pending for the device, it should be woken up
706 * at this point and a system wakeup event should be reported if it's
707 * set up to wake up the system from sleep states.
709 pm_runtime_get_noresume(dev);
710 if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
711 pm_wakeup_event(dev, 0);
713 if (pm_wakeup_pending()) {
718 if (resume_needed(dev, genpd))
719 pm_runtime_resume(dev);
721 mutex_lock(&genpd->lock);
723 if (genpd->prepared_count++ == 0) {
724 genpd->suspended_count = 0;
725 genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
728 mutex_unlock(&genpd->lock);
730 if (genpd->suspend_power_off) {
731 pm_runtime_put_noidle(dev);
736 * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
737 * so pm_genpd_poweron() will return immediately, but if the device
738 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
739 * to make it operational.
741 pm_runtime_resume(dev);
742 __pm_runtime_disable(dev, false);
744 ret = pm_generic_prepare(dev);
746 mutex_lock(&genpd->lock);
748 if (--genpd->prepared_count == 0)
749 genpd->suspend_power_off = false;
751 mutex_unlock(&genpd->lock);
752 pm_runtime_enable(dev);
760 * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
761 * @dev: Device to suspend.
763 * Suspend a device under the assumption that its pm_domain field points to the
764 * domain member of an object of type struct generic_pm_domain representing
765 * a PM domain consisting of I/O devices.
767 static int pm_genpd_suspend(struct device *dev)
769 struct generic_pm_domain *genpd;
771 dev_dbg(dev, "%s()\n", __func__);
773 genpd = dev_to_genpd(dev);
777 return genpd->suspend_power_off ? 0 : pm_generic_suspend(dev);
781 * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
782 * @dev: Device to suspend.
784 * Carry out a late suspend of a device under the assumption that its
785 * pm_domain field points to the domain member of an object of type
786 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
788 static int pm_genpd_suspend_late(struct device *dev)
790 struct generic_pm_domain *genpd;
792 dev_dbg(dev, "%s()\n", __func__);
794 genpd = dev_to_genpd(dev);
798 return genpd->suspend_power_off ? 0 : pm_generic_suspend_late(dev);
802 * pm_genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
803 * @dev: Device to suspend.
805 * Stop the device and remove power from the domain if all devices in it have
808 static int pm_genpd_suspend_noirq(struct device *dev)
810 struct generic_pm_domain *genpd;
812 dev_dbg(dev, "%s()\n", __func__);
814 genpd = dev_to_genpd(dev);
818 if (genpd->suspend_power_off
819 || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
822 genpd_stop_dev(genpd, dev);
825 * Since all of the "noirq" callbacks are executed sequentially, it is
826 * guaranteed that this function will never run twice in parallel for
827 * the same PM domain, so it is not necessary to use locking here.
829 genpd->suspended_count++;
830 pm_genpd_sync_poweroff(genpd, true);
836 * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
837 * @dev: Device to resume.
839 * Restore power to the device's PM domain, if necessary, and start the device.
841 static int pm_genpd_resume_noirq(struct device *dev)
843 struct generic_pm_domain *genpd;
845 dev_dbg(dev, "%s()\n", __func__);
847 genpd = dev_to_genpd(dev);
851 if (genpd->suspend_power_off
852 || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
856 * Since all of the "noirq" callbacks are executed sequentially, it is
857 * guaranteed that this function will never run twice in parallel for
858 * the same PM domain, so it is not necessary to use locking here.
860 pm_genpd_sync_poweron(genpd, true);
861 genpd->suspended_count--;
863 return genpd_start_dev(genpd, dev, true);
867 * pm_genpd_resume_early - Early resume of a device in an I/O PM domain.
868 * @dev: Device to resume.
870 * Carry out an early resume of a device under the assumption that its
871 * pm_domain field points to the domain member of an object of type
872 * struct generic_pm_domain representing a power domain consisting of I/O
875 static int pm_genpd_resume_early(struct device *dev)
877 struct generic_pm_domain *genpd;
879 dev_dbg(dev, "%s()\n", __func__);
881 genpd = dev_to_genpd(dev);
885 return genpd->suspend_power_off ? 0 : pm_generic_resume_early(dev);
889 * pm_genpd_resume - Resume of device in an I/O PM domain.
890 * @dev: Device to resume.
892 * Resume a device under the assumption that its pm_domain field points to the
893 * domain member of an object of type struct generic_pm_domain representing
894 * a power domain consisting of I/O devices.
896 static int pm_genpd_resume(struct device *dev)
898 struct generic_pm_domain *genpd;
900 dev_dbg(dev, "%s()\n", __func__);
902 genpd = dev_to_genpd(dev);
906 return genpd->suspend_power_off ? 0 : pm_generic_resume(dev);
910 * pm_genpd_freeze - Freezing a device in an I/O PM domain.
911 * @dev: Device to freeze.
913 * Freeze a device under the assumption that its pm_domain field points to the
914 * domain member of an object of type struct generic_pm_domain representing
915 * a power domain consisting of I/O devices.
917 static int pm_genpd_freeze(struct device *dev)
919 struct generic_pm_domain *genpd;
921 dev_dbg(dev, "%s()\n", __func__);
923 genpd = dev_to_genpd(dev);
927 return genpd->suspend_power_off ? 0 : pm_generic_freeze(dev);
931 * pm_genpd_freeze_late - Late freeze of a device in an I/O PM domain.
932 * @dev: Device to freeze.
934 * Carry out a late freeze of a device under the assumption that its
935 * pm_domain field points to the domain member of an object of type
936 * struct generic_pm_domain representing a power domain consisting of I/O
939 static int pm_genpd_freeze_late(struct device *dev)
941 struct generic_pm_domain *genpd;
943 dev_dbg(dev, "%s()\n", __func__);
945 genpd = dev_to_genpd(dev);
949 return genpd->suspend_power_off ? 0 : pm_generic_freeze_late(dev);
953 * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
954 * @dev: Device to freeze.
956 * Carry out a late freeze of a device under the assumption that its
957 * pm_domain field points to the domain member of an object of type
958 * struct generic_pm_domain representing a power domain consisting of I/O
961 static int pm_genpd_freeze_noirq(struct device *dev)
963 struct generic_pm_domain *genpd;
965 dev_dbg(dev, "%s()\n", __func__);
967 genpd = dev_to_genpd(dev);
971 return genpd->suspend_power_off ? 0 : genpd_stop_dev(genpd, dev);
975 * pm_genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
976 * @dev: Device to thaw.
978 * Start the device, unless power has been removed from the domain already
979 * before the system transition.
981 static int pm_genpd_thaw_noirq(struct device *dev)
983 struct generic_pm_domain *genpd;
985 dev_dbg(dev, "%s()\n", __func__);
987 genpd = dev_to_genpd(dev);
991 return genpd->suspend_power_off ? 0 : genpd_start_dev(genpd, dev, true);
995 * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
996 * @dev: Device to thaw.
998 * Carry out an early thaw of a device under the assumption that its
999 * pm_domain field points to the domain member of an object of type
1000 * struct generic_pm_domain representing a power domain consisting of I/O
1003 static int pm_genpd_thaw_early(struct device *dev)
1005 struct generic_pm_domain *genpd;
1007 dev_dbg(dev, "%s()\n", __func__);
1009 genpd = dev_to_genpd(dev);
1013 return genpd->suspend_power_off ? 0 : pm_generic_thaw_early(dev);
1017 * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
1018 * @dev: Device to thaw.
1020 * Thaw a device under the assumption that its pm_domain field points to the
1021 * domain member of an object of type struct generic_pm_domain representing
1022 * a power domain consisting of I/O devices.
1024 static int pm_genpd_thaw(struct device *dev)
1026 struct generic_pm_domain *genpd;
1028 dev_dbg(dev, "%s()\n", __func__);
1030 genpd = dev_to_genpd(dev);
1034 return genpd->suspend_power_off ? 0 : pm_generic_thaw(dev);
1038 * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1039 * @dev: Device to resume.
1041 * Make sure the domain will be in the same power state as before the
1042 * hibernation the system is resuming from and start the device if necessary.
1044 static int pm_genpd_restore_noirq(struct device *dev)
1046 struct generic_pm_domain *genpd;
1048 dev_dbg(dev, "%s()\n", __func__);
1050 genpd = dev_to_genpd(dev);
1055 * Since all of the "noirq" callbacks are executed sequentially, it is
1056 * guaranteed that this function will never run twice in parallel for
1057 * the same PM domain, so it is not necessary to use locking here.
1059 * At this point suspended_count == 0 means we are being run for the
1060 * first time for the given domain in the present cycle.
1062 if (genpd->suspended_count++ == 0) {
1064 * The boot kernel might put the domain into arbitrary state,
1065 * so make it appear as powered off to pm_genpd_sync_poweron(),
1066 * so that it tries to power it on in case it was really off.
1068 genpd->status = GPD_STATE_POWER_OFF;
1069 if (genpd->suspend_power_off) {
1071 * If the domain was off before the hibernation, make
1072 * sure it will be off going forward.
1074 genpd_power_off(genpd, true);
1080 if (genpd->suspend_power_off)
1083 pm_genpd_sync_poweron(genpd, true);
1085 return genpd_start_dev(genpd, dev, true);
1089 * pm_genpd_complete - Complete power transition of a device in a power domain.
1090 * @dev: Device to complete the transition of.
1092 * Complete a power transition of a device (during a system-wide power
1093 * transition) under the assumption that its pm_domain field points to the
1094 * domain member of an object of type struct generic_pm_domain representing
1095 * a power domain consisting of I/O devices.
1097 static void pm_genpd_complete(struct device *dev)
1099 struct generic_pm_domain *genpd;
1102 dev_dbg(dev, "%s()\n", __func__);
1104 genpd = dev_to_genpd(dev);
1108 mutex_lock(&genpd->lock);
1110 run_complete = !genpd->suspend_power_off;
1111 if (--genpd->prepared_count == 0)
1112 genpd->suspend_power_off = false;
1114 mutex_unlock(&genpd->lock);
1117 pm_generic_complete(dev);
1118 pm_runtime_set_active(dev);
1119 pm_runtime_enable(dev);
1120 pm_request_idle(dev);
1125 * genpd_syscore_switch - Switch power during system core suspend or resume.
1126 * @dev: Device that normally is marked as "always on" to switch power for.
1128 * This routine may only be called during the system core (syscore) suspend or
1129 * resume phase for devices whose "always on" flags are set.
1131 static void genpd_syscore_switch(struct device *dev, bool suspend)
1133 struct generic_pm_domain *genpd;
1135 genpd = dev_to_genpd(dev);
1136 if (!pm_genpd_present(genpd))
1140 genpd->suspended_count++;
1141 pm_genpd_sync_poweroff(genpd, false);
1143 pm_genpd_sync_poweron(genpd, false);
1144 genpd->suspended_count--;
1148 void pm_genpd_syscore_poweroff(struct device *dev)
1150 genpd_syscore_switch(dev, true);
1152 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweroff);
1154 void pm_genpd_syscore_poweron(struct device *dev)
1156 genpd_syscore_switch(dev, false);
1158 EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweron);
1160 #else /* !CONFIG_PM_SLEEP */
1162 #define pm_genpd_prepare NULL
1163 #define pm_genpd_suspend NULL
1164 #define pm_genpd_suspend_late NULL
1165 #define pm_genpd_suspend_noirq NULL
1166 #define pm_genpd_resume_early NULL
1167 #define pm_genpd_resume_noirq NULL
1168 #define pm_genpd_resume NULL
1169 #define pm_genpd_freeze NULL
1170 #define pm_genpd_freeze_late NULL
1171 #define pm_genpd_freeze_noirq NULL
1172 #define pm_genpd_thaw_early NULL
1173 #define pm_genpd_thaw_noirq NULL
1174 #define pm_genpd_thaw NULL
1175 #define pm_genpd_restore_noirq NULL
1176 #define pm_genpd_complete NULL
1178 #endif /* CONFIG_PM_SLEEP */
1180 static struct generic_pm_domain_data *genpd_alloc_dev_data(struct device *dev,
1181 struct generic_pm_domain *genpd,
1182 struct gpd_timing_data *td)
1184 struct generic_pm_domain_data *gpd_data;
1187 ret = dev_pm_get_subsys_data(dev);
1189 return ERR_PTR(ret);
1191 gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
1200 gpd_data->base.dev = dev;
1201 gpd_data->td.constraint_changed = true;
1202 gpd_data->td.effective_constraint_ns = -1;
1203 gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
1205 spin_lock_irq(&dev->power.lock);
1207 if (dev->power.subsys_data->domain_data) {
1212 dev->power.subsys_data->domain_data = &gpd_data->base;
1213 dev->pm_domain = &genpd->domain;
1215 spin_unlock_irq(&dev->power.lock);
1220 spin_unlock_irq(&dev->power.lock);
1223 dev_pm_put_subsys_data(dev);
1224 return ERR_PTR(ret);
1227 static void genpd_free_dev_data(struct device *dev,
1228 struct generic_pm_domain_data *gpd_data)
1230 spin_lock_irq(&dev->power.lock);
1232 dev->pm_domain = NULL;
1233 dev->power.subsys_data->domain_data = NULL;
1235 spin_unlock_irq(&dev->power.lock);
1238 dev_pm_put_subsys_data(dev);
1242 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1243 * @genpd: PM domain to add the device to.
1244 * @dev: Device to be added.
1245 * @td: Set of PM QoS timing parameters to attach to the device.
1247 int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1248 struct gpd_timing_data *td)
1250 struct generic_pm_domain_data *gpd_data;
1253 dev_dbg(dev, "%s()\n", __func__);
1255 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1258 gpd_data = genpd_alloc_dev_data(dev, genpd, td);
1259 if (IS_ERR(gpd_data))
1260 return PTR_ERR(gpd_data);
1262 mutex_lock(&genpd->lock);
1264 if (genpd->prepared_count > 0) {
1269 ret = genpd->attach_dev ? genpd->attach_dev(genpd, dev) : 0;
1273 genpd->device_count++;
1274 genpd->max_off_time_changed = true;
1276 list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1279 mutex_unlock(&genpd->lock);
1282 genpd_free_dev_data(dev, gpd_data);
1284 dev_pm_qos_add_notifier(dev, &gpd_data->nb);
1290 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1291 * @genpd: PM domain to remove the device from.
1292 * @dev: Device to be removed.
1294 int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1297 struct generic_pm_domain_data *gpd_data;
1298 struct pm_domain_data *pdd;
1301 dev_dbg(dev, "%s()\n", __func__);
1303 if (!genpd || genpd != pm_genpd_lookup_dev(dev))
1306 /* The above validation also means we have existing domain_data. */
1307 pdd = dev->power.subsys_data->domain_data;
1308 gpd_data = to_gpd_data(pdd);
1309 dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
1311 mutex_lock(&genpd->lock);
1313 if (genpd->prepared_count > 0) {
1318 genpd->device_count--;
1319 genpd->max_off_time_changed = true;
1321 if (genpd->detach_dev)
1322 genpd->detach_dev(genpd, dev);
1324 list_del_init(&pdd->list_node);
1326 mutex_unlock(&genpd->lock);
1328 genpd_free_dev_data(dev, gpd_data);
1333 mutex_unlock(&genpd->lock);
1334 dev_pm_qos_add_notifier(dev, &gpd_data->nb);
1340 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1341 * @genpd: Master PM domain to add the subdomain to.
1342 * @subdomain: Subdomain to be added.
1344 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1345 struct generic_pm_domain *subdomain)
1347 struct gpd_link *link;
1350 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
1351 || genpd == subdomain)
1354 mutex_lock(&genpd->lock);
1355 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1357 if (genpd->status == GPD_STATE_POWER_OFF
1358 && subdomain->status != GPD_STATE_POWER_OFF) {
1363 list_for_each_entry(link, &genpd->master_links, master_node) {
1364 if (link->slave == subdomain && link->master == genpd) {
1370 link = kzalloc(sizeof(*link), GFP_KERNEL);
1375 link->master = genpd;
1376 list_add_tail(&link->master_node, &genpd->master_links);
1377 link->slave = subdomain;
1378 list_add_tail(&link->slave_node, &subdomain->slave_links);
1379 if (subdomain->status != GPD_STATE_POWER_OFF)
1380 genpd_sd_counter_inc(genpd);
1383 mutex_unlock(&subdomain->lock);
1384 mutex_unlock(&genpd->lock);
1390 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1391 * @genpd: Master PM domain to remove the subdomain from.
1392 * @subdomain: Subdomain to be removed.
1394 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1395 struct generic_pm_domain *subdomain)
1397 struct gpd_link *link;
1400 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1403 mutex_lock(&genpd->lock);
1405 if (!list_empty(&subdomain->slave_links) || subdomain->device_count) {
1406 pr_warn("%s: unable to remove subdomain %s\n", genpd->name,
1412 list_for_each_entry(link, &genpd->master_links, master_node) {
1413 if (link->slave != subdomain)
1416 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1418 list_del(&link->master_node);
1419 list_del(&link->slave_node);
1421 if (subdomain->status != GPD_STATE_POWER_OFF)
1422 genpd_sd_counter_dec(genpd);
1424 mutex_unlock(&subdomain->lock);
1431 mutex_unlock(&genpd->lock);
1437 * pm_genpd_attach_cpuidle - Connect the given PM domain with cpuidle.
1438 * @genpd: PM domain to be connected with cpuidle.
1439 * @state: cpuidle state this domain can disable/enable.
1441 * Make a PM domain behave as though it contained a CPU core, that is, instead
1442 * of calling its power down routine it will enable the given cpuidle state so
1443 * that the cpuidle subsystem can power it down (if possible and desirable).
1445 int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state)
1447 struct cpuidle_driver *cpuidle_drv;
1448 struct gpd_cpuidle_data *cpuidle_data;
1449 struct cpuidle_state *idle_state;
1452 if (IS_ERR_OR_NULL(genpd) || state < 0)
1455 mutex_lock(&genpd->lock);
1457 if (genpd->cpuidle_data) {
1461 cpuidle_data = kzalloc(sizeof(*cpuidle_data), GFP_KERNEL);
1462 if (!cpuidle_data) {
1466 cpuidle_drv = cpuidle_driver_ref();
1471 if (cpuidle_drv->state_count <= state) {
1475 idle_state = &cpuidle_drv->states[state];
1476 if (!idle_state->disabled) {
1480 cpuidle_data->idle_state = idle_state;
1481 cpuidle_data->saved_exit_latency = idle_state->exit_latency;
1482 genpd->cpuidle_data = cpuidle_data;
1483 genpd_recalc_cpu_exit_latency(genpd);
1486 mutex_unlock(&genpd->lock);
1490 cpuidle_driver_unref();
1493 kfree(cpuidle_data);
1498 * pm_genpd_detach_cpuidle - Remove the cpuidle connection from a PM domain.
1499 * @genpd: PM domain to remove the cpuidle connection from.
1501 * Remove the cpuidle connection set up by pm_genpd_attach_cpuidle() from the
1504 int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
1506 struct gpd_cpuidle_data *cpuidle_data;
1507 struct cpuidle_state *idle_state;
1510 if (IS_ERR_OR_NULL(genpd))
1513 mutex_lock(&genpd->lock);
1515 cpuidle_data = genpd->cpuidle_data;
1516 if (!cpuidle_data) {
1520 idle_state = cpuidle_data->idle_state;
1521 if (!idle_state->disabled) {
1525 idle_state->exit_latency = cpuidle_data->saved_exit_latency;
1526 cpuidle_driver_unref();
1527 genpd->cpuidle_data = NULL;
1528 kfree(cpuidle_data);
1531 mutex_unlock(&genpd->lock);
1535 /* Default device callbacks for generic PM domains. */
1538 * pm_genpd_default_save_state - Default "save device state" for PM domains.
1539 * @dev: Device to handle.
1541 static int pm_genpd_default_save_state(struct device *dev)
1543 int (*cb)(struct device *__dev);
1545 if (dev->type && dev->type->pm)
1546 cb = dev->type->pm->runtime_suspend;
1547 else if (dev->class && dev->class->pm)
1548 cb = dev->class->pm->runtime_suspend;
1549 else if (dev->bus && dev->bus->pm)
1550 cb = dev->bus->pm->runtime_suspend;
1554 if (!cb && dev->driver && dev->driver->pm)
1555 cb = dev->driver->pm->runtime_suspend;
1557 return cb ? cb(dev) : 0;
1561 * pm_genpd_default_restore_state - Default PM domains "restore device state".
1562 * @dev: Device to handle.
1564 static int pm_genpd_default_restore_state(struct device *dev)
1566 int (*cb)(struct device *__dev);
1568 if (dev->type && dev->type->pm)
1569 cb = dev->type->pm->runtime_resume;
1570 else if (dev->class && dev->class->pm)
1571 cb = dev->class->pm->runtime_resume;
1572 else if (dev->bus && dev->bus->pm)
1573 cb = dev->bus->pm->runtime_resume;
1577 if (!cb && dev->driver && dev->driver->pm)
1578 cb = dev->driver->pm->runtime_resume;
1580 return cb ? cb(dev) : 0;
1584 * pm_genpd_init - Initialize a generic I/O PM domain object.
1585 * @genpd: PM domain object to initialize.
1586 * @gov: PM domain governor to associate with the domain (may be NULL).
1587 * @is_off: Initial value of the domain's power_is_off field.
1589 void pm_genpd_init(struct generic_pm_domain *genpd,
1590 struct dev_power_governor *gov, bool is_off)
1592 if (IS_ERR_OR_NULL(genpd))
1595 INIT_LIST_HEAD(&genpd->master_links);
1596 INIT_LIST_HEAD(&genpd->slave_links);
1597 INIT_LIST_HEAD(&genpd->dev_list);
1598 mutex_init(&genpd->lock);
1600 INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1601 genpd->in_progress = 0;
1602 atomic_set(&genpd->sd_count, 0);
1603 genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
1604 genpd->device_count = 0;
1605 genpd->max_off_time_ns = -1;
1606 genpd->max_off_time_changed = true;
1607 genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
1608 genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
1609 genpd->domain.ops.prepare = pm_genpd_prepare;
1610 genpd->domain.ops.suspend = pm_genpd_suspend;
1611 genpd->domain.ops.suspend_late = pm_genpd_suspend_late;
1612 genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
1613 genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1614 genpd->domain.ops.resume_early = pm_genpd_resume_early;
1615 genpd->domain.ops.resume = pm_genpd_resume;
1616 genpd->domain.ops.freeze = pm_genpd_freeze;
1617 genpd->domain.ops.freeze_late = pm_genpd_freeze_late;
1618 genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
1619 genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1620 genpd->domain.ops.thaw_early = pm_genpd_thaw_early;
1621 genpd->domain.ops.thaw = pm_genpd_thaw;
1622 genpd->domain.ops.poweroff = pm_genpd_suspend;
1623 genpd->domain.ops.poweroff_late = pm_genpd_suspend_late;
1624 genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
1625 genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1626 genpd->domain.ops.restore_early = pm_genpd_resume_early;
1627 genpd->domain.ops.restore = pm_genpd_resume;
1628 genpd->domain.ops.complete = pm_genpd_complete;
1629 genpd->dev_ops.save_state = pm_genpd_default_save_state;
1630 genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
1632 if (genpd->flags & GENPD_FLAG_PM_CLK) {
1633 genpd->dev_ops.stop = pm_clk_suspend;
1634 genpd->dev_ops.start = pm_clk_resume;
1637 mutex_lock(&gpd_list_lock);
1638 list_add(&genpd->gpd_list_node, &gpd_list);
1639 mutex_unlock(&gpd_list_lock);
1641 EXPORT_SYMBOL_GPL(pm_genpd_init);
1643 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
1645 * Device Tree based PM domain providers.
1647 * The code below implements generic device tree based PM domain providers that
1648 * bind device tree nodes with generic PM domains registered in the system.
1650 * Any driver that registers generic PM domains and needs to support binding of
1651 * devices to these domains is supposed to register a PM domain provider, which
1652 * maps a PM domain specifier retrieved from the device tree to a PM domain.
1654 * Two simple mapping functions have been provided for convenience:
1655 * - __of_genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
1656 * - __of_genpd_xlate_onecell() for mapping of multiple PM domains per node by
1661 * struct of_genpd_provider - PM domain provider registration structure
1662 * @link: Entry in global list of PM domain providers
1663 * @node: Pointer to device tree node of PM domain provider
1664 * @xlate: Provider-specific xlate callback mapping a set of specifier cells
1666 * @data: context pointer to be passed into @xlate callback
1668 struct of_genpd_provider {
1669 struct list_head link;
1670 struct device_node *node;
1671 genpd_xlate_t xlate;
1675 /* List of registered PM domain providers. */
1676 static LIST_HEAD(of_genpd_providers);
1677 /* Mutex to protect the list above. */
1678 static DEFINE_MUTEX(of_genpd_mutex);
1681 * __of_genpd_xlate_simple() - Xlate function for direct node-domain mapping
1682 * @genpdspec: OF phandle args to map into a PM domain
1683 * @data: xlate function private data - pointer to struct generic_pm_domain
1685 * This is a generic xlate function that can be used to model PM domains that
1686 * have their own device tree nodes. The private data of xlate function needs
1687 * to be a valid pointer to struct generic_pm_domain.
1689 struct generic_pm_domain *__of_genpd_xlate_simple(
1690 struct of_phandle_args *genpdspec,
1693 if (genpdspec->args_count != 0)
1694 return ERR_PTR(-EINVAL);
1697 EXPORT_SYMBOL_GPL(__of_genpd_xlate_simple);
1700 * __of_genpd_xlate_onecell() - Xlate function using a single index.
1701 * @genpdspec: OF phandle args to map into a PM domain
1702 * @data: xlate function private data - pointer to struct genpd_onecell_data
1704 * This is a generic xlate function that can be used to model simple PM domain
1705 * controllers that have one device tree node and provide multiple PM domains.
1706 * A single cell is used as an index into an array of PM domains specified in
1707 * the genpd_onecell_data struct when registering the provider.
1709 struct generic_pm_domain *__of_genpd_xlate_onecell(
1710 struct of_phandle_args *genpdspec,
1713 struct genpd_onecell_data *genpd_data = data;
1714 unsigned int idx = genpdspec->args[0];
1716 if (genpdspec->args_count != 1)
1717 return ERR_PTR(-EINVAL);
1719 if (idx >= genpd_data->num_domains) {
1720 pr_err("%s: invalid domain index %u\n", __func__, idx);
1721 return ERR_PTR(-EINVAL);
1724 if (!genpd_data->domains[idx])
1725 return ERR_PTR(-ENOENT);
1727 return genpd_data->domains[idx];
1729 EXPORT_SYMBOL_GPL(__of_genpd_xlate_onecell);
1732 * __of_genpd_add_provider() - Register a PM domain provider for a node
1733 * @np: Device node pointer associated with the PM domain provider.
1734 * @xlate: Callback for decoding PM domain from phandle arguments.
1735 * @data: Context pointer for @xlate callback.
1737 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
1740 struct of_genpd_provider *cp;
1742 cp = kzalloc(sizeof(*cp), GFP_KERNEL);
1746 cp->node = of_node_get(np);
1750 mutex_lock(&of_genpd_mutex);
1751 list_add(&cp->link, &of_genpd_providers);
1752 mutex_unlock(&of_genpd_mutex);
1753 pr_debug("Added domain provider from %s\n", np->full_name);
1757 EXPORT_SYMBOL_GPL(__of_genpd_add_provider);
1760 * of_genpd_del_provider() - Remove a previously registered PM domain provider
1761 * @np: Device node pointer associated with the PM domain provider
1763 void of_genpd_del_provider(struct device_node *np)
1765 struct of_genpd_provider *cp;
1767 mutex_lock(&of_genpd_mutex);
1768 list_for_each_entry(cp, &of_genpd_providers, link) {
1769 if (cp->node == np) {
1770 list_del(&cp->link);
1771 of_node_put(cp->node);
1776 mutex_unlock(&of_genpd_mutex);
1778 EXPORT_SYMBOL_GPL(of_genpd_del_provider);
1781 * of_genpd_get_from_provider() - Look-up PM domain
1782 * @genpdspec: OF phandle args to use for look-up
1784 * Looks for a PM domain provider under the node specified by @genpdspec and if
1785 * found, uses xlate function of the provider to map phandle args to a PM
1788 * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
1791 struct generic_pm_domain *of_genpd_get_from_provider(
1792 struct of_phandle_args *genpdspec)
1794 struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
1795 struct of_genpd_provider *provider;
1797 mutex_lock(&of_genpd_mutex);
1799 /* Check if we have such a provider in our array */
1800 list_for_each_entry(provider, &of_genpd_providers, link) {
1801 if (provider->node == genpdspec->np)
1802 genpd = provider->xlate(genpdspec, provider->data);
1807 mutex_unlock(&of_genpd_mutex);
1811 EXPORT_SYMBOL_GPL(of_genpd_get_from_provider);
1814 * genpd_dev_pm_detach - Detach a device from its PM domain.
1815 * @dev: Device to detach.
1816 * @power_off: Currently not used
1818 * Try to locate a corresponding generic PM domain, which the device was
1819 * attached to previously. If such is found, the device is detached from it.
1821 static void genpd_dev_pm_detach(struct device *dev, bool power_off)
1823 struct generic_pm_domain *pd;
1827 pd = pm_genpd_lookup_dev(dev);
1831 dev_dbg(dev, "removing from PM domain %s\n", pd->name);
1833 for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
1834 ret = pm_genpd_remove_device(pd, dev);
1843 dev_err(dev, "failed to remove from PM domain %s: %d",
1848 /* Check if PM domain can be powered off after removing this device. */
1849 genpd_queue_power_off_work(pd);
1852 static void genpd_dev_pm_sync(struct device *dev)
1854 struct generic_pm_domain *pd;
1856 pd = dev_to_genpd(dev);
1860 genpd_queue_power_off_work(pd);
1864 * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
1865 * @dev: Device to attach.
1867 * Parse device's OF node to find a PM domain specifier. If such is found,
1868 * attaches the device to retrieved pm_domain ops.
1870 * Both generic and legacy Samsung-specific DT bindings are supported to keep
1871 * backwards compatibility with existing DTBs.
1873 * Returns 0 on successfully attached PM domain or negative error code. Note
1874 * that if a power-domain exists for the device, but it cannot be found or
1875 * turned on, then return -EPROBE_DEFER to ensure that the device is not
1876 * probed and to re-try again later.
1878 int genpd_dev_pm_attach(struct device *dev)
1880 struct of_phandle_args pd_args;
1881 struct generic_pm_domain *pd;
1891 ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
1892 "#power-domain-cells", 0, &pd_args);
1898 * Try legacy Samsung-specific bindings
1899 * (for backwards compatibility of DT ABI)
1901 pd_args.args_count = 0;
1902 pd_args.np = of_parse_phandle(dev->of_node,
1903 "samsung,power-domain", 0);
1908 pd = of_genpd_get_from_provider(&pd_args);
1910 dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
1911 __func__, PTR_ERR(pd));
1912 of_node_put(dev->of_node);
1913 return -EPROBE_DEFER;
1916 dev_dbg(dev, "adding to PM domain %s\n", pd->name);
1918 for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
1919 ret = pm_genpd_add_device(pd, dev);
1928 dev_err(dev, "failed to add to PM domain %s: %d",
1930 of_node_put(dev->of_node);
1934 dev->pm_domain->detach = genpd_dev_pm_detach;
1935 dev->pm_domain->sync = genpd_dev_pm_sync;
1936 ret = pm_genpd_poweron(pd);
1939 return ret ? -EPROBE_DEFER : 0;
1941 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
1942 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
1945 /*** debugfs support ***/
1947 #ifdef CONFIG_PM_ADVANCED_DEBUG
1948 #include <linux/pm.h>
1949 #include <linux/device.h>
1950 #include <linux/debugfs.h>
1951 #include <linux/seq_file.h>
1952 #include <linux/init.h>
1953 #include <linux/kobject.h>
1954 static struct dentry *pm_genpd_debugfs_dir;
1957 * TODO: This function is a slightly modified version of rtpm_status_show
1958 * from sysfs.c, so generalize it.
1960 static void rtpm_status_str(struct seq_file *s, struct device *dev)
1962 static const char * const status_lookup[] = {
1963 [RPM_ACTIVE] = "active",
1964 [RPM_RESUMING] = "resuming",
1965 [RPM_SUSPENDED] = "suspended",
1966 [RPM_SUSPENDING] = "suspending"
1970 if (dev->power.runtime_error)
1972 else if (dev->power.disable_depth)
1974 else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
1975 p = status_lookup[dev->power.runtime_status];
1982 static int pm_genpd_summary_one(struct seq_file *s,
1983 struct generic_pm_domain *genpd)
1985 static const char * const status_lookup[] = {
1986 [GPD_STATE_ACTIVE] = "on",
1987 [GPD_STATE_POWER_OFF] = "off"
1989 struct pm_domain_data *pm_data;
1990 const char *kobj_path;
1991 struct gpd_link *link;
1994 ret = mutex_lock_interruptible(&genpd->lock);
1996 return -ERESTARTSYS;
1998 if (WARN_ON(genpd->status >= ARRAY_SIZE(status_lookup)))
2000 seq_printf(s, "%-30s %-15s ", genpd->name, status_lookup[genpd->status]);
2003 * Modifications on the list require holding locks on both
2004 * master and slave, so we are safe.
2005 * Also genpd->name is immutable.
2007 list_for_each_entry(link, &genpd->master_links, master_node) {
2008 seq_printf(s, "%s", link->slave->name);
2009 if (!list_is_last(&link->master_node, &genpd->master_links))
2013 list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
2014 kobj_path = kobject_get_path(&pm_data->dev->kobj, GFP_KERNEL);
2015 if (kobj_path == NULL)
2018 seq_printf(s, "\n %-50s ", kobj_path);
2019 rtpm_status_str(s, pm_data->dev);
2025 mutex_unlock(&genpd->lock);
2030 static int pm_genpd_summary_show(struct seq_file *s, void *data)
2032 struct generic_pm_domain *genpd;
2035 seq_puts(s, "domain status slaves\n");
2036 seq_puts(s, " /device runtime status\n");
2037 seq_puts(s, "----------------------------------------------------------------------\n");
2039 ret = mutex_lock_interruptible(&gpd_list_lock);
2041 return -ERESTARTSYS;
2043 list_for_each_entry(genpd, &gpd_list, gpd_list_node) {
2044 ret = pm_genpd_summary_one(s, genpd);
2048 mutex_unlock(&gpd_list_lock);
2053 static int pm_genpd_summary_open(struct inode *inode, struct file *file)
2055 return single_open(file, pm_genpd_summary_show, NULL);
2058 static const struct file_operations pm_genpd_summary_fops = {
2059 .open = pm_genpd_summary_open,
2061 .llseek = seq_lseek,
2062 .release = single_release,
2065 static int __init pm_genpd_debug_init(void)
2069 pm_genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);
2071 if (!pm_genpd_debugfs_dir)
2074 d = debugfs_create_file("pm_genpd_summary", S_IRUGO,
2075 pm_genpd_debugfs_dir, NULL, &pm_genpd_summary_fops);
2081 late_initcall(pm_genpd_debug_init);
2083 static void __exit pm_genpd_debug_exit(void)
2085 debugfs_remove_recursive(pm_genpd_debugfs_dir);
2087 __exitcall(pm_genpd_debug_exit);
2088 #endif /* CONFIG_PM_ADVANCED_DEBUG */