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
|
/* Copyright (c) 2013 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.
*/
/* Various utility for unit testing */
#ifndef __CROS_EC_TEST_UTIL_H
#define __CROS_EC_TEST_UTIL_H
#include "common.h"
#include "console.h"
#define RUN_TEST(n) \
do { \
ccprintf("Running %s...", #n); \
cflush(); \
if (n() == EC_SUCCESS) { \
ccputs("OK\n"); \
} else { \
ccputs("Fail\n"); \
__test_error_count++; \
} \
} while (0)
#define TEST_ASSERT(n) \
do { \
if (!(n)) { \
ccprintf("%d: ASSERTION failed: %s\n", __LINE__, #n); \
return EC_ERROR_UNKNOWN; \
} \
} while (0)
#define __ABS(n) ((n) > 0 ? (n) : -(n))
#define TEST_ASSERT_ABS_LESS(n, t) \
do { \
if (__ABS(n) >= t) { \
ccprintf("%d: ASSERT_ABS_LESS failed: abs(%d) is " \
"not less than %d\n", __LINE__, n, t); \
return EC_ERROR_UNKNOWN; \
} \
} while (0)
#define TEST_ASSERT_ARRAY_EQ(s, d, n) \
do { \
int __i; \
for (__i = 0; __i < n; ++__i) \
if ((s)[__i] != (d)[__i]) { \
ccprintf("%d: ASSERT_ARRAY_EQ failed at " \
"index=%d: %d != %d\n", __LINE__, \
__i, (int)(s)[__i], (int)(d)[__i]); \
return EC_ERROR_UNKNOWN; \
} \
} while (0)
#define TEST_CHECK(n) \
do { \
if (n) \
return EC_SUCCESS; \
else \
return EC_ERROR_UNKNOWN; \
} while (0)
/* Mutlistep test states */
enum test_state_t {
TEST_STATE_STEP_1 = 0,
TEST_STATE_STEP_2,
TEST_STATE_STEP_3,
TEST_STATE_STEP_4,
TEST_STATE_STEP_5,
TEST_STATE_STEP_6,
TEST_STATE_STEP_7,
TEST_STATE_STEP_8,
TEST_STATE_STEP_9,
TEST_STATE_PASSED,
TEST_STATE_FAILED,
};
#define TEST_STATE_MASK(x) (1 << (x))
/* Hooks gcov_flush() for test coverage report generation */
void register_test_end_hook(void);
/*
* Test initialization. This is called after all _pre_init() calls and before
* all _init() calls.
*/
void test_init(void);
/* Test entry point */
void run_test(void);
/* Resets test error count */
void test_reset(void);
/* Reports test pass */
void test_pass(void);
/* Reports test failure */
void test_fail(void);
/* Prints test result, including number of failed tests */
void test_print_result(void);
/* Returns the number of failed tests */
int test_get_error_count(void);
/* Simulates host command sent from the host */
int test_send_host_command(int command, int version, const void *params,
int params_size, void *resp, int resp_size);
/* Number of failed tests */
extern int __test_error_count;
/* Simulates UART input */
void uart_inject_char(char *s, int sz);
#define UART_INJECT(s) uart_inject_char(s, strlen(s));
/* Simulates chipset power on */
void test_chipset_on(void);
/* Simulates chipset power off */
void test_chipset_off(void);
/* Start/stop capturing console output */
void test_capture_console(int enabled);
/* Get captured console output */
const char *test_get_captured_console(void);
/*
* Flush emulator status. Must be called before emulator reboots or
* exits.
*/
void emulator_flush(void);
/*
* Entry point of multi-step test.
*
* Depending on current test state, this function runs the corresponding
* test step. This function should be called in a dedicated task on every
* reboot. Also, run_test() is responsible for starting the test by kicking
* that task.
*/
void test_run_multistep(void);
/*
* A function that runs the test step specified in 'state'. This function
* should be defined by all multi-step tests.
*
* @param state TEST_STATE_MASK(x) indicating the step to run.
*/
void test_run_step(uint32_t state);
/* Get the current test state */
uint32_t test_get_state(void);
/*
* Multistep test clean up. If a multi-step test has this function defined,
* it will be called on test end. (i.e. when test passes or fails.)
*/
void test_clean_up(void);
/* Set the next step and reboot */
void test_reboot_to_next_step(enum test_state_t step);
struct test_i2c_read_string_dev {
/* I2C string read handler */
int (*routine)(int port, int slave_addr, int offset, uint8_t *data,
int len);
};
struct test_i2c_read_dev {
/* I2C read handler */
int (*routine)(int port, int slave_addr, int offset, int *data);
};
struct test_i2c_write_dev {
/* I2C write handler */
int (*routine)(int port, int slave_addr, int offset, int data);
};
/**
* Register an I2C 8-bit read function.
*
* When this function is called, it should either perform the desired
* mock functionality, or return EC_ERROR_INVAL to indicate it does
* not respond to the specified port and slave address.
*
* @param routine Function pointer, with the same prototype as i2c_read8()
*/
#define DECLARE_TEST_I2C_READ8(routine) \
const struct test_i2c_read_dev __test_i2c_read8_##routine \
__attribute__((section(".rodata.test_i2c.read8"))) \
= {routine}
/* Register an I2C 8-bit write function. */
#define DECLARE_TEST_I2C_WRITE8(routine) \
const struct test_i2c_write_dev __test_i2c_write8_##routine \
__attribute__((section(".rodata.test_i2c.write8"))) \
= {routine}
/* Register an I2C 16-bit read function. */
#define DECLARE_TEST_I2C_READ16(routine) \
const struct test_i2c_read_dev __test_i2c_read16_##routine \
__attribute__((section(".rodata.test_i2c.read16"))) \
= {routine}
/* Register an I2C 16-bit write function. */
#define DECLARE_TEST_I2C_WRITE16(routine) \
const struct test_i2c_write_dev __test_i2c_write16_##routine \
__attribute__((section(".rodata.test_i2c.write16"))) \
= {routine}
#define DECLARE_TEST_I2C_READ_STRING(routine) \
const struct test_i2c_read_string_dev __test_i2c_rs_##routine \
__attribute__((section(".rodata.test_i2c.read_string"))) \
= {routine}
/*
* Detach an I2C device. Once detached, any read/write command regarding the
* specified port and slave address returns error.
*
* @param port The port that the detached device is connected to
* @param slave_addr The address of the detached device
* @return EC_SUCCESS if detached; EC_ERROR_OVERFLOW if too many devices are
* detached.
*/
int test_detach_i2c(int port, int slave_addr);
/*
* Re-attach an I2C device.
*
* @param port The port that the detached device is connected to
* @param slave_addr The address of the detached device
* @return EC_SUCCESS if re-attached; EC_ERROR_INVAL if the specified device
* is not a detached device.
*/
int test_attach_i2c(int port, int slave_addr);
#endif /* __CROS_EC_TEST_UTIL_H */
|
