From patchwork Fri Jul 22 02:39:18 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahisa Kojima X-Patchwork-Id: 592456 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:b811:0:0:0:0 with SMTP id fc17csp100228mab; Thu, 21 Jul 2022 19:38:04 -0700 (PDT) X-Google-Smtp-Source: AGRyM1uGmRTIZxfeLRpPFMScJhTyqLMmOk3DDBQ9gU5DsNKdBC6yIPgk3WnkaANRLikGmIzFUcFO X-Received: by 2002:a05:6638:d51:b0:341:45d7:f5f8 with SMTP id d17-20020a0566380d5100b0034145d7f5f8mr628855jak.149.1658457484226; Thu, 21 Jul 2022 19:38:04 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1658457484; cv=none; d=google.com; s=arc-20160816; b=PJDYF2dx2uuNHFuexQWV2VNBpvszmhsbmOloUd0Q2KVgvcCSIlR5Ve4hPe5XrzOYRG yhqX3Bmsz0756MzY5FkBSt8TGeTCz7fd2mBh72npeCG0puyiK0/13MGLn69e8bkLZ8xg Aj7WzOiXoDWVAiOz1Kfm1zk1sayB8RTiQ5Y6oGxytiLd8EQAlrOE1Q6cCwWhCbdIGRej skKXnapTMuQCyYm70jA9XXXkvJLdcQuxOwwzfGM5aIsDmt+ulCeNLg208LF0jNJEGMW4 d/xylyZ1IeIpjB6lezcb4OuNNiZ2jrVjsAzzh/Ftw0F8qBv4j1uYnjbrdYgQI/fpSmzi L0sA== 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=bBZxTBVIAf+AmW8T2QxctCUseE2ABE2x9Ymen3LBt8g=; b=j5TUh57OAURAP1hT6Ab1JDtu0R0Z6Lp9osd5XlLPSsAQ6LLa0ncLUlpJKdsLNqPJAC uVdL2vXtNYRyLkvF99EWUTc784qNMWxOmTFlacBoM3rH2nXPwIchowkgaq/+yj8AmrJm o4ADiMw36YS7rWWSWoBaeCiNqahI0Tu9LPLgQtsqFmbl/TmtIZYd33FRnjr/0wm9EN0X rH0FLm7xnHvtjPsFSKpS5c1lRLvW0HImoU9gG5EZ2rj9xRsozwq/35kh/czeIW2QnB9s 8z9Hqr7n0ZTK8xU9MxIu+ZfoIRSJFPTystqGlcsE50O8pjMb/rY1FJS3ZZwQtwyNIlXY wCeg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KCkpQvaz; 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 b15-20020a920b0f000000b002dcfe446378si2570232ilf.150.2022.07.21.19.38.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Jul 2022 19:38:04 -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=KCkpQvaz; 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 8B46084117; Fri, 22 Jul 2022 04:36:51 +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="KCkpQvaz"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 0AA7484116; Fri, 22 Jul 2022 04:36:44 +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 autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-pj1-x102d.google.com (mail-pj1-x102d.google.com [IPv6:2607:f8b0:4864:20::102d]) (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 0F37984129 for ; Fri, 22 Jul 2022 04:36:41 +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-x102d.google.com with SMTP id pc13so3216619pjb.4 for ; Thu, 21 Jul 2022 19:36:40 -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=bBZxTBVIAf+AmW8T2QxctCUseE2ABE2x9Ymen3LBt8g=; b=KCkpQvazm+arH7jqVC8MC+YlVqmKlfRkSOK1EF6NXb34Yr30rQkPaAFaRjx3LXJQm3 Bin3/Xwpn4Pbf2cn23XbIRQC60GraUVoL5cxmJM/kiG4hQ87G4oBVLT1sjGY7VWFSojG NCnh/GlFzmtesz6zHf/HBJzZKG7pM9GmC6XkITs9F/j+Sf+Y/2PGE5k/gI8fc/SE3FLm U/WGg2+paa9+l0oC0tEf4gRnnmTwJmCGrLhyGoLtCsRGlr7kCsQx6OtE7/OMi6xnF5u2 0t5RWMP5mEU5jsXvfQg+cQRb4Y2tuXe8lD5UaF/6dMTHIytpKeQv3TGYTOlJ+UpTtmS5 pc3w== 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=bBZxTBVIAf+AmW8T2QxctCUseE2ABE2x9Ymen3LBt8g=; b=Q3GV72iRne1Zp6Craie547zHEiF2pu2u/PJOnydPFzSd5jG1qaiAd1a/Cev33E9O3Q gfdmN8ogS/uYi8ONpfNHr53D9jf6H8jrxgyZ2VsMt8Mmn1DT9gC0YtMP2L80ctCz+e8y +4ElQ/tNwNnSXPumGr6v2Eb+l1tIBPUR/sZutdXJ5RGD/effcOkXEO2SSpR1Rm3zm9ca 26rQH+ms01h+BzbWvbatXwG2tbALYLrFXI4lTdaqehjZBu0/NgtEL0Mateg3KJhwQ2Ou HzQupJmrstZ9UIAIrAks6GPyo0w8S5j0a2FdZupVcjgg42eJVQjMK1qPqIqDE08dOMTu UU5w== X-Gm-Message-State: AJIora9b2pWaDCqmGX+mvOuWL69fkkcKDZMsd0PHh8wVeo1tT2kMB+Lv 2YMMdZ64RAwCkGOP21tzd9l/V1xXYzucGg== X-Received: by 2002:a17:903:11cc:b0:168:eae:da4a with SMTP id q12-20020a17090311cc00b001680eaeda4amr1422610plh.21.1658457399127; Thu, 21 Jul 2022 19:36:39 -0700 (PDT) Received: from localhost.localdomain ([240d:1a:cf7:5800:82fa:5bff:fe4b:26b1]) by smtp.gmail.com with ESMTPSA id k21-20020aa79735000000b0051c758a3957sm2509896pfg.149.2022.07.21.19.36.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Jul 2022 19:36:38 -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 v10 09/10] doc:eficonfig: add documentation for eficonfig command Date: Fri, 22 Jul 2022 11:39:18 +0900 Message-Id: <20220722023919.19676-10-masahisa.kojima@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220722023919.19676-1-masahisa.kojima@linaro.org> References: <20220722023919.19676-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 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 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