[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiOnUefiHiiThunk / 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
#include "HiiHandle.h"\r
\r
HII_THUNK_PRIVATE_DATA *mHiiThunkPrivateData;\r
\r
HII_THUNK_PRIVATE_DATA mHiiThunkPrivateDataTempate = {\r
  HII_THUNK_PRIVATE_DATA_SIGNATURE,\r
  (EFI_HANDLE) NULL,\r
  {\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
\r
  {\r
    ///\r
    /// HiiHandleLinkList\r
    ///\r
    NULL, NULL                  \r
  },\r
};\r
\r
EFI_FORMBROWSER_THUNK_PRIVATE_DATA mBrowserThunkPrivateDataTemplate = {\r
  EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE,\r
  (EFI_HANDLE) NULL,\r
  (HII_THUNK_PRIVATE_DATA *) NULL,\r
  {\r
    ThunkSendForm,\r
    ThunkCreatePopUp\r
  }\r
};\r
\r
\r
CONST EFI_HII_DATABASE_PROTOCOL            *mHiiDatabase;\r
CONST EFI_HII_IMAGE_PROTOCOL               *mHiiImageProtocol;\r
CONST EFI_HII_STRING_PROTOCOL              *mHiiStringProtocol;\r
CONST EFI_HII_FONT_PROTOCOL                *mHiiFontProtocol;\r
CONST EFI_HII_CONFIG_ROUTING_PROTOCOL      *mHiiConfigRoutingProtocol;\r
CONST EFI_FORM_BROWSER2_PROTOCOL           *mFormBrowser2Protocol;\r
\r
\r
/**\r
  This routine initializes the HII Database.\r
  \r
  @param ImageHandle     Image handle for PCD DXE driver.\r
  @param SystemTable     Pointer to SystemTable.\r
\r
  @retval  EFI_SUCCESS   The entry point alwasy return successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeHiiDatabase (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  HII_THUNK_PRIVATE_DATA *Private;\r
  EFI_HANDLE              Handle;\r
  EFI_STATUS              Status;\r
  UINTN                   BufferLength;\r
  EFI_HII_HANDLE          *Buffer;\r
  UINTN                   Index;\r
  HII_THUNK_CONTEXT       *ThunkContext;\r
  \r
\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiCompatibilityProtocolGuid);\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiFormBrowserCompatibilityProtocolGuid);\r
\r
  Private = AllocateCopyPool (sizeof (HII_THUNK_PRIVATE_DATA), &mHiiThunkPrivateDataTempate);\r
  ASSERT (Private != NULL);\r
  InitializeListHead (&Private->ThunkContextListHead);\r
\r
  InitHiiHandleDatabase ();\r
\r
  mHiiThunkPrivateData = Private;\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiHiiDatabaseProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mHiiDatabase\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
                  &gEfiHiiFontProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mHiiFontProtocol\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
  Status = gBS->LocateProtocol (\r
                  &gEfiFormBrowser2ProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mFormBrowser2Protocol\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
\r
  \r
\r
  //\r
  // Install protocol interface\r
  //\r
  Status = gBS->InstallProtocolInterface (\r
                  &Private->Handle,\r
                  &gEfiHiiCompatibilityProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  (VOID *) &Private->Hii\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = HiiLibListPackageLists (EFI_HII_PACKAGE_STRINGS, NULL, &BufferLength, &Buffer);\r
  if (Status == EFI_SUCCESS) {\r
    for (Index = 0; Index < BufferLength / sizeof (EFI_HII_HANDLE); Index++) {\r
      ThunkContext = CreateThunkContextForUefiHiiHandle (Buffer[Index]);\r
      ASSERT (ThunkContext!= NULL);\r
      \r
      InsertTailList (&Private->ThunkContextListHead, &ThunkContext->Link);\r
    }\r
\r
    FreePool (Buffer);\r
  }\r
\r
  Status = mHiiDatabase->RegisterPackageNotify (\r
                           mHiiDatabase,\r
                           EFI_HII_PACKAGE_STRINGS,\r
                           NULL,\r
                           NewOrAddPackNotify,\r
                           EFI_HII_DATABASE_NOTIFY_NEW_PACK,\r
                           &Handle\r
                           );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = mHiiDatabase->RegisterPackageNotify (\r
                           mHiiDatabase,\r
                           EFI_HII_PACKAGE_STRINGS,\r
                           NULL,\r
                           NewOrAddPackNotify,\r
                           EFI_HII_DATABASE_NOTIFY_ADD_PACK,\r
                           &Handle\r
                           );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = mHiiDatabase->RegisterPackageNotify (\r
                           mHiiDatabase,\r
                           EFI_HII_PACKAGE_FORMS,\r
                           NULL,\r
                           NewOrAddPackNotify,\r
                           EFI_HII_DATABASE_NOTIFY_NEW_PACK,\r
                           &Handle\r
                           );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = mHiiDatabase->RegisterPackageNotify (\r
                           mHiiDatabase,\r
                           EFI_HII_PACKAGE_FORMS,\r
                           NULL,\r
                           NewOrAddPackNotify,\r
                           EFI_HII_DATABASE_NOTIFY_ADD_PACK,\r
                           &Handle\r
                           );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = mHiiDatabase->RegisterPackageNotify (\r
                           mHiiDatabase,\r
                           EFI_HII_PACKAGE_STRINGS,\r
                           NULL,\r
                           RemovePackNotify,\r
                           EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r
                           &Handle\r
                           );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  InitSetBrowserStrings ();\r
\r
  mBrowserThunkPrivateDataTemplate.ThunkPrivate = Private;\r
  Status = gBS->InstallProtocolInterface (\r
                  &mBrowserThunkPrivateDataTemplate.Handle,\r
                  &gEfiFormBrowserCompatibilityProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  (VOID *) &mBrowserThunkPrivateDataTemplate.FormBrowser\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
  \r
  return Status;\r
}\r
\r
/**\r
  Determines the handles that are currently active in the database.\r
\r
  This function determines the handles that are currently active in the database. \r
  For example, a program wishing to create a Setup-like configuration utility would use this call \r
  to determine the handles that are available. It would then use calls defined in the forms section \r
  below to extract forms and then interpret them.\r
\r
  @param This                 A pointer to the EFI_HII_PROTOCOL instance.\r
  @param HandleBufferLength   On input, a pointer to the length of the handle buffer. \r
                              On output, the length of the handle buffer that is required for the handles found.\r
  @param Handle               An array of EFI_HII_HANDLE instances returned. \r
                              Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() in the Packages section.\r
\r
  @retval EFI_SUCCESS         Handle was updated successfully.\r
 \r
  @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates that Handle is too small \r
                               to support the number of handles. HandleBufferLength is updated with a value that \r
                               will enable the data to fit.\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
  UINT16                                     Count;\r
  LIST_ENTRY                                *Link;\r
  HII_THUNK_CONTEXT *ThunkContext;\r
  HII_THUNK_PRIVATE_DATA               *Private;\r
\r
  if (HandleBufferLength == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);  \r
\r
  //\r
  // Count the number of handles.\r
  //\r
  Count = 0;\r
  Link = GetFirstNode (&Private->ThunkContextListHead);\r
  while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
    Count++;\r
    Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
  }\r
\r
  if (Count > *HandleBufferLength) {\r
    *HandleBufferLength = (UINT16) (Count * sizeof (FRAMEWORK_EFI_HII_HANDLE));\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  //\r
  // Output the handles.\r
  //\r
  Count = 0;\r
  Link = GetFirstNode (&Private->ThunkContextListHead);\r
  while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
\r
    ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
    Handle[Count] = ThunkContext->FwHiiHandle;\r
\r
    Count++;\r
    Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
\r
  }\r
\r
  *HandleBufferLength = (UINT16) (Count * sizeof (FRAMEWORK_EFI_HII_HANDLE));\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
LangCodes3066To639 (\r
  IN CHAR8 *LangCodes3066,\r
  IN CHAR8 **LangCodes639\r
  )\r
{\r
  CHAR8                      *AsciiLangCodes;\r
  CHAR8                      Lang[RFC_3066_ENTRY_SIZE];\r
  UINTN                      Index;\r
  UINTN                      Count;\r
  EFI_STATUS                 Status;\r
\r
  ASSERT (LangCodes3066 != NULL);\r
  ASSERT (LangCodes639 != NULL);\r
  \r
  //\r
  // Count the number of RFC 3066 language codes.\r
  //\r
  Index = 0;\r
  AsciiLangCodes = LangCodes3066;\r
  while (AsciiStrLen (AsciiLangCodes) != 0) {\r
    HiiLibGetNextLanguage (&AsciiLangCodes, Lang);\r
    Index++;\r
  }\r
\r
  Count = Index;\r
\r
  //\r
  // \r
  //\r
  *LangCodes639 = AllocateZeroPool (ISO_639_2_ENTRY_SIZE * Count + 1);\r
  if (*LangCodes639 == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  AsciiLangCodes = LangCodes3066;\r
\r
  for (Index = 0; Index < Count; Index++) {\r
    HiiLibGetNextLanguage (&AsciiLangCodes, Lang);\r
    Status = ConvertRfc3066LanguageToIso639Language (Lang, *LangCodes639 + Index * ISO_639_2_ENTRY_SIZE);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Allows a program to determine the primary languages that are supported on a given handle.\r
\r
  This routine is intended to be used by drivers to query the interface database for supported languages. \r
  This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle.\r
\r
  @param This           A pointer to the EFI_HII_PROTOCOL instance.\r
  @param Handle         The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() \r
                        in the Packages section.\r
  @param LanguageString A string allocated by GetPrimaryLanguages() that contains a list of all primary languages \r
                        registered on the handle. The routine will not return the three-spaces language identifier used in \r
                        other functions to indicate non-language-specific strings.\r
\r
  @reval EFI_SUCCESS            LanguageString was correctly returned.\r
 \r
  @reval EFI_INVALID_PARAMETER The Handle was unknown.\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
  HII_THUNK_PRIVATE_DATA     *Private;\r
  EFI_HII_HANDLE             UefiHiiHandle;\r
  CHAR8                      *LangCodes3066;\r
  CHAR16                     *UnicodeLangCodes639;\r
  CHAR8                      *LangCodes639;\r
  EFI_STATUS                 Status;\r
\r
  Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
\r
  UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle);\r
  if (UefiHiiHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  LangCodes3066 = HiiLibGetSupportedLanguages (UefiHiiHandle);\r
\r
  if (LangCodes3066 == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
\r
  LangCodes639 = NULL;\r
  Status = LangCodes3066To639 (LangCodes3066, &LangCodes639);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
  \r
  UnicodeLangCodes639 = AllocateZeroPool (AsciiStrSize (LangCodes639) * sizeof (CHAR16));\r
  if (UnicodeLangCodes639 == NULL) {\r
    Status =  EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  //\r
  // The language returned is in RFC 639-2 format.\r
  //\r
  AsciiStrToUnicodeStr (LangCodes639, UnicodeLangCodes639);\r
  *LanguageString = UnicodeLangCodes639;\r
\r
Done:\r
  FreePool (LangCodes3066);\r
  if (LangCodes639 != NULL) {\r
    FreePool (LangCodes639);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Allows a program to determine which secondary languages are supported on a given handle for a given primary language\r
\r
  This routine is intended to be used by drivers to query the interface database for supported languages. \r
  This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle.\r
\r
  @param This           A pointer to the EFI_HII_PROTOCOL instance.\r
  @param Handle         The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() \r
                        in the Packages section.\r
  @param PrimaryLanguage Pointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating \r
                         the primary language.\r
  @param LanguageString  A string allocated by GetSecondaryLanguages() containing a list of all secondary languages registered \r
                         on the handle. The routine will not return the three-spaces language identifier used in other functions \r
                         to indicate non-language-specific strings, nor will it return the primary language. This function succeeds \r
                         but returns a NULL LanguageString if there are no secondary languages associated with the input Handle and \r
                         PrimaryLanguage pair. Type EFI_STRING is defined in String.\r
  \r
  @reval EFI_SUCCESS            LanguageString was correctly returned.\r
  @reval EFI_INVALID_PARAMETER  The Handle was unknown.\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
  HII_THUNK_PRIVATE_DATA *Private;\r
  EFI_HII_HANDLE             UefiHiiHandle;\r
  CHAR8                      PrimaryLang3066[RFC_3066_ENTRY_SIZE];\r
  CHAR8                      *PrimaryLang639;\r
  CHAR8                      *SecLangCodes3066;\r
  CHAR8                      *SecLangCodes639;\r
  CHAR16                     *UnicodeSecLangCodes639;\r
  EFI_STATUS                 Status;\r
\r
  Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
\r
  SecLangCodes639         = NULL;\r
  SecLangCodes3066        = NULL;\r
  UnicodeSecLangCodes639 = NULL;\r
\r
  UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle);\r
  if (UefiHiiHandle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PrimaryLang639 = AllocateZeroPool (StrLen (PrimaryLanguage) + 1);\r
  if (PrimaryLang639 == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  UnicodeStrToAsciiStr (PrimaryLanguage, PrimaryLang639);\r
\r
  Status = ConvertIso639LanguageToRfc3066Language (PrimaryLang639, PrimaryLang3066);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  SecLangCodes3066 = HiiLibGetSupportedSecondaryLanguages (UefiHiiHandle, PrimaryLang3066);\r
\r
  if (SecLangCodes3066 == NULL) {\r
    Status =  EFI_INVALID_PARAMETER;\r
    goto Done;\r
  }\r
\r
  Status = LangCodes3066To639 (SecLangCodes3066, &SecLangCodes639);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  UnicodeSecLangCodes639 = AllocateZeroPool (AsciiStrSize (SecLangCodes639) * sizeof (CHAR16));\r
  if (UnicodeSecLangCodes639 == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  //\r
  // The language returned is in RFC 3066 format.\r
  //\r
  *LanguageString = AsciiStrToUnicodeStr (SecLangCodes639, UnicodeSecLangCodes639);\r
\r
Done:\r
  if (PrimaryLang639 != NULL) {\r
    FreePool (PrimaryLang639);\r
  }\r
  if (SecLangCodes639 != NULL) {\r
    FreePool (SecLangCodes639);\r
  }\r
  if (SecLangCodes3066 != NULL) {\r
    FreePool (SecLangCodes3066);\r
  }\r
  if (UnicodeSecLangCodes639 != NULL) {\r
    FreePool (UnicodeSecLangCodes639);\r
  }\r
  \r
  return Status;\r
}\r
\r
 \r
Commit	Line	Data
4259256b	1	/**@file\r
ee3428bb	2	Framework to UEFI 2.1 HII Thunk. The driver consume UEFI HII protocols\r
ee3428bb	3	to produce a Framework HII protocol.\r
4259256b	4	\r
ee3428bb	5	Copyright (c) 2008, Intel Corporation\r
4259256b	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	#include "HiiDatabase.h"\r
d4775f2a	17	#include "HiiHandle.h"\r
4259256b	18	\r
0368663f	19	HII_THUNK_PRIVATE_DATA *mHiiThunkPrivateData;\r
	20	\r
	21	HII_THUNK_PRIVATE_DATA mHiiThunkPrivateDataTempate = {\r
	22	HII_THUNK_PRIVATE_DATA_SIGNATURE,\r
	23	(EFI_HANDLE) NULL,\r
	24	{\r
4259256b	25	HiiNewPack,\r
	26	HiiRemovePack,\r
	27	HiiFindHandles,\r
	28	HiiExportDatabase,\r
	29	\r
	30	HiiTestString,\r
	31	HiiGetGlyph,\r
	32	HiiGlyphToBlt,\r
	33	\r
	34	HiiNewString,\r
	35	HiiGetPrimaryLanguages,\r
	36	HiiGetSecondaryLanguages,\r
	37	HiiGetString,\r
	38	HiiResetStrings,\r
	39	HiiGetLine,\r
	40	HiiGetForms,\r
	41	HiiGetDefaultImage,\r
	42	HiiUpdateForm,\r
	43	\r
	44	HiiGetKeyboardLayout\r
	45	},\r
0368663f	46	\r
4259256b	47	{\r
a3318eaf	48	///\r
	49	/// HiiHandleLinkList\r
	50	///\r
	51	NULL, NULL \r
4259256b	52	},\r
	53	};\r
	54	\r
137c54ac	55	EFI_FORMBROWSER_THUNK_PRIVATE_DATA mBrowserThunkPrivateDataTemplate = {\r
	56	EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE,\r
	57	(EFI_HANDLE) NULL,\r
0368663f	58	(HII_THUNK_PRIVATE_DATA *) NULL,\r
137c54ac	59	{\r
	60	ThunkSendForm,\r
	61	ThunkCreatePopUp\r
	62	}\r
	63	};\r
	64	\r
	65	\r
59336178	66	CONST EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;\r
59336178	67	CONST EFI_HII_IMAGE_PROTOCOL *mHiiImageProtocol;\r
59336178	68	CONST EFI_HII_STRING_PROTOCOL *mHiiStringProtocol;\r
133a9dfb	69	CONST EFI_HII_FONT_PROTOCOL *mHiiFontProtocol;\r
59336178	70	CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRoutingProtocol;\r
0368663f	71	CONST EFI_FORM_BROWSER2_PROTOCOL *mFormBrowser2Protocol;\r
ebbd2793	72	\r
ea58467b	73	\r
3321fa09	74	/**\r
	75	This routine initializes the HII Database.\r
	76	\r
	77	@param ImageHandle Image handle for PCD DXE driver.\r
	78	@param SystemTable Pointer to SystemTable.\r
ea58467b	79	\r
3321fa09	80	@retval EFI_SUCCESS The entry point alwasy return successfully.\r
3321fa09	81	**/\r
4259256b	82	EFI_STATUS\r
	83	EFIAPI\r
	84	InitializeHiiDatabase (\r
	85	IN EFI_HANDLE ImageHandle,\r
	86	IN EFI_SYSTEM_TABLE *SystemTable\r
	87	)\r
4259256b	88	{\r
0368663f	89	HII_THUNK_PRIVATE_DATA *Private;\r
	90	EFI_HANDLE Handle;\r
	91	EFI_STATUS Status;\r
	92	UINTN BufferLength;\r
	93	EFI_HII_HANDLE *Buffer;\r
	94	UINTN Index;\r
d4775f2a	95	HII_THUNK_CONTEXT *ThunkContext;\r
0368663f	96	\r
4259256b	97	\r
962045a2	98	ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiCompatibilityProtocolGuid);\r
962045a2	99	ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiFormBrowserCompatibilityProtocolGuid);\r
4259256b	100	\r
0368663f	101	Private = AllocateCopyPool (sizeof (HII_THUNK_PRIVATE_DATA), &mHiiThunkPrivateDataTempate);\r
	102	ASSERT (Private != NULL);\r
	103	InitializeListHead (&Private->ThunkContextListHead);\r
4259256b	104	\r
d4775f2a	105	InitHiiHandleDatabase ();\r
d4775f2a	106	\r
0368663f	107	mHiiThunkPrivateData = Private;\r
ea58467b	108	\r
4259256b	109	Status = gBS->LocateProtocol (\r
	110	&gEfiHiiDatabaseProtocolGuid,\r
	111	NULL,\r
59336178	112	(VOID **) &mHiiDatabase\r
4259256b	113	);\r
	114	ASSERT_EFI_ERROR (Status);\r
	115	\r
	116	Status = gBS->LocateProtocol (\r
0368663f	117	&gEfiHiiStringProtocolGuid,\r
4259256b	118	NULL,\r
0368663f	119	(VOID **) &mHiiStringProtocol\r
4259256b	120	);\r
	121	ASSERT_EFI_ERROR (Status);\r
	122	\r
133a9dfb	123	Status = gBS->LocateProtocol (\r
	124	&gEfiHiiFontProtocolGuid,\r
	125	NULL,\r
	126	(VOID **) &mHiiFontProtocol\r
	127	);\r
	128	ASSERT_EFI_ERROR (Status);\r
	129	\r
4259256b	130	Status = gBS->LocateProtocol (\r
0368663f	131	&gEfiHiiConfigRoutingProtocolGuid,\r
4259256b	132	NULL,\r
0368663f	133	(VOID **) &mHiiConfigRoutingProtocol\r
4259256b	134	);\r
	135	ASSERT_EFI_ERROR (Status);\r
	136	\r
4259256b	137	\r
ebbd2793	138	Status = gBS->LocateProtocol (\r
0368663f	139	&gEfiFormBrowser2ProtocolGuid,\r
ebbd2793	140	NULL,\r
0368663f	141	(VOID **) &mFormBrowser2Protocol\r
ebbd2793	142	);\r
	143	ASSERT_EFI_ERROR (Status);\r
	144	\r
0368663f	145	\r
	146	\r
	147	\r
4259256b	148	//\r
	149	// Install protocol interface\r
	150	//\r
4259256b	151	Status = gBS->InstallProtocolInterface (\r
0368663f	152	&Private->Handle,\r
962045a2	153	&gEfiHiiCompatibilityProtocolGuid,\r
4259256b	154	EFI_NATIVE_INTERFACE,\r
0368663f	155	(VOID *) &Private->Hii\r
4259256b	156	);\r
	157	ASSERT_EFI_ERROR (Status);\r
	158	\r
0368663f	159	Status = HiiLibListPackageLists (EFI_HII_PACKAGE_STRINGS, NULL, &BufferLength, &Buffer);\r
	160	if (Status == EFI_SUCCESS) {\r
	161	for (Index = 0; Index < BufferLength / sizeof (EFI_HII_HANDLE); Index++) {\r
d4775f2a	162	ThunkContext = CreateThunkContextForUefiHiiHandle (Buffer[Index]);\r
	163	ASSERT (ThunkContext!= NULL);\r
	164	\r
	165	InsertTailList (&Private->ThunkContextListHead, &ThunkContext->Link);\r
0368663f	166	}\r
	167	\r
	168	FreePool (Buffer);\r
	169	}\r
ea58467b	170	\r
	171	Status = mHiiDatabase->RegisterPackageNotify (\r
	172	mHiiDatabase,\r
	173	EFI_HII_PACKAGE_STRINGS,\r
	174	NULL,\r
0368663f	175	NewOrAddPackNotify,\r
ea58467b	176	EFI_HII_DATABASE_NOTIFY_NEW_PACK,\r
0368663f	177	&Handle\r
ea58467b	178	);\r
	179	ASSERT_EFI_ERROR (Status);\r
	180	\r
	181	Status = mHiiDatabase->RegisterPackageNotify (\r
	182	mHiiDatabase,\r
	183	EFI_HII_PACKAGE_STRINGS,\r
	184	NULL,\r
0368663f	185	NewOrAddPackNotify,\r
	186	EFI_HII_DATABASE_NOTIFY_ADD_PACK,\r
	187	&Handle\r
	188	);\r
	189	ASSERT_EFI_ERROR (Status);\r
	190	\r
	191	Status = mHiiDatabase->RegisterPackageNotify (\r
	192	mHiiDatabase,\r
4dd76ade	193	EFI_HII_PACKAGE_FORMS,\r
0368663f	194	NULL,\r
	195	NewOrAddPackNotify,\r
	196	EFI_HII_DATABASE_NOTIFY_NEW_PACK,\r
	197	&Handle\r
	198	);\r
	199	ASSERT_EFI_ERROR (Status);\r
	200	\r
	201	Status = mHiiDatabase->RegisterPackageNotify (\r
	202	mHiiDatabase,\r
4dd76ade	203	EFI_HII_PACKAGE_FORMS,\r
0368663f	204	NULL,\r
0368663f	205	NewOrAddPackNotify,\r
ea58467b	206	EFI_HII_DATABASE_NOTIFY_ADD_PACK,\r
0368663f	207	&Handle\r
ea58467b	208	);\r
	209	ASSERT_EFI_ERROR (Status);\r
	210	\r
	211	Status = mHiiDatabase->RegisterPackageNotify (\r
	212	mHiiDatabase,\r
	213	EFI_HII_PACKAGE_STRINGS,\r
	214	NULL,\r
	215	RemovePackNotify,\r
	216	EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r
0368663f	217	&Handle\r
ea58467b	218	);\r
	219	ASSERT_EFI_ERROR (Status);\r
	220	\r
a235abd2	221	InitSetBrowserStrings ();\r
a235abd2	222	\r
0368663f	223	mBrowserThunkPrivateDataTemplate.ThunkPrivate = Private;\r
137c54ac	224	Status = gBS->InstallProtocolInterface (\r
137c54ac	225	&mBrowserThunkPrivateDataTemplate.Handle,\r
962045a2	226	&gEfiFormBrowserCompatibilityProtocolGuid,\r
137c54ac	227	EFI_NATIVE_INTERFACE,\r
	228	(VOID *) &mBrowserThunkPrivateDataTemplate.FormBrowser\r
	229	);\r
	230	ASSERT_EFI_ERROR (Status);\r
	231	\r
4259256b	232	return Status;\r
	233	}\r
	234	\r
