test/overlay/cmd_ut_overlay.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2016 NextThing Co
   4  * Copyright (c) 2016 Free Electrons
   5  */
   6
   7 #include <common.h>
   8 #include <command.h>
   9 #include <errno.h>
  10 #include <fdt_support.h>
  11 #include <image.h>
  12 #include <malloc.h>
  13
  14 #include <linux/sizes.h>
  15
  16 #include <test/ut.h>
  17 #include <test/overlay.h>
  18 #include <test/suites.h>
  19
  20 /* 4k ought to be enough for anybody */
  21 #define FDT_COPY_SIZE   (4 * SZ_1K)
  22
  23 extern u32 __dtb_test_fdt_base_begin;
  24 extern u32 __dtb_test_fdt_overlay_begin;
  25 extern u32 __dtb_test_fdt_overlay_stacked_begin;
  26
  27 static void *fdt;
  28
  29 static int ut_fdt_getprop_u32_by_index(void *fdt, const char *path,
  30                                     const char *name, int index,
  31                                     u32 *out)
  32 {
  33         const fdt32_t *val;
  34         int node_off;
  35         int len;
  36
  37         node_off = fdt_path_offset(fdt, path);
  38         if (node_off < 0)
  39                 return node_off;
  40
  41         val = fdt_getprop(fdt, node_off, name, &len);
  42         if (!val || (len < (sizeof(uint32_t) * (index + 1))))
  43                 return -FDT_ERR_NOTFOUND;
  44
  45         *out = fdt32_to_cpu(*(val + index));
  46
  47         return 0;
  48 }
  49
  50 static int ut_fdt_getprop_u32(void *fdt, const char *path, const char *name,
  51                            u32 *out)
  52 {
  53         return ut_fdt_getprop_u32_by_index(fdt, path, name, 0, out);
  54 }
  55
  56 static int fdt_getprop_str(void *fdt, const char *path, const char *name,
  57                            const char **out)
  58 {
  59         int node_off;
  60         int len;
  61
  62         node_off = fdt_path_offset(fdt, path);
  63         if (node_off < 0)
  64                 return node_off;
  65
  66         *out = fdt_stringlist_get(fdt, node_off, name, 0, &len);
  67
  68         return len < 0 ? len : 0;
  69 }
  70
  71 static int fdt_overlay_change_int_property(struct unit_test_state *uts)
  72 {
  73         u32 val = 0;
  74
  75         ut_assertok(ut_fdt_getprop_u32(fdt, "/test-node", "test-int-property",
  76                                     &val));
  77         ut_asserteq(43, val);
  78
  79         return CMD_RET_SUCCESS;
  80 }
  81 OVERLAY_TEST(fdt_overlay_change_int_property, 0);
  82
  83 static int fdt_overlay_change_str_property(struct unit_test_state *uts)
  84 {
  85         const char *val = NULL;
  86
  87         ut_assertok(fdt_getprop_str(fdt, "/test-node", "test-str-property",
  88                                     &val));
  89         ut_asserteq_str("foobar", val);
  90
  91         return CMD_RET_SUCCESS;
  92 }
  93 OVERLAY_TEST(fdt_overlay_change_str_property, 0);
  94
  95 static int fdt_overlay_add_str_property(struct unit_test_state *uts)
  96 {
  97         const char *val = NULL;
  98
  99         ut_assertok(fdt_getprop_str(fdt, "/test-node", "test-str-property-2",
 100                                     &val));
 101         ut_asserteq_str("foobar2", val);
 102
 103         return CMD_RET_SUCCESS;
 104 }
 105 OVERLAY_TEST(fdt_overlay_add_str_property, 0);
 106
 107 static int fdt_overlay_add_node_by_phandle(struct unit_test_state *uts)
 108 {
 109         int off;
 110
 111         off = fdt_path_offset(fdt, "/test-node/new-node");
 112         ut_assert(off >= 0);
 113
 114         ut_assertnonnull(fdt_getprop(fdt, off, "new-property", NULL));
 115
 116         return CMD_RET_SUCCESS;
 117 }
 118 OVERLAY_TEST(fdt_overlay_add_node_by_phandle, 0);
 119
 120 static int fdt_overlay_add_node_by_path(struct unit_test_state *uts)
 121 {
 122         int off;
 123
 124         off = fdt_path_offset(fdt, "/new-node");
 125         ut_assert(off >= 0);
 126
 127         ut_assertnonnull(fdt_getprop(fdt, off, "new-property", NULL));
 128
 129         return CMD_RET_SUCCESS;
 130 }
 131 OVERLAY_TEST(fdt_overlay_add_node_by_path, 0);
 132
 133 static int fdt_overlay_add_subnode_property(struct unit_test_state *uts)
 134 {
 135         int off;
 136
 137         off = fdt_path_offset(fdt, "/test-node/sub-test-node");
 138         ut_assert(off >= 0);
 139
 140         ut_assertnonnull(fdt_getprop(fdt, off, "sub-test-property", NULL));
 141         ut_assertnonnull(fdt_getprop(fdt, off, "new-sub-test-property", NULL));
 142
 143         return CMD_RET_SUCCESS;
 144 }
 145 OVERLAY_TEST(fdt_overlay_add_subnode_property, 0);
 146
 147 static int fdt_overlay_local_phandle(struct unit_test_state *uts)
 148 {
 149         uint32_t local_phandle;
 150         u32 val = 0;
 151         int off;
 152
 153         off = fdt_path_offset(fdt, "/new-local-node");
 154         ut_assert(off >= 0);
 155
 156         local_phandle = fdt_get_phandle(fdt, off);
 157         ut_assert(local_phandle);
 158
 159         ut_assertok(ut_fdt_getprop_u32_by_index(fdt, "/", "test-several-phandle",
 160                                              0, &val));
 161         ut_asserteq(local_phandle, val);
 162
 163         ut_assertok(ut_fdt_getprop_u32_by_index(fdt, "/", "test-several-phandle",
 164                                              1, &val));
 165         ut_asserteq(local_phandle, val);
 166
 167         return CMD_RET_SUCCESS;
 168 }
 169 OVERLAY_TEST(fdt_overlay_local_phandle, 0);
 170
 171 static int fdt_overlay_local_phandles(struct unit_test_state *uts)
 172 {
 173         uint32_t local_phandle, test_phandle;
 174         u32 val = 0;
 175         int off;
 176
 177         off = fdt_path_offset(fdt, "/new-local-node");
 178         ut_assert(off >= 0);
 179
 180         local_phandle = fdt_get_phandle(fdt, off);
 181         ut_assert(local_phandle);
 182
 183         off = fdt_path_offset(fdt, "/test-node");
 184         ut_assert(off >= 0);
 185
 186         test_phandle = fdt_get_phandle(fdt, off);
 187         ut_assert(test_phandle);
 188
 189         ut_assertok(ut_fdt_getprop_u32_by_index(fdt, "/", "test-phandle", 0,
 190                                              &val));
 191         ut_asserteq(test_phandle, val);
 192
 193         ut_assertok(ut_fdt_getprop_u32_by_index(fdt, "/", "test-phandle", 1,
 194                                              &val));
 195         ut_asserteq(local_phandle, val);
 196
 197         return CMD_RET_SUCCESS;
 198 }
 199 OVERLAY_TEST(fdt_overlay_local_phandles, 0);
 200
 201 static int fdt_overlay_stacked(struct unit_test_state *uts)
 202 {
 203         u32 val = 0;
 204
 205         ut_assertok(ut_fdt_getprop_u32(fdt, "/new-local-node",
 206                                        "stacked-test-int-property", &val));
 207         ut_asserteq(43, val);
 208
 209         return CMD_RET_SUCCESS;
 210 }
 211 OVERLAY_TEST(fdt_overlay_stacked, 0);
 212
 213 int do_ut_overlay(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 214 {
 215         struct unit_test *tests = ll_entry_start(struct unit_test,
 216                                                  overlay_test);
 217         const int n_ents = ll_entry_count(struct unit_test, overlay_test);
 218         struct unit_test_state *uts;
 219         void *fdt_base = &__dtb_test_fdt_base_begin;
 220         void *fdt_overlay = &__dtb_test_fdt_overlay_begin;
 221         void *fdt_overlay_stacked = &__dtb_test_fdt_overlay_stacked_begin;
 222         void *fdt_overlay_copy, *fdt_overlay_stacked_copy;
 223         int ret = -ENOMEM;
 224
 225         uts = calloc(1, sizeof(*uts));
 226         if (!uts)
 227                 return -ENOMEM;
 228
 229         ut_assertok(fdt_check_header(fdt_base));
 230         ut_assertok(fdt_check_header(fdt_overlay));
 231
 232         fdt = malloc(FDT_COPY_SIZE);
 233         if (!fdt)
 234                 goto err1;
 235
 236         fdt_overlay_copy = malloc(FDT_COPY_SIZE);
 237         if (!fdt_overlay_copy)
 238                 goto err2;
 239
 240         fdt_overlay_stacked_copy = malloc(FDT_COPY_SIZE);
 241         if (!fdt_overlay_stacked_copy)
 242                 goto err3;
 243
 244         /*
 245          * Resize the FDT to 4k so that we have room to operate on
 246          *
 247          * (and relocate it since the memory might be mapped
 248          * read-only)
 249          */
 250         ut_assertok(fdt_open_into(fdt_base, fdt, FDT_COPY_SIZE));
 251
 252         /*
 253          * Resize the overlay to 4k so that we have room to operate on
 254          *
 255          * (and relocate it since the memory might be mapped
 256          * read-only)
 257          */
 258         ut_assertok(fdt_open_into(fdt_overlay, fdt_overlay_copy,
 259                                   FDT_COPY_SIZE));
 260
 261         /*
 262          * Resize the stacked overlay to 4k so that we have room to operate on
 263          *
 264          * (and relocate it since the memory might be mapped
 265          * read-only)
 266          */
 267         ut_assertok(fdt_open_into(fdt_overlay_stacked, fdt_overlay_stacked_copy,
 268                                   FDT_COPY_SIZE));
 269
 270         /* Apply the overlay */
 271         ut_assertok(fdt_overlay_apply(fdt, fdt_overlay_copy));
 272
 273         /* Apply the stacked overlay */
 274         ut_assertok(fdt_overlay_apply(fdt, fdt_overlay_stacked_copy));
 275
 276         ret = cmd_ut_category("overlay", "", tests, n_ents, argc, argv);
 277
 278         free(fdt_overlay_stacked_copy);
 279 err3:
 280         free(fdt_overlay_copy);
 281 err2:
 282         free(fdt);
 283 err1:
 284         return ret;
 285 }