1 // SPDX-License-Identifier: GPL-2.0
3 * Self tests for device tree subsystem
6 #define pr_fmt(fmt) "### dt-test ### " fmt
8 #include <linux/memblock.h>
10 #include <linux/dma-direct.h> /* to test phys_to_dma/dma_to_phys */
11 #include <linux/err.h>
12 #include <linux/errno.h>
13 #include <linux/hashtable.h>
14 #include <linux/libfdt.h>
16 #include <linux/of_address.h>
17 #include <linux/of_fdt.h>
18 #include <linux/of_irq.h>
19 #include <linux/of_platform.h>
20 #include <linux/list.h>
21 #include <linux/mutex.h>
22 #include <linux/slab.h>
23 #include <linux/device.h>
24 #include <linux/platform_device.h>
25 #include <linux/kernel.h>
27 #include <linux/i2c.h>
28 #include <linux/i2c-mux.h>
29 #include <linux/gpio/driver.h>
31 #include <linux/bitops.h>
33 #include "of_private.h"
35 static struct unittest_results {
40 #define unittest(result, fmt, ...) ({ \
41 bool failed = !(result); \
43 unittest_results.failed++; \
44 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
46 unittest_results.passed++; \
47 pr_info("pass %s():%i\n", __func__, __LINE__); \
53 * Expected message may have a message level other than KERN_INFO.
54 * Print the expected message only if the current loglevel will allow
55 * the actual message to print.
57 * Do not use EXPECT_BEGIN() or EXPECT_END() for messages generated by
60 #define EXPECT_BEGIN(level, fmt, ...) \
61 printk(level pr_fmt("EXPECT \\ : ") fmt, ##__VA_ARGS__)
63 #define EXPECT_END(level, fmt, ...) \
64 printk(level pr_fmt("EXPECT / : ") fmt, ##__VA_ARGS__)
66 static void __init of_unittest_find_node_by_name(void)
68 struct device_node *np;
69 const char *options, *name;
71 np = of_find_node_by_path("/testcase-data");
72 name = kasprintf(GFP_KERNEL, "%pOF", np);
73 unittest(np && !strcmp("/testcase-data", name),
74 "find /testcase-data failed\n");
78 /* Test if trailing '/' works */
79 np = of_find_node_by_path("/testcase-data/");
80 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
82 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
83 name = kasprintf(GFP_KERNEL, "%pOF", np);
84 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
85 "find /testcase-data/phandle-tests/consumer-a failed\n");
89 np = of_find_node_by_path("testcase-alias");
90 name = kasprintf(GFP_KERNEL, "%pOF", np);
91 unittest(np && !strcmp("/testcase-data", name),
92 "find testcase-alias failed\n");
96 /* Test if trailing '/' works on aliases */
97 np = of_find_node_by_path("testcase-alias/");
98 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
100 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
101 name = kasprintf(GFP_KERNEL, "%pOF", np);
102 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
103 "find testcase-alias/phandle-tests/consumer-a failed\n");
107 np = of_find_node_by_path("/testcase-data/missing-path");
108 unittest(!np, "non-existent path returned node %pOF\n", np);
111 np = of_find_node_by_path("missing-alias");
112 unittest(!np, "non-existent alias returned node %pOF\n", np);
115 np = of_find_node_by_path("testcase-alias/missing-path");
116 unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
119 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
120 unittest(np && !strcmp("testoption", options),
121 "option path test failed\n");
124 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
125 unittest(np && !strcmp("test/option", options),
126 "option path test, subcase #1 failed\n");
129 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
130 unittest(np && !strcmp("test/option", options),
131 "option path test, subcase #2 failed\n");
134 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
135 unittest(np, "NULL option path test failed\n");
138 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
140 unittest(np && !strcmp("testaliasoption", options),
141 "option alias path test failed\n");
144 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
146 unittest(np && !strcmp("test/alias/option", options),
147 "option alias path test, subcase #1 failed\n");
150 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
151 unittest(np, "NULL option alias path test failed\n");
154 options = "testoption";
155 np = of_find_node_opts_by_path("testcase-alias", &options);
156 unittest(np && !options, "option clearing test failed\n");
159 options = "testoption";
160 np = of_find_node_opts_by_path("/", &options);
161 unittest(np && !options, "option clearing root node test failed\n");
165 static void __init of_unittest_dynamic(void)
167 struct device_node *np;
168 struct property *prop;
170 np = of_find_node_by_path("/testcase-data");
172 pr_err("missing testcase data\n");
176 /* Array of 4 properties for the purpose of testing */
177 prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
179 unittest(0, "kzalloc() failed\n");
183 /* Add a new property - should pass*/
184 prop->name = "new-property";
185 prop->value = "new-property-data";
186 prop->length = strlen(prop->value) + 1;
187 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
189 /* Try to add an existing property - should fail */
191 prop->name = "new-property";
192 prop->value = "new-property-data-should-fail";
193 prop->length = strlen(prop->value) + 1;
194 unittest(of_add_property(np, prop) != 0,
195 "Adding an existing property should have failed\n");
197 /* Try to modify an existing property - should pass */
198 prop->value = "modify-property-data-should-pass";
199 prop->length = strlen(prop->value) + 1;
200 unittest(of_update_property(np, prop) == 0,
201 "Updating an existing property should have passed\n");
203 /* Try to modify non-existent property - should pass*/
205 prop->name = "modify-property";
206 prop->value = "modify-missing-property-data-should-pass";
207 prop->length = strlen(prop->value) + 1;
208 unittest(of_update_property(np, prop) == 0,
209 "Updating a missing property should have passed\n");
211 /* Remove property - should pass */
212 unittest(of_remove_property(np, prop) == 0,
213 "Removing a property should have passed\n");
215 /* Adding very large property - should pass */
217 prop->name = "large-property-PAGE_SIZEx8";
218 prop->length = PAGE_SIZE * 8;
219 prop->value = kzalloc(prop->length, GFP_KERNEL);
220 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
222 unittest(of_add_property(np, prop) == 0,
223 "Adding a large property should have passed\n");
226 static int __init of_unittest_check_node_linkage(struct device_node *np)
228 struct device_node *child;
231 for_each_child_of_node(np, child) {
232 if (child->parent != np) {
233 pr_err("Child node %pOFn links to wrong parent %pOFn\n",
239 rc = of_unittest_check_node_linkage(child);
251 static void __init of_unittest_check_tree_linkage(void)
253 struct device_node *np;
254 int allnode_count = 0, child_count;
259 for_each_of_allnodes(np)
261 child_count = of_unittest_check_node_linkage(of_root);
263 unittest(child_count > 0, "Device node data structure is corrupted\n");
264 unittest(child_count == allnode_count,
265 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
266 allnode_count, child_count);
267 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
270 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
271 const char *expected)
277 buf_size = strlen(expected) + 10;
278 buf = kmalloc(buf_size, GFP_KERNEL);
282 /* Baseline; check conversion with a large size limit */
283 memset(buf, 0xff, buf_size);
284 size = snprintf(buf, buf_size - 2, fmt, np);
286 /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
287 unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
288 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
291 /* Make sure length limits work */
293 for (i = 0; i < 2; i++, size--) {
294 /* Clear the buffer, and make sure it works correctly still */
295 memset(buf, 0xff, buf_size);
296 snprintf(buf, size+1, fmt, np);
297 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
298 "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
299 size, fmt, expected, buf);
304 static void __init of_unittest_printf(void)
306 struct device_node *np;
307 const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
308 char phandle_str[16] = "";
310 np = of_find_node_by_path(full_name);
312 unittest(np, "testcase data missing\n");
316 num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
318 of_unittest_printf_one(np, "%pOF", full_name);
319 of_unittest_printf_one(np, "%pOFf", full_name);
320 of_unittest_printf_one(np, "%pOFn", "dev");
321 of_unittest_printf_one(np, "%2pOFn", "dev");
322 of_unittest_printf_one(np, "%5pOFn", " dev");
323 of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
324 of_unittest_printf_one(np, "%pOFp", phandle_str);
325 of_unittest_printf_one(np, "%pOFP", "dev@100");
326 of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
327 of_unittest_printf_one(np, "%10pOFP", " dev@100");
328 of_unittest_printf_one(np, "%-10pOFP", "dev@100 ");
329 of_unittest_printf_one(of_root, "%pOFP", "/");
330 of_unittest_printf_one(np, "%pOFF", "----");
331 of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
332 of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
333 of_unittest_printf_one(np, "%pOFc", "test-sub-device");
334 of_unittest_printf_one(np, "%pOFC",
335 "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
339 struct hlist_node node;
340 struct device_node *np;
343 static DEFINE_HASHTABLE(phandle_ht, 8);
344 static void __init of_unittest_check_phandles(void)
346 struct device_node *np;
347 struct node_hash *nh;
348 struct hlist_node *tmp;
349 int i, dup_count = 0, phandle_count = 0;
351 for_each_of_allnodes(np) {
355 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
356 if (nh->np->phandle == np->phandle) {
357 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
358 np->phandle, nh->np, np);
364 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
369 hash_add(phandle_ht, &nh->node, np->phandle);
372 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
373 dup_count, phandle_count);
376 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
382 static void __init of_unittest_parse_phandle_with_args(void)
384 struct device_node *np;
385 struct of_phandle_args args;
388 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
390 pr_err("missing testcase data\n");
394 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
395 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
397 for (i = 0; i < 8; i++) {
400 memset(&args, 0, sizeof(args));
401 rc = of_parse_phandle_with_args(np, "phandle-list",
402 "#phandle-cells", i, &args);
404 /* Test the values from tests-phandle.dtsi */
408 passed &= (args.args_count == 1);
409 passed &= (args.args[0] == (i + 1));
413 passed &= (args.args_count == 2);
414 passed &= (args.args[0] == (i + 1));
415 passed &= (args.args[1] == 0);
418 passed &= (rc == -ENOENT);
422 passed &= (args.args_count == 3);
423 passed &= (args.args[0] == (i + 1));
424 passed &= (args.args[1] == 4);
425 passed &= (args.args[2] == 3);
429 passed &= (args.args_count == 2);
430 passed &= (args.args[0] == (i + 1));
431 passed &= (args.args[1] == 100);
435 passed &= (args.args_count == 0);
439 passed &= (args.args_count == 1);
440 passed &= (args.args[0] == (i + 1));
443 passed &= (rc == -ENOENT);
449 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
453 /* Check for missing list property */
454 memset(&args, 0, sizeof(args));
455 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
456 "#phandle-cells", 0, &args);
457 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
458 rc = of_count_phandle_with_args(np, "phandle-list-missing",
460 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
462 /* Check for missing cells property */
463 memset(&args, 0, sizeof(args));
465 EXPECT_BEGIN(KERN_INFO,
466 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
468 rc = of_parse_phandle_with_args(np, "phandle-list",
469 "#phandle-cells-missing", 0, &args);
471 EXPECT_END(KERN_INFO,
472 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
474 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
476 EXPECT_BEGIN(KERN_INFO,
477 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
479 rc = of_count_phandle_with_args(np, "phandle-list",
480 "#phandle-cells-missing");
482 EXPECT_END(KERN_INFO,
483 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
485 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
487 /* Check for bad phandle in list */
488 memset(&args, 0, sizeof(args));
490 EXPECT_BEGIN(KERN_INFO,
491 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
493 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
494 "#phandle-cells", 0, &args);
496 EXPECT_END(KERN_INFO,
497 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
499 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
501 EXPECT_BEGIN(KERN_INFO,
502 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
504 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
507 EXPECT_END(KERN_INFO,
508 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
510 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
512 /* Check for incorrectly formed argument list */
513 memset(&args, 0, sizeof(args));
515 EXPECT_BEGIN(KERN_INFO,
516 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
518 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
519 "#phandle-cells", 1, &args);
521 EXPECT_END(KERN_INFO,
522 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
524 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
526 EXPECT_BEGIN(KERN_INFO,
527 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
529 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
532 EXPECT_END(KERN_INFO,
533 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
535 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
538 static void __init of_unittest_parse_phandle_with_args_map(void)
540 struct device_node *np, *p0, *p1, *p2, *p3;
541 struct of_phandle_args args;
544 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
546 pr_err("missing testcase data\n");
550 p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
552 pr_err("missing testcase data\n");
556 p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
558 pr_err("missing testcase data\n");
562 p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
564 pr_err("missing testcase data\n");
568 p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
570 pr_err("missing testcase data\n");
574 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
575 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
577 for (i = 0; i < 8; i++) {
580 memset(&args, 0, sizeof(args));
581 rc = of_parse_phandle_with_args_map(np, "phandle-list",
582 "phandle", i, &args);
584 /* Test the values from tests-phandle.dtsi */
588 passed &= (args.np == p1);
589 passed &= (args.args_count == 1);
590 passed &= (args.args[0] == 1);
594 passed &= (args.np == p3);
595 passed &= (args.args_count == 3);
596 passed &= (args.args[0] == 2);
597 passed &= (args.args[1] == 5);
598 passed &= (args.args[2] == 3);
601 passed &= (rc == -ENOENT);
605 passed &= (args.np == p0);
606 passed &= (args.args_count == 0);
610 passed &= (args.np == p1);
611 passed &= (args.args_count == 1);
612 passed &= (args.args[0] == 3);
616 passed &= (args.np == p0);
617 passed &= (args.args_count == 0);
621 passed &= (args.np == p2);
622 passed &= (args.args_count == 2);
623 passed &= (args.args[0] == 15);
624 passed &= (args.args[1] == 0x20);
627 passed &= (rc == -ENOENT);
633 unittest(passed, "index %i - data error on node %s rc=%i\n",
634 i, args.np->full_name, rc);
637 /* Check for missing list property */
638 memset(&args, 0, sizeof(args));
639 rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
640 "phandle", 0, &args);
641 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
643 /* Check for missing cells,map,mask property */
644 memset(&args, 0, sizeof(args));
646 EXPECT_BEGIN(KERN_INFO,
647 "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
649 rc = of_parse_phandle_with_args_map(np, "phandle-list",
650 "phandle-missing", 0, &args);
651 EXPECT_END(KERN_INFO,
652 "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
654 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
656 /* Check for bad phandle in list */
657 memset(&args, 0, sizeof(args));
659 EXPECT_BEGIN(KERN_INFO,
660 "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
662 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
663 "phandle", 0, &args);
664 EXPECT_END(KERN_INFO,
665 "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
667 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
669 /* Check for incorrectly formed argument list */
670 memset(&args, 0, sizeof(args));
672 EXPECT_BEGIN(KERN_INFO,
673 "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
675 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
676 "phandle", 1, &args);
677 EXPECT_END(KERN_INFO,
678 "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
680 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
683 static void __init of_unittest_property_string(void)
685 const char *strings[4];
686 struct device_node *np;
689 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
691 pr_err("No testcase data in device tree\n");
695 rc = of_property_match_string(np, "phandle-list-names", "first");
696 unittest(rc == 0, "first expected:0 got:%i\n", rc);
697 rc = of_property_match_string(np, "phandle-list-names", "second");
698 unittest(rc == 1, "second expected:1 got:%i\n", rc);
699 rc = of_property_match_string(np, "phandle-list-names", "third");
700 unittest(rc == 2, "third expected:2 got:%i\n", rc);
701 rc = of_property_match_string(np, "phandle-list-names", "fourth");
702 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
703 rc = of_property_match_string(np, "missing-property", "blah");
704 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
705 rc = of_property_match_string(np, "empty-property", "blah");
706 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
707 rc = of_property_match_string(np, "unterminated-string", "blah");
708 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
710 /* of_property_count_strings() tests */
711 rc = of_property_count_strings(np, "string-property");
712 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
713 rc = of_property_count_strings(np, "phandle-list-names");
714 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
715 rc = of_property_count_strings(np, "unterminated-string");
716 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
717 rc = of_property_count_strings(np, "unterminated-string-list");
718 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
720 /* of_property_read_string_index() tests */
721 rc = of_property_read_string_index(np, "string-property", 0, strings);
722 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
724 rc = of_property_read_string_index(np, "string-property", 1, strings);
725 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
726 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
727 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
728 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
729 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
730 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
731 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
733 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
734 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
736 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
737 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
738 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
739 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
741 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
742 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
745 /* of_property_read_string_array() tests */
746 rc = of_property_read_string_array(np, "string-property", strings, 4);
747 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
748 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
749 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
750 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
751 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
752 /* -- An incorrectly formed string should cause a failure */
753 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
754 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
755 /* -- parsing the correctly formed strings should still work: */
757 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
758 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
760 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
761 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
764 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
765 (p1)->value && (p2)->value && \
766 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
767 !strcmp((p1)->name, (p2)->name))
768 static void __init of_unittest_property_copy(void)
770 #ifdef CONFIG_OF_DYNAMIC
771 struct property p1 = { .name = "p1", .length = 0, .value = "" };
772 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
773 struct property *new;
775 new = __of_prop_dup(&p1, GFP_KERNEL);
776 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
781 new = __of_prop_dup(&p2, GFP_KERNEL);
782 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
789 static void __init of_unittest_changeset(void)
791 #ifdef CONFIG_OF_DYNAMIC
792 struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
793 struct property *ppname_n1, pname_n1 = { .name = "name", .length = 3, .value = "n1" };
794 struct property *ppname_n2, pname_n2 = { .name = "name", .length = 3, .value = "n2" };
795 struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
796 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
797 struct property *ppremove;
798 struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
799 struct of_changeset chgset;
801 n1 = __of_node_dup(NULL, "n1");
802 unittest(n1, "testcase setup failure\n");
804 n2 = __of_node_dup(NULL, "n2");
805 unittest(n2, "testcase setup failure\n");
807 n21 = __of_node_dup(NULL, "n21");
808 unittest(n21, "testcase setup failure %p\n", n21);
810 nchangeset = of_find_node_by_path("/testcase-data/changeset");
811 nremove = of_get_child_by_name(nchangeset, "node-remove");
812 unittest(nremove, "testcase setup failure\n");
814 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
815 unittest(ppadd, "testcase setup failure\n");
817 ppname_n1 = __of_prop_dup(&pname_n1, GFP_KERNEL);
818 unittest(ppname_n1, "testcase setup failure\n");
820 ppname_n2 = __of_prop_dup(&pname_n2, GFP_KERNEL);
821 unittest(ppname_n2, "testcase setup failure\n");
823 ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
824 unittest(ppname_n21, "testcase setup failure\n");
826 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
827 unittest(ppupdate, "testcase setup failure\n");
834 ppremove = of_find_property(parent, "prop-remove", NULL);
835 unittest(ppremove, "failed to find removal prop");
837 of_changeset_init(&chgset);
839 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
840 unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
842 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
843 unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
845 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
846 unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
848 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
850 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
851 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
852 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
854 unittest(!of_changeset_apply(&chgset), "apply failed\n");
856 of_node_put(nchangeset);
858 /* Make sure node names are constructed correctly */
859 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
860 "'%pOF' not added\n", n21);
863 unittest(!of_changeset_revert(&chgset), "revert failed\n");
865 of_changeset_destroy(&chgset);
873 static void __init of_unittest_dma_get_max_cpu_address(void)
875 struct device_node *np;
876 phys_addr_t cpu_addr;
878 if (!IS_ENABLED(CONFIG_OF_ADDRESS))
881 np = of_find_node_by_path("/testcase-data/address-tests");
883 pr_err("missing testcase data\n");
887 cpu_addr = of_dma_get_max_cpu_address(np);
888 unittest(cpu_addr == 0x4fffffff,
889 "of_dma_get_max_cpu_address: wrong CPU addr %pad (expecting %x)\n",
890 &cpu_addr, 0x4fffffff);
893 static void __init of_unittest_dma_ranges_one(const char *path,
894 u64 expect_dma_addr, u64 expect_paddr)
896 #ifdef CONFIG_HAS_DMA
897 struct device_node *np;
898 const struct bus_dma_region *map = NULL;
901 np = of_find_node_by_path(path);
903 pr_err("missing testcase data\n");
907 rc = of_dma_get_range(np, &map);
909 unittest(!rc, "of_dma_get_range failed on node %pOF rc=%i\n", np, rc);
914 struct device *dev_bogus;
916 dev_bogus = kzalloc(sizeof(struct device), GFP_KERNEL);
918 unittest(0, "kzalloc() failed\n");
923 dev_bogus->dma_range_map = map;
924 paddr = dma_to_phys(dev_bogus, expect_dma_addr);
925 dma_addr = phys_to_dma(dev_bogus, expect_paddr);
927 unittest(paddr == expect_paddr,
928 "of_dma_get_range: wrong phys addr %pap (expecting %llx) on node %pOF\n",
929 &paddr, expect_paddr, np);
930 unittest(dma_addr == expect_dma_addr,
931 "of_dma_get_range: wrong DMA addr %pad (expecting %llx) on node %pOF\n",
932 &dma_addr, expect_dma_addr, np);
941 static void __init of_unittest_parse_dma_ranges(void)
943 of_unittest_dma_ranges_one("/testcase-data/address-tests/device@70000000",
945 if (IS_ENABLED(CONFIG_ARCH_DMA_ADDR_T_64BIT))
946 of_unittest_dma_ranges_one("/testcase-data/address-tests/bus@80000000/device@1000",
947 0x100000000, 0x20000000);
948 of_unittest_dma_ranges_one("/testcase-data/address-tests/pci@90000000",
949 0x80000000, 0x20000000);
952 static void __init of_unittest_pci_dma_ranges(void)
954 struct device_node *np;
955 struct of_pci_range range;
956 struct of_pci_range_parser parser;
959 if (!IS_ENABLED(CONFIG_PCI))
962 np = of_find_node_by_path("/testcase-data/address-tests/pci@90000000");
964 pr_err("missing testcase data\n");
968 if (of_pci_dma_range_parser_init(&parser, np)) {
969 pr_err("missing dma-ranges property\n");
974 * Get the dma-ranges from the device tree
976 for_each_of_pci_range(&parser, &range) {
978 unittest(range.size == 0x10000000,
979 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
981 unittest(range.cpu_addr == 0x20000000,
982 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
984 unittest(range.pci_addr == 0x80000000,
985 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
988 unittest(range.size == 0x10000000,
989 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
991 unittest(range.cpu_addr == 0x40000000,
992 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
994 unittest(range.pci_addr == 0xc0000000,
995 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1004 static void __init of_unittest_parse_interrupts(void)
1006 struct device_node *np;
1007 struct of_phandle_args args;
1010 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1013 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
1015 pr_err("missing testcase data\n");
1019 for (i = 0; i < 4; i++) {
1022 memset(&args, 0, sizeof(args));
1023 rc = of_irq_parse_one(np, i, &args);
1026 passed &= (args.args_count == 1);
1027 passed &= (args.args[0] == (i + 1));
1029 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1034 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
1036 pr_err("missing testcase data\n");
1040 for (i = 0; i < 4; i++) {
1043 memset(&args, 0, sizeof(args));
1044 rc = of_irq_parse_one(np, i, &args);
1046 /* Test the values from tests-phandle.dtsi */
1050 passed &= (args.args_count == 1);
1051 passed &= (args.args[0] == 9);
1055 passed &= (args.args_count == 3);
1056 passed &= (args.args[0] == 10);
1057 passed &= (args.args[1] == 11);
1058 passed &= (args.args[2] == 12);
1062 passed &= (args.args_count == 2);
1063 passed &= (args.args[0] == 13);
1064 passed &= (args.args[1] == 14);
1068 passed &= (args.args_count == 2);
1069 passed &= (args.args[0] == 15);
1070 passed &= (args.args[1] == 16);
1075 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1081 static void __init of_unittest_parse_interrupts_extended(void)
1083 struct device_node *np;
1084 struct of_phandle_args args;
1087 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1090 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
1092 pr_err("missing testcase data\n");
1096 for (i = 0; i < 7; i++) {
1099 memset(&args, 0, sizeof(args));
1100 rc = of_irq_parse_one(np, i, &args);
1102 /* Test the values from tests-phandle.dtsi */
1106 passed &= (args.args_count == 1);
1107 passed &= (args.args[0] == 1);
1111 passed &= (args.args_count == 3);
1112 passed &= (args.args[0] == 2);
1113 passed &= (args.args[1] == 3);
1114 passed &= (args.args[2] == 4);
1118 passed &= (args.args_count == 2);
1119 passed &= (args.args[0] == 5);
1120 passed &= (args.args[1] == 6);
1124 passed &= (args.args_count == 1);
1125 passed &= (args.args[0] == 9);
1129 passed &= (args.args_count == 3);
1130 passed &= (args.args[0] == 10);
1131 passed &= (args.args[1] == 11);
1132 passed &= (args.args[2] == 12);
1136 passed &= (args.args_count == 2);
1137 passed &= (args.args[0] == 13);
1138 passed &= (args.args[1] == 14);
1142 * Tests child node that is missing property
1143 * #address-cells. See the comments in
1144 * drivers/of/unittest-data/tests-interrupts.dtsi
1145 * nodes intmap1 and interrupts-extended0
1148 passed &= (args.args_count == 1);
1149 passed &= (args.args[0] == 15);
1155 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1161 static const struct of_device_id match_node_table[] = {
1162 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
1163 { .data = "B", .type = "type1", }, /* followed by type alone */
1165 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
1166 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
1167 { .data = "Cc", .name = "name2", .type = "type2", },
1169 { .data = "E", .compatible = "compat3" },
1170 { .data = "G", .compatible = "compat2", },
1171 { .data = "H", .compatible = "compat2", .name = "name5", },
1172 { .data = "I", .compatible = "compat2", .type = "type1", },
1173 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
1174 { .data = "K", .compatible = "compat2", .name = "name9", },
1181 } match_node_tests[] = {
1182 { .path = "/testcase-data/match-node/name0", .data = "A", },
1183 { .path = "/testcase-data/match-node/name1", .data = "B", },
1184 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
1185 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
1186 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
1187 { .path = "/testcase-data/match-node/name3", .data = "E", },
1188 { .path = "/testcase-data/match-node/name4", .data = "G", },
1189 { .path = "/testcase-data/match-node/name5", .data = "H", },
1190 { .path = "/testcase-data/match-node/name6", .data = "G", },
1191 { .path = "/testcase-data/match-node/name7", .data = "I", },
1192 { .path = "/testcase-data/match-node/name8", .data = "J", },
1193 { .path = "/testcase-data/match-node/name9", .data = "K", },
1196 static void __init of_unittest_match_node(void)
1198 struct device_node *np;
1199 const struct of_device_id *match;
1202 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
1203 np = of_find_node_by_path(match_node_tests[i].path);
1205 unittest(0, "missing testcase node %s\n",
1206 match_node_tests[i].path);
1210 match = of_match_node(match_node_table, np);
1212 unittest(0, "%s didn't match anything\n",
1213 match_node_tests[i].path);
1217 if (strcmp(match->data, match_node_tests[i].data) != 0) {
1218 unittest(0, "%s got wrong match. expected %s, got %s\n",
1219 match_node_tests[i].path, match_node_tests[i].data,
1220 (const char *)match->data);
1223 unittest(1, "passed");
1227 static struct resource test_bus_res = DEFINE_RES_MEM(0xfffffff8, 2);
1228 static const struct platform_device_info test_bus_info = {
1229 .name = "unittest-bus",
1231 static void __init of_unittest_platform_populate(void)
1234 struct device_node *np, *child, *grandchild;
1235 struct platform_device *pdev, *test_bus;
1236 const struct of_device_id match[] = {
1237 { .compatible = "test-device", },
1241 np = of_find_node_by_path("/testcase-data");
1242 of_platform_default_populate(np, NULL, NULL);
1244 /* Test that a missing irq domain returns -EPROBE_DEFER */
1245 np = of_find_node_by_path("/testcase-data/testcase-device1");
1246 pdev = of_find_device_by_node(np);
1247 unittest(pdev, "device 1 creation failed\n");
1249 if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1250 irq = platform_get_irq(pdev, 0);
1251 unittest(irq == -EPROBE_DEFER,
1252 "device deferred probe failed - %d\n", irq);
1254 /* Test that a parsing failure does not return -EPROBE_DEFER */
1255 np = of_find_node_by_path("/testcase-data/testcase-device2");
1256 pdev = of_find_device_by_node(np);
1257 unittest(pdev, "device 2 creation failed\n");
1259 EXPECT_BEGIN(KERN_INFO,
1260 "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1262 irq = platform_get_irq(pdev, 0);
1264 EXPECT_END(KERN_INFO,
1265 "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1267 unittest(irq < 0 && irq != -EPROBE_DEFER,
1268 "device parsing error failed - %d\n", irq);
1271 np = of_find_node_by_path("/testcase-data/platform-tests");
1272 unittest(np, "No testcase data in device tree\n");
1276 test_bus = platform_device_register_full(&test_bus_info);
1277 rc = PTR_ERR_OR_ZERO(test_bus);
1278 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1283 test_bus->dev.of_node = np;
1286 * Add a dummy resource to the test bus node after it is
1287 * registered to catch problems with un-inserted resources. The
1288 * DT code doesn't insert the resources, and it has caused the
1289 * kernel to oops in the past. This makes sure the same bug
1290 * doesn't crop up again.
1292 platform_device_add_resources(test_bus, &test_bus_res, 1);
1294 of_platform_populate(np, match, NULL, &test_bus->dev);
1295 for_each_child_of_node(np, child) {
1296 for_each_child_of_node(child, grandchild) {
1297 pdev = of_find_device_by_node(grandchild);
1299 "Could not create device for node '%pOFn'\n",
1301 platform_device_put(pdev);
1305 of_platform_depopulate(&test_bus->dev);
1306 for_each_child_of_node(np, child) {
1307 for_each_child_of_node(child, grandchild)
1308 unittest(!of_find_device_by_node(grandchild),
1309 "device didn't get destroyed '%pOFn'\n",
1313 platform_device_unregister(test_bus);
1318 * update_node_properties - adds the properties
1319 * of np into dup node (present in live tree) and
1320 * updates parent of children of np to dup.
1322 * @np: node whose properties are being added to the live tree
1323 * @dup: node present in live tree to be updated
1325 static void update_node_properties(struct device_node *np,
1326 struct device_node *dup)
1328 struct property *prop;
1329 struct property *save_next;
1330 struct device_node *child;
1333 for_each_child_of_node(np, child)
1334 child->parent = dup;
1337 * "unittest internal error: unable to add testdata property"
1339 * If this message reports a property in node '/__symbols__' then
1340 * the respective unittest overlay contains a label that has the
1341 * same name as a label in the live devicetree. The label will
1342 * be in the live devicetree only if the devicetree source was
1343 * compiled with the '-@' option. If you encounter this error,
1344 * please consider renaming __all__ of the labels in the unittest
1345 * overlay dts files with an odd prefix that is unlikely to be
1346 * used in a real devicetree.
1350 * open code for_each_property_of_node() because of_add_property()
1351 * sets prop->next to NULL
1353 for (prop = np->properties; prop != NULL; prop = save_next) {
1354 save_next = prop->next;
1355 ret = of_add_property(dup, prop);
1357 if (ret == -EEXIST && !strcmp(prop->name, "name"))
1359 pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1366 * attach_node_and_children - attaches nodes
1367 * and its children to live tree.
1368 * CAUTION: misleading function name - if node @np already exists in
1369 * the live tree then children of @np are *not* attached to the live
1370 * tree. This works for the current test devicetree nodes because such
1371 * nodes do not have child nodes.
1373 * @np: Node to attach to live tree
1375 static void attach_node_and_children(struct device_node *np)
1377 struct device_node *next, *dup, *child;
1378 unsigned long flags;
1379 const char *full_name;
1381 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1383 if (!strcmp(full_name, "/__local_fixups__") ||
1384 !strcmp(full_name, "/__fixups__")) {
1389 dup = of_find_node_by_path(full_name);
1392 update_node_properties(np, dup);
1399 mutex_lock(&of_mutex);
1400 raw_spin_lock_irqsave(&devtree_lock, flags);
1401 np->sibling = np->parent->child;
1402 np->parent->child = np;
1403 of_node_clear_flag(np, OF_DETACHED);
1404 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1406 __of_attach_node_sysfs(np);
1407 mutex_unlock(&of_mutex);
1410 next = child->sibling;
1411 attach_node_and_children(child);
1417 * unittest_data_add - Reads, copies data from
1418 * linked tree and attaches it to the live tree
1420 static int __init unittest_data_add(void)
1422 void *unittest_data;
1423 void *unittest_data_align;
1424 struct device_node *unittest_data_node = NULL, *np;
1426 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1427 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1429 extern uint8_t __dtb_testcases_begin[];
1430 extern uint8_t __dtb_testcases_end[];
1431 const int size = __dtb_testcases_end - __dtb_testcases_begin;
1436 pr_warn("%s: testcases is empty\n", __func__);
1441 unittest_data = kmalloc(size + FDT_ALIGN_SIZE, GFP_KERNEL);
1445 unittest_data_align = PTR_ALIGN(unittest_data, FDT_ALIGN_SIZE);
1446 memcpy(unittest_data_align, __dtb_testcases_begin, size);
1448 ret = of_fdt_unflatten_tree(unittest_data_align, NULL, &unittest_data_node);
1450 pr_warn("%s: unflatten testcases tree failed\n", __func__);
1451 kfree(unittest_data);
1454 if (!unittest_data_node) {
1455 pr_warn("%s: testcases tree is empty\n", __func__);
1456 kfree(unittest_data);
1461 * This lock normally encloses of_resolve_phandles()
1463 of_overlay_mutex_lock();
1465 rc = of_resolve_phandles(unittest_data_node);
1467 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1468 of_overlay_mutex_unlock();
1473 of_root = unittest_data_node;
1474 for_each_of_allnodes(np)
1475 __of_attach_node_sysfs(np);
1476 of_aliases = of_find_node_by_path("/aliases");
1477 of_chosen = of_find_node_by_path("/chosen");
1478 of_overlay_mutex_unlock();
1482 EXPECT_BEGIN(KERN_INFO,
1483 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1485 /* attach the sub-tree to live tree */
1486 np = unittest_data_node->child;
1488 struct device_node *next = np->sibling;
1490 np->parent = of_root;
1491 attach_node_and_children(np);
1495 EXPECT_END(KERN_INFO,
1496 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1498 of_overlay_mutex_unlock();
1503 #ifdef CONFIG_OF_OVERLAY
1504 static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id);
1506 static int unittest_probe(struct platform_device *pdev)
1508 struct device *dev = &pdev->dev;
1509 struct device_node *np = dev->of_node;
1512 dev_err(dev, "No OF data for device\n");
1517 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1519 of_platform_populate(np, NULL, NULL, &pdev->dev);
1524 static int unittest_remove(struct platform_device *pdev)
1526 struct device *dev = &pdev->dev;
1527 struct device_node *np = dev->of_node;
1529 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1533 static const struct of_device_id unittest_match[] = {
1534 { .compatible = "unittest", },
1538 static struct platform_driver unittest_driver = {
1539 .probe = unittest_probe,
1540 .remove = unittest_remove,
1543 .of_match_table = of_match_ptr(unittest_match),
1547 /* get the platform device instantiated at the path */
1548 static struct platform_device *of_path_to_platform_device(const char *path)
1550 struct device_node *np;
1551 struct platform_device *pdev;
1553 np = of_find_node_by_path(path);
1557 pdev = of_find_device_by_node(np);
1563 /* find out if a platform device exists at that path */
1564 static int of_path_platform_device_exists(const char *path)
1566 struct platform_device *pdev;
1568 pdev = of_path_to_platform_device(path);
1569 platform_device_put(pdev);
1570 return pdev != NULL;
1573 #ifdef CONFIG_OF_GPIO
1575 struct unittest_gpio_dev {
1576 struct gpio_chip chip;
1579 static int unittest_gpio_chip_request_count;
1580 static int unittest_gpio_probe_count;
1581 static int unittest_gpio_probe_pass_count;
1583 static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
1585 unittest_gpio_chip_request_count++;
1587 pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
1588 unittest_gpio_chip_request_count);
1592 static int unittest_gpio_probe(struct platform_device *pdev)
1594 struct unittest_gpio_dev *devptr;
1597 unittest_gpio_probe_count++;
1599 devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
1603 platform_set_drvdata(pdev, devptr);
1605 devptr->chip.of_node = pdev->dev.of_node;
1606 devptr->chip.label = "of-unittest-gpio";
1607 devptr->chip.base = -1; /* dynamic allocation */
1608 devptr->chip.ngpio = 5;
1609 devptr->chip.request = unittest_gpio_chip_request;
1611 ret = gpiochip_add_data(&devptr->chip, NULL);
1614 "gpiochip_add_data() for node @%pOF failed, ret = %d\n", devptr->chip.of_node, ret);
1617 unittest_gpio_probe_pass_count++;
1621 static int unittest_gpio_remove(struct platform_device *pdev)
1623 struct unittest_gpio_dev *gdev = platform_get_drvdata(pdev);
1624 struct device *dev = &pdev->dev;
1625 struct device_node *np = pdev->dev.of_node;
1627 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1632 if (gdev->chip.base != -1)
1633 gpiochip_remove(&gdev->chip);
1635 platform_set_drvdata(pdev, NULL);
1641 static const struct of_device_id unittest_gpio_id[] = {
1642 { .compatible = "unittest-gpio", },
1646 static struct platform_driver unittest_gpio_driver = {
1647 .probe = unittest_gpio_probe,
1648 .remove = unittest_gpio_remove,
1650 .name = "unittest-gpio",
1651 .of_match_table = of_match_ptr(unittest_gpio_id),
1655 static void __init of_unittest_overlay_gpio(void)
1657 int chip_request_count;
1658 int probe_pass_count;
1662 * tests: apply overlays before registering driver
1663 * Similar to installing a driver as a module, the
1664 * driver is registered after applying the overlays.
1666 * The overlays are applied by overlay_data_apply()
1667 * instead of of_unittest_apply_overlay() so that they
1668 * will not be tracked. Thus they will not be removed
1669 * by of_unittest_remove_tracked_overlays().
1671 * - apply overlay_gpio_01
1672 * - apply overlay_gpio_02a
1673 * - apply overlay_gpio_02b
1676 * register driver will result in
1677 * - probe and processing gpio hog for overlay_gpio_01
1678 * - probe for overlay_gpio_02a
1679 * - processing gpio for overlay_gpio_02b
1682 probe_pass_count = unittest_gpio_probe_pass_count;
1683 chip_request_count = unittest_gpio_chip_request_count;
1686 * overlay_gpio_01 contains gpio node and child gpio hog node
1687 * overlay_gpio_02a contains gpio node
1688 * overlay_gpio_02b contains child gpio hog node
1691 unittest(overlay_data_apply("overlay_gpio_01", NULL),
1692 "Adding overlay 'overlay_gpio_01' failed\n");
1694 unittest(overlay_data_apply("overlay_gpio_02a", NULL),
1695 "Adding overlay 'overlay_gpio_02a' failed\n");
1697 unittest(overlay_data_apply("overlay_gpio_02b", NULL),
1698 "Adding overlay 'overlay_gpio_02b' failed\n");
1701 * messages are the result of the probes, after the
1702 * driver is registered
1705 EXPECT_BEGIN(KERN_INFO,
1706 "gpio-<<int>> (line-B-input): hogged as input\n");
1708 EXPECT_BEGIN(KERN_INFO,
1709 "gpio-<<int>> (line-A-input): hogged as input\n");
1711 ret = platform_driver_register(&unittest_gpio_driver);
1712 if (unittest(ret == 0, "could not register unittest gpio driver\n"))
1715 EXPECT_END(KERN_INFO,
1716 "gpio-<<int>> (line-A-input): hogged as input\n");
1717 EXPECT_END(KERN_INFO,
1718 "gpio-<<int>> (line-B-input): hogged as input\n");
1720 unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
1721 "unittest_gpio_probe() failed or not called\n");
1723 unittest(chip_request_count + 2 == unittest_gpio_chip_request_count,
1724 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1725 unittest_gpio_chip_request_count - chip_request_count);
1728 * tests: apply overlays after registering driver
1730 * Similar to a driver built-in to the kernel, the
1731 * driver is registered before applying the overlays.
1733 * overlay_gpio_03 contains gpio node and child gpio hog node
1735 * - apply overlay_gpio_03
1737 * apply overlay will result in
1738 * - probe and processing gpio hog.
1741 probe_pass_count = unittest_gpio_probe_pass_count;
1742 chip_request_count = unittest_gpio_chip_request_count;
1744 EXPECT_BEGIN(KERN_INFO,
1745 "gpio-<<int>> (line-D-input): hogged as input\n");
1747 /* overlay_gpio_03 contains gpio node and child gpio hog node */
1749 unittest(overlay_data_apply("overlay_gpio_03", NULL),
1750 "Adding overlay 'overlay_gpio_03' failed\n");
1752 EXPECT_END(KERN_INFO,
1753 "gpio-<<int>> (line-D-input): hogged as input\n");
1755 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1756 "unittest_gpio_probe() failed or not called\n");
1758 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1759 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1760 unittest_gpio_chip_request_count - chip_request_count);
1763 * overlay_gpio_04a contains gpio node
1765 * - apply overlay_gpio_04a
1767 * apply the overlay will result in
1768 * - probe for overlay_gpio_04a
1771 probe_pass_count = unittest_gpio_probe_pass_count;
1772 chip_request_count = unittest_gpio_chip_request_count;
1774 /* overlay_gpio_04a contains gpio node */
1776 unittest(overlay_data_apply("overlay_gpio_04a", NULL),
1777 "Adding overlay 'overlay_gpio_04a' failed\n");
1779 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1780 "unittest_gpio_probe() failed or not called\n");
1783 * overlay_gpio_04b contains child gpio hog node
1785 * - apply overlay_gpio_04b
1787 * apply the overlay will result in
1788 * - processing gpio for overlay_gpio_04b
1791 EXPECT_BEGIN(KERN_INFO,
1792 "gpio-<<int>> (line-C-input): hogged as input\n");
1794 /* overlay_gpio_04b contains child gpio hog node */
1796 unittest(overlay_data_apply("overlay_gpio_04b", NULL),
1797 "Adding overlay 'overlay_gpio_04b' failed\n");
1799 EXPECT_END(KERN_INFO,
1800 "gpio-<<int>> (line-C-input): hogged as input\n");
1802 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1803 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1804 unittest_gpio_chip_request_count - chip_request_count);
1809 static void __init of_unittest_overlay_gpio(void)
1816 #if IS_BUILTIN(CONFIG_I2C)
1818 /* get the i2c client device instantiated at the path */
1819 static struct i2c_client *of_path_to_i2c_client(const char *path)
1821 struct device_node *np;
1822 struct i2c_client *client;
1824 np = of_find_node_by_path(path);
1828 client = of_find_i2c_device_by_node(np);
1834 /* find out if a i2c client device exists at that path */
1835 static int of_path_i2c_client_exists(const char *path)
1837 struct i2c_client *client;
1839 client = of_path_to_i2c_client(path);
1841 put_device(&client->dev);
1842 return client != NULL;
1845 static int of_path_i2c_client_exists(const char *path)
1856 static int of_path_device_type_exists(const char *path,
1857 enum overlay_type ovtype)
1861 return of_path_platform_device_exists(path);
1863 return of_path_i2c_client_exists(path);
1868 static const char *unittest_path(int nr, enum overlay_type ovtype)
1871 static char buf[256];
1875 base = "/testcase-data/overlay-node/test-bus";
1878 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1884 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1885 buf[sizeof(buf) - 1] = '\0';
1889 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1893 path = unittest_path(unittest_nr, ovtype);
1897 return of_path_platform_device_exists(path);
1899 return of_path_i2c_client_exists(path);
1904 static const char *overlay_name_from_nr(int nr)
1906 static char buf[256];
1908 snprintf(buf, sizeof(buf) - 1,
1910 buf[sizeof(buf) - 1] = '\0';
1915 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1917 #define MAX_TRACK_OVCS_IDS 256
1919 static int track_ovcs_id[MAX_TRACK_OVCS_IDS];
1920 static int track_ovcs_id_overlay_nr[MAX_TRACK_OVCS_IDS];
1921 static int track_ovcs_id_cnt;
1923 static void of_unittest_track_overlay(int ovcs_id, int overlay_nr)
1925 if (WARN_ON(track_ovcs_id_cnt >= MAX_TRACK_OVCS_IDS))
1928 track_ovcs_id[track_ovcs_id_cnt] = ovcs_id;
1929 track_ovcs_id_overlay_nr[track_ovcs_id_cnt] = overlay_nr;
1930 track_ovcs_id_cnt++;
1933 static void of_unittest_untrack_overlay(int ovcs_id)
1935 if (WARN_ON(track_ovcs_id_cnt < 1))
1938 track_ovcs_id_cnt--;
1940 /* If out of synch then test is broken. Do not try to recover. */
1941 WARN_ON(track_ovcs_id[track_ovcs_id_cnt] != ovcs_id);
1944 static void of_unittest_remove_tracked_overlays(void)
1946 int ret, ovcs_id, overlay_nr, save_ovcs_id;
1947 const char *overlay_name;
1949 while (track_ovcs_id_cnt > 0) {
1951 ovcs_id = track_ovcs_id[track_ovcs_id_cnt - 1];
1952 overlay_nr = track_ovcs_id_overlay_nr[track_ovcs_id_cnt - 1];
1953 save_ovcs_id = ovcs_id;
1954 ret = of_overlay_remove(&ovcs_id);
1955 if (ret == -ENODEV) {
1956 overlay_name = overlay_name_from_nr(overlay_nr);
1957 pr_warn("%s: of_overlay_remove() for overlay \"%s\" failed, ret = %d\n",
1958 __func__, overlay_name, ret);
1960 of_unittest_untrack_overlay(save_ovcs_id);
1965 static int __init of_unittest_apply_overlay(int overlay_nr, int *ovcs_id)
1968 * The overlay will be tracked, thus it will be removed
1969 * by of_unittest_remove_tracked_overlays().
1972 const char *overlay_name;
1974 overlay_name = overlay_name_from_nr(overlay_nr);
1976 if (!overlay_data_apply(overlay_name, ovcs_id)) {
1977 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
1980 of_unittest_track_overlay(*ovcs_id, overlay_nr);
1985 /* apply an overlay while checking before and after states */
1986 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1987 int unittest_nr, int before, int after,
1988 enum overlay_type ovtype)
1992 /* unittest device must not be in before state */
1993 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1994 unittest(0, "%s with device @\"%s\" %s\n",
1995 overlay_name_from_nr(overlay_nr),
1996 unittest_path(unittest_nr, ovtype),
1997 !before ? "enabled" : "disabled");
2002 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2004 /* of_unittest_apply_overlay already called unittest() */
2008 /* unittest device must be to set to after state */
2009 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2010 unittest(0, "%s failed to create @\"%s\" %s\n",
2011 overlay_name_from_nr(overlay_nr),
2012 unittest_path(unittest_nr, ovtype),
2013 !after ? "enabled" : "disabled");
2020 /* apply an overlay and then revert it while checking before, after states */
2021 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
2022 int unittest_nr, int before, int after,
2023 enum overlay_type ovtype)
2025 int ret, ovcs_id, save_ovcs_id;
2027 /* unittest device must be in before state */
2028 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2029 unittest(0, "%s with device @\"%s\" %s\n",
2030 overlay_name_from_nr(overlay_nr),
2031 unittest_path(unittest_nr, ovtype),
2032 !before ? "enabled" : "disabled");
2036 /* apply the overlay */
2038 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2040 /* of_unittest_apply_overlay already called unittest() */
2044 /* unittest device must be in after state */
2045 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2046 unittest(0, "%s failed to create @\"%s\" %s\n",
2047 overlay_name_from_nr(overlay_nr),
2048 unittest_path(unittest_nr, ovtype),
2049 !after ? "enabled" : "disabled");
2053 save_ovcs_id = ovcs_id;
2054 ret = of_overlay_remove(&ovcs_id);
2056 unittest(0, "%s failed to be destroyed @\"%s\"\n",
2057 overlay_name_from_nr(overlay_nr),
2058 unittest_path(unittest_nr, ovtype));
2061 of_unittest_untrack_overlay(save_ovcs_id);
2063 /* unittest device must be again in before state */
2064 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
2065 unittest(0, "%s with device @\"%s\" %s\n",
2066 overlay_name_from_nr(overlay_nr),
2067 unittest_path(unittest_nr, ovtype),
2068 !before ? "enabled" : "disabled");
2075 /* test activation of device */
2076 static void __init of_unittest_overlay_0(void)
2080 EXPECT_BEGIN(KERN_INFO,
2081 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2083 /* device should enable */
2084 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
2086 EXPECT_END(KERN_INFO,
2087 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2092 unittest(1, "overlay test %d passed\n", 0);
2095 /* test deactivation of device */
2096 static void __init of_unittest_overlay_1(void)
2100 EXPECT_BEGIN(KERN_INFO,
2101 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2103 /* device should disable */
2104 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
2106 EXPECT_END(KERN_INFO,
2107 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2112 unittest(1, "overlay test %d passed\n", 1);
2116 /* test activation of device */
2117 static void __init of_unittest_overlay_2(void)
2121 EXPECT_BEGIN(KERN_INFO,
2122 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2124 /* device should enable */
2125 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
2127 EXPECT_END(KERN_INFO,
2128 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2132 unittest(1, "overlay test %d passed\n", 2);
2135 /* test deactivation of device */
2136 static void __init of_unittest_overlay_3(void)
2140 EXPECT_BEGIN(KERN_INFO,
2141 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2143 /* device should disable */
2144 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
2146 EXPECT_END(KERN_INFO,
2147 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2152 unittest(1, "overlay test %d passed\n", 3);
2155 /* test activation of a full device node */
2156 static void __init of_unittest_overlay_4(void)
2158 /* device should disable */
2159 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
2162 unittest(1, "overlay test %d passed\n", 4);
2165 /* test overlay apply/revert sequence */
2166 static void __init of_unittest_overlay_5(void)
2170 EXPECT_BEGIN(KERN_INFO,
2171 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2173 /* device should disable */
2174 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
2176 EXPECT_END(KERN_INFO,
2177 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2182 unittest(1, "overlay test %d passed\n", 5);
2185 /* test overlay application in sequence */
2186 static void __init of_unittest_overlay_6(void)
2188 int i, save_ovcs_id[2], ovcs_id;
2189 int overlay_nr = 6, unittest_nr = 6;
2190 int before = 0, after = 1;
2191 const char *overlay_name;
2195 /* unittest device must be in before state */
2196 for (i = 0; i < 2; i++) {
2197 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2199 unittest(0, "%s with device @\"%s\" %s\n",
2200 overlay_name_from_nr(overlay_nr + i),
2201 unittest_path(unittest_nr + i,
2203 !before ? "enabled" : "disabled");
2208 /* apply the overlays */
2210 EXPECT_BEGIN(KERN_INFO,
2211 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2213 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2215 ret = overlay_data_apply(overlay_name, &ovcs_id);
2218 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2221 save_ovcs_id[0] = ovcs_id;
2222 of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2224 EXPECT_END(KERN_INFO,
2225 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2227 EXPECT_BEGIN(KERN_INFO,
2228 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2230 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2232 ret = overlay_data_apply(overlay_name, &ovcs_id);
2235 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2238 save_ovcs_id[1] = ovcs_id;
2239 of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2241 EXPECT_END(KERN_INFO,
2242 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2245 for (i = 0; i < 2; i++) {
2246 /* unittest device must be in after state */
2247 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2249 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
2250 overlay_name_from_nr(overlay_nr + i),
2251 unittest_path(unittest_nr + i,
2253 !after ? "enabled" : "disabled");
2258 for (i = 1; i >= 0; i--) {
2259 ovcs_id = save_ovcs_id[i];
2260 if (of_overlay_remove(&ovcs_id)) {
2261 unittest(0, "%s failed destroy @\"%s\"\n",
2262 overlay_name_from_nr(overlay_nr + i),
2263 unittest_path(unittest_nr + i,
2267 of_unittest_untrack_overlay(save_ovcs_id[i]);
2270 for (i = 0; i < 2; i++) {
2271 /* unittest device must be again in before state */
2272 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2274 unittest(0, "%s with device @\"%s\" %s\n",
2275 overlay_name_from_nr(overlay_nr + i),
2276 unittest_path(unittest_nr + i,
2278 !before ? "enabled" : "disabled");
2283 unittest(1, "overlay test %d passed\n", 6);
2287 /* test overlay application in sequence */
2288 static void __init of_unittest_overlay_8(void)
2290 int i, save_ovcs_id[2], ovcs_id;
2291 int overlay_nr = 8, unittest_nr = 8;
2292 const char *overlay_name;
2295 /* we don't care about device state in this test */
2297 EXPECT_BEGIN(KERN_INFO,
2298 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2300 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2302 ret = overlay_data_apply(overlay_name, &ovcs_id);
2304 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2306 EXPECT_END(KERN_INFO,
2307 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2312 save_ovcs_id[0] = ovcs_id;
2313 of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2315 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2317 EXPECT_BEGIN(KERN_INFO,
2318 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2320 /* apply the overlays */
2321 ret = overlay_data_apply(overlay_name, &ovcs_id);
2323 EXPECT_END(KERN_INFO,
2324 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2327 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2331 save_ovcs_id[1] = ovcs_id;
2332 of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2334 /* now try to remove first overlay (it should fail) */
2335 ovcs_id = save_ovcs_id[0];
2337 EXPECT_BEGIN(KERN_INFO,
2338 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2340 EXPECT_BEGIN(KERN_INFO,
2341 "OF: overlay: overlay #6 is not topmost");
2343 ret = of_overlay_remove(&ovcs_id);
2345 EXPECT_END(KERN_INFO,
2346 "OF: overlay: overlay #6 is not topmost");
2348 EXPECT_END(KERN_INFO,
2349 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2353 * Should never get here. If we do, expect a lot of
2354 * subsequent tracking and overlay removal related errors.
2356 unittest(0, "%s was destroyed @\"%s\"\n",
2357 overlay_name_from_nr(overlay_nr + 0),
2358 unittest_path(unittest_nr,
2363 /* removing them in order should work */
2364 for (i = 1; i >= 0; i--) {
2365 ovcs_id = save_ovcs_id[i];
2366 if (of_overlay_remove(&ovcs_id)) {
2367 unittest(0, "%s not destroyed @\"%s\"\n",
2368 overlay_name_from_nr(overlay_nr + i),
2369 unittest_path(unittest_nr,
2373 of_unittest_untrack_overlay(save_ovcs_id[i]);
2376 unittest(1, "overlay test %d passed\n", 8);
2379 /* test insertion of a bus with parent devices */
2380 static void __init of_unittest_overlay_10(void)
2385 /* device should disable */
2386 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
2388 if (unittest(ret == 0,
2389 "overlay test %d failed; overlay application\n", 10))
2392 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
2393 unittest_path(10, PDEV_OVERLAY));
2394 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
2397 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
2400 unittest(ret, "overlay test %d failed; no child device\n", 10);
2403 /* test insertion of a bus with parent devices (and revert) */
2404 static void __init of_unittest_overlay_11(void)
2408 /* device should disable */
2409 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
2412 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2415 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2417 struct unittest_i2c_bus_data {
2418 struct platform_device *pdev;
2419 struct i2c_adapter adap;
2422 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2423 struct i2c_msg *msgs, int num)
2425 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2432 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2434 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2437 static const struct i2c_algorithm unittest_i2c_algo = {
2438 .master_xfer = unittest_i2c_master_xfer,
2439 .functionality = unittest_i2c_functionality,
2442 static int unittest_i2c_bus_probe(struct platform_device *pdev)
2444 struct device *dev = &pdev->dev;
2445 struct device_node *np = dev->of_node;
2446 struct unittest_i2c_bus_data *std;
2447 struct i2c_adapter *adap;
2451 dev_err(dev, "No OF data for device\n");
2456 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2458 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
2462 /* link them together */
2464 platform_set_drvdata(pdev, std);
2467 i2c_set_adapdata(adap, std);
2469 strlcpy(adap->name, pdev->name, sizeof(adap->name));
2470 adap->class = I2C_CLASS_DEPRECATED;
2471 adap->algo = &unittest_i2c_algo;
2472 adap->dev.parent = dev;
2473 adap->dev.of_node = dev->of_node;
2474 adap->timeout = 5 * HZ;
2477 ret = i2c_add_numbered_adapter(adap);
2479 dev_err(dev, "Failed to add I2C adapter\n");
2486 static int unittest_i2c_bus_remove(struct platform_device *pdev)
2488 struct device *dev = &pdev->dev;
2489 struct device_node *np = dev->of_node;
2490 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
2492 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2493 i2c_del_adapter(&std->adap);
2498 static const struct of_device_id unittest_i2c_bus_match[] = {
2499 { .compatible = "unittest-i2c-bus", },
2503 static struct platform_driver unittest_i2c_bus_driver = {
2504 .probe = unittest_i2c_bus_probe,
2505 .remove = unittest_i2c_bus_remove,
2507 .name = "unittest-i2c-bus",
2508 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
2512 static int unittest_i2c_dev_probe(struct i2c_client *client,
2513 const struct i2c_device_id *id)
2515 struct device *dev = &client->dev;
2516 struct device_node *np = client->dev.of_node;
2519 dev_err(dev, "No OF node\n");
2523 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2528 static int unittest_i2c_dev_remove(struct i2c_client *client)
2530 struct device *dev = &client->dev;
2531 struct device_node *np = client->dev.of_node;
2533 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2537 static const struct i2c_device_id unittest_i2c_dev_id[] = {
2538 { .name = "unittest-i2c-dev" },
2542 static struct i2c_driver unittest_i2c_dev_driver = {
2544 .name = "unittest-i2c-dev",
2546 .probe = unittest_i2c_dev_probe,
2547 .remove = unittest_i2c_dev_remove,
2548 .id_table = unittest_i2c_dev_id,
2551 #if IS_BUILTIN(CONFIG_I2C_MUX)
2553 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
2558 static int unittest_i2c_mux_probe(struct i2c_client *client,
2559 const struct i2c_device_id *id)
2562 struct device *dev = &client->dev;
2563 struct i2c_adapter *adap = client->adapter;
2564 struct device_node *np = client->dev.of_node, *child;
2565 struct i2c_mux_core *muxc;
2568 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2571 dev_err(dev, "No OF node\n");
2576 for_each_child_of_node(np, child) {
2577 if (of_property_read_u32(child, "reg", ®))
2579 if (max_reg == (u32)-1 || reg > max_reg)
2582 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
2584 dev_err(dev, "No channels\n");
2588 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
2589 unittest_i2c_mux_select_chan, NULL);
2592 for (i = 0; i < nchans; i++) {
2593 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
2594 dev_err(dev, "Failed to register mux #%d\n", i);
2595 i2c_mux_del_adapters(muxc);
2600 i2c_set_clientdata(client, muxc);
2605 static int unittest_i2c_mux_remove(struct i2c_client *client)
2607 struct device *dev = &client->dev;
2608 struct device_node *np = client->dev.of_node;
2609 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
2611 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2612 i2c_mux_del_adapters(muxc);
2616 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2617 { .name = "unittest-i2c-mux" },
2621 static struct i2c_driver unittest_i2c_mux_driver = {
2623 .name = "unittest-i2c-mux",
2625 .probe = unittest_i2c_mux_probe,
2626 .remove = unittest_i2c_mux_remove,
2627 .id_table = unittest_i2c_mux_id,
2632 static int of_unittest_overlay_i2c_init(void)
2636 ret = i2c_add_driver(&unittest_i2c_dev_driver);
2637 if (unittest(ret == 0,
2638 "could not register unittest i2c device driver\n"))
2641 ret = platform_driver_register(&unittest_i2c_bus_driver);
2643 if (unittest(ret == 0,
2644 "could not register unittest i2c bus driver\n"))
2647 #if IS_BUILTIN(CONFIG_I2C_MUX)
2649 EXPECT_BEGIN(KERN_INFO,
2650 "i2c i2c-1: Added multiplexed i2c bus 2");
2652 ret = i2c_add_driver(&unittest_i2c_mux_driver);
2654 EXPECT_END(KERN_INFO,
2655 "i2c i2c-1: Added multiplexed i2c bus 2");
2657 if (unittest(ret == 0,
2658 "could not register unittest i2c mux driver\n"))
2665 static void of_unittest_overlay_i2c_cleanup(void)
2667 #if IS_BUILTIN(CONFIG_I2C_MUX)
2668 i2c_del_driver(&unittest_i2c_mux_driver);
2670 platform_driver_unregister(&unittest_i2c_bus_driver);
2671 i2c_del_driver(&unittest_i2c_dev_driver);
2674 static void __init of_unittest_overlay_i2c_12(void)
2678 /* device should enable */
2679 EXPECT_BEGIN(KERN_INFO,
2680 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2682 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
2684 EXPECT_END(KERN_INFO,
2685 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2690 unittest(1, "overlay test %d passed\n", 12);
2693 /* test deactivation of device */
2694 static void __init of_unittest_overlay_i2c_13(void)
2698 EXPECT_BEGIN(KERN_INFO,
2699 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2701 /* device should disable */
2702 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
2704 EXPECT_END(KERN_INFO,
2705 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2710 unittest(1, "overlay test %d passed\n", 13);
2713 /* just check for i2c mux existence */
2714 static void of_unittest_overlay_i2c_14(void)
2718 static void __init of_unittest_overlay_i2c_15(void)
2722 /* device should enable */
2723 EXPECT_BEGIN(KERN_INFO,
2724 "i2c i2c-1: Added multiplexed i2c bus 3");
2726 ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
2728 EXPECT_END(KERN_INFO,
2729 "i2c i2c-1: Added multiplexed i2c bus 3");
2734 unittest(1, "overlay test %d passed\n", 15);
2739 static inline void of_unittest_overlay_i2c_14(void) { }
2740 static inline void of_unittest_overlay_i2c_15(void) { }
2744 static int of_notify(struct notifier_block *nb, unsigned long action,
2747 struct of_overlay_notify_data *nd = arg;
2748 struct device_node *found;
2752 * For overlay_16 .. overlay_19, check that returning an error
2753 * works for each of the actions by setting an arbitrary return
2754 * error number that matches the test number. e.g. for unittest16,
2755 * ret = -EBUSY which is -16.
2757 * OVERLAY_INFO() for the overlays is declared to expect the same
2758 * error number, so overlay_data_apply() will return no error.
2760 * overlay_20 will return NOTIFY_DONE
2764 of_node_get(nd->overlay);
2768 case OF_OVERLAY_PRE_APPLY:
2769 found = of_find_node_by_name(nd->overlay, "test-unittest16");
2776 case OF_OVERLAY_POST_APPLY:
2777 found = of_find_node_by_name(nd->overlay, "test-unittest17");
2784 case OF_OVERLAY_PRE_REMOVE:
2785 found = of_find_node_by_name(nd->overlay, "test-unittest18");
2792 case OF_OVERLAY_POST_REMOVE:
2793 found = of_find_node_by_name(nd->overlay, "test-unittest19");
2800 default: /* should not happen */
2801 of_node_put(nd->overlay);
2807 return notifier_from_errno(ret);
2812 static struct notifier_block of_nb = {
2813 .notifier_call = of_notify,
2816 static void __init of_unittest_overlay_notify(void)
2821 ret = of_overlay_notifier_register(&of_nb);
2823 "of_overlay_notifier_register() failed, ret = %d\n", ret);
2828 * The overlays are applied by overlay_data_apply()
2829 * instead of of_unittest_apply_overlay() so that they
2830 * will not be tracked. Thus they will not be removed
2831 * by of_unittest_remove_tracked_overlays().
2833 * Applying overlays 16 - 19 will each trigger an error for a
2834 * different action in of_notify().
2836 * Applying overlay 20 will not trigger any error in of_notify().
2839 /* --- overlay 16 --- */
2841 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
2843 unittest(overlay_data_apply("overlay_16", &ovcs_id),
2844 "test OF_OVERLAY_PRE_APPLY notify injected error\n");
2846 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
2848 unittest(ovcs_id, "ovcs_id not created for overlay_16\n");
2850 /* --- overlay 17 --- */
2852 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
2854 unittest(overlay_data_apply("overlay_17", &ovcs_id),
2855 "test OF_OVERLAY_POST_APPLY notify injected error\n");
2857 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
2859 unittest(ovcs_id, "ovcs_id not created for overlay_17\n");
2862 ret = of_overlay_remove(&ovcs_id);
2864 "overlay_17 of_overlay_remove(), ret = %d\n", ret);
2867 /* --- overlay 18 --- */
2869 unittest(overlay_data_apply("overlay_18", &ovcs_id),
2870 "OF_OVERLAY_PRE_REMOVE notify injected error\n");
2872 unittest(ovcs_id, "ovcs_id not created for overlay_18\n");
2875 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
2877 ret = of_overlay_remove(&ovcs_id);
2878 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
2879 if (ret == -EXDEV) {
2881 * change set ovcs_id should still exist
2883 unittest(1, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE\n");
2885 unittest(0, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE not returned\n");
2888 unittest(1, "ovcs_id not created for overlay_18\n");
2891 unittest(ovcs_id, "ovcs_id removed for overlay_18\n");
2893 /* --- overlay 19 --- */
2895 unittest(overlay_data_apply("overlay_19", &ovcs_id),
2896 "OF_OVERLAY_POST_REMOVE notify injected error\n");
2898 unittest(ovcs_id, "ovcs_id not created for overlay_19\n");
2901 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
2902 ret = of_overlay_remove(&ovcs_id);
2903 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
2905 unittest(1, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE\n");
2907 unittest(0, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE not returned\n");
2909 unittest(1, "ovcs_id removed for overlay_19\n");
2912 unittest(!ovcs_id, "changeset ovcs_id = %d not removed for overlay_19\n",
2915 /* --- overlay 20 --- */
2917 unittest(overlay_data_apply("overlay_20", &ovcs_id),
2918 "overlay notify no injected error\n");
2921 ret = of_overlay_remove(&ovcs_id);
2923 unittest(1, "overlay_20 failed to be destroyed, ret = %d\n",
2926 unittest(1, "ovcs_id not created for overlay_20\n");
2929 unittest(!of_overlay_notifier_unregister(&of_nb),
2930 "of_overlay_notifier_unregister() failed, ret = %d\n", ret);
2933 static void __init of_unittest_overlay(void)
2935 struct device_node *bus_np = NULL;
2937 if (platform_driver_register(&unittest_driver)) {
2938 unittest(0, "could not register unittest driver\n");
2942 bus_np = of_find_node_by_path(bus_path);
2943 if (bus_np == NULL) {
2944 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2948 if (of_platform_default_populate(bus_np, NULL, NULL)) {
2949 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2953 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2954 unittest(0, "could not find unittest0 @ \"%s\"\n",
2955 unittest_path(100, PDEV_OVERLAY));
2959 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2960 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2961 unittest_path(101, PDEV_OVERLAY));
2965 unittest(1, "basic infrastructure of overlays passed");
2967 /* tests in sequence */
2968 of_unittest_overlay_0();
2969 of_unittest_overlay_1();
2970 of_unittest_overlay_2();
2971 of_unittest_overlay_3();
2972 of_unittest_overlay_4();
2973 of_unittest_overlay_5();
2974 of_unittest_overlay_6();
2975 of_unittest_overlay_8();
2977 of_unittest_overlay_10();
2978 of_unittest_overlay_11();
2980 #if IS_BUILTIN(CONFIG_I2C)
2981 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2984 of_unittest_overlay_i2c_12();
2985 of_unittest_overlay_i2c_13();
2986 of_unittest_overlay_i2c_14();
2987 of_unittest_overlay_i2c_15();
2989 of_unittest_overlay_i2c_cleanup();
2992 of_unittest_overlay_gpio();
2994 of_unittest_remove_tracked_overlays();
2996 of_unittest_overlay_notify();
2999 of_node_put(bus_np);
3003 static inline void __init of_unittest_overlay(void) { }
3006 #ifdef CONFIG_OF_OVERLAY
3009 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
3010 * in scripts/Makefile.lib
3013 #define OVERLAY_INFO_EXTERN(name) \
3014 extern uint8_t __dtb_##name##_begin[]; \
3015 extern uint8_t __dtb_##name##_end[]
3017 #define OVERLAY_INFO(overlay_name, expected) \
3018 { .dtb_begin = __dtb_##overlay_name##_begin, \
3019 .dtb_end = __dtb_##overlay_name##_end, \
3020 .expected_result = expected, \
3021 .name = #overlay_name, \
3024 struct overlay_info {
3027 int expected_result;
3032 OVERLAY_INFO_EXTERN(overlay_base);
3033 OVERLAY_INFO_EXTERN(overlay);
3034 OVERLAY_INFO_EXTERN(overlay_0);
3035 OVERLAY_INFO_EXTERN(overlay_1);
3036 OVERLAY_INFO_EXTERN(overlay_2);
3037 OVERLAY_INFO_EXTERN(overlay_3);
3038 OVERLAY_INFO_EXTERN(overlay_4);
3039 OVERLAY_INFO_EXTERN(overlay_5);
3040 OVERLAY_INFO_EXTERN(overlay_6);
3041 OVERLAY_INFO_EXTERN(overlay_7);
3042 OVERLAY_INFO_EXTERN(overlay_8);
3043 OVERLAY_INFO_EXTERN(overlay_9);
3044 OVERLAY_INFO_EXTERN(overlay_10);
3045 OVERLAY_INFO_EXTERN(overlay_11);
3046 OVERLAY_INFO_EXTERN(overlay_12);
3047 OVERLAY_INFO_EXTERN(overlay_13);
3048 OVERLAY_INFO_EXTERN(overlay_15);
3049 OVERLAY_INFO_EXTERN(overlay_16);
3050 OVERLAY_INFO_EXTERN(overlay_17);
3051 OVERLAY_INFO_EXTERN(overlay_18);
3052 OVERLAY_INFO_EXTERN(overlay_19);
3053 OVERLAY_INFO_EXTERN(overlay_20);
3054 OVERLAY_INFO_EXTERN(overlay_gpio_01);
3055 OVERLAY_INFO_EXTERN(overlay_gpio_02a);
3056 OVERLAY_INFO_EXTERN(overlay_gpio_02b);
3057 OVERLAY_INFO_EXTERN(overlay_gpio_03);
3058 OVERLAY_INFO_EXTERN(overlay_gpio_04a);
3059 OVERLAY_INFO_EXTERN(overlay_gpio_04b);
3060 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
3061 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
3062 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
3063 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
3065 /* entries found by name */
3066 static struct overlay_info overlays[] = {
3067 OVERLAY_INFO(overlay_base, -9999),
3068 OVERLAY_INFO(overlay, 0),
3069 OVERLAY_INFO(overlay_0, 0),
3070 OVERLAY_INFO(overlay_1, 0),
3071 OVERLAY_INFO(overlay_2, 0),
3072 OVERLAY_INFO(overlay_3, 0),
3073 OVERLAY_INFO(overlay_4, 0),
3074 OVERLAY_INFO(overlay_5, 0),
3075 OVERLAY_INFO(overlay_6, 0),
3076 OVERLAY_INFO(overlay_7, 0),
3077 OVERLAY_INFO(overlay_8, 0),
3078 OVERLAY_INFO(overlay_9, 0),
3079 OVERLAY_INFO(overlay_10, 0),
3080 OVERLAY_INFO(overlay_11, 0),
3081 OVERLAY_INFO(overlay_12, 0),
3082 OVERLAY_INFO(overlay_13, 0),
3083 OVERLAY_INFO(overlay_15, 0),
3084 OVERLAY_INFO(overlay_16, -EBUSY),
3085 OVERLAY_INFO(overlay_17, -EEXIST),
3086 OVERLAY_INFO(overlay_18, 0),
3087 OVERLAY_INFO(overlay_19, 0),
3088 OVERLAY_INFO(overlay_20, 0),
3089 OVERLAY_INFO(overlay_gpio_01, 0),
3090 OVERLAY_INFO(overlay_gpio_02a, 0),
3091 OVERLAY_INFO(overlay_gpio_02b, 0),
3092 OVERLAY_INFO(overlay_gpio_03, 0),
3093 OVERLAY_INFO(overlay_gpio_04a, 0),
3094 OVERLAY_INFO(overlay_gpio_04b, 0),
3095 OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL),
3096 OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL),
3097 OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
3098 OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
3100 {.dtb_begin = NULL, .dtb_end = NULL, .expected_result = 0, .name = NULL}
3103 static struct device_node *overlay_base_root;
3105 static void * __init dt_alloc_memory(u64 size, u64 align)
3107 void *ptr = memblock_alloc(size, align);
3110 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
3111 __func__, size, align);
3117 * Create base device tree for the overlay unittest.
3119 * This is called from very early boot code.
3121 * Do as much as possible the same way as done in __unflatten_device_tree
3122 * and other early boot steps for the normal FDT so that the overlay base
3123 * unflattened tree will have the same characteristics as the real tree
3124 * (such as having memory allocated by the early allocator). The goal
3125 * is to test "the real thing" as much as possible, and test "test setup
3126 * code" as little as possible.
3128 * Have to stop before resolving phandles, because that uses kmalloc.
3130 void __init unittest_unflatten_overlay_base(void)
3132 struct overlay_info *info;
3137 const char *overlay_name = "overlay_base";
3139 for (info = overlays; info && info->name; info++) {
3140 if (!strcmp(overlay_name, info->name)) {
3146 pr_err("no overlay data for %s\n", overlay_name);
3150 info = &overlays[0];
3152 if (info->expected_result != -9999) {
3153 pr_err("No dtb 'overlay_base' to attach\n");
3157 data_size = info->dtb_end - info->dtb_begin;
3159 pr_err("No dtb 'overlay_base' to attach\n");
3163 size = fdt_totalsize(info->dtb_begin);
3164 if (size != data_size) {
3165 pr_err("dtb 'overlay_base' header totalsize != actual size");
3169 new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
3171 pr_err("alloc for dtb 'overlay_base' failed");
3175 memcpy(new_fdt, info->dtb_begin, size);
3177 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
3178 dt_alloc_memory, true);
3182 * The purpose of of_unittest_overlay_data_add is to add an
3183 * overlay in the normal fashion. This is a test of the whole
3184 * picture, instead of testing individual elements.
3186 * A secondary purpose is to be able to verify that the contents of
3187 * /proc/device-tree/ contains the updated structure and values from
3188 * the overlay. That must be verified separately in user space.
3190 * Return 0 on unexpected error.
3192 static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id)
3194 struct overlay_info *info;
3199 for (info = overlays; info && info->name; info++) {
3200 if (!strcmp(overlay_name, info->name)) {
3206 pr_err("no overlay data for %s\n", overlay_name);
3210 size = info->dtb_end - info->dtb_begin;
3212 pr_err("no overlay data for %s\n", overlay_name);
3214 ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->ovcs_id);
3216 *ovcs_id = info->ovcs_id;
3220 pr_debug("%s applied\n", overlay_name);
3223 if (ret != info->expected_result)
3224 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
3225 info->expected_result, ret, overlay_name);
3227 return (ret == info->expected_result);
3231 * The purpose of of_unittest_overlay_high_level is to add an overlay
3232 * in the normal fashion. This is a test of the whole picture,
3233 * instead of individual elements.
3235 * The first part of the function is _not_ normal overlay usage; it is
3236 * finishing splicing the base overlay device tree into the live tree.
3238 static __init void of_unittest_overlay_high_level(void)
3240 struct device_node *last_sibling;
3241 struct device_node *np;
3242 struct device_node *of_symbols;
3243 struct device_node *overlay_base_symbols;
3244 struct device_node **pprev;
3245 struct property *prop;
3248 if (!overlay_base_root) {
3249 unittest(0, "overlay_base_root not initialized\n");
3254 * Could not fixup phandles in unittest_unflatten_overlay_base()
3255 * because kmalloc() was not yet available.
3257 of_overlay_mutex_lock();
3258 of_resolve_phandles(overlay_base_root);
3259 of_overlay_mutex_unlock();
3263 * do not allow overlay_base to duplicate any node already in
3264 * tree, this greatly simplifies the code
3268 * remove overlay_base_root node "__local_fixups", after
3269 * being used by of_resolve_phandles()
3271 pprev = &overlay_base_root->child;
3272 for (np = overlay_base_root->child; np; np = np->sibling) {
3273 if (of_node_name_eq(np, "__local_fixups__")) {
3274 *pprev = np->sibling;
3277 pprev = &np->sibling;
3280 /* remove overlay_base_root node "__symbols__" if in live tree */
3281 of_symbols = of_get_child_by_name(of_root, "__symbols__");
3283 /* will have to graft properties from node into live tree */
3284 pprev = &overlay_base_root->child;
3285 for (np = overlay_base_root->child; np; np = np->sibling) {
3286 if (of_node_name_eq(np, "__symbols__")) {
3287 overlay_base_symbols = np;
3288 *pprev = np->sibling;
3291 pprev = &np->sibling;
3295 for_each_child_of_node(overlay_base_root, np) {
3296 struct device_node *base_child;
3297 for_each_child_of_node(of_root, base_child) {
3298 if (!strcmp(np->full_name, base_child->full_name)) {
3299 unittest(0, "illegal node name in overlay_base %pOFn",
3302 of_node_put(base_child);
3309 * overlay 'overlay_base' is not allowed to have root
3310 * properties, so only need to splice nodes into main device tree.
3312 * root node of *overlay_base_root will not be freed, it is lost
3316 for (np = overlay_base_root->child; np; np = np->sibling)
3317 np->parent = of_root;
3319 mutex_lock(&of_mutex);
3321 for (last_sibling = np = of_root->child; np; np = np->sibling)
3325 last_sibling->sibling = overlay_base_root->child;
3327 of_root->child = overlay_base_root->child;
3329 for_each_of_allnodes_from(overlay_base_root, np)
3330 __of_attach_node_sysfs(np);
3333 struct property *new_prop;
3334 for_each_property_of_node(overlay_base_symbols, prop) {
3336 new_prop = __of_prop_dup(prop, GFP_KERNEL);
3338 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
3342 if (__of_add_property(of_symbols, new_prop)) {
3343 kfree(new_prop->name);
3344 kfree(new_prop->value);
3346 /* "name" auto-generated by unflatten */
3347 if (!strcmp(prop->name, "name"))
3349 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
3353 if (__of_add_property_sysfs(of_symbols, new_prop)) {
3354 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
3361 mutex_unlock(&of_mutex);
3364 /* now do the normal overlay usage test */
3366 EXPECT_BEGIN(KERN_ERR,
3367 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3368 EXPECT_BEGIN(KERN_ERR,
3369 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3370 EXPECT_BEGIN(KERN_ERR,
3371 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3372 EXPECT_BEGIN(KERN_ERR,
3373 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3374 EXPECT_BEGIN(KERN_ERR,
3375 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3376 EXPECT_BEGIN(KERN_ERR,
3377 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3378 EXPECT_BEGIN(KERN_ERR,
3379 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3380 EXPECT_BEGIN(KERN_ERR,
3381 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3382 EXPECT_BEGIN(KERN_ERR,
3383 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3384 EXPECT_BEGIN(KERN_ERR,
3385 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3386 EXPECT_BEGIN(KERN_ERR,
3387 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3389 ret = overlay_data_apply("overlay", NULL);
3391 EXPECT_END(KERN_ERR,
3392 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3393 EXPECT_END(KERN_ERR,
3394 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3395 EXPECT_END(KERN_ERR,
3396 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3397 EXPECT_END(KERN_ERR,
3398 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3399 EXPECT_END(KERN_ERR,
3400 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3401 EXPECT_END(KERN_ERR,
3402 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3403 EXPECT_END(KERN_ERR,
3404 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3405 EXPECT_END(KERN_ERR,
3406 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3407 EXPECT_END(KERN_ERR,
3408 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3409 EXPECT_END(KERN_ERR,
3410 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3411 EXPECT_END(KERN_ERR,
3412 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3414 unittest(ret, "Adding overlay 'overlay' failed\n");
3416 EXPECT_BEGIN(KERN_ERR,
3417 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3418 EXPECT_BEGIN(KERN_ERR,
3419 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3421 unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
3422 "Adding overlay 'overlay_bad_add_dup_node' failed\n");
3424 EXPECT_END(KERN_ERR,
3425 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3426 EXPECT_END(KERN_ERR,
3427 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3429 EXPECT_BEGIN(KERN_ERR,
3430 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3431 EXPECT_BEGIN(KERN_ERR,
3432 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3433 EXPECT_BEGIN(KERN_ERR,
3434 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3436 unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
3437 "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
3439 EXPECT_END(KERN_ERR,
3440 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3441 EXPECT_END(KERN_ERR,
3442 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3443 EXPECT_END(KERN_ERR,
3444 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3446 unittest(overlay_data_apply("overlay_bad_phandle", NULL),
3447 "Adding overlay 'overlay_bad_phandle' failed\n");
3449 unittest(overlay_data_apply("overlay_bad_symbol", NULL),
3450 "Adding overlay 'overlay_bad_symbol' failed\n");
3455 mutex_unlock(&of_mutex);
3460 static inline __init void of_unittest_overlay_high_level(void) {}
3464 static int __init of_unittest(void)
3466 struct device_node *np;
3469 pr_info("start of unittest - you will see error messages\n");
3471 /* adding data for unittest */
3473 if (IS_ENABLED(CONFIG_UML))
3474 unittest_unflatten_overlay_base();
3476 res = unittest_data_add();
3480 of_aliases = of_find_node_by_path("/aliases");
3482 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
3484 pr_info("No testcase data in device tree; not running tests\n");
3489 of_unittest_check_tree_linkage();
3490 of_unittest_check_phandles();
3491 of_unittest_find_node_by_name();
3492 of_unittest_dynamic();
3493 of_unittest_parse_phandle_with_args();
3494 of_unittest_parse_phandle_with_args_map();
3495 of_unittest_printf();
3496 of_unittest_property_string();
3497 of_unittest_property_copy();
3498 of_unittest_changeset();
3499 of_unittest_parse_interrupts();
3500 of_unittest_parse_interrupts_extended();
3501 of_unittest_dma_get_max_cpu_address();
3502 of_unittest_parse_dma_ranges();
3503 of_unittest_pci_dma_ranges();
3504 of_unittest_match_node();
3505 of_unittest_platform_populate();
3506 of_unittest_overlay();
3508 /* Double check linkage after removing testcase data */
3509 of_unittest_check_tree_linkage();
3511 of_unittest_overlay_high_level();
3513 pr_info("end of unittest - %i passed, %i failed\n",
3514 unittest_results.passed, unittest_results.failed);
3518 late_initcall(of_unittest);