]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
2e7d35d2 SG |
2 | /* |
3 | * Copyright (c) 2013 Google, Inc. | |
2e7d35d2 SG |
4 | */ |
5 | ||
6 | #ifndef __DM_TEST_H | |
7 | #define __DM_TEST_H | |
8 | ||
3c2503ee SG |
9 | struct udevice; |
10 | ||
2e7d35d2 SG |
11 | /** |
12 | * struct dm_test_cdata - configuration data for test instance | |
13 | * | |
14 | * @ping_add: Amonut to add each time we get a ping | |
15 | * @base: Base address of this device | |
16 | */ | |
17 | struct dm_test_pdata { | |
18 | int ping_add; | |
19 | uint32_t base; | |
20 | }; | |
21 | ||
22 | /** | |
23 | * struct test_ops - Operations supported by the test device | |
24 | * | |
25 | * @ping: Ping operation | |
26 | * @dev: Device to operate on | |
27 | * @pingval: Value to ping the device with | |
28 | * @pingret: Returns resulting value from driver | |
185f812c | 29 | * Return: 0 if OK, -ve on error |
2e7d35d2 SG |
30 | */ |
31 | struct test_ops { | |
54c5d08a | 32 | int (*ping)(struct udevice *dev, int pingval, int *pingret); |
2e7d35d2 SG |
33 | }; |
34 | ||
35 | /* Operations that our test driver supports */ | |
36 | enum { | |
37 | DM_TEST_OP_BIND = 0, | |
38 | DM_TEST_OP_UNBIND, | |
39 | DM_TEST_OP_PROBE, | |
40 | DM_TEST_OP_REMOVE, | |
41 | ||
42 | /* For uclass */ | |
43 | DM_TEST_OP_POST_BIND, | |
44 | DM_TEST_OP_PRE_UNBIND, | |
02c07b37 | 45 | DM_TEST_OP_PRE_PROBE, |
2e7d35d2 SG |
46 | DM_TEST_OP_POST_PROBE, |
47 | DM_TEST_OP_PRE_REMOVE, | |
48 | DM_TEST_OP_INIT, | |
49 | DM_TEST_OP_DESTROY, | |
50 | ||
51 | DM_TEST_OP_COUNT, | |
52 | }; | |
53 | ||
54 | /* Test driver types */ | |
55 | enum { | |
56 | DM_TEST_TYPE_FIRST = 0, | |
57 | DM_TEST_TYPE_SECOND, | |
50162348 SG |
58 | |
59 | DM_TEST_TYPE_COUNT, | |
2e7d35d2 SG |
60 | }; |
61 | ||
62 | /* The number added to the ping total on each probe */ | |
63 | #define DM_TEST_START_TOTAL 5 | |
64 | ||
65 | /** | |
66 | * struct dm_test_priv - private data for the test devices | |
67 | */ | |
68 | struct dm_test_priv { | |
69 | int ping_total; | |
70 | int op_count[DM_TEST_OP_COUNT]; | |
83c7e434 SG |
71 | int uclass_flag; |
72 | int uclass_total; | |
d92878aa | 73 | int uclass_postp; |
2e7d35d2 SG |
74 | }; |
75 | ||
ea74c951 SG |
76 | /* struct dm_test_uc_priv - private data for the testdrv uclass */ |
77 | struct dm_test_uc_priv { | |
78 | int dummy; | |
79 | }; | |
80 | ||
2e7d35d2 SG |
81 | /** |
82 | * struct dm_test_perdev_class_priv - private per-device data for test uclass | |
83 | */ | |
84 | struct dm_test_uclass_perdev_priv { | |
85 | int base_add; | |
86 | }; | |
87 | ||
88 | /** | |
89 | * struct dm_test_uclass_priv - private data for test uclass | |
90 | */ | |
91 | struct dm_test_uclass_priv { | |
92 | int total_add; | |
93 | }; | |
94 | ||
53c20beb SG |
95 | /** |
96 | * struct dm_test_uclass_plat - private plat data for test uclass | |
97 | */ | |
98 | struct dm_test_uclass_plat { | |
99 | char dummy[32]; | |
100 | }; | |
101 | ||
e59f458d SG |
102 | /** |
103 | * struct dm_test_parent_data - parent's information on each child | |
104 | * | |
105 | * @sum: Test value used to check parent data works correctly | |
a327dee0 | 106 | * @flag: Used to track calling of parent operations |
83c7e434 | 107 | * @uclass_flag: Used to track calling of parent operations by uclass |
e59f458d SG |
108 | */ |
109 | struct dm_test_parent_data { | |
110 | int sum; | |
a327dee0 | 111 | int flag; |
e59f458d SG |
112 | }; |
113 | ||
754e71e8 PM |
114 | /* Test values for test device's uclass platform data */ |
115 | enum { | |
116 | TEST_UC_PDATA_INTVAL1 = 2, | |
117 | TEST_UC_PDATA_INTVAL2 = 334, | |
118 | TEST_UC_PDATA_INTVAL3 = 789452, | |
119 | }; | |
120 | ||
121 | /** | |
122 | * struct dm_test_uclass_platda - uclass's information on each device | |
123 | * | |
124 | * @intval1: set to TEST_UC_PDATA_INTVAL1 in .post_bind method of test uclass | |
125 | * @intval2: set to TEST_UC_PDATA_INTVAL2 in .post_bind method of test uclass | |
126 | * @intval3: set to TEST_UC_PDATA_INTVAL3 in .post_bind method of test uclass | |
127 | */ | |
128 | struct dm_test_perdev_uc_pdata { | |
129 | int intval1; | |
130 | int intval2; | |
131 | int intval3; | |
132 | }; | |
133 | ||
2e7d35d2 SG |
134 | /* |
135 | * Operation counts for the test driver, used to check that each method is | |
136 | * called correctly | |
137 | */ | |
138 | extern int dm_testdrv_op_count[DM_TEST_OP_COUNT]; | |
139 | ||
e721b882 | 140 | extern struct unit_test_state global_dm_test_state; |
2e7d35d2 | 141 | |
2e7d35d2 | 142 | /* Declare a new driver model test */ |
4bc639ee | 143 | #define DM_TEST(_name, _flags) \ |
30a0d206 | 144 | UNIT_TEST(_name, UT_TESTF_DM | UT_TESTF_CONSOLE_REC | (_flags), dm_test) |
2e7d35d2 | 145 | |
ef453129 SG |
146 | /* |
147 | * struct sandbox_sdl_plat - Platform data for the SDL video driver | |
148 | * | |
149 | * This platform data is needed in tests, so declare it here | |
150 | * | |
151 | * @xres: Width of display in pixels | |
152 | * @yres: Height of display in pixels | |
153 | * @bpix: Log2 of bits per pixel (enum video_log2_bpp) | |
154 | * @rot: Console rotation (0=normal orientation, 1=90 degrees clockwise, | |
155 | * 2=upside down, 3=90 degree counterclockwise) | |
156 | * @vidconsole_drv_name: Name of video console driver (set by tests) | |
157 | * @font_size: Console font size to select (set by tests) | |
158 | */ | |
3c97c4fb SG |
159 | struct sandbox_sdl_plat { |
160 | int xres; | |
161 | int yres; | |
162 | int bpix; | |
163 | int rot; | |
8de536c2 SG |
164 | const char *vidconsole_drv_name; |
165 | int font_size; | |
3c97c4fb SG |
166 | }; |
167 | ||
079ac595 SG |
168 | /** |
169 | * struct dm_test_parent_plat - Used to track state in bus tests | |
170 | * | |
171 | * @count: | |
172 | * @bind_flag: Indicates that the child post-bind method was called | |
173 | * @uclass_bind_flag: Also indicates that the child post-bind method was called | |
174 | */ | |
175 | struct dm_test_parent_plat { | |
176 | int count; | |
177 | int bind_flag; | |
178 | int uclass_bind_flag; | |
179 | }; | |
180 | ||
181 | enum { | |
182 | TEST_FLAG_CHILD_PROBED = 10, | |
183 | TEST_FLAG_CHILD_REMOVED = -7, | |
184 | }; | |
185 | ||
2e7d35d2 | 186 | /* Declare ping methods for the drivers */ |
54c5d08a HS |
187 | int test_ping(struct udevice *dev, int pingval, int *pingret); |
188 | int testfdt_ping(struct udevice *dev, int pingval, int *pingret); | |
2e7d35d2 SG |
189 | |
190 | /** | |
191 | * dm_check_operations() - Check that we can perform ping operations | |
192 | * | |
193 | * This checks that the ping operations work as expected for a device | |
194 | * | |
195 | * @dms: Overall test state | |
196 | * @dev: Device to test | |
197 | * @base: Base address, used to check ping return value | |
198 | * @priv: Pointer to private test information | |
185f812c | 199 | * Return: 0 if OK, -ve on error |
2e7d35d2 | 200 | */ |
e721b882 | 201 | int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, |
2e7d35d2 SG |
202 | uint32_t base, struct dm_test_priv *priv); |
203 | ||
1ca7e206 SG |
204 | /** |
205 | * dm_check_devices() - check the devices respond to operations correctly | |
206 | * | |
207 | * @dms: Overall test state | |
208 | * @num_devices: Number of test devices to check | |
185f812c | 209 | * Return: 0 if OK, -ve on error |
1ca7e206 | 210 | */ |
e721b882 | 211 | int dm_check_devices(struct unit_test_state *uts, int num_devices); |
1ca7e206 | 212 | |
756ac0bb SG |
213 | /** |
214 | * dm_leak_check_start() - Prepare to check for a memory leak | |
215 | * | |
216 | * Call this before allocating memory to record the amount of memory being | |
217 | * used. | |
218 | * | |
219 | * @dms: Overall test state | |
220 | */ | |
e721b882 | 221 | void dm_leak_check_start(struct unit_test_state *uts); |
756ac0bb SG |
222 | |
223 | /** | |
224 | * dm_leak_check_end() - Check that no memory has leaked | |
225 | * | |
226 | * Call this after dm_leak_check_start() and after you have hopefuilly freed | |
227 | * all the memory that was allocated. This function will print an error if | |
228 | * it sees a different amount of total memory allocated than before. | |
229 | * | |
230 | * @dms: Overall test state | |
e721b882 | 231 | */int dm_leak_check_end(struct unit_test_state *uts); |
756ac0bb | 232 | |
2e7d35d2 | 233 | #endif |