AppleBootPolicy.h File Reference

#include <Protocol/SimpleFileSystem.h>

Go to the source code of this file.

Data Structures
struct	APPLE_BOOT_POLICY_PROTOCOL

Macros
#define	APPLE_BOOT_POLICY_PROTOCOL_REVISION   0x00000003
#define	APPLE_BOOT_POLICY_PROTOCOL_GUID

Typedefs
typedef EFI_STATUS(EFIAPI *	BOOT_POLICY_GET_BOOT_FILE) (IN EFI_HANDLE Device, IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath)
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)

Enumerations
enum	BOOT_POLICY_ACTION {   BootPolicyNotReady , BootPolicyOk , BootPolicyUpdate , BootPolicyReboot ,   BootPolicyUnknown , BootPolicyBridgeOSUpdateFailed , BootPolicyRecoverySecurityPolicyUpdate , BootPolicyMaxValue }

Variables
EFI_GUID	gAppleBootPolicyProtocolGuid

Detailed Description

Copyright (C) 2014 - 2017, Download-Fritz. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file AppleBootPolicy.h.

Macro Definition Documentation

APPLE_BOOT_POLICY_PROTOCOL_GUID

#define APPLE_BOOT_POLICY_PROTOCOL_GUID

Value:

  { 0x62257758, 0x350C, 0x4D0A,          \
    { 0xB0, 0xBD, 0xF6, 0xBE, 0x2E, 0x1E, 0x27, 0x2C } }

The GUID of the APPLE_BOOT_POLICY_PROTOCOL.

Definition at line 23 of file AppleBootPolicy.h.

APPLE_BOOT_POLICY_PROTOCOL_REVISION

#define APPLE_BOOT_POLICY_PROTOCOL_REVISION   0x00000003

Definition at line 18 of file AppleBootPolicy.h.

Typedef Documentation

BOOT_POLICY_DEVICE_PATH_TO_DIR_PATH

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)

Definition at line 96 of file AppleBootPolicy.h.

BOOT_POLICY_GET_ALL_APFS_RECOVERY_FILE_PATH

typedef EFI_STATUS(EFIAPI * BOOT_POLICY_GET_ALL_APFS_RECOVERY_FILE_PATH) (IN EFI_HANDLE Handle, OUT VOID **Volumes, OUT UINTN *NumberOfEntries)

Definition at line 116 of file AppleBootPolicy.h.

BOOT_POLICY_GET_APFS_RECOVERY_FILE_PATH

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)

Definition at line 105 of file AppleBootPolicy.h.

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)

Locates the bootable file of the given volume. Prefered are the values blessed, though if unavailable, hard-coded names are being verified and used if existing.

The blessed paths are to be determined by the HFS Driver via EFI_FILE_PROTOCOL.GetInfo(). The related identifier definitions are to be found in AppleBless.h.

Parameters

[in]	Device	The Device's Handle to perform the search on.
[out]	FilePath	A pointer to the device path pointer to set to the file path of the boot file.

Return values

EFI_NOT_FOUND	A bootable file could not be found on the given volume.
EFI_OUT_OF_RESOURCES	The memory necessary to complete the operation could not be allocated.
EFI_SUCCESS	The operation completed successfully and the BootFilePath Buffer has been filled.
other	The status of an operation used to complete this operation is returned.

Definition at line 51 of file AppleBootPolicy.h.

BOOT_POLICY_GET_BOOT_FILE_EX

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)

Definition at line 88 of file AppleBootPolicy.h.

Enumeration Type Documentation

BOOT_POLICY_ACTION

enum BOOT_POLICY_ACTION

Enumerator
BootPolicyNotReady
BootPolicyOk
BootPolicyUpdate
BootPolicyReboot
BootPolicyUnknown
BootPolicyBridgeOSUpdateFailed
BootPolicyRecoverySecurityPolicyUpdate
BootPolicyMaxValue

Definition at line 61 of file AppleBootPolicy.h.

Variable Documentation

gAppleBootPolicyProtocolGuid

EFI_GUID gAppleBootPolicyProtocolGuid

extern

A global variable storing the GUID of the APPLE_BOOT_POLICY_PROTOCOL.

Definition at line 35 of file UserGlobalVar.c.