hc
2024-03-26 e0728245c89800c2038c23308f2d88969d5b41c8
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
/** @file
*
*  Copyright (c) 2018, Hisilicon Limited. All rights reserved.
*  Copyright (c) 2018, Linaro Limited. All rights reserved.
*
*  SPDX-License-Identifier: BSD-2-Clause-Patent
*
**/
 
#include <Guid/Cper.h>
#include "Ghes.h"
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
 
#define READ_ACK_PRESERVE 0xFFFFFFFE
#define READ_ACK_WRITE 0x1
 
EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE*
ErrorBlockInitial (
  VOID   *Block,
  UINT32 Severity
)
{
  EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE* BlockHeader = Block;
  BlockHeader->BlockStatus = (EFI_ACPI_6_1_ERROR_BLOCK_STATUS) {0, 0, 0, 0, 0};
  BlockHeader->RawDataOffset = 0;
  BlockHeader->RawDataLength = 0;
  BlockHeader->DataLength = 0;
  BlockHeader->ErrorSeverity = Severity;
  return BlockHeader;
}
 
 
BOOLEAN
ErrorBlockUpdateStatusStructure (
  VOID *ErrorBlock
)
{
  if (ErrorBlock == NULL) {
    return FALSE;
  }
  IN EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE *BlockHeader =  ErrorBlock;
  VOID *EntriesBegin = ErrorBlock + sizeof (EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE);
  if (BlockHeader->BlockStatus.ErrorDataEntryCount == 0) {
    gBS->SetMem (EntriesBegin, BlockHeader->DataLength, 0);
    BlockHeader->RawDataLength = 0;
    BlockHeader->RawDataOffset = 0;
    BlockHeader->DataLength = 0;
  }
  return TRUE;
}
 
 
BOOLEAN
ErrorBlockAddErrorData (
  IN VOID                  *ErrorBlock,
  IN UINT32                MaxBlockLength,
  IN EFI_CPER_SECTION_TYPE TypeOfErrorData,
  IN VOID                  *GenericErrorData,
  IN UINT32                SizeOfGenericErrorData,
  IN ERROR_SEVERITY        ErrorSeverity,
  IN BOOLEAN               Correctable
)
{
  if (ErrorBlock == NULL || GenericErrorData == NULL) {
    DEBUG ((DEBUG_ERROR, "[%a]:[%dL]Invalid Param \n", __FUNCTION__, __LINE__));
    return FALSE;
  }
  EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE*  Entry;
  EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE* BlockHeader = ErrorBlock;
  EFI_ACPI_6_1_ERROR_BLOCK_STATUS* BlockStatus = &BlockHeader->BlockStatus;
  (VOID)ErrorBlockUpdateStatusStructure (ErrorBlock);
  UINT32 ExpectedNewDataLength = BlockHeader->DataLength +
           sizeof (EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE) +
           SizeOfGenericErrorData;
  if (sizeof (EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE) + ExpectedNewDataLength >
      MaxBlockLength) {
    DEBUG ((DEBUG_ERROR, "[%a]:[%dL]Out of BlockSize \n", __FUNCTION__, __LINE__));
    return FALSE;
  }
  // guid
  EFI_GUID Guid;
  switch (TypeOfErrorData) {
    case PROCESSOR_GENERIC:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_PROCESSOR_GENERIC_GUID;
      break;
    case PROCESSOR_ARM:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_PROCESSOR_SPECIFIC_ARM_GUID;
      break;
    case PLATFORM_MEMORY:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_PLATFORM_MEMORY_GUID;
      break;
    case PLATFORM_MEMORY2:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_PLATFORM_MEMORY2_GUID;
      break;
    case PCIE_EXPRESS:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_PCIE_GUID;
      break;
    case FIRMWARE_ERROR:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_FW_ERROR_RECORD_GUID;
      break;
    case PCI_BUS:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_PCI_PCIX_BUS_GUID;
      break;
    case PCI_COMPONENT:
      Guid = (EFI_GUID)EFI_ERROR_SECTION_PCI_DEVICE_GUID;
      break;
    default:
      return FALSE;
  }
  //Block Status
  if (Correctable == TRUE) {
    if (BlockStatus->CorrectableErrorValid == 0) {
      BlockStatus->CorrectableErrorValid = 1;
    } else {
      BlockStatus->MultipleCorrectableErrors = 1;
    }
  } else {
    if (BlockStatus->UncorrectableErrorValid == 0) {
      BlockStatus->UncorrectableErrorValid = 1;
    } else {
      BlockStatus->MultipleUncorrectableErrors = 1;
    }
  }
  BlockStatus->ErrorDataEntryCount++;
  // Entry
  Entry = (EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE*)(ErrorBlock +
           sizeof (EFI_ACPI_6_1_GENERIC_ERROR_STATUS_STRUCTURE) +
           BlockHeader->DataLength);
  gBS->SetMem (Entry, sizeof (EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE), 0);
  gBS->CopyMem (&Entry->SectionType, &Guid, sizeof (EFI_GUID));
  Entry->ErrorSeverity = ErrorSeverity;
  Entry->Revision = EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_REVISION;
  Entry->ErrorDataLength = SizeOfGenericErrorData;
  VOID*  GenericErrorDataFollowEntry = (VOID*)Entry +
           sizeof (EFI_ACPI_6_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE);
  gBS->CopyMem (
         GenericErrorDataFollowEntry,
         GenericErrorData,
         SizeOfGenericErrorData);
  // BlockHeader
  BlockHeader->RawDataOffset = 0;
  BlockHeader->RawDataLength = 0;
  BlockHeader->DataLength = ExpectedNewDataLength;
  return TRUE;
}
 
