iPXE
Macros | Functions | Variables
GlobalVariable.h File Reference

GUID for EFI (NVRAM) Variables. More...

Go to the source code of this file.

Macros

#define EFI_GLOBAL_VARIABLE
 
#define EFI_LANG_CODES_VARIABLE_NAME   L"LangCodes"
 The language codes that the firmware supports. More...
 
#define EFI_LANG_VARIABLE_NAME   L"Lang"
 The language code that the system is configured for. More...
 
#define EFI_TIME_OUT_VARIABLE_NAME   L"Timeout"
 The firmware's boot managers timeout, in seconds, before initiating the default boot selection. More...
 
#define EFI_PLATFORM_LANG_CODES_VARIABLE_NAME   L"PlatformLangCodes"
 The language codes that the firmware supports. More...
 
#define EFI_PLATFORM_LANG_VARIABLE_NAME   L"PlatformLang"
 The language code that the system is configured for. More...
 
#define EFI_CON_IN_VARIABLE_NAME   L"ConIn"
 The device path of the default input/output/error output console. More...
 
#define EFI_CON_OUT_VARIABLE_NAME   L"ConOut"
 
#define EFI_ERR_OUT_VARIABLE_NAME   L"ErrOut"
 
#define EFI_CON_IN_DEV_VARIABLE_NAME   L"ConInDev"
 The device path of all possible input/output/error output devices. More...
 
#define EFI_CON_OUT_DEV_VARIABLE_NAME   L"ConOutDev"
 
#define EFI_ERR_OUT_DEV_VARIABLE_NAME   L"ErrOutDev"
 
#define EFI_BOOT_ORDER_VARIABLE_NAME   L"BootOrder"
 The ordered boot option load list. More...
 
#define EFI_BOOT_NEXT_VARIABLE_NAME   L"BootNext"
 The boot option for the next boot only. More...
 
#define EFI_BOOT_CURRENT_VARIABLE_NAME   L"BootCurrent"
 The boot option that was selected for the current boot. More...
 
#define EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME   L"BootOptionSupport"
 The types of boot options supported by the boot manager. More...
 
#define EFI_DRIVER_ORDER_VARIABLE_NAME   L"DriverOrder"
 The ordered driver load option list. More...
 
#define EFI_SYS_PREP_ORDER_VARIABLE_NAME   L"SysPrepOrder"
 The ordered System Prep Application load option list. More...
 
#define EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME   L"HwErrRecSupport"
 Identifies the level of hardware error record persistence support implemented by the platform. More...
 
#define EFI_SETUP_MODE_NAME   L"SetupMode"
 Whether the system is operating in setup mode (1) or not (0). More...
 
#define EFI_KEY_EXCHANGE_KEY_NAME   L"KEK"
 The Key Exchange Key Signature Database. More...
 
#define EFI_PLATFORM_KEY_NAME   L"PK"
 The public Platform Key. More...
 
#define EFI_SIGNATURE_SUPPORT_NAME   L"SignatureSupport"
 Array of GUIDs representing the type of signatures supported by the platform firmware. More...
 
#define EFI_SECURE_BOOT_MODE_NAME   L"SecureBoot"
 Whether the platform firmware is operating in Secure boot mode (1) or not (0). More...
 
#define EFI_KEK_DEFAULT_VARIABLE_NAME   L"KEKDefault"
 The OEM's default Key Exchange Key Signature Database. More...
 
#define EFI_PK_DEFAULT_VARIABLE_NAME   L"PKDefault"
 The OEM's default public Platform Key. More...
 
#define EFI_DB_DEFAULT_VARIABLE_NAME   L"dbDefault"
 The OEM's default secure boot signature store. More...
 
#define EFI_DBX_DEFAULT_VARIABLE_NAME   L"dbxDefault"
 The OEM's default secure boot blacklist signature store. More...
 
#define EFI_DBT_DEFAULT_VARIABLE_NAME   L"dbtDefault"
 The OEM's default secure boot timestamp signature store. More...
 
#define EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME   L"OsIndicationsSupported"
 Allows the firmware to indicate supported features and actions to the OS. More...
 
#define EFI_OS_INDICATIONS_VARIABLE_NAME   L"OsIndications"
 Allows the OS to request the firmware to enable certain features and to take certain actions. More...
 
#define EFI_VENDOR_KEYS_VARIABLE_NAME   L"VendorKeys"
 Whether the system is configured to use only vendor provided keys or not. More...
 
#define EFI_DEVICE_AUTH_BOOT_MODE_NAME   L"devAuthBoot"
 Whether the platform firmware is operating in device authentication boot mode (1) or not (0). More...
 

Functions

 FILE_LICENCE (BSD2_PATENT)
 

