Linux Audio

Check our new training course

Loading...
v4.6
 
   1/*
   2 * Self tests for device tree subsystem
   3 */
   4
   5#define pr_fmt(fmt) "### dt-test ### " fmt
   6
 
   7#include <linux/clk.h>
   8#include <linux/err.h>
   9#include <linux/errno.h>
  10#include <linux/hashtable.h>
  11#include <linux/module.h>
  12#include <linux/of.h>
  13#include <linux/of_fdt.h>
  14#include <linux/of_irq.h>
  15#include <linux/of_platform.h>
  16#include <linux/list.h>
  17#include <linux/mutex.h>
  18#include <linux/slab.h>
  19#include <linux/device.h>
  20#include <linux/platform_device.h>
  21#include <linux/of_platform.h>
  22
  23#include <linux/i2c.h>
  24#include <linux/i2c-mux.h>
  25
  26#include <linux/bitops.h>
  27
  28#include "of_private.h"
  29
  30static struct unittest_results {
  31	int passed;
  32	int failed;
  33} unittest_results;
  34
  35#define unittest(result, fmt, ...) ({ \
  36	bool failed = !(result); \
  37	if (failed) { \
  38		unittest_results.failed++; \
  39		pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \
  40	} else { \
  41		unittest_results.passed++; \
  42		pr_debug("pass %s():%i\n", __func__, __LINE__); \
  43	} \
  44	failed; \
  45})
  46
  47static void __init of_unittest_find_node_by_name(void)
  48{
  49	struct device_node *np;
  50	const char *options;
  51
  52	np = of_find_node_by_path("/testcase-data");
  53	unittest(np && !strcmp("/testcase-data", np->full_name),
 
  54		"find /testcase-data failed\n");
  55	of_node_put(np);
 
  56
  57	/* Test if trailing '/' works */
  58	np = of_find_node_by_path("/testcase-data/");
  59	unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
  60
  61	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
  62	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
 
  63		"find /testcase-data/phandle-tests/consumer-a failed\n");
  64	of_node_put(np);
 
  65
  66	np = of_find_node_by_path("testcase-alias");
  67	unittest(np && !strcmp("/testcase-data", np->full_name),
 
  68		"find testcase-alias failed\n");
  69	of_node_put(np);
 
  70
  71	/* Test if trailing '/' works on aliases */
  72	np = of_find_node_by_path("testcase-alias/");
  73	unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
  74
  75	np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
  76	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name),
 
  77		"find testcase-alias/phandle-tests/consumer-a failed\n");
  78	of_node_put(np);
 
  79
  80	np = of_find_node_by_path("/testcase-data/missing-path");
  81	unittest(!np, "non-existent path returned node %s\n", np->full_name);
  82	of_node_put(np);
  83
  84	np = of_find_node_by_path("missing-alias");
  85	unittest(!np, "non-existent alias returned node %s\n", np->full_name);
  86	of_node_put(np);
  87
  88	np = of_find_node_by_path("testcase-alias/missing-path");
  89	unittest(!np, "non-existent alias with relative path returned node %s\n", np->full_name);
  90	of_node_put(np);
  91
  92	np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
  93	unittest(np && !strcmp("testoption", options),
  94		 "option path test failed\n");
  95	of_node_put(np);
  96
  97	np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
  98	unittest(np && !strcmp("test/option", options),
  99		 "option path test, subcase #1 failed\n");
 100	of_node_put(np);
 101
 102	np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
 103	unittest(np && !strcmp("test/option", options),
 104		 "option path test, subcase #2 failed\n");
 105	of_node_put(np);
 106
 107	np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
 108	unittest(np, "NULL option path test failed\n");
 109	of_node_put(np);
 110
 111	np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
 112				       &options);
 113	unittest(np && !strcmp("testaliasoption", options),
 114		 "option alias path test failed\n");
 115	of_node_put(np);
 116
 117	np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
 118				       &options);
 119	unittest(np && !strcmp("test/alias/option", options),
 120		 "option alias path test, subcase #1 failed\n");
 121	of_node_put(np);
 122
 123	np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
 124	unittest(np, "NULL option alias path test failed\n");
 125	of_node_put(np);
 126
 127	options = "testoption";
 128	np = of_find_node_opts_by_path("testcase-alias", &options);
 129	unittest(np && !options, "option clearing test failed\n");
 130	of_node_put(np);
 131
 132	options = "testoption";
 133	np = of_find_node_opts_by_path("/", &options);
 134	unittest(np && !options, "option clearing root node test failed\n");
 135	of_node_put(np);
 136}
 137
 138static void __init of_unittest_dynamic(void)
 139{
 140	struct device_node *np;
 141	struct property *prop;
 142
 143	np = of_find_node_by_path("/testcase-data");
 144	if (!np) {
 145		pr_err("missing testcase data\n");
 146		return;
 147	}
 148
 149	/* Array of 4 properties for the purpose of testing */
 150	prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL);
 151	if (!prop) {
 152		unittest(0, "kzalloc() failed\n");
 153		return;
 154	}
 155
 156	/* Add a new property - should pass*/
 157	prop->name = "new-property";
 158	prop->value = "new-property-data";
 159	prop->length = strlen(prop->value);
 160	unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
 161
 162	/* Try to add an existing property - should fail */
 163	prop++;
 164	prop->name = "new-property";
 165	prop->value = "new-property-data-should-fail";
 166	prop->length = strlen(prop->value);
 167	unittest(of_add_property(np, prop) != 0,
 168		 "Adding an existing property should have failed\n");
 169
 170	/* Try to modify an existing property - should pass */
 171	prop->value = "modify-property-data-should-pass";
 172	prop->length = strlen(prop->value);
 173	unittest(of_update_property(np, prop) == 0,
 174		 "Updating an existing property should have passed\n");
 175
 176	/* Try to modify non-existent property - should pass*/
 177	prop++;
 178	prop->name = "modify-property";
 179	prop->value = "modify-missing-property-data-should-pass";
 180	prop->length = strlen(prop->value);
 181	unittest(of_update_property(np, prop) == 0,
 182		 "Updating a missing property should have passed\n");
 183
 184	/* Remove property - should pass */
 185	unittest(of_remove_property(np, prop) == 0,
 186		 "Removing a property should have passed\n");
 187
 188	/* Adding very large property - should pass */
 189	prop++;
 190	prop->name = "large-property-PAGE_SIZEx8";
 191	prop->length = PAGE_SIZE * 8;
 192	prop->value = kzalloc(prop->length, GFP_KERNEL);
 193	unittest(prop->value != NULL, "Unable to allocate large buffer\n");
 194	if (prop->value)
 195		unittest(of_add_property(np, prop) == 0,
 196			 "Adding a large property should have passed\n");
 197}
 198
 199static int __init of_unittest_check_node_linkage(struct device_node *np)
 200{
 201	struct device_node *child;
 202	int count = 0, rc;
 203
 204	for_each_child_of_node(np, child) {
 205		if (child->parent != np) {
 206			pr_err("Child node %s links to wrong parent %s\n",
 207				 child->name, np->name);
 208			rc = -EINVAL;
 209			goto put_child;
 210		}
 211
 212		rc = of_unittest_check_node_linkage(child);
 213		if (rc < 0)
 214			goto put_child;
 215		count += rc;
 216	}
 217
 218	return count + 1;
 219put_child:
 220	of_node_put(child);
 221	return rc;
 222}
 223
 224static void __init of_unittest_check_tree_linkage(void)
 225{
 226	struct device_node *np;
 227	int allnode_count = 0, child_count;
 228
 229	if (!of_root)
 230		return;
 231
 232	for_each_of_allnodes(np)
 233		allnode_count++;
 234	child_count = of_unittest_check_node_linkage(of_root);
 235
 236	unittest(child_count > 0, "Device node data structure is corrupted\n");
 237	unittest(child_count == allnode_count,
 238		 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
 239		 allnode_count, child_count);
 240	pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
 241}
 242
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 243struct node_hash {
 244	struct hlist_node node;
 245	struct device_node *np;
 246};
 247
 248static DEFINE_HASHTABLE(phandle_ht, 8);
 249static void __init of_unittest_check_phandles(void)
 250{
 251	struct device_node *np;
 252	struct node_hash *nh;
 253	struct hlist_node *tmp;
 254	int i, dup_count = 0, phandle_count = 0;
 255
 256	for_each_of_allnodes(np) {
 257		if (!np->phandle)
 258			continue;
 259
 260		hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
 261			if (nh->np->phandle == np->phandle) {
 262				pr_info("Duplicate phandle! %i used by %s and %s\n",
 263					np->phandle, nh->np->full_name, np->full_name);
 264				dup_count++;
 265				break;
 266			}
 267		}
 268
 269		nh = kzalloc(sizeof(*nh), GFP_KERNEL);
 270		if (WARN_ON(!nh))
 271			return;
 272
 273		nh->np = np;
 274		hash_add(phandle_ht, &nh->node, np->phandle);
 275		phandle_count++;
 276	}
 277	unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
 278		 dup_count, phandle_count);
 279
 280	/* Clean up */
 281	hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
 282		hash_del(&nh->node);
 283		kfree(nh);
 284	}
 285}
 286
 287static void __init of_unittest_parse_phandle_with_args(void)
 288{
 289	struct device_node *np;
 290	struct of_phandle_args args;
 291	int i, rc;
 292
 293	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 294	if (!np) {
 295		pr_err("missing testcase data\n");
 296		return;
 297	}
 298
 299	rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 300	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 301
 302	for (i = 0; i < 8; i++) {
 303		bool passed = true;
 304
 
 305		rc = of_parse_phandle_with_args(np, "phandle-list",
 306						"#phandle-cells", i, &args);
 307
 308		/* Test the values from tests-phandle.dtsi */
 309		switch (i) {
 310		case 0:
 311			passed &= !rc;
 312			passed &= (args.args_count == 1);
 313			passed &= (args.args[0] == (i + 1));
 314			break;
 315		case 1:
 316			passed &= !rc;
 317			passed &= (args.args_count == 2);
 318			passed &= (args.args[0] == (i + 1));
 319			passed &= (args.args[1] == 0);
 320			break;
 321		case 2:
 322			passed &= (rc == -ENOENT);
 323			break;
 324		case 3:
 325			passed &= !rc;
 326			passed &= (args.args_count == 3);
 327			passed &= (args.args[0] == (i + 1));
 328			passed &= (args.args[1] == 4);
 329			passed &= (args.args[2] == 3);
 330			break;
 331		case 4:
 332			passed &= !rc;
 333			passed &= (args.args_count == 2);
 334			passed &= (args.args[0] == (i + 1));
 335			passed &= (args.args[1] == 100);
 336			break;
 337		case 5:
 338			passed &= !rc;
 339			passed &= (args.args_count == 0);
 340			break;
 341		case 6:
 342			passed &= !rc;
 343			passed &= (args.args_count == 1);
 344			passed &= (args.args[0] == (i + 1));
 345			break;
 346		case 7:
 347			passed &= (rc == -ENOENT);
 348			break;
 349		default:
 350			passed = false;
 351		}
 352
 353		unittest(passed, "index %i - data error on node %s rc=%i\n",
 354			 i, args.np->full_name, rc);
 355	}
 356
 357	/* Check for missing list property */
 
 358	rc = of_parse_phandle_with_args(np, "phandle-list-missing",
 359					"#phandle-cells", 0, &args);
 360	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 361	rc = of_count_phandle_with_args(np, "phandle-list-missing",
 362					"#phandle-cells");
 363	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 364
 365	/* Check for missing cells property */
 
 366	rc = of_parse_phandle_with_args(np, "phandle-list",
 367					"#phandle-cells-missing", 0, &args);
 368	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 369	rc = of_count_phandle_with_args(np, "phandle-list",
 370					"#phandle-cells-missing");
 371	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 372
 373	/* Check for bad phandle in list */
 
 374	rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
 375					"#phandle-cells", 0, &args);
 376	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 377	rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
 378					"#phandle-cells");
 379	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 380
 381	/* Check for incorrectly formed argument list */
 
 382	rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
 383					"#phandle-cells", 1, &args);
 384	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 385	rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
 386					"#phandle-cells");
 387	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 388}
 389
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 390static void __init of_unittest_property_string(void)
 391{
 392	const char *strings[4];
 393	struct device_node *np;
 394	int rc;
 395
 396	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 397	if (!np) {
 398		pr_err("No testcase data in device tree\n");
 399		return;
 400	}
 401
 402	rc = of_property_match_string(np, "phandle-list-names", "first");
 403	unittest(rc == 0, "first expected:0 got:%i\n", rc);
 404	rc = of_property_match_string(np, "phandle-list-names", "second");
 405	unittest(rc == 1, "second expected:1 got:%i\n", rc);
 406	rc = of_property_match_string(np, "phandle-list-names", "third");
 407	unittest(rc == 2, "third expected:2 got:%i\n", rc);
 408	rc = of_property_match_string(np, "phandle-list-names", "fourth");
 409	unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
 410	rc = of_property_match_string(np, "missing-property", "blah");
 411	unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
 412	rc = of_property_match_string(np, "empty-property", "blah");
 413	unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
 414	rc = of_property_match_string(np, "unterminated-string", "blah");
 415	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 416
 417	/* of_property_count_strings() tests */
 418	rc = of_property_count_strings(np, "string-property");
 419	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 420	rc = of_property_count_strings(np, "phandle-list-names");
 421	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 422	rc = of_property_count_strings(np, "unterminated-string");
 423	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 424	rc = of_property_count_strings(np, "unterminated-string-list");
 425	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 426
 427	/* of_property_read_string_index() tests */
 428	rc = of_property_read_string_index(np, "string-property", 0, strings);
 429	unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
 430	strings[0] = NULL;
 431	rc = of_property_read_string_index(np, "string-property", 1, strings);
 432	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 433	rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
 434	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 435	rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
 436	unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
 437	rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
 438	unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
 439	strings[0] = NULL;
 440	rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
 441	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 442	strings[0] = NULL;
 443	rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
 444	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 445	rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
 446	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 447	strings[0] = NULL;
 448	rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
 449	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 450	strings[1] = NULL;
 451
 452	/* of_property_read_string_array() tests */
 453	rc = of_property_read_string_array(np, "string-property", strings, 4);
 454	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 455	rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
 456	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 457	rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
 458	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 459	/* -- An incorrectly formed string should cause a failure */
 460	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
 461	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 462	/* -- parsing the correctly formed strings should still work: */
 463	strings[2] = NULL;
 464	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
 465	unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
 466	strings[1] = NULL;
 467	rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
 468	unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
 469}
 470
 471#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
 472			(p1)->value && (p2)->value && \
 473			!memcmp((p1)->value, (p2)->value, (p1)->length) && \
 474			!strcmp((p1)->name, (p2)->name))
 475static void __init of_unittest_property_copy(void)
 476{
 477#ifdef CONFIG_OF_DYNAMIC
 478	struct property p1 = { .name = "p1", .length = 0, .value = "" };
 479	struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
 480	struct property *new;
 481
 482	new = __of_prop_dup(&p1, GFP_KERNEL);
 483	unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
 484	kfree(new->value);
 485	kfree(new->name);
 486	kfree(new);
 487
 488	new = __of_prop_dup(&p2, GFP_KERNEL);
 489	unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
 490	kfree(new->value);
 491	kfree(new->name);
 492	kfree(new);
 493#endif
 494}
 495
 496static void __init of_unittest_changeset(void)
 497{
 498#ifdef CONFIG_OF_DYNAMIC
 499	struct property *ppadd, padd = { .name = "prop-add", .length = 0, .value = "" };
 
 
 
 500	struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
 501	struct property *ppremove;
 502	struct device_node *n1, *n2, *n21, *nremove, *parent, *np;
 503	struct of_changeset chgset;
 504
 505	n1 = __of_node_dup(NULL, "/testcase-data/changeset/n1");
 506	unittest(n1, "testcase setup failure\n");
 507	n2 = __of_node_dup(NULL, "/testcase-data/changeset/n2");
 
 508	unittest(n2, "testcase setup failure\n");
 509	n21 = __of_node_dup(NULL, "%s/%s", "/testcase-data/changeset/n2", "n21");
 
 510	unittest(n21, "testcase setup failure %p\n", n21);
 511	nremove = of_find_node_by_path("/testcase-data/changeset/node-remove");
 
 
 512	unittest(nremove, "testcase setup failure\n");
 
 513	ppadd = __of_prop_dup(&padd, GFP_KERNEL);
 514	unittest(ppadd, "testcase setup failure\n");
 
 
 
 
 
 
 
 
 
 
 515	ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
 516	unittest(ppupdate, "testcase setup failure\n");
 517	parent = nremove->parent;
 
 518	n1->parent = parent;
 519	n2->parent = parent;
 520	n21->parent = n2;
 521	n2->child = n21;
 522	ppremove = of_find_property(parent, "prop-remove", NULL);
 523	unittest(ppremove, "failed to find removal prop");
 524
 525	of_changeset_init(&chgset);
 
 526	unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
 
 
 527	unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
 
 
 528	unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
 
 
 529	unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
 530	unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop\n");
 
 531	unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
 532	unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
 
 533	unittest(!of_changeset_apply(&chgset), "apply failed\n");
 534
 
 
 535	/* Make sure node names are constructed correctly */
 536	unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
 537		 "'%s' not added\n", n21->full_name);
 538	of_node_put(np);
 539
 540	unittest(!of_changeset_revert(&chgset), "revert failed\n");
 541
 542	of_changeset_destroy(&chgset);
 543#endif
 544}
 545
 546static void __init of_unittest_parse_interrupts(void)
 547{
 548	struct device_node *np;
 549	struct of_phandle_args args;
 550	int i, rc;
 551
 
 
 
 552	np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
 553	if (!np) {
 554		pr_err("missing testcase data\n");
 555		return;
 556	}
 557
 558	for (i = 0; i < 4; i++) {
 559		bool passed = true;
 560
 561		args.args_count = 0;
 562		rc = of_irq_parse_one(np, i, &args);
 563
 564		passed &= !rc;
 565		passed &= (args.args_count == 1);
 566		passed &= (args.args[0] == (i + 1));
 567
 568		unittest(passed, "index %i - data error on node %s rc=%i\n",
 569			 i, args.np->full_name, rc);
 570	}
 571	of_node_put(np);
 572
 573	np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
 574	if (!np) {
 575		pr_err("missing testcase data\n");
 576		return;
 577	}
 578
 579	for (i = 0; i < 4; i++) {
 580		bool passed = true;
 581
 582		args.args_count = 0;
 583		rc = of_irq_parse_one(np, i, &args);
 584
 585		/* Test the values from tests-phandle.dtsi */
 586		switch (i) {
 587		case 0:
 588			passed &= !rc;
 589			passed &= (args.args_count == 1);
 590			passed &= (args.args[0] == 9);
 591			break;
 592		case 1:
 593			passed &= !rc;
 594			passed &= (args.args_count == 3);
 595			passed &= (args.args[0] == 10);
 596			passed &= (args.args[1] == 11);
 597			passed &= (args.args[2] == 12);
 598			break;
 599		case 2:
 600			passed &= !rc;
 601			passed &= (args.args_count == 2);
 602			passed &= (args.args[0] == 13);
 603			passed &= (args.args[1] == 14);
 604			break;
 605		case 3:
 606			passed &= !rc;
 607			passed &= (args.args_count == 2);
 608			passed &= (args.args[0] == 15);
 609			passed &= (args.args[1] == 16);
 610			break;
 611		default:
 612			passed = false;
 613		}
 614		unittest(passed, "index %i - data error on node %s rc=%i\n",
 615			 i, args.np->full_name, rc);
 616	}
 617	of_node_put(np);
 618}
 619
 620static void __init of_unittest_parse_interrupts_extended(void)
 621{
 622	struct device_node *np;
 623	struct of_phandle_args args;
 624	int i, rc;
 625
 
 
 
 626	np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
 627	if (!np) {
 628		pr_err("missing testcase data\n");
 629		return;
 630	}
 631
 632	for (i = 0; i < 7; i++) {
 633		bool passed = true;
 634
 
 635		rc = of_irq_parse_one(np, i, &args);
 636
 637		/* Test the values from tests-phandle.dtsi */
 638		switch (i) {
 639		case 0:
 640			passed &= !rc;
 641			passed &= (args.args_count == 1);
 642			passed &= (args.args[0] == 1);
 643			break;
 644		case 1:
 645			passed &= !rc;
 646			passed &= (args.args_count == 3);
 647			passed &= (args.args[0] == 2);
 648			passed &= (args.args[1] == 3);
 649			passed &= (args.args[2] == 4);
 650			break;
 651		case 2:
 652			passed &= !rc;
 653			passed &= (args.args_count == 2);
 654			passed &= (args.args[0] == 5);
 655			passed &= (args.args[1] == 6);
 656			break;
 657		case 3:
 658			passed &= !rc;
 659			passed &= (args.args_count == 1);
 660			passed &= (args.args[0] == 9);
 661			break;
 662		case 4:
 663			passed &= !rc;
 664			passed &= (args.args_count == 3);
 665			passed &= (args.args[0] == 10);
 666			passed &= (args.args[1] == 11);
 667			passed &= (args.args[2] == 12);
 668			break;
 669		case 5:
 670			passed &= !rc;
 671			passed &= (args.args_count == 2);
 672			passed &= (args.args[0] == 13);
 673			passed &= (args.args[1] == 14);
 674			break;
 675		case 6:
 676			passed &= !rc;
 677			passed &= (args.args_count == 1);
 678			passed &= (args.args[0] == 15);
 679			break;
 680		default:
 681			passed = false;
 682		}
 683
 684		unittest(passed, "index %i - data error on node %s rc=%i\n",
 685			 i, args.np->full_name, rc);
 686	}
 687	of_node_put(np);
 688}
 689
 690static const struct of_device_id match_node_table[] = {
 691	{ .data = "A", .name = "name0", }, /* Name alone is lowest priority */
 692	{ .data = "B", .type = "type1", }, /* followed by type alone */
 693
 694	{ .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
 695	{ .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
 696	{ .data = "Cc", .name = "name2", .type = "type2", },
 697
 698	{ .data = "E", .compatible = "compat3" },
 699	{ .data = "G", .compatible = "compat2", },
 700	{ .data = "H", .compatible = "compat2", .name = "name5", },
 701	{ .data = "I", .compatible = "compat2", .type = "type1", },
 702	{ .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
 703	{ .data = "K", .compatible = "compat2", .name = "name9", },
 704	{}
 705};
 706
 707static struct {
 708	const char *path;
 709	const char *data;
 710} match_node_tests[] = {
 711	{ .path = "/testcase-data/match-node/name0", .data = "A", },
 712	{ .path = "/testcase-data/match-node/name1", .data = "B", },
 713	{ .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
 714	{ .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
 715	{ .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
 716	{ .path = "/testcase-data/match-node/name3", .data = "E", },
 717	{ .path = "/testcase-data/match-node/name4", .data = "G", },
 718	{ .path = "/testcase-data/match-node/name5", .data = "H", },
 719	{ .path = "/testcase-data/match-node/name6", .data = "G", },
 720	{ .path = "/testcase-data/match-node/name7", .data = "I", },
 721	{ .path = "/testcase-data/match-node/name8", .data = "J", },
 722	{ .path = "/testcase-data/match-node/name9", .data = "K", },
 723};
 724
 725static void __init of_unittest_match_node(void)
 726{
 727	struct device_node *np;
 728	const struct of_device_id *match;
 729	int i;
 730
 731	for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
 732		np = of_find_node_by_path(match_node_tests[i].path);
 733		if (!np) {
 734			unittest(0, "missing testcase node %s\n",
 735				match_node_tests[i].path);
 736			continue;
 737		}
 738
 739		match = of_match_node(match_node_table, np);
 740		if (!match) {
 741			unittest(0, "%s didn't match anything\n",
 742				match_node_tests[i].path);
 743			continue;
 744		}
 745
 746		if (strcmp(match->data, match_node_tests[i].data) != 0) {
 747			unittest(0, "%s got wrong match. expected %s, got %s\n",
 748				match_node_tests[i].path, match_node_tests[i].data,
 749				(const char *)match->data);
 750			continue;
 751		}
 752		unittest(1, "passed");
 753	}
 754}
 755
 756static struct resource test_bus_res = {
 757	.start = 0xfffffff8,
 758	.end = 0xfffffff9,
 759	.flags = IORESOURCE_MEM,
 760};
 761static const struct platform_device_info test_bus_info = {
 762	.name = "unittest-bus",
 763};
 764static void __init of_unittest_platform_populate(void)
 765{
 766	int irq, rc;
 767	struct device_node *np, *child, *grandchild;
 768	struct platform_device *pdev, *test_bus;
 769	const struct of_device_id match[] = {
 770		{ .compatible = "test-device", },
 771		{}
 772	};
 773
 774	np = of_find_node_by_path("/testcase-data");
 775	of_platform_populate(np, of_default_bus_match_table, NULL, NULL);
 776
 777	/* Test that a missing irq domain returns -EPROBE_DEFER */
 778	np = of_find_node_by_path("/testcase-data/testcase-device1");
 779	pdev = of_find_device_by_node(np);
 780	unittest(pdev, "device 1 creation failed\n");
 781
 782	irq = platform_get_irq(pdev, 0);
 783	unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq);
 784
 785	/* Test that a parsing failure does not return -EPROBE_DEFER */
 786	np = of_find_node_by_path("/testcase-data/testcase-device2");
 787	pdev = of_find_device_by_node(np);
 788	unittest(pdev, "device 2 creation failed\n");
 789	irq = platform_get_irq(pdev, 0);
 790	unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq);
 
 
 
 
 791
 792	np = of_find_node_by_path("/testcase-data/platform-tests");
 793	unittest(np, "No testcase data in device tree\n");
 794	if (!np)
 795		return;
 796
 797	test_bus = platform_device_register_full(&test_bus_info);
 798	rc = PTR_ERR_OR_ZERO(test_bus);
 799	unittest(!rc, "testbus registration failed; rc=%i\n", rc);
 800	if (rc)
 
 801		return;
 
 802	test_bus->dev.of_node = np;
 803
 804	/*
 805	 * Add a dummy resource to the test bus node after it is
 806	 * registered to catch problems with un-inserted resources. The
 807	 * DT code doesn't insert the resources, and it has caused the
 808	 * kernel to oops in the past. This makes sure the same bug
 809	 * doesn't crop up again.
 810	 */
 811	platform_device_add_resources(test_bus, &test_bus_res, 1);
 812
 813	of_platform_populate(np, match, NULL, &test_bus->dev);
 814	for_each_child_of_node(np, child) {
 815		for_each_child_of_node(child, grandchild)
 816			unittest(of_find_device_by_node(grandchild),
 817				 "Could not create device for node '%s'\n",
 818				 grandchild->name);
 819	}
 820
 821	of_platform_depopulate(&test_bus->dev);
 822	for_each_child_of_node(np, child) {
 823		for_each_child_of_node(child, grandchild)
 824			unittest(!of_find_device_by_node(grandchild),
 825				 "device didn't get destroyed '%s'\n",
 826				 grandchild->name);
 827	}
 828
 829	platform_device_unregister(test_bus);
 830	of_node_put(np);
 831}
 832
 833/**
 834 *	update_node_properties - adds the properties
 835 *	of np into dup node (present in live tree) and
 836 *	updates parent of children of np to dup.
 837 *
 838 *	@np:	node already present in live tree
 839 *	@dup:	node present in live tree to be updated
 840 */
 841static void update_node_properties(struct device_node *np,
 842					struct device_node *dup)
 843{
 844	struct property *prop;
 
 845	struct device_node *child;
 846
 847	for_each_property_of_node(np, prop)
 848		of_add_property(dup, prop);
 849
 850	for_each_child_of_node(np, child)
 851		child->parent = dup;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 852}
 853
 854/**
 855 *	attach_node_and_children - attaches nodes
 856 *	and its children to live tree
 
 
 
 
 857 *
 858 *	@np:	Node to attach to live tree
 859 */
 860static int attach_node_and_children(struct device_node *np)
 861{
 862	struct device_node *next, *dup, *child;
 863	unsigned long flags;
 
 
 
 864
 865	dup = of_find_node_by_path(np->full_name);
 
 
 
 
 
 866	if (dup) {
 867		update_node_properties(np, dup);
 868		return 0;
 869	}
 870
 871	child = np->child;
 872	np->child = NULL;
 873
 874	mutex_lock(&of_mutex);
 875	raw_spin_lock_irqsave(&devtree_lock, flags);
 876	np->sibling = np->parent->child;
 877	np->parent->child = np;
 878	of_node_clear_flag(np, OF_DETACHED);
 879	raw_spin_unlock_irqrestore(&devtree_lock, flags);
 880
 881	__of_attach_node_sysfs(np);
 882	mutex_unlock(&of_mutex);
 883
 884	while (child) {
 885		next = child->sibling;
 886		attach_node_and_children(child);
 887		child = next;
 888	}
 889
 890	return 0;
 891}
 892
 893/**
 894 *	unittest_data_add - Reads, copies data from
 895 *	linked tree and attaches it to the live tree
 896 */
 897static int __init unittest_data_add(void)
 898{
 899	void *unittest_data;
 900	struct device_node *unittest_data_node, *np;
 901	/*
 902	 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
 903	 * created by cmd_dt_S_dtb in scripts/Makefile.lib
 904	 */
 905	extern uint8_t __dtb_testcases_begin[];
 906	extern uint8_t __dtb_testcases_end[];
 907	const int size = __dtb_testcases_end - __dtb_testcases_begin;
 908	int rc;
 909
 910	if (!size) {
 911		pr_warn("%s: No testcase data to attach; not running tests\n",
 912			__func__);
 913		return -ENODATA;
 914	}
 915
 916	/* creating copy */
 917	unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
 918
 919	if (!unittest_data) {
 920		pr_warn("%s: Failed to allocate memory for unittest_data; "
 921			"not running tests\n", __func__);
 922		return -ENOMEM;
 923	}
 924	of_fdt_unflatten_tree(unittest_data, &unittest_data_node);
 925	if (!unittest_data_node) {
 926		pr_warn("%s: No tree to attach; not running tests\n", __func__);
 
 927		return -ENODATA;
 928	}
 929	of_node_set_flag(unittest_data_node, OF_DETACHED);
 
 
 
 
 
 930	rc = of_resolve_phandles(unittest_data_node);
 931	if (rc) {
 932		pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
 
 933		return -EINVAL;
 934	}
 935
 936	if (!of_root) {
 937		of_root = unittest_data_node;
 938		for_each_of_allnodes(np)
 939			__of_attach_node_sysfs(np);
 940		of_aliases = of_find_node_by_path("/aliases");
 941		of_chosen = of_find_node_by_path("/chosen");
 
 942		return 0;
 943	}
 944
 945	/* attach the sub-tree to live tree */
 946	np = unittest_data_node->child;
 947	while (np) {
 948		struct device_node *next = np->sibling;
 949
 950		np->parent = of_root;
 951		attach_node_and_children(np);
 952		np = next;
 953	}
 
 
 
 954	return 0;
 955}
 956
 957#ifdef CONFIG_OF_OVERLAY
 
 958
 959static int unittest_probe(struct platform_device *pdev)
 960{
 961	struct device *dev = &pdev->dev;
 962	struct device_node *np = dev->of_node;
 963
 964	if (np == NULL) {
 965		dev_err(dev, "No OF data for device\n");
 966		return -EINVAL;
 967
 968	}
 969
 970	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
 971
 972	of_platform_populate(np, NULL, NULL, &pdev->dev);
 973
 974	return 0;
 975}
 976
 977static int unittest_remove(struct platform_device *pdev)
 978{
 979	struct device *dev = &pdev->dev;
 980	struct device_node *np = dev->of_node;
 981
 982	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
 983	return 0;
 984}
 985
 986static const struct of_device_id unittest_match[] = {
 987	{ .compatible = "unittest", },
 988	{},
 989};
 990
 991static struct platform_driver unittest_driver = {
 992	.probe			= unittest_probe,
 993	.remove			= unittest_remove,
 994	.driver = {
 995		.name		= "unittest",
 996		.of_match_table	= of_match_ptr(unittest_match),
 997	},
 998};
 999
1000/* get the platform device instantiated at the path */
1001static struct platform_device *of_path_to_platform_device(const char *path)
1002{
1003	struct device_node *np;
1004	struct platform_device *pdev;
1005
1006	np = of_find_node_by_path(path);
1007	if (np == NULL)
1008		return NULL;
1009
1010	pdev = of_find_device_by_node(np);
1011	of_node_put(np);
1012
1013	return pdev;
1014}
1015
1016/* find out if a platform device exists at that path */
1017static int of_path_platform_device_exists(const char *path)
1018{
1019	struct platform_device *pdev;
1020
1021	pdev = of_path_to_platform_device(path);
1022	platform_device_put(pdev);
1023	return pdev != NULL;
1024}
1025
1026#if IS_BUILTIN(CONFIG_I2C)
1027
1028/* get the i2c client device instantiated at the path */
1029static struct i2c_client *of_path_to_i2c_client(const char *path)
1030{
1031	struct device_node *np;
1032	struct i2c_client *client;
1033
1034	np = of_find_node_by_path(path);
1035	if (np == NULL)
1036		return NULL;
1037
1038	client = of_find_i2c_device_by_node(np);
1039	of_node_put(np);
1040
1041	return client;
1042}
1043
1044/* find out if a i2c client device exists at that path */
1045static int of_path_i2c_client_exists(const char *path)
1046{
1047	struct i2c_client *client;
1048
1049	client = of_path_to_i2c_client(path);
1050	if (client)
1051		put_device(&client->dev);
1052	return client != NULL;
1053}
1054#else
1055static int of_path_i2c_client_exists(const char *path)
1056{
1057	return 0;
1058}
1059#endif
1060
1061enum overlay_type {
1062	PDEV_OVERLAY,
1063	I2C_OVERLAY
1064};
1065
1066static int of_path_device_type_exists(const char *path,
1067		enum overlay_type ovtype)
1068{
1069	switch (ovtype) {
1070	case PDEV_OVERLAY:
1071		return of_path_platform_device_exists(path);
1072	case I2C_OVERLAY:
1073		return of_path_i2c_client_exists(path);
1074	}
1075	return 0;
1076}
1077
1078static const char *unittest_path(int nr, enum overlay_type ovtype)
1079{
1080	const char *base;
1081	static char buf[256];
1082
1083	switch (ovtype) {
1084	case PDEV_OVERLAY:
1085		base = "/testcase-data/overlay-node/test-bus";
1086		break;
1087	case I2C_OVERLAY:
1088		base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1089		break;
1090	default:
1091		buf[0] = '\0';
1092		return buf;
1093	}
1094	snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1095	buf[sizeof(buf) - 1] = '\0';
1096	return buf;
1097}
1098
1099static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1100{
1101	const char *path;
1102
1103	path = unittest_path(unittest_nr, ovtype);
1104
1105	switch (ovtype) {
1106	case PDEV_OVERLAY:
1107		return of_path_platform_device_exists(path);
1108	case I2C_OVERLAY:
1109		return of_path_i2c_client_exists(path);
1110	}
1111	return 0;
1112}
1113
1114static const char *overlay_path(int nr)
1115{
1116	static char buf[256];
1117
1118	snprintf(buf, sizeof(buf) - 1,
1119		"/testcase-data/overlay%d", nr);
1120	buf[sizeof(buf) - 1] = '\0';
1121
1122	return buf;
1123}
1124
1125static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1126
1127/* it is guaranteed that overlay ids are assigned in sequence */
1128#define MAX_UNITTEST_OVERLAYS	256
1129static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1130static int overlay_first_id = -1;
1131
1132static void of_unittest_track_overlay(int id)
1133{
1134	if (overlay_first_id < 0)
1135		overlay_first_id = id;
1136	id -= overlay_first_id;
1137
1138	/* we shouldn't need that many */
1139	BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1140	overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1141}
1142
1143static void of_unittest_untrack_overlay(int id)
1144{
1145	if (overlay_first_id < 0)
1146		return;
1147	id -= overlay_first_id;
1148	BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1149	overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1150}
1151
1152static void of_unittest_destroy_tracked_overlays(void)
1153{
1154	int id, ret, defers;
1155
1156	if (overlay_first_id < 0)
1157		return;
1158
1159	/* try until no defers */
1160	do {
1161		defers = 0;
1162		/* remove in reverse order */
1163		for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1164			if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1165				continue;
1166
1167			ret = of_overlay_destroy(id + overlay_first_id);
 
1168			if (ret == -ENODEV) {
1169				pr_warn("%s: no overlay to destroy for #%d\n",
1170					__func__, id + overlay_first_id);
1171				continue;
1172			}
1173			if (ret != 0) {
1174				defers++;
1175				pr_warn("%s: overlay destroy failed for #%d\n",
1176					__func__, id + overlay_first_id);
1177				continue;
1178			}
1179
1180			overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1181		}
1182	} while (defers > 0);
1183}
1184
1185static int of_unittest_apply_overlay(int unittest_nr, int overlay_nr,
1186		int *overlay_id)
1187{
1188	struct device_node *np = NULL;
1189	int ret, id = -1;
1190
1191	np = of_find_node_by_path(overlay_path(overlay_nr));
1192	if (np == NULL) {
1193		unittest(0, "could not find overlay node @\"%s\"\n",
1194				overlay_path(overlay_nr));
1195		ret = -EINVAL;
1196		goto out;
1197	}
1198
1199	ret = of_overlay_create(np);
1200	if (ret < 0) {
1201		unittest(0, "could not create overlay from \"%s\"\n",
1202				overlay_path(overlay_nr));
1203		goto out;
1204	}
1205	id = ret;
1206	of_unittest_track_overlay(id);
1207
1208	ret = 0;
1209
1210out:
1211	of_node_put(np);
1212
1213	if (overlay_id)
1214		*overlay_id = id;
1215
1216	return ret;
1217}
1218
1219/* apply an overlay while checking before and after states */
1220static int of_unittest_apply_overlay_check(int overlay_nr, int unittest_nr,
1221		int before, int after, enum overlay_type ovtype)
 
1222{
1223	int ret;
1224
1225	/* unittest device must not be in before state */
1226	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1227		unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1228				overlay_path(overlay_nr),
1229				unittest_path(unittest_nr, ovtype),
1230				!before ? "enabled" : "disabled");
1231		return -EINVAL;
1232	}
1233
1234	ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, NULL);
 
