MdeModulePkg/Include/Library/ExtendedHiiLib.h

   1 /** @file
   2   This library includes two extended HII functions to
   3   create and destory Hii Package by create the virtual Driver Handle.
   4
   5 Copyright (c) 2008, Intel Corporation. <BR>
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __EXTENDED_HII_LIB_H__
  17 #define __EXTENDED_HII_LIB_H__
  18
  19 /**
  20   The HII driver handle passed in for HiiDatabase.NewPackageList() requires
  21   that there should be DevicePath Protocol installed on it.
  22   This routine create a virtual Driver Handle by installing a vendor device
  23   path on it, so as to use it to invoke HiiDatabase.NewPackageList().
  24   The Device Path created is a Vendor Device Path specific to Intel's implemenation
  25   and it is defined as HII_VENDOR_DEVICE_PATH_NODE.
  26
  27
  28   @param  DriverHandle           Handle to be returned
  29
  30   @retval EFI_SUCCESS            Handle destroy success.
  31   @retval EFI_OUT_OF_RESOURCES   Not enough memory.
  32
  33 **/
  34 EFI_STATUS
  35 EFIAPI
  36 HiiLibCreateHiiDriverHandle (
  37   OUT EFI_HANDLE               *DriverHandle
  38   );
  39
  40 /**
  41   Destroy the Driver Handle created by CreateHiiDriverHandle().
  42
  43   If no Device Path protocol is installed on the DriverHandle, then ASSERT.
  44   If this Device Path protocol is failed to be uninstalled, then ASSERT.
  45
  46   @param  DriverHandle           Handle returned by CreateHiiDriverHandle()
  47
  48
  49 **/
  50 VOID
  51 EFIAPI
  52 HiiLibDestroyHiiDriverHandle (
  53   IN EFI_HANDLE                 DriverHandle
  54   );
  55
  56
  57 #endif