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