1235	if (ret != 0) {
1236		/* of_unittest_apply_overlay already called unittest() */
1237		return ret;
1238	}
1239
1240	/* unittest device must be to set to after state */
1241	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1242		unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1243				overlay_path(overlay_nr),
1244				unittest_path(unittest_nr, ovtype),
1245				!after ? "enabled" : "disabled");
1246		return -EINVAL;
1247	}
1248
1249	return 0;
1250}
1251
1252/* apply an overlay and then revert it while checking before, after states */
1253static int of_unittest_apply_revert_overlay_check(int overlay_nr,
1254		int unittest_nr, int before, int after,
1255		enum overlay_type ovtype)
1256{
1257	int ret, ov_id;
1258
1259	/* unittest device must be in before state */
1260	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1261		unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1262				overlay_path(overlay_nr),
1263				unittest_path(unittest_nr, ovtype),
1264				!before ? "enabled" : "disabled");
1265		return -EINVAL;
1266	}
1267
1268	/* apply the overlay */
1269	ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ov_id);
 
1270	if (ret != 0) {
1271		/* of_unittest_apply_overlay already called unittest() */
1272		return ret;
1273	}
1274
1275	/* unittest device must be in after state */
1276	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1277		unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n",
1278				overlay_path(overlay_nr),
1279				unittest_path(unittest_nr, ovtype),
1280				!after ? "enabled" : "disabled");
1281		return -EINVAL;
1282	}
1283
1284	ret = of_overlay_destroy(ov_id);
1285	if (ret != 0) {
1286		unittest(0, "overlay @\"%s\" failed to be destroyed @\"%s\"\n",
1287				overlay_path(overlay_nr),
1288				unittest_path(unittest_nr, ovtype));
1289		return ret;
1290	}
1291
1292	/* unittest device must be again in before state */
1293	if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1294		unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1295				overlay_path(overlay_nr),
1296				unittest_path(unittest_nr, ovtype),
1297				!before ? "enabled" : "disabled");
1298		return -EINVAL;
1299	}
1300
1301	return 0;
1302}
1303
1304/* test activation of device */
1305static void of_unittest_overlay_0(void)
1306{
1307	int ret;
1308
1309	/* device should enable */
1310	ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY);
1311	if (ret != 0)
1312		return;
1313
1314	unittest(1, "overlay test %d passed\n", 0);
1315}
1316
1317/* test deactivation of device */
1318static void of_unittest_overlay_1(void)
1319{
1320	int ret;
1321
1322	/* device should disable */
1323	ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY);
1324	if (ret != 0)
1325		return;
1326
1327	unittest(1, "overlay test %d passed\n", 1);
1328}
1329
1330/* test activation of device */
1331static void of_unittest_overlay_2(void)
1332{
1333	int ret;
1334
1335	/* device should enable */
1336	ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY);
1337	if (ret != 0)
1338		return;
1339
1340	unittest(1, "overlay test %d passed\n", 2);
1341}
1342
1343/* test deactivation of device */
1344static void of_unittest_overlay_3(void)
1345{
1346	int ret;
1347
1348	/* device should disable */
1349	ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY);
1350	if (ret != 0)
1351		return;
1352
1353	unittest(1, "overlay test %d passed\n", 3);
1354}
1355
1356/* test activation of a full device node */
1357static void of_unittest_overlay_4(void)
1358{
1359	int ret;
1360
1361	/* device should disable */
1362	ret = of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY);
1363	if (ret != 0)
1364		return;
1365
1366	unittest(1, "overlay test %d passed\n", 4);
1367}
1368
1369/* test overlay apply/revert sequence */
1370static void of_unittest_overlay_5(void)
1371{
1372	int ret;
1373
1374	/* device should disable */
1375	ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY);
1376	if (ret != 0)
1377		return;
1378
1379	unittest(1, "overlay test %d passed\n", 5);
1380}
1381
1382/* test overlay application in sequence */
1383static void of_unittest_overlay_6(void)
1384{
1385	struct device_node *np;
1386	int ret, i, ov_id[2];
1387	int overlay_nr = 6, unittest_nr = 6;
1388	int before = 0, after = 1;
 
1389
1390	/* unittest device must be in before state */
1391	for (i = 0; i < 2; i++) {
1392		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1393				!= before) {
1394			unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1395					overlay_path(overlay_nr + i),
1396					unittest_path(unittest_nr + i,
1397						PDEV_OVERLAY),
1398					!before ? "enabled" : "disabled");
1399			return;
1400		}
1401	}
1402
1403	/* apply the overlays */
1404	for (i = 0; i < 2; i++) {
1405
1406		np = of_find_node_by_path(overlay_path(overlay_nr + i));
1407		if (np == NULL) {
1408			unittest(0, "could not find overlay node @\"%s\"\n",
1409					overlay_path(overlay_nr + i));
1410			return;
1411		}
1412
1413		ret = of_overlay_create(np);
1414		if (ret < 0)  {
1415			unittest(0, "could not create overlay from \"%s\"\n",
1416					overlay_path(overlay_nr + i));
1417			return;
1418		}
1419		ov_id[i] = ret;
1420		of_unittest_track_overlay(ov_id[i]);
1421	}
1422
1423	for (i = 0; i < 2; i++) {
1424		/* unittest device must be in after state */
1425		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1426				!= after) {
1427			unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1428					overlay_path(overlay_nr + i),
1429					unittest_path(unittest_nr + i,
1430						PDEV_OVERLAY),
1431					!after ? "enabled" : "disabled");
1432			return;
1433		}
1434	}
1435
1436	for (i = 1; i >= 0; i--) {
1437		ret = of_overlay_destroy(ov_id[i]);
1438		if (ret != 0) {
1439			unittest(0, "overlay @\"%s\" failed destroy @\"%s\"\n",
1440					overlay_path(overlay_nr + i),
1441					unittest_path(unittest_nr + i,
1442						PDEV_OVERLAY));
1443			return;
1444		}
1445		of_unittest_untrack_overlay(ov_id[i]);
1446	}
1447
1448	for (i = 0; i < 2; i++) {
1449		/* unittest device must be again in before state */
1450		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1451				!= before) {
1452			unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n",
1453					overlay_path(overlay_nr + i),
1454					unittest_path(unittest_nr + i,
1455						PDEV_OVERLAY),
1456					!before ? "enabled" : "disabled");
1457			return;
1458		}
1459	}
1460
1461	unittest(1, "overlay test %d passed\n", 6);
1462}
1463
1464/* test overlay application in sequence */
1465static void of_unittest_overlay_8(void)
1466{
1467	struct device_node *np;
1468	int ret, i, ov_id[2];
1469	int overlay_nr = 8, unittest_nr = 8;
 
1470
1471	/* we don't care about device state in this test */
1472
1473	/* apply the overlays */
1474	for (i = 0; i < 2; i++) {
1475
1476		np = of_find_node_by_path(overlay_path(overlay_nr + i));
1477		if (np == NULL) {
1478			unittest(0, "could not find overlay node @\"%s\"\n",
1479					overlay_path(overlay_nr + i));
1480			return;
1481		}
1482
1483		ret = of_overlay_create(np);
1484		if (ret < 0)  {
1485			unittest(0, "could not create overlay from \"%s\"\n",
1486					overlay_path(overlay_nr + i));
1487			return;
1488		}
1489		ov_id[i] = ret;
1490		of_unittest_track_overlay(ov_id[i]);
1491	}
1492
1493	/* now try to remove first overlay (it should fail) */
1494	ret = of_overlay_destroy(ov_id[0]);
1495	if (ret == 0) {
1496		unittest(0, "overlay @\"%s\" was destroyed @\"%s\"\n",
1497				overlay_path(overlay_nr + 0),
1498				unittest_path(unittest_nr,
1499					PDEV_OVERLAY));
1500		return;
1501	}
1502
1503	/* removing them in order should work */
1504	for (i = 1; i >= 0; i--) {
1505		ret = of_overlay_destroy(ov_id[i]);
1506		if (ret != 0) {
1507			unittest(0, "overlay @\"%s\" not destroyed @\"%s\"\n",
1508					overlay_path(overlay_nr + i),
1509					unittest_path(unittest_nr,
1510						PDEV_OVERLAY));
1511			return;
1512		}
1513		of_unittest_untrack_overlay(ov_id[i]);
1514	}
1515
1516	unittest(1, "overlay test %d passed\n", 8);
1517}
1518
1519/* test insertion of a bus with parent devices */
1520static void of_unittest_overlay_10(void)
1521{
1522	int ret;
1523	char *child_path;
1524
1525	/* device should disable */
1526	ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1527	if (unittest(ret == 0,
1528			"overlay test %d failed; overlay application\n", 10))
1529		return;
1530
1531	child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1532			unittest_path(10, PDEV_OVERLAY));
1533	if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1534		return;
1535
1536	ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1537	kfree(child_path);
1538	if (unittest(ret, "overlay test %d failed; no child device\n", 10))
1539		return;
1540}
1541
1542/* test insertion of a bus with parent devices (and revert) */
1543static void of_unittest_overlay_11(void)
1544{
1545	int ret;
1546
1547	/* device should disable */
1548	ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1549			PDEV_OVERLAY);
1550	if (unittest(ret == 0,
1551			"overlay test %d failed; overlay application\n", 11))
1552		return;
1553}
1554
1555#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1556
1557struct unittest_i2c_bus_data {
1558	struct platform_device	*pdev;
1559	struct i2c_adapter	adap;
1560};
1561
1562static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1563		struct i2c_msg *msgs, int num)
1564{
1565	struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1566
1567	(void)std;
1568
1569	return num;
1570}
1571
1572static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1573{
1574	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1575}
1576
1577static const struct i2c_algorithm unittest_i2c_algo = {
1578	.master_xfer	= unittest_i2c_master_xfer,
1579	.functionality	= unittest_i2c_functionality,
1580};
1581
1582static int unittest_i2c_bus_probe(struct platform_device *pdev)
1583{
1584	struct device *dev = &pdev->dev;
1585	struct device_node *np = dev->of_node;
1586	struct unittest_i2c_bus_data *std;
1587	struct i2c_adapter *adap;
1588	int ret;
1589
1590	if (np == NULL) {
1591		dev_err(dev, "No OF data for device\n");
1592		return -EINVAL;
1593
1594	}
1595
1596	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1597
1598	std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1599	if (!std) {
1600		dev_err(dev, "Failed to allocate unittest i2c data\n");
1601		return -ENOMEM;
1602	}
1603
1604	/* link them together */
1605	std->pdev = pdev;
1606	platform_set_drvdata(pdev, std);
1607
1608	adap = &std->adap;
1609	i2c_set_adapdata(adap, std);
1610	adap->nr = -1;
1611	strlcpy(adap->name, pdev->name, sizeof(adap->name));
1612	adap->class = I2C_CLASS_DEPRECATED;
1613	adap->algo = &unittest_i2c_algo;
1614	adap->dev.parent = dev;
1615	adap->dev.of_node = dev->of_node;
1616	adap->timeout = 5 * HZ;
1617	adap->retries = 3;
1618
1619	ret = i2c_add_numbered_adapter(adap);
1620	if (ret != 0) {
1621		dev_err(dev, "Failed to add I2C adapter\n");
1622		return ret;
1623	}
1624
1625	return 0;
1626}
1627
1628static int unittest_i2c_bus_remove(struct platform_device *pdev)
1629{
1630	struct device *dev = &pdev->dev;
1631	struct device_node *np = dev->of_node;
1632	struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1633
1634	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1635	i2c_del_adapter(&std->adap);
1636
1637	return 0;
1638}
1639
1640static const struct of_device_id unittest_i2c_bus_match[] = {
1641	{ .compatible = "unittest-i2c-bus", },
1642	{},
1643};
1644
1645static struct platform_driver unittest_i2c_bus_driver = {
1646	.probe			= unittest_i2c_bus_probe,
1647	.remove			= unittest_i2c_bus_remove,
1648	.driver = {
1649		.name		= "unittest-i2c-bus",
1650		.of_match_table	= of_match_ptr(unittest_i2c_bus_match),
1651	},
1652};
1653
1654static int unittest_i2c_dev_probe(struct i2c_client *client,
1655		const struct i2c_device_id *id)
1656{
1657	struct device *dev = &client->dev;
1658	struct device_node *np = client->dev.of_node;
1659
1660	if (!np) {
1661		dev_err(dev, "No OF node\n");
1662		return -EINVAL;
1663	}
1664
1665	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1666
1667	return 0;
1668};
1669
1670static int unittest_i2c_dev_remove(struct i2c_client *client)
1671{
1672	struct device *dev = &client->dev;
1673	struct device_node *np = client->dev.of_node;
1674
1675	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1676	return 0;
1677}
1678
1679static const struct i2c_device_id unittest_i2c_dev_id[] = {
1680	{ .name = "unittest-i2c-dev" },
1681	{ }
1682};
1683
1684static struct i2c_driver unittest_i2c_dev_driver = {
1685	.driver = {
1686		.name = "unittest-i2c-dev",
1687	},
1688	.probe = unittest_i2c_dev_probe,
1689	.remove = unittest_i2c_dev_remove,
1690	.id_table = unittest_i2c_dev_id,
1691};
1692
1693#if IS_BUILTIN(CONFIG_I2C_MUX)
1694
1695struct unittest_i2c_mux_data {
1696	int nchans;
1697	struct i2c_adapter *adap[];
1698};
1699
1700static int unittest_i2c_mux_select_chan(struct i2c_adapter *adap,
1701			       void *client, u32 chan)
1702{
1703	return 0;
1704}
1705
1706static int unittest_i2c_mux_probe(struct i2c_client *client,
1707		const struct i2c_device_id *id)
1708{
1709	int ret, i, nchans, size;
1710	struct device *dev = &client->dev;
1711	struct i2c_adapter *adap = to_i2c_adapter(dev->parent);
1712	struct device_node *np = client->dev.of_node, *child;
1713	struct unittest_i2c_mux_data *stm;
1714	u32 reg, max_reg;
1715
1716	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1717
1718	if (!np) {
1719		dev_err(dev, "No OF node\n");
1720		return -EINVAL;
1721	}
1722
1723	max_reg = (u32)-1;
1724	for_each_child_of_node(np, child) {
1725		ret = of_property_read_u32(child, "reg", &reg);
1726		if (ret)
1727			continue;
1728		if (max_reg == (u32)-1 || reg > max_reg)
1729			max_reg = reg;
1730	}
1731	nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1732	if (nchans == 0) {
1733		dev_err(dev, "No channels\n");
1734		return -EINVAL;
1735	}
1736
1737	size = offsetof(struct unittest_i2c_mux_data, adap[nchans]);
1738	stm = devm_kzalloc(dev, size, GFP_KERNEL);
1739	if (!stm) {
1740		dev_err(dev, "Out of memory\n");
1741		return -ENOMEM;
1742	}
1743	stm->nchans = nchans;
1744	for (i = 0; i < nchans; i++) {
1745		stm->adap[i] = i2c_add_mux_adapter(adap, dev, client,
1746				0, i, 0, unittest_i2c_mux_select_chan, NULL);
1747		if (!stm->adap[i]) {
1748			dev_err(dev, "Failed to register mux #%d\n", i);
1749			for (i--; i >= 0; i--)
1750				i2c_del_mux_adapter(stm->adap[i]);
1751			return -ENODEV;
1752		}
1753	}
1754
1755	i2c_set_clientdata(client, stm);
1756
1757	return 0;
1758};
1759
1760static int unittest_i2c_mux_remove(struct i2c_client *client)
1761{
1762	struct device *dev = &client->dev;
1763	struct device_node *np = client->dev.of_node;
1764	struct unittest_i2c_mux_data *stm = i2c_get_clientdata(client);
1765	int i;
1766
1767	dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name);
1768	for (i = stm->nchans - 1; i >= 0; i--)
1769		i2c_del_mux_adapter(stm->adap[i]);
1770	return 0;
1771}
1772
1773static const struct i2c_device_id unittest_i2c_mux_id[] = {
1774	{ .name = "unittest-i2c-mux" },
1775	{ }
1776};
1777
1778static struct i2c_driver unittest_i2c_mux_driver = {
1779	.driver = {
1780		.name = "unittest-i2c-mux",
1781	},
1782	.probe = unittest_i2c_mux_probe,
1783	.remove = unittest_i2c_mux_remove,
1784	.id_table = unittest_i2c_mux_id,
1785};
1786
1787#endif
1788
1789static int of_unittest_overlay_i2c_init(void)
1790{
1791	int ret;
1792
1793	ret = i2c_add_driver(&unittest_i2c_dev_driver);
1794	if (unittest(ret == 0,
1795			"could not register unittest i2c device driver\n"))
1796		return ret;
1797
1798	ret = platform_driver_register(&unittest_i2c_bus_driver);
1799	if (unittest(ret == 0,
1800			"could not register unittest i2c bus driver\n"))
1801		return ret;
1802
1803#if IS_BUILTIN(CONFIG_I2C_MUX)
1804	ret = i2c_add_driver(&unittest_i2c_mux_driver);
1805	if (unittest(ret == 0,
1806			"could not register unittest i2c mux driver\n"))
1807		return ret;
1808#endif
1809
1810	return 0;
1811}
1812
1813static void of_unittest_overlay_i2c_cleanup(void)
1814{
1815#if IS_BUILTIN(CONFIG_I2C_MUX)
1816	i2c_del_driver(&unittest_i2c_mux_driver);
1817#endif
1818	platform_driver_unregister(&unittest_i2c_bus_driver);
1819	i2c_del_driver(&unittest_i2c_dev_driver);
1820}
1821
1822static void of_unittest_overlay_i2c_12(void)
1823{
1824	int ret;
1825
1826	/* device should enable */
1827	ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY);
1828	if (ret != 0)
1829		return;
1830
1831	unittest(1, "overlay test %d passed\n", 12);
1832}
1833
1834/* test deactivation of device */
1835static void of_unittest_overlay_i2c_13(void)
1836{
1837	int ret;
1838
1839	/* device should disable */
1840	ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY);
1841	if (ret != 0)
1842		return;
1843
1844	unittest(1, "overlay test %d passed\n", 13);
1845}
1846
1847/* just check for i2c mux existence */
1848static void of_unittest_overlay_i2c_14(void)
1849{
1850}
1851
1852static void of_unittest_overlay_i2c_15(void)
1853{
1854	int ret;
1855
1856	/* device should enable */
1857	ret = of_unittest_apply_overlay_check(16, 15, 0, 1, I2C_OVERLAY);
1858	if (ret != 0)
1859		return;
1860
1861	unittest(1, "overlay test %d passed\n", 15);
1862}
1863
1864#else
1865
1866static inline void of_unittest_overlay_i2c_14(void) { }
1867static inline void of_unittest_overlay_i2c_15(void) { }
1868
1869#endif
1870
1871static void __init of_unittest_overlay(void)
1872{
1873	struct device_node *bus_np = NULL;
1874	int ret;
1875
1876	ret = platform_driver_register(&unittest_driver);
1877	if (ret != 0) {
1878		unittest(0, "could not register unittest driver\n");
1879		goto out;
1880	}
1881
1882	bus_np = of_find_node_by_path(bus_path);
1883	if (bus_np == NULL) {
1884		unittest(0, "could not find bus_path \"%s\"\n", bus_path);
1885		goto out;
1886	}
1887
1888	ret = of_platform_populate(bus_np, of_default_bus_match_table,
1889			NULL, NULL);
1890	if (ret != 0) {
1891		unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
1892		goto out;
1893	}
1894
1895	if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
1896		unittest(0, "could not find unittest0 @ \"%s\"\n",
1897				unittest_path(100, PDEV_OVERLAY));
1898		goto out;
1899	}
1900
1901	if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
1902		unittest(0, "unittest1 @ \"%s\" should not exist\n",
1903				unittest_path(101, PDEV_OVERLAY));
1904		goto out;
1905	}
1906
1907	unittest(1, "basic infrastructure of overlays passed");
1908
1909	/* tests in sequence */
1910	of_unittest_overlay_0();
1911	of_unittest_overlay_1();
1912	of_unittest_overlay_2();
1913	of_unittest_overlay_3();
1914	of_unittest_overlay_4();
1915	of_unittest_overlay_5();
1916	of_unittest_overlay_6();
1917	of_unittest_overlay_8();
1918
1919	of_unittest_overlay_10();
1920	of_unittest_overlay_11();
1921
1922#if IS_BUILTIN(CONFIG_I2C)
1923	if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
1924		goto out;
1925
1926	of_unittest_overlay_i2c_12();
1927	of_unittest_overlay_i2c_13();
1928	of_unittest_overlay_i2c_14();
1929	of_unittest_overlay_i2c_15();
1930
1931	of_unittest_overlay_i2c_cleanup();
1932#endif
1933
1934	of_unittest_destroy_tracked_overlays();
1935
1936out:
1937	of_node_put(bus_np);
1938}
1939
1940#else
1941static inline void __init of_unittest_overlay(void) { }
1942#endif
1943
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1944static int __init of_unittest(void)
1945{
1946	struct device_node *np;
1947	int res;
1948
1949	/* adding data for unittest */
 
 
 
 
1950	res = unittest_data_add();
1951	if (res)
1952		return res;
1953	if (!of_aliases)
1954		of_aliases = of_find_node_by_path("/aliases");
1955
1956	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
1957	if (!np) {
1958		pr_info("No testcase data in device tree; not running tests\n");
1959		return 0;
1960	}
1961	of_node_put(np);
1962
1963	pr_info("start of unittest - you will see error messages\n");
1964	of_unittest_check_tree_linkage();
1965	of_unittest_check_phandles();
1966	of_unittest_find_node_by_name();
1967	of_unittest_dynamic();
1968	of_unittest_parse_phandle_with_args();
 
 
1969	of_unittest_property_string();
1970	of_unittest_property_copy();
1971	of_unittest_changeset();
1972	of_unittest_parse_interrupts();
1973	of_unittest_parse_interrupts_extended();
1974	of_unittest_match_node();
1975	of_unittest_platform_populate();
1976	of_unittest_overlay();
1977
1978	/* Double check linkage after removing testcase data */
1979	of_unittest_check_tree_linkage();
 
 
1980
1981	pr_info("end of unittest - %i passed, %i failed\n",
1982		unittest_results.passed, unittest_results.failed);
1983
1984	return 0;
1985}
1986late_initcall(of_unittest);
v5.4
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * Self tests for device tree subsystem
   4 */
   5
   6#define pr_fmt(fmt) "### dt-test ### " fmt
   7
   8#include <linux/memblock.h>
   9#include <linux/clk.h>
  10#include <linux/err.h>
  11#include <linux/errno.h>
  12#include <linux/hashtable.h>
  13#include <linux/libfdt.h>
  14#include <linux/of.h>
  15#include <linux/of_fdt.h>
  16#include <linux/of_irq.h>
  17#include <linux/of_platform.h>
  18#include <linux/list.h>
  19#include <linux/mutex.h>
  20#include <linux/slab.h>
  21#include <linux/device.h>
  22#include <linux/platform_device.h>
 
  23
  24#include <linux/i2c.h>
  25#include <linux/i2c-mux.h>
  26
  27#include <linux/bitops.h>
  28
  29#include "of_private.h"
  30
  31static struct unittest_results {
  32	int passed;
  33	int failed;
  34} unittest_results;
  35
  36#define unittest(result, fmt, ...) ({ \
  37	bool failed = !(result); \
  38	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	failed; \
  46})
  47
  48static void __init of_unittest_find_node_by_name(void)
  49{
  50	struct device_node *np;
  51	const char *options, *name;
  52
  53	np = of_find_node_by_path("/testcase-data");
  54	name = kasprintf(GFP_KERNEL, "%pOF", np);
  55	unittest(np && !strcmp("/testcase-data", name),
  56		"find /testcase-data failed\n");
  57	of_node_put(np);
  58	kfree(name);
  59
  60	/* Test if trailing '/' works */
  61	np = of_find_node_by_path("/testcase-data/");
  62	unittest(!np, "trailing '/' on /testcase-data/ should fail\n");
  63
  64	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
  65	name = kasprintf(GFP_KERNEL, "%pOF", np);
  66	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
  67		"find /testcase-data/phandle-tests/consumer-a failed\n");
  68	of_node_put(np);
  69	kfree(name);
  70
  71	np = of_find_node_by_path("testcase-alias");
  72	name = kasprintf(GFP_KERNEL, "%pOF", np);
  73	unittest(np && !strcmp("/testcase-data", name),
  74		"find testcase-alias failed\n");
  75	of_node_put(np);
  76	kfree(name);
  77
  78	/* Test if trailing '/' works on aliases */
  79	np = of_find_node_by_path("testcase-alias/");
  80	unittest(!np, "trailing '/' on testcase-alias/ should fail\n");
  81
  82	np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a");
  83	name = kasprintf(GFP_KERNEL, "%pOF", np);
  84	unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", name),
  85		"find testcase-alias/phandle-tests/consumer-a failed\n");
  86	of_node_put(np);
  87	kfree(name);
  88
  89	np = of_find_node_by_path("/testcase-data/missing-path");
  90	unittest(!np, "non-existent path returned node %pOF\n", np);
  91	of_node_put(np);
  92
  93	np = of_find_node_by_path("missing-alias");
  94	unittest(!np, "non-existent alias returned node %pOF\n", np);
  95	of_node_put(np);
  96
  97	np = of_find_node_by_path("testcase-alias/missing-path");
  98	unittest(!np, "non-existent alias with relative path returned node %pOF\n", np);
  99	of_node_put(np);
 100
 101	np = of_find_node_opts_by_path("/testcase-data:testoption", &options);
 102	unittest(np && !strcmp("testoption", options),
 103		 "option path test failed\n");
 104	of_node_put(np);
 105
 106	np = of_find_node_opts_by_path("/testcase-data:test/option", &options);
 107	unittest(np && !strcmp("test/option", options),
 108		 "option path test, subcase #1 failed\n");
 109	of_node_put(np);
 110
 111	np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options);
 112	unittest(np && !strcmp("test/option", options),
 113		 "option path test, subcase #2 failed\n");
 114	of_node_put(np);
 115
 116	np = of_find_node_opts_by_path("/testcase-data:testoption", NULL);
 117	unittest(np, "NULL option path test failed\n");
 118	of_node_put(np);
 119
 120	np = of_find_node_opts_by_path("testcase-alias:testaliasoption",
 121				       &options);
 122	unittest(np && !strcmp("testaliasoption", options),
 123		 "option alias path test failed\n");
 124	of_node_put(np);
 125
 126	np = of_find_node_opts_by_path("testcase-alias:test/alias/option",
 127				       &options);
 128	unittest(np && !strcmp("test/alias/option", options),
 129		 "option alias path test, subcase #1 failed\n");
 130	of_node_put(np);
 131
 132	np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL);
 133	unittest(np, "NULL option alias path test failed\n");
 134	of_node_put(np);
 135
 136	options = "testoption";
 137	np = of_find_node_opts_by_path("testcase-alias", &options);
 138	unittest(np && !options, "option clearing test failed\n");
 139	of_node_put(np);
 140
 141	options = "testoption";
 142	np = of_find_node_opts_by_path("/", &options);
 143	unittest(np && !options, "option clearing root node test failed\n");
 144	of_node_put(np);
 145}
 146
 147static void __init of_unittest_dynamic(void)
 148{
 149	struct device_node *np;
 150	struct property *prop;
 151
 152	np = of_find_node_by_path("/testcase-data");
 153	if (!np) {
 154		pr_err("missing testcase data\n");
 155		return;
 156	}
 157
 158	/* Array of 4 properties for the purpose of testing */
 159	prop = kcalloc(4, sizeof(*prop), GFP_KERNEL);
 160	if (!prop) {
 161		unittest(0, "kzalloc() failed\n");
 162		return;
 163	}
 164
 165	/* Add a new property - should pass*/
 166	prop->name = "new-property";
 167	prop->value = "new-property-data";
 168	prop->length = strlen(prop->value) + 1;
 169	unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n");
 170
 171	/* Try to add an existing property - should fail */
 172	prop++;
 173	prop->name = "new-property";
 174	prop->value = "new-property-data-should-fail";
 175	prop->length = strlen(prop->value) + 1;
 176	unittest(of_add_property(np, prop) != 0,
 177		 "Adding an existing property should have failed\n");
 178
 179	/* Try to modify an existing property - should pass */
 180	prop->value = "modify-property-data-should-pass";
 181	prop->length = strlen(prop->value) + 1;
 182	unittest(of_update_property(np, prop) == 0,
 183		 "Updating an existing property should have passed\n");
 184
 185	/* Try to modify non-existent property - should pass*/
 186	prop++;
 187	prop->name = "modify-property";
 188	prop->value = "modify-missing-property-data-should-pass";
 189	prop->length = strlen(prop->value) + 1;
 190	unittest(of_update_property(np, prop) == 0,
 191		 "Updating a missing property should have passed\n");
 192
 193	/* Remove property - should pass */
 194	unittest(of_remove_property(np, prop) == 0,
 195		 "Removing a property should have passed\n");
 196
 197	/* Adding very large property - should pass */
 198	prop++;
 199	prop->name = "large-property-PAGE_SIZEx8";
 200	prop->length = PAGE_SIZE * 8;
 201	prop->value = kzalloc(prop->length, GFP_KERNEL);
 202	unittest(prop->value != NULL, "Unable to allocate large buffer\n");
 203	if (prop->value)
 204		unittest(of_add_property(np, prop) == 0,
 205			 "Adding a large property should have passed\n");
 206}
 207
 208static int __init of_unittest_check_node_linkage(struct device_node *np)
 209{
 210	struct device_node *child;
 211	int count = 0, rc;
 212
 213	for_each_child_of_node(np, child) {
 214		if (child->parent != np) {
 215			pr_err("Child node %pOFn links to wrong parent %pOFn\n",
 216				 child, np);
 217			rc = -EINVAL;
 218			goto put_child;
 219		}
 220
 221		rc = of_unittest_check_node_linkage(child);
 222		if (rc < 0)
 223			goto put_child;
 224		count += rc;
 225	}
 226
 227	return count + 1;
 228put_child:
 229	of_node_put(child);
 230	return rc;
 231}
 232
 233static void __init of_unittest_check_tree_linkage(void)
 234{
 235	struct device_node *np;
 236	int allnode_count = 0, child_count;
 237
 238	if (!of_root)
 239		return;
 240
 241	for_each_of_allnodes(np)
 242		allnode_count++;
 243	child_count = of_unittest_check_node_linkage(of_root);
 244
 245	unittest(child_count > 0, "Device node data structure is corrupted\n");
 246	unittest(child_count == allnode_count,
 247		 "allnodes list size (%i) doesn't match sibling lists size (%i)\n",
 248		 allnode_count, child_count);
 249	pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count);
 250}
 251
 252static void __init of_unittest_printf_one(struct device_node *np, const char *fmt,
 253					  const char *expected)
 254{
 255	unsigned char *buf;
 256	int buf_size;
 257	int size, i;
 258
 259	buf_size = strlen(expected) + 10;
 260	buf = kmalloc(buf_size, GFP_KERNEL);
 261	if (!buf)
 262		return;
 263
 264	/* Baseline; check conversion with a large size limit */
 265	memset(buf, 0xff, buf_size);
 266	size = snprintf(buf, buf_size - 2, fmt, np);
 267
 268	/* use strcmp() instead of strncmp() here to be absolutely sure strings match */
 269	unittest((strcmp(buf, expected) == 0) && (buf[size+1] == 0xff),
 270		"sprintf failed; fmt='%s' expected='%s' rslt='%s'\n",
 271		fmt, expected, buf);
 272
 273	/* Make sure length limits work */
 274	size++;
 275	for (i = 0; i < 2; i++, size--) {
 276		/* Clear the buffer, and make sure it works correctly still */
 277		memset(buf, 0xff, buf_size);
 278		snprintf(buf, size+1, fmt, np);
 279		unittest(strncmp(buf, expected, size) == 0 && (buf[size+1] == 0xff),
 280			"snprintf failed; size=%i fmt='%s' expected='%s' rslt='%s'\n",
 281			size, fmt, expected, buf);
 282	}
 283	kfree(buf);
 284}
 285
 286static void __init of_unittest_printf(void)
 287{
 288	struct device_node *np;
 289	const char *full_name = "/testcase-data/platform-tests/test-device@1/dev@100";
 290	char phandle_str[16] = "";
 291
 292	np = of_find_node_by_path(full_name);
 293	if (!np) {
 294		unittest(np, "testcase data missing\n");
 295		return;
 296	}
 297
 298	num_to_str(phandle_str, sizeof(phandle_str), np->phandle, 0);
 299
 300	of_unittest_printf_one(np, "%pOF",  full_name);
 301	of_unittest_printf_one(np, "%pOFf", full_name);
 302	of_unittest_printf_one(np, "%pOFn", "dev");
 303	of_unittest_printf_one(np, "%2pOFn", "dev");
 304	of_unittest_printf_one(np, "%5pOFn", "  dev");
 305	of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
 306	of_unittest_printf_one(np, "%pOFp", phandle_str);
 307	of_unittest_printf_one(np, "%pOFP", "dev@100");
 308	of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
 309	of_unittest_printf_one(np, "%10pOFP", "   dev@100");
 310	of_unittest_printf_one(np, "%-10pOFP", "dev@100   ");
 311	of_unittest_printf_one(of_root, "%pOFP", "/");
 312	of_unittest_printf_one(np, "%pOFF", "----");
 313	of_unittest_printf_one(np, "%pOFPF", "dev@100:----");
 314	of_unittest_printf_one(np, "%pOFPFPc", "dev@100:----:dev@100:test-sub-device");
 315	of_unittest_printf_one(np, "%pOFc", "test-sub-device");
 316	of_unittest_printf_one(np, "%pOFC",
 317			"\"test-sub-device\",\"test-compat2\",\"test-compat3\"");
 318}
 319
 320struct node_hash {
 321	struct hlist_node node;
 322	struct device_node *np;
 323};
 324
 325static DEFINE_HASHTABLE(phandle_ht, 8);
 326static void __init of_unittest_check_phandles(void)
 327{
 328	struct device_node *np;
 329	struct node_hash *nh;
 330	struct hlist_node *tmp;
 331	int i, dup_count = 0, phandle_count = 0;
 332
 333	for_each_of_allnodes(np) {
 334		if (!np->phandle)
 335			continue;
 336
 337		hash_for_each_possible(phandle_ht, nh, node, np->phandle) {
 338			if (nh->np->phandle == np->phandle) {
 339				pr_info("Duplicate phandle! %i used by %pOF and %pOF\n",
 340					np->phandle, nh->np, np);
 341				dup_count++;
 342				break;
 343			}
 344		}
 345
 346		nh = kzalloc(sizeof(*nh), GFP_KERNEL);
 347		if (!nh)
 348			return;
 349
 350		nh->np = np;
 351		hash_add(phandle_ht, &nh->node, np->phandle);
 352		phandle_count++;
 353	}
 354	unittest(dup_count == 0, "Found %i duplicates in %i phandles\n",
 355		 dup_count, phandle_count);
 356
 357	/* Clean up */
 358	hash_for_each_safe(phandle_ht, i, tmp, nh, node) {
 359		hash_del(&nh->node);
 360		kfree(nh);
 361	}
 362}
 363
 364static void __init of_unittest_parse_phandle_with_args(void)
 365{
 366	struct device_node *np;
 367	struct of_phandle_args args;
 368	int i, rc;
 369
 370	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 371	if (!np) {
 372		pr_err("missing testcase data\n");
 373		return;
 374	}
 375
 376	rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 377	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 378
 379	for (i = 0; i < 8; i++) {
 380		bool passed = true;
 381
 382		memset(&args, 0, sizeof(args));
 383		rc = of_parse_phandle_with_args(np, "phandle-list",
 384						"#phandle-cells", i, &args);
 385
 386		/* Test the values from tests-phandle.dtsi */
 387		switch (i) {
 388		case 0:
 389			passed &= !rc;
 390			passed &= (args.args_count == 1);
 391			passed &= (args.args[0] == (i + 1));
 392			break;
 393		case 1:
 394			passed &= !rc;
 395			passed &= (args.args_count == 2);
 396			passed &= (args.args[0] == (i + 1));
 397			passed &= (args.args[1] == 0);
 398			break;
 399		case 2:
 400			passed &= (rc == -ENOENT);
 401			break;
 402		case 3:
 403			passed &= !rc;
 404			passed &= (args.args_count == 3);
 405			passed &= (args.args[0] == (i + 1));
 406			passed &= (args.args[1] == 4);
 407			passed &= (args.args[2] == 3);
 408			break;
 409		case 4:
 410			passed &= !rc;
 411			passed &= (args.args_count == 2);
 412			passed &= (args.args[0] == (i + 1));
 413			passed &= (args.args[1] == 100);
 414			break;
 415		case 5:
 416			passed &= !rc;
 417			passed &= (args.args_count == 0);
 418			break;
 419		case 6:
 420			passed &= !rc;
 421			passed &= (args.args_count == 1);
 422			passed &= (args.args[0] == (i + 1));
 423			break;
 424		case 7:
 425			passed &= (rc == -ENOENT);
 426			break;
 427		default:
 428			passed = false;
 429		}
 430
 431		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 432			 i, args.np, rc);
 433	}
 434
 435	/* Check for missing list property */
 436	memset(&args, 0, sizeof(args));
 437	rc = of_parse_phandle_with_args(np, "phandle-list-missing",
 438					"#phandle-cells", 0, &args);
 439	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 440	rc = of_count_phandle_with_args(np, "phandle-list-missing",
 441					"#phandle-cells");
 442	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 443
 444	/* Check for missing cells property */
 445	memset(&args, 0, sizeof(args));
 446	rc = of_parse_phandle_with_args(np, "phandle-list",
 447					"#phandle-cells-missing", 0, &args);
 448	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 449	rc = of_count_phandle_with_args(np, "phandle-list",
 450					"#phandle-cells-missing");
 451	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 452
 453	/* Check for bad phandle in list */
 454	memset(&args, 0, sizeof(args));
 455	rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
 456					"#phandle-cells", 0, &args);
 457	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 458	rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
 459					"#phandle-cells");
 460	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 461
 462	/* Check for incorrectly formed argument list */
 463	memset(&args, 0, sizeof(args));
 464	rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
 465					"#phandle-cells", 1, &args);
 466	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 467	rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
 468					"#phandle-cells");
 469	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 470}
 471
 472static void __init of_unittest_parse_phandle_with_args_map(void)
 473{
 474	struct device_node *np, *p0, *p1, *p2, *p3;
 475	struct of_phandle_args args;
 476	int i, rc;
 477
 478	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-b");
 479	if (!np) {
 480		pr_err("missing testcase data\n");
 481		return;
 482	}
 483
 484	p0 = of_find_node_by_path("/testcase-data/phandle-tests/provider0");
 485	if (!p0) {
 486		pr_err("missing testcase data\n");
 487		return;
 488	}
 489
 490	p1 = of_find_node_by_path("/testcase-data/phandle-tests/provider1");
 491	if (!p1) {
 492		pr_err("missing testcase data\n");
 493		return;
 494	}
 495
 496	p2 = of_find_node_by_path("/testcase-data/phandle-tests/provider2");
 497	if (!p2) {
 498		pr_err("missing testcase data\n");
 499		return;
 500	}
 501
 502	p3 = of_find_node_by_path("/testcase-data/phandle-tests/provider3");
 503	if (!p3) {
 504		pr_err("missing testcase data\n");
 505		return;
 506	}
 507
 508	rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
 509	unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
 510
 511	for (i = 0; i < 8; i++) {
 512		bool passed = true;
 513
 514		memset(&args, 0, sizeof(args));
 515		rc = of_parse_phandle_with_args_map(np, "phandle-list",
 516						    "phandle", i, &args);
 517
 518		/* Test the values from tests-phandle.dtsi */
 519		switch (i) {
 520		case 0:
 521			passed &= !rc;
 522			passed &= (args.np == p1);
 523			passed &= (args.args_count == 1);
 524			passed &= (args.args[0] == 1);
 525			break;
 526		case 1:
 527			passed &= !rc;
 528			passed &= (args.np == p3);
 529			passed &= (args.args_count == 3);
 530			passed &= (args.args[0] == 2);
 531			passed &= (args.args[1] == 5);
 532			passed &= (args.args[2] == 3);
 533			break;
 534		case 2:
 535			passed &= (rc == -ENOENT);
 536			break;
 537		case 3:
 538			passed &= !rc;
 539			passed &= (args.np == p0);
 540			passed &= (args.args_count == 0);
 541			break;
 542		case 4:
 543			passed &= !rc;
 544			passed &= (args.np == p1);
 545			passed &= (args.args_count == 1);
 546			passed &= (args.args[0] == 3);
 547			break;
 548		case 5:
 549			passed &= !rc;
 550			passed &= (args.np == p0);
 551			passed &= (args.args_count == 0);
 552			break;
 553		case 6:
 554			passed &= !rc;
 555			passed &= (args.np == p2);
 556			passed &= (args.args_count == 2);
 557			passed &= (args.args[0] == 15);
 558			passed &= (args.args[1] == 0x20);
 559			break;
 560		case 7:
 561			passed &= (rc == -ENOENT);
 562			break;
 563		default:
 564			passed = false;
 565		}
 566
 567		unittest(passed, "index %i - data error on node %s rc=%i\n",
 568			 i, args.np->full_name, rc);
 569	}
 570
 571	/* Check for missing list property */
 572	memset(&args, 0, sizeof(args));
 573	rc = of_parse_phandle_with_args_map(np, "phandle-list-missing",
 574					    "phandle", 0, &args);
 575	unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 576
 577	/* Check for missing cells,map,mask property */
 578	memset(&args, 0, sizeof(args));
 579	rc = of_parse_phandle_with_args_map(np, "phandle-list",
 580					    "phandle-missing", 0, &args);
 581	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 582
 583	/* Check for bad phandle in list */
 584	memset(&args, 0, sizeof(args));
 585	rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-phandle",
 586					    "phandle", 0, &args);
 587	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 588
 589	/* Check for incorrectly formed argument list */
 590	memset(&args, 0, sizeof(args));
 591	rc = of_parse_phandle_with_args_map(np, "phandle-list-bad-args",
 592					    "phandle", 1, &args);
 593	unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 594}
 595
 596static void __init of_unittest_property_string(void)
 597{
 598	const char *strings[4];
 599	struct device_node *np;
 600	int rc;
 601
 602	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 603	if (!np) {
 604		pr_err("No testcase data in device tree\n");
 605		return;
 606	}
 607
 608	rc = of_property_match_string(np, "phandle-list-names", "first");
 609	unittest(rc == 0, "first expected:0 got:%i\n", rc);
 610	rc = of_property_match_string(np, "phandle-list-names", "second");
 611	unittest(rc == 1, "second expected:1 got:%i\n", rc);
 612	rc = of_property_match_string(np, "phandle-list-names", "third");
 613	unittest(rc == 2, "third expected:2 got:%i\n", rc);
 614	rc = of_property_match_string(np, "phandle-list-names", "fourth");
 615	unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
 616	rc = of_property_match_string(np, "missing-property", "blah");
 617	unittest(rc == -EINVAL, "missing property; rc=%i\n", rc);
 618	rc = of_property_match_string(np, "empty-property", "blah");
 619	unittest(rc == -ENODATA, "empty property; rc=%i\n", rc);
 620	rc = of_property_match_string(np, "unterminated-string", "blah");
 621	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 622
 623	/* of_property_count_strings() tests */
 624	rc = of_property_count_strings(np, "string-property");
 625	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 626	rc = of_property_count_strings(np, "phandle-list-names");
 627	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 628	rc = of_property_count_strings(np, "unterminated-string");
 629	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 630	rc = of_property_count_strings(np, "unterminated-string-list");
 631	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 632
 633	/* of_property_read_string_index() tests */
 634	rc = of_property_read_string_index(np, "string-property", 0, strings);
 635	unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
 636	strings[0] = NULL;
 637	rc = of_property_read_string_index(np, "string-property", 1, strings);
 638	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 639	rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
 640	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 641	rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
 642	unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
 643	rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
 644	unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
 645	strings[0] = NULL;
 646	rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
 647	unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 648	strings[0] = NULL;
 649	rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
 650	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 651	rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
 652	unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 653	strings[0] = NULL;
 654	rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
 655	unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 656	strings[1] = NULL;
 657
 658	/* of_property_read_string_array() tests */
 659	rc = of_property_read_string_array(np, "string-property", strings, 4);
 660	unittest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 661	rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
 662	unittest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 663	rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
 664	unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 665	/* -- An incorrectly formed string should cause a failure */
 666	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
 667	unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 668	/* -- parsing the correctly formed strings should still work: */
 669	strings[2] = NULL;
 670	rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
 671	unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
 672	strings[1] = NULL;
 673	rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
 674	unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
 675}
 676
 677#define propcmp(p1, p2) (((p1)->length == (p2)->length) && \
 678			(p1)->value && (p2)->value && \
 679			!memcmp((p1)->value, (p2)->value, (p1)->length) && \
 680			!strcmp((p1)->name, (p2)->name))
 681static void __init of_unittest_property_copy(void)
 682{
 683#ifdef CONFIG_OF_DYNAMIC
 684	struct property p1 = { .name = "p1", .length = 0, .value = "" };
 685	struct property p2 = { .name = "p2", .length = 5, .value = "abcd" };
 686	struct property *new;
 687
 688	new = __of_prop_dup(&p1, GFP_KERNEL);
 689	unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n");
 690	kfree(new->value);
 691	kfree(new->name);
 692	kfree(new);
 693
 694	new = __of_prop_dup(&p2, GFP_KERNEL);
 695	unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n");
 696	kfree(new->value);
 697	kfree(new->name);
 698	kfree(new);
 699#endif
 700}
 701
 702static void __init of_unittest_changeset(void)
 703{
 704#ifdef CONFIG_OF_DYNAMIC
 705	struct property *ppadd, padd = { .name = "prop-add", .length = 1, .value = "" };
 706	struct property *ppname_n1,  pname_n1  = { .name = "name", .length = 3, .value = "n1"  };
 707	struct property *ppname_n2,  pname_n2  = { .name = "name", .length = 3, .value = "n2"  };
 708	struct property *ppname_n21, pname_n21 = { .name = "name", .length = 3, .value = "n21" };
 709	struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" };
 710	struct property *ppremove;
 711	struct device_node *n1, *n2, *n21, *nchangeset, *nremove, *parent, *np;
 712	struct of_changeset chgset;
 713
 714	n1 = __of_node_dup(NULL, "n1");
 715	unittest(n1, "testcase setup failure\n");
 716
 717	n2 = __of_node_dup(NULL, "n2");
 718	unittest(n2, "testcase setup failure\n");
 719
 720	n21 = __of_node_dup(NULL, "n21");
 721	unittest(n21, "testcase setup failure %p\n", n21);
 722
 723	nchangeset = of_find_node_by_path("/testcase-data/changeset");
 724	nremove = of_get_child_by_name(nchangeset, "node-remove");
 725	unittest(nremove, "testcase setup failure\n");
 726
 727	ppadd = __of_prop_dup(&padd, GFP_KERNEL);
 728	unittest(ppadd, "testcase setup failure\n");
 729
 730	ppname_n1  = __of_prop_dup(&pname_n1, GFP_KERNEL);
 731	unittest(ppname_n1, "testcase setup failure\n");
 732
 733	ppname_n2  = __of_prop_dup(&pname_n2, GFP_KERNEL);
 734	unittest(ppname_n2, "testcase setup failure\n");
 735
 736	ppname_n21 = __of_prop_dup(&pname_n21, GFP_KERNEL);
 737	unittest(ppname_n21, "testcase setup failure\n");
 738
 739	ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL);
 740	unittest(ppupdate, "testcase setup failure\n");
 741
 742	parent = nchangeset;
 743	n1->parent = parent;
 744	n2->parent = parent;
 745	n21->parent = n2;
 746
 747	ppremove = of_find_property(parent, "prop-remove", NULL);
 748	unittest(ppremove, "failed to find removal prop");
 749
 750	of_changeset_init(&chgset);
 751
 752	unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n");
 753	unittest(!of_changeset_add_property(&chgset, n1, ppname_n1), "fail add prop name\n");
 754
 755	unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n");
 756	unittest(!of_changeset_add_property(&chgset, n2, ppname_n2), "fail add prop name\n");
 757
 758	unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n");
 759	unittest(!of_changeset_add_property(&chgset, n21, ppname_n21), "fail add prop name\n");
 760
 761	unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n");
 762
 763	unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop prop-add\n");
 764	unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n");
 765	unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n");
 766
 767	unittest(!of_changeset_apply(&chgset), "apply failed\n");
 768
 769	of_node_put(nchangeset);
 770
 771	/* Make sure node names are constructed correctly */
 772	unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")),
 773		 "'%pOF' not added\n", n21);
 774	of_node_put(np);
 775
 776	unittest(!of_changeset_revert(&chgset), "revert failed\n");
 777
 778	of_changeset_destroy(&chgset);
 779#endif
 780}
 781
 782static void __init of_unittest_parse_interrupts(void)
 783{
 784	struct device_node *np;
 785	struct of_phandle_args args;
 786	int i, rc;
 787
 788	if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
 789		return;
 790
 791	np = of_find_node_by_path("/testcase-data/interrupts/interrupts0");
 792	if (!np) {
 793		pr_err("missing testcase data\n");
 794		return;
 795	}
 796
 797	for (i = 0; i < 4; i++) {
 798		bool passed = true;
 799
 800		memset(&args, 0, sizeof(args));
 801		rc = of_irq_parse_one(np, i, &args);
 802
 803		passed &= !rc;
 804		passed &= (args.args_count == 1);
 805		passed &= (args.args[0] == (i + 1));
 806
 807		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 808			 i, args.np, rc);
 809	}
 810	of_node_put(np);
 811
 812	np = of_find_node_by_path("/testcase-data/interrupts/interrupts1");
 813	if (!np) {
 814		pr_err("missing testcase data\n");
 815		return;
 816	}
 817
 818	for (i = 0; i < 4; i++) {
 819		bool passed = true;
 820
 821		memset(&args, 0, sizeof(args));
 822		rc = of_irq_parse_one(np, i, &args);
 823
 824		/* Test the values from tests-phandle.dtsi */
 825		switch (i) {
 826		case 0:
 827			passed &= !rc;
 828			passed &= (args.args_count == 1);
 829			passed &= (args.args[0] == 9);
 830			break;
 831		case 1:
 832			passed &= !rc;
 833			passed &= (args.args_count == 3);
 834			passed &= (args.args[0] == 10);
 835			passed &= (args.args[1] == 11);
 836			passed &= (args.args[2] == 12);
 837			break;
 838		case 2:
 839			passed &= !rc;
 840			passed &= (args.args_count == 2);
 841			passed &= (args.args[0] == 13);
 842			passed &= (args.args[1] == 14);
 843			break;
 844		case 3:
 845			passed &= !rc;
 846			passed &= (args.args_count == 2);
 847			passed &= (args.args[0] == 15);
 848			passed &= (args.args[1] == 16);
 849			break;
 850		default:
 851			passed = false;
 852		}
 853		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 854			 i, args.np, rc);
 855	}
 856	of_node_put(np);
 857}
 858
 859static void __init of_unittest_parse_interrupts_extended(void)
 860{
 861	struct device_node *np;
 862	struct of_phandle_args args;
 863	int i, rc;
 864
 865	if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
 866		return;
 867
 868	np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0");
 869	if (!np) {
 870		pr_err("missing testcase data\n");
 871		return;
 872	}
 873
 874	for (i = 0; i < 7; i++) {
 875		bool passed = true;
 876
 877		memset(&args, 0, sizeof(args));
 878		rc = of_irq_parse_one(np, i, &args);
 879
 880		/* Test the values from tests-phandle.dtsi */
 881		switch (i) {
 882		case 0:
 883			passed &= !rc;
 884			passed &= (args.args_count == 1);
 885			passed &= (args.args[0] == 1);
 886			break;
 887		case 1:
 888			passed &= !rc;
 889			passed &= (args.args_count == 3);
 890			passed &= (args.args[0] == 2);
 891			passed &= (args.args[1] == 3);
 892			passed &= (args.args[2] == 4);
 893			break;
 894		case 2:
 895			passed &= !rc;
 896			passed &= (args.args_count == 2);
 897			passed &= (args.args[0] == 5);
 898			passed &= (args.args[1] == 6);
 899			break;
 900		case 3:
 901			passed &= !rc;
 902			passed &= (args.args_count == 1);
 903			passed &= (args.args[0] == 9);
 904			break;
 905		case 4:
 906			passed &= !rc;
 907			passed &= (args.args_count == 3);
 908			passed &= (args.args[0] == 10);
 909			passed &= (args.args[1] == 11);
 910			passed &= (args.args[2] == 12);
 911			break;
 912		case 5:
 913			passed &= !rc;
 914			passed &= (args.args_count == 2);
 915			passed &= (args.args[0] == 13);
 916			passed &= (args.args[1] == 14);
 917			break;
 918		case 6:
 919			passed &= !rc;
 920			passed &= (args.args_count == 1);
 921			passed &= (args.args[0] == 15);
 922			break;
 923		default:
 924			passed = false;
 925		}
 926
 927		unittest(passed, "index %i - data error on node %pOF rc=%i\n",
 928			 i, args.np, rc);
 929	}
 930	of_node_put(np);
 931}
 932
 933static const struct of_device_id match_node_table[] = {
 934	{ .data = "A", .name = "name0", }, /* Name alone is lowest priority */
 935	{ .data = "B", .type = "type1", }, /* followed by type alone */
 936
 937	{ .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */
 938	{ .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */
 939	{ .data = "Cc", .name = "name2", .type = "type2", },
 940
 941	{ .data = "E", .compatible = "compat3" },
 942	{ .data = "G", .compatible = "compat2", },
 943	{ .data = "H", .compatible = "compat2", .name = "name5", },
 944	{ .data = "I", .compatible = "compat2", .type = "type1", },
 945	{ .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", },
 946	{ .data = "K", .compatible = "compat2", .name = "name9", },
 947	{}
 948};
 949
 950static struct {
 951	const char *path;
 952	const char *data;
 953} match_node_tests[] = {
 954	{ .path = "/testcase-data/match-node/name0", .data = "A", },
 955	{ .path = "/testcase-data/match-node/name1", .data = "B", },
 956	{ .path = "/testcase-data/match-node/a/name2", .data = "Ca", },
 957	{ .path = "/testcase-data/match-node/b/name2", .data = "Cb", },
 958	{ .path = "/testcase-data/match-node/c/name2", .data = "Cc", },
 959	{ .path = "/testcase-data/match-node/name3", .data = "E", },
 960	{ .path = "/testcase-data/match-node/name4", .data = "G", },
 961	{ .path = "/testcase-data/match-node/name5", .data = "H", },
 962	{ .path = "/testcase-data/match-node/name6", .data = "G", },
 963	{ .path = "/testcase-data/match-node/name7", .data = "I", },
 964	{ .path = "/testcase-data/match-node/name8", .data = "J", },
 965	{ .path = "/testcase-data/match-node/name9", .data = "K", },
 966};
 967
 968static void __init of_unittest_match_node(void)
 969{
 970	struct device_node *np;
 971	const struct of_device_id *match;
 972	int i;
 973
 974	for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) {
 975		np = of_find_node_by_path(match_node_tests[i].path);
 976		if (!np) {
 977			unittest(0, "missing testcase node %s\n",
 978				match_node_tests[i].path);
 979			continue;
 980		}
 981
 982		match = of_match_node(match_node_table, np);
 983		if (!match) {
 984			unittest(0, "%s didn't match anything\n",
 985				match_node_tests[i].path);
 986			continue;
 987		}
 988
 989		if (strcmp(match->data, match_node_tests[i].data) != 0) {
 990			unittest(0, "%s got wrong match. expected %s, got %s\n",
 991				match_node_tests[i].path, match_node_tests[i].data,
 992				(const char *)match->data);
 993			continue;
 994		}
 995		unittest(1, "passed");
 996	}
 997}
 998
 999static struct resource test_bus_res = {
1000	.start = 0xfffffff8,
1001	.end = 0xfffffff9,
1002	.flags = IORESOURCE_MEM,
1003};
1004static const struct platform_device_info test_bus_info = {
1005	.name = "unittest-bus",
1006};
1007static void __init of_unittest_platform_populate(void)
1008{
1009	int irq, rc;
1010	struct device_node *np, *child, *grandchild;
1011	struct platform_device *pdev, *test_bus;
1012	const struct of_device_id match[] = {
1013		{ .compatible = "test-device", },
1014		{}
1015	};
1016
1017	np = of_find_node_by_path("/testcase-data");
1018	of_platform_default_populate(np, NULL, NULL);
1019
1020	/* Test that a missing irq domain returns -EPROBE_DEFER */
1021	np = of_find_node_by_path("/testcase-data/testcase-device1");
1022	pdev = of_find_device_by_node(np);
1023	unittest(pdev, "device 1 creation failed\n");
1024
1025	if (!(of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)) {
1026		irq = platform_get_irq(pdev, 0);
1027		unittest(irq == -EPROBE_DEFER,
1028			 "device deferred probe failed - %d\n", irq);
1029
1030		/* Test that a parsing failure does not return -EPROBE_DEFER */
1031		np = of_find_node_by_path("/testcase-data/testcase-device2");
1032		pdev = of_find_device_by_node(np);
1033		unittest(pdev, "device 2 creation failed\n");
1034		irq = platform_get_irq(pdev, 0);
1035		unittest(irq < 0 && irq != -EPROBE_DEFER,
1036			 "device parsing error failed - %d\n", irq);
1037	}
1038
1039	np = of_find_node_by_path("/testcase-data/platform-tests");
1040	unittest(np, "No testcase data in device tree\n");
1041	if (!np)
1042		return;
1043
1044	test_bus = platform_device_register_full(&test_bus_info);
1045	rc = PTR_ERR_OR_ZERO(test_bus);
1046	unittest(!rc, "testbus registration failed; rc=%i\n", rc);
1047	if (rc) {
1048		of_node_put(np);
1049		return;
1050	}
1051	test_bus->dev.of_node = np;
1052
1053	/*
1054	 * Add a dummy resource to the test bus node after it is
1055	 * registered to catch problems with un-inserted resources. The
1056	 * DT code doesn't insert the resources, and it has caused the
1057	 * kernel to oops in the past. This makes sure the same bug
1058	 * doesn't crop up again.
1059	 */
1060	platform_device_add_resources(test_bus, &test_bus_res, 1);
1061
1062	of_platform_populate(np, match, NULL, &test_bus->dev);
1063	for_each_child_of_node(np, child) {
1064		for_each_child_of_node(child, grandchild)
1065			unittest(of_find_device_by_node(grandchild),
1066				 "Could not create device for node '%pOFn'\n",
1067				 grandchild);
1068	}
1069
1070	of_platform_depopulate(&test_bus->dev);
1071	for_each_child_of_node(np, child) {
1072		for_each_child_of_node(child, grandchild)
1073			unittest(!of_find_device_by_node(grandchild),
1074				 "device didn't get destroyed '%pOFn'\n",
1075				 grandchild);
1076	}
1077
1078	platform_device_unregister(test_bus);
1079	of_node_put(np);
1080}
1081
1082/**
1083 *	update_node_properties - adds the properties
1084 *	of np into dup node (present in live tree) and
1085 *	updates parent of children of np to dup.
1086 *
1087 *	@np:	node whose properties are being added to the live tree
1088 *	@dup:	node present in live tree to be updated
1089 */
1090static void update_node_properties(struct device_node *np,
1091					struct device_node *dup)
1092{
1093	struct property *prop;
1094	struct property *save_next;
1095	struct device_node *child;
1096	int ret;
 
 
1097
1098	for_each_child_of_node(np, child)
1099		child->parent = dup;
1100
1101	/*
1102	 * "unittest internal error: unable to add testdata property"
1103	 *
1104	 *    If this message reports a property in node '/__symbols__' then
1105	 *    the respective unittest overlay contains a label that has the
1106	 *    same name as a label in the live devicetree.  The label will
1107	 *    be in the live devicetree only if the devicetree source was
1108	 *    compiled with the '-@' option.  If you encounter this error,
1109	 *    please consider renaming __all__ of the labels in the unittest
1110	 *    overlay dts files with an odd prefix that is unlikely to be
1111	 *    used in a real devicetree.
1112	 */
1113
1114	/*
1115	 * open code for_each_property_of_node() because of_add_property()
1116	 * sets prop->next to NULL
1117	 */
1118	for (prop = np->properties; prop != NULL; prop = save_next) {
1119		save_next = prop->next;
1120		ret = of_add_property(dup, prop);
1121		if (ret) {
1122			if (ret == -EEXIST && !strcmp(prop->name, "name"))
1123				continue;
1124			pr_err("unittest internal error: unable to add testdata property %pOF/%s",
1125			       np, prop->name);
1126		}
1127	}
1128}
1129
1130/**
1131 *	attach_node_and_children - attaches nodes
1132 *	and its children to live tree.
1133 *	CAUTION: misleading function name - if node @np already exists in
1134 *	the live tree then children of @np are *not* attached to the live
1135 *	tree.  This works for the current test devicetree nodes because such
1136 *	nodes do not have child nodes.
1137 *
1138 *	@np:	Node to attach to live tree
1139 */
1140static void attach_node_and_children(struct device_node *np)
1141{
1142	struct device_node *next, *dup, *child;
1143	unsigned long flags;
1144	const char *full_name;
1145
1146	full_name = kasprintf(GFP_KERNEL, "%pOF", np);
1147
1148	if (!strcmp(full_name, "/__local_fixups__") ||
1149	    !strcmp(full_name, "/__fixups__"))
1150		return;
1151
1152	dup = of_find_node_by_path(full_name);
1153	kfree(full_name);
1154	if (dup) {
1155		update_node_properties(np, dup);
1156		return;
1157	}
1158
1159	child = np->child;
1160	np->child = NULL;
1161
1162	mutex_lock(&of_mutex);
1163	raw_spin_lock_irqsave(&devtree_lock, flags);
1164	np->sibling = np->parent->child;
1165	np->parent->child = np;
1166	of_node_clear_flag(np, OF_DETACHED);
1167	raw_spin_unlock_irqrestore(&devtree_lock, flags);
1168
1169	__of_attach_node_sysfs(np);
1170	mutex_unlock(&of_mutex);
1171
1172	while (child) {
1173		next = child->sibling;
1174		attach_node_and_children(child);
1175		child = next;
1176	}
 
 
1177}
1178
1179/**
1180 *	unittest_data_add - Reads, copies data from
1181 *	linked tree and attaches it to the live tree
1182 */
1183static int __init unittest_data_add(void)
1184{
1185	void *unittest_data;
1186	struct device_node *unittest_data_node, *np;
1187	/*
1188	 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically
1189	 * created by cmd_dt_S_dtb in scripts/Makefile.lib
1190	 */
1191	extern uint8_t __dtb_testcases_begin[];
1192	extern uint8_t __dtb_testcases_end[];
1193	const int size = __dtb_testcases_end - __dtb_testcases_begin;
1194	int rc;
1195
1196	if (!size) {
1197		pr_warn("%s: No testcase data to attach; not running tests\n",
1198			__func__);
1199		return -ENODATA;
1200	}
1201
1202	/* creating copy */
1203	unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL);
1204	if (!unittest_data)
 
 
 
1205		return -ENOMEM;
1206
1207	of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node);
1208	if (!unittest_data_node) {
1209		pr_warn("%s: No tree to attach; not running tests\n", __func__);
1210		kfree(unittest_data);
1211		return -ENODATA;
1212	}
1213
1214	/*
1215	 * This lock normally encloses of_resolve_phandles()
1216	 */
1217	of_overlay_mutex_lock();
1218
1219	rc = of_resolve_phandles(unittest_data_node);
1220	if (rc) {
1221		pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc);
1222		of_overlay_mutex_unlock();
1223		return -EINVAL;
1224	}
1225
1226	if (!of_root) {
1227		of_root = unittest_data_node;
1228		for_each_of_allnodes(np)
1229			__of_attach_node_sysfs(np);
1230		of_aliases = of_find_node_by_path("/aliases");
1231		of_chosen = of_find_node_by_path("/chosen");
1232		of_overlay_mutex_unlock();
1233		return 0;
1234	}
1235
1236	/* attach the sub-tree to live tree */
1237	np = unittest_data_node->child;
1238	while (np) {
1239		struct device_node *next = np->sibling;
1240
1241		np->parent = of_root;
1242		attach_node_and_children(np);
1243		np = next;
1244	}
1245
1246	of_overlay_mutex_unlock();
1247
1248	return 0;
1249}
1250
1251#ifdef CONFIG_OF_OVERLAY
1252static int __init overlay_data_apply(const char *overlay_name, int *overlay_id);
1253
1254static int unittest_probe(struct platform_device *pdev)
1255{
1256	struct device *dev = &pdev->dev;
1257	struct device_node *np = dev->of_node;
1258
1259	if (np == NULL) {
1260		dev_err(dev, "No OF data for device\n");
1261		return -EINVAL;
1262
1263	}
1264
1265	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1266
1267	of_platform_populate(np, NULL, NULL, &pdev->dev);
1268
1269	return 0;
1270}
1271
1272static int unittest_remove(struct platform_device *pdev)
1273{
1274	struct device *dev = &pdev->dev;
1275	struct device_node *np = dev->of_node;
1276
1277	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1278	return 0;
1279}
1280
1281static const struct of_device_id unittest_match[] = {
1282	{ .compatible = "unittest", },
1283	{},
1284};
1285
1286static struct platform_driver unittest_driver = {
1287	.probe			= unittest_probe,
1288	.remove			= unittest_remove,
1289	.driver = {
1290		.name		= "unittest",
1291		.of_match_table	= of_match_ptr(unittest_match),
1292	},
1293};
1294
1295/* get the platform device instantiated at the path */
1296static struct platform_device *of_path_to_platform_device(const char *path)
1297{
1298	struct device_node *np;
1299	struct platform_device *pdev;
1300
1301	np = of_find_node_by_path(path);
1302	if (np == NULL)
1303		return NULL;
1304
1305	pdev = of_find_device_by_node(np);
1306	of_node_put(np);
1307
1308	return pdev;
1309}
1310
1311/* find out if a platform device exists at that path */
1312static int of_path_platform_device_exists(const char *path)
1313{
1314	struct platform_device *pdev;
1315
1316	pdev = of_path_to_platform_device(path);
1317	platform_device_put(pdev);
1318	return pdev != NULL;
1319}
1320
1321#if IS_BUILTIN(CONFIG_I2C)
1322
1323/* get the i2c client device instantiated at the path */
1324static struct i2c_client *of_path_to_i2c_client(const char *path)
1325{
1326	struct device_node *np;
1327	struct i2c_client *client;
1328
1329	np = of_find_node_by_path(path);
1330	if (np == NULL)
1331		return NULL;
1332
1333	client = of_find_i2c_device_by_node(np);
1334	of_node_put(np);
1335
1336	return client;
1337}
1338
1339/* find out if a i2c client device exists at that path */
1340static int of_path_i2c_client_exists(const char *path)
1341{
1342	struct i2c_client *client;
1343
1344	client = of_path_to_i2c_client(path);
1345	if (client)
1346		put_device(&client->dev);
1347	return client != NULL;
1348}
1349#else
1350static int of_path_i2c_client_exists(const char *path)
1351{
1352	return 0;
1353}
1354#endif
1355
1356enum overlay_type {
1357	PDEV_OVERLAY,
1358	I2C_OVERLAY
1359};
1360
1361static int of_path_device_type_exists(const char *path,
1362		enum overlay_type ovtype)
1363{
1364	switch (ovtype) {
1365	case PDEV_OVERLAY:
1366		return of_path_platform_device_exists(path);
1367	case I2C_OVERLAY:
1368		return of_path_i2c_client_exists(path);
1369	}
1370	return 0;
1371}
1372
1373static const char *unittest_path(int nr, enum overlay_type ovtype)
1374{
1375	const char *base;
1376	static char buf[256];
1377
1378	switch (ovtype) {
1379	case PDEV_OVERLAY:
1380		base = "/testcase-data/overlay-node/test-bus";
1381		break;
1382	case I2C_OVERLAY:
1383		base = "/testcase-data/overlay-node/test-bus/i2c-test-bus";
1384		break;
1385	default:
1386		buf[0] = '\0';
1387		return buf;
1388	}
1389	snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr);
1390	buf[sizeof(buf) - 1] = '\0';
1391	return buf;
1392}
1393
1394static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype)
1395{
1396	const char *path;
1397
1398	path = unittest_path(unittest_nr, ovtype);
1399
1400	switch (ovtype) {
1401	case PDEV_OVERLAY:
1402		return of_path_platform_device_exists(path);
1403	case I2C_OVERLAY:
1404		return of_path_i2c_client_exists(path);
1405	}
1406	return 0;
1407}
1408
1409static const char *overlay_name_from_nr(int nr)
1410{
1411	static char buf[256];
1412
1413	snprintf(buf, sizeof(buf) - 1,
1414		"overlay_%d", nr);
1415	buf[sizeof(buf) - 1] = '\0';
1416
1417	return buf;
1418}
1419
1420static const char *bus_path = "/testcase-data/overlay-node/test-bus";
1421
1422/* it is guaranteed that overlay ids are assigned in sequence */
1423#define MAX_UNITTEST_OVERLAYS	256
1424static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)];
1425static int overlay_first_id = -1;
1426
1427static void of_unittest_track_overlay(int id)
1428{
1429	if (overlay_first_id < 0)
1430		overlay_first_id = id;
1431	id -= overlay_first_id;
1432
1433	/* we shouldn't need that many */
1434	BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1435	overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id);
1436}
1437
1438static void of_unittest_untrack_overlay(int id)
1439{
1440	if (overlay_first_id < 0)
1441		return;
1442	id -= overlay_first_id;
1443	BUG_ON(id >= MAX_UNITTEST_OVERLAYS);
1444	overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1445}
1446
1447static void of_unittest_destroy_tracked_overlays(void)
1448{
1449	int id, ret, defers, ovcs_id;
1450
1451	if (overlay_first_id < 0)
1452		return;
1453
1454	/* try until no defers */
1455	do {
1456		defers = 0;
1457		/* remove in reverse order */
1458		for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) {
1459			if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id)))
1460				continue;
1461
1462			ovcs_id = id + overlay_first_id;
1463			ret = of_overlay_remove(&ovcs_id);
1464			if (ret == -ENODEV) {
1465				pr_warn("%s: no overlay to destroy for #%d\n",
1466					__func__, id + overlay_first_id);
1467				continue;
1468			}
1469			if (ret != 0) {
1470				defers++;
1471				pr_warn("%s: overlay destroy failed for #%d\n",
1472					__func__, id + overlay_first_id);
1473				continue;
1474			}
1475
1476			overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id);
1477		}
1478	} while (defers > 0);
1479}
1480
1481static int __init of_unittest_apply_overlay(int overlay_nr, int *overlay_id)
 
