summaryrefslogtreecommitdiff
path: root/zephyr/test/drivers/rt1718s/src/tcpc.c
blob: 8259b6f097f5ac1836427dc9929777163bcabe77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/* Copyright 2023 The ChromiumOS Authors
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#include "driver/tcpm/rt1718s.h"
#include "driver/tcpm/rt1718s_public.h"
#include "driver/tcpm/tcpci.h"
#include "emul/tcpc/emul_rt1718s.h"
#include "test/drivers/stubs.h"
#include "test/drivers/test_state.h"

#include <zephyr/drivers/emul.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/slist.h>
#include <zephyr/ztest.h>
LOG_MODULE_REGISTER(rt1718s_tcpc_test, CONFIG_TCPCI_EMUL_LOG_LEVEL);

#define RT1718S_NODE DT_NODELABEL(rt1718s_emul)

static const int tcpm_rt1718s_port = USBC_PORT_C0;
static const struct emul *rt1718s_emul = EMUL_DT_GET(RT1718S_NODE);

static void rt1718s_clear_set_reg_history(void *f)
{
	rt1718s_emul_reset_set_history(rt1718s_emul);
}

ZTEST_SUITE(rt1718s_tcpc, drivers_predicate_post_main, NULL,
	    rt1718s_clear_set_reg_history, rt1718s_clear_set_reg_history, NULL);

static uint16_t get_emul_reg(const struct emul *emul, int reg)
{
	uint16_t val;

	zassert_ok(rt1718s_emul_get_reg(emul, reg, &val),
		   "Cannot get reg %x on rt1718s emul", reg);
	return val;
}

static void compare_reg_val_with_mask(const struct emul *emul, int reg,
				      uint16_t expected, uint16_t mask)
{
	uint16_t masked_val = get_emul_reg(emul, reg) & mask;
	uint16_t masked_expected = expected & mask;

	zassert_equal(masked_val, masked_expected,
		      "expected register %x with mask %x should be %x, get %x",
		      reg, mask, masked_expected, masked_val);
}

static void test_bc12_reg_init_settings(const struct emul *emul)
{
	/* Vendor defined BC12 function is enabled */
	compare_reg_val_with_mask(emul, RT1718S_RT_MASK6,
				  RT1718S_RT_MASK6_M_BC12_SNK_DONE |
					  RT1718S_RT_MASK6_M_BC12_TA_CHG,
				  0xFF);
	compare_reg_val_with_mask(emul, RT1718S_RT2_SBU_CTRL_01,
				  RT1718S_RT2_SBU_CTRL_01_DPDM_VIEN |
					  RT1718S_RT2_SBU_CTRL_01_DM_SWEN |
					  RT1718S_RT2_SBU_CTRL_01_DP_SWEN,
				  0xFF);
	/* 2.7v mode is disabled */
	compare_reg_val_with_mask(emul, RT1718S_RT2_BC12_SNK_FUNC, 0,
				  RT1718S_RT2_BC12_SNK_FUNC_SPEC_TA_EN);
	/* DCDT is set to 600ms timeout */
	compare_reg_val_with_mask(emul, RT1718S_RT2_BC12_SNK_FUNC,
				  RT1718S_RT2_BC12_SNK_FUNC_DCDT_SEL_600MS,
				  RT1718S_RT2_BC12_SNK_FUNC_DCDT_SEL_MASK);
	/* vlgc option is disabled */
	compare_reg_val_with_mask(emul, RT1718S_RT2_BC12_SNK_FUNC, 0,
				  RT1718S_RT2_BC12_SNK_FUNC_VLGC_OPT);
	/* DPDM voltage selection is set to 65V */
	compare_reg_val_with_mask(
		emul, RT1718S_RT2_DPDM_CTR1_DPDM_SET,
		RT1718S_RT2_DPDM_CTR1_DPDM_SET_DPDM_VSRC_SEL_0_65V,
		RT1718S_RT2_DPDM_CTR1_DPDM_SET_DPDM_VSRC_SEL_MASK);
	/* Sink wait vbus is disabled */
	compare_reg_val_with_mask(emul, RT1718S_RT2_BC12_SNK_FUNC, 0,
				  RT1718S_RT2_BC12_SNK_FUNC_BC12_WAIT_VBUS);
}

