Add support for the ITE IT8661F/IT8770F, IT8673F, and IT8671F/IT8687R.
[coreboot.git] / util / superiotool / superiotool.c
index 9bde779a81aee8becd240b9bb8f6b85d4f0891f0..10f225f6dcaa0b1de79797fbbfb17e4c624e61ae 100644 (file)
@@ -4,6 +4,7 @@
  * Copyright (C) 2006 Ronald Minnich <rminnich@gmail.com>
  * Copyright (C) 2007 Uwe Hermann <uwe@hermann-uwe.de>
  * Copyright (C) 2007 Carl-Daniel Hailfinger
+ * Copyright (C) 2008 Robinson P. Tryon <bishop.robinson@gmail.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include "superiotool.h"
 
 /* Command line options. */
-int dump = 0, dump_readable = 0, verbose = 0;
+int dump = 0, verbose = 0, extra_dump = 0;
+
+/* Global flag which indicates whether a chip was detected at all. */
+int chip_found = 0;
 
 uint8_t regval(uint16_t port, uint8_t reg)
 {
        outb(reg, port);
-       return inb(port + 1);
+       return inb(port + ((port == 0x3bd) ? 2 : 1)); /* 0x3bd is special. */
 }
 
 void regwrite(uint16_t port, uint8_t reg, uint8_t val)
