[mirror_ubuntu-bionic-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/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_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);
extern void pm_runtime_update_max_time_suspended(struct device *dev,
						 s64 delta_ns);

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_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_status_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);
}

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