[mirror_edk2.git] / MdeModulePkg / Application / UiApp / FrontPage.c

/** @file\r
  FrontPage routines to handle the callbacks and browser calls\r
\r
Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2018 Hewlett Packard Enterprise Development LP<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "FrontPage.h"\r
#include "FrontPageCustomizedUi.h"\r
\r
#define MAX_STRING_LEN  200\r
\r
EFI_GUID  mFrontPageGuid = FRONT_PAGE_FORMSET_GUID;\r
\r
BOOLEAN  mResetRequired = FALSE;\r
\r
EFI_FORM_BROWSER2_PROTOCOL  *gFormBrowser2;\r
CHAR8                       *mLanguageString;\r
BOOLEAN                     mModeInitialized = FALSE;\r
//\r
// Boot video resolution and text mode.\r
//\r
UINT32  mBootHorizontalResolution = 0;\r
UINT32  mBootVerticalResolution   = 0;\r
UINT32  mBootTextModeColumn       = 0;\r
UINT32  mBootTextModeRow          = 0;\r
//\r
// BIOS setup video resolution and text mode.\r
//\r
UINT32  mSetupTextModeColumn       = 0;\r
UINT32  mSetupTextModeRow          = 0;\r
UINT32  mSetupHorizontalResolution = 0;\r
UINT32  mSetupVerticalResolution   = 0;\r
\r
FRONT_PAGE_CALLBACK_DATA  gFrontPagePrivate = {\r
  FRONT_PAGE_CALLBACK_DATA_SIGNATURE,\r
  NULL,\r
  NULL,\r
  NULL,\r
  {\r
    FakeExtractConfig,\r
    FakeRouteConfig,\r
    FrontPageCallback\r
  }\r
};\r
\r
HII_VENDOR_DEVICE_PATH  mFrontPageHiiVendorDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8)(sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8)((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    //\r
    // {8E6D99EE-7531-48f8-8745-7F6144468FF2}\r
    //\r
    { 0x8e6d99ee, 0x7531, 0x48f8, { 0x87, 0x45, 0x7f, 0x61, 0x44, 0x46, 0x8f, 0xf2 }\r
    }\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    {\r
      (UINT8)(END_DEVICE_PATH_LENGTH),\r
      (UINT8)((END_DEVICE_PATH_LENGTH) >> 8)\r
    }\r
  }\r
};\r
\r
/**\r
  Update the banner information for the Front Page based on Smbios information.\r
\r
**/\r
VOID\r
UpdateFrontPageBannerStrings (\r
  VOID\r
  );\r
