Commit | Line | Data |
---|---|---|
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 |
22 | struct module; |
23 | ||
4f86d3a8 | 24 | struct cpuidle_device; |
46bcfad7 | 25 | struct cpuidle_driver; |
4f86d3a8 LB |
26 | |
27 | ||
28 | /**************************** | |
29 | * CPUIDLE DEVICE INTERFACE * | |
30 | ****************************/ | |
31 | ||
4202735e | 32 | struct 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 |
38 | struct 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); | |
4f86d3a8 LB |
53 | }; |
54 | ||
55 | /* Idle State Flags */ | |
4126c019 | 56 | #define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */ |
b60e6a0e | 57 | #define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */ |
4f86d3a8 LB |
58 | |
59 | #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000) | |
60 | ||
728ce22b | 61 | struct cpuidle_device_kobj; |
1a706438 DL |
62 | struct cpuidle_state_kobj; |
63 | struct cpuidle_driver_kobj; | |
728ce22b | 64 | |
4f86d3a8 | 65 | struct cpuidle_device { |
dcb84f33 | 66 | unsigned int registered:1; |
b5556a67 | 67 | unsigned int enabled:1; |
4f86d3a8 LB |
68 | unsigned int cpu; |
69 | ||
70 | int last_residency; | |
71 | int state_count; | |
4202735e | 72 | struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX]; |
4f86d3a8 | 73 | struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX]; |
bf4d1b5d | 74 | struct cpuidle_driver_kobj *kobj_driver; |
728ce22b | 75 | struct cpuidle_device_kobj *kobj_dev; |
4f86d3a8 | 76 | struct list_head device_list; |
4126c019 CC |
77 | |
78 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED | |
79 | int safe_state_index; | |
80 | cpumask_t coupled_cpus; | |
81 | struct cpuidle_coupled *coupled; | |
82 | #endif | |
4f86d3a8 LB |
83 | }; |
84 | ||
85 | DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices); | |
f08dbf8a | 86 | DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev); |
4f86d3a8 LB |
87 | |
88 | /** | |
89 | * cpuidle_get_last_residency - retrieves the last state's residency time | |
90 | * @dev: the target CPU | |
4f86d3a8 LB |
91 | */ |
92 | static inline int cpuidle_get_last_residency(struct cpuidle_device *dev) | |
93 | { | |
94 | return dev->last_residency; | |
95 | } | |
96 | ||
97 | ||
98 | /**************************** | |
99 | * CPUIDLE DRIVER INTERFACE * | |
100 | ****************************/ | |
101 | ||
102 | struct cpuidle_driver { | |
db70b044 | 103 | const char *name; |
4f86d3a8 | 104 | struct module *owner; |
42f67f2a | 105 | int refcnt; |
46bcfad7 | 106 | |
a06df062 DL |
107 | /* used by the cpuidle framework to setup the broadcast timer */ |
108 | unsigned int bctimer:1; | |
8aef33a7 | 109 | /* states array must be ordered in decreasing power consumption */ |
46bcfad7 DD |
110 | struct cpuidle_state states[CPUIDLE_STATE_MAX]; |
111 | int state_count; | |
112 | int safe_state_index; | |
82467a5a DL |
113 | |
114 | /* the driver handles the cpus in cpumask */ | |
6587fca2 | 115 | struct cpumask *cpumask; |
4f86d3a8 LB |
116 | }; |
117 | ||
118 | #ifdef CONFIG_CPU_IDLE | |
d91ee586 | 119 | extern void disable_cpuidle(void); |
907e30f1 | 120 | |
907e30f1 DL |
121 | extern int cpuidle_select(struct cpuidle_driver *drv, |
122 | struct cpuidle_device *dev); | |
123 | extern int cpuidle_enter(struct cpuidle_driver *drv, | |
124 | struct cpuidle_device *dev, int index); | |
125 | extern void cpuidle_reflect(struct cpuidle_device *dev, int index); | |
126 | ||
4f86d3a8 | 127 | extern int cpuidle_register_driver(struct cpuidle_driver *drv); |
6e797a07 RW |
128 | extern struct cpuidle_driver *cpuidle_get_driver(void); |
129 | extern struct cpuidle_driver *cpuidle_driver_ref(void); | |
130 | extern void cpuidle_driver_unref(void); | |
4f86d3a8 LB |
131 | extern void cpuidle_unregister_driver(struct cpuidle_driver *drv); |
132 | extern int cpuidle_register_device(struct cpuidle_device *dev); | |
133 | extern void cpuidle_unregister_device(struct cpuidle_device *dev); | |
4c637b21 DL |
134 | extern int cpuidle_register(struct cpuidle_driver *drv, |
135 | const struct cpumask *const coupled_cpus); | |
136 | extern void cpuidle_unregister(struct cpuidle_driver *drv); | |
4f86d3a8 LB |
137 | extern void cpuidle_pause_and_lock(void); |
138 | extern void cpuidle_resume_and_unlock(void); | |
8651f97b PM |
139 | extern void cpuidle_pause(void); |
140 | extern void cpuidle_resume(void); | |
4f86d3a8 LB |
141 | extern int cpuidle_enable_device(struct cpuidle_device *dev); |
142 | extern void cpuidle_disable_device(struct cpuidle_device *dev); | |
1a022e3f | 143 | extern int cpuidle_play_dead(void); |
a6220fc1 | 144 | extern void cpuidle_use_deepest_state(bool enable); |
1a022e3f | 145 | |
bf4d1b5d | 146 | extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev); |
4f86d3a8 | 147 | #else |
d91ee586 | 148 | static inline void disable_cpuidle(void) { } |
907e30f1 DL |
149 | static inline int cpuidle_select(struct cpuidle_driver *drv, |
150 | struct cpuidle_device *dev) | |
151 | {return -ENODEV; } | |
152 | static inline int cpuidle_enter(struct cpuidle_driver *drv, | |
153 | struct cpuidle_device *dev, int index) | |
154 | {return -ENODEV; } | |
155 | static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { } | |
4f86d3a8 | 156 | static inline int cpuidle_register_driver(struct cpuidle_driver *drv) |
6b2c676b | 157 | {return -ENODEV; } |
752138df | 158 | static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; } |
6e797a07 RW |
159 | static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; } |
160 | static inline void cpuidle_driver_unref(void) {} | |
4f86d3a8 LB |
161 | static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { } |
162 | static inline int cpuidle_register_device(struct cpuidle_device *dev) | |
6b2c676b | 163 | {return -ENODEV; } |
4f86d3a8 | 164 | static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { } |
4c637b21 DL |
165 | static inline int cpuidle_register(struct cpuidle_driver *drv, |
166 | const struct cpumask *const coupled_cpus) | |
167 | {return -ENODEV; } | |
168 | static inline void cpuidle_unregister(struct cpuidle_driver *drv) { } | |
4f86d3a8 LB |
169 | static inline void cpuidle_pause_and_lock(void) { } |
170 | static inline void cpuidle_resume_and_unlock(void) { } | |
8651f97b PM |
171 | static inline void cpuidle_pause(void) { } |
172 | static inline void cpuidle_resume(void) { } | |
4f86d3a8 | 173 | static inline int cpuidle_enable_device(struct cpuidle_device *dev) |
6b2c676b | 174 | {return -ENODEV; } |
4f86d3a8 | 175 | static inline void cpuidle_disable_device(struct cpuidle_device *dev) { } |
1a022e3f | 176 | static inline int cpuidle_play_dead(void) {return -ENODEV; } |
a6220fc1 | 177 | static inline void cpuidle_use_deepest_state(bool enable) {} |
c8cc7d4d DL |
178 | static inline struct cpuidle_driver *cpuidle_get_cpu_driver( |
179 | struct cpuidle_device *dev) {return NULL; } | |
4f86d3a8 LB |
180 | #endif |
181 | ||
20ff51a3 CC |
182 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED |
183 | void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a); | |
c7a9b09b AB |
184 | #else |
185 | static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a) | |
186 | { | |
187 | } | |
20ff51a3 CC |
188 | #endif |
189 | ||
4f86d3a8 LB |
190 | /****************************** |
191 | * CPUIDLE GOVERNOR INTERFACE * | |
192 | ******************************/ | |
193 | ||
194 | struct cpuidle_governor { | |
195 | char name[CPUIDLE_NAME_LEN]; | |
196 | struct list_head governor_list; | |
197 | unsigned int rating; | |
198 | ||
46bcfad7 DD |
199 | int (*enable) (struct cpuidle_driver *drv, |
200 | struct cpuidle_device *dev); | |
201 | void (*disable) (struct cpuidle_driver *drv, | |
202 | struct cpuidle_device *dev); | |
4f86d3a8 | 203 | |
46bcfad7 DD |
204 | int (*select) (struct cpuidle_driver *drv, |
205 | struct cpuidle_device *dev); | |
e978aa7d | 206 | void (*reflect) (struct cpuidle_device *dev, int index); |
4f86d3a8 LB |
207 | |
208 | struct module *owner; | |
209 | }; | |
210 | ||
211 | #ifdef CONFIG_CPU_IDLE | |
4f86d3a8 | 212 | extern int cpuidle_register_governor(struct cpuidle_governor *gov); |
4f86d3a8 | 213 | #else |
4f86d3a8 LB |
214 | static inline int cpuidle_register_governor(struct cpuidle_governor *gov) |
215 | {return 0;} | |
4f86d3a8 LB |
216 | #endif |
217 | ||
9a0b8415 | 218 | #ifdef CONFIG_ARCH_HAS_CPU_RELAX |
219 | #define CPUIDLE_DRIVER_STATE_START 1 | |
220 | #else | |
221 | #define CPUIDLE_DRIVER_STATE_START 0 | |
222 | #endif | |
223 | ||
4f86d3a8 | 224 | #endif /* _LINUX_CPUIDLE_H */ |