[mirror_edk2.git] / MdePkg / Include / Library / IfrSupportLib.h

/** @file\r
  The file contain all library functions and definitions for IFR opcode creation and \r
  related Form Browser utility Operations.\r
\r
  Copyright (c) 2007 - 2008, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  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 _IFR_SUPPORT_LIBRARY_H_\r
#define _IFR_SUPPORT_LIBRARY_H_\r
\r
\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/FormBrowser2.h>\r
#include <Protocol/SimpleTextOut.h>\r
\r
#include <Guid/GlobalVariable.h>\r
\r
//\r
// The architectural variable "Lang" and "LangCodes" are deprecated in UEFI\r
// specification. While, UEFI specification also states that these deprecated\r
// variables may be provided for backwards compatibility.\r
\r
#define EFI_LANGUAGE_VARIABLE           L"Lang"\r
#define EFI_LANGUAGE_CODES_VARIABLE     L"LangCodes"\r
\r
#define UEFI_LANGUAGE_VARIABLE          L"PlatformLang"\r
#define UEFI_LANGUAGE_CODES_VARIABLE    L"PlatformLangCodes"\r
\r
//\r
// Limited buffer size recommended by RFC4646 (4.3.  Length Considerations)\r
// (42 characters plus a NULL terminator)\r
//\r
#define RFC_3066_ENTRY_SIZE             (42 + 1)\r
#define ISO_639_2_ENTRY_SIZE            3\r
\r
#define INVALID_VARSTORE_ID             0\r
\r
#define QUESTION_FLAGS              (EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED | EFI_IFR_FLAG_OPTIONS_ONLY)\r
#define QUESTION_FLAGS_MASK         (~QUESTION_FLAGS)\r
\r
extern EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;\r
extern EFI_HII_STRING_PROTOCOL   *gIfrLibHiiString;\r
\r
#pragma pack(1)\r
typedef struct {\r
  EFI_STRING_ID       StringToken;\r
  EFI_IFR_TYPE_VALUE  Value;\r
  UINT8               Flags;\r
} IFR_OPTION;\r
#pragma pack()\r
\r
typedef struct {\r
  ///\r
  /// Buffer size allocated for Data.\r
  ///\r
  UINT32                BufferSize;\r
\r
  ///\r
  /// Offset in Data to append the newly created opcode binary.\r
  /// It will be adjusted automatically in Create***OpCode(), and should be\r
  /// initialized to 0 before invocation of a serial of Create***OpCode()\r
  ///\r
  UINT32                Offset;\r
\r
  ///\r
  /// The destination buffer for created op-codes\r
  ///\r
  UINT8                 *Data;\r
} EFI_HII_UPDATE_DATA;\r
\r
\r
/**\r
  Create EFI_IFR_END_OP opcode.\r
\r
  If Data is NULL or Data->Data is NULL, then ASSERT.\r
\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateEndOpCode (\r
  IN OUT EFI_HII_UPDATE_DATA *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_DEFAULT_OP opcode.\r
\r
  @param  Value                  Value for the default\r
  @param  Type                   Type for the default\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER The type is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateDefaultOpCode (\r
  IN     EFI_IFR_TYPE_VALUE  *Value,\r
  IN     UINT8               Type,\r
  IN OUT EFI_HII_UPDATE_DATA *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_ACTION_OP opcode.\r
\r
  @param  QuestionId             Question ID\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  QuestionFlags          Flags in Question Header\r
  @param  QuestionConfig         String ID for configuration\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateActionOpCode (\r
  IN     EFI_QUESTION_ID      QuestionId,\r
  IN     EFI_STRING_ID        Prompt,\r
  IN     EFI_STRING_ID        Help,\r
  IN     UINT8                QuestionFlags,\r
  IN     EFI_STRING_ID        QuestionConfig,\r
  IN OUT EFI_HII_UPDATE_DATA  *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_SUBTITLE_OP opcode.\r
\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  Flags                  Subtitle opcode flags\r
  @param  Scope                  Subtitle Scope bit\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateSubTitleOpCode (\r
  IN      EFI_STRING_ID       Prompt,\r
  IN      EFI_STRING_ID       Help,\r
  IN      UINT8               Flags,\r
  IN      UINT8               Scope,\r
  IN OUT EFI_HII_UPDATE_DATA  *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_TEXT_OP opcode.\r
\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  TextTwo                String ID for text two\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateTextOpCode (\r
  IN      EFI_STRING_ID       Prompt,\r
  IN      EFI_STRING_ID       Help,\r
  IN      EFI_STRING_ID       TextTwo,\r
  IN OUT  EFI_HII_UPDATE_DATA *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_REF_OP opcode.\r
\r
  @param  FormId                 Destination Form ID\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  QuestionFlags          Flags in Question Header\r
  @param  QuestionId             Question ID\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateGotoOpCode (\r
  IN      EFI_FORM_ID         FormId,\r
  IN      EFI_STRING_ID       Prompt,\r
  IN      EFI_STRING_ID       Help,\r
  IN      UINT8               QuestionFlags,\r
  IN      EFI_QUESTION_ID     QuestionId,\r
  IN OUT  EFI_HII_UPDATE_DATA *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_ONE_OF_OPTION_OP opcode.\r
\r
  @param  OptionCount            The number of options.\r
  @param  OptionsList            The list of Options.\r
  @param  Type                   The data type.\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateOneOfOptionOpCode (\r
  IN     UINTN                OptionCount,\r
  IN     IFR_OPTION           *OptionsList,\r
  IN     UINT8                Type,\r
  IN OUT EFI_HII_UPDATE_DATA  *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_ONE_OF_OP opcode.\r
\r
  @param  QuestionId             Question ID\r
  @param  VarStoreId             Storage ID\r
  @param  VarOffset              Offset in Storage\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  QuestionFlags          Flags in Question Header\r
  @param  OneOfFlags             Flags for oneof opcode\r
  @param  OptionsList            List of options\r
  @param  OptionCount            Number of options in option list\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateOneOfOpCode (\r
  IN     EFI_QUESTION_ID      QuestionId,\r
  IN     EFI_VARSTORE_ID      VarStoreId,\r
  IN     UINT16               VarOffset,\r
  IN     EFI_STRING_ID        Prompt,\r
  IN     EFI_STRING_ID        Help,\r
  IN     UINT8                QuestionFlags,\r
  IN     UINT8                OneOfFlags,\r
  IN     IFR_OPTION           *OptionsList,\r
  IN     UINTN                OptionCount,\r
  IN OUT EFI_HII_UPDATE_DATA  *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_ORDERED_LIST_OP opcode.\r
\r
  @param  QuestionId             Question ID\r
  @param  VarStoreId             Storage ID\r
  @param  VarOffset              Offset in Storage\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  QuestionFlags          Flags in Question Header\r
  @param  OrderedListFlags       Flags for ordered list opcode\r
  @param  DataType               Type for option value\r
  @param  MaxContainers          Maximum count for options in this ordered list\r
  @param  OptionsList            List of options\r
  @param  OptionCount            Number of options in option list\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateOrderedListOpCode (\r
  IN      EFI_QUESTION_ID     QuestionId,\r
  IN      EFI_VARSTORE_ID     VarStoreId,\r
  IN      UINT16              VarOffset,\r
  IN      EFI_STRING_ID       Prompt,\r
  IN      EFI_STRING_ID       Help,\r
  IN      UINT8               QuestionFlags,\r
  IN      UINT8               OrderedListFlags,\r
  IN      UINT8               DataType,\r
  IN      UINT8               MaxContainers,\r
  IN      IFR_OPTION          *OptionsList,\r
  IN     UINTN                OptionCount,\r
  IN OUT EFI_HII_UPDATE_DATA  *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_CHECKBOX_OP opcode.\r
\r
  @param  QuestionId             Question ID\r
  @param  VarStoreId             Storage ID\r
  @param  VarOffset              Offset in Storage\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  QuestionFlags          Flags in Question Header\r
  @param  CheckBoxFlags          Flags for checkbox opcode\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateCheckBoxOpCode (\r
  IN      EFI_QUESTION_ID     QuestionId,\r
  IN      EFI_VARSTORE_ID     VarStoreId,\r
  IN      UINT16              VarOffset,\r
  IN      EFI_STRING_ID       Prompt,\r
  IN      EFI_STRING_ID       Help,\r
  IN      UINT8               QuestionFlags,\r
  IN      UINT8               CheckBoxFlags,\r
  IN OUT EFI_HII_UPDATE_DATA  *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_NUMERIC_OP opcode.\r
\r
  @param  QuestionId             Question ID\r
  @param  VarStoreId             Storage ID\r
  @param  VarOffset              Offset in Storage\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  QuestionFlags          Flags in Question Header\r
  @param  NumericFlags           Flags for numeric opcode\r
  @param  Minimum                Numeric minimum value\r
  @param  Maximum                Numeric maximum value\r
  @param  Step                   Numeric step for edit\r
  @param  Default                Numeric default value\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateNumericOpCode (\r
  IN     EFI_QUESTION_ID     QuestionId,\r
  IN     EFI_VARSTORE_ID     VarStoreId,\r
  IN     UINT16              VarOffset,\r
  IN     EFI_STRING_ID       Prompt,\r
  IN     EFI_STRING_ID       Help,\r
  IN     UINT8               QuestionFlags,\r
  IN     UINT8               NumericFlags,\r
  IN     UINT64              Minimum,\r
  IN     UINT64              Maximum,\r
  IN     UINT64              Step,\r
  IN     UINT64              Default,\r
  IN OUT EFI_HII_UPDATE_DATA *Data\r
  )\r
;\r
\r
/**\r
  Create EFI_IFR_STRING_OP opcode.\r
\r
  @param  QuestionId             Question ID\r
  @param  VarStoreId             Storage ID\r
  @param  VarOffset              Offset in Storage\r
  @param  Prompt                 String ID for Prompt\r
  @param  Help                   String ID for Help\r
  @param  QuestionFlags          Flags in Question Header\r
  @param  StringFlags            Flags for string opcode\r
  @param  MinSize                String minimum length\r
  @param  MaxSize                String maximum length\r
  @param  Data                   Destination for the created opcode binary\r
\r
  @retval EFI_SUCCESS            Opcode create success\r
  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
  @retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateStringOpCode (\r
  IN      EFI_QUESTION_ID     QuestionId,\r
  IN      EFI_VARSTORE_ID     VarStoreId,\r
  IN      UINT16              VarOffset,\r
  IN      EFI_STRING_ID       Prompt,\r
  IN      EFI_STRING_ID       Help,\r
  IN      UINT8               QuestionFlags,\r
  IN      UINT8               StringFlags,\r
  IN      UINT8               MinSize,\r
  IN      UINT8               MaxSize,\r
  IN OUT EFI_HII_UPDATE_DATA  *Data\r
  )\r
;\r
\r
/**\r
  Converts the unicode character of the string from uppercase to lowercase.\r
\r
  @param Str     String to be converted\r
\r
 \r
**/\r
VOID\r
EFIAPI\r
ToLower (\r
  IN OUT CHAR16    *Str\r
  )\r
