hwmon: (hwmon-vid) Trivial format multi-line comments per CodingStyle
[safe/jmp/linux-2.6] / drivers / hwmon / hwmon-vid.c
1 /*
2  * hwmon-vid.c - VID/VRM/VRD voltage conversions
3  *
4  * Copyright (c) 2004 Rudolf Marek <r.marek@assembler.cz>
5  *
6  * Partly imported from i2c-vid.h of the lm_sensors project
7  * Copyright (c) 2002 Mark D. Studebaker <mdsxyz123@yahoo.com>
8  * With assistance from Trent Piepho <xyzzy@speakeasy.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  */
24
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/hwmon-vid.h>
28
29 /*
30  * Common code for decoding VID pins.
31  *
32  * References:
33  *
34  * For VRM 8.4 to 9.1, "VRM x.y DC-DC Converter Design Guidelines",
35  * available at http://developer.intel.com/.
36  *
37  * For VRD 10.0 and up, "VRD x.y Design Guide",
38  * available at http://developer.intel.com/.
39  *
40  * AMD Opteron processors don't follow the Intel specifications.
41  * I'm going to "make up" 2.4 as the spec number for the Opterons.
42  * No good reason just a mnemonic for the 24x Opteron processor
43  * series.
44  *
45  * Opteron VID encoding is:
46  *    00000  =  1.550 V
47  *    00001  =  1.525 V
48  *     . . . .
49  *    11110  =  0.800 V
50  *    11111  =  0.000 V (off)
51  *
52  * The 17 specification is in fact Intel Mobile Voltage Positioning -
53  * (IMVP-II). You can find more information in the datasheet of Max1718
54  * http://www.maxim-ic.com/quick_view2.cfm/qv_pk/2452
55  *
56  * The 13 specification corresponds to the Intel Pentium M series. There
57  * doesn't seem to be any named specification for these. The conversion
58  * tables are detailed directly in the various Pentium M datasheets:
59  * http://www.intel.com/design/intarch/pentiumm/docs_pentiumm.htm
60  *
61  * The 14 specification corresponds to Intel Core series. There
62  * doesn't seem to be any named specification for these. The conversion
63  * tables are detailed directly in the various Pentium Core datasheets:
64  * http://www.intel.com/design/mobile/datashts/309221.htm
65  *
66  * The 110 (VRM 11) specification corresponds to Intel Conroe based series.
67  * http://www.intel.com/design/processor/applnots/313214.htm
68  */
69
70 /*
71  * vrm is the VRM/VRD document version multiplied by 10.
72  * val is the 4-bit or more VID code.
73  * Returned value is in mV to avoid floating point in the kernel.
74  * Some VID have some bits in uV scale, this is rounded to mV.
75  */
76 int vid_from_reg(int val, u8 vrm)
77 {
78         int vid;
79
80         switch(vrm) {
81
82         case 100:               /* VRD 10.0 */
83                 /* compute in uV, round to mV */
84                 val &= 0x3f;
85                 if((val & 0x1f) == 0x1f)
86                         return 0;
87                 if((val & 0x1f) <= 0x09 || val == 0x0a)
88                         vid = 1087500 - (val & 0x1f) * 25000;
89                 else
90                         vid = 1862500 - (val & 0x1f) * 25000;
91                 if(val & 0x20)
92                         vid -= 12500;
93                 return((vid + 500) / 1000);
94
95         case 110:               /* Intel Conroe */
96                                 /* compute in uV, round to mV */
97                 val &= 0xff;
98                 if (val < 0x02 || val > 0xb2)
99                         return 0;
100                 return((1600000 - (val - 2) * 6250 + 500) / 1000);
101         case 24:                /* Opteron processor */
102                 val &= 0x1f;
103                 return(val == 0x1f ? 0 : 1550 - val * 25);
104
105         case 91:                /* VRM 9.1 */
106         case 90:                /* VRM 9.0 */
107                 val &= 0x1f;
108                 return(val == 0x1f ? 0 :
109                                        1850 - val * 25);
110
111         case 85:                /* VRM 8.5 */
112                 val &= 0x1f;
113                 return((val & 0x10  ? 25 : 0) +
114                        ((val & 0x0f) > 0x04 ? 2050 : 1250) -
115                        ((val & 0x0f) * 50));
116
117         case 84:                /* VRM 8.4 */
118                 val &= 0x0f;
119                                 /* fall through */
120         case 82:                /* VRM 8.2 */
121                 val &= 0x1f;
122                 return(val == 0x1f ? 0 :
123                        val & 0x10  ? 5100 - (val) * 100 :
124                                      2050 - (val) * 50);
125         case 17:                /* Intel IMVP-II */
126                 val &= 0x1f;
127                 return(val & 0x10 ? 975 - (val & 0xF) * 25 :
128                                     1750 - val * 50);
129         case 13:
130                 val &= 0x3f;
131                 return(1708 - val * 16);
132         case 14:                /* Intel Core */
133                                 /* compute in uV, round to mV */
134                 val &= 0x7f;
135                 return(val > 0x77 ? 0 : (1500000 - (val * 12500) + 500) / 1000);
136         default:                /* report 0 for unknown */
137                 if (vrm)
138                         printk(KERN_WARNING "hwmon-vid: Requested unsupported "
139                                "VRM version (%u)\n", (unsigned int)vrm);
140                 return 0;
141         }
142 }
143
144
145 /*
146  * After this point is the code to automatically determine which
147  * VRM/VRD specification should be used depending on the CPU.
148  */
149
150 struct vrm_model {
151         u8 vendor;
152         u8 eff_family;
153         u8 eff_model;
154         u8 eff_stepping;
155         u8 vrm_type;
156 };
157
158 #define ANY 0xFF
159
160 #ifdef CONFIG_X86
161
162 /* the stepping parameter is highest acceptable stepping for current line */
163
164 static struct vrm_model vrm_models[] = {
165         {X86_VENDOR_AMD, 0x6, ANY, ANY, 90},            /* Athlon Duron etc */
166         {X86_VENDOR_AMD, 0xF, ANY, ANY, 24},            /* Athlon 64, Opteron and above VRM 24 */
167         {X86_VENDOR_INTEL, 0x6, 0x9, ANY, 13},          /* Pentium M (130 nm) */
168         {X86_VENDOR_INTEL, 0x6, 0xB, ANY, 85},          /* Tualatin */
169         {X86_VENDOR_INTEL, 0x6, 0xD, ANY, 13},          /* Pentium M (90 nm) */
170         {X86_VENDOR_INTEL, 0x6, 0xE, ANY, 14},          /* Intel Core (65 nm) */
171         {X86_VENDOR_INTEL, 0x6, 0xF, ANY, 110},         /* Intel Conroe */
172         {X86_VENDOR_INTEL, 0x6, ANY, ANY, 82},          /* any P6 */
173         {X86_VENDOR_INTEL, 0xF, 0x0, ANY, 90},          /* P4 */
174         {X86_VENDOR_INTEL, 0xF, 0x1, ANY, 90},          /* P4 Willamette */
175         {X86_VENDOR_INTEL, 0xF, 0x2, ANY, 90},          /* P4 Northwood */
176         {X86_VENDOR_INTEL, 0xF, ANY, ANY, 100},         /* Prescott and above assume VRD 10 */
177         {X86_VENDOR_CENTAUR, 0x6, 0x7, ANY, 85},        /* Eden ESP/Ezra */
178         {X86_VENDOR_CENTAUR, 0x6, 0x8, 0x7, 85},        /* Ezra T */
179         {X86_VENDOR_CENTAUR, 0x6, 0x9, 0x7, 85},        /* Nemiah */
180         {X86_VENDOR_CENTAUR, 0x6, 0x9, ANY, 17},        /* C3-M, Eden-N */
181         {X86_VENDOR_CENTAUR, 0x6, 0xA, 0x7, 0},         /* No information */
182         {X86_VENDOR_CENTAUR, 0x6, 0xA, ANY, 13},        /* C7, Esther */
183         {X86_VENDOR_UNKNOWN, ANY, ANY, ANY, 0}          /* stop here */
184 };
185
186 static u8 find_vrm(u8 eff_family, u8 eff_model, u8 eff_stepping, u8 vendor)
187 {
188         int i = 0;
189
190         while (vrm_models[i].vendor!=X86_VENDOR_UNKNOWN) {
191                 if (vrm_models[i].vendor==vendor)
192                         if ((vrm_models[i].eff_family==eff_family)
193                          && ((vrm_models[i].eff_model==eff_model) ||
194                              (vrm_models[i].eff_model==ANY)) &&
195                              (eff_stepping <= vrm_models[i].eff_stepping))
196                                 return vrm_models[i].vrm_type;
197                 i++;
198         }
199
200         return 0;
201 }
202
203 u8 vid_which_vrm(void)
204 {
205         struct cpuinfo_x86 *c = &cpu_data(0);
206         u32 eax;
207         u8 eff_family, eff_model, eff_stepping, vrm_ret;
208
209         if (c->x86 < 6)         /* Any CPU with family lower than 6 */
210                 return 0;       /* doesn't have VID and/or CPUID */
211
212         eax = cpuid_eax(1);
213         eff_family = ((eax & 0x00000F00)>>8);
214         eff_model  = ((eax & 0x000000F0)>>4);
215         eff_stepping = eax & 0xF;
216         if (eff_family == 0xF) {        /* use extended model & family */
217                 eff_family += ((eax & 0x00F00000)>>20);
218                 eff_model += ((eax & 0x000F0000)>>16)<<4;
219         }
220         vrm_ret = find_vrm(eff_family, eff_model, eff_stepping, c->x86_vendor);
221         if (vrm_ret == 0)
222                 printk(KERN_INFO "hwmon-vid: Unknown VRM version of your "
223                        "x86 CPU\n");
224         return vrm_ret;
225 }
226
227 /* and now for something completely different for the non-x86 world */
228 #else
229 u8 vid_which_vrm(void)
230 {
231         printk(KERN_INFO "hwmon-vid: Unknown VRM version of your CPU\n");
232         return 0;
233 }
234 #endif
235
236 EXPORT_SYMBOL(vid_from_reg);
237 EXPORT_SYMBOL(vid_which_vrm);
238
239 MODULE_AUTHOR("Rudolf Marek <r.marek@assembler.cz>");
240
241 MODULE_DESCRIPTION("hwmon-vid driver");
242 MODULE_LICENSE("GPL");