diff options
Diffstat (limited to 'MdeModulePkg/Include/Guid/VariableFormat.h')
| -rw-r--r-- | MdeModulePkg/Include/Guid/VariableFormat.h | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/MdeModulePkg/Include/Guid/VariableFormat.h b/MdeModulePkg/Include/Guid/VariableFormat.h index bf1c6b3687..8ff64cb2c8 100644 --- a/MdeModulePkg/Include/Guid/VariableFormat.h +++ b/MdeModulePkg/Include/Guid/VariableFormat.h @@ -1,6 +1,6 @@ /** @file
- The variable data structures are related to EDK II specific UEFI variable implementation.
- Variable data header and Variable storage region header are defined here.
+ The variable data structures are related to EDK II-specific implementation of UEFI variables.
+ VariableFormat.h defines variable data headers and variable storage region headers.
Copyright (c) 2006 - 2008 Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -22,8 +22,9 @@ extern EFI_GUID gEfiVariableGuid;
///
-/// Alignment of variable name and data.
-/// For IA32/X64 architecture, the alignment is set to 1, and 8 is for IPF archtecture.
+/// Alignment of variable name and data, according to the architecture:
+/// * For IA-32 and Intel(R) 64 architectures: 1
+/// * For IA-64 architecture: 8
///
#if defined (MDE_CPU_IPF)
#define ALIGNMENT 8
@@ -32,7 +33,7 @@ extern EFI_GUID gEfiVariableGuid; #endif
//
-// GET_PAD_SIZE to calculate miminal pad bytes to make current size satisfy the alignment requirement
+// GET_PAD_SIZE calculates the miminal pad bytes needed to make the current pad size satisfy the alignment requirement.
//
#if (ALIGNMENT == 1)
#define GET_PAD_SIZE(a) (0)
@@ -99,7 +100,7 @@ typedef struct { ///
/// Variable State flags
///
-#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transistion
+#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transition
#define VAR_DELETED 0xfd ///< Variable is obsolete
#define VAR_HEADER_VALID_ONLY 0x7f ///< Variable header has been valid
#define VAR_ADDED 0x3f ///< Variable has been completely added
@@ -122,7 +123,7 @@ typedef struct { ///
UINT32 Attributes;
///
- /// Size of variable Null-terminated Unicode string name
+ /// Size of variable null-terminated Unicode string name
///
UINT32 NameSize;
///
@@ -130,7 +131,7 @@ typedef struct { ///
UINT32 DataSize;
///
- /// A unique identifier for the vendor that produce and consume this varaible.
+ /// A unique identifier for the vendor that produces and consumes this varaible.
///
EFI_GUID VendorGuid;
} VARIABLE_HEADER;
@@ -141,7 +142,7 @@ typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY; ///
/// This structure contains the variable list that is put in EFI system table.
-/// The variable driver collects all used variables at boot service time and produce this list.
+/// The variable driver collects all variables that were used at boot service time and produces this list.
/// This is an optional feature to dump all used variables in shell environment.
///
struct _VARIABLE_INFO_ENTRY {
@@ -149,11 +150,11 @@ struct _VARIABLE_INFO_ENTRY { EFI_GUID VendorGuid; ///> Guid of Variable
CHAR16 *Name; ///> Name of Variable
UINT32 Attributes; ///> Attributes of variable defined in UEFI spec
- UINT32 ReadCount; ///> Times to read this variable
- UINT32 WriteCount; ///> Times to write this variable
- UINT32 DeleteCount; ///> Times to delete this variable
- UINT32 CacheCount; ///> Times that cache hits this variable
- BOOLEAN Volatile; ///> TRUE if volatile FALSE if non-volatile
+ UINT32 ReadCount; ///> Number of times to read this variable
+ UINT32 WriteCount; ///> Number of times to write this variable
+ UINT32 DeleteCount; ///> Number of times to delete this variable
+ UINT32 CacheCount; ///> Number of times that cache hits this variable
+ BOOLEAN Volatile; ///> TRUE if volatile, FALSE if non-volatile
};
#endif // _EFI_VARIABLE_H_
|