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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
|
/** @file
Flattened device tree utility.
Copyright (c) 2021, ARM Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Reference(s):
- Device tree Specification - Release v0.3
- linux/Documentation/devicetree/bindings/interrupt-controller/arm%2Cgic.yaml
- linux//Documentation/devicetree/bindings/interrupt-controller/arm%2Cgic.yaml
**/
#include <FdtHwInfoParserInclude.h>
#include "FdtUtility.h"
/** Get the interrupt Id of an interrupt described in a fdt.
Data must describe a GIC interrupt. A GIC interrupt is on at least
3 UINT32 cells.
This function DOES NOT SUPPORT extended SPI range and extended PPI range.
@param [in] Data Pointer to the first cell of an "interrupts" property.
@retval The interrupt id.
**/
UINT32
EFIAPI
FdtGetInterruptId (
UINT32 CONST *Data
)
{
UINT32 IrqType;
UINT32 IrqId;
ASSERT (Data != NULL);
IrqType = fdt32_to_cpu (Data[IRQ_TYPE_OFFSET]);
IrqId = fdt32_to_cpu (Data[IRQ_NUMBER_OFFSET]);
switch (IrqType) {
case DT_SPI_IRQ:
IrqId += SPI_OFFSET;
break;
case DT_PPI_IRQ:
IrqId += PPI_OFFSET;
break;
default:
ASSERT (0);
IrqId = 0;
}
return IrqId;
}
/** Get the ACPI interrupt flags of an interrupt described in a fdt.
Data must describe a GIC interrupt. A GIC interrupt is on at least
3 UINT32 cells.
PPI interrupt cpu mask on bits [15:8] are ignored.
@param [in] Data Pointer to the first cell of an "interrupts" property.
@retval The interrupt flags (for ACPI).
**/
UINT32
EFIAPI
FdtGetInterruptFlags (
UINT32 CONST *Data
)
{
UINT32 IrqFlags;
UINT32 AcpiIrqFlags;
ASSERT (Data != NULL);
IrqFlags = fdt32_to_cpu (Data[IRQ_FLAGS_OFFSET]);
AcpiIrqFlags = DT_IRQ_IS_EDGE_TRIGGERED (IrqFlags) ? BIT0 : 0;
AcpiIrqFlags |= DT_IRQ_IS_ACTIVE_LOW (IrqFlags) ? BIT1 : 0;
return AcpiIrqFlags;
}
/** Check whether a node has the input name.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] Node Offset of the node to check the name.
@param [in] SearchName Node name to search.
This is a NULL terminated string.
@retval True The node has the input name.
@retval FALSE Otherwise, or error.
**/
STATIC
BOOLEAN
EFIAPI
FdtNodeHasName (
IN CONST VOID *Fdt,
IN INT32 Node,
IN CONST VOID *SearchName
)
{
CONST CHAR8 *NodeName;
UINT32 Length;
if ((Fdt == NULL) ||
(SearchName == NULL))
{
ASSERT (0);
return FALSE;
}
// Always compare the whole string. Don't stop at the "@" char.
Length = (UINT32)AsciiStrLen (SearchName);
// Get the address of the node name.
NodeName = fdt_offset_ptr (Fdt, Node + FDT_TAGSIZE, Length + 1);
if (NodeName == NULL) {
return FALSE;
}
// SearchName must be longer than the node name.
if (Length > AsciiStrLen (NodeName)) {
return FALSE;
}
if (AsciiStrnCmp (NodeName, SearchName, Length) != 0) {
return FALSE;
}
// The name matches perfectly, or
// the node name is XXX@addr and the XXX matches.
if ((NodeName[Length] == '\0') ||
(NodeName[Length] == '@'))
{
return TRUE;
}
return FALSE;
}
/** Iterate through the list of strings in the Context,
and check whether at least one string is matching the
"compatible" property of the node.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] Node Offset of the node to operate the check on.
@param [in] CompatInfo COMPATIBILITY_INFO containing the list of compatible
strings to compare with the "compatible" property
of the node.
@retval TRUE At least one string matched, the node is compatible.
@retval FALSE Otherwise, or error.
**/
BOOLEAN
EFIAPI
FdtNodeIsCompatible (
IN CONST VOID *Fdt,
IN INT32 Node,
IN CONST VOID *CompatInfo
)
{
UINT32 Index;
CONST COMPATIBILITY_STR *CompatibleTable;
UINT32 Count;
CONST VOID *Prop;
INT32 PropLen;
if ((Fdt == NULL) ||
(CompatInfo == NULL))
{
ASSERT (0);
return FALSE;
}
Count = ((COMPATIBILITY_INFO *)CompatInfo)->Count;
CompatibleTable = ((COMPATIBILITY_INFO *)CompatInfo)->CompatTable;
// Get the "compatible" property.
Prop = fdt_getprop (Fdt, Node, "compatible", &PropLen);
if ((Prop == NULL) || (PropLen < 0)) {
return FALSE;
}
for (Index = 0; Index < Count; Index++) {
if (fdt_stringlist_contains (
Prop,
PropLen,
CompatibleTable[Index].CompatStr
))
{
return TRUE;
}
} // for
return FALSE;
}
/** Check whether a node has a property.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] Node Offset of the node to operate the check on.
@param [in] PropertyName Name of the property to search.
This is a NULL terminated string.
@retval True The node has the property.
@retval FALSE Otherwise, or error.
**/
BOOLEAN
EFIAPI
FdtNodeHasProperty (
IN CONST VOID *Fdt,
IN INT32 Node,
IN CONST VOID *PropertyName
)
{
INT32 Size;
CONST VOID *Prop;
if ((Fdt == NULL) ||
(PropertyName == NULL))
{
ASSERT (0);
return FALSE;
}
Prop = fdt_getprop (Fdt, Node, PropertyName, &Size);
if ((Prop == NULL) || (Size < 0)) {
return FALSE;
}
return TRUE;
}
/** Get the next node in the whole DT fulfilling a condition.
The condition to fulfill is checked by the NodeChecker function.
Context is passed to NodeChecker.
The Device tree is traversed in a depth-first search, starting from Node.
The input Node is skipped.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in, out] Node At entry: Node offset to start the search.
This first node is skipped.
Write (-1) to search the whole tree.
At exit: If success, contains the offset of
the next node fulfilling the
condition.
@param [in, out] Depth Depth is incremented/decremented of the depth
difference between the input Node and the
output Node.
E.g.: If the output Node is a child node
of the input Node, contains (+1).
@param [in] NodeChecker Function called to check if the condition
is fulfilled.
@param [in] Context Context for the NodeChecker.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND No matching node found.
**/
STATIC
EFI_STATUS
EFIAPI
FdtGetNextCondNode (
IN CONST VOID *Fdt,
IN OUT INT32 *Node,
IN OUT INT32 *Depth,
IN NODE_CHECKER_FUNC NodeChecker,
IN CONST VOID *Context
)
{
INT32 CurrNode;
if ((Fdt == NULL) ||
(Node == NULL) ||
(Depth == NULL) ||
(NodeChecker == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
CurrNode = *Node;
do {
CurrNode = fdt_next_node (Fdt, CurrNode, Depth);
if ((CurrNode == -FDT_ERR_NOTFOUND) ||
(*Depth < 0))
{
// End of the tree, no matching node found.
return EFI_NOT_FOUND;
} else if (CurrNode < 0) {
// An error occurred.
ASSERT (0);
return EFI_ABORTED;
}
} while (!NodeChecker (Fdt, CurrNode, Context));
// Matching node found.
*Node = CurrNode;
return EFI_SUCCESS;
}
/** Get the next node in a branch fulfilling a condition.
The condition to fulfill is checked by the NodeChecker function.
Context is passed to NodeChecker.
The Device tree is traversed in a depth-first search, starting from Node.
The input Node is skipped.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this
branch.
Write (-1) to search the whole tree.
@param [in] NodeChecker Function called to check if the condition
is fulfilled.
@param [in] Context Context for the NodeChecker.
@param [in, out] Node At entry: Node offset to start the search.
This first node is skipped.
Write (-1) to search the whole tree.
At exit: If success, contains the offset
of the next node in the branch
fulfilling the condition.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND No matching node found.
**/
STATIC
EFI_STATUS
EFIAPI
FdtGetNextCondNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN NODE_CHECKER_FUNC NodeChecker,
IN CONST VOID *Context,
IN OUT INT32 *Node
)
{
EFI_STATUS Status;
INT32 CurrNode;
INT32 Depth;
if ((Fdt == NULL) ||
(Node == NULL) ||
(NodeChecker == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
CurrNode = FdtBranch;
Depth = 0;
// First, check the Node is in the sub-nodes of the branch.
// This allows to find the relative depth of Node in the branch.
if (CurrNode != *Node) {
for (CurrNode = fdt_next_node (Fdt, CurrNode, &Depth);
(CurrNode >= 0) && (Depth > 0);
CurrNode = fdt_next_node (Fdt, CurrNode, &Depth))
{
if (CurrNode == *Node) {
// Node found.
break;
}
} // for
if ((CurrNode < 0) || (Depth <= 0)) {
// Node is not a node in the branch, or an error occurred.
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
}
// Get the next node in the tree fulfilling the condition,
// in any branch.
Status = FdtGetNextCondNode (
Fdt,
Node,
&Depth,
NodeChecker,
Context
);
if (EFI_ERROR (Status)) {
ASSERT (Status == EFI_NOT_FOUND);
return Status;
}
if (Depth <= 0) {
// The node found is not in the right branch.
return EFI_NOT_FOUND;
}
return EFI_SUCCESS;
}
/** Get the next node in a branch having a matching name.
The Device tree is traversed in a depth-first search, starting from Node.
The input Node is skipped.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this branch.
Write (-1) to search the whole tree.
@param [in] NodeName The node name to search.
This is a NULL terminated string.
@param [in, out] Node At entry: Node offset to start the search.
This first node is skipped.
Write (-1) to search the whole tree.
At exit: If success, contains the offset of
the next node in the branch
having a matching name.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND No matching node found.
**/
EFI_STATUS
EFIAPI
FdtGetNextNamedNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN CONST CHAR8 *NodeName,
IN OUT INT32 *Node
)
{
return FdtGetNextCondNodeInBranch (
Fdt,
FdtBranch,
FdtNodeHasName,
NodeName,
Node
);
}
/** Get the next node in a branch with at least one compatible property.
The Device tree is traversed in a depth-first search, starting from Node.
The input Node is skipped.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this branch.
Write (-1) to search the whole tree.
@param [in] CompatNamesInfo Table of compatible strings to compare with
the compatible property of the node.
@param [in, out] Node At entry: Node offset to start the search.
This first node is skipped.
Write (-1) to search the whole tree.
At exit: If success, contains the offset of
the next node in the branch
being compatible.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND No matching node found.
**/
EFI_STATUS
EFIAPI
FdtGetNextCompatNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN CONST COMPATIBILITY_INFO *CompatNamesInfo,
IN OUT INT32 *Node
)
{
return FdtGetNextCondNodeInBranch (
Fdt,
FdtBranch,
FdtNodeIsCompatible,
(CONST VOID *)CompatNamesInfo,
Node
);
}
/** Get the next node in a branch having the PropName property.
The Device tree is traversed in a depth-first search, starting from Node.
The input Node is skipped.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this branch.
Write (-1) to search the whole tree.
@param [in] PropName Name of the property to search.
This is a NULL terminated string.
@param [in, out] Node At entry: Node offset to start the search.
This first node is skipped.
Write (-1) to search the whole tree.
At exit: If success, contains the offset of
the next node in the branch
being compatible.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND No matching node found.
**/
EFI_STATUS
EFIAPI
FdtGetNextPropNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN CONST CHAR8 *PropName,
IN OUT INT32 *Node
)
{
return FdtGetNextCondNodeInBranch (
Fdt,
FdtBranch,
FdtNodeHasProperty,
(CONST VOID *)PropName,
Node
);
}
/** Count the number of Device Tree nodes fulfilling a condition
in a Device Tree branch.
The condition to fulfill is checked by the NodeChecker function.
Context is passed to NodeChecker.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this branch.
Write (-1) to search the whole tree.
@param [in] NodeChecker Function called to check the condition is
fulfilled.
@param [in] Context Context for the NodeChecker.
@param [out] NodeCount If success, contains the count of nodes
fulfilling the condition.
Can be 0.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
FdtCountCondNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN NODE_CHECKER_FUNC NodeChecker,
IN CONST VOID *Context,
OUT UINT32 *NodeCount
)
{
EFI_STATUS Status;
INT32 CurrNode;
if ((Fdt == NULL) ||
(NodeChecker == NULL) ||
(NodeCount == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
*NodeCount = 0;
CurrNode = FdtBranch;
while (TRUE) {
Status = FdtGetNextCondNodeInBranch (
Fdt,
FdtBranch,
NodeChecker,
Context,
&CurrNode
);
if (EFI_ERROR (Status) &&
(Status != EFI_NOT_FOUND))
{
ASSERT (0);
return Status;
} else if (Status == EFI_NOT_FOUND) {
break;
}
(*NodeCount)++;
}
return EFI_SUCCESS;
}
/** Count the number of nodes in a branch with the input name.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this branch.
Write (-1) to search the whole tree.
@param [in] NodeName Node name to search.
This is a NULL terminated string.
@param [out] NodeCount If success, contains the count of nodes
fulfilling the condition.
Can be 0.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
FdtCountNamedNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN CONST CHAR8 *NodeName,
OUT UINT32 *NodeCount
)
{
return FdtCountCondNodeInBranch (
Fdt,
FdtBranch,
FdtNodeHasName,
NodeName,
NodeCount
);
}
/** Count the number of nodes in a branch with at least
one compatible property.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this branch.
Write (-1) to search the whole tree.
@param [in] CompatNamesInfo Table of compatible strings to
compare with the compatible property
of the node.
@param [out] NodeCount If success, contains the count of nodes
fulfilling the condition.
Can be 0.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
FdtCountCompatNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN CONST COMPATIBILITY_INFO *CompatNamesInfo,
OUT UINT32 *NodeCount
)
{
return FdtCountCondNodeInBranch (
Fdt,
FdtBranch,
FdtNodeIsCompatible,
CompatNamesInfo,
NodeCount
);
}
/** Count the number of nodes in a branch having the PropName property.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] FdtBranch Only search in the sub-nodes of this branch.
Write (-1) to search the whole tree.
@param [in] PropName Name of the property to search.
This is a NULL terminated string.
@param [out] NodeCount If success, contains the count of nodes
fulfilling the condition.
Can be 0.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
FdtCountPropNodeInBranch (
IN CONST VOID *Fdt,
IN INT32 FdtBranch,
IN CONST CHAR8 *PropName,
OUT UINT32 *NodeCount
)
{
return FdtCountCondNodeInBranch (
Fdt,
FdtBranch,
FdtNodeHasProperty,
PropName,
NodeCount
);
}
/** Get the interrupt-controller node handling the interrupts of
the input node.
To do this, recursively search a node with either the "interrupt-controller"
or the "interrupt-parent" property in the parents of Node.
Devicetree Specification, Release v0.3,
2.4.1 "Properties for Interrupt Generating Devices":
Because the hierarchy of the nodes in the interrupt tree
might not match the devicetree, the interrupt-parent
property is available to make the definition of an
interrupt parent explicit. The value is the phandle to the
interrupt parent. If this property is missing from a
device, its interrupt parent is assumed to be its devicetree
parent.
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] Node Offset of the node to start the search.
@param [out] IntcNode If success, contains the offset of the
interrupt-controller node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_FOUND No interrupt-controller node found.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
FdtGetIntcParentNode (
IN CONST VOID *Fdt,
IN INT32 Node,
OUT INT32 *IntcNode
)
{
CONST UINT32 *PHandle;
INT32 Size;
CONST VOID *Prop;
if ((Fdt == NULL) ||
(IntcNode == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
while (TRUE) {
// Check whether the node has the "interrupt-controller" property.
Prop = fdt_getprop (Fdt, Node, "interrupt-controller", &Size);
if ((Prop != NULL) && (Size >= 0)) {
// The interrupt-controller has been found.
*IntcNode = Node;
return EFI_SUCCESS;
} else {
// Check whether the node has the "interrupt-parent" property.
PHandle = fdt_getprop (Fdt, Node, "interrupt-parent", &Size);
if ((PHandle != NULL) && (Size == sizeof (UINT32))) {
// The phandle of the interrupt-controller has been found.
// Search the node having this phandle and return it.
Node = fdt_node_offset_by_phandle (Fdt, fdt32_to_cpu (*PHandle));
if (Node < 0) {
ASSERT (0);
return EFI_ABORTED;
}
*IntcNode = Node;
return EFI_SUCCESS;
} else if (Size != -FDT_ERR_NOTFOUND) {
ASSERT (0);
return EFI_ABORTED;
}
}
if (Node == 0) {
// We are at the root of the tree. Not parent available.
return EFI_NOT_FOUND;
}
// Get the parent of the node.
Node = fdt_parent_offset (Fdt, Node);
if (Node < 0) {
// An error occurred.
ASSERT (0);
return EFI_ABORTED;
}
} // while
}
/** Get the "interrupt-cells" property value of the node.
The "interrupts" property requires to know the number of cells used
to encode an interrupt. This information is stored in the
interrupt-controller of the input Node.
@param [in] Fdt Pointer to a Flattened Device Tree (Fdt).
@param [in] IntcNode Offset of an interrupt-controller node.
@param [out] IntCells If success, contains the "interrupt-cells"
property of the IntcNode.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_UNSUPPORTED Unsupported.
**/
EFI_STATUS
EFIAPI
FdtGetInterruptCellsInfo (
IN CONST VOID *Fdt,
IN INT32 IntcNode,
OUT INT32 *IntCells
)
{
CONST UINT32 *Data;
INT32 Size;
if ((Fdt == NULL) ||
(IntCells == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Data = fdt_getprop (Fdt, IntcNode, "#interrupt-cells", &Size);
if ((Data == NULL) || (Size != sizeof (UINT32))) {
// If error or not on one UINT32 cell.
ASSERT (0);
return EFI_ABORTED;
}
*IntCells = fdt32_to_cpu (*Data);
return EFI_SUCCESS;
}
/** Get the "#address-cells" and/or "#size-cells" property of the node.
According to the Device Tree specification, s2.3.5 "#address-cells and
#size-cells":
"If missing, a client program should assume a default value of 2 for
#address-cells, and a value of 1 for #size-cells."
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] Node Offset of the node having to get the
"#address-cells" and "#size-cells"
properties from.
@param [out] AddressCells If success, number of address-cells.
If the property is not available,
default value is 2.
@param [out] SizeCells If success, number of size-cells.
If the property is not available,
default value is 1.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
FdtGetAddressInfo (
IN CONST VOID *Fdt,
IN INT32 Node,
OUT INT32 *AddressCells, OPTIONAL
OUT INT32 *SizeCells OPTIONAL
)
{
if (Fdt == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
if (AddressCells != NULL) {
*AddressCells = fdt_address_cells (Fdt, Node);
if (*AddressCells < 0) {
ASSERT (0);
return EFI_ABORTED;
}
}
if (SizeCells != NULL) {
*SizeCells = fdt_size_cells (Fdt, Node);
if (*SizeCells < 0) {
ASSERT (0);
return EFI_ABORTED;
}
}
return EFI_SUCCESS;
}
/** Get the "#address-cells" and/or "#size-cells" property of the parent node.
According to the Device Tree specification, s2.3.5 "#address-cells and
#size-cells":
"If missing, a client program should assume a default value of 2 for
#address-cells, and a value of 1 for #size-cells."
@param [in] Fdt Pointer to a Flattened Device Tree.
@param [in] Node Offset of the node having to get the
"#address-cells" and "#size-cells"
properties from its parent.
@param [out] AddressCells If success, number of address-cells.
If the property is not available,
default value is 2.
@param [out] SizeCells If success, number of size-cells.
If the property is not available,
default value is 1.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
FdtGetParentAddressInfo (
IN CONST VOID *Fdt,
IN INT32 Node,
OUT INT32 *AddressCells, OPTIONAL
OUT INT32 *SizeCells OPTIONAL
)
{
if (Fdt == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Node = fdt_parent_offset (Fdt, Node);
if (Node < 0) {
// End of the tree, or an error occurred.
ASSERT (0);
return EFI_ABORTED;
}
return FdtGetAddressInfo (Fdt, Node, AddressCells, SizeCells);
}
|