static void test_common_reg_init_settings(const struct emul *emul)
{
	/* VBUS_VOL_SEL is set to 20V */
	compare_reg_val_with_mask(emul, RT1718S_RT2_VBUS_VOL_CTRL,
				  RT1718S_VBUS_VOL_TO_REG(20),
				  RT1718S_RT2_VBUS_VOL_CTRL_VOL_SEL);
	/* VCONN_OCP_SEL is set to 400mA */
	compare_reg_val_with_mask(emul, RT1718S_VCONN_CONTROL_3, 0x7F,
				  RT1718S_VCONN_CONTROL_3_VCONN_OCP_SEL);
	/* Vconn OCP shoot detection is increased from 200ns to 3~5us */
	compare_reg_val_with_mask(emul, RT1718S_VCON_CTRL4, 0,
				  RT1718S_VCON_CTRL4_OCP_CP_EN);
	/* FOD function is disabled */
	compare_reg_val_with_mask(emul, 0xCF, 0, 0x40);
	/* Exit shipping mode request is set */
	compare_reg_val_with_mask(emul, RT1718S_SYS_CTRL1, 0,
				  RT1718S_SYS_CTRL1_TCPC_CONN_INVALID);
	compare_reg_val_with_mask(emul, RT1718S_SYS_CTRL1, 0xFF,
				  RT1718S_SYS_CTRL1_SHIPPING_OFF);
	/* Alert and fault is cleared */
	compare_reg_val_with_mask(emul, TCPC_REG_FAULT_STATUS, 0, 0xFF);
	compare_reg_val_with_mask(emul, TCPC_REG_ALERT, 0, 0xFFFF);
	/*
	 * TODO Validate vendor defined alert mask is set once tcpci emul fix.
	 */
	/* FRS settings: Rx frs and valid vbus fall is set to unmasked */
	compare_reg_val_with_mask(emul, RT1718S_RT_MASK1, 0xFF,
				  RT1718S_RT_MASK1_M_RX_FRS |
					  RT1718S_RT_MASK1_M_VBUS_FRS_LOW);
}

ZTEST(rt1718s_tcpc, test_init_with_device_id_es1)
{
	rt1718s_emul_set_device_id(rt1718s_emul, RT1718S_DEVICE_ID_ES1);
	zassert_ok(rt1718s_tcpm_drv.init(tcpm_rt1718s_port),
		   "Cannot initialize rt1718s");
	test_bc12_reg_init_settings(rt1718s_emul);
	test_common_reg_init_settings(rt1718s_emul);

	compare_reg_val_with_mask(rt1718s_emul, RT1718S_VCONN_CONTROL_3, 0xFF,
				  RT1718S_VCONN_CONTROL_3_VCONN_OVP_DEG);
}

ZTEST(rt1718s_tcpc, test_init_with_device_id_es2)
{
	rt1718s_emul_set_device_id(rt1718s_emul, RT1718S_DEVICE_ID_ES2);
	zassert_ok(rt1718s_tcpm_drv.init(tcpm_rt1718s_port),
		   "Cannot initialize rt1718s");
	test_bc12_reg_init_settings(rt1718s_emul);
	test_common_reg_init_settings(rt1718s_emul);

	compare_reg_val_with_mask(rt1718s_emul, TCPC_REG_FAULT_CTRL, 0xFF,
				  TCPC_REG_FAULT_CTRL_VCONN_OCP_FAULT_DIS);
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_VCON_CTRL4, 0,
				  RT1718S_VCON_CTRL4_UVP_CP_EN |
					  RT1718S_VCON_CTRL4_OCP_CP_EN);
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_VCONN_CONTROL_2, 0xFF,
				  RT1718S_VCONN_CONTROL_2_OVP_EN_CC1 |
					  RT1718S_VCONN_CONTROL_2_OVP_EN_CC2);
}

