1 // SPDX-License-Identifier: GPL-2.0
3 * Self tests for device tree subsystem
6 #define pr_fmt(fmt) "### dt-test ### " fmt
10 #include <linux/errno.h>
11 #include <linux/hashtable.h>
12 #include <linux/libfdt.h>
14 #include <linux/of_fdt.h>
15 #include <linux/of_irq.h>
16 #include <linux/of_platform.h>
17 #include <linux/list.h>
18 #include <linux/mutex.h>
19 #include <linux/slab.h>
20 #include <linux/device.h>
21 #include <linux/platform_device.h>
23 #include <linux/i2c.h>
24 #include <linux/i2c-mux.h>
26 #include <linux/bitops.h>
28 #include "of_private.h"
30 static struct unittest_results {
35 #define unittest(result, fmt, ...) ({ \
36 bool failed = !(result); \
38 unittest_results.failed++; \
39 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
41 unittest_results.passed++; \
42 pr_debug("pass %s():%i\n", __func__, __LINE__); \
47 static void __init of_unittest_find_node_by_name(void)
49 struct device_node *np;
50 const char *options, *name;
52 np = of_find_node_by_path("/testcase-data");
53 name = kasprintf(GFP_KERNEL, "%pOF", np);
54 unittest(np && !strcmp("/testcase-data", name),
55 "find /testcase-data failed\n");
59 /* Test if trailing '/' works */
60 np = of_find_node_by_path("/testcase-data/");
61 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
63 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
64 name = kasprintf(GFP_KERNEL, "%pOF", np);
65 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
66 "find /testcase-data/phandle-tests/consumer-a failed\n");
70 np = of_find_node_by_path("testcase-alias");
71 name = kasprintf(GFP_KERNEL, "%pOF", np);
72 unittest(np && !strcmp("/testcase-data", name),
73 "find testcase-alias failed\n");
77 /* Test if trailing '/' works on aliases */
78 np = of_find_node_by_path("testcase-alias/");
79 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
81 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
82 name = kasprintf(GFP_KERNEL, "%pOF", np);
83 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
84 "find testcase-alias/phandle-tests/consumer-a failed\n");
88 np = of_find_node_by_path("/testcase-data/missing-path");
89 unittest(!np, "non-existent path returned node %pOF\n", np);
92 np = of_find_node_by_path("missing-alias");
93 unittest(!np, "non-existent alias returned node %pOF\n", np);
96 np = of_find_node_by_path("testcase-alias/missing-path");
97 unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
100 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
101 unittest(np && !strcmp("testoption", options),
102 "option path test failed\n");
105 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
106 unittest(np && !strcmp("test/option", options),
107 "option path test, subcase #1 failed\n");
110 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
111 unittest(np && !strcmp("test/option", options),
112 "option path test, subcase #2 failed\n");
115 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
116 unittest(np, "NULL option path test failed\n");
119 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
121 unittest(np && !strcmp("testaliasoption", options),
122 "option alias path test failed\n");
125 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
127 unittest(np && !strcmp("test/alias/option", options),
128 "option alias path test, subcase #1 failed\n");
131 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
132 unittest(np, "NULL option alias path test failed\n");
135 options = "testoption";
136 np = of_find_node_opts_by_path("testcase-alias", &options);
137 unittest(np && !options, "option clearing test failed\n");
140 options = "testoption";
141 np = of_find_node_opts_by_path("/", &options);
142 unittest(np && !options, "option clearing root node test failed\n");
146 static void __init of_unittest_dynamic(void)
148 struct device_node *np;
149 struct property *prop;
151 np = of_find_node_by_path("/testcase-data");
153 pr_err("missing testcase data\n");
157 /* Array of 4 properties for the purpose of testing */
158 prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL);
160 unittest(0, "kzalloc() failed\n");
164 /* Add a new property - should pass*/
165 prop->name = "new-property";
166 prop->value = "new-property-data";
167 prop->length = strlen(prop->value);
168 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
170 /* Try to add an existing property - should fail */
172 prop->name = "new-property";
173 prop->value = "new-property-data-should-fail";
174 prop->length = strlen(prop->value);
175 unittest(of_add_property(np, prop) != 0,
176 "Adding an existing property should have failed\n");
178 /* Try to modify an existing property - should pass */
179 prop->value = "modify-property-data-should-pass";
180 prop->length = strlen(prop->value);
181 unittest(of_update_property(np, prop) == 0,
182 "Updating an existing property should have passed\n");
184 /* Try to modify non-existent property - should pass*/
186 prop->name = "modify-property";
187 prop->value = "modify-missing-property-data-should-pass";
188 prop->length = strlen(prop->value);
189 unittest(of_update_property(np, prop) == 0,
190 "Updating a missing property should have passed\n");
192 /* Remove property - should pass */
193 unittest(of_remove_property(np, prop) == 0,
194 "Removing a property should have passed\n");
196 /* Adding very large property - should pass */
198 prop->name = "large-property-PAGE_SIZEx8";
199 prop->length = PAGE_SIZE * 8;
200 prop->value = kzalloc(prop->length, GFP_KERNEL);
201 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
203 unittest(of_add_property(np, prop) == 0,
204 "Adding a large property should have passed\n");
207 static int __init of_unittest_check_node_linkage(struct device_node *np)
209 struct device_node *child;
212 for_each_child_of_node(np, child) {
213 if (child->parent != np) {
214 pr_err("Child node %s links to wrong parent %s\n",
215 child->name, np->name);
220 rc = of_unittest_check_node_linkage(child);
232 static void __init of_unittest_check_tree_linkage(void)
234 struct device_node *np;
235 int allnode_count = 0, child_count;
240 for_each_of_allnodes(np)
242 child_count = of_unittest_check_node_linkage(of_root);
244 unittest(child_count > 0, "Device node data structure is corrupted\n");
245 unittest(child_count == allnode_count,
246 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
247 allnode_count, child_count);
248 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
251 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
252 const char *expected)
254 unsigned char buf[strlen(expected)+10];
257 /* Baseline; check conversion with a large size limit */
258 memset(buf, 0xff, sizeof(buf));
259 size = snprintf(buf, sizeof(buf) - 2, fmt, np);
261 /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
262 unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
263 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
266 /* Make sure length limits work */
268 for (i = 0; i < 2; i++, size--) {
269 /* Clear the buffer, and make sure it works correctly still */
270 memset(buf, 0xff, sizeof(buf));
271 snprintf(buf, size+1, fmt, np);
272 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
273 "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
274 size, fmt, expected, buf);
278 static void __init of_unittest_printf(void)
280 struct device_node *np;
281 const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
282 char phandle_str[16] = "";
284 np = of_find_node_by_path(full_name);
286 unittest(np, "testcase data missing\n");
290 num_to_str(phandle_str, sizeof(phandle_str), np->phandle);
292 of_unittest_printf_one(np, "%pOF", full_name);
293 of_unittest_printf_one(np, "%pOFf", full_name);
294 of_unittest_printf_one(np, "%pOFp", phandle_str);
295 of_unittest_printf_one(np, "%pOFP", "dev@100");
296 of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
297 of_unittest_printf_one(np, "%10pOFP", " dev@100");
298 of_unittest_printf_one(np, "%-10pOFP", "dev@100 ");
299 of_unittest_printf_one(of_root, "%pOFP", "/");
300 of_unittest_printf_one(np, "%pOFF", "----");
301 of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
302 of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
303 of_unittest_printf_one(np, "%pOFc", "test-sub-device");
304 of_unittest_printf_one(np, "%pOFC",
305 "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
309 struct hlist_node node;
310 struct device_node *np;
313 static DEFINE_HASHTABLE(phandle_ht, 8);
314 static void __init of_unittest_check_phandles(void)
316 struct device_node *np;
317 struct node_hash *nh;
318 struct hlist_node *tmp;
319 int i, dup_count = 0, phandle_count = 0;
321 for_each_of_allnodes(np) {
325 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
326 if (nh->np->phandle == np->phandle) {
327 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
328 np->phandle, nh->np, np);
334 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
339 hash_add(phandle_ht, &nh->node, np->phandle);
342 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
343 dup_count, phandle_count);
346 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
352 static void __init of_unittest_parse_phandle_with_args(void)
354 struct device_node *np;
355 struct of_phandle_args args;
358 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
360 pr_err("missing testcase data\n");
364 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
365 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
367 for (i = 0; i < 8; i++) {
370 rc = of_parse_phandle_with_args(np, "phandle-list",
371 "#phandle-cells", i, &args);
373 /* Test the values from tests-phandle.dtsi */
377 passed &= (args.args_count == 1);
378 passed &= (args.args[0] == (i + 1));
382 passed &= (args.args_count == 2);
383 passed &= (args.args[0] == (i + 1));
384 passed &= (args.args[1] == 0);
387 passed &= (rc == -ENOENT);
391 passed &= (args.args_count == 3);
392 passed &= (args.args[0] == (i + 1));
393 passed &= (args.args[1] == 4);
394 passed &= (args.args[2] == 3);
398 passed &= (args.args_count == 2);
399 passed &= (args.args[0] == (i + 1));
400 passed &= (args.args[1] == 100);
404 passed &= (args.args_count == 0);
408 passed &= (args.args_count == 1);
409 passed &= (args.args[0] == (i + 1));
412 passed &= (rc == -ENOENT);
418 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
422 /* Check for missing list property */
423 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
424 "#phandle-cells", 0, &args);
425 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
426 rc = of_count_phandle_with_args(np, "phandle-list-missing",
428 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
430 /* Check for missing cells property */
431 rc = of_parse_phandle_with_args(np, "phandle-list",
432 "#phandle-cells-missing", 0, &args);
433 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
434 rc = of_count_phandle_with_args(np, "phandle-list",
435 "#phandle-cells-missing");
436 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
438 /* Check for bad phandle in list */
439 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
440 "#phandle-cells", 0, &args);
441 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
442 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
444 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
446 /* Check for incorrectly formed argument list */
447 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
448 "#phandle-cells", 1, &args);
449 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
450 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
452 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
455 static void __init of_unittest_property_string(void)
457 const char *strings[4];
458 struct device_node *np;
461 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
463 pr_err("No testcase data in device tree\n");
467 rc = of_property_match_string(np, "phandle-list-names", "first");
468 unittest(rc == 0, "first expected:0 got:%i\n", rc);
469 rc = of_property_match_string(np, "phandle-list-names", "second");
470 unittest(rc == 1, "second expected:1 got:%i\n", rc);
471 rc = of_property_match_string(np, "phandle-list-names", "third");
472 unittest(rc == 2, "third expected:2 got:%i\n", rc);
473 rc = of_property_match_string(np, "phandle-list-names", "fourth");
474 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
475 rc = of_property_match_string(np, "missing-property", "blah");
476 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
477 rc = of_property_match_string(np, "empty-property", "blah");
478 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
479 rc = of_property_match_string(np, "unterminated-string", "blah");
480 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
482 /* of_property_count_strings() tests */
483 rc = of_property_count_strings(np, "string-property");
484 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
485 rc = of_property_count_strings(np, "phandle-list-names");
486 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
487 rc = of_property_count_strings(np, "unterminated-string");
488 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
489 rc = of_property_count_strings(np, "unterminated-string-list");
490 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
492 /* of_property_read_string_index() tests */
493 rc = of_property_read_string_index(np, "string-property", 0, strings);
494 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
496 rc = of_property_read_string_index(np, "string-property", 1, strings);
497 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
498 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
499 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
500 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
501 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
502 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
503 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
505 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
506 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
508 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
509 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
510 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
511 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
513 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
514 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
517 /* of_property_read_string_array() tests */
518 rc = of_property_read_string_array(np, "string-property", strings, 4);
519 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
520 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
521 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
522 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
523 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
524 /* -- An incorrectly formed string should cause a failure */
525 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
526 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
527 /* -- parsing the correctly formed strings should still work: */
529 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
530 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
532 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
533 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
536 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
537 (p1)->value && (p2)->value && \
538 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
539 !strcmp((p1)->name, (p2)->name))
540 static void __init of_unittest_property_copy(void)
542 #ifdef CONFIG_OF_DYNAMIC
543 struct property p1 = { .name = "p1", .length = 0, .value = "" };
544 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
545 struct property *new;
547 new = __of_prop_dup(&p1, GFP_KERNEL);
548 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
553 new = __of_prop_dup(&p2, GFP_KERNEL);
554 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
561 static void __init of_unittest_changeset(void)
563 #ifdef CONFIG_OF_DYNAMIC
564 struct property *ppadd, padd = { .name = "prop-add", .length = 0, .value = "" };
565 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
566 struct property *ppremove;
567 struct device_node *n1, *n2, *n21, *nremove, *parent, *np;
568 struct of_changeset chgset;
570 n1 = __of_node_dup(NULL, "/testcase-data/changeset/n1");
571 unittest(n1, "testcase setup failure\n");
572 n2 = __of_node_dup(NULL, "/testcase-data/changeset/n2");
573 unittest(n2, "testcase setup failure\n");
574 n21 = __of_node_dup(NULL, "%s/%s", "/testcase-data/changeset/n2", "n21");
575 unittest(n21, "testcase setup failure %p\n", n21);
576 nremove = of_find_node_by_path("/testcase-data/changeset/node-remove");
577 unittest(nremove, "testcase setup failure\n");
578 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
579 unittest(ppadd, "testcase setup failure\n");
580 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
581 unittest(ppupdate, "testcase setup failure\n");
582 parent = nremove->parent;
587 ppremove = of_find_property(parent, "prop-remove", NULL);
588 unittest(ppremove, "failed to find removal prop");
590 of_changeset_init(&chgset);
591 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
592 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
593 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
594 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
595 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop\n");
596 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
597 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
598 unittest(!of_changeset_apply(&chgset), "apply failed\n");
600 /* Make sure node names are constructed correctly */
601 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
602 "'%pOF' not added\n", n21);
605 unittest(!of_changeset_revert(&chgset), "revert failed\n");
607 of_changeset_destroy(&chgset);
611 static void __init of_unittest_parse_interrupts(void)
613 struct device_node *np;
614 struct of_phandle_args args;
617 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
619 pr_err("missing testcase data\n");
623 for (i = 0; i < 4; i++) {
627 rc = of_irq_parse_one(np, i, &args);
630 passed &= (args.args_count == 1);
631 passed &= (args.args[0] == (i + 1));
633 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
638 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
640 pr_err("missing testcase data\n");
644 for (i = 0; i < 4; i++) {
648 rc = of_irq_parse_one(np, i, &args);
650 /* Test the values from tests-phandle.dtsi */
654 passed &= (args.args_count == 1);
655 passed &= (args.args[0] == 9);
659 passed &= (args.args_count == 3);
660 passed &= (args.args[0] == 10);
661 passed &= (args.args[1] == 11);
662 passed &= (args.args[2] == 12);
666 passed &= (args.args_count == 2);
667 passed &= (args.args[0] == 13);
668 passed &= (args.args[1] == 14);
672 passed &= (args.args_count == 2);
673 passed &= (args.args[0] == 15);
674 passed &= (args.args[1] == 16);
679 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
685 static void __init of_unittest_parse_interrupts_extended(void)
687 struct device_node *np;
688 struct of_phandle_args args;
691 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
693 pr_err("missing testcase data\n");
697 for (i = 0; i < 7; i++) {
700 rc = of_irq_parse_one(np, i, &args);
702 /* Test the values from tests-phandle.dtsi */
706 passed &= (args.args_count == 1);
707 passed &= (args.args[0] == 1);
711 passed &= (args.args_count == 3);
712 passed &= (args.args[0] == 2);
713 passed &= (args.args[1] == 3);
714 passed &= (args.args[2] == 4);
718 passed &= (args.args_count == 2);
719 passed &= (args.args[0] == 5);
720 passed &= (args.args[1] == 6);
724 passed &= (args.args_count == 1);
725 passed &= (args.args[0] == 9);
729 passed &= (args.args_count == 3);
730 passed &= (args.args[0] == 10);
731 passed &= (args.args[1] == 11);
732 passed &= (args.args[2] == 12);
736 passed &= (args.args_count == 2);
737 passed &= (args.args[0] == 13);
738 passed &= (args.args[1] == 14);
742 passed &= (args.args_count == 1);
743 passed &= (args.args[0] == 15);
749 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
755 static const struct of_device_id match_node_table[] = {
756 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
757 { .data = "B", .type = "type1", }, /* followed by type alone */
759 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
760 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
761 { .data = "Cc", .name = "name2", .type = "type2", },
763 { .data = "E", .compatible = "compat3" },
764 { .data = "G", .compatible = "compat2", },
765 { .data = "H", .compatible = "compat2", .name = "name5", },
766 { .data = "I", .compatible = "compat2", .type = "type1", },
767 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
768 { .data = "K", .compatible = "compat2", .name = "name9", },
775 } match_node_tests[] = {
776 { .path = "/testcase-data/match-node/name0", .data = "A", },
777 { .path = "/testcase-data/match-node/name1", .data = "B", },
778 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
779 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
780 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
781 { .path = "/testcase-data/match-node/name3", .data = "E", },
782 { .path = "/testcase-data/match-node/name4", .data = "G", },
783 { .path = "/testcase-data/match-node/name5", .data = "H", },
784 { .path = "/testcase-data/match-node/name6", .data = "G", },
785 { .path = "/testcase-data/match-node/name7", .data = "I", },
786 { .path = "/testcase-data/match-node/name8", .data = "J", },
787 { .path = "/testcase-data/match-node/name9", .data = "K", },
790 static void __init of_unittest_match_node(void)
792 struct device_node *np;
793 const struct of_device_id *match;
796 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
797 np = of_find_node_by_path(match_node_tests[i].path);
799 unittest(0, "missing testcase node %s\n",
800 match_node_tests[i].path);
804 match = of_match_node(match_node_table, np);
806 unittest(0, "%s didn't match anything\n",
807 match_node_tests[i].path);
811 if (strcmp(match->data, match_node_tests[i].data) != 0) {
812 unittest(0, "%s got wrong match. expected %s, got %s\n",
813 match_node_tests[i].path, match_node_tests[i].data,
814 (const char *)match->data);
817 unittest(1, "passed");
821 static struct resource test_bus_res = {
824 .flags = IORESOURCE_MEM,
826 static const struct platform_device_info test_bus_info = {
827 .name = "unittest-bus",
829 static void __init of_unittest_platform_populate(void)
832 struct device_node *np, *child, *grandchild;
833 struct platform_device *pdev, *test_bus;
834 const struct of_device_id match[] = {
835 { .compatible = "test-device", },
839 np = of_find_node_by_path("/testcase-data");
840 of_platform_default_populate(np, NULL, NULL);
842 /* Test that a missing irq domain returns -EPROBE_DEFER */
843 np = of_find_node_by_path("/testcase-data/testcase-device1");
844 pdev = of_find_device_by_node(np);
845 unittest(pdev, "device 1 creation failed\n");
847 irq = platform_get_irq(pdev, 0);
848 unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq);
850 /* Test that a parsing failure does not return -EPROBE_DEFER */
851 np = of_find_node_by_path("/testcase-data/testcase-device2");
852 pdev = of_find_device_by_node(np);
853 unittest(pdev, "device 2 creation failed\n");
854 irq = platform_get_irq(pdev, 0);
855 unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq);
857 np = of_find_node_by_path("/testcase-data/platform-tests");
858 unittest(np, "No testcase data in device tree\n");
862 test_bus = platform_device_register_full(&test_bus_info);
863 rc = PTR_ERR_OR_ZERO(test_bus);
864 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
867 test_bus->dev.of_node = np;
870 * Add a dummy resource to the test bus node after it is
871 * registered to catch problems with un-inserted resources. The
872 * DT code doesn't insert the resources, and it has caused the
873 * kernel to oops in the past. This makes sure the same bug
874 * doesn't crop up again.
876 platform_device_add_resources(test_bus, &test_bus_res, 1);
878 of_platform_populate(np, match, NULL, &test_bus->dev);
879 for_each_child_of_node(np, child) {
880 for_each_child_of_node(child, grandchild)
881 unittest(of_find_device_by_node(grandchild),
882 "Could not create device for node '%s'\n",
886 of_platform_depopulate(&test_bus->dev);
887 for_each_child_of_node(np, child) {
888 for_each_child_of_node(child, grandchild)
889 unittest(!of_find_device_by_node(grandchild),
890 "device didn't get destroyed '%s'\n",
894 platform_device_unregister(test_bus);
899 * update_node_properties - adds the properties
900 * of np into dup node (present in live tree) and
901 * updates parent of children of np to dup.
903 * @np: node already present in live tree
904 * @dup: node present in live tree to be updated
906 static void update_node_properties(struct device_node *np,
907 struct device_node *dup)
909 struct property *prop;
910 struct device_node *child;
912 for_each_property_of_node(np, prop)
913 of_add_property(dup, prop);
915 for_each_child_of_node(np, child)
920 * attach_node_and_children - attaches nodes
921 * and its children to live tree
923 * @np: Node to attach to live tree
925 static int attach_node_and_children(struct device_node *np)
927 struct device_node *next, *dup, *child;
929 const char *full_name;
931 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
932 dup = of_find_node_by_path(full_name);
935 update_node_properties(np, dup);
942 mutex_lock(&of_mutex);
943 raw_spin_lock_irqsave(&devtree_lock, flags);
944 np->sibling = np->parent->child;
945 np->parent->child = np;
946 of_node_clear_flag(np, OF_DETACHED);
947 raw_spin_unlock_irqrestore(&devtree_lock, flags);
949 __of_attach_node_sysfs(np);
950 mutex_unlock(&of_mutex);
953 next = child->sibling;
954 attach_node_and_children(child);
962 * unittest_data_add - Reads, copies data from
963 * linked tree and attaches it to the live tree
965 static int __init unittest_data_add(void)
968 struct device_node *unittest_data_node, *np;
970 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
971 * created by cmd_dt_S_dtb in scripts/Makefile.lib
973 extern uint8_t __dtb_testcases_begin[];
974 extern uint8_t __dtb_testcases_end[];
975 const int size = __dtb_testcases_end - __dtb_testcases_begin;
979 pr_warn("%s: No testcase data to attach; not running tests\n",
985 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
987 if (!unittest_data) {
988 pr_warn("%s: Failed to allocate memory for unittest_data; "
989 "not running tests\n", __func__);
992 of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
993 if (!unittest_data_node) {
994 pr_warn("%s: No tree to attach; not running tests\n", __func__);
999 * This lock normally encloses of_overlay_apply() as well as
1000 * of_resolve_phandles().
1002 of_overlay_mutex_lock();
1004 rc = of_resolve_phandles(unittest_data_node);
1006 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1007 of_overlay_mutex_unlock();
1012 of_root = unittest_data_node;
1013 for_each_of_allnodes(np)
1014 __of_attach_node_sysfs(np);
1015 of_aliases = of_find_node_by_path("/aliases");
1016 of_chosen = of_find_node_by_path("/chosen");
1017 of_overlay_mutex_unlock();
1021 /* attach the sub-tree to live tree */
1022 np = unittest_data_node->child;
1024 struct device_node *next = np->sibling;
1026 np->parent = of_root;
1027 attach_node_and_children(np);
1031 of_overlay_mutex_unlock();
1036 #ifdef CONFIG_OF_OVERLAY
1038 static int unittest_probe(struct platform_device *pdev)
1040 struct device *dev = &pdev->dev;
1041 struct device_node *np = dev->of_node;
1044 dev_err(dev, "No OF data for device\n");
1049 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1051 of_platform_populate(np, NULL, NULL, &pdev->dev);
1056 static int unittest_remove(struct platform_device *pdev)
1058 struct device *dev = &pdev->dev;
1059 struct device_node *np = dev->of_node;
1061 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1065 static const struct of_device_id unittest_match[] = {
1066 { .compatible = "unittest", },
1070 static struct platform_driver unittest_driver = {
1071 .probe = unittest_probe,
1072 .remove = unittest_remove,
1075 .of_match_table = of_match_ptr(unittest_match),
1079 /* get the platform device instantiated at the path */
1080 static struct platform_device *of_path_to_platform_device(const char *path)
1082 struct device_node *np;
1083 struct platform_device *pdev;
1085 np = of_find_node_by_path(path);
1089 pdev = of_find_device_by_node(np);
1095 /* find out if a platform device exists at that path */
1096 static int of_path_platform_device_exists(const char *path)
1098 struct platform_device *pdev;
1100 pdev = of_path_to_platform_device(path);
1101 platform_device_put(pdev);
1102 return pdev != NULL;
1105 #if IS_BUILTIN(CONFIG_I2C)
1107 /* get the i2c client device instantiated at the path */
1108 static struct i2c_client *of_path_to_i2c_client(const char *path)
1110 struct device_node *np;
1111 struct i2c_client *client;
1113 np = of_find_node_by_path(path);
1117 client = of_find_i2c_device_by_node(np);
1123 /* find out if a i2c client device exists at that path */
1124 static int of_path_i2c_client_exists(const char *path)
1126 struct i2c_client *client;
1128 client = of_path_to_i2c_client(path);
1130 put_device(&client->dev);
1131 return client != NULL;
1134 static int of_path_i2c_client_exists(const char *path)
1145 static int of_path_device_type_exists(const char *path,
1146 enum overlay_type ovtype)
1150 return of_path_platform_device_exists(path);
1152 return of_path_i2c_client_exists(path);
1157 static const char *unittest_path(int nr, enum overlay_type ovtype)
1160 static char buf[256];
1164 base = "/testcase-data/overlay-node/test-bus";
1167 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1173 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1174 buf[sizeof(buf) - 1] = '\0';
1178 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1182 path = unittest_path(unittest_nr, ovtype);
1186 return of_path_platform_device_exists(path);
1188 return of_path_i2c_client_exists(path);
1193 static const char *overlay_path(int nr)
1195 static char buf[256];
1197 snprintf(buf, sizeof(buf) - 1,
1198 "/testcase-data/overlay%d", nr);
1199 buf[sizeof(buf) - 1] = '\0';
1204 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1206 /* it is guaranteed that overlay ids are assigned in sequence */
1207 #define MAX_UNITTEST_OVERLAYS 256
1208 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1209 static int overlay_first_id = -1;
1211 static void of_unittest_track_overlay(int id)
1213 if (overlay_first_id < 0)
1214 overlay_first_id = id;
1215 id -= overlay_first_id;
1217 /* we shouldn't need that many */
1218 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1219 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1222 static void of_unittest_untrack_overlay(int id)
1224 if (overlay_first_id < 0)
1226 id -= overlay_first_id;
1227 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1228 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1231 static void of_unittest_destroy_tracked_overlays(void)
1233 int id, ret, defers, ovcs_id;
1235 if (overlay_first_id < 0)
1238 /* try until no defers */
1241 /* remove in reverse order */
1242 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1243 if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1246 ovcs_id = id + overlay_first_id;
1247 ret = of_overlay_remove(&ovcs_id);
1248 if (ret == -ENODEV) {
1249 pr_warn("%s: no overlay to destroy for #%d\n",
1250 __func__, id + overlay_first_id);
1255 pr_warn("%s: overlay destroy failed for #%d\n",
1256 __func__, id + overlay_first_id);
1260 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1262 } while (defers > 0);
1265 static int of_unittest_apply_overlay(int overlay_nr, int unittest_nr,
1268 struct device_node *np = NULL;
1271 np = of_find_node_by_path(overlay_path(overlay_nr));
1273 unittest(0, "could not find overlay node @\"%s\"\n",
1274 overlay_path(overlay_nr));
1280 ret = of_overlay_apply(np, overlay_id);
1282 unittest(0, "could not create overlay from \"%s\"\n",
1283 overlay_path(overlay_nr));
1286 of_unittest_track_overlay(*overlay_id);
1296 /* apply an overlay while checking before and after states */
1297 static int of_unittest_apply_overlay_check(int overlay_nr, int unittest_nr,
1298 int before, int after, enum overlay_type ovtype)
1302 /* unittest device must not be in before state */
1303 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1304 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1305 overlay_path(overlay_nr),
1306 unittest_path(unittest_nr, ovtype),
1307 !before ? "enabled" : "disabled");
1312 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1314 /* of_unittest_apply_overlay already called unittest() */
1318 /* unittest device must be to set to after state */
1319 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1320 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1321 overlay_path(overlay_nr),
1322 unittest_path(unittest_nr, ovtype),
1323 !after ? "enabled" : "disabled");
1330 /* apply an overlay and then revert it while checking before, after states */
1331 static int of_unittest_apply_revert_overlay_check(int overlay_nr,
1332 int unittest_nr, int before, int after,
1333 enum overlay_type ovtype)
1337 /* unittest device must be in before state */
1338 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1339 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1340 overlay_path(overlay_nr),
1341 unittest_path(unittest_nr, ovtype),
1342 !before ? "enabled" : "disabled");
1346 /* apply the overlay */
1348 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1350 /* of_unittest_apply_overlay already called unittest() */
1354 /* unittest device must be in after state */
1355 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1356 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1357 overlay_path(overlay_nr),
1358 unittest_path(unittest_nr, ovtype),
1359 !after ? "enabled" : "disabled");
1363 ret = of_overlay_remove(&ovcs_id);
1365 unittest(0, "overlay @\"%s\" failed to be destroyed @\"%s\"\n",
1366 overlay_path(overlay_nr),
1367 unittest_path(unittest_nr, ovtype));
1371 /* unittest device must be again in before state */
1372 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1373 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1374 overlay_path(overlay_nr),
1375 unittest_path(unittest_nr, ovtype),
1376 !before ? "enabled" : "disabled");
1383 /* test activation of device */
1384 static void of_unittest_overlay_0(void)
1388 /* device should enable */
1389 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
1393 unittest(1, "overlay test %d passed\n", 0);
1396 /* test deactivation of device */
1397 static void of_unittest_overlay_1(void)
1401 /* device should disable */
1402 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
1406 unittest(1, "overlay test %d passed\n", 1);
1409 /* test activation of device */
1410 static void of_unittest_overlay_2(void)
1414 /* device should enable */
1415 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
1419 unittest(1, "overlay test %d passed\n", 2);
1422 /* test deactivation of device */
1423 static void of_unittest_overlay_3(void)
1427 /* device should disable */
1428 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
1432 unittest(1, "overlay test %d passed\n", 3);
1435 /* test activation of a full device node */
1436 static void of_unittest_overlay_4(void)
1440 /* device should disable */
1441 ret = of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY);
1445 unittest(1, "overlay test %d passed\n", 4);
1448 /* test overlay apply/revert sequence */
1449 static void of_unittest_overlay_5(void)
1453 /* device should disable */
1454 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
1458 unittest(1, "overlay test %d passed\n", 5);
1461 /* test overlay application in sequence */
1462 static void of_unittest_overlay_6(void)
1464 struct device_node *np;
1465 int ret, i, ov_id[2], ovcs_id;
1466 int overlay_nr = 6, unittest_nr = 6;
1467 int before = 0, after = 1;
1469 /* unittest device must be in before state */
1470 for (i = 0; i < 2; i++) {
1471 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1473 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1474 overlay_path(overlay_nr + i),
1475 unittest_path(unittest_nr + i,
1477 !before ? "enabled" : "disabled");
1482 /* apply the overlays */
1483 for (i = 0; i < 2; i++) {
1485 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1487 unittest(0, "could not find overlay node @\"%s\"\n",
1488 overlay_path(overlay_nr + i));
1493 ret = of_overlay_apply(np, &ovcs_id);
1495 unittest(0, "could not create overlay from \"%s\"\n",
1496 overlay_path(overlay_nr + i));
1500 of_unittest_track_overlay(ov_id[i]);
1503 for (i = 0; i < 2; i++) {
1504 /* unittest device must be in after state */
1505 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1507 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1508 overlay_path(overlay_nr + i),
1509 unittest_path(unittest_nr + i,
1511 !after ? "enabled" : "disabled");
1516 for (i = 1; i >= 0; i--) {
1518 ret = of_overlay_remove(&ovcs_id);
1520 unittest(0, "overlay @\"%s\" failed destroy @\"%s\"\n",
1521 overlay_path(overlay_nr + i),
1522 unittest_path(unittest_nr + i,
1526 of_unittest_untrack_overlay(ov_id[i]);
1529 for (i = 0; i < 2; i++) {
1530 /* unittest device must be again in before state */
1531 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1533 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1534 overlay_path(overlay_nr + i),
1535 unittest_path(unittest_nr + i,
1537 !before ? "enabled" : "disabled");
1542 unittest(1, "overlay test %d passed\n", 6);
1545 /* test overlay application in sequence */
1546 static void of_unittest_overlay_8(void)
1548 struct device_node *np;
1549 int ret, i, ov_id[2], ovcs_id;
1550 int overlay_nr = 8, unittest_nr = 8;
1552 /* we don't care about device state in this test */
1554 /* apply the overlays */
1555 for (i = 0; i < 2; i++) {
1557 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1559 unittest(0, "could not find overlay node @\"%s\"\n",
1560 overlay_path(overlay_nr + i));
1565 ret = of_overlay_apply(np, &ovcs_id);
1567 unittest(0, "could not create overlay from \"%s\"\n",
1568 overlay_path(overlay_nr + i));
1572 of_unittest_track_overlay(ov_id[i]);
1575 /* now try to remove first overlay (it should fail) */
1577 ret = of_overlay_remove(&ovcs_id);
1579 unittest(0, "overlay @\"%s\" was destroyed @\"%s\"\n",
1580 overlay_path(overlay_nr + 0),
1581 unittest_path(unittest_nr,
1586 /* removing them in order should work */
1587 for (i = 1; i >= 0; i--) {
1589 ret = of_overlay_remove(&ovcs_id);
1591 unittest(0, "overlay @\"%s\" not destroyed @\"%s\"\n",
1592 overlay_path(overlay_nr + i),
1593 unittest_path(unittest_nr,
1597 of_unittest_untrack_overlay(ov_id[i]);
1600 unittest(1, "overlay test %d passed\n", 8);
1603 /* test insertion of a bus with parent devices */
1604 static void of_unittest_overlay_10(void)
1609 /* device should disable */
1610 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1611 if (unittest(ret == 0,
1612 "overlay test %d failed; overlay application\n", 10))
1615 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1616 unittest_path(10, PDEV_OVERLAY));
1617 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1620 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1622 if (unittest(ret, "overlay test %d failed; no child device\n", 10))
1626 /* test insertion of a bus with parent devices (and revert) */
1627 static void of_unittest_overlay_11(void)
1631 /* device should disable */
1632 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1634 if (unittest(ret == 0,
1635 "overlay test %d failed; overlay application\n", 11))
1639 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1641 struct unittest_i2c_bus_data {
1642 struct platform_device *pdev;
1643 struct i2c_adapter adap;
1646 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1647 struct i2c_msg *msgs, int num)
1649 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1656 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1658 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1661 static const struct i2c_algorithm unittest_i2c_algo = {
1662 .master_xfer = unittest_i2c_master_xfer,
1663 .functionality = unittest_i2c_functionality,
1666 static int unittest_i2c_bus_probe(struct platform_device *pdev)
1668 struct device *dev = &pdev->dev;
1669 struct device_node *np = dev->of_node;
1670 struct unittest_i2c_bus_data *std;
1671 struct i2c_adapter *adap;
1675 dev_err(dev, "No OF data for device\n");
1680 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1682 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1684 dev_err(dev, "Failed to allocate unittest i2c data\n");
1688 /* link them together */
1690 platform_set_drvdata(pdev, std);
1693 i2c_set_adapdata(adap, std);
1695 strlcpy(adap->name, pdev->name, sizeof(adap->name));
1696 adap->class = I2C_CLASS_DEPRECATED;
1697 adap->algo = &unittest_i2c_algo;
1698 adap->dev.parent = dev;
1699 adap->dev.of_node = dev->of_node;
1700 adap->timeout = 5 * HZ;
1703 ret = i2c_add_numbered_adapter(adap);
1705 dev_err(dev, "Failed to add I2C adapter\n");
1712 static int unittest_i2c_bus_remove(struct platform_device *pdev)
1714 struct device *dev = &pdev->dev;
1715 struct device_node *np = dev->of_node;
1716 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1718 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1719 i2c_del_adapter(&std->adap);
1724 static const struct of_device_id unittest_i2c_bus_match[] = {
1725 { .compatible = "unittest-i2c-bus", },
1729 static struct platform_driver unittest_i2c_bus_driver = {
1730 .probe = unittest_i2c_bus_probe,
1731 .remove = unittest_i2c_bus_remove,
1733 .name = "unittest-i2c-bus",
1734 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1738 static int unittest_i2c_dev_probe(struct i2c_client *client,
1739 const struct i2c_device_id *id)
1741 struct device *dev = &client->dev;
1742 struct device_node *np = client->dev.of_node;
1745 dev_err(dev, "No OF node\n");
1749 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1754 static int unittest_i2c_dev_remove(struct i2c_client *client)
1756 struct device *dev = &client->dev;
1757 struct device_node *np = client->dev.of_node;
1759 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1763 static const struct i2c_device_id unittest_i2c_dev_id[] = {
1764 { .name = "unittest-i2c-dev" },
1768 static struct i2c_driver unittest_i2c_dev_driver = {
1770 .name = "unittest-i2c-dev",
1772 .probe = unittest_i2c_dev_probe,
1773 .remove = unittest_i2c_dev_remove,
1774 .id_table = unittest_i2c_dev_id,
1777 #if IS_BUILTIN(CONFIG_I2C_MUX)
1779 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1784 static int unittest_i2c_mux_probe(struct i2c_client *client,
1785 const struct i2c_device_id *id)
1788 struct device *dev = &client->dev;
1789 struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1790 struct device_node *np = client->dev.of_node, *child;
1791 struct i2c_mux_core *muxc;
1794 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1797 dev_err(dev, "No OF node\n");
1802 for_each_child_of_node(np, child) {
1803 ret = of_property_read_u32(child, "reg", ®);
1806 if (max_reg == (u32)-1 || reg > max_reg)
1809 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1811 dev_err(dev, "No channels\n");
1815 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1816 unittest_i2c_mux_select_chan, NULL);
1819 for (i = 0; i < nchans; i++) {
1820 ret = i2c_mux_add_adapter(muxc, 0, i, 0);
1822 dev_err(dev, "Failed to register mux #%d\n", i);
1823 i2c_mux_del_adapters(muxc);
1828 i2c_set_clientdata(client, muxc);
1833 static int unittest_i2c_mux_remove(struct i2c_client *client)
1835 struct device *dev = &client->dev;
1836 struct device_node *np = client->dev.of_node;
1837 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1839 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1840 i2c_mux_del_adapters(muxc);
1844 static const struct i2c_device_id unittest_i2c_mux_id[] = {
1845 { .name = "unittest-i2c-mux" },
1849 static struct i2c_driver unittest_i2c_mux_driver = {
1851 .name = "unittest-i2c-mux",
1853 .probe = unittest_i2c_mux_probe,
1854 .remove = unittest_i2c_mux_remove,
1855 .id_table = unittest_i2c_mux_id,
1860 static int of_unittest_overlay_i2c_init(void)
1864 ret = i2c_add_driver(&unittest_i2c_dev_driver);
1865 if (unittest(ret == 0,
1866 "could not register unittest i2c device driver\n"))
1869 ret = platform_driver_register(&unittest_i2c_bus_driver);
1870 if (unittest(ret == 0,
1871 "could not register unittest i2c bus driver\n"))
1874 #if IS_BUILTIN(CONFIG_I2C_MUX)
1875 ret = i2c_add_driver(&unittest_i2c_mux_driver);
1876 if (unittest(ret == 0,
1877 "could not register unittest i2c mux driver\n"))
1884 static void of_unittest_overlay_i2c_cleanup(void)
1886 #if IS_BUILTIN(CONFIG_I2C_MUX)
1887 i2c_del_driver(&unittest_i2c_mux_driver);
1889 platform_driver_unregister(&unittest_i2c_bus_driver);
1890 i2c_del_driver(&unittest_i2c_dev_driver);
1893 static void of_unittest_overlay_i2c_12(void)
1897 /* device should enable */
1898 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
1902 unittest(1, "overlay test %d passed\n", 12);
1905 /* test deactivation of device */
1906 static void of_unittest_overlay_i2c_13(void)
1910 /* device should disable */
1911 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
1915 unittest(1, "overlay test %d passed\n", 13);
1918 /* just check for i2c mux existence */
1919 static void of_unittest_overlay_i2c_14(void)
1923 static void of_unittest_overlay_i2c_15(void)
1927 /* device should enable */
1928 ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
1932 unittest(1, "overlay test %d passed\n", 15);
1937 static inline void of_unittest_overlay_i2c_14(void) { }
1938 static inline void of_unittest_overlay_i2c_15(void) { }
1942 static void __init of_unittest_overlay(void)
1944 struct device_node *bus_np = NULL;
1947 ret = platform_driver_register(&unittest_driver);
1949 unittest(0, "could not register unittest driver\n");
1953 bus_np = of_find_node_by_path(bus_path);
1954 if (bus_np == NULL) {
1955 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
1959 ret = of_platform_default_populate(bus_np, NULL, NULL);
1961 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
1965 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
1966 unittest(0, "could not find unittest0 @ \"%s\"\n",
1967 unittest_path(100, PDEV_OVERLAY));
1971 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
1972 unittest(0, "unittest1 @ \"%s\" should not exist\n",
1973 unittest_path(101, PDEV_OVERLAY));
1977 unittest(1, "basic infrastructure of overlays passed");
1979 /* tests in sequence */
1980 of_unittest_overlay_0();
1981 of_unittest_overlay_1();
1982 of_unittest_overlay_2();
1983 of_unittest_overlay_3();
1984 of_unittest_overlay_4();
1985 of_unittest_overlay_5();
1986 of_unittest_overlay_6();
1987 of_unittest_overlay_8();
1989 of_unittest_overlay_10();
1990 of_unittest_overlay_11();
1992 #if IS_BUILTIN(CONFIG_I2C)
1993 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
1996 of_unittest_overlay_i2c_12();
1997 of_unittest_overlay_i2c_13();
1998 of_unittest_overlay_i2c_14();
1999 of_unittest_overlay_i2c_15();
2001 of_unittest_overlay_i2c_cleanup();
2004 of_unittest_destroy_tracked_overlays();
2007 of_node_put(bus_np);
2011 static inline void __init of_unittest_overlay(void) { }
2014 #ifdef CONFIG_OF_OVERLAY
2017 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2018 * in scripts/Makefile.lib
2021 #define OVERLAY_INFO_EXTERN(name) \
2022 extern uint8_t __dtb_##name##_begin[]; \
2023 extern uint8_t __dtb_##name##_end[]
2025 #define OVERLAY_INFO(name, expected) \
2026 { .dtb_begin = __dtb_##name##_begin, \
2027 .dtb_end = __dtb_##name##_end, \
2028 .expected_result = expected, \
2031 struct overlay_info {
2035 struct device_node *np_overlay;
2036 int expected_result;
2040 OVERLAY_INFO_EXTERN(overlay_base);
2041 OVERLAY_INFO_EXTERN(overlay);
2042 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2043 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2045 /* order of entries is hard-coded into users of overlays[] */
2046 static struct overlay_info overlays[] = {
2047 OVERLAY_INFO(overlay_base, -9999),
2048 OVERLAY_INFO(overlay, 0),
2049 OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2050 OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2054 static struct device_node *overlay_base_root;
2057 * Create base device tree for the overlay unittest.
2059 * This is called from very early boot code.
2061 * Do as much as possible the same way as done in __unflatten_device_tree
2062 * and other early boot steps for the normal FDT so that the overlay base
2063 * unflattened tree will have the same characteristics as the real tree
2064 * (such as having memory allocated by the early allocator). The goal
2065 * is to test "the real thing" as much as possible, and test "test setup
2066 * code" as little as possible.
2068 * Have to stop before resolving phandles, because that uses kmalloc.
2070 void __init unittest_unflatten_overlay_base(void)
2072 struct overlay_info *info;
2076 info = &overlays[0];
2078 if (info->expected_result != -9999) {
2079 pr_err("No dtb 'overlay_base' to attach\n");
2083 data_size = info->dtb_end - info->dtb_begin;
2085 pr_err("No dtb 'overlay_base' to attach\n");
2089 size = fdt_totalsize(info->dtb_begin);
2090 if (size != data_size) {
2091 pr_err("dtb 'overlay_base' header totalsize != actual size");
2095 info->data = early_init_dt_alloc_memory_arch(size,
2096 roundup_pow_of_two(FDT_V17_SIZE));
2098 pr_err("alloc for dtb 'overlay_base' failed");
2102 memcpy(info->data, info->dtb_begin, size);
2104 __unflatten_device_tree(info->data, NULL, &info->np_overlay,
2105 early_init_dt_alloc_memory_arch, true);
2106 overlay_base_root = info->np_overlay;
2110 * The purpose of of_unittest_overlay_data_add is to add an
2111 * overlay in the normal fashion. This is a test of the whole
2112 * picture, instead of testing individual elements.
2114 * A secondary purpose is to be able to verify that the contents of
2115 * /proc/device-tree/ contains the updated structure and values from
2116 * the overlay. That must be verified separately in user space.
2118 * Return 0 on unexpected error.
2120 static int __init overlay_data_add(int onum)
2122 struct overlay_info *info;
2126 u32 size_from_header;
2128 for (k = 0, info = overlays; info; info++, k++) {
2135 size = info->dtb_end - info->dtb_begin;
2137 pr_err("no overlay to attach, %d\n", onum);
2141 size_from_header = fdt_totalsize(info->dtb_begin);
2142 if (size_from_header != size) {
2143 pr_err("overlay header totalsize != actual size, %d", onum);
2148 * Must create permanent copy of FDT because of_fdt_unflatten_tree()
2149 * will create pointers to the passed in FDT in the EDT.
2151 info->data = kmemdup(info->dtb_begin, size, GFP_KERNEL);
2153 pr_err("unable to allocate memory for data, %d\n", onum);
2157 of_fdt_unflatten_tree(info->data, NULL, &info->np_overlay);
2158 if (!info->np_overlay) {
2159 pr_err("unable to unflatten overlay, %d\n", onum);
2164 info->overlay_id = 0;
2165 ret = of_overlay_apply(info->np_overlay, &info->overlay_id);
2167 pr_err("of_overlay_apply() (ret=%d), %d\n", ret, onum);
2168 of_overlay_mutex_unlock();
2169 goto out_free_np_overlay;
2172 pr_debug("__dtb_overlay_begin applied, overlay id %d\n", ret);
2176 out_free_np_overlay:
2178 * info->np_overlay is the unflattened device tree
2179 * It has not been spliced into the live tree.
2182 /* todo: function to free unflattened device tree */
2188 return (ret == info->expected_result);
2192 * The purpose of of_unittest_overlay_high_level is to add an overlay
2193 * in the normal fashion. This is a test of the whole picture,
2194 * instead of individual elements.
2196 * The first part of the function is _not_ normal overlay usage; it is
2197 * finishing splicing the base overlay device tree into the live tree.
2199 static __init void of_unittest_overlay_high_level(void)
2201 struct device_node *last_sibling;
2202 struct device_node *np;
2203 struct device_node *of_symbols;
2204 struct device_node *overlay_base_symbols;
2205 struct device_node **pprev;
2206 struct property *prop;
2209 if (!overlay_base_root) {
2210 unittest(0, "overlay_base_root not initialized\n");
2215 * Could not fixup phandles in unittest_unflatten_overlay_base()
2216 * because kmalloc() was not yet available.
2218 of_overlay_mutex_lock();
2219 of_resolve_phandles(overlay_base_root);
2220 of_overlay_mutex_unlock();
2224 * do not allow overlay_base to duplicate any node already in
2225 * tree, this greatly simplifies the code
2229 * remove overlay_base_root node "__local_fixups", after
2230 * being used by of_resolve_phandles()
2232 pprev = &overlay_base_root->child;
2233 for (np = overlay_base_root->child; np; np = np->sibling) {
2234 if (!of_node_cmp(np->name, "__local_fixups__")) {
2235 *pprev = np->sibling;
2238 pprev = &np->sibling;
2241 /* remove overlay_base_root node "__symbols__" if in live tree */
2242 of_symbols = of_get_child_by_name(of_root, "__symbols__");
2244 /* will have to graft properties from node into live tree */
2245 pprev = &overlay_base_root->child;
2246 for (np = overlay_base_root->child; np; np = np->sibling) {
2247 if (!of_node_cmp(np->name, "__symbols__")) {
2248 overlay_base_symbols = np;
2249 *pprev = np->sibling;
2252 pprev = &np->sibling;
2256 for (np = overlay_base_root->child; np; np = np->sibling) {
2257 if (of_get_child_by_name(of_root, np->name)) {
2258 unittest(0, "illegal node name in overlay_base %s",
2265 * overlay 'overlay_base' is not allowed to have root
2266 * properties, so only need to splice nodes into main device tree.
2268 * root node of *overlay_base_root will not be freed, it is lost
2272 for (np = overlay_base_root->child; np; np = np->sibling)
2273 np->parent = of_root;
2275 mutex_lock(&of_mutex);
2277 for (last_sibling = np = of_root->child; np; np = np->sibling)
2281 last_sibling->sibling = overlay_base_root->child;
2283 of_root->child = overlay_base_root->child;
2285 for_each_of_allnodes_from(overlay_base_root, np)
2286 __of_attach_node_sysfs(np);
2289 for_each_property_of_node(overlay_base_symbols, prop) {
2290 ret = __of_add_property(of_symbols, prop);
2293 "duplicate property '%s' in overlay_base node __symbols__",
2297 ret = __of_add_property_sysfs(of_symbols, prop);
2300 "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2307 mutex_unlock(&of_mutex);
2310 /* now do the normal overlay usage test */
2312 unittest(overlay_data_add(1),
2313 "Adding overlay 'overlay' failed\n");
2315 unittest(overlay_data_add(2),
2316 "Adding overlay 'overlay_bad_phandle' failed\n");
2318 unittest(overlay_data_add(3),
2319 "Adding overlay 'overlay_bad_symbol' failed\n");
2324 mutex_unlock(&of_mutex);
2329 static inline __init void of_unittest_overlay_high_level(void) {}
2333 static int __init of_unittest(void)
2335 struct device_node *np;
2338 /* adding data for unittest */
2339 res = unittest_data_add();
2343 of_aliases = of_find_node_by_path("/aliases");
2345 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2347 pr_info("No testcase data in device tree; not running tests\n");
2352 pr_info("start of unittest - you will see error messages\n");
2353 of_unittest_check_tree_linkage();
2354 of_unittest_check_phandles();
2355 of_unittest_find_node_by_name();
2356 of_unittest_dynamic();
2357 of_unittest_parse_phandle_with_args();
2358 of_unittest_printf();
2359 of_unittest_property_string();
2360 of_unittest_property_copy();
2361 of_unittest_changeset();
2362 of_unittest_parse_interrupts();
2363 of_unittest_parse_interrupts_extended();
2364 of_unittest_match_node();
2365 of_unittest_platform_populate();
2366 of_unittest_overlay();
2368 /* Double check linkage after removing testcase data */
2369 of_unittest_check_tree_linkage();
2371 of_unittest_overlay_high_level();
2373 pr_info("end of unittest - %i passed, %i failed\n",
2374 unittest_results.passed, unittest_results.failed);
2378 late_initcall(of_unittest);