OcBootManagementLib.h

Go to the documentation of this file.

 
#ifndef OC_BOOT_MANAGEMENT_LIB_H
#define OC_BOOT_MANAGEMENT_LIB_H
 
#include <PiDxe.h>
#include <Guid/AppleVariable.h>
#include <IndustryStandard/AppleBootArgs.h>
#include <IndustryStandard/AppleHid.h>
#include <Library/OcAppleBootPolicyLib.h>
#include <Library/OcAppleDiskImageLib.h>
#include <Library/OcAppleKeyMapLib.h>
#include <Library/OcFlexArrayLib.h>
#include <Library/OcStringLib.h>
#include <Library/OcStorageLib.h>
#include <Library/OcTypingLib.h>
#include <Protocol/AppleKeyMapAggregator.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/AppleBeepGen.h>
#include <Protocol/OcAudio.h>
#include <Protocol/GraphicsOutput.h>
#include <Protocol/AppleUserInterface.h>
 
#if defined (OC_TARGET_DEBUG) || defined (OC_TARGET_NOOPT)
// #define BUILTIN_DEMONSTRATE_TYPING
#endif
 
#if !defined (OC_TRACE_PARSE_VARS)
#define OC_TRACE_PARSE_VARS  DEBUG_VERBOSE
#endif
 
#define OC_MAX_INSTANCE_IDENTIFIER_SIZE  64
 
#define OC_MAX_CONTENT_VISIBILITY_SIZE  512
 
typedef struct OC_PICKER_CONTEXT_ OC_PICKER_CONTEXT;
 
typedef struct OC_HOTKEY_CONTEXT_ OC_HOTKEY_CONTEXT;
 
#define OC_MENU_BOOT_MENU             L"OpenCore Boot Menu"
#define OC_MENU_UEFI_SHELL_ENTRY      L"UEFI Shell"
#define OC_MENU_PASSWORD_REQUEST      L"Password: "
#define OC_MENU_PASSWORD_PROCESSING   L"Verifying password..."
#define OC_MENU_PASSWORD_RETRY_LIMIT  L"Password retry limit exceeded."
#define OC_MENU_CHOOSE_OS             L"Choose the Operating System: "
#define OC_MENU_SHOW_AUXILIARY        L"Show Auxiliary"
#define OC_MENU_RELOADING             L"Reloading"
#define OC_MENU_TIMEOUT               L"Timeout"
#define OC_MENU_OK                    L"OK"
#define OC_MENU_EXTERNAL              L" (external)"
#define OC_MENU_DISK_IMAGE            L" (dmg)"
#define OC_MENU_SHUTDOWN              L"Shutting Down"
#define OC_MENU_RESTART               L"Restarting"
 
#define OC_FLAVOUR_AUTO                 "Auto"
#define OC_FLAVOUR_RESET_NVRAM          "ResetNVRAM:NVRAMTool"
#define OC_FLAVOUR_TOGGLE_SIP           "ToggleSIP:NVRAMTool"
#define OC_FLAVOUR_TOGGLE_SIP_ENABLED   "ToggleSIP_Enabled:ToggleSIP:NVRAMTool"
#define OC_FLAVOUR_TOGGLE_SIP_DISABLED  "ToggleSIP_Disabled:ToggleSIP:NVRAMTool"
#define OC_FLAVOUR_FIRMWARE_SETTINGS    "FirmwareSettings"
#define OC_FLAVOUR_HTTP_BOOT4           "HttpBoot4:HttpBoot:NetworkBoot"
#define OC_FLAVOUR_HTTP_BOOT6           "HttpBoot6:HttpBoot:NetworkBoot"
#define OC_FLAVOUR_PXE_BOOT4            "PxeBoot4:PxeBoot:NetworkBoot"
#define OC_FLAVOUR_PXE_BOOT6            "PxeBoot6:PxeBoot:NetworkBoot"
#define OC_FLAVOUR_APPLE_OS             "Apple"
#define OC_FLAVOUR_APPLE_RECOVERY       "AppleRecv:Apple"
#define OC_FLAVOUR_APPLE_FW             "AppleRecv:Apple"
#define OC_FLAVOUR_APPLE_TIME_MACHINE   "AppleTM:Apple"
#define OC_FLAVOUR_WINDOWS              "Windows"
 
#define OC_FLAVOUR_ID_RESET_NVRAM          "ResetNVRAM"
#define OC_FLAVOUR_ID_UEFI_SHELL           "UEFIShell"
#define OC_FLAVOUR_ID_TOGGLE_SIP_ENABLED   "ToggleSIP_Enabled"
#define OC_FLAVOUR_ID_TOGGLE_SIP_DISABLED  "ToggleSIP_Disabled"
#define OC_FLAVOUR_ID_FIRMWARE_SETTINGS    "FirmwareSettings"
#define OC_FLAVOUR_ID_NETWORK_BOOT         "NetworkBoot"
 
#define OPEN_CORE_IMAGE_PATH  L"Resources\\Image\\"
#define OPEN_CORE_LABEL_PATH  L"Resources\\Label\\"
#define OPEN_CORE_AUDIO_PATH  L"Resources\\Audio\\"
#define OPEN_CORE_FONT_PATH   L"Resources\\Font\\"
 
#define OC_ATTR_USE_VOLUME_ICON          BIT0
#define OC_ATTR_USE_DISK_LABEL_FILE      BIT1
#define OC_ATTR_USE_GENERIC_LABEL_IMAGE  BIT2
#define OC_ATTR_HIDE_THEMED_ICONS        BIT3
#define OC_ATTR_USE_POINTER_CONTROL      BIT4
#define OC_ATTR_SHOW_DEBUG_DISPLAY       BIT5
#define OC_ATTR_USE_MINIMAL_UI           BIT6
#define OC_ATTR_USE_FLAVOUR_ICON         BIT7
#define OC_ATTR_USE_REVERSED_UI          BIT8
#define OC_ATTR_REDUCE_MOTION            BIT9
#define OC_ATTR_ALL_BITS                 (\
  OC_ATTR_USE_VOLUME_ICON         | OC_ATTR_USE_DISK_LABEL_FILE | \
  OC_ATTR_USE_GENERIC_LABEL_IMAGE | OC_ATTR_HIDE_THEMED_ICONS   | \
  OC_ATTR_USE_POINTER_CONTROL     | OC_ATTR_SHOW_DEBUG_DISPLAY  | \
  OC_ATTR_USE_MINIMAL_UI          | OC_ATTR_USE_FLAVOUR_ICON    | \
  OC_ATTR_USE_REVERSED_UI         | OC_ATTR_REDUCE_MOTION )
 
