PM / Sleep: Introduce generic callbacks for new device PM phases
[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
9#include <linux/init.h>
10#include <linux/kernel.h>
11#include <linux/io.h>
12#include <linux/pm_runtime.h>
13#include <linux/pm_domain.h>
14#include <linux/slab.h>
15#include <linux/err.h>
17b75eca
RW
16#include <linux/sched.h>
17#include <linux/suspend.h>
d5e4cbfe
RW
18#include <linux/export.h>
19
20#define GENPD_DEV_CALLBACK(genpd, type, callback, dev) \
21({ \
22 type (*__routine)(struct device *__d); \
23 type __ret = (type)0; \
24 \
25 __routine = genpd->dev_ops.callback; \
26 if (__routine) { \
27 __ret = __routine(dev); \
28 } else { \
29 __routine = dev_gpd_data(dev)->ops.callback; \
30 if (__routine) \
31 __ret = __routine(dev); \
32 } \
33 __ret; \
34})
f721889f 35
0140d8bd
RW
36#define GENPD_DEV_TIMED_CALLBACK(genpd, type, callback, dev, field, name) \
37({ \
38 ktime_t __start = ktime_get(); \
39 type __retval = GENPD_DEV_CALLBACK(genpd, type, callback, dev); \
40 s64 __elapsed = ktime_to_ns(ktime_sub(ktime_get(), __start)); \
41 struct generic_pm_domain_data *__gpd_data = dev_gpd_data(dev); \
42 if (__elapsed > __gpd_data->td.field) { \
43 __gpd_data->td.field = __elapsed; \
44 dev_warn(dev, name " latency exceeded, new value %lld ns\n", \
45 __elapsed); \
46 } \
47 __retval; \
48})
49
5125bbf3
RW
50static LIST_HEAD(gpd_list);
51static DEFINE_MUTEX(gpd_list_lock);
52
5248051b
RW
53#ifdef CONFIG_PM
54
b02c999a 55struct generic_pm_domain *dev_to_genpd(struct device *dev)
5248051b
RW
56{
57 if (IS_ERR_OR_NULL(dev->pm_domain))
58 return ERR_PTR(-EINVAL);
59
596ba34b 60 return pd_to_genpd(dev->pm_domain);
5248051b 61}
f721889f 62
d5e4cbfe
RW
63static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
64{
0140d8bd
RW
65 return GENPD_DEV_TIMED_CALLBACK(genpd, int, stop, dev,
66 stop_latency_ns, "stop");
d5e4cbfe
RW
67}
68
69static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev)
70{
0140d8bd
RW
71 return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
72 start_latency_ns, "start");
d5e4cbfe
RW
73}
74
ecf00475
RW
75static int genpd_save_dev(struct generic_pm_domain *genpd, struct device *dev)
76{
0140d8bd
RW
77 return GENPD_DEV_TIMED_CALLBACK(genpd, int, save_state, dev,
78 save_state_latency_ns, "state save");
ecf00475
RW
79}
80
81static int genpd_restore_dev(struct generic_pm_domain *genpd, struct device *dev)
82{
0140d8bd
RW
83 return GENPD_DEV_TIMED_CALLBACK(genpd, int, restore_state, dev,
84 restore_state_latency_ns,
85 "state restore");
ecf00475
RW
86}
87
c4bb3160 88static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
f721889f 89{
c4bb3160
RW
90 bool ret = false;
91
92 if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
93 ret = !!atomic_dec_and_test(&genpd->sd_count);
94
95 return ret;
96}
97
98static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
99{
100 atomic_inc(&genpd->sd_count);
101 smp_mb__after_atomic_inc();
f721889f
RW
102}
103
17b75eca
RW
104static void genpd_acquire_lock(struct generic_pm_domain *genpd)
105{
106 DEFINE_WAIT(wait);
107
108 mutex_lock(&genpd->lock);
109 /*
110 * Wait for the domain to transition into either the active,
111 * or the power off state.
112 */
113 for (;;) {
114 prepare_to_wait(&genpd->status_wait_queue, &wait,
115 TASK_UNINTERRUPTIBLE);
c6d22b37
RW
116 if (genpd->status == GPD_STATE_ACTIVE
117 || genpd->status == GPD_STATE_POWER_OFF)
17b75eca
RW
118 break;
119 mutex_unlock(&genpd->lock);
120
121 schedule();
122
123 mutex_lock(&genpd->lock);
124 }
125 finish_wait(&genpd->status_wait_queue, &wait);
126}
127
128static void genpd_release_lock(struct generic_pm_domain *genpd)
129{
130 mutex_unlock(&genpd->lock);
131}
132
c6d22b37
RW
133static void genpd_set_active(struct generic_pm_domain *genpd)
134{
135 if (genpd->resume_count == 0)
136 genpd->status = GPD_STATE_ACTIVE;
137}
138
5248051b 139/**
5063ce15 140 * __pm_genpd_poweron - Restore power to a given PM domain and its masters.
5248051b
RW
141 * @genpd: PM domain to power up.
142 *
5063ce15 143 * Restore power to @genpd and all of its masters so that it is possible to
5248051b
RW
144 * resume a device belonging to it.
145 */
3f241775
RW
146int __pm_genpd_poweron(struct generic_pm_domain *genpd)
147 __releases(&genpd->lock) __acquires(&genpd->lock)
5248051b 148{
5063ce15 149 struct gpd_link *link;
3f241775 150 DEFINE_WAIT(wait);
5248051b
RW
151 int ret = 0;
152
5063ce15 153 /* If the domain's master is being waited for, we have to wait too. */
3f241775
RW
154 for (;;) {
155 prepare_to_wait(&genpd->status_wait_queue, &wait,
156 TASK_UNINTERRUPTIBLE);
17877eb5 157 if (genpd->status != GPD_STATE_WAIT_MASTER)
3f241775
RW
158 break;
159 mutex_unlock(&genpd->lock);
17b75eca 160
3f241775
RW
161 schedule();
162
163 mutex_lock(&genpd->lock);
164 }
165 finish_wait(&genpd->status_wait_queue, &wait);
9e08cf42 166
17b75eca 167 if (genpd->status == GPD_STATE_ACTIVE
596ba34b 168 || (genpd->prepared_count > 0 && genpd->suspend_power_off))
3f241775 169 return 0;
5248051b 170
c6d22b37
RW
171 if (genpd->status != GPD_STATE_POWER_OFF) {
172 genpd_set_active(genpd);
3f241775 173 return 0;
c6d22b37
RW
174 }
175
5063ce15
RW
176 /*
177 * The list is guaranteed not to change while the loop below is being
178 * executed, unless one of the masters' .power_on() callbacks fiddles
179 * with it.
180 */
181 list_for_each_entry(link, &genpd->slave_links, slave_node) {
182 genpd_sd_counter_inc(link->master);
17877eb5 183 genpd->status = GPD_STATE_WAIT_MASTER;
3c07cbc4 184
5248051b 185 mutex_unlock(&genpd->lock);
5248051b 186
5063ce15 187 ret = pm_genpd_poweron(link->master);
9e08cf42
RW
188
189 mutex_lock(&genpd->lock);
190
3f241775
RW
191 /*
192 * The "wait for parent" status is guaranteed not to change
5063ce15 193 * while the master is powering on.
3f241775
RW
194 */
195 genpd->status = GPD_STATE_POWER_OFF;
196 wake_up_all(&genpd->status_wait_queue);
5063ce15
RW
197 if (ret) {
198 genpd_sd_counter_dec(link->master);
9e08cf42 199 goto err;
5063ce15 200 }
5248051b
RW
201 }
202
9e08cf42 203 if (genpd->power_on) {
0140d8bd
RW
204 ktime_t time_start = ktime_get();
205 s64 elapsed_ns;
206
fe202fde 207 ret = genpd->power_on(genpd);
9e08cf42
RW
208 if (ret)
209 goto err;
0140d8bd
RW
210
211 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
e84b2c20 212 if (elapsed_ns > genpd->power_on_latency_ns) {
0140d8bd 213 genpd->power_on_latency_ns = elapsed_ns;
e84b2c20
RW
214 if (genpd->name)
215 pr_warning("%s: Power-on latency exceeded, "
216 "new value %lld ns\n", genpd->name,
217 elapsed_ns);
218 }
3c07cbc4 219 }
5248051b 220
9e08cf42
RW
221 genpd_set_active(genpd);
222
3f241775 223 return 0;
9e08cf42
RW
224
225 err:
5063ce15
RW
226 list_for_each_entry_continue_reverse(link, &genpd->slave_links, slave_node)
227 genpd_sd_counter_dec(link->master);
9e08cf42 228
3f241775
RW
229 return ret;
230}
231
232/**
5063ce15 233 * pm_genpd_poweron - Restore power to a given PM domain and its masters.
3f241775
RW
234 * @genpd: PM domain to power up.
235 */
236int pm_genpd_poweron(struct generic_pm_domain *genpd)
237{
238 int ret;
239
240 mutex_lock(&genpd->lock);
241 ret = __pm_genpd_poweron(genpd);
242 mutex_unlock(&genpd->lock);
243 return ret;
5248051b
RW
244}
245
246#endif /* CONFIG_PM */
247
248#ifdef CONFIG_PM_RUNTIME
249
f721889f
RW
250/**
251 * __pm_genpd_save_device - Save the pre-suspend state of a device.
4605ab65 252 * @pdd: Domain data of the device to save the state of.
f721889f
RW
253 * @genpd: PM domain the device belongs to.
254 */
4605ab65 255static int __pm_genpd_save_device(struct pm_domain_data *pdd,
f721889f 256 struct generic_pm_domain *genpd)
17b75eca 257 __releases(&genpd->lock) __acquires(&genpd->lock)
f721889f 258{
cd0ea672 259 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
4605ab65 260 struct device *dev = pdd->dev;
f721889f
RW
261 int ret = 0;
262
cd0ea672 263 if (gpd_data->need_restore)
f721889f
RW
264 return 0;
265
17b75eca
RW
266 mutex_unlock(&genpd->lock);
267
ecf00475
RW
268 genpd_start_dev(genpd, dev);
269 ret = genpd_save_dev(genpd, dev);
270 genpd_stop_dev(genpd, dev);
f721889f 271
17b75eca
RW
272 mutex_lock(&genpd->lock);
273
f721889f 274 if (!ret)
cd0ea672 275 gpd_data->need_restore = true;
f721889f
RW
276
277 return ret;
278}
279
280/**
281 * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
4605ab65 282 * @pdd: Domain data of the device to restore the state of.
f721889f
RW
283 * @genpd: PM domain the device belongs to.
284 */
4605ab65 285static void __pm_genpd_restore_device(struct pm_domain_data *pdd,
f721889f 286 struct generic_pm_domain *genpd)
17b75eca 287 __releases(&genpd->lock) __acquires(&genpd->lock)
f721889f 288{
cd0ea672 289 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
4605ab65 290 struct device *dev = pdd->dev;
f721889f 291
cd0ea672 292 if (!gpd_data->need_restore)
f721889f
RW
293 return;
294
17b75eca
RW
295 mutex_unlock(&genpd->lock);
296
ecf00475
RW
297 genpd_start_dev(genpd, dev);
298 genpd_restore_dev(genpd, dev);
299 genpd_stop_dev(genpd, dev);
f721889f 300
17b75eca
RW
301 mutex_lock(&genpd->lock);
302
cd0ea672 303 gpd_data->need_restore = false;
f721889f
RW
304}
305
c6d22b37
RW
306/**
307 * genpd_abort_poweroff - Check if a PM domain power off should be aborted.
308 * @genpd: PM domain to check.
309 *
310 * Return true if a PM domain's status changed to GPD_STATE_ACTIVE during
311 * a "power off" operation, which means that a "power on" has occured in the
312 * meantime, or if its resume_count field is different from zero, which means
313 * that one of its devices has been resumed in the meantime.
314 */
315static bool genpd_abort_poweroff(struct generic_pm_domain *genpd)
316{
17877eb5 317 return genpd->status == GPD_STATE_WAIT_MASTER
3f241775 318 || genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
c6d22b37
RW
319}
320
56375fd4
RW
321/**
322 * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
323 * @genpd: PM domait to power off.
324 *
325 * Queue up the execution of pm_genpd_poweroff() unless it's already been done
326 * before.
327 */
0bc5b2de 328void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
56375fd4
RW
329{
330 if (!work_pending(&genpd->power_off_work))
331 queue_work(pm_wq, &genpd->power_off_work);
332}
333
f721889f
RW
334/**
335 * pm_genpd_poweroff - Remove power from a given PM domain.
336 * @genpd: PM domain to power down.
337 *
338 * If all of the @genpd's devices have been suspended and all of its subdomains
339 * have been powered down, run the runtime suspend callbacks provided by all of
340 * the @genpd's devices' drivers and remove power from @genpd.
341 */
342static int pm_genpd_poweroff(struct generic_pm_domain *genpd)
17b75eca 343 __releases(&genpd->lock) __acquires(&genpd->lock)
f721889f 344{
4605ab65 345 struct pm_domain_data *pdd;
5063ce15 346 struct gpd_link *link;
f721889f 347 unsigned int not_suspended;
c6d22b37 348 int ret = 0;
f721889f 349
c6d22b37
RW
350 start:
351 /*
352 * Do not try to power off the domain in the following situations:
353 * (1) The domain is already in the "power off" state.
5063ce15 354 * (2) The domain is waiting for its master to power up.
c6d22b37 355 * (3) One of the domain's devices is being resumed right now.
3f241775 356 * (4) System suspend is in progress.
c6d22b37 357 */
3f241775 358 if (genpd->status == GPD_STATE_POWER_OFF
17877eb5 359 || genpd->status == GPD_STATE_WAIT_MASTER
3f241775 360 || genpd->resume_count > 0 || genpd->prepared_count > 0)
f721889f
RW
361 return 0;
362
c4bb3160 363 if (atomic_read(&genpd->sd_count) > 0)
f721889f
RW
364 return -EBUSY;
365
366 not_suspended = 0;
4605ab65 367 list_for_each_entry(pdd, &genpd->dev_list, list_node)
0aa2a221
RW
368 if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
369 || pdd->dev->power.irq_safe))
f721889f
RW
370 not_suspended++;
371
372 if (not_suspended > genpd->in_progress)
373 return -EBUSY;
374
c6d22b37
RW
375 if (genpd->poweroff_task) {
376 /*
377 * Another instance of pm_genpd_poweroff() is executing
378 * callbacks, so tell it to start over and return.
379 */
380 genpd->status = GPD_STATE_REPEAT;
381 return 0;
382 }
383
f721889f
RW
384 if (genpd->gov && genpd->gov->power_down_ok) {
385 if (!genpd->gov->power_down_ok(&genpd->domain))
386 return -EAGAIN;
387 }
388
17b75eca 389 genpd->status = GPD_STATE_BUSY;
c6d22b37 390 genpd->poweroff_task = current;
17b75eca 391
4605ab65 392 list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
3c07cbc4 393 ret = atomic_read(&genpd->sd_count) == 0 ?
4605ab65 394 __pm_genpd_save_device(pdd, genpd) : -EBUSY;
3f241775
RW
395
396 if (genpd_abort_poweroff(genpd))
397 goto out;
398
697a7f37
RW
399 if (ret) {
400 genpd_set_active(genpd);
401 goto out;
402 }
f721889f 403
c6d22b37
RW
404 if (genpd->status == GPD_STATE_REPEAT) {
405 genpd->poweroff_task = NULL;
406 goto start;
407 }
408 }
17b75eca 409
3c07cbc4 410 if (genpd->power_off) {
0140d8bd
RW
411 ktime_t time_start;
412 s64 elapsed_ns;
413
3c07cbc4
RW
414 if (atomic_read(&genpd->sd_count) > 0) {
415 ret = -EBUSY;
c6d22b37
RW
416 goto out;
417 }
17b75eca 418
0140d8bd
RW
419 time_start = ktime_get();
420
3c07cbc4 421 /*
5063ce15
RW
422 * If sd_count > 0 at this point, one of the subdomains hasn't
423 * managed to call pm_genpd_poweron() for the master yet after
3c07cbc4
RW
424 * incrementing it. In that case pm_genpd_poweron() will wait
425 * for us to drop the lock, so we can call .power_off() and let
426 * the pm_genpd_poweron() restore power for us (this shouldn't
427 * happen very often).
428 */
d2805402
RW
429 ret = genpd->power_off(genpd);
430 if (ret == -EBUSY) {
431 genpd_set_active(genpd);
d2805402
RW
432 goto out;
433 }
0140d8bd
RW
434
435 elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
e84b2c20 436 if (elapsed_ns > genpd->power_off_latency_ns) {
0140d8bd 437 genpd->power_off_latency_ns = elapsed_ns;
e84b2c20
RW
438 if (genpd->name)
439 pr_warning("%s: Power-off latency exceeded, "
440 "new value %lld ns\n", genpd->name,
441 elapsed_ns);
442 }
d2805402 443 }
f721889f 444
17b75eca 445 genpd->status = GPD_STATE_POWER_OFF;
221e9b58
RW
446 genpd->power_off_time = ktime_get();
447
448 /* Update PM QoS information for devices in the domain. */
449 list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
450 struct gpd_timing_data *td = &to_gpd_data(pdd)->td;
451
452 pm_runtime_update_max_time_suspended(pdd->dev,
453 td->start_latency_ns +
454 td->restore_state_latency_ns +
455 genpd->power_on_latency_ns);
456 }
f721889f 457
5063ce15
RW
458 list_for_each_entry(link, &genpd->slave_links, slave_node) {
459 genpd_sd_counter_dec(link->master);
460 genpd_queue_power_off_work(link->master);
461 }
f721889f 462
c6d22b37
RW
463 out:
464 genpd->poweroff_task = NULL;
465 wake_up_all(&genpd->status_wait_queue);
466 return ret;
f721889f
RW
467}
468
469/**
470 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
471 * @work: Work structure used for scheduling the execution of this function.
472 */
473static void genpd_power_off_work_fn(struct work_struct *work)
474{
475 struct generic_pm_domain *genpd;
476
477 genpd = container_of(work, struct generic_pm_domain, power_off_work);
478
17b75eca 479 genpd_acquire_lock(genpd);
f721889f 480 pm_genpd_poweroff(genpd);
17b75eca 481 genpd_release_lock(genpd);
f721889f
RW
482}
483
484/**
485 * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
486 * @dev: Device to suspend.
487 *
488 * Carry out a runtime suspend of a device under the assumption that its
489 * pm_domain field points to the domain member of an object of type
490 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
491 */
492static int pm_genpd_runtime_suspend(struct device *dev)
493{
494 struct generic_pm_domain *genpd;
b02c999a 495 bool (*stop_ok)(struct device *__dev);
d5e4cbfe 496 int ret;
f721889f
RW
497
498 dev_dbg(dev, "%s()\n", __func__);
499
5248051b
RW
500 genpd = dev_to_genpd(dev);
501 if (IS_ERR(genpd))
f721889f
RW
502 return -EINVAL;
503
0aa2a221
RW
504 might_sleep_if(!genpd->dev_irq_safe);
505
b02c999a
RW
506 stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
507 if (stop_ok && !stop_ok(dev))
508 return -EBUSY;
509
d5e4cbfe
RW
510 ret = genpd_stop_dev(genpd, dev);
511 if (ret)
512 return ret;
17b75eca 513
b02c999a
RW
514 pm_runtime_update_max_time_suspended(dev,
515 dev_gpd_data(dev)->td.start_latency_ns);
516
0aa2a221
RW
517 /*
518 * If power.irq_safe is set, this routine will be run with interrupts
519 * off, so it can't use mutexes.
520 */
521 if (dev->power.irq_safe)
522 return 0;
523
c6d22b37 524 mutex_lock(&genpd->lock);
f721889f
RW
525 genpd->in_progress++;
526 pm_genpd_poweroff(genpd);
527 genpd->in_progress--;
c6d22b37 528 mutex_unlock(&genpd->lock);
f721889f
RW
529
530 return 0;
531}
532
f721889f
RW
533/**
534 * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
535 * @dev: Device to resume.
536 *
537 * Carry out a runtime resume of a device under the assumption that its
538 * pm_domain field points to the domain member of an object of type
539 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
540 */
541static int pm_genpd_runtime_resume(struct device *dev)
542{
543 struct generic_pm_domain *genpd;
c6d22b37 544 DEFINE_WAIT(wait);
f721889f
RW
545 int ret;
546
547 dev_dbg(dev, "%s()\n", __func__);
548
5248051b
RW
549 genpd = dev_to_genpd(dev);
550 if (IS_ERR(genpd))
f721889f
RW
551 return -EINVAL;
552
0aa2a221
RW
553 might_sleep_if(!genpd->dev_irq_safe);
554
555 /* If power.irq_safe, the PM domain is never powered off. */
556 if (dev->power.irq_safe)
557 goto out;
558
c6d22b37 559 mutex_lock(&genpd->lock);
3f241775
RW
560 ret = __pm_genpd_poweron(genpd);
561 if (ret) {
562 mutex_unlock(&genpd->lock);
563 return ret;
564 }
17b75eca 565 genpd->status = GPD_STATE_BUSY;
c6d22b37
RW
566 genpd->resume_count++;
567 for (;;) {
568 prepare_to_wait(&genpd->status_wait_queue, &wait,
569 TASK_UNINTERRUPTIBLE);
570 /*
571 * If current is the powering off task, we have been called
572 * reentrantly from one of the device callbacks, so we should
573 * not wait.
574 */
575 if (!genpd->poweroff_task || genpd->poweroff_task == current)
576 break;
577 mutex_unlock(&genpd->lock);
578
579 schedule();
580
581 mutex_lock(&genpd->lock);
582 }
583 finish_wait(&genpd->status_wait_queue, &wait);
cd0ea672 584 __pm_genpd_restore_device(dev->power.subsys_data->domain_data, genpd);
c6d22b37
RW
585 genpd->resume_count--;
586 genpd_set_active(genpd);
17b75eca 587 wake_up_all(&genpd->status_wait_queue);
c6d22b37 588 mutex_unlock(&genpd->lock);
17b75eca 589
0aa2a221 590 out:
d5e4cbfe 591 genpd_start_dev(genpd, dev);
f721889f
RW
592
593 return 0;
594}
595
17f2ae7f
RW
596/**
597 * pm_genpd_poweroff_unused - Power off all PM domains with no devices in use.
598 */
599void pm_genpd_poweroff_unused(void)
600{
601 struct generic_pm_domain *genpd;
602
603 mutex_lock(&gpd_list_lock);
604
605 list_for_each_entry(genpd, &gpd_list, gpd_list_node)
606 genpd_queue_power_off_work(genpd);
607
608 mutex_unlock(&gpd_list_lock);
609}
610
f721889f
RW
611#else
612
613static inline void genpd_power_off_work_fn(struct work_struct *work) {}
614
615#define pm_genpd_runtime_suspend NULL
616#define pm_genpd_runtime_resume NULL
617
618#endif /* CONFIG_PM_RUNTIME */
619
596ba34b
RW
620#ifdef CONFIG_PM_SLEEP
621
d5e4cbfe
RW
622static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
623 struct device *dev)
624{
625 return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
626}
627
d23b9b00
RW
628static int genpd_suspend_dev(struct generic_pm_domain *genpd, struct device *dev)
629{
630 return GENPD_DEV_CALLBACK(genpd, int, suspend, dev);
631}
632
633static int genpd_suspend_late(struct generic_pm_domain *genpd, struct device *dev)
634{
635 return GENPD_DEV_CALLBACK(genpd, int, suspend_late, dev);
636}
637
638static int genpd_resume_early(struct generic_pm_domain *genpd, struct device *dev)
639{
640 return GENPD_DEV_CALLBACK(genpd, int, resume_early, dev);
641}
642
643static int genpd_resume_dev(struct generic_pm_domain *genpd, struct device *dev)
644{
645 return GENPD_DEV_CALLBACK(genpd, int, resume, dev);
646}
647
648static int genpd_freeze_dev(struct generic_pm_domain *genpd, struct device *dev)
649{
650 return GENPD_DEV_CALLBACK(genpd, int, freeze, dev);
651}
652
653static int genpd_freeze_late(struct generic_pm_domain *genpd, struct device *dev)
654{
655 return GENPD_DEV_CALLBACK(genpd, int, freeze_late, dev);
656}
657
658static int genpd_thaw_early(struct generic_pm_domain *genpd, struct device *dev)
659{
660 return GENPD_DEV_CALLBACK(genpd, int, thaw_early, dev);
661}
662
663static int genpd_thaw_dev(struct generic_pm_domain *genpd, struct device *dev)
664{
665 return GENPD_DEV_CALLBACK(genpd, int, thaw, dev);
666}
667
596ba34b 668/**
5063ce15 669 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
596ba34b
RW
670 * @genpd: PM domain to power off, if possible.
671 *
672 * Check if the given PM domain can be powered off (during system suspend or
5063ce15 673 * hibernation) and do that if so. Also, in that case propagate to its masters.
596ba34b
RW
674 *
675 * This function is only called in "noirq" stages of system power transitions,
676 * so it need not acquire locks (all of the "noirq" callbacks are executed
677 * sequentially, so it is guaranteed that it will never run twice in parallel).
678 */
679static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd)
680{
5063ce15 681 struct gpd_link *link;
596ba34b 682
17b75eca 683 if (genpd->status == GPD_STATE_POWER_OFF)
596ba34b
RW
684 return;
685
c4bb3160
RW
686 if (genpd->suspended_count != genpd->device_count
687 || atomic_read(&genpd->sd_count) > 0)
596ba34b
RW
688 return;
689
690 if (genpd->power_off)
691 genpd->power_off(genpd);
692
17b75eca 693 genpd->status = GPD_STATE_POWER_OFF;
5063ce15
RW
694
695 list_for_each_entry(link, &genpd->slave_links, slave_node) {
696 genpd_sd_counter_dec(link->master);
697 pm_genpd_sync_poweroff(link->master);
596ba34b
RW
698 }
699}
700
4ecd6e65
RW
701/**
702 * resume_needed - Check whether to resume a device before system suspend.
703 * @dev: Device to check.
704 * @genpd: PM domain the device belongs to.
705 *
706 * There are two cases in which a device that can wake up the system from sleep
707 * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
708 * to wake up the system and it has to remain active for this purpose while the
709 * system is in the sleep state and (2) if the device is not enabled to wake up
710 * the system from sleep states and it generally doesn't generate wakeup signals
711 * by itself (those signals are generated on its behalf by other parts of the
712 * system). In the latter case it may be necessary to reconfigure the device's
713 * wakeup settings during system suspend, because it may have been set up to
714 * signal remote wakeup from the system's working state as needed by runtime PM.
715 * Return 'true' in either of the above cases.
716 */
717static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
718{
719 bool active_wakeup;
720
721 if (!device_can_wakeup(dev))
722 return false;
723
d5e4cbfe 724 active_wakeup = genpd_dev_active_wakeup(genpd, dev);
4ecd6e65
RW
725 return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
726}
727
596ba34b
RW
728/**
729 * pm_genpd_prepare - Start power transition of a device in a PM domain.
730 * @dev: Device to start the transition of.
731 *
732 * Start a power transition of a device (during a system-wide power transition)
733 * under the assumption that its pm_domain field points to the domain member of
734 * an object of type struct generic_pm_domain representing a PM domain
735 * consisting of I/O devices.
736 */
737static int pm_genpd_prepare(struct device *dev)
738{
739 struct generic_pm_domain *genpd;
b6c10c84 740 int ret;
596ba34b
RW
741
742 dev_dbg(dev, "%s()\n", __func__);
743
744 genpd = dev_to_genpd(dev);
745 if (IS_ERR(genpd))
746 return -EINVAL;
747
17b75eca
RW
748 /*
749 * If a wakeup request is pending for the device, it should be woken up
750 * at this point and a system wakeup event should be reported if it's
751 * set up to wake up the system from sleep states.
752 */
753 pm_runtime_get_noresume(dev);
754 if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
755 pm_wakeup_event(dev, 0);
756
757 if (pm_wakeup_pending()) {
758 pm_runtime_put_sync(dev);
759 return -EBUSY;
760 }
761
4ecd6e65
RW
762 if (resume_needed(dev, genpd))
763 pm_runtime_resume(dev);
764
17b75eca 765 genpd_acquire_lock(genpd);
596ba34b
RW
766
767 if (genpd->prepared_count++ == 0)
17b75eca
RW
768 genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
769
770 genpd_release_lock(genpd);
596ba34b
RW
771
772 if (genpd->suspend_power_off) {
17b75eca 773 pm_runtime_put_noidle(dev);
596ba34b
RW
774 return 0;
775 }
776
777 /*
17b75eca
RW
778 * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
779 * so pm_genpd_poweron() will return immediately, but if the device
d5e4cbfe 780 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
17b75eca 781 * to make it operational.
596ba34b 782 */
17b75eca 783 pm_runtime_resume(dev);
596ba34b
RW
784 __pm_runtime_disable(dev, false);
785
b6c10c84
RW
786 ret = pm_generic_prepare(dev);
787 if (ret) {
788 mutex_lock(&genpd->lock);
789
790 if (--genpd->prepared_count == 0)
791 genpd->suspend_power_off = false;
792
793 mutex_unlock(&genpd->lock);
17b75eca 794 pm_runtime_enable(dev);
b6c10c84 795 }
17b75eca
RW
796
797 pm_runtime_put_sync(dev);
b6c10c84 798 return ret;
596ba34b
RW
799}
800
801/**
802 * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
803 * @dev: Device to suspend.
804 *
805 * Suspend a device under the assumption that its pm_domain field points to the
806 * domain member of an object of type struct generic_pm_domain representing
807 * a PM domain consisting of I/O devices.
808 */
809static int pm_genpd_suspend(struct device *dev)
810{
811 struct generic_pm_domain *genpd;
812
813 dev_dbg(dev, "%s()\n", __func__);
814
815 genpd = dev_to_genpd(dev);
816 if (IS_ERR(genpd))
817 return -EINVAL;
818
d23b9b00 819 return genpd->suspend_power_off ? 0 : genpd_suspend_dev(genpd, dev);
596ba34b
RW
820}
821
822/**
823 * pm_genpd_suspend_noirq - Late suspend of a device from an I/O PM domain.
824 * @dev: Device to suspend.
825 *
826 * Carry out a late suspend of a device under the assumption that its
827 * pm_domain field points to the domain member of an object of type
828 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
829 */
830static int pm_genpd_suspend_noirq(struct device *dev)
831{
832 struct generic_pm_domain *genpd;
833 int ret;
834
835 dev_dbg(dev, "%s()\n", __func__);
836
837 genpd = dev_to_genpd(dev);
838 if (IS_ERR(genpd))
839 return -EINVAL;
840
841 if (genpd->suspend_power_off)
842 return 0;
843
d23b9b00 844 ret = genpd_suspend_late(genpd, dev);
596ba34b
RW
845 if (ret)
846 return ret;
847
d5e4cbfe 848 if (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev))
d4f2d87a
RW
849 return 0;
850
d5e4cbfe 851 genpd_stop_dev(genpd, dev);
596ba34b
RW
852
853 /*
854 * Since all of the "noirq" callbacks are executed sequentially, it is
855 * guaranteed that this function will never run twice in parallel for
856 * the same PM domain, so it is not necessary to use locking here.
857 */
858 genpd->suspended_count++;
859 pm_genpd_sync_poweroff(genpd);
860
861 return 0;
862}
863
864/**
865 * pm_genpd_resume_noirq - Early resume of a device from an I/O power domain.
866 * @dev: Device to resume.
867 *
868 * Carry out an early resume of a device under the assumption that its
869 * pm_domain field points to the domain member of an object of type
870 * struct generic_pm_domain representing a power domain consisting of I/O
871 * devices.
872 */
873static int pm_genpd_resume_noirq(struct device *dev)
874{
875 struct generic_pm_domain *genpd;
876
877 dev_dbg(dev, "%s()\n", __func__);
878
879 genpd = dev_to_genpd(dev);
880 if (IS_ERR(genpd))
881 return -EINVAL;
882
883 if (genpd->suspend_power_off)
884 return 0;
885
886 /*
887 * Since all of the "noirq" callbacks are executed sequentially, it is
888 * guaranteed that this function will never run twice in parallel for
889 * the same PM domain, so it is not necessary to use locking here.
890 */
891 pm_genpd_poweron(genpd);
892 genpd->suspended_count--;
d5e4cbfe 893 genpd_start_dev(genpd, dev);
596ba34b 894
d23b9b00 895 return genpd_resume_early(genpd, dev);
596ba34b
RW
896}
897
898/**
899 * pm_genpd_resume - Resume a device belonging to an I/O power domain.
900 * @dev: Device to resume.
901 *
902 * Resume a device under the assumption that its pm_domain field points to the
903 * domain member of an object of type struct generic_pm_domain representing
904 * a power domain consisting of I/O devices.
905 */
906static int pm_genpd_resume(struct device *dev)
907{
908 struct generic_pm_domain *genpd;
909
910 dev_dbg(dev, "%s()\n", __func__);
911
912 genpd = dev_to_genpd(dev);
913 if (IS_ERR(genpd))
914 return -EINVAL;
915
d23b9b00 916 return genpd->suspend_power_off ? 0 : genpd_resume_dev(genpd, dev);
596ba34b
RW
917}
918
919/**
920 * pm_genpd_freeze - Freeze a device belonging to an I/O power domain.
921 * @dev: Device to freeze.
922 *
923 * Freeze a device under the assumption that its pm_domain field points to the
924 * domain member of an object of type struct generic_pm_domain representing
925 * a power domain consisting of I/O devices.
926 */
927static int pm_genpd_freeze(struct device *dev)
928{
929 struct generic_pm_domain *genpd;
930
931 dev_dbg(dev, "%s()\n", __func__);
932
933 genpd = dev_to_genpd(dev);
934 if (IS_ERR(genpd))
935 return -EINVAL;
936
d23b9b00 937 return genpd->suspend_power_off ? 0 : genpd_freeze_dev(genpd, dev);
596ba34b
RW
938}
939
940/**
941 * pm_genpd_freeze_noirq - Late freeze of a device from an I/O power domain.
942 * @dev: Device to freeze.
943 *
944 * Carry out a late freeze of a device under the assumption that its
945 * pm_domain field points to the domain member of an object of type
946 * struct generic_pm_domain representing a power domain consisting of I/O
947 * devices.
948 */
949static int pm_genpd_freeze_noirq(struct device *dev)
950{
951 struct generic_pm_domain *genpd;
952 int ret;
953
954 dev_dbg(dev, "%s()\n", __func__);
955
956 genpd = dev_to_genpd(dev);
957 if (IS_ERR(genpd))
958 return -EINVAL;
959
960 if (genpd->suspend_power_off)
961 return 0;
962
d23b9b00 963 ret = genpd_freeze_late(genpd, dev);
596ba34b
RW
964 if (ret)
965 return ret;
966
d5e4cbfe 967 genpd_stop_dev(genpd, dev);
596ba34b
RW
968
969 return 0;
970}
971
972/**
973 * pm_genpd_thaw_noirq - Early thaw of a device from an I/O power domain.
974 * @dev: Device to thaw.
975 *
976 * Carry out an early thaw of a device under the assumption that its
977 * pm_domain field points to the domain member of an object of type
978 * struct generic_pm_domain representing a power domain consisting of I/O
979 * devices.
980 */
981static int pm_genpd_thaw_noirq(struct device *dev)
982{
983 struct generic_pm_domain *genpd;
984
985 dev_dbg(dev, "%s()\n", __func__);
986
987 genpd = dev_to_genpd(dev);
988 if (IS_ERR(genpd))
989 return -EINVAL;
990
991 if (genpd->suspend_power_off)
992 return 0;
993
d5e4cbfe 994 genpd_start_dev(genpd, dev);
596ba34b 995
d23b9b00 996 return genpd_thaw_early(genpd, dev);
596ba34b
RW
997}
998
999/**
1000 * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
1001 * @dev: Device to thaw.
1002 *
1003 * Thaw a device under the assumption that its pm_domain field points to the
1004 * domain member of an object of type struct generic_pm_domain representing
1005 * a power domain consisting of I/O devices.
1006 */
1007static int pm_genpd_thaw(struct device *dev)
1008{
1009 struct generic_pm_domain *genpd;
1010
1011 dev_dbg(dev, "%s()\n", __func__);
1012
1013 genpd = dev_to_genpd(dev);
1014 if (IS_ERR(genpd))
1015 return -EINVAL;
1016
d23b9b00 1017 return genpd->suspend_power_off ? 0 : genpd_thaw_dev(genpd, dev);
596ba34b
RW
1018}
1019
1020/**
1021 * pm_genpd_restore_noirq - Early restore of a device from an I/O power domain.
1022 * @dev: Device to resume.
1023 *
1024 * Carry out an early restore of a device under the assumption that its
1025 * pm_domain field points to the domain member of an object of type
1026 * struct generic_pm_domain representing a power domain consisting of I/O
1027 * devices.
1028 */
1029static int pm_genpd_restore_noirq(struct device *dev)
1030{
1031 struct generic_pm_domain *genpd;
1032
1033 dev_dbg(dev, "%s()\n", __func__);
1034
1035 genpd = dev_to_genpd(dev);
1036 if (IS_ERR(genpd))
1037 return -EINVAL;
1038
1039 /*
1040 * Since all of the "noirq" callbacks are executed sequentially, it is
1041 * guaranteed that this function will never run twice in parallel for
1042 * the same PM domain, so it is not necessary to use locking here.
1043 */
17b75eca 1044 genpd->status = GPD_STATE_POWER_OFF;
596ba34b
RW
1045 if (genpd->suspend_power_off) {
1046 /*
1047 * The boot kernel might put the domain into the power on state,
1048 * so make sure it really is powered off.
1049 */
1050 if (genpd->power_off)
1051 genpd->power_off(genpd);
1052 return 0;
1053 }
1054
1055 pm_genpd_poweron(genpd);
1056 genpd->suspended_count--;
d5e4cbfe 1057 genpd_start_dev(genpd, dev);
596ba34b 1058
d23b9b00 1059 return genpd_resume_early(genpd, dev);
596ba34b
RW
1060}
1061
1062/**
1063 * pm_genpd_complete - Complete power transition of a device in a power domain.
1064 * @dev: Device to complete the transition of.
1065 *
1066 * Complete a power transition of a device (during a system-wide power
1067 * transition) under the assumption that its pm_domain field points to the
1068 * domain member of an object of type struct generic_pm_domain representing
1069 * a power domain consisting of I/O devices.
1070 */
1071static void pm_genpd_complete(struct device *dev)
1072{
1073 struct generic_pm_domain *genpd;
1074 bool run_complete;
1075
1076 dev_dbg(dev, "%s()\n", __func__);
1077
1078 genpd = dev_to_genpd(dev);
1079 if (IS_ERR(genpd))
1080 return;
1081
1082 mutex_lock(&genpd->lock);
1083
1084 run_complete = !genpd->suspend_power_off;
1085 if (--genpd->prepared_count == 0)
1086 genpd->suspend_power_off = false;
1087
1088 mutex_unlock(&genpd->lock);
1089
1090 if (run_complete) {
1091 pm_generic_complete(dev);
6f00ff78 1092 pm_runtime_set_active(dev);
596ba34b 1093 pm_runtime_enable(dev);
6f00ff78 1094 pm_runtime_idle(dev);
596ba34b
RW
1095 }
1096}
1097
1098#else
1099
1100#define pm_genpd_prepare NULL
1101#define pm_genpd_suspend NULL
1102#define pm_genpd_suspend_noirq NULL
1103#define pm_genpd_resume_noirq NULL
1104#define pm_genpd_resume NULL
1105#define pm_genpd_freeze NULL
1106#define pm_genpd_freeze_noirq NULL
1107#define pm_genpd_thaw_noirq NULL
1108#define pm_genpd_thaw NULL
596ba34b 1109#define pm_genpd_restore_noirq NULL
596ba34b
RW
1110#define pm_genpd_complete NULL
1111
1112#endif /* CONFIG_PM_SLEEP */
1113
f721889f 1114/**
b02c999a 1115 * __pm_genpd_add_device - Add a device to an I/O PM domain.
f721889f
RW
1116 * @genpd: PM domain to add the device to.
1117 * @dev: Device to be added.
b02c999a 1118 * @td: Set of PM QoS timing parameters to attach to the device.
f721889f 1119 */
b02c999a
RW
1120int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
1121 struct gpd_timing_data *td)
f721889f 1122{
cd0ea672 1123 struct generic_pm_domain_data *gpd_data;
4605ab65 1124 struct pm_domain_data *pdd;
f721889f
RW
1125 int ret = 0;
1126
1127 dev_dbg(dev, "%s()\n", __func__);
1128
1129 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1130 return -EINVAL;
1131
17b75eca 1132 genpd_acquire_lock(genpd);
f721889f 1133
17b75eca 1134 if (genpd->status == GPD_STATE_POWER_OFF) {
f721889f
RW
1135 ret = -EINVAL;
1136 goto out;
1137 }
1138
596ba34b
RW
1139 if (genpd->prepared_count > 0) {
1140 ret = -EAGAIN;
1141 goto out;
1142 }
1143
4605ab65
RW
1144 list_for_each_entry(pdd, &genpd->dev_list, list_node)
1145 if (pdd->dev == dev) {
f721889f
RW
1146 ret = -EINVAL;
1147 goto out;
1148 }
1149
cd0ea672
RW
1150 gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
1151 if (!gpd_data) {
1152 ret = -ENOMEM;
1153 goto out;
1154 }
1155
596ba34b 1156 genpd->device_count++;
f721889f 1157
f721889f 1158 dev->pm_domain = &genpd->domain;
4605ab65 1159 dev_pm_get_subsys_data(dev);
cd0ea672
RW
1160 dev->power.subsys_data->domain_data = &gpd_data->base;
1161 gpd_data->base.dev = dev;
1162 gpd_data->need_restore = false;
1163 list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
b02c999a
RW
1164 if (td)
1165 gpd_data->td = *td;
f721889f
RW
1166
1167 out:
17b75eca 1168 genpd_release_lock(genpd);
f721889f
RW
1169
1170 return ret;
1171}
1172
1173/**
1174 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
1175 * @genpd: PM domain to remove the device from.
1176 * @dev: Device to be removed.
1177 */
1178int pm_genpd_remove_device(struct generic_pm_domain *genpd,
1179 struct device *dev)
1180{
4605ab65 1181 struct pm_domain_data *pdd;
f721889f
RW
1182 int ret = -EINVAL;
1183
1184 dev_dbg(dev, "%s()\n", __func__);
1185
1186 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
1187 return -EINVAL;
1188
17b75eca 1189 genpd_acquire_lock(genpd);
f721889f 1190
596ba34b
RW
1191 if (genpd->prepared_count > 0) {
1192 ret = -EAGAIN;
1193 goto out;
1194 }
1195
4605ab65
RW
1196 list_for_each_entry(pdd, &genpd->dev_list, list_node) {
1197 if (pdd->dev != dev)
f721889f
RW
1198 continue;
1199
4605ab65
RW
1200 list_del_init(&pdd->list_node);
1201 pdd->dev = NULL;
1202 dev_pm_put_subsys_data(dev);
f721889f 1203 dev->pm_domain = NULL;
cd0ea672 1204 kfree(to_gpd_data(pdd));
f721889f 1205
596ba34b 1206 genpd->device_count--;
f721889f
RW
1207
1208 ret = 0;
1209 break;
1210 }
1211
596ba34b 1212 out:
17b75eca 1213 genpd_release_lock(genpd);
f721889f
RW
1214
1215 return ret;
1216}
1217
1218/**
1219 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
1220 * @genpd: Master PM domain to add the subdomain to.
bc0403ff 1221 * @subdomain: Subdomain to be added.
f721889f
RW
1222 */
1223int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
bc0403ff 1224 struct generic_pm_domain *subdomain)
f721889f 1225{
5063ce15 1226 struct gpd_link *link;
f721889f
RW
1227 int ret = 0;
1228
bc0403ff 1229 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
f721889f
RW
1230 return -EINVAL;
1231
17b75eca
RW
1232 start:
1233 genpd_acquire_lock(genpd);
bc0403ff 1234 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
f721889f 1235
bc0403ff
RW
1236 if (subdomain->status != GPD_STATE_POWER_OFF
1237 && subdomain->status != GPD_STATE_ACTIVE) {
1238 mutex_unlock(&subdomain->lock);
17b75eca
RW
1239 genpd_release_lock(genpd);
1240 goto start;
1241 }
1242
1243 if (genpd->status == GPD_STATE_POWER_OFF
bc0403ff 1244 && subdomain->status != GPD_STATE_POWER_OFF) {
f721889f
RW
1245 ret = -EINVAL;
1246 goto out;
1247 }
1248
5063ce15 1249 list_for_each_entry(link, &genpd->slave_links, slave_node) {
bc0403ff 1250 if (link->slave == subdomain && link->master == genpd) {
f721889f
RW
1251 ret = -EINVAL;
1252 goto out;
1253 }
1254 }
1255
5063ce15
RW
1256 link = kzalloc(sizeof(*link), GFP_KERNEL);
1257 if (!link) {
1258 ret = -ENOMEM;
1259 goto out;
1260 }
1261 link->master = genpd;
1262 list_add_tail(&link->master_node, &genpd->master_links);
bc0403ff
RW
1263 link->slave = subdomain;
1264 list_add_tail(&link->slave_node, &subdomain->slave_links);
1265 if (subdomain->status != GPD_STATE_POWER_OFF)
c4bb3160 1266 genpd_sd_counter_inc(genpd);
f721889f 1267
f721889f 1268 out:
bc0403ff 1269 mutex_unlock(&subdomain->lock);
17b75eca 1270 genpd_release_lock(genpd);
f721889f
RW
1271
1272 return ret;
1273}
1274
1275/**
1276 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
1277 * @genpd: Master PM domain to remove the subdomain from.
5063ce15 1278 * @subdomain: Subdomain to be removed.
f721889f
RW
1279 */
1280int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
5063ce15 1281 struct generic_pm_domain *subdomain)
f721889f 1282{
5063ce15 1283 struct gpd_link *link;
f721889f
RW
1284 int ret = -EINVAL;
1285
5063ce15 1286 if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
f721889f
RW
1287 return -EINVAL;
1288
17b75eca
RW
1289 start:
1290 genpd_acquire_lock(genpd);
f721889f 1291
5063ce15
RW
1292 list_for_each_entry(link, &genpd->master_links, master_node) {
1293 if (link->slave != subdomain)
f721889f
RW
1294 continue;
1295
1296 mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1297
17b75eca
RW
1298 if (subdomain->status != GPD_STATE_POWER_OFF
1299 && subdomain->status != GPD_STATE_ACTIVE) {
1300 mutex_unlock(&subdomain->lock);
1301 genpd_release_lock(genpd);
1302 goto start;
1303 }
1304
5063ce15
RW
1305 list_del(&link->master_node);
1306 list_del(&link->slave_node);
1307 kfree(link);
17b75eca 1308 if (subdomain->status != GPD_STATE_POWER_OFF)
f721889f
RW
1309 genpd_sd_counter_dec(genpd);
1310
1311 mutex_unlock(&subdomain->lock);
1312
1313 ret = 0;
1314 break;
1315 }
1316
17b75eca 1317 genpd_release_lock(genpd);
f721889f
RW
1318
1319 return ret;
1320}
1321
d5e4cbfe
RW
1322/**
1323 * pm_genpd_add_callbacks - Add PM domain callbacks to a given device.
1324 * @dev: Device to add the callbacks to.
1325 * @ops: Set of callbacks to add.
b02c999a 1326 * @td: Timing data to add to the device along with the callbacks (optional).
d5e4cbfe 1327 */
b02c999a
RW
1328int pm_genpd_add_callbacks(struct device *dev, struct gpd_dev_ops *ops,
1329 struct gpd_timing_data *td)
d5e4cbfe
RW
1330{
1331 struct pm_domain_data *pdd;
1332 int ret = 0;
1333
1334 if (!(dev && dev->power.subsys_data && ops))
1335 return -EINVAL;
1336
1337 pm_runtime_disable(dev);
1338 device_pm_lock();
1339
1340 pdd = dev->power.subsys_data->domain_data;
1341 if (pdd) {
1342 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
1343
1344 gpd_data->ops = *ops;
b02c999a
RW
1345 if (td)
1346 gpd_data->td = *td;
d5e4cbfe
RW
1347 } else {
1348 ret = -EINVAL;
1349 }
1350
1351 device_pm_unlock();
1352 pm_runtime_enable(dev);
1353
1354 return ret;
1355}
1356EXPORT_SYMBOL_GPL(pm_genpd_add_callbacks);
1357
1358/**
b02c999a 1359 * __pm_genpd_remove_callbacks - Remove PM domain callbacks from a given device.
d5e4cbfe 1360 * @dev: Device to remove the callbacks from.
b02c999a 1361 * @clear_td: If set, clear the device's timing data too.
d5e4cbfe 1362 */
b02c999a 1363int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
d5e4cbfe
RW
1364{
1365 struct pm_domain_data *pdd;
1366 int ret = 0;
1367
1368 if (!(dev && dev->power.subsys_data))
1369 return -EINVAL;
1370
1371 pm_runtime_disable(dev);
1372 device_pm_lock();
1373
1374 pdd = dev->power.subsys_data->domain_data;
1375 if (pdd) {
1376 struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
1377
1378 gpd_data->ops = (struct gpd_dev_ops){ 0 };
b02c999a
RW
1379 if (clear_td)
1380 gpd_data->td = (struct gpd_timing_data){ 0 };
d5e4cbfe
RW
1381 } else {
1382 ret = -EINVAL;
1383 }
1384
1385 device_pm_unlock();
1386 pm_runtime_enable(dev);
1387
1388 return ret;
1389}
b02c999a 1390EXPORT_SYMBOL_GPL(__pm_genpd_remove_callbacks);
d5e4cbfe 1391
d23b9b00
RW
1392/* Default device callbacks for generic PM domains. */
1393
ecf00475
RW
1394/**
1395 * pm_genpd_default_save_state - Default "save device state" for PM domians.
1396 * @dev: Device to handle.
1397 */
1398static int pm_genpd_default_save_state(struct device *dev)
1399{
1400 int (*cb)(struct device *__dev);
1401 struct device_driver *drv = dev->driver;
1402
1403 cb = dev_gpd_data(dev)->ops.save_state;
1404 if (cb)
1405 return cb(dev);
1406
1407 if (drv && drv->pm && drv->pm->runtime_suspend)
1408 return drv->pm->runtime_suspend(dev);
1409
1410 return 0;
1411}
1412
1413/**
1414 * pm_genpd_default_restore_state - Default PM domians "restore device state".
1415 * @dev: Device to handle.
1416 */
1417static int pm_genpd_default_restore_state(struct device *dev)
1418{
1419 int (*cb)(struct device *__dev);
1420 struct device_driver *drv = dev->driver;
1421
1422 cb = dev_gpd_data(dev)->ops.restore_state;
1423 if (cb)
1424 return cb(dev);
1425
1426 if (drv && drv->pm && drv->pm->runtime_resume)
1427 return drv->pm->runtime_resume(dev);
1428
1429 return 0;
1430}
1431
0f1d6986
RW
1432#ifdef CONFIG_PM_SLEEP
1433
d23b9b00
RW
1434/**
1435 * pm_genpd_default_suspend - Default "device suspend" for PM domians.
1436 * @dev: Device to handle.
1437 */
1438static int pm_genpd_default_suspend(struct device *dev)
1439{
c9914854 1440 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend;
d23b9b00
RW
1441
1442 return cb ? cb(dev) : pm_generic_suspend(dev);
1443}
1444
1445/**
1446 * pm_genpd_default_suspend_late - Default "late device suspend" for PM domians.
1447 * @dev: Device to handle.
1448 */
1449static int pm_genpd_default_suspend_late(struct device *dev)
1450{
c9914854 1451 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend_late;
d23b9b00
RW
1452
1453 return cb ? cb(dev) : pm_generic_suspend_noirq(dev);
1454}
1455
1456/**
1457 * pm_genpd_default_resume_early - Default "early device resume" for PM domians.
1458 * @dev: Device to handle.
1459 */
1460static int pm_genpd_default_resume_early(struct device *dev)
1461{
c9914854 1462 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume_early;
d23b9b00
RW
1463
1464 return cb ? cb(dev) : pm_generic_resume_noirq(dev);
1465}
1466
1467/**
1468 * pm_genpd_default_resume - Default "device resume" for PM domians.
1469 * @dev: Device to handle.
1470 */
1471static int pm_genpd_default_resume(struct device *dev)
1472{
c9914854 1473 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume;
d23b9b00
RW
1474
1475 return cb ? cb(dev) : pm_generic_resume(dev);
1476}
1477
1478/**
1479 * pm_genpd_default_freeze - Default "device freeze" for PM domians.
1480 * @dev: Device to handle.
1481 */
1482static int pm_genpd_default_freeze(struct device *dev)
1483{
1484 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.freeze;
1485
1486 return cb ? cb(dev) : pm_generic_freeze(dev);
1487}
1488
1489/**
1490 * pm_genpd_default_freeze_late - Default "late device freeze" for PM domians.
1491 * @dev: Device to handle.
1492 */
1493static int pm_genpd_default_freeze_late(struct device *dev)
1494{
1495 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.freeze_late;
1496
1497 return cb ? cb(dev) : pm_generic_freeze_noirq(dev);
1498}
1499
1500/**
1501 * pm_genpd_default_thaw_early - Default "early device thaw" for PM domians.
1502 * @dev: Device to handle.
1503 */
1504static int pm_genpd_default_thaw_early(struct device *dev)
1505{
1506 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.thaw_early;
1507
1508 return cb ? cb(dev) : pm_generic_thaw_noirq(dev);
1509}
1510
1511/**
1512 * pm_genpd_default_thaw - Default "device thaw" for PM domians.
1513 * @dev: Device to handle.
1514 */
1515static int pm_genpd_default_thaw(struct device *dev)
1516{
1517 int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.thaw;
1518
1519 return cb ? cb(dev) : pm_generic_thaw(dev);
1520}
1521
0f1d6986
RW
1522#else /* !CONFIG_PM_SLEEP */
1523
1524#define pm_genpd_default_suspend NULL
1525#define pm_genpd_default_suspend_late NULL
1526#define pm_genpd_default_resume_early NULL
1527#define pm_genpd_default_resume NULL
1528#define pm_genpd_default_freeze NULL
1529#define pm_genpd_default_freeze_late NULL
1530#define pm_genpd_default_thaw_early NULL
1531#define pm_genpd_default_thaw NULL
1532
1533#endif /* !CONFIG_PM_SLEEP */
1534
f721889f
RW
1535/**
1536 * pm_genpd_init - Initialize a generic I/O PM domain object.
1537 * @genpd: PM domain object to initialize.
1538 * @gov: PM domain governor to associate with the domain (may be NULL).
1539 * @is_off: Initial value of the domain's power_is_off field.
1540 */
1541void pm_genpd_init(struct generic_pm_domain *genpd,
1542 struct dev_power_governor *gov, bool is_off)
1543{
1544 if (IS_ERR_OR_NULL(genpd))
1545 return;
1546
5063ce15
RW
1547 INIT_LIST_HEAD(&genpd->master_links);
1548 INIT_LIST_HEAD(&genpd->slave_links);
f721889f 1549 INIT_LIST_HEAD(&genpd->dev_list);
f721889f
RW
1550 mutex_init(&genpd->lock);
1551 genpd->gov = gov;
1552 INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
1553 genpd->in_progress = 0;
c4bb3160 1554 atomic_set(&genpd->sd_count, 0);
17b75eca
RW
1555 genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
1556 init_waitqueue_head(&genpd->status_wait_queue);
c6d22b37
RW
1557 genpd->poweroff_task = NULL;
1558 genpd->resume_count = 0;
596ba34b
RW
1559 genpd->device_count = 0;
1560 genpd->suspended_count = 0;
221e9b58 1561 genpd->max_off_time_ns = -1;
f721889f
RW
1562 genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
1563 genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
1564 genpd->domain.ops.runtime_idle = pm_generic_runtime_idle;
596ba34b
RW
1565 genpd->domain.ops.prepare = pm_genpd_prepare;
1566 genpd->domain.ops.suspend = pm_genpd_suspend;
1567 genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
1568 genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1569 genpd->domain.ops.resume = pm_genpd_resume;
1570 genpd->domain.ops.freeze = pm_genpd_freeze;
1571 genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
1572 genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1573 genpd->domain.ops.thaw = pm_genpd_thaw;
d23b9b00
RW
1574 genpd->domain.ops.poweroff = pm_genpd_suspend;
1575 genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
596ba34b 1576 genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
d23b9b00 1577 genpd->domain.ops.restore = pm_genpd_resume;
596ba34b 1578 genpd->domain.ops.complete = pm_genpd_complete;
ecf00475
RW
1579 genpd->dev_ops.save_state = pm_genpd_default_save_state;
1580 genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
c9914854
RW
1581 genpd->dev_ops.suspend = pm_genpd_default_suspend;
1582 genpd->dev_ops.suspend_late = pm_genpd_default_suspend_late;
1583 genpd->dev_ops.resume_early = pm_genpd_default_resume_early;
1584 genpd->dev_ops.resume = pm_genpd_default_resume;
d23b9b00
RW
1585 genpd->dev_ops.freeze = pm_genpd_default_freeze;
1586 genpd->dev_ops.freeze_late = pm_genpd_default_freeze_late;
1587 genpd->dev_ops.thaw_early = pm_genpd_default_thaw_early;
1588 genpd->dev_ops.thaw = pm_genpd_default_thaw;
5125bbf3
RW
1589 mutex_lock(&gpd_list_lock);
1590 list_add(&genpd->gpd_list_node, &gpd_list);
1591 mutex_unlock(&gpd_list_lock);
1592}