unittest.c 62.1 KB
Newer Older
G
Grant Likely 已提交
1 2 3 4
/*
 * Self tests for device tree subsystem
 */

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

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

22 23 24
#include <linux/i2c.h>
#include <linux/i2c-mux.h>

25 26
#include <linux/bitops.h>

27 28
#include "of_private.h"

29
static struct unittest_results {
30 31
	int passed;
	int failed;
32
} unittest_results;
33

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

46
static void __init of_unittest_find_node_by_name(void)
47 48
{
	struct device_node *np;
49
	const char *options, *name;
50 51

	np = of_find_node_by_path("/testcase-data");
52 53
	name = kasprintf(GFP_KERNEL, "%pOF", np);
	unittest(np && !strcmp("/testcase-data", name),
54 55
		"find /testcase-data failed\n");
	of_node_put(np);
56
	kfree(name);
57 58 59

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

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

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

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

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

	np = of_find_node_by_path("/testcase-data/missing-path");
88
	unittest(!np, "non-existent path returned node %pOF\n", np);
89 90 91
	of_node_put(np);

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

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

	np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
100
	unittest(np && !strcmp("testoption", options),
101 102 103
		 "option path test failed\n");
	of_node_put(np);

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

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

114
	np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
115
	unittest(np, "NULL option path test failed\n");
116 117 118 119
	of_node_put(np);

	np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
				       &options);
120
	unittest(np && !strcmp("testaliasoption", options),
121 122 123
		 "option alias path test failed\n");
	of_node_put(np);

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

130
	np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
131
	unittest(np, "NULL option alias path test failed\n");
132 133 134 135
	of_node_put(np);

	options = "testoption";
	np = of_find_node_opts_by_path("testcase-alias", &options);
136
	unittest(np && !options, "option clearing test failed\n");
137 138 139 140
	of_node_put(np);

	options = "testoption";
	np = of_find_node_opts_by_path("/", &options);
141
	unittest(np && !options, "option clearing root node test failed\n");
142
	of_node_put(np);
143 144
}

145
static void __init of_unittest_dynamic(void)
146 147 148 149 150 151 152 153 154 155 156 157 158
{
	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) {
159
		unittest(0, "kzalloc() failed\n");
160 161 162 163 164 165 166
		return;
	}

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

	/* 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);
174
	unittest(of_add_property(np, prop) != 0,
175 176 177 178 179
		 "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);
180
	unittest(of_update_property(np, prop) == 0,
181 182 183 184 185 186 187
		 "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);
188
	unittest(of_update_property(np, prop) == 0,
189 190 191
		 "Updating a missing property should have passed\n");

	/* Remove property - should pass */
192
	unittest(of_remove_property(np, prop) == 0,
193 194 195 196 197 198 199
		 "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);
200
	unittest(prop->value != NULL, "Unable to allocate large buffer\n");
201
	if (prop->value)
202
		unittest(of_add_property(np, prop) == 0,
203 204 205
			 "Adding a large property should have passed\n");
}

206
static int __init of_unittest_check_node_linkage(struct device_node *np)
207
{
G
Grant Likely 已提交
208
	struct device_node *child;
209 210 211 212 213 214
	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);
215 216
			rc = -EINVAL;
			goto put_child;
217 218
		}

219
		rc = of_unittest_check_node_linkage(child);
220
		if (rc < 0)
221
			goto put_child;
222 223 224 225
		count += rc;
	}

	return count + 1;
226 227 228
put_child:
	of_node_put(child);
	return rc;
229 230
}

231
static void __init of_unittest_check_tree_linkage(void)
232 233 234 235
{
	struct device_node *np;
	int allnode_count = 0, child_count;

G
Grant Likely 已提交
236
	if (!of_root)
237 238 239 240
		return;

	for_each_of_allnodes(np)
		allnode_count++;
241
	child_count = of_unittest_check_node_linkage(of_root);
242

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

250 251 252 253 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
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\"");
}

307 308 309 310 311
struct node_hash {
	struct hlist_node node;
	struct device_node *np;
};

312
static DEFINE_HASHTABLE(phandle_ht, 8);
313
static void __init of_unittest_check_phandles(void)
314 315 316 317 318 319 320 321 322 323
{
	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;

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

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

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

	/* Clean up */
345
	hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
346 347 348 349 350
		hash_del(&nh->node);
		kfree(nh);
	}
}

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

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

