AppleVariable.h File Reference

#include <Uefi.h>

Go to the source code of this file.

Macros
#define	APPLE_VENDOR_VARIABLE_GUID
#define	APPLE_BOOT_VARIABLE_GUID
#define	APPLE_CORE_STORAGE_VARIABLE_GUID
#define	APPLE_TAMPER_RESISTANT_BOOT_VARIABLE_GUID
#define	APPLE_TAMPER_RESISTANT_BOOT_EFI_USER_GUID
#define	APPLE_WIRELESS_NETWORK_VARIABLE_GUID
#define	APPLE_PERSONALIZATION_VARIABLE_GUID
#define	APPLE_TAMPER_RESISTANT_BOOT_SECURE_VARIABLE_GUID
#define	APPLE_NETBOOT_VARIABLE_GUID
#define	APPLE_SECURITY_VARIABLE_GUID
#define	APPLE_SECURE_BOOT_VARIABLE_GUID
#define	APPLE_STARTUP_MANAGER_VARIABLE_GUID
#define	APPLE_BACKUP_BOOT_VARIABLE_GUID
#define	APPLE_UI_SCALE_VARIABLE_NAME   L"UIScale"
#define	APPLE_DEFAULT_BACKGROUND_COLOR_VARIABLE_NAME   L"DefaultBackgroundColor"
#define	APPLE_PICKER_ENTRY_REASON_VARIABLE_NAME   L"PickerEntryReason"
#define	APPLE_SYSTEM_AUDIO_VOLUME_MUTED   BIT7
#define	APPLE_SYSTEM_AUDIO_VOLUME_VOLUME_MASK   0x7FU
#define	APPLE_SYSTEM_AUDIO_VOLUME_DB_MIN   (-128)
#define	APPLE_SYSTEM_AUDIO_VOLUME_DB_MAX   (127)
#define	APPLE_SYSTEM_AUDIO_VOLUME_VARIABLE_NAME   L"SystemAudioVolume"
#define	APPLE_SYSTEM_AUDIO_VOLUME_SAVED_VARIABLE_NAME   L"SystemAudioVolumeSaved"
#define	APPLE_SYSTEM_AUDIO_VOLUME_DB_VARIABLE_NAME   L"SystemAudioVolumeDB"
#define	APPLE_PREV_LANG_KBD_VARIABLE_NAME   L"prev-lang:kbd"
#define	APPLE_EFI_BOOT_PERF_VARIABLE_NAME   L"efiboot-perf-record"
#define	APPLE_EFI_BOOT_PERF_ADDRESS_VARIABLE_NAME   L"efiboot-perf-record-data"
#define	APPLE_EFI_BOOT_PERF_SIZE_VARIABLE_NAME   L"efiboot-perf-record-data-size"
#define	APPLE_WAKE_FAILURE_VARIABLE_NAME   L"wake-failure"
#define	APPLE_UEFI_WINDOWS_BOOT_CAPABLE_VARIABLE_NAME   L"UEFIWindowsBootCapable"
#define	APPLE_INSTALL_WINDOWS_UEFI_VARIABLE_NAME   L"InstallWindowsUEFI"
#define	APPLE_PANIC_INFO_NO_VARIABLE_NAME   L"AAPL,PanicInfo%04x"
#define	APPLE_FORCE_DISPLAY_ROTATION_VARIABLE_NAME   L"ForceDisplayRotationInEFI"
#define	APPLE_BOOT_CAMP_HD_VARIABLE_NAME   L"BootCampHD"
#define	APPLE_RECOVERY_BOOT_MODE_VARIABLE_NAME   L"recovery-boot-mode"
#define	APPLE_STARTUP_MUTE_VARIABLE_NAME   L"StartupMute"
#define	APPLE_RESET_NVRAM_VARIABLE_NAME   L"ResetNVRam"
#define	APPLE_RECOVERY_BOOT_INITIATOR_VARIABLE_NAME   L"RecoveryBootInitiator"
#define	APPLE_BRIDGE_OS_HARDWARE_MODEL_VARIABLE_NAME   L"BridgeOSHardwareModel"

