[mirror_edk2.git] / MdePkg / Include / Guid / GlobalVariable.h

/** @file\r
  GUID for EFI (NVRAM) Variables.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  GUID defined in UEFI 2.1\r
**/\r
\r
#ifndef __GLOBAL_VARIABLE_GUID_H__\r
#define __GLOBAL_VARIABLE_GUID_H__\r
\r
#define EFI_GLOBAL_VARIABLE \\r
  { \\r
    0x8BE4DF61, 0x93CA, 0x11d2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C } \\r
  }\r
\r
extern EFI_GUID gEfiGlobalVariableGuid;\r
\r
//\r
// Follow UEFI 2.4 spec:\r
// To prevent name collisions with possible future globally defined variables,\r
// other internal firmware data variables that are not defined here must be\r
// saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or\r
// any other GUID defined by the UEFI Specification. Implementations must\r
// only permit the creation of variables with a UEFI Specification-defined\r
// VendorGuid when these variables are documented in the UEFI Specification.\r
//\r
// Note: except the globally defined variables defined below, the spec also defines\r
// L"Boot####"      - A boot load option.\r
// L"Driver####"    - A driver load option.\r
// L"SysPrep####"   - A System Prep application load option.\r
// L"Key####"       - Describes hot key relationship with a Boot#### load option.\r
// The attribute for them is NV+BS+RT, #### is a printed hex value, and no 0x or h\r
// is included in the hex value. They can not be expressed as a #define like other globally\r
// defined variables, it is because we can not list the Boot0000, Boot0001, etc one by one.\r
//\r
\r
///\r
/// The language codes that the firmware supports. This value is deprecated.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_LANG_CODES_VARIABLE_NAME                L"LangCodes"\r
///\r
/// The language code that the system is configured for. This value is deprecated.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_LANG_VARIABLE_NAME                      L"Lang"\r
///\r
/// The firmware's boot managers timeout, in seconds, before initiating the default boot selection.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_TIME_OUT_VARIABLE_NAME                  L"Timeout"\r
///\r
/// The language codes that the firmware supports.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_PLATFORM_LANG_CODES_VARIABLE_NAME       L"PlatformLangCodes"\r
///\r
/// The language code that the system is configured for.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_PLATFORM_LANG_VARIABLE_NAME             L"PlatformLang"\r
///\r
/// The device path of the default input/output/error output console.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_CON_IN_VARIABLE_NAME                    L"ConIn"\r
#define EFI_CON_OUT_VARIABLE_NAME                   L"ConOut"\r
#define EFI_ERR_OUT_VARIABLE_NAME                   L"ErrOut"\r
///\r
/// The device path of all possible input/output/error output devices.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_CON_IN_DEV_VARIABLE_NAME                L"ConInDev"\r
#define EFI_CON_OUT_DEV_VARIABLE_NAME               L"ConOutDev"\r
#define EFI_ERR_OUT_DEV_VARIABLE_NAME               L"ErrOutDev"\r
///\r
/// The ordered boot option load list.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_BOOT_ORDER_VARIABLE_NAME                L"BootOrder"\r
///\r
/// The boot option for the next boot only.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_BOOT_NEXT_VARIABLE_NAME                 L"BootNext"\r
///\r
/// The boot option that was selected for the current boot.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_BOOT_CURRENT_VARIABLE_NAME              L"BootCurrent"\r
///\r
/// The types of boot options supported by the boot manager. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME       L"BootOptionSupport"\r
///\r
/// The ordered driver load option list.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_DRIVER_ORDER_VARIABLE_NAME              L"DriverOrder"\r
///\r
/// The ordered System Prep Application load option list.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_SYS_PREP_ORDER_VARIABLE_NAME            L"SysPrepOrder"\r
///\r
/// Identifies the level of hardware error record persistence\r
/// support implemented by the platform. This variable is\r
/// only modified by firmware and is read-only to the OS.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME        L"HwErrRecSupport"\r
///\r
/// Whether the system is operating in setup mode (1) or not (0).\r
/// All other values are reserved. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_SETUP_MODE_NAME                         L"SetupMode"\r
///\r
/// The Key Exchange Key Signature Database.\r
/// Its attribute is NV+BS+RT+AT.\r
///\r
#define EFI_KEY_EXCHANGE_KEY_NAME                   L"KEK"\r
///\r
/// The public Platform Key.\r
/// Its attribute is NV+BS+RT+AT.\r
///\r
#define EFI_PLATFORM_KEY_NAME                       L"PK"\r
///\r
/// Array of GUIDs representing the type of signatures supported\r
/// by the platform firmware. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_SIGNATURE_SUPPORT_NAME                  L"SignatureSupport"\r
///\r
/// Whether the platform firmware is operating in Secure boot mode (1) or not (0).\r
/// All other values are reserved. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_SECURE_BOOT_MODE_NAME                   L"SecureBoot"\r
///\r
/// The OEM's default Key Exchange Key Signature Database. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_KEK_DEFAULT_VARIABLE_NAME               L"KEKDefault"\r
///\r
/// The OEM's default public Platform Key. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_PK_DEFAULT_VARIABLE_NAME                L"PKDefault"\r
///\r
/// The OEM's default secure boot signature store. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_DB_DEFAULT_VARIABLE_NAME                L"dbDefault"\r
///\r
/// The OEM's default secure boot blacklist signature store. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_DBX_DEFAULT_VARIABLE_NAME               L"dbxDefault"\r
///\r
/// The OEM's default secure boot timestamp signature store. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_DBT_DEFAULT_VARIABLE_NAME               L"dbtDefault"\r
///\r
/// Allows the firmware to indicate supported features and actions to the OS.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME    L"OsIndicationsSupported"\r
///\r
/// Allows the OS to request the firmware to enable certain features and to take certain actions.\r
/// Its attribute is NV+BS+RT.\r
///\r
#define EFI_OS_INDICATIONS_VARIABLE_NAME            L"OsIndications"\r
///\r
/// Whether the system is configured to use only vendor provided\r
/// keys or not. Should be treated as read-only.\r
/// Its attribute is BS+RT.\r
///\r
#define EFI_VENDOR_KEYS_VARIABLE_NAME               L"VendorKeys"\r
\r
#endif\r
Commit	Line	Data
c2f83f0a	1	/** @file\r
	2	GUID for EFI (NVRAM) Variables.\r
	3	\r
9095d37b	4	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
9344f092	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
c2f83f0a	6	\r
c2f83f0a	7	@par Revision Reference:\r
	8	GUID defined in UEFI 2.1\r
	9	**/\r
	10	\r
	11	#ifndef __GLOBAL_VARIABLE_GUID_H__\r
	12	#define __GLOBAL_VARIABLE_GUID_H__\r
	13	\r
