HII Library Class interface refine.

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiOnUefiHiiThunk / 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
/**\r
  \r
  This function returns a list of the package handles of the   \r
  specified type that are currently active in the HII database. The   \r
  pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package   \r
  handles to be listed.\r
\r
  If HandleBufferLength is NULL, then ASSERT.\r
  If HandleBuffer is NULL, the ASSERT.\r
  If PackageType is EFI_HII_PACKAGE_TYPE_GUID and PackageGuid is\r
  NULL, then ASSERT.\r
  If PackageType is not EFI_HII_PACKAGE_TYPE_GUID and PackageGuid is not\r
  NULL, then ASSERT.\r
  \r
  \r
  @param PackageType          Specifies the package type of the packages\r
                              to list or EFI_HII_PACKAGE_TYPE_ALL for\r
                              all packages to be listed.\r
  \r
  @param PackageGuid          If PackageType is\r
                              EFI_HII_PACKAGE_TYPE_GUID, then this is\r
                              the pointer to the GUID which must match\r
                              the Guid field of\r
                              EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it\r
                              must be NULL.\r
  \r
  @param HandleBufferLength   On output, the length of the handle buffer\r
                              that is required for the handles found.\r
\r
  @param HandleBuffer         On output, an array of EFI_HII_HANDLE  instances returned.\r
                              The caller is responcible to free this pointer allocated.\r
\r
  @retval EFI_SUCCESS           The matching handles are outputed successfully.\r
                                HandleBufferLength is updated with the actual length.\r
  @retval EFI_OUT_OF_RESOURCES  Not enough resource to complete the operation.\r
  @retval EFI_NOT_FOUND         No matching handle could not be found in database.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ListPackageLists (\r
  IN        UINT8                     PackageType,\r
  IN CONST  EFI_GUID                  *PackageGuid,\r
  IN OUT    UINTN                     *HandleBufferLength,\r
  OUT       EFI_HII_HANDLE            **HandleBuffer\r
  )\r
;\r
\r
/**\r
  Exports the contents of one or all package lists in the HII database into a buffer.\r
\r
  If Handle is not NULL and not a valid EFI_HII_HANDLE registered in the database, \r
  then ASSERT.\r
  If PackageListHeader is NULL, then ASSERT.\r
  If PackageListSize is NULL, then ASSERT.\r
\r
  @param  Handle                 The HII Handle.\r
  @param  PackageListHeader      A pointer to a buffer that will contain the results of \r
                                 the export function.\r
  @param  PackageListSize        On output, the length of the buffer that is required for the exported data.\r
\r
  @retval EFI_SUCCESS            Package exported.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Not enought memory to complete the operations.\r
\r
**/\r
EFI_STATUS \r
EFIAPI\r
ExportPackageLists (\r
  IN EFI_HII_HANDLE                    Handle,\r
  OUT EFI_HII_PACKAGE_LIST_HEADER      **PackageListHeader,\r
  OUT UINTN                            *PackageListSize\r
  )\r
;\r
\r
/**\r
  Extract Hii package list GUID for given HII handle.\r
\r
  If HiiHandle could not be found in the HII database, then ASSERT.\r
  If Guid is NULL, then ASSERT.\r
\r
  @param  Handle              Hii handle\r
  @param  Guid                Package list GUID\r
\r
  @retval EFI_SUCCESS            Successfully extract GUID from Hii database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ExtractGuidFromHiiHandle (\r
  IN      EFI_HII_HANDLE      Handle,\r
  OUT     EFI_GUID            *Guid\r
  )\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 FwHiiHandle     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
FwHiiHandleToUefiHiiHandle (\r
  IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FwHiiHandle\r
  );\r
\r
HII_THUNK_CONTEXT *\r
FwHiiHandleToThunkContext (\r
  IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FwHiiHandle\r
  );\r
\r
HII_THUNK_CONTEXT *\r
UefiHiiHandleToThunkContext (\r
  IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
  IN EFI_HII_HANDLE                   UefiHiiHandle\r
  );\r
\r
HII_THUNK_CONTEXT *\r
TagGuidToIfrPackThunkContext (\r
  IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
  IN CONST EFI_GUID                   *Guid\r
  );\r
\r
HII_THUNK_CONTEXT *\r
CreateThunkContextForUefiHiiHandle (\r
  IN  EFI_HII_HANDLE             UefiHiiHandle\r
 );\r
\r
VOID\r
DestroyThunkContextForUefiHiiHandle (\r
  IN HII_THUNK_PRIVATE_DATA     *Private,\r
  IN EFI_HII_HANDLE             UefiHiiHandle\r
 );\r
\r
UINTN\r
GetPackageCountByType (\r
  IN CONST EFI_HII_PACKAGE_LIST_HEADER     *PackageListHeader,\r
  IN       UINT8                           PackageType\r
  );\r
\r
EFI_STATUS\r
CreateQuestionIdMap (\r
  IN    OUT HII_THUNK_CONTEXT  *ThunkContext\r
  );\r
\r
VOID\r
GetAttributesOfFirstFormSet (\r
  IN    OUT HII_THUNK_CONTEXT  *ThunkContext\r
  );\r
\r
LIST_ENTRY *\r
GetMapEntryListHead (\r
  IN CONST HII_THUNK_CONTEXT  *ThunkContext,\r
  IN       UINT16             VarStoreId\r
  );\r
\r
HII_THUNK_CONTEXT *\r
CreateThunkContext (\r
  IN  HII_THUNK_PRIVATE_DATA      *Private,\r
  IN  UINTN                       StringPackageCount,\r
  IN  UINTN                       IfrPackageCount\r
  );\r
\r
VOID\r
DestroyThunkContext (\r
  IN HII_THUNK_CONTEXT          *ThunkContext\r
  );\r
\r
VOID\r
DestoryOneOfOptionMap (\r
  IN LIST_ENTRY     *OneOfOptionMapListHead\r
  );\r
\r
VOID\r
GetFormSetGuid (\r
  IN  EFI_HII_PACKAGE_HEADER  *Package,\r
  OUT EFI_GUID                *FormSetGuid\r
  )\r
;\r
\r
EFI_HII_PACKAGE_HEADER *\r
GetIfrPackage (\r
  IN CONST EFI_HII_PACKAGES               *Packages\r
  )\r
;\r
\r
FORM_BROWSER_FORMSET *\r
ParseFormSet (\r
  IN EFI_HII_HANDLE   UefiHiiHandle\r
  )\r
;\r
\r
#endif\r