Retire Extended HII library class.

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / Bds.h

/** @file\r
  Head file for BDS Architectural Protocol implementation\r
\r
Copyright (c) 2004 - 2008, 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
#ifndef _BDS_MODULE_H_\r
#define _BDS_MODULE_H_\r
\r
#include <PiDxe.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
#include <Guid/FileSystemVolumeLabelInfo.h>\r
#include <Protocol/DevicePath.h>\r
#include <Guid/DataHubRecords.h>\r
#include <Protocol/LoadFile.h>\r
#include <Protocol/CpuIo.h>\r
#include <Guid/FileInfo.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/Bds.h>\r
#include <Protocol/DataHub.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/BlockIo.h>\r
#include <Guid/GlobalVariable.h>\r
#include <Guid/CapsuleVendor.h>\r
#include <Protocol/GenericMemoryTest.h>\r
#include <Protocol/FormBrowser2.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiString.h>\r
#include <Protocol/SerialIo.h>\r
#include <Protocol/LegacyBios.h>\r
#include <Protocol/SimpleTextInEx.h>\r
\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/PrintLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/IfrSupportLib.h>\r
#include <Library/ExtendedIfrSupportLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/CapsuleLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
\r
#include <Library/GenericBdsLib.h>\r
#include <Library/PlatformBdsLib.h>\r
\r
#define EFI_BDS_ARCH_PROTOCOL_INSTANCE_FROM_THIS(_this) \\r
  CR ((_this),                                          \\r
      EFI_BDS_ARCH_PROTOCOL_INSTANCE,                   \\r
      Bds,                                              \\r
      EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE          \\r
      )\r
\r
#pragma pack(1)\r
\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH             VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL       End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
#pragma pack()\r
\r
/**\r
\r
  Show progress bar with title above it. It only works in Graphics mode.\r
\r
  @param TitleForeground Foreground color for Title.\r
  @param TitleBackground Background color for Title.\r
  @param Title           Title above progress bar.\r
  @param ProgressColor   Progress bar color.\r
  @param Progress        Progress (0-100)\r
  @param PreviousValue   The previous value of the progress.\r
\r
  @retval  EFI_STATUS       Success update the progress bar\r
\r
**/\r
EFI_STATUS\r
PlatformBdsShowProgress (\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r
  IN CHAR16                        *Title,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r
  IN UINTN                         Progress,\r
  IN UINTN                         PreviousValue\r
  );\r
\r
//\r
// Prototypes\r
//\r
\r
/**\r
\r
  Install Boot Device Selection Protocol\r
\r
  @param ImageHandle     The image handle.\r
  @param SystemTable     The system table.\r
\r
  @retval  EFI_SUCEESS  BDS has finished initializing.\r
                        Return the dispatcher and recall BDS.Entry\r
  @retval  Other        Return status from AllocatePool() or gBS->InstallProtocolInterface\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BdsInitialize (\r
  IN EFI_HANDLE                     ImageHandle,\r
  IN EFI_SYSTEM_TABLE               *SystemTable\r
  );\r
\r
/**\r
\r
  Service routine for BdsInstance->Entry(). Devices are connected, the\r
  consoles are initialized, and the boot options are tried.\r
\r
  @param This            Protocol Instance structure.\r
\r
**/\r
VOID\r
EFIAPI\r
BdsEntry (\r
  IN  EFI_BDS_ARCH_PROTOCOL *This\r
  );\r
\r
#endif\r