2 HII Library implementation that uses DXE protocols and services.
4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
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
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.
18 #include <Protocol/DevicePath.h>
20 #include <Library/BaseMemoryLib.h>
21 #include <Library/DebugLib.h>
22 #include <Library/MemoryAllocationLib.h>
23 #include <Library/UefiBootServicesTableLib.h>
24 #include <MdeModuleHii.h>
28 // Hii vendor device path template
30 GLOBAL_REMOVE_IF_UNREFERENCED CONST HII_VENDOR_DEVICE_PATH mHiiVendorDevicePathTemplate
= {
37 (UINT8
) (sizeof (HII_VENDOR_DEVICE_PATH_NODE
)),
38 (UINT8
) ((sizeof (HII_VENDOR_DEVICE_PATH_NODE
)) >> 8)
48 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
50 END_DEVICE_PATH_LENGTH
56 The HII driver handle passed in for HiiDatabase.NewPackageList() requires
57 that there should be DevicePath Protocol installed on it.
58 This routine create a virtual Driver Handle by installing a vendor device
59 path on it, so as to use it to invoke HiiDatabase.NewPackageList().
60 The Device Path created is a Vendor Device Path specific to Intel's implemenation
61 and it is defined as HII_VENDOR_DEVICE_PATH_NODE.
64 @param DriverHandle Handle to be returned
66 @retval EFI_SUCCESS Handle destroy success.
67 @retval EFI_OUT_OF_RESOURCES Not enough memory.
72 HiiLibCreateHiiDriverHandle (
73 OUT EFI_HANDLE
*DriverHandle
77 HII_VENDOR_DEVICE_PATH_NODE
*VendorDevicePath
;
79 VendorDevicePath
= AllocateCopyPool (sizeof (HII_VENDOR_DEVICE_PATH
), &mHiiVendorDevicePathTemplate
);
80 if (VendorDevicePath
== NULL
) {
81 return EFI_OUT_OF_RESOURCES
;
85 // Use memory address as unique ID to distinguish from different device paths
87 VendorDevicePath
->UniqueId
= (UINT64
) ((UINTN
) VendorDevicePath
);
90 Status
= gBS
->InstallMultipleProtocolInterfaces (
92 &gEfiDevicePathProtocolGuid
,
96 if (EFI_ERROR (Status
)) {
105 Destroy the Driver Handle created by CreateHiiDriverHandle().
107 If no Device Path protocol is installed on the DriverHandle, then ASSERT.
108 If this Device Path protocol is failed to be uninstalled, then ASSERT.
110 @param DriverHandle Handle returned by CreateHiiDriverHandle()
116 HiiLibDestroyHiiDriverHandle (
117 IN EFI_HANDLE DriverHandle
121 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
123 Status
= gBS
->HandleProtocol (
125 &gEfiDevicePathProtocolGuid
,
126 (VOID
**) &DevicePath
128 ASSERT_EFI_ERROR (Status
);
130 Status
= gBS
->UninstallProtocolInterface (
132 &gEfiDevicePathProtocolGuid
,
135 ASSERT_EFI_ERROR (Status
);
137 FreePool (DevicePath
);