xref: /linux/include/acpi/processor.h (revision ed3174d93c342b8b2eeba6bbd124707d55304a7b)
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 /* Power Management */
40 
41 struct acpi_processor_cx;
42 
43 struct acpi_power_register {
44 	u8 descriptor;
45 	u16 length;
46 	u8 space_id;
47 	u8 bit_width;
48 	u8 bit_offset;
49 	u8 reserved;
50 	u64 address;
51 } __attribute__ ((packed));
52 
53 struct acpi_processor_cx_policy {
54 	u32 count;
55 	struct acpi_processor_cx *state;
56 	struct {
57 		u32 time;
58 		u32 ticks;
59 		u32 count;
60 		u32 bm;
61 	} threshold;
62 };
63 
64 struct acpi_processor_cx {
65 	u8 valid;
66 	u8 type;
67 	u32 address;
68 	u8 entry_method;
69 	u8 index;
70 	u32 latency;
71 	u32 latency_ticks;
72 	u32 power;
73 	u32 usage;
74 	u64 time;
75 	struct acpi_processor_cx_policy promotion;
76 	struct acpi_processor_cx_policy demotion;
77 };
78 
79 struct acpi_processor_power {
80 	struct cpuidle_device dev;
81 	struct acpi_processor_cx *state;
82 	unsigned long bm_check_timestamp;
83 	u32 default_state;
84 	u32 bm_activity;
85 	int count;
86 	struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
87 	int timer_broadcast_on_state;
88 };
89 
90 /* Performance Management */
91 
92 struct acpi_psd_package {
93 	acpi_integer num_entries;
94 	acpi_integer revision;
95 	acpi_integer domain;
96 	acpi_integer coord_type;
97 	acpi_integer num_processors;
98 } __attribute__ ((packed));
99 
100 struct acpi_pct_register {
101 	u8 descriptor;
102 	u16 length;
103 	u8 space_id;
104 	u8 bit_width;
105 	u8 bit_offset;
106 	u8 reserved;
107 	u64 address;
108 } __attribute__ ((packed));
109 
110 struct acpi_processor_px {
111 	acpi_integer core_frequency;	/* megahertz */
112 	acpi_integer power;	/* milliWatts */
113 	acpi_integer transition_latency;	/* microseconds */
114 	acpi_integer bus_master_latency;	/* microseconds */
115 	acpi_integer control;	/* control value */
116 	acpi_integer status;	/* success indicator */
117 };
118 
119 struct acpi_processor_performance {
120 	unsigned int state;
121 	unsigned int platform_limit;
122 	struct acpi_pct_register control_register;
123 	struct acpi_pct_register status_register;
124 	unsigned int state_count;
125 	struct acpi_processor_px *states;
126 	struct acpi_psd_package domain_info;
127 	cpumask_t shared_cpu_map;
128 	unsigned int shared_type;
129 };
130 
131 /* Throttling Control */
132 
133 struct acpi_tsd_package {
134 	acpi_integer num_entries;
135 	acpi_integer revision;
136 	acpi_integer domain;
137 	acpi_integer coord_type;
138 	acpi_integer num_processors;
139 } __attribute__ ((packed));
140 
141 struct acpi_ptc_register {
142 	u8 descriptor;
143 	u16 length;
144 	u8 space_id;
145 	u8 bit_width;
146 	u8 bit_offset;
147 	u8 reserved;
148 	u64 address;
149 } __attribute__ ((packed));
150 
151 struct acpi_processor_tx_tss {
152 	acpi_integer freqpercentage;	/* */
153 	acpi_integer power;	/* milliWatts */
154 	acpi_integer transition_latency;	/* microseconds */
155 	acpi_integer control;	/* control value */
156 	acpi_integer status;	/* success indicator */
157 };
158 struct acpi_processor_tx {
159 	u16 power;
160 	u16 performance;
161 };
162 
163 struct acpi_processor;
164 struct acpi_processor_throttling {
165 	unsigned int state;
166 	unsigned int platform_limit;
167 	struct acpi_pct_register control_register;
168 	struct acpi_pct_register status_register;
169 	unsigned int state_count;
170 	struct acpi_processor_tx_tss *states_tss;
171 	struct acpi_tsd_package domain_info;
172 	cpumask_t shared_cpu_map;
173 	int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
174 	int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
175 					      int state);
176 
177 	u32 address;
178 	u8 duty_offset;
179 	u8 duty_width;
180 	u8 tsd_valid_flag;
181 	unsigned int shared_type;
182 	struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
183 };
184 
185 /* Limit Interface */
186 
187 struct acpi_processor_lx {
188 	int px;			/* performance state */
189 	int tx;			/* throttle level */
190 };
191 
192 struct acpi_processor_limit {
193 	struct acpi_processor_lx state;	/* current limit */
194 	struct acpi_processor_lx thermal;	/* thermal limit */
195 	struct acpi_processor_lx user;	/* user limit */
196 };
197 
198 struct acpi_processor_flags {
199 	u8 power:1;
200 	u8 performance:1;
201 	u8 throttling:1;
202 	u8 limit:1;
203 	u8 bm_control:1;
204 	u8 bm_check:1;
205 	u8 has_cst:1;
206 	u8 power_setup_done:1;
207 	u8 bm_rld_set:1;
208 };
209 
210 struct acpi_processor {
211 	acpi_handle handle;
212 	u32 acpi_id;
213 	u32 id;
214 	u32 pblk;
215 	int performance_platform_limit;
216 	int throttling_platform_limit;
217 	/* 0 - states 0..n-th state available */
218 
219 	struct acpi_processor_flags flags;
220 	struct acpi_processor_power power;
221 	struct acpi_processor_performance *performance;
222 	struct acpi_processor_throttling throttling;
223 	struct acpi_processor_limit limit;
224 	struct thermal_cooling_device *cdev;
225 	/* the _PDC objects for this processor, if any */
226 	struct acpi_object_list *pdc;
227 };
228 
229 struct acpi_processor_errata {
230 	u8 smp;
231 	struct {
232 		u8 throttle:1;
233 		u8 fdma:1;
234 		u8 reserved:6;
235 		u32 bmisx;
236 	} piix4;
237 };
238 
239 extern int acpi_processor_preregister_performance(struct
240 						  acpi_processor_performance
241 						  *performance);
242 
243 extern int acpi_processor_register_performance(struct acpi_processor_performance
244 					       *performance, unsigned int cpu);
245 extern void acpi_processor_unregister_performance(struct
246 						  acpi_processor_performance
247 						  *performance,
248 						  unsigned int cpu);
249 
250 /* note: this locks both the calling module and the processor module
251          if a _PPC object exists, rmmod is disallowed then */
252 int acpi_processor_notify_smm(struct module *calling_module);
253 
254 /* for communication between multiple parts of the processor kernel module */
255 extern struct acpi_processor *processors[NR_CPUS];
256 extern struct acpi_processor_errata errata;
257 
258 void arch_acpi_processor_init_pdc(struct acpi_processor *pr);
259 
260 #ifdef ARCH_HAS_POWER_INIT
261 void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
262 					unsigned int cpu);
263 int acpi_processor_ffh_cstate_probe(unsigned int cpu,
264 				    struct acpi_processor_cx *cx,
265 				    struct acpi_power_register *reg);
266 void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
267 #else
268 static inline void acpi_processor_power_init_bm_check(struct
269 						      acpi_processor_flags
270 						      *flags, unsigned int cpu)
271 {
272 	flags->bm_check = 1;
273 	return;
274 }
275 static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
276 						  struct acpi_processor_cx *cx,
277 						  struct acpi_power_register
278 						  *reg)
279 {
280 	return -1;
281 }
282 static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
283 						   *cstate)
284 {
285 	return;
286 }
287 #endif
288 
289 /* in processor_perflib.c */
290 
291 #ifdef CONFIG_CPU_FREQ
292 void acpi_processor_ppc_init(void);
293 void acpi_processor_ppc_exit(void);
294 int acpi_processor_ppc_has_changed(struct acpi_processor *pr);
295 #else
296 static inline void acpi_processor_ppc_init(void)
297 {
298 	return;
299 }
300 static inline void acpi_processor_ppc_exit(void)
301 {
302 	return;
303 }
304 static inline int acpi_processor_ppc_has_changed(struct acpi_processor *pr)
305 {
306 	static unsigned int printout = 1;
307 	if (printout) {
308 		printk(KERN_WARNING
309 		       "Warning: Processor Platform Limit event detected, but not handled.\n");
310 		printk(KERN_WARNING
311 		       "Consider compiling CPUfreq support into your kernel.\n");
312 		printout = 0;
313 	}
314 	return 0;
315 }
316 #endif				/* CONFIG_CPU_FREQ */
317 
318 /* in processor_throttling.c */
319 int acpi_processor_get_throttling_info(struct acpi_processor *pr);
320 extern int acpi_processor_set_throttling(struct acpi_processor *pr, int state);
321 extern struct file_operations acpi_processor_throttling_fops;
322 extern void acpi_processor_throttling_init(void);
323 /* in processor_idle.c */
324 int acpi_processor_power_init(struct acpi_processor *pr,
325 			      struct acpi_device *device);
326 int acpi_processor_cst_has_changed(struct acpi_processor *pr);
327 int acpi_processor_power_exit(struct acpi_processor *pr,
328 			      struct acpi_device *device);
329 int acpi_processor_suspend(struct acpi_device * device, pm_message_t state);
330 int acpi_processor_resume(struct acpi_device * device);
331 extern struct cpuidle_driver acpi_idle_driver;
332 
333 /* in processor_thermal.c */
334 int acpi_processor_get_limit_info(struct acpi_processor *pr);
335 extern struct file_operations acpi_processor_limit_fops;
336 extern struct thermal_cooling_device_ops processor_cooling_ops;
337 #ifdef CONFIG_CPU_FREQ
338 void acpi_thermal_cpufreq_init(void);
339 void acpi_thermal_cpufreq_exit(void);
340 #else
341 static inline void acpi_thermal_cpufreq_init(void)
342 {
343 	return;
344 }
345 static inline void acpi_thermal_cpufreq_exit(void)
346 {
347 	return;
348 }
349 #endif
350 
351 #endif
352