[deliverable/linux.git] / include / linux / pm_runtime.h

/*
 * pm_runtime.h - Device run-time power management helper functions.
 *
 * Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
 *
 * This file is released under the GPLv2.
 */

#ifndef _LINUX_PM_RUNTIME_H
#define _LINUX_PM_RUNTIME_H

#include <linux/device.h>
#include <linux/notifier.h>
#include <linux/pm.h>

#include <linux/jiffies.h>

/* Runtime PM flag argument bits */
#define RPM_ASYNC		0x01	/* Request is asynchronous */
#define RPM_NOWAIT		0x02	/* Don't wait for concurrent
					    state change */
#define RPM_GET_PUT		0x04	/* Increment/decrement the
					    usage_count */
#define RPM_AUTO		0x08	/* Use autosuspend_delay */

#ifdef CONFIG_PM
extern int pm_generic_runtime_suspend(struct device *dev);
extern int pm_generic_runtime_resume(struct device *dev);
#else
static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
#endif

#ifdef CONFIG_PM_RUNTIME

extern struct workqueue_struct *pm_wq;

extern int __pm_runtime_idle(struct device *dev, int rpmflags);
extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
extern int __pm_runtime_resume(struct device *dev, int rpmflags);
extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
extern int pm_runtime_barrier(struct device *dev);
extern void pm_runtime_enable(struct device *dev);
extern void __pm_runtime_disable(struct device *dev, bool check_resume);
extern void pm_runtime_allow(struct device *dev);
extern void pm_runtime_forbid(struct device *dev);
extern void pm_runtime_no_callbacks(struct device *dev);
extern void pm_runtime_irq_safe(struct device *dev);
extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
extern void pm_runtime_update_max_time_suspended(struct device *dev,
						 s64 delta_ns);
extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);

static inline bool pm_children_suspended(struct device *dev)
{
	return dev->power.ignore_children
		|| !atomic_read(&dev->power.child_count);
}

static inline void pm_runtime_get_noresume(struct device *dev)
{
	atomic_inc(&dev->power.usage_count);
}

static inline void pm_runtime_put_noidle(struct device *dev)
{
	atomic_add_unless(&dev->power.usage_count, -1, 0);
}

static inline bool device_run_wake(struct device *dev)
{
	return dev->power.run_wake;
}

static inline void device_set_run_wake(struct device *dev, bool enable)
{
	dev->power.run_wake = enable;
}

static inline bool pm_runtime_suspended(struct device *dev)
{
	return dev->power.runtime_status == RPM_SUSPENDED
		&& !dev->power.disable_depth;
}

static inline bool pm_runtime_active(struct device *dev)
{
	return dev->power.runtime_status == RPM_ACTIVE
		|| dev->power.disable_depth;
}

static inline bool pm_runtime_status_suspended(struct device *dev)
{
	return dev->power.runtime_status == RPM_SUSPENDED;
}

static inline bool pm_runtime_enabled(struct device *dev)
{
	return !dev->power.disable_depth;
}

static inline bool pm_runtime_callbacks_present(struct device *dev)
{
	return !dev->power.no_callbacks;
}

static inline void pm_runtime_mark_last_busy(struct device *dev)
{
	ACCESS_ONCE(dev->power.last_busy) = jiffies;
}

#else /* !CONFIG_PM_RUNTIME */

static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
{
	return -ENOSYS;
}
static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
{
	return -ENOSYS;
}
static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
{
	return 1;
}
static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
{
	return -ENOSYS;
}
static inline int __pm_runtime_set_status(struct device *dev,
					    unsigned int status) { return 0; }
static inline int pm_runtime_barrier(struct device *dev) { return 0; }
static inline void pm_runtime_enable(struct device *dev) {}
static inline void __pm_runtime_disable(struct device *dev, bool c) {}
static inline void pm_runtime_allow(struct device *dev) {}
static inline void pm_runtime_forbid(struct device *dev) {}

static inline bool pm_children_suspended(struct device *dev) { return false; }
static inline void pm_runtime_get_noresume(struct device *dev) {}
static inline void pm_runtime_put_noidle(struct device *dev) {}
static inline bool device_run_wake(struct device *dev) { return false; }
static inline void device_set_run_wake(struct device *dev, bool enable) {}
static inline bool pm_runtime_suspended(struct device *dev) { return false; }
static inline bool pm_runtime_active(struct device *dev) { return true; }
static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
static inline bool pm_runtime_enabled(struct device *dev) { return false; }

