2 * Functions for dealing with DT resolution
4 * Copyright (C) 2012 Pantelis Antoniou <panto@antoniou-consulting.com>
5 * Copyright (C) 2012 Texas Instruments Inc.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
12 #define pr_fmt(fmt) "OF: resolver: " fmt
14 #include <linux/kernel.h>
15 #include <linux/module.h>
17 #include <linux/of_device.h>
18 #include <linux/string.h>
19 #include <linux/ctype.h>
20 #include <linux/errno.h>
21 #include <linux/slab.h>
23 #include "of_private.h"
25 /* illegal phandle value (set when unresolved) */
26 #define OF_PHANDLE_ILLEGAL 0xdeadbeef
28 static phandle
live_tree_max_phandle(void)
30 struct device_node
*node
;
34 raw_spin_lock_irqsave(&devtree_lock
, flags
);
36 for_each_of_allnodes(node
) {
37 if (node
->phandle
!= OF_PHANDLE_ILLEGAL
&&
38 node
->phandle
> phandle
)
39 phandle
= node
->phandle
;
41 raw_spin_unlock_irqrestore(&devtree_lock
, flags
);
46 static void adjust_overlay_phandles(struct device_node
*overlay
,
49 struct device_node
*child
;
50 struct property
*prop
;
53 /* adjust node's phandle in node */
54 if (overlay
->phandle
!= 0 && overlay
->phandle
!= OF_PHANDLE_ILLEGAL
)
55 overlay
->phandle
+= phandle_delta
;
57 /* copy adjusted phandle into *phandle properties */
58 for_each_property_of_node(overlay
, prop
) {
60 if (of_prop_cmp(prop
->name
, "phandle") &&
61 of_prop_cmp(prop
->name
, "linux,phandle"))
67 phandle
= be32_to_cpup(prop
->value
);
68 if (phandle
== OF_PHANDLE_ILLEGAL
)
71 *(__be32
*)prop
->value
= cpu_to_be32(overlay
->phandle
);
74 for_each_child_of_node(overlay
, child
)
75 adjust_overlay_phandles(child
, phandle_delta
);
78 static int update_usages_of_a_phandle_reference(struct device_node
*overlay
,
79 struct property
*prop_fixup
, phandle phandle
)
81 struct device_node
*refnode
;
82 struct property
*prop
;
83 char *value
, *cur
, *end
, *node_path
, *prop_name
, *s
;
87 value
= kmemdup(prop_fixup
->value
, prop_fixup
->length
, GFP_KERNEL
);
91 /* prop_fixup contains a list of tuples of path:property_name:offset */
92 end
= value
+ prop_fixup
->length
;
93 for (cur
= value
; cur
< end
; cur
+= len
+ 1) {
112 err
= kstrtoint(s
, 10, &offset
);
116 refnode
= __of_find_node_by_full_path(of_node_get(overlay
), node_path
);
120 for_each_property_of_node(refnode
, prop
) {
121 if (!of_prop_cmp(prop
->name
, prop_name
))
124 of_node_put(refnode
);
131 *(__be32
*)(prop
->value
+ offset
) = cpu_to_be32(phandle
);
139 /* compare nodes taking into account that 'name' strips out the @ part */
140 static int node_name_cmp(const struct device_node
*dn1
,
141 const struct device_node
*dn2
)
143 const char *n1
= kbasename(dn1
->full_name
);
144 const char *n2
= kbasename(dn2
->full_name
);
146 return of_node_cmp(n1
, n2
);
150 * Adjust the local phandle references by the given phandle delta.
152 * Subtree @local_fixups, which is overlay node __local_fixups__,
153 * mirrors the fragment node structure at the root of the overlay.
155 * For each property in the fragments that contains a phandle reference,
156 * @local_fixups has a property of the same name that contains a list
157 * of offsets of the phandle reference(s) within the respective property
158 * value(s). The values at these offsets will be fixed up.
160 static int adjust_local_phandle_references(struct device_node
*local_fixups
,
161 struct device_node
*overlay
, int phandle_delta
)
163 struct device_node
*child
, *overlay_child
;
164 struct property
*prop_fix
, *prop
;
171 for_each_property_of_node(local_fixups
, prop_fix
) {
173 /* skip properties added automatically */
174 if (!of_prop_cmp(prop_fix
->name
, "name") ||
175 !of_prop_cmp(prop_fix
->name
, "phandle") ||
176 !of_prop_cmp(prop_fix
->name
, "linux,phandle"))
179 if ((prop_fix
->length
% 4) != 0 || prop_fix
->length
== 0)
181 count
= prop_fix
->length
/ sizeof(__be32
);
183 for_each_property_of_node(overlay
, prop
) {
184 if (!of_prop_cmp(prop
->name
, prop_fix
->name
))
191 for (i
= 0; i
< count
; i
++) {
192 off
= be32_to_cpu(((__be32
*)prop_fix
->value
)[i
]);
193 if ((off
+ 4) > prop
->length
)
196 be32_add_cpu(prop
->value
+ off
, phandle_delta
);
201 * These nested loops recurse down two subtrees in parallel, where the
202 * node names in the two subtrees match.
204 * The roots of the subtrees are the overlay's __local_fixups__ node
205 * and the overlay's root node.
207 for_each_child_of_node(local_fixups
, child
) {
209 for_each_child_of_node(overlay
, overlay_child
)
210 if (!node_name_cmp(child
, overlay_child
))
216 err
= adjust_local_phandle_references(child
, overlay_child
,
226 * of_resolve_phandles - Relocate and resolve overlay against live tree
228 * @overlay: Pointer to devicetree overlay to relocate and resolve
230 * Modify (relocate) values of local phandles in @overlay to a range that
231 * does not conflict with the live expanded devicetree. Update references
232 * to the local phandles in @overlay. Update (resolve) phandle references
233 * in @overlay that refer to the live expanded devicetree.
235 * Phandle values in the live tree are in the range of
236 * 1 .. live_tree_max_phandle(). The range of phandle values in the overlay
237 * also begin with at 1. Adjust the phandle values in the overlay to begin
238 * at live_tree_max_phandle() + 1. Update references to the phandles to
239 * the adjusted phandle values.
241 * The name of each property in the "__fixups__" node in the overlay matches
242 * the name of a symbol (a label) in the live tree. The values of each
243 * property in the "__fixups__" node is a list of the property values in the
244 * overlay that need to be updated to contain the phandle reference
245 * corresponding to that symbol in the live tree. Update the references in
246 * the overlay with the phandle values in the live tree.
248 * @overlay must be detached.
250 * Resolving and applying @overlay to the live expanded devicetree must be
251 * protected by a mechanism to ensure that multiple overlays are processed
252 * in a single threaded manner so that multiple overlays will not relocate
253 * phandles to overlapping ranges. The mechanism to enforce this is not
256 * Return: %0 on success or a negative error value on error.
258 int of_resolve_phandles(struct device_node
*overlay
)
260 struct device_node
*child
, *local_fixups
, *refnode
;
261 struct device_node
*tree_symbols
, *overlay_fixups
;
262 struct property
*prop
;
264 phandle phandle
, phandle_delta
;
270 pr_err("null overlay\n");
276 Temporarily disable check so that old style overlay unittests
277 do not fail when
of_resolve_phandles() is moved into
280 if (!of_node_check_flag(overlay
, OF_DETACHED
)) {
281 pr_err("overlay not detached\n");
287 phandle_delta
= live_tree_max_phandle() + 1;
288 adjust_overlay_phandles(overlay
, phandle_delta
);
290 for_each_child_of_node(overlay
, local_fixups
)
291 if (!of_node_cmp(local_fixups
->name
, "__local_fixups__"))
294 err
= adjust_local_phandle_references(local_fixups
, overlay
, phandle_delta
);
298 overlay_fixups
= NULL
;
300 for_each_child_of_node(overlay
, child
) {
301 if (!of_node_cmp(child
->name
, "__fixups__"))
302 overlay_fixups
= child
;
305 if (!overlay_fixups
) {
310 tree_symbols
= of_find_node_by_path("/__symbols__");
312 pr_err("no symbols in root of device tree.\n");
317 for_each_property_of_node(overlay_fixups
, prop
) {
319 /* skip properties added automatically */
320 if (!of_prop_cmp(prop
->name
, "name"))
323 err
= of_property_read_string(tree_symbols
,
324 prop
->name
, &refpath
);
328 refnode
= of_find_node_by_path(refpath
);
334 phandle
= refnode
->phandle
;
335 of_node_put(refnode
);
337 err
= update_usages_of_a_phandle_reference(overlay
, prop
, phandle
);
344 pr_err("overlay phandle fixup failed: %d\n", err
);
345 of_node_put(tree_symbols
);
349 EXPORT_SYMBOL_GPL(of_resolve_phandles
);