#define OC_VOICE_OVER_IDLE_TIMEOUT_MS  700     
 
#define OC_VOICE_OVER_SIGNAL_NORMAL_MS     200 
#define OC_VOICE_OVER_SILENCE_NORMAL_MS    150 
#define OC_VOICE_OVER_SIGNALS_NORMAL       1   
#define OC_VOICE_OVER_SIGNALS_PASSWORD     2   
#define OC_VOICE_OVER_SIGNALS_PASSWORD_OK  3   
 
#define OC_VOICE_OVER_SIGNAL_ERROR_MS   1000
#define OC_VOICE_OVER_SILENCE_ERROR_MS  150
#define OC_VOICE_OVER_SIGNALS_ERROR     1      
#define OC_VOICE_OVER_SIGNALS_HWERROR   3      
 
typedef UINT32 OC_BOOT_ENTRY_TYPE;
 
#define OC_BOOT_UNKNOWN             BIT0
#define OC_BOOT_APPLE_OS            BIT1
#define OC_BOOT_APPLE_RECOVERY      BIT2
#define OC_BOOT_APPLE_TIME_MACHINE  BIT3
#define OC_BOOT_APPLE_FW_UPDATE     BIT4
#define OC_BOOT_APPLE_ANY           (OC_BOOT_APPLE_OS | OC_BOOT_APPLE_RECOVERY | OC_BOOT_APPLE_TIME_MACHINE | OC_BOOT_APPLE_FW_UPDATE)
#define OC_BOOT_WINDOWS             BIT5
#define OC_BOOT_EXTERNAL_OS         BIT6
#define OC_BOOT_EXTERNAL_TOOL       BIT7
#define OC_BOOT_SYSTEM              BIT8
#define OC_BOOT_UNMANAGED           BIT9
 
typedef enum OC_PICKER_MODE_ {
  OcPickerModeBuiltin,
  OcPickerModeExternal,
  OcPickerModeApple,
} OC_PICKER_MODE;
 
#define OC_KERN_CAPABILITY_K32_U32  BIT0       
#define OC_KERN_CAPABILITY_K32_U64  BIT1       
#define OC_KERN_CAPABILITY_K64_U64  BIT2       
 
#define OC_KERN_CAPABILITY_K32_K64_U64  (OC_KERN_CAPABILITY_K32_U64 | OC_KERN_CAPABILITY_K64_U64)
#define OC_KERN_CAPABILITY_K32_U32_U64  (OC_KERN_CAPABILITY_K32_U32 | OC_KERN_CAPABILITY_K32_U64)
#define OC_KERN_CAPABILITY_ALL          (OC_KERN_CAPABILITY_K32_U32 | OC_KERN_CAPABILITY_K32_K64_U64)
 
#define OC_SCAN_FILE_SYSTEM_LOCK  BIT0
 
#define OC_SCAN_DEVICE_LOCK  BIT1
 
#define OC_SCAN_ALLOW_FS_APFS  BIT8
 
#define OC_SCAN_ALLOW_FS_HFS  BIT9
 
#define OC_SCAN_ALLOW_FS_ESP  BIT10
 
#define OC_SCAN_ALLOW_FS_NTFS  BIT11
 
#define OC_SCAN_ALLOW_FS_LINUX_ROOT  BIT12
 
#define OC_SCAN_ALLOW_FS_LINUX_DATA  BIT13
 
#define OC_SCAN_ALLOW_FS_XBOOTLDR  BIT14
 
#define OC_SCAN_ALLOW_DEVICE_SATA  BIT16
 
#define OC_SCAN_ALLOW_DEVICE_SASEX  BIT17
 
#define OC_SCAN_ALLOW_DEVICE_SCSI  BIT18
 
#define OC_SCAN_ALLOW_DEVICE_NVME  BIT19
 
#define OC_SCAN_ALLOW_DEVICE_ATAPI  BIT20
 
#define OC_SCAN_ALLOW_DEVICE_USB  BIT21
 
#define OC_SCAN_ALLOW_DEVICE_FIREWIRE  BIT22
 
#define OC_SCAN_ALLOW_DEVICE_SDCARD  BIT23
 
#define OC_SCAN_ALLOW_DEVICE_PCI  BIT24
 
#define OC_SCAN_DEVICE_BITS  (\
  OC_SCAN_ALLOW_DEVICE_SATA     | OC_SCAN_ALLOW_DEVICE_SASEX | \
  OC_SCAN_ALLOW_DEVICE_SCSI     | OC_SCAN_ALLOW_DEVICE_NVME  | \
  OC_SCAN_ALLOW_DEVICE_ATAPI    | OC_SCAN_ALLOW_DEVICE_USB   | \
  OC_SCAN_ALLOW_DEVICE_FIREWIRE | OC_SCAN_ALLOW_DEVICE_SDCARD | \
  OC_SCAN_ALLOW_DEVICE_PCI)
 
#define OC_SCAN_FILE_SYSTEM_BITS  (\
  OC_SCAN_ALLOW_FS_APFS       | OC_SCAN_ALLOW_FS_HFS        | OC_SCAN_ALLOW_FS_ESP | \
  OC_SCAN_ALLOW_FS_NTFS       | OC_SCAN_ALLOW_FS_LINUX_ROOT | \
  OC_SCAN_ALLOW_FS_LINUX_DATA | OC_SCAN_ALLOW_FS_XBOOTLDR )
 
#define OC_SCAN_DEFAULT_POLICY  (\
  OC_SCAN_FILE_SYSTEM_LOCK   | OC_SCAN_DEVICE_LOCK | \
  OC_SCAN_ALLOW_FS_APFS | \
  OC_SCAN_ALLOW_DEVICE_SATA  | OC_SCAN_ALLOW_DEVICE_SASEX | \
  OC_SCAN_ALLOW_DEVICE_SCSI  | OC_SCAN_ALLOW_DEVICE_NVME | \
  OC_SCAN_ALLOW_DEVICE_PCI)
 
typedef enum {
  OcDmgLoadingDisabled,
  OcDmgLoadingAnyImage,
  OcDmgLoadingAppleSigned,
} OC_DMG_LOADING_SUPPORT;
 
typedef
EFI_STATUS
(*OC_BOOT_SYSTEM_ACTION) (
  IN OUT          OC_PICKER_CONTEXT  *PickerContext
  );
 
typedef
EFI_STATUS
(*OC_BOOT_UNMANAGED_ACTION) (
  IN OUT  OC_PICKER_CONTEXT         *PickerContext,
  IN      EFI_DEVICE_PATH_PROTOCOL  *DevicePath
  );
 
