AppleBootPolicy.h

Go to the documentation of this file.

 
#ifndef APPLE_BOOT_POLICY_H
#define APPLE_BOOT_POLICY_H
 
#include <Protocol/SimpleFileSystem.h>
 
#define APPLE_BOOT_POLICY_PROTOCOL_REVISION  0x00000003
 
#define APPLE_BOOT_POLICY_PROTOCOL_GUID  \
  { 0x62257758, 0x350C, 0x4D0A,          \
    { 0xB0, 0xBD, 0xF6, 0xBE, 0x2E, 0x1E, 0x27, 0x2C } }
 
// BOOT_POLICY_GET_BOOT_FILE
 
typedef
EFI_STATUS
(EFIAPI *BOOT_POLICY_GET_BOOT_FILE)(
  IN     EFI_HANDLE                Device,
  IN OUT EFI_DEVICE_PATH_PROTOCOL  **FilePath
  );
 
//
// Neither is used at this moment.
// https://opensource.apple.com/source/kext_tools/kext_tools-528.220.8/KextAudit/efi_smc.h.auto.html
//
typedef enum {
  // Boot Policy not valid retry.
  BootPolicyNotReady,
 
  // Boot Selected macOS.
  BootPolicyOk,
 
  // Boot Recovery OS, update bridgeOS.
  BootPolicyUpdate,
 
  // Full system reboot, boot selected macOS.
  BootPolicyReboot,
 
  // Version unknown boot to recovery OS to get more info.
  BootPolicyUnknown,
 
  // Update failed take the failure path.
  BootPolicyBridgeOSUpdateFailed,
 
  // Boot Recovery OS to change security policy.
  BootPolicyRecoverySecurityPolicyUpdate,
 
  // Valid values will be less that this version.
  BootPolicyMaxValue
} BOOT_POLICY_ACTION;
 
typedef
EFI_STATUS
(EFIAPI *BOOT_POLICY_GET_BOOT_FILE_EX)(
  IN  EFI_HANDLE                Device,
  IN  BOOT_POLICY_ACTION        Action,
  OUT EFI_DEVICE_PATH_PROTOCOL  **FilePath
  );
 
typedef
EFI_STATUS
(EFIAPI *BOOT_POLICY_DEVICE_PATH_TO_DIR_PATH)(
  IN  EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  OUT CHAR16                    **BootPathName,
  OUT EFI_HANDLE                *Device,
  OUT EFI_HANDLE                *ApfsVolumeHandle
  );
 
typedef
EFI_STATUS
(EFIAPI *BOOT_POLICY_GET_APFS_RECOVERY_FILE_PATH)(
  IN  EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN  CONST CHAR16              *PathName,
  OUT CHAR16                    **FullPathName,
  OUT VOID                      **Reserved,
  OUT EFI_FILE_PROTOCOL         **Root,
  OUT EFI_HANDLE                *DeviceHandle
  );
 
typedef
EFI_STATUS
(EFIAPI *BOOT_POLICY_GET_ALL_APFS_RECOVERY_FILE_PATH)(
  IN  EFI_HANDLE  Handle,
  OUT VOID        **Volumes,
  OUT UINTN       *NumberOfEntries
  );
 
typedef struct {
  UINTN                                          Revision;                   
  BOOT_POLICY_GET_BOOT_FILE                      GetBootFile;                
  BOOT_POLICY_GET_BOOT_FILE_EX                   GetBootFileEx;              
  BOOT_POLICY_DEVICE_PATH_TO_DIR_PATH            DevicePathToDirPath;        
  BOOT_POLICY_GET_APFS_RECOVERY_FILE_PATH        GetApfsRecoveryFilePath;    
  BOOT_POLICY_GET_ALL_APFS_RECOVERY_FILE_PATH    GetAllApfsRecoveryFilePath; 
} APPLE_BOOT_POLICY_PROTOCOL;
 
extern EFI_GUID  gAppleBootPolicyProtocolGuid;
 
#endif // APPLE_BOOT_POLICY_H