[thirdparty/u-boot.git] / net / eth_bootdev.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Bootdev for ethernet (uses PXE)
 *
 * Copyright 2021 Google LLC
 * Written by Simon Glass <sjg@chromium.org>
 */

#define LOG_CATEGORY UCLASS_BOOTSTD

#include <common.h>
#include <bootdev.h>
#include <bootflow.h>
#include <command.h>
#include <bootmeth.h>
#include <dm.h>
#include <extlinux.h>
#include <init.h>
#include <log.h>
#include <net.h>
#include <test/test.h>

static int eth_get_bootflow(struct udevice *dev, struct bootflow_iter *iter,
			    struct bootflow *bflow)
{
	char name[60];
	int ret;

	/* Must be an Ethernet device */
	ret = bootflow_iter_check_net(iter);
	if (ret)
		return log_msg_ret("net", ret);

	ret = bootmeth_check(bflow->method, iter);
	if (ret)
		return log_msg_ret("check", ret);

	/*
	 * Like extlinux boot, this assumes there is only one Ethernet device.
	 * In this case, that means that @eth is ignored
	 */

	snprintf(name, sizeof(name), "%s.%d", dev->name, iter->part);
	bflow->name = strdup(name);
	if (!bflow->name)
		return log_msg_ret("name", -ENOMEM);

	/* See distro_pxe_read_bootflow() for the standard impl of this */
	log_debug("dhcp complete - reading bootflow with method '%s'\n",
		  bflow->method->name);
	ret = bootmeth_read_bootflow(bflow->method, bflow);
	log_debug("reading bootflow returned %d\n", ret);
	if (ret)
		return log_msg_ret("method", ret);

	return 0;
}

static int eth_bootdev_bind(struct udevice *dev)
{
	struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);

	ucp->prio = BOOTDEVP_6_NET_BASE;

	return 0;
}

static int eth_bootdev_hunt(struct bootdev_hunter *info, bool show)
{
	int ret;

	if (!test_eth_enabled())
		return 0;

	/* init PCI first since this is often used to provide Ehternet */
	if (IS_ENABLED(CONFIG_PCI)) {
		ret = pci_init();
		if (ret)
			log_warning("Failed to init PCI (%dE)\n", ret);
	}

	/*
	 * Ethernet devices can also come from USB, but that is a higher
	 * priority (BOOTDEVP_5_SCAN_SLOW) than ethernet, so it should have been
	 * enumerated already. If something like 'bootflow scan dhcp' is used
	 * then the user will need to run 'usb start' first.
	 */
	if (IS_ENABLED(CONFIG_CMD_DHCP)) {
		ret = dhcp_run(0, NULL, false);
		if (ret)
			return -EINVAL;
	}

	return 0;
}

struct bootdev_ops eth_bootdev_ops = {
	.get_bootflow	= eth_get_bootflow,
};

static const struct udevice_id eth_bootdev_ids[] = {
	{ .compatible = "u-boot,bootdev-eth" },
	{ }
};

U_BOOT_DRIVER(eth_bootdev) = {
	.name		= "eth_bootdev",
	.id		= UCLASS_BOOTDEV,
	.ops		= &eth_bootdev_ops,
	.bind		= eth_bootdev_bind,
	.of_match	= eth_bootdev_ids,
};

BOOTDEV_HUNTER(eth_bootdev_hunt) = {
	.prio		= BOOTDEVP_6_NET_BASE,
	.uclass		= UCLASS_ETH,
	.hunt		= eth_bootdev_hunt,
	.drv		= DM_DRIVER_REF(eth_bootdev),
};
Commit	Line	Data
4fd8d077 SG	1	// SPDX-License-Identifier: GPL-2.0+
4fd8d077 SG	2	/*
4de979f6	3	* Bootdev for ethernet (uses PXE)
4fd8d077 SG	4	*
	5	* Copyright 2021 Google LLC
	6	* Written by Simon Glass <sjg@chromium.org>
	7	*/
	8
4146c823 SG	9	#define LOG_CATEGORY UCLASS_BOOTSTD
4146c823 SG	10
4fd8d077 SG	11	#include <common.h>
	12	#include <bootdev.h>
	13	#include <bootflow.h>
	14	#include <command.h>
	15	#include <bootmeth.h>
