* Add OSX/Darwin support
[coreboot.git] / util / superiotool / superiotool.h
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  * Copyright (C) 2008 Robinson P. Tryon <bishop.robinson@gmail.com>
7  * Copyright (C) 2008-2009 coresystems GmbH
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
22  */
23
24 #ifndef SUPERIOTOOL_H
25 #define SUPERIOTOOL_H
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <stdint.h>
30 #include <string.h>
31 #include <getopt.h>
32 #if defined(__GLIBC__)
33 #include <sys/io.h>
34 #endif
35 #if (defined(__MACH__) && defined(__APPLE__))
36 /* DirectIO is available here: http://www.coresystems.de/en/directio */
37 #include <DirectIO/darwinio.h>
38 #endif
39
40 #if defined(__FreeBSD__)
41 #include <sys/types.h>
42 #include <machine/cpufunc.h>
43 #define OUTB(x, y) do { u_int tmp = (y); outb(tmp, (x)); } while (0)
44 #define OUTW(x, y) do { u_int tmp = (y); outw(tmp, (x)); } while (0)
45 #define OUTL(x, y) do { u_int tmp = (y); outl(tmp, (x)); } while (0)
46 #define INB(x) __extension__ ({ u_int tmp = (x); inb(tmp); })
47 #define INW(x) __extension__ ({ u_int tmp = (x); inw(tmp); })
48 #define INL(x) __extension__ ({ u_int tmp = (x); inl(tmp); })
49 #else
50 #define OUTB outb
51 #define OUTW outw
52 #define OUTL outl
53 #define INB  inb
54 #define INW  inw
55 #define INL  inl
56 #endif
57
58 #define USAGE "Usage: superiotool [-d] [-e] [-l] [-V] [-v] [-h]\n\n\
59   -d | --dump            Dump Super I/O register contents\n\
60   -e | --extra-dump      Dump secondary registers too (e.g. EC registers)\n\
61   -l | --list-supported  Show the list of supported Super I/O chips\n\
62   -V | --verbose         Verbose mode\n\
63   -v | --version         Show the superiotool version\n\
64   -h | --help            Show a short help text\n\n"
65
66 #define USAGE_INFO "\
67 Per default (no options) superiotool will just probe for a Super I/O\n\
68 and print its vendor, name, ID, revision, and config port.\n"
69
70 #define NOTFOUND "  Failed. Returned data: "
71
72 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
73
74 #define EOT             -1              /* End Of Table */
75 #define NOLDN           -2              /* NO LDN needed */
76 #define NANA            -3              /* Not Available */
77 #define RSVD            -4              /* Reserved */
78 #define MISC            -5              /* Needs special comment in output */
79 #define MAXLDN          0x14            /* Biggest LDN */
80 #define LDNSIZE         (MAXLDN + 3)    /* Biggest LDN + 0 + NOLDN + EOT */
81 #define MAXNUMIDX       170             /* Maximum number of indices */
82 #define IDXSIZE         (MAXNUMIDX + 1)
83 #define MAXNUMPORTS     (6 + 1)         /* Maximum number of Super I/O ports */
84
85 /* Select registers for various components. */
86 #define LDN_SEL         0x07            /* LDN select register */
87 #define WINBOND_HWM_SEL 0x4e            /* Hardware monitor bank select */
88
89 /* Command line parameters. */
90 extern int dump, verbose, extra_dump;
91
92 extern int chip_found;
93
94 struct superio_registers {
95         int32_t superio_id;             /* Signed, as we need EOT. */
96         const char *name;               /* Super I/O name */
97         struct {
98                 int8_t ldn;
99                 const char *name;       /* LDN name */
100                 int16_t idx[IDXSIZE];
101                 int16_t def[IDXSIZE];
102         } ldn[LDNSIZE];
103 };
104
105 /* superiotool.c */
106 uint8_t regval(uint16_t port, uint8_t reg);
107 void regwrite(uint16_t port, uint8_t reg, uint8_t val);
108 void enter_conf_mode_winbond_fintek_ite_8787(uint16_t port);
109 void exit_conf_mode_winbond_fintek_ite_8787(uint16_t port);
110 int superio_unknown(const struct superio_registers reg_table[], uint16_t id);
111 const char *get_superio_name(const struct superio_registers reg_table[],
112                              uint16_t id);
113 void dump_superio(const char *name, const struct superio_registers reg_table[],
114                   uint16_t port, uint16_t id, uint8_t ldn_sel);
115 void dump_io(uint16_t iobase, uint16_t length);
116 void probing_for(const char *vendor, const char *info, uint16_t port);
117 void print_vendor_chips(const char *vendor,
118                         const struct superio_registers reg_table[]);
119
120 /* ali.c */
121 void probe_idregs_ali(uint16_t port);
122 void print_ali_chips(void);
123
124 /* fintek.c */
125 void probe_idregs_fintek(uint16_t port);
126 void print_fintek_chips(void);
127
128 /* ite.c */
129 void probe_idregs_ite(uint16_t port);
130 void print_ite_chips(void);
131
132 /* nsc.c */
133 void probe_idregs_nsc(uint16_t port);
134 void print_nsc_chips(void);
135
136 /* smsc.c */
137 void probe_idregs_smsc(uint16_t port);
138 void print_smsc_chips(void);
139
140 /* winbond.c */
141 void probe_idregs_winbond(uint16_t port);
142 void print_winbond_chips(void);
143
144 /** Table of which config ports to probe for each Super I/O family. */
145 static const struct {
146         void (*probe_idregs) (uint16_t port);
147         int ports[MAXNUMPORTS]; /* Signed, as we need EOT. */
148 } superio_ports_table[] = {
149         {probe_idregs_ali,      {0x3f0, 0x370, EOT}},
150         {probe_idregs_fintek,   {0x2e, 0x4e, EOT}},
151         /* Only use 0x370 for ITE, but 0x3f0 or 0x3bd would also be valid. */
152         {probe_idregs_ite,      {0x2e, 0x4e, 0x370, EOT}},
153         {probe_idregs_nsc,      {0x2e, 0x4e, 0x15c, EOT}},
154         {probe_idregs_smsc,     {0x2e, 0x4e, 0x162e, 0x164e, 0x3f0, 0x370, EOT}},
155         {probe_idregs_winbond,  {0x2e, 0x4e, 0x3f0, 0x370, 0x250, EOT}},
156 };
157
158 /** Table of functions to print out supported Super I/O chips. */
159 static const struct {
160         void (*print_list) (void);
161 } vendor_print_functions[] = {
162         {print_ali_chips},
163         {print_fintek_chips},
164         {print_ite_chips},
165         {print_nsc_chips},
166         {print_smsc_chips},
167         {print_winbond_chips},
168 };
169
170 #endif