From patchwork Tue Oct 10 09:10:55 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sughosh Ganu X-Patchwork-Id: 731425 Delivered-To: patch@linaro.org Received: by 2002:a5d:574c:0:b0:31d:da82:a3b4 with SMTP id q12csp1634315wrw; Tue, 10 Oct 2023 02:12:32 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHLcCTDjB8mqMOuG0CMvTal9EOcBUQsXx9J4yCSNUn7U/0xnmfcrVk3GiVqfIVeqy2UpUdn X-Received: by 2002:a5d:5d88:0:b0:32d:5eeb:2a53 with SMTP id ci8-20020a5d5d88000000b0032d5eeb2a53mr644292wrb.4.1696929152580; Tue, 10 Oct 2023 02:12:32 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696929152; cv=none; d=google.com; s=arc-20160816; b=0UmlSc5DeuEtB9Ft5kN3PfApYsgBmnd9LOpYkqtpSmCXAE1vUX0w5eVwSoNmHkKamh jGnO64vwiiQbPd7KwEQcm4E037bXmyAYYeQS2fxTbSETn3A+P7ZzodkyynsHqrWN0cow cVXoGRwAGsyVW+Ud5BpIldaQZvvdDe+OP+7yjnjY75tjfq5sxx7bVXPP6p8anDYnYYLH HvPCJ0ldcGOKUXfGzmTqkaGYnT+9OtGeXheuaJQQNvMiYPhvJV2cG4wBrxBNwUzr4Xwv w2VY633L0tqbH2tgHhPm0nklvSjFdzMoDr07hlgjPiWT5Hnr3YXhRORYzGY/ITng5TDb 5h8w== 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=+DevlV1odRxDfegnJpLIy1sdy3WsNwyQRUHQxZRL5dY=; fh=GFi6yKGMx/0zdTg+7jHYbY+NaEzlEBFVO9Bq4SjQnp0=; b=th+02wj/a3j30apM7iYCfctV/DlgTZ/cfuW3UBh0GKJXWXtgs4iI4OJ6uUtOXna5nC zHAdCdol5hf4hEIDx0bxbDX/r9CRTjTMy0Fv8so8fWPN0PxI4g+HzRy1/WJRNiRm5bo2 Tt/5SJkaBBZJfKEKao9pnco9j+uw18rKpMLTe+d9195h8gsmY6YWfrf9CilmFM5kZYJH 2q7AgKsj7BsHu8HStOuNQswRNn8N6QX/3DdTkqh6nXlqZh26nNL8qInJ+HZYtRKED0+2 32naC+DZmY3Q8JKkXdOhjgHV1n+P8XZSIb/PH9JFIV95L3fiu6CRfHB467IQUosEfmZs CnmA== 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 r13-20020adff70d000000b003143a52bd59si4640223wrp.228.2023.10.10.02.12.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 10 Oct 2023 02:12:32 -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 ADACE86DEE; Tue, 10 Oct 2023 11:12:15 +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 B100C86DC5; Tue, 10 Oct 2023 11:12:05 +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 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 894C886D85 for ; Tue, 10 Oct 2023 11:12:02 +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 188501FB; Tue, 10 Oct 2023 02:12:42 -0700 (PDT) Received: from a079122.blr.arm.com (a079122.arm.com [10.162.17.48]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 2A5DD3F762; Tue, 10 Oct 2023 02:11:58 -0700 (PDT) From: Sughosh Ganu To: u-boot@lists.denx.de Cc: Simon Glass , Heinrich Schuchardt , Ilias Apalodimas , Takahiro Akashi , Tom Rini , Sughosh Ganu Subject: [PATCH v2 2/6] doc: capsule: Add documentation for the capsule dump feature Date: Tue, 10 Oct 2023 14:40:55 +0530 Message-Id: <20231010091059.375036-3-sughosh.ganu@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231010091059.375036-1-sughosh.ganu@linaro.org> References: <20231010091059.375036-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.8 at phobos.denx.de X-Virus-Status: Clean Add documentation to explain the printing of the capsule headers through the mkeficapsule tool. Signed-off-by: Sughosh Ganu Reviewed-by: Simon Glass Signed-off-by: Sughosh Ganu Reviewed-by: Simon Glass --- Changes since V1: None doc/develop/uefi/uefi.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index 68f9b332d1..f16580e169 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -385,6 +385,23 @@ capsules. Refer :ref:`etype_efi_capsule` for documentation about the efi-capsule binman entry type, which describes all the properties that can be specified. +Dumping capsule headers +*********************** + +The mkeficapsule tool also provides a command-line option to dump the +contents of the capsule header. This is a useful functionality when +trying to understand the structure of a capsule and is also used in +capsule verification. This feature is used in testing the capsule +contents in binman's test framework. + +To check the contents of the capsule headers, the mkeficapsule command +can be used. + +.. code-block:: console + + $ mkeficapsule --dump-capsule \ + + Performing the update *********************