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

12
MdeModulePkg/Include/Guid/Bmp.h
View File

@@ -1,6 +1,6 @@
/** @file
This file defines header data structures for BMP file and default
GUID for BMP logo file.
FFS GUID Filename for BMP logo file.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -16,10 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __BMP_GUID_H__
#define __BMP_GUID_H__
//
// Definitions for BMP files
//
#pragma pack(1)
typedef struct {
@@ -38,10 +34,10 @@ typedef struct {
UINT32 HeaderSize;
UINT32 PixelWidth;
UINT32 PixelHeight;
UINT16 Planes; // Must be 1
UINT16 BitPerPixel; // 1, 4, 8, or 24
UINT16 Planes; /// Must be 1
UINT16 BitPerPixel; /// 1, 4, 8, or 24
UINT32 CompressionType;
UINT32 ImageSize; // Compressed image size in bytes
UINT32 ImageSize; /// Compressed image size in bytes
UINT32 XPixelsPerMeter;
UINT32 YPixelsPerMeter;
UINT32 NumberOfColors;

6
MdeModulePkg/Include/Guid/BootState.h
View File

@@ -1,5 +1,5 @@
/** @file
This file defines variable name and GUID to record boot state.
This file defines variable name and variable GUID for boot state.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -15,10 +15,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __BOOT_STATE_H__
#define __BOOT_STATE_H__
//
// BOOT STATE
//
typedef UINT32 EFI_BOOT_STATE;
#define BOOT_STATE_VARIABLE_NAME L"BootState"

26
MdeModulePkg/Include/Guid/CapsuleVendor.h
View File

@@ -17,27 +17,27 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __EFI_CAPSULE_VENDOR_GUID_H__
#define __EFI_CAPSULE_VENDOR_GUID_H__
//
// Note -- This guid is used as a variable GUID (depending on implementation)
// for the capsule variable if the capsule pointer is passes through reset
// via a variable.
//
///
/// This guid is used as a variable GUID (depending on implementation)
/// for the capsule variable if the capsule pointer is passes through reset
/// via a variable.
///
#define EFI_CAPSULE_VENDOR_GUID \
{ 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
//
// Name of capsule variable
//
///
/// Name of capsule variable
///
#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
extern EFI_GUID gEfiCapsuleVendorGuid;
//
// Data structure of capsule guid hob
//
///
/// Data structure of capsule guid hob entry
///
typedef struct {
EFI_PHYSICAL_ADDRESS BaseAddress;
UINT32 Length;
EFI_PHYSICAL_ADDRESS BaseAddress; /// Capsule data start address
UINT32 Length; /// Length of capsule data.
} CAPSULE_HOB_INFO;
#endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_

2
MdeModulePkg/Include/Guid/ConsoleInDevice.h
View File

@@ -1,5 +1,5 @@
/** @file
This guid is used to specifiy the device is the console in device.
This guid is used to specify the device is the console in device.
If the device is the console in device, this guid as the protocol guid
will be installed into this device handle.

2
MdeModulePkg/Include/Guid/ConsoleOutDevice.h
View File

@@ -1,5 +1,5 @@
/** @file
This guid is used to specifiy the device is the console out device.
This guid is used to specify the device is the console out device.
If the device is the console out device, this guid as the protocol guid
will be installed into this device handle.

2
MdeModulePkg/Include/Guid/HotPlugDevice.h
View File

@@ -1,5 +1,5 @@
/** @file
This guid is used to specifiy the device is the hot plug device.
This guid is used to specify the device is the hot plug device.
If the device is the hot plug device, this guid as the protocol guid
will be installed into this device handle.

4
MdeModulePkg/Include/Guid/MemoryTypeInformation.h
View File

@@ -24,8 +24,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
extern EFI_GUID gEfiMemoryTypeInformationGuid;
typedef struct {
UINT32 Type;
UINT32 NumberOfPages;
UINT32 Type; /// EFI memory type defined in UEFI specification.
UINT32 NumberOfPages; /// The pages of this type memory.
} EFI_MEMORY_TYPE_INFORMATION;
#endif

10
MdeModulePkg/Include/Guid/OverrideVariable.h
View File

@@ -1,5 +1,5 @@
/** @file
This guid is used for Platform Override Variable named L"PlatDriOver".
This file defines the platform override variable name and variable guid.
Copyright (c) 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -15,12 +15,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __EFI_OVERRIDE_VARIABLE_GUID_H__
#define __EFI_OVERRIDE_VARIABLE_GUID_H__
//
// This guid is used for a platform driver override variable
//
///
/// This guid is used for a platform driver override variable
///
#define EFI_OVERRIDE_VARIABLE_GUID \
{ 0x8e3d4ad5, 0xf762, 0x438a, { 0xa1, 0xc1, 0x5b, 0x9f, 0xe6, 0x8c, 0x6b, 0x15 }}
#define EFI_PLATFORM_OVERRIDE_VARIABLE_NAME L"PlatDriOver"
extern EFI_GUID gEfiOverrideVariableGuid;

34
MdeModulePkg/Include/Guid/PeiPeCoffLoader.h
View File

@@ -29,13 +29,17 @@ typedef struct _EFI_PEI_PE_COFF_LOADER_PROTOCOL EFI_PEI_PE_COFF_LOADER_PROTOCO
/**
Retrieves information about a PE/COFF image.
Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,
PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
fields of the ImageContext structure. If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not
a supported PE/COFF image type, then return RETURN_UNSUPPORTED. If any errors occur while
computing the fields of ImageContext, then the error status is returned in the ImageError field of
ImageContext.
Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,
DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and
DebugDirectoryEntryRva fields of the ImageContext structure.
If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
If the PE/COFF image accessed through the ImageRead service in the ImageContext
structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.
If any errors occur while computing the fields of ImageContext,
then the error status is returned in the ImageError field of ImageContext.
If the image is a TE image, then SectionAlignment is set to 0.
The ImageRead and Handle fields of ImageContext structure must be valid prior
to invoking this service.
@param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.
@param ImageContext Pointer to the image context structure that describes the PE/COFF
@@ -60,7 +64,9 @@ RETURN_STATUS
specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.
If ImageContext is NULL, then ASSERT().
The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
fields of the ImageContext structure must be valid prior to invoking this service.
@param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.
@param ImageContext Pointer to the image context structure that describes the PE/COFF
@@ -90,7 +96,13 @@ RETURN_STATUS
If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
of ImageContext as the relocation base address. The caller must allocate the relocation
fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
the ImageContext structure must be valid prior to invoking this service.
If ImageContext is NULL, then ASSERT().
@param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.
@@ -114,7 +126,9 @@ RETURN_STATUS
/**
Unloads a loaded PE/COFF image from memory and releases its taken resource.
Releases any environment specific resources that were allocated when the image
specified by ImageContext was loaded using PeCoffLoaderLoadImage().
For NT32 emulator, the PE/COFF image loaded by system needs to release.
For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
this function can simply return RETURN_SUCCESS.

12
MdeModulePkg/Include/Guid/PeiPerformanceHob.h
View File

@@ -30,18 +30,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct {
EFI_PHYSICAL_ADDRESS Handle;
CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE];
CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE];
UINT64 StartTimeStamp;
UINT64 EndTimeStamp;
CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; /// Measured token string name
CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; /// Module string name
UINT64 StartTimeStamp; /// Start time point
UINT64 EndTimeStamp; /// End time point
} PEI_PERFORMANCE_LOG_ENTRY;
//
// The header must be aligned at 8 bytes.
//
typedef struct {
UINT32 NumberOfEntries;
UINT32 Reserved;
UINT32 NumberOfEntries; /// The number of all performance log entries
UINT32 Reserved;
} PEI_PERFORMANCE_LOG_HEADER;

2
MdeModulePkg/Include/Guid/ShellFile.h
View File

@@ -1,5 +1,5 @@
/** @file
This file defnies FFS GUID Filename for EFI Shell.
This file defines FFS GUID Filename for EFI Shell.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials

2
MdeModulePkg/Include/Guid/StandardErrorDevice.h
View File

@@ -1,5 +1,5 @@
/** @file
This guid is used to specifiy the device is the StdErr device.
This guid is used to specify the device is the StdErr device.
If the device is the StdErr device, this guid as the protocol guid
will be installed into this device handle.

26
MdeModulePkg/Include/Guid/SystemNvDataGuid.h
View File

@@ -1,6 +1,7 @@
/** @file
This file defines GUIDs used for System Non Volatile HOB entries in the HOB list,
and FV Guids that carrying the System specific information.
This file defines NvDataHob GUIDs for System Non Volatile HOB entries
in the HOB list and NV system hob entry structure.
It also defines NvDataFv GUID used as the signature of FTW working block header.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -22,17 +23,24 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define EFI_SYSTEM_NV_DATA_HOB_GUID \
{0xd6e5092d, 0xc7b2, 0x4872, {0xaf, 0x66, 0xfd, 0xc0, 0xe6, 0xf9, 0x5e, 0x78} }
///
/// Hob entry for NV data region
///
typedef struct {
EFI_GUID SystemNvDataHobGuid;
EFI_GUID SystemNvDataFvGuid;
EFI_LBA StartLba;
UINTN StartLbaOffset;
EFI_LBA EndLba;
UINTN EndLbaOffset;
UINT32 DataTypeSignature;
EFI_GUID SystemNvDataHobGuid; /// EFI_SYSTEM_NV_DATA_HOB_GUID
EFI_GUID SystemNvDataFvGuid; /// Guid specifies the NvData Fv for the specific purpose, such as FTW, Error Log.
EFI_LBA StartLba; /// The starting logical block index.
UINTN StartLbaOffset; /// Offset into the starting block at which to the start of NvData region.
EFI_LBA EndLba; /// The last logical block index.
UINTN EndLbaOffset; /// Offset into the last block at which to the end of Nvdata region.
UINT32 DataTypeSignature; /// NvData type in the specified NV range.
} NV_SYSTEM_DATA_GUID_TYPE;
extern EFI_GUID gEfiSystemNvDataHobGuid;
///
/// NvDataFv GUID used as the signature of FTW working block header.
///
extern EFI_GUID gEfiSystemNvDataFvGuid;
#endif

27
MdeModulePkg/Include/Guid/VariableInfo.h
View File

@@ -24,21 +24,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 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
///
struct _VARIABLE_INFO_ENTRY {
VARIABLE_INFO_ENTRY *Next;
EFI_GUID VendorGuid;
CHAR16 *Name;
UINT32 Attributes;
UINT32 ReadCount;
UINT32 WriteCount;
UINT32 DeleteCount;
UINT32 CacheCount;
BOOLEAN 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