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