]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
projects / mirror_edk2.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update comment in SMM Library class include file.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkHii.h
diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h b/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
index 0caf7adfcfc912e8e705721ca4df8d8a05ffdbe1..c6e131e922fa2e44bdc644e0cf1e7dbd774bd535 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
@@ -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
@@ -30,11 +30,22 @@
 //\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
@@ -171,7 +188,6 @@ typedef struct {
   //\r
 } EFI_HII_EXPORT_TABLE;\r
 \r
-#define EFI_HII_UPDATE_DATA FRAMEWORK_EFI_HII_UPDATE_DATA \r
 typedef struct {\r
   BOOLEAN               FormSetUpdate;      // If TRUE, next variable is significant\r
   EFI_PHYSICAL_ADDRESS  FormCallbackHandle; // If not 0, will update Formset with this info\r
@@ -180,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
@@ -295,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
@@ -304,7 +320,7 @@ typedef struct _EFI_HII_VARIABLE_PACK_LIST {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -324,7 +340,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -345,7 +361,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -370,7 +386,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -390,7 +406,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -446,7 +462,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -477,7 +493,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -507,7 +523,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -530,7 +546,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -553,7 +569,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -585,7 +601,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -619,7 +635,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -653,7 +669,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -680,7 +696,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -706,12 +722,12 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -728,7 +744,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FRAMEWORK_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
@@ -820,5 +836,7 @@ struct _EFI_HII_PROTOCOL {
 };\r
 \r
 extern EFI_GUID gEfiHiiProtocolGuid;\r
+extern EFI_GUID gEfiHiiCompatibilityProtocolGuid;\r
+\r
 \r
 #endif\r
EFI Development Kit II mirror for PVE