3321fa09	235	/**\r
	236	Determines the handles that are currently active in the database.\r
	237	\r
	238	This function determines the handles that are currently active in the database. \r
	239	For example, a program wishing to create a Setup-like configuration utility would use this call \r
	240	to determine the handles that are available. It would then use calls defined in the forms section \r
	241	below to extract forms and then interpret them.\r
	242	\r
	243	@param This A pointer to the EFI_HII_PROTOCOL instance.\r
	244	@param HandleBufferLength On input, a pointer to the length of the handle buffer. \r
	245	On output, the length of the handle buffer that is required for the handles found.\r
	246	@param Handle An array of EFI_HII_HANDLE instances returned. \r
	247	Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() in the Packages section.\r
	248	\r
	249	@retval EFI_SUCCESS Handle was updated successfully.\r
	250	\r
	251	@retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates that Handle is too small \r
	252	to support the number of handles. HandleBufferLength is updated with a value that \r
	253	will enable the data to fit.\r
	254	**/\r
4259256b	255	EFI_STATUS\r
	256	EFIAPI\r
	257	HiiFindHandles (\r
	258	IN EFI_HII_PROTOCOL *This,\r
	259	IN OUT UINT16 *HandleBufferLength,\r
	260	OUT FRAMEWORK_EFI_HII_HANDLE Handle[1]\r
	261	)\r
