ocfs2: avoid inode removal while nfsd is accessing it
[linux/fpc-iii.git] / drivers / of / unittest.c
blob398de04fd19c943e40ec0adb6d5bca92302c1979
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);
865 of_node_put(n1);
866 of_node_put(n2);
867 of_node_put(n21);
868 #endif
871 static void __init of_unittest_dma_ranges_one(const char *path,
872 u64 expect_dma_addr, u64 expect_paddr, u64 expect_size)
874 struct device_node *np;
875 u64 dma_addr, paddr, size;
876 int rc;
878 np = of_find_node_by_path(path);
879 if (!np) {
880 pr_err("missing testcase data\n");
881 return;
884 rc = of_dma_get_range(np, &dma_addr, &paddr, &size);
886 unittest(!rc, "of_dma_get_range failed on node %pOF rc=%i\n", np, rc);
887 if (!rc) {
888 unittest(size == expect_size,
889 "of_dma_get_range wrong size on node %pOF size=%llx\n", np, size);
890 unittest(paddr == expect_paddr,
891 "of_dma_get_range wrong phys addr (%llx) on node %pOF", paddr, np);
892 unittest(dma_addr == expect_dma_addr,
893 "of_dma_get_range wrong DMA addr (%llx) on node %pOF", dma_addr, np);
895 of_node_put(np);
898 static void __init of_unittest_parse_dma_ranges(void)
900 of_unittest_dma_ranges_one("/testcase-data/address-tests/device@70000000",
901 0x0, 0x20000000, 0x40000000);
902 of_unittest_dma_ranges_one("/testcase-data/address-tests/bus@80000000/device@1000",
903 0x10000000, 0x20000000, 0x40000000);
904 of_unittest_dma_ranges_one("/testcase-data/address-tests/pci@90000000",
905 0x80000000, 0x20000000, 0x10000000);
908 static void __init of_unittest_pci_dma_ranges(void)
910 struct device_node *np;
911 struct of_pci_range range;
912 struct of_pci_range_parser parser;
913 int i = 0;
915 if (!IS_ENABLED(CONFIG_PCI))
916 return;
918 np = of_find_node_by_path("/testcase-data/address-tests/pci@90000000");
919 if (!np) {
920 pr_err("missing testcase data\n");
921 return;
924 if (of_pci_dma_range_parser_init(&parser, np)) {
925 pr_err("missing dma-ranges property\n");
926 return;
930 * Get the dma-ranges from the device tree
932 for_each_of_pci_range(&parser, &range) {
933 if (!i) {
934 unittest(range.size == 0x10000000,
935 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
936 np, range.size);
937 unittest(range.cpu_addr == 0x20000000,
938 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
939 range.cpu_addr, np);
940 unittest(range.pci_addr == 0x80000000,
941 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
942 range.pci_addr, np);
943 } else {
944 unittest(range.size == 0x10000000,
945 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
946 np, range.size);
947 unittest(range.cpu_addr == 0x40000000,
948 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
949 range.cpu_addr, np);
950 unittest(range.pci_addr == 0xc0000000,
951 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
952 range.pci_addr, np);
954 i++;
957 of_node_put(np);
960 static void __init of_unittest_parse_interrupts(void)
962 struct device_node *np;
963 struct of_phandle_args args;
964 int i, rc;
966 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
967 return;
969 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
970 if (!np) {
971 pr_err("missing testcase data\n");
972 return;
975 for (i = 0; i < 4; i++) {
976 bool passed = true;
978 memset(&args, 0, sizeof(args));
979 rc = of_irq_parse_one(np, i, &args);
981 passed &= !rc;
982 passed &= (args.args_count == 1);
983 passed &= (args.args[0] == (i + 1));
985 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
986 i, args.np, rc);
988 of_node_put(np);
990 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
991 if (!np) {
992 pr_err("missing testcase data\n");
993 return;
996 for (i = 0; i < 4; i++) {
997 bool passed = true;
999 memset(&args, 0, sizeof(args));
1000 rc = of_irq_parse_one(np, i, &args);
1002 /* Test the values from tests-phandle.dtsi */
1003 switch (i) {
1004 case 0:
1005 passed &= !rc;
1006 passed &= (args.args_count == 1);
1007 passed &= (args.args[0] == 9);
1008 break;
1009 case 1:
1010 passed &= !rc;
1011 passed &= (args.args_count == 3);
1012 passed &= (args.args[0] == 10);
1013 passed &= (args.args[1] == 11);
1014 passed &= (args.args[2] == 12);
1015 break;
1016 case 2:
1017 passed &= !rc;
1018 passed &= (args.args_count == 2);
1019 passed &= (args.args[0] == 13);
1020 passed &= (args.args[1] == 14);
1021 break;
1022 case 3:
1023 passed &= !rc;
1024 passed &= (args.args_count == 2);
1025 passed &= (args.args[0] == 15);
1026 passed &= (args.args[1] == 16);
1027 break;
1028 default:
1029 passed = false;
1031 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1032 i, args.np, rc);
1034 of_node_put(np);
1037 static void __init of_unittest_parse_interrupts_extended(void)
1039 struct device_node *np;
1040 struct of_phandle_args args;
1041 int i, rc;
1043 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1044 return;
1046 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
1047 if (!np) {
1048 pr_err("missing testcase data\n");
1049 return;
1052 for (i = 0; i < 7; i++) {
1053 bool passed = true;
1055 memset(&args, 0, sizeof(args));
1056 rc = of_irq_parse_one(np, i, &args);
1058 /* Test the values from tests-phandle.dtsi */
1059 switch (i) {
1060 case 0:
1061 passed &= !rc;
1062 passed &= (args.args_count == 1);
1063 passed &= (args.args[0] == 1);
1064 break;
1065 case 1:
1066 passed &= !rc;
1067 passed &= (args.args_count == 3);
1068 passed &= (args.args[0] == 2);
1069 passed &= (args.args[1] == 3);
1070 passed &= (args.args[2] == 4);
1071 break;
1072 case 2:
1073 passed &= !rc;
1074 passed &= (args.args_count == 2);
1075 passed &= (args.args[0] == 5);
1076 passed &= (args.args[1] == 6);
1077 break;
1078 case 3:
1079 passed &= !rc;
1080 passed &= (args.args_count == 1);
1081 passed &= (args.args[0] == 9);
1082 break;
1083 case 4:
1084 passed &= !rc;
1085 passed &= (args.args_count == 3);
1086 passed &= (args.args[0] == 10);
1087 passed &= (args.args[1] == 11);
1088 passed &= (args.args[2] == 12);
1089 break;
1090 case 5:
1091 passed &= !rc;
1092 passed &= (args.args_count == 2);
1093 passed &= (args.args[0] == 13);
1094 passed &= (args.args[1] == 14);
1095 break;
1096 case 6:
1097 passed &= !rc;
1098 passed &= (args.args_count == 1);
1099 passed &= (args.args[0] == 15);
1100 break;
1101 default:
1102 passed = false;
1105 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1106 i, args.np, rc);
1108 of_node_put(np);
1111 static const struct of_device_id match_node_table[] = {
1112 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
1113 { .data = "B", .type = "type1", }, /* followed by type alone */
1115 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
1116 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
1117 { .data = "Cc", .name = "name2", .type = "type2", },
1119 { .data = "E", .compatible = "compat3" },
1120 { .data = "G", .compatible = "compat2", },
1121 { .data = "H", .compatible = "compat2", .name = "name5", },
1122 { .data = "I", .compatible = "compat2", .type = "type1", },
1123 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
1124 { .data = "K", .compatible = "compat2", .name = "name9", },
1128 static struct {
1129 const char *path;
1130 const char *data;
1131 } match_node_tests[] = {
1132 { .path = "/testcase-data/match-node/name0", .data = "A", },
1133 { .path = "/testcase-data/match-node/name1", .data = "B", },
1134 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
1135 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
1136 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
1137 { .path = "/testcase-data/match-node/name3", .data = "E", },
1138 { .path = "/testcase-data/match-node/name4", .data = "G", },
1139 { .path = "/testcase-data/match-node/name5", .data = "H", },
1140 { .path = "/testcase-data/match-node/name6", .data = "G", },
1141 { .path = "/testcase-data/match-node/name7", .data = "I", },
1142 { .path = "/testcase-data/match-node/name8", .data = "J", },
1143 { .path = "/testcase-data/match-node/name9", .data = "K", },
1146 static void __init of_unittest_match_node(void)
1148 struct device_node *np;
1149 const struct of_device_id *match;
1150 int i;
1152 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
1153 np = of_find_node_by_path(match_node_tests[i].path);
1154 if (!np) {
1155 unittest(0, "missing testcase node %s\n",
1156 match_node_tests[i].path);
1157 continue;
1160 match = of_match_node(match_node_table, np);
1161 if (!match) {
1162 unittest(0, "%s didn't match anything\n",
1163 match_node_tests[i].path);
1164 continue;
1167 if (strcmp(match->data, match_node_tests[i].data) != 0) {
1168 unittest(0, "%s got wrong match. expected %s, got %s\n",
1169 match_node_tests[i].path, match_node_tests[i].data,
1170 (const char *)match->data);
1171 continue;
1173 unittest(1, "passed");
1177 static struct resource test_bus_res = {
1178 .start = 0xfffffff8,
1179 .end = 0xfffffff9,
1180 .flags = IORESOURCE_MEM,
1182 static const struct platform_device_info test_bus_info = {
1183 .name = "unittest-bus",
1185 static void __init of_unittest_platform_populate(void)
1187 int irq, rc;
1188 struct device_node *np, *child, *grandchild;
1189 struct platform_device *pdev, *test_bus;
1190 const struct of_device_id match[] = {
1191 { .compatible = "test-device", },
1195 np = of_find_node_by_path("/testcase-data");
1196 of_platform_default_populate(np, NULL, NULL);
1198 /* Test that a missing irq domain returns -EPROBE_DEFER */
1199 np = of_find_node_by_path("/testcase-data/testcase-device1");
1200 pdev = of_find_device_by_node(np);
1201 unittest(pdev, "device 1 creation failed\n");
1203 if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1204 irq = platform_get_irq(pdev, 0);
1205 unittest(irq == -EPROBE_DEFER,
1206 "device deferred probe failed - %d\n", irq);
1208 /* Test that a parsing failure does not return -EPROBE_DEFER */
1209 np = of_find_node_by_path("/testcase-data/testcase-device2");
1210 pdev = of_find_device_by_node(np);
1211 unittest(pdev, "device 2 creation failed\n");
1213 EXPECT_BEGIN(KERN_INFO,
1214 "platform testcase-data:testcase-device2: IRQ index 0 not found");
1216 irq = platform_get_irq(pdev, 0);
1218 EXPECT_END(KERN_INFO,
1219 "platform testcase-data:testcase-device2: IRQ index 0 not found");
1221 unittest(irq < 0 && irq != -EPROBE_DEFER,
1222 "device parsing error failed - %d\n", irq);
1225 np = of_find_node_by_path("/testcase-data/platform-tests");
1226 unittest(np, "No testcase data in device tree\n");
1227 if (!np)
1228 return;
1230 test_bus = platform_device_register_full(&test_bus_info);
1231 rc = PTR_ERR_OR_ZERO(test_bus);
1232 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1233 if (rc) {
1234 of_node_put(np);
1235 return;
1237 test_bus->dev.of_node = np;
1240 * Add a dummy resource to the test bus node after it is
1241 * registered to catch problems with un-inserted resources. The
1242 * DT code doesn't insert the resources, and it has caused the
1243 * kernel to oops in the past. This makes sure the same bug
1244 * doesn't crop up again.
1246 platform_device_add_resources(test_bus, &test_bus_res, 1);
1248 of_platform_populate(np, match, NULL, &test_bus->dev);
1249 for_each_child_of_node(np, child) {
1250 for_each_child_of_node(child, grandchild) {
1251 pdev = of_find_device_by_node(grandchild);
1252 unittest(pdev,
1253 "Could not create device for node '%pOFn'\n",
1254 grandchild);
1255 of_dev_put(pdev);
1259 of_platform_depopulate(&test_bus->dev);
1260 for_each_child_of_node(np, child) {
1261 for_each_child_of_node(child, grandchild)
1262 unittest(!of_find_device_by_node(grandchild),
1263 "device didn't get destroyed '%pOFn'\n",
1264 grandchild);
1267 platform_device_unregister(test_bus);
1268 of_node_put(np);
1272 * update_node_properties - adds the properties
1273 * of np into dup node (present in live tree) and
1274 * updates parent of children of np to dup.
1276 * @np: node whose properties are being added to the live tree
1277 * @dup: node present in live tree to be updated
1279 static void update_node_properties(struct device_node *np,
1280 struct device_node *dup)
1282 struct property *prop;
1283 struct property *save_next;
1284 struct device_node *child;
1285 int ret;
1287 for_each_child_of_node(np, child)
1288 child->parent = dup;
1291 * "unittest internal error: unable to add testdata property"
1293 * If this message reports a property in node '/__symbols__' then
1294 * the respective unittest overlay contains a label that has the
1295 * same name as a label in the live devicetree. The label will
1296 * be in the live devicetree only if the devicetree source was
1297 * compiled with the '-@' option. If you encounter this error,
1298 * please consider renaming __all__ of the labels in the unittest
1299 * overlay dts files with an odd prefix that is unlikely to be
1300 * used in a real devicetree.
1304 * open code for_each_property_of_node() because of_add_property()
1305 * sets prop->next to NULL
1307 for (prop = np->properties; prop != NULL; prop = save_next) {
1308 save_next = prop->next;
1309 ret = of_add_property(dup, prop);
1310 if (ret) {
1311 if (ret == -EEXIST && !strcmp(prop->name, "name"))
1312 continue;
1313 pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1314 np, prop->name);
1320 * attach_node_and_children - attaches nodes
1321 * and its children to live tree.
1322 * CAUTION: misleading function name - if node @np already exists in
1323 * the live tree then children of @np are *not* attached to the live
1324 * tree. This works for the current test devicetree nodes because such
1325 * nodes do not have child nodes.
1327 * @np: Node to attach to live tree
1329 static void attach_node_and_children(struct device_node *np)
1331 struct device_node *next, *dup, *child;
1332 unsigned long flags;
1333 const char *full_name;
1335 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1337 if (!strcmp(full_name, "/__local_fixups__") ||
1338 !strcmp(full_name, "/__fixups__")) {
1339 kfree(full_name);
1340 return;
1343 dup = of_find_node_by_path(full_name);
1344 kfree(full_name);
1345 if (dup) {
1346 update_node_properties(np, dup);
1347 return;
1350 child = np->child;
1351 np->child = NULL;
1353 mutex_lock(&of_mutex);
1354 raw_spin_lock_irqsave(&devtree_lock, flags);
1355 np->sibling = np->parent->child;
1356 np->parent->child = np;
1357 of_node_clear_flag(np, OF_DETACHED);
1358 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1360 __of_attach_node_sysfs(np);
1361 mutex_unlock(&of_mutex);
1363 while (child) {
1364 next = child->sibling;
1365 attach_node_and_children(child);
1366 child = next;
1371 * unittest_data_add - Reads, copies data from
1372 * linked tree and attaches it to the live tree
1374 static int __init unittest_data_add(void)
1376 void *unittest_data;
1377 struct device_node *unittest_data_node, *np;
1379 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1380 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1382 extern uint8_t __dtb_testcases_begin[];
1383 extern uint8_t __dtb_testcases_end[];
1384 const int size = __dtb_testcases_end - __dtb_testcases_begin;
1385 int rc;
1387 if (!size) {
1388 pr_warn("%s: No testcase data to attach; not running tests\n",
1389 __func__);
1390 return -ENODATA;
1393 /* creating copy */
1394 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1395 if (!unittest_data)
1396 return -ENOMEM;
1398 of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1399 if (!unittest_data_node) {
1400 pr_warn("%s: No tree to attach; not running tests\n", __func__);
1401 kfree(unittest_data);
1402 return -ENODATA;
1406 * This lock normally encloses of_resolve_phandles()
1408 of_overlay_mutex_lock();
1410 rc = of_resolve_phandles(unittest_data_node);
1411 if (rc) {
1412 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1413 of_overlay_mutex_unlock();
1414 return -EINVAL;
1417 if (!of_root) {
1418 of_root = unittest_data_node;
1419 for_each_of_allnodes(np)
1420 __of_attach_node_sysfs(np);
1421 of_aliases = of_find_node_by_path("/aliases");
1422 of_chosen = of_find_node_by_path("/chosen");
1423 of_overlay_mutex_unlock();
1424 return 0;
1427 EXPECT_BEGIN(KERN_INFO,
1428 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1430 /* attach the sub-tree to live tree */
1431 np = unittest_data_node->child;
1432 while (np) {
1433 struct device_node *next = np->sibling;
1435 np->parent = of_root;
1436 attach_node_and_children(np);
1437 np = next;
1440 EXPECT_END(KERN_INFO,
1441 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1443 of_overlay_mutex_unlock();
1445 return 0;
1448 #ifdef CONFIG_OF_OVERLAY
1449 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1451 static int unittest_probe(struct platform_device *pdev)
1453 struct device *dev = &pdev->dev;
1454 struct device_node *np = dev->of_node;
1456 if (np == NULL) {
1457 dev_err(dev, "No OF data for device\n");
1458 return -EINVAL;
1462 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1464 of_platform_populate(np, NULL, NULL, &pdev->dev);
1466 return 0;
1469 static int unittest_remove(struct platform_device *pdev)
1471 struct device *dev = &pdev->dev;
1472 struct device_node *np = dev->of_node;
1474 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1475 return 0;
1478 static const struct of_device_id unittest_match[] = {
1479 { .compatible = "unittest", },
1483 static struct platform_driver unittest_driver = {
1484 .probe = unittest_probe,
1485 .remove = unittest_remove,
1486 .driver = {
1487 .name = "unittest",
1488 .of_match_table = of_match_ptr(unittest_match),
1492 /* get the platform device instantiated at the path */
1493 static struct platform_device *of_path_to_platform_device(const char *path)
1495 struct device_node *np;
1496 struct platform_device *pdev;
1498 np = of_find_node_by_path(path);
1499 if (np == NULL)
1500 return NULL;
1502 pdev = of_find_device_by_node(np);
1503 of_node_put(np);
1505 return pdev;
1508 /* find out if a platform device exists at that path */
1509 static int of_path_platform_device_exists(const char *path)
1511 struct platform_device *pdev;
1513 pdev = of_path_to_platform_device(path);
1514 platform_device_put(pdev);
1515 return pdev != NULL;
1518 #ifdef CONFIG_OF_GPIO
1520 struct unittest_gpio_dev {
1521 struct gpio_chip chip;
1524 static int unittest_gpio_chip_request_count;
1525 static int unittest_gpio_probe_count;
1526 static int unittest_gpio_probe_pass_count;
1528 static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
1530 unittest_gpio_chip_request_count++;
1532 pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
1533 unittest_gpio_chip_request_count);
1534 return 0;
1537 static int unittest_gpio_probe(struct platform_device *pdev)
1539 struct unittest_gpio_dev *devptr;
1540 int ret;
1542 unittest_gpio_probe_count++;
1544 devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
1545 if (!devptr)
1546 return -ENOMEM;
1548 platform_set_drvdata(pdev, devptr);
1550 devptr->chip.of_node = pdev->dev.of_node;
1551 devptr->chip.label = "of-unittest-gpio";
1552 devptr->chip.base = -1; /* dynamic allocation */
1553 devptr->chip.ngpio = 5;
1554 devptr->chip.request = unittest_gpio_chip_request;
1556 ret = gpiochip_add_data(&devptr->chip, NULL);
1558 unittest(!ret,
1559 "gpiochip_add_data() for node @%pOF failed, ret = %d\n", devptr->chip.of_node, ret);
1561 if (!ret)
1562 unittest_gpio_probe_pass_count++;
1563 return ret;
1566 static int unittest_gpio_remove(struct platform_device *pdev)
1568 struct unittest_gpio_dev *gdev = platform_get_drvdata(pdev);
1569 struct device *dev = &pdev->dev;
1570 struct device_node *np = pdev->dev.of_node;
1572 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1574 if (!gdev)
1575 return -EINVAL;
1577 if (gdev->chip.base != -1)
1578 gpiochip_remove(&gdev->chip);
1580 platform_set_drvdata(pdev, NULL);
1581 kfree(gdev);
1583 return 0;
1586 static const struct of_device_id unittest_gpio_id[] = {
1587 { .compatible = "unittest-gpio", },
1591 static struct platform_driver unittest_gpio_driver = {
1592 .probe = unittest_gpio_probe,
1593 .remove = unittest_gpio_remove,
1594 .driver = {
1595 .name = "unittest-gpio",
1596 .of_match_table = of_match_ptr(unittest_gpio_id),
1600 static void __init of_unittest_overlay_gpio(void)
1602 int chip_request_count;
1603 int probe_pass_count;
1604 int ret;
1607 * tests: apply overlays before registering driver
1608 * Similar to installing a driver as a module, the
1609 * driver is registered after applying the overlays.
1611 * The overlays are applied by overlay_data_apply()
1612 * instead of of_unittest_apply_overlay() so that they
1613 * will not be tracked. Thus they will not be removed
1614 * by of_unittest_destroy_tracked_overlays().
1616 * - apply overlay_gpio_01
1617 * - apply overlay_gpio_02a
1618 * - apply overlay_gpio_02b
1619 * - register driver
1621 * register driver will result in
1622 * - probe and processing gpio hog for overlay_gpio_01
1623 * - probe for overlay_gpio_02a
1624 * - processing gpio for overlay_gpio_02b
1627 probe_pass_count = unittest_gpio_probe_pass_count;
1628 chip_request_count = unittest_gpio_chip_request_count;
1631 * overlay_gpio_01 contains gpio node and child gpio hog node
1632 * overlay_gpio_02a contains gpio node
1633 * overlay_gpio_02b contains child gpio hog node
1636 unittest(overlay_data_apply("overlay_gpio_01", NULL),
1637 "Adding overlay 'overlay_gpio_01' failed\n");
1639 unittest(overlay_data_apply("overlay_gpio_02a", NULL),
1640 "Adding overlay 'overlay_gpio_02a' failed\n");
1642 unittest(overlay_data_apply("overlay_gpio_02b", NULL),
1643 "Adding overlay 'overlay_gpio_02b' failed\n");
1646 * messages are the result of the probes, after the
1647 * driver is registered
1650 EXPECT_BEGIN(KERN_INFO,
1651 "GPIO line <<int>> (line-B-input) hogged as input\n");
1653 EXPECT_BEGIN(KERN_INFO,
1654 "GPIO line <<int>> (line-A-input) hogged as input\n");
1656 ret = platform_driver_register(&unittest_gpio_driver);
1657 if (unittest(ret == 0, "could not register unittest gpio driver\n"))
1658 return;
1660 EXPECT_END(KERN_INFO,
1661 "GPIO line <<int>> (line-A-input) hogged as input\n");
1662 EXPECT_END(KERN_INFO,
1663 "GPIO line <<int>> (line-B-input) hogged as input\n");
1665 unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
1666 "unittest_gpio_probe() failed or not called\n");
1668 unittest(chip_request_count + 2 == unittest_gpio_chip_request_count,
1669 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1670 unittest_gpio_chip_request_count - chip_request_count);
1673 * tests: apply overlays after registering driver
1675 * Similar to a driver built-in to the kernel, the
1676 * driver is registered before applying the overlays.
1678 * overlay_gpio_03 contains gpio node and child gpio hog node
1680 * - apply overlay_gpio_03
1682 * apply overlay will result in
1683 * - probe and processing gpio hog.
1686 probe_pass_count = unittest_gpio_probe_pass_count;
1687 chip_request_count = unittest_gpio_chip_request_count;
1689 EXPECT_BEGIN(KERN_INFO,
1690 "GPIO line <<int>> (line-D-input) hogged as input\n");
1692 /* overlay_gpio_03 contains gpio node and child gpio hog node */
1694 unittest(overlay_data_apply("overlay_gpio_03", NULL),
1695 "Adding overlay 'overlay_gpio_03' failed\n");
1697 EXPECT_END(KERN_INFO,
1698 "GPIO line <<int>> (line-D-input) hogged as input\n");
1700 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1701 "unittest_gpio_probe() failed or not called\n");
1703 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1704 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1705 unittest_gpio_chip_request_count - chip_request_count);
1708 * overlay_gpio_04a contains gpio node
1710 * - apply overlay_gpio_04a
1712 * apply the overlay will result in
1713 * - probe for overlay_gpio_04a
1716 probe_pass_count = unittest_gpio_probe_pass_count;
1717 chip_request_count = unittest_gpio_chip_request_count;
1719 /* overlay_gpio_04a contains gpio node */
1721 unittest(overlay_data_apply("overlay_gpio_04a", NULL),
1722 "Adding overlay 'overlay_gpio_04a' failed\n");
1724 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1725 "unittest_gpio_probe() failed or not called\n");
1728 * overlay_gpio_04b contains child gpio hog node
1730 * - apply overlay_gpio_04b
1732 * apply the overlay will result in
1733 * - processing gpio for overlay_gpio_04b
1736 EXPECT_BEGIN(KERN_INFO,
1737 "GPIO line <<int>> (line-C-input) hogged as input\n");
1739 /* overlay_gpio_04b contains child gpio hog node */
1741 unittest(overlay_data_apply("overlay_gpio_04b", NULL),
1742 "Adding overlay 'overlay_gpio_04b' failed\n");
1744 EXPECT_END(KERN_INFO,
1745 "GPIO line <<int>> (line-C-input) hogged as input\n");
1747 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1748 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1749 unittest_gpio_chip_request_count - chip_request_count);
1752 #else
1754 static void __init of_unittest_overlay_gpio(void)
1756 /* skip tests */
1759 #endif
1761 #if IS_BUILTIN(CONFIG_I2C)
1763 /* get the i2c client device instantiated at the path */
1764 static struct i2c_client *of_path_to_i2c_client(const char *path)
1766 struct device_node *np;
1767 struct i2c_client *client;
1769 np = of_find_node_by_path(path);
1770 if (np == NULL)
1771 return NULL;
1773 client = of_find_i2c_device_by_node(np);
1774 of_node_put(np);
1776 return client;
1779 /* find out if a i2c client device exists at that path */
1780 static int of_path_i2c_client_exists(const char *path)
1782 struct i2c_client *client;
1784 client = of_path_to_i2c_client(path);
1785 if (client)
1786 put_device(&client->dev);
1787 return client != NULL;
1789 #else
1790 static int of_path_i2c_client_exists(const char *path)
1792 return 0;
1794 #endif
1796 enum overlay_type {
1797 PDEV_OVERLAY,
1798 I2C_OVERLAY
1801 static int of_path_device_type_exists(const char *path,
1802 enum overlay_type ovtype)
1804 switch (ovtype) {
1805 case PDEV_OVERLAY:
1806 return of_path_platform_device_exists(path);
1807 case I2C_OVERLAY:
1808 return of_path_i2c_client_exists(path);
1810 return 0;
1813 static const char *unittest_path(int nr, enum overlay_type ovtype)
1815 const char *base;
1816 static char buf[256];
1818 switch (ovtype) {
1819 case PDEV_OVERLAY:
1820 base = "/testcase-data/overlay-node/test-bus";
1821 break;
1822 case I2C_OVERLAY:
1823 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1824 break;
1825 default:
1826 buf[0] = '\0';
1827 return buf;
1829 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1830 buf[sizeof(buf) - 1] = '\0';
1831 return buf;
1834 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1836 const char *path;
1838 path = unittest_path(unittest_nr, ovtype);
1840 switch (ovtype) {
1841 case PDEV_OVERLAY:
1842 return of_path_platform_device_exists(path);
1843 case I2C_OVERLAY:
1844 return of_path_i2c_client_exists(path);
1846 return 0;
1849 static const char *overlay_name_from_nr(int nr)
1851 static char buf[256];
1853 snprintf(buf, sizeof(buf) - 1,
1854 "overlay_%d", nr);
1855 buf[sizeof(buf) - 1] = '\0';
1857 return buf;
1860 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1862 /* FIXME: it is NOT guaranteed that overlay ids are assigned in sequence */
1864 #define MAX_UNITTEST_OVERLAYS 256
1865 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1866 static int overlay_first_id = -1;
1868 static long of_unittest_overlay_tracked(int id)
1870 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1871 return 0;
1872 return overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id);
1875 static void of_unittest_track_overlay(int id)
1877 if (overlay_first_id < 0)
1878 overlay_first_id = id;
1879 id -= overlay_first_id;
1881 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1882 return;
1883 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1886 static void of_unittest_untrack_overlay(int id)
1888 if (overlay_first_id < 0)
1889 return;
1890 id -= overlay_first_id;
1891 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1892 return;
1893 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1896 static void of_unittest_destroy_tracked_overlays(void)
1898 int id, ret, defers, ovcs_id;
1900 if (overlay_first_id < 0)
1901 return;
1903 /* try until no defers */
1904 do {
1905 defers = 0;
1906 /* remove in reverse order */
1907 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1908 if (!of_unittest_overlay_tracked(id))
1909 continue;
1911 ovcs_id = id + overlay_first_id;
1912 ret = of_overlay_remove(&ovcs_id);
1913 if (ret == -ENODEV) {
1914 pr_warn("%s: no overlay to destroy for #%d\n",
1915 __func__, id + overlay_first_id);
1916 continue;
1918 if (ret != 0) {
1919 defers++;
1920 pr_warn("%s: overlay destroy failed for #%d\n",
1921 __func__, id + overlay_first_id);
1922 continue;
1925 of_unittest_untrack_overlay(id);
1927 } while (defers > 0);
1930 static int __init of_unittest_apply_overlay(int overlay_nr, int *overlay_id)
1932 const char *overlay_name;
1934 overlay_name = overlay_name_from_nr(overlay_nr);
1936 if (!overlay_data_apply(overlay_name, overlay_id)) {
1937 unittest(0, "could not apply overlay \"%s\"\n",
1938 overlay_name);
1939 return -EFAULT;
1941 of_unittest_track_overlay(*overlay_id);
1943 return 0;
1946 /* apply an overlay while checking before and after states */
1947 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1948 int unittest_nr, int before, int after,
1949 enum overlay_type ovtype)
1951 int ret, ovcs_id;
1953 /* unittest device must not be in before state */
1954 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1955 unittest(0, "%s with device @\"%s\" %s\n",
1956 overlay_name_from_nr(overlay_nr),
1957 unittest_path(unittest_nr, ovtype),
1958 !before ? "enabled" : "disabled");
1959 return -EINVAL;
1962 ovcs_id = 0;
1963 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
1964 if (ret != 0) {
1965 /* of_unittest_apply_overlay already called unittest() */
1966 return ret;
1969 /* unittest device must be to set to after state */
1970 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1971 unittest(0, "%s failed to create @\"%s\" %s\n",
1972 overlay_name_from_nr(overlay_nr),
1973 unittest_path(unittest_nr, ovtype),
1974 !after ? "enabled" : "disabled");
1975 return -EINVAL;
1978 return 0;
1981 /* apply an overlay and then revert it while checking before, after states */
1982 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1983 int unittest_nr, int before, int after,
1984 enum overlay_type ovtype)
1986 int ret, ovcs_id, save_id;
1988 /* unittest device must be in before state */
1989 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1990 unittest(0, "%s with device @\"%s\" %s\n",
1991 overlay_name_from_nr(overlay_nr),
1992 unittest_path(unittest_nr, ovtype),
1993 !before ? "enabled" : "disabled");
1994 return -EINVAL;
1997 /* apply the overlay */
1998 ovcs_id = 0;
1999 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2000 if (ret != 0) {
2001 /* of_unittest_apply_overlay already called unittest() */
2002 return ret;
2005 /* unittest device must be in after state */
2006 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2007 unittest(0, "%s failed to create @\"%s\" %s\n",
2008 overlay_name_from_nr(overlay_nr),
2009 unittest_path(unittest_nr, ovtype),
2010 !after ? "enabled" : "disabled");
2011 return -EINVAL;
2014 save_id = ovcs_id;
2015 ret = of_overlay_remove(&ovcs_id);
2016 if (ret != 0) {
2017 unittest(0, "%s failed to be destroyed @\"%s\"\n",
2018 overlay_name_from_nr(overlay_nr),
2019 unittest_path(unittest_nr, ovtype));
2020 return ret;
2022 of_unittest_untrack_overlay(save_id);
2024 /* unittest device must be again in before state */
2025 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
2026 unittest(0, "%s with device @\"%s\" %s\n",
2027 overlay_name_from_nr(overlay_nr),
2028 unittest_path(unittest_nr, ovtype),
2029 !before ? "enabled" : "disabled");
2030 return -EINVAL;
2033 return 0;
2036 /* test activation of device */
2037 static void __init of_unittest_overlay_0(void)
2039 int ret;
2041 EXPECT_BEGIN(KERN_INFO,
2042 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2044 /* device should enable */
2045 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
2047 EXPECT_END(KERN_INFO,
2048 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2050 if (ret)
2051 return;
2053 unittest(1, "overlay test %d passed\n", 0);
2056 /* test deactivation of device */
2057 static void __init of_unittest_overlay_1(void)
2059 int ret;
2061 EXPECT_BEGIN(KERN_INFO,
2062 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2064 /* device should disable */
2065 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
2067 EXPECT_END(KERN_INFO,
2068 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2070 if (ret)
2071 return;
2073 unittest(1, "overlay test %d passed\n", 1);
2077 /* test activation of device */
2078 static void __init of_unittest_overlay_2(void)
2080 int ret;
2082 EXPECT_BEGIN(KERN_INFO,
2083 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2085 /* device should enable */
2086 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
2088 EXPECT_END(KERN_INFO,
2089 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2091 if (ret)
2092 return;
2093 unittest(1, "overlay test %d passed\n", 2);
2096 /* test deactivation of device */
2097 static void __init of_unittest_overlay_3(void)
2099 int ret;
2101 EXPECT_BEGIN(KERN_INFO,
2102 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2104 /* device should disable */
2105 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
2107 EXPECT_END(KERN_INFO,
2108 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2110 if (ret)
2111 return;
2113 unittest(1, "overlay test %d passed\n", 3);
2116 /* test activation of a full device node */
2117 static void __init of_unittest_overlay_4(void)
2119 /* device should disable */
2120 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
2121 return;
2123 unittest(1, "overlay test %d passed\n", 4);
2126 /* test overlay apply/revert sequence */
2127 static void __init of_unittest_overlay_5(void)
2129 int ret;
2131 EXPECT_BEGIN(KERN_INFO,
2132 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2134 /* device should disable */
2135 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
2137 EXPECT_END(KERN_INFO,
2138 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2140 if (ret)
2141 return;
2143 unittest(1, "overlay test %d passed\n", 5);
2146 /* test overlay application in sequence */
2147 static void __init of_unittest_overlay_6(void)
2149 int i, ov_id[2], ovcs_id;
2150 int overlay_nr = 6, unittest_nr = 6;
2151 int before = 0, after = 1;
2152 const char *overlay_name;
2154 int ret;
2156 /* unittest device must be in before state */
2157 for (i = 0; i < 2; i++) {
2158 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2159 != before) {
2160 unittest(0, "%s with device @\"%s\" %s\n",
2161 overlay_name_from_nr(overlay_nr + i),
2162 unittest_path(unittest_nr + i,
2163 PDEV_OVERLAY),
2164 !before ? "enabled" : "disabled");
2165 return;
2169 /* apply the overlays */
2171 EXPECT_BEGIN(KERN_INFO,
2172 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2174 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2176 ret = overlay_data_apply(overlay_name, &ovcs_id);
2178 if (!ret) {
2179 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2180 return;
2182 ov_id[0] = ovcs_id;
2183 of_unittest_track_overlay(ov_id[0]);
2185 EXPECT_END(KERN_INFO,
2186 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2188 EXPECT_BEGIN(KERN_INFO,
2189 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2191 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2193 ret = overlay_data_apply(overlay_name, &ovcs_id);
2195 if (!ret) {
2196 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2197 return;
2199 ov_id[1] = ovcs_id;
2200 of_unittest_track_overlay(ov_id[1]);
2202 EXPECT_END(KERN_INFO,
2203 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2206 for (i = 0; i < 2; i++) {
2207 /* unittest device must be in after state */
2208 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2209 != after) {
2210 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
2211 overlay_name_from_nr(overlay_nr + i),
2212 unittest_path(unittest_nr + i,
2213 PDEV_OVERLAY),
2214 !after ? "enabled" : "disabled");
2215 return;
2219 for (i = 1; i >= 0; i--) {
2220 ovcs_id = ov_id[i];
2221 if (of_overlay_remove(&ovcs_id)) {
2222 unittest(0, "%s failed destroy @\"%s\"\n",
2223 overlay_name_from_nr(overlay_nr + i),
2224 unittest_path(unittest_nr + i,
2225 PDEV_OVERLAY));
2226 return;
2228 of_unittest_untrack_overlay(ov_id[i]);
2231 for (i = 0; i < 2; i++) {
2232 /* unittest device must be again in before state */
2233 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2234 != before) {
2235 unittest(0, "%s with device @\"%s\" %s\n",
2236 overlay_name_from_nr(overlay_nr + i),
2237 unittest_path(unittest_nr + i,
2238 PDEV_OVERLAY),
2239 !before ? "enabled" : "disabled");
2240 return;
2244 unittest(1, "overlay test %d passed\n", 6);
2248 /* test overlay application in sequence */
2249 static void __init of_unittest_overlay_8(void)
2251 int i, ov_id[2], ovcs_id;
2252 int overlay_nr = 8, unittest_nr = 8;
2253 const char *overlay_name;
2254 int ret;
2256 /* we don't care about device state in this test */
2258 EXPECT_BEGIN(KERN_INFO,
2259 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2261 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2263 ret = overlay_data_apply(overlay_name, &ovcs_id);
2264 if (!ret)
2265 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2267 EXPECT_END(KERN_INFO,
2268 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2270 if (!ret)
2271 return;
2273 ov_id[0] = ovcs_id;
2274 of_unittest_track_overlay(ov_id[0]);
2276 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2278 EXPECT_BEGIN(KERN_INFO,
2279 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2281 /* apply the overlays */
2282 ret = overlay_data_apply(overlay_name, &ovcs_id);
2284 EXPECT_END(KERN_INFO,
2285 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2287 if (!ret) {
2288 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2289 return;
2292 ov_id[1] = ovcs_id;
2293 of_unittest_track_overlay(ov_id[1]);
2295 /* now try to remove first overlay (it should fail) */
2296 ovcs_id = ov_id[0];
2298 EXPECT_BEGIN(KERN_INFO,
2299 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2301 EXPECT_BEGIN(KERN_INFO,
2302 "OF: overlay: overlay #6 is not topmost");
2304 ret = of_overlay_remove(&ovcs_id);
2306 EXPECT_END(KERN_INFO,
2307 "OF: overlay: overlay #6 is not topmost");
2309 EXPECT_END(KERN_INFO,
2310 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2312 if (!ret) {
2313 unittest(0, "%s was destroyed @\"%s\"\n",
2314 overlay_name_from_nr(overlay_nr + 0),
2315 unittest_path(unittest_nr,
2316 PDEV_OVERLAY));
2317 return;
2320 /* removing them in order should work */
2321 for (i = 1; i >= 0; i--) {
2322 ovcs_id = ov_id[i];
2323 if (of_overlay_remove(&ovcs_id)) {
2324 unittest(0, "%s not destroyed @\"%s\"\n",
2325 overlay_name_from_nr(overlay_nr + i),
2326 unittest_path(unittest_nr,
2327 PDEV_OVERLAY));
2328 return;
2330 of_unittest_untrack_overlay(ov_id[i]);
2333 unittest(1, "overlay test %d passed\n", 8);
2336 /* test insertion of a bus with parent devices */
2337 static void __init of_unittest_overlay_10(void)
2339 int ret;
2340 char *child_path;
2342 /* device should disable */
2343 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
2345 if (unittest(ret == 0,
2346 "overlay test %d failed; overlay application\n", 10))
2347 return;
2349 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
2350 unittest_path(10, PDEV_OVERLAY));
2351 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
2352 return;
2354 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
2355 kfree(child_path);
2357 unittest(ret, "overlay test %d failed; no child device\n", 10);
2360 /* test insertion of a bus with parent devices (and revert) */
2361 static void __init of_unittest_overlay_11(void)
2363 int ret;
2365 /* device should disable */
2366 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
2367 PDEV_OVERLAY);
2369 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2372 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2374 struct unittest_i2c_bus_data {
2375 struct platform_device *pdev;
2376 struct i2c_adapter adap;
2379 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2380 struct i2c_msg *msgs, int num)
2382 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2384 (void)std;
2386 return num;
2389 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2391 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2394 static const struct i2c_algorithm unittest_i2c_algo = {
2395 .master_xfer = unittest_i2c_master_xfer,
2396 .functionality = unittest_i2c_functionality,
2399 static int unittest_i2c_bus_probe(struct platform_device *pdev)
2401 struct device *dev = &pdev->dev;
2402 struct device_node *np = dev->of_node;
2403 struct unittest_i2c_bus_data *std;
2404 struct i2c_adapter *adap;
2405 int ret;
2407 if (np == NULL) {
2408 dev_err(dev, "No OF data for device\n");
2409 return -EINVAL;
2413 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2415 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
2416 if (!std)
2417 return -ENOMEM;
2419 /* link them together */
2420 std->pdev = pdev;
2421 platform_set_drvdata(pdev, std);
2423 adap = &std->adap;
2424 i2c_set_adapdata(adap, std);
2425 adap->nr = -1;
2426 strlcpy(adap->name, pdev->name, sizeof(adap->name));
2427 adap->class = I2C_CLASS_DEPRECATED;
2428 adap->algo = &unittest_i2c_algo;
2429 adap->dev.parent = dev;
2430 adap->dev.of_node = dev->of_node;
2431 adap->timeout = 5 * HZ;
2432 adap->retries = 3;
2434 ret = i2c_add_numbered_adapter(adap);
2435 if (ret != 0) {
2436 dev_err(dev, "Failed to add I2C adapter\n");
2437 return ret;
2440 return 0;
2443 static int unittest_i2c_bus_remove(struct platform_device *pdev)
2445 struct device *dev = &pdev->dev;
2446 struct device_node *np = dev->of_node;
2447 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
2449 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2450 i2c_del_adapter(&std->adap);
2452 return 0;
2455 static const struct of_device_id unittest_i2c_bus_match[] = {
2456 { .compatible = "unittest-i2c-bus", },
2460 static struct platform_driver unittest_i2c_bus_driver = {
2461 .probe = unittest_i2c_bus_probe,
2462 .remove = unittest_i2c_bus_remove,
2463 .driver = {
2464 .name = "unittest-i2c-bus",
2465 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
2469 static int unittest_i2c_dev_probe(struct i2c_client *client,
2470 const struct i2c_device_id *id)
2472 struct device *dev = &client->dev;
2473 struct device_node *np = client->dev.of_node;
2475 if (!np) {
2476 dev_err(dev, "No OF node\n");
2477 return -EINVAL;
2480 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2482 return 0;
2485 static int unittest_i2c_dev_remove(struct i2c_client *client)
2487 struct device *dev = &client->dev;
2488 struct device_node *np = client->dev.of_node;
2490 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2491 return 0;
2494 static const struct i2c_device_id unittest_i2c_dev_id[] = {
2495 { .name = "unittest-i2c-dev" },
2499 static struct i2c_driver unittest_i2c_dev_driver = {
2500 .driver = {
2501 .name = "unittest-i2c-dev",
2503 .probe = unittest_i2c_dev_probe,
2504 .remove = unittest_i2c_dev_remove,
2505 .id_table = unittest_i2c_dev_id,
2508 #if IS_BUILTIN(CONFIG_I2C_MUX)
2510 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
2512 return 0;
2515 static int unittest_i2c_mux_probe(struct i2c_client *client,
2516 const struct i2c_device_id *id)
2518 int i, nchans;
2519 struct device *dev = &client->dev;
2520 struct i2c_adapter *adap = client->adapter;
2521 struct device_node *np = client->dev.of_node, *child;
2522 struct i2c_mux_core *muxc;
2523 u32 reg, max_reg;
2525 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2527 if (!np) {
2528 dev_err(dev, "No OF node\n");
2529 return -EINVAL;
2532 max_reg = (u32)-1;
2533 for_each_child_of_node(np, child) {
2534 if (of_property_read_u32(child, "reg", &reg))
2535 continue;
2536 if (max_reg == (u32)-1 || reg > max_reg)
2537 max_reg = reg;
2539 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
2540 if (nchans == 0) {
2541 dev_err(dev, "No channels\n");
2542 return -EINVAL;
2545 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
2546 unittest_i2c_mux_select_chan, NULL);
2547 if (!muxc)
2548 return -ENOMEM;
2549 for (i = 0; i < nchans; i++) {
2550 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
2551 dev_err(dev, "Failed to register mux #%d\n", i);
2552 i2c_mux_del_adapters(muxc);
2553 return -ENODEV;
2557 i2c_set_clientdata(client, muxc);
2559 return 0;
2562 static int unittest_i2c_mux_remove(struct i2c_client *client)
2564 struct device *dev = &client->dev;
2565 struct device_node *np = client->dev.of_node;
2566 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
2568 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2569 i2c_mux_del_adapters(muxc);
2570 return 0;
2573 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2574 { .name = "unittest-i2c-mux" },
2578 static struct i2c_driver unittest_i2c_mux_driver = {
2579 .driver = {
2580 .name = "unittest-i2c-mux",
2582 .probe = unittest_i2c_mux_probe,
2583 .remove = unittest_i2c_mux_remove,
2584 .id_table = unittest_i2c_mux_id,
2587 #endif
2589 static int of_unittest_overlay_i2c_init(void)
2591 int ret;
2593 ret = i2c_add_driver(&unittest_i2c_dev_driver);
2594 if (unittest(ret == 0,
2595 "could not register unittest i2c device driver\n"))
2596 return ret;
2598 ret = platform_driver_register(&unittest_i2c_bus_driver);
2600 if (unittest(ret == 0,
2601 "could not register unittest i2c bus driver\n"))
2602 return ret;
2604 #if IS_BUILTIN(CONFIG_I2C_MUX)
2606 EXPECT_BEGIN(KERN_INFO,
2607 "i2c i2c-1: Added multiplexed i2c bus 2");
2609 ret = i2c_add_driver(&unittest_i2c_mux_driver);
2611 EXPECT_END(KERN_INFO,
2612 "i2c i2c-1: Added multiplexed i2c bus 2");
2614 if (unittest(ret == 0,
2615 "could not register unittest i2c mux driver\n"))
2616 return ret;
2617 #endif
2619 return 0;
2622 static void of_unittest_overlay_i2c_cleanup(void)
2624 #if IS_BUILTIN(CONFIG_I2C_MUX)
2625 i2c_del_driver(&unittest_i2c_mux_driver);
2626 #endif
2627 platform_driver_unregister(&unittest_i2c_bus_driver);
2628 i2c_del_driver(&unittest_i2c_dev_driver);
2631 static void __init of_unittest_overlay_i2c_12(void)
2633 int ret;
2635 /* device should enable */
2636 EXPECT_BEGIN(KERN_INFO,
2637 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2639 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
2641 EXPECT_END(KERN_INFO,
2642 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2644 if (ret)
2645 return;
2647 unittest(1, "overlay test %d passed\n", 12);
2650 /* test deactivation of device */
2651 static void __init of_unittest_overlay_i2c_13(void)
2653 int ret;
2655 EXPECT_BEGIN(KERN_INFO,
2656 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2658 /* device should disable */
2659 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
2661 EXPECT_END(KERN_INFO,
2662 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2664 if (ret)
2665 return;
2667 unittest(1, "overlay test %d passed\n", 13);
2670 /* just check for i2c mux existence */
2671 static void of_unittest_overlay_i2c_14(void)
2675 static void __init of_unittest_overlay_i2c_15(void)
2677 int ret;
2679 /* device should enable */
2680 EXPECT_BEGIN(KERN_INFO,
2681 "i2c i2c-1: Added multiplexed i2c bus 3");
2683 ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
2685 EXPECT_END(KERN_INFO,
2686 "i2c i2c-1: Added multiplexed i2c bus 3");
2688 if (ret)
2689 return;
2691 unittest(1, "overlay test %d passed\n", 15);
2694 #else
2696 static inline void of_unittest_overlay_i2c_14(void) { }
2697 static inline void of_unittest_overlay_i2c_15(void) { }
2699 #endif
2701 static void __init of_unittest_overlay(void)
2703 struct device_node *bus_np = NULL;
2705 if (platform_driver_register(&unittest_driver)) {
2706 unittest(0, "could not register unittest driver\n");
2707 goto out;
2710 bus_np = of_find_node_by_path(bus_path);
2711 if (bus_np == NULL) {
2712 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2713 goto out;
2716 if (of_platform_default_populate(bus_np, NULL, NULL)) {
2717 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2718 goto out;
2721 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2722 unittest(0, "could not find unittest0 @ \"%s\"\n",
2723 unittest_path(100, PDEV_OVERLAY));
2724 goto out;
2727 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2728 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2729 unittest_path(101, PDEV_OVERLAY));
2730 goto out;
2733 unittest(1, "basic infrastructure of overlays passed");
2735 /* tests in sequence */
2736 of_unittest_overlay_0();
2737 of_unittest_overlay_1();
2738 of_unittest_overlay_2();
2739 of_unittest_overlay_3();
2740 of_unittest_overlay_4();
2741 of_unittest_overlay_5();
2742 of_unittest_overlay_6();
2743 of_unittest_overlay_8();
2745 of_unittest_overlay_10();
2746 of_unittest_overlay_11();
2748 #if IS_BUILTIN(CONFIG_I2C)
2749 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2750 goto out;
2752 of_unittest_overlay_i2c_12();
2753 of_unittest_overlay_i2c_13();
2754 of_unittest_overlay_i2c_14();
2755 of_unittest_overlay_i2c_15();
2757 of_unittest_overlay_i2c_cleanup();
2758 #endif
2760 of_unittest_overlay_gpio();
2762 of_unittest_destroy_tracked_overlays();
2764 out:
2765 of_node_put(bus_np);
2768 #else
2769 static inline void __init of_unittest_overlay(void) { }
2770 #endif
2772 #ifdef CONFIG_OF_OVERLAY
2775 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2776 * in scripts/Makefile.lib
2779 #define OVERLAY_INFO_EXTERN(name) \
2780 extern uint8_t __dtb_##name##_begin[]; \
2781 extern uint8_t __dtb_##name##_end[]
2783 #define OVERLAY_INFO(overlay_name, expected) \
2784 { .dtb_begin = __dtb_##overlay_name##_begin, \
2785 .dtb_end = __dtb_##overlay_name##_end, \
2786 .expected_result = expected, \
2787 .name = #overlay_name, \
2790 struct overlay_info {
2791 uint8_t *dtb_begin;
2792 uint8_t *dtb_end;
2793 int expected_result;
2794 int overlay_id;
2795 char *name;
2798 OVERLAY_INFO_EXTERN(overlay_base);
2799 OVERLAY_INFO_EXTERN(overlay);
2800 OVERLAY_INFO_EXTERN(overlay_0);
2801 OVERLAY_INFO_EXTERN(overlay_1);
2802 OVERLAY_INFO_EXTERN(overlay_2);
2803 OVERLAY_INFO_EXTERN(overlay_3);
2804 OVERLAY_INFO_EXTERN(overlay_4);
2805 OVERLAY_INFO_EXTERN(overlay_5);
2806 OVERLAY_INFO_EXTERN(overlay_6);
2807 OVERLAY_INFO_EXTERN(overlay_7);
2808 OVERLAY_INFO_EXTERN(overlay_8);
2809 OVERLAY_INFO_EXTERN(overlay_9);
2810 OVERLAY_INFO_EXTERN(overlay_10);
2811 OVERLAY_INFO_EXTERN(overlay_11);
2812 OVERLAY_INFO_EXTERN(overlay_12);
2813 OVERLAY_INFO_EXTERN(overlay_13);
2814 OVERLAY_INFO_EXTERN(overlay_15);
2815 OVERLAY_INFO_EXTERN(overlay_gpio_01);
2816 OVERLAY_INFO_EXTERN(overlay_gpio_02a);
2817 OVERLAY_INFO_EXTERN(overlay_gpio_02b);
2818 OVERLAY_INFO_EXTERN(overlay_gpio_03);
2819 OVERLAY_INFO_EXTERN(overlay_gpio_04a);
2820 OVERLAY_INFO_EXTERN(overlay_gpio_04b);
2821 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
2822 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
2823 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2824 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2826 /* entries found by name */
2827 static struct overlay_info overlays[] = {
2828 OVERLAY_INFO(overlay_base, -9999),
2829 OVERLAY_INFO(overlay, 0),
2830 OVERLAY_INFO(overlay_0, 0),
2831 OVERLAY_INFO(overlay_1, 0),
2832 OVERLAY_INFO(overlay_2, 0),
2833 OVERLAY_INFO(overlay_3, 0),
2834 OVERLAY_INFO(overlay_4, 0),
2835 OVERLAY_INFO(overlay_5, 0),
2836 OVERLAY_INFO(overlay_6, 0),
2837 OVERLAY_INFO(overlay_7, 0),
2838 OVERLAY_INFO(overlay_8, 0),
2839 OVERLAY_INFO(overlay_9, 0),
2840 OVERLAY_INFO(overlay_10, 0),
2841 OVERLAY_INFO(overlay_11, 0),
2842 OVERLAY_INFO(overlay_12, 0),
2843 OVERLAY_INFO(overlay_13, 0),
2844 OVERLAY_INFO(overlay_15, 0),
2845 OVERLAY_INFO(overlay_gpio_01, 0),
2846 OVERLAY_INFO(overlay_gpio_02a, 0),
2847 OVERLAY_INFO(overlay_gpio_02b, 0),
2848 OVERLAY_INFO(overlay_gpio_03, 0),
2849 OVERLAY_INFO(overlay_gpio_04a, 0),
2850 OVERLAY_INFO(overlay_gpio_04b, 0),
2851 OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL),
2852 OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL),
2853 OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2854 OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2855 /* end marker */
2856 {.dtb_begin = NULL, .dtb_end = NULL, .expected_result = 0, .name = NULL}
2859 static struct device_node *overlay_base_root;
2861 static void * __init dt_alloc_memory(u64 size, u64 align)
2863 void *ptr = memblock_alloc(size, align);
2865 if (!ptr)
2866 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
2867 __func__, size, align);
2869 return ptr;
2873 * Create base device tree for the overlay unittest.
2875 * This is called from very early boot code.
2877 * Do as much as possible the same way as done in __unflatten_device_tree
2878 * and other early boot steps for the normal FDT so that the overlay base
2879 * unflattened tree will have the same characteristics as the real tree
2880 * (such as having memory allocated by the early allocator). The goal
2881 * is to test "the real thing" as much as possible, and test "test setup
2882 * code" as little as possible.
2884 * Have to stop before resolving phandles, because that uses kmalloc.
2886 void __init unittest_unflatten_overlay_base(void)
2888 struct overlay_info *info;
2889 u32 data_size;
2890 void *new_fdt;
2891 u32 size;
2892 int found = 0;
2893 const char *overlay_name = "overlay_base";
2895 for (info = overlays; info && info->name; info++) {
2896 if (!strcmp(overlay_name, info->name)) {
2897 found = 1;
2898 break;
2901 if (!found) {
2902 pr_err("no overlay data for %s\n", overlay_name);
2903 return;
2906 info = &overlays[0];
2908 if (info->expected_result != -9999) {
2909 pr_err("No dtb 'overlay_base' to attach\n");
2910 return;
2913 data_size = info->dtb_end - info->dtb_begin;
2914 if (!data_size) {
2915 pr_err("No dtb 'overlay_base' to attach\n");
2916 return;
2919 size = fdt_totalsize(info->dtb_begin);
2920 if (size != data_size) {
2921 pr_err("dtb 'overlay_base' header totalsize != actual size");
2922 return;
2925 new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2926 if (!new_fdt) {
2927 pr_err("alloc for dtb 'overlay_base' failed");
2928 return;
2931 memcpy(new_fdt, info->dtb_begin, size);
2933 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2934 dt_alloc_memory, true);
2938 * The purpose of of_unittest_overlay_data_add is to add an
2939 * overlay in the normal fashion. This is a test of the whole
2940 * picture, instead of testing individual elements.
2942 * A secondary purpose is to be able to verify that the contents of
2943 * /proc/device-tree/ contains the updated structure and values from
2944 * the overlay. That must be verified separately in user space.
2946 * Return 0 on unexpected error.
2948 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2950 struct overlay_info *info;
2951 int found = 0;
2952 int ret;
2953 u32 size;
2955 for (info = overlays; info && info->name; info++) {
2956 if (!strcmp(overlay_name, info->name)) {
2957 found = 1;
2958 break;
2961 if (!found) {
2962 pr_err("no overlay data for %s\n", overlay_name);
2963 return 0;
2966 size = info->dtb_end - info->dtb_begin;
2967 if (!size)
2968 pr_err("no overlay data for %s\n", overlay_name);
2970 ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2971 if (overlay_id)
2972 *overlay_id = info->overlay_id;
2973 if (ret < 0)
2974 goto out;
2976 pr_debug("%s applied\n", overlay_name);
2978 out:
2979 if (ret != info->expected_result)
2980 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2981 info->expected_result, ret, overlay_name);
2983 return (ret == info->expected_result);
2987 * The purpose of of_unittest_overlay_high_level is to add an overlay
2988 * in the normal fashion. This is a test of the whole picture,
2989 * instead of individual elements.
2991 * The first part of the function is _not_ normal overlay usage; it is
2992 * finishing splicing the base overlay device tree into the live tree.
2994 static __init void of_unittest_overlay_high_level(void)
2996 struct device_node *last_sibling;
2997 struct device_node *np;
2998 struct device_node *of_symbols;
2999 struct device_node *overlay_base_symbols;
3000 struct device_node **pprev;
3001 struct property *prop;
3002 int ret;
3004 if (!overlay_base_root) {
3005 unittest(0, "overlay_base_root not initialized\n");
3006 return;
3010 * Could not fixup phandles in unittest_unflatten_overlay_base()
3011 * because kmalloc() was not yet available.
3013 of_overlay_mutex_lock();
3014 of_resolve_phandles(overlay_base_root);
3015 of_overlay_mutex_unlock();
3019 * do not allow overlay_base to duplicate any node already in
3020 * tree, this greatly simplifies the code
3024 * remove overlay_base_root node "__local_fixups", after
3025 * being used by of_resolve_phandles()
3027 pprev = &overlay_base_root->child;
3028 for (np = overlay_base_root->child; np; np = np->sibling) {
3029 if (of_node_name_eq(np, "__local_fixups__")) {
3030 *pprev = np->sibling;
3031 break;
3033 pprev = &np->sibling;
3036 /* remove overlay_base_root node "__symbols__" if in live tree */
3037 of_symbols = of_get_child_by_name(of_root, "__symbols__");
3038 if (of_symbols) {
3039 /* will have to graft properties from node into live tree */
3040 pprev = &overlay_base_root->child;
3041 for (np = overlay_base_root->child; np; np = np->sibling) {
3042 if (of_node_name_eq(np, "__symbols__")) {
3043 overlay_base_symbols = np;
3044 *pprev = np->sibling;
3045 break;
3047 pprev = &np->sibling;
3051 for_each_child_of_node(overlay_base_root, np) {
3052 struct device_node *base_child;
3053 for_each_child_of_node(of_root, base_child) {
3054 if (!strcmp(np->full_name, base_child->full_name)) {
3055 unittest(0, "illegal node name in overlay_base %pOFn",
3056 np);
3057 return;
3063 * overlay 'overlay_base' is not allowed to have root
3064 * properties, so only need to splice nodes into main device tree.
3066 * root node of *overlay_base_root will not be freed, it is lost
3067 * memory.
3070 for (np = overlay_base_root->child; np; np = np->sibling)
3071 np->parent = of_root;
3073 mutex_lock(&of_mutex);
3075 for (last_sibling = np = of_root->child; np; np = np->sibling)
3076 last_sibling = np;
3078 if (last_sibling)
3079 last_sibling->sibling = overlay_base_root->child;
3080 else
3081 of_root->child = overlay_base_root->child;
3083 for_each_of_allnodes_from(overlay_base_root, np)
3084 __of_attach_node_sysfs(np);
3086 if (of_symbols) {
3087 struct property *new_prop;
3088 for_each_property_of_node(overlay_base_symbols, prop) {
3090 new_prop = __of_prop_dup(prop, GFP_KERNEL);
3091 if (!new_prop) {
3092 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
3093 prop->name);
3094 goto err_unlock;
3096 if (__of_add_property(of_symbols, new_prop)) {
3097 kfree(new_prop->name);
3098 kfree(new_prop->value);
3099 kfree(new_prop);
3100 /* "name" auto-generated by unflatten */
3101 if (!strcmp(prop->name, "name"))
3102 continue;
3103 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
3104 prop->name);
3105 goto err_unlock;
3107 if (__of_add_property_sysfs(of_symbols, new_prop)) {
3108 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
3109 prop->name);
3110 goto err_unlock;
3115 mutex_unlock(&of_mutex);
3118 /* now do the normal overlay usage test */
3120 EXPECT_BEGIN(KERN_ERR,
3121 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3122 EXPECT_BEGIN(KERN_ERR,
3123 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3124 EXPECT_BEGIN(KERN_ERR,
3125 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3126 EXPECT_BEGIN(KERN_ERR,
3127 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3128 EXPECT_BEGIN(KERN_ERR,
3129 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3130 EXPECT_BEGIN(KERN_ERR,
3131 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3132 EXPECT_BEGIN(KERN_ERR,
3133 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3134 EXPECT_BEGIN(KERN_ERR,
3135 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3136 EXPECT_BEGIN(KERN_ERR,
3137 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3138 EXPECT_BEGIN(KERN_ERR,
3139 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3140 EXPECT_BEGIN(KERN_ERR,
3141 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3143 ret = overlay_data_apply("overlay", NULL);
3145 EXPECT_END(KERN_ERR,
3146 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3147 EXPECT_END(KERN_ERR,
3148 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3149 EXPECT_END(KERN_ERR,
3150 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3151 EXPECT_END(KERN_ERR,
3152 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3153 EXPECT_END(KERN_ERR,
3154 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3155 EXPECT_END(KERN_ERR,
3156 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3157 EXPECT_END(KERN_ERR,
3158 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3159 EXPECT_END(KERN_ERR,
3160 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3161 EXPECT_END(KERN_ERR,
3162 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3163 EXPECT_END(KERN_ERR,
3164 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3165 EXPECT_END(KERN_ERR,
3166 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3168 unittest(ret, "Adding overlay 'overlay' failed\n");
3170 EXPECT_BEGIN(KERN_ERR,
3171 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3172 EXPECT_BEGIN(KERN_ERR,
3173 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3175 unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
3176 "Adding overlay 'overlay_bad_add_dup_node' failed\n");
3178 EXPECT_END(KERN_ERR,
3179 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3180 EXPECT_END(KERN_ERR,
3181 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3183 EXPECT_BEGIN(KERN_ERR,
3184 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3185 EXPECT_BEGIN(KERN_ERR,
3186 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3187 EXPECT_BEGIN(KERN_ERR,
3188 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3190 unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
3191 "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
3193 EXPECT_END(KERN_ERR,
3194 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3195 EXPECT_END(KERN_ERR,
3196 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3197 EXPECT_END(KERN_ERR,
3198 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3200 unittest(overlay_data_apply("overlay_bad_phandle", NULL),
3201 "Adding overlay 'overlay_bad_phandle' failed\n");
3203 unittest(overlay_data_apply("overlay_bad_symbol", NULL),
3204 "Adding overlay 'overlay_bad_symbol' failed\n");
3206 return;
3208 err_unlock:
3209 mutex_unlock(&of_mutex);
3212 #else
3214 static inline __init void of_unittest_overlay_high_level(void) {}
3216 #endif
3218 static int __init of_unittest(void)
3220 struct device_node *np;
3221 int res;
3223 pr_info("start of unittest - you will see error messages\n");
3225 /* adding data for unittest */
3227 if (IS_ENABLED(CONFIG_UML))
3228 unittest_unflatten_overlay_base();
3230 res = unittest_data_add();
3231 if (res)
3232 return res;
3233 if (!of_aliases)
3234 of_aliases = of_find_node_by_path("/aliases");
3236 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
3237 if (!np) {
3238 pr_info("No testcase data in device tree; not running tests\n");
3239 return 0;
3241 of_node_put(np);
3243 of_unittest_check_tree_linkage();
3244 of_unittest_check_phandles();
3245 of_unittest_find_node_by_name();
3246 of_unittest_dynamic();
3247 of_unittest_parse_phandle_with_args();
3248 of_unittest_parse_phandle_with_args_map();
3249 of_unittest_printf();
3250 of_unittest_property_string();
3251 of_unittest_property_copy();
3252 of_unittest_changeset();
3253 of_unittest_parse_interrupts();
3254 of_unittest_parse_interrupts_extended();
3255 of_unittest_parse_dma_ranges();
3256 of_unittest_pci_dma_ranges();
3257 of_unittest_match_node();
3258 of_unittest_platform_populate();
3259 of_unittest_overlay();
3261 /* Double check linkage after removing testcase data */
3262 of_unittest_check_tree_linkage();
3264 of_unittest_overlay_high_level();
3266 pr_info("end of unittest - %i passed, %i failed\n",
3267 unittest_results.passed, unittest_results.failed);
3269 return 0;
3271 late_initcall(of_unittest);