From patchwork Wed Aug 17 09:36:13 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 597847 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:b345:0:0:0:0 with SMTP id w5csp3087690maz; Wed, 17 Aug 2022 02:37:28 -0700 (PDT) X-Google-Smtp-Source: AA6agR795lLAxGd3YxTbIH96Nei5QbzzZBtpsRmsXBI9o0dlns8fDcSBSxJ18uijwitDiIdeTUQh X-Received: by 2002:a05:6512:1395:b0:48d:81c:5159 with SMTP id p21-20020a056512139500b0048d081c5159mr9436133lfa.375.1660729048094; Wed, 17 Aug 2022 02:37:28 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1660729048; cv=none; d=google.com; s=arc-20160816; b=g4N3Tz5C9wIxUDqpYbTMcT+CpSxylzA1005EuqZGbdk4dq4nyEf09Fcjjr4bDYKLXh 2TLcmsZHq6DSn/YmS7eqW0P9WjAOiNKz23WxHeAwVNbuVG5s0ZLruFel40EufdI/6D8R WdSbreFeGVHDhS4ybiZmSP5hWIoGbwT5Ywn49+8jHESdM06YkDKsd1KL7uKDepdrPd2I BK68LThfaOLTiEkmhbVgG2Uma1UnCCQhpWCSeYMBKweeqhMdJ9khMpDkAYZEr0xptc/K /MgMcJkJ0y94PPuOSDnMvGmpbMp35mFfQvNMK6h2U4WvjYHGBBEzwVEmOaA09pY3liGJ nAIA== 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=Fh5fDW1npCkrR1mX+ONLsDky1DYGXskpvHHi5cKcJCQ=; b=BWpibZB2839JWDJA7vXDYiePMqmS/50NiOhNgVzj0sUKwZWxmq5mAQVZMMyWJOMZ5w RQ/q6LsrOFDhyHjraQh3uNkKnldTCHccB7E05HBop5I+JQGyzPnlYNuoCeaHd5447Gp2 kRWQ7Ts1g1oXKQO+yrNLEyz61kC5dfvwRTFJb4RmB2ia4JGy6ijXIwuVwoOqKg382ls0 L+vo0RRSvEQ+/KQRW1mT/Aox4rIjzW1GZ+xWiYEEa1+kz6ptW16CabspQEziO59Fi0I0 mqB3FdbyAC3l1dqd4Pnc6MQaqKa5oshymvQFVVTDBEM71vJ6QP3ReDGRKmO10Edh8CQT lp+Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=RxVjPHAq; 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 x15-20020a2ea98f000000b0025e5335d849si7950508ljq.18.2022.08.17.02.37.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 17 Aug 2022 02:37:28 -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=RxVjPHAq; 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 6F94984A1D; Wed, 17 Aug 2022 11:36:18 +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="RxVjPHAq"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id EE83D84A12; Wed, 17 Aug 2022 11:36:08 +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-pl1-x635.google.com (mail-pl1-x635.google.com [IPv6:2607:f8b0:4864:20::635]) (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 91F1084995 for ; Wed, 17 Aug 2022 11:36:03 +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-pl1-x635.google.com with SMTP id 2so341924pll.0 for ; Wed, 17 Aug 2022 02:36:03 -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=Fh5fDW1npCkrR1mX+ONLsDky1DYGXskpvHHi5cKcJCQ=; b=RxVjPHAqeagGyeOI8eikc4R7AdbgylP5uZ7RfR9Z8FNvHfXoCsXmimYlZivw0P/49C 3DUAxEwG1ggR5PnczdJy8/V6BZMNnlO36GQHYygWQ/6T/ub8/QRiJmzEdUUbip13X7qI XobAz5Uv6xdZ4nE8ECIfjavMtNvYF19zyZq68hyk4vbsEfdulqh7WwJjM5m9utKIJjT7 XkitKY9k6pJsrwKT9AmzXgf415yjRRJ2P7vjHHsaiMCqJZ8fMr6AkR9LNZZob8ktnj7W i1BCJ5jYc+aB4pK2B4/32ow6S9nF0KCw2Y5OrTLxbM13nxAUv3zR2YAXTPB+BhlGYSto UNhg== 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=Fh5fDW1npCkrR1mX+ONLsDky1DYGXskpvHHi5cKcJCQ=; b=W/FMYKutmXw/go+lb+jQyVETqlLB05BzuvxIoyI2AFn3zQoLUbxH6fxGHNbJjz8iL2 d7fM0PFYdDiTO6Moz64XNnTb+19+5h/my7JiJGPSrNK5L9okrWi19wbkp3GIyWrQsqoi wMmzpec1pqSuhUQ8N+P/0KIY7CPBsE4utoozEawOULIbaIzo1K5+ynQu0I2SIN33ck4e dfty6K06z2jLIHmKihX8ymB9qtOYX84NL9Y798STAFPhA1HVfWJpQQvLluABd9OI5x5F o6Qp9KPd0I2c/EUG66m5CWxRisO6dYKxBw6M4kLxoA+cqJRIRqxGHxMnnyk3jDieQDzr y+6A== X-Gm-Message-State: ACgBeo0TdN4IMCzCLlCVYHPKBIbfv8nmoQ6b7R+wfxt3dIFi5H6AuP/a nk1LaRgjfk0QEL0DX3Jd53cgz4Xjcgn7Mg== X-Received: by 2002:a17:902:6808:b0:170:9453:8203 with SMTP id h8-20020a170902680800b0017094538203mr25743913plk.24.1660728961669; Wed, 17 Aug 2022 02:36:01 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id q16-20020aa79610000000b00528669a770esm10214285pfg.90.2022.08.17.02.35.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 17 Aug 2022 02:36:01 -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 v11 8/9] doc:eficonfig: add documentation for eficonfig command Date: Wed, 17 Aug 2022 18:36:13 +0900 Message-Id: <20220817093614.32266-9-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220817093614.32266-1-masahisa.kojima@linaro.org> References: <20220817093614.32266-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 --- 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 | 63 +++++++++++++++++++++++++++++++++++++ doc/usage/index.rst | 1 + 2 files changed, 64 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..958e96992c --- /dev/null +++ b/doc/usage/cmd/eficonfig.rst @@ -0,0 +1,63 @@ +.. 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 privides +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 to configure 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 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. + +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