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