\r
/**\r
  This function allows a caller to extract the current configuration for one\r
  or more named elements from the target driver.\r
\r
\r
  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Request         A null-terminated Unicode string in <ConfigRequest> format.\r
  @param Progress        On return, points to a character in the Request string.\r
                         Points to the string's null terminator if 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\r
                         first name/value pair) if the request was not successful.\r
  @param Results         A null-terminated Unicode string in <ConfigAltResp> format which\r
                         has all values 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 is filled with the requested values.\r
  @retval  EFI_OUT_OF_RESOURCES   Not enough memory to store the results.\r
  @retval  EFI_INVALID_PARAMETER  Request is illegal syntax, or unknown name.\r
  @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FakeExtractConfig (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  IN  CONST EFI_STRING                      Request,\r
  OUT EFI_STRING                            *Progress,\r
  OUT EFI_STRING                            *Results\r
  )\r
{\r
  if ((Progress == NULL) || (Results == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *Progress = Request;\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
\r
  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Configuration   A null-terminated Unicode string in <ConfigResp> format.\r
  @param Progress        A pointer to a string filled in with the offset of the most\r
                         recent '&' before the first failing name/value pair (or the\r
                         beginning of the string if the failure is in the first\r
                         name/value pair) or the terminating NULL if all was successful.\r
\r
  @retval  EFI_SUCCESS            The Results is processed successfully.\r
  @retval  EFI_INVALID_PARAMETER  Configuration is NULL.\r
  @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FakeRouteConfig (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  IN  CONST EFI_STRING                      Configuration,\r
  OUT EFI_STRING                            *Progress\r
  )\r
{\r
  if ((Configuration == NULL) || (Progress == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *Progress = Configuration;\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
\r
  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Action          Specifies the type of action taken by the browser.\r
  @param QuestionId      A unique value which is sent to the original exporting driver\r
                         so that it can identify the type of data to expect.\r
  @param Type            The type of value for the question.\r
  @param Value           A pointer to the data being sent to the original exporting driver.\r
  @param ActionRequest   On return, points to the action requested by the callback function.\r
\r
  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
  @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.\r
  @retval  EFI_DEVICE_ERROR      The variable could not be saved.\r
  @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FrontPageCallback (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL  *This,\r
  IN  EFI_BROWSER_ACTION                    Action,\r
  IN  EFI_QUESTION_ID                       QuestionId,\r
  IN  UINT8                                 Type,\r
  IN  EFI_IFR_TYPE_VALUE                    *Value,\r
  OUT EFI_BROWSER_ACTION_REQUEST            *ActionRequest\r
  )\r
{\r
  return UiFrontPageCallbackHandler (gFrontPagePrivate.HiiHandle, Action, QuestionId, Type, Value, ActionRequest);\r
}\r
\r
/**\r
\r
  Update the menus in the front page.\r
\r
**/\r
VOID\r
UpdateFrontPageForm (\r
  VOID\r
  )\r
{\r
  VOID                *StartOpCodeHandle;\r
  VOID                *EndOpCodeHandle;\r
  EFI_IFR_GUID_LABEL  *StartGuidLabel;\r
  EFI_IFR_GUID_LABEL  *EndGuidLabel;\r
\r
  //\r
  // Allocate space for creation of UpdateData Buffer\r
  //\r
  StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
  ASSERT (StartOpCodeHandle != NULL);\r
\r
  EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
  ASSERT (EndOpCodeHandle != NULL);\r
  //\r
  // Create Hii Extend Label OpCode as the start opcode\r
  //\r
  StartGuidLabel               = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
  StartGuidLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
  StartGuidLabel->Number       = LABEL_FRONTPAGE_INFORMATION;\r
  //\r
  // Create Hii Extend Label OpCode as the end opcode\r
  //\r
  EndGuidLabel               = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
  EndGuidLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
  EndGuidLabel->Number       = LABEL_END;\r
\r
  //\r
  // Updata Front Page form\r
  //\r
  UiCustomizeFrontPage (\r
    gFrontPagePrivate.HiiHandle,\r
    StartOpCodeHandle\r
    );\r
\r
  HiiUpdateForm (\r
    gFrontPagePrivate.HiiHandle,\r
    &mFrontPageGuid,\r
    FRONT_PAGE_FORM_ID,\r
    StartOpCodeHandle,\r
    EndOpCodeHandle\r
    );\r
\r
  HiiFreeOpCodeHandle (StartOpCodeHandle);\r
  HiiFreeOpCodeHandle (EndOpCodeHandle);\r
}\r
\r
/**\r
  Initialize HII information for the FrontPage\r
\r
\r
  @retval  EFI_SUCCESS        The operation is successful.\r
  @retval  EFI_DEVICE_ERROR   If the dynamic opcode creation failed.\r
\r
**/\r
EFI_STATUS\r
InitializeFrontPage (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Locate Hii relative protocols\r
  //\r
  Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **)&gFormBrowser2);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Install Device Path Protocol and Config Access protocol to driver handle\r
  //\r
  gFrontPagePrivate.DriverHandle = NULL;\r
  Status                         = gBS->InstallMultipleProtocolInterfaces (\r
                                          &gFrontPagePrivate.DriverHandle,\r
                                          &gEfiDevicePathProtocolGuid,\r
                                          &mFrontPageHiiVendorDevicePath,\r
                                          &gEfiHiiConfigAccessProtocolGuid,\r
                                          &gFrontPagePrivate.ConfigAccess,\r
                                          NULL\r
                                          );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Publish our HII data\r
  //\r
  gFrontPagePrivate.HiiHandle = HiiAddPackages (\r
                                  &mFrontPageGuid,\r
                                  gFrontPagePrivate.DriverHandle,\r
                                  FrontPageVfrBin,\r
                                  UiAppStrings,\r
                                  NULL\r
                                  );\r
  ASSERT (gFrontPagePrivate.HiiHandle != NULL);\r
\r
  //\r
  // Updata Front Page banner strings\r
  //\r
  UpdateFrontPageBannerStrings ();\r
\r
  //\r
  // Update front page menus.\r
  //\r
  UpdateFrontPageForm ();\r
