drivers/of/unittest.c

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