static inline void pm_runtime_no_callbacks(struct device *dev) {}
static inline void pm_runtime_irq_safe(struct device *dev) {}

static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
static inline void pm_runtime_mark_last_busy(struct device *dev) {}
static inline void __pm_runtime_use_autosuspend(struct device *dev,
						bool use) {}
static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
						int delay) {}
static inline unsigned long pm_runtime_autosuspend_expiration(
				struct device *dev) { return 0; }
static inline void pm_runtime_set_memalloc_noio(struct device *dev,
						bool enable){}

#endif /* !CONFIG_PM_RUNTIME */

static inline int pm_runtime_idle(struct device *dev)
{
	return __pm_runtime_idle(dev, 0);
}

static inline int pm_runtime_suspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, 0);
}

static inline int pm_runtime_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_AUTO);
}

static inline int pm_runtime_resume(struct device *dev)
{
	return __pm_runtime_resume(dev, 0);
}

static inline int pm_request_idle(struct device *dev)
{
	return __pm_runtime_idle(dev, RPM_ASYNC);
}

static inline int pm_request_resume(struct device *dev)
{
	return __pm_runtime_resume(dev, RPM_ASYNC);
}

static inline int pm_request_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
}

static inline int pm_runtime_get(struct device *dev)
{
	return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
}

static inline int pm_runtime_get_sync(struct device *dev)
{
	return __pm_runtime_resume(dev, RPM_GET_PUT);
}

static inline int pm_runtime_put(struct device *dev)
{
	return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
}

static inline int pm_runtime_put_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev,
	    RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
}

static inline int pm_runtime_put_sync(struct device *dev)
{
	return __pm_runtime_idle(dev, RPM_GET_PUT);
}

static inline int pm_runtime_put_sync_suspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_GET_PUT);
}

static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
}

static inline int pm_runtime_set_active(struct device *dev)
{
	return __pm_runtime_set_status(dev, RPM_ACTIVE);
}

static inline void pm_runtime_set_suspended(struct device *dev)
{
	__pm_runtime_set_status(dev, RPM_SUSPENDED);
}

static inline void pm_runtime_disable(struct device *dev)
{
	__pm_runtime_disable(dev, true);
}

static inline void pm_runtime_use_autosuspend(struct device *dev)
{
	__pm_runtime_use_autosuspend(dev, true);
}

static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
{
	__pm_runtime_use_autosuspend(dev, false);
}

#endif
Commit	Line	Data
5e928f77 RW	1	/*
	2	* pm_runtime.h - Device run-time power management helper functions.
	3	*
	4	* Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
	5	*
	6	* This file is released under the GPLv2.
	7	*/
	8
	9	#ifndef _LINUX_PM_RUNTIME_H
	10	#define _LINUX_PM_RUNTIME_H
	11
	12	#include <linux/device.h>
246359d3	13	#include <linux/notifier.h>
5e928f77 RW	14	#include <linux/pm.h>
5e928f77 RW	15
15bcb91d AS	16	#include <linux/jiffies.h>
15bcb91d AS	17
3f9af051 AS	18	/* Runtime PM flag argument bits */
	19	#define RPM_ASYNC 0x01 /* Request is asynchronous */
	20	#define RPM_NOWAIT 0x02 /* Don't wait for concurrent
	21	state change */
140a6c94 AS	22	#define RPM_GET_PUT 0x04 /* Increment/decrement the
140a6c94 AS	23	usage_count */
15bcb91d	24	#define RPM_AUTO 0x08 /* Use autosuspend_delay */
3f9af051	25
717e5d45 UH	26	#ifdef CONFIG_PM
	27	extern int pm_generic_runtime_suspend(struct device *dev);
	28	extern int pm_generic_runtime_resume(struct device *dev);
	29	#else
	30	static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
	31	static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
	32	#endif
	33
5e928f77 RW	34	#ifdef CONFIG_PM_RUNTIME
	35
	36	extern struct workqueue_struct *pm_wq;
	37
140a6c94 AS	38	extern int __pm_runtime_idle(struct device *dev, int rpmflags);
	39	extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
	40	extern int __pm_runtime_resume(struct device *dev, int rpmflags);
5e928f77	41	extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
5e928f77 RW	42	extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
	43	extern int pm_runtime_barrier(struct device *dev);
	44	extern void pm_runtime_enable(struct device *dev);
	45	extern void __pm_runtime_disable(struct device *dev, bool check_resume);
