xref: /aosp_15_r20/external/dtc/tests/overlay.c (revision cd60bc56d4bea3af4ec04523e4d71c2b272c8aff)
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 < 0)
39 		FAIL("fdt_getprop() returns negative length");
40 	if (!val && len < 0)
41 		return len;
42 	if (!val || ((unsigned)len < (sizeof(uint32_t) * (poffset + 1))))
43 		return -FDT_ERR_NOTFOUND;
44 
45 	*out = fdt32_to_cpu(*(val + poffset));
46 
47 	return 0;
48 }
49 
check_getprop_string_by_name(void * fdt,const char * path,const char * name,const char * val)50 static int check_getprop_string_by_name(void *fdt, const char *path,
51 					const char *name, const char *val)
52 {
53 	int node_off;
54 
55 	node_off = fdt_path_offset(fdt, path);
56 	if (node_off < 0)
57 		return node_off;
58 
59 	check_getprop_string(fdt, node_off, name, val);
60 
61 	return 0;
62 }
63 
check_getprop_u32_by_name(void * fdt,const char * path,const char * name,uint32_t val)64 static int check_getprop_u32_by_name(void *fdt, const char *path,
65 				     const char *name, uint32_t val)
66 {
67 	int node_off;
68 
69 	node_off = fdt_path_offset(fdt, path);
70 	CHECK(node_off < 0);
71 
72 	check_getprop_cell(fdt, node_off, name, val);
73 
74 	return 0;
75 }
76 
check_getprop_null_by_name(void * fdt,const char * path,const char * name)77 static int check_getprop_null_by_name(void *fdt, const char *path,
78 				      const char *name)
79 {
80 	int node_off;
81 
82 	node_off = fdt_path_offset(fdt, path);
83 	CHECK(node_off < 0);
84 
85 	check_property(fdt, node_off, name, 0, NULL);
86 
87 	return 0;
88 }
89 
fdt_overlay_change_int_property(void * fdt)90 static int fdt_overlay_change_int_property(void *fdt)
91 {
92 	return check_getprop_u32_by_name(fdt, "/test-node", "test-int-property",
93 					 43);
94 }
95 
fdt_overlay_change_str_property(void * fdt)96 static int fdt_overlay_change_str_property(void *fdt)
97 {
98 	return check_getprop_string_by_name(fdt, "/test-node",
99 					    "test-str-property", "foobar");
100 }
101 
fdt_overlay_add_str_property(void * fdt)102 static int fdt_overlay_add_str_property(void *fdt)
103 {
104 	return check_getprop_string_by_name(fdt, "/test-node",
105 					    "test-str-property-2", "foobar2");
106 }
107 
fdt_overlay_add_node(void * fdt)108 static int fdt_overlay_add_node(void *fdt)
109 {
110 	return check_getprop_null_by_name(fdt, "/test-node/new-node",
111 					  "new-property");
112 }
113 
fdt_overlay_add_subnode_property(void * fdt)114 static int fdt_overlay_add_subnode_property(void *fdt)
115 {
116 	check_getprop_null_by_name(fdt, "/test-node/sub-test-node",
117 				   "sub-test-property");
118 	check_getprop_null_by_name(fdt, "/test-node/sub-test-node",
119 				   "new-sub-test-property");
120 
121 	return 0;
122 }
123 
fdt_overlay_local_phandle(void * fdt)124 static int fdt_overlay_local_phandle(void *fdt)
125 {
126 	uint32_t local_phandle;
127 	unsigned long val = 0;
128 	int off;
129 
130 	off = fdt_path_offset(fdt, "/test-node/new-local-node");
131 	CHECK(off < 0);
132 
133 	local_phandle = fdt_get_phandle(fdt, off);
134 	CHECK(!local_phandle);
135 
136 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
137 					 "test-several-phandle",
138 					 0, &val));
139 	CHECK(val != local_phandle);
140 
141 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
142 					 "test-several-phandle",
143 					 1, &val));
144 	CHECK(val != local_phandle);
145 
146 	return 0;
147 }
148 
fdt_overlay_local_phandles(void * fdt)149 static int fdt_overlay_local_phandles(void *fdt)
150 {
151 	uint32_t local_phandle, test_phandle;
152 	unsigned long val = 0;
153 	int off;
154 
155 	off = fdt_path_offset(fdt, "/test-node/new-local-node");
156 	CHECK(off < 0);
157 
158 	local_phandle = fdt_get_phandle(fdt, off);
159 	CHECK(!local_phandle);
160 
161 	off = fdt_path_offset(fdt, "/test-node");
162 	CHECK(off < 0);
163 
164 	test_phandle = fdt_get_phandle(fdt, off);
165 	CHECK(!test_phandle);
166 
167 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
168 					 "test-phandle", 0, &val));
169 	CHECK(test_phandle != val);
170 
171 	CHECK(fdt_getprop_u32_by_poffset(fdt, "/test-node",
172 					 "test-phandle", 1, &val));
173 	CHECK(local_phandle != val);
174 
175 	return 0;
176 }
177 
open_dt(char * path)178 static void *open_dt(char *path)
179 {
180 	void *dt, *copy;
181 
182 	dt = load_blob(path);
183 	copy = xmalloc(FDT_COPY_SIZE);
184 
185 	/*
186 	 * Resize our DTs to 4k so that we have room to operate on
187 	 */
188 	CHECK(fdt_open_into(dt, copy, FDT_COPY_SIZE));
189 
190 	return copy;
191 }
192 
main(int argc,char * argv[])193 int main(int argc, char *argv[])
194 {
195 	void *fdt_base, *fdt_overlay;
196 
197 	test_init(argc, argv);
198 	if (argc != 3)
199 		CONFIG("Usage: %s <base dtb> <overlay dtb>", argv[0]);
200 
201 	fdt_base = open_dt(argv[1]);
202 	fdt_overlay = open_dt(argv[2]);
203 
204 	/* Apply the overlay */
205 	CHECK(fdt_overlay_apply(fdt_base, fdt_overlay));
206 
207 	fdt_overlay_change_int_property(fdt_base);
208 	fdt_overlay_change_str_property(fdt_base);
209 	fdt_overlay_add_str_property(fdt_base);
210 	fdt_overlay_add_node(fdt_base);
211 	fdt_overlay_add_subnode_property(fdt_base);
212 
213 	/*
214 	 * If the base tree has a __symbols__ node, do the tests that
215 	 * are only successful with a proper phandle support, and thus
216 	 * dtc -@
217 	 */
218 	if (fdt_path_offset(fdt_base, "/__symbols__") >= 0) {
219 		fdt_overlay_local_phandle(fdt_base);
220 		fdt_overlay_local_phandles(fdt_base);
221 	}
222 
223 	PASS();
224 }
225