[linux-block.git] / include / linux / pm_runtime.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * pm_runtime.h - Device run-time power management helper functions.
 *
 * Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
 */

#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_runtime_get_if_in_use(struct device *dev);
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 u64 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);
extern void pm_runtime_clean_up_links(struct device *dev);
extern void pm_runtime_get_suppliers(struct device *dev);
extern void pm_runtime_put_suppliers(struct device *dev);
extern void pm_runtime_new_link(struct device *dev);
extern void pm_runtime_drop_link(struct device *dev);

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 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)
{
	WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());
}

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

extern u64 pm_runtime_suspended_time(struct device *dev);

#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_get_if_in_use(struct device *dev)
{
	return -EINVAL;
}
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 void pm_suspend_ignore_children(struct device *dev, bool enable) {}
static inline void pm_runtime_get_noresume(struct device *dev) {}
static inline void pm_runtime_put_noidle(struct device *dev) {}
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_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 u64 pm_runtime_autosuspend_expiration(
				struct device *dev) { return 0; }
static inline void pm_runtime_set_memalloc_noio(struct device *dev,
						bool enable){}
static inline void pm_runtime_clean_up_links(struct device *dev) {}
static inline void pm_runtime_get_suppliers(struct device *dev) {}
static inline void pm_runtime_put_suppliers(struct device *dev) {}
static inline void pm_runtime_new_link(struct device *dev) {}
static inline void pm_runtime_drop_link(struct device *dev) {}

#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 int pm_runtime_set_suspended(struct device *dev)
{
	return __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
55716d26	1	/* SPDX-License-Identifier: GPL-2.0-only */
5e928f77 RW	2	/*
	3	* pm_runtime.h - Device run-time power management helper functions.
	4	*
	5	* Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
5e928f77 RW	6	*/
	7
	8	#ifndef _LINUX_PM_RUNTIME_H
	9	#define _LINUX_PM_RUNTIME_H
	10
	11	#include <linux/device.h>
246359d3	12	#include <linux/notifier.h>
5e928f77 RW	13	#include <linux/pm.h>
5e928f77 RW	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
717e5d45	25	#ifdef CONFIG_PM
28cb5ef1 RW	26	extern struct workqueue_struct *pm_wq;
	27
	28	static inline bool queue_pm_work(struct work_struct *work)
	29	{
	30	return queue_work(pm_wq, work);
	31	}
	32
717e5d45 UH	33	extern int pm_generic_runtime_suspend(struct device *dev);
717e5d45 UH	34	extern int pm_generic_runtime_resume(struct device *dev);
37f20416 UH	35	extern int pm_runtime_force_suspend(struct device *dev);
37f20416 UH	36	extern int pm_runtime_force_resume(struct device *dev);
5e928f77	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);
a436b6a1	41	extern int pm_runtime_get_if_in_use(struct device *dev);
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);
15bcb91d AS	52	extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
8234f673	53	extern u64 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);
21d5c57b	57	extern void pm_runtime_clean_up_links(struct device *dev);
b06c0b2f RW	58	extern void pm_runtime_get_suppliers(struct device *dev);
b06c0b2f RW	59	extern void pm_runtime_put_suppliers(struct device *dev);
baa8809f RW	60	extern void pm_runtime_new_link(struct device *dev);
baa8809f RW	61	extern void pm_runtime_drop_link(struct device *dev);
5e928f77	62
372a12ed UH	63	static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
	64	{
	65	dev->power.ignore_children = enable;
	66	}
	67
5e928f77 RW	68	static inline void pm_runtime_get_noresume(struct device *dev)
	69	{
	70	atomic_inc(&dev->power.usage_count);
	71	}
	72
	73	static inline void pm_runtime_put_noidle(struct device *dev)
	74	{
	75	atomic_add_unless(&dev->power.usage_count, -1, 0);
	76	}
	77
