[mirror_edk2.git] / MdePkg / Library / UefiIfrSupportLib / UefiIfrForm.c

/** @file\r
Utility functions which helps in opcode creation, HII configuration string manipulations, \r
pop up window creations, setup browser persistence data set and get.\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
#include "UefiIfrLibraryInternal.h"\r
\r
CONST EFI_FORM_BROWSER2_PROTOCOL      *mFormBrowser2     = NULL;\r
CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *mIfrSupportLibHiiConfigRouting = NULL;\r
\r
/**\r
  This function locate FormBrowser2 protocols for later usage.\r
\r
  @return Status the status to locate protocol.\r
**/\r
EFI_STATUS\r
LocateFormBrowser2Protocols (\r
  VOID\r
  )\r
{\r
  EFI_STATUS Status;\r
  //\r
  // Locate protocols for later usage\r
  //\r
  if (mFormBrowser2 == NULL) {\r
    Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &mFormBrowser2);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
  \r
  if (mIfrSupportLibHiiConfigRouting == NULL) {\r
    Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &mIfrSupportLibHiiConfigRouting);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
//\r
// Fake <ConfigHdr>\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT16 mFakeConfigHdr[] = L"GUID=00000000000000000000000000000000&NAME=0000&PATH=0";\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  Marker                 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
  @retval EFI_OUT_OF_RESOURCES   There is no enough available memory space.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IfrLibCreatePopUp2 (\r
  IN  UINTN                       NumberOfLines,\r
  OUT EFI_INPUT_KEY               *KeyValue,\r
  IN  VA_LIST                     Marker\r
  )\r
{\r
  UINTN                         Index;\r
  UINTN                         Count;\r
  UINTN                         Start;\r
  UINTN                         Top;\r
  CHAR16                        *StringPtr;\r
  UINTN                         LeftColumn;\r
  UINTN                         RightColumn;\r
  UINTN                         TopRow;\r
  UINTN                         BottomRow;\r
  UINTN                         DimensionsWidth;\r
  UINTN                         DimensionsHeight;\r
  EFI_INPUT_KEY                 Key;\r
  UINTN                         LargestString;\r
  CHAR16                        *StackString;\r
  EFI_STATUS                    Status;\r
  UINTN                         StringLen;\r
  CHAR16                        *LineBuffer;\r
  CHAR16                        **StringArray;\r
  EFI_EVENT                     TimerEvent;\r
  EFI_EVENT                     WaitList[2];\r
  UINTN                         CurrentAttribute;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *ConOut;\r
  CHAR16                        *String;\r
\r
  String = VA_ARG (Marker, CHAR16 *);\r
  \r
  if ((KeyValue == NULL) || (String == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  TopRow      = 0;\r
  BottomRow   = 0;\r
  LeftColumn  = 0;\r
  RightColumn = 0;\r
\r
  ConOut = gST->ConOut;\r
  ConOut->QueryMode (ConOut, ConOut->Mode->Mode, &RightColumn, &BottomRow);\r
\r
  DimensionsWidth  = RightColumn - LeftColumn;\r
  DimensionsHeight = BottomRow - TopRow;\r
\r
  CurrentAttribute = ConOut->Mode->Attribute;\r
\r
  LineBuffer = AllocateZeroPool (DimensionsWidth * sizeof (CHAR16));\r
  if (LineBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Determine the largest string in the dialog box\r
  // Notice we are starting with 1 since String is the first string\r
  //\r
  StringArray = AllocateZeroPool (NumberOfLines * sizeof (CHAR16 *));\r
  if (StringArray == NULL) {\r
    FreePool (LineBuffer);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  LargestString = StrLen (String);\r
  StringArray[0] = String;\r
\r
  for (Index = 1; Index < NumberOfLines; Index++) {\r
    StackString = VA_ARG (Marker, CHAR16 *);\r
\r
    if (StackString == NULL) {\r
      FreePool (LineBuffer);\r
      FreePool (StringArray);\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    StringArray[Index] = StackString;\r
    StringLen = StrLen (StackString);\r
    if (StringLen > LargestString) {\r
      LargestString = StringLen;\r
    }\r
  }\r
\r
  if ((LargestString + 2) > DimensionsWidth) {\r
    LargestString = DimensionsWidth - 2;\r
  }\r
\r
  //\r
  // Subtract the PopUp width from total Columns, allow for one space extra on\r
  // each end plus a border.\r
  //\r
  Start     = (DimensionsWidth - LargestString - 2) / 2 + LeftColumn + 1;\r
\r
  Top       = ((DimensionsHeight - NumberOfLines - 2) / 2) + TopRow - 1;\r
\r
  //\r
  // Disable cursor\r
  //\r
  ConOut->EnableCursor (ConOut, FALSE);\r
  ConOut->SetAttribute (ConOut, EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE);\r
\r
  StringPtr = &LineBuffer[0];\r
  *StringPtr++ = BOXDRAW_DOWN_RIGHT;\r
  for (Index = 0; Index < LargestString; Index++) {\r
    *StringPtr++ = BOXDRAW_HORIZONTAL;\r
  }\r
  *StringPtr++ = BOXDRAW_DOWN_LEFT;\r
  *StringPtr = L'\0';\r
\r
  ConOut->SetCursorPosition (ConOut, Start, Top);\r
  ConOut->OutputString (ConOut, LineBuffer);\r
\r
  for (Index = 0; Index < NumberOfLines; Index++) {\r
    StringPtr = &LineBuffer[0];\r
    *StringPtr++ = BOXDRAW_VERTICAL;\r
\r
    for (Count = 0; Count < LargestString; Count++) {\r
      StringPtr[Count] = L' ';\r
    }\r
\r
    StringLen = StrLen (StringArray[Index]);\r
    if (StringLen > LargestString) {\r
      StringLen = LargestString;\r
    }\r
    CopyMem (\r
      StringPtr + ((LargestString - StringLen) / 2),\r
      StringArray[Index],\r
      StringLen * sizeof (CHAR16)\r
      );\r
    StringPtr += LargestString;\r
\r
    *StringPtr++ = BOXDRAW_VERTICAL;\r
    *StringPtr = L'\0';\r
\r
    ConOut->SetCursorPosition (ConOut, Start, Top + 1 + Index);\r
    ConOut->OutputString (ConOut, LineBuffer);\r
  }\r
\r
  StringPtr = &LineBuffer[0];\r
  *StringPtr++ = BOXDRAW_UP_RIGHT;\r
  for (Index = 0; Index < LargestString; Index++) {\r
    *StringPtr++ = BOXDRAW_HORIZONTAL;\r
  }\r
  *StringPtr++ = BOXDRAW_UP_LEFT;\r
  *StringPtr = L'\0';\r
\r
  ConOut->SetCursorPosition (ConOut, Start, Top + NumberOfLines + 1);\r
  ConOut->OutputString (ConOut, LineBuffer);\r
\r
  do {\r
    Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);\r
\r
    //\r
    // Set a timer event of 1 second expiration\r
    //\r
    gBS->SetTimer (\r
          TimerEvent,\r
          TimerRelative,\r
          10000000\r
          );\r
\r
    //\r
    // Wait for the keystroke event or the timer\r
    //\r
    WaitList[0] = gST->ConIn->WaitForKey;\r
    WaitList[1] = TimerEvent;\r
    Status      = gBS->WaitForEvent (2, WaitList, &Index);\r
\r
    //\r
    // Check for the timer expiration\r
    //\r
    if (!EFI_ERROR (Status) && Index == 1) {\r
      Status = EFI_TIMEOUT;\r
    }\r
\r
    gBS->CloseEvent (TimerEvent);\r
  } while (Status == EFI_TIMEOUT);\r
\r
  Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
  CopyMem (KeyValue, &Key, sizeof (EFI_INPUT_KEY));\r
\r
  ConOut->SetAttribute (ConOut, CurrentAttribute);\r
  ConOut->EnableCursor (ConOut, TRUE);\r
\r
  FreePool (LineBuffer);\r
  FreePool (StringArray);\r
\r
  return Status;\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
  EFI_STATUS                      Status;\r
  VA_LIST                         Marker;\r
\r
  VA_START (Marker, KeyValue);\r
\r
  Status = IfrLibCreatePopUp2 (NumberOfLines, KeyValue, Marker);\r
\r
  VA_END (Marker);\r
\r
  return Status;\r
}\r
\r
/**\r
  Swap bytes in the buffer. This is a internal function.\r
\r
  @param  Buffer                 Binary buffer.\r
  @param  BufferSize             Size of the buffer in bytes.\r
\r
  @return None.\r
\r
**/\r
VOID\r
SwapBuffer (\r
  IN OUT UINT8     *Buffer,\r
  IN UINTN         BufferSize\r
  )\r
{\r
  UINTN  Index;\r
  UINT8  Temp;\r
  UINTN  SwapCount;\r
\r
  SwapCount = BufferSize / 2;\r
  for (Index = 0; Index < SwapCount; Index++) {\r
    Temp = Buffer[Index];\r
    Buffer[Index] = Buffer[BufferSize - 1 - Index];\r
    Buffer[BufferSize - 1 - Index] = Temp;\r
  }\r
}\r
\r
/**\r
  Converts the unicode character of the string from uppercase to lowercase.\r
  This is a internal function.\r
\r
  @param Str     String to be converted\r
\r
**/\r
VOID\r
EFIAPI\r
ToLower (\r
  IN OUT CHAR16    *Str\r
  )\r
{\r
  CHAR16      *Ptr;\r
  \r
  for (Ptr = Str; *Ptr != L'\0'; Ptr++) {\r
    if (*Ptr >= L'A' && *Ptr <= L'Z') {\r
      *Ptr = (CHAR16) (*Ptr - L'A' + L'a');\r
    }\r
  }\r
}\r
\r
\r
/**\r
  Converts binary buffer to Unicode string in reversed byte order from 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
  @retval EFI_OUT_OF_RESOURCES   There is no enough available memory space.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BufInReverseOrderToHexString (\r
  IN OUT CHAR16    *Str,\r
  IN UINT8         *Buffer,\r
  IN UINTN         BufferSize\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT8       *NewBuffer;\r
  UINTN       StrBufferLen;\r
\r
  NewBuffer = AllocateCopyPool (BufferSize, Buffer);\r
  if (NewBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  SwapBuffer (NewBuffer, BufferSize);\r
\r
  StrBufferLen = BufferSize * sizeof (CHAR16) + 1;\r
  Status = BufToHexString (Str, &StrBufferLen, NewBuffer, BufferSize);\r
\r
  FreePool (NewBuffer);\r
  //\r
  // Convert the uppercase to lowercase since <HexAf> is defined in lowercase format.\r
  //\r
  ToLower (Str);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Converts Hex String to binary buffer in reversed byte order from 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
  @retval RETURN_BUFFER_TOO_SMALL   The input BufferSize is too small to hold the output. BufferSize\r
                                 will be updated to the size required for the converstion.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HexStringToBufInReverseOrder (\r
  IN OUT UINT8         *Buffer,\r
  IN OUT UINTN         *BufferSize,\r
  IN CHAR16            *Str\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       ConvertedStrLen;\r
\r
  ConvertedStrLen = 0;\r
  Status = HexStringToBuf (Buffer, BufferSize, Str, &ConvertedStrLen);\r
  if (!EFI_ERROR (Status)) {\r
    SwapBuffer (Buffer, ConvertedStrLen);\r
  }\r
\r
  return Status;\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          Operation completes successfully.\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
  UINTN       Index;\r
  UINTN       Len;\r
  UINTN       BufferSize;\r
  CHAR16      BackupChar;\r
\r
  Len = StrLen (ConfigString) / 4;\r
  BufferSize = (Len + 1) * sizeof (CHAR16);\r
\r
  if (*StrBufferLen < BufferSize) {\r
    *StrBufferLen = BufferSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *StrBufferLen = BufferSize;\r
\r
  for (Index = 0; Index < Len; Index++) {\r
    BackupChar = ConfigString[4];\r
    ConfigString[4] = L'\0';\r
\r
    HexStringToBuf ((UINT8 *) UnicodeString, &BufferSize, ConfigString, NULL);\r
\r
    ConfigString[4] = BackupChar;\r
\r
    ConfigString += 4;\r
    UnicodeString += 1;\r
  }\r
\r
  //\r
  // Add tailing '\0' character\r
  //\r
  *UnicodeString = L'\0';\r
\r
  return EFI_SUCCESS;\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           Operation completes successfully.\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
  UINTN       Index;\r
  UINTN       Len;\r
  UINTN       BufferSize;\r
  CHAR16      *String;\r
\r
  Len = StrLen (UnicodeString);\r
  BufferSize = (Len * 4 + 1) * sizeof (CHAR16);\r
\r
  if (*StrBufferLen < BufferSize) {\r
    *StrBufferLen = BufferSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *StrBufferLen = BufferSize;\r
  String        = ConfigString;\r
\r
  for (Index = 0; Index < Len; Index++) {\r
    BufToHexString (ConfigString, &BufferSize, (UINT8 *) UnicodeString, 2);\r
\r
    ConfigString += 4;\r
    UnicodeString += 1;\r
  }\r
\r
  //\r
  // Add tailing '\0' character\r
  //\r
  *ConfigString = L'\0';\r
\r
  //\r
  // Convert the uppercase to lowercase since <HexAf> is defined in lowercase format.\r
  //\r
  ToLower (String);  \r
  return EFI_SUCCESS;\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            Operation completes successfully.\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 CONST EFI_GUID            *Guid,\r
  IN CHAR16                    *Name, OPTIONAL\r
  IN EFI_HANDLE                *DriverHandle\r
  )\r
{\r
  EFI_STATUS                Status;\r
  UINTN                     NameStrLen;\r
  UINTN                     DevicePathSize;\r
  UINTN                     BufferSize;\r
  CHAR16                    *StrPtr;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
\r
  if (Name == NULL) {\r
    //\r
    // There will be no "NAME" in <ConfigHdr> for  Name/Value storage\r
    //\r
    NameStrLen = 0;\r
  } else {\r
    //\r
    // For buffer storage\r
    //\r
    NameStrLen = StrLen (Name);\r
  }\r
\r
  //\r
  // Retrieve DevicePath Protocol associated with this HiiPackageList\r
  //\r
  Status = gBS->HandleProtocol (\r
                  DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &DevicePath\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  DevicePathSize = GetDevicePathSize (DevicePath);\r
\r
  //\r
  // GUID=<HexCh>32&NAME=<Char>NameStrLen&PATH=<HexChar>DevicePathStrLen <NULL>\r
  // | 5  |   32   |  6  |  NameStrLen*4 |  6  |    DevicePathStrLen    | 1 |\r
  //\r
  BufferSize = (5 + 32 + 6 + NameStrLen * 4 + 6 + DevicePathSize * 2 + 1) * sizeof (CHAR16);\r
  if (*StrBufferLen < BufferSize) {\r
    *StrBufferLen = BufferSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *StrBufferLen = BufferSize;\r
\r
  StrPtr = ConfigHdr;\r
\r
  StrCpy (StrPtr, L"GUID=");\r
  StrPtr += 5;\r
  BufInReverseOrderToHexString (StrPtr, (UINT8 *) Guid, sizeof (EFI_GUID));\r
  StrPtr += 32;\r
\r
  //\r
  // Convert name string, e.g. name "ABCD" => "&NAME=0041004200430044"\r
  //\r
  StrCpy (StrPtr, L"&NAME=");\r
  StrPtr += 6;\r
  if (Name != NULL) {\r
    BufferSize = (NameStrLen * 4 + 1) * sizeof (CHAR16);\r
    UnicodeToConfigString (StrPtr, &BufferSize, Name);\r
    StrPtr += (NameStrLen * 4);\r
  }\r
\r
  StrCpy (StrPtr, L"&PATH=");\r
  StrPtr += 6;\r
  BufInReverseOrderToHexString (StrPtr, (UINT8 *) DevicePath, DevicePathSize);\r
\r
  return EFI_SUCCESS;\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
  IN UINTN                     Offset,\r
  IN UINTN                     Width\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       Data;\r
  UINTN       BufferSize;\r
  UINTN       ConvertedStrLen;\r
\r
  while ((String = StrStr (String, L"&OFFSET=")) != NULL) {\r
    //\r
    // Skip '&OFFSET='\r
    //\r
    String = String + 8;\r
\r
    Data = 0;\r
    BufferSize = sizeof (UINTN);\r
    Status = HexStringToBuf ((UINT8 *) &Data, &BufferSize, String, &ConvertedStrLen);\r
    if (EFI_ERROR (Status)) {\r
      return FALSE;\r
    }\r
    String = String + ConvertedStrLen;\r
\r
    if (Data != Offset) {\r
      continue;\r
    }\r
\r
    if (StrnCmp (String, L"&WIDTH=", 7) != 0) {\r
      return FALSE;\r
    }\r
    String = String + 7;\r
\r
    Data = 0;\r
    BufferSize = sizeof (UINTN);\r
    Status = HexStringToBuf ((UINT8 *) &Data, &BufferSize, String, &ConvertedStrLen);\r
    if (EFI_ERROR (Status)) {\r
      return FALSE;\r
    }\r
    if (Data == Width) {\r
      return TRUE;\r
    }\r
\r
    String = String + ConvertedStrLen;\r
  }\r
\r
  return FALSE;\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            Operation completes successfully.\r
  @retval EFI_BUFFER_TOO_SMALL   The intput buffer is too small.\r
  @retval EFI_OUT_OF_RESOURCES   There is no enough available memory space.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetBrowserData (\r
  IN CONST EFI_GUID              *VariableGuid, OPTIONAL\r
  IN CONST CHAR16                *VariableName, OPTIONAL\r
  IN OUT UINTN                   *BufferSize,\r
  IN OUT UINT8                   *Buffer\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  CONST CHAR16                    *ConfigHdr;\r
  CHAR16                          *ConfigResp;\r
  CHAR16                          *StringPtr;\r
  UINTN                           HeaderLen;\r
  UINTN                           BufferLen;\r
  CHAR16                          *Progress;\r
\r
  //\r
  // Locate protocols for use\r
  //\r
  Status = LocateFormBrowser2Protocols ();\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Retrive formset storage data from Form Browser\r
  //\r
  ConfigHdr = mFakeConfigHdr;\r
  HeaderLen = StrLen (ConfigHdr);\r
  \r
  //\r
  // First try allocate 0x4000 buffer for the formet storage data.\r
  //\r
  BufferLen = 0x4000;\r
  ConfigResp = AllocateZeroPool (BufferLen + HeaderLen);\r
  if (ConfigResp == NULL) {\r
    BufferLen = 0;\r
  }\r
\r
  StringPtr = ConfigResp + HeaderLen;\r
  *StringPtr = L'&';\r
  StringPtr++;\r
\r
  Status = mFormBrowser2->BrowserCallback (\r
                           mFormBrowser2,\r
                           &BufferLen,\r
                           StringPtr,\r
                           TRUE,\r
                           VariableGuid,\r
                           VariableName\r
                           );\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    if (ConfigResp != NULL) {\r
      FreePool (ConfigResp);\r
    }\r
\r
    ConfigResp = AllocateZeroPool (BufferLen + HeaderLen);\r
    if (ConfigResp == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    StringPtr = ConfigResp + HeaderLen;\r
    *StringPtr = L'&';\r
    StringPtr++;\r
\r
    Status = mFormBrowser2->BrowserCallback (\r
                             mFormBrowser2,\r
                             &BufferLen,\r
                             StringPtr,\r
                             TRUE,\r
                             VariableGuid,\r
                             VariableName\r
                             );\r
  }\r
  if (EFI_ERROR (Status)) {\r
    FreePool (ConfigResp);\r
    return Status;\r
  }\r
  CopyMem (ConfigResp, ConfigHdr, HeaderLen * sizeof (UINT16));\r
\r
  //\r
  // Convert <ConfigResp> to buffer data\r
  //\r
  Status = mIfrSupportLibHiiConfigRouting->ConfigToBlock (\r
                               mIfrSupportLibHiiConfigRouting,\r
                               ConfigResp,\r
                               Buffer,\r
                               BufferSize,\r
                               &Progress\r
                               );\r
  FreePool (ConfigResp);\r
\r
  return Status;\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            Operation completes successfully.\r
  @retval EFI_OUT_OF_RESOURCES   There is no enough available memory space.\r
  @retval Other                  Updating Browser uncommitted data failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SetBrowserData (\r
  IN CONST EFI_GUID          *VariableGuid, OPTIONAL\r
  IN CONST CHAR16            *VariableName, OPTIONAL\r
  IN UINTN                   BufferSize,\r
  IN CONST UINT8             *Buffer,\r
  IN CONST CHAR16            *RequestElement  OPTIONAL\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  CONST CHAR16                    *ConfigHdr;\r
  CHAR16                          *ConfigResp;\r
  CHAR16                          *StringPtr;\r
  UINTN                           HeaderLen;\r
  UINTN                           BufferLen;\r
  CHAR16                          *Progress;\r
  CHAR16                          BlockName[33];\r
  CHAR16                          *ConfigRequest;\r
  CONST CHAR16                    *Request;\r
\r
  //\r
  // Locate protocols for use\r
  //\r
  Status = LocateFormBrowser2Protocols ();\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Prepare <ConfigRequest>\r
  //\r
  ConfigHdr = mFakeConfigHdr;\r
  HeaderLen = StrLen (ConfigHdr);\r
\r
  if (RequestElement == NULL) {\r
    //\r
    // RequestElement not specified, use "&OFFSET=0&WIDTH=<BufferSize>" as <BlockName>\r
    //\r
    BlockName[0] = L'\0';\r
    StrCpy (BlockName, L"&OFFSET=0&WIDTH=");\r
\r
    //\r
    // String lenghth of L"&OFFSET=0&WIDTH=" is 16\r
    //\r
    StringPtr = BlockName + 16;\r
    BufferLen = sizeof (BlockName) - (16 * sizeof (CHAR16));\r
    BufToHexString (StringPtr, &BufferLen, (UINT8 *) &BufferSize, sizeof (UINTN));\r
\r
    Request = BlockName;\r
  } else {\r
    Request = RequestElement;\r
  }\r
\r
  BufferLen = HeaderLen * sizeof (CHAR16) + StrSize (Request);\r
  ConfigRequest = AllocateZeroPool (BufferLen);\r
  if (ConfigRequest == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  CopyMem (ConfigRequest, ConfigHdr, HeaderLen * sizeof (CHAR16));\r
  StringPtr = ConfigRequest + HeaderLen;\r
  StrCpy (StringPtr, Request);\r
\r
  //\r
  // Convert buffer to <ConfigResp>\r
  //\r
  Status = mIfrSupportLibHiiConfigRouting->BlockToConfig (\r
                                mIfrSupportLibHiiConfigRouting,\r
                                ConfigRequest,\r
                                Buffer,\r
                                BufferSize,\r
                                &ConfigResp,\r
                                &Progress\r
                                );\r
  if (EFI_ERROR (Status)) {\r
    FreePool (ConfigRequest);\r
    return Status;\r
  }\r
\r
  //\r
  // Skip <ConfigHdr> and '&'\r
  //\r
  StringPtr = ConfigResp + HeaderLen + 1;\r
\r
  //\r
  // Change uncommitted data in Browser\r
  //\r
  Status = mFormBrowser2->BrowserCallback (\r
                           mFormBrowser2,\r
                           &BufferSize,\r
                           StringPtr,\r
                           FALSE,\r
                           NULL,\r
                           NULL\r
                           );\r
  FreePool (ConfigRequest);\r
  return Status;\r
}\r