4259256b	262	{\r
ea58467b	263	UINT16 Count;\r
0368663f	264	LIST_ENTRY *Link;\r
	265	HII_THUNK_CONTEXT *ThunkContext;\r
	266	HII_THUNK_PRIVATE_DATA *Private;\r
ea58467b	267	\r
	268	if (HandleBufferLength == NULL) {\r
	269	return EFI_INVALID_PARAMETER;\r
	270	}\r
	271	\r
0368663f	272	Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This); \r
ea58467b	273	\r
0368663f	274	//\r
	275	// Count the number of handles.\r
	276	//\r
ea58467b	277	Count = 0;\r
0368663f	278	Link = GetFirstNode (&Private->ThunkContextListHead);\r
0368663f	279	while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
ea58467b	280	Count++;\r
0368663f	281	Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
ea58467b	282	}\r
	283	\r
	284	if (Count > *HandleBufferLength) {\r
5990ace9	285	HandleBufferLength = (UINT16) (Count sizeof (FRAMEWORK_EFI_HII_HANDLE));\r
ea58467b	286	return EFI_BUFFER_TOO_SMALL;\r
	287	}\r
	288	\r
0368663f	289	//\r
	290	// Output the handles.\r
	291	//\r
ea58467b	292	Count = 0;\r
0368663f	293	Link = GetFirstNode (&Private->ThunkContextListHead);\r
	294	while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
	295	\r
	296	ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
	297	Handle[Count] = ThunkContext->FwHiiHandle;\r
