xref: /openbmc/u-boot/lib/libfdt/fdt_rw.c (revision b24a8ec1)
1 /*
2  * libfdt - Flat Device Tree manipulation
3  * Copyright (C) 2006 David Gibson, IBM Corporation.
4  * SPDX-License-Identifier:	GPL-2.0+ BSD-2-Clause
5  */
6 #include <libfdt_env.h>
7 
8 #ifndef USE_HOSTCC
9 #include <fdt.h>
10 #include <libfdt.h>
11 #else
12 #include "fdt_host.h"
13 #endif
14 
15 #include "libfdt_internal.h"
16 
17 static int _fdt_blocks_misordered(const void *fdt,
18 			      int mem_rsv_size, int struct_size)
19 {
20 	return (fdt_off_mem_rsvmap(fdt) < FDT_ALIGN(sizeof(struct fdt_header), 8))
21 		|| (fdt_off_dt_struct(fdt) <
22 		    (fdt_off_mem_rsvmap(fdt) + mem_rsv_size))
23 		|| (fdt_off_dt_strings(fdt) <
24 		    (fdt_off_dt_struct(fdt) + struct_size))
25 		|| (fdt_totalsize(fdt) <
26 		    (fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt)));
27 }
28 
29 static int _fdt_rw_check_header(void *fdt)
30 {
31 	FDT_CHECK_HEADER(fdt);
32 
33 	if (fdt_version(fdt) < 17)
34 		return -FDT_ERR_BADVERSION;
35 	if (_fdt_blocks_misordered(fdt, sizeof(struct fdt_reserve_entry),
36 				   fdt_size_dt_struct(fdt)))
37 		return -FDT_ERR_BADLAYOUT;
38 	if (fdt_version(fdt) > 17)
39 		fdt_set_version(fdt, 17);
40 
41 	return 0;
42 }
43 
44 #define FDT_RW_CHECK_HEADER(fdt) \
45 	{ \
46 		int __err; \
47 		if ((__err = _fdt_rw_check_header(fdt)) != 0) \
48 			return __err; \
49 	}
50 
51 static inline int _fdt_data_size(void *fdt)
52 {
53 	return fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
54 }
55 
56 static int _fdt_splice(void *fdt, void *splicepoint, int oldlen, int newlen)
57 {
58 	char *p = splicepoint;
59 	char *end = (char *)fdt + _fdt_data_size(fdt);
60 
61 	if (((p + oldlen) < p) || ((p + oldlen) > end))
62 		return -FDT_ERR_BADOFFSET;
63 	if ((p < (char *)fdt) || ((end - oldlen + newlen) < (char *)fdt))
64 		return -FDT_ERR_BADOFFSET;
65 	if ((end - oldlen + newlen) > ((char *)fdt + fdt_totalsize(fdt)))
66 		return -FDT_ERR_NOSPACE;
67 	memmove(p + newlen, p + oldlen, end - p - oldlen);
68 	return 0;
69 }
70 
71 static int _fdt_splice_mem_rsv(void *fdt, struct fdt_reserve_entry *p,
72 			       int oldn, int newn)
73 {
74 	int delta = (newn - oldn) * sizeof(*p);
75 	int err;
76 	err = _fdt_splice(fdt, p, oldn * sizeof(*p), newn * sizeof(*p));
77 	if (err)
78 		return err;
79 	fdt_set_off_dt_struct(fdt, fdt_off_dt_struct(fdt) + delta);
80 	fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
81 	return 0;
82 }
83 
84 static int _fdt_splice_struct(void *fdt, void *p,
85 			      int oldlen, int newlen)
86 {
87 	int delta = newlen - oldlen;
88 	int err;
89 
90 	if ((err = _fdt_splice(fdt, p, oldlen, newlen)))
91 		return err;
92 
93 	fdt_set_size_dt_struct(fdt, fdt_size_dt_struct(fdt) + delta);
94 	fdt_set_off_dt_strings(fdt, fdt_off_dt_strings(fdt) + delta);
95 	return 0;
96 }
97 
98 static int _fdt_splice_string(void *fdt, int newlen)
99 {
100 	void *p = (char *)fdt
101 		+ fdt_off_dt_strings(fdt) + fdt_size_dt_strings(fdt);
102 	int err;
103 
104 	if ((err = _fdt_splice(fdt, p, 0, newlen)))
105 		return err;
106 
107 	fdt_set_size_dt_strings(fdt, fdt_size_dt_strings(fdt) + newlen);
108 	return 0;
109 }
110 
111 static int _fdt_find_add_string(void *fdt, const char *s)
112 {
113 	char *strtab = (char *)fdt + fdt_off_dt_strings(fdt);
114 	const char *p;
115 	char *new;
116 	int len = strlen(s) + 1;
117 	int err;
118 
119 	p = _fdt_find_string(strtab, fdt_size_dt_strings(fdt), s);
120 	if (p)
121 		/* found it */
122 		return (p - strtab);
123 
124 	new = strtab + fdt_size_dt_strings(fdt);
125 	err = _fdt_splice_string(fdt, len);
126 	if (err)
127 		return err;
128 
129 	memcpy(new, s, len);
130 	return (new - strtab);
131 }
132 
133 int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size)
134 {
135 	struct fdt_reserve_entry *re;
136 	int err;
137 
138 	FDT_RW_CHECK_HEADER(fdt);
139 
140 	re = _fdt_mem_rsv_w(fdt, fdt_num_mem_rsv(fdt));
141 	err = _fdt_splice_mem_rsv(fdt, re, 0, 1);
142 	if (err)
143 		return err;
144 
145 	re->address = cpu_to_fdt64(address);
146 	re->size = cpu_to_fdt64(size);
147 	return 0;
148 }
149 
150 int fdt_del_mem_rsv(void *fdt, int n)
151 {
152 	struct fdt_reserve_entry *re = _fdt_mem_rsv_w(fdt, n);
153 
154 	FDT_RW_CHECK_HEADER(fdt);
155 
156 	if (n >= fdt_num_mem_rsv(fdt))
157 		return -FDT_ERR_NOTFOUND;
158 
159 	return _fdt_splice_mem_rsv(fdt, re, 1, 0);
160 }
161 
162 static int _fdt_resize_property(void *fdt, int nodeoffset, const char *name,
163 				int len, struct fdt_property **prop)
164 {
165 	int oldlen;
166 	int err;
167 
168 	*prop = fdt_get_property_w(fdt, nodeoffset, name, &oldlen);
169 	if (!*prop)
170 		return oldlen;
171 
172 	if ((err = _fdt_splice_struct(fdt, (*prop)->data, FDT_TAGALIGN(oldlen),
173 				      FDT_TAGALIGN(len))))
174 		return err;
175 
176 	(*prop)->len = cpu_to_fdt32(len);
177 	return 0;
178 }
179 
180 static int _fdt_add_property(void *fdt, int nodeoffset, const char *name,
181 			     int len, struct fdt_property **prop)
182 {
183 	int proplen;
184 	int nextoffset;
185 	int namestroff;
186 	int err;
187 
188 	if ((nextoffset = _fdt_check_node_offset(fdt, nodeoffset)) < 0)
189 		return nextoffset;
190 
191 	namestroff = _fdt_find_add_string(fdt, name);
192 	if (namestroff < 0)
193 		return namestroff;
194 
195 	*prop = _fdt_offset_ptr_w(fdt, nextoffset);
196 	proplen = sizeof(**prop) + FDT_TAGALIGN(len);
197 
198 	err = _fdt_splice_struct(fdt, *prop, 0, proplen);
199 	if (err)
200 		return err;
201 
202 	(*prop)->tag = cpu_to_fdt32(FDT_PROP);
203 	(*prop)->nameoff = cpu_to_fdt32(namestroff);
204 	(*prop)->len = cpu_to_fdt32(len);
205 	return 0;
206 }
207 
208 int fdt_set_name(void *fdt, int nodeoffset, const char *name)
209 {
210 	char *namep;
211 	int oldlen, newlen;
212 	int err;
213 
214 	FDT_RW_CHECK_HEADER(fdt);
215 
216 	namep = (char *)(uintptr_t)fdt_get_name(fdt, nodeoffset, &oldlen);
217 	if (!namep)
218 		return oldlen;
219 
220 	newlen = strlen(name);
221 
222 	err = _fdt_splice_struct(fdt, namep, FDT_TAGALIGN(oldlen+1),
223 				 FDT_TAGALIGN(newlen+1));
224 	if (err)
225 		return err;
226 
227 	memcpy(namep, name, newlen+1);
228 	return 0;
229 }
230 
231 int fdt_setprop(void *fdt, int nodeoffset, const char *name,
232 		const void *val, int len)
233 {
234 	struct fdt_property *prop;
235 	int err;
236 
237 	FDT_RW_CHECK_HEADER(fdt);
238 
239 	err = _fdt_resize_property(fdt, nodeoffset, name, len, &prop);
240 	if (err == -FDT_ERR_NOTFOUND)
241 		err = _fdt_add_property(fdt, nodeoffset, name, len, &prop);
242 	if (err)
243 		return err;
244 
245 	if (len)
246 		memcpy(prop->data, val, len);
247 	return 0;
248 }
249 
250 int fdt_appendprop(void *fdt, int nodeoffset, const char *name,
251 		   const void *val, int len)
252 {
253 	struct fdt_property *prop;
254 	int err, oldlen, newlen;
255 
256 	FDT_RW_CHECK_HEADER(fdt);
257 
258 	prop = fdt_get_property_w(fdt, nodeoffset, name, &oldlen);
259 	if (prop) {
260 		newlen = len + oldlen;
261 		err = _fdt_splice_struct(fdt, prop->data,
262 					 FDT_TAGALIGN(oldlen),
263 					 FDT_TAGALIGN(newlen));
264 		if (err)
265 			return err;
266 		prop->len = cpu_to_fdt32(newlen);
267 		memcpy(prop->data + oldlen, val, len);
268 	} else {
269 		err = _fdt_add_property(fdt, nodeoffset, name, len, &prop);
270 		if (err)
271 			return err;
272 		memcpy(prop->data, val, len);
273 	}
274 	return 0;
275 }
276 
277 int fdt_delprop(void *fdt, int nodeoffset, const char *name)
278 {
279 	struct fdt_property *prop;
280 	int len, proplen;
281 
282 	FDT_RW_CHECK_HEADER(fdt);
283 
284 	prop = fdt_get_property_w(fdt, nodeoffset, name, &len);
285 	if (!prop)
286 		return len;
287 
288 	proplen = sizeof(*prop) + FDT_TAGALIGN(len);
289 	return _fdt_splice_struct(fdt, prop, proplen, 0);
290 }
291 
292 int fdt_add_subnode_namelen(void *fdt, int parentoffset,
293 			    const char *name, int namelen)
294 {
295 	struct fdt_node_header *nh;
296 	int offset, nextoffset;
297 	int nodelen;
298 	int err;
299 	uint32_t tag;
300 	fdt32_t *endtag;
301 
302 	FDT_RW_CHECK_HEADER(fdt);
303 
304 	offset = fdt_subnode_offset_namelen(fdt, parentoffset, name, namelen);
305 	if (offset >= 0)
306 		return -FDT_ERR_EXISTS;
307 	else if (offset != -FDT_ERR_NOTFOUND)
308 		return offset;
309 
310 	/* Try to place the new node after the parent's properties */
311 	fdt_next_tag(fdt, parentoffset, &nextoffset); /* skip the BEGIN_NODE */
312 	do {
313 		offset = nextoffset;
314 		tag = fdt_next_tag(fdt, offset, &nextoffset);
315 	} while ((tag == FDT_PROP) || (tag == FDT_NOP));
316 
317 	nh = _fdt_offset_ptr_w(fdt, offset);
318 	nodelen = sizeof(*nh) + FDT_TAGALIGN(namelen+1) + FDT_TAGSIZE;
319 
320 	err = _fdt_splice_struct(fdt, nh, 0, nodelen);
321 	if (err)
322 		return err;
323 
324 	nh->tag = cpu_to_fdt32(FDT_BEGIN_NODE);
325 	memset(nh->name, 0, FDT_TAGALIGN(namelen+1));
326 	memcpy(nh->name, name, namelen);
327 	endtag = (fdt32_t *)((char *)nh + nodelen - FDT_TAGSIZE);
328 	*endtag = cpu_to_fdt32(FDT_END_NODE);
329 
330 	return offset;
331 }
332 
333 int fdt_add_subnode(void *fdt, int parentoffset, const char *name)
334 {
335 	return fdt_add_subnode_namelen(fdt, parentoffset, name, strlen(name));
336 }
337 
338 int fdt_del_node(void *fdt, int nodeoffset)
339 {
340 	int endoffset;
341 
342 	FDT_RW_CHECK_HEADER(fdt);
343 
344 	endoffset = _fdt_node_end_offset(fdt, nodeoffset);
345 	if (endoffset < 0)
346 		return endoffset;
347 
348 	return _fdt_splice_struct(fdt, _fdt_offset_ptr_w(fdt, nodeoffset),
349 				  endoffset - nodeoffset, 0);
350 }
351 
352 static void _fdt_packblocks(const char *old, char *new,
353 			    int mem_rsv_size, int struct_size)
354 {
355 	int mem_rsv_off, struct_off, strings_off;
356 
357 	mem_rsv_off = FDT_ALIGN(sizeof(struct fdt_header), 8);
358 	struct_off = mem_rsv_off + mem_rsv_size;
359 	strings_off = struct_off + struct_size;
360 
361 	memmove(new + mem_rsv_off, old + fdt_off_mem_rsvmap(old), mem_rsv_size);
362 	fdt_set_off_mem_rsvmap(new, mem_rsv_off);
363 
364 	memmove(new + struct_off, old + fdt_off_dt_struct(old), struct_size);
365 	fdt_set_off_dt_struct(new, struct_off);
366 	fdt_set_size_dt_struct(new, struct_size);
367 
368 	memmove(new + strings_off, old + fdt_off_dt_strings(old),
369 		fdt_size_dt_strings(old));
370 	fdt_set_off_dt_strings(new, strings_off);
371 	fdt_set_size_dt_strings(new, fdt_size_dt_strings(old));
372 }
373 
374 int fdt_open_into(const void *fdt, void *buf, int bufsize)
375 {
376 	int err;
377 	int mem_rsv_size, struct_size;
378 	int newsize;
379 	const char *fdtstart = fdt;
380 	const char *fdtend = fdtstart + fdt_totalsize(fdt);
381 	char *tmp;
382 
383 	FDT_CHECK_HEADER(fdt);
384 
385 	mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
386 		* sizeof(struct fdt_reserve_entry);
387 
388 	if (fdt_version(fdt) >= 17) {
389 		struct_size = fdt_size_dt_struct(fdt);
390 	} else {
391 		struct_size = 0;
392 		while (fdt_next_tag(fdt, struct_size, &struct_size) != FDT_END)
393 			;
394 		if (struct_size < 0)
395 			return struct_size;
396 	}
397 
398 	if (!_fdt_blocks_misordered(fdt, mem_rsv_size, struct_size)) {
399 		/* no further work necessary */
400 		err = fdt_move(fdt, buf, bufsize);
401 		if (err)
402 			return err;
403 		fdt_set_version(buf, 17);
404 		fdt_set_size_dt_struct(buf, struct_size);
405 		fdt_set_totalsize(buf, bufsize);
406 		return 0;
407 	}
408 
409 	/* Need to reorder */
410 	newsize = FDT_ALIGN(sizeof(struct fdt_header), 8) + mem_rsv_size
411 		+ struct_size + fdt_size_dt_strings(fdt);
412 
413 	if (bufsize < newsize)
414 		return -FDT_ERR_NOSPACE;
415 
416 	/* First attempt to build converted tree at beginning of buffer */
417 	tmp = buf;
418 	/* But if that overlaps with the old tree... */
419 	if (((tmp + newsize) > fdtstart) && (tmp < fdtend)) {
420 		/* Try right after the old tree instead */
421 		tmp = (char *)(uintptr_t)fdtend;
422 		if ((tmp + newsize) > ((char *)buf + bufsize))
423 			return -FDT_ERR_NOSPACE;
424 	}
425 
426 	_fdt_packblocks(fdt, tmp, mem_rsv_size, struct_size);
427 	memmove(buf, tmp, newsize);
428 
429 	fdt_set_magic(buf, FDT_MAGIC);
430 	fdt_set_totalsize(buf, bufsize);
431 	fdt_set_version(buf, 17);
432 	fdt_set_last_comp_version(buf, 16);
433 	fdt_set_boot_cpuid_phys(buf, fdt_boot_cpuid_phys(fdt));
434 
435 	return 0;
436 }
437 
438 int fdt_pack(void *fdt)
439 {
440 	int mem_rsv_size;
441 
442 	FDT_RW_CHECK_HEADER(fdt);
443 
444 	mem_rsv_size = (fdt_num_mem_rsv(fdt)+1)
445 		* sizeof(struct fdt_reserve_entry);
446 	_fdt_packblocks(fdt, fdt, mem_rsv_size, fdt_size_dt_struct(fdt));
447 	fdt_set_totalsize(fdt, _fdt_data_size(fdt));
448 
449 	return 0;
450 }
451 
452 int fdt_remove_unused_strings(const void *old, void *new)
453 {
454 	const struct fdt_property *old_prop;
455 	struct fdt_property *new_prop;
456 	int size = fdt_totalsize(old);
457 	int next_offset, offset;
458 	const char *str;
459 	int ret;
460 	int tag = FDT_PROP;
461 
462 	/* Make a copy and remove the strings */
463 	memcpy(new, old, size);
464 	fdt_set_size_dt_strings(new, 0);
465 
466 	/* Add every property name back into the new string table */
467 	for (offset = 0; tag != FDT_END; offset = next_offset) {
468 		tag = fdt_next_tag(old, offset, &next_offset);
469 		if (tag != FDT_PROP)
470 			continue;
471 		old_prop = fdt_get_property_by_offset(old, offset, NULL);
472 		new_prop = (struct fdt_property *)(unsigned long)
473 			fdt_get_property_by_offset(new, offset, NULL);
474 		str = fdt_string(old, fdt32_to_cpu(old_prop->nameoff));
475 		ret = _fdt_find_add_string(new, str);
476 		if (ret < 0)
477 			return ret;
478 		new_prop->nameoff = cpu_to_fdt32(ret);
479 	}
480 
481 	return 0;
482 }
483