mirror of https://github.com/acidanthera/audk.git
180 lines
7.3 KiB
C
180 lines
7.3 KiB
C
/** @file
|
|
BDS library definition, include the file and data structure
|
|
|
|
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef _INTERNAL_BDS_LIB_H_
|
|
#define _INTERNAL_BDS_LIB_H_
|
|
|
|
#include <FrameworkDxe.h>
|
|
|
|
#include <IndustryStandard/Pci.h>
|
|
#include <IndustryStandard/PeImage.h>
|
|
|
|
#include <Protocol/BlockIo.h>
|
|
#include <Protocol/LoadedImage.h>
|
|
#include <Protocol/Cpu.h>
|
|
#include <Protocol/SimpleFileSystem.h>
|
|
#include <Protocol/LoadFile.h>
|
|
#include <Protocol/DebugPort.h>
|
|
#include <Protocol/DevicePath.h>
|
|
#include <Protocol/SimpleTextIn.h>
|
|
#include <Protocol/LegacyBios.h>
|
|
#include <Protocol/SimpleTextOut.h>
|
|
#include <Protocol/SimpleNetwork.h>
|
|
#include <Protocol/FirmwareVolume2.h>
|
|
#include <Protocol/PciIo.h>
|
|
#include <Protocol/AcpiS3Save.h>
|
|
#include <Protocol/OEMBadging.h>
|
|
#include <Protocol/GraphicsOutput.h>
|
|
#include <Protocol/UgaDraw.h>
|
|
#include <Protocol/HiiFont.h>
|
|
#include <Protocol/HiiImage.h>
|
|
#include <Protocol/UsbIo.h>
|
|
#include <Protocol/BootLogo.h>
|
|
|
|
#include <Guid/MemoryTypeInformation.h>
|
|
#include <Guid/FileInfo.h>
|
|
#include <Guid/GlobalVariable.h>
|
|
#include <Guid/PcAnsi.h>
|
|
#include <Guid/BdsLibHii.h>
|
|
#include <Guid/HdBootVariable.h>
|
|
#include <Guid/LastEnumLang.h>
|
|
#include <Guid/LegacyDevOrder.h>
|
|
#include <Guid/StatusCodeDataTypeVariable.h>
|
|
|
|
#include <Library/PrintLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/DxeServicesTableLib.h>
|
|
#include <Library/UefiRuntimeServicesTableLib.h>
|
|
#include <Library/HobLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/DevicePathLib.h>
|
|
#include <Library/PerformanceLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/PeCoffGetEntryPointLib.h>
|
|
#include <Library/GenericBdsLib.h>
|
|
#include <Library/TimerLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/DxeServicesLib.h>
|
|
#include <Library/ReportStatusCodeLib.h>
|
|
#include <Library/BmpSupportLib.h>
|
|
|
|
#if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)
|
|
#if defined (MDE_CPU_EBC)
|
|
//
|
|
// Uefi specification only defines the default boot file name for IA32, X64
|
|
// and IPF processor, so need define boot file name for EBC architecture here.
|
|
//
|
|
#define EFI_REMOVABLE_MEDIA_FILE_NAME L"\\EFI\\BOOT\\BOOTEBC.EFI"
|
|
#else
|
|
#error "Can not determine the default boot file name for unknown processor type!"
|
|
#endif
|
|
#endif
|
|
|
|
/**
|
|
Get the headers (dos, image, optional header) from an image
|
|
|
|
@param Device SimpleFileSystem device handle
|
|
@param FileName File name for the image
|
|
@param DosHeader Pointer to dos header
|
|
@param Hdr The buffer in which to return the PE32, PE32+, or TE header.
|
|
|
|
@retval EFI_SUCCESS Successfully get the machine type.
|
|
@retval EFI_NOT_FOUND The file is not found.
|
|
@retval EFI_LOAD_ERROR File is not a valid image file.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
BdsLibGetImageHeader (
|
|
IN EFI_HANDLE Device,
|
|
IN CHAR16 *FileName,
|
|
OUT EFI_IMAGE_DOS_HEADER *DosHeader,
|
|
OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
|
|
);
|
|
|
|
/**
|
|
This routine adjust the memory information for different memory type and
|
|
save them into the variables for next boot.
|
|
**/
|
|
VOID
|
|
BdsSetMemoryTypeInformationVariable (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Validate the EFI Boot#### or Driver#### variable (VendorGuid/Name)
|
|
|
|
@param Variable Boot#### variable data.
|
|
@param VariableSize Returns the size of the EFI variable that was read
|
|
|
|
@retval TRUE The variable data is correct.
|
|
@retval FALSE The variable data is corrupted.
|
|
|
|
**/
|
|
BOOLEAN
|
|
ValidateOption (
|
|
UINT8 *Variable,
|
|
UINTN VariableSize
|
|
);
|
|
|
|
/**
|
|
Set the variable and report the error through status code upon failure.
|
|
|
|
@param VariableName A Null-terminated string that is the name of the vendor's variable.
|
|
Each VariableName is unique for each VendorGuid. VariableName must
|
|
contain 1 or more characters. If VariableName is an empty string,
|
|
then EFI_INVALID_PARAMETER is returned.
|
|
@param VendorGuid A unique identifier for the vendor.
|
|
@param Attributes Attributes bitmask to set for the variable.
|
|
@param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
|
|
EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or
|
|
EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
|
|
causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
|
|
set, then a SetVariable() call with a DataSize of zero will not cause any change to
|
|
the variable value (the timestamp associated with the variable may be updated however
|
|
even if no new data value is provided,see the description of the
|
|
EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
|
|
be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
|
|
@param Data The contents for the variable.
|
|
|
|
@retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
|
|
defined by the Attributes.
|
|
@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
|
|
DataSize exceeds the maximum allowed.
|
|
@retval EFI_INVALID_PARAMETER VariableName is an empty string.
|
|
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
|
|
@retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
|
|
@retval EFI_WRITE_PROTECTED The variable in question is read-only.
|
|
@retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
|
|
@retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
|
|
or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo
|
|
does NOT pass the validation check carried out by the firmware.
|
|
|
|
@retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
|
|
**/
|
|
EFI_STATUS
|
|
SetVariableAndReportStatusCodeOnError (
|
|
IN CHAR16 *VariableName,
|
|
IN EFI_GUID *VendorGuid,
|
|
IN UINT32 Attributes,
|
|
IN UINTN DataSize,
|
|
IN VOID *Data
|
|
);
|
|
|
|
#endif // _BDS_LIB_H_
|