\r
  return Status;\r
}\r
\r
/**\r
  Call the browser and display the front page\r
\r
  @return   Status code that will be returned by\r
            EFI_FORM_BROWSER2_PROTOCOL.SendForm ().\r
\r
**/\r
EFI_STATUS\r
CallFrontPage (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_BROWSER_ACTION_REQUEST  ActionRequest;\r
\r
  //\r
  // Begin waiting for USER INPUT\r
  //\r
  REPORT_STATUS_CODE (\r
    EFI_PROGRESS_CODE,\r
    (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_PC_INPUT_WAIT)\r
    );\r
\r
  ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
  Status        = gFormBrowser2->SendForm (\r
                                   gFormBrowser2,\r
                                   &gFrontPagePrivate.HiiHandle,\r
                                   1,\r
                                   &mFrontPageGuid,\r
                                   0,\r
                                   NULL,\r
                                   &ActionRequest\r
                                   );\r
  //\r
  // Check whether user change any option setting which needs a reset to be effective\r
  //\r
  if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {\r
    EnableResetRequired ();\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Remove the installed packages from the HiiDatabase.\r
\r
**/\r
VOID\r
FreeFrontPage (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  gFrontPagePrivate.DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mFrontPageHiiVendorDevicePath,\r
                  &gEfiHiiConfigAccessProtocolGuid,\r
                  &gFrontPagePrivate.ConfigAccess,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Publish our HII data\r
  //\r
  HiiRemovePackages (gFrontPagePrivate.HiiHandle);\r
  if (gFrontPagePrivate.LanguageToken != NULL) {\r
    FreePool (gFrontPagePrivate.LanguageToken);\r
    gFrontPagePrivate.LanguageToken = NULL;\r
  }\r
}\r
\r
/**\r
  Convert Processor Frequency Data to a string.\r
\r
  @param ProcessorFrequency The frequency data to process\r
  @param Base10Exponent     The exponent based on 10\r
  @param String             The string that is created\r
\r
**/\r
VOID\r
ConvertProcessorToString (\r
  IN  UINT16  ProcessorFrequency,\r
  IN  UINT16  Base10Exponent,\r
  OUT CHAR16  **String\r
  )\r
{\r
  CHAR16  *StringBuffer;\r
  UINTN   Index;\r
  UINTN   DestMax;\r
  UINT32  FreqMhz;\r
\r
  if (Base10Exponent >= 6) {\r
    FreqMhz = ProcessorFrequency;\r
    for (Index = 0; Index < (UINT32)Base10Exponent - 6; Index++) {\r
      FreqMhz *= 10;\r
    }\r
  } else {\r
    FreqMhz = 0;\r
  }\r
\r
  DestMax      = 0x20 / sizeof (CHAR16);\r
  StringBuffer = AllocateZeroPool (0x20);\r
  ASSERT (StringBuffer != NULL);\r
  UnicodeValueToStringS (StringBuffer, sizeof (CHAR16) * DestMax, LEFT_JUSTIFY, FreqMhz / 1000, 3);\r
  Index = StrnLenS (StringBuffer, DestMax);\r
  StrCatS (StringBuffer, DestMax, L".");\r
  UnicodeValueToStringS (\r
    StringBuffer + Index + 1,\r
    sizeof (CHAR16) * (DestMax - (Index + 1)),\r
    PREFIX_ZERO,\r
    (FreqMhz % 1000) / 10,\r
    2\r
    );\r
  StrCatS (StringBuffer, DestMax, L" GHz");\r
  *String = (CHAR16 *)StringBuffer;\r
  return;\r
}\r
\r
/**\r
  Convert Memory Size to a string.\r
\r
  @param MemorySize      The size of the memory to process\r
  @param String          The string that is created\r
\r
**/\r
VOID\r
ConvertMemorySizeToString (\r
  IN  UINT32  MemorySize,\r
  OUT CHAR16  **String\r
  )\r
{\r
  CHAR16  *StringBuffer;\r
\r
  StringBuffer = AllocateZeroPool (0x24);\r
  ASSERT (StringBuffer != NULL);\r
  UnicodeValueToStringS (StringBuffer, 0x24, LEFT_JUSTIFY, MemorySize, 10);\r
  StrCatS (StringBuffer, 0x24 / sizeof (CHAR16), L" MB RAM");\r
\r
  *String = (CHAR16 *)StringBuffer;\r
\r
  return;\r
}\r
\r
/**\r
\r
  Acquire the string associated with the Index from smbios structure and return it.\r
  The caller is responsible for free the string buffer.\r
\r
  @param    OptionalStrStart  The start position to search the string\r
  @param    Index             The index of the string to extract\r
  @param    String            The string that is extracted\r
\r
  @retval   EFI_SUCCESS       The function returns EFI_SUCCESS always.\r
\r
**/\r
EFI_STATUS\r
GetOptionalStringByIndex (\r
  IN      CHAR8   *OptionalStrStart,\r
  IN      UINT8   Index,\r
  OUT     CHAR16  **String\r
  )\r
{\r
  UINTN  StrSize;\r
\r
  if (Index == 0) {\r
    *String = AllocateZeroPool (sizeof (CHAR16));\r
    return EFI_SUCCESS;\r
  }\r
\r
  StrSize = 0;\r
  do {\r
    Index--;\r
    OptionalStrStart += StrSize;\r
    StrSize           = AsciiStrSize (OptionalStrStart);\r
  } while (OptionalStrStart[StrSize] != 0 && Index != 0);\r
\r
  if ((Index != 0) || (StrSize == 1)) {\r
    //\r
    // Meet the end of strings set but Index is non-zero, or\r
    // Find an empty string\r
    //\r
    *String = GetStringById (STRING_TOKEN (STR_MISSING_STRING));\r
  } else {\r
    *String = AllocatePool (StrSize * sizeof (CHAR16));\r
    AsciiStrToUnicodeStrS (OptionalStrStart, *String, StrSize);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Update the banner information for the Front Page based on Smbios information.\r
\r
**/\r
VOID\r
UpdateFrontPageBannerStrings (\r
  VOID\r
  )\r
{\r
  UINT8                    StrIndex;\r
  CHAR16                   *NewString;\r
  CHAR16                   *FirmwareVersionString;\r
  EFI_STATUS               Status;\r
  EFI_SMBIOS_HANDLE        SmbiosHandle;\r
  EFI_SMBIOS_PROTOCOL      *Smbios;\r
  SMBIOS_TABLE_TYPE0       *Type0Record;\r
  SMBIOS_TABLE_TYPE1       *Type1Record;\r
  SMBIOS_TABLE_TYPE4       *Type4Record;\r
  SMBIOS_TABLE_TYPE19      *Type19Record;\r
  EFI_SMBIOS_TABLE_HEADER  *Record;\r
  UINT64                   InstalledMemory;\r
  BOOLEAN                  FoundCpu;\r
\r
  InstalledMemory = 0;\r
  FoundCpu        = 0;\r
\r
  //\r
  // Update default banner string.\r
  //\r
  NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE4_LEFT), NULL);\r
  UiCustomizeFrontPageBanner (4, TRUE, &NewString);\r
  HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE4_LEFT), NewString, NULL);\r
  FreePool (NewString);\r
\r
  NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE4_RIGHT), NULL);\r
  UiCustomizeFrontPageBanner (4, FALSE, &NewString);\r
  HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE4_RIGHT), NewString, NULL);\r
  FreePool (NewString);\r
