MdePkg/Library/HiiLib/InternalHiiLib.h

   1 /** @file
   2   Internal include file for the HII Library instance.
   3
   4   Copyright (c) 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __INTERNAL_HII_LIB_H__
  16 #define __INTERNAL_HII_LIB_H__
  17
  18 #include <Uefi.h>
  19
  20 #include <Protocol/HiiDatabase.h>
  21 #include <Protocol/HiiString.h>
  22 #include <Protocol/DevicePath.h>
  23
  24 #include <Guid/GlobalVariable.h>
  25
  26 #include <Library/BaseLib.h>
  27 #include <Library/BaseMemoryLib.h>
  28 #include <Library/HiiLib.h>
  29 #include <Library/DebugLib.h>
  30 #include <Library/MemoryAllocationLib.h>
  31 #include <Library/UefiBootServicesTableLib.h>
  32 #include <Library/UefiRuntimeServicesTableLib.h>
  33 #include <Library/PcdLib.h>
  34 #include <Library/DevicePathLib.h>
  35
  36 #define HII_LIB_DEFAULT_STRING_SIZE     0x200
  37
  38
  39 extern CONST EFI_HII_DATABASE_PROTOCOL         *mHiiDatabaseProt;
  40 extern CONST EFI_HII_STRING_PROTOCOL           *mHiiStringProt;
  41
  42 /**
  43   This function check if the Hii Handle is a valid handle registered
  44   in the HII database.
  45
  46   @param HiiHandle The HII Handle.
  47
  48   @retval TRUE If it is a valid HII handle.
  49   @retval FALSE If it is a invalid HII handle.
  50 **/
  51 BOOLEAN
  52 IsHiiHandleRegistered (
  53   EFI_HII_HANDLE    HiiHandle
  54   );
  55
  56 /**
  57
  58   This function locate Hii relative protocols for later usage.
  59
  60 **/
  61 VOID
  62 LocateHiiProtocols (
  63   VOID
  64   );
  65
  66 #endif