d690b2cd RW	78	static inline bool pm_runtime_suspended(struct device *dev)
d690b2cd RW	79	{
f08f5a0a RW	80	return dev->power.runtime_status == RPM_SUSPENDED
f08f5a0a RW	81	&& !dev->power.disable_depth;
d690b2cd RW	82	}
d690b2cd RW	83
fbadc58d SL	84	static inline bool pm_runtime_active(struct device *dev)
	85	{
	86	return dev->power.runtime_status == RPM_ACTIVE
	87	\|\| dev->power.disable_depth;
	88	}
	89
f3393b62 KH	90	static inline bool pm_runtime_status_suspended(struct device *dev)
	91	{
	92	return dev->power.runtime_status == RPM_SUSPENDED;
	93	}
	94
4b31db8a RW	95	static inline bool pm_runtime_enabled(struct device *dev)
	96	{
	97	return !dev->power.disable_depth;
	98	}
	99
cb8f51bd RW	100	static inline bool pm_runtime_callbacks_present(struct device *dev)
	101	{
	102	return !dev->power.no_callbacks;
	103	}
	104
15bcb91d AS	105	static inline void pm_runtime_mark_last_busy(struct device *dev)
15bcb91d AS	106	{
15efb47d	107	WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());
15bcb91d AS	108	}
15bcb91d AS	109
3fb1581e KK	110	static inline bool pm_runtime_is_irq_safe(struct device *dev)
	111	{
	112	return dev->power.irq_safe;
	113	}
	114
8a62ffe2 VG	115	extern u64 pm_runtime_suspended_time(struct device *dev);
8a62ffe2 VG	116
d30d819d RW	117	#else /* !CONFIG_PM */
	118
	119	static inline bool queue_pm_work(struct work_struct *work) { return false; }
	120
	121	static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
	122	static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
	123	static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
	124	static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
5e928f77	125
140a6c94 AS	126	static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
	127	{
	128	return -ENOSYS;
	129	}
	130	static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
	131	{
	132	return -ENOSYS;
	133	}
	134	static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
	135	{
	136	return 1;
	137	}
5e928f77 RW	138	static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
	139	{
	140	return -ENOSYS;
	141	}
a436b6a1 RW	142	static inline int pm_runtime_get_if_in_use(struct device *dev)
	143	{
	144	return -EINVAL;
	145	}
5e928f77 RW	146	static inline int __pm_runtime_set_status(struct device *dev,
	147	unsigned int status) { return 0; }
	148	static inline int pm_runtime_barrier(struct device *dev) { return 0; }
	149	static inline void pm_runtime_enable(struct device *dev) {}
	150	static inline void __pm_runtime_disable(struct device *dev, bool c) {}
53823639 RW	151	static inline void pm_runtime_allow(struct device *dev) {}
53823639 RW	152	static inline void pm_runtime_forbid(struct device *dev) {}
5e928f77	153
372a12ed	154	static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
5e928f77 RW	155	static inline void pm_runtime_get_noresume(struct device *dev) {}
5e928f77 RW	156	static inline void pm_runtime_put_noidle(struct device *dev) {}
d690b2cd	157	static inline bool pm_runtime_suspended(struct device *dev) { return false; }
fbadc58d	158	static inline bool pm_runtime_active(struct device *dev) { return true; }
f3393b62	159	static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
4b31db8a	160	static inline bool pm_runtime_enabled(struct device *dev) { return false; }
5e928f77	161
7490e442	162	static inline void pm_runtime_no_callbacks(struct device *dev) {}
c7b61de5	163	static inline void pm_runtime_irq_safe(struct device *dev) {}
3fb1581e	164	static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
2f60ba70	165
cb8f51bd	166	static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
15bcb91d AS	167	static inline void pm_runtime_mark_last_busy(struct device *dev) {}
	168	static inline void __pm_runtime_use_autosuspend(struct device *dev,
	169	bool use) {}
	170	static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
	171	int delay) {}
