marigold: add customize battery cmd for GRL

for GRL verify add customize battery cmd 0x4F
byte[0] = reg, 0x0 for batt cap, 0x1 for batt status

Change-Id: Ia4e4c8fbf60a7f280c8539b7f7e2c8ac18bdc160
Signed-off-by: LeoCX_Tsai <LeoCX_Tsai@compal.com>

Author: LeoCX-Tsai

zephyr/program/framework/Kconfig

@@ -96,12 +96,28 @@ config PD_CCG6_WAIT_STABLE_TIMER
 	    EC should wait X ms the PD chip run in stable mode then start to
 		communicate.
 
+config PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+	bool "Enable CCG6 Customize battery response"
+	default n
+	depends on PD_CHIP_CCG6
+	help
+	    Enable customize battery response for GRL test, EC will write specific
+		register 0x4f to PD for GET_BATTERY_CAP and GET_BATTERY_STATUS.
+
 config PD_COMMON_VBUS_CONTROL
 	bool "Enable CCG common vbus control"
 	help
 		Enable Cypress CCG common vbus control, if not enable please modify
 		board_set_active_charge_port at board for customize vbus control.
 
+config PD_COMMON_EXTENDED_MESSAGE
+	bool "Enable CCG common extended message"
+	default n
+	help
+		Enable Cypress CCG common extended message, if we need send message to PD
+		please add the response for extended message.
+		ex: get battery status or capability.
+
 config PLATFORM_SIMPLE_VERSION_SHIFT_IDX
 	int "Shift idx for return commit id to BIOS"
 	default 18

zephyr/program/framework/include/cypress_pd_common.h

@@ -20,6 +20,9 @@
 #define CCG_I2C_CHIP1	0x40
 #endif
 
+#define PRODUCT_ID	CONFIG_PD_USB_PID
+#define VENDOR_ID	0x32ac
+
 #define BB_PWR_DOWN_TIMEOUT (4000*MSEC)
 
 /*
@@ -57,6 +60,9 @@
 #define CCG_DPM_CMD_REG			0x004C
 #define CCG_MUX_CFG_REG			0x004D
 #define CCG_DEINIT_PORT_REG		0x004E
+#ifdef CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+#define CCG_BATTERT_STATE		0x004F
+#endif /* CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE */
 #endif
 #define CCG_ICL_STS_REG			0x0042
 #define CCG_ICL_BB_RETIMER_CMD_REG	0x0046
@@ -225,6 +231,13 @@
 #ifdef CONFIG_PD_CHIP_CCG6
 #define CCG6_AC_AT_PORT				0xC4
 #define CCG_ICL_CTRL_REG	0x0040
+
+#ifdef CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+#define CCG6_BATT_IS_PRESENT		BIT(1)
+#define CCG6_BATT_IS_DISCHARGING	BIT(2)
+#define CCG6_BATT_IS_IDLE			BIT(3)
+#endif /* CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE */
+
 #endif
 
 /************************************************/
@@ -526,6 +539,30 @@ struct pd_chip_ucsi_info_t {
 	int wait_ack;
 };
 
+#ifdef CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+
+/**
+ * follow CCG6 vendor Format
+ * byte[0] - reg, 0x0 = batt_cap, 0x01 = batt_status.
+ * ohters byte follow PD Spec format
+ */
+struct pd_battery_cap_t {
+	uint8_t  reg;
+	uint16_t vid;
+	uint16_t pid;
+	uint16_t design_cap;
+	uint16_t last_full_cap;
+	uint8_t	 battery_type;
+} __packed;
+
+struct pd_battery_status_t {
+	uint8_t reg;
+	uint8_t reserved;
+	uint8_t battery_info;
+	uint16_t batt_present_cap;
+} __packed;
+#endif /* CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE */
+
 /**
  * extern struct for ccg6 or ccg8 use.
  */
@@ -543,6 +580,7 @@ extern struct pd_port_current_state_t pd_port_states[];
  */
 int cypd_write_reg8(int controller, int reg, int data);
 int cypd_write_reg16(int controller, int reg, int data);
+int cypd_write8_reg_block(int controller, int reg, void *data, int len);
 int cypd_write_reg_block(int controller, int reg, void *data, int len);
 
 /**
@@ -679,6 +717,19 @@ int cypd_reconnect_port_enable(int controller);
 void cypd_reconnect(void);
 
 #endif /* CONFIG_PD_CCG6_ERROR_RECOVERY */
