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/bootmem.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, "%pOFp", phandle_str);
 303         of_unittest_printf_one(np, "%pOFP", "dev@100");
 304         of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
 305         of_unittest_printf_one(np, "%10pOFP", "   dev@100");
 306         of_unittest_printf_one(np, "%-10pOFP", "dev@100   ");
 307         of_unittest_printf_one(of_root, "%pOFP", "/");
 308         of_unittest_printf_one(np, "%pOFF", "----");
 309         of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
 310         of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
 311         of_unittest_printf_one(np, "%pOFc", "test-sub-device");
 312         of_unittest_printf_one(np, "%pOFC",
 313                         "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
 314 }
 315
 316 struct node_hash {
 317         struct hlist_node node;
 318         struct device_node *np;
 319 };
 320
 321 static DEFINE_HASHTABLE(phandle_ht, 8);
 322 static void __init of_unittest_check_phandles(void)
 323 {
 324         struct device_node *np;
 325         struct node_hash *nh;
 326         struct hlist_node *tmp;
 327         int i, dup_count = 0, phandle_count = 0;
 328
 329         for_each_of_allnodes(np) {
 330                 if (!np->phandle)
 331                         continue;
 332
 333                 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
 334                         if (nh->np->phandle == np->phandle) {
 335                                 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
 336                                         np->phandle, nh->np, np);
 337                                 dup_count++;
 338                                 break;
 339                         }
 340                 }
 341
 342                 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
 343                 if (WARN_ON(!nh))
 344                         return;
 345
 346                 nh->np = np;
 347                 hash_add(phandle_ht, &nh->node, np->phandle);
 348                 phandle_count++;
 349         }
 350         unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
 351                  dup_count, phandle_count);
 352
 353         /* Clean up */
 354         hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
 355                 hash_del(&nh->node);
 356                 kfree(nh);
 357         }
 358 }
 359
 360 static void __init of_unittest_parse_phandle_with_args(void)
 361 {
 362         struct device_node *np;
 363         struct of_phandle_args args;
 364         int i, rc;
 365
 366         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 367         if (!np) {
 368                 pr_err("missing testcase data\n");
 369                 return;
 370         }
 371
 372         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 373         unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 374
 375         for (i = 0; i < 8; i++) {
 376                 bool passed = true;
 377
 378                 memset(&args, 0, sizeof(args));
 379                 rc = of_parse_phandle_with_args(np, "phandle-list",
 380                                                 "#phandle-cells", i, &args);
 381
 382                 /* Test the values from tests-phandle.dtsi */
 383                 switch (i) {
 384                 case 0:
 385                         passed &= !rc;
 386                         passed &= (args.args_count == 1);
 387                         passed &= (args.args[0] == (i + 1));
 388                         break;
 389                 case 1:
 390                         passed &= !rc;
 391                         passed &= (args.args_count == 2);
 392                         passed &= (args.args[0] == (i + 1));
 393                         passed &= (args.args[1] == 0);
 394                         break;
 395                 case 2:
 396                         passed &= (rc == -ENOENT);
 397                         break;
 398                 case 3:
 399                         passed &= !rc;
 400                         passed &= (args.args_count == 3);
 401                         passed &= (args.args[0] == (i + 1));
 402                         passed &= (args.args[1] == 4);
 403                         passed &= (args.args[2] == 3);
 404                         break;
 405                 case 4:
 406                         passed &= !rc;
 407                         passed &= (args.args_count == 2);
 408                         passed &= (args.args[0] == (i + 1));
 409                         passed &= (args.args[1] == 100);
 410                         break;
 411                 case 5:
 412                         passed &= !rc;
 413                         passed &= (args.args_count == 0);
 414                         break;
 415                 case 6:
 416                         passed &= !rc;
 417                         passed &= (args.args_count == 1);
 418                         passed &= (args.args[0] == (i + 1));
 419                         break;
 420                 case 7:
 421                         passed &= (rc == -ENOENT);
 422                         break;
 423                 default:
 424                         passed = false;
 425                 }
 426
 427                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 428                          i, args.np, rc);
 429         }
 430
 431         /* Check for missing list property */
 432         memset(&args, 0, sizeof(args));
 433         rc = of_parse_phandle_with_args(np, "phandle-list-missing",
 434                                         "#phandle-cells", 0, &args);
 435         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 436         rc = of_count_phandle_with_args(np, "phandle-list-missing",
 437                                         "#phandle-cells");
 438         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 439
 440         /* Check for missing cells property */
 441         memset(&args, 0, sizeof(args));
 442         rc = of_parse_phandle_with_args(np, "phandle-list",
 443                                         "#phandle-cells-missing", 0, &args);
 444         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 445         rc = of_count_phandle_with_args(np, "phandle-list",
 446                                         "#phandle-cells-missing");
 447         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 448
 449         /* Check for bad phandle in list */
 450         memset(&args, 0, sizeof(args));
 451         rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
 452                                         "#phandle-cells", 0, &args);
 453         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 454         rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
 455                                         "#phandle-cells");
 456         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 457
 458         /* Check for incorrectly formed argument list */
 459         memset(&args, 0, sizeof(args));
 460         rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
 461                                         "#phandle-cells", 1, &args);
 462         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 463         rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
 464                                         "#phandle-cells");
 465         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 466 }
 467
 468 static void __init of_unittest_parse_phandle_with_args_map(void)
 469 {
 470         struct device_node *np, *p0, *p1, *p2, *p3;
 471         struct of_phandle_args args;
 472         int i, rc;
 473
 474         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
 475         if (!np) {
 476                 pr_err("missing testcase data\n");
 477                 return;
 478         }
 479
 480         p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
 481         if (!p0) {
 482                 pr_err("missing testcase data\n");
 483                 return;
 484         }
 485
 486         p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
 487         if (!p1) {
 488                 pr_err("missing testcase data\n");
 489                 return;
 490         }
 491
 492         p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
 493         if (!p2) {
 494                 pr_err("missing testcase data\n");
 495                 return;
 496         }
 497
 498         p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
 499         if (!p3) {
 500                 pr_err("missing testcase data\n");
 501                 return;
 502         }
 503
 504         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 505         unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 506
 507         for (i = 0; i < 8; i++) {
 508                 bool passed = true;
 509
 510                 memset(&args, 0, sizeof(args));
 511                 rc = of_parse_phandle_with_args_map(np, "phandle-list",
 512                                                     "phandle", i, &args);
 513
 514                 /* Test the values from tests-phandle.dtsi */
 515                 switch (i) {
 516                 case 0:
 517                         passed &= !rc;
 518                         passed &= (args.np == p1);
 519                         passed &= (args.args_count == 1);
 520                         passed &= (args.args[0] == 1);
 521                         break;
 522                 case 1:
 523                         passed &= !rc;
 524                         passed &= (args.np == p3);
 525                         passed &= (args.args_count == 3);
 526                         passed &= (args.args[0] == 2);
 527                         passed &= (args.args[1] == 5);
 528                         passed &= (args.args[2] == 3);
 529                         break;
 530                 case 2:
 531                         passed &= (rc == -ENOENT);
 532                         break;
 533                 case 3:
 534                         passed &= !rc;
 535                         passed &= (args.np == p0);
 536                         passed &= (args.args_count == 0);
 537                         break;
 538                 case 4:
 539                         passed &= !rc;
 540                         passed &= (args.np == p1);
 541                         passed &= (args.args_count == 1);
 542                         passed &= (args.args[0] == 3);
 543                         break;
 544                 case 5:
 545                         passed &= !rc;
 546                         passed &= (args.np == p0);
 547                         passed &= (args.args_count == 0);
 548                         break;
 549                 case 6:
 550                         passed &= !rc;
 551                         passed &= (args.np == p2);
 552                         passed &= (args.args_count == 2);
 553                         passed &= (args.args[0] == 15);
 554                         passed &= (args.args[1] == 0x20);
 555                         break;
 556                 case 7:
 557                         passed &= (rc == -ENOENT);
 558                         break;
 559                 default:
 560                         passed = false;
 561                 }
 562
 563                 unittest(passed, "index %i - data error on node %s rc=%i\n",
 564                          i, args.np->full_name, rc);
 565         }
 566
 567         /* Check for missing list property */
 568         memset(&args, 0, sizeof(args));
 569         rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
 570                                             "phandle", 0, &args);
 571         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 572
 573         /* Check for missing cells,map,mask property */
 574         memset(&args, 0, sizeof(args));
 575         rc = of_parse_phandle_with_args_map(np, "phandle-list",
 576                                             "phandle-missing", 0, &args);
 577         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 578
 579         /* Check for bad phandle in list */
 580         memset(&args, 0, sizeof(args));
 581         rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
 582                                             "phandle", 0, &args);
 583         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 584
 585         /* Check for incorrectly formed argument list */
 586         memset(&args, 0, sizeof(args));
 587         rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
 588                                             "phandle", 1, &args);
 589         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 590 }
 591
 592 static void __init of_unittest_property_string(void)
 593 {
 594         const char *strings[4];
 595         struct device_node *np;
 596         int rc;
 597
 598         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 599         if (!np) {
 600                 pr_err("No testcase data in device tree\n");
 601                 return;
 602         }
 603
 604         rc = of_property_match_string(np, "phandle-list-names", "first");
 605         unittest(rc == 0, "first expected:0 got:%i\n", rc);
 606         rc = of_property_match_string(np, "phandle-list-names", "second");
 607         unittest(rc == 1, "second expected:1 got:%i\n", rc);
 608         rc = of_property_match_string(np, "phandle-list-names", "third");
 609         unittest(rc == 2, "third expected:2 got:%i\n", rc);
 610         rc = of_property_match_string(np, "phandle-list-names", "fourth");
 611         unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
 612         rc = of_property_match_string(np, "missing-property", "blah");
 613         unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
 614         rc = of_property_match_string(np, "empty-property", "blah");
 615         unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
 616         rc = of_property_match_string(np, "unterminated-string", "blah");
 617         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 618
 619         /* of_property_count_strings() tests */
 620         rc = of_property_count_strings(np, "string-property");
 621         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 622         rc = of_property_count_strings(np, "phandle-list-names");
 623         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 624         rc = of_property_count_strings(np, "unterminated-string");
 625         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 626         rc = of_property_count_strings(np, "unterminated-string-list");
 627         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 628
 629         /* of_property_read_string_index() tests */
 630         rc = of_property_read_string_index(np, "string-property", 0, strings);
 631         unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
 632         strings[0] = NULL;
 633         rc = of_property_read_string_index(np, "string-property", 1, strings);
 634         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 635         rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
 636         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 637         rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
 638         unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
 639         rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
 640         unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
 641         strings[0] = NULL;
 642         rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
 643         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 644         strings[0] = NULL;
 645         rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
 646         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 647         rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
 648         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 649         strings[0] = NULL;
 650         rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
 651         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 652         strings[1] = NULL;
 653
 654         /* of_property_read_string_array() tests */
 655         rc = of_property_read_string_array(np, "string-property", strings, 4);
 656         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 657         rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
 658         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 659         rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
 660         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 661         /* -- An incorrectly formed string should cause a failure */
 662         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
 663         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 664         /* -- parsing the correctly formed strings should still work: */
 665         strings[2] = NULL;
 666         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
 667         unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
 668         strings[1] = NULL;
 669         rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
 670         unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
 671 }
 672
 673 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
 674                         (p1)->value && (p2)->value && \
 675                         !memcmp((p1)->value, (p2)->value, (p1)->length) && \
 676                         !strcmp((p1)->name, (p2)->name))
 677 static void __init of_unittest_property_copy(void)
 678 {
 679 #ifdef CONFIG_OF_DYNAMIC
 680         struct property p1 = { .name = "p1", .length = 0, .value = "" };
 681         struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
 682         struct property *new;
 683
 684         new = __of_prop_dup(&p1, GFP_KERNEL);
 685         unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
 686         kfree(new->value);
 687         kfree(new->name);
 688         kfree(new);
 689
 690         new = __of_prop_dup(&p2, GFP_KERNEL);
 691         unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
 692         kfree(new->value);
 693         kfree(new->name);
 694         kfree(new);
 695 #endif
 696 }
 697
 698 static void __init of_unittest_changeset(void)
 699 {
 700 #ifdef CONFIG_OF_DYNAMIC
 701         struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
 702         struct property *ppname_n1,  pname_n1  = { .name = "name", .length = 3, .value = "n1"  };
 703         struct property *ppname_n2,  pname_n2  = { .name = "name", .length = 3, .value = "n2"  };
 704         struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
 705         struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
 706         struct property *ppremove;
 707         struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
 708         struct of_changeset chgset;
 709
 710         n1 = __of_node_dup(NULL, "n1");
 711         unittest(n1, "testcase setup failure\n");
 712
 713         n2 = __of_node_dup(NULL, "n2");
 714         unittest(n2, "testcase setup failure\n");
 715
 716         n21 = __of_node_dup(NULL, "n21");
 717         unittest(n21, "testcase setup failure %p\n", n21);
 718
 719         nchangeset = of_find_node_by_path("/testcase-data/changeset");
 720         nremove = of_get_child_by_name(nchangeset, "node-remove");
 721         unittest(nremove, "testcase setup failure\n");
 722
 723         ppadd = __of_prop_dup(&padd, GFP_KERNEL);
 724         unittest(ppadd, "testcase setup failure\n");
 725
 726         ppname_n1  = __of_prop_dup(&pname_n1, GFP_KERNEL);
 727         unittest(ppname_n1, "testcase setup failure\n");
 728
 729         ppname_n2  = __of_prop_dup(&pname_n2, GFP_KERNEL);
 730         unittest(ppname_n2, "testcase setup failure\n");
 731
 732         ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
 733         unittest(ppname_n21, "testcase setup failure\n");
 734
 735         ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
 736         unittest(ppupdate, "testcase setup failure\n");
 737
 738         parent = nchangeset;
 739         n1->parent = parent;
 740         n2->parent = parent;
 741         n21->parent = n2;
 742
 743         ppremove = of_find_property(parent, "prop-remove", NULL);
 744         unittest(ppremove, "failed to find removal prop");
 745
 746         of_changeset_init(&chgset);
 747
 748         unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
 749         unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
 750
 751         unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
 752         unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
 753
 754         unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
 755         unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
 756
 757         unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
 758
 759         unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
 760         unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
 761         unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
 762
 763         unittest(!of_changeset_apply(&chgset), "apply failed\n");
 764
 765         of_node_put(nchangeset);
 766
 767         /* Make sure node names are constructed correctly */
 768         unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
 769                  "'%pOF' not added\n", n21);
 770         of_node_put(np);
 771
 772         unittest(!of_changeset_revert(&chgset), "revert failed\n");
 773
 774         of_changeset_destroy(&chgset);
 775
 776         of_node_put(n1);
 777         of_node_put(n2);
 778         of_node_put(n21);
 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                 return;
