MdeModulePkg: Refine function comments in Keyword Handler Protocol

[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / HiiDatabase.h

/** @file\r
Private structures definitions in HiiDatabase.\r
\r
Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
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
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __HII_DATABASE_PRIVATE_H__\r
#define __HII_DATABASE_PRIVATE_H__\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/HiiFont.h>\r
#include <Protocol/HiiImage.h>\r
#include <Protocol/HiiString.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/HiiConfigKeyword.h>\r
#include <Protocol/SimpleTextOut.h>\r
\r
#include <Guid/HiiKeyBoardLayout.h>\r
#include <Guid/GlobalVariable.h>\r
\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/PrintLib.h>\r
\r
#define MAX_STRING_LENGTH                  1024\r
#define MAX_FONT_NAME_LEN                  256\r
#define NARROW_BASELINE                    15\r
#define WIDE_BASELINE                      14\r
#define SYS_FONT_INFO_MASK                 0x37\r
#define REPLACE_UNKNOWN_GLYPH              0xFFFD\r
#define PROPORTIONAL_GLYPH                 0x80\r
#define NARROW_GLYPH                       0x40\r
\r
#define BITMAP_LEN_1_BIT(Width, Height)  (((Width) + 7) / 8 * (Height))\r
#define BITMAP_LEN_4_BIT(Width, Height)  (((Width) + 1) / 2 * (Height))\r
#define BITMAP_LEN_8_BIT(Width, Height)  ((Width) * (Height))\r
#define BITMAP_LEN_24_BIT(Width, Height) ((Width) * (Height) * 3)\r
\r
//\r
// IFR data structure\r
//\r
// BASE_CR (a, IFR_DEFAULT_VALUE_DATA, Entry) to get the whole structure.\r
\r
typedef struct {\r
  LIST_ENTRY          Entry;             // Link to VarStorage\r
  EFI_GUID            Guid;\r
  CHAR16              *Name;\r
  UINT16              Size;\r
  UINT8               Type;\r
  LIST_ENTRY          BlockEntry;        // Link to its Block array\r
} IFR_VARSTORAGE_DATA;\r
\r
typedef struct {\r
  LIST_ENTRY          Entry;             // Link to Block array\r
  UINT16              Offset;\r
  UINT16              Width;\r
  EFI_QUESTION_ID     QuestionId;\r
  UINT8               OpCode;\r
  UINT8               Scope;\r
  LIST_ENTRY          DefaultValueEntry; // Link to its default value array\r
  CHAR16              *Name;\r
} IFR_BLOCK_DATA;\r
\r
//\r
// Get default value from IFR data.\r
//\r
typedef enum {\r
  DefaultValueFromDefault = 0,     // Get from the minimum or first one when not set default value.\r
  DefaultValueFromFlag,            // Get default value from the defalut flag.\r
  DefaultValueFromOpcode           // Get default value from default opcode, highest priority.\r
} DEFAULT_VALUE_TYPE;\r
\r
typedef struct {\r
  LIST_ENTRY          Entry;\r
  DEFAULT_VALUE_TYPE  Type;\r
  BOOLEAN             Cleaned;       // Whether this value is cleaned\r
                                     // TRUE  Cleaned, the value can't be used\r
                                     // FALSE Not cleaned, the value can  be used.\r
  UINT16              DefaultId;\r
  EFI_IFR_TYPE_VALUE  Value;\r
} IFR_DEFAULT_DATA;\r
\r
//\r
// Storage types\r
//\r
#define EFI_HII_VARSTORE_BUFFER              0\r
#define EFI_HII_VARSTORE_NAME_VALUE          1\r
#define EFI_HII_VARSTORE_EFI_VARIABLE        2\r
#define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER 3\r
\r
//\r
// Keyword handler protocol filter type.\r
//\r
#define EFI_KEYWORD_FILTER_READONY           0x01\r
#define EFI_KEYWORD_FILTER_REAWRITE          0x02\r
#define EFI_KEYWORD_FILTER_BUFFER            0x10\r
#define EFI_KEYWORD_FILTER_NUMERIC           0x20\r
#define EFI_KEYWORD_FILTER_NUMERIC_1         0x30\r
#define EFI_KEYWORD_FILTER_NUMERIC_2         0x40\r
#define EFI_KEYWORD_FILTER_NUMERIC_4         0x50\r
#define EFI_KEYWORD_FILTER_NUMERIC_8         0x60\r
\r
\r
#define HII_FORMSET_STORAGE_SIGNATURE           SIGNATURE_32 ('H', 'S', 'T', 'G')\r
typedef struct {\r
  UINTN               Signature;\r
  LIST_ENTRY          Entry;\r
\r
  EFI_HII_HANDLE      HiiHandle;\r
  EFI_HANDLE          DriverHandle;\r
\r
  UINT8               Type;   // EFI_HII_VARSTORE_BUFFER, EFI_HII_VARSTORE_NAME_VALUE, EFI_HII_VARSTORE_EFI_VARIABLE\r
  EFI_GUID            Guid;\r
  CHAR16              *Name;\r
  UINT16              Size;\r
} HII_FORMSET_STORAGE;\r
\r
\r
//\r
// String Package definitions\r
//\r
#define HII_STRING_PACKAGE_SIGNATURE    SIGNATURE_32 ('h','i','s','p')\r
typedef struct _HII_STRING_PACKAGE_INSTANCE {\r
  UINTN                                 Signature;\r
  EFI_HII_STRING_PACKAGE_HDR            *StringPkgHdr;\r
  UINT8                                 *StringBlock;\r
  LIST_ENTRY                            StringEntry;\r
  LIST_ENTRY                            FontInfoList;  // local font info list\r
  UINT8                                 FontId;\r
  EFI_STRING_ID                         MaxStringId;   // record StringId\r
} HII_STRING_PACKAGE_INSTANCE;\r
\r
//\r
// Form Package definitions\r
//\r
#define HII_IFR_PACKAGE_SIGNATURE       SIGNATURE_32 ('h','f','r','p')\r
typedef struct _HII_IFR_PACKAGE_INSTANCE {\r
  UINTN                                 Signature;\r
  EFI_HII_PACKAGE_HEADER                FormPkgHdr;\r
  UINT8                                 *IfrData;\r
  LIST_ENTRY                            IfrEntry;\r
} HII_IFR_PACKAGE_INSTANCE;\r
\r
//\r
// Simple Font Package definitions\r
//\r
#define HII_S_FONT_PACKAGE_SIGNATURE    SIGNATURE_32 ('h','s','f','p')\r
typedef struct _HII_SIMPLE_FONT_PACKAGE_INSTANCE {\r
  UINTN                                 Signature;\r
  EFI_HII_SIMPLE_FONT_PACKAGE_HDR       *SimpleFontPkgHdr;\r
  LIST_ENTRY                            SimpleFontEntry;\r
} HII_SIMPLE_FONT_PACKAGE_INSTANCE;\r
\r
//\r
// Font Package definitions\r
//\r
#define HII_FONT_PACKAGE_SIGNATURE      SIGNATURE_32 ('h','i','f','p')\r
typedef struct _HII_FONT_PACKAGE_INSTANCE {\r
  UINTN                                 Signature;\r
  EFI_HII_FONT_PACKAGE_HDR              *FontPkgHdr;\r
  UINT16                                Height;\r
  UINT16                                BaseLine;\r
  UINT8                                 *GlyphBlock;\r
  LIST_ENTRY                            FontEntry;\r
  LIST_ENTRY                            GlyphInfoList;\r
} HII_FONT_PACKAGE_INSTANCE;\r
\r
#define HII_GLYPH_INFO_SIGNATURE        SIGNATURE_32 ('h','g','i','s')\r
typedef struct _HII_GLYPH_INFO {\r
  UINTN                                 Signature;\r
  LIST_ENTRY                            Entry;\r
  CHAR16                                CharId;\r
  EFI_HII_GLYPH_INFO                    Cell;\r
} HII_GLYPH_INFO;\r
\r
#define HII_FONT_INFO_SIGNATURE         SIGNATURE_32 ('h','l','f','i')\r
typedef struct _HII_FONT_INFO {\r
  UINTN                                 Signature;\r
  LIST_ENTRY                            Entry;\r
  LIST_ENTRY                            *GlobalEntry;\r
  UINT8                                 FontId;\r
} HII_FONT_INFO;\r
\r
#define HII_GLOBAL_FONT_INFO_SIGNATURE  SIGNATURE_32 ('h','g','f','i')\r
typedef struct _HII_GLOBAL_FONT_INFO {\r
  UINTN                                 Signature;\r
  LIST_ENTRY                            Entry;\r
  HII_FONT_PACKAGE_INSTANCE             *FontPackage;\r
  UINTN                                 FontInfoSize;\r
  EFI_FONT_INFO                         *FontInfo;\r
} HII_GLOBAL_FONT_INFO;\r
\r
//\r
// Image Package definitions\r
//\r
\r
#define HII_PIXEL_MASK                  0x80\r
\r
typedef struct _HII_IMAGE_PACKAGE_INSTANCE {\r
  EFI_HII_IMAGE_PACKAGE_HDR             ImagePkgHdr;\r
  UINT32                                ImageBlockSize;\r
  UINT32                                PaletteInfoSize;\r
  UINT8                                 *ImageBlock;\r
  UINT8                                 *PaletteBlock;\r
} HII_IMAGE_PACKAGE_INSTANCE;\r
\r
//\r
// Keyboard Layout Pacakge definitions\r
//\r
#define HII_KB_LAYOUT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','k','l','p')\r
typedef struct _HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE {\r
  UINTN                                 Signature;\r
  UINT8                                 *KeyboardPkg;\r
  LIST_ENTRY                            KeyboardEntry;\r
} HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE;\r
\r
//\r
// Guid Package definitions\r
//\r
#define HII_GUID_PACKAGE_SIGNATURE      SIGNATURE_32 ('h','i','g','p')\r
typedef struct _HII_GUID_PACKAGE_INSTANCE {\r
  UINTN                                 Signature;\r
  UINT8                                 *GuidPkg;\r
  LIST_ENTRY                            GuidEntry;\r
} HII_GUID_PACKAGE_INSTANCE;\r
\r
//\r
// A package list can contain only one or less than one device path package.\r
// This rule also applies to image package since ImageId can not be duplicate.\r
//\r
typedef struct _HII_DATABASE_PACKAGE_LIST_INSTANCE {\r
  EFI_HII_PACKAGE_LIST_HEADER           PackageListHdr;\r
  LIST_ENTRY                            GuidPkgHdr;\r
  LIST_ENTRY                            FormPkgHdr;\r
  LIST_ENTRY                            KeyboardLayoutHdr;\r
  LIST_ENTRY                            StringPkgHdr;\r
  LIST_ENTRY                            FontPkgHdr;\r
  HII_IMAGE_PACKAGE_INSTANCE            *ImagePkg;\r
  LIST_ENTRY                            SimpleFontPkgHdr;\r
  UINT8                                 *DevicePathPkg;\r
} HII_DATABASE_PACKAGE_LIST_INSTANCE;\r
\r
#define HII_HANDLE_SIGNATURE            SIGNATURE_32 ('h','i','h','l')\r
\r
typedef struct {\r
  UINTN               Signature;\r
  LIST_ENTRY          Handle;\r
  UINTN               Key;\r
} HII_HANDLE;\r
\r
#define HII_DATABASE_RECORD_SIGNATURE   SIGNATURE_32 ('h','i','d','r')\r
\r
typedef struct _HII_DATABASE_RECORD {\r
  UINTN                                 Signature;\r
  HII_DATABASE_PACKAGE_LIST_INSTANCE    *PackageList;\r
  EFI_HANDLE                            DriverHandle;\r
  EFI_HII_HANDLE                        Handle;\r
  LIST_ENTRY                            DatabaseEntry;\r
} HII_DATABASE_RECORD;\r
\r
#define HII_DATABASE_NOTIFY_SIGNATURE   SIGNATURE_32 ('h','i','d','n')\r
\r
typedef struct _HII_DATABASE_NOTIFY {\r
  UINTN                                 Signature;\r
  EFI_HANDLE                            NotifyHandle;\r
  UINT8                                 PackageType;\r
  EFI_GUID                              *PackageGuid;\r
  EFI_HII_DATABASE_NOTIFY               PackageNotifyFn;\r
  EFI_HII_DATABASE_NOTIFY_TYPE          NotifyType;\r
  LIST_ENTRY                            DatabaseNotifyEntry;\r
} HII_DATABASE_NOTIFY;\r
\r
#define HII_DATABASE_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('H', 'i', 'D', 'p')\r
\r
typedef struct _HII_DATABASE_PRIVATE_DATA {\r
  UINTN                                 Signature;\r
  LIST_ENTRY                            DatabaseList;\r
  LIST_ENTRY                            DatabaseNotifyList;\r
  EFI_HII_FONT_PROTOCOL                 HiiFont;\r
  EFI_HII_IMAGE_PROTOCOL                HiiImage;\r
  EFI_HII_STRING_PROTOCOL               HiiString;\r
  EFI_HII_DATABASE_PROTOCOL             HiiDatabase;\r
  EFI_HII_CONFIG_ROUTING_PROTOCOL       ConfigRouting;\r
  EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL   ConfigKeywordHandler;\r
  LIST_ENTRY                            HiiHandleList;\r
  INTN                                  HiiHandleCount;\r
  LIST_ENTRY                            FontInfoList;  // global font info list\r
  UINTN                                 Attribute;     // default system color\r
  EFI_GUID                              CurrentLayoutGuid;\r
  EFI_HII_KEYBOARD_LAYOUT               *CurrentLayout;\r
} HII_DATABASE_PRIVATE_DATA;\r
\r
#define HII_FONT_DATABASE_PRIVATE_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      HII_DATABASE_PRIVATE_DATA, \\r
      HiiFont, \\r
      HII_DATABASE_PRIVATE_DATA_SIGNATURE \\r
      )\r
\r
#define HII_IMAGE_DATABASE_PRIVATE_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      HII_DATABASE_PRIVATE_DATA, \\r
      HiiImage, \\r
      HII_DATABASE_PRIVATE_DATA_SIGNATURE \\r
      )\r
\r
#define HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      HII_DATABASE_PRIVATE_DATA, \\r
      HiiString, \\r
      HII_DATABASE_PRIVATE_DATA_SIGNATURE \\r
      )\r
\r
#define HII_DATABASE_DATABASE_PRIVATE_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      HII_DATABASE_PRIVATE_DATA, \\r
      HiiDatabase, \\r
      HII_DATABASE_PRIVATE_DATA_SIGNATURE \\r
      )\r
\r
#define CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      HII_DATABASE_PRIVATE_DATA, \\r
      ConfigRouting, \\r
      HII_DATABASE_PRIVATE_DATA_SIGNATURE \\r
      )\r
\r
#define CONFIG_KEYWORD_HANDLER_DATABASE_PRIVATE_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      HII_DATABASE_PRIVATE_DATA, \\r
      ConfigKeywordHandler, \\r
      HII_DATABASE_PRIVATE_DATA_SIGNATURE \\r
      )\r
\r
//\r
// Internal function prototypes.\r
//\r
\r
/**\r
  Generate a sub string then output it.\r
\r
  This is a internal function.\r
\r
  @param  String                 A constant string which is the prefix of the to be\r
                                 generated string, e.g. GUID=\r
\r
  @param  BufferLen              The length of the Buffer in bytes.\r
\r
  @param  Buffer                 Points to a buffer which will be converted to be the \r
                                 content of the generated string.\r
\r
  @param  Flag                   If 1, the buffer contains data for the value of GUID or PATH stored in \r
                                 UINT8 *; if 2, the buffer contains unicode string for the value of NAME;\r
                                 if 3, the buffer contains other data.\r
\r
  @param  SubStr                 Points to the output string. It's caller's\r
                                 responsibility to free this buffer.\r
\r
\r
**/\r
VOID\r
GenerateSubStr (\r
  IN CONST EFI_STRING              String,\r
  IN  UINTN                        BufferLen,\r
  IN  VOID                         *Buffer,\r
  IN  UINT8                        Flag,\r
  OUT EFI_STRING                   *SubStr\r
  );\r
\r
/**\r
  This function checks whether a handle is a valid EFI_HII_HANDLE.\r
\r
  @param  Handle                  Pointer to a EFI_HII_HANDLE\r
\r
  @retval TRUE                    Valid\r
  @retval FALSE                   Invalid\r
\r
**/\r
BOOLEAN\r
IsHiiHandleValid (\r
  EFI_HII_HANDLE Handle\r
  );\r
\r
\r
/**\r
  This function checks whether EFI_FONT_INFO exists in current database. If\r
  FontInfoMask is specified, check what options can be used to make a match.\r
  Note that the masks relate to where the system default should be supplied\r
  are ignored by this function.\r
\r
  @param  Private                 Hii database private structure.\r
  @param  FontInfo                Points to EFI_FONT_INFO structure.\r
  @param  FontInfoMask            If not NULL, describes what options can be used\r
                                  to make a match between the font requested and\r
                                  the font available. The caller must guarantee\r
                                  this mask is valid.\r
  @param  FontHandle              On entry, Points to the font handle returned by a\r
                                  previous  call to GetFontInfo() or NULL to start\r
                                  with the first font.\r
  @param  GlobalFontInfo          If not NULL, output the corresponding globa font\r
                                  info.\r
\r
  @retval TRUE                    Existed\r
  @retval FALSE                   Not existed\r
\r
**/\r
BOOLEAN\r
IsFontInfoExisted (\r
  IN  HII_DATABASE_PRIVATE_DATA *Private,\r
  IN  EFI_FONT_INFO             *FontInfo,\r
  IN  EFI_FONT_INFO_MASK        *FontInfoMask,   OPTIONAL\r
  IN  EFI_FONT_HANDLE           FontHandle,      OPTIONAL\r
  OUT HII_GLOBAL_FONT_INFO      **GlobalFontInfo OPTIONAL\r
  );\r
\r
/**\r
\r
   This function invokes the matching registered function.\r
    \r
   @param  Private           HII Database driver private structure.\r
   @param  NotifyType        The type of change concerning the database.\r
   @param  PackageInstance   Points to the package referred to by the notification.\r
   @param  PackageType       Package type\r
   @param  Handle            The handle of the package list which contains the specified package.\r
    \r
   @retval EFI_SUCCESS            Already checked all registered function and invoked \r
                                  if matched.\r
   @retval EFI_INVALID_PARAMETER  Any input parameter is not valid.\r
     \r
**/\r
EFI_STATUS\r
InvokeRegisteredFunction (\r
  IN HII_DATABASE_PRIVATE_DATA    *Private, \r
  IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType,\r
  IN VOID                         *PackageInstance,\r
  IN UINT8                        PackageType,\r
  IN EFI_HII_HANDLE               Handle\r
  )\r
;\r
\r
/**\r
  Retrieve system default font and color.\r
\r
  @param  Private                 HII database driver private data.\r
  @param  FontInfo                Points to system default font output-related\r
                                  information. It's caller's responsibility to free\r
                                  this buffer.\r
  @param  FontInfoSize            If not NULL, output the size of buffer FontInfo.\r
\r
  @retval EFI_SUCCESS             Cell information is added to the GlyphInfoList.\r
  @retval EFI_OUT_OF_RESOURCES    The system is out of resources to accomplish the\r
                                  task.\r
  @retval EFI_INVALID_PARAMETER   Any input parameter is invalid.\r
\r
**/\r
EFI_STATUS\r
GetSystemFont (\r
  IN  HII_DATABASE_PRIVATE_DATA      *Private,\r
  OUT EFI_FONT_DISPLAY_INFO          **FontInfo,\r
  OUT UINTN                          *FontInfoSize OPTIONAL\r
  );\r
\r
\r
/**\r
  Parse all string blocks to find a String block specified by StringId.\r
  If StringId = (EFI_STRING_ID) (-1), find out all EFI_HII_SIBT_FONT blocks\r
  within this string package and backup its information. If LastStringId is \r
  specified, the string id of last string block will also be output.\r
  If StringId = 0, output the string id of last string block (EFI_HII_SIBT_STRING).\r
\r
  @param  Private                 Hii database private structure.\r
  @param  StringPackage           Hii string package instance.\r
  @param  StringId                The string's id, which is unique within\r
                                  PackageList.\r
  @param  BlockType               Output the block type of found string block.\r
  @param  StringBlockAddr         Output the block address of found string block.\r
  @param  StringTextOffset        Offset, relative to the found block address, of\r
                                  the  string text information.\r
  @param  LastStringId            Output the last string id when StringId = 0 or StringId = -1.\r
  @param  StartStringId           The first id in the skip block which StringId in the block.\r
\r
  @retval EFI_SUCCESS             The string text and font is retrieved\r
                                  successfully.\r
  @retval EFI_NOT_FOUND           The specified text or font info can not be found\r
                                  out.\r
  @retval EFI_OUT_OF_RESOURCES    The system is out of resources to accomplish the\r
                                  task.\r
\r
**/\r
EFI_STATUS\r
FindStringBlock (\r
  IN HII_DATABASE_PRIVATE_DATA        *Private,\r
  IN  HII_STRING_PACKAGE_INSTANCE     *StringPackage,\r
  IN  EFI_STRING_ID                   StringId,\r
  OUT UINT8                           *BlockType, OPTIONAL\r
  OUT UINT8                           **StringBlockAddr, OPTIONAL\r
  OUT UINTN                           *StringTextOffset, OPTIONAL\r
  OUT EFI_STRING_ID                   *LastStringId, OPTIONAL\r
  OUT EFI_STRING_ID                   *StartStringId OPTIONAL\r
  );\r
\r
\r
/**\r
  Parse all glyph blocks to find a glyph block specified by CharValue.\r
  If CharValue = (CHAR16) (-1), collect all default character cell information\r
  within this font package and backup its information.\r
\r
  @param  FontPackage             Hii string package instance.\r
  @param  CharValue               Unicode character value, which identifies a glyph\r
                                  block.\r
  @param  GlyphBuffer             Output the corresponding bitmap data of the found\r
                                  block. It is the caller's responsiblity to free\r
                                  this buffer.\r
  @param  Cell                    Output cell information of the encoded bitmap.\r
  @param  GlyphBufferLen          If not NULL, output the length of GlyphBuffer.\r
\r
  @retval EFI_SUCCESS             The bitmap data is retrieved successfully.\r
  @retval EFI_NOT_FOUND           The specified CharValue does not exist in current\r
                                  database.\r
  @retval EFI_OUT_OF_RESOURCES    The system is out of resources to accomplish the\r
                                  task.\r
\r
**/\r
EFI_STATUS\r
FindGlyphBlock (\r
  IN  HII_FONT_PACKAGE_INSTANCE      *FontPackage,\r
  IN  CHAR16                         CharValue,\r
  OUT UINT8                          **GlyphBuffer, OPTIONAL\r
  OUT EFI_HII_GLYPH_INFO             *Cell, OPTIONAL\r
  OUT UINTN                          *GlyphBufferLen OPTIONAL\r
  );\r
\r
/**\r
  This function exports Form packages to a buffer.\r
  This is a internal function.\r
\r
  @param  Private                Hii database private structure.\r
  @param  Handle                 Identification of a package list.\r
  @param  PackageList            Pointer to a package list which will be exported.\r
  @param  UsedSize               The length of buffer be used.\r
  @param  BufferSize             Length of the Buffer.\r
  @param  Buffer                 Allocated space for storing exported data.\r
  @param  ResultSize             The size of the already exported content of  this\r
                                 package list.\r
\r
  @retval EFI_SUCCESS            Form Packages are exported successfully.\r
  @retval EFI_INVALID_PARAMETER  Any input parameter is invalid.\r
\r
**/\r
EFI_STATUS\r
ExportFormPackages (\r
  IN HII_DATABASE_PRIVATE_DATA          *Private,\r
  IN EFI_HII_HANDLE                     Handle,\r
  IN HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageList,\r
  IN UINTN                              UsedSize,\r
  IN UINTN                              BufferSize,\r
  IN OUT VOID                           *Buffer,\r
  IN OUT UINTN                          *ResultSize\r
  );\r
\r
//\r
// EFI_HII_FONT_PROTOCOL protocol interfaces\r
//\r
\r
\r
/**\r
  Renders a string to a bitmap or to the display.\r
\r
  @param  This                    A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
  @param  Flags                   Describes how the string is to be drawn.\r
  @param  String                  Points to the null-terminated string to be\r
                                  displayed.\r
  @param  StringInfo              Points to the string output information,\r
                                  including the color and font.  If NULL, then the\r
                                  string will be output in the default system font\r
                                  and color.\r
  @param  Blt                     If this points to a non-NULL on entry, this\r
                                  points to the image, which is Width pixels   wide\r
                                  and Height pixels high. The string will be drawn\r
                                  onto this image and\r
                                  EFI_HII_OUT_FLAG_CLIP is implied. If this points\r
                                  to a NULL on entry, then a              buffer\r
                                  will be allocated to hold the generated image and\r
                                  the pointer updated on exit. It is the caller's\r
                                  responsibility to free this buffer.\r
  @param  BltX                    Together with BltX, Specifies the offset from the left and top edge\r
                                  of the image of the first character cell in the\r
                                  image.\r
  @param  BltY                    Together with BltY, Specifies the offset from the left and top edge\r
                                  of the image of the first character cell in the\r
                                  image.\r
  @param  RowInfoArray            If this is non-NULL on entry, then on exit, this\r
                                  will point to an allocated buffer    containing\r
                                  row information and RowInfoArraySize will be\r
                                  updated to contain the        number of elements.\r
                                  This array describes the characters which were at\r
                                  least partially drawn and the heights of the\r
                                  rows. It is the caller's responsibility to free\r
                                  this buffer.\r
  @param  RowInfoArraySize        If this is non-NULL on entry, then on exit it\r
                                  contains the number of elements in RowInfoArray.\r
  @param  ColumnInfoArray         If this is non-NULL, then on return it will be\r
                                  filled with the horizontal offset for each\r
                                  character in the string on the row where it is\r
                                  displayed. Non-printing characters will     have\r
                                  the offset ~0. The caller is responsible to\r
                                  allocate a buffer large enough so that    there\r
                                  is one entry for each character in the string,\r
                                  not including the null-terminator. It is possible\r
                                  when character display is normalized that some\r
                                  character cells overlap.\r
\r
  @retval EFI_SUCCESS             The string was successfully rendered.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for\r
                                  RowInfoArray or Blt.\r
  @retval EFI_INVALID_PARAMETER The String or Blt.\r
  @retval EFI_INVALID_PARAMETER Flags were invalid combination..\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiStringToImage (\r
  IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
  IN  EFI_HII_OUT_FLAGS              Flags,\r
  IN  CONST EFI_STRING               String,\r
  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo       OPTIONAL,\r
  IN  OUT EFI_IMAGE_OUTPUT           **Blt,\r
  IN  UINTN                          BltX,\r
  IN  UINTN                          BltY,\r
  OUT EFI_HII_ROW_INFO               **RowInfoArray    OPTIONAL,\r
  OUT UINTN                          *RowInfoArraySize OPTIONAL,\r
  OUT UINTN                          *ColumnInfoArray  OPTIONAL\r
  );\r
\r
\r
/**\r
  Render a string to a bitmap or the screen containing the contents of the specified string.\r
\r
  @param  This                    A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
  @param  Flags                   Describes how the string is to be drawn.\r
  @param  PackageList             The package list in the HII database to search\r
                                  for the specified string.\r
  @param  StringId                The string's id, which is unique within\r
                                  PackageList.\r
  @param  Language                Points to the language for the retrieved string.\r
                                  If NULL, then the current system language is\r
                                  used.\r
  @param  StringInfo              Points to the string output information,\r
                                  including the color and font.  If NULL, then the\r
                                  string will be output in the default system font\r
                                  and color.\r
  @param  Blt                     If this points to a non-NULL on entry, this\r
                                  points to the image, which is Width pixels   wide\r
                                  and Height pixels high. The string will be drawn\r
                                  onto this image and\r
                                  EFI_HII_OUT_FLAG_CLIP is implied. If this points\r
                                  to a NULL on entry, then a              buffer\r
                                  will be allocated to hold the generated image and\r
                                  the pointer updated on exit. It is the caller's\r
                                  responsibility to free this buffer.\r
  @param  BltX                    Together with BltX, Specifies the offset from the left and top edge\r
                                  of the image of the first character cell in the\r
                                  image.\r
  @param  BltY                    Together with BltY, Specifies the offset from the left and top edge\r
                                  of the image of the first character cell in the\r
                                  image.\r
  @param  RowInfoArray            If this is non-NULL on entry, then on exit, this\r
                                  will point to an allocated buffer    containing\r
                                  row information and RowInfoArraySize will be\r
                                  updated to contain the        number of elements.\r
                                  This array describes the characters which were at\r
                                  least partially drawn and the heights of the\r
                                  rows. It is the caller's responsibility to free\r
                                  this buffer.\r
  @param  RowInfoArraySize        If this is non-NULL on entry, then on exit it\r
                                  contains the number of elements in RowInfoArray.\r
  @param  ColumnInfoArray         If this is non-NULL, then on return it will be\r
                                  filled with the horizontal offset for each\r
                                  character in the string on the row where it is\r
                                  displayed. Non-printing characters will     have\r
                                  the offset ~0. The caller is responsible to\r
                                  allocate a buffer large enough so that    there\r
                                  is one entry for each character in the string,\r
                                  not including the null-terminator. It is possible\r
                                  when character display is normalized that some\r
                                  character cells overlap.\r
\r
  @retval EFI_SUCCESS             The string was successfully rendered.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for\r
                                  RowInfoArray or Blt.\r
  @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
  @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r
  @retval EFI_NOT_FOUND         The specified PackageList is not in the Database or the stringid is not \r
                          in the specified PackageList. \r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiStringIdToImage (\r
  IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
  IN  EFI_HII_OUT_FLAGS              Flags,\r
  IN  EFI_HII_HANDLE                 PackageList,\r
  IN  EFI_STRING_ID                  StringId,\r
  IN  CONST CHAR8*                   Language,\r
  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo       OPTIONAL,\r
  IN  OUT EFI_IMAGE_OUTPUT           **Blt,\r
  IN  UINTN                          BltX,\r
  IN  UINTN                          BltY,\r
  OUT EFI_HII_ROW_INFO               **RowInfoArray    OPTIONAL,\r
  OUT UINTN                          *RowInfoArraySize OPTIONAL,\r
  OUT UINTN                          *ColumnInfoArray  OPTIONAL\r
  );\r
\r
\r
/**\r
  Convert the glyph for a single character into a bitmap.\r
\r
  @param  This                    A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
  @param  Char                    Character to retrieve.\r
  @param  StringInfo              Points to the string font and color information\r
                                  or NULL if the string should use the default\r
                                  system font and color.\r
  @param  Blt                     Thus must point to a NULL on entry. A buffer will\r
                                  be allocated to hold the output and the pointer\r
                                  updated on exit. It is the caller's\r
                                  responsibility to free this buffer.\r
  @param  Baseline                Number of pixels from the bottom of the bitmap to\r
                                  the baseline.\r
\r
  @retval EFI_SUCCESS             Glyph bitmap created.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate the output buffer Blt.\r
  @retval EFI_WARN_UNKNOWN_GLYPH  The glyph was unknown and was replaced with the\r
                                  glyph for Unicode character 0xFFFD.\r
  @retval EFI_INVALID_PARAMETER   Blt is NULL or *Blt is not NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetGlyph (\r
  IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
  IN  CHAR16                         Char,\r
  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo,\r
  OUT EFI_IMAGE_OUTPUT               **Blt,\r
  OUT UINTN                          *Baseline OPTIONAL\r
  );\r
\r
\r
/**\r
  This function iterates through fonts which match the specified font, using\r
  the specified criteria. If String is non-NULL, then all of the characters in\r
  the string must exist in order for a candidate font to be returned.\r
\r
  @param  This                    A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
  @param  FontHandle              On entry, points to the font handle returned by a\r
                                   previous call to GetFontInfo() or NULL to start\r
                                  with the  first font. On return, points to the\r
                                  returned font handle or points to NULL if there\r
                                  are no more matching fonts.\r
  @param  StringInfoIn            Upon entry, points to the font to return information\r
                                  about. If NULL, then the information about the system\r
                                  default font will be returned.\r
  @param  StringInfoOut           Upon return, contains the matching font's information.\r
                                  If NULL, then no information is returned. This buffer\r
                                  is allocated with a call to the Boot Service AllocatePool().\r
                                  It is the caller's responsibility to call the Boot \r
                                  Service FreePool() when the caller no longer requires\r
                                  the contents of StringInfoOut.\r
  @param  String                  Points to the string which will be tested to\r
                                  determine  if all characters are available. If\r
                                  NULL, then any font  is acceptable.\r
\r
  @retval EFI_SUCCESS             Matching font returned successfully.\r
  @retval EFI_NOT_FOUND           No matching font was found.\r
  @retval EFI_INVALID_PARAMETER   StringInfoIn is NULL.\r
  @retval EFI_INVALID_PARAMETER   StringInfoIn->FontInfoMask is an invalid combination.\r
  @retval EFI_OUT_OF_RESOURCES    There were insufficient resources to complete the\r
                                  request.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetFontInfo (\r
  IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
  IN  OUT   EFI_FONT_HANDLE          *FontHandle,\r
  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfoIn, OPTIONAL\r
  OUT       EFI_FONT_DISPLAY_INFO    **StringInfoOut,\r
  IN  CONST EFI_STRING               String OPTIONAL\r
  );\r
\r
//\r
// EFI_HII_IMAGE_PROTOCOL interfaces\r
//\r
\r
\r
/**\r
  This function adds the image Image to the group of images owned by PackageList, and returns\r
  a new image identifier (ImageId).\r
\r
  @param  This                    A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
  @param  PackageList             Handle of the package list where this image will\r
                                  be added.\r
  @param  ImageId                 On return, contains the new image id, which is\r
                                  unique within PackageList.\r
  @param  Image                   Points to the image.\r
\r
  @retval EFI_SUCCESS             The new image was added successfully.\r
  @retval EFI_NOT_FOUND           The specified PackageList could not be found in\r
                                  database.\r
  @retval EFI_OUT_OF_RESOURCES    Could not add the image due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER   Image is NULL or ImageId is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiNewImage (\r
  IN  CONST EFI_HII_IMAGE_PROTOCOL   *This,\r
  IN  EFI_HII_HANDLE                 PackageList,\r
  OUT EFI_IMAGE_ID                   *ImageId,\r
  IN  CONST EFI_IMAGE_INPUT          *Image\r
  );\r
\r
\r
/**\r
  This function retrieves the image specified by ImageId which is associated with\r
  the specified PackageList and copies it into the buffer specified by Image.\r
\r
  @param  This                    A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
  @param  PackageList             Handle of the package list where this image will\r
                                  be searched.\r
  @param  ImageId                 The image's id,, which is unique within\r
                                  PackageList.\r
  @param  Image                   Points to the image.\r
\r
  @retval EFI_SUCCESS             The new image was returned successfully.\r
  @retval EFI_NOT_FOUND           The image specified by ImageId is not available.\r
                                                 The specified PackageList is not in the database.\r
  @retval EFI_BUFFER_TOO_SMALL    The buffer specified by ImageSize is too small to\r
                                  hold the image.\r
  @retval EFI_INVALID_PARAMETER   The Image or ImageSize was NULL.\r
  @retval EFI_OUT_OF_RESOURCES   The bitmap could not be retrieved because there was not\r
                                                       enough memory.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetImage (\r
  IN  CONST EFI_HII_IMAGE_PROTOCOL   *This,\r
  IN  EFI_HII_HANDLE                 PackageList,\r
  IN  EFI_IMAGE_ID                   ImageId,\r
  OUT EFI_IMAGE_INPUT                *Image\r
  );\r
\r
\r
/**\r
  This function updates the image specified by ImageId in the specified PackageListHandle to\r
  the image specified by Image.\r
\r
  @param  This                    A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
  @param  PackageList             The package list containing the images.\r
  @param  ImageId                 The image's id,, which is unique within\r
                                  PackageList.\r
  @param  Image                   Points to the image.\r
\r
  @retval EFI_SUCCESS             The new image was updated successfully.\r
  @retval EFI_NOT_FOUND           The image specified by ImageId is not in the\r
                                                database. The specified PackageList is not in the database.\r
  @retval EFI_INVALID_PARAMETER   The Image was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiSetImage (\r
  IN CONST EFI_HII_IMAGE_PROTOCOL    *This,\r
  IN EFI_HII_HANDLE                  PackageList,\r
  IN EFI_IMAGE_ID                    ImageId,\r
  IN CONST EFI_IMAGE_INPUT           *Image\r
  );\r
\r
\r
/**\r
  This function renders an image to a bitmap or the screen using the specified\r
  color and options. It draws the image on an existing bitmap, allocates a new\r
  bitmap or uses the screen. The images can be clipped.\r
\r
  @param  This                    A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
  @param  Flags                   Describes how the image is to be drawn.\r
  @param  Image                   Points to the image to be displayed.\r
  @param  Blt                     If this points to a non-NULL on entry, this\r
                                  points to the image, which is Width pixels wide\r
                                  and Height pixels high.  The image will be drawn\r
                                  onto this image and  EFI_HII_DRAW_FLAG_CLIP is\r
                                  implied. If this points to a  NULL on entry, then\r
                                  a buffer will be allocated to hold  the generated\r
                                  image and the pointer updated on exit. It is the\r
                                  caller's responsibility to free this buffer.\r
  @param  BltX                    Specifies the offset from the left and top edge\r
                                  of the  output image of the first pixel in the\r
                                  image.\r
  @param  BltY                    Specifies the offset from the left and top edge\r
                                  of the  output image of the first pixel in the\r
                                  image.\r
\r
  @retval EFI_SUCCESS             The image was successfully drawn.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for Blt.\r
  @retval EFI_INVALID_PARAMETER   The Image or Blt was NULL.\r
  @retval EFI_INVALID_PARAMETER   Any combination of Flags is invalid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiDrawImage (\r
  IN CONST EFI_HII_IMAGE_PROTOCOL    *This,\r
  IN EFI_HII_DRAW_FLAGS              Flags,\r
  IN CONST EFI_IMAGE_INPUT           *Image,\r
  IN OUT EFI_IMAGE_OUTPUT            **Blt,\r
  IN UINTN                           BltX,\r
  IN UINTN                           BltY\r
  );\r
\r
\r
/**\r
  This function renders an image to a bitmap or the screen using the specified\r
  color and options. It draws the image on an existing bitmap, allocates a new\r
  bitmap or uses the screen. The images can be clipped.\r
\r
  @param  This                    A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
  @param  Flags                   Describes how the image is to be drawn.\r
  @param  PackageList             The package list in the HII database to search\r
                                  for the  specified image.\r
  @param  ImageId                 The image's id, which is unique within\r
                                  PackageList.\r
  @param  Blt                     If this points to a non-NULL on entry, this\r
                                  points to the image, which is Width pixels wide\r
                                  and Height pixels high. The image will be drawn\r
                                  onto this image and\r
                                  EFI_HII_DRAW_FLAG_CLIP is implied. If this points\r
                                  to a  NULL on entry, then a buffer will be\r
                                  allocated to hold  the generated image and the\r
                                  pointer updated on exit. It is the caller's\r
                                  responsibility to free this buffer.\r
  @param  BltX                    Specifies the offset from the left and top edge\r
                                  of the  output image of the first pixel in the\r
                                  image.\r
  @param  BltY                    Specifies the offset from the left and top edge\r
                                  of the  output image of the first pixel in the\r
                                  image.\r
\r
  @retval EFI_SUCCESS             The image was successfully drawn.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for Blt.\r
  @retval EFI_INVALID_PARAMETER  The Blt was NULL.\r
  @retval EFI_NOT_FOUND          The image specified by ImageId is not in the database. \r
                           The specified PackageList is not in the database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiDrawImageId (\r
  IN CONST EFI_HII_IMAGE_PROTOCOL    *This,\r
  IN EFI_HII_DRAW_FLAGS              Flags,\r
  IN EFI_HII_HANDLE                  PackageList,\r
  IN EFI_IMAGE_ID                    ImageId,\r
  IN OUT EFI_IMAGE_OUTPUT            **Blt,\r
  IN UINTN                           BltX,\r
  IN UINTN                           BltY\r
  )\r
\r
;\r
\r
//\r
// EFI_HII_STRING_PROTOCOL\r
//\r
\r
\r
/**\r
  This function adds the string String to the group of strings owned by PackageList, with the\r
  specified font information StringFontInfo and returns a new string id.\r
\r
  @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                  instance.\r
  @param  PackageList             Handle of the package list where this string will\r
                                  be added.\r
  @param  StringId                On return, contains the new strings id, which is\r
                                  unique within PackageList.\r
  @param  Language                Points to the language for the new string.\r
  @param  LanguageName            Points to the printable language name to\r
                                  associate with the passed in  Language field.If\r
                                  LanguageName is not NULL and the string package\r
                                  header's LanguageName  associated with a given\r
                                  Language is not zero, the LanguageName being\r
                                  passed  in will be ignored.\r
  @param  String                  Points to the new null-terminated string.\r
  @param  StringFontInfo          Points to the new string's font information or\r
                                  NULL if the string should have the default system\r
                                  font, size and style.\r
\r
  @retval EFI_SUCCESS             The new string was added successfully.\r
  @retval EFI_NOT_FOUND           The specified PackageList could not be found in\r
                                  database.\r
  @retval EFI_OUT_OF_RESOURCES    Could not add the string due to lack of\r
                                  resources.\r
  @retval EFI_INVALID_PARAMETER   String is NULL or StringId is NULL or Language is\r
                                  NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiNewString (\r
  IN  CONST EFI_HII_STRING_PROTOCOL   *This,\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  OUT EFI_STRING_ID                   *StringId,\r
  IN  CONST CHAR8                     *Language,\r
  IN  CONST CHAR16                    *LanguageName, OPTIONAL\r
  IN  CONST EFI_STRING                String,\r
  IN  CONST EFI_FONT_INFO             *StringFontInfo OPTIONAL\r
  );\r
\r
\r
/**\r
  This function retrieves the string specified by StringId which is associated\r
  with the specified PackageList in the language Language and copies it into\r
  the buffer specified by String.\r
\r
  @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                  instance.\r
  @param  Language                Points to the language for the retrieved string.\r
  @param  PackageList             The package list in the HII database to search\r
                                  for the  specified string.\r
  @param  StringId                The string's id, which is unique within\r
                                  PackageList.\r
  @param  String                  Points to the new null-terminated string.\r
  @param  StringSize              On entry, points to the size of the buffer\r
                                  pointed to by  String, in bytes. On return,\r
                                  points to the length of the string, in bytes.\r
  @param  StringFontInfo          If not NULL, points to the string's font\r
                                  information.  It's caller's responsibility to\r
                                  free this buffer.\r
\r
  @retval EFI_SUCCESS             The string was returned successfully.\r
  @retval EFI_NOT_FOUND           The string specified by StringId is not\r
                                  available.\r
                                  The specified PackageList is not in the database.\r
  @retval EFI_INVALID_LANGUAGE    The string specified by StringId is available but\r
                                  not in the specified language.\r
  @retval EFI_BUFFER_TOO_SMALL    The buffer specified by StringSize is too small\r
                                  to  hold the string.\r
  @retval EFI_INVALID_PARAMETER   The Language or StringSize was NULL.\r
  @retval EFI_INVALID_PARAMETER   The value referenced by StringSize was not zero\r
                                  and String was NULL.\r
  @retval EFI_OUT_OF_RESOURCES    There were insufficient resources to complete the\r
                                   request.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetString (\r
  IN  CONST EFI_HII_STRING_PROTOCOL   *This,\r
  IN  CONST CHAR8                     *Language,\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  IN  EFI_STRING_ID                   StringId,\r
  OUT EFI_STRING                      String,\r
  IN  OUT UINTN                       *StringSize,\r
  OUT EFI_FONT_INFO                   **StringFontInfo OPTIONAL\r
  );\r
\r
\r
/**\r
  This function updates the string specified by StringId in the specified PackageList to the text\r
  specified by String and, optionally, the font information specified by StringFontInfo.\r
\r
  @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                  instance.\r
  @param  PackageList             The package list containing the strings.\r
  @param  StringId                The string's id, which is unique within\r
                                  PackageList.\r
  @param  Language                Points to the language for the updated string.\r
  @param  String                  Points to the new null-terminated string.\r
  @param  StringFontInfo          Points to the string's font information or NULL\r
                                  if the string font information is not changed.\r
\r
  @retval EFI_SUCCESS             The string was updated successfully.\r
  @retval EFI_NOT_FOUND           The string specified by StringId is not in the\r
                                  database.\r
  @retval EFI_INVALID_PARAMETER   The String or Language was NULL.\r
  @retval EFI_OUT_OF_RESOURCES    The system is out of resources to accomplish the\r
                                  task.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiSetString (\r
  IN CONST EFI_HII_STRING_PROTOCOL    *This,\r
  IN EFI_HII_HANDLE                   PackageList,\r
  IN EFI_STRING_ID                    StringId,\r
  IN CONST CHAR8                      *Language,\r
  IN CONST EFI_STRING                 String,\r
  IN CONST EFI_FONT_INFO              *StringFontInfo OPTIONAL\r
  );\r
\r
\r
/**\r
  This function returns the list of supported languages, in the format specified\r
  in Appendix M of UEFI 2.1 spec.\r
\r
  @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                  instance.\r
  @param  PackageList             The package list to examine.\r
  @param  Languages               Points to the buffer to hold the returned\r
                                  null-terminated ASCII string.\r
  @param  LanguagesSize           On entry, points to the size of the buffer\r
                                  pointed to by  Languages, in bytes. On  return,\r
                                  points to the length of Languages, in bytes.\r
\r
  @retval EFI_SUCCESS             The languages were returned successfully.\r
  @retval EFI_INVALID_PARAMETER   The LanguagesSize was NULL.\r
  @retval EFI_INVALID_PARAMETER   The value referenced by LanguagesSize is not zero and Languages is NULL.\r
  @retval EFI_BUFFER_TOO_SMALL    The LanguagesSize is too small to hold the list\r
                                  of  supported languages. LanguageSize is updated\r
                                  to contain the required size.\r
  @retval EFI_NOT_FOUND           Could not find string package in specified\r
                                  packagelist.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetLanguages (\r
  IN CONST EFI_HII_STRING_PROTOCOL    *This,\r
  IN EFI_HII_HANDLE                   PackageList,\r
  IN OUT CHAR8                        *Languages,\r
  IN OUT UINTN                        *LanguagesSize\r
  );\r
\r
\r
/**\r
  Each string package has associated with it a single primary language and zero\r
  or more secondary languages. This routine returns the secondary languages\r
  associated with a package list.\r
\r
  @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                  instance.\r
  @param  PackageList             The package list to examine.\r
  @param  PrimaryLanguage         Points to the null-terminated ASCII string that specifies\r
                                  the primary language. Languages are specified in the\r
                                  format specified in Appendix M of the UEFI 2.0 specification.\r
  @param  SecondaryLanguages      Points to the buffer to hold the returned null-terminated\r
                                  ASCII string that describes the list of\r
                                  secondary languages for the specified\r
                                  PrimaryLanguage. If there are no secondary\r
                                  languages, the function returns successfully,\r
                                  but this is set to NULL.\r
  @param  SecondaryLanguagesSize  On entry, points to the size of the buffer\r
                                  pointed to by SecondaryLanguages, in bytes. On\r
                                  return, points to the length of SecondaryLanguages\r
                                  in bytes.\r
\r
  @retval EFI_SUCCESS             Secondary languages were correctly returned.\r
  @retval EFI_INVALID_PARAMETER   PrimaryLanguage or SecondaryLanguagesSize was NULL.\r
  @retval EFI_INVALID_PARAMETER   The value referenced by SecondaryLanguagesSize is not\r
                                  zero and SecondaryLanguages is NULL.\r
  @retval EFI_BUFFER_TOO_SMALL    The buffer specified by SecondaryLanguagesSize is\r
                                  too small to hold the returned information.\r
                                  SecondaryLanguageSize is updated to hold the size of\r
                                  the buffer required.\r
  @retval EFI_INVALID_LANGUAGE    The language specified by PrimaryLanguage is not\r
                                  present in the specified package list.\r
  @retval EFI_NOT_FOUND           The specified PackageList is not in the Database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetSecondaryLanguages (\r
  IN CONST EFI_HII_STRING_PROTOCOL   *This,\r
  IN EFI_HII_HANDLE                  PackageList,\r
  IN CONST CHAR8                     *PrimaryLanguage,\r
  IN OUT CHAR8                       *SecondaryLanguages,\r
  IN OUT UINTN                       *SecondaryLanguagesSize\r
  );\r
\r
//\r
// EFI_HII_DATABASE_PROTOCOL protocol interfaces\r
//\r
\r
\r
/**\r
  This function adds the packages in the package list to the database and returns a handle. If there is a\r
  EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then this function will\r
  create a package of type EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  PackageList             A pointer to an EFI_HII_PACKAGE_LIST_HEADER\r
                                  structure.\r
  @param  DriverHandle            Associate the package list with this EFI handle.\r
                                  If a NULL is specified, this data will not be associate\r
                                  with any drivers and cannot have a callback induced.\r
  @param  Handle                  A pointer to the EFI_HII_HANDLE instance.\r
\r
  @retval EFI_SUCCESS             The package list associated with the Handle was\r
                                  added to the HII database.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate necessary resources for the\r
                                  new database contents.\r
  @retval EFI_INVALID_PARAMETER   PackageList is NULL or Handle is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiNewPackageList (\r
  IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
  IN CONST EFI_HII_PACKAGE_LIST_HEADER  *PackageList,\r
  IN CONST EFI_HANDLE                   DriverHandle, OPTIONAL\r
  OUT EFI_HII_HANDLE                    *Handle\r
  );\r
\r
\r
/**\r
  This function removes the package list that is associated with a handle Handle\r
  from the HII database. Before removing the package, any registered functions\r
  with the notification type REMOVE_PACK and the same package type will be called.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  Handle                  The handle that was registered to the data that\r
                                  is requested  for removal.\r
\r
  @retval EFI_SUCCESS             The data associated with the Handle was removed\r
                                  from  the HII database.\r
  @retval EFI_NOT_FOUND           The specified Handle is not in database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiRemovePackageList (\r
  IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
  IN EFI_HII_HANDLE                     Handle\r
  );\r
\r
\r
/**\r
  This function updates the existing package list (which has the specified Handle)\r
  in the HII databases, using the new package list specified by PackageList.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  Handle                  The handle that was registered to the data that\r
                                  is  requested to be updated.\r
  @param  PackageList             A pointer to an EFI_HII_PACKAGE_LIST_HEADER\r
                                  package.\r
\r
  @retval EFI_SUCCESS             The HII database was successfully updated.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate enough memory for the updated\r
                                  database.\r
  @retval EFI_INVALID_PARAMETER  PackageList was NULL.\r
  @retval EFI_NOT_FOUND          The specified Handle is not in database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiUpdatePackageList (\r
  IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
  IN EFI_HII_HANDLE                     Handle,\r
  IN CONST EFI_HII_PACKAGE_LIST_HEADER  *PackageList\r
  );\r
\r
\r
/**\r
  This function returns a list of the package handles of the specified type\r
  that are currently active in the database. The pseudo-type\r
  EFI_HII_PACKAGE_TYPE_ALL will cause all package handles to be listed.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  PackageType             Specifies the package type of the packages to\r
                                  list or EFI_HII_PACKAGE_TYPE_ALL for all packages\r
                                  to be listed.\r
  @param  PackageGuid             If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then\r
                                  this  is the pointer to the GUID which must match\r
                                  the Guid field of EFI_HII_GUID_PACKAGE_GUID_HDR.\r
                                  Otherwise,  it must be NULL.\r
  @param  HandleBufferLength      On input, a pointer to the length of the handle\r
                                  buffer.  On output, the length of the handle\r
                                  buffer that is required for the handles found.\r
  @param  Handle                  An array of EFI_HII_HANDLE instances returned.\r
\r
  @retval EFI_SUCCESS             The matching handles are outputed successfully.\r
                                  HandleBufferLength is updated with the actual length.\r
  @retval EFI_BUFFER_TO_SMALL     The HandleBufferLength parameter indicates that\r
                                  Handle is too small to support the number of\r
                                  handles. HandleBufferLength is updated with a\r
                                  value that will  enable the data to fit.\r
  @retval EFI_NOT_FOUND           No matching handle could not be found in\r
                                  database.\r
  @retval EFI_INVALID_PARAMETER   HandleBufferLength was NULL.\r
  @retval EFI_INVALID_PARAMETER   The value referenced by HandleBufferLength was not\r
                                  zero and Handle was NULL.\r
  @retval EFI_INVALID_PARAMETER   PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
                                  PackageGuid is not NULL, PackageType is a EFI_HII_\r
                                  PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiListPackageLists (\r
  IN  CONST EFI_HII_DATABASE_PROTOCOL   *This,\r
  IN  UINT8                             PackageType,\r
  IN  CONST EFI_GUID                    *PackageGuid,\r
  IN  OUT UINTN                         *HandleBufferLength,\r
  OUT EFI_HII_HANDLE                    *Handle\r
  );\r
\r
\r
/**\r
  This function will export one or all package lists in the database to a buffer.\r
  For each package list exported, this function will call functions registered\r
  with EXPORT_PACK and then copy the package list to the buffer.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  Handle                  An EFI_HII_HANDLE that corresponds to the desired\r
                                  package list in the HII database to export or\r
                                  NULL to indicate  all package lists should be\r
                                  exported.\r
  @param  BufferSize              On input, a pointer to the length of the buffer.\r
                                  On output, the length of the buffer that is\r
                                  required for the exported data.\r
  @param  Buffer                  A pointer to a buffer that will contain the\r
                                  results of  the export function.\r
\r
  @retval EFI_SUCCESS             Package exported.\r
  @retval EFI_BUFFER_TO_SMALL     The HandleBufferLength parameter indicates that\r
                                  Handle is too small to support the number of\r
                                  handles.      HandleBufferLength is updated with\r
                                  a value that will enable the data to fit.\r
  @retval EFI_NOT_FOUND           The specifiecd Handle could not be found in the\r
                                  current database.\r
  @retval EFI_INVALID_PARAMETER   BufferSize was NULL.\r
  @retval EFI_INVALID_PARAMETER   The value referenced by BufferSize was not zero \r
                                  and Buffer was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiExportPackageLists (\r
  IN  CONST EFI_HII_DATABASE_PROTOCOL   *This,\r
  IN  EFI_HII_HANDLE                    Handle,\r
  IN  OUT UINTN                         *BufferSize,\r
  OUT EFI_HII_PACKAGE_LIST_HEADER       *Buffer\r
  );\r
\r
\r
/**\r
  This function registers a function which will be called when specified actions related to packages of\r
  the specified type occur in the HII database. By registering a function, other HII-related drivers are\r
  notified when specific package types are added, removed or updated in the HII database.\r
  Each driver or application which registers a notification should use\r
  EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before exiting.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  PackageType             Specifies the package type of the packages to\r
                                  list or EFI_HII_PACKAGE_TYPE_ALL for all packages\r
                                  to be listed.\r
  @param  PackageGuid             If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then\r
                                  this is the pointer to the GUID which must match\r
                                  the Guid field of\r
                                  EFI_HII_GUID_PACKAGE_GUID_HDR. Otherwise, it must\r
                                  be NULL.\r
  @param  PackageNotifyFn         Points to the function to be called when the\r
                                  event specified by\r
                                  NotificationType occurs.\r
  @param  NotifyType              Describes the types of notification which this\r
                                  function will be receiving.\r
  @param  NotifyHandle            Points to the unique handle assigned to the\r
                                  registered notification. Can be used in\r
                                  EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify()\r
                                  to stop notifications.\r
\r
  @retval EFI_SUCCESS             Notification registered successfully.\r
  @retval EFI_OUT_OF_RESOURCES    Unable to allocate necessary data structures\r
  @retval EFI_INVALID_PARAMETER   NotifyHandle is NULL.\r
  @retval EFI_INVALID_PARAMETER   PackageGuid is not NULL when PackageType is not\r
                                  EFI_HII_PACKAGE_TYPE_GUID.\r
  @retval EFI_INVALID_PARAMETER   PackageGuid is NULL when PackageType is\r
                                  EFI_HII_PACKAGE_TYPE_GUID.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiRegisterPackageNotify (\r
  IN  CONST EFI_HII_DATABASE_PROTOCOL   *This,\r
  IN  UINT8                             PackageType,\r
  IN  CONST EFI_GUID                    *PackageGuid,\r
  IN  CONST EFI_HII_DATABASE_NOTIFY     PackageNotifyFn,\r
  IN  EFI_HII_DATABASE_NOTIFY_TYPE      NotifyType,\r
  OUT EFI_HANDLE                        *NotifyHandle\r
  );\r
\r
\r
/**\r
  Removes the specified HII database package-related notification.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  NotificationHandle      The handle of the notification function being\r
                                  unregistered.\r
\r
  @retval EFI_SUCCESS             Notification is unregistered successfully.\r
  @retval EFI_NOT_FOUND          The incoming notification handle does not exist \r
                           in current hii database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiUnregisterPackageNotify (\r
  IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
  IN EFI_HANDLE                         NotificationHandle\r
  );\r
\r
\r
/**\r
  This routine retrieves an array of GUID values for each keyboard layout that\r
  was previously registered in the system.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  KeyGuidBufferLength     On input, a pointer to the length of the keyboard\r
                                  GUID  buffer. On output, the length of the handle\r
                                  buffer  that is required for the handles found.\r
  @param  KeyGuidBuffer           An array of keyboard layout GUID instances\r
                                  returned.\r
\r
  @retval EFI_SUCCESS             KeyGuidBuffer was updated successfully.\r
  @retval EFI_BUFFER_TOO_SMALL    The KeyGuidBufferLength parameter indicates\r
                                  that KeyGuidBuffer is too small to support the\r
                                  number of GUIDs. KeyGuidBufferLength is\r
                                  updated with a value that will enable the data to\r
                                  fit.\r
  @retval EFI_INVALID_PARAMETER   The KeyGuidBufferLength is NULL.\r
  @retval EFI_INVALID_PARAMETER   The value referenced by KeyGuidBufferLength is not\r
                                  zero and KeyGuidBuffer is NULL.\r
  @retval EFI_NOT_FOUND           There was no keyboard layout.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiFindKeyboardLayouts (\r
  IN  CONST EFI_HII_DATABASE_PROTOCOL   *This,\r
  IN  OUT UINT16                        *KeyGuidBufferLength,\r
  OUT EFI_GUID                          *KeyGuidBuffer\r
  );\r
\r
\r
/**\r
  This routine retrieves the requested keyboard layout. The layout is a physical description of the keys\r
  on a keyboard and the character(s) that are associated with a particular set of key strokes.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  KeyGuid                 A pointer to the unique ID associated with a\r
                                  given keyboard layout. If KeyGuid is NULL then\r
                                  the current layout will be retrieved.\r
  @param  KeyboardLayoutLength    On input, a pointer to the length of the\r
                                  KeyboardLayout buffer.  On output, the length of\r
                                  the data placed into KeyboardLayout.\r
  @param  KeyboardLayout          A pointer to a buffer containing the retrieved\r
                                  keyboard layout.\r
\r
  @retval EFI_SUCCESS             The keyboard layout was retrieved successfully.\r
  @retval EFI_NOT_FOUND           The requested keyboard layout was not found.\r
  @retval EFI_INVALID_PARAMETER   The KeyboardLayout or KeyboardLayoutLength was\r
                                  NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetKeyboardLayout (\r
  IN  CONST EFI_HII_DATABASE_PROTOCOL   *This,\r
  IN  CONST EFI_GUID                          *KeyGuid,\r
  IN OUT UINT16                         *KeyboardLayoutLength,\r
  OUT EFI_HII_KEYBOARD_LAYOUT           *KeyboardLayout\r
  );\r
\r
\r
/**\r
  This routine sets the default keyboard layout to the one referenced by KeyGuid. When this routine\r
  is called, an event will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID\r
  group type. This is so that agents which are sensitive to the current keyboard layout being changed\r
  can be notified of this change.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  KeyGuid                 A pointer to the unique ID associated with a\r
                                  given keyboard layout.\r
\r
  @retval EFI_SUCCESS             The current keyboard layout was successfully set.\r
  @retval EFI_NOT_FOUND           The referenced keyboard layout was not found, so\r
                                  action was taken.\r
  @retval EFI_INVALID_PARAMETER   The KeyGuid was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiSetKeyboardLayout (\r
  IN CONST EFI_HII_DATABASE_PROTOCOL          *This,\r
  IN CONST EFI_GUID                           *KeyGuid\r
  );\r
\r
\r
/**\r
  Return the EFI handle associated with a package list.\r
\r
  @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                  instance.\r
  @param  PackageListHandle       An EFI_HII_HANDLE that corresponds to the desired\r
                                  package list in the HIIdatabase.\r
  @param  DriverHandle            On return, contains the EFI_HANDLE which was\r
                                  registered with the package list in\r
                                  NewPackageList().\r
\r
  @retval EFI_SUCCESS             The DriverHandle was returned successfully.\r
  @retval EFI_INVALID_PARAMETER   The PackageListHandle was not valid or\r
                                  DriverHandle was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetPackageListHandle (\r
  IN  CONST EFI_HII_DATABASE_PROTOCOL         *This,\r
  IN  EFI_HII_HANDLE                    PackageListHandle,\r
  OUT EFI_HANDLE                        *DriverHandle\r
  );\r
\r
//\r
// EFI_HII_CONFIG_ROUTING_PROTOCOL interfaces\r
//\r
\r
\r
/**\r
  This function allows a caller to extract the current configuration\r
  for one or more named elements from one or more drivers.\r
\r
  @param  This                    A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
                                  instance.\r
  @param  Request                 A null-terminated Unicode string in\r
                                  <MultiConfigRequest> format.\r
  @param  Progress                On return, points to a character in the Request\r
                                  string. Points to the string's null terminator if\r
                                  request was successful. Points to the most recent\r
                                  & before the first failing name / value pair (or\r
                                  the beginning of the string if the failure is in\r
                                  the first name / value pair) if the request was\r
                                  not successful.\r
  @param  Results                 Null-terminated Unicode string in\r
                                  <MultiConfigAltResp> format which has all values\r
                                  filled in for the names in the Request string.\r
                                  String to be allocated by the called function.\r
\r
  @retval EFI_SUCCESS             The Results string is filled with the values\r
                                  corresponding to all requested names.\r
  @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the parts of the\r
                                  results that must be stored awaiting possible\r
                                  future        protocols.\r
  @retval EFI_NOT_FOUND           Routing data doesn't match any known driver.\r
                                     Progress set to the "G" in "GUID" of the\r
                                  routing  header that doesn't match. Note: There\r
                                  is no         requirement that all routing data\r
                                  be validated before any configuration extraction.\r
  @retval EFI_INVALID_PARAMETER   For example, passing in a NULL for the Request\r
                                  parameter would result in this type of error. The\r
                                  Progress parameter is set to NULL.\r
  @retval EFI_INVALID_PARAMETER   Illegal syntax. Progress set to most recent &\r
                                  before the error or the beginning of the string.\r
  @retval EFI_INVALID_PARAMETER   Unknown name. Progress points to the & before the\r
                                  name in question.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiConfigRoutingExtractConfig (\r
  IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL  *This,\r
  IN  CONST EFI_STRING                       Request,\r
  OUT EFI_STRING                             *Progress,\r
  OUT EFI_STRING                             *Results\r
  );\r
\r
\r
/**\r
  This function allows the caller to request the current configuration for the\r
  entirety of the current HII database and returns the data in a null-terminated Unicode string.\r
\r
  @param  This                    A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
                                  instance.\r
  @param  Results                 Null-terminated Unicode string in\r
                                  <MultiConfigAltResp> format which has all values\r
                                  filled in for the entirety of the current HII \r
                                  database. String to be allocated by the  called \r
                                  function. De-allocation is up to the caller.\r
\r
  @retval EFI_SUCCESS             The Results string is filled with the values\r
                                  corresponding to all requested names.\r
  @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the parts of the\r
                                  results that must be stored awaiting possible\r
                                  future        protocols.\r
  @retval EFI_INVALID_PARAMETER   For example, passing in a NULL for the Results\r
                                  parameter would result in this type of error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiConfigRoutingExportConfig (\r
  IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL  *This,\r
  OUT EFI_STRING                             *Results\r
  );\r
\r
\r
/**\r
  This function processes the results of processing forms and routes it to the\r
  appropriate handlers or storage.\r
\r
  @param  This                    A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
                                  instance.\r
  @param  Configuration           A null-terminated Unicode string in\r
                                  <MulltiConfigResp> format.\r
  @param  Progress                A pointer to a string filled in with the offset\r
                                  of the most recent & before the first failing\r
                                  name / value pair (or the beginning of the string\r
                                  if the failure is in the first name / value pair)\r
                                  or the terminating NULL if all was successful.\r
\r
  @retval EFI_SUCCESS             The results have been distributed or are awaiting\r
                                  distribution.\r
  @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the parts of the\r
                                  results that must be stored awaiting possible\r
                                  future        protocols.\r
  @retval EFI_INVALID_PARAMETER   Passing in a NULL for the Configuration parameter\r
                                  would result in this type of error.\r
  @retval EFI_NOT_FOUND           Target for the specified routing data was not\r
                                  found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiConfigRoutingRouteConfig (\r
  IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL  *This,\r
  IN  CONST EFI_STRING                       Configuration,\r
  OUT EFI_STRING                             *Progress\r
  );\r
\r
\r
\r
/**\r
  This helper function is to be called by drivers to map configuration data stored\r
  in byte array ("block") formats such as UEFI Variables into current configuration strings.\r
\r
  @param  This                    A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
                                  instance.\r
  @param  ConfigRequest           A null-terminated Unicode string in\r
                                  <ConfigRequest> format.\r
  @param  Block                   Array of bytes defining the block's\r
                                  configuration.\r
  @param  BlockSize               Length in bytes of Block.\r
  @param  Config                  Filled-in configuration string. String allocated\r
                                  by  the function. Returned only if call is\r
                                  successful.\r
  @param  Progress                A pointer to a string filled in with the offset\r
                                  of  the most recent & before the first failing\r
                                  name/value pair (or the beginning of the string\r
                                  if the failure is in the first name / value pair)\r
                                  or the terminating NULL if all was successful.\r
\r
  @retval EFI_SUCCESS             The request succeeded. Progress points to the\r
                                  null terminator at the end of the ConfigRequest\r
                                        string.\r
  @retval EFI_OUT_OF_RESOURCES    Not enough memory to allocate Config.\r
                                  Progress points to the first character of\r
                                  ConfigRequest.\r
  @retval EFI_INVALID_PARAMETER   Passing in a NULL for the ConfigRequest or\r
                                  Block parameter would result in this type of\r
                                  error. Progress points to the first character of\r
                                  ConfigRequest.\r
  @retval EFI_NOT_FOUND           Target for the specified routing data was not\r
                                  found. Progress points to the "G" in "GUID" of\r
                                  the      errant routing data.\r
  @retval EFI_DEVICE_ERROR        Block not large enough. Progress undefined.\r
  @retval EFI_INVALID_PARAMETER   Encountered non <BlockName> formatted string.\r
                                       Block is left updated and Progress points at\r
                                  the '&' preceding the first non-<BlockName>.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiBlockToConfig (\r
  IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL  *This,\r
  IN  CONST EFI_STRING                       ConfigRequest,\r
  IN  CONST UINT8                            *Block,\r
  IN  CONST UINTN                            BlockSize,\r
  OUT EFI_STRING                             *Config,\r
  OUT EFI_STRING                             *Progress\r
  );\r
\r
\r
/**\r
  This helper function is to be called by drivers to map configuration strings\r
  to configurations stored in byte array ("block") formats such as UEFI Variables.\r
\r
  @param  This                    A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
                                  instance.\r
  @param  ConfigResp              A null-terminated Unicode string in <ConfigResp>\r
                                  format.\r
  @param  Block                   A possibly null array of bytes representing the\r
                                  current  block. Only bytes referenced in the\r
                                  ConfigResp string  in the block are modified. If\r
                                  this parameter is null or if the *BlockSize\r
                                  parameter is (on input) shorter than required by\r
                                  the Configuration string, only the BlockSize\r
                                  parameter is updated and an appropriate status\r
                                  (see below)  is returned.\r
  @param  BlockSize               The length of the Block in units of UINT8.  On\r
                                  input, this is the size of the Block. On output,\r
                                  if successful, contains the largest index of the\r
                                  modified byte in the Block, or the required buffer\r
                                  size if the Block is not large enough.\r
  @param  Progress                On return, points to an element of the ConfigResp\r
                                   string filled in with the offset of the most\r
                                  recent '&' before the first failing name / value\r
                                  pair (or  the beginning of the string if the\r
                                  failure is in the  first name / value pair) or\r
                                  the terminating NULL if all was successful.\r
\r
  @retval EFI_SUCCESS             The request succeeded. Progress points to the\r
                                  null terminator at the end of the ConfigResp\r
                                  string.\r
  @retval EFI_OUT_OF_RESOURCES    Not enough memory to allocate Config.\r
                                  Progress points to the first character of\r
                                  ConfigResp.\r
  @retval EFI_INVALID_PARAMETER   Passing in a NULL for the ConfigResp or\r
                                  Block parameter would result in this type of\r
                                  error. Progress points to the first character of\r
                                           ConfigResp.\r
  @retval EFI_NOT_FOUND           Target for the specified routing data was not\r
                                  found. Progress points to the "G" in "GUID" of\r
                                  the      errant routing data.\r
  @retval EFI_INVALID_PARAMETER   Encountered non <BlockName> formatted name /\r
                                  value pair. Block is left updated and\r
                                  Progress points at the '&' preceding the first\r
                                  non-<BlockName>.\r
  @retval EFI_BUFFER_TOO_SMALL    Block not large enough. Progress undefined. \r
                                  BlockSize is updated with the required buffer size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiConfigToBlock (\r
  IN     CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
  IN     CONST EFI_STRING                      ConfigResp,\r
  IN OUT UINT8                                 *Block,\r
  IN OUT UINTN                                 *BlockSize,\r
  OUT    EFI_STRING                            *Progress\r
  );\r
\r
\r
/**\r
  This helper function is to be called by drivers to extract portions of\r
  a larger configuration string.\r
\r
  @param  This                    A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
                                  instance.\r
  @param  Configuration           A null-terminated Unicode string in\r
                                  <MultiConfigAltResp> format.\r
  @param  Guid                    A pointer to the GUID value to search for in the\r
                                  routing portion of the ConfigResp string when\r
                                  retrieving  the requested data. If Guid is NULL,\r
                                  then all GUID  values will be searched for.\r
  @param  Name                    A pointer to the NAME value to search for in the\r
                                  routing portion of the ConfigResp string when\r
                                  retrieving  the requested data. If Name is NULL,\r
                                  then all Name  values will be searched for.\r
  @param  DevicePath              A pointer to the PATH value to search for in the\r
                                  routing portion of the ConfigResp string when\r
                                  retrieving  the requested data. If DevicePath is\r
                                  NULL, then all  DevicePath values will be\r
                                  searched for.\r
  @param  AltCfgId                A pointer to the ALTCFG value to search for in\r
                                  the  routing portion of the ConfigResp string\r
                                  when retrieving  the requested data.  If this\r
                                  parameter is NULL,  then the current setting will\r
                                  be retrieved.\r
  @param  AltCfgResp              A pointer to a buffer which will be allocated by\r
                                  the  function which contains the retrieved string\r
                                  as requested.   This buffer is only allocated if\r
                                  the call was successful.\r
\r
  @retval EFI_SUCCESS             The request succeeded. The requested data was\r
                                  extracted  and placed in the newly allocated\r
                                  AltCfgResp buffer.\r
  @retval EFI_OUT_OF_RESOURCES    Not enough memory to allocate AltCfgResp.\r
  @retval EFI_INVALID_PARAMETER   Any parameter is invalid.\r
  @retval EFI_NOT_FOUND           Target for the specified routing data was not\r
                                  found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiGetAltCfg (\r
  IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL    *This,\r
  IN  CONST EFI_STRING                         Configuration,\r
  IN  CONST EFI_GUID                           *Guid,\r
  IN  CONST EFI_STRING                         Name,\r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL           *DevicePath,\r
  IN  CONST UINT16                             *AltCfgId,\r
  OUT EFI_STRING                               *AltCfgResp\r
  );\r
\r
/**\r
\r
  This function accepts a <MultiKeywordResp> formatted string, finds the associated\r
  keyword owners, creates a <MultiConfigResp> string from it and forwards it to the\r
  EFI_HII_ROUTING_PROTOCOL.RouteConfig function.\r
  \r
  If there is an issue in resolving the contents of the KeywordString, then the \r
  function returns an error and also sets the Progress and ProgressErr with the \r
  appropriate information about where the issue occurred and additional data about\r
  the nature of the issue. \r
  \r
  In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND\r
  error is generated during processing the second or later keyword element, the system\r
  storage associated with earlier keywords is not modified. All elements of the \r
  KeywordString must successfully pass all tests for format and access prior to making\r
  any modifications to storage.\r
  \r
  In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString\r
  containing multiple keywords, the state of storage associated with earlier keywords\r
  is undefined.\r
\r
\r
  @param This             Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r
\r
  @param KeywordString    A null-terminated string in <MultiKeywordResp> format. \r
\r
  @param Progress         On return, points to a character in the KeywordString. \r
                          Points to the string's NULL terminator if the request \r
                          was successful. Points to the most recent '&' before \r
                          the first failing name / value pair (or the beginning\r
                          of the string if the failure is in the first name / value\r
                          pair) if the request was not successful.\r
\r
  @param ProgressErr      If during the processing of the KeywordString there was\r
                          a failure, this parameter gives additional information \r
                          about the possible source of the problem. The various \r
                          errors are defined in "Related Definitions" below.\r
\r
\r
  @retval EFI_SUCCESS             The specified action was completed successfully.\r
\r
  @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:\r
                                  1. KeywordString is NULL.\r
                                  2. Parsing of the KeywordString resulted in an \r
                                     error. See Progress and ProgressErr for more data.\r
\r
  @retval EFI_NOT_FOUND           An element of the KeywordString was not found. \r
                                  See ProgressErr for more data.\r
\r
  @retval EFI_OUT_OF_RESOURCES    Required system resources could not be allocated.  \r
                                  See ProgressErr for more data.\r
                                  \r
  @retval EFI_ACCESS_DENIED       The action violated system policy. See ProgressErr \r
                                  for more data.\r
\r
  @retval EFI_DEVICE_ERROR        An unexpected system error occurred. See ProgressErr\r
                                  for more data.\r
\r
**/\r
EFI_STATUS\r
EFIAPI \r
EfiConfigKeywordHandlerSetData (\r
  IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *This,\r
  IN CONST EFI_STRING                    KeywordString,\r
  OUT EFI_STRING                         *Progress,\r
  OUT UINT32                             *ProgressErr\r
  );\r
\r
/**\r
\r
  This function accepts a <MultiKeywordRequest> formatted string, finds the underlying \r
  keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the\r
  EFI_HII_ROUTING_PROTOCOL.ExtractConfig function.\r
  \r
  If there is an issue in resolving the contents of the KeywordString, then the function\r
  returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the\r
  appropriate information about where the issue occurred and additional data about the\r
  nature of the issue.\r
  \r
  In the case when KeywordString is NULL, or contains multiple keywords, or when\r
  EFI_NOT_FOUND is generated while processing the keyword elements, the Results string\r
  contains values returned for all keywords processed prior to the keyword generating the \r
  error but no values for the keyword with error or any following keywords.\r
\r
  \r
  @param This           Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r
  \r
  @param NameSpaceId    A null-terminated string containing the platform configuration\r
                        language to search through in the system. If a NULL is passed\r
                        in, then it is assumed that any platform configuration language\r
                        with the prefix of "x-UEFI-" are searched.\r
                        \r
  @param KeywordString  A null-terminated string in <MultiKeywordRequest> format. If a\r
                        NULL is passed in the KeywordString field, all of the known \r
                        keywords in the system for the NameSpaceId specified are \r
                        returned in the Results field.\r
  \r
  @param Progress       On return, points to a character in the KeywordString. Points\r
                        to the string's NULL terminator if the request was successful. \r
                        Points to the most recent '&' before the first failing name / value\r
                        pair (or the beginning of the string if the failure is in the first\r
                        name / value pair) if the request was not successful.\r
                        \r
  @param ProgressErr    If during the processing of the KeywordString there was a\r
                        failure, this parameter gives additional information about the \r
                        possible source of the problem. See the definitions in SetData()\r
                        for valid value definitions.\r
  \r
  @param Results        A null-terminated string in <MultiKeywordResp> format is returned\r
                        which has all the values filled in for the keywords in the \r
                        KeywordString. This is a callee-allocated field, and must be freed\r
                        by the caller after being used. \r
\r
  @retval EFI_SUCCESS             The specified action was completed successfully.\r
  \r
  @retval EFI_INVALID_PARAMETER   One or more of the following are TRUE:\r
                                  1.Progress, ProgressErr, or Resuts is NULL.\r
                                  2.Parsing of the KeywordString resulted in an error. See\r
                                    Progress and ProgressErr for more data.\r
  \r
\r
  @retval EFI_NOT_FOUND           An element of the KeywordString was not found. See\r
                                  ProgressErr for more data.\r
\r
  @retval EFI_NOT_FOUND           The NamespaceId specified was not found.  See ProgressErr\r
                                  for more data.\r
\r
  @retval EFI_OUT_OF_RESOURCES    Required system resources could not be allocated.  See\r
                                  ProgressErr for more data.\r
                                  \r
  @retval EFI_ACCESS_DENIED       The action violated system policy.  See ProgressErr for\r
                                  more data.\r
\r
  @retval EFI_DEVICE_ERROR        An unexpected system error occurred.  See ProgressErr\r
                                  for more data.\r
\r
**/\r
EFI_STATUS\r
EFIAPI \r
EfiConfigKeywordHandlerGetData (\r
  IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL  *This,\r
  IN CONST EFI_STRING                     NameSpaceId, OPTIONAL\r
  IN CONST EFI_STRING                     KeywordString, OPTIONAL\r
  OUT EFI_STRING                          *Progress, \r
  OUT UINT32                              *ProgressErr,\r
  OUT EFI_STRING                          *Results\r
  );\r
\r
/**\r
  Compare whether two names of languages are identical.\r
\r
  @param  Language1              Name of language 1 from StringPackage\r
  @param  Language2              Name of language 2 to be compared with language 1.\r
\r
  @retval TRUE                   same\r
  @retval FALSE                  not same\r
\r
**/\r
BOOLEAN\r
HiiCompareLanguage (\r
  IN  CHAR8  *Language1,\r
  IN  CHAR8  *Language2\r
  )\r
;\r
\r
/**\r
  Retrieves a pointer to the a Null-terminated ASCII string containing the list \r
  of languages that an HII handle in the HII Database supports.  The returned \r
  string is allocated using AllocatePool().  The caller is responsible for freeing\r
  the returned string using FreePool().  The format of the returned string follows\r
  the language format assumed the HII Database.\r
  \r
  If HiiHandle is NULL, then ASSERT().\r
\r
  @param[in]  HiiHandle  A handle that was previously registered in the HII Database.\r
\r
  @retval NULL   HiiHandle is not registered in the HII database\r
  @retval NULL   There are not enough resources available to retrieve the suported \r
                 languages.\r
  @retval NULL   The list of suported languages could not be retrieved.\r
  @retval Other  A pointer to the Null-terminated ASCII string of supported languages.\r
\r
**/\r
CHAR8 *\r
GetSupportedLanguages (\r
  IN EFI_HII_HANDLE           HiiHandle\r
  );\r
\r
//\r
// Global variables\r
//\r
extern EFI_EVENT gHiiKeyboardLayoutChanged;\r
#endif\r