unittest.c 62.6 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
G
Grant Likely 已提交
2 3 4 5
/*
 * Self tests for device tree subsystem
 */

6
#define pr_fmt(fmt) "### dt-test ### " fmt
G
Grant Likely 已提交
7

8
#include <linux/bootmem.h>
G
Grant Likely 已提交
9 10 11
#include <linux/clk.h>
#include <linux/err.h>
#include <linux/errno.h>
12
#include <linux/hashtable.h>
13
#include <linux/libfdt.h>
G
Grant Likely 已提交
14
#include <linux/of.h>
15
#include <linux/of_fdt.h>
16
#include <linux/of_irq.h>
17
#include <linux/of_platform.h>
G
Grant Likely 已提交
18 19 20 21
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/slab.h>
#include <linux/device.h>
22
#include <linux/platform_device.h>
G
Grant Likely 已提交
23

24 25 26
#include <linux/i2c.h>
#include <linux/i2c-mux.h>

27 28
#include <linux/bitops.h>

29 30
#include "of_private.h"

31
static struct unittest_results {
32 33
	int passed;
	int failed;
34
} unittest_results;
35

36
#define unittest(result, fmt, ...) ({ \
37 38
	bool failed = !(result); \
	if (failed) { \
39
		unittest_results.failed++; \
40
		pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
41
	} else { \
42
		unittest_results.passed++; \
43
		pr_debug("pass %s():%i\n", __func__, __LINE__); \
44
	} \
45 46
	failed; \
})
G
Grant Likely 已提交
47

48 49
static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);

50
static void __init of_unittest_find_node_by_name(void)
51 52
{
	struct device_node *np;
53
	const char *options, *name;
54 55

	np = of_find_node_by_path("/testcase-data");
56 57
	name = kasprintf(GFP_KERNEL, "%pOF", np);
	unittest(np && !strcmp("/testcase-data", name),
58 59
		"find /testcase-data failed\n");
	of_node_put(np);
60
	kfree(name);
61 62 63

	/* Test if trailing '/' works */
	np = of_find_node_by_path("/testcase-data/");
64
	unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
65 66

	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
67 68
	name = kasprintf(GFP_KERNEL, "%pOF", np);
	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
69 70
		"find /testcase-data/phandle-tests/consumer-a failed\n");
	of_node_put(np);
71
	kfree(name);
72 73

	np = of_find_node_by_path("testcase-alias");
74 75
	name = kasprintf(GFP_KERNEL, "%pOF", np);
	unittest(np && !strcmp("/testcase-data", name),
76 77
		"find testcase-alias failed\n");
	of_node_put(np);
78
	kfree(name);
79 80 81

	/* Test if trailing '/' works on aliases */
	np = of_find_node_by_path("testcase-alias/");
82
	unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
83 84

	np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
85 86
	name = kasprintf(GFP_KERNEL, "%pOF", np);
	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
87 88
		"find testcase-alias/phandle-tests/consumer-a failed\n");
	of_node_put(np);
89
	kfree(name);
90 91

	np = of_find_node_by_path("/testcase-data/missing-path");
92
	unittest(!np, "non-existent path returned node %pOF\n", np);
93 94 95
	of_node_put(np);

	np = of_find_node_by_path("missing-alias");
96
	unittest(!np, "non-existent alias returned node %pOF\n", np);
97 98 99
	of_node_put(np);

	np = of_find_node_by_path("testcase-alias/missing-path");
100
	unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
101
	of_node_put(np);
102 103

	np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
104
	unittest(np && !strcmp("testoption", options),
105 106 107
		 "option path test failed\n");
	of_node_put(np);

108
	np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
109
	unittest(np && !strcmp("test/option", options),
110 111 112
		 "option path test, subcase #1 failed\n");
	of_node_put(np);

113
	np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
114
	unittest(np && !strcmp("test/option", options),
115 116 117
		 "option path test, subcase #2 failed\n");
	of_node_put(np);

118
	np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
119
	unittest(np, "NULL option path test failed\n");
120 121 122 123
	of_node_put(np);

	np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
				       &options);
124
	unittest(np && !strcmp("testaliasoption", options),
125 126 127
		 "option alias path test failed\n");
	of_node_put(np);

128 129
	np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
				       &options);
130
	unittest(np && !strcmp("test/alias/option", options),
131 132 133
		 "option alias path test, subcase #1 failed\n");
	of_node_put(np);

134
	np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
135
	unittest(np, "NULL option alias path test failed\n");
136 137 138 139
	of_node_put(np);

	options = "testoption";
	np = of_find_node_opts_by_path("testcase-alias", &options);
140
	unittest(np && !options, "option clearing test failed\n");
141 142 143 144
	of_node_put(np);

	options = "testoption";
	np = of_find_node_opts_by_path("/", &options);
145
	unittest(np && !options, "option clearing root node test failed\n");
146
	of_node_put(np);
147 148
}

149
static void __init of_unittest_dynamic(void)
150 151 152 153 154 155 156 157 158 159 160 161 162
{
	struct device_node *np;
	struct property *prop;

	np = of_find_node_by_path("/testcase-data");
	if (!np) {
		pr_err("missing testcase data\n");
		return;
	}

	/* Array of 4 properties for the purpose of testing */
	prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL);
	if (!prop) {
163
		unittest(0, "kzalloc() failed\n");
164 165 166 167 168 169 170
		return;
	}

	/* Add a new property - should pass*/
	prop->name = "new-property";
	prop->value = "new-property-data";
	prop->length = strlen(prop->value);
171
	unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
172 173 174 175 176 177

	/* Try to add an existing property - should fail */
	prop++;
	prop->name = "new-property";
	prop->value = "new-property-data-should-fail";
	prop->length = strlen(prop->value);
178
	unittest(of_add_property(np, prop) != 0,
179 180 181 182 183
		 "Adding an existing property should have failed\n");

	/* Try to modify an existing property - should pass */
	prop->value = "modify-property-data-should-pass";
	prop->length = strlen(prop->value);
184
	unittest(of_update_property(np, prop) == 0,
185 186 187 188 189 190 191
		 "Updating an existing property should have passed\n");

	/* Try to modify non-existent property - should pass*/
	prop++;
	prop->name = "modify-property";
	prop->value = "modify-missing-property-data-should-pass";
	prop->length = strlen(prop->value);
192
	unittest(of_update_property(np, prop) == 0,
193 194 195
		 "Updating a missing property should have passed\n");

	/* Remove property - should pass */
196
	unittest(of_remove_property(np, prop) == 0,
197 198 199 200 201 202 203
		 "Removing a property should have passed\n");

	/* Adding very large property - should pass */
	prop++;
	prop->name = "large-property-PAGE_SIZEx8";
	prop->length = PAGE_SIZE * 8;
	prop->value = kzalloc(prop->length, GFP_KERNEL);
204
	unittest(prop->value != NULL, "Unable to allocate large buffer\n");
205
	if (prop->value)
206
		unittest(of_add_property(np, prop) == 0,
207 208 209
			 "Adding a large property should have passed\n");
}

210
static int __init of_unittest_check_node_linkage(struct device_node *np)
211
{
G
Grant Likely 已提交
212
	struct device_node *child;
213 214 215 216 217 218
	int count = 0, rc;

	for_each_child_of_node(np, child) {
		if (child->parent != np) {
			pr_err("Child node %s links to wrong parent %s\n",
				 child->name, np->name);
219 220
			rc = -EINVAL;
			goto put_child;
221 222
		}

223
		rc = of_unittest_check_node_linkage(child);
224
		if (rc < 0)
225
			goto put_child;
226 227 228 229
		count += rc;
	}

	return count + 1;
230 231 232
put_child:
	of_node_put(child);
	return rc;
233 234
}

235
static void __init of_unittest_check_tree_linkage(void)
236 237 238 239
{
	struct device_node *np;
	int allnode_count = 0, child_count;

G
Grant Likely 已提交
240
	if (!of_root)
241 242 243 244
		return;

	for_each_of_allnodes(np)
		allnode_count++;
245
	child_count = of_unittest_check_node_linkage(of_root);
246

247
	unittest(child_count > 0, "Device node data structure is corrupted\n");
248
	unittest(child_count == allnode_count,
F
Frank Rowand 已提交
249 250
		 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
		 allnode_count, child_count);
251 252 253
	pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
}

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
					  const char *expected)
{
	unsigned char buf[strlen(expected)+10];
	int size, i;

	/* Baseline; check conversion with a large size limit */
	memset(buf, 0xff, sizeof(buf));
	size = snprintf(buf, sizeof(buf) - 2, fmt, np);

	/* use strcmp() instead of strncmp() here to be absolutely sure strings match */
	unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
		"sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
		fmt, expected, buf);

	/* Make sure length limits work */
	size++;
	for (i = 0; i < 2; i++, size--) {
		/* Clear the buffer, and make sure it works correctly still */
		memset(buf, 0xff, sizeof(buf));
		snprintf(buf, size+1, fmt, np);
		unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
			"snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
			size, fmt, expected, buf);
	}
}