363
	rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
364
	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
365

366
	for (i = 0; i < 8; i++) {
G
Grant Likely 已提交
367
		bool passed = true;
368

G
Grant Likely 已提交
369 370 371 372 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
		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:
411
			passed &= (rc == -ENOENT);
G
Grant Likely 已提交
412 413 414 415 416
			break;
		default:
			passed = false;
		}

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

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

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

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

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

454
static void __init of_unittest_property_string(void)
455
{
456
	const char *strings[4];
457 458 459 460 461 462 463 464 465 466
	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");
467
	unittest(rc == 0, "first expected:0 got:%i\n", rc);
468
	rc = of_property_match_string(np, "phandle-list-names", "second");
469
	unittest(rc == 1, "second expected:1 got:%i\n", rc);
470
	rc = of_property_match_string(np, "phandle-list-names", "third");
471
	unittest(rc == 2, "third expected:2 got:%i\n", rc);
472
	rc = of_property_match_string(np, "phandle-list-names", "fourth");
473
	unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
474
	rc = of_property_match_string(np, "missing-property", "blah");
475
	unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
476
	rc = of_property_match_string(np, "empty-property", "blah");
477
	unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
478
	rc = of_property_match_string(np, "unterminated-string", "blah");
479
	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
480 481 482

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

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

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

535 536 537 538
#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
			(p1)->value && (p2)->value && \
			!memcmp((p1)->value, (p2)->value, (p1)->length) && \
			!strcmp((p1)->name, (p2)->name))
539
static void __init of_unittest_property_copy(void)
540 541 542 543 544 545 546
{
#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);
547
	unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
548 549 550 551 552
	kfree(new->value);
	kfree(new->name);
	kfree(new);

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

560
static void __init of_unittest_changeset(void)
561 562 563 564 565
{
#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;
566
	struct device_node *n1, *n2, *n21, *nremove, *parent, *np;
567 568
	struct of_changeset chgset;

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

	of_changeset_init(&chgset);
590 591 592 593 594 595 596 597
	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");
598

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

604
	unittest(!of_changeset_revert(&chgset), "revert failed\n");
605 606 607 608 609

	of_changeset_destroy(&chgset);
#endif
}

610
static void __init of_unittest_parse_interrupts(void)
611 612 613 614 615 616 617 618 619 620 621 622 623
{
	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;
624

625 626 627 628 629 630 631
		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));

632 633
		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
			 i, args.np, rc);
634 635 636 637 638 639 640 641 642 643 644
	}
	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;
645

646 647 648 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
		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;
		}
678 679
		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
			 i, args.np, rc);
680 681 682 683
	}
	of_node_put(np);
}

684
static void __init of_unittest_parse_interrupts_extended(void)
685 686 687 688 689 690 691 692 693 694 695 696 697
{
	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;
698

699 700 701 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
		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;
		}

748 749
		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
			 i, args.np, rc);
750 751 752 753
	}
	of_node_put(np);
}

754
static const struct of_device_id match_node_table[] = {
755 756 757 758 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
	{ .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", },
};

789
static void __init of_unittest_match_node(void)
790 791 792 793 794 795 796 797
{
	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) {
798
			unittest(0, "missing testcase node %s\n",
799 800 801 802 803 804
				match_node_tests[i].path);
			continue;
		}

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

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

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

	np = of_find_node_by_path("/testcase-data");
839
	of_platform_default_populate(np, NULL, NULL);
840 841 842 843

	/* 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);
844
	unittest(pdev, "device 1 creation failed\n");
845

846
	irq = platform_get_irq(pdev, 0);
847
	unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq);
848 849 850 851

	/* 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);
852
	unittest(pdev, "device 2 creation failed\n");
853
	irq = platform_get_irq(pdev, 0);
854
	unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq);
855

856
	np = of_find_node_by_path("/testcase-data/platform-tests");
857
	unittest(np, "No testcase data in device tree\n");
858
	if (!np)
859 860
		return;

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

868 869 870 871 872 873 874 875 876
	/*
	 * 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);

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

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

893
	platform_device_unregister(test_bus);
894
	of_node_put(np);
895 896
}

897 898 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
/**
 *	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 已提交
926
	struct device_node *next, *dup, *child;
927
	unsigned long flags;
928
	const char *full_name;
929

930 931 932
	full_name = kasprintf(GFP_KERNEL, "%pOF", np);
	dup = of_find_node_by_path(full_name);
	kfree(full_name);
G
Grant Likely 已提交
933 934 935 936
	if (dup) {
		update_node_properties(np, dup);
		return 0;
	}
937

G
Grant Likely 已提交
938 939
	child = np->child;
	np->child = NULL;
940 941 942 943 944 945 946 947 948 949 950

	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 已提交
951 952 953 954
	while (child) {
		next = child->sibling;
		attach_node_and_children(child);
		child = next;
955 956 957 958 959 960
	}

	return 0;
}

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

977
	if (!size) {
978 979 980 981 982 983
		pr_warn("%s: No testcase data to attach; not running tests\n",
			__func__);
		return -ENODATA;
	}

	/* creating copy */
984
	unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
985

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

	/*
	 * This lock normally encloses of_overlay_apply() as well as
	 * of_resolve_phandles().
	 */
	of_overlay_mutex_lock();

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

G
Grant Likely 已提交
1010
	if (!of_root) {
1011
		of_root = unittest_data_node;
1012 1013 1014 1015
		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");
1016
		of_overlay_mutex_unlock();
1017 1018
		return 0;
	}
1019 1020

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

G
Grant Likely 已提交
1025 1026 1027 1028
		np->parent = of_root;
		attach_node_and_children(np);
		np = next;
	}
