viatool: Add utility to read various configuration bits on VIA systems

viatool is a utility for extracting useful for extracting certain configuration
bits on VIA chipsets and CPUs. It is a fork of inteltool.

viatool is currently focused on "quirks". Quirks are device configurations that
cannot be accessed directly. They are implemented as hierarchical configurations
in the PCI or memory address spaces (index/data register pairs). Such
configurations refer to hardware parameters that are board specific. Those
parameters would otherwise be difficult to extract from a system running the
vendor's firmware.

viatool also preserves inteltool's MSR dumps. VIA CPU and Intel CPU MSRs are
nearly identical.

Change-Id: Icbd39eaf7c7da5568732d77dbf2aed135f835754
Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
Reviewed-on: http://review.coreboot.org/1430
Tested-by: build bot (Jenkins)
Reviewed-by: Ronald G. Minnich <rminnich@gmail.com>

3 files changed, 240 insertions, 0 deletions

diff --git a/util/viatool/quirks/quirks.c b/util/viatool/quirks/quirks.c
new file mode 100644
index 0000000000..c1bd33204f
--- /dev/null
+++ b/util/viatool/quirks/quirks.c
@@ -0,0 +1,118 @@
+/*
+ * viatool - dump all registers on a VIA CPU + chipset based system.
+ *
+ * Copyright (C) 2013 Alexandru Gagniuc
+ *
+ * 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 the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * a long with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "quirks.h"
+#include <viatool.h>
+#include <stdio.h>
+#include <stddef.h>
+
+extern struct quirk_list vx900_sb_quirk_list;
+
+struct quirk_list *sb_quirks[] = {
+	&vx900_sb_quirk_list,
+	0,
+};
+
+struct quirk_list *nb_quirks[] = {
+	0,
+};
+
+int print_quirks(struct pci_dev *sb, struct pci_access *pacc,
+		 struct quirk_list **qlists);
+
+int print_quirks_north(struct pci_dev *nb, struct pci_access *pacc)
+{
+	printf("\n====== Northbridge Quirks =======\n\n");
+	return print_quirks(nb, pacc, nb_quirks);
+}
+
+int print_quirks_south(struct pci_dev *sb, struct pci_access *pacc)
+{
+	printf("\n====== Southbridge Quirks =======\n\n");
+	return print_quirks(sb, pacc, sb_quirks);
+}
+
+int print_quirks(struct pci_dev *sb, struct pci_access *pacc,
+		 struct quirk_list **qlists)
+{
+	size_t i, j;
+	struct quirk *q;
+	struct quirk_list *qlist;
+	struct pci_dev *dev;
+
+	for (i = 0; ; i++)
+	{
+		qlist = qlists[i];
+
+		if (qlist == NULL) {
+			/* OOPS. We've tried all we know, but no quirk */
+			printf("No quirks supported.\n");
+			break;
+		}
+
+		/* Is this the right device ? */
+		if ( (qlist->pci_vendor_id != sb->vendor_id) ||
+			qlist->pci_device_id != sb->device_id)
+			continue;
+
+		for (j = 0; ; j++)
+		{
+			q = &qlist->dev_quirks[j];
+
+			if(q->pci_device_id == 0)
+				break;
+
+			printf("Probing PCI device %i:%.2x.%i\n",
+			       q->pci_bus, q->pci_dev, q->pci_func);
+
+			dev = pci_get_dev(pacc, q->pci_domain, q->pci_bus,
+					  q->pci_dev, q->pci_func);
+
+			if (!dev) {
+				perror("Error: no device found\n");
+				continue;
+			}
+
+			pci_fill_info(dev, PCI_FILL_IDENT |
+					   PCI_FILL_BASES |
+					   PCI_FILL_SIZES |
+					   PCI_FILL_CLASS );
+
+			if (dev->device_id != q->pci_device_id) {
+				printf("Expected %.4x:%.4x, got %.4x:%.4x\n",
+				       q->pci_vendor_id, q->pci_device_id,
+				       dev->vendor_id, dev->device_id);
+				continue;
+			}
+
+			if (!q->quirk_func) {
+				perror("BUG: Quirk missing.\n");
+				continue;
+			}
+
+			q->quirk_func(dev);
+			/* On to next quirk */
+		}
+
+		/* Done. No need to go through the remainder of the list */
+		break;
+	}
+
+	return 0;
+}
diff --git a/util/viatool/quirks/quirks.h b/util/viatool/quirks/quirks.h
new file mode 100644
index 0000000000..a5a47915d5
--- /dev/null
+++ b/util/viatool/quirks/quirks.h
@@ -0,0 +1,38 @@
+/*
+ * viatool - dump all registers on a VIA CPU + chipset based system.
+ *
+ * Copyright (C) 2013 Alexandru Gagniuc
+ *
+ * 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 the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * a long with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <viatool.h>
+
+struct quirk {
+	int pci_domain;
+	int pci_bus;
+	int pci_dev;
+	int pci_func;
+	int pci_vendor_id;
+	int pci_device_id;
+	int (*quirk_func)(struct pci_dev *dev);
+};
+
+struct quirk_list {
+	int pci_vendor_id;
+	int pci_device_id;
+	/* NULL-terminated list of quirks */
+	struct quirk *dev_quirks;
+};
+
diff --git a/util/viatool/quirks/vx900_quirks.c b/util/viatool/quirks/vx900_quirks.c
new file mode 100644
index 0000000000..dffd2c82fa
--- /dev/null
+++ b/util/viatool/quirks/vx900_quirks.c
@@ -0,0 +1,84 @@
+/*
+ * viatool - dump all registers on a VIA CPU + chipset based system.
+ *
+ * Copyright (C) 2013 Alexandru Gagniuc
+ *
+ * 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 the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * a long with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "quirks.h"
+
+#include <stdio.h>
+
+typedef u8 sata_phy_config[64];
+
+static u32 sata_phy_read32(struct pci_dev *dev, u8 index)
+{
+	/* The SATA PHY control registers are accessed by a funny index/value
+	 * scheme. Each byte (0,1,2,3) has its own 4-bit index */
+	index = (index >> 2) & 0xf;
+	u16 i16 = index | (index << 4) | (index << 8)| (index << 12);
+	/* The index */
+	pci_write_word(dev, 0x68, i16);
+	/* The value */
+	return pci_read_long(dev, 0x64);
+}
+
+static void vx900_sata_read_phy_config(struct pci_dev *dev, sata_phy_config cfg)
+{
+	size_t i;
+	u32* data = (u32*)cfg;
+	for (i = 0; i < ( sizeof(sata_phy_config) ) >> 2; i++) {
+		data[i] = sata_phy_read32(dev, i<<2);
+	}
+}
+
+static int quirk_vx900_sata(struct pci_dev *dev)
+{
+	sata_phy_config ephy;
+
+	/* Get all the info in one pass */
+	vx900_sata_read_phy_config(dev, ephy);
+
+	/* Put it on the terminal for the user to read and be done with it */
+	printf("SATA PHY config:\n");
+	unsigned int i;
+	for (i = 0; i < sizeof(sata_phy_config); i++) {
+		if ((i & 0x0f) == 0) {
+			printf("%.2x :", i);
+		}
+		if( (i & 0x0f) == 0x08 )
+			printf("| ");
+		printf("%.2x ", ephy[i]);
+		if ((i & 0x0f) == 0x0f) {
+			printf("\n");
+		}
+	}
+	return 0;
+}
+
+
+
+
+static struct quirk vx900_sb_quirks[] = {
+	{0, 0, 0x0f, 0, PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_VX900_SATA,
+		quirk_vx900_sata },
+	{0, 0, 0, 0, 0, 0, 0},
+};
+
+struct quirk_list vx900_sb_quirk_list = {
+	.pci_vendor_id = PCI_VENDOR_ID_VIA,
+	.pci_device_id = PCI_DEVICE_ID_VIA_VX900_LPC,
+	.dev_quirks = vx900_sb_quirks
+};
\ No newline at end of file