Keep inconsistency in code and add additional comments for that.

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

diff --git a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
index ca54e69cc424e1fb43c5a435ff736550380966e7..0fb4ba12e276de07e65a3ca9fa459eed5bfe817b 100644 (file)
--- a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
+++ b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
@@ -52,6 +52,12 @@ typedef struct {
 #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
@@ -66,7 +72,7 @@ typedef struct {
   /// regions for SMRAM that are supported by this platform. \r
   ///\r
   EFI_SMRAM_DESCRIPTOR  Descriptor[1];\r
-} EFI_HOB_SMRAM_DESCRIPTOR_BLOCK;\r
+} EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;\r
 \r
 extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;\r
 \r