GNU Linux-libre 4.9.337-gnu1
[releases.git] / drivers / of / unittest.c
1 /*
2  * Self tests for device tree subsystem
3  */
4
5 #define pr_fmt(fmt) "### dt-test ### " fmt
6
7 #include <linux/clk.h>
8 #include <linux/err.h>
9 #include <linux/errno.h>
10 #include <linux/hashtable.h>
11 #include <linux/of.h>
12 #include <linux/of_fdt.h>
13 #include <linux/of_irq.h>
14 #include <linux/of_platform.h>
15 #include <linux/list.h>
16 #include <linux/mutex.h>
17 #include <linux/slab.h>
18 #include <linux/device.h>
19 #include <linux/platform_device.h>
20 #include <linux/of_platform.h>
21
22 #include <linux/i2c.h>
23 #include <linux/i2c-mux.h>
24
25 #include <linux/bitops.h>
26
27 #include "of_private.h"
28
29 static struct unittest_results {
30         int passed;
31         int failed;
32 } unittest_results;
33
34 #define unittest(result, fmt, ...) ({ \
35         bool failed = !(result); \
36         if (failed) { \
37                 unittest_results.failed++; \
38                 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
39         } else { \
40                 unittest_results.passed++; \
41                 pr_debug("pass %s():%i\n", __func__, __LINE__); \
42         } \
43         failed; \
44 })
45
46 static void __init of_unittest_find_node_by_name(void)
47 {
48         struct device_node *np;
49         const char *options;
50
51         np = of_find_node_by_path("/testcase-data");
52         unittest(np && !strcmp("/testcase-data", np->full_name),
53                 "find /testcase-data failed\n");
54         of_node_put(np);
55
56         /* Test if trailing '/' works */
57         np = of_find_node_by_path("/testcase-data/");
58         unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
59
60         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
61         unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
62                 "find /testcase-data/phandle-tests/consumer-a failed\n");
63         of_node_put(np);
64
65         np = of_find_node_by_path("testcase-alias");
66         unittest(np && !strcmp("/testcase-data", np->full_name),
67                 "find testcase-alias failed\n");
68         of_node_put(np);
69
70         /* Test if trailing '/' works on aliases */
71         np = of_find_node_by_path("testcase-alias/");
72         unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
73
74         np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
75         unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
76                 "find testcase-alias/phandle-tests/consumer-a failed\n");
77         of_node_put(np);
78
79         np = of_find_node_by_path("/testcase-data/missing-path");
80         unittest(!np, "non-existent path returned node %s\n", np->full_name);
81         of_node_put(np);
82
83         np = of_find_node_by_path("missing-alias");
84         unittest(!np, "non-existent alias returned node %s\n", np->full_name);
85         of_node_put(np);
86
87         np = of_find_node_by_path("testcase-alias/missing-path");
88         unittest(!np, "non-existent alias with relative path returned node %s\n", np->full_name);
89         of_node_put(np);
90
91         np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
92         unittest(np && !strcmp("testoption", options),
93                  "option path test failed\n");
94         of_node_put(np);
95
96         np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
97         unittest(np && !strcmp("test/option", options),
98                  "option path test, subcase #1 failed\n");
99         of_node_put(np);
100
101         np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
102         unittest(np && !strcmp("test/option", options),
103                  "option path test, subcase #2 failed\n");
104         of_node_put(np);
105
106         np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
107         unittest(np, "NULL option path test failed\n");
108         of_node_put(np);
109
110         np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
111                                        &options);
112         unittest(np && !strcmp("testaliasoption", options),
113                  "option alias path test failed\n");
114         of_node_put(np);
115
116         np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
117                                        &options);
118         unittest(np && !strcmp("test/alias/option", options),
119                  "option alias path test, subcase #1 failed\n");
120         of_node_put(np);
121
122         np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
123         unittest(np, "NULL option alias path test failed\n");
124         of_node_put(np);
125
126         options = "testoption";
127         np = of_find_node_opts_by_path("testcase-alias", &options);
128         unittest(np && !options, "option clearing test failed\n");
129         of_node_put(np);
130
131         options = "testoption";
132         np = of_find_node_opts_by_path("/", &options);
133         unittest(np && !options, "option clearing root node test failed\n");
134         of_node_put(np);
135 }
136
137 static void __init of_unittest_dynamic(void)
138 {
139         struct device_node *np;
140         struct property *prop;
141
142         np = of_find_node_by_path("/testcase-data");
143         if (!np) {
144                 pr_err("missing testcase data\n");
145                 return;
146         }
147
148         /* Array of 4 properties for the purpose of testing */
149         prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL);
150         if (!prop) {
151                 unittest(0, "kzalloc() failed\n");
152                 return;
153         }
154
155         /* Add a new property - should pass*/
156         prop->name = "new-property";
157         prop->value = "new-property-data";
158         prop->length = strlen(prop->value) + 1;
159         unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
160
161         /* Try to add an existing property - should fail */
162         prop++;
163         prop->name = "new-property";
164         prop->value = "new-property-data-should-fail";
165         prop->length = strlen(prop->value) + 1;
166         unittest(of_add_property(np, prop) != 0,
167                  "Adding an existing property should have failed\n");
168
169         /* Try to modify an existing property - should pass */
170         prop->value = "modify-property-data-should-pass";
171         prop->length = strlen(prop->value) + 1;
172         unittest(of_update_property(np, prop) == 0,
173                  "Updating an existing property should have passed\n");
174
175         /* Try to modify non-existent property - should pass*/
176         prop++;
177         prop->name = "modify-property";
178         prop->value = "modify-missing-property-data-should-pass";
179         prop->length = strlen(prop->value) + 1;
180         unittest(of_update_property(np, prop) == 0,
181                  "Updating a missing property should have passed\n");
182
183         /* Remove property - should pass */
184         unittest(of_remove_property(np, prop) == 0,
185                  "Removing a property should have passed\n");
186
187         /* Adding very large property - should pass */
188         prop++;
189         prop->name = "large-property-PAGE_SIZEx8";
190         prop->length = PAGE_SIZE * 8;
191         prop->value = kzalloc(prop->length, GFP_KERNEL);
192         unittest(prop->value != NULL, "Unable to allocate large buffer\n");
193         if (prop->value)
194                 unittest(of_add_property(np, prop) == 0,
195                          "Adding a large property should have passed\n");
196 }
197
198 static int __init of_unittest_check_node_linkage(struct device_node *np)
199 {
200         struct device_node *child;
201         int count = 0, rc;
202
203         for_each_child_of_node(np, child) {
204                 if (child->parent != np) {
205                         pr_err("Child node %s links to wrong parent %s\n",
206                                  child->name, np->name);
207                         rc = -EINVAL;
208                         goto put_child;
209                 }
210
211                 rc = of_unittest_check_node_linkage(child);
212                 if (rc < 0)
213                         goto put_child;
214                 count += rc;
215         }
216
217         return count + 1;
218 put_child:
219         of_node_put(child);
220         return rc;
221 }
222
223 static void __init of_unittest_check_tree_linkage(void)
224 {
225         struct device_node *np;
226         int allnode_count = 0, child_count;
227
228         if (!of_root)
229                 return;
230
231         for_each_of_allnodes(np)
232                 allnode_count++;
233         child_count = of_unittest_check_node_linkage(of_root);
234
235         unittest(child_count > 0, "Device node data structure is corrupted\n");
236         unittest(child_count == allnode_count,
237                  "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
238                  allnode_count, child_count);
239         pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
240 }
241
242 struct node_hash {
243         struct hlist_node node;
244         struct device_node *np;
245 };
246
247 static DEFINE_HASHTABLE(phandle_ht, 8);
248 static void __init of_unittest_check_phandles(void)
249 {
250         struct device_node *np;
251         struct node_hash *nh;
252         struct hlist_node *tmp;
253         int i, dup_count = 0, phandle_count = 0;
254
255         for_each_of_allnodes(np) {
256                 if (!np->phandle)
257                         continue;
258
259                 hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
260                         if (nh->np->phandle == np->phandle) {
261                                 pr_info("Duplicate phandle! %i used by %s and %s\n",
262                                         np->phandle, nh->np->full_name, np->full_name);
263                                 dup_count++;
264                                 break;
265                         }
266                 }
267
268                 nh = kzalloc(sizeof(*nh), GFP_KERNEL);
269                 if (WARN_ON(!nh))
270                         return;
271
272                 nh->np = np;
273                 hash_add(phandle_ht, &nh->node, np->phandle);
274                 phandle_count++;
275         }
276         unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
277                  dup_count, phandle_count);
278
279         /* Clean up */
280         hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
281                 hash_del(&nh->node);
282                 kfree(nh);
283         }
284 }
285
286 static void __init of_unittest_parse_phandle_with_args(void)
287 {
288         struct device_node *np;
289         struct of_phandle_args args;
290         int i, rc;
291
292         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
293         if (!np) {
294                 pr_err("missing testcase data\n");
295                 return;
296         }
297
298         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
299         unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
300
301         for (i = 0; i < 8; i++) {
302                 bool passed = true;
303
304                 rc = of_parse_phandle_with_args(np, "phandle-list",
305                                                 "#phandle-cells", i, &args);
306
307                 /* Test the values from tests-phandle.dtsi */
308                 switch (i) {
309                 case 0:
310                         passed &= !rc;
311                         passed &= (args.args_count == 1);
312                         passed &= (args.args[0] == (i + 1));
313                         break;
314                 case 1:
315                         passed &= !rc;
316                         passed &= (args.args_count == 2);
317                         passed &= (args.args[0] == (i + 1));
318                         passed &= (args.args[1] == 0);
319                         break;
320                 case 2:
321                         passed &= (rc == -ENOENT);
322                         break;
323                 case 3:
324                         passed &= !rc;
325                         passed &= (args.args_count == 3);
326                         passed &= (args.args[0] == (i + 1));
327                         passed &= (args.args[1] == 4);
328                         passed &= (args.args[2] == 3);
329                         break;
330                 case 4:
331                         passed &= !rc;
332                         passed &= (args.args_count == 2);
333                         passed &= (args.args[0] == (i + 1));
334                         passed &= (args.args[1] == 100);
335                         break;
336                 case 5:
337                         passed &= !rc;
338                         passed &= (args.args_count == 0);
339                         break;
340                 case 6:
341                         passed &= !rc;
342                         passed &= (args.args_count == 1);
343                         passed &= (args.args[0] == (i + 1));
344                         break;
345                 case 7:
346                         passed &= (rc == -ENOENT);
347                         break;
348                 default:
349                         passed = false;
350                 }
351
352                 unittest(passed, "index %i - data error on node %s rc=%i\n",
353                          i, args.np->full_name, rc);
354         }
355
356         /* Check for missing list property */
357         rc = of_parse_phandle_with_args(np, "phandle-list-missing",
358                                         "#phandle-cells", 0, &args);
359         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
360         rc = of_count_phandle_with_args(np, "phandle-list-missing",
361                                         "#phandle-cells");
362         unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
363
364         /* Check for missing cells property */
365         rc = of_parse_phandle_with_args(np, "phandle-list",
366                                         "#phandle-cells-missing", 0, &args);
367         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
368         rc = of_count_phandle_with_args(np, "phandle-list",
369                                         "#phandle-cells-missing");
370         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
371
372         /* Check for bad phandle in list */
373         rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
374                                         "#phandle-cells", 0, &args);
375         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
376         rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
377                                         "#phandle-cells");
378         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
379
380         /* Check for incorrectly formed argument list */
381         rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
382                                         "#phandle-cells", 1, &args);
383         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
384         rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
385                                         "#phandle-cells");
386         unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
387 }
388
389 static void __init of_unittest_property_string(void)
390 {
391         const char *strings[4];
392         struct device_node *np;
393         int rc;
394
395         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
396         if (!np) {
397                 pr_err("No testcase data in device tree\n");
398                 return;
399         }
400
401         rc = of_property_match_string(np, "phandle-list-names", "first");
402         unittest(rc == 0, "first expected:0 got:%i\n", rc);
403         rc = of_property_match_string(np, "phandle-list-names", "second");
404         unittest(rc == 1, "second expected:1 got:%i\n", rc);
405         rc = of_property_match_string(np, "phandle-list-names", "third");
406         unittest(rc == 2, "third expected:2 got:%i\n", rc);
407         rc = of_property_match_string(np, "phandle-list-names", "fourth");
408         unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
409         rc = of_property_match_string(np, "missing-property", "blah");
410         unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
411         rc = of_property_match_string(np, "empty-property", "blah");
412         unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
413         rc = of_property_match_string(np, "unterminated-string", "blah");
414         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
415
416         /* of_property_count_strings() tests */
417         rc = of_property_count_strings(np, "string-property");
418         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
419         rc = of_property_count_strings(np, "phandle-list-names");
420         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
421         rc = of_property_count_strings(np, "unterminated-string");
422         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
423         rc = of_property_count_strings(np, "unterminated-string-list");
424         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
425
426         /* of_property_read_string_index() tests */
427         rc = of_property_read_string_index(np, "string-property", 0, strings);
428         unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
429         strings[0] = NULL;
430         rc = of_property_read_string_index(np, "string-property", 1, strings);
431         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
432         rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
433         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
434         rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
435         unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
436         rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
437         unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
438         strings[0] = NULL;
439         rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
440         unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
441         strings[0] = NULL;
442         rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
443         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
444         rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
445         unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
446         strings[0] = NULL;
447         rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
448         unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
449         strings[1] = NULL;
450
451         /* of_property_read_string_array() tests */
452         rc = of_property_read_string_array(np, "string-property", strings, 4);
453         unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
454         rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
455         unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
456         rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
457         unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
458         /* -- An incorrectly formed string should cause a failure */
459         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
460         unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
461         /* -- parsing the correctly formed strings should still work: */
462         strings[2] = NULL;
463         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
464         unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
465         strings[1] = NULL;
466         rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
467         unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
468 }
469
470 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
471                         (p1)->value && (p2)->value && \
472                         !memcmp((p1)->value, (p2)->value, (p1)->length) && \
473                         !strcmp((p1)->name, (p2)->name))
474 static void __init of_unittest_property_copy(void)
475 {
476 #ifdef CONFIG_OF_DYNAMIC
477         struct property p1 = { .name = "p1", .length = 0, .value = "" };
478         struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
479         struct property *new;
480
481         new = __of_prop_dup(&p1, GFP_KERNEL);
482         unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
483         kfree(new->value);
484         kfree(new->name);
485         kfree(new);
486
487         new = __of_prop_dup(&p2, GFP_KERNEL);
488         unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
489         kfree(new->value);
490         kfree(new->name);
491         kfree(new);
492 #endif
493 }
494
495 static void __init of_unittest_changeset(void)
496 {
497 #ifdef CONFIG_OF_DYNAMIC
498         struct property *ppadd, padd = { .name = "prop-add", .length = 0, .value = "" };
499         struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
500         struct property *ppremove;
501         struct device_node *n1, *n2, *n21, *nremove, *parent, *np;
502         struct of_changeset chgset;
503
504         n1 = __of_node_dup(NULL, "/testcase-data/changeset/n1");
505         unittest(n1, "testcase setup failure\n");
506         n2 = __of_node_dup(NULL, "/testcase-data/changeset/n2");
507         unittest(n2, "testcase setup failure\n");
508         n21 = __of_node_dup(NULL, "%s/%s", "/testcase-data/changeset/n2", "n21");
509         unittest(n21, "testcase setup failure %p\n", n21);
510         nremove = of_find_node_by_path("/testcase-data/changeset/node-remove");
511         unittest(nremove, "testcase setup failure\n");
512         ppadd = __of_prop_dup(&padd, GFP_KERNEL);
513         unittest(ppadd, "testcase setup failure\n");
514         ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
515         unittest(ppupdate, "testcase setup failure\n");
516         parent = nremove->parent;
517         n1->parent = parent;
518         n2->parent = parent;
519         n21->parent = n2;
520         n2->child = n21;
521         ppremove = of_find_property(parent, "prop-remove", NULL);
522         unittest(ppremove, "failed to find removal prop");
523
524         of_changeset_init(&chgset);
525         unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
526         unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
527         unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
528         unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
529         unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop\n");
530         unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
531         unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
532         unittest(!of_changeset_apply(&chgset), "apply failed\n");
533
534         /* Make sure node names are constructed correctly */
535         unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
536                  "'%s' not added\n", n21->full_name);
537         of_node_put(np);
538
539         unittest(!of_changeset_revert(&chgset), "revert failed\n");
540
541         of_changeset_destroy(&chgset);
542 #endif
543 }
544
545 static void __init of_unittest_parse_interrupts(void)
546 {
547         struct device_node *np;
548         struct of_phandle_args args;
549         int i, rc;
550
551         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
552                 return;
553
554         np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
555         if (!np) {
556                 pr_err("missing testcase data\n");
557                 return;
558         }
559
560         for (i = 0; i < 4; i++) {
561                 bool passed = true;
562
563                 args.args_count = 0;
564                 rc = of_irq_parse_one(np, i, &args);
565
566                 passed &= !rc;
567                 passed &= (args.args_count == 1);
568                 passed &= (args.args[0] == (i + 1));
569
570                 unittest(passed, "index %i - data error on node %s rc=%i\n",
571                          i, args.np->full_name, rc);
572         }
573         of_node_put(np);
574
575         np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
576         if (!np) {
577                 pr_err("missing testcase data\n");
578                 return;
579         }
580
581         for (i = 0; i < 4; i++) {
582                 bool passed = true;
583
584                 args.args_count = 0;
585                 rc = of_irq_parse_one(np, i, &args);
586
587                 /* Test the values from tests-phandle.dtsi */
588                 switch (i) {
589                 case 0:
590                         passed &= !rc;
591                         passed &= (args.args_count == 1);
592                         passed &= (args.args[0] == 9);
593                         break;
594                 case 1:
595                         passed &= !rc;
596                         passed &= (args.args_count == 3);
597                         passed &= (args.args[0] == 10);
598                         passed &= (args.args[1] == 11);
599                         passed &= (args.args[2] == 12);
600                         break;
601                 case 2:
602                         passed &= !rc;
603                         passed &= (args.args_count == 2);
604                         passed &= (args.args[0] == 13);
605                         passed &= (args.args[1] == 14);
606                         break;
607                 case 3:
608                         passed &= !rc;
609                         passed &= (args.args_count == 2);
610                         passed &= (args.args[0] == 15);
611                         passed &= (args.args[1] == 16);
612                         break;
613                 default:
614                         passed = false;
615                 }
616                 unittest(passed, "index %i - data error on node %s rc=%i\n",
617                          i, args.np->full_name, rc);
618         }
619         of_node_put(np);
620 }
621
622 static void __init of_unittest_parse_interrupts_extended(void)
623 {
624         struct device_node *np;
625         struct of_phandle_args args;
626         int i, rc;
627
628         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
629                 return;
630
631         np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
632         if (!np) {
633                 pr_err("missing testcase data\n");
634                 return;
635         }
636
637         for (i = 0; i < 7; i++) {
638                 bool passed = true;
639
640                 rc = of_irq_parse_one(np, i, &args);
641
642                 /* Test the values from tests-phandle.dtsi */
643                 switch (i) {
644                 case 0:
645                         passed &= !rc;
646                         passed &= (args.args_count == 1);
647                         passed &= (args.args[0] == 1);
648                         break;
649                 case 1:
650                         passed &= !rc;
651                         passed &= (args.args_count == 3);
652                         passed &= (args.args[0] == 2);
653                         passed &= (args.args[1] == 3);
654                         passed &= (args.args[2] == 4);
655                         break;
656                 case 2:
657                         passed &= !rc;
658                         passed &= (args.args_count == 2);
659                         passed &= (args.args[0] == 5);
660                         passed &= (args.args[1] == 6);
661                         break;
662                 case 3:
663                         passed &= !rc;
664                         passed &= (args.args_count == 1);
665                         passed &= (args.args[0] == 9);
666                         break;
667                 case 4:
668                         passed &= !rc;
669                         passed &= (args.args_count == 3);
670                         passed &= (args.args[0] == 10);
671                         passed &= (args.args[1] == 11);
672                         passed &= (args.args[2] == 12);
673                         break;
674                 case 5:
675                         passed &= !rc;
676                         passed &= (args.args_count == 2);
677                         passed &= (args.args[0] == 13);
678                         passed &= (args.args[1] == 14);
679                         break;
680                 case 6:
681                         passed &= !rc;
682                         passed &= (args.args_count == 1);
683                         passed &= (args.args[0] == 15);
684                         break;
685                 default:
686                         passed = false;
687                 }
688
689                 unittest(passed, "index %i - data error on node %s rc=%i\n",
690                          i, args.np->full_name, rc);
691         }
692         of_node_put(np);
693 }
694
695 static const struct of_device_id match_node_table[] = {
696         { .data = "A", .name = "name0", }, /* Name alone is lowest priority */
697         { .data = "B", .type = "type1", }, /* followed by type alone */
698
699         { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
700         { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
701         { .data = "Cc", .name = "name2", .type = "type2", },
702
703         { .data = "E", .compatible = "compat3" },
704         { .data = "G", .compatible = "compat2", },
705         { .data = "H", .compatible = "compat2", .name = "name5", },
706         { .data = "I", .compatible = "compat2", .type = "type1", },
707         { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
708         { .data = "K", .compatible = "compat2", .name = "name9", },
709         {}
710 };
711
712 static struct {
713         const char *path;
714         const char *data;
715 } match_node_tests[] = {
716         { .path = "/testcase-data/match-node/name0", .data = "A", },
717         { .path = "/testcase-data/match-node/name1", .data = "B", },
718         { .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
719         { .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
720         { .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
721         { .path = "/testcase-data/match-node/name3", .data = "E", },
722         { .path = "/testcase-data/match-node/name4", .data = "G", },
723         { .path = "/testcase-data/match-node/name5", .data = "H", },
724         { .path = "/testcase-data/match-node/name6", .data = "G", },
725         { .path = "/testcase-data/match-node/name7", .data = "I", },
726         { .path = "/testcase-data/match-node/name8", .data = "J", },
727         { .path = "/testcase-data/match-node/name9", .data = "K", },
728 };
729
730 static void __init of_unittest_match_node(void)
731 {
732         struct device_node *np;
733         const struct of_device_id *match;
734         int i;
735
736         for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
737                 np = of_find_node_by_path(match_node_tests[i].path);
738                 if (!np) {
739                         unittest(0, "missing testcase node %s\n",
740                                 match_node_tests[i].path);
741                         continue;
742                 }
743
744                 match = of_match_node(match_node_table, np);
745                 if (!match) {
746                         unittest(0, "%s didn't match anything\n",
747                                 match_node_tests[i].path);
748                         continue;
749                 }
750
751                 if (strcmp(match->data, match_node_tests[i].data) != 0) {
752                         unittest(0, "%s got wrong match. expected %s, got %s\n",
753                                 match_node_tests[i].path, match_node_tests[i].data,
754                                 (const char *)match->data);
755                         continue;
756                 }
757                 unittest(1, "passed");
758         }
759 }
760
761 static struct resource test_bus_res = {
762         .start = 0xfffffff8,
763         .end = 0xfffffff9,
764         .flags = IORESOURCE_MEM,
765 };
766 static const struct platform_device_info test_bus_info = {
767         .name = "unittest-bus",
768 };
769 static void __init of_unittest_platform_populate(void)
770 {
771         int irq, rc;
772         struct device_node *np, *child, *grandchild;
773         struct platform_device *pdev, *test_bus;
774         const struct of_device_id match[] = {
775                 { .compatible = "test-device", },
776                 {}
777         };
778
779         np = of_find_node_by_path("/testcase-data");
780         of_platform_default_populate(np, NULL, NULL);
781
782         /* Test that a missing irq domain returns -EPROBE_DEFER */
783         np = of_find_node_by_path("/testcase-data/testcase-device1");
784         pdev = of_find_device_by_node(np);
785         unittest(pdev, "device 1 creation failed\n");
786
787         if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
788                 irq = platform_get_irq(pdev, 0);
789                 unittest(irq == -EPROBE_DEFER,
790                          "device deferred probe failed - %d\n", irq);
791
792                 /* Test that a parsing failure does not return -EPROBE_DEFER */
793                 np = of_find_node_by_path("/testcase-data/testcase-device2");
794                 pdev = of_find_device_by_node(np);
795                 unittest(pdev, "device 2 creation failed\n");
796                 irq = platform_get_irq(pdev, 0);
797                 unittest(irq < 0 && irq != -EPROBE_DEFER,
798                          "device parsing error failed - %d\n", irq);
799         }
800
801         np = of_find_node_by_path("/testcase-data/platform-tests");
802         unittest(np, "No testcase data in device tree\n");
803         if (!np)
804                 return;
805
806         test_bus = platform_device_register_full(&test_bus_info);
807         rc = PTR_ERR_OR_ZERO(test_bus);
808         unittest(!rc, "testbus registration failed; rc=%i\n", rc);
809         if (rc)
810                 return;
811         test_bus->dev.of_node = np;
812
813         /*
814          * Add a dummy resource to the test bus node after it is
815          * registered to catch problems with un-inserted resources. The
816          * DT code doesn't insert the resources, and it has caused the
817          * kernel to oops in the past. This makes sure the same bug
818          * doesn't crop up again.
819          */
820         platform_device_add_resources(test_bus, &test_bus_res, 1);
821
822         of_platform_populate(np, match, NULL, &test_bus->dev);
823         for_each_child_of_node(np, child) {
824                 for_each_child_of_node(child, grandchild) {
825                         pdev = of_find_device_by_node(grandchild);
826                         unittest(pdev,
827                                  "Could not create device for node '%s'\n",
828                                  grandchild->name);
829                         of_dev_put(pdev);
830                 }
831         }
832
833         of_platform_depopulate(&test_bus->dev);
834         for_each_child_of_node(np, child) {
835                 for_each_child_of_node(child, grandchild)
836                         unittest(!of_find_device_by_node(grandchild),
837                                  "device didn't get destroyed '%s'\n",
838                                  grandchild->name);
839         }
840
841         platform_device_unregister(test_bus);
842         of_node_put(np);
843 }
844
845 /**
846  *      update_node_properties - adds the properties
847  *      of np into dup node (present in live tree) and
848  *      updates parent of children of np to dup.
849  *
850  *      @np:    node already present in live tree
851  *      @dup:   node present in live tree to be updated
852  */
853 static void update_node_properties(struct device_node *np,
854                                         struct device_node *dup)
855 {
856         struct property *prop;
857         struct device_node *child;
858
859         for_each_property_of_node(np, prop)
860                 of_add_property(dup, prop);
861
862         for_each_child_of_node(np, child)
863                 child->parent = dup;
864 }
865
866 /**
867  *      attach_node_and_children - attaches nodes
868  *      and its children to live tree
869  *
870  *      @np:    Node to attach to live tree
871  */
872 static int attach_node_and_children(struct device_node *np)
873 {
874         struct device_node *next, *dup, *child;
875         unsigned long flags;
876
877         dup = of_find_node_by_path(np->full_name);
878         if (dup) {
879                 update_node_properties(np, dup);
880                 return 0;
881         }
882
883         child = np->child;
884         np->child = NULL;
885
886         mutex_lock(&of_mutex);
887         raw_spin_lock_irqsave(&devtree_lock, flags);
888         np->sibling = np->parent->child;
889         np->parent->child = np;
890         of_node_clear_flag(np, OF_DETACHED);
891         raw_spin_unlock_irqrestore(&devtree_lock, flags);
892
893         __of_attach_node_sysfs(np);
894         mutex_unlock(&of_mutex);
895
896         while (child) {
897                 next = child->sibling;
898                 attach_node_and_children(child);
899                 child = next;
900         }
901
902         return 0;
903 }
904
905 /**
906  *      unittest_data_add - Reads, copies data from
907  *      linked tree and attaches it to the live tree
908  */
909 static int __init unittest_data_add(void)
910 {
911         void *unittest_data;
912         struct device_node *unittest_data_node, *np;
913         /*
914          * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
915          * created by cmd_dt_S_dtb in scripts/Makefile.lib
916          */
917         extern uint8_t __dtb_testcases_begin[];
918         extern uint8_t __dtb_testcases_end[];
919         const int size = __dtb_testcases_end - __dtb_testcases_begin;
920         int rc;
921
922         if (!size) {
923                 pr_warn("%s: No testcase data to attach; not running tests\n",
924                         __func__);
925                 return -ENODATA;
926         }
927
928         /* creating copy */
929         unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
930
931         if (!unittest_data) {
932                 pr_warn("%s: Failed to allocate memory for unittest_data; "
933                         "not running tests\n", __func__);
934                 return -ENOMEM;
935         }
936         of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
937         if (!unittest_data_node) {
938                 pr_warn("%s: No tree to attach; not running tests\n", __func__);
939                 kfree(unittest_data);
940                 return -ENODATA;
941         }
942         of_node_set_flag(unittest_data_node, OF_DETACHED);
943         rc = of_resolve_phandles(unittest_data_node);
944         if (rc) {
945                 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
946                 return -EINVAL;
947         }
948
949         if (!of_root) {
950                 of_root = unittest_data_node;
951                 for_each_of_allnodes(np)
952                         __of_attach_node_sysfs(np);
953                 of_aliases = of_find_node_by_path("/aliases");
954                 of_chosen = of_find_node_by_path("/chosen");
955                 return 0;
956         }
957
958         /* attach the sub-tree to live tree */
959         np = unittest_data_node->child;
960         while (np) {
961                 struct device_node *next = np->sibling;
962
963                 np->parent = of_root;
964                 attach_node_and_children(np);
965                 np = next;
966         }
967         return 0;
968 }
969
970 #ifdef CONFIG_OF_OVERLAY
971
972 static int unittest_probe(struct platform_device *pdev)
973 {
974         struct device *dev = &pdev->dev;
975         struct device_node *np = dev->of_node;
976
977         if (np == NULL) {
978                 dev_err(dev, "No OF data for device\n");
979                 return -EINVAL;
980
981         }
982
983         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
984
985         of_platform_populate(np, NULL, NULL, &pdev->dev);
986
987         return 0;
988 }
989
990 static int unittest_remove(struct platform_device *pdev)
991 {
992         struct device *dev = &pdev->dev;
993         struct device_node *np = dev->of_node;
994
995         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
996         return 0;
997 }
998
999 static const struct of_device_id unittest_match[] = {
1000         { .compatible = "unittest", },
1001         {},
1002 };
1003
1004 static struct platform_driver unittest_driver = {
1005         .probe                  = unittest_probe,
1006         .remove                 = unittest_remove,
1007         .driver = {
1008                 .name           = "unittest",
1009                 .of_match_table = of_match_ptr(unittest_match),
1010         },
1011 };
1012
1013 /* get the platform device instantiated at the path */
1014 static struct platform_device *of_path_to_platform_device(const char *path)
1015 {
1016         struct device_node *np;
1017         struct platform_device *pdev;
1018
1019         np = of_find_node_by_path(path);
1020         if (np == NULL)
1021                 return NULL;
1022
1023         pdev = of_find_device_by_node(np);
1024         of_node_put(np);
1025
1026         return pdev;
1027 }
1028
1029 /* find out if a platform device exists at that path */
1030 static int of_path_platform_device_exists(const char *path)
1031 {
1032         struct platform_device *pdev;
1033
1034         pdev = of_path_to_platform_device(path);
1035         platform_device_put(pdev);
1036         return pdev != NULL;
1037 }
1038
1039 #if IS_BUILTIN(CONFIG_I2C)
1040
1041 /* get the i2c client device instantiated at the path */
1042 static struct i2c_client *of_path_to_i2c_client(const char *path)
1043 {
1044         struct device_node *np;
1045         struct i2c_client *client;
1046
1047         np = of_find_node_by_path(path);
1048         if (np == NULL)
1049                 return NULL;
1050
1051         client = of_find_i2c_device_by_node(np);
1052         of_node_put(np);
1053
1054         return client;
1055 }
1056
1057 /* find out if a i2c client device exists at that path */
1058 static int of_path_i2c_client_exists(const char *path)
1059 {
1060         struct i2c_client *client;
1061
1062         client = of_path_to_i2c_client(path);
1063         if (client)
1064                 put_device(&client->dev);
1065         return client != NULL;
1066 }
1067 #else
1068 static int of_path_i2c_client_exists(const char *path)
1069 {
1070         return 0;
1071 }
1072 #endif
1073
1074 enum overlay_type {
1075         PDEV_OVERLAY,
1076         I2C_OVERLAY
1077 };
1078
1079 static int of_path_device_type_exists(const char *path,
1080                 enum overlay_type ovtype)
1081 {
1082         switch (ovtype) {
1083         case PDEV_OVERLAY:
1084                 return of_path_platform_device_exists(path);
1085         case I2C_OVERLAY:
1086                 return of_path_i2c_client_exists(path);
1087         }
1088         return 0;
1089 }
1090
1091 static const char *unittest_path(int nr, enum overlay_type ovtype)
1092 {
1093         const char *base;
1094         static char buf[256];
1095
1096         switch (ovtype) {
1097         case PDEV_OVERLAY:
1098                 base = "/testcase-data/overlay-node/test-bus";
1099                 break;
1100         case I2C_OVERLAY:
1101                 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1102                 break;
1103         default:
1104                 buf[0] = '\0';
1105                 return buf;
1106         }
1107         snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1108         buf[sizeof(buf) - 1] = '\0';
1109         return buf;
1110 }
1111
1112 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1113 {
1114         const char *path;
1115
1116         path = unittest_path(unittest_nr, ovtype);
1117
1118         switch (ovtype) {
1119         case PDEV_OVERLAY:
1120                 return of_path_platform_device_exists(path);
1121         case I2C_OVERLAY:
1122                 return of_path_i2c_client_exists(path);
1123         }
1124         return 0;
1125 }
1126
1127 static const char *overlay_path(int nr)
1128 {
1129         static char buf[256];
1130
1131         snprintf(buf, sizeof(buf) - 1,
1132                 "/testcase-data/overlay%d", nr);
1133         buf[sizeof(buf) - 1] = '\0';
1134
1135         return buf;
1136 }
1137
1138 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1139
1140 /* it is guaranteed that overlay ids are assigned in sequence */
1141 #define MAX_UNITTEST_OVERLAYS   256
1142 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1143 static int overlay_first_id = -1;
1144
1145 static void of_unittest_track_overlay(int id)
1146 {
1147         if (overlay_first_id < 0)
1148                 overlay_first_id = id;
1149         id -= overlay_first_id;
1150
1151         /* we shouldn't need that many */
1152         BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1153         overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1154 }
1155
1156 static void of_unittest_untrack_overlay(int id)
1157 {
1158         if (overlay_first_id < 0)
1159                 return;
1160         id -= overlay_first_id;
1161         BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1162         overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1163 }
1164
1165 static void of_unittest_destroy_tracked_overlays(void)
1166 {
1167         int id, ret, defers;
1168
1169         if (overlay_first_id < 0)
1170                 return;
1171
1172         /* try until no defers */
1173         do {
1174                 defers = 0;
1175                 /* remove in reverse order */
1176                 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1177                         if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1178                                 continue;
1179
1180                         ret = of_overlay_destroy(id + overlay_first_id);
1181                         if (ret == -ENODEV) {
1182                                 pr_warn("%s: no overlay to destroy for #%d\n",
1183                                         __func__, id + overlay_first_id);
1184                                 continue;
1185                         }
1186                         if (ret != 0) {
1187                                 defers++;
1188                                 pr_warn("%s: overlay destroy failed for #%d\n",
1189                                         __func__, id + overlay_first_id);
1190                                 continue;
1191                         }
1192
1193                         overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1194                 }
1195         } while (defers > 0);
1196 }
1197
1198 static int of_unittest_apply_overlay(int unittest_nr, int overlay_nr,
1199                 int *overlay_id)
1200 {
1201         struct device_node *np = NULL;
1202         int ret, id = -1;
1203
1204         np = of_find_node_by_path(overlay_path(overlay_nr));
1205         if (np == NULL) {
1206                 unittest(0, "could not find overlay node @\"%s\"\n",
1207                                 overlay_path(overlay_nr));
1208                 ret = -EINVAL;
1209                 goto out;
1210         }
1211
1212         ret = of_overlay_create(np);
1213         if (ret < 0) {
1214                 unittest(0, "could not create overlay from \"%s\"\n",
1215                                 overlay_path(overlay_nr));
1216                 goto out;
1217         }
1218         id = ret;
1219         of_unittest_track_overlay(id);
1220
1221         ret = 0;
1222
1223 out:
1224         of_node_put(np);
1225
1226         if (overlay_id)
1227                 *overlay_id = id;
1228
1229         return ret;
1230 }
1231
1232 /* apply an overlay while checking before and after states */
1233 static int of_unittest_apply_overlay_check(int overlay_nr, int unittest_nr,
1234                 int before, int after, enum overlay_type ovtype)
1235 {
1236         int ret;
1237
1238         /* unittest device must not be in before state */
1239         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1240                 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1241                                 overlay_path(overlay_nr),
1242                                 unittest_path(unittest_nr, ovtype),
1243                                 !before ? "enabled" : "disabled");
1244                 return -EINVAL;
1245         }
1246
1247         ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, NULL);
1248         if (ret != 0) {
1249                 /* of_unittest_apply_overlay already called unittest() */
1250                 return ret;
1251         }
1252
1253         /* unittest device must be to set to after state */
1254         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1255                 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1256                                 overlay_path(overlay_nr),
1257                                 unittest_path(unittest_nr, ovtype),
1258                                 !after ? "enabled" : "disabled");
1259                 return -EINVAL;
1260         }
1261
1262         return 0;
1263 }
1264
1265 /* apply an overlay and then revert it while checking before, after states */
1266 static int of_unittest_apply_revert_overlay_check(int overlay_nr,
1267                 int unittest_nr, int before, int after,
1268                 enum overlay_type ovtype)
1269 {
1270         int ret, ov_id;
1271
1272         /* unittest device must be in before state */
1273         if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1274                 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1275                                 overlay_path(overlay_nr),
1276                                 unittest_path(unittest_nr, ovtype),
1277                                 !before ? "enabled" : "disabled");
1278                 return -EINVAL;
1279         }
1280
1281         /* apply the overlay */
1282         ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ov_id);
1283         if (ret != 0) {
1284                 /* of_unittest_apply_overlay already called unittest() */
1285                 return ret;
1286         }
1287
1288         /* unittest device must be in after state */
1289         if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1290                 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1291                                 overlay_path(overlay_nr),
1292                                 unittest_path(unittest_nr, ovtype),
1293                                 !after ? "enabled" : "disabled");
1294                 return -EINVAL;
1295         }
1296
1297         ret = of_overlay_destroy(ov_id);
1298         if (ret != 0) {
1299                 unittest(0, "overlay @\"%s\" failed to be destroyed @\"%s\"\n",
1300                                 overlay_path(overlay_nr),
1301                                 unittest_path(unittest_nr, ovtype));
1302                 return ret;
1303         }
1304
1305         /* unittest device must be again in before state */
1306         if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1307                 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1308                                 overlay_path(overlay_nr),
1309                                 unittest_path(unittest_nr, ovtype),
1310                                 !before ? "enabled" : "disabled");
1311                 return -EINVAL;
1312         }
1313
1314         return 0;
1315 }
1316
1317 /* test activation of device */
1318 static void of_unittest_overlay_0(void)
1319 {
1320         int ret;
1321
1322         /* device should enable */
1323         ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
1324         if (ret != 0)
1325                 return;
1326
1327         unittest(1, "overlay test %d passed\n", 0);
1328 }
1329
1330 /* test deactivation of device */
1331 static void of_unittest_overlay_1(void)
1332 {
1333         int ret;
1334
1335         /* device should disable */
1336         ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
1337         if (ret != 0)
1338                 return;
1339
1340         unittest(1, "overlay test %d passed\n", 1);
1341 }
1342
1343 /* test activation of device */
1344 static void of_unittest_overlay_2(void)
1345 {
1346         int ret;
1347
1348         /* device should enable */
1349         ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
1350         if (ret != 0)
1351                 return;
1352
1353         unittest(1, "overlay test %d passed\n", 2);
1354 }
1355
1356 /* test deactivation of device */
1357 static void of_unittest_overlay_3(void)
1358 {
1359         int ret;
1360
1361         /* device should disable */
1362         ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
1363         if (ret != 0)
1364                 return;
1365
1366         unittest(1, "overlay test %d passed\n", 3);
1367 }
1368
1369 /* test activation of a full device node */
1370 static void of_unittest_overlay_4(void)
1371 {
1372         int ret;
1373
1374         /* device should disable */
1375         ret = of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY);
1376         if (ret != 0)
1377                 return;
1378
1379         unittest(1, "overlay test %d passed\n", 4);
1380 }
1381
1382 /* test overlay apply/revert sequence */
1383 static void of_unittest_overlay_5(void)
1384 {
1385         int ret;
1386
1387         /* device should disable */
1388         ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
1389         if (ret != 0)
1390                 return;
1391
1392         unittest(1, "overlay test %d passed\n", 5);
1393 }
1394
1395 /* test overlay application in sequence */
1396 static void of_unittest_overlay_6(void)
1397 {
1398         struct device_node *np;
1399         int ret, i, ov_id[2];
1400         int overlay_nr = 6, unittest_nr = 6;
1401         int before = 0, after = 1;
1402
1403         /* unittest device must be in before state */
1404         for (i = 0; i < 2; i++) {
1405                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1406                                 != before) {
1407                         unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1408                                         overlay_path(overlay_nr + i),
1409                                         unittest_path(unittest_nr + i,
1410                                                 PDEV_OVERLAY),
1411                                         !before ? "enabled" : "disabled");
1412                         return;
1413                 }
1414         }
1415
1416         /* apply the overlays */
1417         for (i = 0; i < 2; i++) {
1418
1419                 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1420                 if (np == NULL) {
1421                         unittest(0, "could not find overlay node @\"%s\"\n",
1422                                         overlay_path(overlay_nr + i));
1423                         return;
1424                 }
1425
1426                 ret = of_overlay_create(np);
1427                 if (ret < 0)  {
1428                         unittest(0, "could not create overlay from \"%s\"\n",
1429                                         overlay_path(overlay_nr + i));
1430                         return;
1431                 }
1432                 ov_id[i] = ret;
1433                 of_unittest_track_overlay(ov_id[i]);
1434         }
1435
1436         for (i = 0; i < 2; i++) {
1437                 /* unittest device must be in after state */
1438                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1439                                 != after) {
1440                         unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1441                                         overlay_path(overlay_nr + i),
1442                                         unittest_path(unittest_nr + i,
1443                                                 PDEV_OVERLAY),
1444                                         !after ? "enabled" : "disabled");
1445                         return;
1446                 }
1447         }
1448
1449         for (i = 1; i >= 0; i--) {
1450                 ret = of_overlay_destroy(ov_id[i]);
1451                 if (ret != 0) {
1452                         unittest(0, "overlay @\"%s\" failed destroy @\"%s\"\n",
1453                                         overlay_path(overlay_nr + i),
1454                                         unittest_path(unittest_nr + i,
1455                                                 PDEV_OVERLAY));
1456                         return;
1457                 }
1458                 of_unittest_untrack_overlay(ov_id[i]);
1459         }
1460
1461         for (i = 0; i < 2; i++) {
1462                 /* unittest device must be again in before state */
1463                 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1464                                 != before) {
1465                         unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1466                                         overlay_path(overlay_nr + i),
1467                                         unittest_path(unittest_nr + i,
1468                                                 PDEV_OVERLAY),
1469                                         !before ? "enabled" : "disabled");
1470                         return;
1471                 }
1472         }
1473
1474         unittest(1, "overlay test %d passed\n", 6);
1475 }
1476
1477 /* test overlay application in sequence */
1478 static void of_unittest_overlay_8(void)
1479 {
1480         struct device_node *np;
1481         int ret, i, ov_id[2];
1482         int overlay_nr = 8, unittest_nr = 8;
1483
1484         /* we don't care about device state in this test */
1485
1486         /* apply the overlays */
1487         for (i = 0; i < 2; i++) {
1488
1489                 np = of_find_node_by_path(overlay_path(overlay_nr + i));
1490                 if (np == NULL) {
1491                         unittest(0, "could not find overlay node @\"%s\"\n",
1492                                         overlay_path(overlay_nr + i));
1493                         return;
1494                 }
1495
1496                 ret = of_overlay_create(np);
1497                 if (ret < 0)  {
1498                         unittest(0, "could not create overlay from \"%s\"\n",
1499                                         overlay_path(overlay_nr + i));
1500                         return;
1501                 }
1502                 ov_id[i] = ret;
1503                 of_unittest_track_overlay(ov_id[i]);
1504         }
1505
1506         /* now try to remove first overlay (it should fail) */
1507         ret = of_overlay_destroy(ov_id[0]);
1508         if (ret == 0) {
1509                 unittest(0, "overlay @\"%s\" was destroyed @\"%s\"\n",
1510                                 overlay_path(overlay_nr + 0),
1511                                 unittest_path(unittest_nr,
1512                                         PDEV_OVERLAY));
1513                 return;
1514         }
1515
1516         /* removing them in order should work */
1517         for (i = 1; i >= 0; i--) {
1518                 ret = of_overlay_destroy(ov_id[i]);
1519                 if (ret != 0) {
1520                         unittest(0, "overlay @\"%s\" not destroyed @\"%s\"\n",
1521                                         overlay_path(overlay_nr + i),
1522                                         unittest_path(unittest_nr,
1523                                                 PDEV_OVERLAY));
1524                         return;
1525                 }
1526                 of_unittest_untrack_overlay(ov_id[i]);
1527         }
1528
1529         unittest(1, "overlay test %d passed\n", 8);
1530 }
1531
1532 /* test insertion of a bus with parent devices */
1533 static void of_unittest_overlay_10(void)
1534 {
1535         int ret;
1536         char *child_path;
1537
1538         /* device should disable */
1539         ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1540         if (unittest(ret == 0,
1541                         "overlay test %d failed; overlay application\n", 10))
1542                 return;
1543
1544         child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1545                         unittest_path(10, PDEV_OVERLAY));
1546         if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1547                 return;
1548
1549         ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1550         kfree(child_path);
1551         if (unittest(ret, "overlay test %d failed; no child device\n", 10))
1552                 return;
1553 }
1554
1555 /* test insertion of a bus with parent devices (and revert) */
1556 static void of_unittest_overlay_11(void)
1557 {
1558         int ret;
1559
1560         /* device should disable */
1561         ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1562                         PDEV_OVERLAY);
1563         if (unittest(ret == 0,
1564                         "overlay test %d failed; overlay application\n", 11))
1565                 return;
1566 }
1567
1568 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1569
1570 struct unittest_i2c_bus_data {
1571         struct platform_device  *pdev;
1572         struct i2c_adapter      adap;
1573 };
1574
1575 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1576                 struct i2c_msg *msgs, int num)
1577 {
1578         struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1579
1580         (void)std;
1581
1582         return num;
1583 }
1584
1585 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1586 {
1587         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1588 }
1589
1590 static const struct i2c_algorithm unittest_i2c_algo = {
1591         .master_xfer    = unittest_i2c_master_xfer,
1592         .functionality  = unittest_i2c_functionality,
1593 };
1594
1595 static int unittest_i2c_bus_probe(struct platform_device *pdev)
1596 {
1597         struct device *dev = &pdev->dev;
1598         struct device_node *np = dev->of_node;
1599         struct unittest_i2c_bus_data *std;
1600         struct i2c_adapter *adap;
1601         int ret;
1602
1603         if (np == NULL) {
1604                 dev_err(dev, "No OF data for device\n");
1605                 return -EINVAL;
1606
1607         }
1608
1609         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1610
1611         std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1612         if (!std) {
1613                 dev_err(dev, "Failed to allocate unittest i2c data\n");
1614                 return -ENOMEM;
1615         }
1616
1617         /* link them together */
1618         std->pdev = pdev;
1619         platform_set_drvdata(pdev, std);
1620
1621         adap = &std->adap;
1622         i2c_set_adapdata(adap, std);
1623         adap->nr = -1;
1624         strlcpy(adap->name, pdev->name, sizeof(adap->name));
1625         adap->class = I2C_CLASS_DEPRECATED;
1626         adap->algo = &unittest_i2c_algo;
1627         adap->dev.parent = dev;
1628         adap->dev.of_node = dev->of_node;
1629         adap->timeout = 5 * HZ;
1630         adap->retries = 3;
1631
1632         ret = i2c_add_numbered_adapter(adap);
1633         if (ret != 0) {
1634                 dev_err(dev, "Failed to add I2C adapter\n");
1635                 return ret;
1636         }
1637
1638         return 0;
1639 }
1640
1641 static int unittest_i2c_bus_remove(struct platform_device *pdev)
1642 {
1643         struct device *dev = &pdev->dev;
1644         struct device_node *np = dev->of_node;
1645         struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1646
1647         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1648         i2c_del_adapter(&std->adap);
1649
1650         return 0;
1651 }
1652
1653 static const struct of_device_id unittest_i2c_bus_match[] = {
1654         { .compatible = "unittest-i2c-bus", },
1655         {},
1656 };
1657
1658 static struct platform_driver unittest_i2c_bus_driver = {
1659         .probe                  = unittest_i2c_bus_probe,
1660         .remove                 = unittest_i2c_bus_remove,
1661         .driver = {
1662                 .name           = "unittest-i2c-bus",
1663                 .of_match_table = of_match_ptr(unittest_i2c_bus_match),
1664         },
1665 };
1666
1667 static int unittest_i2c_dev_probe(struct i2c_client *client,
1668                 const struct i2c_device_id *id)
1669 {
1670         struct device *dev = &client->dev;
1671         struct device_node *np = client->dev.of_node;
1672
1673         if (!np) {
1674                 dev_err(dev, "No OF node\n");
1675                 return -EINVAL;
1676         }
1677
1678         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1679
1680         return 0;
1681 };
1682
1683 static int unittest_i2c_dev_remove(struct i2c_client *client)
1684 {
1685         struct device *dev = &client->dev;
1686         struct device_node *np = client->dev.of_node;
1687
1688         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1689         return 0;
1690 }
1691
1692 static const struct i2c_device_id unittest_i2c_dev_id[] = {
1693         { .name = "unittest-i2c-dev" },
1694         { }
1695 };
1696
1697 static struct i2c_driver unittest_i2c_dev_driver = {
1698         .driver = {
1699                 .name = "unittest-i2c-dev",
1700         },
1701         .probe = unittest_i2c_dev_probe,
1702         .remove = unittest_i2c_dev_remove,
1703         .id_table = unittest_i2c_dev_id,
1704 };
1705
1706 #if IS_BUILTIN(CONFIG_I2C_MUX)
1707
1708 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1709 {
1710         return 0;
1711 }
1712
1713 static int unittest_i2c_mux_probe(struct i2c_client *client,
1714                 const struct i2c_device_id *id)
1715 {
1716         int ret, i, nchans;
1717         struct device *dev = &client->dev;
1718         struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1719         struct device_node *np = client->dev.of_node, *child;
1720         struct i2c_mux_core *muxc;
1721         u32 reg, max_reg;
1722
1723         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1724
1725         if (!np) {
1726                 dev_err(dev, "No OF node\n");
1727                 return -EINVAL;
1728         }
1729
1730         max_reg = (u32)-1;
1731         for_each_child_of_node(np, child) {
1732                 ret = of_property_read_u32(child, "reg", &reg);
1733                 if (ret)
1734                         continue;
1735                 if (max_reg == (u32)-1 || reg > max_reg)
1736                         max_reg = reg;
1737         }
1738         nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1739         if (nchans == 0) {
1740                 dev_err(dev, "No channels\n");
1741                 return -EINVAL;
1742         }
1743
1744         muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1745                              unittest_i2c_mux_select_chan, NULL);
1746         if (!muxc)
1747                 return -ENOMEM;
1748         for (i = 0; i < nchans; i++) {
1749                 ret = i2c_mux_add_adapter(muxc, 0, i, 0);
1750                 if (ret) {
1751                         dev_err(dev, "Failed to register mux #%d\n", i);
1752                         i2c_mux_del_adapters(muxc);
1753                         return -ENODEV;
1754                 }
1755         }
1756
1757         i2c_set_clientdata(client, muxc);
1758
1759         return 0;
1760 };
1761
1762 static int unittest_i2c_mux_remove(struct i2c_client *client)
1763 {
1764         struct device *dev = &client->dev;
1765         struct device_node *np = client->dev.of_node;
1766         struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1767
1768         dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1769         i2c_mux_del_adapters(muxc);
1770         return 0;
1771 }
1772
1773 static const struct i2c_device_id unittest_i2c_mux_id[] = {
1774         { .name = "unittest-i2c-mux" },
1775         { }
1776 };
1777
1778 static struct i2c_driver unittest_i2c_mux_driver = {
1779         .driver = {
1780                 .name = "unittest-i2c-mux",
1781         },
1782         .probe = unittest_i2c_mux_probe,
1783         .remove = unittest_i2c_mux_remove,
1784         .id_table = unittest_i2c_mux_id,
1785 };
1786
1787 #endif
1788
1789 static int of_unittest_overlay_i2c_init(void)
1790 {
1791         int ret;
1792
1793         ret = i2c_add_driver(&unittest_i2c_dev_driver);
1794         if (unittest(ret == 0,
1795                         "could not register unittest i2c device driver\n"))
1796                 return ret;
1797
1798         ret = platform_driver_register(&unittest_i2c_bus_driver);
1799         if (unittest(ret == 0,
1800                         "could not register unittest i2c bus driver\n"))
1801                 return ret;
1802
1803 #if IS_BUILTIN(CONFIG_I2C_MUX)
1804         ret = i2c_add_driver(&unittest_i2c_mux_driver);
1805         if (unittest(ret == 0,
1806                         "could not register unittest i2c mux driver\n"))
1807                 return ret;
1808 #endif
1809
1810         return 0;
1811 }
1812
1813 static void of_unittest_overlay_i2c_cleanup(void)
1814 {
1815 #if IS_BUILTIN(CONFIG_I2C_MUX)
1816         i2c_del_driver(&unittest_i2c_mux_driver);
1817 #endif
1818         platform_driver_unregister(&unittest_i2c_bus_driver);
1819         i2c_del_driver(&unittest_i2c_dev_driver);
1820 }
1821
1822 static void of_unittest_overlay_i2c_12(void)
1823 {
1824         int ret;
1825
1826         /* device should enable */
1827         ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
1828         if (ret != 0)
1829                 return;
1830
1831         unittest(1, "overlay test %d passed\n", 12);
1832 }
1833
1834 /* test deactivation of device */
1835 static void of_unittest_overlay_i2c_13(void)
1836 {
1837         int ret;
1838
1839         /* device should disable */
1840         ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
1841         if (ret != 0)
1842                 return;
1843
1844         unittest(1, "overlay test %d passed\n", 13);
1845 }
1846
1847 /* just check for i2c mux existence */
1848 static void of_unittest_overlay_i2c_14(void)
1849 {
1850 }
1851
1852 static void of_unittest_overlay_i2c_15(void)
1853 {
1854         int ret;
1855
1856         /* device should enable */
1857         ret = of_unittest_apply_overlay_check(16, 15, 0, 1, I2C_OVERLAY);
1858         if (ret != 0)
1859                 return;
1860
1861         unittest(1, "overlay test %d passed\n", 15);
1862 }
1863
1864 #else
1865
1866 static inline void of_unittest_overlay_i2c_14(void) { }
1867 static inline void of_unittest_overlay_i2c_15(void) { }
1868
1869 #endif
1870
1871 static void __init of_unittest_overlay(void)
1872 {
1873         struct device_node *bus_np = NULL;
1874         int ret;
1875
1876         ret = platform_driver_register(&unittest_driver);
1877         if (ret != 0) {
1878                 unittest(0, "could not register unittest driver\n");
1879                 goto out;
1880         }
1881
1882         bus_np = of_find_node_by_path(bus_path);
1883         if (bus_np == NULL) {
1884                 unittest(0, "could not find bus_path \"%s\"\n", bus_path);
1885                 goto out;
1886         }
1887
1888         ret = of_platform_default_populate(bus_np, NULL, NULL);
1889         if (ret != 0) {
1890                 unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
1891                 goto out;
1892         }
1893
1894         if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
1895                 unittest(0, "could not find unittest0 @ \"%s\"\n",
1896                                 unittest_path(100, PDEV_OVERLAY));
1897                 goto out;
1898         }
1899
1900         if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
1901                 unittest(0, "unittest1 @ \"%s\" should not exist\n",
1902                                 unittest_path(101, PDEV_OVERLAY));
1903                 goto out;
1904         }
1905
1906         unittest(1, "basic infrastructure of overlays passed");
1907
1908         /* tests in sequence */
1909         of_unittest_overlay_0();
1910         of_unittest_overlay_1();
1911         of_unittest_overlay_2();
1912         of_unittest_overlay_3();
1913         of_unittest_overlay_4();
1914         of_unittest_overlay_5();
1915         of_unittest_overlay_6();
1916         of_unittest_overlay_8();
1917
1918         of_unittest_overlay_10();
1919         of_unittest_overlay_11();
1920
1921 #if IS_BUILTIN(CONFIG_I2C)
1922         if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
1923                 goto out;
1924
1925         of_unittest_overlay_i2c_12();
1926         of_unittest_overlay_i2c_13();
1927         of_unittest_overlay_i2c_14();
1928         of_unittest_overlay_i2c_15();
1929
1930         of_unittest_overlay_i2c_cleanup();
1931 #endif
1932
1933         of_unittest_destroy_tracked_overlays();
1934
1935 out:
1936         of_node_put(bus_np);
1937 }
1938
1939 #else
1940 static inline void __init of_unittest_overlay(void) { }
1941 #endif
1942
1943 static int __init of_unittest(void)
1944 {
1945         struct device_node *np;
1946         int res;
1947
1948         /* adding data for unittest */
1949         res = unittest_data_add();
1950         if (res)
1951                 return res;
1952         if (!of_aliases)
1953                 of_aliases = of_find_node_by_path("/aliases");
1954
1955         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
1956         if (!np) {
1957                 pr_info("No testcase data in device tree; not running tests\n");
1958                 return 0;
1959         }
1960         of_node_put(np);
1961
1962         pr_info("start of unittest - you will see error messages\n");
1963         of_unittest_check_tree_linkage();
1964         of_unittest_check_phandles();
1965         of_unittest_find_node_by_name();
1966         of_unittest_dynamic();
1967         of_unittest_parse_phandle_with_args();
1968         of_unittest_property_string();
1969         of_unittest_property_copy();
1970         of_unittest_changeset();
1971         of_unittest_parse_interrupts();
1972         of_unittest_parse_interrupts_extended();
1973         of_unittest_match_node();
1974         of_unittest_platform_populate();
1975         of_unittest_overlay();
1976
1977         /* Double check linkage after removing testcase data */
1978         of_unittest_check_tree_linkage();
1979
1980         pr_info("end of unittest - %i passed, %i failed\n",
1981                 unittest_results.passed, unittest_results.failed);
1982
1983         return 0;
1984 }
1985 late_initcall(of_unittest);