util/inteltool: add code for dumping LPC registers

This adds the implementation for dumping LPC registers

Change-Id: I50ae4913933f7594f0d63ce3f752302ed5c461e2
Signed-off-by: Michael Niewöhner <foss@mniewoehner.de>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/39517
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-by: HAOUAS Elyes <ehaouas@noos.fr>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

4 files changed, 179 insertions, 3 deletions

diff --git a/util/inteltool/Makefile b/util/inteltool/Makefile
index 23ea8a6ee6..b15ae8ec54 100644
--- a/util/inteltool/Makefile
+++ b/util/inteltool/Makefile
@@ -29,7 +29,7 @@ CPPFLAGS += -I$(top)/src/commonlib/include -I$(top)/src/commonlib/bsd/include
 
 
 OBJS = inteltool.o pcr.o cpu.o gpio.o gpio_groups.o rootcmplx.o powermgt.o \
-       memory.o pcie.o amb.o ivy_memory.o spi.o gfx.o ahci.o \
+       memory.o pcie.o amb.o ivy_memory.o spi.o gfx.o ahci.o lpc.o
 
 OS_ARCH	= $(shell uname)
 ifeq ($(OS_ARCH), Darwin)
diff --git a/util/inteltool/inteltool.c b/util/inteltool/inteltool.c
index 0e84b550fc..8d5d9942a7 100644
--- a/util/inteltool/inteltool.c
+++ b/util/inteltool/inteltool.c
@@ -494,7 +494,7 @@ static void print_version(void)
 
 static void print_usage(const char *name)
 {
-	printf("usage: %s [-vh?gGrpmedPMaAsfSRx]\n", name);
+	printf("usage: %s [-vh?gGrplmedPMaAsfSRx]\n", name);
 	printf("\n"
 	     "   -v | --version:                   print the version\n"
 	     "   -h | --help:                      print this help\n\n"
@@ -505,6 +505,7 @@ static void print_usage(const char *name)
 	     "   -G | --gpio-diffs:                show GPIO differences from defaults\n"
 	     "   -r | --rcba:                      dump southbridge RCBA registers\n"
 	     "   -p | --pmbase:                    dump southbridge Power Management registers\n\n"
+	     "   -l | --lpc:                       dump southbridge LPC/eSPI Interface registers\n\n"
 	     "   -m | --mchbar:                    dump northbridge Memory Controller registers\n"
 	     "   -S FILE | --spd=FILE:             create a file storing current timings (implies -m)\n"
 	     "   -e | --epbar:                     dump northbridge EPBAR registers\n"
@@ -574,6 +575,7 @@ int main(int argc, char *argv[])
 	int dump_pmbase = 0, dump_epbar = 0, dump_dmibar = 0;
 	int dump_pciexbar = 0, dump_coremsrs = 0, dump_ambs = 0;
 	int dump_spi = 0, dump_gfx = 0, dump_ahci = 0, dump_sgx = 0;
+	int dump_lpc = 0;
 	int show_gpio_diffs = 0;
 	size_t pcr_count = 0;
 	uint8_t dump_pcr[MAX_PCR_PORTS];
@@ -586,6 +588,7 @@ int main(int argc, char *argv[])
 		{"mchbar", 0, 0, 'm'},
 		{"rcba", 0, 0, 'r'},
 		{"pmbase", 0, 0, 'p'},
+		{"lpc", 0, 0, 'l'},
 		{"epbar", 0, 0, 'e'},
 		{"dmibar", 0, 0, 'd'},
 		{"pciexpress", 0, 0, 'P'},
@@ -601,7 +604,7 @@ int main(int argc, char *argv[])
 		{0, 0, 0, 0}
 	};
 
-	while ((opt = getopt_long(argc, argv, "vh?gGrpmedPMaAsfRS:x",
+	while ((opt = getopt_long(argc, argv, "vh?gGrplmedPMaAsfRS:x",
                                   long_options, &option_index)) != EOF) {
 		switch (opt) {
 		case 'v':
@@ -633,6 +636,9 @@ int main(int argc, char *argv[])
 		case 'p':
 			dump_pmbase = 1;
 			break;
+		case 'l':
+			dump_lpc = 1;
+			break;
 		case 'e':
 			dump_epbar = 1;
 			break;
@@ -651,6 +657,7 @@ int main(int argc, char *argv[])
 			dump_mchbar = 1;
 			dump_rcba = 1;
 			dump_pmbase = 1;
+			dump_lpc = 1;
 			dump_epbar = 1;
 			dump_dmibar = 1;
 			dump_pciexbar = 1;
@@ -816,6 +823,11 @@ int main(int argc, char *argv[])
 		printf("\n\n");
 	}
 
+	if (dump_lpc) {
+		print_lpc(sb, pacc);
+		printf("\n\n");
+	}
+
 	if (dump_mchbar) {
 		print_mchbar(nb, pacc, dump_spd_file);
 		printf("\n\n");
diff --git a/util/inteltool/inteltool.h b/util/inteltool/inteltool.h
index 2bd2afcb40..85f29fd8f9 100644
--- a/util/inteltool/inteltool.h
+++ b/util/inteltool/inteltool.h
@@ -396,6 +396,7 @@ unsigned int cpuid(unsigned int op);
 int print_intel_core_msrs(void);
 int print_mchbar(struct pci_dev *nb, struct pci_access *pacc, const char *dump_spd_file);
 int print_pmbase(struct pci_dev *sb, struct pci_access *pacc);
+int print_lpc(struct pci_dev *sb, struct pci_access *pacc);
 int print_rcba(struct pci_dev *sb);
 int print_gpios(struct pci_dev *sb, int show_all, int show_diffs);
 const struct gpio_community *const *get_gpio_communities(struct pci_dev *const sb,
diff --git a/util/inteltool/lpc.c b/util/inteltool/lpc.c
new file mode 100644
index 0000000000..247c37acb9
--- /dev/null
+++ b/util/inteltool/lpc.c
@@ -0,0 +1,163 @@
+/*
+ * inteltool - dump all registers on an Intel CPU + chipset based system.
+ *
+ * Copyright (C) 2008-2010 by coresystems GmbH
+ *  written by Stefan Reinauer <stepan@coresystems.de>
+ * Copyright (C) 2017 secunet Security Networks AG
+ * Copyright (C) 2020 Michael Niewöhner <foss@mniewoehner.de>
+ *
+ * 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; version 2 of the License.
+ *
+ * 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.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <inttypes.h>
+#include <commonlib/helpers.h>
+#include "inteltool.h"
+
+#define SUNRISE_LPC_BC	0xdc
+
+static const io_register_t sunrise_lpc_cfg_registers[] = {
+	{0x00, 4, "ID"},
+	{0x04, 2, "CMD"},
+	{0x06, 2, "STS"},
+	{0x08, 1, "RID"},
+	{0x09, 1, "CC[3]"},
+	{0x0A, 1, "CC[2]"},
+	{0x0B, 1, "CC[1]"},
+	{0x0C, 1, "CC[0]"},
+	{0x0E, 1, "HTYPE"},
+	{0x2C, 4, "SS"},
+	{0x34, 1, "CAPP"},
+	{0x64, 1, "SCNT"},
+	{0x80, 2, "IOD"},
+	{0x82, 2, "IOE"},
+	{0x84, 4, "LGIR1"},
+	{0x88, 4, "LGIR2"},
+	{0x8C, 4, "LGIR3"},
+	{0x90, 4, "LGIR4"},
+	{0x94, 4, "ULKMC"},
+	{0x98, 4, "LGMR"},
+	{0xD0, 2, "FS1"},
+	{0xD4, 2, "FS2"},
+	{0xD8, 2, "BDE"},
+	{0xDC, 1, "BC"},
+	{0xE0, 4, "PCCTL"},
+};
+
+static const io_register_t sunrise_espi_cfg_registers[] = {
+	{0x00, 4, "ESPI_DID_VID"},
+	{0x04, 4, "ESPI_STS_CMD"},
+	{0x08, 4, "ESPI_CC_RID"},
+	{0x0C, 4, "ESPI_BIST_HTYPE_PLT_CLS"},
+	{0x2C, 4, "ESPI_SS"},
+	{0x34, 4, "ESPI_CAPP"},
+	{0x80, 4, "ESPI_IOD_IOE"},
+	{0x84, 4, "ESPI_LGIR1"},
+	{0x88, 4, "ESPI_LGIR2"},
+	{0x8C, 4, "ESPI_LGIR3"},
+	{0x90, 4, "ESPI_LGIR4"},
+	{0x94, 4, "ESPI_ULKMC"},
+	{0x98, 4, "ESPI_LGMR"},
+	{0xD0, 4, "ESPI_FS1"},
+	{0xD4, 4, "ESPI_FS2"},
+	{0xD8, 4, "ESPI_BDE"},
+	{0xDC, 4, "ESPI_BC"},
+};
+
+int print_lpc(struct pci_dev *sb, struct pci_access *pacc)
+{
+	size_t i, cfg_registers_size = 0;
+	const io_register_t *cfg_registers;
+	struct pci_dev *dev = NULL;
+	uint32_t bc;
+
+	printf("\n========== LPC/eSPI =========\n\n");
+
+	switch (sb->device_id) {
+	case PCI_DEVICE_ID_INTEL_H110:
+	case PCI_DEVICE_ID_INTEL_H170:
+	case PCI_DEVICE_ID_INTEL_Z170:
+	case PCI_DEVICE_ID_INTEL_Q170:
+	case PCI_DEVICE_ID_INTEL_Q150:
+	case PCI_DEVICE_ID_INTEL_B150:
+	case PCI_DEVICE_ID_INTEL_C236:
+	case PCI_DEVICE_ID_INTEL_C232:
+	case PCI_DEVICE_ID_INTEL_QM170:
+	case PCI_DEVICE_ID_INTEL_HM170:
+	case PCI_DEVICE_ID_INTEL_CM236:
+	case PCI_DEVICE_ID_INTEL_HM175:
+	case PCI_DEVICE_ID_INTEL_QM175:
+	case PCI_DEVICE_ID_INTEL_CM238:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_PRE:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_U_BASE_SKL:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_Y_PREM_SKL:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_U_PREM_SKL:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_U_BASE_KBL:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_U_PREM_KBL:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_Y_PREM_KBL:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_U_IHDCP_BASE:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_U_IHDCP_PREM:
+	case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_Y_IHDCP_PREM:
+		dev = pci_get_dev(pacc, sb->domain, sb->bus, sb->dev, 0);
+		if (!dev) {
+			printf("LPC/eSPI interface not found.\n");
+			return 1;
+		}
+		bc = pci_read_long(dev, SUNRISE_LPC_BC);
+		if (bc & (1 << 2)) {
+			printf("Device 0:1f.0 is eSPI (BC.LPC_ESPI=1)\n\n");
+			cfg_registers = sunrise_espi_cfg_registers;
+			cfg_registers_size = ARRAY_SIZE(sunrise_espi_cfg_registers);
+
+		} else {
+			printf("Device 0:1f.0 is LPC (BC.LPC_ESPI=0)\n\n");
+			cfg_registers = sunrise_lpc_cfg_registers;
+			cfg_registers_size = ARRAY_SIZE(sunrise_lpc_cfg_registers);
+		}
+		break;
+
+	default:
+		printf("Error: Dumping LPC/eSPI on this southbridge is not (yet) supported.\n");
+		return 1;
+	}
+
+	for (i = 0; i < cfg_registers_size; i++) {
+		switch (cfg_registers[i].size) {
+		case 4:
+			printf("0x%04x: 0x%08x (%s)\n",
+				cfg_registers[i].addr,
+				pci_read_long(dev, cfg_registers[i].addr),
+				cfg_registers[i].name);
+			break;
+		case 2:
+			printf("0x%04x: 0x%04x     (%s)\n",
+				cfg_registers[i].addr,
+				pci_read_word(dev, cfg_registers[i].addr),
+				cfg_registers[i].name);
+			break;
+		case 1:
+			printf("0x%04x: 0x%02x       (%s)\n",
+				cfg_registers[i].addr,
+				pci_read_byte(dev, cfg_registers[i].addr),
+				cfg_registers[i].name);
+			break;
+		default:
+			printf("Error: register size %d not implemented.\n",
+				cfg_registers[i].size);
+			break;
+		}
+	}
+
+	if (dev)
+		pci_free_dev(dev);
+
+	return 0;
+}