typedef
EFI_STATUS
(*OC_BOOT_UNMANAGED_GET_FINAL_DP) (
  IN OUT  OC_PICKER_CONTEXT         *PickerContext,
  IN OUT  EFI_DEVICE_PATH_PROTOCOL  **DevicePath
  );
 
typedef struct OC_BOOT_ENTRY_ OC_BOOT_ENTRY;
 
typedef
EFI_STATUS
(EFIAPI *OC_CUSTOM_READ)(
  IN  OC_STORAGE_CONTEXT                  *Storage,
  IN  OC_BOOT_ENTRY                       *ChosenEntry,
  OUT VOID                                **Data,
  OUT UINT32                              *DataSize,
  OUT EFI_DEVICE_PATH_PROTOCOL            **DevicePath,
  OUT EFI_HANDLE                          *StorageHandle,
  OUT EFI_DEVICE_PATH_PROTOCOL            **StoragePath,
  IN  OC_DMG_LOADING_SUPPORT              DmgLoading,
  OUT OC_APPLE_DISK_IMAGE_PRELOAD_CONTEXT *DmgPreloadContext,
  OUT VOID                                **CustomFreeContext
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_CUSTOM_FREE)(
  IN  VOID                        *CustomFreeContext
  );
 
struct OC_BOOT_ENTRY_ {
  //
  // Link in entry list in OC_BOOT_FILESYSTEM.
  //
  LIST_ENTRY                        Link;
  //
  // Device path to booter or its directory.
  // Can be NULL, for example, for custom or system entries.
  //
  EFI_DEVICE_PATH_PROTOCOL          *DevicePath;
  //
  // Action to perform on execution. Only valid for system entries.
  //
  OC_BOOT_SYSTEM_ACTION             SystemAction;
  //
  // Action to perform on execution. Only valid for unmanaged boot entries.
  //
  OC_BOOT_UNMANAGED_ACTION          UnmanagedBootAction;
  //
  // Get final Device Path for boot entry. Only valid for unmanaged boot entries.
  //
  OC_BOOT_UNMANAGED_GET_FINAL_DP    UnmanagedBootGetFinalDevicePath;
  //
  // Custom entry image read routine, optional for non-custom entries.
  //
  OC_CUSTOM_READ                    CustomRead;
  //
  // Custom entry routine to free custom items. Optional.
  //
  OC_CUSTOM_FREE                    CustomFree;
  //
  // Id under which to save entry as default.
  //
  CHAR16                            *Id;
  //
  // Obtained human visible name.
  //
  CHAR16                            *Name;
  //
  // Obtained boot path directory.
  // For custom entries this contains tool path.
  //
  CHAR16                            *PathName;
  //
  // Content flavour.
  //
  CHAR8                             *Flavour;
  //
  // Heuristical value signaling inferred type of booted os.
  // WARNING: Non-definitive, do not rely on for any security purposes.
  //
  OC_BOOT_ENTRY_TYPE                Type;
  //
  // Entry index number, assigned by picker.
  //
  UINT32                            EntryIndex;
  //
  // Set when this entry is an externally available entry (e.g. USB).
  //
  BOOLEAN                           IsExternal;
  //
  // Should try booting from first dmg found in DevicePath.
  //
  BOOLEAN                           IsFolder;
  //
  // Set when this entry refers to a generic booter (e.g. BOOTx64.EFI).
  //
  BOOLEAN                           IsGeneric;
  //
  // Set when this entry refers to a custom boot entry.
  //
  BOOLEAN                           IsCustom;
  //
  // Set when entry was created by OC_BOOT_ENTRY_PROTOCOL.
  //
  BOOLEAN                           IsBootEntryProtocol;
  //
  // Set when entry is identified as macOS installer.
  //
  BOOLEAN                           IsAppleInstaller;
  //
  // Should make this option default boot option.
  //
  BOOLEAN                           SetDefault;
  //
  // Should launch this entry in text mode.
  //
  BOOLEAN                           LaunchInText;
  //
  // Should expose real device path when dealing with custom entries.
  //
  BOOLEAN                           ExposeDevicePath;
  //
  // Should disable OpenRuntime NVRAM protection around invocation of tool.
  //
  BOOLEAN                           FullNvramAccess;
  //
  // Partition UUID of entry device.
  // Set for non-system action boot entry protocol boot entries only.
  //
  EFI_GUID                          UniquePartitionGUID;
  //
  // Load option data (usually "boot args") size.
  //
  UINT32                            LoadOptionsSize;
  //
  // Load option data (usually "boot args").
  //
  VOID                              *LoadOptions;
  //
  // Audio base path for system action. Boot Entry Protocol only.
  //
  CHAR8                             *AudioBasePath;
  //
  // Audio base type for system action. Boot Entry Protocol only.
  //
  CHAR8                             *AudioBaseType;
};
 
typedef struct OC_PARSED_VAR_ASCII_ {
  CHAR8    *Name;
  CHAR8    *Value;
} OC_PARSED_VAR_ASCII;
 
typedef struct OC_PARSED_VAR_UNICODE_ {
  CHAR16    *Name;
  CHAR16    *Value;
} OC_PARSED_VAR_UNICODE;
 
typedef union OC_PARSED_VAR_ {
  OC_PARSED_VAR_ASCII      Ascii;
  OC_PARSED_VAR_UNICODE    Unicode;
} OC_PARSED_VAR;
 
typedef struct OC_BOOT_FILESYSTEM_ OC_BOOT_FILESYSTEM;
struct OC_BOOT_FILESYSTEM_ {
  //
  // Link in filesystem list in OC_BOOT_CONTEXT.
  //
  LIST_ENTRY            Link;
  //
  // Filesystem handle.
  //
  EFI_HANDLE            Handle;
  //
  // List of boot entries (OC_BOOT_ENTRY).
  //
  LIST_ENTRY            BootEntries;
  //
  // Pointer to APFS Recovery partition (if any).
  //
  OC_BOOT_FILESYSTEM    *RecoveryFs;
  //
  // External filesystem.
  //
  BOOLEAN               External;
  //
  // Loader filesystem.
  //
  BOOLEAN               LoaderFs;
  //
  // Contains recovery on the filesystem.
  //
  BOOLEAN               HasSelfRecovery;
};
 
