xref: /OK3568_Linux_fs/u-boot/scripts/dtc/libfdt/fdt_sw.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * libfdt - Flat Device Tree manipulation
3*4882a593Smuzhiyun  * Copyright (C) 2006 David Gibson, IBM Corporation.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * libfdt is dual licensed: you can use it either under the terms of
6*4882a593Smuzhiyun  * the GPL, or the BSD license, at your option.
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  *  a) This library is free software; you can redistribute it and/or
9*4882a593Smuzhiyun  *     modify it under the terms of the GNU General Public License as
10*4882a593Smuzhiyun  *     published by the Free Software Foundation; either version 2 of the
11*4882a593Smuzhiyun  *     License, or (at your option) any later version.
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  *     This library is distributed in the hope that it will be useful,
14*4882a593Smuzhiyun  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
15*4882a593Smuzhiyun  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16*4882a593Smuzhiyun  *     GNU General Public License for more details.
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  *     You should have received a copy of the GNU General Public
19*4882a593Smuzhiyun  *     License along with this library; if not, write to the Free
20*4882a593Smuzhiyun  *     Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
21*4882a593Smuzhiyun  *     MA 02110-1301 USA
22*4882a593Smuzhiyun  *
23*4882a593Smuzhiyun  * Alternatively,
24*4882a593Smuzhiyun  *
25*4882a593Smuzhiyun  *  b) Redistribution and use in source and binary forms, with or
26*4882a593Smuzhiyun  *     without modification, are permitted provided that the following
27*4882a593Smuzhiyun  *     conditions are met:
28*4882a593Smuzhiyun  *
29*4882a593Smuzhiyun  *     1. Redistributions of source code must retain the above
30*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
31*4882a593Smuzhiyun  *        disclaimer.
32*4882a593Smuzhiyun  *     2. Redistributions in binary form must reproduce the above
33*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
34*4882a593Smuzhiyun  *        disclaimer in the documentation and/or other materials
35*4882a593Smuzhiyun  *        provided with the distribution.
36*4882a593Smuzhiyun  *
37*4882a593Smuzhiyun  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
38*4882a593Smuzhiyun  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
39*4882a593Smuzhiyun  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
40*4882a593Smuzhiyun  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
41*4882a593Smuzhiyun  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
42*4882a593Smuzhiyun  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43*4882a593Smuzhiyun  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44*4882a593Smuzhiyun  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45*4882a593Smuzhiyun  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46*4882a593Smuzhiyun  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47*4882a593Smuzhiyun  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
48*4882a593Smuzhiyun  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
49*4882a593Smuzhiyun  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
50*4882a593Smuzhiyun  */
51*4882a593Smuzhiyun #include "libfdt_env.h"
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #include <fdt.h>
54*4882a593Smuzhiyun #include <libfdt.h>
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun #include "libfdt_internal.h"
57*4882a593Smuzhiyun 
_fdt_sw_check_header(void * fdt)58*4882a593Smuzhiyun static int _fdt_sw_check_header(void *fdt)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	if (fdt_magic(fdt) != FDT_SW_MAGIC)
61*4882a593Smuzhiyun 		return -FDT_ERR_BADMAGIC;
62*4882a593Smuzhiyun 	/* FIXME: should check more details about the header state */
63*4882a593Smuzhiyun 	return 0;
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun #define FDT_SW_CHECK_HEADER(fdt) \
67*4882a593Smuzhiyun 	{ \
68*4882a593Smuzhiyun 		int err; \
69*4882a593Smuzhiyun 		if ((err = _fdt_sw_check_header(fdt)) != 0) \
70*4882a593Smuzhiyun 			return err; \
71*4882a593Smuzhiyun 	}
72*4882a593Smuzhiyun 
_fdt_grab_space(void * fdt,size_t len)73*4882a593Smuzhiyun static void *_fdt_grab_space(void *fdt, size_t len)
74*4882a593Smuzhiyun {
75*4882a593Smuzhiyun 	int offset = fdt_size_dt_struct(fdt);
76*4882a593Smuzhiyun 	int spaceleft;
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	spaceleft = fdt_totalsize(fdt) - fdt_off_dt_struct(fdt)
79*4882a593Smuzhiyun 		- fdt_size_dt_strings(fdt);
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	if ((offset + len < offset) || (offset + len > spaceleft))
82*4882a593Smuzhiyun 		return NULL;
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	fdt_set_size_dt_struct(fdt, offset + len);
85*4882a593Smuzhiyun 	return _fdt_offset_ptr_w(fdt, offset);
86*4882a593Smuzhiyun }
87*4882a593Smuzhiyun 
fdt_create(void * buf,int bufsize)88*4882a593Smuzhiyun int fdt_create(void *buf, int bufsize)
89*4882a593Smuzhiyun {
90*4882a593Smuzhiyun 	void *fdt = buf;
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	if (bufsize < sizeof(struct fdt_header))
93*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	memset(buf, 0, bufsize);
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 	fdt_set_magic(fdt, FDT_SW_MAGIC);
98*4882a593Smuzhiyun 	fdt_set_version(fdt, FDT_LAST_SUPPORTED_VERSION);
99*4882a593Smuzhiyun 	fdt_set_last_comp_version(fdt, FDT_FIRST_SUPPORTED_VERSION);
100*4882a593Smuzhiyun 	fdt_set_totalsize(fdt,  bufsize);
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	fdt_set_off_mem_rsvmap(fdt, FDT_ALIGN(sizeof(struct fdt_header),
103*4882a593Smuzhiyun 					      sizeof(struct fdt_reserve_entry)));
104*4882a593Smuzhiyun 	fdt_set_off_dt_struct(fdt, fdt_off_mem_rsvmap(fdt));
105*4882a593Smuzhiyun 	fdt_set_off_dt_strings(fdt, bufsize);
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	return 0;
108*4882a593Smuzhiyun }
109*4882a593Smuzhiyun 
fdt_resize(void * fdt,void * buf,int bufsize)110*4882a593Smuzhiyun int fdt_resize(void *fdt, void *buf, int bufsize)
111*4882a593Smuzhiyun {
112*4882a593Smuzhiyun 	size_t headsize, tailsize;
113*4882a593Smuzhiyun 	char *oldtail, *newtail;
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	FDT_SW_CHECK_HEADER(fdt);
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun 	headsize = fdt_off_dt_struct(fdt);
118*4882a593Smuzhiyun 	tailsize = fdt_size_dt_strings(fdt);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	if ((headsize + tailsize) > bufsize)
121*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	oldtail = (char *)fdt + fdt_totalsize(fdt) - tailsize;
124*4882a593Smuzhiyun 	newtail = (char *)buf + bufsize - tailsize;
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 	/* Two cases to avoid clobbering data if the old and new
127*4882a593Smuzhiyun 	 * buffers partially overlap */
128*4882a593Smuzhiyun 	if (buf <= fdt) {
129*4882a593Smuzhiyun 		memmove(buf, fdt, headsize);
130*4882a593Smuzhiyun 		memmove(newtail, oldtail, tailsize);
131*4882a593Smuzhiyun 	} else {
132*4882a593Smuzhiyun 		memmove(newtail, oldtail, tailsize);
133*4882a593Smuzhiyun 		memmove(buf, fdt, headsize);
134*4882a593Smuzhiyun 	}
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 	fdt_set_off_dt_strings(buf, bufsize);
137*4882a593Smuzhiyun 	fdt_set_totalsize(buf, bufsize);
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun 	return 0;
140*4882a593Smuzhiyun }
141*4882a593Smuzhiyun 
fdt_add_reservemap_entry(void * fdt,uint64_t addr,uint64_t size)142*4882a593Smuzhiyun int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size)
143*4882a593Smuzhiyun {
144*4882a593Smuzhiyun 	struct fdt_reserve_entry *re;
145*4882a593Smuzhiyun 	int offset;
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	FDT_SW_CHECK_HEADER(fdt);
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 	if (fdt_size_dt_struct(fdt))
150*4882a593Smuzhiyun 		return -FDT_ERR_BADSTATE;
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	offset = fdt_off_dt_struct(fdt);
153*4882a593Smuzhiyun 	if ((offset + sizeof(*re)) > fdt_totalsize(fdt))
154*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 	re = (struct fdt_reserve_entry *)((char *)fdt + offset);
157*4882a593Smuzhiyun 	re->address = cpu_to_fdt64(addr);
158*4882a593Smuzhiyun 	re->size = cpu_to_fdt64(size);
159*4882a593Smuzhiyun 
160*4882a593Smuzhiyun 	fdt_set_off_dt_struct(fdt, offset + sizeof(*re));
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun 	return 0;
163*4882a593Smuzhiyun }
164*4882a593Smuzhiyun 
fdt_finish_reservemap(void * fdt)165*4882a593Smuzhiyun int fdt_finish_reservemap(void *fdt)
166*4882a593Smuzhiyun {
167*4882a593Smuzhiyun 	return fdt_add_reservemap_entry(fdt, 0, 0);
168*4882a593Smuzhiyun }
169*4882a593Smuzhiyun 
fdt_begin_node(void * fdt,const char * name)170*4882a593Smuzhiyun int fdt_begin_node(void *fdt, const char *name)
171*4882a593Smuzhiyun {
172*4882a593Smuzhiyun 	struct fdt_node_header *nh;
173*4882a593Smuzhiyun 	int namelen = strlen(name) + 1;
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 	FDT_SW_CHECK_HEADER(fdt);
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun 	nh = _fdt_grab_space(fdt, sizeof(*nh) + FDT_TAGALIGN(namelen));
178*4882a593Smuzhiyun 	if (! nh)
179*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun 	nh->tag = cpu_to_fdt32(FDT_BEGIN_NODE);
182*4882a593Smuzhiyun 	memcpy(nh->name, name, namelen);
183*4882a593Smuzhiyun 	return 0;
184*4882a593Smuzhiyun }
185*4882a593Smuzhiyun 
fdt_end_node(void * fdt)186*4882a593Smuzhiyun int fdt_end_node(void *fdt)
187*4882a593Smuzhiyun {
188*4882a593Smuzhiyun 	fdt32_t *en;
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun 	FDT_SW_CHECK_HEADER(fdt);
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun 	en = _fdt_grab_space(fdt, FDT_TAGSIZE);
193*4882a593Smuzhiyun 	if (! en)
194*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun 	*en = cpu_to_fdt32(FDT_END_NODE);
197*4882a593Smuzhiyun 	return 0;
198*4882a593Smuzhiyun }
199*4882a593Smuzhiyun 
_fdt_find_add_string(void * fdt,const char * s)200*4882a593Smuzhiyun static int _fdt_find_add_string(void *fdt, const char *s)
201*4882a593Smuzhiyun {
202*4882a593Smuzhiyun 	char *strtab = (char *)fdt + fdt_totalsize(fdt);
203*4882a593Smuzhiyun 	const char *p;
204*4882a593Smuzhiyun 	int strtabsize = fdt_size_dt_strings(fdt);
205*4882a593Smuzhiyun 	int len = strlen(s) + 1;
206*4882a593Smuzhiyun 	int struct_top, offset;
207*4882a593Smuzhiyun 
208*4882a593Smuzhiyun 	p = _fdt_find_string(strtab - strtabsize, strtabsize, s);
209*4882a593Smuzhiyun 	if (p)
210*4882a593Smuzhiyun 		return p - strtab;
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 	/* Add it */
213*4882a593Smuzhiyun 	offset = -strtabsize - len;
214*4882a593Smuzhiyun 	struct_top = fdt_off_dt_struct(fdt) + fdt_size_dt_struct(fdt);
215*4882a593Smuzhiyun 	if (fdt_totalsize(fdt) + offset < struct_top)
216*4882a593Smuzhiyun 		return 0; /* no more room :( */
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun 	memcpy(strtab + offset, s, len);
219*4882a593Smuzhiyun 	fdt_set_size_dt_strings(fdt, strtabsize + len);
220*4882a593Smuzhiyun 	return offset;
221*4882a593Smuzhiyun }
222*4882a593Smuzhiyun 
fdt_property_placeholder(void * fdt,const char * name,int len,void ** valp)223*4882a593Smuzhiyun int fdt_property_placeholder(void *fdt, const char *name, int len, void **valp)
224*4882a593Smuzhiyun {
225*4882a593Smuzhiyun 	struct fdt_property *prop;
226*4882a593Smuzhiyun 	int nameoff;
227*4882a593Smuzhiyun 
228*4882a593Smuzhiyun 	FDT_SW_CHECK_HEADER(fdt);
229*4882a593Smuzhiyun 
230*4882a593Smuzhiyun 	nameoff = _fdt_find_add_string(fdt, name);
231*4882a593Smuzhiyun 	if (nameoff == 0)
232*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun 	prop = _fdt_grab_space(fdt, sizeof(*prop) + FDT_TAGALIGN(len));
235*4882a593Smuzhiyun 	if (! prop)
236*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun 	prop->tag = cpu_to_fdt32(FDT_PROP);
239*4882a593Smuzhiyun 	prop->nameoff = cpu_to_fdt32(nameoff);
240*4882a593Smuzhiyun 	prop->len = cpu_to_fdt32(len);
241*4882a593Smuzhiyun 	*valp = prop->data;
242*4882a593Smuzhiyun 	return 0;
243*4882a593Smuzhiyun }
244*4882a593Smuzhiyun 
fdt_property(void * fdt,const char * name,const void * val,int len)245*4882a593Smuzhiyun int fdt_property(void *fdt, const char *name, const void *val, int len)
246*4882a593Smuzhiyun {
247*4882a593Smuzhiyun 	void *ptr;
248*4882a593Smuzhiyun 	int ret;
249*4882a593Smuzhiyun 
250*4882a593Smuzhiyun 	ret = fdt_property_placeholder(fdt, name, len, &ptr);
251*4882a593Smuzhiyun 	if (ret)
252*4882a593Smuzhiyun 		return ret;
253*4882a593Smuzhiyun 	memcpy(ptr, val, len);
254*4882a593Smuzhiyun 	return 0;
255*4882a593Smuzhiyun }
256*4882a593Smuzhiyun 
fdt_finish(void * fdt)257*4882a593Smuzhiyun int fdt_finish(void *fdt)
258*4882a593Smuzhiyun {
259*4882a593Smuzhiyun 	char *p = (char *)fdt;
260*4882a593Smuzhiyun 	fdt32_t *end;
261*4882a593Smuzhiyun 	int oldstroffset, newstroffset;
262*4882a593Smuzhiyun 	uint32_t tag;
263*4882a593Smuzhiyun 	int offset, nextoffset;
264*4882a593Smuzhiyun 
265*4882a593Smuzhiyun 	FDT_SW_CHECK_HEADER(fdt);
266*4882a593Smuzhiyun 
267*4882a593Smuzhiyun 	/* Add terminator */
268*4882a593Smuzhiyun 	end = _fdt_grab_space(fdt, sizeof(*end));
269*4882a593Smuzhiyun 	if (! end)
270*4882a593Smuzhiyun 		return -FDT_ERR_NOSPACE;
271*4882a593Smuzhiyun 	*end = cpu_to_fdt32(FDT_END);
272*4882a593Smuzhiyun 
273*4882a593Smuzhiyun 	/* Relocate the string table */
274*4882a593Smuzhiyun 	oldstroffset = fdt_totalsize(fdt) - fdt_size_dt_strings(fdt);
275*4882a593Smuzhiyun 	newstroffset = fdt_off_dt_struct(fdt) + fdt_size_dt_struct(fdt);
276*4882a593Smuzhiyun 	memmove(p + newstroffset, p + oldstroffset, fdt_size_dt_strings(fdt));
277*4882a593Smuzhiyun 	fdt_set_off_dt_strings(fdt, newstroffset);
278*4882a593Smuzhiyun 
279*4882a593Smuzhiyun 	/* Walk the structure, correcting string offsets */
280*4882a593Smuzhiyun 	offset = 0;
281*4882a593Smuzhiyun 	while ((tag = fdt_next_tag(fdt, offset, &nextoffset)) != FDT_END) {
282*4882a593Smuzhiyun 		if (tag == FDT_PROP) {
283*4882a593Smuzhiyun 			struct fdt_property *prop =
284*4882a593Smuzhiyun 				_fdt_offset_ptr_w(fdt, offset);
285*4882a593Smuzhiyun 			int nameoff;
286*4882a593Smuzhiyun 
287*4882a593Smuzhiyun 			nameoff = fdt32_to_cpu(prop->nameoff);
288*4882a593Smuzhiyun 			nameoff += fdt_size_dt_strings(fdt);
289*4882a593Smuzhiyun 			prop->nameoff = cpu_to_fdt32(nameoff);
290*4882a593Smuzhiyun 		}
291*4882a593Smuzhiyun 		offset = nextoffset;
292*4882a593Smuzhiyun 	}
293*4882a593Smuzhiyun 	if (nextoffset < 0)
294*4882a593Smuzhiyun 		return nextoffset;
295*4882a593Smuzhiyun 
296*4882a593Smuzhiyun 	/* Finally, adjust the header */
297*4882a593Smuzhiyun 	fdt_set_totalsize(fdt, newstroffset + fdt_size_dt_strings(fdt));
298*4882a593Smuzhiyun 	fdt_set_magic(fdt, FDT_MAGIC);
299*4882a593Smuzhiyun 	return 0;
300*4882a593Smuzhiyun }
301