1482{
1483	const char *overlay_name;
 
1484
1485	overlay_name = overlay_name_from_nr(overlay_nr);
 
 
 
 
 
 
1486
1487	if (!overlay_data_apply(overlay_name, overlay_id)) {
1488		unittest(0, "could not apply overlay \"%s\"\n",
1489				overlay_name);
1490		return -EFAULT;
 
1491	}
1492	of_unittest_track_overlay(*overlay_id);
 
 
 
1493
1494	return 0;
 
 
 
 
 
 
1495}
1496
1497/* apply an overlay while checking before and after states */
1498static int __init of_unittest_apply_overlay_check(int overlay_nr,
1499		int unittest_nr, int before, int after,
1500		enum overlay_type ovtype)
1501{
1502	int ret, ovcs_id;
1503
1504	/* unittest device must not be in before state */
1505	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1506		unittest(0, "%s with device @\"%s\" %s\n",
1507				overlay_name_from_nr(overlay_nr),
1508				unittest_path(unittest_nr, ovtype),
1509				!before ? "enabled" : "disabled");
1510		return -EINVAL;
1511	}
1512
1513	ovcs_id = 0;
1514	ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
1515	if (ret != 0) {
1516		/* of_unittest_apply_overlay already called unittest() */
1517		return ret;
1518	}
1519
1520	/* unittest device must be to set to after state */
1521	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1522		unittest(0, "%s failed to create @\"%s\" %s\n",
1523				overlay_name_from_nr(overlay_nr),
1524				unittest_path(unittest_nr, ovtype),
1525				!after ? "enabled" : "disabled");
1526		return -EINVAL;
1527	}
1528
1529	return 0;
1530}
1531
1532/* apply an overlay and then revert it while checking before, after states */
1533static int __init of_unittest_apply_revert_overlay_check(int overlay_nr,
1534		int unittest_nr, int before, int after,
1535		enum overlay_type ovtype)
1536{
1537	int ret, ovcs_id;
1538
1539	/* unittest device must be in before state */
1540	if (of_unittest_device_exists(unittest_nr, ovtype) != before) {
1541		unittest(0, "%s with device @\"%s\" %s\n",
1542				overlay_name_from_nr(overlay_nr),
1543				unittest_path(unittest_nr, ovtype),
1544				!before ? "enabled" : "disabled");
1545		return -EINVAL;
1546	}
1547
1548	/* apply the overlay */
1549	ovcs_id = 0;
1550	ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id);
1551	if (ret != 0) {
1552		/* of_unittest_apply_overlay already called unittest() */
1553		return ret;
1554	}
1555
1556	/* unittest device must be in after state */
1557	if (of_unittest_device_exists(unittest_nr, ovtype) != after) {
1558		unittest(0, "%s failed to create @\"%s\" %s\n",
1559				overlay_name_from_nr(overlay_nr),
1560				unittest_path(unittest_nr, ovtype),
1561				!after ? "enabled" : "disabled");
1562		return -EINVAL;
1563	}
1564
1565	ret = of_overlay_remove(&ovcs_id);
1566	if (ret != 0) {
1567		unittest(0, "%s failed to be destroyed @\"%s\"\n",
1568				overlay_name_from_nr(overlay_nr),
1569				unittest_path(unittest_nr, ovtype));
1570		return ret;
1571	}
1572
1573	/* unittest device must be again in before state */
1574	if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) {
1575		unittest(0, "%s with device @\"%s\" %s\n",
1576				overlay_name_from_nr(overlay_nr),
1577				unittest_path(unittest_nr, ovtype),
1578				!before ? "enabled" : "disabled");
1579		return -EINVAL;
1580	}
1581
1582	return 0;
1583}
1584
1585/* test activation of device */
1586static void __init of_unittest_overlay_0(void)
1587{
 
 
1588	/* device should enable */
1589	if (of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY))
 