\r
  NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE5_LEFT), NULL);\r
  UiCustomizeFrontPageBanner (5, TRUE, &NewString);\r
  HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE5_LEFT), NewString, NULL);\r
  FreePool (NewString);\r
\r
  NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE5_RIGHT), NULL);\r
  UiCustomizeFrontPageBanner (5, FALSE, &NewString);\r
  HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE5_RIGHT), NewString, NULL);\r
  FreePool (NewString);\r
\r
  //\r
  // Update Front Page banner strings base on SmBios Table.\r
  //\r
  Status = gBS->LocateProtocol (&gEfiSmbiosProtocolGuid, NULL, (VOID **)&Smbios);\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Smbios protocol not found, get the default value.\r
    //\r
    NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL), NULL);\r
    UiCustomizeFrontPageBanner (1, TRUE, &NewString);\r
    HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL), NewString, NULL);\r
    FreePool (NewString);\r
\r
    NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL), NULL);\r
    UiCustomizeFrontPageBanner (2, TRUE, &NewString);\r
    HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL), NewString, NULL);\r
    FreePool (NewString);\r
\r
    NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED), NULL);\r
    UiCustomizeFrontPageBanner (2, FALSE, &NewString);\r
    HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED), NewString, NULL);\r
    FreePool (NewString);\r
\r
    NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION), NULL);\r
    UiCustomizeFrontPageBanner (3, TRUE, &NewString);\r
    HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION), NewString, NULL);\r
    FreePool (NewString);\r
\r
    NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE), NULL);\r
    UiCustomizeFrontPageBanner (3, FALSE, &NewString);\r
    HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE), NewString, NULL);\r
    FreePool (NewString);\r
\r
    return;\r
  }\r