ea58467b	298	\r
ea58467b	299	Count++;\r
0368663f	300	Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
	301	\r
	302	}\r
ea58467b	303	\r
5990ace9	304	HandleBufferLength = (UINT16) (Count sizeof (FRAMEWORK_EFI_HII_HANDLE));\r
4259256b	305	return EFI_SUCCESS;\r
	306	}\r
	307	\r
0368663f	308	EFI_STATUS\r
	309	LangCodes3066To639 (\r
	310	IN CHAR8 *LangCodes3066,\r
	311	IN CHAR8 **LangCodes639\r
	312	)\r
	313	{\r
	314	CHAR8 *AsciiLangCodes;\r
	315	CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
	316	UINTN Index;\r
	317	UINTN Count;\r
	318	EFI_STATUS Status;\r
	319	\r
	320	ASSERT (LangCodes3066 != NULL);\r
	321	ASSERT (LangCodes639 != NULL);\r
	322	\r
	323	//\r
	324	// Count the number of RFC 3066 language codes.\r
	325	//\r
	326	Index = 0;\r
	327	AsciiLangCodes = LangCodes3066;\r
	328	while (AsciiStrLen (AsciiLangCodes) != 0) {\r
	329	HiiLibGetNextLanguage (&AsciiLangCodes, Lang);\r
	330	Index++;\r
	331	}\r
	332	\r
	333	Count = Index;\r
	334	\r
	335	//\r
	336	// \r
	337	//\r
	338	LangCodes639 = AllocateZeroPool (ISO_639_2_ENTRY_SIZE Count + 1);\r
	339	if (*LangCodes639 == NULL) {\r
	340	return EFI_OUT_OF_RESOURCES;\r
	341	}\r
	342	\r
	343	AsciiLangCodes = LangCodes3066;\r
	344	\r
	345	for (Index = 0; Index < Count; Index++) {\r
	346	HiiLibGetNextLanguage (&AsciiLangCodes, Lang);\r
	347	Status = ConvertRfc3066LanguageToIso639Language (Lang, LangCodes639 + Index ISO_639_2_ENTRY_SIZE);\r
	348	ASSERT_EFI_ERROR (Status);\r
	349	}\r
	350	\r
	351	return EFI_SUCCESS;\r
	352	}\r
	353	\r
