inteltool: add `-s` to dump spi bar and bios_cntl registers

Change-Id: I3bb5dc23885af8c992456ee5e4bd374cd4b813bf
Signed-off-by: Alexander Couzens <lynxis@fe80.eu>
Reviewed-on: http://review.coreboot.org/8049
Reviewed-by: Philipp Deppenwiese <zaolin@das-labor.org>
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi@google.com>

5 files changed, 237 insertions, 3 deletions

diff --git a/util/inteltool/Makefile b/util/inteltool/Makefile
index 98848b101a..f846672f7e 100644
--- a/util/inteltool/Makefile
+++ b/util/inteltool/Makefile
@@ -27,7 +27,7 @@ PREFIX  ?= /usr/local
 CFLAGS  ?= -O2 -g -Wall -W
 LDFLAGS += -lpci -lz
 
-OBJS = inteltool.o cpu.o gpio.o rootcmplx.o powermgt.o memory.o pcie.o amb.o ivy_memory.o
+OBJS = inteltool.o cpu.o gpio.o rootcmplx.o powermgt.o memory.o pcie.o amb.o ivy_memory.o spi.o
 
 OS_ARCH	= $(shell uname)
 ifeq ($(OS_ARCH), Darwin)
diff --git a/util/inteltool/inteltool.8 b/util/inteltool/inteltool.8
index 9db4df7144..5956bcd9e3 100644
--- a/util/inteltool/inteltool.8
+++ b/util/inteltool/inteltool.8
@@ -29,6 +29,9 @@ Dump I/O Controller Hub (ICH) southbridge GPIO registers.
 .B "\-r, \-\-rcba"
 Dump I/O Controller Hub (ICH) southbridge RCBA registers.
 .TP
+.B "\-s, \-\-spi"
+Dump I/O Controller Hub (ICH) southbridge SPI registers and bios control.
+.TP
 .B "\-p, \-\-pmbase"
 Dump I/O Controller Hub (ICH) southbridge PMBASE registers.
 .TP
