archive-gh-me/OpenCorePkg
1
0
Fork 0
mirror of https://github.com/acidanthera/OpenCorePkg.git synced 2025-12-08 19:25:01 +00:00
Code Issues Projects Releases Wiki Activity
OpenCorePkg/Library/OcBootManagementLib/OcBootManagementLib.c
Mike Beaton c8b93357b8 OcConsoleLib: Simplify use of builtin renderer uncontrolled mode 
The renderer already (esp. since recent changes incl. reset to controlled on cls)
manages its own transitions to controlled, so we just need to indicate uncontrolled
in cases where something else has been rendering graphics
2023-05-04 09:59:22 +01:00

674 lines
20 KiB
C
Raw Blame History

/** @file
Copyright (C) 2019, vit9696. All rights reserved.<BR>
SPDX-License-Identifier: BSD-3-Clause
**/
#include "BootManagementInternal.h"
#include <Guid/AppleFile.h>
#include <Guid/AppleVariable.h>
#include <Guid/OcVariable.h>
#include <IndustryStandard/AppleCsrConfig.h>
#include <Protocol/AppleBeepGen.h>
#include <Protocol/AppleBootPolicy.h>
#include <Protocol/AppleKeyMapAggregator.h>
#include <Protocol/AppleUserInterface.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/OcAudio.h>
#include <Protocol/SimpleTextOut.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/BaseOverflowLib.h>
#include <Library/OcConsoleLib.h>
#include <Library/OcCryptoLib.h>
#include <Library/OcDebugLogLib.h>
#include <Library/DevicePathLib.h>
#include <Library/OcTimerLib.h>
#include <Library/OcTypingLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/OcAppleKeyMapLib.h>
#include <Library/OcBootManagementLib.h>
#include <Library/OcDevicePathLib.h>
#include <Library/OcFileLib.h>
#include <Library/OcMainLib.h>
#include <Library/OcMiscLib.h>
#include <Library/OcRtcLib.h>
#include <Library/OcStringLib.h>
#include <Library/OcVariableLib.h>
#include <Library/PrintLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/ResetSystemLib.h>
STATIC
EFI_STATUS
RunShowMenu (
IN OC_BOOT_CONTEXT *BootContext,
OUT OC_BOOT_ENTRY **ChosenBootEntry
)
{
EFI_STATUS Status;
OC_BOOT_ENTRY **BootEntries;
UINT32 EntryReason;
ASSERT (
BootContext->PickerContext->ApplePickerUnsupported
|| (BootContext->PickerContext->PickerMode != OcPickerModeApple)
);
BootEntries = OcEnumerateEntries (BootContext);
if (BootEntries == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// We are not allowed to have no default entry.
// However, if default entry is a tool or a system entry, never autoboot it.
//
if (BootContext->DefaultEntry == NULL) {
BootContext->DefaultEntry = BootEntries[0];
BootContext->PickerContext->TimeoutSeconds = 0;
}
//
// Ensure that picker entry reason is set as it can be read by boot.efi.
//
EntryReason = ApplePickerEntryReasonUnknown;
gRT->SetVariable (
APPLE_PICKER_ENTRY_REASON_VARIABLE_NAME,
&gAppleVendorVariableGuid,
EFI_VARIABLE_BOOTSERVICE_ACCESS,
sizeof (EntryReason),
&EntryReason
);
Status = OcInitHotKeys (BootContext->PickerContext);
if (EFI_ERROR (Status)) {
FreePool (BootEntries);
return Status;
}
Status = BootContext->PickerContext->ShowMenu (
BootContext,
BootEntries,
ChosenBootEntry
);
OcFreeHotKeys (BootContext->PickerContext);
FreePool (BootEntries);
return Status;
}
BOOLEAN
EFIAPI
OcVerifyPassword (
IN CONST UINT8 *Password,
IN UINT32 PasswordSize,
IN CONST OC_PRIVILEGE_CONTEXT *PrivilegeContext
)
{
BOOLEAN Result;
Result = OcVerifyPasswordSha512 (
Password,
PasswordSize,
PrivilegeContext->Salt,
PrivilegeContext->SaltSize,
PrivilegeContext->Hash
);
return Result;
}
EFI_STATUS
InternalRunRequestPrivilege (
IN OC_PICKER_CONTEXT *PickerContext,
IN OC_PRIVILEGE_LEVEL Level
)
{
EFI_STATUS Status;
BOOLEAN HotKeysAlreadyLive;
if ( (PickerContext->PrivilegeContext == NULL)
|| (PickerContext->PrivilegeContext->CurrentLevel >= Level))
{
return EFI_SUCCESS;
}
HotKeysAlreadyLive = (PickerContext->HotKeyContext != NULL);
if (!HotKeysAlreadyLive) {
Status = OcInitHotKeys (PickerContext);
if (EFI_ERROR (Status)) {
return Status;
}
}
Status = PickerContext->RequestPrivilege (
PickerContext,
OcPrivilegeAuthorized
);
if (!EFI_ERROR (Status)) {
PickerContext->PrivilegeContext->CurrentLevel = Level;
}
if (!HotKeysAlreadyLive) {
OcFreeHotKeys (PickerContext);
}
return Status;
}
EFI_STATUS
OcRunBootPicker (
IN OC_PICKER_CONTEXT *Context
)
{
EFI_STATUS Status;
APPLE_KEY_MAP_AGGREGATOR_PROTOCOL *KeyMap;
OC_BOOT_CONTEXT *BootContext;
OC_BOOT_ENTRY *Chosen;
BOOLEAN SaidWelcome;
OC_FIRMWARE_RUNTIME_PROTOCOL *FwRuntime;
BOOLEAN IsApplePickerSelection;
SaidWelcome = FALSE;
OcImageLoaderActivate ();
KeyMap = OcAppleKeyMapInstallProtocols (FALSE);
if (KeyMap == NULL) {
DEBUG ((DEBUG_ERROR, "OCB: AppleKeyMap locate failure\n"));
return EFI_NOT_FOUND;
}
//
// Use builtin text renderer extension:
// - Set for text-based picker, to mark dirty due to BIOS logo, early logs, etc.
// (which are not cleared by initial resync when starting in console graphics mode).
// - Do no set for graphics-based picker, since we want (expected behaviour, also
// similar to how system renderers tend to behave) the debug log to continue on
// over the graphics from the position it has reached so far, if we are running
// in a mode which will show text output.
//
if (Context->ShowMenu == OcShowSimpleBootMenu) {
gST->ConOut->TestString (gST->ConOut, OC_CONSOLE_MARK_UNCONTROLLED);
}
//
// This one is handled as is for Apple BootPicker for now.
//
if (Context->PickerCommand != OcPickerDefault) {
Status = InternalRunRequestPrivilege (Context, OcPrivilegeAuthorized);
if (EFI_ERROR (Status)) {
if (Status != EFI_ABORTED) {
ASSERT (FALSE);
return Status;
}
Context->PickerCommand = OcPickerDefault;
}
}
IsApplePickerSelection = FALSE;
if ((Context->PickerCommand == OcPickerShowPicker) && (Context->PickerMode == OcPickerModeApple)) {
Status = OcLaunchAppleBootPicker ();
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_INFO, "OCB: Apple BootPicker failed - %r, fallback to builtin\n", Status));
Context->ApplePickerUnsupported = TRUE;
} else {
IsApplePickerSelection = TRUE;
}
}
if ((Context->PickerCommand != OcPickerShowPicker) && (Context->PickerCommand != OcPickerDefault)) {
//
// We cannot ignore auxiliary entries for all other modes.
//
Context->HideAuxiliary = FALSE;
}
while (TRUE) {
//
// Never show Apple Picker twice, re-scan for entries if we previously successfully showed it.
//
if (IsApplePickerSelection && (Context->PickerMode != OcPickerModeApple)) {
IsApplePickerSelection = FALSE;
Context->BootOrder = NULL;
Context->BootOrderCount = 0;
}
//
// Turbo-boost scanning when bypassing picker.
//
if ( (Context->PickerCommand == OcPickerDefault)
|| (Context->PickerCommand == OcPickerProtocolHotKey)
|| IsApplePickerSelection
)
{
BootContext = OcScanForDefaultBootEntry (Context, IsApplePickerSelection);
} else {
ASSERT (
Context->PickerCommand == OcPickerShowPicker
|| Context->PickerCommand == OcPickerBootApple
|| Context->PickerCommand == OcPickerBootAppleRecovery
);
BootContext = OcScanForBootEntries (Context);
}
//
// We have no entries at all or have auxiliary entries.
// Fallback to showing menu in the latter case.
//
if (BootContext == NULL) {
//
// Because of this fallback code, failed protocol hotkey can access OcPickerShowPicker mode
// even if this is denied by InternalRunRequestPrivilege above. Believed to be acceptable
// as in a secure system any entry protocol drivers should be locked down and trusted.
//
if (Context->HideAuxiliary || (Context->PickerCommand == OcPickerProtocolHotKey) || IsApplePickerSelection) {
Context->PickerCommand = OcPickerShowPicker;
Context->HideAuxiliary = FALSE;
if (IsApplePickerSelection) {
DEBUG ((DEBUG_WARN, "OCB: Apple Picker returned no entry valid under OC, falling back to builtin\n"));
Context->PickerMode = OcPickerModeBuiltin;
//
// Clears all native picker graphics on switching back to text mode.
//
gST->ConOut->TestString (gST->ConOut, OC_CONSOLE_MARK_UNCONTROLLED);
} else {
DEBUG ((DEBUG_INFO, "OCB: System has no boot entries, showing picker with auxiliary\n"));
}
continue;
}
DEBUG ((DEBUG_WARN, "OCB: System has no boot entries\n"));
return EFI_NOT_FOUND;
}
if ((Context->PickerCommand == OcPickerShowPicker) && !IsApplePickerSelection) {
DEBUG ((
DEBUG_INFO,
"OCB: Showing menu... %a\n",
Context->PollAppleHotKeys ? "(polling hotkeys)" : ""
));
if (!SaidWelcome) {
OcPlayAudioFile (Context, OC_VOICE_OVER_AUDIO_FILE_WELCOME, OC_VOICE_OVER_AUDIO_BASE_TYPE_OPEN_CORE, FALSE);
SaidWelcome = TRUE;
}
Status = RunShowMenu (BootContext, &Chosen);
if (EFI_ERROR (Status) && (Status != EFI_ABORTED)) {
if (BootContext->PickerContext->ShowMenu != OcShowSimpleBootMenu) {
DEBUG ((DEBUG_WARN, "OCB: External interface ShowMenu failure, fallback to builtin - %r\n", Status));
BootContext->PickerContext->ShowMenu = OcShowSimpleBootMenu;
BootContext->PickerContext->RequestPrivilege = OcShowSimplePasswordRequest;
Status = RunShowMenu (BootContext, &Chosen);
}
}
if (EFI_ERROR (Status) && (Status != EFI_ABORTED)) {
DEBUG ((DEBUG_ERROR, "OCB: ShowMenu failed - %r\n", Status));
OcFreeBootContext (BootContext);
return Status;
}
} else if (BootContext->DefaultEntry != NULL) {
Chosen = BootContext->DefaultEntry;
Status = EFI_SUCCESS;
} else {
//
// This can only be failed macOS or macOS recovery boot.
// We may actually not rescan here.
//
ASSERT (Context->PickerCommand == OcPickerBootApple || Context->PickerCommand == OcPickerBootAppleRecovery);
DEBUG ((DEBUG_INFO, "OCB: System has no default boot entry, showing menu\n"));
Context->PickerCommand = OcPickerShowPicker;
OcFreeBootContext (BootContext);
continue;
}
ASSERT (!EFI_ERROR (Status) || Status == EFI_ABORTED);
Context->TimeoutSeconds = 0;
if (!EFI_ERROR (Status)) {
DEBUG ((
DEBUG_INFO,
"OCB: Should boot from %u. %s (T:%d|F:%d|G:%d|E:%d|DEF:%d)\n",
Chosen->EntryIndex,
Chosen->Name,
Chosen->Type,
Chosen->IsFolder,
Chosen->IsGeneric,
Chosen->IsExternal,
Chosen->SetDefault
));
if ((Context->PickerCommand == OcPickerShowPicker) && !IsApplePickerSelection) {
ASSERT (Chosen->EntryIndex > 0);
if (Chosen->SetDefault) {
if (Context->PickerCommand == OcPickerShowPicker) {
OcPlayAudioFile (Context, OC_VOICE_OVER_AUDIO_FILE_SELECTED, OC_VOICE_OVER_AUDIO_BASE_TYPE_OPEN_CORE, FALSE);
OcPlayAudioFile (Context, OC_VOICE_OVER_AUDIO_FILE_DEFAULT, OC_VOICE_OVER_AUDIO_BASE_TYPE_OPEN_CORE, FALSE);
OcPlayAudioEntry (Context, Chosen);
}
Status = OcSetDefaultBootEntry (Context, Chosen);
DEBUG ((DEBUG_INFO, "OCB: Setting default - %r\n", Status));
}
//
// If launching entry in text, clear screen of previous console contents - e.g. from
// builtin picker, log messages, or previous console tool - before loading the entry.
// Otherwise, if coming from graphics picker, set to trigger a full screen clear if anybody,
// but particularly macOS verbose boot, switches to text mode. (If running Canopy with
// a background mode of text, this still works: even though Builtin renderer only clears
// on change from graphics to text, macOS initially sets graphics, which stays uncontrolled,
// then back to text for verbose mode.)
// But if coming from text picker do not set uncontrolled, intentionally allowing initial
// verbose mode text to run on after the picker text.
//
if (Chosen->LaunchInText) {
gST->ConOut->TestString (gST->ConOut, OC_CONSOLE_MARK_UNCONTROLLED);
gST->ConOut->ClearScreen (gST->ConOut);
} else if (BootContext->PickerContext->ShowMenu != OcShowSimpleBootMenu) {
gST->ConOut->TestString (gST->ConOut, OC_CONSOLE_MARK_UNCONTROLLED);
}
//
// Voice chosen information.
//
OcPlayAudioFile (Context, OC_VOICE_OVER_AUDIO_FILE_LOADING, OC_VOICE_OVER_AUDIO_BASE_TYPE_OPEN_CORE, FALSE);
Status = OcPlayAudioEntry (Context, Chosen);
if (EFI_ERROR (Status)) {
OcPlayAudioBeep (
Context,
OC_VOICE_OVER_SIGNALS_PASSWORD_OK,
OC_VOICE_OVER_SIGNAL_NORMAL_MS,
OC_VOICE_OVER_SILENCE_NORMAL_MS
);
}
}
FwRuntime = Chosen->FullNvramAccess ? OcDisableNvramProtection () : NULL;
Status = OcLoadBootEntry (
Context,
Chosen,
gImageHandle
);
OcRestoreNvramProtection (FwRuntime);
//
// Do not wait on successful return code.
//
if (EFI_ERROR (Status)) {
OcPlayAudioFile (Context, OC_VOICE_OVER_AUDIO_FILE_EXECUTION_FAILURE, OC_VOICE_OVER_AUDIO_BASE_TYPE_OPEN_CORE, TRUE);
gBS->Stall (SECONDS_TO_MICROSECONDS (3));
//
// Show picker on first failure.
//
Context->PickerCommand = OcPickerShowPicker;
} else {
OcPlayAudioFile (Context, OC_VOICE_OVER_AUDIO_FILE_EXECUTION_SUCCESSFUL, OC_VOICE_OVER_AUDIO_BASE_TYPE_OPEN_CORE, FALSE);
}
//
// Ensure that we flush all pressed keys after the application.
// This resolves the problem of application-pressed keys being used to control the menu.
//
OcKeyMapFlush (KeyMap, 0, TRUE);
}
OcFreeBootContext (BootContext);
}
}
STATIC
EFI_STATUS
SetPickerEntryReason (
IN APPLE_PICKER_ENTRY_REASON PickerEntryReason
)
{
return gRT->SetVariable (
APPLE_PICKER_ENTRY_REASON_VARIABLE_NAME,
&gAppleVendorVariableGuid,
EFI_VARIABLE_BOOTSERVICE_ACCESS,
sizeof (PickerEntryReason),
&PickerEntryReason
);
}
EFI_STATUS
OcRunFirmwareApplication (
IN EFI_GUID *ApplicationGuid,
IN BOOLEAN SetReason
)
{
EFI_STATUS Status;
EFI_HANDLE NewHandle;
EFI_DEVICE_PATH_PROTOCOL *Dp;
DEBUG ((DEBUG_INFO, "OCB: run fw app attempting to find %g...\n", ApplicationGuid));
Dp = OcCreateFvFileDevicePath (ApplicationGuid);
if (Dp != NULL) {
DEBUG ((DEBUG_INFO, "OCB: run fw app attempting to load %g...\n", ApplicationGuid));
NewHandle = NULL;
Status = gBS->LoadImage (
FALSE,
gImageHandle,
Dp,
NULL,
0,
&NewHandle
);
if (EFI_ERROR (Status)) {
Status = EFI_INVALID_PARAMETER;
}
} else {
Status = EFI_NOT_FOUND;
}
if (!EFI_ERROR (Status)) {
if (SetReason) {
Status = SetPickerEntryReason (ApplePickerEntryReasonUnknown);
}
DEBUG ((
DEBUG_INFO,
"OCB: run fw app attempting to start %g (%d) %r...\n",
ApplicationGuid,
SetReason,
Status
));
Status = gBS->StartImage (
NewHandle,
NULL,
NULL
);
if (EFI_ERROR (Status)) {
Status = EFI_UNSUPPORTED;
}
}
return Status;
}
//
// Patching prolog of this function works on more similar era firmware
// than assuming that mGopAlreadyConnected is located immediately after
// protocol interface (which applies on MacPro5,1 v144.0.0.0.0 but not others).
//
// MacPro5,1 + some iMacs:
//
// sub rsp, 28h
// cmp cs:mGopAlreadyConnected, 0 ///< Ignore offset of this var
// jz short loc_10004431
// xor eax, eax
// jmp short loc_1000446F ///< Change this to no jump
//
STATIC CONST UINT8 ConnectGopPrologue[] = {
0x48, 0x83, 0xEC, 0x28, 0x80, 0x3D, 0x00, 0x00,
0x00, 0x00, 0x00, 0x74, 0x04, 0x33, 0xC0, 0xEB,
0x3E
};
STATIC CONST UINT8 ConnectGopPrologueMask[] = {
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00,
0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
0xFF
};
STATIC CONST UINT8 ConnectGopReplace[] = {
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00
};
STATIC CONST UINT8 ConnectGopReplaceMask[] = {
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0xFF
};
//
// iMac11,1:
//
// push rbx
// sub rsp, 30h
// cmp cs:byte_100065C8, 0
// jz short loc_10004077
// xor ebx, ebx
// jmp short loc_100040D1
//
STATIC CONST UINT8 AltConnectGopPrologue[] = {
0x48, 0x53, 0x48, 0x83, 0xEC, 0x30,
0x80, 0x3D, 0x00, 0x00, 0x00, 0x00,0x00,
0x74, 0x04, 0x33, 0xDB, 0xEB, 0x5A
};
STATIC CONST UINT8 AltConnectGopPrologueMask[] = {
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00,0xFF,
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
};
STATIC CONST UINT8 AltConnectGopReplace[] = {
0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00,0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};
STATIC CONST UINT8 AltConnectGopReplaceMask[] = {
0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00,0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0xFF
};
EFI_STATUS
OcUnlockAppleFirmwareUI (
VOID
)
{
EFI_STATUS Status;
APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL *FirmwareUI;
UINT32 ReplaceCount;
Status = gBS->LocateProtocol (
&gAppleFirmwareUserInterfaceProtocolGuid,
NULL,
(VOID **)&FirmwareUI
);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_INFO, "OCB: Cannot locate FirmwareUI protocol - %r\n", Status));
} else if (FirmwareUI->Revision != APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_REVISION) {
DEBUG ((
DEBUG_INFO,
"OCB: Unlock FirmwareUI incompatible protocol revision %u != %u\n",
FirmwareUI->Revision,
APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_REVISION
));
Status = EFI_UNSUPPORTED;
}
if (!EFI_ERROR (Status)) {
ReplaceCount = ApplyPatch (
ConnectGopPrologue,
ConnectGopPrologueMask,
sizeof (ConnectGopPrologue),
ConnectGopReplace,
ConnectGopReplaceMask,
(VOID *)FirmwareUI->ConnectGop,
sizeof (ConnectGopPrologue),
1,
0
);
if (ReplaceCount == 0) {
ReplaceCount = ApplyPatch (
AltConnectGopPrologue,
AltConnectGopPrologueMask,
sizeof (AltConnectGopPrologue),
AltConnectGopReplace,
AltConnectGopReplaceMask,
(VOID *)FirmwareUI->ConnectGop,
sizeof (AltConnectGopPrologue),
1,
0
);
}
Status = EFI_SUCCESS;
if (ReplaceCount == 0) {
Status = EFI_NOT_FOUND;
DEBUG ((
DEBUG_INFO,
"OCB: 0x%016LX 0x%016LX 0x%016LX\n",
*((UINT64 *)((UINT8 *)FirmwareUI->ConnectGop)),
*((UINT64 *)(((UINT8 *)FirmwareUI->ConnectGop) + 8)),
*((UINT64 *)(((UINT8 *)FirmwareUI->ConnectGop) + 16))
));
}
DEBUG ((
EFI_ERROR (Status) ? DEBUG_WARN : DEBUG_INFO,
"OCB: FirmwareUI ConnectGop patch - %r\n",
Status
));
}
return Status;
}
EFI_STATUS
OcLaunchAppleBootPicker (
VOID
)
{
EFI_STATUS Status;
OcUnlockAppleFirmwareUI ();
Status = OcRunFirmwareApplication (&gAppleBootPickerFileGuid, TRUE);
return Status;
}
Reference in New Issue View Git Blame Copy Permalink