Enumerations
enum	APPLE_PICKER_ENTRY_REASON {   ApplePickerEntryReasonUnknown = 0 , ApplePickerEntryReasonManufacturingMode = 1 , ApplePickerEntryReasonNvram = 2 , ApplePickerEntryReasonLeftOptKeyPress = 3 ,   ApplePickerEntryReasonRightOptKeyPress = 4 , ApplePickerEntryReasonBootDeviceTimeout = 5 }

Variables
EFI_GUID	gAppleVendorVariableGuid
EFI_GUID	gAppleBootVariableGuid
EFI_GUID	gAppleCoreStorageVariableGuid
EFI_GUID	gAppleTamperResistantBootVariableGuid
EFI_GUID	gAppleWirelessNetworkVariableGuid
EFI_GUID	gApplePersonalizationVariableGuid
EFI_GUID	gAppleTamperResistantBootSecureVariableGuid
EFI_GUID	gAppleTamperResistantBootEfiUserVariableGuid
EFI_GUID	gAppleNetbootVariableGuid
EFI_GUID	gAppleSecurityVariableGuid
EFI_GUID	gAppleSecureBootVariableGuid
EFI_GUID	gAppleStartupManagerVariableGuid
EFI_GUID	gAppleBackupBootVariableGuid

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 AppleVariable.h.

Macro Definition Documentation

APPLE_BACKUP_BOOT_VARIABLE_GUID

#define APPLE_BACKUP_BOOT_VARIABLE_GUID

Value:

  { 0xA5CE328C, 0x769D, 0x11E9,              \
    { 0x94, 0xC7, 0x8C, 0x85, 0x90, 0x6B, 0xAC, 0x48 } }

The Apple Boot Variable Backup-vendor GUID.

Definition at line 105 of file AppleVariable.h.

APPLE_BOOT_CAMP_HD_VARIABLE_NAME

#define APPLE_BOOT_CAMP_HD_VARIABLE_NAME   L"BootCampHD"

BootCampt device path. UEFI Device Path. gAppleBootVariableGuid

Definition at line 234 of file AppleVariable.h.

APPLE_BOOT_VARIABLE_GUID

#define APPLE_BOOT_VARIABLE_GUID

Value:

  { 0x7C436110, 0xAB2A, 0x4BBB,   \
    { 0xA8, 0x80, 0xFE, 0x41, 0x99, 0x5C, 0x9F, 0x82 } }

The Apple boot Variable-vendor GUID.

Definition at line 28 of file AppleVariable.h.

APPLE_BRIDGE_OS_HARDWARE_MODEL_VARIABLE_NAME

#define APPLE_BRIDGE_OS_HARDWARE_MODEL_VARIABLE_NAME   L"BridgeOSHardwareModel"

Bridge OS hardware model variable used to propagate to IODT bridge-model by EfiBoot. Read by hw.target sysctl, used by SoftwareUpdateCoreSupport. Uppercase ASCII string with \0 terminator (e.g. J137AP). gAppleVendorVariableGuid

Definition at line 277 of file AppleVariable.h.

APPLE_CORE_STORAGE_VARIABLE_GUID

#define APPLE_CORE_STORAGE_VARIABLE_GUID

Value:

  { 0x8D63D4FE, 0xBD3C, 0x4AAD,           \
    { 0x88, 0x1D, 0x86, 0xFD, 0x97, 0x4B, 0xC1, 0xDF } }

The Apple Core Storage Variable-vendor GUID.

Definition at line 35 of file AppleVariable.h.

APPLE_DEFAULT_BACKGROUND_COLOR_VARIABLE_NAME

#define APPLE_DEFAULT_BACKGROUND_COLOR_VARIABLE_NAME   L"DefaultBackgroundColor"

User interface scale variable. UINT32: RGBA gAppleVendorVariableGuid

Definition at line 121 of file AppleVariable.h.

APPLE_EFI_BOOT_PERF_ADDRESS_VARIABLE_NAME

#define APPLE_EFI_BOOT_PERF_ADDRESS_VARIABLE_NAME   L"efiboot-perf-record-data"

