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

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