[J-u-boot.git] / boot / bootflow.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright 2021 Google LLC
 * Written by Simon Glass <[email protected]>
 */

#define LOG_CATEGORY UCLASS_BOOTSTD

#include <common.h>
#include <bootdev.h>
#include <bootflow.h>
#include <bootmeth.h>
#include <bootstd.h>
#include <dm.h>
#include <malloc.h>
#include <dm/device-internal.h>
#include <dm/uclass-internal.h>

/* error codes used to signal running out of things */
enum {
	BF_NO_MORE_PARTS	= -ESHUTDOWN,
	BF_NO_MORE_DEVICES	= -ENODEV,
};

/**
 * bootflow_state - name for each state
 *
 * See enum bootflow_state_t for what each of these means
 */
static const char *const bootflow_state[BOOTFLOWST_COUNT] = {
	"base",
	"media",
	"part",
	"fs",
	"file",
	"ready",
};

const char *bootflow_state_get_name(enum bootflow_state_t state)
{
	/* This doesn't need to be a useful name, since it will never occur */
	if (state < 0 || state >= BOOTFLOWST_COUNT)
		return "?";

	return bootflow_state[state];
}

int bootflow_first_glob(struct bootflow **bflowp)
{
	struct bootstd_priv *std;
	int ret;

	ret = bootstd_get_priv(&std);
	if (ret)
		return ret;

	if (list_empty(&std->glob_head))
		return -ENOENT;

	*bflowp = list_first_entry(&std->glob_head, struct bootflow,
				   glob_node);

	return 0;
}

int bootflow_next_glob(struct bootflow **bflowp)
{
	struct bootstd_priv *std;
	struct bootflow *bflow = *bflowp;
	int ret;

	ret = bootstd_get_priv(&std);
	if (ret)
		return ret;

	*bflowp = NULL;

	if (list_is_last(&bflow->glob_node, &std->glob_head))
		return -ENOENT;

	*bflowp = list_entry(bflow->glob_node.next, struct bootflow, glob_node);

	return 0;
}

void bootflow_iter_init(struct bootflow_iter *iter, int flags)
{
	memset(iter, '\0', sizeof(*iter));
	iter->first_glob_method = -1;
	iter->flags = flags;

	/* remember the first bootdevs we see */
	iter->max_devs = BOOTFLOW_MAX_USED_DEVS;
}

void bootflow_iter_uninit(struct bootflow_iter *iter)
{
	free(iter->method_order);
}

int bootflow_iter_drop_bootmeth(struct bootflow_iter *iter,
				const struct udevice *bmeth)
{
	/* We only support disabling the current bootmeth */
	if (bmeth != iter->method || iter->cur_method >= iter->num_methods ||
	    iter->method_order[iter->cur_method] != bmeth)
		return -EINVAL;

	memmove(&iter->method_order[iter->cur_method],
		&iter->method_order[iter->cur_method + 1],
		(iter->num_methods - iter->cur_method - 1) * sizeof(void *));

	iter->num_methods--;

	return 0;
}

/**
 * bootflow_iter_set_dev() - switch to the next bootdev when iterating
 *
 * This sets iter->dev, records the device in the dev_used[] list and shows a
 * message if required
 *
 * @iter: Iterator to update
 * @dev: Bootdev to use, or NULL if there are no more
 */
static void bootflow_iter_set_dev(struct bootflow_iter *iter,
				  struct udevice *dev, int method_flags)
{
	struct bootmeth_uc_plat *ucp = dev_get_uclass_plat(iter->method);

	log_debug("iter: Setting dev to %s, flags %x\n",
		  dev ? dev->name : "(none)", method_flags);
	iter->dev = dev;
	iter->method_flags = method_flags;

	if (IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
		/* record the device for later */
		if (dev && iter->num_devs < iter->max_devs)
			iter->dev_used[iter->num_devs++] = dev;

		if ((iter->flags & (BOOTFLOWF_SHOW | BOOTFLOWF_SINGLE_DEV)) ==
		    BOOTFLOWF_SHOW) {
			if (dev)
				printf("Scanning bootdev '%s':\n", dev->name);
			else if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) &&
				ucp->flags & BOOTMETHF_GLOBAL)
				printf("Scanning global bootmeth '%s':\n",
				iter->method->name);
			else
				printf("No more bootdevs\n");
		}
	}
}

/**
 * iter_incr() - Move to the next item (method, part, bootdev)
 *
 * Return: 0 if OK, BF_NO_MORE_DEVICES if there are no more bootdevs
 */