Performance record data address. UINT32: Physical address to EfiACPIReclaimMemory containing perf data. gAppleBootVariableGuid

Definition at line 185 of file AppleVariable.h.

APPLE_EFI_BOOT_PERF_SIZE_VARIABLE_NAME

#define APPLE_EFI_BOOT_PERF_SIZE_VARIABLE_NAME   L"efiboot-perf-record-data-size"

Performance record data size. UINT32: Size of performance record data, usually 4096 bytes. gAppleBootVariableGuid

Definition at line 192 of file AppleVariable.h.

APPLE_EFI_BOOT_PERF_VARIABLE_NAME

#define APPLE_EFI_BOOT_PERF_VARIABLE_NAME   L"efiboot-perf-record"

Performance record data enable. UINT8: Any value to enable performance gathering (one time). gAppleBootVariableGuid

Definition at line 178 of file AppleVariable.h.

APPLE_FORCE_DISPLAY_ROTATION_VARIABLE_NAME

#define APPLE_FORCE_DISPLAY_ROTATION_VARIABLE_NAME   L"ForceDisplayRotationInEFI"

Set display rotation angle. UINT32: 0, 90, 180, 270. gAppleBootVariableGuid

Definition at line 227 of file AppleVariable.h.

APPLE_INSTALL_WINDOWS_UEFI_VARIABLE_NAME

#define APPLE_INSTALL_WINDOWS_UEFI_VARIABLE_NAME   L"InstallWindowsUEFI"

Will install UEFI Windows on next reboot. CHAR8: '1'. gAppleBootVariableGuid

Definition at line 213 of file AppleVariable.h.

APPLE_NETBOOT_VARIABLE_GUID

#define APPLE_NETBOOT_VARIABLE_GUID

Value:

  { 0x37BCBEC7, 0xA645, 0x4215,      \
    { 0x97, 0x9E, 0xF5, 0xAE, 0x4D, 0x11, 0x5F, 0x13 } }

The Apple Netboot Variable-vendor GUID.

Definition at line 77 of file AppleVariable.h.

APPLE_PANIC_INFO_NO_VARIABLE_NAME

#define APPLE_PANIC_INFO_NO_VARIABLE_NAME   L"AAPL,PanicInfo%04x"

7-bit packed panic information. Data blob from with indices in the range of [0000, 0400). gAppleBootVariableGuid

Definition at line 220 of file AppleVariable.h.

APPLE_PERSONALIZATION_VARIABLE_GUID

#define APPLE_PERSONALIZATION_VARIABLE_GUID

Value:

  { 0xFA4CE28D, 0xB62F, 0x4C99,              \
    { 0x9C, 0xC3, 0x68, 0x15, 0x68, 0x6E, 0x30, 0xF9 } }

The Apple Personalization Variable-vendor GUID.

Definition at line 63 of file AppleVariable.h.

APPLE_PICKER_ENTRY_REASON_VARIABLE_NAME

#define APPLE_PICKER_ENTRY_REASON_VARIABLE_NAME   L"PickerEntryReason"

BootPicker startup mode. UINT32: APPLE_PICKER_ENTRY_REASON. gAppleVendorVariableGuid

Definition at line 137 of file AppleVariable.h.

APPLE_PREV_LANG_KBD_VARIABLE_NAME

#define APPLE_PREV_LANG_KBD_VARIABLE_NAME   L"prev-lang:kbd"

System language. CHAR8[] String starting with language code (e.g. ru-RU:252). gAppleBootVariableGuid

Definition at line 171 of file AppleVariable.h.

APPLE_RECOVERY_BOOT_INITIATOR_VARIABLE_NAME

#define APPLE_RECOVERY_BOOT_INITIATOR_VARIABLE_NAME   L"RecoveryBootInitiator"

Recovery initiator device path. In general EfiBoot device path that called reboot to recovery. gAppleVendorVariableGuid

Definition at line 269 of file AppleVariable.h.

APPLE_RECOVERY_BOOT_MODE_VARIABLE_NAME

#define APPLE_RECOVERY_BOOT_MODE_VARIABLE_NAME   L"recovery-boot-mode"

