blob: 4188a4d3b597cac7e8d929d8745217d584d0bb63 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __ACPI_PROCESSOR_H
2#define __ACPI_PROCESSOR_H
3
4#include <linux/kernel.h>
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -05005#include <linux/cpu.h>
Zhang Ruid9460fd222008-01-17 15:51:23 +08006#include <linux/thermal.h>
Venkatesh Pallipadi02df8b92005-04-15 15:07:10 -04007#include <asm/acpi.h>
8
Rafael J. Wysockiac212b62013-05-03 00:26:22 +02009#define ACPI_PROCESSOR_CLASS "processor"
10#define ACPI_PROCESSOR_DEVICE_NAME "Processor"
11#define ACPI_PROCESSOR_DEVICE_HID "ACPI0007"
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#define ACPI_PROCESSOR_BUSY_METRIC 10
14
15#define ACPI_PROCESSOR_MAX_POWER 8
16#define ACPI_PROCESSOR_MAX_C2_LATENCY 100
17#define ACPI_PROCESSOR_MAX_C3_LATENCY 1000
18
19#define ACPI_PROCESSOR_MAX_THROTTLING 16
20#define ACPI_PROCESSOR_MAX_THROTTLE 250 /* 25% */
21#define ACPI_PROCESSOR_MAX_DUTY_WIDTH 4
22
Venkatesh Pallipadi02df8b92005-04-15 15:07:10 -040023#define ACPI_PDC_REVISION_ID 0x1
24
Len Brownfd350942007-05-09 23:34:35 -040025#define ACPI_PSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -050026#define ACPI_PSD_REV0_ENTRIES 5
27
Luming Yu01854e62007-05-26 22:49:58 +080028#define ACPI_TSD_REV0_REVISION 0 /* Support for _PSD as in ACPI 3.0 */
29#define ACPI_TSD_REV0_ENTRIES 5
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -050030/*
31 * Types of coordination defined in ACPI 3.0. Same macros can be used across
32 * P, C and T states
33 */
34#define DOMAIN_COORD_TYPE_SW_ALL 0xfc
35#define DOMAIN_COORD_TYPE_SW_ANY 0xfd
36#define DOMAIN_COORD_TYPE_HW_ALL 0xfe
37
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -080038#define ACPI_CSTATE_SYSTEMIO 0
39#define ACPI_CSTATE_FFH 1
40#define ACPI_CSTATE_HALT 2
41
42#define ACPI_CX_DESC_LEN 32
Venkatesh Pallipadi991528d2006-09-25 16:28:13 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/* Power Management */
45
46struct acpi_processor_cx;
47
48struct acpi_power_register {
Len Brown4be44fc2005-08-05 00:44:28 -040049 u8 descriptor;
50 u16 length;
51 u8 space_id;
52 u8 bit_width;
53 u8 bit_offset;
Len Brown718be4a2010-07-22 16:54:27 -040054 u8 access_size;
Len Brown4be44fc2005-08-05 00:44:28 -040055 u64 address;
Fabian Frederick92c4d2a2014-06-01 19:16:17 +020056} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Linus Torvalds1da177e2005-04-16 15:20:36 -070058struct acpi_processor_cx {
Len Brown4be44fc2005-08-05 00:44:28 -040059 u8 valid;
60 u8 type;
61 u32 address;
venkatesh.pallipadi@intel.combc71bec2008-01-31 17:35:04 -080062 u8 entry_method;
Venkatesh Pallipadi991528d2006-09-25 16:28:13 -070063 u8 index;
Len Brown4be44fc2005-08-05 00:44:28 -040064 u32 latency;
Len Brown718be4a2010-07-22 16:54:27 -040065 u8 bm_sts_skip;
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -080066 char desc[ACPI_CX_DESC_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -070067};
68
69struct acpi_processor_power {
Len Brown4be44fc2005-08-05 00:44:28 -040070 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
Thomas Gleixner169a0ab2007-02-16 01:27:55 -080072 int timer_broadcast_on_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073};
74
75/* Performance Management */
76
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -050077struct acpi_psd_package {
Lin Ming439913f2010-01-28 10:53:19 +080078 u64 num_entries;
79 u64 revision;
80 u64 domain;
81 u64 coord_type;
82 u64 num_processors;
Fabian Frederick92c4d2a2014-06-01 19:16:17 +020083} __packed;
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -050084
Linus Torvalds1da177e2005-04-16 15:20:36 -070085struct acpi_pct_register {
Len Brown4be44fc2005-08-05 00:44:28 -040086 u8 descriptor;
87 u16 length;
88 u8 space_id;
89 u8 bit_width;
90 u8 bit_offset;
91 u8 reserved;
92 u64 address;
Fabian Frederick92c4d2a2014-06-01 19:16:17 +020093} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95struct acpi_processor_px {
Lin Ming439913f2010-01-28 10:53:19 +080096 u64 core_frequency; /* megahertz */
97 u64 power; /* milliWatts */
98 u64 transition_latency; /* microseconds */
99 u64 bus_master_latency; /* microseconds */
100 u64 control; /* control value */
101 u64 status; /* success indicator */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102};
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104struct acpi_processor_performance {
Len Brown4be44fc2005-08-05 00:44:28 -0400105 unsigned int state;
106 unsigned int platform_limit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 struct acpi_pct_register control_register;
108 struct acpi_pct_register status_register;
Len Brown4be44fc2005-08-05 00:44:28 -0400109 unsigned int state_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 struct acpi_processor_px *states;
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -0500111 struct acpi_psd_package domain_info;
Rusty Russell2fdf66b2008-12-31 18:08:47 -0800112 cpumask_var_t shared_cpu_map;
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -0500113 unsigned int shared_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114};
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116/* Throttling Control */
117
Luming Yu01854e62007-05-26 22:49:58 +0800118struct acpi_tsd_package {
Lin Ming439913f2010-01-28 10:53:19 +0800119 u64 num_entries;
120 u64 revision;
121 u64 domain;
122 u64 coord_type;
123 u64 num_processors;
Fabian Frederick92c4d2a2014-06-01 19:16:17 +0200124} __packed;
Luming Yu01854e62007-05-26 22:49:58 +0800125
126struct acpi_ptc_register {
127 u8 descriptor;
128 u16 length;
129 u8 space_id;
130 u8 bit_width;
131 u8 bit_offset;
132 u8 reserved;
133 u64 address;
Fabian Frederick92c4d2a2014-06-01 19:16:17 +0200134} __packed;
Luming Yu01854e62007-05-26 22:49:58 +0800135
136struct acpi_processor_tx_tss {
Lin Ming439913f2010-01-28 10:53:19 +0800137 u64 freqpercentage; /* */
138 u64 power; /* milliWatts */
139 u64 transition_latency; /* microseconds */
140 u64 control; /* control value */
141 u64 status; /* success indicator */
Luming Yu01854e62007-05-26 22:49:58 +0800142};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143struct acpi_processor_tx {
Len Brown4be44fc2005-08-05 00:44:28 -0400144 u16 power;
145 u16 performance;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146};
147
Luming Yu01854e62007-05-26 22:49:58 +0800148struct acpi_processor;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149struct acpi_processor_throttling {
Luming Yu01854e62007-05-26 22:49:58 +0800150 unsigned int state;
151 unsigned int platform_limit;
152 struct acpi_pct_register control_register;
153 struct acpi_pct_register status_register;
154 unsigned int state_count;
155 struct acpi_processor_tx_tss *states_tss;
156 struct acpi_tsd_package domain_info;
Rusty Russell2fdf66b2008-12-31 18:08:47 -0800157 cpumask_var_t shared_cpu_map;
Len Brownff55a9c2007-06-02 00:15:25 -0400158 int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
159 int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
Frans Pop2a908002009-08-26 14:29:29 -0700160 int state, bool force);
Luming Yu01854e62007-05-26 22:49:58 +0800161
Len Brown4be44fc2005-08-05 00:44:28 -0400162 u32 address;
163 u8 duty_offset;
164 u8 duty_width;
Zhao Yakui11805092008-01-28 13:53:42 +0800165 u8 tsd_valid_flag;
166 unsigned int shared_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
168};
169
170/* Limit Interface */
171
172struct acpi_processor_lx {
Joe Perchesaee07ba2008-02-03 17:07:16 +0200173 int px; /* performance state */
Len Brown4be44fc2005-08-05 00:44:28 -0400174 int tx; /* throttle level */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175};
176
177struct acpi_processor_limit {
Len Brown4be44fc2005-08-05 00:44:28 -0400178 struct acpi_processor_lx state; /* current limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 struct acpi_processor_lx thermal; /* thermal limit */
Len Brown4be44fc2005-08-05 00:44:28 -0400180 struct acpi_processor_lx user; /* user limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181};
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183struct acpi_processor_flags {
Len Brown4be44fc2005-08-05 00:44:28 -0400184 u8 power:1;
185 u8 performance:1;
186 u8 throttling:1;
187 u8 limit:1;
188 u8 bm_control:1;
189 u8 bm_check:1;
190 u8 has_cst:1;
191 u8 power_setup_done:1;
Len Brown4f86d3a2007-10-03 18:58:00 -0400192 u8 bm_rld_set:1;
Thomas Renninger99b72502012-01-19 18:18:43 +0100193 u8 need_hotplug_init:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194};
195
196struct acpi_processor {
Len Brown4be44fc2005-08-05 00:44:28 -0400197 acpi_handle handle;
198 u32 acpi_id;
Catalin Marinas828aef32015-03-24 14:02:46 +0000199 phys_cpuid_t phys_id; /* CPU hardware ID such as APIC ID for x86 */
Hanjun Guoaf8f3f52015-01-04 18:55:02 +0800200 u32 id; /* CPU logical ID allocated by OS */
Len Brown4be44fc2005-08-05 00:44:28 -0400201 u32 pblk;
202 int performance_platform_limit;
Luming Yu01854e62007-05-26 22:49:58 +0800203 int throttling_platform_limit;
Len Brownff55a9c2007-06-02 00:15:25 -0400204 /* 0 - states 0..n-th state available */
Luming Yu01854e62007-05-26 22:49:58 +0800205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 struct acpi_processor_flags flags;
207 struct acpi_processor_power power;
208 struct acpi_processor_performance *performance;
209 struct acpi_processor_throttling throttling;
210 struct acpi_processor_limit limit;
Zhang Ruid9460fd222008-01-17 15:51:23 +0800211 struct thermal_cooling_device *cdev;
Rafael J. Wysockiac212b62013-05-03 00:26:22 +0200212 struct device *dev; /* Processor device. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213};
214
215struct acpi_processor_errata {
Len Brown4be44fc2005-08-05 00:44:28 -0400216 u8 smp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 struct {
Len Brown4be44fc2005-08-05 00:44:28 -0400218 u8 throttle:1;
219 u8 fdma:1;
220 u8 reserved:6;
221 u32 bmisx;
222 } piix4;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223};
224
Len Brownfd350942007-05-09 23:34:35 -0400225extern int acpi_processor_preregister_performance(struct
226 acpi_processor_performance
Tejun Heoa29d8b82010-02-02 14:39:15 +0900227 __percpu *performance);
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -0500228
Len Brown4be44fc2005-08-05 00:44:28 -0400229extern int acpi_processor_register_performance(struct acpi_processor_performance
230 *performance, unsigned int cpu);
231extern void acpi_processor_unregister_performance(struct
232 acpi_processor_performance
233 *performance,
234 unsigned int cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236/* note: this locks both the calling module and the processor module
237 if a _PPC object exists, rmmod is disallowed then */
238int acpi_processor_notify_smm(struct module *calling_module);
239
Konrad Rzeszutek Wilkc705c782013-03-05 13:42:54 -0500240/* parsing the _P* objects. */
241extern int acpi_processor_get_performance_info(struct acpi_processor *pr);
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243/* for communication between multiple parts of the processor kernel module */
Mike Travis706546d2008-06-09 16:22:23 -0700244DECLARE_PER_CPU(struct acpi_processor *, processors);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245extern struct acpi_processor_errata errata;
246
Venkatesh Pallipadi05131ec2005-10-23 16:31:00 -0400247#ifdef ARCH_HAS_POWER_INIT
Venkatesh Pallipadi02df8b92005-04-15 15:07:10 -0400248void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
Len Brown4be44fc2005-08-05 00:44:28 -0400249 unsigned int cpu);
Venkatesh Pallipadi991528d2006-09-25 16:28:13 -0700250int acpi_processor_ffh_cstate_probe(unsigned int cpu,
Len Brownfd350942007-05-09 23:34:35 -0400251 struct acpi_processor_cx *cx,
252 struct acpi_power_register *reg);
Venkatesh Pallipadi991528d2006-09-25 16:28:13 -0700253void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
Venkatesh Pallipadi02df8b92005-04-15 15:07:10 -0400254#else
Len Brown4be44fc2005-08-05 00:44:28 -0400255static inline void acpi_processor_power_init_bm_check(struct
256 acpi_processor_flags
257 *flags, unsigned int cpu)
Venkatesh Pallipadi02df8b92005-04-15 15:07:10 -0400258{
259 flags->bm_check = 1;
260 return;
261}
Venkatesh Pallipadi991528d2006-09-25 16:28:13 -0700262static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
Len Brownfd350942007-05-09 23:34:35 -0400263 struct acpi_processor_cx *cx,
264 struct acpi_power_register
265 *reg)
Venkatesh Pallipadi991528d2006-09-25 16:28:13 -0700266{
267 return -1;
268}
Len Brownfd350942007-05-09 23:34:35 -0400269static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
270 *cstate)
Venkatesh Pallipadi991528d2006-09-25 16:28:13 -0700271{
272 return;
273}
Venkatesh Pallipadi02df8b92005-04-15 15:07:10 -0400274#endif
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276/* in processor_perflib.c */
Venkatesh Pallipadi02df8b92005-04-15 15:07:10 -0400277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278#ifdef CONFIG_CPU_FREQ
279void acpi_processor_ppc_init(void);
280void acpi_processor_ppc_exit(void);
Zhao Yakuid81c45e12009-10-16 09:20:41 +0800281int acpi_processor_ppc_has_changed(struct acpi_processor *pr, int event_flag);
Thomas Renningere2f74f32009-11-19 12:31:01 +0100282extern int acpi_processor_get_bios_limit(int cpu, unsigned int *limit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283#else
Len Brown4be44fc2005-08-05 00:44:28 -0400284static inline void acpi_processor_ppc_init(void)
285{
286 return;
287}
288static inline void acpi_processor_ppc_exit(void)
289{
290 return;
291}
Zhao Yakuid81c45e12009-10-16 09:20:41 +0800292static inline int acpi_processor_ppc_has_changed(struct acpi_processor *pr,
293 int event_flag)
Len Brown4be44fc2005-08-05 00:44:28 -0400294{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 static unsigned int printout = 1;
296 if (printout) {
Len Brown4be44fc2005-08-05 00:44:28 -0400297 printk(KERN_WARNING
298 "Warning: Processor Platform Limit event detected, but not handled.\n");
299 printk(KERN_WARNING
300 "Consider compiling CPUfreq support into your kernel.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 printout = 0;
302 }
303 return 0;
304}
Thomas Renningere2f74f32009-11-19 12:31:01 +0100305static inline int acpi_processor_get_bios_limit(int cpu, unsigned int *limit)
306{
307 return -ENODEV;
308}
309
Len Brown4be44fc2005-08-05 00:44:28 -0400310#endif /* CONFIG_CPU_FREQ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Alex Chiang4d5d4cd2010-02-22 12:11:14 -0700312/* in processor_core.c */
Catalin Marinas828aef32015-03-24 14:02:46 +0000313phys_cpuid_t acpi_get_phys_id(acpi_handle, int type, u32 acpi_id);
314int acpi_map_cpuid(phys_cpuid_t phys_id, u32 acpi_id);
Alex Chiang2e9d5e42010-02-22 12:11:19 -0700315int acpi_get_cpuid(acpi_handle, int type, u32 acpi_id);
Alex Chiang78f16992009-12-20 12:19:09 -0700316
Hanjun Guo24119a82014-10-30 17:52:58 +0800317/* in processor_pdc.c */
318void acpi_processor_set_pdc(acpi_handle handle);
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320/* in processor_throttling.c */
Adrian Bunka66b34b2008-06-09 16:22:24 -0700321int acpi_processor_tstate_has_changed(struct acpi_processor *pr);
Len Brown4be44fc2005-08-05 00:44:28 -0400322int acpi_processor_get_throttling_info(struct acpi_processor *pr);
Frans Pop2a908002009-08-26 14:29:29 -0700323extern int acpi_processor_set_throttling(struct acpi_processor *pr,
324 int state, bool force);
Zhao Yakui5a344a52011-01-10 16:35:45 +0800325/*
326 * Reevaluate whether the T-state is invalid after one cpu is
327 * onlined/offlined. In such case the flags.throttling will be updated.
328 */
329extern void acpi_processor_reevaluate_tstate(struct acpi_processor *pr,
330 unsigned long action);
Jan Engelhardt070d8eb2009-01-12 00:07:55 +0100331extern const struct file_operations acpi_processor_throttling_fops;
Zhao Yakui11805092008-01-28 13:53:42 +0800332extern void acpi_processor_throttling_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333/* in processor_idle.c */
Daniel Lezcano38a991b2012-09-15 22:42:54 +0200334int acpi_processor_power_init(struct acpi_processor *pr);
335int acpi_processor_power_exit(struct acpi_processor *pr);
Len Brown4be44fc2005-08-05 00:44:28 -0400336int acpi_processor_cst_has_changed(struct acpi_processor *pr);
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530337int acpi_processor_hotplug(struct acpi_processor *pr);
Len Brown4f86d3a2007-10-03 18:58:00 -0400338extern struct cpuidle_driver acpi_idle_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Rafael J. Wysocki0a3b15a2013-05-02 21:54:37 +0200340#ifdef CONFIG_PM_SLEEP
341void acpi_processor_syscore_init(void);
342void acpi_processor_syscore_exit(void);
343#else
344static inline void acpi_processor_syscore_init(void) {}
345static inline void acpi_processor_syscore_exit(void) {}
346#endif
347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348/* in processor_thermal.c */
Len Brown4be44fc2005-08-05 00:44:28 -0400349int acpi_processor_get_limit_info(struct acpi_processor *pr);
Vasiliy Kulikov9c8b04b2011-06-25 21:07:52 +0400350extern const struct thermal_cooling_device_ops processor_cooling_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351#ifdef CONFIG_CPU_FREQ
352void acpi_thermal_cpufreq_init(void);
353void acpi_thermal_cpufreq_exit(void);
354#else
Len Brown4be44fc2005-08-05 00:44:28 -0400355static inline void acpi_thermal_cpufreq_init(void)
356{
357 return;
358}
359static inline void acpi_thermal_cpufreq_exit(void)
360{
361 return;
362}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363#endif
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365#endif