diff --git a/util/inteltool/inteltool.c b/util/inteltool/inteltool.c
index ffed606842..38ab061517 100644
--- a/util/inteltool/inteltool.c
+++ b/util/inteltool/inteltool.c
@@ -209,10 +209,11 @@ void print_version(void)
 
 void print_usage(const char *name)
 {
-	printf("usage: %s [-vh?gGrpmedPMa]\n", name);
+	printf("usage: %s [-vh?gGrpmedPMas]\n", name);
 	printf("\n"
 	     "   -v | --version:                   print the version\n"
 	     "   -h | --help:                      print this help\n\n"
+	     "   -s | --spi:                       dump southbridge spi and bios_cntrl registers\n"
 	     "   -g | --gpio:                      dump southbridge GPIO registers\n"
 	     "   -G | --gpio-diffs:                show GPIO differences from defaults\n"
 	     "   -r | --rcba:                      dump southbridge RCBA registers\n"
@@ -240,6 +241,7 @@ int main(int argc, char *argv[])
 	int dump_gpios = 0, dump_mchbar = 0, dump_rcba = 0;
 	int dump_pmbase = 0, dump_epbar = 0, dump_dmibar = 0;
 	int dump_pciexbar = 0, dump_coremsrs = 0, dump_ambs = 0;
+	int dump_spi = 0;
 	int show_gpio_diffs = 0;
 
 	static struct option long_options[] = {
@@ -255,11 +257,12 @@ int main(int argc, char *argv[])
 		{"pciexpress", 0, 0, 'P'},
 		{"msrs", 0, 0, 'M'},
 		{"ambs", 0, 0, 'A'},
+		{"spi", 0, 0, 's'},
 		{"all", 0, 0, 'a'},
 		{0, 0, 0, 0}
 	};
 
-	while ((opt = getopt_long(argc, argv, "vh?gGrpmedPMaA",
+	while ((opt = getopt_long(argc, argv, "vh?gGrpmedPMaAs",
                                   long_options, &option_index)) != EOF) {
 		switch (opt) {
 		case 'v':
@@ -304,10 +307,14 @@ int main(int argc, char *argv[])
 			dump_pciexbar = 1;
 			dump_coremsrs = 1;
 			dump_ambs = 1;
+			dump_spi = 1;
 			break;
 		case 'A':
 			dump_ambs = 1;
 			break;
+		case 's':
+			dump_spi = 1;
+			break;
 		case 'h':
 		case '?':
 		default:
@@ -454,6 +461,10 @@ int main(int argc, char *argv[])
 	if (dump_ambs) {
 		print_ambs(nb, pacc);
 	}
+
+	if (dump_spi) {
+		print_spi(sb);
+	}
 	/* Clean up */
 	pci_free_dev(nb);
 	// pci_free_dev(sb); // TODO: glibc detected "double free or corruption"
diff --git a/util/inteltool/inteltool.h b/util/inteltool/inteltool.h
index 1db9e63797..3f22641760 100644
--- a/util/inteltool/inteltool.h
+++ b/util/inteltool/inteltool.h
@@ -203,4 +203,5 @@ int print_epbar(struct pci_dev *nb);
 int print_dmibar(struct pci_dev *nb);
 int print_pciexbar(struct pci_dev *nb);
 int print_ambs(struct pci_dev *nb, struct pci_access *pacc);
+int print_spi(struct pci_dev *sb);
 void ivybridge_dump_timings(void);
diff --git a/util/inteltool/spi.c b/util/inteltool/spi.c
new file mode 100644
index 0000000000..3d5ddc3221
--- /dev/null
+++ b/util/inteltool/spi.c
@@ -0,0 +1,219 @@
+
+#include <stdio.h>
+#include <stdlib.h>
+#include "inteltool.h"
+
+static const io_register_t pch_bios_cntl_registers[] = {
+	{ 0x0, 1, "BIOSWE - write enable" },
+	{ 0x1, 1, "BLE - lock enable" },
+	{ 0x2, 2, "SPI Read configuration" },
+	{ 0x4, 1, "TopSwapStatus" },
+	{ 0x5, 1, "SMM Bios Write Protect Disable" },
+	{ 0x6, 2, "reserved" },
+};
+
+#define SPIBAR 0x3800
+
+static const io_register_t spi_bar_registers[] = {
+	{ SPIBAR + 0x00, 4, "BFPR - BIOS Flash primary region" },
+	{ SPIBAR + 0x04, 2, "HSFSTS - Hardware Sequencing Flash Status" },
+	{ SPIBAR + 0x06, 2, "HSFCTL - Hardware Sequencing Flash Control" },
+	{ SPIBAR + 0x08, 4, "FADDR - Flash Address" },
+	{ SPIBAR + 0x0c, 4, "Reserved" },
+	{ SPIBAR + 0x10, 4, "FDATA0" },
+	/* 0x10 .. 0x4f are filled with data */
+	{ SPIBAR + 0x50, 4, "FRACC - Flash Region Access Permissions" },
+	{ SPIBAR + 0x54, 4, "Flash Region 0" },
+	{ SPIBAR + 0x58, 4, "Flash Region 1" },
+	{ SPIBAR + 0x5c, 4, "Flash Region 2" },
+	{ SPIBAR + 0x60, 4, "Flash Region 3" },
+	{ SPIBAR + 0x64, 4, "Flash Region 4" },
+	{ SPIBAR + 0x74, 4, "FPR0 Flash Protected Range 0" },
+	{ SPIBAR + 0x78, 4, "FPR0 Flash Protected Range 1" },
+	{ SPIBAR + 0x7c, 4, "FPR0 Flash Protected Range 2" },
+	{ SPIBAR + 0x80, 4, "FPR0 Flash Protected Range 3" },
+	{ SPIBAR + 0x84, 4, "FPR0 Flash Protected Range 4" },
+	{ SPIBAR + 0x90, 1, "SSFSTS - Software Sequencing Flash Status" },
+	{ SPIBAR + 0x91, 3, "SSFSTS - Software Sequencing Flash Status" },
+	{ SPIBAR + 0x94, 2, "PREOP - Prefix opcode Configuration" },
+	{ SPIBAR + 0x96, 2, "OPTYPE - Opcode Type Configuration" },
+	{ SPIBAR + 0x98, 8, "OPMENU - Opcode Menu Configuration" },
+	{ SPIBAR + 0xa0, 1, "BBAR - BIOS Base Address Configuration" },
+	{ SPIBAR + 0xb0, 4, "FDOC - Flash Descriptor Observability Control" },
+	{ SPIBAR + 0xb8, 4, "Reserved" },
+	{ SPIBAR + 0xc0, 4, "AFC - Additional Flash Control" },
+	{ SPIBAR + 0xc4, 4, "LVSCC - Host Lower Vendor Specific Component Capabilities" },
+	{ SPIBAR + 0xc8, 4, "UVSCC - Host Upper Vendor Specific Component Capabilities" },
+	{ SPIBAR + 0xd0, 4, "FPB - Flash Partition Boundary" },
+};
+
+int print_bioscntl(struct pci_dev *sb)
+{
+	int i, size = 0;
+	unsigned char bios_cntl = 0xff;
+	const io_register_t *bios_cntl_register = NULL;
+
+	printf("\n============= SPI / BIOS CNTL =============\n\n");
+
+	switch (sb->device_id) {
+	case PCI_DEVICE_ID_INTEL_3400:
+	case PCI_DEVICE_ID_INTEL_3420:
+	case PCI_DEVICE_ID_INTEL_3450:
+	case PCI_DEVICE_ID_INTEL_3400_DESKTOP:
+	case PCI_DEVICE_ID_INTEL_B55_A:
+	case PCI_DEVICE_ID_INTEL_B55_B:
+	case PCI_DEVICE_ID_INTEL_H55:
+	case PCI_DEVICE_ID_INTEL_H57:
+	case PCI_DEVICE_ID_INTEL_P55:
+	case PCI_DEVICE_ID_INTEL_Q57:
+	case PCI_DEVICE_ID_INTEL_3400_MOBILE:
+	case PCI_DEVICE_ID_INTEL_3400_MOBILE_SFF:
+	case PCI_DEVICE_ID_INTEL_HM55:
+	case PCI_DEVICE_ID_INTEL_HM57:
+	case PCI_DEVICE_ID_INTEL_PM55:
+	case PCI_DEVICE_ID_INTEL_QM57:
+	case PCI_DEVICE_ID_INTEL_QS57:
+		bios_cntl = pci_read_byte(sb, 0xdc);
+		bios_cntl_register = pch_bios_cntl_registers;
+		size = ARRAY_SIZE(pch_bios_cntl_registers);
+		break;
+	default:
+		printf("Error: Dumping SPI on this southbridge is not (yet) supported.\n");
+		return 1;
+	}
+
+	printf("BIOS_CNTL = 0x%04x (IO)\n\n", bios_cntl);
+
+	if (bios_cntl_register) {
+		for (i = 0; i < size; i++) {
+			unsigned int val = bios_cntl >> bios_cntl_register[i].addr;
+			val &= ((1 << bios_cntl_register[i].size) -1);
+			printf("0x%04x = %s\n", val, bios_cntl_register[i].name);
+		}
+	}
+
+	return 0;
+}
+
+int print_spibar(struct pci_dev *sb) {
+	int i, size = 0, rcba_size = 0x4000;
+	volatile uint8_t *rcba;
+	uint32_t rcba_phys;
+	const io_register_t *spi_register = NULL;
+
+	printf("\n============= SPI Bar ==============\n\n");
+
+	switch (sb->device_id) {
+	case PCI_DEVICE_ID_INTEL_ICH6:
+	case PCI_DEVICE_ID_INTEL_ICH7:
+	case PCI_DEVICE_ID_INTEL_ICH7M:
+	case PCI_DEVICE_ID_INTEL_ICH7DH:
+	case PCI_DEVICE_ID_INTEL_ICH7MDH:
+	case PCI_DEVICE_ID_INTEL_ICH8:
+	case PCI_DEVICE_ID_INTEL_ICH8M:
+	case PCI_DEVICE_ID_INTEL_ICH9DH:
+	case PCI_DEVICE_ID_INTEL_ICH9DO:
+	case PCI_DEVICE_ID_INTEL_ICH9R:
+	case PCI_DEVICE_ID_INTEL_ICH9:
+	case PCI_DEVICE_ID_INTEL_ICH9M:
+	case PCI_DEVICE_ID_INTEL_ICH9ME:
+	case PCI_DEVICE_ID_INTEL_ICH10R:
+	case PCI_DEVICE_ID_INTEL_NM10:
+	case PCI_DEVICE_ID_INTEL_I63XX:
+	case PCI_DEVICE_ID_INTEL_3400:
+	case PCI_DEVICE_ID_INTEL_3420:
+	case PCI_DEVICE_ID_INTEL_3450:
+	case PCI_DEVICE_ID_INTEL_3400_DESKTOP:
+	case PCI_DEVICE_ID_INTEL_3400_MOBILE:
+	case PCI_DEVICE_ID_INTEL_3400_MOBILE_SFF:
+	case PCI_DEVICE_ID_INTEL_B55_A:
+	case PCI_DEVICE_ID_INTEL_B55_B:
+	case PCI_DEVICE_ID_INTEL_H55:
+	case PCI_DEVICE_ID_INTEL_H57:
+	case PCI_DEVICE_ID_INTEL_HM55:
+	case PCI_DEVICE_ID_INTEL_HM57:
+	case PCI_DEVICE_ID_INTEL_P55:
+	case PCI_DEVICE_ID_INTEL_PM55:
+	case PCI_DEVICE_ID_INTEL_Q57:
+	case PCI_DEVICE_ID_INTEL_QM57:
+	case PCI_DEVICE_ID_INTEL_QS57:
+	case PCI_DEVICE_ID_INTEL_Z68:
+	case PCI_DEVICE_ID_INTEL_P67:
+	case PCI_DEVICE_ID_INTEL_UM67:
+	case PCI_DEVICE_ID_INTEL_HM65:
+	case PCI_DEVICE_ID_INTEL_H67:
+	case PCI_DEVICE_ID_INTEL_HM67:
+	case PCI_DEVICE_ID_INTEL_Q65:
+	case PCI_DEVICE_ID_INTEL_QS67:
+	case PCI_DEVICE_ID_INTEL_Q67:
+	case PCI_DEVICE_ID_INTEL_QM67:
+	case PCI_DEVICE_ID_INTEL_B65:
+	case PCI_DEVICE_ID_INTEL_C202:
+	case PCI_DEVICE_ID_INTEL_C204:
+	case PCI_DEVICE_ID_INTEL_C206:
+	case PCI_DEVICE_ID_INTEL_H61:
+	case PCI_DEVICE_ID_INTEL_Z77:
+	case PCI_DEVICE_ID_INTEL_Z75:
+	case PCI_DEVICE_ID_INTEL_Q77:
+	case PCI_DEVICE_ID_INTEL_Q75:
+	case PCI_DEVICE_ID_INTEL_B75:
+	case PCI_DEVICE_ID_INTEL_H77:
+	case PCI_DEVICE_ID_INTEL_C216:
+	case PCI_DEVICE_ID_INTEL_QM77:
+	case PCI_DEVICE_ID_INTEL_QS77:
+	case PCI_DEVICE_ID_INTEL_HM77:
+	case PCI_DEVICE_ID_INTEL_UM77:
+	case PCI_DEVICE_ID_INTEL_HM76:
+	case PCI_DEVICE_ID_INTEL_HM75:
+	case PCI_DEVICE_ID_INTEL_HM70:
+	case PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_FULL:
+	case PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_PREM:
+	case PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_BASE:
+		rcba_phys = pci_read_long(sb, 0xf0) & 0xfffffffe;
+		size = ARRAY_SIZE(spi_bar_registers);
+		spi_register = spi_bar_registers;
+		break;
+	case PCI_DEVICE_ID_INTEL_ICH:
+	case PCI_DEVICE_ID_INTEL_ICH0:
+	case PCI_DEVICE_ID_INTEL_ICH2:
+	case PCI_DEVICE_ID_INTEL_ICH4:
+	case PCI_DEVICE_ID_INTEL_ICH4M:
+	case PCI_DEVICE_ID_INTEL_ICH5:
+		printf("This southbridge does not have RCBA.\n");
+		return 1;
+	default:
+		printf("Error: Dumping RCBA on this southbridge is not (yet) supported.\n");
+		return 1;
+	}
+
+	rcba = map_physical(rcba_phys, rcba_size);
+	if (rcba == NULL) {
+		perror("Error mapping RCBA");
+		exit(1);
+	}
+
+	for (i = 0; i < size; i++) {
+		switch(spi_register[i].size) {
+			case 1:
+				printf("0x%08x = %s\n", *(uint8_t *)(rcba + spi_register[i].addr), spi_register[i].name);
+				break;
+			case 2:
+				printf("0x%08x = %s\n", *(uint16_t *)(rcba + spi_register[i].addr), spi_register[i].name);
+				break;
+			case 4:
+				printf("0x%08x = %s\n", *(uint32_t *)(rcba + spi_register[i].addr), spi_register[i].name);
+				break;
+			case 8:
+				printf("0x%08x%08x = %s\n", *(uint32_t *)(rcba + spi_register[i].addr), *(uint32_t *)(rcba + spi_register[i].addr + 4), spi_register[i].name);
+				break;
+		}
+	}
+
+	unmap_physical((void *)rcba, rcba_size);
+	return 0;
+}
+
+int print_spi(struct pci_dev *sb) {
+	return (print_bioscntl(sb) || print_spibar(sb));
+}
+