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