Fix up and generalize the ITE IT8708F code. It was only working out of
[coreboot.git] / util / superiotool / ite.c
1 /*
2  * This file is part of the LinuxBIOS project.
3  *
4  * Copyright (C) 2007 Carl-Daniel Hailfinger
5  * Copyright (C) 2007 Uwe Hermann <uwe@hermann-uwe.de>
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 CHIP_ID_BYTE1_REG       0x20
25 #define CHIP_ID_BYTE2_REG       0x21
26 #define CHIP_VERSION_REG        0x22
27
28 /* Note: IT8726F has ID 0x8726 (datasheet wrongly says 0x8716). */
29 const static struct superio_registers reg_table[] = {
30         {0x8702, "IT8702F", {
31                 {EOT}}},
32         {0x8705, "IT8705F or IT8700F", {
33                 {EOT}}},
34         {0x8708, "IT8708F", {
35                 {NOLDN, NULL,
36                         {0x07,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
37                          0x29,0x2a,0x2e,0x2f,EOT},
38                         {NANA,0x87,0x08,0x00,0x00,NANA,0x3f,0x00,0xff,0xff,
39                          0xff,0xff,0x00,0x00,EOT}},
40                 {0x0, "Floppy",
41                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
42                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
43                 {0x1, "COM1",
44                         {0x30,0x60,0x61,0x70,0xf0,EOT},
45                         {0x00,0x03,0xf8,0x04,0x00,EOT}},
46                 {0x2, "COM2",
47                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
48                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
49                 {0x3, "Parallel port",
50                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0x74,
51                          0xf0,EOT},
52                         {0x00,0x03,0x78,0x07,0x78,0x00,0x80,0x07,0x03,
53                          0x03,EOT}},
54                 {0x4, "SWC",
55                         {0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
56                          0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,EOT},
57                         {NANA,NANA,0x00,0x00,0x00,0x00,0x00,0x00,
58                          0x00,0x00,0x00,0x00,0x00,NANA,NANA,EOT}},
59                 {0x5, "Keyboard",
60                         /* Note: 0x30 can actually be 0x00 _or_ 0x01. */
61                         {0x30,0x60,0x61,0x62,0x63,0x70,0x71,0xf0,EOT},
62                         {0x01,0x00,0x60,0x00,0x64,0x01,0x02,0x00,EOT}},
63                 {0x6, "Mouse",
64                         {0x30,0x70,0x71,0xf0,EOT},
65                         {0x00,0x0c,0x02,0x00,EOT}},
66                 {0x7, "GPIO",
67                         {0x70,0xb0,0xb1,0xb2,0xb3,0xb4,0xb5,0xb8,0xb9,0xba,
68                          0xbb,0xbc,0xbd,0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc8,
69                          0xc9,0xca,0xcb,0xcc,0xcd,0xd0,0xd1,0xd2,0xd3,0xd4,
70                          0xd5,0xd6,0xd7,0xd8,0xd9,0xda,0xdb,0xdc,0xf0,0xf1,
71                          0xf2,0xf3,0xf4,0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,
72                          0xfc,EOT},
73                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
74                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
75                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
76                          0x00,0x00,NANA,NANA,NANA,NANA,NANA,NANA,0x00,0x00,
77                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,NANA,
78                          0x00,EOT}},
79                 {0x8, "Game port",
80                         {0x30,0x60,0x61,EOT},
81                         {0x00,0x02,0x01,EOT}},
82                 {0x9, "Consumer IR",
83                         {0x30,0x60,0x61,0x70,0xf0,EOT},
84                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
85                 {0xa, "MIDI port",
86                         {0x30,0x60,0x61,0x70,0xf0,EOT},
87                         {0x00,0x03,0x00,0x0a,0x00,EOT}},
88                 {EOT}}},
89         {0x8710, "IT8710F", {
90                 {EOT}}},
91         {0x8712, "IT8712F", {
92                 {NOLDN, NULL,
93                         {0x07,0x20,0x21,0x22,0x23,0x24,0x2b,EOT},
94                         {NANA,0x87,0x12,0x08,0x00,0x00,0x00,EOT}},
95                 {0x0, "Floppy",
96                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
97                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
98                 {0x1, "COM1",
99                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
100                         {0x00,0x03,0xf8,0x04,0x00,0x50,0x00,0x7f,EOT}},
101                 {0x2, "COM2",
102                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
103                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
104                 {0x3, "Parallel port",
105                         {0x30,0x60,0x61,0x62,0x63,0x70,0x74,0xf0,EOT},
106                         {0x00,0x03,0x78,0x07,0x78,0x07,0x03,0x03,EOT}},
107                 {0x4, "Environment controller",
108                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
109                          0xf4,0xf5,0xf6,EOT},
110                         {0x00,0x02,0x90,0x02,0x30,0x09,0x00,0x00,0x00,0x00,
111                          0x00,NANA,NANA,EOT}},
112                 {0x5, "Keyboard",
113                         /* TODO: 0xf0: Error in datasheet? */
114                         {0x30,0x60,0x61,0x62,0x63,0x70,0x71,0xf0,EOT},
115                         {0x01,0x00,0x60,0x00,0x64,0x01,0x02,0x08,EOT}},
116                 {0x6, "Mouse",
117                         {0x30,0x70,0x71,0xf0,EOT},
118                         {0x00,0x0c,0x02,0x00,EOT}},
119                 {0x7, "GPIO", /* TODO: 0x72, 0x73: Errors in datasheet? */
120                         {0x25,0x26,0x27,0x28,0x29,0x2a,0x2c,0x60,0x61,0x62,
121                          0x63,0x64,0x65,0x70,0x71,0x72,0x73,0x74,0xb0,0xb1,
122                          0xb2,0xb3,0xb4,0xb5,0xb8,0xb9,0xba,0xbb,0xbc,0xbd,
123                          0xc0,0xc1,0xc2,0xc3,0xc4,0xc8,0xc9,0xca,0xcb,0xcc,
124                          0xe0,0xe1,0xe2,0xe3,0xe4,0xf0,0xf1,0xf2,0xf3,0xf4,
125                          0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,0xfc,0xfd,EOT},
126                         {0x01,0x00,0x00,0x40,0x00,0x00,0x00,0x00,0x00,0x00,
127                          0x00,0x00,0x00,0x00,0x00,0x00,0xc0,0x00,0x00,0x00,
128                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
129                          0x01,0x00,0x00,0x40,0x00,0x01,0x00,0x00,0x40,0x00,
130                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
131                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,NANA,0x00,EOT}},
132                 {0x8, "MIDI port",
133                         {0x30,0x60,0x61,0x70,0xf0,EOT},
134                         {0x00,0x03,0x00,0x0a,0x00,EOT}},
135                 {0x9, "Game port",
136                         {0x30,0x60,0x61,EOT},
137                         {0x00,0x02,0x01,EOT}},
138                 {0xa, "Consumer IR",
139                         {0x30,0x60,0x61,0x70,0xf0,EOT},
140                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
141                 {EOT}}},
142         {0x8716, "IT8716F", {
143                 {NOLDN, NULL,
144                         {0x07,0x20,0x21,0x22,0x23,0x24,0x2b,EOT},
145                         {NANA,0x87,0x16,0x01,0x00,0x00,0x00,EOT}},
146                 {0x0, NULL,
147                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
148                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
149                 {0x1, NULL,
150                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
151                         {0x00,0x03,0xf8,0x04,0x00,0x50,0x00,0x7f,EOT}},
152                 {0x2, NULL,
153                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
154                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
155                 {0x3, NULL,
156                         {0x30,0x60,0x61,0x62,0x63,0x70,0x74,0xf0,EOT},
157                         {0x00,0x03,0x78,0x07,0x78,0x07,0x03,0x03,EOT}},
158                 {0x4, NULL,
159                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
160                          0xf4,0xf5,0xf6,EOT},
161                         {0x00,0x02,0x90,0x02,0x30,0x09,0x00,0x00,0x00,0x00,
162                          0x00,NANA,NANA,EOT}},
163                 {0x5, NULL,
164                         {0x30,0x60,0x61,0x62,0x63,0x70,0x71,0xf0,EOT},
165                         {0x01,0x00,0x60,0x00,0x64,0x01,0x02,0x00,EOT}},
166                 {0x6, NULL,
167                         {0x30,0x70,0x71,0xf0,EOT},
168                         {0x00,0x0c,0x02,0x00,EOT}},
169                 {0x7, NULL,
170                         {0x25,0x26,0x27,0x28,0x29,0x2a,0x2c,0x60,0x61,0x62,
171                          0x63,0x64,0x65,0x70,0x71,0x72,0x73,0x74,0xb0,0xb1,
172                          0xb2,0xb3,0xb4,0xb5,0xb8,0xb9,0xba,0xbb,0xbc,0xbd,
173                          0xc0,0xc1,0xc2,0xc3,0xc4,0xc8,0xc9,0xca,0xcb,0xcc,
174                          0xe0,0xe1,0xe2,0xe3,0xe4,0xf0,0xf1,0xf2,0xf3,0xf4,
175                          0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,0xfc,0xfd,EOT},
176                         {0x01,0x00,0x00,0x40,0x00,0x00,0x00,0x00,0x00,0x00,
177                          0x00,0x00,0x00,0x00,0x00,0x20,0x38,0x00,0x00,0x00,
178                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
179                          0x01,0x00,0x00,0x40,0x00,0x01,0x00,0x00,0x40,0x00,
180                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
181                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,NANA,0x00,EOT}},
182                 {0x8, NULL,
183                         {0x30,0x60,0x61,0x70,0xf0,EOT},
184                         {0x00,0x03,0x00,0x0a,0x00,EOT}},
185                 {0x9, NULL,
186                         {0x30,0x60,0x61,EOT},
187                         {0x00,0x02,0x01,EOT}},
188                 {0xa, NULL,
189                         {0x30,0x60,0x61,0x70,0xf0,EOT},
190                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
191                 {EOT}}},
192         {0x8718, "IT8718F", {
193                 {EOT}}},
194         {EOT}
195 };
196
197 /* TODO: Drop this function later. */
198 void dump_ite(uint16_t port, uint16_t id)
199 {
200         dump_superio("ITE", reg_table, port, id);
201 }
202
203 /**
204  * Enable configuration sequence (ITE uses this for newer IT87[012]xF).
205  *
206  * IT871[01]F uses 0x87, 0x87 -> Fintek detection should handle it
207  * IT8708F uses 0x87, 0x87 -> Fintek detection should handle it
208  * IT8761F uses 0x87, 0x61, 0x55, 0x55/0xaa
209  * IT86xxF series uses different ports
210  * IT8661F uses 0x86, 0x61, 0x55/0xaa, 0x55/0xaa and 32 more writes
211  * IT8673F uses 0x86, 0x80, 0x55/0xaa, 0x55/0xaa and 32 more writes
212  */
213 static void enter_conf_mode_ite(uint16_t port)
214 {
215         outb(0x87, port);
216         outb(0x01, port);
217         outb(0x55, port);
218         if (port == 0x2e)
219                 outb(0x55, port);
220         else
221                 outb(0xaa, port);
222 }
223
224 static void exit_conf_mode_ite(uint16_t port)
225 {
226         regwrite(port, 0x02, 0x02);
227 }
228
229 void probe_idregs_ite(uint16_t port)
230 {
231         uint16_t id, chipver;
232
233         enter_conf_mode_ite(port);
234
235         id = regval(port, CHIP_ID_BYTE1_REG) << 8;
236         id |= regval(port, CHIP_ID_BYTE2_REG);
237         chipver = regval(port, CHIP_VERSION_REG) & 0x0f; /* Only bits 3..0 */
238
239         if (superio_unknown(reg_table, id)) {
240                 no_superio_found(port);
241                 exit_conf_mode_ite(port);
242                 return;
243         }
244
245         printf("Found ITE %s (id=0x%04x, rev=0x%01x) at port=0x%x\n",
246                get_superio_name(reg_table, id), id, chipver, port);
247
248         dump_superio("ITE", reg_table, port, id);
249
250         exit_conf_mode_ite(port);
251 }
252