static int iter_incr(struct bootflow_iter *iter)
{
	struct udevice *dev;
	bool inc_dev = true;
	bool global;
	int ret;

	log_debug("entry: err=%d\n", iter->err);
	global = iter->doing_global;

	if (iter->err == BF_NO_MORE_DEVICES)
		return BF_NO_MORE_DEVICES;

	if (iter->err != BF_NO_MORE_PARTS) {
		/* Get the next boothmethod */
		if (++iter->cur_method < iter->num_methods) {
			iter->method = iter->method_order[iter->cur_method];
			return 0;
		}

		/*
		 * If we have finished scanning the global bootmeths, start the
		 * normal bootdev scan
		 */
		if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && global) {
			iter->num_methods = iter->first_glob_method;
			iter->doing_global = false;

			/*
			 * Don't move to the next dev as we haven't tried this
			 * one yet!
			 */
			inc_dev = false;
		}
	}

	/* No more bootmeths; start at the first one, and... */
	iter->cur_method = 0;
	iter->method = iter->method_order[iter->cur_method];

	if (iter->err != BF_NO_MORE_PARTS) {
		/* ...select next partition  */
		if (++iter->part <= iter->max_part)
			return 0;
	}

	/* No more partitions; start at the first one and... */
	iter->part = 0;

	/*
	 * Note: as far as we know, there is no partition table on the next
	 * bootdev, so set max_part to 0 until we discover otherwise. See
	 * bootdev_find_in_blk() for where this is set.
	 */
	iter->max_part = 0;

	/* ...select next bootdev */
	if (iter->flags & BOOTFLOWF_SINGLE_DEV) {
		ret = -ENOENT;
	} else {
		int method_flags;

		ret = 0;
		dev = iter->dev;
		log_debug("inc_dev=%d\n", inc_dev);
		if (!inc_dev) {
			ret = bootdev_setup_iter(iter, NULL, &dev,
						 &method_flags);
		} else if (IS_ENABLED(CONFIG_BOOTSTD_FULL) &&
			   (iter->flags & BOOTFLOWF_SINGLE_UCLASS)) {
			/* Move to the next bootdev in this uclass */
			uclass_find_next_device(&dev);
			if (!dev) {
				log_debug("finished uclass %s\n",
					  dev_get_uclass_name(dev));
				ret = -ENODEV;
			}
		} else if (IS_ENABLED(CONFIG_BOOTSTD_FULL) &&
			   iter->flags & BOOTFLOWF_SINGLE_MEDIA) {
			log_debug("next in single\n");
			method_flags = 0;
			do {
				/*
				 * Move to the next bootdev child of this media
				 * device. This ensures that we cover all the
				 * available SCSI IDs and LUNs.
				 */
				device_find_next_child(&dev);
				log_debug("- next %s\n",
					dev ? dev->name : "(none)");
			} while (dev && device_get_uclass_id(dev) !=
				UCLASS_BOOTDEV);
			if (!dev) {
				log_debug("finished uclass %s\n",
					  dev_get_uclass_name(dev));
				ret = -ENODEV;
			}
		} else {
			log_debug("labels %p\n", iter->labels);
			if (iter->labels) {
				ret = bootdev_next_label(iter, &dev,
							 &method_flags);
			} else {
				ret = bootdev_next_prio(iter, &dev);
				method_flags = 0;
			}
		}
		log_debug("ret=%d, dev=%p %s\n", ret, dev,
			  dev ? dev->name : "none");
		if (ret) {
			bootflow_iter_set_dev(iter, NULL, 0);
		} else {
			/*
			 * Probe the bootdev. This does not probe any attached
			 * block device, since they are siblings
			 */
			ret = device_probe(dev);
			log_debug("probe %s %d\n", dev->name, ret);
			if (!log_msg_ret("probe", ret))
				bootflow_iter_set_dev(iter, dev, method_flags);
		}
	}

	/* if there are no more bootdevs, give up */
	if (ret)
		return log_msg_ret("incr", BF_NO_MORE_DEVICES);

	return 0;
}

/**
 * bootflow_check() - Check if a bootflow can be obtained
 *
 * @iter: Provides part, bootmeth to use
 * @bflow: Bootflow to update on success
 * Return: 0 if OK, -ENOSYS if there is no bootflow support on this device,
 *	BF_NO_MORE_PARTS if there are no more partitions on bootdev
 */
