malefor: define led behavior

Malefor uses two types LED, battery LED and power led. Battery LED uses
dual-color LED, green and red. Power LED uses monochrome LED, white.

Malefor controls battery LED and power LED with GPIO method and remove
unused malefor PWM channels.

BUG=b:154447182
BRANCH=none
TEST=battery led and power led behavior fit the reference design.
https://chromeos.google.com/partner/dlm/docs/reference-designs
/volteer/volteer_clamshell.html#led-behavior

Signed-off-by: xiong.huang <xiong.huang@bitland.corp-partner.google.com>
Change-Id: I272ae8a243b72c4c37b5bb3bd8e96dc57c1ace7e
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2157333
Reviewed-by: Keith Short <keithshort@chromium.org>

4 files changed, 96 insertions, 100 deletions

diff --git a/board/malefor/board.c b/board/malefor/board.c
index 0b382469c5..9d4088d0c0 100644
--- a/board/malefor/board.c
+++ b/board/malefor/board.c
@@ -38,7 +38,11 @@ static void board_init(void)
 	/* Enable gpio interrupt for camera vsync */
 	gpio_enable_interrupt(GPIO_EC_CAM_VSYN_SLP_S0IX);
 
-	/* Illuminate motherboard and daughter board LEDs equally to start. */
+	/*
+	 * TODO: b/154447182 - Malefor will control power LED and battery LED
+	 * independently, and keep the max brightness of power LED and battery
+	 * LED as 50%.
+	 */
 	pwm_enable(PWM_CH_LED4_SIDESEL, 1);
 	pwm_set_duty(PWM_CH_LED4_SIDESEL, 50);
 }