1029 1030 1031

	of_overlay_mutex_unlock();

G
Grant Likely 已提交
1032
	return 0;
1033 1034
}

1035 1036
#ifdef CONFIG_OF_OVERLAY

1037
static int unittest_probe(struct platform_device *pdev)
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
{
	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;

	}

1048
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1049 1050 1051

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

1052 1053 1054
	return 0;
}

1055
static int unittest_remove(struct platform_device *pdev)
1056 1057 1058 1059
{
	struct device *dev = &pdev->dev;
	struct device_node *np = dev->of_node;

1060
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1061 1062 1063
	return 0;
}

1064
static const struct of_device_id unittest_match[] = {
1065
	{ .compatible = "unittest", },
1066 1067 1068
	{},
};

1069 1070 1071
static struct platform_driver unittest_driver = {
	.probe			= unittest_probe,
	.remove			= unittest_remove,
1072
	.driver = {
1073 1074
		.name		= "unittest",
		.of_match_table	= of_match_ptr(unittest_match),
1075 1076 1077 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
	},
};

/* 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 已提交
1104
#if IS_BUILTIN(CONFIG_I2C)
1105 1106 1107 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

/* 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)
1146
{
1147 1148 1149 1150 1151 1152 1153 1154 1155
	switch (ovtype) {
	case PDEV_OVERLAY:
		return of_path_platform_device_exists(path);
	case I2C_OVERLAY:
		return of_path_i2c_client_exists(path);
	}
	return 0;
}

1156
static const char *unittest_path(int nr, enum overlay_type ovtype)
1157 1158
{
	const char *base;
1159 1160
	static char buf[256];

1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
	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;
	}
1172
	snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1173 1174 1175 1176
	buf[sizeof(buf) - 1] = '\0';
	return buf;
}

1177
static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1178 1179 1180
{
	const char *path;

1181
	path = unittest_path(unittest_nr, ovtype);
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191

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

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
static const char *overlay_path(int nr)
{
	static char buf[256];

	snprintf(buf, sizeof(buf) - 1,
		"/testcase-data/overlay%d", nr);
	buf[sizeof(buf) - 1] = '\0';

	return buf;
}

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

1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
/* 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)
{
1232
	int id, ret, defers, ovcs_id;
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244

	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;

1245 1246
			ovcs_id = id + overlay_first_id;
			ret = of_overlay_remove(&ovcs_id);
1247 1248 1249 1250 1251
			if (ret == -ENODEV) {
				pr_warn("%s: no overlay to destroy for #%d\n",
					__func__, id + overlay_first_id);
				continue;
			}
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
			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);
}

1264
static int of_unittest_apply_overlay(int overlay_nr, int unittest_nr,
1265 1266 1267
		int *overlay_id)
{
	struct device_node *np = NULL;
1268
	int ret;
1269 1270 1271

	np = of_find_node_by_path(overlay_path(overlay_nr));
	if (np == NULL) {
1272
		unittest(0, "could not find overlay node @\"%s\"\n",
1273 1274 1275 1276 1277
				overlay_path(overlay_nr));
		ret = -EINVAL;
		goto out;
	}

1278 1279
	*overlay_id = 0;
	ret = of_overlay_apply(np, overlay_id);
1280
	if (ret < 0) {
1281
		unittest(0, "could not create overlay from \"%s\"\n",
1282 1283 1284
				overlay_path(overlay_nr));
		goto out;
	}
1285
	of_unittest_track_overlay(*overlay_id);
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295

	ret = 0;

out:
	of_node_put(np);

	return ret;
}

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

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

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

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

	return 0;
}

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

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

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

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

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

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

	return 0;
}

/* test activation of device */
1383
static void of_unittest_overlay_0(void)
1384 1385 1386 1387
{
	int ret;

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

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

/* test deactivation of device */
1396
static void of_unittest_overlay_1(void)
1397 1398 1399 1400
{
	int ret;

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

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

/* test activation of device */
1409
static void of_unittest_overlay_2(void)
1410 1411 1412 1413
{
	int ret;

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

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

/* test deactivation of device */
1422
static void of_unittest_overlay_3(void)
1423 1424 1425 1426
{
	int ret;

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

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

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

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

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

/* test overlay apply/revert sequence */
1448
static void of_unittest_overlay_5(void)
1449 1450 1451 1452
{
	int ret;

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

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

/* test overlay application in sequence */
1461
static void of_unittest_overlay_6(void)
1462 1463
{
	struct device_node *np;
1464
	int ret, i, ov_id[2], ovcs_id;
1465
	int overlay_nr = 6, unittest_nr = 6;
1466 1467
	int before = 0, after = 1;

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

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

		np = of_find_node_by_path(overlay_path(overlay_nr + i));
		if (np == NULL) {
1486
			unittest(0, "could not find overlay node @\"%s\"\n",
1487 1488 1489 1490
					overlay_path(overlay_nr + i));
			return;
		}

1491 1492
		ovcs_id = 0;
		ret = of_overlay_apply(np, &ovcs_id);
1493
		if (ret < 0)  {
1494
			unittest(0, "could not create overlay from \"%s\"\n",
1495 1496 1497
					overlay_path(overlay_nr + i));
			return;
		}
1498
		ov_id[i] = ovcs_id;
1499
		of_unittest_track_overlay(ov_id[i]);
1500 1501 1502
	}

	for (i = 0; i < 2; i++) {
1503 1504
		/* unittest device must be in after state */
		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1505
				!= after) {
1506
			unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1507
					overlay_path(overlay_nr + i),
1508
					unittest_path(unittest_nr + i,
1509
						PDEV_OVERLAY),
1510 1511 1512 1513 1514 1515
					!after ? "enabled" : "disabled");
			return;
		}
	}

	for (i = 1; i >= 0; i--) {
1516 1517
		ovcs_id = ov_id[i];
		ret = of_overlay_remove(&ovcs_id);
1518
		if (ret != 0) {
1519
			unittest(0, "overlay @\"%s\" failed destroy @\"%s\"\n",
1520
					overlay_path(overlay_nr + i),
1521
					unittest_path(unittest_nr + i,
1522
						PDEV_OVERLAY));
1523 1524
			return;
		}
1525
		of_unittest_untrack_overlay(ov_id[i]);
1526 1527 1528
	}

	for (i = 0; i < 2; i++) {
1529 1530
		/* unittest device must be again in before state */
		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1531
				!= before) {
1532
			unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1533
					overlay_path(overlay_nr + i),
1534
					unittest_path(unittest_nr + i,
1535
						PDEV_OVERLAY),
1536 1537 1538 1539 1540
					!before ? "enabled" : "disabled");
			return;
		}
	}

1541
	unittest(1, "overlay test %d passed\n", 6);
1542 1543 1544
}