static int bootflow_check(struct bootflow_iter *iter, struct bootflow *bflow)
{
	struct udevice *dev;
	int ret;

	if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && iter->doing_global) {
		bootflow_iter_set_dev(iter, NULL, 0);
		ret = bootmeth_get_bootflow(iter->method, bflow);
		if (ret)
			return log_msg_ret("glob", ret);

		return 0;
	}

	dev = iter->dev;
	ret = bootdev_get_bootflow(dev, iter, bflow);

	/* If we got a valid bootflow, return it */
	if (!ret) {
		log_debug("Bootdevice '%s' part %d method '%s': Found bootflow\n",
			  dev->name, iter->part, iter->method->name);
		return 0;
	}

	/* Unless there is nothing more to try, move to the next device */
	else if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
		log_debug("Bootdevice '%s' part %d method '%s': Error %d\n",
			  dev->name, iter->part, iter->method->name, ret);
		/*
		 * For 'all' we return all bootflows, even
		 * those with errors
		 */
		if (iter->flags & BOOTFLOWF_ALL)
			return log_msg_ret("all", ret);
	}
	if (ret)
		return log_msg_ret("check", ret);

	return 0;
}

int bootflow_scan_first(struct udevice *dev, const char *label,
			struct bootflow_iter *iter, int flags,
			struct bootflow *bflow)
{
	int ret;

	if (dev || label)
		flags |= BOOTFLOWF_SKIP_GLOBAL;
	bootflow_iter_init(iter, flags);

	/*
	 * Set up the ordering of bootmeths. This sets iter->doing_global and
	 * iter->first_glob_method if we are starting with the global bootmeths
	 */
	ret = bootmeth_setup_iter_order(iter, !(flags & BOOTFLOWF_SKIP_GLOBAL));
	if (ret)
		return log_msg_ret("obmeth", -ENODEV);

	/* Find the first bootmeth (there must be at least one!) */
	iter->method = iter->method_order[iter->cur_method];

	if (!IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) || !iter->doing_global) {
		struct udevice *dev = NULL;
		int method_flags;

		ret = bootdev_setup_iter(iter, label, &dev, &method_flags);
		if (ret)
			return log_msg_ret("obdev", -ENODEV);

		bootflow_iter_set_dev(iter, dev, method_flags);
	}

	ret = bootflow_check(iter, bflow);
	if (ret) {
		log_debug("check - ret=%d\n", ret);
		if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
			if (iter->flags & BOOTFLOWF_ALL)
				return log_msg_ret("all", ret);
		}
		iter->err = ret;
		ret = bootflow_scan_next(iter, bflow);
		if (ret)
			return log_msg_ret("get", ret);
	}

	return 0;
}

int bootflow_scan_next(struct bootflow_iter *iter, struct bootflow *bflow)
{
	int ret;

	do {
		ret = iter_incr(iter);
		log_debug("iter_incr: ret=%d\n", ret);
		if (ret == BF_NO_MORE_DEVICES)
			return log_msg_ret("done", ret);

		if (!ret) {
			ret = bootflow_check(iter, bflow);
			log_debug("check - ret=%d\n", ret);
			if (!ret)
				return 0;
			iter->err = ret;
			if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
				if (iter->flags & BOOTFLOWF_ALL)
					return log_msg_ret("all", ret);
			}
		} else {
			log_debug("incr failed, err=%d\n", ret);
			iter->err = ret;
		}

	} while (1);
}

void bootflow_init(struct bootflow *bflow, struct udevice *bootdev,
		   struct udevice *meth)
{
	memset(bflow, '\0', sizeof(*bflow));
	bflow->dev = bootdev;
	bflow->method = meth;
	bflow->state = BOOTFLOWST_BASE;
}

void bootflow_free(struct bootflow *bflow)
{
	free(bflow->name);
	free(bflow->subdir);
	free(bflow->fname);
	free(bflow->buf);
	free(bflow->os_name);
	free(bflow->fdt_fname);
}

void bootflow_remove(struct bootflow *bflow)
{
	if (bflow->dev)
		list_del(&bflow->bm_node);
	list_del(&bflow->glob_node);

	bootflow_free(bflow);
	free(bflow);
}

int bootflow_boot(struct bootflow *bflow)
{
	int ret;

	if (bflow->state != BOOTFLOWST_READY)
		return log_msg_ret("load", -EPROTO);

	ret = bootmeth_boot(bflow->method, bflow);
	if (ret)
		return log_msg_ret("boot", ret);

	/*
	 * internal error, should not get here since we should have booted
	 * something or returned an error
	 */

	return log_msg_ret("end", -EFAULT);
}

