blob: 5d5ce7f48cf25556138ed13729fd5fc225949a4a [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
9#include <common.h>
10#include <bootstd.h>
11#include <dm.h>
12#include <bootdev.h>
13#include <bootflow.h>
14#include <mapmem.h>
15#include <os.h>
16#include <test/suites.h>
17#include <test/ut.h>
18#include "bootstd_common.h"
19
20/* Allow reseting the USB-started flag */
21extern char usb_started;
22
23/* Check 'bootdev list' command */
24static int bootdev_test_cmd_list(struct unit_test_state *uts)
25{
26 int probed;
27
28 console_record_reset_enable();
29 for (probed = 0; probed < 2; probed++) {
30 int probe_ch = probed ? '+' : ' ';
31
32 ut_assertok(run_command(probed ? "bootdev list -p" :
33 "bootdev list", 0));
34 ut_assert_nextline("Seq Probed Status Uclass Name");
35 ut_assert_nextlinen("---");
36 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 0, probe_ch, "OK",
37 "mmc", "mmc2.bootdev");
38 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 1, probe_ch, "OK",
39 "mmc", "mmc1.bootdev");
40 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 2, probe_ch, "OK",
41 "mmc", "mmc0.bootdev");
42 ut_assert_nextlinen("---");
43 ut_assert_nextline("(3 bootdevs)");
44 ut_assert_console_end();
45 }
46
47 return 0;
48}
49BOOTSTD_TEST(bootdev_test_cmd_list, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
50
51/* Check 'bootdev select' and 'info' commands */
52static int bootdev_test_cmd_select(struct unit_test_state *uts)
53{
54 struct bootstd_priv *std;
55
56 /* get access to the CLI's cur_bootdev */
57 ut_assertok(bootstd_get_priv(&std));
58
59 console_record_reset_enable();
60 ut_asserteq(1, run_command("bootdev info", 0));
61 ut_assert_nextlinen("Please use");
62 ut_assert_console_end();
63
64 /* select by sequence */
65 ut_assertok(run_command("bootdev select 0", 0));
66 ut_assert_console_end();
67
68 ut_assertok(run_command("bootdev info", 0));
69 ut_assert_nextline("Name: mmc2.bootdev");
70 ut_assert_nextline("Sequence: 0");
71 ut_assert_nextline("Status: Probed");
72 ut_assert_nextline("Uclass: mmc");
73 ut_assert_nextline("Bootflows: 0 (0 valid)");
74 ut_assert_console_end();
75
76 /* select by bootdev name */
77 ut_assertok(run_command("bootdev select mmc1.bootdev", 0));
78 ut_assert_console_end();
79 ut_assertnonnull(std->cur_bootdev);
80 ut_asserteq_str("mmc1.bootdev", std->cur_bootdev->name);
81
82 /* select by bootdev label*/
83 ut_assertok(run_command("bootdev select mmc1", 0));
84 ut_assert_console_end();
85 ut_assertnonnull(std->cur_bootdev);
86 ut_asserteq_str("mmc1.bootdev", std->cur_bootdev->name);
87
88 /* deselect */
89 ut_assertok(run_command("bootdev select", 0));
90 ut_assert_console_end();
91 ut_assertnull(std->cur_bootdev);
92
93 ut_asserteq(1, run_command("bootdev info", 0));
94 ut_assert_nextlinen("Please use");
95 ut_assert_console_end();
96
97 return 0;
98}
99BOOTSTD_TEST(bootdev_test_cmd_select, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
100
101/* Check bootdev labels */
102static int bootdev_test_labels(struct unit_test_state *uts)
103{
104 struct udevice *dev, *media;
Simon Glasse22fe922023-01-17 10:48:05 -0700105 int mflags = 0;
Simon Glassb255efc2022-04-24 23:31:24 -0600106
Simon Glasse22fe922023-01-17 10:48:05 -0700107 ut_assertok(bootdev_find_by_label("mmc2", &dev, &mflags));
Simon Glassb255efc2022-04-24 23:31:24 -0600108 ut_asserteq(UCLASS_BOOTDEV, device_get_uclass_id(dev));
Simon Glasse22fe922023-01-17 10:48:05 -0700109 ut_asserteq(0, mflags);
Simon Glassb255efc2022-04-24 23:31:24 -0600110 media = dev_get_parent(dev);
111 ut_asserteq(UCLASS_MMC, device_get_uclass_id(media));
112 ut_asserteq_str("mmc2", media->name);
113
Simon Glasse22fe922023-01-17 10:48:05 -0700114 /* Check method flags */
115 ut_assertok(bootdev_find_by_label("pxe", &dev, &mflags));
Simon Glassde567b12023-01-17 10:48:09 -0700116 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
117 mflags);
Simon Glasse22fe922023-01-17 10:48:05 -0700118 ut_assertok(bootdev_find_by_label("dhcp", &dev, &mflags));
Simon Glassde567b12023-01-17 10:48:09 -0700119 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_DHCP_ONLY,
120 mflags);
Simon Glasse22fe922023-01-17 10:48:05 -0700121
Simon Glassb255efc2022-04-24 23:31:24 -0600122 /* Check invalid uclass */
Simon Glasse22fe922023-01-17 10:48:05 -0700123 ut_asserteq(-EINVAL, bootdev_find_by_label("fred0", &dev, &mflags));
Simon Glassb255efc2022-04-24 23:31:24 -0600124
125 /* Check unknown sequence number */
Simon Glasse22fe922023-01-17 10:48:05 -0700126 ut_asserteq(-ENOENT, bootdev_find_by_label("mmc6", &dev, &mflags));
Simon Glassb255efc2022-04-24 23:31:24 -0600127
128 return 0;
129}
Simon Glasse22fe922023-01-17 10:48:05 -0700130BOOTSTD_TEST(bootdev_test_labels, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
131 UT_TESTF_ETH_BOOTDEV);
Simon Glassb255efc2022-04-24 23:31:24 -0600132
Simon Glassde567b12023-01-17 10:48:09 -0700133/* Check bootdev_find_by_any() */
134static int bootdev_test_any(struct unit_test_state *uts)
135{
136 struct udevice *dev, *media;
137 int mflags;
138
139 /*
140 * with ethernet enabled we have 8 devices ahead of the mmc ones:
141 *
142 * ut_assertok(run_command("bootdev list", 0));
143 * Seq Probed Status Uclass Name
144 * --- ------ ------ -------- ------------------
145 * 0 [ + ] OK ethernet eth@10002000.bootdev
146 * 1 [ ] OK ethernet eth@10003000.bootdev
147 * 2 [ ] OK ethernet sbe5.bootdev
148 * 3 [ ] OK ethernet eth@10004000.bootdev
149 * 4 [ ] OK ethernet phy-test-eth.bootdev
150 * 5 [ ] OK ethernet dsa-test-eth.bootdev
151 * 6 [ ] OK ethernet dsa-test@0.bootdev
152 * 7 [ ] OK ethernet dsa-test@1.bootdev
153 * 8 [ ] OK mmc mmc2.bootdev
154 * 9 [ + ] OK mmc mmc1.bootdev
155 * a [ ] OK mmc mmc0.bootdev
156 */
157 console_record_reset_enable();
158 ut_assertok(bootdev_find_by_any("8", &dev, &mflags));
159 ut_asserteq(UCLASS_BOOTDEV, device_get_uclass_id(dev));
160 ut_asserteq(BOOTFLOW_METHF_SINGLE_DEV, mflags);
161 media = dev_get_parent(dev);
162 ut_asserteq(UCLASS_MMC, device_get_uclass_id(media));
163 ut_asserteq_str("mmc2", media->name);
164 ut_assert_console_end();
165
166 /* there should not be this many bootdevs */
167 ut_asserteq(-ENODEV, bootdev_find_by_any("50", &dev, &mflags));
168 ut_assert_nextline("Cannot find '50' (err=-19)");
169 ut_assert_console_end();
170
171 /* Check method flags */
172 ut_assertok(bootdev_find_by_any("pxe", &dev, &mflags));
173 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
174 mflags);
175
176 /* Check invalid uclass */
177 mflags = 123;
178 ut_asserteq(-EINVAL, bootdev_find_by_any("fred0", &dev, &mflags));
179 ut_assert_nextline("Unknown uclass 'fred0' in label");
180 ut_assert_nextline("Cannot find bootdev 'fred0' (err=-22)");
181 ut_asserteq(123, mflags);
182 ut_assert_console_end();
183
184 return 0;
185}
186BOOTSTD_TEST(bootdev_test_any, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
187 UT_TESTF_ETH_BOOTDEV);
188
Simon Glass484e4072023-01-17 10:48:14 -0700189#if 0 /* disable for now */
Simon Glassb255efc2022-04-24 23:31:24 -0600190/* Check bootdev ordering with the bootdev-order property */
191static int bootdev_test_order(struct unit_test_state *uts)
192{
193 struct bootflow_iter iter;
194 struct bootflow bflow;
195
196 /*
197 * First try the order set by the bootdev-order property
198 * Like all sandbox unit tests this relies on the devicetree setting up
199 * the required devices:
200 *
201 * mmc0 - nothing connected
202 * mmc1 - connected to mmc1.img file
203 * mmc2 - nothing connected
204 */
205 ut_assertok(env_set("boot_targets", NULL));
Simon Glass5d3d44f2023-01-17 10:48:16 -0700206 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600207 ut_asserteq(2, iter.num_devs);
208 ut_asserteq_str("mmc2.bootdev", iter.dev_order[0]->name);
209 ut_asserteq_str("mmc1.bootdev", iter.dev_order[1]->name);
210 bootflow_iter_uninit(&iter);
211
212 /* Use the environment variable to override it */
213 ut_assertok(env_set("boot_targets", "mmc1 mmc2"));
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);
216 ut_asserteq_str("mmc1.bootdev", iter.dev_order[0]->name);
217 ut_asserteq_str("mmc2.bootdev", iter.dev_order[1]->name);
218 bootflow_iter_uninit(&iter);
219
220 /*
221 * Now drop both orderings, to check the default (prioriy/sequence)
222 * ordering
223 */
224 ut_assertok(env_set("boot_targets", NULL));
225 ut_assertok(bootstd_test_drop_bootdev_order(uts));
226
Simon Glass5d3d44f2023-01-17 10:48:16 -0700227 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600228 ut_asserteq(3, iter.num_devs);
229 ut_asserteq_str("mmc2.bootdev", iter.dev_order[0]->name);
230 ut_asserteq_str("mmc1.bootdev", iter.dev_order[1]->name);
231 ut_asserteq_str("mmc0.bootdev", iter.dev_order[2]->name);
232
233 /*
234 * Check that adding aliases for the bootdevs works. We just fake it by
235 * setting the sequence numbers directly.
236 */
237 iter.dev_order[0]->seq_ = 0;
238 iter.dev_order[1]->seq_ = 3;
239 iter.dev_order[2]->seq_ = 2;
240 bootflow_iter_uninit(&iter);
241
Simon Glass5d3d44f2023-01-17 10:48:16 -0700242 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600243 ut_asserteq(3, iter.num_devs);
244 ut_asserteq_str("mmc2.bootdev", iter.dev_order[0]->name);
245 ut_asserteq_str("mmc0.bootdev", iter.dev_order[1]->name);
246 ut_asserteq_str("mmc1.bootdev", iter.dev_order[2]->name);
247 bootflow_iter_uninit(&iter);
248
249 return 0;
250}
251BOOTSTD_TEST(bootdev_test_order, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
252
253/* Check bootdev ordering with the uclass priority */
254static int bootdev_test_prio(struct unit_test_state *uts)
255{
256 struct bootdev_uc_plat *ucp;
257 struct bootflow_iter iter;
258 struct bootflow bflow;
259 struct udevice *blk;
260
Simon Glassf3cb89f2023-01-17 10:47:37 -0700261 test_set_skip_delays(true);
262
Simon Glassb255efc2022-04-24 23:31:24 -0600263 /* Start up USB which gives us three additional bootdevs */
264 usb_started = false;
265 ut_assertok(run_command("usb start", 0));
266
267 ut_assertok(bootstd_test_drop_bootdev_order(uts));
268
269 /* 3 MMC and 3 USB bootdevs: MMC should come before USB */
270 console_record_reset_enable();
Simon Glass5d3d44f2023-01-17 10:48:16 -0700271 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600272 ut_asserteq(6, iter.num_devs);
273 ut_asserteq_str("mmc2.bootdev", iter.dev_order[0]->name);
274 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
275 iter.dev_order[3]->name);
276
277 ut_assertok(bootdev_get_sibling_blk(iter.dev_order[3], &blk));
278 ut_asserteq_str("usb_mass_storage.lun0", blk->name);
279
280 /* adjust the priority of the first USB bootdev to the highest */
281 ucp = dev_get_uclass_plat(iter.dev_order[3]);
282 ucp->prio = 1;
283
284 bootflow_iter_uninit(&iter);
Simon Glass5d3d44f2023-01-17 10:48:16 -0700285 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, BOOTFLOWF_HUNT,
286 &bflow));
Simon Glassb255efc2022-04-24 23:31:24 -0600287 ut_asserteq(6, iter.num_devs);
288 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
289 iter.dev_order[0]->name);
290 ut_asserteq_str("mmc2.bootdev", iter.dev_order[1]->name);
291
292 return 0;
293}
294BOOTSTD_TEST(bootdev_test_prio, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glass484e4072023-01-17 10:48:14 -0700295#endif
Simon Glass5acb97a2023-01-17 10:47:33 -0700296
297/* Check listing hunters */
298static int bootdev_test_hunter(struct unit_test_state *uts)
299{
300 struct bootstd_priv *std;
301
Simon Glassf3cb89f2023-01-17 10:47:37 -0700302 test_set_skip_delays(true);
303
Simon Glass5acb97a2023-01-17 10:47:33 -0700304 /* get access to the used hunters */
305 ut_assertok(bootstd_get_priv(&std));
306
307 console_record_reset_enable();
308 bootdev_list_hunters(std);
309 ut_assert_nextline("Prio Used Uclass Hunter");
310 ut_assert_nextlinen("----");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700311 ut_assert_nextline(" 6 ethernet eth_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700312 ut_assert_nextline(" 1 simple_bus (none)");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700313 ut_assert_nextline(" 5 ide ide_bootdev");
314 ut_assert_nextline(" 2 mmc mmc_bootdev");
315 ut_assert_nextline(" 4 nvme nvme_bootdev");
316 ut_assert_nextline(" 4 scsi scsi_bootdev");
317 ut_assert_nextline(" 4 spi_flash sf_bootdev");
318 ut_assert_nextline(" 5 usb usb_bootdev");
319 ut_assert_nextline(" 4 virtio virtio_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700320 ut_assert_nextline("(total hunters: 9)");
Simon Glass5acb97a2023-01-17 10:47:33 -0700321 ut_assert_console_end();
322
Simon Glassf3cb89f2023-01-17 10:47:37 -0700323 ut_assertok(bootdev_hunt("usb1", false));
324 ut_assert_nextline(
325 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
Simon Glass1248d2b2023-01-17 10:47:34 -0700326 ut_assert_console_end();
327
Simon Glasse4cf1062023-01-17 10:48:13 -0700328 /* USB is sixth in the list, so bit 7 */
329 ut_asserteq(BIT(7), std->hunters_used);
Simon Glassf3cb89f2023-01-17 10:47:37 -0700330
Simon Glass5acb97a2023-01-17 10:47:33 -0700331 return 0;
332}
333BOOTSTD_TEST(bootdev_test_hunter, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
334
335/* Check 'bootdev hunt' command */
336static int bootdev_test_cmd_hunt(struct unit_test_state *uts)
337{
338 struct bootstd_priv *std;
339
Simon Glassf3cb89f2023-01-17 10:47:37 -0700340 test_set_skip_delays(true);
341
Simon Glass5acb97a2023-01-17 10:47:33 -0700342 /* get access to the used hunters */
343 ut_assertok(bootstd_get_priv(&std));
344
345 console_record_reset_enable();
346 ut_assertok(run_command("bootdev hunt -l", 0));
347 ut_assert_nextline("Prio Used Uclass Hunter");
348 ut_assert_nextlinen("----");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700349 ut_assert_nextline(" 6 ethernet eth_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700350 ut_assert_skip_to_line("(total hunters: 9)");
Simon Glass5acb97a2023-01-17 10:47:33 -0700351 ut_assert_console_end();
352
Simon Glass7e1f6a42023-01-17 10:48:08 -0700353 /* Use the MMC hunter and see that it updates */
354 ut_assertok(run_command("bootdev hunt mmc", 0));
355 ut_assertok(run_command("bootdev hunt -l", 0));
356 ut_assert_skip_to_line(" 5 ide ide_bootdev");
357 ut_assert_nextline(" 2 * mmc mmc_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700358 ut_assert_skip_to_line("(total hunters: 9)");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700359 ut_assert_console_end();
360
Simon Glass5acb97a2023-01-17 10:47:33 -0700361 /* Scan all hunters */
Simon Glassac06b26a2023-01-17 10:48:10 -0700362 test_set_eth_enable(false);
Simon Glass7e1f6a42023-01-17 10:48:08 -0700363 test_set_skip_delays(true);
Simon Glass5acb97a2023-01-17 10:47:33 -0700364 ut_assertok(run_command("bootdev hunt", 0));
Simon Glass5ea0a8d2023-01-17 10:47:40 -0700365 ut_assert_nextline("Hunting with: ethernet");
Simon Glasse4cf1062023-01-17 10:48:13 -0700366
367 /* This is the extension feature which has no uclass at present */
368 ut_assert_nextline("Hunting with: simple_bus");
369 ut_assert_nextline("Found 2 extension board(s).");
Simon Glassbe7c6662023-01-17 10:47:46 -0700370 ut_assert_nextline("Hunting with: ide");
371 ut_assert_nextline("Bus 0: not available ");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700372
373 /* mmc hunter has already been used so should not run again */
374
Simon Glass08382872023-01-17 10:47:47 -0700375 ut_assert_nextline("Hunting with: nvme");
Simon Glass9985e9c2023-01-17 10:47:45 -0700376 ut_assert_nextline("Hunting with: scsi");
377 ut_assert_nextline("scanning bus for devices...");
Simon Glass215be682023-01-17 10:48:03 -0700378 ut_assert_skip_to_line("Hunting with: spi_flash");
379 ut_assert_nextline("Hunting with: usb");
Simon Glassf3cb89f2023-01-17 10:47:37 -0700380 ut_assert_nextline(
381 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
Simon Glass215be682023-01-17 10:48:03 -0700382 ut_assert_nextline("Hunting with: virtio");
Simon Glass5acb97a2023-01-17 10:47:33 -0700383 ut_assert_console_end();
384
385 /* List available hunters */
386 ut_assertok(run_command("bootdev hunt -l", 0));
387 ut_assert_nextlinen("Prio");
388 ut_assert_nextlinen("----");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700389 ut_assert_nextline(" 6 * ethernet eth_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700390 ut_assert_nextline(" 1 * simple_bus (none)");
Simon Glass7e1f6a42023-01-17 10:48:08 -0700391 ut_assert_nextline(" 5 * ide ide_bootdev");
392 ut_assert_nextline(" 2 * mmc mmc_bootdev");
393 ut_assert_nextline(" 4 * nvme nvme_bootdev");
394 ut_assert_nextline(" 4 * scsi scsi_bootdev");
395 ut_assert_nextline(" 4 * spi_flash sf_bootdev");
396 ut_assert_nextline(" 5 * usb usb_bootdev");
397 ut_assert_nextline(" 4 * virtio virtio_bootdev");
Simon Glasse4cf1062023-01-17 10:48:13 -0700398 ut_assert_nextline("(total hunters: 9)");
Simon Glass5acb97a2023-01-17 10:47:33 -0700399 ut_assert_console_end();
400
Simon Glasse4cf1062023-01-17 10:48:13 -0700401 ut_asserteq(GENMASK(MAX_HUNTER, 0), std->hunters_used);
Simon Glass5acb97a2023-01-17 10:47:33 -0700402
403 return 0;
404}
405BOOTSTD_TEST(bootdev_test_cmd_hunt, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
406 UT_TESTF_ETH_BOOTDEV);
Simon Glass64cbc5c2023-01-17 10:47:42 -0700407
Simon Glass484e4072023-01-17 10:48:14 -0700408/* Check searching for bootdevs using the hunters */
409static int bootdev_test_hunt_scan(struct unit_test_state *uts)
410{
411 struct bootflow_iter iter;
412 struct bootstd_priv *std;
413 struct bootflow bflow;
414
415 /* get access to the used hunters */
416 ut_assertok(bootstd_get_priv(&std));
417
418 ut_assertok(bootstd_test_drop_bootdev_order(uts));
Simon Glass5d3d44f2023-01-17 10:48:16 -0700419 ut_assertok(bootflow_scan_first(NULL, NULL, &iter,
420 BOOTFLOWF_SHOW | BOOTFLOWF_HUNT |
Simon Glass484e4072023-01-17 10:48:14 -0700421 BOOTFLOWF_SKIP_GLOBAL, &bflow));
422 ut_asserteq(BIT(MMC_HUNTER) | BIT(1), std->hunters_used);
423
424 return 0;
425}
426BOOTSTD_TEST(bootdev_test_hunt_scan, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
427
Simon Glass64cbc5c2023-01-17 10:47:42 -0700428/* Check that only bootable partitions are processed */
429static int bootdev_test_bootable(struct unit_test_state *uts)
430{
431 struct bootflow_iter iter;
432 struct bootflow bflow;
433 struct udevice *blk;
434
435 memset(&iter, '\0', sizeof(iter));
436 memset(&bflow, '\0', sizeof(bflow));
437 iter.part = 0;
438 ut_assertok(uclass_get_device_by_name(UCLASS_BLK, "mmc1.blk", &blk));
439 iter.dev = blk;
440 ut_assertok(device_find_next_child(&iter.dev));
441 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
442
443 /*
444 * initially we don't have any knowledge of which partitions are
445 * bootable, but mmc1 has two partitions, with the first one being
446 * bootable
447 */
448 iter.part = 2;
449 ut_asserteq(-EINVAL, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
450 ut_asserteq(0, iter.first_bootable);
451
452 /* scan with part == 0 to get the partition info */
453 iter.part = 0;
454 ut_asserteq(-ENOENT, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
455 ut_asserteq(1, iter.first_bootable);
456
457 /* now it will refuse to use non-bootable partitions */
458 iter.part = 2;
459 ut_asserteq(-EINVAL, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
460
461 return 0;
462}
463BOOTSTD_TEST(bootdev_test_bootable, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glass3e9f6be2023-01-17 10:48:07 -0700464
465/* Check hunting for bootdev of a particular priority */
466static int bootdev_test_hunt_prio(struct unit_test_state *uts)
467{
468 test_set_skip_delays(true);
469
470 console_record_reset_enable();
Simon Glass7e1f6a42023-01-17 10:48:08 -0700471 ut_assertok(bootdev_hunt_prio(BOOTDEVP_4_SCAN_FAST, false));
Simon Glass3e9f6be2023-01-17 10:48:07 -0700472 ut_assert_nextline("scanning bus for devices...");
473 ut_assert_skip_to_line(" Type: Hard Disk");
474 ut_assert_nextlinen(" Capacity:");
475 ut_assert_console_end();
476
477 /* now try a different priority, verbosely */
Simon Glass7e1f6a42023-01-17 10:48:08 -0700478 ut_assertok(bootdev_hunt_prio(BOOTDEVP_5_SCAN_SLOW, true));
Simon Glass3e9f6be2023-01-17 10:48:07 -0700479 ut_assert_nextline("Hunting with: ide");
480 ut_assert_nextline("Bus 0: not available ");
481 ut_assert_nextline("Hunting with: usb");
482 ut_assert_nextline(
483 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
484 ut_assert_console_end();
485
486 return 0;
487}
488BOOTSTD_TEST(bootdev_test_hunt_prio, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glassde567b12023-01-17 10:48:09 -0700489
490/* Check hunting for bootdevs with a particular label */
491static int bootdev_test_hunt_label(struct unit_test_state *uts)
492{
493 struct udevice *dev, *old;
494 struct bootstd_priv *std;
495 int mflags;
496
497 /* get access to the used hunters */
498 ut_assertok(bootstd_get_priv(&std));
499
500 /* scan an unknown uclass */
501 console_record_reset_enable();
502 old = (void *)&mflags; /* arbitrary pointer to check against dev */
503 dev = old;
504 mflags = 123;
505 ut_asserteq(-EINVAL,
506 bootdev_hunt_and_find_by_label("fred", &dev, &mflags));
507 ut_assert_nextline("Unknown uclass 'fred' in label");
508 ut_asserteq_ptr(old, dev);
509 ut_asserteq(123, mflags);
510 ut_assert_console_end();
511 ut_asserteq(0, std->hunters_used);
512
513 /* scan an invalid mmc controllers */
514 ut_asserteq(-ENOENT,
515 bootdev_hunt_and_find_by_label("mmc4", &dev, &mflags));
516 ut_asserteq_ptr(old, dev);
517 ut_asserteq(123, mflags);
518 ut_assert_nextline("Unknown seq 4 for label 'mmc4'");
519 ut_assert_console_end();
520
521 ut_assertok(bootstd_test_check_mmc_hunter(uts));
522
523 /* scan for a particular mmc controller */
524 ut_assertok(bootdev_hunt_and_find_by_label("mmc1", &dev, &mflags));
525 ut_assertnonnull(dev);
526 ut_asserteq_str("mmc1.bootdev", dev->name);
527 ut_asserteq(0, mflags);
528 ut_assert_console_end();
529
530 /* scan all of usb */
531 test_set_skip_delays(true);
532 ut_assertok(bootdev_hunt_and_find_by_label("usb", &dev, &mflags));
533 ut_assertnonnull(dev);
534 ut_asserteq_str("usb_mass_storage.lun0.bootdev", dev->name);
535 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS, mflags);
536 ut_assert_nextlinen("Bus usb@1: scanning bus usb@1");
537 ut_assert_console_end();
538
539 return 0;
540}
541BOOTSTD_TEST(bootdev_test_hunt_label, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glassac06b26a2023-01-17 10:48:10 -0700542
543/* Check iterating to the next label in a list */
544static int bootdev_test_next_label(struct unit_test_state *uts)
545{
546 const char *const labels[] = {"mmc0", "scsi", "dhcp", "pxe", NULL};
547 struct bootflow_iter iter;
548 struct bootstd_priv *std;
549 struct bootflow bflow;
550 struct udevice *dev;
551 int mflags;
552
553 test_set_eth_enable(false);
554
555 /* get access to the used hunters */
556 ut_assertok(bootstd_get_priv(&std));
557
558 memset(&iter, '\0', sizeof(iter));
559 memset(&bflow, '\0', sizeof(bflow));
560 iter.part = 0;
561 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
562 iter.cur_label = -1;
563 iter.labels = labels;
564
565 dev = NULL;
566 mflags = 123;
567 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
568 console_record_reset_enable();
569 ut_assert_console_end();
570 ut_assertnonnull(dev);
571 ut_asserteq_str("mmc0.bootdev", dev->name);
572 ut_asserteq(0, mflags);
573
574 ut_assertok(bootstd_test_check_mmc_hunter(uts));
575
576 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
577 ut_assert_nextline("scanning bus for devices...");
578 ut_assert_skip_to_line(
579 " Capacity: 1.9 MB = 0.0 GB (4095 x 512)");
580 ut_assert_console_end();
581 ut_assertnonnull(dev);
582 ut_asserteq_str("scsi.id0lun0.bootdev", dev->name);
583 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS, mflags);
584
Simon Glasse4cf1062023-01-17 10:48:13 -0700585 /* SCSI is sixth in the list, so bit 5 */
586 ut_asserteq(BIT(MMC_HUNTER) | BIT(5), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700587
588 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
589 ut_assert_console_end();
590 ut_assertnonnull(dev);
591 ut_asserteq_str("eth@10002000.bootdev", dev->name);
592 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_DHCP_ONLY,
593 mflags);
594
595 /* dhcp: Ethernet is first so bit 0 */
Simon Glasse4cf1062023-01-17 10:48:13 -0700596 ut_asserteq(BIT(MMC_HUNTER) | BIT(5) | BIT(0), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700597
598 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
599 ut_assert_console_end();
600 ut_assertnonnull(dev);
601 ut_asserteq_str("eth@10002000.bootdev", dev->name);
602 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
603 mflags);
604
605 /* pxe: Ethernet is first so bit 0 */
Simon Glasse4cf1062023-01-17 10:48:13 -0700606 ut_asserteq(BIT(MMC_HUNTER) | BIT(5) | BIT(0), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700607
608 mflags = 123;
609 ut_asserteq(-ENODEV, bootdev_next_label(&iter, &dev, &mflags));
610 ut_asserteq(123, mflags);
611 ut_assert_console_end();
612
613 /* no change */
Simon Glasse4cf1062023-01-17 10:48:13 -0700614 ut_asserteq(BIT(MMC_HUNTER) | BIT(5) | BIT(0), std->hunters_used);
Simon Glassac06b26a2023-01-17 10:48:10 -0700615
616 return 0;
617}
618BOOTSTD_TEST(bootdev_test_next_label, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
619 UT_TESTF_ETH_BOOTDEV | UT_TESTF_SF_BOOTDEV);
Simon Glass660a9952023-01-17 10:48:11 -0700620
621
622/* Check iterating to the next prioirty in a list */
623static int bootdev_test_next_prio(struct unit_test_state *uts)
624{
625 struct bootflow_iter iter;
626 struct bootstd_priv *std;
627 struct bootflow bflow;
628 struct udevice *dev;
629 int ret;
630
Simon Glassba3d5372023-01-17 10:48:15 -0700631 test_set_eth_enable(false);
Simon Glass660a9952023-01-17 10:48:11 -0700632 test_set_skip_delays(true);
633
634 /* get access to the used hunters */
635 ut_assertok(bootstd_get_priv(&std));
636
637 memset(&iter, '\0', sizeof(iter));
638 memset(&bflow, '\0', sizeof(bflow));
639 iter.part = 0;
640 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
641 iter.cur_prio = 0;
642 iter.flags = BOOTFLOWF_SHOW;
643
644 dev = NULL;
645 console_record_reset_enable();
646 ut_assertok(bootdev_next_prio(&iter, &dev));
647 ut_assertnonnull(dev);
648 ut_asserteq_str("mmc2.bootdev", dev->name);
649
650 /* hunt flag not set, so this should not use any hunters */
651 ut_asserteq(0, std->hunters_used);
652 ut_assert_console_end();
653
654 /* now try again with hunting enabled */
655 iter.flags = BOOTFLOWF_SHOW | BOOTFLOWF_HUNT;
656 iter.cur_prio = 0;
657 iter.part = 0;
658
659 ut_assertok(bootdev_next_prio(&iter, &dev));
660 ut_asserteq_str("mmc2.bootdev", dev->name);
Simon Glasse4cf1062023-01-17 10:48:13 -0700661 ut_assert_nextline("Hunting with: simple_bus");
662 ut_assert_nextline("Found 2 extension board(s).");
Simon Glass660a9952023-01-17 10:48:11 -0700663 ut_assert_nextline("Hunting with: mmc");
664 ut_assert_console_end();
665
Simon Glasse4cf1062023-01-17 10:48:13 -0700666 ut_asserteq(BIT(MMC_HUNTER) | BIT(1), std->hunters_used);
Simon Glass660a9952023-01-17 10:48:11 -0700667
668 ut_assertok(bootdev_next_prio(&iter, &dev));
669 ut_asserteq_str("mmc1.bootdev", dev->name);
670
671 ut_assertok(bootdev_next_prio(&iter, &dev));
672 ut_asserteq_str("mmc0.bootdev", dev->name);
673 ut_assert_console_end();
674
675 ut_assertok(bootdev_next_prio(&iter, &dev));
676 ut_asserteq_str("spi.bin@0.bootdev", dev->name);
677 ut_assert_skip_to_line("Hunting with: spi_flash");
678
679 /*
680 * this scans all bootdevs of priority BOOTDEVP_4_SCAN_FAST before it
681 * starts looking at the devices, so we se virtio as well
682 */
683 ut_assert_nextline("Hunting with: virtio");
684 ut_assert_nextlinen("SF: Detected m25p16");
685
686 ut_assertok(bootdev_next_prio(&iter, &dev));
687 ut_asserteq_str("spi.bin@1.bootdev", dev->name);
688 ut_assert_nextlinen("SF: Detected m25p16");
689 ut_assert_console_end();
690
691 /* keep going until there are no more bootdevs */
692 do {
693 ret = bootdev_next_prio(&iter, &dev);
694 } while (!ret);
695 ut_asserteq(-ENODEV, ret);
696 ut_assertnull(dev);
Simon Glasse4cf1062023-01-17 10:48:13 -0700697 ut_asserteq(GENMASK(MAX_HUNTER, 0), std->hunters_used);
Simon Glass660a9952023-01-17 10:48:11 -0700698
699 ut_assert_skip_to_line("Hunting with: ethernet");
700 ut_assert_console_end();
701
702 return 0;
703}
704BOOTSTD_TEST(bootdev_test_next_prio, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
705 UT_TESTF_SF_BOOTDEV);