Add detection support for the Winbond W83977AF as found in the
[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         {0x708, "W83637HF/HG", {
96                 {EOT}}},
97         {0x828, "W83627THF/THG", { /* We assume rev is bits 3..0 of 0x21. */
98                 {NOLDN, NULL,
99                         {0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x28,0x29,0x2a,
100                          0x2b,0x2c,0x2d,0x2e,0x2f,EOT},
101                         {0x82,NANA,0xff,0x00,MISC,0x00,MISC,0x00,0x00,0x00,
102                          MISC,MISC,MISC,0x00,0x00,EOT}},
103                 /* Some register defaults depend on the value of PNPCSV. */
104                 {0x0, "Floppy",
105                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,
106                          0xf5,EOT},
107                         {0x01,0x03,0xf0,0x06,0x02,0x0e,0x00,0xff,0x00,
108                          0x00,EOT}},
109                 {0x1, "Parallel port",
110                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
111                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
112                 {0x2, "COM1",
113                         {0x30,0x60,0x61,0x70,0xf0,EOT},
114                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
115                 {0x3, "COM2",
116                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
117                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
118                 {0x5, "Keyboard",
119                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
120                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x80,EOT}},
121                 {0x7, "GPIO 1, GPIO 5, game port, MIDI port",
122                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
123                          0xf4,0xf5,EOT},
124                         {0x00,0x02,0x01,0x03,0x30,0x09,0xff,0x00,0x00,0xff,
125                          0x00,0x00,EOT}},
126                 {0x8, "GPIO 2",
127                         {0x30,0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,0xf7,EOT},
128                         {0x00,0xff,0x00,0x00,0x00,RSVD,0x00,0x00,0x00,EOT}},
129                 {0x9, "GPIO 3, GPIO 4",
130                         {0x30,0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,EOT},
131                         {0x00,0xff,0x00,0x00,0x00,0xff,0x00,0x00,EOT}},
132                 {0xa, "ACPI",
133                         /* Note: Datasheet says 0xe2 can't be read/written. */
134                         {0x30,0x70,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
135                          0xf0,0xf1,0xf3,0xf4,0xf6,0xf7,0xf9,0xfe,0xff,EOT},
136                         {0x00,0x00,0x00,0x00,MISC,MISC,0x00,0x00,0x00,0x00,
137                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,RSVD,RSVD,EOT}},
138                 {0xb, "Hardware monitor",
139                         {0x30,0x60,0x61,0x70,EOT},
140                         {0x00,0x00,0x00,0x00,EOT}},
141                 {EOT}}},
142 #if 0
143         {0x85x, "W83687THF", {  /* TODO: sensors-detect: 0x85 */
144                 {EOT}}},
145 #endif
146         {0xa02, "W83627DHG", {
147                 {EOT}}},
148         {0x886, "W83627EHF/EF/EHG/EG", { /* sensors-detect: 0x8853 possible */
149                 {NOLDN, NULL,
150                         {0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
151                          0x29,0x2a,0x2b,0x2c,0x2d,0x2e,0x2f,EOT},
152                         {0x88,MISC,0xff,0x00,MISC,0x00,MISC,RSVD,0x50,
153                          0x04,0x00,RSVD,0x00,0x21,0x00,0x00,EOT}},
154                 {0x0, "Floppy",
155                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,
156                          0xf5,EOT},
157                         {0x01,0x03,0xf0,0x06,0x02,0x8e,0x00,0xff,0x00,
158                          0x00,EOT}},
159                 {0x1, "Parallel port",
160                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
161                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
162                 {0x2, "COM1",
163                         {0x30,0x60,0x61,0x70,0xf0,EOT},
164                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
165                 {0x3, "COM2",
166                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
167                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
168                 {0x5, "Keyboard",
169                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
170                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x83,EOT}},
171                 {0x6, "Serial flash interface",
172                         {0x30,0x62,0x63,EOT},
173                         {0x00,0x00,0x00,EOT}},
174                 {0x7, "GPIO 1, GPIO 6, game port, MIDI port",
175                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
176                          0xf4,0xf5,0xf6,0xf7,EOT},
177                         {0x00,0x02,0x01,0x03,0x30,0x09,0xff,0x00,0x00,0x00,
178                          0xff,0x00,0x00,0x00,EOT}},
179                 {0x8, "WDTO#, PLED",
180                         {0x30,0xf5,0xf6,0xf7,EOT},
181                         {0x00,0x00,0x00,0x00,EOT}},
182                 {0x9, "GPIO 2, GPIO 3, GPIO 4, GPIO 5, SUSLED",
183                         {0x30,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xf0,0xf1,0xf2,
184                          0xf3,0xf4,0xf5,0xf6,0xf7,EOT},
185                         {0x00,0xff,0x00,0x00,0xff,0x00,0x00,0xff,0x00,0x00,
186                          0x00,0xff,0x00,0x00,0x00,EOT}},
187                 {0xa, "ACPI",
188                         {0x30,0x70,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
189                          0xe8,0xf2,0xf3,0xf4,0xf6,0xf7,EOT},
190                         {0x00,0x00,0x01,0x00,0xff,0x08,0x00,RSVD,0x00,0x00,
191                          RSVD,0x7c,0x00,0x00,0x00,0x00,EOT}},
192                 {0xb, "Hardware monitor",
193                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
194                         {0x00,0x00,0x00,0x00,0xc1,0x00,EOT}},
195                 {EOT}}},
196         {0xa23, "W83627UHG", {/* TODO: Not yet in sensors-detect */
197                 {EOT}}},
198
199         /* ID and rev */
200         {0x9771, "W83977F-A/G-A/AF-A/AG-A", {
201                 {EOT}}},
202         {0x9777, "W83977AF", {
203                 /* W83977AF as found on the Advantech PCM-5820. We weren't able
204                  * to find a datasheet (so far) which lists the 0x77 revision,
205                  * but the hardware is there in the wild, so detect it...
206                  */
207                 {EOT}}},
208         {0x9773, "W83977TF", {
209                 {NOLDN, NULL,
210                         {0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x28,0x2a,0x2b,
211                          0x2c,0x2d,0x2e,0x2f,EOT},
212                         {0x97,0x73,0xff,0xfe,MISC,0x00,MISC,0x00,0x00,0x00,
213                          0x00,RSVD,RSVD,RSVD,EOT}},
214                 {0x0, "Floppy",
215                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,0xf5,
216                          EOT},
217                         {0x01,0x03,0xf0,0x06,0x02,0x0e,0x00,0xff,0x00,0x00,
218                          EOT}},
219                 {0x1, "Parallel port",
220                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
221                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
222                 {0x2, "COM1",
223                         {0x30,0x60,0x61,0x70,0xf0,EOT},
224                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
225                 {0x3, "COM2",
226                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
227                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
228                 {0x5, "Keyboard / mouse",
229                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
230                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x83,EOT}},
231                 {0x7, "GPIO 1",
232                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0x72,0xe0,
233                          0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,0xf1,EOT},
234                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01,
235                          0x01,0x01,0x01,0x01,0x01,0x01,0x01,0x00,EOT}},
236                 {0x8, "GPIO 2",
237                         {0x30,0x60,0x61,0x70,0x72,0xe8,0xe9,0xea,0xeb,0xec,
238                          0xed,0xee,0xf0,0xf1,0xf2,0xf3,0xf4,EOT},
239                         {0x00,0x00,0x00,0x00,0x00,0x01,0x01,0x01,0x01,0x01,
240                          0x01,0x01,0x00,RSVD,0x00,0x00,0x00,EOT}},
241                 {0x9, "GPIO 3",
242                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0x72,0xe0,
243                          0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,0xf1,EOT},
244                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01,
245                          0x01,0x01,0x01,0x01,0x01,0x01,0x01,0x00,EOT}},
246                 {0xa, "ACPI",
247                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0xe0,0xe1,
248                          0x02,0xe3,0xe4,0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,
249                          0xf7,0xfe,0xff,EOT},
250                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
251                          NANA,MISC,RSVD,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
252                          0x00,RSVD,RSVD,EOT}},
253                 {EOT}}},
254         {0x9774, "W83977ATF", {
255                 {EOT}}},
256
257         /* ID only */
258         {0x52, "W83627HF/F/HG/G", {
259                 {NOLDN, NULL,
260                         {0x02,0x07,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x28,
261                          0x29,0x2a,0x2b,0x2c,0x2e,0x2f,EOT},
262                         {0x00,NANA,0x52,NANA,0xff,0x00,MISC,0x00,0x00,0x00,
263                          0x00,0x7c,0xc0,0x00,0x00,0x00,EOT}},
264                 {0x0, "Floppy",
265                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,0xf2,0xf4,
266                          0xf5,EOT},
267                         {0x01,0x03,0xf0,0x06,0x02,0x0e,0x00,0xff,0x00,
268                          0x00,EOT}},
269                 {0x1, "Parallel port",
270                         {0x30,0x60,0x61,0x70,0x74,0xf0,EOT},
271                         {0x01,0x03,0x78,0x07,0x04,0x3f,EOT}},
272                 {0x2, "COM1",
273                         {0x30,0x60,0x61,0x70,0xf0,EOT},
274                         {0x01,0x03,0xf8,0x04,0x00,EOT}},
275                 {0x3, "COM2",
276                         {0x30,0x60,0x61,0x70,0xf0,0xf1,EOT},
277                         {0x01,0x02,0xf8,0x03,0x00,0x00,EOT}},
278                 {0x5, "Keyboard",
279                         {0x30,0x60,0x61,0x62,0x63,0x70,0x72,0xf0,EOT},
280                         {0x01,0x00,0x60,0x00,0x64,0x01,0x0c,0x80,EOT}},
281                 {0x6, "Consumer IR",
282                         {0x30,0x60,0x61,0x70,EOT},
283                         {0x00,0x00,0x00,0x00,EOT}},
284                 {0x7, "Game port, MIDI port, GPIO 1",
285                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,EOT},
286                         {0x00,0x02,0x01,0x03,0x30,0x09,0xff,0x00,0x00,EOT}},
287                 {0x8, "GPIO 2, Watchdog timer",
288                         {0x30,0xf0,0xf1,0xf2,0xf3,0xf5,0xf6,0xf6,0xf7,EOT},
289                         {0x00,0xff,0x00,0x00,0x00,0x00,0x00,0x00,0x00,EOT}},
290                 {0x9, "GPIO 3",
291                         {0x30,0xf0,0xf1,0xf2,0xf3,EOT},
292                         {0x00,0xff,0x00,0x00,0x00,EOT}},
293                 {0xa, "ACPI",
294                         {0x30,0x70,0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
295                          0xf0,0xf1,0xf3,0xf4,0xf6,0xf7,0xf9,0xfe,0xff,EOT},
296                         {0x00,0x00,0x00,0x00,NANA,NANA,0x00,0x00,0x00,0x00,
297                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,EOT}},
298                 {0xb, "Hardware monitor",
299                         {0x30,0x60,0x61,0x70,0xf0,EOT},
300                         {0x00,0x00,0x00,0x00,0x00,EOT}},
301                 {EOT}}},
302         {0x68, "W83697SF/UF/UG", {      /* TODO: Add comment. */
303                 {EOT}}},
304
305         /* ID[3..0] */
306         {0xa, "W83877F", {
307                 {EOT}}},
308         {0xc, "W83877TF", {
309                 {EOT}}},
310         {0xd, "W83877ATF", {
311                 {EOT}}},
312         {EOT}
313 };
314
315 static void enter_conf_mode_winbond_88(uint16_t port)
316 {
317         outb(0x88, port);
318 }
319
320 static void enter_conf_mode_winbond_89(uint16_t port)
321 {
322         outb(0x89, port);
323 }
324
325 static void enter_conf_mode_winbond_86(uint16_t port)
326 {
327         outb(0x86, port);
328         outb(0x86, port);
329 }
330
331 void probe_idregs_winbond_helper(const char *init, uint16_t port)
332 {
333         uint16_t id;
334         uint8_t devid, rev, olddevid;
335
336         probing_for("Winbond", init, port);
337
338         devid = regval(port, DEVICE_ID_REG);
339         rev = regval(port, DEVICE_REV_REG);
340         olddevid = regval(port, DEVICE_ID_REG_OLD) & 0x0f;
341
342         if (devid == 0x52 || devid == 0x68)
343                 id = devid;                              /* ID only */
344         else if ((devid == 0x97) && ((rev & 0xf0) == 0x70))
345                 id = (devid << 8) | rev;                 /* ID and rev */
346         else
347                 id = (devid << 4) | ((rev & 0xf0) >> 4); /* ID and rev[3..0] */
348
349         if (olddevid == 0x0a || olddevid == 0x0c || olddevid == 0x0d)
350                 id = olddevid & 0x0f;                    /* ID[3..0] */
351
352         if (superio_unknown(reg_table, id)) {
353                 if (verbose)
354                         printf(NOTFOUND "id/oldid=0x%02x/0x%02x, rev=0x%02x\n",
355                                devid, olddevid, rev);
356                 exit_conf_mode_winbond_fintek_ite_8787(port);
357                 return;
358         }
359
360         if (olddevid == 0x0a || olddevid == 0x0c || olddevid == 0x0d)
361                 printf("Found Winbond %s (id=0x%02x) at 0x%x\n",
362                        get_superio_name(reg_table, id), olddevid, port);
363         else
364                 printf("Found Winbond %s (id=0x%02x, rev=0x%02x) at 0x%x\n",
365                        get_superio_name(reg_table, id), devid, rev, port);
366         chip_found = 1;
367
368         /* TODO: Special notes in dump output for the MISC entries. */
369         dump_superio("Winbond", reg_table, port, id);
370         dump_superio_readable(port); /* TODO */
371 }
372
373 void probe_idregs_winbond(uint16_t port)
374 {
375         /* TODO: Not all init sequences are valid for all ports. */
376
377         enter_conf_mode_winbond_88(port);
378         probe_idregs_winbond_helper("(init=0x88) ", port);
379         exit_conf_mode_winbond_fintek_ite_8787(port);
380
381         enter_conf_mode_winbond_89(port);
382         probe_idregs_winbond_helper("(init=0x89) ", port);
383         exit_conf_mode_winbond_fintek_ite_8787(port);
384
385         enter_conf_mode_winbond_86(port);
386         probe_idregs_winbond_helper("(init=0x86,0x86) ", port);
387         exit_conf_mode_winbond_fintek_ite_8787(port);
388
389         enter_conf_mode_winbond_fintek_ite_8787(port);
390         probe_idregs_winbond_helper("(init=0x87,0x87) ", port);
391         exit_conf_mode_winbond_fintek_ite_8787(port);
392 }
393