\r
  SmbiosHandle = SMBIOS_HANDLE_PI_RESERVED;\r
  Status       = Smbios->GetNext (Smbios, &SmbiosHandle, NULL, &Record, NULL);\r
  while (!EFI_ERROR (Status)) {\r
    if (Record->Type == SMBIOS_TYPE_BIOS_INFORMATION) {\r
      Type0Record = (SMBIOS_TABLE_TYPE0 *)Record;\r
      StrIndex    = Type0Record->BiosVersion;\r
      GetOptionalStringByIndex ((CHAR8 *)((UINT8 *)Type0Record + Type0Record->Hdr.Length), StrIndex, &NewString);\r
\r
      FirmwareVersionString = (CHAR16 *)PcdGetPtr (PcdFirmwareVersionString);\r
      if (*FirmwareVersionString != 0x0000 ) {\r
        FreePool (NewString);\r
        NewString = (CHAR16 *)PcdGetPtr (PcdFirmwareVersionString);\r
        UiCustomizeFrontPageBanner (3, TRUE, &NewString);\r
        HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION), NewString, NULL);\r
      } else {\r
        UiCustomizeFrontPageBanner (3, TRUE, &NewString);\r
        HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION), NewString, NULL);\r
        FreePool (NewString);\r
      }\r
    }\r
\r
    if (Record->Type == SMBIOS_TYPE_SYSTEM_INFORMATION) {\r
      Type1Record = (SMBIOS_TABLE_TYPE1 *)Record;\r
      StrIndex    = Type1Record->ProductName;\r
      GetOptionalStringByIndex ((CHAR8 *)((UINT8 *)Type1Record + Type1Record->Hdr.Length), StrIndex, &NewString);\r
      UiCustomizeFrontPageBanner (1, TRUE, &NewString);\r
      HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL), NewString, NULL);\r
      FreePool (NewString);\r
    }\r
\r
    if ((Record->Type == SMBIOS_TYPE_PROCESSOR_INFORMATION) && !FoundCpu) {\r
      Type4Record = (SMBIOS_TABLE_TYPE4 *)Record;\r
      //\r
      // The information in the record should be only valid when the CPU Socket is populated.\r
      //\r
      if ((Type4Record->Status & SMBIOS_TYPE4_CPU_SOCKET_POPULATED) == SMBIOS_TYPE4_CPU_SOCKET_POPULATED) {\r
        StrIndex = Type4Record->ProcessorVersion;\r
        GetOptionalStringByIndex ((CHAR8 *)((UINT8 *)Type4Record + Type4Record->Hdr.Length), StrIndex, &NewString);\r
        UiCustomizeFrontPageBanner (2, TRUE, &NewString);\r
        HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL), NewString, NULL);\r
        FreePool (NewString);\r
\r
        ConvertProcessorToString (Type4Record->CurrentSpeed, 6, &NewString);\r
        UiCustomizeFrontPageBanner (2, FALSE, &NewString);\r
        HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED), NewString, NULL);\r
        FreePool (NewString);\r
\r
        FoundCpu = TRUE;\r
      }\r
    }\r
\r
    if ( Record->Type == SMBIOS_TYPE_MEMORY_ARRAY_MAPPED_ADDRESS ) {\r
      Type19Record = (SMBIOS_TABLE_TYPE19 *)Record;\r
      if (Type19Record->StartingAddress != 0xFFFFFFFF ) {\r
        InstalledMemory += RShiftU64 (\r
                             Type19Record->EndingAddress -\r
                             Type19Record->StartingAddress + 1,\r
                             10\r
                             );\r
      } else {\r
        InstalledMemory += RShiftU64 (\r
                             Type19Record->ExtendedEndingAddress -\r
                             Type19Record->ExtendedStartingAddress + 1,\r
                             20\r
                             );\r
      }\r
    }\r
\r
    Status = Smbios->GetNext (Smbios, &SmbiosHandle, NULL, &Record, NULL);\r
  }\r