@@ -76,12 +80,12 @@ static void dump_regs(const struct superio_registers reg_table[],
                      int i, int j, uint16_t port)
 {
        int k;
-       const int *idx;
+       const int16_t *idx;
 
        if (reg_table[i].ldn[j].ldn != NOLDN) {
-               printf("LDN 0x%02x ", reg_table[i].ldn[j].ldn);
+               printf("LDN 0x%02x", reg_table[i].ldn[j].ldn);
                if (reg_table[i].ldn[j].name != NULL)
-                       printf("(%s)", reg_table[i].ldn[j].name);
+                       printf(" (%s)", reg_table[i].ldn[j].name);
                regwrite(port, 0x07, reg_table[i].ldn[j].ldn);
        } else {
                printf("Register dump:");
@@ -89,33 +93,33 @@ static void dump_regs(const struct superio_registers reg_table[],
 
        idx = reg_table[i].ldn[j].idx;
 
-       printf("\nidx ");
-       for (k = 0; /* Nothing */; k++) {
-               if (idx[k] == EOT)
-                       break;
-               printf("%02x ", idx[k]);
+       printf("\nidx");
+       for (k = 0; idx[k] != EOT; k++) {
+               if (k && !(k % 8))
+                       putchar(' ');
+               printf(" %02x", idx[k]);
        }
 
-       printf("\nval ");
-       for (k = 0; /* Nothing */; k++) {
-               if (idx[k] == EOT)
-                       break;
-               printf("%02x ", regval(port, idx[k]));
+       printf("\nval");
+       for (k = 0; idx[k] != EOT; k++) {
+               if (k && !(k % 8))
+                       putchar(' ');
+               printf(" %02x", regval(port, idx[k]));
        }
 
-       printf("\ndef ");
+       printf("\ndef");
        idx = reg_table[i].ldn[j].def;
-       for (k = 0; /* Nothing */; k++) {
-               if (idx[k] == EOT)
-                       break;
-               else if (idx[k] == NANA)
-                       printf("NA ");
+       for (k = 0; idx[k] != EOT; k++) {
+               if (k && !(k % 8))
+                       putchar(' ');
+               if (idx[k] == NANA)
+                       printf(" NA");
                else if (idx[k] == RSVD)
-                       printf("RR ");
-               else if (idx[k] == MISC)        /* TODO */
-                       printf("MM ");
+                       printf(" RR");
+               else if (idx[k] == MISC)
+                       printf(" MM");
                else
-                       printf("%02x ", idx[k]);
+                       printf(" %02x", idx[k]);
        }
        printf("\n");
 }
@@ -148,58 +152,92 @@ void dump_superio(const char *vendor,
        }
 }
 
-void dump_superio_readable(uint16_t port)
+void probing_for(const char *vendor, const char *info, uint16_t port)
 {
-       /* TODO */
-       if (dump_readable)
-               printf("No human-readable dump available for this Super I/O\n");
+       if (!verbose)
+               return;
+
+       /* Yes, there's no space between '%s' and 'at'! */
+       printf("Probing for %s Super I/O %sat 0x%x...\n", vendor, info, port);
 }
 
-void no_superio_found(const char *vendor, const char *info, uint16_t port)
+/** Print a list of all supported chips from the given vendor. */
+void print_vendor_chips(const char *vendor,
+                       const struct superio_registers reg_table[])
 {
-       if (!verbose)
-               return;
+       int i;
+
+       for (i = 0; reg_table[i].superio_id != EOT; i++) {
+               printf("%s %s", vendor, reg_table[i].name);
+
+               /* Unless the ldn is empty, assume this chip has a dump. */
+               if (reg_table[i].ldn[0].ldn != EOT)
+                       printf(" (dump available)");
+
+               printf("\n");
+       }
 
-       if (inb(port) == 0xff)
-               /* Yes, there's no space between '%s' and 'at'! */
-               printf("Probing for %s Super I/O %sat 0x%x... failed\n",
-                      vendor, info, port);
-       else
-               printf("Probing 0x%x, failed (0x%02x), data returns 0x%02x\n",
-                      port, inb(port), inb(port + 1));
+       /* If we printed any chips for this vendor, put in a blank line. */
+       if (i != 0)
+               printf("\n");
+}
+
+/** Print a list of all chips supported by superiotool. */
+void print_list_of_supported_chips(void)
+{
+       int i;
+
+       printf("Supported Super I/O chips:\n\n");
+
+       for (i = 0; i < ARRAY_SIZE(vendor_print_functions); i++)
+               vendor_print_functions[i].print_list();
+
+       printf("See <http://coreboot.org/Superiotool#Supported_devices> "
+              "for more information.\n");
+}
+
+static void print_version(void)
+{
+       printf("superiotool r%s\n", SUPERIOTOOL_VERSION);
 }
 
 int main(int argc, char *argv[])
 {
        int i, j, opt, option_index;
 
-       const static struct option long_options[] = {
+       static const struct option long_options[] = {
                {"dump",                no_argument, NULL, 'd'},
-               {"dump-readable",       no_argument, NULL, 'D'},
+               {"extra-dump",          no_argument, NULL, 'e'},
+               {"list-supported",      no_argument, NULL, 'l'},
                {"verbose",             no_argument, NULL, 'V'},
                {"version",             no_argument, NULL, 'v'},
                {"help",                no_argument, NULL, 'h'},
                {0, 0, 0, 0}
        };
 
-       while ((opt = getopt_long(argc, argv, "dDVvh",
+       while ((opt = getopt_long(argc, argv, "delVvh",
                                  long_options, &option_index)) != EOF) {
                switch (opt) {
                case 'd':
                        dump = 1;
                        break;
-               case 'D':
-                       dump_readable = 1;
+               case 'e':
+                       extra_dump = 1;
+                       break;
+               case 'l':
+                       print_list_of_supported_chips();
+                       exit(0);
                        break;
                case 'V':
                        verbose = 1;
                        break;
                case 'v':
-                       printf("superiotool %s\n", SUPERIOTOOL_VERSION);
+                       print_version();
                        exit(0);
                        break;
                case 'h':
                        printf(USAGE);
+                       printf(USAGE_INFO);
                        exit(0);
                        break;
                default:
@@ -215,11 +253,16 @@ int main(int argc, char *argv[])
                exit(1);
        }
 
+       print_version();
+
        for (i = 0; i < ARRAY_SIZE(superio_ports_table); i++) {
                for (j = 0; superio_ports_table[i].ports[j] != EOT; j++)
                        superio_ports_table[i].probe_idregs(
                                superio_ports_table[i].ports[j]);
        }
 
+       if (!chip_found)
+               printf("No Super I/O found\n");
+
        return 0;
 }