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