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
|
/** @file
BERT Table Generator
Copyright (c) 2026, Arm Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Glossary:
- Cm or CM - Configuration Manager
- Obj or OBJ - Object
@par Reference(s):
- ACPI 6.6 Specification, January 2025
**/
#include <AcpiTableGenerator.h>
#include <ConfigurationManagerHelper.h>
#include <ConfigurationManagerObject.h>
#include <IndustryStandard/Acpi66.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/TableHelperLib.h>
#include <Protocol/ConfigurationManagerProtocol.h>
/** Standard BERT Generator
Requirements:
The following Configuration Manager Object is required by this Generator:
- EArchCommonObjBootErrorRegionInfo
*/
/** Retrieve the Boot Error Region information. */
GET_OBJECT_LIST (
EObjNameSpaceArchCommon,
EArchCommonObjBootErrorRegionInfo,
CM_ARCH_COMMON_BOOT_ERROR_REGION_INFO
);
/** Construct the BERT ACPI table.
This function invokes the Configuration Manager protocol interface to get
the Boot Error Region information required for generating the ACPI table.
@param [in] This Pointer to the table generator.
@param [in] AcpiTableInfo Pointer to the ACPI Table Info.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager Protocol.
@param [out] Table Pointer to the constructed ACPI Table.
@retval EFI_SUCCESS Table generated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object was not found.
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration Manager
is smaller than the requested object.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
**/
STATIC
EFI_STATUS
EFIAPI
BuildBertTable (
IN CONST ACPI_TABLE_GENERATOR *CONST This,
IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
OUT EFI_ACPI_DESCRIPTION_HEADER **CONST Table
)
{
EFI_STATUS Status;
CM_ARCH_COMMON_BOOT_ERROR_REGION_INFO *BootErrorRegionInfo;
EFI_ACPI_6_6_BOOT_ERROR_RECORD_TABLE_HEADER *Bert;
ASSERT (This != NULL);
ASSERT (AcpiTableInfo != NULL);
ASSERT (CfgMgrProtocol != NULL);
ASSERT (Table != NULL);
ASSERT (AcpiTableInfo->TableGeneratorId == This->GeneratorID);
ASSERT (AcpiTableInfo->AcpiTableSignature == This->AcpiTableSignature);
if ((AcpiTableInfo->AcpiTableRevision < This->MinAcpiTableRevision) ||
(AcpiTableInfo->AcpiTableRevision > This->AcpiTableRevision))
{
DEBUG ((
DEBUG_ERROR,
"ERROR: BERT: Requested table revision = %d is not supported. "
"Supported table revision: Minimum = %d, Maximum = %d\n",
AcpiTableInfo->AcpiTableRevision,
This->MinAcpiTableRevision,
This->AcpiTableRevision
));
return EFI_INVALID_PARAMETER;
}
*Table = NULL;
Status = GetEArchCommonObjBootErrorRegionInfo (
CfgMgrProtocol,
CM_NULL_TOKEN,
&BootErrorRegionInfo,
NULL
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: BERT: Failed to get Boot Error Region information. "
"Status = %r\n",
Status
));
return Status;
}
if (BootErrorRegionInfo->BootErrorRegion == 0) {
DEBUG ((
DEBUG_ERROR,
"ERROR: BERT: Boot Error Region address must not be zero.\n"
));
return EFI_INVALID_PARAMETER;
}
if (BootErrorRegionInfo->BootErrorRegionLength <
sizeof (EFI_ACPI_6_6_GENERIC_ERROR_STATUS_STRUCTURE))
{
DEBUG ((
DEBUG_ERROR,
"ERROR: BERT: Boot Error Region is too small. "
"Length = 0x%x, Minimum = 0x%x\n",
BootErrorRegionInfo->BootErrorRegionLength,
(UINT32)sizeof (EFI_ACPI_6_6_GENERIC_ERROR_STATUS_STRUCTURE)
));
return EFI_INVALID_PARAMETER;
}
Bert = AllocateZeroPool (sizeof (*Bert));
if (Bert == NULL) {
DEBUG ((DEBUG_ERROR, "ERROR: BERT: Failed to allocate the BERT table.\n"));
return EFI_OUT_OF_RESOURCES;
}
Status = AddAcpiHeader (
CfgMgrProtocol,
This,
&Bert->Header,
AcpiTableInfo,
sizeof (*Bert)
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: BERT: Failed to add ACPI header. Status = %r\n",
Status
));
FreePool (Bert);
return Status;
}
Bert->BootErrorRegionLength = BootErrorRegionInfo->BootErrorRegionLength;
Bert->BootErrorRegion = BootErrorRegionInfo->BootErrorRegion;
*Table = &Bert->Header;
return EFI_SUCCESS;
}
/** Free resources allocated for constructing the BERT table.
@param [in] This Pointer to the table generator.
@param [in] AcpiTableInfo Pointer to the ACPI Table Info.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol interface.
@param [in, out] Table Pointer to the constructed ACPI Table.
@retval EFI_SUCCESS The resources were freed successfully.
@retval EFI_INVALID_PARAMETER The table pointer is NULL.
**/
STATIC
EFI_STATUS
EFIAPI
FreeBertTableResources (
IN CONST ACPI_TABLE_GENERATOR *CONST This,
IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
IN OUT EFI_ACPI_DESCRIPTION_HEADER **CONST Table
)
{
ASSERT (This != NULL);
ASSERT (AcpiTableInfo != NULL);
ASSERT (CfgMgrProtocol != NULL);
ASSERT (AcpiTableInfo->TableGeneratorId == This->GeneratorID);
ASSERT (AcpiTableInfo->AcpiTableSignature == This->AcpiTableSignature);
if (Table == NULL) {
DEBUG ((DEBUG_ERROR, "ERROR: BERT: Invalid Table Pointer\n"));
ASSERT (Table != NULL);
return EFI_INVALID_PARAMETER;
}
if (*Table != NULL) {
FreePool (*Table);
*Table = NULL;
}
return EFI_SUCCESS;
}
/** This macro defines the BERT Table Generator revision. */
#define BERT_GENERATOR_REVISION CREATE_REVISION (1, 0)
/** The interface for the BERT Table Generator. */
STATIC
CONST
ACPI_TABLE_GENERATOR BertGenerator = {
// Generator ID
CREATE_STD_ACPI_TABLE_GEN_ID (EStdAcpiTableIdBert),
// Generator Description
L"ACPI.STD.BERT.GENERATOR",
// ACPI Table Signature
EFI_ACPI_6_6_BOOT_ERROR_RECORD_TABLE_SIGNATURE,
// ACPI Table Revision supported by this Generator
EFI_ACPI_6_6_BOOT_ERROR_RECORD_TABLE_REVISION,
// Minimum supported ACPI Table Revision
EFI_ACPI_6_6_BOOT_ERROR_RECORD_TABLE_REVISION,
// Creator ID
TABLE_GENERATOR_CREATOR_ID,
// Creator Revision
BERT_GENERATOR_REVISION,
// Build Table function
BuildBertTable,
// Free Resource function
FreeBertTableResources,
// Extended build function not needed.
NULL,
// Extended free resource function not needed.
NULL
};
/** Register the Generator with the ACPI Table Factory.
@param [in] ImageHandle The handle to the image.
@param [in] SystemTable Pointer to the System Table.
@retval EFI_SUCCESS The Generator was registered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_ALREADY_STARTED The Generator is already registered.
**/
EFI_STATUS
EFIAPI
AcpiBertLibConstructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
Status = RegisterAcpiTableGenerator (&BertGenerator);
DEBUG ((DEBUG_INFO, "BERT: Register Generator. Status = %r\n", Status));
ASSERT_EFI_ERROR (Status);
return Status;
}
/** Deregister the Generator from the ACPI Table Factory.
@param [in] ImageHandle The handle to the image.
@param [in] SystemTable Pointer to the System Table.
@retval EFI_SUCCESS The Generator was deregistered.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The Generator is not registered.
**/
EFI_STATUS
EFIAPI
AcpiBertLibDestructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
Status = DeregisterAcpiTableGenerator (&BertGenerator);
DEBUG ((DEBUG_INFO, "BERT: Deregister Generator. Status = %r\n", Status));
ASSERT_EFI_ERROR (Status);
return Status;
}
|