3321fa09	354	/**\r
	355	Allows a program to determine the primary languages that are supported on a given handle.\r
	356	\r
	357	This routine is intended to be used by drivers to query the interface database for supported languages. \r
	358	This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle.\r
	359	\r
	360	@param This A pointer to the EFI_HII_PROTOCOL instance.\r
	361	@param Handle The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() \r
	362	in the Packages section.\r
	363	@param LanguageString A string allocated by GetPrimaryLanguages() that contains a list of all primary languages \r
	364	registered on the handle. The routine will not return the three-spaces language identifier used in \r
	365	other functions to indicate non-language-specific strings.\r
	366	\r
	367	@reval EFI_SUCCESS LanguageString was correctly returned.\r
	368	\r
	369	@reval EFI_INVALID_PARAMETER The Handle was unknown.\r
	370	**/\r
4259256b	371	EFI_STATUS\r
	372	EFIAPI\r
	373	HiiGetPrimaryLanguages (\r
3321fa09	374	IN EFI_HII_PROTOCOL *This,\r
	375	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
	376	OUT EFI_STRING *LanguageString\r
4259256b	377	)\r
4259256b	378	{\r
0368663f	379	HII_THUNK_PRIVATE_DATA *Private;\r
ee3428bb	380	EFI_HII_HANDLE UefiHiiHandle;\r
0368663f	381	CHAR8 *LangCodes3066;\r
	382	CHAR16 *UnicodeLangCodes639;\r
	383	CHAR8 *LangCodes639;\r
	384	EFI_STATUS Status;\r
ee3428bb	385	\r
0368663f	386	Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
ee3428bb	387	\r
0368663f	388	UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle);\r
ee3428bb	389	if (UefiHiiHandle == NULL) {\r
	390	return EFI_INVALID_PARAMETER;\r
	391	}\r
	392	\r
