[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

/*
 * 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_processor_tx {
	u16 power;
	u16 performance;
};

struct acpi_processor_throttling {
	int state;
	u32 address;
	u8 duty_offset;
	u8 duty_width;
	int state_count;
	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;
	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);
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);

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