1 // SPDX-License-Identifier: LGPL-2.1-or-later
2 /*
3  * libfdt - Flat Device Tree manipulation
4  *	Testcase for DT overlays()
5  * Copyright (C) 2016 Free Electrons
6  * Copyright (C) 2016 NextThing Co.
7  */
8 
9 #include <stdio.h>
10 
11 #include <libfdt.h>
12 
13 #include "tests.h"
14 
15 #define CHECK(code) \
16 	{ \
17 		int err = (code); \
18 		if (err) \
19 			FAIL(#code ": %s", fdt_strerror(err)); \
20 	}
21 
22 /* 4k ought to be enough for anybody */
23 #define FDT_COPY_SIZE	(4 * 1024)
24 
fdt_getprop_u32_by_poffset(void * fdt,const char * path,const char * name,int poffset,unsigned long * out)25 static int fdt_getprop_u32_by_poffset(void *fdt, const char *path,
26 				      const char *name, int poffset,
27 				      unsigned long *out)
28 {
29 	const fdt32_t *val;
30 	int node_off;
31 	int len;
32 
33 	node_off = fdt_path_offset(fdt, path);
34 	if (node_off < 0)
35 		return node_off;
36 
37 	val = fdt_getprop(fdt, node_off, name, &len);
38 	if (!val || (len < (sizeof(uint32_t) * (poffset + 1))))
39 		return -FDT_ERR_NOTFOUND;
40 
41 	*out = fdt32_to_cpu(*(val + poffset));
42 
43 	return 0;
44 }
45 
check_getprop_string_by_name(void * fdt,const char * path,const char * name,const char * val)46 static int check_getprop_string_by_name(void *fdt, const char *path,
47 					const char *name, const char *val)
48 {
49 	int node_off;
50 
51 	node_off = fdt_path_offset(fdt, path);
52 	if (node_off < 0)
53 		return node_off;
54 
55 	check_getprop_string(fdt, node_off, name, val);
56 
57 	return 0;
58 }
59 
check_getprop_u32_by_name(void * fdt,const char * path,const char * name,uint32_t val)60 static int check_getprop_u32_by_name(void *fdt, const char *path,
61 				     const char *name, uint32_t val)
62 {
63 	int node_off;
64 
65 	node_off = fdt_path_offset(fdt, path);
66 	CHECK(node_off < 0);
67 
68 	check_getprop_cell(fdt, node_off, name, val);
69 
70 	return 0;
71 }
72 
check_getprop_null_by_name(void * fdt,const char * path,const char * name)73 static int check_getprop_null_by_name(void *fdt, const char *path,
74 				      const char *name)
75 {
76 	int node_off;
77 
78 	node_off = fdt_path_offset(fdt, path);
79 	CHECK(node_off < 0);
80 
81 	check_property(fdt, node_off, name, 0, NULL);
82 
83 	return 0;
84 }
85 
fdt_overlay_change_int_property(void * fdt)86 static int fdt_overlay_change_int_property(void *fdt)
87 {
88 	return check_getprop_u32_by_name(fdt, "/test-node", "test-int-property",
89 					 43);
90 }
91 
fdt_overlay_change_str_property(void * fdt)92 static int fdt_overlay_change_str_property(void *fdt)
93 {
94 	return check_getprop_string_by_name(fdt, "/test-node",
95 					    "test-str-property", "foobar");
96 }
97 
fdt_overlay_add_str_property(void * fdt)98 static int fdt_overlay_add_str_property(void *fdt)
99 {
100 	return check_getprop_string_by_name(fdt, "/test-node",
101 					    "test-str-property-2", "foobar2");
102 }
103 
fdt_overlay_add_node(void * fdt)104 static int fdt_overlay_add_node(void *fdt)
105 {
106 	return check_getprop_null_by_name(fdt, "/test-node/new-node",
107 					  "new-property");
108 }
109 
fdt_overlay_add_subnode_property(void * fdt)110 static int fdt_overlay_add_subnode_property(void *fdt)
111 {
112 	check_getprop_null_by_name(fdt, "/test-node/sub-test-node",
113 				   "sub-test-property");
114 	check_getprop_null_by_name(fdt, "/test-node/sub-test-node",
115 				   "new-sub-test-property");
116 
117 	return 0;
118 }
119 
fdt_overlay_local_phandle(void * fdt)120 static int fdt_overlay_local_phandle(void *fdt)
121 {
122 	uint32_t local_phandle;
123 	unsigned long val = 0;
124 	int off;
125 
126 	off = fdt_path_offset(fdt, "/test-node/new-local-node");
127 	CHECK(off < 0);
128 
129 	local_phandle = fdt_get_phandle(fdt, off);
130 	CHECK(!local_phandle);
131 
132 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
133 					 "test-several-phandle",
134 					 0, &val));
135 	CHECK(val != local_phandle);
136 
137 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
138 					 "test-several-phandle",
139 					 1, &val));
140 	CHECK(val != local_phandle);
141 
142 	return 0;
143 }
144 
fdt_overlay_local_phandles(void * fdt)145 static int fdt_overlay_local_phandles(void *fdt)
146 {
147 	uint32_t local_phandle, test_phandle;
148 	unsigned long val = 0;
149 	int off;
150 
151 	off = fdt_path_offset(fdt, "/test-node/new-local-node");
152 	CHECK(off < 0);
153 
154 	local_phandle = fdt_get_phandle(fdt, off);
155 	CHECK(!local_phandle);
156 
157 	off = fdt_path_offset(fdt, "/test-node");
158 	CHECK(off < 0);
159 
160 	test_phandle = fdt_get_phandle(fdt, off);
161 	CHECK(!test_phandle);
162 
163 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
164 					 "test-phandle", 0, &val));
165 	CHECK(test_phandle != val);
166 
167 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
168 					 "test-phandle", 1, &val));
169 	CHECK(local_phandle != val);
170 
171 	return 0;
172 }
173 
open_dt(char * path)174 static void *open_dt(char *path)
175 {
176 	void *dt, *copy;
177 
178 	dt = load_blob(path);
179 	copy = xmalloc(FDT_COPY_SIZE);
180 
181 	/*
182 	 * Resize our DTs to 4k so that we have room to operate on
183 	 */
184 	CHECK(fdt_open_into(dt, copy, FDT_COPY_SIZE));
185 
186 	return copy;
187 }
188 
main(int argc,char * argv[])189 int main(int argc, char *argv[])
190 {
191 	void *fdt_base, *fdt_overlay;
192 
193 	test_init(argc, argv);
194 	if (argc != 3)
195 		CONFIG("Usage: %s <base dtb> <overlay dtb>", argv[0]);
196 
197 	fdt_base = open_dt(argv[1]);
198 	fdt_overlay = open_dt(argv[2]);
199 
200 	/* Apply the overlay */
201 	CHECK(fdt_overlay_apply(fdt_base, fdt_overlay));
202 
203 	fdt_overlay_change_int_property(fdt_base);
204 	fdt_overlay_change_str_property(fdt_base);
205 	fdt_overlay_add_str_property(fdt_base);
206 	fdt_overlay_add_node(fdt_base);
207 	fdt_overlay_add_subnode_property(fdt_base);
208 
209 	/*
210 	 * If the base tree has a __symbols__ node, do the tests that
211 	 * are only successful with a proper phandle support, and thus
212 	 * dtc -@
213 	 */
214 	if (fdt_path_offset(fdt_base, "/__symbols__") >= 0) {
215 		fdt_overlay_local_phandle(fdt_base);
216 		fdt_overlay_local_phandles(fdt_base);
217 	}
218 
219 	PASS();
220 }
221