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 (WARN_ON(!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 1203 if (!unittest_data) { 1204 pr_warn("%s: Failed to allocate memory for unittest_data; " 1205 "not running tests\n", __func__); 1206 return -ENOMEM; 1207 } 1208 of_fdt_unflatten_tree(unittest_data, NULL, &unittest_data_node); 1209 if (!unittest_data_node) { 1210 pr_warn("%s: No tree to attach; not running tests\n", __func__); 1211 return -ENODATA; 1212 } 1213 1214 /* 1215 * This lock normally encloses of_resolve_phandles() 1216 */ 1217 of_overlay_mutex_lock(); 1218 1219 rc = of_resolve_phandles(unittest_data_node); 1220 if (rc) { 1221 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc); 1222 of_overlay_mutex_unlock(); 1223 return -EINVAL; 1224 } 1225 1226 if (!of_root) { 1227 of_root = unittest_data_node; 1228 for_each_of_allnodes(np) 1229 __of_attach_node_sysfs(np); 1230 of_aliases = of_find_node_by_path("/aliases"); 1231 of_chosen = of_find_node_by_path("/chosen"); 1232 of_overlay_mutex_unlock(); 1233 return 0; 1234 } 1235 1236 /* attach the sub-tree to live tree */ 1237 np = unittest_data_node->child; 1238 while (np) { 1239 struct device_node *next = np->sibling; 1240 1241 np->parent = of_root; 1242 attach_node_and_children(np); 1243 np = next; 1244 } 1245 1246 of_overlay_mutex_unlock(); 1247 1248 return 0; 1249 } 1250 1251 #ifdef CONFIG_OF_OVERLAY 1252 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id); 1253 1254 static int unittest_probe(struct platform_device *pdev) 1255 { 1256 struct device *dev = &pdev->dev; 1257 struct device_node *np = dev->of_node; 1258 1259 if (np == NULL) { 1260 dev_err(dev, "No OF data for device\n"); 1261 return -EINVAL; 1262 1263 } 1264 1265 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 1266 1267 of_platform_populate(np, NULL, NULL, &pdev->dev); 1268 1269 return 0; 1270 } 1271 1272 static int unittest_remove(struct platform_device *pdev) 1273 { 1274 struct device *dev = &pdev->dev; 1275 struct device_node *np = dev->of_node; 1276 1277 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 1278 return 0; 1279 } 1280 1281 static const struct of_device_id unittest_match[] = { 1282 { .compatible = "unittest", }, 1283 {}, 1284 }; 1285 1286 static struct platform_driver unittest_driver = { 1287 .probe = unittest_probe, 1288 .remove = unittest_remove, 1289 .driver = { 1290 .name = "unittest", 1291 .of_match_table = of_match_ptr(unittest_match), 1292 }, 1293 }; 1294 1295 /* get the platform device instantiated at the path */ 1296 static struct platform_device *of_path_to_platform_device(const char *path) 1297 { 1298 struct device_node *np; 1299 struct platform_device *pdev; 1300 1301 np = of_find_node_by_path(path); 1302 if (np == NULL) 1303 return NULL; 1304 1305 pdev = of_find_device_by_node(np); 1306 of_node_put(np); 1307 1308 return pdev; 1309 } 1310 1311 /* find out if a platform device exists at that path */ 1312 static int of_path_platform_device_exists(const char *path) 1313 { 1314 struct platform_device *pdev; 1315 1316 pdev = of_path_to_platform_device(path); 1317 platform_device_put(pdev); 1318 return pdev != NULL; 1319 } 1320 1321 #if IS_BUILTIN(CONFIG_I2C) 1322 1323 /* get the i2c client device instantiated at the path */ 1324 static struct i2c_client *of_path_to_i2c_client(const char *path) 1325 { 1326 struct device_node *np; 1327 struct i2c_client *client; 1328 1329 np = of_find_node_by_path(path); 1330 if (np == NULL) 1331 return NULL; 1332 1333 client = of_find_i2c_device_by_node(np); 1334 of_node_put(np); 1335 1336 return client; 1337 } 1338 1339 /* find out if a i2c client device exists at that path */ 1340 static int of_path_i2c_client_exists(const char *path) 1341 { 1342 struct i2c_client *client; 1343 1344 client = of_path_to_i2c_client(path); 1345 if (client) 1346 put_device(&client->dev); 1347 return client != NULL; 1348 } 1349 #else 1350 static int of_path_i2c_client_exists(const char *path) 1351 { 1352 return 0; 1353 } 1354 #endif 1355 1356 enum overlay_type { 1357 PDEV_OVERLAY, 1358 I2C_OVERLAY 1359 }; 1360 1361 static int of_path_device_type_exists(const char *path, 1362 enum overlay_type ovtype) 1363 { 1364 switch (ovtype) { 1365 case PDEV_OVERLAY: 1366 return of_path_platform_device_exists(path); 1367 case I2C_OVERLAY: 1368 return of_path_i2c_client_exists(path); 1369 } 1370 return 0; 1371 } 1372 1373 static const char *unittest_path(int nr, enum overlay_type ovtype) 1374 { 1375 const char *base; 1376 static char buf[256]; 1377 1378 switch (ovtype) { 1379 case PDEV_OVERLAY: 1380 base = "/testcase-data/overlay-node/test-bus"; 1381 break; 1382 case I2C_OVERLAY: 1383 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus"; 1384 break; 1385 default: 1386 buf[0] = '\0'; 1387 return buf; 1388 } 1389 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr); 1390 buf[sizeof(buf) - 1] = '\0'; 1391 return buf; 1392 } 1393 1394 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype) 1395 { 1396 const char *path; 1397 1398 path = unittest_path(unittest_nr, ovtype); 1399 1400 switch (ovtype) { 1401 case PDEV_OVERLAY: 1402 return of_path_platform_device_exists(path); 1403 case I2C_OVERLAY: 1404 return of_path_i2c_client_exists(path); 1405 } 1406 return 0; 1407 } 1408 1409 static const char *overlay_name_from_nr(int nr) 1410 { 1411 static char buf[256]; 1412 1413 snprintf(buf, sizeof(buf) - 1, 1414 "overlay_%d", nr); 1415 buf[sizeof(buf) - 1] = '\0'; 1416 1417 return buf; 1418 } 1419 1420 static const char *bus_path = "/testcase-data/overlay-node/test-bus"; 1421 1422 /* it is guaranteed that overlay ids are assigned in sequence */ 1423 #define MAX_UNITTEST_OVERLAYS 256 1424 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)]; 1425 static int overlay_first_id = -1; 1426 1427 static void of_unittest_track_overlay(int id) 1428 { 1429 if (overlay_first_id < 0) 1430 overlay_first_id = id; 1431 id -= overlay_first_id; 1432 1433 /* we shouldn't need that many */ 1434 BUG_ON(id >= MAX_UNITTEST_OVERLAYS); 1435 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id); 1436 } 1437 1438 static void of_unittest_untrack_overlay(int id) 1439 { 1440 if (overlay_first_id < 0) 1441 return; 1442 id -= overlay_first_id; 1443 BUG_ON(id >= MAX_UNITTEST_OVERLAYS); 1444 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id); 1445 } 1446 1447 static void of_unittest_destroy_tracked_overlays(void) 1448 { 1449 int id, ret, defers, ovcs_id; 1450 1451 if (overlay_first_id < 0) 1452 return; 1453 1454 /* try until no defers */ 1455 do { 1456 defers = 0; 1457 /* remove in reverse order */ 1458 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) { 1459 if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id))) 1460 continue; 1461 1462 ovcs_id = id + overlay_first_id; 1463 ret = of_overlay_remove(&ovcs_id); 1464 if (ret == -ENODEV) { 1465 pr_warn("%s: no overlay to destroy for #%d\n", 1466 __func__, id + overlay_first_id); 1467 continue; 1468 } 1469 if (ret != 0) { 1470 defers++; 1471 pr_warn("%s: overlay destroy failed for #%d\n", 1472 __func__, id + overlay_first_id); 1473 continue; 1474 } 1475 1476 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id); 1477 } 1478 } while (defers > 0); 1479 } 1480 1481 static int __init of_unittest_apply_overlay(int overlay_nr, int *overlay_id) 1482 { 1483 const char *overlay_name; 1484 1485 overlay_name = overlay_name_from_nr(overlay_nr); 1486 1487 if (!overlay_data_apply(overlay_name, overlay_id)) { 1488 unittest(0, "could not apply overlay \"%s\"\n", 1489 overlay_name); 1490 return -EFAULT; 1491 } 1492 of_unittest_track_overlay(*overlay_id); 1493 1494 return 0; 1495 } 1496 1497 /* apply an overlay while checking before and after states */ 1498 static int __init of_unittest_apply_overlay_check(int overlay_nr, 1499 int unittest_nr, int before, int after, 1500 enum overlay_type ovtype) 1501 { 1502 int ret, ovcs_id; 1503 1504 /* unittest device must not be in before state */ 1505 if (of_unittest_device_exists(unittest_nr, ovtype) != before) { 1506 unittest(0, "%s with device @\"%s\" %s\n", 1507 overlay_name_from_nr(overlay_nr), 1508 unittest_path(unittest_nr, ovtype), 1509 !before ? "enabled" : "disabled"); 1510 return -EINVAL; 1511 } 1512 1513 ovcs_id = 0; 1514 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id); 1515 if (ret != 0) { 1516 /* of_unittest_apply_overlay already called unittest() */ 1517 return ret; 1518 } 1519 1520 /* unittest device must be to set to after state */ 1521 if (of_unittest_device_exists(unittest_nr, ovtype) != after) { 1522 unittest(0, "%s failed to create @\"%s\" %s\n", 1523 overlay_name_from_nr(overlay_nr), 1524 unittest_path(unittest_nr, ovtype), 1525 !after ? "enabled" : "disabled"); 1526 return -EINVAL; 1527 } 1528 1529 return 0; 1530 } 1531 1532 /* apply an overlay and then revert it while checking before, after states */ 1533 static int __init of_unittest_apply_revert_overlay_check(int overlay_nr, 1534 int unittest_nr, int before, int after, 1535 enum overlay_type ovtype) 1536 { 1537 int ret, ovcs_id; 1538 1539 /* unittest device must be in before state */ 1540 if (of_unittest_device_exists(unittest_nr, ovtype) != before) { 1541 unittest(0, "%s with device @\"%s\" %s\n", 1542 overlay_name_from_nr(overlay_nr), 1543 unittest_path(unittest_nr, ovtype), 1544 !before ? "enabled" : "disabled"); 1545 return -EINVAL; 1546 } 1547 1548 /* apply the overlay */ 1549 ovcs_id = 0; 1550 ret = of_unittest_apply_overlay(overlay_nr, &ovcs_id); 1551 if (ret != 0) { 1552 /* of_unittest_apply_overlay already called unittest() */ 1553 return ret; 1554 } 1555 1556 /* unittest device must be in after state */ 1557 if (of_unittest_device_exists(unittest_nr, ovtype) != after) { 1558 unittest(0, "%s failed to create @\"%s\" %s\n", 1559 overlay_name_from_nr(overlay_nr), 1560 unittest_path(unittest_nr, ovtype), 1561 !after ? "enabled" : "disabled"); 1562 return -EINVAL; 1563 } 1564 1565 ret = of_overlay_remove(&ovcs_id); 1566 if (ret != 0) { 1567 unittest(0, "%s failed to be destroyed @\"%s\"\n", 1568 overlay_name_from_nr(overlay_nr), 1569 unittest_path(unittest_nr, ovtype)); 1570 return ret; 1571 } 1572 1573 /* unittest device must be again in before state */ 1574 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) { 1575 unittest(0, "%s with device @\"%s\" %s\n", 1576 overlay_name_from_nr(overlay_nr), 1577 unittest_path(unittest_nr, ovtype), 1578 !before ? "enabled" : "disabled"); 1579 return -EINVAL; 1580 } 1581 1582 return 0; 1583 } 1584 1585 /* test activation of device */ 1586 static void __init of_unittest_overlay_0(void) 1587 { 1588 /* device should enable */ 1589 if (of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY)) 1590 return; 1591 1592 unittest(1, "overlay test %d passed\n", 0); 1593 } 1594 1595 /* test deactivation of device */ 1596 static void __init of_unittest_overlay_1(void) 1597 { 1598 /* device should disable */ 1599 if (of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY)) 1600 return; 1601 1602 unittest(1, "overlay test %d passed\n", 1); 1603 } 1604 1605 /* test activation of device */ 1606 static void __init of_unittest_overlay_2(void) 1607 { 1608 /* device should enable */ 1609 if (of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY)) 1610 return; 1611 1612 unittest(1, "overlay test %d passed\n", 2); 1613 } 1614 1615 /* test deactivation of device */ 1616 static void __init of_unittest_overlay_3(void) 1617 { 1618 /* device should disable */ 1619 if (of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY)) 1620 return; 1621 1622 unittest(1, "overlay test %d passed\n", 3); 1623 } 1624 1625 /* test activation of a full device node */ 1626 static void __init of_unittest_overlay_4(void) 1627 { 1628 /* device should disable */ 1629 if (of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY)) 1630 return; 1631 1632 unittest(1, "overlay test %d passed\n", 4); 1633 } 1634 1635 /* test overlay apply/revert sequence */ 1636 static void __init of_unittest_overlay_5(void) 1637 { 1638 /* device should disable */ 1639 if (of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY)) 1640 return; 1641 1642 unittest(1, "overlay test %d passed\n", 5); 1643 } 1644 1645 /* test overlay application in sequence */ 1646 static void __init of_unittest_overlay_6(void) 1647 { 1648 int i, ov_id[2], ovcs_id; 1649 int overlay_nr = 6, unittest_nr = 6; 1650 int before = 0, after = 1; 1651 const char *overlay_name; 1652 1653 /* unittest device must be in before state */ 1654 for (i = 0; i < 2; i++) { 1655 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY) 1656 != before) { 1657 unittest(0, "%s with device @\"%s\" %s\n", 1658 overlay_name_from_nr(overlay_nr + i), 1659 unittest_path(unittest_nr + i, 1660 PDEV_OVERLAY), 1661 !before ? "enabled" : "disabled"); 1662 return; 1663 } 1664 } 1665 1666 /* apply the overlays */ 1667 for (i = 0; i < 2; i++) { 1668 1669 overlay_name = overlay_name_from_nr(overlay_nr + i); 1670 1671 if (!overlay_data_apply(overlay_name, &ovcs_id)) { 1672 unittest(0, "could not apply overlay \"%s\"\n", 1673 overlay_name); 1674 return; 1675 } 1676 ov_id[i] = ovcs_id; 1677 of_unittest_track_overlay(ov_id[i]); 1678 } 1679 1680 for (i = 0; i < 2; i++) { 1681 /* unittest device must be in after state */ 1682 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY) 1683 != after) { 1684 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n", 1685 overlay_name_from_nr(overlay_nr + i), 1686 unittest_path(unittest_nr + i, 1687 PDEV_OVERLAY), 1688 !after ? "enabled" : "disabled"); 1689 return; 1690 } 1691 } 1692 1693 for (i = 1; i >= 0; i--) { 1694 ovcs_id = ov_id[i]; 1695 if (of_overlay_remove(&ovcs_id)) { 1696 unittest(0, "%s failed destroy @\"%s\"\n", 1697 overlay_name_from_nr(overlay_nr + i), 1698 unittest_path(unittest_nr + i, 1699 PDEV_OVERLAY)); 1700 return; 1701 } 1702 of_unittest_untrack_overlay(ov_id[i]); 1703 } 1704 1705 for (i = 0; i < 2; i++) { 1706 /* unittest device must be again in before state */ 1707 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY) 1708 != before) { 1709 unittest(0, "%s with device @\"%s\" %s\n", 1710 overlay_name_from_nr(overlay_nr + i), 1711 unittest_path(unittest_nr + i, 1712 PDEV_OVERLAY), 1713 !before ? "enabled" : "disabled"); 1714 return; 1715 } 1716 } 1717 1718 unittest(1, "overlay test %d passed\n", 6); 1719 } 1720 1721 /* test overlay application in sequence */ 1722 static void __init of_unittest_overlay_8(void) 1723 { 1724 int i, ov_id[2], ovcs_id; 1725 int overlay_nr = 8, unittest_nr = 8; 1726 const char *overlay_name; 1727 1728 /* we don't care about device state in this test */ 1729 1730 /* apply the overlays */ 1731 for (i = 0; i < 2; i++) { 1732 1733 overlay_name = overlay_name_from_nr(overlay_nr + i); 1734 1735 if (!overlay_data_apply(overlay_name, &ovcs_id)) { 1736 unittest(0, "could not apply overlay \"%s\"\n", 1737 overlay_name); 1738 return; 1739 } 1740 ov_id[i] = ovcs_id; 1741 of_unittest_track_overlay(ov_id[i]); 1742 } 1743 1744 /* now try to remove first overlay (it should fail) */ 1745 ovcs_id = ov_id[0]; 1746 if (!of_overlay_remove(&ovcs_id)) { 1747 unittest(0, "%s was destroyed @\"%s\"\n", 1748 overlay_name_from_nr(overlay_nr + 0), 1749 unittest_path(unittest_nr, 1750 PDEV_OVERLAY)); 1751 return; 1752 } 1753 1754 /* removing them in order should work */ 1755 for (i = 1; i >= 0; i--) { 1756 ovcs_id = ov_id[i]; 1757 if (of_overlay_remove(&ovcs_id)) { 1758 unittest(0, "%s not destroyed @\"%s\"\n", 1759 overlay_name_from_nr(overlay_nr + i), 1760 unittest_path(unittest_nr, 1761 PDEV_OVERLAY)); 1762 return; 1763 } 1764 of_unittest_untrack_overlay(ov_id[i]); 1765 } 1766 1767 unittest(1, "overlay test %d passed\n", 8); 1768 } 1769 1770 /* test insertion of a bus with parent devices */ 1771 static void __init of_unittest_overlay_10(void) 1772 { 1773 int ret; 1774 char *child_path; 1775 1776 /* device should disable */ 1777 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY); 1778 if (unittest(ret == 0, 1779 "overlay test %d failed; overlay application\n", 10)) 1780 return; 1781 1782 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101", 1783 unittest_path(10, PDEV_OVERLAY)); 1784 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10)) 1785 return; 1786 1787 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY); 1788 kfree(child_path); 1789 1790 unittest(ret, "overlay test %d failed; no child device\n", 10); 1791 } 1792 1793 /* test insertion of a bus with parent devices (and revert) */ 1794 static void __init of_unittest_overlay_11(void) 1795 { 1796 int ret; 1797 1798 /* device should disable */ 1799 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1, 1800 PDEV_OVERLAY); 1801 unittest(ret == 0, "overlay test %d failed; overlay apply\n", 11); 1802 } 1803 1804 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY) 1805 1806 struct unittest_i2c_bus_data { 1807 struct platform_device *pdev; 1808 struct i2c_adapter adap; 1809 }; 1810 1811 static int unittest_i2c_master_xfer(struct i2c_adapter *adap, 1812 struct i2c_msg *msgs, int num) 1813 { 1814 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap); 1815 1816 (void)std; 1817 1818 return num; 1819 } 1820 1821 static u32 unittest_i2c_functionality(struct i2c_adapter *adap) 1822 { 1823 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL; 1824 } 1825 1826 static const struct i2c_algorithm unittest_i2c_algo = { 1827 .master_xfer = unittest_i2c_master_xfer, 1828 .functionality = unittest_i2c_functionality, 1829 }; 1830 1831 static int unittest_i2c_bus_probe(struct platform_device *pdev) 1832 { 1833 struct device *dev = &pdev->dev; 1834 struct device_node *np = dev->of_node; 1835 struct unittest_i2c_bus_data *std; 1836 struct i2c_adapter *adap; 1837 int ret; 1838 1839 if (np == NULL) { 1840 dev_err(dev, "No OF data for device\n"); 1841 return -EINVAL; 1842 1843 } 1844 1845 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 1846 1847 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL); 1848 if (!std) { 1849 dev_err(dev, "Failed to allocate unittest i2c data\n"); 1850 return -ENOMEM; 1851 } 1852 1853 /* link them together */ 1854 std->pdev = pdev; 1855 platform_set_drvdata(pdev, std); 1856 1857 adap = &std->adap; 1858 i2c_set_adapdata(adap, std); 1859 adap->nr = -1; 1860 strlcpy(adap->name, pdev->name, sizeof(adap->name)); 1861 adap->class = I2C_CLASS_DEPRECATED; 1862 adap->algo = &unittest_i2c_algo; 1863 adap->dev.parent = dev; 1864 adap->dev.of_node = dev->of_node; 1865 adap->timeout = 5 * HZ; 1866 adap->retries = 3; 1867 1868 ret = i2c_add_numbered_adapter(adap); 1869 if (ret != 0) { 1870 dev_err(dev, "Failed to add I2C adapter\n"); 1871 return ret; 1872 } 1873 1874 return 0; 1875 } 1876 1877 static int unittest_i2c_bus_remove(struct platform_device *pdev) 1878 { 1879 struct device *dev = &pdev->dev; 1880 struct device_node *np = dev->of_node; 1881 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev); 1882 1883 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 1884 i2c_del_adapter(&std->adap); 1885 1886 return 0; 1887 } 1888 1889 static const struct of_device_id unittest_i2c_bus_match[] = { 1890 { .compatible = "unittest-i2c-bus", }, 1891 {}, 1892 }; 1893 1894 static struct platform_driver unittest_i2c_bus_driver = { 1895 .probe = unittest_i2c_bus_probe, 1896 .remove = unittest_i2c_bus_remove, 1897 .driver = { 1898 .name = "unittest-i2c-bus", 1899 .of_match_table = of_match_ptr(unittest_i2c_bus_match), 1900 }, 1901 }; 1902 1903 static int unittest_i2c_dev_probe(struct i2c_client *client, 1904 const struct i2c_device_id *id) 1905 { 1906 struct device *dev = &client->dev; 1907 struct device_node *np = client->dev.of_node; 1908 1909 if (!np) { 1910 dev_err(dev, "No OF node\n"); 1911 return -EINVAL; 1912 } 1913 1914 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 1915 1916 return 0; 1917 }; 1918 1919 static int unittest_i2c_dev_remove(struct i2c_client *client) 1920 { 1921 struct device *dev = &client->dev; 1922 struct device_node *np = client->dev.of_node; 1923 1924 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 1925 return 0; 1926 } 1927 1928 static const struct i2c_device_id unittest_i2c_dev_id[] = { 1929 { .name = "unittest-i2c-dev" }, 1930 { } 1931 }; 1932 1933 static struct i2c_driver unittest_i2c_dev_driver = { 1934 .driver = { 1935 .name = "unittest-i2c-dev", 1936 }, 1937 .probe = unittest_i2c_dev_probe, 1938 .remove = unittest_i2c_dev_remove, 1939 .id_table = unittest_i2c_dev_id, 1940 }; 1941 1942 #if IS_BUILTIN(CONFIG_I2C_MUX) 1943 1944 static int unittest_i2c_mux_select_chan(struct i2c_mux_core *muxc, u32 chan) 1945 { 1946 return 0; 1947 } 1948 1949 static int unittest_i2c_mux_probe(struct i2c_client *client, 1950 const struct i2c_device_id *id) 1951 { 1952 int i, nchans; 1953 struct device *dev = &client->dev; 1954 struct i2c_adapter *adap = to_i2c_adapter(dev->parent); 1955 struct device_node *np = client->dev.of_node, *child; 1956 struct i2c_mux_core *muxc; 1957 u32 reg, max_reg; 1958 1959 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 1960 1961 if (!np) { 1962 dev_err(dev, "No OF node\n"); 1963 return -EINVAL; 1964 } 1965 1966 max_reg = (u32)-1; 1967 for_each_child_of_node(np, child) { 1968 if (of_property_read_u32(child, "reg", ®)) 1969 continue; 1970 if (max_reg == (u32)-1 || reg > max_reg) 1971 max_reg = reg; 1972 } 1973 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1; 1974 if (nchans == 0) { 1975 dev_err(dev, "No channels\n"); 1976 return -EINVAL; 1977 } 1978 1979 muxc = i2c_mux_alloc(adap, dev, nchans, 0, 0, 1980 unittest_i2c_mux_select_chan, NULL); 1981 if (!muxc) 1982 return -ENOMEM; 1983 for (i = 0; i < nchans; i++) { 1984 if (i2c_mux_add_adapter(muxc, 0, i, 0)) { 1985 dev_err(dev, "Failed to register mux #%d\n", i); 1986 i2c_mux_del_adapters(muxc); 1987 return -ENODEV; 1988 } 1989 } 1990 1991 i2c_set_clientdata(client, muxc); 1992 1993 return 0; 1994 }; 1995 1996 static int unittest_i2c_mux_remove(struct i2c_client *client) 1997 { 1998 struct device *dev = &client->dev; 1999 struct device_node *np = client->dev.of_node; 2000 struct i2c_mux_core *muxc = i2c_get_clientdata(client); 2001 2002 dev_dbg(dev, "%s for node @%pOF\n", __func__, np); 2003 i2c_mux_del_adapters(muxc); 2004 return 0; 2005 } 2006 2007 static const struct i2c_device_id unittest_i2c_mux_id[] = { 2008 { .name = "unittest-i2c-mux" }, 2009 { } 2010 }; 2011 2012 static struct i2c_driver unittest_i2c_mux_driver = { 2013 .driver = { 2014 .name = "unittest-i2c-mux", 2015 }, 2016 .probe = unittest_i2c_mux_probe, 2017 .remove = unittest_i2c_mux_remove, 2018 .id_table = unittest_i2c_mux_id, 2019 }; 2020 2021 #endif 2022 2023 static int of_unittest_overlay_i2c_init(void) 2024 { 2025 int ret; 2026 2027 ret = i2c_add_driver(&unittest_i2c_dev_driver); 2028 if (unittest(ret == 0, 2029 "could not register unittest i2c device driver\n")) 2030 return ret; 2031 2032 ret = platform_driver_register(&unittest_i2c_bus_driver); 2033 if (unittest(ret == 0, 2034 "could not register unittest i2c bus driver\n")) 2035 return ret; 2036 2037 #if IS_BUILTIN(CONFIG_I2C_MUX) 2038 ret = i2c_add_driver(&unittest_i2c_mux_driver); 2039 if (unittest(ret == 0, 2040 "could not register unittest i2c mux driver\n")) 2041 return ret; 2042 #endif 2043 2044 return 0; 2045 } 2046 2047 static void of_unittest_overlay_i2c_cleanup(void) 2048 { 2049 #if IS_BUILTIN(CONFIG_I2C_MUX) 2050 i2c_del_driver(&unittest_i2c_mux_driver); 2051 #endif 2052 platform_driver_unregister(&unittest_i2c_bus_driver); 2053 i2c_del_driver(&unittest_i2c_dev_driver); 2054 } 2055 2056 static void __init of_unittest_overlay_i2c_12(void) 2057 { 2058 /* device should enable */ 2059 if (of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY)) 2060 return; 2061 2062 unittest(1, "overlay test %d passed\n", 12); 2063 } 2064 2065 /* test deactivation of device */ 2066 static void __init of_unittest_overlay_i2c_13(void) 2067 { 2068 /* device should disable */ 2069 if (of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY)) 2070 return; 2071 2072 unittest(1, "overlay test %d passed\n", 13); 2073 } 2074 2075 /* just check for i2c mux existence */ 2076 static void of_unittest_overlay_i2c_14(void) 2077 { 2078 } 2079 2080 static void __init of_unittest_overlay_i2c_15(void) 2081 { 2082 /* device should enable */ 2083 if (of_unittest_apply_overlay_check(15, 15, 0, 1, I2C_OVERLAY)) 2084 return; 2085 2086 unittest(1, "overlay test %d passed\n", 15); 2087 } 2088 2089 #else 2090 2091 static inline void of_unittest_overlay_i2c_14(void) { } 2092 static inline void of_unittest_overlay_i2c_15(void) { } 2093 2094 #endif 2095 2096 static void __init of_unittest_overlay(void) 2097 { 2098 struct device_node *bus_np = NULL; 2099 2100 if (platform_driver_register(&unittest_driver)) { 2101 unittest(0, "could not register unittest driver\n"); 2102 goto out; 2103 } 2104 2105 bus_np = of_find_node_by_path(bus_path); 2106 if (bus_np == NULL) { 2107 unittest(0, "could not find bus_path \"%s\"\n", bus_path); 2108 goto out; 2109 } 2110 2111 if (of_platform_default_populate(bus_np, NULL, NULL)) { 2112 unittest(0, "could not populate bus @ \"%s\"\n", bus_path); 2113 goto out; 2114 } 2115 2116 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) { 2117 unittest(0, "could not find unittest0 @ \"%s\"\n", 2118 unittest_path(100, PDEV_OVERLAY)); 2119 goto out; 2120 } 2121 2122 if (of_unittest_device_exists(101, PDEV_OVERLAY)) { 2123 unittest(0, "unittest1 @ \"%s\" should not exist\n", 2124 unittest_path(101, PDEV_OVERLAY)); 2125 goto out; 2126 } 2127 2128 unittest(1, "basic infrastructure of overlays passed"); 2129 2130 /* tests in sequence */ 2131 of_unittest_overlay_0(); 2132 of_unittest_overlay_1(); 2133 of_unittest_overlay_2(); 2134 of_unittest_overlay_3(); 2135 of_unittest_overlay_4(); 2136 of_unittest_overlay_5(); 2137 of_unittest_overlay_6(); 2138 of_unittest_overlay_8(); 2139 2140 of_unittest_overlay_10(); 2141 of_unittest_overlay_11(); 2142 2143 #if IS_BUILTIN(CONFIG_I2C) 2144 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n")) 2145 goto out; 2146 2147 of_unittest_overlay_i2c_12(); 2148 of_unittest_overlay_i2c_13(); 2149 of_unittest_overlay_i2c_14(); 2150 of_unittest_overlay_i2c_15(); 2151 2152 of_unittest_overlay_i2c_cleanup(); 2153 #endif 2154 2155 of_unittest_destroy_tracked_overlays(); 2156 2157 out: 2158 of_node_put(bus_np); 2159 } 2160 2161 #else 2162 static inline void __init of_unittest_overlay(void) { } 2163 #endif 2164 2165 #ifdef CONFIG_OF_OVERLAY 2166 2167 /* 2168 * __dtb_ot_begin[] and __dtb_ot_end[] are created by cmd_dt_S_dtb 2169 * in scripts/Makefile.lib 2170 */ 2171 2172 #define OVERLAY_INFO_EXTERN(name) \ 2173 extern uint8_t __dtb_##name##_begin[]; \ 2174 extern uint8_t __dtb_##name##_end[] 2175 2176 #define OVERLAY_INFO(overlay_name, expected) \ 2177 { .dtb_begin = __dtb_##overlay_name##_begin, \ 2178 .dtb_end = __dtb_##overlay_name##_end, \ 2179 .expected_result = expected, \ 2180 .name = #overlay_name, \ 2181 } 2182 2183 struct overlay_info { 2184 uint8_t *dtb_begin; 2185 uint8_t *dtb_end; 2186 int expected_result; 2187 int overlay_id; 2188 char *name; 2189 }; 2190 2191 OVERLAY_INFO_EXTERN(overlay_base); 2192 OVERLAY_INFO_EXTERN(overlay); 2193 OVERLAY_INFO_EXTERN(overlay_0); 2194 OVERLAY_INFO_EXTERN(overlay_1); 2195 OVERLAY_INFO_EXTERN(overlay_2); 2196 OVERLAY_INFO_EXTERN(overlay_3); 2197 OVERLAY_INFO_EXTERN(overlay_4); 2198 OVERLAY_INFO_EXTERN(overlay_5); 2199 OVERLAY_INFO_EXTERN(overlay_6); 2200 OVERLAY_INFO_EXTERN(overlay_7); 2201 OVERLAY_INFO_EXTERN(overlay_8); 2202 OVERLAY_INFO_EXTERN(overlay_9); 2203 OVERLAY_INFO_EXTERN(overlay_10); 2204 OVERLAY_INFO_EXTERN(overlay_11); 2205 OVERLAY_INFO_EXTERN(overlay_12); 2206 OVERLAY_INFO_EXTERN(overlay_13); 2207 OVERLAY_INFO_EXTERN(overlay_15); 2208 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_node); 2209 OVERLAY_INFO_EXTERN(overlay_bad_add_dup_prop); 2210 OVERLAY_INFO_EXTERN(overlay_bad_phandle); 2211 OVERLAY_INFO_EXTERN(overlay_bad_symbol); 2212 2213 /* entries found by name */ 2214 static struct overlay_info overlays[] = { 2215 OVERLAY_INFO(overlay_base, -9999), 2216 OVERLAY_INFO(overlay, 0), 2217 OVERLAY_INFO(overlay_0, 0), 2218 OVERLAY_INFO(overlay_1, 0), 2219 OVERLAY_INFO(overlay_2, 0), 2220 OVERLAY_INFO(overlay_3, 0), 2221 OVERLAY_INFO(overlay_4, 0), 2222 OVERLAY_INFO(overlay_5, 0), 2223 OVERLAY_INFO(overlay_6, 0), 2224 OVERLAY_INFO(overlay_7, 0), 2225 OVERLAY_INFO(overlay_8, 0), 2226 OVERLAY_INFO(overlay_9, 0), 2227 OVERLAY_INFO(overlay_10, 0), 2228 OVERLAY_INFO(overlay_11, 0), 2229 OVERLAY_INFO(overlay_12, 0), 2230 OVERLAY_INFO(overlay_13, 0), 2231 OVERLAY_INFO(overlay_15, 0), 2232 OVERLAY_INFO(overlay_bad_add_dup_node, -EINVAL), 2233 OVERLAY_INFO(overlay_bad_add_dup_prop, -EINVAL), 2234 OVERLAY_INFO(overlay_bad_phandle, -EINVAL), 2235 OVERLAY_INFO(overlay_bad_symbol, -EINVAL), 2236 /* end marker */ 2237 {.dtb_begin = NULL, .dtb_end = NULL, .expected_result = 0, .name = NULL} 2238 }; 2239 2240 static struct device_node *overlay_base_root; 2241 2242 static void * __init dt_alloc_memory(u64 size, u64 align) 2243 { 2244 void *ptr = memblock_alloc(size, align); 2245 2246 if (!ptr) 2247 panic("%s: Failed to allocate %llu bytes align=0x%llx\n", 2248 __func__, size, align); 2249 2250 return ptr; 2251 } 2252 2253 /* 2254 * Create base device tree for the overlay unittest. 2255 * 2256 * This is called from very early boot code. 2257 * 2258 * Do as much as possible the same way as done in __unflatten_device_tree 2259 * and other early boot steps for the normal FDT so that the overlay base 2260 * unflattened tree will have the same characteristics as the real tree 2261 * (such as having memory allocated by the early allocator). The goal 2262 * is to test "the real thing" as much as possible, and test "test setup 2263 * code" as little as possible. 2264 * 2265 * Have to stop before resolving phandles, because that uses kmalloc. 2266 */ 2267 void __init unittest_unflatten_overlay_base(void) 2268 { 2269 struct overlay_info *info; 2270 u32 data_size; 2271 void *new_fdt; 2272 u32 size; 2273 int found = 0; 2274 const char *overlay_name = "overlay_base"; 2275 2276 for (info = overlays; info && info->name; info++) { 2277 if (!strcmp(overlay_name, info->name)) { 2278 found = 1; 2279 break; 2280 } 2281 } 2282 if (!found) { 2283 pr_err("no overlay data for %s\n", overlay_name); 2284 return; 2285 } 2286 2287 info = &overlays[0]; 2288 2289 if (info->expected_result != -9999) { 2290 pr_err("No dtb 'overlay_base' to attach\n"); 2291 return; 2292 } 2293 2294 data_size = info->dtb_end - info->dtb_begin; 2295 if (!data_size) { 2296 pr_err("No dtb 'overlay_base' to attach\n"); 2297 return; 2298 } 2299 2300 size = fdt_totalsize(info->dtb_begin); 2301 if (size != data_size) { 2302 pr_err("dtb 'overlay_base' header totalsize != actual size"); 2303 return; 2304 } 2305 2306 new_fdt = dt_alloc_memory(size, roundup_pow_of_two(FDT_V17_SIZE)); 2307 if (!new_fdt) { 2308 pr_err("alloc for dtb 'overlay_base' failed"); 2309 return; 2310 } 2311 2312 memcpy(new_fdt, info->dtb_begin, size); 2313 2314 __unflatten_device_tree(new_fdt, NULL, &overlay_base_root, 2315 dt_alloc_memory, true); 2316 } 2317 2318 /* 2319 * The purpose of of_unittest_overlay_data_add is to add an 2320 * overlay in the normal fashion. This is a test of the whole 2321 * picture, instead of testing individual elements. 2322 * 2323 * A secondary purpose is to be able to verify that the contents of 2324 * /proc/device-tree/ contains the updated structure and values from 2325 * the overlay. That must be verified separately in user space. 2326 * 2327 * Return 0 on unexpected error. 2328 */ 2329 static int __init overlay_data_apply(const char *overlay_name, int *overlay_id) 2330 { 2331 struct overlay_info *info; 2332 int found = 0; 2333 int ret; 2334 u32 size; 2335 2336 for (info = overlays; info && info->name; info++) { 2337 if (!strcmp(overlay_name, info->name)) { 2338 found = 1; 2339 break; 2340 } 2341 } 2342 if (!found) { 2343 pr_err("no overlay data for %s\n", overlay_name); 2344 return 0; 2345 } 2346 2347 size = info->dtb_end - info->dtb_begin; 2348 if (!size) 2349 pr_err("no overlay data for %s\n", overlay_name); 2350 2351 ret = of_overlay_fdt_apply(info->dtb_begin, size, &info->overlay_id); 2352 if (overlay_id) 2353 *overlay_id = info->overlay_id; 2354 if (ret < 0) 2355 goto out; 2356 2357 pr_debug("%s applied\n", overlay_name); 2358 2359 out: 2360 if (ret != info->expected_result) 2361 pr_err("of_overlay_fdt_apply() expected %d, ret=%d, %s\n", 2362 info->expected_result, ret, overlay_name); 2363 2364 return (ret == info->expected_result); 2365 } 2366 2367 /* 2368 * The purpose of of_unittest_overlay_high_level is to add an overlay 2369 * in the normal fashion. This is a test of the whole picture, 2370 * instead of individual elements. 2371 * 2372 * The first part of the function is _not_ normal overlay usage; it is 2373 * finishing splicing the base overlay device tree into the live tree. 2374 */ 2375 static __init void of_unittest_overlay_high_level(void) 2376 { 2377 struct device_node *last_sibling; 2378 struct device_node *np; 2379 struct device_node *of_symbols; 2380 struct device_node *overlay_base_symbols; 2381 struct device_node **pprev; 2382 struct property *prop; 2383 2384 if (!overlay_base_root) { 2385 unittest(0, "overlay_base_root not initialized\n"); 2386 return; 2387 } 2388 2389 /* 2390 * Could not fixup phandles in unittest_unflatten_overlay_base() 2391 * because kmalloc() was not yet available. 2392 */ 2393 of_overlay_mutex_lock(); 2394 of_resolve_phandles(overlay_base_root); 2395 of_overlay_mutex_unlock(); 2396 2397 2398 /* 2399 * do not allow overlay_base to duplicate any node already in 2400 * tree, this greatly simplifies the code 2401 */ 2402 2403 /* 2404 * remove overlay_base_root node "__local_fixups", after 2405 * being used by of_resolve_phandles() 2406 */ 2407 pprev = &overlay_base_root->child; 2408 for (np = overlay_base_root->child; np; np = np->sibling) { 2409 if (of_node_name_eq(np, "__local_fixups__")) { 2410 *pprev = np->sibling; 2411 break; 2412 } 2413 pprev = &np->sibling; 2414 } 2415 2416 /* remove overlay_base_root node "__symbols__" if in live tree */ 2417 of_symbols = of_get_child_by_name(of_root, "__symbols__"); 2418 if (of_symbols) { 2419 /* will have to graft properties from node into live tree */ 2420 pprev = &overlay_base_root->child; 2421 for (np = overlay_base_root->child; np; np = np->sibling) { 2422 if (of_node_name_eq(np, "__symbols__")) { 2423 overlay_base_symbols = np; 2424 *pprev = np->sibling; 2425 break; 2426 } 2427 pprev = &np->sibling; 2428 } 2429 } 2430 2431 for_each_child_of_node(overlay_base_root, np) { 2432 struct device_node *base_child; 2433 for_each_child_of_node(of_root, base_child) { 2434 if (!strcmp(np->full_name, base_child->full_name)) { 2435 unittest(0, "illegal node name in overlay_base %pOFn", 2436 np); 2437 return; 2438 } 2439 } 2440 } 2441 2442 /* 2443 * overlay 'overlay_base' is not allowed to have root 2444 * properties, so only need to splice nodes into main device tree. 2445 * 2446 * root node of *overlay_base_root will not be freed, it is lost 2447 * memory. 2448 */ 2449 2450 for (np = overlay_base_root->child; np; np = np->sibling) 2451 np->parent = of_root; 2452 2453 mutex_lock(&of_mutex); 2454 2455 for (last_sibling = np = of_root->child; np; np = np->sibling) 2456 last_sibling = np; 2457 2458 if (last_sibling) 2459 last_sibling->sibling = overlay_base_root->child; 2460 else 2461 of_root->child = overlay_base_root->child; 2462 2463 for_each_of_allnodes_from(overlay_base_root, np) 2464 __of_attach_node_sysfs(np); 2465 2466 if (of_symbols) { 2467 struct property *new_prop; 2468 for_each_property_of_node(overlay_base_symbols, prop) { 2469 2470 new_prop = __of_prop_dup(prop, GFP_KERNEL); 2471 if (!new_prop) { 2472 unittest(0, "__of_prop_dup() of '%s' from overlay_base node __symbols__", 2473 prop->name); 2474 goto err_unlock; 2475 } 2476 if (__of_add_property(of_symbols, new_prop)) { 2477 /* "name" auto-generated by unflatten */ 2478 if (!strcmp(new_prop->name, "name")) 2479 continue; 2480 unittest(0, "duplicate property '%s' in overlay_base node __symbols__", 2481 prop->name); 2482 goto err_unlock; 2483 } 2484 if (__of_add_property_sysfs(of_symbols, new_prop)) { 2485 unittest(0, "unable to add property '%s' in overlay_base node __symbols__ to sysfs", 2486 prop->name); 2487 goto err_unlock; 2488 } 2489 } 2490 } 2491 2492 mutex_unlock(&of_mutex); 2493 2494 2495 /* now do the normal overlay usage test */ 2496 2497 unittest(overlay_data_apply("overlay", NULL), 2498 "Adding overlay 'overlay' failed\n"); 2499 2500 unittest(overlay_data_apply("overlay_bad_add_dup_node", NULL), 2501 "Adding overlay 'overlay_bad_add_dup_node' failed\n"); 2502 2503 unittest(overlay_data_apply("overlay_bad_add_dup_prop", NULL), 2504 "Adding overlay 'overlay_bad_add_dup_prop' failed\n"); 2505 2506 unittest(overlay_data_apply("overlay_bad_phandle", NULL), 2507 "Adding overlay 'overlay_bad_phandle' failed\n"); 2508 2509 unittest(overlay_data_apply("overlay_bad_symbol", NULL), 2510 "Adding overlay 'overlay_bad_symbol' failed\n"); 2511 2512 return; 2513 2514 err_unlock: 2515 mutex_unlock(&of_mutex); 2516 } 2517 2518 #else 2519 2520 static inline __init void of_unittest_overlay_high_level(void) {} 2521 2522 #endif 2523 2524 static int __init of_unittest(void) 2525 { 2526 struct device_node *np; 2527 int res; 2528 2529 /* adding data for unittest */ 2530 2531 if (IS_ENABLED(CONFIG_UML)) 2532 unittest_unflatten_overlay_base(); 2533 2534 res = unittest_data_add(); 2535 if (res) 2536 return res; 2537 if (!of_aliases) 2538 of_aliases = of_find_node_by_path("/aliases"); 2539 2540 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a"); 2541 if (!np) { 2542 pr_info("No testcase data in device tree; not running tests\n"); 2543 return 0; 2544 } 2545 of_node_put(np); 2546 2547 pr_info("start of unittest - you will see error messages\n"); 2548 of_unittest_check_tree_linkage(); 2549 of_unittest_check_phandles(); 2550 of_unittest_find_node_by_name(); 2551 of_unittest_dynamic(); 2552 of_unittest_parse_phandle_with_args(); 2553 of_unittest_parse_phandle_with_args_map(); 2554 of_unittest_printf(); 2555 of_unittest_property_string(); 2556 of_unittest_property_copy(); 2557 of_unittest_changeset(); 2558 of_unittest_parse_interrupts(); 2559 of_unittest_parse_interrupts_extended(); 2560 of_unittest_match_node(); 2561 of_unittest_platform_populate(); 2562 of_unittest_overlay(); 2563 2564 /* Double check linkage after removing testcase data */ 2565 of_unittest_check_tree_linkage(); 2566 2567 of_unittest_overlay_high_level(); 2568 2569 pr_info("end of unittest - %i passed, %i failed\n", 2570 unittest_results.passed, unittest_results.failed); 2571 2572 return 0; 2573 } 2574 late_initcall(of_unittest); 2575