From patchwork Fri Apr 19 06:55:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sughosh Ganu X-Patchwork-Id: 790185 Delivered-To: patch@linaro.org Received: by 2002:adf:e6ca:0:b0:346:15ad:a2a with SMTP id y10csp921951wrm; Thu, 18 Apr 2024 23:56:28 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCVZrkqTFRqLJ7KxpDKS3U1UEQWu+Olt1KOFXWc0XhlQDKsOgmeURf/ll/CAIz8fd4IxgzD68AyH0NjGMe36vF6i X-Google-Smtp-Source: AGHT+IEcN4l6cYI9ard0cJiGDymhNRgvStGfdnMfCEWRMDShb9c8beRpKv60UHorOHK9pN9cV8bV X-Received: by 2002:ac2:5046:0:b0:519:295a:2d63 with SMTP id a6-20020ac25046000000b00519295a2d63mr724161lfm.23.1713509788510; Thu, 18 Apr 2024 23:56:28 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1713509788; cv=none; d=google.com; s=arc-20160816; b=FXmjHbScsVxoaVpaPFkx6H58/j1MOJBFeNzmw3h+/KMgd5JMRkdWCdm/+5Ma1nc/wZ yA1CP009IzLBt+kJS/NCkgr1DJtr1OeAFyMEkdJgvnsRbxWMSkUBbqN+PaWUxrsDt1EU qSehA31K6K4rLJGLW2stdZPFZnVg9DhgMihFsUhyFlzzbNKOjKrzXQ+2Sr10mKVrmwpT hO/e4DsDeH8xVdwf/YOOm4J058kzbNeeKUeJzknYcpxRDYHYiZ4dPPm3oSV/HOb79aFz S2nsc8YP4JLLKPO77LUvpwW+xateI8kKyu7tQpUqVO4ehNXA2ohjLq1fRJ4AHuRF+Qkb vaHQ== 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=pBukuCNXz3u67WZzXyBbYWPR5C9G4kUdGd0JkBQF70I=; fh=WsxX/MtpAy/GihNoM0Uw3JmpOQd9TnDQAtsquJqrNec=; b=Ya8D1jeu8PrZisD5N4m+Iluy+CBx1xNW0bA0vTEQZHRMqLs87PLPgmNQR7E/9psSns tNpv9dDcAJ4t62PRQ0+uRldNEqlJruzDN7rBUJP9+jK+JnyYhslaqTAyI8v5jjrGFVIc yfdL3LXdkujBU/PPBilNj9vXS1N8nPI151DiocGldbKIZiYVxT2QY3bte1Sw2vIb2Hpa I/l9DxpU0gIrAvx5EGBs13iB4/xZ94O9ofBrCNKpFxj4HNXt2UWV2yGF3/7SxraM+Mg9 TxMyBtKugOTKYZKvzmpGcpO2i+Gq0jtvnxiFhZUSAQS5Hj730nS9CMpcyoNmHRYq3bjP z1Ag==; dara=google.com 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 b9-20020a1709062b4900b00a522935d52dsi1725820ejg.162.2024.04.18.23.56.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Apr 2024 23:56:28 -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 D3A99886D0; Fri, 19 Apr 2024 08:56:13 +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 CE89F886C6; Fri, 19 Apr 2024 08:56:12 +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 D218388684 for ; Fri, 19 Apr 2024 08:56:10 +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 65CDB2F; Thu, 18 Apr 2024 23:56:38 -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 3E4A93F792; Thu, 18 Apr 2024 23:56:08 -0700 (PDT) From: Sughosh Ganu To: u-boot@lists.denx.de Cc: Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Tom Rini , Sughosh Ganu Subject: [PATCH v2 2/4] doc: Document capsule generation through a config file Date: Fri, 19 Apr 2024 12:25:40 +0530 Message-Id: <20240419065542.1160527-3-sughosh.ganu@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240419065542.1160527-1-sughosh.ganu@linaro.org> References: <20240419065542.1160527-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 The UEFI capsule can now be generated by specifying the capsule parameters through a config file. Highlight these changes in the documentation. Signed-off-by: Sughosh Ganu --- doc/develop/uefi/uefi.rst | 70 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index 0389b269c0..8586127a83 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -318,6 +318,76 @@ Run the following command --guid \ +Alternatively, the capsules can be generated through a config +file. When generating the capsules through a config file, the Kconfig +symbol CONFIG_EFI_CAPSULE_CFG_FILE is to be used for specifying the +path to the config file. + +The config file describes the parameters that are used for generating +one or more capsules. The parameters for a given capsule file are +specified within curly braces, in the form of "key:value" pairs. All +the parameters that are currently supported by the mkeficapsule tool +can be specified through the config file. + +The following are some example payload parameters specified through +the config file. + +.. code-block:: none + + { + image-guid: 02f4d760-cfd5-43bd-8e2d-a42acb33c660 + hardware-instance: 0 + monotonic-count: 1 + payload: u-boot.bin + image-index: 1 + fw-version: 2 + private-key: /path/to/priv/key + pub-key-cert: /path/to/pub/key + capsule: u-boot.capsule + } + { + image-guid: 4ce292da-1dd8-428d-a1c2-77743ef8b96e + hardware-instance: 0 + payload: u-boot.itb + image-index: 2 + fw-version: 7 + oemflags: 0x8000 + capsule: fit.capsule + } + { + capsule-type: accept + image-guid: 4ce292da-1dd8-428d-a1c2-77743ef8b96e + capsule: accept.capsule + } + { + capsule-type: revert + capsule: revert.capsule + } + +The following are the keys that specify the capsule parameters + +..code-block:: none + + image-guid: Image GUID + image-index: Image index value + fw-version: Image version + private-key: Path to the private key file used for capsule signing + pub-key-cert: Path to the public key crt file used for capsule signing + payload: Path to the capsule payload file + capsule: Path to the output capsule file that is generated + hardware-instance: Hardware Instance value + monotonic-count: Monotonic count value + capsule-type: Specifies capsule type. normal(default), accept or revert + oemflags: 16bit Oemflags value to be used(populated in capsule header) + +When generating capsules through a config file, the command would look +like + +.. code-block:: console + + $ mkeficapsule --cfg-file + + Capsule with firmware version *****************************