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