33b30a1e	14	#define EFI_GLOBAL_VARIABLE \\r
c2f83f0a	15	{ \\r
	16	0x8BE4DF61, 0x93CA, 0x11d2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C } \\r
	17	}\r
	18	\r
c2f83f0a	19	extern EFI_GUID gEfiGlobalVariableGuid;\r
c2f83f0a	20	\r
6675a21f SZ	21	//\r
	22	// Follow UEFI 2.4 spec:\r
	23	// To prevent name collisions with possible future globally defined variables,\r
	24	// other internal firmware data variables that are not defined here must be\r
	25	// saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or\r
	26	// any other GUID defined by the UEFI Specification. Implementations must\r
	27	// only permit the creation of variables with a UEFI Specification-defined\r
	28	// VendorGuid when these variables are documented in the UEFI Specification.\r
	29	//\r
	30	// Note: except the globally defined variables defined below, the spec also defines\r
	31	// L"Boot####" - A boot load option.\r
	32	// L"Driver####" - A driver load option.\r
c9210f63	33	// L"SysPrep####" - A System Prep application load option.\r
6675a21f SZ	34	// L"Key####" - Describes hot key relationship with a Boot#### load option.\r
	35	// The attribute for them is NV+BS+RT, #### is a printed hex value, and no 0x or h\r
	36	// is included in the hex value. They can not be expressed as a #define like other globally\r
	37	// defined variables, it is because we can not list the Boot0000, Boot0001, etc one by one.\r
	38	//\r
	39	\r
	40	///\r
	41	/// The language codes that the firmware supports. This value is deprecated.\r
	42	/// Its attribute is BS+RT.\r
	43	///\r
	44	#define EFI_LANG_CODES_VARIABLE_NAME L"LangCodes"\r
	45	///\r
	46	/// The language code that the system is configured for. This value is deprecated.\r
	47	/// Its attribute is NV+BS+RT.\r
	48	///\r
	49	#define EFI_LANG_VARIABLE_NAME L"Lang"\r
	50	///\r
	51	/// The firmware's boot managers timeout, in seconds, before initiating the default boot selection.\r
	52	/// Its attribute is NV+BS+RT.\r
	53	///\r
	54	#define EFI_TIME_OUT_VARIABLE_NAME L"Timeout"\r
	55	///\r
	56	/// The language codes that the firmware supports.\r
	57	/// Its attribute is BS+RT.\r
	58	///\r
	59	#define EFI_PLATFORM_LANG_CODES_VARIABLE_NAME L"PlatformLangCodes"\r
	60	///\r
	61	/// The language code that the system is configured for.\r
	62	/// Its attribute is NV+BS+RT.\r
	63	///\r
	64	#define EFI_PLATFORM_LANG_VARIABLE_NAME L"PlatformLang"\r
	65	///\r
	66	/// The device path of the default input/output/error output console.\r
	67	/// Its attribute is NV+BS+RT.\r
	68	///\r
	69	#define EFI_CON_IN_VARIABLE_NAME L"ConIn"\r
	70	#define EFI_CON_OUT_VARIABLE_NAME L"ConOut"\r
	71	#define EFI_ERR_OUT_VARIABLE_NAME L"ErrOut"\r
	72	///\r
	73	/// The device path of all possible input/output/error output devices.\r
	74	/// Its attribute is BS+RT.\r
	75	///\r
	76	#define EFI_CON_IN_DEV_VARIABLE_NAME L"ConInDev"\r
	77	#define EFI_CON_OUT_DEV_VARIABLE_NAME L"ConOutDev"\r
	78	#define EFI_ERR_OUT_DEV_VARIABLE_NAME L"ErrOutDev"\r
	79	///\r
	80	/// The ordered boot option load list.\r
	81	/// Its attribute is NV+BS+RT.\r
	82	///\r
	83	#define EFI_BOOT_ORDER_VARIABLE_NAME L"BootOrder"\r
	84	///\r
	85	/// The boot option for the next boot only.\r
	86	/// Its attribute is NV+BS+RT.\r
	87	///\r
	88	#define EFI_BOOT_NEXT_VARIABLE_NAME L"BootNext"\r
	89	///\r
	90	/// The boot option that was selected for the current boot.\r
	91	/// Its attribute is BS+RT.\r
	92	///\r
	93	#define EFI_BOOT_CURRENT_VARIABLE_NAME L"BootCurrent"\r
	94	///\r
	95	/// The types of boot options supported by the boot manager. Should be treated as read-only.\r
	96	/// Its attribute is BS+RT.\r
	97	///\r
