[mirror_ubuntu-zesty-kernel.git] / drivers / cpufreq / powernow-k8.h

/*
 *  (c) 2003-2006 Advanced Micro Devices, Inc.
 *  Your use of this code is subject to the terms and conditions of the
 *  GNU general public license version 2. See "COPYING" or
 *  http://www.gnu.org/licenses/gpl.html
 */

struct powernow_k8_data {
	unsigned int cpu;

	u32 numps;  /* number of p-states */
	u32 batps;  /* number of p-states supported on battery */

	/* these values are constant when the PSB is used to determine
	 * vid/fid pairings, but are modified during the ->target() call
	 * when ACPI is used */
	u32 rvo;     /* ramp voltage offset */
	u32 irt;     /* isochronous relief time */
	u32 vidmvs;  /* usable value calculated from mvs */
	u32 vstable; /* voltage stabilization time, units 20 us */
	u32 plllock; /* pll lock time, units 1 us */
	u32 exttype; /* extended interface = 1 */

	/* keep track of the current fid / vid or pstate */
	u32 currvid;
	u32 currfid;

	/* the powernow_table includes all frequency and vid/fid pairings:
	 * fid are the lower 8 bits of the index, vid are the upper 8 bits.
	 * frequency is in kHz */
	struct cpufreq_frequency_table  *powernow_table;

	/* the acpi table needs to be kept. it's only available if ACPI was
	 * used to determine valid frequency/vid/fid states */
	struct acpi_processor_performance acpi_data;

	/* we need to keep track of associated cores, but let cpufreq
	 * handle hotplug events - so just point at cpufreq pol->cpus
	 * structure */
	struct cpumask *available_cores;
};

/* processor's cpuid instruction support */
#define CPUID_PROCESSOR_SIGNATURE	1	/* function 1 */
#define CPUID_XFAM			0x0ff00000	/* extended family */
#define CPUID_XFAM_K8			0
#define CPUID_XMOD			0x000f0000	/* extended model */
#define CPUID_XMOD_REV_MASK		0x000c0000
#define CPUID_XFAM_10H			0x00100000	/* family 0x10 */
#define CPUID_USE_XFAM_XMOD		0x00000f00
#define CPUID_GET_MAX_CAPABILITIES	0x80000000
#define CPUID_FREQ_VOLT_CAPABILITIES	0x80000007
#define P_STATE_TRANSITION_CAPABLE	6

/* Model Specific Registers for p-state transitions. MSRs are 64-bit. For     */
/* writes (wrmsr - opcode 0f 30), the register number is placed in ecx, and   */
/* the value to write is placed in edx:eax. For reads (rdmsr - opcode 0f 32), */
/* the register number is placed in ecx, and the data is returned in edx:eax. */

#define MSR_FIDVID_CTL      0xc0010041
#define MSR_FIDVID_STATUS   0xc0010042

/* Field definitions within the FID VID Low Control MSR : */
#define MSR_C_LO_INIT_FID_VID     0x00010000
#define MSR_C_LO_NEW_VID          0x00003f00
#define MSR_C_LO_NEW_FID          0x0000003f
#define MSR_C_LO_VID_SHIFT        8

/* Field definitions within the FID VID High Control MSR : */
#define MSR_C_HI_STP_GNT_TO	  0x000fffff

/* Field definitions within the FID VID Low Status MSR : */
#define MSR_S_LO_CHANGE_PENDING   0x80000000   /* cleared when completed */
#define MSR_S_LO_MAX_RAMP_VID     0x3f000000
#define MSR_S_LO_MAX_FID          0x003f0000
#define MSR_S_LO_START_FID        0x00003f00
#define MSR_S_LO_CURRENT_FID      0x0000003f

/* Field definitions within the FID VID High Status MSR : */
#define MSR_S_HI_MIN_WORKING_VID  0x3f000000
#define MSR_S_HI_MAX_WORKING_VID  0x003f0000
#define MSR_S_HI_START_VID        0x00003f00
#define MSR_S_HI_CURRENT_VID      0x0000003f
#define MSR_C_HI_STP_GNT_BENIGN	  0x00000001

/*
 * There are restrictions frequencies have to follow:
 * - only 1 entry in the low fid table ( <=1.4GHz )
 * - lowest entry in the high fid table must be >= 2 * the entry in the
 *   low fid table
 * - lowest entry in the high fid table must be a <= 200MHz + 2 * the entry
 *   in the low fid table
 * - the parts can only step at <= 200 MHz intervals, odd fid values are
 *   supported in revision G and later revisions.
 * - lowest frequency must be >= interprocessor hypertransport link speed
 *   (only applies to MP systems obviously)
 */

