jinlon: add dual fan control by ec

This patch allows the ec to manage two fans. Currently common/thermal.c
cannot monitor more than 1 fan at the same time. This CL implements a
board-specific thermal policy with multiple fans.

BUG=b:141259174
BRANCH=hatch
TEST=thermal team verified thermal policy is expected.

Change-Id: I6ababcb0795408e8062b7605bc749e23b8bde45a
Signed-off-by: Devin Lu <Devin.Lu@quantatw.com>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1936077
Reviewed-by: Paul Fagerburg <pfagerburg@chromium.org>
Reviewed-by: Tim Wawrzynczak <twawrzynczak@chromium.org>

8 files changed, 265 insertions, 10 deletions

diff --git a/board/jinlon/board.h b/board/jinlon/board.h
index b39bb4c8e6..ffe9ad77c0 100644
--- a/board/jinlon/board.h
+++ b/board/jinlon/board.h
@@ -85,6 +85,7 @@
 
 /* Fan features */
 #define CONFIG_FANS 2
+#define CONFIG_CUSTOM_FAN_CONTROL
 #undef CONFIG_FAN_INIT_SPEED
 #define CONFIG_FAN_INIT_SPEED 50
 #define CONFIG_TEMP_SENSOR_OTI502
diff --git a/board/jinlon/build.mk b/board/jinlon/build.mk
index 733912454f..2d6118ea70 100644
--- a/board/jinlon/build.mk
+++ b/board/jinlon/build.mk
@@ -11,5 +11,5 @@ CHIP_FAMILY:=npcx7
 CHIP_VARIANT:=npcx7m6fc
 BASEBOARD:=hatch
 
-board-y=board.o led.o
+board-y=board.o led.o thermal.o
 board-$(CONFIG_BATTERY_SMART)+=battery.o
