[deliverable/linux.git] / include / acpi / processor.h

#ifndef __ACPI_PROCESSOR_H
#define __ACPI_PROCESSOR_H

#include <linux/kernel.h>
#include <linux/cpu.h>

#include <asm/acpi.h>

#define ACPI_PROCESSOR_BUSY_METRIC	10

#define ACPI_PROCESSOR_MAX_POWER	8
#define ACPI_PROCESSOR_MAX_C2_LATENCY	100
#define ACPI_PROCESSOR_MAX_C3_LATENCY	1000

#define ACPI_PROCESSOR_MAX_THROTTLING	16
#define ACPI_PROCESSOR_MAX_THROTTLE	250	/* 25% */
#define ACPI_PROCESSOR_MAX_DUTY_WIDTH	4

#define ACPI_PDC_REVISION_ID		0x1

#define ACPI_PSD_REV0_REVISION		0	/* Support for _PSD as in ACPI 3.0 */
#define ACPI_PSD_REV0_ENTRIES		5

#define ACPI_TSD_REV0_REVISION		0	/* Support for _PSD as in ACPI 3.0 */
#define ACPI_TSD_REV0_ENTRIES		5
/*
 * Types of coordination defined in ACPI 3.0. Same macros can be used across
 * P, C and T states
 */
#define DOMAIN_COORD_TYPE_SW_ALL	0xfc
#define DOMAIN_COORD_TYPE_SW_ANY	0xfd
#define DOMAIN_COORD_TYPE_HW_ALL	0xfe

#define ACPI_CSTATE_SYSTEMIO	(0)
#define ACPI_CSTATE_FFH		(1)

/* Power Management */

struct acpi_processor_cx;

struct acpi_power_register {
	u8 descriptor;
	u16 length;
	u8 space_id;
	u8 bit_width;
	u8 bit_offset;
	u8 reserved;
	u64 address;
} __attribute__ ((packed));

struct acpi_processor_cx_policy {
	u32 count;
	struct acpi_processor_cx *state;
	struct {
		u32 time;
		u32 ticks;
		u32 count;
		u32 bm;
	} threshold;
};

struct acpi_processor_cx {
	u8 valid;
	u8 type;
	u32 address;
	u8 space_id;
	u8 index;
	u32 latency;
	u32 latency_ticks;
	u32 power;
	u32 usage;
	u64 time;
	struct acpi_processor_cx_policy promotion;
	struct acpi_processor_cx_policy demotion;
};

struct acpi_processor_power {
	struct acpi_processor_cx *state;
	unsigned long bm_check_timestamp;
	u32 default_state;
	u32 bm_activity;
	int count;
	struct acpi_processor_cx states[ACPI_PROCESSOR_MAX_POWER];
	int timer_broadcast_on_state;
};

/* Performance Management */

struct acpi_psd_package {
	acpi_integer num_entries;
	acpi_integer revision;
	acpi_integer domain;
	acpi_integer coord_type;
	acpi_integer num_processors;
} __attribute__ ((packed));

struct acpi_pct_register {
	u8 descriptor;
	u16 length;
	u8 space_id;
	u8 bit_width;
	u8 bit_offset;
	u8 reserved;
	u64 address;
} __attribute__ ((packed));

struct acpi_processor_px {
	acpi_integer core_frequency;	/* megahertz */
	acpi_integer power;	/* milliWatts */
	acpi_integer transition_latency;	/* microseconds */
	acpi_integer bus_master_latency;	/* microseconds */
	acpi_integer control;	/* control value */
	acpi_integer status;	/* success indicator */
};

struct acpi_processor_performance {
	unsigned int state;
	unsigned int platform_limit;
	struct acpi_pct_register control_register;
	struct acpi_pct_register status_register;
	unsigned int state_count;
	struct acpi_processor_px *states;
	struct acpi_psd_package domain_info;
	cpumask_t shared_cpu_map;
	unsigned int shared_type;
};

/* Throttling Control */

struct acpi_tsd_package {
	acpi_integer num_entries;
	acpi_integer revision;
	acpi_integer domain;
	acpi_integer coord_type;
	acpi_integer num_processors;
} __attribute__ ((packed));

struct acpi_ptc_register {
	u8 descriptor;
	u16 length;
	u8 space_id;
	u8 bit_width;
	u8 bit_offset;
	u8 reserved;
	u64 address;
} __attribute__ ((packed));

struct acpi_processor_tx_tss {
	acpi_integer freqpercentage;	/* */
	acpi_integer power;	/* milliWatts */
	acpi_integer transition_latency;	/* microseconds */
	acpi_integer control;	/* control value */
	acpi_integer status;	/* success indicator */
};
struct acpi_processor_tx {
	u16 power;
	u16 performance;
};

struct acpi_processor;
struct acpi_processor_throttling {
	unsigned int state;
	unsigned int platform_limit;
	struct acpi_pct_register control_register;
	struct acpi_pct_register status_register;
	unsigned int state_count;
	struct acpi_processor_tx_tss *states_tss;
	struct acpi_tsd_package domain_info;
	cpumask_t shared_cpu_map;
	int (*acpi_processor_get_throttling) (struct acpi_processor * pr);
	int (*acpi_processor_set_throttling) (struct acpi_processor * pr,
					      int state);

