Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef __ACPI_PROCESSOR_H
2#define __ACPI_PROCESSOR_H
3
4#include <linux/kernel.h>
5#include <linux/cpu.h>
6#include <linux/cpuidle.h>
7#include <linux/thermal.h>
8#include <asm/acpi.h>
9
10#define ACPI_PROCESSOR_BUSY_METRIC 10
11
12#define ACPI_PROCESSOR_MAX_POWER 8
13#define ACPI_PROCESSOR_MAX_C2_LATENCY 100
14#define ACPI_PROCESSOR_MAX_C3_LATENCY 1000
15
16#define ACPI_PROCESSOR_MAX_THROTTLING 16
17#define ACPI_PROCESSOR_MAX_THROTTLE 250 /* 25% */
18#define ACPI_PROCESSOR_MAX_DUTY_WIDTH 4
19
20#define ACPI_PDC_REVISION_ID 0x1
21
22#define ACPI_PSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
23#define ACPI_PSD_REV0_ENTRIES 5
24
25#define ACPI_TSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
26#define ACPI_TSD_REV0_ENTRIES 5
27/*
28 * Types of coordination defined in ACPI 3.0. Same macros can be used across
29 * P, C and T states
30 */
31#define DOMAIN_COORD_TYPE_SW_ALL 0xfc
32#define DOMAIN_COORD_TYPE_SW_ANY 0xfd
33#define DOMAIN_COORD_TYPE_HW_ALL 0xfe
34
35#define ACPI_CSTATE_SYSTEMIO 0
36#define ACPI_CSTATE_FFH 1
37#define ACPI_CSTATE_HALT 2
38
39#define ACPI_CX_DESC_LEN 32
40
41/* Power Management */
42
43struct acpi_processor_cx;
44
45struct acpi_power_register {
46 u8 descriptor;
47 u16 length;
48 u8 space_id;
49 u8 bit_width;
50 u8 bit_offset;
51 u8 access_size;
52 u64 address;
53} __attribute__ ((packed));
54
55struct acpi_processor_cx {
56 u8 valid;
57 u8 type;
58 u32 address;
59 u8 entry_method;
60 u8 index;
61 u32 latency;
62 u32 power;
63 u8 bm_sts_skip;
64 char desc[ACPI_CX_DESC_LEN];
65};
66
67struct acpi_processor_power {
68 struct cpuidle_device dev;
69 struct acpi_processor_cx *state;
70 unsigned long bm_check_timestamp;
71 u32 default_state;
72 int count;
73 struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
74 int timer_broadcast_on_state;
75};
76
77/* Performance Management */
78
79struct acpi_psd_package {
80 u64 num_entries;
81 u64 revision;
82 u64 domain;
83 u64 coord_type;
84 u64 num_processors;
85} __attribute__ ((packed));
86
87struct acpi_pct_register {
88 u8 descriptor;
89 u16 length;
90 u8 space_id;
91 u8 bit_width;
92 u8 bit_offset;
93 u8 reserved;
94 u64 address;
95} __attribute__ ((packed));
96
97struct acpi_processor_px {
98 u64 core_frequency; /* megahertz */
99 u64 power; /* milliWatts */
100 u64 transition_latency; /* microseconds */
101 u64 bus_master_latency; /* microseconds */
102 u64 control; /* control value */
103 u64 status; /* success indicator */
104};
105
106struct acpi_processor_performance {
107 unsigned int state;
108 unsigned int platform_limit;
109 struct acpi_pct_register control_register;
110 struct acpi_pct_register status_register;
111 unsigned int state_count;
112 struct acpi_processor_px *states;
113 struct acpi_psd_package domain_info;
114 cpumask_var_t shared_cpu_map;
115 unsigned int shared_type;
116};
117
118/* Throttling Control */
119
120struct acpi_tsd_package {
121 u64 num_entries;
122 u64 revision;
123 u64 domain;
124 u64 coord_type;
125 u64 num_processors;
126} __attribute__ ((packed));
127
128struct acpi_ptc_register {
129 u8 descriptor;
130 u16 length;
131 u8 space_id;
132 u8 bit_width;
133 u8 bit_offset;
134 u8 reserved;
135 u64 address;
136} __attribute__ ((packed));
137
138struct acpi_processor_tx_tss {
139 u64 freqpercentage; /* */
140 u64 power; /* milliWatts */
141 u64 transition_latency; /* microseconds */
142 u64 control; /* control value */
143 u64 status; /* success indicator */
144};
145struct acpi_processor_tx {
146 u16 power;
147 u16 performance;
148};
149
150struct acpi_processor;
151struct acpi_processor_throttling {
152 unsigned int state;
153 unsigned int platform_limit;
154 struct acpi_pct_register control_register;
155 struct acpi_pct_register status_register;
156 unsigned int state_count;
157 struct acpi_processor_tx_tss *states_tss;
158 struct acpi_tsd_package domain_info;
159 cpumask_var_t shared_cpu_map;
160 int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
161 int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
162 int state, bool force);
163
164 u32 address;
165 u8 duty_offset;
166 u8 duty_width;
167 u8 tsd_valid_flag;
168 unsigned int shared_type;
169 struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
170};
171
172/* Limit Interface */
173
174struct acpi_processor_lx {
175 int px; /* performance state */
176 int tx; /* throttle level */
177};
178
179struct acpi_processor_limit {
180 struct acpi_processor_lx state; /* current limit */
181 struct acpi_processor_lx thermal; /* thermal limit */
182 struct acpi_processor_lx user; /* user limit */
183};
184
185struct acpi_processor_flags {
186 u8 power:1;
187 u8 performance:1;
188 u8 throttling:1;
189 u8 limit:1;
190 u8 bm_control:1;
191 u8 bm_check:1;
192 u8 has_cst:1;
193 u8 power_setup_done:1;
194 u8 bm_rld_set:1;
195 u8 need_hotplug_init:1;
196};
197
198struct acpi_processor {
199 acpi_handle handle;
200 u32 acpi_id;
201 u32 id;
202 u32 pblk;
203 int performance_platform_limit;
204 int throttling_platform_limit;
205 /* 0 - states 0..n-th state available */
206
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;
212 struct thermal_cooling_device *cdev;
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 void acpi_processor_load_module(struct acpi_processor *pr);
226extern int acpi_processor_preregister_performance(struct
227 acpi_processor_performance
228 __percpu *performance);
229
230extern int acpi_processor_register_performance(struct acpi_processor_performance
231 *performance, unsigned int cpu);
232extern void acpi_processor_unregister_performance(struct
233 acpi_processor_performance
234 *performance,
235 unsigned int cpu);
236
237/* note: this locks both the calling module and the processor module
238 if a _PPC object exists, rmmod is disallowed then */
239int acpi_processor_notify_smm(struct module *calling_module);
240
241/* for communication between multiple parts of the processor kernel module */
242DECLARE_PER_CPU(struct acpi_processor *, processors);
243extern struct acpi_processor_errata errata;
244
245#ifdef ARCH_HAS_POWER_INIT
246void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
247 unsigned int cpu);
248int acpi_processor_ffh_cstate_probe(unsigned int cpu,
249 struct acpi_processor_cx *cx,
250 struct acpi_power_register *reg);
251void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
252#else
253static inline void acpi_processor_power_init_bm_check(struct
254 acpi_processor_flags
255 *flags, unsigned int cpu)
256{
257 flags->bm_check = 1;
258 return;
259}
260static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
261 struct acpi_processor_cx *cx,
262 struct acpi_power_register
263 *reg)
264{
265 return -1;
266}
267static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
268 *cstate)
269{
270 return;
271}
272#endif
273
274/* in processor_perflib.c */
275
276#ifdef CONFIG_CPU_FREQ
277void acpi_processor_ppc_init(void);
278void acpi_processor_ppc_exit(void);
279int acpi_processor_ppc_has_changed(struct acpi_processor *pr, int event_flag);
280extern int acpi_processor_get_bios_limit(int cpu, unsigned int *limit);
281#else
282static inline void acpi_processor_ppc_init(void)
283{
284 return;
285}
286static inline void acpi_processor_ppc_exit(void)
287{
288 return;
289}
290static inline int acpi_processor_ppc_has_changed(struct acpi_processor *pr,
291 int event_flag)
292{
293 static unsigned int printout = 1;
294 if (printout) {
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");
299 printout = 0;
300 }
301 return 0;
302}
303static inline int acpi_processor_get_bios_limit(int cpu, unsigned int *limit)
304{
305 return -ENODEV;
306}
307
308#endif /* CONFIG_CPU_FREQ */
309
310/* in processor_core.c */
311void acpi_processor_set_pdc(acpi_handle handle);
312int acpi_get_cpuid(acpi_handle, int type, u32 acpi_id);
313
314/* in processor_throttling.c */
315int acpi_processor_tstate_has_changed(struct acpi_processor *pr);
316int acpi_processor_get_throttling_info(struct acpi_processor *pr);
317extern int acpi_processor_set_throttling(struct acpi_processor *pr,
318 int state, bool force);
319/*
320 * Reevaluate whether the T-state is invalid after one cpu is
321 * onlined/offlined. In such case the flags.throttling will be updated.
322 */
323extern void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
324 unsigned long action);
325extern const struct file_operations acpi_processor_throttling_fops;
326extern void acpi_processor_throttling_init(void);
327/* in processor_idle.c */
328int acpi_processor_power_init(struct acpi_processor *pr,
329 struct acpi_device *device);
330int acpi_processor_cst_has_changed(struct acpi_processor *pr);
331int acpi_processor_hotplug(struct acpi_processor *pr);
332int acpi_processor_power_exit(struct acpi_processor *pr,
333 struct acpi_device *device);
334int acpi_processor_suspend(struct device *dev);
335int acpi_processor_resume(struct device *dev);
336extern struct cpuidle_driver acpi_idle_driver;
337
338/* in processor_thermal.c */
339int acpi_processor_get_limit_info(struct acpi_processor *pr);
340extern const struct thermal_cooling_device_ops processor_cooling_ops;
341#ifdef CONFIG_CPU_FREQ
342void acpi_thermal_cpufreq_init(void);
343void acpi_thermal_cpufreq_exit(void);
344#else
345static inline void acpi_thermal_cpufreq_init(void)
346{
347 return;
348}
349static inline void acpi_thermal_cpufreq_exit(void)
350{
351 return;
352}
353#endif
354
355#endif