Variables

EFI_GUID gEfiGlobalVariableGuid
 

Detailed Description

GUID for EFI (NVRAM) Variables.

Copyright (c) 2006 - 2024, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:
GUID defined in UEFI 2.1

Definition in file GlobalVariable.h.

Macro Definition Documentation

◆ EFI_GLOBAL_VARIABLE

#define EFI_GLOBAL_VARIABLE
Value:
{ \
0x8BE4DF61, 0x93CA, 0x11d2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C } \
}

Definition at line 16 of file GlobalVariable.h.

◆ EFI_LANG_CODES_VARIABLE_NAME

#define EFI_LANG_CODES_VARIABLE_NAME   L"LangCodes"

The language codes that the firmware supports.

This value is deprecated. Its attribute is BS+RT.

Definition at line 46 of file GlobalVariable.h.

◆ EFI_LANG_VARIABLE_NAME

#define EFI_LANG_VARIABLE_NAME   L"Lang"

The language code that the system is configured for.

This value is deprecated. Its attribute is NV+BS+RT.

Definition at line 51 of file GlobalVariable.h.

◆ EFI_TIME_OUT_VARIABLE_NAME

#define EFI_TIME_OUT_VARIABLE_NAME   L"Timeout"

The firmware's boot managers timeout, in seconds, before initiating the default boot selection.

Its attribute is NV+BS+RT.

Definition at line 56 of file GlobalVariable.h.

◆ EFI_PLATFORM_LANG_CODES_VARIABLE_NAME

#define EFI_PLATFORM_LANG_CODES_VARIABLE_NAME   L"PlatformLangCodes"

The language codes that the firmware supports.

Its attribute is BS+RT.

Definition at line 61 of file GlobalVariable.h.

◆ EFI_PLATFORM_LANG_VARIABLE_NAME

#define EFI_PLATFORM_LANG_VARIABLE_NAME   L"PlatformLang"

The language code that the system is configured for.

Its attribute is NV+BS+RT.

Definition at line 66 of file GlobalVariable.h.

◆ EFI_CON_IN_VARIABLE_NAME

#define EFI_CON_IN_VARIABLE_NAME   L"ConIn"

The device path of the default input/output/error output console.

Its attribute is NV+BS+RT.

Definition at line 71 of file GlobalVariable.h.

◆ EFI_CON_OUT_VARIABLE_NAME

#define EFI_CON_OUT_VARIABLE_NAME   L"ConOut"

Definition at line 72 of file GlobalVariable.h.

◆ EFI_ERR_OUT_VARIABLE_NAME

#define EFI_ERR_OUT_VARIABLE_NAME   L"ErrOut"

Definition at line 73 of file GlobalVariable.h.

◆ EFI_CON_IN_DEV_VARIABLE_NAME

#define EFI_CON_IN_DEV_VARIABLE_NAME   L"ConInDev"

The device path of all possible input/output/error output devices.

Its attribute is BS+RT.

Definition at line 78 of file GlobalVariable.h.

◆ EFI_CON_OUT_DEV_VARIABLE_NAME

#define EFI_CON_OUT_DEV_VARIABLE_NAME   L"ConOutDev"

Definition at line 79 of file GlobalVariable.h.

◆ EFI_ERR_OUT_DEV_VARIABLE_NAME

#define EFI_ERR_OUT_DEV_VARIABLE_NAME   L"ErrOutDev"

Definition at line 80 of file GlobalVariable.h.

◆ EFI_BOOT_ORDER_VARIABLE_NAME

#define EFI_BOOT_ORDER_VARIABLE_NAME   L"BootOrder"

The ordered boot option load list.

Its attribute is NV+BS+RT.

Definition at line 85 of file GlobalVariable.h.

◆ EFI_BOOT_NEXT_VARIABLE_NAME

#define EFI_BOOT_NEXT_VARIABLE_NAME   L"BootNext"

The boot option for the next boot only.

Its attribute is NV+BS+RT.

Definition at line 90 of file GlobalVariable.h.

◆ EFI_BOOT_CURRENT_VARIABLE_NAME

#define EFI_BOOT_CURRENT_VARIABLE_NAME   L"BootCurrent"

The boot option that was selected for the current boot.

Its attribute is BS+RT.

Definition at line 95 of file GlobalVariable.h.

◆ EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME

#define EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME   L"BootOptionSupport"

The types of boot options supported by the boot manager.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 100 of file GlobalVariable.h.

◆ EFI_DRIVER_ORDER_VARIABLE_NAME

#define EFI_DRIVER_ORDER_VARIABLE_NAME   L"DriverOrder"

The ordered driver load option list.

Its attribute is NV+BS+RT.

