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
|
/** @file
AML Tree Iterator.
Copyright (c) 2019 - 2020, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <AmlNodeDefines.h>
#include <Tree/AmlTreeIterator.h>
#include <AmlCoreInterface.h>
#include <Tree/AmlTreeTraversal.h>
/** Iterator to traverse the tree.
This is an internal structure.
*/
typedef struct AmlTreeInternalIterator {
/// External iterator structure, containing the external APIs.
/// Must be the first field.
AML_TREE_ITERATOR Iterator;
// Note: The following members of this structure are opaque to the users
// of the Tree iterator APIs.
/// Pointer to the node on which the iterator has been initialized.
CONST AML_NODE_HEADER *InitialNode;
/// Pointer to the current node.
CONST AML_NODE_HEADER *CurrentNode;
/// Iteration mode.
/// Allow to choose how to traverse the tree/choose which node is next.
EAML_ITERATOR_MODE Mode;
} AML_TREE_ITERATOR_INTERNAL;
/** Get the current node of an iterator.
@param [in] Iterator Pointer to an iterator.
@param [out] OutNode Pointer holding the current node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
AmlIteratorGetNode (
IN AML_TREE_ITERATOR *Iterator,
OUT AML_NODE_HEADER **OutNode
)
{
AML_TREE_ITERATOR_INTERNAL *InternalIterator;
InternalIterator = (AML_TREE_ITERATOR_INTERNAL *)Iterator;
// CurrentNode can be NULL, but InitialNode cannot.
if ((OutNode == NULL) ||
(InternalIterator == NULL) ||
(InternalIterator->Mode <= EAmlIteratorUnknown) ||
(InternalIterator->Mode >= EAmlIteratorModeMax) ||
!IS_AML_NODE_VALID (InternalIterator->InitialNode) ||
((InternalIterator->CurrentNode != NULL) &&
!IS_AML_NODE_VALID (InternalIterator->CurrentNode)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
*OutNode = (AML_NODE_HEADER *)InternalIterator->CurrentNode;
return EFI_SUCCESS;
}
/** Move the current node of the iterator to the next node,
according to the iteration mode selected.
If NextNode is not NULL, return the next node.
@param [in] Iterator Pointer to an iterator.
@param [out] NextNode If not NULL, updated to the next node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
AmlIteratorGetNextLinear (
IN AML_TREE_ITERATOR *Iterator,
OUT AML_NODE_HEADER **NextNode
)
{
AML_TREE_ITERATOR_INTERNAL *InternalIterator;
InternalIterator = (AML_TREE_ITERATOR_INTERNAL *)Iterator;
// CurrentNode can be NULL, but InitialNode cannot.
if ((InternalIterator == NULL) ||
(InternalIterator->Mode != EAmlIteratorLinear) ||
!IS_AML_NODE_VALID (InternalIterator->InitialNode) ||
!IS_AML_NODE_VALID (InternalIterator->CurrentNode))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Get the next node according to the iteration mode.
InternalIterator->CurrentNode = AmlGetNextNode (
InternalIterator->CurrentNode
);
if (NextNode != NULL) {
*NextNode = (AML_NODE_HEADER *)InternalIterator->CurrentNode;
}
return EFI_SUCCESS;
}
/** Move the current node of the iterator to the previous node,
according to the iteration mode selected.
If PrevNode is not NULL, return the previous node.
@param [in] Iterator Pointer to an iterator.
@param [out] PrevNode If not NULL, updated to the previous node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
AmlIteratorGetPreviousLinear (
IN AML_TREE_ITERATOR *Iterator,
OUT AML_NODE_HEADER **PrevNode
)
{
AML_TREE_ITERATOR_INTERNAL *InternalIterator;
InternalIterator = (AML_TREE_ITERATOR_INTERNAL *)Iterator;
// CurrentNode can be NULL, but InitialNode cannot.
if ((InternalIterator == NULL) ||
(InternalIterator->Mode != EAmlIteratorLinear) ||
!IS_AML_NODE_VALID (InternalIterator->InitialNode) ||
!IS_AML_NODE_VALID (InternalIterator->CurrentNode))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Get the previous node according to the iteration mode.
InternalIterator->CurrentNode = AmlGetPreviousNode (
InternalIterator->CurrentNode
);
if (PrevNode != NULL) {
*PrevNode = (AML_NODE_HEADER *)InternalIterator->CurrentNode;
}
return EFI_SUCCESS;
}
/** Move the current node of the iterator to the next node,
according to the iteration mode selected.
If NextNode is not NULL, return the next node.
@param [in] Iterator Pointer to an iterator.
@param [out] NextNode If not NULL, updated to the next node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
AmlIteratorGetNextBranch (
IN AML_TREE_ITERATOR *Iterator,
OUT AML_NODE_HEADER **NextNode
)
{
AML_TREE_ITERATOR_INTERNAL *InternalIterator;
AML_NODE_HEADER *Node;
InternalIterator = (AML_TREE_ITERATOR_INTERNAL *)Iterator;
// CurrentNode can be NULL, but InitialNode cannot.
if ((InternalIterator == NULL) ||
(InternalIterator->Mode != EAmlIteratorBranch) ||
!IS_AML_NODE_VALID (InternalIterator->InitialNode) ||
!IS_AML_NODE_VALID (InternalIterator->CurrentNode))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Node = AmlGetNextNode (InternalIterator->CurrentNode);
// Check whether NextNode is a sibling of InitialNode.
if (AmlGetParent (Node) ==
AmlGetParent ((AML_NODE_HEADER *)InternalIterator->InitialNode))
{
Node = NULL;
}
InternalIterator->CurrentNode = Node;
if (NextNode != NULL) {
*NextNode = Node;
}
return EFI_SUCCESS;
}
/** Move the current node of the iterator to the previous node,
according to the iteration mode selected.
If PrevNode is not NULL, return the previous node.
@param [in] Iterator Pointer to an iterator.
@param [out] PrevNode If not NULL, updated to the previous node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
AmlIteratorGetPreviousBranch (
IN AML_TREE_ITERATOR *Iterator,
OUT AML_NODE_HEADER **PrevNode
)
{
AML_TREE_ITERATOR_INTERNAL *InternalIterator;
AML_NODE_HEADER *Node;
InternalIterator = (AML_TREE_ITERATOR_INTERNAL *)Iterator;
// CurrentNode can be NULL, but InitialNode cannot.
if ((InternalIterator == NULL) ||
(InternalIterator->Mode != EAmlIteratorBranch) ||
!IS_AML_NODE_VALID (InternalIterator->InitialNode) ||
!IS_AML_NODE_VALID (InternalIterator->CurrentNode))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Node = AmlGetPreviousNode (InternalIterator->CurrentNode);
// Check whether PreviousNode is a sibling of InitialNode.
if (AmlGetParent (Node) ==
AmlGetParent ((AML_NODE_HEADER *)InternalIterator->InitialNode))
{
Node = NULL;
}
InternalIterator->CurrentNode = Node;
if (PrevNode != NULL) {
*PrevNode = Node;
}
return EFI_SUCCESS;
}
/** Initialize an iterator.
Note: The caller must call AmlDeleteIterator () to free the memory
allocated for the iterator.
@param [in] Node Pointer to the node.
@param [in] IteratorMode Selected mode to traverse the tree.
@param [out] IteratorPtr Pointer holding the created iterator.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Could not allocate memory.
**/
EFI_STATUS
EFIAPI
AmlInitializeIterator (
IN AML_NODE_HEADER *Node,
IN EAML_ITERATOR_MODE IteratorMode,
OUT AML_TREE_ITERATOR **IteratorPtr
)
{
AML_TREE_ITERATOR_INTERNAL *InternalIterator;
if (!IS_AML_NODE_VALID (Node) ||
(IteratorMode <= EAmlIteratorUnknown) ||
(IteratorMode >= EAmlIteratorModeMax) ||
(IteratorPtr == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
*IteratorPtr = NULL;
InternalIterator = (AML_TREE_ITERATOR_INTERNAL *)AllocateZeroPool (
sizeof (
AML_TREE_ITERATOR_INTERNAL
)
);
if (InternalIterator == NULL) {
ASSERT (0);
return EFI_OUT_OF_RESOURCES;
}
InternalIterator->InitialNode = Node;
InternalIterator->CurrentNode = Node;
InternalIterator->Mode = IteratorMode;
InternalIterator->Iterator.GetNode = AmlIteratorGetNode;
switch (InternalIterator->Mode) {
case EAmlIteratorLinear:
{
InternalIterator->Iterator.GetNext = AmlIteratorGetNextLinear;
InternalIterator->Iterator.GetPrevious = AmlIteratorGetPreviousLinear;
break;
}
case EAmlIteratorBranch:
{
InternalIterator->Iterator.GetNext = AmlIteratorGetNextBranch;
InternalIterator->Iterator.GetPrevious = AmlIteratorGetPreviousBranch;
break;
}
default:
{
ASSERT (0);
FreePool (InternalIterator);
return EFI_INVALID_PARAMETER;
}
} // switch
*IteratorPtr = &InternalIterator->Iterator;
return EFI_SUCCESS;
}
/** Delete an iterator.
Note: The caller must have first initialized the iterator with the
AmlInitializeIterator () function.
@param [in] Iterator Pointer to an iterator.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlDeleteIterator (
IN AML_TREE_ITERATOR *Iterator
)
{
if (Iterator == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
FreePool (Iterator);
return EFI_SUCCESS;
}
|
