]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
Correct the structure's comments to follow doxygen format.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkHii.h
index 32e66ed45d61e3bb6280378360af63b951018df7..43fb641b59eff2d0d80926be91b7690534483ce0 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
 //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\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
+\r
 //\r
 // Global definition\r
 //\r
@@ -76,12 +92,15 @@ typedef struct _EFI_HII_PROTOCOL  EFI_HII_PROTOCOL;
 \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
@@ -139,7 +158,7 @@ typedef struct {
 // ********************************************************\r
 //\r
 typedef struct {\r
-  EFI_HII_HANDLE  HiiHandle;\r
+  FRAMEWORK_EFI_HII_HANDLE  HiiHandle;\r
   EFI_GUID        PackageGuid;\r
   UINT32          DataTableSize;\r
   UINT32          IfrDataOffset;\r
@@ -177,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
@@ -207,25 +226,6 @@ typedef struct {
   //\r
 } EFI_HII_STRING_PACK;\r
 \r
-//\r
-// Glyph Attributes\r
-//\r
-#define EFI_GLYPH_NON_SPACING   1\r
-#define EFI_GLYPH_WIDE          2\r
-\r
-typedef struct {\r
-  CHAR16  UnicodeWeight;\r
-  UINT8   Attributes;\r
-  UINT8   GlyphCol1[GLYPH_HEIGHT];\r
-} EFI_NARROW_GLYPH;\r
-\r
-typedef struct {\r
-  CHAR16  UnicodeWeight;\r
-  UINT8   Attributes;\r
-  UINT8   GlyphCol1[GLYPH_HEIGHT];\r
-  UINT8   GlyphCol2[GLYPH_HEIGHT];\r
-  UINT8   Pad[3];\r
-} EFI_WIDE_GLYPH;\r
 \r
 //\r
 // A font list consists of a font header followed by a series\r
@@ -249,117 +249,6 @@ typedef struct {
   EFI_HII_PACK_HEADER Header;\r
 } EFI_HII_IFR_PACK_HEADER;\r
 \r
-//\r
-// pedef EFI_HII_PACK_HEADER EFI_HII_IFR_PACK_HEADER;\r
-//\r
-typedef enum {\r
-  EfiKeyLCtrl,\r
-  EfiKeyA0,\r
-  EfiKeyLAlt,\r
-  EfiKeySpaceBar,\r
-  EfiKeyA2,\r
-  EfiKeyA3,\r
-  EfiKeyA4,\r
-  EfiKeyRCtrl,\r
-  EfiKeyLeftArrow,\r
-  EfiKeyDownArrow,\r
-  EfiKeyRightArrow,\r
-  EfiKeyZero,\r
-  EfiKeyPeriod,\r
-  EfiKeyEnter,\r
-  EfiKeyLShift,\r
-  EfiKeyB0,\r
-  EfiKeyB1,\r
-  EfiKeyB2,\r
-  EfiKeyB3,\r
-  EfiKeyB4,\r
-  EfiKeyB5,\r
-  EfiKeyB6,\r
-  EfiKeyB7,\r
-  EfiKeyB8,\r
-  EfiKeyB9,\r
-  EfiKeyB10,\r
-  EfiKeyRshift,\r
-  EfiKeyUpArrow,\r
-  EfiKeyOne,\r
-  EfiKeyTwo,\r
-  EfiKeyThree,\r
-  EfiKeyCapsLock,\r
-  EfiKeyC1,\r
-  EfiKeyC2,\r
-  EfiKeyC3,\r
-  EfiKeyC4,\r
-  EfiKeyC5,\r
-  EfiKeyC6,\r
-  EfiKeyC7,\r
-  EfiKeyC8,\r
-  EfiKeyC9,\r
-  EfiKeyC10,\r
-  EfiKeyC11,\r
-  EfiKeyC12,\r
-  EfiKeyFour,\r
-  EfiKeyFive,\r
-  EfiKeySix,\r
-  EfiKeyPlus,\r
-  EfiKeyTab,\r
-  EfiKeyD1,\r
-  EfiKeyD2,\r
-  EfiKeyD3,\r
-  EfiKeyD4,\r
-  EfiKeyD5,\r
-  EfiKeyD6,\r
-  EfiKeyD7,\r
-  EfiKeyD8,\r
-  EfiKeyD9,\r
-  EfiKeyD10,\r
-  EfiKeyD11,\r
-  EfiKeyD12,\r
-  EfiKeyD13,\r
-  EfiKeyDel,\r
-  EfiKeyEnd,\r
-  EfiKeyPgDn,\r
-  EfiKeySeven,\r
-  EfiKeyEight,\r
-  EfiKeyNine,\r
-  EfiKeyE0,\r
-  EfiKeyE1,\r
-  EfiKeyE2,\r
-  EfiKeyE3,\r
-  EfiKeyE4,\r
-  EfiKeyE5,\r
-  EfiKeyE6,\r
-  EfiKeyE7,\r
-  EfiKeyE8,\r
-  EfiKeyE9,\r
-  EfiKeyE10,\r
-  EfiKeyE11,\r
-  EfiKeyE12,\r
-  EfiKeyBackSpace,\r
-  EfiKeyIns,\r
-  EfiKeyHome,\r
-  EfiKeyPgUp,\r
-  EfiKeyNLck,\r
-  EfiKeySlash,\r
-  EfiKeyAsterisk,\r
-  EfiKeyMinus,\r
-  EfiKeyEsc,\r
-  EfiKeyF1,\r
-  EfiKeyF2,\r
-  EfiKeyF3,\r
-  EfiKeyF4,\r
-  EfiKeyF5,\r
-  EfiKeyF6,\r
-  EfiKeyF7,\r
-  EfiKeyF8,\r
-  EfiKeyF9,\r
-  EfiKeyF10,\r
-  EfiKeyF11,\r
-  EfiKeyF12,\r
-  EfiKeyPrint,\r
-  EfiKeySLck,\r
-  EfiKeyPause\r
-} EFI_KEY;\r
-\r
 typedef struct {\r
   EFI_KEY Key;\r
   CHAR16  Unicode;\r
@@ -367,7 +256,7 @@ typedef struct {
   CHAR16  AltGrUnicode;\r
   CHAR16  ShiftedAltGrUnicode;\r
   UINT16  Modifier;\r
-} EFI_KEY_DESCRIPTOR;\r
+} FRAMEWORK_EFI_KEY_DESCRIPTOR;\r
 \r
 //\r
 // This structure allows a sparse set of keys to be redefined\r
@@ -389,7 +278,7 @@ typedef struct {
 //\r
 typedef struct {\r
   EFI_HII_PACK_HEADER Header;\r
-  EFI_KEY_DESCRIPTOR  *Descriptor;\r
+  FRAMEWORK_EFI_KEY_DESCRIPTOR  *Descriptor;\r
   UINT8               DescriptorCount;\r
 } EFI_HII_KEYBOARD_PACK;\r
 \r
@@ -422,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 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
@@ -431,10 +320,10 @@ 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 EFI_HII_HANDLE      *Handle\r
+  OUT FRAMEWORK_EFI_HII_HANDLE       *Handle\r
   );\r
 \r
 /**\r
@@ -451,9 +340,9 @@ 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 EFI_HII_HANDLE      Handle\r
+  IN FRAMEWORK_EFI_HII_HANDLE       Handle\r
   );\r
 \r
 /**\r
@@ -463,7 +352,7 @@ EFI_STATUS
   @param  HandleBufferLength    On input, a pointer to the length of the handle\r
                                 buffer. On output, the length of the handle buffer that is required\r
                                 for the handles found.\r
-  @param  Handle                An array of EFI_HII_HANDLE instances returned.\r
+  @param  Handle                An array of FRAMEWORK_EFI_HII_HANDLE  instances returned.\r
 \r
   @retval EFI_SUCCESS           Handle was updated successfully.\r
   @retval EFI_BUFFER_TOO_SMALL  The HandleBufferLength parameter indicates\r
@@ -472,17 +361,17 @@ 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    EFI_HII_HANDLE   *Handle\r
+  OUT    FRAMEWORK_EFI_HII_HANDLE    *Handle\r
   );\r
 \r
 /**\r
   Exports the contents of the database into a buffer.\r
 \r
   @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
-  @param  Handle                An EFI_HII_HANDLE that corresponds to the desired\r
+  @param  Handle                An FRAMEWORK_EFI_HII_HANDLE  that corresponds to the desired\r
                                 handle to export. If the value is 0, the entire database will be exported.\r
                                 In either case, the data will be exported in a format described by the\r
                                 structure definition of EFI_HII_EXPORT_TABLE.\r
@@ -497,9 +386,9 @@ 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     EFI_HII_HANDLE   Handle,\r
+  IN     FRAMEWORK_EFI_HII_HANDLE    Handle,\r
   IN OUT UINTN            *BufferSize,\r
   OUT    VOID             *Buffer\r
   );\r
@@ -517,9 +406,9 @@ 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     EFI_HII_HANDLE     Handle\r
+  IN     FRAMEWORK_EFI_HII_HANDLE      Handle\r
   );\r
 \r
 /**\r
@@ -543,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
@@ -573,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
@@ -604,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
@@ -634,10 +523,10 @@ 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     EFI_HII_HANDLE        Handle,\r
+  IN     FRAMEWORK_EFI_HII_HANDLE         Handle,\r
   IN OUT STRING_REF            *Reference,\r
   IN     CHAR16                *NewString\r
   );\r
@@ -657,9 +546,9 @@ 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  EFI_HII_HANDLE      Handle,\r
+  IN  FRAMEWORK_EFI_HII_HANDLE       Handle,\r
   OUT EFI_STRING          *LanguageString\r
   );\r
 \r
@@ -680,9 +569,9 @@ 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  EFI_HII_HANDLE      Handle,\r
+  IN  FRAMEWORK_EFI_HII_HANDLE       Handle,\r
   IN  CHAR16              *PrimaryLanguage,\r
   OUT EFI_STRING          *LanguageString\r
   );\r
@@ -712,9 +601,9 @@ 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     EFI_HII_HANDLE    Handle,\r
+  IN     FRAMEWORK_EFI_HII_HANDLE     Handle,\r
   IN     STRING_REF        Token,\r
   IN     BOOLEAN           Raw,\r
   IN     CHAR16            *LanguageString,\r
@@ -746,9 +635,9 @@ 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     EFI_HII_HANDLE    Handle,\r
+  IN     FRAMEWORK_EFI_HII_HANDLE     Handle,\r
   IN     STRING_REF        Token,\r
   IN OUT UINT16            *Index,\r
   IN     UINT16            LineWidth,\r
@@ -780,9 +669,9 @@ 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     EFI_HII_HANDLE    Handle,\r
+  IN     FRAMEWORK_EFI_HII_HANDLE     Handle,\r
   IN     EFI_FORM_ID       FormId,\r
   IN OUT UINTN             *BufferLength,\r
   OUT    UINT8             *Buffer\r
@@ -807,9 +696,9 @@ 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     EFI_HII_HANDLE             Handle,\r
+  IN     FRAMEWORK_EFI_HII_HANDLE   Handle,\r
   IN     UINTN                      DefaultMask,\r
   OUT    EFI_HII_VARIABLE_PACK_LIST **VariablePackList\r
   );\r
@@ -833,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 EFI_HII_HANDLE       Handle,\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
@@ -847,7 +736,7 @@ EFI_STATUS
   @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
   @param  DescriptorCount       A pointer to the number of Descriptor entries being\r
                                 described in the keyboard layout being retrieved.\r
-  @param  Descriptor            A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR\r
+  @param  Descriptor            A pointer to a buffer containing an array of FRAMEWORK_EFI_KEY_DESCRIPTOR\r
                                 entries. Each entry will reflect the definition of a specific physical key.\r
 \r
   @retval EFI_SUCCESS           The keyboard layout was retrieved successfully.\r
@@ -855,97 +744,110 @@ 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    EFI_KEY_DESCRIPTOR  *Descriptor\r
+  OUT    FRAMEWORK_EFI_KEY_DESCRIPTOR  *Descriptor\r
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The HII Protocol manages the HII database, which is a repository for data\r
   having to do with fonts, strings, forms, keyboards, and other future human\r
   interface items.\r
-\r
-  @param NewPack\r
-  Extracts the various packs from a package list.\r
-\r
-  @param RemovePack\r
-  Removes a package from the HII database.\r
-\r
-  @param FindHandles\r
-  Determines the handles that are currently active in the database.\r
-\r
-  @param ExportDatabase\r
-  Export the entire contents of the database to a buffer.\r
-\r
-  @param TestString\r
-  Tests if all of the characters in a string have corresponding font characters.\r
-\r
-  @param GetGlyph\r
-  Translates a Unicode character into the corresponding font glyph.\r
-\r
-  @param GlyphToBlt\r
-  Converts a glyph value into a format that is ready for a UGA BLT command.\r
-\r
-  @param NewString\r
-  Allows a new string to be added to an already existing string package.\r
-\r
-  @param GetPrimaryLanguages\r
-  Allows a program to determine the primary languages that are supported\r
-  on a given handle.\r
-\r
-  @param GetSecondaryLanguages\r
-  Allows a program to determine which secondary languages are supported\r
-  on a given handle for a given primary language.\r
-\r
-  @param GetString\r
-  Extracts a string from a package that is already registered with the\r
-  EFI HII database.\r
-\r
-  @param ResetString\r
-  Remove any new strings that were added after the initial string export\r
-  for this handle.\r
-\r
-  @param GetLine\r
-  Allows a program to extract a part of a string of not more than a given width.\r
-\r
-  @param GetForms\r
-  Allows a program to extract a form or form package that has been previously registered.\r
-\r
-  @param GetDefaultImage\r
-  Allows a program to extract the nonvolatile image that represents the default storage image.\r
-\r
-  @param UpdateForm\r
-  Allows a program to update a previously registered form.\r
-\r
-  @param GetKeyboardLayout\r
-  Allows a program to extract the current keyboard layout.\r
-\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
+  ///\r
+  /// Extracts the various packs from a package list.\r
+  ///\r
+  FRAMEWORK_EFI_HII_NEW_PACK            NewPack;\r
+  \r
+  ///\r
+  /// Removes a package from the HII database.\r
+  ///\r
+  FRAMEWORK_EFI_HII_REMOVE_PACK         RemovePack;\r
+  \r
+  ///\r
+  /// Determines the handles that are currently active in the database.\r
+  /// \r
+  FRAMEWORK_EFI_HII_FIND_HANDLES        FindHandles;\r
+  \r
+  ///\r
+  /// Export the entire contents of the database to a buffer.\r
+  ///\r
+  FRAMEWORK_EFI_HII_EXPORT              ExportDatabase;\r
+\r
+  ///\r
+  /// Tests if all of the characters in a string have corresponding font characters.\r
+  ///\r
+  FRAMEWORK_EFI_HII_TEST_STRING         TestString;\r
+  \r
+  ///\r
+  /// Translates a Unicode character into the corresponding font glyph.\r
+  ///\r
+  FRAMEWORK_EFI_HII_GET_GLYPH           GetGlyph;\r
+  \r
+  ///\r
+  /// Converts a glyph value into a format that is ready for a UGA BLT command.\r
+  ///\r
+  FRAMEWORK_EFI_HII_GLYPH_TO_BLT        GlyphToBlt;\r
+\r
+  ///\r
+  /// Allows a new string to be added to an already existing string package.\r
+  ///\r
+  FRAMEWORK_EFI_HII_NEW_STRING          NewString;\r
+  \r
+  ///\r
+  /// Allows a program to determine the primary languages that are supported\r
+  /// on a given handle.  \r
+  ///\r
+  FRAMEWORK_EFI_HII_GET_PRI_LANGUAGES   GetPrimaryLanguages;\r
+  \r
+  ///\r
+  /// Allows a program to determine which secondary languages are supported\r
+  /// on a given handle for a given primary language.  \r
+  ///\r
+  FRAMEWORK_EFI_HII_GET_SEC_LANGUAGES   GetSecondaryLanguages;\r
+  \r
+  ///\r
+  /// Extracts a string from a package that is already registered with the\r
+  /// EFI HII database.  \r
+  ///\r
+  FRAMEWORK_EFI_HII_GET_STRING          GetString;\r
+  \r
+  ///\r
+  /// Remove any new strings that were added after the initial string export\r
+  /// for this handle.  \r
+  ///\r
+  FRAMEWORK_EFI_HII_RESET_STRINGS       ResetStrings;\r
+  \r
+  ///\r
+  /// Allows a program to extract a part of a string of not more than a given width.\r
+  ///\r
+  FRAMEWORK_EFI_HII_GET_LINE            GetLine;\r
+  \r
+  ///\r
+  /// Allows a program to extract a form or form package that has been previously registered.\r
+  ///\r
+  FRAMEWORK_EFI_HII_GET_FORMS           GetForms;\r
+  \r
+  ///\r
+  /// Allows a program to extract the nonvolatile image that represents the default storage image.\r
+  ///\r
+  FRAMEWORK_EFI_HII_GET_DEFAULT_IMAGE   GetDefaultImage;\r
+  \r
+  ///\r
+  /// Allows a program to update a previously registered form.\r
+  ///\r
+  FRAMEWORK_EFI_HII_UPDATE_FORM         UpdateForm;\r
+\r
+  ///\r
+  /// Allows a program to extract the current keyboard layout.\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