From patchwork Fri Jul 15 14:47:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 590851 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:5817:0:0:0:0 with SMTP id j23csp570686max; Fri, 15 Jul 2022 07:46:48 -0700 (PDT) X-Google-Smtp-Source: AGRyM1vu6fxh1Z5Lqikbes8FGVsja/AjmcUpxgFE+DOIl/7KgwHVKkKw9UdacC0s0xr8ccrmj50v X-Received: by 2002:a05:6638:30a:b0:33f:57c5:45fc with SMTP id w10-20020a056638030a00b0033f57c545fcmr8001092jap.291.1657896408857; Fri, 15 Jul 2022 07:46:48 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1657896408; cv=none; d=google.com; s=arc-20160816; b=SLq/El3AlqTjeDNgmeQu4XIH1KYZ/7q3CiGBHIF4xI1hSu1fkN/pkYk0zfmoNJeGDM GIvCzQwxMuTklzbHbVxEbbGd2T01L6+evNoDk3ai26dDllmrgFZ5/s7HDDWgTT+Nc3Ms zL05xbjdCrP3Kr0j5iT09/p8I+vwupw2kJHgbJTRvCRNV36eyLobrmjzEochA753iPd/ wM+P26+6wc/njfy1CshniWxUs5wZOoboD0E0E4mzh9voNeSt+nPKhKEurrYxY/Zms2c+ W/Ran16VhM5VZiJUTjZab9qe3JqWAhyltAuWdLxwmKrKxPSacmA0EXEJ1K6UtIinlHn6 1j5Q== 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=wrdys3/dbUUfK+3BxRJnxUf8rBAvOa2YOd7ils7QECc=; b=AMOclHWyw5jjzGQulxq2ZJlTdxZXY+MQ+GJ3SGMEkRbfn8d9eQLa6GAOXdRvusqDrt NuGNNuzm8RSqlf4dWBvb9cwOHTLFMYcc0PKxWjrzbZnnS4+7Y4zvArr7i+S6bGPeEGQC t/yB4Ks5SSp842yNh+v9ec2URpOY7u4yF60rlkJXSLk6VMF2N31Q3s42KyUqM/3ozCkZ 1JLkuGKwBp6VaM9blUYJQoJPI/OWy2vPdKIetLf7ax/l3GqCTULAF1o2kTMf1G7+Yz1r DZ0I4Xccp7ze+PHYyey1Ri8VFYMjI5YXacRmYl/h818V8TMIGFjGuMlkEM2FPdwZ9z2A vzPA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="T+P/23Ti"; 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 i21-20020a056638381500b0033ebb1c71adsi5689450jav.52.2022.07.15.07.46.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 15 Jul 2022 07:46:48 -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="T+P/23Ti"; 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 03AE381DD4; Fri, 15 Jul 2022 16:45:54 +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="T+P/23Ti"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 2DAB981F69; Fri, 15 Jul 2022 16:45:41 +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-x42a.google.com (mail-pf1-x42a.google.com [IPv6:2607:f8b0:4864:20::42a]) (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 97E69810E8 for ; Fri, 15 Jul 2022 16:45: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=masahisa.kojima@linaro.org Received: by mail-pf1-x42a.google.com with SMTP id l124so4824542pfl.8 for ; Fri, 15 Jul 2022 07:45:35 -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=wrdys3/dbUUfK+3BxRJnxUf8rBAvOa2YOd7ils7QECc=; b=T+P/23TiXgmYGlMDG4eAtnEfX1/wayd2L7chSfuWtkgPoLuXAxmvG2Ewd1wZ0c/EU3 q2YQj2F8fMBbGBYdd+j5yN/6FijHBObUMb0SSbeJusCZTyqD9m+TJqN1MA6ek8uVH7T1 vNRqxHCg7HT1p3aenKKfvmIjm6sT2hSpvJ7wyJSsr15ZJ/R8xAajuxYS6xLYJeG1+1g/ ZSRQdSYgAVEJlnitOgr9vQ4oflDQYg18ng6eXJOxKPlUu2KyRRrdbXx84R8CW/3/Y6SV lJvl7aQsPciGiDqKqadSmbYa9CJ/tflybt8n+9oWWujZrhFK1lh+T6rFcfYoxhMtUxKR vXKA== 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=wrdys3/dbUUfK+3BxRJnxUf8rBAvOa2YOd7ils7QECc=; b=AAyjwYY5wP8NnIQcx+sKlrz+TAOWMUYgqCHcDOpWh2f0dmYO8dDxtly94rmdT6ktCv 40ZGSSe/KTtwXGOsOtd5PQjYzcVY1JqiIxN40zbcUZmP3zTGHHtLW07ySZ6KXa5FTuY3 QBnHzCsgjc7/Dttr2j6GsUYM2TEU8ihKqOwSWRX6BvZerGpx/T9GLrUpUE6IJvxYyq8G 9+z+39Fw9EBZAFu1ungDgmXFcM2GTy3fxlcCrsq2Ca7xx3qr5jofrivcsthAGXrKjTiN 9Q05RI1qZJsMthCWZvNmo5n5veLFJaQQCBjRe3TFmdDo9RxkG6dNcgAtPTO64Sf6ApG5 PpAQ== X-Gm-Message-State: AJIora9PwJu2/WYtEgh1MDSQ6OSYX40WO3LdoGw8UON2OZYzL/mP2PYE Kb6P6JCtlXYuIV/WpdFFvWcnYt5t/0IYTg== X-Received: by 2002:a63:164d:0:b0:416:4bc:1c28 with SMTP id 13-20020a63164d000000b0041604bc1c28mr12363613pgw.302.1657896333541; Fri, 15 Jul 2022 07:45:33 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id u16-20020a170903125000b001690d398401sm3719923plh.88.2022.07.15.07.45.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 15 Jul 2022 07:45:33 -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: [RESEND v9 8/9] doc:bootmenu: add description for UEFI boot support Date: Fri, 15 Jul 2022 23:47:48 +0900 Message-Id: <20220715144749.30564-9-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220715144749.30564-1-masahisa.kojima@linaro.org> References: <20220715144749.30564-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 change since v7 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..69435090a2 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 behabior. + + * if CONFIG_CMD_BOOTEFI_BOOTMGR is enabled, execute "bootefi bootmgr" command + * "bootefi bootmgr" fails or is not enabled, then execute "run bootcmt" 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"