[mirror_edk2.git] / MdeModulePkg / Include / Guid / VariableFormat.h

/** @file\r
  The variable data structures are related to EDK II-specific implementation of UEFI variables.\r
  VariableFormat.h defines variable data headers and variable storage region headers.\r
\r
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under\r
the terms and conditions of the BSD License that accompanies this distribution.\r
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
**/\r
\r
#ifndef __VARIABLE_FORMAT_H__\r
#define __VARIABLE_FORMAT_H__\r
\r
#define EFI_VARIABLE_GUID \\r
  { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }\r
\r
#define EFI_AUTHENTICATED_VARIABLE_GUID \\r
  { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }\r
\r
extern EFI_GUID gEfiVariableGuid;\r
extern EFI_GUID gEfiAuthenticatedVariableGuid;\r
\r
///\r
/// Alignment of variable name and data, according to the architecture:\r
/// * For IA-32 and Intel(R) 64 architectures: 1.\r
/// * For IA-64 architecture: 8.\r
///\r
#if defined (MDE_CPU_IPF)\r
#define ALIGNMENT         8\r
#else\r
#define ALIGNMENT         1\r
#endif\r
\r
//\r
// GET_PAD_SIZE calculates the miminal pad bytes needed to make the current pad size satisfy the alignment requirement.\r
//\r
#if (ALIGNMENT == 1)\r
#define GET_PAD_SIZE(a) (0)\r
#else\r
#define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))\r
#endif\r
\r
///\r
/// Alignment of Variable Data Header in Variable Store region.\r
///\r
#define HEADER_ALIGNMENT  4\r
#define HEADER_ALIGN(Header)  (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))\r
\r
///\r
/// Status of Variable Store Region.\r
///\r
typedef enum {\r
  EfiRaw,\r
  EfiValid,\r
  EfiInvalid,\r
  EfiUnknown\r
} VARIABLE_STORE_STATUS;\r
\r
#pragma pack(1)\r
\r
#define VARIABLE_STORE_SIGNATURE  EFI_VARIABLE_GUID\r
#define AUTHENTICATED_VARIABLE_STORE_SIGNATURE  EFI_AUTHENTICATED_VARIABLE_GUID\r
\r
///\r
/// Variable Store Header Format and State.\r
///\r
#define VARIABLE_STORE_FORMATTED          0x5a\r
#define VARIABLE_STORE_HEALTHY            0xfe\r
\r
///\r
/// Variable Store region header.\r
///\r
typedef struct {\r
  ///\r
  /// Variable store region signature.\r
  ///\r
  EFI_GUID  Signature;\r
  ///\r
  /// Size of entire variable store,\r
  /// including size of variable store header but not including the size of FvHeader.\r
  ///\r
  UINT32  Size;\r
  ///\r
  /// Variable region format state.\r
  ///\r
  UINT8   Format;\r
  ///\r
  /// Variable region healthy state.\r
  ///\r
  UINT8   State;\r
  UINT16  Reserved;\r
  UINT32  Reserved1;\r
} VARIABLE_STORE_HEADER;\r
\r
///\r
/// Variable data start flag.\r
///\r
#define VARIABLE_DATA                     0x55AA\r
\r
///\r
/// Variable State flags.\r
///\r
#define VAR_IN_DELETED_TRANSITION     0xfe  ///< Variable is in obsolete transition.\r
#define VAR_DELETED                   0xfd  ///< Variable is obsolete.\r
#define VAR_HEADER_VALID_ONLY         0x7f  ///< Variable header has been valid.\r
#define VAR_ADDED                     0x3f  ///< Variable has been completely added.\r
\r
///\r
/// Variable Attribute combinations.\r
///\r
#define VARIABLE_ATTRIBUTE_NV_BS        (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)\r
#define VARIABLE_ATTRIBUTE_BS_RT        (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS)\r
#define VARIABLE_ATTRIBUTE_AT_AW        (EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)\r
#define VARIABLE_ATTRIBUTE_BS_RT_AT     (VARIABLE_ATTRIBUTE_BS_RT | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)\r
#define VARIABLE_ATTRIBUTE_NV_BS_RT     (VARIABLE_ATTRIBUTE_BS_RT | EFI_VARIABLE_NON_VOLATILE)\r
#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR  (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_HARDWARE_ERROR_RECORD)\r
#define VARIABLE_ATTRIBUTE_NV_BS_RT_AT  (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)\r
#define VARIABLE_ATTRIBUTE_NV_BS_RT_AW  (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)\r
#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT_AW    (VARIABLE_ATTRIBUTE_NV_BS_RT_HR | VARIABLE_ATTRIBUTE_AT_AW)\r
\r
///\r
/// Single Variable Data Header Structure.\r
///\r
typedef struct {\r
  ///\r
  /// Variable Data Start Flag.\r
  ///\r
  UINT16      StartId;\r
  ///\r
  /// Variable State defined above.\r
  ///\r
  UINT8       State;\r
  UINT8       Reserved;\r
  ///\r
  /// Attributes of variable defined in UEFI specification.\r
  ///\r
  UINT32      Attributes;\r
  ///\r
  /// Size of variable null-terminated Unicode string name.\r
  ///\r
  UINT32      NameSize;\r
  ///\r
  /// Size of the variable data without this header.\r
  ///\r
  UINT32      DataSize;\r
  ///\r
  /// A unique identifier for the vendor that produces and consumes this varaible.\r
  ///\r
  EFI_GUID    VendorGuid;\r
} VARIABLE_HEADER;\r
\r
///\r
/// Single Authenticated Variable Data Header Structure.\r
///\r
typedef struct {\r
  ///\r
  /// Variable Data Start Flag.\r
  ///\r
  UINT16      StartId;\r
  ///\r
  /// Variable State defined above.\r
  ///\r
  UINT8       State;\r
  UINT8       Reserved;\r
  ///\r
  /// Attributes of variable defined in UEFI specification.\r
  ///\r
  UINT32      Attributes;\r
  ///\r
  /// Associated monotonic count value against replay attack.\r
  ///\r
  UINT64      MonotonicCount;\r
  ///\r
  /// Associated TimeStamp value against replay attack.\r
  ///\r
  EFI_TIME    TimeStamp;\r
  ///\r
  /// Index of associated public key in database.\r
  ///\r
  UINT32      PubKeyIndex;\r
  ///\r
  /// Size of variable null-terminated Unicode string name.\r
  ///\r
  UINT32      NameSize;\r
  ///\r
  /// Size of the variable data without this header.\r
  ///\r
  UINT32      DataSize;\r
  ///\r
  /// A unique identifier for the vendor that produces and consumes this varaible.\r
  ///\r
  EFI_GUID    VendorGuid;\r
} AUTHENTICATED_VARIABLE_HEADER;\r
\r
typedef struct {\r
  EFI_GUID    *Guid;\r
  CHAR16      *Name;\r
  UINTN       VariableSize;\r
} VARIABLE_ENTRY_CONSISTENCY;\r
\r
#pragma pack()\r
\r
typedef struct _VARIABLE_INFO_ENTRY  VARIABLE_INFO_ENTRY;\r
\r
///\r
/// This structure contains the variable list that is put in EFI system table.\r
/// The variable driver collects all variables that were used at boot service time and produces this list.\r
/// This is an optional feature to dump all used variables in shell environment.\r
///\r
struct _VARIABLE_INFO_ENTRY {\r
  VARIABLE_INFO_ENTRY *Next;       ///< Pointer to next entry.\r
  EFI_GUID            VendorGuid;  ///< Guid of Variable.\r
  CHAR16              *Name;       ///< Name of Variable.\r
  UINT32              Attributes;  ///< Attributes of variable defined in UEFI specification.\r
  UINT32              ReadCount;   ///< Number of times to read this variable.\r
  UINT32              WriteCount;  ///< Number of times to write this variable.\r
  UINT32              DeleteCount; ///< Number of times to delete this variable.\r
  UINT32              CacheCount;  ///< Number of times that cache hits this variable.\r
  BOOLEAN             Volatile;    ///< TRUE if volatile, FALSE if non-volatile.\r
};\r
\r
#endif // _EFI_VARIABLE_H_\r
Commit	Line	Data
	1	/** @file\r
	2	The variable data structures are related to EDK II-specific implementation of UEFI variables.\r
	3	VariableFormat.h defines variable data headers and variable storage region headers.\r
	4	\r
	5	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials are licensed and made available under\r
	7	the terms and conditions of the BSD License that accompanies this distribution.\r
	8	The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php.\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __VARIABLE_FORMAT_H__\r
	17	#define __VARIABLE_FORMAT_H__\r
	18	\r
	19	#define EFI_VARIABLE_GUID \\r
	20	{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }\r
	21	\r
	22	#define EFI_AUTHENTICATED_VARIABLE_GUID \\r
	23	{ 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }\r
	24	\r
	25	extern EFI_GUID gEfiVariableGuid;\r
	26	extern EFI_GUID gEfiAuthenticatedVariableGuid;\r
	27	\r
	28	///\r
	29	/// Alignment of variable name and data, according to the architecture:\r
	30	/// * For IA-32 and Intel(R) 64 architectures: 1.\r
	31	/// * For IA-64 architecture: 8.\r
	32	///\r
	33	#if defined (MDE_CPU_IPF)\r
	34	#define ALIGNMENT 8\r
	35	#else\r
	36	#define ALIGNMENT 1\r
	37	#endif\r
	38	\r
	39	//\r
	40	// GET_PAD_SIZE calculates the miminal pad bytes needed to make the current pad size satisfy the alignment requirement.\r
	41	//\r
	42	#if (ALIGNMENT == 1)\r
	43	#define GET_PAD_SIZE(a) (0)\r
	44	#else\r
	45	#define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))\r
	46	#endif\r
	47	\r
	48	///\r
	49	/// Alignment of Variable Data Header in Variable Store region.\r
	50	///\r
	51	#define HEADER_ALIGNMENT 4\r
	52	#define HEADER_ALIGN(Header) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))\r
	53	\r
	54	///\r
	55	/// Status of Variable Store Region.\r
	56	///\r
	57	typedef enum {\r
	58	EfiRaw,\r
	59	EfiValid,\r
	60	EfiInvalid,\r
	61	EfiUnknown\r
	62	} VARIABLE_STORE_STATUS;\r
	63	\r
	64	#pragma pack(1)\r
	65	\r
	66	#define VARIABLE_STORE_SIGNATURE EFI_VARIABLE_GUID\r
	67	#define AUTHENTICATED_VARIABLE_STORE_SIGNATURE EFI_AUTHENTICATED_VARIABLE_GUID\r
	68	\r
	69	///\r
	70	/// Variable Store Header Format and State.\r
	71	///\r
	72	#define VARIABLE_STORE_FORMATTED 0x5a\r
	73	#define VARIABLE_STORE_HEALTHY 0xfe\r
	74	\r
	75	///\r
	76	/// Variable Store region header.\r
	77	///\r
	78	typedef struct {\r
	79	///\r
	80	/// Variable store region signature.\r
	81	///\r
	82	EFI_GUID Signature;\r
	83	///\r
	84	/// Size of entire variable store,\r
	85	/// including size of variable store header but not including the size of FvHeader.\r
	86	///\r
	87	UINT32 Size;\r
	88	///\r
	89	/// Variable region format state.\r
	90	///\r
	91	UINT8 Format;\r
	92	///\r
	93	/// Variable region healthy state.\r
	94	///\r
	95	UINT8 State;\r
	96	UINT16 Reserved;\r
	97	UINT32 Reserved1;\r
	98	} VARIABLE_STORE_HEADER;\r
	99	\r
	100	///\r
	101	/// Variable data start flag.\r
	102	///\r
	103	#define VARIABLE_DATA 0x55AA\r
	104	\r
	105	///\r
	106	/// Variable State flags.\r
	107	///\r
	108	#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transition.\r
	109	#define VAR_DELETED 0xfd ///< Variable is obsolete.\r
	110	#define VAR_HEADER_VALID_ONLY 0x7f ///< Variable header has been valid.\r
	111	#define VAR_ADDED 0x3f ///< Variable has been completely added.\r
	112	\r
	113	///\r
	114	/// Variable Attribute combinations.\r
	115	///\r
	116	#define VARIABLE_ATTRIBUTE_NV_BS (EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS)\r
	117	#define VARIABLE_ATTRIBUTE_BS_RT (EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS)\r
	118	#define VARIABLE_ATTRIBUTE_AT_AW (EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS \| EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)\r
	119	#define VARIABLE_ATTRIBUTE_BS_RT_AT (VARIABLE_ATTRIBUTE_BS_RT \| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)\r
	120	#define VARIABLE_ATTRIBUTE_NV_BS_RT (VARIABLE_ATTRIBUTE_BS_RT \| EFI_VARIABLE_NON_VOLATILE)\r
	121	#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR (VARIABLE_ATTRIBUTE_NV_BS_RT \| EFI_VARIABLE_HARDWARE_ERROR_RECORD)\r
	122	#define VARIABLE_ATTRIBUTE_NV_BS_RT_AT (VARIABLE_ATTRIBUTE_NV_BS_RT \| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)\r
	123	#define VARIABLE_ATTRIBUTE_NV_BS_RT_AW (VARIABLE_ATTRIBUTE_NV_BS_RT \| EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)\r
	124	#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT_AW (VARIABLE_ATTRIBUTE_NV_BS_RT_HR \| VARIABLE_ATTRIBUTE_AT_AW)\r
	125	\r
	126	///\r
	127	/// Single Variable Data Header Structure.\r
	128	///\r
	129	typedef struct {\r
	130	///\r
	131	/// Variable Data Start Flag.\r
	132	///\r
	133	UINT16 StartId;\r
	134	///\r
	135	/// Variable State defined above.\r
	136	///\r
	137	UINT8 State;\r
	138	UINT8 Reserved;\r
	139	///\r
	140	/// Attributes of variable defined in UEFI specification.\r
	141	///\r
	142	UINT32 Attributes;\r
	143	///\r
	144	/// Size of variable null-terminated Unicode string name.\r
	145	///\r
	146	UINT32 NameSize;\r
	147	///\r
	148	/// Size of the variable data without this header.\r
	149	///\r
	150	UINT32 DataSize;\r
	151	///\r
	152	/// A unique identifier for the vendor that produces and consumes this varaible.\r
	153	///\r
	154	EFI_GUID VendorGuid;\r
	155	} VARIABLE_HEADER;\r
	156	\r
	157	///\r
	158	/// Single Authenticated Variable Data Header Structure.\r
	159	///\r
	160	typedef struct {\r
	161	///\r
	162	/// Variable Data Start Flag.\r
	163	///\r
	164	UINT16 StartId;\r
	165	///\r
	166	/// Variable State defined above.\r
	167	///\r
	168	UINT8 State;\r
	169	UINT8 Reserved;\r
	170	///\r
	171	/// Attributes of variable defined in UEFI specification.\r
	172	///\r
	173	UINT32 Attributes;\r
	174	///\r
	175	/// Associated monotonic count value against replay attack.\r
	176	///\r
	177	UINT64 MonotonicCount;\r
	178	///\r
	179	/// Associated TimeStamp value against replay attack.\r
	180	///\r
	181	EFI_TIME TimeStamp;\r
	182	///\r
	183	/// Index of associated public key in database.\r
	184	///\r
	185	UINT32 PubKeyIndex;\r
	186	///\r
	187	/// Size of variable null-terminated Unicode string name.\r
	188	///\r
	189	UINT32 NameSize;\r
	190	///\r
	191	/// Size of the variable data without this header.\r
	192	///\r
	193	UINT32 DataSize;\r
	194	///\r
	195	/// A unique identifier for the vendor that produces and consumes this varaible.\r
	196	///\r
	197	EFI_GUID VendorGuid;\r
	198	} AUTHENTICATED_VARIABLE_HEADER;\r
	199	\r
	200	typedef struct {\r
	201	EFI_GUID *Guid;\r
	202	CHAR16 *Name;\r
	203	UINTN VariableSize;\r
	204	} VARIABLE_ENTRY_CONSISTENCY;\r
	205	\r
	206	#pragma pack()\r
	207	\r
	208	typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY;\r
	209	\r
	210	///\r
	211	/// This structure contains the variable list that is put in EFI system table.\r
	212	/// The variable driver collects all variables that were used at boot service time and produces this list.\r
	213	/// This is an optional feature to dump all used variables in shell environment.\r
	214	///\r
	215	struct _VARIABLE_INFO_ENTRY {\r
	216	VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry.\r
	217	EFI_GUID VendorGuid; ///< Guid of Variable.\r
	218	CHAR16 *Name; ///< Name of Variable.\r
	219	UINT32 Attributes; ///< Attributes of variable defined in UEFI specification.\r
	220	UINT32 ReadCount; ///< Number of times to read this variable.\r
	221	UINT32 WriteCount; ///< Number of times to write this variable.\r
	222	UINT32 DeleteCount; ///< Number of times to delete this variable.\r
	223	UINT32 CacheCount; ///< Number of times that cache hits this variable.\r
	224	BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile.\r
	225	};\r
	226	\r
	227	#endif // _EFI_VARIABLE_H_\r