chgstv2: Add battery sustainer

This patch adds the battery sustainer. Given a target SoC by the host,
the sustainer will try to keep the SoC stay close within the range
near the target.

The diagram below shows how the sustainer uses the charge mode to
charge or discharge the battery as the SoC moves near the target:

                   T-d%                    T%
          ----------|----------------------|-----------
   charge normally   charge normally/slowly
    (mode=NORMAL)
          ... ----> +--------------------->
                    |                      |
                    <----------------------+ <----- ...
                      discharge naturally    discharge normally
		            (mode=IDLE)       (mode=DISCHARGE)

When AC is unplugged, the sustainer is disabled. Currently, the
sustainer requires CONFIG_CHARGER_DISCHARGE_ON_AC.

> chgstate
state_of_charge = 69%
chg_ctl_mode = NORMAL
manual_voltage = -1
manual_current = -1
Battery sustainer = off (-1% ~ -1%)

> chgstate sustain 70 72
state_of_charge = 69%
chg_ctl_mode = NORMAL
manual_voltage = -1
manual_current = -1
Battery sustainer = on (70% ~ 72%)

> battfake 71
> chgstate
state_of_charge = 71%
chg_ctl_mode = NORMAL

> battfake 73
> chgstate
state_of_charge = 73%
chg_ctl_mode = DISCHARGE
manual_voltage = -1
manual_current = -1

> battfake 71
> chgstate
state_of_charge = 71%
chg_ctl_mode = IDLE
manual_voltage = 0
manual_current = 0

Unplug AC and EC keeps running.

> chgstate
state_of_charge = 73%
chg_ctl_mode = DISCHARGE
manual_voltage = -1
manual_current = -1

Replug AC.

> chgstate
state_of_charge = 73%
chg_ctl_mode = DISCHARGE
manual_voltage = 0
manual_current = 0

BUG=b:188457962
BRANCH=None
TEST=Atlas. See the description above.

Change-Id: I62b4e8bc9517900a5a32d2f35369c645fa8a60c3
Signed-off-by: Daisuke Nojiri <[email protected]>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2929347
Reviewed-by: Vincent Palatin <[email protected]>

Author: dnojiri

common/charge_state_v2.c

@@ -14,8 +14,9 @@
 #include "chipset.h"
 #include "common.h"
 #include "console.h"
-#include "ec_ec_comm_master.h"
-#include "ec_ec_comm_slave.h"
+#include "ec_commands.h"
+#include "ec_ec_comm_client.h"
+#include "ec_ec_comm_server.h"
 #include "extpower.h"
 #include "gpio.h"
 #include "hooks.h"
@@ -1120,6 +1121,9 @@ static const char * const batt_pres[] = {
 	"NO", "YES", "NOT_SURE",
 };
 
+const char *mode_text[] = EC_CHARGE_MODE_TEXT;
+BUILD_ASSERT(ARRAY_SIZE(mode_text) == CHARGE_CONTROL_COUNT);
+
 static void dump_charge_state(void)
 {
 #define DUMP(FLD, FMT) ccprintf(#FLD " = " FMT "\n", curr.FLD)
@@ -1180,7 +1184,9 @@ static void dump_charge_state(void)
 #ifdef CONFIG_EC_EC_COMM_BATTERY_MASTER
 	DUMP(input_voltage, "%dmV");
 #endif
-	ccprintf("chg_ctl_mode = %d\n", chg_ctl_mode);
+	ccprintf("chg_ctl_mode = %s (%d)\n",
+		 chg_ctl_mode < CHARGE_CONTROL_COUNT
+		 	? mode_text[chg_ctl_mode] : "UNDEF", chg_ctl_mode);
 	ccprintf("manual_voltage = %d\n", manual_voltage);
 	ccprintf("manual_current = %d\n", manual_current);
 	ccprintf("user_current_limit = %dmA\n", user_current_limit);
@@ -1667,41 +1673,47 @@ static int battery_outside_charging_temperature(void)
 }
 #endif
 
-static void sustain_soc_disable(void)
+static void sustain_battery_soc(void)
 {
-	sustain_soc.lower = -1;
-	sustain_soc.upper = -1;
-}
+	enum ec_charge_control_mode mode = chg_ctl_mode;
+	int soc;
+	int rv;
 
