u-boot/lib/efi_client/efi_app_init.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * EFI-app board implementation
 *
 * Copyright 2023 Google LLC
 * Written by Simon Glass <sjg@chromium.org>
 */

#include <dm.h>
#include <efi.h>
#include <efi_api.h>
#include <efi_tcg2.h>
#include <errno.h>
#include <malloc.h>
#include <asm/global_data.h>
#include <dm/device-internal.h>
#include <dm/root.h>
#include <linux/types.h>

DECLARE_GLOBAL_DATA_PTR;

static size_t device_path_length(const struct efi_device_path *device_path)
{
	const struct efi_device_path *d;

	for (d = device_path; d->type != DEVICE_PATH_TYPE_END; d = (void *)d + d->length) {
	}
	return (void *)d - (void *)device_path + d->length;
}

/**
 * efi_bind_block() - bind a new block device to an EFI device
 *
 * Binds a new top-level EFI_MEDIA device as well as a child block device so
 * that the block device can be accessed in U-Boot.
 *
 * The device can then be accessed using 'part list efi 0', 'fat ls efi 0:1',
 * for example, just like any other interface type.
 *
 * @handle: handle of the controller on which this driver is installed
 * @blkio: block io protocol proxied by this driver
 * @device_path: EFI device path structure for this
 * @len: Length of @device_path in bytes
 * @devp: Returns the bound device
 * Return: 0 if OK, -ve on error
 */
int efi_bind_block(efi_handle_t handle, struct efi_block_io *blkio,
		   struct efi_device_path *device_path, int len,
		   struct udevice **devp)
{
	struct efi_media_plat *plat;
	struct udevice *dev;
	char name[18], *str;
	int ret;
	size_t device_path_len = device_path_length(device_path);

	plat = malloc(sizeof(struct efi_media_plat));
	if (!plat)
		return log_msg_ret("plat", -ENOMEM);
	plat->handle = handle;
	plat->blkio = blkio;
	plat->device_path = malloc(device_path_len);
	if (!plat->device_path) {
		free(plat);
		return log_msg_ret("path", -ENOMEM);
	}
	memcpy(plat->device_path, device_path, device_path_len);

	snprintf(name, sizeof(name), "efi_media_%x",
		 uclass_id_count(UCLASS_EFI_MEDIA));
	str = strdup(name);
	if (!str)
		return -ENOMEM;

	ret = device_bind(dm_root(), DM_DRIVER_GET(efi_media), str, plat,
			  ofnode_null(), &dev);
	if (ret) {
		free(str);
		return log_msg_ret("bind", ret);
	}
	device_set_name_alloced(dev);
	*devp = dev;

	return 0;
}

/**
 * devpath_is_partition() - Figure out if a device path is a partition
 *
 * Checks if a device path refers to a partition on some media device. This
 * works by checking for a valid partition number in a hard-driver media device
 * as the final component of the device path.
 *
 * @path:	device path
 * Return:	true if a partition, false if not
 *		(e.g. it might be media which contains partitions)
 */
static bool devpath_is_partition(const struct efi_device_path *path)
{
	const struct efi_device_path *p;
	bool was_part = false;

	for (p = path; p->type != DEVICE_PATH_TYPE_END;
	     p = (void *)p + p->length) {
		was_part = false;
		if (p->type == DEVICE_PATH_TYPE_MEDIA_DEVICE &&
		    p->sub_type == DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH) {
			struct efi_device_path_hard_drive_path *hd =
				(void *)path;

			if (hd->partition_number)
				was_part = true;
		}
	}

	return was_part;
}

/**
 * setup_block() - Find all block devices and setup EFI devices for them
 *
 * Partitions are ignored, since U-Boot has partition handling. Errors with
 * particular devices produce a warning but execution continues to try to
 * find others.
 *
 * Return: 0 if found, -ENOSYS if there is no boot-services table, -ENOTSUPP
 *	if a required protocol is not supported
 */
