zephyr: drivers: add TCPCI test suite

TCPCI emulator is added in tcpc_config for port 0. In this patch init
and release of driver/tcpm/tcpci.c functions are tested.

BUG=b:184857030
BRANCH=none
TEST=make configure --test zephyr/test/drivers

Signed-off-by: Tomasz Michalec <tm@semihalf.com>
Change-Id: Ie36838c9562d5d1480699b7ab0ae3a04e3485d76
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3205360
Reviewed-by: Yuval Peress <peress@google.com>
Reviewed-by: Abe Levkoy <alevkoy@chromium.org>
Tested-by: Tomasz Michalec <tmichalec@google.com>
Commit-Queue: Tomasz Michalec <tmichalec@google.com>

4 files changed, 172 insertions, 3 deletions

diff --git a/zephyr/test/drivers/overlay.dts b/zephyr/test/drivers/overlay.dts
index 24e6ca53e3..d49973180d 100644
--- a/zephyr/test/drivers/overlay.dts
+++ b/zephyr/test/drivers/overlay.dts
@@ -573,6 +573,13 @@
 		reg = <0x9>;
 		label = "ISL923X_EMUL";
 	};
+
+	tcpci_emul: tcpci_emul@82 {
+		compatible = "cros,tcpci-emul";
+		status = "okay";
+		reg = <0x82>;
+		label = "TCPCI_EMUL";
+	};
 };
 
 /* Enable all thermistors for testing */
diff --git a/zephyr/test/drivers/src/main.c b/zephyr/test/drivers/src/main.c
index 2762ac7726..64e49b7006 100644
--- a/zephyr/test/drivers/src/main.c
+++ b/zephyr/test/drivers/src/main.c
@@ -27,6 +27,7 @@ extern void test_suite_isl923x(void);
 extern void test_suite_usb_mux(void);
 extern void test_suite_ppc_syv682c(void);
 extern void test_suite_cros_cbi(void);
+extern void test_suite_tcpci(void);
 
 void test_main(void)
 {
@@ -55,4 +56,5 @@ void test_main(void)
 	test_suite_usb_mux();
 	test_suite_ppc_syv682c();
 	test_suite_cros_cbi();
+	test_suite_tcpci();
 }
diff --git a/zephyr/test/drivers/src/stubs.c b/zephyr/test/drivers/src/stubs.c
index dc9dc5fd4b..9b4604db5a 100644
--- a/zephyr/test/drivers/src/stubs.c
+++ b/zephyr/test/drivers/src/stubs.c
@@ -17,7 +17,7 @@
 #include "ppc/syv682x_public.h"
 #include "retimer/bb_retimer_public.h"
 #include "stubs.h"
-#include "tcpm/tusb422_public.h"
+#include "tcpm/tcpci.h"
 #include "tcpm/tusb422_public.h"
 #include "usb_mux.h"
 #include "usb_pd_tcpm.h"
