]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
Update comment in SMM Library class include file.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkHii.h
index 1fd197a3f8be802f21cb35abb48928c51f0690e1..c6e131e922fa2e44bdc644e0cf1e7dbd774bd535 100644 (file)
@@ -3,7 +3,7 @@
   be used by resources which want to publish IFR/Font/String data and have it\r
   collected by the Configuration engine.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2008, 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
 //\r
 #include <Protocol/GraphicsOutput.h>\r
 \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
+// update the GUID in code in EDK and EDK II. The 0.92 spec is not updated. This\r
+// is a known issue..\r
+//\r
 #define EFI_HII_PROTOCOL_GUID \\r
   { \\r
     0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \\r
   }\r
 \r
+#define EFI_HII_COMPATIBILITY_PROTOCOL_GUID \\r
+  { \\r
+    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
@@ -49,6 +60,9 @@
 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
 //\r
 \r
+typedef UINT16                    STRING_REF;\r
+typedef UINT32                    RELOFST;\r
+\r
 typedef struct _EFI_HII_PROTOCOL  EFI_HII_PROTOCOL;\r
 \r
 typedef UINT16                    FRAMEWORK_EFI_HII_HANDLE;\r
@@ -78,12 +92,15 @@ typedef UINT16                    FRAMEWORK_EFI_HII_HANDLE;
 \r
 //\r
 // The following types are currently defined:\r
-// EFI_FROM_ID has been defined in UEFI spec.\r
+// EFI_FORM_ID has been defined in UEFI spec.\r
 //\r
 typedef UINT16  EFI_FORM_LABEL;\r
 \r
 #pragma pack(1)\r
 \r
+//\r
+// The header found at the start of each package.\r
+//\r
 typedef struct {\r
   UINT32  Length;\r
   UINT16  Type;\r
@@ -179,7 +196,7 @@ typedef struct {
   STRING_REF            FormTitle;          // If not 0, will update Form with this info\r
   UINT16                DataCount;          // The number of Data entries in this structure\r
   UINT8                 *Data;              // An array of 1+ op-codes, specified by DataCount\r
-} EFI_HII_UPDATE_DATA;\r
+} FRAMEWORK_EFI_HII_UPDATE_DATA;\r
 \r
 //\r
 // String attributes\r
@@ -294,7 +311,7 @@ typedef struct _EFI_HII_VARIABLE_PACK_LIST {
 \r
   @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
   @param  Packages              A pointer to an EFI_HII_PACKAGES package instance.\r
-  @param  Handle                A pointer to the FRAMEWORK_EFI_HII_HANDLE  instance.\r
+  @param  Handle                A pointer to the FRAMEWORK_EFI_HII_HANDLE instance.\r
 \r
   @retval EFI_SUCCESS           Data was extracted from Packages, the database\r
                                 was updated with the data, and Handle returned successfully.\r
@@ -303,7 +320,7 @@ typedef struct _EFI_HII_VARIABLE_PACK_LIST {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_NEW_PACK) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_NEW_PACK)(\r
   IN  EFI_HII_PROTOCOL    *This,\r
   IN  EFI_HII_PACKAGES    *Packages,\r
   OUT FRAMEWORK_EFI_HII_HANDLE       *Handle\r
@@ -323,7 +340,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_REMOVE_PACK) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_REMOVE_PACK)(\r
   IN EFI_HII_PROTOCOL    *This,\r
   IN FRAMEWORK_EFI_HII_HANDLE       Handle\r
   );\r
@@ -344,7 +361,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_FIND_HANDLES) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_FIND_HANDLES)(\r
   IN     EFI_HII_PROTOCOL *This,\r
   IN OUT UINT16           *HandleBufferLength,\r
   OUT    FRAMEWORK_EFI_HII_HANDLE    *Handle\r
@@ -369,7 +386,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_EXPORT) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_EXPORT)(\r
   IN     EFI_HII_PROTOCOL *This,\r
   IN     FRAMEWORK_EFI_HII_HANDLE    Handle,\r
   IN OUT UINTN            *BufferSize,\r
@@ -389,7 +406,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_RESET_STRINGS) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_RESET_STRINGS)(\r
   IN     EFI_HII_PROTOCOL   *This,\r
   IN     FRAMEWORK_EFI_HII_HANDLE      Handle\r
   );\r
