From patchwork Tue Aug 31 02:46:56 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 504638 Delivered-To: patch@linaro.org Received: by 2002:a02:8629:0:0:0:0:0 with SMTP id e38csp2369668jai; Mon, 30 Aug 2021 19:47:50 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyeurNPiaeDiEG1MazNJ9jW/LtDLsrV2PEc3teTeCckRkm7+cdfELSLWzfFN4hnqb7if4js X-Received: by 2002:a17:906:abd7:: with SMTP id kq23mr13423395ejb.542.1630378070404; Mon, 30 Aug 2021 19:47:50 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1630378070; cv=none; d=google.com; s=arc-20160816; b=ABRYdajLoXS5o74umQGC3ZnOh8B4giLDSwTtBnUph+luo4Rdj3kAIYTotvw1yDWmGf Dvwvum4UBfSH/lOpq4Wp+Eh3f5nBEnp63v/Z7E05DDH6mkXFoe7F7vmiyUg5PQXzzDQa GLZd9MLf3CZqbB5KMq7MyFQdNv6KjGpv4wIEBvRizR+69y4cHC/YVmIcXiDPSxigH3XJ c18lfzuz2cmitVBe8Z/bQ4Tfu8Ial8R0zR9CZNAPE0UtlW5+ddXHl8rKFjRPbzqje2G0 Y4HHzDvR4Np4L3DcNbLwnA6IakmolbHzRak4QX2JOSfSaoxKvxZInCqPdSgL4/kQgMvo 10iA== 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=xEcUuWoQTzTjHrlxw6696W5Jh9P12XVARrdrpC/YDrM=; b=efo4OTKTap6HBEf7UDOo4qVGBCA07+pB60raBCrhuJgQAyElpgLFXD7gt6tBhshj/5 aaZUHMYWZJFNSD9lDQb8yuvH94i5U9QyPsxQKv+vW3fGPReXlw23NBk72VHgAHdtY31D w8EHwsPivxUnhLm4mgBi+NctwUGGUKaPoxNyUWkKbBdGrXvkD4+WS6vagv+vpl/waRpB L0VINAxCnZebzkEndJuGJJ6tOuhqmuACYTc+hdXf3SQ9W4tZkjKunsYOym8s6GSpypTW u0mda7l/BrTXYApSKGZNx9Mkre3jnoZ+26dIDkdBsnWDwvumvCkiw85GqmnFM3QN9k2C G5dQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=qy8G6d6g; 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 h20si16340590ejt.70.2021.08.30.19.47.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Aug 2021 19:47:50 -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=qy8G6d6g; 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 C38588340C; Tue, 31 Aug 2021 04:47:48 +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="qy8G6d6g"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 86BD783409; Tue, 31 Aug 2021 04:47:44 +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-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 EAD55833FB for ; Tue, 31 Aug 2021 04:47:36 +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-pf1-x436.google.com with SMTP id v123so13753566pfb.11 for ; Mon, 30 Aug 2021 19:47:36 -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=xEcUuWoQTzTjHrlxw6696W5Jh9P12XVARrdrpC/YDrM=; b=qy8G6d6g1xtNTzdeQxgs9zJh7S4X8b1C+FaaI7itNifufih8Vc2bWo5/DPpSxP2XgT zBw+LxehkYUWmVn4zApOuuzg32chQMvp9ykrZGSqxInSHSKa9nwJMyvNTiD791RSMkZm oQXtQQTYZ3oMDtocZGbPdKJZvD/CihA3JhqwCmDJFvFIRm6V7cu9Xrcz3RR6JfWV/Ixn nYtuIMdnYfg2AXkCsUtG8qMeAzZBJVbStWJPA0cMOsr2cSqP/iQVmp3oqjpwnNvuUE47 tL5Lk5vMMly7XiVJ5vpz6O4jib0nthi7Utd9rWMAcTj1KreietQeZnsPJLy92pNnMQAB NgdQ== 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=xEcUuWoQTzTjHrlxw6696W5Jh9P12XVARrdrpC/YDrM=; b=X72BXupAr6/J8C9uSnfl+VQ+EaJN0zFuQdL1xJKMa4N8tGe/RfQHnKtxB846GoX7Bu 57CtYGXyVX2FhddsHOwaHCi1QGoYOo7w0CeNrWQuPCjffTnz1ALGlePmWYPysrFCUVLE rvMJtytrc7vtBDfFN6BpV6wJkB/oFfYadIad/wDpGs2ez2G0m/T09QQ2jb1lgt8biuzb 28Svb+LdJLlk5zQ0fzCz5D2p5anB1hsTNJK0dFSgYj37Ml2/AbjxRcWAErCtlJE0aYbC 1HE/dPE0N93LxWaJggjspcadDz9OrJk17vM0FNm4Rqwx+2hOWscI33kxNk0eHHMDDLMy Hpbg== X-Gm-Message-State: AOAM5303Eg4JAGbFsj+TdTOJwL/WhL0wbPoHuhDDdOkpRwX8iBJTI8gG 16rFAkBOozfuNuqwgy16V2qFxw== X-Received: by 2002:a05:6a00:787:b0:405:700b:69ce with SMTP id g7-20020a056a00078700b00405700b69cemr449385pfu.50.1630378055262; Mon, 30 Aug 2021 19:47:35 -0700 (PDT) Received: from localhost.localdomain (p784a44f4.tkyea130.ap.so-net.ne.jp. [120.74.68.244]) by smtp.gmail.com with ESMTPSA id g2sm219649pfr.35.2021.08.30.19.47.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Aug 2021 19:47:34 -0700 (PDT) From: AKASHI Takahiro To: xypron.glpk@gmx.de, agraf@csgraf.de Cc: ilias.apalodimas@linaro.org, sughosh.ganu@linaro.org, masami.hiramatsu@linaro.org, u-boot@lists.denx.de, AKASHI Takahiro Subject: [PATCH v3 2/5] tools: mkeficapsule: add man page Date: Tue, 31 Aug 2021 11:46:56 +0900 Message-Id: <20210831024659.53464-3-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20210831024659.53464-1-takahiro.akashi@linaro.org> References: <20210831024659.53464-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.33.0 diff --git a/MAINTAINERS b/MAINTAINERS index 4cf0c33c5d58..0bb2de007982 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -701,6 +701,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