MdePkg: Add EFI Capsule Report data structure and GUID

Add EFI Capsule Report data structure and GUID. It is defined in UEFI2.4A

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Chao Zhang <chao.b.zhang@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17568 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Guid/CapsuleReport.h b/MdePkg/Include/Guid/CapsuleReport.h
new file mode 100644 (file)
index 0000000..23c124d
--- /dev/null
+++ b/MdePkg/Include/Guid/CapsuleReport.h
@@ -0,0 +1,105 @@
+/** @file\r
+  Guid & data structure used for Capsule process result variables\r
+  \r
+  Copyright (c) 2015, 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
+\r
+  @par Revision Reference:\r
+  GUIDs defined in UEFI 2.4 spec.\r
+\r
+**/\r
+\r
+\r
+#ifndef _CAPSULE_REPORT_GUID_H__\r
+#define _CAPSULE_REPORT_GUID_H__\r
+\r
+//\r
+// This is the GUID for capsule result variable.\r
+//\r
+#define EFI_CAPSULE_REPORT_GUID \\r
+  { \\r
+    0x39b68c46, 0xf7fb, 0x441b, {0xb6, 0xec, 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3 } \\r
+  }\r
+\r
+\r
+typedef struct {\r
+\r
+  ///\r
+  /// Size in bytes of the variable including any data beyond header as specified by CapsuleGuid\r
+  ///\r
+  UINT32     VariableTotalSize;\r
+\r
+  ///\r
+  /// For alignment\r
+  ///\r
+  UINT32     Reserved;\r
+\r
+  ///\r
+  /// Guid from EFI_CAPSULE_HEADER\r
+  ///\r
+  EFI_GUID   CapsuleGuid;\r
+\r
+  ///\r
+  /// Timestamp using system time when processing completed\r
+  ///\r
+  EFI_TIME   CapsuleProcessed;\r
+\r
+  ///\r
+  /// Result of the capsule processing. Exact interpretation of any error code may depend\r
+  /// upon type of capsule processed\r
+  ///\r
+  EFI_STATUS CapsuleStatus;\r
+} EFI_CAPSULE_RESULT_VARIABLE_HEADER;\r
+\r
+\r
+typedef struct {\r
+\r
+  ///\r
+  /// Version of this structure, currently 0x00000001\r
+  ///\r
+  UINT16   Version;\r
+\r
+  ///\r
+  /// The index of the payload within the FMP capsule which was processed to generate this report\r
+  /// Starting from zero\r
+  ///\r
+  UINT8    PayloadIndex;\r
+\r
+  ///\r
+  /// The UpdateImageIndex from EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER\r
+  /// (after unsigned conversion from UINT8 to UINT16).\r
+  ///\r
+  UINT8    UpdateImageIndex;\r
+\r
+  ///\r
+  /// The UpdateImageTypeId Guid from EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER.\r
+  ///\r
+  EFI_GUID UpdateImageTypeId;\r
+\r
+  ///\r
+  /// In case of capsule loaded from disk, the zero-terminated array containing file name of capsule that was processed.\r
+  /// In case of capsule submitted directly to UpdateCapsule() there is no file name, and this field is required to contain a single 16-bit zero character \r
+  ///  which is included in VariableTotalSize.\r
+  ///\r
+  /// CHAR16 CapsuleFileName[];\r
+  ///\r
+\r
+  ///\r
+  /// This field will contain a zero-terminated CHAR16 string containing the text representation of the device path of device publishing Firmware Management Protocol  \r
+  /// (if present). In case where device path is not present and the target is not otherwise known to firmware, or when payload was blocked by policy, or skipped,\r
+  /// this field is required to contain a single 16-bit zero character which is included in VariableTotalSize.\r
+  ///\r
+  /// CHAR16 CapsuleTarget[];\r
+  ///\r
+} EFI_CAPSULE_RESULT_VARIABLE_FMP;\r
+\r
+\r
+extern EFI_GUID gEfiCapsuleReportGuid;\r
+\r
+#endif\r

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index f052730d6311faeae49941e9fa6eee1a5eceaf6a..16b522d93a2022c49df5ccde518873ce2e661566 100644 (file)
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -551,6 +551,9 @@
   gEfiAdapterInfoNetworkBootGuid      = { 0x1FBD2960, 0x4130, 0x41E5, {0x94, 0xAC, 0xD2, 0xCF, 0x03, 0x7F, 0xB3, 0x7C }}\r
   gEfiAdapterInfoSanMacAddressGuid    = { 0x114da5ef, 0x2cf1, 0x4e12, {0x9b, 0xbb, 0xc4, 0x70, 0xb5, 0x52, 0x5, 0xd9 }}\r
 \r
+  ## Include/Guid/CapsuleReport.h\r
+  gEfiCapsuleReportGuid               = { 0x39b68c46, 0xf7fb, 0x441b, {0xb6, 0xec, 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3 }}\r
+\r
   #\r
   # GUIDs defined in UEFI2.5\r
   #\r