typedef struct OC_BOOT_CONTEXT_ {
  //
  // Total boot entry count.
  //
  UINTN                BootEntryCount;
  //
  // Total filesystem count.
  //
  UINTN                FileSystemCount;
  //
  // List of filesystems containing boot entries (OC_BOOT_FILESYSTEM).
  //
  LIST_ENTRY           FileSystems;
  //
  // GUID namespace for boot entries.
  //
  EFI_GUID             *BootVariableGuid;
  //
  // Default entry to be booted.
  //
  OC_BOOT_ENTRY        *DefaultEntry;
  //
  // Picker context for externally configured parameters.
  //
  OC_PICKER_CONTEXT    *PickerContext;
} OC_BOOT_CONTEXT;
 
typedef
EFI_STATUS
(EFIAPI *OC_IMAGE_START)(
  IN  OC_BOOT_ENTRY               *ChosenEntry,
  IN  EFI_HANDLE                  ImageHandle,
  OUT UINTN                       *ExitDataSize,
  OUT CHAR16                      **ExitData    OPTIONAL,
  IN  BOOLEAN                     LaunchInText
  );
 
typedef struct {
  //
  // Used by OC_BOOT_ENTRY_PROTOCOL to reidentify entry.
  // Multiple entries may share an id - allows e.g. newest version
  // of Linux install to automatically become selected default.
  //
  CONST CHAR8                       *Id;
  //
  // Entry name.
  //
  CONST CHAR8                       *Name;
  //
  // Absolute device path to file for user custom entries,
  // file path relative to device root for boot entry protocol.
  //
  CONST CHAR8                       *Path;
  //
  // Entry boot arguments.
  //
  CONST CHAR8                       *Arguments;
  //
  // Content flavour.
  //
  CONST CHAR8                       *Flavour;
  //
  // Whether this entry is auxiliary.
  //
  BOOLEAN                           Auxiliary;
  //
  // Whether this entry is a tool.
  //
  BOOLEAN                           Tool;
  //
  // Whether it should be started in text mode.
  //
  BOOLEAN                           TextMode;
  //
  // Whether we should pass the actual device path (if possible).
  //
  BOOLEAN                           RealPath;
  //
  // Should disable OpenRuntime NVRAM protection around invocation of tool.
  //
  BOOLEAN                           FullNvramAccess;
  //
  // System action. Boot Entry Protocol only. Optional.
  //
  OC_BOOT_SYSTEM_ACTION             SystemAction;
  //
  // Audio base path for system action. Boot Entry Protocol only. Optional.
  //
  CHAR8                             *AudioBasePath;
  //
  // Audio base type for system action. Boot Entry Protocol only. Optional.
  //
  CHAR8                             *AudioBaseType;
  //
  // Unmanaged boot action. Boot Entry Protocol unmanaged boot entries only.
  //
  OC_BOOT_UNMANAGED_ACTION          UnmanagedBootAction;
  //
  // Get final Device Path for unmanaged boot entry. Boot Entry Protocol unmanaged boot entries only.
  //
  OC_BOOT_UNMANAGED_GET_FINAL_DP    UnmanagedBootGetFinalDevicePath;
  //
  // Absolute Device Path. May be used instead of text Path above for Boot Entry Protocol entries. Optional.
  //
  EFI_DEVICE_PATH_PROTOCOL          *UnmanagedDevicePath;
  //
  // Custom entry image read routine, optional for non-custom entries.
  //
  OC_CUSTOM_READ                    CustomRead;
  //
  // Custom entry routine to free custom items. Optional.
  //
  OC_CUSTOM_FREE                    CustomFree;
  //
  // Whether this entry should be labeled as external to the system. Boot Entry Protocol only. Optional.
  //
  BOOLEAN                           External;
} OC_PICKER_ENTRY;
 
typedef enum {
  OcPrivilegeUnauthorized = 0,
  OcPrivilegeAuthorized   = 1
} OC_PRIVILEGE_LEVEL;
 
typedef INTN OC_KEY_CODE;
 
typedef UINT16 OC_MODIFIER_MAP;
 
typedef UINTN OC_PICKER_KEY_MAP;
 
typedef struct {
  OC_KEY_CODE        OcKeyCode;
  OC_MODIFIER_MAP    OcModifiers;
  CHAR16             UnicodeChar;
} OC_PICKER_KEY_INFO;
 
typedef
EFI_STATUS
(EFIAPI *OC_REQ_PRIVILEGE)(
  IN OC_PICKER_CONTEXT   *Context,
  IN OC_PRIVILEGE_LEVEL  Level
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_SHOW_MENU)(
  IN  OC_BOOT_CONTEXT             *BootContext,
  IN  OC_BOOT_ENTRY               **BootEntries,
  OUT OC_BOOT_ENTRY               **ChosenBootEntry
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_GET_ENTRY_LABEL_IMAGE)(
  IN  OC_PICKER_CONTEXT          *Context,
  IN  OC_BOOT_ENTRY              *BootEntry,
  IN  UINT8                      Scale,
  OUT VOID                       **ImageData,
  OUT UINT32                     *DataLength
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_GET_ENTRY_ICON)(
  IN  OC_PICKER_CONTEXT          *Context,
  IN  OC_BOOT_ENTRY              *BootEntry,
  OUT VOID                       **ImageData,
  OUT UINT32                     *DataLength
  );
 
typedef
VOID
(EFIAPI *OC_GET_KEY_INFO)(
  IN OUT OC_PICKER_CONTEXT                  *Context,
  IN     OC_PICKER_KEY_MAP                  KeyFilter,
  OUT OC_PICKER_KEY_INFO                 *PickerKeyInfo
  );
 
typedef
UINT64
(EFIAPI *OC_GET_KEY_WAIT_END_TIME)(
  IN UINT64     Timeout
  );
 
typedef
BOOLEAN
(EFIAPI *OC_WAIT_FOR_KEY_INFO)(
  IN OUT OC_PICKER_CONTEXT                  *Context,
  IN     UINT64                             EndTime,
  IN     OC_PICKER_KEY_MAP                  KeyFilter,
  IN OUT OC_PICKER_KEY_INFO                 *PickerKeyInfo
  );
 
typedef
VOID
(EFIAPI *OC_FLUSH_TYPING_BUFFER)(
  IN OUT OC_PICKER_CONTEXT                  *Context
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_PLAY_AUDIO_FILE)(
  IN  OC_PICKER_CONTEXT                 *Context,
  IN  CONST CHAR8                       *BasePath,
  IN  CONST CHAR8                       *BaseType,
  IN  BOOLEAN                           Fallback
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_PLAY_AUDIO_BEEP)(
  IN  OC_PICKER_CONTEXT        *Context,
  IN  UINT32                   ToneCount,
  IN  UINT32                   ToneLength,
  IN  UINT32                   SilenceLength
  );
 
