X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkModulePkg%2FInclude%2FGuid%2FMemoryStatusCodeRecord.h;h=fcc7a0d72e11cc19774ba51437ad13eb209be605;hp=4f623b5de6dcbea69d2a28687b8f5684731d1f3c;hb=20774adc0f4a334aef9e05e6e61a762aa3acef53;hpb=f423cbf1e9222c32e1f9974dc6621c5a37cb5c05 diff --git a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h index 4f623b5de6..fcc7a0d72e 100644 --- a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h +++ b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h @@ -1,7 +1,7 @@ /** @file GUID used to identify status code records HOB that originate from the PEI status code -Copyright (c) 2006, 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 @@ -30,15 +30,28 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +---------------- MaxRecordsNumber----------------------+ **/ 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. + UINT16 PacketIndex; ///< Index of the Packet. + UINT16 RecordIndex; ///< Index of record in the packet. + UINT32 MaxRecordsNumber; ///< Max number of records in the packet. } MEMORY_STATUSCODE_PACKET_HEADER; typedef struct { - EFI_STATUS_CODE_TYPE CodeType; - EFI_STATUS_CODE_VALUE Value; - UINT32 Instance; + /// + /// Status Code type to be reported. + /// + 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; + + /// + /// The enumeration of a hardware or software entity within + /// the system. Valid instance numbers start with 1 + /// + UINT32 Instance; } MEMORY_STATUSCODE_RECORD;