blob: 5f07430714ea2bfdb325bdd6967b0642af8141e3 [file] [log] [blame]
Simon Glassb255efc2022-04-24 23:31:24 -06001// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Test for bootdev functions. All start with 'bootdev'
4 *
5 * Copyright 2021 Google LLC
6 * Written by Simon Glass <sjg@chromium.org>
7 */
8
Simon Glassb255efc2022-04-24 23:31:24 -06009#include <bootstd.h>
10#include <dm.h>
11#include <bootdev.h>
12#include <bootflow.h>
13#include <mapmem.h>
14#include <os.h>
Simon Glassb255efc2022-04-24 23:31:24 -060015#include <test/ut.h>
16#include "bootstd_common.h"
17
Simon Glassb255efc2022-04-24 23:31:24 -060018/* Check 'bootdev list' command */
19static int bootdev_test_cmd_list(struct unit_test_state *uts)
20{
21 int probed;
22
Simon Glassb255efc2022-04-24 23:31:24 -060023 for (probed = 0; probed < 2; probed++) {
24 int probe_ch = probed ? '+' : ' ';
25
26 ut_assertok(run_command(probed ? "bootdev list -p" :
27 "bootdev list", 0));
28 ut_assert_nextline("Seq Probed Status Uclass Name");
29 ut_assert_nextlinen("---");
30 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 0, probe_ch, "OK",
31 "mmc", "mmc2.bootdev");
32 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 1, probe_ch, "OK",
33 "mmc", "mmc1.bootdev");
34 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 2, probe_ch, "OK",
35 "mmc", "mmc0.bootdev");
36 ut_assert_nextlinen("---");
37 ut_assert_nextline("(3 bootdevs)");
38 ut_assert_console_end();
39 }
40
41 return 0;
42}
Simon Glassf0425022024-08-22 07:57:54 -060043BOOTSTD_TEST(bootdev_test_cmd_list, UTF_DM | UTF_SCAN_FDT | UTF_CONSOLE);
Simon Glassb255efc2022-04-24 23:31:24 -060044
45/* Check 'bootdev select' and 'info' commands */
46static int bootdev_test_cmd_select(struct unit_test_state *uts)
47{
48 struct bootstd_priv *std;
49
50 /* get access to the CLI's cur_bootdev */
51 ut_assertok(bootstd_get_priv(&std));
52
Simon Glassb255efc2022-04-24 23:31:24 -060053 ut_asserteq(1, run_command("bootdev info", 0));
54 ut_assert_nextlinen("Please use");
55 ut_assert_console_end();
56
57 /* select by sequence */
58 ut_assertok(run_command("bootdev select 0", 0));
59 ut_assert_console_end();
60
61 ut_assertok(run_command("bootdev info", 0));
62 ut_assert_nextline("Name: mmc2.bootdev");
63 ut_assert_nextline("Sequence: 0");
64 ut_assert_nextline("Status: Probed");
65 ut_assert_nextline("Uclass: mmc");
66 ut_assert_nextline("Bootflows: 0 (0 valid)");
67 ut_assert_console_end();
68
69 /* select by bootdev name */
70 ut_assertok(run_command("bootdev select mmc1.bootdev", 0));
71 ut_assert_console_end();
72 ut_assertnonnull(std->cur_bootdev);
73 ut_asserteq_str("mmc1.bootdev", std->cur_bootdev->name);
74
75 /* select by bootdev label*/
76 ut_assertok(run_command("bootdev select mmc1", 0));
77 ut_assert_console_end();
78 ut_assertnonnull(std->cur_bootdev);
79 ut_asserteq_str("mmc1.bootdev", std->cur_bootdev->name);
80
81 /* deselect */
82 ut_assertok(run_command("bootdev select", 0));
83 ut_assert_console_end();
84 ut_assertnull(std->cur_bootdev);
85
86 ut_asserteq(1, run_command("bootdev info", 0));
87 ut_assert_nextlinen("Please use");
88 ut_assert_console_end();
89
90 return 0;
91}
Simon Glassf0425022024-08-22 07:57:54 -060092BOOTSTD_TEST(bootdev_test_cmd_select, UTF_DM | UTF_SCAN_FDT | UTF_CONSOLE);
Simon Glassb255efc2022-04-24 23:31:24 -060093
94/* Check bootdev labels */
95static int bootdev_test_labels(struct unit_test_state *uts)
96{
97 struct udevice *dev, *media;
Simon Glasse22fe922023-01-17 10:48:05 -070098 int mflags = 0;
Simon Glassb255efc2022-04-24 23:31:24 -060099
Simon Glasse22fe922023-01-17 10:48:05 -0700100 ut_assertok(bootdev_find_by_label("mmc2", &dev, &mflags));
Simon Glassb255efc2022-04-24 23:31:24 -0600101 ut_asserteq(UCLASS_BOOTDEV, device_get_uclass_id(dev));
Simon Glasse22fe922023-01-17 10:48:05 -0700102 ut_asserteq(0, mflags);
Simon Glassb255efc2022-04-24 23:31:24 -0600103 media = dev_get_parent(dev);
104 ut_asserteq(UCLASS_MMC, device_get_uclass_id(media));
105 ut_asserteq_str("mmc2", media->name);
106
Simon Glasse22fe922023-01-17 10:48:05 -0700107 /* Check method flags */
108 ut_assertok(bootdev_find_by_label("pxe", &dev, &mflags));
Simon Glassde567b12023-01-17 10:48:09 -0700109 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
110 mflags);
Simon Glasse22fe922023-01-17 10:48:05 -0700111 ut_assertok(bootdev_find_by_label("dhcp", &dev, &mflags));
Simon Glassde567b12023-01-17 10:48:09 -0700112 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_DHCP_ONLY,
113 mflags);
Simon Glasse22fe922023-01-17 10:48:05 -0700114
Simon Glassb255efc2022-04-24 23:31:24 -0600115 /* Check invalid uclass */
Simon Glass4108c6b2023-04-24 13:49:47 +1200116 ut_asserteq(-EPFNOSUPPORT,
117 bootdev_find_by_label("fred0", &dev, &mflags));
Simon Glassb255efc2022-04-24 23:31:24 -0600118
119 /* Check unknown sequence number */
Simon Glasse22fe922023-01-17 10:48:05 -0700120 ut_asserteq(-ENOENT, bootdev_find_by_label("mmc6", &dev, &mflags));
Simon Glassb255efc2022-04-24 23:31:24 -0600121
122 return 0;
123}
Simon Glass1a92f832024-08-22 07:57:48 -0600124BOOTSTD_TEST(bootdev_test_labels, UTF_DM | UTF_SCAN_FDT | UTF_ETH_BOOTDEV);
Simon Glassb255efc2022-04-24 23:31:24 -0600125
Simon Glassde567b12023-01-17 10:48:09 -0700126/* Check bootdev_find_by_any() */
127static int bootdev_test_any(struct unit_test_state *uts)
128{
129 struct udevice *dev, *media;
Jerome Forissier70ff9942024-10-16 11:56:25 +0200130 char *seq;
Simon Glassde567b12023-01-17 10:48:09 -0700131 int mflags;
132
133 /*
134 * with ethernet enabled we have 8 devices ahead of the mmc ones:
135 *
136 * ut_assertok(run_command("bootdev list", 0));
137 * Seq Probed Status Uclass Name
138 * --- ------ ------ -------- ------------------
139 * 0 [ + ] OK ethernet eth@10002000.bootdev
140 * 1 [ ] OK ethernet eth@10003000.bootdev
141 * 2 [ ] OK ethernet sbe5.bootdev
142 * 3 [ ] OK ethernet eth@10004000.bootdev
143 * 4 [ ] OK ethernet phy-test-eth.bootdev
144 * 5 [ ] OK ethernet dsa-test-eth.bootdev
145 * 6 [ ] OK ethernet dsa-test@0.bootdev
146 * 7 [ ] OK ethernet dsa-test@1.bootdev
147 * 8 [ ] OK mmc mmc2.bootdev
148 * 9 [ + ] OK mmc mmc1.bootdev
149 * a [ ] OK mmc mmc0.bootdev
Jerome Forissier70ff9942024-10-16 11:56:25 +0200150 *
151 * However if DSA_SANDBOX is disabled the dsa-test@{0,1} devices
152 * are not there.
Simon Glassde567b12023-01-17 10:48:09 -0700153 */
Jerome Forissier70ff9942024-10-16 11:56:25 +0200154 if (CONFIG_IS_ENABLED(DSA_SANDBOX))
155 seq = "8";
156 else
157 seq = "6";
158
159 ut_assertok(bootdev_find_by_any(seq, &dev, &mflags));
Simon Glassde567b12023-01-17 10:48:09 -0700160 ut_asserteq(UCLASS_BOOTDEV, device_get_uclass_id(dev));
161 ut_asserteq(BOOTFLOW_METHF_SINGLE_DEV, mflags);
162 media = dev_get_parent(dev);
163 ut_asserteq(UCLASS_MMC, device_get_uclass_id(media));
164 ut_asserteq_str("mmc2", media->name);
165 ut_assert_console_end();
166
167 /* there should not be this many bootdevs */
168 ut_asserteq(-ENODEV, bootdev_find_by_any("50", &dev, &mflags));
169 ut_assert_nextline("Cannot find '50' (err=-19)");
170 ut_assert_console_end();
171
172 /* Check method flags */
173 ut_assertok(bootdev_find_by_any("pxe", &dev, &mflags));
174 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
175 mflags);
176
177 /* Check invalid uclass */
178 mflags = 123;
Simon Glass4108c6b2023-04-24 13:49:47 +1200179 ut_asserteq(-EPFNOSUPPORT, bootdev_find_by_any("fred0", &dev, &mflags));
180 ut_assert_nextline("Cannot find bootdev 'fred0' (err=-96)");
Simon Glassde567b12023-01-17 10:48:09 -0700181 ut_asserteq(123, mflags);
182 ut_assert_console_end();
183
184 return 0;
185}
Simon Glassf0425022024-08-22 07:57:54 -0600186BOOTSTD_TEST(bootdev_test_any, UTF_DM | UTF_SCAN_FDT | UTF_ETH_BOOTDEV |
187 UTF_CONSOLE);
Simon Glassde567b12023-01-17 10:48:09 -0700188
Simon Glassfd5a5192023-10-23 00:02:11 -0700189/*
190 * Check bootdev ordering with the bootdev-order property and boot_targets
191 * environment variable
192 */
Simon Glassb255efc2022-04-24 23:31:24 -0600193static int bootdev_test_order(struct unit_test_state *uts)
194{
195 struct bootflow_iter iter;
196 struct bootflow bflow;
197
Simon Glassfd5a5192023-10-23 00:02:11 -0700198 test_set_skip_delays(true);
199
200 /* Start up USB which gives us three additional bootdevs */
Simon Glass22c93da2024-09-01 16:26:16 -0600201 bootstd_reset_usb();
Simon Glassfd5a5192023-10-23 00:02:11 -0700202 ut_assertok(run_command("usb start", 0));
203
Simon Glassb255efc2022-04-24 23:31:24 -0600204 /*
205 * First try the order set by the bootdev-order property
206 * Like all sandbox unit tests this relies on the devicetree setting up
207 * the required devices:
208 *
209 * mmc0 - nothing connected
210 * mmc1 - connected to mmc1.img file
211 * mmc2 - nothing connected
212 */
213 ut_assertok(env_set("boot_targets", NULL));
Simon Glass5d3d44f2023-01-17 10:48:16 -0700214 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600215 ut_asserteq(2, iter.num_devs);
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700216 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
217 ut_asserteq_str("mmc1.bootdev", iter.dev_used[1]->name);
Simon Glassb255efc2022-04-24 23:31:24 -0600218 bootflow_iter_uninit(&iter);
219
220 /* Use the environment variable to override it */
Simon Glassfd5a5192023-10-23 00:02:11 -0700221 ut_assertok(env_set("boot_targets", "mmc1 mmc2 usb"));
Simon Glass5d3d44f2023-01-17 10:48:16 -0700222 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glass64c63252024-11-07 14:31:49 -0700223
224 /* get the usb device which has a backing file (flash1.img) */
225 ut_asserteq(0, bootflow_scan_next(&iter, &bflow));
226
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700227 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
Simon Glassb51f01d2023-10-23 00:02:13 -0700228 ut_asserteq(5, iter.num_devs);
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700229 ut_asserteq_str("mmc1.bootdev", iter.dev_used[0]->name);
230 ut_asserteq_str("mmc2.bootdev", iter.dev_used[1]->name);
Simon Glassfd5a5192023-10-23 00:02:11 -0700231 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
232 iter.dev_used[2]->name);
Simon Glassb255efc2022-04-24 23:31:24 -0600233 bootflow_iter_uninit(&iter);
234
Simon Glass33795a92023-10-23 00:02:12 -0700235 /* Try a single uclass */
236 ut_assertok(env_set("boot_targets", NULL));
237 ut_assertok(bootflow_scan_first(NULL, "mmc", &iter, 0, &bflow));
238 ut_asserteq(2, iter.num_devs);
239
Simon Glassb51f01d2023-10-23 00:02:13 -0700240 /* Now scan past mmc1 and make sure that only mmc0 shows up */
241 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
242 ut_asserteq(3, iter.num_devs);
243 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
244 ut_asserteq_str("mmc1.bootdev", iter.dev_used[1]->name);
245 ut_asserteq_str("mmc0.bootdev", iter.dev_used[2]->name);
246 bootflow_iter_uninit(&iter);
247
248 /* Try a single uclass with boot_targets */
249 ut_assertok(env_set("boot_targets", "mmc"));
250 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
251 ut_asserteq(2, iter.num_devs);
252
253 /* Now scan past mmc1 and make sure that only mmc0 shows up */
Simon Glass33795a92023-10-23 00:02:12 -0700254 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
255 ut_asserteq(3, iter.num_devs);
256 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
257 ut_asserteq_str("mmc1.bootdev", iter.dev_used[1]->name);
258 ut_asserteq_str("mmc0.bootdev", iter.dev_used[2]->name);
259 bootflow_iter_uninit(&iter);
260
Simon Glassb51f01d2023-10-23 00:02:13 -0700261 /* Try a single uclass with boot_targets */
262 ut_assertok(env_set("boot_targets", "mmc usb"));
263 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
264 ut_asserteq(2, iter.num_devs);
265
Simon Glass64c63252024-11-07 14:31:49 -0700266 /*
267 * Now scan past mmc1 and make sure that the 3 USB devices show up. The
268 * first one has a backing file so returns success
269 */
270 ut_asserteq(0, bootflow_scan_next(&iter, &bflow));
Simon Glassb51f01d2023-10-23 00:02:13 -0700271 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
272 ut_asserteq(6, iter.num_devs);
273 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
274 ut_asserteq_str("mmc1.bootdev", iter.dev_used[1]->name);
275 ut_asserteq_str("mmc0.bootdev", iter.dev_used[2]->name);
276 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
277 iter.dev_used[3]->name);
278 bootflow_iter_uninit(&iter);
279
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700280 return 0;
281}
Simon Glass1a92f832024-08-22 07:57:48 -0600282BOOTSTD_TEST(bootdev_test_order, UTF_DM | UTF_SCAN_FDT);
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700283
284/* Check default bootdev ordering */
285static int bootdev_test_order_default(struct unit_test_state *uts)
286{
287 struct bootflow_iter iter;
288 struct bootflow bflow;
289
Simon Glassb255efc2022-04-24 23:31:24 -0600290 /*
291 * Now drop both orderings, to check the default (prioriy/sequence)
292 * ordering
293 */
294 ut_assertok(env_set("boot_targets", NULL));
295 ut_assertok(bootstd_test_drop_bootdev_order(uts));
296
Simon Glass5d3d44f2023-01-17 10:48:16 -0700297 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700298 ut_asserteq(2, iter.num_devs);
299 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
300 ut_asserteq_str("mmc1.bootdev", iter.dev_used[1]->name);
Simon Glassb255efc2022-04-24 23:31:24 -0600301
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700302 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600303 ut_asserteq(3, iter.num_devs);
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700304 ut_asserteq_str("mmc0.bootdev", iter.dev_used[2]->name);
Simon Glassb255efc2022-04-24 23:31:24 -0600305 bootflow_iter_uninit(&iter);
306
307 return 0;
308}
Simon Glass1a92f832024-08-22 07:57:48 -0600309BOOTSTD_TEST(bootdev_test_order_default, UTF_DM | UTF_SCAN_FDT);
Simon Glassb255efc2022-04-24 23:31:24 -0600310
311/* Check bootdev ordering with the uclass priority */
312static int bootdev_test_prio(struct unit_test_state *uts)
313{
314 struct bootdev_uc_plat *ucp;
315 struct bootflow_iter iter;
316 struct bootflow bflow;
317 struct udevice *blk;
318
Simon Glassf3cb89f2023-01-17 10:47:37 -0700319 test_set_skip_delays(true);
320
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700321 /* disable ethernet since the hunter will run dhcp */
322 test_set_eth_enable(false);
323
Simon Glassb255efc2022-04-24 23:31:24 -0600324 /* Start up USB which gives us three additional bootdevs */
Simon Glass22c93da2024-09-01 16:26:16 -0600325 bootstd_reset_usb();
Simon Glassb255efc2022-04-24 23:31:24 -0600326 ut_assertok(run_command("usb start", 0));
327
328 ut_assertok(bootstd_test_drop_bootdev_order(uts));
329
330 /* 3 MMC and 3 USB bootdevs: MMC should come before USB */
Simon Glass5d3d44f2023-01-17 10:48:16 -0700331 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glass64c63252024-11-07 14:31:49 -0700332
333 /* get the usb device which has a backing file (flash1.img) */
334 ut_asserteq(0, bootflow_scan_next(&iter, &bflow));
335
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700336 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600337 ut_asserteq(6, iter.num_devs);
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700338 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
Simon Glassb255efc2022-04-24 23:31:24 -0600339 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700340 iter.dev_used[3]->name);
Simon Glassb255efc2022-04-24 23:31:24 -0600341
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700342 ut_assertok(bootdev_get_sibling_blk(iter.dev_used[3], &blk));
Simon Glassb255efc2022-04-24 23:31:24 -0600343 ut_asserteq_str("usb_mass_storage.lun0", blk->name);
344
345 /* adjust the priority of the first USB bootdev to the highest */
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700346 ucp = dev_get_uclass_plat(iter.dev_used[3]);
347 ucp->prio = BOOTDEVP_1_PRE_SCAN;
Simon Glassb255efc2022-04-24 23:31:24 -0600348
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700349 /* try again but enable hunting, which brings in SCSI */
Simon Glassb255efc2022-04-24 23:31:24 -0600350 bootflow_iter_uninit(&iter);
Simon Glass99e68182023-02-22 12:17:03 -0700351 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, BOOTFLOWIF_HUNT,
Simon Glass5d3d44f2023-01-17 10:48:16 -0700352 &bflow));
Simon Glass64c63252024-11-07 14:31:49 -0700353
354 /* get the usb device which has a backing file (flash1.img) */
355 ut_asserteq(0, bootflow_scan_next(&iter, &bflow));
356
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700357 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
358 ut_asserteq(7, iter.num_devs);
Simon Glassb255efc2022-04-24 23:31:24 -0600359 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
Simon Glasscb2a5cd2023-01-17 10:48:17 -0700360 iter.dev_used[0]->name);
361 ut_asserteq_str("mmc2.bootdev", iter.dev_used[1]->name);
Simon Glassb255efc2022-04-24 23:31:24 -0600362
363 return 0;
364}
Simon Glass1a92f832024-08-22 07:57:48 -0600365BOOTSTD_TEST(bootdev_test_prio, UTF_DM | UTF_SCAN_FDT);
Simon Glass5acb97a2023-01-17 10:47:33 -0700366
367/* Check listing hunters */
368static int bootdev_test_hunter(struct unit_test_state *uts)
369{
370 struct bootstd_priv *std;
371
Simon Glass22c93da2024-09-01 16:26:16 -0600372 bootstd_reset_usb();
Simon Glassf3cb89f2023-01-17 10:47:37 -0700373 test_set_skip_delays(true);
374
Simon Glass5acb97a2023-01-17 10:47:33 -0700375 /* get access to the used hunters */
376 ut_assertok(bootstd_get_priv(&std));
377
Simon Glass5acb97a2023-01-17 10:47:33 -0700378 bootdev_list_hunters(std);
379 ut_assert_nextline("Prio Used Uclass Hunter");
380 ut_assert_nextlinen("----");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700381 ut_assert_nextline(" 6 ethernet eth_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700382 ut_assert_nextline(" 1 simple_bus (none)");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700383 ut_assert_nextline(" 5 ide ide_bootdev");
384 ut_assert_nextline(" 2 mmc mmc_bootdev");
385 ut_assert_nextline(" 4 nvme nvme_bootdev");
Simon Glassdeffa692023-01-28 15:00:28 -0700386 ut_assert_nextline(" 4 qfw qfw_bootdev");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700387 ut_assert_nextline(" 4 scsi scsi_bootdev");
388 ut_assert_nextline(" 4 spi_flash sf_bootdev");
389 ut_assert_nextline(" 5 usb usb_bootdev");
390 ut_assert_nextline(" 4 virtio virtio_bootdev");
Simon Glassdeffa692023-01-28 15:00:28 -0700391 ut_assert_nextline("(total hunters: 10)");
Simon Glass5acb97a2023-01-17 10:47:33 -0700392 ut_assert_console_end();
393
Simon Glassf3cb89f2023-01-17 10:47:37 -0700394 ut_assertok(bootdev_hunt("usb1", false));
395 ut_assert_nextline(
396 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
Simon Glass1248d2b2023-01-17 10:47:34 -0700397 ut_assert_console_end();
398
Simon Glassdeffa692023-01-28 15:00:28 -0700399 /* USB is 7th in the list, so bit 8 */
400 ut_asserteq(BIT(8), std->hunters_used);
Simon Glassf3cb89f2023-01-17 10:47:37 -0700401
Simon Glass5acb97a2023-01-17 10:47:33 -0700402 return 0;
403}
Simon Glassf0425022024-08-22 07:57:54 -0600404BOOTSTD_TEST(bootdev_test_hunter, UTF_DM | UTF_SCAN_FDT | UTF_CONSOLE);
Simon Glass5acb97a2023-01-17 10:47:33 -0700405
406/* Check 'bootdev hunt' command */
407static int bootdev_test_cmd_hunt(struct unit_test_state *uts)
408{
409 struct bootstd_priv *std;
410
Simon Glassf3cb89f2023-01-17 10:47:37 -0700411 test_set_skip_delays(true);
Simon Glass22c93da2024-09-01 16:26:16 -0600412 bootstd_reset_usb();
Simon Glassf3cb89f2023-01-17 10:47:37 -0700413
Simon Glass5acb97a2023-01-17 10:47:33 -0700414 /* get access to the used hunters */
415 ut_assertok(bootstd_get_priv(&std));
416
Simon Glass5acb97a2023-01-17 10:47:33 -0700417 ut_assertok(run_command("bootdev hunt -l", 0));
418 ut_assert_nextline("Prio Used Uclass Hunter");
419 ut_assert_nextlinen("----");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700420 ut_assert_nextline(" 6 ethernet eth_bootdev");
Simon Glassdeffa692023-01-28 15:00:28 -0700421 ut_assert_skip_to_line("(total hunters: 10)");
Simon Glass5acb97a2023-01-17 10:47:33 -0700422 ut_assert_console_end();
423
Simon Glass7e1f6a42023-01-17 10:48:08 -0700424 /* Use the MMC hunter and see that it updates */
425 ut_assertok(run_command("bootdev hunt mmc", 0));
426 ut_assertok(run_command("bootdev hunt -l", 0));
427 ut_assert_skip_to_line(" 5 ide ide_bootdev");
428 ut_assert_nextline(" 2 * mmc mmc_bootdev");
Simon Glassdeffa692023-01-28 15:00:28 -0700429 ut_assert_skip_to_line("(total hunters: 10)");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700430 ut_assert_console_end();
431
Simon Glass5acb97a2023-01-17 10:47:33 -0700432 /* Scan all hunters */
Simon Glassac06b26a2023-01-17 10:48:10 -0700433 test_set_eth_enable(false);
Simon Glass7e1f6a42023-01-17 10:48:08 -0700434 test_set_skip_delays(true);
Simon Glass5acb97a2023-01-17 10:47:33 -0700435 ut_assertok(run_command("bootdev hunt", 0));
Simon Glass5ea0a8d2023-01-17 10:47:40 -0700436 ut_assert_nextline("Hunting with: ethernet");
Simon Glasse4cf1062023-01-17 10:48:13 -0700437
438 /* This is the extension feature which has no uclass at present */
439 ut_assert_nextline("Hunting with: simple_bus");
440 ut_assert_nextline("Found 2 extension board(s).");
Simon Glassbe7c6662023-01-17 10:47:46 -0700441 ut_assert_nextline("Hunting with: ide");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700442
443 /* mmc hunter has already been used so should not run again */
444
Simon Glass08382872023-01-17 10:47:47 -0700445 ut_assert_nextline("Hunting with: nvme");
Simon Glassdeffa692023-01-28 15:00:28 -0700446 ut_assert_nextline("Hunting with: qfw");
Simon Glass9985e9c2023-01-17 10:47:45 -0700447 ut_assert_nextline("Hunting with: scsi");
448 ut_assert_nextline("scanning bus for devices...");
Simon Glass215be682023-01-17 10:48:03 -0700449 ut_assert_skip_to_line("Hunting with: spi_flash");
450 ut_assert_nextline("Hunting with: usb");
Simon Glassf3cb89f2023-01-17 10:47:37 -0700451 ut_assert_nextline(
452 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
Simon Glass215be682023-01-17 10:48:03 -0700453 ut_assert_nextline("Hunting with: virtio");
Simon Glass5acb97a2023-01-17 10:47:33 -0700454 ut_assert_console_end();
455
456 /* List available hunters */
457 ut_assertok(run_command("bootdev hunt -l", 0));
458 ut_assert_nextlinen("Prio");
459 ut_assert_nextlinen("----");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700460 ut_assert_nextline(" 6 * ethernet eth_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700461 ut_assert_nextline(" 1 * simple_bus (none)");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700462 ut_assert_nextline(" 5 * ide ide_bootdev");
463 ut_assert_nextline(" 2 * mmc mmc_bootdev");
464 ut_assert_nextline(" 4 * nvme nvme_bootdev");
Simon Glassdeffa692023-01-28 15:00:28 -0700465 ut_assert_nextline(" 4 * qfw qfw_bootdev");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700466 ut_assert_nextline(" 4 * scsi scsi_bootdev");
467 ut_assert_nextline(" 4 * spi_flash sf_bootdev");
468 ut_assert_nextline(" 5 * usb usb_bootdev");
469 ut_assert_nextline(" 4 * virtio virtio_bootdev");
Simon Glassdeffa692023-01-28 15:00:28 -0700470 ut_assert_nextline("(total hunters: 10)");
Simon Glass5acb97a2023-01-17 10:47:33 -0700471 ut_assert_console_end();
472
Simon Glasse4cf1062023-01-17 10:48:13 -0700473 ut_asserteq(GENMASK(MAX_HUNTER, 0), std->hunters_used);
Simon Glass5acb97a2023-01-17 10:47:33 -0700474
475 return 0;
476}
Simon Glassf0425022024-08-22 07:57:54 -0600477BOOTSTD_TEST(bootdev_test_cmd_hunt, UTF_DM | UTF_SCAN_FDT | UTF_ETH_BOOTDEV |
478 UTF_CONSOLE);
Simon Glass64cbc5c2023-01-17 10:47:42 -0700479
Simon Glass484e4072023-01-17 10:48:14 -0700480/* Check searching for bootdevs using the hunters */
481static int bootdev_test_hunt_scan(struct unit_test_state *uts)
482{
483 struct bootflow_iter iter;
484 struct bootstd_priv *std;
485 struct bootflow bflow;
486
487 /* get access to the used hunters */
488 ut_assertok(bootstd_get_priv(&std));
489
490 ut_assertok(bootstd_test_drop_bootdev_order(uts));
Simon Glass5d3d44f2023-01-17 10:48:16 -0700491 ut_assertok(bootflow_scan_first(NULL, NULL, &iter,
Simon Glass99e68182023-02-22 12:17:03 -0700492 BOOTFLOWIF_SHOW | BOOTFLOWIF_HUNT |
493 BOOTFLOWIF_SKIP_GLOBAL, &bflow));
Simon Glass484e4072023-01-17 10:48:14 -0700494 ut_asserteq(BIT(MMC_HUNTER) | BIT(1), std->hunters_used);
495
496 return 0;
497}
Simon Glass1a92f832024-08-22 07:57:48 -0600498BOOTSTD_TEST(bootdev_test_hunt_scan, UTF_DM | UTF_SCAN_FDT);
Simon Glass484e4072023-01-17 10:48:14 -0700499
Simon Glass64cbc5c2023-01-17 10:47:42 -0700500/* Check that only bootable partitions are processed */
501static int bootdev_test_bootable(struct unit_test_state *uts)
502{
503 struct bootflow_iter iter;
504 struct bootflow bflow;
505 struct udevice *blk;
506
507 memset(&iter, '\0', sizeof(iter));
508 memset(&bflow, '\0', sizeof(bflow));
509 iter.part = 0;
510 ut_assertok(uclass_get_device_by_name(UCLASS_BLK, "mmc1.blk", &blk));
511 iter.dev = blk;
512 ut_assertok(device_find_next_child(&iter.dev));
513 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
514
515 /*
516 * initially we don't have any knowledge of which partitions are
517 * bootable, but mmc1 has two partitions, with the first one being
518 * bootable
519 */
520 iter.part = 2;
521 ut_asserteq(-EINVAL, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
522 ut_asserteq(0, iter.first_bootable);
523
524 /* scan with part == 0 to get the partition info */
525 iter.part = 0;
526 ut_asserteq(-ENOENT, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
527 ut_asserteq(1, iter.first_bootable);
528
529 /* now it will refuse to use non-bootable partitions */
530 iter.part = 2;
531 ut_asserteq(-EINVAL, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
532
533 return 0;
534}
Simon Glass1a92f832024-08-22 07:57:48 -0600535BOOTSTD_TEST(bootdev_test_bootable, UTF_DM | UTF_SCAN_FDT);
Simon Glass3e9f6be2023-01-17 10:48:07 -0700536
537/* Check hunting for bootdev of a particular priority */
538static int bootdev_test_hunt_prio(struct unit_test_state *uts)
539{
Simon Glass22c93da2024-09-01 16:26:16 -0600540 bootstd_reset_usb();
Simon Glass3e9f6be2023-01-17 10:48:07 -0700541 test_set_skip_delays(true);
542
Simon Glass7e1f6a42023-01-17 10:48:08 -0700543 ut_assertok(bootdev_hunt_prio(BOOTDEVP_4_SCAN_FAST, false));
Simon Glass3e9f6be2023-01-17 10:48:07 -0700544 ut_assert_nextline("scanning bus for devices...");
545 ut_assert_skip_to_line(" Type: Hard Disk");
546 ut_assert_nextlinen(" Capacity:");
547 ut_assert_console_end();
548
549 /* now try a different priority, verbosely */
Simon Glass7e1f6a42023-01-17 10:48:08 -0700550 ut_assertok(bootdev_hunt_prio(BOOTDEVP_5_SCAN_SLOW, true));
Simon Glass3e9f6be2023-01-17 10:48:07 -0700551 ut_assert_nextline("Hunting with: ide");
Simon Glass3e9f6be2023-01-17 10:48:07 -0700552 ut_assert_nextline("Hunting with: usb");
553 ut_assert_nextline(
554 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
555 ut_assert_console_end();
556
557 return 0;
558}
Simon Glassf0425022024-08-22 07:57:54 -0600559BOOTSTD_TEST(bootdev_test_hunt_prio, UTF_DM | UTF_SCAN_FDT | UTF_CONSOLE);
Simon Glassde567b12023-01-17 10:48:09 -0700560
561/* Check hunting for bootdevs with a particular label */
562static int bootdev_test_hunt_label(struct unit_test_state *uts)
563{
564 struct udevice *dev, *old;
565 struct bootstd_priv *std;
566 int mflags;
567
Simon Glass22c93da2024-09-01 16:26:16 -0600568 bootstd_reset_usb();
Simon Glass4bb7c162023-05-05 20:03:04 -0600569
Simon Glassde567b12023-01-17 10:48:09 -0700570 /* get access to the used hunters */
571 ut_assertok(bootstd_get_priv(&std));
572
573 /* scan an unknown uclass */
Simon Glassde567b12023-01-17 10:48:09 -0700574 old = (void *)&mflags; /* arbitrary pointer to check against dev */
575 dev = old;
576 mflags = 123;
Simon Glass4108c6b2023-04-24 13:49:47 +1200577 ut_asserteq(-EPFNOSUPPORT,
Simon Glassde567b12023-01-17 10:48:09 -0700578 bootdev_hunt_and_find_by_label("fred", &dev, &mflags));
Simon Glassde567b12023-01-17 10:48:09 -0700579 ut_asserteq_ptr(old, dev);
580 ut_asserteq(123, mflags);
581 ut_assert_console_end();
582 ut_asserteq(0, std->hunters_used);
583
584 /* scan an invalid mmc controllers */
585 ut_asserteq(-ENOENT,
586 bootdev_hunt_and_find_by_label("mmc4", &dev, &mflags));
587 ut_asserteq_ptr(old, dev);
588 ut_asserteq(123, mflags);
Simon Glassde567b12023-01-17 10:48:09 -0700589 ut_assert_console_end();
590
591 ut_assertok(bootstd_test_check_mmc_hunter(uts));
592
593 /* scan for a particular mmc controller */
594 ut_assertok(bootdev_hunt_and_find_by_label("mmc1", &dev, &mflags));
595 ut_assertnonnull(dev);
596 ut_asserteq_str("mmc1.bootdev", dev->name);
597 ut_asserteq(0, mflags);
598 ut_assert_console_end();
599
600 /* scan all of usb */
601 test_set_skip_delays(true);
602 ut_assertok(bootdev_hunt_and_find_by_label("usb", &dev, &mflags));
603 ut_assertnonnull(dev);
604 ut_asserteq_str("usb_mass_storage.lun0.bootdev", dev->name);
605 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS, mflags);
606 ut_assert_nextlinen("Bus usb@1: scanning bus usb@1");
607 ut_assert_console_end();
608
609 return 0;
610}
Simon Glassf0425022024-08-22 07:57:54 -0600611BOOTSTD_TEST(bootdev_test_hunt_label, UTF_DM | UTF_SCAN_FDT | UTF_CONSOLE);
Simon Glassac06b26a2023-01-17 10:48:10 -0700612
613/* Check iterating to the next label in a list */
614static int bootdev_test_next_label(struct unit_test_state *uts)
615{
616 const char *const labels[] = {"mmc0", "scsi", "dhcp", "pxe", NULL};
617 struct bootflow_iter iter;
618 struct bootstd_priv *std;
619 struct bootflow bflow;
620 struct udevice *dev;
621 int mflags;
622
623 test_set_eth_enable(false);
624
625 /* get access to the used hunters */
626 ut_assertok(bootstd_get_priv(&std));
627
628 memset(&iter, '\0', sizeof(iter));
629 memset(&bflow, '\0', sizeof(bflow));
630 iter.part = 0;
631 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
632 iter.cur_label = -1;
633 iter.labels = labels;
634
635 dev = NULL;
636 mflags = 123;
637 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
Simon Glassac06b26a2023-01-17 10:48:10 -0700638 ut_assert_console_end();
639 ut_assertnonnull(dev);
640 ut_asserteq_str("mmc0.bootdev", dev->name);
641 ut_asserteq(0, mflags);
642
643 ut_assertok(bootstd_test_check_mmc_hunter(uts));
644
645 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
646 ut_assert_nextline("scanning bus for devices...");
647 ut_assert_skip_to_line(
Julius Lehmann18afb602024-10-26 20:06:44 +0200648 " Capacity: 2.0 MB = 0.0 GB (4096 x 512)");
Simon Glassac06b26a2023-01-17 10:48:10 -0700649 ut_assert_console_end();
650 ut_assertnonnull(dev);
651 ut_asserteq_str("scsi.id0lun0.bootdev", dev->name);
652 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS, mflags);
653
Simon Glassdeffa692023-01-28 15:00:28 -0700654 /* SCSI is 7th in the list, so bit 6 */
655 ut_asserteq(BIT(MMC_HUNTER) | BIT(6), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700656
657 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
658 ut_assert_console_end();
659 ut_assertnonnull(dev);
660 ut_asserteq_str("eth@10002000.bootdev", dev->name);
661 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_DHCP_ONLY,
662 mflags);
663
664 /* dhcp: Ethernet is first so bit 0 */
Simon Glassdeffa692023-01-28 15:00:28 -0700665 ut_asserteq(BIT(MMC_HUNTER) | BIT(6) | BIT(0), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700666
667 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
668 ut_assert_console_end();
669 ut_assertnonnull(dev);
670 ut_asserteq_str("eth@10002000.bootdev", dev->name);
671 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
672 mflags);
673
674 /* pxe: Ethernet is first so bit 0 */
Simon Glassdeffa692023-01-28 15:00:28 -0700675 ut_asserteq(BIT(MMC_HUNTER) | BIT(6) | BIT(0), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700676
677 mflags = 123;
678 ut_asserteq(-ENODEV, bootdev_next_label(&iter, &dev, &mflags));
679 ut_asserteq(123, mflags);
680 ut_assert_console_end();
681
682 /* no change */
Simon Glassdeffa692023-01-28 15:00:28 -0700683 ut_asserteq(BIT(MMC_HUNTER) | BIT(6) | BIT(0), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700684
685 return 0;
686}
Simon Glass1a92f832024-08-22 07:57:48 -0600687BOOTSTD_TEST(bootdev_test_next_label, UTF_DM | UTF_SCAN_FDT | UTF_ETH_BOOTDEV |
Simon Glassf0425022024-08-22 07:57:54 -0600688 UTF_SF_BOOTDEV | UTF_CONSOLE);
Simon Glass660a9952023-01-17 10:48:11 -0700689
Simon Glass660a9952023-01-17 10:48:11 -0700690/* Check iterating to the next prioirty in a list */
691static int bootdev_test_next_prio(struct unit_test_state *uts)
692{
693 struct bootflow_iter iter;
694 struct bootstd_priv *std;
695 struct bootflow bflow;
696 struct udevice *dev;
697 int ret;
698
Simon Glassba3d5372023-01-17 10:48:15 -0700699 test_set_eth_enable(false);
Simon Glass660a9952023-01-17 10:48:11 -0700700 test_set_skip_delays(true);
701
702 /* get access to the used hunters */
703 ut_assertok(bootstd_get_priv(&std));
704
705 memset(&iter, '\0', sizeof(iter));
706 memset(&bflow, '\0', sizeof(bflow));
707 iter.part = 0;
708 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
709 iter.cur_prio = 0;
Simon Glass99e68182023-02-22 12:17:03 -0700710 iter.flags = BOOTFLOWIF_SHOW;
Simon Glass660a9952023-01-17 10:48:11 -0700711
712 dev = NULL;
Simon Glass660a9952023-01-17 10:48:11 -0700713 ut_assertok(bootdev_next_prio(&iter, &dev));
714 ut_assertnonnull(dev);
715 ut_asserteq_str("mmc2.bootdev", dev->name);
716
717 /* hunt flag not set, so this should not use any hunters */
718 ut_asserteq(0, std->hunters_used);
719 ut_assert_console_end();
720
721 /* now try again with hunting enabled */
Simon Glass99e68182023-02-22 12:17:03 -0700722 iter.flags = BOOTFLOWIF_SHOW | BOOTFLOWIF_HUNT;
Simon Glass660a9952023-01-17 10:48:11 -0700723 iter.cur_prio = 0;
724 iter.part = 0;
725
726 ut_assertok(bootdev_next_prio(&iter, &dev));
727 ut_asserteq_str("mmc2.bootdev", dev->name);
Simon Glasse4cf1062023-01-17 10:48:13 -0700728 ut_assert_nextline("Hunting with: simple_bus");
729 ut_assert_nextline("Found 2 extension board(s).");
Simon Glass660a9952023-01-17 10:48:11 -0700730 ut_assert_nextline("Hunting with: mmc");
731 ut_assert_console_end();
732
Simon Glasse4cf1062023-01-17 10:48:13 -0700733 ut_asserteq(BIT(MMC_HUNTER) | BIT(1), std->hunters_used);
Simon Glass660a9952023-01-17 10:48:11 -0700734
735 ut_assertok(bootdev_next_prio(&iter, &dev));
736 ut_asserteq_str("mmc1.bootdev", dev->name);
737
738 ut_assertok(bootdev_next_prio(&iter, &dev));
739 ut_asserteq_str("mmc0.bootdev", dev->name);
740 ut_assert_console_end();
741
742 ut_assertok(bootdev_next_prio(&iter, &dev));
743 ut_asserteq_str("spi.bin@0.bootdev", dev->name);
744 ut_assert_skip_to_line("Hunting with: spi_flash");
745
746 /*
747 * this scans all bootdevs of priority BOOTDEVP_4_SCAN_FAST before it
748 * starts looking at the devices, so we se virtio as well
749 */
750 ut_assert_nextline("Hunting with: virtio");
751 ut_assert_nextlinen("SF: Detected m25p16");
752
753 ut_assertok(bootdev_next_prio(&iter, &dev));
754 ut_asserteq_str("spi.bin@1.bootdev", dev->name);
755 ut_assert_nextlinen("SF: Detected m25p16");
756 ut_assert_console_end();
757
758 /* keep going until there are no more bootdevs */
759 do {
760 ret = bootdev_next_prio(&iter, &dev);
761 } while (!ret);
762 ut_asserteq(-ENODEV, ret);
763 ut_assertnull(dev);
Simon Glasse4cf1062023-01-17 10:48:13 -0700764 ut_asserteq(GENMASK(MAX_HUNTER, 0), std->hunters_used);
Simon Glass660a9952023-01-17 10:48:11 -0700765
766 ut_assert_skip_to_line("Hunting with: ethernet");
767 ut_assert_console_end();
768
769 return 0;
770}
Simon Glassf0425022024-08-22 07:57:54 -0600771BOOTSTD_TEST(bootdev_test_next_prio, UTF_DM | UTF_SCAN_FDT | UTF_SF_BOOTDEV |
772 UTF_CONSOLE);