1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Self tests for device tree subsystem
4 */
5
6 #define pr_fmt(fmt) "### dt-test ### " fmt
7
8 #include <linux/bootmem.h>
9 #include <linux/clk.h>
10 #include <linux/err.h>
11 #include <linux/errno.h>
12 #include <linux/hashtable.h>
13 #include <linux/libfdt.h>
14 #include <linux/of.h>
15 #include <linux/of_fdt.h>
16 #include <linux/of_irq.h>
17 #include <linux/of_platform.h>
18 #include <linux/list.h>
19 #include <linux/mutex.h>
20 #include <linux/slab.h>
21 #include <linux/device.h>
22 #include <linux/platform_device.h>
23
24 #include <linux/i2c.h>
25 #include <linux/i2c-mux.h>
26
27 #include <linux/bitops.h>
28
29 #include "of_private.h"
30
31 static struct unittest_results {
32 int passed;
33 int failed;
34 } unittest_results;
35
36 #define unittest(result, fmt, ...) ({ \
37 bool failed = !(result); \
38 if (failed) { \
39 unittest_results.failed++; \
40 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
41 } else { \
42 unittest_results.passed++; \
43 pr_debug("pass %s():%i\n", __func__, __LINE__); \
44 } \
45 failed; \
46 })
47
of_unittest_find_node_by_name(void)48 static void __init of_unittest_find_node_by_name(void)
49 {
50 struct device_node *np;
51 const char *options, *name;
52
53 np = of_find_node_by_path("/testcase-data");
54 name = kasprintf(GFP_KERNEL, "%pOF", np);
55 unittest(np && name && !strcmp("/testcase-data", name),
56 "find /testcase-data failed\n");
57 of_node_put(np);
58 kfree(name);
59
60 /* Test if trailing '/' works */
61 np = of_find_node_by_path("/testcase-data/");
62 unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
63
64 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
65 name = kasprintf(GFP_KERNEL, "%pOF", np);
66 unittest(np && name && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
67 "find /testcase-data/phandle-tests/consumer-a failed\n");
68 of_node_put(np);
69 kfree(name);
70
71 np = of_find_node_by_path("testcase-alias");
72 name = kasprintf(GFP_KERNEL, "%pOF", np);
73 unittest(np && name && !strcmp("/testcase-data", name),
74 "find testcase-alias failed\n");
75 of_node_put(np);
76 kfree(name);
77
78 /* Test if trailing '/' works on aliases */
79 np = of_find_node_by_path("testcase-alias/");
80 unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
81
82 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
83 name = kasprintf(GFP_KERNEL, "%pOF", np);
84 unittest(np && name && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
85 "find testcase-alias/phandle-tests/consumer-a failed\n");
86 of_node_put(np);
87 kfree(name);
88
89 np = of_find_node_by_path("/testcase-data/missing-path");
90 unittest(!np, "non-existent path returned node %pOF\n", np);
91 of_node_put(np);
92
93 np = of_find_node_by_path("missing-alias");
94 unittest(!np, "non-existent alias returned node %pOF\n", np);
95 of_node_put(np);
96
97 np = of_find_node_by_path("testcase-alias/missing-path");
98 unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
99 of_node_put(np);
100
101 np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
102 unittest(np && !strcmp("testoption", options),
103 "option path test failed\n");
104 of_node_put(np);
105
106 np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
107 unittest(np && !strcmp("test/option", options),
108 "option path test, subcase #1 failed\n");
109 of_node_put(np);
110
111 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
112 unittest(np && !strcmp("test/option", options),
113 "option path test, subcase #2 failed\n");
114 of_node_put(np);
115
116 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
117 unittest(np, "NULL option path test failed\n");
118 of_node_put(np);
119
120 np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
121 &options);
122 unittest(np && !strcmp("testaliasoption", options),
123 "option alias path test failed\n");
124 of_node_put(np);
125
126 np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
127 &options);
128 unittest(np && !strcmp("test/alias/option", options),
129 "option alias path test, subcase #1 failed\n");
130 of_node_put(np);
131
132 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
133 unittest(np, "NULL option alias path test failed\n");
134 of_node_put(np);
135
136 options = "testoption";
137 np = of_find_node_opts_by_path("testcase-alias", &options);
138 unittest(np && !options, "option clearing test failed\n");
139 of_node_put(np);
140
141 options = "testoption";
142 np = of_find_node_opts_by_path("/", &options);
143 unittest(np && !options, "option clearing root node test failed\n");
144 of_node_put(np);
145 }
146
of_unittest_dynamic(void)147 static void __init of_unittest_dynamic(void)
148 {
149 struct device_node *np;
150 struct property *prop;
151
152 np = of_find_node_by_path("/testcase-data");
153 if (!np) {
154 pr_err("missing testcase data\n");
155 return;
156 }
157
158 /* Array of 4 properties for the purpose of testing */
159 prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
160 if (!prop) {
161 unittest(0, "kzalloc() failed\n");
162 return;
163 }
164
165 /* Add a new property - should pass*/
166 prop->name = "new-property";
167 prop->value = "new-property-data";
168 prop->length = strlen(prop->value) + 1;
169 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
170
171 /* Try to add an existing property - should fail */
172 prop++;
173 prop->name = "new-property";
174 prop->value = "new-property-data-should-fail";
175 prop->length = strlen(prop->value) + 1;
176 unittest(of_add_property(np, prop) != 0,
177 "Adding an existing property should have failed\n");
178
179 /* Try to modify an existing property - should pass */
180 prop->value = "modify-property-data-should-pass";
181 prop->length = strlen(prop->value) + 1;
182 unittest(of_update_property(np, prop) == 0,
183 "Updating an existing property should have passed\n");
184
185 /* Try to modify non-existent property - should pass*/
186 prop++;
187 prop->name = "modify-property";
188 prop->value = "modify-missing-property-data-should-pass";
189 prop->length = strlen(prop->value) + 1;
190 unittest(of_update_property(np, prop) == 0,
191 "Updating a missing property should have passed\n");
192
193 /* Remove property - should pass */
194 unittest(of_remove_property(np, prop) == 0,
195 "Removing a property should have passed\n");
196
197 /* Adding very large property - should pass */
198 prop++;
199 prop->name = "large-property-PAGE_SIZEx8";
200 prop->length = PAGE_SIZE * 8;
201 prop->value = kzalloc(prop->length, GFP_KERNEL);
202 unittest(prop->value != NULL, "Unable to allocate large buffer\n");
203 if (prop->value)
204 unittest(of_add_property(np, prop) == 0,
205 "Adding a large property should have passed\n");
206 }
207
of_unittest_check_node_linkage(struct device_node * np)208 static int __init of_unittest_check_node_linkage(struct device_node *np)
209 {
210 struct device_node *child;
211 int count = 0, rc;
212
213 for_each_child_of_node(np, child) {
214 if (child->parent != np) {
215 pr_err("Child node %pOFn links to wrong parent %pOFn\n",
216 child, np);
217 rc = -EINVAL;
218 goto put_child;
219 }
220
221 rc = of_unittest_check_node_linkage(child);
222 if (rc < 0)
223 goto put_child;
224 count += rc;
225 }
226
227 return count + 1;
228 put_child:
229 of_node_put(child);
230 return rc;
231 }
232
of_unittest_check_tree_linkage(void)233 static void __init of_unittest_check_tree_linkage(void)
234 {
235 struct device_node *np;
236 int allnode_count = 0, child_count;
237
238 if (!of_root)
239 return;
240
241 for_each_of_allnodes(np)
242 allnode_count++;
243 child_count = of_unittest_check_node_linkage(of_root);
244
245 unittest(child_count > 0, "Device node data structure is corrupted\n");
246 unittest(child_count == allnode_count,
247 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
248 allnode_count, child_count);
249 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
250 }
251
of_unittest_printf_one(struct device_node * np,const char * fmt,const char * expected)252 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
253 const char *expected)
254 {
255 unsigned char *buf;
256 int buf_size;
257 int size, i;
258
259 buf_size = strlen(expected) + 10;
260 buf = kmalloc(buf_size, GFP_KERNEL);
261 if (!buf)
262 return;
263
264 /* Baseline; check conversion with a large size limit */
265 memset(buf, 0xff, buf_size);
266 size = snprintf(buf, buf_size - 2, fmt, np);
267
268 /* use strcmp() instead of strncmp() here to be absolutely sure strings match */
269 unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
270 "sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
271 fmt, expected, buf);
272
273 /* Make sure length limits work */
274 size++;
275 for (i = 0; i < 2; i++, size--) {
276 /* Clear the buffer, and make sure it works correctly still */
277 memset(buf, 0xff, buf_size);
278 snprintf(buf, size+1, fmt, np);
279 unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
280 "snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
281 size, fmt, expected, buf);
282 }
283 kfree(buf);
284 }
285
of_unittest_printf(void)286 static void __init of_unittest_printf(void)
287 {
288 struct device_node *np;
289 const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
290 char phandle_str[16] = "";
291
292 np = of_find_node_by_path(full_name);
293 if (!np) {
294 unittest(np, "testcase data missing\n");
295 return;
296 }
297
298 num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
299
300 of_unittest_printf_one(np, "%pOF", full_name);
301 of_unittest_printf_one(np, "%pOFf", full_name);
302 of_unittest_printf_one(np, "%pOFp", phandle_str);
303 of_unittest_printf_one(np, "%pOFP", "dev@100");
304 of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
305 of_unittest_printf_one(np, "%10pOFP", " dev@100");
306 of_unittest_printf_one(np, "%-10pOFP", "dev@100 ");
307 of_unittest_printf_one(of_root, "%pOFP", "/");
308 of_unittest_printf_one(np, "%pOFF", "----");
309 of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
310 of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
311 of_unittest_printf_one(np, "%pOFc", "test-sub-device");
312 of_unittest_printf_one(np, "%pOFC",
313 "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
314 }
315
316 struct node_hash {
317 struct hlist_node node;
318 struct device_node *np;
319 };
320
321 static DEFINE_HASHTABLE(phandle_ht, 8);
of_unittest_check_phandles(void)322 static void __init of_unittest_check_phandles(void)
323 {
324 struct device_node *np;
325 struct node_hash *nh;
326 struct hlist_node *tmp;
327 int i, dup_count = 0, phandle_count = 0;
328
329 for_each_of_allnodes(np) {
330 if (!np->phandle)
331 continue;
332
333 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
334 if (nh->np->phandle == np->phandle) {
335 pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
336 np->phandle, nh->np, np);
337 dup_count++;
338 break;
339 }
340 }
341
342 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
343 if (WARN_ON(!nh))
344 return;
345
346 nh->np = np;
347 hash_add(phandle_ht, &nh->node, np->phandle);
348 phandle_count++;
349 }
350 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
351 dup_count, phandle_count);
352
353 /* Clean up */
354 hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
355 hash_del(&nh->node);
356 kfree(nh);
357 }
358 }
359
of_unittest_parse_phandle_with_args(void)360 static void __init of_unittest_parse_phandle_with_args(void)
361 {
362 struct device_node *np;
363 struct of_phandle_args args;
364 int i, rc;
365
366 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
367 if (!np) {
368 pr_err("missing testcase data\n");
369 return;
370 }
371
372 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
373 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
374
375 for (i = 0; i < 8; i++) {
376 bool passed = true;
377
378 memset(&args, 0, sizeof(args));
379 rc = of_parse_phandle_with_args(np, "phandle-list",
380 "#phandle-cells", i, &args);
381
382 /* Test the values from tests-phandle.dtsi */
383 switch (i) {
384 case 0:
385 passed &= !rc;
386 passed &= (args.args_count == 1);
387 passed &= (args.args[0] == (i + 1));
388 break;
389 case 1:
390 passed &= !rc;
391 passed &= (args.args_count == 2);
392 passed &= (args.args[0] == (i + 1));
393 passed &= (args.args[1] == 0);
394 break;
395 case 2:
396 passed &= (rc == -ENOENT);
397 break;
398 case 3:
399 passed &= !rc;
400 passed &= (args.args_count == 3);
401 passed &= (args.args[0] == (i + 1));
402 passed &= (args.args[1] == 4);
403 passed &= (args.args[2] == 3);
404 break;
405 case 4:
406 passed &= !rc;
407 passed &= (args.args_count == 2);
408 passed &= (args.args[0] == (i + 1));
409 passed &= (args.args[1] == 100);
410 break;
411 case 5:
412 passed &= !rc;
413 passed &= (args.args_count == 0);
414 break;
415 case 6:
416 passed &= !rc;
417 passed &= (args.args_count == 1);
418 passed &= (args.args[0] == (i + 1));
419 break;
420 case 7:
421 passed &= (rc == -ENOENT);
422 break;
423 default:
424 passed = false;
425 }
426
427 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
428 i, args.np, rc);
429 }
430
431 /* Check for missing list property */
432 memset(&args, 0, sizeof(args));
433 rc = of_parse_phandle_with_args(np, "phandle-list-missing",
434 "#phandle-cells", 0, &args);
435 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
436 rc = of_count_phandle_with_args(np, "phandle-list-missing",
437 "#phandle-cells");
438 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
439
440 /* Check for missing cells property */
441 memset(&args, 0, sizeof(args));
442 rc = of_parse_phandle_with_args(np, "phandle-list",
443 "#phandle-cells-missing", 0, &args);
444 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
445 rc = of_count_phandle_with_args(np, "phandle-list",
446 "#phandle-cells-missing");
447 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
448
449 /* Check for bad phandle in list */
450 memset(&args, 0, sizeof(args));
451 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
452 "#phandle-cells", 0, &args);
453 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
454 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
455 "#phandle-cells");
456 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
457
458 /* Check for incorrectly formed argument list */
459 memset(&args, 0, sizeof(args));
460 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
461 "#phandle-cells", 1, &args);
462 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
463 rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
464 "#phandle-cells");
465 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
466 }
467
of_unittest_parse_phandle_with_args_map(void)468 static void __init of_unittest_parse_phandle_with_args_map(void)
469 {
470 struct device_node *np, *p0, *p1, *p2, *p3;
471 struct of_phandle_args args;
472 int i, rc;
473
474 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
475 if (!np) {
476 pr_err("missing testcase data\n");
477 return;
478 }
479
480 p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
481 if (!p0) {
482 pr_err("missing testcase data\n");
483 return;
484 }
485
486 p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
487 if (!p1) {
488 pr_err("missing testcase data\n");
489 return;
490 }
491
492 p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
493 if (!p2) {
494 pr_err("missing testcase data\n");
495 return;
496 }
497
498 p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
499 if (!p3) {
500 pr_err("missing testcase data\n");
501 return;
502 }
503
504 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
505 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
506
507 for (i = 0; i < 8; i++) {
508 bool passed = true;
509
510 memset(&args, 0, sizeof(args));
511 rc = of_parse_phandle_with_args_map(np, "phandle-list",
512 "phandle", i, &args);
513
514 /* Test the values from tests-phandle.dtsi */
515 switch (i) {
516 case 0:
517 passed &= !rc;
518 passed &= (args.np == p1);
519 passed &= (args.args_count == 1);
520 passed &= (args.args[0] == 1);
521 break;
522 case 1:
523 passed &= !rc;
524 passed &= (args.np == p3);
525 passed &= (args.args_count == 3);
526 passed &= (args.args[0] == 2);
527 passed &= (args.args[1] == 5);
528 passed &= (args.args[2] == 3);
529 break;
530 case 2:
531 passed &= (rc == -ENOENT);
532 break;
533 case 3:
534 passed &= !rc;
535 passed &= (args.np == p0);
536 passed &= (args.args_count == 0);
537 break;
538 case 4:
539 passed &= !rc;
540 passed &= (args.np == p1);
541 passed &= (args.args_count == 1);
542 passed &= (args.args[0] == 3);
543 break;
544 case 5:
545 passed &= !rc;
546 passed &= (args.np == p0);
547 passed &= (args.args_count == 0);
548 break;
549 case 6:
550 passed &= !rc;
551 passed &= (args.np == p2);
552 passed &= (args.args_count == 2);
553 passed &= (args.args[0] == 15);
554 passed &= (args.args[1] == 0x20);
555 break;
556 case 7:
557 passed &= (rc == -ENOENT);
558 break;
559 default:
560 passed = false;
561 }
562
563 unittest(passed, "index %i - data error on node %s rc=%i\n",
564 i, args.np->full_name, rc);
565 }
566
567 /* Check for missing list property */
568 memset(&args, 0, sizeof(args));
569 rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
570 "phandle", 0, &args);
571 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
572
573 /* Check for missing cells,map,mask property */
574 memset(&args, 0, sizeof(args));
575 rc = of_parse_phandle_with_args_map(np, "phandle-list",
576 "phandle-missing", 0, &args);
577 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
578
579 /* Check for bad phandle in list */
580 memset(&args, 0, sizeof(args));
581 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
582 "phandle", 0, &args);
583 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
584
585 /* Check for incorrectly formed argument list */
586 memset(&args, 0, sizeof(args));
587 rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
588 "phandle", 1, &args);
589 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
590 }
591
of_unittest_property_string(void)592 static void __init of_unittest_property_string(void)
593 {
594 const char *strings[4];
595 struct device_node *np;
596 int rc;
597
598 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
599 if (!np) {
600 pr_err("No testcase data in device tree\n");
601 return;
602 }
603
604 rc = of_property_match_string(np, "phandle-list-names", "first");
605 unittest(rc == 0, "first expected:0 got:%i\n", rc);
606 rc = of_property_match_string(np, "phandle-list-names", "second");
607 unittest(rc == 1, "second expected:1 got:%i\n", rc);
608 rc = of_property_match_string(np, "phandle-list-names", "third");
609 unittest(rc == 2, "third expected:2 got:%i\n", rc);
610 rc = of_property_match_string(np, "phandle-list-names", "fourth");
611 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
612 rc = of_property_match_string(np, "missing-property", "blah");
613 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
614 rc = of_property_match_string(np, "empty-property", "blah");
615 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
616 rc = of_property_match_string(np, "unterminated-string", "blah");
617 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
618
619 /* of_property_count_strings() tests */
620 rc = of_property_count_strings(np, "string-property");
621 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
622 rc = of_property_count_strings(np, "phandle-list-names");
623 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
624 rc = of_property_count_strings(np, "unterminated-string");
625 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
626 rc = of_property_count_strings(np, "unterminated-string-list");
627 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
628
629 /* of_property_read_string_index() tests */
630 rc = of_property_read_string_index(np, "string-property", 0, strings);
631 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
632 strings[0] = NULL;
633 rc = of_property_read_string_index(np, "string-property", 1, strings);
634 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
635 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
636 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
637 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
638 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
639 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
640 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
641 strings[0] = NULL;
642 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
643 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
644 strings[0] = NULL;
645 rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
646 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
647 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
648 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
649 strings[0] = NULL;
650 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
651 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
652 strings[1] = NULL;
653
654 /* of_property_read_string_array() tests */
655 rc = of_property_read_string_array(np, "string-property", strings, 4);
656 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
657 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
658 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
659 rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
660 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
661 /* -- An incorrectly formed string should cause a failure */
662 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
663 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
664 /* -- parsing the correctly formed strings should still work: */
665 strings[2] = NULL;
666 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
667 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
668 strings[1] = NULL;
669 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
670 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
671 }
672
673 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
674 (p1)->value && (p2)->value && \
675 !memcmp((p1)->value, (p2)->value, (p1)->length) && \
676 !strcmp((p1)->name, (p2)->name))
of_unittest_property_copy(void)677 static void __init of_unittest_property_copy(void)
678 {
679 #ifdef CONFIG_OF_DYNAMIC
680 struct property p1 = { .name = "p1", .length = 0, .value = "" };
681 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
682 struct property *new;
683
684 new = __of_prop_dup(&p1, GFP_KERNEL);
685 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
686 kfree(new->value);
687 kfree(new->name);
688 kfree(new);
689
690 new = __of_prop_dup(&p2, GFP_KERNEL);
691 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
692 kfree(new->value);
693 kfree(new->name);
694 kfree(new);
695 #endif
696 }
697
of_unittest_changeset(void)698 static void __init of_unittest_changeset(void)
699 {
700 #ifdef CONFIG_OF_DYNAMIC
701 struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
702 struct property *ppname_n1, pname_n1 = { .name = "name", .length = 3, .value = "n1" };
703 struct property *ppname_n2, pname_n2 = { .name = "name", .length = 3, .value = "n2" };
704 struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
705 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
706 struct property *ppremove;
707 struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
708 struct of_changeset chgset;
709
710 n1 = __of_node_dup(NULL, "n1");
711 unittest(n1, "testcase setup failure\n");
712
713 n2 = __of_node_dup(NULL, "n2");
714 unittest(n2, "testcase setup failure\n");
715
716 n21 = __of_node_dup(NULL, "n21");
717 unittest(n21, "testcase setup failure %p\n", n21);
718
719 nchangeset = of_find_node_by_path("/testcase-data/changeset");
720 nremove = of_get_child_by_name(nchangeset, "node-remove");
721 unittest(nremove, "testcase setup failure\n");
722
723 ppadd = __of_prop_dup(&padd, GFP_KERNEL);
724 unittest(ppadd, "testcase setup failure\n");
725
726 ppname_n1 = __of_prop_dup(&pname_n1, GFP_KERNEL);
727 unittest(ppname_n1, "testcase setup failure\n");
728
729 ppname_n2 = __of_prop_dup(&pname_n2, GFP_KERNEL);
730 unittest(ppname_n2, "testcase setup failure\n");
731
732 ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
733 unittest(ppname_n21, "testcase setup failure\n");
734
735 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
736 unittest(ppupdate, "testcase setup failure\n");
737
738 parent = nchangeset;
739 n1->parent = parent;
740 n2->parent = parent;
741 n21->parent = n2;
742
743 ppremove = of_find_property(parent, "prop-remove", NULL);
744 unittest(ppremove, "failed to find removal prop");
745
746 of_changeset_init(&chgset);
747
748 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
749 unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
750
751 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
752 unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
753
754 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
755 unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
756
757 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
758
759 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
760 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
761 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
762
763 unittest(!of_changeset_apply(&chgset), "apply failed\n");
764
765 of_node_put(nchangeset);
766
767 /* Make sure node names are constructed correctly */
768 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
769 "'%pOF' not added\n", n21);
770 of_node_put(np);
771
772 unittest(!of_changeset_revert(&chgset), "revert failed\n");
773
774 of_changeset_destroy(&chgset);
775
776 of_node_put(n1);
777 of_node_put(n2);
778 of_node_put(n21);
779 #endif
780 }
781
of_unittest_parse_interrupts(void)782 static void __init of_unittest_parse_interrupts(void)
783 {
784 struct device_node *np;
785 struct of_phandle_args args;
786 int i, rc;
787
788 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
789 return;
790
791 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
792 if (!np) {
793 pr_err("missing testcase data\n");
794 return;
795 }
796
797 for (i = 0; i < 4; i++) {
798 bool passed = true;
799
800 memset(&args, 0, sizeof(args));
801 rc = of_irq_parse_one(np, i, &args);
802
803 passed &= !rc;
804 passed &= (args.args_count == 1);
805 passed &= (args.args[0] == (i + 1));
806
807 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
808 i, args.np, rc);
809 }
810 of_node_put(np);
811
812 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
813 if (!np) {
814 pr_err("missing testcase data\n");
815 return;
816 }
817
818 for (i = 0; i < 4; i++) {
819 bool passed = true;
820
821 memset(&args, 0, sizeof(args));
822 rc = of_irq_parse_one(np, i, &args);
823
824 /* Test the values from tests-phandle.dtsi */
825 switch (i) {
826 case 0:
827 passed &= !rc;
828 passed &= (args.args_count == 1);
829 passed &= (args.args[0] == 9);
830 break;
831 case 1:
832 passed &= !rc;
833 passed &= (args.args_count == 3);
834 passed &= (args.args[0] == 10);
835 passed &= (args.args[1] == 11);
836 passed &= (args.args[2] == 12);
837 break;
838 case 2:
839 passed &= !rc;
840 passed &= (args.args_count == 2);
841 passed &= (args.args[0] == 13);
842 passed &= (args.args[1] == 14);
843 break;
844 case 3:
845 passed &= !rc;
846 passed &= (args.args_count == 2);
847 passed &= (args.args[0] == 15);
848 passed &= (args.args[1] == 16);
849 break;
850 default:
851 passed = false;
852 }
853 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
854 i, args.np, rc);
855 }
856 of_node_put(np);
857 }
858
of_unittest_parse_interrupts_extended(void)859 static void __init of_unittest_parse_interrupts_extended(void)
860 {
861 struct device_node *np;
862 struct of_phandle_args args;
863 int i, rc;
864
865 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
866 return;
867
868 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
869 if (!np) {
870 pr_err("missing testcase data\n");
871 return;
872 }
873
874 for (i = 0; i < 7; i++) {
875 bool passed = true;
876
877 memset(&args, 0, sizeof(args));
878 rc = of_irq_parse_one(np, i, &args);
879
880 /* Test the values from tests-phandle.dtsi */
881 switch (i) {
882 case 0:
883 passed &= !rc;
884 passed &= (args.args_count == 1);
885 passed &= (args.args[0] == 1);
886 break;
887 case 1:
888 passed &= !rc;
889 passed &= (args.args_count == 3);
890 passed &= (args.args[0] == 2);
891 passed &= (args.args[1] == 3);
892 passed &= (args.args[2] == 4);
893 break;
894 case 2:
895 passed &= !rc;
896 passed &= (args.args_count == 2);
897 passed &= (args.args[0] == 5);
898 passed &= (args.args[1] == 6);
899 break;
900 case 3:
901 passed &= !rc;
902 passed &= (args.args_count == 1);
903 passed &= (args.args[0] == 9);
904 break;
905 case 4:
906 passed &= !rc;
907 passed &= (args.args_count == 3);
908 passed &= (args.args[0] == 10);
909 passed &= (args.args[1] == 11);
910 passed &= (args.args[2] == 12);
911 break;
912 case 5:
913 passed &= !rc;
914 passed &= (args.args_count == 2);
915 passed &= (args.args[0] == 13);
916 passed &= (args.args[1] == 14);
917 break;
918 case 6:
919 passed &= !rc;
920 passed &= (args.args_count == 1);
921 passed &= (args.args[0] == 15);
922 break;
923 default:
924 passed = false;
925 }
926
927 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
928 i, args.np, rc);
929 }
930 of_node_put(np);
931 }
932
933 static const struct of_device_id match_node_table[] = {
934 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
935 { .data = "B", .type = "type1", }, /* followed by type alone */
936
937 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
938 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
939 { .data = "Cc", .name = "name2", .type = "type2", },
940
941 { .data = "E", .compatible = "compat3" },
942 { .data = "G", .compatible = "compat2", },
943 { .data = "H", .compatible = "compat2", .name = "name5", },
944 { .data = "I", .compatible = "compat2", .type = "type1", },
945 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
946 { .data = "K", .compatible = "compat2", .name = "name9", },
947 {}
948 };
949
950 static struct {
951 const char *path;
952 const char *data;
953 } match_node_tests[] = {
954 { .path = "/testcase-data/match-node/name0", .data = "A", },
955 { .path = "/testcase-data/match-node/name1", .data = "B", },
956 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
957 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
958 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
959 { .path = "/testcase-data/match-node/name3", .data = "E", },
960 { .path = "/testcase-data/match-node/name4", .data = "G", },
961 { .path = "/testcase-data/match-node/name5", .data = "H", },
962 { .path = "/testcase-data/match-node/name6", .data = "G", },
963 { .path = "/testcase-data/match-node/name7", .data = "I", },
964 { .path = "/testcase-data/match-node/name8", .data = "J", },
965 { .path = "/testcase-data/match-node/name9", .data = "K", },
966 };
967
of_unittest_match_node(void)968 static void __init of_unittest_match_node(void)
969 {
970 struct device_node *np;
971 const struct of_device_id *match;
972 int i;
973
974 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
975 np = of_find_node_by_path(match_node_tests[i].path);
976 if (!np) {
977 unittest(0, "missing testcase node %s\n",
978 match_node_tests[i].path);
979 continue;
980 }
981
982 match = of_match_node(match_node_table, np);
983 if (!match) {
984 unittest(0, "%s didn't match anything\n",
985 match_node_tests[i].path);
986 continue;
987 }
988
989 if (strcmp(match->data, match_node_tests[i].data) != 0) {
990 unittest(0, "%s got wrong match. expected %s, got %s\n",
991 match_node_tests[i].path, match_node_tests[i].data,
992 (const char *)match->data);
993 continue;
994 }
995 unittest(1, "passed");
996 }
997 }
998
999 static struct resource test_bus_res = {
1000 .start = 0xfffffff8,
1001 .end = 0xfffffff9,
1002 .flags = IORESOURCE_MEM,
1003 };
1004 static const struct platform_device_info test_bus_info = {
1005 .name = "unittest-bus",
1006 };
of_unittest_platform_populate(void)1007 static void __init of_unittest_platform_populate(void)
1008 {
1009 int irq, rc;
1010 struct device_node *np, *child, *grandchild;
1011 struct platform_device *pdev, *test_bus;
1012 const struct of_device_id match[] = {
1013 { .compatible = "test-device", },
1014 {}
1015 };
1016
1017 np = of_find_node_by_path("/testcase-data");
1018 of_platform_default_populate(np, NULL, NULL);
1019
1020 /* Test that a missing irq domain returns -EPROBE_DEFER */
1021 np = of_find_node_by_path("/testcase-data/testcase-device1");
1022 pdev = of_find_device_by_node(np);
1023 unittest(pdev, "device 1 creation failed\n");
1024
1025 if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1026 irq = platform_get_irq(pdev, 0);
1027 unittest(irq == -EPROBE_DEFER,
1028 "device deferred probe failed - %d\n", irq);
1029
1030 /* Test that a parsing failure does not return -EPROBE_DEFER */
1031 np = of_find_node_by_path("/testcase-data/testcase-device2");
1032 pdev = of_find_device_by_node(np);
1033 unittest(pdev, "device 2 creation failed\n");
1034 irq = platform_get_irq(pdev, 0);
1035 unittest(irq < 0 && irq != -EPROBE_DEFER,
1036 "device parsing error failed - %d\n", irq);
1037 }
1038
1039 np = of_find_node_by_path("/testcase-data/platform-tests");
1040 unittest(np, "No testcase data in device tree\n");
1041 if (!np)
1042 return;
1043
1044 test_bus = platform_device_register_full(&test_bus_info);
1045 rc = PTR_ERR_OR_ZERO(test_bus);
1046 unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1047 if (rc)
1048 return;
1049 test_bus->dev.of_node = np;
1050
1051 /*
1052 * Add a dummy resource to the test bus node after it is
1053 * registered to catch problems with un-inserted resources. The
1054 * DT code doesn't insert the resources, and it has caused the
1055 * kernel to oops in the past. This makes sure the same bug
1056 * doesn't crop up again.
1057 */
1058 platform_device_add_resources(test_bus, &test_bus_res, 1);
1059
1060 of_platform_populate(np, match, NULL, &test_bus->dev);
1061 for_each_child_of_node(np, child) {
1062 for_each_child_of_node(child, grandchild) {
1063 pdev = of_find_device_by_node(grandchild);
1064 unittest(pdev,
1065 "Could not create device for node '%pOFn'\n",
1066 grandchild);
1067 of_dev_put(pdev);
1068 }
1069 }
1070
1071 of_platform_depopulate(&test_bus->dev);
1072 for_each_child_of_node(np, child) {
1073 for_each_child_of_node(child, grandchild)
1074 unittest(!of_find_device_by_node(grandchild),
1075 "device didn't get destroyed '%pOFn'\n",
1076 grandchild);
1077 }
1078
1079 platform_device_unregister(test_bus);
1080 of_node_put(np);
1081 }
1082
1083 /**
1084 * update_node_properties - adds the properties
1085 * of np into dup node (present in live tree) and
1086 * updates parent of children of np to dup.
1087 *
1088 * @np: node whose properties are being added to the live tree
1089 * @dup: node present in live tree to be updated
1090 */
update_node_properties(struct device_node * np,struct device_node * dup)1091 static void update_node_properties(struct device_node *np,
1092 struct device_node *dup)
1093 {
1094 struct property *prop;
1095 struct property *save_next;
1096 struct device_node *child;
1097 int ret;
1098
1099 for_each_child_of_node(np, child)
1100 child->parent = dup;
1101
1102 /*
1103 * "unittest internal error: unable to add testdata property"
1104 *
1105 * If this message reports a property in node '/__symbols__' then
1106 * the respective unittest overlay contains a label that has the
1107 * same name as a label in the live devicetree. The label will
1108 * be in the live devicetree only if the devicetree source was
1109 * compiled with the '-@' option. If you encounter this error,
1110 * please consider renaming __all__ of the labels in the unittest
1111 * overlay dts files with an odd prefix that is unlikely to be
1112 * used in a real devicetree.
1113 */
1114
1115 /*
1116 * open code for_each_property_of_node() because of_add_property()
1117 * sets prop->next to NULL
1118 */
1119 for (prop = np->properties; prop != NULL; prop = save_next) {
1120 save_next = prop->next;
1121 ret = of_add_property(dup, prop);
1122 if (ret)
1123 pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1124 np, prop->name);
1125 }
1126 }
1127
1128 /**
1129 * attach_node_and_children - attaches nodes
1130 * and its children to live tree
1131 *
1132 * @np: Node to attach to live tree
1133 */
attach_node_and_children(struct device_node * np)1134 static void attach_node_and_children(struct device_node *np)
1135 {
1136 struct device_node *next, *dup, *child;
1137 unsigned long flags;
1138 const char *full_name;
1139
1140 full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1141 if (!full_name)
1142 return;
1143
1144 if (!strcmp(full_name, "/__local_fixups__") ||
1145 !strcmp(full_name, "/__fixups__")) {
1146 kfree(full_name);
1147 return;
1148 }
1149
1150 dup = of_find_node_by_path(full_name);
1151 kfree(full_name);
1152 if (dup) {
1153 update_node_properties(np, dup);
1154 return;
1155 }
1156
1157 child = np->child;
1158 np->child = NULL;
1159
1160 mutex_lock(&of_mutex);
1161 raw_spin_lock_irqsave(&devtree_lock, flags);
1162 np->sibling = np->parent->child;
1163 np->parent->child = np;
1164 of_node_clear_flag(np, OF_DETACHED);
1165 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1166
1167 __of_attach_node_sysfs(np);
1168 mutex_unlock(&of_mutex);
1169
1170 while (child) {
1171 next = child->sibling;
1172 attach_node_and_children(child);
1173 child = next;
1174 }
1175 }
1176
1177 /**
1178 * unittest_data_add - Reads, copies data from
1179 * linked tree and attaches it to the live tree
1180 */
unittest_data_add(void)1181 static int __init unittest_data_add(void)
1182 {
1183 void *unittest_data;
1184 struct device_node *unittest_data_node, *np;
1185 /*
1186 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1187 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1188 */
1189 extern uint8_t __dtb_testcases_begin[];
1190 extern uint8_t __dtb_testcases_end[];
1191 const int size = __dtb_testcases_end - __dtb_testcases_begin;
1192 int rc;
1193
1194 if (!size) {
1195 pr_warn("%s: No testcase data to attach; not running tests\n",
1196 __func__);
1197 return -ENODATA;
1198 }
1199
1200 /* creating copy */
1201 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1202
1203 if (!unittest_data) {
1204 pr_warn("%s: Failed to allocate memory for unittest_data; "
1205 "not running tests\n", __func__);
1206 return -ENOMEM;
1207 }
1208 of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1209 if (!unittest_data_node) {
1210 pr_warn("%s: No tree to attach; not running tests\n", __func__);
1211 kfree(unittest_data);
1212 return -ENODATA;
1213 }
1214
1215 /*
1216 * This lock normally encloses of_resolve_phandles()
1217 */
1218 of_overlay_mutex_lock();
1219
1220 rc = of_resolve_phandles(unittest_data_node);
1221 if (rc) {
1222 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1223 of_overlay_mutex_unlock();
1224 return -EINVAL;
1225 }
1226
1227 if (!of_root) {
1228 of_root = unittest_data_node;
1229 for_each_of_allnodes(np)
1230 __of_attach_node_sysfs(np);
1231 of_aliases = of_find_node_by_path("/aliases");
1232 of_chosen = of_find_node_by_path("/chosen");
1233 of_overlay_mutex_unlock();
1234 return 0;
1235 }
1236
1237 /* attach the sub-tree to live tree */
1238 np = unittest_data_node->child;
1239 while (np) {
1240 struct device_node *next = np->sibling;
1241
1242 np->parent = of_root;
1243 attach_node_and_children(np);
1244 np = next;
1245 }
1246
1247 of_overlay_mutex_unlock();
1248
1249 return 0;
1250 }
1251
1252 #ifdef CONFIG_OF_OVERLAY
1253 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1254
unittest_probe(struct platform_device * pdev)1255 static int unittest_probe(struct platform_device *pdev)
1256 {
1257 struct device *dev = &pdev->dev;
1258 struct device_node *np = dev->of_node;
1259
1260 if (np == NULL) {
1261 dev_err(dev, "No OF data for device\n");
1262 return -EINVAL;
1263
1264 }
1265
1266 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1267
1268 of_platform_populate(np, NULL, NULL, &pdev->dev);
1269
1270 return 0;
1271 }
1272
unittest_remove(struct platform_device * pdev)1273 static int unittest_remove(struct platform_device *pdev)
1274 {
1275 struct device *dev = &pdev->dev;
1276 struct device_node *np = dev->of_node;
1277
1278 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1279 return 0;
1280 }
1281
1282 static const struct of_device_id unittest_match[] = {
1283 { .compatible = "unittest", },
1284 {},
1285 };
1286
1287 static struct platform_driver unittest_driver = {
1288 .probe = unittest_probe,
1289 .remove = unittest_remove,
1290 .driver = {
1291 .name = "unittest",
1292 .of_match_table = of_match_ptr(unittest_match),
1293 },
1294 };
1295
1296 /* get the platform device instantiated at the path */
of_path_to_platform_device(const char * path)1297 static struct platform_device *of_path_to_platform_device(const char *path)
1298 {
1299 struct device_node *np;
1300 struct platform_device *pdev;
1301
1302 np = of_find_node_by_path(path);
1303 if (np == NULL)
1304 return NULL;
1305
1306 pdev = of_find_device_by_node(np);
1307 of_node_put(np);
1308
1309 return pdev;
1310 }
1311
1312 /* find out if a platform device exists at that path */
of_path_platform_device_exists(const char * path)1313 static int of_path_platform_device_exists(const char *path)
1314 {
1315 struct platform_device *pdev;
1316
1317 pdev = of_path_to_platform_device(path);
1318 platform_device_put(pdev);
1319 return pdev != NULL;
1320 }
1321
1322 #if IS_BUILTIN(CONFIG_I2C)
1323
1324 /* get the i2c client device instantiated at the path */
of_path_to_i2c_client(const char * path)1325 static struct i2c_client *of_path_to_i2c_client(const char *path)
1326 {
1327 struct device_node *np;
1328 struct i2c_client *client;
1329
1330 np = of_find_node_by_path(path);
1331 if (np == NULL)
1332 return NULL;
1333
1334 client = of_find_i2c_device_by_node(np);
1335 of_node_put(np);
1336
1337 return client;
1338 }
1339
1340 /* find out if a i2c client device exists at that path */
of_path_i2c_client_exists(const char * path)1341 static int of_path_i2c_client_exists(const char *path)
1342 {
1343 struct i2c_client *client;
1344
1345 client = of_path_to_i2c_client(path);
1346 if (client)
1347 put_device(&client->dev);
1348 return client != NULL;
1349 }
1350 #else
of_path_i2c_client_exists(const char * path)1351 static int of_path_i2c_client_exists(const char *path)
1352 {
1353 return 0;
1354 }
1355 #endif
1356
1357 enum overlay_type {
1358 PDEV_OVERLAY,
1359 I2C_OVERLAY
1360 };
1361
of_path_device_type_exists(const char * path,enum overlay_type ovtype)1362 static int of_path_device_type_exists(const char *path,
1363 enum overlay_type ovtype)
1364 {
1365 switch (ovtype) {
1366 case PDEV_OVERLAY:
1367 return of_path_platform_device_exists(path);
1368 case I2C_OVERLAY:
1369 return of_path_i2c_client_exists(path);
1370 }
1371 return 0;
1372 }
1373
unittest_path(int nr,enum overlay_type ovtype)1374 static const char *unittest_path(int nr, enum overlay_type ovtype)
1375 {
1376 const char *base;
1377 static char buf[256];
1378
1379 switch (ovtype) {
1380 case PDEV_OVERLAY:
1381 base = "/testcase-data/overlay-node/test-bus";
1382 break;
1383 case I2C_OVERLAY:
1384 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1385 break;
1386 default:
1387 buf[0] = '\0';
1388 return buf;
1389 }
1390 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1391 buf[sizeof(buf) - 1] = '\0';
1392 return buf;
1393 }
1394
of_unittest_device_exists(int unittest_nr,enum overlay_type ovtype)1395 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1396 {
1397 const char *path;
1398
1399 path = unittest_path(unittest_nr, ovtype);
1400
1401 switch (ovtype) {
1402 case PDEV_OVERLAY:
1403 return of_path_platform_device_exists(path);
1404 case I2C_OVERLAY:
1405 return of_path_i2c_client_exists(path);
1406 }
1407 return 0;
1408 }
1409
overlay_name_from_nr(int nr)1410 static const char *overlay_name_from_nr(int nr)
1411 {
1412 static char buf[256];
1413
1414 snprintf(buf, sizeof(buf) - 1,
1415 "overlay_%d", nr);
1416 buf[sizeof(buf) - 1] = '\0';
1417
1418 return buf;
1419 }
1420
1421 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1422
1423 /* it is guaranteed that overlay ids are assigned in sequence */
1424 #define MAX_UNITTEST_OVERLAYS 256
1425 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1426 static int overlay_first_id = -1;
1427
of_unittest_track_overlay(int id)1428 static void of_unittest_track_overlay(int id)
1429 {
1430 if (overlay_first_id < 0)
1431 overlay_first_id = id;
1432 id -= overlay_first_id;
1433
1434 /* we shouldn't need that many */
1435 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1436 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1437 }
1438
of_unittest_untrack_overlay(int id)1439 static void of_unittest_untrack_overlay(int id)
1440 {
1441 if (overlay_first_id < 0)
1442 return;
1443 id -= overlay_first_id;
1444 BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1445 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1446 }
1447
of_unittest_destroy_tracked_overlays(void)1448 static void of_unittest_destroy_tracked_overlays(void)
1449 {
1450 int id, ret, defers, ovcs_id;
1451
1452 if (overlay_first_id < 0)
1453 return;
1454
1455 /* try until no defers */
1456 do {
1457 defers = 0;
1458 /* remove in reverse order */
1459 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1460 if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1461 continue;
1462
1463 ovcs_id = id + overlay_first_id;
1464 ret = of_overlay_remove(&ovcs_id);
1465 if (ret == -ENODEV) {
1466 pr_warn("%s: no overlay to destroy for #%d\n",
1467 __func__, id + overlay_first_id);
1468 continue;
1469 }
1470 if (ret != 0) {
1471 defers++;
1472 pr_warn("%s: overlay destroy failed for #%d\n",
1473 __func__, id + overlay_first_id);
1474 continue;
1475 }
1476
1477 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1478 }
1479 } while (defers > 0);
1480 }
1481
of_unittest_apply_overlay(int overlay_nr,int unittest_nr,int * overlay_id)1482 static int __init of_unittest_apply_overlay(int overlay_nr, int unittest_nr,
1483 int *overlay_id)
1484 {
1485 const char *overlay_name;
1486
1487 overlay_name = overlay_name_from_nr(overlay_nr);
1488
1489 if (!overlay_data_apply(overlay_name, overlay_id)) {
1490 unittest(0, "could not apply overlay \"%s\"\n",
1491 overlay_name);
1492 return -EFAULT;
1493 }
1494 of_unittest_track_overlay(*overlay_id);
1495
1496 return 0;
1497 }
1498
1499 /* 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)1500 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1501 int unittest_nr, int before, int after,
1502 enum overlay_type ovtype)
1503 {
1504 int ret, ovcs_id;
1505
1506 /* unittest device must not be in before state */
1507 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1508 unittest(0, "%s with device @\"%s\" %s\n",
1509 overlay_name_from_nr(overlay_nr),
1510 unittest_path(unittest_nr, ovtype),
1511 !before ? "enabled" : "disabled");
1512 return -EINVAL;
1513 }
1514
1515 ovcs_id = 0;
1516 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1517 if (ret != 0) {
1518 /* of_unittest_apply_overlay already called unittest() */
1519 return ret;
1520 }
1521
1522 /* unittest device must be to set to after state */
1523 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1524 unittest(0, "%s failed to create @\"%s\" %s\n",
1525 overlay_name_from_nr(overlay_nr),
1526 unittest_path(unittest_nr, ovtype),
1527 !after ? "enabled" : "disabled");
1528 return -EINVAL;
1529 }
1530
1531 return 0;
1532 }
1533
1534 /* 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)1535 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1536 int unittest_nr, int before, int after,
1537 enum overlay_type ovtype)
1538 {
1539 int ret, ovcs_id;
1540
1541 /* unittest device must be in before state */
1542 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1543 unittest(0, "%s with device @\"%s\" %s\n",
1544 overlay_name_from_nr(overlay_nr),
1545 unittest_path(unittest_nr, ovtype),
1546 !before ? "enabled" : "disabled");
1547 return -EINVAL;
1548 }
1549
1550 /* apply the overlay */
1551 ovcs_id = 0;
1552 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1553 if (ret != 0) {
1554 /* of_unittest_apply_overlay already called unittest() */
1555 return ret;
1556 }
1557
1558 /* unittest device must be in after state */
1559 if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1560 unittest(0, "%s failed to create @\"%s\" %s\n",
1561 overlay_name_from_nr(overlay_nr),
1562 unittest_path(unittest_nr, ovtype),
1563 !after ? "enabled" : "disabled");
1564 return -EINVAL;
1565 }
1566
1567 ret = of_overlay_remove(&ovcs_id);
1568 if (ret != 0) {
1569 unittest(0, "%s failed to be destroyed @\"%s\"\n",
1570 overlay_name_from_nr(overlay_nr),
1571 unittest_path(unittest_nr, ovtype));
1572 return ret;
1573 }
1574
1575 /* unittest device must be again in before state */
1576 if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1577 unittest(0, "%s with device @\"%s\" %s\n",
1578 overlay_name_from_nr(overlay_nr),
1579 unittest_path(unittest_nr, ovtype),
1580 !before ? "enabled" : "disabled");
1581 return -EINVAL;
1582 }
1583
1584 return 0;
1585 }
1586
1587 /* test activation of device */
of_unittest_overlay_0(void)1588 static void __init of_unittest_overlay_0(void)
1589 {
1590 /* device should enable */
1591 if (of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY))
1592 return;
1593
1594 unittest(1, "overlay test %d passed\n", 0);
1595 }
1596
1597 /* test deactivation of device */
of_unittest_overlay_1(void)1598 static void __init of_unittest_overlay_1(void)
1599 {
1600 /* device should disable */
1601 if (of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY))
1602 return;
1603
1604 unittest(1, "overlay test %d passed\n", 1);
1605 }
1606
1607 /* test activation of device */
of_unittest_overlay_2(void)1608 static void __init of_unittest_overlay_2(void)
1609 {
1610 /* device should enable */
1611 if (of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY))
1612 return;
1613
1614 unittest(1, "overlay test %d passed\n", 2);
1615 }
1616
1617 /* test deactivation of device */
of_unittest_overlay_3(void)1618 static void __init of_unittest_overlay_3(void)
1619 {
1620 /* device should disable */
1621 if (of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY))
1622 return;
1623
1624 unittest(1, "overlay test %d passed\n", 3);
1625 }
1626
1627 /* test activation of a full device node */
of_unittest_overlay_4(void)1628 static void __init of_unittest_overlay_4(void)
1629 {
1630 /* device should disable */
1631 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
1632 return;
1633
1634 unittest(1, "overlay test %d passed\n", 4);
1635 }
1636
1637 /* test overlay apply/revert sequence */
of_unittest_overlay_5(void)1638 static void __init of_unittest_overlay_5(void)
1639 {
1640 /* device should disable */
1641 if (of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY))
1642 return;
1643
1644 unittest(1, "overlay test %d passed\n", 5);
1645 }
1646
1647 /* test overlay application in sequence */
of_unittest_overlay_6(void)1648 static void __init of_unittest_overlay_6(void)
1649 {
1650 int i, ov_id[2], ovcs_id;
1651 int overlay_nr = 6, unittest_nr = 6;
1652 int before = 0, after = 1;
1653 const char *overlay_name;
1654
1655 /* unittest device must be in before state */
1656 for (i = 0; i < 2; i++) {
1657 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1658 != before) {
1659 unittest(0, "%s with device @\"%s\" %s\n",
1660 overlay_name_from_nr(overlay_nr + i),
1661 unittest_path(unittest_nr + i,
1662 PDEV_OVERLAY),
1663 !before ? "enabled" : "disabled");
1664 return;
1665 }
1666 }
1667
1668 /* apply the overlays */
1669 for (i = 0; i < 2; i++) {
1670
1671 overlay_name = overlay_name_from_nr(overlay_nr + i);
1672
1673 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1674 unittest(0, "could not apply overlay \"%s\"\n",
1675 overlay_name);
1676 return;
1677 }
1678 ov_id[i] = ovcs_id;
1679 of_unittest_track_overlay(ov_id[i]);
1680 }
1681
1682 for (i = 0; i < 2; i++) {
1683 /* unittest device must be in after state */
1684 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1685 != after) {
1686 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1687 overlay_name_from_nr(overlay_nr + i),
1688 unittest_path(unittest_nr + i,
1689 PDEV_OVERLAY),
1690 !after ? "enabled" : "disabled");
1691 return;
1692 }
1693 }
1694
1695 for (i = 1; i >= 0; i--) {
1696 ovcs_id = ov_id[i];
1697 if (of_overlay_remove(&ovcs_id)) {
1698 unittest(0, "%s failed destroy @\"%s\"\n",
1699 overlay_name_from_nr(overlay_nr + i),
1700 unittest_path(unittest_nr + i,
1701 PDEV_OVERLAY));
1702 return;
1703 }
1704 of_unittest_untrack_overlay(ov_id[i]);
1705 }
1706
1707 for (i = 0; i < 2; i++) {
1708 /* unittest device must be again in before state */
1709 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1710 != before) {
1711 unittest(0, "%s with device @\"%s\" %s\n",
1712 overlay_name_from_nr(overlay_nr + i),
1713 unittest_path(unittest_nr + i,
1714 PDEV_OVERLAY),
1715 !before ? "enabled" : "disabled");
1716 return;
1717 }
1718 }
1719
1720 unittest(1, "overlay test %d passed\n", 6);
1721 }
1722
1723 /* test overlay application in sequence */
of_unittest_overlay_8(void)1724 static void __init of_unittest_overlay_8(void)
1725 {
1726 int i, ov_id[2], ovcs_id;
1727 int overlay_nr = 8, unittest_nr = 8;
1728 const char *overlay_name;
1729
1730 /* we don't care about device state in this test */
1731
1732 /* apply the overlays */
1733 for (i = 0; i < 2; i++) {
1734
1735 overlay_name = overlay_name_from_nr(overlay_nr + i);
1736
1737 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1738 unittest(0, "could not apply overlay \"%s\"\n",
1739 overlay_name);
1740 return;
1741 }
1742 ov_id[i] = ovcs_id;
1743 of_unittest_track_overlay(ov_id[i]);
1744 }
1745
1746 /* now try to remove first overlay (it should fail) */
1747 ovcs_id = ov_id[0];
1748 if (!of_overlay_remove(&ovcs_id)) {
1749 unittest(0, "%s was destroyed @\"%s\"\n",
1750 overlay_name_from_nr(overlay_nr + 0),
1751 unittest_path(unittest_nr,
1752 PDEV_OVERLAY));
1753 return;
1754 }
1755
1756 /* removing them in order should work */
1757 for (i = 1; i >= 0; i--) {
1758 ovcs_id = ov_id[i];
1759 if (of_overlay_remove(&ovcs_id)) {
1760 unittest(0, "%s not destroyed @\"%s\"\n",
1761 overlay_name_from_nr(overlay_nr + i),
1762 unittest_path(unittest_nr,
1763 PDEV_OVERLAY));
1764 return;
1765 }
1766 of_unittest_untrack_overlay(ov_id[i]);
1767 }
1768
1769 unittest(1, "overlay test %d passed\n", 8);
1770 }
1771
1772 /* test insertion of a bus with parent devices */
of_unittest_overlay_10(void)1773 static void __init of_unittest_overlay_10(void)
1774 {
1775 int ret;
1776 char *child_path;
1777
1778 /* device should disable */
1779 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1780 if (unittest(ret == 0,
1781 "overlay test %d failed; overlay application\n", 10))
1782 return;
1783
1784 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1785 unittest_path(10, PDEV_OVERLAY));
1786 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1787 return;
1788
1789 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1790 kfree(child_path);
1791
1792 unittest(ret, "overlay test %d failed; no child device\n", 10);
1793 }
1794
1795 /* test insertion of a bus with parent devices (and revert) */
of_unittest_overlay_11(void)1796 static void __init of_unittest_overlay_11(void)
1797 {
1798 int ret;
1799
1800 /* device should disable */
1801 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1802 PDEV_OVERLAY);
1803 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
1804 }
1805
1806 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1807
1808 struct unittest_i2c_bus_data {
1809 struct platform_device *pdev;
1810 struct i2c_adapter adap;
1811 };
1812
unittest_i2c_master_xfer(struct i2c_adapter * adap,struct i2c_msg * msgs,int num)1813 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1814 struct i2c_msg *msgs, int num)
1815 {
1816 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1817
1818 (void)std;
1819
1820 return num;
1821 }
1822
unittest_i2c_functionality(struct i2c_adapter * adap)1823 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1824 {
1825 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1826 }
1827
1828 static const struct i2c_algorithm unittest_i2c_algo = {
1829 .master_xfer = unittest_i2c_master_xfer,
1830 .functionality = unittest_i2c_functionality,
1831 };
1832
unittest_i2c_bus_probe(struct platform_device * pdev)1833 static int unittest_i2c_bus_probe(struct platform_device *pdev)
1834 {
1835 struct device *dev = &pdev->dev;
1836 struct device_node *np = dev->of_node;
1837 struct unittest_i2c_bus_data *std;
1838 struct i2c_adapter *adap;
1839 int ret;
1840
1841 if (np == NULL) {
1842 dev_err(dev, "No OF data for device\n");
1843 return -EINVAL;
1844
1845 }
1846
1847 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1848
1849 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1850 if (!std) {
1851 dev_err(dev, "Failed to allocate unittest i2c data\n");
1852 return -ENOMEM;
1853 }
1854
1855 /* link them together */
1856 std->pdev = pdev;
1857 platform_set_drvdata(pdev, std);
1858
1859 adap = &std->adap;
1860 i2c_set_adapdata(adap, std);
1861 adap->nr = -1;
1862 strlcpy(adap->name, pdev->name, sizeof(adap->name));
1863 adap->class = I2C_CLASS_DEPRECATED;
1864 adap->algo = &unittest_i2c_algo;
1865 adap->dev.parent = dev;
1866 adap->dev.of_node = dev->of_node;
1867 adap->timeout = 5 * HZ;
1868 adap->retries = 3;
1869
1870 ret = i2c_add_numbered_adapter(adap);
1871 if (ret != 0) {
1872 dev_err(dev, "Failed to add I2C adapter\n");
1873 return ret;
1874 }
1875
1876 return 0;
1877 }
1878
unittest_i2c_bus_remove(struct platform_device * pdev)1879 static int unittest_i2c_bus_remove(struct platform_device *pdev)
1880 {
1881 struct device *dev = &pdev->dev;
1882 struct device_node *np = dev->of_node;
1883 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1884
1885 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1886 i2c_del_adapter(&std->adap);
1887
1888 return 0;
1889 }
1890
1891 static const struct of_device_id unittest_i2c_bus_match[] = {
1892 { .compatible = "unittest-i2c-bus", },
1893 {},
1894 };
1895
1896 static struct platform_driver unittest_i2c_bus_driver = {
1897 .probe = unittest_i2c_bus_probe,
1898 .remove = unittest_i2c_bus_remove,
1899 .driver = {
1900 .name = "unittest-i2c-bus",
1901 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1902 },
1903 };
1904
unittest_i2c_dev_probe(struct i2c_client * client,const struct i2c_device_id * id)1905 static int unittest_i2c_dev_probe(struct i2c_client *client,
1906 const struct i2c_device_id *id)
1907 {
1908 struct device *dev = &client->dev;
1909 struct device_node *np = client->dev.of_node;
1910
1911 if (!np) {
1912 dev_err(dev, "No OF node\n");
1913 return -EINVAL;
1914 }
1915
1916 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1917
1918 return 0;
1919 };
1920
unittest_i2c_dev_remove(struct i2c_client * client)1921 static int unittest_i2c_dev_remove(struct i2c_client *client)
1922 {
1923 struct device *dev = &client->dev;
1924 struct device_node *np = client->dev.of_node;
1925
1926 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1927 return 0;
1928 }
1929
1930 static const struct i2c_device_id unittest_i2c_dev_id[] = {
1931 { .name = "unittest-i2c-dev" },
1932 { }
1933 };
1934
1935 static struct i2c_driver unittest_i2c_dev_driver = {
1936 .driver = {
1937 .name = "unittest-i2c-dev",
1938 },
1939 .probe = unittest_i2c_dev_probe,
1940 .remove = unittest_i2c_dev_remove,
1941 .id_table = unittest_i2c_dev_id,
1942 };
1943
1944 #if IS_BUILTIN(CONFIG_I2C_MUX)
1945
unittest_i2c_mux_select_chan(struct i2c_mux_core * muxc,u32 chan)1946 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1947 {
1948 return 0;
1949 }
1950
unittest_i2c_mux_probe(struct i2c_client * client,const struct i2c_device_id * id)1951 static int unittest_i2c_mux_probe(struct i2c_client *client,
1952 const struct i2c_device_id *id)
1953 {
1954 int i, nchans;
1955 struct device *dev = &client->dev;
1956 struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1957 struct device_node *np = client->dev.of_node, *child;
1958 struct i2c_mux_core *muxc;
1959 u32 reg, max_reg;
1960
1961 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1962
1963 if (!np) {
1964 dev_err(dev, "No OF node\n");
1965 return -EINVAL;
1966 }
1967
1968 max_reg = (u32)-1;
1969 for_each_child_of_node(np, child) {
1970 if (of_property_read_u32(child, "reg", ®))
1971 continue;
1972 if (max_reg == (u32)-1 || reg > max_reg)
1973 max_reg = reg;
1974 }
1975 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1976 if (nchans == 0) {
1977 dev_err(dev, "No channels\n");
1978 return -EINVAL;
1979 }
1980
1981 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1982 unittest_i2c_mux_select_chan, NULL);
1983 if (!muxc)
1984 return -ENOMEM;
1985 for (i = 0; i < nchans; i++) {
1986 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
1987 dev_err(dev, "Failed to register mux #%d\n", i);
1988 i2c_mux_del_adapters(muxc);
1989 return -ENODEV;
1990 }
1991 }
1992
1993 i2c_set_clientdata(client, muxc);
1994
1995 return 0;
1996 };
1997
unittest_i2c_mux_remove(struct i2c_client * client)1998 static int unittest_i2c_mux_remove(struct i2c_client *client)
1999 {
2000 struct device *dev = &client->dev;
2001 struct device_node *np = client->dev.of_node;
2002 struct i2c_mux_core *muxc = i2c_get_clientdata(client);
2003
2004 dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2005 i2c_mux_del_adapters(muxc);
2006 return 0;
2007 }
2008
2009 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2010 { .name = "unittest-i2c-mux" },
2011 { }
2012 };
2013
2014 static struct i2c_driver unittest_i2c_mux_driver = {
2015 .driver = {
2016 .name = "unittest-i2c-mux",
2017 },
2018 .probe = unittest_i2c_mux_probe,
2019 .remove = unittest_i2c_mux_remove,
2020 .id_table = unittest_i2c_mux_id,
2021 };
2022
2023 #endif
2024
of_unittest_overlay_i2c_init(void)2025 static int of_unittest_overlay_i2c_init(void)
2026 {
2027 int ret;
2028
2029 ret = i2c_add_driver(&unittest_i2c_dev_driver);
2030 if (unittest(ret == 0,
2031 "could not register unittest i2c device driver\n"))
2032 return ret;
2033
2034 ret = platform_driver_register(&unittest_i2c_bus_driver);
2035 if (unittest(ret == 0,
2036 "could not register unittest i2c bus driver\n"))
2037 return ret;
2038
2039 #if IS_BUILTIN(CONFIG_I2C_MUX)
2040 ret = i2c_add_driver(&unittest_i2c_mux_driver);
2041 if (unittest(ret == 0,
2042 "could not register unittest i2c mux driver\n"))
2043 return ret;
2044 #endif
2045
2046 return 0;
2047 }
2048
of_unittest_overlay_i2c_cleanup(void)2049 static void of_unittest_overlay_i2c_cleanup(void)
2050 {
2051 #if IS_BUILTIN(CONFIG_I2C_MUX)
2052 i2c_del_driver(&unittest_i2c_mux_driver);
2053 #endif
2054 platform_driver_unregister(&unittest_i2c_bus_driver);
2055 i2c_del_driver(&unittest_i2c_dev_driver);
2056 }
2057
of_unittest_overlay_i2c_12(void)2058 static void __init of_unittest_overlay_i2c_12(void)
2059 {
2060 /* device should enable */
2061 if (of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY))
2062 return;
2063
2064 unittest(1, "overlay test %d passed\n", 12);
2065 }
2066
2067 /* test deactivation of device */
of_unittest_overlay_i2c_13(void)2068 static void __init of_unittest_overlay_i2c_13(void)
2069 {
2070 /* device should disable */
2071 if (of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY))
2072 return;
2073
2074 unittest(1, "overlay test %d passed\n", 13);
2075 }
2076
2077 /* just check for i2c mux existence */
of_unittest_overlay_i2c_14(void)2078 static void of_unittest_overlay_i2c_14(void)
2079 {
2080 }
2081
of_unittest_overlay_i2c_15(void)2082 static void __init of_unittest_overlay_i2c_15(void)
2083 {
2084 /* device should enable */
2085 if (of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY))
2086 return;
2087
2088 unittest(1, "overlay test %d passed\n", 15);
2089 }
2090
2091 #else
2092
of_unittest_overlay_i2c_14(void)2093 static inline void of_unittest_overlay_i2c_14(void) { }
of_unittest_overlay_i2c_15(void)2094 static inline void of_unittest_overlay_i2c_15(void) { }
2095
2096 #endif
2097
of_unittest_overlay(void)2098 static void __init of_unittest_overlay(void)
2099 {
2100 struct device_node *bus_np = NULL;
2101
2102 if (platform_driver_register(&unittest_driver)) {
2103 unittest(0, "could not register unittest driver\n");
2104 goto out;
2105 }
2106
2107 bus_np = of_find_node_by_path(bus_path);
2108 if (bus_np == NULL) {
2109 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2110 goto out;
2111 }
2112
2113 if (of_platform_default_populate(bus_np, NULL, NULL)) {
2114 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2115 goto out;
2116 }
2117
2118 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2119 unittest(0, "could not find unittest0 @ \"%s\"\n",
2120 unittest_path(100, PDEV_OVERLAY));
2121 goto out;
2122 }
2123
2124 if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2125 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2126 unittest_path(101, PDEV_OVERLAY));
2127 goto out;
2128 }
2129
2130 unittest(1, "basic infrastructure of overlays passed");
2131
2132 /* tests in sequence */
2133 of_unittest_overlay_0();
2134 of_unittest_overlay_1();
2135 of_unittest_overlay_2();
2136 of_unittest_overlay_3();
2137 of_unittest_overlay_4();
2138 of_unittest_overlay_5();
2139 of_unittest_overlay_6();
2140 of_unittest_overlay_8();
2141
2142 of_unittest_overlay_10();
2143 of_unittest_overlay_11();
2144
2145 #if IS_BUILTIN(CONFIG_I2C)
2146 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2147 goto out;
2148
2149 of_unittest_overlay_i2c_12();
2150 of_unittest_overlay_i2c_13();
2151 of_unittest_overlay_i2c_14();
2152 of_unittest_overlay_i2c_15();
2153
2154 of_unittest_overlay_i2c_cleanup();
2155 #endif
2156
2157 of_unittest_destroy_tracked_overlays();
2158
2159 out:
2160 of_node_put(bus_np);
2161 }
2162
2163 #else
of_unittest_overlay(void)2164 static inline void __init of_unittest_overlay(void) { }
2165 #endif
2166
2167 #ifdef CONFIG_OF_OVERLAY
2168
2169 /*
2170 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2171 * in scripts/Makefile.lib
2172 */
2173
2174 #define OVERLAY_INFO_EXTERN(name) \
2175 extern uint8_t __dtb_##name##_begin[]; \
2176 extern uint8_t __dtb_##name##_end[]
2177
2178 #define OVERLAY_INFO(overlay_name, expected) \
2179 { .dtb_begin = __dtb_##overlay_name##_begin, \
2180 .dtb_end = __dtb_##overlay_name##_end, \
2181 .expected_result = expected, \
2182 .name = #overlay_name, \
2183 }
2184
2185 struct overlay_info {
2186 uint8_t *dtb_begin;
2187 uint8_t *dtb_end;
2188 int expected_result;
2189 int overlay_id;
2190 char *name;
2191 };
2192
2193 OVERLAY_INFO_EXTERN(overlay_base);
2194 OVERLAY_INFO_EXTERN(overlay);
2195 OVERLAY_INFO_EXTERN(overlay_0);
2196 OVERLAY_INFO_EXTERN(overlay_1);
2197 OVERLAY_INFO_EXTERN(overlay_2);
2198 OVERLAY_INFO_EXTERN(overlay_3);
2199 OVERLAY_INFO_EXTERN(overlay_4);
2200 OVERLAY_INFO_EXTERN(overlay_5);
2201 OVERLAY_INFO_EXTERN(overlay_6);
2202 OVERLAY_INFO_EXTERN(overlay_7);
2203 OVERLAY_INFO_EXTERN(overlay_8);
2204 OVERLAY_INFO_EXTERN(overlay_9);
2205 OVERLAY_INFO_EXTERN(overlay_10);
2206 OVERLAY_INFO_EXTERN(overlay_11);
2207 OVERLAY_INFO_EXTERN(overlay_12);
2208 OVERLAY_INFO_EXTERN(overlay_13);
2209 OVERLAY_INFO_EXTERN(overlay_15);
2210 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2211 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2212
2213 /* order of entries is hard-coded into users of overlays[] */
2214 static struct overlay_info overlays[] = {
2215 OVERLAY_INFO(overlay_base, -9999),
2216 OVERLAY_INFO(overlay, 0),
2217 OVERLAY_INFO(overlay_0, 0),
2218 OVERLAY_INFO(overlay_1, 0),
2219 OVERLAY_INFO(overlay_2, 0),
2220 OVERLAY_INFO(overlay_3, 0),
2221 OVERLAY_INFO(overlay_4, 0),
2222 OVERLAY_INFO(overlay_5, 0),
2223 OVERLAY_INFO(overlay_6, 0),
2224 OVERLAY_INFO(overlay_7, 0),
2225 OVERLAY_INFO(overlay_8, 0),
2226 OVERLAY_INFO(overlay_9, 0),
2227 OVERLAY_INFO(overlay_10, 0),
2228 OVERLAY_INFO(overlay_11, 0),
2229 OVERLAY_INFO(overlay_12, 0),
2230 OVERLAY_INFO(overlay_13, 0),
2231 OVERLAY_INFO(overlay_15, 0),
2232 OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2233 OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2234 {}
2235 };
2236
2237 static struct device_node *overlay_base_root;
2238
dt_alloc_memory(u64 size,u64 align)2239 static void * __init dt_alloc_memory(u64 size, u64 align)
2240 {
2241 return memblock_virt_alloc(size, align);
2242 }
2243
2244 /*
2245 * Create base device tree for the overlay unittest.
2246 *
2247 * This is called from very early boot code.
2248 *
2249 * Do as much as possible the same way as done in __unflatten_device_tree
2250 * and other early boot steps for the normal FDT so that the overlay base
2251 * unflattened tree will have the same characteristics as the real tree
2252 * (such as having memory allocated by the early allocator). The goal
2253 * is to test "the real thing" as much as possible, and test "test setup
2254 * code" as little as possible.
2255 *
2256 * Have to stop before resolving phandles, because that uses kmalloc.
2257 */
unittest_unflatten_overlay_base(void)2258 void __init unittest_unflatten_overlay_base(void)
2259 {
2260 struct overlay_info *info;
2261 u32 data_size;
2262 void *new_fdt;
2263 u32 size;
2264
2265 info = &overlays[0];
2266
2267 if (info->expected_result != -9999) {
2268 pr_err("No dtb 'overlay_base' to attach\n");
2269 return;
2270 }
2271
2272 data_size = info->dtb_end - info->dtb_begin;
2273 if (!data_size) {
2274 pr_err("No dtb 'overlay_base' to attach\n");
2275 return;
2276 }
2277
2278 size = fdt_totalsize(info->dtb_begin);
2279 if (size != data_size) {
2280 pr_err("dtb 'overlay_base' header totalsize != actual size");
2281 return;
2282 }
2283
2284 new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2285 if (!new_fdt) {
2286 pr_err("alloc for dtb 'overlay_base' failed");
2287 return;
2288 }
2289
2290 memcpy(new_fdt, info->dtb_begin, size);
2291
2292 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2293 dt_alloc_memory, true);
2294 }
2295
2296 /*
2297 * The purpose of of_unittest_overlay_data_add is to add an
2298 * overlay in the normal fashion. This is a test of the whole
2299 * picture, instead of testing individual elements.
2300 *
2301 * A secondary purpose is to be able to verify that the contents of
2302 * /proc/device-tree/ contains the updated structure and values from
2303 * the overlay. That must be verified separately in user space.
2304 *
2305 * Return 0 on unexpected error.
2306 */
overlay_data_apply(const char * overlay_name,int * overlay_id)2307 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2308 {
2309 struct overlay_info *info;
2310 int found = 0;
2311 int k;
2312 int ret;
2313 u32 size;
2314
2315 for (k = 0, info = overlays; info && info->name; info++, k++) {
2316 if (!strcmp(overlay_name, info->name)) {
2317 found = 1;
2318 break;
2319 }
2320 }
2321 if (!found) {
2322 pr_err("no overlay data for %s\n", overlay_name);
2323 return 0;
2324 }
2325
2326 size = info->dtb_end - info->dtb_begin;
2327 if (!size)
2328 pr_err("no overlay data for %s\n", overlay_name);
2329
2330 ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2331 if (overlay_id)
2332 *overlay_id = info->overlay_id;
2333 if (ret < 0)
2334 goto out;
2335
2336 pr_debug("%s applied\n", overlay_name);
2337
2338 out:
2339 if (ret != info->expected_result)
2340 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2341 info->expected_result, ret, overlay_name);
2342
2343 return (ret == info->expected_result);
2344 }
2345
2346 /*
2347 * The purpose of of_unittest_overlay_high_level is to add an overlay
2348 * in the normal fashion. This is a test of the whole picture,
2349 * instead of individual elements.
2350 *
2351 * The first part of the function is _not_ normal overlay usage; it is
2352 * finishing splicing the base overlay device tree into the live tree.
2353 */
of_unittest_overlay_high_level(void)2354 static __init void of_unittest_overlay_high_level(void)
2355 {
2356 struct device_node *last_sibling;
2357 struct device_node *np;
2358 struct device_node *of_symbols;
2359 struct device_node *overlay_base_symbols;
2360 struct device_node **pprev;
2361 struct property *prop;
2362
2363 if (!overlay_base_root) {
2364 unittest(0, "overlay_base_root not initialized\n");
2365 return;
2366 }
2367
2368 /*
2369 * Could not fixup phandles in unittest_unflatten_overlay_base()
2370 * because kmalloc() was not yet available.
2371 */
2372 of_overlay_mutex_lock();
2373 of_resolve_phandles(overlay_base_root);
2374 of_overlay_mutex_unlock();
2375
2376
2377 /*
2378 * do not allow overlay_base to duplicate any node already in
2379 * tree, this greatly simplifies the code
2380 */
2381
2382 /*
2383 * remove overlay_base_root node "__local_fixups", after
2384 * being used by of_resolve_phandles()
2385 */
2386 pprev = &overlay_base_root->child;
2387 for (np = overlay_base_root->child; np; np = np->sibling) {
2388 if (!of_node_cmp(np->name, "__local_fixups__")) {
2389 *pprev = np->sibling;
2390 break;
2391 }
2392 pprev = &np->sibling;
2393 }
2394
2395 /* remove overlay_base_root node "__symbols__" if in live tree */
2396 of_symbols = of_get_child_by_name(of_root, "__symbols__");
2397 if (of_symbols) {
2398 /* will have to graft properties from node into live tree */
2399 pprev = &overlay_base_root->child;
2400 for (np = overlay_base_root->child; np; np = np->sibling) {
2401 if (!of_node_cmp(np->name, "__symbols__")) {
2402 overlay_base_symbols = np;
2403 *pprev = np->sibling;
2404 break;
2405 }
2406 pprev = &np->sibling;
2407 }
2408 }
2409
2410 for (np = overlay_base_root->child; np; np = np->sibling) {
2411 if (of_get_child_by_name(of_root, np->name)) {
2412 unittest(0, "illegal node name in overlay_base %s",
2413 np->name);
2414 return;
2415 }
2416 }
2417
2418 /*
2419 * overlay 'overlay_base' is not allowed to have root
2420 * properties, so only need to splice nodes into main device tree.
2421 *
2422 * root node of *overlay_base_root will not be freed, it is lost
2423 * memory.
2424 */
2425
2426 for (np = overlay_base_root->child; np; np = np->sibling)
2427 np->parent = of_root;
2428
2429 mutex_lock(&of_mutex);
2430
2431 for (last_sibling = np = of_root->child; np; np = np->sibling)
2432 last_sibling = np;
2433
2434 if (last_sibling)
2435 last_sibling->sibling = overlay_base_root->child;
2436 else
2437 of_root->child = overlay_base_root->child;
2438
2439 for_each_of_allnodes_from(overlay_base_root, np)
2440 __of_attach_node_sysfs(np);
2441
2442 if (of_symbols) {
2443 struct property *new_prop;
2444 for_each_property_of_node(overlay_base_symbols, prop) {
2445
2446 new_prop = __of_prop_dup(prop, GFP_KERNEL);
2447 if (!new_prop) {
2448 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
2449 prop->name);
2450 goto err_unlock;
2451 }
2452 if (__of_add_property(of_symbols, new_prop)) {
2453 kfree(new_prop->name);
2454 kfree(new_prop->value);
2455 kfree(new_prop);
2456 /* "name" auto-generated by unflatten */
2457 if (!strcmp(prop->name, "name"))
2458 continue;
2459 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
2460 prop->name);
2461 goto err_unlock;
2462 }
2463 if (__of_add_property_sysfs(of_symbols, new_prop)) {
2464 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2465 prop->name);
2466 goto err_unlock;
2467 }
2468 }
2469 }
2470
2471 mutex_unlock(&of_mutex);
2472
2473
2474 /* now do the normal overlay usage test */
2475
2476 unittest(overlay_data_apply("overlay", NULL),
2477 "Adding overlay 'overlay' failed\n");
2478
2479 unittest(overlay_data_apply("overlay_bad_phandle", NULL),
2480 "Adding overlay 'overlay_bad_phandle' failed\n");
2481
2482 unittest(overlay_data_apply("overlay_bad_symbol", NULL),
2483 "Adding overlay 'overlay_bad_symbol' failed\n");
2484
2485 return;
2486
2487 err_unlock:
2488 mutex_unlock(&of_mutex);
2489 }
2490
2491 #else
2492
of_unittest_overlay_high_level(void)2493 static inline __init void of_unittest_overlay_high_level(void) {}
2494
2495 #endif
2496
of_unittest(void)2497 static int __init of_unittest(void)
2498 {
2499 struct device_node *np;
2500 int res;
2501
2502 /* adding data for unittest */
2503 res = unittest_data_add();
2504 if (res)
2505 return res;
2506 if (!of_aliases)
2507 of_aliases = of_find_node_by_path("/aliases");
2508
2509 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2510 if (!np) {
2511 pr_info("No testcase data in device tree; not running tests\n");
2512 return 0;
2513 }
2514 of_node_put(np);
2515
2516 pr_info("start of unittest - you will see error messages\n");
2517 of_unittest_check_tree_linkage();
2518 of_unittest_check_phandles();
2519 of_unittest_find_node_by_name();
2520 of_unittest_dynamic();
2521 of_unittest_parse_phandle_with_args();
2522 of_unittest_parse_phandle_with_args_map();
2523 of_unittest_printf();
2524 of_unittest_property_string();
2525 of_unittest_property_copy();
2526 of_unittest_changeset();
2527 of_unittest_parse_interrupts();
2528 of_unittest_parse_interrupts_extended();
2529 of_unittest_match_node();
2530 of_unittest_platform_populate();
2531 of_unittest_overlay();
2532
2533 /* Double check linkage after removing testcase data */
2534 of_unittest_check_tree_linkage();
2535
2536 of_unittest_overlay_high_level();
2537
2538 pr_info("end of unittest - %i passed, %i failed\n",
2539 unittest_results.passed, unittest_results.failed);
2540
2541 return 0;
2542 }
2543 late_initcall(of_unittest);
2544