/* test overlay application in sequence */
1545
static void of_unittest_overlay_8(void)
1546 1547
{
	struct device_node *np;
1548
	int ret, i, ov_id[2], ovcs_id;
1549
	int overlay_nr = 8, unittest_nr = 8;
1550 1551 1552 1553 1554 1555 1556 1557

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

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

		np = of_find_node_by_path(overlay_path(overlay_nr + i));
		if (np == NULL) {
1558
			unittest(0, "could not find overlay node @\"%s\"\n",
1559 1560 1561 1562
					overlay_path(overlay_nr + i));
			return;
		}

1563 1564
		ovcs_id = 0;
		ret = of_overlay_apply(np, &ovcs_id);
1565
		if (ret < 0)  {
1566
			unittest(0, "could not create overlay from \"%s\"\n",
1567 1568 1569
					overlay_path(overlay_nr + i));
			return;
		}
1570
		ov_id[i] = ovcs_id;
1571
		of_unittest_track_overlay(ov_id[i]);
1572 1573 1574
	}

	/* now try to remove first overlay (it should fail) */
1575 1576
	ovcs_id = ov_id[0];
	ret = of_overlay_remove(&ovcs_id);
1577
	if (ret == 0) {
1578
		unittest(0, "overlay @\"%s\" was destroyed @\"%s\"\n",
1579
				overlay_path(overlay_nr + 0),
1580
				unittest_path(unittest_nr,
1581
					PDEV_OVERLAY));
1582 1583 1584 1585 1586
		return;
	}

	/* removing them in order should work */
	for (i = 1; i >= 0; i--) {
1587 1588
		ovcs_id = ov_id[i];
		ret = of_overlay_remove(&ovcs_id);
1589
		if (ret != 0) {
1590
			unittest(0, "overlay @\"%s\" not destroyed @\"%s\"\n",
1591
					overlay_path(overlay_nr + i),
1592
					unittest_path(unittest_nr,
1593
						PDEV_OVERLAY));
1594 1595
			return;
		}
1596
		of_unittest_untrack_overlay(ov_id[i]);
1597 1598
	}

