test/dm/test-dm.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/global_data.h>
  14 #include <asm/state.h>
  15 #include <dm/test.h>
  16 #include <dm/root.h>
  17 #include <dm/uclass-internal.h>
  18 #include <test/test.h>
  19 #include <test/test.h>
  20 #include <test/ut.h>
  21
  22 DECLARE_GLOBAL_DATA_PTR;
  23
  24 struct unit_test_state global_dm_test_state;
  25 static struct dm_test_state _global_priv_dm_test_state;
  26
  27 /* Get ready for testing */
  28 static int dm_test_init(struct unit_test_state *uts, bool of_live)
  29 {
  30         struct dm_test_state *dms = uts->priv;
  31
  32         memset(dms, '\0', sizeof(*dms));
  33         gd->dm_root = NULL;
  34         if (!CONFIG_IS_ENABLED(OF_PLATDATA))
  35                 memset(dm_testdrv_op_count, '\0', sizeof(dm_testdrv_op_count));
  36         state_reset_for_test(state_get_current());
  37
  38         /* Determine whether to make the live tree available */
  39         gd_set_of_root(of_live ? uts->of_root : NULL);
  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_plat(false));
  94         if (test->flags & UT_TESTF_PROBE_TEST)
  95                 ut_assertok(do_autoprobe(uts));
  96         if (!CONFIG_IS_ENABLED(OF_PLATDATA) &&
  97             (test->flags & UT_TESTF_SCAN_FDT))
  98                 ut_assertok(dm_extended_scan(false));
  99
 100         /*
 101          * Silence the console and rely on console recording to get
 102          * our output.
 103          */
 104         console_record_reset_enable();
 105         if (!state->show_test_output)
 106                 gd->flags |= GD_FLG_SILENT;
 107         test->func(uts);
 108         gd->flags &= ~(GD_FLG_SILENT | GD_FLG_RECORD);
 109         state_set_skip_delays(false);
 110
 111         ut_assertok(dm_test_destroy(uts));
 112
 113         return 0;
 114 }
 115
 116 /**
 117  * dm_test_run_on_flattree() - Check if we should run a test with flat DT
 118  *
 119  * This skips long/slow tests where there is not much value in running a flat
 120  * DT test in addition to a live DT test.
 121  *
 122  * @return true to run the given test on the flat device tree
 123  */
 124 static bool dm_test_run_on_flattree(struct unit_test *test)
 125 {
 126         const char *fname = strrchr(test->file, '/') + 1;
 127
 128         return !strstr(fname, "video") || strstr(test->name, "video_base");
 129 }
 130
 131 static bool test_matches(const char *test_name, const char *find_name)
 132 {
 133         if (!find_name)
 134                 return true;
 135
 136         if (!strcmp(test_name, find_name))
 137                 return true;
 138
 139         /* All tests have this prefix */
 140         if (!strncmp(test_name, "dm_test_", 8))
 141                 test_name += 8;
 142
 143         if (!strcmp(test_name, find_name))
 144                 return true;
 145
 146         return false;
 147 }
 148
 149 int dm_test_run(const char *test_name)
 150 {
 151         struct unit_test *tests = ll_entry_start(struct unit_test, dm_test);
 152         const int n_ents = ll_entry_count(struct unit_test, dm_test);
 153         struct unit_test_state *uts = &global_dm_test_state;
 154         struct unit_test *test;
 155         int found;
 156
 157         uts->priv = &_global_priv_dm_test_state;
 158         uts->fail_count = 0;
 159
 160         if (!CONFIG_IS_ENABLED(OF_PLATDATA)) {
 161                 /*
 162                  * If we have no device tree, or it only has a root node, then
 163                  * these * tests clearly aren't going to work...
 164                  */
 165                 if (!gd->fdt_blob || fdt_next_node(gd->fdt_blob, 0, NULL) < 0) {
 166                         puts("Please run with test device tree:\n"
 167                              "    ./u-boot -d arch/sandbox/dts/test.dtb\n");
 168                         ut_assert(gd->fdt_blob);
 169                 }
 170         }
 171
 172         if (!test_name)
 173                 printf("Running %d driver model tests\n", n_ents);
 174         else
 175
 176         found = 0;
 177         uts->of_root = gd_of_root();
 178         for (test = tests; test < tests + n_ents; test++) {
 179                 const char *name = test->name;
 180                 int runs;
 181
 182                 if (!test_matches(name, test_name))
 183                         continue;
 184
 185                 /* Run with the live tree if possible */
 186                 runs = 0;
 187                 if (CONFIG_IS_ENABLED(OF_LIVE)) {
 188                         if (!(test->flags & UT_TESTF_FLAT_TREE)) {
 189                                 ut_assertok(dm_do_test(uts, test, true));
 190                                 runs++;
 191                         }
 192                 }
 193
 194                 /*
 195                  * Run with the flat tree if we couldn't run it with live tree,
 196                  * or it is a core test.
 197                  */
 198                 if (!(test->flags & UT_TESTF_LIVE_TREE) &&
 199                     (!runs || dm_test_run_on_flattree(test))) {
 200                         ut_assertok(dm_do_test(uts, test, false));
 201                         runs++;
 202                 }
 203                 found++;
 204         }
 205
 206         if (test_name && !found)
 207                 printf("Test '%s' not found\n", test_name);
 208         else
 209                 printf("Failures: %d\n", uts->fail_count);
 210
 211         /* Put everything back to normal so that sandbox works as expected */
 212         gd_set_of_root(uts->of_root);
 213         gd->dm_root = NULL;
 214         ut_assertok(dm_init(CONFIG_IS_ENABLED(OF_LIVE)));
 215         dm_scan_plat(false);
 216         if (!CONFIG_IS_ENABLED(OF_PLATDATA))
 217                 dm_scan_fdt(false);
 218
 219         return uts->fail_count ? CMD_RET_FAILURE : 0;
 220 }
 221
 222 int do_ut_dm(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 223 {
 224         const char *test_name = NULL;
 225
 226         if (argc > 1)
 227                 test_name = argv[1];
 228
 229         return dm_test_run(test_name);
 230 }