BootManagementInternal.h

Go to the documentation of this file.

 
#ifndef BOOT_MANAGEMENET_INTERNAL_H
#define BOOT_MANAGEMENET_INTERNAL_H
 
#include <Uefi.h>
 
#include <Library/OcAppleDiskImageLib.h>
#include <Library/OcBootManagementLib.h>
 
#include <Protocol/AppleBootPolicy.h>
#include <Protocol/DevicePath.h>
#include <Protocol/SimpleFileSystem.h>
 
#define OC_CUSTOM_FS_HANDLE  ((EFI_HANDLE)(UINTN) 0x2007C5F5U)
 
#define OC_CUSTOM_BOOT_DEVICE_PATH_GUID  \
  { 0xd6f263f9, 0x0b19, 0x4670,          \
    { 0xb0, 0xa4, 0x9d, 0x95, 0x9f, 0x58, 0xdf, 0x65 } }
 
#define OC_ENTRY_PROTOCOL_DEVICE_PATH_GUID  \
  { 0x669bf063, 0x78c1, 0x4c29,                  \
    { 0x93, 0x34, 0x2f, 0xf0, 0x15, 0xfe, 0xa2, 0xfe } }
 
#pragma pack(1)
 
typedef PACKED struct {
  VENDOR_DEVICE_PATH      Hdr;
  FILEPATH_DEVICE_PATH    EntryName;
} OC_CUSTOM_BOOT_DEVICE_PATH;
 
typedef PACKED struct {
  VENDOR_DEVICE_PATH      Hdr;
  EFI_GUID                Partuuid;
  FILEPATH_DEVICE_PATH    EntryName;
} OC_ENTRY_PROTOCOL_DEVICE_PATH;
 
//
// Ideally, a variant of FILEPATH_DEVICE_PATH will be used with PathName as a
// flexible array. Such cannot be used for declarations, so provide an
// alternative.
//
typedef PACKED struct {
  VENDOR_DEVICE_PATH          Header;
  EFI_DEVICE_PATH_PROTOCOL    EntryName;
} OC_CUSTOM_BOOT_DEVICE_PATH_DECL;
 
//
// Version not including first char of path name.
//
typedef PACKED struct {
  VENDOR_DEVICE_PATH          Header;
  EFI_GUID                    Partuuid;
  EFI_DEVICE_PATH_PROTOCOL    EntryName;
} OC_ENTRY_PROTOCOL_DEVICE_PATH_DECL;
 
#pragma pack()
 
#define SIZE_OF_OC_CUSTOM_BOOT_DEVICE_PATH  \
  (sizeof (VENDOR_DEVICE_PATH) + SIZE_OF_FILEPATH_DEVICE_PATH)
 
#define SIZE_OF_OC_ENTRY_PROTOCOL_DEVICE_PATH  \
  (sizeof (VENDOR_DEVICE_PATH) + sizeof (EFI_GUID) + SIZE_OF_FILEPATH_DEVICE_PATH)
 
//
// Max. supported Apple version string size
//
#define OC_APPLE_VERSION_MAX_SIZE  (16)
 
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL       *DevicePath;
  OC_APPLE_DISK_IMAGE_CONTEXT    *DmgContext;
  EFI_HANDLE                     BlockIoHandle;
} INTERNAL_DMG_LOAD_CONTEXT;
 
typedef struct {
  EFI_HANDLE                  Device;
  UINTN                       NumBootInstances;
  UINTN                       HdPrefixSize;
  EFI_DEVICE_PATH_PROTOCOL    *HdDevicePath;
  EFI_DEVICE_PATH_PROTOCOL    *BootDevicePath;
  BOOLEAN                     IsExternal;
  BOOLEAN                     SkipRecovery;
} INTERNAL_DEV_PATH_SCAN_INFO;
 
typedef enum {
  BootEntryNormal,
  BootEntryAuxiliary,
  BootEntryDisabled,
} INTERNAL_ENTRY_VISIBILITY;
 
EFI_STATUS
InternalCheckScanPolicy (
  IN  EFI_HANDLE  Handle,
  IN  UINT32      Policy,
  OUT BOOLEAN     *External OPTIONAL
  );
 
