Add comments to describe the difference between code and spec to fix the bug #202430

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkHii.h

diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h b/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
index 43fb641b59eff2d0d80926be91b7690534483ce0..c3117971c27c564217f8aceb90ffcafeea7286bb 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
@@ -29,7 +29,16 @@
 // is defined in MdePkg/Protocol/GraphicsOutput.h\r
 //\r
 #include <Protocol/GraphicsOutput.h>\r
-\r
+//\r
+// In UEFI2.1 spec, there is a same data type named EFI_GRAPHICS_OUTPUT_BLT_PIXEL.\r
+// To define this data type only for backward compatibility. \r
+//\r
+typedef struct {\r
+   UINT8  Blue;\r
+   UINT8  Green;\r
+   UINT8  Red;\r
+   UINT8  Reserved;\r
+} EFI_UGA_PIXEL\r
 //\r
 // In both EDK and EDK II, incompatbile change is done to Framework HII protocol. \r
 // This change should cause a change of GUID in both of code and HII spec. But we \r
@@ -46,19 +55,6 @@
     0x5542cce1, 0xdf5c, 0x4d1b, { 0xab, 0xca, 0x36, 0x4f, 0x77, 0xd3, 0x99, 0xfb } \\r
   }\r
 \r
-// BugBug:\r
-//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
-// If UGA goes away we need to put this some place. I'm not sure where?\r
-//\r
-//typedef struct {\r
-//  UINT8 Blue;\r
-//  UINT8 Green;\r
-//  UINT8 Red;\r
-//  UINT8 Reserved;\r
-//} EFI_UGA_PIXEL;\r
-\r
-//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
-//\r
 \r
 typedef UINT16                    STRING_REF;\r
 typedef UINT32                    RELOFST;\r
@@ -489,7 +485,9 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           It worked.\r
   @retval EFI_NOT_FOUND         A glyph for a character was not found.\r
-\r
+  @note: Inconsistent with specification here:\r
+         In Framework Spec,HII spec 0.92. The type of 3rd, 4th and 8th parameter is EFI_UGA_PIXEL.\r
+         Here the definition use the EFI_GRAPHICS_OUTPUT_BLT_PIXEL which defined in UEFI2.1 spec\r
 **/\r
 typedef\r
 EFI_STATUS\r