/* fids (frequency identifiers) are arranged in 2 tables - lo and hi */
#define LO_FID_TABLE_TOP     7	/* fid values marking the boundary    */
#define HI_FID_TABLE_BOTTOM  8	/* between the low and high tables    */

#define LO_VCOFREQ_TABLE_TOP    1400	/* corresponding vco frequency values */
#define HI_VCOFREQ_TABLE_BOTTOM 1600

#define MIN_FREQ_RESOLUTION  200 /* fids jump by 2 matching freq jumps by 200 */

#define MAX_FID 0x2a	/* Spec only gives FID values as far as 5 GHz */
#define LEAST_VID 0x3e	/* Lowest (numerically highest) useful vid value */

#define MIN_FREQ 800	/* Min and max freqs, per spec */
#define MAX_FREQ 5000

#define INVALID_FID_MASK 0xffffffc0  /* not a valid fid if these bits are set */
#define INVALID_VID_MASK 0xffffffc0  /* not a valid vid if these bits are set */

#define VID_OFF 0x3f

#define STOP_GRANT_5NS 1 /* min poss memory access latency for voltage change */

#define PLL_LOCK_CONVERSION (1000/5) /* ms to ns, then divide by clock period */

#define MAXIMUM_VID_STEPS 1  /* Current cpus only allow a single step of 25mV */
#define VST_UNITS_20US 20   /* Voltage Stabilization Time is in units of 20us */

/*
 * Most values of interest are encoded in a single field of the _PSS
 * entries: the "control" value.
 */

#define IRT_SHIFT      30
#define RVO_SHIFT      28
#define EXT_TYPE_SHIFT 27
#define PLL_L_SHIFT    20
#define MVS_SHIFT      18
#define VST_SHIFT      11
#define VID_SHIFT       6
#define IRT_MASK        3
#define RVO_MASK        3
#define EXT_TYPE_MASK   1
#define PLL_L_MASK   0x7f
#define MVS_MASK        3
#define VST_MASK     0x7f
#define VID_MASK     0x1f
#define FID_MASK     0x1f
#define EXT_VID_MASK 0x3f
#define EXT_FID_MASK 0x3f


/*
 * Version 1.4 of the PSB table. This table is constructed by BIOS and is
 * to tell the OS's power management driver which VIDs and FIDs are
 * supported by this particular processor.
 * If the data in the PSB / PST is wrong, then this driver will program the
 * wrong values into hardware, which is very likely to lead to a crash.
 */

#define PSB_ID_STRING      "AMDK7PNOW!"
#define PSB_ID_STRING_LEN  10

#define PSB_VERSION_1_4  0x14

struct psb_s {
	u8 signature[10];
	u8 tableversion;
	u8 flags1;
	u16 vstable;
	u8 flags2;
	u8 num_tables;
	u32 cpuid;
	u8 plllocktime;
	u8 maxfid;
	u8 maxvid;
	u8 numps;
};

/* Pairs of fid/vid values are appended to the version 1.4 PSB table. */
struct pst_s {
	u8 fid;
	u8 vid;
};

static int core_voltage_pre_transition(struct powernow_k8_data *data,
	u32 reqvid, u32 regfid);
static int core_voltage_post_transition(struct powernow_k8_data *data, u32 reqvid);
static int core_frequency_transition(struct powernow_k8_data *data, u32 reqfid);

static void powernow_k8_acpi_pst_values(struct powernow_k8_data *data, unsigned int index);

