0c75a0b9c565f3e82d0125734d92a36710b79f97
[linux-2.6.git] / include / acpi / processor.h
1 #ifndef __ACPI_PROCESSOR_H
2 #define __ACPI_PROCESSOR_H
3
4 #include <linux/kernel.h>
5 #include <linux/cpu.h>
6 #include <linux/cpuidle.h>
7 #include <linux/thermal.h>
8 #include <asm/acpi.h>
9
10 #define ACPI_PROCESSOR_BUSY_METRIC      10
11
12 #define ACPI_PROCESSOR_MAX_POWER        8
13 #define ACPI_PROCESSOR_MAX_C2_LATENCY   100
14 #define ACPI_PROCESSOR_MAX_C3_LATENCY   1000
15
16 #define ACPI_PROCESSOR_MAX_THROTTLING   16
17 #define ACPI_PROCESSOR_MAX_THROTTLE     250     /* 25% */
18 #define ACPI_PROCESSOR_MAX_DUTY_WIDTH   4
19
20 #define ACPI_PDC_REVISION_ID            0x1
21
22 #define ACPI_PSD_REV0_REVISION          0       /* Support for _PSD as in ACPI 3.0 */
23 #define ACPI_PSD_REV0_ENTRIES           5
24
25 #define ACPI_TSD_REV0_REVISION          0       /* Support for _PSD as in ACPI 3.0 */
26 #define ACPI_TSD_REV0_ENTRIES           5
27 /*
28  * Types of coordination defined in ACPI 3.0. Same macros can be used across
29  * P, C and T states
30  */
31 #define DOMAIN_COORD_TYPE_SW_ALL        0xfc
32 #define DOMAIN_COORD_TYPE_SW_ANY        0xfd
33 #define DOMAIN_COORD_TYPE_HW_ALL        0xfe
34
35 #define ACPI_CSTATE_SYSTEMIO    (0)
36 #define ACPI_CSTATE_FFH         (1)
37 #define ACPI_CSTATE_HALT        (2)
38
39 /* Power Management */
40
41 struct acpi_processor_cx;
42
43 struct acpi_power_register {
44         u8 descriptor;
45         u16 length;
46         u8 space_id;
47         u8 bit_width;
48         u8 bit_offset;
49         u8 reserved;
50         u64 address;
51 } __attribute__ ((packed));
52
53 struct acpi_processor_cx_policy {
54         u32 count;
55         struct acpi_processor_cx *state;
56         struct {
57                 u32 time;
58                 u32 ticks;
59                 u32 count;
60                 u32 bm;
61         } threshold;
62 };
63
64 struct acpi_processor_cx {
65         u8 valid;
66         u8 type;
67         u32 address;
68         u8 entry_method;
69         u8 index;
70         u32 latency;
71         u32 latency_ticks;
72         u32 power;
73         u32 usage;
74         u64 time;
75         struct acpi_processor_cx_policy promotion;
76         struct acpi_processor_cx_policy demotion;
77 };
78
79 struct acpi_processor_power {
80         struct cpuidle_device dev;
81         struct acpi_processor_cx *state;
82         unsigned long bm_check_timestamp;
83         u32 default_state;
84         u32 bm_activity;
85         int count;
86         struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
87         int timer_broadcast_on_state;
88 };
89
90 /* Performance Management */
91
92 struct acpi_psd_package {
93         acpi_integer num_entries;
94         acpi_integer revision;
95         acpi_integer domain;
96         acpi_integer coord_type;
97         acpi_integer num_processors;
98 } __attribute__ ((packed));
99
100 struct acpi_pct_register {
101         u8 descriptor;
102         u16 length;
103         u8 space_id;
104         u8 bit_width;
105         u8 bit_offset;
106         u8 reserved;
107         u64 address;
108 } __attribute__ ((packed));
109
110 struct acpi_processor_px {
111         acpi_integer core_frequency;    /* megahertz */
112         acpi_integer power;     /* milliWatts */
113         acpi_integer transition_latency;        /* microseconds */
114         acpi_integer bus_master_latency;        /* microseconds */
115         acpi_integer control;   /* control value */
116         acpi_integer status;    /* success indicator */
117 };
118
119 struct acpi_processor_performance {
120         unsigned int state;
121         unsigned int platform_limit;
122         struct acpi_pct_register control_register;
123         struct acpi_pct_register status_register;
124         unsigned int state_count;
125         struct acpi_processor_px *states;
126         struct acpi_psd_package domain_info;
127         cpumask_t shared_cpu_map;
128         unsigned int shared_type;
129 };
130
131 /* Throttling Control */
132
133 struct acpi_tsd_package {
134         acpi_integer num_entries;
135         acpi_integer revision;
136         acpi_integer domain;
137         acpi_integer coord_type;
138         acpi_integer num_processors;
139 } __attribute__ ((packed));
140
141 struct acpi_ptc_register {
142         u8 descriptor;
143         u16 length;
144         u8 space_id;
145         u8 bit_width;
146         u8 bit_offset;
147         u8 reserved;
148         u64 address;
149 } __attribute__ ((packed));
150
151 struct acpi_processor_tx_tss {
152         acpi_integer freqpercentage;    /* */
153         acpi_integer power;     /* milliWatts */
154         acpi_integer transition_latency;        /* microseconds */
155         acpi_integer control;   /* control value */
156         acpi_integer status;    /* success indicator */
157 };
158 struct acpi_processor_tx {
159         u16 power;
160         u16 performance;
161 };
162
163 struct acpi_processor;
164 struct acpi_processor_throttling {
165         unsigned int state;
166         unsigned int platform_limit;
167         struct acpi_pct_register control_register;
168         struct acpi_pct_register status_register;
169         unsigned int state_count;
170         struct acpi_processor_tx_tss *states_tss;
171         struct acpi_tsd_package domain_info;
172         cpumask_t shared_cpu_map;
173         int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
174         int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
175                                               int state);
176
177         u32 address;
178         u8 duty_offset;
179         u8 duty_width;
180         struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
181 };
182
183 /* Limit Interface */
184
185 struct acpi_processor_lx {
186         int px;                 /* performance state */
187         int tx;                 /* throttle level */
188 };
189
190 struct acpi_processor_limit {
191         struct acpi_processor_lx state; /* current limit */
192         struct acpi_processor_lx thermal;       /* thermal limit */
193         struct acpi_processor_lx user;  /* user limit */
194 };
195
196 struct acpi_processor_flags {
197         u8 power:1;
198         u8 performance:1;
199         u8 throttling:1;
200         u8 limit:1;
201         u8 bm_control:1;
202         u8 bm_check:1;
203         u8 has_cst:1;
204         u8 power_setup_done:1;
205         u8 bm_rld_set:1;
206 };
207
208 struct acpi_processor {
209         acpi_handle handle;
210         u32 acpi_id;
211         u32 id;
212         u32 pblk;
213         int performance_platform_limit;
214         int throttling_platform_limit;
215         /* 0 - states 0..n-th state available */
216
217         struct acpi_processor_flags flags;
218         struct acpi_processor_power power;
219         struct acpi_processor_performance *performance;
220         struct acpi_processor_throttling throttling;
221         struct acpi_processor_limit limit;
222         struct thermal_cooling_device *cdev;
223         /* the _PDC objects for this processor, if any */
224         struct acpi_object_list *pdc;
225 };
226
227 struct acpi_processor_errata {
228         u8 smp;
229         struct {
230                 u8 throttle:1;
231                 u8 fdma:1;
232                 u8 reserved:6;
233                 u32 bmisx;
234         } piix4;
235 };
236
237 extern int acpi_processor_preregister_performance(struct
238                                                   acpi_processor_performance
239                                                   *performance);
240
241 extern int acpi_processor_register_performance(struct acpi_processor_performance
242                                                *performance, unsigned int cpu);
243 extern void acpi_processor_unregister_performance(struct
244                                                   acpi_processor_performance
245                                                   *performance,
246                                                   unsigned int cpu);
247
248 /* note: this locks both the calling module and the processor module
249          if a _PPC object exists, rmmod is disallowed then */
250 int acpi_processor_notify_smm(struct module *calling_module);
251
252 /* for communication between multiple parts of the processor kernel module */
253 extern struct acpi_processor *processors[NR_CPUS];
254 extern struct acpi_processor_errata errata;
255
256 void arch_acpi_processor_init_pdc(struct acpi_processor *pr);
257
258 #ifdef ARCH_HAS_POWER_INIT
259 void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
260                                         unsigned int cpu);
261 int acpi_processor_ffh_cstate_probe(unsigned int cpu,
262                                     struct acpi_processor_cx *cx,
263                                     struct acpi_power_register *reg);
264 void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
265 #else
266 static inline void acpi_processor_power_init_bm_check(struct
267                                                       acpi_processor_flags
268                                                       *flags, unsigned int cpu)
269 {
270         flags->bm_check = 1;
271         return;
272 }
273 static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
274                                                   struct acpi_processor_cx *cx,
275                                                   struct acpi_power_register
276                                                   *reg)
277 {
278         return -1;
279 }
280 static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
281                                                    *cstate)
282 {
283         return;
284 }
285 #endif
286
287 /* in processor_perflib.c */
288
289 #ifdef CONFIG_CPU_FREQ
290 void acpi_processor_ppc_init(void);
291 void acpi_processor_ppc_exit(void);
292 int acpi_processor_ppc_has_changed(struct acpi_processor *pr);
293 #else
294 static inline void acpi_processor_ppc_init(void)
295 {
296         return;
297 }
298 static inline void acpi_processor_ppc_exit(void)
299 {
300         return;
301 }
302 static inline int acpi_processor_ppc_has_changed(struct acpi_processor *pr)
303 {
304         static unsigned int printout = 1;
305         if (printout) {
306                 printk(KERN_WARNING
307                        "Warning: Processor Platform Limit event detected, but not handled.\n");
308                 printk(KERN_WARNING
309                        "Consider compiling CPUfreq support into your kernel.\n");
310                 printout = 0;
311         }
312         return 0;
313 }
314 #endif                          /* CONFIG_CPU_FREQ */
315
316 /* in processor_throttling.c */
317 int acpi_processor_get_throttling_info(struct acpi_processor *pr);
318 extern int acpi_processor_set_throttling(struct acpi_processor *pr, int state);
319 extern struct file_operations acpi_processor_throttling_fops;
320
321 /* in processor_idle.c */
322 int acpi_processor_power_init(struct acpi_processor *pr,
323                               struct acpi_device *device);
324 int acpi_processor_cst_has_changed(struct acpi_processor *pr);
325 int acpi_processor_power_exit(struct acpi_processor *pr,
326                               struct acpi_device *device);
327 int acpi_processor_suspend(struct acpi_device * device, pm_message_t state);
328 int acpi_processor_resume(struct acpi_device * device);
329 extern struct cpuidle_driver acpi_idle_driver;
330
331 /* in processor_thermal.c */
332 int acpi_processor_get_limit_info(struct acpi_processor *pr);
333 extern struct file_operations acpi_processor_limit_fops;
334 extern struct thermal_cooling_device_ops processor_cooling_ops;
335 #ifdef CONFIG_CPU_FREQ
336 void acpi_thermal_cpufreq_init(void);
337 void acpi_thermal_cpufreq_exit(void);
338 #else
339 static inline void acpi_thermal_cpufreq_init(void)
340 {
341         return;
342 }
343 static inline void acpi_thermal_cpufreq_exit(void)
344 {
345         return;
346 }
347 #endif
348
349 #endif