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 - 2010, 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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define EFI_VARIABLE_GUID \\r
{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }\r
\r
-extern EFI_GUID gEfiVariableGuid;\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
+#define ALIGNMENT 1\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
+#define GET_PAD_SIZE(a) (0)\r
#else\r
-#define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))\r
+#define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))\r
#endif\r
\r
///\r
\r
#pragma pack(1)\r
\r
-#define VARIABLE_STORE_SIGNATURE EFI_VARIABLE_GUID\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
+#define VARIABLE_STORE_FORMATTED 0x5a\r
+#define VARIABLE_STORE_HEALTHY 0xfe\r
\r
///\r
/// Variable Store region header.\r
///\r
/// Variable store region signature.\r
///\r
- EFI_GUID Signature;\r
+ EFI_GUID Signature;\r
///\r
- /// Size of entire variable store, \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
+ UINT32 Size;\r
///\r
/// Variable region format state.\r
///\r
- UINT8 Format;\r
+ UINT8 Format;\r
///\r
/// Variable region healthy state.\r
///\r
- UINT8 State;\r
- UINT16 Reserved;\r
- UINT32 Reserved1;\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
+#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
+#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_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_AT EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\r
+#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT (VARIABLE_ATTRIBUTE_NV_BS_RT_HR | VARIABLE_ATTRIBUTE_AT)\r
+///\r
+/// EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered as reserved\r
+///\r
+#define VARIABLE_ATTRIBUTE_AT_AW (EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | EFI_VARIABLE_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
EFI_GUID VendorGuid;\r
} VARIABLE_HEADER;\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
+/// Single Authenticated Variable Data Header Structure.\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
-//\r
-// This structure is used for SMM variable. the collected statistics data is saved in SMRAM. It can be got from \r
-// SMI handler. The communication buffer should be: \r
-// EFI_SMM_COMMUNICATE_HEADER + SMM_VARIABLE_COMMUNICATE_HEADER + payload.\r
-//\r
typedef struct {\r
- UINTN Function;\r
- EFI_STATUS ReturnStatus;\r
- UINT8 Data[1];\r
-} SMM_VARIABLE_COMMUNICATE_HEADER;\r
-\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r
-//\r
-#define SMM_VARIABLE_FUNCTION_GET_VARIABLE 1\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_GET_NEXT_VARIABLE_NAME 2\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_SET_VARIABLE 3\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_QUERY_VARIABLE_INFO 4\r
-//\r
-// It is a notify event, no extra payload for this function.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_READY_TO_BOOT 5\r
-//\r
-// It is a notify event, no extra payload for this function.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_EXIT_BOOT_SERVICE 6\r
-//\r
-// The payload for this function is VARIABLE_INFO_ENTRY. The GUID in EFI_SMM_COMMUNICATE_HEADER \r
-// is gEfiSmmVariableProtocolGuid.\r
-//\r
-#define SMM_VARIABLE_FUNCTION_GET_STATISTICS 7\r
-\r
-///\r
-/// Size of SMM communicate header, without including the payload.\r
-///\r
-#define SMM_COMMUNICATE_HEADER_SIZE (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data))\r
-\r
-///\r
-/// Size of SMM variable communicate header, without including the payload.\r
-///\r
-#define SMM_VARIABLE_COMMUNICATE_HEADER_SIZE (OFFSET_OF (SMM_VARIABLE_COMMUNICATE_HEADER, Data))\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
-///\r
-/// This structure is used to communicate with SMI handler by SetVariable and GetVariable.\r
-///\r
typedef struct {\r
- EFI_GUID Guid;\r
- UINTN DataSize;\r
- UINTN NameSize;\r
- UINT32 Attributes; \r
- CHAR16 Name[1];\r
-} SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE;\r
+ EFI_GUID *Guid;\r
+ CHAR16 *Name;\r
+ UINTN VariableSize;\r
+} VARIABLE_ENTRY_CONSISTENCY;\r
\r
-///\r
-/// This structure is used to communicate with SMI handler by GetNextVariableName.\r
-///\r
-typedef struct {\r
- EFI_GUID Guid;\r
- UINTN NameSize;\r
- CHAR16 Name[1];\r
-} SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME;\r
+#pragma pack()\r
\r
-///\r
-/// This structure is used to communicate with SMI handler by QueryVariableInfo.\r
-///\r
-typedef struct {\r
- UINT64 MaximumVariableStorageSize;\r
- UINT64 RemainingVariableStorageSize;\r
- UINT64 MaximumVariableSize;\r
- UINT32 Attributes; \r
-} SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO;\r
+typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY;\r
\r
///\r
-/// This structure is used to communicate with SMI handler to get variable statistics information.\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
-typedef VARIABLE_INFO_ENTRY SMM_VARIABLE_COMMUNICATE_VARIABLE_INFO_ENTRY;\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
projects / mirror_edk2.git / blobdiff