Update all files to follow doxygen style file header.

[mirror_edk2.git] / MdeModulePkg / Library / ExtendedHiiLib / ExtendedHiiLib.c

/** @file\r
  HII Library implementation that uses DXE protocols and services.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\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
\r
#include <PiDxe.h>\r
\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <MdeModuleHii.h>\r
\r
\r
//\r
// Hii vendor device path template\r
//\r
HII_VENDOR_DEVICE_PATH  mHiiVendorDevicePathTemplate = {\r
  {\r
    {\r
      {\r
        HARDWARE_DEVICE_PATH,\r
        HW_VENDOR_DP,\r
        {\r
          (UINT8) (sizeof (HII_VENDOR_DEVICE_PATH_NODE)),\r
          (UINT8) ((sizeof (HII_VENDOR_DEVICE_PATH_NODE)) >> 8)\r
        }\r
      },\r
      EFI_IFR_TIANO_GUID\r
    },\r
    0\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    { \r
      END_DEVICE_PATH_LENGTH\r
    }\r
  }\r
};\r
\r
\r
EFI_STATUS\r
EFIAPI\r
HiiLibCreateHiiDriverHandle (\r
  OUT EFI_HANDLE               *DriverHandle\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  HII_VENDOR_DEVICE_PATH_NODE  *VendorDevicePath;\r
  UINT64                       MonotonicCount;\r
\r
  VendorDevicePath = AllocateCopyPool (sizeof (HII_VENDOR_DEVICE_PATH), &mHiiVendorDevicePathTemplate);\r
  if (VendorDevicePath == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  gBS->GetNextMonotonicCount (&MonotonicCount);\r
  VendorDevicePath->MonotonicCount = (UINT32) MonotonicCount;\r
\r
  *DriverHandle = NULL;\r
  Status = gBS->InstallProtocolInterface (\r
                  DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  VendorDevicePath\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
VOID\r
EFIAPI\r
HiiLibDestroyHiiDriverHandle (\r
  IN EFI_HANDLE               DriverHandle\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_DEVICE_PATH_PROTOCOL     *DevicePath;\r
\r
  Status = gBS->HandleProtocol (\r
                  DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &DevicePath\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->UninstallProtocolInterface (\r
                  DriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  DevicePath\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  FreePool (DevicePath);\r
\r
}\r
\r
\r
\r