;\r
\r
/**\r
  Converts binary buffer to Unicode string in reversed byte order to BufToHexString().\r
\r
  @param  Str                    String for output\r
  @param  Buffer                 Binary buffer.\r
  @param  BufferSize             Size of the buffer in bytes.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BufferToHexString (\r
  IN OUT CHAR16    *Str,\r
  IN UINT8         *Buffer,\r
  IN UINTN         BufferSize\r
  )\r
;\r
\r
/**\r
  Converts Hex String to binary buffer in reversed byte order to HexStringToBuf().\r
\r
  @param  Buffer                 Pointer to buffer that receives the data.\r
  @param  BufferSize             Length in bytes of the buffer to hold converted\r
                                 data. If routine return with EFI_SUCCESS,\r
                                 containing length of converted data. If routine\r
                                 return with EFI_BUFFER_TOO_SMALL, containg length\r
                                 of buffer desired.\r
  @param  Str                    String to be converted from.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HexStringToBuffer (\r
  IN OUT UINT8         *Buffer,\r
  IN OUT UINTN         *BufferSize,\r
  IN CHAR16            *Str\r
  )\r
;\r
\r
/**\r
  Convert binary representation Config string (e.g. "0041004200430044") to the\r
  original string (e.g. "ABCD"). Config string appears in <ConfigHdr> (i.e.\r
  "&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").\r
\r
  @param UnicodeString  Original Unicode string.\r
  @param StrBufferLen   On input: Length in bytes of buffer to hold the Unicode string.\r
                                    Includes tailing '\0' character.\r
                                    On output:\r
                                      If return EFI_SUCCESS, containing length of Unicode string buffer.\r
                                      If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.\r
  @param ConfigString   Binary representation of Unicode String, <string> := (<HexCh>4)+\r
\r
  @retval EFI_SUCCESS          Routine success.\r
  @retval EFI_BUFFER_TOO_SMALL The string buffer is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConfigStringToUnicode (\r
  IN OUT CHAR16                *UnicodeString,\r
  IN OUT UINTN                 *StrBufferLen,\r
  IN CHAR16                    *ConfigString\r
  )\r
;\r
\r
/**\r
  Convert Unicode string to binary representation Config string, e.g.\r
  "ABCD" => "0041004200430044". Config string appears in <ConfigHdr> (i.e.\r
  "&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").\r
\r
  @param ConfigString   Binary representation of Unicode String, <string> := (<HexCh>4)+\r
  @param  StrBufferLen  On input: Length in bytes of buffer to hold the Unicode string.\r
                                    Includes tailing '\0' character.\r
                                    On output:\r
                                      If return EFI_SUCCESS, containing length of Unicode string buffer.\r
                                      If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.\r
  @param  UnicodeString  Original Unicode string.\r
\r
  @retval EFI_SUCCESS           Routine success.\r
  @retval EFI_BUFFER_TOO_SMALL  The string buffer is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UnicodeToConfigString (\r
  IN OUT CHAR16                *ConfigString,\r
  IN OUT UINTN                 *StrBufferLen,\r
  IN CHAR16                    *UnicodeString\r
  )\r
;\r
\r
/**\r
  Construct <ConfigHdr> using routing information GUID/NAME/PATH.\r
\r
  @param  ConfigHdr              Pointer to the ConfigHdr string.\r
  @param  StrBufferLen           On input: Length in bytes of buffer to hold the\r
                                 ConfigHdr string. Includes tailing '\0' character.\r
                                 On output: If return EFI_SUCCESS, containing\r
                                 length of ConfigHdr string buffer. If return\r
                                 EFI_BUFFER_TOO_SMALL, containg length of string\r
                                 buffer desired.\r
  @param  Guid                   Routing information: GUID.\r
  @param  Name                   Routing information: NAME.\r
  @param  DriverHandle           Driver handle which contains the routing\r
                                 information: PATH.\r
\r
  @retval EFI_SUCCESS            Routine success.\r
  @retval EFI_BUFFER_TOO_SMALL   The ConfigHdr string buffer is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConstructConfigHdr (\r
  IN OUT CHAR16                *ConfigHdr,\r
  IN OUT UINTN                 *StrBufferLen,\r
  IN EFI_GUID                  *Guid,\r
  IN CHAR16                    *Name, OPTIONAL\r
  IN EFI_HANDLE                *DriverHandle\r
  )\r
\r
;\r
\r
/**\r
  Search BlockName "&OFFSET=Offset&WIDTH=Width" in a string.\r
\r
  @param  String                 The string to be searched in.\r
  @param  Offset                 Offset in BlockName.\r
  @param  Width                  Width in BlockName.\r
\r
  @retval TRUE                   Block name found.\r
  @retval FALSE                  Block name not found.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
FindBlockName (\r
  IN OUT CHAR16                *String,\r
  UINTN                        Offset,\r
  UINTN                        Width\r
  )\r
;\r
\r
/**\r
  This routine is invoked by ConfigAccess.Callback() to retrived uncommitted data from Form Browser.\r
\r
  @param  VariableGuid           An optional field to indicate the target variable\r
                                 GUID name to use.\r
  @param  VariableName           An optional field to indicate the target\r
                                 human-readable variable name.\r
  @param  BufferSize             On input: Length in bytes of buffer to hold\r
                                 retrived data. On output: If return\r
                                 EFI_BUFFER_TOO_SMALL, containg length of buffer\r
                                 desired.\r
  @param  Buffer                 Buffer to hold retrived data.\r
\r
  @retval EFI_SUCCESS            Routine success.\r
  @retval EFI_BUFFER_TOO_SMALL   The intput buffer is too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetBrowserData (\r
  EFI_GUID                   *VariableGuid, OPTIONAL\r
  CHAR16                     *VariableName, OPTIONAL\r
  UINTN                      *BufferSize,\r
  UINT8                      *Buffer\r
  )\r
;\r
\r
/**\r
  This routine is invoked by ConfigAccess.Callback() to update uncommitted data of Form Browser.\r
\r
  @param  VariableGuid           An optional field to indicate the target variable\r
                                 GUID name to use.\r
  @param  VariableName           An optional field to indicate the target\r
                                 human-readable variable name.\r
  @param  BufferSize             Length in bytes of buffer to hold retrived data.\r
  @param  Buffer                 Buffer to hold retrived data.\r
  @param  RequestElement         An optional field to specify which part of the\r
                                 buffer data will be send back to Browser. If NULL,\r
                                 the whole buffer of data will be committed to\r
                                 Browser. <RequestElement> ::=\r
                                 &OFFSET=<Number>&WIDTH=<Number>*\r
\r
  @retval EFI_SUCCESS            Routine success.\r
  @retval Other                  Updating Browser uncommitted data failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SetBrowserData (\r
  EFI_GUID                   *VariableGuid, OPTIONAL\r
  CHAR16                     *VariableName, OPTIONAL\r
  UINTN                      BufferSize,\r
  UINT8                      *Buffer,\r
  CHAR16                     *RequestElement  OPTIONAL\r
  )\r
;\r
\r
/**\r
  Draw a dialog and return the selected key.\r
\r
  @param  NumberOfLines          The number of lines for the dialog box\r
  @param  KeyValue               The EFI_KEY value returned if HotKey is TRUE..\r
  @param  String                 Pointer to the first string in the list\r
  @param  ...                    A series of (quantity == NumberOfLines - 1) text\r
                                 strings which will be used to construct the dialog\r
                                 box\r
\r
  @retval EFI_SUCCESS            Displayed dialog and received user interaction\r
  @retval EFI_INVALID_PARAMETER  One of the parameters was invalid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IfrLibCreatePopUp (\r
  IN  UINTN                       NumberOfLines,\r
  OUT EFI_INPUT_KEY               *KeyValue,\r
  IN  CHAR16                      *String,\r
  ...\r
  )\r
;\r
\r
#endif\r
Commit	Line	Data
fc30687f	1	/** @file\r
	2	The file contain all library functions and definitions for IFR opcode creation and \r
	3	related Form Browser utility Operations.\r
	4	\r
	5	Copyright (c) 2007 - 2008, Intel Corporation\r
	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef _IFR_SUPPORT_LIBRARY_H_\r
	17	#define _IFR_SUPPORT_LIBRARY_H_\r
	18	\r
	19	\r
	20	#include <Protocol/HiiFont.h>\r
	21	#include <Protocol/HiiImage.h>\r
	22	#include <Protocol/HiiString.h>\r
	23	#include <Protocol/HiiDatabase.h>\r
	24	#include <Protocol/HiiConfigRouting.h>\r
	25	#include <Protocol/HiiConfigAccess.h>\r
	26	#include <Protocol/FormBrowser2.h>\r
	27	#include <Protocol/SimpleTextOut.h>\r
	28	\r
	29	#include <Guid/GlobalVariable.h>\r
	30	\r
	31	//\r
	32	// The architectural variable "Lang" and "LangCodes" are deprecated in UEFI\r
	33	// specification. While, UEFI specification also states that these deprecated\r
	34	// variables may be provided for backwards compatibility.\r
	35	\r
	36	#define EFI_LANGUAGE_VARIABLE L"Lang"\r
	37	#define EFI_LANGUAGE_CODES_VARIABLE L"LangCodes"\r
	38	\r
	39	#define UEFI_LANGUAGE_VARIABLE L"PlatformLang"\r
	40	#define UEFI_LANGUAGE_CODES_VARIABLE L"PlatformLangCodes"\r
	41	\r
	42	//\r
	43	// Limited buffer size recommended by RFC4646 (4.3. Length Considerations)\r
	44	// (42 characters plus a NULL terminator)\r
	45	//\r
	46	#define RFC_3066_ENTRY_SIZE (42 + 1)\r
	47	#define ISO_639_2_ENTRY_SIZE 3\r
	48	\r
	49	#define INVALID_VARSTORE_ID 0\r
	50	\r
	51	#define QUESTION_FLAGS (EFI_IFR_FLAG_READ_ONLY \| EFI_IFR_FLAG_CALLBACK \| EFI_IFR_FLAG_RESET_REQUIRED \| EFI_IFR_FLAG_OPTIONS_ONLY)\r
	52	#define QUESTION_FLAGS_MASK (~QUESTION_FLAGS)\r
	53	\r
	54	extern EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;\r
	55	extern EFI_HII_STRING_PROTOCOL *gIfrLibHiiString;\r
	56	\r
	57	#pragma pack(1)\r
	58	typedef struct {\r
	59	EFI_STRING_ID StringToken;\r
	60	EFI_IFR_TYPE_VALUE Value;\r
	61	UINT8 Flags;\r
	62	} IFR_OPTION;\r
	63	#pragma pack()\r
	64	\r
65	typedef struct {\r
66	///\r
67	/// Buffer size allocated for Data.\r
68	///\r
69	UINT32 BufferSize;\r
70	\r
71	///\r
72	/// Offset in Data to append the newly created opcode binary.\r
73	/// It will be adjusted automatically in Create***OpCode(), and should be\r
74	/// initialized to 0 before invocation of a serial of Create***OpCode()\r
75	///\r
76	UINT32 Offset;\r
77	\r
78	///\r
79	/// The destination buffer for created op-codes\r
80	///\r
81	UINT8 *Data;\r
82	} EFI_HII_UPDATE_DATA;\r
83	\r
84	\r
85	/**\r
86	Create EFI_IFR_END_OP opcode.\r
87	\r
88	If Data is NULL or Data->Data is NULL, then ASSERT.\r
89	\r
90	@param Data Destination for the created opcode binary\r
91	\r
92	@retval EFI_SUCCESS Opcode create success\r
93	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
94	\r
95	**/\r
96	EFI_STATUS\r
97	EFIAPI\r
98	CreateEndOpCode (\r
99	IN OUT EFI_HII_UPDATE_DATA *Data\r
100	)\r
101	;\r
102	\r
103	/**\r
104	Create EFI_IFR_DEFAULT_OP opcode.\r
105	\r
106	@param Value Value for the default\r
107	@param Type Type for the default\r
108	@param Data Destination for the created opcode binary\r
109	\r
110	@retval EFI_SUCCESS Opcode create success\r
111	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
112	@retval EFI_INVALID_PARAMETER The type is not valid.\r
113	\r
114	**/\r
115	EFI_STATUS\r
116	EFIAPI\r
117	CreateDefaultOpCode (\r
118	IN EFI_IFR_TYPE_VALUE *Value,\r
119	IN UINT8 Type,\r
120	IN OUT EFI_HII_UPDATE_DATA *Data\r
121	)\r
122	;\r
123	\r
124	/**\r
125	Create EFI_IFR_ACTION_OP opcode.\r
126	\r
127	@param QuestionId Question ID\r
128	@param Prompt String ID for Prompt\r
129	@param Help String ID for Help\r
130	@param QuestionFlags Flags in Question Header\r
131	@param QuestionConfig String ID for configuration\r
132	@param Data Destination for the created opcode binary\r
133	\r
134	@retval EFI_SUCCESS Opcode create success\r
135	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
136	@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
137	\r
138	**/\r
139	EFI_STATUS\r
140	EFIAPI\r
141	CreateActionOpCode (\r
142	IN EFI_QUESTION_ID QuestionId,\r
143	IN EFI_STRING_ID Prompt,\r
144	IN EFI_STRING_ID Help,\r
145	IN UINT8 QuestionFlags,\r
146	IN EFI_STRING_ID QuestionConfig,\r
147	IN OUT EFI_HII_UPDATE_DATA *Data\r
148	)\r
149	;\r
150	\r
151	/**\r
152	Create EFI_IFR_SUBTITLE_OP opcode.\r
153	\r
154	@param Prompt String ID for Prompt\r
155	@param Help String ID for Help\r
156	@param Flags Subtitle opcode flags\r
157	@param Scope Subtitle Scope bit\r
158	@param Data Destination for the created opcode binary\r
159	\r
160	@retval EFI_SUCCESS Opcode create success\r
161	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
162	\r
163	**/\r
164	EFI_STATUS\r
165	EFIAPI\r
166	CreateSubTitleOpCode (\r
167	IN EFI_STRING_ID Prompt,\r
168	IN EFI_STRING_ID Help,\r
169	IN UINT8 Flags,\r
170	IN UINT8 Scope,\r
171	IN OUT EFI_HII_UPDATE_DATA *Data\r
172	)\r
173	;\r
174	\r
175	/**\r
176	Create EFI_IFR_TEXT_OP opcode.\r
177	\r
178	@param Prompt String ID for Prompt\r
179	@param Help String ID for Help\r
180	@param TextTwo String ID for text two\r
181	@param Data Destination for the created opcode binary\r
182	\r
183	@retval EFI_SUCCESS Opcode create success\r
184	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
185	\r
186	**/\r
187	EFI_STATUS\r
188	EFIAPI\r
189	CreateTextOpCode (\r
190	IN EFI_STRING_ID Prompt,\r
191	IN EFI_STRING_ID Help,\r
192	IN EFI_STRING_ID TextTwo,\r
193	IN OUT EFI_HII_UPDATE_DATA *Data\r
194	)\r
195	;\r
196	\r
197	/**\r
198	Create EFI_IFR_REF_OP opcode.\r
199	\r
200	@param FormId Destination Form ID\r
201	@param Prompt String ID for Prompt\r
202	@param Help String ID for Help\r
203	@param QuestionFlags Flags in Question Header\r
204	@param QuestionId Question ID\r
205	@param Data Destination for the created opcode binary\r
206	\r
207	@retval EFI_SUCCESS Opcode create success\r
208	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
209	@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
210	\r
211	**/\r
212	EFI_STATUS\r
213	EFIAPI\r
214	CreateGotoOpCode (\r
215	IN EFI_FORM_ID FormId,\r
216	IN EFI_STRING_ID Prompt,\r
217	IN EFI_STRING_ID Help,\r
218	IN UINT8 QuestionFlags,\r
219	IN EFI_QUESTION_ID QuestionId,\r
220	IN OUT EFI_HII_UPDATE_DATA *Data\r
221	)\r
222	;\r
223	\r
224	/**\r
225	Create EFI_IFR_ONE_OF_OPTION_OP opcode.\r
226	\r
227	@param OptionCount The number of options.\r
228	@param OptionsList The list of Options.\r
229	@param Type The data type.\r
230	@param Data Destination for the created opcode binary\r
231	\r
232	@retval EFI_SUCCESS Opcode create success\r
233	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
234	\r
235	**/\r
236	EFI_STATUS\r
237	EFIAPI\r
238	CreateOneOfOptionOpCode (\r
239	IN UINTN OptionCount,\r
240	IN IFR_OPTION *OptionsList,\r
241	IN UINT8 Type,\r
242	IN OUT EFI_HII_UPDATE_DATA *Data\r
243	)\r
244	;\r
245	\r
246	/**\r
247	Create EFI_IFR_ONE_OF_OP opcode.\r
248	\r
249	@param QuestionId Question ID\r
250	@param VarStoreId Storage ID\r
251	@param VarOffset Offset in Storage\r
252	@param Prompt String ID for Prompt\r
253	@param Help String ID for Help\r
254	@param QuestionFlags Flags in Question Header\r
255	@param OneOfFlags Flags for oneof opcode\r
256	@param OptionsList List of options\r
257	@param OptionCount Number of options in option list\r
258	@param Data Destination for the created opcode binary\r
259	\r
260	@retval EFI_SUCCESS Opcode create success\r
261	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
262	@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
263	\r
264	**/\r
265	EFI_STATUS\r
266	EFIAPI\r
267	CreateOneOfOpCode (\r
268	IN EFI_QUESTION_ID QuestionId,\r
269	IN EFI_VARSTORE_ID VarStoreId,\r
270	IN UINT16 VarOffset,\r
271	IN EFI_STRING_ID Prompt,\r
272	IN EFI_STRING_ID Help,\r
273	IN UINT8 QuestionFlags,\r
274	IN UINT8 OneOfFlags,\r
275	IN IFR_OPTION *OptionsList,\r
276	IN UINTN OptionCount,\r
277	IN OUT EFI_HII_UPDATE_DATA *Data\r
278	)\r
279	;\r
280	\r
281	/**\r
282	Create EFI_IFR_ORDERED_LIST_OP opcode.\r
283	\r
284	@param QuestionId Question ID\r
285	@param VarStoreId Storage ID\r
286	@param VarOffset Offset in Storage\r
287	@param Prompt String ID for Prompt\r
288	@param Help String ID for Help\r
289	@param QuestionFlags Flags in Question Header\r
290	@param OrderedListFlags Flags for ordered list opcode\r
291	@param DataType Type for option value\r
292	@param MaxContainers Maximum count for options in this ordered list\r
293	@param OptionsList List of options\r
294	@param OptionCount Number of options in option list\r
295	@param Data Destination for the created opcode binary\r
296	\r
297	@retval EFI_SUCCESS Opcode create success\r
298	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
299	@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
300	\r
301	**/\r
302	EFI_STATUS\r
303	EFIAPI\r
304	CreateOrderedListOpCode (\r
305	IN EFI_QUESTION_ID QuestionId,\r
306	IN EFI_VARSTORE_ID VarStoreId,\r
307	IN UINT16 VarOffset,\r
308	IN EFI_STRING_ID Prompt,\r
309	IN EFI_STRING_ID Help,\r
310	IN UINT8 QuestionFlags,\r
311	IN UINT8 OrderedListFlags,\r
312	IN UINT8 DataType,\r
313	IN UINT8 MaxContainers,\r
314	IN IFR_OPTION *OptionsList,\r
315	IN UINTN OptionCount,\r
316	IN OUT EFI_HII_UPDATE_DATA *Data\r
317	)\r
318	;\r
319	\r
320	/**\r
321	Create EFI_IFR_CHECKBOX_OP opcode.\r
322	\r
323	@param QuestionId Question ID\r
324	@param VarStoreId Storage ID\r
325	@param VarOffset Offset in Storage\r
326	@param Prompt String ID for Prompt\r
327	@param Help String ID for Help\r
328	@param QuestionFlags Flags in Question Header\r
329	@param CheckBoxFlags Flags for checkbox opcode\r
330	@param Data Destination for the created opcode binary\r
331	\r
332	@retval EFI_SUCCESS Opcode create success\r
333	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
334	@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
335	\r
336	**/\r
337	EFI_STATUS\r
338	EFIAPI\r
339	CreateCheckBoxOpCode (\r
340	IN EFI_QUESTION_ID QuestionId,\r
341	IN EFI_VARSTORE_ID VarStoreId,\r
342	IN UINT16 VarOffset,\r
343	IN EFI_STRING_ID Prompt,\r
344	IN EFI_STRING_ID Help,\r
345	IN UINT8 QuestionFlags,\r
346	IN UINT8 CheckBoxFlags,\r
347	IN OUT EFI_HII_UPDATE_DATA *Data\r
348	)\r
349	;\r
350	\r
351	/**\r
352	Create EFI_IFR_NUMERIC_OP opcode.\r
353	\r
354	@param QuestionId Question ID\r
355	@param VarStoreId Storage ID\r
356	@param VarOffset Offset in Storage\r
357	@param Prompt String ID for Prompt\r
358	@param Help String ID for Help\r
359	@param QuestionFlags Flags in Question Header\r
360	@param NumericFlags Flags for numeric opcode\r
361	@param Minimum Numeric minimum value\r
362	@param Maximum Numeric maximum value\r
363	@param Step Numeric step for edit\r
364	@param Default Numeric default value\r
365	@param Data Destination for the created opcode binary\r
366	\r
367	@retval EFI_SUCCESS Opcode create success\r
368	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
369	@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
370	\r
371	**/\r
372	EFI_STATUS\r
373	EFIAPI\r
374	CreateNumericOpCode (\r
375	IN EFI_QUESTION_ID QuestionId,\r
376	IN EFI_VARSTORE_ID VarStoreId,\r
377	IN UINT16 VarOffset,\r
378	IN EFI_STRING_ID Prompt,\r
379	IN EFI_STRING_ID Help,\r
380	IN UINT8 QuestionFlags,\r
381	IN UINT8 NumericFlags,\r
382	IN UINT64 Minimum,\r
383	IN UINT64 Maximum,\r
384	IN UINT64 Step,\r
385	IN UINT64 Default,\r
386	IN OUT EFI_HII_UPDATE_DATA *Data\r
387	)\r
388	;\r
389	\r
390	/**\r
391	Create EFI_IFR_STRING_OP opcode.\r
392	\r
393	@param QuestionId Question ID\r
394	@param VarStoreId Storage ID\r
395	@param VarOffset Offset in Storage\r
396	@param Prompt String ID for Prompt\r
397	@param Help String ID for Help\r
398	@param QuestionFlags Flags in Question Header\r
399	@param StringFlags Flags for string opcode\r
400	@param MinSize String minimum length\r
401	@param MaxSize String maximum length\r
402	@param Data Destination for the created opcode binary\r
403	\r
404	@retval EFI_SUCCESS Opcode create success\r
405	@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
406	@retval EFI_INVALID_PARAMETER If QuestionFlags is not valid.\r
407	\r
408	**/\r
409	EFI_STATUS\r
410	EFIAPI\r
411	CreateStringOpCode (\r
412	IN EFI_QUESTION_ID QuestionId,\r
413	IN EFI_VARSTORE_ID VarStoreId,\r
414	IN UINT16 VarOffset,\r
415	IN EFI_STRING_ID Prompt,\r
416	IN EFI_STRING_ID Help,\r
417	IN UINT8 QuestionFlags,\r
418	IN UINT8 StringFlags,\r
419	IN UINT8 MinSize,\r
420	IN UINT8 MaxSize,\r
421	IN OUT EFI_HII_UPDATE_DATA *Data\r
422	)\r
423	;\r
424	\r
425	/**\r
426	Converts the unicode character of the string from uppercase to lowercase.\r
427	\r
428	@param Str String to be converted\r
429	\r
430	\r
431	**/\r
432	VOID\r
433	EFIAPI\r
434	ToLower (\r
435	IN OUT CHAR16 *Str\r
436	)\r
437	;\r
438	\r
439	/**\r
440	Converts binary buffer to Unicode string in reversed byte order to BufToHexString().\r
441	\r
442	@param Str String for output\r
443	@param Buffer Binary buffer.\r
444	@param BufferSize Size of the buffer in bytes.\r
445	\r
446	@retval EFI_SUCCESS The function completed successfully.\r
447	\r
448	**/\r
449	EFI_STATUS\r
450	EFIAPI\r
451	BufferToHexString (\r
452	IN OUT CHAR16 *Str,\r
453	IN UINT8 *Buffer,\r
454	IN UINTN BufferSize\r
455	)\r
456	;\r
457	\r
458	/**\r
459	Converts Hex String to binary buffer in reversed byte order to HexStringToBuf().\r
460	\r
461	@param Buffer Pointer to buffer that receives the data.\r
462	@param BufferSize Length in bytes of the buffer to hold converted\r
463	data. If routine return with EFI_SUCCESS,\r
464	containing length of converted data. If routine\r
465	return with EFI_BUFFER_TOO_SMALL, containg length\r
466	of buffer desired.\r
467	@param Str String to be converted from.\r
468	\r
469	@retval EFI_SUCCESS The function completed successfully.\r
470	\r
471	**/\r
472	EFI_STATUS\r
473	EFIAPI\r
474	HexStringToBuffer (\r
475	IN OUT UINT8 *Buffer,\r
476	IN OUT UINTN *BufferSize,\r
477	IN CHAR16 *Str\r
478	)\r
479	;\r
480	\r
481	/**\r
482	Convert binary representation Config string (e.g. "0041004200430044") to the\r
483	original string (e.g. "ABCD"). Config string appears in <ConfigHdr> (i.e.\r
484	"&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").\r
485	\r
486	@param UnicodeString Original Unicode string.\r
487	@param StrBufferLen On input: Length in bytes of buffer to hold the Unicode string.\r
488	Includes tailing '\0' character.\r
489	On output:\r
490	If return EFI_SUCCESS, containing length of Unicode string buffer.\r
491	If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.\r
492	@param ConfigString Binary representation of Unicode String, <string> := (<HexCh>4)+\r
493	\r
494	@retval EFI_SUCCESS Routine success.\r
495	@retval EFI_BUFFER_TOO_SMALL The string buffer is too small.\r
496	\r
497	**/\r
498	EFI_STATUS\r
499	EFIAPI\r
500	ConfigStringToUnicode (\r
501	IN OUT CHAR16 *UnicodeString,\r
502	IN OUT UINTN *StrBufferLen,\r
503	IN CHAR16 *ConfigString\r
504	)\r
505	;\r
506	\r
507	/**\r
508	Convert Unicode string to binary representation Config string, e.g.\r
509	"ABCD" => "0041004200430044". Config string appears in <ConfigHdr> (i.e.\r
510	"&NAME=<string>"), or Name/Value pair in <ConfigBody> (i.e. "label=<string>").\r
511	\r
512	@param ConfigString Binary representation of Unicode String, <string> := (<HexCh>4)+\r
513	@param StrBufferLen On input: Length in bytes of buffer to hold the Unicode string.\r
514	Includes tailing '\0' character.\r
515	On output:\r
516	If return EFI_SUCCESS, containing length of Unicode string buffer.\r
517	If return EFI_BUFFER_TOO_SMALL, containg length of string buffer desired.\r
518	@param UnicodeString Original Unicode string.\r
519	\r
520	@retval EFI_SUCCESS Routine success.\r
521	@retval EFI_BUFFER_TOO_SMALL The string buffer is too small.\r
522	\r
523	**/\r
524	EFI_STATUS\r
525	EFIAPI\r
526	UnicodeToConfigString (\r
527	IN OUT CHAR16 *ConfigString,\r
528	IN OUT UINTN *StrBufferLen,\r
529	IN CHAR16 *UnicodeString\r
530	)\r
531	;\r
532	\r
533	/**\r
534	Construct <ConfigHdr> using routing information GUID/NAME/PATH.\r
535	\r
536	@param ConfigHdr Pointer to the ConfigHdr string.\r
537	@param StrBufferLen On input: Length in bytes of buffer to hold the\r
538	ConfigHdr string. Includes tailing '\0' character.\r
539	On output: If return EFI_SUCCESS, containing\r
540	length of ConfigHdr string buffer. If return\r
541	EFI_BUFFER_TOO_SMALL, containg length of string\r
542	buffer desired.\r
543	@param Guid Routing information: GUID.\r
544	@param Name Routing information: NAME.\r
545	@param DriverHandle Driver handle which contains the routing\r
546	information: PATH.\r
547	\r
548	@retval EFI_SUCCESS Routine success.\r
549	@retval EFI_BUFFER_TOO_SMALL The ConfigHdr string buffer is too small.\r
550	\r
551	**/\r
552	EFI_STATUS\r
553	EFIAPI\r
554	ConstructConfigHdr (\r
555	IN OUT CHAR16 *ConfigHdr,\r
556	IN OUT UINTN *StrBufferLen,\r
557	IN EFI_GUID *Guid,\r
558	IN CHAR16 *Name, OPTIONAL\r
559	IN EFI_HANDLE *DriverHandle\r
560	)\r
561	\r
562	;\r
563	\r
564	/**\r
565	Search BlockName "&OFFSET=Offset&WIDTH=Width" in a string.\r
566	\r
567	@param String The string to be searched in.\r
568	@param Offset Offset in BlockName.\r
569	@param Width Width in BlockName.\r
570	\r
571	@retval TRUE Block name found.\r
572	@retval FALSE Block name not found.\r
573	\r
574	**/\r
575	BOOLEAN\r
576	EFIAPI\r
577	FindBlockName (\r
578	IN OUT CHAR16 *String,\r
579	UINTN Offset,\r
580	UINTN Width\r
581	)\r
582	;\r
583	\r
584	/**\r
585	This routine is invoked by ConfigAccess.Callback() to retrived uncommitted data from Form Browser.\r
586	\r
587	@param VariableGuid An optional field to indicate the target variable\r
588	GUID name to use.\r
589	@param VariableName An optional field to indicate the target\r
590	human-readable variable name.\r
591	@param BufferSize On input: Length in bytes of buffer to hold\r
592	retrived data. On output: If return\r
593	EFI_BUFFER_TOO_SMALL, containg length of buffer\r
594	desired.\r
595	@param Buffer Buffer to hold retrived data.\r
596	\r
597	@retval EFI_SUCCESS Routine success.\r
598	@retval EFI_BUFFER_TOO_SMALL The intput buffer is too small.\r
599	\r
600	**/\r
601	EFI_STATUS\r
602	EFIAPI\r
603	GetBrowserData (\r
604	EFI_GUID *VariableGuid, OPTIONAL\r
605	CHAR16 *VariableName, OPTIONAL\r
606	UINTN *BufferSize,\r
607	UINT8 *Buffer\r
608	)\r
609	;\r
610	\r
611	/**\r
612	This routine is invoked by ConfigAccess.Callback() to update uncommitted data of Form Browser.\r
613	\r
614	@param VariableGuid An optional field to indicate the target variable\r
615	GUID name to use.\r
616	@param VariableName An optional field to indicate the target\r
617	human-readable variable name.\r
618	@param BufferSize Length in bytes of buffer to hold retrived data.\r
619	@param Buffer Buffer to hold retrived data.\r
620	@param RequestElement An optional field to specify which part of the\r
621	buffer data will be send back to Browser. If NULL,\r
622	the whole buffer of data will be committed to\r
623	Browser. <RequestElement> ::=\r
624	&OFFSET=<Number>&WIDTH=<Number>*\r
625	\r
626	@retval EFI_SUCCESS Routine success.\r
627	@retval Other Updating Browser uncommitted data failed.\r
628	\r
629	**/\r
630	EFI_STATUS\r
631	EFIAPI\r
632	SetBrowserData (\r
633	EFI_GUID *VariableGuid, OPTIONAL\r
634	CHAR16 *VariableName, OPTIONAL\r
635	UINTN BufferSize,\r
636	UINT8 *Buffer,\r
637	CHAR16 *RequestElement OPTIONAL\r
638	)\r
639	;\r
640	\r
641	/**\r
642	Draw a dialog and return the selected key.\r
643	\r
644	@param NumberOfLines The number of lines for the dialog box\r
645	@param KeyValue The EFI_KEY value returned if HotKey is TRUE..\r
646	@param String Pointer to the first string in the list\r
647	@param ... A series of (quantity == NumberOfLines - 1) text\r
648	strings which will be used to construct the dialog\r
649	box\r
650	\r
651	@retval EFI_SUCCESS Displayed dialog and received user interaction\r
652	@retval EFI_INVALID_PARAMETER One of the parameters was invalid.\r
653	\r
654	**/\r
655	EFI_STATUS\r
656	EFIAPI\r
657	IfrLibCreatePopUp (\r
658	IN UINTN NumberOfLines,\r
659	OUT EFI_INPUT_KEY *KeyValue,\r
660	IN CHAR16 *String,\r
661	...\r
662	)\r
663	;\r
664	\r
665	#endif\r