From patchwork Tue Feb 1 01:27:34 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AKASHI Takahiro X-Patchwork-Id: 538932 Delivered-To: patch@linaro.org Received: by 2002:ac0:f7d2:0:0:0:0:0 with SMTP id i18csp465541imr; Mon, 31 Jan 2022 17:32:21 -0800 (PST) X-Google-Smtp-Source: ABdhPJzpbtrl77DlYgRbVr0vGtQQayaS8uZvgZK3OGH1PRe55c4UXFAKgpHUdloNJcMRVDAMsdqc X-Received: by 2002:a17:907:8315:: with SMTP id mq21mr19329549ejc.375.1643679140988; Mon, 31 Jan 2022 17:32:20 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1643679140; cv=none; d=google.com; s=arc-20160816; b=OjIFniYKCnTNH58VmVj6oOUGuBb9+J5EvG8e531CGfWgAVKc5TnAqJQP8V7cBTtAbE IQyw1Ljcxf/3O8laIuOHv82sMVikIsiPRRjDvSwivEMLZprrrJtm0i/0nU2fHHVsiww9 bg6dkHJxqgjQCyWGsc9EW3iC911SpQuYfbGGyiHJcng6keM5Ab8HthilQ8ttvZWrmD6v 5R11KglfzrXcWrNTQi06S0atvP6JqLPhX13h0Y11jfEynIV2O3SD3M7/oAMSxbEhBvRA sXvOBeNBPkhXbkW5DBeQlM4BWBV4/HL/LFqPXsDpy27AxzHJYtDmhBWD9rB+ZoNjUZrX gjkw== 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=ol9ddRwnpZf0xiKIvRWpCX3zHIM2hmcgqKnrCjt/dOk=; b=cGBk52lykYG9HI6XJnXAuZdM9XLgrJq6wLL/vi+gsp4Pr4nklD/h7aiSZ+bdbcGTdx movLLHWsjZiugxvUMB1WBRh94kaZEaIObdk55tyWg+s7yYfldx1B/lhtzY7ndrs5D/U+ X49HXYM1juN4Ay5dplIJ5KEyixSHh+FEFEnDpDTRJzOI9unYkyJ99XirVW+HLHESf/PB EulbgsI4/x7tSzkPQtjjl/G1Gbg7QtLP45ZCZAzNC5+mJJt8JVxurG98ZNn56wHYLdsq JXj86KsUTKcW+m9fikbRr4faDpioiTRKVXptozQkdbAqhkw8ZY7fXNWX8CM3ZHOY1PKO LcWQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=oAis9Qb3; 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 s7si8864651edq.265.2022.01.31.17.32.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 31 Jan 2022 17:32:20 -0800 (PST) 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=oAis9Qb3; 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 10A2C836B8; Tue, 1 Feb 2022 02:32:04 +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="oAis9Qb3"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 8D1B98359C; Tue, 1 Feb 2022 02:32:01 +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, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-pj1-x1030.google.com (mail-pj1-x1030.google.com [IPv6:2607:f8b0:4864:20::1030]) (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 6020F836A4 for ; Tue, 1 Feb 2022 02:31:56 +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-x1030.google.com with SMTP id h20-20020a17090adb9400b001b518bf99ffso1017473pjv.1 for ; Mon, 31 Jan 2022 17:31:56 -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=ol9ddRwnpZf0xiKIvRWpCX3zHIM2hmcgqKnrCjt/dOk=; b=oAis9Qb3pqHnN3E5sbYf6LgiUkjWweG2DeMrEp2ehKPFYLZd9+nEJixmCjHas5wdpQ kRjhauteOOAoSFmSx8ik1N7NcFSlv1Gtp4ASq89e7TT5Zi8QJ1P1AOqhpSCcaKGV4kHR i293vhP+b21RZUsPhA8YTToFAghRqH0BtpizpouD6qLLME0yfbCF/YhqnThWrdWFD8oA kxtBUU6SJRFsMUBZ4AV/tyAV5rHgv77yMzKitTacTI4Va//rc4yZgUne8+uE7KTTxc7c vst5isE5KKJs5qJgijYG4F7m1/rFnTrlCH4iFbYu4dxx/+P+9/oC3Dntc6ic8u8MOPYI ERtQ== 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=ol9ddRwnpZf0xiKIvRWpCX3zHIM2hmcgqKnrCjt/dOk=; b=X+QGqhm0Y6aR0LRoNTgPdU1nZyluVCk9O1tmI/4h0t+XTPqIqZGTyTYSt8dRTu33ps jK5LMnXdZS9+Wp5Omi5bVmEAx8XXOqbEWWdrd77tNNd5PDNa0v9ghvIt6Zrs8ehBPE6l t4mgws+urCHXU3HQAXqiNGPT0vtoMfefhWQESHdeisNi0tLG3I8j0yDNVLMr7cfFe7P5 wGt1FZDvitgcZsSJhcoef2p9t+bgD4rQ0EBHk3fWTvbpuK6ZNIhPq0XwYmG1rZTOe5qA wa4Q7nPHLvM1vQgKJUDzr1UbvKKpClHgZ9PeBhy5M5J2nESdw6WcSSBRLs/Ot7yIiCOL BxMw== X-Gm-Message-State: AOAM5302LcxLOvThro2zlM/fxSy8SfcV7EKSHAV6Qf/kyX7m7y/dxkPN l0IRT/H1/txgEgtX79t+2HXkhw== X-Received: by 2002:a17:90b:1b46:: with SMTP id nv6mr27722886pjb.178.1643679114751; Mon, 31 Jan 2022 17:31:54 -0800 (PST) Received: from localhost.localdomain ([2400:4050:c3e1:100:a8:b825:f6dd:417]) by smtp.gmail.com with ESMTPSA id u18sm20733784pfi.185.2022.01.31.17.31.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 31 Jan 2022 17:31:54 -0800 (PST) From: AKASHI Takahiro To: xypron.glpk@gmx.de, agraf@csgraf.de Cc: sjg@chromium.org, 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 v10 3/9] tools: mkeficapsule: add man page Date: Tue, 1 Feb 2022 10:27:34 +0900 Message-Id: <20220201012740.63070-4-takahiro.akashi@linaro.org> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20220201012740.63070-1-takahiro.akashi@linaro.org> References: <20220201012740.63070-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.5 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 dcdd99e368d1..2a8f70d70833 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -749,6 +749,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