Add doxygen style comments for functions in DxeIpl.

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / HiiDatabase.c

/**@file\r
Framework to UEFI 2.1 HII Thunk. The driver consume UEFI HII protocols\r
to produce a Framework HII protocol.\r
\r
Copyright (c) 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 "HiiDatabase.h"\r
\r
\r
EFI_HII_THUNK_PRIVATE_DATA HiiThunkPrivateDataTempate = {\r
  {//Signature\r
    EFI_HII_THUNK_DRIVER_DATA_SIGNATURE \r
  },\r
  {//Handle\r
    (EFI_HANDLE) NULL\r
  },\r
  { //Hii\r
    HiiNewPack,\r
    HiiRemovePack,\r
    HiiFindHandles,\r
    HiiExportDatabase,\r
    \r
    HiiTestString,\r
    HiiGetGlyph,\r
    HiiGlyphToBlt,\r
    \r
    HiiNewString,\r
    HiiGetPrimaryLanguages,\r
    HiiGetSecondaryLanguages,\r
    HiiGetString,\r
    HiiResetStrings,\r
    HiiGetLine,\r
    HiiGetForms,\r
    HiiGetDefaultImage,\r
    HiiUpdateForm,\r
    \r
    HiiGetKeyboardLayout\r
  },\r
  { //StaticHiiHandle\r
    //The FRAMEWORK_EFI_HII_HANDLE starts from 1 \r
    // and increase upwords untill reach 2^(sizeof (FRAMEWORK_EFI_HII_HANDLE)) - 1. \r
    // The code will assert to prevent overflow.\r
    (FRAMEWORK_EFI_HII_HANDLE) 1 \r
  },\r
  {\r
    NULL, NULL                  //HiiHandleLinkList\r
  },\r
};\r
\r
CONST EFI_HII_DATABASE_PROTOCOL            *mHiiDatabase;\r
CONST EFI_HII_FONT_PROTOCOL                *mHiiFontProtocol;\r
CONST EFI_HII_IMAGE_PROTOCOL               *mHiiImageProtocol;\r
CONST EFI_HII_STRING_PROTOCOL              *mHiiStringProtocol;\r
CONST EFI_HII_CONFIG_ROUTING_PROTOCOL      *mHiiConfigRoutingProtocol;\r
\r
\r
EFI_STATUS\r
EFIAPI\r
InitializeHiiDatabase (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
  Initialize HII Database\r
\r
Arguments:\r
  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
\r
Returns:\r
  EFI_SUCCESS - Setup loaded.\r
  other       - Setup Error\r
\r
--*/\r
{\r
  EFI_HII_THUNK_PRIVATE_DATA *HiiData;\r
  EFI_HANDLE                 Handle;\r
  EFI_STATUS                 Status;\r
\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiProtocolGuid);\r
\r
  HiiData = AllocateCopyPool (sizeof (EFI_HII_THUNK_PRIVATE_DATA), &HiiThunkPrivateDataTempate);\r
  ASSERT (HiiData != NULL);\r
  InitializeListHead (&HiiData->HiiThunkHandleMappingDBListHead);\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiHiiDatabaseProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mHiiDatabase\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiHiiFontProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mHiiFontProtocol\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiHiiImageProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mHiiImageProtocol\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiHiiStringProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mHiiStringProtocol\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiHiiConfigRoutingProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mHiiConfigRoutingProtocol\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Install protocol interface\r
  //\r
  Handle = NULL;\r
  Status = gBS->InstallProtocolInterface (\r
                  &HiiData->Handle,\r
                  &gEfiHiiProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  (VOID *) &HiiData->Hii\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiFindHandles (\r
  IN     EFI_HII_PROTOCOL *This,\r
  IN OUT UINT16           *HandleBufferLength,\r
  OUT    FRAMEWORK_EFI_HII_HANDLE    Handle[1]\r
  )\r
/*++\r
\r
Routine Description:\r
  Determines the handles that are currently active in the database.\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  ASSERT (FALSE);\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetPrimaryLanguages (\r
  IN  EFI_HII_PROTOCOL      *This,\r
  IN  FRAMEWORK_EFI_HII_HANDLE         Handle,\r
  OUT EFI_STRING            *LanguageString\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function allows a program to determine what the primary languages that are supported on a given handle.\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  EFI_HII_THUNK_PRIVATE_DATA *Private;\r
  EFI_HII_HANDLE             UefiHiiHandle;\r
  CHAR8                      *AsciiLanguageCodes;\r
  CHAR16                     *UnicodeLanguageCodes;\r
\r
  Private = EFI_HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
\r
  \r
  \r
  UefiHiiHandle = FrameworkHiiHandleToUefiHiiHandle (Private, Handle);\r
  if (UefiHiiHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  AsciiLanguageCodes = HiiLibGetSupportedLanguages (UefiHiiHandle);\r
\r
  if (AsciiLanguageCodes == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  UnicodeLanguageCodes = AllocateZeroPool (AsciiStrSize (AsciiLanguageCodes) * sizeof (CHAR16));\r
  if (UnicodeLanguageCodes == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // The language returned is in RFC 3066 format.\r
  //\r
  *LanguageString = AsciiStrToUnicodeStr (AsciiLanguageCodes, UnicodeLanguageCodes);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetSecondaryLanguages (\r
  IN  EFI_HII_PROTOCOL      *This,\r
  IN  FRAMEWORK_EFI_HII_HANDLE         Handle,\r
  IN  CHAR16                *PrimaryLanguage,\r
  OUT EFI_STRING            *LanguageString\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function allows a program to determine which secondary languages are supported\r
  on a given handle for a given primary language.\r
\r
  Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  EFI_HII_THUNK_PRIVATE_DATA *Private;\r
  EFI_HII_HANDLE             UefiHiiHandle;\r
  CHAR8                      *AsciiPrimaryLanguage;\r
  CHAR8                      *AsciiLanguageCodes;\r
  CHAR16                     *UnicodeLanguageCodes;\r
\r
  Private = EFI_HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
\r
  \r
  \r
  UefiHiiHandle = FrameworkHiiHandleToUefiHiiHandle (Private, Handle);\r
  if (UefiHiiHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  AsciiPrimaryLanguage = AllocateZeroPool (StrLen (PrimaryLanguage) + 1);\r
\r
  UnicodeStrToAsciiStr (PrimaryLanguage, AsciiPrimaryLanguage);\r
\r
  AsciiLanguageCodes = HiiLibGetSupportedSecondaryLanguages (UefiHiiHandle, AsciiPrimaryLanguage);\r
\r
  if (AsciiLanguageCodes == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  UnicodeLanguageCodes = AllocateZeroPool (AsciiStrSize (AsciiLanguageCodes) * sizeof (CHAR16));\r
  if (UnicodeLanguageCodes == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // The language returned is in RFC 3066 format.\r
  //\r
  *LanguageString = AsciiStrToUnicodeStr (AsciiLanguageCodes, UnicodeLanguageCodes);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r