static int fill_powernow_table_fidvid(struct powernow_k8_data *data, struct cpufreq_frequency_table *powernow_table);
Commit	Line	Data
1da177e4	1	/*
1f729e06	2	* (c) 2003-2006 Advanced Micro Devices, Inc.
1da177e4 LT	3	* Your use of this code is subject to the terms and conditions of the
	4	* GNU general public license version 2. See "COPYING" or
	5	* http://www.gnu.org/licenses/gpl.html
	6	*/
	7
	8	struct powernow_k8_data {
	9	unsigned int cpu;
	10
	11	u32 numps; /* number of p-states */
	12	u32 batps; /* number of p-states supported on battery */
	13
	14	/* these values are constant when the PSB is used to determine
	15	* vid/fid pairings, but are modified during the ->target() call
	16	* when ACPI is used */
	17	u32 rvo; /* ramp voltage offset */
	18	u32 irt; /* isochronous relief time */
	19	u32 vidmvs; /* usable value calculated from mvs */
	20	u32 vstable; /* voltage stabilization time, units 20 us */
	21	u32 plllock; /* pll lock time, units 1 us */
e54173b4	22	u32 exttype; /* extended interface = 1 */
1da177e4	23
c5829cd0	24	/* keep track of the current fid / vid or pstate */
a266d9f1 AH	25	u32 currvid;
a266d9f1 AH	26	u32 currfid;
1da177e4 LT	27
	28	/* the powernow_table includes all frequency and vid/fid pairings:
	29	* fid are the lower 8 bits of the index, vid are the upper 8 bits.
	30	* frequency is in kHz */
	31	struct cpufreq_frequency_table *powernow_table;
	32
1da177e4 LT	33	/* the acpi table needs to be kept. it's only available if ACPI was
1da177e4 LT	34	* used to determine valid frequency/vid/fid states */
f607e3a0	35	struct acpi_processor_performance acpi_data;
57f4fa69	36
1f729e06 DJ	37	/* we need to keep track of associated cores, but let cpufreq
	38	* handle hotplug events - so just point at cpufreq pol->cpus
	39	* structure */
835481d9	40	struct cpumask *available_cores;
1da177e4 LT	41	};
1da177e4 LT	42
1da177e4 LT	43	/* processor's cpuid instruction support */
	44	#define CPUID_PROCESSOR_SIGNATURE 1 /* function 1 */
	45	#define CPUID_XFAM 0x0ff00000 /* extended family */
	46	#define CPUID_XFAM_K8 0
	47	#define CPUID_XMOD 0x000f0000 /* extended model */
6c9cda78	48	#define CPUID_XMOD_REV_MASK 0x000c0000
30046e58	49	#define CPUID_XFAM_10H 0x00100000 /* family 0x10 */
1da177e4 LT	50	#define CPUID_USE_XFAM_XMOD 0x00000f00
	51	#define CPUID_GET_MAX_CAPABILITIES 0x80000000
	52	#define CPUID_FREQ_VOLT_CAPABILITIES 0x80000007
	53	#define P_STATE_TRANSITION_CAPABLE 6
	54
	55	/* Model Specific Registers for p-state transitions. MSRs are 64-bit. For */
	56	/* writes (wrmsr - opcode 0f 30), the register number is placed in ecx, and */
	57	/* the value to write is placed in edx:eax. For reads (rdmsr - opcode 0f 32), */
	58	/* the register number is placed in ecx, and the data is returned in edx:eax. */
	59
	60	#define MSR_FIDVID_CTL 0xc0010041
	61	#define MSR_FIDVID_STATUS 0xc0010042
	62
	63	/* Field definitions within the FID VID Low Control MSR : */
	64	#define MSR_C_LO_INIT_FID_VID 0x00010000
841e40b3 DJ	65	#define MSR_C_LO_NEW_VID 0x00003f00
841e40b3 DJ	66	#define MSR_C_LO_NEW_FID 0x0000003f
1da177e4 LT	67	#define MSR_C_LO_VID_SHIFT 8
	68
	69	/* Field definitions within the FID VID High Control MSR : */
32ee8c3e	70	#define MSR_C_HI_STP_GNT_TO 0x000fffff
1da177e4 LT	71
1da177e4 LT	72	/* Field definitions within the FID VID Low Status MSR : */
841e40b3 DJ	73	#define MSR_S_LO_CHANGE_PENDING 0x80000000 /* cleared when completed */
841e40b3 DJ	74	#define MSR_S_LO_MAX_RAMP_VID 0x3f000000
1da177e4 LT	75	#define MSR_S_LO_MAX_FID 0x003f0000
	76	#define MSR_S_LO_START_FID 0x00003f00
	77	#define MSR_S_LO_CURRENT_FID 0x0000003f
	78
	79	/* Field definitions within the FID VID High Status MSR : */
841e40b3 DJ	80	#define MSR_S_HI_MIN_WORKING_VID 0x3f000000
	81	#define MSR_S_HI_MAX_WORKING_VID 0x003f0000
	82	#define MSR_S_HI_START_VID 0x00003f00
	83	#define MSR_S_HI_CURRENT_VID 0x0000003f
	84	#define MSR_C_HI_STP_GNT_BENIGN 0x00000001
1da177e4 LT	85
	86	/*
	87	* There are restrictions frequencies have to follow:
	88	* - only 1 entry in the low fid table ( <=1.4GHz )
	89	* - lowest entry in the high fid table must be >= 2 * the entry in the
	90	* low fid table
	91	* - lowest entry in the high fid table must be a <= 200MHz + 2 * the entry
	92	* in the low fid table
019a61b9 LM	93	* - the parts can only step at <= 200 MHz intervals, odd fid values are
019a61b9 LM	94	* supported in revision G and later revisions.
1da177e4 LT	95	* - lowest frequency must be >= interprocessor hypertransport link speed
	96	* (only applies to MP systems obviously)
	97	*/
	98
	99	/* fids (frequency identifiers) are arranged in 2 tables - lo and hi */