static void __init of_unittest_printf(void)
{
	struct device_node *np;
	const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
	char phandle_str[16] = "";

	np = of_find_node_by_path(full_name);
	if (!np) {
		unittest(np, "testcase data missing\n");
		return;
	}

	num_to_str(phandle_str, sizeof(phandle_str), np->phandle);

	of_unittest_printf_one(np, "%pOF",  full_name);
	of_unittest_printf_one(np, "%pOFf", full_name);
	of_unittest_printf_one(np, "%pOFp", phandle_str);
	of_unittest_printf_one(np, "%pOFP", "dev@100");
	of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
	of_unittest_printf_one(np, "%10pOFP", "   dev@100");
	of_unittest_printf_one(np, "%-10pOFP", "dev@100   ");
	of_unittest_printf_one(of_root, "%pOFP", "/");
	of_unittest_printf_one(np, "%pOFF", "----");
	of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
	of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
	of_unittest_printf_one(np, "%pOFc", "test-sub-device");
	of_unittest_printf_one(np, "%pOFC",
			"\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
}

311 312 313 314 315
struct node_hash {
	struct hlist_node node;
	struct device_node *np;
};

316
static DEFINE_HASHTABLE(phandle_ht, 8);
317
static void __init of_unittest_check_phandles(void)
318 319 320 321 322 323 324 325 326 327
{
	struct device_node *np;
	struct node_hash *nh;
	struct hlist_node *tmp;
	int i, dup_count = 0, phandle_count = 0;

	for_each_of_allnodes(np) {
		if (!np->phandle)
			continue;

328
		hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
329
			if (nh->np->phandle == np->phandle) {
330 331
				pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
					np->phandle, nh->np, np);
332 333 334 335 336 337 338 339 340 341
				dup_count++;
				break;
			}
		}

		nh = kzalloc(sizeof(*nh), GFP_KERNEL);
		if (WARN_ON(!nh))
			return;

		nh->np = np;
342
		hash_add(phandle_ht, &nh->node, np->phandle);
343 344
		phandle_count++;
	}
345
	unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
346 347 348
		 dup_count, phandle_count);

	/* Clean up */
349
	hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
350 351 352 353 354
		hash_del(&nh->node);
		kfree(nh);
	}
}

355
static void __init of_unittest_parse_phandle_with_args(void)
G
Grant Likely 已提交
356 357 358
{
	struct device_node *np;
	struct of_phandle_args args;
359
	int i, rc;
G
Grant Likely 已提交
360 361 362 363 364 365 366

	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
	if (!np) {
		pr_err("missing testcase data\n");
		return;
	}

367
	rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
368
	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
369

370
	for (i = 0; i < 8; i++) {
G
Grant Likely 已提交
371
		bool passed = true;
372

G
Grant Likely 已提交
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
		rc = of_parse_phandle_with_args(np, "phandle-list",
						"#phandle-cells", i, &args);

		/* Test the values from tests-phandle.dtsi */
		switch (i) {
		case 0:
			passed &= !rc;
			passed &= (args.args_count == 1);
			passed &= (args.args[0] == (i + 1));
			break;
		case 1:
			passed &= !rc;
			passed &= (args.args_count == 2);
			passed &= (args.args[0] == (i + 1));
			passed &= (args.args[1] == 0);
			break;
		case 2:
			passed &= (rc == -ENOENT);
			break;
		case 3:
			passed &= !rc;
			passed &= (args.args_count == 3);
			passed &= (args.args[0] == (i + 1));
			passed &= (args.args[1] == 4);
			passed &= (args.args[2] == 3);
			break;
		case 4:
			passed &= !rc;
			passed &= (args.args_count == 2);
			passed &= (args.args[0] == (i + 1));
			passed &= (args.args[1] == 100);
			break;
		case 5:
			passed &= !rc;
			passed &= (args.args_count == 0);
			break;
		case 6:
			passed &= !rc;
			passed &= (args.args_count == 1);
			passed &= (args.args[0] == (i + 1));
			break;
		case 7:
415
			passed &= (rc == -ENOENT);
G
Grant Likely 已提交
416 417 418 419 420
			break;
		default:
			passed = false;
		}

421 422
		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
			 i, args.np, rc);
G
Grant Likely 已提交
423 424 425 426 427
	}

	/* Check for missing list property */
	rc = of_parse_phandle_with_args(np, "phandle-list-missing",
					"#phandle-cells", 0, &args);
428
	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
429 430
	rc = of_count_phandle_with_args(np, "phandle-list-missing",
					"#phandle-cells");
431
	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
G
Grant Likely 已提交
432 433 434 435

	/* Check for missing cells property */
	rc = of_parse_phandle_with_args(np, "phandle-list",
					"#phandle-cells-missing", 0, &args);
436
	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
437 438
	rc = of_count_phandle_with_args(np, "phandle-list",
					"#phandle-cells-missing");
439
	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
G
Grant Likely 已提交
440 441 442 443

	/* Check for bad phandle in list */
	rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
					"#phandle-cells", 0, &args);
444
	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
445 446
	rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
					"#phandle-cells");
447
	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
G
Grant Likely 已提交
448 449 450 451

	/* Check for incorrectly formed argument list */
	rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
					"#phandle-cells", 1, &args);
452
	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
453 454
	rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
					"#phandle-cells");
455
	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
G
Grant Likely 已提交
456 457
}

458
static void __init of_unittest_property_string(void)
459
{
460
	const char *strings[4];
461 462 463 464 465 466 467 468 469 470
	struct device_node *np;
	int rc;

	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
	if (!np) {
		pr_err("No testcase data in device tree\n");
		return;
	}

	rc = of_property_match_string(np, "phandle-list-names", "first");
471
	unittest(rc == 0, "first expected:0 got:%i\n", rc);
472
	rc = of_property_match_string(np, "phandle-list-names", "second");
473
	unittest(rc == 1, "second expected:1 got:%i\n", rc);
474
	rc = of_property_match_string(np, "phandle-list-names", "third");
475
	unittest(rc == 2, "third expected:2 got:%i\n", rc);
476
	rc = of_property_match_string(np, "phandle-list-names", "fourth");
477
	unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
478
	rc = of_property_match_string(np, "missing-property", "blah");
479
	unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
480
	rc = of_property_match_string(np, "empty-property", "blah");
481
	unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
482
	rc = of_property_match_string(np, "unterminated-string", "blah");
483
	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
484 485 486

	/* of_property_count_strings() tests */
	rc = of_property_count_strings(np, "string-property");
487
	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
488
	rc = of_property_count_strings(np, "phandle-list-names");
489
	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
490
	rc = of_property_count_strings(np, "unterminated-string");
491
	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
492
	rc = of_property_count_strings(np, "unterminated-string-list");
493
	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
494 495 496

	/* of_property_read_string_index() tests */
	rc = of_property_read_string_index(np, "string-property", 0, strings);
497
	unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
498 499
	strings[0] = NULL;
	rc = of_property_read_string_index(np, "string-property", 1, strings);
500
	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
501
	rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
502
	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
503
	rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
504
	unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
505
	rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
506
	unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
507 508
	strings[0] = NULL;
	rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
509
	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
510 511
	strings[0] = NULL;
	rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
512
	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
513
	rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
514
	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
515 516
	strings[0] = NULL;
	rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
517
	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
518 519 520 521
	strings[1] = NULL;

	/* of_property_read_string_array() tests */
	rc = of_property_read_string_array(np, "string-property", strings, 4);
522
	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
523
	rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
524
	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
525
	rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
526
	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
527 528
	/* -- An incorrectly formed string should cause a failure */
	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
529
	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
530 531 532
	/* -- parsing the correctly formed strings should still work: */
	strings[2] = NULL;
	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
533
	unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
534 535
	strings[1] = NULL;
	rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
536
	unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
537 538
}

539 540 541 542
#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
			(p1)->value && (p2)->value && \
			!memcmp((p1)->value, (p2)->value, (p1)->length) && \
			!strcmp((p1)->name, (p2)->name))
543
static void __init of_unittest_property_copy(void)
544 545 546 547 548 549 550
{
#ifdef CONFIG_OF_DYNAMIC
	struct property p1 = { .name = "p1", .length = 0, .value = "" };
	struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
	struct property *new;

	new = __of_prop_dup(&p1, GFP_KERNEL);
551
	unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
552 553 554 555 556
	kfree(new->value);
	kfree(new->name);
	kfree(new);

	new = __of_prop_dup(&p2, GFP_KERNEL);
557
	unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
558 559 560 561 562 563
	kfree(new->value);
	kfree(new->name);
	kfree(new);
#endif
}

