]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/cpuidle.h
UBUNTU: SAUCE: overlayfs: Skip permission checking for trusted.overlayfs.* xattrs
[mirror_ubuntu-artful-kernel.git] / include / linux / cpuidle.h
CommitLineData
4f86d3a8
LB
1/*
2 * cpuidle.h - a generic framework for CPU idle power management
3 *
4 * (C) 2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5 * Shaohua Li <shaohua.li@intel.com>
6 * Adam Belay <abelay@novell.com>
7 *
8 * This code is licenced under the GPL.
9 */
10
11#ifndef _LINUX_CPUIDLE_H
12#define _LINUX_CPUIDLE_H
13
14#include <linux/percpu.h>
15#include <linux/list.h>
e1689795 16#include <linux/hrtimer.h>
4f86d3a8 17
86239ceb 18#define CPUIDLE_STATE_MAX 10
4f86d3a8 19#define CPUIDLE_NAME_LEN 16
4fcb2fcd 20#define CPUIDLE_DESC_LEN 32
4f86d3a8 21
de477254
PG
22struct module;
23
4f86d3a8 24struct cpuidle_device;
46bcfad7 25struct cpuidle_driver;
4f86d3a8
LB
26
27
28/****************************
29 * CPUIDLE DEVICE INTERFACE *
30 ****************************/
31
4202735e 32struct cpuidle_state_usage {
dc7fd275 33 unsigned long long disable;
4202735e
DD
34 unsigned long long usage;
35 unsigned long long time; /* in US */
36};
37
4f86d3a8
LB
38struct cpuidle_state {
39 char name[CPUIDLE_NAME_LEN];
4fcb2fcd 40 char desc[CPUIDLE_DESC_LEN];
4f86d3a8
LB
41
42 unsigned int flags;
43 unsigned int exit_latency; /* in US */
02401c06 44 int power_usage; /* in mW */
4f86d3a8 45 unsigned int target_residency; /* in US */
cbc9ef02 46 bool disabled; /* disabled on all CPUs */
4f86d3a8 47
4f86d3a8 48 int (*enter) (struct cpuidle_device *dev,
46bcfad7 49 struct cpuidle_driver *drv,
e978aa7d 50 int index);
1a022e3f
BO
51
52 int (*enter_dead) (struct cpuidle_device *dev, int index);
124cf911
RW
53
54 /*
55 * CPUs execute ->enter_freeze with the local tick or entire timekeeping
56 * suspended, so it must not re-enable interrupts at any point (even
57 * temporarily) or attempt to change states of clock event devices.
58 */
59 void (*enter_freeze) (struct cpuidle_device *dev,
60 struct cpuidle_driver *drv,
61 int index);
4f86d3a8
LB
62};
63
64/* Idle State Flags */
9e9fc6f0 65#define CPUIDLE_FLAG_NONE (0x00)
4126c019 66#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
b60e6a0e 67#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
4f86d3a8
LB
68
69#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
70
728ce22b 71struct cpuidle_device_kobj;
1a706438
DL
72struct cpuidle_state_kobj;
73struct cpuidle_driver_kobj;
728ce22b 74
4f86d3a8 75struct cpuidle_device {
dcb84f33 76 unsigned int registered:1;
b5556a67 77 unsigned int enabled:1;
bb8313b6 78 unsigned int use_deepest_state:1;
4f86d3a8
LB
79 unsigned int cpu;
80
81 int last_residency;
4202735e 82 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8 83 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
bf4d1b5d 84 struct cpuidle_driver_kobj *kobj_driver;
728ce22b 85 struct cpuidle_device_kobj *kobj_dev;
4f86d3a8 86 struct list_head device_list;
4126c019
CC
87
88#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
4126c019
CC
89 cpumask_t coupled_cpus;
90 struct cpuidle_coupled *coupled;
91#endif
4f86d3a8
LB
92};
93
94DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
f08dbf8a 95DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev);
4f86d3a8
LB
96
97/**
98 * cpuidle_get_last_residency - retrieves the last state's residency time
99 * @dev: the target CPU
4f86d3a8
LB
100 */
101static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
102{
103 return dev->last_residency;
104}
105
106
107/****************************
108 * CPUIDLE DRIVER INTERFACE *
109 ****************************/
110
111struct cpuidle_driver {
db70b044 112 const char *name;
4f86d3a8 113 struct module *owner;
42f67f2a 114 int refcnt;
46bcfad7 115
a06df062
DL
116 /* used by the cpuidle framework to setup the broadcast timer */
117 unsigned int bctimer:1;
8aef33a7 118 /* states array must be ordered in decreasing power consumption */
46bcfad7
DD
119 struct cpuidle_state states[CPUIDLE_STATE_MAX];
120 int state_count;
121 int safe_state_index;
82467a5a
DL
122
123 /* the driver handles the cpus in cpumask */
6587fca2 124 struct cpumask *cpumask;
4f86d3a8
LB
125};
126
127#ifdef CONFIG_CPU_IDLE
d91ee586 128extern void disable_cpuidle(void);
ef2b22ac
RW
129extern bool cpuidle_not_available(struct cpuidle_driver *drv,
130 struct cpuidle_device *dev);
907e30f1 131
907e30f1
DL
132extern int cpuidle_select(struct cpuidle_driver *drv,
133 struct cpuidle_device *dev);
134extern int cpuidle_enter(struct cpuidle_driver *drv,
135 struct cpuidle_device *dev, int index);
136extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
137
4f86d3a8 138extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW
139extern struct cpuidle_driver *cpuidle_get_driver(void);
140extern struct cpuidle_driver *cpuidle_driver_ref(void);
141extern void cpuidle_driver_unref(void);
4f86d3a8
LB
142extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
143extern int cpuidle_register_device(struct cpuidle_device *dev);
144extern void cpuidle_unregister_device(struct cpuidle_device *dev);
4c637b21
DL
145extern int cpuidle_register(struct cpuidle_driver *drv,
146 const struct cpumask *const coupled_cpus);
147extern void cpuidle_unregister(struct cpuidle_driver *drv);
4f86d3a8
LB
148extern void cpuidle_pause_and_lock(void);
149extern void cpuidle_resume_and_unlock(void);
8651f97b
PM
150extern void cpuidle_pause(void);
151extern void cpuidle_resume(void);
4f86d3a8
LB
152extern int cpuidle_enable_device(struct cpuidle_device *dev);
153extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f
BO
154extern int cpuidle_play_dead(void);
155
bf4d1b5d 156extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
9bd616e3
CM
157static inline struct cpuidle_device *cpuidle_get_device(void)
158{return __this_cpu_read(cpuidle_devices); }
4f86d3a8 159#else
d91ee586 160static inline void disable_cpuidle(void) { }
ef2b22ac
RW
161static inline bool cpuidle_not_available(struct cpuidle_driver *drv,
162 struct cpuidle_device *dev)
163{return true; }
907e30f1
DL
164static inline int cpuidle_select(struct cpuidle_driver *drv,
165 struct cpuidle_device *dev)
166{return -ENODEV; }
167static inline int cpuidle_enter(struct cpuidle_driver *drv,
168 struct cpuidle_device *dev, int index)
169{return -ENODEV; }
170static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
4f86d3a8 171static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 172{return -ENODEV; }
752138df 173static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW
174static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
175static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB
176static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
177static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 178{return -ENODEV; }
4f86d3a8 179static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
4c637b21
DL
180static inline int cpuidle_register(struct cpuidle_driver *drv,
181 const struct cpumask *const coupled_cpus)
182{return -ENODEV; }
183static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
4f86d3a8
LB
184static inline void cpuidle_pause_and_lock(void) { }
185static inline void cpuidle_resume_and_unlock(void) { }
8651f97b
PM
186static inline void cpuidle_pause(void) { }
187static inline void cpuidle_resume(void) { }
4f86d3a8 188static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 189{return -ENODEV; }
4f86d3a8 190static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f 191static inline int cpuidle_play_dead(void) {return -ENODEV; }
87e9b9f1
RW
192static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
193 struct cpuidle_device *dev) {return NULL; }
9bd616e3 194static inline struct cpuidle_device *cpuidle_get_device(void) {return NULL; }
87e9b9f1
RW
195#endif
196
bb8313b6 197#ifdef CONFIG_CPU_IDLE
87e9b9f1
RW
198extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
199 struct cpuidle_device *dev);
200extern int cpuidle_enter_freeze(struct cpuidle_driver *drv,
201 struct cpuidle_device *dev);
bb8313b6 202extern void cpuidle_use_deepest_state(bool enable);
87e9b9f1 203#else
ef2b22ac
RW
204static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
205 struct cpuidle_device *dev)
206{return -ENODEV; }
207static inline int cpuidle_enter_freeze(struct cpuidle_driver *drv,
208 struct cpuidle_device *dev)
209{return -ENODEV; }
bb8313b6
JP
210static inline void cpuidle_use_deepest_state(bool enable)
211{
212}
4f86d3a8
LB
213#endif
214
faad3849
RW
215/* kernel/sched/idle.c */
216extern void sched_idle_set_state(struct cpuidle_state *idle_state);
827a5aef 217extern void default_idle_call(void);
faad3849 218
20ff51a3
CC
219#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
220void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
c7a9b09b
AB
221#else
222static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
223{
224}
20ff51a3
CC
225#endif
226
4f86d3a8
LB
227/******************************
228 * CPUIDLE GOVERNOR INTERFACE *
229 ******************************/
230
231struct cpuidle_governor {
232 char name[CPUIDLE_NAME_LEN];
233 struct list_head governor_list;
234 unsigned int rating;
235
46bcfad7
DD
236 int (*enable) (struct cpuidle_driver *drv,
237 struct cpuidle_device *dev);
238 void (*disable) (struct cpuidle_driver *drv,
239 struct cpuidle_device *dev);
4f86d3a8 240
46bcfad7
DD
241 int (*select) (struct cpuidle_driver *drv,
242 struct cpuidle_device *dev);
e978aa7d 243 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB
244};
245
246#ifdef CONFIG_CPU_IDLE
4f86d3a8 247extern int cpuidle_register_governor(struct cpuidle_governor *gov);
4f86d3a8 248#else
4f86d3a8
LB
249static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
250{return 0;}
4f86d3a8
LB
251#endif
252
9a0b8415 253#ifdef CONFIG_ARCH_HAS_CPU_RELAX
254#define CPUIDLE_DRIVER_STATE_START 1
255#else
256#define CPUIDLE_DRIVER_STATE_START 0
257#endif
258
220276e0
SH
259#define CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx) \
260({ \
261 int __ret; \
262 \
263 if (!idx) { \
264 cpu_do_idle(); \
265 return idx; \
266 } \
267 \
268 __ret = cpu_pm_enter(); \
269 if (!__ret) { \
270 __ret = low_level_idle_enter(idx); \
271 cpu_pm_exit(); \
272 } \
273 \
274 __ret ? -1 : idx; \
275})
276
4f86d3a8 277#endif /* _LINUX_CPUIDLE_H */