@@ -415,7 +432,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_TEST_STRING) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_TEST_STRING) (\r
   IN     EFI_HII_PROTOCOL  *This,\r
   IN     CHAR16            *StringToTest,\r
   IN OUT UINT32            *FirstMissing,\r
@@ -445,7 +462,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_GLYPH) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_GLYPH)(\r
   IN     EFI_HII_PROTOCOL  *This,\r
   IN     CHAR16            *Source,\r
   IN OUT UINT16            *Index,\r
@@ -476,7 +493,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GLYPH_TO_BLT) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GLYPH_TO_BLT)(\r
   IN     EFI_HII_PROTOCOL             *This,\r
   IN     UINT8                        *GlyphBuffer,\r
   IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,\r
@@ -506,7 +523,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_NEW_STRING) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_NEW_STRING)(\r
   IN     EFI_HII_PROTOCOL      *This,\r
   IN     CHAR16                *Language,\r
   IN     FRAMEWORK_EFI_HII_HANDLE         Handle,\r
@@ -529,7 +546,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_PRI_LANGUAGES) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_PRI_LANGUAGES)(\r
   IN  EFI_HII_PROTOCOL    *This,\r
   IN  FRAMEWORK_EFI_HII_HANDLE       Handle,\r
   OUT EFI_STRING          *LanguageString\r
@@ -552,7 +569,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_SEC_LANGUAGES) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_SEC_LANGUAGES)(\r
   IN  EFI_HII_PROTOCOL    *This,\r
   IN  FRAMEWORK_EFI_HII_HANDLE       Handle,\r
   IN  CHAR16              *PrimaryLanguage,\r
@@ -584,7 +601,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_STRING) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_STRING)(\r
   IN     EFI_HII_PROTOCOL  *This,\r
   IN     FRAMEWORK_EFI_HII_HANDLE     Handle,\r
   IN     STRING_REF        Token,\r
@@ -618,7 +635,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_LINE) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_LINE)(\r
   IN     EFI_HII_PROTOCOL  *This,\r
   IN     FRAMEWORK_EFI_HII_HANDLE     Handle,\r
   IN     STRING_REF        Token,\r
@@ -652,7 +669,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_FORMS) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_FORMS)(\r
   IN     EFI_HII_PROTOCOL  *This,\r
   IN     FRAMEWORK_EFI_HII_HANDLE     Handle,\r
   IN     EFI_FORM_ID       FormId,\r
@@ -679,7 +696,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_DEFAULT_IMAGE) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_DEFAULT_IMAGE)(\r
   IN     EFI_HII_PROTOCOL           *This,\r
   IN     FRAMEWORK_EFI_HII_HANDLE   Handle,\r
   IN     UINTN                      DefaultMask,\r
@@ -705,12 +722,12 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_UPDATE_FORM) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_UPDATE_FORM)(\r
   IN EFI_HII_PROTOCOL     *This,\r
   IN FRAMEWORK_EFI_HII_HANDLE        Handle,\r
   IN EFI_FORM_LABEL       Label,\r
   IN BOOLEAN              AddData,\r
-  IN EFI_HII_UPDATE_DATA  *Data\r
+  IN FRAMEWORK_EFI_HII_UPDATE_DATA  *Data\r
   );\r
 \r
 /**\r
@@ -727,7 +744,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HII_GET_KEYBOARD_LAYOUT) (\r
+(EFIAPI *FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT)(\r
   IN     EFI_HII_PROTOCOL    *This,\r
   OUT    UINT16              *DescriptorCount,\r
   OUT    FRAMEWORK_EFI_KEY_DESCRIPTOR  *Descriptor\r
@@ -796,28 +813,30 @@ EFI_STATUS
 \r
 **/\r
 struct _EFI_HII_PROTOCOL {\r
-  EFI_HII_NEW_PACK            NewPack;\r
-  EFI_HII_REMOVE_PACK         RemovePack;\r
-  EFI_HII_FIND_HANDLES        FindHandles;\r
-  EFI_HII_EXPORT              ExportDatabase;\r
-\r
-  EFI_HII_TEST_STRING         TestString;\r
-  EFI_HII_GET_GLYPH           GetGlyph;\r
-  EFI_HII_GLYPH_TO_BLT        GlyphToBlt;\r
-\r
-  EFI_HII_NEW_STRING          NewString;\r
-  EFI_HII_GET_PRI_LANGUAGES   GetPrimaryLanguages;\r
-  EFI_HII_GET_SEC_LANGUAGES   GetSecondaryLanguages;\r
-  EFI_HII_GET_STRING          GetString;\r
-  EFI_HII_RESET_STRINGS       ResetStrings;\r
-  EFI_HII_GET_LINE            GetLine;\r
-  EFI_HII_GET_FORMS           GetForms;\r
-  EFI_HII_GET_DEFAULT_IMAGE   GetDefaultImage;\r
-  EFI_HII_UPDATE_FORM         UpdateForm;\r
-\r
-  EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;\r
+  FRAMEWORK_EFI_HII_NEW_PACK            NewPack;\r
+  FRAMEWORK_EFI_HII_REMOVE_PACK         RemovePack;\r
+  FRAMEWORK_EFI_HII_FIND_HANDLES        FindHandles;\r
+  FRAMEWORK_EFI_HII_EXPORT              ExportDatabase;\r
+\r
+  FRAMEWORK_EFI_HII_TEST_STRING         TestString;\r
+  FRAMEWORK_EFI_HII_GET_GLYPH           GetGlyph;\r
+  FRAMEWORK_EFI_HII_GLYPH_TO_BLT        GlyphToBlt;\r
+\r
+  FRAMEWORK_EFI_HII_NEW_STRING          NewString;\r
+  FRAMEWORK_EFI_HII_GET_PRI_LANGUAGES   GetPrimaryLanguages;\r
+  FRAMEWORK_EFI_HII_GET_SEC_LANGUAGES   GetSecondaryLanguages;\r
+  FRAMEWORK_EFI_HII_GET_STRING          GetString;\r
+  FRAMEWORK_EFI_HII_RESET_STRINGS       ResetStrings;\r
+  FRAMEWORK_EFI_HII_GET_LINE            GetLine;\r
+  FRAMEWORK_EFI_HII_GET_FORMS           GetForms;\r
+  FRAMEWORK_EFI_HII_GET_DEFAULT_IMAGE   GetDefaultImage;\r
+  FRAMEWORK_EFI_HII_UPDATE_FORM         UpdateForm;\r
+\r
+  FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;\r
 };\r
 \r
 extern EFI_GUID gEfiHiiProtocolGuid;\r
+extern EFI_GUID gEfiHiiCompatibilityProtocolGuid;\r
+\r
 \r
 #endif\r