Split out enter_conf_mode_*()/exit_conf_mode_() functions, we'll soon need
[coreboot.git] / util / superiotool / superiotool.h
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 #ifndef SUPERIOTOOL_H
23 #define SUPERIOTOOL_H
24
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <stdint.h>
28 #include <sys/io.h>
29
30 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
31
32 #define EOT             -1              /* End Of Table */
33 #define NOLDN           -2              /* NO LDN needed */
34 #define NANA            -3              /* Not Available */
35 #define RSVD            -4              /* Reserved */
36 #define MAXNAMELEN      20              /* Maximum Name Length */
37 #define MAXLDN          0xa             /* Biggest LDN */
38 #define LDNSIZE         (MAXLDN + 3)    /* Biggest LDN + 0 + NOLDN + EOT */
39 #define MAXNUMIDX       70              /* Maximum number of indexes */
40 #define IDXSIZE         (MAXNUMIDX + 1)
41 #define MAXNUMPORTS     (2 + 1)         /* Maximum number of Super I/O ports */
42
43 struct superio_registers {
44         int32_t superio_id; /* Signed, as we need EOT. */
45         const char name[MAXNAMELEN];
46         struct {
47                 int ldn;
48                 int idx[IDXSIZE];
49                 int def[IDXSIZE];
50         } ldn[LDNSIZE];
51 };
52
53 /* superiotool.c */
54 uint8_t regval(uint16_t port, uint8_t reg);
55 void regwrite(uint16_t port, uint8_t reg, uint8_t val);
56 void dump_superio(const char *name, const struct superio_registers reg_table[],
57                   uint16_t port, uint16_t id);
58 void probe_superio(uint16_t port);
59
60 /* fintek.c */
61 void enter_conf_mode_fintek(uint16_t port);
62 void exit_conf_mode_fintek(uint16_t port);
63 void dump_fintek(uint16_t port, uint16_t did);
64 void probe_idregs_fintek(uint16_t port);
65
66 /* ite.c */
67 void enter_conf_mode_ite(uint16_t port);
68 void exit_conf_mode_ite(uint16_t port);
69 void dump_ite(uint16_t port, uint16_t id);
70 void probe_idregs_ite(uint16_t port);
71
72 /* nsc.c */
73 void dump_ns8374(uint16_t port);
74 void probe_idregs_simple(uint16_t port);
75
76 /* smsc.c */
77 void enter_conf_mode_smsc(uint16_t port);
78 void exit_conf_mode_smsc(uint16_t port);
79 void dump_smsc(uint16_t port, uint16_t id);
80 void probe_idregs_smsc(uint16_t port);
81
82 /** Table of which config ports to probe on each Super I/O. */
83 const static struct {
84         void (*probe_idregs) (uint16_t port);
85         int ports[MAXNUMPORTS]; /* Signed, as we need EOT. */
86 } superio_ports_table[] = {
87         {probe_idregs_simple,   {0x2e,  0x4e,   EOT}},
88         {probe_idregs_fintek,   {0x2e,  0x4e,   EOT}},
89         {probe_idregs_ite,      {0x2e,  0x4e,   EOT}},
90         {probe_idregs_smsc,     {0x3f0, 0x370,  EOT}},
91 };
92
93 #endif