pm_runtime.h 8.48 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * 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>
13
#include <linux/notifier.h>
14 15
#include <linux/pm.h>

16 17
#include <linux/jiffies.h>

18 19 20 21
/* Runtime PM flag argument bits */
#define RPM_ASYNC		0x01	/* Request is asynchronous */
#define RPM_NOWAIT		0x02	/* Don't wait for concurrent
					    state change */
22 23
#define RPM_GET_PUT		0x04	/* Increment/decrement the
					    usage_count */
24
#define RPM_AUTO		0x08	/* Use autosuspend_delay */
25

26
#ifdef CONFIG_PM
27 28 29 30 31 32 33
extern struct workqueue_struct *pm_wq;

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

34 35
extern int pm_generic_runtime_suspend(struct device *dev);
extern int pm_generic_runtime_resume(struct device *dev);
36 37
extern int pm_runtime_force_suspend(struct device *dev);
extern int pm_runtime_force_resume(struct device *dev);
38

39 40 41
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);
42
extern int pm_runtime_get_if_in_use(struct device *dev);
43 44 45 46 47
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);
48 49
extern void pm_runtime_allow(struct device *dev);
extern void pm_runtime_forbid(struct device *dev);
50
extern void pm_runtime_no_callbacks(struct device *dev);
51
extern void pm_runtime_irq_safe(struct device *dev);
52 53 54
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);
55 56
extern void pm_runtime_update_max_time_suspended(struct device *dev,
						 s64 delta_ns);
57
extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
58

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

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
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);
}

80 81 82 83 84 85 86 87 88 89
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;
}

90 91
static inline bool pm_runtime_suspended(struct device *dev)
{
92 93
	return dev->power.runtime_status == RPM_SUSPENDED
		&& !dev->power.disable_depth;
94 95
}

96 97 98 99 100 101
static inline bool pm_runtime_active(struct device *dev)
{
	return dev->power.runtime_status == RPM_ACTIVE
		|| dev->power.disable_depth;
}

102 103 104 105 106
static inline bool pm_runtime_status_suspended(struct device *dev)
{
	return dev->power.runtime_status == RPM_SUSPENDED;
}

107 108 109 110 111
static inline bool pm_runtime_enabled(struct device *dev)
{
	return !dev->power.disable_depth;
}

112 113 114 115 116
static inline bool pm_runtime_callbacks_present(struct device *dev)
{
	return !dev->power.no_callbacks;
}

117 118 119 120 121
static inline void pm_runtime_mark_last_busy(struct device *dev)
{
	ACCESS_ONCE(dev->power.last_busy) = jiffies;
}

122 123 124 125 126
static inline bool pm_runtime_is_irq_safe(struct device *dev)
{
	return dev->power.irq_safe;
}

127 128 129 130 131 132 133 134
#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; }
135

136 137 138 139 140 141 142 143 144 145 146 147
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;
}
148 149 150 151
static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
{
	return -ENOSYS;
}
152 153 154 155
static inline int pm_runtime_get_if_in_use(struct device *dev)
{
	return -EINVAL;
}
156 157 158 159 160
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) {}
161 162
static inline void pm_runtime_allow(struct device *dev) {}
static inline void pm_runtime_forbid(struct device *dev) {}
163

164
static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
165 166 167
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) {}
168 169
static inline bool device_run_wake(struct device *dev) { return false; }
static inline void device_set_run_wake(struct device *dev, bool enable) {}
170
static inline bool pm_runtime_suspended(struct device *dev) { return false; }
171
static inline bool pm_runtime_active(struct device *dev) { return true; }
172
static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
173
static inline bool pm_runtime_enabled(struct device *dev) { return false; }
174

175
static inline void pm_runtime_no_callbacks(struct device *dev) {}
176
static inline void pm_runtime_irq_safe(struct device *dev) {}
177
static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
178

179
static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
180 181 182 183 184 185 186
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; }
187 188
static inline void pm_runtime_set_memalloc_noio(struct device *dev,
						bool enable){}
189

190
#endif /* !CONFIG_PM */
191

192 193 194 195 196 197 198 199 200 201
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);
}

202 203 204 205 206
static inline int pm_runtime_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_AUTO);
}

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
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);
}

222 223 224 225 226
static inline int pm_request_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
}

227 228
static inline int pm_runtime_get(struct device *dev)
{
229
	return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
230 231 232 233
}

static inline int pm_runtime_get_sync(struct device *dev)
{
234
	return __pm_runtime_resume(dev, RPM_GET_PUT);
235 236 237 238
}

static inline int pm_runtime_put(struct device *dev)
{
239
	return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
240 241
}

242 243 244 245 246 247
static inline int pm_runtime_put_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev,
	    RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
}

248 249
static inline int pm_runtime_put_sync(struct device *dev)
{
250
	return __pm_runtime_idle(dev, RPM_GET_PUT);
251 252
}

253 254 255 256 257
static inline int pm_runtime_put_sync_suspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_GET_PUT);
}

258 259 260 261 262
static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
{
	return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
}

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
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);
}

278 279 280 281 282 283 284 285 286 287
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);
}

288
#endif