Add comments for these header files

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7364 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
2009-01-23 14:45:13 +00:00
parent 7c9c12f09c
commit 6426c8ffb4
16 changed files with 87 additions and 51 deletions

View File

@@ -1,7 +1,8 @@
/** @file
This file defines GUIDs used for variable list entries put in the EFI system table.
This file defines variable info guid and variable info entry.
This guid is used to specify the variable list put in the EFI system table.
Copyright (c) 2006 - 2008, Intel Corporation
Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -15,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __VARIABLE_INFO_GUID_H__
#define __VARIABLE_INFO_GUID_H__
// {DDCF3616-3275-4164-98B6-FE85707FFE7D}
#define EFI_VARIABLE_INFO_GUID \
{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }
@@ -25,19 +25,20 @@ extern EFI_GUID gEfiVariableInfoGuid;
typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY;
///
/// This list gets put in the EFI system table. It is produced by the Variable driver at
/// Boot Services time and records read and write access to a given variable
/// 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.
/// This is an optional feature to dump all used variables in shell environment.
///
struct _VARIABLE_INFO_ENTRY {
VARIABLE_INFO_ENTRY *Next; /// Pointer to next 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
VARIABLE_INFO_ENTRY *Next; ///> Pointer to next 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
};
#endif