From patchwork Fri Sep 2 14:23:47 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 602178 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:4388:0:0:0:0 with SMTP id w8csp1509828mae; Fri, 2 Sep 2022 07:23:44 -0700 (PDT) X-Google-Smtp-Source: AA6agR7JBP3rCPeiGpoF7u8e982bKc1mRHC70zsxL5TjfOLH22z99RqNraeSrvIBUJGU+Auh1UrI X-Received: by 2002:a05:6402:26c6:b0:448:658e:5b32 with SMTP id x6-20020a05640226c600b00448658e5b32mr21901609edd.250.1662128624546; Fri, 02 Sep 2022 07:23:44 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1662128624; cv=none; d=google.com; s=arc-20160816; b=vZAGmpwQbRQojZekFNK9ZnZnAPNm7EfS/40LIZYbfKZHYf7SxrL+ro2qrtbqKHS9+M /Zt+waw+WrjpebqLv54a/ibcw3+uHaECfOpRsT/QcHXWX/D5KtYTGwFgF4F7ZyiaBX4v MSnFHLqGzZ1CZAc+ByEJiqyAxrIsQD4fpgkh9QWQ2G/jU/Hjnpw40MSKH3JMn3Jbuq07 LDk7Nd0ivbgLhCKzTmQePT6JVoBu+t1EIodn23fezMJTrIgFS7STl3GXbaG+YVHku6RB QiH8ajHLPE2e22h4T3WVSmZ70Sim/5R4B5cpE0IJ47SX9fs2TYccv0ro1EaeoQSUgvUp dPrQ== 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=pUd+ePSJtY4udK76FusNe0a668i93KjS6Rry/1J6Nkk=; b=f8M31MSaWVjYuErOmwJT9QUiJqybes2FCCfL3i4GAPDPHB/d3vtpCqMD2V0GTL4Eui OcGMwz2i3l4gh09UH6sH9niIJaU5//7DvdiJ2RC2FTSjshDqVCPbJKklhMeNrb4amxhy zJxYIWl2lht9BtyMRD/v5zfQcYi+aa22q9l8m5NXJwqk/PQEbupasdJ+D9tubwuwApx0 jhdQScTgvCsExAGanvp7LSl51uRwpmPHOkjTe0BiXqRjVsWtu61H3/DItnULiKMFVtKM zViQN1ftZQUNCtng4zE9Muyjp8dCS9rEQenBjnfgnstMurSlU/+URGZIEstXnRCdJwFK 1hrQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=mEOOqUGL; 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 s7-20020a056402520700b00448aec609dfsi2076204edd.20.2022.09.02.07.23.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Sep 2022 07:23:44 -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=mEOOqUGL; 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 88BD784B09; Fri, 2 Sep 2022 16:22:35 +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="mEOOqUGL"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 1CE1A84AFA; Fri, 2 Sep 2022 16:22:33 +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-pf1-x42d.google.com (mail-pf1-x42d.google.com [IPv6:2607:f8b0:4864:20::42d]) (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 CFA9584AF9 for ; Fri, 2 Sep 2022 16:22:29 +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-pf1-x42d.google.com with SMTP id y29so2077233pfq.0 for ; Fri, 02 Sep 2022 07:22:29 -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=pUd+ePSJtY4udK76FusNe0a668i93KjS6Rry/1J6Nkk=; b=mEOOqUGLWJBl6rrndPBDWtAUS5wz9mrCXm/9BH9p8tL3ihP+wjbvykjKaxub5QiYTW AEU2tFMd6jvQoddWdFxdqG89FSKvCL53ZLExZy52rP3C+Kj/n78fubEq3ZvzMmTCucaA myi+X+mISpVcwtjqrkhewLf/Nbd+nVSY7BnjJ1nsAatmbiKQpVBmtDbzICghsPHsuwnZ Ch6qdrIsM+sxwk6KhY9xF03VlS7j/Kv3NX65mg60r942iPNURmLODQj07XHfdc6NtyP7 dNffQFAh8k5nVhLSaN3rhuqrYALgejrtzAIXdDVlL7azkux7O1sBTKnm/n7OQGoK+xft aVhQ== 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=pUd+ePSJtY4udK76FusNe0a668i93KjS6Rry/1J6Nkk=; b=geyUVtI/rYeXWQi/mutmL9JFs+a6S1xqUCu80yluBRO5Oe35c0hJXllYO9tOPs4bXy lSFfwnK3eULOkbcl/gUIUZHcM//xjh+nGLN5H6iw5srv9pv1X+GkOzSpfw7l5NA0HF8G s2W+AIRrTVBvma9AQhJfGl+LZ4DstBVYEZc+yVSv1sGBi4e+NS+gxQb+ELHyUbpm0e3N +8gNqsP9NPZOEwNhG96r3Twuqu8pLezbyYDi/HM08GxBWG0w+TQs5j2vjD7yCQ5OstCw t3jlkitlA8KZSs7NNtmuSTlt6FOXAWQeZRwbl06QS8J8wt9FIX/+Nblcse4V+4nckOdq SZVQ== X-Gm-Message-State: ACgBeo1ApfNd0fOHFmi+7lnPBl5hBK8Ow1ikTXcEWjnAv61CyuuPeG7I 9TukNIJmXoQq/qi2XsGlYMW0+CFfYvG4Wg== X-Received: by 2002:aa7:910b:0:b0:537:cd65:e7d with SMTP id 11-20020aa7910b000000b00537cd650e7dmr34979299pfh.63.1662128548032; Fri, 02 Sep 2022 07:22:28 -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.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Sep 2022 07:22:27 -0700 (PDT) From: Masahisa Kojima To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Takahiro Akashi , Mark Kettenis , Masahisa Kojima , Bin Meng Subject: [PATCH v15 08/10] doc:bootmenu: add description for UEFI boot support Date: Fri, 2 Sep 2022 23:23:47 +0900 Message-Id: <20220902142349.16722-9-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 The bootmenu enumerates the UEFI boot options for boot device selection. This commit adds the description how the UEFI boot work in bootmenu. This commit also adds "Synopsis", "Description" and "Configuration" sections to follow the U-Boot command documentation format. Signed-off-by: Masahisa Kojima Reviewed-by: Ilias Apalodimas --- No update since v10 Changes in v10: - fix typos Changes in v7: - update the description what bootmenu do for uefi-related boot menu - add default behavior when user exits from bootmenu Changes in v6: - remove distro boot related contents because the distro boot support in bootmenu is dropped - update uefi entry example - add [delay] argument of bootmenu command - add description to enable uefi boot entry Changes in v5: - follow the cmd documentation format same as other command, add "Synopsis", "Description" add "Configuration" sections Newly created in v4 doc/usage/cmd/bootmenu.rst | 74 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/doc/usage/cmd/bootmenu.rst b/doc/usage/cmd/bootmenu.rst index 9430f8c9aa..cb3c8d2f93 100644 --- a/doc/usage/cmd/bootmenu.rst +++ b/doc/usage/cmd/bootmenu.rst @@ -4,6 +4,15 @@ bootmenu command ================ +Synopsis +-------- +:: + + bootmenu [delay] + +Description +----------- + The "bootmenu" command uses U-Boot menu interfaces and provides a simple mechanism for creating menus with different boot items. The cursor keys "Up" and "Down" are used for navigation through @@ -79,6 +88,55 @@ The above example will be rendered as below:: The selected menu entry will be highlighted - it will have inverted background and text colors. +UEFI boot variable enumeration +'''''''''''''''''''''''''''''' +If enabled, the bootmenu command will automatically generate and add +UEFI-related boot menu entries for the following items. + + * possible bootable media with default file names + * user-defined UEFI boot options + +The bootmenu automatically enumerates the possible bootable +media devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL. +This auto generated entry is named as " :" format. +(e.g. "usb 0:1") + +The bootmenu displays the UEFI-related menu entries in order of "BootOrder". +When the user selects the UEFI boot menu entry, the bootmenu sets +the selected boot variable index to "BootNext" without non-volatile attribute, +then call the uefi boot manager with the command "bootefi bootmgr". + +Example bootmenu is as below:: + + *** U-Boot Boot Menu *** + + mmc 0:1 + mmc 0:2 + debian + nvme 0:1 + ubuntu + nvme 0:2 + usb 0:2 + U-Boot console + +Default behavior when user exits from the bootmenu +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +User can exit from bootmenu by selecting the last entry +"U-Boot console"/"Quit" or ESC/CTRL+C key. + +When the CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is disabled, +user exits from the bootmenu and returns to the U-Boot console. + +When the CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is enabled, user can not +enter the U-Boot console. When the user exits from the bootmenu, +the bootmenu invokes the following default behavior. + + * if CONFIG_CMD_BOOTEFI_BOOTMGR is enabled, execute "bootefi bootmgr" command + * "bootefi bootmgr" fails or is not enabled, then execute "run bootcmd" command. + +Configuration +------------- + The "bootmenu" command is enabled by:: CONFIG_CMD_BOOTMENU=y @@ -88,3 +146,19 @@ To run the bootmenu at startup add these additional settings:: CONFIG_AUTOBOOT_KEYED=y CONFIG_BOOTDELAY=30 CONFIG_AUTOBOOT_MENU_SHOW=y + +UEFI boot variable enumeration is enabled by:: + + CONFIG_CMD_BOOTEFI_BOOTMGR=y + +To improve the product security, entering U-Boot console from bootmenu +can be disabled by:: + + CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE=y + +To scan the discoverable devices connected to the buses such as +USB and PCIe prior to bootmenu showing up, CONFIG_PREBOOT can be +used to run the command before showing the bootmenu, i.e.:: + + CONFIG_USE_PREBOOT=y + CONFIG_PREBOOT="pci enum; usb start; scsi scan; nvme scan; virtio scan"