Add in supports for platform Setup module which is programmed using Framework HII...

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / Utility.h

/**@file\r
\r
  This file contains utility functions by HII Thunk Modules.\r
  \r
Copyright (c) 2006 - 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
#ifndef _HII_THUNK_UTILITY_H\r
#define _HII_THUNK_UTILITY_H\r
\r
EFI_GUID *\r
GetGuidOfFirstFormset (\r
  CONST EFI_HII_FORM_PACKAGE * FormPackage\r
);\r
\r
/**\r
  Find the UefiHiiHandle based on a Framework HII Handle returned by\r
  the HII Thunk to Framework HII code.\r
\r
  @param Private                        The pointer to the private data of Hii Thunk.\r
  @param FrameworkHiiHandle     Framework HII Handle returned by  the HII Thunk to Framework HII code.\r
\r
  @retval  NULL                           If Framework HII Handle passed in does not have matching UEFI HII handle.\r
  @retval  !NULL                         If the match is found.\r
  \r
**/\r
EFI_HII_HANDLE\r
FrameworkHiiHandleToUefiHiiHandle (\r
  IN CONST EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FrameworkHiiHandle\r
  )\r
;\r
\r
HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *\r
FrameworkHiiHandleToMapDatabaseEntry (\r
  IN CONST EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FrameworkHiiHandle\r
  )\r
;\r
\r
HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *\r
UefiHiiHandleToMapDatabaseEntry (\r
  IN CONST EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  IN EFI_HII_HANDLE                   UefiHiiHandle\r
  )\r
;\r
\r
EFI_HII_HANDLE *\r
TagGuidToUefiIfrHiiHandle (\r
  IN CONST EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  IN CONST EFI_GUID                   *Guid\r
  )\r
;\r
\r
EFI_STATUS\r
AssignHiiHandle (\r
  IN OUT EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  OUT    FRAMEWORK_EFI_HII_HANDLE   *Handle\r
  )\r
;\r
\r
EFI_STATUS\r
AssignPureUefiHiiHandle (\r
  IN OUT EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  OUT    FRAMEWORK_EFI_HII_HANDLE   *Handle\r
  )\r
;\r
#endif\r