IntelFrameworkModulePkg/Library/GenericBdsLib/InternalBdsLib.h

   1 /** @file
   2   BDS library definition, include the file and data structure
   3
   4 Copyright (c) 2004 - 2013, 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 _INTERNAL_BDS_LIB_H_
  16 #define _INTERNAL_BDS_LIB_H_
  17
  18 #include <FrameworkDxe.h>
  19
  20 #include <IndustryStandard/Pci.h>
  21 #include <IndustryStandard/PeImage.h>
  22
  23 #include <Protocol/BlockIo.h>
  24 #include <Protocol/LoadedImage.h>
  25 #include <Protocol/Cpu.h>
  26 #include <Protocol/SimpleFileSystem.h>
  27 #include <Protocol/LoadFile.h>
  28 #include <Protocol/DebugPort.h>
  29 #include <Protocol/DevicePath.h>
  30 #include <Protocol/SimpleTextIn.h>
  31 #include <Protocol/LegacyBios.h>
  32 #include <Protocol/SimpleTextOut.h>
  33 #include <Protocol/SimpleNetwork.h>
  34 #include <Protocol/FirmwareVolume2.h>
  35 #include <Protocol/PciIo.h>
  36 #include <Protocol/AcpiS3Save.h>
  37 #include <Protocol/OEMBadging.h>
  38 #include <Protocol/GraphicsOutput.h>
  39 #include <Protocol/UgaDraw.h>
  40 #include <Protocol/HiiFont.h>
  41 #include <Protocol/HiiImage.h>
  42 #include <Protocol/UsbIo.h>
  43 #include <Protocol/BootLogo.h>
  44
  45 #include <Guid/MemoryTypeInformation.h>
  46 #include <Guid/FileInfo.h>
  47 #include <Guid/GlobalVariable.h>
  48 #include <Guid/PcAnsi.h>
  49 #include <Guid/Performance.h>
  50 #include <Guid/BdsLibHii.h>
  51 #include <Guid/HdBootVariable.h>
  52 #include <Guid/LastEnumLang.h>
  53 #include <Guid/LegacyDevOrder.h>
  54
  55 #include <Library/PrintLib.h>
  56 #include <Library/DebugLib.h>
  57 #include <Library/BaseMemoryLib.h>
  58 #include <Library/UefiBootServicesTableLib.h>
  59 #include <Library/UefiLib.h>
  60 #include <Library/MemoryAllocationLib.h>
  61 #include <Library/DxeServicesTableLib.h>
  62 #include <Library/UefiRuntimeServicesTableLib.h>
  63 #include <Library/HobLib.h>
  64 #include <Library/BaseLib.h>
  65 #include <Library/DevicePathLib.h>
  66 #include <Library/PerformanceLib.h>
  67 #include <Library/PcdLib.h>
  68 #include <Library/PeCoffGetEntryPointLib.h>
  69 #include <Library/GenericBdsLib.h>
  70 #include <Library/TimerLib.h>
  71 #include <Library/PcdLib.h>
  72 #include <Library/DxeServicesLib.h>
  73 #include <Library/ReportStatusCodeLib.h>
  74
  75 #if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)
  76     #if defined (MDE_CPU_EBC)
  77         //
  78         // Uefi specification only defines the default boot file name for IA32, X64
  79         // and IPF processor, so need define boot file name for EBC architecture here.
  80         //
  81         #define EFI_REMOVABLE_MEDIA_FILE_NAME L"\\EFI\\BOOT\\BOOTEBC.EFI"
  82     #else
  83         #error "Can not determine the default boot file name for unknown processor type!"
  84     #endif
  85 #endif
  86
  87 /**
  88
  89   Writes performance data of booting into the allocated memory.
  90   OS can process these records.
  91
  92   @param  Event                 The triggered event.
  93   @param  Context               Context for this event.
  94
  95 **/
  96 VOID
  97 EFIAPI
  98 WriteBootToOsPerformanceData (
  99   IN EFI_EVENT  Event,
 100   IN VOID       *Context
 101   );
 102
 103 /**
 104   Get the headers (dos, image, optional header) from an image
 105
 106   @param  Device                SimpleFileSystem device handle
 107   @param  FileName              File name for the image
 108   @param  DosHeader             Pointer to dos header
 109   @param  Hdr                   The buffer in which to return the PE32, PE32+, or TE header.
 110
 111   @retval EFI_SUCCESS           Successfully get the machine type.
 112   @retval EFI_NOT_FOUND         The file is not found.
 113   @retval EFI_LOAD_ERROR        File is not a valid image file.
 114
 115 **/
 116 EFI_STATUS
 117 EFIAPI
 118 BdsLibGetImageHeader (
 119   IN  EFI_HANDLE                  Device,
 120   IN  CHAR16                      *FileName,
 121   OUT EFI_IMAGE_DOS_HEADER        *DosHeader,
 122   OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION   Hdr
 123   );
 124
 125 /**
 126   This routine adjust the memory information for different memory type and
 127   save them into the variables for next boot.
 128 **/
 129 VOID
 130 BdsSetMemoryTypeInformationVariable (
 131   VOID
 132   );
 133
 134 /**
 135   Validate the EFI Boot#### or Driver#### variable (VendorGuid/Name)
 136
 137   @param  Variable              Boot#### variable data.
 138   @param  VariableSize          Returns the size of the EFI variable that was read
 139
 140   @retval TRUE                  The variable data is correct.
 141   @retval FALSE                 The variable data is corrupted.
 142
 143 **/
 144 BOOLEAN
 145 ValidateOption (
 146   UINT8                     *Variable,
 147   UINTN                     VariableSize
 148   );
 149
 150 #endif // _BDS_LIB_H_