Definition at line 105 of file GlobalVariable.h.

◆ EFI_SYS_PREP_ORDER_VARIABLE_NAME

#define EFI_SYS_PREP_ORDER_VARIABLE_NAME   L"SysPrepOrder"

The ordered System Prep Application load option list.

Its attribute is NV+BS+RT.

Definition at line 110 of file GlobalVariable.h.

◆ EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME

#define EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME   L"HwErrRecSupport"

Identifies the level of hardware error record persistence support implemented by the platform.

This variable is only modified by firmware and is read-only to the OS. Its attribute is NV+BS+RT.

Definition at line 117 of file GlobalVariable.h.

◆ EFI_SETUP_MODE_NAME

#define EFI_SETUP_MODE_NAME   L"SetupMode"

Whether the system is operating in setup mode (1) or not (0).

All other values are reserved. Should be treated as read-only. Its attribute is BS+RT.

Definition at line 123 of file GlobalVariable.h.

◆ EFI_KEY_EXCHANGE_KEY_NAME

#define EFI_KEY_EXCHANGE_KEY_NAME   L"KEK"

The Key Exchange Key Signature Database.

Its attribute is NV+BS+RT+AT.

Definition at line 128 of file GlobalVariable.h.

◆ EFI_PLATFORM_KEY_NAME

#define EFI_PLATFORM_KEY_NAME   L"PK"

The public Platform Key.

Its attribute is NV+BS+RT+AT.

Definition at line 133 of file GlobalVariable.h.

◆ EFI_SIGNATURE_SUPPORT_NAME

#define EFI_SIGNATURE_SUPPORT_NAME   L"SignatureSupport"

Array of GUIDs representing the type of signatures supported by the platform firmware.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 139 of file GlobalVariable.h.

◆ EFI_SECURE_BOOT_MODE_NAME

#define EFI_SECURE_BOOT_MODE_NAME   L"SecureBoot"

Whether the platform firmware is operating in Secure boot mode (1) or not (0).

All other values are reserved. Should be treated as read-only. Its attribute is BS+RT.

Definition at line 145 of file GlobalVariable.h.

◆ EFI_KEK_DEFAULT_VARIABLE_NAME

#define EFI_KEK_DEFAULT_VARIABLE_NAME   L"KEKDefault"

The OEM's default Key Exchange Key Signature Database.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 150 of file GlobalVariable.h.

◆ EFI_PK_DEFAULT_VARIABLE_NAME

#define EFI_PK_DEFAULT_VARIABLE_NAME   L"PKDefault"

The OEM's default public Platform Key.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 155 of file GlobalVariable.h.

◆ EFI_DB_DEFAULT_VARIABLE_NAME

#define EFI_DB_DEFAULT_VARIABLE_NAME   L"dbDefault"

The OEM's default secure boot signature store.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 160 of file GlobalVariable.h.

◆ EFI_DBX_DEFAULT_VARIABLE_NAME

#define EFI_DBX_DEFAULT_VARIABLE_NAME   L"dbxDefault"

The OEM's default secure boot blacklist signature store.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 165 of file GlobalVariable.h.

◆ EFI_DBT_DEFAULT_VARIABLE_NAME

#define EFI_DBT_DEFAULT_VARIABLE_NAME   L"dbtDefault"

The OEM's default secure boot timestamp signature store.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 170 of file GlobalVariable.h.

◆ EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME

#define EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME   L"OsIndicationsSupported"

Allows the firmware to indicate supported features and actions to the OS.

Its attribute is BS+RT.

Definition at line 175 of file GlobalVariable.h.

◆ EFI_OS_INDICATIONS_VARIABLE_NAME

#define EFI_OS_INDICATIONS_VARIABLE_NAME   L"OsIndications"

Allows the OS to request the firmware to enable certain features and to take certain actions.

Its attribute is NV+BS+RT.

Definition at line 180 of file GlobalVariable.h.

◆ EFI_VENDOR_KEYS_VARIABLE_NAME

#define EFI_VENDOR_KEYS_VARIABLE_NAME   L"VendorKeys"

Whether the system is configured to use only vendor provided keys or not.

Should be treated as read-only. Its attribute is BS+RT.

Definition at line 186 of file GlobalVariable.h.

◆ EFI_DEVICE_AUTH_BOOT_MODE_NAME

#define EFI_DEVICE_AUTH_BOOT_MODE_NAME   L"devAuthBoot"

Whether the platform firmware is operating in device authentication boot mode (1) or not (0).

The content is UINT8.

Definition at line 192 of file GlobalVariable.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT  )

Variable Documentation

◆ gEfiGlobalVariableGuid

EFI_GUID gEfiGlobalVariableGuid