564
static void __init of_unittest_changeset(void)
565 566 567 568 569
{
#ifdef CONFIG_OF_DYNAMIC
	struct property *ppadd, padd = { .name = "prop-add", .length = 0, .value = "" };
	struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
	struct property *ppremove;
570
	struct device_node *n1, *n2, *n21, *nremove, *parent, *np;
571 572
	struct of_changeset chgset;

573
	n1 = __of_node_dup(NULL, "/testcase-data/changeset/n1");
574
	unittest(n1, "testcase setup failure\n");
575
	n2 = __of_node_dup(NULL, "/testcase-data/changeset/n2");
576
	unittest(n2, "testcase setup failure\n");
577
	n21 = __of_node_dup(NULL, "%s/%s", "/testcase-data/changeset/n2", "n21");
578
	unittest(n21, "testcase setup failure %p\n", n21);
579
	nremove = of_find_node_by_path("/testcase-data/changeset/node-remove");
580
	unittest(nremove, "testcase setup failure\n");
581
	ppadd = __of_prop_dup(&padd, GFP_KERNEL);
582
	unittest(ppadd, "testcase setup failure\n");
583
	ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
584
	unittest(ppupdate, "testcase setup failure\n");
585 586 587 588 589 590
	parent = nremove->parent;
	n1->parent = parent;
	n2->parent = parent;
	n21->parent = n2;
	n2->child = n21;
	ppremove = of_find_property(parent, "prop-remove", NULL);
591
	unittest(ppremove, "failed to find removal prop");
592 593

	of_changeset_init(&chgset);
594 595 596 597 598 599 600 601
	unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
	unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
	unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
	unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
	unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop\n");
	unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
	unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
	unittest(!of_changeset_apply(&chgset), "apply failed\n");
602

603
	/* Make sure node names are constructed correctly */
604
	unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
605
		 "'%pOF' not added\n", n21);
606
	of_node_put(np);
607

608
	unittest(!of_changeset_revert(&chgset), "revert failed\n");
609 610 611 612 613

	of_changeset_destroy(&chgset);
#endif
}

614
static void __init of_unittest_parse_interrupts(void)
615 616 617 618 619 620 621 622 623 624 625 626 627
{
	struct device_node *np;
	struct of_phandle_args args;
	int i, rc;

	np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
	if (!np) {
		pr_err("missing testcase data\n");
		return;
	}

	for (i = 0; i < 4; i++) {
		bool passed = true;
628

629 630 631 632 633 634 635
		args.args_count = 0;
		rc = of_irq_parse_one(np, i, &args);

		passed &= !rc;
		passed &= (args.args_count == 1);
		passed &= (args.args[0] == (i + 1));

636 637
		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
			 i, args.np, rc);
638 639 640 641 642 643 644 645 646 647 648
	}
	of_node_put(np);

	np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
	if (!np) {
		pr_err("missing testcase data\n");
		return;
	}

	for (i = 0; i < 4; i++) {
		bool passed = true;
649

650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
		args.args_count = 0;
		rc = of_irq_parse_one(np, i, &args);

		/* Test the values from tests-phandle.dtsi */
		switch (i) {
		case 0:
			passed &= !rc;
			passed &= (args.args_count == 1);
			passed &= (args.args[0] == 9);
			break;
		case 1:
			passed &= !rc;
			passed &= (args.args_count == 3);
			passed &= (args.args[0] == 10);
			passed &= (args.args[1] == 11);
			passed &= (args.args[2] == 12);
			break;
		case 2:
			passed &= !rc;
			passed &= (args.args_count == 2);
			passed &= (args.args[0] == 13);
			passed &= (args.args[1] == 14);
			break;
		case 3:
			passed &= !rc;
			passed &= (args.args_count == 2);
			passed &= (args.args[0] == 15);
			passed &= (args.args[1] == 16);
			break;
		default:
			passed = false;
		}
682 683
		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
			 i, args.np, rc);
684 685 686 687
	}
	of_node_put(np);
}

688
static void __init of_unittest_parse_interrupts_extended(void)
689 690 691 692 693 694 695 696 697 698 699 700 701
{
	struct device_node *np;
	struct of_phandle_args args;
	int i, rc;

	np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
	if (!np) {
		pr_err("missing testcase data\n");
		return;
	}

	for (i = 0; i < 7; i++) {
		bool passed = true;
702

703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
		rc = of_irq_parse_one(np, i, &args);

		/* Test the values from tests-phandle.dtsi */
		switch (i) {
		case 0:
			passed &= !rc;
			passed &= (args.args_count == 1);
			passed &= (args.args[0] == 1);
			break;
		case 1:
			passed &= !rc;
			passed &= (args.args_count == 3);
			passed &= (args.args[0] == 2);
			passed &= (args.args[1] == 3);
			passed &= (args.args[2] == 4);
			break;
		case 2:
			passed &= !rc;
			passed &= (args.args_count == 2);
			passed &= (args.args[0] == 5);
			passed &= (args.args[1] == 6);
			break;
		case 3:
			passed &= !rc;
			passed &= (args.args_count == 1);
			passed &= (args.args[0] == 9);
			break;
		case 4:
			passed &= !rc;
			passed &= (args.args_count == 3);
			passed &= (args.args[0] == 10);
			passed &= (args.args[1] == 11);
			passed &= (args.args[2] == 12);
			break;
		case 5:
			passed &= !rc;
			passed &= (args.args_count == 2);
			passed &= (args.args[0] == 13);
			passed &= (args.args[1] == 14);
			break;
		case 6:
			passed &= !rc;
			passed &= (args.args_count == 1);
			passed &= (args.args[0] == 15);
			break;
		default:
			passed = false;
		}

752 753
		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
			 i, args.np, rc);
754 755 756 757
	}
	of_node_put(np);
}