8234f673	172	static inline u64 pm_runtime_autosuspend_expiration(
15bcb91d	173	struct device *dev) { return 0; }
e823407f ML	174	static inline void pm_runtime_set_memalloc_noio(struct device *dev,
e823407f ML	175	bool enable){}
21d5c57b	176	static inline void pm_runtime_clean_up_links(struct device *dev) {}
b06c0b2f RW	177	static inline void pm_runtime_get_suppliers(struct device *dev) {}
b06c0b2f RW	178	static inline void pm_runtime_put_suppliers(struct device *dev) {}
baa8809f RW	179	static inline void pm_runtime_new_link(struct device *dev) {}
baa8809f RW	180	static inline void pm_runtime_drop_link(struct device *dev) {}
15bcb91d	181
d30d819d	182	#endif /* !CONFIG_PM */
5e928f77	183
140a6c94 AS	184	static inline int pm_runtime_idle(struct device *dev)
	185	{
	186	return __pm_runtime_idle(dev, 0);
	187	}
	188
	189	static inline int pm_runtime_suspend(struct device *dev)
	190	{
	191	return __pm_runtime_suspend(dev, 0);
	192	}
	193
15bcb91d AS	194	static inline int pm_runtime_autosuspend(struct device *dev)
	195	{
	196	return __pm_runtime_suspend(dev, RPM_AUTO);
	197	}
	198
140a6c94 AS	199	static inline int pm_runtime_resume(struct device *dev)
	200	{
	201	return __pm_runtime_resume(dev, 0);
	202	}
	203
	204	static inline int pm_request_idle(struct device *dev)
	205	{
	206	return __pm_runtime_idle(dev, RPM_ASYNC);
	207	}
	208
	209	static inline int pm_request_resume(struct device *dev)
	210	{
	211	return __pm_runtime_resume(dev, RPM_ASYNC);
	212	}
	213
5fc62aad ML	214	static inline int pm_request_autosuspend(struct device *dev)
	215	{
	216	return __pm_runtime_suspend(dev, RPM_ASYNC \| RPM_AUTO);
	217	}
	218
5e928f77 RW	219	static inline int pm_runtime_get(struct device *dev)
5e928f77 RW	220	{
140a6c94	221	return __pm_runtime_resume(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	222	}
	223
	224	static inline int pm_runtime_get_sync(struct device *dev)
	225	{
140a6c94	226	return __pm_runtime_resume(dev, RPM_GET_PUT);
5e928f77 RW	227	}
	228
	229	static inline int pm_runtime_put(struct device *dev)
	230	{
140a6c94	231	return __pm_runtime_idle(dev, RPM_GET_PUT \| RPM_ASYNC);
5e928f77 RW	232	}
5e928f77 RW	233
15bcb91d AS	234	static inline int pm_runtime_put_autosuspend(struct device *dev)
	235	{
	236	return __pm_runtime_suspend(dev,
	237	RPM_GET_PUT \| RPM_ASYNC \| RPM_AUTO);
	238	}
	239
5e928f77 RW	240	static inline int pm_runtime_put_sync(struct device *dev)
5e928f77 RW	241	{
140a6c94	242	return __pm_runtime_idle(dev, RPM_GET_PUT);
5e928f77 RW	243	}
5e928f77 RW	244
c7b61de5 AS	245	static inline int pm_runtime_put_sync_suspend(struct device *dev)
	246	{
	247	return __pm_runtime_suspend(dev, RPM_GET_PUT);
	248	}
	249
15bcb91d AS	250	static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
	251	{
	252	return __pm_runtime_suspend(dev, RPM_GET_PUT \| RPM_AUTO);
	253	}
	254
5e928f77 RW	255	static inline int pm_runtime_set_active(struct device *dev)
	256	{
	257	return __pm_runtime_set_status(dev, RPM_ACTIVE);
	258	}
	259
b1a60995	260	static inline int pm_runtime_set_suspended(struct device *dev)
5e928f77	261	{
b1a60995	262	return __pm_runtime_set_status(dev, RPM_SUSPENDED);
5e928f77 RW	263	}
	264
	265	static inline void pm_runtime_disable(struct device *dev)
	266	{
	267	__pm_runtime_disable(dev, true);
	268	}
	269
15bcb91d AS	270	static inline void pm_runtime_use_autosuspend(struct device *dev)
	271	{
	272	__pm_runtime_use_autosuspend(dev, true);
	273	}
	274
	275	static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
	276	{
	277	__pm_runtime_use_autosuspend(dev, false);
	278	}
	279
5e928f77	280	#endif