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