typedef
EFI_STATUS
(EFIAPI *OC_PLAY_AUDIO_ENTRY)(
  IN  OC_PICKER_CONTEXT  *Context,
  IN  OC_BOOT_ENTRY      *Entry
  );
 
typedef
VOID
(EFIAPI *OC_TOGGLE_VOICE_OVER)(
  IN  OC_PICKER_CONTEXT                 *Context,
  IN  CONST CHAR8                       *BasePath     OPTIONAL,
  IN  CONST CHAR8                       *BaseType     OPTIONAL
  );
 
typedef enum {
  OcPickerDefault           = 0,
  OcPickerShowPicker        = 1,
  OcPickerProtocolHotKey    = 2,
  OcPickerBootApple         = 3,
  OcPickerBootAppleRecovery = 4
} OC_PICKER_CMD;
 
typedef
VOID
(EFIAPI *OC_KB_DEBUG_INSTRUMENT_LOOP_DELAY)(
  UINT64 LoopDelayStart,
  UINT64 LoopDelayEnd
  );
 
typedef
VOID
(EFIAPI *OC_KB_DEBUG_SHOW)(
  UINTN                     NumKeysDown,
  UINTN                     NumKeysHeld,
  APPLE_MODIFIER_MAP        Modifiers
  );
 
typedef struct {
  OC_KB_DEBUG_INSTRUMENT_LOOP_DELAY    InstrumentLoopDelay;
  OC_KB_DEBUG_SHOW                     Show;
} OC_KB_DEBUG_CALLBACKS;
 
typedef struct {
  OC_PRIVILEGE_LEVEL    CurrentLevel;
  CONST UINT8           *Salt;
  UINT32                SaltSize;
  CONST UINT8           *Hash;
} OC_PRIVILEGE_CONTEXT;
 
typedef
BOOLEAN
(EFIAPI *OC_VERIFY_PASSWORD)(
  IN CONST UINT8                  *Password,
  IN UINT32                       PasswordSize,
  IN CONST OC_PRIVILEGE_CONTEXT   *PrivilegeContext
  );
 
struct OC_PICKER_CONTEXT_ {
  //
  // Scan policy (e.g. OC_SCAN_DEFAULT_POLICY).
  //
  UINT32                      ScanPolicy;
  //
  // DMG loading mode (e.g. OcDmgLoadingAppleSigned).
  //
  OC_DMG_LOADING_SUPPORT      DmgLoading;
  //
  // Default entry selection timeout (pass 0 to ignore).
  //
  UINT32                      TimeoutSeconds;
  //
  // Default delay prior to handling hotkeys (pass 0 to ignore).
  //
  UINT32                      TakeoffDelay;
  //
  // Define picker behaviour.
  // For example, show boot menu or just boot the default option.
  //
  OC_PICKER_CMD               PickerCommand;
  //
  // Non-NULL if PickerCommand is OcPickerProtocolHotKey.
  //
  EFI_HANDLE                  HotKeyProtocolHandle;
  //
  // Non-NULL if PickerCommand is OcPickerProtocolHotKey.
  //
  CHAR8                       *HotKeyEntryId;
  //
  // Use custom (gOcVendorVariableGuid) for Boot#### variables.
  //
  BOOLEAN                     CustomBootGuid;
  //
  // Custom entry image read routine, optional for non-custom entries.
  //
  OC_CUSTOM_READ              CustomRead;
  //
  // Storage context.
  //
  OC_STORAGE_CONTEXT          *StorageContext;
  //
  // Image starting routine used, required.
  //
  OC_IMAGE_START              StartImage;
  //
  // Handle to perform loader detection, optional.
  //
  EFI_HANDLE                  LoaderHandle;
  //
  // Get entry label image.
  //
  OC_GET_ENTRY_LABEL_IMAGE    GetEntryLabelImage;
  //
  // Get entry icon.
  //
  OC_GET_ENTRY_ICON           GetEntryIcon;
  //
  // Entry display routine.
  //
  OC_SHOW_MENU                ShowMenu;
  //
  // Privilege escalation requesting routine.
  //
  OC_REQ_PRIVILEGE            RequestPrivilege;
  //
  // Password verification.
  //
  OC_VERIFY_PASSWORD          VerifyPassword;
  //
  // Picker typing context.
  //
  OC_HOTKEY_CONTEXT           *HotKeyContext;
  //
  // Keyboard debug methods.
  //
  OC_KB_DEBUG_CALLBACKS       *KbDebug;
  //
  // Context to pass to RequestPrivilege, optional.
  //
  OC_PRIVILEGE_CONTEXT        *PrivilegeContext;
  //
  // Additional suffix to include by the interface.
  //
  CONST CHAR8                 *TitleSuffix;
  //
  // Used picker mode.
  //
  OC_PICKER_MODE              PickerMode;
  //
  // Console attributes. 0 is reserved as disabled.
  //
  UINT32                      ConsoleAttributes;
  //
  // Picker attribues:
  // - BIT0~BIT15  are OpenCore reserved.
  // - BIT16~BIT31 are OEM-specific.
  //
  UINT32                      PickerAttributes;
  //
  // Picker icon set variant (refer to docs for requested behaviour).
  //
  CONST CHAR8                 *PickerVariant;
  //
  // Boot loader instance identifier.
  //
  CONST CHAR8                 *InstanceIdentifier;
  //
  // Enable polling boot arguments.
  //
  BOOLEAN                     PollAppleHotKeys;
  //
  // Allow setting default boot option from boot menu.
  //
  BOOLEAN                     AllowSetDefault;
  //
  // Hide and do not scan auxiliary entries.
  //
  BOOLEAN                     HideAuxiliary;
  //
  // Enable audio assistant during picker playback.
  //
  BOOLEAN                     PickerAudioAssist;
  //
  // Set when Apple picker cannot be used on this system.
  //
  BOOLEAN                     ApplePickerUnsupported;
  //
  // Ignore Apple peripheral firmware updates.
  //
  BOOLEAN                     BlacklistAppleUpdate;
  //
  // Recommended audio protocol, optional.
  //
  OC_AUDIO_PROTOCOL           *OcAudio;
  //
  // Recommended beeper protocol, optional.
  //
  APPLE_BEEP_GEN_PROTOCOL     *BeepGen;
  //
  // Play audio file function.
  //
  OC_PLAY_AUDIO_FILE          PlayAudioFile;
  //
  // Play audio beep function.
  //
  OC_PLAY_AUDIO_BEEP          PlayAudioBeep;
  //
  // Play audio entry function.
  //
  OC_PLAY_AUDIO_ENTRY         PlayAudioEntry;
  //
  // Toggle VoiceOver function.
  //
  OC_TOGGLE_VOICE_OVER        ToggleVoiceOver;
  //
  // Recovery initiator if present.
  //
  EFI_DEVICE_PATH_PROTOCOL    *RecoveryInitiator;
  //
  // Custom boot order updated during scanning allocated from pool.
  // Preserved here to avoid situations with losing BootNext on rescan.
  //
  UINT16                      *BootOrder;
  //
  // Number of entries in boot order.
  //
  UINTN                       BootOrderCount;
  //
  // Additional boot arguments for Apple loaders.
  //
  CHAR8                       AppleBootArgs[BOOT_LINE_LENGTH];
  //
  // Number of custom boot paths (bless override).
  //
  UINTN                       NumCustomBootPaths;
  //
  // Custom boot paths (bless override).  Must start with '\'.
  //
  CHAR16                      **CustomBootPaths;
  //
  // Number of absolute custom entries.
  //
  UINT32                      AbsoluteEntryCount;
  //
  // Number of total custom entries (absolute and tools).
  //
  UINT32                      AllCustomEntryCount;
  //
  // Custom picker entries.  Absolute entries come first.
  //
  OC_PICKER_ENTRY             CustomEntries[];
};
 
