[mirror_ubuntu-artful-kernel.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/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_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 int pm_generic_runtime_idle(struct device *dev);
extern int pm_generic_runtime_suspend(struct device *dev);
extern int pm_generic_runtime_resume(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);

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

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

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_enabled(struct device *dev)
{
	return !dev->power.disable_depth;
}

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_suspend_ignore_children(struct device *dev, bool en) {}
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_enabled(struct device *dev) { return false; }

static inline int pm_generic_runtime_idle(struct device *dev) { return 0; }
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 void pm_runtime_no_callbacks(struct device *dev) {}
static inline void pm_runtime_irq_safe(struct device *dev) {}

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

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