@@ -279,21 +283,6 @@ const unsigned int i2c_ports_used = ARRAY_SIZE(i2c_ports);
 /******************************************************************************/
 /* PWM configuration */
 const struct pwm_t pwm_channels[] = {
-	[PWM_CH_LED1_BLUE] = {
-		.channel = 2,
-		.flags = PWM_CONFIG_ACTIVE_LOW | PWM_CONFIG_DSLEEP,
-		.freq = 2400,
-	},
-	[PWM_CH_LED2_GREEN] = {
-		.channel = 0,
-		.flags = PWM_CONFIG_ACTIVE_LOW | PWM_CONFIG_DSLEEP,
-		.freq = 2400,
-	},
-	[PWM_CH_LED3_RED] = {
-		.channel = 1,
-		.flags = PWM_CONFIG_ACTIVE_LOW | PWM_CONFIG_DSLEEP,
-		.freq = 2400,
-	},
 	[PWM_CH_LED4_SIDESEL] = {
 		.channel = 7,
 		.flags = PWM_CONFIG_ACTIVE_LOW | PWM_CONFIG_DSLEEP,
diff --git a/board/malefor/board.h b/board/malefor/board.h
index 0a675ba3b5..4b30fdc1d5 100644
--- a/board/malefor/board.h
+++ b/board/malefor/board.h
@@ -20,9 +20,8 @@
 #define CONFIG_UART_TX_BUF_SIZE 4096
 
 /* LED defines */
-#define CONFIG_LED_PWM
-/* Although there are 2 LEDs, they are both controlled by the same lines. */
-#define CONFIG_LED_PWM_COUNT 1
+#define CONFIG_LED_POWER_LED
+#define CONFIG_LED_ONOFF_STATES
 
 /* Keyboard features */
 
@@ -127,10 +126,7 @@ enum battery_type {
 };
 
 enum pwm_channel {
-	PWM_CH_LED1_BLUE = 0,
-	PWM_CH_LED2_GREEN,
-	PWM_CH_LED3_RED,
-	PWM_CH_LED4_SIDESEL,
+	PWM_CH_LED4_SIDESEL = 0,
 	PWM_CH_FAN,
 	PWM_CH_KBLIGHT,
 	PWM_CH_COUNT
diff --git a/board/malefor/gpio.inc b/board/malefor/gpio.inc
index 67dc3553e1..21a059bf0a 100644
--- a/board/malefor/gpio.inc
+++ b/board/malefor/gpio.inc
@@ -131,6 +131,11 @@ GPIO(EC_BATT_PRES_ODL, 		PIN(E, 1), GPIO_INPUT)
 GPIO(USB_C0_DP_HPD,		PIN(F, 3), GPIO_INPUT)
 GPIO(USB_C1_DP_HPD,		PIN(7, 0), GPIO_INPUT)
 
+/* LED */
+GPIO(LED_1_L,	 PIN(C, 4), GPIO_OUT_HIGH)	/* Battery - Green LED */
+GPIO(LED_2_L,	 PIN(C, 3), GPIO_OUT_HIGH)	/* Battery - Red LED */
+GPIO(LED_3_L,	 PIN(C, 2), GPIO_OUT_HIGH)	/* Power - White LED */
+
 /* Alternate functions GPIO definitions */
 ALTERNATE(PIN_MASK(B, BIT(5) | BIT(4)), 0, MODULE_I2C, (GPIO_INPUT | GPIO_SEL_1P8V)) /* I2C0 */
 ALTERNATE(PIN_MASK(9, BIT(0) | BIT(2) | BIT(1)), 0, MODULE_I2C, 0)                   /* I2C1 SCL / I2C2 */
@@ -143,7 +148,6 @@ ALTERNATE(PIN_MASK(B, BIT(3) | BIT(2)), 0, MODULE_I2C, 0)
  * board, to be controlled by LED_{1,2,3}_L. PWM allows driving both modules at
  * the same time. */
 ALTERNATE(PIN_MASK(6, BIT(0)), 0, MODULE_PWM, 0)                                     /* LED_SIDESEL_4_L */
-ALTERNATE(PIN_MASK(C, BIT(2) | BIT(3) | BIT(4)), 0, MODULE_PWM, 0)                   /* LED_{3,2,1}_L */
 
 /* Fan signals */
 GPIO(EN_PP5000_FAN,            PIN(6, 1), GPIO_OUT_LOW)
diff --git a/board/malefor/led.c b/board/malefor/led.c
index cdc847bf13..6f4e781404 100644
--- a/board/malefor/led.c
+++ b/board/malefor/led.c
@@ -5,99 +5,106 @@
  * Power and battery LED control for Malefor
  */
 
-#include "charge_manager.h"
 #include "common.h"
-#include "ec_commands.h"
-#include "hooks.h"
+#include "led_onoff_states.h"
 #include "led_common.h"
-#include "led_pwm.h"
-#include "pwm.h"
+#include "gpio.h"
 
-const enum ec_led_id supported_led_ids[] = {
-	EC_LED_ID_POWER_LED,
+#define LED_OFF_LVL	1
+#define LED_ON_LVL	0
+
+const int led_charge_lvl_1 = 5;
+
+const int led_charge_lvl_2 = 97;
+
+struct led_descriptor led_bat_state_table[LED_NUM_STATES][LED_NUM_PHASES] = {
+	[STATE_CHARGING_LVL_1]	     = {{EC_LED_COLOR_RED,   LED_INDEFINITE} },
+	[STATE_CHARGING_LVL_2]	     = {{EC_LED_COLOR_AMBER, LED_INDEFINITE} },
+	[STATE_CHARGING_FULL_CHARGE] = {{EC_LED_COLOR_GREEN, LED_INDEFINITE} },
+	[STATE_DISCHARGE_S0]	     = {{LED_OFF,            LED_INDEFINITE} },
+	[STATE_DISCHARGE_S3]	     = {{LED_OFF,            LED_INDEFINITE} },
+	[STATE_DISCHARGE_S5]         = {{LED_OFF,            LED_INDEFINITE} },
+	[STATE_BATTERY_ERROR]        = {{EC_LED_COLOR_RED,   1 * LED_ONE_SEC},
+					{LED_OFF,	     1 * LED_ONE_SEC} },
+	[STATE_FACTORY_TEST]         = {{EC_LED_COLOR_RED,   2 * LED_ONE_SEC},
+					{EC_LED_COLOR_GREEN, 2 * LED_ONE_SEC} },
 };
-const int supported_led_ids_count = ARRAY_SIZE(supported_led_ids);
 
-struct pwm_led led_color_map[] = {
-				/* Red, Green, Blue */
-	[EC_LED_COLOR_RED] =    {  100,   0,     0 },
-	[EC_LED_COLOR_GREEN] =  {    0, 100,     0 },
-	[EC_LED_COLOR_BLUE] =   {    0,   0,   100 },
-	/* The green LED seems to be brighter than the others, so turn down
-	 * green from its natural level for these secondary colors.
-	 */
-	[EC_LED_COLOR_YELLOW] = {  100,  70,     0 },
-	[EC_LED_COLOR_WHITE] =  {  100,  70,   100 },
-	[EC_LED_COLOR_AMBER] =  {  100,  20,     0 },
+const struct led_descriptor
+		led_pwr_state_table[PWR_LED_NUM_STATES][LED_NUM_PHASES] = {
+	[PWR_LED_STATE_ON]            = {{EC_LED_COLOR_WHITE, LED_INDEFINITE} },
+	[PWR_LED_STATE_SUSPEND_AC]    = {{EC_LED_COLOR_WHITE, 3 * LED_ONE_SEC},
+					 {LED_OFF,         0.5 * LED_ONE_SEC} },
+	[PWR_LED_STATE_SUSPEND_NO_AC] = {{LED_OFF,            LED_INDEFINITE} },
+	[PWR_LED_STATE_OFF]           = {{LED_OFF,            LED_INDEFINITE} },
 };
 
-struct pwm_led pwm_leds[] = {
-	/* 2 RGB diffusers controlled by 1 set of 3 channels. */
-	[PWM_LED0] = {
-		.ch0 = PWM_CH_LED3_RED,
-		.ch1 = PWM_CH_LED2_GREEN,
-		.ch2 = PWM_CH_LED1_BLUE,
-		.enable = &pwm_enable,
-		.set_duty = &pwm_set_duty,
-	},
+const enum ec_led_id supported_led_ids[] = {
+	EC_LED_ID_BATTERY_LED,
+	EC_LED_ID_POWER_LED
 };
 
-void led_get_brightness_range(enum ec_led_id led_id, uint8_t *brightness_range)
-{
-	brightness_range[EC_LED_COLOR_RED] = 255;
-	brightness_range[EC_LED_COLOR_GREEN] = 255;
-	brightness_range[EC_LED_COLOR_BLUE] = 255;
-}
+const int supported_led_ids_count = ARRAY_SIZE(supported_led_ids);
 
-int led_set_brightness(enum ec_led_id led_id, const uint8_t *brightness)
+void led_set_color_power(enum ec_led_colors color)
 {
-	enum pwm_led_id pwm_id;
-
-	/* Convert ec_led_id to pwm_led_id. */
-	if (led_id == EC_LED_ID_POWER_LED)
-		pwm_id = PWM_LED0;
+	if (color == EC_LED_COLOR_WHITE)
+		gpio_set_level(GPIO_LED_3_L, LED_ON_LVL);
 	else
-		return EC_ERROR_UNKNOWN;
-
-	if (brightness[EC_LED_COLOR_RED])
-		set_pwm_led_color(pwm_id, EC_LED_COLOR_RED);
-	else if (brightness[EC_LED_COLOR_GREEN])
-		set_pwm_led_color(pwm_id, EC_LED_COLOR_GREEN);
-	else if (brightness[EC_LED_COLOR_BLUE])
-		set_pwm_led_color(pwm_id, EC_LED_COLOR_BLUE);
-	else if (brightness[EC_LED_COLOR_YELLOW])
-		set_pwm_led_color(pwm_id, EC_LED_COLOR_YELLOW);
-	else if (brightness[EC_LED_COLOR_WHITE])
-		set_pwm_led_color(pwm_id, EC_LED_COLOR_WHITE);
-	else if (brightness[EC_LED_COLOR_AMBER])
-		set_pwm_led_color(pwm_id, EC_LED_COLOR_AMBER);
-	else
-		/* Otherwise, the "color" is "off". */
-		set_pwm_led_color(pwm_id, -1);
-
-	return EC_SUCCESS;
+		/* LED_OFF and unsupported colors */
+		gpio_set_level(GPIO_LED_3_L, LED_OFF_LVL);
 }
 
-/* Illuminates the LED on the side of the active charging port. If not charging,
- * illuminates both LEDs.
- */
-static void led_set_charge_port_tick(void)
+void led_set_color_battery(enum ec_led_colors color)
 {
-	int port;
-	int side_select_duty;
-
-	port = charge_manager_get_active_charge_port();
-	switch (port) {
-	case 0:
-		side_select_duty = 100;
+	switch (color) {
+	case EC_LED_COLOR_RED:
+		gpio_set_level(GPIO_LED_1_L, LED_OFF_LVL);
+		gpio_set_level(GPIO_LED_2_L, LED_ON_LVL);
+		break;
+	case EC_LED_COLOR_AMBER:
+		gpio_set_level(GPIO_LED_1_L, LED_ON_LVL);
+		gpio_set_level(GPIO_LED_2_L, LED_ON_LVL);
+		break;
+	case EC_LED_COLOR_GREEN:
+		gpio_set_level(GPIO_LED_1_L, LED_ON_LVL);
+		gpio_set_level(GPIO_LED_2_L, LED_OFF_LVL);
 		break;
-	case 1:
-		side_select_duty = 0;
+	default: /* LED_OFF and other unsupported colors */
+		gpio_set_level(GPIO_LED_1_L, LED_OFF_LVL);
+		gpio_set_level(GPIO_LED_2_L, LED_OFF_LVL);
 		break;
-	default:
-		side_select_duty = 50;
 	}
+}
 
-	pwm_set_duty(PWM_CH_LED4_SIDESEL, side_select_duty);
+void led_get_brightness_range(enum ec_led_id led_id, uint8_t *brightness_range)
+{
+	if (led_id == EC_LED_ID_BATTERY_LED) {
+		brightness_range[EC_LED_COLOR_RED] = 1;
+		brightness_range[EC_LED_COLOR_AMBER] = 1;
+		brightness_range[EC_LED_COLOR_GREEN] = 1;
+	} else if (led_id == EC_LED_ID_POWER_LED) {
+		brightness_range[EC_LED_COLOR_WHITE] = 1;
+	}
+}
+
+int led_set_brightness(enum ec_led_id led_id, const uint8_t *brightness)
+{
+	if (led_id == EC_LED_ID_BATTERY_LED) {
+		if (brightness[EC_LED_COLOR_RED] != 0)
+			led_set_color_battery(EC_LED_COLOR_RED);
+		else if (brightness[EC_LED_COLOR_AMBER] != 0)
+			led_set_color_battery(EC_LED_COLOR_AMBER);
+		else if (brightness[EC_LED_COLOR_GREEN] != 0)
+			led_set_color_battery(EC_LED_COLOR_GREEN);
+		else
+			led_set_color_battery(LED_OFF);
+	} else if (led_id == EC_LED_ID_POWER_LED) {
+		if (brightness[EC_LED_COLOR_WHITE] != 0)
+			led_set_color_power(EC_LED_COLOR_WHITE);
+		else
+			led_set_color_power(LED_OFF);
+	}
+
+	return EC_SUCCESS;
 }
-DECLARE_HOOK(HOOK_TICK, led_set_charge_port_tick, HOOK_PRIO_DEFAULT);