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