+
+#ifdef CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+/**
+ * Set battery_cap info to PD
+ */
+void cypd_customize_battery_cap(void);
+
+/**
+ * Set battery_status info to PD
+ */
+void cypd_customize_battery_status(void);
+#endif /* CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE */
+
 #endif /* CONFIG_PD_CHIP_CCG6 */
 
 /**

zephyr/program/framework/marigold/project.conf

@@ -38,6 +38,7 @@ CONFIG_THIRD_PARTY_CUSTOMIZED_DESIGN=y
 CONFIG_CHIPSET_INTEL=y
 CONFIG_PD_CHIP_CCG6=y
 CONFIG_PD_CCG6_WAIT_STABLE_TIMER=415
+CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE=y
 
 # PECI
 CONFIG_PECI=y

zephyr/program/framework/src/cypd_ccg6.c

@@ -552,3 +552,142 @@ int check_tbt_mode(int controller)
 
 	return data;
 }
+
+#ifdef CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+/*****************************************************************
+ * Customize response battery status
+ ****************************************************************/
+
+static struct pd_battery_cap_t pd_battery_cap;
+static struct pd_battery_status_t pd_battery_status;
+static int pd_batt_soc;
+bool cypd_batt_update;
+
+void cypd_customize_battery_cap(void)
+{
+	int i;
+	uint32_t c, v;
+	bool battery_can_discharge = (battery_is_present() == BP_YES) &
+		battery_get_disconnect_state();
+
+	/* only send status when PD ready */
+	if (!(pd_chip_config[0].state == CCG_STATE_READY &&
+		pd_chip_config[1].state == CCG_STATE_READY)) {
+		return;
+	}
+
+	if (!battery_can_discharge) {
+		cypd_batt_update = false;
+		pd_battery_cap.design_cap = 0x0000;
+		pd_battery_cap.last_full_cap = 0x0000;
+		pd_battery_cap.battery_type = 0x1;
+
+	} else {
+		cypd_batt_update = true;
+		pd_battery_cap.reg = 0;
+		pd_battery_cap.vid = VENDOR_ID;
+		pd_battery_cap.pid = PRODUCT_ID;
+		pd_battery_cap.battery_type = 0x0;
+
+		if (battery_design_voltage(&v) == 0) {
+			if (battery_design_capacity(&c) == 0) {
+				/*
+				 * Wh = (c * v) / 1000000
+				 * 10th of a Wh = Wh * 10
+				 */
+				pd_battery_cap.design_cap = DIV_ROUND_NEAREST((c * v),
+							100000);
+			}
+			if (battery_full_charge_capacity(&c) == 0) {
+				/*
+				 * Wh = (c * v) / 1000000
+				 * 10th of a Wh = Wh * 10
+				 */
+				pd_battery_cap.last_full_cap = DIV_ROUND_NEAREST((c * v),
+							100000);
+			}
+		}
+	}
+
+	for (i = 0; i < PD_CHIP_COUNT; i++)
+		cypd_write8_reg_block(i, CCG_BATTERT_STATE,
+				&pd_battery_cap, sizeof(pd_battery_cap));
+
+}
+
+void cypd_customize_battery_status(void)
+{
+	int i, soc_wh;
+	uint8_t	batt_info;
+	uint32_t c, v;
+	struct batt_params batt;
+	bool battery_can_discharge = (battery_is_present() == BP_YES) &
+		battery_get_disconnect_state();
+
+	battery_get_params(&batt);
+
+	/* only send status when PD ready */
+	if (!(pd_chip_config[0].state == CCG_STATE_READY &&
+		pd_chip_config[1].state == CCG_STATE_READY)) {
+		return;
+	}
+
+	/* only update data when soc change */
+	if (batt.state_of_charge == pd_batt_soc)
+		return;
+
+	pd_batt_soc = batt.state_of_charge;
+
+	if (!battery_can_discharge) {
+
+		pd_battery_status.reg = 0x1;
+		pd_battery_status.battery_info = 0;
+		pd_battery_status.batt_present_cap = 0xFFFF;
+
+	} else {
+
+		/**
+		 * if battery didn't set cap info at first time pd init
+		 * need set again when battery ready.
+		 * ex: resume from dead battery, or ac only boot and then plug-in batt
+		 */
+		if (!cypd_batt_update)
+			cypd_customize_battery_cap();
+
+		if (battery_design_voltage(&v) == 0) {
+			if (battery_remaining_capacity(&c) == 0) {
+				/*
+				 * Wh = (c * v) / 1000000
+				 * 10th of a Wh = Wh * 10
+				 */
+				soc_wh = DIV_ROUND_NEAREST((c * v), 100000);
+			}
+		}
+
+		if (battery_status(&c) != 0) {
+			batt_info = 0; /* batt not present */
+		} else {
+			if (c & STATUS_FULLY_CHARGED)
+				/* Fully charged */
+				batt_info = CCG6_BATT_IS_IDLE | CCG6_BATT_IS_PRESENT;
+			else if (c & STATUS_DISCHARGING)
+				/* Discharging */
+				batt_info = CCG6_BATT_IS_DISCHARGING | CCG6_BATT_IS_PRESENT;
+			else
+				/* else battery is charging.*/
+				batt_info = CCG6_BATT_IS_PRESENT;
+		}
+
+		pd_battery_status.reg = 0x1;
+		pd_battery_status.battery_info = batt_info;
+		pd_battery_status.batt_present_cap = soc_wh;
+	}
+
+	for (i = 0; i < PD_CHIP_COUNT; i++)
+		cypd_write8_reg_block(i, CCG_BATTERT_STATE,
+				&pd_battery_status, sizeof(pd_battery_status));
+
+}
+DECLARE_HOOK(HOOK_AC_CHANGE, cypd_customize_battery_status, HOOK_PRIO_DEFAULT);
+DECLARE_HOOK(HOOK_BATTERY_SOC_CHANGE, cypd_customize_battery_status, HOOK_PRIO_DEFAULT);
+#endif /* CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE */

