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

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

struct pm_clk_notifier_block {
	struct notifier_block nb;
	struct dev_power_domain *pwr_domain;
	char *con_ids[];
};

#ifdef CONFIG_PM_RUNTIME_CLK
extern int pm_runtime_clk_init(struct device *dev);
extern void pm_runtime_clk_destroy(struct device *dev);
extern int pm_runtime_clk_add(struct device *dev, const char *con_id);
extern void pm_runtime_clk_remove(struct device *dev, const char *con_id);
extern int pm_runtime_clk_suspend(struct device *dev);
extern int pm_runtime_clk_resume(struct device *dev);
#else
static inline int pm_runtime_clk_init(struct device *dev)
{
	return -EINVAL;
}
static inline void pm_runtime_clk_destroy(struct device *dev)
{
}
static inline int pm_runtime_clk_add(struct device *dev, const char *con_id)
{
	return -EINVAL;
}
static inline void pm_runtime_clk_remove(struct device *dev, const char *con_id)
{
}
#define pm_runtime_clock_suspend	NULL
#define pm_runtime_clock_resume		NULL
#endif

#ifdef CONFIG_HAVE_CLK
extern void pm_runtime_clk_add_notifier(struct bus_type *bus,
					struct pm_clk_notifier_block *clknb);
#else
static inline void pm_runtime_clk_add_notifier(struct bus_type *bus,
					struct pm_clk_notifier_block *clknb)
{
}
#endif

#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
cb8f51bd RW	90	static inline bool pm_runtime_callbacks_present(struct device *dev)
	91	{
	92	return !dev->power.no_callbacks;
	93	}
	94
15bcb91d AS	95	static inline void pm_runtime_mark_last_busy(struct device *dev)
	96	{
	97	ACCESS_ONCE(dev->power.last_busy) = jiffies;
	98	}
	99
5e928f77 RW	100	#else /* !CONFIG_PM_RUNTIME */
5e928f77 RW	101
140a6c94 AS	102	static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
	103	{
	104	return -ENOSYS;
	105	}
	106	static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
	107	{
	108	return -ENOSYS;
	109	}
	110	static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
	111	{
	112	return 1;
	113	}
5e928f77 RW	114	static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
	115	{
	116	return -ENOSYS;
	117	}
5e928f77 RW	118	static inline int __pm_runtime_set_status(struct device *dev,
	119	unsigned int status) { return 0; }
	120	static inline int pm_runtime_barrier(struct device *dev) { return 0; }
	121	static inline void pm_runtime_enable(struct device *dev) {}
	122	static inline void __pm_runtime_disable(struct device *dev, bool c) {}
53823639 RW	123	static inline void pm_runtime_allow(struct device *dev) {}
53823639 RW	124	static inline void pm_runtime_forbid(struct device *dev) {}
5e928f77 RW	125
	126	static inline bool pm_children_suspended(struct device *dev) { return false; }
	127	static inline void pm_suspend_ignore_children(struct device *dev, bool en) {}
	128	static inline void pm_runtime_get_noresume(struct device *dev) {}
	129	static inline void pm_runtime_put_noidle(struct device *dev) {}
7a1a8eb5 RW	130	static inline bool device_run_wake(struct device *dev) { return false; }
7a1a8eb5 RW	131	static inline void device_set_run_wake(struct device *dev, bool enable) {}
d690b2cd	132	static inline bool pm_runtime_suspended(struct device *dev) { return false; }
4b31db8a	133	static inline bool pm_runtime_enabled(struct device *dev) { return false; }
5e928f77	134
2f60ba70 RW	135	static inline int pm_generic_runtime_idle(struct device *dev) { return 0; }
	136	static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
	137	static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
7490e442	138	static inline void pm_runtime_no_callbacks(struct device *dev) {}
c7b61de5	139	static inline void pm_runtime_irq_safe(struct device *dev) {}
2f60ba70	140
cb8f51bd	141	static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
15bcb91d AS	142	static inline void pm_runtime_mark_last_busy(struct device *dev) {}
	143	static inline void __pm_runtime_use_autosuspend(struct device *dev,
	144	bool use) {}
	145	static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
	146	int delay) {}
	147	static inline unsigned long pm_runtime_autosuspend_expiration(
	148	struct device *dev) { return 0; }
	149
5e928f77 RW	150	#endif /* !CONFIG_PM_RUNTIME */
5e928f77 RW	151
140a6c94 AS	152	static inline int pm_runtime_idle(struct device *dev)
	153	{
	154	return __pm_runtime_idle(dev, 0);
	155	}
	156
	157	static inline int pm_runtime_suspend(struct device *dev)
	158	{
	159	return __pm_runtime_suspend(dev, 0);
	160	}
	161
15bcb91d AS	162	static inline int pm_runtime_autosuspend(struct device *dev)
	163	{
	164	return __pm_runtime_suspend(dev, RPM_AUTO);
	165	}
	166
