]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
Committing changes to the comments, to improve code documentation.
[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
0e0ab706 4 Copyright (c) 2006 - 2009, Intel Corporation \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9 \r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
a9102619 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
0e0ab706 18///\r
19/// Global ID used to identify GUIDed HOBs that start with a structure of type \r
97482d94 20/// MEMORY_STATUSCODE_PACKET_HEADER followed by an array of structures of type \r
0e0ab706 21/// MEMORY_STATUSCODE_RECORD. These GUIDed HOBs record all the information \r
22/// passed into the ReportStatusCode() service of PEI Services Table.\r
23///\r
24/// <pre>\r
25/// Memory status code records packet structure :\r
26/// +---------------+----------+----------+-----+----------+-----+----------+\r
27/// | Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |\r
28/// +---------------+----------+----------+-----+----------+-----+----------+\r
29/// ^ ^ ^\r
30/// +--------- RecordIndex -----------+ |\r
31/// +---------------- MaxRecordsNumber----------------------+\r
32/// </pre>\r
33///\r
a9102619 34#define MEMORY_STATUS_CODE_RECORD_GUID \\r
35 { \\r
36 0x60cc026, 0x4c0d, 0x4dda, {0x8f, 0x41, 0x59, 0x5f, 0xef, 0x0, 0xa5, 0x2} \\r
37 }\r
38\r
0e0ab706 39///\r
40/// A header structure that is followed by an array of records that contain the \r
41/// parameters passed into the ReportStatusCode() service in the PEI Services Table.\r
42///\r
a9102619 43typedef struct {\r
0e0ab706 44 ///\r
45 /// Index of the packet\r
46 ///\r
47 UINT16 PacketIndex;\r
48 ///\r
49 /// The number of active records in the packet\r
50 ///\r
51 UINT16 RecordIndex;\r
52 ///\r
53 /// The maximum number of records that the packet can store\r
54 ///\r
55 UINT32 MaxRecordsNumber;\r
a9102619 56} MEMORY_STATUSCODE_PACKET_HEADER;\r
57\r
0e0ab706 58///\r
59/// A structure that contains the parameters passed into the ReportStatusCode() \r
60/// service in the PEI Services Table.\r
61///\r
a9102619 62typedef struct {\r
20774adc
LG
63 ///\r
64 /// Status Code type to be reported.\r
65 ///\r
0e0ab706 66 EFI_STATUS_CODE_TYPE CodeType;\r
20774adc
LG
67\r
68 ///\r
97482d94 69 /// An operation, plus value information about the class and subclass, used to\r
70 /// classify the hardware and software entity.\r
20774adc 71 ///\r
0e0ab706 72 EFI_STATUS_CODE_VALUE Value;\r
20774adc
LG
73\r
74 ///\r
75 /// The enumeration of a hardware or software entity within\r
76 /// the system. Valid instance numbers start with 1\r
77 ///\r
0e0ab706 78 UINT32 Instance;\r
a9102619 79} MEMORY_STATUSCODE_RECORD;\r
80\r
a9102619 81extern EFI_GUID gMemoryStatusCodeRecordGuid;\r
82\r
83#endif\r