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
|
/*
* Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <AK/ByteBuffer.h>
#include <AK/Error.h>
#include <AK/IterationDecision.h>
#include <AK/MemoryStream.h>
#include <AK/StringView.h>
#include <LibDeviceTree/FlattenedDeviceTree.h>
namespace DeviceTree {
static ErrorOr<StringView> read_string_view(ReadonlyBytes bytes, StringView error_string)
{
auto len = strnlen(reinterpret_cast<char const*>(bytes.data()), bytes.size());
if (len == bytes.size()) {
return Error::from_string_view_or_print_error_and_return_errno(error_string, EINVAL);
}
return StringView { bytes.slice(0, len) };
}
ErrorOr<void> walk_device_tree(FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree, DeviceTreeCallbacks callbacks)
{
ReadonlyBytes struct_bytes { raw_device_tree.data() + header.off_dt_struct, header.size_dt_struct };
FixedMemoryStream stream(struct_bytes);
char const* begin_strings_block = reinterpret_cast<char const*>(raw_device_tree.data() + header.off_dt_strings);
FlattenedDeviceTreeTokenType prev_token = EndNode;
StringView current_node_name;
while (!stream.is_eof()) {
auto current_token = TRY(stream.read_value<BigEndian<u32>>());
switch (current_token) {
case BeginNode: {
current_node_name = TRY(read_string_view(struct_bytes.slice(stream.offset()), "Non-null terminated name for FDT_BEGIN_NODE token!"sv));
size_t const consume_len = round_up_to_power_of_two(current_node_name.length() + 1, 4);
TRY(stream.discard(consume_len));
if (callbacks.on_node_begin) {
if (IterationDecision::Break == TRY(callbacks.on_node_begin(current_node_name)))
return {};
}
break;
}
case EndNode:
if (callbacks.on_node_end) {
if (IterationDecision::Break == TRY(callbacks.on_node_end(current_node_name)))
return {};
}
break;
case Property: {
if (prev_token == EndNode) {
return Error::from_string_view_or_print_error_and_return_errno("Invalid node sequence, FDT_PROP after FDT_END_NODE"sv, EINVAL);
}
auto len = TRY(stream.read_value<BigEndian<u32>>());
auto nameoff = TRY(stream.read_value<BigEndian<u32>>());
if (nameoff >= header.size_dt_strings) {
return Error::from_string_view_or_print_error_and_return_errno("Invalid name offset in FDT_PROP"sv, EINVAL);
}
size_t const prop_name_max_len = header.size_dt_strings - nameoff;
size_t const prop_name_len = strnlen(begin_strings_block + nameoff, prop_name_max_len);
if (prop_name_len == prop_name_max_len) {
return Error::from_string_view_or_print_error_and_return_errno("Non-null terminated name for FDT_PROP token!"sv, EINVAL);
}
StringView prop_name(begin_strings_block + nameoff, prop_name_len);
if (len >= stream.remaining()) {
return Error::from_string_view_or_print_error_and_return_errno("Property value length too large"sv, EINVAL);
}
ReadonlyBytes prop_value;
if (len != 0) {
prop_value = { struct_bytes.slice(stream.offset()).data(), len };
size_t const consume_len = round_up_to_power_of_two(static_cast<u32>(len), 4);
TRY(stream.discard(consume_len));
}
if (callbacks.on_property) {
if (IterationDecision::Break == TRY(callbacks.on_property(prop_name, prop_value)))
return {};
}
break;
}
case NoOp:
if (callbacks.on_noop) {
if (IterationDecision::Break == TRY(callbacks.on_noop()))
return {};
}
break;
case End: {
if (prev_token == BeginNode || prev_token == Property) {
return Error::from_string_view_or_print_error_and_return_errno("Invalid node sequence, FDT_END after BEGIN_NODE or PROP"sv, EINVAL);
}
if (!stream.is_eof()) {
return Error::from_string_view_or_print_error_and_return_errno("Expected EOF at FTD_END but more data remains"sv, EINVAL);
}
if (callbacks.on_end) {
return callbacks.on_end();
}
return {};
}
default:
return Error::from_string_view_or_print_error_and_return_errno("Invalid token"sv, EINVAL);
}
prev_token = static_cast<FlattenedDeviceTreeTokenType>(static_cast<u32>(current_token));
}
return Error::from_string_view_or_print_error_and_return_errno("Unexpected end of stream"sv, EINVAL);
}
static ErrorOr<ReadonlyBytes> slow_get_property_raw(StringView name, FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree)
{
// Name is a path like /path/to/node/property
Vector<StringView, 16> path;
TRY(name.for_each_split_view('/', SplitBehavior::Nothing, [&path](StringView view) -> ErrorOr<void> {
if (path.size() == path.capacity()) {
return Error::from_errno(ENAMETOOLONG);
}
// This can never fail as all entries go into the inline buffer, enforced by the check above.
MUST(path.try_append(view));
return {};
}));
bool check_property_name = path.size() == 1; // Properties on root node should be checked immediately
ssize_t current_path_idx = -1; // Start "before" the root FDT_BEGIN_NODE tag
ReadonlyBytes found_property_value;
DeviceTreeCallbacks callbacks = {
.on_node_begin = [&](StringView token_name) -> ErrorOr<IterationDecision> {
if (current_path_idx < 0) {
++current_path_idx; // Root node
return IterationDecision::Continue;
}
if (token_name == path[current_path_idx]) {
++current_path_idx;
if (current_path_idx == static_cast<ssize_t>(path.size() - 1)) {
check_property_name = true;
}
}
return IterationDecision::Continue;
},
.on_node_end = [&](StringView) -> ErrorOr<IterationDecision> {
if (check_property_name) {
// Not found, but we were looking for the property
return Error::from_errno(EINVAL);
}
return IterationDecision::Continue;
},
.on_property = [&](StringView property_name, ReadonlyBytes property_value) -> ErrorOr<IterationDecision> {
if (check_property_name && property_name == path[current_path_idx]) {
found_property_value = property_value;
return IterationDecision::Break;
}
return IterationDecision::Continue;
},
.on_noop = nullptr,
.on_end = [&]() -> ErrorOr<void> {
return Error::from_string_view_or_print_error_and_return_errno("Property not found"sv, EINVAL);
}
};
TRY(walk_device_tree(header, raw_device_tree, move(callbacks)));
return found_property_value;
}
template<typename T>
ErrorOr<T> slow_get_property(StringView name, FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree)
{
[[maybe_unused]] auto bytes = TRY(slow_get_property_raw(name, header, raw_device_tree));
if constexpr (IsVoid<T>) {
return {};
} else if constexpr (IsArithmetic<T>) {
if (bytes.size() != sizeof(T)) {
return Error::from_errno(EINVAL);
}
return *bit_cast<T*>(bytes.data());
} else {
static_assert(IsSame<T, StringView>);
return T(bytes);
}
}
template ErrorOr<void> slow_get_property(StringView name, FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree);
template ErrorOr<u32> slow_get_property(StringView name, FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree);
template ErrorOr<u64> slow_get_property(StringView name, FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree);
template ErrorOr<StringView> slow_get_property(StringView name, FlattenedDeviceTreeHeader const& header, ReadonlyBytes raw_device_tree);
} // namespace DeviceTree
|