4fd8d077	16	#include <dm.h>
79f66351	17	#include <extlinux.h>
4146c823	18	#include <init.h>
4fd8d077 SG	19	#include <log.h>
4fd8d077 SG	20	#include <net.h>
4146c823	21	#include <test/test.h>
4fd8d077 SG	22
	23	static int eth_get_bootflow(struct udevice dev, struct bootflow_iter iter,
	24	struct bootflow *bflow)
	25	{
	26	char name[60];
	27	int ret;
	28
	29	/* Must be an Ethernet device */
865328c3	30	ret = bootflow_iter_check_net(iter);
4fd8d077 SG	31	if (ret)
	32	return log_msg_ret("net", ret);
	33
	34	ret = bootmeth_check(bflow->method, iter);
	35	if (ret)
	36	return log_msg_ret("check", ret);
	37
	38	/*
79f66351	39	* Like extlinux boot, this assumes there is only one Ethernet device.
4fd8d077 SG	40	* In this case, that means that @eth is ignored
	41	*/
	42
	43	snprintf(name, sizeof(name), "%s.%d", dev->name, iter->part);
	44	bflow->name = strdup(name);
	45	if (!bflow->name)
	46	return log_msg_ret("name", -ENOMEM);
	47
4fd8d077	48	/* See distro_pxe_read_bootflow() for the standard impl of this */
4146c823	49	log_debug("dhcp complete - reading bootflow with method '%s'\n",
4fd8d077 SG	50	bflow->method->name);
	51	ret = bootmeth_read_bootflow(bflow->method, bflow);
	52	log_debug("reading bootflow returned %d\n", ret);
	53	if (ret)
	54	return log_msg_ret("method", ret);
	55
	56	return 0;
	57	}
	58
	59	static int eth_bootdev_bind(struct udevice *dev)
	60	{
	61	struct bootdev_uc_plat *ucp = dev_get_uclass_plat(dev);
	62
eacc2611	63	ucp->prio = BOOTDEVP_6_NET_BASE;
4fd8d077 SG	64
	65	return 0;
	66	}
	67
4146c823 SG	68	static int eth_bootdev_hunt(struct bootdev_hunter *info, bool show)
	69	{
	70	int ret;
	71
	72	if (!test_eth_enabled())
	73	return 0;
	74
	75	/* init PCI first since this is often used to provide Ehternet */
	76	if (IS_ENABLED(CONFIG_PCI)) {
	77	ret = pci_init();
	78	if (ret)
	79	log_warning("Failed to init PCI (%dE)\n", ret);
	80	}
	81
	82	/*
	83	* Ethernet devices can also come from USB, but that is a higher
	84	* priority (BOOTDEVP_5_SCAN_SLOW) than ethernet, so it should have been
	85	* enumerated already. If something like 'bootflow scan dhcp' is used
	86	* then the user will need to run 'usb start' first.
	87	*/
	88	if (IS_ENABLED(CONFIG_CMD_DHCP)) {
	89	ret = dhcp_run(0, NULL, false);
	90	if (ret)
	91	return -EINVAL;
	92	}
	93
	94	return 0;
	95	}
	96
4fd8d077 SG	97	struct bootdev_ops eth_bootdev_ops = {
	98	.get_bootflow = eth_get_bootflow,
	99	};
	100
	101	static const struct udevice_id eth_bootdev_ids[] = {
	102	{ .compatible = "u-boot,bootdev-eth" },
	103	{ }
	104	};
	105
	106	U_BOOT_DRIVER(eth_bootdev) = {
	107	.name = "eth_bootdev",
	108	.id = UCLASS_BOOTDEV,
	109	.ops = &eth_bootdev_ops,
	110	.bind = eth_bootdev_bind,
	111	.of_match = eth_bootdev_ids,
	112	};
4146c823 SG	113
4146c823 SG	114	BOOTDEV_HUNTER(eth_bootdev_hunt) = {
eacc2611	115	.prio = BOOTDEVP_6_NET_BASE,
4146c823 SG	116	.uclass = UCLASS_ETH,
	117	.hunt = eth_bootdev_hunt,
	118	.drv = DM_DRIVER_REF(eth_bootdev),
	119	};