static int setup_block(void)
{
	efi_guid_t efi_blkio_guid = EFI_BLOCK_IO_PROTOCOL_GUID;
	efi_guid_t efi_devpath_guid = EFI_DEVICE_PATH_PROTOCOL_GUID;
	efi_guid_t efi_pathutil_guid = EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID;
	efi_guid_t efi_pathtext_guid = EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID;
	struct efi_boot_services *boot = efi_get_boot();
	struct efi_device_path_utilities_protocol *util;
	struct efi_device_path_to_text_protocol *text;
	struct efi_device_path *path;
	struct efi_block_io *blkio;
	int num_disks, num_parts;
	efi_uintn_t num_handles;
	efi_handle_t *handle;
	int ret, i;

	if (!boot)
		return log_msg_ret("sys", -ENOSYS);

	/* Find all devices which support the block I/O protocol */
	ret = boot->locate_handle_buffer(BY_PROTOCOL, &efi_blkio_guid, NULL,
				  &num_handles, &handle);
	if (ret)
		return log_msg_ret("loc", -ENOTSUPP);
	log_debug("Found %d handles:\n", (int)num_handles);

	/* We need to look up the path size and convert it to text */
	ret = boot->locate_protocol(&efi_pathutil_guid, NULL, (void **)&util);
	if (ret)
		return log_msg_ret("util", -ENOTSUPP);
	ret = boot->locate_protocol(&efi_pathtext_guid, NULL, (void **)&text);
	if (ret)
		return log_msg_ret("text", -ENOTSUPP);

	for (num_disks = 0, num_parts = 0, i = 0; i < num_handles; i++) {
		struct udevice *dev;
		const u16 *name;
		bool is_part;
		int len;

		ret = boot->handle_protocol(handle[i], &efi_devpath_guid,
					    (void **)&path);
		if (ret) {
			log_warning("- devpath %d failed (ret=%d)\n", i, ret);
			continue;
		}

		ret = boot->handle_protocol(handle[i], &efi_blkio_guid,
					    (void **)&blkio);
		if (ret) {
			log_warning("- blkio %d failed (ret=%d)\n", i, ret);
			continue;
		}

		name = text->convert_device_path_to_text(path, true, false);
		is_part = devpath_is_partition(path);

		if (!is_part) {
			num_disks++;
			len = util->get_device_path_size(path);
			ret = efi_bind_block(handle[i], blkio, path, len, &dev);
			if (ret) {
				log_warning("- blkio bind %d failed (ret=%d)\n",
					    i, ret);
				continue;
			}
		} else {
			dev = NULL;
			num_parts++;
		}

		/*
		 * Show the device name if we created one. Otherwise indicate
		 * that it is a partition.
		 */
		log_debug("%2d: %-12s %ls\n", i,
			  dev ? dev->name : "<partition>", name);
	}
	if (!gd_ulib())
		log_info("EFI:   disks %d, partitions %d\n", num_disks,
			 num_parts);
	boot->free_pool(handle);

	return 0;
}

/**
 * setup_net() - Find all network devices and setup EFI devices for them
 *
 * Return: 0 if found, -ENOSYS if there is no boot-services table, -ENOTSUPP
 *	if a required protocol is not supported
 */