53823639 RW	46	extern void pm_runtime_allow(struct device *dev);
53823639 RW	47	extern void pm_runtime_forbid(struct device *dev);
7490e442	48	extern void pm_runtime_no_callbacks(struct device *dev);
c7b61de5	49	extern void pm_runtime_irq_safe(struct device *dev);
15bcb91d AS	50	extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
	51	extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
	52	extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
00dc9ad1 RW	53	extern void pm_runtime_update_max_time_suspended(struct device *dev,
00dc9ad1 RW	54	s64 delta_ns);
e823407f	55	extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
5e928f77 RW	56
	57	static inline bool pm_children_suspended(struct device *dev)
	58	{
	59	return dev->power.ignore_children
	60	\|\| !atomic_read(&dev->power.child_count);
	61	}
	62
5e928f77 RW	63	static inline void pm_runtime_get_noresume(struct device *dev)
	64	{
	65	atomic_inc(&dev->power.usage_count);
	66	}
	67
	68	static inline void pm_runtime_put_noidle(struct device *dev)
	69	{
	70	atomic_add_unless(&dev->power.usage_count, -1, 0);
	71	}
	72
7a1a8eb5 RW	73	static inline bool device_run_wake(struct device *dev)
	74	{
	75	return dev->power.run_wake;
	76	}
	77
	78	static inline void device_set_run_wake(struct device *dev, bool enable)
	79	{
	80	dev->power.run_wake = enable;
	81	}
	82
d690b2cd RW	83	static inline bool pm_runtime_suspended(struct device *dev)
d690b2cd RW	84	{
f08f5a0a RW	85	return dev->power.runtime_status == RPM_SUSPENDED
f08f5a0a RW	86	&& !dev->power.disable_depth;
d690b2cd RW	87	}
d690b2cd RW	88
fbadc58d SL	89	static inline bool pm_runtime_active(struct device *dev)
	90	{
	91	return dev->power.runtime_status == RPM_ACTIVE
	92	\|\| dev->power.disable_depth;
	93	}
	94
f3393b62 KH	95	static inline bool pm_runtime_status_suspended(struct device *dev)
	96	{
	97	return dev->power.runtime_status == RPM_SUSPENDED;
	98	}
	99
4b31db8a RW	100	static inline bool pm_runtime_enabled(struct device *dev)
	101	{
	102	return !dev->power.disable_depth;
	103	}
	104
cb8f51bd RW	105	static inline bool pm_runtime_callbacks_present(struct device *dev)
	106	{
	107	return !dev->power.no_callbacks;
	108	}
	109
15bcb91d AS	110	static inline void pm_runtime_mark_last_busy(struct device *dev)
	111	{
	112	ACCESS_ONCE(dev->power.last_busy) = jiffies;
	113	}
	114
5e928f77 RW	115	#else /* !CONFIG_PM_RUNTIME */
5e928f77 RW	116
140a6c94 AS	117	static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
	118	{
	119	return -ENOSYS;
	120	}
	121	static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
	122	{
	123	return -ENOSYS;
	124	}
	125	static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
	126	{
	127	return 1;
	128	}
5e928f77 RW	129	static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
	130	{
	131	return -ENOSYS;
	132	}
5e928f77 RW	133	static inline int __pm_runtime_set_status(struct device *dev,
	134	unsigned int status) { return 0; }
	135	static inline int pm_runtime_barrier(struct device *dev) { return 0; }
	136	static inline void pm_runtime_enable(struct device *dev) {}
	137	static inline void __pm_runtime_disable(struct device *dev, bool c) {}
53823639 RW	138	static inline void pm_runtime_allow(struct device *dev) {}
53823639 RW	139	static inline void pm_runtime_forbid(struct device *dev) {}
5e928f77 RW	140
5e928f77 RW	141	static inline bool pm_children_suspended(struct device *dev) { return false; }
5e928f77 RW	142	static inline void pm_runtime_get_noresume(struct device *dev) {}
5e928f77 RW	143	static inline void pm_runtime_put_noidle(struct device *dev) {}
7a1a8eb5 RW	144	static inline bool device_run_wake(struct device *dev) { return false; }
7a1a8eb5 RW	145	static inline void device_set_run_wake(struct device *dev, bool enable) {}
d690b2cd	146	static inline bool pm_runtime_suspended(struct device *dev) { return false; }
fbadc58d	147	static inline bool pm_runtime_active(struct device *dev) { return true; }
f3393b62	148	static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
4b31db8a	149	static inline bool pm_runtime_enabled(struct device *dev) { return false; }
5e928f77	150
7490e442	151	static inline void pm_runtime_no_callbacks(struct device *dev) {}
c7b61de5	152	static inline void pm_runtime_irq_safe(struct device *dev) {}
2f60ba70	153
cb8f51bd	154	static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
15bcb91d AS	155	static inline void pm_runtime_mark_last_busy(struct device *dev) {}
	156	static inline void __pm_runtime_use_autosuspend(struct device *dev,
	157	bool use) {}
	158	static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
	159	int delay) {}
	160	static inline unsigned long pm_runtime_autosuspend_expiration(
	161	struct device *dev) { return 0; }
