]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
Clean up Doxygen commenting.
[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Guid / MemoryStatusCodeRecord.h
CommitLineData
8ca67c46 1/** @file\r
3db51098 2 GUID used to identify status code records HOB that originate from the PEI status code \r
3 \r
20774adc 4Copyright (c) 2006 - 2009, Intel Corporation \r
a9102619 5All rights reserved. This program and the accompanying materials \r
6are licensed and made available under the terms and conditions of the BSD License \r
7which accompanies this distribution. The full text of the license may be found at \r
8http://opensource.org/licenses/bsd-license.php \r
9 \r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
3db51098 13**/\r
a9102619 14\r
15#ifndef __MEMORY_STATUS_CODE_RECORD_H__\r
16#define __MEMORY_STATUS_CODE_RECORD_H__\r
17\r
18#define MEMORY_STATUS_CODE_RECORD_GUID \\r
19 { \\r
20 0x60cc026, 0x4c0d, 0x4dda, {0x8f, 0x41, 0x59, 0x5f, 0xef, 0x0, 0xa5, 0x2} \\r
21 }\r
22\r
23/**\r
24 Memory status code records packet structure :\r
25 +---------------+----------+----------+-----+----------+-----+----------+\r
26 | Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |\r
27 +---------------+----------+----------+-----+----------+-----+----------+\r
28 ^ ^ ^\r
29 +--------- RecordIndex -----------+ |\r
30 +---------------- MaxRecordsNumber----------------------+\r
31**/\r
32typedef struct {\r
20774adc
LG
33 UINT16 PacketIndex; ///< Index of the Packet.\r
34 UINT16 RecordIndex; ///< Index of record in the packet.\r
35 UINT32 MaxRecordsNumber; ///< Max number of records in the packet.\r
a9102619 36} MEMORY_STATUSCODE_PACKET_HEADER;\r
37\r
38typedef struct {\r
20774adc
LG
39 ///\r
40 /// Status Code type to be reported.\r
41 ///\r
42 EFI_STATUS_CODE_TYPE CodeType;\r
43\r
44 ///\r
45 /// Valu information about the class and subclass is used to\r
46 /// classify the hardware and software entity as well as an operation.\r
47 ///\r
48 EFI_STATUS_CODE_VALUE Value;\r
49\r
50 ///\r
51 /// The enumeration of a hardware or software entity within\r
52 /// the system. Valid instance numbers start with 1\r
53 ///\r
54 UINT32 Instance;\r
a9102619 55} MEMORY_STATUSCODE_RECORD;\r
56\r
57\r
58extern EFI_GUID gMemoryStatusCodeRecordGuid;\r
59\r
60#endif\r