Update comments

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8744 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
mdkinney 2009-07-03 22:40:21 +00:00
parent 03df16089f
commit 0e0ab7060e
6 changed files with 84 additions and 43 deletions

View File

@ -1,53 +1,59 @@
/** @file
GUID used to identify Data Hub records logged by Status Code Runtime Protocol.
GUID used to identify Data Hub records logged by Status Code Protocol.
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
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.
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
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.
**/
#ifndef __DATA_HUB_STATUS_CODE_RECORD_H__
#define __DATA_HUB_STATUS_CODE_RECORD_H__
///
/// Global ID used to identify a structure of type DATA_HUB_STATUS_CODE_DATA_RECORD
///
#define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \
{ \
0xd083e94c, 0x6560, 0x42e4, {0xb6, 0xd4, 0x2d, 0xf7, 0x5a, 0xdf, 0x6a, 0x2a } \
}
///
/// Data Hub data record that is used to store all the parameters passed into
/// the ReportStatusCode() service of the EFI_STATUS_CODE_PROTOCOL.
///
typedef struct {
///
/// Status Code type to be reported.
///
EFI_STATUS_CODE_TYPE CodeType;
EFI_STATUS_CODE_TYPE CodeType;
///
/// Valu information about the class and subclass is used to
/// Value information about the class and subclass is used to
/// classify the hardware and software entity as well as an operation.
///
EFI_STATUS_CODE_VALUE Value;
EFI_STATUS_CODE_VALUE Value;
///
/// The enumeration of a hardware or software entity within
/// the system. Valid instance numbers start with 1
/// the system. Valid instance numbers start with 1
///
UINT32 Instance;
UINT32 Instance;
///
/// Identify the caller.
///
EFI_GUID CallerId;
EFI_GUID CallerId;
///
/// Additional status code data
///
EFI_STATUS_CODE_DATA Data;
EFI_STATUS_CODE_DATA Data;
} DATA_HUB_STATUS_CODE_DATA_RECORD;
extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;

View File

@ -15,6 +15,9 @@
#ifndef _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_
#define _INTEL_FRAMEWOKR_MODULEPKG_TOKEN_SPACE_GUID_H_
///
/// Global ID for the IntelFrameworkModulePkg PCD Token Space
///
#define INTEL_FRAMEWORK_MODULEPKG_TOKEN_SPACE_GUID \
{ \
0xD3705011, 0xBC19, 0x4af7, { 0xBE, 0x16, 0xF6, 0x80, 0x30, 0x37, 0x8C, 0x15 } \

View File

@ -15,6 +15,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __LZMA_DECOMPRESS_GUID_H__
#define __LZMA_DECOMPRESS_GUID_H__
///
/// Global ID used to identify a section of an FFS file of type
/// EFI_SECTION_GUID_DEFINED whose contents have been compressed using LZMA.
///
#define LZMA_CUSTOM_DECOMPRESS_GUID \
{ 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF } }

View File

@ -1,60 +1,83 @@
/** @file
GUID used to identify status code records HOB that originate from the PEI status code
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
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.
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
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.
**/
#ifndef __MEMORY_STATUS_CODE_RECORD_H__
#define __MEMORY_STATUS_CODE_RECORD_H__
///
/// Global ID used to identify GUIDed HOBs that start with a structure of type
/// MEMORY_STATUSCODE_PACKET_HEADER followed by an arry of structures of type
/// MEMORY_STATUSCODE_RECORD. These GUIDed HOBs record all the information
/// passed into the ReportStatusCode() service of PEI Services Table.
///
/// <pre>
/// Memory status code records packet structure :
/// +---------------+----------+----------+-----+----------+-----+----------+
/// | Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |
/// +---------------+----------+----------+-----+----------+-----+----------+
/// ^ ^ ^
/// +--------- RecordIndex -----------+ |
/// +---------------- MaxRecordsNumber----------------------+
/// </pre>
///
#define MEMORY_STATUS_CODE_RECORD_GUID \
{ \
0x60cc026, 0x4c0d, 0x4dda, {0x8f, 0x41, 0x59, 0x5f, 0xef, 0x0, 0xa5, 0x2} \
}
/**
Memory status code records packet structure :
+---------------+----------+----------+-----+----------+-----+----------+
| Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |
+---------------+----------+----------+-----+----------+-----+----------+
^ ^ ^
+--------- RecordIndex -----------+ |
+---------------- MaxRecordsNumber----------------------+
**/
///
/// A header structure that is followed by an array of records that contain the
/// parameters passed into the ReportStatusCode() service in the PEI Services Table.
///
typedef struct {
UINT16 PacketIndex; ///< Index of the Packet.
UINT16 RecordIndex; ///< Index of record in the packet.
UINT32 MaxRecordsNumber; ///< Max number of records in the packet.
///
/// Index of the packet
///
UINT16 PacketIndex;
///
/// The number of active records in the packet
///
UINT16 RecordIndex;
///
/// The maximum number of records that the packet can store
///
UINT32 MaxRecordsNumber;
} MEMORY_STATUSCODE_PACKET_HEADER;
///
/// A structure that contains the parameters passed into the ReportStatusCode()
/// service in the PEI Services Table.
///
typedef struct {
///
/// Status Code type to be reported.
///
EFI_STATUS_CODE_TYPE CodeType;
EFI_STATUS_CODE_TYPE CodeType;
///
/// Valu information about the class and subclass is used to
/// classify the hardware and software entity as well as an operation.
///
EFI_STATUS_CODE_VALUE Value;
EFI_STATUS_CODE_VALUE Value;
///
/// The enumeration of a hardware or software entity within
/// the system. Valid instance numbers start with 1
///
UINT32 Instance;
UINT32 Instance;
} MEMORY_STATUSCODE_RECORD;
extern EFI_GUID gMemoryStatusCodeRecordGuid;
#endif

View File

@ -30,12 +30,12 @@
#define EFI_STATUS_CODE_DATA_MAX_SIZE 200
///
/// This structire contains the ErrorLevel passed into the DEBUG() macro followed
/// This structure contains the ErrorLevel passed into the DEBUG() macro followed
/// by a 96-byte buffer that contains the variable argument list passed to the
// DEBUG() macro that has been converted to a BASE_LIST. The 96-byte buffer is
/// followed by a Null terminated ASCII string that is the Format string passed
/// to the DEBUG() macro. The maximum size of this structure is defined by
/// EFI_STATUS_CODE_DATAS_MAX_SIZE.
/// EFI_STATUS_CODE_DATA_MAX_SIZE.
///
typedef struct {
///

View File

@ -15,6 +15,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __TIANO_CUSTOM_DECOMPRESS_GUID_H__
#define __TIANO_CUSTOM_DECOMPRESS_GUID_H__
///
/// Global ID used to identify a section of an FFS file of type
/// EFI_SECTION_GUID_DEFINED whose contents have been compressed using
/// Tiano Custom compression.
///
#define TIANO_CUSTOM_DECOMPRESS_GUID \
{ 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 } }