0368663f	393	LangCodes3066 = HiiLibGetSupportedLanguages (UefiHiiHandle);\r
ee3428bb	394	\r
0368663f	395	if (LangCodes3066 == NULL) {\r
ee3428bb	396	return EFI_INVALID_PARAMETER;\r
	397	}\r
	398	\r
0368663f	399	\r
	400	LangCodes639 = NULL;\r
	401	Status = LangCodes3066To639 (LangCodes3066, &LangCodes639);\r
	402	if (EFI_ERROR (Status)) {\r
	403	goto Done;\r
	404	}\r
	405	\r
	406	UnicodeLangCodes639 = AllocateZeroPool (AsciiStrSize (LangCodes639) * sizeof (CHAR16));\r
	407	if (UnicodeLangCodes639 == NULL) {\r
	408	Status = EFI_OUT_OF_RESOURCES;\r
	409	goto Done;\r
ee3428bb	410	}\r
	411	\r
	412	//\r
0368663f	413	// The language returned is in RFC 639-2 format.\r
ee3428bb	414	//\r
0368663f	415	AsciiStrToUnicodeStr (LangCodes639, UnicodeLangCodes639);\r
0368663f	416	*LanguageString = UnicodeLangCodes639;\r
ee3428bb	417	\r
0368663f	418	Done:\r
0368663f	419	FreePool (LangCodes3066);\r
7001eaf8	420	if (LangCodes639 != NULL) {\r
	421	FreePool (LangCodes639);\r
	422	}\r
