xref: /kvm-unit-tests/lib/libfdt/fdt_overlay.c (revision f2cd179cf9d00c00da2ef2604ed1fd8ebc303bb4)
1553125dfSNikos Nikoleris // SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)
2553125dfSNikos Nikoleris /*
3553125dfSNikos Nikoleris  * libfdt - Flat Device Tree manipulation
4553125dfSNikos Nikoleris  * Copyright (C) 2016 Free Electrons
5553125dfSNikos Nikoleris  * Copyright (C) 2016 NextThing Co.
6553125dfSNikos Nikoleris  */
7553125dfSNikos Nikoleris #include "libfdt_env.h"
8553125dfSNikos Nikoleris 
9553125dfSNikos Nikoleris #include <fdt.h>
10553125dfSNikos Nikoleris #include <libfdt.h>
11553125dfSNikos Nikoleris 
12553125dfSNikos Nikoleris #include "libfdt_internal.h"
13553125dfSNikos Nikoleris 
14553125dfSNikos Nikoleris /**
15553125dfSNikos Nikoleris  * overlay_get_target_phandle - retrieves the target phandle of a fragment
16553125dfSNikos Nikoleris  * @fdto: pointer to the device tree overlay blob
17553125dfSNikos Nikoleris  * @fragment: node offset of the fragment in the overlay
18553125dfSNikos Nikoleris  *
19553125dfSNikos Nikoleris  * overlay_get_target_phandle() retrieves the target phandle of an
20553125dfSNikos Nikoleris  * overlay fragment when that fragment uses a phandle (target
21553125dfSNikos Nikoleris  * property) instead of a path (target-path property).
22553125dfSNikos Nikoleris  *
23553125dfSNikos Nikoleris  * returns:
24553125dfSNikos Nikoleris  *      the phandle pointed by the target property
25553125dfSNikos Nikoleris  *      0, if the phandle was not found
26553125dfSNikos Nikoleris  *	-1, if the phandle was malformed
27553125dfSNikos Nikoleris  */
overlay_get_target_phandle(const void * fdto,int fragment)28553125dfSNikos Nikoleris static uint32_t overlay_get_target_phandle(const void *fdto, int fragment)
29553125dfSNikos Nikoleris {
30553125dfSNikos Nikoleris 	const fdt32_t *val;
31553125dfSNikos Nikoleris 	int len;
32553125dfSNikos Nikoleris 
33553125dfSNikos Nikoleris 	val = fdt_getprop(fdto, fragment, "target", &len);
34553125dfSNikos Nikoleris 	if (!val)
35553125dfSNikos Nikoleris 		return 0;
36553125dfSNikos Nikoleris 
37553125dfSNikos Nikoleris 	if ((len != sizeof(*val)) || (fdt32_to_cpu(*val) == (uint32_t)-1))
38553125dfSNikos Nikoleris 		return (uint32_t)-1;
39553125dfSNikos Nikoleris 
40553125dfSNikos Nikoleris 	return fdt32_to_cpu(*val);
41553125dfSNikos Nikoleris }
42553125dfSNikos Nikoleris 
43553125dfSNikos Nikoleris /**
44553125dfSNikos Nikoleris  * overlay_get_target - retrieves the offset of a fragment's target
45553125dfSNikos Nikoleris  * @fdt: Base device tree blob
46553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
47553125dfSNikos Nikoleris  * @fragment: node offset of the fragment in the overlay
48553125dfSNikos Nikoleris  * @pathp: pointer which receives the path of the target (or NULL)
49553125dfSNikos Nikoleris  *
50553125dfSNikos Nikoleris  * overlay_get_target() retrieves the target offset in the base
51553125dfSNikos Nikoleris  * device tree of a fragment, no matter how the actual targeting is
52553125dfSNikos Nikoleris  * done (through a phandle or a path)
53553125dfSNikos Nikoleris  *
54553125dfSNikos Nikoleris  * returns:
55553125dfSNikos Nikoleris  *      the targeted node offset in the base device tree
56553125dfSNikos Nikoleris  *      Negative error code on error
57553125dfSNikos Nikoleris  */
overlay_get_target(const void * fdt,const void * fdto,int fragment,char const ** pathp)58553125dfSNikos Nikoleris static int overlay_get_target(const void *fdt, const void *fdto,
59553125dfSNikos Nikoleris 			      int fragment, char const **pathp)
60553125dfSNikos Nikoleris {
61553125dfSNikos Nikoleris 	uint32_t phandle;
62553125dfSNikos Nikoleris 	const char *path = NULL;
63553125dfSNikos Nikoleris 	int path_len = 0, ret;
64553125dfSNikos Nikoleris 
65553125dfSNikos Nikoleris 	/* Try first to do a phandle based lookup */
66553125dfSNikos Nikoleris 	phandle = overlay_get_target_phandle(fdto, fragment);
67553125dfSNikos Nikoleris 	if (phandle == (uint32_t)-1)
68553125dfSNikos Nikoleris 		return -FDT_ERR_BADPHANDLE;
69553125dfSNikos Nikoleris 
70553125dfSNikos Nikoleris 	/* no phandle, try path */
71553125dfSNikos Nikoleris 	if (!phandle) {
72553125dfSNikos Nikoleris 		/* And then a path based lookup */
73553125dfSNikos Nikoleris 		path = fdt_getprop(fdto, fragment, "target-path", &path_len);
74553125dfSNikos Nikoleris 		if (path)
75553125dfSNikos Nikoleris 			ret = fdt_path_offset(fdt, path);
76553125dfSNikos Nikoleris 		else
77553125dfSNikos Nikoleris 			ret = path_len;
78553125dfSNikos Nikoleris 	} else
79553125dfSNikos Nikoleris 		ret = fdt_node_offset_by_phandle(fdt, phandle);
80553125dfSNikos Nikoleris 
81553125dfSNikos Nikoleris 	/*
82553125dfSNikos Nikoleris 	* If we haven't found either a target or a
83553125dfSNikos Nikoleris 	* target-path property in a node that contains a
84553125dfSNikos Nikoleris 	* __overlay__ subnode (we wouldn't be called
85553125dfSNikos Nikoleris 	* otherwise), consider it a improperly written
86553125dfSNikos Nikoleris 	* overlay
87553125dfSNikos Nikoleris 	*/
88553125dfSNikos Nikoleris 	if (ret < 0 && path_len == -FDT_ERR_NOTFOUND)
89553125dfSNikos Nikoleris 		ret = -FDT_ERR_BADOVERLAY;
90553125dfSNikos Nikoleris 
91553125dfSNikos Nikoleris 	/* return on error */
92553125dfSNikos Nikoleris 	if (ret < 0)
93553125dfSNikos Nikoleris 		return ret;
94553125dfSNikos Nikoleris 
95553125dfSNikos Nikoleris 	/* return pointer to path (if available) */
96553125dfSNikos Nikoleris 	if (pathp)
97553125dfSNikos Nikoleris 		*pathp = path ? path : NULL;
98553125dfSNikos Nikoleris 
99553125dfSNikos Nikoleris 	return ret;
100553125dfSNikos Nikoleris }
101553125dfSNikos Nikoleris 
102553125dfSNikos Nikoleris /**
103553125dfSNikos Nikoleris  * overlay_phandle_add_offset - Increases a phandle by an offset
104553125dfSNikos Nikoleris  * @fdt: Base device tree blob
105553125dfSNikos Nikoleris  * @node: Device tree overlay blob
106553125dfSNikos Nikoleris  * @name: Name of the property to modify (phandle or linux,phandle)
107553125dfSNikos Nikoleris  * @delta: offset to apply
108553125dfSNikos Nikoleris  *
109553125dfSNikos Nikoleris  * overlay_phandle_add_offset() increments a node phandle by a given
110553125dfSNikos Nikoleris  * offset.
111553125dfSNikos Nikoleris  *
112553125dfSNikos Nikoleris  * returns:
113553125dfSNikos Nikoleris  *      0 on success.
114553125dfSNikos Nikoleris  *      Negative error code on error
115553125dfSNikos Nikoleris  */
overlay_phandle_add_offset(void * fdt,int node,const char * name,uint32_t delta)116553125dfSNikos Nikoleris static int overlay_phandle_add_offset(void *fdt, int node,
117553125dfSNikos Nikoleris 				      const char *name, uint32_t delta)
118553125dfSNikos Nikoleris {
119553125dfSNikos Nikoleris 	const fdt32_t *val;
120553125dfSNikos Nikoleris 	uint32_t adj_val;
121553125dfSNikos Nikoleris 	int len;
122553125dfSNikos Nikoleris 
123553125dfSNikos Nikoleris 	val = fdt_getprop(fdt, node, name, &len);
124553125dfSNikos Nikoleris 	if (!val)
125553125dfSNikos Nikoleris 		return len;
126553125dfSNikos Nikoleris 
127553125dfSNikos Nikoleris 	if (len != sizeof(*val))
128553125dfSNikos Nikoleris 		return -FDT_ERR_BADPHANDLE;
129553125dfSNikos Nikoleris 
130553125dfSNikos Nikoleris 	adj_val = fdt32_to_cpu(*val);
131553125dfSNikos Nikoleris 	if ((adj_val + delta) < adj_val)
132553125dfSNikos Nikoleris 		return -FDT_ERR_NOPHANDLES;
133553125dfSNikos Nikoleris 
134553125dfSNikos Nikoleris 	adj_val += delta;
135553125dfSNikos Nikoleris 	if (adj_val == (uint32_t)-1)
136553125dfSNikos Nikoleris 		return -FDT_ERR_NOPHANDLES;
137553125dfSNikos Nikoleris 
138553125dfSNikos Nikoleris 	return fdt_setprop_inplace_u32(fdt, node, name, adj_val);
139553125dfSNikos Nikoleris }
140553125dfSNikos Nikoleris 
141553125dfSNikos Nikoleris /**
142553125dfSNikos Nikoleris  * overlay_adjust_node_phandles - Offsets the phandles of a node
143553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
144553125dfSNikos Nikoleris  * @node: Offset of the node we want to adjust
145553125dfSNikos Nikoleris  * @delta: Offset to shift the phandles of
146553125dfSNikos Nikoleris  *
147553125dfSNikos Nikoleris  * overlay_adjust_node_phandles() adds a constant to all the phandles
148553125dfSNikos Nikoleris  * of a given node. This is mainly use as part of the overlay
149553125dfSNikos Nikoleris  * application process, when we want to update all the overlay
150553125dfSNikos Nikoleris  * phandles to not conflict with the overlays of the base device tree.
151553125dfSNikos Nikoleris  *
152553125dfSNikos Nikoleris  * returns:
153553125dfSNikos Nikoleris  *      0 on success
154553125dfSNikos Nikoleris  *      Negative error code on failure
155553125dfSNikos Nikoleris  */
overlay_adjust_node_phandles(void * fdto,int node,uint32_t delta)156553125dfSNikos Nikoleris static int overlay_adjust_node_phandles(void *fdto, int node,
157553125dfSNikos Nikoleris 					uint32_t delta)
158553125dfSNikos Nikoleris {
159553125dfSNikos Nikoleris 	int child;
160553125dfSNikos Nikoleris 	int ret;
161553125dfSNikos Nikoleris 
162553125dfSNikos Nikoleris 	ret = overlay_phandle_add_offset(fdto, node, "phandle", delta);
163553125dfSNikos Nikoleris 	if (ret && ret != -FDT_ERR_NOTFOUND)
164553125dfSNikos Nikoleris 		return ret;
165553125dfSNikos Nikoleris 
166553125dfSNikos Nikoleris 	ret = overlay_phandle_add_offset(fdto, node, "linux,phandle", delta);
167553125dfSNikos Nikoleris 	if (ret && ret != -FDT_ERR_NOTFOUND)
168553125dfSNikos Nikoleris 		return ret;
169553125dfSNikos Nikoleris 
170553125dfSNikos Nikoleris 	fdt_for_each_subnode(child, fdto, node) {
171553125dfSNikos Nikoleris 		ret = overlay_adjust_node_phandles(fdto, child, delta);
172553125dfSNikos Nikoleris 		if (ret)
173553125dfSNikos Nikoleris 			return ret;
174553125dfSNikos Nikoleris 	}
175553125dfSNikos Nikoleris 
176553125dfSNikos Nikoleris 	return 0;
177553125dfSNikos Nikoleris }
178553125dfSNikos Nikoleris 
179553125dfSNikos Nikoleris /**
180553125dfSNikos Nikoleris  * overlay_adjust_local_phandles - Adjust the phandles of a whole overlay
181553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
182553125dfSNikos Nikoleris  * @delta: Offset to shift the phandles of
183553125dfSNikos Nikoleris  *
184553125dfSNikos Nikoleris  * overlay_adjust_local_phandles() adds a constant to all the
185553125dfSNikos Nikoleris  * phandles of an overlay. This is mainly use as part of the overlay
186553125dfSNikos Nikoleris  * application process, when we want to update all the overlay
187553125dfSNikos Nikoleris  * phandles to not conflict with the overlays of the base device tree.
188553125dfSNikos Nikoleris  *
189553125dfSNikos Nikoleris  * returns:
190553125dfSNikos Nikoleris  *      0 on success
191553125dfSNikos Nikoleris  *      Negative error code on failure
192553125dfSNikos Nikoleris  */
overlay_adjust_local_phandles(void * fdto,uint32_t delta)193553125dfSNikos Nikoleris static int overlay_adjust_local_phandles(void *fdto, uint32_t delta)
194553125dfSNikos Nikoleris {
195553125dfSNikos Nikoleris 	/*
196553125dfSNikos Nikoleris 	 * Start adjusting the phandles from the overlay root
197553125dfSNikos Nikoleris 	 */
198553125dfSNikos Nikoleris 	return overlay_adjust_node_phandles(fdto, 0, delta);
199553125dfSNikos Nikoleris }
200553125dfSNikos Nikoleris 
201553125dfSNikos Nikoleris /**
202553125dfSNikos Nikoleris  * overlay_update_local_node_references - Adjust the overlay references
203553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
204553125dfSNikos Nikoleris  * @tree_node: Node offset of the node to operate on
205553125dfSNikos Nikoleris  * @fixup_node: Node offset of the matching local fixups node
206553125dfSNikos Nikoleris  * @delta: Offset to shift the phandles of
207553125dfSNikos Nikoleris  *
208553125dfSNikos Nikoleris  * overlay_update_local_nodes_references() update the phandles
209553125dfSNikos Nikoleris  * pointing to a node within the device tree overlay by adding a
210553125dfSNikos Nikoleris  * constant delta.
211553125dfSNikos Nikoleris  *
212553125dfSNikos Nikoleris  * This is mainly used as part of a device tree application process,
213553125dfSNikos Nikoleris  * where you want the device tree overlays phandles to not conflict
214553125dfSNikos Nikoleris  * with the ones from the base device tree before merging them.
215553125dfSNikos Nikoleris  *
216553125dfSNikos Nikoleris  * returns:
217553125dfSNikos Nikoleris  *      0 on success
218553125dfSNikos Nikoleris  *      Negative error code on failure
219553125dfSNikos Nikoleris  */
overlay_update_local_node_references(void * fdto,int tree_node,int fixup_node,uint32_t delta)220553125dfSNikos Nikoleris static int overlay_update_local_node_references(void *fdto,
221553125dfSNikos Nikoleris 						int tree_node,
222553125dfSNikos Nikoleris 						int fixup_node,
223553125dfSNikos Nikoleris 						uint32_t delta)
224553125dfSNikos Nikoleris {
225553125dfSNikos Nikoleris 	int fixup_prop;
226553125dfSNikos Nikoleris 	int fixup_child;
227553125dfSNikos Nikoleris 	int ret;
228553125dfSNikos Nikoleris 
229553125dfSNikos Nikoleris 	fdt_for_each_property_offset(fixup_prop, fdto, fixup_node) {
230553125dfSNikos Nikoleris 		const fdt32_t *fixup_val;
231553125dfSNikos Nikoleris 		const char *tree_val;
232553125dfSNikos Nikoleris 		const char *name;
233553125dfSNikos Nikoleris 		int fixup_len;
234553125dfSNikos Nikoleris 		int tree_len;
235553125dfSNikos Nikoleris 		int i;
236553125dfSNikos Nikoleris 
237553125dfSNikos Nikoleris 		fixup_val = fdt_getprop_by_offset(fdto, fixup_prop,
238553125dfSNikos Nikoleris 						  &name, &fixup_len);
239553125dfSNikos Nikoleris 		if (!fixup_val)
240553125dfSNikos Nikoleris 			return fixup_len;
241553125dfSNikos Nikoleris 
242553125dfSNikos Nikoleris 		if (fixup_len % sizeof(uint32_t))
243553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
244*80a6d74fSAndrew Jones 		fixup_len /= sizeof(uint32_t);
245553125dfSNikos Nikoleris 
246553125dfSNikos Nikoleris 		tree_val = fdt_getprop(fdto, tree_node, name, &tree_len);
247553125dfSNikos Nikoleris 		if (!tree_val) {
248553125dfSNikos Nikoleris 			if (tree_len == -FDT_ERR_NOTFOUND)
249553125dfSNikos Nikoleris 				return -FDT_ERR_BADOVERLAY;
250553125dfSNikos Nikoleris 
251553125dfSNikos Nikoleris 			return tree_len;
252553125dfSNikos Nikoleris 		}
253553125dfSNikos Nikoleris 
254*80a6d74fSAndrew Jones 		for (i = 0; i < fixup_len; i++) {
255553125dfSNikos Nikoleris 			fdt32_t adj_val;
256553125dfSNikos Nikoleris 			uint32_t poffset;
257553125dfSNikos Nikoleris 
258553125dfSNikos Nikoleris 			poffset = fdt32_to_cpu(fixup_val[i]);
259553125dfSNikos Nikoleris 
260553125dfSNikos Nikoleris 			/*
261553125dfSNikos Nikoleris 			 * phandles to fixup can be unaligned.
262553125dfSNikos Nikoleris 			 *
263553125dfSNikos Nikoleris 			 * Use a memcpy for the architectures that do
264553125dfSNikos Nikoleris 			 * not support unaligned accesses.
265553125dfSNikos Nikoleris 			 */
266553125dfSNikos Nikoleris 			memcpy(&adj_val, tree_val + poffset, sizeof(adj_val));
267553125dfSNikos Nikoleris 
268553125dfSNikos Nikoleris 			adj_val = cpu_to_fdt32(fdt32_to_cpu(adj_val) + delta);
269553125dfSNikos Nikoleris 
270553125dfSNikos Nikoleris 			ret = fdt_setprop_inplace_namelen_partial(fdto,
271553125dfSNikos Nikoleris 								  tree_node,
272553125dfSNikos Nikoleris 								  name,
273553125dfSNikos Nikoleris 								  strlen(name),
274553125dfSNikos Nikoleris 								  poffset,
275553125dfSNikos Nikoleris 								  &adj_val,
276553125dfSNikos Nikoleris 								  sizeof(adj_val));
277553125dfSNikos Nikoleris 			if (ret == -FDT_ERR_NOSPACE)
278553125dfSNikos Nikoleris 				return -FDT_ERR_BADOVERLAY;
279553125dfSNikos Nikoleris 
280553125dfSNikos Nikoleris 			if (ret)
281553125dfSNikos Nikoleris 				return ret;
282553125dfSNikos Nikoleris 		}
283553125dfSNikos Nikoleris 	}
284553125dfSNikos Nikoleris 
285553125dfSNikos Nikoleris 	fdt_for_each_subnode(fixup_child, fdto, fixup_node) {
286553125dfSNikos Nikoleris 		const char *fixup_child_name = fdt_get_name(fdto, fixup_child,
287553125dfSNikos Nikoleris 							    NULL);
288553125dfSNikos Nikoleris 		int tree_child;
289553125dfSNikos Nikoleris 
290553125dfSNikos Nikoleris 		tree_child = fdt_subnode_offset(fdto, tree_node,
291553125dfSNikos Nikoleris 						fixup_child_name);
292553125dfSNikos Nikoleris 		if (tree_child == -FDT_ERR_NOTFOUND)
293553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
294553125dfSNikos Nikoleris 		if (tree_child < 0)
295553125dfSNikos Nikoleris 			return tree_child;
296553125dfSNikos Nikoleris 
297553125dfSNikos Nikoleris 		ret = overlay_update_local_node_references(fdto,
298553125dfSNikos Nikoleris 							   tree_child,
299553125dfSNikos Nikoleris 							   fixup_child,
300553125dfSNikos Nikoleris 							   delta);
301553125dfSNikos Nikoleris 		if (ret)
302553125dfSNikos Nikoleris 			return ret;
303553125dfSNikos Nikoleris 	}
304553125dfSNikos Nikoleris 
305553125dfSNikos Nikoleris 	return 0;
306553125dfSNikos Nikoleris }
307553125dfSNikos Nikoleris 
308553125dfSNikos Nikoleris /**
309553125dfSNikos Nikoleris  * overlay_update_local_references - Adjust the overlay references
310553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
311553125dfSNikos Nikoleris  * @delta: Offset to shift the phandles of
312553125dfSNikos Nikoleris  *
313553125dfSNikos Nikoleris  * overlay_update_local_references() update all the phandles pointing
314553125dfSNikos Nikoleris  * to a node within the device tree overlay by adding a constant
315553125dfSNikos Nikoleris  * delta to not conflict with the base overlay.
316553125dfSNikos Nikoleris  *
317553125dfSNikos Nikoleris  * This is mainly used as part of a device tree application process,
318553125dfSNikos Nikoleris  * where you want the device tree overlays phandles to not conflict
319553125dfSNikos Nikoleris  * with the ones from the base device tree before merging them.
320553125dfSNikos Nikoleris  *
321553125dfSNikos Nikoleris  * returns:
322553125dfSNikos Nikoleris  *      0 on success
323553125dfSNikos Nikoleris  *      Negative error code on failure
324553125dfSNikos Nikoleris  */
overlay_update_local_references(void * fdto,uint32_t delta)325553125dfSNikos Nikoleris static int overlay_update_local_references(void *fdto, uint32_t delta)
326553125dfSNikos Nikoleris {
327553125dfSNikos Nikoleris 	int fixups;
328553125dfSNikos Nikoleris 
329553125dfSNikos Nikoleris 	fixups = fdt_path_offset(fdto, "/__local_fixups__");
330553125dfSNikos Nikoleris 	if (fixups < 0) {
331553125dfSNikos Nikoleris 		/* There's no local phandles to adjust, bail out */
332553125dfSNikos Nikoleris 		if (fixups == -FDT_ERR_NOTFOUND)
333553125dfSNikos Nikoleris 			return 0;
334553125dfSNikos Nikoleris 
335553125dfSNikos Nikoleris 		return fixups;
336553125dfSNikos Nikoleris 	}
337553125dfSNikos Nikoleris 
338553125dfSNikos Nikoleris 	/*
339553125dfSNikos Nikoleris 	 * Update our local references from the root of the tree
340553125dfSNikos Nikoleris 	 */
341553125dfSNikos Nikoleris 	return overlay_update_local_node_references(fdto, 0, fixups,
342553125dfSNikos Nikoleris 						    delta);
343553125dfSNikos Nikoleris }
344553125dfSNikos Nikoleris 
345553125dfSNikos Nikoleris /**
346553125dfSNikos Nikoleris  * overlay_fixup_one_phandle - Set an overlay phandle to the base one
347553125dfSNikos Nikoleris  * @fdt: Base Device Tree blob
348553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
349553125dfSNikos Nikoleris  * @symbols_off: Node offset of the symbols node in the base device tree
350553125dfSNikos Nikoleris  * @path: Path to a node holding a phandle in the overlay
351553125dfSNikos Nikoleris  * @path_len: number of path characters to consider
352553125dfSNikos Nikoleris  * @name: Name of the property holding the phandle reference in the overlay
353553125dfSNikos Nikoleris  * @name_len: number of name characters to consider
354553125dfSNikos Nikoleris  * @poffset: Offset within the overlay property where the phandle is stored
355553125dfSNikos Nikoleris  * @label: Label of the node referenced by the phandle
356553125dfSNikos Nikoleris  *
357553125dfSNikos Nikoleris  * overlay_fixup_one_phandle() resolves an overlay phandle pointing to
358553125dfSNikos Nikoleris  * a node in the base device tree.
359553125dfSNikos Nikoleris  *
360553125dfSNikos Nikoleris  * This is part of the device tree overlay application process, when
361553125dfSNikos Nikoleris  * you want all the phandles in the overlay to point to the actual
362553125dfSNikos Nikoleris  * base dt nodes.
363553125dfSNikos Nikoleris  *
364553125dfSNikos Nikoleris  * returns:
365553125dfSNikos Nikoleris  *      0 on success
366553125dfSNikos Nikoleris  *      Negative error code on failure
367553125dfSNikos Nikoleris  */
overlay_fixup_one_phandle(void * fdt,void * fdto,int symbols_off,const char * path,uint32_t path_len,const char * name,uint32_t name_len,int poffset,const char * label)368553125dfSNikos Nikoleris static int overlay_fixup_one_phandle(void *fdt, void *fdto,
369553125dfSNikos Nikoleris 				     int symbols_off,
370553125dfSNikos Nikoleris 				     const char *path, uint32_t path_len,
371553125dfSNikos Nikoleris 				     const char *name, uint32_t name_len,
372553125dfSNikos Nikoleris 				     int poffset, const char *label)
373553125dfSNikos Nikoleris {
374553125dfSNikos Nikoleris 	const char *symbol_path;
375553125dfSNikos Nikoleris 	uint32_t phandle;
376553125dfSNikos Nikoleris 	fdt32_t phandle_prop;
377553125dfSNikos Nikoleris 	int symbol_off, fixup_off;
378553125dfSNikos Nikoleris 	int prop_len;
379553125dfSNikos Nikoleris 
380553125dfSNikos Nikoleris 	if (symbols_off < 0)
381553125dfSNikos Nikoleris 		return symbols_off;
382553125dfSNikos Nikoleris 
383553125dfSNikos Nikoleris 	symbol_path = fdt_getprop(fdt, symbols_off, label,
384553125dfSNikos Nikoleris 				  &prop_len);
385553125dfSNikos Nikoleris 	if (!symbol_path)
386553125dfSNikos Nikoleris 		return prop_len;
387553125dfSNikos Nikoleris 
388553125dfSNikos Nikoleris 	symbol_off = fdt_path_offset(fdt, symbol_path);
389553125dfSNikos Nikoleris 	if (symbol_off < 0)
390553125dfSNikos Nikoleris 		return symbol_off;
391553125dfSNikos Nikoleris 
392553125dfSNikos Nikoleris 	phandle = fdt_get_phandle(fdt, symbol_off);
393553125dfSNikos Nikoleris 	if (!phandle)
394553125dfSNikos Nikoleris 		return -FDT_ERR_NOTFOUND;
395553125dfSNikos Nikoleris 
396553125dfSNikos Nikoleris 	fixup_off = fdt_path_offset_namelen(fdto, path, path_len);
397553125dfSNikos Nikoleris 	if (fixup_off == -FDT_ERR_NOTFOUND)
398553125dfSNikos Nikoleris 		return -FDT_ERR_BADOVERLAY;
399553125dfSNikos Nikoleris 	if (fixup_off < 0)
400553125dfSNikos Nikoleris 		return fixup_off;
401553125dfSNikos Nikoleris 
402553125dfSNikos Nikoleris 	phandle_prop = cpu_to_fdt32(phandle);
403553125dfSNikos Nikoleris 	return fdt_setprop_inplace_namelen_partial(fdto, fixup_off,
404553125dfSNikos Nikoleris 						   name, name_len, poffset,
405553125dfSNikos Nikoleris 						   &phandle_prop,
406553125dfSNikos Nikoleris 						   sizeof(phandle_prop));
407553125dfSNikos Nikoleris };
408553125dfSNikos Nikoleris 
409553125dfSNikos Nikoleris /**
410553125dfSNikos Nikoleris  * overlay_fixup_phandle - Set an overlay phandle to the base one
411553125dfSNikos Nikoleris  * @fdt: Base Device Tree blob
412553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
413553125dfSNikos Nikoleris  * @symbols_off: Node offset of the symbols node in the base device tree
414553125dfSNikos Nikoleris  * @property: Property offset in the overlay holding the list of fixups
415553125dfSNikos Nikoleris  *
416553125dfSNikos Nikoleris  * overlay_fixup_phandle() resolves all the overlay phandles pointed
417553125dfSNikos Nikoleris  * to in a __fixups__ property, and updates them to match the phandles
418553125dfSNikos Nikoleris  * in use in the base device tree.
419553125dfSNikos Nikoleris  *
420553125dfSNikos Nikoleris  * This is part of the device tree overlay application process, when
421553125dfSNikos Nikoleris  * you want all the phandles in the overlay to point to the actual
422553125dfSNikos Nikoleris  * base dt nodes.
423553125dfSNikos Nikoleris  *
424553125dfSNikos Nikoleris  * returns:
425553125dfSNikos Nikoleris  *      0 on success
426553125dfSNikos Nikoleris  *      Negative error code on failure
427553125dfSNikos Nikoleris  */
overlay_fixup_phandle(void * fdt,void * fdto,int symbols_off,int property)428553125dfSNikos Nikoleris static int overlay_fixup_phandle(void *fdt, void *fdto, int symbols_off,
429553125dfSNikos Nikoleris 				 int property)
430553125dfSNikos Nikoleris {
431553125dfSNikos Nikoleris 	const char *value;
432553125dfSNikos Nikoleris 	const char *label;
433553125dfSNikos Nikoleris 	int len;
434553125dfSNikos Nikoleris 
435553125dfSNikos Nikoleris 	value = fdt_getprop_by_offset(fdto, property,
436553125dfSNikos Nikoleris 				      &label, &len);
437553125dfSNikos Nikoleris 	if (!value) {
438553125dfSNikos Nikoleris 		if (len == -FDT_ERR_NOTFOUND)
439553125dfSNikos Nikoleris 			return -FDT_ERR_INTERNAL;
440553125dfSNikos Nikoleris 
441553125dfSNikos Nikoleris 		return len;
442553125dfSNikos Nikoleris 	}
443553125dfSNikos Nikoleris 
444553125dfSNikos Nikoleris 	do {
445553125dfSNikos Nikoleris 		const char *path, *name, *fixup_end;
446553125dfSNikos Nikoleris 		const char *fixup_str = value;
447553125dfSNikos Nikoleris 		uint32_t path_len, name_len;
448553125dfSNikos Nikoleris 		uint32_t fixup_len;
449553125dfSNikos Nikoleris 		char *sep, *endptr;
450553125dfSNikos Nikoleris 		int poffset, ret;
451553125dfSNikos Nikoleris 
452553125dfSNikos Nikoleris 		fixup_end = memchr(value, '\0', len);
453553125dfSNikos Nikoleris 		if (!fixup_end)
454553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
455553125dfSNikos Nikoleris 		fixup_len = fixup_end - fixup_str;
456553125dfSNikos Nikoleris 
457553125dfSNikos Nikoleris 		len -= fixup_len + 1;
458553125dfSNikos Nikoleris 		value += fixup_len + 1;
459553125dfSNikos Nikoleris 
460553125dfSNikos Nikoleris 		path = fixup_str;
461553125dfSNikos Nikoleris 		sep = memchr(fixup_str, ':', fixup_len);
462553125dfSNikos Nikoleris 		if (!sep || *sep != ':')
463553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
464553125dfSNikos Nikoleris 
465553125dfSNikos Nikoleris 		path_len = sep - path;
466553125dfSNikos Nikoleris 		if (path_len == (fixup_len - 1))
467553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
468553125dfSNikos Nikoleris 
469553125dfSNikos Nikoleris 		fixup_len -= path_len + 1;
470553125dfSNikos Nikoleris 		name = sep + 1;
471553125dfSNikos Nikoleris 		sep = memchr(name, ':', fixup_len);
472553125dfSNikos Nikoleris 		if (!sep || *sep != ':')
473553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
474553125dfSNikos Nikoleris 
475553125dfSNikos Nikoleris 		name_len = sep - name;
476553125dfSNikos Nikoleris 		if (!name_len)
477553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
478553125dfSNikos Nikoleris 
479553125dfSNikos Nikoleris 		poffset = strtoul(sep + 1, &endptr, 10);
480553125dfSNikos Nikoleris 		if ((*endptr != '\0') || (endptr <= (sep + 1)))
481553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
482553125dfSNikos Nikoleris 
483553125dfSNikos Nikoleris 		ret = overlay_fixup_one_phandle(fdt, fdto, symbols_off,
484553125dfSNikos Nikoleris 						path, path_len, name, name_len,
485553125dfSNikos Nikoleris 						poffset, label);
486553125dfSNikos Nikoleris 		if (ret)
487553125dfSNikos Nikoleris 			return ret;
488553125dfSNikos Nikoleris 	} while (len > 0);
489553125dfSNikos Nikoleris 
490553125dfSNikos Nikoleris 	return 0;
491553125dfSNikos Nikoleris }
492553125dfSNikos Nikoleris 
493553125dfSNikos Nikoleris /**
494553125dfSNikos Nikoleris  * overlay_fixup_phandles - Resolve the overlay phandles to the base
495553125dfSNikos Nikoleris  *                          device tree
496553125dfSNikos Nikoleris  * @fdt: Base Device Tree blob
497553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
498553125dfSNikos Nikoleris  *
499553125dfSNikos Nikoleris  * overlay_fixup_phandles() resolves all the overlay phandles pointing
500553125dfSNikos Nikoleris  * to nodes in the base device tree.
501553125dfSNikos Nikoleris  *
502553125dfSNikos Nikoleris  * This is one of the steps of the device tree overlay application
503553125dfSNikos Nikoleris  * process, when you want all the phandles in the overlay to point to
504553125dfSNikos Nikoleris  * the actual base dt nodes.
505553125dfSNikos Nikoleris  *
506553125dfSNikos Nikoleris  * returns:
507553125dfSNikos Nikoleris  *      0 on success
508553125dfSNikos Nikoleris  *      Negative error code on failure
509553125dfSNikos Nikoleris  */
overlay_fixup_phandles(void * fdt,void * fdto)510553125dfSNikos Nikoleris static int overlay_fixup_phandles(void *fdt, void *fdto)
511553125dfSNikos Nikoleris {
512553125dfSNikos Nikoleris 	int fixups_off, symbols_off;
513553125dfSNikos Nikoleris 	int property;
514553125dfSNikos Nikoleris 
515553125dfSNikos Nikoleris 	/* We can have overlays without any fixups */
516553125dfSNikos Nikoleris 	fixups_off = fdt_path_offset(fdto, "/__fixups__");
517553125dfSNikos Nikoleris 	if (fixups_off == -FDT_ERR_NOTFOUND)
518553125dfSNikos Nikoleris 		return 0; /* nothing to do */
519553125dfSNikos Nikoleris 	if (fixups_off < 0)
520553125dfSNikos Nikoleris 		return fixups_off;
521553125dfSNikos Nikoleris 
522553125dfSNikos Nikoleris 	/* And base DTs without symbols */
523553125dfSNikos Nikoleris 	symbols_off = fdt_path_offset(fdt, "/__symbols__");
524553125dfSNikos Nikoleris 	if ((symbols_off < 0 && (symbols_off != -FDT_ERR_NOTFOUND)))
525553125dfSNikos Nikoleris 		return symbols_off;
526553125dfSNikos Nikoleris 
527553125dfSNikos Nikoleris 	fdt_for_each_property_offset(property, fdto, fixups_off) {
528553125dfSNikos Nikoleris 		int ret;
529553125dfSNikos Nikoleris 
530553125dfSNikos Nikoleris 		ret = overlay_fixup_phandle(fdt, fdto, symbols_off, property);
531553125dfSNikos Nikoleris 		if (ret)
532553125dfSNikos Nikoleris 			return ret;
533553125dfSNikos Nikoleris 	}
534553125dfSNikos Nikoleris 
535553125dfSNikos Nikoleris 	return 0;
536553125dfSNikos Nikoleris }
537553125dfSNikos Nikoleris 
538553125dfSNikos Nikoleris /**
539553125dfSNikos Nikoleris  * overlay_apply_node - Merges a node into the base device tree
540553125dfSNikos Nikoleris  * @fdt: Base Device Tree blob
541553125dfSNikos Nikoleris  * @target: Node offset in the base device tree to apply the fragment to
542553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
543553125dfSNikos Nikoleris  * @node: Node offset in the overlay holding the changes to merge
544553125dfSNikos Nikoleris  *
545553125dfSNikos Nikoleris  * overlay_apply_node() merges a node into a target base device tree
546553125dfSNikos Nikoleris  * node pointed.
547553125dfSNikos Nikoleris  *
548553125dfSNikos Nikoleris  * This is part of the final step in the device tree overlay
549553125dfSNikos Nikoleris  * application process, when all the phandles have been adjusted and
550553125dfSNikos Nikoleris  * resolved and you just have to merge overlay into the base device
551553125dfSNikos Nikoleris  * tree.
552553125dfSNikos Nikoleris  *
553553125dfSNikos Nikoleris  * returns:
554553125dfSNikos Nikoleris  *      0 on success
555553125dfSNikos Nikoleris  *      Negative error code on failure
556553125dfSNikos Nikoleris  */
overlay_apply_node(void * fdt,int target,void * fdto,int node)557553125dfSNikos Nikoleris static int overlay_apply_node(void *fdt, int target,
558553125dfSNikos Nikoleris 			      void *fdto, int node)
559553125dfSNikos Nikoleris {
560553125dfSNikos Nikoleris 	int property;
561553125dfSNikos Nikoleris 	int subnode;
562553125dfSNikos Nikoleris 
563553125dfSNikos Nikoleris 	fdt_for_each_property_offset(property, fdto, node) {
564553125dfSNikos Nikoleris 		const char *name;
565553125dfSNikos Nikoleris 		const void *prop;
566553125dfSNikos Nikoleris 		int prop_len;
567553125dfSNikos Nikoleris 		int ret;
568553125dfSNikos Nikoleris 
569553125dfSNikos Nikoleris 		prop = fdt_getprop_by_offset(fdto, property, &name,
570553125dfSNikos Nikoleris 					     &prop_len);
571553125dfSNikos Nikoleris 		if (prop_len == -FDT_ERR_NOTFOUND)
572553125dfSNikos Nikoleris 			return -FDT_ERR_INTERNAL;
573553125dfSNikos Nikoleris 		if (prop_len < 0)
574553125dfSNikos Nikoleris 			return prop_len;
575553125dfSNikos Nikoleris 
576553125dfSNikos Nikoleris 		ret = fdt_setprop(fdt, target, name, prop, prop_len);
577553125dfSNikos Nikoleris 		if (ret)
578553125dfSNikos Nikoleris 			return ret;
579553125dfSNikos Nikoleris 	}
580553125dfSNikos Nikoleris 
581553125dfSNikos Nikoleris 	fdt_for_each_subnode(subnode, fdto, node) {
582553125dfSNikos Nikoleris 		const char *name = fdt_get_name(fdto, subnode, NULL);
583553125dfSNikos Nikoleris 		int nnode;
584553125dfSNikos Nikoleris 		int ret;
585553125dfSNikos Nikoleris 
586553125dfSNikos Nikoleris 		nnode = fdt_add_subnode(fdt, target, name);
587553125dfSNikos Nikoleris 		if (nnode == -FDT_ERR_EXISTS) {
588553125dfSNikos Nikoleris 			nnode = fdt_subnode_offset(fdt, target, name);
589553125dfSNikos Nikoleris 			if (nnode == -FDT_ERR_NOTFOUND)
590553125dfSNikos Nikoleris 				return -FDT_ERR_INTERNAL;
591553125dfSNikos Nikoleris 		}
592553125dfSNikos Nikoleris 
593553125dfSNikos Nikoleris 		if (nnode < 0)
594553125dfSNikos Nikoleris 			return nnode;
595553125dfSNikos Nikoleris 
596553125dfSNikos Nikoleris 		ret = overlay_apply_node(fdt, nnode, fdto, subnode);
597553125dfSNikos Nikoleris 		if (ret)
598553125dfSNikos Nikoleris 			return ret;
599553125dfSNikos Nikoleris 	}
600553125dfSNikos Nikoleris 
601553125dfSNikos Nikoleris 	return 0;
602553125dfSNikos Nikoleris }
603553125dfSNikos Nikoleris 
604553125dfSNikos Nikoleris /**
605553125dfSNikos Nikoleris  * overlay_merge - Merge an overlay into its base device tree
606553125dfSNikos Nikoleris  * @fdt: Base Device Tree blob
607553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
608553125dfSNikos Nikoleris  *
609553125dfSNikos Nikoleris  * overlay_merge() merges an overlay into its base device tree.
610553125dfSNikos Nikoleris  *
611553125dfSNikos Nikoleris  * This is the next to last step in the device tree overlay application
612553125dfSNikos Nikoleris  * process, when all the phandles have been adjusted and resolved and
613553125dfSNikos Nikoleris  * you just have to merge overlay into the base device tree.
614553125dfSNikos Nikoleris  *
615553125dfSNikos Nikoleris  * returns:
616553125dfSNikos Nikoleris  *      0 on success
617553125dfSNikos Nikoleris  *      Negative error code on failure
618553125dfSNikos Nikoleris  */
overlay_merge(void * fdt,void * fdto)619553125dfSNikos Nikoleris static int overlay_merge(void *fdt, void *fdto)
620553125dfSNikos Nikoleris {
621553125dfSNikos Nikoleris 	int fragment;
622553125dfSNikos Nikoleris 
623553125dfSNikos Nikoleris 	fdt_for_each_subnode(fragment, fdto, 0) {
624553125dfSNikos Nikoleris 		int overlay;
625553125dfSNikos Nikoleris 		int target;
626553125dfSNikos Nikoleris 		int ret;
627553125dfSNikos Nikoleris 
628553125dfSNikos Nikoleris 		/*
629553125dfSNikos Nikoleris 		 * Each fragments will have an __overlay__ node. If
630553125dfSNikos Nikoleris 		 * they don't, it's not supposed to be merged
631553125dfSNikos Nikoleris 		 */
632553125dfSNikos Nikoleris 		overlay = fdt_subnode_offset(fdto, fragment, "__overlay__");
633553125dfSNikos Nikoleris 		if (overlay == -FDT_ERR_NOTFOUND)
634553125dfSNikos Nikoleris 			continue;
635553125dfSNikos Nikoleris 
636553125dfSNikos Nikoleris 		if (overlay < 0)
637553125dfSNikos Nikoleris 			return overlay;
638553125dfSNikos Nikoleris 
639553125dfSNikos Nikoleris 		target = overlay_get_target(fdt, fdto, fragment, NULL);
640553125dfSNikos Nikoleris 		if (target < 0)
641553125dfSNikos Nikoleris 			return target;
642553125dfSNikos Nikoleris 
643553125dfSNikos Nikoleris 		ret = overlay_apply_node(fdt, target, fdto, overlay);
644553125dfSNikos Nikoleris 		if (ret)
645553125dfSNikos Nikoleris 			return ret;
646553125dfSNikos Nikoleris 	}
647553125dfSNikos Nikoleris 
648553125dfSNikos Nikoleris 	return 0;
649553125dfSNikos Nikoleris }
650553125dfSNikos Nikoleris 
get_path_len(const void * fdt,int nodeoffset)651553125dfSNikos Nikoleris static int get_path_len(const void *fdt, int nodeoffset)
652553125dfSNikos Nikoleris {
653553125dfSNikos Nikoleris 	int len = 0, namelen;
654553125dfSNikos Nikoleris 	const char *name;
655553125dfSNikos Nikoleris 
656553125dfSNikos Nikoleris 	FDT_RO_PROBE(fdt);
657553125dfSNikos Nikoleris 
658553125dfSNikos Nikoleris 	for (;;) {
659553125dfSNikos Nikoleris 		name = fdt_get_name(fdt, nodeoffset, &namelen);
660553125dfSNikos Nikoleris 		if (!name)
661553125dfSNikos Nikoleris 			return namelen;
662553125dfSNikos Nikoleris 
663553125dfSNikos Nikoleris 		/* root? we're done */
664553125dfSNikos Nikoleris 		if (namelen == 0)
665553125dfSNikos Nikoleris 			break;
666553125dfSNikos Nikoleris 
667553125dfSNikos Nikoleris 		nodeoffset = fdt_parent_offset(fdt, nodeoffset);
668553125dfSNikos Nikoleris 		if (nodeoffset < 0)
669553125dfSNikos Nikoleris 			return nodeoffset;
670553125dfSNikos Nikoleris 		len += namelen + 1;
671553125dfSNikos Nikoleris 	}
672553125dfSNikos Nikoleris 
673553125dfSNikos Nikoleris 	/* in case of root pretend it's "/" */
674553125dfSNikos Nikoleris 	if (len == 0)
675553125dfSNikos Nikoleris 		len++;
676553125dfSNikos Nikoleris 	return len;
677553125dfSNikos Nikoleris }
678553125dfSNikos Nikoleris 
679553125dfSNikos Nikoleris /**
680553125dfSNikos Nikoleris  * overlay_symbol_update - Update the symbols of base tree after a merge
681553125dfSNikos Nikoleris  * @fdt: Base Device Tree blob
682553125dfSNikos Nikoleris  * @fdto: Device tree overlay blob
683553125dfSNikos Nikoleris  *
684553125dfSNikos Nikoleris  * overlay_symbol_update() updates the symbols of the base tree with the
685553125dfSNikos Nikoleris  * symbols of the applied overlay
686553125dfSNikos Nikoleris  *
687553125dfSNikos Nikoleris  * This is the last step in the device tree overlay application
688553125dfSNikos Nikoleris  * process, allowing the reference of overlay symbols by subsequent
689553125dfSNikos Nikoleris  * overlay operations.
690553125dfSNikos Nikoleris  *
691553125dfSNikos Nikoleris  * returns:
692553125dfSNikos Nikoleris  *      0 on success
693553125dfSNikos Nikoleris  *      Negative error code on failure
694553125dfSNikos Nikoleris  */
overlay_symbol_update(void * fdt,void * fdto)695553125dfSNikos Nikoleris static int overlay_symbol_update(void *fdt, void *fdto)
696553125dfSNikos Nikoleris {
697553125dfSNikos Nikoleris 	int root_sym, ov_sym, prop, path_len, fragment, target;
698553125dfSNikos Nikoleris 	int len, frag_name_len, ret, rel_path_len;
699553125dfSNikos Nikoleris 	const char *s, *e;
700553125dfSNikos Nikoleris 	const char *path;
701553125dfSNikos Nikoleris 	const char *name;
702553125dfSNikos Nikoleris 	const char *frag_name;
703553125dfSNikos Nikoleris 	const char *rel_path;
704553125dfSNikos Nikoleris 	const char *target_path;
705553125dfSNikos Nikoleris 	char *buf;
706553125dfSNikos Nikoleris 	void *p;
707553125dfSNikos Nikoleris 
708553125dfSNikos Nikoleris 	ov_sym = fdt_subnode_offset(fdto, 0, "__symbols__");
709553125dfSNikos Nikoleris 
710553125dfSNikos Nikoleris 	/* if no overlay symbols exist no problem */
711553125dfSNikos Nikoleris 	if (ov_sym < 0)
712553125dfSNikos Nikoleris 		return 0;
713553125dfSNikos Nikoleris 
714553125dfSNikos Nikoleris 	root_sym = fdt_subnode_offset(fdt, 0, "__symbols__");
715553125dfSNikos Nikoleris 
716553125dfSNikos Nikoleris 	/* it no root symbols exist we should create them */
717553125dfSNikos Nikoleris 	if (root_sym == -FDT_ERR_NOTFOUND)
718553125dfSNikos Nikoleris 		root_sym = fdt_add_subnode(fdt, 0, "__symbols__");
719553125dfSNikos Nikoleris 
720553125dfSNikos Nikoleris 	/* any error is fatal now */
721553125dfSNikos Nikoleris 	if (root_sym < 0)
722553125dfSNikos Nikoleris 		return root_sym;
723553125dfSNikos Nikoleris 
724553125dfSNikos Nikoleris 	/* iterate over each overlay symbol */
725553125dfSNikos Nikoleris 	fdt_for_each_property_offset(prop, fdto, ov_sym) {
726553125dfSNikos Nikoleris 		path = fdt_getprop_by_offset(fdto, prop, &name, &path_len);
727553125dfSNikos Nikoleris 		if (!path)
728553125dfSNikos Nikoleris 			return path_len;
729553125dfSNikos Nikoleris 
730553125dfSNikos Nikoleris 		/* verify it's a string property (terminated by a single \0) */
731553125dfSNikos Nikoleris 		if (path_len < 1 || memchr(path, '\0', path_len) != &path[path_len - 1])
732553125dfSNikos Nikoleris 			return -FDT_ERR_BADVALUE;
733553125dfSNikos Nikoleris 
734553125dfSNikos Nikoleris 		/* keep end marker to avoid strlen() */
735553125dfSNikos Nikoleris 		e = path + path_len;
736553125dfSNikos Nikoleris 
737553125dfSNikos Nikoleris 		if (*path != '/')
738553125dfSNikos Nikoleris 			return -FDT_ERR_BADVALUE;
739553125dfSNikos Nikoleris 
740553125dfSNikos Nikoleris 		/* get fragment name first */
741553125dfSNikos Nikoleris 		s = strchr(path + 1, '/');
742553125dfSNikos Nikoleris 		if (!s) {
743553125dfSNikos Nikoleris 			/* Symbol refers to something that won't end
744553125dfSNikos Nikoleris 			 * up in the target tree */
745553125dfSNikos Nikoleris 			continue;
746553125dfSNikos Nikoleris 		}
747553125dfSNikos Nikoleris 
748553125dfSNikos Nikoleris 		frag_name = path + 1;
749553125dfSNikos Nikoleris 		frag_name_len = s - path - 1;
750553125dfSNikos Nikoleris 
751553125dfSNikos Nikoleris 		/* verify format; safe since "s" lies in \0 terminated prop */
752553125dfSNikos Nikoleris 		len = sizeof("/__overlay__/") - 1;
753553125dfSNikos Nikoleris 		if ((e - s) > len && (memcmp(s, "/__overlay__/", len) == 0)) {
754553125dfSNikos Nikoleris 			/* /<fragment-name>/__overlay__/<relative-subnode-path> */
755553125dfSNikos Nikoleris 			rel_path = s + len;
756553125dfSNikos Nikoleris 			rel_path_len = e - rel_path - 1;
757553125dfSNikos Nikoleris 		} else if ((e - s) == len
758553125dfSNikos Nikoleris 			   && (memcmp(s, "/__overlay__", len - 1) == 0)) {
759553125dfSNikos Nikoleris 			/* /<fragment-name>/__overlay__ */
760553125dfSNikos Nikoleris 			rel_path = "";
761553125dfSNikos Nikoleris 			rel_path_len = 0;
762553125dfSNikos Nikoleris 		} else {
763553125dfSNikos Nikoleris 			/* Symbol refers to something that won't end
764553125dfSNikos Nikoleris 			 * up in the target tree */
765553125dfSNikos Nikoleris 			continue;
766553125dfSNikos Nikoleris 		}
767553125dfSNikos Nikoleris 
768553125dfSNikos Nikoleris 		/* find the fragment index in which the symbol lies */
769553125dfSNikos Nikoleris 		ret = fdt_subnode_offset_namelen(fdto, 0, frag_name,
770553125dfSNikos Nikoleris 					       frag_name_len);
771553125dfSNikos Nikoleris 		/* not found? */
772553125dfSNikos Nikoleris 		if (ret < 0)
773553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
774553125dfSNikos Nikoleris 		fragment = ret;
775553125dfSNikos Nikoleris 
776553125dfSNikos Nikoleris 		/* an __overlay__ subnode must exist */
777553125dfSNikos Nikoleris 		ret = fdt_subnode_offset(fdto, fragment, "__overlay__");
778553125dfSNikos Nikoleris 		if (ret < 0)
779553125dfSNikos Nikoleris 			return -FDT_ERR_BADOVERLAY;
780553125dfSNikos Nikoleris 
781553125dfSNikos Nikoleris 		/* get the target of the fragment */
782553125dfSNikos Nikoleris 		ret = overlay_get_target(fdt, fdto, fragment, &target_path);
783553125dfSNikos Nikoleris 		if (ret < 0)
784553125dfSNikos Nikoleris 			return ret;
785553125dfSNikos Nikoleris 		target = ret;
786553125dfSNikos Nikoleris 
787553125dfSNikos Nikoleris 		/* if we have a target path use */
788553125dfSNikos Nikoleris 		if (!target_path) {
789553125dfSNikos Nikoleris 			ret = get_path_len(fdt, target);
790553125dfSNikos Nikoleris 			if (ret < 0)
791553125dfSNikos Nikoleris 				return ret;
792553125dfSNikos Nikoleris 			len = ret;
793553125dfSNikos Nikoleris 		} else {
794553125dfSNikos Nikoleris 			len = strlen(target_path);
795553125dfSNikos Nikoleris 		}
796553125dfSNikos Nikoleris 
797553125dfSNikos Nikoleris 		ret = fdt_setprop_placeholder(fdt, root_sym, name,
798553125dfSNikos Nikoleris 				len + (len > 1) + rel_path_len + 1, &p);
799553125dfSNikos Nikoleris 		if (ret < 0)
800553125dfSNikos Nikoleris 			return ret;
801553125dfSNikos Nikoleris 
802553125dfSNikos Nikoleris 		if (!target_path) {
803553125dfSNikos Nikoleris 			/* again in case setprop_placeholder changed it */
804553125dfSNikos Nikoleris 			ret = overlay_get_target(fdt, fdto, fragment, &target_path);
805553125dfSNikos Nikoleris 			if (ret < 0)
806553125dfSNikos Nikoleris 				return ret;
807553125dfSNikos Nikoleris 			target = ret;
808553125dfSNikos Nikoleris 		}
809553125dfSNikos Nikoleris 
810553125dfSNikos Nikoleris 		buf = p;
811553125dfSNikos Nikoleris 		if (len > 1) { /* target is not root */
812553125dfSNikos Nikoleris 			if (!target_path) {
813553125dfSNikos Nikoleris 				ret = fdt_get_path(fdt, target, buf, len + 1);
814553125dfSNikos Nikoleris 				if (ret < 0)
815553125dfSNikos Nikoleris 					return ret;
816553125dfSNikos Nikoleris 			} else
817553125dfSNikos Nikoleris 				memcpy(buf, target_path, len + 1);
818553125dfSNikos Nikoleris 
819553125dfSNikos Nikoleris 		} else
820553125dfSNikos Nikoleris 			len--;
821553125dfSNikos Nikoleris 
822553125dfSNikos Nikoleris 		buf[len] = '/';
823553125dfSNikos Nikoleris 		memcpy(buf + len + 1, rel_path, rel_path_len);
824553125dfSNikos Nikoleris 		buf[len + 1 + rel_path_len] = '\0';
825553125dfSNikos Nikoleris 	}
826553125dfSNikos Nikoleris 
827553125dfSNikos Nikoleris 	return 0;
828553125dfSNikos Nikoleris }
829553125dfSNikos Nikoleris 
fdt_overlay_apply(void * fdt,void * fdto)830553125dfSNikos Nikoleris int fdt_overlay_apply(void *fdt, void *fdto)
831553125dfSNikos Nikoleris {
832553125dfSNikos Nikoleris 	uint32_t delta;
833553125dfSNikos Nikoleris 	int ret;
834553125dfSNikos Nikoleris 
835553125dfSNikos Nikoleris 	FDT_RO_PROBE(fdt);
836553125dfSNikos Nikoleris 	FDT_RO_PROBE(fdto);
837553125dfSNikos Nikoleris 
838553125dfSNikos Nikoleris 	ret = fdt_find_max_phandle(fdt, &delta);
839553125dfSNikos Nikoleris 	if (ret)
840553125dfSNikos Nikoleris 		goto err;
841553125dfSNikos Nikoleris 
842553125dfSNikos Nikoleris 	ret = overlay_adjust_local_phandles(fdto, delta);
843553125dfSNikos Nikoleris 	if (ret)
844553125dfSNikos Nikoleris 		goto err;
845553125dfSNikos Nikoleris 
846553125dfSNikos Nikoleris 	ret = overlay_update_local_references(fdto, delta);
847553125dfSNikos Nikoleris 	if (ret)
848553125dfSNikos Nikoleris 		goto err;
849553125dfSNikos Nikoleris 
850553125dfSNikos Nikoleris 	ret = overlay_fixup_phandles(fdt, fdto);
851553125dfSNikos Nikoleris 	if (ret)
852553125dfSNikos Nikoleris 		goto err;
853553125dfSNikos Nikoleris 
854553125dfSNikos Nikoleris 	ret = overlay_merge(fdt, fdto);
855553125dfSNikos Nikoleris 	if (ret)
856553125dfSNikos Nikoleris 		goto err;
857553125dfSNikos Nikoleris 
858553125dfSNikos Nikoleris 	ret = overlay_symbol_update(fdt, fdto);
859553125dfSNikos Nikoleris 	if (ret)
860553125dfSNikos Nikoleris 		goto err;
861553125dfSNikos Nikoleris 
862553125dfSNikos Nikoleris 	/*
863553125dfSNikos Nikoleris 	 * The overlay has been damaged, erase its magic.
864553125dfSNikos Nikoleris 	 */
865553125dfSNikos Nikoleris 	fdt_set_magic(fdto, ~0);
866553125dfSNikos Nikoleris 
867553125dfSNikos Nikoleris 	return 0;
868553125dfSNikos Nikoleris 
869553125dfSNikos Nikoleris err:
870553125dfSNikos Nikoleris 	/*
871553125dfSNikos Nikoleris 	 * The overlay might have been damaged, erase its magic.
872553125dfSNikos Nikoleris 	 */
873553125dfSNikos Nikoleris 	fdt_set_magic(fdto, ~0);
874553125dfSNikos Nikoleris 
875553125dfSNikos Nikoleris 	/*
876553125dfSNikos Nikoleris 	 * The base device tree might have been damaged, erase its
877553125dfSNikos Nikoleris 	 * magic.
878553125dfSNikos Nikoleris 	 */
879553125dfSNikos Nikoleris 	fdt_set_magic(fdt, ~0);
880553125dfSNikos Nikoleris 
881553125dfSNikos Nikoleris 	return ret;
882553125dfSNikos Nikoleris }
883