BootCompatInternal.h

Go to the documentation of this file.

 
#ifndef BOOT_COMPAT_INTERNAL_H
#define BOOT_COMPAT_INTERNAL_H
 
#include <Uefi.h>
 
#include <IndustryStandard/AppleBootArgs.h>
#include <IndustryStandard/AppleEfiBootRtInfo.h>
 
#include <Library/OcAfterBootCompatLib.h>
#include <Library/OcBootManagementLib.h>
#include <Library/OcDebugLogLib.h>
#include <Library/OcMemoryLib.h>
 
#include <Protocol/LoadedImage.h>
#include <Protocol/OcFirmwareRuntime.h>
 
//
// The kernel is normally allocated at base 0x100000 + slide address.
//
// For slide=0x1~0x7F the kernel is allocated from
// 0x100000 + 0x200000 till 0x100000 + 0xFE00000.
//
// For slide = 0x80~0xFF on Sandy Bridge or Ivy Bridge CPUs from
// 0x100000 + 0x20200000 till 0x100000? + 0x30000000??.
//
// For slide = 0x80~0xFF on Other CPUs from
// 0x100000 + 0x10000000 till 0x100000 + 0x1FE00000.
//
 
#define RT_RELOC_PROTECT_MAX_NUM  ((UINTN) 64)
 
#define RT_DESC_ENTRY_NUM  ((UINTN) 64)
 
#define KERNEL_STATIC_VADDR  ((UINT64) 0xFFFFFF8000000000ULL)
 
#define KERNEL_HIB_VADDR  ((UINTN) (0xFFFFFF8000100000ULL & MAX_UINTN))
 
#define KERNEL_TEXT_VADDR  ((UINTN) (0xFFFFFF8000200000ULL & MAX_UINTN))
 
#define KERNEL_TEXT_VADDR_LEGACY  0x111000
 
#define KERNEL_BASE_PADDR  ((UINT32) (KERNEL_HIB_VADDR & MAX_UINT32))
 
#define KERNEL_TEXT_PADDR  ((UINT32) (KERNEL_TEXT_VADDR & MAX_UINT32))
 
#define KERNEL_TEXT_PADDR_LEGACY  (KERNEL_TEXT_VADDR_LEGACY)
 
#define SLIDE_GRANULARITY  ((UINTN) SIZE_2MB)
 
#define TOTAL_SLIDE_NUM  ((UINTN) 0x100)
 
#define SLIDE_ERRATA_NUM  ((UINTN) 0x80)
 
#define SLIDE_ERRATA_SKIP_RANGE  ((UINTN) 0x10200000)
 
#define ESTIMATED_KERNEL_SIZE  ((UINTN) (200 * SIZE_1MB))
 
#define ESTIMATED_CALL_GATE_SIZE  256
 
#define CALL_GATE_JUMP_SIZE  (sizeof (CALL_GATE_JUMP))
 
/*
  Minimum size of the patched call gate.
*/
#define CALL_GATE_MIN_SIZE  (ESTIMATED_CALL_GATE_SIZE + CALL_GATE_JUMP_SIZE)
 
#pragma pack(push,1)
typedef struct CALL_GATE_JUMP_ {
  struct {
    UINT8     Command[3];
    UINT32    Argument;
  } LeaRip;
  struct {
    UINT16    Command;
    UINT32    Argument;
    UINT64    Address;
  } Jmp;
} CALL_GATE_JUMP;
STATIC_ASSERT (sizeof (CALL_GATE_JUMP) == 7 + 14, "Invalid CALL_GATE_JUMP size");
#pragma pack(pop)
 
typedef
UINTN
(EFIAPI *KERNEL_CALL_GATE)(
  IN UINTN    Arg1,
  IN UINTN    Arg2
  );
 
typedef
UINTN
(EFIAPI *RELOCATION_CALL_GATE)(
  IN UINTN                  QWordCount,
  IN UINTN                  EntryPoint,
  IN EFI_PHYSICAL_ADDRESS   Source,
  IN UINTN                  Args
  );
 
