Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...

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

diff --git a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
index 8dece94a94391497bc5ac7c1b42d97ce2f5d3a36..b678bec1b5992309e42ae0eb1bb249cb9fb715cc 100644 (file)
--- a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
+++ b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
@@ -8,7 +8,7 @@
   * 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
+  Copyright (c) 2007 - 2010, 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
@@ -30,35 +30,13 @@
     0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \\r
   }\r
 \r
-///\r
-/// Describes the candidate regions for SMRAM that are\r
-/// supported by this platform.\r
-///\r
-typedef struct {\r
-  EFI_PHYSICAL_ADDRESS  PhysicalStart;  ///< Designates the physical address of the SMRAM in memory.\r
-  EFI_PHYSICAL_ADDRESS  CpuStart;       ///< Designates the address of the SMRAM, as seen by software executing on the processors. \r
-  UINT64                PhysicalSize;   ///< Describes the number of bytes in the SMRAM region.\r
-  UINT64                RegionState;    ///< Describes the accessibility attributes of the SMRAM.\r
-} EFI_SMRAM_DESCRIPTOR;\r
-\r
-//\r
-// Definition of SMRAM states, used as value for EFI_SMRAM_DESCRIPTOR.RegionState.\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
-\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
-\r
-///\r
-/// GUID specific data structure of HOB for reserving SMRAM regions.\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
@@ -75,3 +53,4 @@ typedef struct {
 extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;\r
 \r
 #endif\r
+\r