gpio: rcar: Fix runtime PM imbalance on error
[linux/fpc-iii.git] / drivers / of / unittest.c
blob7e27670c36163f0c0e82ed254806b11d843b8a9b
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Self tests for device tree subsystem
4 */
6 #define pr_fmt(fmt) "### dt-test ### " fmt
8 #include <linux/memblock.h>
9 #include <linux/clk.h>
10 #include <linux/err.h>
11 #include <linux/errno.h>
12 #include <linux/hashtable.h>
13 #include <linux/libfdt.h>
14 #include <linux/of.h>
15 #include <linux/of_address.h>
16 #include <linux/of_fdt.h>
17 #include <linux/of_irq.h>
18 #include <linux/of_platform.h>
19 #include <linux/list.h>
20 #include <linux/mutex.h>
21 #include <linux/slab.h>
22 #include <linux/device.h>
23 #include <linux/platform_device.h>
25 #include <linux/i2c.h>
26 #include <linux/i2c-mux.h>
27 #include <linux/gpio/driver.h>
29 #include <linux/bitops.h>
31 #include "of_private.h"
33 static struct unittest_results {
34 int passed;
35 int failed;
36 } unittest_results;
38 #define unittest(result, fmt, ...) ({ \
39 bool failed = !(result); \
40 if (failed) { \
41 unittest_results.failed++; \
42 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
43 } else { \
44 unittest_results.passed++; \
45 pr_debug("pass %s():%i\n", __func__, __LINE__); \
46 } \
47 failed; \
51 * Expected message may have a message level other than KERN_INFO.
52 * Print the expected message only if the current loglevel will allow
53 * the actual message to print.
55 * Do not use EXPECT_BEGIN() or EXPECT_END() for messages generated by
56 * pr_debug().
58 #define EXPECT_BEGIN(level, fmt, ...) \
59 printk(level pr_fmt("EXPECT \\ : ") fmt, ##__VA_ARGS__)
61 #define EXPECT_END(level, fmt, ...) \
62 printk(level pr_fmt("EXPECT / : ") fmt, ##__VA_ARGS__)
64 static void __init of_unittest_find_node_by_name(void)
66 struct device_node *np;
67 const char *options, *name;
69 np = of_find_node_by_path("/testcase-data");
70 name = kasprintf(GFP_KERNEL, "%pOF", np);
71 unittest(np && !strcmp("/testcase-data", name),
72 "find /testcase-data failed\n");
73 of_node_put(np);
74 kfree(name);
76 /* Test if trailing '/' works */
77 np = of_find_node_by_path("/testcase-data/");
78 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
80 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
81 name = kasprintf(GFP_KERNEL, "%pOF", np);
82 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
83 "find /testcase-data/phandle-tests/consumer-a failed\n");
84 of_node_put(np);
85 kfree(name);
87 np = of_find_node_by_path("testcase-alias");
88 name = kasprintf(GFP_KERNEL, "%pOF", np);
89 unittest(np && !strcmp("/testcase-data", name),
90 "find testcase-alias failed\n");
91 of_node_put(np);
92 kfree(name);
94 /* Test if trailing '/' works on aliases */
95 np = of_find_node_by_path("testcase-alias/");
96 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
98 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
99 name = kasprintf(GFP_KERNEL, "%pOF", np);
100 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
101 "find testcase-alias/phandle-tests/consumer-a failed\n");
102 of_node_put(np);
103 kfree(name);
105 np = of_find_node_by_path("/testcase-data/missing-path");
106 unittest(!np, "non-existent path returned node %pOF\n", np);
107 of_node_put(np);
109 np = of_find_node_by_path("missing-alias");
110 unittest(!np, "non-existent alias returned node %pOF\n", np);
111 of_node_put(np);
113 np = of_find_node_by_path("testcase-alias/missing-path");
114 unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
115 of_node_put(np);
117 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
118 unittest(np && !strcmp("testoption", options),
119 "option path test failed\n");
120 of_node_put(np);
122 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
123 unittest(np && !strcmp("test/option", options),
124 "option path test, subcase #1 failed\n");
125 of_node_put(np);
127 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
128 unittest(np && !strcmp("test/option", options),
129 "option path test, subcase #2 failed\n");
130 of_node_put(np);
132 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
133 unittest(np, "NULL option path test failed\n");
134 of_node_put(np);
136 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
137 &options);
138 unittest(np && !strcmp("testaliasoption", options),
139 "option alias path test failed\n");
140 of_node_put(np);
142 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
143 &options);
144 unittest(np && !strcmp("test/alias/option", options),
145 "option alias path test, subcase #1 failed\n");
146 of_node_put(np);
148 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
149 unittest(np, "NULL option alias path test failed\n");
150 of_node_put(np);
152 options = "testoption";
153 np = of_find_node_opts_by_path("testcase-alias", &options);
154 unittest(np && !options, "option clearing test failed\n");
155 of_node_put(np);
157 options = "testoption";
158 np = of_find_node_opts_by_path("/", &options);
159 unittest(np && !options, "option clearing root node test failed\n");
160 of_node_put(np);
163 static void __init of_unittest_dynamic(void)
165 struct device_node *np;
166 struct property *prop;
168 np = of_find_node_by_path("/testcase-data");
169 if (!np) {
170 pr_err("missing testcase data\n");
171 return;
174 /* Array of 4 properties for the purpose of testing */
175 prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
176 if (!prop) {
177 unittest(0, "kzalloc() failed\n");
178 return;
181 /* Add a new property - should pass*/
182 prop->name = "new-property";
183 prop->value = "new-property-data";
184 prop->length = strlen(prop->value) + 1;
185 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
187 /* Try to add an existing property - should fail */
188 prop++;
189 prop->name = "new-property";
190 prop->value = "new-property-data-should-fail";
191 prop->length = strlen(prop->value) + 1;
192 unittest(of_add_property(np, prop) != 0,
193 "Adding an existing property should have failed\n");
195 /* Try to modify an existing property - should pass */
196 prop->value = "modify-property-data-should-pass";
197 prop->length = strlen(prop->value) + 1;
198 unittest(of_update_property(np, prop) == 0,
199 "Updating an existing property should have passed\n");
201 /* Try to modify non-existent property - should pass*/
202 prop++;
203 prop->name = "modify-property";
204 prop->value = "modify-missing-property-data-should-pass";
205 prop->length = strlen(prop->value) + 1;
206 unittest(of_update_property(np, prop) == 0,
207 "Updating a missing property should have passed\n");
209 /* Remove property - should pass */
210 unittest(of_remove_property(np, prop) == 0,
211 "Removing a property should have passed\n");
213 /* Adding very large property - should pass */
214 prop++;
215 prop->name = "large-property-PAGE_SIZEx8";
216 prop->length = PAGE_SIZE * 8;
217 prop->value = kzalloc(prop->length, GFP_KERNEL);
218 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
219 if (prop->value)
220 unittest(of_add_property(np, prop) == 0,
221 "Adding a large property should have passed\n");
224 static int __init of_unittest_check_node_linkage(struct device_node *np)
226 struct device_node *child;
227 int count = 0, rc;
229 for_each_child_of_node(np, child) {
230 if (child->parent != np) {
231 pr_err("Child node %pOFn links to wrong parent %pOFn\n",
232 child, np);
233 rc = -EINVAL;
234 goto put_child;
237 rc = of_unittest_check_node_linkage(child);
238 if (rc < 0)
239 goto put_child;
240 count += rc;
243 return count + 1;
244 put_child:
245 of_node_put(child);
246 return rc;
249 static void __init of_unittest_check_tree_linkage(void)
251 struct device_node *np;
252 int allnode_count = 0, child_count;
254 if (!of_root)
255 return;
257 for_each_of_allnodes(np)
258 allnode_count++;
259 child_count = of_unittest_check_node_linkage(of_root);
261 unittest(child_count > 0, "Device node data structure is corrupted\n");
262 unittest(child_count == allnode_count,
263 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
264 allnode_count, child_count);
265 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
268 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
269 const char *expected)
271 unsigned char *buf;
272 int buf_size;
273 int size, i;
275 buf_size = strlen(expected) + 10;
276 buf = kmalloc(buf_size, GFP_KERNEL);
277 if (!buf)
278 return;
280 /* Baseline; check conversion with a large size limit */
281 memset(buf, 0xff, buf_size);
282 size = snprintf(buf, buf_size - 2, fmt, np);
284 /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
285 unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
286 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
287 fmt, expected, buf);
289 /* Make sure length limits work */
290 size++;
291 for (i = 0; i < 2; i++, size--) {
292 /* Clear the buffer, and make sure it works correctly still */
293 memset(buf, 0xff, buf_size);
294 snprintf(buf, size+1, fmt, np);
295 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
296 "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
297 size, fmt, expected, buf);
299 kfree(buf);
302 static void __init of_unittest_printf(void)
304 struct device_node *np;
305 const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
306 char phandle_str[16] = "";
308 np = of_find_node_by_path(full_name);
309 if (!np) {
310 unittest(np, "testcase data missing\n");
311 return;
314 num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
316 of_unittest_printf_one(np, "%pOF", full_name);
317 of_unittest_printf_one(np, "%pOFf", full_name);
318 of_unittest_printf_one(np, "%pOFn", "dev");
319 of_unittest_printf_one(np, "%2pOFn", "dev");
320 of_unittest_printf_one(np, "%5pOFn", " dev");
321 of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
322 of_unittest_printf_one(np, "%pOFp", phandle_str);
323 of_unittest_printf_one(np, "%pOFP", "dev@100");
324 of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
325 of_unittest_printf_one(np, "%10pOFP", " dev@100");
326 of_unittest_printf_one(np, "%-10pOFP", "dev@100 ");
327 of_unittest_printf_one(of_root, "%pOFP", "/");
328 of_unittest_printf_one(np, "%pOFF", "----");
329 of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
330 of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
331 of_unittest_printf_one(np, "%pOFc", "test-sub-device");
332 of_unittest_printf_one(np, "%pOFC",
333 "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
336 struct node_hash {
337 struct hlist_node node;
338 struct device_node *np;
341 static DEFINE_HASHTABLE(phandle_ht, 8);
342 static void __init of_unittest_check_phandles(void)
344 struct device_node *np;
345 struct node_hash *nh;
346 struct hlist_node *tmp;
347 int i, dup_count = 0, phandle_count = 0;
349 for_each_of_allnodes(np) {
350 if (!np->phandle)
351 continue;
353 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
354 if (nh->np->phandle == np->phandle) {
355 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
356 np->phandle, nh->np, np);
357 dup_count++;
358 break;
362 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
363 if (!nh)
364 return;
366 nh->np = np;
367 hash_add(phandle_ht, &nh->node, np->phandle);
368 phandle_count++;
370 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
371 dup_count, phandle_count);
373 /* Clean up */
374 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
375 hash_del(&nh->node);
376 kfree(nh);
380 static void __init of_unittest_parse_phandle_with_args(void)
382 struct device_node *np;
383 struct of_phandle_args args;
384 int i, rc;
386 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
387 if (!np) {
388 pr_err("missing testcase data\n");
389 return;
392 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
393 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
395 for (i = 0; i < 8; i++) {
396 bool passed = true;
398 memset(&args, 0, sizeof(args));
399 rc = of_parse_phandle_with_args(np, "phandle-list",
400 "#phandle-cells", i, &args);
402 /* Test the values from tests-phandle.dtsi */
403 switch (i) {
404 case 0:
405 passed &= !rc;
406 passed &= (args.args_count == 1);
407 passed &= (args.args[0] == (i + 1));
408 break;
409 case 1:
410 passed &= !rc;
411 passed &= (args.args_count == 2);
412 passed &= (args.args[0] == (i + 1));
413 passed &= (args.args[1] == 0);
414 break;
415 case 2:
416 passed &= (rc == -ENOENT);
417 break;
418 case 3:
419 passed &= !rc;
420 passed &= (args.args_count == 3);
421 passed &= (args.args[0] == (i + 1));
422 passed &= (args.args[1] == 4);
423 passed &= (args.args[2] == 3);
424 break;
425 case 4:
426 passed &= !rc;
427 passed &= (args.args_count == 2);
428 passed &= (args.args[0] == (i + 1));
429 passed &= (args.args[1] == 100);
430 break;
431 case 5:
432 passed &= !rc;
433 passed &= (args.args_count == 0);
434 break;
435 case 6:
436 passed &= !rc;
437 passed &= (args.args_count == 1);
438 passed &= (args.args[0] == (i + 1));
439 break;
440 case 7:
441 passed &= (rc == -ENOENT);
442 break;
443 default:
444 passed = false;
447 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
448 i, args.np, rc);
451 /* Check for missing list property */
452 memset(&args, 0, sizeof(args));
453 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
454 "#phandle-cells", 0, &args);
455 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
456 rc = of_count_phandle_with_args(np, "phandle-list-missing",
457 "#phandle-cells");
458 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
460 /* Check for missing cells property */
461 memset(&args, 0, sizeof(args));
463 EXPECT_BEGIN(KERN_INFO,
464 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
466 rc = of_parse_phandle_with_args(np, "phandle-list",
467 "#phandle-cells-missing", 0, &args);
469 EXPECT_END(KERN_INFO,
470 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
472 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
474 EXPECT_BEGIN(KERN_INFO,
475 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
477 rc = of_count_phandle_with_args(np, "phandle-list",
478 "#phandle-cells-missing");
480 EXPECT_END(KERN_INFO,
481 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
483 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
485 /* Check for bad phandle in list */
486 memset(&args, 0, sizeof(args));
488 EXPECT_BEGIN(KERN_INFO,
489 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
491 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
492 "#phandle-cells", 0, &args);
494 EXPECT_END(KERN_INFO,
495 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
497 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
499 EXPECT_BEGIN(KERN_INFO,
500 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
502 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
503 "#phandle-cells");
505 EXPECT_END(KERN_INFO,
506 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
508 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
510 /* Check for incorrectly formed argument list */
511 memset(&args, 0, sizeof(args));
513 EXPECT_BEGIN(KERN_INFO,
514 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
516 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
517 "#phandle-cells", 1, &args);
519 EXPECT_END(KERN_INFO,
520 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
522 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
524 EXPECT_BEGIN(KERN_INFO,
525 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
527 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
528 "#phandle-cells");
530 EXPECT_END(KERN_INFO,
531 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
533 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
536 static void __init of_unittest_parse_phandle_with_args_map(void)
538 struct device_node *np, *p0, *p1, *p2, *p3;
539 struct of_phandle_args args;
540 int i, rc;
542 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
543 if (!np) {
544 pr_err("missing testcase data\n");
545 return;
548 p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
549 if (!p0) {
550 pr_err("missing testcase data\n");
551 return;
554 p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
555 if (!p1) {
556 pr_err("missing testcase data\n");
557 return;
560 p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
561 if (!p2) {
562 pr_err("missing testcase data\n");
563 return;
566 p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
567 if (!p3) {
568 pr_err("missing testcase data\n");
569 return;
572 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
573 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
575 for (i = 0; i < 8; i++) {
576 bool passed = true;
578 memset(&args, 0, sizeof(args));
579 rc = of_parse_phandle_with_args_map(np, "phandle-list",
580 "phandle", i, &args);
582 /* Test the values from tests-phandle.dtsi */
583 switch (i) {
584 case 0:
585 passed &= !rc;
586 passed &= (args.np == p1);
587 passed &= (args.args_count == 1);
588 passed &= (args.args[0] == 1);
589 break;
590 case 1:
591 passed &= !rc;
592 passed &= (args.np == p3);
593 passed &= (args.args_count == 3);
594 passed &= (args.args[0] == 2);
595 passed &= (args.args[1] == 5);
596 passed &= (args.args[2] == 3);
597 break;
598 case 2:
599 passed &= (rc == -ENOENT);
600 break;
601 case 3:
602 passed &= !rc;
603 passed &= (args.np == p0);
604 passed &= (args.args_count == 0);
605 break;
606 case 4:
607 passed &= !rc;
608 passed &= (args.np == p1);
609 passed &= (args.args_count == 1);
610 passed &= (args.args[0] == 3);
611 break;
612 case 5:
613 passed &= !rc;
614 passed &= (args.np == p0);
615 passed &= (args.args_count == 0);
616 break;
617 case 6:
618 passed &= !rc;
619 passed &= (args.np == p2);
620 passed &= (args.args_count == 2);
621 passed &= (args.args[0] == 15);
622 passed &= (args.args[1] == 0x20);
623 break;
624 case 7:
625 passed &= (rc == -ENOENT);
626 break;
627 default:
628 passed = false;
631 unittest(passed, "index %i - data error on node %s rc=%i\n",
632 i, args.np->full_name, rc);
635 /* Check for missing list property */
636 memset(&args, 0, sizeof(args));
637 rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
638 "phandle", 0, &args);
639 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
641 /* Check for missing cells,map,mask property */
642 memset(&args, 0, sizeof(args));
644 EXPECT_BEGIN(KERN_INFO,
645 "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
647 rc = of_parse_phandle_with_args_map(np, "phandle-list",
648 "phandle-missing", 0, &args);
649 EXPECT_END(KERN_INFO,
650 "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
652 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
654 /* Check for bad phandle in list */
655 memset(&args, 0, sizeof(args));
657 EXPECT_BEGIN(KERN_INFO,
658 "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
660 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
661 "phandle", 0, &args);
662 EXPECT_END(KERN_INFO,
663 "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
665 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
667 /* Check for incorrectly formed argument list */
668 memset(&args, 0, sizeof(args));
670 EXPECT_BEGIN(KERN_INFO,
671 "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found -1");
673 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
674 "phandle", 1, &args);
675 EXPECT_END(KERN_INFO,
676 "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found -1");
678 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
681 static void __init of_unittest_property_string(void)
683 const char *strings[4];
684 struct device_node *np;
685 int rc;
687 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
688 if (!np) {
689 pr_err("No testcase data in device tree\n");
690 return;
693 rc = of_property_match_string(np, "phandle-list-names", "first");
694 unittest(rc == 0, "first expected:0 got:%i\n", rc);
695 rc = of_property_match_string(np, "phandle-list-names", "second");
696 unittest(rc == 1, "second expected:1 got:%i\n", rc);
697 rc = of_property_match_string(np, "phandle-list-names", "third");
698 unittest(rc == 2, "third expected:2 got:%i\n", rc);
699 rc = of_property_match_string(np, "phandle-list-names", "fourth");
700 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
701 rc = of_property_match_string(np, "missing-property", "blah");
702 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
703 rc = of_property_match_string(np, "empty-property", "blah");
704 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
705 rc = of_property_match_string(np, "unterminated-string", "blah");
706 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
708 /* of_property_count_strings() tests */
709 rc = of_property_count_strings(np, "string-property");
710 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
711 rc = of_property_count_strings(np, "phandle-list-names");
712 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
713 rc = of_property_count_strings(np, "unterminated-string");
714 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
715 rc = of_property_count_strings(np, "unterminated-string-list");
716 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
718 /* of_property_read_string_index() tests */
719 rc = of_property_read_string_index(np, "string-property", 0, strings);
720 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
721 strings[0] = NULL;
722 rc = of_property_read_string_index(np, "string-property", 1, strings);
723 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
724 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
725 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
726 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
727 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
728 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
729 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
730 strings[0] = NULL;
731 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
732 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
733 strings[0] = NULL;
734 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
735 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
736 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
737 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
738 strings[0] = NULL;
739 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
740 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
741 strings[1] = NULL;
743 /* of_property_read_string_array() tests */
744 rc = of_property_read_string_array(np, "string-property", strings, 4);
745 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
746 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
747 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
748 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
749 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
750 /* -- An incorrectly formed string should cause a failure */
751 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
752 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
753 /* -- parsing the correctly formed strings should still work: */
754 strings[2] = NULL;
755 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
756 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
757 strings[1] = NULL;
758 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
759 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
762 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
763 (p1)->value && (p2)->value && \
764 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
765 !strcmp((p1)->name, (p2)->name))
766 static void __init of_unittest_property_copy(void)
768 #ifdef CONFIG_OF_DYNAMIC
769 struct property p1 = { .name = "p1", .length = 0, .value = "" };
770 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
771 struct property *new;
773 new = __of_prop_dup(&p1, GFP_KERNEL);
774 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
775 kfree(new->value);
776 kfree(new->name);
777 kfree(new);
779 new = __of_prop_dup(&p2, GFP_KERNEL);
780 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
781 kfree(new->value);
782 kfree(new->name);
783 kfree(new);
784 #endif
787 static void __init of_unittest_changeset(void)
789 #ifdef CONFIG_OF_DYNAMIC
790 struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
791 struct property *ppname_n1, pname_n1 = { .name = "name", .length = 3, .value = "n1" };
792 struct property *ppname_n2, pname_n2 = { .name = "name", .length = 3, .value = "n2" };
793 struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
794 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
795 struct property *ppremove;
796 struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
797 struct of_changeset chgset;
799 n1 = __of_node_dup(NULL, "n1");
800 unittest(n1, "testcase setup failure\n");
802 n2 = __of_node_dup(NULL, "n2");
803 unittest(n2, "testcase setup failure\n");
805 n21 = __of_node_dup(NULL, "n21");
806 unittest(n21, "testcase setup failure %p\n", n21);
808 nchangeset = of_find_node_by_path("/testcase-data/changeset");
809 nremove = of_get_child_by_name(nchangeset, "node-remove");
810 unittest(nremove, "testcase setup failure\n");
812 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
813 unittest(ppadd, "testcase setup failure\n");
815 ppname_n1 = __of_prop_dup(&pname_n1, GFP_KERNEL);
816 unittest(ppname_n1, "testcase setup failure\n");
818 ppname_n2 = __of_prop_dup(&pname_n2, GFP_KERNEL);
819 unittest(ppname_n2, "testcase setup failure\n");
821 ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
822 unittest(ppname_n21, "testcase setup failure\n");
824 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
825 unittest(ppupdate, "testcase setup failure\n");
827 parent = nchangeset;
828 n1->parent = parent;
829 n2->parent = parent;
830 n21->parent = n2;
832 ppremove = of_find_property(parent, "prop-remove", NULL);
833 unittest(ppremove, "failed to find removal prop");
835 of_changeset_init(&chgset);
837 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
838 unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
840 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
841 unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
843 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
844 unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
846 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
848 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
849 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
850 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
852 unittest(!of_changeset_apply(&chgset), "apply failed\n");
854 of_node_put(nchangeset);
856 /* Make sure node names are constructed correctly */
857 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
858 "'%pOF' not added\n", n21);
859 of_node_put(np);
861 unittest(!of_changeset_revert(&chgset), "revert failed\n");
863 of_changeset_destroy(&chgset);
864 #endif
867 static void __init of_unittest_dma_ranges_one(const char *path,
868 u64 expect_dma_addr, u64 expect_paddr, u64 expect_size)
870 struct device_node *np;
871 u64 dma_addr, paddr, size;
872 int rc;
874 np = of_find_node_by_path(path);
875 if (!np) {
876 pr_err("missing testcase data\n");
877 return;
880 rc = of_dma_get_range(np, &dma_addr, &paddr, &size);
882 unittest(!rc, "of_dma_get_range failed on node %pOF rc=%i\n", np, rc);
883 if (!rc) {
884 unittest(size == expect_size,
885 "of_dma_get_range wrong size on node %pOF size=%llx\n", np, size);
886 unittest(paddr == expect_paddr,
887 "of_dma_get_range wrong phys addr (%llx) on node %pOF", paddr, np);
888 unittest(dma_addr == expect_dma_addr,
889 "of_dma_get_range wrong DMA addr (%llx) on node %pOF", dma_addr, np);
891 of_node_put(np);
894 static void __init of_unittest_parse_dma_ranges(void)
896 of_unittest_dma_ranges_one("/testcase-data/address-tests/device@70000000",
897 0x0, 0x20000000, 0x40000000);
898 of_unittest_dma_ranges_one("/testcase-data/address-tests/bus@80000000/device@1000",
899 0x10000000, 0x20000000, 0x40000000);
900 of_unittest_dma_ranges_one("/testcase-data/address-tests/pci@90000000",
901 0x80000000, 0x20000000, 0x10000000);
904 static void __init of_unittest_pci_dma_ranges(void)
906 struct device_node *np;
907 struct of_pci_range range;
908 struct of_pci_range_parser parser;
909 int i = 0;
911 if (!IS_ENABLED(CONFIG_PCI))
912 return;
914 np = of_find_node_by_path("/testcase-data/address-tests/pci@90000000");
915 if (!np) {
916 pr_err("missing testcase data\n");
917 return;
920 if (of_pci_dma_range_parser_init(&parser, np)) {
921 pr_err("missing dma-ranges property\n");
922 return;
926 * Get the dma-ranges from the device tree
928 for_each_of_pci_range(&parser, &range) {
929 if (!i) {
930 unittest(range.size == 0x10000000,
931 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
932 np, range.size);
933 unittest(range.cpu_addr == 0x20000000,
934 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
935 range.cpu_addr, np);
936 unittest(range.pci_addr == 0x80000000,
937 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
938 range.pci_addr, np);
939 } else {
940 unittest(range.size == 0x10000000,
941 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
942 np, range.size);
943 unittest(range.cpu_addr == 0x40000000,
944 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
945 range.cpu_addr, np);
946 unittest(range.pci_addr == 0xc0000000,
947 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
948 range.pci_addr, np);
950 i++;
953 of_node_put(np);
956 static void __init of_unittest_parse_interrupts(void)
958 struct device_node *np;
959 struct of_phandle_args args;
960 int i, rc;
962 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
963 return;
965 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
966 if (!np) {
967 pr_err("missing testcase data\n");
968 return;
971 for (i = 0; i < 4; i++) {
972 bool passed = true;
974 memset(&args, 0, sizeof(args));
975 rc = of_irq_parse_one(np, i, &args);
977 passed &= !rc;
978 passed &= (args.args_count == 1);
979 passed &= (args.args[0] == (i + 1));
981 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
982 i, args.np, rc);
984 of_node_put(np);
986 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
987 if (!np) {
988 pr_err("missing testcase data\n");
989 return;
992 for (i = 0; i < 4; i++) {
993 bool passed = true;
995 memset(&args, 0, sizeof(args));
996 rc = of_irq_parse_one(np, i, &args);
998 /* Test the values from tests-phandle.dtsi */
999 switch (i) {
1000 case 0:
1001 passed &= !rc;
1002 passed &= (args.args_count == 1);
1003 passed &= (args.args[0] == 9);
1004 break;
1005 case 1:
1006 passed &= !rc;
1007 passed &= (args.args_count == 3);
1008 passed &= (args.args[0] == 10);
1009 passed &= (args.args[1] == 11);
1010 passed &= (args.args[2] == 12);
1011 break;
1012 case 2:
1013 passed &= !rc;
1014 passed &= (args.args_count == 2);
1015 passed &= (args.args[0] == 13);
1016 passed &= (args.args[1] == 14);
1017 break;
1018 case 3:
1019 passed &= !rc;
1020 passed &= (args.args_count == 2);
1021 passed &= (args.args[0] == 15);
1022 passed &= (args.args[1] == 16);
1023 break;
1024 default:
1025 passed = false;
1027 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1028 i, args.np, rc);
1030 of_node_put(np);
1033 static void __init of_unittest_parse_interrupts_extended(void)
1035 struct device_node *np;
1036 struct of_phandle_args args;
1037 int i, rc;
1039 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1040 return;
1042 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
1043 if (!np) {
1044 pr_err("missing testcase data\n");
1045 return;
1048 for (i = 0; i < 7; i++) {
1049 bool passed = true;
1051 memset(&args, 0, sizeof(args));
1052 rc = of_irq_parse_one(np, i, &args);
1054 /* Test the values from tests-phandle.dtsi */
1055 switch (i) {
1056 case 0:
1057 passed &= !rc;
1058 passed &= (args.args_count == 1);
1059 passed &= (args.args[0] == 1);
1060 break;
1061 case 1:
1062 passed &= !rc;
1063 passed &= (args.args_count == 3);
1064 passed &= (args.args[0] == 2);
1065 passed &= (args.args[1] == 3);
1066 passed &= (args.args[2] == 4);
1067 break;
1068 case 2:
1069 passed &= !rc;
1070 passed &= (args.args_count == 2);
1071 passed &= (args.args[0] == 5);
1072 passed &= (args.args[1] == 6);
1073 break;
1074 case 3:
1075 passed &= !rc;
1076 passed &= (args.args_count == 1);
1077 passed &= (args.args[0] == 9);
1078 break;
1079 case 4:
1080 passed &= !rc;
1081 passed &= (args.args_count == 3);
1082 passed &= (args.args[0] == 10);
1083 passed &= (args.args[1] == 11);
1084 passed &= (args.args[2] == 12);
1085 break;
1086 case 5:
1087 passed &= !rc;
1088 passed &= (args.args_count == 2);
1089 passed &= (args.args[0] == 13);
1090 passed &= (args.args[1] == 14);
1091 break;
1092 case 6:
1093 passed &= !rc;
1094 passed &= (args.args_count == 1);
1095 passed &= (args.args[0] == 15);
1096 break;
1097 default:
1098 passed = false;
1101 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1102 i, args.np, rc);
1104 of_node_put(np);
1107 static const struct of_device_id match_node_table[] = {
1108 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
1109 { .data = "B", .type = "type1", }, /* followed by type alone */
1111 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
1112 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
1113 { .data = "Cc", .name = "name2", .type = "type2", },
1115 { .data = "E", .compatible = "compat3" },
1116 { .data = "G", .compatible = "compat2", },
1117 { .data = "H", .compatible = "compat2", .name = "name5", },
1118 { .data = "I", .compatible = "compat2", .type = "type1", },
1119 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
1120 { .data = "K", .compatible = "compat2", .name = "name9", },
1124 static struct {
1125 const char *path;
1126 const char *data;
1127 } match_node_tests[] = {
1128 { .path = "/testcase-data/match-node/name0", .data = "A", },
1129 { .path = "/testcase-data/match-node/name1", .data = "B", },
1130 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
1131 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
1132 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
1133 { .path = "/testcase-data/match-node/name3", .data = "E", },
1134 { .path = "/testcase-data/match-node/name4", .data = "G", },
1135 { .path = "/testcase-data/match-node/name5", .data = "H", },
1136 { .path = "/testcase-data/match-node/name6", .data = "G", },
1137 { .path = "/testcase-data/match-node/name7", .data = "I", },
1138 { .path = "/testcase-data/match-node/name8", .data = "J", },
1139 { .path = "/testcase-data/match-node/name9", .data = "K", },
1142 static void __init of_unittest_match_node(void)
1144 struct device_node *np;
1145 const struct of_device_id *match;
1146 int i;
1148 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
1149 np = of_find_node_by_path(match_node_tests[i].path);
1150 if (!np) {
1151 unittest(0, "missing testcase node %s\n",
1152 match_node_tests[i].path);
1153 continue;
1156 match = of_match_node(match_node_table, np);
1157 if (!match) {
1158 unittest(0, "%s didn't match anything\n",
1159 match_node_tests[i].path);
1160 continue;
1163 if (strcmp(match->data, match_node_tests[i].data) != 0) {
1164 unittest(0, "%s got wrong match. expected %s, got %s\n",
1165 match_node_tests[i].path, match_node_tests[i].data,
1166 (const char *)match->data);
1167 continue;
1169 unittest(1, "passed");
1173 static struct resource test_bus_res = {
1174 .start = 0xfffffff8,
1175 .end = 0xfffffff9,
1176 .flags = IORESOURCE_MEM,
1178 static const struct platform_device_info test_bus_info = {
1179 .name = "unittest-bus",
1181 static void __init of_unittest_platform_populate(void)
1183 int irq, rc;
1184 struct device_node *np, *child, *grandchild;
1185 struct platform_device *pdev, *test_bus;
1186 const struct of_device_id match[] = {
1187 { .compatible = "test-device", },
1191 np = of_find_node_by_path("/testcase-data");
1192 of_platform_default_populate(np, NULL, NULL);
1194 /* Test that a missing irq domain returns -EPROBE_DEFER */
1195 np = of_find_node_by_path("/testcase-data/testcase-device1");
1196 pdev = of_find_device_by_node(np);
1197 unittest(pdev, "device 1 creation failed\n");
1199 if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1200 irq = platform_get_irq(pdev, 0);
1201 unittest(irq == -EPROBE_DEFER,
1202 "device deferred probe failed - %d\n", irq);
1204 /* Test that a parsing failure does not return -EPROBE_DEFER */
1205 np = of_find_node_by_path("/testcase-data/testcase-device2");
1206 pdev = of_find_device_by_node(np);
1207 unittest(pdev, "device 2 creation failed\n");
1209 EXPECT_BEGIN(KERN_INFO,
1210 "platform testcase-data:testcase-device2: IRQ index 0 not found");
1212 irq = platform_get_irq(pdev, 0);
1214 EXPECT_END(KERN_INFO,
1215 "platform testcase-data:testcase-device2: IRQ index 0 not found");
1217 unittest(irq < 0 && irq != -EPROBE_DEFER,
1218 "device parsing error failed - %d\n", irq);
1221 np = of_find_node_by_path("/testcase-data/platform-tests");
1222 unittest(np, "No testcase data in device tree\n");
1223 if (!np)
1224 return;
1226 test_bus = platform_device_register_full(&test_bus_info);
1227 rc = PTR_ERR_OR_ZERO(test_bus);
1228 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1229 if (rc) {
1230 of_node_put(np);
1231 return;
1233 test_bus->dev.of_node = np;
1236 * Add a dummy resource to the test bus node after it is
1237 * registered to catch problems with un-inserted resources. The
1238 * DT code doesn't insert the resources, and it has caused the
1239 * kernel to oops in the past. This makes sure the same bug
1240 * doesn't crop up again.
1242 platform_device_add_resources(test_bus, &test_bus_res, 1);
1244 of_platform_populate(np, match, NULL, &test_bus->dev);
1245 for_each_child_of_node(np, child) {
1246 for_each_child_of_node(child, grandchild)
1247 unittest(of_find_device_by_node(grandchild),
1248 "Could not create device for node '%pOFn'\n",
1249 grandchild);
1252 of_platform_depopulate(&test_bus->dev);
1253 for_each_child_of_node(np, child) {
1254 for_each_child_of_node(child, grandchild)
1255 unittest(!of_find_device_by_node(grandchild),
1256 "device didn't get destroyed '%pOFn'\n",
1257 grandchild);
1260 platform_device_unregister(test_bus);
1261 of_node_put(np);
1265 * update_node_properties - adds the properties
1266 * of np into dup node (present in live tree) and
1267 * updates parent of children of np to dup.
1269 * @np: node whose properties are being added to the live tree
1270 * @dup: node present in live tree to be updated
1272 static void update_node_properties(struct device_node *np,
1273 struct device_node *dup)
1275 struct property *prop;
1276 struct property *save_next;
1277 struct device_node *child;
1278 int ret;
1280 for_each_child_of_node(np, child)
1281 child->parent = dup;
1284 * "unittest internal error: unable to add testdata property"
1286 * If this message reports a property in node '/__symbols__' then
1287 * the respective unittest overlay contains a label that has the
1288 * same name as a label in the live devicetree. The label will
1289 * be in the live devicetree only if the devicetree source was
1290 * compiled with the '-@' option. If you encounter this error,
1291 * please consider renaming __all__ of the labels in the unittest
1292 * overlay dts files with an odd prefix that is unlikely to be
1293 * used in a real devicetree.
1297 * open code for_each_property_of_node() because of_add_property()
1298 * sets prop->next to NULL
1300 for (prop = np->properties; prop != NULL; prop = save_next) {
1301 save_next = prop->next;
1302 ret = of_add_property(dup, prop);
1303 if (ret) {
1304 if (ret == -EEXIST && !strcmp(prop->name, "name"))
1305 continue;
1306 pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1307 np, prop->name);
1313 * attach_node_and_children - attaches nodes
1314 * and its children to live tree.
1315 * CAUTION: misleading function name - if node @np already exists in
1316 * the live tree then children of @np are *not* attached to the live
1317 * tree. This works for the current test devicetree nodes because such
1318 * nodes do not have child nodes.
1320 * @np: Node to attach to live tree
1322 static void attach_node_and_children(struct device_node *np)
1324 struct device_node *next, *dup, *child;
1325 unsigned long flags;
1326 const char *full_name;
1328 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1330 if (!strcmp(full_name, "/__local_fixups__") ||
1331 !strcmp(full_name, "/__fixups__")) {
1332 kfree(full_name);
1333 return;
1336 dup = of_find_node_by_path(full_name);
1337 kfree(full_name);
1338 if (dup) {
1339 update_node_properties(np, dup);
1340 return;
1343 child = np->child;
1344 np->child = NULL;
1346 mutex_lock(&of_mutex);
1347 raw_spin_lock_irqsave(&devtree_lock, flags);
1348 np->sibling = np->parent->child;
1349 np->parent->child = np;
1350 of_node_clear_flag(np, OF_DETACHED);
1351 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1353 __of_attach_node_sysfs(np);
1354 mutex_unlock(&of_mutex);
1356 while (child) {
1357 next = child->sibling;
1358 attach_node_and_children(child);
1359 child = next;
1364 * unittest_data_add - Reads, copies data from
1365 * linked tree and attaches it to the live tree
1367 static int __init unittest_data_add(void)
1369 void *unittest_data;
1370 struct device_node *unittest_data_node, *np;
1372 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1373 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1375 extern uint8_t __dtb_testcases_begin[];
1376 extern uint8_t __dtb_testcases_end[];
1377 const int size = __dtb_testcases_end - __dtb_testcases_begin;
1378 int rc;
1380 if (!size) {
1381 pr_warn("%s: No testcase data to attach; not running tests\n",
1382 __func__);
1383 return -ENODATA;
1386 /* creating copy */
1387 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1388 if (!unittest_data)
1389 return -ENOMEM;
1391 of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1392 if (!unittest_data_node) {
1393 pr_warn("%s: No tree to attach; not running tests\n", __func__);
1394 kfree(unittest_data);
1395 return -ENODATA;
1399 * This lock normally encloses of_resolve_phandles()
1401 of_overlay_mutex_lock();
1403 rc = of_resolve_phandles(unittest_data_node);
1404 if (rc) {
1405 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1406 of_overlay_mutex_unlock();
1407 return -EINVAL;
1410 if (!of_root) {
1411 of_root = unittest_data_node;
1412 for_each_of_allnodes(np)
1413 __of_attach_node_sysfs(np);
1414 of_aliases = of_find_node_by_path("/aliases");
1415 of_chosen = of_find_node_by_path("/chosen");
1416 of_overlay_mutex_unlock();
1417 return 0;
1420 EXPECT_BEGIN(KERN_INFO,
1421 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1423 /* attach the sub-tree to live tree */
1424 np = unittest_data_node->child;
1425 while (np) {
1426 struct device_node *next = np->sibling;
1428 np->parent = of_root;
1429 attach_node_and_children(np);
1430 np = next;
1433 EXPECT_END(KERN_INFO,
1434 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1436 of_overlay_mutex_unlock();
1438 return 0;
1441 #ifdef CONFIG_OF_OVERLAY
1442 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1444 static int unittest_probe(struct platform_device *pdev)
1446 struct device *dev = &pdev->dev;
1447 struct device_node *np = dev->of_node;
1449 if (np == NULL) {
1450 dev_err(dev, "No OF data for device\n");
1451 return -EINVAL;
1455 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1457 of_platform_populate(np, NULL, NULL, &pdev->dev);
1459 return 0;
1462 static int unittest_remove(struct platform_device *pdev)
1464 struct device *dev = &pdev->dev;
1465 struct device_node *np = dev->of_node;
1467 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1468 return 0;
1471 static const struct of_device_id unittest_match[] = {
1472 { .compatible = "unittest", },
1476 static struct platform_driver unittest_driver = {
1477 .probe = unittest_probe,
1478 .remove = unittest_remove,
1479 .driver = {
1480 .name = "unittest",
1481 .of_match_table = of_match_ptr(unittest_match),
1485 /* get the platform device instantiated at the path */
1486 static struct platform_device *of_path_to_platform_device(const char *path)
1488 struct device_node *np;
1489 struct platform_device *pdev;
1491 np = of_find_node_by_path(path);
1492 if (np == NULL)
1493 return NULL;
1495 pdev = of_find_device_by_node(np);
1496 of_node_put(np);
1498 return pdev;
1501 /* find out if a platform device exists at that path */
1502 static int of_path_platform_device_exists(const char *path)
1504 struct platform_device *pdev;
1506 pdev = of_path_to_platform_device(path);
1507 platform_device_put(pdev);
1508 return pdev != NULL;
1511 #ifdef CONFIG_OF_GPIO
1513 struct unittest_gpio_dev {
1514 struct gpio_chip chip;
1517 static int unittest_gpio_chip_request_count;
1518 static int unittest_gpio_probe_count;
1519 static int unittest_gpio_probe_pass_count;
1521 static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
1523 unittest_gpio_chip_request_count++;
1525 pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
1526 unittest_gpio_chip_request_count);
1527 return 0;
1530 static int unittest_gpio_probe(struct platform_device *pdev)
1532 struct unittest_gpio_dev *devptr;
1533 int ret;
1535 unittest_gpio_probe_count++;
1537 devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
1538 if (!devptr)
1539 return -ENOMEM;
1541 platform_set_drvdata(pdev, devptr);
1543 devptr->chip.of_node = pdev->dev.of_node;
1544 devptr->chip.label = "of-unittest-gpio";
1545 devptr->chip.base = -1; /* dynamic allocation */
1546 devptr->chip.ngpio = 5;
1547 devptr->chip.request = unittest_gpio_chip_request;
1549 ret = gpiochip_add_data(&devptr->chip, NULL);
1551 unittest(!ret,
1552 "gpiochip_add_data() for node @%pOF failed, ret = %d\n", devptr->chip.of_node, ret);
1554 if (!ret)
1555 unittest_gpio_probe_pass_count++;
1556 return ret;
1559 static int unittest_gpio_remove(struct platform_device *pdev)
1561 struct unittest_gpio_dev *gdev = platform_get_drvdata(pdev);
1562 struct device *dev = &pdev->dev;
1563 struct device_node *np = pdev->dev.of_node;
1565 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1567 if (!gdev)
1568 return -EINVAL;
1570 if (gdev->chip.base != -1)
1571 gpiochip_remove(&gdev->chip);
1573 platform_set_drvdata(pdev, NULL);
1574 kfree(gdev);
1576 return 0;
1579 static const struct of_device_id unittest_gpio_id[] = {
1580 { .compatible = "unittest-gpio", },
1584 static struct platform_driver unittest_gpio_driver = {
1585 .probe = unittest_gpio_probe,
1586 .remove = unittest_gpio_remove,
1587 .driver = {
1588 .name = "unittest-gpio",
1589 .of_match_table = of_match_ptr(unittest_gpio_id),
1593 static void __init of_unittest_overlay_gpio(void)
1595 int chip_request_count;
1596 int probe_pass_count;
1597 int ret;
1600 * tests: apply overlays before registering driver
1601 * Similar to installing a driver as a module, the
1602 * driver is registered after applying the overlays.
1604 * The overlays are applied by overlay_data_apply()
1605 * instead of of_unittest_apply_overlay() so that they
1606 * will not be tracked. Thus they will not be removed
1607 * by of_unittest_destroy_tracked_overlays().
1609 * - apply overlay_gpio_01
1610 * - apply overlay_gpio_02a
1611 * - apply overlay_gpio_02b
1612 * - register driver
1614 * register driver will result in
1615 * - probe and processing gpio hog for overlay_gpio_01
1616 * - probe for overlay_gpio_02a
1617 * - processing gpio for overlay_gpio_02b
1620 probe_pass_count = unittest_gpio_probe_pass_count;
1621 chip_request_count = unittest_gpio_chip_request_count;
1624 * overlay_gpio_01 contains gpio node and child gpio hog node
1625 * overlay_gpio_02a contains gpio node
1626 * overlay_gpio_02b contains child gpio hog node
1629 unittest(overlay_data_apply("overlay_gpio_01", NULL),
1630 "Adding overlay 'overlay_gpio_01' failed\n");
1632 unittest(overlay_data_apply("overlay_gpio_02a", NULL),
1633 "Adding overlay 'overlay_gpio_02a' failed\n");
1635 unittest(overlay_data_apply("overlay_gpio_02b", NULL),
1636 "Adding overlay 'overlay_gpio_02b' failed\n");
1639 * messages are the result of the probes, after the
1640 * driver is registered
1643 EXPECT_BEGIN(KERN_INFO,
1644 "GPIO line <<int>> (line-B-input) hogged as input\n");
1646 EXPECT_BEGIN(KERN_INFO,
1647 "GPIO line <<int>> (line-A-input) hogged as input\n");
1649 ret = platform_driver_register(&unittest_gpio_driver);
1650 if (unittest(ret == 0, "could not register unittest gpio driver\n"))
1651 return;
1653 EXPECT_END(KERN_INFO,
1654 "GPIO line <<int>> (line-A-input) hogged as input\n");
1655 EXPECT_END(KERN_INFO,
1656 "GPIO line <<int>> (line-B-input) hogged as input\n");
1658 unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
1659 "unittest_gpio_probe() failed or not called\n");
1661 unittest(chip_request_count + 2 == unittest_gpio_chip_request_count,
1662 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1663 unittest_gpio_chip_request_count - chip_request_count);
1666 * tests: apply overlays after registering driver
1668 * Similar to a driver built-in to the kernel, the
1669 * driver is registered before applying the overlays.
1671 * overlay_gpio_03 contains gpio node and child gpio hog node
1673 * - apply overlay_gpio_03
1675 * apply overlay will result in
1676 * - probe and processing gpio hog.
1679 probe_pass_count = unittest_gpio_probe_pass_count;
1680 chip_request_count = unittest_gpio_chip_request_count;
1682 EXPECT_BEGIN(KERN_INFO,
1683 "GPIO line <<int>> (line-D-input) hogged as input\n");
1685 /* overlay_gpio_03 contains gpio node and child gpio hog node */
1687 unittest(overlay_data_apply("overlay_gpio_03", NULL),
1688 "Adding overlay 'overlay_gpio_03' failed\n");
1690 EXPECT_END(KERN_INFO,
1691 "GPIO line <<int>> (line-D-input) hogged as input\n");
1693 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1694 "unittest_gpio_probe() failed or not called\n");
1696 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1697 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1698 unittest_gpio_chip_request_count - chip_request_count);
1701 * overlay_gpio_04a contains gpio node
1703 * - apply overlay_gpio_04a
1705 * apply the overlay will result in
1706 * - probe for overlay_gpio_04a
1709 probe_pass_count = unittest_gpio_probe_pass_count;
1710 chip_request_count = unittest_gpio_chip_request_count;
1712 /* overlay_gpio_04a contains gpio node */
1714 unittest(overlay_data_apply("overlay_gpio_04a", NULL),
1715 "Adding overlay 'overlay_gpio_04a' failed\n");
1717 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1718 "unittest_gpio_probe() failed or not called\n");
1721 * overlay_gpio_04b contains child gpio hog node
1723 * - apply overlay_gpio_04b
1725 * apply the overlay will result in
1726 * - processing gpio for overlay_gpio_04b
1729 EXPECT_BEGIN(KERN_INFO,
1730 "GPIO line <<int>> (line-C-input) hogged as input\n");
1732 /* overlay_gpio_04b contains child gpio hog node */
1734 unittest(overlay_data_apply("overlay_gpio_04b", NULL),
1735 "Adding overlay 'overlay_gpio_04b' failed\n");
1737 EXPECT_END(KERN_INFO,
1738 "GPIO line <<int>> (line-C-input) hogged as input\n");
1740 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1741 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1742 unittest_gpio_chip_request_count - chip_request_count);
1745 #else
1747 static void __init of_unittest_overlay_gpio(void)
1749 /* skip tests */
1752 #endif
1754 #if IS_BUILTIN(CONFIG_I2C)
1756 /* get the i2c client device instantiated at the path */
1757 static struct i2c_client *of_path_to_i2c_client(const char *path)
1759 struct device_node *np;
1760 struct i2c_client *client;
1762 np = of_find_node_by_path(path);
1763 if (np == NULL)
1764 return NULL;
1766 client = of_find_i2c_device_by_node(np);
1767 of_node_put(np);
1769 return client;
1772 /* find out if a i2c client device exists at that path */
1773 static int of_path_i2c_client_exists(const char *path)
1775 struct i2c_client *client;
1777 client = of_path_to_i2c_client(path);
1778 if (client)
1779 put_device(&client->dev);
1780 return client != NULL;
1782 #else
1783 static int of_path_i2c_client_exists(const char *path)
1785 return 0;
1787 #endif
1789 enum overlay_type {
1790 PDEV_OVERLAY,
1791 I2C_OVERLAY
1794 static int of_path_device_type_exists(const char *path,
1795 enum overlay_type ovtype)
1797 switch (ovtype) {
1798 case PDEV_OVERLAY:
1799 return of_path_platform_device_exists(path);
1800 case I2C_OVERLAY:
1801 return of_path_i2c_client_exists(path);
1803 return 0;
1806 static const char *unittest_path(int nr, enum overlay_type ovtype)
1808 const char *base;
1809 static char buf[256];
1811 switch (ovtype) {
1812 case PDEV_OVERLAY:
1813 base = "/testcase-data/overlay-node/test-bus";
1814 break;
1815 case I2C_OVERLAY:
1816 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1817 break;
1818 default:
1819 buf[0] = '\0';
1820 return buf;
1822 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1823 buf[sizeof(buf) - 1] = '\0';
1824 return buf;
1827 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1829 const char *path;
1831 path = unittest_path(unittest_nr, ovtype);
1833 switch (ovtype) {
1834 case PDEV_OVERLAY:
1835 return of_path_platform_device_exists(path);
1836 case I2C_OVERLAY:
1837 return of_path_i2c_client_exists(path);
1839 return 0;
1842 static const char *overlay_name_from_nr(int nr)
1844 static char buf[256];
1846 snprintf(buf, sizeof(buf) - 1,
1847 "overlay_%d", nr);
1848 buf[sizeof(buf) - 1] = '\0';
1850 return buf;
1853 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1855 /* FIXME: it is NOT guaranteed that overlay ids are assigned in sequence */
1857 #define MAX_UNITTEST_OVERLAYS 256
1858 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1859 static int overlay_first_id = -1;
1861 static long of_unittest_overlay_tracked(int id)
1863 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1864 return 0;
1865 return overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id);
1868 static void of_unittest_track_overlay(int id)
1870 if (overlay_first_id < 0)
1871 overlay_first_id = id;
1872 id -= overlay_first_id;
1874 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1875 return;
1876 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1879 static void of_unittest_untrack_overlay(int id)
1881 if (overlay_first_id < 0)
1882 return;
1883 id -= overlay_first_id;
1884 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1885 return;
1886 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1889 static void of_unittest_destroy_tracked_overlays(void)
1891 int id, ret, defers, ovcs_id;
1893 if (overlay_first_id < 0)
1894 return;
1896 /* try until no defers */
1897 do {
1898 defers = 0;
1899 /* remove in reverse order */
1900 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1901 if (!of_unittest_overlay_tracked(id))
1902 continue;
1904 ovcs_id = id + overlay_first_id;
1905 ret = of_overlay_remove(&ovcs_id);
1906 if (ret == -ENODEV) {
1907 pr_warn("%s: no overlay to destroy for #%d\n",
1908 __func__, id + overlay_first_id);
1909 continue;
1911 if (ret != 0) {
1912 defers++;
1913 pr_warn("%s: overlay destroy failed for #%d\n",
1914 __func__, id + overlay_first_id);
1915 continue;
1918 of_unittest_untrack_overlay(id);
1920 } while (defers > 0);
1923 static int __init of_unittest_apply_overlay(int overlay_nr, int *overlay_id)
1925 const char *overlay_name;
1927 overlay_name = overlay_name_from_nr(overlay_nr);
1929 if (!overlay_data_apply(overlay_name, overlay_id)) {
1930 unittest(0, "could not apply overlay \"%s\"\n",
1931 overlay_name);
1932 return -EFAULT;
1934 of_unittest_track_overlay(*overlay_id);
1936 return 0;
1939 /* apply an overlay while checking before and after states */
1940 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1941 int unittest_nr, int before, int after,
1942 enum overlay_type ovtype)
1944 int ret, ovcs_id;
1946 /* unittest device must not be in before state */
1947 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1948 unittest(0, "%s with device @\"%s\" %s\n",
1949 overlay_name_from_nr(overlay_nr),
1950 unittest_path(unittest_nr, ovtype),
1951 !before ? "enabled" : "disabled");
1952 return -EINVAL;
1955 ovcs_id = 0;
1956 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
1957 if (ret != 0) {
1958 /* of_unittest_apply_overlay already called unittest() */
1959 return ret;
1962 /* unittest device must be to set to after state */
1963 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1964 unittest(0, "%s failed to create @\"%s\" %s\n",
1965 overlay_name_from_nr(overlay_nr),
1966 unittest_path(unittest_nr, ovtype),
1967 !after ? "enabled" : "disabled");
1968 return -EINVAL;
1971 return 0;
1974 /* apply an overlay and then revert it while checking before, after states */
1975 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1976 int unittest_nr, int before, int after,
1977 enum overlay_type ovtype)
1979 int ret, ovcs_id, save_id;
1981 /* unittest device must be in before state */
1982 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1983 unittest(0, "%s with device @\"%s\" %s\n",
1984 overlay_name_from_nr(overlay_nr),
1985 unittest_path(unittest_nr, ovtype),
1986 !before ? "enabled" : "disabled");
1987 return -EINVAL;
1990 /* apply the overlay */
1991 ovcs_id = 0;
1992 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
1993 if (ret != 0) {
1994 /* of_unittest_apply_overlay already called unittest() */
1995 return ret;
1998 /* unittest device must be in after state */
1999 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2000 unittest(0, "%s failed to create @\"%s\" %s\n",
2001 overlay_name_from_nr(overlay_nr),
2002 unittest_path(unittest_nr, ovtype),
2003 !after ? "enabled" : "disabled");
2004 return -EINVAL;
2007 save_id = ovcs_id;
2008 ret = of_overlay_remove(&ovcs_id);
2009 if (ret != 0) {
2010 unittest(0, "%s failed to be destroyed @\"%s\"\n",
2011 overlay_name_from_nr(overlay_nr),
2012 unittest_path(unittest_nr, ovtype));
2013 return ret;
2015 of_unittest_untrack_overlay(save_id);
2017 /* unittest device must be again in before state */
2018 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
2019 unittest(0, "%s with device @\"%s\" %s\n",
2020 overlay_name_from_nr(overlay_nr),
2021 unittest_path(unittest_nr, ovtype),
2022 !before ? "enabled" : "disabled");
2023 return -EINVAL;
2026 return 0;
2029 /* test activation of device */
2030 static void __init of_unittest_overlay_0(void)
2032 int ret;
2034 EXPECT_BEGIN(KERN_INFO,
2035 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2037 /* device should enable */
2038 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
2040 EXPECT_END(KERN_INFO,
2041 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2043 if (ret)
2044 return;
2046 unittest(1, "overlay test %d passed\n", 0);
2049 /* test deactivation of device */
2050 static void __init of_unittest_overlay_1(void)
2052 int ret;
2054 EXPECT_BEGIN(KERN_INFO,
2055 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2057 /* device should disable */
2058 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
2060 EXPECT_END(KERN_INFO,
2061 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2063 if (ret)
2064 return;
2066 unittest(1, "overlay test %d passed\n", 1);
2070 /* test activation of device */
2071 static void __init of_unittest_overlay_2(void)
2073 int ret;
2075 EXPECT_BEGIN(KERN_INFO,
2076 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2078 /* device should enable */
2079 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
2081 EXPECT_END(KERN_INFO,
2082 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2084 if (ret)
2085 return;
2086 unittest(1, "overlay test %d passed\n", 2);
2089 /* test deactivation of device */
2090 static void __init of_unittest_overlay_3(void)
2092 int ret;
2094 EXPECT_BEGIN(KERN_INFO,
2095 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2097 /* device should disable */
2098 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
2100 EXPECT_END(KERN_INFO,
2101 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2103 if (ret)
2104 return;
2106 unittest(1, "overlay test %d passed\n", 3);
2109 /* test activation of a full device node */
2110 static void __init of_unittest_overlay_4(void)
2112 /* device should disable */
2113 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
2114 return;
2116 unittest(1, "overlay test %d passed\n", 4);
2119 /* test overlay apply/revert sequence */
2120 static void __init of_unittest_overlay_5(void)
2122 int ret;
2124 EXPECT_BEGIN(KERN_INFO,
2125 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2127 /* device should disable */
2128 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
2130 EXPECT_END(KERN_INFO,
2131 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2133 if (ret)
2134 return;
2136 unittest(1, "overlay test %d passed\n", 5);
2139 /* test overlay application in sequence */
2140 static void __init of_unittest_overlay_6(void)
2142 int i, ov_id[2], ovcs_id;
2143 int overlay_nr = 6, unittest_nr = 6;
2144 int before = 0, after = 1;
2145 const char *overlay_name;
2147 int ret;
2149 /* unittest device must be in before state */
2150 for (i = 0; i < 2; i++) {
2151 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2152 != before) {
2153 unittest(0, "%s with device @\"%s\" %s\n",
2154 overlay_name_from_nr(overlay_nr + i),
2155 unittest_path(unittest_nr + i,
2156 PDEV_OVERLAY),
2157 !before ? "enabled" : "disabled");
2158 return;
2162 /* apply the overlays */
2164 EXPECT_BEGIN(KERN_INFO,
2165 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2167 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2169 ret = overlay_data_apply(overlay_name, &ovcs_id);
2171 if (!ret) {
2172 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2173 return;
2175 ov_id[0] = ovcs_id;
2176 of_unittest_track_overlay(ov_id[0]);
2178 EXPECT_END(KERN_INFO,
2179 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2181 EXPECT_BEGIN(KERN_INFO,
2182 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2184 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2186 ret = overlay_data_apply(overlay_name, &ovcs_id);
2188 if (!ret) {
2189 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2190 return;
2192 ov_id[1] = ovcs_id;
2193 of_unittest_track_overlay(ov_id[1]);
2195 EXPECT_END(KERN_INFO,
2196 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2199 for (i = 0; i < 2; i++) {
2200 /* unittest device must be in after state */
2201 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2202 != after) {
2203 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
2204 overlay_name_from_nr(overlay_nr + i),
2205 unittest_path(unittest_nr + i,
2206 PDEV_OVERLAY),
2207 !after ? "enabled" : "disabled");
2208 return;
2212 for (i = 1; i >= 0; i--) {
2213 ovcs_id = ov_id[i];
2214 if (of_overlay_remove(&ovcs_id)) {
2215 unittest(0, "%s failed destroy @\"%s\"\n",
2216 overlay_name_from_nr(overlay_nr + i),
2217 unittest_path(unittest_nr + i,
2218 PDEV_OVERLAY));
2219 return;
2221 of_unittest_untrack_overlay(ov_id[i]);
2224 for (i = 0; i < 2; i++) {
2225 /* unittest device must be again in before state */
2226 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2227 != before) {
2228 unittest(0, "%s with device @\"%s\" %s\n",
2229 overlay_name_from_nr(overlay_nr + i),
2230 unittest_path(unittest_nr + i,
2231 PDEV_OVERLAY),
2232 !before ? "enabled" : "disabled");
2233 return;
2237 unittest(1, "overlay test %d passed\n", 6);
2241 /* test overlay application in sequence */
2242 static void __init of_unittest_overlay_8(void)
2244 int i, ov_id[2], ovcs_id;
2245 int overlay_nr = 8, unittest_nr = 8;
2246 const char *overlay_name;
2247 int ret;
2249 /* we don't care about device state in this test */
2251 EXPECT_BEGIN(KERN_INFO,
2252 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2254 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2256 ret = overlay_data_apply(overlay_name, &ovcs_id);
2257 if (!ret)
2258 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2260 EXPECT_END(KERN_INFO,
2261 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2263 if (!ret)
2264 return;
2266 ov_id[0] = ovcs_id;
2267 of_unittest_track_overlay(ov_id[0]);
2269 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2271 EXPECT_BEGIN(KERN_INFO,
2272 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2274 /* apply the overlays */
2275 ret = overlay_data_apply(overlay_name, &ovcs_id);
2277 EXPECT_END(KERN_INFO,
2278 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2280 if (!ret) {
2281 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2282 return;
2285 ov_id[1] = ovcs_id;
2286 of_unittest_track_overlay(ov_id[1]);
2288 /* now try to remove first overlay (it should fail) */
2289 ovcs_id = ov_id[0];
2291 EXPECT_BEGIN(KERN_INFO,
2292 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2294 EXPECT_BEGIN(KERN_INFO,
2295 "OF: overlay: overlay #6 is not topmost");
2297 ret = of_overlay_remove(&ovcs_id);
2299 EXPECT_END(KERN_INFO,
2300 "OF: overlay: overlay #6 is not topmost");
2302 EXPECT_END(KERN_INFO,
2303 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2305 if (!ret) {
2306 unittest(0, "%s was destroyed @\"%s\"\n",
2307 overlay_name_from_nr(overlay_nr + 0),
2308 unittest_path(unittest_nr,
2309 PDEV_OVERLAY));
2310 return;
2313 /* removing them in order should work */
2314 for (i = 1; i >= 0; i--) {
2315 ovcs_id = ov_id[i];
2316 if (of_overlay_remove(&ovcs_id)) {
2317 unittest(0, "%s not destroyed @\"%s\"\n",
2318 overlay_name_from_nr(overlay_nr + i),
2319 unittest_path(unittest_nr,
2320 PDEV_OVERLAY));
2321 return;
2323 of_unittest_untrack_overlay(ov_id[i]);
2326 unittest(1, "overlay test %d passed\n", 8);
2329 /* test insertion of a bus with parent devices */
2330 static void __init of_unittest_overlay_10(void)
2332 int ret;
2333 char *child_path;
2335 /* device should disable */
2336 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
2338 if (unittest(ret == 0,
2339 "overlay test %d failed; overlay application\n", 10))
2340 return;
2342 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
2343 unittest_path(10, PDEV_OVERLAY));
2344 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
2345 return;
2347 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
2348 kfree(child_path);
2350 unittest(ret, "overlay test %d failed; no child device\n", 10);
2353 /* test insertion of a bus with parent devices (and revert) */
2354 static void __init of_unittest_overlay_11(void)
2356 int ret;
2358 /* device should disable */
2359 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
2360 PDEV_OVERLAY);
2362 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2365 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2367 struct unittest_i2c_bus_data {
2368 struct platform_device *pdev;
2369 struct i2c_adapter adap;
2372 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2373 struct i2c_msg *msgs, int num)
2375 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2377 (void)std;
2379 return num;
2382 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2384 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2387 static const struct i2c_algorithm unittest_i2c_algo = {
2388 .master_xfer = unittest_i2c_master_xfer,
2389 .functionality = unittest_i2c_functionality,
2392 static int unittest_i2c_bus_probe(struct platform_device *pdev)
2394 struct device *dev = &pdev->dev;
2395 struct device_node *np = dev->of_node;
2396 struct unittest_i2c_bus_data *std;
2397 struct i2c_adapter *adap;
2398 int ret;
2400 if (np == NULL) {
2401 dev_err(dev, "No OF data for device\n");
2402 return -EINVAL;
2406 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2408 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
2409 if (!std)
2410 return -ENOMEM;
2412 /* link them together */
2413 std->pdev = pdev;
2414 platform_set_drvdata(pdev, std);
2416 adap = &std->adap;
2417 i2c_set_adapdata(adap, std);
2418 adap->nr = -1;
2419 strlcpy(adap->name, pdev->name, sizeof(adap->name));
2420 adap->class = I2C_CLASS_DEPRECATED;
2421 adap->algo = &unittest_i2c_algo;
2422 adap->dev.parent = dev;
2423 adap->dev.of_node = dev->of_node;
2424 adap->timeout = 5 * HZ;
2425 adap->retries = 3;
2427 ret = i2c_add_numbered_adapter(adap);
2428 if (ret != 0) {
2429 dev_err(dev, "Failed to add I2C adapter\n");
2430 return ret;
2433 return 0;
2436 static int unittest_i2c_bus_remove(struct platform_device *pdev)
2438 struct device *dev = &pdev->dev;
2439 struct device_node *np = dev->of_node;
2440 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
2442 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2443 i2c_del_adapter(&std->adap);
2445 return 0;
2448 static const struct of_device_id unittest_i2c_bus_match[] = {
2449 { .compatible = "unittest-i2c-bus", },
2453 static struct platform_driver unittest_i2c_bus_driver = {
2454 .probe = unittest_i2c_bus_probe,
2455 .remove = unittest_i2c_bus_remove,
2456 .driver = {
2457 .name = "unittest-i2c-bus",
2458 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
2462 static int unittest_i2c_dev_probe(struct i2c_client *client,
2463 const struct i2c_device_id *id)
2465 struct device *dev = &client->dev;
2466 struct device_node *np = client->dev.of_node;
2468 if (!np) {
2469 dev_err(dev, "No OF node\n");
2470 return -EINVAL;
2473 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2475 return 0;
2478 static int unittest_i2c_dev_remove(struct i2c_client *client)
2480 struct device *dev = &client->dev;
2481 struct device_node *np = client->dev.of_node;
2483 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2484 return 0;
2487 static const struct i2c_device_id unittest_i2c_dev_id[] = {
2488 { .name = "unittest-i2c-dev" },
2492 static struct i2c_driver unittest_i2c_dev_driver = {
2493 .driver = {
2494 .name = "unittest-i2c-dev",
2496 .probe = unittest_i2c_dev_probe,
2497 .remove = unittest_i2c_dev_remove,
2498 .id_table = unittest_i2c_dev_id,
2501 #if IS_BUILTIN(CONFIG_I2C_MUX)
2503 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
2505 return 0;
2508 static int unittest_i2c_mux_probe(struct i2c_client *client,
2509 const struct i2c_device_id *id)
2511 int i, nchans;
2512 struct device *dev = &client->dev;
2513 struct i2c_adapter *adap = client->adapter;
2514 struct device_node *np = client->dev.of_node, *child;
2515 struct i2c_mux_core *muxc;
2516 u32 reg, max_reg;
2518 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2520 if (!np) {
2521 dev_err(dev, "No OF node\n");
2522 return -EINVAL;
2525 max_reg = (u32)-1;
2526 for_each_child_of_node(np, child) {
2527 if (of_property_read_u32(child, "reg", &reg))
2528 continue;
2529 if (max_reg == (u32)-1 || reg > max_reg)
2530 max_reg = reg;
2532 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
2533 if (nchans == 0) {
2534 dev_err(dev, "No channels\n");
2535 return -EINVAL;
2538 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
2539 unittest_i2c_mux_select_chan, NULL);
2540 if (!muxc)
2541 return -ENOMEM;
2542 for (i = 0; i < nchans; i++) {
2543 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
2544 dev_err(dev, "Failed to register mux #%d\n", i);
2545 i2c_mux_del_adapters(muxc);
2546 return -ENODEV;
2550 i2c_set_clientdata(client, muxc);
2552 return 0;
2555 static int unittest_i2c_mux_remove(struct i2c_client *client)
2557 struct device *dev = &client->dev;
2558 struct device_node *np = client->dev.of_node;
2559 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
2561 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2562 i2c_mux_del_adapters(muxc);
2563 return 0;
2566 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2567 { .name = "unittest-i2c-mux" },
2571 static struct i2c_driver unittest_i2c_mux_driver = {
2572 .driver = {
2573 .name = "unittest-i2c-mux",
2575 .probe = unittest_i2c_mux_probe,
2576 .remove = unittest_i2c_mux_remove,
2577 .id_table = unittest_i2c_mux_id,
2580 #endif
2582 static int of_unittest_overlay_i2c_init(void)
2584 int ret;
2586 ret = i2c_add_driver(&unittest_i2c_dev_driver);
2587 if (unittest(ret == 0,
2588 "could not register unittest i2c device driver\n"))
2589 return ret;
2591 ret = platform_driver_register(&unittest_i2c_bus_driver);
2593 if (unittest(ret == 0,
2594 "could not register unittest i2c bus driver\n"))
2595 return ret;
2597 #if IS_BUILTIN(CONFIG_I2C_MUX)
2599 EXPECT_BEGIN(KERN_INFO,
2600 "i2c i2c-1: Added multiplexed i2c bus 2");
2602 ret = i2c_add_driver(&unittest_i2c_mux_driver);
2604 EXPECT_END(KERN_INFO,
2605 "i2c i2c-1: Added multiplexed i2c bus 2");
2607 if (unittest(ret == 0,
2608 "could not register unittest i2c mux driver\n"))
2609 return ret;
2610 #endif
2612 return 0;
2615 static void of_unittest_overlay_i2c_cleanup(void)
2617 #if IS_BUILTIN(CONFIG_I2C_MUX)
2618 i2c_del_driver(&unittest_i2c_mux_driver);
2619 #endif
2620 platform_driver_unregister(&unittest_i2c_bus_driver);
2621 i2c_del_driver(&unittest_i2c_dev_driver);
2624 static void __init of_unittest_overlay_i2c_12(void)
2626 int ret;
2628 /* device should enable */
2629 EXPECT_BEGIN(KERN_INFO,
2630 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2632 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
2634 EXPECT_END(KERN_INFO,
2635 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2637 if (ret)
2638 return;
2640 unittest(1, "overlay test %d passed\n", 12);
2643 /* test deactivation of device */
2644 static void __init of_unittest_overlay_i2c_13(void)
2646 int ret;
2648 EXPECT_BEGIN(KERN_INFO,
2649 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2651 /* device should disable */
2652 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
2654 EXPECT_END(KERN_INFO,
2655 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2657 if (ret)
2658 return;
2660 unittest(1, "overlay test %d passed\n", 13);
2663 /* just check for i2c mux existence */
2664 static void of_unittest_overlay_i2c_14(void)
2668 static void __init of_unittest_overlay_i2c_15(void)
2670 int ret;
2672 /* device should enable */
2673 EXPECT_BEGIN(KERN_INFO,
2674 "i2c i2c-1: Added multiplexed i2c bus 3");
2676 ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
2678 EXPECT_END(KERN_INFO,
2679 "i2c i2c-1: Added multiplexed i2c bus 3");
2681 if (ret)
2682 return;
2684 unittest(1, "overlay test %d passed\n", 15);
2687 #else
2689 static inline void of_unittest_overlay_i2c_14(void) { }
2690 static inline void of_unittest_overlay_i2c_15(void) { }
2692 #endif
2694 static void __init of_unittest_overlay(void)
2696 struct device_node *bus_np = NULL;
2698 if (platform_driver_register(&unittest_driver)) {
2699 unittest(0, "could not register unittest driver\n");
2700 goto out;
2703 bus_np = of_find_node_by_path(bus_path);
2704 if (bus_np == NULL) {
2705 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2706 goto out;
2709 if (of_platform_default_populate(bus_np, NULL, NULL)) {
2710 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2711 goto out;
2714 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2715 unittest(0, "could not find unittest0 @ \"%s\"\n",
2716 unittest_path(100, PDEV_OVERLAY));
2717 goto out;
2720 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2721 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2722 unittest_path(101, PDEV_OVERLAY));
2723 goto out;
2726 unittest(1, "basic infrastructure of overlays passed");
2728 /* tests in sequence */
2729 of_unittest_overlay_0();
2730 of_unittest_overlay_1();
2731 of_unittest_overlay_2();
2732 of_unittest_overlay_3();
2733 of_unittest_overlay_4();
2734 of_unittest_overlay_5();
2735 of_unittest_overlay_6();
2736 of_unittest_overlay_8();
2738 of_unittest_overlay_10();
2739 of_unittest_overlay_11();
2741 #if IS_BUILTIN(CONFIG_I2C)
2742 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2743 goto out;
2745 of_unittest_overlay_i2c_12();
2746 of_unittest_overlay_i2c_13();
2747 of_unittest_overlay_i2c_14();
2748 of_unittest_overlay_i2c_15();
2750 of_unittest_overlay_i2c_cleanup();
2751 #endif
2753 of_unittest_overlay_gpio();
2755 of_unittest_destroy_tracked_overlays();
2757 out:
2758 of_node_put(bus_np);
2761 #else
2762 static inline void __init of_unittest_overlay(void) { }
2763 #endif
2765 #ifdef CONFIG_OF_OVERLAY
2768 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2769 * in scripts/Makefile.lib
2772 #define OVERLAY_INFO_EXTERN(name) \
2773 extern uint8_t __dtb_##name##_begin[]; \
2774 extern uint8_t __dtb_##name##_end[]
2776 #define OVERLAY_INFO(overlay_name, expected) \
2777 { .dtb_begin = __dtb_##overlay_name##_begin, \
2778 .dtb_end = __dtb_##overlay_name##_end, \
2779 .expected_result = expected, \
2780 .name = #overlay_name, \
2783 struct overlay_info {
2784 uint8_t *dtb_begin;
2785 uint8_t *dtb_end;
2786 int expected_result;
2787 int overlay_id;
2788 char *name;
2791 OVERLAY_INFO_EXTERN(overlay_base);
2792 OVERLAY_INFO_EXTERN(overlay);
2793 OVERLAY_INFO_EXTERN(overlay_0);
2794 OVERLAY_INFO_EXTERN(overlay_1);
2795 OVERLAY_INFO_EXTERN(overlay_2);
2796 OVERLAY_INFO_EXTERN(overlay_3);
2797 OVERLAY_INFO_EXTERN(overlay_4);
2798 OVERLAY_INFO_EXTERN(overlay_5);
2799 OVERLAY_INFO_EXTERN(overlay_6);
2800 OVERLAY_INFO_EXTERN(overlay_7);
2801 OVERLAY_INFO_EXTERN(overlay_8);
2802 OVERLAY_INFO_EXTERN(overlay_9);
2803 OVERLAY_INFO_EXTERN(overlay_10);
2804 OVERLAY_INFO_EXTERN(overlay_11);
2805 OVERLAY_INFO_EXTERN(overlay_12);
2806 OVERLAY_INFO_EXTERN(overlay_13);
2807 OVERLAY_INFO_EXTERN(overlay_15);
2808 OVERLAY_INFO_EXTERN(overlay_gpio_01);
2809 OVERLAY_INFO_EXTERN(overlay_gpio_02a);
2810 OVERLAY_INFO_EXTERN(overlay_gpio_02b);
2811 OVERLAY_INFO_EXTERN(overlay_gpio_03);
2812 OVERLAY_INFO_EXTERN(overlay_gpio_04a);
2813 OVERLAY_INFO_EXTERN(overlay_gpio_04b);
2814 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
2815 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
2816 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2817 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2819 /* entries found by name */
2820 static struct overlay_info overlays[] = {
2821 OVERLAY_INFO(overlay_base, -9999),
2822 OVERLAY_INFO(overlay, 0),
2823 OVERLAY_INFO(overlay_0, 0),
2824 OVERLAY_INFO(overlay_1, 0),
2825 OVERLAY_INFO(overlay_2, 0),
2826 OVERLAY_INFO(overlay_3, 0),
2827 OVERLAY_INFO(overlay_4, 0),
2828 OVERLAY_INFO(overlay_5, 0),
2829 OVERLAY_INFO(overlay_6, 0),
2830 OVERLAY_INFO(overlay_7, 0),
2831 OVERLAY_INFO(overlay_8, 0),
2832 OVERLAY_INFO(overlay_9, 0),
2833 OVERLAY_INFO(overlay_10, 0),
2834 OVERLAY_INFO(overlay_11, 0),
2835 OVERLAY_INFO(overlay_12, 0),
2836 OVERLAY_INFO(overlay_13, 0),
2837 OVERLAY_INFO(overlay_15, 0),
2838 OVERLAY_INFO(overlay_gpio_01, 0),
2839 OVERLAY_INFO(overlay_gpio_02a, 0),
2840 OVERLAY_INFO(overlay_gpio_02b, 0),
2841 OVERLAY_INFO(overlay_gpio_03, 0),
2842 OVERLAY_INFO(overlay_gpio_04a, 0),
2843 OVERLAY_INFO(overlay_gpio_04b, 0),
2844 OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL),
2845 OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL),
2846 OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2847 OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2848 /* end marker */
2849 {.dtb_begin = NULL, .dtb_end = NULL, .expected_result = 0, .name = NULL}
2852 static struct device_node *overlay_base_root;
2854 static void * __init dt_alloc_memory(u64 size, u64 align)
2856 void *ptr = memblock_alloc(size, align);
2858 if (!ptr)
2859 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
2860 __func__, size, align);
2862 return ptr;
2866 * Create base device tree for the overlay unittest.
2868 * This is called from very early boot code.
2870 * Do as much as possible the same way as done in __unflatten_device_tree
2871 * and other early boot steps for the normal FDT so that the overlay base
2872 * unflattened tree will have the same characteristics as the real tree
2873 * (such as having memory allocated by the early allocator). The goal
2874 * is to test "the real thing" as much as possible, and test "test setup
2875 * code" as little as possible.
2877 * Have to stop before resolving phandles, because that uses kmalloc.
2879 void __init unittest_unflatten_overlay_base(void)
2881 struct overlay_info *info;
2882 u32 data_size;
2883 void *new_fdt;
2884 u32 size;
2885 int found = 0;
2886 const char *overlay_name = "overlay_base";
2888 for (info = overlays; info && info->name; info++) {
2889 if (!strcmp(overlay_name, info->name)) {
2890 found = 1;
2891 break;
2894 if (!found) {
2895 pr_err("no overlay data for %s\n", overlay_name);
2896 return;
2899 info = &overlays[0];
2901 if (info->expected_result != -9999) {
2902 pr_err("No dtb 'overlay_base' to attach\n");
2903 return;
2906 data_size = info->dtb_end - info->dtb_begin;
2907 if (!data_size) {
2908 pr_err("No dtb 'overlay_base' to attach\n");
2909 return;
2912 size = fdt_totalsize(info->dtb_begin);
2913 if (size != data_size) {
2914 pr_err("dtb 'overlay_base' header totalsize != actual size");
2915 return;
2918 new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2919 if (!new_fdt) {
2920 pr_err("alloc for dtb 'overlay_base' failed");
2921 return;
2924 memcpy(new_fdt, info->dtb_begin, size);
2926 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2927 dt_alloc_memory, true);
2931 * The purpose of of_unittest_overlay_data_add is to add an
2932 * overlay in the normal fashion. This is a test of the whole
2933 * picture, instead of testing individual elements.
2935 * A secondary purpose is to be able to verify that the contents of
2936 * /proc/device-tree/ contains the updated structure and values from
2937 * the overlay. That must be verified separately in user space.
2939 * Return 0 on unexpected error.
2941 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2943 struct overlay_info *info;
2944 int found = 0;
2945 int ret;
2946 u32 size;
2948 for (info = overlays; info && info->name; info++) {
2949 if (!strcmp(overlay_name, info->name)) {
2950 found = 1;
2951 break;
2954 if (!found) {
2955 pr_err("no overlay data for %s\n", overlay_name);
2956 return 0;
2959 size = info->dtb_end - info->dtb_begin;
2960 if (!size)
2961 pr_err("no overlay data for %s\n", overlay_name);
2963 ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2964 if (overlay_id)
2965 *overlay_id = info->overlay_id;
2966 if (ret < 0)
2967 goto out;
2969 pr_debug("%s applied\n", overlay_name);
2971 out:
2972 if (ret != info->expected_result)
2973 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2974 info->expected_result, ret, overlay_name);
2976 return (ret == info->expected_result);
2980 * The purpose of of_unittest_overlay_high_level is to add an overlay
2981 * in the normal fashion. This is a test of the whole picture,
2982 * instead of individual elements.
2984 * The first part of the function is _not_ normal overlay usage; it is
2985 * finishing splicing the base overlay device tree into the live tree.
2987 static __init void of_unittest_overlay_high_level(void)
2989 struct device_node *last_sibling;
2990 struct device_node *np;
2991 struct device_node *of_symbols;
2992 struct device_node *overlay_base_symbols;
2993 struct device_node **pprev;
2994 struct property *prop;
2995 int ret;
2997 if (!overlay_base_root) {
2998 unittest(0, "overlay_base_root not initialized\n");
2999 return;
3003 * Could not fixup phandles in unittest_unflatten_overlay_base()
3004 * because kmalloc() was not yet available.
3006 of_overlay_mutex_lock();
3007 of_resolve_phandles(overlay_base_root);
3008 of_overlay_mutex_unlock();
3012 * do not allow overlay_base to duplicate any node already in
3013 * tree, this greatly simplifies the code
3017 * remove overlay_base_root node "__local_fixups", after
3018 * being used by of_resolve_phandles()
3020 pprev = &overlay_base_root->child;
3021 for (np = overlay_base_root->child; np; np = np->sibling) {
3022 if (of_node_name_eq(np, "__local_fixups__")) {
3023 *pprev = np->sibling;
3024 break;
3026 pprev = &np->sibling;
3029 /* remove overlay_base_root node "__symbols__" if in live tree */
3030 of_symbols = of_get_child_by_name(of_root, "__symbols__");
3031 if (of_symbols) {
3032 /* will have to graft properties from node into live tree */
3033 pprev = &overlay_base_root->child;
3034 for (np = overlay_base_root->child; np; np = np->sibling) {
3035 if (of_node_name_eq(np, "__symbols__")) {
3036 overlay_base_symbols = np;
3037 *pprev = np->sibling;
3038 break;
3040 pprev = &np->sibling;
3044 for_each_child_of_node(overlay_base_root, np) {
3045 struct device_node *base_child;
3046 for_each_child_of_node(of_root, base_child) {
3047 if (!strcmp(np->full_name, base_child->full_name)) {
3048 unittest(0, "illegal node name in overlay_base %pOFn",
3049 np);
3050 return;
3056 * overlay 'overlay_base' is not allowed to have root
3057 * properties, so only need to splice nodes into main device tree.
3059 * root node of *overlay_base_root will not be freed, it is lost
3060 * memory.
3063 for (np = overlay_base_root->child; np; np = np->sibling)
3064 np->parent = of_root;
3066 mutex_lock(&of_mutex);
3068 for (last_sibling = np = of_root->child; np; np = np->sibling)
3069 last_sibling = np;
3071 if (last_sibling)
3072 last_sibling->sibling = overlay_base_root->child;
3073 else
3074 of_root->child = overlay_base_root->child;
3076 for_each_of_allnodes_from(overlay_base_root, np)
3077 __of_attach_node_sysfs(np);
3079 if (of_symbols) {
3080 struct property *new_prop;
3081 for_each_property_of_node(overlay_base_symbols, prop) {
3083 new_prop = __of_prop_dup(prop, GFP_KERNEL);
3084 if (!new_prop) {
3085 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
3086 prop->name);
3087 goto err_unlock;
3089 if (__of_add_property(of_symbols, new_prop)) {
3090 /* "name" auto-generated by unflatten */
3091 if (!strcmp(new_prop->name, "name"))
3092 continue;
3093 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
3094 prop->name);
3095 goto err_unlock;
3097 if (__of_add_property_sysfs(of_symbols, new_prop)) {
3098 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
3099 prop->name);
3100 goto err_unlock;
3105 mutex_unlock(&of_mutex);
3108 /* now do the normal overlay usage test */
3110 EXPECT_BEGIN(KERN_ERR,
3111 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3112 EXPECT_BEGIN(KERN_ERR,
3113 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3114 EXPECT_BEGIN(KERN_ERR,
3115 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3116 EXPECT_BEGIN(KERN_ERR,
3117 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3118 EXPECT_BEGIN(KERN_ERR,
3119 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3120 EXPECT_BEGIN(KERN_ERR,
3121 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3122 EXPECT_BEGIN(KERN_ERR,
3123 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3124 EXPECT_BEGIN(KERN_ERR,
3125 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3126 EXPECT_BEGIN(KERN_ERR,
3127 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3128 EXPECT_BEGIN(KERN_ERR,
3129 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3130 EXPECT_BEGIN(KERN_ERR,
3131 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3133 ret = overlay_data_apply("overlay", NULL);
3135 EXPECT_END(KERN_ERR,
3136 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3137 EXPECT_END(KERN_ERR,
3138 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3139 EXPECT_END(KERN_ERR,
3140 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3141 EXPECT_END(KERN_ERR,
3142 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3143 EXPECT_END(KERN_ERR,
3144 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3145 EXPECT_END(KERN_ERR,
3146 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3147 EXPECT_END(KERN_ERR,
3148 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3149 EXPECT_END(KERN_ERR,
3150 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3151 EXPECT_END(KERN_ERR,
3152 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3153 EXPECT_END(KERN_ERR,
3154 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3155 EXPECT_END(KERN_ERR,
3156 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3158 unittest(ret, "Adding overlay 'overlay' failed\n");
3160 EXPECT_BEGIN(KERN_ERR,
3161 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3162 EXPECT_BEGIN(KERN_ERR,
3163 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3165 unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
3166 "Adding overlay 'overlay_bad_add_dup_node' failed\n");
3168 EXPECT_END(KERN_ERR,
3169 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3170 EXPECT_END(KERN_ERR,
3171 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3173 EXPECT_BEGIN(KERN_ERR,
3174 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/motor-1/rpm_avail");
3175 EXPECT_BEGIN(KERN_ERR,
3176 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/motor-1/rpm_avail");
3177 EXPECT_BEGIN(KERN_ERR,
3178 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/rpm_avail");
3180 unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
3181 "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
3183 EXPECT_END(KERN_ERR,
3184 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/rpm_avail");
3185 EXPECT_END(KERN_ERR,
3186 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/motor-1/rpm_avail");
3187 EXPECT_END(KERN_ERR,
3188 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/motor-1/rpm_avail");
3190 unittest(overlay_data_apply("overlay_bad_phandle", NULL),
3191 "Adding overlay 'overlay_bad_phandle' failed\n");
3193 unittest(overlay_data_apply("overlay_bad_symbol", NULL),
3194 "Adding overlay 'overlay_bad_symbol' failed\n");
3196 return;
3198 err_unlock:
3199 mutex_unlock(&of_mutex);
3202 #else
3204 static inline __init void of_unittest_overlay_high_level(void) {}
3206 #endif
3208 static int __init of_unittest(void)
3210 struct device_node *np;
3211 int res;
3213 pr_info("start of unittest - you will see error messages\n");
3215 /* adding data for unittest */
3217 if (IS_ENABLED(CONFIG_UML))
3218 unittest_unflatten_overlay_base();
3220 res = unittest_data_add();
3221 if (res)
3222 return res;
3223 if (!of_aliases)
3224 of_aliases = of_find_node_by_path("/aliases");
3226 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
3227 if (!np) {
3228 pr_info("No testcase data in device tree; not running tests\n");
3229 return 0;
3231 of_node_put(np);
3233 of_unittest_check_tree_linkage();
3234 of_unittest_check_phandles();
3235 of_unittest_find_node_by_name();
3236 of_unittest_dynamic();
3237 of_unittest_parse_phandle_with_args();
3238 of_unittest_parse_phandle_with_args_map();
3239 of_unittest_printf();
3240 of_unittest_property_string();
3241 of_unittest_property_copy();
3242 of_unittest_changeset();
3243 of_unittest_parse_interrupts();
3244 of_unittest_parse_interrupts_extended();
3245 of_unittest_parse_dma_ranges();
3246 of_unittest_pci_dma_ranges();
3247 of_unittest_match_node();
3248 of_unittest_platform_populate();
3249 of_unittest_overlay();
3251 /* Double check linkage after removing testcase data */
3252 of_unittest_check_tree_linkage();
3254 of_unittest_overlay_high_level();
3256 pr_info("end of unittest - %i passed, %i failed\n",
3257 unittest_results.passed, unittest_results.failed);
3259 return 0;
3261 late_initcall(of_unittest);