[linux-2.6-block.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 struct workqueue_struct *pm_wq;

static inline bool queue_pm_work(struct work_struct *work)
{
	return queue_work(pm_wq, work);
}

extern int pm_generic_runtime_suspend(struct device *dev);
extern int pm_generic_runtime_resume(struct device *dev);
extern int pm_runtime_force_suspend(struct device *dev);
extern int pm_runtime_force_resume(struct device *dev);

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_suspended_if_enabled(struct device *dev)
{
	return pm_runtime_status_suspended(dev) && dev->power.disable_depth == 1;
}

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;
}

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

#else /* !CONFIG_PM */

static inline bool queue_pm_work(struct work_struct *work) { return false; }

static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
static inline int pm_runtime_force_resume(struct device *dev) { return 0; }

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_suspended_if_enabled(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_is_irq_safe(struct device *dev) { return false; }

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 */

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	26	#ifdef CONFIG_PM
28cb5ef1 RW	27	extern struct workqueue_struct *pm_wq;
	28
	29	static inline bool queue_pm_work(struct work_struct *work)
	30	{
	31	return queue_work(pm_wq, work);
	32	}
	33
717e5d45 UH	34	extern int pm_generic_runtime_suspend(struct device *dev);
717e5d45 UH	35	extern int pm_generic_runtime_resume(struct device *dev);
37f20416 UH	36	extern int pm_runtime_force_suspend(struct device *dev);
37f20416 UH	37	extern int pm_runtime_force_resume(struct device *dev);
5e928f77	38
140a6c94 AS	39	extern int __pm_runtime_idle(struct device *dev, int rpmflags);
	40	extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
	41	extern int __pm_runtime_resume(struct device *dev, int rpmflags);
5e928f77	42	extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
5e928f77 RW	43	extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
	44	extern int pm_runtime_barrier(struct device *dev);
	45	extern void pm_runtime_enable(struct device *dev);
	46	extern void __pm_runtime_disable(struct device *dev, bool check_resume);
53823639 RW	47	extern void pm_runtime_allow(struct device *dev);
53823639 RW	48	extern void pm_runtime_forbid(struct device *dev);
7490e442	49	extern void pm_runtime_no_callbacks(struct device *dev);
c7b61de5	50	extern void pm_runtime_irq_safe(struct device *dev);
15bcb91d AS	51	extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
	52	extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
	53	extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
00dc9ad1 RW	54	extern void pm_runtime_update_max_time_suspended(struct device *dev,
00dc9ad1 RW	55	s64 delta_ns);
e823407f	56	extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
5e928f77 RW	57
	58	static inline bool pm_children_suspended(struct device *dev)
	59	{
	60	return dev->power.ignore_children
	61	\|\| !atomic_read(&dev->power.child_count);
	62	}
	63
5e928f77 RW	64	static inline void pm_runtime_get_noresume(struct device *dev)
	65	{
	66	atomic_inc(&dev->power.usage_count);
	67	}
	68
	69	static inline void pm_runtime_put_noidle(struct device *dev)
	70	{
	71	atomic_add_unless(&dev->power.usage_count, -1, 0);
	72	}
	73
7a1a8eb5 RW	74	static inline bool device_run_wake(struct device *dev)
	75	{
	76	return dev->power.run_wake;
	77	}
	78
	79	static inline void device_set_run_wake(struct device *dev, bool enable)
	80	{
	81	dev->power.run_wake = enable;
	82	}
	83
d690b2cd RW	84	static inline bool pm_runtime_suspended(struct device *dev)
d690b2cd RW	85	{
f08f5a0a RW	86	return dev->power.runtime_status == RPM_SUSPENDED
f08f5a0a RW	87	&& !dev->power.disable_depth;
d690b2cd RW	88	}
d690b2cd RW	89
fbadc58d SL	90	static inline bool pm_runtime_active(struct device *dev)
	91	{
	92	return dev->power.runtime_status == RPM_ACTIVE
	93	\|\| dev->power.disable_depth;
	94	}
	95
f3393b62 KH	96	static inline bool pm_runtime_status_suspended(struct device *dev)
	97	{
	98	return dev->power.runtime_status == RPM_SUSPENDED;
	99	}
	100
aae4518b RW	101	static inline bool pm_runtime_suspended_if_enabled(struct device *dev)
	102	{
	103	return pm_runtime_status_suspended(dev) && dev->power.disable_depth == 1;
	104	}
	105
4b31db8a RW	106	static inline bool pm_runtime_enabled(struct device *dev)
	107	{
	108	return !dev->power.disable_depth;
	109	}
	110
cb8f51bd RW	111	static inline bool pm_runtime_callbacks_present(struct device *dev)
	112	{
	113	return !dev->power.no_callbacks;
	114	}
	115
15bcb91d AS	116	static inline void pm_runtime_mark_last_busy(struct device *dev)
	117	{
	118	ACCESS_ONCE(dev->power.last_busy) = jiffies;
	119	}
	120
3fb1581e KK	121	static inline bool pm_runtime_is_irq_safe(struct device *dev)
	122	{
	123	return dev->power.irq_safe;
	124	}
	125
d30d819d RW	126	#else /* !CONFIG_PM */
	127
	128	static inline bool queue_pm_work(struct work_struct *work) { return false; }
	129
	130	static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
	131	static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
	132	static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
	133	static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
5e928f77	134
140a6c94 AS	135	static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
	136	{
	137	return -ENOSYS;
	138	}
	139	static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
	140	{
	141	return -ENOSYS;
	142	}
	143	static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
	144	{
	145	return 1;
	146	}
5e928f77 RW	147	static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
	148	{
	149	return -ENOSYS;
	150	}
5e928f77 RW	151	static inline int __pm_runtime_set_status(struct device *dev,
	152	unsigned int status) { return 0; }
	153	static inline int pm_runtime_barrier(struct device *dev) { return 0; }
	154	static inline void pm_runtime_enable(struct device *dev) {}
	155	static inline void __pm_runtime_disable(struct device *dev, bool c) {}
53823639 RW	156	static inline void pm_runtime_allow(struct device *dev) {}
53823639 RW	157	static inline void pm_runtime_forbid(struct device *dev) {}
5e928f77 RW	158
5e928f77 RW	159	static inline bool pm_children_suspended(struct device *dev) { return false; }
5e928f77 RW	160	static inline void pm_runtime_get_noresume(struct device *dev) {}
5e928f77 RW	161	static inline void pm_runtime_put_noidle(struct device *dev) {}
7a1a8eb5 RW	162	static inline bool device_run_wake(struct device *dev) { return false; }
7a1a8eb5 RW	163	static inline void device_set_run_wake(struct device *dev, bool enable) {}
d690b2cd	164	static inline bool pm_runtime_suspended(struct device *dev) { return false; }
fbadc58d	165	static inline bool pm_runtime_active(struct device *dev) { return true; }
f3393b62	166	static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
aae4518b	167	static inline bool pm_runtime_suspended_if_enabled(struct device *dev) { return false; }
4b31db8a	168	static inline bool pm_runtime_enabled(struct device *dev) { return false; }
5e928f77	169
7490e442	170	static inline void pm_runtime_no_callbacks(struct device *dev) {}
c7b61de5	171	static inline void pm_runtime_irq_safe(struct device *dev) {}
3fb1581e	172	static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
2f60ba70	173
cb8f51bd	174	static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
15bcb91d AS	175	static inline void pm_runtime_mark_last_busy(struct device *dev) {}
	176	static inline void __pm_runtime_use_autosuspend(struct device *dev,
	177	bool use) {}
	178	static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
	179	int delay) {}
	180	static inline unsigned long pm_runtime_autosuspend_expiration(
	181	struct device *dev) { return 0; }