758
static const struct of_device_id match_node_table[] = {
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
	{ .data = "A", .name = "name0", }, /* Name alone is lowest priority */
	{ .data = "B", .type = "type1", }, /* followed by type alone */

	{ .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
	{ .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
	{ .data = "Cc", .name = "name2", .type = "type2", },

	{ .data = "E", .compatible = "compat3" },
	{ .data = "G", .compatible = "compat2", },
	{ .data = "H", .compatible = "compat2", .name = "name5", },
	{ .data = "I", .compatible = "compat2", .type = "type1", },
	{ .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
	{ .data = "K", .compatible = "compat2", .name = "name9", },
	{}
};

static struct {
	const char *path;
	const char *data;
} match_node_tests[] = {
	{ .path = "/testcase-data/match-node/name0", .data = "A", },
	{ .path = "/testcase-data/match-node/name1", .data = "B", },
	{ .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
	{ .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
	{ .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
	{ .path = "/testcase-data/match-node/name3", .data = "E", },
	{ .path = "/testcase-data/match-node/name4", .data = "G", },
	{ .path = "/testcase-data/match-node/name5", .data = "H", },
	{ .path = "/testcase-data/match-node/name6", .data = "G", },
	{ .path = "/testcase-data/match-node/name7", .data = "I", },
	{ .path = "/testcase-data/match-node/name8", .data = "J", },
	{ .path = "/testcase-data/match-node/name9", .data = "K", },
};

793
static void __init of_unittest_match_node(void)
794 795 796 797 798 799 800 801
{
	struct device_node *np;
	const struct of_device_id *match;
	int i;

	for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
		np = of_find_node_by_path(match_node_tests[i].path);
		if (!np) {
802
			unittest(0, "missing testcase node %s\n",
803 804 805 806 807 808
				match_node_tests[i].path);
			continue;
		}

		match = of_match_node(match_node_table, np);
		if (!match) {
809
			unittest(0, "%s didn't match anything\n",
810 811 812 813 814
				match_node_tests[i].path);
			continue;
		}

		if (strcmp(match->data, match_node_tests[i].data) != 0) {
815
			unittest(0, "%s got wrong match. expected %s, got %s\n",
816 817 818 819
				match_node_tests[i].path, match_node_tests[i].data,
				(const char *)match->data);
			continue;
		}
820
		unittest(1, "passed");
821 822 823
	}
}

824 825 826 827 828
static struct resource test_bus_res = {
	.start = 0xfffffff8,
	.end = 0xfffffff9,
	.flags = IORESOURCE_MEM,
};
829 830
static const struct platform_device_info test_bus_info = {
	.name = "unittest-bus",
831
};
832
static void __init of_unittest_platform_populate(void)
833
{
834 835
	int irq, rc;
	struct device_node *np, *child, *grandchild;
836
	struct platform_device *pdev, *test_bus;
837
	const struct of_device_id match[] = {
838 839 840
		{ .compatible = "test-device", },
		{}
	};
841 842

	np = of_find_node_by_path("/testcase-data");
843
	of_platform_default_populate(np, NULL, NULL);
844 845 846 847

	/* Test that a missing irq domain returns -EPROBE_DEFER */
	np = of_find_node_by_path("/testcase-data/testcase-device1");
	pdev = of_find_device_by_node(np);
848
	unittest(pdev, "device 1 creation failed\n");
849

850
	irq = platform_get_irq(pdev, 0);
851
	unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq);
852 853 854 855

	/* Test that a parsing failure does not return -EPROBE_DEFER */
	np = of_find_node_by_path("/testcase-data/testcase-device2");
	pdev = of_find_device_by_node(np);
856
	unittest(pdev, "device 2 creation failed\n");
857
	irq = platform_get_irq(pdev, 0);
858
	unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq);
859

860
	np = of_find_node_by_path("/testcase-data/platform-tests");
861
	unittest(np, "No testcase data in device tree\n");
862
	if (!np)
863 864
		return;

865 866
	test_bus = platform_device_register_full(&test_bus_info);
	rc = PTR_ERR_OR_ZERO(test_bus);
867
	unittest(!rc, "testbus registration failed; rc=%i\n", rc);
868
	if (rc)
869
		return;
870
	test_bus->dev.of_node = np;
871

872 873 874 875 876 877 878 879 880
	/*
	 * Add a dummy resource to the test bus node after it is
	 * registered to catch problems with un-inserted resources. The
	 * DT code doesn't insert the resources, and it has caused the
	 * kernel to oops in the past. This makes sure the same bug
	 * doesn't crop up again.
	 */
	platform_device_add_resources(test_bus, &test_bus_res, 1);

881
	of_platform_populate(np, match, NULL, &test_bus->dev);
882 883
	for_each_child_of_node(np, child) {
		for_each_child_of_node(child, grandchild)
884
			unittest(of_find_device_by_node(grandchild),
885 886 887
				 "Could not create device for node '%s'\n",
				 grandchild->name);
	}
888

889
	of_platform_depopulate(&test_bus->dev);
890 891
	for_each_child_of_node(np, child) {
		for_each_child_of_node(child, grandchild)
892
			unittest(!of_find_device_by_node(grandchild),
893 894 895 896
				 "device didn't get destroyed '%s'\n",
				 grandchild->name);
	}

897
	platform_device_unregister(test_bus);
898
	of_node_put(np);
899 900
}

901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
/**
 *	update_node_properties - adds the properties
 *	of np into dup node (present in live tree) and
 *	updates parent of children of np to dup.
 *
 *	@np:	node already present in live tree
 *	@dup:	node present in live tree to be updated
 */
static void update_node_properties(struct device_node *np,
					struct device_node *dup)
{
	struct property *prop;
	struct device_node *child;

	for_each_property_of_node(np, prop)
		of_add_property(dup, prop);

	for_each_child_of_node(np, child)
		child->parent = dup;
}

/**
 *	attach_node_and_children - attaches nodes
 *	and its children to live tree
 *
 *	@np:	Node to attach to live tree
 */
static int attach_node_and_children(struct device_node *np)
{
G
Grant Likely 已提交
930
	struct device_node *next, *dup, *child;
931
	unsigned long flags;
932
	const char *full_name;
933

934 935 936
	full_name = kasprintf(GFP_KERNEL, "%pOF", np);
	dup = of_find_node_by_path(full_name);
	kfree(full_name);
G
Grant Likely 已提交
937 938 939 940
	if (dup) {
		update_node_properties(np, dup);
		return 0;
	}
941

G
Grant Likely 已提交
942 943
	child = np->child;
	np->child = NULL;
944 945 946 947 948 949 950 951 952 953 954

	mutex_lock(&of_mutex);
	raw_spin_lock_irqsave(&devtree_lock, flags);
	np->sibling = np->parent->child;
	np->parent->child = np;
	of_node_clear_flag(np, OF_DETACHED);
	raw_spin_unlock_irqrestore(&devtree_lock, flags);

	__of_attach_node_sysfs(np);
	mutex_unlock(&of_mutex);

G
Grant Likely 已提交
955 956 957 958
	while (child) {
		next = child->sibling;
		attach_node_and_children(child);
		child = next;
959 960 961 962 963 964
	}

	return 0;
}

/**
965
 *	unittest_data_add - Reads, copies data from
966 967
 *	linked tree and attaches it to the live tree
 */
968
static int __init unittest_data_add(void)
969
{
970 971
	void *unittest_data;
	struct device_node *unittest_data_node, *np;
972 973 974 975
	/*
	 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
	 * created by cmd_dt_S_dtb in scripts/Makefile.lib
	 */
976 977 978
	extern uint8_t __dtb_testcases_begin[];
	extern uint8_t __dtb_testcases_end[];
	const int size = __dtb_testcases_end - __dtb_testcases_begin;
979
	int rc;
980

981
	if (!size) {
982 983 984 985 986 987
		pr_warn("%s: No testcase data to attach; not running tests\n",
			__func__);
		return -ENODATA;
	}

	/* creating copy */
988
	unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
989

990 991
	if (!unittest_data) {
		pr_warn("%s: Failed to allocate memory for unittest_data; "
992 993 994
			"not running tests\n", __func__);
		return -ENOMEM;
	}
995
	of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
996
	if (!unittest_data_node) {
997 998 999
		pr_warn("%s: No tree to attach; not running tests\n", __func__);
		return -ENODATA;
	}
1000 1001

	/*
1002
	 * This lock normally encloses of_resolve_phandles()
1003 1004 1005
	 */
	of_overlay_mutex_lock();

1006
	rc = of_resolve_phandles(unittest_data_node);
1007 1008
	if (rc) {
		pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1009
		of_overlay_mutex_unlock();
1010 1011
		return -EINVAL;
	}
1012

G
Grant Likely 已提交
1013
	if (!of_root) {
1014
		of_root = unittest_data_node;
1015 1016 1017 1018
		for_each_of_allnodes(np)
			__of_attach_node_sysfs(np);
		of_aliases = of_find_node_by_path("/aliases");
		of_chosen = of_find_node_by_path("/chosen");
1019
		of_overlay_mutex_unlock();
1020 1021
		return 0;
	}
1022 1023

	/* attach the sub-tree to live tree */
1024
	np = unittest_data_node->child;
G
Grant Likely 已提交
1025 1026
	while (np) {
		struct device_node *next = np->sibling;
1027

G
Grant Likely 已提交
1028 1029 1030 1031
		np->parent = of_root;
		attach_node_and_children(np);
		np = next;
	}
1032 1033 1034

	of_overlay_mutex_unlock();

G
Grant Likely 已提交
1035
	return 0;
1036 1037
}

1038 1039
#ifdef CONFIG_OF_OVERLAY

1040
static int unittest_probe(struct platform_device *pdev)
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
{
	struct device *dev = &pdev->dev;
	struct device_node *np = dev->of_node;

	if (np == NULL) {
		dev_err(dev, "No OF data for device\n");
		return -EINVAL;

	}

1051
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1052 1053 1054

	of_platform_populate(np, NULL, NULL, &pdev->dev);

1055 1056 1057
	return 0;
}

1058
static int unittest_remove(struct platform_device *pdev)
1059 1060 1061 1062
{
	struct device *dev = &pdev->dev;
	struct device_node *np = dev->of_node;

1063
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1064 1065 1066
	return 0;
}

1067
static const struct of_device_id unittest_match[] = {
1068
	{ .compatible = "unittest", },
1069 1070 1071
	{},
};

1072 1073 1074
static struct platform_driver unittest_driver = {
	.probe			= unittest_probe,
	.remove			= unittest_remove,
1075
	.driver = {
1076 1077
		.name		= "unittest",
		.of_match_table	= of_match_ptr(unittest_match),
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
	},
};

/* get the platform device instantiated at the path */
static struct platform_device *of_path_to_platform_device(const char *path)
{
	struct device_node *np;
	struct platform_device *pdev;

	np = of_find_node_by_path(path);
	if (np == NULL)
		return NULL;

	pdev = of_find_device_by_node(np);
	of_node_put(np);

	return pdev;
}

/* find out if a platform device exists at that path */
static int of_path_platform_device_exists(const char *path)
{
	struct platform_device *pdev;

	pdev = of_path_to_platform_device(path);
	platform_device_put(pdev);
	return pdev != NULL;
}

A
Arnd Bergmann 已提交
1107
#if IS_BUILTIN(CONFIG_I2C)
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148

/* get the i2c client device instantiated at the path */
static struct i2c_client *of_path_to_i2c_client(const char *path)
{
	struct device_node *np;
	struct i2c_client *client;

	np = of_find_node_by_path(path);
	if (np == NULL)
		return NULL;

	client = of_find_i2c_device_by_node(np);
	of_node_put(np);

	return client;
}

/* find out if a i2c client device exists at that path */
static int of_path_i2c_client_exists(const char *path)
{
	struct i2c_client *client;

	client = of_path_to_i2c_client(path);
	if (client)
		put_device(&client->dev);
	return client != NULL;
}
#else
static int of_path_i2c_client_exists(const char *path)
{
	return 0;
}
#endif

enum overlay_type {
	PDEV_OVERLAY,
	I2C_OVERLAY
};

static int of_path_device_type_exists(const char *path,
		enum overlay_type ovtype)
1149
{
1150 1151 1152 1153 1154 1155 1156 1157 1158
	switch (ovtype) {
	case PDEV_OVERLAY:
		return of_path_platform_device_exists(path);
	case I2C_OVERLAY:
		return of_path_i2c_client_exists(path);
	}
	return 0;
}

1159
static const char *unittest_path(int nr, enum overlay_type ovtype)
1160 1161
{
	const char *base;
1162 1163
	static char buf[256];

1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
	switch (ovtype) {
	case PDEV_OVERLAY:
		base = "/testcase-data/overlay-node/test-bus";
		break;
	case I2C_OVERLAY:
		base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
		break;
	default:
		buf[0] = '\0';
		return buf;
	}
1175
	snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1176 1177 1178 1179
	buf[sizeof(buf) - 1] = '\0';
	return buf;
}

1180
static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1181 1182 1183
{
	const char *path;

1184
	path = unittest_path(unittest_nr, ovtype);
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194

	switch (ovtype) {
	case PDEV_OVERLAY:
		return of_path_platform_device_exists(path);
	case I2C_OVERLAY:
		return of_path_i2c_client_exists(path);
	}
	return 0;
}

1195
static const char *overlay_name_from_nr(int nr)
1196 1197 1198 1199
{
	static char buf[256];

	snprintf(buf, sizeof(buf) - 1,
1200
		"overlay_%d", nr);
1201 1202 1203 1204 1205 1206 1207
	buf[sizeof(buf) - 1] = '\0';

	return buf;
}

static const char *bus_path = "/testcase-data/overlay-node/test-bus";

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
/* it is guaranteed that overlay ids are assigned in sequence */
#define MAX_UNITTEST_OVERLAYS	256
static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
static int overlay_first_id = -1;

static void of_unittest_track_overlay(int id)
{
	if (overlay_first_id < 0)
		overlay_first_id = id;
	id -= overlay_first_id;

	/* we shouldn't need that many */
	BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
	overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
}

static void of_unittest_untrack_overlay(int id)
{
	if (overlay_first_id < 0)
		return;
	id -= overlay_first_id;
	BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
	overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
}

static void of_unittest_destroy_tracked_overlays(void)
{
1235
	int id, ret, defers, ovcs_id;
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

	if (overlay_first_id < 0)
		return;

	/* try until no defers */
	do {
		defers = 0;
		/* remove in reverse order */
		for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
			if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
				continue;

1248 1249
			ovcs_id = id + overlay_first_id;
			ret = of_overlay_remove(&ovcs_id);
1250 1251 1252 1253 1254
			if (ret == -ENODEV) {
				pr_warn("%s: no overlay to destroy for #%d\n",
					__func__, id + overlay_first_id);
				continue;
			}
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
			if (ret != 0) {
				defers++;
				pr_warn("%s: overlay destroy failed for #%d\n",
					__func__, id + overlay_first_id);
				continue;
			}

			overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
		}
	} while (defers > 0);
}

1267
static int __init of_unittest_apply_overlay(int overlay_nr, int unittest_nr,
1268 1269 1270
		int *overlay_id)
{
	struct device_node *np = NULL;
1271
	const char *overlay_name;
1272
	int ret;
1273

1274
	overlay_name = overlay_name_from_nr(overlay_nr);
1275

1276 1277 1278 1279
	ret = overlay_data_apply(overlay_name, overlay_id);
	if (!ret) {
		unittest(0, "could not apply overlay \"%s\"\n",
				overlay_name);
1280 1281
		goto out;
	}
1282
	of_unittest_track_overlay(*overlay_id);
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292

	ret = 0;

out:
	of_node_put(np);

	return ret;
}

/* apply an overlay while checking before and after states */
1293 1294 1295
static int __init of_unittest_apply_overlay_check(int overlay_nr,
		int unittest_nr, int before, int after,
		enum overlay_type ovtype)
1296
{
1297
	int ret, ovcs_id;
1298

1299 1300
	/* unittest device must not be in before state */
	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1301 1302
		unittest(0, "%s with device @\"%s\" %s\n",
				overlay_name_from_nr(overlay_nr),
1303
				unittest_path(unittest_nr, ovtype),
1304 1305 1306 1307
				!before ? "enabled" : "disabled");
		return -EINVAL;
	}

1308 1309
	ovcs_id = 0;
	ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1310
	if (ret != 0) {
1311
		/* of_unittest_apply_overlay already called unittest() */
1312 1313 1314
		return ret;
	}

1315 1316
	/* unittest device must be to set to after state */
	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1317 1318
		unittest(0, "%s failed to create @\"%s\" %s\n",
				overlay_name_from_nr(overlay_nr),
1319
				unittest_path(unittest_nr, ovtype),
1320 1321 1322 1323 1324 1325 1326 1327
				!after ? "enabled" : "disabled");
		return -EINVAL;
	}

	return 0;
}