Boot recovery once on the next restart in the specified mode in ASCII (not null-terminated):

• locked — standard reboot (boot-feature-usage BIT6)
• guest — triggered by EfiBoot to perform FV2 "guest" recovery (boot-feature-usage BIT7)
• fde-recovery — triggered by EfiBoot to perform FV2 recovery
• fde-password-reset — triggered by EfiBoot to perform FV2 password reset
• unused — seems to be unused by the firmware, but used often by the users
• secure-boot — triggered by EfiBoot to perform recovery after SB failure gAppleBootVariableGuid

Definition at line 247 of file AppleVariable.h.

APPLE_RESET_NVRAM_VARIABLE_NAME

#define APPLE_RESET_NVRAM_VARIABLE_NAME   L"ResetNVRam"

Resets NVRAM and potentially perform garbage collection etc. on next boot, on supported macOS firmware. Any size, any value: Not present (no action, default), or present (reset NVRAM). gAppleBootVariableGuid

Definition at line 262 of file AppleVariable.h.

APPLE_SECURE_BOOT_VARIABLE_GUID

#define APPLE_SECURE_BOOT_VARIABLE_GUID

Value:

  { 0x94B73556, 0x2197, 0x4702,          \
    { 0x82, 0xA8, 0x3E, 0x13, 0x37, 0xDA, 0xFB, 0xFB } }

The Apple Secure Boot Variable-vendor GUID.

Definition at line 91 of file AppleVariable.h.

APPLE_SECURITY_VARIABLE_GUID

#define APPLE_SECURITY_VARIABLE_GUID

Value:

  { 0x7870DBED, 0x151D, 0x63FE,      \
    { 0xF5, 0x88, 0x7C, 0x69, 0x94, 0x1C, 0xD0, 0x7B } }

The Apple Security-vendor GUID.

Definition at line 84 of file AppleVariable.h.

APPLE_STARTUP_MANAGER_VARIABLE_GUID

#define APPLE_STARTUP_MANAGER_VARIABLE_GUID

Value:

  { 0x5EEB160F, 0x45FB, 0x4CE9,              \
    { 0xB4, 0xE3, 0x61, 0x03, 0x59, 0xAB, 0xF6, 0xF8 } }

The Apple Startup Manager Variable-vendor GUID.

Definition at line 98 of file AppleVariable.h.

APPLE_STARTUP_MUTE_VARIABLE_NAME

#define APPLE_STARTUP_MUTE_VARIABLE_NAME   L"StartupMute"

Startup sound configuration variable. UINT8: 00 or not present (unmuted, default), any non-zero value (muted). gAppleBootVariableGuid

Definition at line 254 of file AppleVariable.h.

APPLE_SYSTEM_AUDIO_VOLUME_DB_MAX

#define APPLE_SYSTEM_AUDIO_VOLUME_DB_MAX   (127)

Definition at line 143 of file AppleVariable.h.

APPLE_SYSTEM_AUDIO_VOLUME_DB_MIN

#define APPLE_SYSTEM_AUDIO_VOLUME_DB_MIN   (-128)

Definition at line 142 of file AppleVariable.h.

APPLE_SYSTEM_AUDIO_VOLUME_DB_VARIABLE_NAME

#define APPLE_SYSTEM_AUDIO_VOLUME_DB_VARIABLE_NAME   L"SystemAudioVolumeDB"

System audio volume in decibels, created by AppleHDA.kext. UINT8: SystemAudioVolumeDB gAppleBootVariableGuid

Definition at line 164 of file AppleVariable.h.

APPLE_SYSTEM_AUDIO_VOLUME_MUTED

#define APPLE_SYSTEM_AUDIO_VOLUME_MUTED   BIT7

Definition at line 139 of file AppleVariable.h.

APPLE_SYSTEM_AUDIO_VOLUME_SAVED_VARIABLE_NAME

#define APPLE_SYSTEM_AUDIO_VOLUME_SAVED_VARIABLE_NAME   L"SystemAudioVolumeSaved"

