drivers/of/unittest.c

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