From 566771b0a70a4ec637420c4b96a1415348bf2f12 Mon Sep 17 00:00:00 2001
From: czhang46 <czhang46>
Date: Tue, 15 Oct 2013 01:31:49 +0000
Subject: Enable UEFI firmware to support FMP capsule format.

signed-off-by : Chao Zhang <chao.b.zhang@intel.com>
reviewed-by   : Gao Liming <liming.gao@intel.com>
reviewed-by   : Yao Jiewen <Jiewen.yao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14773 6f19259b-4bc3-4df7-8a09-765794883524
---
 MdePkg/Include/Guid/FmpCapsule.h | 89 ++++++++++++++++++++++++++++++++++++++++
 MdePkg/Include/Uefi/UefiSpec.h   |  6 ++-
 2 files changed, 94 insertions(+), 1 deletion(-)
 create mode 100644 MdePkg/Include/Guid/FmpCapsule.h

(limited to 'MdePkg/Include')

diff --git a/MdePkg/Include/Guid/FmpCapsule.h b/MdePkg/Include/Guid/FmpCapsule.h
new file mode 100644
index 0000000000..ccc6b101bc
--- /dev/null
+++ b/MdePkg/Include/Guid/FmpCapsule.h
@@ -0,0 +1,89 @@
+/** @file
+  Guid & data structure used for Delivering Capsules Containing Updates to Firmware
+  Managment Protocol
+
+  Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
+  This program and the accompanying materials                          
+  are licensed and made available under the terms and conditions of the BSD License         
+  which accompanies this distribution.  The full text of the license may be found at        
+  http://opensource.org/licenses/bsd-license.php                                            
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+
+  @par Revision Reference:
+  GUIDs defined in UEFI 2.4 spec.
+
+**/
+
+
+#ifndef _FMP_CAPSULE_GUID_H__
+#define _FMP_CAPSULE_GUID_H__
+
+//
+// This is the GUID of the capsule for Firmware Management Protocol.
+//
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID \
+  { \
+    0x6dcbd5ed, 0xe82d, 0x4c44, {0xbd, 0xa1, 0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a } \
+  }
+
+#pragma pack(1)
+
+typedef struct {
+  UINT32 Version;
+
+  ///
+  /// The number of drivers included in the capsule and the number of corresponding
+  /// offsets stored in ItemOffsetList array. 
+  ///
+  UINT16 EmbeddedDriverCount;
+
+  ///
+  /// The number of payload items included in the capsule and the number of
+  /// corresponding offsets stored in the ItemOffsetList array.
+  ///
+  UINT16 PayloadItemCount;
+
+  ///
+  /// Variable length array of dimension [EmbeddedDriverCount + PayloadItemCount]
+  /// containing offsets of each of the drivers and payload items contained within the capsule
+  ///
+  // UINT64 ItemOffsetList[];
+} EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER;
+
+typedef struct {
+  UINT32   Version;
+
+  ///
+  /// Used to identifiy device firmware targeted by this update. This guid is matched by
+  /// system firmware against ImageTypeId field within a EFI_FIRMWARE_IMAGE_DESCRIPTOR
+  ///
+  EFI_GUID UpdateImageTypeId;
+
+  ///
+  /// Passed as ImageIndex in call to EFI_FIRMWARE_MANAGEMENT_PROTOCOL.SetImage()
+  ///
+  UINT8    UpdateImageIndex;
+  UINT8    reserved_bytes[3];
+
+  ///
+  /// Size of the binary update image which immediately follows this structure
+  ///
+  UINT32   UpdateImageSize;
+
+  ///
+  ///Size of the VendorCode bytes which optionally immediately follow binary update image in the capsule
+  ///
+  UINT32   UpdateVendorCodeSize;
+} EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER;
+
+#pragma pack()
+
+
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER_INIT_VERSION       0x00000001  
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION 0x00000001
+
+extern EFI_GUID gEfiFmpCapsuleGuid;
+
+#endif
diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index 45c3186fc2..619246b614 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -1752,7 +1752,11 @@ EFI_STATUS
 //
 // Firmware should stop at a firmware user interface on next boot
 //
-#define EFI_OS_INDICATIONS_BOOT_TO_FW_UI    0x0000000000000001
+#define EFI_OS_INDICATIONS_BOOT_TO_FW_UI                    0x0000000000000001
+#define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION             0x0000000000000002
+#define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED  0x0000000000000004
+#define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED            0x0000000000000008
+#define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED     0x0000000000000010
 
 //
 // EFI Runtime Services Table
-- 
cgit v1.2.3