From 6d1824fc6eb724bf6d21f701b2c66835d1529161 Mon Sep 17 00:00:00 2001 From: jchen20 Date: Thu, 9 Jul 2009 10:27:43 +0000 Subject: [PATCH] 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 --- .../FrameworkInternalFormRepresentation.h | 5 ++++ IntelFrameworkPkg/Include/Framework/SmmCis.h | 10 +++---- .../Include/Protocol/FrameworkHii.h | 28 +++++++++---------- 3 files changed, 23 insertions(+), 20 deletions(-) diff --git a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h index c2baa8fcec..4daf27ca56 100644 --- a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h +++ b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h @@ -273,6 +273,11 @@ typedef struct { UINT16 Key; } FRAMEWORK_EFI_IFR_HIDDEN; +/// +/// Inconsistent with specification here: +/// Following defintion may not comply with Framework Specification HII 0.92. To +/// keep the inconsistant is for implementation needed. +/// typedef struct { FRAMEWORK_EFI_IFR_OP_HEADER Header; UINT8 Flags; diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h index d6572d0141..59a660c3a9 100644 --- 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. @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated. @retval EFI_UNSUPPORTED In runtime. - @Note: Inconsistent with specification here: + @note: Inconsistent with specification here: In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_POOL. However, To avoid the naming conflict, the definition is renamed. **/ @@ -124,7 +124,7 @@ EFI_STATUS @retval EFI_SUCCESS The memory was returned to the system. @retval EFI_INVALID_PARAMETER Buffer was invalid. @retval EFI_UNSUPPORTED In runtime. - @Note: Inconsistent with specification here: + @note: Inconsistent with specification here: In Framework Spec, This definition is naming EFI_SMM_FREE_POOL However, To avoid the naming conflict, the definition is renamed. **/ @@ -149,7 +149,7 @@ EFI_STATUS @retval EFI_NOT_FOUND The requested pages could not be found. @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF. - @Note: Inconsistent with specification here: + @note: Inconsistent with specification here: In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_PAGES However, To avoid the naming conflict, the definition is renamed. **/ @@ -172,7 +172,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid. @retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages(). - @Note: Inconsistent with specification here: + @note: Inconsistent with specification here: In Framework Spec, This definition is naming EFI_SMM_FREE_PAGES However, To avoid the naming conflict, the definition is renamed. **/ @@ -197,7 +197,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER The CPU requested is not available on this SMI invocation. @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation. - @Note: Inconsistent with specification here: + @note: Inconsistent with specification here: In Framework Spec, No this definition. This method is introduced in PI1.0 spec for implementation needed. diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h b/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h index 43fb641b59..c3117971c2 100644 --- a/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h +++ b/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h @@ -29,7 +29,16 @@ // is defined in MdePkg/Protocol/GraphicsOutput.h // #include - +// +// In UEFI2.1 spec, there is a same data type named EFI_GRAPHICS_OUTPUT_BLT_PIXEL. +// To define this data type only for backward compatibility. +// +typedef struct { + UINT8 Blue; + UINT8 Green; + UINT8 Red; + UINT8 Reserved; +} EFI_UGA_PIXEL // // In both EDK and EDK II, incompatbile change is done to Framework HII protocol. // This change should cause a change of GUID in both of code and HII spec. But we @@ -46,19 +55,6 @@ 0x5542cce1, 0xdf5c, 0x4d1b, { 0xab, 0xca, 0x36, 0x4f, 0x77, 0xd3, 0x99, 0xfb } \ } -// BugBug: -//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -// If UGA goes away we need to put this some place. I'm not sure where? -// -//typedef struct { -// UINT8 Blue; -// UINT8 Green; -// UINT8 Red; -// UINT8 Reserved; -//} EFI_UGA_PIXEL; - -//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -// typedef UINT16 STRING_REF; typedef UINT32 RELOFST; @@ -489,7 +485,9 @@ EFI_STATUS @retval EFI_SUCCESS It worked. @retval EFI_NOT_FOUND A glyph for a character was not found. - + @note: Inconsistent with specification here: + In Framework Spec,HII spec 0.92. The type of 3rd, 4th and 8th parameter is EFI_UGA_PIXEL. + Here the definition use the EFI_GRAPHICS_OUTPUT_BLT_PIXEL which defined in UEFI2.1 spec **/ typedef EFI_STATUS -- 2.39.2