From patchwork Thu Mar 24 13:54:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 553919 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:1248:0:0:0:0 with SMTP id z8csp4439120mag; Thu, 24 Mar 2022 06:56:32 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyR52fBsdO2TqS1pyBAMKDOj2dX4DYpLgh4bOMDIiVOaMeFrYIAoBVwRPozY/dINIW4xIjr X-Received: by 2002:a17:906:a1c2:b0:6d6:d54d:4fb1 with SMTP id bx2-20020a170906a1c200b006d6d54d4fb1mr6019478ejb.490.1648130191961; Thu, 24 Mar 2022 06:56:31 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1648130191; cv=none; d=google.com; s=arc-20160816; b=R651y0KY8WbNedTS4JPILyByEWQ+2KmiRO0sNsYGsL1/BrhSD+yTPlu5wICQFZCaiz hazzd61IYD0YQupeW9tyk/b4aQeyO9ldEmoGFQRZ/bEb/KnosPkZKB0xUwRmTSJ7wl1a JaVqC3AD0nONk+0CBTCKFhkaxSMm/+zTfe3aIqAZDHy/NH6FXlwWooAESYRpLieQzU2K 1S8tn5MVNMXq+qwvDVb3NYN8YSsBSzGcp22Tc7SWmvgqnXP0t1dDEu6UEVv9DWZ6fQYw B/+/BOrfTPxU3vXJy63IPRi3p76zHWG425yLgLmb0w2FtOoGMtxnr8H1mwD9AMSMGqvO EQJQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=pFOOErQDOBkVcMwyhyfisM8W5vYktBskj+N5U35cHwM=; b=buE6G+FA+NTWZARCF28r8sXyMbCXa9eYm8HKa/4wrmvI8RoVflePCygCPXZrkyu63u xgQuHpjNP6IgWJdJF+KO9U4SR/XfHLKTjSPid7FH+1v6o6WneZZNDGR4x2KyoZmKxVeV zciWRL6SlppouXir8VWEQzXKmbZh+3PwLFYj05mKK/EO4JXarIuxaEnvSchVwpa7Zlt3 vp2sBgGRqowMuuWvRk4DtbuRHRz60GQ9U7lNLi5IY1qDfjfLXi6/i2K0OcBOrB7WVaDf zbakVMyrV2XGTlouqIvaWOOzkLtRNORS/l3oeYyium0q8AaXOMSsfGo4qPnqYHms7rgd zP5w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=SOpWq3jv; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from phobos.denx.de (phobos.denx.de. [85.214.62.61]) by mx.google.com with ESMTPS id og10-20020a1709071dca00b006df76385df5si14858029ejc.661.2022.03.24.06.56.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 24 Mar 2022 06:56:31 -0700 (PDT) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) client-ip=85.214.62.61; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=SOpWq3jv; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 27541840D8; Thu, 24 Mar 2022 14:55:28 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="SOpWq3jv"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 0E5D4840C3; Thu, 24 Mar 2022 14:55:15 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-pg1-x530.google.com (mail-pg1-x530.google.com [IPv6:2607:f8b0:4864:20::530]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id ED4A8840C6 for ; Thu, 24 Mar 2022 14:55:09 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=masahisa.kojima@linaro.org Received: by mail-pg1-x530.google.com with SMTP id k14so3919771pga.0 for ; Thu, 24 Mar 2022 06:55:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=pFOOErQDOBkVcMwyhyfisM8W5vYktBskj+N5U35cHwM=; b=SOpWq3jvrSFrQ9jWjPWkShYVWcqpHpBw846ncpJ8AOdL9tvm5HsrGiIRyMZd1xjfYz bgljbl3EUAK//udTHsppeIjIO2i3g9U6sbNHv/G2ynyeQvvBbJCpJXcCWuaMpq4hTJTF sVtcJiwq5IxK4cIkcuzEh+ryt2LoJztqGK0NZG4VKE8j6dl4yiQv+v9IVxAa5ktEDVAk O0zqblv1mjlsK/M7fpBUpzjfYkPBZb69oa0PURpPZWvRm7mQSMy4gxF2e0AH7MIFeczS IHq+USqtIR6U0WTSBoQF/7GtRIWh5zhyr+aXQlWSC1GvMGh8C9Z1vGx5SwNzXArz/gFi bflQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=pFOOErQDOBkVcMwyhyfisM8W5vYktBskj+N5U35cHwM=; b=2bLuaeWKTGNnXIqNB3QSZxHUDOvgX++eigwKLZLIAdpV2/oA9mIWC/nX0Bj+Fr06fM qaAMTrFPYEJ0KttX34idKG0XRsdqcnJIkYunhD2IaFmwk4yApZp1YfO07vrFVn7t03wR OX5IXGVeG2zvoVBzXaJZcPqKN1G4CIB96oNtTDU3pi3swC6TAG03dhRUTUlYrqyT21d0 Ia56y1fAQB4Oo8B5AmFrxacAolFC33TtC8muZ4ql7F2vyXA4F1iiXck004n4qsiwLFxN jXsNG1y/6b5vLKSM2sO39CqX9jVyLWQ7HZt8Z4LAjXQyrZ7SQiaFZS1FSUt/LxjJjSgJ xoyw== X-Gm-Message-State: AOAM530NJpYTolg5Y1WIawzo4DDM0IOYthxVeW7P7l+GTQeXUZVd6k11 mQ7VOTZ+J8XDFt51aa74mOLU1AmTIQQtSw== X-Received: by 2002:aa7:92cf:0:b0:4fa:3b47:7408 with SMTP id k15-20020aa792cf000000b004fa3b477408mr5460281pfa.72.1648130108100; Thu, 24 Mar 2022 06:55:08 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id p15-20020a056a000a0f00b004f7c63cba5asm3974609pfh.21.2022.03.24.06.55.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 24 Mar 2022 06:55:07 -0700 (PDT) From: Masahisa Kojima To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Takahiro Akashi , Francois Ozog , Mark Kettenis , Masahisa Kojima Subject: [PATCH v4 10/11] bootmenu: add removable media entries Date: Thu, 24 Mar 2022 22:54:42 +0900 Message-Id: <20220324135443.1571-11-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220324135443.1571-1-masahisa.kojima@linaro.org> References: <20220324135443.1571-1-masahisa.kojima@linaro.org> X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.5 at phobos.denx.de X-Virus-Status: Clean UEFI specification requires booting from removal media using a architecture-specific default image name such as BOOTAA64.EFI. This commit adds the removable media entries into bootmenu, so that user can select the removable media and boot with default image. The bootmenu automatically enumerates the possible bootable media devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, add it as new UEFI boot option(BOOT####) and update BootOrder variable. Depending on the system hardware setup, some devices may not exist at a later system boot, so invalid BOOT#### variable must be deleted. Signed-off-by: Masahisa Kojima --- Newly created in v4 cmd/bootmenu.c | 78 +++++++++++++ include/efi_loader.h | 22 ++++ lib/efi_loader/efi_bootmenu_maintenance.c | 128 ++++++++++++++++++++++ 3 files changed, 228 insertions(+) diff --git a/cmd/bootmenu.c b/cmd/bootmenu.c index 458eb90b63..7357cfeae5 100644 --- a/cmd/bootmenu.c +++ b/cmd/bootmenu.c @@ -304,6 +304,74 @@ static int prepare_uefi_bootorder_entry(struct bootmenu_data *menu, return 1; } +static efi_status_t prepare_media_device_entry(void) +{ + u32 i; + efi_status_t ret; + efi_uintn_t count; + efi_handle_t *volume_handles = NULL; + struct efi_bootmenu_media_boot_option *opt = NULL; + + ret = efi_locate_handle_buffer_int(BY_PROTOCOL, &efi_simple_file_system_protocol_guid, + NULL, &count, (efi_handle_t **)&volume_handles); + if (ret != EFI_SUCCESS) + return ret; + + opt = calloc(count, sizeof(struct efi_bootmenu_media_boot_option)); + if (!opt) + goto out; + + /* enumerate all devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL */ + ret = efi_bootmenu_enumerate_boot_option(opt, volume_handles, count); + if (ret != EFI_SUCCESS) + goto out; + + /* + * System hardware configuration may vary depending on the user setup. + * The boot option is automatically added by the bootmenu. + * If the device is not attached to the system, the boot option needs + * to be deleted. + */ + ret = efi_bootmenu_delete_invalid_boot_option(opt, count); + if (ret != EFI_SUCCESS) + goto out; + + /* add non-existent boot option */ + for (i = 0; i < count; i++) { + u32 boot_index; + u16 var_name[9]; + + if (!opt[i].exist) { + ret = efi_bootmenu_get_unused_bootoption(var_name, sizeof(var_name), + &boot_index); + if (ret != EFI_SUCCESS) + goto out; + + ret = efi_set_variable_int(var_name, &efi_global_variable_guid, + EFI_VARIABLE_NON_VOLATILE | + EFI_VARIABLE_BOOTSERVICE_ACCESS | + EFI_VARIABLE_RUNTIME_ACCESS, + opt[i].size, opt[i].lo, false); + if (ret != EFI_SUCCESS) + goto out; + + ret = efi_bootmenu_append_bootorder(boot_index); + if (ret != EFI_SUCCESS) + goto out; + } + } + +out: + if (opt) { + for (i = 0; i < count; i++) + free(opt[i].lo); + } + free(opt); + efi_free_pool(volume_handles); + + return ret; +} + static int prepare_distro_boot_entry(struct bootmenu_data *menu, struct bootmenu_entry **current, unsigned short int *index) @@ -408,6 +476,16 @@ static struct bootmenu_data *bootmenu_create(int delay) goto cleanup; if (IS_ENABLED(CONFIG_CMD_BOOTEFI_BOOTMGR)) { + if (i < MAX_DYNAMIC_ENTRY) { + /* + * UEFI specification requires booting from removal media using + * a architecture-specific default image name such as BOOTAA64.EFI. + */ + ret = prepare_media_device_entry(); + if (ret != EFI_SUCCESS) + goto cleanup; + } + if (i < MAX_DYNAMIC_ENTRY) { ret = prepare_uefi_bootorder_entry(menu, &iter, &i); if (ret < 0 && ret != -ENOENT) diff --git a/include/efi_loader.h b/include/efi_loader.h index 7b100ca030..c326dfdaf2 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -926,6 +926,22 @@ struct efi_signature_store { struct x509_certificate; struct pkcs7_message; +/** + * struct efi_bootmenu_media_boot_option - boot option for (removable) media device + * + * This structure is used to enumerate possible boot option + * + * @lo: Serialized load option data + * @size: Size of serialized load option data + * @exist: Flag to indicate the load option already exists + * in Non-volatile load option + */ +struct efi_bootmenu_media_boot_option { + void *lo; + efi_uintn_t size; + bool exist; +}; + bool efi_signature_lookup_digest(struct efi_image_regions *regs, struct efi_signature_store *db, bool dbx); @@ -1038,6 +1054,12 @@ efi_status_t efi_console_get_u16_string efi_status_t efi_bootmenu_get_unused_bootoption(u16 *buf, efi_uintn_t buf_size, u32 *index); efi_status_t efi_bootmenu_append_bootorder(u16 index); +efi_status_t efi_bootmenu_enumerate_boot_option( + struct efi_bootmenu_media_boot_option *opt, + efi_handle_t *volume_handles, efi_status_t count); +efi_status_t efi_bootmenu_delete_invalid_boot_option( + struct efi_bootmenu_media_boot_option *opt, + efi_status_t count); efi_status_t efi_disk_get_device_name(struct efi_block_io *this, char *buf, int size); diff --git a/lib/efi_loader/efi_bootmenu_maintenance.c b/lib/efi_loader/efi_bootmenu_maintenance.c index 2ce5a47b10..3a64cf767a 100644 --- a/lib/efi_loader/efi_bootmenu_maintenance.c +++ b/lib/efi_loader/efi_bootmenu_maintenance.c @@ -24,6 +24,8 @@ static struct efi_simple_text_output_protocol *cout; #define EFI_BOOTMENU_FILE_PATH_MAX 512 #define EFI_BOOTMENU_BOOT_NAME_MAX 32 #define EFI_BOOT_ORDER_MAX_SIZE_IN_DECIMAL 6 +#define BOOTMENU_AUTO_ADD_OPTION_DATA "bootmenu" +#define BOOTMENU_AUTO_ADD_OPTION_DATA_U16 u"bootmenu" typedef efi_status_t (*efi_bootmenu_entry_func)(void *data, bool *exit); @@ -1114,3 +1116,129 @@ efi_status_t efi_bootmenu_show_maintenance_menu(void) ARRAY_SIZE(maintenance_menu_items), -1); } + +efi_status_t efi_bootmenu_enumerate_boot_option( + struct efi_bootmenu_media_boot_option *opt, + efi_handle_t *volume_handles, efi_status_t count) +{ + u32 i; + struct efi_handler *handler; + efi_status_t ret = EFI_SUCCESS; + + for (i = 0; i < count; i++) { + u16 *dev_name, *p; + struct efi_load_option lo; + struct efi_block_io *block_io; + char buf[BOOTMENU_DEVICE_NAME_MAX]; + struct efi_device_path *device_path; + + ret = efi_search_protocol(volume_handles[i], &efi_guid_device_path, &handler); + if (ret != EFI_SUCCESS) + continue; + ret = efi_protocol_open(handler, (void **)&device_path, + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) + continue; + + ret = efi_search_protocol(volume_handles[i], &efi_block_io_guid, &handler); + if (ret != EFI_SUCCESS) + continue; + ret = efi_protocol_open(handler, (void **)&block_io, + efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) + continue; + + efi_disk_get_device_name(block_io, buf, BOOTMENU_DEVICE_NAME_MAX); + dev_name = calloc(1, (strlen(buf) + 1) * sizeof(u16)); + if (!dev_name) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + p = dev_name; + utf8_utf16_strncpy(&p, buf, strlen(buf)); + + lo.label = dev_name; + lo.attributes = LOAD_OPTION_ACTIVE; + lo.file_path = device_path; + lo.file_path_length = efi_dp_size(device_path) + sizeof(END); + /* + * To identify the boot option that automatically added by + * the bootmenu, optional_data has special string. + * optional_data will be converted into u16 string + * in efi_serialize_load_option(). + */ + lo.optional_data = BOOTMENU_AUTO_ADD_OPTION_DATA; + opt[i].size = efi_serialize_load_option(&lo, (u8 **)&opt[i].lo); + if (!opt[i].size) { + ret = EFI_OUT_OF_RESOURCES; + free(dev_name); + goto out; + } + free(dev_name); + } + +out: + return ret; +} + +efi_status_t efi_bootmenu_delete_invalid_boot_option( + struct efi_bootmenu_media_boot_option *opt, + efi_status_t count) +{ + u16 *bootorder; + u32 i, j; + efi_status_t ret; + efi_uintn_t num, size, bootorder_size; + void *load_option; + struct efi_load_option lo; + u16 varname[] = u"Boot####"; + + bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &bootorder_size); + if (!bootorder) + return EFI_NOT_FOUND; + + num = bootorder_size / sizeof(u16); + for (i = 0; i < num;) { + efi_uintn_t tmp; + + efi_create_indexed_name(varname, sizeof(varname), + "Boot", bootorder[i]); + load_option = efi_get_var(varname, &efi_global_variable_guid, &size); + if (!load_option) + goto next; + + tmp = size; + ret = efi_deserialize_load_option(&lo, load_option, &tmp); + if (ret != EFI_SUCCESS) + goto next; + + if (u16_strncmp((u16 *)lo.optional_data, BOOTMENU_AUTO_ADD_OPTION_DATA_U16, + u16_strlen(BOOTMENU_AUTO_ADD_OPTION_DATA_U16)) == 0) { + for (j = 0; j < count; j++) { + if (memcmp(opt[j].lo, load_option, size) == 0) { + opt[j].exist = true; + break; + } + } + + if (j == count) { + ret = delete_boot_option(bootorder, i, bootorder_size); + if (ret != EFI_SUCCESS) { + free(load_option); + goto out; + } + + num--; + bootorder_size -= sizeof(u16); + free(load_option); + continue; + } + } +next: + free(load_option); + i++; + } + +out: + return ret; +}