1049         test_bus->dev.of_node = np;
1050
1051         /*
1052          * Add a dummy resource to the test bus node after it is
1053          * registered to catch problems with un-inserted resources. The
1054          * DT code doesn't insert the resources, and it has caused the
1055          * kernel to oops in the past. This makes sure the same bug
1056          * doesn't crop up again.
1057          */
1058         platform_device_add_resources(test_bus, &test_bus_res, 1);
1059
1060         of_platform_populate(np, match, NULL, &test_bus->dev);
1061         for_each_child_of_node(np, child) {
1062                 for_each_child_of_node(child, grandchild) {
1063                         pdev = of_find_device_by_node(grandchild);
1064                         unittest(pdev,
1065                                  "Could not create device for node '%pOFn'\n",
1066                                  grandchild);
1067                         of_dev_put(pdev);
1068                 }
1069         }
1070
1071         of_platform_depopulate(&test_bus->dev);
1072         for_each_child_of_node(np, child) {
1073                 for_each_child_of_node(child, grandchild)
1074                         unittest(!of_find_device_by_node(grandchild),
1075                                  "device didn't get destroyed '%pOFn'\n",
1076                                  grandchild);
1077         }
1078
1079         platform_device_unregister(test_bus);
1080         of_node_put(np);
1081 }
1082
1083 /**
1084  *      update_node_properties - adds the properties
1085  *      of np into dup node (present in live tree) and
1086  *      updates parent of children of np to dup.
1087  *
1088  *      @np:    node whose properties are being added to the live tree
1089  *      @dup:   node present in live tree to be updated
1090  */
1091 static void update_node_properties(struct device_node *np,
1092                                         struct device_node *dup)
1093 {
1094         struct property *prop;
1095         struct property *save_next;
1096         struct device_node *child;
1097         int ret;
1098
1099         for_each_child_of_node(np, child)
1100                 child->parent = dup;
1101
1102         /*
1103          * "unittest internal error: unable to add testdata property"
1104          *
1105          *    If this message reports a property in node '/__symbols__' then
1106          *    the respective unittest overlay contains a label that has the
1107          *    same name as a label in the live devicetree.  The label will
1108          *    be in the live devicetree only if the devicetree source was
1109          *    compiled with the '-@' option.  If you encounter this error,
1110          *    please consider renaming __all__ of the labels in the unittest
1111          *    overlay dts files with an odd prefix that is unlikely to be
1112          *    used in a real devicetree.
1113          */
1114
1115         /*
1116          * open code for_each_property_of_node() because of_add_property()
1117          * sets prop->next to NULL
1118          */
1119         for (prop = np->properties; prop != NULL; prop = save_next) {
1120                 save_next = prop->next;
1121                 ret = of_add_property(dup, prop);
1122                 if (ret)
1123                         pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1124                                np, prop->name);
1125         }
1126 }
1127
1128 /**
1129  *      attach_node_and_children - attaches nodes
1130  *      and its children to live tree
1131  *
1132  *      @np:    Node to attach to live tree
1133  */
1134 static void attach_node_and_children(struct device_node *np)
1135 {
1136         struct device_node *next, *dup, *child;
1137         unsigned long flags;
1138         const char *full_name;
1139
1140         full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1141
1142         if (!strcmp(full_name, "/__local_fixups__") ||
1143             !strcmp(full_name, "/__fixups__")) {
1144                 kfree(full_name);
1145                 return;
1146         }
1147
1148         dup = of_find_node_by_path(full_name);
1149         kfree(full_name);
1150         if (dup) {
1151                 update_node_properties(np, dup);
1152                 return;
1153         }
1154
1155         child = np->child;
1156         np->child = NULL;
1157
1158         mutex_lock(&of_mutex);
1159         raw_spin_lock_irqsave(&devtree_lock, flags);
1160         np->sibling = np->parent->child;
1161         np->parent->child = np;
1162         of_node_clear_flag(np, OF_DETACHED);
1163         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1164
1165         __of_attach_node_sysfs(np);
1166         mutex_unlock(&of_mutex);
1167
1168         while (child) {
1169                 next = child->sibling;
1170                 attach_node_and_children(child);
1171                 child = next;
1172         }
1173 }
1174
1175 /**
1176  *      unittest_data_add - Reads, copies data from
1177  *      linked tree and attaches it to the live tree
1178  */
1179 static int __init unittest_data_add(void)
1180 {
1181         void *unittest_data;
1182         struct device_node *unittest_data_node, *np;
1183         /*
1184          * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1185          * created by cmd_dt_S_dtb in scripts/Makefile.lib
1186          */
1187         extern uint8_t __dtb_testcases_begin[];
1188         extern uint8_t __dtb_testcases_end[];
1189         const int size = __dtb_testcases_end - __dtb_testcases_begin;
1190         int rc;
1191
1192         if (!size) {
1193                 pr_warn("%s: No testcase data to attach; not running tests\n",
1194                         __func__);
1195                 return -ENODATA;
1196         }
1197
1198         /* creating copy */
1199         unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1200
1201         if (!unittest_data) {
1202                 pr_warn("%s: Failed to allocate memory for unittest_data; "
1203                         "not running tests\n", __func__);
1204                 return -ENOMEM;
1205         }
1206         of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1207         if (!unittest_data_node) {
1208                 pr_warn("%s: No tree to attach; not running tests\n", __func__);
1209                 kfree(unittest_data);
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 unittest_nr,
1481                 int *overlay_id)
1482 {
1483         const char *overlay_name;
1484
1485         overlay_name = overlay_name_from_nr(overlay_nr);
1486
1487         if (!overlay_data_apply(overlay_name, overlay_id)) {
1488                 unittest(0, "could not apply overlay \"%s\"\n",
1489                                 overlay_name);
1490                 return -EFAULT;
1491         }
1492         of_unittest_track_overlay(*overlay_id);
1493
1494         return 0;
1495 }
1496
1497 /* apply an overlay while checking before and after states */
1498 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1499                 int unittest_nr, int before, int after,
1500                 enum overlay_type ovtype)
1501 {
1502         int ret, ovcs_id;
1503
1504         /* unittest device must not be in before state */
1505         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1506                 unittest(0, "%s with device @\"%s\" %s\n",
1507                                 overlay_name_from_nr(overlay_nr),
1508                                 unittest_path(unittest_nr, ovtype),
1509                                 !before ? "enabled" : "disabled");
1510                 return -EINVAL;
1511         }
1512
1513         ovcs_id = 0;
1514         ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1515         if (ret != 0) {
1516                 /* of_unittest_apply_overlay already called unittest() */
1517                 return ret;
1518         }
1519
1520         /* unittest device must be to set to after state */
1521         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1522                 unittest(0, "%s failed to create @\"%s\" %s\n",
1523                                 overlay_name_from_nr(overlay_nr),
1524                                 unittest_path(unittest_nr, ovtype),
1525                                 !after ? "enabled" : "disabled");
1526                 return -EINVAL;
1527         }
1528
1529         return 0;
1530 }
1531
1532 /* apply an overlay and then revert it while checking before, after states */
1533 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1534                 int unittest_nr, int before, int after,
1535                 enum overlay_type ovtype)
1536 {
1537         int ret, ovcs_id;
1538
1539         /* unittest device must be in before state */
1540         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1541                 unittest(0, "%s with device @\"%s\" %s\n",
1542                                 overlay_name_from_nr(overlay_nr),
1543                                 unittest_path(unittest_nr, ovtype),
1544                                 !before ? "enabled" : "disabled");
1545                 return -EINVAL;
1546         }
1547
1548         /* apply the overlay */
1549         ovcs_id = 0;
1550         ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1551         if (ret != 0) {
1552                 /* of_unittest_apply_overlay already called unittest() */
1553                 return ret;
1554         }
1555
1556         /* unittest device must be in after state */
1557         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1558                 unittest(0, "%s failed to create @\"%s\" %s\n",
1559                                 overlay_name_from_nr(overlay_nr),
1560                                 unittest_path(unittest_nr, ovtype),
1561                                 !after ? "enabled" : "disabled");
1562                 return -EINVAL;
1563         }
1564
1565         ret = of_overlay_remove(&ovcs_id);
1566         if (ret != 0) {
1567                 unittest(0, "%s failed to be destroyed @\"%s\"\n",
1568                                 overlay_name_from_nr(overlay_nr),
1569                                 unittest_path(unittest_nr, ovtype));
1570                 return ret;
1571         }
1572
1573         /* unittest device must be again in before state */
1574         if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1575                 unittest(0, "%s with device @\"%s\" %s\n",
1576                                 overlay_name_from_nr(overlay_nr),
1577                                 unittest_path(unittest_nr, ovtype),
1578                                 !before ? "enabled" : "disabled");
1579                 return -EINVAL;
1580         }
1581
1582         return 0;
1583 }
1584
1585 /* test activation of device */
1586 static void __init of_unittest_overlay_0(void)
1587 {
1588         /* device should enable */
1589         if (of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY))
1590                 return;
1591
1592         unittest(1, "overlay test %d passed\n", 0);
1593 }
1594
1595 /* test deactivation of device */
1596 static void __init of_unittest_overlay_1(void)
1597 {
1598         /* device should disable */
1599         if (of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY))
1600                 return;
1601
1602         unittest(1, "overlay test %d passed\n", 1);
1603 }
1604
1605 /* test activation of device */
1606 static void __init of_unittest_overlay_2(void)
1607 {
1608         /* device should enable */
1609         if (of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY))
1610                 return;
1611
1612         unittest(1, "overlay test %d passed\n", 2);
1613 }
1614
1615 /* test deactivation of device */
1616 static void __init of_unittest_overlay_3(void)
1617 {
1618         /* device should disable */
1619         if (of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY))
1620                 return;
1621
1622         unittest(1, "overlay test %d passed\n", 3);
1623 }
1624
1625 /* test activation of a full device node */
1626 static void __init of_unittest_overlay_4(void)
1627 {
1628         /* device should disable */
1629         if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
1630                 return;
1631
1632         unittest(1, "overlay test %d passed\n", 4);
1633 }
1634
1635 /* test overlay apply/revert sequence */
1636 static void __init of_unittest_overlay_5(void)
1637 {
1638         /* device should disable */
1639         if (of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY))
1640                 return;
1641
1642         unittest(1, "overlay test %d passed\n", 5);
1643 }
1644
1645 /* test overlay application in sequence */
1646 static void __init of_unittest_overlay_6(void)
1647 {
1648         int i, ov_id[2], ovcs_id;
1649         int overlay_nr = 6, unittest_nr = 6;
1650         int before = 0, after = 1;
1651         const char *overlay_name;
1652
1653         /* unittest device must be in before state */
1654         for (i = 0; i < 2; i++) {
1655                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1656                                 != before) {
1657                         unittest(0, "%s with device @\"%s\" %s\n",
1658                                         overlay_name_from_nr(overlay_nr + i),
1659                                         unittest_path(unittest_nr + i,
1660                                                 PDEV_OVERLAY),
1661                                         !before ? "enabled" : "disabled");
1662                         return;
1663                 }
1664         }
1665
1666         /* apply the overlays */
1667         for (i = 0; i < 2; i++) {
1668
1669                 overlay_name = overlay_name_from_nr(overlay_nr + i);
1670
1671                 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1672                         unittest(0, "could not apply overlay \"%s\"\n",
1673                                         overlay_name);
1674                         return;
1675                 }
1676                 ov_id[i] = ovcs_id;
1677                 of_unittest_track_overlay(ov_id[i]);
1678         }
1679
1680         for (i = 0; i < 2; i++) {
1681                 /* unittest device must be in after state */
1682                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1683                                 != after) {
1684                         unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1685                                         overlay_name_from_nr(overlay_nr + i),
1686                                         unittest_path(unittest_nr + i,
1687                                                 PDEV_OVERLAY),
1688                                         !after ? "enabled" : "disabled");
1689                         return;
1690                 }
1691         }
1692
1693         for (i = 1; i >= 0; i--) {
1694                 ovcs_id = ov_id[i];
1695                 if (of_overlay_remove(&ovcs_id)) {
1696                         unittest(0, "%s failed destroy @\"%s\"\n",
1697                                         overlay_name_from_nr(overlay_nr + i),
1698                                         unittest_path(unittest_nr + i,
1699                                                 PDEV_OVERLAY));
1700                         return;
1701                 }
1702                 of_unittest_untrack_overlay(ov_id[i]);
1703         }
1704
1705         for (i = 0; i < 2; i++) {
1706                 /* unittest device must be again in before state */
1707                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1708                                 != before) {
1709                         unittest(0, "%s with device @\"%s\" %s\n",
1710                                         overlay_name_from_nr(overlay_nr + i),
1711                                         unittest_path(unittest_nr + i,
1712                                                 PDEV_OVERLAY),
1713                                         !before ? "enabled" : "disabled");
1714                         return;
1715                 }
1716         }
1717
1718         unittest(1, "overlay test %d passed\n", 6);
1719 }
1720
1721 /* test overlay application in sequence */
1722 static void __init of_unittest_overlay_8(void)
1723 {
1724         int i, ov_id[2], ovcs_id;
1725         int overlay_nr = 8, unittest_nr = 8;
1726         const char *overlay_name;
1727
1728         /* we don't care about device state in this test */
1729
1730         /* apply the overlays */
1731         for (i = 0; i < 2; i++) {
1732
1733                 overlay_name = overlay_name_from_nr(overlay_nr + i);
1734
1735                 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1736                         unittest(0, "could not apply overlay \"%s\"\n",
1737                                         overlay_name);
1738                         return;
1739                 }
1740                 ov_id[i] = ovcs_id;
1741                 of_unittest_track_overlay(ov_id[i]);
1742         }
1743
1744         /* now try to remove first overlay (it should fail) */
1745         ovcs_id = ov_id[0];
1746         if (!of_overlay_remove(&ovcs_id)) {
1747                 unittest(0, "%s was destroyed @\"%s\"\n",
1748                                 overlay_name_from_nr(overlay_nr + 0),
1749                                 unittest_path(unittest_nr,
1750                                         PDEV_OVERLAY));
1751                 return;
1752         }
1753
1754         /* removing them in order should work */
1755         for (i = 1; i >= 0; i--) {
1756                 ovcs_id = ov_id[i];
1757                 if (of_overlay_remove(&ovcs_id)) {
1758                         unittest(0, "%s not destroyed @\"%s\"\n",
1759                                         overlay_name_from_nr(overlay_nr + i),
1760                                         unittest_path(unittest_nr,
1761                                                 PDEV_OVERLAY));
1762                         return;
1763                 }
1764                 of_unittest_untrack_overlay(ov_id[i]);
1765         }
1766
1767         unittest(1, "overlay test %d passed\n", 8);
1768 }
1769
1770 /* test insertion of a bus with parent devices */
1771 static void __init of_unittest_overlay_10(void)
1772 {
1773         int ret;
1774         char *child_path;
1775
1776         /* device should disable */
1777         ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1778         if (unittest(ret == 0,
1779                         "overlay test %d failed; overlay application\n", 10))
1780                 return;
1781
1782         child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1783                         unittest_path(10, PDEV_OVERLAY));
1784         if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1785                 return;
1786
1787         ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1788         kfree(child_path);
1789
1790         unittest(ret, "overlay test %d failed; no child device\n", 10);
1791 }
1792
1793 /* test insertion of a bus with parent devices (and revert) */
1794 static void __init of_unittest_overlay_11(void)
1795 {
1796         int ret;
1797
1798         /* device should disable */
1799         ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1800                         PDEV_OVERLAY);
1801         unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
1802 }
1803
1804 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1805
1806 struct unittest_i2c_bus_data {
1807         struct platform_device  *pdev;
1808         struct i2c_adapter      adap;
1809 };
1810
1811 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1812                 struct i2c_msg *msgs, int num)
1813 {
1814         struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1815
1816         (void)std;
1817
1818         return num;
1819 }
1820
1821 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1822 {
1823         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1824 }
1825
1826 static const struct i2c_algorithm unittest_i2c_algo = {
1827         .master_xfer    = unittest_i2c_master_xfer,
1828         .functionality  = unittest_i2c_functionality,
1829 };
1830
1831 static int unittest_i2c_bus_probe(struct platform_device *pdev)
1832 {
1833         struct device *dev = &pdev->dev;
1834         struct device_node *np = dev->of_node;
1835         struct unittest_i2c_bus_data *std;
1836         struct i2c_adapter *adap;
1837         int ret;
1838
1839         if (np == NULL) {
1840                 dev_err(dev, "No OF data for device\n");
1841                 return -EINVAL;
1842
1843         }
1844
1845         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1846
1847         std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1848         if (!std) {
1849                 dev_err(dev, "Failed to allocate unittest i2c data\n");
1850                 return -ENOMEM;
1851         }
1852
1853         /* link them together */
1854         std->pdev = pdev;
1855         platform_set_drvdata(pdev, std);
1856
1857         adap = &std->adap;
1858         i2c_set_adapdata(adap, std);
1859         adap->nr = -1;
1860         strlcpy(adap->name, pdev->name, sizeof(adap->name));
1861         adap->class = I2C_CLASS_DEPRECATED;
1862         adap->algo = &unittest_i2c_algo;
1863         adap->dev.parent = dev;
1864         adap->dev.of_node = dev->of_node;
1865         adap->timeout = 5 * HZ;
1866         adap->retries = 3;
1867
1868         ret = i2c_add_numbered_adapter(adap);
1869         if (ret != 0) {
1870                 dev_err(dev, "Failed to add I2C adapter\n");
1871                 return ret;
1872         }
1873
1874         return 0;
1875 }
1876
1877 static int unittest_i2c_bus_remove(struct platform_device *pdev)
1878 {
1879         struct device *dev = &pdev->dev;
1880         struct device_node *np = dev->of_node;
1881         struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1882
1883         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1884         i2c_del_adapter(&std->adap);
1885
1886         return 0;
1887 }
1888
1889 static const struct of_device_id unittest_i2c_bus_match[] = {
1890         { .compatible = "unittest-i2c-bus", },
1891         {},
1892 };
1893
1894 static struct platform_driver unittest_i2c_bus_driver = {
1895         .probe                  = unittest_i2c_bus_probe,
1896         .remove                 = unittest_i2c_bus_remove,
1897         .driver = {
1898                 .name           = "unittest-i2c-bus",
1899                 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1900         },
1901 };
1902
1903 static int unittest_i2c_dev_probe(struct i2c_client *client,
1904                 const struct i2c_device_id *id)
1905 {
1906         struct device *dev = &client->dev;
1907         struct device_node *np = client->dev.of_node;
1908
1909         if (!np) {
1910                 dev_err(dev, "No OF node\n");
1911                 return -EINVAL;
1912         }
1913
1914         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1915
1916         return 0;
1917 };
1918
1919 static int unittest_i2c_dev_remove(struct i2c_client *client)
1920 {
1921         struct device *dev = &client->dev;
1922         struct device_node *np = client->dev.of_node;
1923
1924         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1925         return 0;
1926 }
1927
1928 static const struct i2c_device_id unittest_i2c_dev_id[] = {
1929         { .name = "unittest-i2c-dev" },
1930         { }
1931 };
1932
1933 static struct i2c_driver unittest_i2c_dev_driver = {
1934         .driver = {
1935                 .name = "unittest-i2c-dev",
1936         },
1937         .probe = unittest_i2c_dev_probe,
1938         .remove = unittest_i2c_dev_remove,
1939         .id_table = unittest_i2c_dev_id,
1940 };
1941
1942 #if IS_BUILTIN(CONFIG_I2C_MUX)
1943
1944 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1945 {
1946         return 0;
1947 }
1948
1949 static int unittest_i2c_mux_probe(struct i2c_client *client,
1950                 const struct i2c_device_id *id)
1951 {
1952         int i, nchans;
1953         struct device *dev = &client->dev;
1954         struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1955         struct device_node *np = client->dev.of_node, *child;
1956         struct i2c_mux_core *muxc;
1957         u32 reg, max_reg;
1958
1959         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1960
1961         if (!np) {
1962                 dev_err(dev, "No OF node\n");
1963                 return -EINVAL;
1964         }
1965
1966         max_reg = (u32)-1;
1967         for_each_child_of_node(np, child) {
1968                 if (of_property_read_u32(child, "reg", &reg))
1969                         continue;
1970                 if (max_reg == (u32)-1 || reg > max_reg)
1971                         max_reg = reg;
1972         }
1973         nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1974         if (nchans == 0) {
1975                 dev_err(dev, "No channels\n");
1976                 return -EINVAL;
1977         }
1978
1979         muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1980                              unittest_i2c_mux_select_chan, NULL);
1981         if (!muxc)
1982                 return -ENOMEM;
1983         for (i = 0; i < nchans; i++) {
1984                 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
1985                         dev_err(dev, "Failed to register mux #%d\n", i);
1986                         i2c_mux_del_adapters(muxc);
1987                         return -ENODEV;
1988                 }
1989         }
1990
1991         i2c_set_clientdata(client, muxc);
1992
1993         return 0;
1994 };
1995
1996 static int unittest_i2c_mux_remove(struct i2c_client *client)
1997 {
1998         struct device *dev = &client->dev;
1999         struct device_node *np = client->dev.of_node;
2000         struct i2c_mux_core *muxc = i2c_get_clientdata(client);
2001
2002         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2003         i2c_mux_del_adapters(muxc);
2004         return 0;
2005 }
2006
2007 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2008         { .name = "unittest-i2c-mux" },
2009         { }
2010 };
2011
2012 static struct i2c_driver unittest_i2c_mux_driver = {
2013         .driver = {
2014                 .name = "unittest-i2c-mux",
2015         },
2016         .probe = unittest_i2c_mux_probe,
2017         .remove = unittest_i2c_mux_remove,
2018         .id_table = unittest_i2c_mux_id,
2019 };
2020
2021 #endif
2022
2023 static int of_unittest_overlay_i2c_init(void)
2024 {
2025         int ret;
2026
2027         ret = i2c_add_driver(&unittest_i2c_dev_driver);
2028         if (unittest(ret == 0,
2029                         "could not register unittest i2c device driver\n"))
2030                 return ret;
2031
2032         ret = platform_driver_register(&unittest_i2c_bus_driver);
2033         if (unittest(ret == 0,
2034                         "could not register unittest i2c bus driver\n"))
2035                 return ret;
2036
2037 #if IS_BUILTIN(CONFIG_I2C_MUX)
2038         ret = i2c_add_driver(&unittest_i2c_mux_driver);
2039         if (unittest(ret == 0,
2040                         "could not register unittest i2c mux driver\n"))
2041                 return ret;
2042 #endif
2043
2044         return 0;
2045 }
2046
2047 static void of_unittest_overlay_i2c_cleanup(void)
2048 {
2049 #if IS_BUILTIN(CONFIG_I2C_MUX)
2050         i2c_del_driver(&unittest_i2c_mux_driver);
2051 #endif
2052         platform_driver_unregister(&unittest_i2c_bus_driver);
2053         i2c_del_driver(&unittest_i2c_dev_driver);
2054 }
2055
2056 static void __init of_unittest_overlay_i2c_12(void)
2057 {
2058         /* device should enable */
2059         if (of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY))
2060                 return;
2061
2062         unittest(1, "overlay test %d passed\n", 12);
2063 }
2064
2065 /* test deactivation of device */
2066 static void __init of_unittest_overlay_i2c_13(void)
2067 {
2068         /* device should disable */
2069         if (of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY))
2070                 return;
2071
2072         unittest(1, "overlay test %d passed\n", 13);
2073 }
2074
2075 /* just check for i2c mux existence */
2076 static void of_unittest_overlay_i2c_14(void)
2077 {
2078 }
2079
2080 static void __init of_unittest_overlay_i2c_15(void)
2081 {
2082         /* device should enable */
2083         if (of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY))
2084                 return;
2085
2086         unittest(1, "overlay test %d passed\n", 15);
2087 }
2088
2089 #else
2090
2091 static inline void of_unittest_overlay_i2c_14(void) { }
2092 static inline void of_unittest_overlay_i2c_15(void) { }
2093
2094 #endif
2095
2096 static void __init of_unittest_overlay(void)
2097 {
2098         struct device_node *bus_np = NULL;
2099
2100         if (platform_driver_register(&unittest_driver)) {
2101                 unittest(0, "could not register unittest driver\n");
2102                 goto out;
2103         }
2104
2105         bus_np = of_find_node_by_path(bus_path);
2106         if (bus_np == NULL) {
2107                 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2108                 goto out;
2109         }
2110
2111         if (of_platform_default_populate(bus_np, NULL, NULL)) {
2112                 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2113                 goto out;
2114         }
2115
2116         if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2117                 unittest(0, "could not find unittest0 @ \"%s\"\n",
2118                                 unittest_path(100, PDEV_OVERLAY));
2119                 goto out;
2120         }
2121
2122         if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2123                 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2124                                 unittest_path(101, PDEV_OVERLAY));
2125                 goto out;
2126         }
2127
2128         unittest(1, "basic infrastructure of overlays passed");
2129
2130         /* tests in sequence */
2131         of_unittest_overlay_0();
2132         of_unittest_overlay_1();
2133         of_unittest_overlay_2();
2134         of_unittest_overlay_3();
2135         of_unittest_overlay_4();
2136         of_unittest_overlay_5();
2137         of_unittest_overlay_6();
2138         of_unittest_overlay_8();
2139
2140         of_unittest_overlay_10();
2141         of_unittest_overlay_11();
2142
2143 #if IS_BUILTIN(CONFIG_I2C)
2144         if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2145                 goto out;
2146
2147         of_unittest_overlay_i2c_12();
2148         of_unittest_overlay_i2c_13();
2149         of_unittest_overlay_i2c_14();
2150         of_unittest_overlay_i2c_15();
2151
2152         of_unittest_overlay_i2c_cleanup();
2153 #endif
2154
2155         of_unittest_destroy_tracked_overlays();
2156
2157 out:
2158         of_node_put(bus_np);
2159 }
2160
2161 #else
2162 static inline void __init of_unittest_overlay(void) { }
2163 #endif
2164
2165 #ifdef CONFIG_OF_OVERLAY
2166
2167 /*
2168  * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2169  * in scripts/Makefile.lib
2170  */
2171
2172 #define OVERLAY_INFO_EXTERN(name) \
2173         extern uint8_t __dtb_##name##_begin[]; \
2174         extern uint8_t __dtb_##name##_end[]
2175
2176 #define OVERLAY_INFO(overlay_name, expected)             \
2177 {       .dtb_begin       = __dtb_##overlay_name##_begin, \
2178         .dtb_end         = __dtb_##overlay_name##_end,   \
2179         .expected_result = expected,                     \
2180         .name            = #overlay_name,                \
2181 }
2182
2183 struct overlay_info {
2184         uint8_t         *dtb_begin;
2185         uint8_t         *dtb_end;
2186         int             expected_result;
2187         int             overlay_id;
2188         char            *name;
2189 };
2190
2191 OVERLAY_INFO_EXTERN(overlay_base);
2192 OVERLAY_INFO_EXTERN(overlay);
2193 OVERLAY_INFO_EXTERN(overlay_0);
2194 OVERLAY_INFO_EXTERN(overlay_1);
2195 OVERLAY_INFO_EXTERN(overlay_2);
2196 OVERLAY_INFO_EXTERN(overlay_3);
2197 OVERLAY_INFO_EXTERN(overlay_4);
2198 OVERLAY_INFO_EXTERN(overlay_5);
2199 OVERLAY_INFO_EXTERN(overlay_6);
2200 OVERLAY_INFO_EXTERN(overlay_7);
2201 OVERLAY_INFO_EXTERN(overlay_8);
2202 OVERLAY_INFO_EXTERN(overlay_9);
2203 OVERLAY_INFO_EXTERN(overlay_10);
2204 OVERLAY_INFO_EXTERN(overlay_11);
2205 OVERLAY_INFO_EXTERN(overlay_12);
2206 OVERLAY_INFO_EXTERN(overlay_13);
2207 OVERLAY_INFO_EXTERN(overlay_15);
2208 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2209 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2210
2211 /* order of entries is hard-coded into users of overlays[] */
2212 static struct overlay_info overlays[] = {
2213         OVERLAY_INFO(overlay_base, -9999),
2214         OVERLAY_INFO(overlay, 0),
2215         OVERLAY_INFO(overlay_0, 0),
2216         OVERLAY_INFO(overlay_1, 0),
2217         OVERLAY_INFO(overlay_2, 0),
2218         OVERLAY_INFO(overlay_3, 0),
2219         OVERLAY_INFO(overlay_4, 0),
2220         OVERLAY_INFO(overlay_5, 0),
2221         OVERLAY_INFO(overlay_6, 0),
2222         OVERLAY_INFO(overlay_7, 0),
2223         OVERLAY_INFO(overlay_8, 0),
2224         OVERLAY_INFO(overlay_9, 0),
2225         OVERLAY_INFO(overlay_10, 0),
2226         OVERLAY_INFO(overlay_11, 0),
2227         OVERLAY_INFO(overlay_12, 0),
2228         OVERLAY_INFO(overlay_13, 0),
2229         OVERLAY_INFO(overlay_15, 0),
2230         OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2231         OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2232         {}
2233 };
2234
2235 static struct device_node *overlay_base_root;
2236
2237 static void * __init dt_alloc_memory(u64 size, u64 align)
2238 {
2239         return memblock_virt_alloc(size, align);
2240 }
2241
2242 /*
2243  * Create base device tree for the overlay unittest.
2244  *
2245  * This is called from very early boot code.
2246  *
2247  * Do as much as possible the same way as done in __unflatten_device_tree
2248  * and other early boot steps for the normal FDT so that the overlay base
2249  * unflattened tree will have the same characteristics as the real tree
2250  * (such as having memory allocated by the early allocator).  The goal
2251  * is to test "the real thing" as much as possible, and test "test setup
2252  * code" as little as possible.
2253  *
2254  * Have to stop before resolving phandles, because that uses kmalloc.
2255  */
2256 void __init unittest_unflatten_overlay_base(void)
2257 {
2258         struct overlay_info *info;
2259         u32 data_size;
2260         void *new_fdt;
2261         u32 size;
2262
2263         info = &overlays[0];
2264
2265         if (info->expected_result != -9999) {
2266                 pr_err("No dtb 'overlay_base' to attach\n");
2267                 return;
2268         }
2269
2270         data_size = info->dtb_end - info->dtb_begin;
2271         if (!data_size) {
2272                 pr_err("No dtb 'overlay_base' to attach\n");
2273                 return;
2274         }
2275
2276         size = fdt_totalsize(info->dtb_begin);
2277         if (size != data_size) {
2278                 pr_err("dtb 'overlay_base' header totalsize != actual size");
2279                 return;
2280         }
2281
2282         new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2283         if (!new_fdt) {
2284                 pr_err("alloc for dtb 'overlay_base' failed");
2285                 return;
2286         }
2287
2288         memcpy(new_fdt, info->dtb_begin, size);
2289
2290         __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2291                                 dt_alloc_memory, true);
2292 }
2293
2294 /*
2295  * The purpose of of_unittest_overlay_data_add is to add an
2296  * overlay in the normal fashion.  This is a test of the whole
2297  * picture, instead of testing individual elements.
2298  *
2299  * A secondary purpose is to be able to verify that the contents of
2300  * /proc/device-tree/ contains the updated structure and values from
2301  * the overlay.  That must be verified separately in user space.
2302  *
2303  * Return 0 on unexpected error.
2304  */
2305 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2306 {
2307         struct overlay_info *info;
2308         int found = 0;
2309         int k;
2310         int ret;
2311         u32 size;
2312
2313         for (k = 0, info = overlays; info && info->name; info++, k++) {
2314                 if (!strcmp(overlay_name, info->name)) {
2315                         found = 1;
2316                         break;
2317                 }
2318         }
2319         if (!found) {
2320                 pr_err("no overlay data for %s\n", overlay_name);
2321                 return 0;
2322         }
2323
2324         size = info->dtb_end - info->dtb_begin;
2325         if (!size)
2326                 pr_err("no overlay data for %s\n", overlay_name);
2327
2328         ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2329         if (overlay_id)
2330                 *overlay_id = info->overlay_id;
2331         if (ret < 0)
2332                 goto out;
2333
2334         pr_debug("%s applied\n", overlay_name);
2335
2336 out:
2337         if (ret != info->expected_result)
2338                 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2339                        info->expected_result, ret, overlay_name);
2340
2341         return (ret == info->expected_result);
2342 }
2343
2344 /*
2345  * The purpose of of_unittest_overlay_high_level is to add an overlay
2346  * in the normal fashion.  This is a test of the whole picture,
2347  * instead of individual elements.
2348  *
2349  * The first part of the function is _not_ normal overlay usage; it is
2350  * finishing splicing the base overlay device tree into the live tree.
2351  */
2352 static __init void of_unittest_overlay_high_level(void)
2353 {
2354         struct device_node *last_sibling;
2355         struct device_node *np;
2356         struct device_node *of_symbols;
2357         struct device_node *overlay_base_symbols;
2358         struct device_node **pprev;
2359         struct property *prop;
2360
2361         if (!overlay_base_root) {
2362                 unittest(0, "overlay_base_root not initialized\n");
2363                 return;
2364         }
2365
2366         /*
2367          * Could not fixup phandles in unittest_unflatten_overlay_base()
2368          * because kmalloc() was not yet available.
2369          */
2370         of_overlay_mutex_lock();
2371         of_resolve_phandles(overlay_base_root);
2372         of_overlay_mutex_unlock();
2373
2374
2375         /*
2376          * do not allow overlay_base to duplicate any node already in
2377          * tree, this greatly simplifies the code
2378          */
2379
2380         /*
2381          * remove overlay_base_root node "__local_fixups", after
2382          * being used by of_resolve_phandles()
2383          */
2384         pprev = &overlay_base_root->child;
2385         for (np = overlay_base_root->child; np; np = np->sibling) {
2386                 if (!of_node_cmp(np->name, "__local_fixups__")) {
2387                         *pprev = np->sibling;
2388                         break;
2389                 }
2390                 pprev = &np->sibling;
2391         }
2392
2393         /* remove overlay_base_root node "__symbols__" if in live tree */
2394         of_symbols = of_get_child_by_name(of_root, "__symbols__");
2395         if (of_symbols) {
2396                 /* will have to graft properties from node into live tree */
2397                 pprev = &overlay_base_root->child;
2398                 for (np = overlay_base_root->child; np; np = np->sibling) {
2399                         if (!of_node_cmp(np->name, "__symbols__")) {
2400                                 overlay_base_symbols = np;
2401                                 *pprev = np->sibling;
2402                                 break;
2403                         }
2404                         pprev = &np->sibling;
2405                 }
2406         }
2407
2408         for (np = overlay_base_root->child; np; np = np->sibling) {
2409                 if (of_get_child_by_name(of_root, np->name)) {
2410                         unittest(0, "illegal node name in overlay_base %s",
2411                                 np->name);
2412                         return;
2413                 }
2414         }
2415
2416         /*
2417          * overlay 'overlay_base' is not allowed to have root
2418          * properties, so only need to splice nodes into main device tree.
2419          *
2420          * root node of *overlay_base_root will not be freed, it is lost
2421          * memory.
2422          */
2423
2424         for (np = overlay_base_root->child; np; np = np->sibling)
2425                 np->parent = of_root;
2426
2427         mutex_lock(&of_mutex);
2428
2429         for (last_sibling = np = of_root->child; np; np = np->sibling)
2430                 last_sibling = np;
2431
2432         if (last_sibling)
2433                 last_sibling->sibling = overlay_base_root->child;
2434         else
2435                 of_root->child = overlay_base_root->child;
2436
2437         for_each_of_allnodes_from(overlay_base_root, np)
2438                 __of_attach_node_sysfs(np);
2439
2440         if (of_symbols) {
2441                 struct property *new_prop;
2442                 for_each_property_of_node(overlay_base_symbols, prop) {
2443
2444                         new_prop = __of_prop_dup(prop, GFP_KERNEL);
2445                         if (!new_prop) {
2446                                 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
2447                                          prop->name);
2448                                 goto err_unlock;
2449                         }
2450                         if (__of_add_property(of_symbols, new_prop)) {
2451                                 kfree(new_prop->name);
2452                                 kfree(new_prop->value);
2453                                 kfree(new_prop);
2454                                 /* "name" auto-generated by unflatten */
2455                                 if (!strcmp(prop->name, "name"))
2456                                         continue;
2457                                 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
2458                                          prop->name);
2459                                 goto err_unlock;
2460                         }
2461                         if (__of_add_property_sysfs(of_symbols, new_prop)) {
2462                                 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2463                                          prop->name);
2464                                 goto err_unlock;
2465                         }
2466                 }
2467         }
2468
2469         mutex_unlock(&of_mutex);
2470
2471
2472         /* now do the normal overlay usage test */
2473
2474         unittest(overlay_data_apply("overlay", NULL),
2475                  "Adding overlay 'overlay' failed\n");
2476
2477         unittest(overlay_data_apply("overlay_bad_phandle", NULL),
2478                  "Adding overlay 'overlay_bad_phandle' failed\n");
2479
2480         unittest(overlay_data_apply("overlay_bad_symbol", NULL),
2481                  "Adding overlay 'overlay_bad_symbol' failed\n");
2482
2483         return;
2484
2485 err_unlock:
2486         mutex_unlock(&of_mutex);
2487 }
2488
2489 #else
2490
2491 static inline __init void of_unittest_overlay_high_level(void) {}
2492
2493 #endif
2494
2495 static int __init of_unittest(void)
2496 {
2497         struct device_node *np;
2498         int res;
2499
2500         /* adding data for unittest */
2501         res = unittest_data_add();
2502         if (res)
2503                 return res;
2504         if (!of_aliases)
2505                 of_aliases = of_find_node_by_path("/aliases");
2506
2507         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2508         if (!np) {
2509                 pr_info("No testcase data in device tree; not running tests\n");
2510                 return 0;
2511         }
2512         of_node_put(np);
2513
2514         pr_info("start of unittest - you will see error messages\n");
2515         of_unittest_check_tree_linkage();
2516         of_unittest_check_phandles();
2517         of_unittest_find_node_by_name();
2518         of_unittest_dynamic();
2519         of_unittest_parse_phandle_with_args();
2520         of_unittest_parse_phandle_with_args_map();
2521         of_unittest_printf();
2522         of_unittest_property_string();
2523         of_unittest_property_copy();
2524         of_unittest_changeset();
2525         of_unittest_parse_interrupts();
2526         of_unittest_parse_interrupts_extended();
2527         of_unittest_match_node();
2528         of_unittest_platform_populate();
2529         of_unittest_overlay();
2530
2531         /* Double check linkage after removing testcase data */
2532         of_unittest_check_tree_linkage();
2533
2534         of_unittest_overlay_high_level();
2535
2536         pr_info("end of unittest - %i passed, %i failed\n",
2537                 unittest_results.passed, unittest_results.failed);
2538
2539         return 0;
2540 }
2541 late_initcall(of_unittest);