IntelFrameworkModulePkg/Universal/BdsDxe/Bds.h

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