struct OC_HOTKEY_CONTEXT_ {
  //
  // Get pressed key info.
  //
  OC_GET_KEY_INFO                      GetKeyInfo;
  //
  // Request end time in units appropriate for WaitForKeyInfo.
  //
  OC_GET_KEY_WAIT_END_TIME             GetKeyWaitEndTime;
  //
  // Wait for pressed key info.
  //
  OC_WAIT_FOR_KEY_INFO                 WaitForKeyInfo;
  //
  // Flush typing buffer.
  //
  OC_FLUSH_TYPING_BUFFER               FlushTypingBuffer;
  //
  // Apple Key Map protocol.
  //
  APPLE_KEY_MAP_AGGREGATOR_PROTOCOL    *KeyMap;
  //
  // Non-repeating key context.
  //
  OC_KEY_REPEAT_CONTEXT                *DoNotRepeatContext;
  //
  // Typing context.
  //
  OC_TYPING_CONTEXT                    *TypingContext;
};
 
#define HIBERNATE_MODE_NONE   0U
#define HIBERNATE_MODE_RTC    1U
#define HIBERNATE_MODE_NVRAM  2U
 
EFI_STATUS
EFIAPI
OcGetBootEntryLabelImage (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  OC_BOOT_ENTRY      *BootEntry,
  IN  UINT8              Scale,
  OUT VOID               **ImageData,
  OUT UINT32             *DataLength
  );
 
EFI_STATUS
EFIAPI
OcGetBootEntryIcon (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  OC_BOOT_ENTRY      *BootEntry,
  OUT VOID               **ImageData,
  OUT UINT32             *DataLength
  );
 
OC_BOOT_CONTEXT *
OcScanForBootEntries (
  IN  OC_PICKER_CONTEXT  *Context
  );
 
OC_BOOT_CONTEXT *
OcScanForDefaultBootEntry (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  BOOLEAN            UseBootNextOnly
  );
 
OC_BOOT_ENTRY  **
OcEnumerateEntries (
  IN  OC_BOOT_CONTEXT  *BootContext
  );
 
VOID
OcFreeBootContext (
  IN OUT OC_BOOT_CONTEXT  *Context
  );
 
UINT32
OcGetDefaultBootEntry (
  IN     OC_PICKER_CONTEXT  *Context,
  IN OUT OC_BOOT_ENTRY      *BootEntries,
  IN     UINTN              NumBootEntries
  );
 
EFI_STATUS
OcSetDefaultBootEntry (
  IN OC_PICKER_CONTEXT  *Context,
  IN OC_BOOT_ENTRY      *Entry
  );
 
EFI_STATUS
EFIAPI
OcShowSimplePasswordRequest (
  IN OC_PICKER_CONTEXT   *Context,
  IN OC_PRIVILEGE_LEVEL  Level
  );
 
BOOLEAN
EFIAPI
OcVerifyPassword (
  IN CONST UINT8                 *Password,
  IN UINT32                      PasswordSize,
  IN CONST OC_PRIVILEGE_CONTEXT  *PrivilegeContext
  );
 
EFI_STATUS
EFIAPI
OcShowSimpleBootMenu (
  IN  OC_BOOT_CONTEXT  *BootContext,
  IN  OC_BOOT_ENTRY    **BootEntries,
  OUT OC_BOOT_ENTRY    **ChosenBootEntry
  );
 
EFI_STATUS
OcLoadBootEntry (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  OC_BOOT_ENTRY      *BootEntry,
  IN  EFI_HANDLE         ParentHandle
  );
 
EFI_STATUS
OcActivateHibernateWake (
  IN UINT32  HibernateMask
  );
 
EFI_STATUS
OcHandleRecoveryRequest (
  OUT EFI_DEVICE_PATH_PROTOCOL  **Initiator  OPTIONAL
  );
 
VOID *
OcReadApplePanicLog (
  OUT UINT32  *PanicSize
  );
 
BOOLEAN
OcIsAppleHibernateWake (
  VOID
  );
 
VOID
OcLoadPickerHotKeys (
  IN OUT OC_PICKER_CONTEXT  *Context
  );
 
#define OC_INPUT_STR               "123456789ABCDEFGHIJKLMNOPQRSTUVXWZ"
#define OC_INPUT_MAX               L_STR_LEN (OC_INPUT_STR)
#define OC_INPUT_ABORTED           -1           
#define OC_INPUT_NO_ACTION         -2           
#define OC_INPUT_TIMEOUT           -3           
#define OC_INPUT_CONTINUE          -4           
#define OC_INPUT_UP                -5           
#define OC_INPUT_DOWN              -6           
#define OC_INPUT_LEFT              -7           
#define OC_INPUT_RIGHT             -8           
#define OC_INPUT_TOP               -9           
#define OC_INPUT_BOTTOM            -10          
#define OC_INPUT_MORE              -11          
#define OC_INPUT_VOICE_OVER        -12          
#define OC_INPUT_INTERNAL          -13          
#define OC_INPUT_TYPING_CLEAR_ALL  -14          
#define OC_INPUT_TYPING_BACKSPACE  -15          
#define OC_INPUT_TYPING_LEFT       -16          
#define OC_INPUT_TYPING_RIGHT      -17          
#define OC_INPUT_TYPING_CONFIRM    -18          
#define OC_INPUT_SWITCH_FOCUS      -19          
#define OC_INPUT_FUNCTIONAL(x)  (-50 - (x))     
 
