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