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
|
/** @file
Configuration Manager object token fixer
Copyright (c) 2021 - 2026, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Glossary:
- Cm or CM - Configuration Manager
- Obj or OBJ - Object
**/
#include <Library/DebugLib.h>
#include <Protocol/ConfigurationManagerProtocol.h>
#include "CmObjectTokenFixer.h"
/** Token fixer not implemented.
Most of the objects are not generated by this parser. Add the missing
functions when needed.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerNotImplemented (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (0);
return EFI_UNSUPPORTED;
}
/** EArmObjItsGroup token fixer.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerItsGroup (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (CmObject != NULL);
((CM_ARM_ITS_GROUP_NODE *)CmObject->Data)->Token = Token;
return EFI_SUCCESS;
}
/** EArmObjNamedComponent token fixer.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerNamedComponentNode (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (CmObject != NULL);
((CM_ARM_NAMED_COMPONENT_NODE *)CmObject->Data)->Token = Token;
return EFI_SUCCESS;
}
/** EArmObjRootComplex token fixer.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerRootComplexNode (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (CmObject != NULL);
((CM_ARM_ROOT_COMPLEX_NODE *)CmObject->Data)->Token = Token;
return EFI_SUCCESS;
}
/** EArmObjSmmuV3 token fixer.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerSmmuV3Node (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (CmObject != NULL);
((CM_ARM_SMMUV3_NODE *)CmObject->Data)->Token = Token;
return EFI_SUCCESS;
}
/** ERiscVObjIsaString token fixer.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerIsaStringNode (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (CmObject != NULL);
((CM_RISCV_ISA_STRING_NODE *)CmObject->Data)->Token = Token;
return EFI_SUCCESS;
}
/** ERiscVObjCmoNode token fixer.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerCmoNode (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (CmObject != NULL);
((CM_RISCV_CMO_NODE *)CmObject->Data)->Token = Token;
return EFI_SUCCESS;
}
/** ERiscVObjMmuNode token fixer.
CmObjectToken fixer function that updates the Tokens in the CmObjects.
@param [in] CmObject Pointer to the Configuration Manager Object.
@param [in] Token Token to be updated in the CmObject.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
STATIC
EFI_STATUS
EFIAPI
TokenFixerMmuNode (
IN CM_OBJ_DESCRIPTOR *CmObject,
IN CM_OBJECT_TOKEN Token
)
{
ASSERT (CmObject != NULL);
((CM_RISCV_MMU_NODE *)CmObject->Data)->Token = Token;
return EFI_SUCCESS;
}
/** TokenFixer functions table.
A CmObj having a CM_OBJECT_TOKEN field might need to have its
Token fixed. Each CmObj can have its Token in a specific way.
*/
CONST
CM_OBJECT_TOKEN_FIXER ArmTokenFixer[EArmObjMax] = {
NULL, ///< 0 - Reserved
NULL, ///< 1 - Boot Architecture Info
NULL, ///< 2 - GIC CPU Interface Info
NULL, ///< 3 - GIC Distributor Info
NULL, ///< 4 - GIC MSI Frame Info
NULL, ///< 5 - GIC Redistributor Info
NULL, ///< 6 - GIC ITS Info
NULL, ///< 7 - Generic Timer Info
NULL, ///< 8 - Platform GT Block Info
NULL, ///< 9 - Generic Timer Block Frame Info
NULL, ///< 10 - Platform Generic Watchdog
TokenFixerItsGroup, ///< 11 - ITS Group
TokenFixerNamedComponentNode, ///< 12 - Named Component
TokenFixerRootComplexNode, ///< 13 - Root Complex
TokenFixerNotImplemented, ///< 14 - SMMUv1 or SMMUv2
TokenFixerSmmuV3Node, ///< 15 - SMMUv3
TokenFixerNotImplemented, ///< 16 - PMCG
NULL, ///< 17 - GIC ITS Identifier Array
NULL, ///< 18 - ID Mapping Array
NULL, ///< 19 - SMMU Interrupt Array
NULL, ///< 20 - CMN Info
NULL, ///< 21 - Reserved Memory Range Node
NULL, ///< 22 - Memory Range Descriptor
NULL ///< 23 - Embedded Trace Extension/Module Info
};
/** TokenFixer functions table for RISC-V.
A CmObj having a CM_OBJECT_TOKEN field might need to have its
Token fixed. Each CmObj can have its Token in a specific way.
*/
CONST
CM_OBJECT_TOKEN_FIXER RiscVTokenFixer[ERiscVObjMax] = {
NULL, ///< 0 - Reserved
NULL, ///< 1 - RINTC Info
NULL, ///< 2 - IMSIC Info
NULL, ///< 3 - APLIC Info
NULL, ///< 4 - PLIC Info
TokenFixerIsaStringNode, ///< 5 - ISA String Info
TokenFixerCmoNode, ///< 6 - CMO Info
TokenFixerMmuNode, ///< 7 - MMU Info
NULL, ///< 8 - Timer Type Info
};
/** CmObj token fixer.
Some CmObj structures have a self-token, i.e. they are storing their own
token value in the CmObj. Dynamically created CmObj need to have their
self-token assigned at some point.
@param [in] CmObjDesc Pointer to the Configuration Manager Object.
@param [in] Token Token to update the CmObjDesc with.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_UNSUPPORTED Not supported.
**/
EFI_STATUS
EFIAPI
FixupCmObjectSelfToken (
IN CM_OBJ_DESCRIPTOR *CmObjDesc,
IN CM_OBJECT_TOKEN Token
)
{
EFI_STATUS Status;
CM_OBJECT_TOKEN_FIXER TokenFixerFunc;
CM_OBJECT_ID ArmNamespaceObjId;
CM_OBJECT_ID RiscVNamespaceObjId;
if (CmObjDesc == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Only support Arm and RISC-V objects for now.
if (GET_CM_NAMESPACE_ID (CmObjDesc->ObjectId) == EObjNameSpaceArm) {
ArmNamespaceObjId = GET_CM_OBJECT_ID (CmObjDesc->ObjectId);
if (ArmNamespaceObjId >= EArmObjMax) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Fixup self-token if necessary.
TokenFixerFunc = ArmTokenFixer[ArmNamespaceObjId];
} else if (GET_CM_NAMESPACE_ID (CmObjDesc->ObjectId) == EObjNameSpaceRiscV) {
RiscVNamespaceObjId = GET_CM_OBJECT_ID (CmObjDesc->ObjectId);
if (RiscVNamespaceObjId >= ERiscVObjMax) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Fixup self-token if necessary.
TokenFixerFunc = RiscVTokenFixer[RiscVNamespaceObjId];
} else {
ASSERT (
(GET_CM_NAMESPACE_ID (CmObjDesc->ObjectId) == EObjNameSpaceArm) ||
(GET_CM_NAMESPACE_ID (CmObjDesc->ObjectId) == EObjNameSpaceRiscV)
);
return EFI_UNSUPPORTED;
}
if (TokenFixerFunc != NULL) {
Status = TokenFixerFunc (CmObjDesc, Token);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
}
return EFI_SUCCESS;
}
|
