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
|
/*
* Copyright (c) 2021-2023, Andrew Kaster <akaster@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <AK/AllOf.h>
#include <AK/CharacterTypes.h>
#include <AK/Endian.h>
#include <AK/Format.h>
#include <AK/Try.h>
#include <LibDeviceTree/Validation.h>
namespace DeviceTree {
bool validate_flattened_device_tree(FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree, Verbose verbose)
{
if (header.magic != 0xD00DFEEDU) {
if (verbose == Verbose::Yes)
warnln("FDT Header has invalid magic value 0x{:08x}. Are you sure it's a flattened device tree?", header.magic);
return false;
}
if ((header.off_mem_rsvmap & ~0x7) != header.off_mem_rsvmap) {
if (verbose == Verbose::Yes)
warnln("FDT Header's MemoryReservationBlock is not 8 byte aligned! Offset: 0x{:08x}", header.off_mem_rsvmap);
return false;
}
if ((header.off_dt_struct & ~0x3) != header.off_dt_struct) {
if (verbose == Verbose::Yes)
warnln("FDT Header's StructureBlock is not 4 byte aligned! Offset: 0x{:08x}", header.off_dt_struct);
return false;
}
if (header.totalsize != raw_device_tree.size()) {
if (verbose == Verbose::Yes)
warnln("FDT Header total size mismatch: {}, expected {}!", header.totalsize, raw_device_tree.size());
return false;
}
if (header.off_dt_struct > raw_device_tree.size()) {
if (verbose == Verbose::Yes)
warnln("FDT Header reports larger StructureBlock offset than possible: {} but total size is {}!", header.off_dt_struct, raw_device_tree.size());
return false;
}
if (header.off_dt_strings > raw_device_tree.size()) {
if (verbose == Verbose::Yes)
warnln("FDT Header reports larger StringsBlock offset than possible: {} but total size is {}!", header.off_dt_strings, raw_device_tree.size());
return false;
}
if (header.off_mem_rsvmap > raw_device_tree.size()) {
if (verbose == Verbose::Yes)
warnln("FDT Header reports larger MemoryReservationBlock offset than possible: {} but total size is {}!", header.off_mem_rsvmap, raw_device_tree.size());
return false;
}
// Verify format is correct. Header --> MemoryReservation --> Structures --> Strings
if (header.off_dt_strings <= header.off_dt_struct) {
if (verbose == Verbose::Yes)
warnln("FDT Header has invalid StringsBlock offset {}, must be after v (@ {})", header.off_dt_strings, header.off_dt_struct);
return false;
}
if (header.off_dt_struct <= header.off_mem_rsvmap) {
if (verbose == Verbose::Yes)
warnln("FDT Header has invalid StructureBlock offset {}, must be after MemoryReservationBlock (@ {})", header.off_dt_struct, header.off_mem_rsvmap);
return false;
}
if (header.version != 17) {
if (verbose == Verbose::Yes)
warnln("Expected FDT header version 17, got {}", header.version);
return false;
}
if (header.last_comp_version != 16) {
if (verbose == Verbose::Yes)
warnln("Expected FDT header last compatible version 16, got {}", header.last_comp_version);
return false;
}
auto* mem_reserve_block = reinterpret_cast<FlattenedDeviceTreeReserveEntry const*>(&raw_device_tree[header.off_mem_rsvmap]);
u64 next_block_offset = header.off_mem_rsvmap + sizeof(FlattenedDeviceTreeReserveEntry);
while ((next_block_offset < header.off_dt_struct) && (*mem_reserve_block != FlattenedDeviceTreeReserveEntry {})) {
++mem_reserve_block;
next_block_offset += sizeof(FlattenedDeviceTreeReserveEntry);
}
if (next_block_offset >= header.off_dt_strings) {
if (verbose == Verbose::Yes)
warnln("FDT malformed, MemoryReservationBlock spill into StructureBlock section!");
return false;
}
// check for overlap. Overflow not possible b/c the fields are u32
u64 structure_block_size = header.off_dt_struct + header.size_dt_struct;
if ((structure_block_size > header.off_dt_strings) || (structure_block_size > raw_device_tree.size())) {
if (verbose == Verbose::Yes)
warnln("FDT Header reports invalid StructureBlock block size: {} is too large given StringsBlock offset {} and total size {}", structure_block_size, header.off_dt_strings, raw_device_tree.size());
return false;
}
u64 strings_block_size = header.off_dt_strings + header.size_dt_strings;
if (strings_block_size > raw_device_tree.size()) {
if (verbose == Verbose::Yes)
warnln("FDT Header reports invalid StringsBlock size: {} is too large given total size {}", strings_block_size, raw_device_tree.size());
return false;
}
return true;
}
ErrorOr<void> dump(FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree)
{
outln("/dts-v1/;");
outln("// magic: 0x{:08x}", header.magic);
outln("// totalsize: 0x{:08x} ({})", header.totalsize, header.totalsize);
outln("// off_dt_struct: 0x{:08x}", header.off_dt_struct);
outln("// off_dt_strings: 0x{:08x}", header.off_dt_strings);
outln("// off_mem_rsvmap: 0x{:08x}", header.off_mem_rsvmap);
outln("// version: 0x{:08x}", header.version);
outln("// last_comp_version: 0x{:08x}", header.last_comp_version);
outln("// boot_cpuid_phys: 0x{:08x}", header.boot_cpuid_phys);
outln("// size_dt_strings: 0x{:08x}", header.size_dt_strings);
outln("// size_dt_struct: 0x{:08x}", header.size_dt_struct);
if (!validate_flattened_device_tree(header, raw_device_tree, Verbose::Yes))
return Error::from_errno(EINVAL);
// Now that we know the device tree is valid, print out the rest of the information
auto const* mem_reserve_block = reinterpret_cast<FlattenedDeviceTreeReserveEntry const*>(&raw_device_tree[header.off_mem_rsvmap]);
u64 next_block_offset = header.off_mem_rsvmap + sizeof(FlattenedDeviceTreeReserveEntry);
while ((next_block_offset < header.off_dt_struct) && (*mem_reserve_block != FlattenedDeviceTreeReserveEntry {})) {
outln("/memreserve/ 0x{:08x} 0x{:08x};", mem_reserve_block->address, mem_reserve_block->size);
++mem_reserve_block;
next_block_offset += sizeof(FlattenedDeviceTreeReserveEntry);
}
return dump_flattened_device_tree_structure(header, raw_device_tree);
}
ErrorOr<void> dump_flattened_device_tree_structure(FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree)
{
u8 indent = 0;
DeviceTreeCallbacks callbacks = {
.on_node_begin = [&](StringView token_name) -> ErrorOr<IterationDecision> {
outln("{: >{}}FDT_BEGIN_NODE: {}", ""sv, indent * 2, token_name);
++indent;
return IterationDecision::Continue;
},
.on_node_end = [&](StringView) -> ErrorOr<IterationDecision> {
--indent;
outln("{: >{}}FDT_END_NODE", ""sv, indent * 2);
return IterationDecision::Continue;
},
.on_property = [&](StringView property_name, ReadonlyBytes property_value) -> ErrorOr<IterationDecision> {
StringView property_as_string { property_value };
// Note: We want to figure out if the value is a string, a stringlist, a number or something unprintable.
// In reality, the entity retrieving the value needs to know if it's a u32, u64, string, stringlist, or "property-encoded-value" a priori
bool const is_print = (property_as_string.length() > 0) && all_of(property_as_string.begin(), --property_as_string.end(), [](char c) { return is_ascii_printable(c); });
if (is_print)
outln("{: >{}}FDT_PROP: {}: {}", ""sv, indent * 2, property_name, property_as_string);
else
outln("{: >{}}FDT_PROP: {}: {:hex-dump}", ""sv, indent * 2, property_name, property_as_string);
return IterationDecision::Continue;
},
.on_noop = [&]() -> ErrorOr<IterationDecision> {
outln("{: >{}}FDT_NOOP", ""sv, indent * 2);
return IterationDecision::Continue;
},
.on_end = []() -> ErrorOr<void> {
outln("FDT_END");
return {};
}
};
return walk_device_tree(header, raw_device_tree, move(callbacks));
}
} // namespace DeviceTree
|
