From patchwork Mon Jun 13 09:38:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 581418 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:5806:0:0:0:0 with SMTP id j6csp1798592max; Mon, 13 Jun 2022 02:40:10 -0700 (PDT) X-Google-Smtp-Source: ABdhPJz6QAk9Lx73ApQCxBB8i3sNemk/mRIAHHPW92r5gOcvUpTZeOBYseau6DYUltmPAfJnLGcQ X-Received: by 2002:a92:cd41:0:b0:2d6:6553:db13 with SMTP id v1-20020a92cd41000000b002d66553db13mr14190976ilq.307.1655113210256; Mon, 13 Jun 2022 02:40:10 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1655113210; cv=none; d=google.com; s=arc-20160816; b=EsuZb9yrvqkAHPA+2aQkxh4JT38fCE8+pq/+tVgth7Tirg0dVoaXfmh3TnXnUe+a1h 6KmtaVMksLjavBpVQ6Vq8f9fGJBFt0kHzlwl/PeOfHlxx/BaO3wmYtoAPEiuAKuHIr+l hW5pJPvFItiqpWuPcDYO4nJqpZKqn0t7SUx48KxCNswwZUKcJme/ASDhEsXvy5gmg80d JuTS/ix5PyTzzuUlVLmpaJKc1fR+G3l8mF0r7u8A/ZM+GnWJmkw1SJ7q+lio0bJ9xzPY Awyx0SHv0+LFISY2X9+VvMVWanyapQpmgN+sdH3yk8k1GX8xg9Q/pH9FOwXk8WR3NTKj g83Q== 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=TcgkC7dSbCLJEWpbkUsU5xZrZM5AddVBeoyH2icwoeI=; b=sVWrsbwfnoO7rTMV6ZB4a2ZG1suHkS4PknlUdNbm4xEBN8eY+N3tUBW3mZNszYZywV krmrfjmrNpcn8y0Af30KexWKNSAMCflWAuBIb0kUTsakDOKPhyZfFK4RO4Hl/gJPjax4 Pp7Fyp9+90Vhl6U9WTfCoYyJbbD7ZCaMR+yG0ujbvfm+Ve1B9pMC58yL0WKIpn+hWYON zNJgjjqiAcv4NaPEsCwlvhGJSkvQqtfrzzYX4J7Z3N+MK6MC/TSIliS+dguCe0ZlZ70x xO2FJCC8gTci8t4G49t9LSeowIuUYymaCNbjvzB940XZs5ZM+o2+Mx5d6V+G2mYLjxgJ H16Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=Fkfg09FB; 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 w7-20020a056e02190700b002d3dce14046si9949930ilu.173.2022.06.13.02.40.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Jun 2022 02:40:10 -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=Fkfg09FB; 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 A7D1A8445E; Mon, 13 Jun 2022 11:38:51 +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="Fkfg09FB"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 9A2208445F; Mon, 13 Jun 2022 11:38:46 +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-x1034.google.com (mail-pj1-x1034.google.com [IPv6:2607:f8b0:4864:20::1034]) (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 EEC8084451 for ; Mon, 13 Jun 2022 11:38:41 +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-x1034.google.com with SMTP id v11-20020a17090a4ecb00b001e2c5b837ccso8296433pjl.3 for ; Mon, 13 Jun 2022 02:38:41 -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=TcgkC7dSbCLJEWpbkUsU5xZrZM5AddVBeoyH2icwoeI=; b=Fkfg09FBDV3xBkcqiqs8WpIqaAWty+IZnxCk4q9ZF8tCvOCxjfmic9uSlKAZKgjWaL XwvgqU58I8PubCHcj8Zjjby+80CcPXQjY6fhfqGL6M5bt7c3NCYKtKVOwCviwXWZR5+b 23ARwp13ZBN0jNFflheMZsPgmP3E6d6EiP3Vt1nolPTi3cbaSaJxll602MfXTbXQ/BvA chptysjfsEAB2Fq13GNINO66quT6JchS5+1lKH+PY2kyyqJ1Xea0NTpGN021aFez3UnD eJlK2FZPdv+K97SxR5ZK2384R12i4wOje3K6np+GJDp3fwDdZ60dI2ySMowQnygkMVDb uqVA== 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=TcgkC7dSbCLJEWpbkUsU5xZrZM5AddVBeoyH2icwoeI=; b=kZCD+HUAKTxqS3Wl+RketIw1chIOAG4i0dQL1Yzakxw0MIS57HqRr6Cyx+Rv9IRyIS flZl8OttN+0Tpn0U6sIRybZtGdSq+rOVozpDkqUspU5txujftQ7bC54HWrlPy84h/8Jm 3wHb5BCx1W/yDLFk4wGxo72Nx7DDWKn5lrJNovQ334WuBtIRiNoOsu6AFvypaWUmKGCq kRW7kFjGcZwdeA6hzH/wu3BT3M989m6pGPSLin6U3N5DsaW/h7/WCjC3NHGjkawBvU4g kkvozBGxGp1zBHKbcBrdYFsMCuP06OC+jaR/3vzFHgI3chUno59XWTQgoi2RALxsu3SX 8/EA== X-Gm-Message-State: AOAM5330Vdr7XCnalDSB7PdNhZ0O1ZQ58O0q3rckyq3Vxcxpe9iBRe1P 2Jwj8hQ1LROCjl09ycsp/eE4Ln6Cc4wosg== X-Received: by 2002:a17:902:6845:b0:168:b675:39e2 with SMTP id f5-20020a170902684500b00168b67539e2mr17250941pln.33.1655113120027; Mon, 13 Jun 2022 02:38:40 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id q6-20020a170902a3c600b00163f7935772sm4629227plb.46.2022.06.13.02.38.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Jun 2022 02:38:39 -0700 (PDT) From: Masahisa Kojima To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Takahiro Akashi , Francois Ozog , Mark Kettenis , Masahisa Kojima , Bin Meng Subject: [PATCH v7 8/9] doc:bootmenu: add description for UEFI boot support Date: Mon, 13 Jun 2022 18:38:52 +0900 Message-Id: <20220613093853.23865-9-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220613093853.23865-1-masahisa.kojima@linaro.org> References: <20220613093853.23865-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.5 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 --- 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"