remove libdss from Makefile
[GitHub/moto-9609/android_kernel_motorola_exynos9610.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 /*
28ba086e 55 * CPUs execute ->enter_s2idle with the local tick or entire timekeeping
124cf911
RW
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 */
28ba086e 59 void (*enter_s2idle) (struct cpuidle_device *dev,
124cf911
RW
60 struct cpuidle_driver *drv,
61 int index);
4f86d3a8
LB
62};
63
64/* Idle State Flags */
9e9fc6f0 65#define CPUIDLE_FLAG_NONE (0x00)
dc2251bf 66#define CPUIDLE_FLAG_POLLING (0x01) /* polling state */
4126c019 67#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
b60e6a0e 68#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
4f86d3a8
LB
69
70#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
71
728ce22b 72struct cpuidle_device_kobj;
1a706438
DL
73struct cpuidle_state_kobj;
74struct cpuidle_driver_kobj;
728ce22b 75
4f86d3a8 76struct cpuidle_device {
dcb84f33 77 unsigned int registered:1;
b5556a67 78 unsigned int enabled:1;
bb8313b6 79 unsigned int use_deepest_state:1;
4f86d3a8
LB
80 unsigned int cpu;
81
82 int last_residency;
4202735e 83 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8 84 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
bf4d1b5d 85 struct cpuidle_driver_kobj *kobj_driver;
728ce22b 86 struct cpuidle_device_kobj *kobj_dev;
4f86d3a8 87 struct list_head device_list;
4126c019
CC
88
89#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
4126c019
CC
90 cpumask_t coupled_cpus;
91 struct cpuidle_coupled *coupled;
92#endif
4f86d3a8
LB
93};
94
95DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
f08dbf8a 96DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev);
4f86d3a8
LB
97
98/**
99 * cpuidle_get_last_residency - retrieves the last state's residency time
100 * @dev: the target CPU
4f86d3a8
LB
101 */
102static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
103{
104 return dev->last_residency;
105}
106
107
108/****************************
109 * CPUIDLE DRIVER INTERFACE *
110 ****************************/
111
112struct cpuidle_driver {
db70b044 113 const char *name;
4f86d3a8 114 struct module *owner;
42f67f2a 115 int refcnt;
46bcfad7 116
a06df062
DL
117 /* used by the cpuidle framework to setup the broadcast timer */
118 unsigned int bctimer:1;
8aef33a7 119 /* states array must be ordered in decreasing power consumption */
46bcfad7
DD
120 struct cpuidle_state states[CPUIDLE_STATE_MAX];
121 int state_count;
122 int safe_state_index;
82467a5a
DL
123
124 /* the driver handles the cpus in cpumask */
6587fca2 125 struct cpumask *cpumask;
4f86d3a8
LB
126};
127
128#ifdef CONFIG_CPU_IDLE
d91ee586 129extern void disable_cpuidle(void);
ef2b22ac
RW
130extern bool cpuidle_not_available(struct cpuidle_driver *drv,
131 struct cpuidle_device *dev);
907e30f1 132
907e30f1 133extern int cpuidle_select(struct cpuidle_driver *drv,
3a25735b
RW
134 struct cpuidle_device *dev,
135 bool *stop_tick);
907e30f1
DL
136extern int cpuidle_enter(struct cpuidle_driver *drv,
137 struct cpuidle_device *dev, int index);
138extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
139
4f86d3a8 140extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW
141extern struct cpuidle_driver *cpuidle_get_driver(void);
142extern struct cpuidle_driver *cpuidle_driver_ref(void);
143extern void cpuidle_driver_unref(void);
4f86d3a8
LB
144extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
145extern int cpuidle_register_device(struct cpuidle_device *dev);
146extern void cpuidle_unregister_device(struct cpuidle_device *dev);
4c637b21
DL
147extern int cpuidle_register(struct cpuidle_driver *drv,
148 const struct cpumask *const coupled_cpus);
149extern void cpuidle_unregister(struct cpuidle_driver *drv);
4f86d3a8
LB
150extern void cpuidle_pause_and_lock(void);
151extern void cpuidle_resume_and_unlock(void);
8651f97b
PM
152extern void cpuidle_pause(void);
153extern void cpuidle_resume(void);
4f86d3a8
LB
154extern int cpuidle_enable_device(struct cpuidle_device *dev);
155extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f
BO
156extern int cpuidle_play_dead(void);
157
bf4d1b5d 158extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
9bd616e3
CM
159static inline struct cpuidle_device *cpuidle_get_device(void)
160{return __this_cpu_read(cpuidle_devices); }
642a403b 161extern unsigned int cpuidle_get_target_residency(int cpu, int state);
4f86d3a8 162#else
d91ee586 163static inline void disable_cpuidle(void) { }
ef2b22ac
RW
164static inline bool cpuidle_not_available(struct cpuidle_driver *drv,
165 struct cpuidle_device *dev)
166{return true; }
907e30f1 167static inline int cpuidle_select(struct cpuidle_driver *drv,
3a25735b 168 struct cpuidle_device *dev, bool *stop_tick)
907e30f1
DL
169{return -ENODEV; }
170static inline int cpuidle_enter(struct cpuidle_driver *drv,
171 struct cpuidle_device *dev, int index)
172{return -ENODEV; }
173static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
4f86d3a8 174static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 175{return -ENODEV; }
752138df 176static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW
177static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
178static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB
179static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
180static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 181{return -ENODEV; }
4f86d3a8 182static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
4c637b21
DL
183static inline int cpuidle_register(struct cpuidle_driver *drv,
184 const struct cpumask *const coupled_cpus)
185{return -ENODEV; }
186static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
4f86d3a8
LB
187static inline void cpuidle_pause_and_lock(void) { }
188static inline void cpuidle_resume_and_unlock(void) { }
8651f97b
PM
189static inline void cpuidle_pause(void) { }
190static inline void cpuidle_resume(void) { }
4f86d3a8 191static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 192{return -ENODEV; }
4f86d3a8 193static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f 194static inline int cpuidle_play_dead(void) {return -ENODEV; }
87e9b9f1
RW
195static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
196 struct cpuidle_device *dev) {return NULL; }
9bd616e3 197static inline struct cpuidle_device *cpuidle_get_device(void) {return NULL; }
642a403b 198static inline unsigned int cpuidle_get_target_residency(int cpu, int state) {return UINT_MAX;}
87e9b9f1
RW
199#endif
200
bb8313b6 201#ifdef CONFIG_CPU_IDLE
87e9b9f1
RW
202extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
203 struct cpuidle_device *dev);
28ba086e 204extern int cpuidle_enter_s2idle(struct cpuidle_driver *drv,
87e9b9f1 205 struct cpuidle_device *dev);
bb8313b6 206extern void cpuidle_use_deepest_state(bool enable);
87e9b9f1 207#else
ef2b22ac
RW
208static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
209 struct cpuidle_device *dev)
210{return -ENODEV; }
28ba086e 211static inline int cpuidle_enter_s2idle(struct cpuidle_driver *drv,
ef2b22ac
RW
212 struct cpuidle_device *dev)
213{return -ENODEV; }
bb8313b6
JP
214static inline void cpuidle_use_deepest_state(bool enable)
215{
216}
4f86d3a8
LB
217#endif
218
faad3849 219/* kernel/sched/idle.c */
a732c974 220extern void sched_idle_set_state(struct cpuidle_state *idle_state, int index);
827a5aef 221extern void default_idle_call(void);
faad3849 222
20ff51a3
CC
223#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
224void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
c7a9b09b
AB
225#else
226static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
227{
228}
20ff51a3
CC
229#endif
230
e578fedb 231#if defined(CONFIG_CPU_IDLE) && defined(CONFIG_ARCH_HAS_CPU_RELAX)
1b39e3f8 232void cpuidle_poll_state_init(struct cpuidle_driver *drv);
34c2f65b 233#else
1b39e3f8 234static inline void cpuidle_poll_state_init(struct cpuidle_driver *drv) {}
34c2f65b
RW
235#endif
236
4f86d3a8
LB
237/******************************
238 * CPUIDLE GOVERNOR INTERFACE *
239 ******************************/
240
241struct cpuidle_governor {
242 char name[CPUIDLE_NAME_LEN];
243 struct list_head governor_list;
244 unsigned int rating;
245
46bcfad7
DD
246 int (*enable) (struct cpuidle_driver *drv,
247 struct cpuidle_device *dev);
248 void (*disable) (struct cpuidle_driver *drv,
249 struct cpuidle_device *dev);
4f86d3a8 250
46bcfad7 251 int (*select) (struct cpuidle_driver *drv,
3a25735b
RW
252 struct cpuidle_device *dev,
253 bool *stop_tick);
e978aa7d 254 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB
255};
256
257#ifdef CONFIG_CPU_IDLE
4f86d3a8 258extern int cpuidle_register_governor(struct cpuidle_governor *gov);
4f86d3a8 259#else
4f86d3a8
LB
260static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
261{return 0;}
4f86d3a8
LB
262#endif
263
220276e0
SH
264#define CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx) \
265({ \
266 int __ret; \
267 \
268 if (!idx) { \
269 cpu_do_idle(); \
270 return idx; \
271 } \
272 \
273 __ret = cpu_pm_enter(); \
274 if (!__ret) { \
275 __ret = low_level_idle_enter(idx); \
276 cpu_pm_exit(); \
277 } \
278 \
279 __ret ? -1 : idx; \
280})
281
4f86d3a8 282#endif /* _LINUX_CPUIDLE_H */