\r
  //\r
  // Now update the total installed RAM size\r
  //\r
  ConvertMemorySizeToString ((UINT32)InstalledMemory, &NewString);\r
  UiCustomizeFrontPageBanner (3, FALSE, &NewString);\r
  HiiSetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE), NewString, NULL);\r
  FreePool (NewString);\r
}\r
\r
/**\r
  This function will change video resolution and text mode\r
  according to defined setup mode or defined boot mode\r
\r
  @param  IsSetupMode   Indicate mode is changed to setup mode or boot mode.\r
\r
  @retval  EFI_SUCCESS  Mode is changed successfully.\r
  @retval  Others             Mode failed to be changed.\r
\r
**/\r
EFI_STATUS\r
UiSetConsoleMode (\r
  BOOLEAN  IsSetupMode\r
  )\r
{\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL          *GraphicsOutput;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL       *SimpleTextOut;\r
  UINTN                                 SizeOfInfo;\r
  EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *Info;\r
  UINT32                                MaxGopMode;\r
  UINT32                                MaxTextMode;\r
  UINT32                                ModeNumber;\r
  UINT32                                NewHorizontalResolution;\r
  UINT32                                NewVerticalResolution;\r
  UINT32                                NewColumns;\r
  UINT32                                NewRows;\r
  UINTN                                 HandleCount;\r
  EFI_HANDLE                            *HandleBuffer;\r
  EFI_STATUS                            Status;\r
  UINTN                                 Index;\r
  UINTN                                 CurrentColumn;\r
  UINTN                                 CurrentRow;\r
\r
  MaxGopMode  = 0;\r
  MaxTextMode = 0;\r
\r
  //\r
  // Get current video resolution and text mode\r
  //\r
  Status = gBS->HandleProtocol (\r
                  gST->ConsoleOutHandle,\r
                  &gEfiGraphicsOutputProtocolGuid,\r
                  (VOID **)&GraphicsOutput\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    GraphicsOutput = NULL;\r
  }\r
\r
  Status = gBS->HandleProtocol (\r
                  gST->ConsoleOutHandle,\r
                  &gEfiSimpleTextOutProtocolGuid,\r
                  (VOID **)&SimpleTextOut\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    SimpleTextOut = NULL;\r
  }\r
\r
  if ((GraphicsOutput == NULL) || (SimpleTextOut == NULL)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (IsSetupMode) {\r
    //\r
    // The required resolution and text mode is setup mode.\r
    //\r
    NewHorizontalResolution = mSetupHorizontalResolution;\r
    NewVerticalResolution   = mSetupVerticalResolution;\r
    NewColumns              = mSetupTextModeColumn;\r
    NewRows                 = mSetupTextModeRow;\r
  } else {\r
    //\r
    // The required resolution and text mode is boot mode.\r
    //\r
    NewHorizontalResolution = mBootHorizontalResolution;\r
    NewVerticalResolution   = mBootVerticalResolution;\r
    NewColumns              = mBootTextModeColumn;\r
    NewRows                 = mBootTextModeRow;\r
  }\r
\r
  if (GraphicsOutput != NULL) {\r
    MaxGopMode = GraphicsOutput->Mode->MaxMode;\r
  }\r
\r
  if (SimpleTextOut != NULL) {\r
    MaxTextMode = SimpleTextOut->Mode->MaxMode;\r
  }\r
\r
  //\r
  // 1. If current video resolution is same with required video resolution,\r
  //    video resolution need not be changed.\r
  //    1.1. If current text mode is same with required text mode, text mode need not be changed.\r
  //    1.2. If current text mode is different from required text mode, text mode need be changed.\r
  // 2. If current video resolution is different from required video resolution, we need restart whole console drivers.\r
  //\r
  for (ModeNumber = 0; ModeNumber < MaxGopMode; ModeNumber++) {\r
    Status = GraphicsOutput->QueryMode (\r
                               GraphicsOutput,\r
                               ModeNumber,\r
                               &SizeOfInfo,\r
                               &Info\r
                               );\r
    if (!EFI_ERROR (Status)) {\r
      if ((Info->HorizontalResolution == NewHorizontalResolution) &&\r
          (Info->VerticalResolution == NewVerticalResolution))\r
      {\r
        if ((GraphicsOutput->Mode->Info->HorizontalResolution == NewHorizontalResolution) &&\r
            (GraphicsOutput->Mode->Info->VerticalResolution == NewVerticalResolution))\r
        {\r
          //\r
          // Current resolution is same with required resolution, check if text mode need be set\r
          //\r
          Status = SimpleTextOut->QueryMode (SimpleTextOut, SimpleTextOut->Mode->Mode, &CurrentColumn, &CurrentRow);\r
          ASSERT_EFI_ERROR (Status);\r
          if ((CurrentColumn == NewColumns) && (CurrentRow == NewRows)) {\r
            //\r
            // If current text mode is same with required text mode. Do nothing\r
            //\r
            FreePool (Info);\r
            return EFI_SUCCESS;\r
          } else {\r
            //\r
            // If current text mode is different from required text mode.  Set new video mode\r
            //\r
            for (Index = 0; Index < MaxTextMode; Index++) {\r
              Status = SimpleTextOut->QueryMode (SimpleTextOut, Index, &CurrentColumn, &CurrentRow);\r
              if (!EFI_ERROR (Status)) {\r
                if ((CurrentColumn == NewColumns) && (CurrentRow == NewRows)) {\r
                  //\r
                  // Required text mode is supported, set it.\r
                  //\r
                  Status = SimpleTextOut->SetMode (SimpleTextOut, Index);\r
                  ASSERT_EFI_ERROR (Status);\r
                  //\r
                  // Update text mode PCD.\r
                  //\r
                  Status = PcdSet32S (PcdConOutColumn, mSetupTextModeColumn);\r
                  ASSERT_EFI_ERROR (Status);\r
                  Status = PcdSet32S (PcdConOutRow, mSetupTextModeRow);\r
                  ASSERT_EFI_ERROR (Status);\r
                  FreePool (Info);\r
                  return EFI_SUCCESS;\r
                }\r
              }\r
            }\r
\r
            if (Index == MaxTextMode) {\r
              //\r
              // If required text mode is not supported, return error.\r
              //\r
              FreePool (Info);\r
              return EFI_UNSUPPORTED;\r
            }\r
          }\r
        } else {\r
          //\r
          // If current video resolution is not same with the new one, set new video resolution.\r
          // In this case, the driver which produces simple text out need be restarted.\r
          //\r
          Status = GraphicsOutput->SetMode (GraphicsOutput, ModeNumber);\r
          if (!EFI_ERROR (Status)) {\r
            FreePool (Info);\r
            break;\r
          }\r
        }\r
      }\r
\r
      FreePool (Info);\r
    }\r
  }\r
\r
  if (ModeNumber == MaxGopMode) {\r
    //\r
    // If the resolution is not supported, return error.\r
    //\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Set PCD to Inform GraphicsConsole to change video resolution.\r
  // Set PCD to Inform Consplitter to change text mode.\r
  //\r
  Status = PcdSet32S (PcdVideoHorizontalResolution, NewHorizontalResolution);\r
  ASSERT_EFI_ERROR (Status);\r
  Status = PcdSet32S (PcdVideoVerticalResolution, NewVerticalResolution);\r
  ASSERT_EFI_ERROR (Status);\r
  Status = PcdSet32S (PcdConOutColumn, NewColumns);\r
  ASSERT_EFI_ERROR (Status);\r
  Status = PcdSet32S (PcdConOutRow, NewRows);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Video mode is changed, so restart graphics console driver and higher level driver.\r
  // Reconnect graphics console driver and higher level driver.\r
  // Locate all the handles with GOP protocol and reconnect it.\r
  //\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiSimpleTextOutProtocolGuid,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    for (Index = 0; Index < HandleCount; Index++) {\r
      gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);\r
    }\r
\r
    for (Index = 0; Index < HandleCount; Index++) {\r
      gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);\r
    }\r
