soc/intel/common/thermal: Refactor thermal block to improve reusability

This patch moves common thermal API between chipsets
with thermal device as PCI device and thermal device behind PMC
into common file (thermal_common.c).

Introduce CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV to let SoC
Kconfig to select as applicable for underlying chipset.

+------------------------------------------------------+--------------+
|               Thermal Kconfig                        |    SoC       |
+------------------------------------------------------+--------------+
| CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV        | SKL/KBL, CNL |
|                                                      | till ICL     |
+------------------------------------------------------+--------------+
| CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL_BEHIND_PMC     | TGL onwards  |
|                                                      | ICL          |
+------------------------------------------------------+--------------+

Either of these two Kconfig internally selects
CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL to use common thermal APIs.

BUG=b:193774296
TEST=Able to build and boot hatch and adlrvp platform.

Change-Id: I14df5145629ef03f358b98e824bca6a5b8ebdfc6
Signed-off-by: Subrata Banik <subrata.banik@intel.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/59509
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-by: EricR Lai <ericr_lai@compal.corp-partner.google.com>
Reviewed-by: Tim Wawrzynczak <twawrzynczak@chromium.org>

src/soc/intel/cannonlake/Kconfig

@@ -94,7 +94,7 @@ config CPU_SPECIFIC_OPTIONS
 	select SOC_INTEL_COMMON_BLOCK_SCS
 	select SOC_INTEL_COMMON_BLOCK_SMM
 	select SOC_INTEL_COMMON_BLOCK_SMM_IO_TRAP
-	select SOC_INTEL_COMMON_BLOCK_THERMAL
+	select SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV
 	select SOC_INTEL_COMMON_BLOCK_XHCI
 	select SOC_INTEL_COMMON_BLOCK_XHCI_ELOG
 	select SOC_INTEL_COMMON_FSP_RESET

src/soc/intel/common/block/include/intelblocks/thermal.h

@@ -3,6 +3,25 @@
 #ifndef _SOC_INTEL_COMMON_BLOCK_THERMAL_H_
 #define _SOC_INTEL_COMMON_BLOCK_THERMAL_H_
 
+#define MAX_TRIP_TEMP 205
+/* This is the safest default Trip Temp value */
+#define DEFAULT_TRIP_TEMP 50
+
+#if CONFIG(SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV)
+  /* Trip Point Temp = (LTT / 2 - 50 degree C) */
+  #define GET_LTT_VALUE(x) (((x) + 50) * (2))
+#elif CONFIG(SOC_INTEL_COMMON_BLOCK_THERMAL_BEHIND_PMC)
+  /*
+   * Trip Point = T2L | T1L | T0L where T2L > T1L > T0L
+   * T2L = Bit 28:20
+   * T1L = Bit 18:10
+   * T0L = Bit 8:0
+   */
+  #define GET_LTT_VALUE(x) (((x) + 10) << 20 | ((x) + 5) << 10 | (x))
+#else
+  #error <Undefined: GET_LTT_VALUE macro>
+#endif
+
 /* Catastrophic Trip Point Enable */
 #define PMC_PWRM_THERMAL_CTEN			0x150c
 /* Policy Lock-Down Bit */
@@ -30,6 +49,10 @@
 /* PHL Lock */
 #define  PMC_PWRM_THERMAL_PHLC_PHLCLOCK		(1 << 31)
 
+/* Get PCH Thermal Trip from common chip config */
+uint8_t get_thermal_trip_temp(void);
+/* PCH Low Temp Threshold (LTT) */
+uint32_t pch_get_ltt_value(void);
 /* Enable thermal sensor power management */
 void pch_thermal_configuration(void);
 

src/soc/intel/common/block/thermal/Kconfig

@@ -4,9 +4,19 @@ config SOC_INTEL_COMMON_BLOCK_THERMAL
 	help
 	  This option allows to configure PCH thermal registers for supported PCH.
 
+config SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV
+	bool
+	default n
+	select SOC_INTEL_COMMON_BLOCK_THERMAL
+	help
+	  This option allows to configure PCH thermal registers using Thermal PCI device
+	  for chipsets till Ice Lake PCH.
+
 config SOC_INTEL_COMMON_BLOCK_THERMAL_BEHIND_PMC
 	bool
 	default n
+	depends on !SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV
+	select SOC_INTEL_COMMON_BLOCK_THERMAL
 	help
 	  This option allows to configure PCH thermal registers using PMC PWRMBASE
 	  for chipsets since Tiger Lake PCH.

src/soc/intel/common/block/thermal/Makefile.inc

@@ -1,3 +1,5 @@
-romstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL) += thermal.c
+romstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL) += thermal_common.c
+romstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV) += thermal_pci.c
 romstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL_BEHIND_PMC) += thermal_pmc.c
-ramstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL) += thermal.c
+ramstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL) += thermal_common.c
+ramstage-$(CONFIG_SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV) += thermal_pci.c

src/soc/intel/common/block/thermal/thermal_common.c