int bootflow_run_boot(struct bootflow_iter *iter, struct bootflow *bflow)
{
	int ret;

	printf("** Booting bootflow '%s' with %s\n", bflow->name,
	       bflow->method->name);
	ret = bootflow_boot(bflow);
	if (!IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
		printf("Boot failed (err=%d)\n", ret);
		return ret;
	}

	switch (ret) {
	case -EPROTO:
		printf("Bootflow not loaded (state '%s')\n",
		       bootflow_state_get_name(bflow->state));
		break;
	case -ENOSYS:
		printf("Boot method '%s' not supported\n", bflow->method->name);
		break;
	case -ENOTSUPP:
		/* Disable this bootflow for this iteration */
		if (iter) {
			int ret2;

			ret2 = bootflow_iter_drop_bootmeth(iter, bflow->method);
			if (!ret2) {
				printf("Boot method '%s' failed and will not be retried\n",
				       bflow->method->name);
			}
		}

		break;
	default:
		printf("Boot failed (err=%d)\n", ret);
		break;
	}

	return ret;
}

int bootflow_iter_check_blk(const struct bootflow_iter *iter)
{
	const struct udevice *media = dev_get_parent(iter->dev);
	enum uclass_id id = device_get_uclass_id(media);

	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	if (id != UCLASS_ETH && id != UCLASS_BOOTSTD)
		return 0;

	return -ENOTSUPP;
}

int bootflow_iter_check_sf(const struct bootflow_iter *iter)
{
	const struct udevice *media = dev_get_parent(iter->dev);
	enum uclass_id id = device_get_uclass_id(media);

	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	if (id == UCLASS_SPI_FLASH)
		return 0;

	return -ENOTSUPP;
}

int bootflow_iter_check_net(const struct bootflow_iter *iter)
{
	const struct udevice *media = dev_get_parent(iter->dev);
	enum uclass_id id = device_get_uclass_id(media);

	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	if (id == UCLASS_ETH)
		return 0;

	return -ENOTSUPP;
}

int bootflow_iter_check_system(const struct bootflow_iter *iter)
{
	const struct udevice *media = dev_get_parent(iter->dev);
	enum uclass_id id = device_get_uclass_id(media);

	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	if (id == UCLASS_BOOTSTD)
		return 0;

	return -ENOTSUPP;
}
Commit	Line	Data
a8f5be17 SG	1	// SPDX-License-Identifier: GPL-2.0+
	2	/*
	3	* Copyright 2021 Google LLC
	4	* Written by Simon Glass <[email protected]>
	5	*/
	6
	7	#define LOG_CATEGORY UCLASS_BOOTSTD
	8
	9	#include <common.h>
	10	#include <bootdev.h>
	11	#include <bootflow.h>
	12	#include <bootmeth.h>
	13	#include <bootstd.h>
	14	#include <dm.h>
	15	#include <malloc.h>
	16	#include <dm/device-internal.h>
	17	#include <dm/uclass-internal.h>
	18
	19	/* error codes used to signal running out of things */
	20	enum {
	21	BF_NO_MORE_PARTS = -ESHUTDOWN,
	22	BF_NO_MORE_DEVICES = -ENODEV,
	23	};
	24
	25	/**
	26	* bootflow_state - name for each state
	27	*
	28	* See enum bootflow_state_t for what each of these means
	29	*/
	30	static const char *const bootflow_state[BOOTFLOWST_COUNT] = {
	31	"base",
	32	"media",
	33	"part",
	34	"fs",
	35	"file",
	36	"ready",
	37	};
	38
	39	const char *bootflow_state_get_name(enum bootflow_state_t state)
	40	{
	41	/* This doesn't need to be a useful name, since it will never occur */
	42	if (state < 0 \|\| state >= BOOTFLOWST_COUNT)
	43	return "?";
	44
	45	return bootflow_state[state];
	46	}
	47
	48	int bootflow_first_glob(struct bootflow **bflowp)
	49	{
	50	struct bootstd_priv *std;
	51	int ret;
	52
	53	ret = bootstd_get_priv(&std);
	54	if (ret)
	55	return ret;
	56
	57	if (list_empty(&std->glob_head))
	58	return -ENOENT;
	59
	60	*bflowp = list_first_entry(&std->glob_head, struct bootflow,
	61	glob_node);
	62
	63	return 0;
	64	}
