Dump support for the Winbond W83977TF.
[coreboot.git] / util / superiotool / winbond.c
1 /*
2  * This file is part of the superiotool project.
3  *
4  * Copyright (C) 2007 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2007 Rasmus Wiman <rasmus@wiman.org>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
20  */
21
22 #include "superiotool.h"
23
24 #define DEVICE_ID_REG_OLD       0x09
25
26 #define DEVICE_ID_REG           0x20
27 #define DEVICE_REV_REG          0x21
28
29 /**
30  * The ID entries must be in 0xYYZ format, where YY is the device ID,
31  * and Z is bits 7..4 of the device revision register. We do not match
32  * bits 3..0 of the device revision here (at least for newer Super I/Os).
33  *
34  * But some of the older versions use both bytes (0x20 and 0x21), where
35  * register 0x21 holds the ID and the full 8 bits of 0x21 hold the revision.
36  *
37  * Some other Super I/Os only use bits 3..0 of 0x09 as ID.
38  */
39 const static struct superio_registers reg_table[] = {
40         /* ID and rev[3..0] */
41         {0x527, "W83977CTF", {  /* TODO: Not yet in sensors-detect */
42                 {EOT}}},
43         {0x52f, "W83977EF/EG", {/* TODO: Not yet in sensors-detect */
44                 {EOT}}},
45         {0x595, "W83627SF", {   /* TODO: Not yet in sensors-detect */
46                 {EOT}}},
47         {0x601, "W83697HF/F/HG", { /* No G version? */
48                 {NOLDN, NULL,
49                         {0x07,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x28,0x29,
50                          0x2a,EOT},
51                         {NANA,0x60,NANA,0xff,0x00,0x00,0x00,0x00,0x00,0x00,
52                          MISC,EOT}},
53                 /* Some register defaults depend on the value of PNPCSV. */
54                 {0x0, "Floppy",
55                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,
56                          0xf5,EOT},
57                         {0x01,0x03,0xf0,0x06,0x02,0x0e,0x00,0xff,0x00,
58                          0x00,EOT}},
59                 {0x1, "Parallel port",
60                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
61                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
62                 {0x2, "COM1",
63                         {0x30,0x60,0x61,0x70,0xf0,EOT},
64                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
65                 {0x3, "COM2",
66                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
67                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
68                 {0x6, "Consumer IR",
69                         {0x30,0x60,0x61,0x70,EOT},
70                         {0x00,0x00,0x00,0x00,EOT}},
71                 {0x7, "Game port, GPIO 1",
72                         {0x30,0x60,0x61,0x62,0x63,0xf0,0xf1,0xf2,EOT},
73                         {0x00,0x02,0x01,0x00,0x00,0xff,0x00,0x00,EOT}},
74                 {0x8, "MIDI port, GPIO 5",
75                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
76                          0xf4,0xf5,EOT},
77                         {0x00,0x03,0x30,0x00,0x00,0x09,0xff,0x00,0x00,0x00,
78                          0x00,0x00,EOT}},
79                 {0x9, "GPIO 2, GPIO 3, GPIO 4",
80                         {0x30,0x60,0x61,0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,
81                          0xf7,0xf8,0xf5,EOT},
82                         {0x00,0x00,0x00,0xff,0x00,0x00,0xff,0x00,0x00,0xff,
83                          0x00,0x00,0x00,EOT}},
84                 {0xa, "ACPI",
85                         {0x30,0x70,0xe0,0xe1,0xe2,0xe5,0xe6,0xe7,
86                          0xf0,0xf1,0xf3,0xf4,0xf6,0xf7,0xf9,EOT},
87                         {0x00,0x00,0x00,0x00,NANA,0x00,0x00,0x00,
88                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,EOT}},
89                 {0xb, "Hardware monitor",
90                         {0x30,0x60,0x61,0x70,EOT},
91                         {0x00,0x00,0x00,0x00,EOT}},
92                 {EOT}}},
93         {0x610, "W83L517D/D-F", {
94                 {EOT}}},
95         {0x681, "W83697SF/UF/UG", {
96                 {EOT}}},
97         {0x708, "W83637HF/HG", {
98                 {EOT}}},
99         {0x828, "W83627THF/THG", { /* We assume rev is bits 3..0 of 0x21. */
100                 {NOLDN, NULL,
101                         {0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x28,0x29,0x2a,
102                          0x2b,0x2c,0x2d,0x2e,0x2f,EOT},
103                         {0x82,NANA,0xff,0x00,MISC,0x00,MISC,0x00,0x00,0x00,
104                          MISC,MISC,MISC,0x00,0x00,EOT}},
105                 /* Some register defaults depend on the value of PNPCSV. */
106                 {0x0, "Floppy",
107                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,
108                          0xf5,EOT},
109                         {0x01,0x03,0xf0,0x06,0x02,0x0e,0x00,0xff,0x00,
110                          0x00,EOT}},
111                 {0x1, "Parallel port",
112                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
113                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
114                 {0x2, "COM1",
115                         {0x30,0x60,0x61,0x70,0xf0,EOT},
116                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
117                 {0x3, "COM2",
118                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
119                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
120                 {0x5, "Keyboard",
121                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
122                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x80,EOT}},
123                 {0x7, "GPIO 1, GPIO 5, game port, MIDI port",
124                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
125                          0xf4,0xf5,EOT},
126                         {0x00,0x02,0x01,0x03,0x30,0x09,0xff,0x00,0x00,0xff,
127                          0x00,0x00,EOT}},
128                 {0x8, "GPIO 2",
129                         {0x30,0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,0xf7,EOT},
130                         {0x00,0xff,0x00,0x00,0x00,RSVD,0x00,0x00,0x00,EOT}},
131                 {0x9, "GPIO 3, GPIO 4",
132                         {0x30,0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,EOT},
133                         {0x00,0xff,0x00,0x00,0x00,0xff,0x00,0x00,EOT}},
134                 {0xa, "ACPI",
135                         /* Note: Datasheet says 0xe2 can't be read/written. */
136                         {0x30,0x70,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
137                          0xf0,0xf1,0xf3,0xf4,0xf6,0xf7,0xf9,0xfe,0xff,EOT},
138                         {0x00,0x00,0x00,0x00,MISC,MISC,0x00,0x00,0x00,0x00,
139                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,RSVD,RSVD,EOT}},
140                 {0xb, "Hardware monitor",
141                         {0x30,0x60,0x61,0x70,EOT},
142                         {0x00,0x00,0x00,0x00,EOT}},
143                 {EOT}}},
144 #if 0
145         {0x85x, "W83687THF", {  /* TODO: sensors-detect: 0x85 */
146                 {EOT}}},
147 #endif
148         {0xa02, "W83627DHG", {
149                 {EOT}}},
150         {0x886, "W83627EHF/EF/EHG/EG", { /* sensors-detect: 0x8853 possible */
151                 {NOLDN, NULL,
152                         {0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
153                          0x29,0x2a,0x2b,0x2c,0x2d,0x2e,0x2f,EOT},
154                         {0x88,MISC,0xff,0x00,MISC,0x00,MISC,RSVD,0x50,
155                          0x04,0x00,RSVD,0x00,0x21,0x00,0x00,EOT}},
156                 {0x0, "Floppy",
157                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,
158                          0xf5,EOT},
159                         {0x01,0x03,0xf0,0x06,0x02,0x8e,0x00,0xff,0x00,
160                          0x00,EOT}},
161                 {0x1, "Parallel port",
162                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
163                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
164                 {0x2, "COM1",
165                         {0x30,0x60,0x61,0x70,0xf0,EOT},
166                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
167                 {0x3, "COM2",
168                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
169                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
170                 {0x5, "Keyboard",
171                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
172                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x83,EOT}},
173                 {0x6, "Serial flash interface",
174                         {0x30,0x62,0x63,EOT},
175                         {0x00,0x00,0x00,EOT}},
176                 {0x7, "GPIO 1, GPIO 6, game port, MIDI port",
177                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
178                          0xf4,0xf5,0xf6,0xf7,EOT},
179                         {0x00,0x02,0x01,0x03,0x30,0x09,0xff,0x00,0x00,0x00,
180                          0xff,0x00,0x00,0x00,EOT}},
181                 {0x8, "WDTO#, PLED",
182                         {0x30,0xf5,0xf6,0xf7,EOT},
183                         {0x00,0x00,0x00,0x00,EOT}},
184                 {0x9, "GPIO 2, GPIO 3, GPIO 4, GPIO 5, SUSLED",
185                         {0x30,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xf0,0xf1,0xf2,
186                          0xf3,0xf4,0xf5,0xf6,0xf7,EOT},
187                         {0x00,0xff,0x00,0x00,0xff,0x00,0x00,0xff,0x00,0x00,
188                          0x00,0xff,0x00,0x00,0x00,EOT}},
189                 {0xa, "ACPI",
190                         {0x30,0x70,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
191                          0xe8,0xf2,0xf3,0xf4,0xf6,0xf7,EOT},
192                         {0x00,0x00,0x01,0x00,0xff,0x08,0x00,RSVD,0x00,0x00,
193                          RSVD,0x7c,0x00,0x00,0x00,0x00,EOT}},
194                 {0xb, "Hardware monitor",
195                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
196                         {0x00,0x00,0x00,0x00,0xc1,0x00,EOT}},
197                 {EOT}}},
198         {0xa23, "W83627UHG", {/* TODO: Not yet in sensors-detect */
199                 {EOT}}},
200
201         /* ID and rev */
202         {0x9771, "W83977F-A/G-A/AF-A/AG-A", {
203                 {EOT}}},
204         {0x9773, "W83977TF", {
205                 {NOLDN, NULL,
206                         {0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x28,0x2a,0x2b,
207                          0x2c,0x2d,0x2e,0x2f,EOT},
208                         {0x97,0x73,0xff,0xfe,MISC,0x00,MISC,0x00,0x00,0x00,
209                          0x00,RSVD,RSVD,RSVD,EOT}},
210                 {0x0, "Floppy",
211                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,0xf5,
212                          EOT},
213                         {0x01,0x03,0xf0,0x06,0x02,0x0e,0x00,0xff,0x00,0x00,
214                          EOT}},
215                 {0x1, "Parallel port",
216                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
217                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
218                 {0x2, "COM1",
219                         {0x30,0x60,0x61,0x70,0xf0,EOT},
220                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
221                 {0x3, "COM2",
222                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
223                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
224                 {0x5, "Keyboard / mouse",
225                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
226                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x83,EOT}},
227                 {0x7, "GPIO 1",
228                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0x72,0xe0,
229                          0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,0xf1,EOT},
230                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01,
231                          0x01,0x01,0x01,0x01,0x01,0x01,0x01,0x00,EOT}},
232                 {0x8, "GPIO 2",
233                         {0x30,0x60,0x61,0x70,0x72,0xe8,0xe9,0xea,0xeb,0xec,
234                          0xed,0xee,0xf0,0xf1,0xf2,0xf3,0xf4,EOT},
235                         {0x00,0x00,0x00,0x00,0x00,0x01,0x01,0x01,0x01,0x01,
236                          0x01,0x01,0x00,RSVD,0x00,0x00,0x00,EOT}},
237                 {0x9, "GPIO 3",
238                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0x72,0xe0,
239                          0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,0xf1,EOT},
240                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01,
241                          0x01,0x01,0x01,0x01,0x01,0x01,0x01,0x00,EOT}},
242                 {0xa, "ACPI",
243                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0xe0,0xe1,
244                          0x02,0xe3,0xe4,0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,
245                          0xf7,0xfe,0xff,EOT},
246                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
247                          NANA,MISC,RSVD,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
248                          0x00,RSVD,RSVD,EOT}},
249                 {EOT}}},
250         {0x9774, "W83977ATF", {
251                 {EOT}}},
252
253         /* ID only */
254         {0x52, "W83627HF/F/HG/G", {
255                 {NOLDN, NULL,
256                         {0x02,0x07,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x28,
257                          0x29,0x2a,0x2b,0x2c,0x2e,0x2f,EOT},
258                         {0x00,NANA,0x52,NANA,0xff,0x00,MISC,0x00,0x00,0x00,
259                          0x00,0x7c,0xc0,0x00,0x00,0x00,EOT}},
260                 {0x0, "Floppy",
261                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,
262                          0xf5,EOT},
263                         {0x01,0x03,0xf0,0x06,0x02,0x0e,0x00,0xff,0x00,
264                          0x00,EOT}},
265                 {0x1, "Parallel port",
266                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
267                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
268                 {0x2, "COM1",
269                         {0x30,0x60,0x61,0x70,0xf0,EOT},
270                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
271                 {0x3, "COM2",
272                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
273                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
274                 {0x5, "Keyboard",
275                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
276                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x80,EOT}},
277                 {0x6, "Consumer IR",
278                         {0x30,0x60,0x61,0x70,EOT},
279                         {0x00,0x00,0x00,0x00,EOT}},
280                 {0x7, "Game port, MIDI port, GPIO 1",
281                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,EOT},
282                         {0x00,0x02,0x01,0x03,0x30,0x09,0xff,0x00,0x00,EOT}},
283                 {0x8, "GPIO 2, Watchdog timer",
284                         {0x30,0xf0,0xf1,0xf2,0xf3,0xf5,0xf6,0xf6,0xf7,EOT},
285                         {0x00,0xff,0x00,0x00,0x00,0x00,0x00,0x00,0x00,EOT}},
286                 {0x9, "GPIO 3",
287                         {0x30,0xf0,0xf1,0xf2,0xf3,EOT},
288                         {0x00,0xff,0x00,0x00,0x00,EOT}},
289                 {0xa, "ACPI",
290                         {0x30,0x70,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
291                          0xf0,0xf1,0xf3,0xf4,0xf6,0xf7,0xf9,0xfe,0xff,EOT},
292                         {0x00,0x00,0x00,0x00,NANA,NANA,0x00,0x00,0x00,0x00,
293                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,EOT}},
294                 {0xb, "Hardware monitor",
295                         {0x30,0x60,0x61,0x70,0xf0,EOT},
296                         {0x00,0x00,0x00,0x00,0x00,EOT}},
297                 {EOT}}},
298
299         /* ID[3..0] */
300         {0xa, "W83877F", {
301                 {EOT}}},
302         {0xc, "W83877TF", {
303                 {EOT}}},
304         {0xd, "W83877ATF", {
305                 {EOT}}},
306         {EOT}
307 };
308
309 static void enter_conf_mode_winbond_88(uint16_t port)
310 {
311         outb(0x88, port);
312 }
313
314 static void enter_conf_mode_winbond_89(uint16_t port)
315 {
316         outb(0x89, port);
317 }
318
319 static void enter_conf_mode_winbond_86(uint16_t port)
320 {
321         outb(0x86, port);
322         outb(0x86, port);
323 }
324
325 void probe_idregs_winbond_helper(const char *init, uint16_t port)
326 {
327         uint16_t id;
328         uint8_t devid, rev, olddevid;
329
330         probing_for("Winbond", init, port);
331
332         devid = regval(port, DEVICE_ID_REG);
333         rev = regval(port, DEVICE_REV_REG);
334         olddevid = regval(port, DEVICE_ID_REG_OLD) & 0x0f;
335
336         if (devid == 0x52)
337                 id = devid;                              /* ID only */
338         else if ((devid == 0x97) && ((rev & 0xf0) == 0x70))
339                 id = (devid << 8) | rev;                 /* ID and rev */
340         else
341                 id = (devid << 4) | ((rev & 0xf0) >> 4); /* ID and rev[3..0] */
342
343         if (olddevid == 0x0a || olddevid == 0x0c || olddevid == 0x0d)
344                 id = olddevid & 0x0f;                    /* ID[3..0] */
345
346         if (superio_unknown(reg_table, id)) {
347                 if (verbose)
348                         printf(NOTFOUND "id/oldid=0x%02x/0x%02x, rev=0x%02x\n",
349                                devid, olddevid, rev);
350                 exit_conf_mode_winbond_fintek_ite_8787(port);
351                 return;
352         }
353
354         if (olddevid == 0x0a || olddevid == 0x0c || olddevid == 0x0d)
355                 printf("Found Winbond %s (id=0x%02x) at 0x%x\n",
356                        get_superio_name(reg_table, id), olddevid, port);
357         else
358                 printf("Found Winbond %s (id=0x%02x, rev=0x%02x) at 0x%x\n",
359                        get_superio_name(reg_table, id), devid, rev, port);
360         chip_found = 1;
361
362         /* TODO: Special notes in dump output for the MISC entries. */
363         dump_superio("Winbond", reg_table, port, id);
364         dump_superio_readable(port); /* TODO */
365 }
366
367 void probe_idregs_winbond(uint16_t port)
368 {
369         /* TODO: Not all init sequences are valid for all ports. */
370
371         enter_conf_mode_winbond_88(port);
372         probe_idregs_winbond_helper("(init=0x88) ", port);
373         exit_conf_mode_winbond_fintek_ite_8787(port);
374
375         enter_conf_mode_winbond_89(port);
376         probe_idregs_winbond_helper("(init=0x89) ", port);
377         exit_conf_mode_winbond_fintek_ite_8787(port);
378
379         enter_conf_mode_winbond_86(port);
380         probe_idregs_winbond_helper("(init=0x86,0x86) ", port);
381         exit_conf_mode_winbond_fintek_ite_8787(port);
382
383         enter_conf_mode_winbond_fintek_ite_8787(port);
384         probe_idregs_winbond_helper("(init=0x87,0x87) ", port);
385         exit_conf_mode_winbond_fintek_ite_8787(port);
386 }
387