ZTEST(rt1718s_tcpc, test_set_vconn_enable)
{
	struct _snode *iter_node = NULL;
	struct set_reg_entry_t *iter_entry = NULL;
	struct set_reg_entry_t *set_vconn_limit_on_entry = NULL;
	struct set_reg_entry_t *set_vconn_limit_off_entry = NULL;
	struct rt1718s_emul_data *rt1718s_data = rt1718s_emul->data;
	struct _slist *set_private_reg_history =
		&rt1718s_data->set_private_reg_history;

	zassert_ok(rt1718s_tcpm_drv.set_vconn(tcpm_rt1718s_port, true));

	iter_node = sys_slist_peek_head(set_private_reg_history);
	while (iter_node != NULL) {
		iter_entry = SYS_SLIST_CONTAINER(iter_node, iter_entry, node);
		if (iter_entry->reg == RT1718S_VCON_CTRL3 &&
		    (iter_entry->val & RT1718S_VCON_LIMIT_MODE) == 1) {
			set_vconn_limit_on_entry = iter_entry;
			break;
		}
		iter_node = iter_node->next;
	}
	/* b/233698718#comment9 workaround should applied */
	zassert_not_null(set_vconn_limit_on_entry,
			 "No entry for setting RT1718S_VCON_CTRL3");
	while (iter_node != NULL) {
		iter_entry = SYS_SLIST_CONTAINER(iter_node, iter_entry, node);
		if (iter_entry->reg == RT1718S_VCON_CTRL3 &&
		    (iter_entry->val & RT1718S_VCON_LIMIT_MODE) == 0) {
			set_vconn_limit_off_entry = iter_entry;
			break;
		}
		iter_node = iter_node->next;
	}
	zassert_not_null(set_vconn_limit_off_entry,
			 "No entry for setting RT1718S_VCON_CTRL3");
	zassert_true(
		(set_vconn_limit_off_entry->access_time -
		 set_vconn_limit_on_entry->access_time) >= 10,
		"Workaround for two setting Vconn limit is smaller than 10ms");

	/* rt1718s should be in shutdown mode. */
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_VCON_CTRL3, 0x0,
				  RT1718S_VCON_LIMIT_MODE);
	/* Vconn RVP should be enabled. */
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_VCONN_CONTROL_2, 0xFF,
				  RT1718S_VCONN_CONTROL_2_RVP_EN);
}

ZTEST(rt1718s_tcpc, test_set_vconn_disable)
{
	zassert_ok(rt1718s_tcpm_drv.set_vconn(tcpm_rt1718s_port, false));
	/* Vconn RVP should be disabled. */
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_VCONN_CONTROL_2, 0,
				  RT1718S_VCONN_CONTROL_2_RVP_EN);
}

ZTEST(rt1718s_tcpc, test_enter_low_power_mode)
{
	zassert_ok(rt1718s_tcpm_drv.enter_low_power_mode(tcpm_rt1718s_port));
	compare_reg_val_with_mask(
		rt1718s_emul, RT1718S_SYS_CTRL2, RT1718S_SYS_CTRL2_LPWR_EN,
		RT1718S_SYS_CTRL2_LPWR_EN | RT1718S_SYS_CTRL2_BMCIO_OSC_EN);
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_RT2_SBU_CTRL_01, 0,
				  0xFF);
}

ZTEST(rt1718s_tcpc, test_set_sbu)
{
	uint8_t mask = RT1718S_RT2_SBU_CTRL_01_SBU_VIEN |
		       RT1718S_RT2_SBU_CTRL_01_SBU1_SWEN |
		       RT1718S_RT2_SBU_CTRL_01_SBU2_SWEN;

	zassert_ok(rt1718s_tcpm_drv.set_sbu(tcpm_rt1718s_port, true));
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_RT2_SBU_CTRL_01, 0xFF,
				  mask);

	zassert_ok(rt1718s_tcpm_drv.set_sbu(tcpm_rt1718s_port, false));
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_RT2_SBU_CTRL_01, 0,
				  mask);
}

ZTEST(rt1718s_tcpc, test_set_frs)
{
	zassert_ok(rt1718s_tcpm_drv.set_frs_enable(tcpm_rt1718s_port, true));
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_FRS_CTRL2,
				  RT1718S_FRS_CTRL2_RX_FRS_EN |
					  RT1718S_FRS_CTRL2_VBUS_FRS_EN | 0x10,
				  0xFF);
	compare_reg_val_with_mask(
		rt1718s_emul, RT1718S_VBUS_CTRL_EN,
		RT1718S_VBUS_CTRL_EN_GPIO2_VBUS_PATH_EN |
			RT1718S_VBUS_CTRL_EN_GPIO1_VBUS_PATH_EN | 0x3F,
		0xFF);

	zassert_ok(rt1718s_tcpm_drv.set_frs_enable(tcpm_rt1718s_port, false));
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_FRS_CTRL2, 0x10, 0xFF);
	compare_reg_val_with_mask(rt1718s_emul, RT1718S_VBUS_CTRL_EN, 0x3F,
				  0xFF);
}