65
66	int bootflow_next_glob(struct bootflow **bflowp)
67	{
68	struct bootstd_priv *std;
69	struct bootflow bflow = bflowp;
70	int ret;
71
72	ret = bootstd_get_priv(&std);
73	if (ret)
74	return ret;
75
76	*bflowp = NULL;
77
78	if (list_is_last(&bflow->glob_node, &std->glob_head))
79	return -ENOENT;
80
81	*bflowp = list_entry(bflow->glob_node.next, struct bootflow, glob_node);
82
83	return 0;
84	}
85
86	void bootflow_iter_init(struct bootflow_iter *iter, int flags)
87	{
88	memset(iter, '\0', sizeof(*iter));
2b80bc1e	89	iter->first_glob_method = -1;
a8f5be17	90	iter->flags = flags;
a950f285 SG	91
	92	/* remember the first bootdevs we see */
	93	iter->max_devs = BOOTFLOW_MAX_USED_DEVS;
a8f5be17 SG	94	}
	95
	96	void bootflow_iter_uninit(struct bootflow_iter *iter)
	97	{
a8f5be17 SG	98	free(iter->method_order);
	99	}
	100
	101	int bootflow_iter_drop_bootmeth(struct bootflow_iter *iter,
	102	const struct udevice *bmeth)
	103	{
	104	/* We only support disabling the current bootmeth */
	105	if (bmeth != iter->method \|\| iter->cur_method >= iter->num_methods \|\|
	106	iter->method_order[iter->cur_method] != bmeth)
	107	return -EINVAL;
	108
	109	memmove(&iter->method_order[iter->cur_method],
	110	&iter->method_order[iter->cur_method + 1],
	111	(iter->num_methods - iter->cur_method - 1) * sizeof(void *));
	112
	113	iter->num_methods--;
	114
	115	return 0;
	116	}
	117
47aedc29 SG	118	/**
	119	* bootflow_iter_set_dev() - switch to the next bootdev when iterating
	120	*
	121	* This sets iter->dev, records the device in the dev_used[] list and shows a
	122	* message if required
	123	*
	124	* @iter: Iterator to update
	125	* @dev: Bootdev to use, or NULL if there are no more
	126	*/
a8f5be17	127	static void bootflow_iter_set_dev(struct bootflow_iter *iter,
47aedc29	128	struct udevice *dev, int method_flags)
a8f5be17	129	{
2b80bc1e SG	130	struct bootmeth_uc_plat *ucp = dev_get_uclass_plat(iter->method);
2b80bc1e SG	131
47aedc29 SG	132	log_debug("iter: Setting dev to %s, flags %x\n",
47aedc29 SG	133	dev ? dev->name : "(none)", method_flags);
a8f5be17	134	iter->dev = dev;
47aedc29 SG	135	iter->method_flags = method_flags;
47aedc29 SG	136
a950f285 SG	137	if (IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
	138	/* record the device for later */
	139	if (dev && iter->num_devs < iter->max_devs)
	140	iter->dev_used[iter->num_devs++] = dev;
	141
	142	if ((iter->flags & (BOOTFLOWF_SHOW \| BOOTFLOWF_SINGLE_DEV)) ==
	143	BOOTFLOWF_SHOW) {
	144	if (dev)
	145	printf("Scanning bootdev '%s':\n", dev->name);
	146	else if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) &&
	147	ucp->flags & BOOTMETHF_GLOBAL)
	148	printf("Scanning global bootmeth '%s':\n",
	149	iter->method->name);
	150	else
	151	printf("No more bootdevs\n");
	152	}
a8f5be17 SG	153	}
	154	}
	155
	156	/**
	157	* iter_incr() - Move to the next item (method, part, bootdev)
	158	*
	159	* Return: 0 if OK, BF_NO_MORE_DEVICES if there are no more bootdevs
	160	*/
	161	static int iter_incr(struct bootflow_iter *iter)
	162	{
	163	struct udevice *dev;
2b80bc1e SG	164	bool inc_dev = true;
2b80bc1e SG	165	bool global;
a8f5be17 SG	166	int ret;
a8f5be17 SG	167
47aedc29	168	log_debug("entry: err=%d\n", iter->err);
2b80bc1e SG	169	global = iter->doing_global;
2b80bc1e SG	170
a8f5be17 SG	171	if (iter->err == BF_NO_MORE_DEVICES)
	172	return BF_NO_MORE_DEVICES;
	173
	174	if (iter->err != BF_NO_MORE_PARTS) {
	175	/* Get the next boothmethod */
	176	if (++iter->cur_method < iter->num_methods) {
	177	iter->method = iter->method_order[iter->cur_method];
	178	return 0;
	179	}
2b80bc1e SG	180
	181	/*
	182	* If we have finished scanning the global bootmeths, start the
	183	* normal bootdev scan
	184	*/
	185	if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && global) {
	186	iter->num_methods = iter->first_glob_method;
	187	iter->doing_global = false;
	188
	189	/*
	190	* Don't move to the next dev as we haven't tried this
	191	* one yet!
	192	*/
	193	inc_dev = false;
	194	}
a8f5be17 SG	195	}
	196
	197	/* No more bootmeths; start at the first one, and... */
	198	iter->cur_method = 0;
	199	iter->method = iter->method_order[iter->cur_method];
	200
	201	if (iter->err != BF_NO_MORE_PARTS) {
	202	/* ...select next partition */
	203	if (++iter->part <= iter->max_part)
	204	return 0;
	205	}
	206
