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

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8839 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h
index c2baa8fcecf2b66bcd969a96277426aae19a11d2..4daf27ca566a241db5f1117f56733323c057ea46 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h
+++ b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h
@@ -273,6 +273,11 @@ typedef struct {
   UINT16                            Key;\r
 } FRAMEWORK_EFI_IFR_HIDDEN;\r
 \r
+///\r
+/// Inconsistent with specification here:\r
+/// Following defintion may not comply with Framework Specification HII 0.92. To \r
+/// keep the inconsistant is for implementation needed.\r
+///\r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
   UINT8                             Flags;\r

diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h
index d6572d01417b5a468f572460ef915750e3568733..59a660c3a9001d58f825e7190d078b27a3e088cf 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/SmmCis.h
+++ b/IntelFrameworkPkg/Include/Framework/SmmCis.h
@@ -104,7 +104,7 @@ struct _EFI_SMM_CPU_IO_INTERFACE {
   @retval EFI_SUCCESS           The requested number of bytes was allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The pool requested could not be allocated.\r
   @retval EFI_UNSUPPORTED       In runtime.\r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_POOL. However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -124,7 +124,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The memory was returned to the system.\r
   @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
   @retval EFI_UNSUPPORTED       In runtime.\r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_FREE_POOL However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -149,7 +149,7 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         The requested pages could not be found.\r
   @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
                                 or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_PAGES However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -172,7 +172,7 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.\r
   @retval EFI_NOT_FOUND         The requested memory pages were not allocated with SmmAllocatePages().\r
   \r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_FREE_PAGES However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -197,7 +197,7 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER The CPU requested is not available on this SMI invocation.\r
   @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation.\r
   \r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, No this definition. This method is introduced in PI1.0 spec for \r
          implementation needed.\r
          \r

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