[M] Change in coreboot[master]: drivers/ocp: add VPD processing framework

[Jonathan Zhang (Code Review)]

Attention is currently required from: Marc Jones, Tim Chu.

Hello Marc Jones, Tim Chu,

I'd like you to do a code review.
Please visit

https://review.coreboot.org/c/coreboot/+/68784

to review the following change.

Change subject: drivers/ocp: add VPD processing framework
......................................................................

drivers/ocp: add VPD processing framework

Add VPD processing framework to be shared by OCP mainboards:
* define VPD configruation items in vpd.h.
* add helper functions:
** get_bool_from_vpd()
** get_int_from_vpd_range()

Change-Id: I705bea348b1611f25ccbd798b77cfee22ec30f0f
Signed-off-by: Johnny Lin 
Signed-off-by: Tim Chu 
Signed-off-by: Marc Jones 
Signed-off-by: Jonathan Zhang 
---
A src/drivers/ocp/include/vpd.h
A src/drivers/ocp/vpd/Kconfig
A src/drivers/ocp/vpd/Makefile.inc
A src/drivers/ocp/vpd/vpd_util.c
4 files changed, 153 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/84/68784/1

diff --git a/src/drivers/ocp/include/vpd.h b/src/drivers/ocp/include/vpd.h
new file mode 100644
index 0000000..fe230ee
--- /dev/null
+++ b/src/drivers/ocp/include/vpd.h
@@ -0,0 +1,84 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef OCP_VPD_H
+#define OCP_VPD_H
+
+/* VPD variable for enabling/disabling FRB2 timer. 1/0: Enable/disable */
+#define FRB2_TIMER "frb2_timer_enable"
+#define FRB2_TIMER_DEFAULT 1 /* Default value when the VPD variable is not found */
+
+/* VPD variable for setting FRB2 timer countdown value. */
+#define FRB2_COUNTDOWN "frb2_countdown"
+/* Default countdown is 15 minutes when the VPD variable is not found */
+#define FRB2_COUNTDOWN_DEFAULT 9000
+
+/* VPD variable for setting FRB2 timer action.
+   0: No action, 1: hard reset, 2: power down, 3: power cycle */
+#define FRB2_ACTION "frb2_action"
+#define FRB2_ACTION_DEFAULT 0 /* Default no action when the VPD variable is not found */
+
+/* coreboot log level */
+#define COREBOOT_LOG_LEVEL "coreboot_log_level"
+#define COREBOOT_LOG_LEVEL_DEFAULT 4
+
+/* Define the VPD keys for UPD variables that can be overwritten */
+#define FSP_LOG "fsp_log_enable" /* 1 or 0: enable or disable FSP SOL log */
+#define FSP_LOG_DEFAULT 1 /* Default value when the VPD variable is not found */
+
+/* Select Memory Serial Debug Message Level.
+   0:Disable, 1:Minimum, 2:Normal, 3:Maximum, 4:Auto */
+#define FSP_MEM_LOG_LEVEL "fsp_mem_log_lvl"
+#define FSP_MEM_LOG_LEVEL_DEFAULT 1
+
+/* VPD variable for enabling/disabling MRC promote warning in FSP.
+   System may upgrade memory training warning to fatal error when enabled.
+   0: Disable, 1: Enable */
+#define MRC_PROMOTE_WARNING "mrc_promote_warning"
+#define MRC_PROMOTE_WARNING_DEFAULT 1
+
+/* SMM log level */
+#define SMM_LOG_LEVEL "smm_log_level"
+#define SMM_LOG_LEVEL_DEFAULT 0 /* By default 0 would disable SMM log completely */
+
+/* FSP Dfx PMIC secure mode.
+   0:Disable Pmic Secure Mode, 1:Enable Pmic Secure Mode, 2:Auto Pmic Secure Mode */
+#define FSP_PMIC_SECURE_MODE "fsp_pmic_mode"
+#define FSP_PMIC_SECURE_MODE_DEFAULT 2
+
+enum cxl_memory_mode {
+	CXL_DISABLED, // 0
+	CXL_SYSTEM_MEMORY, // 1
+	CXL_SPM,//2
+	CXL_MODE_MAX,
+};
+
+/* CXL mode. 0: Disable CXL, 1: configured as system memory, 2: configured as SPM. */
+#define CXL_MODE "cxl_mode"
+#define CXL_MODE_DEFAULT CXL_SYSTEM_MEMORY /* By default configured as system memory */
+
+/* Skip TXT lockdown */
+#define SKIP_INTEL_TXT_LOCKDOWN "skip_intel_txt_lockdown"
+#define SKIP_INTEL_TXT_LOCKDOWN_DEFAULT 0
+
+/* Disable boot drive PCIe root port for testing */
+#define DISABLE_BOOTDRIVE "disable_bootdrive"
+#define DISABLE_BOOTDRIVE_DEFAULT 0 /* By default don't disable */
+
+/* Skip Global reset so that information in Previous Boot Error Hob won't be cleared */
+#define SKIP_GLOBAL_RESET "skip_global_reset"
+#define SKIP_GLOBAL_RESET_DEFAULT 1
+
+/* Disable memory poison */
+#define DISABLE_MEM_POISON "disable_mem_poison"
+#define DISABLE_MEM_POISON_DEFAULT 0
+
+/* Socket 0 core disable bitmask, set 1 to disable core */
+#define CORE_DIS_BITMSK0 "core_disable_bitmask0"
+/* Socket 1 core disable bitmask */
+#define CORE_DIS_BITMSK1 "core_disable_bitmask1"
+
+/* Get VPD key with provided fallback value and min/max ranges */
+int get_int_from_vpd_range(const char *const key, const int fallback, const int min,
+	const int max);
+bool get_bool_from_vpd(const char *const key, const bool fallback);
+#endif
diff --git a/src/drivers/ocp/vpd/Kconfig b/src/drivers/ocp/vpd/Kconfig
new file mode 100644
index 0000000..ebecbe6
--- /dev/null
+++ b/src/drivers/ocp/vpd/Kconfig
@@ -0,0 +1,6 @@
+config OCP_VPD
+	bool
+	default n
+	depends on VPD
+	help
+	  It implements functions that get common VPD variables for OCP projects.
diff --git a/src/drivers/ocp/vpd/Makefile.inc b/src/drivers/ocp/vpd/Makefile.inc
new file mode 100644
index 0000000..d00f27d
--- /dev/null
+++ b/src/drivers/ocp/vpd/Makefile.inc
@@ -0,0 +1,3 @@
+romstage-$(CONFIG_OCP_VPD) += vpd_util.c
+ramstage-$(CONFIG_OCP_VPD) += vpd_util.c
+smm-$(CONFIG_VPD_SMM_SUPPORT) += vpd_util.c
diff --git a/src/drivers/ocp/vpd/vpd_util.c b/src/drivers/ocp/vpd/vpd_util.c
new file mode 100644
index 0000000..57dbc3c
--- /dev/null
+++ b/src/drivers/ocp/vpd/vpd_util.c
@@ -0,0 +1,41 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#include <console/console.h>
+#include <drivers/vpd/vpd.h>
+#include <drivers/ocp/include/vpd.h>
+
+int get_int_from_vpd_range(const char *const key, const int fallback, const int min,
+	const int max)
+{
+	int val = fallback;
+
+	if (!vpd_get_int(key, VPD_RW_THEN_RO, &val))
+		printk(BIOS_INFO, "%s: not able to get VPD %s, default set to %d\n",
+		       __func__, key, fallback);
+	else
+		printk(BIOS_DEBUG, "%s: VPD %s, got %d\n", __func__, key, val);
+
+	if (val < min || val > max) {
+		printk(BIOS_INFO, "Invalid VPD %s value, set default value to %d\n",
+			key, fallback);
+		val = fallback;
+	}
+
+	return val;
+}
+
+bool get_bool_from_vpd(const char *const key, const bool fallback)
+{
+	uint8_t val;
+
+	val = (uint8_t)fallback;
+
+	if (!vpd_get_bool(key, VPD_RW_THEN_RO, &val))
+		printk(BIOS_INFO, "%s: not able to get VPD %s, default set to %d\n",
+		       __func__, key, fallback);
+	else
+		printk(BIOS_DEBUG, "%s: VPD %s, got %d\n", __func__, key, val);
+
+
+	return (bool)val;
+}