2 * Self tests for device tree subsystem
5 #define pr_fmt(fmt) "### dt-test ### " fmt
9 #include <linux/errno.h>
10 #include <linux/hashtable.h>
11 #include <linux/libfdt.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>
22 #include <linux/i2c.h>
23 #include <linux/i2c-mux.h>
25 #include <linux/bitops.h>
27 #include "of_private.h"
29 static struct unittest_results {
34 #define unittest(result, fmt, ...) ({ \
35 bool failed = !(result); \
37 unittest_results.failed++; \
38 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
40 unittest_results.passed++; \
41 pr_debug("pass %s():%i\n", __func__, __LINE__); \
46 static void __init of_unittest_find_node_by_name(void)
48 struct device_node *np;
51 np = of_find_node_by_path("/testcase-data");
52 unittest(np && !strcmp("/testcase-data", np->full_name),
53 "find /testcase-data failed\n");
56 /* Test if trailing '/' works */
57 np = of_find_node_by_path("/testcase-data/");
58 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
60 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
61 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
62 "find /testcase-data/phandle-tests/consumer-a failed\n");
65 np = of_find_node_by_path("testcase-alias");
66 unittest(np && !strcmp("/testcase-data", np->full_name),
67 "find testcase-alias failed\n");
70 /* Test if trailing '/' works on aliases */
71 np = of_find_node_by_path("testcase-alias/");
72 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
74 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
75 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
76 "find testcase-alias/phandle-tests/consumer-a failed\n");
79 np = of_find_node_by_path("/testcase-data/missing-path");
80 unittest(!np, "non-existent path returned node %s\n", np->full_name);
83 np = of_find_node_by_path("missing-alias");
84 unittest(!np, "non-existent alias returned node %s\n", np->full_name);
87 np = of_find_node_by_path("testcase-alias/missing-path");
88 unittest(!np, "non-existent alias with relative path returned node %s\n", np->full_name);
91 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
92 unittest(np && !strcmp("testoption", options),
93 "option path test failed\n");
96 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
97 unittest(np && !strcmp("test/option", options),
98 "option path test, subcase #1 failed\n");
101 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
102 unittest(np && !strcmp("test/option", options),
103 "option path test, subcase #2 failed\n");
106 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
107 unittest(np, "NULL option path test failed\n");
110 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
112 unittest(np && !strcmp("testaliasoption", options),
113 "option alias path test failed\n");
116 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
118 unittest(np && !strcmp("test/alias/option", options),
119 "option alias path test, subcase #1 failed\n");
122 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
123 unittest(np, "NULL option alias path test failed\n");
126 options = "testoption";
127 np = of_find_node_opts_by_path("testcase-alias", &options);
128 unittest(np && !options, "option clearing test failed\n");
131 options = "testoption";
132 np = of_find_node_opts_by_path("/", &options);
133 unittest(np && !options, "option clearing root node test failed\n");
137 static void __init of_unittest_dynamic(void)
139 struct device_node *np;
140 struct property *prop;
142 np = of_find_node_by_path("/testcase-data");
144 pr_err("missing testcase data\n");
148 /* Array of 4 properties for the purpose of testing */
149 prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL);
151 unittest(0, "kzalloc() failed\n");
155 /* Add a new property - should pass*/
156 prop->name = "new-property";
157 prop->value = "new-property-data";
158 prop->length = strlen(prop->value);
159 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
161 /* Try to add an existing property - should fail */
163 prop->name = "new-property";
164 prop->value = "new-property-data-should-fail";
165 prop->length = strlen(prop->value);
166 unittest(of_add_property(np, prop) != 0,
167 "Adding an existing property should have failed\n");
169 /* Try to modify an existing property - should pass */
170 prop->value = "modify-property-data-should-pass";
171 prop->length = strlen(prop->value);
172 unittest(of_update_property(np, prop) == 0,
173 "Updating an existing property should have passed\n");
175 /* Try to modify non-existent property - should pass*/
177 prop->name = "modify-property";
178 prop->value = "modify-missing-property-data-should-pass";
179 prop->length = strlen(prop->value);
180 unittest(of_update_property(np, prop) == 0,
181 "Updating a missing property should have passed\n");
183 /* Remove property - should pass */
184 unittest(of_remove_property(np, prop) == 0,
185 "Removing a property should have passed\n");
187 /* Adding very large property - should pass */
189 prop->name = "large-property-PAGE_SIZEx8";
190 prop->length = PAGE_SIZE * 8;
191 prop->value = kzalloc(prop->length, GFP_KERNEL);
192 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
194 unittest(of_add_property(np, prop) == 0,
195 "Adding a large property should have passed\n");
198 static int __init of_unittest_check_node_linkage(struct device_node *np)
200 struct device_node *child;
203 for_each_child_of_node(np, child) {
204 if (child->parent != np) {
205 pr_err("Child node %s links to wrong parent %s\n",
206 child->name, np->name);
211 rc = of_unittest_check_node_linkage(child);
223 static void __init of_unittest_check_tree_linkage(void)
225 struct device_node *np;
226 int allnode_count = 0, child_count;
231 for_each_of_allnodes(np)
233 child_count = of_unittest_check_node_linkage(of_root);
235 unittest(child_count > 0, "Device node data structure is corrupted\n");
236 unittest(child_count == allnode_count,
237 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
238 allnode_count, child_count);
239 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
243 struct hlist_node node;
244 struct device_node *np;
247 static DEFINE_HASHTABLE(phandle_ht, 8);
248 static void __init of_unittest_check_phandles(void)
250 struct device_node *np;
251 struct node_hash *nh;
252 struct hlist_node *tmp;
253 int i, dup_count = 0, phandle_count = 0;
255 for_each_of_allnodes(np) {
259 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
260 if (nh->np->phandle == np->phandle) {
261 pr_info("Duplicate phandle! %i used by %s and %s\n",
262 np->phandle, nh->np->full_name, np->full_name);
268 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
273 hash_add(phandle_ht, &nh->node, np->phandle);
276 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
277 dup_count, phandle_count);
280 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
286 static void __init of_unittest_parse_phandle_with_args(void)
288 struct device_node *np;
289 struct of_phandle_args args;
292 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
294 pr_err("missing testcase data\n");
298 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
299 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
301 for (i = 0; i < 8; i++) {
304 rc = of_parse_phandle_with_args(np, "phandle-list",
305 "#phandle-cells", i, &args);
307 /* Test the values from tests-phandle.dtsi */
311 passed &= (args.args_count == 1);
312 passed &= (args.args[0] == (i + 1));
316 passed &= (args.args_count == 2);
317 passed &= (args.args[0] == (i + 1));
318 passed &= (args.args[1] == 0);
321 passed &= (rc == -ENOENT);
325 passed &= (args.args_count == 3);
326 passed &= (args.args[0] == (i + 1));
327 passed &= (args.args[1] == 4);
328 passed &= (args.args[2] == 3);
332 passed &= (args.args_count == 2);
333 passed &= (args.args[0] == (i + 1));
334 passed &= (args.args[1] == 100);
338 passed &= (args.args_count == 0);
342 passed &= (args.args_count == 1);
343 passed &= (args.args[0] == (i + 1));
346 passed &= (rc == -ENOENT);
352 unittest(passed, "index %i - data error on node %s rc=%i\n",
353 i, args.np->full_name, rc);
356 /* Check for missing list property */
357 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
358 "#phandle-cells", 0, &args);
359 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
360 rc = of_count_phandle_with_args(np, "phandle-list-missing",
362 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
364 /* Check for missing cells property */
365 rc = of_parse_phandle_with_args(np, "phandle-list",
366 "#phandle-cells-missing", 0, &args);
367 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
368 rc = of_count_phandle_with_args(np, "phandle-list",
369 "#phandle-cells-missing");
370 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
372 /* Check for bad phandle in list */
373 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
374 "#phandle-cells", 0, &args);
375 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
376 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
378 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
380 /* Check for incorrectly formed argument list */
381 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
382 "#phandle-cells", 1, &args);
383 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
384 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
386 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
389 static void __init of_unittest_property_string(void)
391 const char *strings[4];
392 struct device_node *np;
395 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
397 pr_err("No testcase data in device tree\n");
401 rc = of_property_match_string(np, "phandle-list-names", "first");
402 unittest(rc == 0, "first expected:0 got:%i\n", rc);
403 rc = of_property_match_string(np, "phandle-list-names", "second");
404 unittest(rc == 1, "second expected:1 got:%i\n", rc);
405 rc = of_property_match_string(np, "phandle-list-names", "third");
406 unittest(rc == 2, "third expected:2 got:%i\n", rc);
407 rc = of_property_match_string(np, "phandle-list-names", "fourth");
408 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
409 rc = of_property_match_string(np, "missing-property", "blah");
410 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
411 rc = of_property_match_string(np, "empty-property", "blah");
412 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
413 rc = of_property_match_string(np, "unterminated-string", "blah");
414 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
416 /* of_property_count_strings() tests */
417 rc = of_property_count_strings(np, "string-property");
418 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
419 rc = of_property_count_strings(np, "phandle-list-names");
420 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
421 rc = of_property_count_strings(np, "unterminated-string");
422 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
423 rc = of_property_count_strings(np, "unterminated-string-list");
424 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
426 /* of_property_read_string_index() tests */
427 rc = of_property_read_string_index(np, "string-property", 0, strings);
428 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
430 rc = of_property_read_string_index(np, "string-property", 1, strings);
431 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
432 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
433 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
434 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
435 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
436 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
437 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
439 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
440 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
442 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
443 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
444 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
445 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
447 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
448 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
451 /* of_property_read_string_array() tests */
452 rc = of_property_read_string_array(np, "string-property", strings, 4);
453 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
454 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
455 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
456 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
457 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
458 /* -- An incorrectly formed string should cause a failure */
459 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
460 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
461 /* -- parsing the correctly formed strings should still work: */
463 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
464 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
466 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
467 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
470 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
471 (p1)->value && (p2)->value && \
472 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
473 !strcmp((p1)->name, (p2)->name))
474 static void __init of_unittest_property_copy(void)
476 #ifdef CONFIG_OF_DYNAMIC
477 struct property p1 = { .name = "p1", .length = 0, .value = "" };
478 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
479 struct property *new;
481 new = __of_prop_dup(&p1, GFP_KERNEL);
482 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
487 new = __of_prop_dup(&p2, GFP_KERNEL);
488 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
495 static void __init of_unittest_changeset(void)
497 #ifdef CONFIG_OF_DYNAMIC
498 struct property *ppadd, padd = { .name = "prop-add", .length = 0, .value = "" };
499 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
500 struct property *ppremove;
501 struct device_node *n1, *n2, *n21, *nremove, *parent, *np;
502 struct of_changeset chgset;
504 n1 = __of_node_dup(NULL, "/testcase-data/changeset/n1");
505 unittest(n1, "testcase setup failure\n");
506 n2 = __of_node_dup(NULL, "/testcase-data/changeset/n2");
507 unittest(n2, "testcase setup failure\n");
508 n21 = __of_node_dup(NULL, "%s/%s", "/testcase-data/changeset/n2", "n21");
509 unittest(n21, "testcase setup failure %p\n", n21);
510 nremove = of_find_node_by_path("/testcase-data/changeset/node-remove");
511 unittest(nremove, "testcase setup failure\n");
512 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
513 unittest(ppadd, "testcase setup failure\n");
514 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
515 unittest(ppupdate, "testcase setup failure\n");
516 parent = nremove->parent;
521 ppremove = of_find_property(parent, "prop-remove", NULL);
522 unittest(ppremove, "failed to find removal prop");
524 of_changeset_init(&chgset);
525 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
526 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
527 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
528 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
529 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop\n");
530 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
531 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
532 unittest(!of_changeset_apply(&chgset), "apply failed\n");
534 /* Make sure node names are constructed correctly */
535 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
536 "'%s' not added\n", n21->full_name);
539 unittest(!of_changeset_revert(&chgset), "revert failed\n");
541 of_changeset_destroy(&chgset);
545 static void __init of_unittest_parse_interrupts(void)
547 struct device_node *np;
548 struct of_phandle_args args;
551 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
553 pr_err("missing testcase data\n");
557 for (i = 0; i < 4; i++) {
561 rc = of_irq_parse_one(np, i, &args);
564 passed &= (args.args_count == 1);
565 passed &= (args.args[0] == (i + 1));
567 unittest(passed, "index %i - data error on node %s rc=%i\n",
568 i, args.np->full_name, rc);
572 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
574 pr_err("missing testcase data\n");
578 for (i = 0; i < 4; i++) {
582 rc = of_irq_parse_one(np, i, &args);
584 /* Test the values from tests-phandle.dtsi */
588 passed &= (args.args_count == 1);
589 passed &= (args.args[0] == 9);
593 passed &= (args.args_count == 3);
594 passed &= (args.args[0] == 10);
595 passed &= (args.args[1] == 11);
596 passed &= (args.args[2] == 12);
600 passed &= (args.args_count == 2);
601 passed &= (args.args[0] == 13);
602 passed &= (args.args[1] == 14);
606 passed &= (args.args_count == 2);
607 passed &= (args.args[0] == 15);
608 passed &= (args.args[1] == 16);
613 unittest(passed, "index %i - data error on node %s rc=%i\n",
614 i, args.np->full_name, rc);
619 static void __init of_unittest_parse_interrupts_extended(void)
621 struct device_node *np;
622 struct of_phandle_args args;
625 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
627 pr_err("missing testcase data\n");
631 for (i = 0; i < 7; i++) {
634 rc = of_irq_parse_one(np, i, &args);
636 /* Test the values from tests-phandle.dtsi */
640 passed &= (args.args_count == 1);
641 passed &= (args.args[0] == 1);
645 passed &= (args.args_count == 3);
646 passed &= (args.args[0] == 2);
647 passed &= (args.args[1] == 3);
648 passed &= (args.args[2] == 4);
652 passed &= (args.args_count == 2);
653 passed &= (args.args[0] == 5);
654 passed &= (args.args[1] == 6);
658 passed &= (args.args_count == 1);
659 passed &= (args.args[0] == 9);
663 passed &= (args.args_count == 3);
664 passed &= (args.args[0] == 10);
665 passed &= (args.args[1] == 11);
666 passed &= (args.args[2] == 12);
670 passed &= (args.args_count == 2);
671 passed &= (args.args[0] == 13);
672 passed &= (args.args[1] == 14);
676 passed &= (args.args_count == 1);
677 passed &= (args.args[0] == 15);
683 unittest(passed, "index %i - data error on node %s rc=%i\n",
684 i, args.np->full_name, rc);
689 static const struct of_device_id match_node_table[] = {
690 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
691 { .data = "B", .type = "type1", }, /* followed by type alone */
693 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
694 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
695 { .data = "Cc", .name = "name2", .type = "type2", },
697 { .data = "E", .compatible = "compat3" },
698 { .data = "G", .compatible = "compat2", },
699 { .data = "H", .compatible = "compat2", .name = "name5", },
700 { .data = "I", .compatible = "compat2", .type = "type1", },
701 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
702 { .data = "K", .compatible = "compat2", .name = "name9", },
709 } match_node_tests[] = {
710 { .path = "/testcase-data/match-node/name0", .data = "A", },
711 { .path = "/testcase-data/match-node/name1", .data = "B", },
712 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
713 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
714 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
715 { .path = "/testcase-data/match-node/name3", .data = "E", },
716 { .path = "/testcase-data/match-node/name4", .data = "G", },
717 { .path = "/testcase-data/match-node/name5", .data = "H", },
718 { .path = "/testcase-data/match-node/name6", .data = "G", },
719 { .path = "/testcase-data/match-node/name7", .data = "I", },
720 { .path = "/testcase-data/match-node/name8", .data = "J", },
721 { .path = "/testcase-data/match-node/name9", .data = "K", },
724 static void __init of_unittest_match_node(void)
726 struct device_node *np;
727 const struct of_device_id *match;
730 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
731 np = of_find_node_by_path(match_node_tests[i].path);
733 unittest(0, "missing testcase node %s\n",
734 match_node_tests[i].path);
738 match = of_match_node(match_node_table, np);
740 unittest(0, "%s didn't match anything\n",
741 match_node_tests[i].path);
745 if (strcmp(match->data, match_node_tests[i].data) != 0) {
746 unittest(0, "%s got wrong match. expected %s, got %s\n",
747 match_node_tests[i].path, match_node_tests[i].data,
748 (const char *)match->data);
751 unittest(1, "passed");
755 static struct resource test_bus_res = {
758 .flags = IORESOURCE_MEM,
760 static const struct platform_device_info test_bus_info = {
761 .name = "unittest-bus",
763 static void __init of_unittest_platform_populate(void)
766 struct device_node *np, *child, *grandchild;
767 struct platform_device *pdev, *test_bus;
768 const struct of_device_id match[] = {
769 { .compatible = "test-device", },
773 np = of_find_node_by_path("/testcase-data");
774 of_platform_default_populate(np, NULL, NULL);
776 /* Test that a missing irq domain returns -EPROBE_DEFER */
777 np = of_find_node_by_path("/testcase-data/testcase-device1");
778 pdev = of_find_device_by_node(np);
779 unittest(pdev, "device 1 creation failed\n");
781 irq = platform_get_irq(pdev, 0);
782 unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq);
784 /* Test that a parsing failure does not return -EPROBE_DEFER */
785 np = of_find_node_by_path("/testcase-data/testcase-device2");
786 pdev = of_find_device_by_node(np);
787 unittest(pdev, "device 2 creation failed\n");
788 irq = platform_get_irq(pdev, 0);
789 unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq);
791 np = of_find_node_by_path("/testcase-data/platform-tests");
792 unittest(np, "No testcase data in device tree\n");
796 test_bus = platform_device_register_full(&test_bus_info);
797 rc = PTR_ERR_OR_ZERO(test_bus);
798 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
801 test_bus->dev.of_node = np;
804 * Add a dummy resource to the test bus node after it is
805 * registered to catch problems with un-inserted resources. The
806 * DT code doesn't insert the resources, and it has caused the
807 * kernel to oops in the past. This makes sure the same bug
808 * doesn't crop up again.
810 platform_device_add_resources(test_bus, &test_bus_res, 1);
812 of_platform_populate(np, match, NULL, &test_bus->dev);
813 for_each_child_of_node(np, child) {
814 for_each_child_of_node(child, grandchild)
815 unittest(of_find_device_by_node(grandchild),
816 "Could not create device for node '%s'\n",
820 of_platform_depopulate(&test_bus->dev);
821 for_each_child_of_node(np, child) {
822 for_each_child_of_node(child, grandchild)
823 unittest(!of_find_device_by_node(grandchild),
824 "device didn't get destroyed '%s'\n",
828 platform_device_unregister(test_bus);
833 * update_node_properties - adds the properties
834 * of np into dup node (present in live tree) and
835 * updates parent of children of np to dup.
837 * @np: node already present in live tree
838 * @dup: node present in live tree to be updated
840 static void update_node_properties(struct device_node *np,
841 struct device_node *dup)
843 struct property *prop;
844 struct device_node *child;
846 for_each_property_of_node(np, prop)
847 of_add_property(dup, prop);
849 for_each_child_of_node(np, child)
854 * attach_node_and_children - attaches nodes
855 * and its children to live tree
857 * @np: Node to attach to live tree
859 static int attach_node_and_children(struct device_node *np)
861 struct device_node *next, *dup, *child;
864 dup = of_find_node_by_path(np->full_name);
866 update_node_properties(np, dup);
873 mutex_lock(&of_mutex);
874 raw_spin_lock_irqsave(&devtree_lock, flags);
875 np->sibling = np->parent->child;
876 np->parent->child = np;
877 of_node_clear_flag(np, OF_DETACHED);
878 raw_spin_unlock_irqrestore(&devtree_lock, flags);
880 __of_attach_node_sysfs(np);
881 mutex_unlock(&of_mutex);
884 next = child->sibling;
885 attach_node_and_children(child);
893 * unittest_data_add - Reads, copies data from
894 * linked tree and attaches it to the live tree
896 static int __init unittest_data_add(void)
899 struct device_node *unittest_data_node, *np;
901 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
902 * created by cmd_dt_S_dtb in scripts/Makefile.lib
904 extern uint8_t __dtb_testcases_begin[];
905 extern uint8_t __dtb_testcases_end[];
906 const int size = __dtb_testcases_end - __dtb_testcases_begin;
910 pr_warn("%s: No testcase data to attach; not running tests\n",
916 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
918 if (!unittest_data) {
919 pr_warn("%s: Failed to allocate memory for unittest_data; "
920 "not running tests\n", __func__);
923 of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
924 if (!unittest_data_node) {
925 pr_warn("%s: No tree to attach; not running tests\n", __func__);
928 of_node_set_flag(unittest_data_node, OF_DETACHED);
929 rc = of_resolve_phandles(unittest_data_node);
931 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
936 of_root = unittest_data_node;
937 for_each_of_allnodes(np)
938 __of_attach_node_sysfs(np);
939 of_aliases = of_find_node_by_path("/aliases");
940 of_chosen = of_find_node_by_path("/chosen");
944 /* attach the sub-tree to live tree */
945 np = unittest_data_node->child;
947 struct device_node *next = np->sibling;
949 np->parent = of_root;
950 attach_node_and_children(np);
956 #ifdef CONFIG_OF_OVERLAY
958 static int unittest_probe(struct platform_device *pdev)
960 struct device *dev = &pdev->dev;
961 struct device_node *np = dev->of_node;
964 dev_err(dev, "No OF data for device\n");
969 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
971 of_platform_populate(np, NULL, NULL, &pdev->dev);
976 static int unittest_remove(struct platform_device *pdev)
978 struct device *dev = &pdev->dev;
979 struct device_node *np = dev->of_node;
981 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
985 static const struct of_device_id unittest_match[] = {
986 { .compatible = "unittest", },
990 static struct platform_driver unittest_driver = {
991 .probe = unittest_probe,
992 .remove = unittest_remove,
995 .of_match_table = of_match_ptr(unittest_match),
999 /* get the platform device instantiated at the path */
1000 static struct platform_device *of_path_to_platform_device(const char *path)
1002 struct device_node *np;
1003 struct platform_device *pdev;
1005 np = of_find_node_by_path(path);
1009 pdev = of_find_device_by_node(np);
1015 /* find out if a platform device exists at that path */
1016 static int of_path_platform_device_exists(const char *path)
1018 struct platform_device *pdev;
1020 pdev = of_path_to_platform_device(path);
1021 platform_device_put(pdev);
1022 return pdev != NULL;
1025 #if IS_BUILTIN(CONFIG_I2C)
1027 /* get the i2c client device instantiated at the path */
1028 static struct i2c_client *of_path_to_i2c_client(const char *path)
1030 struct device_node *np;
1031 struct i2c_client *client;
1033 np = of_find_node_by_path(path);
1037 client = of_find_i2c_device_by_node(np);
1043 /* find out if a i2c client device exists at that path */
1044 static int of_path_i2c_client_exists(const char *path)
1046 struct i2c_client *client;
1048 client = of_path_to_i2c_client(path);
1050 put_device(&client->dev);
1051 return client != NULL;
1054 static int of_path_i2c_client_exists(const char *path)
1065 static int of_path_device_type_exists(const char *path,
1066 enum overlay_type ovtype)
1070 return of_path_platform_device_exists(path);
1072 return of_path_i2c_client_exists(path);
1077 static const char *unittest_path(int nr, enum overlay_type ovtype)
1080 static char buf[256];
1084 base = "/testcase-data/overlay-node/test-bus";
1087 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1093 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1094 buf[sizeof(buf) - 1] = '\0';
1098 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1102 path = unittest_path(unittest_nr, ovtype);
1106 return of_path_platform_device_exists(path);
1108 return of_path_i2c_client_exists(path);
1113 static const char *overlay_path(int nr)
1115 static char buf[256];
1117 snprintf(buf, sizeof(buf) - 1,
1118 "/testcase-data/overlay%d", nr);
1119 buf[sizeof(buf) - 1] = '\0';
1124 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1126 /* it is guaranteed that overlay ids are assigned in sequence */
1127 #define MAX_UNITTEST_OVERLAYS 256
1128 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1129 static int overlay_first_id = -1;
1131 static void of_unittest_track_overlay(int id)
1133 if (overlay_first_id < 0)
1134 overlay_first_id = id;
1135 id -= overlay_first_id;
1137 /* we shouldn't need that many */
1138 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1139 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1142 static void of_unittest_untrack_overlay(int id)
1144 if (overlay_first_id < 0)
1146 id -= overlay_first_id;
1147 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1148 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1151 static void of_unittest_destroy_tracked_overlays(void)
1153 int id, ret, defers;
1155 if (overlay_first_id < 0)
1158 /* try until no defers */
1161 /* remove in reverse order */
1162 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1163 if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1166 ret = of_overlay_destroy(id + overlay_first_id);
1167 if (ret == -ENODEV) {
1168 pr_warn("%s: no overlay to destroy for #%d\n",
1169 __func__, id + overlay_first_id);
1174 pr_warn("%s: overlay destroy failed for #%d\n",
1175 __func__, id + overlay_first_id);
1179 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1181 } while (defers > 0);
1184 static int of_unittest_apply_overlay(int overlay_nr, int unittest_nr,
1187 struct device_node *np = NULL;
1190 np = of_find_node_by_path(overlay_path(overlay_nr));
1192 unittest(0, "could not find overlay node @\"%s\"\n",
1193 overlay_path(overlay_nr));
1198 ret = of_overlay_create(np);
1200 unittest(0, "could not create overlay from \"%s\"\n",
1201 overlay_path(overlay_nr));
1205 of_unittest_track_overlay(id);
1218 /* apply an overlay while checking before and after states */
1219 static int of_unittest_apply_overlay_check(int overlay_nr, int unittest_nr,
1220 int before, int after, enum overlay_type ovtype)
1224 /* unittest device must not be in before state */
1225 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1226 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1227 overlay_path(overlay_nr),
1228 unittest_path(unittest_nr, ovtype),
1229 !before ? "enabled" : "disabled");
1233 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, NULL);
1235 /* of_unittest_apply_overlay already called unittest() */
1239 /* unittest device must be to set to after state */
1240 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1241 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1242 overlay_path(overlay_nr),
1243 unittest_path(unittest_nr, ovtype),
1244 !after ? "enabled" : "disabled");
1251 /* apply an overlay and then revert it while checking before, after states */
1252 static int of_unittest_apply_revert_overlay_check(int overlay_nr,
1253 int unittest_nr, int before, int after,
1254 enum overlay_type ovtype)
1258 /* unittest device must be in before state */
1259 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1260 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1261 overlay_path(overlay_nr),
1262 unittest_path(unittest_nr, ovtype),
1263 !before ? "enabled" : "disabled");
1267 /* apply the overlay */
1268 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ov_id);
1270 /* of_unittest_apply_overlay already called unittest() */
1274 /* unittest device must be in after state */
1275 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1276 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1277 overlay_path(overlay_nr),
1278 unittest_path(unittest_nr, ovtype),
1279 !after ? "enabled" : "disabled");
1283 ret = of_overlay_destroy(ov_id);
1285 unittest(0, "overlay @\"%s\" failed to be destroyed @\"%s\"\n",
1286 overlay_path(overlay_nr),
1287 unittest_path(unittest_nr, ovtype));
1291 /* unittest device must be again in before state */
1292 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1293 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1294 overlay_path(overlay_nr),
1295 unittest_path(unittest_nr, ovtype),
1296 !before ? "enabled" : "disabled");
1303 /* test activation of device */
1304 static void of_unittest_overlay_0(void)
1308 /* device should enable */
1309 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
1313 unittest(1, "overlay test %d passed\n", 0);
1316 /* test deactivation of device */
1317 static void of_unittest_overlay_1(void)
1321 /* device should disable */
1322 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
1326 unittest(1, "overlay test %d passed\n", 1);
1329 /* test activation of device */
1330 static void of_unittest_overlay_2(void)
1334 /* device should enable */
1335 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
1339 unittest(1, "overlay test %d passed\n", 2);
1342 /* test deactivation of device */
1343 static void of_unittest_overlay_3(void)
1347 /* device should disable */
1348 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
1352 unittest(1, "overlay test %d passed\n", 3);
1355 /* test activation of a full device node */
1356 static void of_unittest_overlay_4(void)
1360 /* device should disable */
1361 ret = of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY);
1365 unittest(1, "overlay test %d passed\n", 4);
1368 /* test overlay apply/revert sequence */
1369 static void of_unittest_overlay_5(void)
1373 /* device should disable */
1374 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
1378 unittest(1, "overlay test %d passed\n", 5);
1381 /* test overlay application in sequence */
1382 static void of_unittest_overlay_6(void)
1384 struct device_node *np;
1385 int ret, i, ov_id[2];
1386 int overlay_nr = 6, unittest_nr = 6;
1387 int before = 0, after = 1;
1389 /* unittest device must be in before state */
1390 for (i = 0; i < 2; i++) {
1391 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1393 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1394 overlay_path(overlay_nr + i),
1395 unittest_path(unittest_nr + i,
1397 !before ? "enabled" : "disabled");
1402 /* apply the overlays */
1403 for (i = 0; i < 2; i++) {
1405 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1407 unittest(0, "could not find overlay node @\"%s\"\n",
1408 overlay_path(overlay_nr + i));
1412 ret = of_overlay_create(np);
1414 unittest(0, "could not create overlay from \"%s\"\n",
1415 overlay_path(overlay_nr + i));
1419 of_unittest_track_overlay(ov_id[i]);
1422 for (i = 0; i < 2; i++) {
1423 /* unittest device must be in after state */
1424 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1426 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1427 overlay_path(overlay_nr + i),
1428 unittest_path(unittest_nr + i,
1430 !after ? "enabled" : "disabled");
1435 for (i = 1; i >= 0; i--) {
1436 ret = of_overlay_destroy(ov_id[i]);
1438 unittest(0, "overlay @\"%s\" failed destroy @\"%s\"\n",
1439 overlay_path(overlay_nr + i),
1440 unittest_path(unittest_nr + i,
1444 of_unittest_untrack_overlay(ov_id[i]);
1447 for (i = 0; i < 2; i++) {
1448 /* unittest device must be again in before state */
1449 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1451 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1452 overlay_path(overlay_nr + i),
1453 unittest_path(unittest_nr + i,
1455 !before ? "enabled" : "disabled");
1460 unittest(1, "overlay test %d passed\n", 6);
1463 /* test overlay application in sequence */
1464 static void of_unittest_overlay_8(void)
1466 struct device_node *np;
1467 int ret, i, ov_id[2];
1468 int overlay_nr = 8, unittest_nr = 8;
1470 /* we don't care about device state in this test */
1472 /* apply the overlays */
1473 for (i = 0; i < 2; i++) {
1475 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1477 unittest(0, "could not find overlay node @\"%s\"\n",
1478 overlay_path(overlay_nr + i));
1482 ret = of_overlay_create(np);
1484 unittest(0, "could not create overlay from \"%s\"\n",
1485 overlay_path(overlay_nr + i));
1489 of_unittest_track_overlay(ov_id[i]);
1492 /* now try to remove first overlay (it should fail) */
1493 ret = of_overlay_destroy(ov_id[0]);
1495 unittest(0, "overlay @\"%s\" was destroyed @\"%s\"\n",
1496 overlay_path(overlay_nr + 0),
1497 unittest_path(unittest_nr,
1502 /* removing them in order should work */
1503 for (i = 1; i >= 0; i--) {
1504 ret = of_overlay_destroy(ov_id[i]);
1506 unittest(0, "overlay @\"%s\" not destroyed @\"%s\"\n",
1507 overlay_path(overlay_nr + i),
1508 unittest_path(unittest_nr,
1512 of_unittest_untrack_overlay(ov_id[i]);
1515 unittest(1, "overlay test %d passed\n", 8);
1518 /* test insertion of a bus with parent devices */
1519 static void of_unittest_overlay_10(void)
1524 /* device should disable */
1525 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1526 if (unittest(ret == 0,
1527 "overlay test %d failed; overlay application\n", 10))
1530 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1531 unittest_path(10, PDEV_OVERLAY));
1532 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1535 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1537 if (unittest(ret, "overlay test %d failed; no child device\n", 10))
1541 /* test insertion of a bus with parent devices (and revert) */
1542 static void of_unittest_overlay_11(void)
1546 /* device should disable */
1547 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1549 if (unittest(ret == 0,
1550 "overlay test %d failed; overlay application\n", 11))
1554 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1556 struct unittest_i2c_bus_data {
1557 struct platform_device *pdev;
1558 struct i2c_adapter adap;
1561 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1562 struct i2c_msg *msgs, int num)
1564 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1571 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1573 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1576 static const struct i2c_algorithm unittest_i2c_algo = {
1577 .master_xfer = unittest_i2c_master_xfer,
1578 .functionality = unittest_i2c_functionality,
1581 static int unittest_i2c_bus_probe(struct platform_device *pdev)
1583 struct device *dev = &pdev->dev;
1584 struct device_node *np = dev->of_node;
1585 struct unittest_i2c_bus_data *std;
1586 struct i2c_adapter *adap;
1590 dev_err(dev, "No OF data for device\n");
1595 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1597 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1599 dev_err(dev, "Failed to allocate unittest i2c data\n");
1603 /* link them together */
1605 platform_set_drvdata(pdev, std);
1608 i2c_set_adapdata(adap, std);
1610 strlcpy(adap->name, pdev->name, sizeof(adap->name));
1611 adap->class = I2C_CLASS_DEPRECATED;
1612 adap->algo = &unittest_i2c_algo;
1613 adap->dev.parent = dev;
1614 adap->dev.of_node = dev->of_node;
1615 adap->timeout = 5 * HZ;
1618 ret = i2c_add_numbered_adapter(adap);
1620 dev_err(dev, "Failed to add I2C adapter\n");
1627 static int unittest_i2c_bus_remove(struct platform_device *pdev)
1629 struct device *dev = &pdev->dev;
1630 struct device_node *np = dev->of_node;
1631 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1633 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1634 i2c_del_adapter(&std->adap);
1639 static const struct of_device_id unittest_i2c_bus_match[] = {
1640 { .compatible = "unittest-i2c-bus", },
1644 static struct platform_driver unittest_i2c_bus_driver = {
1645 .probe = unittest_i2c_bus_probe,
1646 .remove = unittest_i2c_bus_remove,
1648 .name = "unittest-i2c-bus",
1649 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1653 static int unittest_i2c_dev_probe(struct i2c_client *client,
1654 const struct i2c_device_id *id)
1656 struct device *dev = &client->dev;
1657 struct device_node *np = client->dev.of_node;
1660 dev_err(dev, "No OF node\n");
1664 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1669 static int unittest_i2c_dev_remove(struct i2c_client *client)
1671 struct device *dev = &client->dev;
1672 struct device_node *np = client->dev.of_node;
1674 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1678 static const struct i2c_device_id unittest_i2c_dev_id[] = {
1679 { .name = "unittest-i2c-dev" },
1683 static struct i2c_driver unittest_i2c_dev_driver = {
1685 .name = "unittest-i2c-dev",
1687 .probe = unittest_i2c_dev_probe,
1688 .remove = unittest_i2c_dev_remove,
1689 .id_table = unittest_i2c_dev_id,
1692 #if IS_BUILTIN(CONFIG_I2C_MUX)
1694 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1699 static int unittest_i2c_mux_probe(struct i2c_client *client,
1700 const struct i2c_device_id *id)
1703 struct device *dev = &client->dev;
1704 struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1705 struct device_node *np = client->dev.of_node, *child;
1706 struct i2c_mux_core *muxc;
1709 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1712 dev_err(dev, "No OF node\n");
1717 for_each_child_of_node(np, child) {
1718 ret = of_property_read_u32(child, "reg", ®);
1721 if (max_reg == (u32)-1 || reg > max_reg)
1724 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1726 dev_err(dev, "No channels\n");
1730 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1731 unittest_i2c_mux_select_chan, NULL);
1734 for (i = 0; i < nchans; i++) {
1735 ret = i2c_mux_add_adapter(muxc, 0, i, 0);
1737 dev_err(dev, "Failed to register mux #%d\n", i);
1738 i2c_mux_del_adapters(muxc);
1743 i2c_set_clientdata(client, muxc);
1748 static int unittest_i2c_mux_remove(struct i2c_client *client)
1750 struct device *dev = &client->dev;
1751 struct device_node *np = client->dev.of_node;
1752 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1754 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1755 i2c_mux_del_adapters(muxc);
1759 static const struct i2c_device_id unittest_i2c_mux_id[] = {
1760 { .name = "unittest-i2c-mux" },
1764 static struct i2c_driver unittest_i2c_mux_driver = {
1766 .name = "unittest-i2c-mux",
1768 .probe = unittest_i2c_mux_probe,
1769 .remove = unittest_i2c_mux_remove,
1770 .id_table = unittest_i2c_mux_id,
1775 static int of_unittest_overlay_i2c_init(void)
1779 ret = i2c_add_driver(&unittest_i2c_dev_driver);
1780 if (unittest(ret == 0,
1781 "could not register unittest i2c device driver\n"))
1784 ret = platform_driver_register(&unittest_i2c_bus_driver);
1785 if (unittest(ret == 0,
1786 "could not register unittest i2c bus driver\n"))
1789 #if IS_BUILTIN(CONFIG_I2C_MUX)
1790 ret = i2c_add_driver(&unittest_i2c_mux_driver);
1791 if (unittest(ret == 0,
1792 "could not register unittest i2c mux driver\n"))
1799 static void of_unittest_overlay_i2c_cleanup(void)
1801 #if IS_BUILTIN(CONFIG_I2C_MUX)
1802 i2c_del_driver(&unittest_i2c_mux_driver);
1804 platform_driver_unregister(&unittest_i2c_bus_driver);
1805 i2c_del_driver(&unittest_i2c_dev_driver);
1808 static void of_unittest_overlay_i2c_12(void)
1812 /* device should enable */
1813 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
1817 unittest(1, "overlay test %d passed\n", 12);
1820 /* test deactivation of device */
1821 static void of_unittest_overlay_i2c_13(void)
1825 /* device should disable */
1826 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
1830 unittest(1, "overlay test %d passed\n", 13);
1833 /* just check for i2c mux existence */
1834 static void of_unittest_overlay_i2c_14(void)
1838 static void of_unittest_overlay_i2c_15(void)
1842 /* device should enable */
1843 ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
1847 unittest(1, "overlay test %d passed\n", 15);
1852 static inline void of_unittest_overlay_i2c_14(void) { }
1853 static inline void of_unittest_overlay_i2c_15(void) { }
1857 static void __init of_unittest_overlay(void)
1859 struct device_node *bus_np = NULL;
1862 ret = platform_driver_register(&unittest_driver);
1864 unittest(0, "could not register unittest driver\n");
1868 bus_np = of_find_node_by_path(bus_path);
1869 if (bus_np == NULL) {
1870 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
1874 ret = of_platform_default_populate(bus_np, NULL, NULL);
1876 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
1880 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
1881 unittest(0, "could not find unittest0 @ \"%s\"\n",
1882 unittest_path(100, PDEV_OVERLAY));
1886 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
1887 unittest(0, "unittest1 @ \"%s\" should not exist\n",
1888 unittest_path(101, PDEV_OVERLAY));
1892 unittest(1, "basic infrastructure of overlays passed");
1894 /* tests in sequence */
1895 of_unittest_overlay_0();
1896 of_unittest_overlay_1();
1897 of_unittest_overlay_2();
1898 of_unittest_overlay_3();
1899 of_unittest_overlay_4();
1900 of_unittest_overlay_5();
1901 of_unittest_overlay_6();
1902 of_unittest_overlay_8();
1904 of_unittest_overlay_10();
1905 of_unittest_overlay_11();
1907 #if IS_BUILTIN(CONFIG_I2C)
1908 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
1911 of_unittest_overlay_i2c_12();
1912 of_unittest_overlay_i2c_13();
1913 of_unittest_overlay_i2c_14();
1914 of_unittest_overlay_i2c_15();
1916 of_unittest_overlay_i2c_cleanup();
1919 of_unittest_destroy_tracked_overlays();
1922 of_node_put(bus_np);
1926 static inline void __init of_unittest_overlay(void) { }
1930 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
1931 * in scripts/Makefile.lib
1934 #define OVERLAY_INFO_EXTERN(name) \
1935 extern uint8_t __dtb_##name##_begin[]; \
1936 extern uint8_t __dtb_##name##_end[]
1938 #define OVERLAY_INFO(name, expected) \
1939 { .dtb_begin = __dtb_##name##_begin, \
1940 .dtb_end = __dtb_##name##_end, \
1941 .expected_result = expected, \
1944 struct overlay_info {
1948 struct device_node *np_overlay;
1949 int expected_result;
1953 OVERLAY_INFO_EXTERN(overlay_base);
1954 OVERLAY_INFO_EXTERN(overlay);
1955 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
1957 #ifdef CONFIG_OF_OVERLAY
1959 /* order of entries is hard-coded into users of overlays[] */
1960 static struct overlay_info overlays[] = {
1961 OVERLAY_INFO(overlay_base, -9999),
1962 OVERLAY_INFO(overlay, 0),
1963 OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
1967 static struct device_node *overlay_base_root;
1970 * Create base device tree for the overlay unittest.
1972 * This is called from very early boot code.
1974 * Do as much as possible the same way as done in __unflatten_device_tree
1975 * and other early boot steps for the normal FDT so that the overlay base
1976 * unflattened tree will have the same characteristics as the real tree
1977 * (such as having memory allocated by the early allocator). The goal
1978 * is to test "the real thing" as much as possible, and test "test setup
1979 * code" as little as possible.
1981 * Have to stop before resolving phandles, because that uses kmalloc.
1983 void __init unittest_unflatten_overlay_base(void)
1985 struct overlay_info *info;
1989 info = &overlays[0];
1991 if (info->expected_result != -9999) {
1992 pr_err("No dtb 'overlay_base' to attach\n");
1996 data_size = info->dtb_end - info->dtb_begin;
1998 pr_err("No dtb 'overlay_base' to attach\n");
2002 size = fdt_totalsize(info->dtb_begin);
2003 if (size != data_size) {
2004 pr_err("dtb 'overlay_base' header totalsize != actual size");
2008 info->data = early_init_dt_alloc_memory_arch(size,
2009 roundup_pow_of_two(FDT_V17_SIZE));
2011 pr_err("alloc for dtb 'overlay_base' failed");
2015 memcpy(info->data, info->dtb_begin, size);
2017 __unflatten_device_tree(info->data, NULL, &info->np_overlay,
2018 early_init_dt_alloc_memory_arch, true);
2019 overlay_base_root = info->np_overlay;
2023 * The purpose of of_unittest_overlay_data_add is to add an
2024 * overlay in the normal fashion. This is a test of the whole
2025 * picture, instead of testing individual elements.
2027 * A secondary purpose is to be able to verify that the contents of
2028 * /proc/device-tree/ contains the updated structure and values from
2029 * the overlay. That must be verified separately in user space.
2031 * Return 0 on unexpected error.
2033 static int __init overlay_data_add(int onum)
2035 struct overlay_info *info;
2039 u32 size_from_header;
2041 for (k = 0, info = overlays; info; info++, k++) {
2048 size = info->dtb_end - info->dtb_begin;
2050 pr_err("no overlay to attach, %d\n", onum);
2054 size_from_header = fdt_totalsize(info->dtb_begin);
2055 if (size_from_header != size) {
2056 pr_err("overlay header totalsize != actual size, %d", onum);
2061 * Must create permanent copy of FDT because of_fdt_unflatten_tree()
2062 * will create pointers to the passed in FDT in the EDT.
2064 info->data = kmemdup(info->dtb_begin, size, GFP_KERNEL);
2066 pr_err("unable to allocate memory for data, %d\n", onum);
2070 of_fdt_unflatten_tree(info->data, NULL, &info->np_overlay);
2071 if (!info->np_overlay) {
2072 pr_err("unable to unflatten overlay, %d\n", onum);
2076 of_node_set_flag(info->np_overlay, OF_DETACHED);
2078 ret = of_resolve_phandles(info->np_overlay);
2080 pr_err("resolve ot phandles (ret=%d), %d\n", ret, onum);
2081 goto out_free_np_overlay;
2084 ret = of_overlay_create(info->np_overlay);
2086 pr_err("of_overlay_create() (ret=%d), %d\n", ret, onum);
2087 goto out_free_np_overlay;
2089 info->overlay_id = ret;
2093 pr_debug("__dtb_overlay_begin applied, overlay id %d\n", ret);
2097 out_free_np_overlay:
2099 * info->np_overlay is the unflattened device tree
2100 * It has not been spliced into the live tree.
2103 /* todo: function to free unflattened device tree */
2109 return (ret == info->expected_result);
2113 * The purpose of of_unittest_overlay_high_level is to add an overlay
2114 * in the normal fashion. This is a test of the whole picture,
2115 * instead of individual elements.
2117 * The first part of the function is _not_ normal overlay usage; it is
2118 * finishing splicing the base overlay device tree into the live tree.
2120 static __init void of_unittest_overlay_high_level(void)
2122 struct device_node *last_sibling;
2123 struct device_node *np;
2124 struct device_node *of_symbols;
2125 struct device_node *overlay_base_symbols;
2126 struct device_node **pprev;
2127 struct property *prop;
2130 if (!overlay_base_root) {
2131 unittest(0, "overlay_base_root not initialized\n");
2136 * Could not fixup phandles in unittest_unflatten_overlay_base()
2137 * because kmalloc() was not yet available.
2139 of_resolve_phandles(overlay_base_root);
2142 * do not allow overlay_base to duplicate any node already in
2143 * tree, this greatly simplifies the code
2147 * remove overlay_base_root node "__local_fixups", after
2148 * being used by of_resolve_phandles()
2150 pprev = &overlay_base_root->child;
2151 for (np = overlay_base_root->child; np; np = np->sibling) {
2152 if (!of_node_cmp(np->name, "__local_fixups__")) {
2153 *pprev = np->sibling;
2156 pprev = &np->sibling;
2159 /* remove overlay_base_root node "__symbols__" if in live tree */
2160 of_symbols = of_get_child_by_name(of_root, "__symbols__");
2162 /* will have to graft properties from node into live tree */
2163 pprev = &overlay_base_root->child;
2164 for (np = overlay_base_root->child; np; np = np->sibling) {
2165 if (!of_node_cmp(np->name, "__symbols__")) {
2166 overlay_base_symbols = np;
2167 *pprev = np->sibling;
2170 pprev = &np->sibling;
2174 for (np = overlay_base_root->child; np; np = np->sibling) {
2175 if (of_get_child_by_name(of_root, np->name)) {
2176 unittest(0, "illegal node name in overlay_base %s",
2183 * overlay 'overlay_base' is not allowed to have root
2184 * properties, so only need to splice nodes into main device tree.
2186 * root node of *overlay_base_root will not be freed, it is lost
2190 for (np = overlay_base_root->child; np; np = np->sibling)
2191 np->parent = of_root;
2193 mutex_lock(&of_mutex);
2195 for (last_sibling = np = of_root->child; np; np = np->sibling)
2199 last_sibling->sibling = overlay_base_root->child;
2201 of_root->child = overlay_base_root->child;
2203 for_each_of_allnodes_from(overlay_base_root, np)
2204 __of_attach_node_sysfs(np);
2207 for_each_property_of_node(overlay_base_symbols, prop) {
2208 ret = __of_add_property(of_symbols, prop);
2211 "duplicate property '%s' in overlay_base node __symbols__",
2215 ret = __of_add_property_sysfs(of_symbols, prop);
2218 "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2225 mutex_unlock(&of_mutex);
2228 /* now do the normal overlay usage test */
2230 unittest(overlay_data_add(1),
2231 "Adding overlay 'overlay' failed\n");
2233 unittest(overlay_data_add(2),
2234 "Adding overlay 'overlay_bad_phandle' failed\n");
2238 mutex_unlock(&of_mutex);
2243 static inline __init void of_unittest_overlay_high_level(void) {}
2247 static int __init of_unittest(void)
2249 struct device_node *np;
2252 /* adding data for unittest */
2253 res = unittest_data_add();
2257 of_aliases = of_find_node_by_path("/aliases");
2259 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2261 pr_info("No testcase data in device tree; not running tests\n");
2266 pr_info("start of unittest - you will see error messages\n");
2267 of_unittest_check_tree_linkage();
2268 of_unittest_check_phandles();
2269 of_unittest_find_node_by_name();
2270 of_unittest_dynamic();
2271 of_unittest_parse_phandle_with_args();
2272 of_unittest_property_string();
2273 of_unittest_property_copy();
2274 of_unittest_changeset();
2275 of_unittest_parse_interrupts();
2276 of_unittest_parse_interrupts_extended();
2277 of_unittest_match_node();
2278 of_unittest_platform_populate();
2279 of_unittest_overlay();
2281 /* Double check linkage after removing testcase data */
2282 of_unittest_check_tree_linkage();
2284 of_unittest_overlay_high_level();
2286 pr_info("end of unittest - %i passed, %i failed\n",
2287 unittest_results.passed, unittest_results.failed);
2291 late_initcall(of_unittest);