ACPI: Add weak routines for ACPI CPU Hotplug
[linux-2.6-block.git] / include / acpi / processor.h
CommitLineData
1da177e4
LT
1#ifndef __ACPI_PROCESSOR_H
2#define __ACPI_PROCESSOR_H
3
4#include <linux/kernel.h>
3b2d9942 5#include <linux/cpu.h>
d9460fd2 6#include <linux/thermal.h>
02df8b93
VP
7#include <asm/acpi.h>
8
ac212b69
RW
9#define ACPI_PROCESSOR_CLASS "processor"
10#define ACPI_PROCESSOR_DEVICE_NAME "Processor"
11#define ACPI_PROCESSOR_DEVICE_HID "ACPI0007"
12
1da177e4
LT
13#define ACPI_PROCESSOR_BUSY_METRIC 10
14
15#define ACPI_PROCESSOR_MAX_POWER 8
16#define ACPI_PROCESSOR_MAX_C2_LATENCY 100
17#define ACPI_PROCESSOR_MAX_C3_LATENCY 1000
18
19#define ACPI_PROCESSOR_MAX_THROTTLING 16
20#define ACPI_PROCESSOR_MAX_THROTTLE 250 /* 25% */
21#define ACPI_PROCESSOR_MAX_DUTY_WIDTH 4
22
02df8b93
VP
23#define ACPI_PDC_REVISION_ID 0x1
24
fd350943 25#define ACPI_PSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
3b2d9942
VP
26#define ACPI_PSD_REV0_ENTRIES 5
27
01854e69
LY
28#define ACPI_TSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
29#define ACPI_TSD_REV0_ENTRIES 5
3b2d9942
VP
30/*
31 * Types of coordination defined in ACPI 3.0. Same macros can be used across
32 * P, C and T states
33 */
34#define DOMAIN_COORD_TYPE_SW_ALL 0xfc
35#define DOMAIN_COORD_TYPE_SW_ANY 0xfd
36#define DOMAIN_COORD_TYPE_HW_ALL 0xfe
37
4fcb2fcd
VP
38#define ACPI_CSTATE_SYSTEMIO 0
39#define ACPI_CSTATE_FFH 1
40#define ACPI_CSTATE_HALT 2
41
42#define ACPI_CX_DESC_LEN 32
991528d7 43
1da177e4
LT
44/* Power Management */
45
46struct acpi_processor_cx;
47
48struct acpi_power_register {
4be44fcd
LB
49 u8 descriptor;
50 u16 length;
51 u8 space_id;
52 u8 bit_width;
53 u8 bit_offset;
718be4aa 54 u8 access_size;
4be44fcd 55 u64 address;
92c4d2ad 56} __packed;
1da177e4 57
1da177e4 58struct acpi_processor_cx {
4be44fcd
LB
59 u8 valid;
60 u8 type;
61 u32 address;
bc71bec9 62 u8 entry_method;
991528d7 63 u8 index;
4be44fcd 64 u32 latency;
718be4aa 65 u8 bm_sts_skip;
4fcb2fcd 66 char desc[ACPI_CX_DESC_LEN];
1da177e4
LT
67};
68
69struct acpi_processor_power {
4be44fcd 70 int count;
1da177e4 71 struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
169a0abb 72 int timer_broadcast_on_state;
1da177e4
LT
73};
74
75/* Performance Management */
76
3b2d9942 77struct acpi_psd_package {
439913ff
LM
78 u64 num_entries;
79 u64 revision;
80 u64 domain;
81 u64 coord_type;
82 u64 num_processors;
92c4d2ad 83} __packed;
3b2d9942 84
1da177e4 85struct acpi_pct_register {
4be44fcd
LB
86 u8 descriptor;
87 u16 length;
88 u8 space_id;
89 u8 bit_width;
90 u8 bit_offset;
91 u8 reserved;
92 u64 address;
92c4d2ad 93} __packed;
1da177e4
LT
94
95struct acpi_processor_px {
439913ff
LM
96 u64 core_frequency; /* megahertz */
97 u64 power; /* milliWatts */
98 u64 transition_latency; /* microseconds */
99 u64 bus_master_latency; /* microseconds */
100 u64 control; /* control value */
101 u64 status; /* success indicator */
1da177e4
LT
102};
103
1da177e4 104struct acpi_processor_performance {
4be44fcd
LB
105 unsigned int state;
106 unsigned int platform_limit;
1da177e4
LT
107 struct acpi_pct_register control_register;
108 struct acpi_pct_register status_register;
4be44fcd 109 unsigned int state_count;
1da177e4 110 struct acpi_processor_px *states;
3b2d9942 111 struct acpi_psd_package domain_info;
2fdf66b4 112 cpumask_var_t shared_cpu_map;
3b2d9942 113 unsigned int shared_type;
1da177e4
LT
114};
115
1da177e4
LT
116/* Throttling Control */
117
01854e69 118struct acpi_tsd_package {
439913ff
LM
119 u64 num_entries;
120 u64 revision;
121 u64 domain;
122 u64 coord_type;
123 u64 num_processors;
92c4d2ad 124} __packed;
01854e69
LY
125
126struct acpi_ptc_register {
127 u8 descriptor;
128 u16 length;
129 u8 space_id;
130 u8 bit_width;
131 u8 bit_offset;
132 u8 reserved;
133 u64 address;
92c4d2ad 134} __packed;
01854e69
LY
135
136struct acpi_processor_tx_tss {
439913ff
LM
137 u64 freqpercentage; /* */
138 u64 power; /* milliWatts */
139 u64 transition_latency; /* microseconds */
140 u64 control; /* control value */
141 u64 status; /* success indicator */
01854e69 142};
1da177e4 143struct acpi_processor_tx {
4be44fcd
LB
144 u16 power;
145 u16 performance;
1da177e4
LT
146};
147
01854e69 148struct acpi_processor;
1da177e4 149struct acpi_processor_throttling {
01854e69
LY
150 unsigned int state;
151 unsigned int platform_limit;
152 struct acpi_pct_register control_register;
153 struct acpi_pct_register status_register;
154 unsigned int state_count;
155 struct acpi_processor_tx_tss *states_tss;
156 struct acpi_tsd_package domain_info;
2fdf66b4 157 cpumask_var_t shared_cpu_map;
ff55a9ce
LB
158 int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
159 int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
2a908002 160 int state, bool force);
01854e69 161
4be44fcd
LB
162 u32 address;
163 u8 duty_offset;
164 u8 duty_width;
1180509f
ZY
165 u8 tsd_valid_flag;
166 unsigned int shared_type;
1da177e4
LT
167 struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
168};
169
170/* Limit Interface */
171
172struct acpi_processor_lx {
aee07ba6 173 int px; /* performance state */
4be44fcd 174 int tx; /* throttle level */
1da177e4
LT
175};
176
177struct acpi_processor_limit {
4be44fcd 178 struct acpi_processor_lx state; /* current limit */
1da177e4 179 struct acpi_processor_lx thermal; /* thermal limit */
4be44fcd 180 struct acpi_processor_lx user; /* user limit */
1da177e4
LT
181};
182
1da177e4 183struct acpi_processor_flags {
4be44fcd
LB
184 u8 power:1;
185 u8 performance:1;
186 u8 throttling:1;
187 u8 limit:1;
188 u8 bm_control:1;
189 u8 bm_check:1;
190 u8 has_cst:1;
191 u8 power_setup_done:1;
4f86d3a8 192 u8 bm_rld_set:1;
99b72508 193 u8 need_hotplug_init:1;
1da177e4
LT
194};
195
196struct acpi_processor {
4be44fcd
LB
197 acpi_handle handle;
198 u32 acpi_id;
828aef37 199 phys_cpuid_t phys_id; /* CPU hardware ID such as APIC ID for x86 */
af8f3f51 200 u32 id; /* CPU logical ID allocated by OS */
4be44fcd
LB
201 u32 pblk;
202 int performance_platform_limit;
01854e69 203 int throttling_platform_limit;
ff55a9ce 204 /* 0 - states 0..n-th state available */
01854e69 205
1da177e4
LT
206 struct acpi_processor_flags flags;
207 struct acpi_processor_power power;
208 struct acpi_processor_performance *performance;
209 struct acpi_processor_throttling throttling;
210 struct acpi_processor_limit limit;
d9460fd2 211 struct thermal_cooling_device *cdev;
ac212b69 212 struct device *dev; /* Processor device. */
1da177e4
LT
213};
214
215struct acpi_processor_errata {
4be44fcd 216 u8 smp;
1da177e4 217 struct {
4be44fcd
LB
218 u8 throttle:1;
219 u8 fdma:1;
220 u8 reserved:6;
221 u32 bmisx;
222 } piix4;
1da177e4
LT
223};
224
fd350943
LB
225extern int acpi_processor_preregister_performance(struct
226 acpi_processor_performance
a29d8b8e 227 __percpu *performance);
3b2d9942 228
4be44fcd
LB
229extern int acpi_processor_register_performance(struct acpi_processor_performance
230 *performance, unsigned int cpu);
b2f8dc4c 231extern void acpi_processor_unregister_performance(unsigned int cpu);
1da177e4
LT
232
233/* note: this locks both the calling module and the processor module
234 if a _PPC object exists, rmmod is disallowed then */
235int acpi_processor_notify_smm(struct module *calling_module);
236
c705c78c
KRW
237/* parsing the _P* objects. */
238extern int acpi_processor_get_performance_info(struct acpi_processor *pr);
239
1da177e4 240/* for communication between multiple parts of the processor kernel module */
706546d0 241DECLARE_PER_CPU(struct acpi_processor *, processors);
1da177e4
LT
242extern struct acpi_processor_errata errata;
243
05131ecc 244#ifdef ARCH_HAS_POWER_INIT
02df8b93 245void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
4be44fcd 246 unsigned int cpu);
991528d7 247int acpi_processor_ffh_cstate_probe(unsigned int cpu,
fd350943
LB
248 struct acpi_processor_cx *cx,
249 struct acpi_power_register *reg);
991528d7 250void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
02df8b93 251#else
4be44fcd
LB
252static inline void acpi_processor_power_init_bm_check(struct
253 acpi_processor_flags
254 *flags, unsigned int cpu)
02df8b93
VP
255{
256 flags->bm_check = 1;
257 return;
258}
991528d7 259static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
fd350943
LB
260 struct acpi_processor_cx *cx,
261 struct acpi_power_register
262 *reg)
991528d7
VP
263{
264 return -1;
265}
fd350943
LB
266static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
267 *cstate)
991528d7
VP
268{
269 return;
270}
02df8b93
VP
271#endif
272
1da177e4 273/* in processor_perflib.c */
02df8b93 274
1da177e4
LT
275#ifdef CONFIG_CPU_FREQ
276void acpi_processor_ppc_init(void);
277void acpi_processor_ppc_exit(void);
d81c45e1 278int acpi_processor_ppc_has_changed(struct acpi_processor *pr, int event_flag);
e2f74f35 279extern int acpi_processor_get_bios_limit(int cpu, unsigned int *limit);
1da177e4 280#else
4be44fcd
LB
281static inline void acpi_processor_ppc_init(void)
282{
283 return;
284}
285static inline void acpi_processor_ppc_exit(void)
286{
287 return;
288}
d81c45e1
ZY
289static inline int acpi_processor_ppc_has_changed(struct acpi_processor *pr,
290 int event_flag)
4be44fcd 291{
1da177e4
LT
292 static unsigned int printout = 1;
293 if (printout) {
4be44fcd
LB
294 printk(KERN_WARNING
295 "Warning: Processor Platform Limit event detected, but not handled.\n");
296 printk(KERN_WARNING
297 "Consider compiling CPUfreq support into your kernel.\n");
1da177e4
LT
298 printout = 0;
299 }
300 return 0;
301}
e2f74f35
TR
302static inline int acpi_processor_get_bios_limit(int cpu, unsigned int *limit)
303{
304 return -ENODEV;
305}
306
4be44fcd 307#endif /* CONFIG_CPU_FREQ */
1da177e4 308
4d5d4cd8 309/* in processor_core.c */
828aef37
CM
310phys_cpuid_t acpi_get_phys_id(acpi_handle, int type, u32 acpi_id);
311int acpi_map_cpuid(phys_cpuid_t phys_id, u32 acpi_id);
2e9d5e4e 312int acpi_get_cpuid(acpi_handle, int type, u32 acpi_id);
78f16996 313
24119a88
HG
314/* in processor_pdc.c */
315void acpi_processor_set_pdc(acpi_handle handle);
316
1da177e4 317/* in processor_throttling.c */
239708a3 318#ifdef CONFIG_ACPI_CPU_FREQ_PSS
a66b34b2 319int acpi_processor_tstate_has_changed(struct acpi_processor *pr);
4be44fcd 320int acpi_processor_get_throttling_info(struct acpi_processor *pr);
2a908002
FP
321extern int acpi_processor_set_throttling(struct acpi_processor *pr,
322 int state, bool force);
5a344a50
ZY
323/*
324 * Reevaluate whether the T-state is invalid after one cpu is
325 * onlined/offlined. In such case the flags.throttling will be updated.
326 */
327extern void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
328 unsigned long action);
070d8eb1 329extern const struct file_operations acpi_processor_throttling_fops;
1180509f 330extern void acpi_processor_throttling_init(void);
239708a3
AC
331#else
332static inline int acpi_processor_tstate_has_changed(struct acpi_processor *pr)
333{
334 return 0;
335}
336
337static inline int acpi_processor_get_throttling_info(struct acpi_processor *pr)
338{
339 return -ENODEV;
340}
341
342static inline int acpi_processor_set_throttling(struct acpi_processor *pr,
343 int state, bool force)
344{
345 return -ENODEV;
346}
347
348static inline void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
349 unsigned long action) {}
350
351static inline void acpi_processor_throttling_init(void) {}
352#endif /* CONFIG_ACPI_CPU_FREQ_PSS */
353
1da177e4 354/* in processor_idle.c */
5f05586c
AC
355extern struct cpuidle_driver acpi_idle_driver;
356#ifdef CONFIG_ACPI_PROCESSOR_IDLE
38a991b6
DL
357int acpi_processor_power_init(struct acpi_processor *pr);
358int acpi_processor_power_exit(struct acpi_processor *pr);
4be44fcd 359int acpi_processor_cst_has_changed(struct acpi_processor *pr);
46bcfad7 360int acpi_processor_hotplug(struct acpi_processor *pr);
5f05586c
AC
361#else
362static inline int acpi_processor_power_init(struct acpi_processor *pr)
363{
364 return -ENODEV;
365}
366
367static inline int acpi_processor_power_exit(struct acpi_processor *pr)
368{
369 return -ENODEV;
370}
371
372static inline int acpi_processor_cst_has_changed(struct acpi_processor *pr)
373{
374 return -ENODEV;
375}
376
377static inline int acpi_processor_hotplug(struct acpi_processor *pr)
378{
379 return -ENODEV;
380}
381#endif /* CONFIG_ACPI_PROCESSOR_IDLE */
1da177e4 382
5f05586c 383#if defined(CONFIG_PM_SLEEP) & defined(CONFIG_ACPI_PROCESSOR_IDLE)
0a3b15ac
RW
384void acpi_processor_syscore_init(void);
385void acpi_processor_syscore_exit(void);
386#else
387static inline void acpi_processor_syscore_init(void) {}
388static inline void acpi_processor_syscore_exit(void) {}
389#endif
390
1da177e4 391/* in processor_thermal.c */
4be44fcd 392int acpi_processor_get_limit_info(struct acpi_processor *pr);
9c8b04be 393extern const struct thermal_cooling_device_ops processor_cooling_ops;
239708a3 394#if defined(CONFIG_ACPI_CPU_FREQ_PSS) & defined(CONFIG_CPU_FREQ)
1da177e4
LT
395void acpi_thermal_cpufreq_init(void);
396void acpi_thermal_cpufreq_exit(void);
397#else
4be44fcd
LB
398static inline void acpi_thermal_cpufreq_init(void)
399{
400 return;
401}
402static inline void acpi_thermal_cpufreq_exit(void)
403{
404 return;
405}
239708a3 406#endif /* CONFIG_ACPI_CPU_FREQ_PSS */
1da177e4 407
1da177e4 408#endif