ACPI: Add weak routines for ACPI CPU Hotplug
[linux-2.6-block.git] / include / acpi / processor.h
... / ...
CommitLineData
1#ifndef __ACPI_PROCESSOR_H
2#define __ACPI_PROCESSOR_H
3
4#include <linux/kernel.h>
5#include <linux/cpu.h>
6#include <linux/thermal.h>
7#include <asm/acpi.h>
8
9#define ACPI_PROCESSOR_CLASS "processor"
10#define ACPI_PROCESSOR_DEVICE_NAME "Processor"
11#define ACPI_PROCESSOR_DEVICE_HID "ACPI0007"
12
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
23#define ACPI_PDC_REVISION_ID 0x1
24
25#define ACPI_PSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
26#define ACPI_PSD_REV0_ENTRIES 5
27
28#define ACPI_TSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
29#define ACPI_TSD_REV0_ENTRIES 5
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
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
43
44/* Power Management */
45
46struct acpi_processor_cx;
47
48struct acpi_power_register {
49 u8 descriptor;
50 u16 length;
51 u8 space_id;
52 u8 bit_width;
53 u8 bit_offset;
54 u8 access_size;
55 u64 address;
56} __packed;
57
58struct acpi_processor_cx {
59 u8 valid;
60 u8 type;
61 u32 address;
62 u8 entry_method;
63 u8 index;
64 u32 latency;
65 u8 bm_sts_skip;
66 char desc[ACPI_CX_DESC_LEN];
67};
68
69struct acpi_processor_power {
70 int count;
71 struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
72 int timer_broadcast_on_state;
73};
74
75/* Performance Management */
76
77struct acpi_psd_package {
78 u64 num_entries;
79 u64 revision;
80 u64 domain;
81 u64 coord_type;
82 u64 num_processors;
83} __packed;
84
85struct acpi_pct_register {
86 u8 descriptor;
87 u16 length;
88 u8 space_id;
89 u8 bit_width;
90 u8 bit_offset;
91 u8 reserved;
92 u64 address;
93} __packed;
94
95struct acpi_processor_px {
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 */
102};
103
104struct acpi_processor_performance {
105 unsigned int state;
106 unsigned int platform_limit;
107 struct acpi_pct_register control_register;
108 struct acpi_pct_register status_register;
109 unsigned int state_count;
110 struct acpi_processor_px *states;
111 struct acpi_psd_package domain_info;
112 cpumask_var_t shared_cpu_map;
113 unsigned int shared_type;
114};
115
116/* Throttling Control */
117
118struct acpi_tsd_package {
119 u64 num_entries;
120 u64 revision;
121 u64 domain;
122 u64 coord_type;
123 u64 num_processors;
124} __packed;
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;
134} __packed;
135
136struct acpi_processor_tx_tss {
137 u64 freqpercentage; /* */
138 u64 power; /* milliWatts */
139 u64 transition_latency; /* microseconds */
140 u64 control; /* control value */
141 u64 status; /* success indicator */
142};
143struct acpi_processor_tx {
144 u16 power;
145 u16 performance;
146};
147
148struct acpi_processor;
149struct acpi_processor_throttling {
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;
157 cpumask_var_t shared_cpu_map;
158 int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
159 int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
160 int state, bool force);
161
162 u32 address;
163 u8 duty_offset;
164 u8 duty_width;
165 u8 tsd_valid_flag;
166 unsigned int shared_type;
167 struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
168};
169
170/* Limit Interface */
171
172struct acpi_processor_lx {
173 int px; /* performance state */
174 int tx; /* throttle level */
175};
176
177struct acpi_processor_limit {
178 struct acpi_processor_lx state; /* current limit */
179 struct acpi_processor_lx thermal; /* thermal limit */
180 struct acpi_processor_lx user; /* user limit */
181};
182
183struct acpi_processor_flags {
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;
192 u8 bm_rld_set:1;
193 u8 need_hotplug_init:1;
194};
195
196struct acpi_processor {
197 acpi_handle handle;
198 u32 acpi_id;
199 phys_cpuid_t phys_id; /* CPU hardware ID such as APIC ID for x86 */
200 u32 id; /* CPU logical ID allocated by OS */
201 u32 pblk;
202 int performance_platform_limit;
203 int throttling_platform_limit;
204 /* 0 - states 0..n-th state available */
205
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;
211 struct thermal_cooling_device *cdev;
212 struct device *dev; /* Processor device. */
213};
214
215struct acpi_processor_errata {
216 u8 smp;
217 struct {
218 u8 throttle:1;
219 u8 fdma:1;
220 u8 reserved:6;
221 u32 bmisx;
222 } piix4;
223};
224
225extern int acpi_processor_preregister_performance(struct
226 acpi_processor_performance
227 __percpu *performance);
228
229extern int acpi_processor_register_performance(struct acpi_processor_performance
230 *performance, unsigned int cpu);
231extern void acpi_processor_unregister_performance(unsigned int cpu);
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
237/* parsing the _P* objects. */
238extern int acpi_processor_get_performance_info(struct acpi_processor *pr);
239
240/* for communication between multiple parts of the processor kernel module */
241DECLARE_PER_CPU(struct acpi_processor *, processors);
242extern struct acpi_processor_errata errata;
243
244#ifdef ARCH_HAS_POWER_INIT
245void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
246 unsigned int cpu);
247int acpi_processor_ffh_cstate_probe(unsigned int cpu,
248 struct acpi_processor_cx *cx,
249 struct acpi_power_register *reg);
250void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
251#else
252static inline void acpi_processor_power_init_bm_check(struct
253 acpi_processor_flags
254 *flags, unsigned int cpu)
255{
256 flags->bm_check = 1;
257 return;
258}
259static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
260 struct acpi_processor_cx *cx,
261 struct acpi_power_register
262 *reg)
263{
264 return -1;
265}
266static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
267 *cstate)
268{
269 return;
270}
271#endif
272
273/* in processor_perflib.c */
274
275#ifdef CONFIG_CPU_FREQ
276void acpi_processor_ppc_init(void);
277void acpi_processor_ppc_exit(void);
278int acpi_processor_ppc_has_changed(struct acpi_processor *pr, int event_flag);
279extern int acpi_processor_get_bios_limit(int cpu, unsigned int *limit);
280#else
281static inline void acpi_processor_ppc_init(void)
282{
283 return;
284}
285static inline void acpi_processor_ppc_exit(void)
286{
287 return;
288}
289static inline int acpi_processor_ppc_has_changed(struct acpi_processor *pr,
290 int event_flag)
291{
292 static unsigned int printout = 1;
293 if (printout) {
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");
298 printout = 0;
299 }
300 return 0;
301}
302static inline int acpi_processor_get_bios_limit(int cpu, unsigned int *limit)
303{
304 return -ENODEV;
305}
306
307#endif /* CONFIG_CPU_FREQ */
308
309/* in processor_core.c */
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);
312int acpi_get_cpuid(acpi_handle, int type, u32 acpi_id);
313
314/* in processor_pdc.c */
315void acpi_processor_set_pdc(acpi_handle handle);
316
317/* in processor_throttling.c */
318#ifdef CONFIG_ACPI_CPU_FREQ_PSS
319int acpi_processor_tstate_has_changed(struct acpi_processor *pr);
320int acpi_processor_get_throttling_info(struct acpi_processor *pr);
321extern int acpi_processor_set_throttling(struct acpi_processor *pr,
322 int state, bool force);
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);
329extern const struct file_operations acpi_processor_throttling_fops;
330extern void acpi_processor_throttling_init(void);
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
354/* in processor_idle.c */
355extern struct cpuidle_driver acpi_idle_driver;
356#ifdef CONFIG_ACPI_PROCESSOR_IDLE
357int acpi_processor_power_init(struct acpi_processor *pr);
358int acpi_processor_power_exit(struct acpi_processor *pr);
359int acpi_processor_cst_has_changed(struct acpi_processor *pr);
360int acpi_processor_hotplug(struct acpi_processor *pr);
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 */
382
383#if defined(CONFIG_PM_SLEEP) & defined(CONFIG_ACPI_PROCESSOR_IDLE)
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
391/* in processor_thermal.c */
392int acpi_processor_get_limit_info(struct acpi_processor *pr);
393extern const struct thermal_cooling_device_ops processor_cooling_ops;
394#if defined(CONFIG_ACPI_CPU_FREQ_PSS) & defined(CONFIG_CPU_FREQ)
395void acpi_thermal_cpufreq_init(void);
396void acpi_thermal_cpufreq_exit(void);
397#else
398static inline void acpi_thermal_cpufreq_init(void)
399{
400 return;
401}
402static inline void acpi_thermal_cpufreq_exit(void)
403{
404 return;
405}
406#endif /* CONFIG_ACPI_CPU_FREQ_PSS */
407
408#endif