1590		return;
1591
1592	unittest(1, "overlay test %d passed\n", 0);
1593}
1594
1595/* test deactivation of device */
1596static void __init of_unittest_overlay_1(void)
1597{
 
 
1598	/* device should disable */
1599	if (of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY))
 
1600		return;
1601
1602	unittest(1, "overlay test %d passed\n", 1);
1603}
1604
1605/* test activation of device */
1606static void __init of_unittest_overlay_2(void)
1607{
 
 
1608	/* device should enable */
1609	if (of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY))
 
1610		return;
1611
1612	unittest(1, "overlay test %d passed\n", 2);
1613}
1614
1615/* test deactivation of device */
1616static void __init of_unittest_overlay_3(void)
1617{
 
 
1618	/* device should disable */
1619	if (of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY))
 
1620		return;
1621
1622	unittest(1, "overlay test %d passed\n", 3);
1623}
1624
1625/* test activation of a full device node */
1626static void __init of_unittest_overlay_4(void)
1627{
 
 
1628	/* device should disable */
1629	if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY))
 
1630		return;
1631
1632	unittest(1, "overlay test %d passed\n", 4);
1633}
1634
1635/* test overlay apply/revert sequence */
1636static void __init of_unittest_overlay_5(void)
1637{
 
 
1638	/* device should disable */
1639	if (of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY))
 