/* apply an overlay and then revert it while checking before, after states */
1328
static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1329
		int unittest_nr, int before, int after,
1330
		enum overlay_type ovtype)
1331
{
1332
	int ret, ovcs_id;
1333

1334 1335
	/* unittest device must be in before state */
	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1336 1337
		unittest(0, "%s with device @\"%s\" %s\n",
				overlay_name_from_nr(overlay_nr),
1338
				unittest_path(unittest_nr, ovtype),
1339 1340 1341 1342 1343
				!before ? "enabled" : "disabled");
		return -EINVAL;
	}

	/* apply the overlay */
1344 1345
	ovcs_id = 0;
	ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ovcs_id);
1346
	if (ret != 0) {
1347
		/* of_unittest_apply_overlay already called unittest() */
1348 1349 1350
		return ret;
	}

1351 1352
	/* unittest device must be in after state */
	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1353 1354
		unittest(0, "%s failed to create @\"%s\" %s\n",
				overlay_name_from_nr(overlay_nr),
1355
				unittest_path(unittest_nr, ovtype),
1356 1357 1358 1359
				!after ? "enabled" : "disabled");
		return -EINVAL;
	}

1360
	ret = of_overlay_remove(&ovcs_id);
1361
	if (ret != 0) {
1362 1363
		unittest(0, "%s failed to be destroyed @\"%s\"\n",
				overlay_name_from_nr(overlay_nr),
1364
				unittest_path(unittest_nr, ovtype));
1365 1366 1367
		return ret;
	}

1368 1369
	/* unittest device must be again in before state */
	if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1370 1371
		unittest(0, "%s with device @\"%s\" %s\n",
				overlay_name_from_nr(overlay_nr),
1372
				unittest_path(unittest_nr, ovtype),
1373 1374 1375 1376 1377 1378 1379 1380
				!before ? "enabled" : "disabled");
		return -EINVAL;
	}

	return 0;
}

/* test activation of device */
1381
static void __init of_unittest_overlay_0(void)
1382 1383 1384 1385
{
	int ret;

	/* device should enable */
1386
	ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
1387 1388 1389
	if (ret != 0)
		return;

1390
	unittest(1, "overlay test %d passed\n", 0);
1391 1392 1393
}

/* test deactivation of device */
1394
static void __init of_unittest_overlay_1(void)
1395 1396 1397 1398
{
	int ret;

	/* device should disable */
1399
	ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
1400 1401 1402
	if (ret != 0)
		return;

1403
	unittest(1, "overlay test %d passed\n", 1);
1404 1405 1406
}

/* test activation of device */
1407
static void __init of_unittest_overlay_2(void)
1408 1409 1410 1411
{
	int ret;

	/* device should enable */
1412
	ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
1413 1414 1415
	if (ret != 0)
		return;

1416
	unittest(1, "overlay test %d passed\n", 2);
1417 1418 1419
}

/* test deactivation of device */
1420
static void __init of_unittest_overlay_3(void)
1421 1422 1423 1424
{
	int ret;

	/* device should disable */
1425
	ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
1426 1427 1428
	if (ret != 0)
		return;

1429
	unittest(1, "overlay test %d passed\n", 3);
1430 1431 1432
}

/* test activation of a full device node */
1433
static void __init of_unittest_overlay_4(void)
1434 1435 1436 1437
{
	int ret;

	/* device should disable */
1438
	ret = of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY);
1439 1440 1441
	if (ret != 0)
		return;

1442
	unittest(1, "overlay test %d passed\n", 4);
1443 1444 1445
}

/* test overlay apply/revert sequence */
1446
static void __init of_unittest_overlay_5(void)
1447 1448 1449 1450
{
	int ret;

	/* device should disable */
1451
	ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
1452 1453 1454
	if (ret != 0)
		return;

1455
	unittest(1, "overlay test %d passed\n", 5);
1456 1457 1458
}

/* test overlay application in sequence */
1459
static void __init of_unittest_overlay_6(void)
1460
{
1461
	int ret, i, ov_id[2], ovcs_id;
1462
	int overlay_nr = 6, unittest_nr = 6;
1463
	int before = 0, after = 1;
1464
	const char *overlay_name;
1465

1466
	/* unittest device must be in before state */
1467
	for (i = 0; i < 2; i++) {
1468
		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1469
				!= before) {
1470 1471
			unittest(0, "%s with device @\"%s\" %s\n",
					overlay_name_from_nr(overlay_nr + i),
1472
					unittest_path(unittest_nr + i,
1473
						PDEV_OVERLAY),
1474 1475 1476 1477 1478 1479 1480 1481
					!before ? "enabled" : "disabled");
			return;
		}
	}

	/* apply the overlays */
	for (i = 0; i < 2; i++) {

1482
		overlay_name = overlay_name_from_nr(overlay_nr + i);
1483

1484 1485 1486 1487
		ret = overlay_data_apply(overlay_name, &ovcs_id);
		if (!ret)  {
			unittest(0, "could not apply overlay \"%s\"\n",
					overlay_name);
1488 1489
			return;
		}
1490
		ov_id[i] = ovcs_id;
1491
		of_unittest_track_overlay(ov_id[i]);
1492 1493 1494
	}

	for (i = 0; i < 2; i++) {
1495 1496
		/* unittest device must be in after state */
		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1497
				!= after) {
1498
			unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1499
					overlay_name_from_nr(overlay_nr + i),
1500
					unittest_path(unittest_nr + i,
1501
						PDEV_OVERLAY),
1502 1503 1504 1505 1506 1507
					!after ? "enabled" : "disabled");
			return;
		}
	}

	for (i = 1; i >= 0; i--) {
1508 1509
		ovcs_id = ov_id[i];
		ret = of_overlay_remove(&ovcs_id);
1510
		if (ret != 0) {
1511 1512
			unittest(0, "%s failed destroy @\"%s\"\n",
					overlay_name_from_nr(overlay_nr + i),
1513
					unittest_path(unittest_nr + i,
1514
						PDEV_OVERLAY));
1515 1516
			return;
		}
1517
		of_unittest_untrack_overlay(ov_id[i]);
1518 1519 1520
	}

	for (i = 0; i < 2; i++) {
1521 1522
		/* unittest device must be again in before state */
		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1523
				!= before) {
1524 1525
			unittest(0, "%s with device @\"%s\" %s\n",
					overlay_name_from_nr(overlay_nr + i),
1526
					unittest_path(unittest_nr + i,
1527
						PDEV_OVERLAY),
1528 1529 1530 1531 1532
					!before ? "enabled" : "disabled");
			return;
		}
	}

