From patchwork Fri Jul 15 14:47:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 1656928 X-Patchwork-Delegate: xypron.glpk@gmx.de Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: bilbo.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=WF/7RDRJ; dkim-atps=neutral Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Received: from phobos.denx.de (phobos.denx.de [IPv6:2a01:238:438b:c500:173d:9f52:ddab:ee01]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by bilbo.ozlabs.org (Postfix) with ESMTPS id 4LkvMk01Rpz9s07 for ; Sat, 16 Jul 2022 00:47:13 +1000 (AEST) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id B723D82A35; Fri, 15 Jul 2022 16:46:01 +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="WF/7RDRJ"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 6DCF0819B1; Fri, 15 Jul 2022 16:45: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-x1030.google.com (mail-pj1-x1030.google.com [IPv6:2607:f8b0:4864:20::1030]) (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 F028881872 for ; Fri, 15 Jul 2022 16:45:38 +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-x1030.google.com with SMTP id i8-20020a17090a4b8800b001ef8a65bfbdso6302625pjh.1 for ; Fri, 15 Jul 2022 07:45:38 -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=vuLfgFvgZHZ4kdb0w0HXLMs9Pp7vocINI2Oojq9LWDs=; b=WF/7RDRJAY+OVZRl6EVRbRvr4w4phUQnEsqI+pkgrcFHtO6bCtz5MnXhdTqPhHPFb1 4nSt1Tuk8uKSD3n70skYWJoHeQYF0dRkNQRW/knRliqXzO0XNevv8NH9Qb1vXdgw4uyO 3i/rtmCi6l/qzDy/vnu9Ww7nEjUyslYxc+swlYiuDUZG0KnY4ikD0E7ZJM9DtoBW9xu7 ElQufUE67WywvmdtkbDvadeZFSeZaPrZgMH0QgQcjkH3U0U2FeZiCJkWj1PXjeuJBHd1 4OtVmBpzB1vioSM/nO31y0fOe281sK5bK759Wr/Swbh9IOioKyBXQh5bBntuxViIMpaS qSZA== 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=vuLfgFvgZHZ4kdb0w0HXLMs9Pp7vocINI2Oojq9LWDs=; b=TE40w5JYpj/8wQWB0sy4sX08H0jJTLHnfRfaPf2vhVgkkBIQl+boUdJlfETvJofGfp v5S4j1HvvK6lFGYNWy7hbQcMLUxiOfN5ayXgDUMpfYrm0KXCUS198BW6oaAtspN4q1uV J9oFicIvWsTpZgoxKLwwqDl06xiYOtHhQcXOr1jaR9bo3lZEohrF4bS0HMbX5qE77suO tVx4eV/Ujrlebi8WSTJ+dssWCOrK71gTmTJDO0+y4B7LQOUC9cdHnqUH6erDKODGTMS/ fsuiHZ5+ykK2QmYRJyrFmychAtcZiwKuDCejKoKzjfn0HRVKyqQWsR8GRCXVP8dNsqg1 4yeA== X-Gm-Message-State: AJIora+XFJZ0diZki6//GppSNRLDERht2qJLsSkZCFR3yI50NcjIdMbt XgQKvQqc+xRbY7eF1lJ1oRR9vvKseskGnA== X-Google-Smtp-Source: AGRyM1sXvnzKzf5DsrYEdEM0o64+OI2RtBNQUvbTku9p+pR8E8O+lODWDZbENcCyZ7/7eQ/phcljkA== X-Received: by 2002:a17:90b:2250:b0:1f0:768a:1ae8 with SMTP id hk16-20020a17090b225000b001f0768a1ae8mr15886854pjb.17.1657896336913; Fri, 15 Jul 2022 07:45:36 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id u16-20020a170903125000b001690d398401sm3719923plh.88.2022.07.15.07.45.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 15 Jul 2022 07:45:36 -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: [RESEND v9 9/9] doc:eficonfig: add documentation for eficonfig command Date: Fri, 15 Jul 2022 23:47:49 +0900 Message-Id: <20220715144749.30564-10-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220715144749.30564-1-masahisa.kojima@linaro.org> References: <20220715144749.30564-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 change sinch v8 Changes in v8: - command name is changed from "efimenu" to "eficonfig" Newly created in v7 doc/usage/cmd/eficonfig.rst | 49 +++++++++++++++++++++++++++++++++++++ doc/usage/index.rst | 1 + 2 files changed, 50 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..f150d7301c --- /dev/null +++ b/doc/usage/cmd/eficonfig.rst @@ -0,0 +1,49 @@ +.. 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" + +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 8b98629d6b..1afbb6bc5d 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