1640		return;
1641
1642	unittest(1, "overlay test %d passed\n", 5);
1643}
1644
1645/* test overlay application in sequence */
1646static void __init of_unittest_overlay_6(void)
1647{
1648	int i, ov_id[2], ovcs_id;
 
1649	int overlay_nr = 6, unittest_nr = 6;
1650	int before = 0, after = 1;
1651	const char *overlay_name;
1652
1653	/* unittest device must be in before state */
1654	for (i = 0; i < 2; i++) {
1655		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1656				!= before) {
1657			unittest(0, "%s with device @\"%s\" %s\n",
1658					overlay_name_from_nr(overlay_nr + i),
1659					unittest_path(unittest_nr + i,
1660						PDEV_OVERLAY),
1661					!before ? "enabled" : "disabled");
1662			return;
1663		}
1664	}
1665
1666	/* apply the overlays */
1667	for (i = 0; i < 2; i++) {
1668
1669		overlay_name = overlay_name_from_nr(overlay_nr + i);
 
 
 
 
 
1670
1671		if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1672			unittest(0, "could not apply overlay \"%s\"\n",
1673					overlay_name);
 
1674			return;
1675		}
1676		ov_id[i] = ovcs_id;
1677		of_unittest_track_overlay(ov_id[i]);
1678	}
1679
1680	for (i = 0; i < 2; i++) {
1681		/* unittest device must be in after state */
1682		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1683				!= after) {
1684			unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n",
1685					overlay_name_from_nr(overlay_nr + i),
1686					unittest_path(unittest_nr + i,
1687						PDEV_OVERLAY),
1688					!after ? "enabled" : "disabled");
1689			return;
1690		}
1691	}
1692
1693	for (i = 1; i >= 0; i--) {
1694		ovcs_id = ov_id[i];
1695		if (of_overlay_remove(&ovcs_id)) {
1696			unittest(0, "%s failed destroy @\"%s\"\n",
1697					overlay_name_from_nr(overlay_nr + i),
1698					unittest_path(unittest_nr + i,
1699						PDEV_OVERLAY));
1700			return;
1701		}
1702		of_unittest_untrack_overlay(ov_id[i]);
1703	}
1704
1705	for (i = 0; i < 2; i++) {
1706		/* unittest device must be again in before state */
1707		if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY)
1708				!= before) {
1709			unittest(0, "%s with device @\"%s\" %s\n",
1710					overlay_name_from_nr(overlay_nr + i),
1711					unittest_path(unittest_nr + i,
1712						PDEV_OVERLAY),
1713					!before ? "enabled" : "disabled");
1714			return;
1715		}
1716	}
1717
1718	unittest(1, "overlay test %d passed\n", 6);
1719}
1720
1721/* test overlay application in sequence */
1722static void __init of_unittest_overlay_8(void)
1723{
1724	int i, ov_id[2], ovcs_id;
 
1725	int overlay_nr = 8, unittest_nr = 8;
1726	const char *overlay_name;
1727
1728	/* we don't care about device state in this test */
1729
1730	/* apply the overlays */
1731	for (i = 0; i < 2; i++) {
1732
1733		overlay_name = overlay_name_from_nr(overlay_nr + i);
 
 
 
 
 
1734
1735		if (!overlay_data_apply(overlay_name, &ovcs_id)) {
1736			unittest(0, "could not apply overlay \"%s\"\n",
1737					overlay_name);
 
1738			return;
1739		}
1740		ov_id[i] = ovcs_id;
1741		of_unittest_track_overlay(ov_id[i]);
1742	}
1743
1744	/* now try to remove first overlay (it should fail) */
1745	ovcs_id = ov_id[0];
1746	if (!of_overlay_remove(&ovcs_id)) {
1747		unittest(0, "%s was destroyed @\"%s\"\n",
1748				overlay_name_from_nr(overlay_nr + 0),
1749				unittest_path(unittest_nr,
1750					PDEV_OVERLAY));
1751		return;
1752	}
1753
1754	/* removing them in order should work */
1755	for (i = 1; i >= 0; i--) {
1756		ovcs_id = ov_id[i];
1757		if (of_overlay_remove(&ovcs_id)) {
1758			unittest(0, "%s not destroyed @\"%s\"\n",
1759					overlay_name_from_nr(overlay_nr + i),
1760					unittest_path(unittest_nr,
1761						PDEV_OVERLAY));
1762			return;
1763		}
1764		of_unittest_untrack_overlay(ov_id[i]);
1765	}
1766
1767	unittest(1, "overlay test %d passed\n", 8);
1768}
1769
1770/* test insertion of a bus with parent devices */
1771static void __init of_unittest_overlay_10(void)
1772{
1773	int ret;
1774	char *child_path;
1775
1776	/* device should disable */
1777	ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY);
1778	if (unittest(ret == 0,
1779			"overlay test %d failed; overlay application\n", 10))
1780		return;
1781
1782	child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101",
1783			unittest_path(10, PDEV_OVERLAY));
1784	if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10))
1785		return;
1786
1787	ret = of_path_device_type_exists(child_path, PDEV_OVERLAY);
1788	kfree(child_path);
1789
1790	unittest(ret, "overlay test %d failed; no child device\n", 10);
1791}
1792
1793/* test insertion of a bus with parent devices (and revert) */
1794static void __init of_unittest_overlay_11(void)
1795{
1796	int ret;
1797
1798	/* device should disable */
1799	ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1,
1800			PDEV_OVERLAY);
1801	unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11);
 
 
1802}
1803
1804#if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY)
1805
1806struct unittest_i2c_bus_data {
1807	struct platform_device	*pdev;
1808	struct i2c_adapter	adap;
1809};
1810
1811static int unittest_i2c_master_xfer(struct i2c_adapter *adap,
1812		struct i2c_msg *msgs, int num)
1813{
1814	struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap);
1815
1816	(void)std;
1817
1818	return num;
1819}
1820
1821static u32 unittest_i2c_functionality(struct i2c_adapter *adap)
1822{
1823	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
1824}
1825
1826static const struct i2c_algorithm unittest_i2c_algo = {
1827	.master_xfer	= unittest_i2c_master_xfer,
1828	.functionality	= unittest_i2c_functionality,
1829};
1830
1831static int unittest_i2c_bus_probe(struct platform_device *pdev)
1832{
1833	struct device *dev = &pdev->dev;
1834	struct device_node *np = dev->of_node;
1835	struct unittest_i2c_bus_data *std;
1836	struct i2c_adapter *adap;
1837	int ret;
1838
1839	if (np == NULL) {
1840		dev_err(dev, "No OF data for device\n");
1841		return -EINVAL;
1842
1843	}
1844
1845	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1846
1847	std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL);
1848	if (!std)
 
