drivers/of/unittest.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Self tests for device tree subsystem
   4  */
   5
   6 #define pr_fmt(fmt) "### dt-test ### " fmt
   7
   8 #include <linux/memblock.h>
   9 #include <linux/clk.h>
  10 #include <linux/dma-direct.h> /* to test phys_to_dma/dma_to_phys */
  11 #include <linux/err.h>
  12 #include <linux/errno.h>
  13 #include <linux/hashtable.h>
  14 #include <linux/libfdt.h>
  15 #include <linux/of.h>
  16 #include <linux/of_address.h>
  17 #include <linux/of_fdt.h>
  18 #include <linux/of_irq.h>
  19 #include <linux/of_platform.h>
  20 #include <linux/list.h>
  21 #include <linux/mutex.h>
  22 #include <linux/slab.h>
  23 #include <linux/device.h>
  24 #include <linux/platform_device.h>
  25 #include <linux/kernel.h>
  26
  27 #include <linux/i2c.h>
  28 #include <linux/i2c-mux.h>
  29 #include <linux/gpio/driver.h>
  30
  31 #include <linux/bitops.h>
  32
  33 #include "of_private.h"
  34
  35 static struct unittest_results {
  36         int passed;
  37         int failed;
  38 } unittest_results;
  39
  40 #define unittest(result, fmt, ...) ({ \
  41         bool failed = !(result); \
  42         if (failed) { \
  43                 unittest_results.failed++; \
  44                 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
  45         } else { \
  46                 unittest_results.passed++; \
  47                 pr_info("pass %s():%i\n", __func__, __LINE__); \
  48         } \
  49         failed; \
  50 })
  51
  52 /*
  53  * Expected message may have a message level other than KERN_INFO.
  54  * Print the expected message only if the current loglevel will allow
  55  * the actual message to print.
  56  *
  57  * Do not use EXPECT_BEGIN(), EXPECT_END(), EXPECT_NOT_BEGIN(), or
  58  * EXPECT_NOT_END() to report messages expected to be reported or not
  59  * reported by pr_debug().
  60  */
  61 #define EXPECT_BEGIN(level, fmt, ...) \
  62         printk(level pr_fmt("EXPECT \\ : ") fmt, ##__VA_ARGS__)
  63
  64 #define EXPECT_END(level, fmt, ...) \
  65         printk(level pr_fmt("EXPECT / : ") fmt, ##__VA_ARGS__)
  66
  67 #define EXPECT_NOT_BEGIN(level, fmt, ...) \
  68         printk(level pr_fmt("EXPECT_NOT \\ : ") fmt, ##__VA_ARGS__)
  69
  70 #define EXPECT_NOT_END(level, fmt, ...) \
  71         printk(level pr_fmt("EXPECT_NOT / : ") fmt, ##__VA_ARGS__)
  72
  73 static void __init of_unittest_find_node_by_name(void)
  74 {
  75         struct device_node *np;
  76         const char *options, *name;
  77
  78         np = of_find_node_by_path("/testcase-data");
  79         name = kasprintf(GFP_KERNEL, "%pOF", np);
  80         unittest(np && !strcmp("/testcase-data", name),
  81                 "find /testcase-data failed\n");
  82         of_node_put(np);
  83         kfree(name);
  84
  85         /* Test if trailing '/' works */
  86         np = of_find_node_by_path("/testcase-data/");
  87         unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
  88
  89         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
  90         name = kasprintf(GFP_KERNEL, "%pOF", np);
  91         unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
  92                 "find /testcase-data/phandle-tests/consumer-a failed\n");
  93         of_node_put(np);
  94         kfree(name);
  95
  96         np = of_find_node_by_path("testcase-alias");
  97         name = kasprintf(GFP_KERNEL, "%pOF", np);
  98         unittest(np && !strcmp("/testcase-data", name),
  99                 "find testcase-alias failed\n");
 100         of_node_put(np);
 101         kfree(name);
 102
 103         /* Test if trailing '/' works on aliases */
 104         np = of_find_node_by_path("testcase-alias/");
 105         unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
 106
 107         np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
 108         name = kasprintf(GFP_KERNEL, "%pOF", np);
 109         unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
 110                 "find testcase-alias/phandle-tests/consumer-a failed\n");
 111         of_node_put(np);
 112         kfree(name);
 113
 114         np = of_find_node_by_path("/testcase-data/missing-path");
 115         unittest(!np, "non-existent path returned node %pOF\n", np);
 116         of_node_put(np);
 117
 118         np = of_find_node_by_path("missing-alias");
 119         unittest(!np, "non-existent alias returned node %pOF\n", np);
 120         of_node_put(np);
 121
 122         np = of_find_node_by_path("testcase-alias/missing-path");
 123         unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
 124         of_node_put(np);
 125
 126         np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
 127         unittest(np && !strcmp("testoption", options),
 128                  "option path test failed\n");
 129         of_node_put(np);
 130
 131         np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
 132         unittest(np && !strcmp("test/option", options),
 133                  "option path test, subcase #1 failed\n");
 134         of_node_put(np);
 135
 136         np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
 137         unittest(np && !strcmp("test/option", options),
 138                  "option path test, subcase #2 failed\n");
 139         of_node_put(np);
 140
 141         np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
 142         unittest(np, "NULL option path test failed\n");
 143         of_node_put(np);
 144
 145         np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
 146                                        &options);
 147         unittest(np && !strcmp("testaliasoption", options),
 148                  "option alias path test failed\n");
 149         of_node_put(np);
 150
 151         np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
 152                                        &options);
 153         unittest(np && !strcmp("test/alias/option", options),
 154                  "option alias path test, subcase #1 failed\n");
 155         of_node_put(np);
 156
 157         np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
 158         unittest(np, "NULL option alias path test failed\n");
 159         of_node_put(np);
 160
 161         options = "testoption";
 162         np = of_find_node_opts_by_path("testcase-alias", &options);
 163         unittest(np && !options, "option clearing test failed\n");
 164         of_node_put(np);
 165
 166         options = "testoption";
 167         np = of_find_node_opts_by_path("/", &options);
 168         unittest(np && !options, "option clearing root node test failed\n");
 169         of_node_put(np);
 170 }
 171
 172 static void __init of_unittest_dynamic(void)
 173 {
 174         struct device_node *np;
 175         struct property *prop;
 176
 177         np = of_find_node_by_path("/testcase-data");
 178         if (!np) {
 179                 pr_err("missing testcase data\n");
 180                 return;
 181         }
 182
 183         /* Array of 4 properties for the purpose of testing */
 184         prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
 185         if (!prop) {
 186                 unittest(0, "kzalloc() failed\n");
 187                 return;
 188         }
 189
 190         /* Add a new property - should pass*/
 191         prop->name = "new-property";
 192         prop->value = "new-property-data";
 193         prop->length = strlen(prop->value) + 1;
 194         unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
 195
 196         /* Try to add an existing property - should fail */
 197         prop++;
 198         prop->name = "new-property";
 199         prop->value = "new-property-data-should-fail";
 200         prop->length = strlen(prop->value) + 1;
 201         unittest(of_add_property(np, prop) != 0,
 202                  "Adding an existing property should have failed\n");
 203
 204         /* Try to modify an existing property - should pass */
 205         prop->value = "modify-property-data-should-pass";
 206         prop->length = strlen(prop->value) + 1;
 207         unittest(of_update_property(np, prop) == 0,
 208                  "Updating an existing property should have passed\n");
 209
 210         /* Try to modify non-existent property - should pass*/
 211         prop++;
 212         prop->name = "modify-property";
 213         prop->value = "modify-missing-property-data-should-pass";
 214         prop->length = strlen(prop->value) + 1;
 215         unittest(of_update_property(np, prop) == 0,
 216                  "Updating a missing property should have passed\n");
 217
 218         /* Remove property - should pass */
 219         unittest(of_remove_property(np, prop) == 0,
 220                  "Removing a property should have passed\n");
 221
 222         /* Adding very large property - should pass */
 223         prop++;
 224         prop->name = "large-property-PAGE_SIZEx8";
 225         prop->length = PAGE_SIZE * 8;
 226         prop->value = kzalloc(prop->length, GFP_KERNEL);
 227         unittest(prop->value != NULL, "Unable to allocate large buffer\n");
 228         if (prop->value)
 229                 unittest(of_add_property(np, prop) == 0,
 230                          "Adding a large property should have passed\n");
 231 }
 232
 233 static int __init of_unittest_check_node_linkage(struct device_node *np)
 234 {
 235         struct device_node *child;
 236         int count = 0, rc;
 237
 238         for_each_child_of_node(np, child) {
 239                 if (child->parent != np) {
 240                         pr_err("Child node %pOFn links to wrong parent %pOFn\n",
 241                                  child, np);
 242                         rc = -EINVAL;
 243                         goto put_child;
 244                 }
 245
 246                 rc = of_unittest_check_node_linkage(child);
 247                 if (rc < 0)
 248                         goto put_child;
 249                 count += rc;
 250         }
 251
 252         return count + 1;
 253 put_child:
 254         of_node_put(child);
 255         return rc;
 256 }
 257
 258 static void __init of_unittest_check_tree_linkage(void)
 259 {
 260         struct device_node *np;
 261         int allnode_count = 0, child_count;
 262
 263         if (!of_root)
 264                 return;
 265
 266         for_each_of_allnodes(np)
 267                 allnode_count++;
 268         child_count = of_unittest_check_node_linkage(of_root);
 269
 270         unittest(child_count > 0, "Device node data structure is corrupted\n");
 271         unittest(child_count == allnode_count,
 272                  "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
 273                  allnode_count, child_count);
 274         pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
 275 }
 276
 277 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
 278                                           const char *expected)
 279 {
 280         unsigned char *buf;
 281         int buf_size;
 282         int size, i;
 283
 284         buf_size = strlen(expected) + 10;
 285         buf = kmalloc(buf_size, GFP_KERNEL);
 286         if (!buf)
 287                 return;
 288
 289         /* Baseline; check conversion with a large size limit */
 290         memset(buf, 0xff, buf_size);
 291         size = snprintf(buf, buf_size - 2, fmt, np);
 292
 293         /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
 294         unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
 295                 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
 296                 fmt, expected, buf);
 297
 298         /* Make sure length limits work */
 299         size++;
 300         for (i = 0; i < 2; i++, size--) {
 301                 /* Clear the buffer, and make sure it works correctly still */
 302                 memset(buf, 0xff, buf_size);
 303                 snprintf(buf, size+1, fmt, np);
 304                 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
 305                         "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
 306                         size, fmt, expected, buf);
 307         }
 308         kfree(buf);
 309 }
 310
 311 static void __init of_unittest_printf(void)
 312 {
 313         struct device_node *np;
 314         const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
 315         char phandle_str[16] = "";
 316
 317         np = of_find_node_by_path(full_name);
 318         if (!np) {
 319                 unittest(np, "testcase data missing\n");
 320                 return;
 321         }
 322
 323         num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
 324
 325         of_unittest_printf_one(np, "%pOF",  full_name);
 326         of_unittest_printf_one(np, "%pOFf", full_name);
 327         of_unittest_printf_one(np, "%pOFn", "dev");
 328         of_unittest_printf_one(np, "%2pOFn", "dev");
 329         of_unittest_printf_one(np, "%5pOFn", "  dev");
 330         of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
 331         of_unittest_printf_one(np, "%pOFp", phandle_str);
 332         of_unittest_printf_one(np, "%pOFP", "dev@100");
 333         of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
 334         of_unittest_printf_one(np, "%10pOFP", "   dev@100");
 335         of_unittest_printf_one(np, "%-10pOFP", "dev@100   ");
 336         of_unittest_printf_one(of_root, "%pOFP", "/");
 337         of_unittest_printf_one(np, "%pOFF", "----");
 338         of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
 339         of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
 340         of_unittest_printf_one(np, "%pOFc", "test-sub-device");
 341         of_unittest_printf_one(np, "%pOFC",
 342                         "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
 343 }
 344
 345 struct node_hash {
 346         struct hlist_node node;
 347         struct device_node *np;
 348 };
 349
 350 static DEFINE_HASHTABLE(phandle_ht, 8);
 351 static void __init of_unittest_check_phandles(void)
 352 {
 353         struct device_node *np;
 354         struct node_hash *nh;
 355         struct hlist_node *tmp;
 356         int i, dup_count = 0, phandle_count = 0;
 357
 358         for_each_of_allnodes(np) {
 359                 if (!np->phandle)
 360                         continue;
 361
 362                 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
 363                         if (nh->np->phandle == np->phandle) {
 364                                 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
 365                                         np->phandle, nh->np, np);
 366                                 dup_count++;
 367                                 break;
 368                         }
 369                 }
 370
 371                 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
 372                 if (!nh)
 373                         return;
 374
 375                 nh->np = np;
 376                 hash_add(phandle_ht, &nh->node, np->phandle);
 377                 phandle_count++;
 378         }
 379         unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
 380                  dup_count, phandle_count);
 381
 382         /* Clean up */
 383         hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
 384                 hash_del(&nh->node);
 385                 kfree(nh);
 386         }
 387 }
 388
 389 static void __init of_unittest_parse_phandle_with_args(void)
 390 {
 391         struct device_node *np;
 392         struct of_phandle_args args;
 393         int i, rc;
 394
 395         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 396         if (!np) {
 397                 pr_err("missing testcase data\n");
 398                 return;
 399         }
 400
 401         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 402         unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 403
 404         for (i = 0; i < 8; i++) {
 405                 bool passed = true;
 406
 407                 memset(&args, 0, sizeof(args));
 408                 rc = of_parse_phandle_with_args(np, "phandle-list",
 409                                                 "#phandle-cells", i, &args);
 410
 411                 /* Test the values from tests-phandle.dtsi */
 412                 switch (i) {
 413                 case 0:
 414                         passed &= !rc;
 415                         passed &= (args.args_count == 1);
 416                         passed &= (args.args[0] == (i + 1));
 417                         break;
 418                 case 1:
 419                         passed &= !rc;
 420                         passed &= (args.args_count == 2);
 421                         passed &= (args.args[0] == (i + 1));
 422                         passed &= (args.args[1] == 0);
 423                         break;
 424                 case 2:
 425                         passed &= (rc == -ENOENT);
 426                         break;
 427                 case 3:
 428                         passed &= !rc;
 429                         passed &= (args.args_count == 3);
 430                         passed &= (args.args[0] == (i + 1));
 431                         passed &= (args.args[1] == 4);
 432                         passed &= (args.args[2] == 3);
 433                         break;
 434                 case 4:
 435                         passed &= !rc;
 436                         passed &= (args.args_count == 2);
 437                         passed &= (args.args[0] == (i + 1));
 438                         passed &= (args.args[1] == 100);
 439                         break;
 440                 case 5:
 441                         passed &= !rc;
 442                         passed &= (args.args_count == 0);
 443                         break;
 444                 case 6:
 445                         passed &= !rc;
 446                         passed &= (args.args_count == 1);
 447                         passed &= (args.args[0] == (i + 1));
 448                         break;
 449                 case 7:
 450                         passed &= (rc == -ENOENT);
 451                         break;
 452                 default:
 453                         passed = false;
 454                 }
 455
 456                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 457                          i, args.np, rc);
 458         }
 459
 460         /* Check for missing list property */
 461         memset(&args, 0, sizeof(args));
 462         rc = of_parse_phandle_with_args(np, "phandle-list-missing",
 463                                         "#phandle-cells", 0, &args);
 464         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 465         rc = of_count_phandle_with_args(np, "phandle-list-missing",
 466                                         "#phandle-cells");
 467         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 468
 469         /* Check for missing cells property */
 470         memset(&args, 0, sizeof(args));
 471
 472         EXPECT_BEGIN(KERN_INFO,
 473                      "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
 474
 475         rc = of_parse_phandle_with_args(np, "phandle-list",
 476                                         "#phandle-cells-missing", 0, &args);
 477
 478         EXPECT_END(KERN_INFO,
 479                    "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
 480
 481         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 482
 483         EXPECT_BEGIN(KERN_INFO,
 484                      "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
 485
 486         rc = of_count_phandle_with_args(np, "phandle-list",
 487                                         "#phandle-cells-missing");
 488
 489         EXPECT_END(KERN_INFO,
 490                    "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
 491
 492         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 493
 494         /* Check for bad phandle in list */
 495         memset(&args, 0, sizeof(args));
 496
 497         EXPECT_BEGIN(KERN_INFO,
 498                      "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
 499
 500         rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
 501                                         "#phandle-cells", 0, &args);
 502
 503         EXPECT_END(KERN_INFO,
 504                    "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
 505
 506         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 507
 508         EXPECT_BEGIN(KERN_INFO,
 509                      "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
 510
 511         rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
 512                                         "#phandle-cells");
 513
 514         EXPECT_END(KERN_INFO,
 515                    "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
 516
 517         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 518
 519         /* Check for incorrectly formed argument list */
 520         memset(&args, 0, sizeof(args));
 521
 522         EXPECT_BEGIN(KERN_INFO,
 523                      "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
 524
 525         rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
 526                                         "#phandle-cells", 1, &args);
 527
 528         EXPECT_END(KERN_INFO,
 529                    "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
 530
 531         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 532
 533         EXPECT_BEGIN(KERN_INFO,
 534                      "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
 535
 536         rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
 537                                         "#phandle-cells");
 538
 539         EXPECT_END(KERN_INFO,
 540                    "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
 541
 542         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 543 }
 544
 545 static void __init of_unittest_parse_phandle_with_args_map(void)
 546 {
 547         struct device_node *np, *p0, *p1, *p2, *p3;
 548         struct of_phandle_args args;
 549         int i, rc;
 550
 551         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
 552         if (!np) {
 553                 pr_err("missing testcase data\n");
 554                 return;
 555         }
 556
 557         p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
 558         if (!p0) {
 559                 pr_err("missing testcase data\n");
 560                 return;
 561         }
 562
 563         p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
 564         if (!p1) {
 565                 pr_err("missing testcase data\n");
 566                 return;
 567         }
 568
 569         p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
 570         if (!p2) {
 571                 pr_err("missing testcase data\n");
 572                 return;
 573         }
 574
 575         p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
 576         if (!p3) {
 577                 pr_err("missing testcase data\n");
 578                 return;
 579         }
 580
 581         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 582         unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 583
 584         for (i = 0; i < 8; i++) {
 585                 bool passed = true;
 586
 587                 memset(&args, 0, sizeof(args));
 588                 rc = of_parse_phandle_with_args_map(np, "phandle-list",
 589                                                     "phandle", i, &args);
 590
 591                 /* Test the values from tests-phandle.dtsi */
 592                 switch (i) {
 593                 case 0:
 594                         passed &= !rc;
 595                         passed &= (args.np == p1);
 596                         passed &= (args.args_count == 1);
 597                         passed &= (args.args[0] == 1);
 598                         break;
 599                 case 1:
 600                         passed &= !rc;
 601                         passed &= (args.np == p3);
 602                         passed &= (args.args_count == 3);
 603                         passed &= (args.args[0] == 2);
 604                         passed &= (args.args[1] == 5);
 605                         passed &= (args.args[2] == 3);
 606                         break;
 607                 case 2:
 608                         passed &= (rc == -ENOENT);
 609                         break;
 610                 case 3:
 611                         passed &= !rc;
 612                         passed &= (args.np == p0);
 613                         passed &= (args.args_count == 0);
 614                         break;
 615                 case 4:
 616                         passed &= !rc;
 617                         passed &= (args.np == p1);
 618                         passed &= (args.args_count == 1);
 619                         passed &= (args.args[0] == 3);
 620                         break;
 621                 case 5:
 622                         passed &= !rc;
 623                         passed &= (args.np == p0);
 624                         passed &= (args.args_count == 0);
 625                         break;
 626                 case 6:
 627                         passed &= !rc;
 628                         passed &= (args.np == p2);
 629                         passed &= (args.args_count == 2);
 630                         passed &= (args.args[0] == 15);
 631                         passed &= (args.args[1] == 0x20);
 632                         break;
 633                 case 7:
 634                         passed &= (rc == -ENOENT);
 635                         break;
 636                 default:
 637                         passed = false;
 638                 }
 639
 640                 unittest(passed, "index %i - data error on node %s rc=%i\n",
 641                          i, args.np->full_name, rc);
 642         }
 643
 644         /* Check for missing list property */
 645         memset(&args, 0, sizeof(args));
 646         rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
 647                                             "phandle", 0, &args);
 648         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 649
 650         /* Check for missing cells,map,mask property */
 651         memset(&args, 0, sizeof(args));
 652
 653         EXPECT_BEGIN(KERN_INFO,
 654                      "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
 655
 656         rc = of_parse_phandle_with_args_map(np, "phandle-list",
 657                                             "phandle-missing", 0, &args);
 658         EXPECT_END(KERN_INFO,
 659                    "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
 660
 661         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 662
 663         /* Check for bad phandle in list */
 664         memset(&args, 0, sizeof(args));
 665
 666         EXPECT_BEGIN(KERN_INFO,
 667                      "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
 668
 669         rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
 670                                             "phandle", 0, &args);
 671         EXPECT_END(KERN_INFO,
 672                    "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
 673
 674         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 675
 676         /* Check for incorrectly formed argument list */
 677         memset(&args, 0, sizeof(args));
 678
 679         EXPECT_BEGIN(KERN_INFO,
 680                      "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
 681
 682         rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
 683                                             "phandle", 1, &args);
 684         EXPECT_END(KERN_INFO,
 685                    "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
 686
 687         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 688 }
 689
 690 static void __init of_unittest_property_string(void)
 691 {
 692         const char *strings[4];
 693         struct device_node *np;
 694         int rc;
 695
 696         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 697         if (!np) {
 698                 pr_err("No testcase data in device tree\n");
 699                 return;
 700         }
 701
 702         rc = of_property_match_string(np, "phandle-list-names", "first");
 703         unittest(rc == 0, "first expected:0 got:%i\n", rc);
 704         rc = of_property_match_string(np, "phandle-list-names", "second");
 705         unittest(rc == 1, "second expected:1 got:%i\n", rc);
 706         rc = of_property_match_string(np, "phandle-list-names", "third");
 707         unittest(rc == 2, "third expected:2 got:%i\n", rc);
 708         rc = of_property_match_string(np, "phandle-list-names", "fourth");
 709         unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
 710         rc = of_property_match_string(np, "missing-property", "blah");
 711         unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
 712         rc = of_property_match_string(np, "empty-property", "blah");
 713         unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
 714         rc = of_property_match_string(np, "unterminated-string", "blah");
 715         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 716
 717         /* of_property_count_strings() tests */
 718         rc = of_property_count_strings(np, "string-property");
 719         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 720         rc = of_property_count_strings(np, "phandle-list-names");
 721         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 722         rc = of_property_count_strings(np, "unterminated-string");
 723         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 724         rc = of_property_count_strings(np, "unterminated-string-list");
 725         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 726
 727         /* of_property_read_string_index() tests */
 728         rc = of_property_read_string_index(np, "string-property", 0, strings);
 729         unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
 730         strings[0] = NULL;
 731         rc = of_property_read_string_index(np, "string-property", 1, strings);
 732         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 733         rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
 734         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 735         rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
 736         unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
 737         rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
 738         unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
 739         strings[0] = NULL;
 740         rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
 741         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 742         strings[0] = NULL;
 743         rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
 744         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 745         rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
 746         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 747         strings[0] = NULL;
 748         rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
 749         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 750         strings[1] = NULL;
 751
 752         /* of_property_read_string_array() tests */
 753         rc = of_property_read_string_array(np, "string-property", strings, 4);
 754         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 755         rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
 756         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 757         rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
 758         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 759         /* -- An incorrectly formed string should cause a failure */
 760         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
 761         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 762         /* -- parsing the correctly formed strings should still work: */
 763         strings[2] = NULL;
 764         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
 765         unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
 766         strings[1] = NULL;
 767         rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
 768         unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
 769 }
 770
 771 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
 772                         (p1)->value && (p2)->value && \
 773                         !memcmp((p1)->value, (p2)->value, (p1)->length) && \
 774                         !strcmp((p1)->name, (p2)->name))
 775 static void __init of_unittest_property_copy(void)
 776 {
 777 #ifdef CONFIG_OF_DYNAMIC
 778         struct property p1 = { .name = "p1", .length = 0, .value = "" };
 779         struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
 780         struct property *new;
 781
 782         new = __of_prop_dup(&p1, GFP_KERNEL);
 783         unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
 784         kfree(new->value);
 785         kfree(new->name);
 786         kfree(new);
 787
 788         new = __of_prop_dup(&p2, GFP_KERNEL);
 789         unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
 790         kfree(new->value);
 791         kfree(new->name);
 792         kfree(new);
 793 #endif
 794 }
 795
 796 static void __init of_unittest_changeset(void)
 797 {
 798 #ifdef CONFIG_OF_DYNAMIC
 799         struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
 800         struct property *ppname_n1,  pname_n1  = { .name = "name", .length = 3, .value = "n1"  };
 801         struct property *ppname_n2,  pname_n2  = { .name = "name", .length = 3, .value = "n2"  };
 802         struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
 803         struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
 804         struct property *ppremove;
 805         struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
 806         struct of_changeset chgset;
 807
 808         n1 = __of_node_dup(NULL, "n1");
 809         unittest(n1, "testcase setup failure\n");
 810
 811         n2 = __of_node_dup(NULL, "n2");
 812         unittest(n2, "testcase setup failure\n");
 813
 814         n21 = __of_node_dup(NULL, "n21");
 815         unittest(n21, "testcase setup failure %p\n", n21);
 816
 817         nchangeset = of_find_node_by_path("/testcase-data/changeset");
 818         nremove = of_get_child_by_name(nchangeset, "node-remove");
 819         unittest(nremove, "testcase setup failure\n");
 820
 821         ppadd = __of_prop_dup(&padd, GFP_KERNEL);
 822         unittest(ppadd, "testcase setup failure\n");
 823
 824         ppname_n1  = __of_prop_dup(&pname_n1, GFP_KERNEL);
 825         unittest(ppname_n1, "testcase setup failure\n");
 826
 827         ppname_n2  = __of_prop_dup(&pname_n2, GFP_KERNEL);
 828         unittest(ppname_n2, "testcase setup failure\n");
 829
 830         ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
 831         unittest(ppname_n21, "testcase setup failure\n");
 832
 833         ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
 834         unittest(ppupdate, "testcase setup failure\n");
 835
 836         parent = nchangeset;
 837         n1->parent = parent;
 838         n2->parent = parent;
 839         n21->parent = n2;
 840
 841         ppremove = of_find_property(parent, "prop-remove", NULL);
 842         unittest(ppremove, "failed to find removal prop");
 843
 844         of_changeset_init(&chgset);
 845
 846         unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
 847         unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
 848
 849         unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
 850         unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
 851
 852         unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
 853         unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
 854
 855         unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
 856
 857         unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
 858         unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
 859         unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
 860
 861         unittest(!of_changeset_apply(&chgset), "apply failed\n");
 862
 863         of_node_put(nchangeset);
 864
 865         /* Make sure node names are constructed correctly */
 866         unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
 867                  "'%pOF' not added\n", n21);
 868         of_node_put(np);
 869
 870         unittest(!of_changeset_revert(&chgset), "revert failed\n");
 871
 872         of_changeset_destroy(&chgset);
 873
 874         of_node_put(n1);
 875         of_node_put(n2);
 876         of_node_put(n21);
 877 #endif
 878 }
 879
 880 static void __init of_unittest_dma_get_max_cpu_address(void)
 881 {
 882         struct device_node *np;
 883         phys_addr_t cpu_addr;
 884
 885         if (!IS_ENABLED(CONFIG_OF_ADDRESS))
 886                 return;
 887
 888         np = of_find_node_by_path("/testcase-data/address-tests");
 889         if (!np) {
 890                 pr_err("missing testcase data\n");
 891                 return;
 892         }
 893
 894         cpu_addr = of_dma_get_max_cpu_address(np);
 895         unittest(cpu_addr == 0x4fffffff,
 896                  "of_dma_get_max_cpu_address: wrong CPU addr %pad (expecting %x)\n",
 897                  &cpu_addr, 0x4fffffff);
 898 }
 899
 900 static void __init of_unittest_dma_ranges_one(const char *path,
 901                 u64 expect_dma_addr, u64 expect_paddr)
 902 {
 903 #ifdef CONFIG_HAS_DMA
 904         struct device_node *np;
 905         const struct bus_dma_region *map = NULL;
 906         int rc;
 907
 908         np = of_find_node_by_path(path);
 909         if (!np) {
 910                 pr_err("missing testcase data\n");
 911                 return;
 912         }
 913
 914         rc = of_dma_get_range(np, &map);
 915
 916         unittest(!rc, "of_dma_get_range failed on node %pOF rc=%i\n", np, rc);
 917
 918         if (!rc) {
 919                 phys_addr_t     paddr;
 920                 dma_addr_t      dma_addr;
 921                 struct device   *dev_bogus;
 922
 923                 dev_bogus = kzalloc(sizeof(struct device), GFP_KERNEL);
 924                 if (!dev_bogus) {
 925                         unittest(0, "kzalloc() failed\n");
 926                         kfree(map);
 927                         return;
 928                 }
 929
 930                 dev_bogus->dma_range_map = map;
 931                 paddr = dma_to_phys(dev_bogus, expect_dma_addr);
 932                 dma_addr = phys_to_dma(dev_bogus, expect_paddr);
 933
 934                 unittest(paddr == expect_paddr,
 935                          "of_dma_get_range: wrong phys addr %pap (expecting %llx) on node %pOF\n",
 936                          &paddr, expect_paddr, np);
 937                 unittest(dma_addr == expect_dma_addr,
 938                          "of_dma_get_range: wrong DMA addr %pad (expecting %llx) on node %pOF\n",
 939                          &dma_addr, expect_dma_addr, np);
 940
 941                 kfree(map);
 942                 kfree(dev_bogus);
 943         }
 944         of_node_put(np);
 945 #endif
 946 }
 947
 948 static void __init of_unittest_parse_dma_ranges(void)
 949 {
 950         of_unittest_dma_ranges_one("/testcase-data/address-tests/device@70000000",
 951                 0x0, 0x20000000);
 952         if (IS_ENABLED(CONFIG_ARCH_DMA_ADDR_T_64BIT))
 953                 of_unittest_dma_ranges_one("/testcase-data/address-tests/bus@80000000/device@1000",
 954                         0x100000000, 0x20000000);
 955         of_unittest_dma_ranges_one("/testcase-data/address-tests/pci@90000000",
 956                 0x80000000, 0x20000000);
 957 }
 958
 959 static void __init of_unittest_pci_dma_ranges(void)
 960 {
 961         struct device_node *np;
 962         struct of_pci_range range;
 963         struct of_pci_range_parser parser;
 964         int i = 0;
 965
 966         if (!IS_ENABLED(CONFIG_PCI))
 967                 return;
 968
 969         np = of_find_node_by_path("/testcase-data/address-tests/pci@90000000");
 970         if (!np) {
 971                 pr_err("missing testcase data\n");
 972                 return;
 973         }
 974
 975         if (of_pci_dma_range_parser_init(&parser, np)) {
 976                 pr_err("missing dma-ranges property\n");
 977                 return;
 978         }
 979
 980         /*
 981          * Get the dma-ranges from the device tree
 982          */
 983         for_each_of_pci_range(&parser, &range) {
 984                 if (!i) {
 985                         unittest(range.size == 0x10000000,
 986                                  "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
 987                                  np, range.size);
 988                         unittest(range.cpu_addr == 0x20000000,
 989                                  "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
 990                                  range.cpu_addr, np);
 991                         unittest(range.pci_addr == 0x80000000,
 992                                  "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
 993                                  range.pci_addr, np);
 994                 } else {
 995                         unittest(range.size == 0x10000000,
 996                                  "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
 997                                  np, range.size);
 998                         unittest(range.cpu_addr == 0x40000000,
 999                                  "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
1000                                  range.cpu_addr, np);
1001                         unittest(range.pci_addr == 0xc0000000,
1002                                  "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1003                                  range.pci_addr, np);
1004                 }
1005                 i++;
1006         }
1007
1008         of_node_put(np);
1009 }
1010
1011 static void __init of_unittest_bus_ranges(void)
1012 {
1013         struct device_node *np;
1014         struct of_range range;
1015         struct of_range_parser parser;
1016         struct resource res;
1017         int ret, count, i = 0;
1018
1019         np = of_find_node_by_path("/testcase-data/address-tests");
1020         if (!np) {
1021                 pr_err("missing testcase data\n");
1022                 return;
1023         }
1024
1025         if (of_range_parser_init(&parser, np)) {
1026                 pr_err("missing ranges property\n");
1027                 return;
1028         }
1029
1030         ret = of_range_to_resource(np, 1, &res);
1031         unittest(!ret, "of_range_to_resource returned error (%d) node %pOF\n",
1032                 ret, np);
1033         unittest(resource_type(&res) == IORESOURCE_MEM,
1034                 "of_range_to_resource wrong resource type on node %pOF res=%pR\n",
1035                 np, &res);
1036         unittest(res.start == 0xd0000000,
1037                 "of_range_to_resource wrong resource start address on node %pOF res=%pR\n",
1038                 np, &res);
1039         unittest(resource_size(&res) == 0x20000000,
1040                 "of_range_to_resource wrong resource start address on node %pOF res=%pR\n",
1041                 np, &res);
1042
1043         count = of_range_count(&parser);
1044         unittest(count == 2,
1045                 "of_range_count wrong size on node %pOF count=%d\n",
1046                 np, count);
1047
1048         /*
1049          * Get the "ranges" from the device tree
1050          */
1051         for_each_of_range(&parser, &range) {
1052                 unittest(range.flags == IORESOURCE_MEM,
1053                         "for_each_of_range wrong flags on node %pOF flags=%x (expected %x)\n",
1054                         np, range.flags, IORESOURCE_MEM);
1055                 if (!i) {
1056                         unittest(range.size == 0x50000000,
1057                                  "for_each_of_range wrong size on node %pOF size=%llx\n",
1058                                  np, range.size);
1059                         unittest(range.cpu_addr == 0x70000000,
1060                                  "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1061                                  range.cpu_addr, np);
1062                         unittest(range.bus_addr == 0x70000000,
1063                                  "for_each_of_range wrong bus addr (%llx) on node %pOF",
1064                                  range.pci_addr, np);
1065                 } else {
1066                         unittest(range.size == 0x20000000,
1067                                  "for_each_of_range wrong size on node %pOF size=%llx\n",
1068                                  np, range.size);
1069                         unittest(range.cpu_addr == 0xd0000000,
1070                                  "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1071                                  range.cpu_addr, np);
1072                         unittest(range.bus_addr == 0x00000000,
1073                                  "for_each_of_range wrong bus addr (%llx) on node %pOF",
1074                                  range.pci_addr, np);
1075                 }
1076                 i++;
1077         }
1078
1079         of_node_put(np);
1080 }
1081
1082 static void __init of_unittest_bus_3cell_ranges(void)
1083 {
1084         struct device_node *np;
1085         struct of_range range;
1086         struct of_range_parser parser;
1087         int i = 0;
1088
1089         np = of_find_node_by_path("/testcase-data/address-tests/bus@a0000000");
1090         if (!np) {
1091                 pr_err("missing testcase data\n");
1092                 return;
1093         }
1094
1095         if (of_range_parser_init(&parser, np)) {
1096                 pr_err("missing ranges property\n");
1097                 return;
1098         }
1099
1100         /*
1101          * Get the "ranges" from the device tree
1102          */
1103         for_each_of_range(&parser, &range) {
1104                 if (!i) {
1105                         unittest(range.flags == 0xf00baa,
1106                                  "for_each_of_range wrong flags on node %pOF flags=%x\n",
1107                                  np, range.flags);
1108                         unittest(range.size == 0x100000,
1109                                  "for_each_of_range wrong size on node %pOF size=%llx\n",
1110                                  np, range.size);
1111                         unittest(range.cpu_addr == 0xa0000000,
1112                                  "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1113                                  range.cpu_addr, np);
1114                         unittest(range.bus_addr == 0x0,
1115                                  "for_each_of_range wrong bus addr (%llx) on node %pOF",
1116                                  range.pci_addr, np);
1117                 } else {
1118                         unittest(range.flags == 0xf00bee,
1119                                  "for_each_of_range wrong flags on node %pOF flags=%x\n",
1120                                  np, range.flags);
1121                         unittest(range.size == 0x200000,
1122                                  "for_each_of_range wrong size on node %pOF size=%llx\n",
1123                                  np, range.size);
1124                         unittest(range.cpu_addr == 0xb0000000,
1125                                  "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1126                                  range.cpu_addr, np);
1127                         unittest(range.bus_addr == 0x100000000,
1128                                  "for_each_of_range wrong bus addr (%llx) on node %pOF",
1129                                  range.pci_addr, np);
1130                 }
1131                 i++;
1132         }
1133
1134         of_node_put(np);
1135 }
1136
1137 static void __init of_unittest_reg(void)
1138 {
1139         struct device_node *np;
1140         int ret;
1141         u64 addr, size;
1142
1143         np = of_find_node_by_path("/testcase-data/address-tests/bus@80000000/device@1000");
1144         if (!np) {
1145                 pr_err("missing testcase data\n");
1146                 return;
1147         }
1148
1149         ret = of_property_read_reg(np, 0, &addr, &size);
1150         unittest(!ret, "of_property_read_reg(%pOF) returned error %d\n",
1151                 np, ret);
1152         unittest(addr == 0x1000, "of_property_read_reg(%pOF) untranslated address (%llx) incorrect\n",
1153                 np, addr);
1154
1155         of_node_put(np);
1156 }
1157
1158 static void __init of_unittest_parse_interrupts(void)
1159 {
1160         struct device_node *np;
1161         struct of_phandle_args args;
1162         int i, rc;
1163
1164         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1165                 return;
1166
1167         np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
1168         if (!np) {
1169                 pr_err("missing testcase data\n");
1170                 return;
1171         }
1172
1173         for (i = 0; i < 4; i++) {
1174                 bool passed = true;
1175
1176                 memset(&args, 0, sizeof(args));
1177                 rc = of_irq_parse_one(np, i, &args);
1178
1179                 passed &= !rc;
1180                 passed &= (args.args_count == 1);
1181                 passed &= (args.args[0] == (i + 1));
1182
1183                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1184                          i, args.np, rc);
1185         }
1186         of_node_put(np);
1187
1188         np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
1189         if (!np) {
1190                 pr_err("missing testcase data\n");
1191                 return;
1192         }
1193
1194         for (i = 0; i < 4; i++) {
1195                 bool passed = true;
1196
1197                 memset(&args, 0, sizeof(args));
1198                 rc = of_irq_parse_one(np, i, &args);
1199
1200                 /* Test the values from tests-phandle.dtsi */
1201                 switch (i) {
1202                 case 0:
1203                         passed &= !rc;
1204                         passed &= (args.args_count == 1);
1205                         passed &= (args.args[0] == 9);
1206                         break;
1207                 case 1:
1208                         passed &= !rc;
1209                         passed &= (args.args_count == 3);
1210                         passed &= (args.args[0] == 10);
1211                         passed &= (args.args[1] == 11);
1212                         passed &= (args.args[2] == 12);
1213                         break;
1214                 case 2:
1215                         passed &= !rc;
1216                         passed &= (args.args_count == 2);
1217                         passed &= (args.args[0] == 13);
1218                         passed &= (args.args[1] == 14);
1219                         break;
1220                 case 3:
1221                         passed &= !rc;
1222                         passed &= (args.args_count == 2);
1223                         passed &= (args.args[0] == 15);
1224                         passed &= (args.args[1] == 16);
1225                         break;
1226                 default:
1227                         passed = false;
1228                 }
1229                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1230                          i, args.np, rc);
1231         }
1232         of_node_put(np);
1233 }
1234
1235 static void __init of_unittest_parse_interrupts_extended(void)
1236 {
1237         struct device_node *np;
1238         struct of_phandle_args args;
1239         int i, rc;
1240
1241         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1242                 return;
1243
1244         np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
1245         if (!np) {
1246                 pr_err("missing testcase data\n");
1247                 return;
1248         }
1249
1250         for (i = 0; i < 7; i++) {
1251                 bool passed = true;
1252
1253                 memset(&args, 0, sizeof(args));
1254                 rc = of_irq_parse_one(np, i, &args);
1255
1256                 /* Test the values from tests-phandle.dtsi */
1257                 switch (i) {
1258                 case 0:
1259                         passed &= !rc;
1260                         passed &= (args.args_count == 1);
1261                         passed &= (args.args[0] == 1);
1262                         break;
1263                 case 1:
1264                         passed &= !rc;
1265                         passed &= (args.args_count == 3);
1266                         passed &= (args.args[0] == 2);
1267                         passed &= (args.args[1] == 3);
1268                         passed &= (args.args[2] == 4);
1269                         break;
1270                 case 2:
1271                         passed &= !rc;
1272                         passed &= (args.args_count == 2);
1273                         passed &= (args.args[0] == 5);
1274                         passed &= (args.args[1] == 6);
1275                         break;
1276                 case 3:
1277                         passed &= !rc;
1278                         passed &= (args.args_count == 1);
1279                         passed &= (args.args[0] == 9);
1280                         break;
1281                 case 4:
1282                         passed &= !rc;
1283                         passed &= (args.args_count == 3);
1284                         passed &= (args.args[0] == 10);
1285                         passed &= (args.args[1] == 11);
1286                         passed &= (args.args[2] == 12);
1287                         break;
1288                 case 5:
1289                         passed &= !rc;
1290                         passed &= (args.args_count == 2);
1291                         passed &= (args.args[0] == 13);
1292                         passed &= (args.args[1] == 14);
1293                         break;
1294                 case 6:
1295                         /*
1296                          * Tests child node that is missing property
1297                          * #address-cells.  See the comments in
1298                          * drivers/of/unittest-data/tests-interrupts.dtsi
1299                          * nodes intmap1 and interrupts-extended0
1300                          */
1301                         passed &= !rc;
1302                         passed &= (args.args_count == 1);
1303                         passed &= (args.args[0] == 15);
1304                         break;
1305                 default:
1306                         passed = false;
1307                 }
1308
1309                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1310                          i, args.np, rc);
1311         }
1312         of_node_put(np);
1313 }
1314
1315 static const struct of_device_id match_node_table[] = {
1316         { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
1317         { .data = "B", .type = "type1", }, /* followed by type alone */
1318
1319         { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
1320         { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
1321         { .data = "Cc", .name = "name2", .type = "type2", },
1322
1323         { .data = "E", .compatible = "compat3" },
1324         { .data = "G", .compatible = "compat2", },
1325         { .data = "H", .compatible = "compat2", .name = "name5", },
1326         { .data = "I", .compatible = "compat2", .type = "type1", },
1327         { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
1328         { .data = "K", .compatible = "compat2", .name = "name9", },
1329         {}
1330 };
1331
1332 static struct {
1333         const char *path;
1334         const char *data;
1335 } match_node_tests[] = {
1336         { .path = "/testcase-data/match-node/name0", .data = "A", },
1337         { .path = "/testcase-data/match-node/name1", .data = "B", },
1338         { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
1339         { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
1340         { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
1341         { .path = "/testcase-data/match-node/name3", .data = "E", },
1342         { .path = "/testcase-data/match-node/name4", .data = "G", },
1343         { .path = "/testcase-data/match-node/name5", .data = "H", },
1344         { .path = "/testcase-data/match-node/name6", .data = "G", },
1345         { .path = "/testcase-data/match-node/name7", .data = "I", },
1346         { .path = "/testcase-data/match-node/name8", .data = "J", },
1347         { .path = "/testcase-data/match-node/name9", .data = "K", },
1348 };
1349
1350 static void __init of_unittest_match_node(void)
1351 {
1352         struct device_node *np;
1353         const struct of_device_id *match;
1354         int i;
1355
1356         for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
1357                 np = of_find_node_by_path(match_node_tests[i].path);
1358                 if (!np) {
1359                         unittest(0, "missing testcase node %s\n",
1360                                 match_node_tests[i].path);
1361                         continue;
1362                 }
1363
1364                 match = of_match_node(match_node_table, np);
1365                 if (!match) {
1366                         unittest(0, "%s didn't match anything\n",
1367                                 match_node_tests[i].path);
1368                         continue;
1369                 }
1370
1371                 if (strcmp(match->data, match_node_tests[i].data) != 0) {
1372                         unittest(0, "%s got wrong match. expected %s, got %s\n",
1373                                 match_node_tests[i].path, match_node_tests[i].data,
1374                                 (const char *)match->data);
1375                         continue;
1376                 }
1377                 unittest(1, "passed");
1378         }
1379 }
1380
1381 static struct resource test_bus_res = DEFINE_RES_MEM(0xfffffff8, 2);
1382 static const struct platform_device_info test_bus_info = {
1383         .name = "unittest-bus",
1384 };
1385 static void __init of_unittest_platform_populate(void)
1386 {
1387         int irq, rc;
1388         struct device_node *np, *child, *grandchild;
1389         struct platform_device *pdev, *test_bus;
1390         const struct of_device_id match[] = {
1391                 { .compatible = "test-device", },
1392                 {}
1393         };
1394
1395         np = of_find_node_by_path("/testcase-data");
1396         of_platform_default_populate(np, NULL, NULL);
1397
1398         /* Test that a missing irq domain returns -EPROBE_DEFER */
1399         np = of_find_node_by_path("/testcase-data/testcase-device1");
1400         pdev = of_find_device_by_node(np);
1401         unittest(pdev, "device 1 creation failed\n");
1402
1403         if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1404                 irq = platform_get_irq(pdev, 0);
1405                 unittest(irq == -EPROBE_DEFER,
1406                          "device deferred probe failed - %d\n", irq);
1407
1408                 /* Test that a parsing failure does not return -EPROBE_DEFER */
1409                 np = of_find_node_by_path("/testcase-data/testcase-device2");
1410                 pdev = of_find_device_by_node(np);
1411                 unittest(pdev, "device 2 creation failed\n");
1412
1413                 EXPECT_BEGIN(KERN_INFO,
1414                              "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1415
1416                 irq = platform_get_irq(pdev, 0);
1417
1418                 EXPECT_END(KERN_INFO,
1419                            "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1420
1421                 unittest(irq < 0 && irq != -EPROBE_DEFER,
1422                          "device parsing error failed - %d\n", irq);
1423         }
1424
1425         np = of_find_node_by_path("/testcase-data/platform-tests");
1426         unittest(np, "No testcase data in device tree\n");
1427         if (!np)
1428                 return;
1429
1430         test_bus = platform_device_register_full(&test_bus_info);
1431         rc = PTR_ERR_OR_ZERO(test_bus);
1432         unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1433         if (rc) {
1434                 of_node_put(np);
1435                 return;
1436         }
1437         test_bus->dev.of_node = np;
1438
1439         /*
1440          * Add a dummy resource to the test bus node after it is
1441          * registered to catch problems with un-inserted resources. The
1442          * DT code doesn't insert the resources, and it has caused the
1443          * kernel to oops in the past. This makes sure the same bug
1444          * doesn't crop up again.
1445          */
1446         platform_device_add_resources(test_bus, &test_bus_res, 1);
1447
1448         of_platform_populate(np, match, NULL, &test_bus->dev);
1449         for_each_child_of_node(np, child) {
1450                 for_each_child_of_node(child, grandchild) {
1451                         pdev = of_find_device_by_node(grandchild);
1452                         unittest(pdev,
1453                                  "Could not create device for node '%pOFn'\n",
1454                                  grandchild);
1455                         platform_device_put(pdev);
1456                 }
1457         }
1458
1459         of_platform_depopulate(&test_bus->dev);
1460         for_each_child_of_node(np, child) {
1461                 for_each_child_of_node(child, grandchild)
1462                         unittest(!of_find_device_by_node(grandchild),
1463                                  "device didn't get destroyed '%pOFn'\n",
1464                                  grandchild);
1465         }
1466
1467         platform_device_unregister(test_bus);
1468         of_node_put(np);
1469 }
1470
1471 /**
1472  *      update_node_properties - adds the properties
1473  *      of np into dup node (present in live tree) and
1474  *      updates parent of children of np to dup.
1475  *
1476  *      @np:    node whose properties are being added to the live tree
1477  *      @dup:   node present in live tree to be updated
1478  */
1479 static void update_node_properties(struct device_node *np,
1480                                         struct device_node *dup)
1481 {
1482         struct property *prop;
1483         struct property *save_next;
1484         struct device_node *child;
1485         int ret;
1486
1487         for_each_child_of_node(np, child)
1488                 child->parent = dup;
1489
1490         /*
1491          * "unittest internal error: unable to add testdata property"
1492          *
1493          *    If this message reports a property in node '/__symbols__' then
1494          *    the respective unittest overlay contains a label that has the
1495          *    same name as a label in the live devicetree.  The label will
1496          *    be in the live devicetree only if the devicetree source was
1497          *    compiled with the '-@' option.  If you encounter this error,
1498          *    please consider renaming __all__ of the labels in the unittest
1499          *    overlay dts files with an odd prefix that is unlikely to be
1500          *    used in a real devicetree.
1501          */
1502
1503         /*
1504          * open code for_each_property_of_node() because of_add_property()
1505          * sets prop->next to NULL
1506          */
1507         for (prop = np->properties; prop != NULL; prop = save_next) {
1508                 save_next = prop->next;
1509                 ret = of_add_property(dup, prop);
1510                 if (ret) {
1511                         if (ret == -EEXIST && !strcmp(prop->name, "name"))
1512                                 continue;
1513                         pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1514                                np, prop->name);
1515                 }
1516         }
1517 }
1518
1519 /**
1520  *      attach_node_and_children - attaches nodes
1521  *      and its children to live tree.
1522  *      CAUTION: misleading function name - if node @np already exists in
1523  *      the live tree then children of @np are *not* attached to the live
1524  *      tree.  This works for the current test devicetree nodes because such
1525  *      nodes do not have child nodes.
1526  *
1527  *      @np:    Node to attach to live tree
1528  */
1529 static void attach_node_and_children(struct device_node *np)
1530 {
1531         struct device_node *next, *dup, *child;
1532         unsigned long flags;
1533         const char *full_name;
1534
1535         full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1536
1537         if (!strcmp(full_name, "/__local_fixups__") ||
1538             !strcmp(full_name, "/__fixups__")) {
1539                 kfree(full_name);
1540                 return;
1541         }
1542
1543         dup = of_find_node_by_path(full_name);
1544         kfree(full_name);
1545         if (dup) {
1546                 update_node_properties(np, dup);
1547                 return;
1548         }
1549
1550         child = np->child;
1551         np->child = NULL;
1552
1553         mutex_lock(&of_mutex);
1554         raw_spin_lock_irqsave(&devtree_lock, flags);
1555         np->sibling = np->parent->child;
1556         np->parent->child = np;
1557         of_node_clear_flag(np, OF_DETACHED);
1558         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1559
1560         __of_attach_node_sysfs(np);
1561         mutex_unlock(&of_mutex);
1562
1563         while (child) {
1564                 next = child->sibling;
1565                 attach_node_and_children(child);
1566                 child = next;
1567         }
1568 }
1569
1570 /**
1571  *      unittest_data_add - Reads, copies data from
1572  *      linked tree and attaches it to the live tree
1573  */
1574 static int __init unittest_data_add(void)
1575 {
1576         void *unittest_data;
1577         void *unittest_data_align;
1578         struct device_node *unittest_data_node = NULL, *np;
1579         /*
1580          * __dtbo_testcases_begin[] and __dtbo_testcases_end[] are magically
1581          * created by cmd_dt_S_dtbo in scripts/Makefile.lib
1582          */
1583         extern uint8_t __dtbo_testcases_begin[];
1584         extern uint8_t __dtbo_testcases_end[];
1585         const int size = __dtbo_testcases_end - __dtbo_testcases_begin;
1586         int rc;
1587         void *ret;
1588
1589         if (!size) {
1590                 pr_warn("%s: testcases is empty\n", __func__);
1591                 return -ENODATA;
1592         }
1593
1594         /* creating copy */
1595         unittest_data = kmalloc(size + FDT_ALIGN_SIZE, GFP_KERNEL);
1596         if (!unittest_data)
1597                 return -ENOMEM;
1598
1599         unittest_data_align = PTR_ALIGN(unittest_data, FDT_ALIGN_SIZE);
1600         memcpy(unittest_data_align, __dtbo_testcases_begin, size);
1601
1602         ret = of_fdt_unflatten_tree(unittest_data_align, NULL, &unittest_data_node);
1603         if (!ret) {
1604                 pr_warn("%s: unflatten testcases tree failed\n", __func__);
1605                 kfree(unittest_data);
1606                 return -ENODATA;
1607         }
1608         if (!unittest_data_node) {
1609                 pr_warn("%s: testcases tree is empty\n", __func__);
1610                 kfree(unittest_data);
1611                 return -ENODATA;
1612         }
1613
1614         /*
1615          * This lock normally encloses of_resolve_phandles()
1616          */
1617         of_overlay_mutex_lock();
1618
1619         rc = of_resolve_phandles(unittest_data_node);
1620         if (rc) {
1621                 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1622                 of_overlay_mutex_unlock();
1623                 return -EINVAL;
1624         }
1625
1626         if (!of_root) {
1627                 of_root = unittest_data_node;
1628                 for_each_of_allnodes(np)
1629                         __of_attach_node_sysfs(np);
1630                 of_aliases = of_find_node_by_path("/aliases");
1631                 of_chosen = of_find_node_by_path("/chosen");
1632                 of_overlay_mutex_unlock();
1633                 return 0;
1634         }
1635
1636         EXPECT_BEGIN(KERN_INFO,
1637                      "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1638
1639         /* attach the sub-tree to live tree */
1640         np = unittest_data_node->child;
1641         while (np) {
1642                 struct device_node *next = np->sibling;
1643
1644                 np->parent = of_root;
1645                 /* this will clear OF_DETACHED in np and children */
1646                 attach_node_and_children(np);
1647                 np = next;
1648         }
1649
1650         EXPECT_END(KERN_INFO,
1651                    "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1652
1653         of_overlay_mutex_unlock();
1654
1655         return 0;
1656 }
1657
1658 #ifdef CONFIG_OF_OVERLAY
1659 static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id);
1660
1661 static int unittest_probe(struct platform_device *pdev)
1662 {
1663         struct device *dev = &pdev->dev;
1664         struct device_node *np = dev->of_node;
1665
1666         if (np == NULL) {
1667                 dev_err(dev, "No OF data for device\n");
1668                 return -EINVAL;
1669
1670         }
1671
1672         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1673
1674         of_platform_populate(np, NULL, NULL, &pdev->dev);
1675
1676         return 0;
1677 }
1678
1679 static void unittest_remove(struct platform_device *pdev)
1680 {
1681         struct device *dev = &pdev->dev;
1682         struct device_node *np = dev->of_node;
1683
1684         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1685 }
1686
1687 static const struct of_device_id unittest_match[] = {
1688         { .compatible = "unittest", },
1689         {},
1690 };
1691
1692 static struct platform_driver unittest_driver = {
1693         .probe                  = unittest_probe,
1694         .remove_new             = unittest_remove,
1695         .driver = {
1696                 .name           = "unittest",
1697                 .of_match_table = of_match_ptr(unittest_match),
1698         },
1699 };
1700
1701 /* get the platform device instantiated at the path */
1702 static struct platform_device *of_path_to_platform_device(const char *path)
1703 {
1704         struct device_node *np;
1705         struct platform_device *pdev;
1706
1707         np = of_find_node_by_path(path);
1708         if (np == NULL)
1709                 return NULL;
1710
1711         pdev = of_find_device_by_node(np);
1712         of_node_put(np);
1713
1714         return pdev;
1715 }
1716
1717 /* find out if a platform device exists at that path */
1718 static int of_path_platform_device_exists(const char *path)
1719 {
1720         struct platform_device *pdev;
1721
1722         pdev = of_path_to_platform_device(path);
1723         platform_device_put(pdev);
1724         return pdev != NULL;
1725 }
1726
1727 #ifdef CONFIG_OF_GPIO
1728
1729 struct unittest_gpio_dev {
1730         struct gpio_chip chip;
1731 };
1732
1733 static int unittest_gpio_chip_request_count;
1734 static int unittest_gpio_probe_count;
1735 static int unittest_gpio_probe_pass_count;
1736
1737 static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
1738 {
1739         unittest_gpio_chip_request_count++;
1740
1741         pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
1742                  unittest_gpio_chip_request_count);
1743         return 0;
1744 }
1745
1746 static int unittest_gpio_probe(struct platform_device *pdev)
1747 {
1748         struct unittest_gpio_dev *devptr;
1749         int ret;
1750
1751         unittest_gpio_probe_count++;
1752
1753         devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
1754         if (!devptr)
1755                 return -ENOMEM;
1756
1757         platform_set_drvdata(pdev, devptr);
1758
1759         devptr->chip.fwnode = dev_fwnode(&pdev->dev);
1760         devptr->chip.label = "of-unittest-gpio";
1761         devptr->chip.base = -1; /* dynamic allocation */
1762         devptr->chip.ngpio = 5;
1763         devptr->chip.request = unittest_gpio_chip_request;
1764
1765         ret = gpiochip_add_data(&devptr->chip, NULL);
1766
1767         unittest(!ret,
1768                  "gpiochip_add_data() for node @%pfw failed, ret = %d\n", devptr->chip.fwnode, ret);
1769
1770         if (!ret)
1771                 unittest_gpio_probe_pass_count++;
1772         return ret;
1773 }
1774
1775 static void unittest_gpio_remove(struct platform_device *pdev)
1776 {
1777         struct unittest_gpio_dev *devptr = platform_get_drvdata(pdev);
1778         struct device *dev = &pdev->dev;
1779
1780         dev_dbg(dev, "%s for node @%pfw\n", __func__, devptr->chip.fwnode);
1781
1782         if (devptr->chip.base != -1)
1783                 gpiochip_remove(&devptr->chip);
1784
1785         kfree(devptr);
1786 }
1787
1788 static const struct of_device_id unittest_gpio_id[] = {
1789         { .compatible = "unittest-gpio", },
1790         {}
1791 };
1792
1793 static struct platform_driver unittest_gpio_driver = {
1794         .probe  = unittest_gpio_probe,
1795         .remove_new = unittest_gpio_remove,
1796         .driver = {
1797                 .name           = "unittest-gpio",
1798                 .of_match_table = of_match_ptr(unittest_gpio_id),
1799         },
1800 };
1801
1802 static void __init of_unittest_overlay_gpio(void)
1803 {
1804         int chip_request_count;
1805         int probe_pass_count;
1806         int ret;
1807
1808         /*
1809          * tests: apply overlays before registering driver
1810          * Similar to installing a driver as a module, the
1811          * driver is registered after applying the overlays.
1812          *
1813          * The overlays are applied by overlay_data_apply()
1814          * instead of of_unittest_apply_overlay() so that they
1815          * will not be tracked.  Thus they will not be removed
1816          * by of_unittest_remove_tracked_overlays().
1817          *
1818          * - apply overlay_gpio_01
1819          * - apply overlay_gpio_02a
1820          * - apply overlay_gpio_02b
1821          * - register driver
1822          *
1823          * register driver will result in
1824          *   - probe and processing gpio hog for overlay_gpio_01
1825          *   - probe for overlay_gpio_02a
1826          *   - processing gpio for overlay_gpio_02b
1827          */
1828
1829         probe_pass_count = unittest_gpio_probe_pass_count;
1830         chip_request_count = unittest_gpio_chip_request_count;
1831
1832         /*
1833          * overlay_gpio_01 contains gpio node and child gpio hog node
1834          * overlay_gpio_02a contains gpio node
1835          * overlay_gpio_02b contains child gpio hog node
1836          */
1837
1838         unittest(overlay_data_apply("overlay_gpio_01", NULL),
1839                  "Adding overlay 'overlay_gpio_01' failed\n");
1840
1841         unittest(overlay_data_apply("overlay_gpio_02a", NULL),
1842                  "Adding overlay 'overlay_gpio_02a' failed\n");
1843
1844         unittest(overlay_data_apply("overlay_gpio_02b", NULL),
1845                  "Adding overlay 'overlay_gpio_02b' failed\n");
1846
1847         ret = platform_driver_register(&unittest_gpio_driver);
1848         if (unittest(ret == 0, "could not register unittest gpio driver\n"))
1849                 return;
1850
1851         unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
1852                  "unittest_gpio_probe() failed or not called\n");
1853
1854         unittest(chip_request_count + 2 == unittest_gpio_chip_request_count,
1855                  "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1856                  unittest_gpio_chip_request_count - chip_request_count);
1857
1858         /*
1859          * tests: apply overlays after registering driver
1860          *
1861          * Similar to a driver built-in to the kernel, the
1862          * driver is registered before applying the overlays.
1863          *
1864          * overlay_gpio_03 contains gpio node and child gpio hog node
1865          *
1866          * - apply overlay_gpio_03
1867          *
1868          * apply overlay will result in
1869          *   - probe and processing gpio hog.
1870          */
1871
1872         probe_pass_count = unittest_gpio_probe_pass_count;
1873         chip_request_count = unittest_gpio_chip_request_count;
1874
1875         /* overlay_gpio_03 contains gpio node and child gpio hog node */
1876
1877         unittest(overlay_data_apply("overlay_gpio_03", NULL),
1878                  "Adding overlay 'overlay_gpio_03' failed\n");
1879
1880         unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1881                  "unittest_gpio_probe() failed or not called\n");
1882
1883         unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1884                  "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1885                  unittest_gpio_chip_request_count - chip_request_count);
1886
1887         /*
1888          * overlay_gpio_04a contains gpio node
1889          *
1890          * - apply overlay_gpio_04a
1891          *
1892          * apply the overlay will result in
1893          *   - probe for overlay_gpio_04a
1894          */
1895
1896         probe_pass_count = unittest_gpio_probe_pass_count;
1897         chip_request_count = unittest_gpio_chip_request_count;
1898
1899         /* overlay_gpio_04a contains gpio node */
1900
1901         unittest(overlay_data_apply("overlay_gpio_04a", NULL),
1902                  "Adding overlay 'overlay_gpio_04a' failed\n");
1903
1904         unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1905                  "unittest_gpio_probe() failed or not called\n");
1906
1907         /*
1908          * overlay_gpio_04b contains child gpio hog node
1909          *
1910          * - apply overlay_gpio_04b
1911          *
1912          * apply the overlay will result in
1913          *   - processing gpio for overlay_gpio_04b
1914          */
1915
1916         /* overlay_gpio_04b contains child gpio hog node */
1917
1918         unittest(overlay_data_apply("overlay_gpio_04b", NULL),
1919                  "Adding overlay 'overlay_gpio_04b' failed\n");
1920
1921         unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1922                  "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1923                  unittest_gpio_chip_request_count - chip_request_count);
1924 }
1925
1926 #else
1927
1928 static void __init of_unittest_overlay_gpio(void)
1929 {
1930         /* skip tests */
1931 }
1932
1933 #endif
1934
1935 #if IS_BUILTIN(CONFIG_I2C)
1936
1937 /* get the i2c client device instantiated at the path */
1938 static struct i2c_client *of_path_to_i2c_client(const char *path)
1939 {
1940         struct device_node *np;
1941         struct i2c_client *client;
1942
1943         np = of_find_node_by_path(path);
1944         if (np == NULL)
1945                 return NULL;
1946
1947         client = of_find_i2c_device_by_node(np);
1948         of_node_put(np);
1949
1950         return client;
1951 }
1952
1953 /* find out if a i2c client device exists at that path */
1954 static int of_path_i2c_client_exists(const char *path)
1955 {
1956         struct i2c_client *client;
1957
1958         client = of_path_to_i2c_client(path);
1959         if (client)
1960                 put_device(&client->dev);
1961         return client != NULL;
1962 }
1963 #else
1964 static int of_path_i2c_client_exists(const char *path)
1965 {
1966         return 0;
1967 }
1968 #endif
1969
1970 enum overlay_type {
1971         PDEV_OVERLAY,
1972         I2C_OVERLAY
1973 };
1974
1975 static int of_path_device_type_exists(const char *path,
1976                 enum overlay_type ovtype)
1977 {
1978         switch (ovtype) {
1979         case PDEV_OVERLAY:
1980                 return of_path_platform_device_exists(path);
1981         case I2C_OVERLAY:
1982                 return of_path_i2c_client_exists(path);
1983         }
1984         return 0;
1985 }
1986
1987 static const char *unittest_path(int nr, enum overlay_type ovtype)
1988 {
1989         const char *base;
1990         static char buf[256];
1991
1992         switch (ovtype) {
1993         case PDEV_OVERLAY:
1994                 base = "/testcase-data/overlay-node/test-bus";
1995                 break;
1996         case I2C_OVERLAY:
1997                 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1998                 break;
1999         default:
2000                 buf[0] = '\0';
2001                 return buf;
2002         }
2003         snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
2004         buf[sizeof(buf) - 1] = '\0';
2005         return buf;
2006 }
2007
2008 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
2009 {
2010         const char *path;
2011
2012         path = unittest_path(unittest_nr, ovtype);
2013
2014         switch (ovtype) {
2015         case PDEV_OVERLAY:
2016                 return of_path_platform_device_exists(path);
2017         case I2C_OVERLAY:
2018                 return of_path_i2c_client_exists(path);
2019         }
2020         return 0;
2021 }
2022
2023 static const char *overlay_name_from_nr(int nr)
2024 {
2025         static char buf[256];
2026
2027         snprintf(buf, sizeof(buf) - 1,
2028                 "overlay_%d", nr);
2029         buf[sizeof(buf) - 1] = '\0';
2030
2031         return buf;
2032 }
2033
2034 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
2035
2036 #define MAX_TRACK_OVCS_IDS 256
2037
2038 static int track_ovcs_id[MAX_TRACK_OVCS_IDS];
2039 static int track_ovcs_id_overlay_nr[MAX_TRACK_OVCS_IDS];
2040 static int track_ovcs_id_cnt;
2041
2042 static void of_unittest_track_overlay(int ovcs_id, int overlay_nr)
2043 {
2044         if (WARN_ON(track_ovcs_id_cnt >= MAX_TRACK_OVCS_IDS))
2045                 return;
2046
2047         track_ovcs_id[track_ovcs_id_cnt] = ovcs_id;
2048         track_ovcs_id_overlay_nr[track_ovcs_id_cnt] = overlay_nr;
2049         track_ovcs_id_cnt++;
2050 }
2051
2052 static void of_unittest_untrack_overlay(int ovcs_id)
2053 {
2054         if (WARN_ON(track_ovcs_id_cnt < 1))
2055                 return;
2056
2057         track_ovcs_id_cnt--;
2058
2059         /* If out of synch then test is broken.  Do not try to recover. */
2060         WARN_ON(track_ovcs_id[track_ovcs_id_cnt] != ovcs_id);
2061 }
2062
2063 static void of_unittest_remove_tracked_overlays(void)
2064 {
2065         int ret, ovcs_id, overlay_nr, save_ovcs_id;
2066         const char *overlay_name;
2067
2068         while (track_ovcs_id_cnt > 0) {
2069
2070                 ovcs_id = track_ovcs_id[track_ovcs_id_cnt - 1];
2071                 overlay_nr = track_ovcs_id_overlay_nr[track_ovcs_id_cnt - 1];
2072                 save_ovcs_id = ovcs_id;
2073                 ret = of_overlay_remove(&ovcs_id);
2074                 if (ret == -ENODEV) {
2075                         overlay_name = overlay_name_from_nr(overlay_nr);
2076                         pr_warn("%s: of_overlay_remove() for overlay \"%s\" failed, ret = %d\n",
2077                                 __func__, overlay_name, ret);
2078                 }
2079                 of_unittest_untrack_overlay(save_ovcs_id);
2080         }
2081
2082 }
2083
2084 static int __init of_unittest_apply_overlay(int overlay_nr, int *ovcs_id)
2085 {
2086         /*
2087          * The overlay will be tracked, thus it will be removed
2088          * by of_unittest_remove_tracked_overlays().
2089          */
2090
2091         const char *overlay_name;
2092
2093         overlay_name = overlay_name_from_nr(overlay_nr);
2094
2095         if (!overlay_data_apply(overlay_name, ovcs_id)) {
2096                 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2097                 return -EFAULT;
2098         }
2099         of_unittest_track_overlay(*ovcs_id, overlay_nr);
2100
2101         return 0;
2102 }
2103
2104 /* apply an overlay while checking before and after states */
2105 static int __init of_unittest_apply_overlay_check(int overlay_nr,
2106                 int unittest_nr, int before, int after,
2107                 enum overlay_type ovtype)
2108 {
2109         int ret, ovcs_id;
2110
2111         /* unittest device must not be in before state */
2112         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2113                 unittest(0, "%s with device @\"%s\" %s\n",
2114                                 overlay_name_from_nr(overlay_nr),
2115                                 unittest_path(unittest_nr, ovtype),
2116                                 !before ? "enabled" : "disabled");
2117                 return -EINVAL;
2118         }
2119
2120         ovcs_id = 0;
2121         ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2122         if (ret != 0) {
2123                 /* of_unittest_apply_overlay already called unittest() */
2124                 return ret;
2125         }
2126
2127         /* unittest device must be to set to after state */
2128         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2129                 unittest(0, "%s failed to create @\"%s\" %s\n",
2130                                 overlay_name_from_nr(overlay_nr),
2131                                 unittest_path(unittest_nr, ovtype),
2132                                 !after ? "enabled" : "disabled");
2133                 return -EINVAL;
2134         }
2135
2136         return 0;
2137 }
2138
2139 /* apply an overlay and then revert it while checking before, after states */
2140 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
2141                 int unittest_nr, int before, int after,
2142                 enum overlay_type ovtype)
2143 {
2144         int ret, ovcs_id, save_ovcs_id;
2145
2146         /* unittest device must be in before state */
2147         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2148                 unittest(0, "%s with device @\"%s\" %s\n",
2149                                 overlay_name_from_nr(overlay_nr),
2150                                 unittest_path(unittest_nr, ovtype),
2151                                 !before ? "enabled" : "disabled");
2152                 return -EINVAL;
2153         }
2154
2155         /* apply the overlay */
2156         ovcs_id = 0;
2157         ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2158         if (ret != 0) {
2159                 /* of_unittest_apply_overlay already called unittest() */
2160                 return ret;
2161         }
2162
2163         /* unittest device must be in after state */
2164         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2165                 unittest(0, "%s failed to create @\"%s\" %s\n",
2166                                 overlay_name_from_nr(overlay_nr),
2167                                 unittest_path(unittest_nr, ovtype),
2168                                 !after ? "enabled" : "disabled");
2169                 return -EINVAL;
2170         }
2171
2172         save_ovcs_id = ovcs_id;
2173         ret = of_overlay_remove(&ovcs_id);
2174         if (ret != 0) {
2175                 unittest(0, "%s failed to be destroyed @\"%s\"\n",
2176                                 overlay_name_from_nr(overlay_nr),
2177                                 unittest_path(unittest_nr, ovtype));
2178                 return ret;
2179         }
2180         of_unittest_untrack_overlay(save_ovcs_id);
2181
2182         /* unittest device must be again in before state */
2183         if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
2184                 unittest(0, "%s with device @\"%s\" %s\n",
2185                                 overlay_name_from_nr(overlay_nr),
2186                                 unittest_path(unittest_nr, ovtype),
2187                                 !before ? "enabled" : "disabled");
2188                 return -EINVAL;
2189         }
2190
2191         return 0;
2192 }
2193
2194 /* test activation of device */
2195 static void __init of_unittest_overlay_0(void)
2196 {
2197         int ret;
2198
2199         EXPECT_BEGIN(KERN_INFO,
2200                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2201
2202         /* device should enable */
2203         ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
2204
2205         EXPECT_END(KERN_INFO,
2206                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2207
2208         if (ret)
2209                 return;
2210
2211         unittest(1, "overlay test %d passed\n", 0);
2212 }
2213
2214 /* test deactivation of device */
2215 static void __init of_unittest_overlay_1(void)
2216 {
2217         int ret;
2218
2219         EXPECT_BEGIN(KERN_INFO,
2220                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2221
2222         /* device should disable */
2223         ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
2224
2225         EXPECT_END(KERN_INFO,
2226                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2227
2228         if (ret)
2229                 return;
2230
2231         unittest(1, "overlay test %d passed\n", 1);
2232
2233 }
2234
2235 /* test activation of device */
2236 static void __init of_unittest_overlay_2(void)
2237 {
2238         int ret;
2239
2240         EXPECT_BEGIN(KERN_INFO,
2241                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2242
2243         /* device should enable */
2244         ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
2245
2246         EXPECT_END(KERN_INFO,
2247                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2248
2249         if (ret)
2250                 return;
2251         unittest(1, "overlay test %d passed\n", 2);
2252 }
2253
2254 /* test deactivation of device */
2255 static void __init of_unittest_overlay_3(void)
2256 {
2257         int ret;
2258
2259         EXPECT_BEGIN(KERN_INFO,
2260                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2261
2262         /* device should disable */
2263         ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
2264
2265         EXPECT_END(KERN_INFO,
2266                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2267
2268         if (ret)
2269                 return;
2270
2271         unittest(1, "overlay test %d passed\n", 3);
2272 }
2273
2274 /* test activation of a full device node */
2275 static void __init of_unittest_overlay_4(void)
2276 {
2277         /* device should disable */
2278         if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
2279                 return;
2280
2281         unittest(1, "overlay test %d passed\n", 4);
2282 }
2283
2284 /* test overlay apply/revert sequence */
2285 static void __init of_unittest_overlay_5(void)
2286 {
2287         int ret;
2288
2289         EXPECT_BEGIN(KERN_INFO,
2290                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2291
2292         /* device should disable */
2293         ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
2294
2295         EXPECT_END(KERN_INFO,
2296                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2297
2298         if (ret)
2299                 return;
2300
2301         unittest(1, "overlay test %d passed\n", 5);
2302 }
2303
2304 /* test overlay application in sequence */
2305 static void __init of_unittest_overlay_6(void)
2306 {
2307         int i, save_ovcs_id[2], ovcs_id;
2308         int overlay_nr = 6, unittest_nr = 6;
2309         int before = 0, after = 1;
2310         const char *overlay_name;
2311
2312         int ret;
2313
2314         /* unittest device must be in before state */
2315         for (i = 0; i < 2; i++) {
2316                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2317                                 != before) {
2318                         unittest(0, "%s with device @\"%s\" %s\n",
2319                                         overlay_name_from_nr(overlay_nr + i),
2320                                         unittest_path(unittest_nr + i,
2321                                                 PDEV_OVERLAY),
2322                                         !before ? "enabled" : "disabled");
2323                         return;
2324                 }
2325         }
2326
2327         /* apply the overlays */
2328
2329         EXPECT_BEGIN(KERN_INFO,
2330                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2331
2332         overlay_name = overlay_name_from_nr(overlay_nr + 0);
2333
2334         ret = overlay_data_apply(overlay_name, &ovcs_id);
2335
2336         if (!ret) {
2337                 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2338                         return;
2339         }
2340         save_ovcs_id[0] = ovcs_id;
2341         of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2342
2343         EXPECT_END(KERN_INFO,
2344                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2345
2346         EXPECT_BEGIN(KERN_INFO,
2347                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2348
2349         overlay_name = overlay_name_from_nr(overlay_nr + 1);
2350
2351         ret = overlay_data_apply(overlay_name, &ovcs_id);
2352
2353         if (!ret) {
2354                 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2355                         return;
2356         }
2357         save_ovcs_id[1] = ovcs_id;
2358         of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2359
2360         EXPECT_END(KERN_INFO,
2361                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2362
2363
2364         for (i = 0; i < 2; i++) {
2365                 /* unittest device must be in after state */
2366                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2367                                 != after) {
2368                         unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
2369                                         overlay_name_from_nr(overlay_nr + i),
2370                                         unittest_path(unittest_nr + i,
2371                                                 PDEV_OVERLAY),
2372                                         !after ? "enabled" : "disabled");
2373                         return;
2374                 }
2375         }
2376
2377         for (i = 1; i >= 0; i--) {
2378                 ovcs_id = save_ovcs_id[i];
2379                 if (of_overlay_remove(&ovcs_id)) {
2380                         unittest(0, "%s failed destroy @\"%s\"\n",
2381                                         overlay_name_from_nr(overlay_nr + i),
2382                                         unittest_path(unittest_nr + i,
2383                                                 PDEV_OVERLAY));
2384                         return;
2385                 }
2386                 of_unittest_untrack_overlay(save_ovcs_id[i]);
2387         }
2388
2389         for (i = 0; i < 2; i++) {
2390                 /* unittest device must be again in before state */
2391                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2392                                 != before) {
2393                         unittest(0, "%s with device @\"%s\" %s\n",
2394                                         overlay_name_from_nr(overlay_nr + i),
2395                                         unittest_path(unittest_nr + i,
2396                                                 PDEV_OVERLAY),
2397                                         !before ? "enabled" : "disabled");
2398                         return;
2399                 }
2400         }
2401
2402         unittest(1, "overlay test %d passed\n", 6);
2403
2404 }
2405
2406 /* test overlay application in sequence */
2407 static void __init of_unittest_overlay_8(void)
2408 {
2409         int i, save_ovcs_id[2], ovcs_id;
2410         int overlay_nr = 8, unittest_nr = 8;
2411         const char *overlay_name;
2412         int ret;
2413
2414         /* we don't care about device state in this test */
2415
2416         EXPECT_BEGIN(KERN_INFO,
2417                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2418
2419         overlay_name = overlay_name_from_nr(overlay_nr + 0);
2420
2421         ret = overlay_data_apply(overlay_name, &ovcs_id);
2422         if (!ret)
2423                 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2424
2425         EXPECT_END(KERN_INFO,
2426                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2427
2428         if (!ret)
2429                 return;
2430
2431         save_ovcs_id[0] = ovcs_id;
2432         of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2433
2434         overlay_name = overlay_name_from_nr(overlay_nr + 1);
2435
2436         EXPECT_BEGIN(KERN_INFO,
2437                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2438
2439         /* apply the overlays */
2440         ret = overlay_data_apply(overlay_name, &ovcs_id);
2441
2442         EXPECT_END(KERN_INFO,
2443                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2444
2445         if (!ret) {
2446                 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2447                 return;
2448         }
2449
2450         save_ovcs_id[1] = ovcs_id;
2451         of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2452
2453         /* now try to remove first overlay (it should fail) */
2454         ovcs_id = save_ovcs_id[0];
2455
2456         EXPECT_BEGIN(KERN_INFO,
2457                      "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2458
2459         EXPECT_BEGIN(KERN_INFO,
2460                      "OF: overlay: overlay #6 is not topmost");
2461
2462         ret = of_overlay_remove(&ovcs_id);
2463
2464         EXPECT_END(KERN_INFO,
2465                    "OF: overlay: overlay #6 is not topmost");
2466
2467         EXPECT_END(KERN_INFO,
2468                    "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2469
2470         if (!ret) {
2471                 /*
2472                  * Should never get here.  If we do, expect a lot of
2473                  * subsequent tracking and overlay removal related errors.
2474                  */
2475                 unittest(0, "%s was destroyed @\"%s\"\n",
2476                                 overlay_name_from_nr(overlay_nr + 0),
2477                                 unittest_path(unittest_nr,
2478                                         PDEV_OVERLAY));
2479                 return;
2480         }
2481
2482         /* removing them in order should work */
2483         for (i = 1; i >= 0; i--) {
2484                 ovcs_id = save_ovcs_id[i];
2485                 if (of_overlay_remove(&ovcs_id)) {
2486                         unittest(0, "%s not destroyed @\"%s\"\n",
2487                                         overlay_name_from_nr(overlay_nr + i),
2488                                         unittest_path(unittest_nr,
2489                                                 PDEV_OVERLAY));
2490                         return;
2491                 }
2492                 of_unittest_untrack_overlay(save_ovcs_id[i]);
2493         }
2494
2495         unittest(1, "overlay test %d passed\n", 8);
2496 }
2497
2498 /* test insertion of a bus with parent devices */
2499 static void __init of_unittest_overlay_10(void)
2500 {
2501         int ret;
2502         char *child_path;
2503
2504         /* device should disable */
2505         ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
2506
2507         if (unittest(ret == 0,
2508                         "overlay test %d failed; overlay application\n", 10))
2509                 return;
2510
2511         child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
2512                         unittest_path(10, PDEV_OVERLAY));
2513         if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
2514                 return;
2515
2516         ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
2517         kfree(child_path);
2518
2519         unittest(ret, "overlay test %d failed; no child device\n", 10);
2520 }
2521
2522 /* test insertion of a bus with parent devices (and revert) */
2523 static void __init of_unittest_overlay_11(void)
2524 {
2525         int ret;
2526
2527         /* device should disable */
2528         ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
2529                         PDEV_OVERLAY);
2530
2531         unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2532 }
2533
2534 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2535
2536 struct unittest_i2c_bus_data {
2537         struct platform_device  *pdev;
2538         struct i2c_adapter      adap;
2539 };
2540
2541 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2542                 struct i2c_msg *msgs, int num)
2543 {
2544         struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2545
2546         (void)std;
2547
2548         return num;
2549 }
2550
2551 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2552 {
2553         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2554 }
2555
2556 static const struct i2c_algorithm unittest_i2c_algo = {
2557         .master_xfer    = unittest_i2c_master_xfer,
2558         .functionality  = unittest_i2c_functionality,
2559 };
2560
2561 static int unittest_i2c_bus_probe(struct platform_device *pdev)
2562 {
2563         struct device *dev = &pdev->dev;
2564         struct device_node *np = dev->of_node;
2565         struct unittest_i2c_bus_data *std;
2566         struct i2c_adapter *adap;
2567         int ret;
2568
2569         if (np == NULL) {
2570                 dev_err(dev, "No OF data for device\n");
2571                 return -EINVAL;
2572
2573         }
2574
2575         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2576
2577         std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
2578         if (!std)
2579                 return -ENOMEM;
2580
2581         /* link them together */
2582         std->pdev = pdev;
2583         platform_set_drvdata(pdev, std);
2584
2585         adap = &std->adap;
2586         i2c_set_adapdata(adap, std);
2587         adap->nr = -1;
2588         strscpy(adap->name, pdev->name, sizeof(adap->name));
2589         adap->class = I2C_CLASS_DEPRECATED;
2590         adap->algo = &unittest_i2c_algo;
2591         adap->dev.parent = dev;
2592         adap->dev.of_node = dev->of_node;
2593         adap->timeout = 5 * HZ;
2594         adap->retries = 3;
2595
2596         ret = i2c_add_numbered_adapter(adap);
2597         if (ret != 0) {
2598                 dev_err(dev, "Failed to add I2C adapter\n");
2599                 return ret;
2600         }
2601
2602         return 0;
2603 }
2604
2605 static void unittest_i2c_bus_remove(struct platform_device *pdev)
2606 {
2607         struct device *dev = &pdev->dev;
2608         struct device_node *np = dev->of_node;
2609         struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
2610
2611         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2612         i2c_del_adapter(&std->adap);
2613 }
2614
2615 static const struct of_device_id unittest_i2c_bus_match[] = {
2616         { .compatible = "unittest-i2c-bus", },
2617         {},
2618 };
2619
2620 static struct platform_driver unittest_i2c_bus_driver = {
2621         .probe                  = unittest_i2c_bus_probe,
2622         .remove_new             = unittest_i2c_bus_remove,
2623         .driver = {
2624                 .name           = "unittest-i2c-bus",
2625                 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
2626         },
2627 };
2628
2629 static int unittest_i2c_dev_probe(struct i2c_client *client)
2630 {
2631         struct device *dev = &client->dev;
2632         struct device_node *np = client->dev.of_node;
2633
2634         if (!np) {
2635                 dev_err(dev, "No OF node\n");
2636                 return -EINVAL;
2637         }
2638
2639         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2640
2641         return 0;
2642 };
2643
2644 static void unittest_i2c_dev_remove(struct i2c_client *client)
2645 {
2646         struct device *dev = &client->dev;
2647         struct device_node *np = client->dev.of_node;
2648
2649         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2650 }
2651
2652 static const struct i2c_device_id unittest_i2c_dev_id[] = {
2653         { .name = "unittest-i2c-dev" },
2654         { }
2655 };
2656
2657 static struct i2c_driver unittest_i2c_dev_driver = {
2658         .driver = {
2659                 .name = "unittest-i2c-dev",
2660         },
2661         .probe = unittest_i2c_dev_probe,
2662         .remove = unittest_i2c_dev_remove,
2663         .id_table = unittest_i2c_dev_id,
2664 };
2665
2666 #if IS_BUILTIN(CONFIG_I2C_MUX)
2667
2668 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
2669 {
2670         return 0;
2671 }
2672
2673 static int unittest_i2c_mux_probe(struct i2c_client *client)
2674 {
2675         int i, nchans;
2676         struct device *dev = &client->dev;
2677         struct i2c_adapter *adap = client->adapter;
2678         struct device_node *np = client->dev.of_node, *child;
2679         struct i2c_mux_core *muxc;
2680         u32 reg, max_reg;
2681
2682         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2683
2684         if (!np) {
2685                 dev_err(dev, "No OF node\n");
2686                 return -EINVAL;
2687         }
2688
2689         max_reg = (u32)-1;
2690         for_each_child_of_node(np, child) {
2691                 if (of_property_read_u32(child, "reg", &reg))
2692                         continue;
2693                 if (max_reg == (u32)-1 || reg > max_reg)
2694                         max_reg = reg;
2695         }
2696         nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
2697         if (nchans == 0) {
2698                 dev_err(dev, "No channels\n");
2699                 return -EINVAL;
2700         }
2701
2702         muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
2703                              unittest_i2c_mux_select_chan, NULL);
2704         if (!muxc)
2705                 return -ENOMEM;
2706         for (i = 0; i < nchans; i++) {
2707                 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
2708                         dev_err(dev, "Failed to register mux #%d\n", i);
2709                         i2c_mux_del_adapters(muxc);
2710                         return -ENODEV;
2711                 }
2712         }
2713
2714         i2c_set_clientdata(client, muxc);
2715
2716         return 0;
2717 };
2718
2719 static void unittest_i2c_mux_remove(struct i2c_client *client)
2720 {
2721         struct device *dev = &client->dev;
2722         struct device_node *np = client->dev.of_node;
2723         struct i2c_mux_core *muxc = i2c_get_clientdata(client);
2724
2725         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2726         i2c_mux_del_adapters(muxc);
2727 }
2728
2729 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2730         { .name = "unittest-i2c-mux" },
2731         { }
2732 };
2733
2734 static struct i2c_driver unittest_i2c_mux_driver = {
2735         .driver = {
2736                 .name = "unittest-i2c-mux",
2737         },
2738         .probe = unittest_i2c_mux_probe,
2739         .remove = unittest_i2c_mux_remove,
2740         .id_table = unittest_i2c_mux_id,
2741 };
2742
2743 #endif
2744
2745 static int of_unittest_overlay_i2c_init(void)
2746 {
2747         int ret;
2748
2749         ret = i2c_add_driver(&unittest_i2c_dev_driver);
2750         if (unittest(ret == 0,
2751                         "could not register unittest i2c device driver\n"))
2752                 return ret;
2753
2754         ret = platform_driver_register(&unittest_i2c_bus_driver);
2755
2756         if (unittest(ret == 0,
2757                         "could not register unittest i2c bus driver\n"))
2758                 return ret;
2759
2760 #if IS_BUILTIN(CONFIG_I2C_MUX)
2761
2762         EXPECT_BEGIN(KERN_INFO,
2763                      "i2c i2c-1: Added multiplexed i2c bus 2");
2764
2765         ret = i2c_add_driver(&unittest_i2c_mux_driver);
2766
2767         EXPECT_END(KERN_INFO,
2768                    "i2c i2c-1: Added multiplexed i2c bus 2");
2769
2770         if (unittest(ret == 0,
2771                         "could not register unittest i2c mux driver\n"))
2772                 return ret;
2773 #endif
2774
2775         return 0;
2776 }
2777
2778 static void of_unittest_overlay_i2c_cleanup(void)
2779 {
2780 #if IS_BUILTIN(CONFIG_I2C_MUX)
2781         i2c_del_driver(&unittest_i2c_mux_driver);
2782 #endif
2783         platform_driver_unregister(&unittest_i2c_bus_driver);
2784         i2c_del_driver(&unittest_i2c_dev_driver);
2785 }
2786
2787 static void __init of_unittest_overlay_i2c_12(void)
2788 {
2789         int ret;
2790
2791         /* device should enable */
2792         EXPECT_BEGIN(KERN_INFO,
2793                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2794
2795         ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
2796
2797         EXPECT_END(KERN_INFO,
2798                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2799
2800         if (ret)
2801                 return;
2802
2803         unittest(1, "overlay test %d passed\n", 12);
2804 }
2805
2806 /* test deactivation of device */
2807 static void __init of_unittest_overlay_i2c_13(void)
2808 {
2809         int ret;
2810
2811         EXPECT_BEGIN(KERN_INFO,
2812                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2813
2814         /* device should disable */
2815         ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
2816
2817         EXPECT_END(KERN_INFO,
2818                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2819
2820         if (ret)
2821                 return;
2822
2823         unittest(1, "overlay test %d passed\n", 13);
2824 }
2825
2826 /* just check for i2c mux existence */
2827 static void of_unittest_overlay_i2c_14(void)
2828 {
2829 }
2830
2831 static void __init of_unittest_overlay_i2c_15(void)
2832 {
2833         int ret;
2834
2835         /* device should enable */
2836         EXPECT_BEGIN(KERN_INFO,
2837                      "i2c i2c-1: Added multiplexed i2c bus 3");
2838
2839         ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
2840
2841         EXPECT_END(KERN_INFO,
2842                    "i2c i2c-1: Added multiplexed i2c bus 3");
2843
2844         if (ret)
2845                 return;
2846
2847         unittest(1, "overlay test %d passed\n", 15);
2848 }
2849
2850 #else
2851
2852 static inline void of_unittest_overlay_i2c_14(void) { }
2853 static inline void of_unittest_overlay_i2c_15(void) { }
2854
2855 #endif
2856
2857 static int of_notify(struct notifier_block *nb, unsigned long action,
2858                      void *arg)
2859 {
2860         struct of_overlay_notify_data *nd = arg;
2861         struct device_node *found;
2862         int ret;
2863
2864         /*
2865          * For overlay_16 .. overlay_19, check that returning an error
2866          * works for each of the actions by setting an arbitrary return
2867          * error number that matches the test number.  e.g. for unittest16,
2868          * ret = -EBUSY which is -16.
2869          *
2870          * OVERLAY_INFO() for the overlays is declared to expect the same
2871          * error number, so overlay_data_apply() will return no error.
2872          *
2873          * overlay_20 will return NOTIFY_DONE
2874          */
2875
2876         ret = 0;
2877         of_node_get(nd->overlay);
2878
2879         switch (action) {
2880
2881         case OF_OVERLAY_PRE_APPLY:
2882                 found = of_find_node_by_name(nd->overlay, "test-unittest16");
2883                 if (found) {
2884                         of_node_put(found);
2885                         ret = -EBUSY;
2886                 }
2887                 break;
2888
2889         case OF_OVERLAY_POST_APPLY:
2890                 found = of_find_node_by_name(nd->overlay, "test-unittest17");
2891                 if (found) {
2892                         of_node_put(found);
2893                         ret = -EEXIST;
2894                 }
2895                 break;
2896
2897         case OF_OVERLAY_PRE_REMOVE:
2898                 found = of_find_node_by_name(nd->overlay, "test-unittest18");
2899                 if (found) {
2900                         of_node_put(found);
2901                         ret = -EXDEV;
2902                 }
2903                 break;
2904
2905         case OF_OVERLAY_POST_REMOVE:
2906                 found = of_find_node_by_name(nd->overlay, "test-unittest19");
2907                 if (found) {
2908                         of_node_put(found);
2909                         ret = -ENODEV;
2910                 }
2911                 break;
2912
2913         default:                        /* should not happen */
2914                 of_node_put(nd->overlay);
2915                 ret = -EINVAL;
2916                 break;
2917         }
2918
2919         if (ret)
2920                 return notifier_from_errno(ret);
2921
2922         return NOTIFY_DONE;
2923 }
2924
2925 static struct notifier_block of_nb = {
2926         .notifier_call = of_notify,
2927 };
2928
2929 static void __init of_unittest_overlay_notify(void)
2930 {
2931         int ovcs_id;
2932         int ret;
2933
2934         ret = of_overlay_notifier_register(&of_nb);
2935         unittest(!ret,
2936                  "of_overlay_notifier_register() failed, ret = %d\n", ret);
2937         if (ret)
2938                 return;
2939
2940         /*
2941          * The overlays are applied by overlay_data_apply()
2942          * instead of of_unittest_apply_overlay() so that they
2943          * will not be tracked.  Thus they will not be removed
2944          * by of_unittest_remove_tracked_overlays().
2945          *
2946          * Applying overlays 16 - 19 will each trigger an error for a
2947          * different action in of_notify().
2948          *
2949          * Applying overlay 20 will not trigger any error in of_notify().
2950          */
2951
2952         /* ---  overlay 16  --- */
2953
2954         EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
2955
2956         unittest(overlay_data_apply("overlay_16", &ovcs_id),
2957                  "test OF_OVERLAY_PRE_APPLY notify injected error\n");
2958
2959         EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
2960
2961         unittest(ovcs_id, "ovcs_id not created for overlay_16\n");
2962
2963         /* ---  overlay 17  --- */
2964
2965         EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
2966
2967         unittest(overlay_data_apply("overlay_17", &ovcs_id),
2968                  "test OF_OVERLAY_POST_APPLY notify injected error\n");
2969
2970         EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
2971
2972         unittest(ovcs_id, "ovcs_id not created for overlay_17\n");
2973
2974         if (ovcs_id) {
2975                 ret = of_overlay_remove(&ovcs_id);
2976                 unittest(!ret,
2977                         "overlay_17 of_overlay_remove(), ret = %d\n", ret);
2978         }
2979
2980         /* ---  overlay 18  --- */
2981
2982         unittest(overlay_data_apply("overlay_18", &ovcs_id),
2983                  "OF_OVERLAY_PRE_REMOVE notify injected error\n");
2984
2985         unittest(ovcs_id, "ovcs_id not created for overlay_18\n");
2986
2987         if (ovcs_id) {
2988                 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
2989
2990                 ret = of_overlay_remove(&ovcs_id);
2991                 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
2992                 if (ret == -EXDEV) {
2993                         /*
2994                          * change set ovcs_id should still exist
2995                          */
2996                         unittest(1, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE\n");
2997                 } else {
2998                         unittest(0, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE not returned\n");
2999                 }
3000         } else {
3001                 unittest(1, "ovcs_id not created for overlay_18\n");
3002         }
3003
3004         unittest(ovcs_id, "ovcs_id removed for overlay_18\n");
3005
3006         /* ---  overlay 19  --- */
3007
3008         unittest(overlay_data_apply("overlay_19", &ovcs_id),
3009                  "OF_OVERLAY_POST_REMOVE notify injected error\n");
3010
3011         unittest(ovcs_id, "ovcs_id not created for overlay_19\n");
3012
3013         if (ovcs_id) {
3014                 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
3015                 ret = of_overlay_remove(&ovcs_id);
3016                 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
3017                 if (ret == -ENODEV)
3018                         unittest(1, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE\n");
3019                 else
3020                         unittest(0, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE not returned\n");
3021         } else {
3022                 unittest(1, "ovcs_id removed for overlay_19\n");
3023         }
3024
3025         unittest(!ovcs_id, "changeset ovcs_id = %d not removed for overlay_19\n",
3026                  ovcs_id);
3027
3028         /* ---  overlay 20  --- */
3029
3030         unittest(overlay_data_apply("overlay_20", &ovcs_id),
3031                  "overlay notify no injected error\n");
3032
3033         if (ovcs_id) {
3034                 ret = of_overlay_remove(&ovcs_id);
3035                 if (ret)
3036                         unittest(1, "overlay_20 failed to be destroyed, ret = %d\n",
3037                                  ret);
3038         } else {
3039                 unittest(1, "ovcs_id not created for overlay_20\n");
3040         }
3041
3042         unittest(!of_overlay_notifier_unregister(&of_nb),
3043                  "of_overlay_notifier_unregister() failed, ret = %d\n", ret);
3044 }
3045
3046 static void __init of_unittest_overlay(void)
3047 {
3048         struct device_node *bus_np = NULL;
3049
3050         if (platform_driver_register(&unittest_driver)) {
3051                 unittest(0, "could not register unittest driver\n");
3052                 goto out;
3053         }
3054
3055         bus_np = of_find_node_by_path(bus_path);
3056         if (bus_np == NULL) {
3057                 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
3058                 goto out;
3059         }
3060
3061         if (of_platform_default_populate(bus_np, NULL, NULL)) {
3062                 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
3063                 goto out;
3064         }
3065
3066         if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
3067                 unittest(0, "could not find unittest0 @ \"%s\"\n",
3068                                 unittest_path(100, PDEV_OVERLAY));
3069                 goto out;
3070         }
3071
3072         if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
3073                 unittest(0, "unittest1 @ \"%s\" should not exist\n",
3074                                 unittest_path(101, PDEV_OVERLAY));
3075                 goto out;
3076         }
3077
3078         unittest(1, "basic infrastructure of overlays passed");
3079
3080         /* tests in sequence */
3081         of_unittest_overlay_0();
3082         of_unittest_overlay_1();
3083         of_unittest_overlay_2();
3084         of_unittest_overlay_3();
3085         of_unittest_overlay_4();
3086         of_unittest_overlay_5();
3087         of_unittest_overlay_6();
3088         of_unittest_overlay_8();
3089
3090         of_unittest_overlay_10();
3091         of_unittest_overlay_11();
3092
3093 #if IS_BUILTIN(CONFIG_I2C)
3094         if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
3095                 goto out;
3096
3097         of_unittest_overlay_i2c_12();
3098         of_unittest_overlay_i2c_13();
3099         of_unittest_overlay_i2c_14();
3100         of_unittest_overlay_i2c_15();
3101
3102         of_unittest_overlay_i2c_cleanup();
3103 #endif
3104
3105         of_unittest_overlay_gpio();
3106
3107         of_unittest_remove_tracked_overlays();
3108
3109         of_unittest_overlay_notify();
3110
3111 out:
3112         of_node_put(bus_np);
3113 }
3114
3115 #else
3116 static inline void __init of_unittest_overlay(void) { }
3117 #endif
3118
3119 static void __init of_unittest_lifecycle(void)
3120 {
3121 #ifdef CONFIG_OF_DYNAMIC
3122         unsigned int refcount;
3123         int found_refcount_one = 0;
3124         int put_count = 0;
3125         struct device_node *np;
3126         struct device_node *prev_sibling, *next_sibling;
3127         const char *refcount_path = "/testcase-data/refcount-node";
3128         const char *refcount_parent_path = "/testcase-data";
3129
3130         /*
3131          * Node lifecycle tests, non-dynamic node:
3132          *
3133          * - Decrementing refcount to zero via of_node_put() should cause the
3134          *   attempt to free the node memory by of_node_release() to fail
3135          *   because the node is not a dynamic node.
3136          *
3137          * - Decrementing refcount past zero should result in additional
3138          *   errors reported.
3139          */
3140
3141         np = of_find_node_by_path(refcount_path);
3142         unittest(np, "find refcount_path \"%s\"\n", refcount_path);
3143         if (np == NULL)
3144                 goto out_skip_tests;
3145
3146         while (!found_refcount_one) {
3147
3148                 if (put_count++ > 10) {
3149                         unittest(0, "guardrail to avoid infinite loop\n");
3150                         goto out_skip_tests;
3151                 }
3152
3153                 refcount = kref_read(&np->kobj.kref);
3154                 if (refcount == 1)
3155                         found_refcount_one = 1;
3156                 else
3157                         of_node_put(np);
3158         }
3159
3160         EXPECT_BEGIN(KERN_INFO, "OF: ERROR: of_node_release() detected bad of_node_put() on /testcase-data/refcount-node");
3161
3162         /*
3163          * refcount is now one, decrementing to zero will result in a call to
3164          * of_node_release() to free the node's memory, which should result
3165          * in an error
3166          */
3167         unittest(1, "/testcase-data/refcount-node is one");
3168         of_node_put(np);
3169
3170         EXPECT_END(KERN_INFO, "OF: ERROR: of_node_release() detected bad of_node_put() on /testcase-data/refcount-node");
3171
3172
3173         /*
3174          * expect stack trace for subsequent of_node_put():
3175          *   __refcount_sub_and_test() calls:
3176          *   refcount_warn_saturate(r, REFCOUNT_SUB_UAF)
3177          *
3178          * Not capturing entire WARN_ONCE() trace with EXPECT_*(), just
3179          * the first three lines, and the last line.
3180          */
3181         EXPECT_BEGIN(KERN_INFO, "------------[ cut here ]------------");
3182         EXPECT_BEGIN(KERN_INFO, "WARNING: <<all>>");
3183         EXPECT_BEGIN(KERN_INFO, "refcount_t: underflow; use-after-free.");
3184         EXPECT_BEGIN(KERN_INFO, "---[ end trace <<int>> ]---");
3185
3186         /* refcount is now zero, this should fail */
3187         unittest(1, "/testcase-data/refcount-node is zero");
3188         of_node_put(np);
3189
3190         EXPECT_END(KERN_INFO, "---[ end trace <<int>> ]---");
3191         EXPECT_END(KERN_INFO, "refcount_t: underflow; use-after-free.");
3192         EXPECT_END(KERN_INFO, "WARNING: <<all>>");
3193         EXPECT_END(KERN_INFO, "------------[ cut here ]------------");
3194
3195         /*
3196          * Q. do we expect to get yet another warning?
3197          * A. no, the WARNING is from WARN_ONCE()
3198          */
3199         EXPECT_NOT_BEGIN(KERN_INFO, "------------[ cut here ]------------");
3200         EXPECT_NOT_BEGIN(KERN_INFO, "WARNING: <<all>>");
3201         EXPECT_NOT_BEGIN(KERN_INFO, "refcount_t: underflow; use-after-free.");
3202         EXPECT_NOT_BEGIN(KERN_INFO, "---[ end trace <<int>> ]---");
3203
3204         unittest(1, "/testcase-data/refcount-node is zero, second time");
3205         of_node_put(np);
3206
3207         EXPECT_NOT_END(KERN_INFO, "---[ end trace <<int>> ]---");
3208         EXPECT_NOT_END(KERN_INFO, "refcount_t: underflow; use-after-free.");
3209         EXPECT_NOT_END(KERN_INFO, "WARNING: <<all>>");
3210         EXPECT_NOT_END(KERN_INFO, "------------[ cut here ]------------");
3211
3212         /*
3213          * refcount of zero will trigger stack traces from any further
3214          * attempt to of_node_get() node "refcount-node". One example of
3215          * this is where of_unittest_check_node_linkage() will recursively
3216          * scan the tree, with 'for_each_child_of_node()' doing an
3217          * of_node_get() of the children of a node.
3218          *
3219          * Prevent the stack trace by removing node "refcount-node" from
3220          * its parent's child list.
3221          *
3222          * WARNING:  EVIL, EVIL, EVIL:
3223          *
3224          *   Directly manipulate the child list of node /testcase-data to
3225          *   remove child refcount-node.  This is ignoring all proper methods
3226          *   of removing a child and will leak a small amount of memory.
3227          */
3228
3229         np = of_find_node_by_path(refcount_parent_path);
3230         unittest(np, "find refcount_parent_path \"%s\"\n", refcount_parent_path);
3231         unittest(np, "ERROR: devicetree live tree left in a 'bad state' if test fail\n");
3232         if (np == NULL)
3233                 return;
3234
3235         prev_sibling = np->child;
3236         next_sibling = prev_sibling->sibling;
3237         if (!strcmp(prev_sibling->full_name, "refcount-node")) {
3238                 np->child = next_sibling;
3239                 next_sibling = next_sibling->sibling;
3240         }
3241         while (next_sibling) {
3242                 if (!strcmp(next_sibling->full_name, "refcount-node"))
3243                         prev_sibling->sibling = next_sibling->sibling;
3244                 prev_sibling = next_sibling;
3245                 next_sibling = next_sibling->sibling;
3246         }
3247         of_node_put(np);
3248
3249         return;
3250
3251 out_skip_tests:
3252 #endif
3253         unittest(0, "One or more lifecycle tests skipped\n");
3254 }
3255
3256 #ifdef CONFIG_OF_OVERLAY
3257
3258 /*
3259  * __dtbo_##overlay_name##_begin[] and __dtbo_##overlay_name##_end[] are
3260  * created by cmd_dt_S_dtbo in scripts/Makefile.lib
3261  */
3262
3263 #define OVERLAY_INFO_EXTERN(overlay_name) \
3264         extern uint8_t __dtbo_##overlay_name##_begin[]; \
3265         extern uint8_t __dtbo_##overlay_name##_end[]
3266
3267 #define OVERLAY_INFO(overlay_name, expected) \
3268 {       .dtbo_begin       = __dtbo_##overlay_name##_begin, \
3269         .dtbo_end         = __dtbo_##overlay_name##_end, \
3270         .expected_result = expected, \
3271         .name            = #overlay_name, \
3272 }
3273
3274 struct overlay_info {
3275         uint8_t         *dtbo_begin;
3276         uint8_t         *dtbo_end;
3277         int             expected_result;
3278         int             ovcs_id;
3279         char            *name;
3280 };
3281
3282 OVERLAY_INFO_EXTERN(overlay_base);
3283 OVERLAY_INFO_EXTERN(overlay);
3284 OVERLAY_INFO_EXTERN(overlay_0);
3285 OVERLAY_INFO_EXTERN(overlay_1);
3286 OVERLAY_INFO_EXTERN(overlay_2);
3287 OVERLAY_INFO_EXTERN(overlay_3);
3288 OVERLAY_INFO_EXTERN(overlay_4);
3289 OVERLAY_INFO_EXTERN(overlay_5);
3290 OVERLAY_INFO_EXTERN(overlay_6);
3291 OVERLAY_INFO_EXTERN(overlay_7);
3292 OVERLAY_INFO_EXTERN(overlay_8);
3293 OVERLAY_INFO_EXTERN(overlay_9);
3294 OVERLAY_INFO_EXTERN(overlay_10);
3295 OVERLAY_INFO_EXTERN(overlay_11);
3296 OVERLAY_INFO_EXTERN(overlay_12);
3297 OVERLAY_INFO_EXTERN(overlay_13);
3298 OVERLAY_INFO_EXTERN(overlay_15);
3299 OVERLAY_INFO_EXTERN(overlay_16);
3300 OVERLAY_INFO_EXTERN(overlay_17);
3301 OVERLAY_INFO_EXTERN(overlay_18);
3302 OVERLAY_INFO_EXTERN(overlay_19);
3303 OVERLAY_INFO_EXTERN(overlay_20);
3304 OVERLAY_INFO_EXTERN(overlay_gpio_01);
3305 OVERLAY_INFO_EXTERN(overlay_gpio_02a);
3306 OVERLAY_INFO_EXTERN(overlay_gpio_02b);
3307 OVERLAY_INFO_EXTERN(overlay_gpio_03);
3308 OVERLAY_INFO_EXTERN(overlay_gpio_04a);
3309 OVERLAY_INFO_EXTERN(overlay_gpio_04b);
3310 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
3311 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
3312 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
3313 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
3314
3315 /* entries found by name */
3316 static struct overlay_info overlays[] = {
3317         OVERLAY_INFO(overlay_base, -9999),
3318         OVERLAY_INFO(overlay, 0),
3319         OVERLAY_INFO(overlay_0, 0),
3320         OVERLAY_INFO(overlay_1, 0),
3321         OVERLAY_INFO(overlay_2, 0),
3322         OVERLAY_INFO(overlay_3, 0),
3323         OVERLAY_INFO(overlay_4, 0),
3324         OVERLAY_INFO(overlay_5, 0),
3325         OVERLAY_INFO(overlay_6, 0),
3326         OVERLAY_INFO(overlay_7, 0),
3327         OVERLAY_INFO(overlay_8, 0),
3328         OVERLAY_INFO(overlay_9, 0),
3329         OVERLAY_INFO(overlay_10, 0),
3330         OVERLAY_INFO(overlay_11, 0),
3331         OVERLAY_INFO(overlay_12, 0),
3332         OVERLAY_INFO(overlay_13, 0),
3333         OVERLAY_INFO(overlay_15, 0),
3334         OVERLAY_INFO(overlay_16, -EBUSY),
3335         OVERLAY_INFO(overlay_17, -EEXIST),
3336         OVERLAY_INFO(overlay_18, 0),
3337         OVERLAY_INFO(overlay_19, 0),
3338         OVERLAY_INFO(overlay_20, 0),
3339         OVERLAY_INFO(overlay_gpio_01, 0),
3340         OVERLAY_INFO(overlay_gpio_02a, 0),
3341         OVERLAY_INFO(overlay_gpio_02b, 0),
3342         OVERLAY_INFO(overlay_gpio_03, 0),
3343         OVERLAY_INFO(overlay_gpio_04a, 0),
3344         OVERLAY_INFO(overlay_gpio_04b, 0),
3345         OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL),
3346         OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL),
3347         OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
3348         OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
3349         /* end marker */
3350         {.dtbo_begin = NULL, .dtbo_end = NULL, .expected_result = 0, .name = NULL}
3351 };
3352
3353 static struct device_node *overlay_base_root;
3354
3355 static void * __init dt_alloc_memory(u64 size, u64 align)
3356 {
3357         void *ptr = memblock_alloc(size, align);
3358
3359         if (!ptr)
3360                 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
3361                       __func__, size, align);
3362
3363         return ptr;
3364 }
3365
3366 /*
3367  * Create base device tree for the overlay unittest.
3368  *
3369  * This is called from very early boot code.
3370  *
3371  * Do as much as possible the same way as done in __unflatten_device_tree
3372  * and other early boot steps for the normal FDT so that the overlay base
3373  * unflattened tree will have the same characteristics as the real tree
3374  * (such as having memory allocated by the early allocator).  The goal
3375  * is to test "the real thing" as much as possible, and test "test setup
3376  * code" as little as possible.
3377  *
3378  * Have to stop before resolving phandles, because that uses kmalloc.
3379  */
3380 void __init unittest_unflatten_overlay_base(void)
3381 {
3382         struct overlay_info *info;
3383         u32 data_size;
3384         void *new_fdt;
3385         u32 size;
3386         int found = 0;
3387         const char *overlay_name = "overlay_base";
3388
3389         for (info = overlays; info && info->name; info++) {
3390                 if (!strcmp(overlay_name, info->name)) {
3391                         found = 1;
3392                         break;
3393                 }
3394         }
3395         if (!found) {
3396                 pr_err("no overlay data for %s\n", overlay_name);
3397                 return;
3398         }
3399
3400         info = &overlays[0];
3401
3402         if (info->expected_result != -9999) {
3403                 pr_err("No dtb 'overlay_base' to attach\n");
3404                 return;
3405         }
3406
3407         data_size = info->dtbo_end - info->dtbo_begin;
3408         if (!data_size) {
3409                 pr_err("No dtb 'overlay_base' to attach\n");
3410                 return;
3411         }
3412
3413         size = fdt_totalsize(info->dtbo_begin);
3414         if (size != data_size) {
3415                 pr_err("dtb 'overlay_base' header totalsize != actual size");
3416                 return;
3417         }
3418
3419         new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
3420         if (!new_fdt) {
3421                 pr_err("alloc for dtb 'overlay_base' failed");
3422                 return;
3423         }
3424
3425         memcpy(new_fdt, info->dtbo_begin, size);
3426
3427         __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
3428                                 dt_alloc_memory, true);
3429 }
3430
3431 /*
3432  * The purpose of of_unittest_overlay_data_add is to add an
3433  * overlay in the normal fashion.  This is a test of the whole
3434  * picture, instead of testing individual elements.
3435  *
3436  * A secondary purpose is to be able to verify that the contents of
3437  * /proc/device-tree/ contains the updated structure and values from
3438  * the overlay.  That must be verified separately in user space.
3439  *
3440  * Return 0 on unexpected error.
3441  */
3442 static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id)
3443 {
3444         struct overlay_info *info;
3445         int found = 0;
3446         int ret;
3447         u32 size;
3448
3449         for (info = overlays; info && info->name; info++) {
3450                 if (!strcmp(overlay_name, info->name)) {
3451                         found = 1;
3452                         break;
3453                 }
3454         }
3455         if (!found) {
3456                 pr_err("no overlay data for %s\n", overlay_name);
3457                 return 0;
3458         }
3459
3460         size = info->dtbo_end - info->dtbo_begin;
3461         if (!size)
3462                 pr_err("no overlay data for %s\n", overlay_name);
3463
3464         ret = of_overlay_fdt_apply(info->dtbo_begin, size, &info->ovcs_id);
3465         if (ovcs_id)
3466                 *ovcs_id = info->ovcs_id;
3467         if (ret < 0)
3468                 goto out;
3469
3470         pr_debug("%s applied\n", overlay_name);
3471
3472 out:
3473         if (ret != info->expected_result)
3474                 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
3475                        info->expected_result, ret, overlay_name);
3476
3477         return (ret == info->expected_result);
3478 }
3479
3480 /*
3481  * The purpose of of_unittest_overlay_high_level is to add an overlay
3482  * in the normal fashion.  This is a test of the whole picture,
3483  * instead of individual elements.
3484  *
3485  * The first part of the function is _not_ normal overlay usage; it is
3486  * finishing splicing the base overlay device tree into the live tree.
3487  */
3488 static __init void of_unittest_overlay_high_level(void)
3489 {
3490         struct device_node *last_sibling;
3491         struct device_node *np;
3492         struct device_node *of_symbols;
3493         struct device_node *overlay_base_symbols;
3494         struct device_node **pprev;
3495         struct property *prop;
3496         int ret;
3497
3498         if (!overlay_base_root) {
3499                 unittest(0, "overlay_base_root not initialized\n");
3500                 return;
3501         }
3502
3503         /*
3504          * Could not fixup phandles in unittest_unflatten_overlay_base()
3505          * because kmalloc() was not yet available.
3506          */
3507         of_overlay_mutex_lock();
3508         of_resolve_phandles(overlay_base_root);
3509         of_overlay_mutex_unlock();
3510
3511
3512         /*
3513          * do not allow overlay_base to duplicate any node already in
3514          * tree, this greatly simplifies the code
3515          */
3516
3517         /*
3518          * remove overlay_base_root node "__local_fixups", after
3519          * being used by of_resolve_phandles()
3520          */
3521         pprev = &overlay_base_root->child;
3522         for (np = overlay_base_root->child; np; np = np->sibling) {
3523                 if (of_node_name_eq(np, "__local_fixups__")) {
3524                         *pprev = np->sibling;
3525                         break;
3526                 }
3527                 pprev = &np->sibling;
3528         }
3529
3530         /* remove overlay_base_root node "__symbols__" if in live tree */
3531         of_symbols = of_get_child_by_name(of_root, "__symbols__");
3532         if (of_symbols) {
3533                 /* will have to graft properties from node into live tree */
3534                 pprev = &overlay_base_root->child;
3535                 for (np = overlay_base_root->child; np; np = np->sibling) {
3536                         if (of_node_name_eq(np, "__symbols__")) {
3537                                 overlay_base_symbols = np;
3538                                 *pprev = np->sibling;
3539                                 break;
3540                         }
3541                         pprev = &np->sibling;
3542                 }
3543         }
3544
3545         for_each_child_of_node(overlay_base_root, np) {
3546                 struct device_node *base_child;
3547                 for_each_child_of_node(of_root, base_child) {
3548                         if (!strcmp(np->full_name, base_child->full_name)) {
3549                                 unittest(0, "illegal node name in overlay_base %pOFn",
3550                                          np);
3551                                 of_node_put(np);
3552                                 of_node_put(base_child);
3553                                 return;
3554                         }
3555                 }
3556         }
3557
3558         /*
3559          * overlay 'overlay_base' is not allowed to have root
3560          * properties, so only need to splice nodes into main device tree.
3561          *
3562          * root node of *overlay_base_root will not be freed, it is lost
3563          * memory.
3564          */
3565
3566         for (np = overlay_base_root->child; np; np = np->sibling)
3567                 np->parent = of_root;
3568
3569         mutex_lock(&of_mutex);
3570
3571         for (last_sibling = np = of_root->child; np; np = np->sibling)
3572                 last_sibling = np;
3573
3574         if (last_sibling)
3575                 last_sibling->sibling = overlay_base_root->child;
3576         else
3577                 of_root->child = overlay_base_root->child;
3578
3579         for_each_of_allnodes_from(overlay_base_root, np)
3580                 __of_attach_node_sysfs(np);
3581
3582         if (of_symbols) {
3583                 struct property *new_prop;
3584                 for_each_property_of_node(overlay_base_symbols, prop) {
3585
3586                         new_prop = __of_prop_dup(prop, GFP_KERNEL);
3587                         if (!new_prop) {
3588                                 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
3589                                          prop->name);
3590                                 goto err_unlock;
3591                         }
3592                         if (__of_add_property(of_symbols, new_prop)) {
3593                                 kfree(new_prop->name);
3594                                 kfree(new_prop->value);
3595                                 kfree(new_prop);
3596                                 /* "name" auto-generated by unflatten */
3597                                 if (!strcmp(prop->name, "name"))
3598                                         continue;
3599                                 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
3600                                          prop->name);
3601                                 goto err_unlock;
3602                         }
3603                         if (__of_add_property_sysfs(of_symbols, new_prop)) {
3604                                 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
3605                                          prop->name);
3606                                 goto err_unlock;
3607                         }
3608                 }
3609         }
3610
3611         mutex_unlock(&of_mutex);
3612
3613
3614         /* now do the normal overlay usage test */
3615
3616         EXPECT_BEGIN(KERN_ERR,
3617                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3618         EXPECT_BEGIN(KERN_ERR,
3619                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3620         EXPECT_BEGIN(KERN_ERR,
3621                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3622         EXPECT_BEGIN(KERN_ERR,
3623                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3624         EXPECT_BEGIN(KERN_ERR,
3625                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3626         EXPECT_BEGIN(KERN_ERR,
3627                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3628         EXPECT_BEGIN(KERN_ERR,
3629                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3630         EXPECT_BEGIN(KERN_ERR,
3631                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3632         EXPECT_BEGIN(KERN_ERR,
3633                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3634         EXPECT_BEGIN(KERN_ERR,
3635                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3636         EXPECT_BEGIN(KERN_ERR,
3637                      "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3638
3639         ret = overlay_data_apply("overlay", NULL);
3640
3641         EXPECT_END(KERN_ERR,
3642                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3643         EXPECT_END(KERN_ERR,
3644                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3645         EXPECT_END(KERN_ERR,
3646                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3647         EXPECT_END(KERN_ERR,
3648                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3649         EXPECT_END(KERN_ERR,
3650                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3651         EXPECT_END(KERN_ERR,
3652                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3653         EXPECT_END(KERN_ERR,
3654                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3655         EXPECT_END(KERN_ERR,
3656                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3657         EXPECT_END(KERN_ERR,
3658                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3659         EXPECT_END(KERN_ERR,
3660                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3661         EXPECT_END(KERN_ERR,
3662                    "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3663
3664         unittest(ret, "Adding overlay 'overlay' failed\n");
3665
3666         EXPECT_BEGIN(KERN_ERR,
3667                      "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3668         EXPECT_BEGIN(KERN_ERR,
3669                      "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3670
3671         unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
3672                  "Adding overlay 'overlay_bad_add_dup_node' failed\n");
3673
3674         EXPECT_END(KERN_ERR,
3675                    "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3676         EXPECT_END(KERN_ERR,
3677                    "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3678
3679         EXPECT_BEGIN(KERN_ERR,
3680                      "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3681         EXPECT_BEGIN(KERN_ERR,
3682                      "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3683         EXPECT_BEGIN(KERN_ERR,
3684                      "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3685
3686         unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
3687                  "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
3688
3689         EXPECT_END(KERN_ERR,
3690                      "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3691         EXPECT_END(KERN_ERR,
3692                      "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3693         EXPECT_END(KERN_ERR,
3694                      "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3695
3696         unittest(overlay_data_apply("overlay_bad_phandle", NULL),
3697                  "Adding overlay 'overlay_bad_phandle' failed\n");
3698
3699         unittest(overlay_data_apply("overlay_bad_symbol", NULL),
3700                  "Adding overlay 'overlay_bad_symbol' failed\n");
3701
3702         return;
3703
3704 err_unlock:
3705         mutex_unlock(&of_mutex);
3706 }
3707
3708 #else
3709
3710 static inline __init void of_unittest_overlay_high_level(void) {}
3711
3712 #endif
3713
3714 static int __init of_unittest(void)
3715 {
3716         struct device_node *np;
3717         int res;
3718
3719         pr_info("start of unittest - you will see error messages\n");
3720
3721         /* Taint the kernel so we know we've run tests. */
3722         add_taint(TAINT_TEST, LOCKDEP_STILL_OK);
3723
3724         /* adding data for unittest */
3725
3726         if (IS_ENABLED(CONFIG_UML))
3727                 unittest_unflatten_overlay_base();
3728
3729         res = unittest_data_add();
3730         if (res)
3731                 return res;
3732         if (!of_aliases)
3733                 of_aliases = of_find_node_by_path("/aliases");
3734
3735         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
3736         if (!np) {
3737                 pr_info("No testcase data in device tree; not running tests\n");
3738                 return 0;
3739         }
3740         of_node_put(np);
3741
3742         of_unittest_check_tree_linkage();
3743         of_unittest_check_phandles();
3744         of_unittest_find_node_by_name();
3745         of_unittest_dynamic();
3746         of_unittest_parse_phandle_with_args();
3747         of_unittest_parse_phandle_with_args_map();
3748         of_unittest_printf();
3749         of_unittest_property_string();
3750         of_unittest_property_copy();
3751         of_unittest_changeset();
3752         of_unittest_parse_interrupts();
3753         of_unittest_parse_interrupts_extended();
3754         of_unittest_dma_get_max_cpu_address();
3755         of_unittest_parse_dma_ranges();
3756         of_unittest_pci_dma_ranges();
3757         of_unittest_bus_ranges();
3758         of_unittest_bus_3cell_ranges();
3759         of_unittest_reg();
3760         of_unittest_match_node();
3761         of_unittest_platform_populate();
3762         of_unittest_overlay();
3763         of_unittest_lifecycle();
3764
3765         /* Double check linkage after removing testcase data */
3766         of_unittest_check_tree_linkage();
3767
3768         of_unittest_overlay_high_level();
3769
3770         pr_info("end of unittest - %i passed, %i failed\n",
3771                 unittest_results.passed, unittest_results.failed);
3772
3773         return 0;
3774 }
3775 late_initcall(of_unittest);