From patchwork Wed Mar 30 14:51:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sughosh Ganu X-Patchwork-Id: 555119 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:1248:0:0:0:0 with SMTP id z8csp1316338mag; Wed, 30 Mar 2022 07:54:26 -0700 (PDT) X-Google-Smtp-Source: ABdhPJx0gZ4Gm+NB1Lfxe9ceIizoS/35cXk7Ex2Vm56FbbrRbS1ix0B0s2Lhlb5iCAdDKs4LNR+m X-Received: by 2002:a17:906:19c6:b0:6ce:98a4:5ee6 with SMTP id h6-20020a17090619c600b006ce98a45ee6mr40333955ejd.567.1648652066528; Wed, 30 Mar 2022 07:54:26 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1648652066; cv=none; d=google.com; s=arc-20160816; b=MQeKI5tOlZslGoB2qeEVmgVt7tQoZR0ykgIok72dYnHbBjN8FPBAKZjVeRuvGmhIGE IaCsVoGLNZzmlapZ9AAN1cH5oANfseCwIDepMIEBoQ2RCerd8iB8kHzQZri58uMGVBHv mfwJTYKw6U8sUtYD9ray0BmWcFffgN256Hup47S1gUL+Avshtnzh9f4O/5/nYs6M38dK VuZPvQGbQpyE+OOPA9t0pY30tOCp34rUMXiycRss5NPCQt9EuoJoJCeM/F1ByrqX1ZGh ktKCpGHcaFIyii3AhlQq5isskmfcE26+69F0Wxx2t2gb5iFTnzQQ+kEtQ2U40GcymaPn zbew== 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:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from; bh=ccEeEM4ULkFpET0eH3EO53H6fw/gJRXtg2TYD1X0aeM=; b=E3T5rjDd2Kn8aKUcomHqrF54MqdXUoojDNRPBV3+Ov0t3MYBgPduZpA+XHrPgQIii+ tIWTcJavyG3n/gm5Lk/5AboNplxtvhSgNzwrXBVB2WBPnGuaDHFTD2dnpav6bzcN55Pe cpzA8aaVhi+ZCNvOSiZz6WJHYLpF+Mf5tE4HbNs7WBCY+Lg1Nwql5CxTsIo08tvB0CvY qNzsNZZfkcRw7f5ELfE88AZZ4xL/SzxCdVuLs0IM71a9nyw29c08XWfQKhMtgaCtjhnt Hd7gAoHyMOVRpI0CYZMOorWfMh0KfcPmA/v5Puh3d6AlnWld1nmXk1InZbLLHRQWPu3M F7dg== ARC-Authentication-Results: i=1; mx.google.com; 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=fail (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 u6-20020aa7db86000000b004190c9f1e66si20533946edt.326.2022.03.30.07.54.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 30 Mar 2022 07:54: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; 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=fail (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 D79DC84135; Wed, 30 Mar 2022 16:52:47 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Received: by phobos.denx.de (Postfix, from userid 109) id CC70384142; Wed, 30 Mar 2022 16:52:25 +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=-1.2 required=5.0 tests=BAYES_00,SPF_HELO_NONE, SPF_SOFTFAIL,T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.2 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by phobos.denx.de (Postfix) with ESMTP id DDB788411A for ; Wed, 30 Mar 2022 16:52:15 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=fail smtp.mailfrom=sughosh.ganu@linaro.org Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 379B423A; Wed, 30 Mar 2022 07:52:15 -0700 (PDT) Received: from a076522.blr.arm.com (a076522.blr.arm.com [10.162.16.44]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 562CE3F73B; Wed, 30 Mar 2022 07:52:11 -0700 (PDT) From: Sughosh Ganu To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , AKASHI Takahiro , Ying-Chun Liu , Tuomas Tynkkynen , Heiko Thiery , Frieder Schrempf , Michael Walle , Masami Hiramatsu , Jassi Brar , Michal Simek , Michal Simek , Sughosh Ganu Subject: [PATCH v3 9/9] doc: uefi: Update the capsule update related documentation Date: Wed, 30 Mar 2022 20:21:03 +0530 Message-Id: <20220330145103.1435736-10-sughosh.ganu@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220330145103.1435736-1-sughosh.ganu@linaro.org> References: <20220330145103.1435736-1-sughosh.ganu@linaro.org> MIME-Version: 1.0 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.5 at phobos.denx.de X-Virus-Status: Clean Update the capsule update functionality related documentation to refect the fact that a unique image GUID is to be used per image that forms part of the capsule file. Signed-off-by: Sughosh Ganu Reviewed-by: Masami Hiramatsu --- Changes since V2: * Add a description for adding image index value and definition of set_dfu_alt_info function for the capsule updates. doc/develop/uefi/uefi.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index fe337c88bd..403885d0f2 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -312,8 +312,8 @@ Run the following command .. code-block:: console $ mkeficapsule \ - --index 1 --instance 0 \ - [--fit | --raw ] \ + --index --instance 0 \ + --guid \ Performing the update @@ -333,6 +333,24 @@ won't be taken over across the reboot. If this is the case, you can skip this feature check with the Kconfig option (CONFIG_EFI_IGNORE_OSINDICATIONS) set. +A few things need to be defined in the board file for performing the +capsule upadte. The first is defining the function set_dfu_alt_info in +the board file. This function sets the environment variable +dfu_alt_info. Instead of taking the variable from the environment, the +capsule update feature requires that the variable be set through the +board function, since that is more robust. Secondly, define GUID +values and image index of the images that are to be updated through +the capsule update feature in the board file. Both the values are to +be defined as part of the fw_images array. These GUID values would be +used by the Firmware Management Protocol(FMP) to populate the image +descriptor array and also displayed as part of the ESRT table. The +image index values defined in the array should match the dfu alt +number that corresponds to the firmware image. The dfu alt number can +be obtained by running the following command:: + + dfu list + + Finally, the capsule update can be initiated by rebooting the board. Enabling Capsule Authentication