1599
	unittest(1, "overlay test %d passed\n", 8);
1600 1601
}

1602
/* test insertion of a bus with parent devices */
1603
static void of_unittest_overlay_10(void)
1604 1605 1606 1607 1608
{
	int ret;
	char *child_path;

	/* device should disable */
1609 1610
	ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
	if (unittest(ret == 0,
1611
			"overlay test %d failed; overlay application\n", 10))
1612 1613
		return;

1614 1615 1616
	child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
			unittest_path(10, PDEV_OVERLAY));
	if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1617 1618
		return;

1619
	ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1620
	kfree(child_path);
1621
	if (unittest(ret, "overlay test %d failed; no child device\n", 10))
1622 1623 1624 1625
		return;
}

/* test insertion of a bus with parent devices (and revert) */
1626
static void of_unittest_overlay_11(void)
1627 1628 1629 1630
{
	int ret;

	/* device should disable */
1631
	ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1632
			PDEV_OVERLAY);
1633
	if (unittest(ret == 0,
1634 1635 1636 1637
			"overlay test %d failed; overlay application\n", 11))
		return;
}

A
Arnd Bergmann 已提交
1638
#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1639

1640
struct unittest_i2c_bus_data {
1641 1642 1643 1644
	struct platform_device	*pdev;
	struct i2c_adapter	adap;
};

1645
static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1646 1647
		struct i2c_msg *msgs, int num)
{
1648
	struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1649 1650 1651 1652 1653 1654

	(void)std;

	return num;
}

1655
static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1656 1657 1658 1659
{
	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
}

1660 1661 1662
static const struct i2c_algorithm unittest_i2c_algo = {
	.master_xfer	= unittest_i2c_master_xfer,
	.functionality	= unittest_i2c_functionality,
1663 1664
};

1665
static int unittest_i2c_bus_probe(struct platform_device *pdev)
1666 1667 1668
{
	struct device *dev = &pdev->dev;
	struct device_node *np = dev->of_node;
1669
	struct unittest_i2c_bus_data *std;
1670 1671 1672 1673 1674 1675 1676 1677 1678
	struct i2c_adapter *adap;
	int ret;

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

	}

1679
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1680 1681 1682

	std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
	if (!std) {
1683
		dev_err(dev, "Failed to allocate unittest i2c data\n");
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
		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;
1696
	adap->algo = &unittest_i2c_algo;
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
	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;
}

1711
static int unittest_i2c_bus_remove(struct platform_device *pdev)
1712 1713 1714
{
	struct device *dev = &pdev->dev;
	struct device_node *np = dev->of_node;
1715
	struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1716

1717
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1718 1719 1720 1721 1722
	i2c_del_adapter(&std->adap);

	return 0;
}

1723
static const struct of_device_id unittest_i2c_bus_match[] = {
1724
	{ .compatible = "unittest-i2c-bus", },
1725 1726 1727
	{},
};

