fwk: add virtual temperature and DTT support

Signed-off-by: LeoCX_Tsai <LeoCX_Tsai@compal.com>

Author: LeoCX-Tsai

baseboard/fwk/build.mk

@@ -13,4 +13,4 @@ baseboard-$(CONFIG_SYSTEMSERIAL_DEBUG) += system_serial.o
 baseboard-$(CONFIG_8042_AUX) += ps2mouse.o
 baseboard-$(HAS_TASK_HOSTCMD) += baseboard_host_commands.o
 baseboard-$(CONFIG_CHARGE_MANAGER) += battery_extender.o
-baseboard-$(CONFIG_FAN_VIRTUAL_TEMP) += temperature_filter.o
+baseboard-$(CONFIG_FAN_VIRTUAL_TEMP) += temperature_filter.o thermal.o

baseboard/fwk/fan.c

@@ -176,11 +176,11 @@ void fan_set_rpm_target(int ch, int rpm)
 
 	if (ch < 0 || ch > MCHP_TACH_ID_MAX || ch > FAN_CH_COUNT)
 		return;
-	/* Keep the fan spinning at min speed for a minute after we transition to 0 rpm*/
+	/* Keep the fan spinning at min speed for a 10s after we transition to 0 rpm*/
 	if (rpm == 0 && rpm_setting[ch] != rpm) {
 		timestamp_t now = get_time();
 
-		fan_spindown_time.val = now.val + 60*SECOND;
+		fan_spindown_time.val = now.val + 10*SECOND;
 	}
 	rpm_setting[ch] = rpm;
 	if (chipset_in_state(CHIPSET_STATE_ON) && rpm == 0 &&

baseboard/fwk/thermal.c

@@ -0,0 +1,211 @@
+/* Copyright 2023 The ChromiumOS Authors
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#include "chipset.h"
+#include "common.h"
+#include "console.h"
+#include "fan.h"
+#include "hooks.h"
+#include "system.h"
+#include "thermal.h"
+#include "temp_sensor.h"
+#include "util.h"
+#include "temperature_filter.h"
+#include "math_util.h"
+#include "temp_sensor/f75303.h"
+#include "temp_sensor/f75397.h"
+
+#define CPRINTS(format, args...) cprints(CC_THERMAL, format, ##args)
+#define CPRINTF(format, args...) cprintf(CC_THERMAL, format, ##args)
+
+#define FAN_STOP_DELAY_S (5 * SECOND)
+
+
+/*coeff in the form b0, b1, b2, A0, a1, a2 note: drop a0*/
+/* 1590,-3130,1590,-31527,15193,14 */
+/* */
+const int32_t apu_coeff[6] = {
+	22,     44,     22,  16384, -31023,  14727
+};
+struct biquad apu_filtered = {
+	.coeff = apu_coeff,
+};
+
+static void board_temperature_reset(void)
+{
+	thermal_filter_reset(&apu_filtered);
+}
+DECLARE_HOOK(HOOK_CHIPSET_RESUME, board_temperature_reset, HOOK_PRIO_DEFAULT);
+
+bool log_thermal;
+/* battery-temp */
+#define TEMP_BATTERY TEMP_SENSOR_BATTERY
+
+/* TODO: Rename to SOC */
+/* soc-temp */
+#define TEMP_APU TEMP_SENSOR_PECI
+
+/* ddr-f75303 */
+#define TEMP_DDR TEMP_SENSOR_DDR
+#define TEMP_DDR_F TEMP_SENSOR_DDR
+
+/* cpu-f75303 */
+#define TEMP_CPU TEMP_SENSOR_CPU
+#define TEMP_CPU_F TEMP_SENSOR_CPU
+
+/* local-f75397 */
+#define TEMP_LOCAL TEMP_SENSOR_LOCAL
+#define TEMP_LOCAL_F TEMP_SENSOR_LOCAL
+
+
+int fan_percent_to_rpm(int fan_index, int temp_ratio)
+{
+	int rpm;
+	int max = fans[fan_index].rpm->rpm_max;
+	int min = fans[fan_index].rpm->rpm_min;
+
+	if (temp_ratio <= 0) {
+		rpm = 0;
+	} else {
+		rpm = ((temp_ratio - 1) * max + (100 - temp_ratio) * min) / 99;
+	}
+
+	return rpm;
+}
+
+void board_override_fan_control(int fan, int *temp)
+{
+	int actual_rpm, new_rpm;
+	int apu_temp_mk = 0;
+
+	int apu_pct = 0;
+	int pct = 0;
+#ifdef CONFIG_GPU
+	int apu_selected_pct = 0;
+	int current_max_temp_idx = TEMP_APU;
+#endif
+	int apu_filtered_temp = 0;
+
+	int apu_filtered_pct = 0;
+	int temps_mk[5] = {0};
+
+	static timestamp_t deadline;
+	timestamp_t now = get_time();
+
+	/*
+	 * CPRINTS("fan: %d, is_thermal_control_enabled: %d", fan, is_thermal_control_enabled(fan));
+	 * */
+	if (!is_thermal_control_enabled(fan))
+		return;
+
+	/*
+	 * In common/fan.c pwm_fan_stop() will turn off fan
+	 * when chipset suspend or shutdown.
+	 */
+	if (chipset_in_state(CHIPSET_STATE_ON)) {
+
+		if (fan == 0) {
+			thermal_filter_update(&apu_filtered, temp[TEMP_APU]);
+		}
+		/*f75303_get_val_mk(TEMP_CPU_F, &apu_temp_mk); */
+
+		apu_filtered_temp = thermal_filter_get(&apu_filtered);
+
+		f75303_get_val_mk(TEMP_CPU_F, &temps_mk[1]);
+		if (thermal_params[TEMP_CPU].temp_fan_off &&
+			thermal_params[TEMP_CPU].temp_fan_max) {
+			apu_pct = thermal_fan_percent(thermal_params[TEMP_CPU].temp_fan_off * 1000,
+						thermal_params[TEMP_CPU].temp_fan_max * 1000,
+						temps_mk[1]);
+		}
+
+		if (thermal_params[TEMP_APU].temp_fan_off &&
+			thermal_params[TEMP_APU].temp_fan_max) {
+			apu_filtered_pct = thermal_fan_percent(
+				thermal_params[TEMP_APU].temp_fan_off * 1000,
+				thermal_params[TEMP_APU].temp_fan_max * 1000,
+				C_TO_K(apu_filtered_temp)*1000);
+		}
+		pct = MAX(apu_pct, apu_filtered_pct);
+		new_rpm = fan_percent_to_rpm(fan, pct);
+		actual_rpm = fan_get_rpm_actual(FAN_CH(fan));
+
+		/*
+		 * If we want to turn and the fans are currently significantly below
+		 * the minimum turning speed, we should turn at least as fast as the
+		 * necessary start speed instead.
+		 */
+		if (new_rpm && actual_rpm < fans[fan].rpm->rpm_min * 9 / 10 &&
+			new_rpm < fans[fan].rpm->rpm_start)
+			new_rpm = fans[fan].rpm->rpm_start;
+
+		if (!new_rpm) {
+			/* add temperature histeresis so the fan does not turn off
+			 * unless the system has cooled 0.5C below the fan turn on temperature
+			 */
+			if (thermal_params[TEMP_APU].temp_fan_off &&
+				apu_temp_mk > (thermal_params[TEMP_APU].temp_fan_off
+					* 1000 - 500)) {
+				deadline.val = get_time().val + FAN_STOP_DELAY_S;
+			}
+			if (!timestamp_expired(deadline, &now))
+				return;
+		} else {
+			deadline.val = get_time().val + FAN_STOP_DELAY_S;
+		}
+
+		if (log_thermal && fan == 0) {
+			f75303_get_val_mk(TEMP_DDR_F, &temps_mk[0]);
+			f75303_get_val_mk(TEMP_CPU_F, &temps_mk[1]);
+			f75397_get_val_mk(TEMP_LOCAL_F, &temps_mk[2]);
+			CPRINTS(
+				"\tThrm\t%d\t%d\t%d\t"
+				"\t%d\t%d\t"
+				"\t%d\t"
+				"\t%d\t%d\t%d\t"
+				"\t%d\t%d",
+				MILLI_KELVIN_TO_CELSIUS(temps_mk[0]),
+				MILLI_KELVIN_TO_CELSIUS(temps_mk[1]),
+				MILLI_KELVIN_TO_CELSIUS(temps_mk[2]),
+				temp[TEMP_BATTERY], temp[TEMP_APU],
+				thermal_filter_get(&apu_filtered),
+				pct, apu_pct, apu_filtered_pct,
+				new_rpm, actual_rpm);
+		}
+		fan_set_rpm_mode(fan, 1);
+		fan_set_rpm_target(FAN_CH(fan), new_rpm);
+	} else if (chipset_in_state(CHIPSET_STATE_ANY_SUSPEND)) {
+		/* Stop fan when enter S0ix */
+		fan_set_rpm_mode(fan, 1);
+		fan_set_rpm_target(fan, 0);
+	}
+}
+
+/* EC console command */
+static int thermallog_cmd(int argc, char **argv)
+{
+	if (argc >= 2) {
+		if (!strncmp(argv[1], "en", 2)) {
+			log_thermal = true;
+			CPRINTS(
+				"\tThrm\tDDR\tCPU\tLocal\t"
+				"\tBAT\tSOC\t"
+				"\tS_f\t"
+				"\tPCT\tSpct\tSfilt\t"
+				"\tRPM\tFAN"
+				);
+		} else if (!strncmp(argv[1], "dis", 3)) {
+			log_thermal = false;
+		} else {
+			return EC_ERROR_PARAM1;
+		}
+	} else {
+		CPRINTS("thermallog [en/dis]");
+	}
+	return EC_SUCCESS;
+}
+DECLARE_CONSOLE_COMMAND(thermallog, thermallog_cmd, "<en/dis>",
+			"Enable or disable thermal logging");
+

board/hx30/board.c

@@ -1007,19 +1007,19 @@ const struct temp_sensor_t temp_sensors[] = {
 	[TEMP_SENSOR_LOCAL] = {
 		.name = "F75303_Local",
 		.type = TEMP_SENSOR_TYPE_BOARD,
-		.read = f75303_get_val_mk,
+		.read = f75303_get_val,
 		.idx = F75303_IDX_LOCAL
 	},
 	[TEMP_SENSOR_CPU] = {
 		.name = "F75303_CPU",
 		.type = TEMP_SENSOR_TYPE_CPU,
-		.read = f75303_get_val_mk,
+		.read = f75303_get_val,
 		.idx = F75303_IDX_REMOTE2
 	},
 	[TEMP_SENSOR_DDR] = {
 		.name = "F75303_DDR",
 		.type = TEMP_SENSOR_TYPE_BOARD,
-		.read = f75303_get_val_mk,
+		.read = f75303_get_val,
 		.idx = F75303_IDX_REMOTE1
 	},
 	[TEMP_SENSOR_BATTERY] = {

board/hx30/board.h

@@ -407,6 +407,8 @@
 
 /* Support FAN */
 #define CONFIG_FANS 1
+#define CONFIG_CUSTOM_FAN_CONTROL
+#define CONFIG_FAN_RPM_CUSTOM
 #undef CONFIG_FAN_INIT_SPEED
 #define CONFIG_FAN_INIT_SPEED 15
 #define FAN_HARDARE_MAX 7100
@@ -417,6 +419,8 @@
 #define F75303_I2C_ADDR_FLAGS 0x4D
 #define CONFIG_CHIPSET_CAN_THROTTLE		/* Enable EC_PROCHOT_L control */
 
+#define CONFIG_MATH_UTIL
+
 #define CONFIG_THROTTLE_AP
 
 /* Factory mode support */

common/thermal.c

@@ -85,11 +85,6 @@ static void thermal_control(void)
 		/* read one */
 		rv = temp_sensor_read(i, &t);
 
-#ifdef CONFIG_CUSTOM_FAN_CONTROL
-		/* Store all sensors value */
-		temp[i] = K_TO_C(t);
-#endif
-
 		if (rv != EC_SUCCESS)
 			continue;
 		else

driver/temp_sensor/f75303.c

@@ -38,7 +38,7 @@ static int raw_read8(const int offset, int *data)
 			 offset, data);
 }
 
-#ifndef CONFIG_CUSTOMZIED_DESIGN
+#ifndef CONFIG_CUSTOMIZED_DESIGN
 static int get_temp(const int offset, int *temp)
 {
 	int rv;
@@ -100,7 +100,7 @@ int f75303_get_val(int idx, int *temp)
 	if (!f75303_enabled)
 		return EC_ERROR_NOT_POWERED;
 
-	*temp = temps[idx];
+	*temp = MILLI_KELVIN_TO_KELVIN(temps[idx]);
 	return EC_SUCCESS;
 }
 

include/common.h

@@ -198,11 +198,23 @@
 /* There isn't really a better place for this */
 #define C_TO_K(temp_c) ((temp_c) + 273)
 #define K_TO_C(temp_c) ((temp_c) - 273)
-#define CELSIUS_TO_DECI_KELVIN(temp_c) ((temp_c) * 10 + 2731)
+/*
+ * round_divide is part of math_utils, so you may need to import math_utils.h
+ * and link math_utils.o if you use the following macros.
+ */
+#define CELSIUS_TO_DECI_KELVIN(temp_c) \
+	(round_divide(CELSIUS_TO_MILLI_KELVIN(temp_c), 100))
+#define DECI_KELVIN_TO_CELSIUS(temp_dk) \
+	(MILLI_KELVIN_TO_CELSIUS((temp_dk) * 100))
+#define MILLI_KELVIN_TO_MILLI_CELSIUS(temp_mk) ((temp_mk)-273150)
 #define MILLI_CELSIUS_TO_MILLI_KELVIN(temp_mc) ((temp_mc) + 273150)
-#define KELVIN_TO_MILLI_KELVIN(temp_k) ((temp_k) * 1000)
-#define DECI_KELVIN_TO_CELSIUS(temp_dk) ((temp_dk - 2731) / 10)
 #define MILLI_KELVIN_TO_KELVIN(temp_mk) (round_divide((temp_mk), 1000))
+#define KELVIN_TO_MILLI_KELVIN(temp_k) ((temp_k) * 1000)
+#define CELSIUS_TO_MILLI_KELVIN(temp_c) \
+	(MILLI_CELSIUS_TO_MILLI_KELVIN((temp_c) * 1000))
+#define MILLI_KELVIN_TO_CELSIUS(temp_mk) \
+	(round_divide(MILLI_KELVIN_TO_MILLI_CELSIUS(temp_mk), 1000))
+
 
 /* Calculate a value with error margin considered. For example,
  * TARGET_WITH_MARGIN(X, 5) returns X' where X' * 100.5% is almost equal to