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/dma-direct.h> /* to test phys_to_dma/dma_to_phys */
11#include <linux/err.h>
12#include <linux/errno.h>
13#include <linux/hashtable.h>
14#include <linux/libfdt.h>
15#include <linux/of.h>
16#include <linux/of_address.h>
17#include <linux/of_fdt.h>
18#include <linux/of_irq.h>
19#include <linux/of_platform.h>
20#include <linux/list.h>
21#include <linux/mutex.h>
22#include <linux/slab.h>
23#include <linux/device.h>
24#include <linux/platform_device.h>
25#include <linux/pci.h>
26#include <linux/kernel.h>
27
28#include <linux/i2c.h>
29#include <linux/i2c-mux.h>
30#include <linux/gpio/driver.h>
31
32#include <linux/bitops.h>
33
34#include "of_private.h"
35
36static struct unittest_results {
37 int passed;
38 int failed;
39} unittest_results;
40
41#define unittest(result, fmt, ...) ({ \
42 bool failed = !(result); \
43 if (failed) { \
44 unittest_results.failed++; \
45 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
46 } else { \
47 unittest_results.passed++; \
48 pr_info("pass %s():%i\n", __func__, __LINE__); \
49 } \
50 failed; \
51})
52
53#ifdef CONFIG_OF_KOBJ
54#define OF_KREF_READ(NODE) kref_read(&(NODE)->kobj.kref)
55#else
56#define OF_KREF_READ(NODE) 1
57#endif
58
59/*
60 * Expected message may have a message level other than KERN_INFO.
61 * Print the expected message only if the current loglevel will allow
62 * the actual message to print.
63 *
64 * Do not use EXPECT_BEGIN(), EXPECT_END(), EXPECT_NOT_BEGIN(), or
65 * EXPECT_NOT_END() to report messages expected to be reported or not
66 * reported by pr_debug().
67 */
68#define EXPECT_BEGIN(level, fmt, ...) \
69 printk(level pr_fmt("EXPECT \\ : ") fmt, ##__VA_ARGS__)
70
71#define EXPECT_END(level, fmt, ...) \
72 printk(level pr_fmt("EXPECT / : ") fmt, ##__VA_ARGS__)
73
74#define EXPECT_NOT_BEGIN(level, fmt, ...) \
75 printk(level pr_fmt("EXPECT_NOT \\ : ") fmt, ##__VA_ARGS__)
76
77#define EXPECT_NOT_END(level, fmt, ...) \
78 printk(level pr_fmt("EXPECT_NOT / : ") fmt, ##__VA_ARGS__)
79
80static void __init of_unittest_find_node_by_name(void)
81{
82 struct device_node *np;
83 const char *options, *name;
84
85 np = of_find_node_by_path("/testcase-data");
86 name = kasprintf(GFP_KERNEL, "%pOF", np);
87 unittest(np && name && !strcmp("/testcase-data", name),
88 "find /testcase-data failed\n");
89 of_node_put(np);
90 kfree(name);
91
92 /* Test if trailing '/' works */
93 np = of_find_node_by_path("/testcase-data/");
94 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
95
96 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
97 name = kasprintf(GFP_KERNEL, "%pOF", np);
98 unittest(np && name && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
99 "find /testcase-data/phandle-tests/consumer-a failed\n");
100 of_node_put(np);
101 kfree(name);
102
103 np = of_find_node_by_path("testcase-alias");
104 name = kasprintf(GFP_KERNEL, "%pOF", np);
105 unittest(np && name && !strcmp("/testcase-data", name),
106 "find testcase-alias failed\n");
107 of_node_put(np);
108 kfree(name);
109
110 /* Test if trailing '/' works on aliases */
111 np = of_find_node_by_path("testcase-alias/");
112 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
113
114 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
115 name = kasprintf(GFP_KERNEL, "%pOF", np);
116 unittest(np && name && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
117 "find testcase-alias/phandle-tests/consumer-a failed\n");
118 of_node_put(np);
119 kfree(name);
120
121 np = of_find_node_by_path("/testcase-data/missing-path");
122 unittest(!np, "non-existent path returned node %pOF\n", np);
123 of_node_put(np);
124
125 np = of_find_node_by_path("missing-alias");
126 unittest(!np, "non-existent alias returned node %pOF\n", np);
127 of_node_put(np);
128
129 np = of_find_node_by_path("testcase-alias/missing-path");
130 unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
131 of_node_put(np);
132
133 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
134 unittest(np && !strcmp("testoption", options),
135 "option path test failed\n");
136 of_node_put(np);
137
138 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
139 unittest(np && !strcmp("test/option", options),
140 "option path test, subcase #1 failed\n");
141 of_node_put(np);
142
143 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
144 unittest(np && !strcmp("test/option", options),
145 "option path test, subcase #2 failed\n");
146 of_node_put(np);
147
148 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
149 unittest(np, "NULL option path test failed\n");
150 of_node_put(np);
151
152 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
153 &options);
154 unittest(np && !strcmp("testaliasoption", options),
155 "option alias path test failed\n");
156 of_node_put(np);
157
158 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
159 &options);
160 unittest(np && !strcmp("test/alias/option", options),
161 "option alias path test, subcase #1 failed\n");
162 of_node_put(np);
163
164 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
165 unittest(np, "NULL option alias path test failed\n");
166 of_node_put(np);
167
168 options = "testoption";
169 np = of_find_node_opts_by_path("testcase-alias", &options);
170 unittest(np && !options, "option clearing test failed\n");
171 of_node_put(np);
172
173 options = "testoption";
174 np = of_find_node_opts_by_path("/", &options);
175 unittest(np && !options, "option clearing root node test failed\n");
176 of_node_put(np);
177}
178
179static void __init of_unittest_dynamic(void)
180{
181 struct device_node *np;
182 struct property *prop;
183
184 np = of_find_node_by_path("/testcase-data");
185 if (!np) {
186 pr_err("missing testcase data\n");
187 return;
188 }
189
190 /* Array of 4 properties for the purpose of testing */
191 prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
192 if (!prop) {
193 unittest(0, "kzalloc() failed\n");
194 return;
195 }
196
197 /* Add a new property - should pass*/
198 prop->name = "new-property";
199 prop->value = "new-property-data";
200 prop->length = strlen(prop->value) + 1;
201 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
202
203 /* Try to add an existing property - should fail */
204 prop++;
205 prop->name = "new-property";
206 prop->value = "new-property-data-should-fail";
207 prop->length = strlen(prop->value) + 1;
208 unittest(of_add_property(np, prop) != 0,
209 "Adding an existing property should have failed\n");
210
211 /* Try to modify an existing property - should pass */
212 prop->value = "modify-property-data-should-pass";
213 prop->length = strlen(prop->value) + 1;
214 unittest(of_update_property(np, prop) == 0,
215 "Updating an existing property should have passed\n");
216
217 /* Try to modify non-existent property - should pass*/
218 prop++;
219 prop->name = "modify-property";
220 prop->value = "modify-missing-property-data-should-pass";
221 prop->length = strlen(prop->value) + 1;
222 unittest(of_update_property(np, prop) == 0,
223 "Updating a missing property should have passed\n");
224
225 /* Remove property - should pass */
226 unittest(of_remove_property(np, prop) == 0,
227 "Removing a property should have passed\n");
228
229 /* Adding very large property - should pass */
230 prop++;
231 prop->name = "large-property-PAGE_SIZEx8";
232 prop->length = PAGE_SIZE * 8;
233 prop->value = kzalloc(prop->length, GFP_KERNEL);
234 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
235 if (prop->value)
236 unittest(of_add_property(np, prop) == 0,
237 "Adding a large property should have passed\n");
238}
239
240static int __init of_unittest_check_node_linkage(struct device_node *np)
241{
242 int count = 0, rc;
243
244 for_each_child_of_node_scoped(np, child) {
245 if (child->parent != np) {
246 pr_err("Child node %pOFn links to wrong parent %pOFn\n",
247 child, np);
248 return -EINVAL;
249 }
250
251 rc = of_unittest_check_node_linkage(child);
252 if (rc < 0)
253 return rc;
254 count += rc;
255 }
256
257 return count + 1;
258}
259
260static void __init of_unittest_check_tree_linkage(void)
261{
262 struct device_node *np;
263 int allnode_count = 0, child_count;
264
265 if (!of_root)
266 return;
267
268 for_each_of_allnodes(np)
269 allnode_count++;
270 child_count = of_unittest_check_node_linkage(of_root);
271
272 unittest(child_count > 0, "Device node data structure is corrupted\n");
273 unittest(child_count == allnode_count,
274 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
275 allnode_count, child_count);
276 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
277}
278
279static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
280 const char *expected)
281{
282 unsigned char *buf;
283 int buf_size;
284 int size, i;
285
286 buf_size = strlen(expected) + 10;
287 buf = kmalloc(buf_size, GFP_KERNEL);
288 if (!buf)
289 return;
290
291 /* Baseline; check conversion with a large size limit */
292 memset(buf, 0xff, buf_size);
293 size = snprintf(buf, buf_size - 2, fmt, np);
294
295 /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
296 unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
297 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
298 fmt, expected, buf);
299
300 /* Make sure length limits work */
301 size++;
302 for (i = 0; i < 2; i++, size--) {
303 /* Clear the buffer, and make sure it works correctly still */
304 memset(buf, 0xff, buf_size);
305 snprintf(buf, size+1, fmt, np);
306 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
307 "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
308 size, fmt, expected, buf);
309 }
310 kfree(buf);
311}
312
313static void __init of_unittest_printf(void)
314{
315 struct device_node *np;
316 const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
317 char phandle_str[16] = "";
318
319 np = of_find_node_by_path(full_name);
320 if (!np) {
321 unittest(np, "testcase data missing\n");
322 return;
323 }
324
325 num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
326
327 of_unittest_printf_one(np, "%pOF", full_name);
328 of_unittest_printf_one(np, "%pOFf", full_name);
329 of_unittest_printf_one(np, "%pOFn", "dev");
330 of_unittest_printf_one(np, "%2pOFn", "dev");
331 of_unittest_printf_one(np, "%5pOFn", " dev");
332 of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
333 of_unittest_printf_one(np, "%pOFp", phandle_str);
334 of_unittest_printf_one(np, "%pOFP", "dev@100");
335 of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
336 of_unittest_printf_one(np, "%10pOFP", " dev@100");
337 of_unittest_printf_one(np, "%-10pOFP", "dev@100 ");
338 of_unittest_printf_one(of_root, "%pOFP", "/");
339 of_unittest_printf_one(np, "%pOFF", "----");
340 of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
341 of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
342 of_unittest_printf_one(np, "%pOFc", "test-sub-device");
343 of_unittest_printf_one(np, "%pOFC",
344 "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
345}
346
347struct node_hash {
348 struct hlist_node node;
349 struct device_node *np;
350};
351
352static DEFINE_HASHTABLE(phandle_ht, 8);
353static void __init of_unittest_check_phandles(void)
354{
355 struct device_node *np;
356 struct node_hash *nh;
357 struct hlist_node *tmp;
358 int i, dup_count = 0, phandle_count = 0;
359
360 for_each_of_allnodes(np) {
361 if (!np->phandle)
362 continue;
363
364 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
365 if (nh->np->phandle == np->phandle) {
366 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
367 np->phandle, nh->np, np);
368 dup_count++;
369 break;
370 }
371 }
372
373 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
374 if (!nh)
375 return;
376
377 nh->np = np;
378 hash_add(phandle_ht, &nh->node, np->phandle);
379 phandle_count++;
380 }
381 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
382 dup_count, phandle_count);
383
384 /* Clean up */
385 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
386 hash_del(&nh->node);
387 kfree(nh);
388 }
389}
390
391static void __init of_unittest_parse_phandle_with_args(void)
392{
393 struct device_node *np;
394 struct of_phandle_args args;
395 int i, rc;
396
397 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
398 if (!np) {
399 pr_err("missing testcase data\n");
400 return;
401 }
402
403 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
404 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
405
406 for (i = 0; i < 8; i++) {
407 bool passed = true;
408
409 memset(&args, 0, sizeof(args));
410 rc = of_parse_phandle_with_args(np, "phandle-list",
411 "#phandle-cells", i, &args);
412
413 /* Test the values from tests-phandle.dtsi */
414 switch (i) {
415 case 0:
416 passed &= !rc;
417 passed &= (args.args_count == 1);
418 passed &= (args.args[0] == (i + 1));
419 break;
420 case 1:
421 passed &= !rc;
422 passed &= (args.args_count == 2);
423 passed &= (args.args[0] == (i + 1));
424 passed &= (args.args[1] == 0);
425 break;
426 case 2:
427 passed &= (rc == -ENOENT);
428 break;
429 case 3:
430 passed &= !rc;
431 passed &= (args.args_count == 3);
432 passed &= (args.args[0] == (i + 1));
433 passed &= (args.args[1] == 4);
434 passed &= (args.args[2] == 3);
435 break;
436 case 4:
437 passed &= !rc;
438 passed &= (args.args_count == 2);
439 passed &= (args.args[0] == (i + 1));
440 passed &= (args.args[1] == 100);
441 break;
442 case 5:
443 passed &= !rc;
444 passed &= (args.args_count == 0);
445 break;
446 case 6:
447 passed &= !rc;
448 passed &= (args.args_count == 1);
449 passed &= (args.args[0] == (i + 1));
450 break;
451 case 7:
452 passed &= (rc == -ENOENT);
453 break;
454 default:
455 passed = false;
456 }
457
458 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
459 i, args.np, rc);
460
461 if (rc == 0)
462 of_node_put(args.np);
463 }
464
465 /* Check for missing list property */
466 memset(&args, 0, sizeof(args));
467 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
468 "#phandle-cells", 0, &args);
469 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
470 rc = of_count_phandle_with_args(np, "phandle-list-missing",
471 "#phandle-cells");
472 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
473
474 /* Check for missing cells property */
475 memset(&args, 0, sizeof(args));
476
477 EXPECT_BEGIN(KERN_INFO,
478 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
479
480 rc = of_parse_phandle_with_args(np, "phandle-list",
481 "#phandle-cells-missing", 0, &args);
482
483 EXPECT_END(KERN_INFO,
484 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
485
486 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
487
488 EXPECT_BEGIN(KERN_INFO,
489 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
490
491 rc = of_count_phandle_with_args(np, "phandle-list",
492 "#phandle-cells-missing");
493
494 EXPECT_END(KERN_INFO,
495 "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
496
497 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
498
499 /* Check for bad phandle in list */
500 memset(&args, 0, sizeof(args));
501
502 EXPECT_BEGIN(KERN_INFO,
503 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
504
505 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
506 "#phandle-cells", 0, &args);
507
508 EXPECT_END(KERN_INFO,
509 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
510
511 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
512
513 EXPECT_BEGIN(KERN_INFO,
514 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
515
516 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
517 "#phandle-cells");
518
519 EXPECT_END(KERN_INFO,
520 "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
521
522 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
523
524 /* Check for incorrectly formed argument list */
525 memset(&args, 0, sizeof(args));
526
527 EXPECT_BEGIN(KERN_INFO,
528 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
529
530 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
531 "#phandle-cells", 1, &args);
532
533 EXPECT_END(KERN_INFO,
534 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
535
536 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
537
538 EXPECT_BEGIN(KERN_INFO,
539 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
540
541 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
542 "#phandle-cells");
543
544 EXPECT_END(KERN_INFO,
545 "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
546
547 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
548}
549
550static void __init of_unittest_parse_phandle_with_args_map(void)
551{
552 struct device_node *np, *p[6] = {};
553 struct of_phandle_args args;
554 unsigned int prefs[6];
555 int i, rc;
556
557 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
558 if (!np) {
559 pr_err("missing testcase data\n");
560 return;
561 }
562
563 p[0] = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
564 p[1] = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
565 p[2] = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
566 p[3] = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
567 p[4] = of_find_node_by_path("/testcase-data/phandle-tests/provider4");
568 p[5] = of_find_node_by_path("/testcase-data/phandle-tests/provider5");
569 for (i = 0; i < ARRAY_SIZE(p); ++i) {
570 if (!p[i]) {
571 pr_err("missing testcase data\n");
572 return;
573 }
574 prefs[i] = OF_KREF_READ(p[i]);
575 }
576
577 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
578 unittest(rc == 8, "of_count_phandle_with_args() returned %i, expected 8\n", rc);
579
580 for (i = 0; i < 9; i++) {
581 bool passed = true;
582
583 memset(&args, 0, sizeof(args));
584 rc = of_parse_phandle_with_args_map(np, "phandle-list",
585 "phandle", i, &args);
586
587 /* Test the values from tests-phandle.dtsi */
588 switch (i) {
589 case 0:
590 passed &= !rc;
591 passed &= (args.np == p[1]);
592 passed &= (args.args_count == 1);
593 passed &= (args.args[0] == 1);
594 break;
595 case 1:
596 passed &= !rc;
597 passed &= (args.np == p[3]);
598 passed &= (args.args_count == 3);
599 passed &= (args.args[0] == 2);
600 passed &= (args.args[1] == 5);
601 passed &= (args.args[2] == 3);
602 break;
603 case 2:
604 passed &= (rc == -ENOENT);
605 break;
606 case 3:
607 passed &= !rc;
608 passed &= (args.np == p[0]);
609 passed &= (args.args_count == 0);
610 break;
611 case 4:
612 passed &= !rc;
613 passed &= (args.np == p[1]);
614 passed &= (args.args_count == 1);
615 passed &= (args.args[0] == 3);
616 break;
617 case 5:
618 passed &= !rc;
619 passed &= (args.np == p[0]);
620 passed &= (args.args_count == 0);
621 break;
622 case 6:
623 passed &= !rc;
624 passed &= (args.np == p[2]);
625 passed &= (args.args_count == 2);
626 passed &= (args.args[0] == 15);
627 passed &= (args.args[1] == 0x20);
628 break;
629 case 7:
630 passed &= !rc;
631 passed &= (args.np == p[3]);
632 passed &= (args.args_count == 3);
633 passed &= (args.args[0] == 2);
634 passed &= (args.args[1] == 5);
635 passed &= (args.args[2] == 3);
636 break;
637 case 8:
638 passed &= (rc == -ENOENT);
639 break;
640 default:
641 passed = false;
642 }
643
644 unittest(passed, "index %i - data error on node %s rc=%i\n",
645 i, args.np->full_name, rc);
646
647 if (rc == 0)
648 of_node_put(args.np);
649 }
650
651 /* Check for missing list property */
652 memset(&args, 0, sizeof(args));
653 rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
654 "phandle", 0, &args);
655 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
656
657 /* Check for missing cells,map,mask property */
658 memset(&args, 0, sizeof(args));
659
660 EXPECT_BEGIN(KERN_INFO,
661 "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
662
663 rc = of_parse_phandle_with_args_map(np, "phandle-list",
664 "phandle-missing", 0, &args);
665 EXPECT_END(KERN_INFO,
666 "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
667
668 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
669
670 /* Check for bad phandle in list */
671 memset(&args, 0, sizeof(args));
672
673 EXPECT_BEGIN(KERN_INFO,
674 "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle 12345678");
675
676 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
677 "phandle", 0, &args);
678 EXPECT_END(KERN_INFO,
679 "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle 12345678");
680
681 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
682
683 /* Check for incorrectly formed argument list */
684 memset(&args, 0, sizeof(args));
685
686 EXPECT_BEGIN(KERN_INFO,
687 "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
688
689 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
690 "phandle", 1, &args);
691 EXPECT_END(KERN_INFO,
692 "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
693
694 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
695
696 for (i = 0; i < ARRAY_SIZE(p); ++i) {
697 unittest(prefs[i] == OF_KREF_READ(p[i]),
698 "provider%d: expected:%d got:%d\n",
699 i, prefs[i], OF_KREF_READ(p[i]));
700 of_node_put(p[i]);
701 }
702}
703
704static void __init of_unittest_property_string(void)
705{
706 const char *strings[4];
707 struct device_node *np;
708 int rc;
709
710 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
711 if (!np) {
712 pr_err("No testcase data in device tree\n");
713 return;
714 }
715
716 rc = of_property_match_string(np, "phandle-list-names", "first");
717 unittest(rc == 0, "first expected:0 got:%i\n", rc);
718 rc = of_property_match_string(np, "phandle-list-names", "second");
719 unittest(rc == 1, "second expected:1 got:%i\n", rc);
720 rc = of_property_match_string(np, "phandle-list-names", "third");
721 unittest(rc == 2, "third expected:2 got:%i\n", rc);
722 rc = of_property_match_string(np, "phandle-list-names", "fourth");
723 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
724 rc = of_property_match_string(np, "missing-property", "blah");
725 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
726 rc = of_property_match_string(np, "empty-property", "blah");
727 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
728 rc = of_property_match_string(np, "unterminated-string", "blah");
729 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
730
731 /* of_property_count_strings() tests */
732 rc = of_property_count_strings(np, "string-property");
733 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
734 rc = of_property_count_strings(np, "phandle-list-names");
735 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
736 rc = of_property_count_strings(np, "unterminated-string");
737 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
738 rc = of_property_count_strings(np, "unterminated-string-list");
739 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
740
741 /* of_property_read_string_index() tests */
742 rc = of_property_read_string_index(np, "string-property", 0, strings);
743 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
744 strings[0] = NULL;
745 rc = of_property_read_string_index(np, "string-property", 1, strings);
746 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
747 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
748 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
749 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
750 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
751 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
752 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
753 strings[0] = NULL;
754 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
755 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
756 strings[0] = NULL;
757 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
758 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
759 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
760 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
761 strings[0] = NULL;
762 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
763 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
764 strings[1] = NULL;
765
766 /* of_property_read_string_array() tests */
767 rc = of_property_read_string_array(np, "string-property", strings, 4);
768 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
769 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
770 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
771 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
772 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
773 /* -- An incorrectly formed string should cause a failure */
774 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
775 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
776 /* -- parsing the correctly formed strings should still work: */
777 strings[2] = NULL;
778 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
779 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
780 strings[1] = NULL;
781 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
782 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
783}
784
785#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
786 (p1)->value && (p2)->value && \
787 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
788 !strcmp((p1)->name, (p2)->name))
789static void __init of_unittest_property_copy(void)
790{
791#ifdef CONFIG_OF_DYNAMIC
792 struct property p1 = { .name = "p1", .length = 0, .value = "" };
793 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
794 struct property *new;
795
796 new = __of_prop_dup(&p1, GFP_KERNEL);
797 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
798 __of_prop_free(new);
799
800 new = __of_prop_dup(&p2, GFP_KERNEL);
801 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
802 __of_prop_free(new);
803#endif
804}
805
806static void __init of_unittest_changeset(void)
807{
808#ifdef CONFIG_OF_DYNAMIC
809 int ret;
810 struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
811 struct property *ppname_n1, pname_n1 = { .name = "name", .length = 3, .value = "n1" };
812 struct property *ppname_n2, pname_n2 = { .name = "name", .length = 3, .value = "n2" };
813 struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
814 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
815 struct property *ppremove;
816 struct device_node *n1, *n2, *n21, *n22, *nchangeset, *nremove, *parent, *np;
817 static const char * const str_array[] = { "str1", "str2", "str3" };
818 const u32 u32_array[] = { 1, 2, 3 };
819 struct of_changeset chgset;
820 const char *propstr = NULL;
821
822 n1 = __of_node_dup(NULL, "n1");
823 unittest(n1, "testcase setup failure\n");
824
825 n2 = __of_node_dup(NULL, "n2");
826 unittest(n2, "testcase setup failure\n");
827
828 n21 = __of_node_dup(NULL, "n21");
829 unittest(n21, "testcase setup failure %p\n", n21);
830
831 nchangeset = of_find_node_by_path("/testcase-data/changeset");
832 nremove = of_get_child_by_name(nchangeset, "node-remove");
833 unittest(nremove, "testcase setup failure\n");
834
835 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
836 unittest(ppadd, "testcase setup failure\n");
837
838 ppname_n1 = __of_prop_dup(&pname_n1, GFP_KERNEL);
839 unittest(ppname_n1, "testcase setup failure\n");
840
841 ppname_n2 = __of_prop_dup(&pname_n2, GFP_KERNEL);
842 unittest(ppname_n2, "testcase setup failure\n");
843
844 ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
845 unittest(ppname_n21, "testcase setup failure\n");
846
847 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
848 unittest(ppupdate, "testcase setup failure\n");
849
850 parent = nchangeset;
851 n1->parent = parent;
852 n2->parent = parent;
853 n21->parent = n2;
854
855 ppremove = of_find_property(parent, "prop-remove", NULL);
856 unittest(ppremove, "failed to find removal prop");
857
858 of_changeset_init(&chgset);
859
860 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
861 unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
862
863 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
864 unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
865
866 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
867 unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
868
869 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
870
871 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
872 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
873 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
874 n22 = of_changeset_create_node(&chgset, n2, "n22");
875 unittest(n22, "fail create n22\n");
876 unittest(!of_changeset_add_prop_string(&chgset, n22, "prop-str", "abcd"),
877 "fail add prop prop-str");
878 unittest(!of_changeset_add_prop_string_array(&chgset, n22, "prop-str-array",
879 (const char **)str_array,
880 ARRAY_SIZE(str_array)),
881 "fail add prop prop-str-array");
882 unittest(!of_changeset_add_prop_u32_array(&chgset, n22, "prop-u32-array",
883 u32_array, ARRAY_SIZE(u32_array)),
884 "fail add prop prop-u32-array");
885
886 unittest(!of_changeset_apply(&chgset), "apply failed\n");
887
888 of_node_put(nchangeset);
889
890 /* Make sure node names are constructed correctly */
891 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
892 "'%pOF' not added\n", n21);
893 of_node_put(np);
894 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n22")),
895 "'%pOF' not added\n", n22);
896 of_node_put(np);
897
898 unittest(!of_changeset_revert(&chgset), "revert failed\n");
899
900 unittest(!of_find_node_by_path("/testcase-data/changeset/n2/n21"),
901 "'%pOF' still present after revert\n", n21);
902
903 unittest(of_property_present(parent, "prop-remove"),
904 "failed to find removed prop after revert\n");
905
906 ret = of_property_read_string(parent, "prop-update", &propstr);
907 unittest(!ret, "failed to find updated prop after revert\n");
908 if (!ret)
909 unittest(strcmp(propstr, "hello") == 0, "original value not in updated property after revert");
910
911 of_changeset_destroy(&chgset);
912
913 of_node_put(n1);
914 of_node_put(n2);
915 of_node_put(n21);
916 of_node_put(n22);
917#endif
918}
919
920static void __init __maybe_unused changeset_check_string(struct device_node *np,
921 const char *prop_name,
922 const char *expected_str)
923{
924 const char *str;
925 int ret;
926
927 ret = of_property_read_string(np, prop_name, &str);
928 if (unittest(ret == 0, "failed to read %s\n", prop_name))
929 return;
930
931 unittest(strcmp(str, expected_str) == 0,
932 "%s value mismatch (read '%s', exp '%s')\n",
933 prop_name, str, expected_str);
934}
935
936static void __init __maybe_unused changeset_check_string_array(struct device_node *np,
937 const char *prop_name,
938 const char * const *expected_array,
939 unsigned int count)
940{
941 const char *str;
942 unsigned int i;
943 int ret;
944 int cnt;
945
946 cnt = of_property_count_strings(np, prop_name);
947 if (unittest(cnt >= 0, "failed to get %s count\n", prop_name))
948 return;
949
950 if (unittest(cnt == count,
951 "%s count mismatch (read %d, exp %u)\n",
952 prop_name, cnt, count))
953 return;
954
955 for (i = 0; i < count; i++) {
956 ret = of_property_read_string_index(np, prop_name, i, &str);
957 if (unittest(ret == 0, "failed to read %s[%d]\n", prop_name, i))
958 continue;
959
960 unittest(strcmp(str, expected_array[i]) == 0,
961 "%s[%d] value mismatch (read '%s', exp '%s')\n",
962 prop_name, i, str, expected_array[i]);
963 }
964}
965
966static void __init __maybe_unused changeset_check_u32(struct device_node *np,
967 const char *prop_name,
968 u32 expected_u32)
969{
970 u32 val32;
971 int ret;
972
973 ret = of_property_read_u32(np, prop_name, &val32);
974 if (unittest(ret == 0, "failed to read %s\n", prop_name))
975 return;
976
977 unittest(val32 == expected_u32,
978 "%s value mismatch (read '%u', exp '%u')\n",
979 prop_name, val32, expected_u32);
980}
981
982static void __init __maybe_unused changeset_check_u32_array(struct device_node *np,
983 const char *prop_name,
984 const u32 *expected_array,
985 unsigned int count)
986{
987 unsigned int i;
988 u32 val32;
989 int ret;
990 int cnt;
991
992 cnt = of_property_count_u32_elems(np, prop_name);
993 if (unittest(cnt >= 0, "failed to get %s count\n", prop_name))
994 return;
995
996 if (unittest(cnt == count,
997 "%s count mismatch (read %d, exp %u)\n",
998 prop_name, cnt, count))
999 return;
1000
1001 for (i = 0; i < count; i++) {
1002 ret = of_property_read_u32_index(np, prop_name, i, &val32);
1003 if (unittest(ret == 0, "failed to read %s[%d]\n", prop_name, i))
1004 continue;
1005
1006 unittest(val32 == expected_array[i],
1007 "%s[%d] value mismatch (read '%u', exp '%u')\n",
1008 prop_name, i, val32, expected_array[i]);
1009 }
1010}
1011
1012static void __init __maybe_unused changeset_check_bool(struct device_node *np,
1013 const char *prop_name)
1014{
1015 unittest(of_property_read_bool(np, prop_name),
1016 "%s value mismatch (read 'false', exp 'true')\n", prop_name);
1017}
1018
1019static void __init of_unittest_changeset_prop(void)
1020{
1021#ifdef CONFIG_OF_DYNAMIC
1022 static const char * const str_array[] = { "abc", "defg", "hij" };
1023 static const u32 u32_array[] = { 123, 4567, 89, 10, 11 };
1024 struct device_node *nchangeset, *np;
1025 struct of_changeset chgset;
1026 int ret;
1027
1028 nchangeset = of_find_node_by_path("/testcase-data/changeset");
1029 if (!nchangeset) {
1030 pr_err("missing testcase data\n");
1031 return;
1032 }
1033
1034 of_changeset_init(&chgset);
1035
1036 np = of_changeset_create_node(&chgset, nchangeset, "test-prop");
1037 if (unittest(np, "failed to create test-prop node\n"))
1038 goto end_changeset_destroy;
1039
1040 ret = of_changeset_add_prop_string(&chgset, np, "prop-string", "abcde");
1041 unittest(ret == 0, "failed to add prop-string\n");
1042
1043 ret = of_changeset_add_prop_string_array(&chgset, np, "prop-string-array",
1044 str_array, ARRAY_SIZE(str_array));
1045 unittest(ret == 0, "failed to add prop-string-array\n");
1046
1047 ret = of_changeset_add_prop_u32(&chgset, np, "prop-u32", 1234);
1048 unittest(ret == 0, "failed to add prop-u32\n");
1049
1050 ret = of_changeset_add_prop_u32_array(&chgset, np, "prop-u32-array",
1051 u32_array, ARRAY_SIZE(u32_array));
1052 unittest(ret == 0, "failed to add prop-u32-array\n");
1053
1054 ret = of_changeset_add_prop_bool(&chgset, np, "prop-bool");
1055 unittest(ret == 0, "failed to add prop-bool\n");
1056
1057 of_node_put(np);
1058
1059 ret = of_changeset_apply(&chgset);
1060 if (unittest(ret == 0, "failed to apply changeset\n"))
1061 goto end_changeset_destroy;
1062
1063 np = of_find_node_by_path("/testcase-data/changeset/test-prop");
1064 if (unittest(np, "failed to find test-prop node\n"))
1065 goto end_revert_changeset;
1066
1067 changeset_check_string(np, "prop-string", "abcde");
1068 changeset_check_string_array(np, "prop-string-array", str_array, ARRAY_SIZE(str_array));
1069 changeset_check_u32(np, "prop-u32", 1234);
1070 changeset_check_u32_array(np, "prop-u32-array", u32_array, ARRAY_SIZE(u32_array));
1071 changeset_check_bool(np, "prop-bool");
1072
1073 of_node_put(np);
1074
1075end_revert_changeset:
1076 ret = of_changeset_revert(&chgset);
1077 unittest(ret == 0, "failed to revert changeset\n");
1078
1079end_changeset_destroy:
1080 of_changeset_destroy(&chgset);
1081 of_node_put(nchangeset);
1082#endif
1083}
1084
1085static void __init of_unittest_dma_get_max_cpu_address(void)
1086{
1087 struct device_node *np;
1088 phys_addr_t cpu_addr;
1089
1090 if (!IS_ENABLED(CONFIG_OF_ADDRESS))
1091 return;
1092
1093 np = of_find_node_by_path("/testcase-data/address-tests");
1094 if (!np) {
1095 pr_err("missing testcase data\n");
1096 return;
1097 }
1098
1099 cpu_addr = of_dma_get_max_cpu_address(np);
1100 unittest(cpu_addr == 0x4fffffff,
1101 "of_dma_get_max_cpu_address: wrong CPU addr %pad (expecting %x)\n",
1102 &cpu_addr, 0x4fffffff);
1103}
1104
1105static void __init of_unittest_dma_ranges_one(const char *path,
1106 u64 expect_dma_addr, u64 expect_paddr)
1107{
1108#ifdef CONFIG_HAS_DMA
1109 struct device_node *np;
1110 const struct bus_dma_region *map = NULL;
1111 int rc;
1112
1113 np = of_find_node_by_path(path);
1114 if (!np) {
1115 pr_err("missing testcase data\n");
1116 return;
1117 }
1118
1119 rc = of_dma_get_range(np, &map);
1120
1121 unittest(!rc, "of_dma_get_range failed on node %pOF rc=%i\n", np, rc);
1122
1123 if (!rc) {
1124 phys_addr_t paddr;
1125 dma_addr_t dma_addr;
1126 struct device *dev_bogus;
1127
1128 dev_bogus = kzalloc(sizeof(struct device), GFP_KERNEL);
1129 if (!dev_bogus) {
1130 unittest(0, "kzalloc() failed\n");
1131 kfree(map);
1132 return;
1133 }
1134
1135 dev_bogus->dma_range_map = map;
1136 paddr = dma_to_phys(dev_bogus, expect_dma_addr);
1137 dma_addr = phys_to_dma(dev_bogus, expect_paddr);
1138
1139 unittest(paddr == expect_paddr,
1140 "of_dma_get_range: wrong phys addr %pap (expecting %llx) on node %pOF\n",
1141 &paddr, expect_paddr, np);
1142 unittest(dma_addr == expect_dma_addr,
1143 "of_dma_get_range: wrong DMA addr %pad (expecting %llx) on node %pOF\n",
1144 &dma_addr, expect_dma_addr, np);
1145
1146 kfree(map);
1147 kfree(dev_bogus);
1148 }
1149 of_node_put(np);
1150#endif
1151}
1152
1153static void __init of_unittest_parse_dma_ranges(void)
1154{
1155 of_unittest_dma_ranges_one("/testcase-data/address-tests/device@70000000",
1156 0x0, 0x20000000);
1157 if (IS_ENABLED(CONFIG_ARCH_DMA_ADDR_T_64BIT))
1158 of_unittest_dma_ranges_one("/testcase-data/address-tests/bus@80000000/device@1000",
1159 0x100000000, 0x20000000);
1160 of_unittest_dma_ranges_one("/testcase-data/address-tests/pci@90000000",
1161 0x80000000, 0x20000000);
1162}
1163
1164static void __init of_unittest_pci_dma_ranges(void)
1165{
1166 struct device_node *np;
1167 struct of_pci_range range;
1168 struct of_pci_range_parser parser;
1169 int i = 0;
1170
1171 if (!IS_ENABLED(CONFIG_PCI))
1172 return;
1173
1174 np = of_find_node_by_path("/testcase-data/address-tests/pci@90000000");
1175 if (!np) {
1176 pr_err("missing testcase data\n");
1177 return;
1178 }
1179
1180 if (of_pci_dma_range_parser_init(&parser, np)) {
1181 pr_err("missing dma-ranges property\n");
1182 return;
1183 }
1184
1185 /*
1186 * Get the dma-ranges from the device tree
1187 */
1188 for_each_of_pci_range(&parser, &range) {
1189 if (!i) {
1190 unittest(range.size == 0x10000000,
1191 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
1192 np, range.size);
1193 unittest(range.cpu_addr == 0x20000000,
1194 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
1195 range.cpu_addr, np);
1196 unittest(range.pci_addr == 0x80000000,
1197 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1198 range.pci_addr, np);
1199 } else {
1200 unittest(range.size == 0x10000000,
1201 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
1202 np, range.size);
1203 unittest(range.cpu_addr == 0x40000000,
1204 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
1205 range.cpu_addr, np);
1206 unittest(range.pci_addr == 0xc0000000,
1207 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1208 range.pci_addr, np);
1209 }
1210 i++;
1211 }
1212
1213 of_node_put(np);
1214}
1215
1216static void __init of_unittest_pci_empty_dma_ranges(void)
1217{
1218 struct device_node *np;
1219 struct of_pci_range range;
1220 struct of_pci_range_parser parser;
1221
1222 if (!IS_ENABLED(CONFIG_PCI))
1223 return;
1224
1225 np = of_find_node_by_path("/testcase-data/address-tests2/pcie@d1070000/pci@0,0/dev@0,0/local-bus@0");
1226 if (!np) {
1227 pr_err("missing testcase data\n");
1228 return;
1229 }
1230
1231 if (of_pci_dma_range_parser_init(&parser, np)) {
1232 pr_err("missing dma-ranges property\n");
1233 return;
1234 }
1235
1236 /*
1237 * Get the dma-ranges from the device tree
1238 */
1239 for_each_of_pci_range(&parser, &range) {
1240 unittest(range.size == 0x10000000,
1241 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
1242 np, range.size);
1243 unittest(range.cpu_addr == 0x00000000,
1244 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
1245 range.cpu_addr, np);
1246 unittest(range.pci_addr == 0xc0000000,
1247 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1248 range.pci_addr, np);
1249 }
1250
1251 of_node_put(np);
1252}
1253
1254static void __init of_unittest_bus_ranges(void)
1255{
1256 struct device_node *np;
1257 struct of_range range;
1258 struct of_range_parser parser;
1259 struct resource res;
1260 int ret, count, i = 0;
1261
1262 np = of_find_node_by_path("/testcase-data/address-tests");
1263 if (!np) {
1264 pr_err("missing testcase data\n");
1265 return;
1266 }
1267
1268 if (of_range_parser_init(&parser, np)) {
1269 pr_err("missing ranges property\n");
1270 return;
1271 }
1272
1273 ret = of_range_to_resource(np, 1, &res);
1274 unittest(!ret, "of_range_to_resource returned error (%d) node %pOF\n",
1275 ret, np);
1276 unittest(resource_type(&res) == IORESOURCE_MEM,
1277 "of_range_to_resource wrong resource type on node %pOF res=%pR\n",
1278 np, &res);
1279 unittest(res.start == 0xd0000000,
1280 "of_range_to_resource wrong resource start address on node %pOF res=%pR\n",
1281 np, &res);
1282 unittest(resource_size(&res) == 0x20000000,
1283 "of_range_to_resource wrong resource start address on node %pOF res=%pR\n",
1284 np, &res);
1285
1286 count = of_range_count(&parser);
1287 unittest(count == 2,
1288 "of_range_count wrong size on node %pOF count=%d\n",
1289 np, count);
1290
1291 /*
1292 * Get the "ranges" from the device tree
1293 */
1294 for_each_of_range(&parser, &range) {
1295 unittest(range.flags == IORESOURCE_MEM,
1296 "for_each_of_range wrong flags on node %pOF flags=%x (expected %x)\n",
1297 np, range.flags, IORESOURCE_MEM);
1298 if (!i) {
1299 unittest(range.size == 0x50000000,
1300 "for_each_of_range wrong size on node %pOF size=%llx\n",
1301 np, range.size);
1302 unittest(range.cpu_addr == 0x70000000,
1303 "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1304 range.cpu_addr, np);
1305 unittest(range.bus_addr == 0x70000000,
1306 "for_each_of_range wrong bus addr (%llx) on node %pOF",
1307 range.pci_addr, np);
1308 } else {
1309 unittest(range.size == 0x20000000,
1310 "for_each_of_range wrong size on node %pOF size=%llx\n",
1311 np, range.size);
1312 unittest(range.cpu_addr == 0xd0000000,
1313 "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1314 range.cpu_addr, np);
1315 unittest(range.bus_addr == 0x00000000,
1316 "for_each_of_range wrong bus addr (%llx) on node %pOF",
1317 range.pci_addr, np);
1318 }
1319 i++;
1320 }
1321
1322 of_node_put(np);
1323}
1324
1325static void __init of_unittest_bus_3cell_ranges(void)
1326{
1327 struct device_node *np;
1328 struct of_range range;
1329 struct of_range_parser parser;
1330 int i = 0;
1331
1332 np = of_find_node_by_path("/testcase-data/address-tests/bus@a0000000");
1333 if (!np) {
1334 pr_err("missing testcase data\n");
1335 return;
1336 }
1337
1338 if (of_range_parser_init(&parser, np)) {
1339 pr_err("missing ranges property\n");
1340 return;
1341 }
1342
1343 /*
1344 * Get the "ranges" from the device tree
1345 */
1346 for_each_of_range(&parser, &range) {
1347 if (!i) {
1348 unittest(range.flags == 0xf00baa,
1349 "for_each_of_range wrong flags on node %pOF flags=%x\n",
1350 np, range.flags);
1351 unittest(range.size == 0x100000,
1352 "for_each_of_range wrong size on node %pOF size=%llx\n",
1353 np, range.size);
1354 unittest(range.cpu_addr == 0xa0000000,
1355 "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1356 range.cpu_addr, np);
1357 unittest(range.bus_addr == 0x0,
1358 "for_each_of_range wrong bus addr (%llx) on node %pOF",
1359 range.pci_addr, np);
1360 } else {
1361 unittest(range.flags == 0xf00bee,
1362 "for_each_of_range wrong flags on node %pOF flags=%x\n",
1363 np, range.flags);
1364 unittest(range.size == 0x200000,
1365 "for_each_of_range wrong size on node %pOF size=%llx\n",
1366 np, range.size);
1367 unittest(range.cpu_addr == 0xb0000000,
1368 "for_each_of_range wrong CPU addr (%llx) on node %pOF",
1369 range.cpu_addr, np);
1370 unittest(range.bus_addr == 0x100000000,
1371 "for_each_of_range wrong bus addr (%llx) on node %pOF",
1372 range.pci_addr, np);
1373 }
1374 i++;
1375 }
1376
1377 of_node_put(np);
1378}
1379
1380static void __init of_unittest_reg(void)
1381{
1382 struct device_node *np;
1383 struct resource res;
1384 int ret;
1385 u64 addr, size;
1386
1387 np = of_find_node_by_path("/testcase-data/address-tests/bus@80000000/device@1000");
1388 if (!np) {
1389 pr_err("missing testcase data\n");
1390 return;
1391 }
1392
1393 ret = of_property_read_reg(np, 0, &addr, &size);
1394 unittest(!ret, "of_property_read_reg(%pOF) returned error %d\n",
1395 np, ret);
1396 unittest(addr == 0x1000, "of_property_read_reg(%pOF) untranslated address (%llx) incorrect\n",
1397 np, addr);
1398
1399 of_node_put(np);
1400
1401 np = of_find_node_by_path("/testcase-data/platform-tests-2/node/test-device@100");
1402 if (!np) {
1403 pr_err("missing testcase data\n");
1404 return;
1405 }
1406
1407 ret = of_address_to_resource(np, 0, &res);
1408 unittest(ret == -EINVAL, "of_address_to_resource(%pOF) expected error on untranslatable address\n",
1409 np);
1410
1411 of_node_put(np);
1412
1413}
1414
1415struct of_unittest_expected_res {
1416 int index;
1417 struct resource res;
1418};
1419
1420static void __init of_unittest_check_addr(const char *node_path,
1421 const struct of_unittest_expected_res *tab_exp,
1422 unsigned int tab_exp_count)
1423{
1424 const struct of_unittest_expected_res *expected;
1425 struct device_node *np;
1426 struct resource res;
1427 unsigned int count;
1428 int ret;
1429
1430 if (!IS_ENABLED(CONFIG_OF_ADDRESS))
1431 return;
1432
1433 np = of_find_node_by_path(node_path);
1434 if (!np) {
1435 pr_err("missing testcase data (%s)\n", node_path);
1436 return;
1437 }
1438
1439 expected = tab_exp;
1440 count = tab_exp_count;
1441 while (count--) {
1442 ret = of_address_to_resource(np, expected->index, &res);
1443 unittest(!ret, "of_address_to_resource(%pOF, %d) returned error %d\n",
1444 np, expected->index, ret);
1445 unittest(resource_type(&res) == resource_type(&expected->res) &&
1446 res.start == expected->res.start &&
1447 resource_size(&res) == resource_size(&expected->res),
1448 "of_address_to_resource(%pOF, %d) wrong resource %pR, expected %pR\n",
1449 np, expected->index, &res, &expected->res);
1450 expected++;
1451 }
1452
1453 of_node_put(np);
1454}
1455
1456static const struct of_unittest_expected_res of_unittest_reg_2cell_expected_res[] = {
1457 {.index = 0, .res = DEFINE_RES_MEM(0xa0a01000, 0x100) },
1458 {.index = 1, .res = DEFINE_RES_MEM(0xa0a02000, 0x100) },
1459 {.index = 2, .res = DEFINE_RES_MEM(0xc0c01000, 0x100) },
1460 {.index = 3, .res = DEFINE_RES_MEM(0xd0d01000, 0x100) },
1461};
1462
1463static const struct of_unittest_expected_res of_unittest_reg_3cell_expected_res[] = {
1464 {.index = 0, .res = DEFINE_RES_MEM(0xa0a01000, 0x100) },
1465 {.index = 1, .res = DEFINE_RES_MEM(0xa0b02000, 0x100) },
1466 {.index = 2, .res = DEFINE_RES_MEM(0xc0c01000, 0x100) },
1467 {.index = 3, .res = DEFINE_RES_MEM(0xc0c09000, 0x100) },
1468 {.index = 4, .res = DEFINE_RES_MEM(0xd0d01000, 0x100) },
1469};
1470
1471static const struct of_unittest_expected_res of_unittest_reg_pci_expected_res[] = {
1472 {.index = 0, .res = DEFINE_RES_MEM(0xe8001000, 0x1000) },
1473 {.index = 1, .res = DEFINE_RES_MEM(0xea002000, 0x2000) },
1474};
1475
1476static void __init of_unittest_translate_addr(void)
1477{
1478 of_unittest_check_addr("/testcase-data/address-tests2/bus-2cell@10000000/device@100000",
1479 of_unittest_reg_2cell_expected_res,
1480 ARRAY_SIZE(of_unittest_reg_2cell_expected_res));
1481
1482 of_unittest_check_addr("/testcase-data/address-tests2/bus-3cell@20000000/local-bus@100000/device@f1001000",
1483 of_unittest_reg_3cell_expected_res,
1484 ARRAY_SIZE(of_unittest_reg_3cell_expected_res));
1485
1486 of_unittest_check_addr("/testcase-data/address-tests2/pcie@d1070000/pci@0,0/dev@0,0/local-bus@0/dev@e0000000",
1487 of_unittest_reg_pci_expected_res,
1488 ARRAY_SIZE(of_unittest_reg_pci_expected_res));
1489}
1490
1491static void __init of_unittest_parse_interrupts(void)
1492{
1493 struct device_node *np;
1494 struct of_phandle_args args;
1495 int i, rc;
1496
1497 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1498 return;
1499
1500 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
1501 if (!np) {
1502 pr_err("missing testcase data\n");
1503 return;
1504 }
1505
1506 for (i = 0; i < 4; i++) {
1507 bool passed = true;
1508
1509 memset(&args, 0, sizeof(args));
1510 rc = of_irq_parse_one(np, i, &args);
1511
1512 passed &= !rc;
1513 passed &= (args.args_count == 1);
1514 passed &= (args.args[0] == (i + 1));
1515
1516 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1517 i, args.np, rc);
1518 }
1519 of_node_put(np);
1520
1521 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
1522 if (!np) {
1523 pr_err("missing testcase data\n");
1524 return;
1525 }
1526
1527 for (i = 0; i < 4; i++) {
1528 bool passed = true;
1529
1530 memset(&args, 0, sizeof(args));
1531 rc = of_irq_parse_one(np, i, &args);
1532
1533 /* Test the values from tests-phandle.dtsi */
1534 switch (i) {
1535 case 0:
1536 passed &= !rc;
1537 passed &= (args.args_count == 1);
1538 passed &= (args.args[0] == 9);
1539 break;
1540 case 1:
1541 passed &= !rc;
1542 passed &= (args.args_count == 3);
1543 passed &= (args.args[0] == 10);
1544 passed &= (args.args[1] == 11);
1545 passed &= (args.args[2] == 12);
1546 break;
1547 case 2:
1548 passed &= !rc;
1549 passed &= (args.args_count == 2);
1550 passed &= (args.args[0] == 13);
1551 passed &= (args.args[1] == 14);
1552 break;
1553 case 3:
1554 passed &= !rc;
1555 passed &= (args.args_count == 2);
1556 passed &= (args.args[0] == 15);
1557 passed &= (args.args[1] == 16);
1558 break;
1559 default:
1560 passed = false;
1561 }
1562 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1563 i, args.np, rc);
1564 }
1565 of_node_put(np);
1566}
1567
1568static void __init of_unittest_parse_interrupts_extended(void)
1569{
1570 struct device_node *np;
1571 struct of_phandle_args args;
1572 int i, rc;
1573
1574 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1575 return;
1576
1577 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
1578 if (!np) {
1579 pr_err("missing testcase data\n");
1580 return;
1581 }
1582
1583 for (i = 0; i < 7; i++) {
1584 bool passed = true;
1585
1586 memset(&args, 0, sizeof(args));
1587 rc = of_irq_parse_one(np, i, &args);
1588
1589 /* Test the values from tests-phandle.dtsi */
1590 switch (i) {
1591 case 0:
1592 passed &= !rc;
1593 passed &= (args.args_count == 1);
1594 passed &= (args.args[0] == 1);
1595 break;
1596 case 1:
1597 passed &= !rc;
1598 passed &= (args.args_count == 3);
1599 passed &= (args.args[0] == 2);
1600 passed &= (args.args[1] == 3);
1601 passed &= (args.args[2] == 4);
1602 break;
1603 case 2:
1604 passed &= !rc;
1605 passed &= (args.args_count == 2);
1606 passed &= (args.args[0] == 5);
1607 passed &= (args.args[1] == 6);
1608 break;
1609 case 3:
1610 passed &= !rc;
1611 passed &= (args.args_count == 1);
1612 passed &= (args.args[0] == 9);
1613 break;
1614 case 4:
1615 passed &= !rc;
1616 passed &= (args.args_count == 3);
1617 passed &= (args.args[0] == 10);
1618 passed &= (args.args[1] == 11);
1619 passed &= (args.args[2] == 12);
1620 break;
1621 case 5:
1622 passed &= !rc;
1623 passed &= (args.args_count == 2);
1624 passed &= (args.args[0] == 13);
1625 passed &= (args.args[1] == 14);
1626 break;
1627 case 6:
1628 /*
1629 * Tests child node that is missing property
1630 * #address-cells. See the comments in
1631 * drivers/of/unittest-data/tests-interrupts.dtsi
1632 * nodes intmap1 and interrupts-extended0
1633 */
1634 passed &= !rc;
1635 passed &= (args.args_count == 1);
1636 passed &= (args.args[0] == 15);
1637 break;
1638 default:
1639 passed = false;
1640 }
1641
1642 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1643 i, args.np, rc);
1644 }
1645 of_node_put(np);
1646}
1647
1648static const struct of_device_id match_node_table[] = {
1649 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
1650 { .data = "B", .type = "type1", }, /* followed by type alone */
1651
1652 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
1653 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
1654 { .data = "Cc", .name = "name2", .type = "type2", },
1655
1656 { .data = "E", .compatible = "compat3" },
1657 { .data = "G", .compatible = "compat2", },
1658 { .data = "H", .compatible = "compat2", .name = "name5", },
1659 { .data = "I", .compatible = "compat2", .type = "type1", },
1660 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
1661 { .data = "K", .compatible = "compat2", .name = "name9", },
1662 {}
1663};
1664
1665static struct {
1666 const char *path;
1667 const char *data;
1668} match_node_tests[] = {
1669 { .path = "/testcase-data/match-node/name0", .data = "A", },
1670 { .path = "/testcase-data/match-node/name1", .data = "B", },
1671 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
1672 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
1673 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
1674 { .path = "/testcase-data/match-node/name3", .data = "E", },
1675 { .path = "/testcase-data/match-node/name4", .data = "G", },
1676 { .path = "/testcase-data/match-node/name5", .data = "H", },
1677 { .path = "/testcase-data/match-node/name6", .data = "G", },
1678 { .path = "/testcase-data/match-node/name7", .data = "I", },
1679 { .path = "/testcase-data/match-node/name8", .data = "J", },
1680 { .path = "/testcase-data/match-node/name9", .data = "K", },
1681};
1682
1683static void __init of_unittest_match_node(void)
1684{
1685 struct device_node *np;
1686 const struct of_device_id *match;
1687 int i;
1688
1689 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
1690 np = of_find_node_by_path(match_node_tests[i].path);
1691 if (!np) {
1692 unittest(0, "missing testcase node %s\n",
1693 match_node_tests[i].path);
1694 continue;
1695 }
1696
1697 match = of_match_node(match_node_table, np);
1698 if (!match) {
1699 unittest(0, "%s didn't match anything\n",
1700 match_node_tests[i].path);
1701 continue;
1702 }
1703
1704 if (strcmp(match->data, match_node_tests[i].data) != 0) {
1705 unittest(0, "%s got wrong match. expected %s, got %s\n",
1706 match_node_tests[i].path, match_node_tests[i].data,
1707 (const char *)match->data);
1708 continue;
1709 }
1710 unittest(1, "passed");
1711 }
1712}
1713
1714static struct resource test_bus_res = DEFINE_RES_MEM(0xfffffff8, 2);
1715static const struct platform_device_info test_bus_info = {
1716 .name = "unittest-bus",
1717};
1718static void __init of_unittest_platform_populate(void)
1719{
1720 int irq, rc;
1721 struct device_node *np, *child, *grandchild;
1722 struct platform_device *pdev, *test_bus;
1723 const struct of_device_id match[] = {
1724 { .compatible = "test-device", },
1725 {}
1726 };
1727
1728 np = of_find_node_by_path("/testcase-data");
1729 of_platform_default_populate(np, NULL, NULL);
1730
1731 /* Test that a missing irq domain returns -EPROBE_DEFER */
1732 np = of_find_node_by_path("/testcase-data/testcase-device1");
1733 pdev = of_find_device_by_node(np);
1734 unittest(pdev, "device 1 creation failed\n");
1735
1736 if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1737 irq = platform_get_irq(pdev, 0);
1738 unittest(irq == -EPROBE_DEFER,
1739 "device deferred probe failed - %d\n", irq);
1740
1741 /* Test that a parsing failure does not return -EPROBE_DEFER */
1742 np = of_find_node_by_path("/testcase-data/testcase-device2");
1743 pdev = of_find_device_by_node(np);
1744 unittest(pdev, "device 2 creation failed\n");
1745
1746 EXPECT_BEGIN(KERN_INFO,
1747 "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1748
1749 irq = platform_get_irq(pdev, 0);
1750
1751 EXPECT_END(KERN_INFO,
1752 "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1753
1754 unittest(irq < 0 && irq != -EPROBE_DEFER,
1755 "device parsing error failed - %d\n", irq);
1756 }
1757
1758 np = of_find_node_by_path("/testcase-data/platform-tests");
1759 unittest(np, "No testcase data in device tree\n");
1760 if (!np)
1761 return;
1762
1763 test_bus = platform_device_register_full(&test_bus_info);
1764 rc = PTR_ERR_OR_ZERO(test_bus);
1765 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1766 if (rc) {
1767 of_node_put(np);
1768 return;
1769 }
1770 test_bus->dev.of_node = np;
1771
1772 /*
1773 * Add a dummy resource to the test bus node after it is
1774 * registered to catch problems with un-inserted resources. The
1775 * DT code doesn't insert the resources, and it has caused the
1776 * kernel to oops in the past. This makes sure the same bug
1777 * doesn't crop up again.
1778 */
1779 platform_device_add_resources(test_bus, &test_bus_res, 1);
1780
1781 of_platform_populate(np, match, NULL, &test_bus->dev);
1782 for_each_child_of_node(np, child) {
1783 for_each_child_of_node(child, grandchild) {
1784 pdev = of_find_device_by_node(grandchild);
1785 unittest(pdev,
1786 "Could not create device for node '%pOFn'\n",
1787 grandchild);
1788 platform_device_put(pdev);
1789 }
1790 }
1791
1792 of_platform_depopulate(&test_bus->dev);
1793 for_each_child_of_node(np, child) {
1794 for_each_child_of_node(child, grandchild)
1795 unittest(!of_find_device_by_node(grandchild),
1796 "device didn't get destroyed '%pOFn'\n",
1797 grandchild);
1798 }
1799
1800 platform_device_unregister(test_bus);
1801 of_node_put(np);
1802}
1803
1804/**
1805 * update_node_properties - adds the properties
1806 * of np into dup node (present in live tree) and
1807 * updates parent of children of np to dup.
1808 *
1809 * @np: node whose properties are being added to the live tree
1810 * @dup: node present in live tree to be updated
1811 */
1812static void update_node_properties(struct device_node *np,
1813 struct device_node *dup)
1814{
1815 struct property *prop;
1816 struct property *save_next;
1817 struct device_node *child;
1818 int ret;
1819
1820 for_each_child_of_node(np, child)
1821 child->parent = dup;
1822
1823 /*
1824 * "unittest internal error: unable to add testdata property"
1825 *
1826 * If this message reports a property in node '/__symbols__' then
1827 * the respective unittest overlay contains a label that has the
1828 * same name as a label in the live devicetree. The label will
1829 * be in the live devicetree only if the devicetree source was
1830 * compiled with the '-@' option. If you encounter this error,
1831 * please consider renaming __all__ of the labels in the unittest
1832 * overlay dts files with an odd prefix that is unlikely to be
1833 * used in a real devicetree.
1834 */
1835
1836 /*
1837 * open code for_each_property_of_node() because of_add_property()
1838 * sets prop->next to NULL
1839 */
1840 for (prop = np->properties; prop != NULL; prop = save_next) {
1841 save_next = prop->next;
1842 ret = of_add_property(dup, prop);
1843 if (ret) {
1844 if (ret == -EEXIST && !strcmp(prop->name, "name"))
1845 continue;
1846 pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1847 np, prop->name);
1848 }
1849 }
1850}
1851
1852/**
1853 * attach_node_and_children - attaches nodes
1854 * and its children to live tree.
1855 * CAUTION: misleading function name - if node @np already exists in
1856 * the live tree then children of @np are *not* attached to the live
1857 * tree. This works for the current test devicetree nodes because such
1858 * nodes do not have child nodes.
1859 *
1860 * @np: Node to attach to live tree
1861 */
1862static void attach_node_and_children(struct device_node *np)
1863{
1864 struct device_node *next, *dup, *child;
1865 unsigned long flags;
1866 const char *full_name;
1867
1868 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1869 if (!full_name)
1870 return;
1871
1872 if (!strcmp(full_name, "/__local_fixups__") ||
1873 !strcmp(full_name, "/__fixups__")) {
1874 kfree(full_name);
1875 return;
1876 }
1877
1878 dup = of_find_node_by_path(full_name);
1879 kfree(full_name);
1880 if (dup) {
1881 update_node_properties(np, dup);
1882 return;
1883 }
1884
1885 child = np->child;
1886 np->child = NULL;
1887
1888 mutex_lock(&of_mutex);
1889 raw_spin_lock_irqsave(&devtree_lock, flags);
1890 np->sibling = np->parent->child;
1891 np->parent->child = np;
1892 of_node_clear_flag(np, OF_DETACHED);
1893 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1894
1895 __of_attach_node_sysfs(np);
1896 mutex_unlock(&of_mutex);
1897
1898 while (child) {
1899 next = child->sibling;
1900 attach_node_and_children(child);
1901 child = next;
1902 }
1903}
1904
1905/**
1906 * unittest_data_add - Reads, copies data from
1907 * linked tree and attaches it to the live tree
1908 */
1909static int __init unittest_data_add(void)
1910{
1911 void *unittest_data;
1912 void *unittest_data_align;
1913 struct device_node *unittest_data_node = NULL, *np;
1914 /*
1915 * __dtbo_testcases_begin[] and __dtbo_testcases_end[] are magically
1916 * created by cmd_wrap_S_dtbo in scripts/Makefile.dtbs
1917 */
1918 extern uint8_t __dtbo_testcases_begin[];
1919 extern uint8_t __dtbo_testcases_end[];
1920 const int size = __dtbo_testcases_end - __dtbo_testcases_begin;
1921 int rc;
1922 void *ret;
1923
1924 if (!size) {
1925 pr_warn("%s: testcases is empty\n", __func__);
1926 return -ENODATA;
1927 }
1928
1929 /* creating copy */
1930 unittest_data = kmalloc(size + FDT_ALIGN_SIZE, GFP_KERNEL);
1931 if (!unittest_data)
1932 return -ENOMEM;
1933
1934 unittest_data_align = PTR_ALIGN(unittest_data, FDT_ALIGN_SIZE);
1935 memcpy(unittest_data_align, __dtbo_testcases_begin, size);
1936
1937 ret = of_fdt_unflatten_tree(unittest_data_align, NULL, &unittest_data_node);
1938 if (!ret) {
1939 pr_warn("%s: unflatten testcases tree failed\n", __func__);
1940 kfree(unittest_data);
1941 return -ENODATA;
1942 }
1943 if (!unittest_data_node) {
1944 pr_warn("%s: testcases tree is empty\n", __func__);
1945 kfree(unittest_data);
1946 return -ENODATA;
1947 }
1948
1949 /*
1950 * This lock normally encloses of_resolve_phandles()
1951 */
1952 of_overlay_mutex_lock();
1953
1954 rc = of_resolve_phandles(unittest_data_node);
1955 if (rc) {
1956 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1957 of_overlay_mutex_unlock();
1958 return -EINVAL;
1959 }
1960
1961 /* attach the sub-tree to live tree */
1962 if (!of_root) {
1963 pr_warn("%s: no live tree to attach sub-tree\n", __func__);
1964 kfree(unittest_data);
1965 return -ENODEV;
1966 }
1967
1968 EXPECT_BEGIN(KERN_INFO,
1969 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1970
1971 np = unittest_data_node->child;
1972 while (np) {
1973 struct device_node *next = np->sibling;
1974
1975 np->parent = of_root;
1976 /* this will clear OF_DETACHED in np and children */
1977 attach_node_and_children(np);
1978 np = next;
1979 }
1980
1981 EXPECT_END(KERN_INFO,
1982 "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1983
1984 of_overlay_mutex_unlock();
1985
1986 return 0;
1987}
1988
1989#ifdef CONFIG_OF_OVERLAY
1990static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id);
1991
1992static int unittest_probe(struct platform_device *pdev)
1993{
1994 struct device *dev = &pdev->dev;
1995 struct device_node *np = dev->of_node;
1996
1997 if (np == NULL) {
1998 dev_err(dev, "No OF data for device\n");
1999 return -EINVAL;
2000
2001 }
2002
2003 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2004
2005 of_platform_populate(np, NULL, NULL, &pdev->dev);
2006
2007 return 0;
2008}
2009
2010static void unittest_remove(struct platform_device *pdev)
2011{
2012 struct device *dev = &pdev->dev;
2013 struct device_node *np = dev->of_node;
2014
2015 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2016}
2017
2018static const struct of_device_id unittest_match[] = {
2019 { .compatible = "unittest", },
2020 {},
2021};
2022
2023static struct platform_driver unittest_driver = {
2024 .probe = unittest_probe,
2025 .remove = unittest_remove,
2026 .driver = {
2027 .name = "unittest",
2028 .of_match_table = unittest_match,
2029 },
2030};
2031
2032/* get the platform device instantiated at the path */
2033static struct platform_device *of_path_to_platform_device(const char *path)
2034{
2035 struct device_node *np;
2036 struct platform_device *pdev;
2037
2038 np = of_find_node_by_path(path);
2039 if (np == NULL)
2040 return NULL;
2041
2042 pdev = of_find_device_by_node(np);
2043 of_node_put(np);
2044
2045 return pdev;
2046}
2047
2048/* find out if a platform device exists at that path */
2049static int of_path_platform_device_exists(const char *path)
2050{
2051 struct platform_device *pdev;
2052
2053 pdev = of_path_to_platform_device(path);
2054 platform_device_put(pdev);
2055 return pdev != NULL;
2056}
2057
2058#ifdef CONFIG_OF_GPIO
2059
2060struct unittest_gpio_dev {
2061 struct gpio_chip chip;
2062};
2063
2064static int unittest_gpio_chip_request_count;
2065static int unittest_gpio_probe_count;
2066static int unittest_gpio_probe_pass_count;
2067
2068static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
2069{
2070 unittest_gpio_chip_request_count++;
2071
2072 pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
2073 unittest_gpio_chip_request_count);
2074 return 0;
2075}
2076
2077static int unittest_gpio_probe(struct platform_device *pdev)
2078{
2079 struct unittest_gpio_dev *devptr;
2080 int ret;
2081
2082 unittest_gpio_probe_count++;
2083
2084 devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
2085 if (!devptr)
2086 return -ENOMEM;
2087
2088 platform_set_drvdata(pdev, devptr);
2089
2090 devptr->chip.fwnode = dev_fwnode(&pdev->dev);
2091 devptr->chip.label = "of-unittest-gpio";
2092 devptr->chip.base = -1; /* dynamic allocation */
2093 devptr->chip.ngpio = 5;
2094 devptr->chip.request = unittest_gpio_chip_request;
2095
2096 ret = gpiochip_add_data(&devptr->chip, NULL);
2097
2098 unittest(!ret,
2099 "gpiochip_add_data() for node @%pfw failed, ret = %d\n", devptr->chip.fwnode, ret);
2100
2101 if (!ret)
2102 unittest_gpio_probe_pass_count++;
2103 return ret;
2104}
2105
2106static void unittest_gpio_remove(struct platform_device *pdev)
2107{
2108 struct unittest_gpio_dev *devptr = platform_get_drvdata(pdev);
2109 struct device *dev = &pdev->dev;
2110
2111 dev_dbg(dev, "%s for node @%pfw\n", __func__, devptr->chip.fwnode);
2112
2113 if (devptr->chip.base != -1)
2114 gpiochip_remove(&devptr->chip);
2115
2116 kfree(devptr);
2117}
2118
2119static const struct of_device_id unittest_gpio_id[] = {
2120 { .compatible = "unittest-gpio", },
2121 {}
2122};
2123
2124static struct platform_driver unittest_gpio_driver = {
2125 .probe = unittest_gpio_probe,
2126 .remove = unittest_gpio_remove,
2127 .driver = {
2128 .name = "unittest-gpio",
2129 .of_match_table = unittest_gpio_id,
2130 },
2131};
2132
2133static void __init of_unittest_overlay_gpio(void)
2134{
2135 int chip_request_count;
2136 int probe_pass_count;
2137 int ret;
2138
2139 /*
2140 * tests: apply overlays before registering driver
2141 * Similar to installing a driver as a module, the
2142 * driver is registered after applying the overlays.
2143 *
2144 * The overlays are applied by overlay_data_apply()
2145 * instead of of_unittest_apply_overlay() so that they
2146 * will not be tracked. Thus they will not be removed
2147 * by of_unittest_remove_tracked_overlays().
2148 *
2149 * - apply overlay_gpio_01
2150 * - apply overlay_gpio_02a
2151 * - apply overlay_gpio_02b
2152 * - register driver
2153 *
2154 * register driver will result in
2155 * - probe and processing gpio hog for overlay_gpio_01
2156 * - probe for overlay_gpio_02a
2157 * - processing gpio for overlay_gpio_02b
2158 */
2159
2160 probe_pass_count = unittest_gpio_probe_pass_count;
2161 chip_request_count = unittest_gpio_chip_request_count;
2162
2163 /*
2164 * overlay_gpio_01 contains gpio node and child gpio hog node
2165 * overlay_gpio_02a contains gpio node
2166 * overlay_gpio_02b contains child gpio hog node
2167 */
2168
2169 unittest(overlay_data_apply("overlay_gpio_01", NULL),
2170 "Adding overlay 'overlay_gpio_01' failed\n");
2171
2172 unittest(overlay_data_apply("overlay_gpio_02a", NULL),
2173 "Adding overlay 'overlay_gpio_02a' failed\n");
2174
2175 unittest(overlay_data_apply("overlay_gpio_02b", NULL),
2176 "Adding overlay 'overlay_gpio_02b' failed\n");
2177
2178 ret = platform_driver_register(&unittest_gpio_driver);
2179 if (unittest(ret == 0, "could not register unittest gpio driver\n"))
2180 return;
2181
2182 unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
2183 "unittest_gpio_probe() failed or not called\n");
2184
2185 unittest(chip_request_count + 2 == unittest_gpio_chip_request_count,
2186 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
2187 unittest_gpio_chip_request_count - chip_request_count);
2188
2189 /*
2190 * tests: apply overlays after registering driver
2191 *
2192 * Similar to a driver built-in to the kernel, the
2193 * driver is registered before applying the overlays.
2194 *
2195 * overlay_gpio_03 contains gpio node and child gpio hog node
2196 *
2197 * - apply overlay_gpio_03
2198 *
2199 * apply overlay will result in
2200 * - probe and processing gpio hog.
2201 */
2202
2203 probe_pass_count = unittest_gpio_probe_pass_count;
2204 chip_request_count = unittest_gpio_chip_request_count;
2205
2206 /* overlay_gpio_03 contains gpio node and child gpio hog node */
2207
2208 unittest(overlay_data_apply("overlay_gpio_03", NULL),
2209 "Adding overlay 'overlay_gpio_03' failed\n");
2210
2211 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
2212 "unittest_gpio_probe() failed or not called\n");
2213
2214 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
2215 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
2216 unittest_gpio_chip_request_count - chip_request_count);
2217
2218 /*
2219 * overlay_gpio_04a contains gpio node
2220 *
2221 * - apply overlay_gpio_04a
2222 *
2223 * apply the overlay will result in
2224 * - probe for overlay_gpio_04a
2225 */
2226
2227 probe_pass_count = unittest_gpio_probe_pass_count;
2228 chip_request_count = unittest_gpio_chip_request_count;
2229
2230 /* overlay_gpio_04a contains gpio node */
2231
2232 unittest(overlay_data_apply("overlay_gpio_04a", NULL),
2233 "Adding overlay 'overlay_gpio_04a' failed\n");
2234
2235 unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
2236 "unittest_gpio_probe() failed or not called\n");
2237
2238 /*
2239 * overlay_gpio_04b contains child gpio hog node
2240 *
2241 * - apply overlay_gpio_04b
2242 *
2243 * apply the overlay will result in
2244 * - processing gpio for overlay_gpio_04b
2245 */
2246
2247 /* overlay_gpio_04b contains child gpio hog node */
2248
2249 unittest(overlay_data_apply("overlay_gpio_04b", NULL),
2250 "Adding overlay 'overlay_gpio_04b' failed\n");
2251
2252 unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
2253 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
2254 unittest_gpio_chip_request_count - chip_request_count);
2255}
2256
2257#else
2258
2259static void __init of_unittest_overlay_gpio(void)
2260{
2261 /* skip tests */
2262}
2263
2264#endif
2265
2266#if IS_BUILTIN(CONFIG_I2C)
2267
2268/* get the i2c client device instantiated at the path */
2269static struct i2c_client *of_path_to_i2c_client(const char *path)
2270{
2271 struct device_node *np;
2272 struct i2c_client *client;
2273
2274 np = of_find_node_by_path(path);
2275 if (np == NULL)
2276 return NULL;
2277
2278 client = of_find_i2c_device_by_node(np);
2279 of_node_put(np);
2280
2281 return client;
2282}
2283
2284/* find out if a i2c client device exists at that path */
2285static int of_path_i2c_client_exists(const char *path)
2286{
2287 struct i2c_client *client;
2288
2289 client = of_path_to_i2c_client(path);
2290 if (client)
2291 put_device(&client->dev);
2292 return client != NULL;
2293}
2294#else
2295static int of_path_i2c_client_exists(const char *path)
2296{
2297 return 0;
2298}
2299#endif
2300
2301enum overlay_type {
2302 PDEV_OVERLAY,
2303 I2C_OVERLAY
2304};
2305
2306static int of_path_device_type_exists(const char *path,
2307 enum overlay_type ovtype)
2308{
2309 switch (ovtype) {
2310 case PDEV_OVERLAY:
2311 return of_path_platform_device_exists(path);
2312 case I2C_OVERLAY:
2313 return of_path_i2c_client_exists(path);
2314 }
2315 return 0;
2316}
2317
2318static const char *unittest_path(int nr, enum overlay_type ovtype)
2319{
2320 const char *base;
2321 static char buf[256];
2322
2323 switch (ovtype) {
2324 case PDEV_OVERLAY:
2325 base = "/testcase-data/overlay-node/test-bus";
2326 break;
2327 case I2C_OVERLAY:
2328 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
2329 break;
2330 default:
2331 buf[0] = '\0';
2332 return buf;
2333 }
2334 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
2335 buf[sizeof(buf) - 1] = '\0';
2336 return buf;
2337}
2338
2339static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
2340{
2341 const char *path;
2342
2343 path = unittest_path(unittest_nr, ovtype);
2344
2345 switch (ovtype) {
2346 case PDEV_OVERLAY:
2347 return of_path_platform_device_exists(path);
2348 case I2C_OVERLAY:
2349 return of_path_i2c_client_exists(path);
2350 }
2351 return 0;
2352}
2353
2354static const char *overlay_name_from_nr(int nr)
2355{
2356 static char buf[256];
2357
2358 snprintf(buf, sizeof(buf) - 1,
2359 "overlay_%d", nr);
2360 buf[sizeof(buf) - 1] = '\0';
2361
2362 return buf;
2363}
2364
2365static const char *bus_path = "/testcase-data/overlay-node/test-bus";
2366
2367#define MAX_TRACK_OVCS_IDS 256
2368
2369static int track_ovcs_id[MAX_TRACK_OVCS_IDS];
2370static int track_ovcs_id_overlay_nr[MAX_TRACK_OVCS_IDS];
2371static int track_ovcs_id_cnt;
2372
2373static void of_unittest_track_overlay(int ovcs_id, int overlay_nr)
2374{
2375 if (WARN_ON(track_ovcs_id_cnt >= MAX_TRACK_OVCS_IDS))
2376 return;
2377
2378 track_ovcs_id[track_ovcs_id_cnt] = ovcs_id;
2379 track_ovcs_id_overlay_nr[track_ovcs_id_cnt] = overlay_nr;
2380 track_ovcs_id_cnt++;
2381}
2382
2383static void of_unittest_untrack_overlay(int ovcs_id)
2384{
2385 if (WARN_ON(track_ovcs_id_cnt < 1))
2386 return;
2387
2388 track_ovcs_id_cnt--;
2389
2390 /* If out of synch then test is broken. Do not try to recover. */
2391 WARN_ON(track_ovcs_id[track_ovcs_id_cnt] != ovcs_id);
2392}
2393
2394static void of_unittest_remove_tracked_overlays(void)
2395{
2396 int ret, ovcs_id, overlay_nr, save_ovcs_id;
2397 const char *overlay_name;
2398
2399 while (track_ovcs_id_cnt > 0) {
2400
2401 ovcs_id = track_ovcs_id[track_ovcs_id_cnt - 1];
2402 overlay_nr = track_ovcs_id_overlay_nr[track_ovcs_id_cnt - 1];
2403 save_ovcs_id = ovcs_id;
2404 ret = of_overlay_remove(&ovcs_id);
2405 if (ret == -ENODEV) {
2406 overlay_name = overlay_name_from_nr(overlay_nr);
2407 pr_warn("%s: of_overlay_remove() for overlay \"%s\" failed, ret = %d\n",
2408 __func__, overlay_name, ret);
2409 }
2410 of_unittest_untrack_overlay(save_ovcs_id);
2411 }
2412
2413}
2414
2415static int __init of_unittest_apply_overlay(int overlay_nr, int *ovcs_id)
2416{
2417 /*
2418 * The overlay will be tracked, thus it will be removed
2419 * by of_unittest_remove_tracked_overlays().
2420 */
2421
2422 const char *overlay_name;
2423
2424 overlay_name = overlay_name_from_nr(overlay_nr);
2425
2426 if (!overlay_data_apply(overlay_name, ovcs_id)) {
2427 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2428 return -EFAULT;
2429 }
2430 of_unittest_track_overlay(*ovcs_id, overlay_nr);
2431
2432 return 0;
2433}
2434
2435static int __init __of_unittest_apply_overlay_check(int overlay_nr,
2436 int unittest_nr, int before, int after,
2437 enum overlay_type ovtype)
2438{
2439 int ret, ovcs_id;
2440
2441 /* unittest device must be in before state */
2442 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2443 unittest(0, "%s with device @\"%s\" %s\n",
2444 overlay_name_from_nr(overlay_nr),
2445 unittest_path(unittest_nr, ovtype),
2446 !before ? "enabled" : "disabled");
2447 return -EINVAL;
2448 }
2449
2450 /* apply the overlay */
2451 ovcs_id = 0;
2452 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2453 if (ret != 0) {
2454 /* of_unittest_apply_overlay already called unittest() */
2455 return ret;
2456 }
2457
2458 /* unittest device must be in after state */
2459 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2460 unittest(0, "%s with device @\"%s\" %s\n",
2461 overlay_name_from_nr(overlay_nr),
2462 unittest_path(unittest_nr, ovtype),
2463 !after ? "enabled" : "disabled");
2464 return -EINVAL;
2465 }
2466
2467 return ovcs_id;
2468}
2469
2470/* apply an overlay while checking before and after states */
2471static int __init of_unittest_apply_overlay_check(int overlay_nr,
2472 int unittest_nr, int before, int after,
2473 enum overlay_type ovtype)
2474{
2475 int ovcs_id = __of_unittest_apply_overlay_check(overlay_nr,
2476 unittest_nr, before, after, ovtype);
2477 if (ovcs_id < 0)
2478 return ovcs_id;
2479
2480 return 0;
2481}
2482
2483/* apply an overlay and then revert it while checking before, after states */
2484static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
2485 int unittest_nr, int before, int after,
2486 enum overlay_type ovtype)
2487{
2488 int ret, ovcs_id, save_ovcs_id;
2489
2490 ovcs_id = __of_unittest_apply_overlay_check(overlay_nr, unittest_nr,
2491 before, after, ovtype);
2492 if (ovcs_id < 0)
2493 return ovcs_id;
2494
2495 /* remove the overlay */
2496 save_ovcs_id = ovcs_id;
2497 ret = of_overlay_remove(&ovcs_id);
2498 if (ret != 0) {
2499 unittest(0, "%s failed to be destroyed @\"%s\"\n",
2500 overlay_name_from_nr(overlay_nr),
2501 unittest_path(unittest_nr, ovtype));
2502 return ret;
2503 }
2504 of_unittest_untrack_overlay(save_ovcs_id);
2505
2506 /* unittest device must be again in before state */
2507 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2508 unittest(0, "%s with device @\"%s\" %s\n",
2509 overlay_name_from_nr(overlay_nr),
2510 unittest_path(unittest_nr, ovtype),
2511 !before ? "enabled" : "disabled");
2512 return -EINVAL;
2513 }
2514
2515 return 0;
2516}
2517
2518/* test activation of device */
2519static void __init of_unittest_overlay_0(void)
2520{
2521 int ret;
2522
2523 EXPECT_BEGIN(KERN_INFO,
2524 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2525
2526 /* device should enable */
2527 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
2528
2529 EXPECT_END(KERN_INFO,
2530 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2531
2532 if (ret)
2533 return;
2534
2535 unittest(1, "overlay test %d passed\n", 0);
2536}
2537
2538/* test deactivation of device */
2539static void __init of_unittest_overlay_1(void)
2540{
2541 int ret;
2542
2543 EXPECT_BEGIN(KERN_INFO,
2544 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2545
2546 /* device should disable */
2547 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
2548
2549 EXPECT_END(KERN_INFO,
2550 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2551
2552 if (ret)
2553 return;
2554
2555 unittest(1, "overlay test %d passed\n", 1);
2556
2557}
2558
2559/* test activation of device */
2560static void __init of_unittest_overlay_2(void)
2561{
2562 int ret;
2563
2564 EXPECT_BEGIN(KERN_INFO,
2565 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2566
2567 /* device should enable */
2568 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
2569
2570 EXPECT_END(KERN_INFO,
2571 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2572
2573 if (ret)
2574 return;
2575 unittest(1, "overlay test %d passed\n", 2);
2576}
2577
2578/* test deactivation of device */
2579static void __init of_unittest_overlay_3(void)
2580{
2581 int ret;
2582
2583 EXPECT_BEGIN(KERN_INFO,
2584 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2585
2586 /* device should disable */
2587 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
2588
2589 EXPECT_END(KERN_INFO,
2590 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2591
2592 if (ret)
2593 return;
2594
2595 unittest(1, "overlay test %d passed\n", 3);
2596}
2597
2598/* test activation of a full device node */
2599static void __init of_unittest_overlay_4(void)
2600{
2601 /* device should disable */
2602 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
2603 return;
2604
2605 unittest(1, "overlay test %d passed\n", 4);
2606}
2607
2608/* test overlay apply/revert sequence */
2609static void __init of_unittest_overlay_5(void)
2610{
2611 int ret;
2612
2613 EXPECT_BEGIN(KERN_INFO,
2614 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2615
2616 /* device should disable */
2617 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
2618
2619 EXPECT_END(KERN_INFO,
2620 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2621
2622 if (ret)
2623 return;
2624
2625 unittest(1, "overlay test %d passed\n", 5);
2626}
2627
2628/* test overlay application in sequence */
2629static void __init of_unittest_overlay_6(void)
2630{
2631 int i, save_ovcs_id[2], ovcs_id;
2632 int overlay_nr = 6, unittest_nr = 6;
2633 int before = 0, after = 1;
2634 const char *overlay_name;
2635
2636 int ret;
2637
2638 /* unittest device must be in before state */
2639 for (i = 0; i < 2; i++) {
2640 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2641 != before) {
2642 unittest(0, "%s with device @\"%s\" %s\n",
2643 overlay_name_from_nr(overlay_nr + i),
2644 unittest_path(unittest_nr + i,
2645 PDEV_OVERLAY),
2646 !before ? "enabled" : "disabled");
2647 return;
2648 }
2649 }
2650
2651 /* apply the overlays */
2652
2653 EXPECT_BEGIN(KERN_INFO,
2654 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2655
2656 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2657
2658 ret = overlay_data_apply(overlay_name, &ovcs_id);
2659
2660 if (!ret) {
2661 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2662 return;
2663 }
2664 save_ovcs_id[0] = ovcs_id;
2665 of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2666
2667 EXPECT_END(KERN_INFO,
2668 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2669
2670 EXPECT_BEGIN(KERN_INFO,
2671 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2672
2673 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2674
2675 ret = overlay_data_apply(overlay_name, &ovcs_id);
2676
2677 if (!ret) {
2678 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2679 return;
2680 }
2681 save_ovcs_id[1] = ovcs_id;
2682 of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2683
2684 EXPECT_END(KERN_INFO,
2685 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2686
2687
2688 for (i = 0; i < 2; i++) {
2689 /* unittest device must be in after state */
2690 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2691 != after) {
2692 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
2693 overlay_name_from_nr(overlay_nr + i),
2694 unittest_path(unittest_nr + i,
2695 PDEV_OVERLAY),
2696 !after ? "enabled" : "disabled");
2697 return;
2698 }
2699 }
2700
2701 for (i = 1; i >= 0; i--) {
2702 ovcs_id = save_ovcs_id[i];
2703 if (of_overlay_remove(&ovcs_id)) {
2704 unittest(0, "%s failed destroy @\"%s\"\n",
2705 overlay_name_from_nr(overlay_nr + i),
2706 unittest_path(unittest_nr + i,
2707 PDEV_OVERLAY));
2708 return;
2709 }
2710 of_unittest_untrack_overlay(save_ovcs_id[i]);
2711 }
2712
2713 for (i = 0; i < 2; i++) {
2714 /* unittest device must be again in before state */
2715 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2716 != before) {
2717 unittest(0, "%s with device @\"%s\" %s\n",
2718 overlay_name_from_nr(overlay_nr + i),
2719 unittest_path(unittest_nr + i,
2720 PDEV_OVERLAY),
2721 !before ? "enabled" : "disabled");
2722 return;
2723 }
2724 }
2725
2726 unittest(1, "overlay test %d passed\n", 6);
2727
2728}
2729
2730/* test overlay application in sequence */
2731static void __init of_unittest_overlay_8(void)
2732{
2733 int i, save_ovcs_id[2], ovcs_id;
2734 int overlay_nr = 8, unittest_nr = 8;
2735 const char *overlay_name;
2736 int ret;
2737
2738 /* we don't care about device state in this test */
2739
2740 EXPECT_BEGIN(KERN_INFO,
2741 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2742
2743 overlay_name = overlay_name_from_nr(overlay_nr + 0);
2744
2745 ret = overlay_data_apply(overlay_name, &ovcs_id);
2746 if (!ret)
2747 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2748
2749 EXPECT_END(KERN_INFO,
2750 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2751
2752 if (!ret)
2753 return;
2754
2755 save_ovcs_id[0] = ovcs_id;
2756 of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2757
2758 overlay_name = overlay_name_from_nr(overlay_nr + 1);
2759
2760 EXPECT_BEGIN(KERN_INFO,
2761 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2762
2763 /* apply the overlays */
2764 ret = overlay_data_apply(overlay_name, &ovcs_id);
2765
2766 EXPECT_END(KERN_INFO,
2767 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2768
2769 if (!ret) {
2770 unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2771 return;
2772 }
2773
2774 save_ovcs_id[1] = ovcs_id;
2775 of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2776
2777 /* now try to remove first overlay (it should fail) */
2778 ovcs_id = save_ovcs_id[0];
2779
2780 EXPECT_BEGIN(KERN_INFO,
2781 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2782
2783 EXPECT_BEGIN(KERN_INFO,
2784 "OF: overlay: overlay #6 is not topmost");
2785
2786 ret = of_overlay_remove(&ovcs_id);
2787
2788 EXPECT_END(KERN_INFO,
2789 "OF: overlay: overlay #6 is not topmost");
2790
2791 EXPECT_END(KERN_INFO,
2792 "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2793
2794 if (!ret) {
2795 /*
2796 * Should never get here. If we do, expect a lot of
2797 * subsequent tracking and overlay removal related errors.
2798 */
2799 unittest(0, "%s was destroyed @\"%s\"\n",
2800 overlay_name_from_nr(overlay_nr + 0),
2801 unittest_path(unittest_nr,
2802 PDEV_OVERLAY));
2803 return;
2804 }
2805
2806 /* removing them in order should work */
2807 for (i = 1; i >= 0; i--) {
2808 ovcs_id = save_ovcs_id[i];
2809 if (of_overlay_remove(&ovcs_id)) {
2810 unittest(0, "%s not destroyed @\"%s\"\n",
2811 overlay_name_from_nr(overlay_nr + i),
2812 unittest_path(unittest_nr,
2813 PDEV_OVERLAY));
2814 return;
2815 }
2816 of_unittest_untrack_overlay(save_ovcs_id[i]);
2817 }
2818
2819 unittest(1, "overlay test %d passed\n", 8);
2820}
2821
2822/* test insertion of a bus with parent devices */
2823static void __init of_unittest_overlay_10(void)
2824{
2825 int ret;
2826 char *child_path;
2827
2828 /* device should disable */
2829 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
2830
2831 if (unittest(ret == 0,
2832 "overlay test %d failed; overlay application\n", 10))
2833 return;
2834
2835 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
2836 unittest_path(10, PDEV_OVERLAY));
2837 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
2838 return;
2839
2840 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
2841 kfree(child_path);
2842
2843 unittest(ret, "overlay test %d failed; no child device\n", 10);
2844}
2845
2846/* test insertion of a bus with parent devices (and revert) */
2847static void __init of_unittest_overlay_11(void)
2848{
2849 int ret;
2850
2851 /* device should disable */
2852 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
2853 PDEV_OVERLAY);
2854
2855 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2856}
2857
2858#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2859
2860struct unittest_i2c_bus_data {
2861 struct platform_device *pdev;
2862 struct i2c_adapter adap;
2863};
2864
2865static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2866 struct i2c_msg *msgs, int num)
2867{
2868 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2869
2870 (void)std;
2871
2872 return num;
2873}
2874
2875static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2876{
2877 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2878}
2879
2880static const struct i2c_algorithm unittest_i2c_algo = {
2881 .master_xfer = unittest_i2c_master_xfer,
2882 .functionality = unittest_i2c_functionality,
2883};
2884
2885static int unittest_i2c_bus_probe(struct platform_device *pdev)
2886{
2887 struct device *dev = &pdev->dev;
2888 struct device_node *np = dev->of_node;
2889 struct unittest_i2c_bus_data *std;
2890 struct i2c_adapter *adap;
2891 int ret;
2892
2893 if (np == NULL) {
2894 dev_err(dev, "No OF data for device\n");
2895 return -EINVAL;
2896
2897 }
2898
2899 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2900
2901 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
2902 if (!std)
2903 return -ENOMEM;
2904
2905 /* link them together */
2906 std->pdev = pdev;
2907 platform_set_drvdata(pdev, std);
2908
2909 adap = &std->adap;
2910 i2c_set_adapdata(adap, std);
2911 adap->nr = -1;
2912 strscpy(adap->name, pdev->name, sizeof(adap->name));
2913 adap->class = I2C_CLASS_DEPRECATED;
2914 adap->algo = &unittest_i2c_algo;
2915 adap->dev.parent = dev;
2916 adap->dev.of_node = dev->of_node;
2917 adap->timeout = 5 * HZ;
2918 adap->retries = 3;
2919
2920 ret = i2c_add_numbered_adapter(adap);
2921 if (ret != 0) {
2922 dev_err(dev, "Failed to add I2C adapter\n");
2923 return ret;
2924 }
2925
2926 return 0;
2927}
2928
2929static void unittest_i2c_bus_remove(struct platform_device *pdev)
2930{
2931 struct device *dev = &pdev->dev;
2932 struct device_node *np = dev->of_node;
2933 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
2934
2935 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2936 i2c_del_adapter(&std->adap);
2937}
2938
2939static const struct of_device_id unittest_i2c_bus_match[] = {
2940 { .compatible = "unittest-i2c-bus", },
2941 {},
2942};
2943
2944static struct platform_driver unittest_i2c_bus_driver = {
2945 .probe = unittest_i2c_bus_probe,
2946 .remove = unittest_i2c_bus_remove,
2947 .driver = {
2948 .name = "unittest-i2c-bus",
2949 .of_match_table = unittest_i2c_bus_match,
2950 },
2951};
2952
2953static int unittest_i2c_dev_probe(struct i2c_client *client)
2954{
2955 struct device *dev = &client->dev;
2956 struct device_node *np = client->dev.of_node;
2957
2958 if (!np) {
2959 dev_err(dev, "No OF node\n");
2960 return -EINVAL;
2961 }
2962
2963 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2964
2965 return 0;
2966};
2967
2968static void unittest_i2c_dev_remove(struct i2c_client *client)
2969{
2970 struct device *dev = &client->dev;
2971 struct device_node *np = client->dev.of_node;
2972
2973 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2974}
2975
2976static const struct i2c_device_id unittest_i2c_dev_id[] = {
2977 { .name = "unittest-i2c-dev" },
2978 { }
2979};
2980
2981static struct i2c_driver unittest_i2c_dev_driver = {
2982 .driver = {
2983 .name = "unittest-i2c-dev",
2984 },
2985 .probe = unittest_i2c_dev_probe,
2986 .remove = unittest_i2c_dev_remove,
2987 .id_table = unittest_i2c_dev_id,
2988};
2989
2990#if IS_BUILTIN(CONFIG_I2C_MUX)
2991
2992static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
2993{
2994 return 0;
2995}
2996
2997static int unittest_i2c_mux_probe(struct i2c_client *client)
2998{
2999 int i, nchans;
3000 struct device *dev = &client->dev;
3001 struct i2c_adapter *adap = client->adapter;
3002 struct device_node *np = client->dev.of_node, *child;
3003 struct i2c_mux_core *muxc;
3004 u32 reg, max_reg;
3005
3006 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
3007
3008 if (!np) {
3009 dev_err(dev, "No OF node\n");
3010 return -EINVAL;
3011 }
3012
3013 max_reg = (u32)-1;
3014 for_each_child_of_node(np, child) {
3015 if (of_property_read_u32(child, "reg", ®))
3016 continue;
3017 if (max_reg == (u32)-1 || reg > max_reg)
3018 max_reg = reg;
3019 }
3020 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
3021 if (nchans == 0) {
3022 dev_err(dev, "No channels\n");
3023 return -EINVAL;
3024 }
3025
3026 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
3027 unittest_i2c_mux_select_chan, NULL);
3028 if (!muxc)
3029 return -ENOMEM;
3030 for (i = 0; i < nchans; i++) {
3031 if (i2c_mux_add_adapter(muxc, 0, i)) {
3032 dev_err(dev, "Failed to register mux #%d\n", i);
3033 i2c_mux_del_adapters(muxc);
3034 return -ENODEV;
3035 }
3036 }
3037
3038 i2c_set_clientdata(client, muxc);
3039
3040 return 0;
3041};
3042
3043static void unittest_i2c_mux_remove(struct i2c_client *client)
3044{
3045 struct device *dev = &client->dev;
3046 struct device_node *np = client->dev.of_node;
3047 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
3048
3049 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
3050 i2c_mux_del_adapters(muxc);
3051}
3052
3053static const struct i2c_device_id unittest_i2c_mux_id[] = {
3054 { .name = "unittest-i2c-mux" },
3055 { }
3056};
3057
3058static struct i2c_driver unittest_i2c_mux_driver = {
3059 .driver = {
3060 .name = "unittest-i2c-mux",
3061 },
3062 .probe = unittest_i2c_mux_probe,
3063 .remove = unittest_i2c_mux_remove,
3064 .id_table = unittest_i2c_mux_id,
3065};
3066
3067#endif
3068
3069static int of_unittest_overlay_i2c_init(void)
3070{
3071 int ret;
3072
3073 ret = i2c_add_driver(&unittest_i2c_dev_driver);
3074 if (unittest(ret == 0,
3075 "could not register unittest i2c device driver\n"))
3076 return ret;
3077
3078 ret = platform_driver_register(&unittest_i2c_bus_driver);
3079
3080 if (unittest(ret == 0,
3081 "could not register unittest i2c bus driver\n"))
3082 return ret;
3083
3084#if IS_BUILTIN(CONFIG_I2C_MUX)
3085
3086 EXPECT_BEGIN(KERN_INFO,
3087 "i2c i2c-1: Added multiplexed i2c bus 2");
3088
3089 ret = i2c_add_driver(&unittest_i2c_mux_driver);
3090
3091 EXPECT_END(KERN_INFO,
3092 "i2c i2c-1: Added multiplexed i2c bus 2");
3093
3094 if (unittest(ret == 0,
3095 "could not register unittest i2c mux driver\n"))
3096 return ret;
3097#endif
3098
3099 return 0;
3100}
3101
3102static void of_unittest_overlay_i2c_cleanup(void)
3103{
3104#if IS_BUILTIN(CONFIG_I2C_MUX)
3105 i2c_del_driver(&unittest_i2c_mux_driver);
3106#endif
3107 platform_driver_unregister(&unittest_i2c_bus_driver);
3108 i2c_del_driver(&unittest_i2c_dev_driver);
3109}
3110
3111static void __init of_unittest_overlay_i2c_12(void)
3112{
3113 int ret;
3114
3115 /* device should enable */
3116 EXPECT_BEGIN(KERN_INFO,
3117 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
3118
3119 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
3120
3121 EXPECT_END(KERN_INFO,
3122 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
3123
3124 if (ret)
3125 return;
3126
3127 unittest(1, "overlay test %d passed\n", 12);
3128}
3129
3130/* test deactivation of device */
3131static void __init of_unittest_overlay_i2c_13(void)
3132{
3133 int ret;
3134
3135 EXPECT_BEGIN(KERN_INFO,
3136 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
3137
3138 /* device should disable */
3139 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
3140
3141 EXPECT_END(KERN_INFO,
3142 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
3143
3144 if (ret)
3145 return;
3146
3147 unittest(1, "overlay test %d passed\n", 13);
3148}
3149
3150/* just check for i2c mux existence */
3151static void of_unittest_overlay_i2c_14(void)
3152{
3153}
3154
3155static void __init of_unittest_overlay_i2c_15(void)
3156{
3157 int ret;
3158
3159 /* device should enable */
3160 EXPECT_BEGIN(KERN_INFO,
3161 "i2c i2c-1: Added multiplexed i2c bus 3");
3162
3163 ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
3164
3165 EXPECT_END(KERN_INFO,
3166 "i2c i2c-1: Added multiplexed i2c bus 3");
3167
3168 if (ret)
3169 return;
3170
3171 unittest(1, "overlay test %d passed\n", 15);
3172}
3173
3174#else
3175
3176static inline void of_unittest_overlay_i2c_14(void) { }
3177static inline void of_unittest_overlay_i2c_15(void) { }
3178
3179#endif
3180
3181static int of_notify(struct notifier_block *nb, unsigned long action,
3182 void *arg)
3183{
3184 struct of_overlay_notify_data *nd = arg;
3185 struct device_node *found;
3186 int ret;
3187
3188 /*
3189 * For overlay_16 .. overlay_19, check that returning an error
3190 * works for each of the actions by setting an arbitrary return
3191 * error number that matches the test number. e.g. for unittest16,
3192 * ret = -EBUSY which is -16.
3193 *
3194 * OVERLAY_INFO() for the overlays is declared to expect the same
3195 * error number, so overlay_data_apply() will return no error.
3196 *
3197 * overlay_20 will return NOTIFY_DONE
3198 */
3199
3200 ret = 0;
3201 of_node_get(nd->overlay);
3202
3203 switch (action) {
3204
3205 case OF_OVERLAY_PRE_APPLY:
3206 found = of_find_node_by_name(nd->overlay, "test-unittest16");
3207 if (found) {
3208 of_node_put(found);
3209 ret = -EBUSY;
3210 }
3211 break;
3212
3213 case OF_OVERLAY_POST_APPLY:
3214 found = of_find_node_by_name(nd->overlay, "test-unittest17");
3215 if (found) {
3216 of_node_put(found);
3217 ret = -EEXIST;
3218 }
3219 break;
3220
3221 case OF_OVERLAY_PRE_REMOVE:
3222 found = of_find_node_by_name(nd->overlay, "test-unittest18");
3223 if (found) {
3224 of_node_put(found);
3225 ret = -EXDEV;
3226 }
3227 break;
3228
3229 case OF_OVERLAY_POST_REMOVE:
3230 found = of_find_node_by_name(nd->overlay, "test-unittest19");
3231 if (found) {
3232 of_node_put(found);
3233 ret = -ENODEV;
3234 }
3235 break;
3236
3237 default: /* should not happen */
3238 of_node_put(nd->overlay);
3239 ret = -EINVAL;
3240 break;
3241 }
3242
3243 if (ret)
3244 return notifier_from_errno(ret);
3245
3246 return NOTIFY_DONE;
3247}
3248
3249static struct notifier_block of_nb = {
3250 .notifier_call = of_notify,
3251};
3252
3253static void __init of_unittest_overlay_notify(void)
3254{
3255 int ovcs_id;
3256 int ret;
3257
3258 ret = of_overlay_notifier_register(&of_nb);
3259 unittest(!ret,
3260 "of_overlay_notifier_register() failed, ret = %d\n", ret);
3261 if (ret)
3262 return;
3263
3264 /*
3265 * The overlays are applied by overlay_data_apply()
3266 * instead of of_unittest_apply_overlay() so that they
3267 * will not be tracked. Thus they will not be removed
3268 * by of_unittest_remove_tracked_overlays().
3269 *
3270 * Applying overlays 16 - 19 will each trigger an error for a
3271 * different action in of_notify().
3272 *
3273 * Applying overlay 20 will not trigger any error in of_notify().
3274 */
3275
3276 /* --- overlay 16 --- */
3277
3278 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
3279
3280 unittest(overlay_data_apply("overlay_16", &ovcs_id),
3281 "test OF_OVERLAY_PRE_APPLY notify injected error\n");
3282
3283 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
3284
3285 unittest(ovcs_id, "ovcs_id not created for overlay_16\n");
3286
3287 /* --- overlay 17 --- */
3288
3289 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
3290
3291 unittest(overlay_data_apply("overlay_17", &ovcs_id),
3292 "test OF_OVERLAY_POST_APPLY notify injected error\n");
3293
3294 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
3295
3296 unittest(ovcs_id, "ovcs_id not created for overlay_17\n");
3297
3298 /* --- overlay 18 --- */
3299
3300 unittest(overlay_data_apply("overlay_18", &ovcs_id),
3301 "OF_OVERLAY_PRE_REMOVE notify injected error\n");
3302
3303 unittest(ovcs_id, "ovcs_id not created for overlay_18\n");
3304
3305 if (ovcs_id) {
3306 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
3307
3308 ret = of_overlay_remove(&ovcs_id);
3309 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
3310 if (ret == -EXDEV) {
3311 /*
3312 * change set ovcs_id should still exist
3313 */
3314 unittest(1, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE\n");
3315 } else {
3316 unittest(0, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE not returned\n");
3317 }
3318 } else {
3319 unittest(1, "ovcs_id not created for overlay_18\n");
3320 }
3321
3322 unittest(ovcs_id, "ovcs_id removed for overlay_18\n");
3323
3324 /* --- overlay 19 --- */
3325
3326 unittest(overlay_data_apply("overlay_19", &ovcs_id),
3327 "OF_OVERLAY_POST_REMOVE notify injected error\n");
3328
3329 unittest(ovcs_id, "ovcs_id not created for overlay_19\n");
3330
3331 if (ovcs_id) {
3332 EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
3333 ret = of_overlay_remove(&ovcs_id);
3334 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
3335 if (ret == -ENODEV)
3336 unittest(1, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE\n");
3337 else
3338 unittest(0, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE not returned\n");
3339 } else {
3340 unittest(1, "ovcs_id removed for overlay_19\n");
3341 }
3342
3343 unittest(!ovcs_id, "changeset ovcs_id = %d not removed for overlay_19\n",
3344 ovcs_id);
3345
3346 /* --- overlay 20 --- */
3347
3348 unittest(overlay_data_apply("overlay_20", &ovcs_id),
3349 "overlay notify no injected error\n");
3350
3351 if (ovcs_id) {
3352 ret = of_overlay_remove(&ovcs_id);
3353 if (ret)
3354 unittest(1, "overlay_20 failed to be destroyed, ret = %d\n",
3355 ret);
3356 } else {
3357 unittest(1, "ovcs_id not created for overlay_20\n");
3358 }
3359
3360 unittest(!of_overlay_notifier_unregister(&of_nb),
3361 "of_overlay_notifier_unregister() failed, ret = %d\n", ret);
3362}
3363
3364static void __init of_unittest_overlay(void)
3365{
3366 struct device_node *bus_np = NULL;
3367 unsigned int i;
3368
3369 if (platform_driver_register(&unittest_driver)) {
3370 unittest(0, "could not register unittest driver\n");
3371 goto out;
3372 }
3373
3374 bus_np = of_find_node_by_path(bus_path);
3375 if (bus_np == NULL) {
3376 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
3377 goto out;
3378 }
3379
3380 if (of_platform_default_populate(bus_np, NULL, NULL)) {
3381 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
3382 goto out;
3383 }
3384
3385 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
3386 unittest(0, "could not find unittest0 @ \"%s\"\n",
3387 unittest_path(100, PDEV_OVERLAY));
3388 goto out;
3389 }
3390
3391 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
3392 unittest(0, "unittest1 @ \"%s\" should not exist\n",
3393 unittest_path(101, PDEV_OVERLAY));
3394 goto out;
3395 }
3396
3397 unittest(1, "basic infrastructure of overlays passed");
3398
3399 /* tests in sequence */
3400 of_unittest_overlay_0();
3401 of_unittest_overlay_1();
3402 of_unittest_overlay_2();
3403 of_unittest_overlay_3();
3404 of_unittest_overlay_4();
3405 for (i = 0; i < 3; i++)
3406 of_unittest_overlay_5();
3407 of_unittest_overlay_6();
3408 of_unittest_overlay_8();
3409
3410 of_unittest_overlay_10();
3411 of_unittest_overlay_11();
3412
3413#if IS_BUILTIN(CONFIG_I2C)
3414 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
3415 goto out;
3416
3417 of_unittest_overlay_i2c_12();
3418 of_unittest_overlay_i2c_13();
3419 of_unittest_overlay_i2c_14();
3420 of_unittest_overlay_i2c_15();
3421
3422 of_unittest_overlay_i2c_cleanup();
3423#endif
3424
3425 of_unittest_overlay_gpio();
3426
3427 of_unittest_remove_tracked_overlays();
3428
3429 of_unittest_overlay_notify();
3430
3431out:
3432 of_node_put(bus_np);
3433}
3434
3435#else
3436static inline void __init of_unittest_overlay(void) { }
3437#endif
3438
3439static void __init of_unittest_lifecycle(void)
3440{
3441#ifdef CONFIG_OF_DYNAMIC
3442 unsigned int refcount;
3443 int found_refcount_one = 0;
3444 int put_count = 0;
3445 struct device_node *np;
3446 struct device_node *prev_sibling, *next_sibling;
3447 const char *refcount_path = "/testcase-data/refcount-node";
3448 const char *refcount_parent_path = "/testcase-data";
3449
3450 /*
3451 * Node lifecycle tests, non-dynamic node:
3452 *
3453 * - Decrementing refcount to zero via of_node_put() should cause the
3454 * attempt to free the node memory by of_node_release() to fail
3455 * because the node is not a dynamic node.
3456 *
3457 * - Decrementing refcount past zero should result in additional
3458 * errors reported.
3459 */
3460
3461 np = of_find_node_by_path(refcount_path);
3462 unittest(np, "find refcount_path \"%s\"\n", refcount_path);
3463 if (np == NULL)
3464 goto out_skip_tests;
3465
3466 while (!found_refcount_one) {
3467
3468 if (put_count++ > 10) {
3469 unittest(0, "guardrail to avoid infinite loop\n");
3470 goto out_skip_tests;
3471 }
3472
3473 refcount = kref_read(&np->kobj.kref);
3474 if (refcount == 1)
3475 found_refcount_one = 1;
3476 else
3477 of_node_put(np);
3478 }
3479
3480 EXPECT_BEGIN(KERN_INFO, "OF: ERROR: of_node_release() detected bad of_node_put() on /testcase-data/refcount-node");
3481
3482 /*
3483 * refcount is now one, decrementing to zero will result in a call to
3484 * of_node_release() to free the node's memory, which should result
3485 * in an error
3486 */
3487 unittest(1, "/testcase-data/refcount-node is one");
3488 of_node_put(np);
3489
3490 EXPECT_END(KERN_INFO, "OF: ERROR: of_node_release() detected bad of_node_put() on /testcase-data/refcount-node");
3491
3492
3493 /*
3494 * expect stack trace for subsequent of_node_put():
3495 * __refcount_sub_and_test() calls:
3496 * refcount_warn_saturate(r, REFCOUNT_SUB_UAF)
3497 *
3498 * Not capturing entire WARN_ONCE() trace with EXPECT_*(), just
3499 * the first three lines, and the last line.
3500 */
3501 EXPECT_BEGIN(KERN_INFO, "------------[ cut here ]------------");
3502 EXPECT_BEGIN(KERN_INFO, "WARNING: <<all>>");
3503 EXPECT_BEGIN(KERN_INFO, "refcount_t: underflow; use-after-free.");
3504 EXPECT_BEGIN(KERN_INFO, "---[ end trace <<int>> ]---");
3505
3506 /* refcount is now zero, this should fail */
3507 unittest(1, "/testcase-data/refcount-node is zero");
3508 of_node_put(np);
3509
3510 EXPECT_END(KERN_INFO, "---[ end trace <<int>> ]---");
3511 EXPECT_END(KERN_INFO, "refcount_t: underflow; use-after-free.");
3512 EXPECT_END(KERN_INFO, "WARNING: <<all>>");
3513 EXPECT_END(KERN_INFO, "------------[ cut here ]------------");
3514
3515 /*
3516 * Q. do we expect to get yet another warning?
3517 * A. no, the WARNING is from WARN_ONCE()
3518 */
3519 EXPECT_NOT_BEGIN(KERN_INFO, "------------[ cut here ]------------");
3520 EXPECT_NOT_BEGIN(KERN_INFO, "WARNING: <<all>>");
3521 EXPECT_NOT_BEGIN(KERN_INFO, "refcount_t: underflow; use-after-free.");
3522 EXPECT_NOT_BEGIN(KERN_INFO, "---[ end trace <<int>> ]---");
3523
3524 unittest(1, "/testcase-data/refcount-node is zero, second time");
3525 of_node_put(np);
3526
3527 EXPECT_NOT_END(KERN_INFO, "---[ end trace <<int>> ]---");
3528 EXPECT_NOT_END(KERN_INFO, "refcount_t: underflow; use-after-free.");
3529 EXPECT_NOT_END(KERN_INFO, "WARNING: <<all>>");
3530 EXPECT_NOT_END(KERN_INFO, "------------[ cut here ]------------");
3531
3532 /*
3533 * refcount of zero will trigger stack traces from any further
3534 * attempt to of_node_get() node "refcount-node". One example of
3535 * this is where of_unittest_check_node_linkage() will recursively
3536 * scan the tree, with 'for_each_child_of_node()' doing an
3537 * of_node_get() of the children of a node.
3538 *
3539 * Prevent the stack trace by removing node "refcount-node" from
3540 * its parent's child list.
3541 *
3542 * WARNING: EVIL, EVIL, EVIL:
3543 *
3544 * Directly manipulate the child list of node /testcase-data to
3545 * remove child refcount-node. This is ignoring all proper methods
3546 * of removing a child and will leak a small amount of memory.
3547 */
3548
3549 np = of_find_node_by_path(refcount_parent_path);
3550 unittest(np, "find refcount_parent_path \"%s\"\n", refcount_parent_path);
3551 unittest(np, "ERROR: devicetree live tree left in a 'bad state' if test fail\n");
3552 if (np == NULL)
3553 return;
3554
3555 prev_sibling = np->child;
3556 next_sibling = prev_sibling->sibling;
3557 if (!strcmp(prev_sibling->full_name, "refcount-node")) {
3558 np->child = next_sibling;
3559 next_sibling = next_sibling->sibling;
3560 }
3561 while (next_sibling) {
3562 if (!strcmp(next_sibling->full_name, "refcount-node"))
3563 prev_sibling->sibling = next_sibling->sibling;
3564 prev_sibling = next_sibling;
3565 next_sibling = next_sibling->sibling;
3566 }
3567 of_node_put(np);
3568
3569 return;
3570
3571out_skip_tests:
3572#endif
3573 unittest(0, "One or more lifecycle tests skipped\n");
3574}
3575
3576#ifdef CONFIG_OF_OVERLAY
3577
3578/*
3579 * __dtbo_##overlay_name##_begin[] and __dtbo_##overlay_name##_end[] are
3580 * created by cmd_wrap_S_dtbo in scripts/Makefile.dtbs
3581 */
3582
3583#define OVERLAY_INFO_EXTERN(overlay_name) \
3584 extern uint8_t __dtbo_##overlay_name##_begin[]; \
3585 extern uint8_t __dtbo_##overlay_name##_end[]
3586
3587#define OVERLAY_INFO(overlay_name, expected, expected_remove) \
3588{ .dtbo_begin = __dtbo_##overlay_name##_begin, \
3589 .dtbo_end = __dtbo_##overlay_name##_end, \
3590 .expected_result = expected, \
3591 .expected_result_remove = expected_remove, \
3592 .name = #overlay_name, \
3593}
3594
3595struct overlay_info {
3596 uint8_t *dtbo_begin;
3597 uint8_t *dtbo_end;
3598 int expected_result;
3599 int expected_result_remove; /* if apply failed */
3600 int ovcs_id;
3601 char *name;
3602};
3603
3604OVERLAY_INFO_EXTERN(overlay_base);
3605OVERLAY_INFO_EXTERN(overlay);
3606OVERLAY_INFO_EXTERN(overlay_0);
3607OVERLAY_INFO_EXTERN(overlay_1);
3608OVERLAY_INFO_EXTERN(overlay_2);
3609OVERLAY_INFO_EXTERN(overlay_3);
3610OVERLAY_INFO_EXTERN(overlay_4);
3611OVERLAY_INFO_EXTERN(overlay_5);
3612OVERLAY_INFO_EXTERN(overlay_6);
3613OVERLAY_INFO_EXTERN(overlay_7);
3614OVERLAY_INFO_EXTERN(overlay_8);
3615OVERLAY_INFO_EXTERN(overlay_9);
3616OVERLAY_INFO_EXTERN(overlay_10);
3617OVERLAY_INFO_EXTERN(overlay_11);
3618OVERLAY_INFO_EXTERN(overlay_12);
3619OVERLAY_INFO_EXTERN(overlay_13);
3620OVERLAY_INFO_EXTERN(overlay_15);
3621OVERLAY_INFO_EXTERN(overlay_16);
3622OVERLAY_INFO_EXTERN(overlay_17);
3623OVERLAY_INFO_EXTERN(overlay_18);
3624OVERLAY_INFO_EXTERN(overlay_19);
3625OVERLAY_INFO_EXTERN(overlay_20);
3626OVERLAY_INFO_EXTERN(overlay_gpio_01);
3627OVERLAY_INFO_EXTERN(overlay_gpio_02a);
3628OVERLAY_INFO_EXTERN(overlay_gpio_02b);
3629OVERLAY_INFO_EXTERN(overlay_gpio_03);
3630OVERLAY_INFO_EXTERN(overlay_gpio_04a);
3631OVERLAY_INFO_EXTERN(overlay_gpio_04b);
3632OVERLAY_INFO_EXTERN(overlay_pci_node);
3633OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
3634OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
3635OVERLAY_INFO_EXTERN(overlay_bad_phandle);
3636OVERLAY_INFO_EXTERN(overlay_bad_symbol);
3637OVERLAY_INFO_EXTERN(overlay_bad_unresolved);
3638
3639/* entries found by name */
3640static struct overlay_info overlays[] = {
3641 OVERLAY_INFO(overlay_base, -9999, 0),
3642 OVERLAY_INFO(overlay, 0, 0),
3643 OVERLAY_INFO(overlay_0, 0, 0),
3644 OVERLAY_INFO(overlay_1, 0, 0),
3645 OVERLAY_INFO(overlay_2, 0, 0),
3646 OVERLAY_INFO(overlay_3, 0, 0),
3647 OVERLAY_INFO(overlay_4, 0, 0),
3648 OVERLAY_INFO(overlay_5, 0, 0),
3649 OVERLAY_INFO(overlay_6, 0, 0),
3650 OVERLAY_INFO(overlay_7, 0, 0),
3651 OVERLAY_INFO(overlay_8, 0, 0),
3652 OVERLAY_INFO(overlay_9, 0, 0),
3653 OVERLAY_INFO(overlay_10, 0, 0),
3654 OVERLAY_INFO(overlay_11, 0, 0),
3655 OVERLAY_INFO(overlay_12, 0, 0),
3656 OVERLAY_INFO(overlay_13, 0, 0),
3657 OVERLAY_INFO(overlay_15, 0, 0),
3658 OVERLAY_INFO(overlay_16, -EBUSY, 0),
3659 OVERLAY_INFO(overlay_17, -EEXIST, 0),
3660 OVERLAY_INFO(overlay_18, 0, 0),
3661 OVERLAY_INFO(overlay_19, 0, 0),
3662 OVERLAY_INFO(overlay_20, 0, 0),
3663 OVERLAY_INFO(overlay_gpio_01, 0, 0),
3664 OVERLAY_INFO(overlay_gpio_02a, 0, 0),
3665 OVERLAY_INFO(overlay_gpio_02b, 0, 0),
3666 OVERLAY_INFO(overlay_gpio_03, 0, 0),
3667 OVERLAY_INFO(overlay_gpio_04a, 0, 0),
3668 OVERLAY_INFO(overlay_gpio_04b, 0, 0),
3669 OVERLAY_INFO(overlay_pci_node, 0, 0),
3670 OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL, -ENODEV),
3671 OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL, -ENODEV),
3672 OVERLAY_INFO(overlay_bad_phandle, -EINVAL, 0),
3673 OVERLAY_INFO(overlay_bad_symbol, -EINVAL, -ENODEV),
3674 OVERLAY_INFO(overlay_bad_unresolved, -EINVAL, 0),
3675 /* end marker */
3676 { }
3677};
3678
3679static struct device_node *overlay_base_root;
3680
3681static void * __init dt_alloc_memory(u64 size, u64 align)
3682{
3683 void *ptr = memblock_alloc(size, align);
3684
3685 if (!ptr)
3686 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
3687 __func__, size, align);
3688
3689 return ptr;
3690}
3691
3692/*
3693 * Create base device tree for the overlay unittest.
3694 *
3695 * This is called from very early boot code.
3696 *
3697 * Do as much as possible the same way as done in __unflatten_device_tree
3698 * and other early boot steps for the normal FDT so that the overlay base
3699 * unflattened tree will have the same characteristics as the real tree
3700 * (such as having memory allocated by the early allocator). The goal
3701 * is to test "the real thing" as much as possible, and test "test setup
3702 * code" as little as possible.
3703 *
3704 * Have to stop before resolving phandles, because that uses kmalloc.
3705 */
3706void __init unittest_unflatten_overlay_base(void)
3707{
3708 struct overlay_info *info;
3709 u32 data_size;
3710 void *new_fdt;
3711 u32 size;
3712 int found = 0;
3713 const char *overlay_name = "overlay_base";
3714
3715 for (info = overlays; info && info->name; info++) {
3716 if (!strcmp(overlay_name, info->name)) {
3717 found = 1;
3718 break;
3719 }
3720 }
3721 if (!found) {
3722 pr_err("no overlay data for %s\n", overlay_name);
3723 return;
3724 }
3725
3726 info = &overlays[0];
3727
3728 if (info->expected_result != -9999) {
3729 pr_err("No dtb 'overlay_base' to attach\n");
3730 return;
3731 }
3732
3733 data_size = info->dtbo_end - info->dtbo_begin;
3734 if (!data_size) {
3735 pr_err("No dtb 'overlay_base' to attach\n");
3736 return;
3737 }
3738
3739 size = fdt_totalsize(info->dtbo_begin);
3740 if (size != data_size) {
3741 pr_err("dtb 'overlay_base' header totalsize != actual size");
3742 return;
3743 }
3744
3745 new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
3746 if (!new_fdt) {
3747 pr_err("alloc for dtb 'overlay_base' failed");
3748 return;
3749 }
3750
3751 memcpy(new_fdt, info->dtbo_begin, size);
3752
3753 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
3754 dt_alloc_memory, true);
3755}
3756
3757/*
3758 * The purpose of of_unittest_overlay_data_add is to add an
3759 * overlay in the normal fashion. This is a test of the whole
3760 * picture, instead of testing individual elements.
3761 *
3762 * A secondary purpose is to be able to verify that the contents of
3763 * /proc/device-tree/ contains the updated structure and values from
3764 * the overlay. That must be verified separately in user space.
3765 *
3766 * Return 0 on unexpected error.
3767 */
3768static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id)
3769{
3770 struct overlay_info *info;
3771 int passed = 1;
3772 int found = 0;
3773 int ret, ret2;
3774 u32 size;
3775
3776 for (info = overlays; info && info->name; info++) {
3777 if (!strcmp(overlay_name, info->name)) {
3778 found = 1;
3779 break;
3780 }
3781 }
3782 if (!found) {
3783 pr_err("no overlay data for %s\n", overlay_name);
3784 return 0;
3785 }
3786
3787 size = info->dtbo_end - info->dtbo_begin;
3788 if (!size)
3789 pr_err("no overlay data for %s\n", overlay_name);
3790
3791 ret = of_overlay_fdt_apply(info->dtbo_begin, size, &info->ovcs_id,
3792 NULL);
3793 if (ovcs_id)
3794 *ovcs_id = info->ovcs_id;
3795 if (ret < 0)
3796 goto out;
3797
3798 pr_debug("%s applied\n", overlay_name);
3799
3800out:
3801 if (ret != info->expected_result) {
3802 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
3803 info->expected_result, ret, overlay_name);
3804 passed = 0;
3805 }
3806
3807 if (ret < 0) {
3808 /* changeset may be partially applied */
3809 ret2 = of_overlay_remove(&info->ovcs_id);
3810 if (ret2 != info->expected_result_remove) {
3811 pr_err("of_overlay_remove() expected %d, ret=%d, %s\n",
3812 info->expected_result_remove, ret2,
3813 overlay_name);
3814 passed = 0;
3815 }
3816 }
3817
3818 return passed;
3819}
3820
3821/*
3822 * The purpose of of_unittest_overlay_high_level is to add an overlay
3823 * in the normal fashion. This is a test of the whole picture,
3824 * instead of individual elements.
3825 *
3826 * The first part of the function is _not_ normal overlay usage; it is
3827 * finishing splicing the base overlay device tree into the live tree.
3828 */
3829static __init void of_unittest_overlay_high_level(void)
3830{
3831 struct device_node *last_sibling;
3832 struct device_node *np;
3833 struct device_node *of_symbols;
3834 struct device_node *overlay_base_symbols;
3835 struct device_node **pprev;
3836 struct property *prop;
3837 int ret;
3838
3839 if (!overlay_base_root) {
3840 unittest(0, "overlay_base_root not initialized\n");
3841 return;
3842 }
3843
3844 /*
3845 * Could not fixup phandles in unittest_unflatten_overlay_base()
3846 * because kmalloc() was not yet available.
3847 */
3848 of_overlay_mutex_lock();
3849 of_resolve_phandles(overlay_base_root);
3850 of_overlay_mutex_unlock();
3851
3852
3853 /*
3854 * do not allow overlay_base to duplicate any node already in
3855 * tree, this greatly simplifies the code
3856 */
3857
3858 /*
3859 * remove overlay_base_root node "__local_fixups", after
3860 * being used by of_resolve_phandles()
3861 */
3862 pprev = &overlay_base_root->child;
3863 for (np = overlay_base_root->child; np; np = np->sibling) {
3864 if (of_node_name_eq(np, "__local_fixups__")) {
3865 *pprev = np->sibling;
3866 break;
3867 }
3868 pprev = &np->sibling;
3869 }
3870
3871 /* remove overlay_base_root node "__symbols__" if in live tree */
3872 of_symbols = of_get_child_by_name(of_root, "__symbols__");
3873 if (of_symbols) {
3874 /* will have to graft properties from node into live tree */
3875 pprev = &overlay_base_root->child;
3876 for (np = overlay_base_root->child; np; np = np->sibling) {
3877 if (of_node_name_eq(np, "__symbols__")) {
3878 overlay_base_symbols = np;
3879 *pprev = np->sibling;
3880 break;
3881 }
3882 pprev = &np->sibling;
3883 }
3884 }
3885
3886 for_each_child_of_node(overlay_base_root, np) {
3887 struct device_node *base_child;
3888 for_each_child_of_node(of_root, base_child) {
3889 if (!strcmp(np->full_name, base_child->full_name)) {
3890 unittest(0, "illegal node name in overlay_base %pOFn",
3891 np);
3892 of_node_put(np);
3893 of_node_put(base_child);
3894 return;
3895 }
3896 }
3897 }
3898
3899 /*
3900 * overlay 'overlay_base' is not allowed to have root
3901 * properties, so only need to splice nodes into main device tree.
3902 *
3903 * root node of *overlay_base_root will not be freed, it is lost
3904 * memory.
3905 */
3906
3907 for (np = overlay_base_root->child; np; np = np->sibling)
3908 np->parent = of_root;
3909
3910 mutex_lock(&of_mutex);
3911
3912 for (last_sibling = np = of_root->child; np; np = np->sibling)
3913 last_sibling = np;
3914
3915 if (last_sibling)
3916 last_sibling->sibling = overlay_base_root->child;
3917 else
3918 of_root->child = overlay_base_root->child;
3919
3920 for_each_of_allnodes_from(overlay_base_root, np)
3921 __of_attach_node_sysfs(np);
3922
3923 if (of_symbols) {
3924 struct property *new_prop;
3925 for_each_property_of_node(overlay_base_symbols, prop) {
3926
3927 new_prop = __of_prop_dup(prop, GFP_KERNEL);
3928 if (!new_prop) {
3929 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
3930 prop->name);
3931 goto err_unlock;
3932 }
3933 if (__of_add_property(of_symbols, new_prop)) {
3934 __of_prop_free(new_prop);
3935 /* "name" auto-generated by unflatten */
3936 if (!strcmp(prop->name, "name"))
3937 continue;
3938 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
3939 prop->name);
3940 goto err_unlock;
3941 }
3942 if (__of_add_property_sysfs(of_symbols, new_prop)) {
3943 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
3944 prop->name);
3945 goto err_unlock;
3946 }
3947 }
3948 }
3949
3950 mutex_unlock(&of_mutex);
3951
3952
3953 /* now do the normal overlay usage test */
3954
3955 /* --- overlay --- */
3956
3957 EXPECT_BEGIN(KERN_ERR,
3958 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3959 EXPECT_BEGIN(KERN_ERR,
3960 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3961 EXPECT_BEGIN(KERN_ERR,
3962 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3963 EXPECT_BEGIN(KERN_ERR,
3964 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3965 EXPECT_BEGIN(KERN_ERR,
3966 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3967 EXPECT_BEGIN(KERN_ERR,
3968 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3969 EXPECT_BEGIN(KERN_ERR,
3970 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3971 EXPECT_BEGIN(KERN_ERR,
3972 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3973 EXPECT_BEGIN(KERN_ERR,
3974 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3975 EXPECT_BEGIN(KERN_ERR,
3976 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3977 EXPECT_BEGIN(KERN_ERR,
3978 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3979
3980 ret = overlay_data_apply("overlay", NULL);
3981
3982 EXPECT_END(KERN_ERR,
3983 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3984 EXPECT_END(KERN_ERR,
3985 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3986 EXPECT_END(KERN_ERR,
3987 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3988 EXPECT_END(KERN_ERR,
3989 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3990 EXPECT_END(KERN_ERR,
3991 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3992 EXPECT_END(KERN_ERR,
3993 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3994 EXPECT_END(KERN_ERR,
3995 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3996 EXPECT_END(KERN_ERR,
3997 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3998 EXPECT_END(KERN_ERR,
3999 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
4000 EXPECT_END(KERN_ERR,
4001 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
4002 EXPECT_END(KERN_ERR,
4003 "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
4004
4005 unittest(ret, "Adding overlay 'overlay' failed\n");
4006
4007 /* --- overlay_bad_add_dup_node --- */
4008
4009 EXPECT_BEGIN(KERN_ERR,
4010 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
4011 EXPECT_BEGIN(KERN_ERR,
4012 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
4013 EXPECT_BEGIN(KERN_ERR,
4014 "OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/controller:name");
4015 EXPECT_BEGIN(KERN_ERR,
4016 "OF: Error reverting changeset (-19)");
4017
4018 unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
4019 "Adding overlay 'overlay_bad_add_dup_node' failed\n");
4020
4021 EXPECT_END(KERN_ERR,
4022 "OF: Error reverting changeset (-19)");
4023 EXPECT_END(KERN_ERR,
4024 "OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/controller:name");
4025 EXPECT_END(KERN_ERR,
4026 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
4027 EXPECT_END(KERN_ERR,
4028 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
4029
4030 /* --- overlay_bad_add_dup_prop --- */
4031
4032 EXPECT_BEGIN(KERN_ERR,
4033 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
4034 EXPECT_BEGIN(KERN_ERR,
4035 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
4036 EXPECT_BEGIN(KERN_ERR,
4037 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
4038 EXPECT_BEGIN(KERN_ERR,
4039 "OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/electric:name");
4040 EXPECT_BEGIN(KERN_ERR,
4041 "OF: Error reverting changeset (-19)");
4042
4043 unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
4044 "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
4045
4046 EXPECT_END(KERN_ERR,
4047 "OF: Error reverting changeset (-19)");
4048 EXPECT_END(KERN_ERR,
4049 "OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/electric:name");
4050 EXPECT_END(KERN_ERR,
4051 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
4052 EXPECT_END(KERN_ERR,
4053 "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
4054 EXPECT_END(KERN_ERR,
4055 "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
4056
4057 /* --- overlay_bad_phandle --- */
4058
4059 unittest(overlay_data_apply("overlay_bad_phandle", NULL),
4060 "Adding overlay 'overlay_bad_phandle' failed\n");
4061
4062 /* --- overlay_bad_symbol --- */
4063
4064 EXPECT_BEGIN(KERN_ERR,
4065 "OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/hvac-medium-2:name");
4066 EXPECT_BEGIN(KERN_ERR,
4067 "OF: Error reverting changeset (-19)");
4068
4069 unittest(overlay_data_apply("overlay_bad_symbol", NULL),
4070 "Adding overlay 'overlay_bad_symbol' failed\n");
4071
4072 EXPECT_END(KERN_ERR,
4073 "OF: Error reverting changeset (-19)");
4074 EXPECT_END(KERN_ERR,
4075 "OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/hvac-medium-2:name");
4076
4077 /* --- overlay_bad_unresolved --- */
4078
4079 EXPECT_BEGIN(KERN_ERR,
4080 "OF: resolver: node label 'this_label_does_not_exist' not found in live devicetree symbols table");
4081 EXPECT_BEGIN(KERN_ERR,
4082 "OF: resolver: overlay phandle fixup failed: -22");
4083
4084 unittest(overlay_data_apply("overlay_bad_unresolved", NULL),
4085 "Adding overlay 'overlay_bad_unresolved' failed\n");
4086
4087 EXPECT_END(KERN_ERR,
4088 "OF: resolver: overlay phandle fixup failed: -22");
4089 EXPECT_END(KERN_ERR,
4090 "OF: resolver: node label 'this_label_does_not_exist' not found in live devicetree symbols table");
4091
4092 return;
4093
4094err_unlock:
4095 mutex_unlock(&of_mutex);
4096}
4097
4098static int of_unittest_pci_dev_num;
4099static int of_unittest_pci_child_num;
4100
4101/*
4102 * PCI device tree node test driver
4103 */
4104static const struct pci_device_id testdrv_pci_ids[] = {
4105 { PCI_DEVICE(PCI_VENDOR_ID_REDHAT, 0x5), }, /* PCI_VENDOR_ID_REDHAT */
4106 { 0, }
4107};
4108
4109static int testdrv_probe(struct pci_dev *pdev, const struct pci_device_id *id)
4110{
4111 struct overlay_info *info;
4112 struct device_node *dn;
4113 int ret, ovcs_id;
4114 u32 size;
4115
4116 dn = pdev->dev.of_node;
4117 if (!dn) {
4118 dev_err(&pdev->dev, "does not find bus endpoint");
4119 return -EINVAL;
4120 }
4121
4122 for (info = overlays; info && info->name; info++) {
4123 if (!strcmp(info->name, "overlay_pci_node"))
4124 break;
4125 }
4126 if (!info || !info->name) {
4127 dev_err(&pdev->dev, "no overlay data for overlay_pci_node");
4128 return -ENODEV;
4129 }
4130
4131 size = info->dtbo_end - info->dtbo_begin;
4132 ret = of_overlay_fdt_apply(info->dtbo_begin, size, &ovcs_id, dn);
4133 of_node_put(dn);
4134 if (ret)
4135 return ret;
4136
4137 of_platform_default_populate(dn, NULL, &pdev->dev);
4138 pci_set_drvdata(pdev, (void *)(uintptr_t)ovcs_id);
4139
4140 return 0;
4141}
4142
4143static void testdrv_remove(struct pci_dev *pdev)
4144{
4145 int ovcs_id = (int)(uintptr_t)pci_get_drvdata(pdev);
4146
4147 of_platform_depopulate(&pdev->dev);
4148 of_overlay_remove(&ovcs_id);
4149}
4150
4151static struct pci_driver testdrv_driver = {
4152 .name = "pci_dt_testdrv",
4153 .id_table = testdrv_pci_ids,
4154 .probe = testdrv_probe,
4155 .remove = testdrv_remove,
4156};
4157
4158static int unittest_pci_probe(struct platform_device *pdev)
4159{
4160 struct resource *res;
4161 struct device *dev;
4162 u64 exp_addr;
4163
4164 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
4165 if (!res)
4166 return -ENODEV;
4167
4168 dev = &pdev->dev;
4169 while (dev && !dev_is_pci(dev))
4170 dev = dev->parent;
4171 if (!dev) {
4172 pr_err("unable to find parent device\n");
4173 return -ENODEV;
4174 }
4175
4176 exp_addr = pci_resource_start(to_pci_dev(dev), 0) + 0x100;
4177 unittest(res->start == exp_addr, "Incorrect translated address %llx, expected %llx\n",
4178 (u64)res->start, exp_addr);
4179
4180 of_unittest_pci_child_num++;
4181
4182 return 0;
4183}
4184
4185static const struct of_device_id unittest_pci_of_match[] = {
4186 { .compatible = "unittest-pci" },
4187 { }
4188};
4189
4190static struct platform_driver unittest_pci_driver = {
4191 .probe = unittest_pci_probe,
4192 .driver = {
4193 .name = "unittest-pci",
4194 .of_match_table = unittest_pci_of_match,
4195 },
4196};
4197
4198static int of_unittest_pci_node_verify(struct pci_dev *pdev, bool add)
4199{
4200 struct device_node *pnp, *np = NULL;
4201 struct device *child_dev;
4202 char *path = NULL;
4203 const __be32 *reg;
4204 int rc = 0;
4205
4206 pnp = pdev->dev.of_node;
4207 unittest(pnp, "Failed creating PCI dt node\n");
4208 if (!pnp)
4209 return -ENODEV;
4210
4211 if (add) {
4212 path = kasprintf(GFP_KERNEL, "%pOF/pci-ep-bus@0/unittest-pci@100", pnp);
4213 np = of_find_node_by_path(path);
4214 unittest(np, "Failed to get unittest-pci node under PCI node\n");
4215 if (!np) {
4216 rc = -ENODEV;
4217 goto failed;
4218 }
4219
4220 reg = of_get_property(np, "reg", NULL);
4221 unittest(reg, "Failed to get reg property\n");
4222 if (!reg)
4223 rc = -ENODEV;
4224 } else {
4225 path = kasprintf(GFP_KERNEL, "%pOF/pci-ep-bus@0", pnp);
4226 np = of_find_node_by_path(path);
4227 unittest(!np, "Child device tree node is not removed\n");
4228 child_dev = device_find_any_child(&pdev->dev);
4229 unittest(!child_dev, "Child device is not removed\n");
4230 }
4231
4232failed:
4233 kfree(path);
4234 if (np)
4235 of_node_put(np);
4236
4237 return rc;
4238}
4239
4240static void __init of_unittest_pci_node(void)
4241{
4242 struct pci_dev *pdev = NULL;
4243 int rc;
4244
4245 if (!IS_ENABLED(CONFIG_PCI_DYNAMIC_OF_NODES))
4246 return;
4247
4248 rc = pci_register_driver(&testdrv_driver);
4249 unittest(!rc, "Failed to register pci test driver; rc = %d\n", rc);
4250 if (rc)
4251 return;
4252
4253 rc = platform_driver_register(&unittest_pci_driver);
4254 if (unittest(!rc, "Failed to register unittest pci driver\n")) {
4255 pci_unregister_driver(&testdrv_driver);
4256 return;
4257 }
4258
4259 while ((pdev = pci_get_device(PCI_VENDOR_ID_REDHAT, 0x5, pdev)) != NULL) {
4260 of_unittest_pci_node_verify(pdev, true);
4261 of_unittest_pci_dev_num++;
4262 }
4263 if (pdev)
4264 pci_dev_put(pdev);
4265
4266 unittest(of_unittest_pci_dev_num,
4267 "No test PCI device been found. Please run QEMU with '-device pci-testdev'\n");
4268 unittest(of_unittest_pci_dev_num == of_unittest_pci_child_num,
4269 "Child device number %d is not expected %d", of_unittest_pci_child_num,
4270 of_unittest_pci_dev_num);
4271
4272 platform_driver_unregister(&unittest_pci_driver);
4273 pci_unregister_driver(&testdrv_driver);
4274
4275 while ((pdev = pci_get_device(PCI_VENDOR_ID_REDHAT, 0x5, pdev)) != NULL)
4276 of_unittest_pci_node_verify(pdev, false);
4277 if (pdev)
4278 pci_dev_put(pdev);
4279}
4280#else
4281
4282static inline __init void of_unittest_overlay_high_level(void) {}
4283static inline __init void of_unittest_pci_node(void) { }
4284
4285#endif
4286
4287static int __init of_unittest(void)
4288{
4289 struct device_node *np;
4290 int res;
4291
4292 pr_info("start of unittest - you will see error messages\n");
4293
4294 /* Taint the kernel so we know we've run tests. */
4295 add_taint(TAINT_TEST, LOCKDEP_STILL_OK);
4296
4297 /* adding data for unittest */
4298 res = unittest_data_add();
4299 if (res)
4300 return res;
4301 if (!of_aliases)
4302 of_aliases = of_find_node_by_path("/aliases");
4303
4304 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
4305 if (!np) {
4306 pr_info("No testcase data in device tree; not running tests\n");
4307 return 0;
4308 }
4309 of_node_put(np);
4310
4311 of_unittest_check_tree_linkage();
4312 of_unittest_check_phandles();
4313 of_unittest_find_node_by_name();
4314 of_unittest_dynamic();
4315 of_unittest_parse_phandle_with_args();
4316 of_unittest_parse_phandle_with_args_map();
4317 of_unittest_printf();
4318 of_unittest_property_string();
4319 of_unittest_property_copy();
4320 of_unittest_changeset();
4321 of_unittest_changeset_prop();
4322 of_unittest_parse_interrupts();
4323 of_unittest_parse_interrupts_extended();
4324 of_unittest_dma_get_max_cpu_address();
4325 of_unittest_parse_dma_ranges();
4326 of_unittest_pci_dma_ranges();
4327 of_unittest_pci_empty_dma_ranges();
4328 of_unittest_bus_ranges();
4329 of_unittest_bus_3cell_ranges();
4330 of_unittest_reg();
4331 of_unittest_translate_addr();
4332 of_unittest_match_node();
4333 of_unittest_platform_populate();
4334 of_unittest_overlay();
4335 of_unittest_lifecycle();
4336 of_unittest_pci_node();
4337
4338 /* Double check linkage after removing testcase data */
4339 of_unittest_check_tree_linkage();
4340
4341 of_unittest_overlay_high_level();
4342
4343 pr_info("end of unittest - %i passed, %i failed\n",
4344 unittest_results.passed, unittest_results.failed);
4345
4346 return 0;
4347}
4348late_initcall(of_unittest);
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/bootmem.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_fdt.h>
16#include <linux/of_irq.h>
17#include <linux/of_platform.h>
18#include <linux/list.h>
19#include <linux/mutex.h>
20#include <linux/slab.h>
21#include <linux/device.h>
22#include <linux/platform_device.h>
23
24#include <linux/i2c.h>
25#include <linux/i2c-mux.h>
26
27#include <linux/bitops.h>
28
29#include "of_private.h"
30
31static struct unittest_results {
32 int passed;
33 int failed;
34} unittest_results;
35
36#define unittest(result, fmt, ...) ({ \
37 bool failed = !(result); \
38 if (failed) { \
39 unittest_results.failed++; \
40 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
41 } else { \
42 unittest_results.passed++; \
43 pr_debug("pass %s():%i\n", __func__, __LINE__); \
44 } \
45 failed; \
46})
47
48static void __init of_unittest_find_node_by_name(void)
49{
50 struct device_node *np;
51 const char *options, *name;
52
53 np = of_find_node_by_path("/testcase-data");
54 name = kasprintf(GFP_KERNEL, "%pOF", np);
55 unittest(np && !strcmp("/testcase-data", name),
56 "find /testcase-data failed\n");
57 of_node_put(np);
58 kfree(name);
59
60 /* Test if trailing '/' works */
61 np = of_find_node_by_path("/testcase-data/");
62 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
63
64 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
65 name = kasprintf(GFP_KERNEL, "%pOF", np);
66 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
67 "find /testcase-data/phandle-tests/consumer-a failed\n");
68 of_node_put(np);
69 kfree(name);
70
71 np = of_find_node_by_path("testcase-alias");
72 name = kasprintf(GFP_KERNEL, "%pOF", np);
73 unittest(np && !strcmp("/testcase-data", name),
74 "find testcase-alias failed\n");
75 of_node_put(np);
76 kfree(name);
77
78 /* Test if trailing '/' works on aliases */
79 np = of_find_node_by_path("testcase-alias/");
80 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
81
82 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
83 name = kasprintf(GFP_KERNEL, "%pOF", np);
84 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
85 "find testcase-alias/phandle-tests/consumer-a failed\n");
86 of_node_put(np);
87 kfree(name);
88
89 np = of_find_node_by_path("/testcase-data/missing-path");
90 unittest(!np, "non-existent path returned node %pOF\n", np);
91 of_node_put(np);
92
93 np = of_find_node_by_path("missing-alias");
94 unittest(!np, "non-existent alias returned node %pOF\n", np);
95 of_node_put(np);
96
97 np = of_find_node_by_path("testcase-alias/missing-path");
98 unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
99 of_node_put(np);
100
101 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
102 unittest(np && !strcmp("testoption", options),
103 "option path test failed\n");
104 of_node_put(np);
105
106 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
107 unittest(np && !strcmp("test/option", options),
108 "option path test, subcase #1 failed\n");
109 of_node_put(np);
110
111 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
112 unittest(np && !strcmp("test/option", options),
113 "option path test, subcase #2 failed\n");
114 of_node_put(np);
115
116 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
117 unittest(np, "NULL option path test failed\n");
118 of_node_put(np);
119
120 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
121 &options);
122 unittest(np && !strcmp("testaliasoption", options),
123 "option alias path test failed\n");
124 of_node_put(np);
125
126 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
127 &options);
128 unittest(np && !strcmp("test/alias/option", options),
129 "option alias path test, subcase #1 failed\n");
130 of_node_put(np);
131
132 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
133 unittest(np, "NULL option alias path test failed\n");
134 of_node_put(np);
135
136 options = "testoption";
137 np = of_find_node_opts_by_path("testcase-alias", &options);
138 unittest(np && !options, "option clearing test failed\n");
139 of_node_put(np);
140
141 options = "testoption";
142 np = of_find_node_opts_by_path("/", &options);
143 unittest(np && !options, "option clearing root node test failed\n");
144 of_node_put(np);
145}
146
147static void __init of_unittest_dynamic(void)
148{
149 struct device_node *np;
150 struct property *prop;
151
152 np = of_find_node_by_path("/testcase-data");
153 if (!np) {
154 pr_err("missing testcase data\n");
155 return;
156 }
157
158 /* Array of 4 properties for the purpose of testing */
159 prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL);
160 if (!prop) {
161 unittest(0, "kzalloc() failed\n");
162 return;
163 }
164
165 /* Add a new property - should pass*/
166 prop->name = "new-property";
167 prop->value = "new-property-data";
168 prop->length = strlen(prop->value);
169 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
170
171 /* Try to add an existing property - should fail */
172 prop++;
173 prop->name = "new-property";
174 prop->value = "new-property-data-should-fail";
175 prop->length = strlen(prop->value);
176 unittest(of_add_property(np, prop) != 0,
177 "Adding an existing property should have failed\n");
178
179 /* Try to modify an existing property - should pass */
180 prop->value = "modify-property-data-should-pass";
181 prop->length = strlen(prop->value);
182 unittest(of_update_property(np, prop) == 0,
183 "Updating an existing property should have passed\n");
184
185 /* Try to modify non-existent property - should pass*/
186 prop++;
187 prop->name = "modify-property";
188 prop->value = "modify-missing-property-data-should-pass";
189 prop->length = strlen(prop->value);
190 unittest(of_update_property(np, prop) == 0,
191 "Updating a missing property should have passed\n");
192
193 /* Remove property - should pass */
194 unittest(of_remove_property(np, prop) == 0,
195 "Removing a property should have passed\n");
196
197 /* Adding very large property - should pass */
198 prop++;
199 prop->name = "large-property-PAGE_SIZEx8";
200 prop->length = PAGE_SIZE * 8;
201 prop->value = kzalloc(prop->length, GFP_KERNEL);
202 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
203 if (prop->value)
204 unittest(of_add_property(np, prop) == 0,
205 "Adding a large property should have passed\n");
206}
207
208static int __init of_unittest_check_node_linkage(struct device_node *np)
209{
210 struct device_node *child;
211 int count = 0, rc;
212
213 for_each_child_of_node(np, child) {
214 if (child->parent != np) {
215 pr_err("Child node %s links to wrong parent %s\n",
216 child->name, np->name);
217 rc = -EINVAL;
218 goto put_child;
219 }
220
221 rc = of_unittest_check_node_linkage(child);
222 if (rc < 0)
223 goto put_child;
224 count += rc;
225 }
226
227 return count + 1;
228put_child:
229 of_node_put(child);
230 return rc;
231}
232
233static void __init of_unittest_check_tree_linkage(void)
234{
235 struct device_node *np;
236 int allnode_count = 0, child_count;
237
238 if (!of_root)
239 return;
240
241 for_each_of_allnodes(np)
242 allnode_count++;
243 child_count = of_unittest_check_node_linkage(of_root);
244
245 unittest(child_count > 0, "Device node data structure is corrupted\n");
246 unittest(child_count == allnode_count,
247 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
248 allnode_count, child_count);
249 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
250}
251
252static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
253 const char *expected)
254{
255 unsigned char *buf;
256 int buf_size;
257 int size, i;
258
259 buf_size = strlen(expected) + 10;
260 buf = kmalloc(buf_size, GFP_KERNEL);
261 if (!buf)
262 return;
263
264 /* Baseline; check conversion with a large size limit */
265 memset(buf, 0xff, buf_size);
266 size = snprintf(buf, buf_size - 2, fmt, np);
267
268 /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
269 unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
270 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
271 fmt, expected, buf);
272
273 /* Make sure length limits work */
274 size++;
275 for (i = 0; i < 2; i++, size--) {
276 /* Clear the buffer, and make sure it works correctly still */
277 memset(buf, 0xff, buf_size);
278 snprintf(buf, size+1, fmt, np);
279 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
280 "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
281 size, fmt, expected, buf);
282 }
283 kfree(buf);
284}
285
286static void __init of_unittest_printf(void)
287{
288 struct device_node *np;
289 const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
290 char phandle_str[16] = "";
291
292 np = of_find_node_by_path(full_name);
293 if (!np) {
294 unittest(np, "testcase data missing\n");
295 return;
296 }
297
298 num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
299
300 of_unittest_printf_one(np, "%pOF", full_name);
301 of_unittest_printf_one(np, "%pOFf", full_name);
302 of_unittest_printf_one(np, "%pOFp", phandle_str);
303 of_unittest_printf_one(np, "%pOFP", "dev@100");
304 of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
305 of_unittest_printf_one(np, "%10pOFP", " dev@100");
306 of_unittest_printf_one(np, "%-10pOFP", "dev@100 ");
307 of_unittest_printf_one(of_root, "%pOFP", "/");
308 of_unittest_printf_one(np, "%pOFF", "----");
309 of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
310 of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
311 of_unittest_printf_one(np, "%pOFc", "test-sub-device");
312 of_unittest_printf_one(np, "%pOFC",
313 "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
314}
315
316struct node_hash {
317 struct hlist_node node;
318 struct device_node *np;
319};
320
321static DEFINE_HASHTABLE(phandle_ht, 8);
322static void __init of_unittest_check_phandles(void)
323{
324 struct device_node *np;
325 struct node_hash *nh;
326 struct hlist_node *tmp;
327 int i, dup_count = 0, phandle_count = 0;
328
329 for_each_of_allnodes(np) {
330 if (!np->phandle)
331 continue;
332
333 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
334 if (nh->np->phandle == np->phandle) {
335 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
336 np->phandle, nh->np, np);
337 dup_count++;
338 break;
339 }
340 }
341
342 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
343 if (WARN_ON(!nh))
344 return;
345
346 nh->np = np;
347 hash_add(phandle_ht, &nh->node, np->phandle);
348 phandle_count++;
349 }
350 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
351 dup_count, phandle_count);
352
353 /* Clean up */
354 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
355 hash_del(&nh->node);
356 kfree(nh);
357 }
358}
359
360static void __init of_unittest_parse_phandle_with_args(void)
361{
362 struct device_node *np;
363 struct of_phandle_args args;
364 int i, rc;
365
366 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
367 if (!np) {
368 pr_err("missing testcase data\n");
369 return;
370 }
371
372 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
373 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
374
375 for (i = 0; i < 8; i++) {
376 bool passed = true;
377
378 rc = of_parse_phandle_with_args(np, "phandle-list",
379 "#phandle-cells", i, &args);
380
381 /* Test the values from tests-phandle.dtsi */
382 switch (i) {
383 case 0:
384 passed &= !rc;
385 passed &= (args.args_count == 1);
386 passed &= (args.args[0] == (i + 1));
387 break;
388 case 1:
389 passed &= !rc;
390 passed &= (args.args_count == 2);
391 passed &= (args.args[0] == (i + 1));
392 passed &= (args.args[1] == 0);
393 break;
394 case 2:
395 passed &= (rc == -ENOENT);
396 break;
397 case 3:
398 passed &= !rc;
399 passed &= (args.args_count == 3);
400 passed &= (args.args[0] == (i + 1));
401 passed &= (args.args[1] == 4);
402 passed &= (args.args[2] == 3);
403 break;
404 case 4:
405 passed &= !rc;
406 passed &= (args.args_count == 2);
407 passed &= (args.args[0] == (i + 1));
408 passed &= (args.args[1] == 100);
409 break;
410 case 5:
411 passed &= !rc;
412 passed &= (args.args_count == 0);
413 break;
414 case 6:
415 passed &= !rc;
416 passed &= (args.args_count == 1);
417 passed &= (args.args[0] == (i + 1));
418 break;
419 case 7:
420 passed &= (rc == -ENOENT);
421 break;
422 default:
423 passed = false;
424 }
425
426 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
427 i, args.np, rc);
428 }
429
430 /* Check for missing list property */
431 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
432 "#phandle-cells", 0, &args);
433 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
434 rc = of_count_phandle_with_args(np, "phandle-list-missing",
435 "#phandle-cells");
436 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
437
438 /* Check for missing cells property */
439 rc = of_parse_phandle_with_args(np, "phandle-list",
440 "#phandle-cells-missing", 0, &args);
441 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
442 rc = of_count_phandle_with_args(np, "phandle-list",
443 "#phandle-cells-missing");
444 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
445
446 /* Check for bad phandle in list */
447 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
448 "#phandle-cells", 0, &args);
449 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
450 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
451 "#phandle-cells");
452 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
453
454 /* Check for incorrectly formed argument list */
455 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
456 "#phandle-cells", 1, &args);
457 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
458 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
459 "#phandle-cells");
460 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
461}
462
463static void __init of_unittest_parse_phandle_with_args_map(void)
464{
465 struct device_node *np, *p0, *p1, *p2, *p3;
466 struct of_phandle_args args;
467 int i, rc;
468
469 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
470 if (!np) {
471 pr_err("missing testcase data\n");
472 return;
473 }
474
475 p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
476 if (!p0) {
477 pr_err("missing testcase data\n");
478 return;
479 }
480
481 p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
482 if (!p1) {
483 pr_err("missing testcase data\n");
484 return;
485 }
486
487 p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
488 if (!p2) {
489 pr_err("missing testcase data\n");
490 return;
491 }
492
493 p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
494 if (!p3) {
495 pr_err("missing testcase data\n");
496 return;
497 }
498
499 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
500 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
501
502 for (i = 0; i < 8; i++) {
503 bool passed = true;
504
505 rc = of_parse_phandle_with_args_map(np, "phandle-list",
506 "phandle", i, &args);
507
508 /* Test the values from tests-phandle.dtsi */
509 switch (i) {
510 case 0:
511 passed &= !rc;
512 passed &= (args.np == p1);
513 passed &= (args.args_count == 1);
514 passed &= (args.args[0] == 1);
515 break;
516 case 1:
517 passed &= !rc;
518 passed &= (args.np == p3);
519 passed &= (args.args_count == 3);
520 passed &= (args.args[0] == 2);
521 passed &= (args.args[1] == 5);
522 passed &= (args.args[2] == 3);
523 break;
524 case 2:
525 passed &= (rc == -ENOENT);
526 break;
527 case 3:
528 passed &= !rc;
529 passed &= (args.np == p0);
530 passed &= (args.args_count == 0);
531 break;
532 case 4:
533 passed &= !rc;
534 passed &= (args.np == p1);
535 passed &= (args.args_count == 1);
536 passed &= (args.args[0] == 3);
537 break;
538 case 5:
539 passed &= !rc;
540 passed &= (args.np == p0);
541 passed &= (args.args_count == 0);
542 break;
543 case 6:
544 passed &= !rc;
545 passed &= (args.np == p2);
546 passed &= (args.args_count == 2);
547 passed &= (args.args[0] == 15);
548 passed &= (args.args[1] == 0x20);
549 break;
550 case 7:
551 passed &= (rc == -ENOENT);
552 break;
553 default:
554 passed = false;
555 }
556
557 unittest(passed, "index %i - data error on node %s rc=%i\n",
558 i, args.np->full_name, rc);
559 }
560
561 /* Check for missing list property */
562 rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
563 "phandle", 0, &args);
564 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
565
566 /* Check for missing cells,map,mask property */
567 rc = of_parse_phandle_with_args_map(np, "phandle-list",
568 "phandle-missing", 0, &args);
569 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
570
571 /* Check for bad phandle in list */
572 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
573 "phandle", 0, &args);
574 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
575
576 /* Check for incorrectly formed argument list */
577 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
578 "phandle", 1, &args);
579 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
580}
581
582static void __init of_unittest_property_string(void)
583{
584 const char *strings[4];
585 struct device_node *np;
586 int rc;
587
588 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
589 if (!np) {
590 pr_err("No testcase data in device tree\n");
591 return;
592 }
593
594 rc = of_property_match_string(np, "phandle-list-names", "first");
595 unittest(rc == 0, "first expected:0 got:%i\n", rc);
596 rc = of_property_match_string(np, "phandle-list-names", "second");
597 unittest(rc == 1, "second expected:1 got:%i\n", rc);
598 rc = of_property_match_string(np, "phandle-list-names", "third");
599 unittest(rc == 2, "third expected:2 got:%i\n", rc);
600 rc = of_property_match_string(np, "phandle-list-names", "fourth");
601 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
602 rc = of_property_match_string(np, "missing-property", "blah");
603 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
604 rc = of_property_match_string(np, "empty-property", "blah");
605 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
606 rc = of_property_match_string(np, "unterminated-string", "blah");
607 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
608
609 /* of_property_count_strings() tests */
610 rc = of_property_count_strings(np, "string-property");
611 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
612 rc = of_property_count_strings(np, "phandle-list-names");
613 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
614 rc = of_property_count_strings(np, "unterminated-string");
615 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
616 rc = of_property_count_strings(np, "unterminated-string-list");
617 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
618
619 /* of_property_read_string_index() tests */
620 rc = of_property_read_string_index(np, "string-property", 0, strings);
621 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
622 strings[0] = NULL;
623 rc = of_property_read_string_index(np, "string-property", 1, strings);
624 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
625 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
626 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
627 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
628 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
629 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
630 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
631 strings[0] = NULL;
632 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
633 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
634 strings[0] = NULL;
635 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
636 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
637 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
638 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
639 strings[0] = NULL;
640 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
641 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
642 strings[1] = NULL;
643
644 /* of_property_read_string_array() tests */
645 rc = of_property_read_string_array(np, "string-property", strings, 4);
646 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
647 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
648 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
649 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
650 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
651 /* -- An incorrectly formed string should cause a failure */
652 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
653 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
654 /* -- parsing the correctly formed strings should still work: */
655 strings[2] = NULL;
656 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
657 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
658 strings[1] = NULL;
659 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
660 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
661}
662
663#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
664 (p1)->value && (p2)->value && \
665 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
666 !strcmp((p1)->name, (p2)->name))
667static void __init of_unittest_property_copy(void)
668{
669#ifdef CONFIG_OF_DYNAMIC
670 struct property p1 = { .name = "p1", .length = 0, .value = "" };
671 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
672 struct property *new;
673
674 new = __of_prop_dup(&p1, GFP_KERNEL);
675 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
676 kfree(new->value);
677 kfree(new->name);
678 kfree(new);
679
680 new = __of_prop_dup(&p2, GFP_KERNEL);
681 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
682 kfree(new->value);
683 kfree(new->name);
684 kfree(new);
685#endif
686}
687
688static void __init of_unittest_changeset(void)
689{
690#ifdef CONFIG_OF_DYNAMIC
691 struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
692 struct property *ppname_n1, pname_n1 = { .name = "name", .length = 3, .value = "n1" };
693 struct property *ppname_n2, pname_n2 = { .name = "name", .length = 3, .value = "n2" };
694 struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
695 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
696 struct property *ppremove;
697 struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
698 struct of_changeset chgset;
699
700 n1 = __of_node_dup(NULL, "n1");
701 unittest(n1, "testcase setup failure\n");
702
703 n2 = __of_node_dup(NULL, "n2");
704 unittest(n2, "testcase setup failure\n");
705
706 n21 = __of_node_dup(NULL, "n21");
707 unittest(n21, "testcase setup failure %p\n", n21);
708
709 nchangeset = of_find_node_by_path("/testcase-data/changeset");
710 nremove = of_get_child_by_name(nchangeset, "node-remove");
711 unittest(nremove, "testcase setup failure\n");
712
713 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
714 unittest(ppadd, "testcase setup failure\n");
715
716 ppname_n1 = __of_prop_dup(&pname_n1, GFP_KERNEL);
717 unittest(ppname_n1, "testcase setup failure\n");
718
719 ppname_n2 = __of_prop_dup(&pname_n2, GFP_KERNEL);
720 unittest(ppname_n2, "testcase setup failure\n");
721
722 ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
723 unittest(ppname_n21, "testcase setup failure\n");
724
725 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
726 unittest(ppupdate, "testcase setup failure\n");
727
728 parent = nchangeset;
729 n1->parent = parent;
730 n2->parent = parent;
731 n21->parent = n2;
732
733 ppremove = of_find_property(parent, "prop-remove", NULL);
734 unittest(ppremove, "failed to find removal prop");
735
736 of_changeset_init(&chgset);
737
738 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
739 unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
740
741 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
742 unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
743
744 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
745 unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
746
747 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
748
749 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
750 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
751 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
752
753 unittest(!of_changeset_apply(&chgset), "apply failed\n");
754
755 of_node_put(nchangeset);
756
757 /* Make sure node names are constructed correctly */
758 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
759 "'%pOF' not added\n", n21);
760 of_node_put(np);
761
762 unittest(!of_changeset_revert(&chgset), "revert failed\n");
763
764 of_changeset_destroy(&chgset);
765#endif
766}
767
768static void __init of_unittest_parse_interrupts(void)
769{
770 struct device_node *np;
771 struct of_phandle_args args;
772 int i, rc;
773
774 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
775 if (!np) {
776 pr_err("missing testcase data\n");
777 return;
778 }
779
780 for (i = 0; i < 4; i++) {
781 bool passed = true;
782
783 args.args_count = 0;
784 rc = of_irq_parse_one(np, i, &args);
785
786 passed &= !rc;
787 passed &= (args.args_count == 1);
788 passed &= (args.args[0] == (i + 1));
789
790 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
791 i, args.np, rc);
792 }
793 of_node_put(np);
794
795 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
796 if (!np) {
797 pr_err("missing testcase data\n");
798 return;
799 }
800
801 for (i = 0; i < 4; i++) {
802 bool passed = true;
803
804 args.args_count = 0;
805 rc = of_irq_parse_one(np, i, &args);
806
807 /* Test the values from tests-phandle.dtsi */
808 switch (i) {
809 case 0:
810 passed &= !rc;
811 passed &= (args.args_count == 1);
812 passed &= (args.args[0] == 9);
813 break;
814 case 1:
815 passed &= !rc;
816 passed &= (args.args_count == 3);
817 passed &= (args.args[0] == 10);
818 passed &= (args.args[1] == 11);
819 passed &= (args.args[2] == 12);
820 break;
821 case 2:
822 passed &= !rc;
823 passed &= (args.args_count == 2);
824 passed &= (args.args[0] == 13);
825 passed &= (args.args[1] == 14);
826 break;
827 case 3:
828 passed &= !rc;
829 passed &= (args.args_count == 2);
830 passed &= (args.args[0] == 15);
831 passed &= (args.args[1] == 16);
832 break;
833 default:
834 passed = false;
835 }
836 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
837 i, args.np, rc);
838 }
839 of_node_put(np);
840}
841
842static void __init of_unittest_parse_interrupts_extended(void)
843{
844 struct device_node *np;
845 struct of_phandle_args args;
846 int i, rc;
847
848 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
849 if (!np) {
850 pr_err("missing testcase data\n");
851 return;
852 }
853
854 for (i = 0; i < 7; i++) {
855 bool passed = true;
856
857 rc = of_irq_parse_one(np, i, &args);
858
859 /* Test the values from tests-phandle.dtsi */
860 switch (i) {
861 case 0:
862 passed &= !rc;
863 passed &= (args.args_count == 1);
864 passed &= (args.args[0] == 1);
865 break;
866 case 1:
867 passed &= !rc;
868 passed &= (args.args_count == 3);
869 passed &= (args.args[0] == 2);
870 passed &= (args.args[1] == 3);
871 passed &= (args.args[2] == 4);
872 break;
873 case 2:
874 passed &= !rc;
875 passed &= (args.args_count == 2);
876 passed &= (args.args[0] == 5);
877 passed &= (args.args[1] == 6);
878 break;
879 case 3:
880 passed &= !rc;
881 passed &= (args.args_count == 1);
882 passed &= (args.args[0] == 9);
883 break;
884 case 4:
885 passed &= !rc;
886 passed &= (args.args_count == 3);
887 passed &= (args.args[0] == 10);
888 passed &= (args.args[1] == 11);
889 passed &= (args.args[2] == 12);
890 break;
891 case 5:
892 passed &= !rc;
893 passed &= (args.args_count == 2);
894 passed &= (args.args[0] == 13);
895 passed &= (args.args[1] == 14);
896 break;
897 case 6:
898 passed &= !rc;
899 passed &= (args.args_count == 1);
900 passed &= (args.args[0] == 15);
901 break;
902 default:
903 passed = false;
904 }
905
906 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
907 i, args.np, rc);
908 }
909 of_node_put(np);
910}
911
912static const struct of_device_id match_node_table[] = {
913 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
914 { .data = "B", .type = "type1", }, /* followed by type alone */
915
916 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
917 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
918 { .data = "Cc", .name = "name2", .type = "type2", },
919
920 { .data = "E", .compatible = "compat3" },
921 { .data = "G", .compatible = "compat2", },
922 { .data = "H", .compatible = "compat2", .name = "name5", },
923 { .data = "I", .compatible = "compat2", .type = "type1", },
924 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
925 { .data = "K", .compatible = "compat2", .name = "name9", },
926 {}
927};
928
929static struct {
930 const char *path;
931 const char *data;
932} match_node_tests[] = {
933 { .path = "/testcase-data/match-node/name0", .data = "A", },
934 { .path = "/testcase-data/match-node/name1", .data = "B", },
935 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
936 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
937 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
938 { .path = "/testcase-data/match-node/name3", .data = "E", },
939 { .path = "/testcase-data/match-node/name4", .data = "G", },
940 { .path = "/testcase-data/match-node/name5", .data = "H", },
941 { .path = "/testcase-data/match-node/name6", .data = "G", },
942 { .path = "/testcase-data/match-node/name7", .data = "I", },
943 { .path = "/testcase-data/match-node/name8", .data = "J", },
944 { .path = "/testcase-data/match-node/name9", .data = "K", },
945};
946
947static void __init of_unittest_match_node(void)
948{
949 struct device_node *np;
950 const struct of_device_id *match;
951 int i;
952
953 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
954 np = of_find_node_by_path(match_node_tests[i].path);
955 if (!np) {
956 unittest(0, "missing testcase node %s\n",
957 match_node_tests[i].path);
958 continue;
959 }
960
961 match = of_match_node(match_node_table, np);
962 if (!match) {
963 unittest(0, "%s didn't match anything\n",
964 match_node_tests[i].path);
965 continue;
966 }
967
968 if (strcmp(match->data, match_node_tests[i].data) != 0) {
969 unittest(0, "%s got wrong match. expected %s, got %s\n",
970 match_node_tests[i].path, match_node_tests[i].data,
971 (const char *)match->data);
972 continue;
973 }
974 unittest(1, "passed");
975 }
976}
977
978static struct resource test_bus_res = {
979 .start = 0xfffffff8,
980 .end = 0xfffffff9,
981 .flags = IORESOURCE_MEM,
982};
983static const struct platform_device_info test_bus_info = {
984 .name = "unittest-bus",
985};
986static void __init of_unittest_platform_populate(void)
987{
988 int irq, rc;
989 struct device_node *np, *child, *grandchild;
990 struct platform_device *pdev, *test_bus;
991 const struct of_device_id match[] = {
992 { .compatible = "test-device", },
993 {}
994 };
995
996 np = of_find_node_by_path("/testcase-data");
997 of_platform_default_populate(np, NULL, NULL);
998
999 /* Test that a missing irq domain returns -EPROBE_DEFER */
1000 np = of_find_node_by_path("/testcase-data/testcase-device1");
1001 pdev = of_find_device_by_node(np);
1002 unittest(pdev, "device 1 creation failed\n");
1003
1004 irq = platform_get_irq(pdev, 0);
1005 unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq);
1006
1007 /* Test that a parsing failure does not return -EPROBE_DEFER */
1008 np = of_find_node_by_path("/testcase-data/testcase-device2");
1009 pdev = of_find_device_by_node(np);
1010 unittest(pdev, "device 2 creation failed\n");
1011 irq = platform_get_irq(pdev, 0);
1012 unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq);
1013
1014 np = of_find_node_by_path("/testcase-data/platform-tests");
1015 unittest(np, "No testcase data in device tree\n");
1016 if (!np)
1017 return;
1018
1019 test_bus = platform_device_register_full(&test_bus_info);
1020 rc = PTR_ERR_OR_ZERO(test_bus);
1021 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1022 if (rc)
1023 return;
1024 test_bus->dev.of_node = np;
1025
1026 /*
1027 * Add a dummy resource to the test bus node after it is
1028 * registered to catch problems with un-inserted resources. The
1029 * DT code doesn't insert the resources, and it has caused the
1030 * kernel to oops in the past. This makes sure the same bug
1031 * doesn't crop up again.
1032 */
1033 platform_device_add_resources(test_bus, &test_bus_res, 1);
1034
1035 of_platform_populate(np, match, NULL, &test_bus->dev);
1036 for_each_child_of_node(np, child) {
1037 for_each_child_of_node(child, grandchild)
1038 unittest(of_find_device_by_node(grandchild),
1039 "Could not create device for node '%s'\n",
1040 grandchild->name);
1041 }
1042
1043 of_platform_depopulate(&test_bus->dev);
1044 for_each_child_of_node(np, child) {
1045 for_each_child_of_node(child, grandchild)
1046 unittest(!of_find_device_by_node(grandchild),
1047 "device didn't get destroyed '%s'\n",
1048 grandchild->name);
1049 }
1050
1051 platform_device_unregister(test_bus);
1052 of_node_put(np);
1053}
1054
1055/**
1056 * update_node_properties - adds the properties
1057 * of np into dup node (present in live tree) and
1058 * updates parent of children of np to dup.
1059 *
1060 * @np: node already present in live tree
1061 * @dup: node present in live tree to be updated
1062 */
1063static void update_node_properties(struct device_node *np,
1064 struct device_node *dup)
1065{
1066 struct property *prop;
1067 struct device_node *child;
1068
1069 for_each_property_of_node(np, prop)
1070 of_add_property(dup, prop);
1071
1072 for_each_child_of_node(np, child)
1073 child->parent = dup;
1074}
1075
1076/**
1077 * attach_node_and_children - attaches nodes
1078 * and its children to live tree
1079 *
1080 * @np: Node to attach to live tree
1081 */
1082static int attach_node_and_children(struct device_node *np)
1083{
1084 struct device_node *next, *dup, *child;
1085 unsigned long flags;
1086 const char *full_name;
1087
1088 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1089 dup = of_find_node_by_path(full_name);
1090 kfree(full_name);
1091 if (dup) {
1092 update_node_properties(np, dup);
1093 return 0;
1094 }
1095
1096 child = np->child;
1097 np->child = NULL;
1098
1099 mutex_lock(&of_mutex);
1100 raw_spin_lock_irqsave(&devtree_lock, flags);
1101 np->sibling = np->parent->child;
1102 np->parent->child = np;
1103 of_node_clear_flag(np, OF_DETACHED);
1104 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1105
1106 __of_attach_node_sysfs(np);
1107 mutex_unlock(&of_mutex);
1108
1109 while (child) {
1110 next = child->sibling;
1111 attach_node_and_children(child);
1112 child = next;
1113 }
1114
1115 return 0;
1116}
1117
1118/**
1119 * unittest_data_add - Reads, copies data from
1120 * linked tree and attaches it to the live tree
1121 */
1122static int __init unittest_data_add(void)
1123{
1124 void *unittest_data;
1125 struct device_node *unittest_data_node, *np;
1126 /*
1127 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1128 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1129 */
1130 extern uint8_t __dtb_testcases_begin[];
1131 extern uint8_t __dtb_testcases_end[];
1132 const int size = __dtb_testcases_end - __dtb_testcases_begin;
1133 int rc;
1134
1135 if (!size) {
1136 pr_warn("%s: No testcase data to attach; not running tests\n",
1137 __func__);
1138 return -ENODATA;
1139 }
1140
1141 /* creating copy */
1142 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1143
1144 if (!unittest_data) {
1145 pr_warn("%s: Failed to allocate memory for unittest_data; "
1146 "not running tests\n", __func__);
1147 return -ENOMEM;
1148 }
1149 of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1150 if (!unittest_data_node) {
1151 pr_warn("%s: No tree to attach; not running tests\n", __func__);
1152 return -ENODATA;
1153 }
1154
1155 /*
1156 * This lock normally encloses of_resolve_phandles()
1157 */
1158 of_overlay_mutex_lock();
1159
1160 rc = of_resolve_phandles(unittest_data_node);
1161 if (rc) {
1162 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1163 of_overlay_mutex_unlock();
1164 return -EINVAL;
1165 }
1166
1167 if (!of_root) {
1168 of_root = unittest_data_node;
1169 for_each_of_allnodes(np)
1170 __of_attach_node_sysfs(np);
1171 of_aliases = of_find_node_by_path("/aliases");
1172 of_chosen = of_find_node_by_path("/chosen");
1173 of_overlay_mutex_unlock();
1174 return 0;
1175 }
1176
1177 /* attach the sub-tree to live tree */
1178 np = unittest_data_node->child;
1179 while (np) {
1180 struct device_node *next = np->sibling;
1181
1182 np->parent = of_root;
1183 attach_node_and_children(np);
1184 np = next;
1185 }
1186
1187 of_overlay_mutex_unlock();
1188
1189 return 0;
1190}
1191
1192#ifdef CONFIG_OF_OVERLAY
1193static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1194
1195static int unittest_probe(struct platform_device *pdev)
1196{
1197 struct device *dev = &pdev->dev;
1198 struct device_node *np = dev->of_node;
1199
1200 if (np == NULL) {
1201 dev_err(dev, "No OF data for device\n");
1202 return -EINVAL;
1203
1204 }
1205
1206 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1207
1208 of_platform_populate(np, NULL, NULL, &pdev->dev);
1209
1210 return 0;
1211}
1212
1213static int unittest_remove(struct platform_device *pdev)
1214{
1215 struct device *dev = &pdev->dev;
1216 struct device_node *np = dev->of_node;
1217
1218 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1219 return 0;
1220}
1221
1222static const struct of_device_id unittest_match[] = {
1223 { .compatible = "unittest", },
1224 {},
1225};
1226
1227static struct platform_driver unittest_driver = {
1228 .probe = unittest_probe,
1229 .remove = unittest_remove,
1230 .driver = {
1231 .name = "unittest",
1232 .of_match_table = of_match_ptr(unittest_match),
1233 },
1234};
1235
1236/* get the platform device instantiated at the path */
1237static struct platform_device *of_path_to_platform_device(const char *path)
1238{
1239 struct device_node *np;
1240 struct platform_device *pdev;
1241
1242 np = of_find_node_by_path(path);
1243 if (np == NULL)
1244 return NULL;
1245
1246 pdev = of_find_device_by_node(np);
1247 of_node_put(np);
1248
1249 return pdev;
1250}
1251
1252/* find out if a platform device exists at that path */
1253static int of_path_platform_device_exists(const char *path)
1254{
1255 struct platform_device *pdev;
1256
1257 pdev = of_path_to_platform_device(path);
1258 platform_device_put(pdev);
1259 return pdev != NULL;
1260}
1261
1262#if IS_BUILTIN(CONFIG_I2C)
1263
1264/* get the i2c client device instantiated at the path */
1265static struct i2c_client *of_path_to_i2c_client(const char *path)
1266{
1267 struct device_node *np;
1268 struct i2c_client *client;
1269
1270 np = of_find_node_by_path(path);
1271 if (np == NULL)
1272 return NULL;
1273
1274 client = of_find_i2c_device_by_node(np);
1275 of_node_put(np);
1276
1277 return client;
1278}
1279
1280/* find out if a i2c client device exists at that path */
1281static int of_path_i2c_client_exists(const char *path)
1282{
1283 struct i2c_client *client;
1284
1285 client = of_path_to_i2c_client(path);
1286 if (client)
1287 put_device(&client->dev);
1288 return client != NULL;
1289}
1290#else
1291static int of_path_i2c_client_exists(const char *path)
1292{
1293 return 0;
1294}
1295#endif
1296
1297enum overlay_type {
1298 PDEV_OVERLAY,
1299 I2C_OVERLAY
1300};
1301
1302static int of_path_device_type_exists(const char *path,
1303 enum overlay_type ovtype)
1304{
1305 switch (ovtype) {
1306 case PDEV_OVERLAY:
1307 return of_path_platform_device_exists(path);
1308 case I2C_OVERLAY:
1309 return of_path_i2c_client_exists(path);
1310 }
1311 return 0;
1312}
1313
1314static const char *unittest_path(int nr, enum overlay_type ovtype)
1315{
1316 const char *base;
1317 static char buf[256];
1318
1319 switch (ovtype) {
1320 case PDEV_OVERLAY:
1321 base = "/testcase-data/overlay-node/test-bus";
1322 break;
1323 case I2C_OVERLAY:
1324 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1325 break;
1326 default:
1327 buf[0] = '\0';
1328 return buf;
1329 }
1330 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1331 buf[sizeof(buf) - 1] = '\0';
1332 return buf;
1333}
1334
1335static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1336{
1337 const char *path;
1338
1339 path = unittest_path(unittest_nr, ovtype);
1340
1341 switch (ovtype) {
1342 case PDEV_OVERLAY:
1343 return of_path_platform_device_exists(path);
1344 case I2C_OVERLAY:
1345 return of_path_i2c_client_exists(path);
1346 }
1347 return 0;
1348}
1349
1350static const char *overlay_name_from_nr(int nr)
1351{
1352 static char buf[256];
1353
1354 snprintf(buf, sizeof(buf) - 1,
1355 "overlay_%d", nr);
1356 buf[sizeof(buf) - 1] = '\0';
1357
1358 return buf;
1359}
1360
1361static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1362
1363/* it is guaranteed that overlay ids are assigned in sequence */
1364#define MAX_UNITTEST_OVERLAYS 256
1365static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1366static int overlay_first_id = -1;
1367
1368static void of_unittest_track_overlay(int id)
1369{
1370 if (overlay_first_id < 0)
1371 overlay_first_id = id;
1372 id -= overlay_first_id;
1373
1374 /* we shouldn't need that many */
1375 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1376 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1377}
1378
1379static void of_unittest_untrack_overlay(int id)
1380{
1381 if (overlay_first_id < 0)
1382 return;
1383 id -= overlay_first_id;
1384 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1385 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1386}
1387
1388static void of_unittest_destroy_tracked_overlays(void)
1389{
1390 int id, ret, defers, ovcs_id;
1391
1392 if (overlay_first_id < 0)
1393 return;
1394
1395 /* try until no defers */
1396 do {
1397 defers = 0;
1398 /* remove in reverse order */
1399 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1400 if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1401 continue;
1402
1403 ovcs_id = id + overlay_first_id;
1404 ret = of_overlay_remove(&ovcs_id);
1405 if (ret == -ENODEV) {
1406 pr_warn("%s: no overlay to destroy for #%d\n",
1407 __func__, id + overlay_first_id);
1408 continue;
1409 }
1410 if (ret != 0) {
1411 defers++;
1412 pr_warn("%s: overlay destroy failed for #%d\n",
1413 __func__, id + overlay_first_id);
1414 continue;
1415 }
1416
1417 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1418 }
1419 } while (defers > 0);
1420}
1421
1422static int __init of_unittest_apply_overlay(int overlay_nr, int unittest_nr,
1423 int *overlay_id)
1424{
1425 const char *overlay_name;
1426
1427 overlay_name = overlay_name_from_nr(overlay_nr);
1428
1429 if (!overlay_data_apply(overlay_name, overlay_id)) {
1430 unittest(0, "could not apply overlay \"%s\"\n",
1431 overlay_name);
1432 return -EFAULT;
1433 }
1434 of_unittest_track_overlay(*overlay_id);
1435
1436 return 0;
1437}
1438
1439/* apply an overlay while checking before and after states */
1440static int __init of_unittest_apply_overlay_check(int overlay_nr,
1441 int unittest_nr, int before, int after,
1442 enum overlay_type ovtype)
1443{
1444 int ret, ovcs_id;
1445
1446 /* unittest device must not be in before state */
1447 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1448 unittest(0, "%s with device @\"%s\" %s\n",
1449 overlay_name_from_nr(overlay_nr),
1450 unittest_path(unittest_nr, ovtype),
1451 !before ? "enabled" : "disabled");
1452 return -EINVAL;
1453 }
1454
1455 ovcs_id = 0;
1456 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1457 if (ret != 0) {
1458 /* of_unittest_apply_overlay already called unittest() */
1459 return ret;
1460 }
1461
1462 /* unittest device must be to set to after state */
1463 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1464 unittest(0, "%s failed to create @\"%s\" %s\n",
1465 overlay_name_from_nr(overlay_nr),
1466 unittest_path(unittest_nr, ovtype),
1467 !after ? "enabled" : "disabled");
1468 return -EINVAL;
1469 }
1470
1471 return 0;
1472}
1473
1474/* apply an overlay and then revert it while checking before, after states */
1475static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1476 int unittest_nr, int before, int after,
1477 enum overlay_type ovtype)
1478{
1479 int ret, ovcs_id;
1480
1481 /* unittest device must be in before state */
1482 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1483 unittest(0, "%s with device @\"%s\" %s\n",
1484 overlay_name_from_nr(overlay_nr),
1485 unittest_path(unittest_nr, ovtype),
1486 !before ? "enabled" : "disabled");
1487 return -EINVAL;
1488 }
1489
1490 /* apply the overlay */
1491 ovcs_id = 0;
1492 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1493 if (ret != 0) {
1494 /* of_unittest_apply_overlay already called unittest() */
1495 return ret;
1496 }
1497
1498 /* unittest device must be in after state */
1499 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1500 unittest(0, "%s failed to create @\"%s\" %s\n",
1501 overlay_name_from_nr(overlay_nr),
1502 unittest_path(unittest_nr, ovtype),
1503 !after ? "enabled" : "disabled");
1504 return -EINVAL;
1505 }
1506
1507 ret = of_overlay_remove(&ovcs_id);
1508 if (ret != 0) {
1509 unittest(0, "%s failed to be destroyed @\"%s\"\n",
1510 overlay_name_from_nr(overlay_nr),
1511 unittest_path(unittest_nr, ovtype));
1512 return ret;
1513 }
1514
1515 /* unittest device must be again in before state */
1516 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1517 unittest(0, "%s with device @\"%s\" %s\n",
1518 overlay_name_from_nr(overlay_nr),
1519 unittest_path(unittest_nr, ovtype),
1520 !before ? "enabled" : "disabled");
1521 return -EINVAL;
1522 }
1523
1524 return 0;
1525}
1526
1527/* test activation of device */
1528static void __init of_unittest_overlay_0(void)
1529{
1530 /* device should enable */
1531 if (of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY))
1532 return;
1533
1534 unittest(1, "overlay test %d passed\n", 0);
1535}
1536
1537/* test deactivation of device */
1538static void __init of_unittest_overlay_1(void)
1539{
1540 /* device should disable */
1541 if (of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY))
1542 return;
1543
1544 unittest(1, "overlay test %d passed\n", 1);
1545}
1546
1547/* test activation of device */
1548static void __init of_unittest_overlay_2(void)
1549{
1550 /* device should enable */
1551 if (of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY))
1552 return;
1553
1554 unittest(1, "overlay test %d passed\n", 2);
1555}
1556
1557/* test deactivation of device */
1558static void __init of_unittest_overlay_3(void)
1559{
1560 /* device should disable */
1561 if (of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY))
1562 return;
1563
1564 unittest(1, "overlay test %d passed\n", 3);
1565}
1566
1567/* test activation of a full device node */
1568static void __init of_unittest_overlay_4(void)
1569{
1570 /* device should disable */
1571 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
1572 return;
1573
1574 unittest(1, "overlay test %d passed\n", 4);
1575}
1576
1577/* test overlay apply/revert sequence */
1578static void __init of_unittest_overlay_5(void)
1579{
1580 /* device should disable */
1581 if (of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY))
1582 return;
1583
1584 unittest(1, "overlay test %d passed\n", 5);
1585}
1586
1587/* test overlay application in sequence */
1588static void __init of_unittest_overlay_6(void)
1589{
1590 int i, ov_id[2], ovcs_id;
1591 int overlay_nr = 6, unittest_nr = 6;
1592 int before = 0, after = 1;
1593 const char *overlay_name;
1594
1595 /* unittest device must be in before state */
1596 for (i = 0; i < 2; i++) {
1597 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1598 != before) {
1599 unittest(0, "%s with device @\"%s\" %s\n",
1600 overlay_name_from_nr(overlay_nr + i),
1601 unittest_path(unittest_nr + i,
1602 PDEV_OVERLAY),
1603 !before ? "enabled" : "disabled");
1604 return;
1605 }
1606 }
1607
1608 /* apply the overlays */
1609 for (i = 0; i < 2; i++) {
1610
1611 overlay_name = overlay_name_from_nr(overlay_nr + i);
1612
1613 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1614 unittest(0, "could not apply overlay \"%s\"\n",
1615 overlay_name);
1616 return;
1617 }
1618 ov_id[i] = ovcs_id;
1619 of_unittest_track_overlay(ov_id[i]);
1620 }
1621
1622 for (i = 0; i < 2; i++) {
1623 /* unittest device must be in after state */
1624 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1625 != after) {
1626 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1627 overlay_name_from_nr(overlay_nr + i),
1628 unittest_path(unittest_nr + i,
1629 PDEV_OVERLAY),
1630 !after ? "enabled" : "disabled");
1631 return;
1632 }
1633 }
1634
1635 for (i = 1; i >= 0; i--) {
1636 ovcs_id = ov_id[i];
1637 if (of_overlay_remove(&ovcs_id)) {
1638 unittest(0, "%s failed destroy @\"%s\"\n",
1639 overlay_name_from_nr(overlay_nr + i),
1640 unittest_path(unittest_nr + i,
1641 PDEV_OVERLAY));
1642 return;
1643 }
1644 of_unittest_untrack_overlay(ov_id[i]);
1645 }
1646
1647 for (i = 0; i < 2; i++) {
1648 /* unittest device must be again in before state */
1649 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1650 != before) {
1651 unittest(0, "%s with device @\"%s\" %s\n",
1652 overlay_name_from_nr(overlay_nr + i),
1653 unittest_path(unittest_nr + i,
1654 PDEV_OVERLAY),
1655 !before ? "enabled" : "disabled");
1656 return;
1657 }
1658 }
1659
1660 unittest(1, "overlay test %d passed\n", 6);
1661}
1662
1663/* test overlay application in sequence */
1664static void __init of_unittest_overlay_8(void)
1665{
1666 int i, ov_id[2], ovcs_id;
1667 int overlay_nr = 8, unittest_nr = 8;
1668 const char *overlay_name;
1669
1670 /* we don't care about device state in this test */
1671
1672 /* apply the overlays */
1673 for (i = 0; i < 2; i++) {
1674
1675 overlay_name = overlay_name_from_nr(overlay_nr + i);
1676
1677 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1678 unittest(0, "could not apply overlay \"%s\"\n",
1679 overlay_name);
1680 return;
1681 }
1682 ov_id[i] = ovcs_id;
1683 of_unittest_track_overlay(ov_id[i]);
1684 }
1685
1686 /* now try to remove first overlay (it should fail) */
1687 ovcs_id = ov_id[0];
1688 if (!of_overlay_remove(&ovcs_id)) {
1689 unittest(0, "%s was destroyed @\"%s\"\n",
1690 overlay_name_from_nr(overlay_nr + 0),
1691 unittest_path(unittest_nr,
1692 PDEV_OVERLAY));
1693 return;
1694 }
1695
1696 /* removing them in order should work */
1697 for (i = 1; i >= 0; i--) {
1698 ovcs_id = ov_id[i];
1699 if (of_overlay_remove(&ovcs_id)) {
1700 unittest(0, "%s not destroyed @\"%s\"\n",
1701 overlay_name_from_nr(overlay_nr + i),
1702 unittest_path(unittest_nr,
1703 PDEV_OVERLAY));
1704 return;
1705 }
1706 of_unittest_untrack_overlay(ov_id[i]);
1707 }
1708
1709 unittest(1, "overlay test %d passed\n", 8);
1710}
1711
1712/* test insertion of a bus with parent devices */
1713static void __init of_unittest_overlay_10(void)
1714{
1715 int ret;
1716 char *child_path;
1717
1718 /* device should disable */
1719 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1720 if (unittest(ret == 0,
1721 "overlay test %d failed; overlay application\n", 10))
1722 return;
1723
1724 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1725 unittest_path(10, PDEV_OVERLAY));
1726 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1727 return;
1728
1729 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1730 kfree(child_path);
1731
1732 unittest(ret, "overlay test %d failed; no child device\n", 10);
1733}
1734
1735/* test insertion of a bus with parent devices (and revert) */
1736static void __init of_unittest_overlay_11(void)
1737{
1738 int ret;
1739
1740 /* device should disable */
1741 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1742 PDEV_OVERLAY);
1743 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
1744}
1745
1746#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1747
1748struct unittest_i2c_bus_data {
1749 struct platform_device *pdev;
1750 struct i2c_adapter adap;
1751};
1752
1753static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1754 struct i2c_msg *msgs, int num)
1755{
1756 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1757
1758 (void)std;
1759
1760 return num;
1761}
1762
1763static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1764{
1765 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1766}
1767
1768static const struct i2c_algorithm unittest_i2c_algo = {
1769 .master_xfer = unittest_i2c_master_xfer,
1770 .functionality = unittest_i2c_functionality,
1771};
1772
1773static int unittest_i2c_bus_probe(struct platform_device *pdev)
1774{
1775 struct device *dev = &pdev->dev;
1776 struct device_node *np = dev->of_node;
1777 struct unittest_i2c_bus_data *std;
1778 struct i2c_adapter *adap;
1779 int ret;
1780
1781 if (np == NULL) {
1782 dev_err(dev, "No OF data for device\n");
1783 return -EINVAL;
1784
1785 }
1786
1787 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1788
1789 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1790 if (!std) {
1791 dev_err(dev, "Failed to allocate unittest i2c data\n");
1792 return -ENOMEM;
1793 }
1794
1795 /* link them together */
1796 std->pdev = pdev;
1797 platform_set_drvdata(pdev, std);
1798
1799 adap = &std->adap;
1800 i2c_set_adapdata(adap, std);
1801 adap->nr = -1;
1802 strlcpy(adap->name, pdev->name, sizeof(adap->name));
1803 adap->class = I2C_CLASS_DEPRECATED;
1804 adap->algo = &unittest_i2c_algo;
1805 adap->dev.parent = dev;
1806 adap->dev.of_node = dev->of_node;
1807 adap->timeout = 5 * HZ;
1808 adap->retries = 3;
1809
1810 ret = i2c_add_numbered_adapter(adap);
1811 if (ret != 0) {
1812 dev_err(dev, "Failed to add I2C adapter\n");
1813 return ret;
1814 }
1815
1816 return 0;
1817}
1818
1819static int unittest_i2c_bus_remove(struct platform_device *pdev)
1820{
1821 struct device *dev = &pdev->dev;
1822 struct device_node *np = dev->of_node;
1823 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1824
1825 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1826 i2c_del_adapter(&std->adap);
1827
1828 return 0;
1829}
1830
1831static const struct of_device_id unittest_i2c_bus_match[] = {
1832 { .compatible = "unittest-i2c-bus", },
1833 {},
1834};
1835
1836static struct platform_driver unittest_i2c_bus_driver = {
1837 .probe = unittest_i2c_bus_probe,
1838 .remove = unittest_i2c_bus_remove,
1839 .driver = {
1840 .name = "unittest-i2c-bus",
1841 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1842 },
1843};
1844
1845static int unittest_i2c_dev_probe(struct i2c_client *client,
1846 const struct i2c_device_id *id)
1847{
1848 struct device *dev = &client->dev;
1849 struct device_node *np = client->dev.of_node;
1850
1851 if (!np) {
1852 dev_err(dev, "No OF node\n");
1853 return -EINVAL;
1854 }
1855
1856 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1857
1858 return 0;
1859};
1860
1861static int unittest_i2c_dev_remove(struct i2c_client *client)
1862{
1863 struct device *dev = &client->dev;
1864 struct device_node *np = client->dev.of_node;
1865
1866 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1867 return 0;
1868}
1869
1870static const struct i2c_device_id unittest_i2c_dev_id[] = {
1871 { .name = "unittest-i2c-dev" },
1872 { }
1873};
1874
1875static struct i2c_driver unittest_i2c_dev_driver = {
1876 .driver = {
1877 .name = "unittest-i2c-dev",
1878 },
1879 .probe = unittest_i2c_dev_probe,
1880 .remove = unittest_i2c_dev_remove,
1881 .id_table = unittest_i2c_dev_id,
1882};
1883
1884#if IS_BUILTIN(CONFIG_I2C_MUX)
1885
1886static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1887{
1888 return 0;
1889}
1890
1891static int unittest_i2c_mux_probe(struct i2c_client *client,
1892 const struct i2c_device_id *id)
1893{
1894 int i, nchans;
1895 struct device *dev = &client->dev;
1896 struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1897 struct device_node *np = client->dev.of_node, *child;
1898 struct i2c_mux_core *muxc;
1899 u32 reg, max_reg;
1900
1901 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1902
1903 if (!np) {
1904 dev_err(dev, "No OF node\n");
1905 return -EINVAL;
1906 }
1907
1908 max_reg = (u32)-1;
1909 for_each_child_of_node(np, child) {
1910 if (of_property_read_u32(child, "reg", ®))
1911 continue;
1912 if (max_reg == (u32)-1 || reg > max_reg)
1913 max_reg = reg;
1914 }
1915 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1916 if (nchans == 0) {
1917 dev_err(dev, "No channels\n");
1918 return -EINVAL;
1919 }
1920
1921 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1922 unittest_i2c_mux_select_chan, NULL);
1923 if (!muxc)
1924 return -ENOMEM;
1925 for (i = 0; i < nchans; i++) {
1926 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
1927 dev_err(dev, "Failed to register mux #%d\n", i);
1928 i2c_mux_del_adapters(muxc);
1929 return -ENODEV;
1930 }
1931 }
1932
1933 i2c_set_clientdata(client, muxc);
1934
1935 return 0;
1936};
1937
1938static int unittest_i2c_mux_remove(struct i2c_client *client)
1939{
1940 struct device *dev = &client->dev;
1941 struct device_node *np = client->dev.of_node;
1942 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1943
1944 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1945 i2c_mux_del_adapters(muxc);
1946 return 0;
1947}
1948
1949static const struct i2c_device_id unittest_i2c_mux_id[] = {
1950 { .name = "unittest-i2c-mux" },
1951 { }
1952};
1953
1954static struct i2c_driver unittest_i2c_mux_driver = {
1955 .driver = {
1956 .name = "unittest-i2c-mux",
1957 },
1958 .probe = unittest_i2c_mux_probe,
1959 .remove = unittest_i2c_mux_remove,
1960 .id_table = unittest_i2c_mux_id,
1961};
1962
1963#endif
1964
1965static int of_unittest_overlay_i2c_init(void)
1966{
1967 int ret;
1968
1969 ret = i2c_add_driver(&unittest_i2c_dev_driver);
1970 if (unittest(ret == 0,
1971 "could not register unittest i2c device driver\n"))
1972 return ret;
1973
1974 ret = platform_driver_register(&unittest_i2c_bus_driver);
1975 if (unittest(ret == 0,
1976 "could not register unittest i2c bus driver\n"))
1977 return ret;
1978
1979#if IS_BUILTIN(CONFIG_I2C_MUX)
1980 ret = i2c_add_driver(&unittest_i2c_mux_driver);
1981 if (unittest(ret == 0,
1982 "could not register unittest i2c mux driver\n"))
1983 return ret;
1984#endif
1985
1986 return 0;
1987}
1988
1989static void of_unittest_overlay_i2c_cleanup(void)
1990{
1991#if IS_BUILTIN(CONFIG_I2C_MUX)
1992 i2c_del_driver(&unittest_i2c_mux_driver);
1993#endif
1994 platform_driver_unregister(&unittest_i2c_bus_driver);
1995 i2c_del_driver(&unittest_i2c_dev_driver);
1996}
1997
1998static void __init of_unittest_overlay_i2c_12(void)
1999{
2000 /* device should enable */
2001 if (of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY))
2002 return;
2003
2004 unittest(1, "overlay test %d passed\n", 12);
2005}
2006
2007/* test deactivation of device */
2008static void __init of_unittest_overlay_i2c_13(void)
2009{
2010 /* device should disable */
2011 if (of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY))
2012 return;
2013
2014 unittest(1, "overlay test %d passed\n", 13);
2015}
2016
2017/* just check for i2c mux existence */
2018static void of_unittest_overlay_i2c_14(void)
2019{
2020}
2021
2022static void __init of_unittest_overlay_i2c_15(void)
2023{
2024 /* device should enable */
2025 if (of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY))
2026 return;
2027
2028 unittest(1, "overlay test %d passed\n", 15);
2029}
2030
2031#else
2032
2033static inline void of_unittest_overlay_i2c_14(void) { }
2034static inline void of_unittest_overlay_i2c_15(void) { }
2035
2036#endif
2037
2038static void __init of_unittest_overlay(void)
2039{
2040 struct device_node *bus_np = NULL;
2041
2042 if (platform_driver_register(&unittest_driver)) {
2043 unittest(0, "could not register unittest driver\n");
2044 goto out;
2045 }
2046
2047 bus_np = of_find_node_by_path(bus_path);
2048 if (bus_np == NULL) {
2049 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2050 goto out;
2051 }
2052
2053 if (of_platform_default_populate(bus_np, NULL, NULL)) {
2054 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2055 goto out;
2056 }
2057
2058 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2059 unittest(0, "could not find unittest0 @ \"%s\"\n",
2060 unittest_path(100, PDEV_OVERLAY));
2061 goto out;
2062 }
2063
2064 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2065 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2066 unittest_path(101, PDEV_OVERLAY));
2067 goto out;
2068 }
2069
2070 unittest(1, "basic infrastructure of overlays passed");
2071
2072 /* tests in sequence */
2073 of_unittest_overlay_0();
2074 of_unittest_overlay_1();
2075 of_unittest_overlay_2();
2076 of_unittest_overlay_3();
2077 of_unittest_overlay_4();
2078 of_unittest_overlay_5();
2079 of_unittest_overlay_6();
2080 of_unittest_overlay_8();
2081
2082 of_unittest_overlay_10();
2083 of_unittest_overlay_11();
2084
2085#if IS_BUILTIN(CONFIG_I2C)
2086 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2087 goto out;
2088
2089 of_unittest_overlay_i2c_12();
2090 of_unittest_overlay_i2c_13();
2091 of_unittest_overlay_i2c_14();
2092 of_unittest_overlay_i2c_15();
2093
2094 of_unittest_overlay_i2c_cleanup();
2095#endif
2096
2097 of_unittest_destroy_tracked_overlays();
2098
2099out:
2100 of_node_put(bus_np);
2101}
2102
2103#else
2104static inline void __init of_unittest_overlay(void) { }
2105#endif
2106
2107#ifdef CONFIG_OF_OVERLAY
2108
2109/*
2110 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2111 * in scripts/Makefile.lib
2112 */
2113
2114#define OVERLAY_INFO_EXTERN(name) \
2115 extern uint8_t __dtb_##name##_begin[]; \
2116 extern uint8_t __dtb_##name##_end[]
2117
2118#define OVERLAY_INFO(overlay_name, expected) \
2119{ .dtb_begin = __dtb_##overlay_name##_begin, \
2120 .dtb_end = __dtb_##overlay_name##_end, \
2121 .expected_result = expected, \
2122 .name = #overlay_name, \
2123}
2124
2125struct overlay_info {
2126 uint8_t *dtb_begin;
2127 uint8_t *dtb_end;
2128 int expected_result;
2129 int overlay_id;
2130 char *name;
2131};
2132
2133OVERLAY_INFO_EXTERN(overlay_base);
2134OVERLAY_INFO_EXTERN(overlay);
2135OVERLAY_INFO_EXTERN(overlay_0);
2136OVERLAY_INFO_EXTERN(overlay_1);
2137OVERLAY_INFO_EXTERN(overlay_2);
2138OVERLAY_INFO_EXTERN(overlay_3);
2139OVERLAY_INFO_EXTERN(overlay_4);
2140OVERLAY_INFO_EXTERN(overlay_5);
2141OVERLAY_INFO_EXTERN(overlay_6);
2142OVERLAY_INFO_EXTERN(overlay_7);
2143OVERLAY_INFO_EXTERN(overlay_8);
2144OVERLAY_INFO_EXTERN(overlay_9);
2145OVERLAY_INFO_EXTERN(overlay_10);
2146OVERLAY_INFO_EXTERN(overlay_11);
2147OVERLAY_INFO_EXTERN(overlay_12);
2148OVERLAY_INFO_EXTERN(overlay_13);
2149OVERLAY_INFO_EXTERN(overlay_15);
2150OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2151OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2152
2153/* order of entries is hard-coded into users of overlays[] */
2154static struct overlay_info overlays[] = {
2155 OVERLAY_INFO(overlay_base, -9999),
2156 OVERLAY_INFO(overlay, 0),
2157 OVERLAY_INFO(overlay_0, 0),
2158 OVERLAY_INFO(overlay_1, 0),
2159 OVERLAY_INFO(overlay_2, 0),
2160 OVERLAY_INFO(overlay_3, 0),
2161 OVERLAY_INFO(overlay_4, 0),
2162 OVERLAY_INFO(overlay_5, 0),
2163 OVERLAY_INFO(overlay_6, 0),
2164 OVERLAY_INFO(overlay_7, 0),
2165 OVERLAY_INFO(overlay_8, 0),
2166 OVERLAY_INFO(overlay_9, 0),
2167 OVERLAY_INFO(overlay_10, 0),
2168 OVERLAY_INFO(overlay_11, 0),
2169 OVERLAY_INFO(overlay_12, 0),
2170 OVERLAY_INFO(overlay_13, 0),
2171 OVERLAY_INFO(overlay_15, 0),
2172 OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2173 OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2174 {}
2175};
2176
2177static struct device_node *overlay_base_root;
2178
2179static void * __init dt_alloc_memory(u64 size, u64 align)
2180{
2181 return memblock_virt_alloc(size, align);
2182}
2183
2184/*
2185 * Create base device tree for the overlay unittest.
2186 *
2187 * This is called from very early boot code.
2188 *
2189 * Do as much as possible the same way as done in __unflatten_device_tree
2190 * and other early boot steps for the normal FDT so that the overlay base
2191 * unflattened tree will have the same characteristics as the real tree
2192 * (such as having memory allocated by the early allocator). The goal
2193 * is to test "the real thing" as much as possible, and test "test setup
2194 * code" as little as possible.
2195 *
2196 * Have to stop before resolving phandles, because that uses kmalloc.
2197 */
2198void __init unittest_unflatten_overlay_base(void)
2199{
2200 struct overlay_info *info;
2201 u32 data_size;
2202 void *new_fdt;
2203 u32 size;
2204
2205 info = &overlays[0];
2206
2207 if (info->expected_result != -9999) {
2208 pr_err("No dtb 'overlay_base' to attach\n");
2209 return;
2210 }
2211
2212 data_size = info->dtb_end - info->dtb_begin;
2213 if (!data_size) {
2214 pr_err("No dtb 'overlay_base' to attach\n");
2215 return;
2216 }
2217
2218 size = fdt_totalsize(info->dtb_begin);
2219 if (size != data_size) {
2220 pr_err("dtb 'overlay_base' header totalsize != actual size");
2221 return;
2222 }
2223
2224 new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2225 if (!new_fdt) {
2226 pr_err("alloc for dtb 'overlay_base' failed");
2227 return;
2228 }
2229
2230 memcpy(new_fdt, info->dtb_begin, size);
2231
2232 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2233 dt_alloc_memory, true);
2234}
2235
2236/*
2237 * The purpose of of_unittest_overlay_data_add is to add an
2238 * overlay in the normal fashion. This is a test of the whole
2239 * picture, instead of testing individual elements.
2240 *
2241 * A secondary purpose is to be able to verify that the contents of
2242 * /proc/device-tree/ contains the updated structure and values from
2243 * the overlay. That must be verified separately in user space.
2244 *
2245 * Return 0 on unexpected error.
2246 */
2247static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2248{
2249 struct overlay_info *info;
2250 int found = 0;
2251 int k;
2252 int ret;
2253 u32 size;
2254
2255 for (k = 0, info = overlays; info && info->name; info++, k++) {
2256 if (!strcmp(overlay_name, info->name)) {
2257 found = 1;
2258 break;
2259 }
2260 }
2261 if (!found) {
2262 pr_err("no overlay data for %s\n", overlay_name);
2263 return 0;
2264 }
2265
2266 size = info->dtb_end - info->dtb_begin;
2267 if (!size)
2268 pr_err("no overlay data for %s\n", overlay_name);
2269
2270 ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2271 if (overlay_id)
2272 *overlay_id = info->overlay_id;
2273 if (ret < 0)
2274 goto out;
2275
2276 pr_debug("%s applied\n", overlay_name);
2277
2278out:
2279 if (ret != info->expected_result)
2280 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2281 info->expected_result, ret, overlay_name);
2282
2283 return (ret == info->expected_result);
2284}
2285
2286/*
2287 * The purpose of of_unittest_overlay_high_level is to add an overlay
2288 * in the normal fashion. This is a test of the whole picture,
2289 * instead of individual elements.
2290 *
2291 * The first part of the function is _not_ normal overlay usage; it is
2292 * finishing splicing the base overlay device tree into the live tree.
2293 */
2294static __init void of_unittest_overlay_high_level(void)
2295{
2296 struct device_node *last_sibling;
2297 struct device_node *np;
2298 struct device_node *of_symbols;
2299 struct device_node *overlay_base_symbols;
2300 struct device_node **pprev;
2301 struct property *prop;
2302
2303 if (!overlay_base_root) {
2304 unittest(0, "overlay_base_root not initialized\n");
2305 return;
2306 }
2307
2308 /*
2309 * Could not fixup phandles in unittest_unflatten_overlay_base()
2310 * because kmalloc() was not yet available.
2311 */
2312 of_overlay_mutex_lock();
2313 of_resolve_phandles(overlay_base_root);
2314 of_overlay_mutex_unlock();
2315
2316
2317 /*
2318 * do not allow overlay_base to duplicate any node already in
2319 * tree, this greatly simplifies the code
2320 */
2321
2322 /*
2323 * remove overlay_base_root node "__local_fixups", after
2324 * being used by of_resolve_phandles()
2325 */
2326 pprev = &overlay_base_root->child;
2327 for (np = overlay_base_root->child; np; np = np->sibling) {
2328 if (!of_node_cmp(np->name, "__local_fixups__")) {
2329 *pprev = np->sibling;
2330 break;
2331 }
2332 pprev = &np->sibling;
2333 }
2334
2335 /* remove overlay_base_root node "__symbols__" if in live tree */
2336 of_symbols = of_get_child_by_name(of_root, "__symbols__");
2337 if (of_symbols) {
2338 /* will have to graft properties from node into live tree */
2339 pprev = &overlay_base_root->child;
2340 for (np = overlay_base_root->child; np; np = np->sibling) {
2341 if (!of_node_cmp(np->name, "__symbols__")) {
2342 overlay_base_symbols = np;
2343 *pprev = np->sibling;
2344 break;
2345 }
2346 pprev = &np->sibling;
2347 }
2348 }
2349
2350 for (np = overlay_base_root->child; np; np = np->sibling) {
2351 if (of_get_child_by_name(of_root, np->name)) {
2352 unittest(0, "illegal node name in overlay_base %s",
2353 np->name);
2354 return;
2355 }
2356 }
2357
2358 /*
2359 * overlay 'overlay_base' is not allowed to have root
2360 * properties, so only need to splice nodes into main device tree.
2361 *
2362 * root node of *overlay_base_root will not be freed, it is lost
2363 * memory.
2364 */
2365
2366 for (np = overlay_base_root->child; np; np = np->sibling)
2367 np->parent = of_root;
2368
2369 mutex_lock(&of_mutex);
2370
2371 for (last_sibling = np = of_root->child; np; np = np->sibling)
2372 last_sibling = np;
2373
2374 if (last_sibling)
2375 last_sibling->sibling = overlay_base_root->child;
2376 else
2377 of_root->child = overlay_base_root->child;
2378
2379 for_each_of_allnodes_from(overlay_base_root, np)
2380 __of_attach_node_sysfs(np);
2381
2382 if (of_symbols) {
2383 struct property *new_prop;
2384 for_each_property_of_node(overlay_base_symbols, prop) {
2385
2386 new_prop = __of_prop_dup(prop, GFP_KERNEL);
2387 if (!new_prop) {
2388 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
2389 prop->name);
2390 goto err_unlock;
2391 }
2392 if (__of_add_property(of_symbols, new_prop)) {
2393 /* "name" auto-generated by unflatten */
2394 if (!strcmp(new_prop->name, "name"))
2395 continue;
2396 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
2397 prop->name);
2398 goto err_unlock;
2399 }
2400 if (__of_add_property_sysfs(of_symbols, new_prop)) {
2401 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2402 prop->name);
2403 goto err_unlock;
2404 }
2405 }
2406 }
2407
2408 mutex_unlock(&of_mutex);
2409
2410
2411 /* now do the normal overlay usage test */
2412
2413 unittest(overlay_data_apply("overlay", NULL),
2414 "Adding overlay 'overlay' failed\n");
2415
2416 unittest(overlay_data_apply("overlay_bad_phandle", NULL),
2417 "Adding overlay 'overlay_bad_phandle' failed\n");
2418
2419 unittest(overlay_data_apply("overlay_bad_symbol", NULL),
2420 "Adding overlay 'overlay_bad_symbol' failed\n");
2421
2422 return;
2423
2424err_unlock:
2425 mutex_unlock(&of_mutex);
2426}
2427
2428#else
2429
2430static inline __init void of_unittest_overlay_high_level(void) {}
2431
2432#endif
2433
2434static int __init of_unittest(void)
2435{
2436 struct device_node *np;
2437 int res;
2438
2439 /* adding data for unittest */
2440 res = unittest_data_add();
2441 if (res)
2442 return res;
2443 if (!of_aliases)
2444 of_aliases = of_find_node_by_path("/aliases");
2445
2446 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2447 if (!np) {
2448 pr_info("No testcase data in device tree; not running tests\n");
2449 return 0;
2450 }
2451 of_node_put(np);
2452
2453 pr_info("start of unittest - you will see error messages\n");
2454 of_unittest_check_tree_linkage();
2455 of_unittest_check_phandles();
2456 of_unittest_find_node_by_name();
2457 of_unittest_dynamic();
2458 of_unittest_parse_phandle_with_args();
2459 of_unittest_parse_phandle_with_args_map();
2460 of_unittest_printf();
2461 of_unittest_property_string();
2462 of_unittest_property_copy();
2463 of_unittest_changeset();
2464 of_unittest_parse_interrupts();
2465 of_unittest_parse_interrupts_extended();
2466 of_unittest_match_node();
2467 of_unittest_platform_populate();
2468 of_unittest_overlay();
2469
2470 /* Double check linkage after removing testcase data */
2471 of_unittest_check_tree_linkage();
2472
2473 of_unittest_overlay_high_level();
2474
2475 pr_info("end of unittest - %i passed, %i failed\n",
2476 unittest_results.passed, unittest_results.failed);
2477
2478 return 0;
2479}
2480late_initcall(of_unittest);