System audio volume backup, restored by AppleEFIRuntime.kext at next reboot. UINT8: APPLE_SYSTEM_AUDIO_VOLUME_VOLUME_MASK | APPLE_SYSTEM_AUDIO_VOLUME_VOLUME_MASK gAppleBootVariableGuid

Definition at line 157 of file AppleVariable.h.

APPLE_SYSTEM_AUDIO_VOLUME_VARIABLE_NAME

#define APPLE_SYSTEM_AUDIO_VOLUME_VARIABLE_NAME   L"SystemAudioVolume"

System audio volume. UINT8: APPLE_SYSTEM_AUDIO_VOLUME_MUTED | APPLE_SYSTEM_AUDIO_VOLUME_VOLUME_MASK gAppleBootVariableGuid

Definition at line 150 of file AppleVariable.h.

APPLE_SYSTEM_AUDIO_VOLUME_VOLUME_MASK

#define APPLE_SYSTEM_AUDIO_VOLUME_VOLUME_MASK   0x7FU

Definition at line 140 of file AppleVariable.h.

APPLE_TAMPER_RESISTANT_BOOT_EFI_USER_GUID

#define APPLE_TAMPER_RESISTANT_BOOT_EFI_USER_GUID

Value:

  { 0x4E8023FF, 0xA79A, 0x47D1,                    \
    { 0xA3, 0x42, 0x75, 0x24, 0xCF, 0xC9, 0x6D, 0xC4 } }

The Apple TRB EFI User GUID.

Definition at line 49 of file AppleVariable.h.

APPLE_TAMPER_RESISTANT_BOOT_SECURE_VARIABLE_GUID

#define APPLE_TAMPER_RESISTANT_BOOT_SECURE_VARIABLE_GUID

Value:

  { 0xF68DA75E, 0x1B55, 0x4E70,                           \
    { 0xB4, 0x1B, 0xA7, 0xB7, 0xA5, 0xB7, 0x58, 0xEA } }

The Apple TRB Secure Variable-vendor GUID.

Definition at line 70 of file AppleVariable.h.

APPLE_TAMPER_RESISTANT_BOOT_VARIABLE_GUID

#define APPLE_TAMPER_RESISTANT_BOOT_VARIABLE_GUID

Value:

  { 0x5D62B28D, 0x6ED2, 0x40B4,                    \
    { 0xA5, 0x60, 0x6C, 0xD7, 0x9B, 0x93, 0xD3, 0x66 } }

The Apple TRB Variable-vendor GUID.

Definition at line 42 of file AppleVariable.h.

APPLE_UEFI_WINDOWS_BOOT_CAPABLE_VARIABLE_NAME

#define APPLE_UEFI_WINDOWS_BOOT_CAPABLE_VARIABLE_NAME   L"UEFIWindowsBootCapable"

Force enable UEFI Windows support. CHAR8: '1'. gAppleBootVariableGuid

Definition at line 206 of file AppleVariable.h.

APPLE_UI_SCALE_VARIABLE_NAME

#define APPLE_UI_SCALE_VARIABLE_NAME   L"UIScale"

User interface scale variable UINT8: 1 or 2 gAppleVendorVariableGuid

Definition at line 114 of file AppleVariable.h.

APPLE_VENDOR_VARIABLE_GUID

#define APPLE_VENDOR_VARIABLE_GUID

Value:

  { 0x4D1EDE05, 0x38C7, 0x4A6A,     \
    { 0x9C, 0xC6, 0x4B, 0xCC, 0xA8, 0xB3, 0x8C, 0x14 } }

The Apple Vendor Variable-vendor GUID.

Definition at line 21 of file AppleVariable.h.

APPLE_WAKE_FAILURE_VARIABLE_NAME

#define APPLE_WAKE_FAILURE_VARIABLE_NAME   L"wake-failure"

Hibernation wake log (mirror for APPLE_RTC_WAKE_LOG_ADDR). UINT8[4]: Normally printed like 0x%02X 0x%02X % 3d 0x%02X. gAppleBootVariableGuid

Definition at line 199 of file AppleVariable.h.

APPLE_WIRELESS_NETWORK_VARIABLE_GUID

