1 // SPDX-License-Identifier: GPL-2.0+
3 * Tests for the core driver model code
5 * Copyright (c) 2013 Google, Inc
14 #include <asm/global_data.h>
15 #include <dm/device-internal.h>
19 #include <dm/uclass-internal.h>
20 #include <test/test.h>
23 DECLARE_GLOBAL_DATA_PTR;
29 TEST_INTVAL_MANUAL = 101112,
30 TEST_INTVAL_PRE_RELOC = 7,
33 static const struct dm_test_pdata test_pdata[] = {
34 { .ping_add = TEST_INTVAL1, },
35 { .ping_add = TEST_INTVAL2, },
36 { .ping_add = TEST_INTVAL3, },
39 static const struct dm_test_pdata test_pdata_manual = {
40 .ping_add = TEST_INTVAL_MANUAL,
43 static const struct dm_test_pdata test_pdata_pre_reloc = {
44 .ping_add = TEST_INTVAL_PRE_RELOC,
47 U_BOOT_DRVINFO(dm_test_info1) = {
49 .plat = &test_pdata[0],
52 U_BOOT_DRVINFO(dm_test_info2) = {
54 .plat = &test_pdata[1],
57 U_BOOT_DRVINFO(dm_test_info3) = {
59 .plat = &test_pdata[2],
62 static struct driver_info driver_info_manual = {
63 .name = "test_manual_drv",
64 .plat = &test_pdata_manual,
67 static struct driver_info driver_info_pre_reloc = {
68 .name = "test_pre_reloc_drv",
69 .plat = &test_pdata_pre_reloc,
72 static struct driver_info driver_info_act_dma = {
73 .name = "test_act_dma_drv",
76 static struct driver_info driver_info_vital_clk = {
77 .name = "test_vital_clk_drv",
80 static struct driver_info driver_info_act_dma_vital_clk = {
81 .name = "test_act_dma_vital_clk_drv",
84 void dm_leak_check_start(struct unit_test_state *uts)
86 uts->start = mallinfo();
87 if (!uts->start.uordblks)
88 puts("Warning: Please add '#define DEBUG' to the top of common/dlmalloc.c\n");
91 int dm_leak_check_end(struct unit_test_state *uts)
96 /* Don't delete the root class, since we started with that */
97 for (id = UCLASS_ROOT + 1; id < UCLASS_COUNT; id++) {
100 uc = uclass_find(id);
103 ut_assertok(uclass_destroy(uc));
107 diff = end.uordblks - uts->start.uordblks;
109 printf("Leak: lost %#xd bytes\n", diff);
111 printf("Leak: gained %#xd bytes\n", -diff);
112 ut_asserteq(uts->start.uordblks, end.uordblks);
117 /* Test that binding with plat occurs correctly */
118 static int dm_test_autobind(struct unit_test_state *uts)
123 * We should have a single class (UCLASS_ROOT) and a single root
124 * device with no children.
126 ut_assert(uts->root);
127 ut_asserteq(1, list_count_items(gd->uclass_root));
128 ut_asserteq(0, list_count_items(&gd->dm_root->child_head));
129 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_POST_BIND]);
131 ut_assertok(dm_scan_plat(false));
133 /* We should have our test class now at least, plus more children */
134 ut_assert(1 < list_count_items(gd->uclass_root));
135 ut_assert(0 < list_count_items(&gd->dm_root->child_head));
137 /* Our 3 dm_test_infox children should be bound to the test uclass */
138 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_POST_BIND]);
140 /* No devices should be probed */
141 list_for_each_entry(dev, &gd->dm_root->child_head, sibling_node)
142 ut_assert(!(dev_get_flags(dev) & DM_FLAG_ACTIVATED));
144 /* Our test driver should have been bound 3 times */
145 ut_assert(dm_testdrv_op_count[DM_TEST_OP_BIND] == 3);
149 DM_TEST(dm_test_autobind, 0);
151 /* Test that binding with uclass plat allocation occurs correctly */
152 static int dm_test_autobind_uclass_pdata_alloc(struct unit_test_state *uts)
154 struct dm_test_perdev_uc_pdata *uc_pdata;
158 ut_assertok(uclass_get(UCLASS_TEST, &uc));
162 * Test if test uclass driver requires allocation for the uclass
163 * platform data and then check the dev->uclass_plat pointer.
165 ut_assert(uc->uc_drv->per_device_plat_auto);
167 for (uclass_find_first_device(UCLASS_TEST, &dev);
169 uclass_find_next_device(&dev)) {
170 ut_assertnonnull(dev);
172 uc_pdata = dev_get_uclass_plat(dev);
178 DM_TEST(dm_test_autobind_uclass_pdata_alloc, UT_TESTF_SCAN_PDATA);
180 /* compare node names ignoring the unit address */
181 static int dm_test_compare_node_name(struct unit_test_state *uts)
185 node = ofnode_path("/mmio-bus@0");
186 ut_assert(ofnode_valid(node));
187 ut_assert(ofnode_name_eq(node, "mmio-bus"));
192 DM_TEST(dm_test_compare_node_name, UT_TESTF_SCAN_PDATA);
194 /* Test that binding with uclass plat setting occurs correctly */
195 static int dm_test_autobind_uclass_pdata_valid(struct unit_test_state *uts)
197 struct dm_test_perdev_uc_pdata *uc_pdata;
201 * In the test_postbind() method of test uclass driver, the uclass
202 * platform data should be set to three test int values - test it.
204 for (uclass_find_first_device(UCLASS_TEST, &dev);
206 uclass_find_next_device(&dev)) {
207 ut_assertnonnull(dev);
209 uc_pdata = dev_get_uclass_plat(dev);
211 ut_assert(uc_pdata->intval1 == TEST_UC_PDATA_INTVAL1);
212 ut_assert(uc_pdata->intval2 == TEST_UC_PDATA_INTVAL2);
213 ut_assert(uc_pdata->intval3 == TEST_UC_PDATA_INTVAL3);
218 DM_TEST(dm_test_autobind_uclass_pdata_valid, UT_TESTF_SCAN_PDATA);
220 /* Test that autoprobe finds all the expected devices */
221 static int dm_test_autoprobe(struct unit_test_state *uts)
223 int expected_base_add;
228 ut_assertok(uclass_get(UCLASS_TEST, &uc));
231 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_INIT]);
232 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_PRE_PROBE]);
233 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_POST_PROBE]);
235 /* The root device should not be activated until needed */
236 ut_assert(dev_get_flags(uts->root) & DM_FLAG_ACTIVATED);
239 * We should be able to find the three test devices, and they should
240 * all be activated as they are used (lazy activation, required by
243 for (i = 0; i < 3; i++) {
244 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
246 ut_assertf(!(dev_get_flags(dev) & DM_FLAG_ACTIVATED),
247 "Driver %d/%s already activated", i, dev->name);
249 /* This should activate it */
250 ut_assertok(uclass_get_device(UCLASS_TEST, i, &dev));
252 ut_assert(dev_get_flags(dev) & DM_FLAG_ACTIVATED);
254 /* Activating a device should activate the root device */
256 ut_assert(dev_get_flags(uts->root) & DM_FLAG_ACTIVATED);
260 * Our 3 dm_test_info children should be passed to pre_probe and
263 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_POST_PROBE]);
264 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_PRE_PROBE]);
266 /* Also we can check the per-device data */
267 expected_base_add = 0;
268 for (i = 0; i < 3; i++) {
269 struct dm_test_uclass_perdev_priv *priv;
270 struct dm_test_pdata *pdata;
272 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
275 priv = dev_get_uclass_priv(dev);
277 ut_asserteq(expected_base_add, priv->base_add);
279 pdata = dev_get_plat(dev);
280 expected_base_add += pdata->ping_add;
285 DM_TEST(dm_test_autoprobe, UT_TESTF_SCAN_PDATA);
287 /* Check that we see the correct plat in each device */
288 static int dm_test_plat(struct unit_test_state *uts)
290 const struct dm_test_pdata *pdata;
294 for (i = 0; i < 3; i++) {
295 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
297 pdata = dev_get_plat(dev);
298 ut_assert(pdata->ping_add == test_pdata[i].ping_add);
303 DM_TEST(dm_test_plat, UT_TESTF_SCAN_PDATA);
305 /* Test that we can bind, probe, remove, unbind a driver */
306 static int dm_test_lifecycle(struct unit_test_state *uts)
308 int op_count[DM_TEST_OP_COUNT];
309 struct udevice *dev, *test_dev;
310 int start_dev_count, start_uc_count;
311 int dev_count, uc_count;
315 memcpy(op_count, dm_testdrv_op_count, sizeof(op_count));
317 dm_get_stats(&start_dev_count, &start_uc_count);
319 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_manual,
322 ut_assert(dm_testdrv_op_count[DM_TEST_OP_BIND]
323 == op_count[DM_TEST_OP_BIND] + 1);
324 ut_assert(!dev_get_priv(dev));
326 /* We should have one more device */
327 dm_get_stats(&dev_count, &uc_count);
328 ut_asserteq(start_dev_count + 1, dev_count);
329 ut_asserteq(start_uc_count, uc_count);
331 /* Probe the device - it should fail allocating private data */
332 uts->force_fail_alloc = 1;
333 ret = device_probe(dev);
334 ut_assert(ret == -ENOMEM);
335 ut_assert(dm_testdrv_op_count[DM_TEST_OP_PROBE]
336 == op_count[DM_TEST_OP_PROBE] + 1);
337 ut_assert(!dev_get_priv(dev));
339 /* Try again without the alloc failure */
340 uts->force_fail_alloc = 0;
341 ut_assertok(device_probe(dev));
342 ut_assert(dm_testdrv_op_count[DM_TEST_OP_PROBE]
343 == op_count[DM_TEST_OP_PROBE] + 2);
344 ut_assert(dev_get_priv(dev));
346 /* This should be device 3 in the uclass */
347 ut_assertok(uclass_find_device(UCLASS_TEST, 3, &test_dev));
348 ut_assert(dev == test_dev);
351 ut_assertok(test_ping(dev, 100, &pingret));
352 ut_assert(pingret == 102);
354 /* Now remove device 3 */
355 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_PRE_REMOVE]);
356 ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
357 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_PRE_REMOVE]);
359 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
360 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_PRE_UNBIND]);
361 ut_assertok(device_unbind(dev));
362 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
363 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_PRE_UNBIND]);
365 /* We should have one less device */
366 dm_get_stats(&dev_count, &uc_count);
367 ut_asserteq(start_dev_count, dev_count);
368 ut_asserteq(start_uc_count, uc_count);
372 DM_TEST(dm_test_lifecycle, UT_TESTF_SCAN_PDATA | UT_TESTF_PROBE_TEST);
374 /* Test that we can bind/unbind and the lists update correctly */
375 static int dm_test_ordering(struct unit_test_state *uts)
377 struct udevice *dev, *dev_penultimate, *dev_last, *test_dev;
380 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_manual,
384 /* Bind two new devices (numbers 4 and 5) */
385 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_manual,
387 ut_assert(dev_penultimate);
388 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_manual,
392 /* Now remove device 3 */
393 ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
394 ut_assertok(device_unbind(dev));
396 /* The device numbering should have shifted down one */
397 ut_assertok(uclass_find_device(UCLASS_TEST, 3, &test_dev));
398 ut_assert(dev_penultimate == test_dev);
399 ut_assertok(uclass_find_device(UCLASS_TEST, 4, &test_dev));
400 ut_assert(dev_last == test_dev);
402 /* Add back the original device 3, now in position 5 */
403 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_manual,
408 ut_assertok(test_ping(dev, 100, &pingret));
409 ut_assert(pingret == 102);
412 ut_assertok(device_remove(dev_penultimate, DM_REMOVE_NORMAL));
413 ut_assertok(device_unbind(dev_penultimate));
414 ut_assertok(device_remove(dev_last, DM_REMOVE_NORMAL));
415 ut_assertok(device_unbind(dev_last));
417 /* Our device should now be in position 3 */
418 ut_assertok(uclass_find_device(UCLASS_TEST, 3, &test_dev));
419 ut_assert(dev == test_dev);
421 /* Now remove device 3 */
422 ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
423 ut_assertok(device_unbind(dev));
427 DM_TEST(dm_test_ordering, UT_TESTF_SCAN_PDATA);
429 /* Check that we can perform operations on a device (do a ping) */
430 int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
431 uint32_t base, struct dm_test_priv *priv)
436 /* Getting the child device should allocate plat / priv */
437 ut_assertok(testfdt_ping(dev, 10, &pingret));
438 ut_assert(dev_get_priv(dev));
439 ut_assert(dev_get_plat(dev));
441 expected = 10 + base;
442 ut_asserteq(expected, pingret);
444 /* Do another ping */
445 ut_assertok(testfdt_ping(dev, 20, &pingret));
446 expected = 20 + base;
447 ut_asserteq(expected, pingret);
449 /* Now check the ping_total */
450 priv = dev_get_priv(dev);
451 ut_asserteq(DM_TEST_START_TOTAL + 10 + 20 + base * 2,
457 /* Check that we can perform operations on devices */
458 static int dm_test_operations(struct unit_test_state *uts)
464 * Now check that the ping adds are what we expect. This is using the
465 * ping-add property in each node.
467 for (i = 0; i < ARRAY_SIZE(test_pdata); i++) {
470 ut_assertok(uclass_get_device(UCLASS_TEST, i, &dev));
473 * Get the 'reg' property, which tells us what the ping add
474 * should be. We don't use the plat because we want
475 * to test the code that sets that up (testfdt_drv_probe()).
477 base = test_pdata[i].ping_add;
478 debug("dev=%d, base=%d\n", i, base);
480 ut_assert(!dm_check_operations(uts, dev, base, dev_get_priv(dev)));
485 DM_TEST(dm_test_operations, UT_TESTF_SCAN_PDATA);
487 /* Remove all drivers and check that things work */
488 static int dm_test_remove(struct unit_test_state *uts)
493 for (i = 0; i < 3; i++) {
494 ut_assertok(uclass_find_device(UCLASS_TEST, i, &dev));
496 ut_assertf(dev_get_flags(dev) & DM_FLAG_ACTIVATED,
497 "Driver %d/%s not activated", i, dev->name);
498 ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
499 ut_assertf(!(dev_get_flags(dev) & DM_FLAG_ACTIVATED),
500 "Driver %d/%s should have deactivated", i,
502 ut_assert(!dev_get_priv(dev));
507 DM_TEST(dm_test_remove, UT_TESTF_SCAN_PDATA | UT_TESTF_PROBE_TEST);
509 /* Remove and recreate everything, check for memory leaks */
510 static int dm_test_leak(struct unit_test_state *uts)
514 for (i = 0; i < 2; i++) {
517 dm_leak_check_start(uts);
519 ut_assertok(dm_scan_plat(false));
520 ut_assertok(dm_scan_fdt(false));
522 ret = uclass_probe_all(UCLASS_TEST);
525 ut_assertok(dm_leak_check_end(uts));
530 DM_TEST(dm_test_leak, 0);
532 /* Test uclass init/destroy methods */
533 static int dm_test_uclass(struct unit_test_state *uts)
535 int dev_count, uc_count;
538 /* We should have just the root device and uclass */
539 dm_get_stats(&dev_count, &uc_count);
540 ut_asserteq(1, dev_count);
541 ut_asserteq(1, uc_count);
543 ut_assertok(uclass_get(UCLASS_TEST, &uc));
544 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_INIT]);
545 ut_asserteq(0, dm_testdrv_op_count[DM_TEST_OP_DESTROY]);
546 ut_assert(uclass_get_priv(uc));
548 dm_get_stats(&dev_count, &uc_count);
549 ut_asserteq(1, dev_count);
550 ut_asserteq(2, uc_count);
552 ut_assertok(uclass_destroy(uc));
553 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_INIT]);
554 ut_asserteq(1, dm_testdrv_op_count[DM_TEST_OP_DESTROY]);
556 dm_get_stats(&dev_count, &uc_count);
557 ut_asserteq(1, dev_count);
558 ut_asserteq(1, uc_count);
562 DM_TEST(dm_test_uclass, 0);
565 * create_children() - Create children of a parent node
567 * @dms: Test system state
568 * @parent: Parent device
569 * @count: Number of children to create
570 * @key: Key value to put in first child. Subsequence children
571 * receive an incrementing value
572 * @child: If not NULL, then the child device pointers are written into
574 * Return: 0 if OK, -ve on error
576 static int create_children(struct unit_test_state *uts, struct udevice *parent,
577 int count, int key, struct udevice *child[])
582 for (i = 0; i < count; i++) {
583 struct dm_test_pdata *pdata;
585 ut_assertok(device_bind_by_name(parent, false,
586 &driver_info_manual, &dev));
587 pdata = calloc(1, sizeof(*pdata));
588 pdata->ping_add = key + i;
589 dev_set_plat(dev, pdata);
597 #define NODE_COUNT 10
599 static int dm_test_children(struct unit_test_state *uts)
601 struct udevice *top[NODE_COUNT];
602 struct udevice *child[NODE_COUNT];
603 struct udevice *grandchild[NODE_COUNT];
609 /* We don't care about the numbering for this test */
610 uts->skip_post_probe = 1;
612 ut_assert(NODE_COUNT > 5);
614 /* First create 10 top-level children */
615 ut_assertok(create_children(uts, uts->root, NODE_COUNT, 0, top));
617 /* Now a few have their own children */
618 ut_assertok(create_children(uts, top[2], NODE_COUNT, 2, NULL));
619 ut_assertok(create_children(uts, top[5], NODE_COUNT, 5, child));
621 /* And grandchildren */
622 for (i = 0; i < NODE_COUNT; i++)
623 ut_assertok(create_children(uts, child[i], NODE_COUNT, 50 * i,
624 i == 2 ? grandchild : NULL));
626 /* Check total number of devices */
627 total = NODE_COUNT * (3 + NODE_COUNT);
628 ut_asserteq(total, dm_testdrv_op_count[DM_TEST_OP_BIND]);
630 /* Try probing one of the grandchildren */
631 ut_assertok(uclass_get_device(UCLASS_TEST,
632 NODE_COUNT * 3 + 2 * NODE_COUNT, &dev));
633 ut_asserteq_ptr(grandchild[0], dev);
636 * This should have probed the child and top node also, for a total
639 ut_asserteq(3, dm_testdrv_op_count[DM_TEST_OP_PROBE]);
641 /* Probe the other grandchildren */
642 for (i = 1; i < NODE_COUNT; i++)
643 ut_assertok(device_probe(grandchild[i]));
645 ut_asserteq(2 + NODE_COUNT, dm_testdrv_op_count[DM_TEST_OP_PROBE]);
647 /* Probe everything */
648 ret = uclass_probe_all(UCLASS_TEST);
651 ut_asserteq(total, dm_testdrv_op_count[DM_TEST_OP_PROBE]);
653 /* Remove a top-level child and check that the children are removed */
654 ut_assertok(device_remove(top[2], DM_REMOVE_NORMAL));
655 ut_asserteq(NODE_COUNT + 1, dm_testdrv_op_count[DM_TEST_OP_REMOVE]);
656 dm_testdrv_op_count[DM_TEST_OP_REMOVE] = 0;
658 /* Try one with grandchildren */
659 ut_assertok(uclass_get_device(UCLASS_TEST, 5, &dev));
660 ut_asserteq_ptr(dev, top[5]);
661 ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
662 ut_asserteq(1 + NODE_COUNT * (1 + NODE_COUNT),
663 dm_testdrv_op_count[DM_TEST_OP_REMOVE]);
665 /* Try the same with unbind */
666 ut_assertok(device_unbind(top[2]));
667 ut_asserteq(NODE_COUNT + 1, dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
668 dm_testdrv_op_count[DM_TEST_OP_UNBIND] = 0;
670 /* Try one with grandchildren */
671 ut_assertok(uclass_get_device(UCLASS_TEST, 5, &dev));
672 ut_asserteq_ptr(dev, top[6]);
673 ut_assertok(device_unbind(top[5]));
674 ut_asserteq(1 + NODE_COUNT * (1 + NODE_COUNT),
675 dm_testdrv_op_count[DM_TEST_OP_UNBIND]);
679 DM_TEST(dm_test_children, 0);
681 static int dm_test_device_reparent(struct unit_test_state *uts)
683 struct udevice *top[NODE_COUNT];
684 struct udevice *child[NODE_COUNT];
685 struct udevice *grandchild[NODE_COUNT];
691 /* We don't care about the numbering for this test */
692 uts->skip_post_probe = 1;
694 ut_assert(NODE_COUNT > 5);
696 /* First create 10 top-level children */
697 ut_assertok(create_children(uts, uts->root, NODE_COUNT, 0, top));
699 /* Now a few have their own children */
700 ut_assertok(create_children(uts, top[2], NODE_COUNT, 2, NULL));
701 ut_assertok(create_children(uts, top[5], NODE_COUNT, 5, child));
703 /* And grandchildren */
704 for (i = 0; i < NODE_COUNT; i++)
705 ut_assertok(create_children(uts, child[i], NODE_COUNT, 50 * i,
706 i == 2 ? grandchild : NULL));
708 /* Check total number of devices */
709 total = NODE_COUNT * (3 + NODE_COUNT);
710 ut_asserteq(total, dm_testdrv_op_count[DM_TEST_OP_BIND]);
712 /* Probe everything */
713 for (i = 0; i < total; i++)
714 ut_assertok(uclass_get_device(UCLASS_TEST, i, &dev));
716 /* Re-parent top-level children with no grandchildren. */
717 ut_assertok(device_reparent(top[3], top[0]));
718 /* try to get devices */
719 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
721 ret = uclass_find_next_device(&dev)) {
723 ut_assertnonnull(dev);
726 ut_assertok(device_reparent(top[4], top[0]));
727 /* try to get devices */
728 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
730 ret = uclass_find_next_device(&dev)) {
732 ut_assertnonnull(dev);
735 /* Re-parent top-level children with grandchildren. */
736 ut_assertok(device_reparent(top[2], top[0]));
737 /* try to get devices */
738 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
740 ret = uclass_find_next_device(&dev)) {
742 ut_assertnonnull(dev);
745 ut_assertok(device_reparent(top[5], top[2]));
746 /* try to get devices */
747 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
749 ret = uclass_find_next_device(&dev)) {
751 ut_assertnonnull(dev);
754 /* Re-parent grandchildren. */
755 ut_assertok(device_reparent(grandchild[0], top[1]));
756 /* try to get devices */
757 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
759 ret = uclass_find_next_device(&dev)) {
761 ut_assertnonnull(dev);
764 ut_assertok(device_reparent(grandchild[1], top[1]));
765 /* try to get devices */
766 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
768 ret = uclass_find_next_device(&dev)) {
770 ut_assertnonnull(dev);
773 /* Remove re-pareneted devices. */
774 ut_assertok(device_remove(top[3], DM_REMOVE_NORMAL));
775 /* try to get devices */
776 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
778 ret = uclass_find_next_device(&dev)) {
780 ut_assertnonnull(dev);
783 ut_assertok(device_remove(top[4], DM_REMOVE_NORMAL));
784 /* try to get devices */
785 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
787 ret = uclass_find_next_device(&dev)) {
789 ut_assertnonnull(dev);
792 ut_assertok(device_remove(top[5], DM_REMOVE_NORMAL));
793 /* try to get devices */
794 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
796 ret = uclass_find_next_device(&dev)) {
798 ut_assertnonnull(dev);
801 ut_assertok(device_remove(top[2], DM_REMOVE_NORMAL));
802 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
804 ret = uclass_find_next_device(&dev)) {
806 ut_assertnonnull(dev);
809 ut_assertok(device_remove(grandchild[0], DM_REMOVE_NORMAL));
810 /* try to get devices */
811 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
813 ret = uclass_find_next_device(&dev)) {
815 ut_assertnonnull(dev);
818 ut_assertok(device_remove(grandchild[1], DM_REMOVE_NORMAL));
819 /* try to get devices */
820 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
822 ret = uclass_find_next_device(&dev)) {
824 ut_assertnonnull(dev);
827 /* Try the same with unbind */
828 ut_assertok(device_unbind(top[3]));
829 ut_assertok(device_unbind(top[4]));
830 ut_assertok(device_unbind(top[5]));
831 ut_assertok(device_unbind(top[2]));
833 ut_assertok(device_unbind(grandchild[0]));
834 ut_assertok(device_unbind(grandchild[1]));
838 DM_TEST(dm_test_device_reparent, 0);
840 /* Test that pre-relocation devices work as expected */
841 static int dm_test_pre_reloc(struct unit_test_state *uts)
845 /* The normal driver should refuse to bind before relocation */
846 ut_asserteq(-EPERM, device_bind_by_name(uts->root, true,
847 &driver_info_manual, &dev));
849 /* But this one is marked pre-reloc */
850 ut_assertok(device_bind_by_name(uts->root, true,
851 &driver_info_pre_reloc, &dev));
855 DM_TEST(dm_test_pre_reloc, 0);
858 * Test that removal of devices, either via the "normal" device_remove()
859 * API or via the device driver selective flag works as expected
861 static int dm_test_remove_active_dma(struct unit_test_state *uts)
865 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_act_dma,
869 /* Probe the device */
870 ut_assertok(device_probe(dev));
872 /* Test if device is active right now */
873 ut_asserteq(true, device_active(dev));
875 /* Remove the device via selective remove flag */
876 dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
878 /* Test if device is inactive right now */
879 ut_asserteq(false, device_active(dev));
881 /* Probe the device again */
882 ut_assertok(device_probe(dev));
884 /* Test if device is active right now */
885 ut_asserteq(true, device_active(dev));
887 /* Remove the device via "normal" remove API */
888 ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
890 /* Test if device is inactive right now */
891 ut_asserteq(false, device_active(dev));
894 * Test if a device without the active DMA flags is not removed upon
895 * the active DMA remove call
897 ut_assertok(device_unbind(dev));
898 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_manual,
902 /* Probe the device */
903 ut_assertok(device_probe(dev));
905 /* Test if device is active right now */
906 ut_asserteq(true, device_active(dev));
908 /* Remove the device via selective remove flag */
909 dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
911 /* Test if device is still active right now */
912 ut_asserteq(true, device_active(dev));
916 DM_TEST(dm_test_remove_active_dma, 0);
918 /* Test removal of 'vital' devices */
919 static int dm_test_remove_vital(struct unit_test_state *uts)
921 struct udevice *normal, *dma, *vital, *dma_vital;
923 /* Skip the behaviour in test_post_probe() */
924 uts->skip_post_probe = 1;
926 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_manual,
928 ut_assertnonnull(normal);
930 ut_assertok(device_bind_by_name(uts->root, false, &driver_info_act_dma,
932 ut_assertnonnull(dma);
934 ut_assertok(device_bind_by_name(uts->root, false,
935 &driver_info_vital_clk, &vital));
936 ut_assertnonnull(vital);
938 ut_assertok(device_bind_by_name(uts->root, false,
939 &driver_info_act_dma_vital_clk,
941 ut_assertnonnull(dma_vital);
943 /* Probe the devices */
944 ut_assertok(device_probe(normal));
945 ut_assertok(device_probe(dma));
946 ut_assertok(device_probe(vital));
947 ut_assertok(device_probe(dma_vital));
949 /* Check that devices are active right now */
950 ut_asserteq(true, device_active(normal));
951 ut_asserteq(true, device_active(dma));
952 ut_asserteq(true, device_active(vital));
953 ut_asserteq(true, device_active(dma_vital));
955 /* Remove active devices via selective remove flag */
956 dm_remove_devices_flags(DM_REMOVE_NON_VITAL | DM_REMOVE_ACTIVE_ALL);
959 * Check that this only has an effect on the dma device, since two
960 * devices are vital and the third does not have active DMA
962 ut_asserteq(true, device_active(normal));
963 ut_asserteq(false, device_active(dma));
964 ut_asserteq(true, device_active(vital));
965 ut_asserteq(true, device_active(dma_vital));
967 /* Remove active devices via selective remove flag */
968 ut_assertok(device_probe(dma));
969 dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
971 /* This should have affected both active-dma devices */
972 ut_asserteq(true, device_active(normal));
973 ut_asserteq(false, device_active(dma));
974 ut_asserteq(true, device_active(vital));
975 ut_asserteq(false, device_active(dma_vital));
977 /* Remove non-vital devices */
978 ut_assertok(device_probe(dma));
979 ut_assertok(device_probe(dma_vital));
980 dm_remove_devices_flags(DM_REMOVE_NON_VITAL);
982 /* This should have affected only non-vital devices */
983 ut_asserteq(false, device_active(normal));
984 ut_asserteq(false, device_active(dma));
985 ut_asserteq(true, device_active(vital));
986 ut_asserteq(true, device_active(dma_vital));
988 /* Remove vital devices via normal remove flag */
989 ut_assertok(device_probe(normal));
990 ut_assertok(device_probe(dma));
991 dm_remove_devices_flags(DM_REMOVE_NORMAL);
993 /* Check that all devices are inactive right now */
994 ut_asserteq(false, device_active(normal));
995 ut_asserteq(false, device_active(dma));
996 ut_asserteq(false, device_active(vital));
997 ut_asserteq(false, device_active(dma_vital));
1001 DM_TEST(dm_test_remove_vital, 0);
1003 static int dm_test_uclass_before_ready(struct unit_test_state *uts)
1007 ut_assertok(uclass_get(UCLASS_TEST, &uc));
1010 gd->dm_root_f = NULL;
1011 memset(&gd->uclass_root, '\0', sizeof(gd->uclass_root));
1013 ut_asserteq_ptr(NULL, uclass_find(UCLASS_TEST));
1014 ut_asserteq(-EDEADLK, uclass_get(UCLASS_TEST, &uc));
1018 DM_TEST(dm_test_uclass_before_ready, 0);
1020 static int dm_test_uclass_devices_find(struct unit_test_state *uts)
1022 struct udevice *dev;
1025 for (ret = uclass_find_first_device(UCLASS_TEST, &dev);
1027 ret = uclass_find_next_device(&dev)) {
1029 ut_assertnonnull(dev);
1032 ut_assertok(uclass_find_first_device(UCLASS_TEST_DUMMY, &dev));
1037 DM_TEST(dm_test_uclass_devices_find, UT_TESTF_SCAN_PDATA);
1039 static int dm_test_uclass_devices_find_by_name(struct unit_test_state *uts)
1041 struct udevice *finddev;
1042 struct udevice *testdev;
1046 * For each test device found in fdt like: "a-test", "b-test", etc.,
1047 * use its name and try to find it by uclass_find_device_by_name().
1048 * Then, on success check if:
1049 * - current 'testdev' name is equal to the returned 'finddev' name
1050 * - current 'testdev' pointer is equal to the returned 'finddev'
1052 * We assume that, each uclass's device name is unique, so if not, then
1053 * this will fail on checking condition: testdev == finddev, since the
1054 * uclass_find_device_by_name(), returns the first device by given name.
1056 for (ret = uclass_find_first_device(UCLASS_TEST_FDT, &testdev);
1058 ret = uclass_find_next_device(&testdev)) {
1060 ut_assertnonnull(testdev);
1062 findret = uclass_find_device_by_name(UCLASS_TEST_FDT,
1066 ut_assertok(findret);
1068 ut_asserteq_str(testdev->name, finddev->name);
1069 ut_asserteq_ptr(testdev, finddev);
1074 DM_TEST(dm_test_uclass_devices_find_by_name, UT_TESTF_SCAN_FDT);
1076 static int dm_test_uclass_devices_get(struct unit_test_state *uts)
1078 struct udevice *dev;
1081 for (ret = uclass_first_device_check(UCLASS_TEST, &dev);
1083 ret = uclass_next_device_check(&dev)) {
1085 ut_assert(device_active(dev));
1090 DM_TEST(dm_test_uclass_devices_get, UT_TESTF_SCAN_PDATA);
1092 static int dm_test_uclass_devices_get_by_name(struct unit_test_state *uts)
1094 struct udevice *finddev;
1095 struct udevice *testdev;
1099 * For each test device found in fdt like: "a-test", "b-test", etc.,
1100 * use its name and try to get it by uclass_get_device_by_name().
1101 * On success check if:
1102 * - returned finddev' is active
1103 * - current 'testdev' name is equal to the returned 'finddev' name
1104 * - current 'testdev' pointer is equal to the returned 'finddev'
1106 * We asserts that the 'testdev' is active on each loop entry, so we
1107 * could be sure that the 'finddev' is activated too, but for sure
1108 * we check it again.
1110 * We assume that, each uclass's device name is unique, so if not, then
1111 * this will fail on checking condition: testdev == finddev, since the
1112 * uclass_get_device_by_name(), returns the first device by given name.
1114 for (ret = uclass_first_device_check(UCLASS_TEST_FDT, &testdev);
1116 ret = uclass_next_device_check(&testdev)) {
1118 ut_assert(device_active(testdev));
1120 findret = uclass_get_device_by_name(UCLASS_TEST_FDT,
1124 ut_assertok(findret);
1126 ut_assert(device_active(finddev));
1127 ut_asserteq_str(testdev->name, finddev->name);
1128 ut_asserteq_ptr(testdev, finddev);
1133 DM_TEST(dm_test_uclass_devices_get_by_name, UT_TESTF_SCAN_FDT);
1135 static int dm_test_device_get_uclass_id(struct unit_test_state *uts)
1137 struct udevice *dev;
1139 ut_assertok(uclass_get_device(UCLASS_TEST, 0, &dev));
1140 ut_asserteq(UCLASS_TEST, device_get_uclass_id(dev));
1144 DM_TEST(dm_test_device_get_uclass_id, UT_TESTF_SCAN_PDATA);
1146 static int dm_test_uclass_names(struct unit_test_state *uts)
1148 ut_asserteq_str("test", uclass_get_name(UCLASS_TEST));
1149 ut_asserteq(UCLASS_TEST, uclass_get_by_name("test"));
1151 ut_asserteq(UCLASS_SPI, uclass_get_by_name("spi"));
1155 DM_TEST(dm_test_uclass_names, UT_TESTF_SCAN_PDATA);
1157 static int dm_test_inactive_child(struct unit_test_state *uts)
1159 struct udevice *parent, *dev1, *dev2;
1161 /* Skip the behaviour in test_post_probe() */
1162 uts->skip_post_probe = 1;
1164 ut_assertok(uclass_first_device_err(UCLASS_TEST, &parent));
1167 * Create a child but do not activate it. Calling the function again
1168 * should return the same child.
1170 ut_asserteq(-ENODEV, device_find_first_inactive_child(parent,
1171 UCLASS_TEST, &dev1));
1172 ut_assertok(device_bind(parent, DM_DRIVER_GET(test_drv),
1173 "test_child", 0, ofnode_null(), &dev1));
1175 ut_assertok(device_find_first_inactive_child(parent, UCLASS_TEST,
1177 ut_asserteq_ptr(dev1, dev2);
1179 ut_assertok(device_probe(dev1));
1180 ut_asserteq(-ENODEV, device_find_first_inactive_child(parent,
1181 UCLASS_TEST, &dev2));
1185 DM_TEST(dm_test_inactive_child, UT_TESTF_SCAN_PDATA);
1187 /* Make sure all bound devices have a sequence number */
1188 static int dm_test_all_have_seq(struct unit_test_state *uts)
1190 struct udevice *dev;
1193 list_for_each_entry(uc, gd->uclass_root, sibling_node) {
1194 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
1195 if (dev->seq_ == -1)
1196 printf("Device '%s' has no seq (%d)\n",
1197 dev->name, dev->seq_);
1198 ut_assert(dev->seq_ != -1);
1204 DM_TEST(dm_test_all_have_seq, UT_TESTF_SCAN_PDATA);
1206 #if CONFIG_IS_ENABLED(DM_DMA)
1207 static int dm_test_dma_offset(struct unit_test_state *uts)
1209 struct udevice *dev;
1212 /* Make sure the bus's dma-ranges aren't taken into account here */
1213 node = ofnode_path("/mmio-bus@0");
1214 ut_assert(ofnode_valid(node));
1215 ut_assertok(uclass_get_device_by_ofnode(UCLASS_TEST_BUS, node, &dev));
1216 ut_asserteq_64(0, dev->dma_offset);
1218 /* Device behind a bus with dma-ranges */
1219 node = ofnode_path("/mmio-bus@0/subnode@0");
1220 ut_assert(ofnode_valid(node));
1221 ut_assertok(uclass_get_device_by_ofnode(UCLASS_TEST_FDT, node, &dev));
1222 ut_asserteq_64(-0x10000000ULL, dev->dma_offset);
1224 /* This one has no dma-ranges */
1225 node = ofnode_path("/mmio-bus@1");
1226 ut_assert(ofnode_valid(node));
1227 ut_assertok(uclass_get_device_by_ofnode(UCLASS_TEST_BUS, node, &dev));
1228 node = ofnode_path("/mmio-bus@1/subnode@0");
1229 ut_assert(ofnode_valid(node));
1230 ut_assertok(uclass_get_device_by_ofnode(UCLASS_TEST_FDT, node, &dev));
1231 ut_asserteq_64(0, dev->dma_offset);
1235 DM_TEST(dm_test_dma_offset, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
1238 /* Test dm_get_stats() */
1239 static int dm_test_get_stats(struct unit_test_state *uts)
1241 int dev_count, uc_count;
1243 dm_get_stats(&dev_count, &uc_count);
1244 ut_assert(dev_count > 50);
1245 ut_assert(uc_count > 30);
1249 DM_TEST(dm_test_get_stats, UT_TESTF_SCAN_FDT);
1251 /* Test uclass_find_device_by_name() */
1252 static int dm_test_uclass_find_device(struct unit_test_state *uts)
1254 struct udevice *dev;
1256 ut_assertok(uclass_find_device_by_name(UCLASS_I2C, "i2c@0", &dev));
1257 ut_asserteq(-ENODEV,
1258 uclass_find_device_by_name(UCLASS_I2C, "i2c@0x", &dev));
1259 ut_assertok(uclass_find_device_by_namelen(UCLASS_I2C, "i2c@0x", 5,
1264 DM_TEST(dm_test_uclass_find_device, UT_TESTF_SCAN_FDT);
1266 /* Test getting information about tags attached to devices */
1267 static int dm_test_dev_get_attach(struct unit_test_state *uts)
1269 struct udevice *dev;
1271 ut_assertok(uclass_first_device_err(UCLASS_TEST_FDT, &dev));
1272 ut_asserteq_str("a-test", dev->name);
1274 ut_assertnonnull(dev_get_attach_ptr(dev, DM_TAG_PLAT));
1275 ut_assertnonnull(dev_get_attach_ptr(dev, DM_TAG_PRIV));
1276 ut_assertnull(dev_get_attach_ptr(dev, DM_TAG_UC_PRIV));
1277 ut_assertnull(dev_get_attach_ptr(dev, DM_TAG_UC_PLAT));
1278 ut_assertnull(dev_get_attach_ptr(dev, DM_TAG_PARENT_PLAT));
1279 ut_assertnull(dev_get_attach_ptr(dev, DM_TAG_PARENT_PRIV));
1281 ut_asserteq(sizeof(struct dm_test_pdata),
1282 dev_get_attach_size(dev, DM_TAG_PLAT));
1283 ut_asserteq(sizeof(struct dm_test_priv),
1284 dev_get_attach_size(dev, DM_TAG_PRIV));
1285 ut_asserteq(0, dev_get_attach_size(dev, DM_TAG_UC_PRIV));
1286 ut_asserteq(0, dev_get_attach_size(dev, DM_TAG_UC_PLAT));
1287 ut_asserteq(0, dev_get_attach_size(dev, DM_TAG_PARENT_PLAT));
1288 ut_asserteq(0, dev_get_attach_size(dev, DM_TAG_PARENT_PRIV));
1292 DM_TEST(dm_test_dev_get_attach, UT_TESTF_SCAN_FDT);
1294 /* Test getting information about tags attached to bus devices */
1295 static int dm_test_dev_get_attach_bus(struct unit_test_state *uts)
1297 struct udevice *dev, *child;
1299 ut_assertok(uclass_first_device_err(UCLASS_TEST_BUS, &dev));
1300 ut_asserteq_str("some-bus", dev->name);
1302 ut_assertnonnull(dev_get_attach_ptr(dev, DM_TAG_PLAT));
1303 ut_assertnonnull(dev_get_attach_ptr(dev, DM_TAG_PRIV));
1304 ut_assertnonnull(dev_get_attach_ptr(dev, DM_TAG_UC_PRIV));
1305 ut_assertnonnull(dev_get_attach_ptr(dev, DM_TAG_UC_PLAT));
1306 ut_assertnull(dev_get_attach_ptr(dev, DM_TAG_PARENT_PLAT));
1307 ut_assertnull(dev_get_attach_ptr(dev, DM_TAG_PARENT_PRIV));
1309 ut_asserteq(sizeof(struct dm_test_pdata),
1310 dev_get_attach_size(dev, DM_TAG_PLAT));
1311 ut_asserteq(sizeof(struct dm_test_priv),
1312 dev_get_attach_size(dev, DM_TAG_PRIV));
1313 ut_asserteq(sizeof(struct dm_test_uclass_priv),
1314 dev_get_attach_size(dev, DM_TAG_UC_PRIV));
1315 ut_asserteq(sizeof(struct dm_test_uclass_plat),
1316 dev_get_attach_size(dev, DM_TAG_UC_PLAT));
1317 ut_asserteq(0, dev_get_attach_size(dev, DM_TAG_PARENT_PLAT));
1318 ut_asserteq(0, dev_get_attach_size(dev, DM_TAG_PARENT_PRIV));
1320 /* Now try the child of the bus */
1321 ut_assertok(device_first_child_err(dev, &child));
1322 ut_asserteq_str("c-test@5", child->name);
1324 ut_assertnonnull(dev_get_attach_ptr(child, DM_TAG_PLAT));
1325 ut_assertnonnull(dev_get_attach_ptr(child, DM_TAG_PRIV));
1326 ut_assertnull(dev_get_attach_ptr(child, DM_TAG_UC_PRIV));
1327 ut_assertnull(dev_get_attach_ptr(child, DM_TAG_UC_PLAT));
1328 ut_assertnonnull(dev_get_attach_ptr(child, DM_TAG_PARENT_PLAT));
1329 ut_assertnonnull(dev_get_attach_ptr(child, DM_TAG_PARENT_PRIV));
1331 ut_asserteq(sizeof(struct dm_test_pdata),
1332 dev_get_attach_size(child, DM_TAG_PLAT));
1333 ut_asserteq(sizeof(struct dm_test_priv),
1334 dev_get_attach_size(child, DM_TAG_PRIV));
1335 ut_asserteq(0, dev_get_attach_size(child, DM_TAG_UC_PRIV));
1336 ut_asserteq(0, dev_get_attach_size(child, DM_TAG_UC_PLAT));
1337 ut_asserteq(sizeof(struct dm_test_parent_plat),
1338 dev_get_attach_size(child, DM_TAG_PARENT_PLAT));
1339 ut_asserteq(sizeof(struct dm_test_parent_data),
1340 dev_get_attach_size(child, DM_TAG_PARENT_PRIV));
1344 DM_TEST(dm_test_dev_get_attach_bus, UT_TESTF_SCAN_FDT);
1346 /* Test getting information about tags attached to bus devices */
1347 static int dm_test_dev_get_mem(struct unit_test_state *uts)
1349 struct dm_stats stats;
1355 DM_TEST(dm_test_dev_get_mem, UT_TESTF_SCAN_FDT);