blob: 7228f545e9e648a76b1cee6e03032297ada27a57 [file] [log] [blame]
Simon Glassfb1451b2022-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 */
Linus Walleij0c1413f2023-01-23 23:07:21 +010021#if defined(CONFIG_USB_HOST) || defined(CONFIG_USB_GADGET)
Simon Glass9fea3a72023-05-05 20:03:03 -060022extern bool usb_started;
Linus Walleij0c1413f2023-01-23 23:07:21 +010023#else
Simon Glass9fea3a72023-05-05 20:03:03 -060024#include <usb.h>
Linus Walleij0c1413f2023-01-23 23:07:21 +010025#endif
Simon Glassfb1451b2022-04-24 23:31:24 -060026
27/* Check 'bootdev list' command */
28static int bootdev_test_cmd_list(struct unit_test_state *uts)
29{
30 int probed;
31
32 console_record_reset_enable();
33 for (probed = 0; probed < 2; probed++) {
34 int probe_ch = probed ? '+' : ' ';
35
36 ut_assertok(run_command(probed ? "bootdev list -p" :
37 "bootdev list", 0));
38 ut_assert_nextline("Seq Probed Status Uclass Name");
39 ut_assert_nextlinen("---");
40 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 0, probe_ch, "OK",
41 "mmc", "mmc2.bootdev");
42 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 1, probe_ch, "OK",
43 "mmc", "mmc1.bootdev");
44 ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 2, probe_ch, "OK",
45 "mmc", "mmc0.bootdev");
46 ut_assert_nextlinen("---");
47 ut_assert_nextline("(3 bootdevs)");
48 ut_assert_console_end();
49 }
50
51 return 0;
52}
53BOOTSTD_TEST(bootdev_test_cmd_list, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
54
55/* Check 'bootdev select' and 'info' commands */
56static int bootdev_test_cmd_select(struct unit_test_state *uts)
57{
58 struct bootstd_priv *std;
59
60 /* get access to the CLI's cur_bootdev */
61 ut_assertok(bootstd_get_priv(&std));
62
63 console_record_reset_enable();
64 ut_asserteq(1, run_command("bootdev info", 0));
65 ut_assert_nextlinen("Please use");
66 ut_assert_console_end();
67
68 /* select by sequence */
69 ut_assertok(run_command("bootdev select 0", 0));
70 ut_assert_console_end();
71
72 ut_assertok(run_command("bootdev info", 0));
73 ut_assert_nextline("Name: mmc2.bootdev");
74 ut_assert_nextline("Sequence: 0");
75 ut_assert_nextline("Status: Probed");
76 ut_assert_nextline("Uclass: mmc");
77 ut_assert_nextline("Bootflows: 0 (0 valid)");
78 ut_assert_console_end();
79
80 /* select by bootdev name */
81 ut_assertok(run_command("bootdev select mmc1.bootdev", 0));
82 ut_assert_console_end();
83 ut_assertnonnull(std->cur_bootdev);
84 ut_asserteq_str("mmc1.bootdev", std->cur_bootdev->name);
85
86 /* select by bootdev label*/
87 ut_assertok(run_command("bootdev select mmc1", 0));
88 ut_assert_console_end();
89 ut_assertnonnull(std->cur_bootdev);
90 ut_asserteq_str("mmc1.bootdev", std->cur_bootdev->name);
91
92 /* deselect */
93 ut_assertok(run_command("bootdev select", 0));
94 ut_assert_console_end();
95 ut_assertnull(std->cur_bootdev);
96
97 ut_asserteq(1, run_command("bootdev info", 0));
98 ut_assert_nextlinen("Please use");
99 ut_assert_console_end();
100
101 return 0;
102}
103BOOTSTD_TEST(bootdev_test_cmd_select, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
104
105/* Check bootdev labels */
106static int bootdev_test_labels(struct unit_test_state *uts)
107{
108 struct udevice *dev, *media;
Simon Glassd9f48572023-01-17 10:48:05 -0700109 int mflags = 0;
Simon Glassfb1451b2022-04-24 23:31:24 -0600110
Simon Glassd9f48572023-01-17 10:48:05 -0700111 ut_assertok(bootdev_find_by_label("mmc2", &dev, &mflags));
Simon Glassfb1451b2022-04-24 23:31:24 -0600112 ut_asserteq(UCLASS_BOOTDEV, device_get_uclass_id(dev));
Simon Glassd9f48572023-01-17 10:48:05 -0700113 ut_asserteq(0, mflags);
Simon Glassfb1451b2022-04-24 23:31:24 -0600114 media = dev_get_parent(dev);
115 ut_asserteq(UCLASS_MMC, device_get_uclass_id(media));
116 ut_asserteq_str("mmc2", media->name);
117
Simon Glassd9f48572023-01-17 10:48:05 -0700118 /* Check method flags */
119 ut_assertok(bootdev_find_by_label("pxe", &dev, &mflags));
Simon Glass66e3dce2023-01-17 10:48:09 -0700120 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
121 mflags);
Simon Glassd9f48572023-01-17 10:48:05 -0700122 ut_assertok(bootdev_find_by_label("dhcp", &dev, &mflags));
Simon Glass66e3dce2023-01-17 10:48:09 -0700123 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_DHCP_ONLY,
124 mflags);
Simon Glassd9f48572023-01-17 10:48:05 -0700125
Simon Glassfb1451b2022-04-24 23:31:24 -0600126 /* Check invalid uclass */
Simon Glass1736b4a2023-04-24 13:49:47 +1200127 ut_asserteq(-EPFNOSUPPORT,
128 bootdev_find_by_label("fred0", &dev, &mflags));
Simon Glassfb1451b2022-04-24 23:31:24 -0600129
130 /* Check unknown sequence number */
Simon Glassd9f48572023-01-17 10:48:05 -0700131 ut_asserteq(-ENOENT, bootdev_find_by_label("mmc6", &dev, &mflags));
Simon Glassfb1451b2022-04-24 23:31:24 -0600132
133 return 0;
134}
Simon Glassd9f48572023-01-17 10:48:05 -0700135BOOTSTD_TEST(bootdev_test_labels, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
136 UT_TESTF_ETH_BOOTDEV);
Simon Glassfb1451b2022-04-24 23:31:24 -0600137
Simon Glass66e3dce2023-01-17 10:48:09 -0700138/* Check bootdev_find_by_any() */
139static int bootdev_test_any(struct unit_test_state *uts)
140{
141 struct udevice *dev, *media;
142 int mflags;
143
144 /*
145 * with ethernet enabled we have 8 devices ahead of the mmc ones:
146 *
147 * ut_assertok(run_command("bootdev list", 0));
148 * Seq Probed Status Uclass Name
149 * --- ------ ------ -------- ------------------
150 * 0 [ + ] OK ethernet eth@10002000.bootdev
151 * 1 [ ] OK ethernet eth@10003000.bootdev
152 * 2 [ ] OK ethernet sbe5.bootdev
153 * 3 [ ] OK ethernet eth@10004000.bootdev
154 * 4 [ ] OK ethernet phy-test-eth.bootdev
155 * 5 [ ] OK ethernet dsa-test-eth.bootdev
156 * 6 [ ] OK ethernet dsa-test@0.bootdev
157 * 7 [ ] OK ethernet dsa-test@1.bootdev
158 * 8 [ ] OK mmc mmc2.bootdev
159 * 9 [ + ] OK mmc mmc1.bootdev
160 * a [ ] OK mmc mmc0.bootdev
161 */
162 console_record_reset_enable();
163 ut_assertok(bootdev_find_by_any("8", &dev, &mflags));
164 ut_asserteq(UCLASS_BOOTDEV, device_get_uclass_id(dev));
165 ut_asserteq(BOOTFLOW_METHF_SINGLE_DEV, mflags);
166 media = dev_get_parent(dev);
167 ut_asserteq(UCLASS_MMC, device_get_uclass_id(media));
168 ut_asserteq_str("mmc2", media->name);
169 ut_assert_console_end();
170
171 /* there should not be this many bootdevs */
172 ut_asserteq(-ENODEV, bootdev_find_by_any("50", &dev, &mflags));
173 ut_assert_nextline("Cannot find '50' (err=-19)");
174 ut_assert_console_end();
175
176 /* Check method flags */
177 ut_assertok(bootdev_find_by_any("pxe", &dev, &mflags));
178 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
179 mflags);
180
181 /* Check invalid uclass */
182 mflags = 123;
Simon Glass1736b4a2023-04-24 13:49:47 +1200183 ut_asserteq(-EPFNOSUPPORT, bootdev_find_by_any("fred0", &dev, &mflags));
184 ut_assert_nextline("Cannot find bootdev 'fred0' (err=-96)");
Simon Glass66e3dce2023-01-17 10:48:09 -0700185 ut_asserteq(123, mflags);
186 ut_assert_console_end();
187
188 return 0;
189}
190BOOTSTD_TEST(bootdev_test_any, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
191 UT_TESTF_ETH_BOOTDEV);
192
Simon Glass7ae83bf2023-10-23 00:02:11 -0700193/*
194 * Check bootdev ordering with the bootdev-order property and boot_targets
195 * environment variable
196 */
Simon Glassfb1451b2022-04-24 23:31:24 -0600197static int bootdev_test_order(struct unit_test_state *uts)
198{
199 struct bootflow_iter iter;
200 struct bootflow bflow;
201
Simon Glass7ae83bf2023-10-23 00:02:11 -0700202 test_set_skip_delays(true);
203
204 /* Start up USB which gives us three additional bootdevs */
205 usb_started = false;
206 ut_assertok(run_command("usb start", 0));
207
Simon Glassfb1451b2022-04-24 23:31:24 -0600208 /*
209 * First try the order set by the bootdev-order property
210 * Like all sandbox unit tests this relies on the devicetree setting up
211 * the required devices:
212 *
213 * mmc0 - nothing connected
214 * mmc1 - connected to mmc1.img file
215 * mmc2 - nothing connected
216 */
217 ut_assertok(env_set("boot_targets", NULL));
Simon Glass4b7cb052023-01-17 10:48:16 -0700218 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassfb1451b2022-04-24 23:31:24 -0600219 ut_asserteq(2, iter.num_devs);
Simon Glassa950f282023-01-17 10:48:17 -0700220 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
221 ut_asserteq_str("mmc1.bootdev", iter.dev_used[1]->name);
Simon Glassfb1451b2022-04-24 23:31:24 -0600222 bootflow_iter_uninit(&iter);
223
224 /* Use the environment variable to override it */
Simon Glass7ae83bf2023-10-23 00:02:11 -0700225 ut_assertok(env_set("boot_targets", "mmc1 mmc2 usb"));
Simon Glass4b7cb052023-01-17 10:48:16 -0700226 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassa950f282023-01-17 10:48:17 -0700227 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
Simon Glass7ae83bf2023-10-23 00:02:11 -0700228 ut_asserteq(3, iter.num_devs);
Simon Glassa950f282023-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 Glass7ae83bf2023-10-23 00:02:11 -0700231 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
232 iter.dev_used[2]->name);
Simon Glassfb1451b2022-04-24 23:31:24 -0600233 bootflow_iter_uninit(&iter);
234
Simon Glassa950f282023-01-17 10:48:17 -0700235 return 0;
236}
237BOOTSTD_TEST(bootdev_test_order, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
238
239/* Check default bootdev ordering */
240static int bootdev_test_order_default(struct unit_test_state *uts)
241{
242 struct bootflow_iter iter;
243 struct bootflow bflow;
244
Simon Glassfb1451b2022-04-24 23:31:24 -0600245 /*
246 * Now drop both orderings, to check the default (prioriy/sequence)
247 * ordering
248 */
249 ut_assertok(env_set("boot_targets", NULL));
250 ut_assertok(bootstd_test_drop_bootdev_order(uts));
251
Simon Glass4b7cb052023-01-17 10:48:16 -0700252 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassa950f282023-01-17 10:48:17 -0700253 ut_asserteq(2, iter.num_devs);
254 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
255 ut_asserteq_str("mmc1.bootdev", iter.dev_used[1]->name);
Simon Glassfb1451b2022-04-24 23:31:24 -0600256
Simon Glassa950f282023-01-17 10:48:17 -0700257 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
Simon Glassfb1451b2022-04-24 23:31:24 -0600258 ut_asserteq(3, iter.num_devs);
Simon Glassa950f282023-01-17 10:48:17 -0700259 ut_asserteq_str("mmc0.bootdev", iter.dev_used[2]->name);
Simon Glassfb1451b2022-04-24 23:31:24 -0600260 bootflow_iter_uninit(&iter);
261
262 return 0;
263}
Simon Glassa950f282023-01-17 10:48:17 -0700264BOOTSTD_TEST(bootdev_test_order_default, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glassfb1451b2022-04-24 23:31:24 -0600265
266/* Check bootdev ordering with the uclass priority */
267static int bootdev_test_prio(struct unit_test_state *uts)
268{
269 struct bootdev_uc_plat *ucp;
270 struct bootflow_iter iter;
271 struct bootflow bflow;
272 struct udevice *blk;
273
Simon Glass04fb2b62023-01-17 10:47:37 -0700274 test_set_skip_delays(true);
275
Simon Glassa950f282023-01-17 10:48:17 -0700276 /* disable ethernet since the hunter will run dhcp */
277 test_set_eth_enable(false);
278
Simon Glassfb1451b2022-04-24 23:31:24 -0600279 /* Start up USB which gives us three additional bootdevs */
280 usb_started = false;
281 ut_assertok(run_command("usb start", 0));
282
283 ut_assertok(bootstd_test_drop_bootdev_order(uts));
284
285 /* 3 MMC and 3 USB bootdevs: MMC should come before USB */
286 console_record_reset_enable();
Simon Glass4b7cb052023-01-17 10:48:16 -0700287 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, 0, &bflow));
Simon Glassa950f282023-01-17 10:48:17 -0700288 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
Simon Glassfb1451b2022-04-24 23:31:24 -0600289 ut_asserteq(6, iter.num_devs);
Simon Glassa950f282023-01-17 10:48:17 -0700290 ut_asserteq_str("mmc2.bootdev", iter.dev_used[0]->name);
Simon Glassfb1451b2022-04-24 23:31:24 -0600291 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
Simon Glassa950f282023-01-17 10:48:17 -0700292 iter.dev_used[3]->name);
Simon Glassfb1451b2022-04-24 23:31:24 -0600293
Simon Glassa950f282023-01-17 10:48:17 -0700294 ut_assertok(bootdev_get_sibling_blk(iter.dev_used[3], &blk));
Simon Glassfb1451b2022-04-24 23:31:24 -0600295 ut_asserteq_str("usb_mass_storage.lun0", blk->name);
296
297 /* adjust the priority of the first USB bootdev to the highest */
Simon Glassa950f282023-01-17 10:48:17 -0700298 ucp = dev_get_uclass_plat(iter.dev_used[3]);
299 ucp->prio = BOOTDEVP_1_PRE_SCAN;
Simon Glassfb1451b2022-04-24 23:31:24 -0600300
Simon Glassa950f282023-01-17 10:48:17 -0700301 /* try again but enable hunting, which brings in SCSI */
Simon Glassfb1451b2022-04-24 23:31:24 -0600302 bootflow_iter_uninit(&iter);
Simon Glass4f806f32023-02-22 12:17:03 -0700303 ut_assertok(bootflow_scan_first(NULL, NULL, &iter, BOOTFLOWIF_HUNT,
Simon Glass4b7cb052023-01-17 10:48:16 -0700304 &bflow));
Simon Glassa950f282023-01-17 10:48:17 -0700305 ut_asserteq(-ENODEV, bootflow_scan_next(&iter, &bflow));
306 ut_asserteq(7, iter.num_devs);
Simon Glassfb1451b2022-04-24 23:31:24 -0600307 ut_asserteq_str("usb_mass_storage.lun0.bootdev",
Simon Glassa950f282023-01-17 10:48:17 -0700308 iter.dev_used[0]->name);
309 ut_asserteq_str("mmc2.bootdev", iter.dev_used[1]->name);
Simon Glassfb1451b2022-04-24 23:31:24 -0600310
311 return 0;
312}
313BOOTSTD_TEST(bootdev_test_prio, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glassbd90b092023-01-17 10:47:33 -0700314
315/* Check listing hunters */
316static int bootdev_test_hunter(struct unit_test_state *uts)
317{
318 struct bootstd_priv *std;
319
Simon Glass8c29b732023-05-05 20:03:04 -0600320 usb_started = false;
Simon Glass04fb2b62023-01-17 10:47:37 -0700321 test_set_skip_delays(true);
322
Simon Glassbd90b092023-01-17 10:47:33 -0700323 /* get access to the used hunters */
324 ut_assertok(bootstd_get_priv(&std));
325
326 console_record_reset_enable();
327 bootdev_list_hunters(std);
328 ut_assert_nextline("Prio Used Uclass Hunter");
329 ut_assert_nextlinen("----");
Simon Glasseacc2612023-01-17 10:48:08 -0700330 ut_assert_nextline(" 6 ethernet eth_bootdev");
Simon Glass18552d22023-01-17 10:48:13 -0700331 ut_assert_nextline(" 1 simple_bus (none)");
Simon Glasseacc2612023-01-17 10:48:08 -0700332 ut_assert_nextline(" 5 ide ide_bootdev");
333 ut_assert_nextline(" 2 mmc mmc_bootdev");
334 ut_assert_nextline(" 4 nvme nvme_bootdev");
Simon Glass662cfa02023-01-28 15:00:28 -0700335 ut_assert_nextline(" 4 qfw qfw_bootdev");
Simon Glasseacc2612023-01-17 10:48:08 -0700336 ut_assert_nextline(" 4 scsi scsi_bootdev");
337 ut_assert_nextline(" 4 spi_flash sf_bootdev");
338 ut_assert_nextline(" 5 usb usb_bootdev");
339 ut_assert_nextline(" 4 virtio virtio_bootdev");
Simon Glass662cfa02023-01-28 15:00:28 -0700340 ut_assert_nextline("(total hunters: 10)");
Simon Glassbd90b092023-01-17 10:47:33 -0700341 ut_assert_console_end();
342
Simon Glass04fb2b62023-01-17 10:47:37 -0700343 ut_assertok(bootdev_hunt("usb1", false));
344 ut_assert_nextline(
345 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
Simon Glassc7b63d52023-01-17 10:47:34 -0700346 ut_assert_console_end();
347
Simon Glass662cfa02023-01-28 15:00:28 -0700348 /* USB is 7th in the list, so bit 8 */
349 ut_asserteq(BIT(8), std->hunters_used);
Simon Glass04fb2b62023-01-17 10:47:37 -0700350
Simon Glassbd90b092023-01-17 10:47:33 -0700351 return 0;
352}
353BOOTSTD_TEST(bootdev_test_hunter, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
354
355/* Check 'bootdev hunt' command */
356static int bootdev_test_cmd_hunt(struct unit_test_state *uts)
357{
358 struct bootstd_priv *std;
359
Simon Glass04fb2b62023-01-17 10:47:37 -0700360 test_set_skip_delays(true);
Simon Glass8c29b732023-05-05 20:03:04 -0600361 usb_started = false;
Simon Glass04fb2b62023-01-17 10:47:37 -0700362
Simon Glassbd90b092023-01-17 10:47:33 -0700363 /* get access to the used hunters */
364 ut_assertok(bootstd_get_priv(&std));
365
366 console_record_reset_enable();
367 ut_assertok(run_command("bootdev hunt -l", 0));
368 ut_assert_nextline("Prio Used Uclass Hunter");
369 ut_assert_nextlinen("----");
Simon Glasseacc2612023-01-17 10:48:08 -0700370 ut_assert_nextline(" 6 ethernet eth_bootdev");
Simon Glass662cfa02023-01-28 15:00:28 -0700371 ut_assert_skip_to_line("(total hunters: 10)");
Simon Glasseacc2612023-01-17 10:48:08 -0700372 ut_assert_console_end();
373
374 /* Use the MMC hunter and see that it updates */
375 ut_assertok(run_command("bootdev hunt mmc", 0));
376 ut_assertok(run_command("bootdev hunt -l", 0));
377 ut_assert_skip_to_line(" 5 ide ide_bootdev");
378 ut_assert_nextline(" 2 * mmc mmc_bootdev");
Simon Glass662cfa02023-01-28 15:00:28 -0700379 ut_assert_skip_to_line("(total hunters: 10)");
Simon Glassbd90b092023-01-17 10:47:33 -0700380 ut_assert_console_end();
381
382 /* Scan all hunters */
Simon Glasse4b69482023-01-17 10:48:10 -0700383 test_set_eth_enable(false);
Simon Glasseacc2612023-01-17 10:48:08 -0700384 test_set_skip_delays(true);
Simon Glassbd90b092023-01-17 10:47:33 -0700385 ut_assertok(run_command("bootdev hunt", 0));
Simon Glass4146c822023-01-17 10:47:40 -0700386 ut_assert_nextline("Hunting with: ethernet");
Simon Glass18552d22023-01-17 10:48:13 -0700387
388 /* This is the extension feature which has no uclass at present */
389 ut_assert_nextline("Hunting with: simple_bus");
390 ut_assert_nextline("Found 2 extension board(s).");
Simon Glass0d77f8f2023-01-17 10:47:46 -0700391 ut_assert_nextline("Hunting with: ide");
Simon Glasseacc2612023-01-17 10:48:08 -0700392
393 /* mmc hunter has already been used so should not run again */
394
Simon Glass758c7062023-01-17 10:47:47 -0700395 ut_assert_nextline("Hunting with: nvme");
Simon Glass662cfa02023-01-28 15:00:28 -0700396 ut_assert_nextline("Hunting with: qfw");
Simon Glass8f090b62023-01-17 10:47:45 -0700397 ut_assert_nextline("Hunting with: scsi");
398 ut_assert_nextline("scanning bus for devices...");
Simon Glass0c1f4a92023-01-17 10:48:03 -0700399 ut_assert_skip_to_line("Hunting with: spi_flash");
400 ut_assert_nextline("Hunting with: usb");
Simon Glass04fb2b62023-01-17 10:47:37 -0700401 ut_assert_nextline(
402 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
Simon Glass0c1f4a92023-01-17 10:48:03 -0700403 ut_assert_nextline("Hunting with: virtio");
Simon Glassbd90b092023-01-17 10:47:33 -0700404 ut_assert_console_end();
405
406 /* List available hunters */
407 ut_assertok(run_command("bootdev hunt -l", 0));
408 ut_assert_nextlinen("Prio");
409 ut_assert_nextlinen("----");
Simon Glasseacc2612023-01-17 10:48:08 -0700410 ut_assert_nextline(" 6 * ethernet eth_bootdev");
Simon Glass18552d22023-01-17 10:48:13 -0700411 ut_assert_nextline(" 1 * simple_bus (none)");
Simon Glasseacc2612023-01-17 10:48:08 -0700412 ut_assert_nextline(" 5 * ide ide_bootdev");
413 ut_assert_nextline(" 2 * mmc mmc_bootdev");
414 ut_assert_nextline(" 4 * nvme nvme_bootdev");
Simon Glass662cfa02023-01-28 15:00:28 -0700415 ut_assert_nextline(" 4 * qfw qfw_bootdev");
Simon Glasseacc2612023-01-17 10:48:08 -0700416 ut_assert_nextline(" 4 * scsi scsi_bootdev");
417 ut_assert_nextline(" 4 * spi_flash sf_bootdev");
418 ut_assert_nextline(" 5 * usb usb_bootdev");
419 ut_assert_nextline(" 4 * virtio virtio_bootdev");
Simon Glass662cfa02023-01-28 15:00:28 -0700420 ut_assert_nextline("(total hunters: 10)");
Simon Glassbd90b092023-01-17 10:47:33 -0700421 ut_assert_console_end();
422
Simon Glass18552d22023-01-17 10:48:13 -0700423 ut_asserteq(GENMASK(MAX_HUNTER, 0), std->hunters_used);
Simon Glassbd90b092023-01-17 10:47:33 -0700424
425 return 0;
426}
427BOOTSTD_TEST(bootdev_test_cmd_hunt, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
428 UT_TESTF_ETH_BOOTDEV);
Simon Glassf0e358f2023-01-17 10:47:42 -0700429
Simon Glass47aedc22023-01-17 10:48:14 -0700430/* Check searching for bootdevs using the hunters */
431static int bootdev_test_hunt_scan(struct unit_test_state *uts)
432{
433 struct bootflow_iter iter;
434 struct bootstd_priv *std;
435 struct bootflow bflow;
436
437 /* get access to the used hunters */
438 ut_assertok(bootstd_get_priv(&std));
439
440 ut_assertok(bootstd_test_drop_bootdev_order(uts));
Simon Glass4b7cb052023-01-17 10:48:16 -0700441 ut_assertok(bootflow_scan_first(NULL, NULL, &iter,
Simon Glass4f806f32023-02-22 12:17:03 -0700442 BOOTFLOWIF_SHOW | BOOTFLOWIF_HUNT |
443 BOOTFLOWIF_SKIP_GLOBAL, &bflow));
Simon Glass47aedc22023-01-17 10:48:14 -0700444 ut_asserteq(BIT(MMC_HUNTER) | BIT(1), std->hunters_used);
445
446 return 0;
447}
448BOOTSTD_TEST(bootdev_test_hunt_scan, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
449
Simon Glassf0e358f2023-01-17 10:47:42 -0700450/* Check that only bootable partitions are processed */
451static int bootdev_test_bootable(struct unit_test_state *uts)
452{
453 struct bootflow_iter iter;
454 struct bootflow bflow;
455 struct udevice *blk;
456
457 memset(&iter, '\0', sizeof(iter));
458 memset(&bflow, '\0', sizeof(bflow));
459 iter.part = 0;
460 ut_assertok(uclass_get_device_by_name(UCLASS_BLK, "mmc1.blk", &blk));
461 iter.dev = blk;
462 ut_assertok(device_find_next_child(&iter.dev));
463 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
464
465 /*
466 * initially we don't have any knowledge of which partitions are
467 * bootable, but mmc1 has two partitions, with the first one being
468 * bootable
469 */
470 iter.part = 2;
471 ut_asserteq(-EINVAL, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
472 ut_asserteq(0, iter.first_bootable);
473
474 /* scan with part == 0 to get the partition info */
475 iter.part = 0;
476 ut_asserteq(-ENOENT, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
477 ut_asserteq(1, iter.first_bootable);
478
479 /* now it will refuse to use non-bootable partitions */
480 iter.part = 2;
481 ut_asserteq(-EINVAL, bootdev_find_in_blk(iter.dev, blk, &iter, &bflow));
482
483 return 0;
484}
485BOOTSTD_TEST(bootdev_test_bootable, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glass79a7d4a2023-01-17 10:48:07 -0700486
487/* Check hunting for bootdev of a particular priority */
488static int bootdev_test_hunt_prio(struct unit_test_state *uts)
489{
Simon Glass8c29b732023-05-05 20:03:04 -0600490 usb_started = false;
Simon Glass79a7d4a2023-01-17 10:48:07 -0700491 test_set_skip_delays(true);
492
493 console_record_reset_enable();
Simon Glasseacc2612023-01-17 10:48:08 -0700494 ut_assertok(bootdev_hunt_prio(BOOTDEVP_4_SCAN_FAST, false));
Simon Glass79a7d4a2023-01-17 10:48:07 -0700495 ut_assert_nextline("scanning bus for devices...");
496 ut_assert_skip_to_line(" Type: Hard Disk");
497 ut_assert_nextlinen(" Capacity:");
498 ut_assert_console_end();
499
500 /* now try a different priority, verbosely */
Simon Glasseacc2612023-01-17 10:48:08 -0700501 ut_assertok(bootdev_hunt_prio(BOOTDEVP_5_SCAN_SLOW, true));
Simon Glass79a7d4a2023-01-17 10:48:07 -0700502 ut_assert_nextline("Hunting with: ide");
Simon Glass79a7d4a2023-01-17 10:48:07 -0700503 ut_assert_nextline("Hunting with: usb");
504 ut_assert_nextline(
505 "Bus usb@1: scanning bus usb@1 for devices... 5 USB Device(s) found");
506 ut_assert_console_end();
507
508 return 0;
509}
510BOOTSTD_TEST(bootdev_test_hunt_prio, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glass66e3dce2023-01-17 10:48:09 -0700511
512/* Check hunting for bootdevs with a particular label */
513static int bootdev_test_hunt_label(struct unit_test_state *uts)
514{
515 struct udevice *dev, *old;
516 struct bootstd_priv *std;
517 int mflags;
518
Simon Glass8c29b732023-05-05 20:03:04 -0600519 usb_started = false;
520
Simon Glass66e3dce2023-01-17 10:48:09 -0700521 /* get access to the used hunters */
522 ut_assertok(bootstd_get_priv(&std));
523
524 /* scan an unknown uclass */
525 console_record_reset_enable();
526 old = (void *)&mflags; /* arbitrary pointer to check against dev */
527 dev = old;
528 mflags = 123;
Simon Glass1736b4a2023-04-24 13:49:47 +1200529 ut_asserteq(-EPFNOSUPPORT,
Simon Glass66e3dce2023-01-17 10:48:09 -0700530 bootdev_hunt_and_find_by_label("fred", &dev, &mflags));
Simon Glass66e3dce2023-01-17 10:48:09 -0700531 ut_asserteq_ptr(old, dev);
532 ut_asserteq(123, mflags);
533 ut_assert_console_end();
534 ut_asserteq(0, std->hunters_used);
535
536 /* scan an invalid mmc controllers */
537 ut_asserteq(-ENOENT,
538 bootdev_hunt_and_find_by_label("mmc4", &dev, &mflags));
539 ut_asserteq_ptr(old, dev);
540 ut_asserteq(123, mflags);
Simon Glass66e3dce2023-01-17 10:48:09 -0700541 ut_assert_console_end();
542
543 ut_assertok(bootstd_test_check_mmc_hunter(uts));
544
545 /* scan for a particular mmc controller */
546 ut_assertok(bootdev_hunt_and_find_by_label("mmc1", &dev, &mflags));
547 ut_assertnonnull(dev);
548 ut_asserteq_str("mmc1.bootdev", dev->name);
549 ut_asserteq(0, mflags);
550 ut_assert_console_end();
551
552 /* scan all of usb */
553 test_set_skip_delays(true);
554 ut_assertok(bootdev_hunt_and_find_by_label("usb", &dev, &mflags));
555 ut_assertnonnull(dev);
556 ut_asserteq_str("usb_mass_storage.lun0.bootdev", dev->name);
557 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS, mflags);
558 ut_assert_nextlinen("Bus usb@1: scanning bus usb@1");
559 ut_assert_console_end();
560
561 return 0;
562}
563BOOTSTD_TEST(bootdev_test_hunt_label, UT_TESTF_DM | UT_TESTF_SCAN_FDT);
Simon Glasse4b69482023-01-17 10:48:10 -0700564
565/* Check iterating to the next label in a list */
566static int bootdev_test_next_label(struct unit_test_state *uts)
567{
568 const char *const labels[] = {"mmc0", "scsi", "dhcp", "pxe", NULL};
569 struct bootflow_iter iter;
570 struct bootstd_priv *std;
571 struct bootflow bflow;
572 struct udevice *dev;
573 int mflags;
574
575 test_set_eth_enable(false);
576
577 /* get access to the used hunters */
578 ut_assertok(bootstd_get_priv(&std));
579
580 memset(&iter, '\0', sizeof(iter));
581 memset(&bflow, '\0', sizeof(bflow));
582 iter.part = 0;
583 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
584 iter.cur_label = -1;
585 iter.labels = labels;
586
587 dev = NULL;
588 mflags = 123;
589 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
590 console_record_reset_enable();
591 ut_assert_console_end();
592 ut_assertnonnull(dev);
593 ut_asserteq_str("mmc0.bootdev", dev->name);
594 ut_asserteq(0, mflags);
595
596 ut_assertok(bootstd_test_check_mmc_hunter(uts));
597
598 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
599 ut_assert_nextline("scanning bus for devices...");
600 ut_assert_skip_to_line(
601 " Capacity: 1.9 MB = 0.0 GB (4095 x 512)");
602 ut_assert_console_end();
603 ut_assertnonnull(dev);
604 ut_asserteq_str("scsi.id0lun0.bootdev", dev->name);
605 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS, mflags);
606
Simon Glass662cfa02023-01-28 15:00:28 -0700607 /* SCSI is 7th in the list, so bit 6 */
608 ut_asserteq(BIT(MMC_HUNTER) | BIT(6), std->hunters_used);
Simon Glasse4b69482023-01-17 10:48:10 -0700609
610 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
611 ut_assert_console_end();
612 ut_assertnonnull(dev);
613 ut_asserteq_str("eth@10002000.bootdev", dev->name);
614 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_DHCP_ONLY,
615 mflags);
616
617 /* dhcp: Ethernet is first so bit 0 */
Simon Glass662cfa02023-01-28 15:00:28 -0700618 ut_asserteq(BIT(MMC_HUNTER) | BIT(6) | BIT(0), std->hunters_used);
Simon Glasse4b69482023-01-17 10:48:10 -0700619
620 ut_assertok(bootdev_next_label(&iter, &dev, &mflags));
621 ut_assert_console_end();
622 ut_assertnonnull(dev);
623 ut_asserteq_str("eth@10002000.bootdev", dev->name);
624 ut_asserteq(BOOTFLOW_METHF_SINGLE_UCLASS | BOOTFLOW_METHF_PXE_ONLY,
625 mflags);
626
627 /* pxe: Ethernet is first so bit 0 */
Simon Glass662cfa02023-01-28 15:00:28 -0700628 ut_asserteq(BIT(MMC_HUNTER) | BIT(6) | BIT(0), std->hunters_used);
Simon Glasse4b69482023-01-17 10:48:10 -0700629
630 mflags = 123;
631 ut_asserteq(-ENODEV, bootdev_next_label(&iter, &dev, &mflags));
632 ut_asserteq(123, mflags);
633 ut_assert_console_end();
634
635 /* no change */
Simon Glass662cfa02023-01-28 15:00:28 -0700636 ut_asserteq(BIT(MMC_HUNTER) | BIT(6) | BIT(0), std->hunters_used);
Simon Glasse4b69482023-01-17 10:48:10 -0700637
638 return 0;
639}
640BOOTSTD_TEST(bootdev_test_next_label, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
641 UT_TESTF_ETH_BOOTDEV | UT_TESTF_SF_BOOTDEV);
Simon Glass43e89a32023-01-17 10:48:11 -0700642
643
644/* Check iterating to the next prioirty in a list */
645static int bootdev_test_next_prio(struct unit_test_state *uts)
646{
647 struct bootflow_iter iter;
648 struct bootstd_priv *std;
649 struct bootflow bflow;
650 struct udevice *dev;
651 int ret;
652
Simon Glass91943ff2023-01-17 10:48:15 -0700653 test_set_eth_enable(false);
Simon Glass43e89a32023-01-17 10:48:11 -0700654 test_set_skip_delays(true);
655
656 /* get access to the used hunters */
657 ut_assertok(bootstd_get_priv(&std));
658
659 memset(&iter, '\0', sizeof(iter));
660 memset(&bflow, '\0', sizeof(bflow));
661 iter.part = 0;
662 uclass_first_device(UCLASS_BOOTMETH, &bflow.method);
663 iter.cur_prio = 0;
Simon Glass4f806f32023-02-22 12:17:03 -0700664 iter.flags = BOOTFLOWIF_SHOW;
Simon Glass43e89a32023-01-17 10:48:11 -0700665
666 dev = NULL;
667 console_record_reset_enable();
668 ut_assertok(bootdev_next_prio(&iter, &dev));
669 ut_assertnonnull(dev);
670 ut_asserteq_str("mmc2.bootdev", dev->name);
671
672 /* hunt flag not set, so this should not use any hunters */
673 ut_asserteq(0, std->hunters_used);
674 ut_assert_console_end();
675
676 /* now try again with hunting enabled */
Simon Glass4f806f32023-02-22 12:17:03 -0700677 iter.flags = BOOTFLOWIF_SHOW | BOOTFLOWIF_HUNT;
Simon Glass43e89a32023-01-17 10:48:11 -0700678 iter.cur_prio = 0;
679 iter.part = 0;
680
681 ut_assertok(bootdev_next_prio(&iter, &dev));
682 ut_asserteq_str("mmc2.bootdev", dev->name);
Simon Glass18552d22023-01-17 10:48:13 -0700683 ut_assert_nextline("Hunting with: simple_bus");
684 ut_assert_nextline("Found 2 extension board(s).");
Simon Glass43e89a32023-01-17 10:48:11 -0700685 ut_assert_nextline("Hunting with: mmc");
686 ut_assert_console_end();
687
Simon Glass18552d22023-01-17 10:48:13 -0700688 ut_asserteq(BIT(MMC_HUNTER) | BIT(1), std->hunters_used);
Simon Glass43e89a32023-01-17 10:48:11 -0700689
690 ut_assertok(bootdev_next_prio(&iter, &dev));
691 ut_asserteq_str("mmc1.bootdev", dev->name);
692
693 ut_assertok(bootdev_next_prio(&iter, &dev));
694 ut_asserteq_str("mmc0.bootdev", dev->name);
695 ut_assert_console_end();
696
697 ut_assertok(bootdev_next_prio(&iter, &dev));
698 ut_asserteq_str("spi.bin@0.bootdev", dev->name);
699 ut_assert_skip_to_line("Hunting with: spi_flash");
700
701 /*
702 * this scans all bootdevs of priority BOOTDEVP_4_SCAN_FAST before it
703 * starts looking at the devices, so we se virtio as well
704 */
705 ut_assert_nextline("Hunting with: virtio");
706 ut_assert_nextlinen("SF: Detected m25p16");
707
708 ut_assertok(bootdev_next_prio(&iter, &dev));
709 ut_asserteq_str("spi.bin@1.bootdev", dev->name);
710 ut_assert_nextlinen("SF: Detected m25p16");
711 ut_assert_console_end();
712
713 /* keep going until there are no more bootdevs */
714 do {
715 ret = bootdev_next_prio(&iter, &dev);
716 } while (!ret);
717 ut_asserteq(-ENODEV, ret);
718 ut_assertnull(dev);
Simon Glass18552d22023-01-17 10:48:13 -0700719 ut_asserteq(GENMASK(MAX_HUNTER, 0), std->hunters_used);
Simon Glass43e89a32023-01-17 10:48:11 -0700720
721 ut_assert_skip_to_line("Hunting with: ethernet");
722 ut_assert_console_end();
723
724 return 0;
725}
726BOOTSTD_TEST(bootdev_test_next_prio, UT_TESTF_DM | UT_TESTF_SCAN_FDT |
727 UT_TESTF_SF_BOOTDEV);