MdeModulePkg: Make HII configuration settings available to OS runtime

[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / HiiDatabaseEntry.c

/** @file\r
This file contains the entry code to the HII database, which is defined by\r
UEFI 2.1 specification.\r
\r
Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
#include "HiiDatabase.h"\r
\r
//\r
// Global variables\r
//\r
EFI_EVENT gHiiKeyboardLayoutChanged;\r
BOOLEAN   gExportAfterReadyToBoot = FALSE;\r
\r
HII_DATABASE_PRIVATE_DATA mPrivate = {\r
  HII_DATABASE_PRIVATE_DATA_SIGNATURE,\r
  {\r
    (LIST_ENTRY *) NULL,\r
    (LIST_ENTRY *) NULL\r
  },\r
  {\r
    (LIST_ENTRY *) NULL,\r
    (LIST_ENTRY *) NULL\r
  },\r
  {\r
    HiiStringToImage,\r
    HiiStringIdToImage,\r
    HiiGetGlyph,\r
    HiiGetFontInfo\r
  },\r
  {\r
    NULL,\r
    NULL,\r
    NULL,\r
    NULL,\r
    NULL\r
  },\r
  {\r
    HiiNewString,\r
    HiiGetString,\r
    HiiSetString,\r
    HiiGetLanguages,\r
    HiiGetSecondaryLanguages\r
  },\r
  {\r
    HiiNewPackageList,\r
    HiiRemovePackageList,\r
    HiiUpdatePackageList,\r
    HiiListPackageLists,\r
    HiiExportPackageLists,\r
    HiiRegisterPackageNotify,\r
    HiiUnregisterPackageNotify,\r
    HiiFindKeyboardLayouts,\r
    HiiGetKeyboardLayout,\r
    HiiSetKeyboardLayout,\r
    HiiGetPackageListHandle\r
  },\r
  {\r
    HiiConfigRoutingExtractConfig,\r
    HiiConfigRoutingExportConfig,\r
    HiiConfigRoutingRouteConfig,\r
    HiiBlockToConfig,\r
    HiiConfigToBlock,\r
    HiiGetAltCfg\r
  },\r
  {\r
    EfiConfigKeywordHandlerSetData,\r
    EfiConfigKeywordHandlerGetData\r
  },\r
  {\r
    (LIST_ENTRY *) NULL,\r
    (LIST_ENTRY *) NULL\r
  },\r
  0,\r
  {\r
    (LIST_ENTRY *) NULL,\r
    (LIST_ENTRY *) NULL\r
  },\r
  EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK),\r
  {\r
    0x00000000,\r
    0x0000,\r
    0x0000,\r
    {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}\r
  },\r
  NULL\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_HII_IMAGE_PROTOCOL mImageProtocol = {\r
  HiiNewImage,\r
  HiiGetImage,\r
  HiiSetImage,\r
  HiiDrawImage,\r
  HiiDrawImageId\r
};\r
\r
/**\r
  The default event handler for gHiiKeyboardLayoutChanged\r
  event group.\r
\r
  This is internal function.\r
\r
  @param Event           The event that triggered this notification function.\r
  @param Context         Pointer to the notification functions context.\r
\r
**/\r
VOID\r
EFIAPI\r
KeyboardLayoutChangeNullEvent (\r
  IN EFI_EVENT                Event,\r
  IN VOID                     *Context\r
  )\r
{\r
  return;\r
}\r
\r
/**\r
  On Ready To Boot Services Event notification handler.\r
\r
  To trigger the function that to export the Hii Configuration setting.\r
\r
  @param[in]  Event     Event whose notification function is being invoked\r
  @param[in]  Context   Pointer to the notification function's context\r
\r
**/\r
VOID\r
EFIAPI\r
OnReadyToBoot (\r
  IN      EFI_EVENT                         Event,\r
  IN      VOID                              *Context\r
  )\r
{\r
  //\r
  // When ready to boot, we begin to export the HiiDatabase date.\r
  // And hook all the possible HiiDatabase change actions to export data.\r
  //\r
  HiiGetConfigurationSetting(&mPrivate.HiiDatabase);\r
  gExportAfterReadyToBoot = TRUE;\r
}\r
\r
/**\r
  Initialize HII Database.\r
\r
\r
  @param ImageHandle     The image handle.\r
  @param SystemTable     The system table.\r
\r
  @retval EFI_SUCCESS    The Hii database is setup correctly.\r
  @return Other value if failed to create the default event for\r
          gHiiKeyboardLayoutChanged. Check gBS->CreateEventEx for\r
          details. Or failed to insatll the protocols.\r
          Check gBS->InstallMultipleProtocolInterfaces for details.\r
          Or failed to create Ready To Boot Event.\r
          Check EfiCreateEventReadyToBootEx for details.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeHiiDatabase (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS                             Status;\r
  EFI_HANDLE                             Handle;\r
  EFI_EVENT                              ReadyToBootEvent;\r
\r
  //\r
  // There will be only one HII Database in the system\r
  // If there is another out there, someone is trying to install us\r
  // again.  Fail that scenario.\r
  //\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiDatabaseProtocolGuid);\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiFontProtocolGuid);\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiImageProtocolGuid);\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiStringProtocolGuid);\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiConfigRoutingProtocolGuid);\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiConfigKeywordHandlerProtocolGuid);\r
  \r
  InitializeListHead (&mPrivate.DatabaseList);\r
  InitializeListHead (&mPrivate.DatabaseNotifyList);\r
  InitializeListHead (&mPrivate.HiiHandleList);\r
  InitializeListHead (&mPrivate.FontInfoList);\r
\r
  //\r
  // Create a event with EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group type.\r
  //\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  KeyboardLayoutChangeNullEvent,\r
                  NULL,\r
                  &gEfiHiiKeyBoardLayoutGuid,\r
                  &gHiiKeyboardLayoutChanged\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Handle = NULL;\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Handle,\r
                  &gEfiHiiFontProtocolGuid,\r
                  &mPrivate.HiiFont,\r
                  &gEfiHiiStringProtocolGuid,\r
                  &mPrivate.HiiString,\r
                  &gEfiHiiDatabaseProtocolGuid,\r
                  &mPrivate.HiiDatabase,\r
                  &gEfiHiiConfigRoutingProtocolGuid,\r
                  &mPrivate.ConfigRouting,\r
                  &gEfiConfigKeywordHandlerProtocolGuid,\r
                  &mPrivate.ConfigKeywordHandler,\r
                  NULL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (FeaturePcdGet (PcdSupportHiiImageProtocol)) {\r
    CopyMem (&mPrivate.HiiImage, &mImageProtocol, sizeof (mImageProtocol));\r
\r
    Status = gBS->InstallMultipleProtocolInterfaces (\r
                    &Handle,\r
                    &gEfiHiiImageProtocolGuid,\r
                    &mPrivate.HiiImage,\r
                    NULL\r
                    );\r
\r
  }\r
\r
  if (FeaturePcdGet(PcdHiiOsRuntimeSupport)) {\r
    Status = EfiCreateEventReadyToBootEx (\r
               TPL_CALLBACK,\r
               OnReadyToBoot,\r
               NULL,\r
               &ReadyToBootEvent\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r