xref: /linux/drivers/of/unittest.c (revision fb2ac84f8acccdec644d26dfc8ba6554f30cd6c0)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Self tests for device tree subsystem
4  */
5 
6 #define pr_fmt(fmt) "### dt-test ### " fmt
7 
8 #include <linux/memblock.h>
9 #include <linux/clk.h>
10 #include <linux/dma-direct.h> /* to test phys_to_dma/dma_to_phys */
11 #include <linux/err.h>
12 #include <linux/errno.h>
13 #include <linux/hashtable.h>
14 #include <linux/libfdt.h>
15 #include <linux/of.h>
16 #include <linux/of_address.h>
17 #include <linux/of_fdt.h>
18 #include <linux/of_irq.h>
19 #include <linux/of_platform.h>
20 #include <linux/list.h>
21 #include <linux/mutex.h>
22 #include <linux/slab.h>
23 #include <linux/device.h>
24 #include <linux/platform_device.h>
25 #include <linux/kernel.h>
26 
27 #include <linux/i2c.h>
28 #include <linux/i2c-mux.h>
29 #include <linux/gpio/driver.h>
30 
31 #include <linux/bitops.h>
32 
33 #include "of_private.h"
34 
35 static struct unittest_results {
36 	int passed;
37 	int failed;
38 } unittest_results;
39 
40 #define unittest(result, fmt, ...) ({ \
41 	bool failed = !(result); \
42 	if (failed) { \
43 		unittest_results.failed++; \
44 		pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
45 	} else { \
46 		unittest_results.passed++; \
47 		pr_info("pass %s():%i\n", __func__, __LINE__); \
48 	} \
49 	failed; \
50 })
51 
52 /*
53  * Expected message may have a message level other than KERN_INFO.
54  * Print the expected message only if the current loglevel will allow
55  * the actual message to print.
56  *
57  * Do not use EXPECT_BEGIN() or EXPECT_END() for messages generated by
58  * pr_debug().
59  */
60 #define EXPECT_BEGIN(level, fmt, ...) \
61 	printk(level pr_fmt("EXPECT \\ : ") fmt, ##__VA_ARGS__)
62 
63 #define EXPECT_END(level, fmt, ...) \
64 	printk(level pr_fmt("EXPECT / : ") fmt, ##__VA_ARGS__)
65 
66 static void __init of_unittest_find_node_by_name(void)
67 {
68 	struct device_node *np;
69 	const char *options, *name;
70 
71 	np = of_find_node_by_path("/testcase-data");
72 	name = kasprintf(GFP_KERNEL, "%pOF", np);
73 	unittest(np && !strcmp("/testcase-data", name),
74 		"find /testcase-data failed\n");
75 	of_node_put(np);
76 	kfree(name);
77 
78 	/* Test if trailing '/' works */
79 	np = of_find_node_by_path("/testcase-data/");
80 	unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
81 
82 	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
83 	name = kasprintf(GFP_KERNEL, "%pOF", np);
84 	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
85 		"find /testcase-data/phandle-tests/consumer-a failed\n");
86 	of_node_put(np);
87 	kfree(name);
88 
89 	np = of_find_node_by_path("testcase-alias");
90 	name = kasprintf(GFP_KERNEL, "%pOF", np);
91 	unittest(np && !strcmp("/testcase-data", name),
92 		"find testcase-alias failed\n");
93 	of_node_put(np);
94 	kfree(name);
95 
96 	/* Test if trailing '/' works on aliases */
97 	np = of_find_node_by_path("testcase-alias/");
98 	unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
99 
100 	np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
101 	name = kasprintf(GFP_KERNEL, "%pOF", np);
102 	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
103 		"find testcase-alias/phandle-tests/consumer-a failed\n");
104 	of_node_put(np);
105 	kfree(name);
106 
107 	np = of_find_node_by_path("/testcase-data/missing-path");
108 	unittest(!np, "non-existent path returned node %pOF\n", np);
109 	of_node_put(np);
110 
111 	np = of_find_node_by_path("missing-alias");
112 	unittest(!np, "non-existent alias returned node %pOF\n", np);
113 	of_node_put(np);
114 
115 	np = of_find_node_by_path("testcase-alias/missing-path");
116 	unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
117 	of_node_put(np);
118 
119 	np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
120 	unittest(np && !strcmp("testoption", options),
121 		 "option path test failed\n");
122 	of_node_put(np);
123 
124 	np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
125 	unittest(np && !strcmp("test/option", options),
126 		 "option path test, subcase #1 failed\n");
127 	of_node_put(np);
128 
129 	np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
130 	unittest(np && !strcmp("test/option", options),
131 		 "option path test, subcase #2 failed\n");
132 	of_node_put(np);
133 
134 	np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
135 	unittest(np, "NULL option path test failed\n");
136 	of_node_put(np);
137 
138 	np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
139 				       &options);
140 	unittest(np && !strcmp("testaliasoption", options),
141 		 "option alias path test failed\n");
142 	of_node_put(np);
143 
144 	np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
145 				       &options);
146 	unittest(np && !strcmp("test/alias/option", options),
147 		 "option alias path test, subcase #1 failed\n");
148 	of_node_put(np);
149 
150 	np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
151 	unittest(np, "NULL option alias path test failed\n");
152 	of_node_put(np);
153 
154 	options = "testoption";
155 	np = of_find_node_opts_by_path("testcase-alias", &options);
156 	unittest(np && !options, "option clearing test failed\n");
157 	of_node_put(np);
158 
159 	options = "testoption";
160 	np = of_find_node_opts_by_path("/", &options);
161 	unittest(np && !options, "option clearing root node test failed\n");
162 	of_node_put(np);
163 }
164 
165 static void __init of_unittest_dynamic(void)
166 {
167 	struct device_node *np;
168 	struct property *prop;
169 
170 	np = of_find_node_by_path("/testcase-data");
171 	if (!np) {
172 		pr_err("missing testcase data\n");
173 		return;
174 	}
175 
176 	/* Array of 4 properties for the purpose of testing */
177 	prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
178 	if (!prop) {
179 		unittest(0, "kzalloc() failed\n");
180 		return;
181 	}
182 
183 	/* Add a new property - should pass*/
184 	prop->name = "new-property";
185 	prop->value = "new-property-data";
186 	prop->length = strlen(prop->value) + 1;
187 	unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
188 
189 	/* Try to add an existing property - should fail */
190 	prop++;
191 	prop->name = "new-property";
192 	prop->value = "new-property-data-should-fail";
193 	prop->length = strlen(prop->value) + 1;
194 	unittest(of_add_property(np, prop) != 0,
195 		 "Adding an existing property should have failed\n");
196 
197 	/* Try to modify an existing property - should pass */
198 	prop->value = "modify-property-data-should-pass";
199 	prop->length = strlen(prop->value) + 1;
200 	unittest(of_update_property(np, prop) == 0,
201 		 "Updating an existing property should have passed\n");
202 
203 	/* Try to modify non-existent property - should pass*/
204 	prop++;
205 	prop->name = "modify-property";
206 	prop->value = "modify-missing-property-data-should-pass";
207 	prop->length = strlen(prop->value) + 1;
208 	unittest(of_update_property(np, prop) == 0,
209 		 "Updating a missing property should have passed\n");
210 
211 	/* Remove property - should pass */
212 	unittest(of_remove_property(np, prop) == 0,
213 		 "Removing a property should have passed\n");
214 
215 	/* Adding very large property - should pass */
216 	prop++;
217 	prop->name = "large-property-PAGE_SIZEx8";
218 	prop->length = PAGE_SIZE * 8;
219 	prop->value = kzalloc(prop->length, GFP_KERNEL);
220 	unittest(prop->value != NULL, "Unable to allocate large buffer\n");
221 	if (prop->value)
222 		unittest(of_add_property(np, prop) == 0,
223 			 "Adding a large property should have passed\n");
224 }
225 
226 static int __init of_unittest_check_node_linkage(struct device_node *np)
227 {
228 	struct device_node *child;
229 	int count = 0, rc;
230 
231 	for_each_child_of_node(np, child) {
232 		if (child->parent != np) {
233 			pr_err("Child node %pOFn links to wrong parent %pOFn\n",
234 				 child, np);
235 			rc = -EINVAL;
236 			goto put_child;
237 		}
238 
239 		rc = of_unittest_check_node_linkage(child);
240 		if (rc < 0)
241 			goto put_child;
242 		count += rc;
243 	}
244 
245 	return count + 1;
246 put_child:
247 	of_node_put(child);
248 	return rc;
249 }
250 
251 static void __init of_unittest_check_tree_linkage(void)
252 {
253 	struct device_node *np;
254 	int allnode_count = 0, child_count;
255 
256 	if (!of_root)
257 		return;
258 
259 	for_each_of_allnodes(np)
260 		allnode_count++;
261 	child_count = of_unittest_check_node_linkage(of_root);
262 
263 	unittest(child_count > 0, "Device node data structure is corrupted\n");
264 	unittest(child_count == allnode_count,
265 		 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
266 		 allnode_count, child_count);
267 	pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
268 }
269 
270 static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
271 					  const char *expected)
272 {
273 	unsigned char *buf;
274 	int buf_size;
275 	int size, i;
276 
277 	buf_size = strlen(expected) + 10;
278 	buf = kmalloc(buf_size, GFP_KERNEL);
279 	if (!buf)
280 		return;
281 
282 	/* Baseline; check conversion with a large size limit */
283 	memset(buf, 0xff, buf_size);
284 	size = snprintf(buf, buf_size - 2, fmt, np);
285 
286 	/* use strcmp() instead of strncmp() here to be absolutely sure strings match */
287 	unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
288 		"sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
289 		fmt, expected, buf);
290 
291 	/* Make sure length limits work */
292 	size++;
293 	for (i = 0; i < 2; i++, size--) {
294 		/* Clear the buffer, and make sure it works correctly still */
295 		memset(buf, 0xff, buf_size);
296 		snprintf(buf, size+1, fmt, np);
297 		unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
298 			"snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
299 			size, fmt, expected, buf);
300 	}
301 	kfree(buf);
302 }
303 
304 static void __init of_unittest_printf(void)
305 {
306 	struct device_node *np;
307 	const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
308 	char phandle_str[16] = "";
309 
310 	np = of_find_node_by_path(full_name);
311 	if (!np) {
312 		unittest(np, "testcase data missing\n");
313 		return;
314 	}
315 
316 	num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
317 
318 	of_unittest_printf_one(np, "%pOF",  full_name);
319 	of_unittest_printf_one(np, "%pOFf", full_name);
320 	of_unittest_printf_one(np, "%pOFn", "dev");
321 	of_unittest_printf_one(np, "%2pOFn", "dev");
322 	of_unittest_printf_one(np, "%5pOFn", "  dev");
323 	of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
324 	of_unittest_printf_one(np, "%pOFp", phandle_str);
325 	of_unittest_printf_one(np, "%pOFP", "dev@100");
326 	of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
327 	of_unittest_printf_one(np, "%10pOFP", "   dev@100");
328 	of_unittest_printf_one(np, "%-10pOFP", "dev@100   ");
329 	of_unittest_printf_one(of_root, "%pOFP", "/");
330 	of_unittest_printf_one(np, "%pOFF", "----");
331 	of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
332 	of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
333 	of_unittest_printf_one(np, "%pOFc", "test-sub-device");
334 	of_unittest_printf_one(np, "%pOFC",
335 			"\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
336 }
337 
338 struct node_hash {
339 	struct hlist_node node;
340 	struct device_node *np;
341 };
342 
343 static DEFINE_HASHTABLE(phandle_ht, 8);
344 static void __init of_unittest_check_phandles(void)
345 {
346 	struct device_node *np;
347 	struct node_hash *nh;
348 	struct hlist_node *tmp;
349 	int i, dup_count = 0, phandle_count = 0;
350 
351 	for_each_of_allnodes(np) {
352 		if (!np->phandle)
353 			continue;
354 
355 		hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
356 			if (nh->np->phandle == np->phandle) {
357 				pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
358 					np->phandle, nh->np, np);
359 				dup_count++;
360 				break;
361 			}
362 		}
363 
364 		nh = kzalloc(sizeof(*nh), GFP_KERNEL);
365 		if (!nh)
366 			return;
367 
368 		nh->np = np;
369 		hash_add(phandle_ht, &nh->node, np->phandle);
370 		phandle_count++;
371 	}
372 	unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
373 		 dup_count, phandle_count);
374 
375 	/* Clean up */
376 	hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
377 		hash_del(&nh->node);
378 		kfree(nh);
379 	}
380 }
381 
382 static void __init of_unittest_parse_phandle_with_args(void)
383 {
384 	struct device_node *np;
385 	struct of_phandle_args args;
386 	int i, rc;
387 
388 	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
389 	if (!np) {
390 		pr_err("missing testcase data\n");
391 		return;
392 	}
393 
394 	rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
395 	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
396 
397 	for (i = 0; i < 8; i++) {
398 		bool passed = true;
399 
400 		memset(&args, 0, sizeof(args));
401 		rc = of_parse_phandle_with_args(np, "phandle-list",
402 						"#phandle-cells", i, &args);
403 
404 		/* Test the values from tests-phandle.dtsi */
405 		switch (i) {
406 		case 0:
407 			passed &= !rc;
408 			passed &= (args.args_count == 1);
409 			passed &= (args.args[0] == (i + 1));
410 			break;
411 		case 1:
412 			passed &= !rc;
413 			passed &= (args.args_count == 2);
414 			passed &= (args.args[0] == (i + 1));
415 			passed &= (args.args[1] == 0);
416 			break;
417 		case 2:
418 			passed &= (rc == -ENOENT);
419 			break;
420 		case 3:
421 			passed &= !rc;
422 			passed &= (args.args_count == 3);
423 			passed &= (args.args[0] == (i + 1));
424 			passed &= (args.args[1] == 4);
425 			passed &= (args.args[2] == 3);
426 			break;
427 		case 4:
428 			passed &= !rc;
429 			passed &= (args.args_count == 2);
430 			passed &= (args.args[0] == (i + 1));
431 			passed &= (args.args[1] == 100);
432 			break;
433 		case 5:
434 			passed &= !rc;
435 			passed &= (args.args_count == 0);
436 			break;
437 		case 6:
438 			passed &= !rc;
439 			passed &= (args.args_count == 1);
440 			passed &= (args.args[0] == (i + 1));
441 			break;
442 		case 7:
443 			passed &= (rc == -ENOENT);
444 			break;
445 		default:
446 			passed = false;
447 		}
448 
449 		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
450 			 i, args.np, rc);
451 	}
452 
453 	/* Check for missing list property */
454 	memset(&args, 0, sizeof(args));
455 	rc = of_parse_phandle_with_args(np, "phandle-list-missing",
456 					"#phandle-cells", 0, &args);
457 	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
458 	rc = of_count_phandle_with_args(np, "phandle-list-missing",
459 					"#phandle-cells");
460 	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
461 
462 	/* Check for missing cells property */
463 	memset(&args, 0, sizeof(args));
464 
465 	EXPECT_BEGIN(KERN_INFO,
466 		     "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
467 
468 	rc = of_parse_phandle_with_args(np, "phandle-list",
469 					"#phandle-cells-missing", 0, &args);
470 
471 	EXPECT_END(KERN_INFO,
472 		   "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
473 
474 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
475 
476 	EXPECT_BEGIN(KERN_INFO,
477 		     "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
478 
479 	rc = of_count_phandle_with_args(np, "phandle-list",
480 					"#phandle-cells-missing");
481 
482 	EXPECT_END(KERN_INFO,
483 		   "OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
484 
485 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
486 
487 	/* Check for bad phandle in list */
488 	memset(&args, 0, sizeof(args));
489 
490 	EXPECT_BEGIN(KERN_INFO,
491 		     "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
492 
493 	rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
494 					"#phandle-cells", 0, &args);
495 
496 	EXPECT_END(KERN_INFO,
497 		   "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
498 
499 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
500 
501 	EXPECT_BEGIN(KERN_INFO,
502 		     "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
503 
504 	rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
505 					"#phandle-cells");
506 
507 	EXPECT_END(KERN_INFO,
508 		   "OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
509 
510 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
511 
512 	/* Check for incorrectly formed argument list */
513 	memset(&args, 0, sizeof(args));
514 
515 	EXPECT_BEGIN(KERN_INFO,
516 		     "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
517 
518 	rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
519 					"#phandle-cells", 1, &args);
520 
521 	EXPECT_END(KERN_INFO,
522 		   "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
523 
524 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
525 
526 	EXPECT_BEGIN(KERN_INFO,
527 		     "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
528 
529 	rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
530 					"#phandle-cells");
531 
532 	EXPECT_END(KERN_INFO,
533 		   "OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
534 
535 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
536 }
537 
538 static void __init of_unittest_parse_phandle_with_args_map(void)
539 {
540 	struct device_node *np, *p0, *p1, *p2, *p3;
541 	struct of_phandle_args args;
542 	int i, rc;
543 
544 	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
545 	if (!np) {
546 		pr_err("missing testcase data\n");
547 		return;
548 	}
549 
550 	p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
551 	if (!p0) {
552 		pr_err("missing testcase data\n");
553 		return;
554 	}
555 
556 	p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
557 	if (!p1) {
558 		pr_err("missing testcase data\n");
559 		return;
560 	}
561 
562 	p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
563 	if (!p2) {
564 		pr_err("missing testcase data\n");
565 		return;
566 	}
567 
568 	p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
569 	if (!p3) {
570 		pr_err("missing testcase data\n");
571 		return;
572 	}
573 
574 	rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
575 	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
576 
577 	for (i = 0; i < 8; i++) {
578 		bool passed = true;
579 
580 		memset(&args, 0, sizeof(args));
581 		rc = of_parse_phandle_with_args_map(np, "phandle-list",
582 						    "phandle", i, &args);
583 
584 		/* Test the values from tests-phandle.dtsi */
585 		switch (i) {
586 		case 0:
587 			passed &= !rc;
588 			passed &= (args.np == p1);
589 			passed &= (args.args_count == 1);
590 			passed &= (args.args[0] == 1);
591 			break;
592 		case 1:
593 			passed &= !rc;
594 			passed &= (args.np == p3);
595 			passed &= (args.args_count == 3);
596 			passed &= (args.args[0] == 2);
597 			passed &= (args.args[1] == 5);
598 			passed &= (args.args[2] == 3);
599 			break;
600 		case 2:
601 			passed &= (rc == -ENOENT);
602 			break;
603 		case 3:
604 			passed &= !rc;
605 			passed &= (args.np == p0);
606 			passed &= (args.args_count == 0);
607 			break;
608 		case 4:
609 			passed &= !rc;
610 			passed &= (args.np == p1);
611 			passed &= (args.args_count == 1);
612 			passed &= (args.args[0] == 3);
613 			break;
614 		case 5:
615 			passed &= !rc;
616 			passed &= (args.np == p0);
617 			passed &= (args.args_count == 0);
618 			break;
619 		case 6:
620 			passed &= !rc;
621 			passed &= (args.np == p2);
622 			passed &= (args.args_count == 2);
623 			passed &= (args.args[0] == 15);
624 			passed &= (args.args[1] == 0x20);
625 			break;
626 		case 7:
627 			passed &= (rc == -ENOENT);
628 			break;
629 		default:
630 			passed = false;
631 		}
632 
633 		unittest(passed, "index %i - data error on node %s rc=%i\n",
634 			 i, args.np->full_name, rc);
635 	}
636 
637 	/* Check for missing list property */
638 	memset(&args, 0, sizeof(args));
639 	rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
640 					    "phandle", 0, &args);
641 	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
642 
643 	/* Check for missing cells,map,mask property */
644 	memset(&args, 0, sizeof(args));
645 
646 	EXPECT_BEGIN(KERN_INFO,
647 		     "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
648 
649 	rc = of_parse_phandle_with_args_map(np, "phandle-list",
650 					    "phandle-missing", 0, &args);
651 	EXPECT_END(KERN_INFO,
652 		   "OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
653 
654 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
655 
656 	/* Check for bad phandle in list */
657 	memset(&args, 0, sizeof(args));
658 
659 	EXPECT_BEGIN(KERN_INFO,
660 		     "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
661 
662 	rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
663 					    "phandle", 0, &args);
664 	EXPECT_END(KERN_INFO,
665 		   "OF: /testcase-data/phandle-tests/consumer-b: could not find phandle");
666 
667 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
668 
669 	/* Check for incorrectly formed argument list */
670 	memset(&args, 0, sizeof(args));
671 
672 	EXPECT_BEGIN(KERN_INFO,
673 		     "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
674 
675 	rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
676 					    "phandle", 1, &args);
677 	EXPECT_END(KERN_INFO,
678 		   "OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
679 
680 	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
681 }
682 
683 static void __init of_unittest_property_string(void)
684 {
685 	const char *strings[4];
686 	struct device_node *np;
687 	int rc;
688 
689 	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
690 	if (!np) {
691 		pr_err("No testcase data in device tree\n");
692 		return;
693 	}
694 
695 	rc = of_property_match_string(np, "phandle-list-names", "first");
696 	unittest(rc == 0, "first expected:0 got:%i\n", rc);
697 	rc = of_property_match_string(np, "phandle-list-names", "second");
698 	unittest(rc == 1, "second expected:1 got:%i\n", rc);
699 	rc = of_property_match_string(np, "phandle-list-names", "third");
700 	unittest(rc == 2, "third expected:2 got:%i\n", rc);
701 	rc = of_property_match_string(np, "phandle-list-names", "fourth");
702 	unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
703 	rc = of_property_match_string(np, "missing-property", "blah");
704 	unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
705 	rc = of_property_match_string(np, "empty-property", "blah");
706 	unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
707 	rc = of_property_match_string(np, "unterminated-string", "blah");
708 	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
709 
710 	/* of_property_count_strings() tests */
711 	rc = of_property_count_strings(np, "string-property");
712 	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
713 	rc = of_property_count_strings(np, "phandle-list-names");
714 	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
715 	rc = of_property_count_strings(np, "unterminated-string");
716 	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
717 	rc = of_property_count_strings(np, "unterminated-string-list");
718 	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
719 
720 	/* of_property_read_string_index() tests */
721 	rc = of_property_read_string_index(np, "string-property", 0, strings);
722 	unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
723 	strings[0] = NULL;
724 	rc = of_property_read_string_index(np, "string-property", 1, strings);
725 	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
726 	rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
727 	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
728 	rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
729 	unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
730 	rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
731 	unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
732 	strings[0] = NULL;
733 	rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
734 	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
735 	strings[0] = NULL;
736 	rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
737 	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
738 	rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
739 	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
740 	strings[0] = NULL;
741 	rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
742 	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
743 	strings[1] = NULL;
744 
745 	/* of_property_read_string_array() tests */
746 	rc = of_property_read_string_array(np, "string-property", strings, 4);
747 	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
748 	rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
749 	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
750 	rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
751 	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
752 	/* -- An incorrectly formed string should cause a failure */
753 	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
754 	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
755 	/* -- parsing the correctly formed strings should still work: */
756 	strings[2] = NULL;
757 	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
758 	unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
759 	strings[1] = NULL;
760 	rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
761 	unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
762 }
763 
764 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
765 			(p1)->value && (p2)->value && \
766 			!memcmp((p1)->value, (p2)->value, (p1)->length) && \
767 			!strcmp((p1)->name, (p2)->name))
768 static void __init of_unittest_property_copy(void)
769 {
770 #ifdef CONFIG_OF_DYNAMIC
771 	struct property p1 = { .name = "p1", .length = 0, .value = "" };
772 	struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
773 	struct property *new;
774 
775 	new = __of_prop_dup(&p1, GFP_KERNEL);
776 	unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
777 	kfree(new->value);
778 	kfree(new->name);
779 	kfree(new);
780 
781 	new = __of_prop_dup(&p2, GFP_KERNEL);
782 	unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
783 	kfree(new->value);
784 	kfree(new->name);
785 	kfree(new);
786 #endif
787 }
788 
789 static void __init of_unittest_changeset(void)
790 {
791 #ifdef CONFIG_OF_DYNAMIC
792 	struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
793 	struct property *ppname_n1,  pname_n1  = { .name = "name", .length = 3, .value = "n1"  };
794 	struct property *ppname_n2,  pname_n2  = { .name = "name", .length = 3, .value = "n2"  };
795 	struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
796 	struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
797 	struct property *ppremove;
798 	struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
799 	struct of_changeset chgset;
800 
801 	n1 = __of_node_dup(NULL, "n1");
802 	unittest(n1, "testcase setup failure\n");
803 
804 	n2 = __of_node_dup(NULL, "n2");
805 	unittest(n2, "testcase setup failure\n");
806 
807 	n21 = __of_node_dup(NULL, "n21");
808 	unittest(n21, "testcase setup failure %p\n", n21);
809 
810 	nchangeset = of_find_node_by_path("/testcase-data/changeset");
811 	nremove = of_get_child_by_name(nchangeset, "node-remove");
812 	unittest(nremove, "testcase setup failure\n");
813 
814 	ppadd = __of_prop_dup(&padd, GFP_KERNEL);
815 	unittest(ppadd, "testcase setup failure\n");
816 
817 	ppname_n1  = __of_prop_dup(&pname_n1, GFP_KERNEL);
818 	unittest(ppname_n1, "testcase setup failure\n");
819 
820 	ppname_n2  = __of_prop_dup(&pname_n2, GFP_KERNEL);
821 	unittest(ppname_n2, "testcase setup failure\n");
822 
823 	ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
824 	unittest(ppname_n21, "testcase setup failure\n");
825 
826 	ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
827 	unittest(ppupdate, "testcase setup failure\n");
828 
829 	parent = nchangeset;
830 	n1->parent = parent;
831 	n2->parent = parent;
832 	n21->parent = n2;
833 
834 	ppremove = of_find_property(parent, "prop-remove", NULL);
835 	unittest(ppremove, "failed to find removal prop");
836 
837 	of_changeset_init(&chgset);
838 
839 	unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
840 	unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
841 
842 	unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
843 	unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
844 
845 	unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
846 	unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
847 
848 	unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
849 
850 	unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
851 	unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
852 	unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
853 
854 	unittest(!of_changeset_apply(&chgset), "apply failed\n");
855 
856 	of_node_put(nchangeset);
857 
858 	/* Make sure node names are constructed correctly */
859 	unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
860 		 "'%pOF' not added\n", n21);
861 	of_node_put(np);
862 
863 	unittest(!of_changeset_revert(&chgset), "revert failed\n");
864 
865 	of_changeset_destroy(&chgset);
866 
867 	of_node_put(n1);
868 	of_node_put(n2);
869 	of_node_put(n21);
870 #endif
871 }
872 
873 static void __init of_unittest_dma_get_max_cpu_address(void)
874 {
875 	struct device_node *np;
876 	phys_addr_t cpu_addr;
877 
878 	if (!IS_ENABLED(CONFIG_OF_ADDRESS))
879 		return;
880 
881 	np = of_find_node_by_path("/testcase-data/address-tests");
882 	if (!np) {
883 		pr_err("missing testcase data\n");
884 		return;
885 	}
886 
887 	cpu_addr = of_dma_get_max_cpu_address(np);
888 	unittest(cpu_addr == 0x4fffffff,
889 		 "of_dma_get_max_cpu_address: wrong CPU addr %pad (expecting %x)\n",
890 		 &cpu_addr, 0x4fffffff);
891 }
892 
893 static void __init of_unittest_dma_ranges_one(const char *path,
894 		u64 expect_dma_addr, u64 expect_paddr)
895 {
896 #ifdef CONFIG_HAS_DMA
897 	struct device_node *np;
898 	const struct bus_dma_region *map = NULL;
899 	int rc;
900 
901 	np = of_find_node_by_path(path);
902 	if (!np) {
903 		pr_err("missing testcase data\n");
904 		return;
905 	}
906 
907 	rc = of_dma_get_range(np, &map);
908 
909 	unittest(!rc, "of_dma_get_range failed on node %pOF rc=%i\n", np, rc);
910 
911 	if (!rc) {
912 		phys_addr_t	paddr;
913 		dma_addr_t	dma_addr;
914 		struct device	*dev_bogus;
915 
916 		dev_bogus = kzalloc(sizeof(struct device), GFP_KERNEL);
917 		if (!dev_bogus) {
918 			unittest(0, "kzalloc() failed\n");
919 			kfree(map);
920 			return;
921 		}
922 
923 		dev_bogus->dma_range_map = map;
924 		paddr = dma_to_phys(dev_bogus, expect_dma_addr);
925 		dma_addr = phys_to_dma(dev_bogus, expect_paddr);
926 
927 		unittest(paddr == expect_paddr,
928 			 "of_dma_get_range: wrong phys addr %pap (expecting %llx) on node %pOF\n",
929 			 &paddr, expect_paddr, np);
930 		unittest(dma_addr == expect_dma_addr,
931 			 "of_dma_get_range: wrong DMA addr %pad (expecting %llx) on node %pOF\n",
932 			 &dma_addr, expect_dma_addr, np);
933 
934 		kfree(map);
935 		kfree(dev_bogus);
936 	}
937 	of_node_put(np);
938 #endif
939 }
940 
941 static void __init of_unittest_parse_dma_ranges(void)
942 {
943 	of_unittest_dma_ranges_one("/testcase-data/address-tests/device@70000000",
944 		0x0, 0x20000000);
945 	if (IS_ENABLED(CONFIG_ARCH_DMA_ADDR_T_64BIT))
946 		of_unittest_dma_ranges_one("/testcase-data/address-tests/bus@80000000/device@1000",
947 			0x100000000, 0x20000000);
948 	of_unittest_dma_ranges_one("/testcase-data/address-tests/pci@90000000",
949 		0x80000000, 0x20000000);
950 }
951 
952 static void __init of_unittest_pci_dma_ranges(void)
953 {
954 	struct device_node *np;
955 	struct of_pci_range range;
956 	struct of_pci_range_parser parser;
957 	int i = 0;
958 
959 	if (!IS_ENABLED(CONFIG_PCI))
960 		return;
961 
962 	np = of_find_node_by_path("/testcase-data/address-tests/pci@90000000");
963 	if (!np) {
964 		pr_err("missing testcase data\n");
965 		return;
966 	}
967 
968 	if (of_pci_dma_range_parser_init(&parser, np)) {
969 		pr_err("missing dma-ranges property\n");
970 		return;
971 	}
972 
973 	/*
974 	 * Get the dma-ranges from the device tree
975 	 */
976 	for_each_of_pci_range(&parser, &range) {
977 		if (!i) {
978 			unittest(range.size == 0x10000000,
979 				 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
980 				 np, range.size);
981 			unittest(range.cpu_addr == 0x20000000,
982 				 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
983 				 range.cpu_addr, np);
984 			unittest(range.pci_addr == 0x80000000,
985 				 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
986 				 range.pci_addr, np);
987 		} else {
988 			unittest(range.size == 0x10000000,
989 				 "for_each_of_pci_range wrong size on node %pOF size=%llx\n",
990 				 np, range.size);
991 			unittest(range.cpu_addr == 0x40000000,
992 				 "for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
993 				 range.cpu_addr, np);
994 			unittest(range.pci_addr == 0xc0000000,
995 				 "for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
996 				 range.pci_addr, np);
997 		}
998 		i++;
999 	}
1000 
1001 	of_node_put(np);
1002 }
1003 
1004 static void __init of_unittest_parse_interrupts(void)
1005 {
1006 	struct device_node *np;
1007 	struct of_phandle_args args;
1008 	int i, rc;
1009 
1010 	if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1011 		return;
1012 
1013 	np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
1014 	if (!np) {
1015 		pr_err("missing testcase data\n");
1016 		return;
1017 	}
1018 
1019 	for (i = 0; i < 4; i++) {
1020 		bool passed = true;
1021 
1022 		memset(&args, 0, sizeof(args));
1023 		rc = of_irq_parse_one(np, i, &args);
1024 
1025 		passed &= !rc;
1026 		passed &= (args.args_count == 1);
1027 		passed &= (args.args[0] == (i + 1));
1028 
1029 		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1030 			 i, args.np, rc);
1031 	}
1032 	of_node_put(np);
1033 
1034 	np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
1035 	if (!np) {
1036 		pr_err("missing testcase data\n");
1037 		return;
1038 	}
1039 
1040 	for (i = 0; i < 4; i++) {
1041 		bool passed = true;
1042 
1043 		memset(&args, 0, sizeof(args));
1044 		rc = of_irq_parse_one(np, i, &args);
1045 
1046 		/* Test the values from tests-phandle.dtsi */
1047 		switch (i) {
1048 		case 0:
1049 			passed &= !rc;
1050 			passed &= (args.args_count == 1);
1051 			passed &= (args.args[0] == 9);
1052 			break;
1053 		case 1:
1054 			passed &= !rc;
1055 			passed &= (args.args_count == 3);
1056 			passed &= (args.args[0] == 10);
1057 			passed &= (args.args[1] == 11);
1058 			passed &= (args.args[2] == 12);
1059 			break;
1060 		case 2:
1061 			passed &= !rc;
1062 			passed &= (args.args_count == 2);
1063 			passed &= (args.args[0] == 13);
1064 			passed &= (args.args[1] == 14);
1065 			break;
1066 		case 3:
1067 			passed &= !rc;
1068 			passed &= (args.args_count == 2);
1069 			passed &= (args.args[0] == 15);
1070 			passed &= (args.args[1] == 16);
1071 			break;
1072 		default:
1073 			passed = false;
1074 		}
1075 		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1076 			 i, args.np, rc);
1077 	}
1078 	of_node_put(np);
1079 }
1080 
1081 static void __init of_unittest_parse_interrupts_extended(void)
1082 {
1083 	struct device_node *np;
1084 	struct of_phandle_args args;
1085 	int i, rc;
1086 
1087 	if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1088 		return;
1089 
1090 	np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
1091 	if (!np) {
1092 		pr_err("missing testcase data\n");
1093 		return;
1094 	}
1095 
1096 	for (i = 0; i < 7; i++) {
1097 		bool passed = true;
1098 
1099 		memset(&args, 0, sizeof(args));
1100 		rc = of_irq_parse_one(np, i, &args);
1101 
1102 		/* Test the values from tests-phandle.dtsi */
1103 		switch (i) {
1104 		case 0:
1105 			passed &= !rc;
1106 			passed &= (args.args_count == 1);
1107 			passed &= (args.args[0] == 1);
1108 			break;
1109 		case 1:
1110 			passed &= !rc;
1111 			passed &= (args.args_count == 3);
1112 			passed &= (args.args[0] == 2);
1113 			passed &= (args.args[1] == 3);
1114 			passed &= (args.args[2] == 4);
1115 			break;
1116 		case 2:
1117 			passed &= !rc;
1118 			passed &= (args.args_count == 2);
1119 			passed &= (args.args[0] == 5);
1120 			passed &= (args.args[1] == 6);
1121 			break;
1122 		case 3:
1123 			passed &= !rc;
1124 			passed &= (args.args_count == 1);
1125 			passed &= (args.args[0] == 9);
1126 			break;
1127 		case 4:
1128 			passed &= !rc;
1129 			passed &= (args.args_count == 3);
1130 			passed &= (args.args[0] == 10);
1131 			passed &= (args.args[1] == 11);
1132 			passed &= (args.args[2] == 12);
1133 			break;
1134 		case 5:
1135 			passed &= !rc;
1136 			passed &= (args.args_count == 2);
1137 			passed &= (args.args[0] == 13);
1138 			passed &= (args.args[1] == 14);
1139 			break;
1140 		case 6:
1141 			/*
1142 			 * Tests child node that is missing property
1143 			 * #address-cells.  See the comments in
1144 			 * drivers/of/unittest-data/tests-interrupts.dtsi
1145 			 * nodes intmap1 and interrupts-extended0
1146 			 */
1147 			passed &= !rc;
1148 			passed &= (args.args_count == 1);
1149 			passed &= (args.args[0] == 15);
1150 			break;
1151 		default:
1152 			passed = false;
1153 		}
1154 
1155 		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1156 			 i, args.np, rc);
1157 	}
1158 	of_node_put(np);
1159 }
1160 
1161 static const struct of_device_id match_node_table[] = {
1162 	{ .data = "A", .name = "name0", }, /* Name alone is lowest priority */
1163 	{ .data = "B", .type = "type1", }, /* followed by type alone */
1164 
1165 	{ .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
1166 	{ .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
1167 	{ .data = "Cc", .name = "name2", .type = "type2", },
1168 
1169 	{ .data = "E", .compatible = "compat3" },
1170 	{ .data = "G", .compatible = "compat2", },
1171 	{ .data = "H", .compatible = "compat2", .name = "name5", },
1172 	{ .data = "I", .compatible = "compat2", .type = "type1", },
1173 	{ .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
1174 	{ .data = "K", .compatible = "compat2", .name = "name9", },
1175 	{}
1176 };
1177 
1178 static struct {
1179 	const char *path;
1180 	const char *data;
1181 } match_node_tests[] = {
1182 	{ .path = "/testcase-data/match-node/name0", .data = "A", },
1183 	{ .path = "/testcase-data/match-node/name1", .data = "B", },
1184 	{ .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
1185 	{ .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
1186 	{ .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
1187 	{ .path = "/testcase-data/match-node/name3", .data = "E", },
1188 	{ .path = "/testcase-data/match-node/name4", .data = "G", },
1189 	{ .path = "/testcase-data/match-node/name5", .data = "H", },
1190 	{ .path = "/testcase-data/match-node/name6", .data = "G", },
1191 	{ .path = "/testcase-data/match-node/name7", .data = "I", },
1192 	{ .path = "/testcase-data/match-node/name8", .data = "J", },
1193 	{ .path = "/testcase-data/match-node/name9", .data = "K", },
1194 };
1195 
1196 static void __init of_unittest_match_node(void)
1197 {
1198 	struct device_node *np;
1199 	const struct of_device_id *match;
1200 	int i;
1201 
1202 	for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
1203 		np = of_find_node_by_path(match_node_tests[i].path);
1204 		if (!np) {
1205 			unittest(0, "missing testcase node %s\n",
1206 				match_node_tests[i].path);
1207 			continue;
1208 		}
1209 
1210 		match = of_match_node(match_node_table, np);
1211 		if (!match) {
1212 			unittest(0, "%s didn't match anything\n",
1213 				match_node_tests[i].path);
1214 			continue;
1215 		}
1216 
1217 		if (strcmp(match->data, match_node_tests[i].data) != 0) {
1218 			unittest(0, "%s got wrong match. expected %s, got %s\n",
1219 				match_node_tests[i].path, match_node_tests[i].data,
1220 				(const char *)match->data);
1221 			continue;
1222 		}
1223 		unittest(1, "passed");
1224 	}
1225 }
1226 
1227 static struct resource test_bus_res = DEFINE_RES_MEM(0xfffffff8, 2);
1228 static const struct platform_device_info test_bus_info = {
1229 	.name = "unittest-bus",
1230 };
1231 static void __init of_unittest_platform_populate(void)
1232 {
1233 	int irq, rc;
1234 	struct device_node *np, *child, *grandchild;
1235 	struct platform_device *pdev, *test_bus;
1236 	const struct of_device_id match[] = {
1237 		{ .compatible = "test-device", },
1238 		{}
1239 	};
1240 
1241 	np = of_find_node_by_path("/testcase-data");
1242 	of_platform_default_populate(np, NULL, NULL);
1243 
1244 	/* Test that a missing irq domain returns -EPROBE_DEFER */
1245 	np = of_find_node_by_path("/testcase-data/testcase-device1");
1246 	pdev = of_find_device_by_node(np);
1247 	unittest(pdev, "device 1 creation failed\n");
1248 
1249 	if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1250 		irq = platform_get_irq(pdev, 0);
1251 		unittest(irq == -EPROBE_DEFER,
1252 			 "device deferred probe failed - %d\n", irq);
1253 
1254 		/* Test that a parsing failure does not return -EPROBE_DEFER */
1255 		np = of_find_node_by_path("/testcase-data/testcase-device2");
1256 		pdev = of_find_device_by_node(np);
1257 		unittest(pdev, "device 2 creation failed\n");
1258 
1259 		EXPECT_BEGIN(KERN_INFO,
1260 			     "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1261 
1262 		irq = platform_get_irq(pdev, 0);
1263 
1264 		EXPECT_END(KERN_INFO,
1265 			   "platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1266 
1267 		unittest(irq < 0 && irq != -EPROBE_DEFER,
1268 			 "device parsing error failed - %d\n", irq);
1269 	}
1270 
1271 	np = of_find_node_by_path("/testcase-data/platform-tests");
1272 	unittest(np, "No testcase data in device tree\n");
1273 	if (!np)
1274 		return;
1275 
1276 	test_bus = platform_device_register_full(&test_bus_info);
1277 	rc = PTR_ERR_OR_ZERO(test_bus);
1278 	unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1279 	if (rc) {
1280 		of_node_put(np);
1281 		return;
1282 	}
1283 	test_bus->dev.of_node = np;
1284 
1285 	/*
1286 	 * Add a dummy resource to the test bus node after it is
1287 	 * registered to catch problems with un-inserted resources. The
1288 	 * DT code doesn't insert the resources, and it has caused the
1289 	 * kernel to oops in the past. This makes sure the same bug
1290 	 * doesn't crop up again.
1291 	 */
1292 	platform_device_add_resources(test_bus, &test_bus_res, 1);
1293 
1294 	of_platform_populate(np, match, NULL, &test_bus->dev);
1295 	for_each_child_of_node(np, child) {
1296 		for_each_child_of_node(child, grandchild) {
1297 			pdev = of_find_device_by_node(grandchild);
1298 			unittest(pdev,
1299 				 "Could not create device for node '%pOFn'\n",
1300 				 grandchild);
1301 			platform_device_put(pdev);
1302 		}
1303 	}
1304 
1305 	of_platform_depopulate(&test_bus->dev);
1306 	for_each_child_of_node(np, child) {
1307 		for_each_child_of_node(child, grandchild)
1308 			unittest(!of_find_device_by_node(grandchild),
1309 				 "device didn't get destroyed '%pOFn'\n",
1310 				 grandchild);
1311 	}
1312 
1313 	platform_device_unregister(test_bus);
1314 	of_node_put(np);
1315 }
1316 
1317 /**
1318  *	update_node_properties - adds the properties
1319  *	of np into dup node (present in live tree) and
1320  *	updates parent of children of np to dup.
1321  *
1322  *	@np:	node whose properties are being added to the live tree
1323  *	@dup:	node present in live tree to be updated
1324  */
1325 static void update_node_properties(struct device_node *np,
1326 					struct device_node *dup)
1327 {
1328 	struct property *prop;
1329 	struct property *save_next;
1330 	struct device_node *child;
1331 	int ret;
1332 
1333 	for_each_child_of_node(np, child)
1334 		child->parent = dup;
1335 
1336 	/*
1337 	 * "unittest internal error: unable to add testdata property"
1338 	 *
1339 	 *    If this message reports a property in node '/__symbols__' then
1340 	 *    the respective unittest overlay contains a label that has the
1341 	 *    same name as a label in the live devicetree.  The label will
1342 	 *    be in the live devicetree only if the devicetree source was
1343 	 *    compiled with the '-@' option.  If you encounter this error,
1344 	 *    please consider renaming __all__ of the labels in the unittest
1345 	 *    overlay dts files with an odd prefix that is unlikely to be
1346 	 *    used in a real devicetree.
1347 	 */
1348 
1349 	/*
1350 	 * open code for_each_property_of_node() because of_add_property()
1351 	 * sets prop->next to NULL
1352 	 */
1353 	for (prop = np->properties; prop != NULL; prop = save_next) {
1354 		save_next = prop->next;
1355 		ret = of_add_property(dup, prop);
1356 		if (ret) {
1357 			if (ret == -EEXIST && !strcmp(prop->name, "name"))
1358 				continue;
1359 			pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1360 			       np, prop->name);
1361 		}
1362 	}
1363 }
1364 
1365 /**
1366  *	attach_node_and_children - attaches nodes
1367  *	and its children to live tree.
1368  *	CAUTION: misleading function name - if node @np already exists in
1369  *	the live tree then children of @np are *not* attached to the live
1370  *	tree.  This works for the current test devicetree nodes because such
1371  *	nodes do not have child nodes.
1372  *
1373  *	@np:	Node to attach to live tree
1374  */
1375 static void attach_node_and_children(struct device_node *np)
1376 {
1377 	struct device_node *next, *dup, *child;
1378 	unsigned long flags;
1379 	const char *full_name;
1380 
1381 	full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1382 
1383 	if (!strcmp(full_name, "/__local_fixups__") ||
1384 	    !strcmp(full_name, "/__fixups__")) {
1385 		kfree(full_name);
1386 		return;
1387 	}
1388 
1389 	dup = of_find_node_by_path(full_name);
1390 	kfree(full_name);
1391 	if (dup) {
1392 		update_node_properties(np, dup);
1393 		return;
1394 	}
1395 
1396 	child = np->child;
1397 	np->child = NULL;
1398 
1399 	mutex_lock(&of_mutex);
1400 	raw_spin_lock_irqsave(&devtree_lock, flags);
1401 	np->sibling = np->parent->child;
1402 	np->parent->child = np;
1403 	of_node_clear_flag(np, OF_DETACHED);
1404 	raw_spin_unlock_irqrestore(&devtree_lock, flags);
1405 
1406 	__of_attach_node_sysfs(np);
1407 	mutex_unlock(&of_mutex);
1408 
1409 	while (child) {
1410 		next = child->sibling;
1411 		attach_node_and_children(child);
1412 		child = next;
1413 	}
1414 }
1415 
1416 /**
1417  *	unittest_data_add - Reads, copies data from
1418  *	linked tree and attaches it to the live tree
1419  */
1420 static int __init unittest_data_add(void)
1421 {
1422 	void *unittest_data;
1423 	void *unittest_data_align;
1424 	struct device_node *unittest_data_node = NULL, *np;
1425 	/*
1426 	 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1427 	 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1428 	 */
1429 	extern uint8_t __dtb_testcases_begin[];
1430 	extern uint8_t __dtb_testcases_end[];
1431 	const int size = __dtb_testcases_end - __dtb_testcases_begin;
1432 	int rc;
1433 	void *ret;
1434 
1435 	if (!size) {
1436 		pr_warn("%s: testcases is empty\n", __func__);
1437 		return -ENODATA;
1438 	}
1439 
1440 	/* creating copy */
1441 	unittest_data = kmalloc(size + FDT_ALIGN_SIZE, GFP_KERNEL);
1442 	if (!unittest_data)
1443 		return -ENOMEM;
1444 
1445 	unittest_data_align = PTR_ALIGN(unittest_data, FDT_ALIGN_SIZE);
1446 	memcpy(unittest_data_align, __dtb_testcases_begin, size);
1447 
1448 	ret = of_fdt_unflatten_tree(unittest_data_align, NULL, &unittest_data_node);
1449 	if (!ret) {
1450 		pr_warn("%s: unflatten testcases tree failed\n", __func__);
1451 		kfree(unittest_data);
1452 		return -ENODATA;
1453 	}
1454 	if (!unittest_data_node) {
1455 		pr_warn("%s: testcases tree is empty\n", __func__);
1456 		kfree(unittest_data);
1457 		return -ENODATA;
1458 	}
1459 
1460 	/*
1461 	 * This lock normally encloses of_resolve_phandles()
1462 	 */
1463 	of_overlay_mutex_lock();
1464 
1465 	rc = of_resolve_phandles(unittest_data_node);
1466 	if (rc) {
1467 		pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1468 		of_overlay_mutex_unlock();
1469 		return -EINVAL;
1470 	}
1471 
1472 	if (!of_root) {
1473 		of_root = unittest_data_node;
1474 		for_each_of_allnodes(np)
1475 			__of_attach_node_sysfs(np);
1476 		of_aliases = of_find_node_by_path("/aliases");
1477 		of_chosen = of_find_node_by_path("/chosen");
1478 		of_overlay_mutex_unlock();
1479 		return 0;
1480 	}
1481 
1482 	EXPECT_BEGIN(KERN_INFO,
1483 		     "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1484 
1485 	/* attach the sub-tree to live tree */
1486 	np = unittest_data_node->child;
1487 	while (np) {
1488 		struct device_node *next = np->sibling;
1489 
1490 		np->parent = of_root;
1491 		attach_node_and_children(np);
1492 		np = next;
1493 	}
1494 
1495 	EXPECT_END(KERN_INFO,
1496 		   "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
1497 
1498 	of_overlay_mutex_unlock();
1499 
1500 	return 0;
1501 }
1502 
1503 #ifdef CONFIG_OF_OVERLAY
1504 static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id);
1505 
1506 static int unittest_probe(struct platform_device *pdev)
1507 {
1508 	struct device *dev = &pdev->dev;
1509 	struct device_node *np = dev->of_node;
1510 
1511 	if (np == NULL) {
1512 		dev_err(dev, "No OF data for device\n");
1513 		return -EINVAL;
1514 
1515 	}
1516 
1517 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1518 
1519 	of_platform_populate(np, NULL, NULL, &pdev->dev);
1520 
1521 	return 0;
1522 }
1523 
1524 static int unittest_remove(struct platform_device *pdev)
1525 {
1526 	struct device *dev = &pdev->dev;
1527 	struct device_node *np = dev->of_node;
1528 
1529 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1530 	return 0;
1531 }
1532 
1533 static const struct of_device_id unittest_match[] = {
1534 	{ .compatible = "unittest", },
1535 	{},
1536 };
1537 
1538 static struct platform_driver unittest_driver = {
1539 	.probe			= unittest_probe,
1540 	.remove			= unittest_remove,
1541 	.driver = {
1542 		.name		= "unittest",
1543 		.of_match_table	= of_match_ptr(unittest_match),
1544 	},
1545 };
1546 
1547 /* get the platform device instantiated at the path */
1548 static struct platform_device *of_path_to_platform_device(const char *path)
1549 {
1550 	struct device_node *np;
1551 	struct platform_device *pdev;
1552 
1553 	np = of_find_node_by_path(path);
1554 	if (np == NULL)
1555 		return NULL;
1556 
1557 	pdev = of_find_device_by_node(np);
1558 	of_node_put(np);
1559 
1560 	return pdev;
1561 }
1562 
1563 /* find out if a platform device exists at that path */
1564 static int of_path_platform_device_exists(const char *path)
1565 {
1566 	struct platform_device *pdev;
1567 
1568 	pdev = of_path_to_platform_device(path);
1569 	platform_device_put(pdev);
1570 	return pdev != NULL;
1571 }
1572 
1573 #ifdef CONFIG_OF_GPIO
1574 
1575 struct unittest_gpio_dev {
1576 	struct gpio_chip chip;
1577 };
1578 
1579 static int unittest_gpio_chip_request_count;
1580 static int unittest_gpio_probe_count;
1581 static int unittest_gpio_probe_pass_count;
1582 
1583 static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
1584 {
1585 	unittest_gpio_chip_request_count++;
1586 
1587 	pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
1588 		 unittest_gpio_chip_request_count);
1589 	return 0;
1590 }
1591 
1592 static int unittest_gpio_probe(struct platform_device *pdev)
1593 {
1594 	struct unittest_gpio_dev *devptr;
1595 	int ret;
1596 
1597 	unittest_gpio_probe_count++;
1598 
1599 	devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
1600 	if (!devptr)
1601 		return -ENOMEM;
1602 
1603 	platform_set_drvdata(pdev, devptr);
1604 
1605 	devptr->chip.fwnode = dev_fwnode(&pdev->dev);
1606 	devptr->chip.label = "of-unittest-gpio";
1607 	devptr->chip.base = -1; /* dynamic allocation */
1608 	devptr->chip.ngpio = 5;
1609 	devptr->chip.request = unittest_gpio_chip_request;
1610 
1611 	ret = gpiochip_add_data(&devptr->chip, NULL);
1612 
1613 	unittest(!ret,
1614 		 "gpiochip_add_data() for node @%pfw failed, ret = %d\n", devptr->chip.fwnode, ret);
1615 
1616 	if (!ret)
1617 		unittest_gpio_probe_pass_count++;
1618 	return ret;
1619 }
1620 
1621 static int unittest_gpio_remove(struct platform_device *pdev)
1622 {
1623 	struct unittest_gpio_dev *devptr = platform_get_drvdata(pdev);
1624 	struct device *dev = &pdev->dev;
1625 
1626 	dev_dbg(dev, "%s for node @%pfw\n", __func__, devptr->chip.fwnode);
1627 
1628 	if (!devptr)
1629 		return -EINVAL;
1630 
1631 	if (devptr->chip.base != -1)
1632 		gpiochip_remove(&devptr->chip);
1633 
1634 	platform_set_drvdata(pdev, NULL);
1635 	kfree(devptr);
1636 
1637 	return 0;
1638 }
1639 
1640 static const struct of_device_id unittest_gpio_id[] = {
1641 	{ .compatible = "unittest-gpio", },
1642 	{}
1643 };
1644 
1645 static struct platform_driver unittest_gpio_driver = {
1646 	.probe	= unittest_gpio_probe,
1647 	.remove	= unittest_gpio_remove,
1648 	.driver	= {
1649 		.name		= "unittest-gpio",
1650 		.of_match_table	= of_match_ptr(unittest_gpio_id),
1651 	},
1652 };
1653 
1654 static void __init of_unittest_overlay_gpio(void)
1655 {
1656 	int chip_request_count;
1657 	int probe_pass_count;
1658 	int ret;
1659 
1660 	/*
1661 	 * tests: apply overlays before registering driver
1662 	 * Similar to installing a driver as a module, the
1663 	 * driver is registered after applying the overlays.
1664 	 *
1665 	 * The overlays are applied by overlay_data_apply()
1666 	 * instead of of_unittest_apply_overlay() so that they
1667 	 * will not be tracked.  Thus they will not be removed
1668 	 * by of_unittest_remove_tracked_overlays().
1669 	 *
1670 	 * - apply overlay_gpio_01
1671 	 * - apply overlay_gpio_02a
1672 	 * - apply overlay_gpio_02b
1673 	 * - register driver
1674 	 *
1675 	 * register driver will result in
1676 	 *   - probe and processing gpio hog for overlay_gpio_01
1677 	 *   - probe for overlay_gpio_02a
1678 	 *   - processing gpio for overlay_gpio_02b
1679 	 */
1680 
1681 	probe_pass_count = unittest_gpio_probe_pass_count;
1682 	chip_request_count = unittest_gpio_chip_request_count;
1683 
1684 	/*
1685 	 * overlay_gpio_01 contains gpio node and child gpio hog node
1686 	 * overlay_gpio_02a contains gpio node
1687 	 * overlay_gpio_02b contains child gpio hog node
1688 	 */
1689 
1690 	unittest(overlay_data_apply("overlay_gpio_01", NULL),
1691 		 "Adding overlay 'overlay_gpio_01' failed\n");
1692 
1693 	unittest(overlay_data_apply("overlay_gpio_02a", NULL),
1694 		 "Adding overlay 'overlay_gpio_02a' failed\n");
1695 
1696 	unittest(overlay_data_apply("overlay_gpio_02b", NULL),
1697 		 "Adding overlay 'overlay_gpio_02b' failed\n");
1698 
1699 	/*
1700 	 * messages are the result of the probes, after the
1701 	 * driver is registered
1702 	 */
1703 
1704 	EXPECT_BEGIN(KERN_INFO,
1705 		     "gpio-<<int>> (line-B-input): hogged as input\n");
1706 
1707 	EXPECT_BEGIN(KERN_INFO,
1708 		     "gpio-<<int>> (line-A-input): hogged as input\n");
1709 
1710 	ret = platform_driver_register(&unittest_gpio_driver);
1711 	if (unittest(ret == 0, "could not register unittest gpio driver\n"))
1712 		return;
1713 
1714 	EXPECT_END(KERN_INFO,
1715 		   "gpio-<<int>> (line-A-input): hogged as input\n");
1716 	EXPECT_END(KERN_INFO,
1717 		   "gpio-<<int>> (line-B-input): hogged as input\n");
1718 
1719 	unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
1720 		 "unittest_gpio_probe() failed or not called\n");
1721 
1722 	unittest(chip_request_count + 2 == unittest_gpio_chip_request_count,
1723 		 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1724 		 unittest_gpio_chip_request_count - chip_request_count);
1725 
1726 	/*
1727 	 * tests: apply overlays after registering driver
1728 	 *
1729 	 * Similar to a driver built-in to the kernel, the
1730 	 * driver is registered before applying the overlays.
1731 	 *
1732 	 * overlay_gpio_03 contains gpio node and child gpio hog node
1733 	 *
1734 	 * - apply overlay_gpio_03
1735 	 *
1736 	 * apply overlay will result in
1737 	 *   - probe and processing gpio hog.
1738 	 */
1739 
1740 	probe_pass_count = unittest_gpio_probe_pass_count;
1741 	chip_request_count = unittest_gpio_chip_request_count;
1742 
1743 	EXPECT_BEGIN(KERN_INFO,
1744 		     "gpio-<<int>> (line-D-input): hogged as input\n");
1745 
1746 	/* overlay_gpio_03 contains gpio node and child gpio hog node */
1747 
1748 	unittest(overlay_data_apply("overlay_gpio_03", NULL),
1749 		 "Adding overlay 'overlay_gpio_03' failed\n");
1750 
1751 	EXPECT_END(KERN_INFO,
1752 		   "gpio-<<int>> (line-D-input): hogged as input\n");
1753 
1754 	unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1755 		 "unittest_gpio_probe() failed or not called\n");
1756 
1757 	unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1758 		 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1759 		 unittest_gpio_chip_request_count - chip_request_count);
1760 
1761 	/*
1762 	 * overlay_gpio_04a contains gpio node
1763 	 *
1764 	 * - apply overlay_gpio_04a
1765 	 *
1766 	 * apply the overlay will result in
1767 	 *   - probe for overlay_gpio_04a
1768 	 */
1769 
1770 	probe_pass_count = unittest_gpio_probe_pass_count;
1771 	chip_request_count = unittest_gpio_chip_request_count;
1772 
1773 	/* overlay_gpio_04a contains gpio node */
1774 
1775 	unittest(overlay_data_apply("overlay_gpio_04a", NULL),
1776 		 "Adding overlay 'overlay_gpio_04a' failed\n");
1777 
1778 	unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
1779 		 "unittest_gpio_probe() failed or not called\n");
1780 
1781 	/*
1782 	 * overlay_gpio_04b contains child gpio hog node
1783 	 *
1784 	 * - apply overlay_gpio_04b
1785 	 *
1786 	 * apply the overlay will result in
1787 	 *   - processing gpio for overlay_gpio_04b
1788 	 */
1789 
1790 	EXPECT_BEGIN(KERN_INFO,
1791 		     "gpio-<<int>> (line-C-input): hogged as input\n");
1792 
1793 	/* overlay_gpio_04b contains child gpio hog node */
1794 
1795 	unittest(overlay_data_apply("overlay_gpio_04b", NULL),
1796 		 "Adding overlay 'overlay_gpio_04b' failed\n");
1797 
1798 	EXPECT_END(KERN_INFO,
1799 		   "gpio-<<int>> (line-C-input): hogged as input\n");
1800 
1801 	unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
1802 		 "unittest_gpio_chip_request() called %d times (expected 1 time)\n",
1803 		 unittest_gpio_chip_request_count - chip_request_count);
1804 }
1805 
1806 #else
1807 
1808 static void __init of_unittest_overlay_gpio(void)
1809 {
1810 	/* skip tests */
1811 }
1812 
1813 #endif
1814 
1815 #if IS_BUILTIN(CONFIG_I2C)
1816 
1817 /* get the i2c client device instantiated at the path */
1818 static struct i2c_client *of_path_to_i2c_client(const char *path)
1819 {
1820 	struct device_node *np;
1821 	struct i2c_client *client;
1822 
1823 	np = of_find_node_by_path(path);
1824 	if (np == NULL)
1825 		return NULL;
1826 
1827 	client = of_find_i2c_device_by_node(np);
1828 	of_node_put(np);
1829 
1830 	return client;
1831 }
1832 
1833 /* find out if a i2c client device exists at that path */
1834 static int of_path_i2c_client_exists(const char *path)
1835 {
1836 	struct i2c_client *client;
1837 
1838 	client = of_path_to_i2c_client(path);
1839 	if (client)
1840 		put_device(&client->dev);
1841 	return client != NULL;
1842 }
1843 #else
1844 static int of_path_i2c_client_exists(const char *path)
1845 {
1846 	return 0;
1847 }
1848 #endif
1849 
1850 enum overlay_type {
1851 	PDEV_OVERLAY,
1852 	I2C_OVERLAY
1853 };
1854 
1855 static int of_path_device_type_exists(const char *path,
1856 		enum overlay_type ovtype)
1857 {
1858 	switch (ovtype) {
1859 	case PDEV_OVERLAY:
1860 		return of_path_platform_device_exists(path);
1861 	case I2C_OVERLAY:
1862 		return of_path_i2c_client_exists(path);
1863 	}
1864 	return 0;
1865 }
1866 
1867 static const char *unittest_path(int nr, enum overlay_type ovtype)
1868 {
1869 	const char *base;
1870 	static char buf[256];
1871 
1872 	switch (ovtype) {
1873 	case PDEV_OVERLAY:
1874 		base = "/testcase-data/overlay-node/test-bus";
1875 		break;
1876 	case I2C_OVERLAY:
1877 		base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1878 		break;
1879 	default:
1880 		buf[0] = '\0';
1881 		return buf;
1882 	}
1883 	snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1884 	buf[sizeof(buf) - 1] = '\0';
1885 	return buf;
1886 }
1887 
1888 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1889 {
1890 	const char *path;
1891 
1892 	path = unittest_path(unittest_nr, ovtype);
1893 
1894 	switch (ovtype) {
1895 	case PDEV_OVERLAY:
1896 		return of_path_platform_device_exists(path);
1897 	case I2C_OVERLAY:
1898 		return of_path_i2c_client_exists(path);
1899 	}
1900 	return 0;
1901 }
1902 
1903 static const char *overlay_name_from_nr(int nr)
1904 {
1905 	static char buf[256];
1906 
1907 	snprintf(buf, sizeof(buf) - 1,
1908 		"overlay_%d", nr);
1909 	buf[sizeof(buf) - 1] = '\0';
1910 
1911 	return buf;
1912 }
1913 
1914 static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1915 
1916 #define MAX_TRACK_OVCS_IDS 256
1917 
1918 static int track_ovcs_id[MAX_TRACK_OVCS_IDS];
1919 static int track_ovcs_id_overlay_nr[MAX_TRACK_OVCS_IDS];
1920 static int track_ovcs_id_cnt;
1921 
1922 static void of_unittest_track_overlay(int ovcs_id, int overlay_nr)
1923 {
1924 	if (WARN_ON(track_ovcs_id_cnt >= MAX_TRACK_OVCS_IDS))
1925 		return;
1926 
1927 	track_ovcs_id[track_ovcs_id_cnt] = ovcs_id;
1928 	track_ovcs_id_overlay_nr[track_ovcs_id_cnt] = overlay_nr;
1929 	track_ovcs_id_cnt++;
1930 }
1931 
1932 static void of_unittest_untrack_overlay(int ovcs_id)
1933 {
1934 	if (WARN_ON(track_ovcs_id_cnt < 1))
1935 		return;
1936 
1937 	track_ovcs_id_cnt--;
1938 
1939 	/* If out of synch then test is broken.  Do not try to recover. */
1940 	WARN_ON(track_ovcs_id[track_ovcs_id_cnt] != ovcs_id);
1941 }
1942 
1943 static void of_unittest_remove_tracked_overlays(void)
1944 {
1945 	int ret, ovcs_id, overlay_nr, save_ovcs_id;
1946 	const char *overlay_name;
1947 
1948 	while (track_ovcs_id_cnt > 0) {
1949 
1950 		ovcs_id = track_ovcs_id[track_ovcs_id_cnt - 1];
1951 		overlay_nr = track_ovcs_id_overlay_nr[track_ovcs_id_cnt - 1];
1952 		save_ovcs_id = ovcs_id;
1953 		ret = of_overlay_remove(&ovcs_id);
1954 		if (ret == -ENODEV) {
1955 			overlay_name = overlay_name_from_nr(overlay_nr);
1956 			pr_warn("%s: of_overlay_remove() for overlay \"%s\" failed, ret = %d\n",
1957 				__func__, overlay_name, ret);
1958 		}
1959 		of_unittest_untrack_overlay(save_ovcs_id);
1960 	}
1961 
1962 }
1963 
1964 static int __init of_unittest_apply_overlay(int overlay_nr, int *ovcs_id)
1965 {
1966 	/*
1967 	 * The overlay will be tracked, thus it will be removed
1968 	 * by of_unittest_remove_tracked_overlays().
1969 	 */
1970 
1971 	const char *overlay_name;
1972 
1973 	overlay_name = overlay_name_from_nr(overlay_nr);
1974 
1975 	if (!overlay_data_apply(overlay_name, ovcs_id)) {
1976 		unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
1977 		return -EFAULT;
1978 	}
1979 	of_unittest_track_overlay(*ovcs_id, overlay_nr);
1980 
1981 	return 0;
1982 }
1983 
1984 /* apply an overlay while checking before and after states */
1985 static int __init of_unittest_apply_overlay_check(int overlay_nr,
1986 		int unittest_nr, int before, int after,
1987 		enum overlay_type ovtype)
1988 {
1989 	int ret, ovcs_id;
1990 
1991 	/* unittest device must not be in before state */
1992 	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1993 		unittest(0, "%s with device @\"%s\" %s\n",
1994 				overlay_name_from_nr(overlay_nr),
1995 				unittest_path(unittest_nr, ovtype),
1996 				!before ? "enabled" : "disabled");
1997 		return -EINVAL;
1998 	}
1999 
2000 	ovcs_id = 0;
2001 	ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2002 	if (ret != 0) {
2003 		/* of_unittest_apply_overlay already called unittest() */
2004 		return ret;
2005 	}
2006 
2007 	/* unittest device must be to set to after state */
2008 	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2009 		unittest(0, "%s failed to create @\"%s\" %s\n",
2010 				overlay_name_from_nr(overlay_nr),
2011 				unittest_path(unittest_nr, ovtype),
2012 				!after ? "enabled" : "disabled");
2013 		return -EINVAL;
2014 	}
2015 
2016 	return 0;
2017 }
2018 
2019 /* apply an overlay and then revert it while checking before, after states */
2020 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
2021 		int unittest_nr, int before, int after,
2022 		enum overlay_type ovtype)
2023 {
2024 	int ret, ovcs_id, save_ovcs_id;
2025 
2026 	/* unittest device must be in before state */
2027 	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2028 		unittest(0, "%s with device @\"%s\" %s\n",
2029 				overlay_name_from_nr(overlay_nr),
2030 				unittest_path(unittest_nr, ovtype),
2031 				!before ? "enabled" : "disabled");
2032 		return -EINVAL;
2033 	}
2034 
2035 	/* apply the overlay */
2036 	ovcs_id = 0;
2037 	ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
2038 	if (ret != 0) {
2039 		/* of_unittest_apply_overlay already called unittest() */
2040 		return ret;
2041 	}
2042 
2043 	/* unittest device must be in after state */
2044 	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2045 		unittest(0, "%s failed to create @\"%s\" %s\n",
2046 				overlay_name_from_nr(overlay_nr),
2047 				unittest_path(unittest_nr, ovtype),
2048 				!after ? "enabled" : "disabled");
2049 		return -EINVAL;
2050 	}
2051 
2052 	save_ovcs_id = ovcs_id;
2053 	ret = of_overlay_remove(&ovcs_id);
2054 	if (ret != 0) {
2055 		unittest(0, "%s failed to be destroyed @\"%s\"\n",
2056 				overlay_name_from_nr(overlay_nr),
2057 				unittest_path(unittest_nr, ovtype));
2058 		return ret;
2059 	}
2060 	of_unittest_untrack_overlay(save_ovcs_id);
2061 
2062 	/* unittest device must be again in before state */
2063 	if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
2064 		unittest(0, "%s with device @\"%s\" %s\n",
2065 				overlay_name_from_nr(overlay_nr),
2066 				unittest_path(unittest_nr, ovtype),
2067 				!before ? "enabled" : "disabled");
2068 		return -EINVAL;
2069 	}
2070 
2071 	return 0;
2072 }
2073 
2074 /* test activation of device */
2075 static void __init of_unittest_overlay_0(void)
2076 {
2077 	int ret;
2078 
2079 	EXPECT_BEGIN(KERN_INFO,
2080 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2081 
2082 	/* device should enable */
2083 	ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
2084 
2085 	EXPECT_END(KERN_INFO,
2086 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2087 
2088 	if (ret)
2089 		return;
2090 
2091 	unittest(1, "overlay test %d passed\n", 0);
2092 }
2093 
2094 /* test deactivation of device */
2095 static void __init of_unittest_overlay_1(void)
2096 {
2097 	int ret;
2098 
2099 	EXPECT_BEGIN(KERN_INFO,
2100 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2101 
2102 	/* device should disable */
2103 	ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
2104 
2105 	EXPECT_END(KERN_INFO,
2106 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2107 
2108 	if (ret)
2109 		return;
2110 
2111 	unittest(1, "overlay test %d passed\n", 1);
2112 
2113 }
2114 
2115 /* test activation of device */
2116 static void __init of_unittest_overlay_2(void)
2117 {
2118 	int ret;
2119 
2120 	EXPECT_BEGIN(KERN_INFO,
2121 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2122 
2123 	/* device should enable */
2124 	ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
2125 
2126 	EXPECT_END(KERN_INFO,
2127 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2128 
2129 	if (ret)
2130 		return;
2131 	unittest(1, "overlay test %d passed\n", 2);
2132 }
2133 
2134 /* test deactivation of device */
2135 static void __init of_unittest_overlay_3(void)
2136 {
2137 	int ret;
2138 
2139 	EXPECT_BEGIN(KERN_INFO,
2140 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2141 
2142 	/* device should disable */
2143 	ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
2144 
2145 	EXPECT_END(KERN_INFO,
2146 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2147 
2148 	if (ret)
2149 		return;
2150 
2151 	unittest(1, "overlay test %d passed\n", 3);
2152 }
2153 
2154 /* test activation of a full device node */
2155 static void __init of_unittest_overlay_4(void)
2156 {
2157 	/* device should disable */
2158 	if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
2159 		return;
2160 
2161 	unittest(1, "overlay test %d passed\n", 4);
2162 }
2163 
2164 /* test overlay apply/revert sequence */
2165 static void __init of_unittest_overlay_5(void)
2166 {
2167 	int ret;
2168 
2169 	EXPECT_BEGIN(KERN_INFO,
2170 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2171 
2172 	/* device should disable */
2173 	ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
2174 
2175 	EXPECT_END(KERN_INFO,
2176 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2177 
2178 	if (ret)
2179 		return;
2180 
2181 	unittest(1, "overlay test %d passed\n", 5);
2182 }
2183 
2184 /* test overlay application in sequence */
2185 static void __init of_unittest_overlay_6(void)
2186 {
2187 	int i, save_ovcs_id[2], ovcs_id;
2188 	int overlay_nr = 6, unittest_nr = 6;
2189 	int before = 0, after = 1;
2190 	const char *overlay_name;
2191 
2192 	int ret;
2193 
2194 	/* unittest device must be in before state */
2195 	for (i = 0; i < 2; i++) {
2196 		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2197 				!= before) {
2198 			unittest(0, "%s with device @\"%s\" %s\n",
2199 					overlay_name_from_nr(overlay_nr + i),
2200 					unittest_path(unittest_nr + i,
2201 						PDEV_OVERLAY),
2202 					!before ? "enabled" : "disabled");
2203 			return;
2204 		}
2205 	}
2206 
2207 	/* apply the overlays */
2208 
2209 	EXPECT_BEGIN(KERN_INFO,
2210 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2211 
2212 	overlay_name = overlay_name_from_nr(overlay_nr + 0);
2213 
2214 	ret = overlay_data_apply(overlay_name, &ovcs_id);
2215 
2216 	if (!ret) {
2217 		unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2218 			return;
2219 	}
2220 	save_ovcs_id[0] = ovcs_id;
2221 	of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2222 
2223 	EXPECT_END(KERN_INFO,
2224 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2225 
2226 	EXPECT_BEGIN(KERN_INFO,
2227 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2228 
2229 	overlay_name = overlay_name_from_nr(overlay_nr + 1);
2230 
2231 	ret = overlay_data_apply(overlay_name, &ovcs_id);
2232 
2233 	if (!ret) {
2234 		unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2235 			return;
2236 	}
2237 	save_ovcs_id[1] = ovcs_id;
2238 	of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2239 
2240 	EXPECT_END(KERN_INFO,
2241 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2242 
2243 
2244 	for (i = 0; i < 2; i++) {
2245 		/* unittest device must be in after state */
2246 		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2247 				!= after) {
2248 			unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
2249 					overlay_name_from_nr(overlay_nr + i),
2250 					unittest_path(unittest_nr + i,
2251 						PDEV_OVERLAY),
2252 					!after ? "enabled" : "disabled");
2253 			return;
2254 		}
2255 	}
2256 
2257 	for (i = 1; i >= 0; i--) {
2258 		ovcs_id = save_ovcs_id[i];
2259 		if (of_overlay_remove(&ovcs_id)) {
2260 			unittest(0, "%s failed destroy @\"%s\"\n",
2261 					overlay_name_from_nr(overlay_nr + i),
2262 					unittest_path(unittest_nr + i,
2263 						PDEV_OVERLAY));
2264 			return;
2265 		}
2266 		of_unittest_untrack_overlay(save_ovcs_id[i]);
2267 	}
2268 
2269 	for (i = 0; i < 2; i++) {
2270 		/* unittest device must be again in before state */
2271 		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
2272 				!= before) {
2273 			unittest(0, "%s with device @\"%s\" %s\n",
2274 					overlay_name_from_nr(overlay_nr + i),
2275 					unittest_path(unittest_nr + i,
2276 						PDEV_OVERLAY),
2277 					!before ? "enabled" : "disabled");
2278 			return;
2279 		}
2280 	}
2281 
2282 	unittest(1, "overlay test %d passed\n", 6);
2283 
2284 }
2285 
2286 /* test overlay application in sequence */
2287 static void __init of_unittest_overlay_8(void)
2288 {
2289 	int i, save_ovcs_id[2], ovcs_id;
2290 	int overlay_nr = 8, unittest_nr = 8;
2291 	const char *overlay_name;
2292 	int ret;
2293 
2294 	/* we don't care about device state in this test */
2295 
2296 	EXPECT_BEGIN(KERN_INFO,
2297 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2298 
2299 	overlay_name = overlay_name_from_nr(overlay_nr + 0);
2300 
2301 	ret = overlay_data_apply(overlay_name, &ovcs_id);
2302 	if (!ret)
2303 		unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2304 
2305 	EXPECT_END(KERN_INFO,
2306 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2307 
2308 	if (!ret)
2309 		return;
2310 
2311 	save_ovcs_id[0] = ovcs_id;
2312 	of_unittest_track_overlay(ovcs_id, overlay_nr + 0);
2313 
2314 	overlay_name = overlay_name_from_nr(overlay_nr + 1);
2315 
2316 	EXPECT_BEGIN(KERN_INFO,
2317 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2318 
2319 	/* apply the overlays */
2320 	ret = overlay_data_apply(overlay_name, &ovcs_id);
2321 
2322 	EXPECT_END(KERN_INFO,
2323 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2324 
2325 	if (!ret) {
2326 		unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2327 		return;
2328 	}
2329 
2330 	save_ovcs_id[1] = ovcs_id;
2331 	of_unittest_track_overlay(ovcs_id, overlay_nr + 1);
2332 
2333 	/* now try to remove first overlay (it should fail) */
2334 	ovcs_id = save_ovcs_id[0];
2335 
2336 	EXPECT_BEGIN(KERN_INFO,
2337 		     "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2338 
2339 	EXPECT_BEGIN(KERN_INFO,
2340 		     "OF: overlay: overlay #6 is not topmost");
2341 
2342 	ret = of_overlay_remove(&ovcs_id);
2343 
2344 	EXPECT_END(KERN_INFO,
2345 		   "OF: overlay: overlay #6 is not topmost");
2346 
2347 	EXPECT_END(KERN_INFO,
2348 		   "OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2349 
2350 	if (!ret) {
2351 		/*
2352 		 * Should never get here.  If we do, expect a lot of
2353 		 * subsequent tracking and overlay removal related errors.
2354 		 */
2355 		unittest(0, "%s was destroyed @\"%s\"\n",
2356 				overlay_name_from_nr(overlay_nr + 0),
2357 				unittest_path(unittest_nr,
2358 					PDEV_OVERLAY));
2359 		return;
2360 	}
2361 
2362 	/* removing them in order should work */
2363 	for (i = 1; i >= 0; i--) {
2364 		ovcs_id = save_ovcs_id[i];
2365 		if (of_overlay_remove(&ovcs_id)) {
2366 			unittest(0, "%s not destroyed @\"%s\"\n",
2367 					overlay_name_from_nr(overlay_nr + i),
2368 					unittest_path(unittest_nr,
2369 						PDEV_OVERLAY));
2370 			return;
2371 		}
2372 		of_unittest_untrack_overlay(save_ovcs_id[i]);
2373 	}
2374 
2375 	unittest(1, "overlay test %d passed\n", 8);
2376 }
2377 
2378 /* test insertion of a bus with parent devices */
2379 static void __init of_unittest_overlay_10(void)
2380 {
2381 	int ret;
2382 	char *child_path;
2383 
2384 	/* device should disable */
2385 	ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
2386 
2387 	if (unittest(ret == 0,
2388 			"overlay test %d failed; overlay application\n", 10))
2389 		return;
2390 
2391 	child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
2392 			unittest_path(10, PDEV_OVERLAY));
2393 	if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
2394 		return;
2395 
2396 	ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
2397 	kfree(child_path);
2398 
2399 	unittest(ret, "overlay test %d failed; no child device\n", 10);
2400 }
2401 
2402 /* test insertion of a bus with parent devices (and revert) */
2403 static void __init of_unittest_overlay_11(void)
2404 {
2405 	int ret;
2406 
2407 	/* device should disable */
2408 	ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
2409 			PDEV_OVERLAY);
2410 
2411 	unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2412 }
2413 
2414 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2415 
2416 struct unittest_i2c_bus_data {
2417 	struct platform_device	*pdev;
2418 	struct i2c_adapter	adap;
2419 };
2420 
2421 static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2422 		struct i2c_msg *msgs, int num)
2423 {
2424 	struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2425 
2426 	(void)std;
2427 
2428 	return num;
2429 }
2430 
2431 static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2432 {
2433 	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2434 }
2435 
2436 static const struct i2c_algorithm unittest_i2c_algo = {
2437 	.master_xfer	= unittest_i2c_master_xfer,
2438 	.functionality	= unittest_i2c_functionality,
2439 };
2440 
2441 static int unittest_i2c_bus_probe(struct platform_device *pdev)
2442 {
2443 	struct device *dev = &pdev->dev;
2444 	struct device_node *np = dev->of_node;
2445 	struct unittest_i2c_bus_data *std;
2446 	struct i2c_adapter *adap;
2447 	int ret;
2448 
2449 	if (np == NULL) {
2450 		dev_err(dev, "No OF data for device\n");
2451 		return -EINVAL;
2452 
2453 	}
2454 
2455 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2456 
2457 	std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
2458 	if (!std)
2459 		return -ENOMEM;
2460 
2461 	/* link them together */
2462 	std->pdev = pdev;
2463 	platform_set_drvdata(pdev, std);
2464 
2465 	adap = &std->adap;
2466 	i2c_set_adapdata(adap, std);
2467 	adap->nr = -1;
2468 	strlcpy(adap->name, pdev->name, sizeof(adap->name));
2469 	adap->class = I2C_CLASS_DEPRECATED;
2470 	adap->algo = &unittest_i2c_algo;
2471 	adap->dev.parent = dev;
2472 	adap->dev.of_node = dev->of_node;
2473 	adap->timeout = 5 * HZ;
2474 	adap->retries = 3;
2475 
2476 	ret = i2c_add_numbered_adapter(adap);
2477 	if (ret != 0) {
2478 		dev_err(dev, "Failed to add I2C adapter\n");
2479 		return ret;
2480 	}
2481 
2482 	return 0;
2483 }
2484 
2485 static int unittest_i2c_bus_remove(struct platform_device *pdev)
2486 {
2487 	struct device *dev = &pdev->dev;
2488 	struct device_node *np = dev->of_node;
2489 	struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
2490 
2491 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2492 	i2c_del_adapter(&std->adap);
2493 
2494 	return 0;
2495 }
2496 
2497 static const struct of_device_id unittest_i2c_bus_match[] = {
2498 	{ .compatible = "unittest-i2c-bus", },
2499 	{},
2500 };
2501 
2502 static struct platform_driver unittest_i2c_bus_driver = {
2503 	.probe			= unittest_i2c_bus_probe,
2504 	.remove			= unittest_i2c_bus_remove,
2505 	.driver = {
2506 		.name		= "unittest-i2c-bus",
2507 		.of_match_table	= of_match_ptr(unittest_i2c_bus_match),
2508 	},
2509 };
2510 
2511 static int unittest_i2c_dev_probe(struct i2c_client *client,
2512 		const struct i2c_device_id *id)
2513 {
2514 	struct device *dev = &client->dev;
2515 	struct device_node *np = client->dev.of_node;
2516 
2517 	if (!np) {
2518 		dev_err(dev, "No OF node\n");
2519 		return -EINVAL;
2520 	}
2521 
2522 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2523 
2524 	return 0;
2525 };
2526 
2527 static int unittest_i2c_dev_remove(struct i2c_client *client)
2528 {
2529 	struct device *dev = &client->dev;
2530 	struct device_node *np = client->dev.of_node;
2531 
2532 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2533 	return 0;
2534 }
2535 
2536 static const struct i2c_device_id unittest_i2c_dev_id[] = {
2537 	{ .name = "unittest-i2c-dev" },
2538 	{ }
2539 };
2540 
2541 static struct i2c_driver unittest_i2c_dev_driver = {
2542 	.driver = {
2543 		.name = "unittest-i2c-dev",
2544 	},
2545 	.probe = unittest_i2c_dev_probe,
2546 	.remove = unittest_i2c_dev_remove,
2547 	.id_table = unittest_i2c_dev_id,
2548 };
2549 
2550 #if IS_BUILTIN(CONFIG_I2C_MUX)
2551 
2552 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
2553 {
2554 	return 0;
2555 }
2556 
2557 static int unittest_i2c_mux_probe(struct i2c_client *client,
2558 		const struct i2c_device_id *id)
2559 {
2560 	int i, nchans;
2561 	struct device *dev = &client->dev;
2562 	struct i2c_adapter *adap = client->adapter;
2563 	struct device_node *np = client->dev.of_node, *child;
2564 	struct i2c_mux_core *muxc;
2565 	u32 reg, max_reg;
2566 
2567 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2568 
2569 	if (!np) {
2570 		dev_err(dev, "No OF node\n");
2571 		return -EINVAL;
2572 	}
2573 
2574 	max_reg = (u32)-1;
2575 	for_each_child_of_node(np, child) {
2576 		if (of_property_read_u32(child, "reg", &reg))
2577 			continue;
2578 		if (max_reg == (u32)-1 || reg > max_reg)
2579 			max_reg = reg;
2580 	}
2581 	nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
2582 	if (nchans == 0) {
2583 		dev_err(dev, "No channels\n");
2584 		return -EINVAL;
2585 	}
2586 
2587 	muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
2588 			     unittest_i2c_mux_select_chan, NULL);
2589 	if (!muxc)
2590 		return -ENOMEM;
2591 	for (i = 0; i < nchans; i++) {
2592 		if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
2593 			dev_err(dev, "Failed to register mux #%d\n", i);
2594 			i2c_mux_del_adapters(muxc);
2595 			return -ENODEV;
2596 		}
2597 	}
2598 
2599 	i2c_set_clientdata(client, muxc);
2600 
2601 	return 0;
2602 };
2603 
2604 static int unittest_i2c_mux_remove(struct i2c_client *client)
2605 {
2606 	struct device *dev = &client->dev;
2607 	struct device_node *np = client->dev.of_node;
2608 	struct i2c_mux_core *muxc = i2c_get_clientdata(client);
2609 
2610 	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2611 	i2c_mux_del_adapters(muxc);
2612 	return 0;
2613 }
2614 
2615 static const struct i2c_device_id unittest_i2c_mux_id[] = {
2616 	{ .name = "unittest-i2c-mux" },
2617 	{ }
2618 };
2619 
2620 static struct i2c_driver unittest_i2c_mux_driver = {
2621 	.driver = {
2622 		.name = "unittest-i2c-mux",
2623 	},
2624 	.probe = unittest_i2c_mux_probe,
2625 	.remove = unittest_i2c_mux_remove,
2626 	.id_table = unittest_i2c_mux_id,
2627 };
2628 
2629 #endif
2630 
2631 static int of_unittest_overlay_i2c_init(void)
2632 {
2633 	int ret;
2634 
2635 	ret = i2c_add_driver(&unittest_i2c_dev_driver);
2636 	if (unittest(ret == 0,
2637 			"could not register unittest i2c device driver\n"))
2638 		return ret;
2639 
2640 	ret = platform_driver_register(&unittest_i2c_bus_driver);
2641 
2642 	if (unittest(ret == 0,
2643 			"could not register unittest i2c bus driver\n"))
2644 		return ret;
2645 
2646 #if IS_BUILTIN(CONFIG_I2C_MUX)
2647 
2648 	EXPECT_BEGIN(KERN_INFO,
2649 		     "i2c i2c-1: Added multiplexed i2c bus 2");
2650 
2651 	ret = i2c_add_driver(&unittest_i2c_mux_driver);
2652 
2653 	EXPECT_END(KERN_INFO,
2654 		   "i2c i2c-1: Added multiplexed i2c bus 2");
2655 
2656 	if (unittest(ret == 0,
2657 			"could not register unittest i2c mux driver\n"))
2658 		return ret;
2659 #endif
2660 
2661 	return 0;
2662 }
2663 
2664 static void of_unittest_overlay_i2c_cleanup(void)
2665 {
2666 #if IS_BUILTIN(CONFIG_I2C_MUX)
2667 	i2c_del_driver(&unittest_i2c_mux_driver);
2668 #endif
2669 	platform_driver_unregister(&unittest_i2c_bus_driver);
2670 	i2c_del_driver(&unittest_i2c_dev_driver);
2671 }
2672 
2673 static void __init of_unittest_overlay_i2c_12(void)
2674 {
2675 	int ret;
2676 
2677 	/* device should enable */
2678 	EXPECT_BEGIN(KERN_INFO,
2679 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2680 
2681 	ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
2682 
2683 	EXPECT_END(KERN_INFO,
2684 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
2685 
2686 	if (ret)
2687 		return;
2688 
2689 	unittest(1, "overlay test %d passed\n", 12);
2690 }
2691 
2692 /* test deactivation of device */
2693 static void __init of_unittest_overlay_i2c_13(void)
2694 {
2695 	int ret;
2696 
2697 	EXPECT_BEGIN(KERN_INFO,
2698 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2699 
2700 	/* device should disable */
2701 	ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
2702 
2703 	EXPECT_END(KERN_INFO,
2704 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
2705 
2706 	if (ret)
2707 		return;
2708 
2709 	unittest(1, "overlay test %d passed\n", 13);
2710 }
2711 
2712 /* just check for i2c mux existence */
2713 static void of_unittest_overlay_i2c_14(void)
2714 {
2715 }
2716 
2717 static void __init of_unittest_overlay_i2c_15(void)
2718 {
2719 	int ret;
2720 
2721 	/* device should enable */
2722 	EXPECT_BEGIN(KERN_INFO,
2723 		     "i2c i2c-1: Added multiplexed i2c bus 3");
2724 
2725 	ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
2726 
2727 	EXPECT_END(KERN_INFO,
2728 		   "i2c i2c-1: Added multiplexed i2c bus 3");
2729 
2730 	if (ret)
2731 		return;
2732 
2733 	unittest(1, "overlay test %d passed\n", 15);
2734 }
2735 
2736 #else
2737 
2738 static inline void of_unittest_overlay_i2c_14(void) { }
2739 static inline void of_unittest_overlay_i2c_15(void) { }
2740 
2741 #endif
2742 
2743 static int of_notify(struct notifier_block *nb, unsigned long action,
2744 		     void *arg)
2745 {
2746 	struct of_overlay_notify_data *nd = arg;
2747 	struct device_node *found;
2748 	int ret;
2749 
2750 	/*
2751 	 * For overlay_16 .. overlay_19, check that returning an error
2752 	 * works for each of the actions by setting an arbitrary return
2753 	 * error number that matches the test number.  e.g. for unittest16,
2754 	 * ret = -EBUSY which is -16.
2755 	 *
2756 	 * OVERLAY_INFO() for the overlays is declared to expect the same
2757 	 * error number, so overlay_data_apply() will return no error.
2758 	 *
2759 	 * overlay_20 will return NOTIFY_DONE
2760 	 */
2761 
2762 	ret = 0;
2763 	of_node_get(nd->overlay);
2764 
2765 	switch (action) {
2766 
2767 	case OF_OVERLAY_PRE_APPLY:
2768 		found = of_find_node_by_name(nd->overlay, "test-unittest16");
2769 		if (found) {
2770 			of_node_put(found);
2771 			ret = -EBUSY;
2772 		}
2773 		break;
2774 
2775 	case OF_OVERLAY_POST_APPLY:
2776 		found = of_find_node_by_name(nd->overlay, "test-unittest17");
2777 		if (found) {
2778 			of_node_put(found);
2779 			ret = -EEXIST;
2780 		}
2781 		break;
2782 
2783 	case OF_OVERLAY_PRE_REMOVE:
2784 		found = of_find_node_by_name(nd->overlay, "test-unittest18");
2785 		if (found) {
2786 			of_node_put(found);
2787 			ret = -EXDEV;
2788 		}
2789 		break;
2790 
2791 	case OF_OVERLAY_POST_REMOVE:
2792 		found = of_find_node_by_name(nd->overlay, "test-unittest19");
2793 		if (found) {
2794 			of_node_put(found);
2795 			ret = -ENODEV;
2796 		}
2797 		break;
2798 
2799 	default:			/* should not happen */
2800 		of_node_put(nd->overlay);
2801 		ret = -EINVAL;
2802 		break;
2803 	}
2804 
2805 	if (ret)
2806 		return notifier_from_errno(ret);
2807 
2808 	return NOTIFY_DONE;
2809 }
2810 
2811 static struct notifier_block of_nb = {
2812 	.notifier_call = of_notify,
2813 };
2814 
2815 static void __init of_unittest_overlay_notify(void)
2816 {
2817 	int ovcs_id;
2818 	int ret;
2819 
2820 	ret = of_overlay_notifier_register(&of_nb);
2821 	unittest(!ret,
2822 		 "of_overlay_notifier_register() failed, ret = %d\n", ret);
2823 	if (ret)
2824 		return;
2825 
2826 	/*
2827 	 * The overlays are applied by overlay_data_apply()
2828 	 * instead of of_unittest_apply_overlay() so that they
2829 	 * will not be tracked.  Thus they will not be removed
2830 	 * by of_unittest_remove_tracked_overlays().
2831 	 *
2832 	 * Applying overlays 16 - 19 will each trigger an error for a
2833 	 * different action in of_notify().
2834 	 *
2835 	 * Applying overlay 20 will not trigger any error in of_notify().
2836 	 */
2837 
2838 	/* ---  overlay 16  --- */
2839 
2840 	EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
2841 
2842 	unittest(overlay_data_apply("overlay_16", &ovcs_id),
2843 		 "test OF_OVERLAY_PRE_APPLY notify injected error\n");
2844 
2845 	EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
2846 
2847 	unittest(ovcs_id, "ovcs_id not created for overlay_16\n");
2848 
2849 	/* ---  overlay 17  --- */
2850 
2851 	EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
2852 
2853 	unittest(overlay_data_apply("overlay_17", &ovcs_id),
2854 		 "test OF_OVERLAY_POST_APPLY notify injected error\n");
2855 
2856 	EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
2857 
2858 	unittest(ovcs_id, "ovcs_id not created for overlay_17\n");
2859 
2860 	if (ovcs_id) {
2861 		ret = of_overlay_remove(&ovcs_id);
2862 		unittest(!ret,
2863 			"overlay_17 of_overlay_remove(), ret = %d\n", ret);
2864 	}
2865 
2866 	/* ---  overlay 18  --- */
2867 
2868 	unittest(overlay_data_apply("overlay_18", &ovcs_id),
2869 		 "OF_OVERLAY_PRE_REMOVE notify injected error\n");
2870 
2871 	unittest(ovcs_id, "ovcs_id not created for overlay_18\n");
2872 
2873 	if (ovcs_id) {
2874 		EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
2875 
2876 		ret = of_overlay_remove(&ovcs_id);
2877 		EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
2878 		if (ret == -EXDEV) {
2879 			/*
2880 			 * change set ovcs_id should still exist
2881 			 */
2882 			unittest(1, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE\n");
2883 		} else {
2884 			unittest(0, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE not returned\n");
2885 		}
2886 	} else {
2887 		unittest(1, "ovcs_id not created for overlay_18\n");
2888 	}
2889 
2890 	unittest(ovcs_id, "ovcs_id removed for overlay_18\n");
2891 
2892 	/* ---  overlay 19  --- */
2893 
2894 	unittest(overlay_data_apply("overlay_19", &ovcs_id),
2895 		 "OF_OVERLAY_POST_REMOVE notify injected error\n");
2896 
2897 	unittest(ovcs_id, "ovcs_id not created for overlay_19\n");
2898 
2899 	if (ovcs_id) {
2900 		EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
2901 		ret = of_overlay_remove(&ovcs_id);
2902 		EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
2903 		if (ret == -ENODEV)
2904 			unittest(1, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE\n");
2905 		else
2906 			unittest(0, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE not returned\n");
2907 	} else {
2908 		unittest(1, "ovcs_id removed for overlay_19\n");
2909 	}
2910 
2911 	unittest(!ovcs_id, "changeset ovcs_id = %d not removed for overlay_19\n",
2912 		 ovcs_id);
2913 
2914 	/* ---  overlay 20  --- */
2915 
2916 	unittest(overlay_data_apply("overlay_20", &ovcs_id),
2917 		 "overlay notify no injected error\n");
2918 
2919 	if (ovcs_id) {
2920 		ret = of_overlay_remove(&ovcs_id);
2921 		if (ret)
2922 			unittest(1, "overlay_20 failed to be destroyed, ret = %d\n",
2923 				 ret);
2924 	} else {
2925 		unittest(1, "ovcs_id not created for overlay_20\n");
2926 	}
2927 
2928 	unittest(!of_overlay_notifier_unregister(&of_nb),
2929 		 "of_overlay_notifier_unregister() failed, ret = %d\n", ret);
2930 }
2931 
2932 static void __init of_unittest_overlay(void)
2933 {
2934 	struct device_node *bus_np = NULL;
2935 
2936 	if (platform_driver_register(&unittest_driver)) {
2937 		unittest(0, "could not register unittest driver\n");
2938 		goto out;
2939 	}
2940 
2941 	bus_np = of_find_node_by_path(bus_path);
2942 	if (bus_np == NULL) {
2943 		unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2944 		goto out;
2945 	}
2946 
2947 	if (of_platform_default_populate(bus_np, NULL, NULL)) {
2948 		unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2949 		goto out;
2950 	}
2951 
2952 	if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2953 		unittest(0, "could not find unittest0 @ \"%s\"\n",
2954 				unittest_path(100, PDEV_OVERLAY));
2955 		goto out;
2956 	}
2957 
2958 	if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2959 		unittest(0, "unittest1 @ \"%s\" should not exist\n",
2960 				unittest_path(101, PDEV_OVERLAY));
2961 		goto out;
2962 	}
2963 
2964 	unittest(1, "basic infrastructure of overlays passed");
2965 
2966 	/* tests in sequence */
2967 	of_unittest_overlay_0();
2968 	of_unittest_overlay_1();
2969 	of_unittest_overlay_2();
2970 	of_unittest_overlay_3();
2971 	of_unittest_overlay_4();
2972 	of_unittest_overlay_5();
2973 	of_unittest_overlay_6();
2974 	of_unittest_overlay_8();
2975 
2976 	of_unittest_overlay_10();
2977 	of_unittest_overlay_11();
2978 
2979 #if IS_BUILTIN(CONFIG_I2C)
2980 	if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2981 		goto out;
2982 
2983 	of_unittest_overlay_i2c_12();
2984 	of_unittest_overlay_i2c_13();
2985 	of_unittest_overlay_i2c_14();
2986 	of_unittest_overlay_i2c_15();
2987 
2988 	of_unittest_overlay_i2c_cleanup();
2989 #endif
2990 
2991 	of_unittest_overlay_gpio();
2992 
2993 	of_unittest_remove_tracked_overlays();
2994 
2995 	of_unittest_overlay_notify();
2996 
2997 out:
2998 	of_node_put(bus_np);
2999 }
3000 
3001 #else
3002 static inline void __init of_unittest_overlay(void) { }
3003 #endif
3004 
3005 #ifdef CONFIG_OF_OVERLAY
3006 
3007 /*
3008  * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
3009  * in scripts/Makefile.lib
3010  */
3011 
3012 #define OVERLAY_INFO_EXTERN(name) \
3013 	extern uint8_t __dtb_##name##_begin[]; \
3014 	extern uint8_t __dtb_##name##_end[]
3015 
3016 #define OVERLAY_INFO(overlay_name, expected)             \
3017 {	.dtb_begin       = __dtb_##overlay_name##_begin, \
3018 	.dtb_end         = __dtb_##overlay_name##_end,   \
3019 	.expected_result = expected,                     \
3020 	.name            = #overlay_name,                \
3021 }
3022 
3023 struct overlay_info {
3024 	uint8_t		*dtb_begin;
3025 	uint8_t		*dtb_end;
3026 	int		expected_result;
3027 	int		ovcs_id;
3028 	char		*name;
3029 };
3030 
3031 OVERLAY_INFO_EXTERN(overlay_base);
3032 OVERLAY_INFO_EXTERN(overlay);
3033 OVERLAY_INFO_EXTERN(overlay_0);
3034 OVERLAY_INFO_EXTERN(overlay_1);
3035 OVERLAY_INFO_EXTERN(overlay_2);
3036 OVERLAY_INFO_EXTERN(overlay_3);
3037 OVERLAY_INFO_EXTERN(overlay_4);
3038 OVERLAY_INFO_EXTERN(overlay_5);
3039 OVERLAY_INFO_EXTERN(overlay_6);
3040 OVERLAY_INFO_EXTERN(overlay_7);
3041 OVERLAY_INFO_EXTERN(overlay_8);
3042 OVERLAY_INFO_EXTERN(overlay_9);
3043 OVERLAY_INFO_EXTERN(overlay_10);
3044 OVERLAY_INFO_EXTERN(overlay_11);
3045 OVERLAY_INFO_EXTERN(overlay_12);
3046 OVERLAY_INFO_EXTERN(overlay_13);
3047 OVERLAY_INFO_EXTERN(overlay_15);
3048 OVERLAY_INFO_EXTERN(overlay_16);
3049 OVERLAY_INFO_EXTERN(overlay_17);
3050 OVERLAY_INFO_EXTERN(overlay_18);
3051 OVERLAY_INFO_EXTERN(overlay_19);
3052 OVERLAY_INFO_EXTERN(overlay_20);
3053 OVERLAY_INFO_EXTERN(overlay_gpio_01);
3054 OVERLAY_INFO_EXTERN(overlay_gpio_02a);
3055 OVERLAY_INFO_EXTERN(overlay_gpio_02b);
3056 OVERLAY_INFO_EXTERN(overlay_gpio_03);
3057 OVERLAY_INFO_EXTERN(overlay_gpio_04a);
3058 OVERLAY_INFO_EXTERN(overlay_gpio_04b);
3059 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
3060 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
3061 OVERLAY_INFO_EXTERN(overlay_bad_phandle);
3062 OVERLAY_INFO_EXTERN(overlay_bad_symbol);
3063 
3064 /* entries found by name */
3065 static struct overlay_info overlays[] = {
3066 	OVERLAY_INFO(overlay_base, -9999),
3067 	OVERLAY_INFO(overlay, 0),
3068 	OVERLAY_INFO(overlay_0, 0),
3069 	OVERLAY_INFO(overlay_1, 0),
3070 	OVERLAY_INFO(overlay_2, 0),
3071 	OVERLAY_INFO(overlay_3, 0),
3072 	OVERLAY_INFO(overlay_4, 0),
3073 	OVERLAY_INFO(overlay_5, 0),
3074 	OVERLAY_INFO(overlay_6, 0),
3075 	OVERLAY_INFO(overlay_7, 0),
3076 	OVERLAY_INFO(overlay_8, 0),
3077 	OVERLAY_INFO(overlay_9, 0),
3078 	OVERLAY_INFO(overlay_10, 0),
3079 	OVERLAY_INFO(overlay_11, 0),
3080 	OVERLAY_INFO(overlay_12, 0),
3081 	OVERLAY_INFO(overlay_13, 0),
3082 	OVERLAY_INFO(overlay_15, 0),
3083 	OVERLAY_INFO(overlay_16, -EBUSY),
3084 	OVERLAY_INFO(overlay_17, -EEXIST),
3085 	OVERLAY_INFO(overlay_18, 0),
3086 	OVERLAY_INFO(overlay_19, 0),
3087 	OVERLAY_INFO(overlay_20, 0),
3088 	OVERLAY_INFO(overlay_gpio_01, 0),
3089 	OVERLAY_INFO(overlay_gpio_02a, 0),
3090 	OVERLAY_INFO(overlay_gpio_02b, 0),
3091 	OVERLAY_INFO(overlay_gpio_03, 0),
3092 	OVERLAY_INFO(overlay_gpio_04a, 0),
3093 	OVERLAY_INFO(overlay_gpio_04b, 0),
3094 	OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL),
3095 	OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL),
3096 	OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
3097 	OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
3098 	/* end marker */
3099 	{.dtb_begin = NULL, .dtb_end = NULL, .expected_result = 0, .name = NULL}
3100 };
3101 
3102 static struct device_node *overlay_base_root;
3103 
3104 static void * __init dt_alloc_memory(u64 size, u64 align)
3105 {
3106 	void *ptr = memblock_alloc(size, align);
3107 
3108 	if (!ptr)
3109 		panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
3110 		      __func__, size, align);
3111 
3112 	return ptr;
3113 }
3114 
3115 /*
3116  * Create base device tree for the overlay unittest.
3117  *
3118  * This is called from very early boot code.
3119  *
3120  * Do as much as possible the same way as done in __unflatten_device_tree
3121  * and other early boot steps for the normal FDT so that the overlay base
3122  * unflattened tree will have the same characteristics as the real tree
3123  * (such as having memory allocated by the early allocator).  The goal
3124  * is to test "the real thing" as much as possible, and test "test setup
3125  * code" as little as possible.
3126  *
3127  * Have to stop before resolving phandles, because that uses kmalloc.
3128  */
3129 void __init unittest_unflatten_overlay_base(void)
3130 {
3131 	struct overlay_info *info;
3132 	u32 data_size;
3133 	void *new_fdt;
3134 	u32 size;
3135 	int found = 0;
3136 	const char *overlay_name = "overlay_base";
3137 
3138 	for (info = overlays; info && info->name; info++) {
3139 		if (!strcmp(overlay_name, info->name)) {
3140 			found = 1;
3141 			break;
3142 		}
3143 	}
3144 	if (!found) {
3145 		pr_err("no overlay data for %s\n", overlay_name);
3146 		return;
3147 	}
3148 
3149 	info = &overlays[0];
3150 
3151 	if (info->expected_result != -9999) {
3152 		pr_err("No dtb 'overlay_base' to attach\n");
3153 		return;
3154 	}
3155 
3156 	data_size = info->dtb_end - info->dtb_begin;
3157 	if (!data_size) {
3158 		pr_err("No dtb 'overlay_base' to attach\n");
3159 		return;
3160 	}
3161 
3162 	size = fdt_totalsize(info->dtb_begin);
3163 	if (size != data_size) {
3164 		pr_err("dtb 'overlay_base' header totalsize != actual size");
3165 		return;
3166 	}
3167 
3168 	new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
3169 	if (!new_fdt) {
3170 		pr_err("alloc for dtb 'overlay_base' failed");
3171 		return;
3172 	}
3173 
3174 	memcpy(new_fdt, info->dtb_begin, size);
3175 
3176 	__unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
3177 				dt_alloc_memory, true);
3178 }
3179 
3180 /*
3181  * The purpose of of_unittest_overlay_data_add is to add an
3182  * overlay in the normal fashion.  This is a test of the whole
3183  * picture, instead of testing individual elements.
3184  *
3185  * A secondary purpose is to be able to verify that the contents of
3186  * /proc/device-tree/ contains the updated structure and values from
3187  * the overlay.  That must be verified separately in user space.
3188  *
3189  * Return 0 on unexpected error.
3190  */
3191 static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id)
3192 {
3193 	struct overlay_info *info;
3194 	int found = 0;
3195 	int ret;
3196 	u32 size;
3197 
3198 	for (info = overlays; info && info->name; info++) {
3199 		if (!strcmp(overlay_name, info->name)) {
3200 			found = 1;
3201 			break;
3202 		}
3203 	}
3204 	if (!found) {
3205 		pr_err("no overlay data for %s\n", overlay_name);
3206 		return 0;
3207 	}
3208 
3209 	size = info->dtb_end - info->dtb_begin;
3210 	if (!size)
3211 		pr_err("no overlay data for %s\n", overlay_name);
3212 
3213 	ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->ovcs_id);
3214 	if (ovcs_id)
3215 		*ovcs_id = info->ovcs_id;
3216 	if (ret < 0)
3217 		goto out;
3218 
3219 	pr_debug("%s applied\n", overlay_name);
3220 
3221 out:
3222 	if (ret != info->expected_result)
3223 		pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
3224 		       info->expected_result, ret, overlay_name);
3225 
3226 	return (ret == info->expected_result);
3227 }
3228 
3229 /*
3230  * The purpose of of_unittest_overlay_high_level is to add an overlay
3231  * in the normal fashion.  This is a test of the whole picture,
3232  * instead of individual elements.
3233  *
3234  * The first part of the function is _not_ normal overlay usage; it is
3235  * finishing splicing the base overlay device tree into the live tree.
3236  */
3237 static __init void of_unittest_overlay_high_level(void)
3238 {
3239 	struct device_node *last_sibling;
3240 	struct device_node *np;
3241 	struct device_node *of_symbols;
3242 	struct device_node *overlay_base_symbols;
3243 	struct device_node **pprev;
3244 	struct property *prop;
3245 	int ret;
3246 
3247 	if (!overlay_base_root) {
3248 		unittest(0, "overlay_base_root not initialized\n");
3249 		return;
3250 	}
3251 
3252 	/*
3253 	 * Could not fixup phandles in unittest_unflatten_overlay_base()
3254 	 * because kmalloc() was not yet available.
3255 	 */
3256 	of_overlay_mutex_lock();
3257 	of_resolve_phandles(overlay_base_root);
3258 	of_overlay_mutex_unlock();
3259 
3260 
3261 	/*
3262 	 * do not allow overlay_base to duplicate any node already in
3263 	 * tree, this greatly simplifies the code
3264 	 */
3265 
3266 	/*
3267 	 * remove overlay_base_root node "__local_fixups", after
3268 	 * being used by of_resolve_phandles()
3269 	 */
3270 	pprev = &overlay_base_root->child;
3271 	for (np = overlay_base_root->child; np; np = np->sibling) {
3272 		if (of_node_name_eq(np, "__local_fixups__")) {
3273 			*pprev = np->sibling;
3274 			break;
3275 		}
3276 		pprev = &np->sibling;
3277 	}
3278 
3279 	/* remove overlay_base_root node "__symbols__" if in live tree */
3280 	of_symbols = of_get_child_by_name(of_root, "__symbols__");
3281 	if (of_symbols) {
3282 		/* will have to graft properties from node into live tree */
3283 		pprev = &overlay_base_root->child;
3284 		for (np = overlay_base_root->child; np; np = np->sibling) {
3285 			if (of_node_name_eq(np, "__symbols__")) {
3286 				overlay_base_symbols = np;
3287 				*pprev = np->sibling;
3288 				break;
3289 			}
3290 			pprev = &np->sibling;
3291 		}
3292 	}
3293 
3294 	for_each_child_of_node(overlay_base_root, np) {
3295 		struct device_node *base_child;
3296 		for_each_child_of_node(of_root, base_child) {
3297 			if (!strcmp(np->full_name, base_child->full_name)) {
3298 				unittest(0, "illegal node name in overlay_base %pOFn",
3299 					 np);
3300 				of_node_put(np);
3301 				of_node_put(base_child);
3302 				return;
3303 			}
3304 		}
3305 	}
3306 
3307 	/*
3308 	 * overlay 'overlay_base' is not allowed to have root
3309 	 * properties, so only need to splice nodes into main device tree.
3310 	 *
3311 	 * root node of *overlay_base_root will not be freed, it is lost
3312 	 * memory.
3313 	 */
3314 
3315 	for (np = overlay_base_root->child; np; np = np->sibling)
3316 		np->parent = of_root;
3317 
3318 	mutex_lock(&of_mutex);
3319 
3320 	for (last_sibling = np = of_root->child; np; np = np->sibling)
3321 		last_sibling = np;
3322 
3323 	if (last_sibling)
3324 		last_sibling->sibling = overlay_base_root->child;
3325 	else
3326 		of_root->child = overlay_base_root->child;
3327 
3328 	for_each_of_allnodes_from(overlay_base_root, np)
3329 		__of_attach_node_sysfs(np);
3330 
3331 	if (of_symbols) {
3332 		struct property *new_prop;
3333 		for_each_property_of_node(overlay_base_symbols, prop) {
3334 
3335 			new_prop = __of_prop_dup(prop, GFP_KERNEL);
3336 			if (!new_prop) {
3337 				unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
3338 					 prop->name);
3339 				goto err_unlock;
3340 			}
3341 			if (__of_add_property(of_symbols, new_prop)) {
3342 				kfree(new_prop->name);
3343 				kfree(new_prop->value);
3344 				kfree(new_prop);
3345 				/* "name" auto-generated by unflatten */
3346 				if (!strcmp(prop->name, "name"))
3347 					continue;
3348 				unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
3349 					 prop->name);
3350 				goto err_unlock;
3351 			}
3352 			if (__of_add_property_sysfs(of_symbols, new_prop)) {
3353 				unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
3354 					 prop->name);
3355 				goto err_unlock;
3356 			}
3357 		}
3358 	}
3359 
3360 	mutex_unlock(&of_mutex);
3361 
3362 
3363 	/* now do the normal overlay usage test */
3364 
3365 	EXPECT_BEGIN(KERN_ERR,
3366 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3367 	EXPECT_BEGIN(KERN_ERR,
3368 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3369 	EXPECT_BEGIN(KERN_ERR,
3370 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3371 	EXPECT_BEGIN(KERN_ERR,
3372 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3373 	EXPECT_BEGIN(KERN_ERR,
3374 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3375 	EXPECT_BEGIN(KERN_ERR,
3376 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3377 	EXPECT_BEGIN(KERN_ERR,
3378 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3379 	EXPECT_BEGIN(KERN_ERR,
3380 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3381 	EXPECT_BEGIN(KERN_ERR,
3382 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3383 	EXPECT_BEGIN(KERN_ERR,
3384 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3385 	EXPECT_BEGIN(KERN_ERR,
3386 		     "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3387 
3388 	ret = overlay_data_apply("overlay", NULL);
3389 
3390 	EXPECT_END(KERN_ERR,
3391 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
3392 	EXPECT_END(KERN_ERR,
3393 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
3394 	EXPECT_END(KERN_ERR,
3395 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
3396 	EXPECT_END(KERN_ERR,
3397 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
3398 	EXPECT_END(KERN_ERR,
3399 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
3400 	EXPECT_END(KERN_ERR,
3401 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
3402 	EXPECT_END(KERN_ERR,
3403 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
3404 	EXPECT_END(KERN_ERR,
3405 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
3406 	EXPECT_END(KERN_ERR,
3407 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
3408 	EXPECT_END(KERN_ERR,
3409 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
3410 	EXPECT_END(KERN_ERR,
3411 		   "OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
3412 
3413 	unittest(ret, "Adding overlay 'overlay' failed\n");
3414 
3415 	EXPECT_BEGIN(KERN_ERR,
3416 		     "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3417 	EXPECT_BEGIN(KERN_ERR,
3418 		     "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3419 
3420 	unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
3421 		 "Adding overlay 'overlay_bad_add_dup_node' failed\n");
3422 
3423 	EXPECT_END(KERN_ERR,
3424 		   "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
3425 	EXPECT_END(KERN_ERR,
3426 		   "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
3427 
3428 	EXPECT_BEGIN(KERN_ERR,
3429 		     "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3430 	EXPECT_BEGIN(KERN_ERR,
3431 		     "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3432 	EXPECT_BEGIN(KERN_ERR,
3433 		     "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3434 
3435 	unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
3436 		 "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
3437 
3438 	EXPECT_END(KERN_ERR,
3439 		     "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
3440 	EXPECT_END(KERN_ERR,
3441 		     "OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
3442 	EXPECT_END(KERN_ERR,
3443 		     "OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
3444 
3445 	unittest(overlay_data_apply("overlay_bad_phandle", NULL),
3446 		 "Adding overlay 'overlay_bad_phandle' failed\n");
3447 
3448 	unittest(overlay_data_apply("overlay_bad_symbol", NULL),
3449 		 "Adding overlay 'overlay_bad_symbol' failed\n");
3450 
3451 	return;
3452 
3453 err_unlock:
3454 	mutex_unlock(&of_mutex);
3455 }
3456 
3457 #else
3458 
3459 static inline __init void of_unittest_overlay_high_level(void) {}
3460 
3461 #endif
3462 
3463 static int __init of_unittest(void)
3464 {
3465 	struct device_node *np;
3466 	int res;
3467 
3468 	pr_info("start of unittest - you will see error messages\n");
3469 
3470 	/* adding data for unittest */
3471 
3472 	if (IS_ENABLED(CONFIG_UML))
3473 		unittest_unflatten_overlay_base();
3474 
3475 	res = unittest_data_add();
3476 	if (res)
3477 		return res;
3478 	if (!of_aliases)
3479 		of_aliases = of_find_node_by_path("/aliases");
3480 
3481 	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
3482 	if (!np) {
3483 		pr_info("No testcase data in device tree; not running tests\n");
3484 		return 0;
3485 	}
3486 	of_node_put(np);
3487 
3488 	of_unittest_check_tree_linkage();
3489 	of_unittest_check_phandles();
3490 	of_unittest_find_node_by_name();
3491 	of_unittest_dynamic();
3492 	of_unittest_parse_phandle_with_args();
3493 	of_unittest_parse_phandle_with_args_map();
3494 	of_unittest_printf();
3495 	of_unittest_property_string();
3496 	of_unittest_property_copy();
3497 	of_unittest_changeset();
3498 	of_unittest_parse_interrupts();
3499 	of_unittest_parse_interrupts_extended();
3500 	of_unittest_dma_get_max_cpu_address();
3501 	of_unittest_parse_dma_ranges();
3502 	of_unittest_pci_dma_ranges();
3503 	of_unittest_match_node();
3504 	of_unittest_platform_populate();
3505 	of_unittest_overlay();
3506 
3507 	/* Double check linkage after removing testcase data */
3508 	of_unittest_check_tree_linkage();
3509 
3510 	of_unittest_overlay_high_level();
3511 
3512 	pr_info("end of unittest - %i passed, %i failed\n",
3513 		unittest_results.passed, unittest_results.failed);
3514 
3515 	return 0;
3516 }
3517 late_initcall(of_unittest);
3518