sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add additional comments for structure definition.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6750 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
2008-11-27 04:53:43 +00:00
parent 9c83c97ac2
commit ebafc55b92
18 changed files with 313 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
MdeModulePkg/Include/VariableFormat.h
View File

@ -1,12 +1,12 @@
/** @file
EDK II specific implementation of UEFI variable depend on data structure.
The variable data structure related to EDK II specific UEFI variable implementation.
Copyright (c) 2006 - 2008 Intel Corporation. <BR>
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
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@ -15,31 +15,25 @@
#ifndef __VARIABLE_FORMAT_H__
#define __VARIABLE_FORMAT_H__
#define VARIABLE_STORE_SIGNATURE EFI_SIGNATURE_32 ('$', 'V', 'S', 'S')
///
/// Maximum buffer for the single variable.
///
#ifndef MAX_VARIABLE_SIZE
#define MAX_VARIABLE_SIZE FixedPcdGet32(PcdMaxVariableSize)
#endif
//
// Enlarges the hardware error record maximum variable size to 32K bytes
//
///
/// Hardware error record maximum variable size
///
#ifndef MAX_HARDWARE_ERROR_VARIABLE_SIZE
#define MAX_HARDWARE_ERROR_VARIABLE_SIZE FixedPcdGet32(PcdMaxHardwareErrorVariableSize)
#endif
#define VARIABLE_DATA 0x55AA
//
// Variable Store Header flags
//
#define VARIABLE_STORE_FORMATTED 0x5a
#define VARIABLE_STORE_HEALTHY 0xfe
//
// The alignment of variable's start offset.
// For IA32/X64 architecture, the alignment is set to 1, and
// 8 is for IPF archtecture.
//
///
/// The alignment of variable's start offset.
/// For IA32/X64 architecture, the alignment is set to 1, and
/// 8 is for IPF archtecture.
///
#if defined (MDE_CPU_IPF)
#define ALIGNMENT 8
#else
@ -48,9 +42,9 @@
#define HEADER_ALIGNMENT 4
//
// Variable Store Status
//
///
/// Variable Store Status
///
typedef enum {
EfiRaw,
EfiValid,
@ -58,40 +52,86 @@ typedef enum {
EfiUnknown
} VARIABLE_STORE_STATUS;
//
// Variable State flags
//
#define VAR_IN_DELETED_TRANSITION 0xfe // Variable is in obsolete transistion
#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
//
#define IS_VARIABLE_STATE(_c, _Mask) (BOOLEAN) (((~_c) & (~_Mask)) != 0)
#pragma pack(1)
//
// Variable Store region header
//
#define VARIABLE_STORE_SIGNATURE EFI_SIGNATURE_32 ('$', 'V', 'S', 'S')
///
/// Variable Store Header Format and State
///
#define VARIABLE_STORE_FORMATTED 0x5a
#define VARIABLE_STORE_HEALTHY 0xfe
///
/// Variable Store region header
///
typedef struct {
///
/// Variable store region signature.
///
UINT32 Signature;
///
/// Size of variable store region including this header
///
UINT32 Size;
///
/// variable region format state
///
UINT8 Format;
///
/// variable region healthy state
///
UINT8 State;
UINT16 Reserved;
UINT32 Reserved1;
} VARIABLE_STORE_HEADER;
//
// Variable header structure
//
///
/// Variable data start flag
///
#define VARIABLE_DATA 0x55AA
///
/// Variable State flags
///
#define VAR_IN_DELETED_TRANSITION 0xfe /// Variable is in obsolete transistion
#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
///
/// Removed
///
#define IS_VARIABLE_STATE(_c, _Mask) (BOOLEAN) (((~_c) & (~_Mask)) != 0)
///
/// Variable Data Header Structure
///
typedef struct {
///
/// Variable Data Start Flag
///
UINT16 StartId;
///
/// Variable State defined above
///
UINT8 State;
UINT8 Reserved;
///
/// Attributes of variable defined in UEFI spec
///
UINT32 Attributes;
///
/// Size of variable Null-terminated Unicode string name
///
UINT32 NameSize;
///
/// Size of the variable data without this header
///
UINT32 DataSize;
///
/// A unique identifier for the vendor.
///
EFI_GUID VendorGuid;
} VARIABLE_HEADER;