1 // SPDX-License-Identifier: GPL-2.0
3 * drivers/base/power/domain.c - Common code related to device power domains.
5 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
7 #define pr_fmt(fmt) "PM: " fmt
9 #include <linux/delay.h>
10 #include <linux/kernel.h>
12 #include <linux/platform_device.h>
13 #include <linux/pm_opp.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/pm_domain.h>
16 #include <linux/pm_qos.h>
17 #include <linux/pm_clock.h>
18 #include <linux/slab.h>
19 #include <linux/err.h>
20 #include <linux/sched.h>
21 #include <linux/suspend.h>
22 #include <linux/export.h>
23 #include <linux/cpu.h>
24 #include <linux/debugfs.h>
28 #define GENPD_RETRY_MAX_MS 250 /* Approximate */
30 #define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
32 type (*__routine)(struct device *__d); \
33 type __ret = (type)0; \
35 __routine = genpd->dev_ops.callback; \
37 __ret = __routine(dev); \
42 static LIST_HEAD(gpd_list);
43 static DEFINE_MUTEX(gpd_list_lock);
45 struct genpd_lock_ops {
46 void (*lock)(struct generic_pm_domain *genpd);
47 void (*lock_nested)(struct generic_pm_domain *genpd, int depth);
48 int (*lock_interruptible)(struct generic_pm_domain *genpd);
49 void (*unlock)(struct generic_pm_domain *genpd);
52 static void genpd_lock_mtx(struct generic_pm_domain *genpd)
54 mutex_lock(&genpd->mlock);
57 static void genpd_lock_nested_mtx(struct generic_pm_domain *genpd,
60 mutex_lock_nested(&genpd->mlock, depth);
63 static int genpd_lock_interruptible_mtx(struct generic_pm_domain *genpd)
65 return mutex_lock_interruptible(&genpd->mlock);
68 static void genpd_unlock_mtx(struct generic_pm_domain *genpd)
70 return mutex_unlock(&genpd->mlock);
73 static const struct genpd_lock_ops genpd_mtx_ops = {
74 .lock = genpd_lock_mtx,
75 .lock_nested = genpd_lock_nested_mtx,
76 .lock_interruptible = genpd_lock_interruptible_mtx,
77 .unlock = genpd_unlock_mtx,
80 static void genpd_lock_spin(struct generic_pm_domain *genpd)
81 __acquires(&genpd->slock)
85 spin_lock_irqsave(&genpd->slock, flags);
86 genpd->lock_flags = flags;
89 static void genpd_lock_nested_spin(struct generic_pm_domain *genpd,
91 __acquires(&genpd->slock)
95 spin_lock_irqsave_nested(&genpd->slock, flags, depth);
96 genpd->lock_flags = flags;
99 static int genpd_lock_interruptible_spin(struct generic_pm_domain *genpd)
100 __acquires(&genpd->slock)
104 spin_lock_irqsave(&genpd->slock, flags);
105 genpd->lock_flags = flags;
109 static void genpd_unlock_spin(struct generic_pm_domain *genpd)
110 __releases(&genpd->slock)
112 spin_unlock_irqrestore(&genpd->slock, genpd->lock_flags);
115 static const struct genpd_lock_ops genpd_spin_ops = {
116 .lock = genpd_lock_spin,
117 .lock_nested = genpd_lock_nested_spin,
118 .lock_interruptible = genpd_lock_interruptible_spin,
119 .unlock = genpd_unlock_spin,
122 #define genpd_lock(p) p->lock_ops->lock(p)
123 #define genpd_lock_nested(p, d) p->lock_ops->lock_nested(p, d)
124 #define genpd_lock_interruptible(p) p->lock_ops->lock_interruptible(p)
125 #define genpd_unlock(p) p->lock_ops->unlock(p)
127 #define genpd_status_on(genpd) (genpd->status == GENPD_STATE_ON)
128 #define genpd_is_irq_safe(genpd) (genpd->flags & GENPD_FLAG_IRQ_SAFE)
129 #define genpd_is_always_on(genpd) (genpd->flags & GENPD_FLAG_ALWAYS_ON)
130 #define genpd_is_active_wakeup(genpd) (genpd->flags & GENPD_FLAG_ACTIVE_WAKEUP)
131 #define genpd_is_cpu_domain(genpd) (genpd->flags & GENPD_FLAG_CPU_DOMAIN)
132 #define genpd_is_rpm_always_on(genpd) (genpd->flags & GENPD_FLAG_RPM_ALWAYS_ON)
134 static inline bool irq_safe_dev_in_no_sleep_domain(struct device *dev,
135 const struct generic_pm_domain *genpd)
139 ret = pm_runtime_is_irq_safe(dev) && !genpd_is_irq_safe(genpd);
142 * Warn once if an IRQ safe device is attached to a no sleep domain, as
143 * to indicate a suboptimal configuration for PM. For an always on
144 * domain this isn't case, thus don't warn.
146 if (ret && !genpd_is_always_on(genpd))
147 dev_warn_once(dev, "PM domain %s will not be powered off\n",
153 static int genpd_runtime_suspend(struct device *dev);
156 * Get the generic PM domain for a particular struct device.
157 * This validates the struct device pointer, the PM domain pointer,
158 * and checks that the PM domain pointer is a real generic PM domain.
159 * Any failure results in NULL being returned.
161 static struct generic_pm_domain *dev_to_genpd_safe(struct device *dev)
163 if (IS_ERR_OR_NULL(dev) || IS_ERR_OR_NULL(dev->pm_domain))
166 /* A genpd's always have its ->runtime_suspend() callback assigned. */
167 if (dev->pm_domain->ops.runtime_suspend == genpd_runtime_suspend)
168 return pd_to_genpd(dev->pm_domain);
174 * This should only be used where we are certain that the pm_domain
175 * attached to the device is a genpd domain.
177 static struct generic_pm_domain *dev_to_genpd(struct device *dev)
179 if (IS_ERR_OR_NULL(dev->pm_domain))
180 return ERR_PTR(-EINVAL);
182 return pd_to_genpd(dev->pm_domain);
185 static int genpd_stop_dev(const struct generic_pm_domain *genpd,
188 return GENPD_DEV_CALLBACK(genpd, int, stop, dev);
191 static int genpd_start_dev(const struct generic_pm_domain *genpd,
194 return GENPD_DEV_CALLBACK(genpd, int, start, dev);
197 static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
201 if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
202 ret = !!atomic_dec_and_test(&genpd->sd_count);
207 static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
209 atomic_inc(&genpd->sd_count);
210 smp_mb__after_atomic();
213 #ifdef CONFIG_DEBUG_FS
214 static struct dentry *genpd_debugfs_dir;
216 static void genpd_debug_add(struct generic_pm_domain *genpd);
218 static void genpd_debug_remove(struct generic_pm_domain *genpd)
222 d = debugfs_lookup(genpd->name, genpd_debugfs_dir);
226 static void genpd_update_accounting(struct generic_pm_domain *genpd)
231 delta = ktime_sub(now, genpd->accounting_time);
234 * If genpd->status is active, it means we are just
235 * out of off and so update the idle time and vice
238 if (genpd->status == GENPD_STATE_ON) {
239 int state_idx = genpd->state_idx;
241 genpd->states[state_idx].idle_time =
242 ktime_add(genpd->states[state_idx].idle_time, delta);
244 genpd->on_time = ktime_add(genpd->on_time, delta);
247 genpd->accounting_time = now;
250 static inline void genpd_debug_add(struct generic_pm_domain *genpd) {}
251 static inline void genpd_debug_remove(struct generic_pm_domain *genpd) {}
252 static inline void genpd_update_accounting(struct generic_pm_domain *genpd) {}
255 static int _genpd_reeval_performance_state(struct generic_pm_domain *genpd,
258 struct generic_pm_domain_data *pd_data;
259 struct pm_domain_data *pdd;
260 struct gpd_link *link;
262 /* New requested state is same as Max requested state */
263 if (state == genpd->performance_state)
266 /* New requested state is higher than Max requested state */
267 if (state > genpd->performance_state)
270 /* Traverse all devices within the domain */
271 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
272 pd_data = to_gpd_data(pdd);
274 if (pd_data->performance_state > state)
275 state = pd_data->performance_state;
279 * Traverse all sub-domains within the domain. This can be
280 * done without any additional locking as the link->performance_state
281 * field is protected by the parent genpd->lock, which is already taken.
283 * Also note that link->performance_state (subdomain's performance state
284 * requirement to parent domain) is different from
285 * link->child->performance_state (current performance state requirement
286 * of the devices/sub-domains of the subdomain) and so can have a
289 * Note that we also take vote from powered-off sub-domains into account
290 * as the same is done for devices right now.
292 list_for_each_entry(link, &genpd->parent_links, parent_node) {
293 if (link->performance_state > state)
294 state = link->performance_state;
300 static int genpd_xlate_performance_state(struct generic_pm_domain *genpd,
301 struct generic_pm_domain *parent,
304 if (!parent->set_performance_state)
307 return dev_pm_opp_xlate_performance_state(genpd->opp_table,
312 static int _genpd_set_performance_state(struct generic_pm_domain *genpd,
313 unsigned int state, int depth)
315 struct generic_pm_domain *parent;
316 struct gpd_link *link;
317 int parent_state, ret;
319 if (state == genpd->performance_state)
322 /* Propagate to parents of genpd */
323 list_for_each_entry(link, &genpd->child_links, child_node) {
324 parent = link->parent;
326 /* Find parent's performance state */
327 ret = genpd_xlate_performance_state(genpd, parent, state);
328 if (unlikely(ret < 0))
333 genpd_lock_nested(parent, depth + 1);
335 link->prev_performance_state = link->performance_state;
336 link->performance_state = parent_state;
337 parent_state = _genpd_reeval_performance_state(parent,
339 ret = _genpd_set_performance_state(parent, parent_state, depth + 1);
341 link->performance_state = link->prev_performance_state;
343 genpd_unlock(parent);
349 if (genpd->set_performance_state) {
350 ret = genpd->set_performance_state(genpd, state);
355 genpd->performance_state = state;
359 /* Encountered an error, lets rollback */
360 list_for_each_entry_continue_reverse(link, &genpd->child_links,
362 parent = link->parent;
364 genpd_lock_nested(parent, depth + 1);
366 parent_state = link->prev_performance_state;
367 link->performance_state = parent_state;
369 parent_state = _genpd_reeval_performance_state(parent,
371 if (_genpd_set_performance_state(parent, parent_state, depth + 1)) {
372 pr_err("%s: Failed to roll back to %d performance state\n",
373 parent->name, parent_state);
376 genpd_unlock(parent);
383 * dev_pm_genpd_set_performance_state- Set performance state of device's power
386 * @dev: Device for which the performance-state needs to be set.
387 * @state: Target performance state of the device. This can be set as 0 when the
388 * device doesn't have any performance state constraints left (And so
389 * the device wouldn't participate anymore to find the target
390 * performance state of the genpd).
392 * It is assumed that the users guarantee that the genpd wouldn't be detached
393 * while this routine is getting called.
395 * Returns 0 on success and negative error values on failures.
397 int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state)
399 struct generic_pm_domain *genpd;
400 struct generic_pm_domain_data *gpd_data;
404 genpd = dev_to_genpd_safe(dev);
408 if (WARN_ON(!dev->power.subsys_data ||
409 !dev->power.subsys_data->domain_data))
414 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
415 prev = gpd_data->performance_state;
416 gpd_data->performance_state = state;
418 state = _genpd_reeval_performance_state(genpd, state);
419 ret = _genpd_set_performance_state(genpd, state, 0);
421 gpd_data->performance_state = prev;
427 EXPORT_SYMBOL_GPL(dev_pm_genpd_set_performance_state);
430 * dev_pm_genpd_set_next_wakeup - Notify PM framework of an impending wakeup.
432 * @dev: Device to handle
433 * @next: impending interrupt/wakeup for the device
436 * Allow devices to inform of the next wakeup. It's assumed that the users
437 * guarantee that the genpd wouldn't be detached while this routine is getting
438 * called. Additionally, it's also assumed that @dev isn't runtime suspended
440 * Although devices are expected to update the next_wakeup after the end of
441 * their usecase as well, it is possible the devices themselves may not know
442 * about that, so stale @next will be ignored when powering off the domain.
444 void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
446 struct generic_pm_domain_data *gpd_data;
447 struct generic_pm_domain *genpd;
449 genpd = dev_to_genpd_safe(dev);
453 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
454 gpd_data->next_wakeup = next;
456 EXPORT_SYMBOL_GPL(dev_pm_genpd_set_next_wakeup);
458 static int _genpd_power_on(struct generic_pm_domain *genpd, bool timed)
460 unsigned int state_idx = genpd->state_idx;
465 /* Notify consumers that we are about to power on. */
466 ret = raw_notifier_call_chain_robust(&genpd->power_notifiers,
468 GENPD_NOTIFY_OFF, NULL);
469 ret = notifier_to_errno(ret);
473 if (!genpd->power_on)
477 ret = genpd->power_on(genpd);
484 time_start = ktime_get();
485 ret = genpd->power_on(genpd);
489 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
490 if (elapsed_ns <= genpd->states[state_idx].power_on_latency_ns)
493 genpd->states[state_idx].power_on_latency_ns = elapsed_ns;
494 genpd->max_off_time_changed = true;
495 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
496 genpd->name, "on", elapsed_ns);
499 raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_ON, NULL);
502 raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_OFF,
507 static int _genpd_power_off(struct generic_pm_domain *genpd, bool timed)
509 unsigned int state_idx = genpd->state_idx;
514 /* Notify consumers that we are about to power off. */
515 ret = raw_notifier_call_chain_robust(&genpd->power_notifiers,
516 GENPD_NOTIFY_PRE_OFF,
517 GENPD_NOTIFY_ON, NULL);
518 ret = notifier_to_errno(ret);
522 if (!genpd->power_off)
526 ret = genpd->power_off(genpd);
533 time_start = ktime_get();
534 ret = genpd->power_off(genpd);
538 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
539 if (elapsed_ns <= genpd->states[state_idx].power_off_latency_ns)
542 genpd->states[state_idx].power_off_latency_ns = elapsed_ns;
543 genpd->max_off_time_changed = true;
544 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
545 genpd->name, "off", elapsed_ns);
548 raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_OFF,
552 raw_notifier_call_chain(&genpd->power_notifiers, GENPD_NOTIFY_ON, NULL);
557 * genpd_queue_power_off_work - Queue up the execution of genpd_power_off().
558 * @genpd: PM domain to power off.
560 * Queue up the execution of genpd_power_off() unless it's already been done
563 static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
565 queue_work(pm_wq, &genpd->power_off_work);
569 * genpd_power_off - Remove power from a given PM domain.
570 * @genpd: PM domain to power down.
571 * @one_dev_on: If invoked from genpd's ->runtime_suspend|resume() callback, the
572 * RPM status of the releated device is in an intermediate state, not yet turned
573 * into RPM_SUSPENDED. This means genpd_power_off() must allow one device to not
574 * be RPM_SUSPENDED, while it tries to power off the PM domain.
576 * If all of the @genpd's devices have been suspended and all of its subdomains
577 * have been powered down, remove power from @genpd.
579 static int genpd_power_off(struct generic_pm_domain *genpd, bool one_dev_on,
582 struct pm_domain_data *pdd;
583 struct gpd_link *link;
584 unsigned int not_suspended = 0;
588 * Do not try to power off the domain in the following situations:
589 * (1) The domain is already in the "power off" state.
590 * (2) System suspend is in progress.
592 if (!genpd_status_on(genpd) || genpd->prepared_count > 0)
596 * Abort power off for the PM domain in the following situations:
597 * (1) The domain is configured as always on.
598 * (2) When the domain has a subdomain being powered on.
600 if (genpd_is_always_on(genpd) ||
601 genpd_is_rpm_always_on(genpd) ||
602 atomic_read(&genpd->sd_count) > 0)
605 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
606 enum pm_qos_flags_status stat;
608 stat = dev_pm_qos_flags(pdd->dev, PM_QOS_FLAG_NO_POWER_OFF);
609 if (stat > PM_QOS_FLAGS_NONE)
613 * Do not allow PM domain to be powered off, when an IRQ safe
614 * device is part of a non-IRQ safe domain.
616 if (!pm_runtime_suspended(pdd->dev) ||
617 irq_safe_dev_in_no_sleep_domain(pdd->dev, genpd))
621 if (not_suspended > 1 || (not_suspended == 1 && !one_dev_on))
624 if (genpd->gov && genpd->gov->power_down_ok) {
625 if (!genpd->gov->power_down_ok(&genpd->domain))
629 /* Default to shallowest state. */
631 genpd->state_idx = 0;
633 /* Don't power off, if a child domain is waiting to power on. */
634 if (atomic_read(&genpd->sd_count) > 0)
637 ret = _genpd_power_off(genpd, true);
639 genpd->states[genpd->state_idx].rejected++;
643 genpd->status = GENPD_STATE_OFF;
644 genpd_update_accounting(genpd);
645 genpd->states[genpd->state_idx].usage++;
647 list_for_each_entry(link, &genpd->child_links, child_node) {
648 genpd_sd_counter_dec(link->parent);
649 genpd_lock_nested(link->parent, depth + 1);
650 genpd_power_off(link->parent, false, depth + 1);
651 genpd_unlock(link->parent);
658 * genpd_power_on - Restore power to a given PM domain and its parents.
659 * @genpd: PM domain to power up.
660 * @depth: nesting count for lockdep.
662 * Restore power to @genpd and all of its parents so that it is possible to
663 * resume a device belonging to it.
665 static int genpd_power_on(struct generic_pm_domain *genpd, unsigned int depth)
667 struct gpd_link *link;
670 if (genpd_status_on(genpd))
674 * The list is guaranteed not to change while the loop below is being
675 * executed, unless one of the parents' .power_on() callbacks fiddles
678 list_for_each_entry(link, &genpd->child_links, child_node) {
679 struct generic_pm_domain *parent = link->parent;
681 genpd_sd_counter_inc(parent);
683 genpd_lock_nested(parent, depth + 1);
684 ret = genpd_power_on(parent, depth + 1);
685 genpd_unlock(parent);
688 genpd_sd_counter_dec(parent);
693 ret = _genpd_power_on(genpd, true);
697 genpd->status = GENPD_STATE_ON;
698 genpd_update_accounting(genpd);
703 list_for_each_entry_continue_reverse(link,
706 genpd_sd_counter_dec(link->parent);
707 genpd_lock_nested(link->parent, depth + 1);
708 genpd_power_off(link->parent, false, depth + 1);
709 genpd_unlock(link->parent);
715 static int genpd_dev_pm_start(struct device *dev)
717 struct generic_pm_domain *genpd = dev_to_genpd(dev);
719 return genpd_start_dev(genpd, dev);
722 static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
723 unsigned long val, void *ptr)
725 struct generic_pm_domain_data *gpd_data;
728 gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
729 dev = gpd_data->base.dev;
732 struct generic_pm_domain *genpd;
733 struct pm_domain_data *pdd;
735 spin_lock_irq(&dev->power.lock);
737 pdd = dev->power.subsys_data ?
738 dev->power.subsys_data->domain_data : NULL;
740 to_gpd_data(pdd)->td.constraint_changed = true;
741 genpd = dev_to_genpd(dev);
743 genpd = ERR_PTR(-ENODATA);
746 spin_unlock_irq(&dev->power.lock);
748 if (!IS_ERR(genpd)) {
750 genpd->max_off_time_changed = true;
755 if (!dev || dev->power.ignore_children)
763 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
764 * @work: Work structure used for scheduling the execution of this function.
766 static void genpd_power_off_work_fn(struct work_struct *work)
768 struct generic_pm_domain *genpd;
770 genpd = container_of(work, struct generic_pm_domain, power_off_work);
773 genpd_power_off(genpd, false, 0);
778 * __genpd_runtime_suspend - walk the hierarchy of ->runtime_suspend() callbacks
779 * @dev: Device to handle.
781 static int __genpd_runtime_suspend(struct device *dev)
783 int (*cb)(struct device *__dev);
785 if (dev->type && dev->type->pm)
786 cb = dev->type->pm->runtime_suspend;
787 else if (dev->class && dev->class->pm)
788 cb = dev->class->pm->runtime_suspend;
789 else if (dev->bus && dev->bus->pm)
790 cb = dev->bus->pm->runtime_suspend;
794 if (!cb && dev->driver && dev->driver->pm)
795 cb = dev->driver->pm->runtime_suspend;
797 return cb ? cb(dev) : 0;
801 * __genpd_runtime_resume - walk the hierarchy of ->runtime_resume() callbacks
802 * @dev: Device to handle.
804 static int __genpd_runtime_resume(struct device *dev)
806 int (*cb)(struct device *__dev);
808 if (dev->type && dev->type->pm)
809 cb = dev->type->pm->runtime_resume;
810 else if (dev->class && dev->class->pm)
811 cb = dev->class->pm->runtime_resume;
812 else if (dev->bus && dev->bus->pm)
813 cb = dev->bus->pm->runtime_resume;
817 if (!cb && dev->driver && dev->driver->pm)
818 cb = dev->driver->pm->runtime_resume;
820 return cb ? cb(dev) : 0;
824 * genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
825 * @dev: Device to suspend.
827 * Carry out a runtime suspend of a device under the assumption that its
828 * pm_domain field points to the domain member of an object of type
829 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
831 static int genpd_runtime_suspend(struct device *dev)
833 struct generic_pm_domain *genpd;
834 bool (*suspend_ok)(struct device *__dev);
835 struct gpd_timing_data *td = &dev_gpd_data(dev)->td;
836 bool runtime_pm = pm_runtime_enabled(dev);
841 dev_dbg(dev, "%s()\n", __func__);
843 genpd = dev_to_genpd(dev);
848 * A runtime PM centric subsystem/driver may re-use the runtime PM
849 * callbacks for other purposes than runtime PM. In those scenarios
850 * runtime PM is disabled. Under these circumstances, we shall skip
851 * validating/measuring the PM QoS latency.
853 suspend_ok = genpd->gov ? genpd->gov->suspend_ok : NULL;
854 if (runtime_pm && suspend_ok && !suspend_ok(dev))
857 /* Measure suspend latency. */
860 time_start = ktime_get();
862 ret = __genpd_runtime_suspend(dev);
866 ret = genpd_stop_dev(genpd, dev);
868 __genpd_runtime_resume(dev);
872 /* Update suspend latency value if the measured time exceeds it. */
874 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
875 if (elapsed_ns > td->suspend_latency_ns) {
876 td->suspend_latency_ns = elapsed_ns;
877 dev_dbg(dev, "suspend latency exceeded, %lld ns\n",
879 genpd->max_off_time_changed = true;
880 td->constraint_changed = true;
885 * If power.irq_safe is set, this routine may be run with
886 * IRQs disabled, so suspend only if the PM domain also is irq_safe.
888 if (irq_safe_dev_in_no_sleep_domain(dev, genpd))
892 genpd_power_off(genpd, true, 0);
899 * genpd_runtime_resume - Resume a device belonging to I/O PM domain.
900 * @dev: Device to resume.
902 * Carry out a runtime resume of a device under the assumption that its
903 * pm_domain field points to the domain member of an object of type
904 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
906 static int genpd_runtime_resume(struct device *dev)
908 struct generic_pm_domain *genpd;
909 struct gpd_timing_data *td = &dev_gpd_data(dev)->td;
910 bool runtime_pm = pm_runtime_enabled(dev);
916 dev_dbg(dev, "%s()\n", __func__);
918 genpd = dev_to_genpd(dev);
923 * As we don't power off a non IRQ safe domain, which holds
924 * an IRQ safe device, we don't need to restore power to it.
926 if (irq_safe_dev_in_no_sleep_domain(dev, genpd)) {
932 ret = genpd_power_on(genpd, 0);
939 /* Measure resume latency. */
941 if (timed && runtime_pm)
942 time_start = ktime_get();
944 ret = genpd_start_dev(genpd, dev);
948 ret = __genpd_runtime_resume(dev);
952 /* Update resume latency value if the measured time exceeds it. */
953 if (timed && runtime_pm) {
954 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
955 if (elapsed_ns > td->resume_latency_ns) {
956 td->resume_latency_ns = elapsed_ns;
957 dev_dbg(dev, "resume latency exceeded, %lld ns\n",
959 genpd->max_off_time_changed = true;
960 td->constraint_changed = true;
967 genpd_stop_dev(genpd, dev);
969 if (!pm_runtime_is_irq_safe(dev) || genpd_is_irq_safe(genpd)) {
971 genpd_power_off(genpd, true, 0);
978 static bool pd_ignore_unused;
979 static int __init pd_ignore_unused_setup(char *__unused)
981 pd_ignore_unused = true;
984 __setup("pd_ignore_unused", pd_ignore_unused_setup);
987 * genpd_power_off_unused - Power off all PM domains with no devices in use.
989 static int __init genpd_power_off_unused(void)
991 struct generic_pm_domain *genpd;
993 if (pd_ignore_unused) {
994 pr_warn("genpd: Not disabling unused power domains\n");
998 mutex_lock(&gpd_list_lock);
1000 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
1001 genpd_queue_power_off_work(genpd);
1003 mutex_unlock(&gpd_list_lock);
1007 late_initcall(genpd_power_off_unused);
1009 #ifdef CONFIG_PM_SLEEP
1012 * genpd_sync_power_off - Synchronously power off a PM domain and its parents.
1013 * @genpd: PM domain to power off, if possible.
1014 * @use_lock: use the lock.
1015 * @depth: nesting count for lockdep.
1017 * Check if the given PM domain can be powered off (during system suspend or
1018 * hibernation) and do that if so. Also, in that case propagate to its parents.
1020 * This function is only called in "noirq" and "syscore" stages of system power
1021 * transitions. The "noirq" callbacks may be executed asynchronously, thus in
1022 * these cases the lock must be held.
1024 static void genpd_sync_power_off(struct generic_pm_domain *genpd, bool use_lock,
1027 struct gpd_link *link;
1029 if (!genpd_status_on(genpd) || genpd_is_always_on(genpd))
1032 if (genpd->suspended_count != genpd->device_count
1033 || atomic_read(&genpd->sd_count) > 0)
1036 /* Choose the deepest state when suspending */
1037 genpd->state_idx = genpd->state_count - 1;
1038 if (_genpd_power_off(genpd, false))
1041 genpd->status = GENPD_STATE_OFF;
1043 list_for_each_entry(link, &genpd->child_links, child_node) {
1044 genpd_sd_counter_dec(link->parent);
1047 genpd_lock_nested(link->parent, depth + 1);
1049 genpd_sync_power_off(link->parent, use_lock, depth + 1);
1052 genpd_unlock(link->parent);
1057 * genpd_sync_power_on - Synchronously power on a PM domain and its parents.
1058 * @genpd: PM domain to power on.
1059 * @use_lock: use the lock.
1060 * @depth: nesting count for lockdep.
1062 * This function is only called in "noirq" and "syscore" stages of system power
1063 * transitions. The "noirq" callbacks may be executed asynchronously, thus in
1064 * these cases the lock must be held.
1066 static void genpd_sync_power_on(struct generic_pm_domain *genpd, bool use_lock,
1069 struct gpd_link *link;
1071 if (genpd_status_on(genpd))
1074 list_for_each_entry(link, &genpd->child_links, child_node) {
1075 genpd_sd_counter_inc(link->parent);
1078 genpd_lock_nested(link->parent, depth + 1);
1080 genpd_sync_power_on(link->parent, use_lock, depth + 1);
1083 genpd_unlock(link->parent);
1086 _genpd_power_on(genpd, false);
1087 genpd->status = GENPD_STATE_ON;
1091 * resume_needed - Check whether to resume a device before system suspend.
1092 * @dev: Device to check.
1093 * @genpd: PM domain the device belongs to.
1095 * There are two cases in which a device that can wake up the system from sleep
1096 * states should be resumed by genpd_prepare(): (1) if the device is enabled
1097 * to wake up the system and it has to remain active for this purpose while the
1098 * system is in the sleep state and (2) if the device is not enabled to wake up
1099 * the system from sleep states and it generally doesn't generate wakeup signals
1100 * by itself (those signals are generated on its behalf by other parts of the
1101 * system). In the latter case it may be necessary to reconfigure the device's
1102 * wakeup settings during system suspend, because it may have been set up to
1103 * signal remote wakeup from the system's working state as needed by runtime PM.
1104 * Return 'true' in either of the above cases.
1106 static bool resume_needed(struct device *dev,
1107 const struct generic_pm_domain *genpd)
1111 if (!device_can_wakeup(dev))
1114 active_wakeup = genpd_is_active_wakeup(genpd);
1115 return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
1119 * genpd_prepare - Start power transition of a device in a PM domain.
1120 * @dev: Device to start the transition of.
1122 * Start a power transition of a device (during a system-wide power transition)
1123 * under the assumption that its pm_domain field points to the domain member of
1124 * an object of type struct generic_pm_domain representing a PM domain
1125 * consisting of I/O devices.
1127 static int genpd_prepare(struct device *dev)
1129 struct generic_pm_domain *genpd;
1132 dev_dbg(dev, "%s()\n", __func__);
1134 genpd = dev_to_genpd(dev);
1139 * If a wakeup request is pending for the device, it should be woken up
1140 * at this point and a system wakeup event should be reported if it's
1141 * set up to wake up the system from sleep states.
1143 if (resume_needed(dev, genpd))
1144 pm_runtime_resume(dev);
1148 if (genpd->prepared_count++ == 0)
1149 genpd->suspended_count = 0;
1151 genpd_unlock(genpd);
1153 ret = pm_generic_prepare(dev);
1157 genpd->prepared_count--;
1159 genpd_unlock(genpd);
1162 /* Never return 1, as genpd don't cope with the direct_complete path. */
1163 return ret >= 0 ? 0 : ret;
1167 * genpd_finish_suspend - Completion of suspend or hibernation of device in an
1169 * @dev: Device to suspend.
1170 * @poweroff: Specifies if this is a poweroff_noirq or suspend_noirq callback.
1172 * Stop the device and remove power from the domain if all devices in it have
1175 static int genpd_finish_suspend(struct device *dev, bool poweroff)
1177 struct generic_pm_domain *genpd;
1180 genpd = dev_to_genpd(dev);
1185 ret = pm_generic_poweroff_noirq(dev);
1187 ret = pm_generic_suspend_noirq(dev);
1191 if (device_wakeup_path(dev) && genpd_is_active_wakeup(genpd))
1194 if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1195 !pm_runtime_status_suspended(dev)) {
1196 ret = genpd_stop_dev(genpd, dev);
1199 pm_generic_restore_noirq(dev);
1201 pm_generic_resume_noirq(dev);
1207 genpd->suspended_count++;
1208 genpd_sync_power_off(genpd, true, 0);
1209 genpd_unlock(genpd);
1215 * genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
1216 * @dev: Device to suspend.
1218 * Stop the device and remove power from the domain if all devices in it have
1221 static int genpd_suspend_noirq(struct device *dev)
1223 dev_dbg(dev, "%s()\n", __func__);
1225 return genpd_finish_suspend(dev, false);
1229 * genpd_resume_noirq - Start of resume of device in an I/O PM domain.
1230 * @dev: Device to resume.
1232 * Restore power to the device's PM domain, if necessary, and start the device.
1234 static int genpd_resume_noirq(struct device *dev)
1236 struct generic_pm_domain *genpd;
1239 dev_dbg(dev, "%s()\n", __func__);
1241 genpd = dev_to_genpd(dev);
1245 if (device_wakeup_path(dev) && genpd_is_active_wakeup(genpd))
1246 return pm_generic_resume_noirq(dev);
1249 genpd_sync_power_on(genpd, true, 0);
1250 genpd->suspended_count--;
1251 genpd_unlock(genpd);
1253 if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1254 !pm_runtime_status_suspended(dev)) {
1255 ret = genpd_start_dev(genpd, dev);
1260 return pm_generic_resume_noirq(dev);
1264 * genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
1265 * @dev: Device to freeze.
1267 * Carry out a late freeze of a device under the assumption that its
1268 * pm_domain field points to the domain member of an object of type
1269 * struct generic_pm_domain representing a power domain consisting of I/O
1272 static int genpd_freeze_noirq(struct device *dev)
1274 const struct generic_pm_domain *genpd;
1277 dev_dbg(dev, "%s()\n", __func__);
1279 genpd = dev_to_genpd(dev);
1283 ret = pm_generic_freeze_noirq(dev);
1287 if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1288 !pm_runtime_status_suspended(dev))
1289 ret = genpd_stop_dev(genpd, dev);
1295 * genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
1296 * @dev: Device to thaw.
1298 * Start the device, unless power has been removed from the domain already
1299 * before the system transition.
1301 static int genpd_thaw_noirq(struct device *dev)
1303 const struct generic_pm_domain *genpd;
1306 dev_dbg(dev, "%s()\n", __func__);
1308 genpd = dev_to_genpd(dev);
1312 if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1313 !pm_runtime_status_suspended(dev)) {
1314 ret = genpd_start_dev(genpd, dev);
1319 return pm_generic_thaw_noirq(dev);
1323 * genpd_poweroff_noirq - Completion of hibernation of device in an
1325 * @dev: Device to poweroff.
1327 * Stop the device and remove power from the domain if all devices in it have
1330 static int genpd_poweroff_noirq(struct device *dev)
1332 dev_dbg(dev, "%s()\n", __func__);
1334 return genpd_finish_suspend(dev, true);
1338 * genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1339 * @dev: Device to resume.
1341 * Make sure the domain will be in the same power state as before the
1342 * hibernation the system is resuming from and start the device if necessary.
1344 static int genpd_restore_noirq(struct device *dev)
1346 struct generic_pm_domain *genpd;
1349 dev_dbg(dev, "%s()\n", __func__);
1351 genpd = dev_to_genpd(dev);
1356 * At this point suspended_count == 0 means we are being run for the
1357 * first time for the given domain in the present cycle.
1360 if (genpd->suspended_count++ == 0) {
1362 * The boot kernel might put the domain into arbitrary state,
1363 * so make it appear as powered off to genpd_sync_power_on(),
1364 * so that it tries to power it on in case it was really off.
1366 genpd->status = GENPD_STATE_OFF;
1369 genpd_sync_power_on(genpd, true, 0);
1370 genpd_unlock(genpd);
1372 if (genpd->dev_ops.stop && genpd->dev_ops.start &&
1373 !pm_runtime_status_suspended(dev)) {
1374 ret = genpd_start_dev(genpd, dev);
1379 return pm_generic_restore_noirq(dev);
1383 * genpd_complete - Complete power transition of a device in a power domain.
1384 * @dev: Device to complete the transition of.
1386 * Complete a power transition of a device (during a system-wide power
1387 * transition) under the assumption that its pm_domain field points to the
1388 * domain member of an object of type struct generic_pm_domain representing
1389 * a power domain consisting of I/O devices.
1391 static void genpd_complete(struct device *dev)
1393 struct generic_pm_domain *genpd;
1395 dev_dbg(dev, "%s()\n", __func__);
1397 genpd = dev_to_genpd(dev);
1401 pm_generic_complete(dev);
1405 genpd->prepared_count--;
1406 if (!genpd->prepared_count)
1407 genpd_queue_power_off_work(genpd);
1409 genpd_unlock(genpd);
1412 static void genpd_switch_state(struct device *dev, bool suspend)
1414 struct generic_pm_domain *genpd;
1417 genpd = dev_to_genpd_safe(dev);
1421 use_lock = genpd_is_irq_safe(genpd);
1427 genpd->suspended_count++;
1428 genpd_sync_power_off(genpd, use_lock, 0);
1430 genpd_sync_power_on(genpd, use_lock, 0);
1431 genpd->suspended_count--;
1435 genpd_unlock(genpd);
1439 * dev_pm_genpd_suspend - Synchronously try to suspend the genpd for @dev
1440 * @dev: The device that is attached to the genpd, that can be suspended.
1442 * This routine should typically be called for a device that needs to be
1443 * suspended during the syscore suspend phase. It may also be called during
1444 * suspend-to-idle to suspend a corresponding CPU device that is attached to a
1447 void dev_pm_genpd_suspend(struct device *dev)
1449 genpd_switch_state(dev, true);
1451 EXPORT_SYMBOL_GPL(dev_pm_genpd_suspend);
1454 * dev_pm_genpd_resume - Synchronously try to resume the genpd for @dev
1455 * @dev: The device that is attached to the genpd, which needs to be resumed.
1457 * This routine should typically be called for a device that needs to be resumed
1458 * during the syscore resume phase. It may also be called during suspend-to-idle
1459 * to resume a corresponding CPU device that is attached to a genpd.
1461 void dev_pm_genpd_resume(struct device *dev)
1463 genpd_switch_state(dev, false);
1465 EXPORT_SYMBOL_GPL(dev_pm_genpd_resume);
1467 #else /* !CONFIG_PM_SLEEP */
1469 #define genpd_prepare NULL
1470 #define genpd_suspend_noirq NULL
1471 #define genpd_resume_noirq NULL
1472 #define genpd_freeze_noirq NULL
1473 #define genpd_thaw_noirq NULL
1474 #define genpd_poweroff_noirq NULL
1475 #define genpd_restore_noirq NULL
1476 #define genpd_complete NULL
1478 #endif /* CONFIG_PM_SLEEP */
1480 static struct generic_pm_domain_data *genpd_alloc_dev_data(struct device *dev)
1482 struct generic_pm_domain_data *gpd_data;
1485 ret = dev_pm_get_subsys_data(dev);
1487 return ERR_PTR(ret);
1489 gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
1495 gpd_data->base.dev = dev;
1496 gpd_data->td.constraint_changed = true;
1497 gpd_data->td.effective_constraint_ns = PM_QOS_RESUME_LATENCY_NO_CONSTRAINT_NS;
1498 gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
1499 gpd_data->next_wakeup = KTIME_MAX;
1501 spin_lock_irq(&dev->power.lock);
1503 if (dev->power.subsys_data->domain_data) {
1508 dev->power.subsys_data->domain_data = &gpd_data->base;
1510 spin_unlock_irq(&dev->power.lock);
1515 spin_unlock_irq(&dev->power.lock);
1518 dev_pm_put_subsys_data(dev);
1519 return ERR_PTR(ret);
1522 static void genpd_free_dev_data(struct device *dev,
1523 struct generic_pm_domain_data *gpd_data)
1525 spin_lock_irq(&dev->power.lock);
1527 dev->power.subsys_data->domain_data = NULL;
1529 spin_unlock_irq(&dev->power.lock);
1532 dev_pm_put_subsys_data(dev);
1535 static void genpd_update_cpumask(struct generic_pm_domain *genpd,
1536 int cpu, bool set, unsigned int depth)
1538 struct gpd_link *link;
1540 if (!genpd_is_cpu_domain(genpd))
1543 list_for_each_entry(link, &genpd->child_links, child_node) {
1544 struct generic_pm_domain *parent = link->parent;
1546 genpd_lock_nested(parent, depth + 1);
1547 genpd_update_cpumask(parent, cpu, set, depth + 1);
1548 genpd_unlock(parent);
1552 cpumask_set_cpu(cpu, genpd->cpus);
1554 cpumask_clear_cpu(cpu, genpd->cpus);
1557 static void genpd_set_cpumask(struct generic_pm_domain *genpd, int cpu)
1560 genpd_update_cpumask(genpd, cpu, true, 0);
1563 static void genpd_clear_cpumask(struct generic_pm_domain *genpd, int cpu)
1566 genpd_update_cpumask(genpd, cpu, false, 0);
1569 static int genpd_get_cpu(struct generic_pm_domain *genpd, struct device *dev)
1573 if (!genpd_is_cpu_domain(genpd))
1576 for_each_possible_cpu(cpu) {
1577 if (get_cpu_device(cpu) == dev)
1584 static int genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1585 struct device *base_dev)
1587 struct generic_pm_domain_data *gpd_data;
1590 dev_dbg(dev, "%s()\n", __func__);
1592 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1595 gpd_data = genpd_alloc_dev_data(dev);
1596 if (IS_ERR(gpd_data))
1597 return PTR_ERR(gpd_data);
1599 gpd_data->cpu = genpd_get_cpu(genpd, base_dev);
1601 ret = genpd->attach_dev ? genpd->attach_dev(genpd, dev) : 0;
1607 genpd_set_cpumask(genpd, gpd_data->cpu);
1608 dev_pm_domain_set(dev, &genpd->domain);
1610 genpd->device_count++;
1611 genpd->max_off_time_changed = true;
1613 list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1615 genpd_unlock(genpd);
1618 genpd_free_dev_data(dev, gpd_data);
1620 dev_pm_qos_add_notifier(dev, &gpd_data->nb,
1621 DEV_PM_QOS_RESUME_LATENCY);
1627 * pm_genpd_add_device - Add a device to an I/O PM domain.
1628 * @genpd: PM domain to add the device to.
1629 * @dev: Device to be added.
1631 int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev)
1635 mutex_lock(&gpd_list_lock);
1636 ret = genpd_add_device(genpd, dev, dev);
1637 mutex_unlock(&gpd_list_lock);
1641 EXPORT_SYMBOL_GPL(pm_genpd_add_device);
1643 static int genpd_remove_device(struct generic_pm_domain *genpd,
1646 struct generic_pm_domain_data *gpd_data;
1647 struct pm_domain_data *pdd;
1650 dev_dbg(dev, "%s()\n", __func__);
1652 pdd = dev->power.subsys_data->domain_data;
1653 gpd_data = to_gpd_data(pdd);
1654 dev_pm_qos_remove_notifier(dev, &gpd_data->nb,
1655 DEV_PM_QOS_RESUME_LATENCY);
1659 if (genpd->prepared_count > 0) {
1664 genpd->device_count--;
1665 genpd->max_off_time_changed = true;
1667 genpd_clear_cpumask(genpd, gpd_data->cpu);
1668 dev_pm_domain_set(dev, NULL);
1670 list_del_init(&pdd->list_node);
1672 genpd_unlock(genpd);
1674 if (genpd->detach_dev)
1675 genpd->detach_dev(genpd, dev);
1677 genpd_free_dev_data(dev, gpd_data);
1682 genpd_unlock(genpd);
1683 dev_pm_qos_add_notifier(dev, &gpd_data->nb, DEV_PM_QOS_RESUME_LATENCY);
1689 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1690 * @dev: Device to be removed.
1692 int pm_genpd_remove_device(struct device *dev)
1694 struct generic_pm_domain *genpd = dev_to_genpd_safe(dev);
1699 return genpd_remove_device(genpd, dev);
1701 EXPORT_SYMBOL_GPL(pm_genpd_remove_device);
1704 * dev_pm_genpd_add_notifier - Add a genpd power on/off notifier for @dev
1706 * @dev: Device that should be associated with the notifier
1707 * @nb: The notifier block to register
1709 * Users may call this function to add a genpd power on/off notifier for an
1710 * attached @dev. Only one notifier per device is allowed. The notifier is
1711 * sent when genpd is powering on/off the PM domain.
1713 * It is assumed that the user guarantee that the genpd wouldn't be detached
1714 * while this routine is getting called.
1716 * Returns 0 on success and negative error values on failures.
1718 int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb)
1720 struct generic_pm_domain *genpd;
1721 struct generic_pm_domain_data *gpd_data;
1724 genpd = dev_to_genpd_safe(dev);
1728 if (WARN_ON(!dev->power.subsys_data ||
1729 !dev->power.subsys_data->domain_data))
1732 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1733 if (gpd_data->power_nb)
1737 ret = raw_notifier_chain_register(&genpd->power_notifiers, nb);
1738 genpd_unlock(genpd);
1741 dev_warn(dev, "failed to add notifier for PM domain %s\n",
1746 gpd_data->power_nb = nb;
1749 EXPORT_SYMBOL_GPL(dev_pm_genpd_add_notifier);
1752 * dev_pm_genpd_remove_notifier - Remove a genpd power on/off notifier for @dev
1754 * @dev: Device that is associated with the notifier
1756 * Users may call this function to remove a genpd power on/off notifier for an
1759 * It is assumed that the user guarantee that the genpd wouldn't be detached
1760 * while this routine is getting called.
1762 * Returns 0 on success and negative error values on failures.
1764 int dev_pm_genpd_remove_notifier(struct device *dev)
1766 struct generic_pm_domain *genpd;
1767 struct generic_pm_domain_data *gpd_data;
1770 genpd = dev_to_genpd_safe(dev);
1774 if (WARN_ON(!dev->power.subsys_data ||
1775 !dev->power.subsys_data->domain_data))
1778 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
1779 if (!gpd_data->power_nb)
1783 ret = raw_notifier_chain_unregister(&genpd->power_notifiers,
1784 gpd_data->power_nb);
1785 genpd_unlock(genpd);
1788 dev_warn(dev, "failed to remove notifier for PM domain %s\n",
1793 gpd_data->power_nb = NULL;
1796 EXPORT_SYMBOL_GPL(dev_pm_genpd_remove_notifier);
1798 static int genpd_add_subdomain(struct generic_pm_domain *genpd,
1799 struct generic_pm_domain *subdomain)
1801 struct gpd_link *link, *itr;
1804 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
1805 || genpd == subdomain)
1809 * If the domain can be powered on/off in an IRQ safe
1810 * context, ensure that the subdomain can also be
1811 * powered on/off in that context.
1813 if (!genpd_is_irq_safe(genpd) && genpd_is_irq_safe(subdomain)) {
1814 WARN(1, "Parent %s of subdomain %s must be IRQ safe\n",
1815 genpd->name, subdomain->name);
1819 link = kzalloc(sizeof(*link), GFP_KERNEL);
1823 genpd_lock(subdomain);
1824 genpd_lock_nested(genpd, SINGLE_DEPTH_NESTING);
1826 if (!genpd_status_on(genpd) && genpd_status_on(subdomain)) {
1831 list_for_each_entry(itr, &genpd->parent_links, parent_node) {
1832 if (itr->child == subdomain && itr->parent == genpd) {
1838 link->parent = genpd;
1839 list_add_tail(&link->parent_node, &genpd->parent_links);
1840 link->child = subdomain;
1841 list_add_tail(&link->child_node, &subdomain->child_links);
1842 if (genpd_status_on(subdomain))
1843 genpd_sd_counter_inc(genpd);
1846 genpd_unlock(genpd);
1847 genpd_unlock(subdomain);
1854 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1855 * @genpd: Leader PM domain to add the subdomain to.
1856 * @subdomain: Subdomain to be added.
1858 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1859 struct generic_pm_domain *subdomain)
1863 mutex_lock(&gpd_list_lock);
1864 ret = genpd_add_subdomain(genpd, subdomain);
1865 mutex_unlock(&gpd_list_lock);
1869 EXPORT_SYMBOL_GPL(pm_genpd_add_subdomain);
1872 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1873 * @genpd: Leader PM domain to remove the subdomain from.
1874 * @subdomain: Subdomain to be removed.
1876 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1877 struct generic_pm_domain *subdomain)
1879 struct gpd_link *l, *link;
1882 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1885 genpd_lock(subdomain);
1886 genpd_lock_nested(genpd, SINGLE_DEPTH_NESTING);
1888 if (!list_empty(&subdomain->parent_links) || subdomain->device_count) {
1889 pr_warn("%s: unable to remove subdomain %s\n",
1890 genpd->name, subdomain->name);
1895 list_for_each_entry_safe(link, l, &genpd->parent_links, parent_node) {
1896 if (link->child != subdomain)
1899 list_del(&link->parent_node);
1900 list_del(&link->child_node);
1902 if (genpd_status_on(subdomain))
1903 genpd_sd_counter_dec(genpd);
1910 genpd_unlock(genpd);
1911 genpd_unlock(subdomain);
1915 EXPORT_SYMBOL_GPL(pm_genpd_remove_subdomain);
1917 static void genpd_free_default_power_state(struct genpd_power_state *states,
1918 unsigned int state_count)
1923 static int genpd_set_default_power_state(struct generic_pm_domain *genpd)
1925 struct genpd_power_state *state;
1927 state = kzalloc(sizeof(*state), GFP_KERNEL);
1931 genpd->states = state;
1932 genpd->state_count = 1;
1933 genpd->free_states = genpd_free_default_power_state;
1938 static void genpd_lock_init(struct generic_pm_domain *genpd)
1940 if (genpd->flags & GENPD_FLAG_IRQ_SAFE) {
1941 spin_lock_init(&genpd->slock);
1942 genpd->lock_ops = &genpd_spin_ops;
1944 mutex_init(&genpd->mlock);
1945 genpd->lock_ops = &genpd_mtx_ops;
1950 * pm_genpd_init - Initialize a generic I/O PM domain object.
1951 * @genpd: PM domain object to initialize.
1952 * @gov: PM domain governor to associate with the domain (may be NULL).
1953 * @is_off: Initial value of the domain's power_is_off field.
1955 * Returns 0 on successful initialization, else a negative error code.
1957 int pm_genpd_init(struct generic_pm_domain *genpd,
1958 struct dev_power_governor *gov, bool is_off)
1962 if (IS_ERR_OR_NULL(genpd))
1965 INIT_LIST_HEAD(&genpd->parent_links);
1966 INIT_LIST_HEAD(&genpd->child_links);
1967 INIT_LIST_HEAD(&genpd->dev_list);
1968 RAW_INIT_NOTIFIER_HEAD(&genpd->power_notifiers);
1969 genpd_lock_init(genpd);
1971 INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1972 atomic_set(&genpd->sd_count, 0);
1973 genpd->status = is_off ? GENPD_STATE_OFF : GENPD_STATE_ON;
1974 genpd->device_count = 0;
1975 genpd->max_off_time_ns = -1;
1976 genpd->max_off_time_changed = true;
1977 genpd->provider = NULL;
1978 genpd->has_provider = false;
1979 genpd->accounting_time = ktime_get();
1980 genpd->domain.ops.runtime_suspend = genpd_runtime_suspend;
1981 genpd->domain.ops.runtime_resume = genpd_runtime_resume;
1982 genpd->domain.ops.prepare = genpd_prepare;
1983 genpd->domain.ops.suspend_noirq = genpd_suspend_noirq;
1984 genpd->domain.ops.resume_noirq = genpd_resume_noirq;
1985 genpd->domain.ops.freeze_noirq = genpd_freeze_noirq;
1986 genpd->domain.ops.thaw_noirq = genpd_thaw_noirq;
1987 genpd->domain.ops.poweroff_noirq = genpd_poweroff_noirq;
1988 genpd->domain.ops.restore_noirq = genpd_restore_noirq;
1989 genpd->domain.ops.complete = genpd_complete;
1990 genpd->domain.start = genpd_dev_pm_start;
1992 if (genpd->flags & GENPD_FLAG_PM_CLK) {
1993 genpd->dev_ops.stop = pm_clk_suspend;
1994 genpd->dev_ops.start = pm_clk_resume;
1997 /* Always-on domains must be powered on at initialization. */
1998 if ((genpd_is_always_on(genpd) || genpd_is_rpm_always_on(genpd)) &&
1999 !genpd_status_on(genpd))
2002 if (genpd_is_cpu_domain(genpd) &&
2003 !zalloc_cpumask_var(&genpd->cpus, GFP_KERNEL))
2006 /* Use only one "off" state if there were no states declared */
2007 if (genpd->state_count == 0) {
2008 ret = genpd_set_default_power_state(genpd);
2010 if (genpd_is_cpu_domain(genpd))
2011 free_cpumask_var(genpd->cpus);
2014 } else if (!gov && genpd->state_count > 1) {
2015 pr_warn("%s: no governor for states\n", genpd->name);
2018 device_initialize(&genpd->dev);
2019 dev_set_name(&genpd->dev, "%s", genpd->name);
2021 mutex_lock(&gpd_list_lock);
2022 list_add(&genpd->gpd_list_node, &gpd_list);
2023 genpd_debug_add(genpd);
2024 mutex_unlock(&gpd_list_lock);
2028 EXPORT_SYMBOL_GPL(pm_genpd_init);
2030 static int genpd_remove(struct generic_pm_domain *genpd)
2032 struct gpd_link *l, *link;
2034 if (IS_ERR_OR_NULL(genpd))
2039 if (genpd->has_provider) {
2040 genpd_unlock(genpd);
2041 pr_err("Provider present, unable to remove %s\n", genpd->name);
2045 if (!list_empty(&genpd->parent_links) || genpd->device_count) {
2046 genpd_unlock(genpd);
2047 pr_err("%s: unable to remove %s\n", __func__, genpd->name);
2051 list_for_each_entry_safe(link, l, &genpd->child_links, child_node) {
2052 list_del(&link->parent_node);
2053 list_del(&link->child_node);
2057 genpd_debug_remove(genpd);
2058 list_del(&genpd->gpd_list_node);
2059 genpd_unlock(genpd);
2060 cancel_work_sync(&genpd->power_off_work);
2061 if (genpd_is_cpu_domain(genpd))
2062 free_cpumask_var(genpd->cpus);
2063 if (genpd->free_states)
2064 genpd->free_states(genpd->states, genpd->state_count);
2066 pr_debug("%s: removed %s\n", __func__, genpd->name);
2072 * pm_genpd_remove - Remove a generic I/O PM domain
2073 * @genpd: Pointer to PM domain that is to be removed.
2075 * To remove the PM domain, this function:
2076 * - Removes the PM domain as a subdomain to any parent domains,
2078 * - Removes the PM domain from the list of registered PM domains.
2080 * The PM domain will only be removed, if the associated provider has
2081 * been removed, it is not a parent to any other PM domain and has no
2082 * devices associated with it.
2084 int pm_genpd_remove(struct generic_pm_domain *genpd)
2088 mutex_lock(&gpd_list_lock);
2089 ret = genpd_remove(genpd);
2090 mutex_unlock(&gpd_list_lock);
2094 EXPORT_SYMBOL_GPL(pm_genpd_remove);
2096 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
2099 * Device Tree based PM domain providers.
2101 * The code below implements generic device tree based PM domain providers that
2102 * bind device tree nodes with generic PM domains registered in the system.
2104 * Any driver that registers generic PM domains and needs to support binding of
2105 * devices to these domains is supposed to register a PM domain provider, which
2106 * maps a PM domain specifier retrieved from the device tree to a PM domain.
2108 * Two simple mapping functions have been provided for convenience:
2109 * - genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
2110 * - genpd_xlate_onecell() for mapping of multiple PM domains per node by
2115 * struct of_genpd_provider - PM domain provider registration structure
2116 * @link: Entry in global list of PM domain providers
2117 * @node: Pointer to device tree node of PM domain provider
2118 * @xlate: Provider-specific xlate callback mapping a set of specifier cells
2120 * @data: context pointer to be passed into @xlate callback
2122 struct of_genpd_provider {
2123 struct list_head link;
2124 struct device_node *node;
2125 genpd_xlate_t xlate;
2129 /* List of registered PM domain providers. */
2130 static LIST_HEAD(of_genpd_providers);
2131 /* Mutex to protect the list above. */
2132 static DEFINE_MUTEX(of_genpd_mutex);
2135 * genpd_xlate_simple() - Xlate function for direct node-domain mapping
2136 * @genpdspec: OF phandle args to map into a PM domain
2137 * @data: xlate function private data - pointer to struct generic_pm_domain
2139 * This is a generic xlate function that can be used to model PM domains that
2140 * have their own device tree nodes. The private data of xlate function needs
2141 * to be a valid pointer to struct generic_pm_domain.
2143 static struct generic_pm_domain *genpd_xlate_simple(
2144 struct of_phandle_args *genpdspec,
2151 * genpd_xlate_onecell() - Xlate function using a single index.
2152 * @genpdspec: OF phandle args to map into a PM domain
2153 * @data: xlate function private data - pointer to struct genpd_onecell_data
2155 * This is a generic xlate function that can be used to model simple PM domain
2156 * controllers that have one device tree node and provide multiple PM domains.
2157 * A single cell is used as an index into an array of PM domains specified in
2158 * the genpd_onecell_data struct when registering the provider.
2160 static struct generic_pm_domain *genpd_xlate_onecell(
2161 struct of_phandle_args *genpdspec,
2164 struct genpd_onecell_data *genpd_data = data;
2165 unsigned int idx = genpdspec->args[0];
2167 if (genpdspec->args_count != 1)
2168 return ERR_PTR(-EINVAL);
2170 if (idx >= genpd_data->num_domains) {
2171 pr_err("%s: invalid domain index %u\n", __func__, idx);
2172 return ERR_PTR(-EINVAL);
2175 if (!genpd_data->domains[idx])
2176 return ERR_PTR(-ENOENT);
2178 return genpd_data->domains[idx];
2182 * genpd_add_provider() - Register a PM domain provider for a node
2183 * @np: Device node pointer associated with the PM domain provider.
2184 * @xlate: Callback for decoding PM domain from phandle arguments.
2185 * @data: Context pointer for @xlate callback.
2187 static int genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
2190 struct of_genpd_provider *cp;
2192 cp = kzalloc(sizeof(*cp), GFP_KERNEL);
2196 cp->node = of_node_get(np);
2200 mutex_lock(&of_genpd_mutex);
2201 list_add(&cp->link, &of_genpd_providers);
2202 mutex_unlock(&of_genpd_mutex);
2203 pr_debug("Added domain provider from %pOF\n", np);
2208 static bool genpd_present(const struct generic_pm_domain *genpd)
2210 const struct generic_pm_domain *gpd;
2212 list_for_each_entry(gpd, &gpd_list, gpd_list_node)
2219 * of_genpd_add_provider_simple() - Register a simple PM domain provider
2220 * @np: Device node pointer associated with the PM domain provider.
2221 * @genpd: Pointer to PM domain associated with the PM domain provider.
2223 int of_genpd_add_provider_simple(struct device_node *np,
2224 struct generic_pm_domain *genpd)
2231 mutex_lock(&gpd_list_lock);
2233 if (!genpd_present(genpd))
2236 genpd->dev.of_node = np;
2238 /* Parse genpd OPP table */
2239 if (genpd->set_performance_state) {
2240 ret = dev_pm_opp_of_add_table(&genpd->dev);
2242 if (ret != -EPROBE_DEFER)
2243 dev_err(&genpd->dev, "Failed to add OPP table: %d\n",
2249 * Save table for faster processing while setting performance
2252 genpd->opp_table = dev_pm_opp_get_opp_table(&genpd->dev);
2253 WARN_ON(IS_ERR(genpd->opp_table));
2256 ret = genpd_add_provider(np, genpd_xlate_simple, genpd);
2258 if (genpd->set_performance_state) {
2259 dev_pm_opp_put_opp_table(genpd->opp_table);
2260 dev_pm_opp_of_remove_table(&genpd->dev);
2266 genpd->provider = &np->fwnode;
2267 genpd->has_provider = true;
2270 mutex_unlock(&gpd_list_lock);
2274 EXPORT_SYMBOL_GPL(of_genpd_add_provider_simple);
2277 * of_genpd_add_provider_onecell() - Register a onecell PM domain provider
2278 * @np: Device node pointer associated with the PM domain provider.
2279 * @data: Pointer to the data associated with the PM domain provider.
2281 int of_genpd_add_provider_onecell(struct device_node *np,
2282 struct genpd_onecell_data *data)
2284 struct generic_pm_domain *genpd;
2291 mutex_lock(&gpd_list_lock);
2294 data->xlate = genpd_xlate_onecell;
2296 for (i = 0; i < data->num_domains; i++) {
2297 genpd = data->domains[i];
2301 if (!genpd_present(genpd))
2304 genpd->dev.of_node = np;
2306 /* Parse genpd OPP table */
2307 if (genpd->set_performance_state) {
2308 ret = dev_pm_opp_of_add_table_indexed(&genpd->dev, i);
2310 if (ret != -EPROBE_DEFER)
2311 dev_err(&genpd->dev, "Failed to add OPP table for index %d: %d\n",
2317 * Save table for faster processing while setting
2318 * performance state.
2320 genpd->opp_table = dev_pm_opp_get_opp_table(&genpd->dev);
2321 WARN_ON(IS_ERR(genpd->opp_table));
2324 genpd->provider = &np->fwnode;
2325 genpd->has_provider = true;
2328 ret = genpd_add_provider(np, data->xlate, data);
2332 mutex_unlock(&gpd_list_lock);
2338 genpd = data->domains[i];
2343 genpd->provider = NULL;
2344 genpd->has_provider = false;
2346 if (genpd->set_performance_state) {
2347 dev_pm_opp_put_opp_table(genpd->opp_table);
2348 dev_pm_opp_of_remove_table(&genpd->dev);
2352 mutex_unlock(&gpd_list_lock);
2356 EXPORT_SYMBOL_GPL(of_genpd_add_provider_onecell);
2359 * of_genpd_del_provider() - Remove a previously registered PM domain provider
2360 * @np: Device node pointer associated with the PM domain provider
2362 void of_genpd_del_provider(struct device_node *np)
2364 struct of_genpd_provider *cp, *tmp;
2365 struct generic_pm_domain *gpd;
2367 mutex_lock(&gpd_list_lock);
2368 mutex_lock(&of_genpd_mutex);
2369 list_for_each_entry_safe(cp, tmp, &of_genpd_providers, link) {
2370 if (cp->node == np) {
2372 * For each PM domain associated with the
2373 * provider, set the 'has_provider' to false
2374 * so that the PM domain can be safely removed.
2376 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
2377 if (gpd->provider == &np->fwnode) {
2378 gpd->has_provider = false;
2380 if (!gpd->set_performance_state)
2383 dev_pm_opp_put_opp_table(gpd->opp_table);
2384 dev_pm_opp_of_remove_table(&gpd->dev);
2388 list_del(&cp->link);
2389 of_node_put(cp->node);
2394 mutex_unlock(&of_genpd_mutex);
2395 mutex_unlock(&gpd_list_lock);
2397 EXPORT_SYMBOL_GPL(of_genpd_del_provider);
2400 * genpd_get_from_provider() - Look-up PM domain
2401 * @genpdspec: OF phandle args to use for look-up
2403 * Looks for a PM domain provider under the node specified by @genpdspec and if
2404 * found, uses xlate function of the provider to map phandle args to a PM
2407 * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
2410 static struct generic_pm_domain *genpd_get_from_provider(
2411 struct of_phandle_args *genpdspec)
2413 struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
2414 struct of_genpd_provider *provider;
2417 return ERR_PTR(-EINVAL);
2419 mutex_lock(&of_genpd_mutex);
2421 /* Check if we have such a provider in our array */
2422 list_for_each_entry(provider, &of_genpd_providers, link) {
2423 if (provider->node == genpdspec->np)
2424 genpd = provider->xlate(genpdspec, provider->data);
2429 mutex_unlock(&of_genpd_mutex);
2435 * of_genpd_add_device() - Add a device to an I/O PM domain
2436 * @genpdspec: OF phandle args to use for look-up PM domain
2437 * @dev: Device to be added.
2439 * Looks-up an I/O PM domain based upon phandle args provided and adds
2440 * the device to the PM domain. Returns a negative error code on failure.
2442 int of_genpd_add_device(struct of_phandle_args *genpdspec, struct device *dev)
2444 struct generic_pm_domain *genpd;
2447 mutex_lock(&gpd_list_lock);
2449 genpd = genpd_get_from_provider(genpdspec);
2450 if (IS_ERR(genpd)) {
2451 ret = PTR_ERR(genpd);
2455 ret = genpd_add_device(genpd, dev, dev);
2458 mutex_unlock(&gpd_list_lock);
2462 EXPORT_SYMBOL_GPL(of_genpd_add_device);
2465 * of_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
2466 * @parent_spec: OF phandle args to use for parent PM domain look-up
2467 * @subdomain_spec: OF phandle args to use for subdomain look-up
2469 * Looks-up a parent PM domain and subdomain based upon phandle args
2470 * provided and adds the subdomain to the parent PM domain. Returns a
2471 * negative error code on failure.
2473 int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
2474 struct of_phandle_args *subdomain_spec)
2476 struct generic_pm_domain *parent, *subdomain;
2479 mutex_lock(&gpd_list_lock);
2481 parent = genpd_get_from_provider(parent_spec);
2482 if (IS_ERR(parent)) {
2483 ret = PTR_ERR(parent);
2487 subdomain = genpd_get_from_provider(subdomain_spec);
2488 if (IS_ERR(subdomain)) {
2489 ret = PTR_ERR(subdomain);
2493 ret = genpd_add_subdomain(parent, subdomain);
2496 mutex_unlock(&gpd_list_lock);
2498 return ret == -ENOENT ? -EPROBE_DEFER : ret;
2500 EXPORT_SYMBOL_GPL(of_genpd_add_subdomain);
2503 * of_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
2504 * @parent_spec: OF phandle args to use for parent PM domain look-up
2505 * @subdomain_spec: OF phandle args to use for subdomain look-up
2507 * Looks-up a parent PM domain and subdomain based upon phandle args
2508 * provided and removes the subdomain from the parent PM domain. Returns a
2509 * negative error code on failure.
2511 int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
2512 struct of_phandle_args *subdomain_spec)
2514 struct generic_pm_domain *parent, *subdomain;
2517 mutex_lock(&gpd_list_lock);
2519 parent = genpd_get_from_provider(parent_spec);
2520 if (IS_ERR(parent)) {
2521 ret = PTR_ERR(parent);
2525 subdomain = genpd_get_from_provider(subdomain_spec);
2526 if (IS_ERR(subdomain)) {
2527 ret = PTR_ERR(subdomain);
2531 ret = pm_genpd_remove_subdomain(parent, subdomain);
2534 mutex_unlock(&gpd_list_lock);
2538 EXPORT_SYMBOL_GPL(of_genpd_remove_subdomain);
2541 * of_genpd_remove_last - Remove the last PM domain registered for a provider
2542 * @provider: Pointer to device structure associated with provider
2544 * Find the last PM domain that was added by a particular provider and
2545 * remove this PM domain from the list of PM domains. The provider is
2546 * identified by the 'provider' device structure that is passed. The PM
2547 * domain will only be removed, if the provider associated with domain
2550 * Returns a valid pointer to struct generic_pm_domain on success or
2551 * ERR_PTR() on failure.
2553 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
2555 struct generic_pm_domain *gpd, *tmp, *genpd = ERR_PTR(-ENOENT);
2558 if (IS_ERR_OR_NULL(np))
2559 return ERR_PTR(-EINVAL);
2561 mutex_lock(&gpd_list_lock);
2562 list_for_each_entry_safe(gpd, tmp, &gpd_list, gpd_list_node) {
2563 if (gpd->provider == &np->fwnode) {
2564 ret = genpd_remove(gpd);
2565 genpd = ret ? ERR_PTR(ret) : gpd;
2569 mutex_unlock(&gpd_list_lock);
2573 EXPORT_SYMBOL_GPL(of_genpd_remove_last);
2575 static void genpd_release_dev(struct device *dev)
2577 of_node_put(dev->of_node);
2581 static struct bus_type genpd_bus_type = {
2586 * genpd_dev_pm_detach - Detach a device from its PM domain.
2587 * @dev: Device to detach.
2588 * @power_off: Currently not used
2590 * Try to locate a corresponding generic PM domain, which the device was
2591 * attached to previously. If such is found, the device is detached from it.
2593 static void genpd_dev_pm_detach(struct device *dev, bool power_off)
2595 struct generic_pm_domain *pd;
2599 pd = dev_to_genpd(dev);
2603 dev_dbg(dev, "removing from PM domain %s\n", pd->name);
2605 for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
2606 ret = genpd_remove_device(pd, dev);
2615 dev_err(dev, "failed to remove from PM domain %s: %d",
2620 /* Check if PM domain can be powered off after removing this device. */
2621 genpd_queue_power_off_work(pd);
2623 /* Unregister the device if it was created by genpd. */
2624 if (dev->bus == &genpd_bus_type)
2625 device_unregister(dev);
2628 static void genpd_dev_pm_sync(struct device *dev)
2630 struct generic_pm_domain *pd;
2632 pd = dev_to_genpd(dev);
2636 genpd_queue_power_off_work(pd);
2639 static int __genpd_dev_pm_attach(struct device *dev, struct device *base_dev,
2640 unsigned int index, bool power_on)
2642 struct of_phandle_args pd_args;
2643 struct generic_pm_domain *pd;
2646 ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
2647 "#power-domain-cells", index, &pd_args);
2651 mutex_lock(&gpd_list_lock);
2652 pd = genpd_get_from_provider(&pd_args);
2653 of_node_put(pd_args.np);
2655 mutex_unlock(&gpd_list_lock);
2656 dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
2657 __func__, PTR_ERR(pd));
2658 return driver_deferred_probe_check_state(base_dev);
2661 dev_dbg(dev, "adding to PM domain %s\n", pd->name);
2663 ret = genpd_add_device(pd, dev, base_dev);
2664 mutex_unlock(&gpd_list_lock);
2667 if (ret != -EPROBE_DEFER)
2668 dev_err(dev, "failed to add to PM domain %s: %d",
2673 dev->pm_domain->detach = genpd_dev_pm_detach;
2674 dev->pm_domain->sync = genpd_dev_pm_sync;
2678 ret = genpd_power_on(pd, 0);
2683 genpd_remove_device(pd, dev);
2685 return ret ? -EPROBE_DEFER : 1;
2689 * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
2690 * @dev: Device to attach.
2692 * Parse device's OF node to find a PM domain specifier. If such is found,
2693 * attaches the device to retrieved pm_domain ops.
2695 * Returns 1 on successfully attached PM domain, 0 when the device don't need a
2696 * PM domain or when multiple power-domains exists for it, else a negative error
2697 * code. Note that if a power-domain exists for the device, but it cannot be
2698 * found or turned on, then return -EPROBE_DEFER to ensure that the device is
2699 * not probed and to re-try again later.
2701 int genpd_dev_pm_attach(struct device *dev)
2707 * Devices with multiple PM domains must be attached separately, as we
2708 * can only attach one PM domain per device.
2710 if (of_count_phandle_with_args(dev->of_node, "power-domains",
2711 "#power-domain-cells") != 1)
2714 return __genpd_dev_pm_attach(dev, dev, 0, true);
2716 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
2719 * genpd_dev_pm_attach_by_id - Associate a device with one of its PM domains.
2720 * @dev: The device used to lookup the PM domain.
2721 * @index: The index of the PM domain.
2723 * Parse device's OF node to find a PM domain specifier at the provided @index.
2724 * If such is found, creates a virtual device and attaches it to the retrieved
2725 * pm_domain ops. To deal with detaching of the virtual device, the ->detach()
2726 * callback in the struct dev_pm_domain are assigned to genpd_dev_pm_detach().
2728 * Returns the created virtual device if successfully attached PM domain, NULL
2729 * when the device don't need a PM domain, else an ERR_PTR() in case of
2730 * failures. If a power-domain exists for the device, but cannot be found or
2731 * turned on, then ERR_PTR(-EPROBE_DEFER) is returned to ensure that the device
2732 * is not probed and to re-try again later.
2734 struct device *genpd_dev_pm_attach_by_id(struct device *dev,
2737 struct device *virt_dev;
2744 /* Verify that the index is within a valid range. */
2745 num_domains = of_count_phandle_with_args(dev->of_node, "power-domains",
2746 "#power-domain-cells");
2747 if (index >= num_domains)
2750 /* Allocate and register device on the genpd bus. */
2751 virt_dev = kzalloc(sizeof(*virt_dev), GFP_KERNEL);
2753 return ERR_PTR(-ENOMEM);
2755 dev_set_name(virt_dev, "genpd:%u:%s", index, dev_name(dev));
2756 virt_dev->bus = &genpd_bus_type;
2757 virt_dev->release = genpd_release_dev;
2758 virt_dev->of_node = of_node_get(dev->of_node);
2760 ret = device_register(virt_dev);
2762 put_device(virt_dev);
2763 return ERR_PTR(ret);
2766 /* Try to attach the device to the PM domain at the specified index. */
2767 ret = __genpd_dev_pm_attach(virt_dev, dev, index, false);
2769 device_unregister(virt_dev);
2770 return ret ? ERR_PTR(ret) : NULL;
2773 pm_runtime_enable(virt_dev);
2774 genpd_queue_power_off_work(dev_to_genpd(virt_dev));
2778 EXPORT_SYMBOL_GPL(genpd_dev_pm_attach_by_id);
2781 * genpd_dev_pm_attach_by_name - Associate a device with one of its PM domains.
2782 * @dev: The device used to lookup the PM domain.
2783 * @name: The name of the PM domain.
2785 * Parse device's OF node to find a PM domain specifier using the
2786 * power-domain-names DT property. For further description see
2787 * genpd_dev_pm_attach_by_id().
2789 struct device *genpd_dev_pm_attach_by_name(struct device *dev, const char *name)
2796 index = of_property_match_string(dev->of_node, "power-domain-names",
2801 return genpd_dev_pm_attach_by_id(dev, index);
2804 static const struct of_device_id idle_state_match[] = {
2805 { .compatible = "domain-idle-state", },
2809 static int genpd_parse_state(struct genpd_power_state *genpd_state,
2810 struct device_node *state_node)
2814 u32 entry_latency, exit_latency;
2816 err = of_property_read_u32(state_node, "entry-latency-us",
2819 pr_debug(" * %pOF missing entry-latency-us property\n",
2824 err = of_property_read_u32(state_node, "exit-latency-us",
2827 pr_debug(" * %pOF missing exit-latency-us property\n",
2832 err = of_property_read_u32(state_node, "min-residency-us", &residency);
2834 genpd_state->residency_ns = 1000 * residency;
2836 genpd_state->power_on_latency_ns = 1000 * exit_latency;
2837 genpd_state->power_off_latency_ns = 1000 * entry_latency;
2838 genpd_state->fwnode = &state_node->fwnode;
2843 static int genpd_iterate_idle_states(struct device_node *dn,
2844 struct genpd_power_state *states)
2847 struct of_phandle_iterator it;
2848 struct device_node *np;
2851 ret = of_count_phandle_with_args(dn, "domain-idle-states", NULL);
2853 return ret == -ENOENT ? 0 : ret;
2855 /* Loop over the phandles until all the requested entry is found */
2856 of_for_each_phandle(&it, ret, dn, "domain-idle-states", NULL, 0) {
2858 if (!of_match_node(idle_state_match, np))
2861 ret = genpd_parse_state(&states[i], np);
2863 pr_err("Parsing idle state node %pOF failed with err %d\n",
2876 * of_genpd_parse_idle_states: Return array of idle states for the genpd.
2878 * @dn: The genpd device node
2879 * @states: The pointer to which the state array will be saved.
2880 * @n: The count of elements in the array returned from this function.
2882 * Returns the device states parsed from the OF node. The memory for the states
2883 * is allocated by this function and is the responsibility of the caller to
2884 * free the memory after use. If any or zero compatible domain idle states is
2885 * found it returns 0 and in case of errors, a negative error code is returned.
2887 int of_genpd_parse_idle_states(struct device_node *dn,
2888 struct genpd_power_state **states, int *n)
2890 struct genpd_power_state *st;
2893 ret = genpd_iterate_idle_states(dn, NULL);
2903 st = kcalloc(ret, sizeof(*st), GFP_KERNEL);
2907 ret = genpd_iterate_idle_states(dn, st);
2910 return ret < 0 ? ret : -EINVAL;
2918 EXPORT_SYMBOL_GPL(of_genpd_parse_idle_states);
2921 * pm_genpd_opp_to_performance_state - Gets performance state of the genpd from its OPP node.
2923 * @genpd_dev: Genpd's device for which the performance-state needs to be found.
2924 * @opp: struct dev_pm_opp of the OPP for which we need to find performance
2927 * Returns performance state encoded in the OPP of the genpd. This calls
2928 * platform specific genpd->opp_to_performance_state() callback to translate
2929 * power domain OPP to performance state.
2931 * Returns performance state on success and 0 on failure.
2933 unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
2934 struct dev_pm_opp *opp)
2936 struct generic_pm_domain *genpd = NULL;
2939 genpd = container_of(genpd_dev, struct generic_pm_domain, dev);
2941 if (unlikely(!genpd->opp_to_performance_state))
2945 state = genpd->opp_to_performance_state(genpd, opp);
2946 genpd_unlock(genpd);
2950 EXPORT_SYMBOL_GPL(pm_genpd_opp_to_performance_state);
2952 static int __init genpd_bus_init(void)
2954 return bus_register(&genpd_bus_type);
2956 core_initcall(genpd_bus_init);
2958 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
2961 /*** debugfs support ***/
2963 #ifdef CONFIG_DEBUG_FS
2965 * TODO: This function is a slightly modified version of rtpm_status_show
2966 * from sysfs.c, so generalize it.
2968 static void rtpm_status_str(struct seq_file *s, struct device *dev)
2970 static const char * const status_lookup[] = {
2971 [RPM_ACTIVE] = "active",
2972 [RPM_RESUMING] = "resuming",
2973 [RPM_SUSPENDED] = "suspended",
2974 [RPM_SUSPENDING] = "suspending"
2978 if (dev->power.runtime_error)
2980 else if (dev->power.disable_depth)
2982 else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
2983 p = status_lookup[dev->power.runtime_status];
2987 seq_printf(s, "%-25s ", p);
2990 static void perf_status_str(struct seq_file *s, struct device *dev)
2992 struct generic_pm_domain_data *gpd_data;
2994 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
2995 seq_put_decimal_ull(s, "", gpd_data->performance_state);
2998 static int genpd_summary_one(struct seq_file *s,
2999 struct generic_pm_domain *genpd)
3001 static const char * const status_lookup[] = {
3002 [GENPD_STATE_ON] = "on",
3003 [GENPD_STATE_OFF] = "off"
3005 struct pm_domain_data *pm_data;
3006 const char *kobj_path;
3007 struct gpd_link *link;
3011 ret = genpd_lock_interruptible(genpd);
3013 return -ERESTARTSYS;
3015 if (WARN_ON(genpd->status >= ARRAY_SIZE(status_lookup)))
3017 if (!genpd_status_on(genpd))
3018 snprintf(state, sizeof(state), "%s-%u",
3019 status_lookup[genpd->status], genpd->state_idx);
3021 snprintf(state, sizeof(state), "%s",
3022 status_lookup[genpd->status]);
3023 seq_printf(s, "%-30s %-50s %u", genpd->name, state, genpd->performance_state);
3026 * Modifications on the list require holding locks on both
3027 * parent and child, so we are safe.
3028 * Also genpd->name is immutable.
3030 list_for_each_entry(link, &genpd->parent_links, parent_node) {
3031 if (list_is_first(&link->parent_node, &genpd->parent_links))
3032 seq_printf(s, "\n%48s", " ");
3033 seq_printf(s, "%s", link->child->name);
3034 if (!list_is_last(&link->parent_node, &genpd->parent_links))
3038 list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
3039 kobj_path = kobject_get_path(&pm_data->dev->kobj,
3040 genpd_is_irq_safe(genpd) ?
3041 GFP_ATOMIC : GFP_KERNEL);
3042 if (kobj_path == NULL)
3045 seq_printf(s, "\n %-50s ", kobj_path);
3046 rtpm_status_str(s, pm_data->dev);
3047 perf_status_str(s, pm_data->dev);
3053 genpd_unlock(genpd);
3058 static int summary_show(struct seq_file *s, void *data)
3060 struct generic_pm_domain *genpd;
3063 seq_puts(s, "domain status children performance\n");
3064 seq_puts(s, " /device runtime status\n");
3065 seq_puts(s, "----------------------------------------------------------------------------------------------\n");
3067 ret = mutex_lock_interruptible(&gpd_list_lock);
3069 return -ERESTARTSYS;
3071 list_for_each_entry(genpd, &gpd_list, gpd_list_node) {
3072 ret = genpd_summary_one(s, genpd);
3076 mutex_unlock(&gpd_list_lock);
3081 static int status_show(struct seq_file *s, void *data)
3083 static const char * const status_lookup[] = {
3084 [GENPD_STATE_ON] = "on",
3085 [GENPD_STATE_OFF] = "off"
3088 struct generic_pm_domain *genpd = s->private;
3091 ret = genpd_lock_interruptible(genpd);
3093 return -ERESTARTSYS;
3095 if (WARN_ON_ONCE(genpd->status >= ARRAY_SIZE(status_lookup)))
3098 if (genpd->status == GENPD_STATE_OFF)
3099 seq_printf(s, "%s-%u\n", status_lookup[genpd->status],
3102 seq_printf(s, "%s\n", status_lookup[genpd->status]);
3104 genpd_unlock(genpd);
3108 static int sub_domains_show(struct seq_file *s, void *data)
3110 struct generic_pm_domain *genpd = s->private;
3111 struct gpd_link *link;
3114 ret = genpd_lock_interruptible(genpd);
3116 return -ERESTARTSYS;
3118 list_for_each_entry(link, &genpd->parent_links, parent_node)
3119 seq_printf(s, "%s\n", link->child->name);
3121 genpd_unlock(genpd);
3125 static int idle_states_show(struct seq_file *s, void *data)
3127 struct generic_pm_domain *genpd = s->private;
3131 ret = genpd_lock_interruptible(genpd);
3133 return -ERESTARTSYS;
3135 seq_puts(s, "State Time Spent(ms) Usage Rejected\n");
3137 for (i = 0; i < genpd->state_count; i++) {
3141 if ((genpd->status == GENPD_STATE_OFF) &&
3142 (genpd->state_idx == i))
3143 delta = ktime_sub(ktime_get(), genpd->accounting_time);
3145 msecs = ktime_to_ms(
3146 ktime_add(genpd->states[i].idle_time, delta));
3147 seq_printf(s, "S%-13i %-14lld %-14llu %llu\n", i, msecs,
3148 genpd->states[i].usage, genpd->states[i].rejected);
3151 genpd_unlock(genpd);
3155 static int active_time_show(struct seq_file *s, void *data)
3157 struct generic_pm_domain *genpd = s->private;
3161 ret = genpd_lock_interruptible(genpd);
3163 return -ERESTARTSYS;
3165 if (genpd->status == GENPD_STATE_ON)
3166 delta = ktime_sub(ktime_get(), genpd->accounting_time);
3168 seq_printf(s, "%lld ms\n", ktime_to_ms(
3169 ktime_add(genpd->on_time, delta)));
3171 genpd_unlock(genpd);
3175 static int total_idle_time_show(struct seq_file *s, void *data)
3177 struct generic_pm_domain *genpd = s->private;
3178 ktime_t delta = 0, total = 0;
3182 ret = genpd_lock_interruptible(genpd);
3184 return -ERESTARTSYS;
3186 for (i = 0; i < genpd->state_count; i++) {
3188 if ((genpd->status == GENPD_STATE_OFF) &&
3189 (genpd->state_idx == i))
3190 delta = ktime_sub(ktime_get(), genpd->accounting_time);
3192 total = ktime_add(total, genpd->states[i].idle_time);
3194 total = ktime_add(total, delta);
3196 seq_printf(s, "%lld ms\n", ktime_to_ms(total));
3198 genpd_unlock(genpd);
3203 static int devices_show(struct seq_file *s, void *data)
3205 struct generic_pm_domain *genpd = s->private;
3206 struct pm_domain_data *pm_data;
3207 const char *kobj_path;
3210 ret = genpd_lock_interruptible(genpd);
3212 return -ERESTARTSYS;
3214 list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
3215 kobj_path = kobject_get_path(&pm_data->dev->kobj,
3216 genpd_is_irq_safe(genpd) ?
3217 GFP_ATOMIC : GFP_KERNEL);
3218 if (kobj_path == NULL)
3221 seq_printf(s, "%s\n", kobj_path);
3225 genpd_unlock(genpd);
3229 static int perf_state_show(struct seq_file *s, void *data)
3231 struct generic_pm_domain *genpd = s->private;
3233 if (genpd_lock_interruptible(genpd))
3234 return -ERESTARTSYS;
3236 seq_printf(s, "%u\n", genpd->performance_state);
3238 genpd_unlock(genpd);
3242 DEFINE_SHOW_ATTRIBUTE(summary);
3243 DEFINE_SHOW_ATTRIBUTE(status);
3244 DEFINE_SHOW_ATTRIBUTE(sub_domains);
3245 DEFINE_SHOW_ATTRIBUTE(idle_states);
3246 DEFINE_SHOW_ATTRIBUTE(active_time);
3247 DEFINE_SHOW_ATTRIBUTE(total_idle_time);
3248 DEFINE_SHOW_ATTRIBUTE(devices);
3249 DEFINE_SHOW_ATTRIBUTE(perf_state);
3251 static void genpd_debug_add(struct generic_pm_domain *genpd)
3255 if (!genpd_debugfs_dir)
3258 d = debugfs_create_dir(genpd->name, genpd_debugfs_dir);
3260 debugfs_create_file("current_state", 0444,
3261 d, genpd, &status_fops);
3262 debugfs_create_file("sub_domains", 0444,
3263 d, genpd, &sub_domains_fops);
3264 debugfs_create_file("idle_states", 0444,
3265 d, genpd, &idle_states_fops);
3266 debugfs_create_file("active_time", 0444,
3267 d, genpd, &active_time_fops);
3268 debugfs_create_file("total_idle_time", 0444,
3269 d, genpd, &total_idle_time_fops);
3270 debugfs_create_file("devices", 0444,
3271 d, genpd, &devices_fops);
3272 if (genpd->set_performance_state)
3273 debugfs_create_file("perf_state", 0444,
3274 d, genpd, &perf_state_fops);
3277 static int __init genpd_debug_init(void)
3279 struct generic_pm_domain *genpd;
3281 genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);
3283 debugfs_create_file("pm_genpd_summary", S_IRUGO, genpd_debugfs_dir,
3284 NULL, &summary_fops);
3286 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
3287 genpd_debug_add(genpd);
3291 late_initcall(genpd_debug_init);
3293 static void __exit genpd_debug_exit(void)
3295 debugfs_remove_recursive(genpd_debugfs_dir);
3297 __exitcall(genpd_debug_exit);
3298 #endif /* CONFIG_DEBUG_FS */