diff --git a/board/jinlon/thermal.c b/board/jinlon/thermal.c
new file mode 100644
index 0000000000..a997d587d4
--- /dev/null
+++ b/board/jinlon/thermal.c
@@ -0,0 +1,221 @@
+/* Copyright 2019 The Chromium OS Authors. All rights reserved.
+ * 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 "host_command.h"
+#include "tablet_mode.h"
+#include "temp_sensor.h"
+#include "thermal.h"
+#include "util.h"
+
+/* Console output macros */
+#define CPUTS(outstr) cputs(CC_THERMAL, outstr)
+#define CPRINTS(format, args...) cprints(CC_THERMAL, format, ## args)
+
+struct fan_step {
+	/*
+	 * Sensor 1~4 trigger point, set -1 if we're not using this
+	 * sensor to determine fan speed.
+	 */
+	int8_t on[TEMP_SENSOR_COUNT];
+
+	/*
+	 * Sensor 1~4 trigger point, set -1 if we're not using this
+	 * sensor to determine fan speed.
+	 */
+	int8_t off[TEMP_SENSOR_COUNT];
+
+	/* Fan 1~2 rpm */
+	uint16_t rpm[FAN_CH_COUNT];
+};
+
+static const struct fan_step *fan_step_table;
+
+static const struct fan_step fan_table_clamshell[] = {
+	{
+		/* level 0 */
+		.on = {0, -1, 54, 45},
+		.off = {99, -1, 52, 0},
+		.rpm = {0, 0},
+	},
+	{
+		/* level 1 */
+		.on = {0, -1, 56, 46},
+		.off = {99, -1, 54, 45},
+		.rpm = {4200, 4700},
+	},
+	{
+		/* level 2 */
+		.on = {0, -1, 58, 47},
+		.off = {99, -1, 56, 46},
+		.rpm = {4400, 4900},
+	},
+	{
+		/* level 3 */
+		.on = {0, -1, 60, 48},
+		.off = {99, -1, 58, 47},
+		.rpm = {4600, 5100},
+	},
+	{
+		/* level 4 */
+		.on = {80, -1, 62, 49},
+		.off = {74, -1, 60, 48},
+		.rpm = {4800, 5300},
+	},
+	{
+		/* level 5 */
+		.on = {85, -1, 64, 50},
+		.off = {79, -1, 62, 49},
+		.rpm = {5200, 5700},
+	},
+	{
+		/* level 6 */
+		.on = {90, -1, 66, 51},
+		.off = {84, -1, 64, 50},
+		.rpm = {5600, 6100},
+	},
+	{
+		/* level 7 */
+		.on = {127, -1, 127, 127},
+		.off = {89, -1, 66, 51},
+		.rpm = {6000, 6500},
+	},
+};
+
+static const struct fan_step fan_table_tablet[] = {
+	{
+		/* level 0 */
+		.on = {0, -1, 40, 42},
+		.off = {99, -1, 0, 0},
+		.rpm = {0, 0},
+	},
+	{
+		/* level 1 */
+		.on = {0, -1, 42, 43},
+		.off = {99, -1, 37, 42},
+		.rpm = {0, 0},
+	},
+	{
+		/* level 2 */
+		.on = {0, -1, 44, 44},
+		.off = {99, -1, 39, 43},
+		.rpm = {0, 0},
+	},
+	{
+		/* level 3 */
+		.on = {0, -1, 46, 45},
+		.off = {99, -1, 41, 44},
+		.rpm = {0, 0},
+	},
+	{
+		/* level 4 */
+		.on = {80, -1, 48, 46},
+		.off = {74, -1, 43, 45},
+		.rpm = {4800, 5300},
+	},
+	{
+		/* level 5 */
+		.on = {85, -1, 50, 47},
+		.off = {79, -1, 45, 46},
+		.rpm = {5200, 5700},
+	},
+	{
+		/* level 6 */
+		.on = {90, -1, 65, 60},
+		.off = {84, -1, 47, 47},
+		.rpm = {5600, 6100},
+	},
+	{
+		/* level 7 */
+		.on = {127, -1, 127, 127},
+		.off = {89, -1, 57, 53},
+		.rpm = {6000, 6500},
+	},
+};
+
+#define NUM_FAN_LEVELS ARRAY_SIZE(fan_table_clamshell)
+
+BUILD_ASSERT(ARRAY_SIZE(fan_table_clamshell) ==
+	ARRAY_SIZE(fan_table_tablet));
+
+int fan_table_to_rpm(int fan, int *temp)
+{
+	static int current_level;
+	static int prev_tmp[TEMP_SENSOR_COUNT];
+	static int new_rpm;
+	int i;
+
+	if (tablet_get_mode())
+		fan_step_table = fan_table_tablet;
+	else
+		fan_step_table = fan_table_clamshell;
+
+	/*
+	 * Compare the current and previous temperature, we have
+	 * the three paths :
+	 *  1. decreasing path. (check the release point)
+	 *  2. increasing path. (check the trigger point)
+	 *  3. invariant path. (return the current RPM)
+	 */
+
+	if (temp[TEMP_SENSOR_1] < prev_tmp[TEMP_SENSOR_1] ||
+		temp[TEMP_SENSOR_3] < prev_tmp[TEMP_SENSOR_3] ||
+		temp[TEMP_SENSOR_4] < prev_tmp[TEMP_SENSOR_4]) {
+		for (i = current_level; i > 0; i--) {
+			if (temp[TEMP_SENSOR_1] < fan_step_table[i].off[TEMP_SENSOR_1] &&
+				 temp[TEMP_SENSOR_4] < fan_step_table[i].off[TEMP_SENSOR_4] &&
+				 temp[TEMP_SENSOR_3] < fan_step_table[i].off[TEMP_SENSOR_3])
+				current_level = i - 1;
+			else
+				break;
+		}
+	} else if (temp[TEMP_SENSOR_1] > prev_tmp[TEMP_SENSOR_1] ||
+		   temp[TEMP_SENSOR_3] > prev_tmp[TEMP_SENSOR_3] ||
+		   temp[TEMP_SENSOR_4] > prev_tmp[TEMP_SENSOR_4]) {
+		for (i = current_level; i < NUM_FAN_LEVELS; i++) {
+			if ((temp[TEMP_SENSOR_1] > fan_step_table[i].on[TEMP_SENSOR_1] &&
+				 temp[TEMP_SENSOR_4] > fan_step_table[i].on[TEMP_SENSOR_4]) ||
+				 temp[TEMP_SENSOR_3] > fan_step_table[i].on[TEMP_SENSOR_3])
+				current_level = i + 1;
+			else
+				break;
+		}
+	}
+
+	if (current_level < 0)
+		current_level = 0;
+
+	for (i = 0; i < TEMP_SENSOR_COUNT; ++i)
+		prev_tmp[i] = temp[i];
+
+	ASSERT(current_level < NUM_FAN_LEVELS);
+
+	switch (fan) {
+	case FAN_CH_0:
+		new_rpm = fan_step_table[current_level].rpm[FAN_CH_0];
+		break;
+	case FAN_CH_1:
+		new_rpm = fan_step_table[current_level].rpm[FAN_CH_1];
+		break;
+	default:
+		break;
+	}
+
+	return new_rpm;
+}
+
+void board_override_fan_control(int fan, int *tmp)
+{
+	if (chipset_in_state(CHIPSET_STATE_ON |
+		CHIPSET_STATE_ANY_SUSPEND)) {
+		fan_set_rpm_mode(FAN_CH(fan), 1);
+		fan_set_rpm_target(FAN_CH(fan),
+			fan_table_to_rpm(fan, tmp));
+	}
+}
diff --git a/common/fan.c b/common/fan.c
index f3ee013a4c..c91fa1b318 100644
--- a/common/fan.c
+++ b/common/fan.c
@@ -20,6 +20,11 @@
  * things manually. */
 static int thermal_control_enabled[CONFIG_FANS];
 
+int is_thermal_control_enabled(int idx)
+{
+	return thermal_control_enabled[idx];
+}
+
 #ifdef CONFIG_FAN_UPDATE_PERIOD
 /* Should we ignore the fans for a while? */
 static int fan_update_counter[CONFIG_FANS];
