From patchwork Thu Oct 28 06:23:48 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 516356 Delivered-To: patch@linaro.org Received: by 2002:ac0:c404:0:0:0:0:0 with SMTP id t4csp1370686imj; Wed, 27 Oct 2021 23:25:25 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzg2XMEvlJrF9ratWMa5V6Z6ILziFQJ+Sv3z5YtYZISgYjNukMaJ6jCovawL3RRqHoAbOOh X-Received: by 2002:a05:6402:270b:: with SMTP id y11mr3580022edd.387.1635402325411; Wed, 27 Oct 2021 23:25:25 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1635402325; cv=none; d=google.com; s=arc-20160816; b=GCuHrTK/GlmTMSbTl1M0DqBGanf5Y3n/C9WGPAkbRV6PPhx9/d7/y3w40lSEw/6ji2 qS2AA2pPgRS+Na4UZO50TfRL7QQE0yeNGIu5qC0h17RthZmk9Sku2vDm2mSRalCvP/Of gVWjmoel3Zt4tTddKqNdgl1U8C9eahGwuoIfljCUH4e0v7GhPlAdtDPYrf/YO+K+n8lW /Ai8xyh8+sLosejXKZd6hp7bgHhi8Gh18VZ9LKrE/fZXqqGRDaoWkZ6cegGgRPa60Ebo plepmfKY/5v/bgvZkCRygu4pXnfljUkZGF8tgVVRUEU8yGoHGXouWU/sBcITFt3Ms72W hi8Q== 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=cRikCXg+PPiYIlKIg5wySHKZL5oVN2TnGGpcmdxqRTQ=; b=mYpArOs0TGuNI2rWInPcxCDrv6QqdoMlgBGDw1pcukda0Tiv5hvOHR2vETDRcoUSUr o+f0J3VINltcWhGvXx5D/xatQbWIbd4mNmErRxIGMw+PRO3bpiiGYjulnJGYhUgdf2qq bz7QLyn3wVGxUDVT0ZQIRhiUMoWowTrpF9kBdVKLg7Rzten/f9QHmFxFT+0mqKyb1K/U kAlkow7zL6Fw1Ipsl+OErw/ru+jiOY527MdCVK/IvM7aFWmlwxbT+NcPdZH65Jt6yd5B a3bwdEojrb6RIPD3ldU+kZT18PS/VvUj6iZK6AfjRXca00gKFJAavtBne3vgh5WKbsmq 2XoA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="lJe/8zdk"; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 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. [2a01:238:438b:c500:173d:9f52:ddab:ee01]) by mx.google.com with ESMTPS id cw8si3549426ejc.645.2021.10.27.23.25.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 27 Oct 2021 23:25:25 -0700 (PDT) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="lJe/8zdk"; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 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 F339783556; Thu, 28 Oct 2021 08:25:23 +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="lJe/8zdk"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id F351383216; Thu, 28 Oct 2021 08:25:14 +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-pl1-x62b.google.com (mail-pl1-x62b.google.com [IPv6:2607:f8b0:4864:20::62b]) (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 7BF788347C for ; Thu, 28 Oct 2021 08:25:04 +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-pl1-x62b.google.com with SMTP id t21so3700205plr.6 for ; Wed, 27 Oct 2021 23:25:04 -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=cRikCXg+PPiYIlKIg5wySHKZL5oVN2TnGGpcmdxqRTQ=; b=lJe/8zdkKaxW1BzBLBgNNiZU35ZCgZzUqsUQgzHACc2Nhhivw8H1NhAfe7FcXVU9NK T7k4Kz2QL3glEBjtWXwbgdvjVozRRkh5+mXeUIpDTJFZWu/0pee5rmluE4IgvmwcKbpv UG2Ondt5aaCX1b7i/FPCI9Bi3FQ2FUctVjSs/oTvvxLjqFKvexEoIDRdLWhCQZ3F4eAx Q0zzWepx+x0UaPzAfb1Gd3fNoFj5cTu+v1jW1Hjx2DKkp+r9ZFcazsHb1+pLwhQ7EOiZ 5AERgfyJdkzfrU8hnqjNf05NcLZw1s93AZ0iMjos/1ZYkgvUFDiP9KB+XijHz0ID+LZq S09g== 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:mime-version:content-transfer-encoding; bh=cRikCXg+PPiYIlKIg5wySHKZL5oVN2TnGGpcmdxqRTQ=; b=foinbaXTD/LeWVM+bcClGgQyXuTxUjE5zmWa0QIpWE0lsez+mNR18j6AXT+bebt5bH 68SoQOrkd/t8INRrsh1qgTrUxneL9cfdyhqsaS8ovkftK6hW6bhTQoaFpe//YKQBO7Ke QGabJOTq2giYa9aXkpLy4dbVsODIenEfUmvta8nWEdtuw7Jpa5RWK9iZT6HIIVEkFS5O +JUXgbD8ehhHuYEsgzMUbfTYKC98IUFF0j3jy96qkPXQiu3LIFI12kDB3GP2R9ScbTQE LA6uygRK3iP+aR5CQcWaWXcrDV2d3H6kKsokxdOTailnU2oMJIyM5Rmqa1A/w9hgrsnq oLkg== X-Gm-Message-State: AOAM532e3bzpkktTYWgD29d1WJAGN0998Beqg/OtwBQ8zlFW19feaFDh gb/PQIFRF7PynuoxHaNLUopPLA== X-Received: by 2002:a17:90a:e389:: with SMTP id b9mr2482365pjz.40.1635402302231; Wed, 27 Oct 2021 23:25:02 -0700 (PDT) Received: from localhost.localdomain ([2400:4050:c3e1:100:394a:97ee:bbbb:462e]) by smtp.gmail.com with ESMTPSA id p16sm1582018pgd.78.2021.10.27.23.24.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 27 Oct 2021 23:25:01 -0700 (PDT) From: AKASHI Takahiro To: xypron.glpk@gmx.de, agraf@csgraf.de, 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 v5 03/11] tools: mkeficapsule: add man page Date: Thu, 28 Oct 2021 15:23:48 +0900 Message-Id: <20211028062356.98224-4-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20211028062356.98224-1-takahiro.akashi@linaro.org> References: <20211028062356.98224-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 | 95 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) create mode 100644 doc/mkeficapsule.1 -- 2.33.0 Reviewed-by: Simon Glass diff --git a/MAINTAINERS b/MAINTAINERS index 5069f1880652..96233f0aad51 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -707,6 +707,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..837e09ab451e --- /dev/null +++ b/doc/mkeficapsule.1 @@ -0,0 +1,95 @@ +.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" +One of \fB--fit\fP or \fB--raw\fP option must be specified. + +.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: + +\fB--private-key\fP, \fB--certificate\fP and \fB--monotonic-count\fP are +all mandatory. + +.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