cpuidle: Single/Global registration of idle states
[linux-2.6.git] / include / linux / cpuidle.h
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>
16 #include <linux/module.h>
17 #include <linux/kobject.h>
18 #include <linux/completion.h>
19
20 #define CPUIDLE_STATE_MAX       8
21 #define CPUIDLE_NAME_LEN        16
22 #define CPUIDLE_DESC_LEN        32
23
24 struct cpuidle_device;
25 struct cpuidle_driver;
26
27
28 /****************************
29  * CPUIDLE DEVICE INTERFACE *
30  ****************************/
31
32 struct cpuidle_state_usage {
33         void            *driver_data;
34
35         unsigned long long      usage;
36         unsigned long long      time; /* in US */
37 };
38
39 struct cpuidle_state {
40         char            name[CPUIDLE_NAME_LEN];
41         char            desc[CPUIDLE_DESC_LEN];
42
43         unsigned int    flags;
44         unsigned int    exit_latency; /* in US */
45         unsigned int    power_usage; /* in mW */
46         unsigned int    target_residency; /* in US */
47
48         int (*enter)    (struct cpuidle_device *dev,
49                         struct cpuidle_driver *drv,
50                         int index);
51 };
52
53 /* Idle State Flags */
54 #define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
55
56 #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
57
58 /**
59  * cpuidle_get_statedata - retrieves private driver state data
60  * @st_usage: the state usage statistics
61  */
62 static inline void *cpuidle_get_statedata(struct cpuidle_state_usage *st_usage)
63 {
64         return st_usage->driver_data;
65 }
66
67 /**
68  * cpuidle_set_statedata - stores private driver state data
69  * @st_usage: the state usage statistics
70  * @data: the private data
71  */
72 static inline void
73 cpuidle_set_statedata(struct cpuidle_state_usage *st_usage, void *data)
74 {
75         st_usage->driver_data = data;
76 }
77
78 struct cpuidle_state_kobj {
79         struct cpuidle_state *state;
80         struct cpuidle_state_usage *state_usage;
81         struct completion kobj_unregister;
82         struct kobject kobj;
83 };
84
85 struct cpuidle_device {
86         unsigned int            registered:1;
87         unsigned int            enabled:1;
88         unsigned int            cpu;
89
90         int                     last_residency;
91         int                     state_count;
92         struct cpuidle_state_usage      states_usage[CPUIDLE_STATE_MAX];
93         struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
94
95         struct list_head        device_list;
96         struct kobject          kobj;
97         struct completion       kobj_unregister;
98         void                    *governor_data;
99 };
100
101 DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
102
103 /**
104  * cpuidle_get_last_residency - retrieves the last state's residency time
105  * @dev: the target CPU
106  *
107  * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
108  */
109 static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
110 {
111         return dev->last_residency;
112 }
113
114
115 /****************************
116  * CPUIDLE DRIVER INTERFACE *
117  ****************************/
118
119 struct cpuidle_driver {
120         char                    name[CPUIDLE_NAME_LEN];
121         struct module           *owner;
122
123         unsigned int            power_specified:1;
124         struct cpuidle_state    states[CPUIDLE_STATE_MAX];
125         int                     state_count;
126         int                     safe_state_index;
127 };
128
129 #ifdef CONFIG_CPU_IDLE
130 extern void disable_cpuidle(void);
131 extern int cpuidle_idle_call(void);
132
133 extern int cpuidle_register_driver(struct cpuidle_driver *drv);
134 struct cpuidle_driver *cpuidle_get_driver(void);
135 extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
136 extern int cpuidle_register_device(struct cpuidle_device *dev);
137 extern void cpuidle_unregister_device(struct cpuidle_device *dev);
138
139 extern void cpuidle_pause_and_lock(void);
140 extern void cpuidle_resume_and_unlock(void);
141 extern int cpuidle_enable_device(struct cpuidle_device *dev);
142 extern void cpuidle_disable_device(struct cpuidle_device *dev);
143
144 #else
145 static inline void disable_cpuidle(void) { }
146 static inline int cpuidle_idle_call(void) { return -ENODEV; }
147
148 static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
149 {return -ENODEV; }
150 static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
151 static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
152 static inline int cpuidle_register_device(struct cpuidle_device *dev)
153 {return -ENODEV; }
154 static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
155
156 static inline void cpuidle_pause_and_lock(void) { }
157 static inline void cpuidle_resume_and_unlock(void) { }
158 static inline int cpuidle_enable_device(struct cpuidle_device *dev)
159 {return -ENODEV; }
160 static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
161
162 #endif
163
164 /******************************
165  * CPUIDLE GOVERNOR INTERFACE *
166  ******************************/
167
168 struct cpuidle_governor {
169         char                    name[CPUIDLE_NAME_LEN];
170         struct list_head        governor_list;
171         unsigned int            rating;
172
173         int  (*enable)          (struct cpuidle_driver *drv,
174                                         struct cpuidle_device *dev);
175         void (*disable)         (struct cpuidle_driver *drv,
176                                         struct cpuidle_device *dev);
177
178         int  (*select)          (struct cpuidle_driver *drv,
179                                         struct cpuidle_device *dev);
180         void (*reflect)         (struct cpuidle_device *dev, int index);
181
182         struct module           *owner;
183 };
184
185 #ifdef CONFIG_CPU_IDLE
186
187 extern int cpuidle_register_governor(struct cpuidle_governor *gov);
188 extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
189
190 #else
191
192 static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
193 {return 0;}
194 static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
195
196 #endif
197
198 #ifdef CONFIG_ARCH_HAS_CPU_RELAX
199 #define CPUIDLE_DRIVER_STATE_START      1
200 #else
201 #define CPUIDLE_DRIVER_STATE_START      0
202 #endif
203
204 #endif /* _LINUX_CPUIDLE_H */