019a61b9	100	#define LO_FID_TABLE_TOP 7 /* fid values marking the boundary */
1da177e4 LT	101	#define HI_FID_TABLE_BOTTOM 8 /* between the low and high tables */
	102
	103	#define LO_VCOFREQ_TABLE_TOP 1400 /* corresponding vco frequency values */
	104	#define HI_VCOFREQ_TABLE_BOTTOM 1600
	105
	106	#define MIN_FREQ_RESOLUTION 200 /* fids jump by 2 matching freq jumps by 200 */
	107
	108	#define MAX_FID 0x2a /* Spec only gives FID values as far as 5 GHz */
841e40b3	109	#define LEAST_VID 0x3e /* Lowest (numerically highest) useful vid value */
1da177e4 LT	110
	111	#define MIN_FREQ 800 /* Min and max freqs, per spec */
	112	#define MAX_FREQ 5000
	113
019a61b9	114	#define INVALID_FID_MASK 0xffffffc0 /* not a valid fid if these bits are set */
841e40b3 DJ	115	#define INVALID_VID_MASK 0xffffffc0 /* not a valid vid if these bits are set */
	116
	117	#define VID_OFF 0x3f
1da177e4 LT	118
	119	#define STOP_GRANT_5NS 1 /* min poss memory access latency for voltage change */
	120
	121	#define PLL_LOCK_CONVERSION (1000/5) /* ms to ns, then divide by clock period */
	122
	123	#define MAXIMUM_VID_STEPS 1 /* Current cpus only allow a single step of 25mV */
27b46d76	124	#define VST_UNITS_20US 20 /* Voltage Stabilization Time is in units of 20us */
1da177e4 LT	125
1da177e4 LT	126	/*
27b46d76	127	* Most values of interest are encoded in a single field of the _PSS
1da177e4 LT	128	* entries: the "control" value.
1da177e4 LT	129	*/
32ee8c3e	130
1da177e4 LT	131	#define IRT_SHIFT 30
1da177e4 LT	132	#define RVO_SHIFT 28
2bcad935	133	#define EXT_TYPE_SHIFT 27
1da177e4 LT	134	#define PLL_L_SHIFT 20
	135	#define MVS_SHIFT 18
	136	#define VST_SHIFT 11
	137	#define VID_SHIFT 6
	138	#define IRT_MASK 3
	139	#define RVO_MASK 3
2bcad935	140	#define EXT_TYPE_MASK 1
1da177e4 LT	141	#define PLL_L_MASK 0x7f
	142	#define MVS_MASK 3
	143	#define VST_MASK 0x7f
	144	#define VID_MASK 0x1f
6cad647d LM	145	#define FID_MASK 0x1f
	146	#define EXT_VID_MASK 0x3f
	147	#define EXT_FID_MASK 0x3f
1da177e4 LT	148
	149
	150	/*
	151	* Version 1.4 of the PSB table. This table is constructed by BIOS and is
	152	* to tell the OS's power management driver which VIDs and FIDs are
	153	* supported by this particular processor.
	154	* If the data in the PSB / PST is wrong, then this driver will program the
	155	* wrong values into hardware, which is very likely to lead to a crash.
	156	*/
	157
	158	#define PSB_ID_STRING "AMDK7PNOW!"
	159	#define PSB_ID_STRING_LEN 10
	160
	161	#define PSB_VERSION_1_4 0x14
	162
	163	struct psb_s {
	164	u8 signature[10];
	165	u8 tableversion;
	166	u8 flags1;
	167	u16 vstable;
	168	u8 flags2;
	169	u8 num_tables;
	170	u32 cpuid;
	171	u8 plllocktime;
	172	u8 maxfid;
	173	u8 maxvid;
	174	u8 numps;
	175	};
	176
	177	/* Pairs of fid/vid values are appended to the version 1.4 PSB table. */
	178	struct pst_s {
	179	u8 fid;
	180	u8 vid;
	181	};
	182
a2e1b4c3 ML	183	static int core_voltage_pre_transition(struct powernow_k8_data *data,
a2e1b4c3 ML	184	u32 reqvid, u32 regfid);
1da177e4 LT	185	static int core_voltage_post_transition(struct powernow_k8_data *data, u32 reqvid);
	186	static int core_frequency_transition(struct powernow_k8_data *data, u32 reqfid);
	187
	188	static void powernow_k8_acpi_pst_values(struct powernow_k8_data *data, unsigned int index);
065b807c	189
1f729e06	190	static int fill_powernow_table_fidvid(struct powernow_k8_data data, struct cpufreq_frequency_table powernow_table);