-static int sustain_soc_set(int16_t lower, int16_t upper)
-{
-	if (sustain_soc.lower < sustain_soc.upper
-			&& 0 <= sustain_soc.lower && sustain_soc.upper <= 100) {
-		sustain_soc.lower = lower;
-		sustain_soc.upper = upper;
-		return EC_SUCCESS;
-	}
+	/* If either AC or battery is not present, nothing to do. */
+	if (!curr.ac || curr.batt.is_present != BP_YES
+			|| !battery_sustainer_enabled())
+		return;
 
-	CPRINTS("Invalid param: %s(%d, %d)", __func__, lower, upper);
-	return EC_ERROR_INVAL;
-}
+	soc = charge_get_display_charge() / 10;
 
-static bool sustain_soc_enabled(void)
-{
-	return sustain_soc.lower != -1 && sustain_soc.upper != -1;
-}
+	switch (chg_ctl_mode) {
+	case CHARGE_CONTROL_NORMAL:
+		/* Going up */
+		if (sustain_soc.upper < soc)
+			mode = CHARGE_CONTROL_DISCHARGE;
+		break;
+	case CHARGE_CONTROL_IDLE:
+		/* discharging naturally */
+		if (soc < sustain_soc.lower)
+			/* TODO: Charge slowly */
+			mode = CHARGE_CONTROL_NORMAL;
+		break;
+	case CHARGE_CONTROL_DISCHARGE:
+		/* discharging rapidly (discharge_on_ac) */
+		if (soc < sustain_soc.upper)
+			mode = CHARGE_CONTROL_IDLE;
+		break;
+	default:
+		return;
+	}
 
-static void sustain_battery_soc(void)
-{
-	/* If both of AC and battery aren't present, nothing to do. */
-	if (!curr.ac || curr.batt.is_present != BP_YES
-			|| !sustain_soc_enabled())
+	if (mode == chg_ctl_mode)
 		return;
 
-	if (curr.batt.state_of_charge < sustain_soc.lower)
-		set_chg_ctrl_mode(CHARGE_CONTROL_NORMAL);
-	else if (sustain_soc.upper < curr.batt.state_of_charge)
-		set_chg_ctrl_mode(CHARGE_CONTROL_DISCHARGE);
+	rv = set_chg_ctrl_mode(mode);
+	CPRINTS("%s: %s control mode to %s",
+		__func__, rv == EC_SUCCESS ? "Switched" : "Failed to switch",
+		mode_text[mode]);
 }
 
 /*****************************************************************************/
@@ -1720,7 +1732,7 @@ void charger_init(void)
 	 */
 	battery_get_params(&curr.batt);
 
-	sustain_soc_disable();
+	battery_sustainer_disable();
 }
 DECLARE_HOOK(HOOK_INIT, charger_init, HOOK_PRIO_DEFAULT);
 
@@ -1865,7 +1877,7 @@ void charger_task(void *u)
 				}
 			} else {
 				/* Some things are only meaningful on AC */
-				chg_ctl_mode = CHARGE_CONTROL_NORMAL;
+				set_chg_ctrl_mode(CHARGE_CONTROL_NORMAL);
 				battery_seems_to_be_dead = 0;
 				prev_ac = curr.ac;
 			}
@@ -2988,7 +3000,7 @@ static int command_chgstate(int argc, char **argv)
 			upper = strtoi(argv[3], &e, 0);
 			if (*e)
 				return EC_ERROR_PARAM3;
-			rv = sustain_soc_set(lower, upper);
+			rv = battery_sustainer_set(lower, upper);
 			if (rv)
 				return EC_ERROR_INVAL;
 		} else {
@@ -3001,7 +3013,7 @@ static int command_chgstate(int argc, char **argv)
 }
 DECLARE_CONSOLE_COMMAND(chgstate, command_chgstate,
 			"[idle|discharge|debug on|off]"
-			"\n[sustain lower upper]",
+			"\n[sustain <lower> <upper>]",
 			"Get/set charge state machine status");
 
 #ifdef CONFIG_EC_EC_COMM_BATTERY_MASTER