typedef struct RT_RELOC_PROTECT_INFO_ {
  EFI_PHYSICAL_ADDRESS    PhysicalStart;
  EFI_PHYSICAL_ADDRESS    PhysicalEnd;
  EFI_MEMORY_TYPE         Type;
} RT_RELOC_PROTECT_INFO;
 
typedef struct RT_RELOC_PROTECT_DATA_ {
  UINTN                    NumEntries;
  RT_RELOC_PROTECT_INFO    RelocInfo[RT_RELOC_PROTECT_MAX_NUM];
} RT_RELOC_PROTECT_DATA;
 
typedef struct UEFI_SERVICES_POINTERS_ {
  EFI_ALLOCATE_PAGES        AllocatePages;
  EFI_FREE_PAGES            FreePages;
  EFI_GET_MEMORY_MAP        GetMemoryMap;
  EFI_ALLOCATE_POOL         AllocatePool;
  EFI_FREE_POOL             FreePool;
  EFI_EXIT_BOOT_SERVICES    ExitBootServices;
  EFI_IMAGE_LOAD            LoadImage;
  EFI_IMAGE_START           StartImage;
  EFI_GET_VARIABLE          GetVariable;
} UEFI_SERVICES_POINTERS;
 
typedef struct SERVICES_OVERRIDE_STATE_ {
  EFI_EVENT                       GetVariableEvent;
  OC_FIRMWARE_RUNTIME_PROTOCOL    *FwRuntime;
  EFI_PHYSICAL_ADDRESS         OldKernelCallGate;
  UINTN                        MemoryMapDescriptorSize;
  UINTN                        AppleBootNestedCount;
  EFI_LOADED_IMAGE_PROTOCOL    *LastAppleBootImage;
  BOOLEAN                      AppleHibernateWake;
  BOOLEAN                      AppleCustomSlide;
  BOOLEAN                      ReportedMmio;
  BOOLEAN                      AwaitingPerfAlloc;
} SERVICES_OVERRIDE_STATE;
 
typedef struct KERNEL_SUPPORT_STATE_ {
  EFI_PHYSICAL_ADDRESS       SysTableRtArea;
  UINTN                      SysTableRtAreaSize;
  EFI_CONFIGURATION_TABLE    *ConfigurationTable;
  OC_VMEM_CONTEXT            VmContext;
  EFI_MEMORY_DESCRIPTOR      VmMap[RT_DESC_ENTRY_NUM];
  UINTN                      VmMapSize;
  UINTN                      VmMapDescSize;
  EFI_PHYSICAL_ADDRESS    RelocationBlock;
  UINTN                   RelocationBlockUsed;
  BOOLEAN                 RelocationBlockLegacy;
} KERNEL_SUPPORT_STATE;
 
typedef struct SLIDE_SUPPORT_STATE_ {
  BOOLEAN    HasMemoryMapAnalysis;
  BOOLEAN    HasSandyOrIvy;
  BOOLEAN    HasCsrActiveConfig;
  BOOLEAN    HasBootArgs;
  UINT32     CsrActiveConfig;
  UINT8      ProvideMaxSlide;
  UINT8      ValidSlides[TOTAL_SLIDE_NUM];
  UINT32     ValidSlideCount;
  CHAR8      BootArgs[BOOT_LINE_LENGTH];
  UINTN      BootArgsSize;
  UINTN      EstimatedKernelArea;
} SLIDE_SUPPORT_STATE;
 
typedef struct BOOT_COMPAT_CONTEXT_ {
  OC_ABC_SETTINGS            Settings;
  RT_RELOC_PROTECT_DATA      RtReloc;
  UEFI_SERVICES_POINTERS     ServicePtrs;
  SERVICES_OVERRIDE_STATE    ServiceState;
  KERNEL_SUPPORT_STATE       KernelState;
  SLIDE_SUPPORT_STATE        SlideSupport;
  OC_CPU_INFO                *CpuInfo;
} BOOT_COMPAT_CONTEXT;
 
BOOT_COMPAT_CONTEXT *
GetBootCompatContext (
  VOID
  );
 
VOID
InstallServiceOverrides (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat
  );
 
VOID
AppleMapPrepareMemoryPool (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat
  );
 
