Standard Power/Charging LED Behavior

Assuming the dut has red/green battery led and a single power led
CONFIG_LED_POLICY_STD implements the chromeos spec:
* power led on in S0
* power led off in S5
* power led pulsing in S3
* battery led amber when charging
* battery led green when fully charged with AC
* battery led off when discharging
* battery led pulsing red when battery error

BUG=chrome-os-partner:35355
TEST=The Charging led behavior should match the cros spec
BRANCH=None

Change-Id: I645a939ecc2d44d73d2f52b295f9c7e8c923f77b
Signed-off-by: Alexandru M Stan <amstan@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/240705
Reviewed-by: Randall Spangler <rspangler@chromium.org>

1 files changed, 185 insertions, 0 deletions

diff --git a/common/led_policy_std.c b/common/led_policy_std.c
new file mode 100644
index 0000000000..2fd159ec49
--- /dev/null
+++ b/common/led_policy_std.c
@@ -0,0 +1,185 @@
+/* Copyright (c) 2015 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.
+ *
+ * Standard Battery LED and Power LED control
+ * This assumes a red/green battery led and a single power led.
+ */
+
+#include "gpio.h"
+#include "hooks.h"
+#include "battery.h"
+#include "charge_state.h"
+#include "chipset.h"
+#include "led_common.h"
+#include "util.h"
+#include "lid_switch.h"
+
+#ifdef CONFIG_LED_BAT_ACTIVE_LOW
+#define BAT_LED_ON 0
+#define BAT_LED_OFF 1
+#else
+#define BAT_LED_ON 1
+#define BAT_LED_OFF 0
+#endif
+
+#ifdef CONFIG_LED_POWER_ACTIVE_LOW
+#define POWER_LED_ON 0
+#define POWER_LED_OFF 1
+#else
+#define POWER_LED_ON 1
+#define POWER_LED_OFF 0
+#endif
+
+const enum ec_led_id supported_led_ids[] = {
+	EC_LED_ID_BATTERY_LED, EC_LED_ID_POWER_LED};
+
+const int supported_led_ids_count = ARRAY_SIZE(supported_led_ids);
+
+enum led_color {
+	LED_OFF = 0,
+	LED_RED,
+	LED_AMBER,
+	LED_GREEN,
+	LED_WHITE,
+	LED_COLOR_COUNT  /* Number of colors, not a color itself */
+};
+
+static int bat_led_set_color(enum led_color color)
+{
+	switch (color) {
+	case LED_OFF:
+		gpio_set_level(GPIO_BAT_LED_GREEN, BAT_LED_OFF);
+		gpio_set_level(GPIO_BAT_LED_RED, BAT_LED_OFF);
+		break;
+	case LED_RED:
+		gpio_set_level(GPIO_BAT_LED_GREEN, BAT_LED_OFF);
+		gpio_set_level(GPIO_BAT_LED_RED, BAT_LED_ON);
+		break;
+	case LED_AMBER:
+		gpio_set_level(GPIO_BAT_LED_GREEN, BAT_LED_ON);
+		gpio_set_level(GPIO_BAT_LED_RED, BAT_LED_ON);
+		break;
+	case LED_GREEN:
+		gpio_set_level(GPIO_BAT_LED_GREEN, BAT_LED_ON);
+		gpio_set_level(GPIO_BAT_LED_RED, BAT_LED_OFF);
+		break;
+	default:
+		return EC_ERROR_UNKNOWN;
+	}
+	return EC_SUCCESS;
+}
+
+static int pwr_led_set_color(enum led_color color)
+{
+	switch (color) {
+	case LED_OFF:
+		gpio_set_level(GPIO_POWER_LED, POWER_LED_OFF);
+		break;
+	case LED_WHITE:
+		gpio_set_level(GPIO_POWER_LED,
+			       lid_is_open() ? POWER_LED_ON : POWER_LED_OFF);
+		break;
+	default:
+		return EC_ERROR_UNKNOWN;
+	}
+	return EC_SUCCESS;
+}
+
+void led_get_brightness_range(enum ec_led_id led_id, uint8_t *brightness_range)
+{
+	/* Ignoring led_id as both leds support the same colors */
+	brightness_range[EC_LED_COLOR_BLUE] = 1;
+	brightness_range[EC_LED_COLOR_YELLOW] = 1;
+}
+
+int led_set_brightness(enum ec_led_id led_id, const uint8_t *brightness)
+{
+	switch (led_id) {
+	case EC_LED_ID_BATTERY_LED:
+		gpio_set_level(GPIO_BAT_LED_RED,
+			       (brightness[EC_LED_COLOR_RED] != 0) ?
+					BAT_LED_ON : BAT_LED_OFF);
+		gpio_set_level(GPIO_BAT_LED_GREEN,
+			       (brightness[EC_LED_COLOR_GREEN] != 0) ?
+					BAT_LED_ON : BAT_LED_OFF);
+		break;
+	case EC_LED_ID_POWER_LED:
+		gpio_set_level(GPIO_POWER_LED,
+			       (brightness[EC_LED_COLOR_WHITE] != 0) ?
+					POWER_LED_ON : POWER_LED_OFF);
+		break;
+	default:
+		return EC_ERROR_UNKNOWN;
+	}
+	return EC_SUCCESS;
+}
+
+static void std_led_set_power(void)
+{
+	static int power_second;
+
+	power_second++;
+
+	if (chipset_in_state(CHIPSET_STATE_ANY_OFF))
+		pwr_led_set_color(LED_OFF);
+	else if (chipset_in_state(CHIPSET_STATE_ON))
+		pwr_led_set_color(LED_WHITE);
+	else if (chipset_in_state(CHIPSET_STATE_SUSPEND))
+		pwr_led_set_color((power_second & 3) ? LED_OFF : LED_WHITE);
+}
+
+static void std_led_set_battery(void)
+{
+	static int battery_second;
+	uint32_t chflags = charge_get_flags();
+
+	battery_second++;
+
+	/* BAT LED behavior:
+	 * Same as the chromeos spec
+	 * Green/Amber for CHARGE_FLAG_FORCE_IDLE
+	 */
+	switch (charge_get_state()) {
+	case PWR_STATE_CHARGE:
+		bat_led_set_color(LED_AMBER);
+		break;
+	case PWR_STATE_DISCHARGE:
+		if (charge_get_percent() < 3)
+			bat_led_set_color((battery_second & 1)
+					? LED_OFF : LED_AMBER);
+		else if (charge_get_percent() < 10)
+			bat_led_set_color((battery_second & 3)
+					? LED_OFF : LED_AMBER);
+		else
+			bat_led_set_color(LED_OFF);
+		break;
+	case PWR_STATE_ERROR:
+		bat_led_set_color((battery_second & 1) ? LED_OFF : LED_RED);
+		break;
+	case PWR_STATE_CHARGE_NEAR_FULL:
+		bat_led_set_color(LED_GREEN);
+		break;
+	case PWR_STATE_IDLE: /* External power connected in IDLE. */
+		if (chflags & CHARGE_FLAG_FORCE_IDLE)
+			bat_led_set_color(
+				(battery_second & 0x2) ? LED_GREEN : LED_AMBER);
+		else
+			bat_led_set_color(LED_GREEN);
+		break;
+	default:
+		/* Other states don't alter LED behavior */
+		break;
+	}
+}
+
+/**  * Called by hook task every 1 sec  */
+static void led_second(void)
+{
+	if (led_auto_control_is_enabled(EC_LED_ID_POWER_LED))
+		std_led_set_power();
+	if (led_auto_control_is_enabled(EC_LED_ID_BATTERY_LED))
+		std_led_set_battery();
+}
+DECLARE_HOOK(HOOK_SECOND, led_second, HOOK_PRIO_DEFAULT);
+