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