PM / Domains: Add support to select performance-state of domains
[linux-2.6-block.git] / drivers / base / power / domain.c
CommitLineData
f721889f
RW
1/*
2 * drivers/base/power/domain.c - Common code related to device power domains.
3 *
4 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
5 *
6 * This file is released under the GPLv2.
7 */
8
93af5e93 9#include <linux/delay.h>
f721889f
RW
10#include <linux/kernel.h>
11#include <linux/io.h>
aa42240a 12#include <linux/platform_device.h>
f721889f
RW
13#include <linux/pm_runtime.h>
14#include <linux/pm_domain.h>
6ff7bb0d 15#include <linux/pm_qos.h>
c11f6f5b 16#include <linux/pm_clock.h>
f721889f
RW
17#include <linux/slab.h>
18#include <linux/err.h>
17b75eca
RW
19#include <linux/sched.h>
20#include <linux/suspend.h>
d5e4cbfe
RW
21#include <linux/export.h>
22
aa8e54b5
TV
23#include "power.h"
24
93af5e93
GU
25#define GENPD_RETRY_MAX_MS 250 /* Approximate */
26
d5e4cbfe
RW
27#define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
28({ \
29 type (*__routine)(struct device *__d); \
30 type __ret = (type)0; \
31 \
32 __routine = genpd->dev_ops.callback; \
33 if (__routine) { \
34 __ret = __routine(dev); \
d5e4cbfe
RW
35 } \
36 __ret; \
37})
f721889f 38
5125bbf3
RW
39static LIST_HEAD(gpd_list);
40static DEFINE_MUTEX(gpd_list_lock);
41
35241d12
LI
42struct genpd_lock_ops {
43 void (*lock)(struct generic_pm_domain *genpd);
44 void (*lock_nested)(struct generic_pm_domain *genpd, int depth);
45 int (*lock_interruptible)(struct generic_pm_domain *genpd);
46 void (*unlock)(struct generic_pm_domain *genpd);
47};
48
49static void genpd_lock_mtx(struct generic_pm_domain *genpd)
50{
51 mutex_lock(&genpd->mlock);
52}
53
54static void genpd_lock_nested_mtx(struct generic_pm_domain *genpd,
55 int depth)
56{
57 mutex_lock_nested(&genpd->mlock, depth);
58}
59
60static int genpd_lock_interruptible_mtx(struct generic_pm_domain *genpd)
61{
62 return mutex_lock_interruptible(&genpd->mlock);
63}
64
65static void genpd_unlock_mtx(struct generic_pm_domain *genpd)
66{
67 return mutex_unlock(&genpd->mlock);
68}
69
70static const struct genpd_lock_ops genpd_mtx_ops = {
71 .lock = genpd_lock_mtx,
72 .lock_nested = genpd_lock_nested_mtx,
73 .lock_interruptible = genpd_lock_interruptible_mtx,
74 .unlock = genpd_unlock_mtx,
75};
76
d716f479
LI
77static void genpd_lock_spin(struct generic_pm_domain *genpd)
78 __acquires(&genpd->slock)
79{
80 unsigned long flags;
81
82 spin_lock_irqsave(&genpd->slock, flags);
83 genpd->lock_flags = flags;
84}
85
86static void genpd_lock_nested_spin(struct generic_pm_domain *genpd,
87 int depth)
88 __acquires(&genpd->slock)
89{
90 unsigned long flags;
91
92 spin_lock_irqsave_nested(&genpd->slock, flags, depth);
93 genpd->lock_flags = flags;
94}
95
96static int genpd_lock_interruptible_spin(struct generic_pm_domain *genpd)
97 __acquires(&genpd->slock)
98{
99 unsigned long flags;
100
101 spin_lock_irqsave(&genpd->slock, flags);
102 genpd->lock_flags = flags;
103 return 0;
104}
105
106static void genpd_unlock_spin(struct generic_pm_domain *genpd)
107 __releases(&genpd->slock)
108{
109 spin_unlock_irqrestore(&genpd->slock, genpd->lock_flags);
110}
111
112static const struct genpd_lock_ops genpd_spin_ops = {
113 .lock = genpd_lock_spin,
114 .lock_nested = genpd_lock_nested_spin,
115 .lock_interruptible = genpd_lock_interruptible_spin,
116 .unlock = genpd_unlock_spin,
117};
118
35241d12
LI
119#define genpd_lock(p) p->lock_ops->lock(p)
120#define genpd_lock_nested(p, d) p->lock_ops->lock_nested(p, d)
121#define genpd_lock_interruptible(p) p->lock_ops->lock_interruptible(p)
122#define genpd_unlock(p) p->lock_ops->unlock(p)
123
41e2c8e0 124#define genpd_status_on(genpd) (genpd->status == GPD_STATE_ACTIVE)
d716f479 125#define genpd_is_irq_safe(genpd) (genpd->flags & GENPD_FLAG_IRQ_SAFE)
ffaa42e8 126#define genpd_is_always_on(genpd) (genpd->flags & GENPD_FLAG_ALWAYS_ON)
d716f479
LI
127
128static inline bool irq_safe_dev_in_no_sleep_domain(struct device *dev,
d8600c8b 129 const struct generic_pm_domain *genpd)
d716f479
LI
130{
131 bool ret;
132
133 ret = pm_runtime_is_irq_safe(dev) && !genpd_is_irq_safe(genpd);
134
075c37d5
UH
135 /*
136 * Warn once if an IRQ safe device is attached to a no sleep domain, as
137 * to indicate a suboptimal configuration for PM. For an always on
138 * domain this isn't case, thus don't warn.
139 */
140 if (ret && !genpd_is_always_on(genpd))
d716f479
LI
141 dev_warn_once(dev, "PM domain %s will not be powered off\n",
142 genpd->name);
143
144 return ret;
145}
146
446d999c
RK
147/*
148 * Get the generic PM domain for a particular struct device.
149 * This validates the struct device pointer, the PM domain pointer,
150 * and checks that the PM domain pointer is a real generic PM domain.
151 * Any failure results in NULL being returned.
152 */
f58d4e5a 153static struct generic_pm_domain *genpd_lookup_dev(struct device *dev)
446d999c
RK
154{
155 struct generic_pm_domain *genpd = NULL, *gpd;
156
157 if (IS_ERR_OR_NULL(dev) || IS_ERR_OR_NULL(dev->pm_domain))
158 return NULL;
159
160 mutex_lock(&gpd_list_lock);
161 list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
162 if (&gpd->domain == dev->pm_domain) {
163 genpd = gpd;
164 break;
165 }
166 }
167 mutex_unlock(&gpd_list_lock);
168
169 return genpd;
170}
171
172/*
173 * This should only be used where we are certain that the pm_domain
174 * attached to the device is a genpd domain.
175 */
176static struct generic_pm_domain *dev_to_genpd(struct device *dev)
5248051b
RW
177{
178 if (IS_ERR_OR_NULL(dev->pm_domain))
179 return ERR_PTR(-EINVAL);
180
596ba34b 181 return pd_to_genpd(dev->pm_domain);
5248051b 182}
f721889f 183
d8600c8b
KK
184static int genpd_stop_dev(const struct generic_pm_domain *genpd,
185 struct device *dev)
d5e4cbfe 186{
2b1d88cd 187 return GENPD_DEV_CALLBACK(genpd, int, stop, dev);
d5e4cbfe
RW
188}
189
d8600c8b
KK
190static int genpd_start_dev(const struct generic_pm_domain *genpd,
191 struct device *dev)
d5e4cbfe 192{
2b1d88cd 193 return GENPD_DEV_CALLBACK(genpd, int, start, dev);
d5e4cbfe
RW
194}
195
c4bb3160 196static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
f721889f 197{
c4bb3160
RW
198 bool ret = false;
199
200 if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
201 ret = !!atomic_dec_and_test(&genpd->sd_count);
202
203 return ret;
204}
205
206static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
207{
208 atomic_inc(&genpd->sd_count);
4e857c58 209 smp_mb__after_atomic();
f721889f
RW
210}
211
afece3ab
TG
212#ifdef CONFIG_DEBUG_FS
213static void genpd_update_accounting(struct generic_pm_domain *genpd)
214{
215 ktime_t delta, now;
216
217 now = ktime_get();
218 delta = ktime_sub(now, genpd->accounting_time);
219
220 /*
221 * If genpd->status is active, it means we are just
222 * out of off and so update the idle time and vice
223 * versa.
224 */
225 if (genpd->status == GPD_STATE_ACTIVE) {
226 int state_idx = genpd->state_idx;
227
228 genpd->states[state_idx].idle_time =
229 ktime_add(genpd->states[state_idx].idle_time, delta);
230 } else {
231 genpd->on_time = ktime_add(genpd->on_time, delta);
232 }
233
234 genpd->accounting_time = now;
235}
236#else
237static inline void genpd_update_accounting(struct generic_pm_domain *genpd) {}
238#endif
239
42f6284a
VK
240/**
241 * dev_pm_genpd_set_performance_state- Set performance state of device's power
242 * domain.
243 *
244 * @dev: Device for which the performance-state needs to be set.
245 * @state: Target performance state of the device. This can be set as 0 when the
246 * device doesn't have any performance state constraints left (And so
247 * the device wouldn't participate anymore to find the target
248 * performance state of the genpd).
249 *
250 * It is assumed that the users guarantee that the genpd wouldn't be detached
251 * while this routine is getting called.
252 *
253 * Returns 0 on success and negative error values on failures.
254 */
255int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state)
256{
257 struct generic_pm_domain *genpd;
258 struct generic_pm_domain_data *gpd_data, *pd_data;
259 struct pm_domain_data *pdd;
260 unsigned int prev;
261 int ret = 0;
262
263 genpd = dev_to_genpd(dev);
264 if (IS_ERR(genpd))
265 return -ENODEV;
266
267 if (unlikely(!genpd->set_performance_state))
268 return -EINVAL;
269
270 if (unlikely(!dev->power.subsys_data ||
271 !dev->power.subsys_data->domain_data)) {
272 WARN_ON(1);
273 return -EINVAL;
274 }
275
276 genpd_lock(genpd);
277
278 gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
279 prev = gpd_data->performance_state;
280 gpd_data->performance_state = state;
281
282 /* New requested state is same as Max requested state */
283 if (state == genpd->performance_state)
284 goto unlock;
285
286 /* New requested state is higher than Max requested state */
287 if (state > genpd->performance_state)
288 goto update_state;
289
290 /* Traverse all devices within the domain */
291 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
292 pd_data = to_gpd_data(pdd);
293
294 if (pd_data->performance_state > state)
295 state = pd_data->performance_state;
296 }
297
298 if (state == genpd->performance_state)
299 goto unlock;
300
301 /*
302 * We aren't propagating performance state changes of a subdomain to its
303 * masters as we don't have hardware that needs it. Over that, the
304 * performance states of subdomain and its masters may not have
305 * one-to-one mapping and would require additional information. We can
306 * get back to this once we have hardware that needs it. For that
307 * reason, we don't have to consider performance state of the subdomains
308 * of genpd here.
309 */
310
311update_state:
312 if (genpd_status_on(genpd)) {
313 ret = genpd->set_performance_state(genpd, state);
314 if (ret) {
315 gpd_data->performance_state = prev;
316 goto unlock;
317 }
318 }
319
320 genpd->performance_state = state;
321
322unlock:
323 genpd_unlock(genpd);
324
325 return ret;
326}
327EXPORT_SYMBOL_GPL(dev_pm_genpd_set_performance_state);
328
86e12eac 329static int _genpd_power_on(struct generic_pm_domain *genpd, bool timed)
c8f0ea45 330{
fc5cbf0c 331 unsigned int state_idx = genpd->state_idx;
c8f0ea45
GU
332 ktime_t time_start;
333 s64 elapsed_ns;
334 int ret;
335
336 if (!genpd->power_on)
337 return 0;
338
a4630c61
GU
339 if (!timed)
340 return genpd->power_on(genpd);
341
c8f0ea45
GU
342 time_start = ktime_get();
343 ret = genpd->power_on(genpd);
344 if (ret)
345 return ret;
346
347 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
42f6284a
VK
348
349 if (unlikely(genpd->set_performance_state)) {
350 ret = genpd->set_performance_state(genpd, genpd->performance_state);
351 if (ret) {
352 pr_warn("%s: Failed to set performance state %d (%d)\n",
353 genpd->name, genpd->performance_state, ret);
354 }
355 }
356
fc5cbf0c 357 if (elapsed_ns <= genpd->states[state_idx].power_on_latency_ns)
c8f0ea45
GU
358 return ret;
359
fc5cbf0c 360 genpd->states[state_idx].power_on_latency_ns = elapsed_ns;
c8f0ea45 361 genpd->max_off_time_changed = true;
6d7d5c32
RK
362 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
363 genpd->name, "on", elapsed_ns);
c8f0ea45
GU
364
365 return ret;
366}
367
86e12eac 368static int _genpd_power_off(struct generic_pm_domain *genpd, bool timed)
c8f0ea45 369{
fc5cbf0c 370 unsigned int state_idx = genpd->state_idx;
c8f0ea45
GU
371 ktime_t time_start;
372 s64 elapsed_ns;
373 int ret;
374
375 if (!genpd->power_off)
376 return 0;
377
a4630c61
GU
378 if (!timed)
379 return genpd->power_off(genpd);
380
c8f0ea45
GU
381 time_start = ktime_get();
382 ret = genpd->power_off(genpd);
383 if (ret == -EBUSY)
384 return ret;
385
386 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
fc5cbf0c 387 if (elapsed_ns <= genpd->states[state_idx].power_off_latency_ns)
c8f0ea45
GU
388 return ret;
389
fc5cbf0c 390 genpd->states[state_idx].power_off_latency_ns = elapsed_ns;
c8f0ea45 391 genpd->max_off_time_changed = true;
6d7d5c32
RK
392 pr_debug("%s: Power-%s latency exceeded, new value %lld ns\n",
393 genpd->name, "off", elapsed_ns);
c8f0ea45
GU
394
395 return ret;
396}
397
29e47e21 398/**
86e12eac 399 * genpd_queue_power_off_work - Queue up the execution of genpd_power_off().
a3d09c73 400 * @genpd: PM domain to power off.
29e47e21 401 *
86e12eac 402 * Queue up the execution of genpd_power_off() unless it's already been done
29e47e21
UH
403 * before.
404 */
405static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
406{
407 queue_work(pm_wq, &genpd->power_off_work);
408}
409
1f8728b7
UH
410/**
411 * genpd_power_off - Remove power from a given PM domain.
412 * @genpd: PM domain to power down.
3c64649d
UH
413 * @one_dev_on: If invoked from genpd's ->runtime_suspend|resume() callback, the
414 * RPM status of the releated device is in an intermediate state, not yet turned
415 * into RPM_SUSPENDED. This means genpd_power_off() must allow one device to not
416 * be RPM_SUSPENDED, while it tries to power off the PM domain.
1f8728b7
UH
417 *
418 * If all of the @genpd's devices have been suspended and all of its subdomains
419 * have been powered down, remove power from @genpd.
420 */
2da83545
UH
421static int genpd_power_off(struct generic_pm_domain *genpd, bool one_dev_on,
422 unsigned int depth)
1f8728b7
UH
423{
424 struct pm_domain_data *pdd;
425 struct gpd_link *link;
426 unsigned int not_suspended = 0;
427
428 /*
429 * Do not try to power off the domain in the following situations:
430 * (1) The domain is already in the "power off" state.
431 * (2) System suspend is in progress.
432 */
41e2c8e0 433 if (!genpd_status_on(genpd) || genpd->prepared_count > 0)
1f8728b7
UH
434 return 0;
435
ffaa42e8
UH
436 /*
437 * Abort power off for the PM domain in the following situations:
438 * (1) The domain is configured as always on.
439 * (2) When the domain has a subdomain being powered on.
440 */
441 if (genpd_is_always_on(genpd) || atomic_read(&genpd->sd_count) > 0)
1f8728b7
UH
442 return -EBUSY;
443
444 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
445 enum pm_qos_flags_status stat;
446
447 stat = dev_pm_qos_flags(pdd->dev,
448 PM_QOS_FLAG_NO_POWER_OFF
449 | PM_QOS_FLAG_REMOTE_WAKEUP);
450 if (stat > PM_QOS_FLAGS_NONE)
451 return -EBUSY;
452
453 /*
454 * Do not allow PM domain to be powered off, when an IRQ safe
455 * device is part of a non-IRQ safe domain.
456 */
457 if (!pm_runtime_suspended(pdd->dev) ||
458 irq_safe_dev_in_no_sleep_domain(pdd->dev, genpd))
459 not_suspended++;
460 }
461
3c64649d 462 if (not_suspended > 1 || (not_suspended == 1 && !one_dev_on))
1f8728b7
UH
463 return -EBUSY;
464
465 if (genpd->gov && genpd->gov->power_down_ok) {
466 if (!genpd->gov->power_down_ok(&genpd->domain))
467 return -EAGAIN;
468 }
469
470 if (genpd->power_off) {
471 int ret;
472
473 if (atomic_read(&genpd->sd_count) > 0)
474 return -EBUSY;
475
476 /*
477 * If sd_count > 0 at this point, one of the subdomains hasn't
478 * managed to call genpd_power_on() for the master yet after
479 * incrementing it. In that case genpd_power_on() will wait
480 * for us to drop the lock, so we can call .power_off() and let
481 * the genpd_power_on() restore power for us (this shouldn't
482 * happen very often).
483 */
484 ret = _genpd_power_off(genpd, true);
485 if (ret)
486 return ret;
487 }
488
489 genpd->status = GPD_STATE_POWER_OFF;
afece3ab 490 genpd_update_accounting(genpd);
1f8728b7
UH
491
492 list_for_each_entry(link, &genpd->slave_links, slave_node) {
493 genpd_sd_counter_dec(link->master);
2da83545
UH
494 genpd_lock_nested(link->master, depth + 1);
495 genpd_power_off(link->master, false, depth + 1);
496 genpd_unlock(link->master);
1f8728b7
UH
497 }
498
499 return 0;
500}
501
5248051b 502/**
86e12eac 503 * genpd_power_on - Restore power to a given PM domain and its masters.
5248051b 504 * @genpd: PM domain to power up.
0106ef51 505 * @depth: nesting count for lockdep.
5248051b 506 *
5063ce15 507 * Restore power to @genpd and all of its masters so that it is possible to
5248051b
RW
508 * resume a device belonging to it.
509 */
86e12eac 510static int genpd_power_on(struct generic_pm_domain *genpd, unsigned int depth)
5248051b 511{
5063ce15 512 struct gpd_link *link;
5248051b
RW
513 int ret = 0;
514
41e2c8e0 515 if (genpd_status_on(genpd))
3f241775 516 return 0;
5248051b 517
5063ce15
RW
518 /*
519 * The list is guaranteed not to change while the loop below is being
520 * executed, unless one of the masters' .power_on() callbacks fiddles
521 * with it.
522 */
523 list_for_each_entry(link, &genpd->slave_links, slave_node) {
0106ef51
MS
524 struct generic_pm_domain *master = link->master;
525
526 genpd_sd_counter_inc(master);
527
35241d12 528 genpd_lock_nested(master, depth + 1);
86e12eac 529 ret = genpd_power_on(master, depth + 1);
35241d12 530 genpd_unlock(master);
5248051b 531
5063ce15 532 if (ret) {
0106ef51 533 genpd_sd_counter_dec(master);
9e08cf42 534 goto err;
5063ce15 535 }
5248051b
RW
536 }
537
86e12eac 538 ret = _genpd_power_on(genpd, true);
c8f0ea45
GU
539 if (ret)
540 goto err;
5248051b 541
ba2bbfbf 542 genpd->status = GPD_STATE_ACTIVE;
afece3ab
TG
543 genpd_update_accounting(genpd);
544
3f241775 545 return 0;
9e08cf42
RW
546
547 err:
29e47e21
UH
548 list_for_each_entry_continue_reverse(link,
549 &genpd->slave_links,
550 slave_node) {
5063ce15 551 genpd_sd_counter_dec(link->master);
2da83545
UH
552 genpd_lock_nested(link->master, depth + 1);
553 genpd_power_off(link->master, false, depth + 1);
554 genpd_unlock(link->master);
29e47e21 555 }
9e08cf42 556
3f241775
RW
557 return ret;
558}
559
6ff7bb0d
RW
560static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
561 unsigned long val, void *ptr)
562{
563 struct generic_pm_domain_data *gpd_data;
564 struct device *dev;
565
566 gpd_data = container_of(nb, struct generic_pm_domain_data, nb);
6ff7bb0d 567 dev = gpd_data->base.dev;
6ff7bb0d
RW
568
569 for (;;) {
570 struct generic_pm_domain *genpd;
571 struct pm_domain_data *pdd;
572
573 spin_lock_irq(&dev->power.lock);
574
575 pdd = dev->power.subsys_data ?
576 dev->power.subsys_data->domain_data : NULL;
b4883ca4 577 if (pdd) {
6ff7bb0d
RW
578 to_gpd_data(pdd)->td.constraint_changed = true;
579 genpd = dev_to_genpd(dev);
580 } else {
581 genpd = ERR_PTR(-ENODATA);
582 }
583
584 spin_unlock_irq(&dev->power.lock);
585
586 if (!IS_ERR(genpd)) {
35241d12 587 genpd_lock(genpd);
6ff7bb0d 588 genpd->max_off_time_changed = true;
35241d12 589 genpd_unlock(genpd);
6ff7bb0d
RW
590 }
591
592 dev = dev->parent;
593 if (!dev || dev->power.ignore_children)
594 break;
595 }
596
597 return NOTIFY_DONE;
598}
599
f721889f
RW
600/**
601 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
602 * @work: Work structure used for scheduling the execution of this function.
603 */
604static void genpd_power_off_work_fn(struct work_struct *work)
605{
606 struct generic_pm_domain *genpd;
607
608 genpd = container_of(work, struct generic_pm_domain, power_off_work);
609
35241d12 610 genpd_lock(genpd);
2da83545 611 genpd_power_off(genpd, false, 0);
35241d12 612 genpd_unlock(genpd);
f721889f
RW
613}
614
54eeddbf
UH
615/**
616 * __genpd_runtime_suspend - walk the hierarchy of ->runtime_suspend() callbacks
617 * @dev: Device to handle.
618 */
619static int __genpd_runtime_suspend(struct device *dev)
620{
621 int (*cb)(struct device *__dev);
622
623 if (dev->type && dev->type->pm)
624 cb = dev->type->pm->runtime_suspend;
625 else if (dev->class && dev->class->pm)
626 cb = dev->class->pm->runtime_suspend;
627 else if (dev->bus && dev->bus->pm)
628 cb = dev->bus->pm->runtime_suspend;
629 else
630 cb = NULL;
631
632 if (!cb && dev->driver && dev->driver->pm)
633 cb = dev->driver->pm->runtime_suspend;
634
635 return cb ? cb(dev) : 0;
636}
637
638/**
639 * __genpd_runtime_resume - walk the hierarchy of ->runtime_resume() callbacks
640 * @dev: Device to handle.
641 */
642static int __genpd_runtime_resume(struct device *dev)
643{
644 int (*cb)(struct device *__dev);
645
646 if (dev->type && dev->type->pm)
647 cb = dev->type->pm->runtime_resume;
648 else if (dev->class && dev->class->pm)
649 cb = dev->class->pm->runtime_resume;
650 else if (dev->bus && dev->bus->pm)
651 cb = dev->bus->pm->runtime_resume;
652 else
653 cb = NULL;
654
655 if (!cb && dev->driver && dev->driver->pm)
656 cb = dev->driver->pm->runtime_resume;
657
658 return cb ? cb(dev) : 0;
659}
660
f721889f 661/**
795bd2e7 662 * genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
f721889f
RW
663 * @dev: Device to suspend.
664 *
665 * Carry out a runtime suspend of a device under the assumption that its
666 * pm_domain field points to the domain member of an object of type
667 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
668 */
795bd2e7 669static int genpd_runtime_suspend(struct device *dev)
f721889f
RW
670{
671 struct generic_pm_domain *genpd;
9df3921e 672 bool (*suspend_ok)(struct device *__dev);
2b1d88cd 673 struct gpd_timing_data *td = &dev_gpd_data(dev)->td;
ffe12855 674 bool runtime_pm = pm_runtime_enabled(dev);
2b1d88cd
UH
675 ktime_t time_start;
676 s64 elapsed_ns;
d5e4cbfe 677 int ret;
f721889f
RW
678
679 dev_dbg(dev, "%s()\n", __func__);
680
5248051b
RW
681 genpd = dev_to_genpd(dev);
682 if (IS_ERR(genpd))
f721889f
RW
683 return -EINVAL;
684
ffe12855
UH
685 /*
686 * A runtime PM centric subsystem/driver may re-use the runtime PM
687 * callbacks for other purposes than runtime PM. In those scenarios
688 * runtime PM is disabled. Under these circumstances, we shall skip
689 * validating/measuring the PM QoS latency.
690 */
9df3921e
UH
691 suspend_ok = genpd->gov ? genpd->gov->suspend_ok : NULL;
692 if (runtime_pm && suspend_ok && !suspend_ok(dev))
b02c999a
RW
693 return -EBUSY;
694
2b1d88cd 695 /* Measure suspend latency. */
d33d5a6c 696 time_start = 0;
ffe12855
UH
697 if (runtime_pm)
698 time_start = ktime_get();
2b1d88cd 699
54eeddbf 700 ret = __genpd_runtime_suspend(dev);
d5e4cbfe
RW
701 if (ret)
702 return ret;
17b75eca 703
2b1d88cd 704 ret = genpd_stop_dev(genpd, dev);
ba2bbfbf 705 if (ret) {
54eeddbf 706 __genpd_runtime_resume(dev);
ba2bbfbf
UH
707 return ret;
708 }
709
2b1d88cd 710 /* Update suspend latency value if the measured time exceeds it. */
ffe12855
UH
711 if (runtime_pm) {
712 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
713 if (elapsed_ns > td->suspend_latency_ns) {
714 td->suspend_latency_ns = elapsed_ns;
715 dev_dbg(dev, "suspend latency exceeded, %lld ns\n",
716 elapsed_ns);
717 genpd->max_off_time_changed = true;
718 td->constraint_changed = true;
719 }
2b1d88cd
UH
720 }
721
0aa2a221 722 /*
d716f479
LI
723 * If power.irq_safe is set, this routine may be run with
724 * IRQs disabled, so suspend only if the PM domain also is irq_safe.
0aa2a221 725 */
d716f479 726 if (irq_safe_dev_in_no_sleep_domain(dev, genpd))
0aa2a221
RW
727 return 0;
728
35241d12 729 genpd_lock(genpd);
2da83545 730 genpd_power_off(genpd, true, 0);
35241d12 731 genpd_unlock(genpd);
f721889f
RW
732
733 return 0;
734}
735
f721889f 736/**
795bd2e7 737 * genpd_runtime_resume - Resume a device belonging to I/O PM domain.
f721889f
RW
738 * @dev: Device to resume.
739 *
740 * Carry out a runtime resume of a device under the assumption that its
741 * pm_domain field points to the domain member of an object of type
742 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
743 */
795bd2e7 744static int genpd_runtime_resume(struct device *dev)
f721889f
RW
745{
746 struct generic_pm_domain *genpd;
2b1d88cd 747 struct gpd_timing_data *td = &dev_gpd_data(dev)->td;
ffe12855 748 bool runtime_pm = pm_runtime_enabled(dev);
2b1d88cd
UH
749 ktime_t time_start;
750 s64 elapsed_ns;
f721889f 751 int ret;
ba2bbfbf 752 bool timed = true;
f721889f
RW
753
754 dev_dbg(dev, "%s()\n", __func__);
755
5248051b
RW
756 genpd = dev_to_genpd(dev);
757 if (IS_ERR(genpd))
f721889f
RW
758 return -EINVAL;
759
d716f479
LI
760 /*
761 * As we don't power off a non IRQ safe domain, which holds
762 * an IRQ safe device, we don't need to restore power to it.
763 */
764 if (irq_safe_dev_in_no_sleep_domain(dev, genpd)) {
ba2bbfbf
UH
765 timed = false;
766 goto out;
767 }
0aa2a221 768
35241d12 769 genpd_lock(genpd);
86e12eac 770 ret = genpd_power_on(genpd, 0);
35241d12 771 genpd_unlock(genpd);
c6d22b37 772
ba2bbfbf
UH
773 if (ret)
774 return ret;
c6d22b37 775
ba2bbfbf 776 out:
2b1d88cd 777 /* Measure resume latency. */
ab51e6ba 778 time_start = 0;
ffe12855 779 if (timed && runtime_pm)
2b1d88cd
UH
780 time_start = ktime_get();
781
076395ca
LP
782 ret = genpd_start_dev(genpd, dev);
783 if (ret)
784 goto err_poweroff;
785
54eeddbf 786 ret = __genpd_runtime_resume(dev);
076395ca
LP
787 if (ret)
788 goto err_stop;
2b1d88cd
UH
789
790 /* Update resume latency value if the measured time exceeds it. */
ffe12855 791 if (timed && runtime_pm) {
2b1d88cd
UH
792 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
793 if (elapsed_ns > td->resume_latency_ns) {
794 td->resume_latency_ns = elapsed_ns;
795 dev_dbg(dev, "resume latency exceeded, %lld ns\n",
796 elapsed_ns);
797 genpd->max_off_time_changed = true;
798 td->constraint_changed = true;
799 }
800 }
17b75eca 801
f721889f 802 return 0;
076395ca
LP
803
804err_stop:
805 genpd_stop_dev(genpd, dev);
806err_poweroff:
d716f479
LI
807 if (!pm_runtime_is_irq_safe(dev) ||
808 (pm_runtime_is_irq_safe(dev) && genpd_is_irq_safe(genpd))) {
35241d12 809 genpd_lock(genpd);
2da83545 810 genpd_power_off(genpd, true, 0);
35241d12 811 genpd_unlock(genpd);
076395ca
LP
812 }
813
814 return ret;
f721889f
RW
815}
816
39ac5ba5
TB
817static bool pd_ignore_unused;
818static int __init pd_ignore_unused_setup(char *__unused)
819{
820 pd_ignore_unused = true;
821 return 1;
822}
823__setup("pd_ignore_unused", pd_ignore_unused_setup);
824
17f2ae7f 825/**
86e12eac 826 * genpd_power_off_unused - Power off all PM domains with no devices in use.
17f2ae7f 827 */
86e12eac 828static int __init genpd_power_off_unused(void)
17f2ae7f
RW
829{
830 struct generic_pm_domain *genpd;
831
39ac5ba5
TB
832 if (pd_ignore_unused) {
833 pr_warn("genpd: Not disabling unused power domains\n");
bb4b72fc 834 return 0;
39ac5ba5
TB
835 }
836
17f2ae7f
RW
837 mutex_lock(&gpd_list_lock);
838
839 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
840 genpd_queue_power_off_work(genpd);
841
842 mutex_unlock(&gpd_list_lock);
17f2ae7f 843
2fe71dcd
UH
844 return 0;
845}
86e12eac 846late_initcall(genpd_power_off_unused);
2fe71dcd 847
0159ec67 848#if defined(CONFIG_PM_SLEEP) || defined(CONFIG_PM_GENERIC_DOMAINS_OF)
596ba34b 849
9e9704ea 850static bool genpd_present(const struct generic_pm_domain *genpd)
77f827de 851{
895b31f3 852 const struct generic_pm_domain *gpd;
77f827de
RW
853
854 if (IS_ERR_OR_NULL(genpd))
855 return false;
856
857 list_for_each_entry(gpd, &gpd_list, gpd_list_node)
858 if (gpd == genpd)
859 return true;
860
861 return false;
862}
863
0159ec67
JH
864#endif
865
866#ifdef CONFIG_PM_SLEEP
867
d8600c8b 868static bool genpd_dev_active_wakeup(const struct generic_pm_domain *genpd,
d5e4cbfe
RW
869 struct device *dev)
870{
871 return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
872}
873
596ba34b 874/**
86e12eac 875 * genpd_sync_power_off - Synchronously power off a PM domain and its masters.
596ba34b 876 * @genpd: PM domain to power off, if possible.
0883ac03
UH
877 * @use_lock: use the lock.
878 * @depth: nesting count for lockdep.
596ba34b
RW
879 *
880 * Check if the given PM domain can be powered off (during system suspend or
5063ce15 881 * hibernation) and do that if so. Also, in that case propagate to its masters.
596ba34b 882 *
77f827de 883 * This function is only called in "noirq" and "syscore" stages of system power
0883ac03
UH
884 * transitions. The "noirq" callbacks may be executed asynchronously, thus in
885 * these cases the lock must be held.
596ba34b 886 */
0883ac03
UH
887static void genpd_sync_power_off(struct generic_pm_domain *genpd, bool use_lock,
888 unsigned int depth)
596ba34b 889{
5063ce15 890 struct gpd_link *link;
596ba34b 891
ffaa42e8 892 if (!genpd_status_on(genpd) || genpd_is_always_on(genpd))
596ba34b
RW
893 return;
894
c4bb3160
RW
895 if (genpd->suspended_count != genpd->device_count
896 || atomic_read(&genpd->sd_count) > 0)
596ba34b
RW
897 return;
898
fc5cbf0c
AH
899 /* Choose the deepest state when suspending */
900 genpd->state_idx = genpd->state_count - 1;
1c14967c
UH
901 if (_genpd_power_off(genpd, false))
902 return;
596ba34b 903
17b75eca 904 genpd->status = GPD_STATE_POWER_OFF;
5063ce15
RW
905
906 list_for_each_entry(link, &genpd->slave_links, slave_node) {
907 genpd_sd_counter_dec(link->master);
0883ac03
UH
908
909 if (use_lock)
910 genpd_lock_nested(link->master, depth + 1);
911
912 genpd_sync_power_off(link->master, use_lock, depth + 1);
913
914 if (use_lock)
915 genpd_unlock(link->master);
596ba34b
RW
916 }
917}
918
802d8b49 919/**
86e12eac 920 * genpd_sync_power_on - Synchronously power on a PM domain and its masters.
802d8b49 921 * @genpd: PM domain to power on.
0883ac03
UH
922 * @use_lock: use the lock.
923 * @depth: nesting count for lockdep.
802d8b49 924 *
77f827de 925 * This function is only called in "noirq" and "syscore" stages of system power
0883ac03
UH
926 * transitions. The "noirq" callbacks may be executed asynchronously, thus in
927 * these cases the lock must be held.
802d8b49 928 */
0883ac03
UH
929static void genpd_sync_power_on(struct generic_pm_domain *genpd, bool use_lock,
930 unsigned int depth)
802d8b49
RW
931{
932 struct gpd_link *link;
933
41e2c8e0 934 if (genpd_status_on(genpd))
802d8b49
RW
935 return;
936
937 list_for_each_entry(link, &genpd->slave_links, slave_node) {
802d8b49 938 genpd_sd_counter_inc(link->master);
0883ac03
UH
939
940 if (use_lock)
941 genpd_lock_nested(link->master, depth + 1);
942
943 genpd_sync_power_on(link->master, use_lock, depth + 1);
944
945 if (use_lock)
946 genpd_unlock(link->master);
802d8b49
RW
947 }
948
86e12eac 949 _genpd_power_on(genpd, false);
802d8b49
RW
950
951 genpd->status = GPD_STATE_ACTIVE;
952}
953
4ecd6e65
RW
954/**
955 * resume_needed - Check whether to resume a device before system suspend.
956 * @dev: Device to check.
957 * @genpd: PM domain the device belongs to.
958 *
959 * There are two cases in which a device that can wake up the system from sleep
9e9704ea 960 * states should be resumed by genpd_prepare(): (1) if the device is enabled
4ecd6e65
RW
961 * to wake up the system and it has to remain active for this purpose while the
962 * system is in the sleep state and (2) if the device is not enabled to wake up
963 * the system from sleep states and it generally doesn't generate wakeup signals
964 * by itself (those signals are generated on its behalf by other parts of the
965 * system). In the latter case it may be necessary to reconfigure the device's
966 * wakeup settings during system suspend, because it may have been set up to
967 * signal remote wakeup from the system's working state as needed by runtime PM.
968 * Return 'true' in either of the above cases.
969 */
d8600c8b
KK
970static bool resume_needed(struct device *dev,
971 const struct generic_pm_domain *genpd)
4ecd6e65
RW
972{
973 bool active_wakeup;
974
975 if (!device_can_wakeup(dev))
976 return false;
977
d5e4cbfe 978 active_wakeup = genpd_dev_active_wakeup(genpd, dev);
4ecd6e65
RW
979 return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
980}
981
596ba34b 982/**
9e9704ea 983 * genpd_prepare - Start power transition of a device in a PM domain.
596ba34b
RW
984 * @dev: Device to start the transition of.
985 *
986 * Start a power transition of a device (during a system-wide power transition)
987 * under the assumption that its pm_domain field points to the domain member of
988 * an object of type struct generic_pm_domain representing a PM domain
989 * consisting of I/O devices.
990 */
9e9704ea 991static int genpd_prepare(struct device *dev)
596ba34b
RW
992{
993 struct generic_pm_domain *genpd;
b6c10c84 994 int ret;
596ba34b
RW
995
996 dev_dbg(dev, "%s()\n", __func__);
997
998 genpd = dev_to_genpd(dev);
999 if (IS_ERR(genpd))
1000 return -EINVAL;
1001
17b75eca
RW
1002 /*
1003 * If a wakeup request is pending for the device, it should be woken up
1004 * at this point and a system wakeup event should be reported if it's
1005 * set up to wake up the system from sleep states.
1006 */
4ecd6e65
RW
1007 if (resume_needed(dev, genpd))
1008 pm_runtime_resume(dev);
1009
35241d12 1010 genpd_lock(genpd);
596ba34b 1011
39dd0f23 1012 if (genpd->prepared_count++ == 0)
65533bbf 1013 genpd->suspended_count = 0;
17b75eca 1014
35241d12 1015 genpd_unlock(genpd);
596ba34b 1016
b6c10c84
RW
1017 ret = pm_generic_prepare(dev);
1018 if (ret) {
35241d12 1019 genpd_lock(genpd);
b6c10c84 1020
39dd0f23 1021 genpd->prepared_count--;
b6c10c84 1022
35241d12 1023 genpd_unlock(genpd);
b6c10c84 1024 }
17b75eca 1025
b6c10c84 1026 return ret;
596ba34b
RW
1027}
1028
0496c8ae 1029/**
10da6542
MP
1030 * genpd_finish_suspend - Completion of suspend or hibernation of device in an
1031 * I/O pm domain.
0496c8ae 1032 * @dev: Device to suspend.
10da6542 1033 * @poweroff: Specifies if this is a poweroff_noirq or suspend_noirq callback.
0496c8ae
RW
1034 *
1035 * Stop the device and remove power from the domain if all devices in it have
1036 * been stopped.
1037 */
10da6542 1038static int genpd_finish_suspend(struct device *dev, bool poweroff)
0496c8ae
RW
1039{
1040 struct generic_pm_domain *genpd;
122a2237 1041 int ret;
0496c8ae 1042
0496c8ae
RW
1043 genpd = dev_to_genpd(dev);
1044 if (IS_ERR(genpd))
1045 return -EINVAL;
596ba34b 1046
39dd0f23 1047 if (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev))
d4f2d87a
RW
1048 return 0;
1049
10da6542
MP
1050 if (poweroff)
1051 ret = pm_generic_poweroff_noirq(dev);
1052 else
1053 ret = pm_generic_suspend_noirq(dev);
1054 if (ret)
1055 return ret;
1056
122a2237
UH
1057 if (genpd->dev_ops.stop && genpd->dev_ops.start) {
1058 ret = pm_runtime_force_suspend(dev);
1059 if (ret)
1060 return ret;
1061 }
1062
0883ac03 1063 genpd_lock(genpd);
596ba34b 1064 genpd->suspended_count++;
0883ac03
UH
1065 genpd_sync_power_off(genpd, true, 0);
1066 genpd_unlock(genpd);
596ba34b
RW
1067
1068 return 0;
1069}
1070
10da6542 1071/**
9e9704ea 1072 * genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
10da6542
MP
1073 * @dev: Device to suspend.
1074 *
1075 * Stop the device and remove power from the domain if all devices in it have
1076 * been stopped.
1077 */
9e9704ea 1078static int genpd_suspend_noirq(struct device *dev)
10da6542
MP
1079{
1080 dev_dbg(dev, "%s()\n", __func__);
1081
1082 return genpd_finish_suspend(dev, false);
1083}
1084
596ba34b 1085/**
9e9704ea 1086 * genpd_resume_noirq - Start of resume of device in an I/O PM domain.
596ba34b
RW
1087 * @dev: Device to resume.
1088 *
0496c8ae 1089 * Restore power to the device's PM domain, if necessary, and start the device.
596ba34b 1090 */
9e9704ea 1091static int genpd_resume_noirq(struct device *dev)
596ba34b
RW
1092{
1093 struct generic_pm_domain *genpd;
122a2237 1094 int ret = 0;
596ba34b
RW
1095
1096 dev_dbg(dev, "%s()\n", __func__);
1097
1098 genpd = dev_to_genpd(dev);
1099 if (IS_ERR(genpd))
1100 return -EINVAL;
1101
39dd0f23 1102 if (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev))
596ba34b
RW
1103 return 0;
1104
0883ac03
UH
1105 genpd_lock(genpd);
1106 genpd_sync_power_on(genpd, true, 0);
596ba34b 1107 genpd->suspended_count--;
0883ac03 1108 genpd_unlock(genpd);
596ba34b 1109
122a2237
UH
1110 if (genpd->dev_ops.stop && genpd->dev_ops.start)
1111 ret = pm_runtime_force_resume(dev);
1112
10da6542
MP
1113 ret = pm_generic_resume_noirq(dev);
1114 if (ret)
1115 return ret;
1116
122a2237 1117 return ret;
596ba34b
RW
1118}
1119
0496c8ae 1120/**
9e9704ea 1121 * genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
596ba34b
RW
1122 * @dev: Device to freeze.
1123 *
1124 * Carry out a late freeze of a device under the assumption that its
1125 * pm_domain field points to the domain member of an object of type
1126 * struct generic_pm_domain representing a power domain consisting of I/O
1127 * devices.
1128 */
9e9704ea 1129static int genpd_freeze_noirq(struct device *dev)
596ba34b 1130{
d8600c8b 1131 const struct generic_pm_domain *genpd;
122a2237 1132 int ret = 0;
596ba34b
RW
1133
1134 dev_dbg(dev, "%s()\n", __func__);
1135
1136 genpd = dev_to_genpd(dev);
1137 if (IS_ERR(genpd))
1138 return -EINVAL;
1139
10da6542
MP
1140 ret = pm_generic_freeze_noirq(dev);
1141 if (ret)
1142 return ret;
1143
122a2237
UH
1144 if (genpd->dev_ops.stop && genpd->dev_ops.start)
1145 ret = pm_runtime_force_suspend(dev);
1146
1147 return ret;
0496c8ae 1148}
596ba34b 1149
0496c8ae 1150/**
9e9704ea 1151 * genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
0496c8ae
RW
1152 * @dev: Device to thaw.
1153 *
1154 * Start the device, unless power has been removed from the domain already
1155 * before the system transition.
1156 */
9e9704ea 1157static int genpd_thaw_noirq(struct device *dev)
0496c8ae 1158{
d8600c8b 1159 const struct generic_pm_domain *genpd;
122a2237 1160 int ret = 0;
596ba34b 1161
0496c8ae 1162 dev_dbg(dev, "%s()\n", __func__);
596ba34b 1163
0496c8ae
RW
1164 genpd = dev_to_genpd(dev);
1165 if (IS_ERR(genpd))
1166 return -EINVAL;
1167
10da6542 1168 if (genpd->dev_ops.stop && genpd->dev_ops.start) {
122a2237 1169 ret = pm_runtime_force_resume(dev);
10da6542
MP
1170 if (ret)
1171 return ret;
1172 }
122a2237 1173
10da6542
MP
1174 return pm_generic_thaw_noirq(dev);
1175}
1176
1177/**
9e9704ea 1178 * genpd_poweroff_noirq - Completion of hibernation of device in an
10da6542
MP
1179 * I/O PM domain.
1180 * @dev: Device to poweroff.
1181 *
1182 * Stop the device and remove power from the domain if all devices in it have
1183 * been stopped.
1184 */
9e9704ea 1185static int genpd_poweroff_noirq(struct device *dev)
10da6542
MP
1186{
1187 dev_dbg(dev, "%s()\n", __func__);
1188
1189 return genpd_finish_suspend(dev, true);
596ba34b
RW
1190}
1191
596ba34b 1192/**
9e9704ea 1193 * genpd_restore_noirq - Start of restore of device in an I/O PM domain.
596ba34b
RW
1194 * @dev: Device to resume.
1195 *
0496c8ae
RW
1196 * Make sure the domain will be in the same power state as before the
1197 * hibernation the system is resuming from and start the device if necessary.
596ba34b 1198 */
9e9704ea 1199static int genpd_restore_noirq(struct device *dev)
596ba34b
RW
1200{
1201 struct generic_pm_domain *genpd;
122a2237 1202 int ret = 0;
596ba34b
RW
1203
1204 dev_dbg(dev, "%s()\n", __func__);
1205
1206 genpd = dev_to_genpd(dev);
1207 if (IS_ERR(genpd))
1208 return -EINVAL;
1209
1210 /*
65533bbf
RW
1211 * At this point suspended_count == 0 means we are being run for the
1212 * first time for the given domain in the present cycle.
596ba34b 1213 */
0883ac03 1214 genpd_lock(genpd);
39dd0f23 1215 if (genpd->suspended_count++ == 0)
596ba34b 1216 /*
65533bbf 1217 * The boot kernel might put the domain into arbitrary state,
86e12eac 1218 * so make it appear as powered off to genpd_sync_power_on(),
802d8b49 1219 * so that it tries to power it on in case it was really off.
596ba34b 1220 */
65533bbf 1221 genpd->status = GPD_STATE_POWER_OFF;
18dd2ece 1222
0883ac03
UH
1223 genpd_sync_power_on(genpd, true, 0);
1224 genpd_unlock(genpd);
596ba34b 1225
10da6542 1226 if (genpd->dev_ops.stop && genpd->dev_ops.start) {
122a2237 1227 ret = pm_runtime_force_resume(dev);
10da6542
MP
1228 if (ret)
1229 return ret;
1230 }
122a2237 1231
10da6542 1232 return pm_generic_restore_noirq(dev);
596ba34b
RW
1233}
1234
1235/**
9e9704ea 1236 * genpd_complete - Complete power transition of a device in a power domain.
596ba34b
RW
1237 * @dev: Device to complete the transition of.
1238 *
1239 * Complete a power transition of a device (during a system-wide power
1240 * transition) under the assumption that its pm_domain field points to the
1241 * domain member of an object of type struct generic_pm_domain representing
1242 * a power domain consisting of I/O devices.
1243 */
9e9704ea 1244static void genpd_complete(struct device *dev)
596ba34b
RW
1245{
1246 struct generic_pm_domain *genpd;
596ba34b
RW
1247
1248 dev_dbg(dev, "%s()\n", __func__);
1249
1250 genpd = dev_to_genpd(dev);
1251 if (IS_ERR(genpd))
1252 return;
1253
4d23a5e8
UH
1254 pm_generic_complete(dev);
1255
35241d12 1256 genpd_lock(genpd);
596ba34b 1257
39dd0f23 1258 genpd->prepared_count--;
4d23a5e8
UH
1259 if (!genpd->prepared_count)
1260 genpd_queue_power_off_work(genpd);
596ba34b 1261
35241d12 1262 genpd_unlock(genpd);
596ba34b
RW
1263}
1264
77f827de 1265/**
d47e6464 1266 * genpd_syscore_switch - Switch power during system core suspend or resume.
77f827de
RW
1267 * @dev: Device that normally is marked as "always on" to switch power for.
1268 *
1269 * This routine may only be called during the system core (syscore) suspend or
1270 * resume phase for devices whose "always on" flags are set.
1271 */
d47e6464 1272static void genpd_syscore_switch(struct device *dev, bool suspend)
77f827de
RW
1273{
1274 struct generic_pm_domain *genpd;
1275
23c6d2c7 1276 genpd = dev_to_genpd(dev);
9e9704ea 1277 if (!genpd_present(genpd))
77f827de
RW
1278 return;
1279
1280 if (suspend) {
1281 genpd->suspended_count++;
0883ac03 1282 genpd_sync_power_off(genpd, false, 0);
77f827de 1283 } else {
0883ac03 1284 genpd_sync_power_on(genpd, false, 0);
77f827de
RW
1285 genpd->suspended_count--;
1286 }
1287}
d47e6464
UH
1288
1289void pm_genpd_syscore_poweroff(struct device *dev)
1290{
1291 genpd_syscore_switch(dev, true);
1292}
1293EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweroff);
1294
1295void pm_genpd_syscore_poweron(struct device *dev)
1296{
1297 genpd_syscore_switch(dev, false);
1298}
1299EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweron);
77f827de 1300
d30d819d 1301#else /* !CONFIG_PM_SLEEP */
596ba34b 1302
9e9704ea
UH
1303#define genpd_prepare NULL
1304#define genpd_suspend_noirq NULL
1305#define genpd_resume_noirq NULL
1306#define genpd_freeze_noirq NULL
1307#define genpd_thaw_noirq NULL
1308#define genpd_poweroff_noirq NULL
1309#define genpd_restore_noirq NULL
1310#define genpd_complete NULL
596ba34b
RW
1311
1312#endif /* CONFIG_PM_SLEEP */
1313
f104e1e5
UH
1314static struct generic_pm_domain_data *genpd_alloc_dev_data(struct device *dev,
1315 struct generic_pm_domain *genpd,
1316 struct gpd_timing_data *td)
1d5fcfec
RW
1317{
1318 struct generic_pm_domain_data *gpd_data;
3e235685
UH
1319 int ret;
1320
1321 ret = dev_pm_get_subsys_data(dev);
1322 if (ret)
1323 return ERR_PTR(ret);
1d5fcfec
RW
1324
1325 gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
3e235685
UH
1326 if (!gpd_data) {
1327 ret = -ENOMEM;
1328 goto err_put;
1329 }
1d5fcfec 1330
f104e1e5
UH
1331 if (td)
1332 gpd_data->td = *td;
1333
1334 gpd_data->base.dev = dev;
f104e1e5
UH
1335 gpd_data->td.constraint_changed = true;
1336 gpd_data->td.effective_constraint_ns = -1;
1337 gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
1338
1339 spin_lock_irq(&dev->power.lock);
1340
1341 if (dev->power.subsys_data->domain_data) {
1342 ret = -EINVAL;
1343 goto err_free;
1344 }
1345
1346 dev->power.subsys_data->domain_data = &gpd_data->base;
f104e1e5
UH
1347
1348 spin_unlock_irq(&dev->power.lock);
1349
1d5fcfec 1350 return gpd_data;
3e235685 1351
f104e1e5
UH
1352 err_free:
1353 spin_unlock_irq(&dev->power.lock);
1354 kfree(gpd_data);
3e235685
UH
1355 err_put:
1356 dev_pm_put_subsys_data(dev);
1357 return ERR_PTR(ret);
1d5fcfec
RW
1358}
1359
49d400c7
UH
1360static void genpd_free_dev_data(struct device *dev,
1361 struct generic_pm_domain_data *gpd_data)
1d5fcfec 1362{
f104e1e5
UH
1363 spin_lock_irq(&dev->power.lock);
1364
f104e1e5
UH
1365 dev->power.subsys_data->domain_data = NULL;
1366
1367 spin_unlock_irq(&dev->power.lock);
1368
1d5fcfec 1369 kfree(gpd_data);
3e235685 1370 dev_pm_put_subsys_data(dev);
1d5fcfec
RW
1371}
1372
19efa5ff
JH
1373static int genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1374 struct gpd_timing_data *td)
f721889f 1375{
c0356db7 1376 struct generic_pm_domain_data *gpd_data;
f721889f
RW
1377 int ret = 0;
1378
1379 dev_dbg(dev, "%s()\n", __func__);
1380
1381 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1382 return -EINVAL;
1383
f104e1e5 1384 gpd_data = genpd_alloc_dev_data(dev, genpd, td);
3e235685
UH
1385 if (IS_ERR(gpd_data))
1386 return PTR_ERR(gpd_data);
6ff7bb0d 1387
35241d12 1388 genpd_lock(genpd);
f721889f 1389
596ba34b
RW
1390 if (genpd->prepared_count > 0) {
1391 ret = -EAGAIN;
1392 goto out;
1393 }
1394
b472c2fa
UH
1395 ret = genpd->attach_dev ? genpd->attach_dev(genpd, dev) : 0;
1396 if (ret)
1397 goto out;
d79b6fe1 1398
975e83cf
SH
1399 dev_pm_domain_set(dev, &genpd->domain);
1400
14b53064
UH
1401 genpd->device_count++;
1402 genpd->max_off_time_changed = true;
1403
1d5fcfec 1404 list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
6ff7bb0d 1405
f721889f 1406 out:
35241d12 1407 genpd_unlock(genpd);
f721889f 1408
c0356db7
UH
1409 if (ret)
1410 genpd_free_dev_data(dev, gpd_data);
1411 else
1412 dev_pm_qos_add_notifier(dev, &gpd_data->nb);
1d5fcfec 1413
f721889f
RW
1414 return ret;
1415}
19efa5ff
JH
1416
1417/**
1418 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1419 * @genpd: PM domain to add the device to.
1420 * @dev: Device to be added.
1421 * @td: Set of PM QoS timing parameters to attach to the device.
1422 */
1423int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1424 struct gpd_timing_data *td)
1425{
1426 int ret;
1427
1428 mutex_lock(&gpd_list_lock);
1429 ret = genpd_add_device(genpd, dev, td);
1430 mutex_unlock(&gpd_list_lock);
1431
1432 return ret;
1433}
24c96dc7 1434EXPORT_SYMBOL_GPL(__pm_genpd_add_device);
f721889f 1435
85168d56
UH
1436static int genpd_remove_device(struct generic_pm_domain *genpd,
1437 struct device *dev)
f721889f 1438{
6ff7bb0d 1439 struct generic_pm_domain_data *gpd_data;
4605ab65 1440 struct pm_domain_data *pdd;
efa69025 1441 int ret = 0;
f721889f
RW
1442
1443 dev_dbg(dev, "%s()\n", __func__);
1444
c0356db7
UH
1445 pdd = dev->power.subsys_data->domain_data;
1446 gpd_data = to_gpd_data(pdd);
1447 dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
1448
35241d12 1449 genpd_lock(genpd);
f721889f 1450
596ba34b
RW
1451 if (genpd->prepared_count > 0) {
1452 ret = -EAGAIN;
1453 goto out;
1454 }
1455
6ff7bb0d
RW
1456 genpd->device_count--;
1457 genpd->max_off_time_changed = true;
1458
d79b6fe1 1459 if (genpd->detach_dev)
c16561e8 1460 genpd->detach_dev(genpd, dev);
d79b6fe1 1461
975e83cf
SH
1462 dev_pm_domain_set(dev, NULL);
1463
efa69025 1464 list_del_init(&pdd->list_node);
6ff7bb0d 1465
35241d12 1466 genpd_unlock(genpd);
6ff7bb0d 1467
c1dbe2fb 1468 genpd_free_dev_data(dev, gpd_data);
1d5fcfec 1469
6ff7bb0d 1470 return 0;
f721889f 1471
596ba34b 1472 out:
35241d12 1473 genpd_unlock(genpd);
c0356db7 1474 dev_pm_qos_add_notifier(dev, &gpd_data->nb);
f721889f
RW
1475
1476 return ret;
1477}
85168d56
UH
1478
1479/**
1480 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1481 * @genpd: PM domain to remove the device from.
1482 * @dev: Device to be removed.
1483 */
1484int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1485 struct device *dev)
1486{
1487 if (!genpd || genpd != genpd_lookup_dev(dev))
1488 return -EINVAL;
1489
1490 return genpd_remove_device(genpd, dev);
1491}
24c96dc7 1492EXPORT_SYMBOL_GPL(pm_genpd_remove_device);
f721889f 1493
19efa5ff
JH
1494static int genpd_add_subdomain(struct generic_pm_domain *genpd,
1495 struct generic_pm_domain *subdomain)
f721889f 1496{
2547923d 1497 struct gpd_link *link, *itr;
f721889f
RW
1498 int ret = 0;
1499
fb7268be
RW
1500 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
1501 || genpd == subdomain)
f721889f
RW
1502 return -EINVAL;
1503
d716f479
LI
1504 /*
1505 * If the domain can be powered on/off in an IRQ safe
1506 * context, ensure that the subdomain can also be
1507 * powered on/off in that context.
1508 */
1509 if (!genpd_is_irq_safe(genpd) && genpd_is_irq_safe(subdomain)) {
44cae7d5 1510 WARN(1, "Parent %s of subdomain %s must be IRQ safe\n",
d716f479
LI
1511 genpd->name, subdomain->name);
1512 return -EINVAL;
1513 }
1514
2547923d
LI
1515 link = kzalloc(sizeof(*link), GFP_KERNEL);
1516 if (!link)
1517 return -ENOMEM;
1518
35241d12
LI
1519 genpd_lock(subdomain);
1520 genpd_lock_nested(genpd, SINGLE_DEPTH_NESTING);
f721889f 1521
41e2c8e0 1522 if (!genpd_status_on(genpd) && genpd_status_on(subdomain)) {
f721889f
RW
1523 ret = -EINVAL;
1524 goto out;
1525 }
1526
2547923d
LI
1527 list_for_each_entry(itr, &genpd->master_links, master_node) {
1528 if (itr->slave == subdomain && itr->master == genpd) {
f721889f
RW
1529 ret = -EINVAL;
1530 goto out;
1531 }
1532 }
1533
5063ce15
RW
1534 link->master = genpd;
1535 list_add_tail(&link->master_node, &genpd->master_links);
bc0403ff
RW
1536 link->slave = subdomain;
1537 list_add_tail(&link->slave_node, &subdomain->slave_links);
41e2c8e0 1538 if (genpd_status_on(subdomain))
c4bb3160 1539 genpd_sd_counter_inc(genpd);
f721889f 1540
f721889f 1541 out:
35241d12
LI
1542 genpd_unlock(genpd);
1543 genpd_unlock(subdomain);
2547923d
LI
1544 if (ret)
1545 kfree(link);
f721889f
RW
1546 return ret;
1547}
19efa5ff
JH
1548
1549/**
1550 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1551 * @genpd: Master PM domain to add the subdomain to.
1552 * @subdomain: Subdomain to be added.
1553 */
1554int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1555 struct generic_pm_domain *subdomain)
1556{
1557 int ret;
1558
1559 mutex_lock(&gpd_list_lock);
1560 ret = genpd_add_subdomain(genpd, subdomain);
1561 mutex_unlock(&gpd_list_lock);
1562
1563 return ret;
1564}
d60ee966 1565EXPORT_SYMBOL_GPL(pm_genpd_add_subdomain);
f721889f
RW
1566
1567/**
1568 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1569 * @genpd: Master PM domain to remove the subdomain from.
5063ce15 1570 * @subdomain: Subdomain to be removed.
f721889f
RW
1571 */
1572int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
5063ce15 1573 struct generic_pm_domain *subdomain)
f721889f 1574{
c6e83cac 1575 struct gpd_link *l, *link;
f721889f
RW
1576 int ret = -EINVAL;
1577
5063ce15 1578 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
f721889f
RW
1579 return -EINVAL;
1580
35241d12
LI
1581 genpd_lock(subdomain);
1582 genpd_lock_nested(genpd, SINGLE_DEPTH_NESTING);
f721889f 1583
beda5fc1 1584 if (!list_empty(&subdomain->master_links) || subdomain->device_count) {
30e7a65b
JH
1585 pr_warn("%s: unable to remove subdomain %s\n", genpd->name,
1586 subdomain->name);
1587 ret = -EBUSY;
1588 goto out;
1589 }
1590
c6e83cac 1591 list_for_each_entry_safe(link, l, &genpd->master_links, master_node) {
5063ce15 1592 if (link->slave != subdomain)
f721889f
RW
1593 continue;
1594
5063ce15
RW
1595 list_del(&link->master_node);
1596 list_del(&link->slave_node);
1597 kfree(link);
41e2c8e0 1598 if (genpd_status_on(subdomain))
f721889f
RW
1599 genpd_sd_counter_dec(genpd);
1600
f721889f
RW
1601 ret = 0;
1602 break;
1603 }
1604
30e7a65b 1605out:
35241d12
LI
1606 genpd_unlock(genpd);
1607 genpd_unlock(subdomain);
f721889f
RW
1608
1609 return ret;
1610}
d60ee966 1611EXPORT_SYMBOL_GPL(pm_genpd_remove_subdomain);
f721889f 1612
59d65b73
LI
1613static int genpd_set_default_power_state(struct generic_pm_domain *genpd)
1614{
1615 struct genpd_power_state *state;
1616
1617 state = kzalloc(sizeof(*state), GFP_KERNEL);
1618 if (!state)
1619 return -ENOMEM;
1620
1621 genpd->states = state;
1622 genpd->state_count = 1;
1623 genpd->free = state;
1624
1625 return 0;
1626}
1627
d716f479
LI
1628static void genpd_lock_init(struct generic_pm_domain *genpd)
1629{
1630 if (genpd->flags & GENPD_FLAG_IRQ_SAFE) {
1631 spin_lock_init(&genpd->slock);
1632 genpd->lock_ops = &genpd_spin_ops;
1633 } else {
1634 mutex_init(&genpd->mlock);
1635 genpd->lock_ops = &genpd_mtx_ops;
1636 }
1637}
1638
f721889f
RW
1639/**
1640 * pm_genpd_init - Initialize a generic I/O PM domain object.
1641 * @genpd: PM domain object to initialize.
1642 * @gov: PM domain governor to associate with the domain (may be NULL).
1643 * @is_off: Initial value of the domain's power_is_off field.
7eb231c3
UH
1644 *
1645 * Returns 0 on successful initialization, else a negative error code.
f721889f 1646 */
7eb231c3
UH
1647int pm_genpd_init(struct generic_pm_domain *genpd,
1648 struct dev_power_governor *gov, bool is_off)
f721889f 1649{
59d65b73
LI
1650 int ret;
1651
f721889f 1652 if (IS_ERR_OR_NULL(genpd))
7eb231c3 1653 return -EINVAL;
f721889f 1654
5063ce15
RW
1655 INIT_LIST_HEAD(&genpd->master_links);
1656 INIT_LIST_HEAD(&genpd->slave_links);
f721889f 1657 INIT_LIST_HEAD(&genpd->dev_list);
d716f479 1658 genpd_lock_init(genpd);
f721889f
RW
1659 genpd->gov = gov;
1660 INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
c4bb3160 1661 atomic_set(&genpd->sd_count, 0);
17b75eca 1662 genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
596ba34b 1663 genpd->device_count = 0;
221e9b58 1664 genpd->max_off_time_ns = -1;
6ff7bb0d 1665 genpd->max_off_time_changed = true;
de0aa06d
JH
1666 genpd->provider = NULL;
1667 genpd->has_provider = false;
afece3ab 1668 genpd->accounting_time = ktime_get();
795bd2e7
UH
1669 genpd->domain.ops.runtime_suspend = genpd_runtime_suspend;
1670 genpd->domain.ops.runtime_resume = genpd_runtime_resume;
9e9704ea
UH
1671 genpd->domain.ops.prepare = genpd_prepare;
1672 genpd->domain.ops.suspend_noirq = genpd_suspend_noirq;
1673 genpd->domain.ops.resume_noirq = genpd_resume_noirq;
1674 genpd->domain.ops.freeze_noirq = genpd_freeze_noirq;
1675 genpd->domain.ops.thaw_noirq = genpd_thaw_noirq;
1676 genpd->domain.ops.poweroff_noirq = genpd_poweroff_noirq;
1677 genpd->domain.ops.restore_noirq = genpd_restore_noirq;
1678 genpd->domain.ops.complete = genpd_complete;
c11f6f5b
UH
1679
1680 if (genpd->flags & GENPD_FLAG_PM_CLK) {
1681 genpd->dev_ops.stop = pm_clk_suspend;
1682 genpd->dev_ops.start = pm_clk_resume;
1683 }
1684
ffaa42e8
UH
1685 /* Always-on domains must be powered on at initialization. */
1686 if (genpd_is_always_on(genpd) && !genpd_status_on(genpd))
1687 return -EINVAL;
1688
fc5cbf0c 1689 /* Use only one "off" state if there were no states declared */
59d65b73
LI
1690 if (genpd->state_count == 0) {
1691 ret = genpd_set_default_power_state(genpd);
1692 if (ret)
1693 return ret;
1694 }
fc5cbf0c 1695
5125bbf3
RW
1696 mutex_lock(&gpd_list_lock);
1697 list_add(&genpd->gpd_list_node, &gpd_list);
1698 mutex_unlock(&gpd_list_lock);
7eb231c3
UH
1699
1700 return 0;
5125bbf3 1701}
be5ed55d 1702EXPORT_SYMBOL_GPL(pm_genpd_init);
aa42240a 1703
3fe57710
JH
1704static int genpd_remove(struct generic_pm_domain *genpd)
1705{
1706 struct gpd_link *l, *link;
1707
1708 if (IS_ERR_OR_NULL(genpd))
1709 return -EINVAL;
1710
35241d12 1711 genpd_lock(genpd);
3fe57710
JH
1712
1713 if (genpd->has_provider) {
35241d12 1714 genpd_unlock(genpd);
3fe57710
JH
1715 pr_err("Provider present, unable to remove %s\n", genpd->name);
1716 return -EBUSY;
1717 }
1718
1719 if (!list_empty(&genpd->master_links) || genpd->device_count) {
35241d12 1720 genpd_unlock(genpd);
3fe57710
JH
1721 pr_err("%s: unable to remove %s\n", __func__, genpd->name);
1722 return -EBUSY;
1723 }
1724
1725 list_for_each_entry_safe(link, l, &genpd->slave_links, slave_node) {
1726 list_del(&link->master_node);
1727 list_del(&link->slave_node);
1728 kfree(link);
1729 }
1730
1731 list_del(&genpd->gpd_list_node);
35241d12 1732 genpd_unlock(genpd);
3fe57710 1733 cancel_work_sync(&genpd->power_off_work);
59d65b73 1734 kfree(genpd->free);
3fe57710
JH
1735 pr_debug("%s: removed %s\n", __func__, genpd->name);
1736
1737 return 0;
1738}
1739
1740/**
1741 * pm_genpd_remove - Remove a generic I/O PM domain
1742 * @genpd: Pointer to PM domain that is to be removed.
1743 *
1744 * To remove the PM domain, this function:
1745 * - Removes the PM domain as a subdomain to any parent domains,
1746 * if it was added.
1747 * - Removes the PM domain from the list of registered PM domains.
1748 *
1749 * The PM domain will only be removed, if the associated provider has
1750 * been removed, it is not a parent to any other PM domain and has no
1751 * devices associated with it.
1752 */
1753int pm_genpd_remove(struct generic_pm_domain *genpd)
1754{
1755 int ret;
1756
1757 mutex_lock(&gpd_list_lock);
1758 ret = genpd_remove(genpd);
1759 mutex_unlock(&gpd_list_lock);
1760
1761 return ret;
1762}
1763EXPORT_SYMBOL_GPL(pm_genpd_remove);
1764
aa42240a 1765#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
892ebdcc 1766
aa42240a
TF
1767/*
1768 * Device Tree based PM domain providers.
1769 *
1770 * The code below implements generic device tree based PM domain providers that
1771 * bind device tree nodes with generic PM domains registered in the system.
1772 *
1773 * Any driver that registers generic PM domains and needs to support binding of
1774 * devices to these domains is supposed to register a PM domain provider, which
1775 * maps a PM domain specifier retrieved from the device tree to a PM domain.
1776 *
1777 * Two simple mapping functions have been provided for convenience:
892ebdcc
JH
1778 * - genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
1779 * - genpd_xlate_onecell() for mapping of multiple PM domains per node by
aa42240a
TF
1780 * index.
1781 */
1782
1783/**
1784 * struct of_genpd_provider - PM domain provider registration structure
1785 * @link: Entry in global list of PM domain providers
1786 * @node: Pointer to device tree node of PM domain provider
1787 * @xlate: Provider-specific xlate callback mapping a set of specifier cells
1788 * into a PM domain.
1789 * @data: context pointer to be passed into @xlate callback
1790 */
1791struct of_genpd_provider {
1792 struct list_head link;
1793 struct device_node *node;
1794 genpd_xlate_t xlate;
1795 void *data;
1796};
1797
1798/* List of registered PM domain providers. */
1799static LIST_HEAD(of_genpd_providers);
1800/* Mutex to protect the list above. */
1801static DEFINE_MUTEX(of_genpd_mutex);
1802
1803/**
892ebdcc 1804 * genpd_xlate_simple() - Xlate function for direct node-domain mapping
aa42240a
TF
1805 * @genpdspec: OF phandle args to map into a PM domain
1806 * @data: xlate function private data - pointer to struct generic_pm_domain
1807 *
1808 * This is a generic xlate function that can be used to model PM domains that
1809 * have their own device tree nodes. The private data of xlate function needs
1810 * to be a valid pointer to struct generic_pm_domain.
1811 */
892ebdcc 1812static struct generic_pm_domain *genpd_xlate_simple(
aa42240a
TF
1813 struct of_phandle_args *genpdspec,
1814 void *data)
1815{
aa42240a
TF
1816 return data;
1817}
aa42240a
TF
1818
1819/**
892ebdcc 1820 * genpd_xlate_onecell() - Xlate function using a single index.
aa42240a
TF
1821 * @genpdspec: OF phandle args to map into a PM domain
1822 * @data: xlate function private data - pointer to struct genpd_onecell_data
1823 *
1824 * This is a generic xlate function that can be used to model simple PM domain
1825 * controllers that have one device tree node and provide multiple PM domains.
1826 * A single cell is used as an index into an array of PM domains specified in
1827 * the genpd_onecell_data struct when registering the provider.
1828 */
892ebdcc 1829static struct generic_pm_domain *genpd_xlate_onecell(
aa42240a
TF
1830 struct of_phandle_args *genpdspec,
1831 void *data)
1832{
1833 struct genpd_onecell_data *genpd_data = data;
1834 unsigned int idx = genpdspec->args[0];
1835
1836 if (genpdspec->args_count != 1)
1837 return ERR_PTR(-EINVAL);
1838
1839 if (idx >= genpd_data->num_domains) {
1840 pr_err("%s: invalid domain index %u\n", __func__, idx);
1841 return ERR_PTR(-EINVAL);
1842 }
1843
1844 if (!genpd_data->domains[idx])
1845 return ERR_PTR(-ENOENT);
1846
1847 return genpd_data->domains[idx];
1848}
aa42240a
TF
1849
1850/**
892ebdcc 1851 * genpd_add_provider() - Register a PM domain provider for a node
aa42240a
TF
1852 * @np: Device node pointer associated with the PM domain provider.
1853 * @xlate: Callback for decoding PM domain from phandle arguments.
1854 * @data: Context pointer for @xlate callback.
1855 */
892ebdcc
JH
1856static int genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
1857 void *data)
aa42240a
TF
1858{
1859 struct of_genpd_provider *cp;
1860
1861 cp = kzalloc(sizeof(*cp), GFP_KERNEL);
1862 if (!cp)
1863 return -ENOMEM;
1864
1865 cp->node = of_node_get(np);
1866 cp->data = data;
1867 cp->xlate = xlate;
1868
1869 mutex_lock(&of_genpd_mutex);
1870 list_add(&cp->link, &of_genpd_providers);
1871 mutex_unlock(&of_genpd_mutex);
ea11e94b 1872 pr_debug("Added domain provider from %pOF\n", np);
aa42240a
TF
1873
1874 return 0;
1875}
892ebdcc
JH
1876
1877/**
1878 * of_genpd_add_provider_simple() - Register a simple PM domain provider
1879 * @np: Device node pointer associated with the PM domain provider.
1880 * @genpd: Pointer to PM domain associated with the PM domain provider.
1881 */
1882int of_genpd_add_provider_simple(struct device_node *np,
1883 struct generic_pm_domain *genpd)
1884{
0159ec67
JH
1885 int ret = -EINVAL;
1886
1887 if (!np || !genpd)
1888 return -EINVAL;
1889
1890 mutex_lock(&gpd_list_lock);
1891
9e9704ea 1892 if (genpd_present(genpd)) {
0159ec67 1893 ret = genpd_add_provider(np, genpd_xlate_simple, genpd);
8ce95844
VK
1894 if (!ret) {
1895 genpd->provider = &np->fwnode;
1896 genpd->has_provider = true;
1897 }
de0aa06d
JH
1898 }
1899
0159ec67
JH
1900 mutex_unlock(&gpd_list_lock);
1901
1902 return ret;
892ebdcc
JH
1903}
1904EXPORT_SYMBOL_GPL(of_genpd_add_provider_simple);
1905
1906/**
1907 * of_genpd_add_provider_onecell() - Register a onecell PM domain provider
1908 * @np: Device node pointer associated with the PM domain provider.
1909 * @data: Pointer to the data associated with the PM domain provider.
1910 */
1911int of_genpd_add_provider_onecell(struct device_node *np,
1912 struct genpd_onecell_data *data)
1913{
0159ec67 1914 unsigned int i;
de0aa06d 1915 int ret = -EINVAL;
0159ec67
JH
1916
1917 if (!np || !data)
1918 return -EINVAL;
1919
1920 mutex_lock(&gpd_list_lock);
1921
40845524
TR
1922 if (!data->xlate)
1923 data->xlate = genpd_xlate_onecell;
1924
0159ec67 1925 for (i = 0; i < data->num_domains; i++) {
609bed67
TV
1926 if (!data->domains[i])
1927 continue;
9e9704ea 1928 if (!genpd_present(data->domains[i]))
de0aa06d
JH
1929 goto error;
1930
1931 data->domains[i]->provider = &np->fwnode;
1932 data->domains[i]->has_provider = true;
0159ec67
JH
1933 }
1934
40845524 1935 ret = genpd_add_provider(np, data->xlate, data);
de0aa06d
JH
1936 if (ret < 0)
1937 goto error;
1938
1939 mutex_unlock(&gpd_list_lock);
1940
1941 return 0;
1942
1943error:
1944 while (i--) {
609bed67
TV
1945 if (!data->domains[i])
1946 continue;
de0aa06d
JH
1947 data->domains[i]->provider = NULL;
1948 data->domains[i]->has_provider = false;
1949 }
0159ec67
JH
1950
1951 mutex_unlock(&gpd_list_lock);
1952
1953 return ret;
892ebdcc
JH
1954}
1955EXPORT_SYMBOL_GPL(of_genpd_add_provider_onecell);
aa42240a
TF
1956
1957/**
1958 * of_genpd_del_provider() - Remove a previously registered PM domain provider
1959 * @np: Device node pointer associated with the PM domain provider
1960 */
1961void of_genpd_del_provider(struct device_node *np)
1962{
b556b15d 1963 struct of_genpd_provider *cp, *tmp;
de0aa06d 1964 struct generic_pm_domain *gpd;
aa42240a 1965
de0aa06d 1966 mutex_lock(&gpd_list_lock);
aa42240a 1967 mutex_lock(&of_genpd_mutex);
b556b15d 1968 list_for_each_entry_safe(cp, tmp, &of_genpd_providers, link) {
aa42240a 1969 if (cp->node == np) {
de0aa06d
JH
1970 /*
1971 * For each PM domain associated with the
1972 * provider, set the 'has_provider' to false
1973 * so that the PM domain can be safely removed.
1974 */
1975 list_for_each_entry(gpd, &gpd_list, gpd_list_node)
1976 if (gpd->provider == &np->fwnode)
1977 gpd->has_provider = false;
1978
aa42240a
TF
1979 list_del(&cp->link);
1980 of_node_put(cp->node);
1981 kfree(cp);
1982 break;
1983 }
1984 }
1985 mutex_unlock(&of_genpd_mutex);
de0aa06d 1986 mutex_unlock(&gpd_list_lock);
aa42240a
TF
1987}
1988EXPORT_SYMBOL_GPL(of_genpd_del_provider);
1989
1990/**
f58d4e5a 1991 * genpd_get_from_provider() - Look-up PM domain
aa42240a
TF
1992 * @genpdspec: OF phandle args to use for look-up
1993 *
1994 * Looks for a PM domain provider under the node specified by @genpdspec and if
1995 * found, uses xlate function of the provider to map phandle args to a PM
1996 * domain.
1997 *
1998 * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
1999 * on failure.
2000 */
f58d4e5a 2001static struct generic_pm_domain *genpd_get_from_provider(
aa42240a
TF
2002 struct of_phandle_args *genpdspec)
2003{
2004 struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
2005 struct of_genpd_provider *provider;
2006
41795a8a
JH
2007 if (!genpdspec)
2008 return ERR_PTR(-EINVAL);
2009
aa42240a
TF
2010 mutex_lock(&of_genpd_mutex);
2011
2012 /* Check if we have such a provider in our array */
2013 list_for_each_entry(provider, &of_genpd_providers, link) {
2014 if (provider->node == genpdspec->np)
2015 genpd = provider->xlate(genpdspec, provider->data);
2016 if (!IS_ERR(genpd))
2017 break;
2018 }
2019
2020 mutex_unlock(&of_genpd_mutex);
2021
2022 return genpd;
2023}
2024
ec69572b
JH
2025/**
2026 * of_genpd_add_device() - Add a device to an I/O PM domain
2027 * @genpdspec: OF phandle args to use for look-up PM domain
2028 * @dev: Device to be added.
2029 *
2030 * Looks-up an I/O PM domain based upon phandle args provided and adds
2031 * the device to the PM domain. Returns a negative error code on failure.
2032 */
2033int of_genpd_add_device(struct of_phandle_args *genpdspec, struct device *dev)
2034{
2035 struct generic_pm_domain *genpd;
19efa5ff
JH
2036 int ret;
2037
2038 mutex_lock(&gpd_list_lock);
ec69572b 2039
f58d4e5a 2040 genpd = genpd_get_from_provider(genpdspec);
19efa5ff
JH
2041 if (IS_ERR(genpd)) {
2042 ret = PTR_ERR(genpd);
2043 goto out;
2044 }
2045
2046 ret = genpd_add_device(genpd, dev, NULL);
ec69572b 2047
19efa5ff
JH
2048out:
2049 mutex_unlock(&gpd_list_lock);
2050
2051 return ret;
ec69572b
JH
2052}
2053EXPORT_SYMBOL_GPL(of_genpd_add_device);
2054
2055/**
2056 * of_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
2057 * @parent_spec: OF phandle args to use for parent PM domain look-up
2058 * @subdomain_spec: OF phandle args to use for subdomain look-up
2059 *
2060 * Looks-up a parent PM domain and subdomain based upon phandle args
2061 * provided and adds the subdomain to the parent PM domain. Returns a
2062 * negative error code on failure.
2063 */
2064int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
2065 struct of_phandle_args *subdomain_spec)
2066{
2067 struct generic_pm_domain *parent, *subdomain;
19efa5ff
JH
2068 int ret;
2069
2070 mutex_lock(&gpd_list_lock);
ec69572b 2071
f58d4e5a 2072 parent = genpd_get_from_provider(parent_spec);
19efa5ff
JH
2073 if (IS_ERR(parent)) {
2074 ret = PTR_ERR(parent);
2075 goto out;
2076 }
ec69572b 2077
f58d4e5a 2078 subdomain = genpd_get_from_provider(subdomain_spec);
19efa5ff
JH
2079 if (IS_ERR(subdomain)) {
2080 ret = PTR_ERR(subdomain);
2081 goto out;
2082 }
2083
2084 ret = genpd_add_subdomain(parent, subdomain);
ec69572b 2085
19efa5ff
JH
2086out:
2087 mutex_unlock(&gpd_list_lock);
2088
2089 return ret;
ec69572b
JH
2090}
2091EXPORT_SYMBOL_GPL(of_genpd_add_subdomain);
2092
17926551
JH
2093/**
2094 * of_genpd_remove_last - Remove the last PM domain registered for a provider
2095 * @provider: Pointer to device structure associated with provider
2096 *
2097 * Find the last PM domain that was added by a particular provider and
2098 * remove this PM domain from the list of PM domains. The provider is
2099 * identified by the 'provider' device structure that is passed. The PM
2100 * domain will only be removed, if the provider associated with domain
2101 * has been removed.
2102 *
2103 * Returns a valid pointer to struct generic_pm_domain on success or
2104 * ERR_PTR() on failure.
2105 */
2106struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
2107{
a7e2d1bc 2108 struct generic_pm_domain *gpd, *tmp, *genpd = ERR_PTR(-ENOENT);
17926551
JH
2109 int ret;
2110
2111 if (IS_ERR_OR_NULL(np))
2112 return ERR_PTR(-EINVAL);
2113
2114 mutex_lock(&gpd_list_lock);
a7e2d1bc 2115 list_for_each_entry_safe(gpd, tmp, &gpd_list, gpd_list_node) {
17926551
JH
2116 if (gpd->provider == &np->fwnode) {
2117 ret = genpd_remove(gpd);
2118 genpd = ret ? ERR_PTR(ret) : gpd;
2119 break;
2120 }
2121 }
2122 mutex_unlock(&gpd_list_lock);
2123
2124 return genpd;
2125}
2126EXPORT_SYMBOL_GPL(of_genpd_remove_last);
2127
aa42240a
TF
2128/**
2129 * genpd_dev_pm_detach - Detach a device from its PM domain.
8bb6944e 2130 * @dev: Device to detach.
aa42240a
TF
2131 * @power_off: Currently not used
2132 *
2133 * Try to locate a corresponding generic PM domain, which the device was
2134 * attached to previously. If such is found, the device is detached from it.
2135 */
2136static void genpd_dev_pm_detach(struct device *dev, bool power_off)
2137{
446d999c 2138 struct generic_pm_domain *pd;
93af5e93 2139 unsigned int i;
aa42240a
TF
2140 int ret = 0;
2141
85168d56
UH
2142 pd = dev_to_genpd(dev);
2143 if (IS_ERR(pd))
aa42240a
TF
2144 return;
2145
2146 dev_dbg(dev, "removing from PM domain %s\n", pd->name);
2147
93af5e93 2148 for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
85168d56 2149 ret = genpd_remove_device(pd, dev);
aa42240a
TF
2150 if (ret != -EAGAIN)
2151 break;
93af5e93
GU
2152
2153 mdelay(i);
aa42240a
TF
2154 cond_resched();
2155 }
2156
2157 if (ret < 0) {
2158 dev_err(dev, "failed to remove from PM domain %s: %d",
2159 pd->name, ret);
2160 return;
2161 }
2162
2163 /* Check if PM domain can be powered off after removing this device. */
2164 genpd_queue_power_off_work(pd);
2165}
2166
632f7ce3
RK
2167static void genpd_dev_pm_sync(struct device *dev)
2168{
2169 struct generic_pm_domain *pd;
2170
2171 pd = dev_to_genpd(dev);
2172 if (IS_ERR(pd))
2173 return;
2174
2175 genpd_queue_power_off_work(pd);
2176}
2177
aa42240a
TF
2178/**
2179 * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
2180 * @dev: Device to attach.
2181 *
2182 * Parse device's OF node to find a PM domain specifier. If such is found,
2183 * attaches the device to retrieved pm_domain ops.
2184 *
2185 * Both generic and legacy Samsung-specific DT bindings are supported to keep
2186 * backwards compatibility with existing DTBs.
2187 *
311fa6ad
JH
2188 * Returns 0 on successfully attached PM domain or negative error code. Note
2189 * that if a power-domain exists for the device, but it cannot be found or
2190 * turned on, then return -EPROBE_DEFER to ensure that the device is not
2191 * probed and to re-try again later.
aa42240a
TF
2192 */
2193int genpd_dev_pm_attach(struct device *dev)
2194{
2195 struct of_phandle_args pd_args;
2196 struct generic_pm_domain *pd;
93af5e93 2197 unsigned int i;
aa42240a
TF
2198 int ret;
2199
2200 if (!dev->of_node)
2201 return -ENODEV;
2202
2203 if (dev->pm_domain)
2204 return -EEXIST;
2205
2206 ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
2207 "#power-domain-cells", 0, &pd_args);
2208 if (ret < 0) {
2209 if (ret != -ENOENT)
2210 return ret;
2211
2212 /*
2213 * Try legacy Samsung-specific bindings
2214 * (for backwards compatibility of DT ABI)
2215 */
2216 pd_args.args_count = 0;
2217 pd_args.np = of_parse_phandle(dev->of_node,
2218 "samsung,power-domain", 0);
2219 if (!pd_args.np)
2220 return -ENOENT;
2221 }
2222
19efa5ff 2223 mutex_lock(&gpd_list_lock);
f58d4e5a 2224 pd = genpd_get_from_provider(&pd_args);
265e2cf6 2225 of_node_put(pd_args.np);
aa42240a 2226 if (IS_ERR(pd)) {
19efa5ff 2227 mutex_unlock(&gpd_list_lock);
aa42240a
TF
2228 dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
2229 __func__, PTR_ERR(pd));
311fa6ad 2230 return -EPROBE_DEFER;
aa42240a
TF
2231 }
2232
2233 dev_dbg(dev, "adding to PM domain %s\n", pd->name);
2234
93af5e93 2235 for (i = 1; i < GENPD_RETRY_MAX_MS; i <<= 1) {
19efa5ff 2236 ret = genpd_add_device(pd, dev, NULL);
aa42240a
TF
2237 if (ret != -EAGAIN)
2238 break;
93af5e93
GU
2239
2240 mdelay(i);
aa42240a
TF
2241 cond_resched();
2242 }
19efa5ff 2243 mutex_unlock(&gpd_list_lock);
aa42240a
TF
2244
2245 if (ret < 0) {
34994692
GU
2246 if (ret != -EPROBE_DEFER)
2247 dev_err(dev, "failed to add to PM domain %s: %d",
2248 pd->name, ret);
311fa6ad 2249 goto out;
aa42240a
TF
2250 }
2251
2252 dev->pm_domain->detach = genpd_dev_pm_detach;
632f7ce3 2253 dev->pm_domain->sync = genpd_dev_pm_sync;
aa42240a 2254
35241d12 2255 genpd_lock(pd);
86e12eac 2256 ret = genpd_power_on(pd, 0);
35241d12 2257 genpd_unlock(pd);
311fa6ad
JH
2258out:
2259 return ret ? -EPROBE_DEFER : 0;
aa42240a
TF
2260}
2261EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
30f60428
LI
2262
2263static const struct of_device_id idle_state_match[] = {
598da548 2264 { .compatible = "domain-idle-state", },
30f60428
LI
2265 { }
2266};
2267
2268static int genpd_parse_state(struct genpd_power_state *genpd_state,
2269 struct device_node *state_node)
2270{
2271 int err;
2272 u32 residency;
2273 u32 entry_latency, exit_latency;
30f60428
LI
2274
2275 err = of_property_read_u32(state_node, "entry-latency-us",
2276 &entry_latency);
2277 if (err) {
ea11e94b
RH
2278 pr_debug(" * %pOF missing entry-latency-us property\n",
2279 state_node);
30f60428
LI
2280 return -EINVAL;
2281 }
2282
2283 err = of_property_read_u32(state_node, "exit-latency-us",
2284 &exit_latency);
2285 if (err) {
ea11e94b
RH
2286 pr_debug(" * %pOF missing exit-latency-us property\n",
2287 state_node);
30f60428
LI
2288 return -EINVAL;
2289 }
2290
2291 err = of_property_read_u32(state_node, "min-residency-us", &residency);
2292 if (!err)
2293 genpd_state->residency_ns = 1000 * residency;
2294
2295 genpd_state->power_on_latency_ns = 1000 * exit_latency;
2296 genpd_state->power_off_latency_ns = 1000 * entry_latency;
0c9b694a 2297 genpd_state->fwnode = &state_node->fwnode;
30f60428
LI
2298
2299 return 0;
2300}
2301
2302/**
2303 * of_genpd_parse_idle_states: Return array of idle states for the genpd.
2304 *
2305 * @dn: The genpd device node
2306 * @states: The pointer to which the state array will be saved.
2307 * @n: The count of elements in the array returned from this function.
2308 *
2309 * Returns the device states parsed from the OF node. The memory for the states
2310 * is allocated by this function and is the responsibility of the caller to
2311 * free the memory after use.
2312 */
2313int of_genpd_parse_idle_states(struct device_node *dn,
2314 struct genpd_power_state **states, int *n)
2315{
2316 struct genpd_power_state *st;
2317 struct device_node *np;
2318 int i = 0;
2319 int err, ret;
2320 int count;
2321 struct of_phandle_iterator it;
b539cc82 2322 const struct of_device_id *match_id;
30f60428
LI
2323
2324 count = of_count_phandle_with_args(dn, "domain-idle-states", NULL);
a1fee00d 2325 if (count <= 0)
30f60428
LI
2326 return -EINVAL;
2327
2328 st = kcalloc(count, sizeof(*st), GFP_KERNEL);
2329 if (!st)
2330 return -ENOMEM;
2331
2332 /* Loop over the phandles until all the requested entry is found */
2333 of_for_each_phandle(&it, err, dn, "domain-idle-states", NULL, 0) {
2334 np = it.node;
b539cc82
LI
2335 match_id = of_match_node(idle_state_match, np);
2336 if (!match_id)
2337 continue;
30f60428
LI
2338 ret = genpd_parse_state(&st[i++], np);
2339 if (ret) {
2340 pr_err
ea11e94b
RH
2341 ("Parsing idle state node %pOF failed with err %d\n",
2342 np, ret);
30f60428
LI
2343 of_node_put(np);
2344 kfree(st);
2345 return ret;
2346 }
2347 }
2348
b539cc82
LI
2349 *n = i;
2350 if (!i)
2351 kfree(st);
2352 else
2353 *states = st;
30f60428
LI
2354
2355 return 0;
2356}
2357EXPORT_SYMBOL_GPL(of_genpd_parse_idle_states);
2358
d30d819d 2359#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
2bd5306a
MM
2360
2361
2362/*** debugfs support ***/
2363
8b0510b5 2364#ifdef CONFIG_DEBUG_FS
2bd5306a
MM
2365#include <linux/pm.h>
2366#include <linux/device.h>
2367#include <linux/debugfs.h>
2368#include <linux/seq_file.h>
2369#include <linux/init.h>
2370#include <linux/kobject.h>
9e9704ea 2371static struct dentry *genpd_debugfs_dir;
2bd5306a
MM
2372
2373/*
2374 * TODO: This function is a slightly modified version of rtpm_status_show
d30d819d 2375 * from sysfs.c, so generalize it.
2bd5306a 2376 */
2bd5306a
MM
2377static void rtpm_status_str(struct seq_file *s, struct device *dev)
2378{
2379 static const char * const status_lookup[] = {
2380 [RPM_ACTIVE] = "active",
2381 [RPM_RESUMING] = "resuming",
2382 [RPM_SUSPENDED] = "suspended",
2383 [RPM_SUSPENDING] = "suspending"
2384 };
2385 const char *p = "";
2386
2387 if (dev->power.runtime_error)
2388 p = "error";
2389 else if (dev->power.disable_depth)
2390 p = "unsupported";
2391 else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
2392 p = status_lookup[dev->power.runtime_status];
2393 else
2394 WARN_ON(1);
2395
2396 seq_puts(s, p);
2397}
2bd5306a 2398
9e9704ea
UH
2399static int genpd_summary_one(struct seq_file *s,
2400 struct generic_pm_domain *genpd)
2bd5306a
MM
2401{
2402 static const char * const status_lookup[] = {
2403 [GPD_STATE_ACTIVE] = "on",
2bd5306a
MM
2404 [GPD_STATE_POWER_OFF] = "off"
2405 };
2406 struct pm_domain_data *pm_data;
2407 const char *kobj_path;
2408 struct gpd_link *link;
6954d432 2409 char state[16];
2bd5306a
MM
2410 int ret;
2411
35241d12 2412 ret = genpd_lock_interruptible(genpd);
2bd5306a
MM
2413 if (ret)
2414 return -ERESTARTSYS;
2415
66a5ca4b 2416 if (WARN_ON(genpd->status >= ARRAY_SIZE(status_lookup)))
2bd5306a 2417 goto exit;
41e2c8e0 2418 if (!genpd_status_on(genpd))
0ba554e4 2419 snprintf(state, sizeof(state), "%s-%u",
6954d432 2420 status_lookup[genpd->status], genpd->state_idx);
fc5cbf0c 2421 else
6954d432
GU
2422 snprintf(state, sizeof(state), "%s",
2423 status_lookup[genpd->status]);
2424 seq_printf(s, "%-30s %-15s ", genpd->name, state);
2bd5306a
MM
2425
2426 /*
2427 * Modifications on the list require holding locks on both
2428 * master and slave, so we are safe.
66a5ca4b 2429 * Also genpd->name is immutable.
2bd5306a 2430 */
66a5ca4b 2431 list_for_each_entry(link, &genpd->master_links, master_node) {
2bd5306a 2432 seq_printf(s, "%s", link->slave->name);
66a5ca4b 2433 if (!list_is_last(&link->master_node, &genpd->master_links))
2bd5306a
MM
2434 seq_puts(s, ", ");
2435 }
2436
66a5ca4b 2437 list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
d716f479
LI
2438 kobj_path = kobject_get_path(&pm_data->dev->kobj,
2439 genpd_is_irq_safe(genpd) ?
2440 GFP_ATOMIC : GFP_KERNEL);
2bd5306a
MM
2441 if (kobj_path == NULL)
2442 continue;
2443
2444 seq_printf(s, "\n %-50s ", kobj_path);
2445 rtpm_status_str(s, pm_data->dev);
2446 kfree(kobj_path);
2447 }
2448
2449 seq_puts(s, "\n");
2450exit:
35241d12 2451 genpd_unlock(genpd);
2bd5306a
MM
2452
2453 return 0;
2454}
2455
b6a1d093 2456static int genpd_summary_show(struct seq_file *s, void *data)
2bd5306a 2457{
66a5ca4b 2458 struct generic_pm_domain *genpd;
2bd5306a
MM
2459 int ret = 0;
2460
15dec67a
GU
2461 seq_puts(s, "domain status slaves\n");
2462 seq_puts(s, " /device runtime status\n");
2bd5306a
MM
2463 seq_puts(s, "----------------------------------------------------------------------\n");
2464
2465 ret = mutex_lock_interruptible(&gpd_list_lock);
2466 if (ret)
2467 return -ERESTARTSYS;
2468
66a5ca4b 2469 list_for_each_entry(genpd, &gpd_list, gpd_list_node) {
9e9704ea 2470 ret = genpd_summary_one(s, genpd);
2bd5306a
MM
2471 if (ret)
2472 break;
2473 }
2474 mutex_unlock(&gpd_list_lock);
2475
2476 return ret;
2477}
2478
b6a1d093 2479static int genpd_status_show(struct seq_file *s, void *data)
2bd5306a 2480{
b6a1d093
TG
2481 static const char * const status_lookup[] = {
2482 [GPD_STATE_ACTIVE] = "on",
2483 [GPD_STATE_POWER_OFF] = "off"
2484 };
2485
2486 struct generic_pm_domain *genpd = s->private;
2487 int ret = 0;
2488
2489 ret = genpd_lock_interruptible(genpd);
2490 if (ret)
2491 return -ERESTARTSYS;
2492
2493 if (WARN_ON_ONCE(genpd->status >= ARRAY_SIZE(status_lookup)))
2494 goto exit;
2495
2496 if (genpd->status == GPD_STATE_POWER_OFF)
2497 seq_printf(s, "%s-%u\n", status_lookup[genpd->status],
2498 genpd->state_idx);
2499 else
2500 seq_printf(s, "%s\n", status_lookup[genpd->status]);
2501exit:
2502 genpd_unlock(genpd);
2503 return ret;
2bd5306a
MM
2504}
2505
b6a1d093
TG
2506static int genpd_sub_domains_show(struct seq_file *s, void *data)
2507{
2508 struct generic_pm_domain *genpd = s->private;
2509 struct gpd_link *link;
2510 int ret = 0;
2511
2512 ret = genpd_lock_interruptible(genpd);
2513 if (ret)
2514 return -ERESTARTSYS;
2515
2516 list_for_each_entry(link, &genpd->master_links, master_node)
2517 seq_printf(s, "%s\n", link->slave->name);
2518
2519 genpd_unlock(genpd);
2520 return ret;
2521}
2522
2523static int genpd_idle_states_show(struct seq_file *s, void *data)
2524{
2525 struct generic_pm_domain *genpd = s->private;
2526 unsigned int i;
2527 int ret = 0;
2528
2529 ret = genpd_lock_interruptible(genpd);
2530 if (ret)
2531 return -ERESTARTSYS;
2532
2533 seq_puts(s, "State Time Spent(ms)\n");
2534
2535 for (i = 0; i < genpd->state_count; i++) {
2536 ktime_t delta = 0;
2537 s64 msecs;
2538
2539 if ((genpd->status == GPD_STATE_POWER_OFF) &&
2540 (genpd->state_idx == i))
2541 delta = ktime_sub(ktime_get(), genpd->accounting_time);
2542
2543 msecs = ktime_to_ms(
2544 ktime_add(genpd->states[i].idle_time, delta));
2545 seq_printf(s, "S%-13i %lld\n", i, msecs);
2546 }
2547
2548 genpd_unlock(genpd);
2549 return ret;
2550}
2551
2552static int genpd_active_time_show(struct seq_file *s, void *data)
2553{
2554 struct generic_pm_domain *genpd = s->private;
2555 ktime_t delta = 0;
2556 int ret = 0;
2557
2558 ret = genpd_lock_interruptible(genpd);
2559 if (ret)
2560 return -ERESTARTSYS;
2561
2562 if (genpd->status == GPD_STATE_ACTIVE)
2563 delta = ktime_sub(ktime_get(), genpd->accounting_time);
2564
2565 seq_printf(s, "%lld ms\n", ktime_to_ms(
2566 ktime_add(genpd->on_time, delta)));
2567
2568 genpd_unlock(genpd);
2569 return ret;
2570}
2571
2572static int genpd_total_idle_time_show(struct seq_file *s, void *data)
2573{
2574 struct generic_pm_domain *genpd = s->private;
2575 ktime_t delta = 0, total = 0;
2576 unsigned int i;
2577 int ret = 0;
2578
2579 ret = genpd_lock_interruptible(genpd);
2580 if (ret)
2581 return -ERESTARTSYS;
2582
2583 for (i = 0; i < genpd->state_count; i++) {
2584
2585 if ((genpd->status == GPD_STATE_POWER_OFF) &&
2586 (genpd->state_idx == i))
2587 delta = ktime_sub(ktime_get(), genpd->accounting_time);
2588
2589 total = ktime_add(total, genpd->states[i].idle_time);
2590 }
2591 total = ktime_add(total, delta);
2592
2593 seq_printf(s, "%lld ms\n", ktime_to_ms(total));
2594
2595 genpd_unlock(genpd);
2596 return ret;
2597}
2598
2599
2600static int genpd_devices_show(struct seq_file *s, void *data)
2601{
2602 struct generic_pm_domain *genpd = s->private;
2603 struct pm_domain_data *pm_data;
2604 const char *kobj_path;
2605 int ret = 0;
2606
2607 ret = genpd_lock_interruptible(genpd);
2608 if (ret)
2609 return -ERESTARTSYS;
2610
2611 list_for_each_entry(pm_data, &genpd->dev_list, list_node) {
2612 kobj_path = kobject_get_path(&pm_data->dev->kobj,
2613 genpd_is_irq_safe(genpd) ?
2614 GFP_ATOMIC : GFP_KERNEL);
2615 if (kobj_path == NULL)
2616 continue;
2617
2618 seq_printf(s, "%s\n", kobj_path);
2619 kfree(kobj_path);
2620 }
2621
2622 genpd_unlock(genpd);
2623 return ret;
2624}
2625
2626#define define_genpd_open_function(name) \
2627static int genpd_##name##_open(struct inode *inode, struct file *file) \
2628{ \
2629 return single_open(file, genpd_##name##_show, inode->i_private); \
2630}
2631
2632define_genpd_open_function(summary);
2633define_genpd_open_function(status);
2634define_genpd_open_function(sub_domains);
2635define_genpd_open_function(idle_states);
2636define_genpd_open_function(active_time);
2637define_genpd_open_function(total_idle_time);
2638define_genpd_open_function(devices);
2639
2640#define define_genpd_debugfs_fops(name) \
2641static const struct file_operations genpd_##name##_fops = { \
2642 .open = genpd_##name##_open, \
2643 .read = seq_read, \
2644 .llseek = seq_lseek, \
2645 .release = single_release, \
2646}
2647
2648define_genpd_debugfs_fops(summary);
2649define_genpd_debugfs_fops(status);
2650define_genpd_debugfs_fops(sub_domains);
2651define_genpd_debugfs_fops(idle_states);
2652define_genpd_debugfs_fops(active_time);
2653define_genpd_debugfs_fops(total_idle_time);
2654define_genpd_debugfs_fops(devices);
2bd5306a 2655
9e9704ea 2656static int __init genpd_debug_init(void)
2bd5306a
MM
2657{
2658 struct dentry *d;
b6a1d093 2659 struct generic_pm_domain *genpd;
2bd5306a 2660
9e9704ea 2661 genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);
2bd5306a 2662
9e9704ea 2663 if (!genpd_debugfs_dir)
2bd5306a
MM
2664 return -ENOMEM;
2665
2666 d = debugfs_create_file("pm_genpd_summary", S_IRUGO,
9e9704ea 2667 genpd_debugfs_dir, NULL, &genpd_summary_fops);
2bd5306a
MM
2668 if (!d)
2669 return -ENOMEM;
2670
b6a1d093 2671 list_for_each_entry(genpd, &gpd_list, gpd_list_node) {
9e9704ea 2672 d = debugfs_create_dir(genpd->name, genpd_debugfs_dir);
b6a1d093
TG
2673 if (!d)
2674 return -ENOMEM;
2675
2676 debugfs_create_file("current_state", 0444,
2677 d, genpd, &genpd_status_fops);
2678 debugfs_create_file("sub_domains", 0444,
2679 d, genpd, &genpd_sub_domains_fops);
2680 debugfs_create_file("idle_states", 0444,
2681 d, genpd, &genpd_idle_states_fops);
2682 debugfs_create_file("active_time", 0444,
2683 d, genpd, &genpd_active_time_fops);
2684 debugfs_create_file("total_idle_time", 0444,
2685 d, genpd, &genpd_total_idle_time_fops);
2686 debugfs_create_file("devices", 0444,
2687 d, genpd, &genpd_devices_fops);
2688 }
2689
2bd5306a
MM
2690 return 0;
2691}
9e9704ea 2692late_initcall(genpd_debug_init);
2bd5306a 2693
9e9704ea 2694static void __exit genpd_debug_exit(void)
2bd5306a 2695{
9e9704ea 2696 debugfs_remove_recursive(genpd_debugfs_dir);
2bd5306a 2697}
9e9704ea 2698__exitcall(genpd_debug_exit);
8b0510b5 2699#endif /* CONFIG_DEBUG_FS */