Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Self tests for device tree subsystem
4 */
5
6#define pr_fmt(fmt) "### dt-test ### " fmt
7
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>
24
25#include <linux/i2c.h>
26#include <linux/i2c-mux.h>
27#include <linux/gpio/driver.h>
28
29#include <linux/bitops.h>
30
31#include "of_private.h"
32
33static struct unittest_results {
34 int passed;
35 int failed;
36} unittest_results;
37
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; \
48})
49
50/*
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.
54 *
55 * Do not use EXPECT_BEGIN() or EXPECT_END() for messages generated by
56 * pr_debug().
57 */
58#define EXPECT_BEGIN(level, fmt, ...) \
59 printk(level pr_fmt("EXPECT \\ : ") fmt, ##__VA_ARGS__)
60
61#define EXPECT_END(level, fmt, ...) \
62 printk(level pr_fmt("EXPECT / : ") fmt, ##__VA_ARGS__)
63
64static void __init of_unittest_find_node_by_name(void)
65{
66 struct device_node *np;
67 const char *options, *name;
68
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);
75
76 /* Test if trailing '/' works */
77 np = of_find_node_by_path("/testcase-data/");
78 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
79
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);
86
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);
93
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");
97
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);
104
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);
108
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);
112
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);
116
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);
121
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);
126
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);
131
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);
135
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);
141
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);
147
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);
151
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);
156
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);
161}
162
163static void __init of_unittest_dynamic(void)
164{
165 struct device_node *np;
166 struct property *prop;
167
168 np = of_find_node_by_path("/testcase-data");
169 if (!np) {
170 pr_err("missing testcase data\n");
171 return;
172 }
173
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;
179 }
180
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");
186
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");
194
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");
200
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");
208
209 /* Remove property - should pass */
210 unittest(of_remove_property(np, prop) == 0,
211 "Removing a property should have passed\n");
212
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");
222}
223
224static int __init of_unittest_check_node_linkage(struct device_node *np)
225{
226 struct device_node *child;
227 int count = 0, rc;
228
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;
235 }
236
237 rc = of_unittest_check_node_linkage(child);
238 if (rc < 0)
239 goto put_child;
240 count += rc;
241 }
242
243 return count + 1;
244put_child:
245 of_node_put(child);
246 return rc;
247}
248
249static void __init of_unittest_check_tree_linkage(void)
250{
251 struct device_node *np;
252 int allnode_count = 0, child_count;
253
254 if (!of_root)
255 return;
256
257 for_each_of_allnodes(np)
258 allnode_count++;
259 child_count = of_unittest_check_node_linkage(of_root);
260
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);
266}
267
268static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
269 const char *expected)
270{
271 unsigned char *buf;
272 int buf_size;
273 int size, i;
274
275 buf_size = strlen(expected) + 10;
276 buf = kmalloc(buf_size, GFP_KERNEL);
277 if (!buf)
278 return;
279
280 /* Baseline; check conversion with a large size limit */
281 memset(buf, 0xff, buf_size);
282 size = snprintf(buf, buf_size - 2, fmt, np);
283
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);
288
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);
298 }
299 kfree(buf);
300}
301
302static void __init of_unittest_printf(void)
303{
304 struct device_node *np;
305 const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
306 char phandle_str[16] = "";
307
308 np = of_find_node_by_path(full_name);
309 if (!np) {
310 unittest(np, "testcase data missing\n");
311 return;
312 }
313
314 num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
315
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\"");
334}
335
336struct node_hash {
337 struct hlist_node node;
338 struct device_node *np;
339};
340
341static DEFINE_HASHTABLE(phandle_ht, 8);
342static void __init of_unittest_check_phandles(void)
343{
344 struct device_node *np;
345 struct node_hash *nh;
346 struct hlist_node *tmp;
347 int i, dup_count = 0, phandle_count = 0;
348
349 for_each_of_allnodes(np) {
350 if (!np->phandle)
351 continue;
352
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;
359 }
360 }
361
362 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
363 if (!nh)
364 return;
365
366 nh->np = np;
367 hash_add(phandle_ht, &nh->node, np->phandle);
368 phandle_count++;
369 }
370 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
371 dup_count, phandle_count);
372
373 /* Clean up */
374 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
375 hash_del(&nh->node);
376 kfree(nh);
377 }
378}
379
380static void __init of_unittest_parse_phandle_with_args(void)
381{
382 struct device_node *np;
383 struct of_phandle_args args;
384 int i, rc;
385
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;
390 }
391
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);
394
395 for (i = 0; i < 8; i++) {
396 bool passed = true;
397
398 memset(&args, 0, sizeof(args));
399 rc = of_parse_phandle_with_args(np, "phandle-list",
400 "#phandle-cells", i, &args);
401
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;
445 }
446
447 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
448 i, args.np, rc);
449 }
450
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);
459
460 /* Check for missing cells property */
461 memset(&args, 0, sizeof(args));
462
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");
465
466 rc = of_parse_phandle_with_args(np, "phandle-list",
467 "#phandle-cells-missing", 0, &args);
468
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");
471
472 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
473
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");
476
477 rc = of_count_phandle_with_args(np, "phandle-list",
478 "#phandle-cells-missing");
479
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");
482
483 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
484
485 /* Check for bad phandle in list */
486 memset(&args, 0, sizeof(args));
487
488 EXPECT_BEGIN(KERN_INFO,
489 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
490
491 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
492 "#phandle-cells", 0, &args);
493
494 EXPECT_END(KERN_INFO,
495 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
496
497 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
498
499 EXPECT_BEGIN(KERN_INFO,
500 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
501
502 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
503 "#phandle-cells");
504
505 EXPECT_END(KERN_INFO,
506 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
507
508 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
509
510 /* Check for incorrectly formed argument list */
511 memset(&args, 0, sizeof(args));
512
513 EXPECT_BEGIN(KERN_INFO,
514 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
515
516 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
517 "#phandle-cells", 1, &args);
518
519 EXPECT_END(KERN_INFO,
520 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
521
522 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
523
524 EXPECT_BEGIN(KERN_INFO,
525 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
526
527 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
528 "#phandle-cells");
529
530 EXPECT_END(KERN_INFO,
531 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found -1");
532
533 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
534}
535
536static void __init of_unittest_parse_phandle_with_args_map(void)
537{
538 struct device_node *np, *p0, *p1, *p2, *p3;
539 struct of_phandle_args args;
540 int i, rc;
541
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;
546 }
547
548 p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
549 if (!p0) {
550 pr_err("missing testcase data\n");
551 return;
552 }
553
554 p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
555 if (!p1) {
556 pr_err("missing testcase data\n");
557 return;
558 }
559
560 p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
561 if (!p2) {
562 pr_err("missing testcase data\n");
563 return;
564 }
565
566 p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
567 if (!p3) {
568 pr_err("missing testcase data\n");
569 return;
570 }
571
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);
574
575 for (i = 0; i < 8; i++) {
576 bool passed = true;
577
578 memset(&args, 0, sizeof(args));
579 rc = of_parse_phandle_with_args_map(np, "phandle-list",
580 "phandle", i, &args);
581
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;
629 }
630
631 unittest(passed, "index %i - data error on node %s rc=%i\n",
632 i, args.np->full_name, rc);
633 }
634
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);
640
641 /* Check for missing cells,map,mask property */
642 memset(&args, 0, sizeof(args));
643
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");
646
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");
651
652 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
653
654 /* Check for bad phandle in list */
655 memset(&args, 0, sizeof(args));
656
657 EXPECT_BEGIN(KERN_INFO,
658 "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
659
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");
664
665 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
666
667 /* Check for incorrectly formed argument list */
668 memset(&args, 0, sizeof(args));
669
670 EXPECT_BEGIN(KERN_INFO,
671 "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found -1");
672
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");
677
678 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
679}
680
681static void __init of_unittest_property_string(void)
682{
683 const char *strings[4];
684 struct device_node *np;
685 int rc;
686
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;
691 }
692
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);
707
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);
717
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;
742
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]);
760}
761
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))
766static void __init of_unittest_property_copy(void)
767{
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;
772
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);
778
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
785}
786
787static void __init of_unittest_changeset(void)
788{
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;
798
799 n1 = __of_node_dup(NULL, "n1");
800 unittest(n1, "testcase setup failure\n");
801
802 n2 = __of_node_dup(NULL, "n2");
803 unittest(n2, "testcase setup failure\n");
804
805 n21 = __of_node_dup(NULL, "n21");
806 unittest(n21, "testcase setup failure %p\n", n21);
807
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");
811
812 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
813 unittest(ppadd, "testcase setup failure\n");
814
815 ppname_n1 = __of_prop_dup(&pname_n1, GFP_KERNEL);
816 unittest(ppname_n1, "testcase setup failure\n");
817
818 ppname_n2 = __of_prop_dup(&pname_n2, GFP_KERNEL);
819 unittest(ppname_n2, "testcase setup failure\n");
820
821 ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
822 unittest(ppname_n21, "testcase setup failure\n");
823
824 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
825 unittest(ppupdate, "testcase setup failure\n");
826
827 parent = nchangeset;
828 n1->parent = parent;
829 n2->parent = parent;
830 n21->parent = n2;
831
832 ppremove = of_find_property(parent, "prop-remove", NULL);
833 unittest(ppremove, "failed to find removal prop");
834
835 of_changeset_init(&chgset);
836
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");
839
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");
842
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");
845
846 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
847
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");
851
852 unittest(!of_changeset_apply(&chgset), "apply failed\n");
853
854 of_node_put(nchangeset);
855
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);
860
861 unittest(!of_changeset_revert(&chgset), "revert failed\n");
862
863 of_changeset_destroy(&chgset);
864
865 of_node_put(n1);
866 of_node_put(n2);
867 of_node_put(n21);
868#endif
869}
870
871static void __init of_unittest_dma_ranges_one(const char *path,
872 u64 expect_dma_addr, u64 expect_paddr, u64 expect_size)
873{
874 struct device_node *np;
875 u64 dma_addr, paddr, size;
876 int rc;
877
878 np = of_find_node_by_path(path);
879 if (!np) {
880 pr_err("missing testcase data\n");
881 return;
882 }
883
884 rc = of_dma_get_range(np, &dma_addr, &paddr, &size);
885
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);
894 }
895 of_node_put(np);
896}
897
898static void __init of_unittest_parse_dma_ranges(void)
899{
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 0x100000000, 0x20000000, 0x2000000000);
904 of_unittest_dma_ranges_one("/testcase-data/address-tests/pci@90000000",
905 0x80000000, 0x20000000, 0x10000000);
906}
907
908static void __init of_unittest_pci_dma_ranges(void)
909{
910 struct device_node *np;
911 struct of_pci_range range;
912 struct of_pci_range_parser parser;
913 int i = 0;
914
915 if (!IS_ENABLED(CONFIG_PCI))
916 return;
917
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;
922 }
923
924 if (of_pci_dma_range_parser_init(&parser, np)) {
925 pr_err("missing dma-ranges property\n");
926 return;
927 }
928
929 /*
930 * Get the dma-ranges from the device tree
931 */
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);
953 }
954 i++;
955 }
956
957 of_node_put(np);
958}
959
960static void __init of_unittest_parse_interrupts(void)
961{
962 struct device_node *np;
963 struct of_phandle_args args;
964 int i, rc;
965
966 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
967 return;
968
969 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
970 if (!np) {
971 pr_err("missing testcase data\n");
972 return;
973 }
974
975 for (i = 0; i < 4; i++) {
976 bool passed = true;
977
978 memset(&args, 0, sizeof(args));
979 rc = of_irq_parse_one(np, i, &args);
980
981 passed &= !rc;
982 passed &= (args.args_count == 1);
983 passed &= (args.args[0] == (i + 1));
984
985 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
986 i, args.np, rc);
987 }
988 of_node_put(np);
989
990 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
991 if (!np) {
992 pr_err("missing testcase data\n");
993 return;
994 }
995
996 for (i = 0; i < 4; i++) {
997 bool passed = true;
998
999 memset(&args, 0, sizeof(args));
1000 rc = of_irq_parse_one(np, i, &args);
1001
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;
1030 }
1031 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1032 i, args.np, rc);
1033 }
1034 of_node_put(np);
1035}
1036
1037static void __init of_unittest_parse_interrupts_extended(void)
1038{
1039 struct device_node *np;
1040 struct of_phandle_args args;
1041 int i, rc;
1042
1043 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1044 return;
1045
1046 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
1047 if (!np) {
1048 pr_err("missing testcase data\n");
1049 return;
1050 }
1051
1052 for (i = 0; i < 7; i++) {
1053 bool passed = true;
1054
1055 memset(&args, 0, sizeof(args));
1056 rc = of_irq_parse_one(np, i, &args);
1057
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;
1103 }
1104
1105 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1106 i, args.np, rc);
1107 }
1108 of_node_put(np);
1109}
1110
1111static 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 */
1114
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", },
1118
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", },
1125 {}
1126};
1127
1128static 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", },
1144};
1145
1146static void __init of_unittest_match_node(void)
1147{
1148 struct device_node *np;
1149 const struct of_device_id *match;
1150 int i;
1151
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;
1158 }
1159
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;
1165 }
1166
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;
1172 }
1173 unittest(1, "passed");
1174 }
1175}
1176
1177static struct resource test_bus_res = {
1178 .start = 0xfffffff8,
1179 .end = 0xfffffff9,
1180 .flags = IORESOURCE_MEM,
1181};
1182static const struct platform_device_info test_bus_info = {
1183 .name = "unittest-bus",
1184};
1185static void __init of_unittest_platform_populate(void)
1186{
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", },
1192 {}
1193 };
1194
1195 np = of_find_node_by_path("/testcase-data");
1196 of_platform_default_populate(np, NULL, NULL);
1197
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");
1202
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);
1207
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");
1212
1213 EXPECT_BEGIN(KERN_INFO,
1214 "platform testcase-data:testcase-device2: IRQ index 0 not found");
1215
1216 irq = platform_get_irq(pdev, 0);
1217
1218 EXPECT_END(KERN_INFO,
1219 "platform testcase-data:testcase-device2: IRQ index 0 not found");
1220
1221 unittest(irq < 0 && irq != -EPROBE_DEFER,
1222 "device parsing error failed - %d\n", irq);
1223 }
1224
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;
1229
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;
1236 }
1237 test_bus->dev.of_node = np;
1238
1239 /*
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.
1245 */
1246 platform_device_add_resources(test_bus, &test_bus_res, 1);
1247
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);
1256 }
1257 }
1258
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);
1265 }
1266
1267 platform_device_unregister(test_bus);
1268 of_node_put(np);
1269}
1270
1271/**
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.
1275 *
1276 * @np: node whose properties are being added to the live tree
1277 * @dup: node present in live tree to be updated
1278 */
1279static void update_node_properties(struct device_node *np,
1280 struct device_node *dup)
1281{
1282 struct property *prop;
1283 struct property *save_next;
1284 struct device_node *child;
1285 int ret;
1286
1287 for_each_child_of_node(np, child)
1288 child->parent = dup;
1289
1290 /*
1291 * "unittest internal error: unable to add testdata property"
1292 *
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.
1301 */
1302
1303 /*
1304 * open code for_each_property_of_node() because of_add_property()
1305 * sets prop->next to NULL
1306 */
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);
1315 }
1316 }
1317}
1318
1319/**
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.
1326 *
1327 * @np: Node to attach to live tree
1328 */
1329static void attach_node_and_children(struct device_node *np)
1330{
1331 struct device_node *next, *dup, *child;
1332 unsigned long flags;
1333 const char *full_name;
1334
1335 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1336
1337 if (!strcmp(full_name, "/__local_fixups__") ||
1338 !strcmp(full_name, "/__fixups__")) {
1339 kfree(full_name);
1340 return;
1341 }
1342
1343 dup = of_find_node_by_path(full_name);
1344 kfree(full_name);
1345 if (dup) {
1346 update_node_properties(np, dup);
1347 return;
1348 }
1349
1350 child = np->child;
1351 np->child = NULL;
1352
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);
1359
1360 __of_attach_node_sysfs(np);
1361 mutex_unlock(&of_mutex);
1362
1363 while (child) {
1364 next = child->sibling;
1365 attach_node_and_children(child);
1366 child = next;
1367 }
1368}
1369
1370/**
1371 * unittest_data_add - Reads, copies data from
1372 * linked tree and attaches it to the live tree
1373 */
1374static int __init unittest_data_add(void)
1375{
1376 void *unittest_data;
1377 struct device_node *unittest_data_node, *np;
1378 /*
1379 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1380 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1381 */
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;
1386
1387 if (!size) {
1388 pr_warn("%s: No testcase data to attach; not running tests\n",
1389 __func__);
1390 return -ENODATA;
1391 }
1392
1393 /* creating copy */
1394 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1395 if (!unittest_data)
1396 return -ENOMEM;
1397
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;
1403 }
1404
1405 /*
1406 * This lock normally encloses of_resolve_phandles()
1407 */
1408 of_overlay_mutex_lock();
1409
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;
1415 }
1416
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;
1425 }
1426
1427 EXPECT_BEGIN(KERN_INFO,
1428 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1429
1430 /* attach the sub-tree to live tree */
1431 np = unittest_data_node->child;
1432 while (np) {
1433 struct device_node *next = np->sibling;
1434
1435 np->parent = of_root;
1436 attach_node_and_children(np);
1437 np = next;
1438 }
1439
1440 EXPECT_END(KERN_INFO,
1441 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1442
1443 of_overlay_mutex_unlock();
1444
1445 return 0;
1446}
1447
1448#ifdef CONFIG_OF_OVERLAY
1449static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1450
1451static int unittest_probe(struct platform_device *pdev)
1452{
1453 struct device *dev = &pdev->dev;
1454 struct device_node *np = dev->of_node;
1455
1456 if (np == NULL) {
1457 dev_err(dev, "No OF data for device\n");
1458 return -EINVAL;
1459
1460 }
1461
1462 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1463
1464 of_platform_populate(np, NULL, NULL, &pdev->dev);
1465
1466 return 0;
1467}
1468
1469static int unittest_remove(struct platform_device *pdev)
1470{
1471 struct device *dev = &pdev->dev;
1472 struct device_node *np = dev->of_node;
1473
1474 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1475 return 0;
1476}
1477
1478static const struct of_device_id unittest_match[] = {
1479 { .compatible = "unittest", },
1480 {},
1481};
1482
1483static 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),
1489 },
1490};
1491
1492/* get the platform device instantiated at the path */
1493static struct platform_device *of_path_to_platform_device(const char *path)
1494{
1495 struct device_node *np;
1496 struct platform_device *pdev;
1497
1498 np = of_find_node_by_path(path);
1499 if (np == NULL)
1500 return NULL;
1501
1502 pdev = of_find_device_by_node(np);
1503 of_node_put(np);
1504
1505 return pdev;
1506}
1507
1508/* find out if a platform device exists at that path */
1509static int of_path_platform_device_exists(const char *path)
1510{
1511 struct platform_device *pdev;
1512
1513 pdev = of_path_to_platform_device(path);
1514 platform_device_put(pdev);
1515 return pdev != NULL;
1516}
1517
1518#ifdef CONFIG_OF_GPIO
1519
1520struct unittest_gpio_dev {
1521 struct gpio_chip chip;
1522};
1523
1524static int unittest_gpio_chip_request_count;
1525static int unittest_gpio_probe_count;
1526static int unittest_gpio_probe_pass_count;
1527
1528static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
1529{
1530 unittest_gpio_chip_request_count++;
1531
1532 pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
1533 unittest_gpio_chip_request_count);
1534 return 0;
1535}
1536
1537static int unittest_gpio_probe(struct platform_device *pdev)
1538{
1539 struct unittest_gpio_dev *devptr;
1540 int ret;
1541
1542 unittest_gpio_probe_count++;
1543
1544 devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
1545 if (!devptr)
1546 return -ENOMEM;
1547
1548 platform_set_drvdata(pdev, devptr);
1549
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;
1555
1556 ret = gpiochip_add_data(&devptr->chip, NULL);
1557
1558 unittest(!ret,
1559 "gpiochip_add_data() for node @%pOF failed, ret = %d\n", devptr->chip.of_node, ret);
1560
1561 if (!ret)
1562 unittest_gpio_probe_pass_count++;
1563 return ret;
1564}
1565
1566static int unittest_gpio_remove(struct platform_device *pdev)
1567{
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;
1571
1572 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1573
1574 if (!gdev)
1575 return -EINVAL;
1576
1577 if (gdev->chip.base != -1)
1578 gpiochip_remove(&gdev->chip);
1579
1580 platform_set_drvdata(pdev, NULL);
1581 kfree(gdev);
1582
1583 return 0;
1584}
1585
1586static const struct of_device_id unittest_gpio_id[] = {
1587 { .compatible = "unittest-gpio", },
1588 {}
1589};
1590
1591static 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),
1597 },
1598};
1599
1600static void __init of_unittest_overlay_gpio(void)
1601{
1602 int chip_request_count;
1603 int probe_pass_count;
1604 int ret;
1605
1606 /*
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.
1610 *
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().
1615 *
1616 * - apply overlay_gpio_01
1617 * - apply overlay_gpio_02a
1618 * - apply overlay_gpio_02b
1619 * - register driver
1620 *
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
1625 */
1626
1627 probe_pass_count = unittest_gpio_probe_pass_count;
1628 chip_request_count = unittest_gpio_chip_request_count;
1629
1630 /*
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
1634 */
1635
1636 unittest(overlay_data_apply("overlay_gpio_01", NULL),
1637 "Adding overlay 'overlay_gpio_01' failed\n");
1638
1639 unittest(overlay_data_apply("overlay_gpio_02a", NULL),
1640 "Adding overlay 'overlay_gpio_02a' failed\n");
1641
1642 unittest(overlay_data_apply("overlay_gpio_02b", NULL),
1643 "Adding overlay 'overlay_gpio_02b' failed\n");
1644
1645 /*
1646 * messages are the result of the probes, after the
1647 * driver is registered
1648 */
1649
1650 EXPECT_BEGIN(KERN_INFO,
1651 "GPIO line <<int>> (line-B-input) hogged as input\n");
1652
1653 EXPECT_BEGIN(KERN_INFO,
1654 "GPIO line <<int>> (line-A-input) hogged as input\n");
1655
1656 ret = platform_driver_register(&unittest_gpio_driver);
1657 if (unittest(ret == 0, "could not register unittest gpio driver\n"))
1658 return;
1659
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");
1664
1665 unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
1666 "unittest_gpio_probe() failed or not called\n");
1667
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);
1671
1672 /*
1673 * tests: apply overlays after registering driver
1674 *
1675 * Similar to a driver built-in to the kernel, the
1676 * driver is registered before applying the overlays.
1677 *
1678 * overlay_gpio_03 contains gpio node and child gpio hog node
1679 *
1680 * - apply overlay_gpio_03
1681 *
1682 * apply overlay will result in
1683 * - probe and processing gpio hog.
1684 */
1685
1686 probe_pass_count = unittest_gpio_probe_pass_count;
1687 chip_request_count = unittest_gpio_chip_request_count;
1688
1689 EXPECT_BEGIN(KERN_INFO,
1690 "GPIO line <<int>> (line-D-input) hogged as input\n");
1691
1692 /* overlay_gpio_03 contains gpio node and child gpio hog node */
1693
1694 unittest(overlay_data_apply("overlay_gpio_03", NULL),
1695 "Adding overlay 'overlay_gpio_03' failed\n");
1696
1697 EXPECT_END(KERN_INFO,
1698 "GPIO line <<int>> (line-D-input) hogged as input\n");
1699
1700 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1701 "unittest_gpio_probe() failed or not called\n");
1702
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);
1706
1707 /*
1708 * overlay_gpio_04a contains gpio node
1709 *
1710 * - apply overlay_gpio_04a
1711 *
1712 * apply the overlay will result in
1713 * - probe for overlay_gpio_04a
1714 */
1715
1716 probe_pass_count = unittest_gpio_probe_pass_count;
1717 chip_request_count = unittest_gpio_chip_request_count;
1718
1719 /* overlay_gpio_04a contains gpio node */
1720
1721 unittest(overlay_data_apply("overlay_gpio_04a", NULL),
1722 "Adding overlay 'overlay_gpio_04a' failed\n");
1723
1724 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1725 "unittest_gpio_probe() failed or not called\n");
1726
1727 /*
1728 * overlay_gpio_04b contains child gpio hog node
1729 *
1730 * - apply overlay_gpio_04b
1731 *
1732 * apply the overlay will result in
1733 * - processing gpio for overlay_gpio_04b
1734 */
1735
1736 EXPECT_BEGIN(KERN_INFO,
1737 "GPIO line <<int>> (line-C-input) hogged as input\n");
1738
1739 /* overlay_gpio_04b contains child gpio hog node */
1740
1741 unittest(overlay_data_apply("overlay_gpio_04b", NULL),
1742 "Adding overlay 'overlay_gpio_04b' failed\n");
1743
1744 EXPECT_END(KERN_INFO,
1745 "GPIO line <<int>> (line-C-input) hogged as input\n");
1746
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);
1750}
1751
1752#else
1753
1754static void __init of_unittest_overlay_gpio(void)
1755{
1756 /* skip tests */
1757}
1758
1759#endif
1760
1761#if IS_BUILTIN(CONFIG_I2C)
1762
1763/* get the i2c client device instantiated at the path */
1764static struct i2c_client *of_path_to_i2c_client(const char *path)
1765{
1766 struct device_node *np;
1767 struct i2c_client *client;
1768
1769 np = of_find_node_by_path(path);
1770 if (np == NULL)
1771 return NULL;
1772
1773 client = of_find_i2c_device_by_node(np);
1774 of_node_put(np);
1775
1776 return client;
1777}
1778
1779/* find out if a i2c client device exists at that path */
1780static int of_path_i2c_client_exists(const char *path)
1781{
1782 struct i2c_client *client;
1783
1784 client = of_path_to_i2c_client(path);
1785 if (client)
1786 put_device(&client->dev);
1787 return client != NULL;
1788}
1789#else
1790static int of_path_i2c_client_exists(const char *path)
1791{
1792 return 0;
1793}
1794#endif
1795
1796enum overlay_type {
1797 PDEV_OVERLAY,
1798 I2C_OVERLAY
1799};
1800
1801static int of_path_device_type_exists(const char *path,
1802 enum overlay_type ovtype)
1803{
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);
1809 }
1810 return 0;
1811}
1812
1813static const char *unittest_path(int nr, enum overlay_type ovtype)
1814{
1815 const char *base;
1816 static char buf[256];
1817
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;
1828 }
1829 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1830 buf[sizeof(buf) - 1] = '\0';
1831 return buf;
1832}
1833
1834static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1835{
1836 const char *path;
1837
1838 path = unittest_path(unittest_nr, ovtype);
1839
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);
1845 }
1846 return 0;
1847}
1848
1849static const char *overlay_name_from_nr(int nr)
1850{
1851 static char buf[256];
1852
1853 snprintf(buf, sizeof(buf) - 1,
1854 "overlay_%d", nr);
1855 buf[sizeof(buf) - 1] = '\0';
1856
1857 return buf;
1858}
1859
1860static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1861
1862/* FIXME: it is NOT guaranteed that overlay ids are assigned in sequence */
1863
1864#define MAX_UNITTEST_OVERLAYS 256
1865static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1866static int overlay_first_id = -1;
1867
1868static long of_unittest_overlay_tracked(int id)
1869{
1870 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1871 return 0;
1872 return overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id);
1873}
1874
1875static void of_unittest_track_overlay(int id)
1876{
1877 if (overlay_first_id < 0)
1878 overlay_first_id = id;
1879 id -= overlay_first_id;
1880
1881 if (WARN_ON(id >= MAX_UNITTEST_OVERLAYS))
1882 return;
1883 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1884}
1885
1886static void of_unittest_untrack_overlay(int id)
1887{
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);
1894}
1895
1896static void of_unittest_destroy_tracked_overlays(void)
1897{
1898 int id, ret, defers, ovcs_id;
1899
1900 if (overlay_first_id < 0)
1901 return;
1902
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;
1910
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;
1917 }
1918 if (ret != 0) {
1919 defers++;
1920 pr_warn("%s: overlay destroy failed for #%d\n",
1921 __func__, id + overlay_first_id);
1922 continue;
1923 }
1924
1925 of_unittest_untrack_overlay(id);
1926 }
1927 } while (defers > 0);
1928}
1929
1930static int __init of_unittest_apply_overlay(int overlay_nr, int *overlay_id)
1931{
1932 const char *overlay_name;
1933
1934 overlay_name = overlay_name_from_nr(overlay_nr);
1935
1936 if (!overlay_data_apply(overlay_name, overlay_id)) {
1937 unittest(0, "could not apply overlay \"%s\"\n",
1938 overlay_name);
1939 return -EFAULT;
1940 }
1941 of_unittest_track_overlay(*overlay_id);
1942
1943 return 0;
1944}
1945
1946/* apply an overlay while checking before and after states */
1947static int __init of_unittest_apply_overlay_check(int overlay_nr,
1948 int unittest_nr, int before, int after,
1949 enum overlay_type ovtype)
1950{
1951 int ret, ovcs_id;
1952
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;
1960 }
1961
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;
1967 }
1968
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;
1976 }
1977
1978 return 0;
1979}
1980
1981/* apply an overlay and then revert it while checking before, after states */
1982static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1983 int unittest_nr, int before, int after,
1984 enum overlay_type ovtype)
1985{
1986 int ret, ovcs_id, save_id;
1987
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;
1995 }
1996
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;
2003 }
2004
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;
2012 }
2013
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;
2021 }
2022 of_unittest_untrack_overlay(save_id);
2023
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;
2031 }
2032
2033 return 0;
2034}
2035
2036/* test activation of device */
2037static void __init of_unittest_overlay_0(void)
2038{
2039 int ret;
2040
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");
2043
2044 /* device should enable */
2045 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
2046
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");
2049
2050 if (ret)
2051 return;
2052
2053 unittest(1, "overlay test %d passed\n", 0);
2054}
2055
2056/* test deactivation of device */
2057static void __init of_unittest_overlay_1(void)
2058{
2059 int ret;
2060
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");
2063
2064 /* device should disable */
2065 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
2066
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");
2069
2070 if (ret)
2071 return;
2072
2073 unittest(1, "overlay test %d passed\n", 1);
2074
2075}
2076
2077/* test activation of device */
2078static void __init of_unittest_overlay_2(void)
2079{
2080 int ret;
2081
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");
2084
2085 /* device should enable */
2086 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
2087
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");
2090
2091 if (ret)
2092 return;
2093 unittest(1, "overlay test %d passed\n", 2);
2094}
2095
2096/* test deactivation of device */
2097static void __init of_unittest_overlay_3(void)
2098{
2099 int ret;
2100
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");
2103
2104 /* device should disable */
2105 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
2106
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");
2109
2110 if (ret)
2111 return;
2112
2113 unittest(1, "overlay test %d passed\n", 3);
2114}
2115
2116/* test activation of a full device node */
2117static void __init of_unittest_overlay_4(void)
2118{
2119 /* device should disable */
2120 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
2121 return;
2122
2123 unittest(1, "overlay test %d passed\n", 4);
2124}
2125
2126/* test overlay apply/revert sequence */
2127static void __init of_unittest_overlay_5(void)
2128{
2129 int ret;
2130
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");
2133
2134 /* device should disable */
2135 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
2136
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");
2139
2140 if (ret)
2141 return;
2142
2143 unittest(1, "overlay test %d passed\n", 5);
2144}
2145
2146/* test overlay application in sequence */
2147static void __init of_unittest_overlay_6(void)
2148{
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;
2153
2154 int ret;
2155
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;
2166 }
2167 }
2168
2169 /* apply the overlays */
2170
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");
2173
2174 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2175
2176 ret = overlay_data_apply(overlay_name, &ovcs_id);
2177
2178 if (!ret) {
2179 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2180 return;
2181 }
2182 ov_id[0] = ovcs_id;
2183 of_unittest_track_overlay(ov_id[0]);
2184
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");
2187
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");
2190
2191 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2192
2193 ret = overlay_data_apply(overlay_name, &ovcs_id);
2194
2195 if (!ret) {
2196 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2197 return;
2198 }
2199 ov_id[1] = ovcs_id;
2200 of_unittest_track_overlay(ov_id[1]);
2201
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");
2204
2205
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;
2216 }
2217 }
2218
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;
2227 }
2228 of_unittest_untrack_overlay(ov_id[i]);
2229 }
2230
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;
2241 }
2242 }
2243
2244 unittest(1, "overlay test %d passed\n", 6);
2245
2246}
2247
2248/* test overlay application in sequence */
2249static void __init of_unittest_overlay_8(void)
2250{
2251 int i, ov_id[2], ovcs_id;
2252 int overlay_nr = 8, unittest_nr = 8;
2253 const char *overlay_name;
2254 int ret;
2255
2256 /* we don't care about device state in this test */
2257
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");
2260
2261 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2262
2263 ret = overlay_data_apply(overlay_name, &ovcs_id);
2264 if (!ret)
2265 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2266
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");
2269
2270 if (!ret)
2271 return;
2272
2273 ov_id[0] = ovcs_id;
2274 of_unittest_track_overlay(ov_id[0]);
2275
2276 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2277
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");
2280
2281 /* apply the overlays */
2282 ret = overlay_data_apply(overlay_name, &ovcs_id);
2283
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");
2286
2287 if (!ret) {
2288 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2289 return;
2290 }
2291
2292 ov_id[1] = ovcs_id;
2293 of_unittest_track_overlay(ov_id[1]);
2294
2295 /* now try to remove first overlay (it should fail) */
2296 ovcs_id = ov_id[0];
2297
2298 EXPECT_BEGIN(KERN_INFO,
2299 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2300
2301 EXPECT_BEGIN(KERN_INFO,
2302 "OF: overlay: overlay #6 is not topmost");
2303
2304 ret = of_overlay_remove(&ovcs_id);
2305
2306 EXPECT_END(KERN_INFO,
2307 "OF: overlay: overlay #6 is not topmost");
2308
2309 EXPECT_END(KERN_INFO,
2310 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2311
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;
2318 }
2319
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;
2329 }
2330 of_unittest_untrack_overlay(ov_id[i]);
2331 }
2332
2333 unittest(1, "overlay test %d passed\n", 8);
2334}
2335
2336/* test insertion of a bus with parent devices */
2337static void __init of_unittest_overlay_10(void)
2338{
2339 int ret;
2340 char *child_path;
2341
2342 /* device should disable */
2343 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
2344
2345 if (unittest(ret == 0,
2346 "overlay test %d failed; overlay application\n", 10))
2347 return;
2348
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;
2353
2354 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
2355 kfree(child_path);
2356
2357 unittest(ret, "overlay test %d failed; no child device\n", 10);
2358}
2359
2360/* test insertion of a bus with parent devices (and revert) */
2361static void __init of_unittest_overlay_11(void)
2362{
2363 int ret;
2364
2365 /* device should disable */
2366 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
2367 PDEV_OVERLAY);
2368
2369 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2370}
2371
2372#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2373
2374struct unittest_i2c_bus_data {
2375 struct platform_device *pdev;
2376 struct i2c_adapter adap;
2377};
2378
2379static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2380 struct i2c_msg *msgs, int num)
2381{
2382 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2383
2384 (void)std;
2385
2386 return num;
2387}
2388
2389static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2390{
2391 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2392}
2393
2394static const struct i2c_algorithm unittest_i2c_algo = {
2395 .master_xfer = unittest_i2c_master_xfer,
2396 .functionality = unittest_i2c_functionality,
2397};
2398
2399static int unittest_i2c_bus_probe(struct platform_device *pdev)
2400{
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;
2406
2407 if (np == NULL) {
2408 dev_err(dev, "No OF data for device\n");
2409 return -EINVAL;
2410
2411 }
2412
2413 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2414
2415 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
2416 if (!std)
2417 return -ENOMEM;
2418
2419 /* link them together */
2420 std->pdev = pdev;
2421 platform_set_drvdata(pdev, std);
2422
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;
2433
2434 ret = i2c_add_numbered_adapter(adap);
2435 if (ret != 0) {
2436 dev_err(dev, "Failed to add I2C adapter\n");
2437 return ret;
2438 }
2439
2440 return 0;
2441}
2442
2443static int unittest_i2c_bus_remove(struct platform_device *pdev)
2444{
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);
2448
2449 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2450 i2c_del_adapter(&std->adap);
2451
2452 return 0;
2453}
2454
2455static const struct of_device_id unittest_i2c_bus_match[] = {
2456 { .compatible = "unittest-i2c-bus", },
2457 {},
2458};
2459
2460static 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),
2466 },
2467};
2468
2469static int unittest_i2c_dev_probe(struct i2c_client *client,
2470 const struct i2c_device_id *id)
2471{
2472 struct device *dev = &client->dev;
2473 struct device_node *np = client->dev.of_node;
2474
2475 if (!np) {
2476 dev_err(dev, "No OF node\n");
2477 return -EINVAL;
2478 }
2479
2480 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2481
2482 return 0;
2483};
2484
2485static int unittest_i2c_dev_remove(struct i2c_client *client)
2486{
2487 struct device *dev = &client->dev;
2488 struct device_node *np = client->dev.of_node;
2489
2490 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2491 return 0;
2492}
2493
2494static const struct i2c_device_id unittest_i2c_dev_id[] = {
2495 { .name = "unittest-i2c-dev" },
2496 { }
2497};
2498
2499static struct i2c_driver unittest_i2c_dev_driver = {
2500 .driver = {
2501 .name = "unittest-i2c-dev",
2502 },
2503 .probe = unittest_i2c_dev_probe,
2504 .remove = unittest_i2c_dev_remove,
2505 .id_table = unittest_i2c_dev_id,
2506};
2507
2508#if IS_BUILTIN(CONFIG_I2C_MUX)
2509
2510static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
2511{
2512 return 0;
2513}
2514
2515static int unittest_i2c_mux_probe(struct i2c_client *client,
2516 const struct i2c_device_id *id)
2517{
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;
2524
2525 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2526
2527 if (!np) {
2528 dev_err(dev, "No OF node\n");
2529 return -EINVAL;
2530 }
2531
2532 max_reg = (u32)-1;
2533 for_each_child_of_node(np, child) {
2534 if (of_property_read_u32(child, "reg", ®))
2535 continue;
2536 if (max_reg == (u32)-1 || reg > max_reg)
2537 max_reg = reg;
2538 }
2539 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
2540 if (nchans == 0) {
2541 dev_err(dev, "No channels\n");
2542 return -EINVAL;
2543 }
2544
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;
2554 }
2555 }
2556
2557 i2c_set_clientdata(client, muxc);
2558
2559 return 0;
2560};
2561
2562static int unittest_i2c_mux_remove(struct i2c_client *client)
2563{
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);
2567
2568 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2569 i2c_mux_del_adapters(muxc);
2570 return 0;
2571}
2572
2573static const struct i2c_device_id unittest_i2c_mux_id[] = {
2574 { .name = "unittest-i2c-mux" },
2575 { }
2576};
2577
2578static struct i2c_driver unittest_i2c_mux_driver = {
2579 .driver = {
2580 .name = "unittest-i2c-mux",
2581 },
2582 .probe = unittest_i2c_mux_probe,
2583 .remove = unittest_i2c_mux_remove,
2584 .id_table = unittest_i2c_mux_id,
2585};
2586
2587#endif
2588
2589static int of_unittest_overlay_i2c_init(void)
2590{
2591 int ret;
2592
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;
2597
2598 ret = platform_driver_register(&unittest_i2c_bus_driver);
2599
2600 if (unittest(ret == 0,
2601 "could not register unittest i2c bus driver\n"))
2602 return ret;
2603
2604#if IS_BUILTIN(CONFIG_I2C_MUX)
2605
2606 EXPECT_BEGIN(KERN_INFO,
2607 "i2c i2c-1: Added multiplexed i2c bus 2");
2608
2609 ret = i2c_add_driver(&unittest_i2c_mux_driver);
2610
2611 EXPECT_END(KERN_INFO,
2612 "i2c i2c-1: Added multiplexed i2c bus 2");
2613
2614 if (unittest(ret == 0,
2615 "could not register unittest i2c mux driver\n"))
2616 return ret;
2617#endif
2618
2619 return 0;
2620}
2621
2622static void of_unittest_overlay_i2c_cleanup(void)
2623{
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);
2629}
2630
2631static void __init of_unittest_overlay_i2c_12(void)
2632{
2633 int ret;
2634
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");
2638
2639 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
2640
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");
2643
2644 if (ret)
2645 return;
2646
2647 unittest(1, "overlay test %d passed\n", 12);
2648}
2649
2650/* test deactivation of device */
2651static void __init of_unittest_overlay_i2c_13(void)
2652{
2653 int ret;
2654
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");
2657
2658 /* device should disable */
2659 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
2660
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");
2663
2664 if (ret)
2665 return;
2666
2667 unittest(1, "overlay test %d passed\n", 13);
2668}
2669
2670/* just check for i2c mux existence */
2671static void of_unittest_overlay_i2c_14(void)
2672{
2673}
2674
2675static void __init of_unittest_overlay_i2c_15(void)
2676{
2677 int ret;
2678
2679 /* device should enable */
2680 EXPECT_BEGIN(KERN_INFO,
2681 "i2c i2c-1: Added multiplexed i2c bus 3");
2682
2683 ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
2684
2685 EXPECT_END(KERN_INFO,
2686 "i2c i2c-1: Added multiplexed i2c bus 3");
2687
2688 if (ret)
2689 return;
2690
2691 unittest(1, "overlay test %d passed\n", 15);
2692}
2693
2694#else
2695
2696static inline void of_unittest_overlay_i2c_14(void) { }
2697static inline void of_unittest_overlay_i2c_15(void) { }
2698
2699#endif
2700
2701static void __init of_unittest_overlay(void)
2702{
2703 struct device_node *bus_np = NULL;
2704
2705 if (platform_driver_register(&unittest_driver)) {
2706 unittest(0, "could not register unittest driver\n");
2707 goto out;
2708 }
2709
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;
2714 }
2715
2716 if (of_platform_default_populate(bus_np, NULL, NULL)) {
2717 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2718 goto out;
2719 }
2720
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;
2725 }
2726
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;
2731 }
2732
2733 unittest(1, "basic infrastructure of overlays passed");
2734
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();
2744
2745 of_unittest_overlay_10();
2746 of_unittest_overlay_11();
2747
2748#if IS_BUILTIN(CONFIG_I2C)
2749 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2750 goto out;
2751
2752 of_unittest_overlay_i2c_12();
2753 of_unittest_overlay_i2c_13();
2754 of_unittest_overlay_i2c_14();
2755 of_unittest_overlay_i2c_15();
2756
2757 of_unittest_overlay_i2c_cleanup();
2758#endif
2759
2760 of_unittest_overlay_gpio();
2761
2762 of_unittest_destroy_tracked_overlays();
2763
2764out:
2765 of_node_put(bus_np);
2766}
2767
2768#else
2769static inline void __init of_unittest_overlay(void) { }
2770#endif
2771
2772#ifdef CONFIG_OF_OVERLAY
2773
2774/*
2775 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2776 * in scripts/Makefile.lib
2777 */
2778
2779#define OVERLAY_INFO_EXTERN(name) \
2780 extern uint8_t __dtb_##name##_begin[]; \
2781 extern uint8_t __dtb_##name##_end[]
2782
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, \
2788}
2789
2790struct overlay_info {
2791 uint8_t *dtb_begin;
2792 uint8_t *dtb_end;
2793 int expected_result;
2794 int overlay_id;
2795 char *name;
2796};
2797
2798OVERLAY_INFO_EXTERN(overlay_base);
2799OVERLAY_INFO_EXTERN(overlay);
2800OVERLAY_INFO_EXTERN(overlay_0);
2801OVERLAY_INFO_EXTERN(overlay_1);
2802OVERLAY_INFO_EXTERN(overlay_2);
2803OVERLAY_INFO_EXTERN(overlay_3);
2804OVERLAY_INFO_EXTERN(overlay_4);
2805OVERLAY_INFO_EXTERN(overlay_5);
2806OVERLAY_INFO_EXTERN(overlay_6);
2807OVERLAY_INFO_EXTERN(overlay_7);
2808OVERLAY_INFO_EXTERN(overlay_8);
2809OVERLAY_INFO_EXTERN(overlay_9);
2810OVERLAY_INFO_EXTERN(overlay_10);
2811OVERLAY_INFO_EXTERN(overlay_11);
2812OVERLAY_INFO_EXTERN(overlay_12);
2813OVERLAY_INFO_EXTERN(overlay_13);
2814OVERLAY_INFO_EXTERN(overlay_15);
2815OVERLAY_INFO_EXTERN(overlay_gpio_01);
2816OVERLAY_INFO_EXTERN(overlay_gpio_02a);
2817OVERLAY_INFO_EXTERN(overlay_gpio_02b);
2818OVERLAY_INFO_EXTERN(overlay_gpio_03);
2819OVERLAY_INFO_EXTERN(overlay_gpio_04a);
2820OVERLAY_INFO_EXTERN(overlay_gpio_04b);
2821OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
2822OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
2823OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2824OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2825
2826/* entries found by name */
2827static 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}
2857};
2858
2859static struct device_node *overlay_base_root;
2860
2861static void * __init dt_alloc_memory(u64 size, u64 align)
2862{
2863 void *ptr = memblock_alloc(size, align);
2864
2865 if (!ptr)
2866 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
2867 __func__, size, align);
2868
2869 return ptr;
2870}
2871
2872/*
2873 * Create base device tree for the overlay unittest.
2874 *
2875 * This is called from very early boot code.
2876 *
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.
2883 *
2884 * Have to stop before resolving phandles, because that uses kmalloc.
2885 */
2886void __init unittest_unflatten_overlay_base(void)
2887{
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";
2894
2895 for (info = overlays; info && info->name; info++) {
2896 if (!strcmp(overlay_name, info->name)) {
2897 found = 1;
2898 break;
2899 }
2900 }
2901 if (!found) {
2902 pr_err("no overlay data for %s\n", overlay_name);
2903 return;
2904 }
2905
2906 info = &overlays[0];
2907
2908 if (info->expected_result != -9999) {
2909 pr_err("No dtb 'overlay_base' to attach\n");
2910 return;
2911 }
2912
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;
2917 }
2918
2919 size = fdt_totalsize(info->dtb_begin);
2920 if (size != data_size) {
2921 pr_err("dtb 'overlay_base' header totalsize != actual size");
2922 return;
2923 }
2924
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;
2929 }
2930
2931 memcpy(new_fdt, info->dtb_begin, size);
2932
2933 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2934 dt_alloc_memory, true);
2935}
2936
2937/*
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.
2941 *
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.
2945 *
2946 * Return 0 on unexpected error.
2947 */
2948static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2949{
2950 struct overlay_info *info;
2951 int found = 0;
2952 int ret;
2953 u32 size;
2954
2955 for (info = overlays; info && info->name; info++) {
2956 if (!strcmp(overlay_name, info->name)) {
2957 found = 1;
2958 break;
2959 }
2960 }
2961 if (!found) {
2962 pr_err("no overlay data for %s\n", overlay_name);
2963 return 0;
2964 }
2965
2966 size = info->dtb_end - info->dtb_begin;
2967 if (!size)
2968 pr_err("no overlay data for %s\n", overlay_name);
2969
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;
2975
2976 pr_debug("%s applied\n", overlay_name);
2977
2978out:
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);
2982
2983 return (ret == info->expected_result);
2984}
2985
2986/*
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.
2990 *
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.
2993 */
2994static __init void of_unittest_overlay_high_level(void)
2995{
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;
3003
3004 if (!overlay_base_root) {
3005 unittest(0, "overlay_base_root not initialized\n");
3006 return;
3007 }
3008
3009 /*
3010 * Could not fixup phandles in unittest_unflatten_overlay_base()
3011 * because kmalloc() was not yet available.
3012 */
3013 of_overlay_mutex_lock();
3014 of_resolve_phandles(overlay_base_root);
3015 of_overlay_mutex_unlock();
3016
3017
3018 /*
3019 * do not allow overlay_base to duplicate any node already in
3020 * tree, this greatly simplifies the code
3021 */
3022
3023 /*
3024 * remove overlay_base_root node "__local_fixups", after
3025 * being used by of_resolve_phandles()
3026 */
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;
3032 }
3033 pprev = &np->sibling;
3034 }
3035
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;
3046 }
3047 pprev = &np->sibling;
3048 }
3049 }
3050
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;
3058 }
3059 }
3060 }
3061
3062 /*
3063 * overlay 'overlay_base' is not allowed to have root
3064 * properties, so only need to splice nodes into main device tree.
3065 *
3066 * root node of *overlay_base_root will not be freed, it is lost
3067 * memory.
3068 */
3069
3070 for (np = overlay_base_root->child; np; np = np->sibling)
3071 np->parent = of_root;
3072
3073 mutex_lock(&of_mutex);
3074
3075 for (last_sibling = np = of_root->child; np; np = np->sibling)
3076 last_sibling = np;
3077
3078 if (last_sibling)
3079 last_sibling->sibling = overlay_base_root->child;
3080 else
3081 of_root->child = overlay_base_root->child;
3082
3083 for_each_of_allnodes_from(overlay_base_root, np)
3084 __of_attach_node_sysfs(np);
3085
3086 if (of_symbols) {
3087 struct property *new_prop;
3088 for_each_property_of_node(overlay_base_symbols, prop) {
3089
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;
3095 }
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;
3106 }
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;
3111 }
3112 }
3113 }
3114
3115 mutex_unlock(&of_mutex);
3116
3117
3118 /* now do the normal overlay usage test */
3119
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");
3142
3143 ret = overlay_data_apply("overlay", NULL);
3144
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");
3167
3168 unittest(ret, "Adding overlay 'overlay' failed\n");
3169
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");
3174
3175 unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
3176 "Adding overlay 'overlay_bad_add_dup_node' failed\n");
3177
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");
3182
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");
3189
3190 unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
3191 "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
3192
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");
3199
3200 unittest(overlay_data_apply("overlay_bad_phandle", NULL),
3201 "Adding overlay 'overlay_bad_phandle' failed\n");
3202
3203 unittest(overlay_data_apply("overlay_bad_symbol", NULL),
3204 "Adding overlay 'overlay_bad_symbol' failed\n");
3205
3206 return;
3207
3208err_unlock:
3209 mutex_unlock(&of_mutex);
3210}
3211
3212#else
3213
3214static inline __init void of_unittest_overlay_high_level(void) {}
3215
3216#endif
3217
3218static int __init of_unittest(void)
3219{
3220 struct device_node *np;
3221 int res;
3222
3223 pr_info("start of unittest - you will see error messages\n");
3224
3225 /* adding data for unittest */
3226
3227 if (IS_ENABLED(CONFIG_UML))
3228 unittest_unflatten_overlay_base();
3229
3230 res = unittest_data_add();
3231 if (res)
3232 return res;
3233 if (!of_aliases)
3234 of_aliases = of_find_node_by_path("/aliases");
3235
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;
3240 }
3241 of_node_put(np);
3242
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();
3260
3261 /* Double check linkage after removing testcase data */
3262 of_unittest_check_tree_linkage();
3263
3264 of_unittest_overlay_high_level();
3265
3266 pr_info("end of unittest - %i passed, %i failed\n",
3267 unittest_results.passed, unittest_results.failed);
3268
3269 return 0;
3270}
3271late_initcall(of_unittest);
1/*
2 * Self tests for device tree subsystem
3 */
4
5#define pr_fmt(fmt) "### dt-test ### " fmt
6
7#include <linux/clk.h>
8#include <linux/err.h>
9#include <linux/errno.h>
10#include <linux/hashtable.h>
11#include <linux/module.h>
12#include <linux/of.h>
13#include <linux/of_fdt.h>
14#include <linux/of_irq.h>
15#include <linux/of_platform.h>
16#include <linux/list.h>
17#include <linux/mutex.h>
18#include <linux/slab.h>
19#include <linux/device.h>
20#include <linux/platform_device.h>
21#include <linux/of_platform.h>
22
23#include <linux/i2c.h>
24#include <linux/i2c-mux.h>
25
26#include <linux/bitops.h>
27
28#include "of_private.h"
29
30static struct unittest_results {
31 int passed;
32 int failed;
33} unittest_results;
34
35#define unittest(result, fmt, ...) ({ \
36 bool failed = !(result); \
37 if (failed) { \
38 unittest_results.failed++; \
39 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
40 } else { \
41 unittest_results.passed++; \
42 pr_debug("pass %s():%i\n", __func__, __LINE__); \
43 } \
44 failed; \
45})
46
47static void __init of_unittest_find_node_by_name(void)
48{
49 struct device_node *np;
50 const char *options;
51
52 np = of_find_node_by_path("/testcase-data");
53 unittest(np && !strcmp("/testcase-data", np->full_name),
54 "find /testcase-data failed\n");
55 of_node_put(np);
56
57 /* Test if trailing '/' works */
58 np = of_find_node_by_path("/testcase-data/");
59 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
60
61 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
62 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
63 "find /testcase-data/phandle-tests/consumer-a failed\n");
64 of_node_put(np);
65
66 np = of_find_node_by_path("testcase-alias");
67 unittest(np && !strcmp("/testcase-data", np->full_name),
68 "find testcase-alias failed\n");
69 of_node_put(np);
70
71 /* Test if trailing '/' works on aliases */
72 np = of_find_node_by_path("testcase-alias/");
73 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
74
75 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
76 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
77 "find testcase-alias/phandle-tests/consumer-a failed\n");
78 of_node_put(np);
79
80 np = of_find_node_by_path("/testcase-data/missing-path");
81 unittest(!np, "non-existent path returned node %s\n", np->full_name);
82 of_node_put(np);
83
84 np = of_find_node_by_path("missing-alias");
85 unittest(!np, "non-existent alias returned node %s\n", np->full_name);
86 of_node_put(np);
87
88 np = of_find_node_by_path("testcase-alias/missing-path");
89 unittest(!np, "non-existent alias with relative path returned node %s\n", np->full_name);
90 of_node_put(np);
91
92 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
93 unittest(np && !strcmp("testoption", options),
94 "option path test failed\n");
95 of_node_put(np);
96
97 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
98 unittest(np && !strcmp("test/option", options),
99 "option path test, subcase #1 failed\n");
100 of_node_put(np);
101
102 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
103 unittest(np && !strcmp("test/option", options),
104 "option path test, subcase #2 failed\n");
105 of_node_put(np);
106
107 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
108 unittest(np, "NULL option path test failed\n");
109 of_node_put(np);
110
111 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
112 &options);
113 unittest(np && !strcmp("testaliasoption", options),
114 "option alias path test failed\n");
115 of_node_put(np);
116
117 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
118 &options);
119 unittest(np && !strcmp("test/alias/option", options),
120 "option alias path test, subcase #1 failed\n");
121 of_node_put(np);
122
123 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
124 unittest(np, "NULL option alias path test failed\n");
125 of_node_put(np);
126
127 options = "testoption";
128 np = of_find_node_opts_by_path("testcase-alias", &options);
129 unittest(np && !options, "option clearing test failed\n");
130 of_node_put(np);
131
132 options = "testoption";
133 np = of_find_node_opts_by_path("/", &options);
134 unittest(np && !options, "option clearing root node test failed\n");
135 of_node_put(np);
136}
137
138static void __init of_unittest_dynamic(void)
139{
140 struct device_node *np;
141 struct property *prop;
142
143 np = of_find_node_by_path("/testcase-data");
144 if (!np) {
145 pr_err("missing testcase data\n");
146 return;
147 }
148
149 /* Array of 4 properties for the purpose of testing */
150 prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL);
151 if (!prop) {
152 unittest(0, "kzalloc() failed\n");
153 return;
154 }
155
156 /* Add a new property - should pass*/
157 prop->name = "new-property";
158 prop->value = "new-property-data";
159 prop->length = strlen(prop->value);
160 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
161
162 /* Try to add an existing property - should fail */
163 prop++;
164 prop->name = "new-property";
165 prop->value = "new-property-data-should-fail";
166 prop->length = strlen(prop->value);
167 unittest(of_add_property(np, prop) != 0,
168 "Adding an existing property should have failed\n");
169
170 /* Try to modify an existing property - should pass */
171 prop->value = "modify-property-data-should-pass";
172 prop->length = strlen(prop->value);
173 unittest(of_update_property(np, prop) == 0,
174 "Updating an existing property should have passed\n");
175
176 /* Try to modify non-existent property - should pass*/
177 prop++;
178 prop->name = "modify-property";
179 prop->value = "modify-missing-property-data-should-pass";
180 prop->length = strlen(prop->value);
181 unittest(of_update_property(np, prop) == 0,
182 "Updating a missing property should have passed\n");
183
184 /* Remove property - should pass */
185 unittest(of_remove_property(np, prop) == 0,
186 "Removing a property should have passed\n");
187
188 /* Adding very large property - should pass */
189 prop++;
190 prop->name = "large-property-PAGE_SIZEx8";
191 prop->length = PAGE_SIZE * 8;
192 prop->value = kzalloc(prop->length, GFP_KERNEL);
193 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
194 if (prop->value)
195 unittest(of_add_property(np, prop) == 0,
196 "Adding a large property should have passed\n");
197}
198
199static int __init of_unittest_check_node_linkage(struct device_node *np)
200{
201 struct device_node *child;
202 int count = 0, rc;
203
204 for_each_child_of_node(np, child) {
205 if (child->parent != np) {
206 pr_err("Child node %s links to wrong parent %s\n",
207 child->name, np->name);
208 rc = -EINVAL;
209 goto put_child;
210 }
211
212 rc = of_unittest_check_node_linkage(child);
213 if (rc < 0)
214 goto put_child;
215 count += rc;
216 }
217
218 return count + 1;
219put_child:
220 of_node_put(child);
221 return rc;
222}
223
224static void __init of_unittest_check_tree_linkage(void)
225{
226 struct device_node *np;
227 int allnode_count = 0, child_count;
228
229 if (!of_root)
230 return;
231
232 for_each_of_allnodes(np)
233 allnode_count++;
234 child_count = of_unittest_check_node_linkage(of_root);
235
236 unittest(child_count > 0, "Device node data structure is corrupted\n");
237 unittest(child_count == allnode_count,
238 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
239 allnode_count, child_count);
240 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
241}
242
243struct node_hash {
244 struct hlist_node node;
245 struct device_node *np;
246};
247
248static DEFINE_HASHTABLE(phandle_ht, 8);
249static void __init of_unittest_check_phandles(void)
250{
251 struct device_node *np;
252 struct node_hash *nh;
253 struct hlist_node *tmp;
254 int i, dup_count = 0, phandle_count = 0;
255
256 for_each_of_allnodes(np) {
257 if (!np->phandle)
258 continue;
259
260 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
261 if (nh->np->phandle == np->phandle) {
262 pr_info("Duplicate phandle! %i used by %s and %s\n",
263 np->phandle, nh->np->full_name, np->full_name);
264 dup_count++;
265 break;
266 }
267 }
268
269 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
270 if (WARN_ON(!nh))
271 return;
272
273 nh->np = np;
274 hash_add(phandle_ht, &nh->node, np->phandle);
275 phandle_count++;
276 }
277 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
278 dup_count, phandle_count);
279
280 /* Clean up */
281 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
282 hash_del(&nh->node);
283 kfree(nh);
284 }
285}
286
287static void __init of_unittest_parse_phandle_with_args(void)
288{
289 struct device_node *np;
290 struct of_phandle_args args;
291 int i, rc;
292
293 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
294 if (!np) {
295 pr_err("missing testcase data\n");
296 return;
297 }
298
299 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
300 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
301
302 for (i = 0; i < 8; i++) {
303 bool passed = true;
304
305 rc = of_parse_phandle_with_args(np, "phandle-list",
306 "#phandle-cells", i, &args);
307
308 /* Test the values from tests-phandle.dtsi */
309 switch (i) {
310 case 0:
311 passed &= !rc;
312 passed &= (args.args_count == 1);
313 passed &= (args.args[0] == (i + 1));
314 break;
315 case 1:
316 passed &= !rc;
317 passed &= (args.args_count == 2);
318 passed &= (args.args[0] == (i + 1));
319 passed &= (args.args[1] == 0);
320 break;
321 case 2:
322 passed &= (rc == -ENOENT);
323 break;
324 case 3:
325 passed &= !rc;
326 passed &= (args.args_count == 3);
327 passed &= (args.args[0] == (i + 1));
328 passed &= (args.args[1] == 4);
329 passed &= (args.args[2] == 3);
330 break;
331 case 4:
332 passed &= !rc;
333 passed &= (args.args_count == 2);
334 passed &= (args.args[0] == (i + 1));
335 passed &= (args.args[1] == 100);
336 break;
337 case 5:
338 passed &= !rc;
339 passed &= (args.args_count == 0);
340 break;
341 case 6:
342 passed &= !rc;
343 passed &= (args.args_count == 1);
344 passed &= (args.args[0] == (i + 1));
345 break;
346 case 7:
347 passed &= (rc == -ENOENT);
348 break;
349 default:
350 passed = false;
351 }
352
353 unittest(passed, "index %i - data error on node %s rc=%i\n",
354 i, args.np->full_name, rc);
355 }
356
357 /* Check for missing list property */
358 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
359 "#phandle-cells", 0, &args);
360 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
361 rc = of_count_phandle_with_args(np, "phandle-list-missing",
362 "#phandle-cells");
363 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
364
365 /* Check for missing cells property */
366 rc = of_parse_phandle_with_args(np, "phandle-list",
367 "#phandle-cells-missing", 0, &args);
368 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
369 rc = of_count_phandle_with_args(np, "phandle-list",
370 "#phandle-cells-missing");
371 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
372
373 /* Check for bad phandle in list */
374 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
375 "#phandle-cells", 0, &args);
376 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
377 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
378 "#phandle-cells");
379 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
380
381 /* Check for incorrectly formed argument list */
382 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
383 "#phandle-cells", 1, &args);
384 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
385 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
386 "#phandle-cells");
387 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
388}
389
390static void __init of_unittest_property_string(void)
391{
392 const char *strings[4];
393 struct device_node *np;
394 int rc;
395
396 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
397 if (!np) {
398 pr_err("No testcase data in device tree\n");
399 return;
400 }
401
402 rc = of_property_match_string(np, "phandle-list-names", "first");
403 unittest(rc == 0, "first expected:0 got:%i\n", rc);
404 rc = of_property_match_string(np, "phandle-list-names", "second");
405 unittest(rc == 1, "second expected:1 got:%i\n", rc);
406 rc = of_property_match_string(np, "phandle-list-names", "third");
407 unittest(rc == 2, "third expected:2 got:%i\n", rc);
408 rc = of_property_match_string(np, "phandle-list-names", "fourth");
409 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
410 rc = of_property_match_string(np, "missing-property", "blah");
411 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
412 rc = of_property_match_string(np, "empty-property", "blah");
413 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
414 rc = of_property_match_string(np, "unterminated-string", "blah");
415 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
416
417 /* of_property_count_strings() tests */
418 rc = of_property_count_strings(np, "string-property");
419 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
420 rc = of_property_count_strings(np, "phandle-list-names");
421 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
422 rc = of_property_count_strings(np, "unterminated-string");
423 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
424 rc = of_property_count_strings(np, "unterminated-string-list");
425 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
426
427 /* of_property_read_string_index() tests */
428 rc = of_property_read_string_index(np, "string-property", 0, strings);
429 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
430 strings[0] = NULL;
431 rc = of_property_read_string_index(np, "string-property", 1, strings);
432 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
433 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
434 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
435 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
436 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
437 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
438 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
439 strings[0] = NULL;
440 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
441 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
442 strings[0] = NULL;
443 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
444 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
445 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
446 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
447 strings[0] = NULL;
448 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
449 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
450 strings[1] = NULL;
451
452 /* of_property_read_string_array() tests */
453 rc = of_property_read_string_array(np, "string-property", strings, 4);
454 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
455 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
456 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
457 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
458 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
459 /* -- An incorrectly formed string should cause a failure */
460 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
461 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
462 /* -- parsing the correctly formed strings should still work: */
463 strings[2] = NULL;
464 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
465 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
466 strings[1] = NULL;
467 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
468 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
469}
470
471#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
472 (p1)->value && (p2)->value && \
473 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
474 !strcmp((p1)->name, (p2)->name))
475static void __init of_unittest_property_copy(void)
476{
477#ifdef CONFIG_OF_DYNAMIC
478 struct property p1 = { .name = "p1", .length = 0, .value = "" };
479 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
480 struct property *new;
481
482 new = __of_prop_dup(&p1, GFP_KERNEL);
483 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
484 kfree(new->value);
485 kfree(new->name);
486 kfree(new);
487
488 new = __of_prop_dup(&p2, GFP_KERNEL);
489 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
490 kfree(new->value);
491 kfree(new->name);
492 kfree(new);
493#endif
494}
495
496static void __init of_unittest_changeset(void)
497{
498#ifdef CONFIG_OF_DYNAMIC
499 struct property *ppadd, padd = { .name = "prop-add", .length = 0, .value = "" };
500 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
501 struct property *ppremove;
502 struct device_node *n1, *n2, *n21, *nremove, *parent, *np;
503 struct of_changeset chgset;
504
505 n1 = __of_node_dup(NULL, "/testcase-data/changeset/n1");
506 unittest(n1, "testcase setup failure\n");
507 n2 = __of_node_dup(NULL, "/testcase-data/changeset/n2");
508 unittest(n2, "testcase setup failure\n");
509 n21 = __of_node_dup(NULL, "%s/%s", "/testcase-data/changeset/n2", "n21");
510 unittest(n21, "testcase setup failure %p\n", n21);
511 nremove = of_find_node_by_path("/testcase-data/changeset/node-remove");
512 unittest(nremove, "testcase setup failure\n");
513 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
514 unittest(ppadd, "testcase setup failure\n");
515 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
516 unittest(ppupdate, "testcase setup failure\n");
517 parent = nremove->parent;
518 n1->parent = parent;
519 n2->parent = parent;
520 n21->parent = n2;
521 n2->child = n21;
522 ppremove = of_find_property(parent, "prop-remove", NULL);
523 unittest(ppremove, "failed to find removal prop");
524
525 of_changeset_init(&chgset);
526 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
527 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
528 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
529 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
530 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop\n");
531 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
532 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
533 unittest(!of_changeset_apply(&chgset), "apply failed\n");
534
535 /* Make sure node names are constructed correctly */
536 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
537 "'%s' not added\n", n21->full_name);
538 of_node_put(np);
539
540 unittest(!of_changeset_revert(&chgset), "revert failed\n");
541
542 of_changeset_destroy(&chgset);
543#endif
544}
545
546static void __init of_unittest_parse_interrupts(void)
547{
548 struct device_node *np;
549 struct of_phandle_args args;
550 int i, rc;
551
552 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
553 if (!np) {
554 pr_err("missing testcase data\n");
555 return;
556 }
557
558 for (i = 0; i < 4; i++) {
559 bool passed = true;
560
561 args.args_count = 0;
562 rc = of_irq_parse_one(np, i, &args);
563
564 passed &= !rc;
565 passed &= (args.args_count == 1);
566 passed &= (args.args[0] == (i + 1));
567
568 unittest(passed, "index %i - data error on node %s rc=%i\n",
569 i, args.np->full_name, rc);
570 }
571 of_node_put(np);
572
573 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
574 if (!np) {
575 pr_err("missing testcase data\n");
576 return;
577 }
578
579 for (i = 0; i < 4; i++) {
580 bool passed = true;
581
582 args.args_count = 0;
583 rc = of_irq_parse_one(np, i, &args);
584
585 /* Test the values from tests-phandle.dtsi */
586 switch (i) {
587 case 0:
588 passed &= !rc;
589 passed &= (args.args_count == 1);
590 passed &= (args.args[0] == 9);
591 break;
592 case 1:
593 passed &= !rc;
594 passed &= (args.args_count == 3);
595 passed &= (args.args[0] == 10);
596 passed &= (args.args[1] == 11);
597 passed &= (args.args[2] == 12);
598 break;
599 case 2:
600 passed &= !rc;
601 passed &= (args.args_count == 2);
602 passed &= (args.args[0] == 13);
603 passed &= (args.args[1] == 14);
604 break;
605 case 3:
606 passed &= !rc;
607 passed &= (args.args_count == 2);
608 passed &= (args.args[0] == 15);
609 passed &= (args.args[1] == 16);
610 break;
611 default:
612 passed = false;
613 }
614 unittest(passed, "index %i - data error on node %s rc=%i\n",
615 i, args.np->full_name, rc);
616 }
617 of_node_put(np);
618}
619
620static void __init of_unittest_parse_interrupts_extended(void)
621{
622 struct device_node *np;
623 struct of_phandle_args args;
624 int i, rc;
625
626 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
627 if (!np) {
628 pr_err("missing testcase data\n");
629 return;
630 }
631
632 for (i = 0; i < 7; i++) {
633 bool passed = true;
634
635 rc = of_irq_parse_one(np, i, &args);
636
637 /* Test the values from tests-phandle.dtsi */
638 switch (i) {
639 case 0:
640 passed &= !rc;
641 passed &= (args.args_count == 1);
642 passed &= (args.args[0] == 1);
643 break;
644 case 1:
645 passed &= !rc;
646 passed &= (args.args_count == 3);
647 passed &= (args.args[0] == 2);
648 passed &= (args.args[1] == 3);
649 passed &= (args.args[2] == 4);
650 break;
651 case 2:
652 passed &= !rc;
653 passed &= (args.args_count == 2);
654 passed &= (args.args[0] == 5);
655 passed &= (args.args[1] == 6);
656 break;
657 case 3:
658 passed &= !rc;
659 passed &= (args.args_count == 1);
660 passed &= (args.args[0] == 9);
661 break;
662 case 4:
663 passed &= !rc;
664 passed &= (args.args_count == 3);
665 passed &= (args.args[0] == 10);
666 passed &= (args.args[1] == 11);
667 passed &= (args.args[2] == 12);
668 break;
669 case 5:
670 passed &= !rc;
671 passed &= (args.args_count == 2);
672 passed &= (args.args[0] == 13);
673 passed &= (args.args[1] == 14);
674 break;
675 case 6:
676 passed &= !rc;
677 passed &= (args.args_count == 1);
678 passed &= (args.args[0] == 15);
679 break;
680 default:
681 passed = false;
682 }
683
684 unittest(passed, "index %i - data error on node %s rc=%i\n",
685 i, args.np->full_name, rc);
686 }
687 of_node_put(np);
688}
689
690static const struct of_device_id match_node_table[] = {
691 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
692 { .data = "B", .type = "type1", }, /* followed by type alone */
693
694 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
695 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
696 { .data = "Cc", .name = "name2", .type = "type2", },
697
698 { .data = "E", .compatible = "compat3" },
699 { .data = "G", .compatible = "compat2", },
700 { .data = "H", .compatible = "compat2", .name = "name5", },
701 { .data = "I", .compatible = "compat2", .type = "type1", },
702 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
703 { .data = "K", .compatible = "compat2", .name = "name9", },
704 {}
705};
706
707static struct {
708 const char *path;
709 const char *data;
710} match_node_tests[] = {
711 { .path = "/testcase-data/match-node/name0", .data = "A", },
712 { .path = "/testcase-data/match-node/name1", .data = "B", },
713 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
714 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
715 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
716 { .path = "/testcase-data/match-node/name3", .data = "E", },
717 { .path = "/testcase-data/match-node/name4", .data = "G", },
718 { .path = "/testcase-data/match-node/name5", .data = "H", },
719 { .path = "/testcase-data/match-node/name6", .data = "G", },
720 { .path = "/testcase-data/match-node/name7", .data = "I", },
721 { .path = "/testcase-data/match-node/name8", .data = "J", },
722 { .path = "/testcase-data/match-node/name9", .data = "K", },
723};
724
725static void __init of_unittest_match_node(void)
726{
727 struct device_node *np;
728 const struct of_device_id *match;
729 int i;
730
731 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
732 np = of_find_node_by_path(match_node_tests[i].path);
733 if (!np) {
734 unittest(0, "missing testcase node %s\n",
735 match_node_tests[i].path);
736 continue;
737 }
738
739 match = of_match_node(match_node_table, np);
740 if (!match) {
741 unittest(0, "%s didn't match anything\n",
742 match_node_tests[i].path);
743 continue;
744 }
745
746 if (strcmp(match->data, match_node_tests[i].data) != 0) {
747 unittest(0, "%s got wrong match. expected %s, got %s\n",
748 match_node_tests[i].path, match_node_tests[i].data,
749 (const char *)match->data);
750 continue;
751 }
752 unittest(1, "passed");
753 }
754}
755
756static struct resource test_bus_res = {
757 .start = 0xfffffff8,
758 .end = 0xfffffff9,
759 .flags = IORESOURCE_MEM,
760};
761static const struct platform_device_info test_bus_info = {
762 .name = "unittest-bus",
763};
764static void __init of_unittest_platform_populate(void)
765{
766 int irq, rc;
767 struct device_node *np, *child, *grandchild;
768 struct platform_device *pdev, *test_bus;
769 const struct of_device_id match[] = {
770 { .compatible = "test-device", },
771 {}
772 };
773
774 np = of_find_node_by_path("/testcase-data");
775 of_platform_populate(np, of_default_bus_match_table, NULL, NULL);
776
777 /* Test that a missing irq domain returns -EPROBE_DEFER */
778 np = of_find_node_by_path("/testcase-data/testcase-device1");
779 pdev = of_find_device_by_node(np);
780 unittest(pdev, "device 1 creation failed\n");
781
782 irq = platform_get_irq(pdev, 0);
783 unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq);
784
785 /* Test that a parsing failure does not return -EPROBE_DEFER */
786 np = of_find_node_by_path("/testcase-data/testcase-device2");
787 pdev = of_find_device_by_node(np);
788 unittest(pdev, "device 2 creation failed\n");
789 irq = platform_get_irq(pdev, 0);
790 unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq);
791
792 np = of_find_node_by_path("/testcase-data/platform-tests");
793 unittest(np, "No testcase data in device tree\n");
794 if (!np)
795 return;
796
797 test_bus = platform_device_register_full(&test_bus_info);
798 rc = PTR_ERR_OR_ZERO(test_bus);
799 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
800 if (rc)
801 return;
802 test_bus->dev.of_node = np;
803
804 /*
805 * Add a dummy resource to the test bus node after it is
806 * registered to catch problems with un-inserted resources. The
807 * DT code doesn't insert the resources, and it has caused the
808 * kernel to oops in the past. This makes sure the same bug
809 * doesn't crop up again.
810 */
811 platform_device_add_resources(test_bus, &test_bus_res, 1);
812
813 of_platform_populate(np, match, NULL, &test_bus->dev);
814 for_each_child_of_node(np, child) {
815 for_each_child_of_node(child, grandchild)
816 unittest(of_find_device_by_node(grandchild),
817 "Could not create device for node '%s'\n",
818 grandchild->name);
819 }
820
821 of_platform_depopulate(&test_bus->dev);
822 for_each_child_of_node(np, child) {
823 for_each_child_of_node(child, grandchild)
824 unittest(!of_find_device_by_node(grandchild),
825 "device didn't get destroyed '%s'\n",
826 grandchild->name);
827 }
828
829 platform_device_unregister(test_bus);
830 of_node_put(np);
831}
832
833/**
834 * update_node_properties - adds the properties
835 * of np into dup node (present in live tree) and
836 * updates parent of children of np to dup.
837 *
838 * @np: node already present in live tree
839 * @dup: node present in live tree to be updated
840 */
841static void update_node_properties(struct device_node *np,
842 struct device_node *dup)
843{
844 struct property *prop;
845 struct device_node *child;
846
847 for_each_property_of_node(np, prop)
848 of_add_property(dup, prop);
849
850 for_each_child_of_node(np, child)
851 child->parent = dup;
852}
853
854/**
855 * attach_node_and_children - attaches nodes
856 * and its children to live tree
857 *
858 * @np: Node to attach to live tree
859 */
860static int attach_node_and_children(struct device_node *np)
861{
862 struct device_node *next, *dup, *child;
863 unsigned long flags;
864
865 dup = of_find_node_by_path(np->full_name);
866 if (dup) {
867 update_node_properties(np, dup);
868 return 0;
869 }
870
871 child = np->child;
872 np->child = NULL;
873
874 mutex_lock(&of_mutex);
875 raw_spin_lock_irqsave(&devtree_lock, flags);
876 np->sibling = np->parent->child;
877 np->parent->child = np;
878 of_node_clear_flag(np, OF_DETACHED);
879 raw_spin_unlock_irqrestore(&devtree_lock, flags);
880
881 __of_attach_node_sysfs(np);
882 mutex_unlock(&of_mutex);
883
884 while (child) {
885 next = child->sibling;
886 attach_node_and_children(child);
887 child = next;
888 }
889
890 return 0;
891}
892
893/**
894 * unittest_data_add - Reads, copies data from
895 * linked tree and attaches it to the live tree
896 */
897static int __init unittest_data_add(void)
898{
899 void *unittest_data;
900 struct device_node *unittest_data_node, *np;
901 /*
902 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
903 * created by cmd_dt_S_dtb in scripts/Makefile.lib
904 */
905 extern uint8_t __dtb_testcases_begin[];
906 extern uint8_t __dtb_testcases_end[];
907 const int size = __dtb_testcases_end - __dtb_testcases_begin;
908 int rc;
909
910 if (!size) {
911 pr_warn("%s: No testcase data to attach; not running tests\n",
912 __func__);
913 return -ENODATA;
914 }
915
916 /* creating copy */
917 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
918
919 if (!unittest_data) {
920 pr_warn("%s: Failed to allocate memory for unittest_data; "
921 "not running tests\n", __func__);
922 return -ENOMEM;
923 }
924 of_fdt_unflatten_tree(unittest_data, &unittest_data_node);
925 if (!unittest_data_node) {
926 pr_warn("%s: No tree to attach; not running tests\n", __func__);
927 return -ENODATA;
928 }
929 of_node_set_flag(unittest_data_node, OF_DETACHED);
930 rc = of_resolve_phandles(unittest_data_node);
931 if (rc) {
932 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
933 return -EINVAL;
934 }
935
936 if (!of_root) {
937 of_root = unittest_data_node;
938 for_each_of_allnodes(np)
939 __of_attach_node_sysfs(np);
940 of_aliases = of_find_node_by_path("/aliases");
941 of_chosen = of_find_node_by_path("/chosen");
942 return 0;
943 }
944
945 /* attach the sub-tree to live tree */
946 np = unittest_data_node->child;
947 while (np) {
948 struct device_node *next = np->sibling;
949
950 np->parent = of_root;
951 attach_node_and_children(np);
952 np = next;
953 }
954 return 0;
955}
956
957#ifdef CONFIG_OF_OVERLAY
958
959static int unittest_probe(struct platform_device *pdev)
960{
961 struct device *dev = &pdev->dev;
962 struct device_node *np = dev->of_node;
963
964 if (np == NULL) {
965 dev_err(dev, "No OF data for device\n");
966 return -EINVAL;
967
968 }
969
970 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
971
972 of_platform_populate(np, NULL, NULL, &pdev->dev);
973
974 return 0;
975}
976
977static int unittest_remove(struct platform_device *pdev)
978{
979 struct device *dev = &pdev->dev;
980 struct device_node *np = dev->of_node;
981
982 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
983 return 0;
984}
985
986static const struct of_device_id unittest_match[] = {
987 { .compatible = "unittest", },
988 {},
989};
990
991static struct platform_driver unittest_driver = {
992 .probe = unittest_probe,
993 .remove = unittest_remove,
994 .driver = {
995 .name = "unittest",
996 .of_match_table = of_match_ptr(unittest_match),
997 },
998};
999
1000/* get the platform device instantiated at the path */
1001static struct platform_device *of_path_to_platform_device(const char *path)
1002{
1003 struct device_node *np;
1004 struct platform_device *pdev;
1005
1006 np = of_find_node_by_path(path);
1007 if (np == NULL)
1008 return NULL;
1009
1010 pdev = of_find_device_by_node(np);
1011 of_node_put(np);
1012
1013 return pdev;
1014}
1015
1016/* find out if a platform device exists at that path */
1017static int of_path_platform_device_exists(const char *path)
1018{
1019 struct platform_device *pdev;
1020
1021 pdev = of_path_to_platform_device(path);
1022 platform_device_put(pdev);
1023 return pdev != NULL;
1024}
1025
1026#if IS_BUILTIN(CONFIG_I2C)
1027
1028/* get the i2c client device instantiated at the path */
1029static struct i2c_client *of_path_to_i2c_client(const char *path)
1030{
1031 struct device_node *np;
1032 struct i2c_client *client;
1033
1034 np = of_find_node_by_path(path);
1035 if (np == NULL)
1036 return NULL;
1037
1038 client = of_find_i2c_device_by_node(np);
1039 of_node_put(np);
1040
1041 return client;
1042}
1043
1044/* find out if a i2c client device exists at that path */
1045static int of_path_i2c_client_exists(const char *path)
1046{
1047 struct i2c_client *client;
1048
1049 client = of_path_to_i2c_client(path);
1050 if (client)
1051 put_device(&client->dev);
1052 return client != NULL;
1053}
1054#else
1055static int of_path_i2c_client_exists(const char *path)
1056{
1057 return 0;
1058}
1059#endif
1060
1061enum overlay_type {
1062 PDEV_OVERLAY,
1063 I2C_OVERLAY
1064};
1065
1066static int of_path_device_type_exists(const char *path,
1067 enum overlay_type ovtype)
1068{
1069 switch (ovtype) {
1070 case PDEV_OVERLAY:
1071 return of_path_platform_device_exists(path);
1072 case I2C_OVERLAY:
1073 return of_path_i2c_client_exists(path);
1074 }
1075 return 0;
1076}
1077
1078static const char *unittest_path(int nr, enum overlay_type ovtype)
1079{
1080 const char *base;
1081 static char buf[256];
1082
1083 switch (ovtype) {
1084 case PDEV_OVERLAY:
1085 base = "/testcase-data/overlay-node/test-bus";
1086 break;
1087 case I2C_OVERLAY:
1088 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1089 break;
1090 default:
1091 buf[0] = '\0';
1092 return buf;
1093 }
1094 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1095 buf[sizeof(buf) - 1] = '\0';
1096 return buf;
1097}
1098
1099static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1100{
1101 const char *path;
1102
1103 path = unittest_path(unittest_nr, ovtype);
1104
1105 switch (ovtype) {
1106 case PDEV_OVERLAY:
1107 return of_path_platform_device_exists(path);
1108 case I2C_OVERLAY:
1109 return of_path_i2c_client_exists(path);
1110 }
1111 return 0;
1112}
1113
1114static const char *overlay_path(int nr)
1115{
1116 static char buf[256];
1117
1118 snprintf(buf, sizeof(buf) - 1,
1119 "/testcase-data/overlay%d", nr);
1120 buf[sizeof(buf) - 1] = '\0';
1121
1122 return buf;
1123}
1124
1125static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1126
1127/* it is guaranteed that overlay ids are assigned in sequence */
1128#define MAX_UNITTEST_OVERLAYS 256
1129static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1130static int overlay_first_id = -1;
1131
1132static void of_unittest_track_overlay(int id)
1133{
1134 if (overlay_first_id < 0)
1135 overlay_first_id = id;
1136 id -= overlay_first_id;
1137
1138 /* we shouldn't need that many */
1139 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1140 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1141}
1142
1143static void of_unittest_untrack_overlay(int id)
1144{
1145 if (overlay_first_id < 0)
1146 return;
1147 id -= overlay_first_id;
1148 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1149 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1150}
1151
1152static void of_unittest_destroy_tracked_overlays(void)
1153{
1154 int id, ret, defers;
1155
1156 if (overlay_first_id < 0)
1157 return;
1158
1159 /* try until no defers */
1160 do {
1161 defers = 0;
1162 /* remove in reverse order */
1163 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1164 if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1165 continue;
1166
1167 ret = of_overlay_destroy(id + overlay_first_id);
1168 if (ret == -ENODEV) {
1169 pr_warn("%s: no overlay to destroy for #%d\n",
1170 __func__, id + overlay_first_id);
1171 continue;
1172 }
1173 if (ret != 0) {
1174 defers++;
1175 pr_warn("%s: overlay destroy failed for #%d\n",
1176 __func__, id + overlay_first_id);
1177 continue;
1178 }
1179
1180 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1181 }
1182 } while (defers > 0);
1183}
1184
1185static int of_unittest_apply_overlay(int unittest_nr, int overlay_nr,
1186 int *overlay_id)
1187{
1188 struct device_node *np = NULL;
1189 int ret, id = -1;
1190
1191 np = of_find_node_by_path(overlay_path(overlay_nr));
1192 if (np == NULL) {
1193 unittest(0, "could not find overlay node @\"%s\"\n",
1194 overlay_path(overlay_nr));
1195 ret = -EINVAL;
1196 goto out;
1197 }
1198
1199 ret = of_overlay_create(np);
1200 if (ret < 0) {
1201 unittest(0, "could not create overlay from \"%s\"\n",
1202 overlay_path(overlay_nr));
1203 goto out;
1204 }
1205 id = ret;
1206 of_unittest_track_overlay(id);
1207
1208 ret = 0;
1209
1210out:
1211 of_node_put(np);
1212
1213 if (overlay_id)
1214 *overlay_id = id;
1215
1216 return ret;
1217}
1218
1219/* apply an overlay while checking before and after states */
1220static int of_unittest_apply_overlay_check(int overlay_nr, int unittest_nr,
1221 int before, int after, enum overlay_type ovtype)
1222{
1223 int ret;
1224
1225 /* unittest device must not be in before state */
1226 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1227 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1228 overlay_path(overlay_nr),
1229 unittest_path(unittest_nr, ovtype),
1230 !before ? "enabled" : "disabled");
1231 return -EINVAL;
1232 }
1233
1234 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, NULL);
1235 if (ret != 0) {
1236 /* of_unittest_apply_overlay already called unittest() */
1237 return ret;
1238 }
1239
1240 /* unittest device must be to set to after state */
1241 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1242 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1243 overlay_path(overlay_nr),
1244 unittest_path(unittest_nr, ovtype),
1245 !after ? "enabled" : "disabled");
1246 return -EINVAL;
1247 }
1248
1249 return 0;
1250}
1251
1252/* apply an overlay and then revert it while checking before, after states */
1253static int of_unittest_apply_revert_overlay_check(int overlay_nr,
1254 int unittest_nr, int before, int after,
1255 enum overlay_type ovtype)
1256{
1257 int ret, ov_id;
1258
1259 /* unittest device must be in before state */
1260 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1261 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1262 overlay_path(overlay_nr),
1263 unittest_path(unittest_nr, ovtype),
1264 !before ? "enabled" : "disabled");
1265 return -EINVAL;
1266 }
1267
1268 /* apply the overlay */
1269 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ov_id);
1270 if (ret != 0) {
1271 /* of_unittest_apply_overlay already called unittest() */
1272 return ret;
1273 }
1274
1275 /* unittest device must be in after state */
1276 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1277 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1278 overlay_path(overlay_nr),
1279 unittest_path(unittest_nr, ovtype),
1280 !after ? "enabled" : "disabled");
1281 return -EINVAL;
1282 }
1283
1284 ret = of_overlay_destroy(ov_id);
1285 if (ret != 0) {
1286 unittest(0, "overlay @\"%s\" failed to be destroyed @\"%s\"\n",
1287 overlay_path(overlay_nr),
1288 unittest_path(unittest_nr, ovtype));
1289 return ret;
1290 }
1291
1292 /* unittest device must be again in before state */
1293 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1294 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1295 overlay_path(overlay_nr),
1296 unittest_path(unittest_nr, ovtype),
1297 !before ? "enabled" : "disabled");
1298 return -EINVAL;
1299 }
1300
1301 return 0;
1302}
1303
1304/* test activation of device */
1305static void of_unittest_overlay_0(void)
1306{
1307 int ret;
1308
1309 /* device should enable */
1310 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
1311 if (ret != 0)
1312 return;
1313
1314 unittest(1, "overlay test %d passed\n", 0);
1315}
1316
1317/* test deactivation of device */
1318static void of_unittest_overlay_1(void)
1319{
1320 int ret;
1321
1322 /* device should disable */
1323 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
1324 if (ret != 0)
1325 return;
1326
1327 unittest(1, "overlay test %d passed\n", 1);
1328}
1329
1330/* test activation of device */
1331static void of_unittest_overlay_2(void)
1332{
1333 int ret;
1334
1335 /* device should enable */
1336 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
1337 if (ret != 0)
1338 return;
1339
1340 unittest(1, "overlay test %d passed\n", 2);
1341}
1342
1343/* test deactivation of device */
1344static void of_unittest_overlay_3(void)
1345{
1346 int ret;
1347
1348 /* device should disable */
1349 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
1350 if (ret != 0)
1351 return;
1352
1353 unittest(1, "overlay test %d passed\n", 3);
1354}
1355
1356/* test activation of a full device node */
1357static void of_unittest_overlay_4(void)
1358{
1359 int ret;
1360
1361 /* device should disable */
1362 ret = of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY);
1363 if (ret != 0)
1364 return;
1365
1366 unittest(1, "overlay test %d passed\n", 4);
1367}
1368
1369/* test overlay apply/revert sequence */
1370static void of_unittest_overlay_5(void)
1371{
1372 int ret;
1373
1374 /* device should disable */
1375 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
1376 if (ret != 0)
1377 return;
1378
1379 unittest(1, "overlay test %d passed\n", 5);
1380}
1381
1382/* test overlay application in sequence */
1383static void of_unittest_overlay_6(void)
1384{
1385 struct device_node *np;
1386 int ret, i, ov_id[2];
1387 int overlay_nr = 6, unittest_nr = 6;
1388 int before = 0, after = 1;
1389
1390 /* unittest device must be in before state */
1391 for (i = 0; i < 2; i++) {
1392 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1393 != before) {
1394 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1395 overlay_path(overlay_nr + i),
1396 unittest_path(unittest_nr + i,
1397 PDEV_OVERLAY),
1398 !before ? "enabled" : "disabled");
1399 return;
1400 }
1401 }
1402
1403 /* apply the overlays */
1404 for (i = 0; i < 2; i++) {
1405
1406 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1407 if (np == NULL) {
1408 unittest(0, "could not find overlay node @\"%s\"\n",
1409 overlay_path(overlay_nr + i));
1410 return;
1411 }
1412
1413 ret = of_overlay_create(np);
1414 if (ret < 0) {
1415 unittest(0, "could not create overlay from \"%s\"\n",
1416 overlay_path(overlay_nr + i));
1417 return;
1418 }
1419 ov_id[i] = ret;
1420 of_unittest_track_overlay(ov_id[i]);
1421 }
1422
1423 for (i = 0; i < 2; i++) {
1424 /* unittest device must be in after state */
1425 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1426 != after) {
1427 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1428 overlay_path(overlay_nr + i),
1429 unittest_path(unittest_nr + i,
1430 PDEV_OVERLAY),
1431 !after ? "enabled" : "disabled");
1432 return;
1433 }
1434 }
1435
1436 for (i = 1; i >= 0; i--) {
1437 ret = of_overlay_destroy(ov_id[i]);
1438 if (ret != 0) {
1439 unittest(0, "overlay @\"%s\" failed destroy @\"%s\"\n",
1440 overlay_path(overlay_nr + i),
1441 unittest_path(unittest_nr + i,
1442 PDEV_OVERLAY));
1443 return;
1444 }
1445 of_unittest_untrack_overlay(ov_id[i]);
1446 }
1447
1448 for (i = 0; i < 2; i++) {
1449 /* unittest device must be again in before state */
1450 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1451 != before) {
1452 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1453 overlay_path(overlay_nr + i),
1454 unittest_path(unittest_nr + i,
1455 PDEV_OVERLAY),
1456 !before ? "enabled" : "disabled");
1457 return;
1458 }
1459 }
1460
1461 unittest(1, "overlay test %d passed\n", 6);
1462}
1463
1464/* test overlay application in sequence */
1465static void of_unittest_overlay_8(void)
1466{
1467 struct device_node *np;
1468 int ret, i, ov_id[2];
1469 int overlay_nr = 8, unittest_nr = 8;
1470
1471 /* we don't care about device state in this test */
1472
1473 /* apply the overlays */
1474 for (i = 0; i < 2; i++) {
1475
1476 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1477 if (np == NULL) {
1478 unittest(0, "could not find overlay node @\"%s\"\n",
1479 overlay_path(overlay_nr + i));
1480 return;
1481 }
1482
1483 ret = of_overlay_create(np);
1484 if (ret < 0) {
1485 unittest(0, "could not create overlay from \"%s\"\n",
1486 overlay_path(overlay_nr + i));
1487 return;
1488 }
1489 ov_id[i] = ret;
1490 of_unittest_track_overlay(ov_id[i]);
1491 }
1492
1493 /* now try to remove first overlay (it should fail) */
1494 ret = of_overlay_destroy(ov_id[0]);
1495 if (ret == 0) {
1496 unittest(0, "overlay @\"%s\" was destroyed @\"%s\"\n",
1497 overlay_path(overlay_nr + 0),
1498 unittest_path(unittest_nr,
1499 PDEV_OVERLAY));
1500 return;
1501 }
1502
1503 /* removing them in order should work */
1504 for (i = 1; i >= 0; i--) {
1505 ret = of_overlay_destroy(ov_id[i]);
1506 if (ret != 0) {
1507 unittest(0, "overlay @\"%s\" not destroyed @\"%s\"\n",
1508 overlay_path(overlay_nr + i),
1509 unittest_path(unittest_nr,
1510 PDEV_OVERLAY));
1511 return;
1512 }
1513 of_unittest_untrack_overlay(ov_id[i]);
1514 }
1515
1516 unittest(1, "overlay test %d passed\n", 8);
1517}
1518
1519/* test insertion of a bus with parent devices */
1520static void of_unittest_overlay_10(void)
1521{
1522 int ret;
1523 char *child_path;
1524
1525 /* device should disable */
1526 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1527 if (unittest(ret == 0,
1528 "overlay test %d failed; overlay application\n", 10))
1529 return;
1530
1531 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1532 unittest_path(10, PDEV_OVERLAY));
1533 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1534 return;
1535
1536 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1537 kfree(child_path);
1538 if (unittest(ret, "overlay test %d failed; no child device\n", 10))
1539 return;
1540}
1541
1542/* test insertion of a bus with parent devices (and revert) */
1543static void of_unittest_overlay_11(void)
1544{
1545 int ret;
1546
1547 /* device should disable */
1548 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1549 PDEV_OVERLAY);
1550 if (unittest(ret == 0,
1551 "overlay test %d failed; overlay application\n", 11))
1552 return;
1553}
1554
1555#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1556
1557struct unittest_i2c_bus_data {
1558 struct platform_device *pdev;
1559 struct i2c_adapter adap;
1560};
1561
1562static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1563 struct i2c_msg *msgs, int num)
1564{
1565 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1566
1567 (void)std;
1568
1569 return num;
1570}
1571
1572static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1573{
1574 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1575}
1576
1577static const struct i2c_algorithm unittest_i2c_algo = {
1578 .master_xfer = unittest_i2c_master_xfer,
1579 .functionality = unittest_i2c_functionality,
1580};
1581
1582static int unittest_i2c_bus_probe(struct platform_device *pdev)
1583{
1584 struct device *dev = &pdev->dev;
1585 struct device_node *np = dev->of_node;
1586 struct unittest_i2c_bus_data *std;
1587 struct i2c_adapter *adap;
1588 int ret;
1589
1590 if (np == NULL) {
1591 dev_err(dev, "No OF data for device\n");
1592 return -EINVAL;
1593
1594 }
1595
1596 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1597
1598 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1599 if (!std) {
1600 dev_err(dev, "Failed to allocate unittest i2c data\n");
1601 return -ENOMEM;
1602 }
1603
1604 /* link them together */
1605 std->pdev = pdev;
1606 platform_set_drvdata(pdev, std);
1607
1608 adap = &std->adap;
1609 i2c_set_adapdata(adap, std);
1610 adap->nr = -1;
1611 strlcpy(adap->name, pdev->name, sizeof(adap->name));
1612 adap->class = I2C_CLASS_DEPRECATED;
1613 adap->algo = &unittest_i2c_algo;
1614 adap->dev.parent = dev;
1615 adap->dev.of_node = dev->of_node;
1616 adap->timeout = 5 * HZ;
1617 adap->retries = 3;
1618
1619 ret = i2c_add_numbered_adapter(adap);
1620 if (ret != 0) {
1621 dev_err(dev, "Failed to add I2C adapter\n");
1622 return ret;
1623 }
1624
1625 return 0;
1626}
1627
1628static int unittest_i2c_bus_remove(struct platform_device *pdev)
1629{
1630 struct device *dev = &pdev->dev;
1631 struct device_node *np = dev->of_node;
1632 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1633
1634 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1635 i2c_del_adapter(&std->adap);
1636
1637 return 0;
1638}
1639
1640static const struct of_device_id unittest_i2c_bus_match[] = {
1641 { .compatible = "unittest-i2c-bus", },
1642 {},
1643};
1644
1645static struct platform_driver unittest_i2c_bus_driver = {
1646 .probe = unittest_i2c_bus_probe,
1647 .remove = unittest_i2c_bus_remove,
1648 .driver = {
1649 .name = "unittest-i2c-bus",
1650 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1651 },
1652};
1653
1654static int unittest_i2c_dev_probe(struct i2c_client *client,
1655 const struct i2c_device_id *id)
1656{
1657 struct device *dev = &client->dev;
1658 struct device_node *np = client->dev.of_node;
1659
1660 if (!np) {
1661 dev_err(dev, "No OF node\n");
1662 return -EINVAL;
1663 }
1664
1665 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1666
1667 return 0;
1668};
1669
1670static int unittest_i2c_dev_remove(struct i2c_client *client)
1671{
1672 struct device *dev = &client->dev;
1673 struct device_node *np = client->dev.of_node;
1674
1675 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1676 return 0;
1677}
1678
1679static const struct i2c_device_id unittest_i2c_dev_id[] = {
1680 { .name = "unittest-i2c-dev" },
1681 { }
1682};
1683
1684static struct i2c_driver unittest_i2c_dev_driver = {
1685 .driver = {
1686 .name = "unittest-i2c-dev",
1687 },
1688 .probe = unittest_i2c_dev_probe,
1689 .remove = unittest_i2c_dev_remove,
1690 .id_table = unittest_i2c_dev_id,
1691};
1692
1693#if IS_BUILTIN(CONFIG_I2C_MUX)
1694
1695struct unittest_i2c_mux_data {
1696 int nchans;
1697 struct i2c_adapter *adap[];
1698};
1699
1700static int unittest_i2c_mux_select_chan(struct i2c_adapter *adap,
1701 void *client, u32 chan)
1702{
1703 return 0;
1704}
1705
1706static int unittest_i2c_mux_probe(struct i2c_client *client,
1707 const struct i2c_device_id *id)
1708{
1709 int ret, i, nchans, size;
1710 struct device *dev = &client->dev;
1711 struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1712 struct device_node *np = client->dev.of_node, *child;
1713 struct unittest_i2c_mux_data *stm;
1714 u32 reg, max_reg;
1715
1716 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1717
1718 if (!np) {
1719 dev_err(dev, "No OF node\n");
1720 return -EINVAL;
1721 }
1722
1723 max_reg = (u32)-1;
1724 for_each_child_of_node(np, child) {
1725 ret = of_property_read_u32(child, "reg", ®);
1726 if (ret)
1727 continue;
1728 if (max_reg == (u32)-1 || reg > max_reg)
1729 max_reg = reg;
1730 }
1731 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1732 if (nchans == 0) {
1733 dev_err(dev, "No channels\n");
1734 return -EINVAL;
1735 }
1736
1737 size = offsetof(struct unittest_i2c_mux_data, adap[nchans]);
1738 stm = devm_kzalloc(dev, size, GFP_KERNEL);
1739 if (!stm) {
1740 dev_err(dev, "Out of memory\n");
1741 return -ENOMEM;
1742 }
1743 stm->nchans = nchans;
1744 for (i = 0; i < nchans; i++) {
1745 stm->adap[i] = i2c_add_mux_adapter(adap, dev, client,
1746 0, i, 0, unittest_i2c_mux_select_chan, NULL);
1747 if (!stm->adap[i]) {
1748 dev_err(dev, "Failed to register mux #%d\n", i);
1749 for (i--; i >= 0; i--)
1750 i2c_del_mux_adapter(stm->adap[i]);
1751 return -ENODEV;
1752 }
1753 }
1754
1755 i2c_set_clientdata(client, stm);
1756
1757 return 0;
1758};
1759
1760static int unittest_i2c_mux_remove(struct i2c_client *client)
1761{
1762 struct device *dev = &client->dev;
1763 struct device_node *np = client->dev.of_node;
1764 struct unittest_i2c_mux_data *stm = i2c_get_clientdata(client);
1765 int i;
1766
1767 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1768 for (i = stm->nchans - 1; i >= 0; i--)
1769 i2c_del_mux_adapter(stm->adap[i]);
1770 return 0;
1771}
1772
1773static const struct i2c_device_id unittest_i2c_mux_id[] = {
1774 { .name = "unittest-i2c-mux" },
1775 { }
1776};
1777
1778static struct i2c_driver unittest_i2c_mux_driver = {
1779 .driver = {
1780 .name = "unittest-i2c-mux",
1781 },
1782 .probe = unittest_i2c_mux_probe,
1783 .remove = unittest_i2c_mux_remove,
1784 .id_table = unittest_i2c_mux_id,
1785};
1786
1787#endif
1788
1789static int of_unittest_overlay_i2c_init(void)
1790{
1791 int ret;
1792
1793 ret = i2c_add_driver(&unittest_i2c_dev_driver);
1794 if (unittest(ret == 0,
1795 "could not register unittest i2c device driver\n"))
1796 return ret;
1797
1798 ret = platform_driver_register(&unittest_i2c_bus_driver);
1799 if (unittest(ret == 0,
1800 "could not register unittest i2c bus driver\n"))
1801 return ret;
1802
1803#if IS_BUILTIN(CONFIG_I2C_MUX)
1804 ret = i2c_add_driver(&unittest_i2c_mux_driver);
1805 if (unittest(ret == 0,
1806 "could not register unittest i2c mux driver\n"))
1807 return ret;
1808#endif
1809
1810 return 0;
1811}
1812
1813static void of_unittest_overlay_i2c_cleanup(void)
1814{
1815#if IS_BUILTIN(CONFIG_I2C_MUX)
1816 i2c_del_driver(&unittest_i2c_mux_driver);
1817#endif
1818 platform_driver_unregister(&unittest_i2c_bus_driver);
1819 i2c_del_driver(&unittest_i2c_dev_driver);
1820}
1821
1822static void of_unittest_overlay_i2c_12(void)
1823{
1824 int ret;
1825
1826 /* device should enable */
1827 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
1828 if (ret != 0)
1829 return;
1830
1831 unittest(1, "overlay test %d passed\n", 12);
1832}
1833
1834/* test deactivation of device */
1835static void of_unittest_overlay_i2c_13(void)
1836{
1837 int ret;
1838
1839 /* device should disable */
1840 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
1841 if (ret != 0)
1842 return;
1843
1844 unittest(1, "overlay test %d passed\n", 13);
1845}
1846
1847/* just check for i2c mux existence */
1848static void of_unittest_overlay_i2c_14(void)
1849{
1850}
1851
1852static void of_unittest_overlay_i2c_15(void)
1853{
1854 int ret;
1855
1856 /* device should enable */
1857 ret = of_unittest_apply_overlay_check(16, 15, 0, 1, I2C_OVERLAY);
1858 if (ret != 0)
1859 return;
1860
1861 unittest(1, "overlay test %d passed\n", 15);
1862}
1863
1864#else
1865
1866static inline void of_unittest_overlay_i2c_14(void) { }
1867static inline void of_unittest_overlay_i2c_15(void) { }
1868
1869#endif
1870
1871static void __init of_unittest_overlay(void)
1872{
1873 struct device_node *bus_np = NULL;
1874 int ret;
1875
1876 ret = platform_driver_register(&unittest_driver);
1877 if (ret != 0) {
1878 unittest(0, "could not register unittest driver\n");
1879 goto out;
1880 }
1881
1882 bus_np = of_find_node_by_path(bus_path);
1883 if (bus_np == NULL) {
1884 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
1885 goto out;
1886 }
1887
1888 ret = of_platform_populate(bus_np, of_default_bus_match_table,
1889 NULL, NULL);
1890 if (ret != 0) {
1891 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
1892 goto out;
1893 }
1894
1895 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
1896 unittest(0, "could not find unittest0 @ \"%s\"\n",
1897 unittest_path(100, PDEV_OVERLAY));
1898 goto out;
1899 }
1900
1901 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
1902 unittest(0, "unittest1 @ \"%s\" should not exist\n",
1903 unittest_path(101, PDEV_OVERLAY));
1904 goto out;
1905 }
1906
1907 unittest(1, "basic infrastructure of overlays passed");
1908
1909 /* tests in sequence */
1910 of_unittest_overlay_0();
1911 of_unittest_overlay_1();
1912 of_unittest_overlay_2();
1913 of_unittest_overlay_3();
1914 of_unittest_overlay_4();
1915 of_unittest_overlay_5();
1916 of_unittest_overlay_6();
1917 of_unittest_overlay_8();
1918
1919 of_unittest_overlay_10();
1920 of_unittest_overlay_11();
1921
1922#if IS_BUILTIN(CONFIG_I2C)
1923 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
1924 goto out;
1925
1926 of_unittest_overlay_i2c_12();
1927 of_unittest_overlay_i2c_13();
1928 of_unittest_overlay_i2c_14();
1929 of_unittest_overlay_i2c_15();
1930
1931 of_unittest_overlay_i2c_cleanup();
1932#endif
1933
1934 of_unittest_destroy_tracked_overlays();
1935
1936out:
1937 of_node_put(bus_np);
1938}
1939
1940#else
1941static inline void __init of_unittest_overlay(void) { }
1942#endif
1943
1944static int __init of_unittest(void)
1945{
1946 struct device_node *np;
1947 int res;
1948
1949 /* adding data for unittest */
1950 res = unittest_data_add();
1951 if (res)
1952 return res;
1953 if (!of_aliases)
1954 of_aliases = of_find_node_by_path("/aliases");
1955
1956 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
1957 if (!np) {
1958 pr_info("No testcase data in device tree; not running tests\n");
1959 return 0;
1960 }
1961 of_node_put(np);
1962
1963 pr_info("start of unittest - you will see error messages\n");
1964 of_unittest_check_tree_linkage();
1965 of_unittest_check_phandles();
1966 of_unittest_find_node_by_name();
1967 of_unittest_dynamic();
1968 of_unittest_parse_phandle_with_args();
1969 of_unittest_property_string();
1970 of_unittest_property_copy();
1971 of_unittest_changeset();
1972 of_unittest_parse_interrupts();
1973 of_unittest_parse_interrupts_extended();
1974 of_unittest_match_node();
1975 of_unittest_platform_populate();
1976 of_unittest_overlay();
1977
1978 /* Double check linkage after removing testcase data */
1979 of_unittest_check_tree_linkage();
1980
1981 pr_info("end of unittest - %i passed, %i failed\n",
1982 unittest_results.passed, unittest_results.failed);
1983
1984 return 0;
1985}
1986late_initcall(of_unittest);