+/** @file\r
+ The variable data structures are related to EDK II specific UEFI variable implementation.\r
+ Variable data header and Variable storage region header are defined here.\r
+\r
+ Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
+ All rights reserved. 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
+**/\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
+extern EFI_GUID gEfiVariableGuid;\r
+\r
+///\r
+/// Alignment of variable name and data.\r
+/// For IA32/X64 architecture, the alignment is set to 1, and 8 is for IPF archtecture.\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 to calculate miminal pad bytes to make current size satisfy the alignment requirement\r
+//\r
+#if ((ALIGNMENT == 0) || (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
+\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 transistion\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
+/// 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 spec\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 produce and consume this varaible.\r
+ ///\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 used variables at boot service time and produce 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 spec\r
+ UINT32 ReadCount; ///> Times to read this variable\r
+ UINT32 WriteCount; ///> Times to write this variable\r
+ UINT32 DeleteCount; ///> Times to delete this variable\r
+ UINT32 CacheCount; ///> 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 / commitdiff