From patchwork Tue Jan 18 04:39:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 532857 Delivered-To: patch@linaro.org Received: by 2002:ad5:544f:0:0:0:0:0 with SMTP id a15csp3352450imp; Mon, 17 Jan 2022 20:41:12 -0800 (PST) X-Google-Smtp-Source: ABdhPJzqkTuLXrR4gqr6Zd6QNZuhDa9FKEOn0IJCVWK4XMshNBWn/IN1akFU0aXuvC2jsY+tYKme X-Received: by 2002:a17:906:724a:: with SMTP id n10mr15238094ejk.659.1642480872498; Mon, 17 Jan 2022 20:41:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1642480872; cv=none; d=google.com; s=arc-20160816; b=U7yqjj3Rk2UrdDSxjk2Mbc/Rb6maQtw6DUrYpnFMckYq5kWJCuWhbqAtcv2BDOE5AC 9YIJ9T0pdKbGlUgp2mTIdhHmBoiH3OHoJmwkEAYwyv8dTb/CTBCoFMYCMHq6dErza3NE eAJkdY8UkZpKrKSdB4E4HDOteXYU8O0lWbFdBcxx0dRfH7q5L9LN516YnH4OcPVqEMam PYIlLrzkmrxwyBQuFu8BD5JYvtmaJUfWTdM7dt2q69nRPpcgrT1EtRMJ7mkoRdP+ce8Z 2WOFBGrE6Hc2VKzCYfft5xdKwK3cYKQP20OIKpVLyTAbrA7/FQRObmAwHiZSuwXUViu6 Fq7g== 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=BLaD296bB3+X+4iH6AyjgB8RxZhGevGO+Cpe2GrKalI=; b=b7pdgDkTAe0Myt/svk7O2mkqagUQ4b5on/xIhQc/2X7FXYwmHeA1ABHvvNCjgqrH7A AtJukvtJStFjeTvQbXnWAnpatNbMbsq85zNsykIQeq9cUULffZncU+82LOMBQEzjPCB2 5+sWaxHRy33v7sRYT2xDBm4m92znuZ+hz4soqhPA1uV2dIF4caqv7VUIdMaAvqriLUJI cS7ZHFskHsJwQMBTmzNR2u4zB5Qhu+Lrwjhu9kJV2zxvCr4l6yDWODP0P0Q6csOs3L2c ilhyWhh1K2iPfpnwECwo7gQU12rkvj9tVuNzolIbFMeJslgfrTgVPDQ+sCzeVT0/yR3W 1COQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=cHOACaJK; 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 sd9si8566116ejc.969.2022.01.17.20.41.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 17 Jan 2022 20:41:12 -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=cHOACaJK; 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 D13CD837DD; Tue, 18 Jan 2022 05:40:50 +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="cHOACaJK"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id DD3308365E; Tue, 18 Jan 2022 05:40:41 +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-pj1-x1031.google.com (mail-pj1-x1031.google.com [IPv6:2607:f8b0:4864:20::1031]) (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 1428483214 for ; Tue, 18 Jan 2022 05:40:33 +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-pj1-x1031.google.com with SMTP id i8-20020a17090a138800b001b3936fb375so1184997pja.1 for ; Mon, 17 Jan 2022 20:40:33 -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=BLaD296bB3+X+4iH6AyjgB8RxZhGevGO+Cpe2GrKalI=; b=cHOACaJKHrWf3zkKuBnGHkXWYa3oljxIJfR28K19s+YRC/Uh1ARS3bs+2YAXq1AXH8 1V56yDi9dA/oWPblA5DQDSSqwRmXIwALrEA/9u7mfSxj66C+yLMP2Ao9fe3HjKox8cEH b89g2egaFluwiJn2IZRobYZpKnXZiJzeCBcJYgPLz7SwGMmVIZt2AJyeKMhSPKE1MXRf e7k1p0iBzjPZ1aTDBiAJEtUZ4WomDde59bJ4Aj47sPRsofkio0blY8gmA5hMQ4BhpgJU D3vIPNCmpV/BPgjClis7b2LIWOKq8umMKPkruy3T+xKPN7F7cICTk9l1t77UybxJ8kEM iqxA== 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=BLaD296bB3+X+4iH6AyjgB8RxZhGevGO+Cpe2GrKalI=; b=n3pv7oeW4uAA3MK8Gp6LF2ZJqNSC9LqHwLzNDAsGUhJkagSISXGesSmes11AIFCWdR MeVQflmRCzDWflMUOxib/MPzyjfik1OYCTgoZKj57T8ILCHhAJMiFX/DUpB0pwaabpzC bICN9hH9vmv6cyLhJAXZxMFgpLZ0JEvM4z/LcCCGcVzRcQvemQ2NFweHMdoX2uTgMKZg 3GC+3laTCtfYI1DR0rmUDyzBinQMH/YU5qkFFtzRFUb8ZtndnGZYCnb4yho2tRpLBW9r KpXqVppDKYmkIlrTKvanEqpKuJHr+XxCd2rXrLR5nr2G4NtXy3yq4Xq5nrcfQ6K5wqXU cyqw== X-Gm-Message-State: AOAM531z2QSXCeYQCvJvoonKM98zPUAEMad56kgTI8HDVNVklxBnISwZ Gko8Hs2eB2/lbmBZe1jQfmB7ig== X-Received: by 2002:a17:90a:e7ca:: with SMTP id kb10mr37791338pjb.200.1642480831411; Mon, 17 Jan 2022 20:40:31 -0800 (PST) Received: from localhost.localdomain ([2400:4050:c3e1:100:bc1a:291e:ac91:be98]) by smtp.gmail.com with ESMTPSA id y69sm15670770pfg.171.2022.01.17.20.40.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 17 Jan 2022 20:40:30 -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 v9 05/11] tools: mkeficapsule: add man page Date: Tue, 18 Jan 2022 13:39:48 +0900 Message-Id: <20220118043954.55940-6-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20220118043954.55940-1-takahiro.akashi@linaro.org> References: <20220118043954.55940-1-takahiro.akashi@linaro.org> MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 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 | 99 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+) create mode 100644 doc/mkeficapsule.1 diff --git a/MAINTAINERS b/MAINTAINERS index 90666ce376cd..2b73feffafe0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -726,6 +726,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..680362f5c4e9 --- /dev/null +++ b/doc/mkeficapsule.1 @@ -0,0 +1,99 @@ +.\" SPDX-License-Identifier: GPL-2.0+ +.\" Copyright (c) 2021, Linaro Limited +.\" written by AKASHI Takahiro +.TH MAEFICAPSULE 1 "May 2021" + +.SH NAME +mkeficapsule \- Generate EFI capsule file for U-Boot + +.SH SYNOPSIS +.B mkeficapsule +.RI [ options "] " capsule-file + +.SH "DESCRIPTION" +.B mkeficapsule +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. + +.B mkeficapsule +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 uImage format and allows for +multiple binary blobs in a single capsule file. +This type of image file can be generated by +.BR mkimage . + +.SH "OPTIONS" +One of +.BR --fit " or " --raw +option must be specified. + +.TP +.BI "-f\fR,\fB --fit " fit-image-file +Specify a FIT image file + +.TP +.BI "-r\fR,\fB --raw " raw-image-file +Specify a raw image file + +.TP +.BI "-i\fR,\fB --index " index +Specify an image index + +.TP +.BI "-I\fR,\fB --instance " instance +Specify a hardware instance + +.TP +.BR -h ", " --help +Print a help message + +.PP +With signing, +.BR --private-key ", " --certificate " and " --monotonic-count +are all mandatory. + +.TP +.BI "-p\fR,\fB --private-key " private-key-file +Specify signer's private key file in PEM + +.TP +.BI "-c\fR,\fB --certificate " certificate-file +Specify signer's certificate file in EFI certificate list format + +.TP +.BI "-m\fR,\fB --monotonic-count " count +Specify a monotonic count which is set to be monotonically incremented +at every firmware update. + +.TP +.B "-d\fR,\fB --dump_sig" +Dump signature data into *.p7 file + +.PP +.SH FILES +.TP +.I /EFI/UpdateCapsule +The directory in which all capsule files be placed + +.SH SEE ALSO +.BR mkimage (1) + +.SH AUTHORS +Written by AKASHI Takahiro + +.SH HOMEPAGE +http://www.denx.de/wiki/U-Boot/WebHome