@@ -0,0 +1,29 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#include <console/console.h>
+#include <intelblocks/cfg.h>
+#include <intelblocks/thermal.h>
+
+/* Get PCH Thermal Trip from common chip config */
+uint8_t get_thermal_trip_temp(void)
+{
+	const struct soc_intel_common_config *common_config;
+	common_config = chip_get_common_soc_structure();
+
+	return common_config->pch_thermal_trip;
+}
+
+/* PCH Low Temp Threshold (LTT) */
+uint32_t pch_get_ltt_value(void)
+{
+	uint8_t thermal_config;
+
+	thermal_config = get_thermal_trip_temp();
+	if (!thermal_config)
+		thermal_config = DEFAULT_TRIP_TEMP;
+
+	if (thermal_config > MAX_TRIP_TEMP)
+		die("Input PCH temp trip is higher than allowed range!");
+
+	return GET_LTT_VALUE(thermal_config);
+}

src/soc/intel/common/block/thermal/thermal_pci.c

@@ -1,41 +1,13 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
 
 #include <console/console.h>
+#include <device/device.h>
 #include <device/mmio.h>
-#include <intelblocks/cfg.h>
 #include <intelblocks/thermal.h>
 #include <soc/pci_devs.h>
 
 #define THERMAL_SENSOR_POWER_MANAGEMENT 0x1c
 #define CATASTROPHIC_TRIP_POINT_MASK 0x1ff
-#define MAX_TRIP_TEMP 205
-/* This is the safest default Trip Temp value */
-#define DEFAULT_TRIP_TEMP 50
-/* Trip Point Temp = (LTT / 2 - 50 degree C) */
-#define GET_LTT_VALUE(x) (((x) + 50) * (2))
-
-static uint8_t get_thermal_trip_temp(void)
-{
-	const struct soc_intel_common_config *common_config;
-	common_config = chip_get_common_soc_structure();
-
-	return common_config->pch_thermal_trip;
-}
-
-/* PCH Low Temp Threshold (LTT) */
-static uint32_t pch_get_ltt_value(void)
-{
-	uint8_t thermal_config;
-
-	thermal_config = get_thermal_trip_temp();
-	if (!thermal_config)
-		thermal_config = DEFAULT_TRIP_TEMP;
-
-	if (thermal_config > MAX_TRIP_TEMP)
-		die("Input PCH temp trip is higher than allowed range!");
-
-	return GET_LTT_VALUE(thermal_config);
-}
 
 /* Enable thermal sensor power management */
 void pch_thermal_configuration(void)

src/soc/intel/common/block/thermal/thermal_pmc.c

@@ -1,46 +1,9 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
 
-#include <console/console.h>
 #include <device/mmio.h>
-#include <intelblocks/cfg.h>
 #include <intelblocks/pmclib.h>
 #include <intelblocks/thermal.h>
 
-#define MAX_TRIP_TEMP 205
-/* This is the safest default Trip Temp value */
-#define DEFAULT_TRIP_TEMP 50
-
-/*
- * Trip Point = T2L | T1L | T0L where T2L > T1L > T0L
- * T2L = Bit 28:20
- * T1L = Bit 18:10
- * T0L = Bit 8:0
- */
-#define GET_LTT_VALUE(x) ((x + 10) << 20 | (x + 5) << 10 | x)
-
-static uint8_t get_thermal_trip_temp(void)
-{
-	const struct soc_intel_common_config *common_config;
-	common_config = chip_get_common_soc_structure();
-
-	return common_config->pch_thermal_trip;
-}
-
-/* PCH Low Temp Threshold (LTT) */
-static uint32_t pch_get_ltt_value(void)
-{
-	uint8_t thermal_config;
-
-	thermal_config = get_thermal_trip_temp();
-	if (!thermal_config)
-		thermal_config = DEFAULT_TRIP_TEMP;
-
-	if (thermal_config > MAX_TRIP_TEMP)
-		die("Input PCH temp trip is higher than allowed range!");
-
-	return GET_LTT_VALUE(thermal_config);
-}
-
 /*
  * Thermal configuration has evolved over time. With older platform the
  * thermal device is sitting over PCI and allow to configure its configuration

src/soc/intel/icelake/Kconfig

@@ -50,7 +50,7 @@ config CPU_SPECIFIC_OPTIONS
 	select SOC_INTEL_COMMON_BLOCK_SCS
 	select SOC_INTEL_COMMON_BLOCK_SMM
 	select SOC_INTEL_COMMON_BLOCK_SMM_IO_TRAP
-	select SOC_INTEL_COMMON_BLOCK_THERMAL
+	select SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV
 	select SOC_INTEL_COMMON_FSP_RESET
 	select SOC_INTEL_COMMON_PCH_BASE
 	select SOC_INTEL_COMMON_RESET

src/soc/intel/skylake/Kconfig

@@ -70,7 +70,7 @@ config CPU_SPECIFIC_OPTIONS
 	select SOC_INTEL_COMMON_BLOCK_SGX_LOCK_MEMORY
 	select SOC_INTEL_COMMON_BLOCK_SMM
 	select SOC_INTEL_COMMON_BLOCK_SMM_IO_TRAP
-	select SOC_INTEL_COMMON_BLOCK_THERMAL
+	select SOC_INTEL_COMMON_BLOCK_THERMAL_PCI_DEV
 	select SOC_INTEL_COMMON_BLOCK_UART
 	select SOC_INTEL_COMMON_BLOCK_XHCI_ELOG
 	select SOC_INTEL_COMMON_FSP_RESET