47aedc29	207	/* No more partitions; start at the first one and... */
a8f5be17 SG	208	iter->part = 0;
	209
	210	/*
	211	* Note: as far as we know, there is no partition table on the next
	212	* bootdev, so set max_part to 0 until we discover otherwise. See
	213	* bootdev_find_in_blk() for where this is set.
	214	*/
	215	iter->max_part = 0;
	216
	217	/* ...select next bootdev */
	218	if (iter->flags & BOOTFLOWF_SINGLE_DEV) {
	219	ret = -ENOENT;
a8f5be17	220	} else {
47aedc29 SG	221	int method_flags;
	222
	223	ret = 0;
	224	dev = iter->dev;
	225	log_debug("inc_dev=%d\n", inc_dev);
	226	if (!inc_dev) {
91943ff7 SG	227	ret = bootdev_setup_iter(iter, NULL, &dev,
	228	&method_flags);
	229	} else if (IS_ENABLED(CONFIG_BOOTSTD_FULL) &&
	230	(iter->flags & BOOTFLOWF_SINGLE_UCLASS)) {
	231	/* Move to the next bootdev in this uclass */
	232	uclass_find_next_device(&dev);
	233	if (!dev) {
	234	log_debug("finished uclass %s\n",
	235	dev_get_uclass_name(dev));
	236	ret = -ENODEV;
	237	}
	238	} else if (IS_ENABLED(CONFIG_BOOTSTD_FULL) &&
	239	iter->flags & BOOTFLOWF_SINGLE_MEDIA) {
	240	log_debug("next in single\n");
	241	method_flags = 0;
	242	do {
	243	/*
	244	* Move to the next bootdev child of this media
	245	* device. This ensures that we cover all the
	246	* available SCSI IDs and LUNs.
	247	*/
	248	device_find_next_child(&dev);
	249	log_debug("- next %s\n",
	250	dev ? dev->name : "(none)");
	251	} while (dev && device_get_uclass_id(dev) !=
	252	UCLASS_BOOTDEV);
	253	if (!dev) {
	254	log_debug("finished uclass %s\n",
	255	dev_get_uclass_name(dev));
	256	ret = -ENODEV;
	257	}
47aedc29 SG	258	} else {
	259	log_debug("labels %p\n", iter->labels);
	260	if (iter->labels) {
	261	ret = bootdev_next_label(iter, &dev,
	262	&method_flags);
	263	} else {
	264	ret = bootdev_next_prio(iter, &dev);
	265	method_flags = 0;
	266	}
	267	}
	268	log_debug("ret=%d, dev=%p %s\n", ret, dev,
	269	dev ? dev->name : "none");
	270	if (ret) {
	271	bootflow_iter_set_dev(iter, NULL, 0);
2b80bc1e	272	} else {
965020c3 SG	273	/*
	274	* Probe the bootdev. This does not probe any attached
	275	* block device, since they are siblings
	276	*/
2b80bc1e	277	ret = device_probe(dev);
47aedc29	278	log_debug("probe %s %d\n", dev->name, ret);
2b80bc1e	279	if (!log_msg_ret("probe", ret))
47aedc29	280	bootflow_iter_set_dev(iter, dev, method_flags);
2b80bc1e	281	}
a8f5be17 SG	282	}
	283
	284	/* if there are no more bootdevs, give up */
	285	if (ret)
	286	return log_msg_ret("incr", BF_NO_MORE_DEVICES);
	287
	288	return 0;
	289	}
	290
	291	/**
	292	* bootflow_check() - Check if a bootflow can be obtained
	293	*
	294	* @iter: Provides part, bootmeth to use
	295	* @bflow: Bootflow to update on success
	296	* Return: 0 if OK, -ENOSYS if there is no bootflow support on this device,
	297	* BF_NO_MORE_PARTS if there are no more partitions on bootdev
	298	*/
	299	static int bootflow_check(struct bootflow_iter iter, struct bootflow bflow)
	300	{
	301	struct udevice *dev;
	302	int ret;
	303
2b80bc1e	304	if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && iter->doing_global) {
47aedc29	305	bootflow_iter_set_dev(iter, NULL, 0);
2b80bc1e SG	306	ret = bootmeth_get_bootflow(iter->method, bflow);
	307	if (ret)
	308	return log_msg_ret("glob", ret);
	309
	310	return 0;
	311	}
	312
