drivers/of/unittest.c

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