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