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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
|
/** @file
GTDT table parser
Copyright (c) 2016 - 2024, Arm Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Reference(s):
- ACPI 6.4 Specification - January 2021
**/
#include <IndustryStandard/Acpi.h>
#include <Library/UefiLib.h>
#include "AcpiParser.h"
#include "AcpiTableParser.h"
#include "AcpiViewConfig.h"
// "The number of GT Block Timers must be less than or equal to 8"
#define GT_BLOCK_TIMER_COUNT_MAX 8
// Local variables
STATIC CONST UINT32 *GtdtPlatformTimerCount;
STATIC CONST UINT32 *GtdtPlatformTimerOffset;
STATIC CONST UINT8 *PlatformTimerType;
STATIC CONST UINT16 *PlatformTimerLength;
STATIC CONST UINT32 *GtBlockTimerCount;
STATIC CONST UINT32 *GtBlockTimerOffset;
STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;
/**
This function validates the GT Block timer count.
@param [in] Ptr Pointer to the start of the field data.
@param [in] Length Length of the field.
@param [in] Context Pointer to context specific information e.g. this
could be a pointer to the ACPI table header.
**/
STATIC
VOID
EFIAPI
ValidateGtBlockTimerCount (
IN UINT8 *Ptr,
IN UINT32 Length,
IN VOID *Context
)
{
UINT32 BlockTimerCount;
BlockTimerCount = *(UINT32 *)Ptr;
if (BlockTimerCount > GT_BLOCK_TIMER_COUNT_MAX) {
IncrementErrorCount ();
Print (
L"\nERROR: Timer Count = %d. Max Timer Count is %d.",
BlockTimerCount,
GT_BLOCK_TIMER_COUNT_MAX
);
}
}
/**
This function validates the GT Frame Number.
@param [in] Ptr Pointer to the start of the field data.
@param [in] Length Length of the field.
@param [in] Context Pointer to context specific information e.g. this
could be a pointer to the ACPI table header.
**/
STATIC
VOID
EFIAPI
ValidateGtFrameNumber (
IN UINT8 *Ptr,
IN UINT32 Length,
IN VOID *Context
)
{
UINT8 FrameNumber;
FrameNumber = *(UINT8 *)Ptr;
if (FrameNumber >= GT_BLOCK_TIMER_COUNT_MAX) {
IncrementErrorCount ();
Print (
L"\nERROR: GT Frame Number = %d. GT Frame Number must be in range 0-%d.",
FrameNumber,
GT_BLOCK_TIMER_COUNT_MAX - 1
);
}
}
/**
An ACPI_PARSER array describing the ACPI GTDT Table.
**/
STATIC CONST ACPI_PARSER GtdtParser[] = {
PARSE_ACPI_HEADER (&AcpiHdrInfo),
{ L"CntControlBase Physical Address",8, 36, L"0x%lx", NULL, NULL,
NULL, NULL },
{ L"Reserved", 4, 44, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Secure EL1 timer GSIV", 4, 48, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Secure EL1 timer FLAGS", 4, 52, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Non-Secure EL1 timer GSIV", 4, 56, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Non-Secure EL1 timer FLAGS", 4, 60, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Virtual timer GSIV", 4, 64, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Virtual timer FLAGS", 4, 68, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Non-Secure EL2 timer GSIV", 4, 72, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Non-Secure EL2 timer FLAGS", 4, 76, L"0x%x", NULL, NULL,NULL, NULL },
{ L"CntReadBase Physical address", 8, 80, L"0x%lx", NULL, NULL,NULL, NULL },
{ L"Platform Timer Count", 4, 88, L"%d", NULL,
(VOID **)&GtdtPlatformTimerCount, NULL, NULL },
{ L"Platform Timer Offset", 4, 92, L"0x%x", NULL,
(VOID **)&GtdtPlatformTimerOffset,NULL, NULL },
{ L"Virtual EL2 Timer GSIV", 4, 96, L"0x%x", NULL, NULL,NULL, NULL },
{ L"Virtual EL2 Timer Flags", 4, 100, L"0x%x", NULL, NULL,NULL, NULL }
};
/**
An ACPI_PARSER array describing the Platform timer header.
**/
STATIC CONST ACPI_PARSER GtPlatformTimerHeaderParser[] = {
{ L"Type", 1, 0, NULL, NULL, (VOID **)&PlatformTimerType, NULL, NULL },
{ L"Length", 2, 1, NULL, NULL, (VOID **)&PlatformTimerLength, NULL, NULL },
{ L"Reserved", 1, 3, NULL, NULL, NULL, NULL, NULL }
};
/**
An ACPI_PARSER array describing the Platform GT Block.
**/
STATIC CONST ACPI_PARSER GtBlockParser[] = {
{ L"Type", 1, 0, L"%d", NULL, NULL, NULL, NULL },
{ L"Length", 2, 1, L"%d", NULL, NULL, NULL, NULL },
{ L"Reserved", 1, 3, L"%x", NULL, NULL, NULL, NULL },
{ L"Physical address (CntCtlBase)", 8, 4, L"0x%lx", NULL, NULL, NULL, NULL },
{ L"Timer Count", 4, 12, L"%d", NULL, (VOID **)&GtBlockTimerCount,
ValidateGtBlockTimerCount, NULL },
{ L"Timer Offset", 4, 16, L"%d", NULL, (VOID **)&GtBlockTimerOffset, NULL,
NULL }
};
/**
An ACPI_PARSER array describing the GT Block timer.
**/
STATIC CONST ACPI_PARSER GtBlockTimerParser[] = {
{ L"Frame Number", 1, 0, L"%d", NULL, NULL, ValidateGtFrameNumber, NULL },
{ L"Reserved", 3, 1, L"%x %x %x", Dump3Chars, NULL, NULL, NULL },
{ L"Physical address (CntBaseX)", 8, 4, L"0x%lx", NULL, NULL, NULL, NULL },
{ L"Physical address (CntEL0BaseX)", 8, 12, L"0x%lx", NULL, NULL, NULL,
NULL },
{ L"Physical Timer GSIV", 4, 20, L"0x%x", NULL, NULL, NULL, NULL },
{ L"Physical Timer Flags", 4, 24, L"0x%x", NULL, NULL, NULL, NULL },
{ L"Virtual Timer GSIV", 4, 28, L"0x%x", NULL, NULL, NULL, NULL },
{ L"Virtual Timer Flags", 4, 32, L"0x%x", NULL, NULL, NULL, NULL },
{ L"Common Flags", 4, 36, L"0x%x", NULL, NULL, NULL, NULL }
};
/**
An ACPI_PARSER array describing the Platform Watchdog.
**/
STATIC CONST ACPI_PARSER ArmGenericWatchdogParser[] = {
{ L"Type", 1, 0, L"%d", NULL, NULL, NULL, NULL },
{ L"Length", 2, 1, L"%d", NULL, NULL, NULL, NULL },
{ L"Reserved", 1, 3, L"%x", NULL, NULL, NULL, NULL },
{ L"RefreshFrame Physical address", 8, 4, L"0x%lx", NULL, NULL, NULL, NULL },
{ L"ControlFrame Physical address", 8, 12, L"0x%lx", NULL, NULL, NULL, NULL },
{ L"Watchdog Timer GSIV", 4, 20, L"0x%x", NULL, NULL, NULL, NULL },
{ L"Watchdog Timer Flags", 4, 24, L"0x%x", NULL, NULL, NULL, NULL }
};
/**
This function parses the Platform GT Block.
@param [in] Ptr Pointer to the start of the GT Block data.
@param [in] Length Length of the GT Block structure.
**/
STATIC
VOID
DumpGTBlock (
IN UINT8 *Ptr,
IN UINT16 Length
)
{
UINT32 Index;
UINT32 Offset;
ParseAcpi (
TRUE,
2,
"GT Block",
Ptr,
Length,
PARSER_PARAMS (GtBlockParser)
);
// Check if the values used to control the parsing logic have been
// successfully read.
if ((GtBlockTimerCount == NULL) ||
(GtBlockTimerOffset == NULL))
{
IncrementErrorCount ();
Print (
L"ERROR: Insufficient GT Block Structure length. Length = %d.\n",
Length
);
return;
}
Offset = *GtBlockTimerOffset;
Index = 0;
// Parse the specified number of GT Block Timer Structures or the GT Block
// Structure buffer length. Whichever is minimum.
while ((Index++ < *GtBlockTimerCount) &&
(Offset < Length))
{
Offset += ParseAcpi (
TRUE,
2,
"GT Block Timer",
Ptr + Offset,
Length - Offset,
PARSER_PARAMS (GtBlockTimerParser)
);
}
}
/**
This function parses the Platform Watchdog timer.
@param [in] Ptr Pointer to the start of the watchdog timer data.
@param [in] Length Length of the watchdog timer structure.
**/
STATIC
VOID
DumpWatchdogTimer (
IN UINT8 *Ptr,
IN UINT16 Length
)
{
ParseAcpi (
TRUE,
2,
"Arm Generic Watchdog",
Ptr,
Length,
PARSER_PARAMS (ArmGenericWatchdogParser)
);
}
/**
This function parses the ACPI GTDT table.
When trace is enabled this function parses the GTDT table and
traces the ACPI table fields.
This function also parses the following platform timer structures:
- GT Block timer
- Watchdog timer
This function also performs validation of the ACPI table fields.
@param [in] Trace If TRUE, trace the ACPI fields.
@param [in] Ptr Pointer to the start of the buffer.
@param [in] AcpiTableLength Length of the ACPI table.
@param [in] AcpiTableRevision Revision of the ACPI table.
**/
VOID
EFIAPI
ParseAcpiGtdt (
IN BOOLEAN Trace,
IN UINT8 *Ptr,
IN UINT32 AcpiTableLength,
IN UINT8 AcpiTableRevision
)
{
UINT32 Index;
UINT32 Offset;
UINT8 *TimerPtr;
if (!Trace) {
return;
}
ParseAcpi (
TRUE,
0,
"GTDT",
Ptr,
AcpiTableLength,
PARSER_PARAMS (GtdtParser)
);
// Check if the values used to control the parsing logic have been
// successfully read.
if ((GtdtPlatformTimerCount == NULL) ||
(GtdtPlatformTimerOffset == NULL))
{
IncrementErrorCount ();
Print (
L"ERROR: Insufficient table length. AcpiTableLength = %d.\n",
AcpiTableLength
);
return;
}
TimerPtr = Ptr + *GtdtPlatformTimerOffset;
Offset = *GtdtPlatformTimerOffset;
Index = 0;
// Parse the specified number of Platform Timer Structures or the GTDT
// buffer length. Whichever is minimum.
while ((Index++ < *GtdtPlatformTimerCount) &&
(Offset < AcpiTableLength))
{
// Parse the Platform Timer Header to obtain Length and Type
ParseAcpi (
FALSE,
0,
NULL,
TimerPtr,
AcpiTableLength - Offset,
PARSER_PARAMS (GtPlatformTimerHeaderParser)
);
// Check if the values used to control the parsing logic have been
// successfully read.
if ((PlatformTimerType == NULL) ||
(PlatformTimerLength == NULL))
{
IncrementErrorCount ();
Print (
L"ERROR: Insufficient remaining table buffer length to read the " \
L"Platform Timer Structure header. Length = %d.\n",
AcpiTableLength - Offset
);
return;
}
// Validate Platform Timer Structure length
if ((*PlatformTimerLength == 0) ||
((Offset + (*PlatformTimerLength)) > AcpiTableLength))
{
IncrementErrorCount ();
Print (
L"ERROR: Invalid Platform Timer Structure length. " \
L"Length = %d. Offset = %d. AcpiTableLength = %d.\n",
*PlatformTimerLength,
Offset,
AcpiTableLength
);
return;
}
switch (*PlatformTimerType) {
case EFI_ACPI_6_4_GTDT_GT_BLOCK:
DumpGTBlock (TimerPtr, *PlatformTimerLength);
break;
case EFI_ACPI_6_4_GTDT_ARM_GENERIC_WATCHDOG:
DumpWatchdogTimer (TimerPtr, *PlatformTimerLength);
break;
default:
IncrementErrorCount ();
Print (
L"ERROR: Invalid Platform Timer Type = %d\n",
*PlatformTimerType
);
break;
} // switch
TimerPtr += *PlatformTimerLength;
Offset += *PlatformTimerLength;
} // while
}
|
