UEFI HII: Merge UEFI HII support changes from branch.

[mirror_edk2.git] / MdePkg / Include / Library / HiiLib.h

/** @file\r
  Public include file for the HII Library\r
\r
  Copyright (c) 2006, 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_LIB_H__\r
#define __HII_LIB_H__\r
\r
//#include <PiDxe.h>\r
\r
//\r
// Limited buffer size recommended by RFC4646 (4.3.  Length Considerations)\r
// (42 characters plus a NULL terminator)\r
//\r
#define RFC_3066_ENTRY_SIZE             (42 + 1)\r
\r
/**\r
  This function allocates pool for an EFI_HII_PACKAGE_LIST structure\r
  with additional space that is big enough to host all packages described by the variable \r
  argument list of package pointers.  The allocated structure is initialized using NumberOfPackages, \r
  GuidId,  and the variable length argument list of package pointers.\r
\r
  Then, EFI_HII_PACKAGE_LIST will be register to the default System HII Database. The\r
  Handle to the newly registered Package List is returned throught HiiHandle.\r
\r
  @param  NumberOfPackages  The number of HII packages to register.\r
  @param  GuidId                    Package List GUID ID.\r
  @param  HiiHandle                The ID used to retrieve the Package List later.\r
  @param  ...                          The variable argument list describing all HII Package.\r
\r
  @return\r
  The allocated and initialized packages.\r
\r
**/\r
\r
EFI_STATUS\r
EFIAPI\r
HiiLibAddPackagesToHiiDatabase (\r
  IN       UINTN               NumberOfPackages,\r
  IN CONST EFI_GUID            *GuidId,\r
  IN       EFI_HANDLE          DriverHandle, OPTIONAL\r
  OUT      EFI_HII_HANDLE      *HiiHandle, OPTIONAL\r
  ...\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiLibAddFontPackageToHiiDatabase (\r
  IN       UINTN               FontSize,\r
  IN CONST UINT8               *FontBinary,\r
  IN CONST EFI_GUID            *GuidId,\r
  OUT      EFI_HII_HANDLE      *HiiHandle OPTIONAL\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiLibRemovePackagesFromHiiDatabase (\r
  IN      EFI_HII_HANDLE      HiiHandle\r
  )\r
;\r
\r
/**\r
  This function adds the string into String Package of each language.\r
\r
  @param  PackageList            Handle of the package list where this string will\r
                                 be added.\r
  @param  StringId               On return, contains the new strings id, which is\r
                                 unique within PackageList.\r
  @param  String                 Points to the new null-terminated string.\r
\r
  @retval EFI_SUCCESS            The new string was added successfully.\r
  @retval EFI_NOT_FOUND          The specified PackageList could not be found in\r
                                 database.\r
  @retval EFI_OUT_OF_RESOURCES   Could not add the string due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER  String is NULL or StringId is NULL is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibCreateString (\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  OUT EFI_STRING_ID                   *StringId,\r
  IN  CONST EFI_STRING                String\r
  )\r
;\r
\r
/**\r
  This function update the specified string in String Package of each language.\r
\r
  @param  PackageList            Handle of the package list where this string will\r
                                 be added.\r
  @param  StringId               Ths String Id to be updated.\r
  @param  String                 Points to the new null-terminated string.\r
\r
  @retval EFI_SUCCESS            The new string was added successfully.\r
  @retval EFI_NOT_FOUND          The specified PackageList could not be found in\r
                                 database.\r
  @retval EFI_OUT_OF_RESOURCES   Could not add the string due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER  String is NULL or StringId is NULL is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibUpdateString (\r
  IN  EFI_HII_HANDLE                  PackageList,\r
  IN  EFI_STRING_ID                   StringId,\r
  IN  CONST EFI_STRING                String\r
  )\r
;\r
\r
\r
\r
//\r
// Just use the UEFI prototype\r
//\r
EFI_STATUS\r
EFIAPI\r
HiiLibGetStringFromGuidId (\r
  IN  EFI_GUID                        *ProducerGuid,\r
  IN  EFI_STRING_ID                   StringId,\r
  OUT EFI_STRING                      *String\r
  )\r
;\r
\r
//\r
// This function is Implementation Specifc. HII_VENDOR_DEVICE_PATH\r
// This should be moved to MdeModulepkg.\r
//\r
EFI_STATUS\r
EFIAPI\r
HiiLibCreateHiiDriverHandle (\r
  OUT EFI_HANDLE               *DriverHandle\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiLibDestroyHiiDriverHandle (\r
  IN EFI_HANDLE                 DriverHandle\r
  )\r
;\r
\r
\r
EFI_STATUS\r
HiiLibExtractClassFromHiiHandle (\r
  IN      EFI_HII_HANDLE      Handle,\r
  OUT     UINT16              *Class,\r
  OUT     EFI_STRING_ID       *FormSetTitle,\r
  OUT     EFI_STRING_ID       *FormSetHelp\r
  )\r
/*++\r
\r
Routine Description:\r
  Extract formset class for given HII handle.\r
\r
Arguments:\r
  HiiHandle       - Hii handle\r
  Class           - Class of the formset\r
  FormSetTitle    - Formset title string\r
  FormSetHelp     - Formset help string\r
\r
Returns:\r
  EFI_SUCCESS     - Successfully extract Class for specified Hii handle.\r
\r
--*/\r
;\r
\r
#endif\r