Add dump support for the ITE IT8705F/AF.
[coreboot.git] / util / superiotool / ite.c
1 /*
2  * This file is part of the superiotool 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
27 #define CHIP_VERSION_REG        0x22
28
29 /* Note: IT8726F has ID 0x8726 (datasheet wrongly says 0x8716). */
30 const static struct superio_registers reg_table[] = {
31         {0x8702, "IT8702F", {
32                 {EOT}}},
33         {0x8705, "IT8705F/AF or IT8700F", {
34                 {NOLDN, NULL,
35                         {0x07,0x20,0x21,0x22,0x23,0x24,EOT},
36                         {NANA,0x87,0x05,0x00,0x00,NANA,EOT}},
37                 {0x0, "Floppy",
38                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
39                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
40                 {0x1, "COM1",
41                         {0x30,0x60,0x61,0x70,0xf0,EOT},
42                         {0x00,0x03,0xf8,0x04,0x00,EOT}},
43                 {0x2, "COM2",
44                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
45                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
46                 {0x3, "Parallel port",
47                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0x74,
48                          0xf0,EOT},
49                         {0x00,0x03,0x78,0x07,0x78,0x00,0x80,0x07,0x03,
50                          0x03,EOT}},
51                 {0x4, "Environment controller",
52                         {0x2b,0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,
53                          0xf3,0xf4,0xf5,0xf6,EOT},
54                         {0x00,0x00,0x02,0x90,0x02,0x30,0x09,0x00,0x00,0x00,
55                          0x00,0x00,NANA,NANA,EOT}},
56                 {0x5, "GPIO",
57                         {0x25,0x26,0x27,0x28,0x29,0x2a,0x2b,0x60,0x61,0x62,
58                          0x63,0x64,0x65,0x70,0x71,0x72,0xb0,0xb1,0xb2,0xb3,
59                          0xb4,0xb5,0xb8,0xb9,0xba,0xbb,0xbc,0xbd,0xc0,0xc1,
60                          0xc2,0xc3,0xc4,0xc5,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,
61                          0xd0,0xd1,0xd2,0xd3,0xd4,0xd5,0xd6,0xd8,0xd9,0xda,
62                          0xf0,0xf1,0xf2,0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,
63                          0xfc,0xfd,0xfe,0xff,EOT},
64                         {0x00,0x00,0x00,0xff,0xe0,0xff,0x00,0x00,0x00,0x00,
65                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
66                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
67                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
68                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
69                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
70                          0x00,0x00,NANA,0x00,EOT}},
71                 {0x6, "Game port",
72                         {0x30,0x60,0x61,EOT},
73                         {0x00,0x02,0x01,EOT}},
74                 {0x7, "Consumer IR",
75                         {0x30,0x60,0x61,0x70,0xf0,EOT},
76                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
77                 {0x8, "MIDI port",
78                         {0x30,0x60,0x61,0x70,0xf0,EOT},
79                         {0x00,0x03,0x00,0x0a,0x00,EOT}},
80                 {EOT}}},
81         {0x8708, "IT8708F", {
82                 {NOLDN, NULL,
83                         {0x07,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
84                          0x29,0x2a,0x2e,0x2f,EOT},
85                         {NANA,0x87,0x08,0x00,0x00,NANA,0x3f,0x00,0xff,0xff,
86                          0xff,0xff,0x00,0x00,EOT}},
87                 {0x0, "Floppy",
88                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
89                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
90                 {0x1, "COM1",
91                         {0x30,0x60,0x61,0x70,0xf0,EOT},
92                         {0x00,0x03,0xf8,0x04,0x00,EOT}},
93                 {0x2, "COM2",
94                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
95                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
96                 {0x3, "Parallel port",
97                         {0x30,0x60,0x61,0x62,0x63,0x64,0x65,0x70,0x74,
98                          0xf0,EOT},
99                         {0x00,0x03,0x78,0x07,0x78,0x00,0x80,0x07,0x03,
100                          0x03,EOT}},
101                 {0x4, "SWC",
102                         {0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,
103                          0xf0,0xf1,0xf2,0xf3,0xf4,0xf5,0xf6,EOT},
104                         {NANA,NANA,0x00,0x00,0x00,0x00,0x00,0x00,
105                          0x00,0x00,0x00,0x00,0x00,NANA,NANA,EOT}},
106                 {0x5, "Keyboard",
107                         /* Note: 0x30 can actually be 0x00 _or_ 0x01. */
108                         {0x30,0x60,0x61,0x62,0x63,0x70,0x71,0xf0,EOT},
109                         {0x01,0x00,0x60,0x00,0x64,0x01,0x02,0x00,EOT}},
110                 {0x6, "Mouse",
111                         {0x30,0x70,0x71,0xf0,EOT},
112                         {0x00,0x0c,0x02,0x00,EOT}},
113                 {0x7, "GPIO",
114                         {0x70,0xb0,0xb1,0xb2,0xb3,0xb4,0xb5,0xb8,0xb9,0xba,
115                          0xbb,0xbc,0xbd,0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc8,
116                          0xc9,0xca,0xcb,0xcc,0xcd,0xd0,0xd1,0xd2,0xd3,0xd4,
117                          0xd5,0xd6,0xd7,0xd8,0xd9,0xda,0xdb,0xdc,0xf0,0xf1,
118                          0xf2,0xf3,0xf4,0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,
119                          0xfc,EOT},
120                         {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
121                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
122                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
123                          0x00,0x00,NANA,NANA,NANA,NANA,NANA,NANA,0x00,0x00,
124                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,NANA,
125                          0x00,EOT}},
126                 {0x8, "Game port",
127                         {0x30,0x60,0x61,EOT},
128                         {0x00,0x02,0x01,EOT}},
129                 {0x9, "Consumer IR",
130                         {0x30,0x60,0x61,0x70,0xf0,EOT},
131                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
132                 {0xa, "MIDI port",
133                         {0x30,0x60,0x61,0x70,0xf0,EOT},
134                         {0x00,0x03,0x00,0x0a,0x00,EOT}},
135                 {EOT}}},
136         {0x8710, "IT8710F", {
137                 {EOT}}},
138         {0x8712, "IT8712F", {
139                 {NOLDN, NULL,
140                         {0x07,0x20,0x21,0x22,0x23,0x24,0x2b,EOT},
141                         {NANA,0x87,0x12,0x08,0x00,0x00,0x00,EOT}},
142                 {0x0, "Floppy",
143                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
144                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
145                 {0x1, "COM1",
146                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
147                         {0x00,0x03,0xf8,0x04,0x00,0x50,0x00,0x7f,EOT}},
148                 {0x2, "COM2",
149                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
150                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
151                 {0x3, "Parallel port",
152                         {0x30,0x60,0x61,0x62,0x63,0x70,0x74,0xf0,EOT},
153                         {0x00,0x03,0x78,0x07,0x78,0x07,0x03,0x03,EOT}},
154                 {0x4, "Environment controller",
155                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
156                          0xf4,0xf5,0xf6,EOT},
157                         {0x00,0x02,0x90,0x02,0x30,0x09,0x00,0x00,0x00,0x00,
158                          0x00,NANA,NANA,EOT}},
159                 {0x5, "Keyboard",
160                         /* TODO: 0xf0: Error in datasheet? */
161                         {0x30,0x60,0x61,0x62,0x63,0x70,0x71,0xf0,EOT},
162                         {0x01,0x00,0x60,0x00,0x64,0x01,0x02,0x08,EOT}},
163                 {0x6, "Mouse",
164                         {0x30,0x70,0x71,0xf0,EOT},
165                         {0x00,0x0c,0x02,0x00,EOT}},
166                 {0x7, "GPIO", /* TODO: 0x72, 0x73: Errors in datasheet? */
167                         {0x25,0x26,0x27,0x28,0x29,0x2a,0x2c,0x60,0x61,0x62,
168                          0x63,0x64,0x65,0x70,0x71,0x72,0x73,0x74,0xb0,0xb1,
169                          0xb2,0xb3,0xb4,0xb5,0xb8,0xb9,0xba,0xbb,0xbc,0xbd,
170                          0xc0,0xc1,0xc2,0xc3,0xc4,0xc8,0xc9,0xca,0xcb,0xcc,
171                          0xe0,0xe1,0xe2,0xe3,0xe4,0xf0,0xf1,0xf2,0xf3,0xf4,
172                          0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,0xfc,0xfd,EOT},
173                         {0x01,0x00,0x00,0x40,0x00,0x00,0x00,0x00,0x00,0x00,
174                          0x00,0x00,0x00,0x00,0x00,0x00,0xc0,0x00,0x00,0x00,
175                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
176                          0x01,0x00,0x00,0x40,0x00,0x01,0x00,0x00,0x40,0x00,
177                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
178                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,NANA,0x00,EOT}},
179                 {0x8, "MIDI port",
180                         {0x30,0x60,0x61,0x70,0xf0,EOT},
181                         {0x00,0x03,0x00,0x0a,0x00,EOT}},
182                 {0x9, "Game port",
183                         {0x30,0x60,0x61,EOT},
184                         {0x00,0x02,0x01,EOT}},
185                 {0xa, "Consumer IR",
186                         {0x30,0x60,0x61,0x70,0xf0,EOT},
187                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
188                 {EOT}}},
189         {0x8716, "IT8716F", {
190                 {NOLDN, NULL,
191                         {0x07,0x20,0x21,0x22,0x23,0x24,0x2b,EOT},
192                         {NANA,0x87,0x16,0x01,0x00,0x00,0x00,EOT}},
193                 {0x0, NULL,
194                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
195                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
196                 {0x1, NULL,
197                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
198                         {0x00,0x03,0xf8,0x04,0x00,0x50,0x00,0x7f,EOT}},
199                 {0x2, NULL,
200                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
201                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
202                 {0x3, NULL,
203                         {0x30,0x60,0x61,0x62,0x63,0x70,0x74,0xf0,EOT},
204                         {0x00,0x03,0x78,0x07,0x78,0x07,0x03,0x03,EOT}},
205                 {0x4, NULL,
206                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
207                          0xf4,0xf5,0xf6,EOT},
208                         {0x00,0x02,0x90,0x02,0x30,0x09,0x00,0x00,0x00,0x00,
209                          0x00,NANA,NANA,EOT}},
210                 {0x5, NULL,
211                         {0x30,0x60,0x61,0x62,0x63,0x70,0x71,0xf0,EOT},
212                         {0x01,0x00,0x60,0x00,0x64,0x01,0x02,0x00,EOT}},
213                 {0x6, NULL,
214                         {0x30,0x70,0x71,0xf0,EOT},
215                         {0x00,0x0c,0x02,0x00,EOT}},
216                 {0x7, NULL,
217                         {0x25,0x26,0x27,0x28,0x29,0x2a,0x2c,0x60,0x61,0x62,
218                          0x63,0x64,0x65,0x70,0x71,0x72,0x73,0x74,0xb0,0xb1,
219                          0xb2,0xb3,0xb4,0xb5,0xb8,0xb9,0xba,0xbb,0xbc,0xbd,
220                          0xc0,0xc1,0xc2,0xc3,0xc4,0xc8,0xc9,0xca,0xcb,0xcc,
221                          0xe0,0xe1,0xe2,0xe3,0xe4,0xf0,0xf1,0xf2,0xf3,0xf4,
222                          0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,0xfc,0xfd,EOT},
223                         {0x01,0x00,0x00,0x40,0x00,0x00,0x00,0x00,0x00,0x00,
224                          0x00,0x00,0x00,0x00,0x00,0x20,0x38,0x00,0x00,0x00,
225                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
226                          0x01,0x00,0x00,0x40,0x00,0x01,0x00,0x00,0x40,0x00,
227                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
228                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,NANA,0x00,EOT}},
229                 {0x8, NULL,
230                         {0x30,0x60,0x61,0x70,0xf0,EOT},
231                         {0x00,0x03,0x00,0x0a,0x00,EOT}},
232                 {0x9, NULL,
233                         {0x30,0x60,0x61,EOT},
234                         {0x00,0x02,0x01,EOT}},
235                 {0xa, NULL,
236                         {0x30,0x60,0x61,0x70,0xf0,EOT},
237                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
238                 {EOT}}},
239         {0x8718, "IT8718F", {
240                 {NOLDN, NULL,
241                         {0x07,0x20,0x21,0x22,0x23,0x24,0x2b,EOT},
242                         {NANA,0x87,0x18,0x01,0x00,0x00,0x00,EOT}},
243                 {0x0, "Floppy",
244                         {0x30,0x60,0x61,0x70,0x74,0xf0,0xf1,EOT},
245                         {0x00,0x03,0xf0,0x06,0x02,0x00,0x00,EOT}},
246                 {0x1, "COM1",
247                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
248                         {0x00,0x03,0xf8,0x04,0x00,0x50,0x00,0x7f,EOT}},
249                 {0x2, "COM2",
250                         {0x30,0x60,0x61,0x70,0xf0,0xf1,0xf2,0xf3,EOT},
251                         {0x00,0x02,0xf8,0x03,0x00,0x50,0x00,0x7f,EOT}},
252                 {0x3, "Parallel port",
253                         {0x30,0x60,0x61,0x62,0x63,0x70,0x74,0xf0,EOT},
254                         {0x00,0x03,0x78,0x07,0x78,0x07,0x03,0x03,EOT}},
255                 {0x4, "Environment controller",
256                         {0x30,0x60,0x61,0x62,0x63,0x70,0xf0,0xf1,0xf2,0xf3,
257                          0xf4,0xf5,0xf6,EOT},
258                         {0x00,0x02,0x90,0x02,0x30,0x09,0x00,0x00,0x00,0x00,
259                          0x00,NANA,NANA,EOT}},
260                 {0x5, "Keyboard",
261                         {0x30,0x60,0x61,0x62,0x63,0x70,0x71,0xf0,EOT},
262                         {0x01,0x00,0x60,0x00,0x64,0x01,0x02,0x00,EOT}},
263                 {0x6, "Mouse",
264                         {0x30,0x70,0x71,0xf0,EOT},
265                         {0x00,0x0c,0x02,0x00,EOT}},
266                 {0x7, "GPIO",
267                         {0x25,0x26,0x27,0x28,0x29,0x2a,0x2c,0x60,0x61,0x62,
268                          0x63,0x64,0x65,0x70,0x71,0x72,0x73,0x74,0xb0,0xb1,
269                          0xb2,0xb3,0xb4,0xb5,0xb8,0xb9,0xba,0xbb,0xbc,0xbd,
270                          0xc0,0xc1,0xc2,0xc3,0xc4,0xc8,0xc9,0xca,0xcb,0xcc,
271                          0xe0,0xe1,0xe2,0xe3,0xe4,0xe5,0xe6,0xe7,0xf0,0xf1,
272                          0xf2,0xf3,0xf4,0xf5,0xf6,0xf7,0xf8,0xf9,0xfa,0xfb,
273                          0xfc,0xfd,0xfe,0xff,EOT},
274                         {0x01,0x00,0x00,0x40,0x00,0x00,0x00,0x00,0x00,0x00,
275                          0x00,0x00,0x00,0x00,0x00,0x20,0x38,0x00,0x00,0x00,
276                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
277                          0x01,0x00,0x00,0x40,0x00,0x01,0x00,0x00,0x40,0x00,
278                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
279                          0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
280                          NANA,0x00,0x00,0x00,EOT}},
281                 {0xa, "Consumer IR",
282                         {0x30,0x60,0x61,0x70,0xf0,EOT},
283                         {0x00,0x03,0x10,0x0b,0x00,EOT}},
284                 {EOT}}},
285         {EOT}
286 };
287
288 /**
289  * IT871[01]F and IT8708F use 0x87, 0x87
290  * IT8761F uses 0x87, 0x61, 0x55, 0x55/0xaa
291  * IT86xxF series uses different ports
292  * IT8661F uses 0x86, 0x61, 0x55/0xaa, 0x55/0xaa and 32 more writes
293  * IT8673F uses 0x86, 0x80, 0x55/0xaa, 0x55/0xaa and 32 more writes
294  */
295 static void enter_conf_mode_ite(uint16_t port)
296 {
297         outb(0x87, port);
298         outb(0x01, port);
299         outb(0x55, port);
300         if (port == 0x2e)
301                 outb(0x55, port);
302         else
303                 outb(0xaa, port);
304 }
305
306 static void exit_conf_mode_ite(uint16_t port)
307 {
308         regwrite(port, 0x02, 0x02);
309 }
310
311 static void probe_idregs_ite_helper(const char *init, uint16_t port)
312 {
313         uint16_t id, chipver;
314
315         probing_for("ITE", init, port);
316
317         id = regval(port, CHIP_ID_BYTE1_REG) << 8;
318         id |= regval(port, CHIP_ID_BYTE2_REG);
319         chipver = regval(port, CHIP_VERSION_REG) & 0x0f; /* Only bits 3..0 */
320
321         if (superio_unknown(reg_table, id)) {
322                 if (verbose)
323                         printf(NOTFOUND "id=0x%04x, rev=0x%01x\n", id, chipver);
324                 exit_conf_mode_ite(port);
325                 return;
326         }
327
328         printf("Found ITE %s (id=0x%04x, rev=0x%01x) at 0x%x\n",
329                get_superio_name(reg_table, id), id, chipver, port);
330
331         dump_superio("ITE", reg_table, port, id);
332         dump_superio_readable(port); /* TODO */
333 }
334
335 void probe_idregs_ite(uint16_t port)
336 {
337         enter_conf_mode_ite(port);
338         probe_idregs_ite_helper("(init=0x87,0x01,0x55,0x55/0xaa) ", port);
339         exit_conf_mode_ite(port);
340
341         enter_conf_mode_winbond_fintek_ite_8787(port);
342         probe_idregs_ite_helper("(init=0x87,0x87) ", port);
343         exit_conf_mode_winbond_fintek_ite_8787(port);
344 }
345