EFI_DEVICE_PATH_PROTOCOL *
InternalLoadDmg (
  IN OUT INTERNAL_DMG_LOAD_CONTEXT            *Context,
  IN     OC_DMG_LOADING_SUPPORT               DmgLoading,
  IN     OC_APPLE_DISK_IMAGE_PRELOAD_CONTEXT  *DmgPreloadContext
  );
 
VOID
InternalUnloadDmg (
  IN INTERNAL_DMG_LOAD_CONTEXT  *DmgLoadContext
  );
 
CHAR16 *
InternalGetAppleDiskLabel (
  IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *FileSystem,
  IN  CONST CHAR16                     *BootDirectoryName,
  IN  CONST CHAR16                     *LabelFilename
  );
 
CHAR8 *
InternalGetContentFlavour (
  IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *FileSystem,
  IN  CONST CHAR16                     *BootDirectoryName
  );
 
EFI_STATUS
InternalGetAppleImage (
  IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *FileSystem,
  IN  CONST CHAR16                     *DirectoryName,
  IN  CONST CHAR16                     *LabelFilename,
  OUT VOID                             **ImageData,
  OUT UINT32                           *DataSize
  );
 
EFI_STATUS
InternalGetRecoveryOsBooter (
  IN  EFI_HANDLE                Device,
  OUT EFI_DEVICE_PATH_PROTOCOL  **FilePath,
  IN  BOOLEAN                   Basic
  );
 
EFI_STATUS
InternalLoadBootEntry (
  IN  OC_PICKER_CONTEXT          *Context,
  IN  OC_BOOT_ENTRY              *BootEntry,
  IN  EFI_HANDLE                 ParentHandle,
  OUT EFI_HANDLE                 *EntryHandle,
  OUT INTERNAL_DMG_LOAD_CONTEXT  *DmgLoadContext,
  OUT VOID                       **CustomFreeContext
  );
 
UINT16 *
InternalGetBootOrderForBooting (
  IN  EFI_GUID  *BootVariableGuid,
  IN  BOOLEAN   BlacklistAppleUpdate,
  OUT UINTN     *BootOrderCount,
  IN  BOOLEAN   UseBootNextOnly
  );
 
VOID
InternalDebugBootEnvironment (
  IN CONST UINT16  *BootOrder,
  IN EFI_GUID      *BootGuid,
  IN UINTN         BootOrderCount
  );
 
EFI_DEVICE_PATH_PROTOCOL *
InternalGetBootOptionPath (
  IN EFI_LOAD_OPTION  *LoadOption,
  IN UINTN            LoadOptionSize
  );
 
EFI_STATUS
InternalAddBootEntryFromCustomEntry (
  IN OUT OC_BOOT_CONTEXT     *BootContext,
  IN OUT OC_BOOT_FILESYSTEM  *FileSystem,
  IN     OC_PICKER_ENTRY     *CustomEntry,
  IN     BOOLEAN             IsBootEntryProtocol
  );
 
EFI_STATUS
InternalDescribeBootEntry (
  IN     OC_BOOT_CONTEXT  *BootContext,
  IN OUT OC_BOOT_ENTRY    *BootEntry
  );
 
BOOLEAN
InternalIsAppleLegacyLoadApp (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath
  );
 
OC_BOOT_FILESYSTEM *
InternalFileSystemForHandle (
  IN  OC_BOOT_CONTEXT  *BootContext,
  IN  EFI_HANDLE       FileSystemHandle,
  IN  BOOLEAN          LazyScan,
  OUT BOOLEAN          *AlreadySeen        OPTIONAL
  );
 
CONST OC_CUSTOM_BOOT_DEVICE_PATH *
InternalGetOcCustomDevPath (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath
  );
 
CONST OC_ENTRY_PROTOCOL_DEVICE_PATH *
InternalGetOcEntryProtocolDevPath (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath
  );
 
EFI_STATUS
InternalRunRequestPrivilege (
  IN OC_PICKER_CONTEXT   *PickerContext,
  IN OC_PRIVILEGE_LEVEL  Level
  );
 
#endif // BOOT_MANAGEMENET_INTERNAL_H