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/pci.h>
26	#include <linux/kernel.h>
27
28	#include <linux/i2c.h>
29	#include <linux/i2c-mux.h>
30	#include <linux/gpio/driver.h>
31
32	#include <linux/bitops.h>
33
34	#include "of_private.h"
35
36	static struct unittest_results {
37	int passed;
38	int failed;
39	} unittest_results;
40
41	#define unittest(result, fmt, ...) ({ \
42	bool failed = !(result); \
43	if (failed) { \
44	unittest_results.failed++; \
45	pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
46	} else { \
47	unittest_results.passed++; \
48	pr_info("pass %s():%i\n", __func__, __LINE__); \
49	} \
50	failed; \
51	})
52
53	#ifdef CONFIG_OF_KOBJ
54	#define OF_KREF_READ(NODE) kref_read(&(NODE)->kobj.kref)
55	#else
56	#define OF_KREF_READ(NODE) 1
57	#endif
58
59	/*
60	* Expected message may have a message level other than KERN_INFO.
61	* Print the expected message only if the current loglevel will allow
62	* the actual message to print.
63	*
64	* Do not use EXPECT_BEGIN(), EXPECT_END(), EXPECT_NOT_BEGIN(), or
65	* EXPECT_NOT_END() to report messages expected to be reported or not
66	* reported by pr_debug().
67	*/
68	#define EXPECT_BEGIN(level, fmt, ...) \
69	printk(level pr_fmt("EXPECT \\ : ") fmt, ##__VA_ARGS__)
70
71	#define EXPECT_END(level, fmt, ...) \
72	printk(level pr_fmt("EXPECT / : ") fmt, ##__VA_ARGS__)
73
74	#define EXPECT_NOT_BEGIN(level, fmt, ...) \
75	printk(level pr_fmt("EXPECT_NOT \\ : ") fmt, ##__VA_ARGS__)
76
77	#define EXPECT_NOT_END(level, fmt, ...) \
78	printk(level pr_fmt("EXPECT_NOT / : ") fmt, ##__VA_ARGS__)
79
80	static void __init of_unittest_find_node_by_name(void)
81	{
82	struct device_node *np;
83	const char *options, *name;
84
85	np = of_find_node_by_path(path: "/testcase-data");
86	name = kasprintf(GFP_KERNEL, fmt: "%pOF", np);
87	unittest(np && name && !strcmp("/testcase-data", name),
88	"find /testcase-data failed\n");
89	of_node_put(node: np);
90	kfree(objp: name);
91
92	/* Test if trailing '/' works */
93	np = of_find_node_by_path(path: "/testcase-data/");
94	unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
95
96	np = of_find_node_by_path(path: "/testcase-data/phandle-tests/consumer-a");
97	name = kasprintf(GFP_KERNEL, fmt: "%pOF", np);
98	unittest(np && name && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
99	"find /testcase-data/phandle-tests/consumer-a failed\n");
100	of_node_put(node: np);
101	kfree(objp: name);
102
103	np = of_find_node_by_path(path: "testcase-alias");
104	name = kasprintf(GFP_KERNEL, fmt: "%pOF", np);
105	unittest(np && name && !strcmp("/testcase-data", name),
106	"find testcase-alias failed\n");
107	of_node_put(node: np);
108	kfree(objp: name);
109
110	/* Test if trailing '/' works on aliases */
111	np = of_find_node_by_path(path: "testcase-alias/");
112	unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
113
114	np = of_find_node_by_path(path: "testcase-alias/phandle-tests/consumer-a");
115	name = kasprintf(GFP_KERNEL, fmt: "%pOF", np);
116	unittest(np && name && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
117	"find testcase-alias/phandle-tests/consumer-a failed\n");
118	of_node_put(node: np);
119	kfree(objp: name);
120
121	np = of_find_node_by_path(path: "/testcase-data/missing-path");
122	unittest(!np, "non-existent path returned node %pOF\n", np);
123	of_node_put(node: np);
124
125	np = of_find_node_by_path(path: "missing-alias");
126	unittest(!np, "non-existent alias returned node %pOF\n", np);
127	of_node_put(node: np);
128
129	np = of_find_node_by_path(path: "testcase-alias/missing-path");
130	unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
131	of_node_put(node: np);
132
133	np = of_find_node_opts_by_path(path: "/testcase-data:testoption", opts: &options);
134	unittest(np && !strcmp("testoption", options),
135	"option path test failed\n");
136	of_node_put(node: np);
137
138	np = of_find_node_opts_by_path(path: "/testcase-data:test/option", opts: &options);
139	unittest(np && !strcmp("test/option", options),
140	"option path test, subcase #1 failed\n");
141	of_node_put(node: np);
142
143	np = of_find_node_opts_by_path(path: "/testcase-data/testcase-device1:test/option", opts: &options);
144	unittest(np && !strcmp("test/option", options),
145	"option path test, subcase #2 failed\n");
146	of_node_put(node: np);
147
148	np = of_find_node_opts_by_path(path: "/testcase-data:testoption", NULL);
149	unittest(np, "NULL option path test failed\n");
150	of_node_put(node: np);
151
152	np = of_find_node_opts_by_path(path: "testcase-alias:testaliasoption",
153	opts: &options);
154	unittest(np && !strcmp("testaliasoption", options),
155	"option alias path test failed\n");
156	of_node_put(node: np);
157
158	np = of_find_node_opts_by_path(path: "testcase-alias:test/alias/option",
159	opts: &options);
160	unittest(np && !strcmp("test/alias/option", options),
161	"option alias path test, subcase #1 failed\n");
162	of_node_put(node: np);
163
164	np = of_find_node_opts_by_path(path: "testcase-alias/phandle-tests/consumer-a:testaliasoption",
165	opts: &options);
166	name = kasprintf(GFP_KERNEL, fmt: "%pOF", np);
167	unittest(np && name && !strcmp("/testcase-data/phandle-tests/consumer-a", name) &&
168	!strcmp("testaliasoption", options),
169	"option alias path test, subcase #2 failed\n");
170	of_node_put(node: np);
171	kfree(objp: name);
172
173	np = of_find_node_opts_by_path(path: "testcase-alias:testaliasoption", NULL);
174	unittest(np, "NULL option alias path test failed\n");
175	of_node_put(node: np);
176
177	options = "testoption";
178	np = of_find_node_opts_by_path(path: "testcase-alias", opts: &options);
179	unittest(np && !options, "option clearing test failed\n");
180	of_node_put(node: np);
181
182	options = "testoption";
183	np = of_find_node_opts_by_path(path: "/", opts: &options);
184	unittest(np && !options, "option clearing root node test failed\n");
185	of_node_put(node: np);
186	}
187
188	static void __init of_unittest_dynamic(void)
189	{
190	struct device_node *np;
191	struct property *prop;
192
193	np = of_find_node_by_path(path: "/testcase-data");
194	if (!np) {
195	pr_err("missing testcase data\n");
196	return;
197	}
198
199	/* Array of 4 properties for the purpose of testing */
200	prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
201	if (!prop) {
202	unittest(0, "kzalloc() failed\n");
203	return;
204	}
205
206	/* Add a new property - should pass*/
207	prop->name = "new-property";
208	prop->value = "new-property-data";
209	prop->length = strlen(prop->value) + 1;
210	unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
211
212	/* Try to add an existing property - should fail */
213	prop++;
214	prop->name = "new-property";
215	prop->value = "new-property-data-should-fail";
216	prop->length = strlen(prop->value) + 1;
217	unittest(of_add_property(np, prop) != 0,
218	"Adding an existing property should have failed\n");
219
220	/* Try to modify an existing property - should pass */
221	prop->value = "modify-property-data-should-pass";
222	prop->length = strlen(prop->value) + 1;
223	unittest(of_update_property(np, prop) == 0,
224	"Updating an existing property should have passed\n");
225
226	/* Try to modify non-existent property - should pass*/
227	prop++;
228	prop->name = "modify-property";
229	prop->value = "modify-missing-property-data-should-pass";
230	prop->length = strlen(prop->value) + 1;
231	unittest(of_update_property(np, prop) == 0,
232	"Updating a missing property should have passed\n");
233
234	/* Remove property - should pass */
235	unittest(of_remove_property(np, prop) == 0,
236	"Removing a property should have passed\n");
237
238	/* Adding very large property - should pass */
239	prop++;
240	prop->name = "large-property-PAGE_SIZEx8";
241	prop->length = PAGE_SIZE * 8;
242	prop->value = kzalloc(prop->length, GFP_KERNEL);
243	unittest(prop->value != NULL, "Unable to allocate large buffer\n");
244	if (prop->value)
245	unittest(of_add_property(np, prop) == 0,
246	"Adding a large property should have passed\n");
247	}
248
249	static int __init of_unittest_check_node_linkage(struct device_node *np)
250	{
251	int count = 0, rc;
252
253	for_each_child_of_node_scoped(np, child) {
254	if (child->parent != np) {
255	pr_err("Child node %pOFn links to wrong parent %pOFn\n",
256	child, np);
257	return -EINVAL;
258	}
259
260	rc = of_unittest_check_node_linkage(np: child);
261	if (rc < 0)
262	return rc;
263	count += rc;
264	}
265
266	return count + 1;
267	}
268
269	static void __init of_unittest_check_tree_linkage(void)
270	{
271	struct device_node *np;
272	int allnode_count = 0, child_count;
273
274	if (!of_root)
275	return;
276
277	for_each_of_allnodes(np)
278	allnode_count++;
279	child_count = of_unittest_check_node_linkage(np: of_root);
280
281	unittest(child_count > 0, "Device node data structure is corrupted\n");
282	unittest(child_count == allnode_count,
283	"allnodes list size (%i) doesn't match sibling lists size (%i)\n",
284	allnode_count, child_count);
285	pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
286	}
287
288	static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
289	const char *expected)
290	{
291	unsigned char *buf;
292	int buf_size;
293	int size, i;
294
295	buf_size = strlen(expected) + 10;
296	buf = kmalloc(buf_size, GFP_KERNEL);
297	if (!buf)
298	return;
299
300	/* Baseline; check conversion with a large size limit */
301	memset(buf, 0xff, buf_size);
302	size = snprintf(buf, size: buf_size - 2, fmt, np);
303
304	/* use strcmp() instead of strncmp() here to be absolutely sure strings match */
305	unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
306	"sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
307	fmt, expected, buf);
308
309	/* Make sure length limits work */
310	size++;
311	for (i = 0; i < 2; i++, size--) {
312	/* Clear the buffer, and make sure it works correctly still */
313	memset(buf, 0xff, buf_size);
314	snprintf(buf, size: size+1, fmt, np);
315	unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
316	"snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
317	size, fmt, expected, buf);
318	}
319	kfree(objp: buf);
320	}
321
322	static void __init of_unittest_printf(void)
323	{
324	struct device_node *np;
325	const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
326	char phandle_str[16] = "";
327
328	np = of_find_node_by_path(path: full_name);
329	if (!np) {
330	unittest(np, "testcase data missing\n");
331	return;
332	}
333
334	num_to_str(buf: phandle_str, size: sizeof(phandle_str), num: np->phandle, width: 0);
335
336	of_unittest_printf_one(np, fmt: "%pOF", expected: full_name);
337	of_unittest_printf_one(np, fmt: "%pOFf", expected: full_name);
338	of_unittest_printf_one(np, fmt: "%pOFn", expected: "dev");
339	of_unittest_printf_one(np, fmt: "%2pOFn", expected: "dev");
340	of_unittest_printf_one(np, fmt: "%5pOFn", expected: " dev");
341	of_unittest_printf_one(np, fmt: "%pOFnc", expected: "dev:test-sub-device");
342	of_unittest_printf_one(np, fmt: "%pOFp", expected: phandle_str);
343	of_unittest_printf_one(np, fmt: "%pOFP", expected: "dev@100");
344	of_unittest_printf_one(np, fmt: "ABC %pOFP ABC", expected: "ABC dev@100 ABC");
345	of_unittest_printf_one(np, fmt: "%10pOFP", expected: " dev@100");
346	of_unittest_printf_one(np, fmt: "%-10pOFP", expected: "dev@100 ");
347	of_unittest_printf_one(np: of_root, fmt: "%pOFP", expected: "/");
348	of_unittest_printf_one(np, fmt: "%pOFF", expected: "----");
349	of_unittest_printf_one(np, fmt: "%pOFPF", expected: "dev@100:----");
350	of_unittest_printf_one(np, fmt: "%pOFPFPc", expected: "dev@100:----:dev@100:test-sub-device");
351	of_unittest_printf_one(np, fmt: "%pOFc", expected: "test-sub-device");
352	of_unittest_printf_one(np, fmt: "%pOFC",
353	expected: "\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
354	}
355
356	struct node_hash {
357	struct hlist_node node;
358	struct device_node *np;
359	};
360
361	static DEFINE_HASHTABLE(phandle_ht, 8);
362	static void __init of_unittest_check_phandles(void)
363	{
364	struct device_node *np;
365	struct node_hash *nh;
366	struct hlist_node *tmp;
367	int i, dup_count = 0, phandle_count = 0;
368
369	for_each_of_allnodes(np) {
370	if (!np->phandle)
371	continue;
372
373	hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
374	if (nh->np->phandle == np->phandle) {
375	pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
376	np->phandle, nh->np, np);
377	dup_count++;
378	break;
379	}
380	}
381
382	nh = kzalloc(sizeof(*nh), GFP_KERNEL);
383	if (!nh)
384	return;
385
386	nh->np = np;
387	hash_add(phandle_ht, &nh->node, np->phandle);
388	phandle_count++;
389	}
390	unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
391	dup_count, phandle_count);
392
393	/* Clean up */
394	hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
395	hash_del(node: &nh->node);
396	kfree(objp: nh);
397	}
398	}
399
400	static void __init of_unittest_parse_phandle_with_args(void)
401	{
402	struct device_node *np;
403	struct of_phandle_args args;
404	int i, rc;
405
406	np = of_find_node_by_path(path: "/testcase-data/phandle-tests/consumer-a");
407	if (!np) {
408	pr_err("missing testcase data\n");
409	return;
410	}
411
412	rc = of_count_phandle_with_args(np, list_name: "phandle-list", cells_name: "#phandle-cells");
413	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
414
415	for (i = 0; i < 8; i++) {
416	bool passed = true;
417
418	memset(&args, 0, sizeof(args));
419	rc = of_parse_phandle_with_args(np, list_name: "phandle-list",
420	cells_name: "#phandle-cells", index: i, out_args: &args);
421
422	/* Test the values from tests-phandle.dtsi */
423	switch (i) {
424	case 0:
425	passed &= !rc;
426	passed &= (args.args_count == 1);
427	passed &= (args.args[0] == (i + 1));
428	break;
429	case 1:
430	passed &= !rc;
431	passed &= (args.args_count == 2);
432	passed &= (args.args[0] == (i + 1));
433	passed &= (args.args[1] == 0);
434	break;
435	case 2:
436	passed &= (rc == -ENOENT);
437	break;
438	case 3:
439	passed &= !rc;
440	passed &= (args.args_count == 3);
441	passed &= (args.args[0] == (i + 1));
442	passed &= (args.args[1] == 4);
443	passed &= (args.args[2] == 3);
444	break;
445	case 4:
446	passed &= !rc;
447	passed &= (args.args_count == 2);
448	passed &= (args.args[0] == (i + 1));
449	passed &= (args.args[1] == 100);
450	break;
451	case 5:
452	passed &= !rc;
453	passed &= (args.args_count == 0);
454	break;
455	case 6:
456	passed &= !rc;
457	passed &= (args.args_count == 1);
458	passed &= (args.args[0] == (i + 1));
459	break;
460	case 7:
461	passed &= (rc == -ENOENT);
462	break;
463	default:
464	passed = false;
465	}
466
467	unittest(passed, "index %i - data error on node %pOF rc=%i\n",
468	i, args.np, rc);
469
470	if (rc == 0)
471	of_node_put(node: args.np);
472	}
473
474	/* Check for missing list property */
475	memset(&args, 0, sizeof(args));
476	rc = of_parse_phandle_with_args(np, list_name: "phandle-list-missing",
477	cells_name: "#phandle-cells", index: 0, out_args: &args);
478	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
479	rc = of_count_phandle_with_args(np, list_name: "phandle-list-missing",
480	cells_name: "#phandle-cells");
481	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
482
483	/* Check for missing cells property */
484	memset(&args, 0, sizeof(args));
485
486	EXPECT_BEGIN(KERN_INFO,
487	"OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
488
489	rc = of_parse_phandle_with_args(np, list_name: "phandle-list",
490	cells_name: "#phandle-cells-missing", index: 0, out_args: &args);
491
492	EXPECT_END(KERN_INFO,
493	"OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
494
495	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
496
497	EXPECT_BEGIN(KERN_INFO,
498	"OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
499
500	rc = of_count_phandle_with_args(np, list_name: "phandle-list",
501	cells_name: "#phandle-cells-missing");
502
503	EXPECT_END(KERN_INFO,
504	"OF: /testcase-data/phandle-tests/consumer-a: could not get #phandle-cells-missing for /testcase-data/phandle-tests/provider1");
505
506	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
507
508	/* Check for bad phandle in list */
509	memset(&args, 0, sizeof(args));
510
511	EXPECT_BEGIN(KERN_INFO,
512	"OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
513
514	rc = of_parse_phandle_with_args(np, list_name: "phandle-list-bad-phandle",
515	cells_name: "#phandle-cells", index: 0, out_args: &args);
516
517	EXPECT_END(KERN_INFO,
518	"OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
519
520	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
521
522	EXPECT_BEGIN(KERN_INFO,
523	"OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
524
525	rc = of_count_phandle_with_args(np, list_name: "phandle-list-bad-phandle",
526	cells_name: "#phandle-cells");
527
528	EXPECT_END(KERN_INFO,
529	"OF: /testcase-data/phandle-tests/consumer-a: could not find phandle");
530
531	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
532
533	/* Check for incorrectly formed argument list */
534	memset(&args, 0, sizeof(args));
535
536	EXPECT_BEGIN(KERN_INFO,
537	"OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
538
539	rc = of_parse_phandle_with_args(np, list_name: "phandle-list-bad-args",
540	cells_name: "#phandle-cells", index: 1, out_args: &args);
541
542	EXPECT_END(KERN_INFO,
543	"OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
544
545	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
546
547	EXPECT_BEGIN(KERN_INFO,
548	"OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
549
550	rc = of_count_phandle_with_args(np, list_name: "phandle-list-bad-args",
551	cells_name: "#phandle-cells");
552
553	EXPECT_END(KERN_INFO,
554	"OF: /testcase-data/phandle-tests/consumer-a: #phandle-cells = 3 found 1");
555
556	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
557	}
558
559	static void __init of_unittest_parse_phandle_with_args_map(void)
560	{
561	struct device_node *np, *p[6] = {};
562	struct of_phandle_args args;
563	unsigned int prefs[6];
564	int i, rc;
565
566	np = of_find_node_by_path(path: "/testcase-data/phandle-tests/consumer-b");
567	if (!np) {
568	pr_err("missing testcase data\n");
569	return;
570	}
571
572	p[0] = of_find_node_by_path(path: "/testcase-data/phandle-tests/provider0");
573	p[1] = of_find_node_by_path(path: "/testcase-data/phandle-tests/provider1");
574	p[2] = of_find_node_by_path(path: "/testcase-data/phandle-tests/provider2");
575	p[3] = of_find_node_by_path(path: "/testcase-data/phandle-tests/provider3");
576	p[4] = of_find_node_by_path(path: "/testcase-data/phandle-tests/provider4");
577	p[5] = of_find_node_by_path(path: "/testcase-data/phandle-tests/provider5");
578	for (i = 0; i < ARRAY_SIZE(p); ++i) {
579	if (!p[i]) {
580	pr_err("missing testcase data\n");
581	return;
582	}
583	prefs[i] = OF_KREF_READ(p[i]);
584	}
585
586	rc = of_count_phandle_with_args(np, list_name: "phandle-list", cells_name: "#phandle-cells");
587	unittest(rc == 8, "of_count_phandle_with_args() returned %i, expected 8\n", rc);
588
589	for (i = 0; i < 9; i++) {
590	bool passed = true;
591
592	memset(&args, 0, sizeof(args));
593	rc = of_parse_phandle_with_args_map(np, list_name: "phandle-list",
594	stem_name: "phandle", index: i, out_args: &args);
595
596	/* Test the values from tests-phandle.dtsi */
597	switch (i) {
598	case 0:
599	passed &= !rc;
600	passed &= (args.np == p[1]);
601	passed &= (args.args_count == 1);
602	passed &= (args.args[0] == 1);
603	break;
604	case 1:
605	passed &= !rc;
606	passed &= (args.np == p[3]);
607	passed &= (args.args_count == 3);
608	passed &= (args.args[0] == 2);
609	passed &= (args.args[1] == 5);
610	passed &= (args.args[2] == 3);
611	break;
612	case 2:
613	passed &= (rc == -ENOENT);
614	break;
615	case 3:
616	passed &= !rc;
617	passed &= (args.np == p[0]);
618	passed &= (args.args_count == 0);
619	break;
620	case 4:
621	passed &= !rc;
622	passed &= (args.np == p[1]);
623	passed &= (args.args_count == 1);
624	passed &= (args.args[0] == 3);
625	break;
626	case 5:
627	passed &= !rc;
628	passed &= (args.np == p[0]);
629	passed &= (args.args_count == 0);
630	break;
631	case 6:
632	passed &= !rc;
633	passed &= (args.np == p[2]);
634	passed &= (args.args_count == 2);
635	passed &= (args.args[0] == 15);
636	passed &= (args.args[1] == 0x20);
637	break;
638	case 7:
639	passed &= !rc;
640	passed &= (args.np == p[3]);
641	passed &= (args.args_count == 3);
642	passed &= (args.args[0] == 2);
643	passed &= (args.args[1] == 5);
644	passed &= (args.args[2] == 3);
645	break;
646	case 8:
647	passed &= (rc == -ENOENT);
648	break;
649	default:
650	passed = false;
651	}
652
653	unittest(passed, "index %i - data error on node %s rc=%i\n",
654	i, args.np->full_name, rc);
655
656	if (rc == 0)
657	of_node_put(node: args.np);
658	}
659
660	/* Check for missing list property */
661	memset(&args, 0, sizeof(args));
662	rc = of_parse_phandle_with_args_map(np, list_name: "phandle-list-missing",
663	stem_name: "phandle", index: 0, out_args: &args);
664	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
665
666	/* Check for missing cells,map,mask property */
667	memset(&args, 0, sizeof(args));
668
669	EXPECT_BEGIN(KERN_INFO,
670	"OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
671
672	rc = of_parse_phandle_with_args_map(np, list_name: "phandle-list",
673	stem_name: "phandle-missing", index: 0, out_args: &args);
674	EXPECT_END(KERN_INFO,
675	"OF: /testcase-data/phandle-tests/consumer-b: could not get #phandle-missing-cells for /testcase-data/phandle-tests/provider1");
676
677	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
678
679	/* Check for bad phandle in list */
680	memset(&args, 0, sizeof(args));
681
682	EXPECT_BEGIN(KERN_INFO,
683	"OF: /testcase-data/phandle-tests/consumer-b: could not find phandle 12345678");
684
685	rc = of_parse_phandle_with_args_map(np, list_name: "phandle-list-bad-phandle",
686	stem_name: "phandle", index: 0, out_args: &args);
687	EXPECT_END(KERN_INFO,
688	"OF: /testcase-data/phandle-tests/consumer-b: could not find phandle 12345678");
689
690	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
691
692	/* Check for incorrectly formed argument list */
693	memset(&args, 0, sizeof(args));
694
695	EXPECT_BEGIN(KERN_INFO,
696	"OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
697
698	rc = of_parse_phandle_with_args_map(np, list_name: "phandle-list-bad-args",
699	stem_name: "phandle", index: 1, out_args: &args);
700	EXPECT_END(KERN_INFO,
701	"OF: /testcase-data/phandle-tests/consumer-b: #phandle-cells = 2 found 1");
702
703	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
704
705	for (i = 0; i < ARRAY_SIZE(p); ++i) {
706	unittest(prefs[i] == OF_KREF_READ(p[i]),
707	"provider%d: expected:%d got:%d\n",
708	i, prefs[i], OF_KREF_READ(p[i]));
709	of_node_put(node: p[i]);
710	}
711	}
712
713	static void __init of_unittest_property_string(void)
714	{
715	const char *strings[4];
716	struct device_node *np;
717	int rc;
718
719	np = of_find_node_by_path(path: "/testcase-data/phandle-tests/consumer-a");
720	if (!np) {
721	pr_err("No testcase data in device tree\n");
722	return;
723	}
724
725	rc = of_property_match_string(np, propname: "phandle-list-names", string: "first");
726	unittest(rc == 0, "first expected:0 got:%i\n", rc);
727	rc = of_property_match_string(np, propname: "phandle-list-names", string: "second");
728	unittest(rc == 1, "second expected:1 got:%i\n", rc);
729	rc = of_property_match_string(np, propname: "phandle-list-names", string: "third");
730	unittest(rc == 2, "third expected:2 got:%i\n", rc);
731	rc = of_property_match_string(np, propname: "phandle-list-names", string: "fourth");
732	unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
733	rc = of_property_match_string(np, propname: "missing-property", string: "blah");
734	unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
735	rc = of_property_match_string(np, propname: "empty-property", string: "blah");
736	unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
737	rc = of_property_match_string(np, propname: "unterminated-string", string: "blah");
738	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
739
740	/* of_property_count_strings() tests */
741	rc = of_property_count_strings(np, propname: "string-property");
742	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
743	rc = of_property_count_strings(np, propname: "phandle-list-names");
744	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
745	rc = of_property_count_strings(np, propname: "unterminated-string");
746	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
747	rc = of_property_count_strings(np, propname: "unterminated-string-list");
748	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
749
750	/* of_property_read_string_index() tests */
751	rc = of_property_read_string_index(np, propname: "string-property", index: 0, output: strings);
752	unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
753	strings[0] = NULL;
754	rc = of_property_read_string_index(np, propname: "string-property", index: 1, output: strings);
755	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
756	rc = of_property_read_string_index(np, propname: "phandle-list-names", index: 0, output: strings);
757	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
758	rc = of_property_read_string_index(np, propname: "phandle-list-names", index: 1, output: strings);
759	unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
760	rc = of_property_read_string_index(np, propname: "phandle-list-names", index: 2, output: strings);
761	unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
762	strings[0] = NULL;
763	rc = of_property_read_string_index(np, propname: "phandle-list-names", index: 3, output: strings);
764	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
765	strings[0] = NULL;
766	rc = of_property_read_string_index(np, propname: "unterminated-string", index: 0, output: strings);
767	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
768	rc = of_property_read_string_index(np, propname: "unterminated-string-list", index: 0, output: strings);
769	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
770	strings[0] = NULL;
771	rc = of_property_read_string_index(np, propname: "unterminated-string-list", index: 2, output: strings); /* should fail */
772	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
773	strings[1] = NULL;
774
775	/* of_property_read_string_array() tests */
776	rc = of_property_read_string_array(np, propname: "string-property", out_strs: strings, sz: 4);
777	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
778	rc = of_property_read_string_array(np, propname: "phandle-list-names", out_strs: strings, sz: 4);
779	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
780	rc = of_property_read_string_array(np, propname: "unterminated-string", out_strs: strings, sz: 4);
781	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
782	/* -- An incorrectly formed string should cause a failure */
783	rc = of_property_read_string_array(np, propname: "unterminated-string-list", out_strs: strings, sz: 4);
784	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
785	/* -- parsing the correctly formed strings should still work: */
786	strings[2] = NULL;
787	rc = of_property_read_string_array(np, propname: "unterminated-string-list", out_strs: strings, sz: 2);
788	unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
789	strings[1] = NULL;
790	rc = of_property_read_string_array(np, propname: "phandle-list-names", out_strs: strings, sz: 1);
791	unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
792	}
793
794	#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
795	(p1)->value && (p2)->value && \
796	!memcmp((p1)->value, (p2)->value, (p1)->length) && \
797	!strcmp((p1)->name, (p2)->name))
798	static void __init of_unittest_property_copy(void)
799	{
800	#ifdef CONFIG_OF_DYNAMIC
801	struct property p1 = { .name = "p1", .length = 0, .value = "" };
802	struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
803	struct property *new;
804
805	new = __of_prop_dup(prop: &p1, GFP_KERNEL);
806	unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
807	__of_prop_free(prop: new);
808
809	new = __of_prop_dup(prop: &p2, GFP_KERNEL);
810	unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
811	__of_prop_free(prop: new);
812	#endif
813	}
814
815	static void __init of_unittest_changeset(void)
816	{
817	#ifdef CONFIG_OF_DYNAMIC
818	int ret;
819	struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
820	struct property *ppname_n1, pname_n1 = { .name = "name", .length = 3, .value = "n1" };
821	struct property *ppname_n2, pname_n2 = { .name = "name", .length = 3, .value = "n2" };
822	struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
823	struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
824	struct property *ppremove;
825	struct device_node *n1, *n2, *n21, *n22, *nchangeset, *nremove, *parent, *np;
826	static const char * const str_array[] = { "str1", "str2", "str3" };
827	const u32 u32_array[] = { 1, 2, 3 };
828	struct of_changeset chgset;
829	const char *propstr = NULL;
830
831	n1 = __of_node_dup(NULL, full_name: "n1");
832	unittest(n1, "testcase setup failure\n");
833
834	n2 = __of_node_dup(NULL, full_name: "n2");
835	unittest(n2, "testcase setup failure\n");
836
837	n21 = __of_node_dup(NULL, full_name: "n21");
838	unittest(n21, "testcase setup failure %p\n", n21);
839
840	nchangeset = of_find_node_by_path(path: "/testcase-data/changeset");
841	nremove = of_get_child_by_name(node: nchangeset, name: "node-remove");
842	unittest(nremove, "testcase setup failure\n");
843
844	ppadd = __of_prop_dup(prop: &padd, GFP_KERNEL);
845	unittest(ppadd, "testcase setup failure\n");
846
847	ppname_n1 = __of_prop_dup(prop: &pname_n1, GFP_KERNEL);
848	unittest(ppname_n1, "testcase setup failure\n");
849
850	ppname_n2 = __of_prop_dup(prop: &pname_n2, GFP_KERNEL);
851	unittest(ppname_n2, "testcase setup failure\n");
852
853	ppname_n21 = __of_prop_dup(prop: &pname_n21, GFP_KERNEL);
854	unittest(ppname_n21, "testcase setup failure\n");
855
856	ppupdate = __of_prop_dup(prop: &pupdate, GFP_KERNEL);
857	unittest(ppupdate, "testcase setup failure\n");
858
859	parent = nchangeset;
860	n1->parent = parent;
861	n2->parent = parent;
862	n21->parent = n2;
863
864	ppremove = of_find_property(np: parent, name: "prop-remove", NULL);
865	unittest(ppremove, "failed to find removal prop");
866
867	of_changeset_init(ocs: &chgset);
868
869	unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
870	unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
871
872	unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
873	unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
874
875	unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
876	unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
877
878	unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
879
880	unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
881	unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
882	unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
883	n22 = of_changeset_create_node(ocs: &chgset, parent: n2, full_name: "n22");
884	unittest(n22, "fail create n22\n");
885	unittest(!of_changeset_add_prop_string(&chgset, n22, "prop-str", "abcd"),
886	"fail add prop prop-str");
887	unittest(!of_changeset_add_prop_string_array(&chgset, n22, "prop-str-array",
888	(const char **)str_array,
889	ARRAY_SIZE(str_array)),
890	"fail add prop prop-str-array");
891	unittest(!of_changeset_add_prop_u32_array(&chgset, n22, "prop-u32-array",
892	u32_array, ARRAY_SIZE(u32_array)),
893	"fail add prop prop-u32-array");
894
895	unittest(!of_changeset_apply(&chgset), "apply failed\n");
896
897	of_node_put(node: nchangeset);
898
899	/* Make sure node names are constructed correctly */
900	unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
901	"'%pOF' not added\n", n21);
902	of_node_put(node: np);
903	unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n22")),
904	"'%pOF' not added\n", n22);
905	of_node_put(node: np);
906
907	unittest(!of_changeset_revert(&chgset), "revert failed\n");
908
909	unittest(!of_find_node_by_path("/testcase-data/changeset/n2/n21"),
910	"'%pOF' still present after revert\n", n21);
911
912	unittest(of_property_present(parent, "prop-remove"),
913	"failed to find removed prop after revert\n");
914
915	ret = of_property_read_string(np: parent, propname: "prop-update", out_string: &propstr);
916	unittest(!ret, "failed to find updated prop after revert\n");
917	if (!ret)
918	unittest(strcmp(propstr, "hello") == 0, "original value not in updated property after revert");
919
920	of_changeset_destroy(ocs: &chgset);
921
922	of_node_put(node: n1);
923	of_node_put(node: n2);
924	of_node_put(node: n21);
925	of_node_put(node: n22);
926	#endif
927	}
928
929	static void __init __maybe_unused changeset_check_string(struct device_node *np,
930	const char *prop_name,
931	const char *expected_str)
932	{
933	const char *str;
934	int ret;
935
936	ret = of_property_read_string(np, propname: prop_name, out_string: &str);
937	if (unittest(ret == 0, "failed to read %s\n", prop_name))
938	return;
939
940	unittest(strcmp(str, expected_str) == 0,
941	"%s value mismatch (read '%s', exp '%s')\n",
942	prop_name, str, expected_str);
943	}
944
945	static void __init __maybe_unused changeset_check_string_array(struct device_node *np,
946	const char *prop_name,
947	const char * const *expected_array,
948	unsigned int count)
949	{
950	const char *str;
951	unsigned int i;
952	int ret;
953	int cnt;
954
955	cnt = of_property_count_strings(np, propname: prop_name);
956	if (unittest(cnt >= 0, "failed to get %s count\n", prop_name))
957	return;
958
959	if (unittest(cnt == count,
960	"%s count mismatch (read %d, exp %u)\n",
961	prop_name, cnt, count))
962	return;
963
964	for (i = 0; i < count; i++) {
965	ret = of_property_read_string_index(np, propname: prop_name, index: i, output: &str);
966	if (unittest(ret == 0, "failed to read %s[%d]\n", prop_name, i))
967	continue;
968
969	unittest(strcmp(str, expected_array[i]) == 0,
970	"%s[%d] value mismatch (read '%s', exp '%s')\n",
971	prop_name, i, str, expected_array[i]);
972	}
973	}
974
975	static void __init __maybe_unused changeset_check_u32(struct device_node *np,
976	const char *prop_name,
977	u32 expected_u32)
978	{
979	u32 val32;
980	int ret;
981
982	ret = of_property_read_u32(np, propname: prop_name, out_value: &val32);
983	if (unittest(ret == 0, "failed to read %s\n", prop_name))
984	return;
985
986	unittest(val32 == expected_u32,
987	"%s value mismatch (read '%u', exp '%u')\n",
988	prop_name, val32, expected_u32);
989	}
990
991	static void __init __maybe_unused changeset_check_u32_array(struct device_node *np,
992	const char *prop_name,
993	const u32 *expected_array,
994	unsigned int count)
995	{
996	unsigned int i;
997	u32 val32;
998	int ret;
999	int cnt;
1000
1001	cnt = of_property_count_u32_elems(np, propname: prop_name);
1002	if (unittest(cnt >= 0, "failed to get %s count\n", prop_name))
1003	return;
1004
1005	if (unittest(cnt == count,
1006	"%s count mismatch (read %d, exp %u)\n",
1007	prop_name, cnt, count))
1008	return;
1009
1010	for (i = 0; i < count; i++) {
1011	ret = of_property_read_u32_index(np, propname: prop_name, index: i, out_value: &val32);
1012	if (unittest(ret == 0, "failed to read %s[%d]\n", prop_name, i))
1013	continue;
1014
1015	unittest(val32 == expected_array[i],
1016	"%s[%d] value mismatch (read '%u', exp '%u')\n",
1017	prop_name, i, val32, expected_array[i]);
1018	}
1019	}
1020
1021	static void __init __maybe_unused changeset_check_bool(struct device_node *np,
1022	const char *prop_name)
1023	{
1024	unittest(of_property_read_bool(np, prop_name),
1025	"%s value mismatch (read 'false', exp 'true')\n", prop_name);
1026	}
1027
1028	static void __init of_unittest_changeset_prop(void)
1029	{
1030	#ifdef CONFIG_OF_DYNAMIC
1031	static const char * const str_array[] = { "abc", "defg", "hij" };
1032	static const u32 u32_array[] = { 123, 4567, 89, 10, 11 };
1033	struct device_node *nchangeset, *np;
1034	struct of_changeset chgset;
1035	int ret;
1036
1037	nchangeset = of_find_node_by_path(path: "/testcase-data/changeset");
1038	if (!nchangeset) {
1039	pr_err("missing testcase data\n");
1040	return;
1041	}
1042
1043	of_changeset_init(ocs: &chgset);
1044
1045	np = of_changeset_create_node(ocs: &chgset, parent: nchangeset, full_name: "test-prop");
1046	if (unittest(np, "failed to create test-prop node\n"))
1047	goto end_changeset_destroy;
1048
1049	ret = of_changeset_add_prop_string(ocs: &chgset, np, prop_name: "prop-string", str: "abcde");
1050	unittest(ret == 0, "failed to add prop-string\n");
1051
1052	ret = of_changeset_add_prop_string_array(ocs: &chgset, np, prop_name: "prop-string-array",
1053	str_array, ARRAY_SIZE(str_array));
1054	unittest(ret == 0, "failed to add prop-string-array\n");
1055
1056	ret = of_changeset_add_prop_u32(ocs: &chgset, np, prop_name: "prop-u32", val: 1234);
1057	unittest(ret == 0, "failed to add prop-u32\n");
1058
1059	ret = of_changeset_add_prop_u32_array(ocs: &chgset, np, prop_name: "prop-u32-array",
1060	array: u32_array, ARRAY_SIZE(u32_array));
1061	unittest(ret == 0, "failed to add prop-u32-array\n");
1062
1063	ret = of_changeset_add_prop_bool(ocs: &chgset, np, prop_name: "prop-bool");
1064	unittest(ret == 0, "failed to add prop-bool\n");
1065
1066	of_node_put(node: np);
1067
1068	ret = of_changeset_apply(ocs: &chgset);
1069	if (unittest(ret == 0, "failed to apply changeset\n"))
1070	goto end_changeset_destroy;
1071
1072	np = of_find_node_by_path(path: "/testcase-data/changeset/test-prop");
1073	if (unittest(np, "failed to find test-prop node\n"))
1074	goto end_revert_changeset;
1075
1076	changeset_check_string(np, prop_name: "prop-string", expected_str: "abcde");
1077	changeset_check_string_array(np, prop_name: "prop-string-array", expected_array: str_array, ARRAY_SIZE(str_array));
1078	changeset_check_u32(np, prop_name: "prop-u32", expected_u32: 1234);
1079	changeset_check_u32_array(np, prop_name: "prop-u32-array", expected_array: u32_array, ARRAY_SIZE(u32_array));
1080	changeset_check_bool(np, prop_name: "prop-bool");
1081
1082	of_node_put(node: np);
1083
1084	end_revert_changeset:
1085	ret = of_changeset_revert(ocs: &chgset);
1086	unittest(ret == 0, "failed to revert changeset\n");
1087
1088	end_changeset_destroy:
1089	of_changeset_destroy(ocs: &chgset);
1090	of_node_put(node: nchangeset);
1091	#endif
1092	}
1093
1094	static void __init of_unittest_dma_get_max_cpu_address(void)
1095	{
1096	struct device_node *np;
1097	phys_addr_t cpu_addr;
1098
1099	if (!IS_ENABLED(CONFIG_OF_ADDRESS))
1100	return;
1101
1102	np = of_find_node_by_path(path: "/testcase-data/address-tests");
1103	if (!np) {
1104	pr_err("missing testcase data\n");
1105	return;
1106	}
1107
1108	cpu_addr = of_dma_get_max_cpu_address(np);
1109	unittest(cpu_addr == 0x4fffffff,
1110	"of_dma_get_max_cpu_address: wrong CPU addr %pad (expecting %x)\n",
1111	&cpu_addr, 0x4fffffff);
1112	}
1113
1114	static void __init of_unittest_dma_ranges_one(const char *path,
1115	u64 expect_dma_addr, u64 expect_paddr)
1116	{
1117	#ifdef CONFIG_HAS_DMA
1118	struct device_node *np;
1119	const struct bus_dma_region *map = NULL;
1120	int rc;
1121
1122	np = of_find_node_by_path(path);
1123	if (!np) {
1124	pr_err("missing testcase data\n");
1125	return;
1126	}
1127
1128	rc = of_dma_get_range(np, map: &map);
1129
1130	unittest(!rc, "of_dma_get_range failed on node %pOF rc=%i\n", np, rc);
1131
1132	if (!rc) {
1133	phys_addr_t paddr;
1134	dma_addr_t dma_addr;
1135	struct device *dev_bogus;
1136
1137	dev_bogus = kzalloc(sizeof(struct device), GFP_KERNEL);
1138	if (!dev_bogus) {
1139	unittest(0, "kzalloc() failed\n");
1140	kfree(objp: map);
1141	return;
1142	}
1143
1144	dev_bogus->dma_range_map = map;
1145	paddr = dma_to_phys(dev: dev_bogus, dma_addr: expect_dma_addr);
1146	dma_addr = phys_to_dma(dev: dev_bogus, paddr: expect_paddr);
1147
1148	unittest(paddr == expect_paddr,
1149	"of_dma_get_range: wrong phys addr %pap (expecting %llx) on node %pOF\n",
1150	&paddr, expect_paddr, np);
1151	unittest(dma_addr == expect_dma_addr,
1152	"of_dma_get_range: wrong DMA addr %pad (expecting %llx) on node %pOF\n",
1153	&dma_addr, expect_dma_addr, np);
1154
1155	kfree(objp: map);
1156	kfree(objp: dev_bogus);
1157	}
1158	of_node_put(node: np);
1159	#endif
1160	}
1161
1162	static void __init of_unittest_parse_dma_ranges(void)
1163	{
1164	of_unittest_dma_ranges_one(path: "/testcase-data/address-tests/device@70000000",
1165	expect_dma_addr: 0x0, expect_paddr: 0x20000000);
1166	if (IS_ENABLED(CONFIG_ARCH_DMA_ADDR_T_64BIT))
1167	of_unittest_dma_ranges_one(path: "/testcase-data/address-tests/bus@80000000/device@1000",
1168	expect_dma_addr: 0x100000000, expect_paddr: 0x20000000);
1169	of_unittest_dma_ranges_one(path: "/testcase-data/address-tests/pci@90000000",
1170	expect_dma_addr: 0x80000000, expect_paddr: 0x20000000);
1171	}
1172
1173	static void __init of_unittest_pci_dma_ranges(void)
1174	{
1175	struct device_node *np;
1176	struct of_pci_range range;
1177	struct of_pci_range_parser parser;
1178	int i = 0;
1179
1180	if (!IS_ENABLED(CONFIG_PCI))
1181	return;
1182
1183	np = of_find_node_by_path(path: "/testcase-data/address-tests/pci@90000000");
1184	if (!np) {
1185	pr_err("missing testcase data\n");
1186	return;
1187	}
1188
1189	if (of_pci_dma_range_parser_init(parser: &parser, node: np)) {
1190	pr_err("missing dma-ranges property\n");
1191	return;
1192	}
1193
1194	/*
1195	* Get the dma-ranges from the device tree
1196	*/
1197	for_each_of_pci_range(&parser, &range) {
1198	if (!i) {
1199	unittest(range.size == 0x10000000,
1200	"for_each_of_pci_range wrong size on node %pOF size=%llx\n",
1201	np, range.size);
1202	unittest(range.cpu_addr == 0x20000000,
1203	"for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
1204	range.cpu_addr, np);
1205	unittest(range.pci_addr == 0x80000000,
1206	"for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1207	range.pci_addr, np);
1208	} else {
1209	unittest(range.size == 0x10000000,
1210	"for_each_of_pci_range wrong size on node %pOF size=%llx\n",
1211	np, range.size);
1212	unittest(range.cpu_addr == 0x40000000,
1213	"for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
1214	range.cpu_addr, np);
1215	unittest(range.pci_addr == 0xc0000000,
1216	"for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1217	range.pci_addr, np);
1218	}
1219	i++;
1220	}
1221
1222	of_node_put(node: np);
1223	}
1224
1225	static void __init of_unittest_pci_empty_dma_ranges(void)
1226	{
1227	struct device_node *np;
1228	struct of_pci_range range;
1229	struct of_pci_range_parser parser;
1230
1231	if (!IS_ENABLED(CONFIG_PCI))
1232	return;
1233
1234	np = of_find_node_by_path(path: "/testcase-data/address-tests2/pcie@d1070000/pci@0,0/dev@0,0/local-bus@0");
1235	if (!np) {
1236	pr_err("missing testcase data\n");
1237	return;
1238	}
1239
1240	if (of_pci_dma_range_parser_init(parser: &parser, node: np)) {
1241	pr_err("missing dma-ranges property\n");
1242	return;
1243	}
1244
1245	/*
1246	* Get the dma-ranges from the device tree
1247	*/
1248	for_each_of_pci_range(&parser, &range) {
1249	unittest(range.size == 0x10000000,
1250	"for_each_of_pci_range wrong size on node %pOF size=%llx\n",
1251	np, range.size);
1252	unittest(range.cpu_addr == 0x00000000,
1253	"for_each_of_pci_range wrong CPU addr (%llx) on node %pOF",
1254	range.cpu_addr, np);
1255	unittest(range.pci_addr == 0xc0000000,
1256	"for_each_of_pci_range wrong DMA addr (%llx) on node %pOF",
1257	range.pci_addr, np);
1258	}
1259
1260	of_node_put(node: np);
1261	}
1262
1263	static void __init of_unittest_bus_ranges(void)
1264	{
1265	struct device_node *np;
1266	struct of_range range;
1267	struct of_range_parser parser;
1268	struct resource res;
1269	int ret, count, i = 0;
1270
1271	np = of_find_node_by_path(path: "/testcase-data/address-tests");
1272	if (!np) {
1273	pr_err("missing testcase data\n");
1274	return;
1275	}
1276
1277	if (of_range_parser_init(parser: &parser, node: np)) {
1278	pr_err("missing ranges property\n");
1279	return;
1280	}
1281
1282	ret = of_range_to_resource(np, index: 1, res: &res);
1283	unittest(!ret, "of_range_to_resource returned error (%d) node %pOF\n",
1284	ret, np);
1285	unittest(resource_type(&res) == IORESOURCE_MEM,
1286	"of_range_to_resource wrong resource type on node %pOF res=%pR\n",
1287	np, &res);
1288	unittest(res.start == 0xd0000000,
1289	"of_range_to_resource wrong resource start address on node %pOF res=%pR\n",
1290	np, &res);
1291	unittest(resource_size(&res) == 0x20000000,
1292	"of_range_to_resource wrong resource start address on node %pOF res=%pR\n",
1293	np, &res);
1294
1295	count = of_range_count(parser: &parser);
1296	unittest(count == 2,
1297	"of_range_count wrong size on node %pOF count=%d\n",
1298	np, count);
1299
1300	/*
1301	* Get the "ranges" from the device tree
1302	*/
1303	for_each_of_range(&parser, &range) {
1304	unittest(range.flags == IORESOURCE_MEM,
1305	"for_each_of_range wrong flags on node %pOF flags=%x (expected %x)\n",
1306	np, range.flags, IORESOURCE_MEM);
1307	if (!i) {
1308	unittest(range.size == 0x50000000,
1309	"for_each_of_range wrong size on node %pOF size=%llx\n",
1310	np, range.size);
1311	unittest(range.cpu_addr == 0x70000000,
1312	"for_each_of_range wrong CPU addr (%llx) on node %pOF",
1313	range.cpu_addr, np);
1314	unittest(range.bus_addr == 0x70000000,
1315	"for_each_of_range wrong bus addr (%llx) on node %pOF",
1316	range.pci_addr, np);
1317	} else {
1318	unittest(range.size == 0x20000000,
1319	"for_each_of_range wrong size on node %pOF size=%llx\n",
1320	np, range.size);
1321	unittest(range.cpu_addr == 0xd0000000,
1322	"for_each_of_range wrong CPU addr (%llx) on node %pOF",
1323	range.cpu_addr, np);
1324	unittest(range.bus_addr == 0x00000000,
1325	"for_each_of_range wrong bus addr (%llx) on node %pOF",
1326	range.pci_addr, np);
1327	}
1328	i++;
1329	}
1330
1331	of_node_put(node: np);
1332	}
1333
1334	static void __init of_unittest_bus_3cell_ranges(void)
1335	{
1336	struct device_node *np;
1337	struct of_range range;
1338	struct of_range_parser parser;
1339	int i = 0;
1340
1341	np = of_find_node_by_path(path: "/testcase-data/address-tests/bus@a0000000");
1342	if (!np) {
1343	pr_err("missing testcase data\n");
1344	return;
1345	}
1346
1347	if (of_range_parser_init(parser: &parser, node: np)) {
1348	pr_err("missing ranges property\n");
1349	return;
1350	}
1351
1352	/*
1353	* Get the "ranges" from the device tree
1354	*/
1355	for_each_of_range(&parser, &range) {
1356	if (!i) {
1357	unittest(range.flags == 0xf00baa,
1358	"for_each_of_range wrong flags on node %pOF flags=%x\n",
1359	np, range.flags);
1360	unittest(range.size == 0x100000,
1361	"for_each_of_range wrong size on node %pOF size=%llx\n",
1362	np, range.size);
1363	unittest(range.cpu_addr == 0xa0000000,
1364	"for_each_of_range wrong CPU addr (%llx) on node %pOF",
1365	range.cpu_addr, np);
1366	unittest(range.bus_addr == 0x0,
1367	"for_each_of_range wrong bus addr (%llx) on node %pOF",
1368	range.pci_addr, np);
1369	} else {
1370	unittest(range.flags == 0xf00bee,
1371	"for_each_of_range wrong flags on node %pOF flags=%x\n",
1372	np, range.flags);
1373	unittest(range.size == 0x200000,
1374	"for_each_of_range wrong size on node %pOF size=%llx\n",
1375	np, range.size);
1376	unittest(range.cpu_addr == 0xb0000000,
1377	"for_each_of_range wrong CPU addr (%llx) on node %pOF",
1378	range.cpu_addr, np);
1379	unittest(range.bus_addr == 0x100000000,
1380	"for_each_of_range wrong bus addr (%llx) on node %pOF",
1381	range.pci_addr, np);
1382	}
1383	i++;
1384	}
1385
1386	of_node_put(node: np);
1387	}
1388
1389	static void __init of_unittest_reg(void)
1390	{
1391	struct device_node *np;
1392	struct resource res;
1393	int ret;
1394	u64 addr, size;
1395
1396	np = of_find_node_by_path(path: "/testcase-data/address-tests/bus@80000000/device@1000");
1397	if (!np) {
1398	pr_err("missing testcase data\n");
1399	return;
1400	}
1401
1402	ret = of_property_read_reg(np, idx: 0, addr: &addr, size: &size);
1403	unittest(!ret, "of_property_read_reg(%pOF) returned error %d\n",
1404	np, ret);
1405	unittest(addr == 0x1000, "of_property_read_reg(%pOF) untranslated address (%llx) incorrect\n",
1406	np, addr);
1407
1408	of_node_put(node: np);
1409
1410	np = of_find_node_by_path(path: "/testcase-data/platform-tests-2/node/test-device@100");
1411	if (!np) {
1412	pr_err("missing testcase data\n");
1413	return;
1414	}
1415
1416	ret = of_address_to_resource(dev: np, index: 0, r: &res);
1417	unittest(ret == -EINVAL, "of_address_to_resource(%pOF) expected error on untranslatable address\n",
1418	np);
1419
1420	of_node_put(node: np);
1421
1422	}
1423
1424	struct of_unittest_expected_res {
1425	int index;
1426	struct resource res;
1427	};
1428
1429	static void __init of_unittest_check_addr(const char *node_path,
1430	const struct of_unittest_expected_res *tab_exp,
1431	unsigned int tab_exp_count)
1432	{
1433	const struct of_unittest_expected_res *expected;
1434	struct device_node *np;
1435	struct resource res;
1436	unsigned int count;
1437	int ret;
1438
1439	if (!IS_ENABLED(CONFIG_OF_ADDRESS))
1440	return;
1441
1442	np = of_find_node_by_path(path: node_path);
1443	if (!np) {
1444	pr_err("missing testcase data (%s)\n", node_path);
1445	return;
1446	}
1447
1448	expected = tab_exp;
1449	count = tab_exp_count;
1450	while (count--) {
1451	ret = of_address_to_resource(dev: np, index: expected->index, r: &res);
1452	unittest(!ret, "of_address_to_resource(%pOF, %d) returned error %d\n",
1453	np, expected->index, ret);
1454	unittest(resource_type(&res) == resource_type(&expected->res) &&
1455	res.start == expected->res.start &&
1456	resource_size(&res) == resource_size(&expected->res),
1457	"of_address_to_resource(%pOF, %d) wrong resource %pR, expected %pR\n",
1458	np, expected->index, &res, &expected->res);
1459	expected++;
1460	}
1461
1462	of_node_put(node: np);
1463	}
1464
1465	static const struct of_unittest_expected_res of_unittest_reg_2cell_expected_res[] = {
1466	{.index = 0, .res = DEFINE_RES_MEM(0xa0a01000, 0x100) },
1467	{.index = 1, .res = DEFINE_RES_MEM(0xa0a02000, 0x100) },
1468	{.index = 2, .res = DEFINE_RES_MEM(0xc0c01000, 0x100) },
1469	{.index = 3, .res = DEFINE_RES_MEM(0xd0d01000, 0x100) },
1470	};
1471
1472	static const struct of_unittest_expected_res of_unittest_reg_3cell_expected_res[] = {
1473	{.index = 0, .res = DEFINE_RES_MEM(0xa0a01000, 0x100) },
1474	{.index = 1, .res = DEFINE_RES_MEM(0xa0b02000, 0x100) },
1475	{.index = 2, .res = DEFINE_RES_MEM(0xc0c01000, 0x100) },
1476	{.index = 3, .res = DEFINE_RES_MEM(0xc0c09000, 0x100) },
1477	{.index = 4, .res = DEFINE_RES_MEM(0xd0d01000, 0x100) },
1478	};
1479
1480	static const struct of_unittest_expected_res of_unittest_reg_pci_expected_res[] = {
1481	{.index = 0, .res = DEFINE_RES_MEM(0xe8001000, 0x1000) },
1482	{.index = 1, .res = DEFINE_RES_MEM(0xea002000, 0x2000) },
1483	};
1484
1485	static void __init of_unittest_translate_addr(void)
1486	{
1487	of_unittest_check_addr(node_path: "/testcase-data/address-tests2/bus-2cell@10000000/device@100000",
1488	tab_exp: of_unittest_reg_2cell_expected_res,
1489	ARRAY_SIZE(of_unittest_reg_2cell_expected_res));
1490
1491	of_unittest_check_addr(node_path: "/testcase-data/address-tests2/bus-3cell@20000000/local-bus@100000/device@f1001000",
1492	tab_exp: of_unittest_reg_3cell_expected_res,
1493	ARRAY_SIZE(of_unittest_reg_3cell_expected_res));
1494
1495	of_unittest_check_addr(node_path: "/testcase-data/address-tests2/pcie@d1070000/pci@0,0/dev@0,0/local-bus@0/dev@e0000000",
1496	tab_exp: of_unittest_reg_pci_expected_res,
1497	ARRAY_SIZE(of_unittest_reg_pci_expected_res));
1498	}
1499
1500	static void __init of_unittest_parse_interrupts(void)
1501	{
1502	struct device_node *np;
1503	struct of_phandle_args args;
1504	int i, rc;
1505
1506	if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1507	return;
1508
1509	np = of_find_node_by_path(path: "/testcase-data/interrupts/interrupts0");
1510	if (!np) {
1511	pr_err("missing testcase data\n");
1512	return;
1513	}
1514
1515	for (i = 0; i < 4; i++) {
1516	bool passed = true;
1517
1518	memset(&args, 0, sizeof(args));
1519	rc = of_irq_parse_one(device: np, index: i, out_irq: &args);
1520
1521	passed &= !rc;
1522	passed &= (args.args_count == 1);
1523	passed &= (args.args[0] == (i + 1));
1524
1525	unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1526	i, args.np, rc);
1527	}
1528	of_node_put(node: np);
1529
1530	np = of_find_node_by_path(path: "/testcase-data/interrupts/interrupts1");
1531	if (!np) {
1532	pr_err("missing testcase data\n");
1533	return;
1534	}
1535
1536	for (i = 0; i < 4; i++) {
1537	bool passed = true;
1538
1539	memset(&args, 0, sizeof(args));
1540	rc = of_irq_parse_one(device: np, index: i, out_irq: &args);
1541
1542	/* Test the values from tests-phandle.dtsi */
1543	switch (i) {
1544	case 0:
1545	passed &= !rc;
1546	passed &= (args.args_count == 1);
1547	passed &= (args.args[0] == 9);
1548	break;
1549	case 1:
1550	passed &= !rc;
1551	passed &= (args.args_count == 3);
1552	passed &= (args.args[0] == 10);
1553	passed &= (args.args[1] == 11);
1554	passed &= (args.args[2] == 12);
1555	break;
1556	case 2:
1557	passed &= !rc;
1558	passed &= (args.args_count == 2);
1559	passed &= (args.args[0] == 13);
1560	passed &= (args.args[1] == 14);
1561	break;
1562	case 3:
1563	passed &= !rc;
1564	passed &= (args.args_count == 2);
1565	passed &= (args.args[0] == 15);
1566	passed &= (args.args[1] == 16);
1567	break;
1568	default:
1569	passed = false;
1570	}
1571	unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1572	i, args.np, rc);
1573	}
1574	of_node_put(node: np);
1575	}
1576
1577	static void __init of_unittest_parse_interrupts_extended(void)
1578	{
1579	struct device_node *np;
1580	struct of_phandle_args args;
1581	int i, rc;
1582
1583	if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1584	return;
1585
1586	np = of_find_node_by_path(path: "/testcase-data/interrupts/interrupts-extended0");
1587	if (!np) {
1588	pr_err("missing testcase data\n");
1589	return;
1590	}
1591
1592	for (i = 0; i < 7; i++) {
1593	bool passed = true;
1594
1595	memset(&args, 0, sizeof(args));
1596	rc = of_irq_parse_one(device: np, index: i, out_irq: &args);
1597
1598	/* Test the values from tests-phandle.dtsi */
1599	switch (i) {
1600	case 0:
1601	passed &= !rc;
1602	passed &= (args.args_count == 1);
1603	passed &= (args.args[0] == 1);
1604	break;
1605	case 1:
1606	passed &= !rc;
1607	passed &= (args.args_count == 3);
1608	passed &= (args.args[0] == 2);
1609	passed &= (args.args[1] == 3);
1610	passed &= (args.args[2] == 4);
1611	break;
1612	case 2:
1613	passed &= !rc;
1614	passed &= (args.args_count == 2);
1615	passed &= (args.args[0] == 5);
1616	passed &= (args.args[1] == 6);
1617	break;
1618	case 3:
1619	passed &= !rc;
1620	passed &= (args.args_count == 1);
1621	passed &= (args.args[0] == 9);
1622	break;
1623	case 4:
1624	passed &= !rc;
1625	passed &= (args.args_count == 3);
1626	passed &= (args.args[0] == 10);
1627	passed &= (args.args[1] == 11);
1628	passed &= (args.args[2] == 12);
1629	break;
1630	case 5:
1631	passed &= !rc;
1632	passed &= (args.args_count == 2);
1633	passed &= (args.args[0] == 13);
1634	passed &= (args.args[1] == 14);
1635	break;
1636	case 6:
1637	/*
1638	* Tests child node that is missing property
1639	* #address-cells. See the comments in
1640	* drivers/of/unittest-data/tests-interrupts.dtsi
1641	* nodes intmap1 and interrupts-extended0
1642	*/
1643	passed &= !rc;
1644	passed &= (args.args_count == 1);
1645	passed &= (args.args[0] == 15);
1646	break;
1647	default:
1648	passed = false;
1649	}
1650
1651	unittest(passed, "index %i - data error on node %pOF rc=%i\n",
1652	i, args.np, rc);
1653	}
1654	of_node_put(node: np);
1655	}
1656
1657	#if IS_ENABLED(CONFIG_OF_DYNAMIC)
1658	static void __init of_unittest_irq_refcount(void)
1659	{
1660	struct of_phandle_args args;
1661	struct device_node *intc0, *int_ext0;
1662	struct device_node *int2, *intc_intmap0;
1663	unsigned int ref_c0, ref_c1, ref_c2;
1664	int rc;
1665	bool passed;
1666
1667	if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
1668	return;
1669
1670	intc0 = of_find_node_by_path(path: "/testcase-data/interrupts/intc0");
1671	int_ext0 = of_find_node_by_path(path: "/testcase-data/interrupts/interrupts-extended0");
1672	intc_intmap0 = of_find_node_by_path(path: "/testcase-data/interrupts/intc-intmap0");
1673	int2 = of_find_node_by_path(path: "/testcase-data/interrupts/interrupts2");
1674	if (!intc0 || !int_ext0 || !intc_intmap0 || !int2) {
1675	pr_err("missing testcase data\n");
1676	goto out;
1677	}
1678
1679	/* Test refcount for API of_irq_parse_one() */
1680	passed = true;
1681	ref_c0 = OF_KREF_READ(intc0);
1682	ref_c1 = ref_c0 + 1;
1683	memset(&args, 0, sizeof(args));
1684	rc = of_irq_parse_one(device: int_ext0, index: 0, out_irq: &args);
1685	ref_c2 = OF_KREF_READ(intc0);
1686	of_node_put(node: args.np);
1687
1688	passed &= !rc;
1689	passed &= (args.np == intc0);
1690	passed &= (args.args_count == 1);
1691	passed &= (args.args[0] == 1);
1692	passed &= (ref_c1 == ref_c2);
1693	unittest(passed, "IRQ refcount case #1 failed, original(%u) expected(%u) got(%u)\n",
1694	ref_c0, ref_c1, ref_c2);
1695
1696	/* Test refcount for API of_irq_parse_raw() */
1697	passed = true;
1698	ref_c0 = OF_KREF_READ(intc_intmap0);
1699	ref_c1 = ref_c0 + 1;
1700	memset(&args, 0, sizeof(args));
1701	rc = of_irq_parse_one(device: int2, index: 0, out_irq: &args);
1702	ref_c2 = OF_KREF_READ(intc_intmap0);
1703	of_node_put(node: args.np);
1704
1705	passed &= !rc;
1706	passed &= (args.np == intc_intmap0);
1707	passed &= (args.args_count == 1);
1708	passed &= (args.args[0] == 2);
1709	passed &= (ref_c1 == ref_c2);
1710	unittest(passed, "IRQ refcount case #2 failed, original(%u) expected(%u) got(%u)\n",
1711	ref_c0, ref_c1, ref_c2);
1712
1713	out:
1714	of_node_put(node: int2);
1715	of_node_put(node: intc_intmap0);
1716	of_node_put(node: int_ext0);
1717	of_node_put(node: intc0);
1718	}
1719	#else
1720	static inline void __init of_unittest_irq_refcount(void) { }
1721	#endif
1722
1723	static const struct of_device_id match_node_table[] = {
1724	{ .data = "A", .name = "name0", }, /* Name alone is lowest priority */
1725	{ .data = "B", .type = "type1", }, /* followed by type alone */
1726
1727	{ .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
1728	{ .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
1729	{ .data = "Cc", .name = "name2", .type = "type2", },
1730
1731	{ .data = "E", .compatible = "compat3" },
1732	{ .data = "G", .compatible = "compat2", },
1733	{ .data = "H", .compatible = "compat2", .name = "name5", },
1734	{ .data = "I", .compatible = "compat2", .type = "type1", },
1735	{ .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
1736	{ .data = "K", .compatible = "compat2", .name = "name9", },
1737	{}
1738	};
1739
1740	static struct {
1741	const char *path;
1742	const char *data;
1743	} match_node_tests[] = {
1744	{ .path = "/testcase-data/match-node/name0", .data = "A", },
1745	{ .path = "/testcase-data/match-node/name1", .data = "B", },
1746	{ .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
1747	{ .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
1748	{ .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
1749	{ .path = "/testcase-data/match-node/name3", .data = "E", },
1750	{ .path = "/testcase-data/match-node/name4", .data = "G", },
1751	{ .path = "/testcase-data/match-node/name5", .data = "H", },
1752	{ .path = "/testcase-data/match-node/name6", .data = "G", },
1753	{ .path = "/testcase-data/match-node/name7", .data = "I", },
1754	{ .path = "/testcase-data/match-node/name8", .data = "J", },
1755	{ .path = "/testcase-data/match-node/name9", .data = "K", },
1756	};
1757
1758	static void __init of_unittest_match_node(void)
1759	{
1760	struct device_node *np;
1761	const struct of_device_id *match;
1762	int i;
1763
1764	for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
1765	np = of_find_node_by_path(path: match_node_tests[i].path);
1766	if (!np) {
1767	unittest(0, "missing testcase node %s\n",
1768	match_node_tests[i].path);
1769	continue;
1770	}
1771
1772	match = of_match_node(matches: match_node_table, node: np);
1773	if (!match) {
1774	unittest(0, "%s didn't match anything\n",
1775	match_node_tests[i].path);
1776	continue;
1777	}
1778
1779	if (strcmp(match->data, match_node_tests[i].data) != 0) {
1780	unittest(0, "%s got wrong match. expected %s, got %s\n",
1781	match_node_tests[i].path, match_node_tests[i].data,
1782	(const char *)match->data);
1783	continue;
1784	}
1785	unittest(1, "passed");
1786	}
1787	}
1788
1789	static struct resource test_bus_res = DEFINE_RES_MEM(0xfffffff8, 2);
1790	static const struct platform_device_info test_bus_info = {
1791	.name = "unittest-bus",
1792	};
1793	static void __init of_unittest_platform_populate(void)
1794	{
1795	int irq, rc;
1796	struct device_node *np, *child, *grandchild;
1797	struct platform_device *pdev, *test_bus;
1798	const struct of_device_id match[] = {
1799	{ .compatible = "test-device", },
1800	{}
1801	};
1802
1803	np = of_find_node_by_path(path: "/testcase-data");
1804	of_platform_default_populate(root: np, NULL, NULL);
1805
1806	/* Test that a missing irq domain returns -EPROBE_DEFER */
1807	np = of_find_node_by_path(path: "/testcase-data/testcase-device1");
1808	pdev = of_find_device_by_node(np);
1809	unittest(pdev, "device 1 creation failed\n");
1810
1811	if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1812	irq = platform_get_irq(pdev, 0);
1813	unittest(irq == -EPROBE_DEFER,
1814	"device deferred probe failed - %d\n", irq);
1815
1816	/* Test that a parsing failure does not return -EPROBE_DEFER */
1817	np = of_find_node_by_path(path: "/testcase-data/testcase-device2");
1818	pdev = of_find_device_by_node(np);
1819	unittest(pdev, "device 2 creation failed\n");
1820
1821	EXPECT_BEGIN(KERN_INFO,
1822	"platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1823
1824	irq = platform_get_irq(pdev, 0);
1825
1826	EXPECT_END(KERN_INFO,
1827	"platform testcase-data:testcase-device2: error -ENXIO: IRQ index 0 not found");
1828
1829	unittest(irq < 0 && irq != -EPROBE_DEFER,
1830	"device parsing error failed - %d\n", irq);
1831	}
1832
1833	np = of_find_node_by_path(path: "/testcase-data/platform-tests");
1834	unittest(np, "No testcase data in device tree\n");
1835	if (!np)
1836	return;
1837
1838	test_bus = platform_device_register_full(pdevinfo: &test_bus_info);
1839	rc = PTR_ERR_OR_ZERO(ptr: test_bus);
1840	unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1841	if (rc) {
1842	of_node_put(node: np);
1843	return;
1844	}
1845	test_bus->dev.of_node = np;
1846
1847	/*
1848	* Add a dummy resource to the test bus node after it is
1849	* registered to catch problems with un-inserted resources. The
1850	* DT code doesn't insert the resources, and it has caused the
1851	* kernel to oops in the past. This makes sure the same bug
1852	* doesn't crop up again.
1853	*/
1854	platform_device_add_resources(pdev: test_bus, res: &test_bus_res, num: 1);
1855
1856	of_platform_populate(root: np, matches: match, NULL, parent: &test_bus->dev);
1857	for_each_child_of_node(np, child) {
1858	for_each_child_of_node(child, grandchild) {
1859	if (!of_property_present(np: grandchild, propname: "compatible"))
1860	continue;
1861	pdev = of_find_device_by_node(np: grandchild);
1862	unittest(pdev,
1863	"Could not create device for node '%pOFn'\n",
1864	grandchild);
1865	platform_device_put(pdev);
1866	}
1867	}
1868
1869	of_platform_depopulate(parent: &test_bus->dev);
1870	for_each_child_of_node(np, child) {
1871	for_each_child_of_node(child, grandchild)
1872	unittest(!of_find_device_by_node(grandchild),
1873	"device didn't get destroyed '%pOFn'\n",
1874	grandchild);
1875	}
1876
1877	platform_device_unregister(test_bus);
1878	of_node_put(node: np);
1879	}
1880
1881	/**
1882	* update_node_properties - adds the properties
1883	* of np into dup node (present in live tree) and
1884	* updates parent of children of np to dup.
1885	*
1886	* @np: node whose properties are being added to the live tree
1887	* @dup: node present in live tree to be updated
1888	*/
1889	static void update_node_properties(struct device_node *np,
1890	struct device_node *dup)
1891	{
1892	struct property *prop;
1893	struct property *save_next;
1894	struct device_node *child;
1895	int ret;
1896
1897	for_each_child_of_node(np, child)
1898	child->parent = dup;
1899
1900	/*
1901	* "unittest internal error: unable to add testdata property"
1902	*
1903	* If this message reports a property in node '/__symbols__' then
1904	* the respective unittest overlay contains a label that has the
1905	* same name as a label in the live devicetree. The label will
1906	* be in the live devicetree only if the devicetree source was
1907	* compiled with the '-@' option. If you encounter this error,
1908	* please consider renaming __all__ of the labels in the unittest
1909	* overlay dts files with an odd prefix that is unlikely to be
1910	* used in a real devicetree.
1911	*/
1912
1913	/*
1914	* open code for_each_property_of_node() because of_add_property()
1915	* sets prop->next to NULL
1916	*/
1917	for (prop = np->properties; prop != NULL; prop = save_next) {
1918	save_next = prop->next;
1919	ret = of_add_property(np: dup, prop);
1920	if (ret) {
1921	if (ret == -EEXIST && !strcmp(prop->name, "name"))
1922	continue;
1923	pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1924	np, prop->name);
1925	}
1926	}
1927	}
1928
1929	/**
1930	* attach_node_and_children - attaches nodes
1931	* and its children to live tree.
1932	* CAUTION: misleading function name - if node @np already exists in
1933	* the live tree then children of @np are *not* attached to the live
1934	* tree. This works for the current test devicetree nodes because such
1935	* nodes do not have child nodes.
1936	*
1937	* @np: Node to attach to live tree
1938	*/
1939	static void attach_node_and_children(struct device_node *np)
1940	{
1941	struct device_node *next, *dup, *child;
1942	unsigned long flags;
1943	const char *full_name;
1944
1945	full_name = kasprintf(GFP_KERNEL, fmt: "%pOF", np);
1946	if (!full_name)
1947	return;
1948
1949	if (!strcmp(full_name, "/__local_fixups__") ||
1950	!strcmp(full_name, "/__fixups__")) {
1951	kfree(objp: full_name);
1952	return;
1953	}
1954
1955	dup = of_find_node_by_path(path: full_name);
1956	kfree(objp: full_name);
1957	if (dup) {
1958	update_node_properties(np, dup);
1959	return;
1960	}
1961
1962	child = np->child;
1963	np->child = NULL;
1964
1965	mutex_lock(&of_mutex);
1966	raw_spin_lock_irqsave(&devtree_lock, flags);
1967	np->sibling = np->parent->child;
1968	np->parent->child = np;
1969	of_node_clear_flag(n: np, OF_DETACHED);
1970	raw_spin_unlock_irqrestore(&devtree_lock, flags);
1971
1972	__of_attach_node_sysfs(np);
1973	mutex_unlock(lock: &of_mutex);
1974
1975	while (child) {
1976	next = child->sibling;
1977	attach_node_and_children(np: child);
1978	child = next;
1979	}
1980	}
1981
1982	/**
1983	* unittest_data_add - Reads, copies data from
1984	* linked tree and attaches it to the live tree
1985	*/
1986	static int __init unittest_data_add(void)
1987	{
1988	void *unittest_data_align;
1989	struct device_node *unittest_data_node = NULL, *np;
1990	/*
1991	* __dtbo_testcases_begin[] and __dtbo_testcases_end[] are magically
1992	* created by cmd_wrap_S_dtbo in scripts/Makefile.dtbs
1993	*/
1994	extern uint8_t __dtbo_testcases_begin[];
1995	extern uint8_t __dtbo_testcases_end[];
1996	const int size = __dtbo_testcases_end - __dtbo_testcases_begin;
1997	int rc;
1998	void *ret;
1999
2000	if (!size) {
2001	pr_warn("%s: testcases is empty\n", __func__);
2002	return -ENODATA;
2003	}
2004
2005	/* creating copy */
2006	void *unittest_data __free(kfree) = kmalloc(size + FDT_ALIGN_SIZE, GFP_KERNEL);
2007	if (!unittest_data)
2008	return -ENOMEM;
2009
2010	unittest_data_align = PTR_ALIGN(unittest_data, FDT_ALIGN_SIZE);
2011	memcpy(unittest_data_align, __dtbo_testcases_begin, size);
2012
2013	ret = of_fdt_unflatten_tree(blob: unittest_data_align, NULL, mynodes: &unittest_data_node);
2014	if (!ret) {
2015	pr_warn("%s: unflatten testcases tree failed\n", __func__);
2016	return -ENODATA;
2017	}
2018	if (!unittest_data_node) {
2019	pr_warn("%s: testcases tree is empty\n", __func__);
2020	return -ENODATA;
2021	}
2022
2023	/*
2024	* This lock normally encloses of_resolve_phandles()
2025	*/
2026	of_overlay_mutex_lock();
2027
2028	rc = of_resolve_phandles(tree: unittest_data_node);
2029	if (rc) {
2030	pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
2031	rc = -EINVAL;
2032	goto unlock;
2033	}
2034
2035	/* attach the sub-tree to live tree */
2036	if (!of_root) {
2037	pr_warn("%s: no live tree to attach sub-tree\n", __func__);
2038	rc = -ENODEV;
2039	goto unlock;
2040	}
2041
2042	EXPECT_BEGIN(KERN_INFO,
2043	"Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
2044
2045	np = unittest_data_node->child;
2046	while (np) {
2047	struct device_node *next = np->sibling;
2048
2049	np->parent = of_root;
2050	/* this will clear OF_DETACHED in np and children */
2051	attach_node_and_children(np);
2052	np = next;
2053	}
2054
2055	EXPECT_END(KERN_INFO,
2056	"Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
2057
2058	retain_and_null_ptr(unittest_data);
2059
2060	unlock:
2061	of_overlay_mutex_unlock();
2062
2063	return rc;
2064	}
2065
2066	#ifdef CONFIG_OF_OVERLAY
2067	static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id);
2068
2069	static int unittest_probe(struct platform_device *pdev)
2070	{
2071	struct device *dev = &pdev->dev;
2072	struct device_node *np = dev->of_node;
2073
2074	if (np == NULL) {
2075	dev_err(dev, "No OF data for device\n");
2076	return -EINVAL;
2077
2078	}
2079
2080	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2081
2082	of_platform_populate(root: np, NULL, NULL, parent: &pdev->dev);
2083
2084	return 0;
2085	}
2086
2087	static void unittest_remove(struct platform_device *pdev)
2088	{
2089	struct device *dev = &pdev->dev;
2090	struct device_node *np = dev->of_node;
2091
2092	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2093	}
2094
2095	static const struct of_device_id unittest_match[] = {
2096	{ .compatible = "unittest", },
2097	{},
2098	};
2099
2100	static struct platform_driver unittest_driver = {
2101	.probe = unittest_probe,
2102	.remove = unittest_remove,
2103	.driver = {
2104	.name = "unittest",
2105	.of_match_table = unittest_match,
2106	},
2107	};
2108
2109	/* get the platform device instantiated at the path */
2110	static struct platform_device *of_path_to_platform_device(const char *path)
2111	{
2112	struct device_node *np;
2113	struct platform_device *pdev;
2114
2115	np = of_find_node_by_path(path);
2116	if (np == NULL)
2117	return NULL;
2118
2119	pdev = of_find_device_by_node(np);
2120	of_node_put(node: np);
2121
2122	return pdev;
2123	}
2124
2125	/* find out if a platform device exists at that path */
2126	static int of_path_platform_device_exists(const char *path)
2127	{
2128	struct platform_device *pdev;
2129
2130	pdev = of_path_to_platform_device(path);
2131	platform_device_put(pdev);
2132	return pdev != NULL;
2133	}
2134
2135	#ifdef CONFIG_OF_GPIO
2136
2137	struct unittest_gpio_dev {
2138	struct gpio_chip chip;
2139	};
2140
2141	static int unittest_gpio_chip_request_count;
2142	static int unittest_gpio_probe_count;
2143	static int unittest_gpio_probe_pass_count;
2144
2145	static int unittest_gpio_chip_request(struct gpio_chip *chip, unsigned int offset)
2146	{
2147	unittest_gpio_chip_request_count++;
2148
2149	pr_debug("%s(): %s %d %d\n", __func__, chip->label, offset,
2150	unittest_gpio_chip_request_count);
2151	return 0;
2152	}
2153
2154	static int unittest_gpio_probe(struct platform_device *pdev)
2155	{
2156	struct unittest_gpio_dev *devptr;
2157	int ret;
2158
2159	unittest_gpio_probe_count++;
2160
2161	devptr = kzalloc(sizeof(*devptr), GFP_KERNEL);
2162	if (!devptr)
2163	return -ENOMEM;
2164
2165	platform_set_drvdata(pdev, data: devptr);
2166
2167	devptr->chip.fwnode = dev_fwnode(&pdev->dev);
2168	devptr->chip.label = "of-unittest-gpio";
2169	devptr->chip.base = -1; /* dynamic allocation */
2170	devptr->chip.ngpio = 5;
2171	devptr->chip.request = unittest_gpio_chip_request;
2172
2173	ret = gpiochip_add_data(&devptr->chip, NULL);
2174
2175	unittest(!ret,
2176	"gpiochip_add_data() for node @%pfw failed, ret = %d\n", devptr->chip.fwnode, ret);
2177
2178	if (!ret)
2179	unittest_gpio_probe_pass_count++;
2180	return ret;
2181	}
2182
2183	static void unittest_gpio_remove(struct platform_device *pdev)
2184	{
2185	struct unittest_gpio_dev *devptr = platform_get_drvdata(pdev);
2186	struct device *dev = &pdev->dev;
2187
2188	dev_dbg(dev, "%s for node @%pfw\n", __func__, devptr->chip.fwnode);
2189
2190	if (devptr->chip.base != -1)
2191	gpiochip_remove(gc: &devptr->chip);
2192
2193	kfree(objp: devptr);
2194	}
2195
2196	static const struct of_device_id unittest_gpio_id[] = {
2197	{ .compatible = "unittest-gpio", },
2198	{}
2199	};
2200
2201	static struct platform_driver unittest_gpio_driver = {
2202	.probe = unittest_gpio_probe,
2203	.remove = unittest_gpio_remove,
2204	.driver = {
2205	.name = "unittest-gpio",
2206	.of_match_table = unittest_gpio_id,
2207	},
2208	};
2209
2210	static void __init of_unittest_overlay_gpio(void)
2211	{
2212	int chip_request_count;
2213	int probe_pass_count;
2214	int ret;
2215
2216	/*
2217	* tests: apply overlays before registering driver
2218	* Similar to installing a driver as a module, the
2219	* driver is registered after applying the overlays.
2220	*
2221	* The overlays are applied by overlay_data_apply()
2222	* instead of of_unittest_apply_overlay() so that they
2223	* will not be tracked. Thus they will not be removed
2224	* by of_unittest_remove_tracked_overlays().
2225	*
2226	* - apply overlay_gpio_01
2227	* - apply overlay_gpio_02a
2228	* - apply overlay_gpio_02b
2229	* - register driver
2230	*
2231	* register driver will result in
2232	* - probe and processing gpio hog for overlay_gpio_01
2233	* - probe for overlay_gpio_02a
2234	* - processing gpio for overlay_gpio_02b
2235	*/
2236
2237	probe_pass_count = unittest_gpio_probe_pass_count;
2238	chip_request_count = unittest_gpio_chip_request_count;
2239
2240	/*
2241	* overlay_gpio_01 contains gpio node and child gpio hog node
2242	* overlay_gpio_02a contains gpio node
2243	* overlay_gpio_02b contains child gpio hog node
2244	*/
2245
2246	unittest(overlay_data_apply("overlay_gpio_01", NULL),
2247	"Adding overlay 'overlay_gpio_01' failed\n");
2248
2249	unittest(overlay_data_apply("overlay_gpio_02a", NULL),
2250	"Adding overlay 'overlay_gpio_02a' failed\n");
2251
2252	unittest(overlay_data_apply("overlay_gpio_02b", NULL),
2253	"Adding overlay 'overlay_gpio_02b' failed\n");
2254
2255	ret = platform_driver_register(&unittest_gpio_driver);
2256	if (unittest(ret == 0, "could not register unittest gpio driver\n"))
2257	return;
2258
2259	unittest(probe_pass_count + 2 == unittest_gpio_probe_pass_count,
2260	"unittest_gpio_probe() failed or not called\n");
2261
2262	unittest(chip_request_count + 2 == unittest_gpio_chip_request_count,
2263	"unittest_gpio_chip_request() called %d times (expected 1 time)\n",
2264	unittest_gpio_chip_request_count - chip_request_count);
2265
2266	/*
2267	* tests: apply overlays after registering driver
2268	*
2269	* Similar to a driver built-in to the kernel, the
2270	* driver is registered before applying the overlays.
2271	*
2272	* overlay_gpio_03 contains gpio node and child gpio hog node
2273	*
2274	* - apply overlay_gpio_03
2275	*
2276	* apply overlay will result in
2277	* - probe and processing gpio hog.
2278	*/
2279
2280	probe_pass_count = unittest_gpio_probe_pass_count;
2281	chip_request_count = unittest_gpio_chip_request_count;
2282
2283	/* overlay_gpio_03 contains gpio node and child gpio hog node */
2284
2285	unittest(overlay_data_apply("overlay_gpio_03", NULL),
2286	"Adding overlay 'overlay_gpio_03' failed\n");
2287
2288	unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
2289	"unittest_gpio_probe() failed or not called\n");
2290
2291	unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
2292	"unittest_gpio_chip_request() called %d times (expected 1 time)\n",
2293	unittest_gpio_chip_request_count - chip_request_count);
2294
2295	/*
2296	* overlay_gpio_04a contains gpio node
2297	*
2298	* - apply overlay_gpio_04a
2299	*
2300	* apply the overlay will result in
2301	* - probe for overlay_gpio_04a
2302	*/
2303
2304	probe_pass_count = unittest_gpio_probe_pass_count;
2305	chip_request_count = unittest_gpio_chip_request_count;
2306
2307	/* overlay_gpio_04a contains gpio node */
2308
2309	unittest(overlay_data_apply("overlay_gpio_04a", NULL),
2310	"Adding overlay 'overlay_gpio_04a' failed\n");
2311
2312	unittest(probe_pass_count + 1 == unittest_gpio_probe_pass_count,
2313	"unittest_gpio_probe() failed or not called\n");
2314
2315	/*
2316	* overlay_gpio_04b contains child gpio hog node
2317	*
2318	* - apply overlay_gpio_04b
2319	*
2320	* apply the overlay will result in
2321	* - processing gpio for overlay_gpio_04b
2322	*/
2323
2324	/* overlay_gpio_04b contains child gpio hog node */
2325
2326	unittest(overlay_data_apply("overlay_gpio_04b", NULL),
2327	"Adding overlay 'overlay_gpio_04b' failed\n");
2328
2329	unittest(chip_request_count + 1 == unittest_gpio_chip_request_count,
2330	"unittest_gpio_chip_request() called %d times (expected 1 time)\n",
2331	unittest_gpio_chip_request_count - chip_request_count);
2332	}
2333
2334	#else
2335
2336	static void __init of_unittest_overlay_gpio(void)
2337	{
2338	/* skip tests */
2339	}
2340
2341	#endif
2342
2343	#if IS_BUILTIN(CONFIG_I2C)
2344
2345	/* get the i2c client device instantiated at the path */
2346	static struct i2c_client *of_path_to_i2c_client(const char *path)
2347	{
2348	struct device_node *np;
2349	struct i2c_client *client;
2350
2351	np = of_find_node_by_path(path);
2352	if (np == NULL)
2353	return NULL;
2354
2355	client = of_find_i2c_device_by_node(node: np);
2356	of_node_put(node: np);
2357
2358	return client;
2359	}
2360
2361	/* find out if a i2c client device exists at that path */
2362	static int of_path_i2c_client_exists(const char *path)
2363	{
2364	struct i2c_client *client;
2365
2366	client = of_path_to_i2c_client(path);
2367	if (client)
2368	put_device(dev: &client->dev);
2369	return client != NULL;
2370	}
2371	#else
2372	static int of_path_i2c_client_exists(const char *path)
2373	{
2374	return 0;
2375	}
2376	#endif
2377
2378	enum overlay_type {
2379	PDEV_OVERLAY,
2380	I2C_OVERLAY
2381	};
2382
2383	static int of_path_device_type_exists(const char *path,
2384	enum overlay_type ovtype)
2385	{
2386	switch (ovtype) {
2387	case PDEV_OVERLAY:
2388	return of_path_platform_device_exists(path);
2389	case I2C_OVERLAY:
2390	return of_path_i2c_client_exists(path);
2391	}
2392	return 0;
2393	}
2394
2395	static const char *unittest_path(int nr, enum overlay_type ovtype)
2396	{
2397	const char *base;
2398	static char buf[256];
2399
2400	switch (ovtype) {
2401	case PDEV_OVERLAY:
2402	base = "/testcase-data/overlay-node/test-bus";
2403	break;
2404	case I2C_OVERLAY:
2405	base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
2406	break;
2407	default:
2408	buf[0] = '\0';
2409	return buf;
2410	}
2411	snprintf(buf, size: sizeof(buf) - 1, fmt: "%s/test-unittest%d", base, nr);
2412	buf[sizeof(buf) - 1] = '\0';
2413	return buf;
2414	}
2415
2416	static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
2417	{
2418	const char *path;
2419
2420	path = unittest_path(nr: unittest_nr, ovtype);
2421
2422	switch (ovtype) {
2423	case PDEV_OVERLAY:
2424	return of_path_platform_device_exists(path);
2425	case I2C_OVERLAY:
2426	return of_path_i2c_client_exists(path);
2427	}
2428	return 0;
2429	}
2430
2431	static const char *overlay_name_from_nr(int nr)
2432	{
2433	static char buf[256];
2434
2435	snprintf(buf, size: sizeof(buf) - 1,
2436	fmt: "overlay_%d", nr);
2437	buf[sizeof(buf) - 1] = '\0';
2438
2439	return buf;
2440	}
2441
2442	static const char *bus_path = "/testcase-data/overlay-node/test-bus";
2443
2444	#define MAX_TRACK_OVCS_IDS 256
2445
2446	static int track_ovcs_id[MAX_TRACK_OVCS_IDS];
2447	static int track_ovcs_id_overlay_nr[MAX_TRACK_OVCS_IDS];
2448	static int track_ovcs_id_cnt;
2449
2450	static void of_unittest_track_overlay(int ovcs_id, int overlay_nr)
2451	{
2452	if (WARN_ON(track_ovcs_id_cnt >= MAX_TRACK_OVCS_IDS))
2453	return;
2454
2455	track_ovcs_id[track_ovcs_id_cnt] = ovcs_id;
2456	track_ovcs_id_overlay_nr[track_ovcs_id_cnt] = overlay_nr;
2457	track_ovcs_id_cnt++;
2458	}
2459
2460	static void of_unittest_untrack_overlay(int ovcs_id)
2461	{
2462	if (WARN_ON(track_ovcs_id_cnt < 1))
2463	return;
2464
2465	track_ovcs_id_cnt--;
2466
2467	/* If out of synch then test is broken. Do not try to recover. */
2468	WARN_ON(track_ovcs_id[track_ovcs_id_cnt] != ovcs_id);
2469	}
2470
2471	static void of_unittest_remove_tracked_overlays(void)
2472	{
2473	int ret, ovcs_id, overlay_nr, save_ovcs_id;
2474	const char *overlay_name;
2475
2476	while (track_ovcs_id_cnt > 0) {
2477
2478	ovcs_id = track_ovcs_id[track_ovcs_id_cnt - 1];
2479	overlay_nr = track_ovcs_id_overlay_nr[track_ovcs_id_cnt - 1];
2480	save_ovcs_id = ovcs_id;
2481	ret = of_overlay_remove(ovcs_id: &ovcs_id);
2482	if (ret == -ENODEV) {
2483	overlay_name = overlay_name_from_nr(nr: overlay_nr);
2484	pr_warn("%s: of_overlay_remove() for overlay \"%s\" failed, ret = %d\n",
2485	__func__, overlay_name, ret);
2486	}
2487	of_unittest_untrack_overlay(ovcs_id: save_ovcs_id);
2488	}
2489
2490	}
2491
2492	static int __init of_unittest_apply_overlay(int overlay_nr, int *ovcs_id)
2493	{
2494	/*
2495	* The overlay will be tracked, thus it will be removed
2496	* by of_unittest_remove_tracked_overlays().
2497	*/
2498
2499	const char *overlay_name;
2500
2501	overlay_name = overlay_name_from_nr(nr: overlay_nr);
2502
2503	if (!overlay_data_apply(overlay_name, ovcs_id)) {
2504	unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2505	return -EFAULT;
2506	}
2507	of_unittest_track_overlay(ovcs_id: *ovcs_id, overlay_nr);
2508
2509	return 0;
2510	}
2511
2512	static int __init __of_unittest_apply_overlay_check(int overlay_nr,
2513	int unittest_nr, int before, int after,
2514	enum overlay_type ovtype)
2515	{
2516	int ret, ovcs_id;
2517
2518	/* unittest device must be in before state */
2519	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2520	unittest(0, "%s with device @\"%s\" %s\n",
2521	overlay_name_from_nr(overlay_nr),
2522	unittest_path(unittest_nr, ovtype),
2523	!before ? "enabled" : "disabled");
2524	return -EINVAL;
2525	}
2526
2527	/* apply the overlay */
2528	ovcs_id = 0;
2529	ret = of_unittest_apply_overlay(overlay_nr, ovcs_id: &ovcs_id);
2530	if (ret != 0) {
2531	/* of_unittest_apply_overlay already called unittest() */
2532	return ret;
2533	}
2534
2535	/* unittest device must be in after state */
2536	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
2537	unittest(0, "%s with device @\"%s\" %s\n",
2538	overlay_name_from_nr(overlay_nr),
2539	unittest_path(unittest_nr, ovtype),
2540	!after ? "enabled" : "disabled");
2541	return -EINVAL;
2542	}
2543
2544	return ovcs_id;
2545	}
2546
2547	/* apply an overlay while checking before and after states */
2548	static int __init of_unittest_apply_overlay_check(int overlay_nr,
2549	int unittest_nr, int before, int after,
2550	enum overlay_type ovtype)
2551	{
2552	int ovcs_id = __of_unittest_apply_overlay_check(overlay_nr,
2553	unittest_nr, before, after, ovtype);
2554	if (ovcs_id < 0)
2555	return ovcs_id;
2556
2557	return 0;
2558	}
2559
2560	/* apply an overlay and then revert it while checking before, after states */
2561	static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
2562	int unittest_nr, int before, int after,
2563	enum overlay_type ovtype)
2564	{
2565	int ret, ovcs_id, save_ovcs_id;
2566
2567	ovcs_id = __of_unittest_apply_overlay_check(overlay_nr, unittest_nr,
2568	before, after, ovtype);
2569	if (ovcs_id < 0)
2570	return ovcs_id;
2571
2572	/* remove the overlay */
2573	save_ovcs_id = ovcs_id;
2574	ret = of_overlay_remove(ovcs_id: &ovcs_id);
2575	if (ret != 0) {
2576	unittest(0, "%s failed to be destroyed @\"%s\"\n",
2577	overlay_name_from_nr(overlay_nr),
2578	unittest_path(unittest_nr, ovtype));
2579	return ret;
2580	}
2581	of_unittest_untrack_overlay(ovcs_id: save_ovcs_id);
2582
2583	/* unittest device must be again in before state */
2584	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
2585	unittest(0, "%s with device @\"%s\" %s\n",
2586	overlay_name_from_nr(overlay_nr),
2587	unittest_path(unittest_nr, ovtype),
2588	!before ? "enabled" : "disabled");
2589	return -EINVAL;
2590	}
2591
2592	return 0;
2593	}
2594
2595	/* test activation of device */
2596	static void __init of_unittest_overlay_0(void)
2597	{
2598	int ret;
2599
2600	EXPECT_BEGIN(KERN_INFO,
2601	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2602
2603	/* device should enable */
2604	ret = of_unittest_apply_overlay_check(overlay_nr: 0, unittest_nr: 0, before: 0, after: 1, ovtype: PDEV_OVERLAY);
2605
2606	EXPECT_END(KERN_INFO,
2607	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest0/status");
2608
2609	if (ret)
2610	return;
2611
2612	unittest(1, "overlay test %d passed\n", 0);
2613	}
2614
2615	/* test deactivation of device */
2616	static void __init of_unittest_overlay_1(void)
2617	{
2618	int ret;
2619
2620	EXPECT_BEGIN(KERN_INFO,
2621	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2622
2623	/* device should disable */
2624	ret = of_unittest_apply_overlay_check(overlay_nr: 1, unittest_nr: 1, before: 1, after: 0, ovtype: PDEV_OVERLAY);
2625
2626	EXPECT_END(KERN_INFO,
2627	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest1/status");
2628
2629	if (ret)
2630	return;
2631
2632	unittest(1, "overlay test %d passed\n", 1);
2633
2634	}
2635
2636	/* test activation of device */
2637	static void __init of_unittest_overlay_2(void)
2638	{
2639	int ret;
2640
2641	EXPECT_BEGIN(KERN_INFO,
2642	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2643
2644	/* device should enable */
2645	ret = of_unittest_apply_overlay_check(overlay_nr: 2, unittest_nr: 2, before: 0, after: 1, ovtype: PDEV_OVERLAY);
2646
2647	EXPECT_END(KERN_INFO,
2648	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest2/status");
2649
2650	if (ret)
2651	return;
2652	unittest(1, "overlay test %d passed\n", 2);
2653	}
2654
2655	/* test deactivation of device */
2656	static void __init of_unittest_overlay_3(void)
2657	{
2658	int ret;
2659
2660	EXPECT_BEGIN(KERN_INFO,
2661	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2662
2663	/* device should disable */
2664	ret = of_unittest_apply_overlay_check(overlay_nr: 3, unittest_nr: 3, before: 1, after: 0, ovtype: PDEV_OVERLAY);
2665
2666	EXPECT_END(KERN_INFO,
2667	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest3/status");
2668
2669	if (ret)
2670	return;
2671
2672	unittest(1, "overlay test %d passed\n", 3);
2673	}
2674
2675	/* test activation of a full device node */
2676	static void __init of_unittest_overlay_4(void)
2677	{
2678	/* device should disable */
2679	if (of_unittest_apply_overlay_check(overlay_nr: 4, unittest_nr: 4, before: 0, after: 1, ovtype: PDEV_OVERLAY))
2680	return;
2681
2682	unittest(1, "overlay test %d passed\n", 4);
2683	}
2684
2685	/* test overlay apply/revert sequence */
2686	static void __init of_unittest_overlay_5(void)
2687	{
2688	int ret;
2689
2690	EXPECT_BEGIN(KERN_INFO,
2691	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2692
2693	/* device should disable */
2694	ret = of_unittest_apply_revert_overlay_check(overlay_nr: 5, unittest_nr: 5, before: 0, after: 1, ovtype: PDEV_OVERLAY);
2695
2696	EXPECT_END(KERN_INFO,
2697	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest5/status");
2698
2699	if (ret)
2700	return;
2701
2702	unittest(1, "overlay test %d passed\n", 5);
2703	}
2704
2705	/* test overlay application in sequence */
2706	static void __init of_unittest_overlay_6(void)
2707	{
2708	int i, save_ovcs_id[2], ovcs_id;
2709	int overlay_nr = 6, unittest_nr = 6;
2710	int before = 0, after = 1;
2711	const char *overlay_name;
2712
2713	int ret;
2714
2715	/* unittest device must be in before state */
2716	for (i = 0; i < 2; i++) {
2717	if (of_unittest_device_exists(unittest_nr: unittest_nr + i, ovtype: PDEV_OVERLAY)
2718	!= before) {
2719	unittest(0, "%s with device @\"%s\" %s\n",
2720	overlay_name_from_nr(overlay_nr + i),
2721	unittest_path(unittest_nr + i,
2722	PDEV_OVERLAY),
2723	!before ? "enabled" : "disabled");
2724	return;
2725	}
2726	}
2727
2728	/* apply the overlays */
2729
2730	EXPECT_BEGIN(KERN_INFO,
2731	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2732
2733	overlay_name = overlay_name_from_nr(nr: overlay_nr + 0);
2734
2735	ret = overlay_data_apply(overlay_name, ovcs_id: &ovcs_id);
2736
2737	if (!ret) {
2738	unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2739	return;
2740	}
2741	save_ovcs_id[0] = ovcs_id;
2742	of_unittest_track_overlay(ovcs_id, overlay_nr: overlay_nr + 0);
2743
2744	EXPECT_END(KERN_INFO,
2745	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest6/status");
2746
2747	EXPECT_BEGIN(KERN_INFO,
2748	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2749
2750	overlay_name = overlay_name_from_nr(nr: overlay_nr + 1);
2751
2752	ret = overlay_data_apply(overlay_name, ovcs_id: &ovcs_id);
2753
2754	if (!ret) {
2755	unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2756	return;
2757	}
2758	save_ovcs_id[1] = ovcs_id;
2759	of_unittest_track_overlay(ovcs_id, overlay_nr: overlay_nr + 1);
2760
2761	EXPECT_END(KERN_INFO,
2762	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest7/status");
2763
2764
2765	for (i = 0; i < 2; i++) {
2766	/* unittest device must be in after state */
2767	if (of_unittest_device_exists(unittest_nr: unittest_nr + i, ovtype: PDEV_OVERLAY)
2768	!= after) {
2769	unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
2770	overlay_name_from_nr(overlay_nr + i),
2771	unittest_path(unittest_nr + i,
2772	PDEV_OVERLAY),
2773	!after ? "enabled" : "disabled");
2774	return;
2775	}
2776	}
2777
2778	for (i = 1; i >= 0; i--) {
2779	ovcs_id = save_ovcs_id[i];
2780	if (of_overlay_remove(ovcs_id: &ovcs_id)) {
2781	unittest(0, "%s failed destroy @\"%s\"\n",
2782	overlay_name_from_nr(overlay_nr + i),
2783	unittest_path(unittest_nr + i,
2784	PDEV_OVERLAY));
2785	return;
2786	}
2787	of_unittest_untrack_overlay(ovcs_id: save_ovcs_id[i]);
2788	}
2789
2790	for (i = 0; i < 2; i++) {
2791	/* unittest device must be again in before state */
2792	if (of_unittest_device_exists(unittest_nr: unittest_nr + i, ovtype: PDEV_OVERLAY)
2793	!= before) {
2794	unittest(0, "%s with device @\"%s\" %s\n",
2795	overlay_name_from_nr(overlay_nr + i),
2796	unittest_path(unittest_nr + i,
2797	PDEV_OVERLAY),
2798	!before ? "enabled" : "disabled");
2799	return;
2800	}
2801	}
2802
2803	unittest(1, "overlay test %d passed\n", 6);
2804
2805	}
2806
2807	/* test overlay application in sequence */
2808	static void __init of_unittest_overlay_8(void)
2809	{
2810	int i, save_ovcs_id[2], ovcs_id;
2811	int overlay_nr = 8, unittest_nr = 8;
2812	const char *overlay_name;
2813	int ret;
2814
2815	/* we don't care about device state in this test */
2816
2817	EXPECT_BEGIN(KERN_INFO,
2818	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2819
2820	overlay_name = overlay_name_from_nr(nr: overlay_nr + 0);
2821
2822	ret = overlay_data_apply(overlay_name, ovcs_id: &ovcs_id);
2823	if (!ret)
2824	unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2825
2826	EXPECT_END(KERN_INFO,
2827	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/status");
2828
2829	if (!ret)
2830	return;
2831
2832	save_ovcs_id[0] = ovcs_id;
2833	of_unittest_track_overlay(ovcs_id, overlay_nr: overlay_nr + 0);
2834
2835	overlay_name = overlay_name_from_nr(nr: overlay_nr + 1);
2836
2837	EXPECT_BEGIN(KERN_INFO,
2838	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2839
2840	/* apply the overlays */
2841	ret = overlay_data_apply(overlay_name, ovcs_id: &ovcs_id);
2842
2843	EXPECT_END(KERN_INFO,
2844	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/test-unittest8/property-foo");
2845
2846	if (!ret) {
2847	unittest(0, "could not apply overlay \"%s\"\n", overlay_name);
2848	return;
2849	}
2850
2851	save_ovcs_id[1] = ovcs_id;
2852	of_unittest_track_overlay(ovcs_id, overlay_nr: overlay_nr + 1);
2853
2854	/* now try to remove first overlay (it should fail) */
2855	ovcs_id = save_ovcs_id[0];
2856
2857	EXPECT_BEGIN(KERN_INFO,
2858	"OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2859
2860	EXPECT_BEGIN(KERN_INFO,
2861	"OF: overlay: overlay #6 is not topmost");
2862
2863	ret = of_overlay_remove(ovcs_id: &ovcs_id);
2864
2865	EXPECT_END(KERN_INFO,
2866	"OF: overlay: overlay #6 is not topmost");
2867
2868	EXPECT_END(KERN_INFO,
2869	"OF: overlay: node_overlaps_later_cs: #6 overlaps with #7 @/testcase-data/overlay-node/test-bus/test-unittest8");
2870
2871	if (!ret) {
2872	/*
2873	* Should never get here. If we do, expect a lot of
2874	* subsequent tracking and overlay removal related errors.
2875	*/
2876	unittest(0, "%s was destroyed @\"%s\"\n",
2877	overlay_name_from_nr(overlay_nr + 0),
2878	unittest_path(unittest_nr,
2879	PDEV_OVERLAY));
2880	return;
2881	}
2882
2883	/* removing them in order should work */
2884	for (i = 1; i >= 0; i--) {
2885	ovcs_id = save_ovcs_id[i];
2886	if (of_overlay_remove(ovcs_id: &ovcs_id)) {
2887	unittest(0, "%s not destroyed @\"%s\"\n",
2888	overlay_name_from_nr(overlay_nr + i),
2889	unittest_path(unittest_nr,
2890	PDEV_OVERLAY));
2891	return;
2892	}
2893	of_unittest_untrack_overlay(ovcs_id: save_ovcs_id[i]);
2894	}
2895
2896	unittest(1, "overlay test %d passed\n", 8);
2897	}
2898
2899	/* test insertion of a bus with parent devices */
2900	static void __init of_unittest_overlay_10(void)
2901	{
2902	int ret;
2903	char *child_path;
2904
2905	/* device should disable */
2906	ret = of_unittest_apply_overlay_check(overlay_nr: 10, unittest_nr: 10, before: 0, after: 1, ovtype: PDEV_OVERLAY);
2907
2908	if (unittest(ret == 0,
2909	"overlay test %d failed; overlay application\n", 10))
2910	return;
2911
2912	child_path = kasprintf(GFP_KERNEL, fmt: "%s/test-unittest101",
2913	unittest_path(nr: 10, ovtype: PDEV_OVERLAY));
2914	if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
2915	return;
2916
2917	ret = of_path_device_type_exists(path: child_path, ovtype: PDEV_OVERLAY);
2918	kfree(objp: child_path);
2919
2920	unittest(ret, "overlay test %d failed; no child device\n", 10);
2921	}
2922
2923	/* test insertion of a bus with parent devices (and revert) */
2924	static void __init of_unittest_overlay_11(void)
2925	{
2926	int ret;
2927
2928	/* device should disable */
2929	ret = of_unittest_apply_revert_overlay_check(overlay_nr: 11, unittest_nr: 11, before: 0, after: 1,
2930	ovtype: PDEV_OVERLAY);
2931
2932	unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
2933	}
2934
2935	#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
2936
2937	struct unittest_i2c_bus_data {
2938	struct platform_device *pdev;
2939	struct i2c_adapter adap;
2940	};
2941
2942	static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
2943	struct i2c_msg *msgs, int num)
2944	{
2945	struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
2946
2947	(void)std;
2948
2949	return num;
2950	}
2951
2952	static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
2953	{
2954	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
2955	}
2956
2957	static const struct i2c_algorithm unittest_i2c_algo = {
2958	.master_xfer = unittest_i2c_master_xfer,
2959	.functionality = unittest_i2c_functionality,
2960	};
2961
2962	static int unittest_i2c_bus_probe(struct platform_device *pdev)
2963	{
2964	struct device *dev = &pdev->dev;
2965	struct device_node *np = dev->of_node;
2966	struct unittest_i2c_bus_data *std;
2967	struct i2c_adapter *adap;
2968	int ret;
2969
2970	if (np == NULL) {
2971	dev_err(dev, "No OF data for device\n");
2972	return -EINVAL;
2973
2974	}
2975
2976	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2977
2978	std = devm_kzalloc(dev, size: sizeof(*std), GFP_KERNEL);
2979	if (!std)
2980	return -ENOMEM;
2981
2982	/* link them together */
2983	std->pdev = pdev;
2984	platform_set_drvdata(pdev, data: std);
2985
2986	adap = &std->adap;
2987	i2c_set_adapdata(adap, data: std);
2988	adap->nr = -1;
2989	strscpy(adap->name, pdev->name, sizeof(adap->name));
2990	adap->class = I2C_CLASS_DEPRECATED;
2991	adap->algo = &unittest_i2c_algo;
2992	adap->dev.parent = dev;
2993	adap->dev.of_node = dev->of_node;
2994	adap->timeout = 5 * HZ;
2995	adap->retries = 3;
2996
2997	ret = i2c_add_numbered_adapter(adap);
2998	if (ret != 0) {
2999	dev_err(dev, "Failed to add I2C adapter\n");
3000	return ret;
3001	}
3002
3003	return 0;
3004	}
3005
3006	static void unittest_i2c_bus_remove(struct platform_device *pdev)
3007	{
3008	struct device *dev = &pdev->dev;
3009	struct device_node *np = dev->of_node;
3010	struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
3011
3012	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
3013	i2c_del_adapter(adap: &std->adap);
3014	}
3015
3016	static const struct of_device_id unittest_i2c_bus_match[] = {
3017	{ .compatible = "unittest-i2c-bus", },
3018	{},
3019	};
3020
3021	static struct platform_driver unittest_i2c_bus_driver = {
3022	.probe = unittest_i2c_bus_probe,
3023	.remove = unittest_i2c_bus_remove,
3024	.driver = {
3025	.name = "unittest-i2c-bus",
3026	.of_match_table = unittest_i2c_bus_match,
3027	},
3028	};
3029
3030	static int unittest_i2c_dev_probe(struct i2c_client *client)
3031	{
3032	struct device *dev = &client->dev;
3033	struct device_node *np = client->dev.of_node;
3034
3035	if (!np) {
3036	dev_err(dev, "No OF node\n");
3037	return -EINVAL;
3038	}
3039
3040	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
3041
3042	return 0;
3043	};
3044
3045	static void unittest_i2c_dev_remove(struct i2c_client *client)
3046	{
3047	struct device *dev = &client->dev;
3048	struct device_node *np = client->dev.of_node;
3049
3050	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
3051	}
3052
3053	static const struct i2c_device_id unittest_i2c_dev_id[] = {
3054	{ .name = "unittest-i2c-dev" },
3055	{ }
3056	};
3057
3058	static struct i2c_driver unittest_i2c_dev_driver = {
3059	.driver = {
3060	.name = "unittest-i2c-dev",
3061	},
3062	.probe = unittest_i2c_dev_probe,
3063	.remove = unittest_i2c_dev_remove,
3064	.id_table = unittest_i2c_dev_id,
3065	};
3066
3067	#if IS_BUILTIN(CONFIG_I2C_MUX)
3068
3069	static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
3070	{
3071	return 0;
3072	}
3073
3074	static int unittest_i2c_mux_probe(struct i2c_client *client)
3075	{
3076	int i, nchans;
3077	struct device *dev = &client->dev;
3078	struct i2c_adapter *adap = client->adapter;
3079	struct device_node *np = client->dev.of_node, *child;
3080	struct i2c_mux_core *muxc;
3081	u32 reg, max_reg;
3082
3083	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
3084
3085	if (!np) {
3086	dev_err(dev, "No OF node\n");
3087	return -EINVAL;
3088	}
3089
3090	max_reg = (u32)-1;
3091	for_each_child_of_node(np, child) {
3092	if (of_property_read_u32(np: child, propname: "reg", out_value: &reg))
3093	continue;
3094	if (max_reg == (u32)-1 || reg > max_reg)
3095	max_reg = reg;
3096	}
3097	nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
3098	if (nchans == 0) {
3099	dev_err(dev, "No channels\n");
3100	return -EINVAL;
3101	}
3102
3103	muxc = i2c_mux_alloc(parent: adap, dev, max_adapters: nchans, sizeof_priv: 0, flags: 0,
3104	select: unittest_i2c_mux_select_chan, NULL);
3105	if (!muxc)
3106	return -ENOMEM;
3107	for (i = 0; i < nchans; i++) {
3108	if (i2c_mux_add_adapter(muxc, force_nr: 0, chan_id: i)) {
3109	dev_err(dev, "Failed to register mux #%d\n", i);
3110	i2c_mux_del_adapters(muxc);
3111	return -ENODEV;
3112	}
3113	}
3114
3115	i2c_set_clientdata(client, data: muxc);
3116
3117	return 0;
3118	};
3119
3120	static void unittest_i2c_mux_remove(struct i2c_client *client)
3121	{
3122	struct device *dev = &client->dev;
3123	struct device_node *np = client->dev.of_node;
3124	struct i2c_mux_core *muxc = i2c_get_clientdata(client);
3125
3126	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
3127	i2c_mux_del_adapters(muxc);
3128	}
3129
3130	static const struct i2c_device_id unittest_i2c_mux_id[] = {
3131	{ .name = "unittest-i2c-mux" },
3132	{ }
3133	};
3134
3135	static struct i2c_driver unittest_i2c_mux_driver = {
3136	.driver = {
3137	.name = "unittest-i2c-mux",
3138	},
3139	.probe = unittest_i2c_mux_probe,
3140	.remove = unittest_i2c_mux_remove,
3141	.id_table = unittest_i2c_mux_id,
3142	};
3143
3144	#endif
3145
3146	static int of_unittest_overlay_i2c_init(void)
3147	{
3148	int ret;
3149
3150	ret = i2c_add_driver(&unittest_i2c_dev_driver);
3151	if (unittest(ret == 0,
3152	"could not register unittest i2c device driver\n"))
3153	return ret;
3154
3155	ret = platform_driver_register(&unittest_i2c_bus_driver);
3156
3157	if (unittest(ret == 0,
3158	"could not register unittest i2c bus driver\n"))
3159	return ret;
3160
3161	#if IS_BUILTIN(CONFIG_I2C_MUX)
3162
3163	EXPECT_BEGIN(KERN_INFO,
3164	"i2c i2c-1: Added multiplexed i2c bus 2");
3165
3166	ret = i2c_add_driver(&unittest_i2c_mux_driver);
3167
3168	EXPECT_END(KERN_INFO,
3169	"i2c i2c-1: Added multiplexed i2c bus 2");
3170
3171	if (unittest(ret == 0,
3172	"could not register unittest i2c mux driver\n"))
3173	return ret;
3174	#endif
3175
3176	return 0;
3177	}
3178
3179	static void of_unittest_overlay_i2c_cleanup(void)
3180	{
3181	#if IS_BUILTIN(CONFIG_I2C_MUX)
3182	i2c_del_driver(driver: &unittest_i2c_mux_driver);
3183	#endif
3184	platform_driver_unregister(&unittest_i2c_bus_driver);
3185	i2c_del_driver(driver: &unittest_i2c_dev_driver);
3186	}
3187
3188	static void __init of_unittest_overlay_i2c_12(void)
3189	{
3190	int ret;
3191
3192	/* device should enable */
3193	EXPECT_BEGIN(KERN_INFO,
3194	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
3195
3196	ret = of_unittest_apply_overlay_check(overlay_nr: 12, unittest_nr: 12, before: 0, after: 1, ovtype: I2C_OVERLAY);
3197
3198	EXPECT_END(KERN_INFO,
3199	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest12/status");
3200
3201	if (ret)
3202	return;
3203
3204	unittest(1, "overlay test %d passed\n", 12);
3205	}
3206
3207	/* test deactivation of device */
3208	static void __init of_unittest_overlay_i2c_13(void)
3209	{
3210	int ret;
3211
3212	EXPECT_BEGIN(KERN_INFO,
3213	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
3214
3215	/* device should disable */
3216	ret = of_unittest_apply_overlay_check(overlay_nr: 13, unittest_nr: 13, before: 1, after: 0, ovtype: I2C_OVERLAY);
3217
3218	EXPECT_END(KERN_INFO,
3219	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data/overlay-node/test-bus/i2c-test-bus/test-unittest13/status");
3220
3221	if (ret)
3222	return;
3223
3224	unittest(1, "overlay test %d passed\n", 13);
3225	}
3226
3227	/* just check for i2c mux existence */
3228	static void of_unittest_overlay_i2c_14(void)
3229	{
3230	}
3231
3232	static void __init of_unittest_overlay_i2c_15(void)
3233	{
3234	int ret;
3235
3236	/* device should enable */
3237	EXPECT_BEGIN(KERN_INFO,
3238	"i2c i2c-1: Added multiplexed i2c bus 3");
3239
3240	ret = of_unittest_apply_overlay_check(overlay_nr: 15, unittest_nr: 15, before: 0, after: 1, ovtype: I2C_OVERLAY);
3241
3242	EXPECT_END(KERN_INFO,
3243	"i2c i2c-1: Added multiplexed i2c bus 3");
3244
3245	if (ret)
3246	return;
3247
3248	unittest(1, "overlay test %d passed\n", 15);
3249	}
3250
3251	#else
3252
3253	static inline void of_unittest_overlay_i2c_14(void) { }
3254	static inline void of_unittest_overlay_i2c_15(void) { }
3255
3256	#endif
3257
3258	static int of_notify(struct notifier_block *nb, unsigned long action,
3259	void *arg)
3260	{
3261	struct of_overlay_notify_data *nd = arg;
3262	struct device_node *found;
3263	int ret;
3264
3265	/*
3266	* For overlay_16 .. overlay_19, check that returning an error
3267	* works for each of the actions by setting an arbitrary return
3268	* error number that matches the test number. e.g. for unittest16,
3269	* ret = -EBUSY which is -16.
3270	*
3271	* OVERLAY_INFO() for the overlays is declared to expect the same
3272	* error number, so overlay_data_apply() will return no error.
3273	*
3274	* overlay_20 will return NOTIFY_DONE
3275	*/
3276
3277	ret = 0;
3278	of_node_get(node: nd->overlay);
3279
3280	switch (action) {
3281
3282	case OF_OVERLAY_PRE_APPLY:
3283	found = of_find_node_by_name(from: nd->overlay, name: "test-unittest16");
3284	if (found) {
3285	of_node_put(node: found);
3286	ret = -EBUSY;
3287	}
3288	break;
3289
3290	case OF_OVERLAY_POST_APPLY:
3291	found = of_find_node_by_name(from: nd->overlay, name: "test-unittest17");
3292	if (found) {
3293	of_node_put(node: found);
3294	ret = -EEXIST;
3295	}
3296	break;
3297
3298	case OF_OVERLAY_PRE_REMOVE:
3299	found = of_find_node_by_name(from: nd->overlay, name: "test-unittest18");
3300	if (found) {
3301	of_node_put(node: found);
3302	ret = -EXDEV;
3303	}
3304	break;
3305
3306	case OF_OVERLAY_POST_REMOVE:
3307	found = of_find_node_by_name(from: nd->overlay, name: "test-unittest19");
3308	if (found) {
3309	of_node_put(node: found);
3310	ret = -ENODEV;
3311	}
3312	break;
3313
3314	default: /* should not happen */
3315	of_node_put(node: nd->overlay);
3316	ret = -EINVAL;
3317	break;
3318	}
3319
3320	if (ret)
3321	return notifier_from_errno(err: ret);
3322
3323	return NOTIFY_DONE;
3324	}
3325
3326	static struct notifier_block of_nb = {
3327	.notifier_call = of_notify,
3328	};
3329
3330	static void __init of_unittest_overlay_notify(void)
3331	{
3332	int ovcs_id;
3333	int ret;
3334
3335	ret = of_overlay_notifier_register(nb: &of_nb);
3336	unittest(!ret,
3337	"of_overlay_notifier_register() failed, ret = %d\n", ret);
3338	if (ret)
3339	return;
3340
3341	/*
3342	* The overlays are applied by overlay_data_apply()
3343	* instead of of_unittest_apply_overlay() so that they
3344	* will not be tracked. Thus they will not be removed
3345	* by of_unittest_remove_tracked_overlays().
3346	*
3347	* Applying overlays 16 - 19 will each trigger an error for a
3348	* different action in of_notify().
3349	*
3350	* Applying overlay 20 will not trigger any error in of_notify().
3351	*/
3352
3353	/* --- overlay 16 --- */
3354
3355	EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
3356
3357	unittest(overlay_data_apply("overlay_16", &ovcs_id),
3358	"test OF_OVERLAY_PRE_APPLY notify injected error\n");
3359
3360	EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier error -16, target: /testcase-data/overlay-node/test-bus");
3361
3362	unittest(ovcs_id, "ovcs_id not created for overlay_16\n");
3363
3364	/* --- overlay 17 --- */
3365
3366	EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
3367
3368	unittest(overlay_data_apply("overlay_17", &ovcs_id),
3369	"test OF_OVERLAY_POST_APPLY notify injected error\n");
3370
3371	EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier error -17, target: /testcase-data/overlay-node/test-bus");
3372
3373	unittest(ovcs_id, "ovcs_id not created for overlay_17\n");
3374
3375	/* --- overlay 18 --- */
3376
3377	unittest(overlay_data_apply("overlay_18", &ovcs_id),
3378	"OF_OVERLAY_PRE_REMOVE notify injected error\n");
3379
3380	unittest(ovcs_id, "ovcs_id not created for overlay_18\n");
3381
3382	if (ovcs_id) {
3383	EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
3384
3385	ret = of_overlay_remove(ovcs_id: &ovcs_id);
3386	EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifier error -18, target: /testcase-data/overlay-node/test-bus");
3387	if (ret == -EXDEV) {
3388	/*
3389	* change set ovcs_id should still exist
3390	*/
3391	unittest(1, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE\n");
3392	} else {
3393	unittest(0, "overlay_18 of_overlay_remove() injected error for OF_OVERLAY_PRE_REMOVE not returned\n");
3394	}
3395	} else {
3396	unittest(1, "ovcs_id not created for overlay_18\n");
3397	}
3398
3399	unittest(ovcs_id, "ovcs_id removed for overlay_18\n");
3400
3401	/* --- overlay 19 --- */
3402
3403	unittest(overlay_data_apply("overlay_19", &ovcs_id),
3404	"OF_OVERLAY_POST_REMOVE notify injected error\n");
3405
3406	unittest(ovcs_id, "ovcs_id not created for overlay_19\n");
3407
3408	if (ovcs_id) {
3409	EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
3410	ret = of_overlay_remove(ovcs_id: &ovcs_id);
3411	EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-remove notifier error -19, target: /testcase-data/overlay-node/test-bus");
3412	if (ret == -ENODEV)
3413	unittest(1, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE\n");
3414	else
3415	unittest(0, "overlay_19 of_overlay_remove() injected error for OF_OVERLAY_POST_REMOVE not returned\n");
3416	} else {
3417	unittest(1, "ovcs_id removed for overlay_19\n");
3418	}
3419
3420	unittest(!ovcs_id, "changeset ovcs_id = %d not removed for overlay_19\n",
3421	ovcs_id);
3422
3423	/* --- overlay 20 --- */
3424
3425	unittest(overlay_data_apply("overlay_20", &ovcs_id),
3426	"overlay notify no injected error\n");
3427
3428	if (ovcs_id) {
3429	ret = of_overlay_remove(ovcs_id: &ovcs_id);
3430	if (ret)
3431	unittest(1, "overlay_20 failed to be destroyed, ret = %d\n",
3432	ret);
3433	} else {
3434	unittest(1, "ovcs_id not created for overlay_20\n");
3435	}
3436
3437	unittest(!of_overlay_notifier_unregister(&of_nb),
3438	"of_overlay_notifier_unregister() failed, ret = %d\n", ret);
3439	}
3440
3441	static void __init of_unittest_overlay(void)
3442	{
3443	struct device_node *bus_np = NULL;
3444	unsigned int i;
3445
3446	if (platform_driver_register(&unittest_driver)) {
3447	unittest(0, "could not register unittest driver\n");
3448	goto out;
3449	}
3450
3451	bus_np = of_find_node_by_path(path: bus_path);
3452	if (bus_np == NULL) {
3453	unittest(0, "could not find bus_path \"%s\"\n", bus_path);
3454	goto out;
3455	}
3456
3457	if (of_platform_default_populate(root: bus_np, NULL, NULL)) {
3458	unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
3459	goto out;
3460	}
3461
3462	if (!of_unittest_device_exists(unittest_nr: 100, ovtype: PDEV_OVERLAY)) {
3463	unittest(0, "could not find unittest0 @ \"%s\"\n",
3464	unittest_path(100, PDEV_OVERLAY));
3465	goto out;
3466	}
3467
3468	if (of_unittest_device_exists(unittest_nr: 101, ovtype: PDEV_OVERLAY)) {
3469	unittest(0, "unittest1 @ \"%s\" should not exist\n",
3470	unittest_path(101, PDEV_OVERLAY));
3471	goto out;
3472	}
3473
3474	unittest(1, "basic infrastructure of overlays passed");
3475
3476	/* tests in sequence */
3477	of_unittest_overlay_0();
3478	of_unittest_overlay_1();
3479	of_unittest_overlay_2();
3480	of_unittest_overlay_3();
3481	of_unittest_overlay_4();
3482	for (i = 0; i < 3; i++)
3483	of_unittest_overlay_5();
3484	of_unittest_overlay_6();
3485	of_unittest_overlay_8();
3486
3487	of_unittest_overlay_10();
3488	of_unittest_overlay_11();
3489
3490	#if IS_BUILTIN(CONFIG_I2C)
3491	if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
3492	goto out;
3493
3494	of_unittest_overlay_i2c_12();
3495	of_unittest_overlay_i2c_13();
3496	of_unittest_overlay_i2c_14();
3497	of_unittest_overlay_i2c_15();
3498
3499	of_unittest_overlay_i2c_cleanup();
3500	#endif
3501
3502	of_unittest_overlay_gpio();
3503
3504	of_unittest_remove_tracked_overlays();
3505
3506	of_unittest_overlay_notify();
3507
3508	out:
3509	of_node_put(node: bus_np);
3510	}
3511
3512	#else
3513	static inline void __init of_unittest_overlay(void) { }
3514	#endif
3515
3516	static void __init of_unittest_lifecycle(void)
3517	{
3518	#ifdef CONFIG_OF_DYNAMIC
3519	unsigned int refcount;
3520	int found_refcount_one = 0;
3521	int put_count = 0;
3522	struct device_node *np;
3523	struct device_node *prev_sibling, *next_sibling;
3524	const char *refcount_path = "/testcase-data/refcount-node";
3525	const char *refcount_parent_path = "/testcase-data";
3526
3527	/*
3528	* Node lifecycle tests, non-dynamic node:
3529	*
3530	* - Decrementing refcount to zero via of_node_put() should cause the
3531	* attempt to free the node memory by of_node_release() to fail
3532	* because the node is not a dynamic node.
3533	*
3534	* - Decrementing refcount past zero should result in additional
3535	* errors reported.
3536	*/
3537
3538	np = of_find_node_by_path(path: refcount_path);
3539	unittest(np, "find refcount_path \"%s\"\n", refcount_path);
3540	if (np == NULL)
3541	goto out_skip_tests;
3542
3543	while (!found_refcount_one) {
3544
3545	if (put_count++ > 10) {
3546	unittest(0, "guardrail to avoid infinite loop\n");
3547	goto out_skip_tests;
3548	}
3549
3550	refcount = kref_read(kref: &np->kobj.kref);
3551	if (refcount == 1)
3552	found_refcount_one = 1;
3553	else
3554	of_node_put(node: np);
3555	}
3556
3557	EXPECT_BEGIN(KERN_INFO, "OF: ERROR: of_node_release() detected bad of_node_put() on /testcase-data/refcount-node");
3558
3559	/*
3560	* refcount is now one, decrementing to zero will result in a call to
3561	* of_node_release() to free the node's memory, which should result
3562	* in an error
3563	*/
3564	unittest(1, "/testcase-data/refcount-node is one");
3565	of_node_put(node: np);
3566
3567	EXPECT_END(KERN_INFO, "OF: ERROR: of_node_release() detected bad of_node_put() on /testcase-data/refcount-node");
3568
3569
3570	/*
3571	* expect stack trace for subsequent of_node_put():
3572	* __refcount_sub_and_test() calls:
3573	* refcount_warn_saturate(r, REFCOUNT_SUB_UAF)
3574	*
3575	* Not capturing entire WARN_ONCE() trace with EXPECT_*(), just
3576	* the first three lines, and the last line.
3577	*/
3578	EXPECT_BEGIN(KERN_INFO, "------------[ cut here ]------------");
3579	EXPECT_BEGIN(KERN_INFO, "WARNING: <<all>>");
3580	EXPECT_BEGIN(KERN_INFO, "refcount_t: underflow; use-after-free.");
3581	EXPECT_BEGIN(KERN_INFO, "---[ end trace <<int>> ]---");
3582
3583	/* refcount is now zero, this should fail */
3584	unittest(1, "/testcase-data/refcount-node is zero");
3585	of_node_put(node: np);
3586
3587	EXPECT_END(KERN_INFO, "---[ end trace <<int>> ]---");
3588	EXPECT_END(KERN_INFO, "refcount_t: underflow; use-after-free.");
3589	EXPECT_END(KERN_INFO, "WARNING: <<all>>");
3590	EXPECT_END(KERN_INFO, "------------[ cut here ]------------");
3591
3592	/*
3593	* Q. do we expect to get yet another warning?
3594	* A. no, the WARNING is from WARN_ONCE()
3595	*/
3596	EXPECT_NOT_BEGIN(KERN_INFO, "------------[ cut here ]------------");
3597	EXPECT_NOT_BEGIN(KERN_INFO, "WARNING: <<all>>");
3598	EXPECT_NOT_BEGIN(KERN_INFO, "refcount_t: underflow; use-after-free.");
3599	EXPECT_NOT_BEGIN(KERN_INFO, "---[ end trace <<int>> ]---");
3600
3601	unittest(1, "/testcase-data/refcount-node is zero, second time");
3602	of_node_put(node: np);
3603
3604	EXPECT_NOT_END(KERN_INFO, "---[ end trace <<int>> ]---");
3605	EXPECT_NOT_END(KERN_INFO, "refcount_t: underflow; use-after-free.");
3606	EXPECT_NOT_END(KERN_INFO, "WARNING: <<all>>");
3607	EXPECT_NOT_END(KERN_INFO, "------------[ cut here ]------------");
3608
3609	/*
3610	* refcount of zero will trigger stack traces from any further
3611	* attempt to of_node_get() node "refcount-node". One example of
3612	* this is where of_unittest_check_node_linkage() will recursively
3613	* scan the tree, with 'for_each_child_of_node()' doing an
3614	* of_node_get() of the children of a node.
3615	*
3616	* Prevent the stack trace by removing node "refcount-node" from
3617	* its parent's child list.
3618	*
3619	* WARNING: EVIL, EVIL, EVIL:
3620	*
3621	* Directly manipulate the child list of node /testcase-data to
3622	* remove child refcount-node. This is ignoring all proper methods
3623	* of removing a child and will leak a small amount of memory.
3624	*/
3625
3626	np = of_find_node_by_path(path: refcount_parent_path);
3627	unittest(np, "find refcount_parent_path \"%s\"\n", refcount_parent_path);
3628	unittest(np, "ERROR: devicetree live tree left in a 'bad state' if test fail\n");
3629	if (np == NULL)
3630	return;
3631
3632	prev_sibling = np->child;
3633	next_sibling = prev_sibling->sibling;
3634	if (!strcmp(prev_sibling->full_name, "refcount-node")) {
3635	np->child = next_sibling;
3636	next_sibling = next_sibling->sibling;
3637	}
3638	while (next_sibling) {
3639	if (!strcmp(next_sibling->full_name, "refcount-node"))
3640	prev_sibling->sibling = next_sibling->sibling;
3641	prev_sibling = next_sibling;
3642	next_sibling = next_sibling->sibling;
3643	}
3644	of_node_put(node: np);
3645
3646	return;
3647
3648	out_skip_tests:
3649	#endif
3650	unittest(0, "One or more lifecycle tests skipped\n");
3651	}
3652
3653	#ifdef CONFIG_OF_OVERLAY
3654
3655	/*
3656	* __dtbo_##overlay_name##_begin[] and __dtbo_##overlay_name##_end[] are
3657	* created by cmd_wrap_S_dtbo in scripts/Makefile.dtbs
3658	*/
3659
3660	#define OVERLAY_INFO_EXTERN(overlay_name) \
3661	extern uint8_t __dtbo_##overlay_name##_begin[]; \
3662	extern uint8_t __dtbo_##overlay_name##_end[]
3663
3664	#define OVERLAY_INFO(overlay_name, expected, expected_remove) \
3665	{ .dtbo_begin = __dtbo_##overlay_name##_begin, \
3666	.dtbo_end = __dtbo_##overlay_name##_end, \
3667	.expected_result = expected, \
3668	.expected_result_remove = expected_remove, \
3669	.name = #overlay_name, \
3670	}
3671
3672	struct overlay_info {
3673	uint8_t *dtbo_begin;
3674	uint8_t *dtbo_end;
3675	int expected_result;
3676	int expected_result_remove; /* if apply failed */
3677	int ovcs_id;
3678	char *name;
3679	};
3680
3681	OVERLAY_INFO_EXTERN(overlay_base);
3682	OVERLAY_INFO_EXTERN(overlay);
3683	OVERLAY_INFO_EXTERN(overlay_0);
3684	OVERLAY_INFO_EXTERN(overlay_1);
3685	OVERLAY_INFO_EXTERN(overlay_2);
3686	OVERLAY_INFO_EXTERN(overlay_3);
3687	OVERLAY_INFO_EXTERN(overlay_4);
3688	OVERLAY_INFO_EXTERN(overlay_5);
3689	OVERLAY_INFO_EXTERN(overlay_6);
3690	OVERLAY_INFO_EXTERN(overlay_7);
3691	OVERLAY_INFO_EXTERN(overlay_8);
3692	OVERLAY_INFO_EXTERN(overlay_9);
3693	OVERLAY_INFO_EXTERN(overlay_10);
3694	OVERLAY_INFO_EXTERN(overlay_11);
3695	OVERLAY_INFO_EXTERN(overlay_12);
3696	OVERLAY_INFO_EXTERN(overlay_13);
3697	OVERLAY_INFO_EXTERN(overlay_15);
3698	OVERLAY_INFO_EXTERN(overlay_16);
3699	OVERLAY_INFO_EXTERN(overlay_17);
3700	OVERLAY_INFO_EXTERN(overlay_18);
3701	OVERLAY_INFO_EXTERN(overlay_19);
3702	OVERLAY_INFO_EXTERN(overlay_20);
3703	OVERLAY_INFO_EXTERN(overlay_gpio_01);
3704	OVERLAY_INFO_EXTERN(overlay_gpio_02a);
3705	OVERLAY_INFO_EXTERN(overlay_gpio_02b);
3706	OVERLAY_INFO_EXTERN(overlay_gpio_03);
3707	OVERLAY_INFO_EXTERN(overlay_gpio_04a);
3708	OVERLAY_INFO_EXTERN(overlay_gpio_04b);
3709	OVERLAY_INFO_EXTERN(overlay_pci_node);
3710	OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
3711	OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
3712	OVERLAY_INFO_EXTERN(overlay_bad_phandle);
3713	OVERLAY_INFO_EXTERN(overlay_bad_symbol);
3714	OVERLAY_INFO_EXTERN(overlay_bad_unresolved);
3715
3716	/* entries found by name */
3717	static struct overlay_info overlays[] = {
3718	OVERLAY_INFO(overlay_base, -9999, 0),
3719	OVERLAY_INFO(overlay, 0, 0),
3720	OVERLAY_INFO(overlay_0, 0, 0),
3721	OVERLAY_INFO(overlay_1, 0, 0),
3722	OVERLAY_INFO(overlay_2, 0, 0),
3723	OVERLAY_INFO(overlay_3, 0, 0),
3724	OVERLAY_INFO(overlay_4, 0, 0),
3725	OVERLAY_INFO(overlay_5, 0, 0),
3726	OVERLAY_INFO(overlay_6, 0, 0),
3727	OVERLAY_INFO(overlay_7, 0, 0),
3728	OVERLAY_INFO(overlay_8, 0, 0),
3729	OVERLAY_INFO(overlay_9, 0, 0),
3730	OVERLAY_INFO(overlay_10, 0, 0),
3731	OVERLAY_INFO(overlay_11, 0, 0),
3732	OVERLAY_INFO(overlay_12, 0, 0),
3733	OVERLAY_INFO(overlay_13, 0, 0),
3734	OVERLAY_INFO(overlay_15, 0, 0),
3735	OVERLAY_INFO(overlay_16, -EBUSY, 0),
3736	OVERLAY_INFO(overlay_17, -EEXIST, 0),
3737	OVERLAY_INFO(overlay_18, 0, 0),
3738	OVERLAY_INFO(overlay_19, 0, 0),
3739	OVERLAY_INFO(overlay_20, 0, 0),
3740	OVERLAY_INFO(overlay_gpio_01, 0, 0),
3741	OVERLAY_INFO(overlay_gpio_02a, 0, 0),
3742	OVERLAY_INFO(overlay_gpio_02b, 0, 0),
3743	OVERLAY_INFO(overlay_gpio_03, 0, 0),
3744	OVERLAY_INFO(overlay_gpio_04a, 0, 0),
3745	OVERLAY_INFO(overlay_gpio_04b, 0, 0),
3746	OVERLAY_INFO(overlay_pci_node, 0, 0),
3747	OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL, -ENODEV),
3748	OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL, -ENODEV),
3749	OVERLAY_INFO(overlay_bad_phandle, -EINVAL, 0),
3750	OVERLAY_INFO(overlay_bad_symbol, -EINVAL, -ENODEV),
3751	OVERLAY_INFO(overlay_bad_unresolved, -EINVAL, 0),
3752	/* end marker */
3753	{ }
3754	};
3755
3756	static struct device_node *overlay_base_root;
3757
3758	static void * __init dt_alloc_memory(u64 size, u64 align)
3759	{
3760	return memblock_alloc_or_panic(size, align);
3761	}
3762
3763	/*
3764	* Create base device tree for the overlay unittest.
3765	*
3766	* This is called from very early boot code.
3767	*
3768	* Do as much as possible the same way as done in __unflatten_device_tree
3769	* and other early boot steps for the normal FDT so that the overlay base
3770	* unflattened tree will have the same characteristics as the real tree
3771	* (such as having memory allocated by the early allocator). The goal
3772	* is to test "the real thing" as much as possible, and test "test setup
3773	* code" as little as possible.
3774	*
3775	* Have to stop before resolving phandles, because that uses kmalloc.
3776	*/
3777	void __init unittest_unflatten_overlay_base(void)
3778	{
3779	struct overlay_info *info;
3780	u32 data_size;
3781	void *new_fdt;
3782	u32 size;
3783	int found = 0;
3784	const char *overlay_name = "overlay_base";
3785
3786	for (info = overlays; info && info->name; info++) {
3787	if (!strcmp(overlay_name, info->name)) {
3788	found = 1;
3789	break;
3790	}
3791	}
3792	if (!found) {
3793	pr_err("no overlay data for %s\n", overlay_name);
3794	return;
3795	}
3796
3797	info = &overlays[0];
3798
3799	if (info->expected_result != -9999) {
3800	pr_err("No dtb 'overlay_base' to attach\n");
3801	return;
3802	}
3803
3804	data_size = info->dtbo_end - info->dtbo_begin;
3805	if (!data_size) {
3806	pr_err("No dtb 'overlay_base' to attach\n");
3807	return;
3808	}
3809
3810	size = fdt_totalsize(info->dtbo_begin);
3811	if (size != data_size) {
3812	pr_err("dtb 'overlay_base' header totalsize != actual size");
3813	return;
3814	}
3815
3816	new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
3817	if (!new_fdt) {
3818	pr_err("alloc for dtb 'overlay_base' failed");
3819	return;
3820	}
3821
3822	memcpy(new_fdt, info->dtbo_begin, size);
3823
3824	__unflatten_device_tree(blob: new_fdt, NULL, mynodes: &overlay_base_root,
3825	dt_alloc: dt_alloc_memory, detached: true);
3826	}
3827
3828	/*
3829	* The purpose of of_unittest_overlay_data_add is to add an
3830	* overlay in the normal fashion. This is a test of the whole
3831	* picture, instead of testing individual elements.
3832	*
3833	* A secondary purpose is to be able to verify that the contents of
3834	* /proc/device-tree/ contains the updated structure and values from
3835	* the overlay. That must be verified separately in user space.
3836	*
3837	* Return 0 on unexpected error.
3838	*/
3839	static int __init overlay_data_apply(const char *overlay_name, int *ovcs_id)
3840	{
3841	struct overlay_info *info;
3842	int passed = 1;
3843	int found = 0;
3844	int ret, ret2;
3845	u32 size;
3846
3847	for (info = overlays; info && info->name; info++) {
3848	if (!strcmp(overlay_name, info->name)) {
3849	found = 1;
3850	break;
3851	}
3852	}
3853	if (!found) {
3854	pr_err("no overlay data for %s\n", overlay_name);
3855	return 0;
3856	}
3857
3858	size = info->dtbo_end - info->dtbo_begin;
3859	if (!size)
3860	pr_err("no overlay data for %s\n", overlay_name);
3861
3862	ret = of_overlay_fdt_apply(overlay_fdt: info->dtbo_begin, overlay_fdt_size: size, ovcs_id: &info->ovcs_id,
3863	NULL);
3864	if (ovcs_id)
3865	*ovcs_id = info->ovcs_id;
3866	if (ret < 0)
3867	goto out;
3868
3869	pr_debug("%s applied\n", overlay_name);
3870
3871	out:
3872	if (ret != info->expected_result) {
3873	pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
3874	info->expected_result, ret, overlay_name);
3875	passed = 0;
3876	}
3877
3878	if (ret < 0) {
3879	/* changeset may be partially applied */
3880	ret2 = of_overlay_remove(ovcs_id: &info->ovcs_id);
3881	if (ret2 != info->expected_result_remove) {
3882	pr_err("of_overlay_remove() expected %d, ret=%d, %s\n",
3883	info->expected_result_remove, ret2,
3884	overlay_name);
3885	passed = 0;
3886	}
3887	}
3888
3889	return passed;
3890	}
3891
3892	/*
3893	* The purpose of of_unittest_overlay_high_level is to add an overlay
3894	* in the normal fashion. This is a test of the whole picture,
3895	* instead of individual elements.
3896	*
3897	* The first part of the function is _not_ normal overlay usage; it is
3898	* finishing splicing the base overlay device tree into the live tree.
3899	*/
3900	static __init void of_unittest_overlay_high_level(void)
3901	{
3902	struct device_node *last_sibling;
3903	struct device_node *np;
3904	struct device_node *of_symbols;
3905	struct device_node *overlay_base_symbols;
3906	struct device_node **pprev;
3907	struct property *prop;
3908	int ret;
3909
3910	if (!overlay_base_root) {
3911	unittest(0, "overlay_base_root not initialized\n");
3912	return;
3913	}
3914
3915	/*
3916	* Could not fixup phandles in unittest_unflatten_overlay_base()
3917	* because kmalloc() was not yet available.
3918	*/
3919	of_overlay_mutex_lock();
3920	of_resolve_phandles(tree: overlay_base_root);
3921	of_overlay_mutex_unlock();
3922
3923
3924	/*
3925	* do not allow overlay_base to duplicate any node already in
3926	* tree, this greatly simplifies the code
3927	*/
3928
3929	/*
3930	* remove overlay_base_root node "__local_fixups", after
3931	* being used by of_resolve_phandles()
3932	*/
3933	pprev = &overlay_base_root->child;
3934	for (np = overlay_base_root->child; np; np = np->sibling) {
3935	if (of_node_name_eq(np, name: "__local_fixups__")) {
3936	*pprev = np->sibling;
3937	break;
3938	}
3939	pprev = &np->sibling;
3940	}
3941
3942	/* remove overlay_base_root node "__symbols__" if in live tree */
3943	of_symbols = of_get_child_by_name(node: of_root, name: "__symbols__");
3944	if (of_symbols) {
3945	/* will have to graft properties from node into live tree */
3946	pprev = &overlay_base_root->child;
3947	for (np = overlay_base_root->child; np; np = np->sibling) {
3948	if (of_node_name_eq(np, name: "__symbols__")) {
3949	overlay_base_symbols = np;
3950	*pprev = np->sibling;
3951	break;
3952	}
3953	pprev = &np->sibling;
3954	}
3955	}
3956
3957	for_each_child_of_node(overlay_base_root, np) {
3958	struct device_node *base_child;
3959	for_each_child_of_node(of_root, base_child) {
3960	if (!strcmp(np->full_name, base_child->full_name)) {
3961	unittest(0, "illegal node name in overlay_base %pOFn",
3962	np);
3963	of_node_put(node: np);
3964	of_node_put(node: base_child);
3965	return;
3966	}
3967	}
3968	}
3969
3970	/*
3971	* overlay 'overlay_base' is not allowed to have root
3972	* properties, so only need to splice nodes into main device tree.
3973	*
3974	* root node of *overlay_base_root will not be freed, it is lost
3975	* memory.
3976	*/
3977
3978	for (np = overlay_base_root->child; np; np = np->sibling)
3979	np->parent = of_root;
3980
3981	mutex_lock(&of_mutex);
3982
3983	for (last_sibling = np = of_root->child; np; np = np->sibling)
3984	last_sibling = np;
3985
3986	if (last_sibling)
3987	last_sibling->sibling = overlay_base_root->child;
3988	else
3989	of_root->child = overlay_base_root->child;
3990
3991	for_each_of_allnodes_from(overlay_base_root, np)
3992	__of_attach_node_sysfs(np);
3993
3994	if (of_symbols) {
3995	struct property *new_prop;
3996	for_each_property_of_node(overlay_base_symbols, prop) {
3997
3998	new_prop = __of_prop_dup(prop, GFP_KERNEL);
3999	if (!new_prop) {
4000	unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
4001	prop->name);
4002	goto err_unlock;
4003	}
4004	if (__of_add_property(np: of_symbols, prop: new_prop)) {
4005	__of_prop_free(prop: new_prop);
4006	/* "name" auto-generated by unflatten */
4007	if (!strcmp(prop->name, "name"))
4008	continue;
4009	unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
4010	prop->name);
4011	goto err_unlock;
4012	}
4013	if (__of_add_property_sysfs(np: of_symbols, pp: new_prop)) {
4014	unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
4015	prop->name);
4016	goto err_unlock;
4017	}
4018	}
4019	}
4020
4021	mutex_unlock(lock: &of_mutex);
4022
4023
4024	/* now do the normal overlay usage test */
4025
4026	/* --- overlay --- */
4027
4028	EXPECT_BEGIN(KERN_ERR,
4029	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
4030	EXPECT_BEGIN(KERN_ERR,
4031	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
4032	EXPECT_BEGIN(KERN_ERR,
4033	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
4034	EXPECT_BEGIN(KERN_ERR,
4035	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
4036	EXPECT_BEGIN(KERN_ERR,
4037	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
4038	EXPECT_BEGIN(KERN_ERR,
4039	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
4040	EXPECT_BEGIN(KERN_ERR,
4041	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
4042	EXPECT_BEGIN(KERN_ERR,
4043	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
4044	EXPECT_BEGIN(KERN_ERR,
4045	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
4046	EXPECT_BEGIN(KERN_ERR,
4047	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
4048	EXPECT_BEGIN(KERN_ERR,
4049	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
4050
4051	ret = overlay_data_apply(overlay_name: "overlay", NULL);
4052
4053	EXPECT_END(KERN_ERR,
4054	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_right");
4055	EXPECT_END(KERN_ERR,
4056	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200_left");
4057	EXPECT_END(KERN_ERR,
4058	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/ride_200");
4059	EXPECT_END(KERN_ERR,
4060	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /__symbols__/hvac_2");
4061	EXPECT_END(KERN_ERR,
4062	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/rate");
4063	EXPECT_END(KERN_ERR,
4064	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/color");
4065	EXPECT_END(KERN_ERR,
4066	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/lights@40000/status");
4067	EXPECT_END(KERN_ERR,
4068	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@40/incline-up");
4069	EXPECT_END(KERN_ERR,
4070	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/ride@100/track@30/incline-up");
4071	EXPECT_END(KERN_ERR,
4072	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/fairway-1/status");
4073	EXPECT_END(KERN_ERR,
4074	"OF: overlay: WARNING: memory leak will occur if overlay removed, property: /testcase-data-2/substation@100/status");
4075
4076	unittest(ret, "Adding overlay 'overlay' failed\n");
4077
4078	/* --- overlay_bad_add_dup_node --- */
4079
4080	EXPECT_BEGIN(KERN_ERR,
4081	"OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
4082	EXPECT_BEGIN(KERN_ERR,
4083	"OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
4084	EXPECT_BEGIN(KERN_ERR,
4085	"OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/controller:name");
4086	EXPECT_BEGIN(KERN_ERR,
4087	"OF: Error reverting changeset (-19)");
4088
4089	unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
4090	"Adding overlay 'overlay_bad_add_dup_node' failed\n");
4091
4092	EXPECT_END(KERN_ERR,
4093	"OF: Error reverting changeset (-19)");
4094	EXPECT_END(KERN_ERR,
4095	"OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/controller:name");
4096	EXPECT_END(KERN_ERR,
4097	"OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/controller/name");
4098	EXPECT_END(KERN_ERR,
4099	"OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/controller");
4100
4101	/* --- overlay_bad_add_dup_prop --- */
4102
4103	EXPECT_BEGIN(KERN_ERR,
4104	"OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
4105	EXPECT_BEGIN(KERN_ERR,
4106	"OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
4107	EXPECT_BEGIN(KERN_ERR,
4108	"OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
4109	EXPECT_BEGIN(KERN_ERR,
4110	"OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/electric:name");
4111	EXPECT_BEGIN(KERN_ERR,
4112	"OF: Error reverting changeset (-19)");
4113
4114	unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
4115	"Adding overlay 'overlay_bad_add_dup_prop' failed\n");
4116
4117	EXPECT_END(KERN_ERR,
4118	"OF: Error reverting changeset (-19)");
4119	EXPECT_END(KERN_ERR,
4120	"OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/motor-1/electric:name");
4121	EXPECT_END(KERN_ERR,
4122	"OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/name");
4123	EXPECT_END(KERN_ERR,
4124	"OF: overlay: ERROR: multiple fragments add, update, and/or delete property /testcase-data-2/substation@100/motor-1/electric/rpm_avail");
4125	EXPECT_END(KERN_ERR,
4126	"OF: overlay: ERROR: multiple fragments add and/or delete node /testcase-data-2/substation@100/motor-1/electric");
4127
4128	/* --- overlay_bad_phandle --- */
4129
4130	unittest(overlay_data_apply("overlay_bad_phandle", NULL),
4131	"Adding overlay 'overlay_bad_phandle' failed\n");
4132
4133	/* --- overlay_bad_symbol --- */
4134
4135	EXPECT_BEGIN(KERN_ERR,
4136	"OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/hvac-medium-2:name");
4137	EXPECT_BEGIN(KERN_ERR,
4138	"OF: Error reverting changeset (-19)");
4139
4140	unittest(overlay_data_apply("overlay_bad_symbol", NULL),
4141	"Adding overlay 'overlay_bad_symbol' failed\n");
4142
4143	EXPECT_END(KERN_ERR,
4144	"OF: Error reverting changeset (-19)");
4145	EXPECT_END(KERN_ERR,
4146	"OF: changeset: apply failed: REMOVE_PROPERTY /testcase-data-2/substation@100/hvac-medium-2:name");
4147
4148	/* --- overlay_bad_unresolved --- */
4149
4150	EXPECT_BEGIN(KERN_ERR,
4151	"OF: resolver: node label 'this_label_does_not_exist' not found in live devicetree symbols table");
4152	EXPECT_BEGIN(KERN_ERR,
4153	"OF: resolver: overlay phandle fixup failed: -22");
4154
4155	unittest(overlay_data_apply("overlay_bad_unresolved", NULL),
4156	"Adding overlay 'overlay_bad_unresolved' failed\n");
4157
4158	EXPECT_END(KERN_ERR,
4159	"OF: resolver: overlay phandle fixup failed: -22");
4160	EXPECT_END(KERN_ERR,
4161	"OF: resolver: node label 'this_label_does_not_exist' not found in live devicetree symbols table");
4162
4163	return;
4164
4165	err_unlock:
4166	mutex_unlock(lock: &of_mutex);
4167	}
4168
4169	static int of_unittest_pci_dev_num;
4170	static int of_unittest_pci_child_num;
4171
4172	/*
4173	* PCI device tree node test driver
4174	*/
4175	static const struct pci_device_id testdrv_pci_ids[] = {
4176	{ PCI_DEVICE(PCI_VENDOR_ID_REDHAT, 0x5), }, /* PCI_VENDOR_ID_REDHAT */
4177	{ 0, }
4178	};
4179
4180	static int testdrv_probe(struct pci_dev *pdev, const struct pci_device_id *id)
4181	{
4182	struct overlay_info *info;
4183	struct device_node *dn;
4184	int ret, ovcs_id;
4185	u32 size;
4186
4187	dn = pdev->dev.of_node;
4188	if (!dn) {
4189	dev_err(&pdev->dev, "does not find bus endpoint");
4190	return -EINVAL;
4191	}
4192
4193	for (info = overlays; info && info->name; info++) {
4194	if (!strcmp(info->name, "overlay_pci_node"))
4195	break;
4196	}
4197	if (!info || !info->name) {
4198	dev_err(&pdev->dev, "no overlay data for overlay_pci_node");
4199	return -ENODEV;
4200	}
4201
4202	size = info->dtbo_end - info->dtbo_begin;
4203	ret = of_overlay_fdt_apply(overlay_fdt: info->dtbo_begin, overlay_fdt_size: size, ovcs_id: &ovcs_id, target_base: dn);
4204	of_node_put(node: dn);
4205	if (ret)
4206	return ret;
4207
4208	of_platform_default_populate(root: dn, NULL, parent: &pdev->dev);
4209	pci_set_drvdata(pdev, data: (void *)(uintptr_t)ovcs_id);
4210
4211	return 0;
4212	}
4213
4214	static void testdrv_remove(struct pci_dev *pdev)
4215	{
4216	int ovcs_id = (int)(uintptr_t)pci_get_drvdata(pdev);
4217
4218	of_platform_depopulate(parent: &pdev->dev);
4219	of_overlay_remove(ovcs_id: &ovcs_id);
4220	}
4221
4222	static struct pci_driver testdrv_driver = {
4223	.name = "pci_dt_testdrv",
4224	.id_table = testdrv_pci_ids,
4225	.probe = testdrv_probe,
4226	.remove = testdrv_remove,
4227	};
4228
4229	static int unittest_pci_probe(struct platform_device *pdev)
4230	{
4231	struct resource *res;
4232	struct device *dev;
4233	u64 exp_addr;
4234
4235	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
4236	if (!res)
4237	return -ENODEV;
4238
4239	dev = &pdev->dev;
4240	while (dev && !dev_is_pci(dev))
4241	dev = dev->parent;
4242	if (!dev) {
4243	pr_err("unable to find parent device\n");
4244	return -ENODEV;
4245	}
4246
4247	exp_addr = pci_resource_start(to_pci_dev(dev), 0) + 0x100;
4248	unittest(res->start == exp_addr, "Incorrect translated address %llx, expected %llx\n",
4249	(u64)res->start, exp_addr);
4250
4251	of_unittest_pci_child_num++;
4252
4253	return 0;
4254	}
4255
4256	static const struct of_device_id unittest_pci_of_match[] = {
4257	{ .compatible = "unittest-pci" },
4258	{ }
4259	};
4260
4261	static struct platform_driver unittest_pci_driver = {
4262	.probe = unittest_pci_probe,
4263	.driver = {
4264	.name = "unittest-pci",
4265	.of_match_table = unittest_pci_of_match,
4266	},
4267	};
4268
4269	static int of_unittest_pci_node_verify(struct pci_dev *pdev, bool add)
4270	{
4271	struct device_node *pnp, *np = NULL;
4272	struct device *child_dev;
4273	char *path = NULL;
4274	const __be32 *reg;
4275	int rc = 0;
4276
4277	pnp = pdev->dev.of_node;
4278	unittest(pnp, "Failed creating PCI dt node\n");
4279	if (!pnp)
4280	return -ENODEV;
4281
4282	if (add) {
4283	path = kasprintf(GFP_KERNEL, fmt: "%pOF/pci-ep-bus@0/unittest-pci@100", pnp);
4284	np = of_find_node_by_path(path);
4285	unittest(np, "Failed to get unittest-pci node under PCI node\n");
4286	if (!np) {
4287	rc = -ENODEV;
4288	goto failed;
4289	}
4290
4291	reg = of_get_property(node: np, name: "reg", NULL);
4292	unittest(reg, "Failed to get reg property\n");
4293	if (!reg)
4294	rc = -ENODEV;
4295	} else {
4296	path = kasprintf(GFP_KERNEL, fmt: "%pOF/pci-ep-bus@0", pnp);
4297	np = of_find_node_by_path(path);
4298	unittest(!np, "Child device tree node is not removed\n");
4299	child_dev = device_find_any_child(parent: &pdev->dev);
4300	unittest(!child_dev, "Child device is not removed\n");
4301	put_device(dev: child_dev);
4302	}
4303
4304	failed:
4305	kfree(objp: path);
4306	if (np)
4307	of_node_put(node: np);
4308
4309	return rc;
4310	}
4311
4312	static void __init of_unittest_pci_node(void)
4313	{
4314	struct pci_dev *pdev = NULL;
4315	int rc;
4316
4317	if (!IS_ENABLED(CONFIG_PCI_DYNAMIC_OF_NODES))
4318	return;
4319
4320	rc = pci_register_driver(&testdrv_driver);
4321	unittest(!rc, "Failed to register pci test driver; rc = %d\n", rc);
4322	if (rc)
4323	return;
4324
4325	rc = platform_driver_register(&unittest_pci_driver);
4326	if (unittest(!rc, "Failed to register unittest pci driver\n")) {
4327	pci_unregister_driver(dev: &testdrv_driver);
4328	return;
4329	}
4330
4331	while ((pdev = pci_get_device(PCI_VENDOR_ID_REDHAT, device: 0x5, from: pdev)) != NULL) {
4332	of_unittest_pci_node_verify(pdev, add: true);
4333	of_unittest_pci_dev_num++;
4334	}
4335	if (pdev)
4336	pci_dev_put(dev: pdev);
4337
4338	unittest(of_unittest_pci_dev_num,
4339	"No test PCI device been found. Please run QEMU with '-device pci-testdev'\n");
4340	unittest(of_unittest_pci_dev_num == of_unittest_pci_child_num,
4341	"Child device number %d is not expected %d", of_unittest_pci_child_num,
4342	of_unittest_pci_dev_num);
4343
4344	platform_driver_unregister(&unittest_pci_driver);
4345	pci_unregister_driver(dev: &testdrv_driver);
4346
4347	while ((pdev = pci_get_device(PCI_VENDOR_ID_REDHAT, device: 0x5, from: pdev)) != NULL)
4348	of_unittest_pci_node_verify(pdev, add: false);
4349	if (pdev)
4350	pci_dev_put(dev: pdev);
4351	}
4352	#else
4353
4354	static inline __init void of_unittest_overlay_high_level(void) {}
4355	static inline __init void of_unittest_pci_node(void) { }
4356
4357	#endif
4358
4359	static int __init of_unittest(void)
4360	{
4361	struct device_node *np;
4362	int res;
4363
4364	pr_info("start of unittest - you will see error messages\n");
4365
4366	/* Taint the kernel so we know we've run tests. */
4367	add_taint(TAINT_TEST, LOCKDEP_STILL_OK);
4368
4369	/* adding data for unittest */
4370	res = unittest_data_add();
4371	if (res)
4372	return res;
4373	if (!of_aliases)
4374	of_aliases = of_find_node_by_path(path: "/aliases");
4375
4376	np = of_find_node_by_path(path: "/testcase-data/phandle-tests/consumer-a");
4377	if (!np) {
4378	pr_info("No testcase data in device tree; not running tests\n");
4379	return 0;
4380	}
4381	of_node_put(node: np);
4382
4383	of_unittest_check_tree_linkage();
4384	of_unittest_check_phandles();
4385	of_unittest_find_node_by_name();
4386	of_unittest_dynamic();
4387	of_unittest_parse_phandle_with_args();
4388	of_unittest_parse_phandle_with_args_map();
4389	of_unittest_printf();
4390	of_unittest_property_string();
4391	of_unittest_property_copy();
4392	of_unittest_changeset();
4393	of_unittest_changeset_prop();
4394	of_unittest_parse_interrupts();
4395	of_unittest_parse_interrupts_extended();
4396	of_unittest_irq_refcount();
4397	of_unittest_dma_get_max_cpu_address();
4398	of_unittest_parse_dma_ranges();
4399	of_unittest_pci_dma_ranges();
4400	of_unittest_pci_empty_dma_ranges();
4401	of_unittest_bus_ranges();
4402	of_unittest_bus_3cell_ranges();
4403	of_unittest_reg();
4404	of_unittest_translate_addr();
4405	of_unittest_match_node();
4406	of_unittest_platform_populate();
4407	of_unittest_overlay();
4408	of_unittest_lifecycle();
4409	of_unittest_pci_node();
4410
4411	/* Double check linkage after removing testcase data */
4412	of_unittest_check_tree_linkage();
4413
4414	of_unittest_overlay_high_level();
4415
4416	pr_info("end of unittest - %i passed, %i failed\n",
4417	unittest_results.passed, unittest_results.failed);
4418
4419	return 0;
4420	}
4421	late_initcall(of_unittest);
4422