grunt: Add power/battery LED support

Replace the current led code with an implementation that uses the new
led_pwm interface. Grunt has a blue LED which we use for power and an
amber LED which we use for battery.

The colours used are documented in update_leds() in led_pwm.c

BUG=b:71902053
BRANCH=none
TEST=manual
Check for the various states:
 * Solid Amber == Charging
 * Solid Blue == Charging (near full)
 * Fast Flash Amber == Charging error or battery not present

Did not test low / critical battery

Change-Id: Ie46075855ab17e6e7301025b62e57db2c596b2a4
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/919765
Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
Reviewed-by: Edward Hill <ecgh@chromium.org>

4 files changed, 58 insertions, 173 deletions

diff --git a/board/grunt/board.c b/board/grunt/board.c
index 2154fc8172..b9f171905c 100644
--- a/board/grunt/board.c
+++ b/board/grunt/board.c
@@ -630,15 +630,6 @@ struct motion_sensor_t motion_sensors[] = {
 
 const unsigned int motion_sensor_count = ARRAY_SIZE(motion_sensors);
 
-static void board_init_leds_off(void)
-{
-	/* Initialize the LEDs off. */
-	/* TODO(sjg): Eventually do something with these LEDs. */
-	pwm_set_duty(PWM_CH_LED1_AMBER, 0);
-	pwm_set_duty(PWM_CH_LED2_BLUE, 0);
-}
-DECLARE_HOOK(HOOK_INIT, board_init_leds_off, HOOK_PRIO_INIT_PWM + 1);
-
 #ifndef TEST_BUILD
 void lid_angle_peripheral_enable(int enable)
 {
diff --git a/board/grunt/board.h b/board/grunt/board.h
index fb3e4e47c0..905f57f850 100644
--- a/board/grunt/board.h
+++ b/board/grunt/board.h
@@ -141,6 +141,22 @@
 /* Thermal */
 #define CONFIG_TEMP_SENSOR_SB_TSI
 
+/* Power and battery LEDs */
+#define CONFIG_LED_COMMON
+#define CONFIG_CMD_LEDTEST
+
+#undef CONFIG_LED_PWM_NEAR_FULL_COLOR
+#undef CONFIG_LED_PWM_CHARGE_ERROR_COLOR
+#undef CONFIG_LED_PWM_SOC_ON_COLOR
+#undef CONFIG_LED_PWM_SOC_SUSPEND_COLOR
+
+#define CONFIG_LED_PWM_NEAR_FULL_COLOR EC_LED_COLOR_BLUE
+#define CONFIG_LED_PWM_CHARGE_ERROR_COLOR EC_LED_COLOR_AMBER
+#define CONFIG_LED_PWM_SOC_ON_COLOR EC_LED_COLOR_BLUE
+#define CONFIG_LED_PWM_SOC_SUSPEND_COLOR EC_LED_COLOR_BLUE
+
+#define CONFIG_LED_PWM_COUNT 1
+
 /* KB backlight driver */
 #define CONFIG_LED_DRIVER_LM3630A
 
diff --git a/board/grunt/build.mk b/board/grunt/build.mk
index ec727e96c0..17edac9b50 100644
--- a/board/grunt/build.mk
+++ b/board/grunt/build.mk
@@ -10,6 +10,6 @@ CHIP:=npcx
 CHIP_FAMILY:=npcx7
 CHIP_VARIANT:=npcx7m6f
 
-board-y=board.o
+board-y=board.o led.o
 board-$(CONFIG_BATTERY_SMART)+=battery.o
 board-$(CONFIG_USB_POWER_DELIVERY)+=usb_pd_policy.o
diff --git a/board/grunt/led.c b/board/grunt/led.c
index 43e35848a0..fc6f427cd2 100644
--- a/board/grunt/led.c
+++ b/board/grunt/led.c
@@ -1,188 +1,66 @@
-/* Copyright 2017 The Chromium OS Authors. All rights reserved.
+/* Copyright 2018 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.
- *
- * Power and battery LED control for Grunt
  */
 
-#include "battery.h"
-#include "charge_state.h"
-#include "chipset.h"
+#include "common.h"
 #include "ec_commands.h"
-#include "extpower.h"
-#include "gpio.h"
-#include "hooks.h"
-#include "host_command.h"
-#include "led_common.h"
+#include "led_pwm.h"
 #include "util.h"
 
-#define BAT_LED_ON 0
-#define BAT_LED_OFF 1
-
-#define PWR_LED_ON 0
-#define PWR_LED_OFF 1
-
-#define CRITICAL_LOW_BATTERY_PERCENTAGE 3
-#define LOW_BATTERY_PERCENTAGE 10
-
-#define LED_TOTAL_4SECS_TICKS 4
-#define LED_TOTAL_2SECS_TICKS 2
-#define LED_ON_1SEC_TICKS 1
-#define LED_ON_2SECS_TICKS 2
-
 const enum ec_led_id supported_led_ids[] = {
-			EC_LED_ID_POWER_LED, 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_GREEN,
-	LED_AMBER,
-	LED_COLOR_COUNT  /* Number of colors, not a color itself */
+/*
+ * We only have a blue and an amber LED, so setting any other colour results in
+ * both LEDs being off.
+ */
+struct pwm_led led_color_map[EC_LED_COLOR_COUNT] = {
+				/* Amber, Blue */
+	[EC_LED_COLOR_RED]    = {   0,   0 },
+	[EC_LED_COLOR_GREEN]  = {   0,   0 },
+	[EC_LED_COLOR_BLUE]   = {   0, 100 },
+	[EC_LED_COLOR_YELLOW] = {   0,   0 },
+	[EC_LED_COLOR_WHITE]  = {   0,   0 },
+	[EC_LED_COLOR_AMBER]  = {  100,  0 },
 };
 
-static int led_set_color_battery(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_AMBER, BAT_LED_OFF);
-		break;
-	case LED_GREEN:
-		gpio_set_level(GPIO_BAT_LED_GREEN, BAT_LED_ON);
-		gpio_set_level(GPIO_BAT_LED_AMBER, BAT_LED_OFF);
-		break;
-	case LED_AMBER:
-		gpio_set_level(GPIO_BAT_LED_GREEN, BAT_LED_OFF);
-		gpio_set_level(GPIO_BAT_LED_AMBER, BAT_LED_ON);
-		break;
-	default:
-		return EC_ERROR_UNKNOWN;
-	}
-	return EC_SUCCESS;
-}
-
-static int led_set_color_power(enum led_color color)
-{
-	switch (color) {
-	case LED_OFF:
-		gpio_set_level(GPIO_PWR_LED_GREEN, PWR_LED_OFF);
-		break;
-	case LED_GREEN:
-		gpio_set_level(GPIO_PWR_LED_GREEN, PWR_LED_ON);
-		break;
-	default:
-		return EC_ERROR_UNKNOWN;
-	}
-	return EC_SUCCESS;
-}
+/* One logical LED with amber and blue channels. */
+struct pwm_led pwm_leds[CONFIG_LED_PWM_COUNT] = {
+	{
+		PWM_CH_LED1_AMBER,
+		PWM_CH_LED2_BLUE,
+		PWM_LED_NO_CHANNEL,
+	},
+};
 
 void led_get_brightness_range(enum ec_led_id led_id, uint8_t *brightness_range)
 {
-	brightness_range[EC_LED_COLOR_GREEN] = 1;
-	brightness_range[EC_LED_COLOR_AMBER] = 1;
+	memset(brightness_range, '\0',
+	       sizeof(*brightness_range) * EC_LED_COLOR_COUNT);
+	brightness_range[EC_LED_COLOR_AMBER] = 100;
+	brightness_range[EC_LED_COLOR_BLUE] = 100;
 }
 
-static int led_set_color(enum ec_led_id led_id, enum led_color color)
+int led_set_brightness(enum ec_led_id led_id, const uint8_t *brightness)
 {
-	int rv;
+	enum pwm_led_id pwm_id;
 
-	switch (led_id) {
-	case EC_LED_ID_BATTERY_LED:
-		rv = led_set_color_battery(color);
-		break;
-	case EC_LED_ID_POWER_LED:
-		rv = led_set_color_power(color);
-		break;
-	default:
+	/* Convert ec_led_id to pwm_led_id. */
+	if (led_id == EC_LED_ID_POWER_LED)
+		pwm_id = PWM_LED0;
+	else
 		return EC_ERROR_UNKNOWN;
-	}
-	return rv;
-}
 
-int led_set_brightness(enum ec_led_id led_id, const uint8_t *brightness)
-{
-	if (brightness[EC_LED_COLOR_GREEN] != 0)
-		led_set_color(led_id, LED_GREEN);
-	else if (brightness[EC_LED_COLOR_AMBER] != 0)
-		led_set_color(led_id, LED_AMBER);
+	if (brightness[EC_LED_COLOR_BLUE])
+		set_pwm_led_color(pwm_id, EC_LED_COLOR_BLUE);
+	else if (brightness[EC_LED_COLOR_AMBER])
+		set_pwm_led_color(pwm_id, EC_LED_COLOR_AMBER);
 	else
-		led_set_color(led_id, LED_OFF);
+		/* Otherwise, the "color" is "off". */
+		set_pwm_led_color(pwm_id, -1);
 
 	return EC_SUCCESS;
 }
-
-static void led_set_battery(void)
-{
-	static int battery_ticks;
-
-	uint32_t chflags = charge_get_flags();
-
-	battery_ticks++;
-
-	switch (charge_get_state()) {
-	case PWR_STATE_CHARGE:
-		led_set_color_battery(LED_AMBER);
-		break;
-	case PWR_STATE_DISCHARGE:
-		led_set_color_battery(LED_OFF);
-		break;
-	case PWR_STATE_ERROR:
-		led_set_color_battery(
-			(battery_ticks % LED_TOTAL_2SECS_TICKS <
-			 LED_ON_1SEC_TICKS) ? LED_AMBER : LED_OFF);
-		break;
-	case PWR_STATE_CHARGE_NEAR_FULL:
-		led_set_color_battery(LED_GREEN);
-		break;
-	case PWR_STATE_IDLE: /* External power connected in IDLE */
-		if (chflags & CHARGE_FLAG_FORCE_IDLE)
-			led_set_color_battery(
-				(battery_ticks % LED_TOTAL_4SECS_TICKS <
-				 LED_ON_2SECS_TICKS) ? LED_AMBER : LED_GREEN);
-		else
-			led_set_color_battery(LED_GREEN);
-		break;
-	default:
-		/* Other states don't alter LED behavior */
-		break;
-	}
-}
-
-static void led_set_power(void)
-{
-	static int suspend_ticks;
-	static int previous_state_suspend;
-
-	suspend_ticks++;
-
-	if (chipset_in_state(CHIPSET_STATE_ANY_SUSPEND)) {
-		if (!previous_state_suspend)
-			suspend_ticks = 0;
-		/* Blink once every four seconds. */
-		led_set_color_battery(
-			(suspend_ticks % LED_TOTAL_4SECS_TICKS)
-			< LED_ON_1SEC_TICKS ?
-			LED_GREEN : LED_OFF);
-		previous_state_suspend = 1;
-		return;
-	}
-
-	previous_state_suspend = 0;
-
-	if (chipset_in_state(CHIPSET_STATE_ON))
-		led_set_color_power(LED_GREEN);
-	else
-		led_set_color_power(LED_OFF);
-}
-
-/* Called by hook task every 1 sec */
-static void led_second(void)
-{
-	if (led_auto_control_is_enabled(EC_LED_ID_BATTERY_LED))
-		led_set_battery();
-	if (led_auto_control_is_enabled(EC_LED_ID_POWER_LED))
-		led_set_power();
-}
-DECLARE_HOOK(HOOK_SECOND, led_second, HOOK_PRIO_DEFAULT);