1728 1729 1730
static struct platform_driver unittest_i2c_bus_driver = {
	.probe			= unittest_i2c_bus_probe,
	.remove			= unittest_i2c_bus_remove,
1731
	.driver = {
1732 1733
		.name		= "unittest-i2c-bus",
		.of_match_table	= of_match_ptr(unittest_i2c_bus_match),
1734 1735 1736
	},
};

1737
static int unittest_i2c_dev_probe(struct i2c_client *client,
1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
		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;
	}

1748
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1749 1750 1751 1752

	return 0;
};

1753
static int unittest_i2c_dev_remove(struct i2c_client *client)
1754 1755 1756 1757
{
	struct device *dev = &client->dev;
	struct device_node *np = client->dev.of_node;

1758
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1759 1760 1761
	return 0;
}

1762 1763
static const struct i2c_device_id unittest_i2c_dev_id[] = {
	{ .name = "unittest-i2c-dev" },
1764 1765 1766
	{ }
};

1767
static struct i2c_driver unittest_i2c_dev_driver = {
1768
	.driver = {
1769
		.name = "unittest-i2c-dev",
1770
	},
1771 1772 1773
	.probe = unittest_i2c_dev_probe,
	.remove = unittest_i2c_dev_remove,
	.id_table = unittest_i2c_dev_id,
1774 1775
};

A
Arnd Bergmann 已提交
1776
#if IS_BUILTIN(CONFIG_I2C_MUX)
1777

1778
static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
1779 1780 1781 1782
{
	return 0;
}

1783
static int unittest_i2c_mux_probe(struct i2c_client *client,
1784 1785
		const struct i2c_device_id *id)
{
1786
	int ret, i, nchans;
1787 1788 1789
	struct device *dev = &client->dev;
	struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
	struct device_node *np = client->dev.of_node, *child;
1790
	struct i2c_mux_core *muxc;
1791 1792
	u32 reg, max_reg;

1793
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813

	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;
	}

1814 1815 1816
	muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
			     unittest_i2c_mux_select_chan, NULL);
	if (!muxc)
1817 1818
		return -ENOMEM;
	for (i = 0; i < nchans; i++) {
1819 1820
		ret = i2c_mux_add_adapter(muxc, 0, i, 0);
		if (ret) {
1821
			dev_err(dev, "Failed to register mux #%d\n", i);
1822
			i2c_mux_del_adapters(muxc);
1823 1824 1825 1826
			return -ENODEV;
		}
	}

1827
	i2c_set_clientdata(client, muxc);
1828 1829 1830 1831

	return 0;
};

1832
static int unittest_i2c_mux_remove(struct i2c_client *client)
1833 1834 1835
{
	struct device *dev = &client->dev;
	struct device_node *np = client->dev.of_node;
1836
	struct i2c_mux_core *muxc = i2c_get_clientdata(client);
1837

1838
	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1839
	i2c_mux_del_adapters(muxc);
1840 1841 1842
	return 0;
}

1843 1844
static const struct i2c_device_id unittest_i2c_mux_id[] = {
	{ .name = "unittest-i2c-mux" },
1845 1846 1847
	{ }
};

1848
static struct i2c_driver unittest_i2c_mux_driver = {
1849
	.driver = {
1850
		.name = "unittest-i2c-mux",
1851
	},
1852 1853 1854
	.probe = unittest_i2c_mux_probe,
	.remove = unittest_i2c_mux_remove,
	.id_table = unittest_i2c_mux_id,
1855 1856 1857 1858
};

#endif

1859
static int of_unittest_overlay_i2c_init(void)
1860 1861 1862
{
	int ret;

1863 1864 1865
	ret = i2c_add_driver(&unittest_i2c_dev_driver);
	if (unittest(ret == 0,
			"could not register unittest i2c device driver\n"))
1866 1867
		return ret;

1868 1869 1870
	ret = platform_driver_register(&unittest_i2c_bus_driver);
	if (unittest(ret == 0,
			"could not register unittest i2c bus driver\n"))
1871 1872
		return ret;

A
Arnd Bergmann 已提交
1873
#if IS_BUILTIN(CONFIG_I2C_MUX)
1874 1875 1876
	ret = i2c_add_driver(&unittest_i2c_mux_driver);
	if (unittest(ret == 0,
			"could not register unittest i2c mux driver\n"))
1877 1878 1879 1880 1881 1882
		return ret;
#endif

	return 0;
}