#define OC_MODIFIERS_NONE                  0
#define OC_MODIFIERS_SET_DEFAULT           BIT0
#define OC_MODIFIERS_REVERSE_SWITCH_FOCUS  BIT1
 
#define OC_PICKER_KEYS_TYPING       BIT0
#define OC_PICKER_KEYS_HOTKEYS      BIT1
#define OC_PICKER_KEYS_VOICE_OVER   BIT2
#define OC_PICKER_KEYS_TAB_CONTROL  BIT3
 
#define OC_PICKER_KEYS_FOR_TYPING   \
  (OC_PICKER_KEYS_TYPING | OC_PICKER_KEYS_VOICE_OVER | OC_PICKER_KEYS_TAB_CONTROL)
 
#define OC_PICKER_KEYS_FOR_PICKER   \
  (OC_PICKER_KEYS_HOTKEYS | OC_PICKER_KEYS_VOICE_OVER | OC_PICKER_KEYS_TAB_CONTROL)
 
EFI_STATUS
OcInitHotKeys (
  IN OUT OC_PICKER_CONTEXT  *Context
  );
 
VOID
OcFreeHotKeys (
  IN     OC_PICKER_CONTEXT  *Context
  );
 
EFI_STATUS
OcRunBootPicker (
  IN  OC_PICKER_CONTEXT  *Context
  );
 
UINT32
OcGetDevicePolicyType (
  IN  EFI_HANDLE  Handle,
  OUT BOOLEAN     *External  OPTIONAL
  );
 
UINT32
OcGetFileSystemPolicyType (
  IN  EFI_HANDLE  Handle
  );
 
OC_BOOT_ENTRY_TYPE
OcGetBootDevicePathType (
  IN  EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  OUT BOOLEAN                   *IsFolder   OPTIONAL,
  OUT BOOLEAN                   *IsGeneric  OPTIONAL
  );
 
EFI_LOADED_IMAGE_PROTOCOL *
OcGetAppleBootLoadedImage (
  IN EFI_HANDLE  ImageHandle
  );
 
typedef struct OC_BOOT_ARGUMENTS_ {
  UINT32              *MemoryMap;
  UINT32              *MemoryMapSize;
  UINT32              *MemoryMapDescriptorSize;
  UINT32              *MemoryMapDescriptorVersion;
  CHAR8               *CommandLine;
  UINT32              *KernelAddrP;
  UINT32              *SystemTableP;
  UINT32              *RuntimeServicesPG;
  UINT64              *RuntimeServicesV;
  UINT32              *DeviceTreeP;
  UINT32              *DeviceTreeLength;
  UINT32              *CsrActiveConfig;
  EFI_SYSTEM_TABLE    *SystemTable;
} OC_BOOT_ARGUMENTS;
 
//
// Sanity check max. size for LoadOptions. We need to pass PEM certificates
// to some drivers (e.g. OpenNetworkBoot), so this has to be quite large.
//
#define MAX_LOAD_OPTIONS_SIZE  SIZE_16KB
 
BOOLEAN
EFIAPI
OcValidLoadOptions (
  IN        UINT32  LoadOptionsSize,
  IN CONST  VOID    *LoadOptions
  );
 
BOOLEAN
EFIAPI
OcHasLoadOptions (
  IN        UINT32  LoadOptionsSize,
  IN CONST  VOID    *LoadOptions
  );
 
VOID
OcParseBootArgs (
  OUT OC_BOOT_ARGUMENTS  *Arguments,
  IN  VOID               *BootArgs
  );
 
BOOLEAN
OcCheckArgumentFromEnv (
  IN     EFI_LOADED_IMAGE  *LoadedImage OPTIONAL,
  IN     EFI_GET_VARIABLE  GetVariable OPTIONAL,
  IN     CONST CHAR8       *Argument,
  IN     CONST UINTN       ArgumentLength,
  IN OUT CHAR8             **Value OPTIONAL
  );
 
CONST CHAR8 *
OcGetArgumentFromCmd (
  IN  CONST CHAR8  *CommandLine,
  IN  CONST CHAR8  *Argument,
  IN  CONST UINTN  ArgumentLength,
  OUT UINTN        *ValueLength OPTIONAL
  );
 
VOID
OcRemoveArgumentFromCmd (
  IN OUT CHAR8        *CommandLine,
  IN     CONST CHAR8  *Argument
  );
 
BOOLEAN
OcAppendArgumentToCmd (
  IN OUT OC_PICKER_CONTEXT  *Context OPTIONAL,
  IN OUT CHAR8              *CommandLine,
  IN     CONST CHAR8        *Argument,
  IN     CONST UINTN        ArgumentLength
  );
 
BOOLEAN
OcAppendArgumentsToLoadedImage (
  IN OUT EFI_LOADED_IMAGE_PROTOCOL  *LoadedImage,
  IN     CONST CHAR8                **Arguments,
  IN     UINT32                     ArgumentCount,
  IN     BOOLEAN                    Replace
  );
 
EFI_STATUS
OcRunFirmwareApplication (
  IN EFI_GUID  *ApplicationGuid,
  IN BOOLEAN   SetReason
  );
 
EFI_STATUS
EFIAPI
OcPreLocateAudioProtocol (
  IN     OC_PICKER_CONTEXT  *Context
  );
 
EFI_STATUS
EFIAPI
OcPlayAudioFile (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  CONST CHAR8        *BasePath,
  IN  CONST CHAR8        *BaseType,
  IN  BOOLEAN            Fallback
  );
 
EFI_STATUS
EFIAPI
OcPlayAudioBeep (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  UINT32             ToneCount,
  IN  UINT32             ToneLength,
  IN  UINT32             SilenceLength
  );
 
EFI_STATUS
EFIAPI
OcPlayAudioEntry (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  OC_BOOT_ENTRY      *Entry
  );
 
VOID
EFIAPI
OcToggleVoiceOver (
  IN  OC_PICKER_CONTEXT  *Context,
  IN  CONST CHAR8        *BasePath     OPTIONAL,
  IN  CONST CHAR8        *BaseType     OPTIONAL
  );
 
UINT16 *
OcGetBootOrder (
  IN  EFI_GUID  *BootVariableGuid,
  IN  BOOLEAN   WithBootNext,
  OUT UINTN     *BootOrderCount,
  OUT BOOLEAN   *Deduplicated  OPTIONAL,
  OUT BOOLEAN   *HasBootNext   OPTIONAL,
  IN  BOOLEAN   UseBootNextOnly
  );
 
