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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
/* 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 <device.h>
#include <devicetree.h>
#include <emul.h>
#include <ztest.h>
#include "driver/ppc/sn5s330.h"
#include "driver/ppc/sn5s330_public.h"
#include "emul/emul_common_i2c.h"
#include "emul/emul_sn5s330.h"
#include "usbc_ppc.h"
/** This must match the index of the sn5s330 in ppc_chips[] */
#define SN5S330_PORT 0
#define EMUL emul_get_binding(DT_LABEL(DT_NODELABEL(sn5s330_emul)))
#define FUNC_SET1_ILIMPP1_MSK 0x1F
/*
* TODO(b/203364783): Exclude other threads from interacting with the emulator
* to avoid test flakiness
*/
struct intercept_write_data {
int reg_to_intercept;
uint8_t val_intercepted;
};
struct intercept_read_data {
int reg_to_intercept;
bool replace_reg_val;
uint8_t replacement_val;
};
static int intercept_read_func(struct i2c_emul *emul, int reg, uint8_t *val,
int bytes, void *data)
{
struct intercept_read_data *test_data = data;
if (test_data->reg_to_intercept && test_data->replace_reg_val)
*val = test_data->replacement_val;
return EC_SUCCESS;
}
static int intercept_write_func(struct i2c_emul *emul, int reg, uint8_t val,
int bytes, void *data)
{
struct intercept_write_data *test_data = data;
if (test_data->reg_to_intercept == reg)
test_data->val_intercepted = val;
return 1;
}
static int fail_until_write_func(struct i2c_emul *emul, int reg, uint8_t val,
int bytes, void *data)
{
uint32_t *count = data;
if (*count != 0) {
*count -= 1;
return -EIO;
}
return 1;
}
static void test_fail_once_func_set1(void)
{
const struct emul *emul = EMUL;
struct i2c_emul *i2c_emul = sn5s330_emul_to_i2c_emul(emul);
uint32_t count = 1;
uint8_t func_set1_value;
i2c_common_emul_set_write_func(i2c_emul, fail_until_write_func, &count);
zassert_ok(sn5s330_drv.init(SN5S330_PORT), NULL);
zassert_equal(count, 0, NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET1, &func_set1_value);
zassert_true((func_set1_value & SN5S330_ILIM_1_62) != 0, NULL);
i2c_common_emul_set_write_func(i2c_emul, NULL, NULL);
}
static void test_dead_battery_boot_force_pp2_fets_set(void)
{
const struct emul *emul = EMUL;
struct i2c_emul *i2c_emul = sn5s330_emul_to_i2c_emul(emul);
struct intercept_write_data test_write_data = {
.reg_to_intercept = SN5S330_FUNC_SET3,
.val_intercepted = 0,
};
struct intercept_read_data test_read_data = {
.reg_to_intercept = SN5S330_INT_STATUS_REG4,
.replace_reg_val = true,
.replacement_val = SN5S330_DB_BOOT,
};
i2c_common_emul_set_write_func(i2c_emul, intercept_write_func,
&test_write_data);
i2c_common_emul_set_read_func(i2c_emul, intercept_read_func,
&test_read_data);
zassert_ok(sn5s330_drv.init(SN5S330_PORT), NULL);
/*
* Although the device enables PP2_FET on dead battery boot by setting
* the PP2_EN bit, the driver also force sets this bit during dead
* battery boot by writing that bit to the FUNC_SET3 reg.
*
* TODO(207034759): Verify need or remove redundant PP2 set.
*/
zassert_true(test_write_data.val_intercepted & SN5S330_PP2_EN, NULL);
zassert_false(sn5s330_drv.is_sourcing_vbus(SN5S330_PORT), NULL);
}
static void test_enter_low_power_mode(void)
{
const struct emul *emul = EMUL;
uint8_t func_set2_reg;
uint8_t func_set3_reg;
uint8_t func_set4_reg;
uint8_t func_set9_reg;
/*
* Requirements were extracted from TI's recommended changes for octopus
* to lower power use during hibernate as well as the follow up changes
* we made to allow the device to wake up from hibernate.
*
* For Reference: b/111006203#comment35
*/
zassert_ok(sn5s330_drv.init(SN5S330_PORT), NULL);
zassert_ok(sn5s330_drv.enter_low_power_mode(SN5S330_PORT), NULL);
/* 1) Verify VBUS power paths are off */
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET3, &func_set3_reg);
zassert_equal(func_set3_reg & SN5S330_PP1_EN, 0, NULL);
zassert_equal(func_set3_reg & SN5S330_PP2_EN, 0, NULL);
/* 2) Verify VCONN power path is off */
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET4, &func_set4_reg);
zassert_not_equal(func_set4_reg & SN5S330_CC_EN, 0, NULL);
zassert_equal(func_set4_reg & SN5S330_VCONN_EN, 0, NULL);
/* 3) Verify SBU FET is off */
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET2, &func_set2_reg);
zassert_equal(func_set2_reg & SN5S330_SBU_EN, 0, NULL);
/* 4) Verify VBUS and SBU OVP comparators are off */
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET9, &func_set9_reg);
zassert_equal(func_set9_reg & SN5S330_FORCE_OVP_EN_SBU, 0, NULL);
zassert_equal(func_set9_reg & SN5S330_PWR_OVR_VBUS, 0, NULL);
zassert_not_equal(func_set9_reg & SN5S330_OVP_EN_CC, 0, NULL);
zassert_equal(func_set9_reg & SN5S330_FORCE_ON_VBUS_OVP, 0, NULL);
zassert_equal(func_set9_reg & SN5S330_FORCE_ON_VBUS_UVP, 0, NULL);
}
static void test_vbus_source_sink_enable(void)
{
const struct emul *emul = EMUL;
uint8_t func_set3_reg;
zassert_ok(sn5s330_drv.init(SN5S330_PORT), NULL);
/* Test enable/disable VBUS source FET */
zassert_ok(sn5s330_drv.vbus_source_enable(SN5S330_PORT, true), NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET3, &func_set3_reg);
zassert_not_equal(func_set3_reg & SN5S330_PP1_EN, 0, NULL);
zassert_ok(sn5s330_drv.vbus_source_enable(SN5S330_PORT, false), NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET3, &func_set3_reg);
zassert_equal(func_set3_reg & SN5S330_PP1_EN, 0, NULL);
/* Test enable/disable VBUS sink FET */
zassert_ok(sn5s330_drv.vbus_sink_enable(SN5S330_PORT, true), NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET3, &func_set3_reg);
zassert_not_equal(func_set3_reg & SN5S330_PP2_EN, 0, NULL);
zassert_ok(sn5s330_drv.vbus_sink_enable(SN5S330_PORT, false), NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET3, &func_set3_reg);
zassert_equal(func_set3_reg & SN5S330_PP2_EN, 0, NULL);
}
static void test_vbus_discharge(void)
{
const struct emul *emul = EMUL;
uint8_t func_set3_reg;
zassert_ok(sn5s330_drv.init(SN5S330_PORT), NULL);
/* Test enable/disable VBUS discharging */
zassert_ok(sn5s330_drv.discharge_vbus(SN5S330_PORT, true), NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET3, &func_set3_reg);
zassert_not_equal(func_set3_reg & SN5S330_VBUS_DISCH_EN, 0, NULL);
zassert_ok(sn5s330_drv.discharge_vbus(SN5S330_PORT, false), NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET3, &func_set3_reg);
zassert_equal(func_set3_reg & SN5S330_VBUS_DISCH_EN, 0, NULL);
}
static void test_set_vbus_source_current_limit(void)
{
const struct emul *emul = EMUL;
uint8_t func_set1_reg;
/* Test every TCPC Pull Resistance Value */
zassert_ok(sn5s330_drv.init(SN5S330_PORT), NULL);
/* USB */
zassert_ok(sn5s330_drv.set_vbus_source_current_limit(SN5S330_PORT,
TYPEC_RP_USB),
NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET1, &func_set1_reg);
zassert_equal(func_set1_reg & FUNC_SET1_ILIMPP1_MSK, SN5S330_ILIM_0_63,
NULL);
/* 1.5A */
zassert_ok(sn5s330_drv.set_vbus_source_current_limit(SN5S330_PORT,
TYPEC_RP_1A5),
NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET1, &func_set1_reg);
zassert_equal(func_set1_reg & FUNC_SET1_ILIMPP1_MSK, SN5S330_ILIM_1_62,
NULL);
/* 3.0A */
zassert_ok(sn5s330_drv.set_vbus_source_current_limit(SN5S330_PORT,
TYPEC_RP_3A0),
NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET1, &func_set1_reg);
zassert_equal(func_set1_reg & FUNC_SET1_ILIMPP1_MSK, SN5S330_ILIM_3_06,
NULL);
/* Unknown/Reserved - We set result as USB */
zassert_ok(sn5s330_drv.set_vbus_source_current_limit(SN5S330_PORT,
TYPEC_RP_RESERVED),
NULL);
sn5s330_emul_peek_reg(emul, SN5S330_FUNC_SET1, &func_set1_reg);
zassert_equal(func_set1_reg & FUNC_SET1_ILIMPP1_MSK, SN5S330_ILIM_0_63,
NULL);
}
static void reset_sn5s330_state(void)
{
struct i2c_emul *i2c_emul = sn5s330_emul_to_i2c_emul(EMUL);
i2c_common_emul_set_write_func(i2c_emul, NULL, NULL);
i2c_common_emul_set_read_func(i2c_emul, NULL, NULL);
sn5s330_emul_reset(EMUL);
}
void test_suite_ppc_sn5s330(void)
{
ztest_test_suite(
ppc_sn5s330,
ztest_unit_test_setup_teardown(
test_set_vbus_source_current_limit, reset_sn5s330_state,
reset_sn5s330_state),
ztest_unit_test_setup_teardown(test_vbus_discharge,
reset_sn5s330_state,
reset_sn5s330_state),
ztest_unit_test_setup_teardown(test_vbus_source_sink_enable,
reset_sn5s330_state,
reset_sn5s330_state),
ztest_unit_test_setup_teardown(test_enter_low_power_mode,
reset_sn5s330_state,
reset_sn5s330_state),
ztest_unit_test_setup_teardown(
test_dead_battery_boot_force_pp2_fets_set,
reset_sn5s330_state, reset_sn5s330_state),
ztest_unit_test_setup_teardown(test_fail_once_func_set1,
reset_sn5s330_state,
reset_sn5s330_state));
ztest_run_test_suite(ppc_sn5s330);
}
|
