test/dm/test-main.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2013 Google, Inc
   4  */
   5
   6 #include <common.h>
   7 #include <command.h>
   8 #include <console.h>
   9 #include <dm.h>
  10 #include <errno.h>
  11 #include <log.h>
  12 #include <malloc.h>
  13 #include <asm/state.h>
  14 #include <dm/test.h>
  15 #include <dm/root.h>
  16 #include <dm/uclass-internal.h>
  17 #include <test/test.h>
  18 #include <test/test.h>
  19 #include <test/ut.h>
  20
  21 DECLARE_GLOBAL_DATA_PTR;
  22
  23 struct unit_test_state global_dm_test_state;
  24 static struct dm_test_state _global_priv_dm_test_state;
  25
  26 /* Get ready for testing */
  27 static int dm_test_init(struct unit_test_state *uts, bool of_live)
  28 {
  29         struct dm_test_state *dms = uts->priv;
  30
  31         memset(dms, '\0', sizeof(*dms));
  32         gd->dm_root = NULL;
  33         memset(dm_testdrv_op_count, '\0', sizeof(dm_testdrv_op_count));
  34         state_reset_for_test(state_get_current());
  35
  36 #ifdef CONFIG_OF_LIVE
  37         /* Determine whether to make the live tree available */
  38         gd->of_root = of_live ? uts->of_root : NULL;
  39 #endif
  40         ut_assertok(dm_init(of_live));
  41         dms->root = dm_root();
  42
  43         return 0;
  44 }
  45
  46 /* Ensure all the test devices are probed */
  47 static int do_autoprobe(struct unit_test_state *uts)
  48 {
  49         struct udevice *dev;
  50         int ret;
  51
  52         /* Scanning the uclass is enough to probe all the devices */
  53         for (ret = uclass_first_device(UCLASS_TEST, &dev);
  54              dev;
  55              ret = uclass_next_device(&dev))
  56                 ;
  57
  58         return ret;
  59 }
  60
  61 static int dm_test_destroy(struct unit_test_state *uts)
  62 {
  63         int id;
  64
  65         for (id = 0; id < UCLASS_COUNT; id++) {
  66                 struct uclass *uc;
  67
  68                 /*
  69                  * If the uclass doesn't exist we don't want to create it. So
  70                  * check that here before we call uclass_find_device().
  71                  */
  72                 uc = uclass_find(id);
  73                 if (!uc)
  74                         continue;
  75                 ut_assertok(uclass_destroy(uc));
  76         }
  77
  78         return 0;
  79 }
  80
  81 static int dm_do_test(struct unit_test_state *uts, struct unit_test *test,
  82                       bool of_live)
  83 {
  84         struct sandbox_state *state = state_get_current();
  85         const char *fname = strrchr(test->file, '/') + 1;
  86
  87         printf("Test: %s: %s%s\n", test->name, fname,
  88                !of_live ? " (flat tree)" : "");
  89         ut_assertok(dm_test_init(uts, of_live));
  90
  91         uts->start = mallinfo();
  92         if (test->flags & UT_TESTF_SCAN_PDATA)
  93                 ut_assertok(dm_scan_platdata(false));
  94         if (test->flags & UT_TESTF_PROBE_TEST)
  95                 ut_assertok(do_autoprobe(uts));
  96         if (test->flags & UT_TESTF_SCAN_FDT)
  97                 ut_assertok(dm_extended_scan_fdt(gd->fdt_blob, false));
  98
  99         /*
 100          * Silence the console and rely on console recording to get
 101          * our output.
 102          */
 103         console_record_reset_enable();
 104         if (!state->show_test_output)
 105                 gd->flags |= GD_FLG_SILENT;
 106         test->func(uts);
 107         gd->flags &= ~(GD_FLG_SILENT | GD_FLG_RECORD);
 108         state_set_skip_delays(false);
 109
 110         ut_assertok(dm_test_destroy(uts));
 111
 112         return 0;
 113 }
 114
 115 /**
 116  * dm_test_run_on_flattree() - Check if we should run a test with flat DT
 117  *
 118  * This skips long/slow tests where there is not much value in running a flat
 119  * DT test in addition to a live DT test.
 120  *
 121  * @return true to run the given test on the flat device tree
 122  */
 123 static bool dm_test_run_on_flattree(struct unit_test *test)
 124 {
 125         const char *fname = strrchr(test->file, '/') + 1;
 126
 127         return !strstr(fname, "video") || strstr(test->name, "video_base");
 128 }
 129
 130 static int dm_test_main(const char *test_name)
 131 {
 132         struct unit_test *tests = ll_entry_start(struct unit_test, dm_test);
 133         const int n_ents = ll_entry_count(struct unit_test, dm_test);
 134         struct unit_test_state *uts = &global_dm_test_state;
 135         struct unit_test *test;
 136         int found;
 137
 138         uts->priv = &_global_priv_dm_test_state;
 139         uts->fail_count = 0;
 140
 141         /*
 142          * If we have no device tree, or it only has a root node, then these
 143          * tests clearly aren't going to work...
 144          */
 145         if (!gd->fdt_blob || fdt_next_node(gd->fdt_blob, 0, NULL) < 0) {
 146                 puts("Please run with test device tree:\n"
 147                      "    ./u-boot -d arch/sandbox/dts/test.dtb\n");
 148                 ut_assert(gd->fdt_blob);
 149         }
 150
 151         if (!test_name)
 152                 printf("Running %d driver model tests\n", n_ents);
 153
 154         found = 0;
 155 #ifdef CONFIG_OF_LIVE
 156         uts->of_root = gd->of_root;
 157 #endif
 158         for (test = tests; test < tests + n_ents; test++) {
 159                 const char *name = test->name;
 160                 int runs;
 161
 162                 /* All tests have this prefix */
 163                 if (!strncmp(name, "dm_test_", 8))
 164                         name += 8;
 165                 if (test_name && strcmp(test_name, name))
 166                         continue;
 167
 168                 /* Run with the live tree if possible */
 169                 runs = 0;
 170                 if (IS_ENABLED(CONFIG_OF_LIVE)) {
 171                         if (!(test->flags & UT_TESTF_FLAT_TREE)) {
 172                                 ut_assertok(dm_do_test(uts, test, true));
 173                                 runs++;
 174                         }
 175                 }
 176
 177                 /*
 178                  * Run with the flat tree if we couldn't run it with live tree,
 179                  * or it is a core test.
 180                  */
 181                 if (!(test->flags & UT_TESTF_LIVE_TREE) &&
 182                     (!runs || dm_test_run_on_flattree(test))) {
 183                         ut_assertok(dm_do_test(uts, test, false));
 184                         runs++;
 185                 }
 186                 found++;
 187         }
 188
 189         if (test_name && !found)
 190                 printf("Test '%s' not found\n", test_name);
 191         else
 192                 printf("Failures: %d\n", uts->fail_count);
 193
 194         /* Put everything back to normal so that sandbox works as expected */
 195 #ifdef CONFIG_OF_LIVE
 196         gd->of_root = uts->of_root;
 197 #endif
 198         gd->dm_root = NULL;
 199         ut_assertok(dm_init(IS_ENABLED(CONFIG_OF_LIVE)));
 200         dm_scan_platdata(false);
 201         dm_scan_fdt(gd->fdt_blob, false);
 202
 203         return uts->fail_count ? CMD_RET_FAILURE : 0;
 204 }
 205
 206 int do_ut_dm(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 207 {
 208         const char *test_name = NULL;
 209
 210         if (argc > 1)
 211                 test_name = argv[1];
 212
 213         return dm_test_main(test_name);
 214 }