Merge tag 'devicetree-fixes-for-4.19-3' of git://git.kernel.org/pub/scm/linux/kernel...
[rpmsg/rpmsg.git] / drivers / of / unittest.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Self tests for device tree subsystem
4  */
6 #define pr_fmt(fmt) "### dt-test ### " fmt
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>
24 #include <linux/i2c.h>
25 #include <linux/i2c-mux.h>
27 #include <linux/bitops.h>
29 #include "of_private.h"
31 static struct unittest_results {
32         int passed;
33         int failed;
34 } unittest_results;
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 })
48 static void __init of_unittest_find_node_by_name(void)
49 {
50         struct device_node *np;
51         const char *options, *name;
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);
60         /* Test if trailing '/' works */
61         np = of_find_node_by_path("/testcase-data/");
62         unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
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);
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);
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");
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
147 static void __init of_unittest_dynamic(void)
149         struct device_node *np;
150         struct property *prop;
152         np = of_find_node_by_path("/testcase-data");
153         if (!np) {
154                 pr_err("missing testcase data\n");
155                 return;
156         }
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         }
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");
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");
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");
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");
193         /* Remove property - should pass */
194         unittest(of_remove_property(np, prop) == 0,
195                  "Removing a property should have passed\n");
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");
208 static int __init of_unittest_check_node_linkage(struct device_node *np)
210         struct device_node *child;
211         int count = 0, rc;
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                 }
221                 rc = of_unittest_check_node_linkage(child);
222                 if (rc < 0)
223                         goto put_child;
224                 count += rc;
225         }
227         return count + 1;
228 put_child:
229         of_node_put(child);
230         return rc;
233 static void __init of_unittest_check_tree_linkage(void)
235         struct device_node *np;
236         int allnode_count = 0, child_count;
238         if (!of_root)
239                 return;
241         for_each_of_allnodes(np)
242                 allnode_count++;
243         child_count = of_unittest_check_node_linkage(of_root);
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);
252 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
253                                           const char *expected)
255         unsigned char *buf;
256         int buf_size;
257         int size, i;
259         buf_size = strlen(expected) + 10;
260         buf = kmalloc(buf_size, GFP_KERNEL);
261         if (!buf)
262                 return;
264         /* Baseline; check conversion with a large size limit */
265         memset(buf, 0xff, buf_size);
266         size = snprintf(buf, buf_size - 2, fmt, np);
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);
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);
286 static void __init of_unittest_printf(void)
288         struct device_node *np;
289         const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
290         char phandle_str[16] = "";
292         np = of_find_node_by_path(full_name);
293         if (!np) {
294                 unittest(np, "testcase data missing\n");
295                 return;
296         }
298         num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
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\"");
316 struct node_hash {
317         struct hlist_node node;
318         struct device_node *np;
319 };
321 static DEFINE_HASHTABLE(phandle_ht, 8);
322 static void __init of_unittest_check_phandles(void)
324         struct device_node *np;
325         struct node_hash *nh;
326         struct hlist_node *tmp;
327         int i, dup_count = 0, phandle_count = 0;
329         for_each_of_allnodes(np) {
330                 if (!np->phandle)
331                         continue;
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                 }
342                 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
343                 if (WARN_ON(!nh))
344                         return;
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);
353         /* Clean up */
354         hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
355                 hash_del(&nh->node);
356                 kfree(nh);
357         }
360 static void __init of_unittest_parse_phandle_with_args(void)
362         struct device_node *np;
363         struct of_phandle_args args;
364         int i, rc;
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         }
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);
375         for (i = 0; i < 8; i++) {
376                 bool passed = true;
378                 rc = of_parse_phandle_with_args(np, "phandle-list",
379                                                 "#phandle-cells", i, &args);
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                 }
426                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
427                          i, args.np, rc);
428         }
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);
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);
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);
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);
463 static void __init of_unittest_parse_phandle_with_args_map(void)
465         struct device_node *np, *p0, *p1, *p2, *p3;
466         struct of_phandle_args args;
467         int i, rc;
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         }
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         }
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         }
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         }
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         }
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);
502         for (i = 0; i < 8; i++) {
503                 bool passed = true;
505                 rc = of_parse_phandle_with_args_map(np, "phandle-list",
506                                                     "phandle", i, &args);
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                 }
557                 unittest(passed, "index %i - data error on node %s rc=%i\n",
558                          i, args.np->full_name, rc);
559         }
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);
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);
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);
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);
582 static void __init of_unittest_property_string(void)
584         const char *strings[4];
585         struct device_node *np;
586         int rc;
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         }
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);
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);
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;
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]);
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)
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;
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);
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
688 static void __init of_unittest_changeset(void)
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;
700         n1 = __of_node_dup(NULL, "n1");
701         unittest(n1, "testcase setup failure\n");
703         n2 = __of_node_dup(NULL, "n2");
704         unittest(n2, "testcase setup failure\n");
706         n21 = __of_node_dup(NULL, "n21");
707         unittest(n21, "testcase setup failure %p\n", n21);
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");
713         ppadd = __of_prop_dup(&padd, GFP_KERNEL);
714         unittest(ppadd, "testcase setup failure\n");
716         ppname_n1  = __of_prop_dup(&pname_n1, GFP_KERNEL);
717         unittest(ppname_n1, "testcase setup failure\n");
719         ppname_n2  = __of_prop_dup(&pname_n2, GFP_KERNEL);
720         unittest(ppname_n2, "testcase setup failure\n");
722         ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
723         unittest(ppname_n21, "testcase setup failure\n");
725         ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
726         unittest(ppupdate, "testcase setup failure\n");
728         parent = nchangeset;
729         n1->parent = parent;
730         n2->parent = parent;
731         n21->parent = n2;
733         ppremove = of_find_property(parent, "prop-remove", NULL);
734         unittest(ppremove, "failed to find removal prop");
736         of_changeset_init(&chgset);
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");
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");
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");
747         unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
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");
753         unittest(!of_changeset_apply(&chgset), "apply failed\n");
755         of_node_put(nchangeset);
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);
762         unittest(!of_changeset_revert(&chgset), "revert failed\n");
764         of_changeset_destroy(&chgset);
765 #endif
768 static void __init of_unittest_parse_interrupts(void)
770         struct device_node *np;
771         struct of_phandle_args args;
772         int i, rc;
774         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
775                 return;
777         np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
778         if (!np) {
779                 pr_err("missing testcase data\n");
780                 return;
781         }
783         for (i = 0; i < 4; i++) {
784                 bool passed = true;
786                 args.args_count = 0;
787                 rc = of_irq_parse_one(np, i, &args);
789                 passed &= !rc;
790                 passed &= (args.args_count == 1);
791                 passed &= (args.args[0] == (i + 1));
793                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
794                          i, args.np, rc);
795         }
796         of_node_put(np);
798         np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
799         if (!np) {
800                 pr_err("missing testcase data\n");
801                 return;
802         }
804         for (i = 0; i < 4; i++) {
805                 bool passed = true;
807                 args.args_count = 0;
808                 rc = of_irq_parse_one(np, i, &args);
810                 /* Test the values from tests-phandle.dtsi */
811                 switch (i) {
812                 case 0:
813                         passed &= !rc;
814                         passed &= (args.args_count == 1);
815                         passed &= (args.args[0] == 9);
816                         break;
817                 case 1:
818                         passed &= !rc;
819                         passed &= (args.args_count == 3);
820                         passed &= (args.args[0] == 10);
821                         passed &= (args.args[1] == 11);
822                         passed &= (args.args[2] == 12);
823                         break;
824                 case 2:
825                         passed &= !rc;
826                         passed &= (args.args_count == 2);
827                         passed &= (args.args[0] == 13);
828                         passed &= (args.args[1] == 14);
829                         break;
830                 case 3:
831                         passed &= !rc;
832                         passed &= (args.args_count == 2);
833                         passed &= (args.args[0] == 15);
834                         passed &= (args.args[1] == 16);
835                         break;
836                 default:
837                         passed = false;
838                 }
839                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
840                          i, args.np, rc);
841         }
842         of_node_put(np);
845 static void __init of_unittest_parse_interrupts_extended(void)
847         struct device_node *np;
848         struct of_phandle_args args;
849         int i, rc;
851         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
852                 return;
854         np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
855         if (!np) {
856                 pr_err("missing testcase data\n");
857                 return;
858         }
860         for (i = 0; i < 7; i++) {
861                 bool passed = true;
863                 rc = of_irq_parse_one(np, i, &args);
865                 /* Test the values from tests-phandle.dtsi */
866                 switch (i) {
867                 case 0:
868                         passed &= !rc;
869                         passed &= (args.args_count == 1);
870                         passed &= (args.args[0] == 1);
871                         break;
872                 case 1:
873                         passed &= !rc;
874                         passed &= (args.args_count == 3);
875                         passed &= (args.args[0] == 2);
876                         passed &= (args.args[1] == 3);
877                         passed &= (args.args[2] == 4);
878                         break;
879                 case 2:
880                         passed &= !rc;
881                         passed &= (args.args_count == 2);
882                         passed &= (args.args[0] == 5);
883                         passed &= (args.args[1] == 6);
884                         break;
885                 case 3:
886                         passed &= !rc;
887                         passed &= (args.args_count == 1);
888                         passed &= (args.args[0] == 9);
889                         break;
890                 case 4:
891                         passed &= !rc;
892                         passed &= (args.args_count == 3);
893                         passed &= (args.args[0] == 10);
894                         passed &= (args.args[1] == 11);
895                         passed &= (args.args[2] == 12);
896                         break;
897                 case 5:
898                         passed &= !rc;
899                         passed &= (args.args_count == 2);
900                         passed &= (args.args[0] == 13);
901                         passed &= (args.args[1] == 14);
902                         break;
903                 case 6:
904                         passed &= !rc;
905                         passed &= (args.args_count == 1);
906                         passed &= (args.args[0] == 15);
907                         break;
908                 default:
909                         passed = false;
910                 }
912                 unittest(passed, "index %i - data error on node %pOF rc=%i\n",
913                          i, args.np, rc);
914         }
915         of_node_put(np);
918 static const struct of_device_id match_node_table[] = {
919         { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
920         { .data = "B", .type = "type1", }, /* followed by type alone */
922         { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
923         { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
924         { .data = "Cc", .name = "name2", .type = "type2", },
926         { .data = "E", .compatible = "compat3" },
927         { .data = "G", .compatible = "compat2", },
928         { .data = "H", .compatible = "compat2", .name = "name5", },
929         { .data = "I", .compatible = "compat2", .type = "type1", },
930         { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
931         { .data = "K", .compatible = "compat2", .name = "name9", },
932         {}
933 };
935 static struct {
936         const char *path;
937         const char *data;
938 } match_node_tests[] = {
939         { .path = "/testcase-data/match-node/name0", .data = "A", },
940         { .path = "/testcase-data/match-node/name1", .data = "B", },
941         { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
942         { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
943         { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
944         { .path = "/testcase-data/match-node/name3", .data = "E", },
945         { .path = "/testcase-data/match-node/name4", .data = "G", },
946         { .path = "/testcase-data/match-node/name5", .data = "H", },
947         { .path = "/testcase-data/match-node/name6", .data = "G", },
948         { .path = "/testcase-data/match-node/name7", .data = "I", },
949         { .path = "/testcase-data/match-node/name8", .data = "J", },
950         { .path = "/testcase-data/match-node/name9", .data = "K", },
951 };
953 static void __init of_unittest_match_node(void)
955         struct device_node *np;
956         const struct of_device_id *match;
957         int i;
959         for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
960                 np = of_find_node_by_path(match_node_tests[i].path);
961                 if (!np) {
962                         unittest(0, "missing testcase node %s\n",
963                                 match_node_tests[i].path);
964                         continue;
965                 }
967                 match = of_match_node(match_node_table, np);
968                 if (!match) {
969                         unittest(0, "%s didn't match anything\n",
970                                 match_node_tests[i].path);
971                         continue;
972                 }
974                 if (strcmp(match->data, match_node_tests[i].data) != 0) {
975                         unittest(0, "%s got wrong match. expected %s, got %s\n",
976                                 match_node_tests[i].path, match_node_tests[i].data,
977                                 (const char *)match->data);
978                         continue;
979                 }
980                 unittest(1, "passed");
981         }
984 static struct resource test_bus_res = {
985         .start = 0xfffffff8,
986         .end = 0xfffffff9,
987         .flags = IORESOURCE_MEM,
988 };
989 static const struct platform_device_info test_bus_info = {
990         .name = "unittest-bus",
991 };
992 static void __init of_unittest_platform_populate(void)
994         int irq, rc;
995         struct device_node *np, *child, *grandchild;
996         struct platform_device *pdev, *test_bus;
997         const struct of_device_id match[] = {
998                 { .compatible = "test-device", },
999                 {}
1000         };
1002         np = of_find_node_by_path("/testcase-data");
1003         of_platform_default_populate(np, NULL, NULL);
1005         /* Test that a missing irq domain returns -EPROBE_DEFER */
1006         np = of_find_node_by_path("/testcase-data/testcase-device1");
1007         pdev = of_find_device_by_node(np);
1008         unittest(pdev, "device 1 creation failed\n");
1010         if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1011                 irq = platform_get_irq(pdev, 0);
1012                 unittest(irq == -EPROBE_DEFER,
1013                          "device deferred probe failed - %d\n", irq);
1015                 /* Test that a parsing failure does not return -EPROBE_DEFER */
1016                 np = of_find_node_by_path("/testcase-data/testcase-device2");
1017                 pdev = of_find_device_by_node(np);
1018                 unittest(pdev, "device 2 creation failed\n");
1019                 irq = platform_get_irq(pdev, 0);
1020                 unittest(irq < 0 && irq != -EPROBE_DEFER,
1021                          "device parsing error failed - %d\n", irq);
1022         }
1024         np = of_find_node_by_path("/testcase-data/platform-tests");
1025         unittest(np, "No testcase data in device tree\n");
1026         if (!np)
1027                 return;
1029         test_bus = platform_device_register_full(&test_bus_info);
1030         rc = PTR_ERR_OR_ZERO(test_bus);
1031         unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1032         if (rc)
1033                 return;
1034         test_bus->dev.of_node = np;
1036         /*
1037          * Add a dummy resource to the test bus node after it is
1038          * registered to catch problems with un-inserted resources. The
1039          * DT code doesn't insert the resources, and it has caused the
1040          * kernel to oops in the past. This makes sure the same bug
1041          * doesn't crop up again.
1042          */
1043         platform_device_add_resources(test_bus, &test_bus_res, 1);
1045         of_platform_populate(np, match, NULL, &test_bus->dev);
1046         for_each_child_of_node(np, child) {
1047                 for_each_child_of_node(child, grandchild)
1048                         unittest(of_find_device_by_node(grandchild),
1049                                  "Could not create device for node '%s'\n",
1050                                  grandchild->name);
1051         }
1053         of_platform_depopulate(&test_bus->dev);
1054         for_each_child_of_node(np, child) {
1055                 for_each_child_of_node(child, grandchild)
1056                         unittest(!of_find_device_by_node(grandchild),
1057                                  "device didn't get destroyed '%s'\n",
1058                                  grandchild->name);
1059         }
1061         platform_device_unregister(test_bus);
1062         of_node_put(np);
1065 /**
1066  *      update_node_properties - adds the properties
1067  *      of np into dup node (present in live tree) and
1068  *      updates parent of children of np to dup.
1069  *
1070  *      @np:    node already present in live tree
1071  *      @dup:   node present in live tree to be updated
1072  */
1073 static void update_node_properties(struct device_node *np,
1074                                         struct device_node *dup)
1076         struct property *prop;
1077         struct device_node *child;
1079         for_each_property_of_node(np, prop)
1080                 of_add_property(dup, prop);
1082         for_each_child_of_node(np, child)
1083                 child->parent = dup;
1086 /**
1087  *      attach_node_and_children - attaches nodes
1088  *      and its children to live tree
1089  *
1090  *      @np:    Node to attach to live tree
1091  */
1092 static int attach_node_and_children(struct device_node *np)
1094         struct device_node *next, *dup, *child;
1095         unsigned long flags;
1096         const char *full_name;
1098         full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1099         dup = of_find_node_by_path(full_name);
1100         kfree(full_name);
1101         if (dup) {
1102                 update_node_properties(np, dup);
1103                 return 0;
1104         }
1106         child = np->child;
1107         np->child = NULL;
1109         mutex_lock(&of_mutex);
1110         raw_spin_lock_irqsave(&devtree_lock, flags);
1111         np->sibling = np->parent->child;
1112         np->parent->child = np;
1113         of_node_clear_flag(np, OF_DETACHED);
1114         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1116         __of_attach_node_sysfs(np);
1117         mutex_unlock(&of_mutex);
1119         while (child) {
1120                 next = child->sibling;
1121                 attach_node_and_children(child);
1122                 child = next;
1123         }
1125         return 0;
1128 /**
1129  *      unittest_data_add - Reads, copies data from
1130  *      linked tree and attaches it to the live tree
1131  */
1132 static int __init unittest_data_add(void)
1134         void *unittest_data;
1135         struct device_node *unittest_data_node, *np;
1136         /*
1137          * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1138          * created by cmd_dt_S_dtb in scripts/Makefile.lib
1139          */
1140         extern uint8_t __dtb_testcases_begin[];
1141         extern uint8_t __dtb_testcases_end[];
1142         const int size = __dtb_testcases_end - __dtb_testcases_begin;
1143         int rc;
1145         if (!size) {
1146                 pr_warn("%s: No testcase data to attach; not running tests\n",
1147                         __func__);
1148                 return -ENODATA;
1149         }
1151         /* creating copy */
1152         unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1154         if (!unittest_data) {
1155                 pr_warn("%s: Failed to allocate memory for unittest_data; "
1156                         "not running tests\n", __func__);
1157                 return -ENOMEM;
1158         }
1159         of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1160         if (!unittest_data_node) {
1161                 pr_warn("%s: No tree to attach; not running tests\n", __func__);
1162                 return -ENODATA;
1163         }
1165         /*
1166          * This lock normally encloses of_resolve_phandles()
1167          */
1168         of_overlay_mutex_lock();
1170         rc = of_resolve_phandles(unittest_data_node);
1171         if (rc) {
1172                 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1173                 of_overlay_mutex_unlock();
1174                 return -EINVAL;
1175         }
1177         if (!of_root) {
1178                 of_root = unittest_data_node;
1179                 for_each_of_allnodes(np)
1180                         __of_attach_node_sysfs(np);
1181                 of_aliases = of_find_node_by_path("/aliases");
1182                 of_chosen = of_find_node_by_path("/chosen");
1183                 of_overlay_mutex_unlock();
1184                 return 0;
1185         }
1187         /* attach the sub-tree to live tree */
1188         np = unittest_data_node->child;
1189         while (np) {
1190                 struct device_node *next = np->sibling;
1192                 np->parent = of_root;
1193                 attach_node_and_children(np);
1194                 np = next;
1195         }
1197         of_overlay_mutex_unlock();
1199         return 0;
1202 #ifdef CONFIG_OF_OVERLAY
1203 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1205 static int unittest_probe(struct platform_device *pdev)
1207         struct device *dev = &pdev->dev;
1208         struct device_node *np = dev->of_node;
1210         if (np == NULL) {
1211                 dev_err(dev, "No OF data for device\n");
1212                 return -EINVAL;
1214         }
1216         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1218         of_platform_populate(np, NULL, NULL, &pdev->dev);
1220         return 0;
1223 static int unittest_remove(struct platform_device *pdev)
1225         struct device *dev = &pdev->dev;
1226         struct device_node *np = dev->of_node;
1228         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1229         return 0;
1232 static const struct of_device_id unittest_match[] = {
1233         { .compatible = "unittest", },
1234         {},
1235 };
1237 static struct platform_driver unittest_driver = {
1238         .probe                  = unittest_probe,
1239         .remove                 = unittest_remove,
1240         .driver = {
1241                 .name           = "unittest",
1242                 .of_match_table = of_match_ptr(unittest_match),
1243         },
1244 };
1246 /* get the platform device instantiated at the path */
1247 static struct platform_device *of_path_to_platform_device(const char *path)
1249         struct device_node *np;
1250         struct platform_device *pdev;
1252         np = of_find_node_by_path(path);
1253         if (np == NULL)
1254                 return NULL;
1256         pdev = of_find_device_by_node(np);
1257         of_node_put(np);
1259         return pdev;
1262 /* find out if a platform device exists at that path */
1263 static int of_path_platform_device_exists(const char *path)
1265         struct platform_device *pdev;
1267         pdev = of_path_to_platform_device(path);
1268         platform_device_put(pdev);
1269         return pdev != NULL;
1272 #if IS_BUILTIN(CONFIG_I2C)
1274 /* get the i2c client device instantiated at the path */
1275 static struct i2c_client *of_path_to_i2c_client(const char *path)
1277         struct device_node *np;
1278         struct i2c_client *client;
1280         np = of_find_node_by_path(path);
1281         if (np == NULL)
1282                 return NULL;
1284         client = of_find_i2c_device_by_node(np);
1285         of_node_put(np);
1287         return client;
1290 /* find out if a i2c client device exists at that path */
1291 static int of_path_i2c_client_exists(const char *path)
1293         struct i2c_client *client;
1295         client = of_path_to_i2c_client(path);
1296         if (client)
1297                 put_device(&client->dev);
1298         return client != NULL;
1300 #else
1301 static int of_path_i2c_client_exists(const char *path)
1303         return 0;
1305 #endif
1307 enum overlay_type {
1308         PDEV_OVERLAY,
1309         I2C_OVERLAY
1310 };
1312 static int of_path_device_type_exists(const char *path,
1313                 enum overlay_type ovtype)
1315         switch (ovtype) {
1316         case PDEV_OVERLAY:
1317                 return of_path_platform_device_exists(path);
1318         case I2C_OVERLAY:
1319                 return of_path_i2c_client_exists(path);
1320         }
1321         return 0;
1324 static const char *unittest_path(int nr, enum overlay_type ovtype)
1326         const char *base;
1327         static char buf[256];
1329         switch (ovtype) {
1330         case PDEV_OVERLAY:
1331                 base = "/testcase-data/overlay-node/test-bus";
1332                 break;
1333         case I2C_OVERLAY:
1334                 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1335                 break;
1336         default:
1337                 buf[0] = '\0';
1338                 return buf;
1339         }
1340         snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1341         buf[sizeof(buf) - 1] = '\0';
1342         return buf;
1345 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1347         const char *path;
1349         path = unittest_path(unittest_nr, ovtype);
1351         switch (ovtype) {
1352         case PDEV_OVERLAY:
1353                 return of_path_platform_device_exists(path);
1354         case I2C_OVERLAY:
1355                 return of_path_i2c_client_exists(path);
1356         }
1357         return 0;
1360 static const char *overlay_name_from_nr(int nr)
1362         static char buf[256];
1364         snprintf(buf, sizeof(buf) - 1,
1365                 "overlay_%d", nr);
1366         buf[sizeof(buf) - 1] = '\0';
1368         return buf;
1371 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1373 /* it is guaranteed that overlay ids are assigned in sequence */
1374 #define MAX_UNITTEST_OVERLAYS   256
1375 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1376 static int overlay_first_id = -1;
1378 static void of_unittest_track_overlay(int id)
1380         if (overlay_first_id < 0)
1381                 overlay_first_id = id;
1382         id -= overlay_first_id;
1384         /* we shouldn't need that many */
1385         BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1386         overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1389 static void of_unittest_untrack_overlay(int id)
1391         if (overlay_first_id < 0)
1392                 return;
1393         id -= overlay_first_id;
1394         BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1395         overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1398 static void of_unittest_destroy_tracked_overlays(void)
1400         int id, ret, defers, ovcs_id;
1402         if (overlay_first_id < 0)
1403                 return;
1405         /* try until no defers */
1406         do {
1407                 defers = 0;
1408                 /* remove in reverse order */
1409                 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1410                         if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1411                                 continue;
1413                         ovcs_id = id + overlay_first_id;
1414                         ret = of_overlay_remove(&ovcs_id);
1415                         if (ret == -ENODEV) {
1416                                 pr_warn("%s: no overlay to destroy for #%d\n",
1417                                         __func__, id + overlay_first_id);
1418                                 continue;
1419                         }
1420                         if (ret != 0) {
1421                                 defers++;
1422                                 pr_warn("%s: overlay destroy failed for #%d\n",
1423                                         __func__, id + overlay_first_id);
1424                                 continue;
1425                         }
1427                         overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1428                 }
1429         } while (defers > 0);
1432 static int __init of_unittest_apply_overlay(int overlay_nr, int unittest_nr,
1433                 int *overlay_id)
1435         const char *overlay_name;
1437         overlay_name = overlay_name_from_nr(overlay_nr);
1439         if (!overlay_data_apply(overlay_name, overlay_id)) {
1440                 unittest(0, "could not apply overlay \"%s\"\n",
1441                                 overlay_name);
1442                 return -EFAULT;
1443         }
1444         of_unittest_track_overlay(*overlay_id);
1446         return 0;
1449 /* apply an overlay while checking before and after states */
1450 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1451                 int unittest_nr, int before, int after,
1452                 enum overlay_type ovtype)
1454         int ret, ovcs_id;
1456         /* unittest device must not be in before state */
1457         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1458                 unittest(0, "%s with device @\"%s\" %s\n",
1459                                 overlay_name_from_nr(overlay_nr),
1460                                 unittest_path(unittest_nr, ovtype),
1461                                 !before ? "enabled" : "disabled");
1462                 return -EINVAL;
1463         }
1465         ovcs_id = 0;
1466         ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1467         if (ret != 0) {
1468                 /* of_unittest_apply_overlay already called unittest() */
1469                 return ret;
1470         }
1472         /* unittest device must be to set to after state */
1473         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1474                 unittest(0, "%s failed to create @\"%s\" %s\n",
1475                                 overlay_name_from_nr(overlay_nr),
1476                                 unittest_path(unittest_nr, ovtype),
1477                                 !after ? "enabled" : "disabled");
1478                 return -EINVAL;
1479         }
1481         return 0;
1484 /* apply an overlay and then revert it while checking before, after states */
1485 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1486                 int unittest_nr, int before, int after,
1487                 enum overlay_type ovtype)
1489         int ret, ovcs_id;
1491         /* unittest device must be in before state */
1492         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1493                 unittest(0, "%s with device @\"%s\" %s\n",
1494                                 overlay_name_from_nr(overlay_nr),
1495                                 unittest_path(unittest_nr, ovtype),
1496                                 !before ? "enabled" : "disabled");
1497                 return -EINVAL;
1498         }
1500         /* apply the overlay */
1501         ovcs_id = 0;
1502         ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1503         if (ret != 0) {
1504                 /* of_unittest_apply_overlay already called unittest() */
1505                 return ret;
1506         }
1508         /* unittest device must be in after state */
1509         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1510                 unittest(0, "%s failed to create @\"%s\" %s\n",
1511                                 overlay_name_from_nr(overlay_nr),
1512                                 unittest_path(unittest_nr, ovtype),
1513                                 !after ? "enabled" : "disabled");
1514                 return -EINVAL;
1515         }
1517         ret = of_overlay_remove(&ovcs_id);
1518         if (ret != 0) {
1519                 unittest(0, "%s failed to be destroyed @\"%s\"\n",
1520                                 overlay_name_from_nr(overlay_nr),
1521                                 unittest_path(unittest_nr, ovtype));
1522                 return ret;
1523         }
1525         /* unittest device must be again in before state */
1526         if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1527                 unittest(0, "%s with device @\"%s\" %s\n",
1528                                 overlay_name_from_nr(overlay_nr),
1529                                 unittest_path(unittest_nr, ovtype),
1530                                 !before ? "enabled" : "disabled");
1531                 return -EINVAL;
1532         }
1534         return 0;
1537 /* test activation of device */
1538 static void __init of_unittest_overlay_0(void)
1540         /* device should enable */
1541         if (of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY))
1542                 return;
1544         unittest(1, "overlay test %d passed\n", 0);
1547 /* test deactivation of device */
1548 static void __init of_unittest_overlay_1(void)
1550         /* device should disable */
1551         if (of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY))
1552                 return;
1554         unittest(1, "overlay test %d passed\n", 1);
1557 /* test activation of device */
1558 static void __init of_unittest_overlay_2(void)
1560         /* device should enable */
1561         if (of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY))
1562                 return;
1564         unittest(1, "overlay test %d passed\n", 2);
1567 /* test deactivation of device */
1568 static void __init of_unittest_overlay_3(void)
1570         /* device should disable */
1571         if (of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY))
1572                 return;
1574         unittest(1, "overlay test %d passed\n", 3);
1577 /* test activation of a full device node */
1578 static void __init of_unittest_overlay_4(void)
1580         /* device should disable */
1581         if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
1582                 return;
1584         unittest(1, "overlay test %d passed\n", 4);
1587 /* test overlay apply/revert sequence */
1588 static void __init of_unittest_overlay_5(void)
1590         /* device should disable */
1591         if (of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY))
1592                 return;
1594         unittest(1, "overlay test %d passed\n", 5);
1597 /* test overlay application in sequence */
1598 static void __init of_unittest_overlay_6(void)
1600         int i, ov_id[2], ovcs_id;
1601         int overlay_nr = 6, unittest_nr = 6;
1602         int before = 0, after = 1;
1603         const char *overlay_name;
1605         /* unittest device must be in before state */
1606         for (i = 0; i < 2; i++) {
1607                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1608                                 != before) {
1609                         unittest(0, "%s with device @\"%s\" %s\n",
1610                                         overlay_name_from_nr(overlay_nr + i),
1611                                         unittest_path(unittest_nr + i,
1612                                                 PDEV_OVERLAY),
1613                                         !before ? "enabled" : "disabled");
1614                         return;
1615                 }
1616         }
1618         /* apply the overlays */
1619         for (i = 0; i < 2; i++) {
1621                 overlay_name = overlay_name_from_nr(overlay_nr + i);
1623                 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1624                         unittest(0, "could not apply overlay \"%s\"\n",
1625                                         overlay_name);
1626                         return;
1627                 }
1628                 ov_id[i] = ovcs_id;
1629                 of_unittest_track_overlay(ov_id[i]);
1630         }
1632         for (i = 0; i < 2; i++) {
1633                 /* unittest device must be in after state */
1634                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1635                                 != after) {
1636                         unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1637                                         overlay_name_from_nr(overlay_nr + i),
1638                                         unittest_path(unittest_nr + i,
1639                                                 PDEV_OVERLAY),
1640                                         !after ? "enabled" : "disabled");
1641                         return;
1642                 }
1643         }
1645         for (i = 1; i >= 0; i--) {
1646                 ovcs_id = ov_id[i];
1647                 if (of_overlay_remove(&ovcs_id)) {
1648                         unittest(0, "%s failed destroy @\"%s\"\n",
1649                                         overlay_name_from_nr(overlay_nr + i),
1650                                         unittest_path(unittest_nr + i,
1651                                                 PDEV_OVERLAY));
1652                         return;
1653                 }
1654                 of_unittest_untrack_overlay(ov_id[i]);
1655         }
1657         for (i = 0; i < 2; i++) {
1658                 /* unittest device must be again in before state */
1659                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1660                                 != before) {
1661                         unittest(0, "%s with device @\"%s\" %s\n",
1662                                         overlay_name_from_nr(overlay_nr + i),
1663                                         unittest_path(unittest_nr + i,
1664                                                 PDEV_OVERLAY),
1665                                         !before ? "enabled" : "disabled");
1666                         return;
1667                 }
1668         }
1670         unittest(1, "overlay test %d passed\n", 6);
1673 /* test overlay application in sequence */
1674 static void __init of_unittest_overlay_8(void)
1676         int i, ov_id[2], ovcs_id;
1677         int overlay_nr = 8, unittest_nr = 8;
1678         const char *overlay_name;
1680         /* we don't care about device state in this test */
1682         /* apply the overlays */
1683         for (i = 0; i < 2; i++) {
1685                 overlay_name = overlay_name_from_nr(overlay_nr + i);
1687                 if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1688                         unittest(0, "could not apply overlay \"%s\"\n",
1689                                         overlay_name);
1690                         return;
1691                 }
1692                 ov_id[i] = ovcs_id;
1693                 of_unittest_track_overlay(ov_id[i]);
1694         }
1696         /* now try to remove first overlay (it should fail) */
1697         ovcs_id = ov_id[0];
1698         if (!of_overlay_remove(&ovcs_id)) {
1699                 unittest(0, "%s was destroyed @\"%s\"\n",
1700                                 overlay_name_from_nr(overlay_nr + 0),
1701                                 unittest_path(unittest_nr,
1702                                         PDEV_OVERLAY));
1703                 return;
1704         }
1706         /* removing them in order should work */
1707         for (i = 1; i >= 0; i--) {
1708                 ovcs_id = ov_id[i];
1709                 if (of_overlay_remove(&ovcs_id)) {
1710                         unittest(0, "%s not destroyed @\"%s\"\n",
1711                                         overlay_name_from_nr(overlay_nr + i),
1712                                         unittest_path(unittest_nr,
1713                                                 PDEV_OVERLAY));
1714                         return;
1715                 }
1716                 of_unittest_untrack_overlay(ov_id[i]);
1717         }
1719         unittest(1, "overlay test %d passed\n", 8);
1722 /* test insertion of a bus with parent devices */
1723 static void __init of_unittest_overlay_10(void)
1725         int ret;
1726         char *child_path;
1728         /* device should disable */
1729         ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1730         if (unittest(ret == 0,
1731                         "overlay test %d failed; overlay application\n", 10))
1732                 return;
1734         child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1735                         unittest_path(10, PDEV_OVERLAY));
1736         if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1737                 return;
1739         ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1740         kfree(child_path);
1742         unittest(ret, "overlay test %d failed; no child device\n", 10);
1745 /* test insertion of a bus with parent devices (and revert) */
1746 static void __init of_unittest_overlay_11(void)
1748         int ret;
1750         /* device should disable */
1751         ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1752                         PDEV_OVERLAY);
1753         unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
1756 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1758 struct unittest_i2c_bus_data {
1759         struct platform_device  *pdev;
1760         struct i2c_adapter      adap;
1761 };
1763 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1764                 struct i2c_msg *msgs, int num)
1766         struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1768         (void)std;
1770         return num;
1773 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1775         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1778 static const struct i2c_algorithm unittest_i2c_algo = {
1779         .master_xfer    = unittest_i2c_master_xfer,
1780         .functionality  = unittest_i2c_functionality,
1781 };
1783 static int unittest_i2c_bus_probe(struct platform_device *pdev)
1785         struct device *dev = &pdev->dev;
1786         struct device_node *np = dev->of_node;
1787         struct unittest_i2c_bus_data *std;
1788         struct i2c_adapter *adap;
1789         int ret;
1791         if (np == NULL) {
1792                 dev_err(dev, "No OF data for device\n");
1793                 return -EINVAL;
1795         }
1797         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1799         std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1800         if (!std) {
1801                 dev_err(dev, "Failed to allocate unittest i2c data\n");
1802                 return -ENOMEM;
1803         }
1805         /* link them together */
1806         std->pdev = pdev;
1807         platform_set_drvdata(pdev, std);
1809         adap = &std->adap;
1810         i2c_set_adapdata(adap, std);
1811         adap->nr = -1;
1812         strlcpy(adap->name, pdev->name, sizeof(adap->name));
1813         adap->class = I2C_CLASS_DEPRECATED;
1814         adap->algo = &unittest_i2c_algo;
1815         adap->dev.parent = dev;
1816         adap->dev.of_node = dev->of_node;
1817         adap->timeout = 5 * HZ;
1818         adap->retries = 3;
1820         ret = i2c_add_numbered_adapter(adap);
1821         if (ret != 0) {
1822                 dev_err(dev, "Failed to add I2C adapter\n");
1823                 return ret;
1824         }
1826         return 0;
1829 static int unittest_i2c_bus_remove(struct platform_device *pdev)
1831         struct device *dev = &pdev->dev;
1832         struct device_node *np = dev->of_node;
1833         struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1835         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1836         i2c_del_adapter(&std->adap);
1838         return 0;
1841 static const struct of_device_id unittest_i2c_bus_match[] = {
1842         { .compatible = "unittest-i2c-bus", },
1843         {},
1844 };
1846 static struct platform_driver unittest_i2c_bus_driver = {
1847         .probe                  = unittest_i2c_bus_probe,
1848         .remove                 = unittest_i2c_bus_remove,
1849         .driver = {
1850                 .name           = "unittest-i2c-bus",
1851                 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1852         },
1853 };
1855 static int unittest_i2c_dev_probe(struct i2c_client *client,
1856                 const struct i2c_device_id *id)
1858         struct device *dev = &client->dev;
1859         struct device_node *np = client->dev.of_node;
1861         if (!np) {
1862                 dev_err(dev, "No OF node\n");
1863                 return -EINVAL;
1864         }
1866         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1868         return 0;
1869 };
1871 static int unittest_i2c_dev_remove(struct i2c_client *client)
1873         struct device *dev = &client->dev;
1874         struct device_node *np = client->dev.of_node;
1876         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1877         return 0;
1880 static const struct i2c_device_id unittest_i2c_dev_id[] = {
1881         { .name = "unittest-i2c-dev" },
1882         { }
1883 };
1885 static struct i2c_driver unittest_i2c_dev_driver = {
1886         .driver = {
1887                 .name = "unittest-i2c-dev",
1888         },
1889         .probe = unittest_i2c_dev_probe,
1890         .remove = unittest_i2c_dev_remove,
1891         .id_table = unittest_i2c_dev_id,
1892 };
1894 #if IS_BUILTIN(CONFIG_I2C_MUX)
1896 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1898         return 0;
1901 static int unittest_i2c_mux_probe(struct i2c_client *client,
1902                 const struct i2c_device_id *id)
1904         int i, nchans;
1905         struct device *dev = &client->dev;
1906         struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1907         struct device_node *np = client->dev.of_node, *child;
1908         struct i2c_mux_core *muxc;
1909         u32 reg, max_reg;
1911         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1913         if (!np) {
1914                 dev_err(dev, "No OF node\n");
1915                 return -EINVAL;
1916         }
1918         max_reg = (u32)-1;
1919         for_each_child_of_node(np, child) {
1920                 if (of_property_read_u32(child, "reg", &reg))
1921                         continue;
1922                 if (max_reg == (u32)-1 || reg > max_reg)
1923                         max_reg = reg;
1924         }
1925         nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1926         if (nchans == 0) {
1927                 dev_err(dev, "No channels\n");
1928                 return -EINVAL;
1929         }
1931         muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1932                              unittest_i2c_mux_select_chan, NULL);
1933         if (!muxc)
1934                 return -ENOMEM;
1935         for (i = 0; i < nchans; i++) {
1936                 if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
1937                         dev_err(dev, "Failed to register mux #%d\n", i);
1938                         i2c_mux_del_adapters(muxc);
1939                         return -ENODEV;
1940                 }
1941         }
1943         i2c_set_clientdata(client, muxc);
1945         return 0;
1946 };
1948 static int unittest_i2c_mux_remove(struct i2c_client *client)
1950         struct device *dev = &client->dev;
1951         struct device_node *np = client->dev.of_node;
1952         struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1954         dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1955         i2c_mux_del_adapters(muxc);
1956         return 0;
1959 static const struct i2c_device_id unittest_i2c_mux_id[] = {
1960         { .name = "unittest-i2c-mux" },
1961         { }
1962 };
1964 static struct i2c_driver unittest_i2c_mux_driver = {
1965         .driver = {
1966                 .name = "unittest-i2c-mux",
1967         },
1968         .probe = unittest_i2c_mux_probe,
1969         .remove = unittest_i2c_mux_remove,
1970         .id_table = unittest_i2c_mux_id,
1971 };
1973 #endif
1975 static int of_unittest_overlay_i2c_init(void)
1977         int ret;
1979         ret = i2c_add_driver(&unittest_i2c_dev_driver);
1980         if (unittest(ret == 0,
1981                         "could not register unittest i2c device driver\n"))
1982                 return ret;
1984         ret = platform_driver_register(&unittest_i2c_bus_driver);
1985         if (unittest(ret == 0,
1986                         "could not register unittest i2c bus driver\n"))
1987                 return ret;
1989 #if IS_BUILTIN(CONFIG_I2C_MUX)
1990         ret = i2c_add_driver(&unittest_i2c_mux_driver);
1991         if (unittest(ret == 0,
1992                         "could not register unittest i2c mux driver\n"))
1993                 return ret;
1994 #endif
1996         return 0;
1999 static void of_unittest_overlay_i2c_cleanup(void)
2001 #if IS_BUILTIN(CONFIG_I2C_MUX)
2002         i2c_del_driver(&unittest_i2c_mux_driver);
2003 #endif
2004         platform_driver_unregister(&unittest_i2c_bus_driver);
2005         i2c_del_driver(&unittest_i2c_dev_driver);
2008 static void __init of_unittest_overlay_i2c_12(void)
2010         /* device should enable */
2011         if (of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY))
2012                 return;
2014         unittest(1, "overlay test %d passed\n", 12);
2017 /* test deactivation of device */
2018 static void __init of_unittest_overlay_i2c_13(void)
2020         /* device should disable */
2021         if (of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY))
2022                 return;
2024         unittest(1, "overlay test %d passed\n", 13);
2027 /* just check for i2c mux existence */
2028 static void of_unittest_overlay_i2c_14(void)
2032 static void __init of_unittest_overlay_i2c_15(void)
2034         /* device should enable */
2035         if (of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY))
2036                 return;
2038         unittest(1, "overlay test %d passed\n", 15);
2041 #else
2043 static inline void of_unittest_overlay_i2c_14(void) { }
2044 static inline void of_unittest_overlay_i2c_15(void) { }
2046 #endif
2048 static void __init of_unittest_overlay(void)
2050         struct device_node *bus_np = NULL;
2052         if (platform_driver_register(&unittest_driver)) {
2053                 unittest(0, "could not register unittest driver\n");
2054                 goto out;
2055         }
2057         bus_np = of_find_node_by_path(bus_path);
2058         if (bus_np == NULL) {
2059                 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2060                 goto out;
2061         }
2063         if (of_platform_default_populate(bus_np, NULL, NULL)) {
2064                 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2065                 goto out;
2066         }
2068         if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2069                 unittest(0, "could not find unittest0 @ \"%s\"\n",
2070                                 unittest_path(100, PDEV_OVERLAY));
2071                 goto out;
2072         }
2074         if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2075                 unittest(0, "unittest1 @ \"%s\" should not exist\n",
2076                                 unittest_path(101, PDEV_OVERLAY));
2077                 goto out;
2078         }
2080         unittest(1, "basic infrastructure of overlays passed");
2082         /* tests in sequence */
2083         of_unittest_overlay_0();
2084         of_unittest_overlay_1();
2085         of_unittest_overlay_2();
2086         of_unittest_overlay_3();
2087         of_unittest_overlay_4();
2088         of_unittest_overlay_5();
2089         of_unittest_overlay_6();
2090         of_unittest_overlay_8();
2092         of_unittest_overlay_10();
2093         of_unittest_overlay_11();
2095 #if IS_BUILTIN(CONFIG_I2C)
2096         if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2097                 goto out;
2099         of_unittest_overlay_i2c_12();
2100         of_unittest_overlay_i2c_13();
2101         of_unittest_overlay_i2c_14();
2102         of_unittest_overlay_i2c_15();
2104         of_unittest_overlay_i2c_cleanup();
2105 #endif
2107         of_unittest_destroy_tracked_overlays();
2109 out:
2110         of_node_put(bus_np);
2113 #else
2114 static inline void __init of_unittest_overlay(void) { }
2115 #endif
2117 #ifdef CONFIG_OF_OVERLAY
2119 /*
2120  * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2121  * in scripts/Makefile.lib
2122  */
2124 #define OVERLAY_INFO_EXTERN(name) \
2125         extern uint8_t __dtb_##name##_begin[]; \
2126         extern uint8_t __dtb_##name##_end[]
2128 #define OVERLAY_INFO(overlay_name, expected)             \
2129 {       .dtb_begin       = __dtb_##overlay_name##_begin, \
2130         .dtb_end         = __dtb_##overlay_name##_end,   \
2131         .expected_result = expected,                     \
2132         .name            = #overlay_name,                \
2135 struct overlay_info {
2136         uint8_t         *dtb_begin;
2137         uint8_t         *dtb_end;
2138         int             expected_result;
2139         int             overlay_id;
2140         char            *name;
2141 };
2143 OVERLAY_INFO_EXTERN(overlay_base);
2144 OVERLAY_INFO_EXTERN(overlay);
2145 OVERLAY_INFO_EXTERN(overlay_0);
2146 OVERLAY_INFO_EXTERN(overlay_1);
2147 OVERLAY_INFO_EXTERN(overlay_2);
2148 OVERLAY_INFO_EXTERN(overlay_3);
2149 OVERLAY_INFO_EXTERN(overlay_4);
2150 OVERLAY_INFO_EXTERN(overlay_5);
2151 OVERLAY_INFO_EXTERN(overlay_6);
2152 OVERLAY_INFO_EXTERN(overlay_7);
2153 OVERLAY_INFO_EXTERN(overlay_8);
2154 OVERLAY_INFO_EXTERN(overlay_9);
2155 OVERLAY_INFO_EXTERN(overlay_10);
2156 OVERLAY_INFO_EXTERN(overlay_11);
2157 OVERLAY_INFO_EXTERN(overlay_12);
2158 OVERLAY_INFO_EXTERN(overlay_13);
2159 OVERLAY_INFO_EXTERN(overlay_15);
2160 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2161 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2163 /* order of entries is hard-coded into users of overlays[] */
2164 static struct overlay_info overlays[] = {
2165         OVERLAY_INFO(overlay_base, -9999),
2166         OVERLAY_INFO(overlay, 0),
2167         OVERLAY_INFO(overlay_0, 0),
2168         OVERLAY_INFO(overlay_1, 0),
2169         OVERLAY_INFO(overlay_2, 0),
2170         OVERLAY_INFO(overlay_3, 0),
2171         OVERLAY_INFO(overlay_4, 0),
2172         OVERLAY_INFO(overlay_5, 0),
2173         OVERLAY_INFO(overlay_6, 0),
2174         OVERLAY_INFO(overlay_7, 0),
2175         OVERLAY_INFO(overlay_8, 0),
2176         OVERLAY_INFO(overlay_9, 0),
2177         OVERLAY_INFO(overlay_10, 0),
2178         OVERLAY_INFO(overlay_11, 0),
2179         OVERLAY_INFO(overlay_12, 0),
2180         OVERLAY_INFO(overlay_13, 0),
2181         OVERLAY_INFO(overlay_15, 0),
2182         OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2183         OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2184         {}
2185 };
2187 static struct device_node *overlay_base_root;
2189 static void * __init dt_alloc_memory(u64 size, u64 align)
2191         return memblock_virt_alloc(size, align);
2194 /*
2195  * Create base device tree for the overlay unittest.
2196  *
2197  * This is called from very early boot code.
2198  *
2199  * Do as much as possible the same way as done in __unflatten_device_tree
2200  * and other early boot steps for the normal FDT so that the overlay base
2201  * unflattened tree will have the same characteristics as the real tree
2202  * (such as having memory allocated by the early allocator).  The goal
2203  * is to test "the real thing" as much as possible, and test "test setup
2204  * code" as little as possible.
2205  *
2206  * Have to stop before resolving phandles, because that uses kmalloc.
2207  */
2208 void __init unittest_unflatten_overlay_base(void)
2210         struct overlay_info *info;
2211         u32 data_size;
2212         void *new_fdt;
2213         u32 size;
2215         info = &overlays[0];
2217         if (info->expected_result != -9999) {
2218                 pr_err("No dtb 'overlay_base' to attach\n");
2219                 return;
2220         }
2222         data_size = info->dtb_end - info->dtb_begin;
2223         if (!data_size) {
2224                 pr_err("No dtb 'overlay_base' to attach\n");
2225                 return;
2226         }
2228         size = fdt_totalsize(info->dtb_begin);
2229         if (size != data_size) {
2230                 pr_err("dtb 'overlay_base' header totalsize != actual size");
2231                 return;
2232         }
2234         new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2235         if (!new_fdt) {
2236                 pr_err("alloc for dtb 'overlay_base' failed");
2237                 return;
2238         }
2240         memcpy(new_fdt, info->dtb_begin, size);
2242         __unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2243                                 dt_alloc_memory, true);
2246 /*
2247  * The purpose of of_unittest_overlay_data_add is to add an
2248  * overlay in the normal fashion.  This is a test of the whole
2249  * picture, instead of testing individual elements.
2250  *
2251  * A secondary purpose is to be able to verify that the contents of
2252  * /proc/device-tree/ contains the updated structure and values from
2253  * the overlay.  That must be verified separately in user space.
2254  *
2255  * Return 0 on unexpected error.
2256  */
2257 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2259         struct overlay_info *info;
2260         int found = 0;
2261         int k;
2262         int ret;
2263         u32 size;
2265         for (k = 0, info = overlays; info && info->name; info++, k++) {
2266                 if (!strcmp(overlay_name, info->name)) {
2267                         found = 1;
2268                         break;
2269                 }
2270         }
2271         if (!found) {
2272                 pr_err("no overlay data for %s\n", overlay_name);
2273                 return 0;
2274         }
2276         size = info->dtb_end - info->dtb_begin;
2277         if (!size)
2278                 pr_err("no overlay data for %s\n", overlay_name);
2280         ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2281         if (overlay_id)
2282                 *overlay_id = info->overlay_id;
2283         if (ret < 0)
2284                 goto out;
2286         pr_debug("%s applied\n", overlay_name);
2288 out:
2289         if (ret != info->expected_result)
2290                 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2291                        info->expected_result, ret, overlay_name);
2293         return (ret == info->expected_result);
2296 /*
2297  * The purpose of of_unittest_overlay_high_level is to add an overlay
2298  * in the normal fashion.  This is a test of the whole picture,
2299  * instead of individual elements.
2300  *
2301  * The first part of the function is _not_ normal overlay usage; it is
2302  * finishing splicing the base overlay device tree into the live tree.
2303  */
2304 static __init void of_unittest_overlay_high_level(void)
2306         struct device_node *last_sibling;
2307         struct device_node *np;
2308         struct device_node *of_symbols;
2309         struct device_node *overlay_base_symbols;
2310         struct device_node **pprev;
2311         struct property *prop;
2313         if (!overlay_base_root) {
2314                 unittest(0, "overlay_base_root not initialized\n");
2315                 return;
2316         }
2318         /*
2319          * Could not fixup phandles in unittest_unflatten_overlay_base()
2320          * because kmalloc() was not yet available.
2321          */
2322         of_overlay_mutex_lock();
2323         of_resolve_phandles(overlay_base_root);
2324         of_overlay_mutex_unlock();
2327         /*
2328          * do not allow overlay_base to duplicate any node already in
2329          * tree, this greatly simplifies the code
2330          */
2332         /*
2333          * remove overlay_base_root node "__local_fixups", after
2334          * being used by of_resolve_phandles()
2335          */
2336         pprev = &overlay_base_root->child;
2337         for (np = overlay_base_root->child; np; np = np->sibling) {
2338                 if (!of_node_cmp(np->name, "__local_fixups__")) {
2339                         *pprev = np->sibling;
2340                         break;
2341                 }
2342                 pprev = &np->sibling;
2343         }
2345         /* remove overlay_base_root node "__symbols__" if in live tree */
2346         of_symbols = of_get_child_by_name(of_root, "__symbols__");
2347         if (of_symbols) {
2348                 /* will have to graft properties from node into live tree */
2349                 pprev = &overlay_base_root->child;
2350                 for (np = overlay_base_root->child; np; np = np->sibling) {
2351                         if (!of_node_cmp(np->name, "__symbols__")) {
2352                                 overlay_base_symbols = np;
2353                                 *pprev = np->sibling;
2354                                 break;
2355                         }
2356                         pprev = &np->sibling;
2357                 }
2358         }
2360         for (np = overlay_base_root->child; np; np = np->sibling) {
2361                 if (of_get_child_by_name(of_root, np->name)) {
2362                         unittest(0, "illegal node name in overlay_base %s",
2363                                 np->name);
2364                         return;
2365                 }
2366         }
2368         /*
2369          * overlay 'overlay_base' is not allowed to have root
2370          * properties, so only need to splice nodes into main device tree.
2371          *
2372          * root node of *overlay_base_root will not be freed, it is lost
2373          * memory.
2374          */
2376         for (np = overlay_base_root->child; np; np = np->sibling)
2377                 np->parent = of_root;
2379         mutex_lock(&of_mutex);
2381         for (last_sibling = np = of_root->child; np; np = np->sibling)
2382                 last_sibling = np;
2384         if (last_sibling)
2385                 last_sibling->sibling = overlay_base_root->child;
2386         else
2387                 of_root->child = overlay_base_root->child;
2389         for_each_of_allnodes_from(overlay_base_root, np)
2390                 __of_attach_node_sysfs(np);
2392         if (of_symbols) {
2393                 struct property *new_prop;
2394                 for_each_property_of_node(overlay_base_symbols, prop) {
2396                         new_prop = __of_prop_dup(prop, GFP_KERNEL);
2397                         if (!new_prop) {
2398                                 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
2399                                          prop->name);
2400                                 goto err_unlock;
2401                         }
2402                         if (__of_add_property(of_symbols, new_prop)) {
2403                                 /* "name" auto-generated by unflatten */
2404                                 if (!strcmp(new_prop->name, "name"))
2405                                         continue;
2406                                 unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
2407                                          prop->name);
2408                                 goto err_unlock;
2409                         }
2410                         if (__of_add_property_sysfs(of_symbols, new_prop)) {
2411                                 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2412                                          prop->name);
2413                                 goto err_unlock;
2414                         }
2415                 }
2416         }
2418         mutex_unlock(&of_mutex);
2421         /* now do the normal overlay usage test */
2423         unittest(overlay_data_apply("overlay", NULL),
2424                  "Adding overlay 'overlay' failed\n");
2426         unittest(overlay_data_apply("overlay_bad_phandle", NULL),
2427                  "Adding overlay 'overlay_bad_phandle' failed\n");
2429         unittest(overlay_data_apply("overlay_bad_symbol", NULL),
2430                  "Adding overlay 'overlay_bad_symbol' failed\n");
2432         return;
2434 err_unlock:
2435         mutex_unlock(&of_mutex);
2438 #else
2440 static inline __init void of_unittest_overlay_high_level(void) {}
2442 #endif
2444 static int __init of_unittest(void)
2446         struct device_node *np;
2447         int res;
2449         /* adding data for unittest */
2450         res = unittest_data_add();
2451         if (res)
2452                 return res;
2453         if (!of_aliases)
2454                 of_aliases = of_find_node_by_path("/aliases");
2456         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2457         if (!np) {
2458                 pr_info("No testcase data in device tree; not running tests\n");
2459                 return 0;
2460         }
2461         of_node_put(np);
2463         pr_info("start of unittest - you will see error messages\n");
2464         of_unittest_check_tree_linkage();
2465         of_unittest_check_phandles();
2466         of_unittest_find_node_by_name();
2467         of_unittest_dynamic();
2468         of_unittest_parse_phandle_with_args();
2469         of_unittest_parse_phandle_with_args_map();
2470         of_unittest_printf();
2471         of_unittest_property_string();
2472         of_unittest_property_copy();
2473         of_unittest_changeset();
2474         of_unittest_parse_interrupts();
2475         of_unittest_parse_interrupts_extended();
2476         of_unittest_match_node();
2477         of_unittest_platform_populate();
2478         of_unittest_overlay();
2480         /* Double check linkage after removing testcase data */
2481         of_unittest_check_tree_linkage();
2483         of_unittest_overlay_high_level();
2485         pr_info("end of unittest - %i passed, %i failed\n",
2486                 unittest_results.passed, unittest_results.failed);
2488         return 0;
2490 late_initcall(of_unittest);