From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.126; helo=mga18.intel.com; envelope-from=michael.d.kinney@intel.com; receiver=edk2-devel@lists.01.org Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id CF60A210C7ADD for ; Tue, 31 Jul 2018 23:34:11 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 31 Jul 2018 23:34:10 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,430,1526367600"; d="scan'208";a="250709234" Received: from mdkinney-mobl2.amr.corp.intel.com ([10.254.71.234]) by fmsmga006.fm.intel.com with ESMTP; 31 Jul 2018 23:33:50 -0700 From: "Kinney, Michael D" To: edk2-devel@lists.01.org Cc: Sean Brogan , Jiewen Yao , Yonghong Zhu , Liming Gao , Michael D Kinney Date: Tue, 31 Jul 2018 23:33:31 -0700 Message-Id: <20180801063333.17824-9-michael.d.kinney@intel.com> X-Mailer: git-send-email 2.14.2.windows.3 In-Reply-To: <20180801063333.17824-1-michael.d.kinney@intel.com> References: <20180801063333.17824-1-michael.d.kinney@intel.com> Subject: [Patch v3 08/10] BaseTools/Capsule: Update file header with tool limitations X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 01 Aug 2018 06:34:12 -0000 Update file header to state that the tool does not support: * Multiple payloads * Drivers * Vendor code bytes https://bugzilla.tianocore.org/show_bug.cgi?id=1031 Cc: Sean Brogan Cc: Jiewen Yao Cc: Yonghong Zhu Cc: Liming Gao Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney Reviewed-by: Yonghong Zhu --- BaseTools/Source/Python/Capsule/GenerateCapsule.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/BaseTools/Source/Python/Capsule/GenerateCapsule.py b/BaseTools/Source/Python/Capsule/GenerateCapsule.py index 76426dcf66..d829000849 100644 --- a/BaseTools/Source/Python/Capsule/GenerateCapsule.py +++ b/BaseTools/Source/Python/Capsule/GenerateCapsule.py @@ -1,6 +1,17 @@ ## @file # Generate a capsule. # +# This tool generates a UEFI Capsule around an FMP Capsule. The capsule payload +# be signed using signtool or OpenSSL and if it is signed the signed content +# includes an FMP Payload Header. +# +# This tool is intended to be used to generate UEFI Capsules to update the +# system firmware or device firmware for integrated devices. In order to +# keep the tool as simple as possible, it has the following limitations: +# * Do not support multiple payloads in a capsule. +# * Do not support optional drivers in a capsule. +# * Do not support vendor code bytes in a capsule. +# # Copyright (c) 2018, Intel Corporation. All rights reserved.
# This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License -- 2.14.2.windows.3