1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/** @file
Copyright (c) 2019-2023, Intel Corporation. All rights reserved.<BR>
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* Neither the name of Intel Corporation nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
**/
#ifndef _ENHANCED_WARNING_LOG_LIB_
#define _ENHANCED_WARNING_LOG_LIB_
#define FSP_RESERVED_LEN 12
#pragma pack(1)
///
/// Enhanced Warning Log Header
///
typedef struct {
EFI_GUID EwlGuid; /// GUID that uniquely identifies the EWL revision
UINT32 Size; /// Total size in bytes including the header and buffer
UINT32 FreeOffset; /// Offset of the beginning of the free space from byte 0
/// of the buffer immediately following this structure
/// Can be used to determine if buffer has sufficient space for next entry
UINT32 Crc; /// 32-bit CRC generated over the whole size minus this crc field
/// Note: UEFI 32-bit CRC implementation (CalculateCrc32) (References [7])
/// Consumers can ignore CRC check if not needed.
UINT32 Reserved; /// Reserved for future use, must be initialized to 0
} EWL_HEADER;
///
/// List of all entry types supported by this revision of EWL
///
typedef enum {
EwlType0 = 0,
EwlType1 = 1,
EwlType2 = 2,
EwlType3 = 3,
EwlType4 = 4,
EwlType5 = 5,
EwlType6 = 6,
EwlType7 = 7,
EwlType8 = 8,
EwlType9 = 9,
EwlType10 = 10,
EwlType11 = 11,
EwlType12 = 12,
EwlType13 = 13,
EwlType14 = 14,
EwlType15 = 15,
EwlType16 = 16,
EwlType17 = 17,
EwlType18 = 18,
EwlType19 = 19,
EwlType20 = 20,
EwlType21 = 21,
EwlType22 = 22,
EwlType23 = 23,
EwlType24 = 24,
EwlType25 = 25,
EwlType26 = 26,
EwlType27 = 27,
EwlType28 = 28,
EwlType29 = 29,
EwlType30 = 30,
EwlType31 = 31,
EwlType32 = 32,
EwlTypeMax,
EwlTypeOem = 0x8000,
EwlTypeDelim = MAX_INT32
} EWL_TYPE;
///
/// EWL severities
///
typedef enum {
EwlSeverityInfo,
EwlSeverityWarning,
EwlSeverityFatal,
EwlSeverityMax,
EwlSeverityDelim = MAX_INT32
} EWL_SEVERITY;
///
/// Generic entry header for parsing the log
///
typedef struct {
EWL_TYPE Type;
UINT16 Size; /// Entries will be packed by byte in contiguous space
EWL_SEVERITY Severity; /// Warning, error, informational, this may be extended in the future
} EWL_ENTRY_HEADER;
///
/// Legacy content provides context of the warning
///
typedef struct {
UINT8 MajorCheckpoint; // EWL Spec - Appendix B
UINT8 MinorCheckpoint;
UINT8 MajorWarningCode; // EWL Spec - Appendix A
UINT8 MinorWarningCode;
} EWL_ENTRY_CONTEXT;
///
/// Legacy content to specify memory location
///
typedef struct {
UINT8 Socket; /// 0xFF = n/a
UINT8 Channel; /// 0xFF = n/a
UINT8 PseudoChannel; /// 0xFF = n/a
UINT8 Dimm; /// 0xFF = n/a
UINT8 Rank; /// 0xFF = n/a
} EWL_ENTRY_MEMORY_LOCATION;
///
/// Type 3 = Enhanced type for command, control IO errors
///
typedef struct {
EWL_ENTRY_HEADER Header;
EWL_ENTRY_CONTEXT Context;
EWL_ENTRY_MEMORY_LOCATION MemoryLocation;
UINT8 reserved1[FSP_RESERVED_LEN]; // MRC_LT Level; MRC_GT Group; GSM_CSN Signal;
UINT8 EyeSize; // 0xFF = n/a
} EWL_ENTRY_TYPE3;
#pragma pack()
///
/// Enhanced Warning Log Spec defined data log structure
///
typedef struct {
EWL_HEADER Header; /// The size will vary by implementation and should not be assumed
UINT8 Buffer[4 * 1024]; /// The spec requirement is that the buffer follow the header
} EWL_PUBLIC_DATA;
///
/// EWL private data structure. This is going to be implementation dependent
/// When we separate OEM hooks via a PPI, we can remove this
///
typedef struct {
UINT32 bufSizeOverflow; // Number of bytes that could not be added to buffer
UINT32 numEntries; // Number of entries currently logged
EWL_PUBLIC_DATA status; // Spec defined EWL
} EWL_PRIVATE_DATA;
#endif // #ifndef _ENHANCED_WARNING_LOG_LIB_
|