1849		return -ENOMEM;
 
1850
1851	/* link them together */
1852	std->pdev = pdev;
1853	platform_set_drvdata(pdev, std);
1854
1855	adap = &std->adap;
1856	i2c_set_adapdata(adap, std);
1857	adap->nr = -1;
1858	strlcpy(adap->name, pdev->name, sizeof(adap->name));
1859	adap->class = I2C_CLASS_DEPRECATED;
1860	adap->algo = &unittest_i2c_algo;
1861	adap->dev.parent = dev;
1862	adap->dev.of_node = dev->of_node;
1863	adap->timeout = 5 * HZ;
1864	adap->retries = 3;
1865
1866	ret = i2c_add_numbered_adapter(adap);
1867	if (ret != 0) {
1868		dev_err(dev, "Failed to add I2C adapter\n");
1869		return ret;
1870	}
1871
1872	return 0;
1873}
1874
1875static int unittest_i2c_bus_remove(struct platform_device *pdev)
1876{
1877	struct device *dev = &pdev->dev;
1878	struct device_node *np = dev->of_node;
1879	struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev);
1880
1881	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1882	i2c_del_adapter(&std->adap);
1883
1884	return 0;
1885}
1886
1887static const struct of_device_id unittest_i2c_bus_match[] = {
1888	{ .compatible = "unittest-i2c-bus", },
1889	{},
1890};
1891
1892static struct platform_driver unittest_i2c_bus_driver = {
1893	.probe			= unittest_i2c_bus_probe,
1894	.remove			= unittest_i2c_bus_remove,
1895	.driver = {
1896		.name		= "unittest-i2c-bus",
1897		.of_match_table	= of_match_ptr(unittest_i2c_bus_match),
1898	},
1899};
1900
1901static int unittest_i2c_dev_probe(struct i2c_client *client,
1902		const struct i2c_device_id *id)
1903{
1904	struct device *dev = &client->dev;
1905	struct device_node *np = client->dev.of_node;
1906
1907	if (!np) {
1908		dev_err(dev, "No OF node\n");
1909		return -EINVAL;
1910	}
1911
1912	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1913
1914	return 0;
1915};
1916
1917static int unittest_i2c_dev_remove(struct i2c_client *client)
1918{
1919	struct device *dev = &client->dev;
1920	struct device_node *np = client->dev.of_node;
1921
1922	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1923	return 0;
1924}
1925
1926static const struct i2c_device_id unittest_i2c_dev_id[] = {
1927	{ .name = "unittest-i2c-dev" },
1928	{ }
1929};
1930
1931static struct i2c_driver unittest_i2c_dev_driver = {
1932	.driver = {
1933		.name = "unittest-i2c-dev",
1934	},
1935	.probe = unittest_i2c_dev_probe,
1936	.remove = unittest_i2c_dev_remove,
1937	.id_table = unittest_i2c_dev_id,
1938};
1939
1940#if IS_BUILTIN(CONFIG_I2C_MUX)
1941
1942static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan)
 
 
 
 
 
 
1943{
1944	return 0;
1945}
1946
1947static int unittest_i2c_mux_probe(struct i2c_client *client,
1948		const struct i2c_device_id *id)
1949{
1950	int i, nchans;
1951	struct device *dev = &client->dev;
1952	struct i2c_adapter *adap = client->adapter;
1953	struct device_node *np = client->dev.of_node, *child;
1954	struct i2c_mux_core *muxc;
1955	u32 reg, max_reg;
1956
1957	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
1958
1959	if (!np) {
1960		dev_err(dev, "No OF node\n");
1961		return -EINVAL;
1962	}
1963
1964	max_reg = (u32)-1;
1965	for_each_child_of_node(np, child) {
1966		if (of_property_read_u32(child, "reg", &reg))
 
1967			continue;
1968		if (max_reg == (u32)-1 || reg > max_reg)
1969			max_reg = reg;
1970	}
1971	nchans = max_reg == (u32)-1 ? 0 : max_reg + 1;
1972	if (nchans == 0) {
1973		dev_err(dev, "No channels\n");
1974		return -EINVAL;
1975	}
1976
1977	muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0,
1978			     unittest_i2c_mux_select_chan, NULL);
1979	if (!muxc)
 
