1 // SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)
3 * libfdt - Flat Device Tree manipulation
4 * Copyright (C) 2006 David Gibson, IBM Corporation.
6 #include "libfdt_env.h"
11 #include "libfdt_internal.h"
13 static int fdt_sw_probe_(void *fdt)
15 if (fdt_chk_basic()) {
16 if (fdt_magic(fdt) == FDT_MAGIC)
17 return -FDT_ERR_BADSTATE;
18 else if (fdt_magic(fdt) != FDT_SW_MAGIC)
19 return -FDT_ERR_BADMAGIC;
25 #define FDT_SW_PROBE(fdt) \
28 if (fdt_chk_basic() && (err = fdt_sw_probe_(fdt)) != 0) \
32 /* 'memrsv' state: Initial state after fdt_create()
35 * fdt_add_reservmap_entry()
36 * fdt_finish_reservemap() [moves to 'struct' state]
38 static int fdt_sw_probe_memrsv_(void *fdt)
40 int err = fdt_sw_probe_(fdt);
44 if (fdt_chk_extra() && fdt_off_dt_strings(fdt) != 0)
45 return -FDT_ERR_BADSTATE;
49 #define FDT_SW_PROBE_MEMRSV(fdt) \
52 if (fdt_chk_extra() && (err = fdt_sw_probe_memrsv_(fdt)) != 0) \
56 /* 'struct' state: Enter this state after fdt_finish_reservemap()
62 * fdt_finish() [moves to 'complete' state]
64 static int fdt_sw_probe_struct_(void *fdt)
70 err = fdt_sw_probe_(fdt);
74 if (fdt_off_dt_strings(fdt) != fdt_totalsize(fdt))
75 return -FDT_ERR_BADSTATE;
79 #define FDT_SW_PROBE_STRUCT(fdt) \
82 if (fdt_chk_extra() && (err = fdt_sw_probe_struct_(fdt)) != 0) \
86 static inline uint32_t sw_flags(void *fdt)
88 /* assert: (fdt_magic(fdt) == FDT_SW_MAGIC) */
89 return fdt_last_comp_version(fdt);
92 /* 'complete' state: Enter this state after fdt_finish()
94 * Allowed functions: none
97 static void *fdt_grab_space_(void *fdt, size_t len)
99 unsigned int offset = fdt_size_dt_struct(fdt);
100 unsigned int spaceleft;
102 spaceleft = fdt_totalsize(fdt) - fdt_off_dt_struct(fdt)
103 - fdt_size_dt_strings(fdt);
105 if ((offset + len < offset) || (offset + len > spaceleft))
108 fdt_set_size_dt_struct(fdt, offset + len);
109 return fdt_offset_ptr_w_(fdt, offset);
112 int fdt_create_with_flags(void *buf, int bufsize, uint32_t flags)
114 const int hdrsize = FDT_ALIGN(sizeof(struct fdt_header),
115 sizeof(struct fdt_reserve_entry));
118 if (bufsize < hdrsize)
119 return -FDT_ERR_NOSPACE;
121 if (flags & ~FDT_CREATE_FLAGS_ALL)
122 return -FDT_ERR_BADFLAGS;
124 memset(buf, 0, bufsize);
127 * magic and last_comp_version keep intermediate state during the fdt
128 * creation process, which is replaced with the proper FDT format by
131 * flags should be accessed with sw_flags().
133 fdt_set_magic(fdt, FDT_SW_MAGIC);
134 fdt_set_version(fdt, FDT_LAST_SUPPORTED_VERSION);
135 fdt_set_last_comp_version(fdt, flags);
137 fdt_set_totalsize(fdt, bufsize);
139 fdt_set_off_mem_rsvmap(fdt, hdrsize);
140 fdt_set_off_dt_struct(fdt, fdt_off_mem_rsvmap(fdt));
141 fdt_set_off_dt_strings(fdt, 0);
146 int fdt_create(void *buf, int bufsize)
148 return fdt_create_with_flags(buf, bufsize, 0);
151 int fdt_resize(void *fdt, void *buf, int bufsize)
153 size_t headsize, tailsize;
154 char *oldtail, *newtail;
159 return -FDT_ERR_NOSPACE;
161 headsize = fdt_off_dt_struct(fdt) + fdt_size_dt_struct(fdt);
162 tailsize = fdt_size_dt_strings(fdt);
164 if (fdt_chk_extra() && (headsize + tailsize) > fdt_totalsize(fdt))
165 return -FDT_ERR_INTERNAL;
167 if ((headsize + tailsize) > (unsigned)bufsize)
168 return -FDT_ERR_NOSPACE;
170 oldtail = (char *)fdt + fdt_totalsize(fdt) - tailsize;
171 newtail = (char *)buf + bufsize - tailsize;
173 /* Two cases to avoid clobbering data if the old and new
174 * buffers partially overlap */
176 memmove(buf, fdt, headsize);
177 memmove(newtail, oldtail, tailsize);
179 memmove(newtail, oldtail, tailsize);
180 memmove(buf, fdt, headsize);
183 fdt_set_totalsize(buf, bufsize);
184 if (fdt_off_dt_strings(buf))
185 fdt_set_off_dt_strings(buf, bufsize);
190 int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size)
192 struct fdt_reserve_entry *re;
195 FDT_SW_PROBE_MEMRSV(fdt);
197 offset = fdt_off_dt_struct(fdt);
198 if ((offset + sizeof(*re)) > fdt_totalsize(fdt))
199 return -FDT_ERR_NOSPACE;
201 re = (struct fdt_reserve_entry *)((char *)fdt + offset);
202 re->address = cpu_to_fdt64(addr);
203 re->size = cpu_to_fdt64(size);
205 fdt_set_off_dt_struct(fdt, offset + sizeof(*re));
210 int fdt_finish_reservemap(void *fdt)
212 int err = fdt_add_reservemap_entry(fdt, 0, 0);
217 fdt_set_off_dt_strings(fdt, fdt_totalsize(fdt));
221 int fdt_begin_node(void *fdt, const char *name)
223 struct fdt_node_header *nh;
226 FDT_SW_PROBE_STRUCT(fdt);
228 namelen = strlen(name) + 1;
229 nh = fdt_grab_space_(fdt, sizeof(*nh) + FDT_TAGALIGN(namelen));
231 return -FDT_ERR_NOSPACE;
233 nh->tag = cpu_to_fdt32(FDT_BEGIN_NODE);
234 memcpy(nh->name, name, namelen);
238 int fdt_end_node(void *fdt)
242 FDT_SW_PROBE_STRUCT(fdt);
244 en = fdt_grab_space_(fdt, FDT_TAGSIZE);
246 return -FDT_ERR_NOSPACE;
248 *en = cpu_to_fdt32(FDT_END_NODE);
252 static int fdt_add_string_(void *fdt, const char *s)
254 char *strtab = (char *)fdt + fdt_totalsize(fdt);
255 unsigned int strtabsize = fdt_size_dt_strings(fdt);
256 unsigned int len = strlen(s) + 1;
257 unsigned int struct_top, offset;
259 offset = strtabsize + len;
260 struct_top = fdt_off_dt_struct(fdt) + fdt_size_dt_struct(fdt);
261 if (fdt_totalsize(fdt) - offset < struct_top)
262 return 0; /* no more room :( */
264 memcpy(strtab - offset, s, len);
265 fdt_set_size_dt_strings(fdt, strtabsize + len);
269 /* Must only be used to roll back in case of error */
270 static void fdt_del_last_string_(void *fdt, const char *s)
272 int strtabsize = fdt_size_dt_strings(fdt);
273 int len = strlen(s) + 1;
275 fdt_set_size_dt_strings(fdt, strtabsize - len);
278 static int fdt_find_add_string_(void *fdt, const char *s, int *allocated)
280 char *strtab = (char *)fdt + fdt_totalsize(fdt);
281 int strtabsize = fdt_size_dt_strings(fdt);
286 p = fdt_find_string_(strtab - strtabsize, strtabsize, s);
292 return fdt_add_string_(fdt, s);
295 int fdt_property_placeholder(void *fdt, const char *name, int len, void **valp)
297 struct fdt_property *prop;
301 FDT_SW_PROBE_STRUCT(fdt);
303 /* String de-duplication can be slow, _NO_NAME_DEDUP skips it */
304 if (sw_flags(fdt) & FDT_CREATE_FLAG_NO_NAME_DEDUP) {
306 nameoff = fdt_add_string_(fdt, name);
308 nameoff = fdt_find_add_string_(fdt, name, &allocated);
311 return -FDT_ERR_NOSPACE;
313 prop = fdt_grab_space_(fdt, sizeof(*prop) + FDT_TAGALIGN(len));
316 fdt_del_last_string_(fdt, name);
317 return -FDT_ERR_NOSPACE;
320 prop->tag = cpu_to_fdt32(FDT_PROP);
321 prop->nameoff = cpu_to_fdt32(nameoff);
322 prop->len = cpu_to_fdt32(len);
327 int fdt_property(void *fdt, const char *name, const void *val, int len)
332 ret = fdt_property_placeholder(fdt, name, len, &ptr);
335 memcpy(ptr, val, len);
339 int fdt_finish(void *fdt)
341 char *p = (char *)fdt;
343 int oldstroffset, newstroffset;
345 int offset, nextoffset;
347 FDT_SW_PROBE_STRUCT(fdt);
350 end = fdt_grab_space_(fdt, sizeof(*end));
352 return -FDT_ERR_NOSPACE;
353 *end = cpu_to_fdt32(FDT_END);
355 /* Relocate the string table */
356 oldstroffset = fdt_totalsize(fdt) - fdt_size_dt_strings(fdt);
357 newstroffset = fdt_off_dt_struct(fdt) + fdt_size_dt_struct(fdt);
358 memmove(p + newstroffset, p + oldstroffset, fdt_size_dt_strings(fdt));
359 fdt_set_off_dt_strings(fdt, newstroffset);
361 /* Walk the structure, correcting string offsets */
363 while ((tag = fdt_next_tag(fdt, offset, &nextoffset)) != FDT_END) {
364 if (tag == FDT_PROP) {
365 struct fdt_property *prop =
366 fdt_offset_ptr_w_(fdt, offset);
369 nameoff = fdt32_to_cpu(prop->nameoff);
370 nameoff += fdt_size_dt_strings(fdt);
371 prop->nameoff = cpu_to_fdt32(nameoff);
378 /* Finally, adjust the header */
379 fdt_set_totalsize(fdt, newstroffset + fdt_size_dt_strings(fdt));
381 /* And fix up fields that were keeping intermediate state. */
382 fdt_set_last_comp_version(fdt, FDT_FIRST_SUPPORTED_VERSION);
383 fdt_set_magic(fdt, FDT_MAGIC);