VOID
AppleMapPrepareBooterState (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat,
  IN OUT EFI_LOADED_IMAGE     *LoadedImage,
  IN     EFI_GET_MEMORY_MAP   GetMemoryMap  OPTIONAL
  );
 
VOID
AppleMapPrepareKernelJump32 (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat
  );
 
VOID
AppleMapPrepareKernelJump64 (
  IN OUT BOOT_COMPAT_CONTEXT   *BootCompat,
  IN     EFI_PHYSICAL_ADDRESS  CallGate,
  IN     UINTN                 HookAddress
  );
 
VOID
AppleMapPrepareForBooting (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat,
  IN OUT VOID                 *BootArgs
  );
 
VOID
AppleMapPrepareForHibernateWake (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat,
  IN     UINTN                ImageHeaderPage
  );
 
EFI_STATUS
AppleMapPrepareMemState (
  IN OUT BOOT_COMPAT_CONTEXT    *BootCompat,
  IN     UINTN                  MemoryMapSize,
  IN     UINTN                  DescriptorSize,
  IN     UINT32                 DescriptorVersion,
  IN     EFI_MEMORY_DESCRIPTOR  *MemoryMap
  );
 
VOID
AsmAppleMapPrepareKernelState32 (
  VOID
  );
 
UINTN
EFIAPI
AppleMapPrepareKernelState32 (
  IN UINTN  Args
  );
 
EFI_STATUS
EFIAPI
AppleMapPrepareKernelStateNew64 (
  IN     UINTN                       SystemTable,
  IN OUT APPLE_EFI_BOOT_RT_KCG_ARGS  *KcgArguments,
  IN     KERNEL_CALL_GATE            CallGate
  );
 
UINTN
EFIAPI
AppleMapPrepareKernelStateOld64 (
  IN UINTN             Args,
  IN UINTN             EntryPoint,
  IN KERNEL_CALL_GATE  CallGate
  );
 
VOID
AppleSlideUnlockForSafeMode (
  IN OUT UINT8  *ImageBase,
  IN     UINTN  ImageSize
  );
 
EFI_STATUS
AppleSlideGetVariable (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat,
  IN     EFI_GET_VARIABLE     GetVariable,
  IN     EFI_GET_MEMORY_MAP   GetMemoryMap  OPTIONAL,
  IN     OC_MEMORY_FILTER     FilterMap     OPTIONAL,
  IN     VOID                 *FilterMapContext  OPTIONAL,
  IN     CHAR16               *VariableName,
  IN     EFI_GUID             *VendorGuid,
  OUT UINT32                  *Attributes   OPTIONAL,
  IN OUT UINTN                *DataSize,
  OUT VOID                    *Data
  );
 
VOID
AppleSlideRestore (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat,
  IN OUT OC_BOOT_ARGUMENTS    *BootArgs
  );
 
UINTN
AppleSlideGetRelocationSize (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat
  );
 
EFI_STATUS
AppleRelocationAllocatePages (
  IN OUT BOOT_COMPAT_CONTEXT   *BootCompat,
  IN     EFI_GET_MEMORY_MAP    GetMemoryMap,
  IN     EFI_ALLOCATE_PAGES    AllocatePages,
  IN     UINTN                 NumberOfPages,
  IN OUT EFI_PHYSICAL_ADDRESS  *Memory
  );
 
EFI_STATUS
AppleRelocationRelease (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat
  );
 
EFI_STATUS
AppleRelocationVirtualize (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat,
  IN OUT OC_BOOT_ARGUMENTS    *BA
  );
 
VOID
AppleRelocationRebase (
  IN OUT BOOT_COMPAT_CONTEXT  *BootCompat,
  IN OUT OC_BOOT_ARGUMENTS    *BA
  );
 
VOID
AppleRelocationCallGate64 (
  IN OUT UINTN                *Args,
  IN     BOOT_COMPAT_CONTEXT  *BootCompat,
  IN     KERNEL_CALL_GATE     CallGate,
  IN     UINTN                *KcgArg1,
  IN     UINTN                KcgArg2
  );
 
#endif // BOOT_COMPAT_INTERNAL_H