0368663f	423	\r
0368663f	424	return Status;\r
4259256b	425	}\r
4259256b	426	\r
0368663f	427	\r
3321fa09	428	/**\r
3321fa09	429	Allows a program to determine which secondary languages are supported on a given handle for a given primary language\r
0368663f	430	\r
3321fa09	431	This routine is intended to be used by drivers to query the interface database for supported languages. \r
	432	This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle.\r
	433	\r
	434	@param This A pointer to the EFI_HII_PROTOCOL instance.\r
	435	@param Handle The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() \r
	436	in the Packages section.\r
	437	@param PrimaryLanguage Pointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating \r
	438	the primary language.\r
	439	@param LanguageString A string allocated by GetSecondaryLanguages() containing a list of all secondary languages registered \r
	440	on the handle. The routine will not return the three-spaces language identifier used in other functions \r
	441	to indicate non-language-specific strings, nor will it return the primary language. This function succeeds \r
	442	but returns a NULL LanguageString if there are no secondary languages associated with the input Handle and \r
	443	PrimaryLanguage pair. Type EFI_STRING is defined in String.\r
	444	\r
	445	@reval EFI_SUCCESS LanguageString was correctly returned.\r
	446	@reval EFI_INVALID_PARAMETER The Handle was unknown.\r
	447	**/\r