VOID
GhesV2Initial (
  EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_VERSION_2_STRUCTURE *GhesV2,
  UINT32                                                         BlockLength
)
{
  if (GhesV2 == NULL) {
    return;
  }
  *GhesV2 = (EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_VERSION_2_STRUCTURE) {
    .Type = EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_VERSION_2,
    .SourceId = 0,
    .RelatedSourceId = 0xFFFF,
    .Flags = 0,
    .Enabled = 1,
    .NumberOfRecordsToPreAllocate = 1,//ERROR BLOCK
    .MaxSectionsPerRecord = 1,// Num Entries(section)
    .MaxRawDataLength = BlockLength, // Max Size Of a Raw Data
    .ErrorStatusAddress = {
      .AddressSpaceId = EFI_ACPI_6_1_SYSTEM_MEMORY,
      .RegisterBitWidth = 64,
      .RegisterBitOffset = 0,
      .AccessSize = EFI_ACPI_6_1_QWORD,
      .Address = 0
    },
    .NotificationStructure = {
      .Type = EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_GSIV,
      .Length = sizeof (EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_VERSION_2_STRUCTURE),
      .ConfigurationWriteEnable = {0, 0, 0, 0, 0, 0, 0} ,
      .PollInterval = 0,
      .Vector = 0,
      .SwitchToPollingThresholdValue = 0,
      .SwitchToPollingThresholdWindow = 0,
      .ErrorThresholdValue = 0,
      .ErrorThresholdWindow = 0
    },
    .ErrorStatusBlockLength = BlockLength,
    .ReadAckRegister = {
      .AddressSpaceId = EFI_ACPI_6_1_SYSTEM_MEMORY,
      .RegisterBitWidth = 64,
      .RegisterBitOffset = 0,
      .AccessSize = EFI_ACPI_6_1_QWORD,
      .Address = 0
    },
    .ReadAckPreserve = READ_ACK_PRESERVE,
    .ReadAckWrite = READ_ACK_WRITE
  };
  return;
}
 