1883
static void of_unittest_overlay_i2c_cleanup(void)
1884
{
A
Arnd Bergmann 已提交
1885
#if IS_BUILTIN(CONFIG_I2C_MUX)
1886
	i2c_del_driver(&unittest_i2c_mux_driver);
1887
#endif
1888 1889
	platform_driver_unregister(&unittest_i2c_bus_driver);
	i2c_del_driver(&unittest_i2c_dev_driver);
1890 1891
}

1892
static void of_unittest_overlay_i2c_12(void)
1893 1894 1895 1896
{
	int ret;

	/* device should enable */
1897
	ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
1898 1899 1900
	if (ret != 0)
		return;

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

/* test deactivation of device */
1905
static void of_unittest_overlay_i2c_13(void)
1906 1907 1908 1909
{
	int ret;

	/* device should disable */
1910
	ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
1911
	if (ret != 0)
1912
		return;
1913

1914
	unittest(1, "overlay test %d passed\n", 13);
1915 1916 1917
}

/* just check for i2c mux existence */
1918
static void of_unittest_overlay_i2c_14(void)
1919
{
1920 1921
}

1922
static void of_unittest_overlay_i2c_15(void)
1923 1924 1925 1926
{
	int ret;

	/* device should enable */
1927
	ret = of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY);
1928 1929 1930
	if (ret != 0)
		return;

1931
	unittest(1, "overlay test %d passed\n", 15);
1932 1933 1934 1935
}

#else

1936 1937
static inline void of_unittest_overlay_i2c_14(void) { }
static inline void of_unittest_overlay_i2c_15(void) { }
1938 1939 1940

#endif

1941
static void __init of_unittest_overlay(void)
1942 1943 1944 1945
{
	struct device_node *bus_np = NULL;
	int ret;

1946
	ret = platform_driver_register(&unittest_driver);
1947
	if (ret != 0) {
1948
		unittest(0, "could not register unittest driver\n");
1949 1950 1951 1952 1953
		goto out;
	}

	bus_np = of_find_node_by_path(bus_path);
	if (bus_np == NULL) {
1954
		unittest(0, "could not find bus_path \"%s\"\n", bus_path);
1955 1956 1957
		goto out;
	}

1958
	ret = of_platform_default_populate(bus_np, NULL, NULL);
1959
	if (ret != 0) {
1960
		unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
1961 1962 1963
		goto out;
	}

1964 1965 1966
	if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
		unittest(0, "could not find unittest0 @ \"%s\"\n",
				unittest_path(100, PDEV_OVERLAY));
1967 1968 1969
		goto out;
	}

1970 1971 1972
	if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
		unittest(0, "unittest1 @ \"%s\" should not exist\n",
				unittest_path(101, PDEV_OVERLAY));
1973 1974 1975
		goto out;
	}

1976
	unittest(1, "basic infrastructure of overlays passed");
1977 1978

	/* tests in sequence */
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
	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();
1990

A
Arnd Bergmann 已提交
1991
#if IS_BUILTIN(CONFIG_I2C)
1992
	if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
1993 1994
		goto out;

1995 1996 1997 1998
	of_unittest_overlay_i2c_12();
	of_unittest_overlay_i2c_13();
	of_unittest_overlay_i2c_14();
	of_unittest_overlay_i2c_15();
1999

2000
	of_unittest_overlay_i2c_cleanup();
2001 2002
#endif

2003 2004
	of_unittest_destroy_tracked_overlays();

2005 2006 2007 2008 2009
out:
	of_node_put(bus_np);
}

#else
2010
static inline void __init of_unittest_overlay(void) { }
2011 2012
#endif

2013 2014
#ifdef CONFIG_OF_OVERLAY