1533
	unittest(1, "overlay test %d passed\n", 6);
1534 1535 1536
}

/* test overlay application in sequence */
1537
static void __init of_unittest_overlay_8(void)
1538
{
1539
	int ret, i, ov_id[2], ovcs_id;
1540
	int overlay_nr = 8, unittest_nr = 8;
1541
	const char *overlay_name;
1542 1543 1544 1545 1546 1547

	/* we don't care about device state in this test */

	/* apply the overlays */
	for (i = 0; i < 2; i++) {

1548
		overlay_name = overlay_name_from_nr(overlay_nr + i);
1549

1550
		ret = overlay_data_apply(overlay_name, &ovcs_id);
1551
		if (ret < 0)  {
1552 1553
			unittest(0, "could not apply overlay \"%s\"\n",
					overlay_name);
1554 1555
			return;
		}
1556
		ov_id[i] = ovcs_id;
1557
		of_unittest_track_overlay(ov_id[i]);
1558 1559 1560
	}

	/* now try to remove first overlay (it should fail) */
1561 1562
	ovcs_id = ov_id[0];
	ret = of_overlay_remove(&ovcs_id);
1563
	if (ret == 0) {
1564 1565
		unittest(0, "%s was destroyed @\"%s\"\n",
				overlay_name_from_nr(overlay_nr + 0),
1566
				unittest_path(unittest_nr,
1567
					PDEV_OVERLAY));
1568 1569 1570 1571 1572
		return;
	}

	/* removing them in order should work */
	for (i = 1; i >= 0; i--) {
1573 1574
		ovcs_id = ov_id[i];
		ret = of_overlay_remove(&ovcs_id);
1575
		if (ret != 0) {
1576 1577
			unittest(0, "%s not destroyed @\"%s\"\n",
					overlay_name_from_nr(overlay_nr + i),
1578
					unittest_path(unittest_nr,
1579
						PDEV_OVERLAY));
1580 1581
			return;
		}
1582
		of_unittest_untrack_overlay(ov_id[i]);
1583 1584
	}

1585
	unittest(1, "overlay test %d passed\n", 8);
1586 1587
}

1588
/* test insertion of a bus with parent devices */
1589
static void __init of_unittest_overlay_10(void)
1590 1591 1592 1593 1594
{
	int ret;
	char *child_path;

	/* device should disable */
1595 1596
	ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
	if (unittest(ret == 0,
1597
			"overlay test %d failed; overlay application\n", 10))
1598 1599
		return;

1600 1601 1602
	child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
			unittest_path(10, PDEV_OVERLAY));
	if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1603 1604
		return;

1605
	ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1606
	kfree(child_path);
1607
	if (unittest(ret, "overlay test %d failed; no child device\n", 10))
1608 1609 1610 1611
		return;
}

/* test insertion of a bus with parent devices (and revert) */
1612
static void __init of_unittest_overlay_11(void)
1613 1614 1615 1616
{
	int ret;

	/* device should disable */
1617
	ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1618
			PDEV_OVERLAY);
1619
	if (unittest(ret == 0,
1620 1621 1622 1623
			"overlay test %d failed; overlay application\n", 11))
		return;
}

A
Arnd Bergmann 已提交
1624
#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1625

1626
struct unittest_i2c_bus_data {
1627 1628 1629 1630
	struct platform_device	*pdev;
	struct i2c_adapter	adap;
};

1631
static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1632 1633
		struct i2c_msg *msgs, int num)
{
1634
	struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1635 1636 1637 1638 1639 1640

	(void)std;

	return num;
}

1641
static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1642 1643 1644 1645
{
	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
}

1646 1647 1648
static const struct i2c_algorithm unittest_i2c_algo = {
	.master_xfer	= unittest_i2c_master_xfer,
	.functionality	= unittest_i2c_functionality,
1649 1650
};

1651
static int unittest_i2c_bus_probe(struct platform_device *pdev)
1652 1653 1654
{
	struct device *dev = &pdev->dev;
	struct device_node *np = dev->of_node;
1655
	struct unittest_i2c_bus_data *std;
1656 1657 1658 1659 1660 1661 1662 1663 1664
	struct i2c_adapter *adap;
	int ret;

	if (np == NULL) {
		dev_err(dev, "No OF data for device\n");
		return -EINVAL;

	}

1665
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1666 1667 1668

	std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
	if (!std) {
1669
		dev_err(dev, "Failed to allocate unittest i2c data\n");
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
		return -ENOMEM;
	}

	/* link them together */
	std->pdev = pdev;
	platform_set_drvdata(pdev, std);

	adap = &std->adap;
	i2c_set_adapdata(adap, std);
	adap->nr = -1;
	strlcpy(adap->name, pdev->name, sizeof(adap->name));
	adap->class = I2C_CLASS_DEPRECATED;
1682
	adap->algo = &unittest_i2c_algo;
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
	adap->dev.parent = dev;
	adap->dev.of_node = dev->of_node;
	adap->timeout = 5 * HZ;
	adap->retries = 3;

	ret = i2c_add_numbered_adapter(adap);
	if (ret != 0) {
		dev_err(dev, "Failed to add I2C adapter\n");
		return ret;
	}

	return 0;
}

1697
static int unittest_i2c_bus_remove(struct platform_device *pdev)
1698 1699 1700
{
	struct device *dev = &pdev->dev;
	struct device_node *np = dev->of_node;
1701
	struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1702

1703
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1704 1705 1706 1707 1708
	i2c_del_adapter(&std->adap);

	return 0;
}

1709
static const struct of_device_id unittest_i2c_bus_match[] = {
1710
	{ .compatible = "unittest-i2c-bus", },
1711 1712 1713
	{},
};

1714 1715 1716
static struct platform_driver unittest_i2c_bus_driver = {
	.probe			= unittest_i2c_bus_probe,
	.remove			= unittest_i2c_bus_remove,
1717
	.driver = {
1718 1719
		.name		= "unittest-i2c-bus",
		.of_match_table	= of_match_ptr(unittest_i2c_bus_match),
1720 1721 1722
	},
};

1723
static int unittest_i2c_dev_probe(struct i2c_client *client,
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
		const struct i2c_device_id *id)
{
	struct device *dev = &client->dev;
	struct device_node *np = client->dev.of_node;

	if (!np) {
		dev_err(dev, "No OF node\n");
		return -EINVAL;
	}

1734
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1735 1736 1737 1738

	return 0;
};

1739
static int unittest_i2c_dev_remove(struct i2c_client *client)
1740 1741 1742 1743
{
	struct device *dev = &client->dev;
	struct device_node *np = client->dev.of_node;

1744
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1745 1746 1747
	return 0;
}

1748 1749
static const struct i2c_device_id unittest_i2c_dev_id[] = {
	{ .name = "unittest-i2c-dev" },
1750 1751 1752
	{ }
};

1753
static struct i2c_driver unittest_i2c_dev_driver = {
1754
	.driver = {
1755
		.name = "unittest-i2c-dev",
1756
	},
1757 1758 1759
	.probe = unittest_i2c_dev_probe,
	.remove = unittest_i2c_dev_remove,
	.id_table = unittest_i2c_dev_id,
1760 1761
};

A
Arnd Bergmann 已提交
1762
#if IS_BUILTIN(CONFIG_I2C_MUX)
1763

1764
static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1765 1766 1767 1768
{
	return 0;
}

1769
static int unittest_i2c_mux_probe(struct i2c_client *client,
1770 1771
		const struct i2c_device_id *id)
{
1772
	int ret, i, nchans;
1773 1774 1775
	struct device *dev = &client->dev;
	struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
	struct device_node *np = client->dev.of_node, *child;
1776
	struct i2c_mux_core *muxc;
1777 1778
	u32 reg, max_reg;

1779
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799

	if (!np) {
		dev_err(dev, "No OF node\n");
		return -EINVAL;
	}

	max_reg = (u32)-1;
	for_each_child_of_node(np, child) {
		ret = of_property_read_u32(child, "reg", &reg);
		if (ret)
			continue;
		if (max_reg == (u32)-1 || reg > max_reg)
			max_reg = reg;
	}
	nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
	if (nchans == 0) {
		dev_err(dev, "No channels\n");
		return -EINVAL;
	}

1800 1801 1802
	muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
			     unittest_i2c_mux_select_chan, NULL);
	if (!muxc)
1803 1804
		return -ENOMEM;
	for (i = 0; i < nchans; i++) {
1805 1806
		ret = i2c_mux_add_adapter(muxc, 0, i, 0);
		if (ret) {
1807
			dev_err(dev, "Failed to register mux #%d\n", i);
1808
			i2c_mux_del_adapters(muxc);
1809 1810 1811 1812
			return -ENODEV;
		}
	}

