blob: 8103a11d1bbf5f00f082edc8f5fd90877e558035 [file] [log] [blame]
Simon Glass201417d2022-04-24 23:31:07 -06001// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Copyright 2021 Google LLC
4 * Written by Simon Glass <sjg@chromium.org>
5 */
6
7#define LOG_CATEGORY UCLASS_BOOTSTD
8
9#include <common.h>
10#include <dm.h>
11#include <bootdev.h>
12#include <bootflow.h>
Simon Glassa8f5be12022-04-24 23:31:09 -060013#include <bootmeth.h>
Simon Glass201417d2022-04-24 23:31:07 -060014#include <bootstd.h>
Simon Glass201417d2022-04-24 23:31:07 -060015#include <fs.h>
16#include <log.h>
17#include <malloc.h>
18#include <part.h>
19#include <sort.h>
20#include <dm/device-internal.h>
21#include <dm/lists.h>
22#include <dm/uclass-internal.h>
23
24enum {
25 /*
26 * Set some sort of limit on the number of partitions a bootdev can
27 * have. Note that for disks this limits the partitions numbers that
28 * are scanned to 1..MAX_BOOTFLOWS_PER_BOOTDEV
29 */
30 MAX_PART_PER_BOOTDEV = 30,
31
32 /* Maximum supported length of the "boot_targets" env string */
33 BOOT_TARGETS_MAX_LEN = 100,
34};
35
36int bootdev_add_bootflow(struct bootflow *bflow)
37{
Simon Glass201417d2022-04-24 23:31:07 -060038 struct bootstd_priv *std;
39 struct bootflow *new;
40 int ret;
41
42 assert(bflow->dev);
43 ret = bootstd_get_priv(&std);
44 if (ret)
45 return ret;
46
47 new = malloc(sizeof(*bflow));
48 if (!new)
49 return log_msg_ret("bflow", -ENOMEM);
50 memcpy(new, bflow, sizeof(*bflow));
51
52 list_add_tail(&new->glob_node, &std->glob_head);
Simon Glasseccb25c2022-07-30 15:52:23 -060053 if (bflow->dev) {
54 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(bflow->dev);
55
56 list_add_tail(&new->bm_node, &ucp->bootflow_head);
57 }
Simon Glass201417d2022-04-24 23:31:07 -060058
59 return 0;
60}
61
62int bootdev_first_bootflow(struct udevice *dev, struct bootflow **bflowp)
63{
64 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);
65
66 if (list_empty(&ucp->bootflow_head))
67 return -ENOENT;
68
69 *bflowp = list_first_entry(&ucp->bootflow_head, struct bootflow,
70 bm_node);
71
72 return 0;
73}
74
75int bootdev_next_bootflow(struct bootflow **bflowp)
76{
77 struct bootflow *bflow = *bflowp;
78 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(bflow->dev);
79
80 *bflowp = NULL;
81
82 if (list_is_last(&bflow->bm_node, &ucp->bootflow_head))
83 return -ENOENT;
84
85 *bflowp = list_entry(bflow->bm_node.next, struct bootflow, bm_node);
86
87 return 0;
88}
89
90int bootdev_bind(struct udevice *parent, const char *drv_name, const char *name,
91 struct udevice **devp)
92{
93 struct udevice *dev;
94 char dev_name[30];
95 char *str;
96 int ret;
97
98 snprintf(dev_name, sizeof(dev_name), "%s.%s", parent->name, name);
99 str = strdup(dev_name);
100 if (!str)
101 return -ENOMEM;
102 ret = device_bind_driver(parent, drv_name, str, &dev);
103 if (ret)
104 return ret;
105 device_set_name_alloced(dev);
106 *devp = dev;
107
108 return 0;
109}
110
111int bootdev_find_in_blk(struct udevice *dev, struct udevice *blk,
112 struct bootflow_iter *iter, struct bootflow *bflow)
113{
114 struct blk_desc *desc = dev_get_uclass_plat(blk);
115 struct disk_partition info;
116 char partstr[20];
117 char name[60];
118 int ret;
119
120 /* Sanity check */
121 if (iter->part >= MAX_PART_PER_BOOTDEV)
122 return log_msg_ret("max", -ESHUTDOWN);
123
124 bflow->blk = blk;
125 if (iter->part)
126 snprintf(partstr, sizeof(partstr), "part_%x", iter->part);
127 else
128 strcpy(partstr, "whole");
129 snprintf(name, sizeof(name), "%s.%s", dev->name, partstr);
130 bflow->name = strdup(name);
131 if (!bflow->name)
132 return log_msg_ret("name", -ENOMEM);
133
134 bflow->part = iter->part;
135
Simon Glassa8f5be12022-04-24 23:31:09 -0600136 ret = bootmeth_check(bflow->method, iter);
137 if (ret)
138 return log_msg_ret("check", ret);
139
Simon Glass201417d2022-04-24 23:31:07 -0600140 /*
141 * partition numbers start at 0 so this cannot succeed, but it can tell
142 * us whether there is valid media there
143 */
144 ret = part_get_info(desc, iter->part, &info);
145 if (!iter->part && ret == -ENOENT)
146 ret = 0;
147
148 /*
149 * This error indicates the media is not present. Otherwise we just
150 * blindly scan the next partition. We could be more intelligent here
151 * and check which partition numbers actually exist.
152 */
153 if (ret == -EOPNOTSUPP)
154 ret = -ESHUTDOWN;
155 else
156 bflow->state = BOOTFLOWST_MEDIA;
157 if (ret)
158 return log_msg_ret("part", ret);
159
160 /*
161 * Currently we don't get the number of partitions, so just
162 * assume a large number
163 */
164 iter->max_part = MAX_PART_PER_BOOTDEV;
165
Simon Glassf0e358f2023-01-17 10:47:42 -0700166 /* If this is the whole disk, check if we have bootable partitions */
167 if (!iter->part) {
168 iter->first_bootable = part_get_bootable(desc);
169 log_debug("checking bootable=%d\n", iter->first_bootable);
170
171 /* if there are bootable partitions, scan only those */
172 } else if (iter->first_bootable ? !info.bootable : iter->part != 1) {
173 return log_msg_ret("boot", -EINVAL);
174 } else {
Simon Glass201417d2022-04-24 23:31:07 -0600175 ret = fs_set_blk_dev_with_part(desc, bflow->part);
176 bflow->state = BOOTFLOWST_PART;
177
178 /* Use an #ifdef due to info.sys_ind */
179#ifdef CONFIG_DOS_PARTITION
180 log_debug("%s: Found partition %x type %x fstype %d\n",
181 blk->name, bflow->part, info.sys_ind,
182 ret ? -1 : fs_get_type());
183#endif
184 if (ret)
185 return log_msg_ret("fs", ret);
186 bflow->state = BOOTFLOWST_FS;
187 }
188
Simon Glassa8f5be12022-04-24 23:31:09 -0600189 ret = bootmeth_read_bootflow(bflow->method, bflow);
190 if (ret)
191 return log_msg_ret("method", ret);
192
Simon Glass201417d2022-04-24 23:31:07 -0600193 return 0;
194}
195
196void bootdev_list(bool probe)
197{
198 struct udevice *dev;
199 int ret;
200 int i;
201
202 printf("Seq Probed Status Uclass Name\n");
203 printf("--- ------ ------ -------- ------------------\n");
204 if (probe)
Michal Suchanek28a22cd2022-10-12 21:57:53 +0200205 ret = uclass_first_device_check(UCLASS_BOOTDEV, &dev);
Simon Glass201417d2022-04-24 23:31:07 -0600206 else
207 ret = uclass_find_first_device(UCLASS_BOOTDEV, &dev);
208 for (i = 0; dev; i++) {
209 printf("%3x [ %c ] %6s %-9.9s %s\n", dev_seq(dev),
210 device_active(dev) ? '+' : ' ',
211 ret ? simple_itoa(ret) : "OK",
212 dev_get_uclass_name(dev_get_parent(dev)), dev->name);
213 if (probe)
Michal Suchanek28a22cd2022-10-12 21:57:53 +0200214 ret = uclass_next_device_check(&dev);
Simon Glass201417d2022-04-24 23:31:07 -0600215 else
216 ret = uclass_find_next_device(&dev);
217 }
218 printf("--- ------ ------ -------- ------------------\n");
219 printf("(%d bootdev%s)\n", i, i != 1 ? "s" : "");
220}
221
222int bootdev_setup_for_dev(struct udevice *parent, const char *drv_name)
223{
224 struct udevice *bdev;
225 int ret;
226
227 ret = device_find_first_child_by_uclass(parent, UCLASS_BOOTDEV,
228 &bdev);
229 if (ret) {
230 if (ret != -ENODEV) {
231 log_debug("Cannot access bootdev device\n");
232 return ret;
233 }
234
235 ret = bootdev_bind(parent, drv_name, "bootdev", &bdev);
236 if (ret) {
237 log_debug("Cannot create bootdev device\n");
238 return ret;
239 }
240 }
241
242 return 0;
243}
244
Simon Glass3a2cb96e52023-01-17 10:47:25 -0700245static int bootdev_get_suffix_start(struct udevice *dev, const char *suffix)
246{
247 int len, slen;
248
249 len = strlen(dev->name);
250 slen = strlen(suffix);
251 if (len > slen && !strcmp(suffix, dev->name + len - slen))
252 return len - slen;
253
254 return len;
255}
256
Simon Glass201417d2022-04-24 23:31:07 -0600257int bootdev_setup_sibling_blk(struct udevice *blk, const char *drv_name)
258{
259 struct udevice *parent, *dev;
260 char dev_name[50];
Simon Glass3a2cb96e52023-01-17 10:47:25 -0700261 int ret, len;
Simon Glass201417d2022-04-24 23:31:07 -0600262
Simon Glass3a2cb96e52023-01-17 10:47:25 -0700263 len = bootdev_get_suffix_start(blk, ".blk");
264 snprintf(dev_name, sizeof(dev_name), "%.*s.%s", len, blk->name,
265 "bootdev");
Simon Glass201417d2022-04-24 23:31:07 -0600266
267 parent = dev_get_parent(blk);
268 ret = device_find_child_by_name(parent, dev_name, &dev);
269 if (ret) {
270 char *str;
271
272 if (ret != -ENODEV) {
273 log_debug("Cannot access bootdev device\n");
274 return ret;
275 }
276 str = strdup(dev_name);
277 if (!str)
278 return -ENOMEM;
279
280 ret = device_bind_driver(parent, drv_name, str, &dev);
281 if (ret) {
282 log_debug("Cannot create bootdev device\n");
283 return ret;
284 }
285 device_set_name_alloced(dev);
286 }
287
288 return 0;
289}
290
291int bootdev_get_sibling_blk(struct udevice *dev, struct udevice **blkp)
292{
293 struct udevice *parent = dev_get_parent(dev);
294 struct udevice *blk;
295 int ret, len;
Simon Glass201417d2022-04-24 23:31:07 -0600296
297 if (device_get_uclass_id(dev) != UCLASS_BOOTDEV)
298 return -EINVAL;
299
300 /* This should always work if bootdev_setup_sibling_blk() was used */
Simon Glass3a2cb96e52023-01-17 10:47:25 -0700301 len = bootdev_get_suffix_start(dev, ".bootdev");
Simon Glass201417d2022-04-24 23:31:07 -0600302 ret = device_find_child_by_namelen(parent, dev->name, len, &blk);
Simon Glass3a2cb96e52023-01-17 10:47:25 -0700303 if (ret) {
304 char dev_name[50];
305
306 snprintf(dev_name, sizeof(dev_name), "%.*s.blk", len,
307 dev->name);
308 ret = device_find_child_by_name(parent, dev_name, &blk);
309 if (ret)
310 return log_msg_ret("find", ret);
311 }
Simon Glass965020c2023-01-28 15:00:19 -0700312 ret = device_probe(blk);
313 if (ret)
314 return log_msg_ret("act", ret);
Simon Glass201417d2022-04-24 23:31:07 -0600315 *blkp = blk;
316
317 return 0;
318}
319
320static int bootdev_get_from_blk(struct udevice *blk, struct udevice **bootdevp)
321{
322 struct udevice *parent = dev_get_parent(blk);
323 struct udevice *bootdev;
324 char dev_name[50];
Simon Glass3a2cb96e52023-01-17 10:47:25 -0700325 int ret, len;
Simon Glass201417d2022-04-24 23:31:07 -0600326
327 if (device_get_uclass_id(blk) != UCLASS_BLK)
328 return -EINVAL;
329
330 /* This should always work if bootdev_setup_sibling_blk() was used */
Simon Glass3a2cb96e52023-01-17 10:47:25 -0700331 len = bootdev_get_suffix_start(blk, ".blk");
332 snprintf(dev_name, sizeof(dev_name), "%.*s.%s", len, blk->name,
333 "bootdev");
Simon Glass201417d2022-04-24 23:31:07 -0600334 ret = device_find_child_by_name(parent, dev_name, &bootdev);
335 if (ret)
336 return log_msg_ret("find", ret);
337 *bootdevp = bootdev;
338
339 return 0;
340}
341
342int bootdev_unbind_dev(struct udevice *parent)
343{
344 struct udevice *dev;
345 int ret;
346
347 ret = device_find_first_child_by_uclass(parent, UCLASS_BOOTDEV, &dev);
348 if (!ret) {
349 ret = device_remove(dev, DM_REMOVE_NORMAL);
350 if (ret)
351 return log_msg_ret("rem", ret);
352 ret = device_unbind(dev);
353 if (ret)
354 return log_msg_ret("unb", ret);
355 }
356
357 return 0;
358}
359
360/**
Simon Glass74ebfb62023-01-17 10:48:00 -0700361 * label_to_uclass() - Convert a label to a uclass and sequence number
362 *
363 * @label: Label to look up (e.g. "mmc1" or "mmc0")
364 * @seqp: Returns the sequence number, or -1 if none
Simon Glassd9f48572023-01-17 10:48:05 -0700365 * @method_flagsp: If non-NULL, returns any flags implied by the label
366 * (enum bootflow_meth_flags_t), 0 if none
Simon Glass74ebfb62023-01-17 10:48:00 -0700367 * Returns: sequence number on success, else -ve error code
368 */
Simon Glassd9f48572023-01-17 10:48:05 -0700369static int label_to_uclass(const char *label, int *seqp, int *method_flagsp)
Simon Glass74ebfb62023-01-17 10:48:00 -0700370{
Simon Glassd9f48572023-01-17 10:48:05 -0700371 int seq, len, method_flags;
Simon Glass74ebfb62023-01-17 10:48:00 -0700372 enum uclass_id id;
373 const char *end;
Simon Glass74ebfb62023-01-17 10:48:00 -0700374
Simon Glassd9f48572023-01-17 10:48:05 -0700375 method_flags = 0;
Simon Glass74ebfb62023-01-17 10:48:00 -0700376 seq = trailing_strtoln_end(label, NULL, &end);
377 len = end - label;
378 if (!len)
379 return -EINVAL;
380 id = uclass_get_by_namelen(label, len);
381 log_debug("find %s: seq=%d, id=%d/%s\n", label, seq, id,
382 uclass_get_name(id));
383 if (id == UCLASS_INVALID) {
Simon Glass0c1f4a92023-01-17 10:48:03 -0700384 /* try some special cases */
385 if (IS_ENABLED(CONFIG_BOOTDEV_SPI_FLASH) &&
386 !strncmp("spi", label, len)) {
387 id = UCLASS_SPI_FLASH;
Simon Glassd9f48572023-01-17 10:48:05 -0700388 } else if (IS_ENABLED(CONFIG_BOOTDEV_ETH) &&
389 !strncmp("pxe", label, len)) {
390 id = UCLASS_ETH;
391 method_flags |= BOOTFLOW_METHF_PXE_ONLY;
392 } else if (IS_ENABLED(CONFIG_BOOTDEV_ETH) &&
393 !strncmp("dhcp", label, len)) {
394 id = UCLASS_ETH;
395 method_flags |= BOOTFLOW_METHF_DHCP_ONLY;
Simon Glass0c1f4a92023-01-17 10:48:03 -0700396 } else {
397 log_warning("Unknown uclass '%s' in label\n", label);
398 return -EINVAL;
399 }
Simon Glass74ebfb62023-01-17 10:48:00 -0700400 }
401 if (id == UCLASS_USB)
402 id = UCLASS_MASS_STORAGE;
403 *seqp = seq;
Simon Glassd9f48572023-01-17 10:48:05 -0700404 if (method_flagsp)
405 *method_flagsp = method_flags;
Simon Glass74ebfb62023-01-17 10:48:00 -0700406
407 return id;
408}
409
Simon Glassd9f48572023-01-17 10:48:05 -0700410int bootdev_find_by_label(const char *label, struct udevice **devp,
411 int *method_flagsp)
Simon Glass201417d2022-04-24 23:31:07 -0600412{
Simon Glassd9f48572023-01-17 10:48:05 -0700413 int seq, ret, method_flags = 0;
Simon Glass201417d2022-04-24 23:31:07 -0600414 struct udevice *media;
415 struct uclass *uc;
416 enum uclass_id id;
Simon Glass201417d2022-04-24 23:31:07 -0600417
Simon Glassd9f48572023-01-17 10:48:05 -0700418 ret = label_to_uclass(label, &seq, &method_flags);
Simon Glass74ebfb62023-01-17 10:48:00 -0700419 if (ret < 0)
420 return log_msg_ret("uc", ret);
421 id = ret;
Simon Glass201417d2022-04-24 23:31:07 -0600422
423 /* Iterate through devices in the media uclass (e.g. UCLASS_MMC) */
424 uclass_id_foreach_dev(id, media, uc) {
425 struct udevice *bdev, *blk;
426 int ret;
427
428 /* if there is no seq, match anything */
429 if (seq != -1 && dev_seq(media) != seq) {
430 log_debug("- skip, media seq=%d\n", dev_seq(media));
431 continue;
432 }
433
434 ret = device_find_first_child_by_uclass(media, UCLASS_BOOTDEV,
435 &bdev);
436 if (ret) {
437 log_debug("- looking via blk, seq=%d, id=%d\n", seq,
438 id);
439 ret = blk_find_device(id, seq, &blk);
440 if (!ret) {
441 log_debug("- get from blk %s\n", blk->name);
442 ret = bootdev_get_from_blk(blk, &bdev);
443 }
444 }
445 if (!ret) {
446 log_debug("- found %s\n", bdev->name);
447 *devp = bdev;
Simon Glass66e3dce2023-01-17 10:48:09 -0700448
449 /*
450 * if no sequence number was provided, we must scan all
451 * bootdevs for this media uclass
452 */
453 if (IS_ENABLED(CONFIG_BOOTSTD_FULL) && seq == -1)
454 method_flags |= BOOTFLOW_METHF_SINGLE_UCLASS;
Simon Glassd9f48572023-01-17 10:48:05 -0700455 if (method_flagsp)
456 *method_flagsp = method_flags;
Simon Glass201417d2022-04-24 23:31:07 -0600457 return 0;
458 }
459 log_debug("- no device in %s\n", media->name);
460 }
461 log_warning("Unknown seq %d for label '%s'\n", seq, label);
462
463 return -ENOENT;
464}
465
Simon Glassd9f48572023-01-17 10:48:05 -0700466int bootdev_find_by_any(const char *name, struct udevice **devp,
467 int *method_flagsp)
Simon Glass201417d2022-04-24 23:31:07 -0600468{
469 struct udevice *dev;
Simon Glassd9f48572023-01-17 10:48:05 -0700470 int method_flags = 0;
Simon Glass66e3dce2023-01-17 10:48:09 -0700471 int ret = -ENODEV, seq;
Simon Glass201417d2022-04-24 23:31:07 -0600472 char *endp;
473
474 seq = simple_strtol(name, &endp, 16);
475
476 /* Select by name, label or number */
477 if (*endp) {
478 ret = uclass_get_device_by_name(UCLASS_BOOTDEV, name, &dev);
479 if (ret == -ENODEV) {
Simon Glassd9f48572023-01-17 10:48:05 -0700480 ret = bootdev_find_by_label(name, &dev, &method_flags);
Simon Glass201417d2022-04-24 23:31:07 -0600481 if (ret) {
482 printf("Cannot find bootdev '%s' (err=%d)\n",
483 name, ret);
Simon Glassd9f48572023-01-17 10:48:05 -0700484 return log_msg_ret("lab", ret);
Simon Glass201417d2022-04-24 23:31:07 -0600485 }
486 ret = device_probe(dev);
487 }
488 if (ret) {
489 printf("Cannot probe bootdev '%s' (err=%d)\n", name,
490 ret);
Simon Glassd9f48572023-01-17 10:48:05 -0700491 return log_msg_ret("pro", ret);
Simon Glass201417d2022-04-24 23:31:07 -0600492 }
Simon Glass66e3dce2023-01-17 10:48:09 -0700493 } else if (IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
Simon Glass201417d2022-04-24 23:31:07 -0600494 ret = uclass_get_device_by_seq(UCLASS_BOOTDEV, seq, &dev);
Simon Glass66e3dce2023-01-17 10:48:09 -0700495 method_flags |= BOOTFLOW_METHF_SINGLE_DEV;
Simon Glass201417d2022-04-24 23:31:07 -0600496 }
497 if (ret) {
498 printf("Cannot find '%s' (err=%d)\n", name, ret);
499 return ret;
500 }
501
502 *devp = dev;
Simon Glassd9f48572023-01-17 10:48:05 -0700503 if (method_flagsp)
504 *method_flagsp = method_flags;
Simon Glass201417d2022-04-24 23:31:07 -0600505
506 return 0;
507}
508
Simon Glass66e3dce2023-01-17 10:48:09 -0700509int bootdev_hunt_and_find_by_label(const char *label, struct udevice **devp,
510 int *method_flagsp)
511{
512 int ret;
513
514 ret = bootdev_hunt(label, false);
515 if (ret)
516 return log_msg_ret("scn", ret);
517 ret = bootdev_find_by_label(label, devp, method_flagsp);
518 if (ret)
519 return log_msg_ret("fnd", ret);
520
521 return 0;
522}
523
Simon Glassb85fc8d2023-01-17 10:47:26 -0700524static int default_get_bootflow(struct udevice *dev, struct bootflow_iter *iter,
525 struct bootflow *bflow)
526{
527 struct udevice *blk;
528 int ret;
529
530 ret = bootdev_get_sibling_blk(dev, &blk);
531 /*
532 * If there is no media, indicate that no more partitions should be
533 * checked
534 */
535 if (ret == -EOPNOTSUPP)
536 ret = -ESHUTDOWN;
537 if (ret)
538 return log_msg_ret("blk", ret);
539 assert(blk);
540 ret = bootdev_find_in_blk(dev, blk, iter, bflow);
541 if (ret)
542 return log_msg_ret("find", ret);
543
544 return 0;
545}
546
Simon Glass201417d2022-04-24 23:31:07 -0600547int bootdev_get_bootflow(struct udevice *dev, struct bootflow_iter *iter,
548 struct bootflow *bflow)
549{
550 const struct bootdev_ops *ops = bootdev_get_ops(dev);
551
Simon Glassf738c732023-01-17 10:48:18 -0700552 log_debug("->get_bootflow %s=%p\n", dev->name, ops->get_bootflow);
Simon Glassb190deb2022-10-20 18:22:51 -0600553 bootflow_init(bflow, dev, iter->method);
Simon Glassb85fc8d2023-01-17 10:47:26 -0700554 if (!ops->get_bootflow)
555 return default_get_bootflow(dev, iter, bflow);
Simon Glass201417d2022-04-24 23:31:07 -0600556
557 return ops->get_bootflow(dev, iter, bflow);
558}
559
560void bootdev_clear_bootflows(struct udevice *dev)
561{
562 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);
563
564 while (!list_empty(&ucp->bootflow_head)) {
565 struct bootflow *bflow;
566
567 bflow = list_first_entry(&ucp->bootflow_head, struct bootflow,
568 bm_node);
Simon Glassa8f5be12022-04-24 23:31:09 -0600569 bootflow_remove(bflow);
Simon Glass201417d2022-04-24 23:31:07 -0600570 }
571}
572
Simon Glasse4b69482023-01-17 10:48:10 -0700573int bootdev_next_label(struct bootflow_iter *iter, struct udevice **devp,
574 int *method_flagsp)
575{
576 struct udevice *dev;
577
578 log_debug("next\n");
579 for (dev = NULL; !dev && iter->labels[++iter->cur_label];) {
580 log_debug("Scanning: %s\n", iter->labels[iter->cur_label]);
581 bootdev_hunt_and_find_by_label(iter->labels[iter->cur_label],
582 &dev, method_flagsp);
583 }
584
585 if (!dev)
586 return log_msg_ret("fin", -ENODEV);
587 *devp = dev;
588
589 return 0;
590}
591
Simon Glass43e89a32023-01-17 10:48:11 -0700592int bootdev_next_prio(struct bootflow_iter *iter, struct udevice **devp)
593{
594 struct udevice *dev = *devp;
595 bool found;
596 int ret;
597
598 /* find the next device with this priority */
599 *devp = NULL;
600 log_debug("next prio %d: dev=%p/%s\n", iter->cur_prio, dev,
601 dev ? dev->name : "none");
602 do {
603 /*
604 * Don't probe devices here since they may not be of the
605 * required priority
606 */
607 if (!dev)
608 uclass_find_first_device(UCLASS_BOOTDEV, &dev);
609 else
610 uclass_find_next_device(&dev);
611 found = false;
612
613 /* scan for the next device with the correct priority */
614 while (dev) {
615 struct bootdev_uc_plat *plat;
616
617 plat = dev_get_uclass_plat(dev);
618 log_debug("- %s: %d, want %d\n", dev->name, plat->prio,
619 iter->cur_prio);
620 if (plat->prio == iter->cur_prio)
621 break;
622 uclass_find_next_device(&dev);
623 }
624
625 /* none found for this priority, so move to the next */
626 if (!dev) {
627 log_debug("None found at prio %d, moving to %d\n",
628 iter->cur_prio, iter->cur_prio + 1);
629 if (++iter->cur_prio == BOOTDEVP_COUNT)
630 return log_msg_ret("fin", -ENODEV);
631
632 if (iter->flags & BOOTFLOWF_HUNT) {
633 /* hunt to find new bootdevs */
634 ret = bootdev_hunt_prio(iter->cur_prio,
635 iter->flags &
636 BOOTFLOWF_SHOW);
637 log_debug("- hunt ret %d\n", ret);
638 if (ret)
639 return log_msg_ret("hun", ret);
640 }
641 } else {
642 ret = device_probe(dev);
643 if (ret) {
644 log_debug("Device '%s' failed to probe\n",
645 dev->name);
646 dev = NULL;
647 }
648 }
649 } while (!dev);
650
651 *devp = dev;
652
653 return 0;
654}
655
Simon Glass91943ff2023-01-17 10:48:15 -0700656int bootdev_setup_iter(struct bootflow_iter *iter, const char *label,
657 struct udevice **devp, int *method_flagsp)
Simon Glass201417d2022-04-24 23:31:07 -0600658{
Simon Glass91943ff2023-01-17 10:48:15 -0700659 struct udevice *bootstd, *dev = NULL;
Simon Glasseacc2612023-01-17 10:48:08 -0700660 bool show = iter->flags & BOOTFLOWF_SHOW;
Simon Glass47aedc22023-01-17 10:48:14 -0700661 int method_flags;
Simon Glass201417d2022-04-24 23:31:07 -0600662 int ret;
663
664 ret = uclass_first_device_err(UCLASS_BOOTSTD, &bootstd);
665 if (ret) {
666 log_err("Missing bootstd device\n");
667 return log_msg_ret("std", ret);
668 }
669
Simon Glasseacc2612023-01-17 10:48:08 -0700670 /* hunt for any pre-scan devices */
671 if (iter->flags & BOOTFLOWF_HUNT) {
672 ret = bootdev_hunt_prio(BOOTDEVP_1_PRE_SCAN, show);
673 if (ret)
674 return log_msg_ret("pre", ret);
675 }
676
Simon Glass201417d2022-04-24 23:31:07 -0600677 /* Handle scanning a single device */
Simon Glass91943ff2023-01-17 10:48:15 -0700678 if (IS_ENABLED(CONFIG_BOOTSTD_FULL) && label) {
679 if (iter->flags & BOOTFLOWF_HUNT) {
680 ret = bootdev_hunt(label, show);
681 if (ret)
682 return log_msg_ret("hun", ret);
683 }
684 ret = bootdev_find_by_any(label, &dev, &method_flags);
685 if (ret)
686 return log_msg_ret("lab", ret);
687
688 log_debug("method_flags: %x\n", method_flags);
689 if (method_flags & BOOTFLOW_METHF_SINGLE_UCLASS)
690 iter->flags |= BOOTFLOWF_SINGLE_UCLASS;
691 else if (method_flags & BOOTFLOW_METHF_SINGLE_DEV)
692 iter->flags |= BOOTFLOWF_SINGLE_DEV;
693 else
694 iter->flags |= BOOTFLOWF_SINGLE_MEDIA;
695 log_debug("Selected label: %s, flags %x\n", label, iter->flags);
Simon Glass47aedc22023-01-17 10:48:14 -0700696 } else {
697 bool ok;
698
699 /* This either returns a non-empty list or NULL */
700 iter->labels = bootstd_get_bootdev_order(bootstd, &ok);
701 if (!ok)
702 return log_msg_ret("ord", -ENOMEM);
703 log_debug("setup labels %p\n", iter->labels);
704 if (iter->labels) {
705 iter->cur_label = -1;
706 ret = bootdev_next_label(iter, &dev, &method_flags);
707 } else {
708 ret = bootdev_next_prio(iter, &dev);
709 method_flags = 0;
710 }
711 if (!dev)
712 return log_msg_ret("fin", -ENOENT);
713 log_debug("Selected bootdev: %s\n", dev->name);
Simon Glass201417d2022-04-24 23:31:07 -0600714 }
715
Simon Glass201417d2022-04-24 23:31:07 -0600716 ret = device_probe(dev);
717 if (ret)
718 return log_msg_ret("probe", ret);
Simon Glass47aedc22023-01-17 10:48:14 -0700719 if (method_flagsp)
720 *method_flagsp = method_flags;
Simon Glass201417d2022-04-24 23:31:07 -0600721 *devp = dev;
722
723 return 0;
724}
725
Simon Glassc7b63d52023-01-17 10:47:34 -0700726static int bootdev_hunt_drv(struct bootdev_hunter *info, uint seq, bool show)
727{
728 const char *name = uclass_get_name(info->uclass);
729 struct bootstd_priv *std;
730 int ret;
731
732 ret = bootstd_get_priv(&std);
733 if (ret)
734 return log_msg_ret("std", ret);
735
736 if (!(std->hunters_used & BIT(seq))) {
737 if (show)
738 printf("Hunting with: %s\n",
739 uclass_get_name(info->uclass));
740 log_debug("Hunting with: %s\n", name);
741 if (info->hunt) {
742 ret = info->hunt(info, show);
743 if (ret)
744 return ret;
745 }
746 std->hunters_used |= BIT(seq);
747 }
748
749 return 0;
750}
751
752int bootdev_hunt(const char *spec, bool show)
753{
754 struct bootdev_hunter *start;
755 const char *end;
756 int n_ent, i;
757 int result;
758 size_t len;
759
760 start = ll_entry_start(struct bootdev_hunter, bootdev_hunter);
761 n_ent = ll_entry_count(struct bootdev_hunter, bootdev_hunter);
762 result = 0;
763
764 len = SIZE_MAX;
765 if (spec) {
766 trailing_strtoln_end(spec, NULL, &end);
767 len = end - spec;
768 }
769
770 for (i = 0; i < n_ent; i++) {
771 struct bootdev_hunter *info = start + i;
772 const char *name = uclass_get_name(info->uclass);
773 int ret;
774
775 log_debug("looking at %.*s for %s\n",
776 (int)max(strlen(name), len), spec, name);
Simon Glasse4b69482023-01-17 10:48:10 -0700777 if (spec && strncmp(spec, name, max(strlen(name), len))) {
778 if (info->uclass != UCLASS_ETH ||
779 (strcmp("dhcp", spec) && strcmp("pxe", spec)))
780 continue;
781 }
Simon Glassc7b63d52023-01-17 10:47:34 -0700782 ret = bootdev_hunt_drv(info, i, show);
783 if (ret)
784 result = ret;
785 }
786
787 return result;
788}
789
Simon Glass79a7d4a2023-01-17 10:48:07 -0700790int bootdev_hunt_prio(enum bootdev_prio_t prio, bool show)
791{
792 struct bootdev_hunter *start;
793 int n_ent, i;
794 int result;
795
796 start = ll_entry_start(struct bootdev_hunter, bootdev_hunter);
797 n_ent = ll_entry_count(struct bootdev_hunter, bootdev_hunter);
798 result = 0;
799
800 log_debug("Hunting for priority %d\n", prio);
801 for (i = 0; i < n_ent; i++) {
802 struct bootdev_hunter *info = start + i;
803 int ret;
804
805 if (prio != info->prio)
806 continue;
807 ret = bootdev_hunt_drv(info, i, show);
808 if (ret && ret != -ENOENT)
809 result = ret;
810 }
811
812 return result;
813}
814
Simon Glassbd90b092023-01-17 10:47:33 -0700815void bootdev_list_hunters(struct bootstd_priv *std)
816{
817 struct bootdev_hunter *orig, *start;
818 int n_ent, i;
819
820 orig = ll_entry_start(struct bootdev_hunter, bootdev_hunter);
821 n_ent = ll_entry_count(struct bootdev_hunter, bootdev_hunter);
822
823 /*
824 * workaround for strange bug in clang-12 which sees all the below data
825 * as zeroes. Any access of start seems to fix it, such as
826 *
827 * printf("%p", start);
828 *
829 * Use memcpy() to force the correct behaviour.
830 */
831 memcpy(&start, &orig, sizeof(orig));
832 printf("%4s %4s %-15s %s\n", "Prio", "Used", "Uclass", "Hunter");
833 printf("%4s %4s %-15s %s\n", "----", "----", "---------------", "---------------");
834 for (i = 0; i < n_ent; i++) {
835 struct bootdev_hunter *info = start + i;
836
837 printf("%4d %4s %-15s %s\n", info->prio,
838 std->hunters_used & BIT(i) ? "*" : "",
839 uclass_get_name(info->uclass),
840 info->drv ? info->drv->name : "(none)");
841 }
842
843 printf("(total hunters: %d)\n", n_ent);
844}
845
Simon Glass201417d2022-04-24 23:31:07 -0600846static int bootdev_post_bind(struct udevice *dev)
847{
848 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);
849
850 INIT_LIST_HEAD(&ucp->bootflow_head);
851
852 return 0;
853}
854
855static int bootdev_pre_unbind(struct udevice *dev)
856{
857 bootdev_clear_bootflows(dev);
858
859 return 0;
860}
861
862UCLASS_DRIVER(bootdev) = {
863 .id = UCLASS_BOOTDEV,
864 .name = "bootdev",
865 .flags = DM_UC_FLAG_SEQ_ALIAS,
866 .per_device_plat_auto = sizeof(struct bootdev_uc_plat),
867 .post_bind = bootdev_post_bind,
868 .pre_unbind = bootdev_pre_unbind,
869};