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