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