1980		return -ENOMEM;
 
 
1981	for (i = 0; i < nchans; i++) {
1982		if (i2c_mux_add_adapter(muxc, 0, i, 0)) {
 
 
1983			dev_err(dev, "Failed to register mux #%d\n", i);
1984			i2c_mux_del_adapters(muxc);
 
1985			return -ENODEV;
1986		}
1987	}
1988
1989	i2c_set_clientdata(client, muxc);
1990
1991	return 0;
1992};
1993
1994static int unittest_i2c_mux_remove(struct i2c_client *client)
1995{
1996	struct device *dev = &client->dev;
1997	struct device_node *np = client->dev.of_node;
1998	struct i2c_mux_core *muxc = i2c_get_clientdata(client);
 
1999
2000	dev_dbg(dev, "%s for node @%pOF\n", __func__, np);
2001	i2c_mux_del_adapters(muxc);
 
2002	return 0;
2003}
2004
2005static const struct i2c_device_id unittest_i2c_mux_id[] = {
2006	{ .name = "unittest-i2c-mux" },
2007	{ }
2008};
2009
2010static struct i2c_driver unittest_i2c_mux_driver = {
2011	.driver = {
2012		.name = "unittest-i2c-mux",
2013	},
2014	.probe = unittest_i2c_mux_probe,
2015	.remove = unittest_i2c_mux_remove,
2016	.id_table = unittest_i2c_mux_id,
2017};
2018
2019#endif
2020
2021static int of_unittest_overlay_i2c_init(void)
2022{
2023	int ret;
2024
2025	ret = i2c_add_driver(&unittest_i2c_dev_driver);
2026	if (unittest(ret == 0,
2027			"could not register unittest i2c device driver\n"))
2028		return ret;
2029
2030	ret = platform_driver_register(&unittest_i2c_bus_driver);
2031	if (unittest(ret == 0,
2032			"could not register unittest i2c bus driver\n"))
2033		return ret;
2034
2035#if IS_BUILTIN(CONFIG_I2C_MUX)
2036	ret = i2c_add_driver(&unittest_i2c_mux_driver);
2037	if (unittest(ret == 0,
2038			"could not register unittest i2c mux driver\n"))
2039		return ret;
2040#endif
2041
2042	return 0;
2043}
2044
2045static void of_unittest_overlay_i2c_cleanup(void)
2046{
2047#if IS_BUILTIN(CONFIG_I2C_MUX)
2048	i2c_del_driver(&unittest_i2c_mux_driver);
2049#endif
2050	platform_driver_unregister(&unittest_i2c_bus_driver);
2051	i2c_del_driver(&unittest_i2c_dev_driver);
2052}
2053
2054static void __init of_unittest_overlay_i2c_12(void)
2055{
 
 
2056	/* device should enable */
2057	if (of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY))
 
