zephyr: drivers: Add PS8xxx unit tests

This patch adds unit tests for code of PS8xxx driver that is used
for all devices.

PS8805 is first device from PS8xxx family which will be tested.
All devices that are used for USBC port 1 are moved to i2c1 emulated
bus, because addresses required for PS8805 are not available on i2c0
bus.

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

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

5 files changed, 347 insertions, 30 deletions

diff --git a/zephyr/test/drivers/overlay.dts b/zephyr/test/drivers/overlay.dts
index 96fc7de31a..a8b5dec4d1 100644
--- a/zephyr/test/drivers/overlay.dts
+++ b/zephyr/test/drivers/overlay.dts
@@ -69,7 +69,7 @@
 			label = "USB_C0";
 		};
 		usb-c1 {
-			i2c-port = <&i2c0>;
+			i2c-port = <&i2c1>;
 			enum-name = "I2C_PORT_USB_C1";
 			label = "USB_C1";
 		};
@@ -432,8 +432,8 @@
 	};
 
 	/*
-	 * Second i2c bus is required, because there is already device with
-	 * address 0x68 on the first bus
+	 * Second i2c bus is required, because there are already devices with
+	 * addresses 0x68, 0xb and 0x9 on the first bus
 	 */
 	i2c1: i2c@400 {
 		status = "okay";
@@ -444,15 +444,20 @@
 		reg = <0x400 4>;
 		label = "I2C_1";
 
-		accel_bmi160: bmi160@68 {
-			compatible = "zephyr,bmi";
-			reg = <0x68>;
-			label = "BMI160";
-			device-model = "BMI_EMUL_160";
-			error-on-ro-write;
-			error-on-wo-read;
-			error-on-reserved-bit-write;
-			simulate-command-exec-time;
+		tcpci_ps8xxx_emul: tcpci_ps8xxx_emul@b {
+			compatible = "cros,tcpci-emul";
+			status = "okay";
+			reg = <0xb>;
+			label = "TCPCI_PS8XXX_EMUL";
+		};
+
+		ps8xxx_emul: ps8xxx_emul {
+			compatible = "cros,ps8xxx-emul";
+			tcpci-i2c = <&tcpci_ps8xxx_emul>;
+			p0-i2c-addr = <0x8>;
+			p1-i2c-addr = <0x9>;
+			gpio-i2c-addr = <0x1a>;
+			label = "PS8XXX_EMUL";
 		};
 
 		tcs_emul: tcs@39 {
@@ -463,6 +468,32 @@
 			error-on-reserved-bit-write;
 			error-on-msb-first-access;
 		};
+
+		syv682x_emul: syv682x@41 {
+			compatible = "zephyr,syv682x-emul";
+			reg = <0x41>;
+			label = "SYV682X_EMUL";
+		};
+
+		usb_c1_bb_retimer_emul: bbretimer@42 {
+			compatible = "cros,bb-retimer-emul";
+			reg = <0x42>;
+			label = "USB_C1_BB_RETIMER";
+			vendor = "BB_RETIMER_VENDOR_ID_1";
+			error-on-ro-write;
+			error-on-reserved-bit-write;
+		};
+
+		accel_bmi160: bmi160@68 {
+			compatible = "zephyr,bmi";
+			reg = <0x68>;
+			label = "BMI160";
+			device-model = "BMI_EMUL_160";
+			error-on-ro-write;
+			error-on-wo-read;
+			error-on-reserved-bit-write;
+			simulate-command-exec-time;
+		};
 	};
 
 	clock: clock {
@@ -526,12 +557,6 @@
 		label = "SN5S330_EMUL";
 	};
 
-	syv682x_emul: syv682x@41 {
-		compatible = "zephyr,syv682x-emul";
-		reg = <0x41>;
-		label = "SYV682X_EMUL";
-	};
-
 	accel_bmi260: bmi260@68 {
 		compatible = "zephyr,bmi";
 		reg = <0x68>;
@@ -543,15 +568,6 @@
 		simulate-command-exec-time;
 	};
 
-	usb_c1_bb_retimer_emul: bbretimer@42 {
-		compatible = "cros,bb-retimer-emul";
-		reg = <0x42>;
-		label = "USB_C1_BB_RETIMER";
-		vendor = "BB_RETIMER_VENDOR_ID_1";
-		error-on-ro-write;
-		error-on-reserved-bit-write;
-	};
-
 	ln9310: ln9310@80 {
 		compatible = "cros,ln9310-emul";
 		status = "okay";
diff --git a/zephyr/test/drivers/prj.conf b/zephyr/test/drivers/prj.conf
index 2edca02975..cad89e716c 100644
--- a/zephyr/test/drivers/prj.conf
+++ b/zephyr/test/drivers/prj.conf
@@ -39,6 +39,7 @@ CONFIG_EMUL_BMA255=y
 CONFIG_EMUL_BMI=y
 CONFIG_EMUL_TCS3400=y
 CONFIG_EMUL_BB_RETIMER=y
+CONFIG_EMUL_PS8XXX=y
 
 CONFIG_PLATFORM_EC_POWERSEQ=y
 
@@ -80,6 +81,8 @@ CONFIG_PLATFORM_EC_SENSOR_TIGHT_TIMESTAMPS=y
 CONFIG_PLATFORM_EC_ALS_TCS3400=y
 CONFIG_PLATFORM_EC_USBC_RETIMER_INTEL_BB=y
 CONFIG_PLATFORM_EC_USB_PD_TCPM_MUX=y
+CONFIG_PLATFORM_EC_USB_PD_TCPM_PS8805=y
+CONFIG_PLATFORM_EC_USB_PD_TCPM_PS8805_FORCE_DID=y
 
 CONFIG_ESPI=y
 CONFIG_ESPI_EMUL=y
diff --git a/zephyr/test/drivers/src/main.c b/zephyr/test/drivers/src/main.c
index ee82140ca6..05fe12c8fc 100644
--- a/zephyr/test/drivers/src/main.c
+++ b/zephyr/test/drivers/src/main.c
@@ -29,6 +29,7 @@ extern void test_suite_ppc_syv682c(void);
 extern void test_suite_ppc_sn5s330(void);
 extern void test_suite_cros_cbi(void);
 extern void test_suite_tcpci(void);
+extern void test_suite_ps8xxx(void);
 
 void test_main(void)
 {
@@ -59,4 +60,5 @@ void test_main(void)
 	test_suite_ppc_syv682c();
 	test_suite_cros_cbi();
 	test_suite_tcpci();
+	test_suite_ps8xxx();
 }
diff --git a/zephyr/test/drivers/src/ps8xxx.c b/zephyr/test/drivers/src/ps8xxx.c
new file mode 100644
index 0000000000..f95c7ea95a
--- /dev/null
+++ b/zephyr/test/drivers/src/ps8xxx.c
@@ -0,0 +1,295 @@
+/* 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 "common.h"
+#include "emul/emul_common_i2c.h"
+#include "emul/emul_tcpci.h"
+#include "emul/emul_ps8xxx.h"
+#include "timer.h"
+#include "i2c.h"
+#include "stubs.h"
+#include "tcpci_test_common.h"
+
+#include "tcpm/tcpci.h"
+#include "driver/tcpm/ps8xxx.h"
+#include "driver/tcpm/ps8xxx_public.h"
+
+#define PS8XXX_EMUL_LABEL	DT_LABEL(DT_NODELABEL(ps8xxx_emul))
+
+/** Test PS8xxx init fail conditions common for all PS8xxx devices */
+static void test_ps8xxx_init_fail(void)
+{
+	const struct emul *ps8xxx_emul = emul_get_binding(PS8XXX_EMUL_LABEL);
+	const struct emul *tcpci_emul = ps8xxx_emul_get_tcpci(ps8xxx_emul);
+	struct i2c_emul *tcpci_i2c_emul = tcpci_emul_get_i2c_emul(tcpci_emul);
+
+	/* Test fail on FW reg read */
+	i2c_common_emul_set_read_fail_reg(tcpci_i2c_emul, PS8XXX_REG_FW_REV);
+	zassert_equal(EC_ERROR_TIMEOUT, ps8xxx_tcpm_drv.init(USBC_PORT_C1),
+		      NULL);
+	i2c_common_emul_set_read_fail_reg(tcpci_i2c_emul,
+					  I2C_COMMON_EMUL_NO_FAIL_REG);
+
+	/* Test fail on FW reg set to 0 */
+	tcpci_emul_set_reg(tcpci_emul, PS8XXX_REG_FW_REV, 0x0);
+	zassert_equal(EC_ERROR_TIMEOUT, ps8xxx_tcpm_drv.init(USBC_PORT_C1),
+		      NULL);
+
+	/* Set arbitrary FW reg value != 0 for rest of the test */
+	tcpci_emul_set_reg(tcpci_emul, PS8XXX_REG_FW_REV, 0x31);
+
+	/* Test fail on TCPCI init */
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_POWER_STATUS,
+			   TCPC_REG_POWER_STATUS_UNINIT);
+	zassert_equal(EC_ERROR_TIMEOUT, ps8xxx_tcpm_drv.init(USBC_PORT_C1),
+		      NULL);
+}
+
+/** Test PS8xxx release */
+static void test_ps8xxx_release(void)
+{
+	const struct emul *ps8xxx_emul = emul_get_binding(PS8XXX_EMUL_LABEL);
+	const struct emul *tcpci_emul = ps8xxx_emul_get_tcpci(ps8xxx_emul);
+	struct i2c_emul *tcpci_i2c_emul = tcpci_emul_get_i2c_emul(tcpci_emul);
+	uint64_t start_ms;
+
+	/* Test successful release with correct FW reg read */
+	start_ms = k_uptime_get();
+	zassert_equal(EC_SUCCESS, ps8xxx_tcpm_drv.release(USBC_PORT_C1),
+		      NULL);
+	zassert_true(k_uptime_get() - start_ms < 10,
+		     "release on correct FW reg read shouldn't wait for chip");
+
+	/* Test delay on FW reg read fail */
+	i2c_common_emul_set_read_fail_reg(tcpci_i2c_emul, PS8XXX_REG_FW_REV);
+	start_ms = k_uptime_get();
+	zassert_equal(EC_SUCCESS, ps8xxx_tcpm_drv.release(USBC_PORT_C1),
+		      NULL);
+	zassert_true(k_uptime_get() - start_ms >= 10,
+		     "release on FW reg read fail should wait for chip");
+}
+
+/** Test PS8xxx set vconn */
+static void test_ps8xxx_set_vconn(void)
+{
+	uint64_t start_ms;
+
+	/* Test vconn enable */
+	start_ms = k_uptime_get();
+	zassert_equal(EC_SUCCESS, ps8xxx_tcpm_drv.set_vconn(USBC_PORT_C1, 1),
+		      NULL);
+	zassert_true(k_uptime_get() - start_ms < 10,
+		     "VCONN enable should be without delay");
+
+	/* Test vconn disable */
+	start_ms = k_uptime_get();
+	zassert_equal(EC_SUCCESS, ps8xxx_tcpm_drv.set_vconn(USBC_PORT_C1, 0),
+		      NULL);
+	/* Delay for VCONN disable is required because of issue b/185202064 */
+	zassert_true(k_uptime_get() - start_ms >= 10,
+		     "VCONN disable require minimum 10ms delay");
+}
+
+/** Test PS8xxx transmitting message from TCPC */
+static void test_ps8xxx_transmit(void)
+{
+	const struct emul *ps8xxx_emul = emul_get_binding(PS8XXX_EMUL_LABEL);
+	const struct emul *tcpci_emul = ps8xxx_emul_get_tcpci(ps8xxx_emul);
+	struct i2c_emul *tcpci_i2c_emul = tcpci_emul_get_i2c_emul(tcpci_emul);
+	struct tcpci_emul_msg *msg;
+	uint64_t exp_cnt, cnt;
+	uint16_t reg_val;
+
+	msg = tcpci_emul_get_tx_msg(tcpci_emul);
+
+	/* Test fail on transmitting BIST MODE 2 message */
+	i2c_common_emul_set_write_fail_reg(tcpci_i2c_emul, TCPC_REG_TRANSMIT);
+	zassert_equal(EC_ERROR_INVAL,
+		      ps8xxx_tcpm_drv.transmit(USBC_PORT_C1,
+					       TCPCI_MSG_TX_BIST_MODE_2, 0,
+					       NULL), NULL);
+	i2c_common_emul_set_write_fail_reg(tcpci_i2c_emul,
+					   I2C_COMMON_EMUL_NO_FAIL_REG);
+
+	/* Test sending BIST MODE 2 message */
+	exp_cnt = PS8751_BIST_COUNTER;
+	zassert_equal(EC_SUCCESS,
+		      ps8xxx_tcpm_drv.transmit(USBC_PORT_C1,
+					       TCPCI_MSG_TX_BIST_MODE_2, 0,
+					       NULL), NULL);
+	check_tcpci_reg(tcpci_emul, PS8XXX_REG_BIST_CONT_MODE_CTR, 0);
+	zassert_equal(TCPCI_MSG_TX_BIST_MODE_2, msg->type, NULL);
+
+	/* Check BIST counter value */
+	zassert_ok(tcpci_emul_get_reg(tcpci_emul,
+				      PS8XXX_REG_BIST_CONT_MODE_BYTE2,
+				      &reg_val), NULL);
+	cnt = reg_val;
+	cnt <<= 8;
+	zassert_ok(tcpci_emul_get_reg(tcpci_emul,
+				      PS8XXX_REG_BIST_CONT_MODE_BYTE1,
+				      &reg_val), NULL);
+	cnt |= reg_val;
+	cnt <<= 8;
+	zassert_ok(tcpci_emul_get_reg(tcpci_emul,
+				      PS8XXX_REG_BIST_CONT_MODE_BYTE0,
+				      &reg_val), NULL);
+	cnt |= reg_val;
+	zassert_equal(exp_cnt, cnt, "0x%llx != 0x%llx", exp_cnt, cnt);
+}
+
+/** Test PS8xxx get chip info code used by all PS8xxx devices */
+static void test_ps8xxx_get_chip_info(uint16_t current_product_id)
+{
+	const struct emul *ps8xxx_emul = emul_get_binding(PS8XXX_EMUL_LABEL);
+	const struct emul *tcpci_emul = ps8xxx_emul_get_tcpci(ps8xxx_emul);
+	struct i2c_emul *tcpci_i2c_emul = tcpci_emul_get_i2c_emul(tcpci_emul);
+	struct ec_response_pd_chip_info_v1 info;
+	uint16_t vendor, product, device_id, fw_rev;
+
+	/* Setup chip info */
+	vendor = PS8XXX_VENDOR_ID;
+	/* Get currently used product ID */
+	product = current_product_id;
+	/* Arbitrary choose device ID that doesn't require fixing */
+	device_id = 0x2;
+	/* Arbitrary revision */
+	fw_rev = 0x32;
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_VENDOR_ID, vendor);
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_PRODUCT_ID, product);
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_BCD_DEV, device_id);
+	tcpci_emul_set_reg(tcpci_emul, PS8XXX_REG_FW_REV, fw_rev);
+
+	/* Test fail on reading FW revision */
+	i2c_common_emul_set_read_fail_reg(tcpci_i2c_emul, PS8XXX_REG_FW_REV);
+	zassert_equal(EC_ERROR_INVAL,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 1, &info),
+		      NULL);
+	i2c_common_emul_set_read_fail_reg(tcpci_i2c_emul,
+					  I2C_COMMON_EMUL_NO_FAIL_REG);
+
+	/* Test reading chip info */
+	zassert_equal(EC_SUCCESS,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 1, &info),
+		      NULL);
+	zassert_equal(vendor, info.vendor_id, NULL);
+	zassert_equal(product, info.product_id, NULL);
+	zassert_equal(device_id, info.device_id, NULL);
+	zassert_equal(fw_rev, info.fw_version_number, NULL);
+
+	/* Test fail on wrong vendor id */
+	vendor = 0x0;
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_VENDOR_ID, vendor);
+	zassert_equal(EC_ERROR_UNKNOWN,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 1, &info),
+		      NULL);
+
+	/* Set correct vendor id */
+	vendor = PS8XXX_VENDOR_ID;
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_VENDOR_ID, vendor);
+
+	/* Set firmware revision to 0 */
+	fw_rev = 0x0;
+	tcpci_emul_set_reg(tcpci_emul, PS8XXX_REG_FW_REV, fw_rev);
+
+	/*
+	 * Test fail on firmware revision equals to 0 when getting chip info
+	 * from live device
+	 */
+	zassert_equal(EC_ERROR_UNKNOWN,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 1, &info),
+		      NULL);
+
+	/*
+	 * Test if firmware revision 0 is accepted when getting chip info from
+	 * not live device
+	 */
+	zassert_equal(EC_SUCCESS,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 0, &info),
+		      NULL);
+	zassert_equal(vendor, info.vendor_id, NULL);
+	zassert_equal(product, info.product_id, NULL);
+	zassert_equal(device_id, info.device_id, NULL);
+	zassert_equal(fw_rev, info.fw_version_number, NULL);
+
+	/* Set wrong vendor id */
+	vendor = 0;
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_VENDOR_ID, vendor);
+
+	/* Test fail on vendor id mismatch on live device */
+	zassert_equal(EC_ERROR_UNKNOWN,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 1, &info),
+		      NULL);
+
+	/* Test that vendor id is fixed on not live device */
+	zassert_equal(EC_SUCCESS,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 0, &info),
+		      NULL);
+	zassert_equal(PS8XXX_VENDOR_ID, info.vendor_id, NULL);
+	zassert_equal(product, info.product_id, NULL);
+	zassert_equal(device_id, info.device_id, NULL);
+	zassert_equal(fw_rev, info.fw_version_number, NULL);
+
+	/* Set correct vendor id */
+	vendor = PS8XXX_VENDOR_ID;
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_VENDOR_ID, vendor);
+
+	/* Set wrong product id */
+	product = 0;
+	tcpci_emul_set_reg(tcpci_emul, TCPC_REG_PRODUCT_ID, product);
+
+	/* Test fail on product id mismatch on live device */
+	zassert_equal(EC_ERROR_UNKNOWN,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 1, &info),
+		      NULL);
+
+	/* Test that product id is fixed on not live device */
+	zassert_equal(EC_SUCCESS,
+		      ps8xxx_tcpm_drv.get_chip_info(USBC_PORT_C1, 0, &info),
+		      NULL);
+	zassert_equal(vendor, info.vendor_id, NULL);
+	zassert_equal(board_get_ps8xxx_product_id(USBC_PORT_C1),
+		      info.product_id, NULL);
+	zassert_equal(device_id, info.device_id, NULL);
+	zassert_equal(fw_rev, info.fw_version_number, NULL);
+}
+
+static void test_ps8805_get_chip_info(void)
+{
+	test_ps8xxx_get_chip_info(PS8805_PRODUCT_ID);
+}
+
+/* Setup no fail for all I2C devices associated with PS8xxx emulator */
+static void setup_no_fail_all(void)
+{
+	const struct emul *ps8xxx_emul = emul_get_binding(PS8XXX_EMUL_LABEL);
+	const struct emul *tcpci_emul = ps8xxx_emul_get_tcpci(ps8xxx_emul);
+	struct i2c_emul *tcpci_i2c_emul = tcpci_emul_get_i2c_emul(tcpci_emul);
+
+	i2c_common_emul_set_read_fail_reg(tcpci_i2c_emul,
+					  I2C_COMMON_EMUL_NO_FAIL_REG);
+	i2c_common_emul_set_write_fail_reg(tcpci_i2c_emul,
+					   I2C_COMMON_EMUL_NO_FAIL_REG);
+}
+
+void test_suite_ps8xxx(void)
+{
+	ztest_test_suite(ps8805,
+			 ztest_unit_test_setup_teardown(test_ps8xxx_init_fail,
+				 setup_no_fail_all, unit_test_noop),
+			 ztest_unit_test_setup_teardown(test_ps8xxx_release,
+				 setup_no_fail_all, unit_test_noop),
+			 ztest_unit_test_setup_teardown(test_ps8xxx_set_vconn,
+				 setup_no_fail_all, unit_test_noop),
+			 ztest_unit_test_setup_teardown(test_ps8xxx_transmit,
+				 setup_no_fail_all, unit_test_noop),
+			 ztest_unit_test_setup_teardown(
+				 test_ps8805_get_chip_info,
+				 setup_no_fail_all, unit_test_noop));
+	ztest_run_test_suite(ps8805);
+}
diff --git a/zephyr/test/drivers/src/stubs.c b/zephyr/test/drivers/src/stubs.c
index 9aa9cf539e..9418207349 100644
--- a/zephyr/test/drivers/src/stubs.c
+++ b/zephyr/test/drivers/src/stubs.c
@@ -17,8 +17,8 @@
 #include "ppc/syv682x_public.h"
 #include "retimer/bb_retimer_public.h"
 #include "stubs.h"
+#include "tcpm/ps8xxx_public.h"
 #include "tcpm/tcpci.h"
-#include "tcpm/tusb422_public.h"
 #include "usb_mux.h"
 #include "usb_pd_tcpm.h"
 #include "usbc_ppc.h"
@@ -130,9 +130,10 @@ struct tcpc_config_t tcpc_config[] = {
 		.bus_type = EC_BUS_TYPE_I2C,
 		.i2c_info = {
 			.port = I2C_PORT_USB_C1,
-			.addr_flags = TUSB422_I2C_ADDR_FLAGS,
+			.addr_flags = DT_REG_ADDR(DT_NODELABEL(
+							tcpci_ps8xxx_emul)),
 		},
-		.drv = &tusb422_tcpm_drv,
+		.drv = &ps8xxx_tcpm_drv,
 	},
 };
 BUILD_ASSERT(ARRAY_SIZE(tcpc_config) == USBC_PORT_COUNT);