a8f5be17 SG	313	dev = iter->dev;
	314	ret = bootdev_get_bootflow(dev, iter, bflow);
	315
	316	/* If we got a valid bootflow, return it */
	317	if (!ret) {
	318	log_debug("Bootdevice '%s' part %d method '%s': Found bootflow\n",
	319	dev->name, iter->part, iter->method->name);
	320	return 0;
	321	}
	322
	323	/* Unless there is nothing more to try, move to the next device */
	324	else if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
	325	log_debug("Bootdevice '%s' part %d method '%s': Error %d\n",
	326	dev->name, iter->part, iter->method->name, ret);
	327	/*
	328	* For 'all' we return all bootflows, even
	329	* those with errors
	330	*/
	331	if (iter->flags & BOOTFLOWF_ALL)
	332	return log_msg_ret("all", ret);
	333	}
	334	if (ret)
	335	return log_msg_ret("check", ret);
	336
	337	return 0;
	338	}
	339
4b7cb058 SG	340	int bootflow_scan_first(struct udevice dev, const char label,
	341	struct bootflow_iter *iter, int flags,
	342	struct bootflow *bflow)
a8f5be17 SG	343	{
	344	int ret;
	345
91943ff7	346	if (dev \|\| label)
2b80bc1e	347	flags \|= BOOTFLOWF_SKIP_GLOBAL;
a8f5be17 SG	348	bootflow_iter_init(iter, flags);
a8f5be17 SG	349
47aedc29 SG	350	/*
	351	* Set up the ordering of bootmeths. This sets iter->doing_global and
	352	* iter->first_glob_method if we are starting with the global bootmeths
	353	*/
c627cfc1	354	ret = bootmeth_setup_iter_order(iter, !(flags & BOOTFLOWF_SKIP_GLOBAL));
a8f5be17 SG	355	if (ret)
	356	return log_msg_ret("obmeth", -ENODEV);
	357
	358	/* Find the first bootmeth (there must be at least one!) */
	359	iter->method = iter->method_order[iter->cur_method];
47aedc29 SG	360
	361	if (!IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) \|\| !iter->doing_global) {
	362	struct udevice *dev = NULL;
	363	int method_flags;
	364
91943ff7	365	ret = bootdev_setup_iter(iter, label, &dev, &method_flags);
47aedc29 SG	366	if (ret)
	367	return log_msg_ret("obdev", -ENODEV);
	368
	369	bootflow_iter_set_dev(iter, dev, method_flags);
	370	}
a8f5be17 SG	371
	372	ret = bootflow_check(iter, bflow);
	373	if (ret) {
f738c73a	374	log_debug("check - ret=%d\n", ret);
a8f5be17 SG	375	if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
	376	if (iter->flags & BOOTFLOWF_ALL)
	377	return log_msg_ret("all", ret);
	378	}
	379	iter->err = ret;
	380	ret = bootflow_scan_next(iter, bflow);
	381	if (ret)
	382	return log_msg_ret("get", ret);
	383	}
	384
	385	return 0;
	386	}
	387
a8f5be17 SG	388	int bootflow_scan_next(struct bootflow_iter iter, struct bootflow bflow)
	389	{
	390	int ret;
	391
	392	do {
	393	ret = iter_incr(iter);
f738c73a	394	log_debug("iter_incr: ret=%d\n", ret);
a8f5be17 SG	395	if (ret == BF_NO_MORE_DEVICES)
	396	return log_msg_ret("done", ret);
	397
	398	if (!ret) {
	399	ret = bootflow_check(iter, bflow);
f738c73a	400	log_debug("check - ret=%d\n", ret);
a8f5be17 SG	401	if (!ret)
	402	return 0;
	403	iter->err = ret;
	404	if (ret != BF_NO_MORE_PARTS && ret != -ENOSYS) {
	405	if (iter->flags & BOOTFLOWF_ALL)
	406	return log_msg_ret("all", ret);
	407	}
	408	} else {
f738c73a	409	log_debug("incr failed, err=%d\n", ret);
a8f5be17 SG	410	iter->err = ret;
	411	}
	412
	413	} while (1);
	414	}
	415
