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
|
/** @file
Arm generic timer parser.
Copyright (c) 2021 - 2026, ARM Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Reference(s):
- linux/Documentation/devicetree/bindings/timer/arm,arch_timer.yaml
**/
#include <Library/BaseMemoryLib.h>
#include <Library/FdtLib.h>
#include "FdtHwInfoParser.h"
#include "CmObjectDescUtility.h"
#include "Arm/GenericTimer/ArmGenericTimerParser.h"
#include "Arm/Gic/ArmGicDispatcher.h"
/** List of "compatible" property values for timer nodes.
Other "compatible" values are not supported by this module.
*/
STATIC CONST COMPATIBILITY_STR TimerCompatibleStr[] = {
{ "arm,armv7-timer" },
{ "arm,armv8-timer" }
};
/** Timer compatiblity information.
*/
STATIC CONST COMPATIBILITY_INFO TimerCompatibleInfo = {
ARRAY_SIZE (TimerCompatibleStr),
TimerCompatibleStr
};
/** Parse a timer node.
@param [in] Fdt Pointer to a Flattened Device Tree (Fdt).
@param [in] TimerNode Offset of a timer node.
@param [in] GenericTimerInfo The CM_ARM_BOOT_ARCH_INFO to populate.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
TimerNodeParser (
IN CONST VOID *Fdt,
IN INT32 TimerNode,
IN CM_ARM_GENERIC_TIMER_INFO *GenericTimerInfo
)
{
EFI_STATUS Status;
CONST UINT32 *Data;
CONST UINT32 *DecodedInterruptData;
INT32 DecodedInterruptCells;
INT32 DataSize;
UINT32 AlwaysOnTimerFlag;
if ((Fdt == NULL) ||
(GenericTimerInfo == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Data = FdtGetProp (Fdt, TimerNode, "always-on", &DataSize);
if ((Data == NULL) || (DataSize < 0)) {
AlwaysOnTimerFlag = 0;
} else {
AlwaysOnTimerFlag = BIT2;
}
Status = FdtResolveInterrupt (
Fdt,
TimerNode,
FdtSecureTimerIrq,
&DecodedInterruptData,
&DecodedInterruptCells
);
if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) {
ASSERT (0);
return Status;
} else if (Status == EFI_NOT_FOUND) {
GenericTimerInfo->SecurePL1TimerGSIV = 0;
GenericTimerInfo->SecurePL1TimerFlags = 0;
} else {
GenericTimerInfo->SecurePL1TimerGSIV = FdtGetInterruptId (DecodedInterruptData, DecodedInterruptCells);
GenericTimerInfo->SecurePL1TimerFlags = FdtGetInterruptFlags (DecodedInterruptData, DecodedInterruptCells) | AlwaysOnTimerFlag;
}
Status = FdtResolveInterrupt (
Fdt,
TimerNode,
FdtNonSecureTimerIrq,
&DecodedInterruptData,
&DecodedInterruptCells
);
if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) {
ASSERT (0);
return Status;
} else if (Status == EFI_NOT_FOUND) {
GenericTimerInfo->NonSecurePL1TimerGSIV = 0;
GenericTimerInfo->NonSecurePL1TimerFlags = 0;
} else {
GenericTimerInfo->NonSecurePL1TimerGSIV = FdtGetInterruptId (DecodedInterruptData, DecodedInterruptCells);
GenericTimerInfo->NonSecurePL1TimerFlags = FdtGetInterruptFlags (DecodedInterruptData, DecodedInterruptCells) | AlwaysOnTimerFlag;
}
Status = FdtResolveInterrupt (
Fdt,
TimerNode,
FdtVirtualTimerIrq,
&DecodedInterruptData,
&DecodedInterruptCells
);
if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) {
ASSERT (FALSE);
return Status;
} else if (Status == EFI_NOT_FOUND) {
GenericTimerInfo->VirtualTimerGSIV = 0;
GenericTimerInfo->VirtualTimerFlags = 0;
} else {
GenericTimerInfo->VirtualTimerGSIV = FdtGetInterruptId (DecodedInterruptData, DecodedInterruptCells);
GenericTimerInfo->VirtualTimerFlags = FdtGetInterruptFlags (DecodedInterruptData, DecodedInterruptCells) | AlwaysOnTimerFlag;
}
Status = FdtResolveInterrupt (
Fdt,
TimerNode,
FdtHypervisorTimerIrq,
&DecodedInterruptData,
&DecodedInterruptCells
);
if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) {
ASSERT (0);
return Status;
} else if (Status == EFI_NOT_FOUND) {
GenericTimerInfo->NonSecurePL2TimerGSIV = 0;
GenericTimerInfo->NonSecurePL2TimerFlags = 0;
} else {
GenericTimerInfo->NonSecurePL2TimerGSIV = FdtGetInterruptId (DecodedInterruptData, DecodedInterruptCells);
GenericTimerInfo->NonSecurePL2TimerFlags = FdtGetInterruptFlags (DecodedInterruptData, DecodedInterruptCells) | AlwaysOnTimerFlag;
}
Status = FdtResolveInterrupt (
Fdt,
TimerNode,
FdtHypervisorVTimerIrq,
&DecodedInterruptData,
&DecodedInterruptCells
);
if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) {
ASSERT (0);
return Status;
} else if (Status == EFI_NOT_FOUND) {
GenericTimerInfo->VirtualPL2TimerGSIV = 0;
GenericTimerInfo->VirtualPL2TimerFlags = 0;
} else {
GenericTimerInfo->VirtualPL2TimerGSIV = FdtGetInterruptId (DecodedInterruptData, DecodedInterruptCells);
GenericTimerInfo->VirtualPL2TimerFlags = FdtGetInterruptFlags (DecodedInterruptData, DecodedInterruptCells) | AlwaysOnTimerFlag;
}
// Setup default values
// The CntControlBase & CntReadBase Physical Address are optional if
// the system implements EL3 (Security Extensions). So, initialise
// these to their default value.
GenericTimerInfo->CounterControlBaseAddress = 0xFFFFFFFFFFFFFFFF;
GenericTimerInfo->CounterReadBaseAddress = 0xFFFFFFFFFFFFFFFF;
return EFI_SUCCESS;
}
/** CM_ARM_GENERIC_TIMER_INFO parser function.
The following structure is populated:
typedef struct CmArmGenericTimerInfo {
UINT64 CounterControlBaseAddress; // {default}
UINT64 CounterReadBaseAddress; // {default}
UINT32 SecurePL1TimerGSIV; // {Populated}
UINT32 SecurePL1TimerFlags; // {Populated}
UINT32 NonSecurePL1TimerGSIV; // {Populated}
UINT32 NonSecurePL1TimerFlags; // {Populated}
UINT32 VirtualTimerGSIV; // {Populated}
UINT32 VirtualTimerFlags; // {Populated}
UINT32 NonSecurePL2TimerGSIV; // {Populated}
UINT32 NonSecurePL2TimerFlags; // {Populated}
UINT32 VirtualPL2TimerGSIV; // {default}
UINT32 VirtualPL2TimerFlags; // {default}
} CM_ARM_GENERIC_TIMER_INFO;
A parser parses a Device Tree to populate a specific CmObj type. None,
one or many CmObj can be created by the parser.
The created CmObj are then handed to the parser's caller through the
HW_INFO_ADD_OBJECT interface.
This can also be a dispatcher. I.e. a function that not parsing a
Device Tree but calling other parsers.
@param [in] FdtParserHandle A handle to the parser instance.
@param [in] FdtBranch When searching for DT node name, restrict
the search to this Device Tree branch.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND Not found.
@retval EFI_UNSUPPORTED Unsupported.
**/
EFI_STATUS
EFIAPI
ArmGenericTimerInfoParser (
IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle,
IN INT32 FdtBranch
)
{
EFI_STATUS Status;
UINT32 Index;
INT32 TimerNode;
UINT32 TimerNodeCount;
CM_ARM_GENERIC_TIMER_INFO GenericTimerInfo;
VOID *Fdt;
if (FdtParserHandle == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Fdt = FdtParserHandle->Fdt;
Status = FdtCountCompatNodeInBranch (
Fdt,
FdtBranch,
&TimerCompatibleInfo,
&TimerNodeCount
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
if (TimerNodeCount == 0) {
return EFI_NOT_FOUND;
}
// Parse each timer node in the branch.
TimerNode = FdtBranch;
for (Index = 0; Index < TimerNodeCount; Index++) {
ZeroMem (&GenericTimerInfo, sizeof (CM_ARM_GENERIC_TIMER_INFO));
Status = FdtGetNextCompatNodeInBranch (
Fdt,
FdtBranch,
&TimerCompatibleInfo,
&TimerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
if (Status == EFI_NOT_FOUND) {
// Should have found the node.
Status = EFI_ABORTED;
}
return Status;
}
Status = TimerNodeParser (Fdt, TimerNode, &GenericTimerInfo);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// Add the CmObj to the Configuration Manager.
Status = AddSingleCmObj (
FdtParserHandle,
CREATE_CM_ARM_OBJECT_ID (EArmObjGenericTimerInfo),
&GenericTimerInfo,
sizeof (CM_ARM_GENERIC_TIMER_INFO),
NULL
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
} // for
return Status;
}
|