1813
	i2c_set_clientdata(client, muxc);
1814 1815 1816 1817

	return 0;
};

1818
static int unittest_i2c_mux_remove(struct i2c_client *client)
1819 1820 1821
{
	struct device *dev = &client->dev;
	struct device_node *np = client->dev.of_node;
1822
	struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1823

1824
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1825
	i2c_mux_del_adapters(muxc);
1826 1827 1828
	return 0;
}

1829 1830
static const struct i2c_device_id unittest_i2c_mux_id[] = {
	{ .name = "unittest-i2c-mux" },
1831 1832 1833
	{ }
};

1834
static struct i2c_driver unittest_i2c_mux_driver = {
1835
	.driver = {
1836
		.name = "unittest-i2c-mux",
1837
	},
1838 1839 1840
	.probe = unittest_i2c_mux_probe,
	.remove = unittest_i2c_mux_remove,
	.id_table = unittest_i2c_mux_id,
1841 1842 1843 1844
};

#endif

1845
static int of_unittest_overlay_i2c_init(void)
1846 1847 1848
{
	int ret;

1849 1850 1851
	ret = i2c_add_driver(&unittest_i2c_dev_driver);
	if (unittest(ret == 0,
			"could not register unittest i2c device driver\n"))
1852 1853
		return ret;

1854 1855 1856
	ret = platform_driver_register(&unittest_i2c_bus_driver);
	if (unittest(ret == 0,
			"could not register unittest i2c bus driver\n"))
1857 1858
		return ret;

A
Arnd Bergmann 已提交
1859
#if IS_BUILTIN(CONFIG_I2C_MUX)
1860 1861 1862
	ret = i2c_add_driver(&unittest_i2c_mux_driver);
	if (unittest(ret == 0,
			"could not register unittest i2c mux driver\n"))
1863 1864 1865 1866 1867 1868
		return ret;
#endif

	return 0;
}

1869
static void of_unittest_overlay_i2c_cleanup(void)
1870
{
A
Arnd Bergmann 已提交
1871
#if IS_BUILTIN(CONFIG_I2C_MUX)
1872
	i2c_del_driver(&unittest_i2c_mux_driver);
1873
#endif
1874 1875
	platform_driver_unregister(&unittest_i2c_bus_driver);
	i2c_del_driver(&unittest_i2c_dev_driver);
1876 1877
}

1878
static void __init of_unittest_overlay_i2c_12(void)
1879 1880 1881 1882
{
	int ret;

	/* device should enable */
1883
	ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
1884 1885 1886
	if (ret != 0)
		return;

1887
	unittest(1, "overlay test %d passed\n", 12);
1888 1889 1890
}

/* test deactivation of device */
1891
static void __init of_unittest_overlay_i2c_13(void)
1892 1893 1894 1895
{
	int ret;

	/* device should disable */
1896
	ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
1897
	if (ret != 0)
1898
		return;
1899

1900
	unittest(1, "overlay test %d passed\n", 13);
1901 1902 1903
}

/* just check for i2c mux existence */
1904
static void of_unittest_overlay_i2c_14(void)
1905
{
1906 1907
}

1908
static void __init of_unittest_overlay_i2c_15(void)
1909 1910 1911 1912
{
	int ret;

	/* device should enable */
1913
	ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
1914 1915 1916
	if (ret != 0)
		return;

1917
	unittest(1, "overlay test %d passed\n", 15);
1918 1919 1920 1921
}

#else

1922 1923
static inline void of_unittest_overlay_i2c_14(void) { }
static inline void of_unittest_overlay_i2c_15(void) { }
1924 1925 1926

#endif

1927
static void __init of_unittest_overlay(void)
1928 1929 1930 1931
{
	struct device_node *bus_np = NULL;
	int ret;

1932
	ret = platform_driver_register(&unittest_driver);
1933
	if (ret != 0) {
1934
		unittest(0, "could not register unittest driver\n");
1935 1936 1937 1938 1939
		goto out;
	}

	bus_np = of_find_node_by_path(bus_path);
	if (bus_np == NULL) {
1940
		unittest(0, "could not find bus_path \"%s\"\n", bus_path);
1941 1942 1943
		goto out;
	}

1944
	ret = of_platform_default_populate(bus_np, NULL, NULL);
1945
	if (ret != 0) {
1946
		unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
1947 1948 1949
		goto out;
	}

1950 1951 1952
	if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
		unittest(0, "could not find unittest0 @ \"%s\"\n",
				unittest_path(100, PDEV_OVERLAY));
1953 1954 1955
		goto out;
	}

1956 1957 1958
	if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
		unittest(0, "unittest1 @ \"%s\" should not exist\n",
				unittest_path(101, PDEV_OVERLAY));
1959 1960 1961
		goto out;
	}

1962
	unittest(1, "basic infrastructure of overlays passed");
1963 1964

	/* tests in sequence */
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
	of_unittest_overlay_0();
	of_unittest_overlay_1();
	of_unittest_overlay_2();
	of_unittest_overlay_3();
	of_unittest_overlay_4();
	of_unittest_overlay_5();
	of_unittest_overlay_6();
	of_unittest_overlay_8();

	of_unittest_overlay_10();
	of_unittest_overlay_11();
1976

A
Arnd Bergmann 已提交
1977
#if IS_BUILTIN(CONFIG_I2C)
1978
	if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
1979 1980
		goto out;

1981 1982 1983 1984
	of_unittest_overlay_i2c_12();
	of_unittest_overlay_i2c_13();
	of_unittest_overlay_i2c_14();
	of_unittest_overlay_i2c_15();
1985

1986
	of_unittest_overlay_i2c_cleanup();
1987 1988
#endif

1989 1990
	of_unittest_destroy_tracked_overlays();

1991 1992 1993 1994 1995
out:
	of_node_put(bus_np);
}

#else
1996
static inline void __init of_unittest_overlay(void) { }
1997 1998
#endif

1999 2000
#ifdef CONFIG_OF_OVERLAY

2001 2002 2003 2004 2005 2006 2007 2008 2009
/*
 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
 * in scripts/Makefile.lib
 */

#define OVERLAY_INFO_EXTERN(name) \
	extern uint8_t __dtb_##name##_begin[]; \
	extern uint8_t __dtb_##name##_end[]

2010 2011 2012 2013 2014
#define OVERLAY_INFO(overlay_name, expected)             \
{	.dtb_begin       = __dtb_##overlay_name##_begin, \
	.dtb_end         = __dtb_##overlay_name##_end,   \
	.expected_result = expected,                     \
	.name            = #overlay_name,                \
2015 2016 2017
}

struct overlay_info {
2018 2019 2020 2021 2022
	uint8_t		*dtb_begin;
	uint8_t		*dtb_end;
	int		expected_result;
	int		overlay_id;
	char		*name;
2023 2024 2025 2026
};

OVERLAY_INFO_EXTERN(overlay_base);
OVERLAY_INFO_EXTERN(overlay);
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041
OVERLAY_INFO_EXTERN(overlay_0);
OVERLAY_INFO_EXTERN(overlay_1);
OVERLAY_INFO_EXTERN(overlay_2);
OVERLAY_INFO_EXTERN(overlay_3);
OVERLAY_INFO_EXTERN(overlay_4);
OVERLAY_INFO_EXTERN(overlay_5);
OVERLAY_INFO_EXTERN(overlay_6);
OVERLAY_INFO_EXTERN(overlay_7);
OVERLAY_INFO_EXTERN(overlay_8);
OVERLAY_INFO_EXTERN(overlay_9);
OVERLAY_INFO_EXTERN(overlay_10);
OVERLAY_INFO_EXTERN(overlay_11);
OVERLAY_INFO_EXTERN(overlay_12);
OVERLAY_INFO_EXTERN(overlay_13);
OVERLAY_INFO_EXTERN(overlay_15);
2042
OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2043
OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2044 2045 2046 2047 2048

/* order of entries is hard-coded into users of overlays[] */
static struct overlay_info overlays[] = {
	OVERLAY_INFO(overlay_base, -9999),
	OVERLAY_INFO(overlay, 0),
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063
	OVERLAY_INFO(overlay_0, 0),
	OVERLAY_INFO(overlay_1, 0),
	OVERLAY_INFO(overlay_2, 0),
	OVERLAY_INFO(overlay_3, 0),
	OVERLAY_INFO(overlay_4, 0),
	OVERLAY_INFO(overlay_5, 0),
	OVERLAY_INFO(overlay_6, 0),
	OVERLAY_INFO(overlay_7, 0),
	OVERLAY_INFO(overlay_8, 0),
	OVERLAY_INFO(overlay_9, 0),
	OVERLAY_INFO(overlay_10, 0),
	OVERLAY_INFO(overlay_11, 0),
	OVERLAY_INFO(overlay_12, 0),
	OVERLAY_INFO(overlay_13, 0),
	OVERLAY_INFO(overlay_15, 0),
2064
	OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2065
	OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2066 2067 2068 2069 2070
	{}
};

static struct device_node *overlay_base_root;

2071 2072 2073 2074 2075
static void * __init dt_alloc_memory(u64 size, u64 align)
{
	return memblock_virt_alloc(size, align);
}