@@ -72,7 +77,7 @@ test_mockable void fan_set_percent_needed(int fan, int pct)
 {
 	int actual_rpm, new_rpm;
 
-	if (!thermal_control_enabled[fan])
+	if (!is_thermal_control_enabled(fan))
 		return;
 
 #ifdef CONFIG_FAN_UPDATE_PERIOD
@@ -195,7 +200,7 @@ static int cc_faninfo(int argc, char **argv)
 		ccprintf("%sMode:   %s\n", leader,
 			 fan_get_rpm_mode(FAN_CH(fan)) ? "rpm" : "duty");
 		ccprintf("%sAuto:   %s\n", leader,
-			 thermal_control_enabled[fan] ? "yes" : "no");
+			 is_thermal_control_enabled(fan) ? "yes" : "no");
 		ccprintf("%sEnable: %s\n", leader,
 			 fan_get_enabled(FAN_CH(fan)) ? "yes" : "no");
 		is_pgood = is_powered(fan);
@@ -317,7 +322,7 @@ int dptf_get_fan_duty_target(void)
 	if (fan_count == 0)
 		return -1;
 
-	if (thermal_control_enabled[fan] || fan_get_rpm_mode(FAN_CH(fan)))
+	if (is_thermal_control_enabled(fan) || fan_get_rpm_mode(FAN_CH(fan)))
 		return -1;
 
 	return fan_get_duty(FAN_CH(fan));
@@ -551,7 +556,7 @@ static void pwm_fan_preserve_state(void)
 	/* TODO(crosbug.com/p/23530): Still treating all fans as one. */
 	if (fan_get_enabled(FAN_CH(fan)))
 		state.flag |= FAN_STATE_FLAG_ENABLED;
-	if (thermal_control_enabled[fan])
+	if (is_thermal_control_enabled(fan))
 		state.flag |= FAN_STATE_FLAG_THERMAL;
 	state.rpm = fan_get_rpm_target(FAN_CH(fan));
 
diff --git a/common/thermal.c b/common/thermal.c
index f5988f7046..b39dab04cd 100644
--- a/common/thermal.c
+++ b/common/thermal.c
@@ -59,6 +59,10 @@ static void thermal_control(void)
 	int fmax;
 	int temp_fan_configured;
 
+#ifdef CONFIG_CUSTOM_FAN_CONTROL
+	int temp[TEMP_SENSOR_COUNT];
+#endif
+
 	/* Get ready to count things */
 	memset(count_over, 0, sizeof(count_over));
 	memset(count_under, 0, sizeof(count_under));
@@ -72,6 +76,12 @@ 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
@@ -174,14 +184,24 @@ static void thermal_control(void)
 
 	if (temp_fan_configured) {
 #ifdef CONFIG_FANS
-	/* TODO(crosbug.com/p/23797): For now, we just treat all fans the
-	 * same. It would be better if we could assign different thermal
-	 * profiles to each fan - in case one fan cools the CPU while another
-	 * cools the radios or battery.
-	 */
+#ifdef CONFIG_CUSTOM_FAN_CONTROL
+		for (i = 0; i < fan_get_count(); i++) {
+			if (!is_thermal_control_enabled(i))
+				continue;
+
+			board_override_fan_control(i, temp);
+		}
+#else
+		/* TODO(crosbug.com/p/23797): For now, we just treat all
+		 * fans the same. It would be better if we could assign
+		 * different thermal profiles to each fan - in case one
+		 * fan cools the CPU while another cools the radios or
+		 * battery.
+		 */
 		for (i = 0; i < fan_get_count(); i++)
 			fan_set_percent_needed(i, fmax);
 #endif
+#endif
 	}
 }
 
diff --git a/include/config.h b/include/config.h
index 20c26cf231..0d578451cb 100644
--- a/include/config.h
+++ b/include/config.h
@@ -1626,6 +1626,9 @@
 /* Percentage to which all fans are set at initiation */
 #define CONFIG_FAN_INIT_SPEED 100
 
+/* Allow board custom fan control */
+#undef CONFIG_CUSTOM_FAN_CONTROL
+
 /* Support fan control while in low-power idle */
 #undef CONFIG_FAN_DSLEEP
 
diff --git a/include/fan.h b/include/fan.h
index 083feae4a9..fd49649547 100644
--- a/include/fan.h
+++ b/include/fan.h
@@ -124,4 +124,6 @@ int fan_get_count(void);
 
 void fan_set_count(int count);
 
+int is_thermal_control_enabled(int idx);
+
 #endif  /* __CROS_EC_FAN_H */
diff --git a/include/thermal.h b/include/thermal.h
index 62e16cb7c2..7628cfd6ae 100644
--- a/include/thermal.h
+++ b/include/thermal.h
@@ -19,4 +19,7 @@ extern struct ec_thermal_config thermal_params[];
 /* Helper function to compute percent cooling */
 int thermal_fan_percent(int low, int high, int cur);
 
+/* Allow board custom fan control */
+void board_override_fan_control(int fan, int *tmp);
+
 #endif  /* __CROS_EC_THERMAL_H */