soc/intel/common: Bring DISPLAY_MTRRS into the light

Initially, I wanted to move only the Kconfig DISPLAY_MTRRS into the
"Debug" menu. It turned out, though, that the code looks rather generic.
No need to hide it in soc/intel/.

To not bloat src/Kconfig up any further, start a new `Kconfig.debug`
hierarchy just for debug options.

If somebody wants to review the code if it's 100% generic, we could
even get rid of HAVE_DISPLAY_MTRRS.

Change-Id: Ibd0a64121bd6e4ab5d7fd835f3ac25d3f5011f24
Signed-off-by: Nico Huber <nico.h@gmx.de>
Reviewed-on: https://review.coreboot.org/c/29684
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

4 files changed, 219 insertions, 7 deletions

diff --git a/src/cpu/x86/Kconfig.debug b/src/cpu/x86/Kconfig.debug
new file mode 100644
index 0000000000..2348231c58
--- /dev/null
+++ b/src/cpu/x86/Kconfig.debug
@@ -0,0 +1,6 @@
+config HAVE_DISPLAY_MTRRS
+	bool
+
+config DISPLAY_MTRRS
+	bool "Display intermediate MTRR settings"
+	depends on HAVE_DISPLAY_MTRRS
diff --git a/src/cpu/x86/mtrr/Makefile.inc b/src/cpu/x86/mtrr/Makefile.inc
index e6e9c50bc2..caa6e9c5d2 100644
--- a/src/cpu/x86/mtrr/Makefile.inc
+++ b/src/cpu/x86/mtrr/Makefile.inc
@@ -1,3 +1,9 @@
-ramstage-y += mtrr.c
-romstage-y += earlymtrr.c
-bootblock-y += earlymtrr.c
+ramstage-y	+= mtrr.c
+
+romstage-y	+= earlymtrr.c
+bootblock-y	+= earlymtrr.c
+
+bootblock-y	+= debug.c
+romstage-y	+= debug.c
+postcar-y	+= debug.c
+ramstage-y	+= debug.c
diff --git a/src/cpu/x86/mtrr/debug.c b/src/cpu/x86/mtrr/debug.c
new file mode 100644
index 0000000000..c562d84941
--- /dev/null
+++ b/src/cpu/x86/mtrr/debug.c
@@ -0,0 +1,202 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2015-2016 Intel Corporation.
+ *
+ * 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 <console/console.h>
+#include <cpu/cpu.h>
+#include <cpu/x86/mtrr.h>
+#include <stdint.h>
+
+static const char *display_mtrr_type(uint32_t type)
+{
+	switch (type) {
+	default: return "reserved";
+	case 0: return "UC";
+	case 1: return "WC";
+	case 4: return "WT";
+	case 5: return "WP";
+	case 6: return "WB";
+	case 7: return "UC-";
+	}
+}
+
+static void display_mtrr_fixed_types(uint64_t msr,
+	uint32_t starting_address, uint32_t memory_size)
+{
+	uint32_t base_address;
+	uint32_t index;
+	uint32_t next_address;
+	uint32_t next_type;
+	uint32_t type;
+
+	type = msr & MTRR_DEF_TYPE_MASK;
+	base_address = starting_address;
+	next_address = base_address;
+	for (index = 0; index < 64; index += 8) {
+		next_address = starting_address + (memory_size *
+			((index >> 3) + 1));
+		next_type = (msr >> index) & MTRR_DEF_TYPE_MASK;
+		if (next_type != type) {
+			printk(BIOS_DEBUG, "    0x%08x - 0x%08x: %s\n",
+				base_address, next_address - 1,
+				display_mtrr_type(type));
+			base_address = next_address;
+			type = next_type;
+		}
+	}
+	if (base_address != next_address)
+		printk(BIOS_DEBUG, "    0x%08x - 0x%08x: %s\n",
+			base_address, next_address - 1,
+			display_mtrr_type(type));
+}
+
+static void display_4k_mtrr(uint32_t msr_reg, uint32_t starting_address,
+	const char *name)
+{
+	union {
+		uint64_t u64;
+		msr_t s;
+	} msr;
+
+	msr.s = rdmsr(msr_reg);
+	printk(BIOS_DEBUG, "0x%016llx: %s\n", msr.u64, name);
+	display_mtrr_fixed_types(msr.u64, starting_address, 0x1000);
+}
+
+static void display_16k_mtrr(uint32_t msr_reg, uint32_t starting_address,
+	const char *name)
+{
+	union {
+		uint64_t u64;
+		msr_t s;
+	} msr;
+
+	msr.s = rdmsr(msr_reg);
+	printk(BIOS_DEBUG, "0x%016llx: %s\n", msr.u64, name);
+	display_mtrr_fixed_types(msr.u64, starting_address, 0x4000);
+}
+
+static void display_64k_mtrr(void)
+{
+	union {
+		uint64_t u64;
+		msr_t s;
+	} msr;
+
+	msr.s = rdmsr(MTRR_FIX_64K_00000);
+	printk(BIOS_DEBUG, "0x%016llx: IA32_MTRR_FIX64K_00000\n", msr.u64);
+	display_mtrr_fixed_types(msr.u64, 0, 0x10000);
+}
+
+static void display_mtrrcap(void)
+{
+	msr_t msr;
+
+	msr = rdmsr(MTRR_CAP_MSR);
+	printk(BIOS_DEBUG,
+		"0x%08x%08x: IA32_MTRRCAP: %s%s%s%u variable MTRRs\n",
+		msr.hi, msr.lo,
+		(msr.lo & MTRR_CAP_SMRR) ? "SMRR, " : "",
+		(msr.lo & MTRR_CAP_WC) ? "WC, " : "",
+		(msr.lo & MTRR_CAP_FIX) ? "FIX, " : "",
+		msr.lo & MTRR_CAP_VCNT);
+}
+
+static void display_mtrr_def_type(void)
+{
+	union {
+		uint64_t u64;
+		msr_t s;
+	} msr;
+
+	msr.s = rdmsr(MTRR_DEF_TYPE_MSR);
+	printk(BIOS_DEBUG, "0x%016llx: IA32_MTRR_DEF_TYPE:%s%s %s\n",
+		msr.u64,
+		(msr.u64 & MTRR_DEF_TYPE_EN) ? " E," : "",
+		(msr.u64 & MTRR_DEF_TYPE_FIX_EN) ? " FE," : "",
+		display_mtrr_type((uint32_t)(msr.u64 &
+			MTRR_DEF_TYPE_MASK)));
+}
+
+static void display_variable_mtrr(int index, uint64_t address_mask)
+{
+	const uint32_t msr_reg = MTRR_PHYS_BASE(index);
+	uint64_t base_address;
+	uint64_t length;
+	uint64_t mask;
+	union {
+		uint64_t u64;
+		msr_t s;
+	} msr_a;
+	union {
+		uint64_t u64;
+		msr_t s;
+	} msr_m;
+
+	msr_a.s = rdmsr(msr_reg);
+	msr_m.s = rdmsr(msr_reg + 1);
+	if (msr_m.u64 & MTRR_PHYS_MASK_VALID) {
+		base_address = (msr_a.u64 & 0xfffffffffffff000ULL)
+			& address_mask;
+		printk(BIOS_DEBUG,
+			"0x%016llx: PHYBASE%d: Address = 0x%016llx, %s\n",
+			msr_a.u64, index, base_address,
+			display_mtrr_type(msr_a.u64 & MTRR_DEF_TYPE_MASK));
+		mask = (msr_m.u64 & 0xfffffffffffff000ULL) & address_mask;
+		length = (~mask & address_mask) + 1;
+		printk(BIOS_DEBUG,
+			"0x%016llx: PHYMASK%d: Length  = 0x%016llx, Valid\n",
+			msr_m.u64, index, length);
+	} else {
+		printk(BIOS_DEBUG, "0x%016llx: PHYBASE%d\n", msr_a.u64, index);
+		printk(BIOS_DEBUG, "0x%016llx: PHYMASK%d: Disabled\n",
+			msr_m.u64, index);
+	}
+}
+
+static void _display_mtrrs(void)
+{
+	uint32_t address_bits;
+	uint64_t address_mask;
+	int i;
+	int variable_mtrrs;
+
+	/* Display the fixed MTRRs */
+	display_mtrrcap();
+	display_mtrr_def_type();
+	display_64k_mtrr();
+	display_16k_mtrr(MTRR_FIX_16K_80000, 0x80000, "IA32_MTRR_FIX16K_80000");
+	display_16k_mtrr(MTRR_FIX_16K_A0000, 0xa0000, "IA32_MTRR_FIX16K_A0000");
+	display_4k_mtrr(MTRR_FIX_4K_C0000, 0xc0000, "IA32_MTRR_FIX4K_C0000");
+	display_4k_mtrr(MTRR_FIX_4K_C8000, 0xc8000, "IA32_MTRR_FIX4K_C8000");
+	display_4k_mtrr(MTRR_FIX_4K_D0000, 0xd0000, "IA32_MTRR_FIX4K_D0000");
+	display_4k_mtrr(MTRR_FIX_4K_D8000, 0xd8000, "IA32_MTRR_FIX4K_D8000");
+	display_4k_mtrr(MTRR_FIX_4K_E0000, 0xe0000, "IA32_MTRR_FIX4K_E0000");
+	display_4k_mtrr(MTRR_FIX_4K_E8000, 0xe8000, "IA32_MTRR_FIX4K_E8000");
+	display_4k_mtrr(MTRR_FIX_4K_F0000, 0xf0000, "IA32_MTRR_FIX4K_F0000");
+	display_4k_mtrr(MTRR_FIX_4K_F8000, 0xf8000, "IA32_MTRR_FIX4K_F8000");
+	address_bits = cpu_phys_address_size();
+	address_mask = (1ULL << address_bits) - 1;
+
+	/* Display the variable MTRRs */
+	variable_mtrrs = get_var_mtrr_count();
+	for (i = 0; i < variable_mtrrs; i++)
+		display_variable_mtrr(i, address_mask);
+}
+
+asmlinkage void display_mtrrs(void)
+{
+	if (IS_ENABLED(CONFIG_DISPLAY_MTRRS))
+		_display_mtrrs();
+}
diff --git a/src/cpu/x86/mtrr/earlymtrr.c b/src/cpu/x86/mtrr/earlymtrr.c
index 4ee54a370f..02ad85f321 100644
--- a/src/cpu/x86/mtrr/earlymtrr.c
+++ b/src/cpu/x86/mtrr/earlymtrr.c
@@ -20,13 +20,11 @@
  */
 int get_free_var_mtrr(void)
 {
-	msr_t msr, maskm;
+	msr_t maskm;
 	int vcnt;
 	int i;
 
-	/* Read MTRRCap and get vcnt - variable memory type ranges. */
-	msr = rdmsr(MTRR_CAP_MSR);
-	vcnt = msr.lo & 0xff;
+	vcnt = get_var_mtrr_count();
 
 	/* Identify the first var mtrr which is not valid. */
 	for (i = 0; i < vcnt; i++) {