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 <FrameworkDxe.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 <Guid/StatusCodeDataTypeId.h>
  35 #include <Protocol/GenericMemoryTest.h>
  36 #include <Protocol/FormBrowser2.h>
  37 #include <Protocol/HiiConfigAccess.h>
  38 #include <Protocol/GraphicsOutput.h>
  39 #include <Protocol/SimpleFileSystem.h>
  40 #include <Protocol/HiiDatabase.h>
  41 #include <Protocol/HiiString.h>
  42 #include <Protocol/SerialIo.h>
  43 #include <Protocol/LegacyBios.h>
  44 #include <Protocol/SimpleTextInEx.h>
  45
  46 #include <Library/UefiDriverEntryPoint.h>
  47 #include <Library/PrintLib.h>
  48 #include <Library/DebugLib.h>
  49 #include <Library/BaseMemoryLib.h>
  50 #include <Library/UefiBootServicesTableLib.h>
  51 #include <Library/UefiLib.h>
  52 #include <Library/MemoryAllocationLib.h>
  53 #include <Library/PerformanceLib.h>
  54 #include <Library/ReportStatusCodeLib.h>
  55 #include <Library/UefiRuntimeServicesTableLib.h>
  56 #include <Library/HobLib.h>
  57 #include <Library/BaseLib.h>
  58 #include <Library/DevicePathLib.h>
  59 #include <Library/PcdLib.h>
  60 #include <Library/CapsuleLib.h>
  61 #include <Library/HiiLib.h>
  62 #include <Library/DevicePathLib.h>
  63 #include <Library/PcdLib.h>
  64
  65 #include <Library/GenericBdsLib.h>
  66 #include <Library/PlatformBdsLib.h>
  67
  68 #pragma pack(1)
  69
  70 ///
  71 /// HII specific Vendor Device Path definition.
  72 ///
  73 typedef struct {
  74   VENDOR_DEVICE_PATH             VendorDevicePath;
  75   EFI_DEVICE_PATH_PROTOCOL       End;
  76 } HII_VENDOR_DEVICE_PATH;
  77
  78 #pragma pack()
  79
  80 /**
  81
  82   Show progress bar with title above it. It only works in Graphics mode.
  83
  84   @param TitleForeground Foreground color for Title.
  85   @param TitleBackground Background color for Title.
  86   @param Title           Title above progress bar.
  87   @param ProgressColor   Progress bar color.
  88   @param Progress        Progress (0-100)
  89   @param PreviousValue   The previous value of the progress.
  90
  91   @retval  EFI_STATUS       Success update the progress bar
  92
  93 **/
  94 EFI_STATUS
  95 PlatformBdsShowProgress (
  96   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
  97   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
  98   IN CHAR16                        *Title,
  99   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
 100   IN UINTN                         Progress,
 101   IN UINTN                         PreviousValue
 102   );
 103
 104 //
 105 // Prototypes
 106 //
 107
 108 /**
 109
 110   Install Boot Device Selection Protocol
 111
 112   @param ImageHandle     The image handle.
 113   @param SystemTable     The system table.
 114
 115   @retval  EFI_SUCEESS  BDS has finished initializing.
 116                         Return the dispatcher and recall BDS.Entry
 117   @retval  Other        Return status from AllocatePool() or gBS->InstallProtocolInterface
 118
 119 **/
 120 EFI_STATUS
 121 EFIAPI
 122 BdsInitialize (
 123   IN EFI_HANDLE                     ImageHandle,
 124   IN EFI_SYSTEM_TABLE               *SystemTable
 125   );
 126
 127 /**
 128
 129   Service routine for BdsInstance->Entry(). Devices are connected, the
 130   consoles are initialized, and the boot options are tried.
 131
 132   @param This            Protocol Instance structure.
 133
 134 **/
 135 VOID
 136 EFIAPI
 137 BdsEntry (
 138   IN  EFI_BDS_ARCH_PROTOCOL *This
 139   );
 140
 141
 142 /**
 143   Perform the memory test base on the memory test intensive level,
 144   and update the memory resource.
 145
 146   @param  Level         The memory test intensive level.
 147
 148   @retval EFI_STATUS    Success test all the system memory and update
 149                         the memory resource
 150
 151 **/
 152 EFI_STATUS
 153 BdsMemoryTest (
 154   IN EXTENDMEM_COVERAGE_LEVEL Level
 155   );
 156
 157 /**
 158
 159   This routine is called to see if there are any capsules we need to process.
 160   If the boot mode is not UPDATE, then we do nothing. Otherwise find the
 161   capsule HOBS and produce firmware volumes for them via the DXE service.
 162   Then call the dispatcher to dispatch drivers from them. Finally, check
 163   the status of the updates.
 164
 165   This function should be called by BDS in case we need to do some
 166   sort of processing even if there is no capsule to process. We
 167   need to do this if an earlier update went away and we need to
 168   clear the capsule variable so on the next reset PEI does not see it and
 169   think there is a capsule available.
 170
 171   @param BootMode                 the current boot mode
 172
 173   @retval EFI_INVALID_PARAMETER   boot mode is not correct for an update
 174   @retval EFI_SUCCESS             There is no error when processing capsule
 175
 176 **/
 177 EFI_STATUS
 178 BdsProcessCapsules (
 179   EFI_BOOT_MODE BootMode
 180   );
 181
 182 #endif