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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
/* Copyright 2022 The ChromiumOS Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "common.h"
#include "ec_tasks.h"
#include "gpio.h"
#include "hooks.h"
#include "host_command.h"
#include "power.h"
#include "power_button.h"
#include "system.h"
#include "task.h"
#include "test_state.h"
#include "timer.h"
#include <zephyr/devicetree.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/gpio/gpio_emul.h>
#include <zephyr/fff.h>
#include <zephyr/kernel.h>
#include <zephyr/ztest.h>
FAKE_VOID_FUNC(chipset_pre_init_hook);
DECLARE_HOOK(HOOK_CHIPSET_PRE_INIT, chipset_pre_init_hook, HOOK_PRIO_DEFAULT);
FAKE_VOID_FUNC(chipset_startup_hook);
DECLARE_HOOK(HOOK_CHIPSET_STARTUP, chipset_startup_hook, HOOK_PRIO_DEFAULT);
FAKE_VOID_FUNC(chipset_resume_hook);
DECLARE_HOOK(HOOK_CHIPSET_RESUME, chipset_resume_hook, HOOK_PRIO_DEFAULT);
FAKE_VALUE_FUNC(int, system_jumped_late);
static void set_signal_state(enum power_state state)
{
const struct gpio_dt_spec *ap_ec_sysrst_odl =
gpio_get_dt_spec(GPIO_AP_EC_SYSRST_ODL);
const struct gpio_dt_spec *ap_in_sleep_l =
gpio_get_dt_spec(GPIO_AP_IN_SLEEP_L);
switch (state) {
case POWER_S0:
gpio_emul_input_set(ap_in_sleep_l->port, ap_in_sleep_l->pin, 1);
gpio_emul_input_set(ap_ec_sysrst_odl->port,
ap_ec_sysrst_odl->pin, 1);
break;
case POWER_S3:
gpio_emul_input_set(ap_in_sleep_l->port, ap_in_sleep_l->pin, 0);
gpio_emul_input_set(ap_ec_sysrst_odl->port,
ap_ec_sysrst_odl->pin, 1);
break;
case POWER_G3:
gpio_emul_input_set(ap_in_sleep_l->port, ap_in_sleep_l->pin, 0);
gpio_emul_input_set(ap_ec_sysrst_odl->port,
ap_ec_sysrst_odl->pin, 0);
break;
default:
zassert_unreachable("state %d not supported", state);
}
task_wake(TASK_ID_CHIPSET);
k_sleep(K_SECONDS(1));
}
static void power_seq_before(void *f)
{
/* Required for deferred callbacks to work */
set_test_runner_tid();
/* Start from G3 */
power_set_state(POWER_G3);
set_signal_state(POWER_G3);
RESET_FAKE(chipset_pre_init_hook);
RESET_FAKE(chipset_startup_hook);
RESET_FAKE(chipset_resume_hook);
RESET_FAKE(system_jumped_late);
FFF_RESET_HISTORY();
}
/* Normal boot sequence, G3 -> S3 -> S0 */
ZTEST(power_seq, test_power_state_machine)
{
/* G3 -> S3 */
power_set_state(POWER_G3);
set_signal_state(POWER_S3);
zassert_equal(power_get_state(), POWER_S3);
/* S3 -> S0 */
power_set_state(POWER_S3);
set_signal_state(POWER_S0);
zassert_equal(power_get_state(), POWER_S0);
/* S0 -> G3 */
power_set_state(POWER_S0);
set_signal_state(POWER_G3);
zassert_equal(power_get_state(), POWER_G3);
}
/* Verify power btn short press can boot the device */
ZTEST(power_seq, test_power_btn_short_press)
{
zassert_equal(power_get_state(), POWER_G3);
power_button_simulate_press(100);
k_sleep(K_SECONDS(1));
/* Verify that power state machine is able to reach S5S3, and back to G3
* because power signal is not changed
*/
zassert_equal(chipset_pre_init_hook_fake.call_count, 1);
zassert_equal(chipset_startup_hook_fake.call_count, 0);
zassert_equal(power_get_state(), POWER_G3);
}
/* Verify lid open can boot the device */
ZTEST(power_seq, test_lid_open)
{
const struct gpio_dt_spec *lid_open = gpio_get_dt_spec(GPIO_LID_OPEN);
gpio_emul_input_set(lid_open->port, lid_open->pin, 0);
zassert_equal(power_get_state(), POWER_G3);
gpio_emul_input_set(lid_open->port, lid_open->pin, 1);
k_sleep(K_SECONDS(1));
/* Verify that power state machine is able to reach S5S3, and back to G3
* because power signal is not changed
*/
zassert_equal(chipset_pre_init_hook_fake.call_count, 1);
zassert_equal(chipset_startup_hook_fake.call_count, 0);
zassert_equal(power_get_state(), POWER_G3);
}
/* Suspend, S0 -> S3 -> S0 */
ZTEST(power_seq, test_host_sleep_success)
{
host_clear_events(EC_HOST_EVENT_MASK(EC_HOST_EVENT_HANG_DETECT));
/* Boot AP */
set_signal_state(POWER_S0);
zassert_equal(power_get_state(), POWER_S0);
/* Suspend for 30 seconds */
zassert_ok(host_command_process(
&(struct host_cmd_handler_args)BUILD_HOST_COMMAND_PARAMS(
EC_CMD_HOST_SLEEP_EVENT, 0,
(struct ec_params_host_sleep_event){
.sleep_event = HOST_SLEEP_EVENT_S3_SUSPEND })));
k_sleep(K_MSEC(1));
set_signal_state(POWER_S3);
k_sleep(K_SECONDS(30));
zassert_equal(power_get_state(), POWER_S3);
/* Resume */
set_signal_state(POWER_S0);
zassert_ok(host_command_process(
&(struct host_cmd_handler_args)BUILD_HOST_COMMAND_PARAMS(
EC_CMD_HOST_SLEEP_EVENT, 0,
(struct ec_params_host_sleep_event){
.sleep_event = HOST_SLEEP_EVENT_S3_RESUME })));
zassert_equal(power_get_state(), POWER_S0);
/* Verify that EC_HOST_EVENT_HANG_DETECT is not triggered */
zassert_false(host_is_event_set(EC_HOST_EVENT_HANG_DETECT));
}
/* Sleep hang, send EC_HOST_EVENT_HANG_DETECT */
ZTEST(power_seq, test_host_sleep_hang)
{
host_clear_events(EC_HOST_EVENT_MASK(EC_HOST_EVENT_HANG_DETECT));
/* Boot AP */
set_signal_state(POWER_S0);
zassert_equal(power_get_state(), POWER_S0);
/* Send HOST_SLEEP_EVENT_S3_SUSPEND and hang for 30 seconds */
zassert_ok(host_command_process(
&(struct host_cmd_handler_args)BUILD_HOST_COMMAND_PARAMS(
EC_CMD_HOST_SLEEP_EVENT, 0,
(struct ec_params_host_sleep_event){
.sleep_event = HOST_SLEEP_EVENT_S3_SUSPEND })));
k_sleep(K_SECONDS(30));
/* Verify that EC_HOST_EVENT_HANG_DETECT is triggered */
zassert_true(host_is_event_set(EC_HOST_EVENT_HANG_DETECT));
}
/* Shutdown from EC, S0 -> S5 (8 secs) -> G3 */
ZTEST(power_seq, test_force_shutdown)
{
const struct gpio_dt_spec *sys_rst_odl =
gpio_get_dt_spec(GPIO_SYS_RST_ODL);
const struct gpio_dt_spec *ec_pmic_en_odl =
gpio_get_dt_spec(GPIO_EC_PMIC_EN_ODL);
gpio_set_level(GPIO_SYS_RST_ODL, 1);
gpio_set_level(GPIO_EC_PMIC_EN_ODL, 1);
/* Boot AP */
set_signal_state(POWER_S0);
zassert_equal(power_get_state(), POWER_S0);
/* Verify that ec resets ap and holds power button */
chipset_force_shutdown(CHIPSET_SHUTDOWN_CONSOLE_CMD);
zassert_equal(gpio_emul_output_get(sys_rst_odl->port, sys_rst_odl->pin),
0);
zassert_equal(gpio_emul_output_get(ec_pmic_en_odl->port,
ec_pmic_en_odl->pin),
0);
/* Emulate AP power down (hw state G3, sw state unchanged),
* Verify power state stops at S5
*/
set_signal_state(POWER_G3);
zassert_equal(power_get_state(), POWER_S5);
/* Wait 10 seconds for power button release and drop to G3 */
k_sleep(K_SECONDS(10));
zassert_equal(gpio_emul_output_get(sys_rst_odl->port, sys_rst_odl->pin),
0);
zassert_equal(gpio_emul_output_get(ec_pmic_en_odl->port,
ec_pmic_en_odl->pin),
1);
zassert_equal(power_get_state(), POWER_G3);
}
/* Shutdown from AP, S0 -> G3 */
ZTEST(power_seq, test_force_shutdown_button)
{
const struct gpio_dt_spec *sys_rst_odl =
gpio_get_dt_spec(GPIO_SYS_RST_ODL);
const struct gpio_dt_spec *ec_pmic_en_odl =
gpio_get_dt_spec(GPIO_EC_PMIC_EN_ODL);
gpio_set_level(GPIO_SYS_RST_ODL, 1);
gpio_set_level(GPIO_EC_PMIC_EN_ODL, 1);
/* Boot AP */
set_signal_state(POWER_S0);
zassert_equal(power_get_state(), POWER_S0);
power_button_simulate_press(10000); /* 10 seconds */
k_sleep(K_SECONDS(2)); /* AP off after 2 seconds */
set_signal_state(POWER_G3);
zassert_equal(gpio_emul_output_get(sys_rst_odl->port, sys_rst_odl->pin),
0);
zassert_equal(gpio_emul_output_get(ec_pmic_en_odl->port,
ec_pmic_en_odl->pin),
1);
zassert_equal(power_get_state(), POWER_G3);
k_sleep(K_SECONDS(10)); /* Wait for power button release */
}
/* AP reset (S0 -> S0).
* Verify power state doesn't change during reset.
*/
ZTEST(power_seq, test_chipset_reset)
{
const struct gpio_dt_spec *ap_ec_warm_rst_req =
gpio_get_dt_spec(GPIO_AP_EC_WARM_RST_REQ);
const struct gpio_dt_spec *ap_ec_sysrst_odl =
gpio_get_dt_spec(GPIO_AP_EC_SYSRST_ODL);
/* Boot AP */
set_signal_state(POWER_S0);
zassert_equal(power_get_state(), POWER_S0);
RESET_FAKE(chipset_resume_hook);
/* Clear reset reason */
report_ap_reset(CHIPSET_RESET_UNKNOWN);
/* Trigger AP reboot */
gpio_emul_input_set(ap_ec_warm_rst_req->port, ap_ec_warm_rst_req->pin,
0);
gpio_emul_input_set(ap_ec_warm_rst_req->port, ap_ec_warm_rst_req->pin,
1);
/* Simulate sysrst toggle */
gpio_emul_input_set(ap_ec_sysrst_odl->port, ap_ec_sysrst_odl->pin, 0);
gpio_emul_input_set(ap_ec_sysrst_odl->port, ap_ec_sysrst_odl->pin, 1);
k_sleep(K_SECONDS(1));
/* Back to S0, verify that resume hook is not triggered */
zassert_equal(power_get_state(), POWER_S0);
zassert_equal(chipset_resume_hook_fake.call_count, 0);
/* Also verify that chipset_reset_request_interrupt is called by
* checking its side-effect
*/
zassert_equal(chipset_get_shutdown_reason(), CHIPSET_RESET_AP_REQ);
}
/* AP reset during suspend (S3 -> S0).
* Verify state reaches S0 with resume hook triggered.
*/
ZTEST(power_seq, test_chipset_reset_in_s3)
{
const struct gpio_dt_spec *ap_ec_warm_rst_req =
gpio_get_dt_spec(GPIO_AP_EC_WARM_RST_REQ);
const struct gpio_dt_spec *ap_ec_sysrst_odl =
gpio_get_dt_spec(GPIO_AP_EC_SYSRST_ODL);
/* Boot AP */
set_signal_state(POWER_S3);
zassert_equal(power_get_state(), POWER_S3);
RESET_FAKE(chipset_resume_hook);
/* Clear reset reason */
report_ap_reset(CHIPSET_RESET_UNKNOWN);
/* Trigger AP reboot */
gpio_emul_input_set(ap_ec_warm_rst_req->port, ap_ec_warm_rst_req->pin,
0);
gpio_emul_input_set(ap_ec_warm_rst_req->port, ap_ec_warm_rst_req->pin,
1);
/* Simulate sysrst toggle */
gpio_emul_input_set(ap_ec_sysrst_odl->port, ap_ec_sysrst_odl->pin, 0);
gpio_emul_input_set(ap_ec_sysrst_odl->port, ap_ec_sysrst_odl->pin, 1);
set_signal_state(POWER_S0);
/* Back to S0, verify that resume hook is triggered */
zassert_equal(power_get_state(), POWER_S0);
zassert_equal(chipset_resume_hook_fake.call_count, 1);
/* Also verify that chipset_reset_request_interrupt is called by
* checking its side-effect
*/
zassert_equal(chipset_get_shutdown_reason(), CHIPSET_RESET_AP_REQ);
}
static void power_chipset_init_subtest(enum power_state signal_state,
bool jumped_late, uint32_t reset_flags,
enum power_state expected_state,
int line)
{
set_signal_state(signal_state);
system_jumped_late_fake.return_val = jumped_late;
system_common_reset_state();
system_set_reset_flags(reset_flags);
power_set_state(power_chipset_init());
RESET_FAKE(chipset_pre_init_hook);
task_wake(TASK_ID_CHIPSET);
k_sleep(K_SECONDS(1));
if (signal_state == expected_state) {
/* Expect nothing changed */
zassert_equal(chipset_pre_init_hook_fake.call_count, 0,
"test_power_chipset_init line %d failed", line);
zassert_equal(power_get_state(), expected_state);
} else if (expected_state == POWER_S0 && signal_state == POWER_G3) {
/* Expect boot to S0 and fail at S5->S3 */
zassert_equal(chipset_pre_init_hook_fake.call_count, 1,
"test_power_chipset_init line %d failed", line);
} else {
zassert_unreachable();
}
}
/* Verify initial state decision logic.
* Combination that don't make sense (e.g. wake from hibernate but signal
* state is already S0) are skipped.
*/
ZTEST(power_seq, test_power_chipset_init)
{
const struct gpio_dt_spec *ac_present =
gpio_get_dt_spec(GPIO_AC_PRESENT);
/* system_jumped_late => ignore all flags and boot to S0 */
power_chipset_init_subtest(POWER_G3, true, 0, POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_S0, true, 0, POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_G3, true, EC_RESET_FLAG_AP_OFF,
POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_S0, true, EC_RESET_FLAG_AP_OFF,
POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_G3, true, EC_RESET_FLAG_HIBERNATE,
POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_S0, true, EC_RESET_FLAG_HIBERNATE,
POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_G3, true, EC_RESET_FLAG_AP_IDLE,
POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_S0, true, EC_RESET_FLAG_AP_IDLE,
POWER_S0, __LINE__);
/* No reset flag => always boot to S0 */
power_chipset_init_subtest(POWER_G3, false, 0, POWER_S0, __LINE__);
power_chipset_init_subtest(POWER_S0, false, 0, POWER_S0, __LINE__);
/* AP off => stay at G3 */
power_chipset_init_subtest(POWER_G3, false, EC_RESET_FLAG_AP_OFF,
POWER_G3, __LINE__);
/* Boot from hibernate => stay at G3 */
gpio_emul_input_set(ac_present->port, ac_present->pin, 1);
power_chipset_init_subtest(POWER_G3, false, EC_RESET_FLAG_HIBERNATE,
POWER_G3, __LINE__);
/* AP_IDLE => keep current state */
power_chipset_init_subtest(POWER_G3, false, EC_RESET_FLAG_AP_IDLE,
POWER_G3, __LINE__);
power_chipset_init_subtest(POWER_S0, false, EC_RESET_FLAG_AP_IDLE,
POWER_S0, __LINE__);
}
ZTEST_SUITE(power_seq, krabby_predicate_post_main, NULL, power_seq_before, NULL,
NULL);
|