e823407f ML	182	static inline void pm_runtime_set_memalloc_noio(struct device *dev,
e823407f ML	183	bool enable){}
15bcb91d	184
d30d819d	185	#endif /* !CONFIG_PM */
5e928f77	186
140a6c94 AS	187	static inline int pm_runtime_idle(struct device *dev)
	188	{
	189	return __pm_runtime_idle(dev, 0);
	190	}
	191
	192	static inline int pm_runtime_suspend(struct device *dev)
	193	{
	194	return __pm_runtime_suspend(dev, 0);
	195	}
	196
15bcb91d AS	197	static inline int pm_runtime_autosuspend(struct device *dev)
	198	{
	199	return __pm_runtime_suspend(dev, RPM_AUTO);
	200	}
	201
140a6c94 AS	202	static inline int pm_runtime_resume(struct device *dev)
	203	{
	204	return __pm_runtime_resume(dev, 0);
	205	}
	206
	207	static inline int pm_request_idle(struct device *dev)
	208	{
	209	return __pm_runtime_idle(dev, RPM_ASYNC);
	210	}
	211
	212	static inline int pm_request_resume(struct device *dev)
	213	{
	214	return __pm_runtime_resume(dev, RPM_ASYNC);
	215	}
	216
5fc62aad ML	217	static inline int pm_request_autosuspend(struct device *dev)
	218	{
	219	return __pm_runtime_suspend(dev, RPM_ASYNC \| RPM_AUTO);
	220	}
	221
