From patchwork Tue Jul 27 09:10:47 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 486669 Delivered-To: patch@linaro.org Received: by 2002:a05:6638:1185:0:0:0:0 with SMTP id f5csp37809jas; Tue, 27 Jul 2021 02:13:00 -0700 (PDT) X-Google-Smtp-Source: ABdhPJy7hPRFt01H6hL0c0oq7sUL502i5GBgPaS8AQDEIcXAGgIqdUH2JYhxbEEJ0lys/ag2ecZJ X-Received: by 2002:aa7:d395:: with SMTP id x21mr26344022edq.98.1627377180472; Tue, 27 Jul 2021 02:13:00 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1627377180; cv=none; d=google.com; s=arc-20160816; b=k2pd14JorbaXOGoqOhLPyfFH3i8Aj1sUX8hfHGtvbhbDJgQH7IL78HGaZ8zsUEn3XQ S2fopO6EzoinxRrbK0aklrb0LVhbEiDAwOyo57xNnne3YMTproD9HGpufHlW1Qhp07Nm /qfD8LJdJMXMwDEQOsIkmRtKEudGXVajVqIAA7ZWTE9wDVEXCm5YvsgQcA8YO1BEfvLS cpOpV0xA4BLwF/d/DeMDi9k57Zf6+rwJQl+cLgzxKUa+ySDQ/jdvaVOZtH13MhBIKO6N o+NVbOTRrqN9d8UhvavnBJABKdBYVItrNZSAe5QtRo9DXuTep9AD90zDGRV+MtWnxX9A GhWg== 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:dkim-signature; bh=MLlwQPSRER3ANkN8G56lbwkpfzx2oclPAcZJZwKKhDA=; b=dqIY6pw93HCc/eDyiN4ZztzMnJsimrVEtuOGT/Q8w3MfuomO29oI/vgBD6ofRki9c2 3AUlCNAoisEejryFYwB4kBUiNfrnxdeAJxZQAJlDq0EEvPgX/cEKcp7VnKggGzDulyij s9v1lQ+7dn4SRWYW9xKR1XH+39Lgi2DVRZPGHznxQPi4zHcGVbEqiIUoAQJY75vC1OpS awhFspxUQoilNYAhDnRF7AgBzJ3UdrtvUhfEptMdyE2sbG7Mn6e4PdCKOWqC+6qKOz7U d2DieW1IuSlc3TzVwSdzHfNk5OcTiYJ+zdP5aOov2ROSLE9FhXPl6uEsp3iYnhwEeAwk NX7Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="o/wxagC9"; 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 q5si2425496edi.242.2021.07.27.02.13.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Jul 2021 02:13:00 -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="o/wxagC9"; 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 3D82F83450; Tue, 27 Jul 2021 11:12:55 +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="o/wxagC9"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id A7ECA83458; Tue, 27 Jul 2021 11:12:34 +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.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,SPF_HELO_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-pj1-x1036.google.com (mail-pj1-x1036.google.com [IPv6:2607:f8b0:4864:20::1036]) (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 1C21C8344E for ; Tue, 27 Jul 2021 11:12:18 +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=takahiro.akashi@linaro.org Received: by mail-pj1-x1036.google.com with SMTP id m1so16861638pjv.2 for ; Tue, 27 Jul 2021 02:12:18 -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 :mime-version:content-transfer-encoding; bh=MLlwQPSRER3ANkN8G56lbwkpfzx2oclPAcZJZwKKhDA=; b=o/wxagC9o+UOJLnG1QzA9RtBm694ie7U2qXhfBc+MPn8bALedbhabYYC90wvA/vbX3 YDOIjC2LnhXsSe44jVGYuWmTBMa+viuTEdU8vjWKUbNTtm+ZQaGuBkUewlmV3YRD+983 7NC3Bb5OFACI7K8y9yb565J9M3yuZUv4tRPGEy8cbf+Lc9res+/shnSIA5bJB2YahqhL 0/7Y/LivnEGKmuR7yzMyjTThAQrp37T5aiJtVJns84p4x/bllsucdQkrRq5MylVaPAey Een/BnL0OrUstF+1bMSVmBSQ+6eWe1ns72nUxoipahuqjZFpVIdeZqGyPVJ5u/9QLXdc 5n0w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=MLlwQPSRER3ANkN8G56lbwkpfzx2oclPAcZJZwKKhDA=; b=bvIGP0tuiULNSHwvrKlbWH7zLTHT5eS/D54Ri0aUNs6coECiIgziPR0Io0krwH+Tj8 99uXMtKnp5ED6wSdcnzmAiBToHY1XTpKDO5dUd688U9TZwCvxpboRKiHGyLifkAjZslD K30Xwo+QIFR69bXcJ7bhAgwT24EKW311GMoi9o3I1encsIaHGNmpe319Bg1nt7VYZg+T hZ6+02e5OwbTTfGuSfG8+jLUfxbZV0LtLzDlo0Hwgoy91sefd1r4nEOaxS0RFzbUWGS3 UT1q93KxFwbTh2+QvOV0zr7QQqtdUde3JbVcrXSyR+ni8xmskrT9kPse3e8oJYFrsMKe ji5g== X-Gm-Message-State: AOAM533eKe4Yp1VYZ4VIg+hdeXvf+edgEsW41hI03fDaWOstMfKE7cFj wXzPJvDsnZjN6KFaAyZ9cJztLw== X-Received: by 2002:aa7:8550:0:b029:32b:963f:f53b with SMTP id y16-20020aa785500000b029032b963ff53bmr22430030pfn.0.1627377136437; Tue, 27 Jul 2021 02:12:16 -0700 (PDT) Received: from localhost.localdomain (pdb6272ed.tkyea130.ap.so-net.ne.jp. [219.98.114.237]) by smtp.gmail.com with ESMTPSA id q13sm2008218pjq.10.2021.07.27.02.12.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Jul 2021 02:12:16 -0700 (PDT) From: AKASHI Takahiro To: xypron.glpk@gmx.de, agraf@csgraf.de, trini@konsulko.com, sjg@chromium.org Cc: ilias.apalodimas@linaro.org, sughosh.ganu@linaro.org, masami.hiramatsu@linaro.org, u-boot@lists.denx.de, AKASHI Takahiro Subject: [PATCH v2 2/9] tools: mkeficapsule: add man page Date: Tue, 27 Jul 2021 18:10:47 +0900 Message-Id: <20210727091054.512050-3-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.31.0 In-Reply-To: <20210727091054.512050-1-takahiro.akashi@linaro.org> References: <20210727091054.512050-1-takahiro.akashi@linaro.org> MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 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.2 at phobos.denx.de X-Virus-Status: Clean Add a man page for mkeficapsule command. Signed-off-by: AKASHI Takahiro --- MAINTAINERS | 1 + doc/mkeficapsule.1 | 91 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 92 insertions(+) create mode 100644 doc/mkeficapsule.1 -- 2.31.0 Reviewed-by: Heinrich Schuchardt diff --git a/MAINTAINERS b/MAINTAINERS index ae6c70860d3a..24f52f837066 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -696,6 +696,7 @@ S: Maintained T: git https://source.denx.de/u-boot/custodians/u-boot-efi.git F: doc/api/efi.rst F: doc/develop/uefi/* +F: doc/mkeficapsule.1 F: doc/usage/bootefi.rst F: drivers/rtc/emul_rtc.c F: include/capitalization.h diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1 new file mode 100644 index 000000000000..7c2341160ea4 --- /dev/null +++ b/doc/mkeficapsule.1 @@ -0,0 +1,91 @@ +.TH MAEFICAPSULE 1 "May 2021" + +.SH NAME +mkeficapsule \- Generate EFI capsule file for U-Boot + +.SH SYNOPSIS +.B mkeficapsule +.RB [\fIoptions\fP] " \fIcapsule-file\fP" + +.SH "DESCRIPTION" +The +\fBmkeficapsule\fP +command is used to create an EFI capsule file for use with the U-Boot +EFI capsule update. +A capsule file may contain various type of firmware blobs which +are to be applied to the system and must be placed in the specific +directory on the UEFI system partition. An update will be automatically +executed at next reboot. + +Optionally, a capsule file can be signed with a given private key. +In this case, the update will be authenticated by verifying the signature +before applying. + +\fBmkeficapsule\fP supports two different format of image files: +.TP +.I raw image +format is a single binary blob of any type of firmware. + +.TP +.I FIT (Flattened Image Tree) image +format +is the same as used in the new \fIuImage\fP format and allows for +multiple binary blobs in a single capsule file. +This type of image file can be generated by \fBmkimage\fP. + +.SH "OPTIONS" + +.TP +.BI "-f, --fit \fIfit-image-file\fP" +Specify a FIT image file + +.TP +.BI "-r, --raw \fIraw-image-file\fP" +Specify a raw image file + +.TP +.BI "-i, --index \fIindex\fP" +Specify an image index + +.TP +.BI "-I, --instance \fIinstance\fP" +Specify a hardware instance + +.TP +.BI "-h, --help" +Print a help message + +.TP 0 +.B With signing: + +.TP +.BI "-p, --private-key \fIprivate-key-file\fP" +Specify signer's private key file in PEM + +.TP +.BI "-c, --certificate \fIcertificate-file\fP" +Specify signer's certificate file in EFI certificate list format + +.TP +.BI "-m, --monotonic-count \fIcount\fP" +Specify a monotonic count which is set to be monotonically incremented +at every firmware update. + +.TP +.BI "-d, --dump_sig" +Dump signature data into *.p7 file + +.PP +.SH FILES +.TP +.BI "\fI/EFI/UpdateCapsule\fP" +The directory in which all capsule files be placed + +.SH SEE ALSO +.B mkimage + +.SH AUTHORS +Written by AKASHI Takahiro + +.SH HOMEPAGE +http://www.denx.de/wiki/U-Boot/WebHome