zephyr/program/framework/src/cypress_pd_common.c

@@ -37,10 +37,6 @@
 #define CPRINTS(format, args...) cprints(CC_USBCHARGE, format, ##args)
 #define CPRINTF(format, args...) cprintf(CC_USBCHARGE, format, ##args)
 
-
-#define PRODUCT_ID	CONFIG_PD_USB_PID
-#define VENDOR_ID	0x32ac
-
 #undef CCG_INIT_STATE
 #ifdef CONFIG_PD_CHIP_CCG6
 #define CCG_INIT_STATE CCG_STATE_WAIT_STABLE
@@ -116,6 +112,18 @@ int cypd_write_reg_block(int controller, int reg, void *data, int len)
 	return rv;
 }
 
+int cypd_write8_reg_block(int controller, int reg, void *data, int len)
+{
+	int rv;
+	uint16_t i2c_port = pd_chip_config[controller].i2c_port;
+	uint16_t addr_flags = pd_chip_config[controller].addr_flags;
+
+	rv = i2c_write_block(i2c_port, addr_flags, reg, data, len);
+	if (rv != EC_SUCCESS)
+		CPRINTS("%s failed: ctrl=0x%x, reg=0x%02x", __func__, controller, reg);
+	return rv;
+}
+
 int cypd_write_reg16(int controller, int reg, int data)
 {
 	int rv;
@@ -687,6 +695,7 @@ static void cypd_ppm_port_clear(void)
 	hook_call_deferred(&pdo_init_deferred_data, 1);
 }
 
+#ifdef CONFIG_PD_COMMON_EXTENDED_MESSAGE
 /*
  * send a message using DM_CONTROL to port partner
  * pd_header is using chromium PD header with upper bits defining SOP type
@@ -745,6 +754,7 @@ void cypd_send_msg(int controller, int port, uint32_t pd_header, uint16_t ext_hd
 	cypd_write_reg16(controller, CCG_DM_CONTROL_REG(port), dm_control_data);
 }
 
+
 void cypd_response_get_battery_capability(int controller, int port,
 	uint32_t pd_header, enum tcpci_msg_type sop_type)
 {
@@ -942,6 +952,7 @@ int cypd_handle_extend_msg(int controller, int port, int len, enum tcpci_msg_typ
 
 	return rv;
 }
+#endif
 
 static void clear_port_state(int controller, int port)
 {
@@ -1194,6 +1205,15 @@ __overridable void cypd_customize_app_setup(int controller)
 	 */
 }
 
+#ifdef CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+static void pd_batt_init_deferred(void)
+{
+	cypd_customize_battery_cap();
+	cypd_customize_battery_status();
+}
+DECLARE_DEFERRED(pd_batt_init_deferred);
+#endif /* CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE */
+
 static void cypd_handle_state(int controller)
 {
 	int data;
@@ -1259,8 +1279,12 @@ static void cypd_handle_state(int controller)
 			gpio_enable_interrupt(pd_chip_config[controller].gpio);
 
 			/* Update PDO format after init complete */
-			if (controller)
+			if (controller) {
+#ifdef CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE
+				hook_call_deferred(&pd_batt_init_deferred_data, 100 * MSEC);
+#endif /* CONFIG_PD_CCG6_CUSTOMIZE_BATT_MESSAGE */
 				hook_call_deferred(&pdo_init_deferred_data, 25 * MSEC);
+			}
 
 			CPRINTS("CYPD %d Ready!", controller);
 			pd_chip_config[controller].state = CCG_STATE_READY;
@@ -1629,8 +1653,10 @@ void cypd_port_int(int controller, int port)
 			sop_type = TCPCI_MSG_SOP_PRIME;
 		else if (data2[0] == CCG_RESPONSE_EXT_MSG_SOP_RX)
 			sop_type = TCPCI_MSG_SOP_PRIME_PRIME;
+#ifdef CONFIG_PD_COMMON_EXTENDED_MESSAGE
 		cypd_handle_extend_msg(controller, port, response_len, sop_type);
 		CPRINTS("CYP_RESPONSE_RX_EXT_MSG");
+#endif /* CONFIG_PD_COMMON_EXTENDED_MESSAGE */
 		break;
 	case CCG_RESPONSE_VDM_RX:
 		i2c_read_offset16_block(i2c_port, addr_flags,