From patchwork Mon Dec 20 05:02:45 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 526043 Delivered-To: patch@linaro.org Received: by 2002:a05:6e04:2287:0:0:0:0 with SMTP id bl7csp3768175imb; Sun, 19 Dec 2021 21:04:29 -0800 (PST) X-Google-Smtp-Source: ABdhPJxXRFtxC9HyheX3KZbriNBG54GS7OvT6OvQDe23vZmCHWQZoakugWgpHfcHfdOZwFHz3LJ/ X-Received: by 2002:a17:907:c0c:: with SMTP id ga12mr9606014ejc.147.1639976669788; Sun, 19 Dec 2021 21:04:29 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1639976669; cv=none; d=google.com; s=arc-20160816; b=bdgyhpecTjfylw97SOkRiyi2CNyaP/AhO6/zR5UkHbYta1b3T2S6QXNq47Nr3j2GCJ k3XfY9nUrblB7sYrQ7VG6hhrFYQ9BSS0m7fJAQ3JB4flX66vdLo6EpLJK90nnOGkPRkE qMPFt7fQ2UVnlsBblMQD3isFa3XPt+yllxE2r7+4B3IYjsP6RSJrETsh2hblamAvsTRt 1dgPZheINMiZej9Q+uBT8CdocmOtonID6d9LZcmJFG8MyOmXToR7DoSV5G4bFImdaCJ1 gQ+LwfUDml405bqTDYffpgqXVZCT/HTI05LlMTrYbCQs1OK85Wivme4SkyPWpmpwHumh NnIw== 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=Mml3ICjaaBBgtJYrbjKQr4IdaQGfPoXXhGwX2gLY4Uw=; b=jf7xs/ahqRMj8lWY9YvF3oHI/GWWmU+RI1+uzZuX4IuzxGzC6yY2BKiwRYga2XOy4S rmFAiEW9hQglpTwF6kV4d3gY+3i8rZlV36WbApzbajY9yWxxgDl3uCK2vJOwN8+pH18s Xymg5l3voKmtqTFMFpceJbUmkPRlV8f6C3DgN6E/T0NePqapO73ns+JCNQAIQYzZ3Ym1 P6xd9qhjJKyg1kMYPlIC5agGvp5Gs2p95liOiB9+yhXXaiBbDDFUI8Za1dcqbcE2ZgBE MEhwWNmDxcjChBUMHkFI7b0yabiF0r4rJw+1HPVKWjgeq05ihZ5EcC37/wmfLcC3k4tK bwrw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=k3ELMatm; 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 m12si10014147edb.613.2021.12.19.21.04.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 19 Dec 2021 21:04:29 -0800 (PST) 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=k3ELMatm; 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 43E77833B8; Mon, 20 Dec 2021 06:04:13 +0100 (CET) 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="k3ELMatm"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 313B88309D; Mon, 20 Dec 2021 06:04:02 +0100 (CET) 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-pf1-x436.google.com (mail-pf1-x436.google.com [IPv6:2607:f8b0:4864:20::436]) (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 BF63D83104 for ; Mon, 20 Dec 2021 06:03:52 +0100 (CET) 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-pf1-x436.google.com with SMTP id c2so7680261pfc.1 for ; Sun, 19 Dec 2021 21:03:52 -0800 (PST) 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=Mml3ICjaaBBgtJYrbjKQr4IdaQGfPoXXhGwX2gLY4Uw=; b=k3ELMatmSjqkjtV27U6FEseWzU3JdmWR4tK9prxCLblNeazlZlTqEp8HTDEU0vCVUo TnwI+UKEsn+uBbcHOMi9X+Nzk/HFg4bru2/mFXKSsBW7JlC1Wak1LM7xWnTI5OADSr08 EKnl1tG9lq0rcTBSe9ttOZ+8wCJl45FaKIVqiUIXlRuaXa+cq28qY5BGQ52AbQ6rKBvv eSYoDQimSlOQNZpvLUVEG1c/4ZF30SoUPLLsMBFKvItHJLLU6HO0VUcHAY1ObhehBDKT o+OVtLqNeBikluJQCIkA4BF5/666veQxOlJiQsmsh/mkX+jp6GI+bjolV4Frhbp6XDLr SgVQ== 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=Mml3ICjaaBBgtJYrbjKQr4IdaQGfPoXXhGwX2gLY4Uw=; b=7/MhzqD32MKNi7nhq7YXIlb+7nDUJ1RbhjXSLE1IVeBaheGg4qYge6GQknbEnc8246 EeH1AjTlIeQ0HITsKuNwlpAX18BCkYkeKfq2asP+x4px7nr5mgBQy1Dl0v8XZzRwL7T2 S4ANlzEJZV8V2owX4uVIQNxRrRXJtIBXt4wv9LfPL+AQD6cPmQjquIbrRjEz9Ap88kqC kdRZ7OneL7oaxiQGcQNH/dI+MGFBt4idJq5egZZn2ISSax6mt6DBJ1/lt3URKRGHetO+ uYVIE67r4gV1eO7/52WdWQp3R4qflMJHLMKekzJYT0RUgb5xi5MNO674uIx860vqTYQv O0qQ== X-Gm-Message-State: AOAM5337Mh8Dat8V28wx/wZKnMcZUL7uzkXqrJb1L57XXL/v51MxOHI0 apcQADHYdFB7RwXX3nir0Uxa8g== X-Received: by 2002:a63:2c10:: with SMTP id s16mr13651700pgs.173.1639976631225; Sun, 19 Dec 2021 21:03:51 -0800 (PST) Received: from localhost.localdomain ([2400:4050:c3e1:100:89bf:be4:468d:12c2]) by smtp.gmail.com with ESMTPSA id mu2sm4581163pjb.43.2021.12.19.21.03.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 19 Dec 2021 21:03:50 -0800 (PST) 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, mark.kettenis@xs4all.nl, u-boot@lists.denx.de, AKASHI Takahiro Subject: [PATCH v8 04/12] tools: mkeficapsule: add man page Date: Mon, 20 Dec 2021 14:02:45 +0900 Message-Id: <20211220050253.31163-5-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20211220050253.31163-1-takahiro.akashi@linaro.org> References: <20211220050253.31163-1-takahiro.akashi@linaro.org> MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.38 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 Reviewed-by: Simon Glass Acked-by: Ilias Apalodimas --- MAINTAINERS | 1 + doc/mkeficapsule.1 | 95 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) create mode 100644 doc/mkeficapsule.1 diff --git a/MAINTAINERS b/MAINTAINERS index e718ad213553..93ef5e297acc 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -723,6 +723,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