69fc8f080e
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com> Reviewed-by: Jiewen Yao <jiewen.yao@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15385 6f19259b-4bc3-4df7-8a09-765794883524
238 lines
8.6 KiB
C
238 lines
8.6 KiB
C
/** @file
|
|
Head file for BDS Architectural Protocol implementation
|
|
|
|
Copyright (c) 2004 - 2014, 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 _BDS_MODULE_H_
|
|
#define _BDS_MODULE_H_
|
|
|
|
#include <FrameworkDxe.h>
|
|
#include <IndustryStandard/PeImage.h>
|
|
#include <Guid/MdeModuleHii.h>
|
|
#include <Guid/FileSystemVolumeLabelInfo.h>
|
|
#include <Guid/HiiPlatformSetupFormset.h>
|
|
#include <Guid/StatusCodeDataTypeVariable.h>
|
|
#include <Protocol/DevicePath.h>
|
|
#include <IndustryStandard/SmBios.h>
|
|
#include <Protocol/LoadFile.h>
|
|
#include <Guid/FileInfo.h>
|
|
#include <Protocol/HiiConfigRouting.h>
|
|
#include <Protocol/Bds.h>
|
|
#include <Protocol/Smbios.h>
|
|
#include <Protocol/UgaDraw.h>
|
|
#include <Protocol/BlockIo.h>
|
|
#include <Guid/GlobalVariable.h>
|
|
#include <Guid/CapsuleVendor.h>
|
|
#include <Guid/StatusCodeDataTypeId.h>
|
|
#include <Guid/LegacyDevOrder.h>
|
|
#include <Guid/BdsHii.h>
|
|
#include <Guid/ConnectConInEvent.h>
|
|
#include <Guid/Performance.h>
|
|
#include <Guid/FmpCapsule.h>
|
|
#include <Protocol/GenericMemoryTest.h>
|
|
#include <Protocol/FormBrowser2.h>
|
|
#include <Protocol/HiiConfigAccess.h>
|
|
#include <Protocol/GraphicsOutput.h>
|
|
#include <Protocol/SimpleFileSystem.h>
|
|
#include <Protocol/HiiDatabase.h>
|
|
#include <Protocol/HiiString.h>
|
|
#include <Protocol/SerialIo.h>
|
|
#include <Protocol/LegacyBios.h>
|
|
#include <Protocol/SimpleTextInEx.h>
|
|
#include <Protocol/DriverHealth.h>
|
|
#include <Protocol/BootLogo.h>
|
|
#include <Protocol/VariableLock.h>
|
|
|
|
#include <Library/UefiDriverEntryPoint.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/PerformanceLib.h>
|
|
#include <Library/ReportStatusCodeLib.h>
|
|
#include <Library/UefiRuntimeServicesTableLib.h>
|
|
#include <Library/HobLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/DevicePathLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/CapsuleLib.h>
|
|
#include <Library/HiiLib.h>
|
|
#include <Library/DevicePathLib.h>
|
|
#include <Library/UefiHiiServicesLib.h>
|
|
|
|
#include <Library/GenericBdsLib.h>
|
|
#include <Library/PlatformBdsLib.h>
|
|
|
|
#pragma pack(1)
|
|
|
|
///
|
|
/// HII specific Vendor Device Path definition.
|
|
///
|
|
typedef struct {
|
|
VENDOR_DEVICE_PATH VendorDevicePath;
|
|
EFI_DEVICE_PATH_PROTOCOL End;
|
|
} HII_VENDOR_DEVICE_PATH;
|
|
|
|
#pragma pack()
|
|
|
|
/**
|
|
|
|
Show progress bar with title above it. It only works in Graphics mode.
|
|
|
|
@param TitleForeground Foreground color for Title.
|
|
@param TitleBackground Background color for Title.
|
|
@param Title Title above progress bar.
|
|
@param ProgressColor Progress bar color.
|
|
@param Progress Progress (0-100)
|
|
@param PreviousValue The previous value of the progress.
|
|
|
|
@retval EFI_STATUS Success update the progress bar
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PlatformBdsShowProgress (
|
|
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
|
|
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
|
|
IN CHAR16 *Title,
|
|
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
|
|
IN UINTN Progress,
|
|
IN UINTN PreviousValue
|
|
);
|
|
|
|
//
|
|
// Prototypes
|
|
//
|
|
|
|
/**
|
|
|
|
Install Boot Device Selection Protocol
|
|
|
|
@param ImageHandle The image handle.
|
|
@param SystemTable The system table.
|
|
|
|
@retval EFI_SUCEESS BDS has finished initializing.
|
|
Return the dispatcher and recall BDS.Entry
|
|
@retval Other Return status from AllocatePool() or gBS->InstallProtocolInterface
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
BdsInitialize (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
);
|
|
|
|
/**
|
|
|
|
Service routine for BdsInstance->Entry(). Devices are connected, the
|
|
consoles are initialized, and the boot options are tried.
|
|
|
|
@param This Protocol Instance structure.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
BdsEntry (
|
|
IN EFI_BDS_ARCH_PROTOCOL *This
|
|
);
|
|
|
|
|
|
/**
|
|
Perform the memory test base on the memory test intensive level,
|
|
and update the memory resource.
|
|
|
|
@param Level The memory test intensive level.
|
|
|
|
@retval EFI_STATUS Success test all the system memory and update
|
|
the memory resource
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
BdsMemoryTest (
|
|
IN EXTENDMEM_COVERAGE_LEVEL Level
|
|
);
|
|
|
|
/**
|
|
|
|
This routine is called to see if there are any capsules we need to process.
|
|
If the boot mode is not UPDATE, then we do nothing. Otherwise find the
|
|
capsule HOBS and produce firmware volumes for them via the DXE service.
|
|
Then call the dispatcher to dispatch drivers from them. Finally, check
|
|
the status of the updates.
|
|
|
|
This function should be called by BDS in case we need to do some
|
|
sort of processing even if there is no capsule to process. We
|
|
need to do this if an earlier update went away and we need to
|
|
clear the capsule variable so on the next reset PEI does not see it and
|
|
think there is a capsule available.
|
|
|
|
@param BootMode the current boot mode
|
|
|
|
@retval EFI_INVALID_PARAMETER boot mode is not correct for an update
|
|
@retval EFI_SUCCESS There is no error when processing capsule
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
BdsProcessCapsules (
|
|
EFI_BOOT_MODE BootMode
|
|
);
|
|
|
|
/**
|
|
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
|
|
BdsDxeSetVariableAndReportStatusCodeOnError (
|
|
IN CHAR16 *VariableName,
|
|
IN EFI_GUID *VendorGuid,
|
|
IN UINT32 Attributes,
|
|
IN UINTN DataSize,
|
|
IN VOID *Data
|
|
);
|
|
|
|
#endif
|