From patchwork Fri Sep 2 14:23: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: 602179 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:4388:0:0:0:0 with SMTP id w8csp1509976mae; Fri, 2 Sep 2022 07:23:55 -0700 (PDT) X-Google-Smtp-Source: AA6agR5cufBoEk+giE1E7ah8ewEmnSx7KC5242bQZtz/wXFS2tGO45OOQ4ZBRffGHQguccgVv+FL X-Received: by 2002:a17:907:72d6:b0:742:133b:42be with SMTP id du22-20020a17090772d600b00742133b42bemr12912744ejc.581.1662128635216; Fri, 02 Sep 2022 07:23:55 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1662128635; cv=none; d=google.com; s=arc-20160816; b=DvNS4Ox7NC4pEIIBoEE3CtqKXLDTwmXsJk7LQuo03A6PayJhwj8Il/zeiieoXbPSAr fghhgsD0xR3mJP3FN0UbfpWsaFMgx8JAWal6ht4wUooVMx6XmNmqlmxbWlOmz/+QtRmy P3nmn2Wn6+XS7QixW3CQv1tJnljMfXZJWma27WL/ECH3ARAyV9NSGcOMbYePOs0udoBy uSgQYKyBwPbPa8gM8FMEHc6j3Sbpn3zAVgVSAtySkX0R9WsjjtuUyZb3Sy4eJn32+XUD mriZGG+DXYBqcQ/8i1y2P/GwgtIvI7hrRHv/PEMg99Y7Mmvvm2t9ruCLH9+Gxq/F+Tu0 mBDw== 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=WrDJxlh8LkANWAkJ37kLHdJ2DlUQiMncLUzDnQOCRb4=; b=J4h4k1Oqer3C1sApKC21/q2TrjU6iV8id8RikHQMHlx2ClWff7mcbD8IfYGB0qNU2c d8WXVX6Xs2c14HLs80tZw4gDBCjxklvRrIKZE2Ze+nEuGbIL34bR+Z4UvyeQSmp1pPJU qShZ3HPD1iBBJT8mkuT5WVWVgYiSYyOQA4DX7ouHkRSnoORRr94DnGt2FfONQyHJzZBL /i1IwZ757p6TnIJe7c0CL4MJj+BWZrQfTA96ZkrWEAx3m+zFjiq7+8Q/c0dDzRwG1iZt +vG1Oe/QEYOg5mZ2j1NqbcTJQHU9KMyVa99hhdRtdOMluuN2PTi22CXrxAZrA+BtRwXO oEWw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=e68pLVzs; 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 h19-20020aa7c953000000b00446d2362b7esi1748937edt.539.2022.09.02.07.23.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Sep 2022 07:23:55 -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=e68pLVzs; 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 2FA2684AF9; Fri, 2 Sep 2022 16:22:40 +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="e68pLVzs"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 066C084AF9; Fri, 2 Sep 2022 16:22:39 +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-pg1-x533.google.com (mail-pg1-x533.google.com [IPv6:2607:f8b0:4864:20::533]) (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 29C9184B00 for ; Fri, 2 Sep 2022 16:22:34 +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-pg1-x533.google.com with SMTP id b196so2102049pga.7 for ; Fri, 02 Sep 2022 07:22:34 -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=WrDJxlh8LkANWAkJ37kLHdJ2DlUQiMncLUzDnQOCRb4=; b=e68pLVzsFfw+gVJMDVoFaUP8dp+rwHL1qDaQgNImA665Qa6+q42UI4r5ucvA4tUo6s Qhul90QtOcFn1W2JDdIJceOv1tiSq86PQ1P8mmlWyFtNKSR8/PvbyjIOTEH8gsIW8UJ4 fbZXq3afZiGbuits2Q0hHgjUzT7Z71z2jl8FRRGNtp95/mOAkP787ftNH0NRq+VvyJlE KS45suItebBGfabUSQgqWKYiCpoo3ve6CrhXECb9EFCDksjaXBYU3BbWysOOWDfFV6YM iXleJKFV6GqqUahn5a3nkpbb2Q/Q8vqu8ILT/aBuHQ1lhUv/WEjbC2c9vBbNQfK9nS3b fwXQ== 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=WrDJxlh8LkANWAkJ37kLHdJ2DlUQiMncLUzDnQOCRb4=; b=KsDWGzOi1uKIQLII8ez1Z6kqgmWl5dcFcj20Eo+tQJGl0ecHj76ySsHovhdTDupkf7 emG1R4P1SWGDtEYVbh9jh0JHD+od6xkHHse9EPrYYylMiO/vUhF+PyduJpRqFbO7cSTj jaiYXjM5tp8vpKkIYXUylVjDZA8vHvTW/C5pJ+eGpH7ZHAP/XOT++d2AQ0XlsH3QtiLn 5esnQ5z0AQImEaxmyfN1UMqheR02+NNyVVqaar2MqCRZa0Bq9ocFJ5B4nQW7++j4zXNZ WBfoJPx+55K6WAjcfgpyHc0kf/8nsX6jq6WkWrO8+U/B4Ut24mzyt2MX0J2ZDC/0uUVw 2Yfg== X-Gm-Message-State: ACgBeo2XXwFEZzMzv8EA2a5omAW3iXbblIJkUCeuS/59F364ctbXx7j3 k5hdC9pXcgVtwU/ZAnNShVeBOwKYlLGSGg== X-Received: by 2002:a05:6a00:ccf:b0:536:4dbe:b948 with SMTP id b15-20020a056a000ccf00b005364dbeb948mr36704521pfv.67.1662128552305; Fri, 02 Sep 2022 07:22:32 -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.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 Sep 2022 07:22:31 -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 , =?utf-8?q?Marek_Beh=C3=BAn?= Subject: [PATCH v15 09/10] doc:eficonfig: add documentation for eficonfig command Date: Fri, 2 Sep 2022 23:23:48 +0900 Message-Id: <20220902142349.16722-10-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 Add documentation for eficonfig command. Signed-off-by: Masahisa Kojima Reviewed-by: Ilias Apalodimas --- No update since v15 Changes in v14: - fix typos Changes in v13: - describe how to auto boot according to the UEFI Boot option Changes in v12: - CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE condition is added to show newly added boot option No update since v10 Changes in v10: - describe how to boot system after editting by eficonfig Changes in v8: - command name is changed from "efimenu" to "eficonfig" Newly created in v7 doc/usage/cmd/eficonfig.rst | 71 +++++++++++++++++++++++++++++++++++++ doc/usage/index.rst | 1 + 2 files changed, 72 insertions(+) create mode 100644 doc/usage/cmd/eficonfig.rst diff --git a/doc/usage/cmd/eficonfig.rst b/doc/usage/cmd/eficonfig.rst new file mode 100644 index 0000000000..340ebc80db --- /dev/null +++ b/doc/usage/cmd/eficonfig.rst @@ -0,0 +1,71 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. (C) Copyright 2022, Masahisa Kojima + +eficonfig command +================= + +Synopsis +-------- +:: + + eficonfig + +Description +----------- + +The "eficonfig" command uses U-Boot menu interface and provides +a menu-driven UEFI variable maintenance feature. +The "eficonfig" has the following menu entries. + +Add Boot Option + Add new UEFI Boot Option. + User can edit description, file path, and optional_data. + +Edit Boot Option + Edit the existing UEFI Boot Option + User can edit description, file path, and optional_data. + +Change Boot Order + Change the order of UEFI BootOrder variable. + +Delete Boot Option + Delete the UEFI Boot Option + +Configuration +------------- + +The "eficonfig" command is enabled by:: + + CONFIG_CMD_EFICONFIG=y + +If CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is enabled, user can not enter +U-Boot console. In this case, bootmenu can be used to invoke "eficonfig":: + + CONFIG_USE_PREBOOT=y + CONFIG_PREBOOT="setenv bootmenu_0 UEFI Maintenance Menu=eficonfig" + +How to boot the system with newly added UEFI Boot Option +'''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +"eficonfig" command is responsible for configuring the UEFI variables, +not directly handle the system boot. +The new Boot Option added by "eficonfig" is appended at the last entry +of UEFI BootOrder variable, user may want to change the boot order +through "Change Boot Order". +If the bootmenu is enabled, CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is enabled, +and "eficonfig" is configured as preboot command, the newly added Boot Options +are enumerated in the bootmenu when user exits from the eficonfig menu. +User may select the entry in the bootmenu to boot the system, or follow +the U-Boot configuration the system already has. + +Auto boot with the UEFI Boot Option +''''''''''''''''''''''''''''''''''' + +To do auto boot according to the UEFI BootOrder variable, +add "bootefi bootmgr" entry as a default or first bootmenu entry:: + + CONFIG_PREBOOT="setenv bootmenu_0 UEFI Boot Manager=bootefi bootmgr; setenv bootmenu_1 UEFI Maintenance Menu=eficonfig" + +See also +-------- +* :doc:`bootmenu` provides a simple mechanism for creating menus with different boot items diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 28f9683a3e..09f2928970 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -35,6 +35,7 @@ Shell commands cmd/conitrace cmd/dm cmd/echo + cmd/eficonfig cmd/env cmd/event cmd/exception