4259256b	448	EFI_STATUS\r
	449	EFIAPI\r
	450	HiiGetSecondaryLanguages (\r
0368663f	451	IN EFI_HII_PROTOCOL *This,\r
	452	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
	453	IN CHAR16 *PrimaryLanguage,\r
	454	OUT EFI_STRING *LanguageString\r
4259256b	455	)\r
4259256b	456	{\r
0368663f	457	HII_THUNK_PRIVATE_DATA *Private;\r
ee3428bb	458	EFI_HII_HANDLE UefiHiiHandle;\r
0368663f	459	CHAR8 PrimaryLang3066[RFC_3066_ENTRY_SIZE];\r
	460	CHAR8 *PrimaryLang639;\r
	461	CHAR8 *SecLangCodes3066;\r
	462	CHAR8 *SecLangCodes639;\r
	463	CHAR16 *UnicodeSecLangCodes639;\r
	464	EFI_STATUS Status;\r
ee3428bb	465	\r
0368663f	466	Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
ee3428bb	467	\r
0368663f	468	SecLangCodes639 = NULL;\r
	469	SecLangCodes3066 = NULL;\r
	470	UnicodeSecLangCodes639 = NULL;\r
	471	\r
	472	UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle);\r
ee3428bb	473	if (UefiHiiHandle == NULL) {\r
	474	return EFI_INVALID_PARAMETER;\r
	475	}\r
	476	\r
0368663f	477	PrimaryLang639 = AllocateZeroPool (StrLen (PrimaryLanguage) + 1);\r
	478	if (PrimaryLang639 == NULL) {\r
	479	Status = EFI_OUT_OF_RESOURCES;\r
	480	goto Done;\r
	481	}\r
ee3428bb	482	\r
0368663f	483	UnicodeStrToAsciiStr (PrimaryLanguage, PrimaryLang639);\r
ee3428bb	484	\r
0368663f	485	Status = ConvertIso639LanguageToRfc3066Language (PrimaryLang639, PrimaryLang3066);\r
0368663f	486	ASSERT_EFI_ERROR (Status);\r
ee3428bb	487	\r
0368663f	488	SecLangCodes3066 = HiiLibGetSupportedSecondaryLanguages (UefiHiiHandle, PrimaryLang3066);\r
	489	\r
	490	if (SecLangCodes3066 == NULL) {\r
	491	Status = EFI_INVALID_PARAMETER;\r
	492	goto Done;\r
ee3428bb	493	}\r
ee3428bb	494	\r
0368663f	495	Status = LangCodes3066To639 (SecLangCodes3066, &SecLangCodes639);\r
	496	if (EFI_ERROR (Status)) {\r
	497	goto Done;\r
	498	}\r
	499	\r
	500	UnicodeSecLangCodes639 = AllocateZeroPool (AsciiStrSize (SecLangCodes639) * sizeof (CHAR16));\r
	501	if (UnicodeSecLangCodes639 == NULL) {\r
	502	Status = EFI_OUT_OF_RESOURCES;\r
	503	goto Done;\r
ee3428bb	504	}\r
	505	\r
	506	//\r
	507	// The language returned is in RFC 3066 format.\r
	508	//\r
0368663f	509	*LanguageString = AsciiStrToUnicodeStr (SecLangCodes639, UnicodeSecLangCodes639);\r
ee3428bb	510	\r
0368663f	511	Done:\r
7001eaf8	512	if (PrimaryLang639 != NULL) {\r
	513	FreePool (PrimaryLang639);\r
	514	}\r
	515	if (SecLangCodes639 != NULL) {\r
	516	FreePool (SecLangCodes639);\r
	517	}\r
	518	if (SecLangCodes3066 != NULL) {\r
	519	FreePool (SecLangCodes3066);\r
	520	}\r
	521	if (UnicodeSecLangCodes639 != NULL) {\r
	522	FreePool (UnicodeSecLangCodes639);\r
	523	}\r
0368663f	524	\r
0368663f	525	return Status;\r
137c54ac	526	}\r
4259256b	527	\r
0368663f	528	\r