From patchwork Thu Oct 7 06:23:35 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 515432 Delivered-To: patch@linaro.org Received: by 2002:ac0:b5cc:0:0:0:0:0 with SMTP id x12csp1004326ime; Wed, 6 Oct 2021 23:26:04 -0700 (PDT) X-Google-Smtp-Source: ABdhPJywBHbIy+7I6zlG8TN+Ail3MqHn6+w6Iu192i8W+UFfOvGOhs0XPOgt9CKlW36pwHjdLeIn X-Received: by 2002:a17:906:c014:: with SMTP id e20mr3452650ejz.166.1633587964494; Wed, 06 Oct 2021 23:26:04 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1633587964; cv=none; d=google.com; s=arc-20160816; b=ta2IggW1zJ6YUGBkA4BVbI3yKa0/nrho0zujm2GGWMqrnnoDBioQ4C1QVTd1F5fwoT cGFhwmFgvfMSYR8ojgIp8d2szP2fmfJA/qCxRoTW5NPeUsnBsMh/7d9cpjjmxs22iaJf qrdn8hnmgQn/thVDU70cSYJXMqwAP2aNZDB51ve8WTennEC8NOGumkRe7al/79Lnmxi7 TJR0oJKM0NNkDJpP+t9FjT2DLkwLbHt0aEiuT/HYV6rtFTb3h/LN2zGzAA72bzuWT4Eh XREhEOjC8x2nZgU9i6oJuneVDQbDTS0QFtdJYwkMFywGAtZqbbIWelLj51yr4+TLK1jq sNcg== 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=M0bJRbOEbNqHhgTVZHwTpCAUUqAzh/fETzYiPCT19dU=; b=agKoTy+/4UiSJOiHUm2O1WFG7oIYNecgCj/LcMVHOnTbq2PFSrZJEiHGjQtnIU/oaw F/UA0+Ce5hU2N+iKBpBhEFHtGn/QIJgRngvgPeE8JlBEZw9M/jGPNsXKS+dgTxFs7JOh +rOp1ePqAexEk+zE7SRElOBcP3DJmJndWbaYnKhqi8TxtpZd4/42aEUKWvDHLqLI0QTK Vg+HGSOc+2pnPsf1aUoSrG0GRFvwaY0KcCJJ5mCmGrFYm1RwthMod+/S2JxCHib3YgBI AzN06vWyeqe/6RZY0v1rilJr68BGG4IOj13Svypd64IJvgd0b+qdkvrTMvuMf6hIBIB+ U5UA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=QNdO50Yl; 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 hs4si43429864ejc.266.2021.10.06.23.26.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 06 Oct 2021 23:26:04 -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=QNdO50Yl; 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 28D9B834D8; Thu, 7 Oct 2021 08:25: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=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="QNdO50Yl"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 439DE834AD; Thu, 7 Oct 2021 08:25:32 +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-pj1-x102d.google.com (mail-pj1-x102d.google.com [IPv6:2607:f8b0:4864:20::102d]) (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 688D0834BE for ; Thu, 7 Oct 2021 08:25:26 +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-x102d.google.com with SMTP id q7-20020a17090a2e0700b001a01027dd88so3495602pjd.1 for ; Wed, 06 Oct 2021 23:25:26 -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=M0bJRbOEbNqHhgTVZHwTpCAUUqAzh/fETzYiPCT19dU=; b=QNdO50YlrRunw3Ql5Hd0dYx/fZGW55Blw+dp2VzQKepiXcSjae+bpj7/H5RmD/23vw 4NmHo2mjJHrZMmV5FvxiWJB01L9ToEJhvknHDKfa8bUbNnVMvl0EDKZrxD9lVR+j/g6q GHzUg7lr90MI0038EvcLdFM6MZ22WK7wmp1HjAgzt2BrNXa3imPA48u/1LAqzDv1P69J VJFzXnMNmF+dEPtdhREa2Tw98HXAmA2RtQQBwHeSC1DCr5qwQyKAtqnhgIGgtqaiBps2 qnajz+6ZvDqcazh0cOPPkrKZfBWDf9FNw21gAIv72UfENE2nGdVdc8Y/hJq0Bx/kmwxP 57Dg== 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=M0bJRbOEbNqHhgTVZHwTpCAUUqAzh/fETzYiPCT19dU=; b=Vnrisx2F7tWB85khJ6r7mEynEUjsi24p7yDh++813m+z/twvo5ThrqlJmJCESW+MyH Zv3g/gwf8BPbRqX9UBpni97zI6C+Jyxag01YXn9jks5o6tfM6S3IgITjjaFtuzNdSTgi ic4XezQF+ow8kwaIDDrPPbhvj0dQRIjdi1xYvqYSNj880fwVxR2bsI/0aOh0i/IIJTym XyaYhyoJH85CjMUXAAHLl408NvGF2iwRRI5Xpd5D3OP1IApsJErSU+po11fwuNHxvaez 8AB0hxkl/spNTN+/HMknsj1eXb4Zm5fJneUKYwE1SRqK5fKJHfoObMO4QCziH7lxWuHq vxqA== X-Gm-Message-State: AOAM5337Xft8fjNsJZUvLsAdKo5F0c/Zjx2wci3CMYXf85Gr7nJEyiHD fEAoWc51ePP/FQs2Q7WIMo0jeg== X-Received: by 2002:a17:90a:b38c:: with SMTP id e12mr3370376pjr.125.1633587924694; Wed, 06 Oct 2021 23:25:24 -0700 (PDT) Received: from localhost.localdomain (122-100-26-39m5.mineo.jp. [122.100.26.39]) by smtp.gmail.com with ESMTPSA id b17sm22131859pgl.61.2021.10.06.23.25.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 06 Oct 2021 23:25:24 -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 v4 06/11] tools: mkeficapsule: add man page Date: Thu, 7 Oct 2021 15:23:35 +0900 Message-Id: <20211007062340.72207-7-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20211007062340.72207-1-takahiro.akashi@linaro.org> References: <20211007062340.72207-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 diff --git a/MAINTAINERS b/MAINTAINERS index 650e428b6cb4..1ef3aae41328 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -694,6 +694,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