VOID
GhesV2AddNotification (
  EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_VERSION_2_STRUCTURE  *This,
  UINT8                                                           Type
)
{
  This->NotificationStructure = (EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE) {
    .Type = Type,
    .Length = sizeof (EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_VERSION_2_STRUCTURE),
    .ConfigurationWriteEnable = {
      .Type = 0,
      .PollInterval = 1,
      .SwitchToPollingThresholdValue = 1,
      .SwitchToPollingThresholdWindow = 1,
      .ErrorThresholdValue = 1,
      .ErrorThresholdWindow = 1
    },
    .PollInterval = 20,
    .Vector = 0,
    .SwitchToPollingThresholdValue = 0,
    .SwitchToPollingThresholdWindow = 0,
    .ErrorThresholdValue = 0,
    .ErrorThresholdWindow = 0
  };
  return;
}
 
EFI_STATUS
GhesV2LinkErrorBlock (
  EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_VERSION_2_STRUCTURE *GhesV2,
  GHES_REGISTER                                                  *Register,
  VOID                                                           *ErrorBlock
)
{
  if (ErrorBlock == NULL || Register == NULL || GhesV2 == NULL) {
    return EFI_INVALID_PARAMETER;
  }
 
  Register->ErrorStatusBlockAddress = (UINTN)ErrorBlock;
  GhesV2->ErrorStatusAddress.Address = (UINTN)&(Register->ErrorStatusBlockAddress);
  Register->AckRegister = READ_ACK_WRITE;
  GhesV2->ReadAckRegister.Address = (UINT64)&(Register->AckRegister);
  return EFI_SUCCESS;
}
 
 
VOID GhesV1Initial (
  EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE *GhesV1,
  UINT32 BlockLength
)
{
  if (GhesV1 == NULL) {
    return;
  }
  *GhesV1 = (EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE) {
    .Type = EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR,
    .SourceId = 0,
    .RelatedSourceId = 0xFFFF,
    .Flags = 0,
    .Enabled = 1,
    .NumberOfRecordsToPreAllocate = 1,//ERROR BLOCK
    .MaxSectionsPerRecord = 1,// Num Entries(section)
    .MaxRawDataLength = BlockLength, // Max Size Of a Raw Data
    .ErrorStatusAddress = {
      .AddressSpaceId = EFI_ACPI_6_1_SYSTEM_MEMORY,
      .RegisterBitWidth = 64,
      .RegisterBitOffset = 0,
      .AccessSize = EFI_ACPI_6_1_QWORD,
      .Address = 0
    },
    .NotificationStructure = {
      .Type = EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_GSIV,
      .Length = sizeof (EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE),
      .ConfigurationWriteEnable = {0, 0, 0, 0, 0, 0, 0},
      .PollInterval = 0,
      .Vector = 0,
      .SwitchToPollingThresholdValue = 0,
      .SwitchToPollingThresholdWindow = 0,
      .ErrorThresholdValue = 0,
      .ErrorThresholdWindow = 0
    },
    .ErrorStatusBlockLength = BlockLength,
  };
  return;
}
 
VOID
GhesV1AddNotification (
  EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE *This,
  UINT8                                                Type
)
{
  This->NotificationStructure = (EFI_ACPI_6_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE) {
    .Type = Type,
    .Length = sizeof (EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE),
    .ConfigurationWriteEnable = {
      .Type = 0,
      .PollInterval = 1,
      .SwitchToPollingThresholdValue = 1,
      .SwitchToPollingThresholdWindow = 1,
      .ErrorThresholdValue = 1,
      .ErrorThresholdWindow = 1
    },
    .PollInterval = 20,
    .Vector = 0,
    .SwitchToPollingThresholdValue = 0,
    .SwitchToPollingThresholdWindow = 0,
    .ErrorThresholdValue = 0,
    .ErrorThresholdWindow = 0
  };
  return;
}
 
EFI_STATUS GhesV1LinkErrorBlock (
  EFI_ACPI_6_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE *This,
  UINT64                                               *ptrBlockAddress,
  VOID                                                 *ErrorBlock
)
{
  if (ErrorBlock == NULL || ptrBlockAddress == NULL || This == NULL) {
    return EFI_INVALID_PARAMETER;
  }
  *ptrBlockAddress = (UINTN)ErrorBlock;
  This->ErrorStatusAddress.Address = (UINTN) ptrBlockAddress;
  return EFI_SUCCESS;
}