/** @file
|
This file include all platform actions
|
|
Copyright (c) 2019, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
|
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
#include "PlatformBootManager.h"
|
|
|
EFI_GUID mUefiShellFileGuid = { 0x7C04A583, 0x9E3E, 0x4f1c, {0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 0xB4, 0xD1}};
|
|
/**
|
Perform the platform diagnostic, such like test memory. OEM/IBV also
|
can customize this function to support specific platform diagnostic.
|
|
@param MemoryTestLevel The memory test intensive level
|
@param QuietBoot Indicate if need to enable the quiet boot
|
|
**/
|
VOID
|
PlatformBootManagerDiagnostics (
|
IN EXTENDMEM_COVERAGE_LEVEL MemoryTestLevel,
|
IN BOOLEAN QuietBoot
|
)
|
{
|
EFI_STATUS Status;
|
|
//
|
// Here we can decide if we need to show
|
// the diagnostics screen
|
// Notes: this quiet boot code should be remove
|
// from the graphic lib
|
//
|
if (QuietBoot) {
|
|
//
|
// Perform system diagnostic
|
//
|
Status = PlatformBootManagerMemoryTest (MemoryTestLevel);
|
return;
|
}
|
|
//
|
// Perform system diagnostic
|
//
|
Status = PlatformBootManagerMemoryTest (MemoryTestLevel);
|
}
|
|
/**
|
Return the index of the load option in the load option array.
|
|
The function consider two load options are equal when the
|
OptionType, Attributes, Description, FilePath and OptionalData are equal.
|
|
@param Key Pointer to the load option to be found.
|
@param Array Pointer to the array of load options to be found.
|
@param Count Number of entries in the Array.
|
|
@retval -1 Key wasn't found in the Array.
|
@retval 0 ~ Count-1 The index of the Key in the Array.
|
**/
|
INTN
|
PlatformFindLoadOption (
|
IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *Key,
|
IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *Array,
|
IN UINTN Count
|
)
|
{
|
UINTN Index;
|
|
for (Index = 0; Index < Count; Index++) {
|
if ((Key->OptionType == Array[Index].OptionType) &&
|
(Key->Attributes == Array[Index].Attributes) &&
|
(StrCmp (Key->Description, Array[Index].Description) == 0) &&
|
(CompareMem (Key->FilePath, Array[Index].FilePath, GetDevicePathSize (Key->FilePath)) == 0) &&
|
(Key->OptionalDataSize == Array[Index].OptionalDataSize) &&
|
(CompareMem (Key->OptionalData, Array[Index].OptionalData, Key->OptionalDataSize) == 0)) {
|
return (INTN) Index;
|
}
|
}
|
|
return -1;
|
}
|
|
VOID
|
PlatformRegisterFvBootOption (
|
EFI_GUID *FileGuid,
|
CHAR16 *Description,
|
UINT32 Attributes
|
)
|
{
|
EFI_STATUS Status;
|
UINTN OptionIndex;
|
EFI_BOOT_MANAGER_LOAD_OPTION NewOption;
|
EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions;
|
UINTN BootOptionCount;
|
MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FileNode;
|
EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
|
EFI_DEVICE_PATH_PROTOCOL *DevicePath;
|
|
Status = gBS->HandleProtocol (gImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &LoadedImage);
|
ASSERT_EFI_ERROR (Status);
|
|
EfiInitializeFwVolDevicepathNode (&FileNode, FileGuid);
|
DevicePath = AppendDevicePathNode (
|
DevicePathFromHandle (LoadedImage->DeviceHandle),
|
(EFI_DEVICE_PATH_PROTOCOL *) &FileNode
|
);
|
|
Status = EfiBootManagerInitializeLoadOption (
|
&NewOption,
|
LoadOptionNumberUnassigned,
|
LoadOptionTypeBoot,
|
Attributes,
|
Description,
|
DevicePath,
|
NULL,
|
0
|
);
|
if (!EFI_ERROR (Status)) {
|
BootOptions = EfiBootManagerGetLoadOptions (&BootOptionCount, LoadOptionTypeBoot);
|
|
OptionIndex = PlatformFindLoadOption (&NewOption, BootOptions, BootOptionCount);
|
|
if (OptionIndex == -1) {
|
Status = EfiBootManagerAddLoadOptionVariable (&NewOption, (UINTN) -1);
|
ASSERT_EFI_ERROR (Status);
|
}
|
EfiBootManagerFreeLoadOption (&NewOption);
|
EfiBootManagerFreeLoadOptions (BootOptions, BootOptionCount);
|
}
|
}
|
|
/**
|
Do the platform specific action before the console is connected.
|
|
Such as:
|
Update console variable;
|
Register new Driver#### or Boot####;
|
Signal ReadyToLock event.
|
**/
|
VOID
|
EFIAPI
|
PlatformBootManagerBeforeConsole (
|
VOID
|
)
|
{
|
UINTN Index;
|
EFI_STATUS Status;
|
EFI_INPUT_KEY Enter;
|
EFI_INPUT_KEY F2;
|
EFI_BOOT_MANAGER_LOAD_OPTION BootOption;
|
|
//
|
// Update the console variables.
|
//
|
for (Index = 0; gPlatformConsole[Index].DevicePath != NULL; Index++) {
|
DEBUG ((DEBUG_INFO, "Check gPlatformConsole %d\n", Index));
|
if ((gPlatformConsole[Index].ConnectType & CONSOLE_IN) == CONSOLE_IN) {
|
Status = EfiBootManagerUpdateConsoleVariable (ConIn, gPlatformConsole[Index].DevicePath, NULL);
|
DEBUG ((DEBUG_INFO, "CONSOLE_IN variable set %s : %r\n", ConvertDevicePathToText (gPlatformConsole[Index].DevicePath, FALSE, FALSE), Status));
|
}
|
|
if ((gPlatformConsole[Index].ConnectType & CONSOLE_OUT) == CONSOLE_OUT) {
|
Status = EfiBootManagerUpdateConsoleVariable (ConOut, gPlatformConsole[Index].DevicePath, NULL);
|
DEBUG ((DEBUG_INFO, "CONSOLE_OUT variable set %s : %r\n", ConvertDevicePathToText (gPlatformConsole[Index].DevicePath, FALSE, FALSE), Status));
|
}
|
|
if ((gPlatformConsole[Index].ConnectType & STD_ERROR) == STD_ERROR) {
|
Status = EfiBootManagerUpdateConsoleVariable (ErrOut, gPlatformConsole[Index].DevicePath, NULL);
|
DEBUG ((DEBUG_INFO, "STD_ERROR variable set %r", Status));
|
}
|
}
|
|
//
|
// Register ENTER as CONTINUE key
|
//
|
Enter.ScanCode = SCAN_NULL;
|
Enter.UnicodeChar = CHAR_CARRIAGE_RETURN;
|
EfiBootManagerRegisterContinueKeyOption (0, &Enter, NULL);
|
//
|
// Map F2 to Boot Manager Menu
|
//
|
F2.ScanCode = SCAN_F2;
|
F2.UnicodeChar = CHAR_NULL;
|
EfiBootManagerGetBootManagerMenu (&BootOption);
|
EfiBootManagerAddKeyOptionVariable (NULL, (UINT16) BootOption.OptionNumber, 0, &F2, NULL);
|
//
|
// Register UEFI Shell
|
//
|
PlatformRegisterFvBootOption (&mUefiShellFileGuid, L"UEFI Shell", LOAD_OPTION_ACTIVE);
|
}
|
|
/**
|
Do the platform specific action after the console is connected.
|
|
Such as:
|
Dynamically switch output mode;
|
Signal console ready platform customized event;
|
Run diagnostics like memory testing;
|
Connect certain devices;
|
Dispatch aditional option roms.
|
**/
|
VOID
|
EFIAPI
|
PlatformBootManagerAfterConsole (
|
VOID
|
)
|
{
|
EFI_GRAPHICS_OUTPUT_BLT_PIXEL Black;
|
EFI_GRAPHICS_OUTPUT_BLT_PIXEL White;
|
|
Black.Blue = Black.Green = Black.Red = Black.Reserved = 0;
|
White.Blue = White.Green = White.Red = White.Reserved = 0xFF;
|
|
EfiBootManagerConnectAll ();
|
EfiBootManagerRefreshAllBootOption ();
|
|
PlatformBootManagerDiagnostics (QUICK, TRUE);
|
|
PrintXY (10, 10, &White, &Black, L"F2 to enter Boot Manager Menu. ");
|
PrintXY (10, 30, &White, &Black, L"Enter to boot directly.");
|
}
|
|
/**
|
The function is called when no boot option could be launched,
|
including platform recovery options and options pointing to applications
|
built into firmware volumes.
|
|
If this function returns, BDS attempts to enter an infinite loop.
|
**/
|
VOID
|
EFIAPI
|
PlatformBootManagerUnableToBoot (
|
VOID
|
)
|
{
|
return;
|
}
|