From patchwork Wed Aug 24 04:27: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: 599719 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:4388:0:0:0:0 with SMTP id w8csp2894783mae; Tue, 23 Aug 2022 21:28:27 -0700 (PDT) X-Google-Smtp-Source: AA6agR7TzERlxtmpNLn65pHRsS1OBK9Xro90u04hoikV5D+ZUmT1p9ZhWR9HyLSj0FpSchWA3mCV X-Received: by 2002:a05:6402:5c9:b0:446:fb0:56bb with SMTP id n9-20020a05640205c900b004460fb056bbmr6164833edx.173.1661315306915; Tue, 23 Aug 2022 21:28:26 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1661315306; cv=none; d=google.com; s=arc-20160816; b=YJYPf60byDeOn7QhwVBswtD7Itw/KhbR/JGiTVF6sE8s8pc4FBqHTgpd33yF95VKpe u+xZgiJdkxQIWfZ/BhuhNYL7nsrIzpBi2JQOHwvUHKkcQUiQL+aFt7LBfMi8zsn+zoqU SKOONjzOkbBjBitXhkZy0uRBJRS0CIXY8AdUXywB4PII60Vz5n0QeiWIXU99UfZfGsgq Fhe+mkwm+VT2k9lM5GsUiI2Nan1GjOJQ4e3oJYTgOzPdRH1SlCsPNhDqfbZlRkGA1be7 cIM+Um+VPnsKaxyOSoyt1vQOElEWvxUGZpDKMIY2dWnZQ3d83j5d52yx3zMg57fDAB6H GoUw== 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=fXFBvaik/9bM2FEJSejqOUiRFbF3yYvbXlnFsXX/Rgw=; b=vazeeZ7MIeN7z2Zg7PlSuLuwlJlwMMB5YAKGbxRjefMKIJ/NK82bJjaWZDkBTvtnDF 24nVY7951sSQz7ZMNfwCkXCOjJSt+zSurcVHRzWpPjWoRB/9oipddBZl4AHKhujtbb6m WGlj3GzQ1VFmzdK4TvV1SzOIcB4E7A/9kX9G+mwtQ0f7Wb0/1bfb3hnLyV2+V1qXRy7B ODeztNIHWk6J9Zh+xO2CvlnQI70ncJnazZ1beS93LKgXEv3WjyZ5SRriOnWC7RUcrpQJ gEwv0GqqKD7eFa8EL2JF0a1z1k1b5//Wm7p2ylbxEqeAgoh9db5rQg6ckQi5cckQz+0a depQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=OMInhFZ+; 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 sd40-20020a1709076e2800b0073156b6fe1csi1249050ejc.799.2022.08.23.21.28.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Aug 2022 21:28:26 -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=OMInhFZ+; 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 9CC068486B; Wed, 24 Aug 2022 06:27:28 +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="OMInhFZ+"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 49CDA84841; Wed, 24 Aug 2022 06:27:15 +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-x102e.google.com (mail-pj1-x102e.google.com [IPv6:2607:f8b0:4864:20::102e]) (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 6C46884841 for ; Wed, 24 Aug 2022 06:27:11 +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-x102e.google.com with SMTP id o14-20020a17090a0a0e00b001fabfd3369cso340786pjo.5 for ; Tue, 23 Aug 2022 21:27:11 -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=fXFBvaik/9bM2FEJSejqOUiRFbF3yYvbXlnFsXX/Rgw=; b=OMInhFZ+o/oGdOilVeMtss3aRBeZ++f1U5EELNfv/ZqNHwvd9B1BxEl91iSGzb06Lh hl1ktkXla1X5L9pdMMycp01QgSiLUNSKszgQjoUzp4h8CaAsTbz2SgguLq53ciISy31d pDIQcoLb4rMZquJMvMakYuY5pBNCrj4/l1e0FKrC5MaPVym+/OakbPyAFtZMgixhzSiN PcY19fkRwG0ENZCRQMRH82Zf2ZCVdbbXjazF6NhSUE5hkRtoD6t9riJ3lQiZD54OehfB MtLGRYUuZmphNrWADd83c3jERwiHtZVWVxfy91y/SFAUa5gsMpd5oEPoVYeD5YcPZ+lh +ipA== 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=fXFBvaik/9bM2FEJSejqOUiRFbF3yYvbXlnFsXX/Rgw=; b=F3Uzm4/H+R/HAgqN1zodwgkpd13ChKVF2v/YRVIhZj5zRX0vQqLl+3xBeVpvh2GB1U JV7tJHtc6orzQ/psabNEwrSDeFNHOBfzdqjmwTN6lQIjJWwa8/ZioRAnuXJODWpml124 qRufPEZT8tPIMa3WbhYP+BQdY9FX+RmQ6A4GaM1wVBlAffbhBudl+fZtc/Y5dRIcIP/S zqNsUn+SrbXvPR0xPGYToDgIpRIoMloc3x2R3M40xP/TvkqNqZewyZMdZkQ5y6GvlhKh qzgLyvT78V9CeDvdkvPbFPbL5ihAlD7oiddBWBq+3s9cHGaINVjk3rFJND8U6qOWgl1o YRuA== X-Gm-Message-State: ACgBeo1WwVFWZpwnNuo3N5o0CR8pYGcL650MSZqYm0a3iH7YlbOS3Hd8 nyefhNmlPr2pq1PBNz4sknWtvuAwsGN96g== X-Received: by 2002:a17:90b:4ad1:b0:1fb:5d3:3a36 with SMTP id mh17-20020a17090b4ad100b001fb05d33a36mr6392913pjb.174.1661315229031; Tue, 23 Aug 2022 21:27:09 -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.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Aug 2022 21:27:08 -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 v12 8/9] doc:eficonfig: add documentation for eficonfig command Date: Wed, 24 Aug 2022 13:27:48 +0900 Message-Id: <20220824042749.27434-9-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 Add documentation for eficonfig command. Signed-off-by: Masahisa Kojima --- 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 | 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..52cc7b900d --- /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, 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. + +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