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