2 * Tests for the core driver model code
4 * Copyright (c) 2013 Google, Inc
6 * SPDX-License-Identifier: GPL-2.0+
14 #include <dm/device-internal.h>
18 #include <dm/uclass-internal.h>
21 DECLARE_GLOBAL_DATA_PTR;
27 TEST_INTVAL_MANUAL = 101112,
28 TEST_INTVAL_PRE_RELOC = 7,
31 static const struct dm_test_pdata test_pdata[] = {
32 { .ping_add = TEST_INTVAL1, },
33 { .ping_add = TEST_INTVAL2, },
34 { .ping_add = TEST_INTVAL3, },
37 static const struct dm_test_pdata test_pdata_manual = {
38 .ping_add = TEST_INTVAL_MANUAL,
41 static const struct dm_test_pdata test_pdata_pre_reloc = {
42 .ping_add = TEST_INTVAL_PRE_RELOC,
45 U_BOOT_DEVICE(dm_test_info1) = {
47 .platdata = &test_pdata[0],
50 U_BOOT_DEVICE(dm_test_info2) = {
52 .platdata = &test_pdata[1],
55 U_BOOT_DEVICE(dm_test_info3) = {
57 .platdata = &test_pdata[2],
60 static struct driver_info driver_info_manual = {
61 .name = "test_manual_drv",
62 .platdata = &test_pdata_manual,
65 static struct driver_info driver_info_pre_reloc = {
66 .name = "test_pre_reloc_drv",
67 .platdata = &test_pdata_pre_reloc,
70 void dm_leak_check_start(struct unit_test_state *uts)
72 uts->start = mallinfo();
73 if (!uts->start.uordblks)
74 puts("Warning: Please add '#define DEBUG' to the top of common/dlmalloc.c\n");
77 int dm_leak_check_end(struct unit_test_state *uts)
82 /* Don't delete the root class, since we started with that */
83 for (id = UCLASS_ROOT + 1; id < UCLASS_COUNT; id++) {
89 ut_assertok(uclass_destroy(uc));
93 diff = end.uordblks - uts->start.uordblks;
95 printf("Leak: lost %#xd bytes\n", diff);
97 printf("Leak: gained %#xd bytes\n", -diff);
98 ut_asserteq(uts->start.uordblks, end.uordblks);
103 /* Test that binding with platdata occurs correctly */
104 static int dm_test_autobind(struct unit_test_state *uts)
106 struct dm_test_state *dms = uts->priv;
110 * We should have a single class (UCLASS_ROOT) and a single root
111 * device with no children.
113 ut_assert(dms->root);
114 ut_asserteq(1, list_count_items(&gd->uclass_root));
115 ut_asserteq(0, list_count_items(&gd->dm_root->child_head));
116 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_POST_BIND]);
118 ut_assertok(dm_scan_platdata(false));
120 /* We should have our test class now at least, plus more children */
121 ut_assert(1 < list_count_items(&gd->uclass_root));
122 ut_assert(0 < list_count_items(&gd->dm_root->child_head));
124 /* Our 3 dm_test_infox children should be bound to the test uclass */
125 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_POST_BIND]);
127 /* No devices should be probed */
128 list_for_each_entry(dev, &gd->dm_root->child_head, sibling_node)
129 ut_assert(!(dev->flags & DM_FLAG_ACTIVATED));
131 /* Our test driver should have been bound 3 times */
132 ut_assert(dm_testdrv_op_count[DM_TEST_OP_BIND] == 3);
136 DM_TEST(dm_test_autobind, 0);
138 /* Test that binding with uclass platdata allocation occurs correctly */
139 static int dm_test_autobind_uclass_pdata_alloc(struct unit_test_state *uts)
141 struct dm_test_perdev_uc_pdata *uc_pdata;
145 ut_assertok(uclass_get(UCLASS_TEST, &uc));
149 * Test if test uclass driver requires allocation for the uclass
150 * platform data and then check the dev->uclass_platdata pointer.
152 ut_assert(uc->uc_drv->per_device_platdata_auto_alloc_size);
154 for (uclass_find_first_device(UCLASS_TEST, &dev);
156 uclass_find_next_device(&dev)) {
159 uc_pdata = dev_get_uclass_platdata(dev);
165 DM_TEST(dm_test_autobind_uclass_pdata_alloc, DM_TESTF_SCAN_PDATA);
167 /* Test that binding with uclass platdata setting occurs correctly */
168 static int dm_test_autobind_uclass_pdata_valid(struct unit_test_state *uts)
170 struct dm_test_perdev_uc_pdata *uc_pdata;
174 * In the test_postbind() method of test uclass driver, the uclass
175 * platform data should be set to three test int values - test it.
177 for (uclass_find_first_device(UCLASS_TEST, &dev);
179 uclass_find_next_device(&dev)) {
182 uc_pdata = dev_get_uclass_platdata(dev);
184 ut_assert(uc_pdata->intval1 == TEST_UC_PDATA_INTVAL1);
185 ut_assert(uc_pdata->intval2 == TEST_UC_PDATA_INTVAL2);
186 ut_assert(uc_pdata->intval3 == TEST_UC_PDATA_INTVAL3);
191 DM_TEST(dm_test_autobind_uclass_pdata_valid, DM_TESTF_SCAN_PDATA);
193 /* Test that autoprobe finds all the expected devices */
194 static int dm_test_autoprobe(struct unit_test_state *uts)
196 struct dm_test_state *dms = uts->priv;
197 int expected_base_add;
202 ut_assertok(uclass_get(UCLASS_TEST, &uc));
205 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_INIT]);
206 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_PRE_PROBE]);
207 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_POST_PROBE]);
209 /* The root device should not be activated until needed */
210 ut_assert(dms->root->flags & DM_FLAG_ACTIVATED);
213 * We should be able to find the three test devices, and they should
214 * all be activated as they are used (lazy activation, required by
217 for (i = 0; i < 3; i++) {
218 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
220 ut_assertf(!(dev->flags & DM_FLAG_ACTIVATED),
221 "Driver %d/%s already activated", i, dev->name);
223 /* This should activate it */
224 ut_assertok(uclass_get_device(UCLASS_TEST, i, &dev));
226 ut_assert(dev->flags & DM_FLAG_ACTIVATED);
228 /* Activating a device should activate the root device */
230 ut_assert(dms->root->flags & DM_FLAG_ACTIVATED);
234 * Our 3 dm_test_info children should be passed to pre_probe and
237 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_POST_PROBE]);
238 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_PRE_PROBE]);
240 /* Also we can check the per-device data */
241 expected_base_add = 0;
242 for (i = 0; i < 3; i++) {
243 struct dm_test_uclass_perdev_priv *priv;
244 struct dm_test_pdata *pdata;
246 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
249 priv = dev_get_uclass_priv(dev);
251 ut_asserteq(expected_base_add, priv->base_add);
253 pdata = dev->platdata;
254 expected_base_add += pdata->ping_add;
259 DM_TEST(dm_test_autoprobe, DM_TESTF_SCAN_PDATA);
261 /* Check that we see the correct platdata in each device */
262 static int dm_test_platdata(struct unit_test_state *uts)
264 const struct dm_test_pdata *pdata;
268 for (i = 0; i < 3; i++) {
269 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
271 pdata = dev->platdata;
272 ut_assert(pdata->ping_add == test_pdata[i].ping_add);
277 DM_TEST(dm_test_platdata, DM_TESTF_SCAN_PDATA);
279 /* Test that we can bind, probe, remove, unbind a driver */
280 static int dm_test_lifecycle(struct unit_test_state *uts)
282 struct dm_test_state *dms = uts->priv;
283 int op_count[DM_TEST_OP_COUNT];
284 struct udevice *dev, *test_dev;
288 memcpy(op_count, dm_testdrv_op_count, sizeof(op_count));
290 ut_assertok(device_bind_by_name(dms->root, false, &driver_info_manual,
293 ut_assert(dm_testdrv_op_count[DM_TEST_OP_BIND]
294 == op_count[DM_TEST_OP_BIND] + 1);
295 ut_assert(!dev->priv);
297 /* Probe the device - it should fail allocating private data */
298 dms->force_fail_alloc = 1;
299 ret = device_probe(dev);
300 ut_assert(ret == -ENOMEM);
301 ut_assert(dm_testdrv_op_count[DM_TEST_OP_PROBE]
302 == op_count[DM_TEST_OP_PROBE] + 1);
303 ut_assert(!dev->priv);
305 /* Try again without the alloc failure */
306 dms->force_fail_alloc = 0;
307 ut_assertok(device_probe(dev));
308 ut_assert(dm_testdrv_op_count[DM_TEST_OP_PROBE]
309 == op_count[DM_TEST_OP_PROBE] + 2);
310 ut_assert(dev->priv);
312 /* This should be device 3 in the uclass */
313 ut_assertok(uclass_find_device(UCLASS_TEST, 3, &test_dev));
314 ut_assert(dev == test_dev);
317 ut_assertok(test_ping(dev, 100, &pingret));
318 ut_assert(pingret == 102);
320 /* Now remove device 3 */
321 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_PRE_REMOVE]);
322 ut_assertok(device_remove(dev));
323 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_PRE_REMOVE]);
325 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
326 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_PRE_UNBIND]);
327 ut_assertok(device_unbind(dev));
328 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
329 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_PRE_UNBIND]);
333 DM_TEST(dm_test_lifecycle, DM_TESTF_SCAN_PDATA | DM_TESTF_PROBE_TEST);
335 /* Test that we can bind/unbind and the lists update correctly */
336 static int dm_test_ordering(struct unit_test_state *uts)
338 struct dm_test_state *dms = uts->priv;
339 struct udevice *dev, *dev_penultimate, *dev_last, *test_dev;
342 ut_assertok(device_bind_by_name(dms->root, false, &driver_info_manual,
346 /* Bind two new devices (numbers 4 and 5) */
347 ut_assertok(device_bind_by_name(dms->root, false, &driver_info_manual,
349 ut_assert(dev_penultimate);
350 ut_assertok(device_bind_by_name(dms->root, false, &driver_info_manual,
354 /* Now remove device 3 */
355 ut_assertok(device_remove(dev));
356 ut_assertok(device_unbind(dev));
358 /* The device numbering should have shifted down one */
359 ut_assertok(uclass_find_device(UCLASS_TEST, 3, &test_dev));
360 ut_assert(dev_penultimate == test_dev);
361 ut_assertok(uclass_find_device(UCLASS_TEST, 4, &test_dev));
362 ut_assert(dev_last == test_dev);
364 /* Add back the original device 3, now in position 5 */
365 ut_assertok(device_bind_by_name(dms->root, false, &driver_info_manual,
370 ut_assertok(test_ping(dev, 100, &pingret));
371 ut_assert(pingret == 102);
374 ut_assertok(device_remove(dev_penultimate));
375 ut_assertok(device_unbind(dev_penultimate));
376 ut_assertok(device_remove(dev_last));
377 ut_assertok(device_unbind(dev_last));
379 /* Our device should now be in position 3 */
380 ut_assertok(uclass_find_device(UCLASS_TEST, 3, &test_dev));
381 ut_assert(dev == test_dev);
383 /* Now remove device 3 */
384 ut_assertok(device_remove(dev));
385 ut_assertok(device_unbind(dev));
389 DM_TEST(dm_test_ordering, DM_TESTF_SCAN_PDATA);
391 /* Check that we can perform operations on a device (do a ping) */
392 int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
393 uint32_t base, struct dm_test_priv *priv)
398 /* Getting the child device should allocate platdata / priv */
399 ut_assertok(testfdt_ping(dev, 10, &pingret));
400 ut_assert(dev->priv);
401 ut_assert(dev->platdata);
403 expected = 10 + base;
404 ut_asserteq(expected, pingret);
406 /* Do another ping */
407 ut_assertok(testfdt_ping(dev, 20, &pingret));
408 expected = 20 + base;
409 ut_asserteq(expected, pingret);
411 /* Now check the ping_total */
413 ut_asserteq(DM_TEST_START_TOTAL + 10 + 20 + base * 2,
419 /* Check that we can perform operations on devices */
420 static int dm_test_operations(struct unit_test_state *uts)
426 * Now check that the ping adds are what we expect. This is using the
427 * ping-add property in each node.
429 for (i = 0; i < ARRAY_SIZE(test_pdata); i++) {
432 ut_assertok(uclass_get_device(UCLASS_TEST, i, &dev));
435 * Get the 'reg' property, which tells us what the ping add
436 * should be. We don't use the platdata because we want
437 * to test the code that sets that up (testfdt_drv_probe()).
439 base = test_pdata[i].ping_add;
440 debug("dev=%d, base=%d\n", i, base);
442 ut_assert(!dm_check_operations(uts, dev, base, dev->priv));
447 DM_TEST(dm_test_operations, DM_TESTF_SCAN_PDATA);
449 /* Remove all drivers and check that things work */
450 static int dm_test_remove(struct unit_test_state *uts)
455 for (i = 0; i < 3; i++) {
456 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
458 ut_assertf(dev->flags & DM_FLAG_ACTIVATED,
459 "Driver %d/%s not activated", i, dev->name);
460 ut_assertok(device_remove(dev));
461 ut_assertf(!(dev->flags & DM_FLAG_ACTIVATED),
462 "Driver %d/%s should have deactivated", i,
464 ut_assert(!dev->priv);
469 DM_TEST(dm_test_remove, DM_TESTF_SCAN_PDATA | DM_TESTF_PROBE_TEST);
471 /* Remove and recreate everything, check for memory leaks */
472 static int dm_test_leak(struct unit_test_state *uts)
476 for (i = 0; i < 2; i++) {
481 dm_leak_check_start(uts);
483 ut_assertok(dm_scan_platdata(false));
484 ut_assertok(dm_scan_fdt(gd->fdt_blob, false));
486 /* Scanning the uclass is enough to probe all the devices */
487 for (id = UCLASS_ROOT; id < UCLASS_COUNT; id++) {
488 for (ret = uclass_first_device(UCLASS_TEST, &dev);
490 ret = uclass_next_device(&dev))
495 ut_assertok(dm_leak_check_end(uts));
500 DM_TEST(dm_test_leak, 0);
502 /* Test uclass init/destroy methods */
503 static int dm_test_uclass(struct unit_test_state *uts)
507 ut_assertok(uclass_get(UCLASS_TEST, &uc));
508 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_INIT]);
509 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_DESTROY]);
512 ut_assertok(uclass_destroy(uc));
513 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_INIT]);
514 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_DESTROY]);
518 DM_TEST(dm_test_uclass, 0);
521 * create_children() - Create children of a parent node
523 * @dms: Test system state
524 * @parent: Parent device
525 * @count: Number of children to create
526 * @key: Key value to put in first child. Subsequence children
527 * receive an incrementing value
528 * @child: If not NULL, then the child device pointers are written into
530 * @return 0 if OK, -ve on error
532 static int create_children(struct unit_test_state *uts, struct udevice *parent,
533 int count, int key, struct udevice *child[])
538 for (i = 0; i < count; i++) {
539 struct dm_test_pdata *pdata;
541 ut_assertok(device_bind_by_name(parent, false,
542 &driver_info_manual, &dev));
543 pdata = calloc(1, sizeof(*pdata));
544 pdata->ping_add = key + i;
545 dev->platdata = pdata;
553 #define NODE_COUNT 10
555 static int dm_test_children(struct unit_test_state *uts)
557 struct dm_test_state *dms = uts->priv;
558 struct udevice *top[NODE_COUNT];
559 struct udevice *child[NODE_COUNT];
560 struct udevice *grandchild[NODE_COUNT];
566 /* We don't care about the numbering for this test */
567 dms->skip_post_probe = 1;
569 ut_assert(NODE_COUNT > 5);
571 /* First create 10 top-level children */
572 ut_assertok(create_children(uts, dms->root, NODE_COUNT, 0, top));
574 /* Now a few have their own children */
575 ut_assertok(create_children(uts, top[2], NODE_COUNT, 2, NULL));
576 ut_assertok(create_children(uts, top[5], NODE_COUNT, 5, child));
578 /* And grandchildren */
579 for (i = 0; i < NODE_COUNT; i++)
580 ut_assertok(create_children(uts, child[i], NODE_COUNT, 50 * i,
581 i == 2 ? grandchild : NULL));
583 /* Check total number of devices */
584 total = NODE_COUNT * (3 + NODE_COUNT);
585 ut_asserteq(total, dm_testdrv_op_count[DM_TEST_OP_BIND]);
587 /* Try probing one of the grandchildren */
588 ut_assertok(uclass_get_device(UCLASS_TEST,
589 NODE_COUNT * 3 + 2 * NODE_COUNT, &dev));
590 ut_asserteq_ptr(grandchild[0], dev);
593 * This should have probed the child and top node also, for a total
596 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_PROBE]);
598 /* Probe the other grandchildren */
599 for (i = 1; i < NODE_COUNT; i++)
600 ut_assertok(device_probe(grandchild[i]));
602 ut_asserteq(2 + NODE_COUNT, dm_testdrv_op_count[DM_TEST_OP_PROBE]);
604 /* Probe everything */
605 for (ret = uclass_first_device(UCLASS_TEST, &dev);
607 ret = uclass_next_device(&dev))
611 ut_asserteq(total, dm_testdrv_op_count[DM_TEST_OP_PROBE]);
613 /* Remove a top-level child and check that the children are removed */
614 ut_assertok(device_remove(top[2]));
615 ut_asserteq(NODE_COUNT + 1, dm_testdrv_op_count[DM_TEST_OP_REMOVE]);
616 dm_testdrv_op_count[DM_TEST_OP_REMOVE] = 0;
618 /* Try one with grandchildren */
619 ut_assertok(uclass_get_device(UCLASS_TEST, 5, &dev));
620 ut_asserteq_ptr(dev, top[5]);
621 ut_assertok(device_remove(dev));
622 ut_asserteq(1 + NODE_COUNT * (1 + NODE_COUNT),
623 dm_testdrv_op_count[DM_TEST_OP_REMOVE]);
625 /* Try the same with unbind */
626 ut_assertok(device_unbind(top[2]));
627 ut_asserteq(NODE_COUNT + 1, dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
628 dm_testdrv_op_count[DM_TEST_OP_UNBIND] = 0;
630 /* Try one with grandchildren */
631 ut_assertok(uclass_get_device(UCLASS_TEST, 5, &dev));
632 ut_asserteq_ptr(dev, top[6]);
633 ut_assertok(device_unbind(top[5]));
634 ut_asserteq(1 + NODE_COUNT * (1 + NODE_COUNT),
635 dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
639 DM_TEST(dm_test_children, 0);
641 /* Test that pre-relocation devices work as expected */
642 static int dm_test_pre_reloc(struct unit_test_state *uts)
644 struct dm_test_state *dms = uts->priv;
647 /* The normal driver should refuse to bind before relocation */
648 ut_asserteq(-EPERM, device_bind_by_name(dms->root, true,
649 &driver_info_manual, &dev));
651 /* But this one is marked pre-reloc */
652 ut_assertok(device_bind_by_name(dms->root, true,
653 &driver_info_pre_reloc, &dev));
657 DM_TEST(dm_test_pre_reloc, 0);
659 static int dm_test_uclass_before_ready(struct unit_test_state *uts)
663 ut_assertok(uclass_get(UCLASS_TEST, &uc));
666 gd->dm_root_f = NULL;
667 memset(&gd->uclass_root, '\0', sizeof(gd->uclass_root));
669 ut_asserteq_ptr(NULL, uclass_find(UCLASS_TEST));
673 DM_TEST(dm_test_uclass_before_ready, 0);
675 static int dm_test_uclass_devices_find(struct unit_test_state *uts)
680 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
682 ret = uclass_find_next_device(&dev)) {
689 DM_TEST(dm_test_uclass_devices_find, DM_TESTF_SCAN_PDATA);
691 static int dm_test_uclass_devices_find_by_name(struct unit_test_state *uts)
693 struct udevice *finddev;
694 struct udevice *testdev;
698 * For each test device found in fdt like: "a-test", "b-test", etc.,
699 * use its name and try to find it by uclass_find_device_by_name().
700 * Then, on success check if:
701 * - current 'testdev' name is equal to the returned 'finddev' name
702 * - current 'testdev' pointer is equal to the returned 'finddev'
704 * We assume that, each uclass's device name is unique, so if not, then
705 * this will fail on checking condition: testdev == finddev, since the
706 * uclass_find_device_by_name(), returns the first device by given name.
708 for (ret = uclass_find_first_device(UCLASS_TEST_FDT, &testdev);
710 ret = uclass_find_next_device(&testdev)) {
714 findret = uclass_find_device_by_name(UCLASS_TEST_FDT,
718 ut_assertok(findret);
720 ut_asserteq_str(testdev->name, finddev->name);
721 ut_asserteq_ptr(testdev, finddev);
726 DM_TEST(dm_test_uclass_devices_find_by_name, DM_TESTF_SCAN_FDT);
728 static int dm_test_uclass_devices_get(struct unit_test_state *uts)
733 for (ret = uclass_first_device(UCLASS_TEST, &dev);
735 ret = uclass_next_device(&dev)) {
738 ut_assert(device_active(dev));
743 DM_TEST(dm_test_uclass_devices_get, DM_TESTF_SCAN_PDATA);
745 static int dm_test_uclass_devices_get_by_name(struct unit_test_state *uts)
747 struct udevice *finddev;
748 struct udevice *testdev;
752 * For each test device found in fdt like: "a-test", "b-test", etc.,
753 * use its name and try to get it by uclass_get_device_by_name().
754 * On success check if:
755 * - returned finddev' is active
756 * - current 'testdev' name is equal to the returned 'finddev' name
757 * - current 'testdev' pointer is equal to the returned 'finddev'
759 * We asserts that the 'testdev' is active on each loop entry, so we
760 * could be sure that the 'finddev' is activated too, but for sure
763 * We assume that, each uclass's device name is unique, so if not, then
764 * this will fail on checking condition: testdev == finddev, since the
765 * uclass_get_device_by_name(), returns the first device by given name.
767 for (ret = uclass_first_device(UCLASS_TEST_FDT, &testdev);
769 ret = uclass_next_device(&testdev)) {
772 ut_assert(device_active(testdev));
774 findret = uclass_get_device_by_name(UCLASS_TEST_FDT,
778 ut_assertok(findret);
780 ut_assert(device_active(finddev));
781 ut_asserteq_str(testdev->name, finddev->name);
782 ut_asserteq_ptr(testdev, finddev);
787 DM_TEST(dm_test_uclass_devices_get_by_name, DM_TESTF_SCAN_FDT);
789 static int dm_test_device_get_uclass_id(struct unit_test_state *uts)
793 ut_assertok(uclass_get_device(UCLASS_TEST, 0, &dev));
794 ut_asserteq(UCLASS_TEST, device_get_uclass_id(dev));
798 DM_TEST(dm_test_device_get_uclass_id, DM_TESTF_SCAN_PDATA);