\r
    if (HandleBuffer != NULL) {\r
      FreePool (HandleBuffer);\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The user Entry Point for Application. The user code starts with this function\r
  as the real entry point for the image goes into a library that calls this\r
  function.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.\r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeUserInterface (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_HII_HANDLE                   HiiHandle;\r
  EFI_STATUS                       Status;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *SimpleTextOut;\r
  UINTN                            BootTextColumn;\r
  UINTN                            BootTextRow;\r
\r
  if (!mModeInitialized) {\r
    //\r
    // After the console is ready, get current video resolution\r
    // and text mode before launching setup at first time.\r
    //\r
    Status = gBS->HandleProtocol (\r
                    gST->ConsoleOutHandle,\r
                    &gEfiGraphicsOutputProtocolGuid,\r
                    (VOID **)&GraphicsOutput\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      GraphicsOutput = NULL;\r
    }\r
\r
    Status = gBS->HandleProtocol (\r
                    gST->ConsoleOutHandle,\r
                    &gEfiSimpleTextOutProtocolGuid,\r
                    (VOID **)&SimpleTextOut\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      SimpleTextOut = NULL;\r
    }\r
\r
    if (GraphicsOutput != NULL) {\r
      //\r
      // Get current video resolution and text mode.\r
      //\r
      mBootHorizontalResolution = GraphicsOutput->Mode->Info->HorizontalResolution;\r
      mBootVerticalResolution   = GraphicsOutput->Mode->Info->VerticalResolution;\r
    }\r
\r
    if (SimpleTextOut != NULL) {\r
      Status = SimpleTextOut->QueryMode (\r
                                SimpleTextOut,\r
                                SimpleTextOut->Mode->Mode,\r
                                &BootTextColumn,\r
                                &BootTextRow\r
                                );\r
      mBootTextModeColumn = (UINT32)BootTextColumn;\r
      mBootTextModeRow    = (UINT32)BootTextRow;\r
    }\r
\r
    //\r
    // Get user defined text mode for setup.\r
    //\r
    mSetupHorizontalResolution = PcdGet32 (PcdSetupVideoHorizontalResolution);\r
    mSetupVerticalResolution   = PcdGet32 (PcdSetupVideoVerticalResolution);\r
    mSetupTextModeColumn       = PcdGet32 (PcdSetupConOutColumn);\r
    mSetupTextModeRow          = PcdGet32 (PcdSetupConOutRow);\r
\r
    mModeInitialized = TRUE;\r
  }\r
\r
  gBS->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL);\r
  gST->ConOut->ClearScreen (gST->ConOut);\r
\r
  //\r
  // Install customized fonts needed by Front Page\r
  //\r
  HiiHandle = ExportFonts ();\r
  ASSERT (HiiHandle != NULL);\r
\r
  InitializeStringSupport ();\r
\r
  UiSetConsoleMode (TRUE);\r
  UiEntry (FALSE);\r
  UiSetConsoleMode (FALSE);\r
\r
  UninitializeStringSupport ();\r
  HiiRemovePackages (HiiHandle);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function is the main entry of the UI entry.\r
  The function will present the main menu of the system UI.\r
\r
  @param ConnectAllHappened Caller passes the value to UI to avoid unnecessary connect-all.\r
\r
**/\r
VOID\r
EFIAPI\r
UiEntry (\r
  IN BOOLEAN  ConnectAllHappened\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_BOOT_LOGO_PROTOCOL  *BootLogo;\r
\r
  //\r
  // Enter Setup page.\r
  //\r
  REPORT_STATUS_CODE (\r
    EFI_PROGRESS_CODE,\r
    (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_PC_USER_SETUP)\r
    );\r
\r
  //\r
  // Indicate if the connect all has been performed before.\r
  // If has not been performed before, do here.\r
  //\r
  if (!ConnectAllHappened) {\r
    EfiBootManagerConnectAll ();\r
  }\r
\r
  //\r
  // The boot option enumeration time is acceptable in Ui driver\r
  //\r
  EfiBootManagerRefreshAllBootOption ();\r
\r
  //\r
  // Boot Logo is corrupted, report it using Boot Logo protocol.\r
  //\r
  Status = gBS->LocateProtocol (&gEfiBootLogoProtocolGuid, NULL, (VOID **)&BootLogo);\r
  if (!EFI_ERROR (Status) && (BootLogo != NULL)) {\r
    BootLogo->SetBootLogo (BootLogo, NULL, 0, 0, 0, 0);\r
  }\r
\r
  InitializeFrontPage ();\r
\r
  CallFrontPage ();\r
\r
  FreeFrontPage ();\r
\r
  if (mLanguageString != NULL) {\r
    FreePool (mLanguageString);\r
    mLanguageString = NULL;\r
  }\r
\r
  //\r
  // Will leave browser, check any reset required change is applied? if yes, reset system\r
  //\r
  SetupResetReminder ();\r
}\r
\r
//\r
//  Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.\r
//  Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser  if\r
//  user change any option setting which needs a reset to be effective, and  the reset will be applied according to  the user selection.\r
//\r
\r
/**\r
  Record the info that  a reset is required.\r
  A  module boolean variable is used to record whether a reset is required.\r
\r
**/\r
VOID\r
EFIAPI\r
EnableResetRequired (\r
  VOID\r
  )\r
{\r
  mResetRequired = TRUE;\r
}\r
\r
/**\r
  Check if  user changed any option setting which needs a system reset to be effective.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
IsResetRequired (\r
  VOID\r
  )\r
{\r
  return mResetRequired;\r
}\r
\r
/**\r
  Check whether a reset is needed, and finish the reset reminder feature.\r
  If a reset is needed, Popup a menu to notice user, and finish the feature\r
  according to the user selection.\r
\r
**/\r
VOID\r
EFIAPI\r
SetupResetReminder (\r
  VOID\r
  )\r
{\r
  EFI_INPUT_KEY  Key;\r
  CHAR16         *StringBuffer1;\r
  CHAR16         *StringBuffer2;\r
\r
  //\r
  // check any reset required change is applied? if yes, reset system\r
  //\r
  if (IsResetRequired ()) {\r
    StringBuffer1 = AllocateZeroPool (MAX_STRING_LEN * sizeof (CHAR16));\r
    ASSERT (StringBuffer1 != NULL);\r
    StringBuffer2 = AllocateZeroPool (MAX_STRING_LEN * sizeof (CHAR16));\r
    ASSERT (StringBuffer2 != NULL);\r
    StrCpyS (StringBuffer1, MAX_STRING_LEN, L"Configuration changed. Reset to apply it Now.");\r
    StrCpyS (StringBuffer2, MAX_STRING_LEN, L"Press ENTER to reset");\r
    //\r
    // Popup a menu to notice user\r
    //\r
    do {\r
      CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, StringBuffer1, StringBuffer2, NULL);\r
    } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
\r
    FreePool (StringBuffer1);\r
    FreePool (StringBuffer2);\r
\r
    gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);\r
  }\r
}\r