Implement usage for --help and put the same information into the README, too.
[coreboot.git] / util / superiotool / superiotool.c
1 /*
2  * This file is part of the LinuxBIOS project.
3  *
4  * Copyright (C) 2006 Ronald Minnich <rminnich@gmail.com>
5  * Copyright (C) 2007 Uwe Hermann <uwe@hermann-uwe.de>
6  * Copyright (C) 2007 Carl-Daniel Hailfinger
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
21  */
22
23 #include "superiotool.h"
24
25 /* Command line options. */
26 int dump = 0, verbose = 0;
27
28 uint8_t regval(uint16_t port, uint8_t reg)
29 {
30         outb(reg, port);
31         return inb(port + 1);
32 }
33
34 void regwrite(uint16_t port, uint8_t reg, uint8_t val)
35 {
36         outb(reg, port);
37         outb(val, port + 1);
38 }
39
40 int superio_unknown(const struct superio_registers reg_table[], uint16_t id)
41 {
42         return !strncmp(get_superio_name(reg_table, id), "<unknown>", 9);
43 }
44
45 const char *get_superio_name(const struct superio_registers reg_table[],
46                              uint16_t id)
47 {
48         int i;
49
50         for (i = 0; /* Nothing */; i++) {
51                 if (reg_table[i].superio_id == EOT)
52                         break;
53
54                 if ((uint16_t)reg_table[i].superio_id != id)
55                         continue;
56
57                 return reg_table[i].name;
58         }
59
60         return "<unknown>";
61 }
62
63 void dump_superio(const char *vendor, const struct superio_registers reg_table[],
64                   uint16_t port, uint16_t id)
65 {
66         int i, j, k, nodump;
67         int *idx;
68
69         if (!dump)
70                 return;
71
72         for (i = 0; /* Nothing */; i++) {
73                 if (reg_table[i].superio_id == EOT)
74                         break;
75
76                 if ((uint16_t)reg_table[i].superio_id != id)
77                         continue;
78
79                 nodump = 1;
80
81                 for (j = 0; /* Nothing */; j++) {
82                         if (reg_table[i].ldn[j].ldn == EOT)
83                                 break;
84
85                         nodump = 0;
86
87                         if (reg_table[i].ldn[j].ldn != NOLDN) {
88                                 printf("Switching to LDN 0x%02x\n",
89                                        reg_table[i].ldn[j].ldn);
90                                 regwrite(port, 0x07, reg_table[i].ldn[j].ldn);
91                         }
92
93                         idx = reg_table[i].ldn[j].idx;
94
95                         printf("idx ");
96                         for (k = 0; /* Nothing */; k++) {
97                                 if (idx[k] == EOT)
98                                         break;
99                                 printf("%02x ", idx[k]);
100                         }
101
102                         printf("\nval ");
103                         for (k = 0; /* Nothing */; k++) {
104                                 if (idx[k] == EOT)
105                                         break;
106                                 printf("%02x ", regval(port, idx[k]));
107                         }
108
109                         printf("\ndef ");
110                         idx = reg_table[i].ldn[j].def;
111                         for (k = 0; /* Nothing */; k++) {
112                                 if (idx[k] == EOT)
113                                         break;
114                                 else if (idx[k] == NANA)
115                                         printf("NA ");
116                                 else if (idx[k] == RSVD)
117                                         printf("RR ");
118                                 else if (idx[k] == MISC)        /* TODO */
119                                         printf("MM ");
120                                 else
121                                         printf("%02x ", idx[k]);
122                         }
123                         printf("\n");
124                 }
125
126                 if (nodump)
127                         printf("No dump for %s %s\n", vendor, reg_table[i].name);
128         }
129 }
130
131 void no_superio_found(uint16_t port) {
132         if (!verbose)
133                 return;
134
135         if (inb(port) == 0xff)
136                 printf("No Super I/O chip found at 0x%04x\n", port);
137         else
138                 printf("Probing 0x%04x, failed (0x%02x), data returns 0x%02x\n", port, inb(port), inb(port + 1));
139 }
140
141 int main(int argc, char *argv[])
142 {
143         int i, j, opt, option_index;
144
145         const static struct option long_options[] = {
146                 {"dump",        no_argument, NULL, 'd'},
147                 {"verbose",     no_argument, NULL, 'V'},
148                 {"version",     no_argument, NULL, 'v'},
149                 {"help",        no_argument, NULL, 'h'},
150                 {0, 0, 0, 0}
151         };
152
153         while ((opt = getopt_long(argc, argv, "dVvh",
154                                   long_options, &option_index)) != EOF) {
155                 switch (opt) {
156                 case 'd':
157                         dump = 1;
158                         break;
159                 case 'V':
160                         verbose = 1;
161                         break;
162                 case 'v':
163                         printf("superiotool %s\n", SUPERIOTOOL_VERSION);
164                         exit(0);
165                         break;
166                 case 'h':
167                         printf(USAGE);
168                         exit(0);
169                         break;
170                 default:
171                         /* Unknown option. */
172                         exit(1);
173                         break;
174                 }
175         }
176
177         if (iopl(3) < 0) {
178                 perror("iopl");
179                 printf("Superiotool must be run as root.\n");
180                 exit(1);
181         }
182
183         for (i = 0; i < ARRAY_SIZE(superio_ports_table); i++) {
184                 for (j = 0; superio_ports_table[i].ports[j] != EOT; j++)
185                         superio_ports_table[i].probe_idregs(
186                                 superio_ports_table[i].ports[j]);
187         }
188
189         return 0;
190 }