static int setup_net(void)
{
	efi_guid_t efi_snp_guid = EFI_SIMPLE_NETWORK_PROTOCOL_GUID;
	struct efi_boot_services *boot = efi_get_boot();
	efi_uintn_t num_handles;
	efi_handle_t *handle;
	int ret, i;

	if (!boot)
		return log_msg_ret("sys", -ENOSYS);

	/* Find all devices which support the simple network protocol */
	ret = boot->locate_handle_buffer(BY_PROTOCOL, &efi_snp_guid, NULL,
				  &num_handles, &handle);

	if (ret)
		return 0;
	log_debug("Found %d net handles:\n", (int)num_handles);

	for (i = 0; i < num_handles; i++) {
		struct efi_simple_network *snp;
		struct efi_net_plat *plat;
		struct udevice *dev;
		char name[18];

		ret = boot->handle_protocol(handle[i], &efi_snp_guid,
					    (void **)&snp);

		if (ret != EFI_SUCCESS) {
			log_warning("- snp %d failed (ret=0x%x\n", i, ret);
			continue;
		}

		plat = malloc(sizeof(*plat));
		if (!plat) {
			log_warning("- snp %d failed to alloc platform data", i);
			continue;
		}
		plat->handle = handle[i];
		plat->snp = snp;
		ret = device_bind(dm_root(), DM_DRIVER_GET(efi_net), "efi_net",
				  plat, ofnode_null(), &dev);
		if (ret) {
			log_warning("- bind snp %d failed (ret=0x%x)\n", i,
				    ret);
			continue;
		}

		snprintf(name, sizeof(name), "efi_net_%x", dev_seq(dev));
		device_set_name(dev, name);

		printf("%2d: %-12s\n", i, dev->name);
	}
	boot->free_pool(handle);

	return 0;
}

/**
 * setup_tpm() - Find all TPMs and setup EFI devices for them
 *
 * Return: 0 if found, -ENOSYS if there is no boot-services table, -ENOTSUPP
 *	if a required protocol is not supported
 */
static int setup_tpm(void)
{
	efi_guid_t efi_tcg2_guid = EFI_TCG2_PROTOCOL_GUID;
	struct efi_boot_services *boot = efi_get_boot();
	efi_uintn_t num_handles;
	efi_handle_t *handle;
	int ret, i;

	if (!boot)
		return log_msg_ret("sys", -ENOSYS);

	/* Find all devices which support the TCG2 protocol */
	ret = boot->locate_handle_buffer(BY_PROTOCOL, &efi_tcg2_guid, NULL,
				  &num_handles, &handle);

	if (ret)
		return 0;
	log_debug("Found %d TPM handles:\n", (int)num_handles);

	for (i = 0; i < num_handles; i++) {
		struct efi_tcg2_protocol *proto;
		struct efi_tpm_plat *plat;
		struct udevice *dev;
		char name[18];

		ret = boot->handle_protocol(handle[i], &efi_tcg2_guid,
					    (void **)&proto);

		if (ret != EFI_SUCCESS) {
			log_warning("- TPM %d failed (ret=0x%x)\n", i, ret);
			continue;
		}

		plat = malloc(sizeof(*plat));
		if (!plat) {
			log_warning("- TPM %d failed to alloc platform data", i);
			continue;
		}

		plat->handle = handle[i];
		plat->proto = proto;
		ret = device_bind(dm_root(), DM_DRIVER_GET(efi_tpm), "efi_tpm",
				  plat, ofnode_null(), &dev);
		if (ret) {
			log_warning("- bind TPM %d failed (ret=0x%x)\n", i,
				    ret);
			continue;
		}

		snprintf(name, sizeof(name), "efi_tpm_%x", dev_seq(dev));
		device_set_name(dev, name);

		printf("%2d: %-12s\n", i, dev->name);
	}
	boot->free_pool(handle);

	return 0;
}

/**
 * board_early_init_r() - Scan for UEFI devices that should be available
 *
 * This sets up block devices within U-Boot for those found in UEFI. With this,
 * U-Boot can access those devices
 *
 * Returns: 0 on success, -ve on error
 */
int board_early_init_r(void)
{
	if (gd->flags & GD_FLG_RELOC) {
		int ret;

		ret = setup_block();
		if (ret)
			return ret;
		if (IS_ENABLED(CONFIG_NET)) {
			ret = setup_net();
			if (ret)
				return ret;
		}
		if (IS_ENABLED(CONFIG_TPM)) {
			ret = setup_tpm();
			if (ret)
				return ret;
		}
	}

	return 0;
}