1 /* 2 * Self tests for device tree subsystem 3 */ 4 5 #define pr_fmt(fmt) "### dt-test ### " fmt 6 7 #include <linux/clk.h> 8 #include <linux/err.h> 9 #include <linux/errno.h> 10 #include <linux/hashtable.h> 11 #include <linux/module.h> 12 #include <linux/of.h> 13 #include <linux/of_fdt.h> 14 #include <linux/of_irq.h> 15 #include <linux/of_platform.h> 16 #include <linux/list.h> 17 #include <linux/mutex.h> 18 #include <linux/slab.h> 19 #include <linux/device.h> 20 #include <linux/platform_device.h> 21 #include <linux/of_platform.h> 22 23 #include <linux/i2c.h> 24 #include <linux/i2c-mux.h> 25 26 #include <linux/bitops.h> 27 28 #include "of_private.h" 29 30 static struct unittest_results { 31 int passed; 32 int failed; 33 } unittest_results; 34 35 #define unittest(result, fmt, ...) ({ \ 36 bool failed = !(result); \ 37 if (failed) { \ 38 unittest_results.failed++; \ 39 pr_err("FAIL %s():%i " fmt, __func__, __LINE__, ##__VA_ARGS__); \ 40 } else { \ 41 unittest_results.passed++; \ 42 pr_debug("pass %s():%i\n", __func__, __LINE__); \ 43 } \ 44 failed; \ 45 }) 46 47 static void __init of_unittest_find_node_by_name(void) 48 { 49 struct device_node *np; 50 const char *options; 51 52 np = of_find_node_by_path("/testcase-data"); 53 unittest(np && !strcmp("/testcase-data", np->full_name), 54 "find /testcase-data failed\n"); 55 of_node_put(np); 56 57 /* Test if trailing '/' works */ 58 np = of_find_node_by_path("/testcase-data/"); 59 unittest(!np, "trailing '/' on /testcase-data/ should fail\n"); 60 61 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a"); 62 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name), 63 "find /testcase-data/phandle-tests/consumer-a failed\n"); 64 of_node_put(np); 65 66 np = of_find_node_by_path("testcase-alias"); 67 unittest(np && !strcmp("/testcase-data", np->full_name), 68 "find testcase-alias failed\n"); 69 of_node_put(np); 70 71 /* Test if trailing '/' works on aliases */ 72 np = of_find_node_by_path("testcase-alias/"); 73 unittest(!np, "trailing '/' on testcase-alias/ should fail\n"); 74 75 np = of_find_node_by_path("testcase-alias/phandle-tests/consumer-a"); 76 unittest(np && !strcmp("/testcase-data/phandle-tests/consumer-a", np->full_name), 77 "find testcase-alias/phandle-tests/consumer-a failed\n"); 78 of_node_put(np); 79 80 np = of_find_node_by_path("/testcase-data/missing-path"); 81 unittest(!np, "non-existent path returned node %s\n", np->full_name); 82 of_node_put(np); 83 84 np = of_find_node_by_path("missing-alias"); 85 unittest(!np, "non-existent alias returned node %s\n", np->full_name); 86 of_node_put(np); 87 88 np = of_find_node_by_path("testcase-alias/missing-path"); 89 unittest(!np, "non-existent alias with relative path returned node %s\n", np->full_name); 90 of_node_put(np); 91 92 np = of_find_node_opts_by_path("/testcase-data:testoption", &options); 93 unittest(np && !strcmp("testoption", options), 94 "option path test failed\n"); 95 of_node_put(np); 96 97 np = of_find_node_opts_by_path("/testcase-data:test/option", &options); 98 unittest(np && !strcmp("test/option", options), 99 "option path test, subcase #1 failed\n"); 100 of_node_put(np); 101 102 np = of_find_node_opts_by_path("/testcase-data/testcase-device1:test/option", &options); 103 unittest(np && !strcmp("test/option", options), 104 "option path test, subcase #2 failed\n"); 105 of_node_put(np); 106 107 np = of_find_node_opts_by_path("/testcase-data:testoption", NULL); 108 unittest(np, "NULL option path test failed\n"); 109 of_node_put(np); 110 111 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", 112 &options); 113 unittest(np && !strcmp("testaliasoption", options), 114 "option alias path test failed\n"); 115 of_node_put(np); 116 117 np = of_find_node_opts_by_path("testcase-alias:test/alias/option", 118 &options); 119 unittest(np && !strcmp("test/alias/option", options), 120 "option alias path test, subcase #1 failed\n"); 121 of_node_put(np); 122 123 np = of_find_node_opts_by_path("testcase-alias:testaliasoption", NULL); 124 unittest(np, "NULL option alias path test failed\n"); 125 of_node_put(np); 126 127 options = "testoption"; 128 np = of_find_node_opts_by_path("testcase-alias", &options); 129 unittest(np && !options, "option clearing test failed\n"); 130 of_node_put(np); 131 132 options = "testoption"; 133 np = of_find_node_opts_by_path("/", &options); 134 unittest(np && !options, "option clearing root node test failed\n"); 135 of_node_put(np); 136 } 137 138 static void __init of_unittest_dynamic(void) 139 { 140 struct device_node *np; 141 struct property *prop; 142 143 np = of_find_node_by_path("/testcase-data"); 144 if (!np) { 145 pr_err("missing testcase data\n"); 146 return; 147 } 148 149 /* Array of 4 properties for the purpose of testing */ 150 prop = kzalloc(sizeof(*prop) * 4, GFP_KERNEL); 151 if (!prop) { 152 unittest(0, "kzalloc() failed\n"); 153 return; 154 } 155 156 /* Add a new property - should pass*/ 157 prop->name = "new-property"; 158 prop->value = "new-property-data"; 159 prop->length = strlen(prop->value); 160 unittest(of_add_property(np, prop) == 0, "Adding a new property failed\n"); 161 162 /* Try to add an existing property - should fail */ 163 prop++; 164 prop->name = "new-property"; 165 prop->value = "new-property-data-should-fail"; 166 prop->length = strlen(prop->value); 167 unittest(of_add_property(np, prop) != 0, 168 "Adding an existing property should have failed\n"); 169 170 /* Try to modify an existing property - should pass */ 171 prop->value = "modify-property-data-should-pass"; 172 prop->length = strlen(prop->value); 173 unittest(of_update_property(np, prop) == 0, 174 "Updating an existing property should have passed\n"); 175 176 /* Try to modify non-existent property - should pass*/ 177 prop++; 178 prop->name = "modify-property"; 179 prop->value = "modify-missing-property-data-should-pass"; 180 prop->length = strlen(prop->value); 181 unittest(of_update_property(np, prop) == 0, 182 "Updating a missing property should have passed\n"); 183 184 /* Remove property - should pass */ 185 unittest(of_remove_property(np, prop) == 0, 186 "Removing a property should have passed\n"); 187 188 /* Adding very large property - should pass */ 189 prop++; 190 prop->name = "large-property-PAGE_SIZEx8"; 191 prop->length = PAGE_SIZE * 8; 192 prop->value = kzalloc(prop->length, GFP_KERNEL); 193 unittest(prop->value != NULL, "Unable to allocate large buffer\n"); 194 if (prop->value) 195 unittest(of_add_property(np, prop) == 0, 196 "Adding a large property should have passed\n"); 197 } 198 199 static int __init of_unittest_check_node_linkage(struct device_node *np) 200 { 201 struct device_node *child; 202 int count = 0, rc; 203 204 for_each_child_of_node(np, child) { 205 if (child->parent != np) { 206 pr_err("Child node %s links to wrong parent %s\n", 207 child->name, np->name); 208 rc = -EINVAL; 209 goto put_child; 210 } 211 212 rc = of_unittest_check_node_linkage(child); 213 if (rc < 0) 214 goto put_child; 215 count += rc; 216 } 217 218 return count + 1; 219 put_child: 220 of_node_put(child); 221 return rc; 222 } 223 224 static void __init of_unittest_check_tree_linkage(void) 225 { 226 struct device_node *np; 227 int allnode_count = 0, child_count; 228 229 if (!of_root) 230 return; 231 232 for_each_of_allnodes(np) 233 allnode_count++; 234 child_count = of_unittest_check_node_linkage(of_root); 235 236 unittest(child_count > 0, "Device node data structure is corrupted\n"); 237 unittest(child_count == allnode_count, 238 "allnodes list size (%i) doesn't match sibling lists size (%i)\n", 239 allnode_count, child_count); 240 pr_debug("allnodes list size (%i); sibling lists size (%i)\n", allnode_count, child_count); 241 } 242 243 struct node_hash { 244 struct hlist_node node; 245 struct device_node *np; 246 }; 247 248 static DEFINE_HASHTABLE(phandle_ht, 8); 249 static void __init of_unittest_check_phandles(void) 250 { 251 struct device_node *np; 252 struct node_hash *nh; 253 struct hlist_node *tmp; 254 int i, dup_count = 0, phandle_count = 0; 255 256 for_each_of_allnodes(np) { 257 if (!np->phandle) 258 continue; 259 260 hash_for_each_possible(phandle_ht, nh, node, np->phandle) { 261 if (nh->np->phandle == np->phandle) { 262 pr_info("Duplicate phandle! %i used by %s and %s\n", 263 np->phandle, nh->np->full_name, np->full_name); 264 dup_count++; 265 break; 266 } 267 } 268 269 nh = kzalloc(sizeof(*nh), GFP_KERNEL); 270 if (WARN_ON(!nh)) 271 return; 272 273 nh->np = np; 274 hash_add(phandle_ht, &nh->node, np->phandle); 275 phandle_count++; 276 } 277 unittest(dup_count == 0, "Found %i duplicates in %i phandles\n", 278 dup_count, phandle_count); 279 280 /* Clean up */ 281 hash_for_each_safe(phandle_ht, i, tmp, nh, node) { 282 hash_del(&nh->node); 283 kfree(nh); 284 } 285 } 286 287 static void __init of_unittest_parse_phandle_with_args(void) 288 { 289 struct device_node *np; 290 struct of_phandle_args args; 291 int i, rc; 292 293 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a"); 294 if (!np) { 295 pr_err("missing testcase data\n"); 296 return; 297 } 298 299 rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells"); 300 unittest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc); 301 302 for (i = 0; i < 8; i++) { 303 bool passed = true; 304 305 rc = of_parse_phandle_with_args(np, "phandle-list", 306 "#phandle-cells", i, &args); 307 308 /* Test the values from tests-phandle.dtsi */ 309 switch (i) { 310 case 0: 311 passed &= !rc; 312 passed &= (args.args_count == 1); 313 passed &= (args.args[0] == (i + 1)); 314 break; 315 case 1: 316 passed &= !rc; 317 passed &= (args.args_count == 2); 318 passed &= (args.args[0] == (i + 1)); 319 passed &= (args.args[1] == 0); 320 break; 321 case 2: 322 passed &= (rc == -ENOENT); 323 break; 324 case 3: 325 passed &= !rc; 326 passed &= (args.args_count == 3); 327 passed &= (args.args[0] == (i + 1)); 328 passed &= (args.args[1] == 4); 329 passed &= (args.args[2] == 3); 330 break; 331 case 4: 332 passed &= !rc; 333 passed &= (args.args_count == 2); 334 passed &= (args.args[0] == (i + 1)); 335 passed &= (args.args[1] == 100); 336 break; 337 case 5: 338 passed &= !rc; 339 passed &= (args.args_count == 0); 340 break; 341 case 6: 342 passed &= !rc; 343 passed &= (args.args_count == 1); 344 passed &= (args.args[0] == (i + 1)); 345 break; 346 case 7: 347 passed &= (rc == -ENOENT); 348 break; 349 default: 350 passed = false; 351 } 352 353 unittest(passed, "index %i - data error on node %s rc=%i\n", 354 i, args.np->full_name, rc); 355 } 356 357 /* Check for missing list property */ 358 rc = of_parse_phandle_with_args(np, "phandle-list-missing", 359 "#phandle-cells", 0, &args); 360 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc); 361 rc = of_count_phandle_with_args(np, "phandle-list-missing", 362 "#phandle-cells"); 363 unittest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc); 364 365 /* Check for missing cells property */ 366 rc = of_parse_phandle_with_args(np, "phandle-list", 367 "#phandle-cells-missing", 0, &args); 368 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc); 369 rc = of_count_phandle_with_args(np, "phandle-list", 370 "#phandle-cells-missing"); 371 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc); 372 373 /* Check for bad phandle in list */ 374 rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle", 375 "#phandle-cells", 0, &args); 376 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc); 377 rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle", 378 "#phandle-cells"); 379 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc); 380 381 /* Check for incorrectly formed argument list */ 382 rc = of_parse_phandle_with_args(np, "phandle-list-bad-args", 383 "#phandle-cells", 1, &args); 384 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc); 385 rc = of_count_phandle_with_args(np, "phandle-list-bad-args", 386 "#phandle-cells"); 387 unittest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc); 388 } 389 390 static void __init of_unittest_property_string(void) 391 { 392 const char *strings[4]; 393 struct device_node *np; 394 int rc; 395 396 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a"); 397 if (!np) { 398 pr_err("No testcase data in device tree\n"); 399 return; 400 } 401 402 rc = of_property_match_string(np, "phandle-list-names", "first"); 403 unittest(rc == 0, "first expected:0 got:%i\n", rc); 404 rc = of_property_match_string(np, "phandle-list-names", "second"); 405 unittest(rc == 1, "second expected:1 got:%i\n", rc); 406 rc = of_property_match_string(np, "phandle-list-names", "third"); 407 unittest(rc == 2, "third expected:2 got:%i\n", rc); 408 rc = of_property_match_string(np, "phandle-list-names", "fourth"); 409 unittest(rc == -ENODATA, "unmatched string; rc=%i\n", rc); 410 rc = of_property_match_string(np, "missing-property", "blah"); 411 unittest(rc == -EINVAL, "missing property; rc=%i\n", rc); 412 rc = of_property_match_string(np, "empty-property", "blah"); 413 unittest(rc == -ENODATA, "empty property; rc=%i\n", rc); 414 rc = of_property_match_string(np, "unterminated-string", "blah"); 415 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc); 416 417 /* of_property_count_strings() tests */ 418 rc = of_property_count_strings(np, "string-property"); 419 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc); 420 rc = of_property_count_strings(np, "phandle-list-names"); 421 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc); 422 rc = of_property_count_strings(np, "unterminated-string"); 423 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc); 424 rc = of_property_count_strings(np, "unterminated-string-list"); 425 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc); 426 427 /* of_property_read_string_index() tests */ 428 rc = of_property_read_string_index(np, "string-property", 0, strings); 429 unittest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc); 430 strings[0] = NULL; 431 rc = of_property_read_string_index(np, "string-property", 1, strings); 432 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc); 433 rc = of_property_read_string_index(np, "phandle-list-names", 0, strings); 434 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc); 435 rc = of_property_read_string_index(np, "phandle-list-names", 1, strings); 436 unittest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc); 437 rc = of_property_read_string_index(np, "phandle-list-names", 2, strings); 438 unittest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc); 439 strings[0] = NULL; 440 rc = of_property_read_string_index(np, "phandle-list-names", 3, strings); 441 unittest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc); 442 strings[0] = NULL; 443 rc = of_property_read_string_index(np, "unterminated-string", 0, strings); 444 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc); 445 rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings); 446 unittest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc); 447 strings[0] = NULL; 448 rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */ 449 unittest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc); 450 strings[1] = NULL; 451 452 /* of_property_read_string_array() tests */ 453 rc = of_property_read_string_array(np, "string-property", strings, 4); 454 unittest(rc == 1, "Incorrect string count; rc=%i\n", rc); 455 rc = of_property_read_string_array(np, "phandle-list-names", strings, 4); 456 unittest(rc == 3, "Incorrect string count; rc=%i\n", rc); 457 rc = of_property_read_string_array(np, "unterminated-string", strings, 4); 458 unittest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc); 459 /* -- An incorrectly formed string should cause a failure */ 460 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4); 461 unittest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc); 462 /* -- parsing the correctly formed strings should still work: */ 463 strings[2] = NULL; 464 rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2); 465 unittest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc); 466 strings[1] = NULL; 467 rc = of_property_read_string_array(np, "phandle-list-names", strings, 1); 468 unittest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]); 469 } 470 471 #define propcmp(p1, p2) (((p1)->length == (p2)->length) && \ 472 (p1)->value && (p2)->value && \ 473 !memcmp((p1)->value, (p2)->value, (p1)->length) && \ 474 !strcmp((p1)->name, (p2)->name)) 475 static void __init of_unittest_property_copy(void) 476 { 477 #ifdef CONFIG_OF_DYNAMIC 478 struct property p1 = { .name = "p1", .length = 0, .value = "" }; 479 struct property p2 = { .name = "p2", .length = 5, .value = "abcd" }; 480 struct property *new; 481 482 new = __of_prop_dup(&p1, GFP_KERNEL); 483 unittest(new && propcmp(&p1, new), "empty property didn't copy correctly\n"); 484 kfree(new->value); 485 kfree(new->name); 486 kfree(new); 487 488 new = __of_prop_dup(&p2, GFP_KERNEL); 489 unittest(new && propcmp(&p2, new), "non-empty property didn't copy correctly\n"); 490 kfree(new->value); 491 kfree(new->name); 492 kfree(new); 493 #endif 494 } 495 496 static void __init of_unittest_changeset(void) 497 { 498 #ifdef CONFIG_OF_DYNAMIC 499 struct property *ppadd, padd = { .name = "prop-add", .length = 0, .value = "" }; 500 struct property *ppupdate, pupdate = { .name = "prop-update", .length = 5, .value = "abcd" }; 501 struct property *ppremove; 502 struct device_node *n1, *n2, *n21, *nremove, *parent, *np; 503 struct of_changeset chgset; 504 505 n1 = __of_node_dup(NULL, "/testcase-data/changeset/n1"); 506 unittest(n1, "testcase setup failure\n"); 507 n2 = __of_node_dup(NULL, "/testcase-data/changeset/n2"); 508 unittest(n2, "testcase setup failure\n"); 509 n21 = __of_node_dup(NULL, "%s/%s", "/testcase-data/changeset/n2", "n21"); 510 unittest(n21, "testcase setup failure %p\n", n21); 511 nremove = of_find_node_by_path("/testcase-data/changeset/node-remove"); 512 unittest(nremove, "testcase setup failure\n"); 513 ppadd = __of_prop_dup(&padd, GFP_KERNEL); 514 unittest(ppadd, "testcase setup failure\n"); 515 ppupdate = __of_prop_dup(&pupdate, GFP_KERNEL); 516 unittest(ppupdate, "testcase setup failure\n"); 517 parent = nremove->parent; 518 n1->parent = parent; 519 n2->parent = parent; 520 n21->parent = n2; 521 n2->child = n21; 522 ppremove = of_find_property(parent, "prop-remove", NULL); 523 unittest(ppremove, "failed to find removal prop"); 524 525 of_changeset_init(&chgset); 526 unittest(!of_changeset_attach_node(&chgset, n1), "fail attach n1\n"); 527 unittest(!of_changeset_attach_node(&chgset, n2), "fail attach n2\n"); 528 unittest(!of_changeset_detach_node(&chgset, nremove), "fail remove node\n"); 529 unittest(!of_changeset_attach_node(&chgset, n21), "fail attach n21\n"); 530 unittest(!of_changeset_add_property(&chgset, parent, ppadd), "fail add prop\n"); 531 unittest(!of_changeset_update_property(&chgset, parent, ppupdate), "fail update prop\n"); 532 unittest(!of_changeset_remove_property(&chgset, parent, ppremove), "fail remove prop\n"); 533 mutex_lock(&of_mutex); 534 unittest(!of_changeset_apply(&chgset), "apply failed\n"); 535 mutex_unlock(&of_mutex); 536 537 /* Make sure node names are constructed correctly */ 538 unittest((np = of_find_node_by_path("/testcase-data/changeset/n2/n21")), 539 "'%s' not added\n", n21->full_name); 540 of_node_put(np); 541 542 mutex_lock(&of_mutex); 543 unittest(!of_changeset_revert(&chgset), "revert failed\n"); 544 mutex_unlock(&of_mutex); 545 546 of_changeset_destroy(&chgset); 547 #endif 548 } 549 550 static void __init of_unittest_parse_interrupts(void) 551 { 552 struct device_node *np; 553 struct of_phandle_args args; 554 int i, rc; 555 556 np = of_find_node_by_path("/testcase-data/interrupts/interrupts0"); 557 if (!np) { 558 pr_err("missing testcase data\n"); 559 return; 560 } 561 562 for (i = 0; i < 4; i++) { 563 bool passed = true; 564 565 args.args_count = 0; 566 rc = of_irq_parse_one(np, i, &args); 567 568 passed &= !rc; 569 passed &= (args.args_count == 1); 570 passed &= (args.args[0] == (i + 1)); 571 572 unittest(passed, "index %i - data error on node %s rc=%i\n", 573 i, args.np->full_name, rc); 574 } 575 of_node_put(np); 576 577 np = of_find_node_by_path("/testcase-data/interrupts/interrupts1"); 578 if (!np) { 579 pr_err("missing testcase data\n"); 580 return; 581 } 582 583 for (i = 0; i < 4; i++) { 584 bool passed = true; 585 586 args.args_count = 0; 587 rc = of_irq_parse_one(np, i, &args); 588 589 /* Test the values from tests-phandle.dtsi */ 590 switch (i) { 591 case 0: 592 passed &= !rc; 593 passed &= (args.args_count == 1); 594 passed &= (args.args[0] == 9); 595 break; 596 case 1: 597 passed &= !rc; 598 passed &= (args.args_count == 3); 599 passed &= (args.args[0] == 10); 600 passed &= (args.args[1] == 11); 601 passed &= (args.args[2] == 12); 602 break; 603 case 2: 604 passed &= !rc; 605 passed &= (args.args_count == 2); 606 passed &= (args.args[0] == 13); 607 passed &= (args.args[1] == 14); 608 break; 609 case 3: 610 passed &= !rc; 611 passed &= (args.args_count == 2); 612 passed &= (args.args[0] == 15); 613 passed &= (args.args[1] == 16); 614 break; 615 default: 616 passed = false; 617 } 618 unittest(passed, "index %i - data error on node %s rc=%i\n", 619 i, args.np->full_name, rc); 620 } 621 of_node_put(np); 622 } 623 624 static void __init of_unittest_parse_interrupts_extended(void) 625 { 626 struct device_node *np; 627 struct of_phandle_args args; 628 int i, rc; 629 630 np = of_find_node_by_path("/testcase-data/interrupts/interrupts-extended0"); 631 if (!np) { 632 pr_err("missing testcase data\n"); 633 return; 634 } 635 636 for (i = 0; i < 7; i++) { 637 bool passed = true; 638 639 rc = of_irq_parse_one(np, i, &args); 640 641 /* Test the values from tests-phandle.dtsi */ 642 switch (i) { 643 case 0: 644 passed &= !rc; 645 passed &= (args.args_count == 1); 646 passed &= (args.args[0] == 1); 647 break; 648 case 1: 649 passed &= !rc; 650 passed &= (args.args_count == 3); 651 passed &= (args.args[0] == 2); 652 passed &= (args.args[1] == 3); 653 passed &= (args.args[2] == 4); 654 break; 655 case 2: 656 passed &= !rc; 657 passed &= (args.args_count == 2); 658 passed &= (args.args[0] == 5); 659 passed &= (args.args[1] == 6); 660 break; 661 case 3: 662 passed &= !rc; 663 passed &= (args.args_count == 1); 664 passed &= (args.args[0] == 9); 665 break; 666 case 4: 667 passed &= !rc; 668 passed &= (args.args_count == 3); 669 passed &= (args.args[0] == 10); 670 passed &= (args.args[1] == 11); 671 passed &= (args.args[2] == 12); 672 break; 673 case 5: 674 passed &= !rc; 675 passed &= (args.args_count == 2); 676 passed &= (args.args[0] == 13); 677 passed &= (args.args[1] == 14); 678 break; 679 case 6: 680 passed &= !rc; 681 passed &= (args.args_count == 1); 682 passed &= (args.args[0] == 15); 683 break; 684 default: 685 passed = false; 686 } 687 688 unittest(passed, "index %i - data error on node %s rc=%i\n", 689 i, args.np->full_name, rc); 690 } 691 of_node_put(np); 692 } 693 694 static const struct of_device_id match_node_table[] = { 695 { .data = "A", .name = "name0", }, /* Name alone is lowest priority */ 696 { .data = "B", .type = "type1", }, /* followed by type alone */ 697 698 { .data = "Ca", .name = "name2", .type = "type1", }, /* followed by both together */ 699 { .data = "Cb", .name = "name2", }, /* Only match when type doesn't match */ 700 { .data = "Cc", .name = "name2", .type = "type2", }, 701 702 { .data = "E", .compatible = "compat3" }, 703 { .data = "G", .compatible = "compat2", }, 704 { .data = "H", .compatible = "compat2", .name = "name5", }, 705 { .data = "I", .compatible = "compat2", .type = "type1", }, 706 { .data = "J", .compatible = "compat2", .type = "type1", .name = "name8", }, 707 { .data = "K", .compatible = "compat2", .name = "name9", }, 708 {} 709 }; 710 711 static struct { 712 const char *path; 713 const char *data; 714 } match_node_tests[] = { 715 { .path = "/testcase-data/match-node/name0", .data = "A", }, 716 { .path = "/testcase-data/match-node/name1", .data = "B", }, 717 { .path = "/testcase-data/match-node/a/name2", .data = "Ca", }, 718 { .path = "/testcase-data/match-node/b/name2", .data = "Cb", }, 719 { .path = "/testcase-data/match-node/c/name2", .data = "Cc", }, 720 { .path = "/testcase-data/match-node/name3", .data = "E", }, 721 { .path = "/testcase-data/match-node/name4", .data = "G", }, 722 { .path = "/testcase-data/match-node/name5", .data = "H", }, 723 { .path = "/testcase-data/match-node/name6", .data = "G", }, 724 { .path = "/testcase-data/match-node/name7", .data = "I", }, 725 { .path = "/testcase-data/match-node/name8", .data = "J", }, 726 { .path = "/testcase-data/match-node/name9", .data = "K", }, 727 }; 728 729 static void __init of_unittest_match_node(void) 730 { 731 struct device_node *np; 732 const struct of_device_id *match; 733 int i; 734 735 for (i = 0; i < ARRAY_SIZE(match_node_tests); i++) { 736 np = of_find_node_by_path(match_node_tests[i].path); 737 if (!np) { 738 unittest(0, "missing testcase node %s\n", 739 match_node_tests[i].path); 740 continue; 741 } 742 743 match = of_match_node(match_node_table, np); 744 if (!match) { 745 unittest(0, "%s didn't match anything\n", 746 match_node_tests[i].path); 747 continue; 748 } 749 750 if (strcmp(match->data, match_node_tests[i].data) != 0) { 751 unittest(0, "%s got wrong match. expected %s, got %s\n", 752 match_node_tests[i].path, match_node_tests[i].data, 753 (const char *)match->data); 754 continue; 755 } 756 unittest(1, "passed"); 757 } 758 } 759 760 static const struct platform_device_info test_bus_info = { 761 .name = "unittest-bus", 762 }; 763 static void __init of_unittest_platform_populate(void) 764 { 765 int irq, rc; 766 struct device_node *np, *child, *grandchild; 767 struct platform_device *pdev, *test_bus; 768 const struct of_device_id match[] = { 769 { .compatible = "test-device", }, 770 {} 771 }; 772 773 np = of_find_node_by_path("/testcase-data"); 774 of_platform_populate(np, of_default_bus_match_table, NULL, NULL); 775 776 /* Test that a missing irq domain returns -EPROBE_DEFER */ 777 np = of_find_node_by_path("/testcase-data/testcase-device1"); 778 pdev = of_find_device_by_node(np); 779 unittest(pdev, "device 1 creation failed\n"); 780 781 irq = platform_get_irq(pdev, 0); 782 unittest(irq == -EPROBE_DEFER, "device deferred probe failed - %d\n", irq); 783 784 /* Test that a parsing failure does not return -EPROBE_DEFER */ 785 np = of_find_node_by_path("/testcase-data/testcase-device2"); 786 pdev = of_find_device_by_node(np); 787 unittest(pdev, "device 2 creation failed\n"); 788 irq = platform_get_irq(pdev, 0); 789 unittest(irq < 0 && irq != -EPROBE_DEFER, "device parsing error failed - %d\n", irq); 790 791 np = of_find_node_by_path("/testcase-data/platform-tests"); 792 unittest(np, "No testcase data in device tree\n"); 793 if (!np) 794 return; 795 796 test_bus = platform_device_register_full(&test_bus_info); 797 rc = PTR_ERR_OR_ZERO(test_bus); 798 unittest(!rc, "testbus registration failed; rc=%i\n", rc); 799 if (rc) 800 return; 801 test_bus->dev.of_node = np; 802 803 of_platform_populate(np, match, NULL, &test_bus->dev); 804 for_each_child_of_node(np, child) { 805 for_each_child_of_node(child, grandchild) 806 unittest(of_find_device_by_node(grandchild), 807 "Could not create device for node '%s'\n", 808 grandchild->name); 809 } 810 811 of_platform_depopulate(&test_bus->dev); 812 for_each_child_of_node(np, child) { 813 for_each_child_of_node(child, grandchild) 814 unittest(!of_find_device_by_node(grandchild), 815 "device didn't get destroyed '%s'\n", 816 grandchild->name); 817 } 818 819 platform_device_unregister(test_bus); 820 of_node_put(np); 821 } 822 823 /** 824 * update_node_properties - adds the properties 825 * of np into dup node (present in live tree) and 826 * updates parent of children of np to dup. 827 * 828 * @np: node already present in live tree 829 * @dup: node present in live tree to be updated 830 */ 831 static void update_node_properties(struct device_node *np, 832 struct device_node *dup) 833 { 834 struct property *prop; 835 struct device_node *child; 836 837 for_each_property_of_node(np, prop) 838 of_add_property(dup, prop); 839 840 for_each_child_of_node(np, child) 841 child->parent = dup; 842 } 843 844 /** 845 * attach_node_and_children - attaches nodes 846 * and its children to live tree 847 * 848 * @np: Node to attach to live tree 849 */ 850 static int attach_node_and_children(struct device_node *np) 851 { 852 struct device_node *next, *dup, *child; 853 unsigned long flags; 854 855 dup = of_find_node_by_path(np->full_name); 856 if (dup) { 857 update_node_properties(np, dup); 858 return 0; 859 } 860 861 child = np->child; 862 np->child = NULL; 863 864 mutex_lock(&of_mutex); 865 raw_spin_lock_irqsave(&devtree_lock, flags); 866 np->sibling = np->parent->child; 867 np->parent->child = np; 868 of_node_clear_flag(np, OF_DETACHED); 869 raw_spin_unlock_irqrestore(&devtree_lock, flags); 870 871 __of_attach_node_sysfs(np); 872 mutex_unlock(&of_mutex); 873 874 while (child) { 875 next = child->sibling; 876 attach_node_and_children(child); 877 child = next; 878 } 879 880 return 0; 881 } 882 883 /** 884 * unittest_data_add - Reads, copies data from 885 * linked tree and attaches it to the live tree 886 */ 887 static int __init unittest_data_add(void) 888 { 889 void *unittest_data; 890 struct device_node *unittest_data_node, *np; 891 /* 892 * __dtb_testcases_begin[] and __dtb_testcases_end[] are magically 893 * created by cmd_dt_S_dtb in scripts/Makefile.lib 894 */ 895 extern uint8_t __dtb_testcases_begin[]; 896 extern uint8_t __dtb_testcases_end[]; 897 const int size = __dtb_testcases_end - __dtb_testcases_begin; 898 int rc; 899 900 if (!size) { 901 pr_warn("%s: No testcase data to attach; not running tests\n", 902 __func__); 903 return -ENODATA; 904 } 905 906 /* creating copy */ 907 unittest_data = kmemdup(__dtb_testcases_begin, size, GFP_KERNEL); 908 909 if (!unittest_data) { 910 pr_warn("%s: Failed to allocate memory for unittest_data; " 911 "not running tests\n", __func__); 912 return -ENOMEM; 913 } 914 of_fdt_unflatten_tree(unittest_data, &unittest_data_node); 915 if (!unittest_data_node) { 916 pr_warn("%s: No tree to attach; not running tests\n", __func__); 917 return -ENODATA; 918 } 919 of_node_set_flag(unittest_data_node, OF_DETACHED); 920 rc = of_resolve_phandles(unittest_data_node); 921 if (rc) { 922 pr_err("%s: Failed to resolve phandles (rc=%i)\n", __func__, rc); 923 return -EINVAL; 924 } 925 926 if (!of_root) { 927 of_root = unittest_data_node; 928 for_each_of_allnodes(np) 929 __of_attach_node_sysfs(np); 930 of_aliases = of_find_node_by_path("/aliases"); 931 of_chosen = of_find_node_by_path("/chosen"); 932 return 0; 933 } 934 935 /* attach the sub-tree to live tree */ 936 np = unittest_data_node->child; 937 while (np) { 938 struct device_node *next = np->sibling; 939 940 np->parent = of_root; 941 attach_node_and_children(np); 942 np = next; 943 } 944 return 0; 945 } 946 947 #ifdef CONFIG_OF_OVERLAY 948 949 static int unittest_probe(struct platform_device *pdev) 950 { 951 struct device *dev = &pdev->dev; 952 struct device_node *np = dev->of_node; 953 954 if (np == NULL) { 955 dev_err(dev, "No OF data for device\n"); 956 return -EINVAL; 957 958 } 959 960 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 961 962 of_platform_populate(np, NULL, NULL, &pdev->dev); 963 964 return 0; 965 } 966 967 static int unittest_remove(struct platform_device *pdev) 968 { 969 struct device *dev = &pdev->dev; 970 struct device_node *np = dev->of_node; 971 972 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 973 return 0; 974 } 975 976 static const struct of_device_id unittest_match[] = { 977 { .compatible = "unittest", }, 978 {}, 979 }; 980 981 static struct platform_driver unittest_driver = { 982 .probe = unittest_probe, 983 .remove = unittest_remove, 984 .driver = { 985 .name = "unittest", 986 .of_match_table = of_match_ptr(unittest_match), 987 }, 988 }; 989 990 /* get the platform device instantiated at the path */ 991 static struct platform_device *of_path_to_platform_device(const char *path) 992 { 993 struct device_node *np; 994 struct platform_device *pdev; 995 996 np = of_find_node_by_path(path); 997 if (np == NULL) 998 return NULL; 999 1000 pdev = of_find_device_by_node(np); 1001 of_node_put(np); 1002 1003 return pdev; 1004 } 1005 1006 /* find out if a platform device exists at that path */ 1007 static int of_path_platform_device_exists(const char *path) 1008 { 1009 struct platform_device *pdev; 1010 1011 pdev = of_path_to_platform_device(path); 1012 platform_device_put(pdev); 1013 return pdev != NULL; 1014 } 1015 1016 #if IS_BUILTIN(CONFIG_I2C) 1017 1018 /* get the i2c client device instantiated at the path */ 1019 static struct i2c_client *of_path_to_i2c_client(const char *path) 1020 { 1021 struct device_node *np; 1022 struct i2c_client *client; 1023 1024 np = of_find_node_by_path(path); 1025 if (np == NULL) 1026 return NULL; 1027 1028 client = of_find_i2c_device_by_node(np); 1029 of_node_put(np); 1030 1031 return client; 1032 } 1033 1034 /* find out if a i2c client device exists at that path */ 1035 static int of_path_i2c_client_exists(const char *path) 1036 { 1037 struct i2c_client *client; 1038 1039 client = of_path_to_i2c_client(path); 1040 if (client) 1041 put_device(&client->dev); 1042 return client != NULL; 1043 } 1044 #else 1045 static int of_path_i2c_client_exists(const char *path) 1046 { 1047 return 0; 1048 } 1049 #endif 1050 1051 enum overlay_type { 1052 PDEV_OVERLAY, 1053 I2C_OVERLAY 1054 }; 1055 1056 static int of_path_device_type_exists(const char *path, 1057 enum overlay_type ovtype) 1058 { 1059 switch (ovtype) { 1060 case PDEV_OVERLAY: 1061 return of_path_platform_device_exists(path); 1062 case I2C_OVERLAY: 1063 return of_path_i2c_client_exists(path); 1064 } 1065 return 0; 1066 } 1067 1068 static const char *unittest_path(int nr, enum overlay_type ovtype) 1069 { 1070 const char *base; 1071 static char buf[256]; 1072 1073 switch (ovtype) { 1074 case PDEV_OVERLAY: 1075 base = "/testcase-data/overlay-node/test-bus"; 1076 break; 1077 case I2C_OVERLAY: 1078 base = "/testcase-data/overlay-node/test-bus/i2c-test-bus"; 1079 break; 1080 default: 1081 buf[0] = '\0'; 1082 return buf; 1083 } 1084 snprintf(buf, sizeof(buf) - 1, "%s/test-unittest%d", base, nr); 1085 buf[sizeof(buf) - 1] = '\0'; 1086 return buf; 1087 } 1088 1089 static int of_unittest_device_exists(int unittest_nr, enum overlay_type ovtype) 1090 { 1091 const char *path; 1092 1093 path = unittest_path(unittest_nr, ovtype); 1094 1095 switch (ovtype) { 1096 case PDEV_OVERLAY: 1097 return of_path_platform_device_exists(path); 1098 case I2C_OVERLAY: 1099 return of_path_i2c_client_exists(path); 1100 } 1101 return 0; 1102 } 1103 1104 static const char *overlay_path(int nr) 1105 { 1106 static char buf[256]; 1107 1108 snprintf(buf, sizeof(buf) - 1, 1109 "/testcase-data/overlay%d", nr); 1110 buf[sizeof(buf) - 1] = '\0'; 1111 1112 return buf; 1113 } 1114 1115 static const char *bus_path = "/testcase-data/overlay-node/test-bus"; 1116 1117 /* it is guaranteed that overlay ids are assigned in sequence */ 1118 #define MAX_UNITTEST_OVERLAYS 256 1119 static unsigned long overlay_id_bits[BITS_TO_LONGS(MAX_UNITTEST_OVERLAYS)]; 1120 static int overlay_first_id = -1; 1121 1122 static void of_unittest_track_overlay(int id) 1123 { 1124 if (overlay_first_id < 0) 1125 overlay_first_id = id; 1126 id -= overlay_first_id; 1127 1128 /* we shouldn't need that many */ 1129 BUG_ON(id >= MAX_UNITTEST_OVERLAYS); 1130 overlay_id_bits[BIT_WORD(id)] |= BIT_MASK(id); 1131 } 1132 1133 static void of_unittest_untrack_overlay(int id) 1134 { 1135 if (overlay_first_id < 0) 1136 return; 1137 id -= overlay_first_id; 1138 BUG_ON(id >= MAX_UNITTEST_OVERLAYS); 1139 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id); 1140 } 1141 1142 static void of_unittest_destroy_tracked_overlays(void) 1143 { 1144 int id, ret, defers; 1145 1146 if (overlay_first_id < 0) 1147 return; 1148 1149 /* try until no defers */ 1150 do { 1151 defers = 0; 1152 /* remove in reverse order */ 1153 for (id = MAX_UNITTEST_OVERLAYS - 1; id >= 0; id--) { 1154 if (!(overlay_id_bits[BIT_WORD(id)] & BIT_MASK(id))) 1155 continue; 1156 1157 ret = of_overlay_destroy(id + overlay_first_id); 1158 if (ret != 0) { 1159 defers++; 1160 pr_warn("%s: overlay destroy failed for #%d\n", 1161 __func__, id + overlay_first_id); 1162 continue; 1163 } 1164 1165 overlay_id_bits[BIT_WORD(id)] &= ~BIT_MASK(id); 1166 } 1167 } while (defers > 0); 1168 } 1169 1170 static int of_unittest_apply_overlay(int unittest_nr, int overlay_nr, 1171 int *overlay_id) 1172 { 1173 struct device_node *np = NULL; 1174 int ret, id = -1; 1175 1176 np = of_find_node_by_path(overlay_path(overlay_nr)); 1177 if (np == NULL) { 1178 unittest(0, "could not find overlay node @\"%s\"\n", 1179 overlay_path(overlay_nr)); 1180 ret = -EINVAL; 1181 goto out; 1182 } 1183 1184 ret = of_overlay_create(np); 1185 if (ret < 0) { 1186 unittest(0, "could not create overlay from \"%s\"\n", 1187 overlay_path(overlay_nr)); 1188 goto out; 1189 } 1190 id = ret; 1191 of_unittest_track_overlay(id); 1192 1193 ret = 0; 1194 1195 out: 1196 of_node_put(np); 1197 1198 if (overlay_id) 1199 *overlay_id = id; 1200 1201 return ret; 1202 } 1203 1204 /* apply an overlay while checking before and after states */ 1205 static int of_unittest_apply_overlay_check(int overlay_nr, int unittest_nr, 1206 int before, int after, enum overlay_type ovtype) 1207 { 1208 int ret; 1209 1210 /* unittest device must not be in before state */ 1211 if (of_unittest_device_exists(unittest_nr, ovtype) != before) { 1212 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n", 1213 overlay_path(overlay_nr), 1214 unittest_path(unittest_nr, ovtype), 1215 !before ? "enabled" : "disabled"); 1216 return -EINVAL; 1217 } 1218 1219 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, NULL); 1220 if (ret != 0) { 1221 /* of_unittest_apply_overlay already called unittest() */ 1222 return ret; 1223 } 1224 1225 /* unittest device must be to set to after state */ 1226 if (of_unittest_device_exists(unittest_nr, ovtype) != after) { 1227 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n", 1228 overlay_path(overlay_nr), 1229 unittest_path(unittest_nr, ovtype), 1230 !after ? "enabled" : "disabled"); 1231 return -EINVAL; 1232 } 1233 1234 return 0; 1235 } 1236 1237 /* apply an overlay and then revert it while checking before, after states */ 1238 static int of_unittest_apply_revert_overlay_check(int overlay_nr, 1239 int unittest_nr, int before, int after, 1240 enum overlay_type ovtype) 1241 { 1242 int ret, ov_id; 1243 1244 /* unittest device must be in before state */ 1245 if (of_unittest_device_exists(unittest_nr, ovtype) != before) { 1246 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n", 1247 overlay_path(overlay_nr), 1248 unittest_path(unittest_nr, ovtype), 1249 !before ? "enabled" : "disabled"); 1250 return -EINVAL; 1251 } 1252 1253 /* apply the overlay */ 1254 ret = of_unittest_apply_overlay(overlay_nr, unittest_nr, &ov_id); 1255 if (ret != 0) { 1256 /* of_unittest_apply_overlay already called unittest() */ 1257 return ret; 1258 } 1259 1260 /* unittest device must be in after state */ 1261 if (of_unittest_device_exists(unittest_nr, ovtype) != after) { 1262 unittest(0, "overlay @\"%s\" failed to create @\"%s\" %s\n", 1263 overlay_path(overlay_nr), 1264 unittest_path(unittest_nr, ovtype), 1265 !after ? "enabled" : "disabled"); 1266 return -EINVAL; 1267 } 1268 1269 ret = of_overlay_destroy(ov_id); 1270 if (ret != 0) { 1271 unittest(0, "overlay @\"%s\" failed to be destroyed @\"%s\"\n", 1272 overlay_path(overlay_nr), 1273 unittest_path(unittest_nr, ovtype)); 1274 return ret; 1275 } 1276 1277 /* unittest device must be again in before state */ 1278 if (of_unittest_device_exists(unittest_nr, PDEV_OVERLAY) != before) { 1279 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n", 1280 overlay_path(overlay_nr), 1281 unittest_path(unittest_nr, ovtype), 1282 !before ? "enabled" : "disabled"); 1283 return -EINVAL; 1284 } 1285 1286 return 0; 1287 } 1288 1289 /* test activation of device */ 1290 static void of_unittest_overlay_0(void) 1291 { 1292 int ret; 1293 1294 /* device should enable */ 1295 ret = of_unittest_apply_overlay_check(0, 0, 0, 1, PDEV_OVERLAY); 1296 if (ret != 0) 1297 return; 1298 1299 unittest(1, "overlay test %d passed\n", 0); 1300 } 1301 1302 /* test deactivation of device */ 1303 static void of_unittest_overlay_1(void) 1304 { 1305 int ret; 1306 1307 /* device should disable */ 1308 ret = of_unittest_apply_overlay_check(1, 1, 1, 0, PDEV_OVERLAY); 1309 if (ret != 0) 1310 return; 1311 1312 unittest(1, "overlay test %d passed\n", 1); 1313 } 1314 1315 /* test activation of device */ 1316 static void of_unittest_overlay_2(void) 1317 { 1318 int ret; 1319 1320 /* device should enable */ 1321 ret = of_unittest_apply_overlay_check(2, 2, 0, 1, PDEV_OVERLAY); 1322 if (ret != 0) 1323 return; 1324 1325 unittest(1, "overlay test %d passed\n", 2); 1326 } 1327 1328 /* test deactivation of device */ 1329 static void of_unittest_overlay_3(void) 1330 { 1331 int ret; 1332 1333 /* device should disable */ 1334 ret = of_unittest_apply_overlay_check(3, 3, 1, 0, PDEV_OVERLAY); 1335 if (ret != 0) 1336 return; 1337 1338 unittest(1, "overlay test %d passed\n", 3); 1339 } 1340 1341 /* test activation of a full device node */ 1342 static void of_unittest_overlay_4(void) 1343 { 1344 int ret; 1345 1346 /* device should disable */ 1347 ret = of_unittest_apply_overlay_check(4, 4, 0, 1, PDEV_OVERLAY); 1348 if (ret != 0) 1349 return; 1350 1351 unittest(1, "overlay test %d passed\n", 4); 1352 } 1353 1354 /* test overlay apply/revert sequence */ 1355 static void of_unittest_overlay_5(void) 1356 { 1357 int ret; 1358 1359 /* device should disable */ 1360 ret = of_unittest_apply_revert_overlay_check(5, 5, 0, 1, PDEV_OVERLAY); 1361 if (ret != 0) 1362 return; 1363 1364 unittest(1, "overlay test %d passed\n", 5); 1365 } 1366 1367 /* test overlay application in sequence */ 1368 static void of_unittest_overlay_6(void) 1369 { 1370 struct device_node *np; 1371 int ret, i, ov_id[2]; 1372 int overlay_nr = 6, unittest_nr = 6; 1373 int before = 0, after = 1; 1374 1375 /* unittest device must be in before state */ 1376 for (i = 0; i < 2; i++) { 1377 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY) 1378 != before) { 1379 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n", 1380 overlay_path(overlay_nr + i), 1381 unittest_path(unittest_nr + i, 1382 PDEV_OVERLAY), 1383 !before ? "enabled" : "disabled"); 1384 return; 1385 } 1386 } 1387 1388 /* apply the overlays */ 1389 for (i = 0; i < 2; i++) { 1390 1391 np = of_find_node_by_path(overlay_path(overlay_nr + i)); 1392 if (np == NULL) { 1393 unittest(0, "could not find overlay node @\"%s\"\n", 1394 overlay_path(overlay_nr + i)); 1395 return; 1396 } 1397 1398 ret = of_overlay_create(np); 1399 if (ret < 0) { 1400 unittest(0, "could not create overlay from \"%s\"\n", 1401 overlay_path(overlay_nr + i)); 1402 return; 1403 } 1404 ov_id[i] = ret; 1405 of_unittest_track_overlay(ov_id[i]); 1406 } 1407 1408 for (i = 0; i < 2; i++) { 1409 /* unittest device must be in after state */ 1410 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY) 1411 != after) { 1412 unittest(0, "overlay @\"%s\" failed @\"%s\" %s\n", 1413 overlay_path(overlay_nr + i), 1414 unittest_path(unittest_nr + i, 1415 PDEV_OVERLAY), 1416 !after ? "enabled" : "disabled"); 1417 return; 1418 } 1419 } 1420 1421 for (i = 1; i >= 0; i--) { 1422 ret = of_overlay_destroy(ov_id[i]); 1423 if (ret != 0) { 1424 unittest(0, "overlay @\"%s\" failed destroy @\"%s\"\n", 1425 overlay_path(overlay_nr + i), 1426 unittest_path(unittest_nr + i, 1427 PDEV_OVERLAY)); 1428 return; 1429 } 1430 of_unittest_untrack_overlay(ov_id[i]); 1431 } 1432 1433 for (i = 0; i < 2; i++) { 1434 /* unittest device must be again in before state */ 1435 if (of_unittest_device_exists(unittest_nr + i, PDEV_OVERLAY) 1436 != before) { 1437 unittest(0, "overlay @\"%s\" with device @\"%s\" %s\n", 1438 overlay_path(overlay_nr + i), 1439 unittest_path(unittest_nr + i, 1440 PDEV_OVERLAY), 1441 !before ? "enabled" : "disabled"); 1442 return; 1443 } 1444 } 1445 1446 unittest(1, "overlay test %d passed\n", 6); 1447 } 1448 1449 /* test overlay application in sequence */ 1450 static void of_unittest_overlay_8(void) 1451 { 1452 struct device_node *np; 1453 int ret, i, ov_id[2]; 1454 int overlay_nr = 8, unittest_nr = 8; 1455 1456 /* we don't care about device state in this test */ 1457 1458 /* apply the overlays */ 1459 for (i = 0; i < 2; i++) { 1460 1461 np = of_find_node_by_path(overlay_path(overlay_nr + i)); 1462 if (np == NULL) { 1463 unittest(0, "could not find overlay node @\"%s\"\n", 1464 overlay_path(overlay_nr + i)); 1465 return; 1466 } 1467 1468 ret = of_overlay_create(np); 1469 if (ret < 0) { 1470 unittest(0, "could not create overlay from \"%s\"\n", 1471 overlay_path(overlay_nr + i)); 1472 return; 1473 } 1474 ov_id[i] = ret; 1475 of_unittest_track_overlay(ov_id[i]); 1476 } 1477 1478 /* now try to remove first overlay (it should fail) */ 1479 ret = of_overlay_destroy(ov_id[0]); 1480 if (ret == 0) { 1481 unittest(0, "overlay @\"%s\" was destroyed @\"%s\"\n", 1482 overlay_path(overlay_nr + 0), 1483 unittest_path(unittest_nr, 1484 PDEV_OVERLAY)); 1485 return; 1486 } 1487 1488 /* removing them in order should work */ 1489 for (i = 1; i >= 0; i--) { 1490 ret = of_overlay_destroy(ov_id[i]); 1491 if (ret != 0) { 1492 unittest(0, "overlay @\"%s\" not destroyed @\"%s\"\n", 1493 overlay_path(overlay_nr + i), 1494 unittest_path(unittest_nr, 1495 PDEV_OVERLAY)); 1496 return; 1497 } 1498 of_unittest_untrack_overlay(ov_id[i]); 1499 } 1500 1501 unittest(1, "overlay test %d passed\n", 8); 1502 } 1503 1504 /* test insertion of a bus with parent devices */ 1505 static void of_unittest_overlay_10(void) 1506 { 1507 int ret; 1508 char *child_path; 1509 1510 /* device should disable */ 1511 ret = of_unittest_apply_overlay_check(10, 10, 0, 1, PDEV_OVERLAY); 1512 if (unittest(ret == 0, 1513 "overlay test %d failed; overlay application\n", 10)) 1514 return; 1515 1516 child_path = kasprintf(GFP_KERNEL, "%s/test-unittest101", 1517 unittest_path(10, PDEV_OVERLAY)); 1518 if (unittest(child_path, "overlay test %d failed; kasprintf\n", 10)) 1519 return; 1520 1521 ret = of_path_device_type_exists(child_path, PDEV_OVERLAY); 1522 kfree(child_path); 1523 if (unittest(ret, "overlay test %d failed; no child device\n", 10)) 1524 return; 1525 } 1526 1527 /* test insertion of a bus with parent devices (and revert) */ 1528 static void of_unittest_overlay_11(void) 1529 { 1530 int ret; 1531 1532 /* device should disable */ 1533 ret = of_unittest_apply_revert_overlay_check(11, 11, 0, 1, 1534 PDEV_OVERLAY); 1535 if (unittest(ret == 0, 1536 "overlay test %d failed; overlay application\n", 11)) 1537 return; 1538 } 1539 1540 #if IS_BUILTIN(CONFIG_I2C) && IS_ENABLED(CONFIG_OF_OVERLAY) 1541 1542 struct unittest_i2c_bus_data { 1543 struct platform_device *pdev; 1544 struct i2c_adapter adap; 1545 }; 1546 1547 static int unittest_i2c_master_xfer(struct i2c_adapter *adap, 1548 struct i2c_msg *msgs, int num) 1549 { 1550 struct unittest_i2c_bus_data *std = i2c_get_adapdata(adap); 1551 1552 (void)std; 1553 1554 return num; 1555 } 1556 1557 static u32 unittest_i2c_functionality(struct i2c_adapter *adap) 1558 { 1559 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL; 1560 } 1561 1562 static const struct i2c_algorithm unittest_i2c_algo = { 1563 .master_xfer = unittest_i2c_master_xfer, 1564 .functionality = unittest_i2c_functionality, 1565 }; 1566 1567 static int unittest_i2c_bus_probe(struct platform_device *pdev) 1568 { 1569 struct device *dev = &pdev->dev; 1570 struct device_node *np = dev->of_node; 1571 struct unittest_i2c_bus_data *std; 1572 struct i2c_adapter *adap; 1573 int ret; 1574 1575 if (np == NULL) { 1576 dev_err(dev, "No OF data for device\n"); 1577 return -EINVAL; 1578 1579 } 1580 1581 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 1582 1583 std = devm_kzalloc(dev, sizeof(*std), GFP_KERNEL); 1584 if (!std) { 1585 dev_err(dev, "Failed to allocate unittest i2c data\n"); 1586 return -ENOMEM; 1587 } 1588 1589 /* link them together */ 1590 std->pdev = pdev; 1591 platform_set_drvdata(pdev, std); 1592 1593 adap = &std->adap; 1594 i2c_set_adapdata(adap, std); 1595 adap->nr = -1; 1596 strlcpy(adap->name, pdev->name, sizeof(adap->name)); 1597 adap->class = I2C_CLASS_DEPRECATED; 1598 adap->algo = &unittest_i2c_algo; 1599 adap->dev.parent = dev; 1600 adap->dev.of_node = dev->of_node; 1601 adap->timeout = 5 * HZ; 1602 adap->retries = 3; 1603 1604 ret = i2c_add_numbered_adapter(adap); 1605 if (ret != 0) { 1606 dev_err(dev, "Failed to add I2C adapter\n"); 1607 return ret; 1608 } 1609 1610 return 0; 1611 } 1612 1613 static int unittest_i2c_bus_remove(struct platform_device *pdev) 1614 { 1615 struct device *dev = &pdev->dev; 1616 struct device_node *np = dev->of_node; 1617 struct unittest_i2c_bus_data *std = platform_get_drvdata(pdev); 1618 1619 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 1620 i2c_del_adapter(&std->adap); 1621 1622 return 0; 1623 } 1624 1625 static const struct of_device_id unittest_i2c_bus_match[] = { 1626 { .compatible = "unittest-i2c-bus", }, 1627 {}, 1628 }; 1629 1630 static struct platform_driver unittest_i2c_bus_driver = { 1631 .probe = unittest_i2c_bus_probe, 1632 .remove = unittest_i2c_bus_remove, 1633 .driver = { 1634 .name = "unittest-i2c-bus", 1635 .of_match_table = of_match_ptr(unittest_i2c_bus_match), 1636 }, 1637 }; 1638 1639 static int unittest_i2c_dev_probe(struct i2c_client *client, 1640 const struct i2c_device_id *id) 1641 { 1642 struct device *dev = &client->dev; 1643 struct device_node *np = client->dev.of_node; 1644 1645 if (!np) { 1646 dev_err(dev, "No OF node\n"); 1647 return -EINVAL; 1648 } 1649 1650 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 1651 1652 return 0; 1653 }; 1654 1655 static int unittest_i2c_dev_remove(struct i2c_client *client) 1656 { 1657 struct device *dev = &client->dev; 1658 struct device_node *np = client->dev.of_node; 1659 1660 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 1661 return 0; 1662 } 1663 1664 static const struct i2c_device_id unittest_i2c_dev_id[] = { 1665 { .name = "unittest-i2c-dev" }, 1666 { } 1667 }; 1668 1669 static struct i2c_driver unittest_i2c_dev_driver = { 1670 .driver = { 1671 .name = "unittest-i2c-dev", 1672 }, 1673 .probe = unittest_i2c_dev_probe, 1674 .remove = unittest_i2c_dev_remove, 1675 .id_table = unittest_i2c_dev_id, 1676 }; 1677 1678 #if IS_BUILTIN(CONFIG_I2C_MUX) 1679 1680 struct unittest_i2c_mux_data { 1681 int nchans; 1682 struct i2c_adapter *adap[]; 1683 }; 1684 1685 static int unittest_i2c_mux_select_chan(struct i2c_adapter *adap, 1686 void *client, u32 chan) 1687 { 1688 return 0; 1689 } 1690 1691 static int unittest_i2c_mux_probe(struct i2c_client *client, 1692 const struct i2c_device_id *id) 1693 { 1694 int ret, i, nchans, size; 1695 struct device *dev = &client->dev; 1696 struct i2c_adapter *adap = to_i2c_adapter(dev->parent); 1697 struct device_node *np = client->dev.of_node, *child; 1698 struct unittest_i2c_mux_data *stm; 1699 u32 reg, max_reg; 1700 1701 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 1702 1703 if (!np) { 1704 dev_err(dev, "No OF node\n"); 1705 return -EINVAL; 1706 } 1707 1708 max_reg = (u32)-1; 1709 for_each_child_of_node(np, child) { 1710 ret = of_property_read_u32(child, "reg", ®); 1711 if (ret) 1712 continue; 1713 if (max_reg == (u32)-1 || reg > max_reg) 1714 max_reg = reg; 1715 } 1716 nchans = max_reg == (u32)-1 ? 0 : max_reg + 1; 1717 if (nchans == 0) { 1718 dev_err(dev, "No channels\n"); 1719 return -EINVAL; 1720 } 1721 1722 size = offsetof(struct unittest_i2c_mux_data, adap[nchans]); 1723 stm = devm_kzalloc(dev, size, GFP_KERNEL); 1724 if (!stm) { 1725 dev_err(dev, "Out of memory\n"); 1726 return -ENOMEM; 1727 } 1728 stm->nchans = nchans; 1729 for (i = 0; i < nchans; i++) { 1730 stm->adap[i] = i2c_add_mux_adapter(adap, dev, client, 1731 0, i, 0, unittest_i2c_mux_select_chan, NULL); 1732 if (!stm->adap[i]) { 1733 dev_err(dev, "Failed to register mux #%d\n", i); 1734 for (i--; i >= 0; i--) 1735 i2c_del_mux_adapter(stm->adap[i]); 1736 return -ENODEV; 1737 } 1738 } 1739 1740 i2c_set_clientdata(client, stm); 1741 1742 return 0; 1743 }; 1744 1745 static int unittest_i2c_mux_remove(struct i2c_client *client) 1746 { 1747 struct device *dev = &client->dev; 1748 struct device_node *np = client->dev.of_node; 1749 struct unittest_i2c_mux_data *stm = i2c_get_clientdata(client); 1750 int i; 1751 1752 dev_dbg(dev, "%s for node @%s\n", __func__, np->full_name); 1753 for (i = stm->nchans - 1; i >= 0; i--) 1754 i2c_del_mux_adapter(stm->adap[i]); 1755 return 0; 1756 } 1757 1758 static const struct i2c_device_id unittest_i2c_mux_id[] = { 1759 { .name = "unittest-i2c-mux" }, 1760 { } 1761 }; 1762 1763 static struct i2c_driver unittest_i2c_mux_driver = { 1764 .driver = { 1765 .name = "unittest-i2c-mux", 1766 }, 1767 .probe = unittest_i2c_mux_probe, 1768 .remove = unittest_i2c_mux_remove, 1769 .id_table = unittest_i2c_mux_id, 1770 }; 1771 1772 #endif 1773 1774 static int of_unittest_overlay_i2c_init(void) 1775 { 1776 int ret; 1777 1778 ret = i2c_add_driver(&unittest_i2c_dev_driver); 1779 if (unittest(ret == 0, 1780 "could not register unittest i2c device driver\n")) 1781 return ret; 1782 1783 ret = platform_driver_register(&unittest_i2c_bus_driver); 1784 if (unittest(ret == 0, 1785 "could not register unittest i2c bus driver\n")) 1786 return ret; 1787 1788 #if IS_BUILTIN(CONFIG_I2C_MUX) 1789 ret = i2c_add_driver(&unittest_i2c_mux_driver); 1790 if (unittest(ret == 0, 1791 "could not register unittest i2c mux driver\n")) 1792 return ret; 1793 #endif 1794 1795 return 0; 1796 } 1797 1798 static void of_unittest_overlay_i2c_cleanup(void) 1799 { 1800 #if IS_BUILTIN(CONFIG_I2C_MUX) 1801 i2c_del_driver(&unittest_i2c_mux_driver); 1802 #endif 1803 platform_driver_unregister(&unittest_i2c_bus_driver); 1804 i2c_del_driver(&unittest_i2c_dev_driver); 1805 } 1806 1807 static void of_unittest_overlay_i2c_12(void) 1808 { 1809 int ret; 1810 1811 /* device should enable */ 1812 ret = of_unittest_apply_overlay_check(12, 12, 0, 1, I2C_OVERLAY); 1813 if (ret != 0) 1814 return; 1815 1816 unittest(1, "overlay test %d passed\n", 12); 1817 } 1818 1819 /* test deactivation of device */ 1820 static void of_unittest_overlay_i2c_13(void) 1821 { 1822 int ret; 1823 1824 /* device should disable */ 1825 ret = of_unittest_apply_overlay_check(13, 13, 1, 0, I2C_OVERLAY); 1826 if (ret != 0) 1827 return; 1828 1829 unittest(1, "overlay test %d passed\n", 13); 1830 } 1831 1832 /* just check for i2c mux existence */ 1833 static void of_unittest_overlay_i2c_14(void) 1834 { 1835 } 1836 1837 static void of_unittest_overlay_i2c_15(void) 1838 { 1839 int ret; 1840 1841 /* device should enable */ 1842 ret = of_unittest_apply_overlay_check(16, 15, 0, 1, I2C_OVERLAY); 1843 if (ret != 0) 1844 return; 1845 1846 unittest(1, "overlay test %d passed\n", 15); 1847 } 1848 1849 #else 1850 1851 static inline void of_unittest_overlay_i2c_14(void) { } 1852 static inline void of_unittest_overlay_i2c_15(void) { } 1853 1854 #endif 1855 1856 static void __init of_unittest_overlay(void) 1857 { 1858 struct device_node *bus_np = NULL; 1859 int ret; 1860 1861 ret = platform_driver_register(&unittest_driver); 1862 if (ret != 0) { 1863 unittest(0, "could not register unittest driver\n"); 1864 goto out; 1865 } 1866 1867 bus_np = of_find_node_by_path(bus_path); 1868 if (bus_np == NULL) { 1869 unittest(0, "could not find bus_path \"%s\"\n", bus_path); 1870 goto out; 1871 } 1872 1873 ret = of_platform_populate(bus_np, of_default_bus_match_table, 1874 NULL, NULL); 1875 if (ret != 0) { 1876 unittest(0, "could not populate bus @ \"%s\"\n", bus_path); 1877 goto out; 1878 } 1879 1880 if (!of_unittest_device_exists(100, PDEV_OVERLAY)) { 1881 unittest(0, "could not find unittest0 @ \"%s\"\n", 1882 unittest_path(100, PDEV_OVERLAY)); 1883 goto out; 1884 } 1885 1886 if (of_unittest_device_exists(101, PDEV_OVERLAY)) { 1887 unittest(0, "unittest1 @ \"%s\" should not exist\n", 1888 unittest_path(101, PDEV_OVERLAY)); 1889 goto out; 1890 } 1891 1892 unittest(1, "basic infrastructure of overlays passed"); 1893 1894 /* tests in sequence */ 1895 of_unittest_overlay_0(); 1896 of_unittest_overlay_1(); 1897 of_unittest_overlay_2(); 1898 of_unittest_overlay_3(); 1899 of_unittest_overlay_4(); 1900 of_unittest_overlay_5(); 1901 of_unittest_overlay_6(); 1902 of_unittest_overlay_8(); 1903 1904 of_unittest_overlay_10(); 1905 of_unittest_overlay_11(); 1906 1907 #if IS_BUILTIN(CONFIG_I2C) 1908 if (unittest(of_unittest_overlay_i2c_init() == 0, "i2c init failed\n")) 1909 goto out; 1910 1911 of_unittest_overlay_i2c_12(); 1912 of_unittest_overlay_i2c_13(); 1913 of_unittest_overlay_i2c_14(); 1914 of_unittest_overlay_i2c_15(); 1915 1916 of_unittest_overlay_i2c_cleanup(); 1917 #endif 1918 1919 of_unittest_destroy_tracked_overlays(); 1920 1921 out: 1922 of_node_put(bus_np); 1923 } 1924 1925 #else 1926 static inline void __init of_unittest_overlay(void) { } 1927 #endif 1928 1929 static int __init of_unittest(void) 1930 { 1931 struct device_node *np; 1932 int res; 1933 1934 /* adding data for unittest */ 1935 res = unittest_data_add(); 1936 if (res) 1937 return res; 1938 if (!of_aliases) 1939 of_aliases = of_find_node_by_path("/aliases"); 1940 1941 np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a"); 1942 if (!np) { 1943 pr_info("No testcase data in device tree; not running tests\n"); 1944 return 0; 1945 } 1946 of_node_put(np); 1947 1948 pr_info("start of unittest - you will see error messages\n"); 1949 of_unittest_check_tree_linkage(); 1950 of_unittest_check_phandles(); 1951 of_unittest_find_node_by_name(); 1952 of_unittest_dynamic(); 1953 of_unittest_parse_phandle_with_args(); 1954 of_unittest_property_string(); 1955 of_unittest_property_copy(); 1956 of_unittest_changeset(); 1957 of_unittest_parse_interrupts(); 1958 of_unittest_parse_interrupts_extended(); 1959 of_unittest_match_node(); 1960 of_unittest_platform_populate(); 1961 of_unittest_overlay(); 1962 1963 /* Double check linkage after removing testcase data */ 1964 of_unittest_check_tree_linkage(); 1965 1966 pr_info("end of unittest - %i passed, %i failed\n", 1967 unittest_results.passed, unittest_results.failed); 1968 1969 return 0; 1970 } 1971 late_initcall(of_unittest); 1972