From patchwork Wed Aug 24 04:27: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: 599718 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:4388:0:0:0:0 with SMTP id w8csp2894726mae; Tue, 23 Aug 2022 21:28:15 -0700 (PDT) X-Google-Smtp-Source: AA6agR6TfKjIrlOmgiWLmMa908t+udAwDjLkw9bRrNZ9FSIRqqzsf+wUa1+tQf1kbh0I2Ga/ZM7R X-Received: by 2002:a17:906:e28e:b0:73d:8cca:2f6 with SMTP id gg14-20020a170906e28e00b0073d8cca02f6mr1681608ejb.621.1661315294922; Tue, 23 Aug 2022 21:28:14 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1661315294; cv=none; d=google.com; s=arc-20160816; b=CY2DB5I575GEbUy+AwKriq7qNK/BIz1/8VfTZxlQbyARMaLmmnEgF+I2EdXzmeRVGv s/3Nvzb7i1bnBETtQEo7A+YPVBCv85degKHUid7ObjZmmYnv2V64+4oAWnyDkRs36fxo QeLu41DFl14LqoEBYk0O+IsuaS2kwf4sR+kOM1Zr1cgvFw6CUb1ihljKLCx5J/u+85z9 dHBcCo/Yn9/SWt5PComtkxNItdeu+Ru4XIVTuJo61nLvW2agmTg886UI71DdV8Nh4EPv HTR/dxZbw2AJ/aWerzVLbmioLM5huXhUApHmnrdGg3tVbzHt2Sr42XCzVTfHroTLN/9z IRgw== 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=R2m1PALxrLNFqeLDUFe6njpGnsKyJB17x8HxUZou1/uVJL1B7SX/sVIpeUgWmUdI1i iZPB7J9xUgXuMKrjpdVw27mtAQZgpoNIa92Xc9ms5VaXWLqOy8yGVhDKqynV7iNs6LkY +ZdGvIetgPuEJQMSlIxI1HK25MC1kC+WZrAV2QuQhRn1W38WoZqdabApeZycVKZ4O26y xvKvOp05Uupl4noOaMd2so19V9YhoIoqbmV1xM/hs9B7Wd28osTCWjAJhVG5YzBzj4le Qh/v0b4hlQOWwsaI/hiv574498pVv5eq6Xxiri4+jkTYaKRkpus7K7Rpav28a7YxQkM1 9k/w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=Ia2N4dxz; 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 hb9-20020a170907160900b0073d85d36f86si1312080ejc.724.2022.08.23.21.28.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Aug 2022 21:28:14 -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=Ia2N4dxz; 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 C2A8684867; Wed, 24 Aug 2022 06:27:25 +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="Ia2N4dxz"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 32D0D8485C; Wed, 24 Aug 2022 06:27:12 +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-x102c.google.com (mail-pj1-x102c.google.com [IPv6:2607:f8b0:4864:20::102c]) (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 103098483E for ; Wed, 24 Aug 2022 06:27:07 +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-x102c.google.com with SMTP id s3-20020a17090a2f0300b001facfc6fdbcso351414pjd.1 for ; Tue, 23 Aug 2022 21:27:06 -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; bh=pUd+ePSJtY4udK76FusNe0a668i93KjS6Rry/1J6Nkk=; b=Ia2N4dxzJ0WB0O+0IDqD8X5qiAWfk8mlKXrF1xYqKyivivoaO776i9fBU1l7TsLy/i yDw/zIyAIXEFyKkEle5ARPXjaAIvmB6WCHywjg0ZAHlLjR137rRhA8sIi8l9K79ofSYZ zzFNQI48QRsWTSfdfvQcvWYsPP2xl5+uPjjda4EfuP89F4j9LMMH26AUKJWpWAammAcS JLyqRUe7pBOVUVh5g2MVodeP0EO9sAJ3JOypKbtAq4HNP2atSwklcNhWnCONIRi/yMEC aeUY0zJTfF92i2MDmFvXetMiGsqXZX6EG18W0mvai9yS8EPQ9LEy/w1WzxcdoagPrP0H 87uw== 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; bh=pUd+ePSJtY4udK76FusNe0a668i93KjS6Rry/1J6Nkk=; b=UagEcL2/W2KhXv5GgmDgskRUJc/2LiOSwRgaxfpZ//iaZ+gdgkQA2NRlcHMBL/2VTv b1y6mmKEnSIAvxYSn5assO4lTP7bnnSCSnO++0fXxEen4hJU8QEsDBlznAgJp/lcSjyZ RyGeqeORglDMmXfJ9TdPkXA2U4LnfjvJ9enXLNH17l/cmXt3Ei+agh1eyfTlSqYRtxe+ TAVMKN88sDT9JDYnhKJGGVs1vVKeffh468j1DPvoM4rWYzvVbEd9uh0CDHtuuNqXYy74 Wct0oYLTrccKzYhlC41wriJVjgix8D+6czJ3S4LNroR8PqCGMcFZ4VF2elav+cp3WtoS 6owQ== X-Gm-Message-State: ACgBeo0L5PphkEzCay1bKvuQ7idDUvwuBwuKN7rhD7gbZrkaAtJS5JVv 9mwYpDyl+GI3osksG6UauYBzrn+LcqgW6A== X-Received: by 2002:a17:902:9b97:b0:173:dd7:3f3 with SMTP id y23-20020a1709029b9700b001730dd703f3mr3314859plp.56.1661315225152; Tue, 23 Aug 2022 21:27:05 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id g21-20020a170902d1d500b0016397da033csm11280965plb.62.2022.08.23.21.27.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Aug 2022 21:27:04 -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 v12 7/9] doc:bootmenu: add description for UEFI boot support Date: Wed, 24 Aug 2022 13:27:47 +0900 Message-Id: <20220824042749.27434-8-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220824042749.27434-1-masahisa.kojima@linaro.org> References: <20220824042749.27434-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"