1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __ACPI_PROCESSOR_H
3 #define __ACPI_PROCESSOR_H
5 #include <linux/kernel.h>
7 #include <linux/thermal.h>
10 #define ACPI_PROCESSOR_CLASS "processor"
11 #define ACPI_PROCESSOR_DEVICE_NAME "Processor"
12 #define ACPI_PROCESSOR_DEVICE_HID "ACPI0007"
13 #define ACPI_PROCESSOR_CONTAINER_HID "ACPI0010"
15 #define ACPI_PROCESSOR_BUSY_METRIC 10
17 #define ACPI_PROCESSOR_MAX_POWER 8
18 #define ACPI_PROCESSOR_MAX_C2_LATENCY 100
19 #define ACPI_PROCESSOR_MAX_C3_LATENCY 1000
21 #define ACPI_PROCESSOR_MAX_THROTTLING 16
22 #define ACPI_PROCESSOR_MAX_THROTTLE 250 /* 25% */
23 #define ACPI_PROCESSOR_MAX_DUTY_WIDTH 4
25 #define ACPI_PDC_REVISION_ID 0x1
27 #define ACPI_PSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
28 #define ACPI_PSD_REV0_ENTRIES 5
30 #define ACPI_TSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
31 #define ACPI_TSD_REV0_ENTRIES 5
33 * Types of coordination defined in ACPI 3.0. Same macros can be used across
36 #define DOMAIN_COORD_TYPE_SW_ALL 0xfc
37 #define DOMAIN_COORD_TYPE_SW_ANY 0xfd
38 #define DOMAIN_COORD_TYPE_HW_ALL 0xfe
40 #define ACPI_CSTATE_SYSTEMIO 0
41 #define ACPI_CSTATE_FFH 1
42 #define ACPI_CSTATE_HALT 2
43 #define ACPI_CSTATE_INTEGER 3
45 #define ACPI_CX_DESC_LEN 32
47 /* Power Management */
49 struct acpi_processor_cx;
51 struct acpi_power_register {
61 struct acpi_processor_cx {
69 char desc[ACPI_CX_DESC_LEN];
72 struct acpi_lpi_state {
74 u32 wake_latency; /* worst case */
78 u32 enable_parent_state;
82 char desc[ACPI_CX_DESC_LEN];
85 struct acpi_processor_power {
88 struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
89 struct acpi_lpi_state lpi_states[ACPI_PROCESSOR_MAX_POWER];
91 int timer_broadcast_on_state;
94 /* Performance Management */
96 struct acpi_psd_package {
104 struct acpi_pct_register {
114 struct acpi_processor_px {
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 */
123 struct acpi_processor_performance {
125 unsigned int platform_limit;
126 struct acpi_pct_register control_register;
127 struct acpi_pct_register status_register;
128 unsigned int state_count;
129 struct acpi_processor_px *states;
130 struct acpi_psd_package domain_info;
131 cpumask_var_t shared_cpu_map;
132 unsigned int shared_type;
135 /* Throttling Control */
137 struct acpi_tsd_package {
145 struct acpi_ptc_register {
155 struct acpi_processor_tx_tss {
156 u64 freqpercentage; /* */
157 u64 power; /* milliWatts */
158 u64 transition_latency; /* microseconds */
159 u64 control; /* control value */
160 u64 status; /* success indicator */
162 struct acpi_processor_tx {
167 struct acpi_processor;
168 struct acpi_processor_throttling {
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;
176 cpumask_var_t shared_cpu_map;
177 int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
178 int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
179 int state, bool force);
185 unsigned int shared_type;
186 struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
189 /* Limit Interface */
191 struct acpi_processor_lx {
192 int px; /* performance state */
193 int tx; /* throttle level */
196 struct acpi_processor_limit {
197 struct acpi_processor_lx state; /* current limit */
198 struct acpi_processor_lx thermal; /* thermal limit */
199 struct acpi_processor_lx user; /* user limit */
202 struct acpi_processor_flags {
211 u8 power_setup_done:1;
213 u8 need_hotplug_init:1;
216 struct acpi_processor {
219 phys_cpuid_t phys_id; /* CPU hardware ID such as APIC ID for x86 */
220 u32 id; /* CPU logical ID allocated by OS */
222 int performance_platform_limit;
223 int throttling_platform_limit;
224 /* 0 - states 0..n-th state available */
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;
231 struct thermal_cooling_device *cdev;
232 struct device *dev; /* Processor device. */
235 struct acpi_processor_errata {
245 extern int acpi_processor_preregister_performance(struct
246 acpi_processor_performance
247 __percpu *performance);
249 extern int acpi_processor_register_performance(struct acpi_processor_performance
250 *performance, unsigned int cpu);
251 extern void acpi_processor_unregister_performance(unsigned int cpu);
253 int acpi_processor_pstate_control(void);
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);
257 int acpi_processor_get_psd(acpi_handle handle,
258 struct acpi_psd_package *pdomain);
260 /* parsing the _P* objects. */
261 extern int acpi_processor_get_performance_info(struct acpi_processor *pr);
263 /* for communication between multiple parts of the processor kernel module */
264 DECLARE_PER_CPU(struct acpi_processor *, processors);
265 extern struct acpi_processor_errata errata;
267 #if defined(ARCH_HAS_POWER_INIT) && defined(CONFIG_ACPI_PROCESSOR_CSTATE)
268 void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
270 int acpi_processor_ffh_cstate_probe(unsigned int cpu,
271 struct acpi_processor_cx *cx,
272 struct acpi_power_register *reg);
273 void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
275 static inline void acpi_processor_power_init_bm_check(struct
277 *flags, unsigned int cpu)
282 static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
283 struct acpi_processor_cx *cx,
284 struct acpi_power_register
289 static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
296 static inline int call_on_cpu(int cpu, long (*fn)(void *), void *arg,
299 if (direct || (is_percpu_thread() && cpu == smp_processor_id()))
301 return work_on_cpu(cpu, fn, arg);
304 /* in processor_perflib.c */
306 #ifdef CONFIG_CPU_FREQ
307 void acpi_processor_ppc_init(void);
308 void acpi_processor_ppc_exit(void);
309 void acpi_processor_ppc_has_changed(struct acpi_processor *pr, int event_flag);
310 extern int acpi_processor_get_bios_limit(int cpu, unsigned int *limit);
312 static inline void acpi_processor_ppc_init(void)
316 static inline void acpi_processor_ppc_exit(void)
320 static inline void acpi_processor_ppc_has_changed(struct acpi_processor *pr,
323 static unsigned int printout = 1;
326 "Warning: Processor Platform Limit event detected, but not handled.\n");
328 "Consider compiling CPUfreq support into your kernel.\n");
332 static inline int acpi_processor_get_bios_limit(int cpu, unsigned int *limit)
337 #endif /* CONFIG_CPU_FREQ */
339 /* in processor_core.c */
340 phys_cpuid_t acpi_get_phys_id(acpi_handle, int type, u32 acpi_id);
341 phys_cpuid_t acpi_map_madt_entry(u32 acpi_id);
342 int acpi_map_cpuid(phys_cpuid_t phys_id, u32 acpi_id);
343 int acpi_get_cpuid(acpi_handle, int type, u32 acpi_id);
345 #ifdef CONFIG_ACPI_CPPC_LIB
346 extern int acpi_cppc_processor_probe(struct acpi_processor *pr);
347 extern void acpi_cppc_processor_exit(struct acpi_processor *pr);
349 static inline int acpi_cppc_processor_probe(struct acpi_processor *pr)
353 static inline void acpi_cppc_processor_exit(struct acpi_processor *pr)
357 #endif /* CONFIG_ACPI_CPPC_LIB */
359 /* in processor_pdc.c */
360 void acpi_processor_set_pdc(acpi_handle handle);
362 /* in processor_throttling.c */
363 #ifdef CONFIG_ACPI_CPU_FREQ_PSS
364 int acpi_processor_tstate_has_changed(struct acpi_processor *pr);
365 int acpi_processor_get_throttling_info(struct acpi_processor *pr);
366 extern int acpi_processor_set_throttling(struct acpi_processor *pr,
367 int state, bool force);
369 * Reevaluate whether the T-state is invalid after one cpu is
370 * onlined/offlined. In such case the flags.throttling will be updated.
372 extern void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
374 extern const struct file_operations acpi_processor_throttling_fops;
375 extern void acpi_processor_throttling_init(void);
377 static inline int acpi_processor_tstate_has_changed(struct acpi_processor *pr)
382 static inline int acpi_processor_get_throttling_info(struct acpi_processor *pr)
387 static inline int acpi_processor_set_throttling(struct acpi_processor *pr,
388 int state, bool force)
393 static inline void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
396 static inline void acpi_processor_throttling_init(void) {}
397 #endif /* CONFIG_ACPI_CPU_FREQ_PSS */
399 /* in processor_idle.c */
400 extern struct cpuidle_driver acpi_idle_driver;
401 #ifdef CONFIG_ACPI_PROCESSOR_IDLE
402 int acpi_processor_power_init(struct acpi_processor *pr);
403 int acpi_processor_power_exit(struct acpi_processor *pr);
404 int acpi_processor_power_state_has_changed(struct acpi_processor *pr);
405 int acpi_processor_hotplug(struct acpi_processor *pr);
407 static inline int acpi_processor_power_init(struct acpi_processor *pr)
412 static inline int acpi_processor_power_exit(struct acpi_processor *pr)
417 static inline int acpi_processor_power_state_has_changed(struct acpi_processor *pr)
422 static inline int acpi_processor_hotplug(struct acpi_processor *pr)
426 #endif /* CONFIG_ACPI_PROCESSOR_IDLE */
428 /* in processor_thermal.c */
429 int acpi_processor_get_limit_info(struct acpi_processor *pr);
430 extern const struct thermal_cooling_device_ops processor_cooling_ops;
431 #if defined(CONFIG_ACPI_CPU_FREQ_PSS) & defined(CONFIG_CPU_FREQ)
432 void acpi_thermal_cpufreq_init(void);
433 void acpi_thermal_cpufreq_exit(void);
435 static inline void acpi_thermal_cpufreq_init(void)
439 static inline void acpi_thermal_cpufreq_exit(void)
443 #endif /* CONFIG_ACPI_CPU_FREQ_PSS */