98	#define EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME L"BootOptionSupport"\r
99	///\r
100	/// The ordered driver load option list.\r
101	/// Its attribute is NV+BS+RT.\r
102	///\r
103	#define EFI_DRIVER_ORDER_VARIABLE_NAME L"DriverOrder"\r
104	///\r
573b8a86 RN	105	/// The ordered System Prep Application load option list.\r
	106	/// Its attribute is NV+BS+RT.\r
	107	///\r
	108	#define EFI_SYS_PREP_ORDER_VARIABLE_NAME L"SysPrepOrder"\r
	109	///\r
6675a21f SZ	110	/// Identifies the level of hardware error record persistence\r
	111	/// support implemented by the platform. This variable is\r
	112	/// only modified by firmware and is read-only to the OS.\r
	113	/// Its attribute is NV+BS+RT.\r
	114	///\r
	115	#define EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME L"HwErrRecSupport"\r
	116	///\r
	117	/// Whether the system is operating in setup mode (1) or not (0).\r
	118	/// All other values are reserved. Should be treated as read-only.\r
	119	/// Its attribute is BS+RT.\r
	120	///\r
	121	#define EFI_SETUP_MODE_NAME L"SetupMode"\r
	122	///\r
	123	/// The Key Exchange Key Signature Database.\r
	124	/// Its attribute is NV+BS+RT+AT.\r
	125	///\r
	126	#define EFI_KEY_EXCHANGE_KEY_NAME L"KEK"\r
	127	///\r
	128	/// The public Platform Key.\r
	129	/// Its attribute is NV+BS+RT+AT.\r
	130	///\r
	131	#define EFI_PLATFORM_KEY_NAME L"PK"\r
	132	///\r
	133	/// Array of GUIDs representing the type of signatures supported\r
	134	/// by the platform firmware. Should be treated as read-only.\r
	135	/// Its attribute is BS+RT.\r
	136	///\r
	137	#define EFI_SIGNATURE_SUPPORT_NAME L"SignatureSupport"\r
	138	///\r
	139	/// Whether the platform firmware is operating in Secure boot mode (1) or not (0).\r
	140	/// All other values are reserved. Should be treated as read-only.\r
	141	/// Its attribute is BS+RT.\r
	142	///\r
	143	#define EFI_SECURE_BOOT_MODE_NAME L"SecureBoot"\r
	144	///\r
	145	/// The OEM's default Key Exchange Key Signature Database. Should be treated as read-only.\r
	146	/// Its attribute is BS+RT.\r
	147	///\r
	148	#define EFI_KEK_DEFAULT_VARIABLE_NAME L"KEKDefault"\r
	149	///\r
	150	/// The OEM's default public Platform Key. Should be treated as read-only.\r
	151	/// Its attribute is BS+RT.\r
	152	///\r
	153	#define EFI_PK_DEFAULT_VARIABLE_NAME L"PKDefault"\r
	154	///\r
	155	/// The OEM's default secure boot signature store. Should be treated as read-only.\r
	156	/// Its attribute is BS+RT.\r
	157	///\r
	158	#define EFI_DB_DEFAULT_VARIABLE_NAME L"dbDefault"\r
	159	///\r
	160	/// The OEM's default secure boot blacklist signature store. Should be treated as read-only.\r
	161	/// Its attribute is BS+RT.\r
	162	///\r
	163	#define EFI_DBX_DEFAULT_VARIABLE_NAME L"dbxDefault"\r
	164	///\r
	165	/// The OEM's default secure boot timestamp signature store. Should be treated as read-only.\r
	166	/// Its attribute is BS+RT.\r
	167	///\r
	168	#define EFI_DBT_DEFAULT_VARIABLE_NAME L"dbtDefault"\r
	169	///\r
	170	/// Allows the firmware to indicate supported features and actions to the OS.\r
	171	/// Its attribute is BS+RT.\r
	172	///\r
	173	#define EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME L"OsIndicationsSupported"\r
174	///\r
175	/// Allows the OS to request the firmware to enable certain features and to take certain actions.\r
176	/// Its attribute is NV+BS+RT.\r
177	///\r
178	#define EFI_OS_INDICATIONS_VARIABLE_NAME L"OsIndications"\r
179	///\r
180	/// Whether the system is configured to use only vendor provided\r
181	/// keys or not. Should be treated as read-only.\r
182	/// Its attribute is BS+RT.\r
183	///\r
184	#define EFI_VENDOR_KEYS_VARIABLE_NAME L"VendorKeys"\r
185	\r
c2f83f0a	186	#endif\r