2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
/*
 * Create base device tree for the overlay unittest.
 *
 * This is called from very early boot code.
 *
 * Do as much as possible the same way as done in __unflatten_device_tree
 * and other early boot steps for the normal FDT so that the overlay base
 * unflattened tree will have the same characteristics as the real tree
 * (such as having memory allocated by the early allocator).  The goal
 * is to test "the real thing" as much as possible, and test "test setup
 * code" as little as possible.
 *
 * Have to stop before resolving phandles, because that uses kmalloc.
 */
void __init unittest_unflatten_overlay_base(void)
{
	struct overlay_info *info;
	u32 data_size;
2094
	void *new_fdt;
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
	u32 size;

	info = &overlays[0];

	if (info->expected_result != -9999) {
		pr_err("No dtb 'overlay_base' to attach\n");
		return;
	}

	data_size = info->dtb_end - info->dtb_begin;
	if (!data_size) {
		pr_err("No dtb 'overlay_base' to attach\n");
		return;
	}

	size = fdt_totalsize(info->dtb_begin);
	if (size != data_size) {
		pr_err("dtb 'overlay_base' header totalsize != actual size");
		return;
	}

2116 2117
	new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
	if (!new_fdt) {
2118 2119 2120 2121
		pr_err("alloc for dtb 'overlay_base' failed");
		return;
	}

2122
	memcpy(new_fdt, info->dtb_begin, size);
2123

2124
	__unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2125
				dt_alloc_memory, true);
2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
}

/*
 * The purpose of of_unittest_overlay_data_add is to add an
 * overlay in the normal fashion.  This is a test of the whole
 * picture, instead of testing individual elements.
 *
 * A secondary purpose is to be able to verify that the contents of
 * /proc/device-tree/ contains the updated structure and values from
 * the overlay.  That must be verified separately in user space.
 *
 * Return 0 on unexpected error.
 */
2139
static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2140 2141
{
	struct overlay_info *info;
2142
	int found = 0;
2143 2144 2145 2146
	int k;
	int ret;
	u32 size;

2147 2148 2149
	for (k = 0, info = overlays; info && info->name; info++, k++) {
		if (!strcmp(overlay_name, info->name)) {
			found = 1;
2150
			break;
2151
		}
2152
	}
2153 2154
	if (!found) {
		pr_err("no overlay data for %s\n", overlay_name);
2155
		return 0;
2156
	}
2157 2158 2159

	size = info->dtb_end - info->dtb_begin;
	if (!size) {
2160
		pr_err("no overlay data for %s\n", overlay_name);
2161 2162 2163
		ret = 0;
	}

2164 2165 2166 2167 2168
	ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
	if (overlay_id)
		*overlay_id = info->overlay_id;
	if (ret < 0)
		goto out;
2169

2170
	pr_debug("%s applied\n", overlay_name);
2171 2172

out:
2173 2174 2175 2176
	if (ret != info->expected_result)
		pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
		       info->expected_result, ret, overlay_name);

2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206
	return (ret == info->expected_result);
}

/*
 * The purpose of of_unittest_overlay_high_level is to add an overlay
 * in the normal fashion.  This is a test of the whole picture,
 * instead of individual elements.
 *
 * The first part of the function is _not_ normal overlay usage; it is
 * finishing splicing the base overlay device tree into the live tree.
 */
static __init void of_unittest_overlay_high_level(void)
{
	struct device_node *last_sibling;
	struct device_node *np;
	struct device_node *of_symbols;
	struct device_node *overlay_base_symbols;
	struct device_node **pprev;
	struct property *prop;
	int ret;

	if (!overlay_base_root) {
		unittest(0, "overlay_base_root not initialized\n");
		return;
	}

	/*
	 * Could not fixup phandles in unittest_unflatten_overlay_base()
	 * because kmalloc() was not yet available.
	 */
2207
	of_overlay_mutex_lock();
2208
	of_resolve_phandles(overlay_base_root);
2209 2210
	of_overlay_mutex_unlock();

2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265

	/*
	 * do not allow overlay_base to duplicate any node already in
	 * tree, this greatly simplifies the code
	 */

	/*
	 * remove overlay_base_root node "__local_fixups", after
	 * being used by of_resolve_phandles()
	 */
	pprev = &overlay_base_root->child;
	for (np = overlay_base_root->child; np; np = np->sibling) {
		if (!of_node_cmp(np->name, "__local_fixups__")) {
			*pprev = np->sibling;
			break;
		}
		pprev = &np->sibling;
	}

	/* remove overlay_base_root node "__symbols__" if in live tree */
	of_symbols = of_get_child_by_name(of_root, "__symbols__");
	if (of_symbols) {
		/* will have to graft properties from node into live tree */
		pprev = &overlay_base_root->child;
		for (np = overlay_base_root->child; np; np = np->sibling) {
			if (!of_node_cmp(np->name, "__symbols__")) {
				overlay_base_symbols = np;
				*pprev = np->sibling;
				break;
			}
			pprev = &np->sibling;
		}
	}

	for (np = overlay_base_root->child; np; np = np->sibling) {
		if (of_get_child_by_name(of_root, np->name)) {
			unittest(0, "illegal node name in overlay_base %s",
				np->name);
			return;
		}
	}

	/*
	 * overlay 'overlay_base' is not allowed to have root
	 * properties, so only need to splice nodes into main device tree.
	 *
	 * root node of *overlay_base_root will not be freed, it is lost
	 * memory.
	 */

	for (np = overlay_base_root->child; np; np = np->sibling)
		np->parent = of_root;

	mutex_lock(&of_mutex);

2266
	for (last_sibling = np = of_root->child; np; np = np->sibling)
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277
		last_sibling = np;

	if (last_sibling)
		last_sibling->sibling = overlay_base_root->child;
	else
		of_root->child = overlay_base_root->child;

	for_each_of_allnodes_from(overlay_base_root, np)
		__of_attach_node_sysfs(np);

	if (of_symbols) {
2278
		struct property *new_prop;
2279
		for_each_property_of_node(overlay_base_symbols, prop) {
2280 2281 2282 2283 2284 2285 2286 2287

			new_prop = __of_prop_dup(prop, GFP_KERNEL);
			if (!new_prop) {
				unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
					 prop->name);
				goto err_unlock;
			}
			ret = __of_add_property(of_symbols, new_prop);
2288
			if (ret) {
2289 2290 2291 2292 2293 2294
				if (!strcmp(new_prop->name, "name")) {
					/* auto-generated by unflatten */
					ret = 0;
					continue;
				}
				unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
2295
					 prop->name);
2296
				goto err_unlock;
2297
			}
2298
			ret = __of_add_property_sysfs(of_symbols, new_prop);
2299
			if (ret) {
2300
				unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2301
					 prop->name);
2302
				goto err_unlock;
2303 2304 2305 2306 2307 2308 2309 2310 2311
			}
		}
	}

	mutex_unlock(&of_mutex);


	/* now do the normal overlay usage test */

2312
	unittest(overlay_data_apply("overlay", NULL),
2313 2314
		 "Adding overlay 'overlay' failed\n");

2315
	unittest(overlay_data_apply("overlay_bad_phandle", NULL),
2316
		 "Adding overlay 'overlay_bad_phandle' failed\n");
2317

2318
	unittest(overlay_data_apply("overlay_bad_symbol", NULL),
2319 2320
		 "Adding overlay 'overlay_bad_symbol' failed\n");

2321 2322 2323 2324
	return;

err_unlock:
	mutex_unlock(&of_mutex);
2325 2326 2327 2328 2329 2330 2331 2332
}

#else

static inline __init void of_unittest_overlay_high_level(void) {}

#endif

2333
static int __init of_unittest(void)
G
Grant Likely 已提交
2334 2335
{
	struct device_node *np;
2336 2337
	int res;

2338 2339
	/* adding data for unittest */
	res = unittest_data_add();
2340 2341
	if (res)
		return res;
2342 2343
	if (!of_aliases)
		of_aliases = of_find_node_by_path("/aliases");
G
Grant Likely 已提交
2344 2345 2346 2347 2348 2349 2350 2351

	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
	if (!np) {
		pr_info("No testcase data in device tree; not running tests\n");
		return 0;
	}
	of_node_put(np);

2352 2353 2354 2355 2356 2357
	pr_info("start of unittest - you will see error messages\n");
	of_unittest_check_tree_linkage();
	of_unittest_check_phandles();
	of_unittest_find_node_by_name();
	of_unittest_dynamic();
	of_unittest_parse_phandle_with_args();
2358
	of_unittest_printf();
2359 2360 2361 2362 2363 2364 2365 2366
	of_unittest_property_string();
	of_unittest_property_copy();
	of_unittest_changeset();
	of_unittest_parse_interrupts();
	of_unittest_parse_interrupts_extended();
	of_unittest_match_node();
	of_unittest_platform_populate();
	of_unittest_overlay();
2367

2368
	/* Double check linkage after removing testcase data */
2369
	of_unittest_check_tree_linkage();
2370

2371 2372
	of_unittest_overlay_high_level();

2373 2374
	pr_info("end of unittest - %i passed, %i failed\n",
		unittest_results.passed, unittest_results.failed);
2375

G
Grant Likely 已提交
2376 2377
	return 0;
}
2378
late_initcall(of_unittest);