140a6c94 AS	167	static inline int pm_runtime_resume(struct device *dev)
	168	{
	169	return __pm_runtime_resume(dev, 0);
	170	}
	171
	172	static inline int pm_request_idle(struct device *dev)
	173	{
	174	return __pm_runtime_idle(dev, RPM_ASYNC);
	175	}
	176
	177	static inline int pm_request_resume(struct device *dev)
	178	{
	179	return __pm_runtime_resume(dev, RPM_ASYNC);
	180	}
	181
5fc62aad ML	182	static inline int pm_request_autosuspend(struct device *dev)
	183	{
	184	return __pm_runtime_suspend(dev, RPM_ASYNC \| RPM_AUTO);
	185	}
	186
5e928f77 RW	187	static inline int pm_runtime_get(struct device *dev)
5e928f77 RW	188	{
140a6c94	189	return __pm_runtime_resume(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	190	}
	191
	192	static inline int pm_runtime_get_sync(struct device *dev)
	193	{
140a6c94	194	return __pm_runtime_resume(dev, RPM_GET_PUT);
5e928f77 RW	195	}
	196
	197	static inline int pm_runtime_put(struct device *dev)
	198	{
140a6c94	199	return __pm_runtime_idle(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	200	}
5e928f77 RW	201
15bcb91d AS	202	static inline int pm_runtime_put_autosuspend(struct device *dev)
	203	{
	204	return __pm_runtime_suspend(dev,
	205	RPM_GET_PUT \| RPM_ASYNC \| RPM_AUTO);
	206	}
	207
5e928f77 RW	208	static inline int pm_runtime_put_sync(struct device *dev)
5e928f77 RW	209	{
140a6c94	210	return __pm_runtime_idle(dev, RPM_GET_PUT);
5e928f77 RW	211	}
5e928f77 RW	212
c7b61de5 AS	213	static inline int pm_runtime_put_sync_suspend(struct device *dev)
	214	{
	215	return __pm_runtime_suspend(dev, RPM_GET_PUT);
	216	}
	217
15bcb91d AS	218	static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
	219	{
	220	return __pm_runtime_suspend(dev, RPM_GET_PUT \| RPM_AUTO);
	221	}
	222
5e928f77 RW	223	static inline int pm_runtime_set_active(struct device *dev)
	224	{
	225	return __pm_runtime_set_status(dev, RPM_ACTIVE);
	226	}
	227
	228	static inline void pm_runtime_set_suspended(struct device *dev)
	229	{
	230	__pm_runtime_set_status(dev, RPM_SUSPENDED);
	231	}
	232
	233	static inline void pm_runtime_disable(struct device *dev)
	234	{
	235	__pm_runtime_disable(dev, true);
	236	}
	237
15bcb91d AS	238	static inline void pm_runtime_use_autosuspend(struct device *dev)
	239	{
	240	__pm_runtime_use_autosuspend(dev, true);
	241	}
	242
	243	static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
	244	{
	245	__pm_runtime_use_autosuspend(dev, false);
	246	}
	247
85eb8c8d RW	248	struct pm_clk_notifier_block {
	249	struct notifier_block nb;
	250	struct dev_power_domain *pwr_domain;
	251	char *con_ids[];
	252	};
	253
	254	#ifdef CONFIG_PM_RUNTIME_CLK
	255	extern int pm_runtime_clk_init(struct device *dev);
	256	extern void pm_runtime_clk_destroy(struct device *dev);
	257	extern int pm_runtime_clk_add(struct device dev, const char con_id);
	258	extern void pm_runtime_clk_remove(struct device dev, const char con_id);
	259	extern int pm_runtime_clk_suspend(struct device *dev);
	260	extern int pm_runtime_clk_resume(struct device *dev);
	261	#else
	262	static inline int pm_runtime_clk_init(struct device *dev)
	263	{
	264	return -EINVAL;
	265	}
	266	static inline void pm_runtime_clk_destroy(struct device *dev)
	267	{
	268	}
	269	static inline int pm_runtime_clk_add(struct device dev, const char con_id)
	270	{
	271	return -EINVAL;
	272	}
	273	static inline void pm_runtime_clk_remove(struct device dev, const char con_id)
	274	{
	275	}
	276	#define pm_runtime_clock_suspend NULL
	277	#define pm_runtime_clock_resume NULL
	278	#endif
	279
	280	#ifdef CONFIG_HAVE_CLK
	281	extern void pm_runtime_clk_add_notifier(struct bus_type *bus,
	282	struct pm_clk_notifier_block *clknb);
	283	#else
	284	static inline void pm_runtime_clk_add_notifier(struct bus_type *bus,
	285	struct pm_clk_notifier_block *clknb)
	286	{
	287	}
	288	#endif
	289
5e928f77	290	#endif