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  *
   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 #ifndef SUPERIOTOOL_H
  24 #define SUPERIOTOOL_H
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <stdint.h>
  29 #include <string.h>
  30 #include <getopt.h>
  31 #include <sys/io.h>
  32
  33 #define USAGE "Usage: superiotool [-d] [-e] [-l] [-V] [-v] [-h]\n\n\
  34   -d | --dump            Dump Super I/O register contents\n\
  35   -e | --extra-dump      Dump secondary registers too (e.g. EC registers)\n\
  36   -l | --list-supported  Show the list of supported Super I/O chips\n\
  37   -V | --verbose         Verbose mode\n\
  38   -v | --version         Show the superiotool version\n\
  39   -h | --help            Show a short help text\n\n"
  40
  41 #define USAGE_INFO "\
  42 Per default (no options) superiotool will just probe for a Super I/O\n\
  43 and print its vendor, name, ID, revision, and config port.\n"
  44
  45 #define NOTFOUND "  Failed. Returned data: "
  46
  47 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  48
  49 #define EOT             -1              /* End Of Table */
  50 #define NOLDN           -2              /* NO LDN needed */
  51 #define NANA            -3              /* Not Available */
  52 #define RSVD            -4              /* Reserved */
  53 #define MISC            -5              /* Needs special comment in output */
  54 #define MAXLDN          0x14            /* Biggest LDN */
  55 #define LDNSIZE         (MAXLDN + 3)    /* Biggest LDN + 0 + NOLDN + EOT */
  56 #define MAXNUMIDX       170             /* Maximum number of indexes */
  57 #define IDXSIZE         (MAXNUMIDX + 1)
  58 #define MAXNUMPORTS     (6 + 1)         /* Maximum number of Super I/O ports */
  59
  60 /* Command line parameters. */
  61 extern int dump, verbose, extra_dump;
  62
  63 extern int chip_found;
  64
  65 struct superio_registers {
  66         int32_t superio_id;             /* Signed, as we need EOT. */
  67         const char *name;               /* Super I/O name */
  68         struct {
  69                 int8_t ldn;
  70                 const char *name;       /* LDN name */
  71                 int16_t idx[IDXSIZE];
  72                 int16_t def[IDXSIZE];
  73         } ldn[LDNSIZE];
  74 };
  75
  76 /* superiotool.c */
  77 uint8_t regval(uint16_t port, uint8_t reg);
  78 void regwrite(uint16_t port, uint8_t reg, uint8_t val);
  79 void enter_conf_mode_winbond_fintek_ite_8787(uint16_t port);
  80 void exit_conf_mode_winbond_fintek_ite_8787(uint16_t port);
  81 int superio_unknown(const struct superio_registers reg_table[], uint16_t id);
  82 const char *get_superio_name(const struct superio_registers reg_table[],
  83                              uint16_t id);
  84 void dump_superio(const char *name, const struct superio_registers reg_table[],
  85                   uint16_t port, uint16_t id);
  86 void probing_for(const char *vendor, const char *info, uint16_t port);
  87 void print_vendor_chips(const char *vendor,
  88                         const struct superio_registers reg_table[]);
  89
  90 /* ali.c */
  91 void probe_idregs_ali(uint16_t port);
  92 void print_ali_chips(void);
  93
  94 /* fintek.c */
  95 void probe_idregs_fintek(uint16_t port);
  96 void print_fintek_chips(void);
  97
  98 /* ite.c */
  99 void probe_idregs_ite(uint16_t port);
 100 void print_ite_chips(void);
 101
 102 /* nsc.c */
 103 void probe_idregs_nsc(uint16_t port);
 104 void print_nsc_chips(void);
 105
 106 /* smsc.c */
 107 void probe_idregs_smsc(uint16_t port);
 108 void print_smsc_chips(void);
 109
 110 /* winbond.c */
 111 void probe_idregs_winbond(uint16_t port);
 112 void print_winbond_chips(void);
 113
 114 /** Table of which config ports to probe for each Super I/O family. */
 115 static const struct {
 116         void (*probe_idregs) (uint16_t port);
 117         int ports[MAXNUMPORTS]; /* Signed, as we need EOT. */
 118 } superio_ports_table[] = {
 119         {probe_idregs_ali,      {0x3f0, 0x370, EOT}},
 120         {probe_idregs_fintek,   {0x2e, 0x4e, EOT}},
 121         {probe_idregs_ite,      {0x2e, 0x4e, EOT}},
 122         {probe_idregs_nsc,      {0x2e, 0x4e, 0x15c, EOT}},
 123         {probe_idregs_smsc,     {0x2e, 0x4e, 0x162e, 0x164e, 0x3f0, 0x370, EOT}},
 124         {probe_idregs_winbond,  {0x2e, 0x4e, 0x3f0, 0x370, 0x250, EOT}},
 125 };
 126
 127 /** Table of functions to print out supported Super I/O chips. */
 128 static const struct {
 129         void (*print_list) (void);
 130 } vendor_print_functions[] = {
 131         {print_ali_chips},
 132         {print_fintek_chips},
 133         {print_ite_chips},
 134         {print_nsc_chips},
 135         {print_smsc_chips},
 136         {print_winbond_chips},
 137 };
 138
 139 #endif