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> | |
4f86d3a8 LB |
16 | #include <linux/kobject.h> |
17 | #include <linux/completion.h> | |
e1689795 | 18 | #include <linux/hrtimer.h> |
4f86d3a8 | 19 | |
86239ceb | 20 | #define CPUIDLE_STATE_MAX 10 |
4f86d3a8 | 21 | #define CPUIDLE_NAME_LEN 16 |
4fcb2fcd | 22 | #define CPUIDLE_DESC_LEN 32 |
4f86d3a8 | 23 | |
de477254 PG |
24 | struct module; |
25 | ||
4f86d3a8 | 26 | struct cpuidle_device; |
46bcfad7 | 27 | struct cpuidle_driver; |
4f86d3a8 LB |
28 | |
29 | ||
30 | /**************************** | |
31 | * CPUIDLE DEVICE INTERFACE * | |
32 | ****************************/ | |
33 | ||
4202735e | 34 | struct cpuidle_state_usage { |
dc7fd275 | 35 | unsigned long long disable; |
4202735e DD |
36 | unsigned long long usage; |
37 | unsigned long long time; /* in US */ | |
38 | }; | |
39 | ||
4f86d3a8 LB |
40 | struct cpuidle_state { |
41 | char name[CPUIDLE_NAME_LEN]; | |
4fcb2fcd | 42 | char desc[CPUIDLE_DESC_LEN]; |
4f86d3a8 LB |
43 | |
44 | unsigned int flags; | |
45 | unsigned int exit_latency; /* in US */ | |
02401c06 | 46 | int power_usage; /* in mW */ |
4f86d3a8 | 47 | unsigned int target_residency; /* in US */ |
cbc9ef02 | 48 | bool disabled; /* disabled on all CPUs */ |
4f86d3a8 | 49 | |
4f86d3a8 | 50 | int (*enter) (struct cpuidle_device *dev, |
46bcfad7 | 51 | struct cpuidle_driver *drv, |
e978aa7d | 52 | int index); |
1a022e3f BO |
53 | |
54 | int (*enter_dead) (struct cpuidle_device *dev, int index); | |
4f86d3a8 LB |
55 | }; |
56 | ||
57 | /* Idle State Flags */ | |
58 | #define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */ | |
4126c019 | 59 | #define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */ |
b60e6a0e | 60 | #define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */ |
4f86d3a8 LB |
61 | |
62 | #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000) | |
63 | ||
4f86d3a8 | 64 | struct cpuidle_device { |
dcb84f33 | 65 | unsigned int registered:1; |
b5556a67 | 66 | unsigned int enabled:1; |
4f86d3a8 LB |
67 | unsigned int cpu; |
68 | ||
69 | int last_residency; | |
70 | int state_count; | |
4202735e | 71 | struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX]; |
4f86d3a8 | 72 | struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX]; |
bf4d1b5d | 73 | struct cpuidle_driver_kobj *kobj_driver; |
4f86d3a8 LB |
74 | struct list_head device_list; |
75 | struct kobject kobj; | |
76 | struct completion kobj_unregister; | |
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); | |
86 | ||
87 | /** | |
88 | * cpuidle_get_last_residency - retrieves the last state's residency time | |
89 | * @dev: the target CPU | |
90 | * | |
91 | * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set | |
92 | */ | |
93 | static inline int cpuidle_get_last_residency(struct cpuidle_device *dev) | |
94 | { | |
95 | return dev->last_residency; | |
96 | } | |
97 | ||
98 | ||
99 | /**************************** | |
100 | * CPUIDLE DRIVER INTERFACE * | |
101 | ****************************/ | |
102 | ||
103 | struct cpuidle_driver { | |
db70b044 | 104 | const char *name; |
4f86d3a8 | 105 | struct module *owner; |
42f67f2a | 106 | int refcnt; |
46bcfad7 | 107 | |
a06df062 DL |
108 | /* used by the cpuidle framework to setup the broadcast timer */ |
109 | unsigned int bctimer:1; | |
8aef33a7 | 110 | /* states array must be ordered in decreasing power consumption */ |
46bcfad7 DD |
111 | struct cpuidle_state states[CPUIDLE_STATE_MAX]; |
112 | int state_count; | |
113 | int safe_state_index; | |
82467a5a DL |
114 | |
115 | /* the driver handles the cpus in cpumask */ | |
116 | struct cpumask *cpumask; | |
4f86d3a8 LB |
117 | }; |
118 | ||
119 | #ifdef CONFIG_CPU_IDLE | |
d91ee586 | 120 | extern void disable_cpuidle(void); |
a0bfa137 | 121 | extern int cpuidle_idle_call(void); |
4f86d3a8 | 122 | extern int cpuidle_register_driver(struct cpuidle_driver *drv); |
6e797a07 RW |
123 | extern struct cpuidle_driver *cpuidle_get_driver(void); |
124 | extern struct cpuidle_driver *cpuidle_driver_ref(void); | |
125 | extern void cpuidle_driver_unref(void); | |
4f86d3a8 LB |
126 | extern void cpuidle_unregister_driver(struct cpuidle_driver *drv); |
127 | extern int cpuidle_register_device(struct cpuidle_device *dev); | |
128 | extern void cpuidle_unregister_device(struct cpuidle_device *dev); | |
4c637b21 DL |
129 | extern int cpuidle_register(struct cpuidle_driver *drv, |
130 | const struct cpumask *const coupled_cpus); | |
131 | extern void cpuidle_unregister(struct cpuidle_driver *drv); | |
4f86d3a8 LB |
132 | extern void cpuidle_pause_and_lock(void); |
133 | extern void cpuidle_resume_and_unlock(void); | |
8651f97b PM |
134 | extern void cpuidle_pause(void); |
135 | extern void cpuidle_resume(void); | |
4f86d3a8 LB |
136 | extern int cpuidle_enable_device(struct cpuidle_device *dev); |
137 | extern void cpuidle_disable_device(struct cpuidle_device *dev); | |
1a022e3f BO |
138 | extern int cpuidle_play_dead(void); |
139 | ||
bf4d1b5d | 140 | extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev); |
4f86d3a8 | 141 | #else |
d91ee586 | 142 | static inline void disable_cpuidle(void) { } |
a0bfa137 | 143 | static inline int cpuidle_idle_call(void) { return -ENODEV; } |
4f86d3a8 | 144 | static inline int cpuidle_register_driver(struct cpuidle_driver *drv) |
6b2c676b | 145 | {return -ENODEV; } |
752138df | 146 | static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; } |
6e797a07 RW |
147 | static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; } |
148 | static inline void cpuidle_driver_unref(void) {} | |
4f86d3a8 LB |
149 | static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { } |
150 | static inline int cpuidle_register_device(struct cpuidle_device *dev) | |
6b2c676b | 151 | {return -ENODEV; } |
4f86d3a8 | 152 | static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { } |
4c637b21 DL |
153 | static inline int cpuidle_register(struct cpuidle_driver *drv, |
154 | const struct cpumask *const coupled_cpus) | |
155 | {return -ENODEV; } | |
156 | static inline void cpuidle_unregister(struct cpuidle_driver *drv) { } | |
4f86d3a8 LB |
157 | static inline void cpuidle_pause_and_lock(void) { } |
158 | static inline void cpuidle_resume_and_unlock(void) { } | |
8651f97b PM |
159 | static inline void cpuidle_pause(void) { } |
160 | static inline void cpuidle_resume(void) { } | |
4f86d3a8 | 161 | static inline int cpuidle_enable_device(struct cpuidle_device *dev) |
6b2c676b | 162 | {return -ENODEV; } |
4f86d3a8 | 163 | static inline void cpuidle_disable_device(struct cpuidle_device *dev) { } |
1a022e3f | 164 | static inline int cpuidle_play_dead(void) {return -ENODEV; } |
4f86d3a8 LB |
165 | #endif |
166 | ||
20ff51a3 CC |
167 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED |
168 | void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a); | |
c7a9b09b AB |
169 | #else |
170 | static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a) | |
171 | { | |
172 | } | |
20ff51a3 CC |
173 | #endif |
174 | ||
4f86d3a8 LB |
175 | /****************************** |
176 | * CPUIDLE GOVERNOR INTERFACE * | |
177 | ******************************/ | |
178 | ||
179 | struct cpuidle_governor { | |
180 | char name[CPUIDLE_NAME_LEN]; | |
181 | struct list_head governor_list; | |
182 | unsigned int rating; | |
183 | ||
46bcfad7 DD |
184 | int (*enable) (struct cpuidle_driver *drv, |
185 | struct cpuidle_device *dev); | |
186 | void (*disable) (struct cpuidle_driver *drv, | |
187 | struct cpuidle_device *dev); | |
4f86d3a8 | 188 | |
46bcfad7 DD |
189 | int (*select) (struct cpuidle_driver *drv, |
190 | struct cpuidle_device *dev); | |
e978aa7d | 191 | void (*reflect) (struct cpuidle_device *dev, int index); |
4f86d3a8 LB |
192 | |
193 | struct module *owner; | |
194 | }; | |
195 | ||
196 | #ifdef CONFIG_CPU_IDLE | |
197 | ||
198 | extern int cpuidle_register_governor(struct cpuidle_governor *gov); | |
199 | extern void cpuidle_unregister_governor(struct cpuidle_governor *gov); | |
200 | ||
201 | #else | |
202 | ||
203 | static inline int cpuidle_register_governor(struct cpuidle_governor *gov) | |
204 | {return 0;} | |
205 | static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { } | |
206 | ||
207 | #endif | |
208 | ||
9a0b8415 | 209 | #ifdef CONFIG_ARCH_HAS_CPU_RELAX |
210 | #define CPUIDLE_DRIVER_STATE_START 1 | |
211 | #else | |
212 | #define CPUIDLE_DRIVER_STATE_START 0 | |
213 | #endif | |
214 | ||
4f86d3a8 | 215 | #endif /* _LINUX_CPUIDLE_H */ |