	u32 address;
	u8 duty_offset;
	u8 duty_width;
	struct acpi_processor_tx states[ACPI_PROCESSOR_MAX_THROTTLING];
};

/* Limit Interface */

struct acpi_processor_lx {
	int px;			/* performace state */
	int tx;			/* throttle level */
};

struct acpi_processor_limit {
	struct acpi_processor_lx state;	/* current limit */
	struct acpi_processor_lx thermal;	/* thermal limit */
	struct acpi_processor_lx user;	/* user limit */
};

struct acpi_processor_flags {
	u8 power:1;
	u8 performance:1;
	u8 throttling:1;
	u8 limit:1;
	u8 bm_control:1;
	u8 bm_check:1;
	u8 has_cst:1;
	u8 power_setup_done:1;
};

struct acpi_processor {
	acpi_handle handle;
	u32 acpi_id;
	u32 id;
	u32 pblk;
	int performance_platform_limit;
	int throttling_platform_limit;
	/* 0 - states 0..n-th state available */

	struct acpi_processor_flags flags;
	struct acpi_processor_power power;
	struct acpi_processor_performance *performance;
	struct acpi_processor_throttling throttling;
	struct acpi_processor_limit limit;

	/* the _PDC objects for this processor, if any */
	struct acpi_object_list *pdc;
};

struct acpi_processor_errata {
	u8 smp;
	struct {
		u8 throttle:1;
		u8 fdma:1;
		u8 reserved:6;
		u32 bmisx;
	} piix4;
};

extern int acpi_processor_preregister_performance(struct
						  acpi_processor_performance
						  *performance);

extern int acpi_processor_register_performance(struct acpi_processor_performance
					       *performance, unsigned int cpu);
extern void acpi_processor_unregister_performance(struct
						  acpi_processor_performance
						  *performance,
						  unsigned int cpu);

/* note: this locks both the calling module and the processor module
         if a _PPC object exists, rmmod is disallowed then */
int acpi_processor_notify_smm(struct module *calling_module);

/* for communication between multiple parts of the processor kernel module */
extern struct acpi_processor *processors[NR_CPUS];
extern struct acpi_processor_errata errata;

void arch_acpi_processor_init_pdc(struct acpi_processor *pr);

#ifdef ARCH_HAS_POWER_INIT
void acpi_processor_power_init_bm_check(struct acpi_processor_flags *flags,
					unsigned int cpu);
int acpi_processor_ffh_cstate_probe(unsigned int cpu,
				    struct acpi_processor_cx *cx,
				    struct acpi_power_register *reg);
void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx *cstate);
#else
static inline void acpi_processor_power_init_bm_check(struct
						      acpi_processor_flags
						      *flags, unsigned int cpu)
{
	flags->bm_check = 1;
	return;
}
static inline int acpi_processor_ffh_cstate_probe(unsigned int cpu,
						  struct acpi_processor_cx *cx,
						  struct acpi_power_register
						  *reg)
{
	return -1;
}
static inline void acpi_processor_ffh_cstate_enter(struct acpi_processor_cx
						   *cstate)
{
	return;
}
#endif

/* in processor_perflib.c */

#ifdef CONFIG_CPU_FREQ
void acpi_processor_ppc_init(void);
void acpi_processor_ppc_exit(void);
int acpi_processor_ppc_has_changed(struct acpi_processor *pr);
#else
static inline void acpi_processor_ppc_init(void)
{
	return;
}
static inline void acpi_processor_ppc_exit(void)
{
	return;
}
static inline int acpi_processor_ppc_has_changed(struct acpi_processor *pr)
{
	static unsigned int printout = 1;
	if (printout) {
		printk(KERN_WARNING
		       "Warning: Processor Platform Limit event detected, but not handled.\n");
		printk(KERN_WARNING
		       "Consider compiling CPUfreq support into your kernel.\n");
		printout = 0;
	}
	return 0;
}
#endif				/* CONFIG_CPU_FREQ */

/* in processor_throttling.c */
int acpi_processor_get_throttling_info(struct acpi_processor *pr);
extern int acpi_processor_set_throttling(struct acpi_processor *pr, int state);
extern struct file_operations acpi_processor_throttling_fops;

/* in processor_idle.c */
int acpi_processor_power_init(struct acpi_processor *pr,
			      struct acpi_device *device);
int acpi_processor_cst_has_changed(struct acpi_processor *pr);
int acpi_processor_power_exit(struct acpi_processor *pr,
			      struct acpi_device *device);
int acpi_processor_suspend(struct acpi_device * device, pm_message_t state);
int acpi_processor_resume(struct acpi_device * device);

/* in processor_thermal.c */
int acpi_processor_get_limit_info(struct acpi_processor *pr);
extern struct file_operations acpi_processor_limit_fops;

#ifdef CONFIG_CPU_FREQ
void acpi_thermal_cpufreq_init(void);
void acpi_thermal_cpufreq_exit(void);
#else
static inline void acpi_thermal_cpufreq_init(void)
{
	return;
}
static inline void acpi_thermal_cpufreq_exit(void)
{
	return;
}
#endif

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