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