Add new interface GetVariable2 and GetEfiGlobalVariable2 to return more info. Also...

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / GenericBdsLib / InternalBdsLib.h

/** @file\r
  BDS library definition, include the file and data structure\r
\r
Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r
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 _INTERNAL_BDS_LIB_H_\r
#define _INTERNAL_BDS_LIB_H_\r
\r
#include <FrameworkDxe.h>\r
\r
#include <IndustryStandard/Pci.h>\r
#include <IndustryStandard/PeImage.h>\r
\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/Cpu.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/LoadFile.h>\r
#include <Protocol/DebugPort.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/LegacyBios.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/SimpleNetwork.h>\r
#include <Protocol/DevicePathToText.h>\r
#include <Protocol/FirmwareVolume2.h>\r
#include <Protocol/PciIo.h>\r
#include <Protocol/AcpiS3Save.h>\r
#include <Protocol/OEMBadging.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/HiiFont.h>\r
#include <Protocol/HiiImage.h>\r
#include <Protocol/UsbIo.h>\r
#include <Protocol/BootLogo.h>\r
\r
#include <Guid/MemoryTypeInformation.h>\r
#include <Guid/FileInfo.h>\r
#include <Guid/GlobalVariable.h>\r
#include <Guid/PcAnsi.h>\r
#include <Guid/Performance.h>\r
#include <Guid/BdsLibHii.h>\r
#include <Guid/HdBootVariable.h>\r
#include <Guid/LastEnumLang.h>\r
\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/DxeServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PeCoffGetEntryPointLib.h>\r
#include <Library/GenericBdsLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/DxeServicesLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
\r
#if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)\r
    #if defined (MDE_CPU_EBC)\r
        //\r
        // Uefi specification only defines the default boot file name for IA32, X64\r
        // and IPF processor, so need define boot file name for EBC architecture here.\r
        //\r
        #define EFI_REMOVABLE_MEDIA_FILE_NAME L"\\EFI\\BOOT\\BOOTEBC.EFI"\r
    #else\r
        #error "Can not determine the default boot file name for unknown processor type!"\r
    #endif\r
#endif\r
\r
/**\r
\r
  Allocates a block of memory and writes performance data of booting into it.\r
  OS can processing these record.\r
  \r
**/\r
VOID\r
WriteBootToOsPerformanceData (\r
  VOID\r
  );\r
\r
/**\r
  Get the headers (dos, image, optional header) from an image\r
\r
  @param  Device                SimpleFileSystem device handle\r
  @param  FileName              File name for the image\r
  @param  DosHeader             Pointer to dos header\r
  @param  Hdr                   The buffer in which to return the PE32, PE32+, or TE header.\r
\r
  @retval EFI_SUCCESS           Successfully get the machine type.\r
  @retval EFI_NOT_FOUND         The file is not found.\r
  @retval EFI_LOAD_ERROR        File is not a valid image file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BdsLibGetImageHeader (\r
  IN  EFI_HANDLE                  Device,\r
  IN  CHAR16                      *FileName,\r
  OUT EFI_IMAGE_DOS_HEADER        *DosHeader,\r
  OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION   Hdr\r
  );\r
\r
/**\r
  This routine adjust the memory information for different memory type and \r
  save them into the variables for next boot.\r
**/\r
VOID\r
BdsSetMemoryTypeInformationVariable (\r
  VOID\r
  );\r
\r
/**\r
  Validate the EFI Boot#### or Driver#### variable (VendorGuid/Name)\r
\r
  @param  Variable              Boot#### variable data.\r
  @param  VariableSize          Returns the size of the EFI variable that was read\r
\r
  @retval TRUE                  The variable data is correct.\r
  @retval FALSE                 The variable data is corrupted.\r
\r
**/\r
BOOLEAN \r
ValidateOption (\r
  UINT8                     *Variable,\r
  UINTN                     VariableSize\r
  );\r
\r
#endif // _BDS_LIB_H_\r