MdePkg: Add FMP Capsule Image Header extension

[mirror_edk2.git] / MdePkg / Include / Guid / FmpCapsule.h

diff --git a/MdePkg/Include/Guid/FmpCapsule.h b/MdePkg/Include/Guid/FmpCapsule.h
index ccc6b101bcb08da18101e7ea69cf73b4f8964ebe..bd5cb7798e27e3815a4ada5ef901a04b333e12d3 100644 (file)
--- a/MdePkg/Include/Guid/FmpCapsule.h
+++ b/MdePkg/Include/Guid/FmpCapsule.h
@@ -1,15 +1,9 @@
 /** @file\r
   Guid & data structure used for Delivering Capsules Containing Updates to Firmware\r
-  Managment Protocol\r
+  Management Protocol\r
 \r
-  Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
-  This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
   GUIDs defined in UEFI 2.4 spec.\r
@@ -35,7 +29,7 @@ typedef struct {
 \r
   ///\r
   /// The number of drivers included in the capsule and the number of corresponding\r
-  /// offsets stored in ItemOffsetList array. \r
+  /// offsets stored in ItemOffsetList array.\r
   ///\r
   UINT16 EmbeddedDriverCount;\r
 \r
@@ -56,7 +50,7 @@ typedef struct {
   UINT32   Version;\r
 \r
   ///\r
-  /// Used to identifiy device firmware targeted by this update. This guid is matched by\r
+  /// Used to identify device firmware targeted by this update. This guid is matched by\r
   /// system firmware against ImageTypeId field within a EFI_FIRMWARE_IMAGE_DESCRIPTOR\r
   ///\r
   EFI_GUID UpdateImageTypeId;\r
@@ -73,16 +67,34 @@ typedef struct {
   UINT32   UpdateImageSize;\r
 \r
   ///\r
-  ///Size of the VendorCode bytes which optionally immediately follow binary update image in the capsule\r
+  /// Size of the VendorCode bytes which optionally immediately follow binary update image in the capsule\r
   ///\r
   UINT32   UpdateVendorCodeSize;\r
+\r
+  ///\r
+  /// The HardwareInstance to target with this update. If value is zero it means match all\r
+  /// HardwareInstances. This field allows update software to target only a single device in\r
+  /// cases where there are more than one device with the same ImageTypeId GUID.\r
+  /// This header is outside the signed data of the Authentication Info structure and\r
+  /// therefore can be modified without changing the Auth data.\r
+  ///\r
+  UINT64   UpdateHardwareInstance;\r
+\r
+  ///\r
+  /// A 64-bit bitmask that determines what sections are added to the payload.\r
+  /// #define CAPSULE_SUPPORT_AUTHENTICATION 0x0000000000000001\r
+  /// #define CAPSULE_SUPPORT_DEPENDENCY 0x0000000000000002\r
+  ///\r
+  UINT64   ImageCapsuleSupport;\r
 } EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER;\r
 \r
 #pragma pack()\r
 \r
 \r
-#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER_INIT_VERSION       0x00000001  \r
-#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION 0x00000001\r
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER_INIT_VERSION       0x00000001\r
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION 0x00000003\r
+#define CAPSULE_SUPPORT_AUTHENTICATION    0x0000000000000001\r
+#define CAPSULE_SUPPORT_DEPENDENCY        0x0000000000000002\r
 \r
 extern EFI_GUID gEfiFmpCapsuleGuid;\r
 \r