2058		return;
2059
2060	unittest(1, "overlay test %d passed\n", 12);
2061}
2062
2063/* test deactivation of device */
2064static void __init of_unittest_overlay_i2c_13(void)
2065{
 
 
2066	/* device should disable */
2067	if (of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY))
 
2068		return;
2069
2070	unittest(1, "overlay test %d passed\n", 13);
2071}
2072
2073/* just check for i2c mux existence */
2074static void of_unittest_overlay_i2c_14(void)
2075{
2076}
2077
2078static void __init of_unittest_overlay_i2c_15(void)
2079{
 
 
2080	/* device should enable */
2081	if (of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY))
 
2082		return;
2083
2084	unittest(1, "overlay test %d passed\n", 15);
2085}
2086
2087#else
2088
2089static inline void of_unittest_overlay_i2c_14(void) { }
2090static inline void of_unittest_overlay_i2c_15(void) { }
2091
2092#endif
2093
2094static void __init of_unittest_overlay(void)
2095{
2096	struct device_node *bus_np = NULL;
 
2097
2098	if (platform_driver_register(&unittest_driver)) {
 
2099		unittest(0, "could not register unittest driver\n");
2100		goto out;
2101	}
2102
2103	bus_np = of_find_node_by_path(bus_path);
2104	if (bus_np == NULL) {
2105		unittest(0, "could not find bus_path \"%s\"\n", bus_path);
2106		goto out;
2107	}
2108
2109	if (of_platform_default_populate(bus_np, NULL, NULL)) {
 
 
2110		unittest(0, "could not populate bus @ \"%s\"\n", bus_path);
2111		goto out;
2112	}
2113
2114	if (!of_unittest_device_exists(100, PDEV_OVERLAY)) {
2115		unittest(0, "could not find unittest0 @ \"%s\"\n",
2116				unittest_path(100, PDEV_OVERLAY));
2117		goto out;
2118	}
2119
2120	if (of_unittest_device_exists(101, PDEV_OVERLAY)) {
2121		unittest(0, "unittest1 @ \"%s\" should not exist\n",
2122				unittest_path(101, PDEV_OVERLAY));
2123		goto out;
2124	}
2125
2126	unittest(1, "basic infrastructure of overlays passed");
2127
2128	/* tests in sequence */
2129	of_unittest_overlay_0();
2130	of_unittest_overlay_1();
2131	of_unittest_overlay_2();
2132	of_unittest_overlay_3();
2133	of_unittest_overlay_4();
2134	of_unittest_overlay_5();
2135	of_unittest_overlay_6();
2136	of_unittest_overlay_8();
2137
2138	of_unittest_overlay_10();
2139	of_unittest_overlay_11();
2140
2141#if IS_BUILTIN(CONFIG_I2C)
2142	if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n"))
2143		goto out;
2144
2145	of_unittest_overlay_i2c_12();
2146	of_unittest_overlay_i2c_13();
2147	of_unittest_overlay_i2c_14();
2148	of_unittest_overlay_i2c_15();
2149
2150	of_unittest_overlay_i2c_cleanup();
2151#endif
2152
2153	of_unittest_destroy_tracked_overlays();
2154
2155out:
2156	of_node_put(bus_np);
2157}
2158
2159#else
2160static inline void __init of_unittest_overlay(void) { }
2161#endif
2162
2163#ifdef CONFIG_OF_OVERLAY
2164
2165/*
2166 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb
2167 * in scripts/Makefile.lib
2168 */
2169
2170#define OVERLAY_INFO_EXTERN(name) \
2171	extern uint8_t __dtb_##name##_begin[]; \
2172	extern uint8_t __dtb_##name##_end[]
2173
2174#define OVERLAY_INFO(overlay_name, expected)             \
2175{	.dtb_begin       = __dtb_##overlay_name##_begin, \
2176	.dtb_end         = __dtb_##overlay_name##_end,   \
2177	.expected_result = expected,                     \
2178	.name            = #overlay_name,                \
2179}
2180
2181struct overlay_info {
2182	uint8_t		*dtb_begin;
2183	uint8_t		*dtb_end;
2184	int		expected_result;
2185	int		overlay_id;
2186	char		*name;
2187};
2188
2189OVERLAY_INFO_EXTERN(overlay_base);
2190OVERLAY_INFO_EXTERN(overlay);
2191OVERLAY_INFO_EXTERN(overlay_0);
2192OVERLAY_INFO_EXTERN(overlay_1);
2193OVERLAY_INFO_EXTERN(overlay_2);
2194OVERLAY_INFO_EXTERN(overlay_3);
2195OVERLAY_INFO_EXTERN(overlay_4);
2196OVERLAY_INFO_EXTERN(overlay_5);
2197OVERLAY_INFO_EXTERN(overlay_6);
2198OVERLAY_INFO_EXTERN(overlay_7);
2199OVERLAY_INFO_EXTERN(overlay_8);
2200OVERLAY_INFO_EXTERN(overlay_9);
2201OVERLAY_INFO_EXTERN(overlay_10);
2202OVERLAY_INFO_EXTERN(overlay_11);
2203OVERLAY_INFO_EXTERN(overlay_12);
2204OVERLAY_INFO_EXTERN(overlay_13);
2205OVERLAY_INFO_EXTERN(overlay_15);
2206OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node);
2207OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop);
2208OVERLAY_INFO_EXTERN(overlay_bad_phandle);
2209OVERLAY_INFO_EXTERN(overlay_bad_symbol);
2210
2211/* entries found by name */
2212static struct overlay_info overlays[] = {
2213	OVERLAY_INFO(overlay_base, -9999),
2214	OVERLAY_INFO(overlay, 0),
2215	OVERLAY_INFO(overlay_0, 0),
2216	OVERLAY_INFO(overlay_1, 0),
2217	OVERLAY_INFO(overlay_2, 0),
2218	OVERLAY_INFO(overlay_3, 0),
2219	OVERLAY_INFO(overlay_4, 0),
2220	OVERLAY_INFO(overlay_5, 0),
2221	OVERLAY_INFO(overlay_6, 0),
2222	OVERLAY_INFO(overlay_7, 0),
2223	OVERLAY_INFO(overlay_8, 0),
2224	OVERLAY_INFO(overlay_9, 0),
2225	OVERLAY_INFO(overlay_10, 0),
2226	OVERLAY_INFO(overlay_11, 0),
2227	OVERLAY_INFO(overlay_12, 0),
2228	OVERLAY_INFO(overlay_13, 0),
2229	OVERLAY_INFO(overlay_15, 0),
2230	OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL),
2231	OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL),
2232	OVERLAY_INFO(overlay_bad_phandle, -EINVAL),
2233	OVERLAY_INFO(overlay_bad_symbol, -EINVAL),
2234	/* end marker */
2235	{.dtb_begin = NULL, .dtb_end = NULL, .expected_result = 0, .name = NULL}
2236};
2237
2238static struct device_node *overlay_base_root;
2239
2240static void * __init dt_alloc_memory(u64 size, u64 align)
2241{
2242	void *ptr = memblock_alloc(size, align);
2243
2244	if (!ptr)
2245		panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
2246		      __func__, size, align);
2247
2248	return ptr;
2249}
2250
2251/*
2252 * Create base device tree for the overlay unittest.
2253 *
2254 * This is called from very early boot code.
2255 *
2256 * Do as much as possible the same way as done in __unflatten_device_tree
2257 * and other early boot steps for the normal FDT so that the overlay base
2258 * unflattened tree will have the same characteristics as the real tree
2259 * (such as having memory allocated by the early allocator).  The goal
2260 * is to test "the real thing" as much as possible, and test "test setup
2261 * code" as little as possible.
2262 *
2263 * Have to stop before resolving phandles, because that uses kmalloc.
2264 */
2265void __init unittest_unflatten_overlay_base(void)
2266{
2267	struct overlay_info *info;
2268	u32 data_size;
2269	void *new_fdt;
2270	u32 size;
2271	int found = 0;
2272	const char *overlay_name = "overlay_base";
2273
2274	for (info = overlays; info && info->name; info++) {
2275		if (!strcmp(overlay_name, info->name)) {
2276			found = 1;
2277			break;
2278		}
2279	}
2280	if (!found) {
2281		pr_err("no overlay data for %s\n", overlay_name);
2282		return;
2283	}
2284
2285	info = &overlays[0];
2286
2287	if (info->expected_result != -9999) {
2288		pr_err("No dtb 'overlay_base' to attach\n");
2289		return;
2290	}
2291
2292	data_size = info->dtb_end - info->dtb_begin;
2293	if (!data_size) {
2294		pr_err("No dtb 'overlay_base' to attach\n");
2295		return;
2296	}
2297
2298	size = fdt_totalsize(info->dtb_begin);
2299	if (size != data_size) {
2300		pr_err("dtb 'overlay_base' header totalsize != actual size");
2301		return;
2302	}
2303
2304	new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE));
2305	if (!new_fdt) {
2306		pr_err("alloc for dtb 'overlay_base' failed");
2307		return;
2308	}
2309
2310	memcpy(new_fdt, info->dtb_begin, size);
2311
2312	__unflatten_device_tree(new_fdt, NULL, &overlay_base_root,
2313				dt_alloc_memory, true);
2314}
2315
2316/*
2317 * The purpose of of_unittest_overlay_data_add is to add an
2318 * overlay in the normal fashion.  This is a test of the whole
2319 * picture, instead of testing individual elements.
2320 *
2321 * A secondary purpose is to be able to verify that the contents of
2322 * /proc/device-tree/ contains the updated structure and values from
2323 * the overlay.  That must be verified separately in user space.
2324 *
2325 * Return 0 on unexpected error.
2326 */
2327static int __init overlay_data_apply(const char *overlay_name, int *overlay_id)
2328{
2329	struct overlay_info *info;
2330	int found = 0;
2331	int ret;
2332	u32 size;
2333
2334	for (info = overlays; info && info->name; info++) {
2335		if (!strcmp(overlay_name, info->name)) {
2336			found = 1;
2337			break;
2338		}
2339	}
2340	if (!found) {
2341		pr_err("no overlay data for %s\n", overlay_name);
2342		return 0;
2343	}
2344
2345	size = info->dtb_end - info->dtb_begin;
2346	if (!size)
2347		pr_err("no overlay data for %s\n", overlay_name);
2348
2349	ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id);
2350	if (overlay_id)
2351		*overlay_id = info->overlay_id;
2352	if (ret < 0)
2353		goto out;
2354
2355	pr_debug("%s applied\n", overlay_name);
2356
2357out:
2358	if (ret != info->expected_result)
2359		pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n",
2360		       info->expected_result, ret, overlay_name);
2361
2362	return (ret == info->expected_result);
2363}
2364
2365/*
2366 * The purpose of of_unittest_overlay_high_level is to add an overlay
2367 * in the normal fashion.  This is a test of the whole picture,
2368 * instead of individual elements.
2369 *
2370 * The first part of the function is _not_ normal overlay usage; it is
2371 * finishing splicing the base overlay device tree into the live tree.
2372 */
2373static __init void of_unittest_overlay_high_level(void)
2374{
2375	struct device_node *last_sibling;
2376	struct device_node *np;
2377	struct device_node *of_symbols;
2378	struct device_node *overlay_base_symbols;
2379	struct device_node **pprev;
2380	struct property *prop;
2381
2382	if (!overlay_base_root) {
2383		unittest(0, "overlay_base_root not initialized\n");
2384		return;
2385	}
2386
2387	/*
2388	 * Could not fixup phandles in unittest_unflatten_overlay_base()
2389	 * because kmalloc() was not yet available.
2390	 */
2391	of_overlay_mutex_lock();
2392	of_resolve_phandles(overlay_base_root);
2393	of_overlay_mutex_unlock();
2394
2395
2396	/*
2397	 * do not allow overlay_base to duplicate any node already in
2398	 * tree, this greatly simplifies the code
2399	 */
2400
2401	/*
2402	 * remove overlay_base_root node "__local_fixups", after
2403	 * being used by of_resolve_phandles()
2404	 */
2405	pprev = &overlay_base_root->child;
2406	for (np = overlay_base_root->child; np; np = np->sibling) {
2407		if (of_node_name_eq(np, "__local_fixups__")) {
2408			*pprev = np->sibling;
2409			break;
2410		}
2411		pprev = &np->sibling;
2412	}
2413
2414	/* remove overlay_base_root node "__symbols__" if in live tree */
2415	of_symbols = of_get_child_by_name(of_root, "__symbols__");
2416	if (of_symbols) {
2417		/* will have to graft properties from node into live tree */
2418		pprev = &overlay_base_root->child;
2419		for (np = overlay_base_root->child; np; np = np->sibling) {
2420			if (of_node_name_eq(np, "__symbols__")) {
2421				overlay_base_symbols = np;
2422				*pprev = np->sibling;
2423				break;
2424			}
2425			pprev = &np->sibling;
2426		}
2427	}
2428
2429	for_each_child_of_node(overlay_base_root, np) {
2430		struct device_node *base_child;
2431		for_each_child_of_node(of_root, base_child) {
2432			if (!strcmp(np->full_name, base_child->full_name)) {
2433				unittest(0, "illegal node name in overlay_base %pOFn",
2434					 np);
2435				return;
2436			}
2437		}
2438	}
2439
2440	/*
2441	 * overlay 'overlay_base' is not allowed to have root
2442	 * properties, so only need to splice nodes into main device tree.
2443	 *
2444	 * root node of *overlay_base_root will not be freed, it is lost
2445	 * memory.
2446	 */
2447
2448	for (np = overlay_base_root->child; np; np = np->sibling)
2449		np->parent = of_root;
2450
2451	mutex_lock(&of_mutex);
2452
2453	for (last_sibling = np = of_root->child; np; np = np->sibling)
2454		last_sibling = np;
2455
2456	if (last_sibling)
2457		last_sibling->sibling = overlay_base_root->child;
2458	else
2459		of_root->child = overlay_base_root->child;
2460
2461	for_each_of_allnodes_from(overlay_base_root, np)
2462		__of_attach_node_sysfs(np);
2463
2464	if (of_symbols) {
2465		struct property *new_prop;
2466		for_each_property_of_node(overlay_base_symbols, prop) {
2467
2468			new_prop = __of_prop_dup(prop, GFP_KERNEL);
2469			if (!new_prop) {
2470				unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__",
2471					 prop->name);
2472				goto err_unlock;
2473			}
2474			if (__of_add_property(of_symbols, new_prop)) {
2475				/* "name" auto-generated by unflatten */
2476				if (!strcmp(new_prop->name, "name"))
2477					continue;
2478				unittest(0, "duplicate property '%s' in overlay_base node __symbols__",
2479					 prop->name);
2480				goto err_unlock;
2481			}
2482			if (__of_add_property_sysfs(of_symbols, new_prop)) {
2483				unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs",
2484					 prop->name);
2485				goto err_unlock;
2486			}
2487		}
2488	}
2489
2490	mutex_unlock(&of_mutex);
2491
2492
2493	/* now do the normal overlay usage test */
2494
2495	unittest(overlay_data_apply("overlay", NULL),
2496		 "Adding overlay 'overlay' failed\n");
2497
2498	unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL),
2499		 "Adding overlay 'overlay_bad_add_dup_node' failed\n");
2500
2501	unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL),
2502		 "Adding overlay 'overlay_bad_add_dup_prop' failed\n");
2503
2504	unittest(overlay_data_apply("overlay_bad_phandle", NULL),
2505		 "Adding overlay 'overlay_bad_phandle' failed\n");
2506
2507	unittest(overlay_data_apply("overlay_bad_symbol", NULL),
2508		 "Adding overlay 'overlay_bad_symbol' failed\n");
2509
2510	return;
2511
2512err_unlock:
2513	mutex_unlock(&of_mutex);
2514}
2515
2516#else
2517
2518static inline __init void of_unittest_overlay_high_level(void) {}
2519
2520#endif
2521
2522static int __init of_unittest(void)
2523{
2524	struct device_node *np;
2525	int res;
2526
2527	/* adding data for unittest */
2528
2529	if (IS_ENABLED(CONFIG_UML))
2530		unittest_unflatten_overlay_base();
2531
2532	res = unittest_data_add();
2533	if (res)
2534		return res;
2535	if (!of_aliases)
2536		of_aliases = of_find_node_by_path("/aliases");
2537
2538	np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
2539	if (!np) {
2540		pr_info("No testcase data in device tree; not running tests\n");
2541		return 0;
2542	}
2543	of_node_put(np);
2544
2545	pr_info("start of unittest - you will see error messages\n");
2546	of_unittest_check_tree_linkage();
2547	of_unittest_check_phandles();
2548	of_unittest_find_node_by_name();
2549	of_unittest_dynamic();
2550	of_unittest_parse_phandle_with_args();
2551	of_unittest_parse_phandle_with_args_map();
2552	of_unittest_printf();
2553	of_unittest_property_string();
2554	of_unittest_property_copy();
2555	of_unittest_changeset();
2556	of_unittest_parse_interrupts();
2557	of_unittest_parse_interrupts_extended();
2558	of_unittest_match_node();
2559	of_unittest_platform_populate();
2560	of_unittest_overlay();
2561
2562	/* Double check linkage after removing testcase data */
2563	of_unittest_check_tree_linkage();
2564
2565	of_unittest_overlay_high_level();
2566
2567	pr_info("end of unittest - %i passed, %i failed\n",
2568		unittest_results.passed, unittest_results.failed);
2569
2570	return 0;
2571}
2572late_initcall(of_unittest);