Rename PI SMM definitions which has same name with those of Framework SMM spec but...

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

diff --git a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
index d13119d45faf56e1a5647ab24c9ce751e431079c..045e06dfb355e2f7795fa9536a3beb5f8e527b34 100644 (file)
--- a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
+++ b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
@@ -1,7 +1,14 @@
 /** @file\r
-  GUID for use in reserving SMRAM regions.\r
+  Definition of GUIDed HOB for reserving SMRAM regions.\r
 \r
-  Copyright (c) 2007, Intel Corporation\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
+  This GUIDed HOB can be used to convey the existence of the T-SEG reservation and H-SEG usage\r
+\r
+  Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. 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
@@ -10,8 +17,6 @@
   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
-  Module Name:  SmramMemoryReserve.h\r
-\r
   @par Revision Reference:\r
   GUIDs defined in SmmCis spec version 0.9\r
 \r
@@ -20,50 +25,37 @@
 #ifndef _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_\r
 #define _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_\r
 \r
-#include <PiPei.h>\r
+//\r
+// Share some common definitions with PI SMM\r
+//\r
+#include <Protocol/SmmAccess2.h>\r
 \r
 #define EFI_SMM_PEI_SMRAM_MEMORY_RESERVE \\r
   { \\r
     0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \\r
   }\r
 \r
-//\r
-// *******************************************************\r
-//  EFI_SMRAM_DESCRIPTOR\r
-// *******************************************************\r
-//\r
-typedef struct {\r
-  EFI_PHYSICAL_ADDRESS  PhysicalStart;  // Phsyical location in DRAM\r
-  EFI_PHYSICAL_ADDRESS  CpuStart;       // Address CPU uses to access the SMI handler\r
-  // May or may not match PhysicalStart\r
-  //\r
-  UINT64                PhysicalSize;\r
-  UINT64                RegionState;\r
-} EFI_SMRAM_DESCRIPTOR;\r
-\r
-//\r
-// *******************************************************\r
-//  EFI_SMRAM_STATE\r
-// *******************************************************\r
-//\r
-#define EFI_SMRAM_OPEN                0x00000001\r
-#define EFI_SMRAM_CLOSED              0x00000002\r
-#define EFI_SMRAM_LOCKED              0x00000004\r
-#define EFI_CACHEABLE                 0x00000008\r
-#define EFI_ALLOCATED                 0x00000010\r
-#define EFI_NEEDS_TESTING             0x00000020\r
-#define EFI_NEEDS_ECC_INITIALIZATION  0x00000040\r
-\r
-//\r
-// *******************************************************\r
-//  EFI_SMRAM_HOB_DESCRIPTOR_BLOCK\r
-// *******************************************************\r
-//\r
+/**\r
+* GUID specific data structure of HOB for reserving SMRAM regions.\r
+*\r
+* Inconsistent with specification here: \r
+* EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.\r
+* This inconsistency is kept in code in order for backward compatibility.\r
+**/\r
 typedef struct {\r
+  ///\r
+  /// Designates the number of possible regions in the system\r
+  /// that can be usable for SMRAM. \r
+  ///\r
   UINTN                 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 gEfiSmmPeiSmramMemoryReserveGuid;\r
 \r
 #endif\r
+\r