#define APPLE_WIRELESS_NETWORK_VARIABLE_GUID

Value:

  { 0x36C28AB5, 0x6566, 0x4C50,               \
    { 0x9E, 0xBD, 0xCB, 0xB9, 0x20, 0xF8, 0x38, 0x43 } }

The Apple WiFi Network Variable-vendor GUID.

Definition at line 56 of file AppleVariable.h.

Enumeration Type Documentation

APPLE_PICKER_ENTRY_REASON

enum APPLE_PICKER_ENTRY_REASON

Enumerator
ApplePickerEntryReasonUnknown	Unknown.
ApplePickerEntryReasonManufacturingMode	IR Remote.
ApplePickerEntryReasonNvram	NVRAM.
ApplePickerEntryReasonLeftOptKeyPress	Left Option.
ApplePickerEntryReasonRightOptKeyPress	Right Option.
ApplePickerEntryReasonBootDeviceTimeout	BDS Timeout.

Definition at line 123 of file AppleVariable.h.

Variable Documentation

gAppleBackupBootVariableGuid

EFI_GUID gAppleBackupBootVariableGuid

extern

A global variable storing the GUID of the APPLE_BACKUP_BOOT variable scope.

gAppleBootVariableGuid

EFI_GUID gAppleBootVariableGuid

extern

A global variable storing the GUID of the APPLE_BOOT EFI variable scope. AKA gAppleEFINVRAMGuid

Definition at line 8 of file UserGlobalVar.c.

gAppleCoreStorageVariableGuid

EFI_GUID gAppleCoreStorageVariableGuid

extern

A global variable storing the GUID of the APPLE_CORE_STORAGE EFI variable scope.

gAppleNetbootVariableGuid

EFI_GUID gAppleNetbootVariableGuid

extern

A global variable storing the GUID of the APPLE_NETBOOT EFI variable scope.

gApplePersonalizationVariableGuid

EFI_GUID gApplePersonalizationVariableGuid

extern

A global variable storing the GUID of the APPLE_PERSONALIZATION EFI variable scope.

gAppleSecureBootVariableGuid

EFI_GUID gAppleSecureBootVariableGuid

extern

A global variable storing the GUID of the APPLE_SECURE_BOOT_VARIABLE_GUID EFI variable scope.

Definition at line 59 of file UserGlobalVar.c.

gAppleSecurityVariableGuid

EFI_GUID gAppleSecurityVariableGuid

extern

A global variable storing the GUID of the APPLE_SECURITY EFI variable scope.

gAppleStartupManagerVariableGuid

EFI_GUID gAppleStartupManagerVariableGuid

extern

A global variable storing the GUID of the APPLE_STARTUP_MANAGER variable scope.

gAppleTamperResistantBootEfiUserVariableGuid

EFI_GUID gAppleTamperResistantBootEfiUserVariableGuid

extern

A global variable storing the GUID of the APPLE_TAMPER_RESISTANT_BOOT_EFI_USER_VARIABLE_GUID EFI variable scope.

gAppleTamperResistantBootSecureVariableGuid

EFI_GUID gAppleTamperResistantBootSecureVariableGuid

extern

A global variable storing the GUID of the APPLE_TAMPER_RESISTANT_BOOT_SECURE_VARIABLE_GUID EFI variable scope. AKA gAppleEFINVRAMTRBSecureVariableGuid.

gAppleTamperResistantBootVariableGuid

EFI_GUID gAppleTamperResistantBootVariableGuid

extern

A global variable storing the GUID of the APPLE_TAMPER_RESISTANT_BOOT EFI variable scope. AKA gAppleEFINVRAMTRBStagingCommandGuid.

gAppleVendorVariableGuid

EFI_GUID gAppleVendorVariableGuid

extern

A global variable storing the GUID of the APPLE_VENDOR EFI variable scope.

Definition at line 38 of file UserGlobalVar.c.

gAppleWirelessNetworkVariableGuid

EFI_GUID gAppleWirelessNetworkVariableGuid

extern

A global variable storing the GUID of the APPLE_WIRELESS_NETWORK EFI variable scope.