IntelFrameworkModulePkg/Universal/BdsDxe/Bds.h

   1 /** @file
   2   Head file for BDS Architectural Protocol implementation
   3
   4 Copyright (c) 2004 - 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
   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 _BDS_MODULE_H_
  16 #define _BDS_MODULE_H_
  17
  18 #include <PiDxe.h>
  19 #include <IndustryStandard/PeImage.h>
  20 #include <Guid/MdeModuleHii.h>
  21 #include <Guid/FileSystemVolumeLabelInfo.h>
  22 #include <Protocol/DevicePath.h>
  23 #include <Guid/DataHubRecords.h>
  24 #include <Protocol/LoadFile.h>
  25 #include <Protocol/CpuIo.h>
  26 #include <Guid/FileInfo.h>
  27 #include <Protocol/HiiConfigRouting.h>
  28 #include <Protocol/Bds.h>
  29 #include <Protocol/DataHub.h>
  30 #include <Protocol/UgaDraw.h>
  31 #include <Protocol/BlockIo.h>
  32 #include <Guid/GlobalVariable.h>
  33 #include <Guid/CapsuleVendor.h>
  34 #include <Protocol/GenericMemoryTest.h>
  35 #include <Protocol/FormBrowser2.h>
  36 #include <Protocol/HiiConfigAccess.h>
  37 #include <Protocol/GraphicsOutput.h>
  38 #include <Protocol/SimpleFileSystem.h>
  39 #include <Protocol/HiiDatabase.h>
  40 #include <Protocol/HiiString.h>
  41 #include <Protocol/SerialIo.h>
  42 #include <Protocol/LegacyBios.h>
  43 #include <Protocol/SimpleTextInEx.h>
  44
  45 #include <Library/UefiDriverEntryPoint.h>
  46 #include <Library/PrintLib.h>
  47 #include <Library/DebugLib.h>
  48 #include <Library/BaseMemoryLib.h>
  49 #include <Library/UefiBootServicesTableLib.h>
  50 #include <Library/UefiLib.h>
  51 #include <Library/MemoryAllocationLib.h>
  52 #include <Library/PerformanceLib.h>
  53 #include <Library/ReportStatusCodeLib.h>
  54 #include <Library/UefiRuntimeServicesTableLib.h>
  55 #include <Library/HobLib.h>
  56 #include <Library/BaseLib.h>
  57 #include <Library/DevicePathLib.h>
  58 #include <Library/PcdLib.h>
  59 #include <Library/CapsuleLib.h>
  60 #include <Library/HiiLib.h>
  61 #include <Library/DevicePathLib.h>
  62 #include <Library/PcdLib.h>
  63
  64 #include <Library/GenericBdsLib.h>
  65 #include <Library/PlatformBdsLib.h>
  66
  67 #define EFI_BDS_ARCH_PROTOCOL_INSTANCE_FROM_THIS(_this) \
  68   CR ((_this),                                          \
  69       EFI_BDS_ARCH_PROTOCOL_INSTANCE,                   \
  70       Bds,                                              \
  71       EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE          \
  72       )
  73
  74 #pragma pack(1)
  75
  76 ///
  77 /// HII specific Vendor Device Path definition.
  78 ///
  79 typedef struct {
  80   VENDOR_DEVICE_PATH             VendorDevicePath;
  81   EFI_DEVICE_PATH_PROTOCOL       End;
  82 } HII_VENDOR_DEVICE_PATH;
  83
  84 #pragma pack()
  85
  86 /**
  87
  88   Show progress bar with title above it. It only works in Graphics mode.
  89
  90   @param TitleForeground Foreground color for Title.
  91   @param TitleBackground Background color for Title.
  92   @param Title           Title above progress bar.
  93   @param ProgressColor   Progress bar color.
  94   @param Progress        Progress (0-100)
  95   @param PreviousValue   The previous value of the progress.
  96
  97   @retval  EFI_STATUS       Success update the progress bar
  98
  99 **/
 100 EFI_STATUS
 101 PlatformBdsShowProgress (
 102   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
 103   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
 104   IN CHAR16                        *Title,
 105   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
 106   IN UINTN                         Progress,
 107   IN UINTN                         PreviousValue
 108   );
 109
 110 //
 111 // Prototypes
 112 //
 113
 114 /**
 115
 116   Install Boot Device Selection Protocol
 117
 118   @param ImageHandle     The image handle.
 119   @param SystemTable     The system table.
 120
 121   @retval  EFI_SUCEESS  BDS has finished initializing.
 122                         Return the dispatcher and recall BDS.Entry
 123   @retval  Other        Return status from AllocatePool() or gBS->InstallProtocolInterface
 124
 125 **/
 126 EFI_STATUS
 127 EFIAPI
 128 BdsInitialize (
 129   IN EFI_HANDLE                     ImageHandle,
 130   IN EFI_SYSTEM_TABLE               *SystemTable
 131   );
 132
 133 /**
 134
 135   Service routine for BdsInstance->Entry(). Devices are connected, the
 136   consoles are initialized, and the boot options are tried.
 137
 138   @param This            Protocol Instance structure.
 139
 140 **/
 141 VOID
 142 EFIAPI
 143 BdsEntry (
 144   IN  EFI_BDS_ARCH_PROTOCOL *This
 145   );
 146
 147 #endif