EFI_STATUS
OcRegisterBootstrapBootOption (
  IN CONST CHAR16  *OptionName,
  IN EFI_HANDLE    DeviceHandle,
  IN CONST CHAR16  *FilePath,
  IN BOOLEAN       ShortForm,
  IN CONST CHAR16  *MatchSuffix,
  IN UINTN         MatchSuffixLen
  );
 
VOID
OcImageLoaderInit (
  IN     CONST BOOLEAN  ProtectUefiServices,
  IN     CONST BOOLEAN  FixupAppleEfiImages
  );
 
VOID
OcImageLoaderActivate (
  VOID
  );
 
typedef
VOID
(*OC_IMAGE_LOADER_PATCH) (
  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath  OPTIONAL,
  IN VOID                      *SourceBuffer,
  IN UINTN                     SourceSize
  );
 
typedef
VOID
(*OC_IMAGE_LOADER_CONFIGURE) (
  IN OUT EFI_LOADED_IMAGE_PROTOCOL  *LoadedImage,
  IN     UINT32                     Capabilities
  );
 
VOID
OcImageLoaderRegisterPatch (
  IN OC_IMAGE_LOADER_PATCH  Patch      OPTIONAL
  );
 
VOID
OcImageLoaderRegisterConfigure (
  IN OC_IMAGE_LOADER_CONFIGURE  Configure  OPTIONAL
  );
 
EFI_STATUS
EFIAPI
OcImageLoaderLoad (
  IN  BOOLEAN                   BootPolicy,
  IN  EFI_HANDLE                ParentImageHandle,
  IN  EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN  VOID                      *SourceBuffer OPTIONAL,
  IN  UINTN                     SourceSize,
  OUT EFI_HANDLE                *ImageHandle
  );
 
EFI_STATUS
OcParseLoadOptions (
  IN     CONST EFI_LOADED_IMAGE_PROTOCOL  *LoadedImage,
  OUT       OC_FLEX_ARRAY                 **ParsedVars
  );
 
EFI_STATUS
OcParseVars (
  IN           VOID              *StrVars,
  OUT       OC_FLEX_ARRAY        **ParsedVars,
  IN     CONST OC_STRING_FORMAT  StringFormat,
  IN     CONST BOOLEAN           TokensOnly
  );
 
OC_PARSED_VAR *
OcParsedVarsItemAt (
  IN     CONST OC_FLEX_ARRAY  *ParsedVars,
  IN     CONST UINTN          Index
  );
 
BOOLEAN
OcParsedVarsGetStr (
  IN     CONST OC_FLEX_ARRAY     *ParsedVars,
  IN     CONST VOID              *Name,
  OUT       VOID                 **StrValue,
  IN     CONST OC_STRING_FORMAT  StringFormat
  );
 
BOOLEAN
OcParsedVarsGetUnicodeStr (
  IN     CONST OC_FLEX_ARRAY  *ParsedVars,
  IN     CONST CHAR16         *Name,
  OUT       CHAR16            **StrValue
  );
 
BOOLEAN
OcParsedVarsGetAsciiStr (
  IN     CONST OC_FLEX_ARRAY  *ParsedVars,
  IN     CONST CHAR8          *Name,
  OUT       CHAR8             **StrValue
  );
 
BOOLEAN
OcHasParsedVar (
  IN     CONST OC_FLEX_ARRAY     *ParsedVars,
  IN     CONST VOID              *Name,
  IN     CONST OC_STRING_FORMAT  StringFormat
  );
 
EFI_STATUS
OcParsedVarsGetInt (
  IN     CONST OC_FLEX_ARRAY     *ParsedVars,
  IN     CONST VOID              *Name,
  OUT       UINTN                *Value,
  IN     CONST OC_STRING_FORMAT  StringFormat
  );
 
EFI_STATUS
OcParsedVarsGetGuid (
  IN     CONST OC_FLEX_ARRAY     *ParsedVars,
  IN     CONST VOID              *Name,
  OUT       EFI_GUID             *Value,
  IN     CONST OC_STRING_FORMAT  StringFormat
  );
 
VOID
OcLocateBootEntryProtocolHandles (
  IN OUT EFI_HANDLE  **EntryProtocolHandles,
  IN OUT UINTN       *EntryProtocolHandleCount
  );
 
VOID
OcFreeBootEntryProtocolHandles (
  EFI_HANDLE  **EntryProtocolHandles
  );
 
EFI_STATUS
OcAddEntriesFromBootEntryProtocol (
  IN OUT OC_BOOT_CONTEXT *BootContext,
  IN OUT OC_BOOT_FILESYSTEM *FileSystem,
  IN     EFI_HANDLE *EntryProtocolHandles,
  IN     UINTN EntryProtocolHandleCount,
  IN     CONST VOID *DefaultEntryId, OPTIONAL
  IN     BOOLEAN        CreateDefault,
  IN     BOOLEAN        CreateForHotKey
  );
 
EFI_STATUS
OcUnlockAppleFirmwareUI (
  VOID
  );
 
EFI_STATUS
OcLaunchAppleBootPicker (
  VOID
  );
 
EFI_STATUS
EFIAPI
OcGetBootEntryFileFromDevicePath (
  IN  EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN  CONST CHAR16              *FileName,
  IN  CONST CHAR8               *DebugFileType,
  IN  UINT32                    MaxFileSize,
  IN  UINT32                    MinFileSize,
  OUT VOID                      **FileData,
  OUT UINT32                    *DataLength OPTIONAL,
  IN  BOOLEAN                   SearchAtLeaf,
  IN  BOOLEAN                   SearchAtRoot
  );
 
EFI_STATUS
EFIAPI
OcGetBootEntryFile (
  IN  OC_BOOT_ENTRY  *BootEntry,
  IN  CONST CHAR16   *FileName,
  IN  CONST CHAR8    *DebugFileType,
  IN  UINT32         MaxFileSize,
  IN  UINT32         MinFileSize,
  OUT VOID           **FileData,
  OUT UINT32         *DataLength OPTIONAL,
  IN  BOOLEAN        SearchAtLeaf,
  IN  BOOLEAN        SearchAtRoot
  );
 
EFI_STATUS
EFIAPI
OcResetToFirmwareSettingsSupported (
  VOID
  );
 
EFI_STATUS
EFIAPI
OcResetSystem (
  IN CHAR16  *Mode
  );
 
#endif // OC_BOOT_MANAGEMENT_LIB_H