@@ -122,9 +122,9 @@ struct tcpc_config_t tcpc_config[] = {
 		.bus_type = EC_BUS_TYPE_I2C,
 		.i2c_info = {
 			.port = I2C_PORT_USB_C0,
-			.addr_flags = TUSB422_I2C_ADDR_FLAGS,
+			.addr_flags = DT_REG_ADDR(DT_NODELABEL(tcpci_emul)),
 		},
-		.drv = &tusb422_tcpm_drv,
+		.drv = &tcpci_tcpm_drv,
 	},
 	[USBC_PORT_C1] = {
 		.bus_type = EC_BUS_TYPE_I2C,
diff --git a/zephyr/test/drivers/src/tcpci.c b/zephyr/test/drivers/src/tcpci.c
new file mode 100644
index 0000000000..97578745cd
--- /dev/null
+++ b/zephyr/test/drivers/src/tcpci.c
@@ -0,0 +1,160 @@
+/* Copyright 2021 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.
+ */
+
+#include <zephyr.h>
+#include <ztest.h>
+#include <drivers/gpio.h>
+#include <drivers/gpio/gpio_emul.h>
+
+#include "common.h"
+#include "ec_tasks.h"
+#include "emul/emul_common_i2c.h"
+#include "emul/emul_tcpci.h"
+#include "hooks.h"
+#include "i2c.h"
+#include "stubs.h"
+
+#include "tcpm/tcpci.h"
+
+#define EMUL_LABEL DT_NODELABEL(tcpci_emul)
+
+/** Check TCPC register value */
+static void check_tcpci_reg_f(const struct emul *emul, int reg,
+			      uint16_t exp_val, int line)
+{
+	uint16_t reg_val;
+
+	zassert_ok(tcpci_emul_get_reg(emul, reg, &reg_val),
+		   "Failed tcpci_emul_get_reg(); line: %d", line);
+	zassert_equal(exp_val, reg_val, "Expected 0x%x, got 0x%x; line: %d",
+		      exp_val, reg_val, line);
+}
+#define check_tcpci_reg(emul, reg, exp_val)			\
+	check_tcpci_reg_f((emul), (reg), (exp_val), __LINE__)
+
+/** Test TCPCI init and vbus level */
+static void test_tcpci_init(void)
+{
+	const struct emul *emul = emul_get_binding(DT_LABEL(EMUL_LABEL));
+	struct i2c_emul *i2c_emul = tcpci_emul_get_i2c_emul(emul);
+	uint16_t exp_mask;
+
+	tcpc_config[USBC_PORT_C0].flags = TCPC_FLAGS_TCPCI_REV2_0 &
+					  TCPC_FLAGS_TCPCI_REV2_0_NO_VSAFE0V;
+	tcpci_emul_set_rev(emul, TCPCI_EMUL_REV2_0_VER1_1);
+
+	/* Test fail on power status read */
+	i2c_common_emul_set_read_fail_reg(i2c_emul, TCPC_REG_POWER_STATUS);
+	zassert_equal(EC_ERROR_INVAL, tcpci_tcpm_init(USBC_PORT_C0), NULL);
+	i2c_common_emul_set_read_fail_reg(i2c_emul,
+					  I2C_COMMON_EMUL_NO_FAIL_REG);
+
+	/* Test fail on uninitialised bit set */
+	tcpci_emul_set_reg(emul, TCPC_REG_POWER_STATUS,
+			   TCPC_REG_POWER_STATUS_UNINIT);
+	zassert_equal(EC_ERROR_TIMEOUT, tcpci_tcpm_init(USBC_PORT_C0), NULL);
+
+	/*
+	 * Set expected alert mask. It is used in test until vSafe0V tcpc
+	 * config flag is revmoved.
+	 */
+	exp_mask = TCPC_REG_ALERT_TX_SUCCESS | TCPC_REG_ALERT_TX_FAILED |
+		   TCPC_REG_ALERT_TX_DISCARDED | TCPC_REG_ALERT_RX_STATUS |
+		   TCPC_REG_ALERT_RX_HARD_RST | TCPC_REG_ALERT_CC_STATUS |
+		   TCPC_REG_ALERT_FAULT | TCPC_REG_ALERT_POWER_STATUS;
+
+	/* Set TCPCI emulator VBUS to safe0v (disconnected) */
+	tcpci_emul_set_reg(emul, TCPC_REG_POWER_STATUS, 0);
+
+	/* Test init with VBUS safe0v without vSafe0V tcpc config flag */
+	zassert_equal(EC_SUCCESS, tcpci_tcpm_init(USBC_PORT_C0), NULL);
+	zassert_true(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_SAFE0V),
+		     NULL);
+	zassert_false(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_PRESENT),
+		      NULL);
+	check_tcpci_reg(emul, TCPC_REG_POWER_STATUS_MASK,
+			TCPC_REG_POWER_STATUS_VBUS_PRES);
+	check_tcpci_reg(emul, TCPC_REG_ALERT_MASK, exp_mask);
+
+	/* Set TCPCI emulator VBUS to present (connected, above 4V) */
+	tcpci_emul_set_reg(emul, TCPC_REG_POWER_STATUS,
+			   TCPC_REG_POWER_STATUS_VBUS_PRES);
+
+	/* Test init with VBUS present without vSafe0V tcpc config flag */
+	zassert_equal(EC_SUCCESS, tcpci_tcpm_init(USBC_PORT_C0), NULL);
+	zassert_false(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_SAFE0V),
+		      NULL);
+	zassert_true(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_PRESENT),
+		     NULL);
+	check_tcpci_reg(emul, TCPC_REG_POWER_STATUS_MASK,
+			TCPC_REG_POWER_STATUS_VBUS_PRES);
+	check_tcpci_reg(emul, TCPC_REG_ALERT_MASK, exp_mask);
+
+	/* Disable vSafe0V tcpc config flag and update expected alert mask */
+	exp_mask |= TCPC_REG_ALERT_EXT_STATUS;
+	tcpc_config[USBC_PORT_C0].flags = TCPC_FLAGS_TCPCI_REV2_0;
+
+	/* Test init with VBUS present with vSafe0V tcpc config flag */
+	zassert_equal(EC_SUCCESS, tcpci_tcpm_init(USBC_PORT_C0), NULL);
+	zassert_false(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_SAFE0V),
+		      NULL);
+	zassert_true(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_PRESENT),
+		     NULL);
+	check_tcpci_reg(emul, TCPC_REG_POWER_STATUS_MASK,
+			TCPC_REG_POWER_STATUS_VBUS_PRES);
+	check_tcpci_reg(emul, TCPC_REG_ALERT_MASK, exp_mask);
+
+	/* Set TCPCI emulator VBUS to safe0v (disconnected) */
+	tcpci_emul_set_reg(emul, TCPC_REG_POWER_STATUS, 0);
+	tcpci_emul_set_reg(emul, TCPC_REG_EXT_STATUS,
+			   TCPC_REG_EXT_STATUS_SAFE0V);
+
+	/* Test init with VBUS safe0v with vSafe0V tcpc config flag */
+	zassert_equal(EC_SUCCESS, tcpci_tcpm_init(USBC_PORT_C0), NULL);
+	zassert_true(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_SAFE0V),
+		      NULL);
+	zassert_false(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_PRESENT),
+		     NULL);
+	check_tcpci_reg(emul, TCPC_REG_POWER_STATUS_MASK,
+			TCPC_REG_POWER_STATUS_VBUS_PRES);
+	check_tcpci_reg(emul, TCPC_REG_ALERT_MASK, exp_mask);
+
+	/*
+	 * Set TCPCI emulator VBUS to disconnected but not at vSafe0V
+	 * (VBUS in 0.8V - 3.5V range)
+	 */
+	tcpci_emul_set_reg(emul, TCPC_REG_EXT_STATUS, 0);
+
+	/* Test init with VBUS not safe0v with vSafe0V tcpc config flag */
+	zassert_equal(EC_SUCCESS, tcpci_tcpm_init(USBC_PORT_C0), NULL);
+	zassert_false(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_SAFE0V),
+		      NULL);
+	zassert_false(tcpci_tcpm_check_vbus_level(USBC_PORT_C0, VBUS_PRESENT),
+		     NULL);
+	check_tcpci_reg(emul, TCPC_REG_POWER_STATUS_MASK,
+			TCPC_REG_POWER_STATUS_VBUS_PRES);
+	check_tcpci_reg(emul, TCPC_REG_ALERT_MASK, exp_mask);
+}
+
+/** Test TCPCI release */
+static void test_tcpci_release(void)
+{
+	const struct emul *emul = emul_get_binding(DT_LABEL(EMUL_LABEL));
+
+	tcpci_emul_set_reg(emul, TCPC_REG_ALERT, 0xffff);
+
+	zassert_equal(EC_SUCCESS, tcpci_tcpm_release(USBC_PORT_C0), NULL);
+	check_tcpci_reg(emul, TCPC_REG_POWER_STATUS_MASK, 0);
+	check_tcpci_reg(emul, TCPC_REG_ALERT_MASK, 0);
+	check_tcpci_reg(emul, TCPC_REG_ALERT, 0);
+}
+
+void test_suite_tcpci(void)
+{
+	ztest_test_suite(tcpci,
+			 ztest_user_unit_test(test_tcpci_init),
+			 ztest_user_unit_test(test_tcpci_release));
+	ztest_run_test_suite(tcpci);
+}