b190deb8 SG	416	void bootflow_init(struct bootflow bflow, struct udevice bootdev,
	417	struct udevice *meth)
	418	{
	419	memset(bflow, '\0', sizeof(*bflow));
	420	bflow->dev = bootdev;
	421	bflow->method = meth;
	422	bflow->state = BOOTFLOWST_BASE;
	423	}
	424
a8f5be17 SG	425	void bootflow_free(struct bootflow *bflow)
	426	{
	427	free(bflow->name);
	428	free(bflow->subdir);
	429	free(bflow->fname);
	430	free(bflow->buf);
2175e76a	431	free(bflow->os_name);
7638c851	432	free(bflow->fdt_fname);
a8f5be17 SG	433	}
	434
	435	void bootflow_remove(struct bootflow *bflow)
	436	{
eccb25cd SG	437	if (bflow->dev)
eccb25cd SG	438	list_del(&bflow->bm_node);
a8f5be17 SG	439	list_del(&bflow->glob_node);
	440
	441	bootflow_free(bflow);
	442	free(bflow);
	443	}
	444
	445	int bootflow_boot(struct bootflow *bflow)
	446	{
	447	int ret;
	448
	449	if (bflow->state != BOOTFLOWST_READY)
	450	return log_msg_ret("load", -EPROTO);
	451
	452	ret = bootmeth_boot(bflow->method, bflow);
	453	if (ret)
	454	return log_msg_ret("boot", ret);
	455
	456	/*
	457	* internal error, should not get here since we should have booted
	458	* something or returned an error
	459	*/
	460
	461	return log_msg_ret("end", -EFAULT);
	462	}
	463
	464	int bootflow_run_boot(struct bootflow_iter iter, struct bootflow bflow)
	465	{
	466	int ret;
	467
	468	printf("** Booting bootflow '%s' with %s\n", bflow->name,
	469	bflow->method->name);
	470	ret = bootflow_boot(bflow);
	471	if (!IS_ENABLED(CONFIG_BOOTSTD_FULL)) {
	472	printf("Boot failed (err=%d)\n", ret);
	473	return ret;
	474	}
	475
	476	switch (ret) {
	477	case -EPROTO:
	478	printf("Bootflow not loaded (state '%s')\n",
	479	bootflow_state_get_name(bflow->state));
	480	break;
	481	case -ENOSYS:
	482	printf("Boot method '%s' not supported\n", bflow->method->name);
	483	break;
	484	case -ENOTSUPP:
	485	/* Disable this bootflow for this iteration */
	486	if (iter) {
	487	int ret2;
	488
	489	ret2 = bootflow_iter_drop_bootmeth(iter, bflow->method);
	490	if (!ret2) {
	491	printf("Boot method '%s' failed and will not be retried\n",
	492	bflow->method->name);
	493	}
	494	}
	495
	496	break;
	497	default:
	498	printf("Boot failed (err=%d)\n", ret);
	499	break;
	500	}
	501
	502	return ret;
503	}
504
865328c3	505	int bootflow_iter_check_blk(const struct bootflow_iter *iter)
a8f5be17 SG	506	{
	507	const struct udevice *media = dev_get_parent(iter->dev);
	508	enum uclass_id id = device_get_uclass_id(media);
	509
	510	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	511	if (id != UCLASS_ETH && id != UCLASS_BOOTSTD)
	512	return 0;
	513
	514	return -ENOTSUPP;
	515	}
	516
0c1f4a9f SG	517	int bootflow_iter_check_sf(const struct bootflow_iter *iter)
	518	{
	519	const struct udevice *media = dev_get_parent(iter->dev);
	520	enum uclass_id id = device_get_uclass_id(media);
	521
	522	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	523	if (id == UCLASS_SPI_FLASH)
	524	return 0;
	525
	526	return -ENOTSUPP;
	527	}
	528
865328c3	529	int bootflow_iter_check_net(const struct bootflow_iter *iter)
a8f5be17 SG	530	{
	531	const struct udevice *media = dev_get_parent(iter->dev);
	532	enum uclass_id id = device_get_uclass_id(media);
	533
	534	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	535	if (id == UCLASS_ETH)
	536	return 0;
	537
	538	return -ENOTSUPP;
	539	}
	540
865328c3	541	int bootflow_iter_check_system(const struct bootflow_iter *iter)
a8f5be17 SG	542	{
	543	const struct udevice *media = dev_get_parent(iter->dev);
	544	enum uclass_id id = device_get_uclass_id(media);
	545
	546	log_debug("uclass %d: %s\n", id, uclass_get_name(id));
	547	if (id == UCLASS_BOOTSTD)
	548	return 0;
	549
	550	return -ENOTSUPP;
	551	}