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