From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id BC675C32771 for ; Fri, 19 Aug 2022 05:57:29 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id CD21A8480D; Fri, 19 Aug 2022 07:57:26 +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="SRd5mUEL"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 0E00784816; Fri, 19 Aug 2022 07:57:25 +0200 (CEST) Received: from mail-pl1-x629.google.com (mail-pl1-x629.google.com [IPv6:2607:f8b0:4864:20::629]) (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 0D0FE8447A for ; Fri, 19 Aug 2022 07:57:22 +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=takahiro.akashi@linaro.org Received: by mail-pl1-x629.google.com with SMTP id 20so3295881plo.10 for ; Thu, 18 Aug 2022 22:57:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date:from:to:cc; bh=/Z2kdhMh5hIh/Uf54iX9GIedF21i4krgT1+T0zTxPqU=; b=SRd5mUEL1o6R//jg6RWL/IRHCYoYyKospBsap84mye68KbLh3neVwrycqwlEieKxRO dCzpyCHZdR1RKLjn+7Che+ZhvCuvqcoRjeIYl09hgNqOomlSpPmshpqoJ348zqkpPXEO pcftR7jkZ3ByI41n+3JTUDcht7lUoIg+RXQxigCXB6grHJZDEjOJQGUVOWntn9FR26Iu tsslDb4689wy8c651NO0aQwluKoNjb27TA59dCNxC5y/+rvkjcA3YZL8dF4r6/ifViqZ 4kj5IfTSybbdxOyGtOR5qH2ibkeKJdnAQP/xBg4Dl9+C1a86D4EV9e91O/3CX7VC8YY3 SOog== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc; bh=/Z2kdhMh5hIh/Uf54iX9GIedF21i4krgT1+T0zTxPqU=; b=exrD1SyreSdSMmAZJZ3wDiVUHAf5vgIIckI1ZitGv+KsCthkHoJgL+5Tbh5IhvPoI1 Sjbs3AoPLg6Q/fNoShva/kKjX2N9U+TEHb9YhIejJZR3LNRjILZh1fALGoNRGtWt9MSk XAtWt39MutVHWI1cV4WZgSCDVNsE/Dn4pY13TZF8UV8Fkc5bCx+SZl3p5mFi7kTji2Wy IR2KzNZxrPiUYgk6Gh4LZlzGmXvym3OtJZB6qNpf7gkJTa+mX0OwdTv7SwQT6UKcks7h oLwGy5+lbk/OnjksZ0+UL/ypfGefZLcRxVp1xk68tahe6ZSsHs6822eKB4Kp5ZD9ovTo YJAQ== X-Gm-Message-State: ACgBeo1kJLIoBeTe6YqVjN8JKDTHFnKD60NQnCNQ4tP7hGt97ie8Q5ht ka3RCHV/BseMWxIMjiDW062xZw== X-Google-Smtp-Source: AA6agR7p/kkNhZX57wpmklnNZDphE0yNjCz/Xzc8oJ46pUzd28pgPb220/4iWwOYVf273vgk9ujqBg== X-Received: by 2002:a17:90b:350e:b0:1f5:1c63:b563 with SMTP id ls14-20020a17090b350e00b001f51c63b563mr6901340pjb.24.1660888640169; Thu, 18 Aug 2022 22:57:20 -0700 (PDT) Received: from laputa ([2400:4050:c3e1:100:d8f6:519f:2123:6238]) by smtp.gmail.com with ESMTPSA id 123-20020a620481000000b00528bd940390sm2613337pfe.153.2022.08.18.22.57.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Aug 2022 22:57:19 -0700 (PDT) Date: Fri, 19 Aug 2022 14:57:14 +0900 From: Takahiro Akashi To: Masahisa Kojima Cc: u-boot@lists.denx.de, Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Mark Kettenis , Bin Meng , Marek Beh??n Subject: Re: [PATCH v11 8/9] doc:eficonfig: add documentation for eficonfig command Message-ID: <20220819055714.GA72617@laputa> Mail-Followup-To: Takahiro Akashi , Masahisa Kojima , u-boot@lists.denx.de, Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Mark Kettenis , Bin Meng , Marek Beh??n References: <20220817093614.32266-1-masahisa.kojima@linaro.org> <20220817093614.32266-9-masahisa.kojima@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220817093614.32266-9-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 On Wed, Aug 17, 2022 at 06:36:13PM +0900, Masahisa Kojima wrote: > 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. Right, and when user quits from eficonfig, bootmenu also quits. *If possible*, I expect that we return to bootmenu's screen directly for better user-experience :) Otherwise, we have to enable U-Boot console to re-invoke bootmenu. (we can instead reboot U-Boot, though.) -Takahiro Akashi > +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 > -- > 2.17.1 >