From patchwork Mon Sep 5 12:48:00 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 602746 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:4388:0:0:0:0 with SMTP id w8csp3642692mae; Mon, 5 Sep 2022 05:47:39 -0700 (PDT) X-Google-Smtp-Source: AA6agR5H62iD/+fxe4QHZk6SLpyxgFlmx/ZPObm/slBkDnjGx5pDuiTFLvf9UAi4QUJ7WufibAOy X-Received: by 2002:a05:6402:516f:b0:44e:9151:d54b with SMTP id d15-20020a056402516f00b0044e9151d54bmr2969338ede.241.1662382058917; Mon, 05 Sep 2022 05:47:38 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1662382058; cv=none; d=google.com; s=arc-20160816; b=ucboYhUZhR+f8te0iAB8+yilXFy/fiO8RlUq6asch2C/BKbU5VEioiS9RgljE7jjD7 goNcnw5AD1dL9yoyAgFfEFMdTFQwOjL8QnvQAX3xnsvou5C2AjdtSCXjsQq38quu+oqO vjNshzROX+9aY9+gtk3IIT+32hoepByhqqSpOeYL1xaEX74ibR5A3f12ZqwNU63Pdskm V0tZx6+teUOC7wuCJqjBHRZxjmc8RAiHuj80dxqosWszvn/c/5wM+0NPStyWvjBGXVdE Yh/6NO/+20d2DBvsSfwsQcEDkVcWr0SMr+FdBU2DMRs5mBlEKZcbYKugySJmx8pjSbp8 q6Qg== 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=U7DrxJcRs7+3r2R7JCrVfeXPdk8DMZDUUeTYVODn8k6ErteBSJ1BuK92l67DUZFBTZ sMncdKIGD+B6cSM1UmBWvKNm6bYADGHA26pLkyxmGrUquj1vSoX+cxgYNYSOfHr5x1EJ XQI0rBqhxLjEi8D3noI+I+lcxKkQJMnt7C8FTEgNsATYCVool0NOKktNzDQJrgGWMoxM gpMmDTPFBB5udYAaJLnBL1B/ZhOZOsdErqT4DV5K9napQu3JgAunznJLtbAbDsEH+OWd e/W7KJau/erkUQDEMr6zYf40G17MeUHPXSQlvQU6o5AvljKi0IcuUHOcUSE5vBXOxZBO rc9A== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=rLYAMnf4; 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 hw9-20020a170907a0c900b00730c028231esi6146925ejc.120.2022.09.05.05.47.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Sep 2022 05:47:38 -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=rLYAMnf4; 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 033D784986; Mon, 5 Sep 2022 14:46:46 +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="rLYAMnf4"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 81048848F2; Mon, 5 Sep 2022 14:46:35 +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-pj1-x1036.google.com (mail-pj1-x1036.google.com [IPv6:2607:f8b0:4864:20::1036]) (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 5CA6D84912 for ; Mon, 5 Sep 2022 14:46:30 +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-pj1-x1036.google.com with SMTP id t11-20020a17090a510b00b001fac77e9d1fso12088728pjh.5 for ; Mon, 05 Sep 2022 05:46:30 -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=rLYAMnf4AshlseTu1PlFWmMdDXqjVom89aSeGuZ3gK8DrZKDhGEgmCbKJb+dGdGwyx sdBXaTXzWHRImMIQNgOiFlLZ+s2G+j10DkYryM6sDHcRdN8CQ6vqnMSaWWV7NBojdVJu DShmrxwrmjZWUNYOJpTr1j50vxpo9ospDeuoI+SvgoO38ex2kraRjAOcMH40ZumCouX1 ya6rbzFZ4GxwGuRWSdFXmR9iPICoRFglsKlpXahwZkoRuzpak04ovoguwmDvYV+vbP1Y w2r/abLNMfcJCGTRMYfwqSxt2Ez7SyqPuiYgvGiAkeVCvU7hnYGeguvAbYK1lbt9Gr65 PmDw== 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=k/e1qMJwMfdYk+CbsxjbOiT6GVm4Ko7FyK+GF3SKDvu7THET3tYI9QkY49GEFWQ214 2X5REuAbNDLffSHvosnrGWcR/oNsdUjgT7BH4iaPAcZuuV3ZyJL40q/Xdtumcvg0OHRh iPkb98VL+A+lCc63V8xfH06WE7iIbsNZHXX+GP31bOOVFgulKr4oJeTRLNRgfc6RZtvR Iuz6uRDZ0a7SPsSBq1PsM1R0JLUCW9q99HJVdCjEuivmVnnIc5pjK5tZcz05j6zzUqPu 7VD0AQA2fSOvXKJEyL5nUE/xeWXSvS64HAmV3nE6NZYQgXgcnA+onaAnxslwub3Wgoi7 R/Hg== X-Gm-Message-State: ACgBeo2qt46N1B2lifU1lWI7AaoReohTt0UaNsdMfsPbFyU230l8SKZu Ga9LjSSTQimMqr9FaXAQ0hJ9VmoPHr+l7g== X-Received: by 2002:a17:902:b903:b0:176:6db0:de76 with SMTP id bf3-20020a170902b90300b001766db0de76mr15187580plb.149.1662381988175; Mon, 05 Sep 2022 05:46:28 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id y64-20020a623243000000b0053639773ad8sm7660949pfy.119.2022.09.05.05.46.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 05 Sep 2022 05:46: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 v16 08/10] doc:bootmenu: add description for UEFI boot support Date: Mon, 5 Sep 2022 21:48:00 +0900 Message-Id: <20220905124803.2909-9-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220905124803.2909-1-masahisa.kojima@linaro.org> References: <20220905124803.2909-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"