blob: b7015d9f38ddf6c308b6c6355c4ac02e0266c1fe [file] [log] [blame]
Simon Glass1c721752021-03-07 17:34:47 -07001// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Copyright 2021 Google LLC
4 * Written by Simon Glass <sjg@chromium.org>
5 */
6
Tom Rinid678a592024-05-18 20:20:43 -06007#include <common.h>
Simon Glass5ea894a2022-10-29 19:47:08 -06008#include <blk.h>
Simon Glass1c721752021-03-07 17:34:47 -07009#include <console.h>
Stefan Roeseaf042c22022-09-02 13:57:54 +020010#include <cyclic.h>
Simon Glassd8ed2342021-03-07 17:34:50 -070011#include <dm.h>
Simon Glass7d026452022-03-04 08:43:01 -070012#include <event.h>
Simon Glass70dd8862023-01-17 10:47:28 -070013#include <net.h>
Simon Glass8d468a12022-09-06 20:27:11 -060014#include <of_live.h>
Simon Glass0e4b6972022-09-06 20:27:05 -060015#include <os.h>
Simon Glassee88ba72022-09-06 20:27:19 -060016#include <dm/ofnode.h>
Simon Glassd8ed2342021-03-07 17:34:50 -070017#include <dm/root.h>
Simon Glassc79705e2021-03-07 17:34:58 -070018#include <dm/test.h>
Simon Glasse77615d2021-03-07 17:34:59 -070019#include <dm/uclass-internal.h>
Simon Glass1c721752021-03-07 17:34:47 -070020#include <test/test.h>
Simon Glassd8ed2342021-03-07 17:34:50 -070021#include <test/ut.h>
Simon Glass0e4b6972022-09-06 20:27:05 -060022#include <u-boot/crc.h>
Simon Glass1c721752021-03-07 17:34:47 -070023
Simon Glass30a0d202021-03-07 17:34:49 -070024DECLARE_GLOBAL_DATA_PTR;
25
Simon Glass0e4b6972022-09-06 20:27:05 -060026/**
27 * enum fdtchk_t - what to do with the device tree (gd->fdt_blob)
28 *
29 * This affects what happens with the device tree before and after a test
30 *
31 * @FDTCHK_NONE: Do nothing
32 * @FDTCHK_CHECKSUM: Take a checksum of the FDT before the test runs and
33 * compare it afterwards to detect any changes
34 * @FDTCHK_COPY: Make a copy of the FDT and restore it afterwards
35 */
36enum fdtchk_t {
37 FDTCHK_NONE,
38 FDTCHK_CHECKSUM,
39 FDTCHK_COPY,
40};
41
42/**
43 * fdt_action() - get the required action for the FDT
44 *
45 * @return the action that should be taken for this build
46 */
47static enum fdtchk_t fdt_action(void)
48{
Simon Glass0e4b6972022-09-06 20:27:05 -060049 /* For sandbox SPL builds, do nothing */
Simon Glassd5774592023-02-22 09:34:12 -070050 if (IS_ENABLED(CONFIG_SANDBOX) && IS_ENABLED(CONFIG_SPL_BUILD))
Simon Glass0e4b6972022-09-06 20:27:05 -060051 return FDTCHK_NONE;
52
Simon Glassd5774592023-02-22 09:34:12 -070053 /* Do a copy for sandbox (but only the U-Boot build, not SPL) */
54 if (IS_ENABLED(CONFIG_SANDBOX))
55 return FDTCHK_COPY;
56
Simon Glass0e4b6972022-09-06 20:27:05 -060057 /* For all other boards, do a checksum */
58 return FDTCHK_CHECKSUM;
59}
60
Simon Glassfe806862021-03-07 17:35:04 -070061/* This is valid when a test is running, NULL otherwise */
62static struct unit_test_state *cur_test_state;
63
64struct unit_test_state *test_get_state(void)
65{
66 return cur_test_state;
67}
68
69void test_set_state(struct unit_test_state *uts)
70{
71 cur_test_state = uts;
72}
73
Simon Glassc79705e2021-03-07 17:34:58 -070074/**
75 * dm_test_pre_run() - Get ready to run a driver model test
76 *
77 * This clears out the driver model data structures. For sandbox it resets the
78 * state structure
79 *
80 * @uts: Test state
81 */
82static int dm_test_pre_run(struct unit_test_state *uts)
83{
84 bool of_live = uts->of_live;
85
Simon Glasseb6e9032022-09-06 20:27:06 -060086 if (of_live && (gd->flags & GD_FLG_FDT_CHANGED)) {
87 printf("Cannot run live tree test as device tree changed\n");
88 return -EFAULT;
89 }
Simon Glassc79705e2021-03-07 17:34:58 -070090 uts->root = NULL;
91 uts->testdev = NULL;
92 uts->force_fail_alloc = false;
93 uts->skip_post_probe = false;
Simon Glass0e4b6972022-09-06 20:27:05 -060094 if (fdt_action() == FDTCHK_CHECKSUM)
95 uts->fdt_chksum = crc8(0, gd->fdt_blob,
96 fdt_totalsize(gd->fdt_blob));
Simon Glassc79705e2021-03-07 17:34:58 -070097 gd->dm_root = NULL;
Simon Glass62d63832022-09-06 20:27:00 -060098 malloc_disable_testing();
Simon Glass719d2862021-07-05 16:32:43 -060099 if (CONFIG_IS_ENABLED(UT_DM) && !CONFIG_IS_ENABLED(OF_PLATDATA))
Simon Glassc79705e2021-03-07 17:34:58 -0700100 memset(dm_testdrv_op_count, '\0', sizeof(dm_testdrv_op_count));
Simon Glassd4a15922021-03-25 10:44:33 +1300101 arch_reset_for_test();
Simon Glassc79705e2021-03-07 17:34:58 -0700102
103 /* Determine whether to make the live tree available */
104 gd_set_of_root(of_live ? uts->of_root : NULL);
Simon Glassee88ba72022-09-06 20:27:19 -0600105 oftree_reset();
Simon Glassc79705e2021-03-07 17:34:58 -0700106 ut_assertok(dm_init(of_live));
107 uts->root = dm_root();
108
109 return 0;
110}
111
Simon Glasse77615d2021-03-07 17:34:59 -0700112static int dm_test_post_run(struct unit_test_state *uts)
113{
114 int id;
115
Simon Glass0e4b6972022-09-06 20:27:05 -0600116 if (gd->fdt_blob) {
117 switch (fdt_action()) {
118 case FDTCHK_COPY:
119 memcpy((void *)gd->fdt_blob, uts->fdt_copy, uts->fdt_size);
120 break;
121 case FDTCHK_CHECKSUM: {
122 uint chksum;
123
124 chksum = crc8(0, gd->fdt_blob, fdt_totalsize(gd->fdt_blob));
Simon Glasseb6e9032022-09-06 20:27:06 -0600125 if (chksum != uts->fdt_chksum) {
126 /*
127 * We cannot run any more tests that need the
128 * live tree, since its strings point into the
129 * flat tree, which has changed. This likely
130 * means that at least some of the pointers from
131 * the live tree point to different things
132 */
Simon Glass0e4b6972022-09-06 20:27:05 -0600133 printf("Device tree changed: cannot run live tree tests\n");
Simon Glasseb6e9032022-09-06 20:27:06 -0600134 gd->flags |= GD_FLG_FDT_CHANGED;
135 }
Simon Glass0e4b6972022-09-06 20:27:05 -0600136 break;
137 }
138 case FDTCHK_NONE:
139 break;
140 }
141 }
142
Simon Glasse8c023c2021-03-15 17:25:21 +1300143 /*
144 * With of-platdata-inst the uclasses are created at build time. If we
145 * destroy them we cannot get them back since uclass_add() is not
146 * supported. So skip this.
147 */
148 if (!CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
149 for (id = 0; id < UCLASS_COUNT; id++) {
150 struct uclass *uc;
Simon Glasse77615d2021-03-07 17:34:59 -0700151
Simon Glasse8c023c2021-03-15 17:25:21 +1300152 /*
153 * If the uclass doesn't exist we don't want to create
154 * it. So check that here before we call
155 * uclass_find_device().
156 */
157 uc = uclass_find(id);
158 if (!uc)
159 continue;
160 ut_assertok(uclass_destroy(uc));
161 }
Simon Glasse77615d2021-03-07 17:34:59 -0700162 }
163
164 return 0;
165}
166
Simon Glass4b8b27e2021-03-07 17:34:51 -0700167/* Ensure all the test devices are probed */
168static int do_autoprobe(struct unit_test_state *uts)
169{
Michal Suchanekc0648b72022-10-12 21:57:51 +0200170 return uclass_probe_all(UCLASS_TEST);
Simon Glass4b8b27e2021-03-07 17:34:51 -0700171}
172
Simon Glassd2281bb2021-03-07 17:35:03 -0700173/*
174 * ut_test_run_on_flattree() - Check if we should run a test with flat DT
175 *
176 * This skips long/slow tests where there is not much value in running a flat
177 * DT test in addition to a live DT test.
178 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100179 * Return: true to run the given test on the flat device tree
Simon Glassd2281bb2021-03-07 17:35:03 -0700180 */
181static bool ut_test_run_on_flattree(struct unit_test *test)
182{
183 const char *fname = strrchr(test->file, '/') + 1;
184
185 if (!(test->flags & UT_TESTF_DM))
186 return false;
187
188 return !strstr(fname, "video") || strstr(test->name, "video_base");
189}
190
Simon Glassca44ca02021-03-07 17:35:01 -0700191/**
Simon Glassf97f85e2021-03-07 17:35:05 -0700192 * test_matches() - Check if a test should be run
193 *
194 * This checks if the a test should be run. In the normal case of running all
195 * tests, @select_name is NULL.
196 *
197 * @prefix: String prefix for the tests. Any tests that have this prefix will be
198 * printed without the prefix, so that it is easier to see the unique part
Simon Glass84823562021-03-07 17:35:12 -0700199 * of the test name. If NULL, any suite name (xxx_test) is considered to be
200 * a prefix.
Simon Glassf97f85e2021-03-07 17:35:05 -0700201 * @test_name: Name of current test
202 * @select_name: Name of test to run (or NULL for all)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100203 * Return: true to run this test, false to skip it
Simon Glassf97f85e2021-03-07 17:35:05 -0700204 */
205static bool test_matches(const char *prefix, const char *test_name,
206 const char *select_name)
207{
Andy Shevchenkoff232a72021-02-11 16:40:10 +0200208 size_t len;
209
Simon Glassf97f85e2021-03-07 17:35:05 -0700210 if (!select_name)
211 return true;
212
Andy Shevchenkoff232a72021-02-11 16:40:10 +0200213 /* Allow glob expansion in the test name */
214 len = select_name[strlen(select_name) - 1] == '*' ? strlen(select_name) : 0;
215 if (len-- == 1)
216 return true;
217
218 if (!strncmp(test_name, select_name, len))
Simon Glassf97f85e2021-03-07 17:35:05 -0700219 return true;
220
Andy Shevchenko494a5e12021-02-11 16:40:11 +0200221 if (prefix) {
222 /* All tests have this prefix */
223 if (!strncmp(test_name, prefix, strlen(prefix)))
224 test_name += strlen(prefix);
225 } else {
Simon Glass84823562021-03-07 17:35:12 -0700226 const char *p = strstr(test_name, "_test_");
227
228 /* convert xxx_test_yyy to yyy, i.e. remove the suite name */
229 if (p)
Andy Shevchenko494a5e12021-02-11 16:40:11 +0200230 test_name = p + strlen("_test_");
Simon Glass84823562021-03-07 17:35:12 -0700231 }
Simon Glassf97f85e2021-03-07 17:35:05 -0700232
Andy Shevchenkoff232a72021-02-11 16:40:10 +0200233 if (!strncmp(test_name, select_name, len))
Simon Glassf97f85e2021-03-07 17:35:05 -0700234 return true;
235
236 return false;
237}
238
Simon Glass664277f2021-03-07 17:35:08 -0700239/**
Simon Glass1fc9c122021-03-07 17:35:07 -0700240 * ut_list_has_dm_tests() - Check if a list of tests has driver model ones
241 *
242 * @tests: List of tests to run
243 * @count: Number of tests to ru
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100244 * Return: true if any of the tests have the UT_TESTF_DM flag
Simon Glass1fc9c122021-03-07 17:35:07 -0700245 */
246static bool ut_list_has_dm_tests(struct unit_test *tests, int count)
247{
248 struct unit_test *test;
249
250 for (test = tests; test < tests + count; test++) {
251 if (test->flags & UT_TESTF_DM)
252 return true;
253 }
254
255 return false;
256}
257
Simon Glassf97f85e2021-03-07 17:35:05 -0700258/**
Simon Glass664277f2021-03-07 17:35:08 -0700259 * dm_test_restore() Put things back to normal so sandbox works as expected
260 *
261 * @of_root: Value to set for of_root
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100262 * Return: 0 if OK, -ve on error
Simon Glass664277f2021-03-07 17:35:08 -0700263 */
264static int dm_test_restore(struct device_node *of_root)
265{
266 int ret;
267
268 gd_set_of_root(of_root);
269 gd->dm_root = NULL;
270 ret = dm_init(CONFIG_IS_ENABLED(OF_LIVE));
271 if (ret)
272 return ret;
273 dm_scan_plat(false);
274 if (!CONFIG_IS_ENABLED(OF_PLATDATA))
AKASHI Takahiro230038f2023-06-08 09:55:59 +0900275 dm_extended_scan(false);
Simon Glass664277f2021-03-07 17:35:08 -0700276
277 return 0;
278}
279
280/**
Simon Glassca44ca02021-03-07 17:35:01 -0700281 * test_pre_run() - Handle any preparation needed to run a test
282 *
283 * @uts: Test state
284 * @test: Test to prepare for
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100285 * Return: 0 if OK, -EAGAIN to skip this test since some required feature is not
Simon Glassca44ca02021-03-07 17:35:01 -0700286 * available, other -ve on error (meaning that testing cannot likely
287 * continue)
288 */
289static int test_pre_run(struct unit_test_state *uts, struct unit_test *test)
Simon Glassd002a272021-03-07 17:34:48 -0700290{
Simon Glass7d026452022-03-04 08:43:01 -0700291 ut_assertok(event_init());
292
Simon Glass72b524c2021-03-07 17:34:56 -0700293 if (test->flags & UT_TESTF_DM)
Simon Glassc79705e2021-03-07 17:34:58 -0700294 ut_assertok(dm_test_pre_run(uts));
Simon Glass72b524c2021-03-07 17:34:56 -0700295
Simon Glass47ec3ed2021-03-07 17:34:55 -0700296 ut_set_skip_delays(uts, false);
297
Simon Glass19fb3db2021-03-07 17:34:53 -0700298 uts->start = mallinfo();
Simon Glassd002a272021-03-07 17:34:48 -0700299
Simon Glassecb274c2023-01-17 10:47:23 -0700300 if (test->flags & UT_TESTF_SCAN_PDATA)
Simon Glass5a986f32021-03-07 17:34:52 -0700301 ut_assertok(dm_scan_plat(false));
302
Simon Glass4b8b27e2021-03-07 17:34:51 -0700303 if (test->flags & UT_TESTF_PROBE_TEST)
304 ut_assertok(do_autoprobe(uts));
305
Sean Andersoneaf73852023-10-14 16:47:46 -0400306 if (CONFIG_IS_ENABLED(OF_REAL) &&
Simon Glass70dd8862023-01-17 10:47:28 -0700307 (test->flags & UT_TESTF_SCAN_FDT)) {
308 /*
309 * only set this if we know the ethernet uclass will be created
310 */
311 eth_set_enable_bootdevs(test->flags & UT_TESTF_ETH_BOOTDEV);
Simon Glass081bdc52023-01-17 10:48:02 -0700312 test_sf_set_enable_bootdevs(test->flags & UT_TESTF_SF_BOOTDEV);
Simon Glassd8ed2342021-03-07 17:34:50 -0700313 ut_assertok(dm_extended_scan(false));
Simon Glass70dd8862023-01-17 10:47:28 -0700314 }
Simon Glassd8ed2342021-03-07 17:34:50 -0700315
Simon Glassecb274c2023-01-17 10:47:23 -0700316 /*
317 * Do this after FDT scan since dm_scan_other() in bootstd-uclass.c
318 * checks for the existence of bootstd
319 */
320 if (test->flags & UT_TESTF_SCAN_PDATA)
321 ut_assertok(dm_scan_other(false));
322
Simon Glass8d468a12022-09-06 20:27:11 -0600323 if (IS_ENABLED(CONFIG_SANDBOX) && (test->flags & UT_TESTF_OTHER_FDT)) {
324 /* make sure the other FDT is available */
325 ut_assertok(test_load_other_fdt(uts));
326
327 /*
328 * create a new live tree with it for every test, in case a
329 * test modifies the tree
330 */
331 if (of_live_active()) {
332 ut_assertok(unflatten_device_tree(uts->other_fdt,
333 &uts->of_other));
334 }
335 }
336
Simon Glassd002a272021-03-07 17:34:48 -0700337 if (test->flags & UT_TESTF_CONSOLE_REC) {
338 int ret = console_record_reset_enable();
339
340 if (ret) {
341 printf("Skipping: Console recording disabled\n");
342 return -EAGAIN;
343 }
344 }
Simon Glass74524712021-03-07 17:34:54 -0700345 ut_silence_console(uts);
Simon Glassd002a272021-03-07 17:34:48 -0700346
347 return 0;
348}
349
Simon Glassca44ca02021-03-07 17:35:01 -0700350/**
351 * test_post_run() - Handle cleaning up after a test
352 *
353 * @uts: Test state
354 * @test: Test to clean up after
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100355 * Return: 0 if OK, -ve on error (meaning that testing cannot likely continue)
Simon Glassca44ca02021-03-07 17:35:01 -0700356 */
357static int test_post_run(struct unit_test_state *uts, struct unit_test *test)
Simon Glassd002a272021-03-07 17:34:48 -0700358{
Simon Glass74524712021-03-07 17:34:54 -0700359 ut_unsilence_console(uts);
Simon Glasse77615d2021-03-07 17:34:59 -0700360 if (test->flags & UT_TESTF_DM)
361 ut_assertok(dm_test_post_run(uts));
Rasmus Villemoes50128ae2022-10-28 13:50:54 +0200362 ut_assertok(cyclic_unregister_all());
Simon Glass7d026452022-03-04 08:43:01 -0700363 ut_assertok(event_uninit());
Simon Glass30a0d202021-03-07 17:34:49 -0700364
Simon Glass8d468a12022-09-06 20:27:11 -0600365 free(uts->of_other);
366 uts->of_other = NULL;
367
Simon Glass5ea894a2022-10-29 19:47:08 -0600368 blkcache_free();
369
Simon Glassd002a272021-03-07 17:34:48 -0700370 return 0;
371}
372
Simon Glassd2281bb2021-03-07 17:35:03 -0700373/**
Simon Glass1facaad2022-10-20 18:22:48 -0600374 * skip_test() - Handle skipping a test
375 *
376 * @uts: Test state to update
377 * @return -EAGAIN (always)
378 */
379static int skip_test(struct unit_test_state *uts)
380{
381 uts->skip_count++;
382
383 return -EAGAIN;
384}
385
386/**
Simon Glassd2281bb2021-03-07 17:35:03 -0700387 * ut_run_test() - Run a single test
388 *
389 * This runs the test, handling any preparation and clean-up needed. It prints
390 * the name of each test before running it.
391 *
392 * @uts: Test state to update. The caller should ensure that this is zeroed for
393 * the first call to this function. On exit, @uts->fail_count is
394 * incremented by the number of failures (0, one hopes)
395 * @test_name: Test to run
396 * @name: Name of test, possibly skipping a prefix that should not be displayed
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100397 * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
Simon Glassd2281bb2021-03-07 17:35:03 -0700398 * any failed
399 */
400static int ut_run_test(struct unit_test_state *uts, struct unit_test *test,
401 const char *test_name)
Simon Glass99a88fe2021-03-07 17:35:00 -0700402{
Simon Glassca44ca02021-03-07 17:35:01 -0700403 const char *fname = strrchr(test->file, '/') + 1;
404 const char *note = "";
Simon Glass99a88fe2021-03-07 17:35:00 -0700405 int ret;
406
Simon Glassca44ca02021-03-07 17:35:01 -0700407 if ((test->flags & UT_TESTF_DM) && !uts->of_live)
408 note = " (flat tree)";
409 printf("Test: %s: %s%s\n", test_name, fname, note);
Simon Glass99a88fe2021-03-07 17:35:00 -0700410
Simon Glassfe806862021-03-07 17:35:04 -0700411 /* Allow access to test state from drivers */
412 test_set_state(uts);
413
Simon Glass99a88fe2021-03-07 17:35:00 -0700414 ret = test_pre_run(uts, test);
415 if (ret == -EAGAIN)
Simon Glass1facaad2022-10-20 18:22:48 -0600416 return skip_test(uts);
Simon Glass99a88fe2021-03-07 17:35:00 -0700417 if (ret)
418 return ret;
419
Simon Glass1facaad2022-10-20 18:22:48 -0600420 ret = test->func(uts);
421 if (ret == -EAGAIN)
422 skip_test(uts);
Simon Glass99a88fe2021-03-07 17:35:00 -0700423
424 ret = test_post_run(uts, test);
425 if (ret)
426 return ret;
427
Simon Glassfe806862021-03-07 17:35:04 -0700428 test_set_state( NULL);
429
Simon Glass99a88fe2021-03-07 17:35:00 -0700430 return 0;
431}
432
Simon Glassf97f85e2021-03-07 17:35:05 -0700433/**
434 * ut_run_test_live_flat() - Run a test with both live and flat tree
435 *
436 * This calls ut_run_test() with livetree enabled, which is the standard setup
437 * for runnig tests. Then, for driver model test, it calls it again with
438 * livetree disabled. This allows checking of flattree being used when OF_LIVE
439 * is enabled, as is the case in U-Boot proper before relocation, as well as in
440 * SPL.
441 *
442 * @uts: Test state to update. The caller should ensure that this is zeroed for
443 * the first call to this function. On exit, @uts->fail_count is
444 * incremented by the number of failures (0, one hopes)
445 * @test: Test to run
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100446 * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
Simon Glassf97f85e2021-03-07 17:35:05 -0700447 * any failed
448 */
449static int ut_run_test_live_flat(struct unit_test_state *uts,
Simon Glassf7a68d22022-10-29 19:47:09 -0600450 struct unit_test *test)
Simon Glassd2281bb2021-03-07 17:35:03 -0700451{
452 int runs;
453
Simon Glass8d468a12022-09-06 20:27:11 -0600454 if ((test->flags & UT_TESTF_OTHER_FDT) && !IS_ENABLED(CONFIG_SANDBOX))
Simon Glass1facaad2022-10-20 18:22:48 -0600455 return skip_test(uts);
Simon Glass8d468a12022-09-06 20:27:11 -0600456
Simon Glassd2281bb2021-03-07 17:35:03 -0700457 /* Run with the live tree if possible */
458 runs = 0;
459 if (CONFIG_IS_ENABLED(OF_LIVE)) {
Simon Glass7c14dc72022-09-06 20:26:59 -0600460 if (!(test->flags & UT_TESTF_FLAT_TREE)) {
Simon Glassd2281bb2021-03-07 17:35:03 -0700461 uts->of_live = true;
462 ut_assertok(ut_run_test(uts, test, test->name));
463 runs++;
464 }
465 }
466
467 /*
Simon Glass8d468a12022-09-06 20:27:11 -0600468 * Run with the flat tree if:
469 * - it is not marked for live tree only
470 * - it doesn't require the 'other' FDT when OFNODE_MULTI_TREE_MAX is
471 * not enabled (since flat tree can only support a single FDT in that
472 * case
473 * - we couldn't run it with live tree,
474 * - it is a core test (dm tests except video)
475 * - the FDT is still valid and has not been updated by an earlier test
476 * (for sandbox we handle this by copying the tree, but not for other
477 * boards)
Simon Glassd2281bb2021-03-07 17:35:03 -0700478 */
Sean Anderson3f876cb2023-09-29 12:06:54 -0400479 if ((!CONFIG_IS_ENABLED(OF_LIVE) ||
480 (test->flags & UT_TESTF_SCAN_FDT)) &&
Simon Glass6ec51782023-07-12 09:04:30 -0600481 !(test->flags & UT_TESTF_LIVE_TREE) &&
Simon Glass8d468a12022-09-06 20:27:11 -0600482 (CONFIG_IS_ENABLED(OFNODE_MULTI_TREE) ||
483 !(test->flags & UT_TESTF_OTHER_FDT)) &&
Simon Glasseb6e9032022-09-06 20:27:06 -0600484 (!runs || ut_test_run_on_flattree(test)) &&
485 !(gd->flags & GD_FLG_FDT_CHANGED)) {
Simon Glassd2281bb2021-03-07 17:35:03 -0700486 uts->of_live = false;
487 ut_assertok(ut_run_test(uts, test, test->name));
488 runs++;
489 }
490
491 return 0;
492}
493
Simon Glassf97f85e2021-03-07 17:35:05 -0700494/**
495 * ut_run_tests() - Run a set of tests
496 *
497 * This runs the tests, handling any preparation and clean-up needed. It prints
498 * the name of each test before running it.
499 *
500 * @uts: Test state to update. The caller should ensure that this is zeroed for
501 * the first call to this function. On exit, @uts->fail_count is
502 * incremented by the number of failures (0, one hopes)
503 * @prefix: String prefix for the tests. Any tests that have this prefix will be
504 * printed without the prefix, so that it is easier to see the unique part
505 * of the test name. If NULL, no prefix processing is done
506 * @tests: List of tests to run
507 * @count: Number of tests to run
508 * @select_name: Name of a single test to run (from the list provided). If NULL
509 * then all tests are run
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100510 * Return: 0 if all tests passed, -ENOENT if test @select_name was not found,
Simon Glassf97f85e2021-03-07 17:35:05 -0700511 * -EBADF if any failed
512 */
513static int ut_run_tests(struct unit_test_state *uts, const char *prefix,
514 struct unit_test *tests, int count,
Simon Glassd1b46592022-10-29 19:47:13 -0600515 const char *select_name, const char *test_insert)
Simon Glass1c721752021-03-07 17:34:47 -0700516{
Simon Glassd1b46592022-10-29 19:47:13 -0600517 struct unit_test *test, *one;
Simon Glass1c721752021-03-07 17:34:47 -0700518 int found = 0;
Simon Glassd1b46592022-10-29 19:47:13 -0600519 int pos = 0;
520 int upto;
Simon Glass1c721752021-03-07 17:34:47 -0700521
Simon Glassd1b46592022-10-29 19:47:13 -0600522 one = NULL;
523 if (test_insert) {
524 char *p;
525
526 pos = dectoul(test_insert, NULL);
527 p = strchr(test_insert, ':');
528 if (p)
529 p++;
530
531 for (test = tests; test < tests + count; test++) {
532 if (!strcmp(p, test->name))
533 one = test;
534 }
535 }
536
537 for (upto = 0, test = tests; test < tests + count; test++, upto++) {
Simon Glass1c721752021-03-07 17:34:47 -0700538 const char *test_name = test->name;
Simon Glassea94d052022-08-01 07:58:45 -0600539 int ret, i, old_fail_count;
Simon Glass1c721752021-03-07 17:34:47 -0700540
Simon Glassf97f85e2021-03-07 17:35:05 -0700541 if (!test_matches(prefix, test_name, select_name))
Simon Glass1c721752021-03-07 17:34:47 -0700542 continue;
Simon Glasscbd71fa2022-10-20 18:22:50 -0600543
544 if (test->flags & UT_TESTF_MANUAL) {
545 int len;
546
547 /*
548 * manual tests must have a name ending "_norun" as this
549 * is how pytest knows to skip them. See
550 * generate_ut_subtest() for this check.
551 */
552 len = strlen(test_name);
553 if (len < 6 || strcmp(test_name + len - 6, "_norun")) {
554 printf("Test %s is manual so must have a name ending in _norun\n",
555 test_name);
556 uts->fail_count++;
557 return -EBADF;
558 }
559 if (!uts->force_run) {
560 if (select_name) {
561 printf("Test %s skipped as it is manual (use -f to run it)\n",
562 test_name);
563 }
564 continue;
565 }
566 }
Simon Glassea94d052022-08-01 07:58:45 -0600567 old_fail_count = uts->fail_count;
Simon Glassd1b46592022-10-29 19:47:13 -0600568
569 if (one && upto == pos) {
570 ret = ut_run_test_live_flat(uts, one);
571 if (uts->fail_count != old_fail_count) {
572 printf("Test %s failed %d times (position %d)\n",
573 one->name,
574 uts->fail_count - old_fail_count, pos);
575 }
576 return -EBADF;
577 }
578
Simon Glassea94d052022-08-01 07:58:45 -0600579 for (i = 0; i < uts->runs_per_test; i++)
Simon Glassf7a68d22022-10-29 19:47:09 -0600580 ret = ut_run_test_live_flat(uts, test);
Simon Glassea94d052022-08-01 07:58:45 -0600581 if (uts->fail_count != old_fail_count) {
582 printf("Test %s failed %d times\n", select_name,
583 uts->fail_count - old_fail_count);
584 }
Simon Glass1c721752021-03-07 17:34:47 -0700585 found++;
Simon Glassd002a272021-03-07 17:34:48 -0700586 if (ret == -EAGAIN)
587 continue;
588 if (ret)
589 return ret;
Simon Glass1c721752021-03-07 17:34:47 -0700590 }
591 if (select_name && !found)
592 return -ENOENT;
593
594 return uts->fail_count ? -EBADF : 0;
595}
596
597int ut_run_list(const char *category, const char *prefix,
Simon Glassea94d052022-08-01 07:58:45 -0600598 struct unit_test *tests, int count, const char *select_name,
Simon Glassd1b46592022-10-29 19:47:13 -0600599 int runs_per_test, bool force_run, const char *test_insert)
Simon Glass1c721752021-03-07 17:34:47 -0700600{
601 struct unit_test_state uts = { .fail_count = 0 };
Simon Glass664277f2021-03-07 17:35:08 -0700602 bool has_dm_tests = false;
Simon Glass1c721752021-03-07 17:34:47 -0700603 int ret;
604
Simon Glass1fc9c122021-03-07 17:35:07 -0700605 if (!CONFIG_IS_ENABLED(OF_PLATDATA) &&
606 ut_list_has_dm_tests(tests, count)) {
Simon Glass664277f2021-03-07 17:35:08 -0700607 has_dm_tests = true;
Simon Glass1fc9c122021-03-07 17:35:07 -0700608 /*
609 * If we have no device tree, or it only has a root node, then
610 * these * tests clearly aren't going to work...
611 */
612 if (!gd->fdt_blob || fdt_next_node(gd->fdt_blob, 0, NULL) < 0) {
613 puts("Please run with test device tree:\n"
614 " ./u-boot -d arch/sandbox/dts/test.dtb\n");
615 return CMD_RET_FAILURE;
616 }
617 }
618
Simon Glass1c721752021-03-07 17:34:47 -0700619 if (!select_name)
620 printf("Running %d %s tests\n", count, category);
621
Simon Glassf97f85e2021-03-07 17:35:05 -0700622 uts.of_root = gd_of_root();
Simon Glassea94d052022-08-01 07:58:45 -0600623 uts.runs_per_test = runs_per_test;
Simon Glass0e4b6972022-09-06 20:27:05 -0600624 if (fdt_action() == FDTCHK_COPY && gd->fdt_blob) {
625 uts.fdt_size = fdt_totalsize(gd->fdt_blob);
626 uts.fdt_copy = os_malloc(uts.fdt_size);
627 if (!uts.fdt_copy) {
628 printf("Out of memory for device tree copy\n");
629 return -ENOMEM;
630 }
631 memcpy(uts.fdt_copy, gd->fdt_blob, uts.fdt_size);
632 }
Simon Glasscbd71fa2022-10-20 18:22:50 -0600633 uts.force_run = force_run;
Simon Glassd1b46592022-10-29 19:47:13 -0600634 ret = ut_run_tests(&uts, prefix, tests, count, select_name,
635 test_insert);
Simon Glass1c721752021-03-07 17:34:47 -0700636
Simon Glass0e4b6972022-09-06 20:27:05 -0600637 /* Best efforts only...ignore errors */
638 if (has_dm_tests)
639 dm_test_restore(uts.of_root);
Simon Glass8d468a12022-09-06 20:27:11 -0600640 if (IS_ENABLED(CONFIG_SANDBOX)) {
Simon Glass0e4b6972022-09-06 20:27:05 -0600641 os_free(uts.fdt_copy);
Simon Glass8d468a12022-09-06 20:27:11 -0600642 os_free(uts.other_fdt);
643 }
Simon Glass0e4b6972022-09-06 20:27:05 -0600644
Simon Glass1facaad2022-10-20 18:22:48 -0600645 if (uts.skip_count)
646 printf("Skipped: %d, ", uts.skip_count);
Simon Glass1c721752021-03-07 17:34:47 -0700647 if (ret == -ENOENT)
648 printf("Test '%s' not found\n", select_name);
649 else
650 printf("Failures: %d\n", uts.fail_count);
651
Simon Glass1c721752021-03-07 17:34:47 -0700652 return ret;
653}