From patchwork Fri Sep 2 14:23:44 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 602175 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:4388:0:0:0:0 with SMTP id w8csp1509313mae; Fri, 2 Sep 2022 07:23:10 -0700 (PDT) X-Google-Smtp-Source: AA6agR6s0mCddyUBORXxV+WLiNcdKzNtfqUTHXnPUWrMREyIKCseXkEi4rgQH8GINd/PCJ2d1kf0 X-Received: by 2002:a05:6402:5ca:b0:445:c80a:3c2 with SMTP id n10-20020a05640205ca00b00445c80a03c2mr33372344edx.247.1662128589996; Fri, 02 Sep 2022 07:23:09 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1662128589; cv=none; d=google.com; s=arc-20160816; b=czycNBW8LrI0ebR2zovUBkojr8CEGG6PE4g0C2gNbGazOndVdY/IK76pTkTga161ZI rzqG0X9FAFTzvfswdObq7+YFIIUykJC7I6GkycFJvr2OKKK2WNa3LOo089xmiL4BfBH/ Ldc6zPKhuj+7IoDZhco2TqQcqYuDqxwmpTMcjSA6Z3JJ9OoxBoRwH+8DAudFarZbrBrj ERQ31fvyyYvB2n0yzSs/x2blVhOpqJ5qh3hpA1h0OZ10w7LRFJ+jtADkzDDSXKbh+mRc urJk+N2txWoxsBQwsaSqtgbmUCXLk5KVt8a3womp51nzuIs0Ig+x+hm8Gz2fajZyI3Vm HMTQ== 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=7OaT4iXISa83wktJsG6FZpBYeCLd0as9Zt51OghLJNY=; b=iTAZruLRDjeFhrerMPkniAguwPzhwmz01rOTFDeQd5C5dpuBmKqpo3AxTTZprXzHmb Z7NG4qamJiU4quMRshtGDKmC9XrETpnZsjUNfKcAJxbUQT0oQe/b79sfjD71JPHvJBlg sZ30Fe+rsmLMJOb4yPJplih3Y63YcAEeXwCUOSaTZkhQhdXEx/1WeDt5xImh326TSv2p XDRMFHmJhnJZiv/6pyACKotHSCXq8bM2fkRaeLe0FNNr+16aP9z8kEKJLmv1j1wsygcD R5sp+G+Ria0vqq59QviBpGmF87tdvpxns1IYcoizAHu7Je8WjHNg33jheJ4A3vlYYVeP 89Yw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=osE92CUw; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 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. [2a01:238:438b:c500:173d:9f52:ddab:ee01]) by mx.google.com with ESMTPS id e14-20020a17090658ce00b0073d6c39d4bcsi2436948ejs.653.2022.09.02.07.23.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Sep 2022 07:23:09 -0700 (PDT) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=osE92CUw; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 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 106A984AF2; Fri, 2 Sep 2022 16:22:27 +0200 (CEST) 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="osE92CUw"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 6866084AF7; Fri, 2 Sep 2022 16:22:24 +0200 (CEST) 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-pl1-x635.google.com (mail-pl1-x635.google.com [IPv6:2607:f8b0:4864:20::635]) (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 8D6A684AD5 for ; Fri, 2 Sep 2022 16:22:20 +0200 (CEST) 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-pl1-x635.google.com with SMTP id j5so2026873plj.5 for ; Fri, 02 Sep 2022 07:22:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=references:in-reply-to:message-id:date:subject:cc:to:from:from:to :cc:subject:date; bh=7OaT4iXISa83wktJsG6FZpBYeCLd0as9Zt51OghLJNY=; b=osE92CUw9fOF3RIPvgtekF+zcSqRHn1Oc2WoiZ/inbCGpGm3p9fj2gIXLlcH4crhDu 8wmrsqn0yRsGQhzN6FQBkT1wINOssXI6YXseFRNo3NaYfnWH69k4tJIzCcP+O0qVmmHd SabL4kjOMK4HTR9EMCHP/m0xXl9H1XxJQ43YTbZKR0peuxdyKNa5kABH8edEYm0IUFbC RFjacHioNXXiNKqstcTZTm2+WwN84OjAsj/VXlOMXhGP8QKfW8UbDBUuk1iTz/7Co+IZ 07oc/ADQHe5bZ9Pdnde4TsMLzSOYHl4mETqsgzpO0h969UaYNOzUgz3cpoJssi08OSos 78wQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=references:in-reply-to:message-id:date:subject:cc:to:from :x-gm-message-state:from:to:cc:subject:date; bh=7OaT4iXISa83wktJsG6FZpBYeCLd0as9Zt51OghLJNY=; b=M5VetLVNDM9aKEECODZ2UHgb76VnX9uNtnfvmymeNDL9v4ZTz67h6OBL7aGH7v4ZPm STZ1t/8WNgCFwZBP+LAeUul7HsZlMvNpSjtdlKZ2AgIhtF2urcDHmkP5/T+WYg077H2r gXqyzECCsjN7HJU9KO7dZdXSJ+kWlHRpZXA5NGLhd5nQUcb0UF60rJTijerWF3xpjxUq vJTx8zF7h7EmDUu5F+ONTUUtBm68gm9EyiEp7w7SfC5IfxfBw0SLCUPs1BMtvlDVVPUs 2FZPN6MZVdr+5KlE3+dyAnSutTXPTD0ygdlqK119jqd9qnTBcyLWBgSK8ked8QqKSZbP wH/g== X-Gm-Message-State: ACgBeo3gOi8KNa9gZBjTAEO78j71NPBc+2Qd+ma0PEsybE0YEtpNnZcF Rw331Yv8d/zV8OzJPlYxKBq56SxhVlsEyQ== X-Received: by 2002:a17:90b:3b8d:b0:1fe:1fbe:b043 with SMTP id pc13-20020a17090b3b8d00b001fe1fbeb043mr5293021pjb.63.1662128538477; Fri, 02 Sep 2022 07:22:18 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id i8-20020a17090332c800b0017272667a56sm1678485plr.196.2022.09.02.07.22.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Sep 2022 07:22:18 -0700 (PDT) From: Masahisa Kojima To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Takahiro Akashi , Mark Kettenis , Masahisa Kojima Subject: [PATCH v15 05/10] bootmenu: add removable media entries Date: Fri, 2 Sep 2022 23:23:44 +0900 Message-Id: <20220902142349.16722-6-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220902142349.16722-1-masahisa.kojima@linaro.org> References: <20220902142349.16722-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.6 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. This automatically generated UEFI boot option has the dedicated guid in the optional_data to distinguish it from the UEFI boot option user adds manually. This optional_data is removed when the efi bootmgr loads the selected UEFI boot option. This commit also provides the BOOT#### variable maintenance feature. Depending on the system hardware setup, some devices may not exist at a later system boot, so bootmenu checks the available device in each bootmenu invocation and automatically removes the BOOT#### variable corrensponding to the non-existent media device. Signed-off-by: Masahisa Kojima --- No update since v14 Changes in v14: - remove invalid free() call Changes in v13: - remove BootOrder variable dependency Changes in v12: - move generate_media_device_boot_option into cmd/eficonfig.c and expose it - remove unnecessary include file Changes in v11: - update delete_boot_option() parameter Changes in v10: - add function comment - devname dynamic allocation removes, allocate in stack - delete BOOT#### when updating BootOrder fails Changes in v9: - update efi_disk_get_device_name() parameter to pass efi_handle_t - add function comment Changes in v8: - function and structure prefix is changed to "eficonfig" Changes in v7: - rename prepare_media_device_entry() to generate_media_device_boot_option() Changes in v6: - optional_data size is changed to 16bytes - check the load option size before comparison - remove guid included in optional_data of auto generated entry when loading Changes in v5: - Return EFI_SUCCESS if there is no BootOrder defined - correctly handle the case if no removable device found - use guid to identify the automatically generated entry by bootmenu cmd/bootmenu.c | 22 +++- cmd/eficonfig.c | 208 +++++++++++++++++++++++++++++++++++ include/efi_config.h | 1 + include/efi_loader.h | 16 +++ lib/efi_loader/efi_bootmgr.c | 4 + 5 files changed, 245 insertions(+), 6 deletions(-) diff --git a/cmd/bootmenu.c b/cmd/bootmenu.c index 704d36debe..3340be1632 100644 --- a/cmd/bootmenu.c +++ b/cmd/bootmenu.c @@ -7,7 +7,7 @@ #include #include #include -#include +#include #include #include #include @@ -220,7 +220,7 @@ static int prepare_bootmenu_entry(struct bootmenu_data *menu, return 1; } -#if (CONFIG_IS_ENABLED(CMD_BOOTEFI_BOOTMGR)) +#if (CONFIG_IS_ENABLED(CMD_BOOTEFI_BOOTMGR)) && (CONFIG_IS_ENABLED(CMD_EFICONFIG)) /** * prepare_uefi_bootorder_entry() - generate the uefi bootmenu entries * @@ -340,11 +340,21 @@ static struct bootmenu_data *bootmenu_create(int delay) if (ret < 0) goto cleanup; -#if (CONFIG_IS_ENABLED(CMD_BOOTEFI_BOOTMGR)) +#if (CONFIG_IS_ENABLED(CMD_BOOTEFI_BOOTMGR)) && (CONFIG_IS_ENABLED(CMD_EFICONFIG)) if (i < MAX_COUNT - 1) { - ret = prepare_uefi_bootorder_entry(menu, &iter, &i); - if (ret < 0 && ret != -ENOENT) - goto cleanup; + efi_status_t efi_ret; + + /* + * UEFI specification requires booting from removal media using + * a architecture-specific default image name such as BOOTAA64.EFI. + */ + efi_ret = eficonfig_generate_media_device_boot_option(); + if (efi_ret != EFI_SUCCESS && efi_ret != EFI_NOT_FOUND) + goto cleanup; + + ret = prepare_uefi_bootorder_entry(menu, &iter, &i); + if (ret < 0 && ret != -ENOENT) + goto cleanup; } #endif diff --git a/cmd/eficonfig.c b/cmd/eficonfig.c index c9713acdda..21d9bd3e23 100644 --- a/cmd/eficonfig.c +++ b/cmd/eficonfig.c @@ -1818,6 +1818,214 @@ static efi_status_t eficonfig_process_delete_boot_option(void *data) return ret; } +/** + * eficonfig_enumerate_boot_option() - enumerate the possible bootable media + * + * @opt: pointer to the media boot option structure + * @volume_handles: pointer to the efi handles + * @count: number of efi handle + * Return: status code + */ +efi_status_t eficonfig_enumerate_boot_option(struct eficonfig_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 *p; + u16 dev_name[BOOTMENU_DEVICE_NAME_MAX]; + char *optional_data; + struct efi_load_option lo; + 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_disk_get_device_name(volume_handles[i], buf, BOOTMENU_DEVICE_NAME_MAX); + if (ret != EFI_SUCCESS) + continue; + + 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); + /* + * Set the dedicated guid to optional_data, it is used to identify + * the boot option that automatically generated by the bootmenu. + * efi_serialize_load_option() expects optional_data is null-terminated + * utf8 string, so set the "1234567" string to allocate enough space + * to store guid, instead of realloc the load_option. + */ + lo.optional_data = "1234567"; + opt[i].size = efi_serialize_load_option(&lo, (u8 **)&opt[i].lo); + if (!opt[i].size) { + ret = EFI_OUT_OF_RESOURCES; + goto out; + } + /* set the guid */ + optional_data = (char *)opt[i].lo + (opt[i].size - u16_strsize(u"1234567")); + memcpy(optional_data, &efi_guid_bootmenu_auto_generated, sizeof(efi_guid_t)); + } + +out: + return ret; +} + +/** + * eficonfig_delete_invalid_boot_option() - delete non-existing boot option + * + * @opt: pointer to the media boot option structure + * @count: number of media boot option structure + * Return: status code + */ +efi_status_t eficonfig_delete_invalid_boot_option(struct eficonfig_media_boot_option *opt, + efi_status_t count) +{ + u32 i, j; + efi_uintn_t size; + efi_status_t ret; + void *load_option; + struct efi_load_option lo; + u16 varname[] = u"Boot####"; + + for (i = 0; i <= 0xFFFF; i++) { + efi_uintn_t tmp; + + efi_create_indexed_name(varname, sizeof(varname), "Boot", i); + load_option = efi_get_var(varname, &efi_global_variable_guid, &size); + if (!load_option) + continue; + + tmp = size; + ret = efi_deserialize_load_option(&lo, load_option, &size); + if (ret != EFI_SUCCESS) + goto next; + + if (size >= sizeof(efi_guid_bootmenu_auto_generated)) { + if (guidcmp(lo.optional_data, &efi_guid_bootmenu_auto_generated) == 0) { + for (j = 0; j < count; j++) { + if (opt[j].size == tmp && + memcmp(opt[j].lo, load_option, tmp) == 0) { + opt[j].exist = true; + break; + } + } + + if (j == count) { + ret = delete_boot_option(i); + if (ret != EFI_SUCCESS) { + free(load_option); + goto out; + } + } + } + } +next: + free(load_option); + } + +out: + return ret; +} + +/** + * eficonfig_generate_media_device_boot_option() - generate the media device boot option + * + * This function enumerates all devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL + * and generate the bootmenu entries. + * This function also provide the BOOT#### variable maintenance for + * the media device entries. + * - Automatically create the BOOT#### variable for the newly detected device, + * this BOOT#### variable is distinguished by the special GUID + * stored in the EFI_LOAD_OPTION.optional_data + * - If the device is not attached to the system, the associated BOOT#### variable + * is automatically deleted. + * + * Return: status code + */ +efi_status_t eficonfig_generate_media_device_boot_option(void) +{ + u32 i; + efi_status_t ret; + efi_uintn_t count; + efi_handle_t *volume_handles = NULL; + struct eficonfig_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 eficonfig_media_boot_option)); + if (!opt) + goto out; + + /* enumerate all devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL */ + ret = eficonfig_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 = eficonfig_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 = eficonfig_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 = eficonfig_append_bootorder(boot_index); + if (ret != EFI_SUCCESS) { + efi_set_variable_int(var_name, &efi_global_variable_guid, + 0, 0, NULL, false); + goto out; + } + } + } + +out: + if (opt) { + for (i = 0; i < count; i++) + free(opt[i].lo); + } + free(opt); + efi_free_pool(volume_handles); + + return ret; +} + + /** * eficonfig_init() - do required initialization for eficonfig command * diff --git a/include/efi_config.h b/include/efi_config.h index dddffe045e..098cac2115 100644 --- a/include/efi_config.h +++ b/include/efi_config.h @@ -93,5 +93,6 @@ efi_status_t eficonfig_select_file_handler(void *data); efi_status_t eficonfig_get_unused_bootoption(u16 *buf, efi_uintn_t buf_size, u32 *index); efi_status_t eficonfig_append_bootorder(u16 index); +efi_status_t eficonfig_generate_media_device_boot_option(void); #endif diff --git a/include/efi_loader.h b/include/efi_loader.h index 4461f721e0..6b63ae8dde 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -953,6 +953,22 @@ struct efi_signature_store { struct x509_certificate; struct pkcs7_message; +/** + * struct eficonfig_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 eficonfig_media_boot_option { + void *lo; + efi_uintn_t size; + bool exist; +}; + bool efi_hash_regions(struct image_region *regs, int count, void **hash, const char *hash_algo, int *len); bool efi_signature_lookup_digest(struct efi_image_regions *regs, diff --git a/lib/efi_loader/efi_bootmgr.c b/lib/efi_loader/efi_bootmgr.c index ede9116b3c..4b24b41047 100644 --- a/lib/efi_loader/efi_bootmgr.c +++ b/lib/efi_loader/efi_bootmgr.c @@ -246,6 +246,10 @@ static efi_status_t try_load_entry(u16 n, efi_handle_t *handle, } /* Set load options */ + if (size >= sizeof(efi_guid_t) && + !guidcmp(lo.optional_data, &efi_guid_bootmenu_auto_generated)) + size = 0; + if (size) { *load_options = malloc(size); if (!*load_options) {