e823407f ML	162	static inline void pm_runtime_set_memalloc_noio(struct device *dev,
e823407f ML	163	bool enable){}
15bcb91d	164
5e928f77 RW	165	#endif /* !CONFIG_PM_RUNTIME */
5e928f77 RW	166
140a6c94 AS	167	static inline int pm_runtime_idle(struct device *dev)
	168	{
	169	return __pm_runtime_idle(dev, 0);
	170	}
	171
	172	static inline int pm_runtime_suspend(struct device *dev)
	173	{
	174	return __pm_runtime_suspend(dev, 0);
	175	}
	176
15bcb91d AS	177	static inline int pm_runtime_autosuspend(struct device *dev)
	178	{
	179	return __pm_runtime_suspend(dev, RPM_AUTO);
	180	}
	181
140a6c94 AS	182	static inline int pm_runtime_resume(struct device *dev)
	183	{
	184	return __pm_runtime_resume(dev, 0);
	185	}
	186
	187	static inline int pm_request_idle(struct device *dev)
	188	{
	189	return __pm_runtime_idle(dev, RPM_ASYNC);
	190	}
	191
	192	static inline int pm_request_resume(struct device *dev)
	193	{
	194	return __pm_runtime_resume(dev, RPM_ASYNC);
	195	}
	196
5fc62aad ML	197	static inline int pm_request_autosuspend(struct device *dev)
	198	{
	199	return __pm_runtime_suspend(dev, RPM_ASYNC \| RPM_AUTO);
	200	}
	201
5e928f77 RW	202	static inline int pm_runtime_get(struct device *dev)
5e928f77 RW	203	{
140a6c94	204	return __pm_runtime_resume(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	205	}
	206
	207	static inline int pm_runtime_get_sync(struct device *dev)
	208	{
140a6c94	209	return __pm_runtime_resume(dev, RPM_GET_PUT);
5e928f77 RW	210	}
	211
	212	static inline int pm_runtime_put(struct device *dev)
	213	{
140a6c94	214	return __pm_runtime_idle(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	215	}
5e928f77 RW	216
15bcb91d AS	217	static inline int pm_runtime_put_autosuspend(struct device *dev)
	218	{
	219	return __pm_runtime_suspend(dev,
	220	RPM_GET_PUT \| RPM_ASYNC \| RPM_AUTO);
	221	}
	222
5e928f77 RW	223	static inline int pm_runtime_put_sync(struct device *dev)
5e928f77 RW	224	{
140a6c94	225	return __pm_runtime_idle(dev, RPM_GET_PUT);
5e928f77 RW	226	}
5e928f77 RW	227
c7b61de5 AS	228	static inline int pm_runtime_put_sync_suspend(struct device *dev)
	229	{
	230	return __pm_runtime_suspend(dev, RPM_GET_PUT);
	231	}
	232
15bcb91d AS	233	static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
	234	{
	235	return __pm_runtime_suspend(dev, RPM_GET_PUT \| RPM_AUTO);
	236	}
	237
5e928f77 RW	238	static inline int pm_runtime_set_active(struct device *dev)
	239	{
	240	return __pm_runtime_set_status(dev, RPM_ACTIVE);
	241	}
	242
	243	static inline void pm_runtime_set_suspended(struct device *dev)
	244	{
	245	__pm_runtime_set_status(dev, RPM_SUSPENDED);
	246	}
	247
	248	static inline void pm_runtime_disable(struct device *dev)
	249	{
	250	__pm_runtime_disable(dev, true);
	251	}
	252
15bcb91d AS	253	static inline void pm_runtime_use_autosuspend(struct device *dev)
	254	{
	255	__pm_runtime_use_autosuspend(dev, true);
	256	}
	257
	258	static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
	259	{
	260	__pm_runtime_use_autosuspend(dev, false);
	261	}
	262
5e928f77	263	#endif