[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

/* 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;
	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];
};

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