1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2021 Google LLC
7 #define LOG_CATEGORY UCLASS_BOOTSTD
20 #include <dm/device-internal.h>
22 #include <dm/uclass-internal.h>
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
30 MAX_PART_PER_BOOTDEV = 30,
32 /* Maximum supported length of the "boot_targets" env string */
33 BOOT_TARGETS_MAX_LEN = 100,
36 int bootdev_add_bootflow(struct bootflow *bflow)
38 struct bootstd_priv *std;
42 ret = bootstd_get_priv(&std);
46 new = malloc(sizeof(*bflow));
48 return log_msg_ret("bflow", -ENOMEM);
49 memcpy(new, bflow, sizeof(*bflow));
51 list_add_tail(&new->glob_node, &std->glob_head);
53 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(bflow->dev);
55 list_add_tail(&new->bm_node, &ucp->bootflow_head);
61 int bootdev_first_bootflow(struct udevice *dev, struct bootflow **bflowp)
63 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);
65 if (list_empty(&ucp->bootflow_head))
68 *bflowp = list_first_entry(&ucp->bootflow_head, struct bootflow,
74 int bootdev_next_bootflow(struct bootflow **bflowp)
76 struct bootflow *bflow = *bflowp;
77 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(bflow->dev);
81 if (list_is_last(&bflow->bm_node, &ucp->bootflow_head))
84 *bflowp = list_entry(bflow->bm_node.next, struct bootflow, bm_node);
89 int bootdev_bind(struct udevice *parent, const char *drv_name, const char *name,
90 struct udevice **devp)
97 snprintf(dev_name, sizeof(dev_name), "%s.%s", parent->name, name);
98 str = strdup(dev_name);
101 ret = device_bind_driver(parent, drv_name, str, &dev);
104 device_set_name_alloced(dev);
110 int bootdev_find_in_blk(struct udevice *dev, struct udevice *blk,
111 struct bootflow_iter *iter, struct bootflow *bflow)
113 struct bootmeth_uc_plat *plat = dev_get_uclass_plat(bflow->method);
114 bool allow_any_part = plat->flags & BOOTMETHF_ANY_PART;
115 struct blk_desc *desc = dev_get_uclass_plat(blk);
116 struct disk_partition info;
122 if (iter->part >= MAX_PART_PER_BOOTDEV)
123 return log_msg_ret("max", -ESHUTDOWN);
127 snprintf(partstr, sizeof(partstr), "part_%x", iter->part);
129 strcpy(partstr, "whole");
130 snprintf(name, sizeof(name), "%s.%s", dev->name, partstr);
131 bflow->name = strdup(name);
133 return log_msg_ret("name", -ENOMEM);
135 bflow->part = iter->part;
137 ret = bootmeth_check(bflow->method, iter);
139 return log_msg_ret("check", ret);
142 * partition numbers start at 0 so this cannot succeed, but it can tell
143 * us whether there is valid media there
145 ret = part_get_info(desc, iter->part, &info);
146 log_debug("part_get_info() returned %d\n", ret);
147 if (!iter->part && ret == -ENOENT)
151 * This error indicates the media is not present. Otherwise we just
152 * blindly scan the next partition. We could be more intelligent here
153 * and check which partition numbers actually exist.
155 if (ret == -EOPNOTSUPP)
158 bflow->state = BOOTFLOWST_MEDIA;
159 if (ret && !allow_any_part) {
160 /* allow partition 1 to be missing */
161 if (iter->part == 1) {
166 return log_msg_ret("part", ret);
170 * Currently we don't get the number of partitions, so just
171 * assume a large number
173 iter->max_part = MAX_PART_PER_BOOTDEV;
175 if (iter->flags & BOOTFLOWIF_SINGLE_PARTITION) {
176 /* a particular partition was specified, scan it without checking */
177 } else if (!iter->part) {
178 /* This is the whole disk, check if we have bootable partitions */
179 iter->first_bootable = part_get_bootable(desc);
180 log_debug("checking bootable=%d\n", iter->first_bootable);
181 } else if (allow_any_part) {
183 * allow any partition to be scanned, by skipping any checks
184 * for filesystems or partition contents on this disk
187 /* if there are bootable partitions, scan only those */
188 } else if (iter->first_bootable >= 0 &&
189 (iter->first_bootable ? !info.bootable : iter->part != 1)) {
190 return log_msg_ret("boot", -EINVAL);
192 ret = fs_set_blk_dev_with_part(desc, bflow->part);
193 bflow->state = BOOTFLOWST_PART;
195 return log_msg_ret("fs", ret);
197 log_debug("%s: Found partition %x type %x fstype %d\n",
198 blk->name, bflow->part,
199 IS_ENABLED(CONFIG_DOS_PARTITION) ?
200 disk_partition_sys_ind(&info) : 0,
201 ret ? -1 : fs_get_type());
203 bflow->state = BOOTFLOWST_FS;
206 log_debug("method %s\n", bflow->method->name);
207 ret = bootmeth_read_bootflow(bflow->method, bflow);
209 return log_msg_ret("method", ret);
214 void bootdev_list(bool probe)
220 printf("Seq Probed Status Uclass Name\n");
221 printf("--- ------ ------ -------- ------------------\n");
223 ret = uclass_first_device_check(UCLASS_BOOTDEV, &dev);
225 ret = uclass_find_first_device(UCLASS_BOOTDEV, &dev);
226 for (i = 0; dev; i++) {
227 printf("%3x [ %c ] %6s %-9.9s %s\n", dev_seq(dev),
228 device_active(dev) ? '+' : ' ',
229 ret ? simple_itoa(-ret) : "OK",
230 dev_get_uclass_name(dev_get_parent(dev)), dev->name);
232 ret = uclass_next_device_check(&dev);
234 ret = uclass_find_next_device(&dev);
236 printf("--- ------ ------ -------- ------------------\n");
237 printf("(%d bootdev%s)\n", i, i != 1 ? "s" : "");
240 int bootdev_setup_for_dev(struct udevice *parent, const char *drv_name)
242 struct udevice *bdev;
245 ret = device_find_first_child_by_uclass(parent, UCLASS_BOOTDEV,
248 if (ret != -ENODEV) {
249 log_debug("Cannot access bootdev device\n");
253 ret = bootdev_bind(parent, drv_name, "bootdev", &bdev);
255 log_debug("Cannot create bootdev device\n");
263 static int bootdev_get_suffix_start(struct udevice *dev, const char *suffix)
267 len = strlen(dev->name);
268 slen = strlen(suffix);
269 if (len > slen && !strcmp(suffix, dev->name + len - slen))
275 int bootdev_setup_for_sibling_blk(struct udevice *blk, const char *drv_name)
277 struct udevice *parent, *dev;
281 len = bootdev_get_suffix_start(blk, ".blk");
282 snprintf(dev_name, sizeof(dev_name), "%.*s.%s", len, blk->name,
285 parent = dev_get_parent(blk);
286 ret = device_find_child_by_name(parent, dev_name, &dev);
290 if (ret != -ENODEV) {
291 log_debug("Cannot access bootdev device\n");
294 str = strdup(dev_name);
298 ret = device_bind_driver(parent, drv_name, str, &dev);
300 log_debug("Cannot create bootdev device\n");
303 device_set_name_alloced(dev);
309 int bootdev_get_sibling_blk(struct udevice *dev, struct udevice **blkp)
311 struct udevice *parent = dev_get_parent(dev);
315 if (device_get_uclass_id(dev) != UCLASS_BOOTDEV)
319 * This should always work if bootdev_setup_for_sibling_blk() was used
321 len = bootdev_get_suffix_start(dev, ".bootdev");
322 ret = device_find_child_by_namelen(parent, dev->name, len, &blk);
326 snprintf(dev_name, sizeof(dev_name), "%.*s.blk", len,
328 ret = device_find_child_by_name(parent, dev_name, &blk);
330 return log_msg_ret("find", ret);
332 ret = device_probe(blk);
334 return log_msg_ret("act", ret);
340 static int bootdev_get_from_blk(struct udevice *blk, struct udevice **bootdevp)
342 struct udevice *parent = dev_get_parent(blk);
343 struct udevice *bootdev;
347 if (device_get_uclass_id(blk) != UCLASS_BLK)
350 /* This should always work if bootdev_setup_for_sibling_blk() was used */
351 len = bootdev_get_suffix_start(blk, ".blk");
352 snprintf(dev_name, sizeof(dev_name), "%.*s.%s", len, blk->name,
354 ret = device_find_child_by_name(parent, dev_name, &bootdev);
356 return log_msg_ret("find", ret);
362 int bootdev_unbind_dev(struct udevice *parent)
367 ret = device_find_first_child_by_uclass(parent, UCLASS_BOOTDEV, &dev);
369 ret = device_remove(dev, DM_REMOVE_NORMAL);
371 return log_msg_ret("rem", ret);
372 ret = device_unbind(dev);
374 return log_msg_ret("unb", ret);
381 * label_to_uclass() - Convert a label to a uclass and sequence number
383 * @label: Label to look up (e.g. "mmc1" or "mmc0")
384 * @seqp: Returns the sequence number, or -1 if none
385 * @method_flagsp: If non-NULL, returns any flags implied by the label
386 * (enum bootflow_meth_flags_t), 0 if none
387 * Returns: sequence number on success, -EPFNOSUPPORT is the uclass is not
388 * known, other -ve error code on other error
390 static int label_to_uclass(const char *label, int *seqp, int *method_flagsp)
392 int seq, len, method_flags;
397 seq = trailing_strtoln_end(label, NULL, &end);
401 id = uclass_get_by_namelen(label, len);
402 log_debug("find %s: seq=%d, id=%d/%s\n", label, seq, id,
403 uclass_get_name(id));
404 if (id == UCLASS_INVALID) {
405 /* try some special cases */
406 if (IS_ENABLED(CONFIG_BOOTDEV_SPI_FLASH) &&
407 !strncmp("spi", label, len)) {
408 id = UCLASS_SPI_FLASH;
409 } else if (IS_ENABLED(CONFIG_BOOTDEV_ETH) &&
410 !strncmp("pxe", label, len)) {
412 method_flags |= BOOTFLOW_METHF_PXE_ONLY;
413 } else if (IS_ENABLED(CONFIG_BOOTDEV_ETH) &&
414 !strncmp("dhcp", label, len)) {
416 method_flags |= BOOTFLOW_METHF_DHCP_ONLY;
418 return -EPFNOSUPPORT;
421 if (id == UCLASS_USB)
422 id = UCLASS_MASS_STORAGE;
425 *method_flagsp = method_flags;
430 int bootdev_find_by_label(const char *label, struct udevice **devp,
433 int seq, ret, method_flags = 0;
434 struct udevice *media;
438 ret = label_to_uclass(label, &seq, &method_flags);
440 return log_msg_ret("uc", ret);
443 /* Iterate through devices in the media uclass (e.g. UCLASS_MMC) */
444 uclass_id_foreach_dev(id, media, uc) {
445 struct udevice *bdev, *blk;
448 /* if there is no seq, match anything */
449 if (seq != -1 && dev_seq(media) != seq) {
450 log_debug("- skip, media seq=%d\n", dev_seq(media));
454 ret = device_find_first_child_by_uclass(media, UCLASS_BOOTDEV,
457 log_debug("- looking via blk, seq=%d, id=%d\n", seq,
459 ret = blk_find_device(id, seq, &blk);
461 log_debug("- get from blk %s\n", blk->name);
462 ret = bootdev_get_from_blk(blk, &bdev);
466 log_debug("- found %s\n", bdev->name);
470 * if no sequence number was provided, we must scan all
471 * bootdevs for this media uclass
474 method_flags |= BOOTFLOW_METHF_SINGLE_UCLASS;
476 *method_flagsp = method_flags;
477 log_debug("method flags %x\n", method_flags);
480 log_debug("- no device in %s\n", media->name);
486 int bootdev_find_by_any(const char *name, struct udevice **devp,
490 int method_flags = 0;
491 int ret = -ENODEV, seq;
494 seq = simple_strtol(name, &endp, 16);
496 /* Select by name, label or number */
498 ret = uclass_get_device_by_name(UCLASS_BOOTDEV, name, &dev);
499 if (ret == -ENODEV) {
500 ret = bootdev_find_by_label(name, &dev, &method_flags);
502 printf("Cannot find bootdev '%s' (err=%d)\n",
504 return log_msg_ret("lab", ret);
506 ret = device_probe(dev);
509 printf("Cannot probe bootdev '%s' (err=%d)\n", name,
511 return log_msg_ret("pro", ret);
513 } else if (IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
514 ret = uclass_get_device_by_seq(UCLASS_BOOTDEV, seq, &dev);
515 method_flags |= BOOTFLOW_METHF_SINGLE_DEV;
518 printf("Cannot find '%s' (err=%d)\n", name, ret);
524 *method_flagsp = method_flags;
529 int bootdev_hunt_and_find_by_label(const char *label, struct udevice **devp,
534 ret = bootdev_hunt(label, false);
536 return log_msg_ret("scn", ret);
537 ret = bootdev_find_by_label(label, devp, method_flagsp);
539 return log_msg_ret("fnd", ret);
544 static int default_get_bootflow(struct udevice *dev, struct bootflow_iter *iter,
545 struct bootflow *bflow)
550 ret = bootdev_get_sibling_blk(dev, &blk);
551 log_debug("sibling_blk ret=%d, blk=%s\n", ret,
552 ret ? "(none)" : blk->name);
554 * If there is no media, indicate that no more partitions should be
557 if (ret == -EOPNOTSUPP)
560 return log_msg_ret("blk", ret);
562 ret = bootdev_find_in_blk(dev, blk, iter, bflow);
564 return log_msg_ret("find", ret);
569 int bootdev_get_bootflow(struct udevice *dev, struct bootflow_iter *iter,
570 struct bootflow *bflow)
572 const struct bootdev_ops *ops = bootdev_get_ops(dev);
574 log_debug("->get_bootflow %s,%x=%p\n", dev->name, iter->part,
576 bootflow_init(bflow, dev, iter->method);
577 if (!ops->get_bootflow)
578 return default_get_bootflow(dev, iter, bflow);
580 return ops->get_bootflow(dev, iter, bflow);
583 void bootdev_clear_bootflows(struct udevice *dev)
585 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);
587 while (!list_empty(&ucp->bootflow_head)) {
588 struct bootflow *bflow;
590 bflow = list_first_entry(&ucp->bootflow_head, struct bootflow,
592 bootflow_remove(bflow);
596 int bootdev_next_label(struct bootflow_iter *iter, struct udevice **devp,
602 for (dev = NULL; !dev && iter->labels[++iter->cur_label];) {
603 const char *label = iter->labels[iter->cur_label];
606 log_debug("Scanning: %s\n", label);
607 ret = bootdev_hunt_and_find_by_label(label, &dev,
609 if (iter->flags & BOOTFLOWIF_SHOW) {
610 if (ret == -EPFNOSUPPORT) {
611 log_warning("Unknown uclass '%s' in label\n",
613 } else if (ret == -ENOENT) {
615 * looking for, e.g. 'scsi0' should find
616 * something if SCSI is present
618 if (!trailing_strtol(label)) {
619 log_warning("No bootdevs for '%s'\n",
628 return log_msg_ret("fin", -ENODEV);
634 int bootdev_next_prio(struct bootflow_iter *iter, struct udevice **devp)
636 struct udevice *dev = *devp, *last_dev = NULL;
640 /* find the next device with this priority */
642 log_debug("next prio %d: dev=%p/%s\n", iter->cur_prio, dev,
643 dev ? dev->name : "none");
646 * Don't probe devices here since they may not be of the
650 uclass_find_first_device(UCLASS_BOOTDEV, &dev);
652 uclass_find_next_device(&dev);
655 /* scan for the next device with the correct priority */
657 struct bootdev_uc_plat *plat;
659 plat = dev_get_uclass_plat(dev);
660 log_debug("- %s: %d, want %d\n", dev->name, plat->prio,
662 if (plat->prio == iter->cur_prio)
664 uclass_find_next_device(&dev);
667 /* none found for this priority, so move to the next */
669 log_debug("None found at prio %d, moving to %d\n",
670 iter->cur_prio, iter->cur_prio + 1);
671 if (++iter->cur_prio == BOOTDEVP_COUNT)
672 return log_msg_ret("fin", -ENODEV);
674 if (iter->flags & BOOTFLOWIF_HUNT) {
675 /* hunt to find new bootdevs */
676 ret = bootdev_hunt_prio(iter->cur_prio,
679 log_debug("- bootdev_hunt_prio() ret %d\n",
682 return log_msg_ret("hun", ret);
685 ret = device_probe(dev);
689 log_warning("Device '%s' failed to probe\n",
691 if (last_dev == dev) {
693 * We have already tried this device
694 * and it failed to probe. Give up.
696 return log_msg_ret("probe", ret);
709 int bootdev_setup_iter(struct bootflow_iter *iter, const char *label,
710 struct udevice **devp, int *method_flagsp)
712 struct udevice *bootstd, *dev = NULL;
713 bool show = iter->flags & BOOTFLOWIF_SHOW;
719 const char *end = strchr(label, ':');
722 size_t len = (size_t)(end - label);
723 const char *part = end + 1;
725 if (len + 1 > sizeof(buf)) {
726 log_err("label \"%s\" is way too long\n", label);
730 memcpy(buf, label, len);
736 if (strict_strtoul(part, 0, &tmp)) {
737 log_err("Invalid partition number: %s\n", part);
741 iter->flags |= BOOTFLOWIF_SINGLE_PARTITION;
746 ret = uclass_first_device_err(UCLASS_BOOTSTD, &bootstd);
748 log_err("Missing bootstd device\n");
749 return log_msg_ret("std", ret);
752 /* hunt for any pre-scan devices */
753 if (iter->flags & BOOTFLOWIF_HUNT) {
754 ret = bootdev_hunt_prio(BOOTDEVP_1_PRE_SCAN, show);
755 log_debug("- bootdev_hunt_prio() ret %d\n", ret);
757 return log_msg_ret("pre", ret);
760 /* Handle scanning a single device */
761 if (IS_ENABLED(CONFIG_BOOTSTD_FULL) && label) {
762 if (iter->flags & BOOTFLOWIF_HUNT) {
763 ret = bootdev_hunt(label, show);
765 return log_msg_ret("hun", ret);
767 ret = bootdev_find_by_any(label, &dev, &method_flags);
769 return log_msg_ret("lab", ret);
771 log_debug("method_flags: %x\n", method_flags);
772 if (method_flags & BOOTFLOW_METHF_SINGLE_UCLASS)
773 iter->flags |= BOOTFLOWIF_SINGLE_UCLASS;
774 else if (method_flags & BOOTFLOW_METHF_SINGLE_DEV)
775 iter->flags |= BOOTFLOWIF_SINGLE_DEV;
777 iter->flags |= BOOTFLOWIF_SINGLE_MEDIA;
778 log_debug("Selected label: %s, flags %x\n", label, iter->flags);
782 /* This either returns a non-empty list or NULL */
783 iter->labels = bootstd_get_bootdev_order(bootstd, &ok);
785 return log_msg_ret("ord", -ENOMEM);
786 log_debug("setup labels %p\n", iter->labels);
788 iter->cur_label = -1;
789 ret = bootdev_next_label(iter, &dev, &method_flags);
791 ret = bootdev_next_prio(iter, &dev);
795 return log_msg_ret("fin", -ENOENT);
796 log_debug("Selected bootdev: %s\n", dev->name);
799 ret = device_probe(dev);
801 return log_msg_ret("probe", ret);
803 *method_flagsp = method_flags;
809 static int bootdev_hunt_drv(struct bootdev_hunter *info, uint seq, bool show)
811 const char *name = uclass_get_name(info->uclass);
812 struct bootstd_priv *std;
815 ret = bootstd_get_priv(&std);
817 return log_msg_ret("std", ret);
819 if (!(std->hunters_used & BIT(seq))) {
821 printf("Hunting with: %s\n",
822 uclass_get_name(info->uclass));
823 log_debug("Hunting with: %s\n", name);
825 ret = info->hunt(info, show);
826 log_debug(" - hunt result %d\n", ret);
827 if (ret && ret != -ENOENT)
830 std->hunters_used |= BIT(seq);
836 int bootdev_hunt(const char *spec, bool show)
838 struct bootdev_hunter *start;
844 start = ll_entry_start(struct bootdev_hunter, bootdev_hunter);
845 n_ent = ll_entry_count(struct bootdev_hunter, bootdev_hunter);
850 trailing_strtoln_end(spec, NULL, &end);
854 for (i = 0; i < n_ent; i++) {
855 struct bootdev_hunter *info = start + i;
856 const char *name = uclass_get_name(info->uclass);
859 log_debug("looking at %.*s for %s\n",
860 (int)max(strlen(name), len), spec, name);
861 if (spec && strncmp(spec, name, max(strlen(name), len))) {
862 if (info->uclass != UCLASS_ETH ||
863 (strcmp("dhcp", spec) && strcmp("pxe", spec)))
866 ret = bootdev_hunt_drv(info, i, show);
874 int bootdev_unhunt(enum uclass_id id)
876 struct bootdev_hunter *start;
879 start = ll_entry_start(struct bootdev_hunter, bootdev_hunter);
880 n_ent = ll_entry_count(struct bootdev_hunter, bootdev_hunter);
881 for (i = 0; i < n_ent; i++) {
882 struct bootdev_hunter *info = start + i;
884 if (info->uclass == id) {
885 struct bootstd_priv *std;
888 ret = bootstd_get_priv(&std);
890 return log_msg_ret("std", ret);
891 if (!(std->hunters_used & BIT(i)))
893 std->hunters_used &= ~BIT(i);
901 int bootdev_hunt_prio(enum bootdev_prio_t prio, bool show)
903 struct bootdev_hunter *start;
907 start = ll_entry_start(struct bootdev_hunter, bootdev_hunter);
908 n_ent = ll_entry_count(struct bootdev_hunter, bootdev_hunter);
911 log_debug("Hunting for priority %d\n", prio);
912 for (i = 0; i < n_ent; i++) {
913 struct bootdev_hunter *info = start + i;
916 if (prio != info->prio)
918 ret = bootdev_hunt_drv(info, i, show);
919 log_debug("bootdev_hunt_drv() return %d\n", ret);
920 if (ret && ret != -ENOENT)
923 log_debug("exit %d\n", result);
928 void bootdev_list_hunters(struct bootstd_priv *std)
930 struct bootdev_hunter *orig, *start;
933 orig = ll_entry_start(struct bootdev_hunter, bootdev_hunter);
934 n_ent = ll_entry_count(struct bootdev_hunter, bootdev_hunter);
937 * workaround for strange bug in clang-12 which sees all the below data
938 * as zeroes. Any access of start seems to fix it, such as
940 * printf("%p", start);
942 * Use memcpy() to force the correct behaviour.
944 memcpy(&start, &orig, sizeof(orig));
945 printf("%4s %4s %-15s %s\n", "Prio", "Used", "Uclass", "Hunter");
946 printf("%4s %4s %-15s %s\n", "----", "----", "---------------", "---------------");
947 for (i = 0; i < n_ent; i++) {
948 struct bootdev_hunter *info = start + i;
950 printf("%4d %4s %-15s %s\n", info->prio,
951 std->hunters_used & BIT(i) ? "*" : "",
952 uclass_get_name(info->uclass),
953 info->drv ? info->drv->name : "(none)");
956 printf("(total hunters: %d)\n", n_ent);
959 static int bootdev_post_bind(struct udevice *dev)
961 struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);
963 INIT_LIST_HEAD(&ucp->bootflow_head);
968 static int bootdev_pre_unbind(struct udevice *dev)
970 bootdev_clear_bootflows(dev);
975 UCLASS_DRIVER(bootdev) = {
976 .id = UCLASS_BOOTDEV,
978 .flags = DM_UC_FLAG_SEQ_ALIAS,
979 .per_device_plat_auto = sizeof(struct bootdev_uc_plat),
980 .post_bind = bootdev_post_bind,
981 .pre_unbind = bootdev_pre_unbind,