2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041
/*
 * __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[]

#define OVERLAY_INFO(name, expected) \
{	.dtb_begin	 = __dtb_##name##_begin, \
	.dtb_end	 = __dtb_##name##_end, \
	.expected_result = expected, \
}

struct overlay_info {
	uint8_t		   *dtb_begin;
	uint8_t		   *dtb_end;
	void		   *data;
	struct device_node *np_overlay;
	int		   expected_result;
	int		   overlay_id;
};

OVERLAY_INFO_EXTERN(overlay_base);
OVERLAY_INFO_EXTERN(overlay);
OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2042
OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2043 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),
	OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2049
	OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
	{}
};

static struct device_node *overlay_base_root;

/*
 * 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;
	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;
	}

	info->data = early_init_dt_alloc_memory_arch(size,
					     roundup_pow_of_two(FDT_V17_SIZE));
	if (!info->data) {
		pr_err("alloc for dtb 'overlay_base' failed");
		return;
	}

	memcpy(info->data, info->dtb_begin, size);

	__unflatten_device_tree(info->data, NULL, &info->np_overlay,
				early_init_dt_alloc_memory_arch, true);
	overlay_base_root = info->np_overlay;
}

/*
 * 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.
 */
static int __init overlay_data_add(int onum)
{
	struct overlay_info *info;
	int k;
	int ret;
	u32 size;
	u32 size_from_header;

	for (k = 0, info = overlays; info; info++, k++) {
		if (k == onum)
			break;
	}
	if (onum > k)
		return 0;

	size = info->dtb_end - info->dtb_begin;
	if (!size) {
		pr_err("no overlay to attach, %d\n", onum);
		ret = 0;
	}

	size_from_header = fdt_totalsize(info->dtb_begin);
	if (size_from_header != size) {
		pr_err("overlay header totalsize != actual size, %d", onum);
		return 0;
	}

	/*
	 * Must create permanent copy of FDT because of_fdt_unflatten_tree()
	 * will create pointers to the passed in FDT in the EDT.
	 */
	info->data = kmemdup(info->dtb_begin, size, GFP_KERNEL);
	if (!info->data) {
		pr_err("unable to allocate memory for data, %d\n", onum);
		return 0;
	}

	of_fdt_unflatten_tree(info->data, NULL, &info->np_overlay);
	if (!info->np_overlay) {
		pr_err("unable to unflatten overlay, %d\n", onum);
		ret = 0;
		goto out_free_data;
	}

2163 2164
	info->overlay_id = 0;
	ret = of_overlay_apply(info->np_overlay, &info->overlay_id);
2165
	if (ret < 0) {
2166
		pr_err("of_overlay_apply() (ret=%d), %d\n", ret, onum);
2167
		of_overlay_mutex_unlock();
2168 2169 2170 2171 2172 2173 2174 2175 2176 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 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216
		goto out_free_np_overlay;
	}

	pr_debug("__dtb_overlay_begin applied, overlay id %d\n", ret);

	goto out;

out_free_np_overlay:
	/*
	 * info->np_overlay is the unflattened device tree
	 * It has not been spliced into the live tree.
	 */

	/* todo: function to free unflattened device tree */

out_free_data:
	kfree(info->data);

out:
	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.
	 */
2217
	of_overlay_mutex_lock();
2218
	of_resolve_phandles(overlay_base_root);
2219 2220
	of_overlay_mutex_unlock();

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 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275

	/*
	 * 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);

2276
	for (last_sibling = np = of_root->child; np; np = np->sibling)
2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293
		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) {
		for_each_property_of_node(overlay_base_symbols, prop) {
			ret = __of_add_property(of_symbols, prop);
			if (ret) {
				unittest(0,
					 "duplicate property '%s' in overlay_base node __symbols__",
					 prop->name);
2294
				goto err_unlock;
2295 2296 2297 2298 2299 2300
			}
			ret = __of_add_property_sysfs(of_symbols, prop);
			if (ret) {
				unittest(0,
					 "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
					 prop->name);
2301
				goto err_unlock;
2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315
			}
		}
	}

	mutex_unlock(&of_mutex);


	/* now do the normal overlay usage test */

	unittest(overlay_data_add(1),
		 "Adding overlay 'overlay' failed\n");

	unittest(overlay_data_add(2),
		 "Adding overlay 'overlay_bad_phandle' failed\n");
2316 2317 2318 2319

	unittest(overlay_data_add(3),
		 "Adding overlay 'overlay_bad_symbol' failed\n");

2320 2321 2322 2323
	return;

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

#else

static inline __init void of_unittest_overlay_high_level(void) {}

#endif

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

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

	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);

2351 2352 2353 2354 2355 2356
	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();
2357
	of_unittest_printf();
2358 2359 2360 2361 2362 2363 2364 2365
	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();
2366

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

2370 2371
	of_unittest_overlay_high_level();

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

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