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/err.h>
  11 #include <linux/errno.h>
  12 #include <linux/hashtable.h>
  13 #include <linux/libfdt.h>
  14 #include <linux/of.h>
  15 #include <linux/of_fdt.h>
  16 #include <linux/of_irq.h>
  17 #include <linux/of_platform.h>
  18 #include <linux/list.h>
  19 #include <linux/mutex.h>
  20 #include <linux/slab.h>
  21 #include <linux/device.h>
  22 #include <linux/platform_device.h>
  23
  24 #include <linux/i2c.h>
  25 #include <linux/i2c-mux.h>
  26
  27 #include <linux/bitops.h>
  28
  29 #include "of_private.h"
  30
  31 static struct unittest_results {
  32         int passed;
  33         int failed;
  34 } unittest_results;
  35
  36 #define unittest(result, fmt, ...) ({ \
  37         bool failed = !(result); \
  38         if (failed) { \
  39                 unittest_results.failed++; \
  40                 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
  41         } else { \
  42                 unittest_results.passed++; \
  43                 pr_debug("pass %s():%i\n", __func__, __LINE__); \
  44         } \
  45         failed; \
  46 })
  47
  48 static void __init of_unittest_find_node_by_name(void)
  49 {
  50         struct device_node *np;
  51         const char *options, *name;
  52
  53         np = of_find_node_by_path("/testcase-data");
  54         name = kasprintf(GFP_KERNEL, "%pOF", np);
  55         unittest(np && !strcmp("/testcase-data", name),
  56                 "find /testcase-data failed\n");
  57         of_node_put(np);
  58         kfree(name);
  59
  60         /* Test if trailing '/' works */
  61         np = of_find_node_by_path("/testcase-data/");
  62         unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
  63
  64         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
  65         name = kasprintf(GFP_KERNEL, "%pOF", np);
  66         unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
  67                 "find /testcase-data/phandle-tests/consumer-a failed\n");
  68         of_node_put(np);
  69         kfree(name);
  70
  71         np = of_find_node_by_path("testcase-alias");
  72         name = kasprintf(GFP_KERNEL, "%pOF", np);
  73         unittest(np && !strcmp("/testcase-data", name),
  74                 "find testcase-alias failed\n");
  75         of_node_put(np);
  76         kfree(name);
  77
  78         /* Test if trailing '/' works on aliases */
  79         np = of_find_node_by_path("testcase-alias/");
  80         unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
  81
  82         np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
  83         name = kasprintf(GFP_KERNEL, "%pOF", np);
  84         unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
  85                 "find testcase-alias/phandle-tests/consumer-a failed\n");
  86         of_node_put(np);
  87         kfree(name);
  88
  89         np = of_find_node_by_path("/testcase-data/missing-path");
  90         unittest(!np, "non-existent path returned node %pOF\n", np);
  91         of_node_put(np);
  92
  93         np = of_find_node_by_path("missing-alias");
  94         unittest(!np, "non-existent alias returned node %pOF\n", np);
  95         of_node_put(np);
  96
  97         np = of_find_node_by_path("testcase-alias/missing-path");
  98         unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
  99         of_node_put(np);
 100
 101         np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
 102         unittest(np && !strcmp("testoption", options),
 103                  "option path test failed\n");
 104         of_node_put(np);
 105
 106         np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
 107         unittest(np && !strcmp("test/option", options),
 108                  "option path test, subcase #1 failed\n");
 109         of_node_put(np);
 110
 111         np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
 112         unittest(np && !strcmp("test/option", options),
 113                  "option path test, subcase #2 failed\n");
 114         of_node_put(np);
 115
 116         np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
 117         unittest(np, "NULL option path test failed\n");
 118         of_node_put(np);
 119
 120         np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
 121                                        &options);
 122         unittest(np && !strcmp("testaliasoption", options),
 123                  "option alias path test failed\n");
 124         of_node_put(np);
 125
 126         np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
 127                                        &options);
 128         unittest(np && !strcmp("test/alias/option", options),
 129                  "option alias path test, subcase #1 failed\n");
 130         of_node_put(np);
 131
 132         np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
 133         unittest(np, "NULL option alias path test failed\n");
 134         of_node_put(np);
 135
 136         options = "testoption";
 137         np = of_find_node_opts_by_path("testcase-alias", &options);
 138         unittest(np && !options, "option clearing test failed\n");
 139         of_node_put(np);
 140
 141         options = "testoption";
 142         np = of_find_node_opts_by_path("/", &options);
 143         unittest(np && !options, "option clearing root node test failed\n");
 144         of_node_put(np);
 145 }
 146
 147 static void __init of_unittest_dynamic(void)
 148 {
 149         struct device_node *np;
 150         struct property *prop;
 151
 152         np = of_find_node_by_path("/testcase-data");
 153         if (!np) {
 154                 pr_err("missing testcase data\n");
 155                 return;
 156         }
 157
 158         /* Array of 4 properties for the purpose of testing */
 159         prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
 160         if (!prop) {
 161                 unittest(0, "kzalloc() failed\n");
 162                 return;
 163         }
 164
 165         /* Add a new property - should pass*/
 166         prop->name = "new-property";
 167         prop->value = "new-property-data";
 168         prop->length = strlen(prop->value) + 1;
 169         unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
 170
 171         /* Try to add an existing property - should fail */
 172         prop++;
 173         prop->name = "new-property";
 174         prop->value = "new-property-data-should-fail";
 175         prop->length = strlen(prop->value) + 1;
 176         unittest(of_add_property(np, prop) != 0,
 177                  "Adding an existing property should have failed\n");
 178
 179         /* Try to modify an existing property - should pass */
 180         prop->value = "modify-property-data-should-pass";
 181         prop->length = strlen(prop->value) + 1;
 182         unittest(of_update_property(np, prop) == 0,
 183                  "Updating an existing property should have passed\n");
 184
 185         /* Try to modify non-existent property - should pass*/
 186         prop++;
 187         prop->name = "modify-property";
 188         prop->value = "modify-missing-property-data-should-pass";
 189         prop->length = strlen(prop->value) + 1;
 190         unittest(of_update_property(np, prop) == 0,
 191                  "Updating a missing property should have passed\n");
 192
 193         /* Remove property - should pass */
 194         unittest(of_remove_property(np, prop) == 0,
 195                  "Removing a property should have passed\n");
 196
 197         /* Adding very large property - should pass */
 198         prop++;
 199         prop->name = "large-property-PAGE_SIZEx8";
 200         prop->length = PAGE_SIZE * 8;
 201         prop->value = kzalloc(prop->length, GFP_KERNEL);
 202         unittest(prop->value != NULL, "Unable to allocate large buffer\n");
 203         if (prop->value)
 204                 unittest(of_add_property(np, prop) == 0,
 205                          "Adding a large property should have passed\n");
 206 }
 207
 208 static int __init of_unittest_check_node_linkage(struct device_node *np)
 209 {
 210         struct device_node *child;
 211         int count = 0, rc;
 212
 213         for_each_child_of_node(np, child) {
 214                 if (child->parent != np) {
 215                         pr_err("Child node %pOFn links to wrong parent %pOFn\n",
 216                                  child, np);
 217                         rc = -EINVAL;
 218                         goto put_child;
 219                 }
 220
 221                 rc = of_unittest_check_node_linkage(child);
 222                 if (rc < 0)
 223                         goto put_child;
 224                 count += rc;
 225         }
 226
 227         return count + 1;
 228 put_child:
 229         of_node_put(child);
 230         return rc;
 231 }
 232
 233 static void __init of_unittest_check_tree_linkage(void)
 234 {
 235         struct device_node *np;
 236         int allnode_count = 0, child_count;
 237
 238         if (!of_root)
 239                 return;
 240
 241         for_each_of_allnodes(np)
 242                 allnode_count++;
 243         child_count = of_unittest_check_node_linkage(of_root);
 244
 245         unittest(child_count > 0, "Device node data structure is corrupted\n");
 246         unittest(child_count == allnode_count,
 247                  "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
 248                  allnode_count, child_count);
 249         pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
 250 }
 251
 252 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
 253                                           const char *expected)
 254 {
 255         unsigned char *buf;
 256         int buf_size;
 257         int size, i;
 258
 259         buf_size = strlen(expected) + 10;
 260         buf = kmalloc(buf_size, GFP_KERNEL);
 261         if (!buf)
 262                 return;
 263
 264         /* Baseline; check conversion with a large size limit */
 265         memset(buf, 0xff, buf_size);
 266         size = snprintf(buf, buf_size - 2, fmt, np);
 267
 268         /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
 269         unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
 270                 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
 271                 fmt, expected, buf);
 272
 273         /* Make sure length limits work */
 274         size++;
 275         for (i = 0; i < 2; i++, size--) {
 276                 /* Clear the buffer, and make sure it works correctly still */
 277                 memset(buf, 0xff, buf_size);
 278                 snprintf(buf, size+1, fmt, np);
 279                 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
 280                         "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
 281                         size, fmt, expected, buf);
 282         }
 283         kfree(buf);
 284 }
 285
 286 static void __init of_unittest_printf(void)
 287 {
 288         struct device_node *np;
 289         const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
 290         char phandle_str[16] = "";
 291
 292         np = of_find_node_by_path(full_name);
 293         if (!np) {
 294                 unittest(np, "testcase data missing\n");
 295                 return;
 296         }
 297
 298         num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
 299
 300         of_unittest_printf_one(np, "%pOF",  full_name);
 301         of_unittest_printf_one(np, "%pOFf", full_name);
 302         of_unittest_printf_one(np, "%pOFn", "dev");
 303         of_unittest_printf_one(np, "%2pOFn", "dev");
 304         of_unittest_printf_one(np, "%5pOFn", "  dev");
 305         of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
 306         of_unittest_printf_one(np, "%pOFp", phandle_str);
 307         of_unittest_printf_one(np, "%pOFP", "dev@100");
 308         of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
 309         of_unittest_printf_one(np, "%10pOFP", "   dev@100");
 310         of_unittest_printf_one(np, "%-10pOFP", "dev@100   ");
 311         of_unittest_printf_one(of_root, "%pOFP", "/");
 312         of_unittest_printf_one(np, "%pOFF", "----");
 313         of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
 314         of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
 315         of_unittest_printf_one(np, "%pOFc", "test-sub-device");
 316         of_unittest_printf_one(np, "%pOFC",
 317                         "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
 318 }
 319
 320 struct node_hash {
 321         struct hlist_node node;
 322         struct device_node *np;
 323 };
 324
 325 static DEFINE_HASHTABLE(phandle_ht, 8);
 326 static void __init of_unittest_check_phandles(void)
 327 {
 328         struct device_node *np;
 329         struct node_hash *nh;
 330         struct hlist_node *tmp;
 331         int i, dup_count = 0, phandle_count = 0;
 332
 333         for_each_of_allnodes(np) {
 334                 if (!np->phandle)
 335                         continue;
 336
 337                 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
 338                         if (nh->np->phandle == np->phandle) {
 339                                 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
 340                                         np->phandle, nh->np, np);
 341                                 dup_count++;
 342                                 break;
 343                         }
 344                 }
 345
 346                 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
 347                 if (!nh)
 348                         return;
 349
 350                 nh->np = np;
 351                 hash_add(phandle_ht, &nh->node, np->phandle);
 352                 phandle_count++;
 353         }
 354         unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
 355                  dup_count, phandle_count);
 356
 357         /* Clean up */
 358         hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
 359                 hash_del(&nh->node);
 360                 kfree(nh);
 361         }
 362 }
 363
 364 static void __init of_unittest_parse_phandle_with_args(void)
 365 {
 366         struct device_node *np;
 367         struct of_phandle_args args;
 368         int i, rc;
 369
 370         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 371         if (!np) {
 372                 pr_err("missing testcase data\n");
 373                 return;
 374         }
 375
 376         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 377         unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 378
 379         for (i = 0; i < 8; i++) {
 380                 bool passed = true;
 381
 382                 memset(&args, 0, sizeof(args));
 383                 rc = of_parse_phandle_with_args(np, "phandle-list",
 384                                                 "#phandle-cells", i, &args);
 385
 386                 /* Test the values from tests-phandle.dtsi */
 387                 switch (i) {
 388                 case 0:
 389                         passed &= !rc;
 390                         passed &= (args.args_count == 1);
 391                         passed &= (args.args[0] == (i + 1));
 392                         break;
 393                 case 1:
 394                         passed &= !rc;
 395                         passed &= (args.args_count == 2);
 396                         passed &= (args.args[0] == (i + 1));
 397                         passed &= (args.args[1] == 0);
 398                         break;
 399                 case 2:
 400                         passed &= (rc == -ENOENT);
 401                         break;
 402                 case 3:
 403                         passed &= !rc;
 404                         passed &= (args.args_count == 3);
 405                         passed &= (args.args[0] == (i + 1));
 406                         passed &= (args.args[1] == 4);
 407                         passed &= (args.args[2] == 3);
 408                         break;
 409                 case 4:
 410                         passed &= !rc;
 411                         passed &= (args.args_count == 2);
 412                         passed &= (args.args[0] == (i + 1));
 413                         passed &= (args.args[1] == 100);
 414                         break;
 415                 case 5:
 416                         passed &= !rc;
 417                         passed &= (args.args_count == 0);
 418                         break;
 419                 case 6:
 420                         passed &= !rc;
 421                         passed &= (args.args_count == 1);
 422                         passed &= (args.args[0] == (i + 1));
 423                         break;
 424                 case 7:
 425                         passed &= (rc == -ENOENT);
 426                         break;
 427                 default:
 428                         passed = false;
 429                 }
 430
 431                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 432                          i, args.np, rc);
 433         }
 434
 435         /* Check for missing list property */
 436         memset(&args, 0, sizeof(args));
 437         rc = of_parse_phandle_with_args(np, "phandle-list-missing",
 438                                         "#phandle-cells", 0, &args);
 439         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 440         rc = of_count_phandle_with_args(np, "phandle-list-missing",
 441                                         "#phandle-cells");
 442         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 443
 444         /* Check for missing cells property */
 445         memset(&args, 0, sizeof(args));
 446         rc = of_parse_phandle_with_args(np, "phandle-list",
 447                                         "#phandle-cells-missing", 0, &args);
 448         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 449         rc = of_count_phandle_with_args(np, "phandle-list",
 450                                         "#phandle-cells-missing");
 451         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 452
 453         /* Check for bad phandle in list */
 454         memset(&args, 0, sizeof(args));
 455         rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
 456                                         "#phandle-cells", 0, &args);
 457         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 458         rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
 459                                         "#phandle-cells");
 460         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 461
 462         /* Check for incorrectly formed argument list */
 463         memset(&args, 0, sizeof(args));
 464         rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
 465                                         "#phandle-cells", 1, &args);
 466         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 467         rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
 468                                         "#phandle-cells");
 469         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 470 }
 471
 472 static void __init of_unittest_parse_phandle_with_args_map(void)
 473 {
 474         struct device_node *np, *p0, *p1, *p2, *p3;
 475         struct of_phandle_args args;
 476         int i, rc;
 477
 478         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
 479         if (!np) {
 480                 pr_err("missing testcase data\n");
 481                 return;
 482         }
 483
 484         p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
 485         if (!p0) {
 486                 pr_err("missing testcase data\n");
 487                 return;
 488         }
 489
 490         p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
 491         if (!p1) {
 492                 pr_err("missing testcase data\n");
 493                 return;
 494         }
 495
 496         p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
 497         if (!p2) {
 498                 pr_err("missing testcase data\n");
 499                 return;
 500         }
 501
 502         p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
 503         if (!p3) {
 504                 pr_err("missing testcase data\n");
 505                 return;
 506         }
 507
 508         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 509         unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 510
 511         for (i = 0; i < 8; i++) {
 512                 bool passed = true;
 513
 514                 memset(&args, 0, sizeof(args));
 515                 rc = of_parse_phandle_with_args_map(np, "phandle-list",
 516                                                     "phandle", i, &args);
 517
 518                 /* Test the values from tests-phandle.dtsi */
 519                 switch (i) {
 520                 case 0:
 521                         passed &= !rc;
 522                         passed &= (args.np == p1);
 523                         passed &= (args.args_count == 1);
 524                         passed &= (args.args[0] == 1);
 525                         break;
 526                 case 1:
 527                         passed &= !rc;
 528                         passed &= (args.np == p3);
 529                         passed &= (args.args_count == 3);
 530                         passed &= (args.args[0] == 2);
 531                         passed &= (args.args[1] == 5);
 532                         passed &= (args.args[2] == 3);
 533                         break;
 534                 case 2:
 535                         passed &= (rc == -ENOENT);
 536                         break;
 537                 case 3:
 538                         passed &= !rc;
 539                         passed &= (args.np == p0);
 540                         passed &= (args.args_count == 0);
 541                         break;
 542                 case 4:
 543                         passed &= !rc;
 544                         passed &= (args.np == p1);
 545                         passed &= (args.args_count == 1);
 546                         passed &= (args.args[0] == 3);
 547                         break;
 548                 case 5:
 549                         passed &= !rc;
 550                         passed &= (args.np == p0);
 551                         passed &= (args.args_count == 0);
 552                         break;
 553                 case 6:
 554                         passed &= !rc;
 555                         passed &= (args.np == p2);
 556                         passed &= (args.args_count == 2);
 557                         passed &= (args.args[0] == 15);
 558                         passed &= (args.args[1] == 0x20);
 559                         break;
 560                 case 7:
 561                         passed &= (rc == -ENOENT);
 562                         break;
 563                 default:
 564                         passed = false;
 565                 }
 566
 567                 unittest(passed, "index %i - data error on node %s rc=%i\n",
 568                          i, args.np->full_name, rc);
 569         }
 570
 571         /* Check for missing list property */
 572         memset(&args, 0, sizeof(args));
 573         rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
 574                                             "phandle", 0, &args);
 575         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 576
 577         /* Check for missing cells,map,mask property */
 578         memset(&args, 0, sizeof(args));
 579         rc = of_parse_phandle_with_args_map(np, "phandle-list",
 580                                             "phandle-missing", 0, &args);
 581         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 582
 583         /* Check for bad phandle in list */
 584         memset(&args, 0, sizeof(args));
 585         rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
 586                                             "phandle", 0, &args);
 587         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 588
 589         /* Check for incorrectly formed argument list */
 590         memset(&args, 0, sizeof(args));
 591         rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
 592                                             "phandle", 1, &args);
 593         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 594 }
 595
 596 static void __init of_unittest_property_string(void)
 597 {
 598         const char *strings[4];
 599         struct device_node *np;
 600         int rc;
 601
 602         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 603         if (!np) {
 604                 pr_err("No testcase data in device tree\n");
 605                 return;
 606         }
 607
 608         rc = of_property_match_string(np, "phandle-list-names", "first");
 609         unittest(rc == 0, "first expected:0 got:%i\n", rc);
 610         rc = of_property_match_string(np, "phandle-list-names", "second");
 611         unittest(rc == 1, "second expected:1 got:%i\n", rc);
 612         rc = of_property_match_string(np, "phandle-list-names", "third");
 613         unittest(rc == 2, "third expected:2 got:%i\n", rc);
 614         rc = of_property_match_string(np, "phandle-list-names", "fourth");
 615         unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
 616         rc = of_property_match_string(np, "missing-property", "blah");
 617         unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
 618         rc = of_property_match_string(np, "empty-property", "blah");
 619         unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
 620         rc = of_property_match_string(np, "unterminated-string", "blah");
 621         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 622
 623         /* of_property_count_strings() tests */
 624         rc = of_property_count_strings(np, "string-property");
 625         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 626         rc = of_property_count_strings(np, "phandle-list-names");
 627         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 628         rc = of_property_count_strings(np, "unterminated-string");
 629         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 630         rc = of_property_count_strings(np, "unterminated-string-list");
 631         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 632
 633         /* of_property_read_string_index() tests */
 634         rc = of_property_read_string_index(np, "string-property", 0, strings);
 635         unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
 636         strings[0] = NULL;
 637         rc = of_property_read_string_index(np, "string-property", 1, strings);
 638         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 639         rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
 640         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 641         rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
 642         unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
 643         rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
 644         unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
 645         strings[0] = NULL;
 646         rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
 647         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 648         strings[0] = NULL;
 649         rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
 650         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 651         rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
 652         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 653         strings[0] = NULL;
 654         rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
 655         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 656         strings[1] = NULL;
 657
 658         /* of_property_read_string_array() tests */
 659         rc = of_property_read_string_array(np, "string-property", strings, 4);
 660         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 661         rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
 662         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 663         rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
 664         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 665         /* -- An incorrectly formed string should cause a failure */
 666         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
 667         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 668         /* -- parsing the correctly formed strings should still work: */
 669         strings[2] = NULL;
 670         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
 671         unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
 672         strings[1] = NULL;
 673         rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
 674         unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
 675 }
 676
 677 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
 678                         (p1)->value && (p2)->value && \
 679                         !memcmp((p1)->value, (p2)->value, (p1)->length) && \
 680                         !strcmp((p1)->name, (p2)->name))
 681 static void __init of_unittest_property_copy(void)
 682 {
 683 #ifdef CONFIG_OF_DYNAMIC
 684         struct property p1 = { .name = "p1", .length = 0, .value = "" };
 685         struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
 686         struct property *new;
 687
 688         new = __of_prop_dup(&p1, GFP_KERNEL);
 689         unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
 690         kfree(new->value);
 691         kfree(new->name);
 692         kfree(new);
 693
 694         new = __of_prop_dup(&p2, GFP_KERNEL);
 695         unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
 696         kfree(new->value);
 697         kfree(new->name);
 698         kfree(new);
 699 #endif
 700 }
 701
 702 static void __init of_unittest_changeset(void)
 703 {
 704 #ifdef CONFIG_OF_DYNAMIC
 705         struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
 706         struct property *ppname_n1,  pname_n1  = { .name = "name", .length = 3, .value = "n1"  };
 707         struct property *ppname_n2,  pname_n2  = { .name = "name", .length = 3, .value = "n2"  };
 708         struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
 709         struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
 710         struct property *ppremove;
 711         struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
 712         struct of_changeset chgset;
 713
 714         n1 = __of_node_dup(NULL, "n1");
 715         unittest(n1, "testcase setup failure\n");
 716
 717         n2 = __of_node_dup(NULL, "n2");
 718         unittest(n2, "testcase setup failure\n");
 719
 720         n21 = __of_node_dup(NULL, "n21");
 721         unittest(n21, "testcase setup failure %p\n", n21);
 722
 723         nchangeset = of_find_node_by_path("/testcase-data/changeset");
 724         nremove = of_get_child_by_name(nchangeset, "node-remove");
 725         unittest(nremove, "testcase setup failure\n");
 726
 727         ppadd = __of_prop_dup(&padd, GFP_KERNEL);
 728         unittest(ppadd, "testcase setup failure\n");
 729
 730         ppname_n1  = __of_prop_dup(&pname_n1, GFP_KERNEL);
 731         unittest(ppname_n1, "testcase setup failure\n");
 732
 733         ppname_n2  = __of_prop_dup(&pname_n2, GFP_KERNEL);
 734         unittest(ppname_n2, "testcase setup failure\n");
 735
 736         ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
 737         unittest(ppname_n21, "testcase setup failure\n");
 738
 739         ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
 740         unittest(ppupdate, "testcase setup failure\n");
 741
 742         parent = nchangeset;
 743         n1->parent = parent;
 744         n2->parent = parent;
 745         n21->parent = n2;
 746
 747         ppremove = of_find_property(parent, "prop-remove", NULL);
 748         unittest(ppremove, "failed to find removal prop");
 749
 750         of_changeset_init(&chgset);
 751
 752         unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
 753         unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
 754
 755         unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
 756         unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
 757
 758         unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
 759         unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
 760
 761         unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
 762
 763         unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
 764         unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
 765         unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
 766
 767         unittest(!of_changeset_apply(&chgset), "apply failed\n");
 768
 769         of_node_put(nchangeset);
 770
 771         /* Make sure node names are constructed correctly */
 772         unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
 773                  "'%pOF' not added\n", n21);
 774         of_node_put(np);
 775
 776         unittest(!of_changeset_revert(&chgset), "revert failed\n");
 777
 778         of_changeset_destroy(&chgset);
 779 #endif
 780 }
 781
 782 static void __init of_unittest_parse_interrupts(void)
 783 {
 784         struct device_node *np;
 785         struct of_phandle_args args;
 786         int i, rc;
 787
 788         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
 789                 return;
 790
 791         np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
 792         if (!np) {
 793                 pr_err("missing testcase data\n");
 794                 return;
 795         }
 796
 797         for (i = 0; i < 4; i++) {
 798                 bool passed = true;
 799
 800                 memset(&args, 0, sizeof(args));
 801                 rc = of_irq_parse_one(np, i, &args);
 802
 803                 passed &= !rc;
 804                 passed &= (args.args_count == 1);
 805                 passed &= (args.args[0] == (i + 1));
 806
 807                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 808                          i, args.np, rc);
 809         }
 810         of_node_put(np);
 811
 812         np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
 813         if (!np) {
 814                 pr_err("missing testcase data\n");
 815                 return;
 816         }
 817
 818         for (i = 0; i < 4; i++) {
 819                 bool passed = true;
 820
 821                 memset(&args, 0, sizeof(args));
 822                 rc = of_irq_parse_one(np, i, &args);
 823
 824                 /* Test the values from tests-phandle.dtsi */
 825                 switch (i) {
 826                 case 0:
 827                         passed &= !rc;
 828                         passed &= (args.args_count == 1);
 829                         passed &= (args.args[0] == 9);
 830                         break;
 831                 case 1:
 832                         passed &= !rc;
 833                         passed &= (args.args_count == 3);
 834                         passed &= (args.args[0] == 10);
 835                         passed &= (args.args[1] == 11);
 836                         passed &= (args.args[2] == 12);
 837                         break;
 838                 case 2:
 839                         passed &= !rc;
 840                         passed &= (args.args_count == 2);
 841                         passed &= (args.args[0] == 13);
 842                         passed &= (args.args[1] == 14);
 843                         break;
 844                 case 3:
 845                         passed &= !rc;
 846                         passed &= (args.args_count == 2);
 847                         passed &= (args.args[0] == 15);
 848                         passed &= (args.args[1] == 16);
 849                         break;
 850                 default:
 851                         passed = false;
 852                 }
 853                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 854                          i, args.np, rc);
 855         }
 856         of_node_put(np);
 857 }
 858
 859 static void __init of_unittest_parse_interrupts_extended(void)
 860 {
 861         struct device_node *np;
 862         struct of_phandle_args args;
 863         int i, rc;
 864
 865         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
 866                 return;
 867
 868         np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
 869         if (!np) {
 870                 pr_err("missing testcase data\n");
 871                 return;
 872         }
 873
 874         for (i = 0; i < 7; i++) {
 875                 bool passed = true;
 876
 877                 memset(&args, 0, sizeof(args));
 878                 rc = of_irq_parse_one(np, i, &args);
 879
 880                 /* Test the values from tests-phandle.dtsi */
 881                 switch (i) {
 882                 case 0:
 883                         passed &= !rc;
 884                         passed &= (args.args_count == 1);
 885                         passed &= (args.args[0] == 1);
 886                         break;
 887                 case 1:
 888                         passed &= !rc;
 889                         passed &= (args.args_count == 3);
 890                         passed &= (args.args[0] == 2);
 891                         passed &= (args.args[1] == 3);
 892                         passed &= (args.args[2] == 4);
 893                         break;
 894                 case 2:
 895                         passed &= !rc;
 896                         passed &= (args.args_count == 2);
 897                         passed &= (args.args[0] == 5);
 898                         passed &= (args.args[1] == 6);
 899                         break;
 900                 case 3:
 901                         passed &= !rc;
 902                         passed &= (args.args_count == 1);
 903                         passed &= (args.args[0] == 9);
 904                         break;
 905                 case 4:
 906                         passed &= !rc;
 907                         passed &= (args.args_count == 3);
 908                         passed &= (args.args[0] == 10);
 909                         passed &= (args.args[1] == 11);
 910                         passed &= (args.args[2] == 12);
 911                         break;
 912                 case 5:
 913                         passed &= !rc;
 914                         passed &= (args.args_count == 2);
 915                         passed &= (args.args[0] == 13);
 916                         passed &= (args.args[1] == 14);
 917                         break;
 918                 case 6:
 919                         passed &= !rc;
 920                         passed &= (args.args_count == 1);
 921                         passed &= (args.args[0] == 15);
 922                         break;
 923                 default:
 924                         passed = false;
 925                 }
 926
 927                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 928                          i, args.np, rc);
 929         }
 930         of_node_put(np);
 931 }
 932
 933 static const struct of_device_id match_node_table[] = {
 934         { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
 935         { .data = "B", .type = "type1", }, /* followed by type alone */
 936
 937         { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
 938         { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
 939         { .data = "Cc", .name = "name2", .type = "type2", },
 940
 941         { .data = "E", .compatible = "compat3" },
 942         { .data = "G", .compatible = "compat2", },
 943         { .data = "H", .compatible = "compat2", .name = "name5", },
 944         { .data = "I", .compatible = "compat2", .type = "type1", },
 945         { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
 946         { .data = "K", .compatible = "compat2", .name = "name9", },
 947         {}
 948 };
 949
 950 static struct {
 951         const char *path;
 952         const char *data;
 953 } match_node_tests[] = {
 954         { .path = "/testcase-data/match-node/name0", .data = "A", },
 955         { .path = "/testcase-data/match-node/name1", .data = "B", },
 956         { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
 957         { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
 958         { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
 959         { .path = "/testcase-data/match-node/name3", .data = "E", },
 960         { .path = "/testcase-data/match-node/name4", .data = "G", },
 961         { .path = "/testcase-data/match-node/name5", .data = "H", },
 962         { .path = "/testcase-data/match-node/name6", .data = "G", },
 963         { .path = "/testcase-data/match-node/name7", .data = "I", },
 964         { .path = "/testcase-data/match-node/name8", .data = "J", },
 965         { .path = "/testcase-data/match-node/name9", .data = "K", },
 966 };
 967
 968 static void __init of_unittest_match_node(void)
 969 {
 970         struct device_node *np;
 971         const struct of_device_id *match;
 972         int i;
 973
 974         for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
 975                 np = of_find_node_by_path(match_node_tests[i].path);
 976                 if (!np) {
 977                         unittest(0, "missing testcase node %s\n",
 978                                 match_node_tests[i].path);
 979                         continue;
 980                 }
 981
 982                 match = of_match_node(match_node_table, np);
 983                 if (!match) {
 984                         unittest(0, "%s didn't match anything\n",
 985                                 match_node_tests[i].path);
 986                         continue;
 987                 }
 988
 989                 if (strcmp(match->data, match_node_tests[i].data) != 0) {
 990                         unittest(0, "%s got wrong match. expected %s, got %s\n",
 991                                 match_node_tests[i].path, match_node_tests[i].data,
 992                                 (const char *)match->data);
 993                         continue;
 994                 }
 995                 unittest(1, "passed");
 996         }
 997 }
 998
 999 static struct resource test_bus_res = {
1000         .start = 0xfffffff8,
1001         .end = 0xfffffff9,
1002         .flags = IORESOURCE_MEM,
1003 };
1004 static const struct platform_device_info test_bus_info = {
1005         .name = "unittest-bus",
1006 };
1007 static void __init of_unittest_platform_populate(void)
1008 {
1009         int irq, rc;
1010         struct device_node *np, *child, *grandchild;
1011         struct platform_device *pdev, *test_bus;
1012         const struct of_device_id match[] = {
1013                 { .compatible = "test-device", },
1014                 {}
1015         };
1016
1017         np = of_find_node_by_path("/testcase-data");
1018         of_platform_default_populate(np, NULL, NULL);
1019
1020         /* Test that a missing irq domain returns -EPROBE_DEFER */
1021         np = of_find_node_by_path("/testcase-data/testcase-device1");
1022         pdev = of_find_device_by_node(np);
1023         unittest(pdev, "device 1 creation failed\n");
1024
1025         if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1026                 irq = platform_get_irq(pdev, 0);
1027                 unittest(irq == -EPROBE_DEFER,
1028                          "device deferred probe failed - %d\n", irq);
1029
1030                 /* Test that a parsing failure does not return -EPROBE_DEFER */
1031                 np = of_find_node_by_path("/testcase-data/testcase-device2");
1032                 pdev = of_find_device_by_node(np);
1033                 unittest(pdev, "device 2 creation failed\n");
1034                 irq = platform_get_irq(pdev, 0);
1035                 unittest(irq < 0 && irq != -EPROBE_DEFER,
1036                          "device parsing error failed - %d\n", irq);
1037         }
1038
1039         np = of_find_node_by_path("/testcase-data/platform-tests");
1040         unittest(np, "No testcase data in device tree\n");
1041         if (!np)
1042                 return;
1043
1044         test_bus = platform_device_register_full(&test_bus_info);
1045         rc = PTR_ERR_OR_ZERO(test_bus);
1046         unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1047         if (rc) {
1048                 of_node_put(np);
1049                 return;
1050         }
1051         test_bus->dev.of_node = np;
1052
1053         /*
1054          * Add a dummy resource to the test bus node after it is
1055          * registered to catch problems with un-inserted resources. The
1056          * DT code doesn't insert the resources, and it has caused the
1057          * kernel to oops in the past. This makes sure the same bug
1058          * doesn't crop up again.
1059          */
1060         platform_device_add_resources(test_bus, &test_bus_res, 1);
1061
1062         of_platform_populate(np, match, NULL, &test_bus->dev);
1063         for_each_child_of_node(np, child) {
1064                 for_each_child_of_node(child, grandchild)
1065                         unittest(of_find_device_by_node(grandchild),
1066                                  "Could not create device for node '%pOFn'\n",
1067                                  grandchild);
1068         }
1069
1070         of_platform_depopulate(&test_bus->dev);
1071         for_each_child_of_node(np, child) {
1072                 for_each_child_of_node(child, grandchild)
1073                         unittest(!of_find_device_by_node(grandchild),
1074                                  "device didn't get destroyed '%pOFn'\n",
1075                                  grandchild);
1076         }
1077
1078         platform_device_unregister(test_bus);
1079         of_node_put(np);
1080 }
1081
1082 /**
1083  *      update_node_properties - adds the properties
1084  *      of np into dup node (present in live tree) and
1085  *      updates parent of children of np to dup.
1086  *
1087  *      @np:    node whose properties are being added to the live tree
1088  *      @dup:   node present in live tree to be updated
1089  */
1090 static void update_node_properties(struct device_node *np,
1091                                         struct device_node *dup)
1092 {
1093         struct property *prop;
1094         struct property *save_next;
1095         struct device_node *child;
1096         int ret;
1097
1098         for_each_child_of_node(np, child)
1099                 child->parent = dup;
1100
1101         /*
1102          * "unittest internal error: unable to add testdata property"
1103          *
1104          *    If this message reports a property in node '/__symbols__' then
1105          *    the respective unittest overlay contains a label that has the
1106          *    same name as a label in the live devicetree.  The label will
1107          *    be in the live devicetree only if the devicetree source was
1108          *    compiled with the '-@' option.  If you encounter this error,
1109          *    please consider renaming __all__ of the labels in the unittest
1110          *    overlay dts files with an odd prefix that is unlikely to be
1111          *    used in a real devicetree.
1112          */
1113
1114         /*
1115          * open code for_each_property_of_node() because of_add_property()
1116          * sets prop->next to NULL
1117          */
1118         for (prop = np->properties; prop != NULL; prop = save_next) {
1119                 save_next = prop->next;
1120                 ret = of_add_property(dup, prop);
1121                 if (ret) {
1122                         if (ret == -EEXIST && !strcmp(prop->name, "name"))
1123                                 continue;
1124                         pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1125                                np, prop->name);
1126                 }
1127         }
1128 }
1129
1130 /**
1131  *      attach_node_and_children - attaches nodes
1132  *      and its children to live tree.
1133  *      CAUTION: misleading function name - if node @np already exists in
1134  *      the live tree then children of @np are *not* attached to the live
1135  *      tree.  This works for the current test devicetree nodes because such
1136  *      nodes do not have child nodes.
1137  *
1138  *      @np:    Node to attach to live tree
1139  */
1140 static void attach_node_and_children(struct device_node *np)
1141 {
1142         struct device_node *next, *dup, *child;
1143         unsigned long flags;
1144         const char *full_name;
1145
1146         full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1147
1148         if (!strcmp(full_name, "/__local_fixups__") ||
1149             !strcmp(full_name, "/__fixups__"))
1150                 return;
1151
1152         dup = of_find_node_by_path(full_name);
1153         kfree(full_name);
1154         if (dup) {
1155                 update_node_properties(np, dup);
1156                 return;
1157         }
1158
1159         child = np->child;
1160         np->child = NULL;
1161
1162         mutex_lock(&of_mutex);
1163         raw_spin_lock_irqsave(&devtree_lock, flags);
1164         np->sibling = np->parent->child;
1165         np->parent->child = np;
1166         of_node_clear_flag(np, OF_DETACHED);
1167         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1168
1169         __of_attach_node_sysfs(np);
1170         mutex_unlock(&of_mutex);
1171
1172         while (child) {
1173                 next = child->sibling;
1174                 attach_node_and_children(child);
1175                 child = next;
1176         }
1177 }
1178
1179 /**
1180  *      unittest_data_add - Reads, copies data from
1181  *      linked tree and attaches it to the live tree
1182  */
1183 static int __init unittest_data_add(void)
1184 {
1185         void *unittest_data;
1186         struct device_node *unittest_data_node, *np;
1187         /*
1188          * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1189          * created by cmd_dt_S_dtb in scripts/Makefile.lib
1190          */
1191         extern uint8_t __dtb_testcases_begin[];
1192         extern uint8_t __dtb_testcases_end[];
1193         const int size = __dtb_testcases_end - __dtb_testcases_begin;
1194         int rc;
1195
1196         if (!size) {
1197                 pr_warn("%s: No testcase data to attach; not running tests\n",
1198                         __func__);
1199                 return -ENODATA;
1200         }
1201
1202         /* creating copy */
1203         unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1204         if (!unittest_data)
1205                 return -ENOMEM;
1206
1207         of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1208         if (!unittest_data_node) {
1209                 pr_warn("%s: No tree to attach; not running tests\n", __func__);
1210                 return -ENODATA;
1211         }
1212
1213         /*
1214          * This lock normally encloses of_resolve_phandles()
1215          */
1216         of_overlay_mutex_lock();
1217
1218         rc = of_resolve_phandles(unittest_data_node);
1219         if (rc) {
1220                 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1221                 of_overlay_mutex_unlock();
1222                 return -EINVAL;
1223         }
1224
1225         if (!of_root) {
1226                 of_root = unittest_data_node;
1227                 for_each_of_allnodes(np)
1228                         __of_attach_node_sysfs(np);
1229                 of_aliases = of_find_node_by_path("/aliases");
1230                 of_chosen = of_find_node_by_path("/chosen");
1231                 of_overlay_mutex_unlock();
1232                 return 0;
1233         }
1234
1235         /* attach the sub-tree to live tree */
1236         np = unittest_data_node->child;
1237         while (np) {
1238                 struct device_node *next = np->sibling;
1239
1240                 np->parent = of_root;
1241                 attach_node_and_children(np);
1242                 np = next;
1243         }
1244
1245         of_overlay_mutex_unlock();
1246
1247         return 0;
1248 }
1249
1250 #ifdef CONFIG_OF_OVERLAY
1251 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1252
1253 static int unittest_probe(struct platform_device *pdev)
1254 {
1255         struct device *dev = &pdev->dev;
1256         struct device_node *np = dev->of_node;
1257
1258         if (np == NULL) {
1259                 dev_err(dev, "No OF data for device\n");
1260                 return -EINVAL;
1261
1262         }
1263
1264         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1265
1266         of_platform_populate(np, NULL, NULL, &pdev->dev);
1267
1268         return 0;
1269 }
1270
1271 static int unittest_remove(struct platform_device *pdev)
1272 {
1273         struct device *dev = &pdev->dev;
1274         struct device_node *np = dev->of_node;
1275
1276         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1277         return 0;
1278 }
1279
1280 static const struct of_device_id unittest_match[] = {
1281         { .compatible = "unittest", },
1282         {},
1283 };
1284
1285 static struct platform_driver unittest_driver = {
1286         .probe                  = unittest_probe,
1287         .remove                 = unittest_remove,
1288         .driver = {
1289                 .name           = "unittest",
1290                 .of_match_table = of_match_ptr(unittest_match),
1291         },
1292 };
1293
1294 /* get the platform device instantiated at the path */
1295 static struct platform_device *of_path_to_platform_device(const char *path)
1296 {
1297         struct device_node *np;
1298         struct platform_device *pdev;
1299
1300         np = of_find_node_by_path(path);
1301         if (np == NULL)
1302                 return NULL;
1303
1304         pdev = of_find_device_by_node(np);
1305         of_node_put(np);
1306
1307         return pdev;
1308 }
1309
1310 /* find out if a platform device exists at that path */
1311 static int of_path_platform_device_exists(const char *path)
1312 {
1313         struct platform_device *pdev;
1314
1315         pdev = of_path_to_platform_device(path);
1316         platform_device_put(pdev);
1317         return pdev != NULL;
1318 }
1319
1320 #if IS_BUILTIN(CONFIG_I2C)
1321
1322 /* get the i2c client device instantiated at the path */
1323 static struct i2c_client *of_path_to_i2c_client(const char *path)
1324 {
1325         struct device_node *np;
1326         struct i2c_client *client;
1327
1328         np = of_find_node_by_path(path);
1329         if (np == NULL)
1330                 return NULL;
1331
1332         client = of_find_i2c_device_by_node(np);
1333         of_node_put(np);
1334
1335         return client;
1336 }
1337
1338 /* find out if a i2c client device exists at that path */
1339 static int of_path_i2c_client_exists(const char *path)
1340 {
1341         struct i2c_client *client;
1342
1343         client = of_path_to_i2c_client(path);
1344         if (client)
1345                 put_device(&client->dev);
1346         return client != NULL;
1347 }
1348 #else
1349 static int of_path_i2c_client_exists(const char *path)
1350 {
1351         return 0;
1352 }
1353 #endif
1354
1355 enum overlay_type {
1356         PDEV_OVERLAY,
1357         I2C_OVERLAY
1358 };
1359
1360 static int of_path_device_type_exists(const char *path,
1361                 enum overlay_type ovtype)
1362 {
1363         switch (ovtype) {
1364         case PDEV_OVERLAY:
1365                 return of_path_platform_device_exists(path);
1366         case I2C_OVERLAY:
1367                 return of_path_i2c_client_exists(path);
1368         }
1369         return 0;
1370 }
1371
1372 static const char *unittest_path(int nr, enum overlay_type ovtype)
1373 {
1374         const char *base;
1375         static char buf[256];
1376
1377         switch (ovtype) {
1378         case PDEV_OVERLAY:
1379                 base = "/testcase-data/overlay-node/test-bus";
1380                 break;
1381         case I2C_OVERLAY:
1382                 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1383                 break;
1384         default:
1385                 buf[0] = '\0';
1386                 return buf;
1387         }
1388         snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1389         buf[sizeof(buf) - 1] = '\0';
1390         return buf;
1391 }
1392
1393 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1394 {
1395         const char *path;
1396
1397         path = unittest_path(unittest_nr, ovtype);
1398
1399         switch (ovtype) {
1400         case PDEV_OVERLAY:
1401                 return of_path_platform_device_exists(path);
1402         case I2C_OVERLAY:
1403                 return of_path_i2c_client_exists(path);
1404         }
1405         return 0;
1406 }
1407
1408 static const char *overlay_name_from_nr(int nr)
1409 {
1410         static char buf[256];
1411
1412         snprintf(buf, sizeof(buf) - 1,
1413                 "overlay_%d", nr);
1414         buf[sizeof(buf) - 1] = '\0';
1415
1416         return buf;
1417 }
1418
1419 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1420
1421 /* it is guaranteed that overlay ids are assigned in sequence */
1422 #define MAX_UNITTEST_OVERLAYS   256
1423 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1424 static int overlay_first_id = -1;
1425
1426 static void of_unittest_track_overlay(int id)
1427 {
1428         if (overlay_first_id < 0)
1429                 overlay_first_id = id;
1430         id -= overlay_first_id;
1431
1432         /* we shouldn't need that many */
1433         BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1434         overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1435 }
1436
1437 static void of_unittest_untrack_overlay(int id)
1438 {
1439         if (overlay_first_id < 0)
1440                 return;
1441         id -= overlay_first_id;
1442         BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1443         overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1444 }
1445
1446 static void of_unittest_destroy_tracked_overlays(void)
1447 {
1448         int id, ret, defers, ovcs_id;
1449
1450         if (overlay_first_id < 0)
1451                 return;
1452
1453         /* try until no defers */
1454         do {
1455                 defers = 0;
1456                 /* remove in reverse order */
1457                 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1458                         if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1459                                 continue;
1460
1461                         ovcs_id = id + overlay_first_id;
1462                         ret = of_overlay_remove(&ovcs_id);
1463                         if (ret == -ENODEV) {
1464                                 pr_warn("%s: no overlay to destroy for #%d\n",
1465                                         __func__, id + overlay_first_id);
1466                                 continue;
1467                         }
1468                         if (ret != 0) {
1469                                 defers++;
1470                                 pr_warn("%s: overlay destroy failed for #%d\n",
1471                                         __func__, id + overlay_first_id);
1472                                 continue;
1473                         }
1474
1475                         overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1476                 }
1477         } while (defers > 0);
1478 }
1479
1480 static int __init of_unittest_apply_overlay(int overlay_nr, int *overlay_id)
1481 {
1482         const char *overlay_name;
1483
1484         overlay_name = overlay_name_from_nr(overlay_nr);
1485
1486         if (!overlay_data_apply(overlay_name, overlay_id)) {
1487                 unittest(0, "could not apply overlay \"%s\"\n",
1488                                 overlay_name);
1489                 return -EFAULT;
1490         }
1491         of_unittest_track_overlay(*overlay_id);
1492
1493         return 0;
1494 }
1495
1496 /* apply an overlay while checking before and after states */
1497 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1498                 int unittest_nr, int before, int after,
1499                 enum overlay_type ovtype)
1500 {
1501         int ret, ovcs_id;
1502
1503         /* unittest device must not be in before state */
1504         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1505                 unittest(0, "%s with device @\"%s\" %s\n",
1506                                 overlay_name_from_nr(overlay_nr),
1507                                 unittest_path(unittest_nr, ovtype),
1508                                 !before ? "enabled" : "disabled");
1509                 return -EINVAL;
1510         }
1511
1512         ovcs_id = 0;
1513         ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
1514         if (ret != 0) {
1515                 /* of_unittest_apply_overlay already called unittest() */
1516                 return ret;
1517         }
1518
1519         /* unittest device must be to set to after state */
1520         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1521                 unittest(0, "%s failed to create @\"%s\" %s\n",
1522                                 overlay_name_from_nr(overlay_nr),
1523                                 unittest_path(unittest_nr, ovtype),
1524                                 !after ? "enabled" : "disabled");
1525                 return -EINVAL;
1526         }
1527
1528         return 0;
1529 }
1530
1531 /* apply an overlay and then revert it while checking before, after states */
1532 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1533                 int unittest_nr, int before, int after,
1534                 enum overlay_type ovtype)
1535 {
1536         int ret, ovcs_id;
1537
1538         /* unittest device must be in before state */
1539         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1540                 unittest(0, "%s with device @\"%s\" %s\n",
1541                                 overlay_name_from_nr(overlay_nr),
1542                                 unittest_path(unittest_nr, ovtype),
1543                                 !before ? "enabled" : "disabled");
1544                 return -EINVAL;
1545         }
1546
1547         /* apply the overlay */
1548         ovcs_id = 0;
1549         ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
1550         if (ret != 0) {
1551                 /* of_unittest_apply_overlay already called unittest() */
1552                 return ret;
1553         }
1554
1555         /* unittest device must be in after state */
1556         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1557                 unittest(0, "%s failed to create @\"%s\" %s\n",
1558                                 overlay_name_from_nr(overlay_nr),
1559                                 unittest_path(unittest_nr, ovtype),
1560                                 !after ? "enabled" : "disabled");
1561                 return -EINVAL;
1562         }
1563
1564         ret = of_overlay_remove(&ovcs_id);
1565         if (ret != 0) {
1566                 unittest(0, "%s failed to be destroyed @\"%s\"\n",
1567                                 overlay_name_from_nr(overlay_nr),
1568                                 unittest_path(unittest_nr, ovtype));
1569                 return ret;
1570         }
1571
1572         /* unittest device must be again in before state */
1573         if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1574                 unittest(0, "%s with device @\"%s\" %s\n",
1575                                 overlay_name_from_nr(overlay_nr),
1576                                 unittest_path(unittest_nr, ovtype),
1577                                 !before ? "enabled" : "disabled");
1578                 return -EINVAL;
1579         }
1580
1581         return 0;
1582 }
1583
1584 /* test activation of device */
1585 static void __init of_unittest_overlay_0(void)
1586 {
1587         /* device should enable */
1588         if (of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY))
1589                 return;
1590
1591         unittest(1, "overlay test %d passed\n", 0);
1592 }
1593
1594 /* test deactivation of device */
1595 static void __init of_unittest_overlay_1(void)
1596 {
1597         /* device should disable */
1598         if (of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY))
1599                 return;
1600
1601         unittest(1, "overlay test %d passed\n", 1);
1602 }
1603
1604 /* test activation of device */
1605 static void __init of_unittest_overlay_2(void)
1606 {
1607         /* device should enable */
1608         if (of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY))
1609                 return;
1610
1611         unittest(1, "overlay test %d passed\n", 2);
1612 }
1613
1614 /* test deactivation of device */
1615 static void __init of_unittest_overlay_3(void)
1616 {
1617         /* device should disable */
1618         if (of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY))
1619                 return;
1620
1621         unittest(1, "overlay test %d passed\n", 3);
1622 }
1623
1624 /* test activation of a full device node */
1625 static void __init of_unittest_overlay_4(void)
1626 {
1627         /* device should disable */
1628         if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
1629                 return;
1630
1631         unittest(1, "overlay test %d passed\n", 4);
1632 }
1633
1634 /* test overlay apply/revert sequence */
1635 static void __init of_unittest_overlay_5(void)
1636 {
1637         /* device should disable */
1638         if (of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY))
1639                 return;
1640
1641         unittest(1, "overlay test %d passed\n", 5);
1642 }
1643
1644 /* test overlay application in sequence */
1645 static void __init of_unittest_overlay_6(void)
1646 {
1647         int i, ov_id[2], ovcs_id;
1648         int overlay_nr = 6, unittest_nr = 6;
1649         int before = 0, after = 1;
1650         const char *overlay_name;
1651
1652         /* unittest device must be in before state */
1653         for (i = 0; i < 2; i++) {
1654                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1655                                 != before) {
1656                         unittest(0, "%s with device @\"%s\" %s\n",
1657                                         overlay_name_from_nr(overlay_nr + i),
1658                                         unittest_path(unittest_nr + i,
1659                                                 PDEV_OVERLAY),
1660                                         !before ? "enabled" : "disabled");
1661                         return;
1662                 }
1663         }
1664
1665         /* apply the overlays */
1666         for (i = 0; i < 2; i++) {
1667
1668                 overlay_name = overlay_name_from_nr(overlay_nr + i);
1669
1670                 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1671                         unittest(0, "could not apply overlay \"%s\"\n",
1672                                         overlay_name);
1673                         return;
1674                 }
1675                 ov_id[i] = ovcs_id;
1676                 of_unittest_track_overlay(ov_id[i]);
1677         }
1678
1679         for (i = 0; i < 2; i++) {
1680                 /* unittest device must be in after state */
1681                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1682                                 != after) {
1683                         unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1684                                         overlay_name_from_nr(overlay_nr + i),
1685                                         unittest_path(unittest_nr + i,
1686                                                 PDEV_OVERLAY),
1687                                         !after ? "enabled" : "disabled");
1688                         return;
1689                 }
1690         }
1691
1692         for (i = 1; i >= 0; i--) {
1693                 ovcs_id = ov_id[i];
1694                 if (of_overlay_remove(&ovcs_id)) {
1695                         unittest(0, "%s failed destroy @\"%s\"\n",
1696                                         overlay_name_from_nr(overlay_nr + i),
1697                                         unittest_path(unittest_nr + i,
1698                                                 PDEV_OVERLAY));
1699                         return;
1700                 }
1701                 of_unittest_untrack_overlay(ov_id[i]);
1702         }
1703
1704         for (i = 0; i < 2; i++) {
1705                 /* unittest device must be again in before state */
1706                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1707                                 != before) {
1708                         unittest(0, "%s with device @\"%s\" %s\n",
1709                                         overlay_name_from_nr(overlay_nr + i),
1710                                         unittest_path(unittest_nr + i,
1711                                                 PDEV_OVERLAY),
1712                                         !before ? "enabled" : "disabled");
1713                         return;
1714                 }
1715         }
1716
1717         unittest(1, "overlay test %d passed\n", 6);
1718 }
1719
1720 /* test overlay application in sequence */
1721 static void __init of_unittest_overlay_8(void)
1722 {
1723         int i, ov_id[2], ovcs_id;
1724         int overlay_nr = 8, unittest_nr = 8;
1725         const char *overlay_name;
1726
1727         /* we don't care about device state in this test */
1728
1729         /* apply the overlays */
1730         for (i = 0; i < 2; i++) {
1731
1732                 overlay_name = overlay_name_from_nr(overlay_nr + i);
1733
1734                 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1735                         unittest(0, "could not apply overlay \"%s\"\n",
1736                                         overlay_name);
1737                         return;
1738                 }
1739                 ov_id[i] = ovcs_id;
1740                 of_unittest_track_overlay(ov_id[i]);
1741         }
1742
1743         /* now try to remove first overlay (it should fail) */
1744         ovcs_id = ov_id[0];
1745         if (!of_overlay_remove(&ovcs_id)) {
1746                 unittest(0, "%s was destroyed @\"%s\"\n",
1747                                 overlay_name_from_nr(overlay_nr + 0),
1748                                 unittest_path(unittest_nr,
1749                                         PDEV_OVERLAY));
1750                 return;
1751         }
1752
1753         /* removing them in order should work */
1754         for (i = 1; i >= 0; i--) {
1755                 ovcs_id = ov_id[i];
1756                 if (of_overlay_remove(&ovcs_id)) {
1757                         unittest(0, "%s not destroyed @\"%s\"\n",
1758                                         overlay_name_from_nr(overlay_nr + i),
1759                                         unittest_path(unittest_nr,
1760                                                 PDEV_OVERLAY));
1761                         return;
1762                 }
1763                 of_unittest_untrack_overlay(ov_id[i]);
1764         }
1765
1766         unittest(1, "overlay test %d passed\n", 8);
1767 }
1768
1769 /* test insertion of a bus with parent devices */
1770 static void __init of_unittest_overlay_10(void)
1771 {
1772         int ret;
1773         char *child_path;
1774
1775         /* device should disable */
1776         ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1777         if (unittest(ret == 0,
1778                         "overlay test %d failed; overlay application\n", 10))
1779                 return;
1780
1781         child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1782                         unittest_path(10, PDEV_OVERLAY));
1783         if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1784                 return;
1785
1786         ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1787         kfree(child_path);
1788
1789         unittest(ret, "overlay test %d failed; no child device\n", 10);
1790 }
1791
1792 /* test insertion of a bus with parent devices (and revert) */
1793 static void __init of_unittest_overlay_11(void)
1794 {
1795         int ret;
1796
1797         /* device should disable */
1798         ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1799                         PDEV_OVERLAY);
1800         unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
1801 }
1802
1803 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1804
1805 struct unittest_i2c_bus_data {
1806         struct platform_device  *pdev;
1807         struct i2c_adapter      adap;
1808 };
1809
1810 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1811                 struct i2c_msg *msgs, int num)
1812 {
1813         struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1814
1815         (void)std;
1816
1817         return num;
1818 }
1819
1820 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1821 {
1822         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1823 }
1824
1825 static const struct i2c_algorithm unittest_i2c_algo = {
1826         .master_xfer    = unittest_i2c_master_xfer,
1827         .functionality  = unittest_i2c_functionality,
1828 };
1829
1830 static int unittest_i2c_bus_probe(struct platform_device *pdev)
1831 {
1832         struct device *dev = &pdev->dev;
1833         struct device_node *np = dev->of_node;
1834         struct unittest_i2c_bus_data *std;
1835         struct i2c_adapter *adap;
1836         int ret;
1837
1838         if (np == NULL) {
1839                 dev_err(dev, "No OF data for device\n");
1840                 return -EINVAL;
1841
1842         }
1843
1844         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1845
1846         std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1847         if (!std)
1848                 return -ENOMEM;
1849
1850         /* link them together */
1851         std->pdev = pdev;
1852         platform_set_drvdata(pdev, std);
1853
1854         adap = &std->adap;
1855         i2c_set_adapdata(adap, std);
1856         adap->nr = -1;
1857         strlcpy(adap->name, pdev->name, sizeof(adap->name));
1858         adap->class = I2C_CLASS_DEPRECATED;
1859         adap->algo = &unittest_i2c_algo;
1860         adap->dev.parent = dev;
1861         adap->dev.of_node = dev->of_node;
1862         adap->timeout = 5 * HZ;
1863         adap->retries = 3;
1864
1865         ret = i2c_add_numbered_adapter(adap);
1866         if (ret != 0) {
1867                 dev_err(dev, "Failed to add I2C adapter\n");
1868                 return ret;
1869         }
1870
1871         return 0;
1872 }
1873
1874 static int unittest_i2c_bus_remove(struct platform_device *pdev)
1875 {
1876         struct device *dev = &pdev->dev;
1877         struct device_node *np = dev->of_node;
1878         struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1879
1880         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1881         i2c_del_adapter(&std->adap);
1882
1883         return 0;
1884 }
1885
1886 static const struct of_device_id unittest_i2c_bus_match[] = {
1887         { .compatible = "unittest-i2c-bus", },
1888         {},
1889 };
1890
1891 static struct platform_driver unittest_i2c_bus_driver = {
1892         .probe                  = unittest_i2c_bus_probe,
1893         .remove                 = unittest_i2c_bus_remove,
1894         .driver = {
1895                 .name           = "unittest-i2c-bus",
1896                 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1897         },
1898 };
1899
1900 static int unittest_i2c_dev_probe(struct i2c_client *client,
1901                 const struct i2c_device_id *id)
1902 {
1903         struct device *dev = &client->dev;
1904         struct device_node *np = client->dev.of_node;
1905
1906         if (!np) {
1907                 dev_err(dev, "No OF node\n");
1908                 return -EINVAL;
1909         }
1910
1911         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1912
1913         return 0;
1914 };
1915
1916 static int unittest_i2c_dev_remove(struct i2c_client *client)
1917 {
1918         struct device *dev = &client->dev;
1919         struct device_node *np = client->dev.of_node;
1920
1921         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1922         return 0;
1923 }
1924
1925 static const struct i2c_device_id unittest_i2c_dev_id[] = {
1926         { .name = "unittest-i2c-dev" },
1927         { }
1928 };
1929
1930 static struct i2c_driver unittest_i2c_dev_driver = {
1931         .driver = {
1932                 .name = "unittest-i2c-dev",
1933         },
1934         .probe = unittest_i2c_dev_probe,
1935         .remove = unittest_i2c_dev_remove,
1936         .id_table = unittest_i2c_dev_id,
1937 };
1938
1939 #if IS_BUILTIN(CONFIG_I2C_MUX)
1940
1941 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1942 {
1943         return 0;
1944 }
1945
1946 static int unittest_i2c_mux_probe(struct i2c_client *client,
1947                 const struct i2c_device_id *id)
1948 {
1949         int i, nchans;
1950         struct device *dev = &client->dev;
1951         struct i2c_adapter *adap = client->adapter;
1952         struct device_node *np = client->dev.of_node, *child;
1953         struct i2c_mux_core *muxc;
1954         u32 reg, max_reg;
1955
1956         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1957
1958         if (!np) {
1959                 dev_err(dev, "No OF node\n");
1960                 return -EINVAL;
1961         }
1962
1963         max_reg = (u32)-1;
1964         for_each_child_of_node(np, child) {
1965                 if (of_property_read_u32(child, "reg", &reg))
1966                         continue;
1967                 if (max_reg == (u32)-1 || reg > max_reg)
1968                         max_reg = reg;
1969         }
1970         nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1971         if (nchans == 0) {
1972                 dev_err(dev, "No channels\n");
1973                 return -EINVAL;
1974         }
1975
1976         muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1977                              unittest_i2c_mux_select_chan, NULL);
1978         if (!muxc)
1979                 return -ENOMEM;
1980         for (i = 0; i < nchans; i++) {
1981                 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
1982                         dev_err(dev, "Failed to register mux #%d\n", i);
1983                         i2c_mux_del_adapters(muxc);
1984                         return -ENODEV;
1985                 }
1986         }
1987
1988         i2c_set_clientdata(client, muxc);
1989
1990         return 0;
1991 };
1992
1993 static int unittest_i2c_mux_remove(struct i2c_client *client)
1994 {
1995         struct device *dev = &client->dev;
1996         struct device_node *np = client->dev.of_node;
1997         struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1998
1999         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2000         i2c_mux_del_adapters(muxc);
2001         return 0;
2002 }
2003
2004 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2005         { .name = "unittest-i2c-mux" },
2006         { }
2007 };
2008
2009 static struct i2c_driver unittest_i2c_mux_driver = {
2010         .driver = {
2011                 .name = "unittest-i2c-mux",
2012         },
2013         .probe = unittest_i2c_mux_probe,
2014         .remove = unittest_i2c_mux_remove,
2015         .id_table = unittest_i2c_mux_id,
2016 };
2017
2018 #endif
2019
2020 static int of_unittest_overlay_i2c_init(void)
2021 {
2022         int ret;
2023
2024         ret = i2c_add_driver(&unittest_i2c_dev_driver);
2025         if (unittest(ret == 0,
2026                         "could not register unittest i2c device driver\n"))
2027                 return ret;
2028
2029         ret = platform_driver_register(&unittest_i2c_bus_driver);
2030         if (unittest(ret == 0,
2031                         "could not register unittest i2c bus driver\n"))
2032                 return ret;
2033
2034 #if IS_BUILTIN(CONFIG_I2C_MUX)
2035         ret = i2c_add_driver(&unittest_i2c_mux_driver);
2036         if (unittest(ret == 0,
2037                         "could not register unittest i2c mux driver\n"))
2038                 return ret;
2039 #endif
2040
2041         return 0;
2042 }
2043
2044 static void of_unittest_overlay_i2c_cleanup(void)
2045 {
2046 #if IS_BUILTIN(CONFIG_I2C_MUX)
2047         i2c_del_driver(&unittest_i2c_mux_driver);
2048 #endif
2049         platform_driver_unregister(&unittest_i2c_bus_driver);
2050         i2c_del_driver(&unittest_i2c_dev_driver);
2051 }
2052
2053 static void __init of_unittest_overlay_i2c_12(void)
2054 {
2055         /* device should enable */
2056         if (of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY))
2057                 return;
2058
2059         unittest(1, "overlay test %d passed\n", 12);
2060 }
2061
2062 /* test deactivation of device */
2063 static void __init of_unittest_overlay_i2c_13(void)
2064 {
2065         /* device should disable */
2066         if (of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY))
2067                 return;
2068
2069         unittest(1, "overlay test %d passed\n", 13);
2070 }
2071
2072 /* just check for i2c mux existence */
2073 static void of_unittest_overlay_i2c_14(void)
2074 {
2075 }
2076
2077 static void __init of_unittest_overlay_i2c_15(void)
2078 {
2079         /* device should enable */
2080         if (of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY))
2081                 return;
2082
2083         unittest(1, "overlay test %d passed\n", 15);
2084 }
2085
2086 #else
2087
2088 static inline void of_unittest_overlay_i2c_14(void) { }
2089 static inline void of_unittest_overlay_i2c_15(void) { }
2090
2091 #endif
2092
2093 static void __init of_unittest_overlay(void)
2094 {
2095         struct device_node *bus_np = NULL;
2096
2097         if (platform_driver_register(&unittest_driver)) {
2098                 unittest(0, "could not register unittest driver\n");
2099                 goto out;
2100         }
2101
2102         bus_np = of_find_node_by_path(bus_path);
2103         if (bus_np == NULL) {
2104                 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2105                 goto out;
2106         }
2107
2108         if (of_platform_default_populate(bus_np, NULL, NULL)) {
2109                 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2110                 goto out;
2111         }
2112
2113         if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2114                 unittest(0, "could not find unittest0 @ \"%s\"\n",
2115                                 unittest_path(100, PDEV_OVERLAY));
2116                 goto out;
2117         }
2118
2119         if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2120                 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2121                                 unittest_path(101, PDEV_OVERLAY));
2122                 goto out;
2123         }
2124
2125         unittest(1, "basic infrastructure of overlays passed");
2126
2127         /* tests in sequence */
2128         of_unittest_overlay_0();
2129         of_unittest_overlay_1();
2130         of_unittest_overlay_2();
2131         of_unittest_overlay_3();
2132         of_unittest_overlay_4();
2133         of_unittest_overlay_5();
2134         of_unittest_overlay_6();
2135         of_unittest_overlay_8();
2136
2137         of_unittest_overlay_10();
2138         of_unittest_overlay_11();
2139
2140 #if IS_BUILTIN(CONFIG_I2C)
2141         if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2142                 goto out;
2143
2144         of_unittest_overlay_i2c_12();
2145         of_unittest_overlay_i2c_13();
2146         of_unittest_overlay_i2c_14();
2147         of_unittest_overlay_i2c_15();
2148
2149         of_unittest_overlay_i2c_cleanup();
2150 #endif
2151
2152         of_unittest_destroy_tracked_overlays();
2153
2154 out:
2155         of_node_put(bus_np);
2156 }
2157
2158 #else
2159 static inline void __init of_unittest_overlay(void) { }
2160 #endif
2161
2162 #ifdef CONFIG_OF_OVERLAY
2163
2164 /*
2165  * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2166  * in scripts/Makefile.lib
2167  */
2168
2169 #define OVERLAY_INFO_EXTERN(name) \
2170         extern uint8_t __dtb_##name##_begin[]; \
2171         extern uint8_t __dtb_##name##_end[]
2172
2173 #define OVERLAY_INFO(overlay_name, expected)             \
2174 {       .dtb_begin       = __dtb_##overlay_name##_begin, \
2175         .dtb_end         = __dtb_##overlay_name##_end,   \
2176         .expected_result = expected,                     \
2177         .name            = #overlay_name,                \
2178 }
2179
2180 struct overlay_info {
2181         uint8_t         *dtb_begin;
2182         uint8_t         *dtb_end;
2183         int             expected_result;
2184         int             overlay_id;
2185         char            *name;
2186 };
2187
2188 OVERLAY_INFO_EXTERN(overlay_base);
2189 OVERLAY_INFO_EXTERN(overlay);
2190 OVERLAY_INFO_EXTERN(overlay_0);
2191 OVERLAY_INFO_EXTERN(overlay_1);
2192 OVERLAY_INFO_EXTERN(overlay_2);
2193 OVERLAY_INFO_EXTERN(overlay_3);
2194 OVERLAY_INFO_EXTERN(overlay_4);
2195 OVERLAY_INFO_EXTERN(overlay_5);
2196 OVERLAY_INFO_EXTERN(overlay_6);
2197 OVERLAY_INFO_EXTERN(overlay_7);
2198 OVERLAY_INFO_EXTERN(overlay_8);
2199 OVERLAY_INFO_EXTERN(overlay_9);
2200 OVERLAY_INFO_EXTERN(overlay_10);
2201 OVERLAY_INFO_EXTERN(overlay_11);
2202 OVERLAY_INFO_EXTERN(overlay_12);
2203 OVERLAY_INFO_EXTERN(overlay_13);
2204 OVERLAY_INFO_EXTERN(overlay_15);
2205 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
2206 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
2207 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2208 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2209
2210 /* entries found by name */
2211 static struct overlay_info overlays[] = {
2212         OVERLAY_INFO(overlay_base, -9999),
2213         OVERLAY_INFO(overlay, 0),
2214         OVERLAY_INFO(overlay_0, 0),
2215         OVERLAY_INFO(overlay_1, 0),
2216         OVERLAY_INFO(overlay_2, 0),
2217         OVERLAY_INFO(overlay_3, 0),
2218         OVERLAY_INFO(overlay_4, 0),
2219         OVERLAY_INFO(overlay_5, 0),
2220         OVERLAY_INFO(overlay_6, 0),
2221         OVERLAY_INFO(overlay_7, 0),
2222         OVERLAY_INFO(overlay_8, 0),
2223         OVERLAY_INFO(overlay_9, 0),
2224         OVERLAY_INFO(overlay_10, 0),
2225         OVERLAY_INFO(overlay_11, 0),
2226         OVERLAY_INFO(overlay_12, 0),
2227         OVERLAY_INFO(overlay_13, 0),
2228         OVERLAY_INFO(overlay_15, 0),
2229         OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL),
2230         OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL),
2231         OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2232         OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2233         /* end marker */
2234         {.dtb_begin = NULL, .dtb_end = NULL, .expected_result = 0, .name = NULL}
2235 };
2236
2237 static struct device_node *overlay_base_root;
2238
2239 static void * __init dt_alloc_memory(u64 size, u64 align)
2240 {
2241         void *ptr = memblock_alloc(size, align);
2242
2243         if (!ptr)
2244                 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
2245                       __func__, size, align);
2246
2247         return ptr;
2248 }
2249
2250 /*
2251  * Create base device tree for the overlay unittest.
2252  *
2253  * This is called from very early boot code.
2254  *
2255  * Do as much as possible the same way as done in __unflatten_device_tree
2256  * and other early boot steps for the normal FDT so that the overlay base
2257  * unflattened tree will have the same characteristics as the real tree
2258  * (such as having memory allocated by the early allocator).  The goal
2259  * is to test "the real thing" as much as possible, and test "test setup
2260  * code" as little as possible.
2261  *
2262  * Have to stop before resolving phandles, because that uses kmalloc.
2263  */
2264 void __init unittest_unflatten_overlay_base(void)
2265 {
2266         struct overlay_info *info;
2267         u32 data_size;
2268         void *new_fdt;
2269         u32 size;
2270         int found = 0;
2271         const char *overlay_name = "overlay_base";
2272
2273         for (info = overlays; info && info->name; info++) {
2274                 if (!strcmp(overlay_name, info->name)) {
2275                         found = 1;
2276                         break;
2277                 }
2278         }
2279         if (!found) {
2280                 pr_err("no overlay data for %s\n", overlay_name);
2281                 return;
2282         }
2283
2284         info = &overlays[0];
2285
2286         if (info->expected_result != -9999) {
2287                 pr_err("No dtb 'overlay_base' to attach\n");
2288                 return;
2289         }
2290
2291         data_size = info->dtb_end - info->dtb_begin;
2292         if (!data_size) {
2293                 pr_err("No dtb 'overlay_base' to attach\n");
2294                 return;
2295         }
2296
2297         size = fdt_totalsize(info->dtb_begin);
2298         if (size != data_size) {
2299                 pr_err("dtb 'overlay_base' header totalsize != actual size");
2300                 return;
2301         }
2302
2303         new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2304         if (!new_fdt) {
2305                 pr_err("alloc for dtb 'overlay_base' failed");
2306                 return;
2307         }
2308
2309         memcpy(new_fdt, info->dtb_begin, size);
2310
2311         __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2312                                 dt_alloc_memory, true);
2313 }
2314
2315 /*
2316  * The purpose of of_unittest_overlay_data_add is to add an
2317  * overlay in the normal fashion.  This is a test of the whole
2318  * picture, instead of testing individual elements.
2319  *
2320  * A secondary purpose is to be able to verify that the contents of
2321  * /proc/device-tree/ contains the updated structure and values from
2322  * the overlay.  That must be verified separately in user space.
2323  *
2324  * Return 0 on unexpected error.
2325  */
2326 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2327 {
2328         struct overlay_info *info;
2329         int found = 0;
2330         int ret;
2331         u32 size;
2332
2333         for (info = overlays; info && info->name; info++) {
2334                 if (!strcmp(overlay_name, info->name)) {
2335                         found = 1;
2336                         break;
2337                 }
2338         }
2339         if (!found) {
2340                 pr_err("no overlay data for %s\n", overlay_name);
2341                 return 0;
2342         }
2343
2344         size = info->dtb_end - info->dtb_begin;
2345         if (!size)
2346                 pr_err("no overlay data for %s\n", overlay_name);
2347
2348         ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2349         if (overlay_id)
2350                 *overlay_id = info->overlay_id;
2351         if (ret < 0)
2352                 goto out;
2353
2354         pr_debug("%s applied\n", overlay_name);
2355
2356 out:
2357         if (ret != info->expected_result)
2358                 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2359                        info->expected_result, ret, overlay_name);
2360
2361         return (ret == info->expected_result);
2362 }
2363
2364 /*
2365  * The purpose of of_unittest_overlay_high_level is to add an overlay
2366  * in the normal fashion.  This is a test of the whole picture,
2367  * instead of individual elements.
2368  *
2369  * The first part of the function is _not_ normal overlay usage; it is
2370  * finishing splicing the base overlay device tree into the live tree.
2371  */
2372 static __init void of_unittest_overlay_high_level(void)
2373 {
2374         struct device_node *last_sibling;
2375         struct device_node *np;
2376         struct device_node *of_symbols;
2377         struct device_node *overlay_base_symbols;
2378         struct device_node **pprev;
2379         struct property *prop;
2380
2381         if (!overlay_base_root) {
2382                 unittest(0, "overlay_base_root not initialized\n");
2383                 return;
2384         }
2385
2386         /*
2387          * Could not fixup phandles in unittest_unflatten_overlay_base()
2388          * because kmalloc() was not yet available.
2389          */
2390         of_overlay_mutex_lock();
2391         of_resolve_phandles(overlay_base_root);
2392         of_overlay_mutex_unlock();
2393
2394
2395         /*
2396          * do not allow overlay_base to duplicate any node already in
2397          * tree, this greatly simplifies the code
2398          */
2399
2400         /*
2401          * remove overlay_base_root node "__local_fixups", after
2402          * being used by of_resolve_phandles()
2403          */
2404         pprev = &overlay_base_root->child;
2405         for (np = overlay_base_root->child; np; np = np->sibling) {
2406                 if (of_node_name_eq(np, "__local_fixups__")) {
2407                         *pprev = np->sibling;
2408                         break;
2409                 }
2410                 pprev = &np->sibling;
2411         }
2412
2413         /* remove overlay_base_root node "__symbols__" if in live tree */
2414         of_symbols = of_get_child_by_name(of_root, "__symbols__");
2415         if (of_symbols) {
2416                 /* will have to graft properties from node into live tree */
2417                 pprev = &overlay_base_root->child;
2418                 for (np = overlay_base_root->child; np; np = np->sibling) {
2419                         if (of_node_name_eq(np, "__symbols__")) {
2420                                 overlay_base_symbols = np;
2421                                 *pprev = np->sibling;
2422                                 break;
2423                         }
2424                         pprev = &np->sibling;
2425                 }
2426         }
2427
2428         for_each_child_of_node(overlay_base_root, np) {
2429                 struct device_node *base_child;
2430                 for_each_child_of_node(of_root, base_child) {
2431                         if (!strcmp(np->full_name, base_child->full_name)) {
2432                                 unittest(0, "illegal node name in overlay_base %pOFn",
2433                                          np);
2434                                 return;
2435                         }
2436                 }
2437         }
2438
2439         /*
2440          * overlay 'overlay_base' is not allowed to have root
2441          * properties, so only need to splice nodes into main device tree.
2442          *
2443          * root node of *overlay_base_root will not be freed, it is lost
2444          * memory.
2445          */
2446
2447         for (np = overlay_base_root->child; np; np = np->sibling)
2448                 np->parent = of_root;
2449
2450         mutex_lock(&of_mutex);
2451
2452         for (last_sibling = np = of_root->child; np; np = np->sibling)
2453                 last_sibling = np;
2454
2455         if (last_sibling)
2456                 last_sibling->sibling = overlay_base_root->child;
2457         else
2458                 of_root->child = overlay_base_root->child;
2459
2460         for_each_of_allnodes_from(overlay_base_root, np)
2461                 __of_attach_node_sysfs(np);
2462
2463         if (of_symbols) {
2464                 struct property *new_prop;
2465                 for_each_property_of_node(overlay_base_symbols, prop) {
2466
2467                         new_prop = __of_prop_dup(prop, GFP_KERNEL);
2468                         if (!new_prop) {
2469                                 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
2470                                          prop->name);
2471                                 goto err_unlock;
2472                         }
2473                         if (__of_add_property(of_symbols, new_prop)) {
2474                                 /* "name" auto-generated by unflatten */
2475                                 if (!strcmp(new_prop->name, "name"))
2476                                         continue;
2477                                 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
2478                                          prop->name);
2479                                 goto err_unlock;
2480                         }
2481                         if (__of_add_property_sysfs(of_symbols, new_prop)) {
2482                                 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2483                                          prop->name);
2484                                 goto err_unlock;
2485                         }
2486                 }
2487         }
2488
2489         mutex_unlock(&of_mutex);
2490
2491
2492         /* now do the normal overlay usage test */
2493
2494         unittest(overlay_data_apply("overlay", NULL),
2495                  "Adding overlay 'overlay' failed\n");
2496
2497         unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
2498                  "Adding overlay 'overlay_bad_add_dup_node' failed\n");
2499
2500         unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
2501                  "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
2502
2503         unittest(overlay_data_apply("overlay_bad_phandle", NULL),
2504                  "Adding overlay 'overlay_bad_phandle' failed\n");
2505
2506         unittest(overlay_data_apply("overlay_bad_symbol", NULL),
2507                  "Adding overlay 'overlay_bad_symbol' failed\n");
2508
2509         return;
2510
2511 err_unlock:
2512         mutex_unlock(&of_mutex);
2513 }
2514
2515 #else
2516
2517 static inline __init void of_unittest_overlay_high_level(void) {}
2518
2519 #endif
2520
2521 static int __init of_unittest(void)
2522 {
2523         struct device_node *np;
2524         int res;
2525
2526         /* adding data for unittest */
2527
2528         if (IS_ENABLED(CONFIG_UML))
2529                 unittest_unflatten_overlay_base();
2530
2531         res = unittest_data_add();
2532         if (res)
2533                 return res;
2534         if (!of_aliases)
2535                 of_aliases = of_find_node_by_path("/aliases");
2536
2537         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2538         if (!np) {
2539                 pr_info("No testcase data in device tree; not running tests\n");
2540                 return 0;
2541         }
2542         of_node_put(np);
2543
2544         pr_info("start of unittest - you will see error messages\n");
2545         of_unittest_check_tree_linkage();
2546         of_unittest_check_phandles();
2547         of_unittest_find_node_by_name();
2548         of_unittest_dynamic();
2549         of_unittest_parse_phandle_with_args();
2550         of_unittest_parse_phandle_with_args_map();
2551         of_unittest_printf();
2552         of_unittest_property_string();
2553         of_unittest_property_copy();
2554         of_unittest_changeset();
2555         of_unittest_parse_interrupts();
2556         of_unittest_parse_interrupts_extended();
2557         of_unittest_match_node();
2558         of_unittest_platform_populate();
2559         of_unittest_overlay();
2560
2561         /* Double check linkage after removing testcase data */
2562         of_unittest_check_tree_linkage();
2563
2564         of_unittest_overlay_high_level();
2565
2566         pr_info("end of unittest - %i passed, %i failed\n",
2567                 unittest_results.passed, unittest_results.failed);
2568
2569         return 0;
2570 }
2571 late_initcall(of_unittest);