MdePkg: Add PI 1.5 SmramMemoryReserve HOB file

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

diff --git a/MdePkg/Include/Guid/SmramMemoryReserve.h b/MdePkg/Include/Guid/SmramMemoryReserve.h
new file mode 100644 (file)
index 0000000..47320f3
--- /dev/null
+++ b/MdePkg/Include/Guid/SmramMemoryReserve.h
@@ -0,0 +1,45 @@
+/** @file\r
+  This is a special GUID extension Hob to describe SMRAM memory regions.\r
+\r
+  This file defines:\r
+  * the GUID used to identify the GUID HOB for reserving SMRAM regions.\r
+  * the data structure of SMRAM descriptor to describe SMRAM candidate regions\r
+  * values of state of SMRAM candidate regions\r
+  * the GUID specific data structure of HOB for reserving SMRAM regions.\r
+\r
+  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+  @par Revision Reference:\r
+  GUIDs defined in PI SPEC version 1.5.\r
+\r
+**/\r
+\r
+#ifndef _SMRAM_MEMORY_RESERVE_H_\r
+#define _SMRAM_MEMORY_RESERVE_H_\r
+\r
+#define EFI_SMM_SMRAM_MEMORY_GUID \\r
+  { \\r
+    0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \\r
+  }\r
+\r
+/**\r
+* The GUID extension hob is to describe SMRAM memory regions supported by the platform.\r
+**/\r
+typedef struct {\r
+  ///\r
+  /// Designates the number of possible regions in the system\r
+  /// that can be usable for SMRAM.\r
+  ///\r
+  UINT32                NumberOfSmmReservedRegions;\r
+  ///\r
+  /// Used throughout this protocol to describe the candidate\r
+  /// regions for SMRAM that are supported by this platform.\r
+  ///\r
+  EFI_SMRAM_DESCRIPTOR  Descriptor[1];\r
+} EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;\r
+\r
+extern EFI_GUID gEfiSmmSmramMemoryGuid;\r
+\r
+#endif\r
+\r