5e928f77 RW	222	static inline int pm_runtime_get(struct device *dev)
5e928f77 RW	223	{
140a6c94	224	return __pm_runtime_resume(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	225	}
	226
	227	static inline int pm_runtime_get_sync(struct device *dev)
	228	{
140a6c94	229	return __pm_runtime_resume(dev, RPM_GET_PUT);
5e928f77 RW	230	}
	231
	232	static inline int pm_runtime_put(struct device *dev)
	233	{
140a6c94	234	return __pm_runtime_idle(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	235	}
5e928f77 RW	236
15bcb91d AS	237	static inline int pm_runtime_put_autosuspend(struct device *dev)
	238	{
	239	return __pm_runtime_suspend(dev,
	240	RPM_GET_PUT \| RPM_ASYNC \| RPM_AUTO);
	241	}
	242
5e928f77 RW	243	static inline int pm_runtime_put_sync(struct device *dev)
5e928f77 RW	244	{
140a6c94	245	return __pm_runtime_idle(dev, RPM_GET_PUT);
5e928f77 RW	246	}
5e928f77 RW	247
c7b61de5 AS	248	static inline int pm_runtime_put_sync_suspend(struct device *dev)
	249	{
	250	return __pm_runtime_suspend(dev, RPM_GET_PUT);
	251	}
	252
15bcb91d AS	253	static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
	254	{
	255	return __pm_runtime_suspend(dev, RPM_GET_PUT \| RPM_AUTO);
	256	}
	257
5e928f77 RW	258	static inline int pm_runtime_set_active(struct device *dev)
	259	{
	260	return __pm_runtime_set_status(dev, RPM_ACTIVE);
	261	}
	262
	263	static inline void pm_runtime_set_suspended(struct device *dev)
	264	{
	265	__pm_runtime_set_status(dev, RPM_SUSPENDED);
	266	}
	267
	268	static inline void pm_runtime_disable(struct device *dev)
	269	{
	270	__pm_runtime_disable(dev, true);
	271	}
	272
15bcb91d AS	273	static inline void pm_runtime_use_autosuspend(struct device *dev)
	274	{
	275	__pm_runtime_use_autosuspend(dev, true);
	276	}
	277
	278	static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
	279	{
	280	__pm_runtime_use_autosuspend(dev, false);
	281	}
	282
5e928f77	283	#endif