blob: 7bb33d22b4e2f50fe19d8f555170c835dc4a8406 [file] [log] [blame]
Rob Herringaf6074f2017-12-27 12:55:14 -06001// SPDX-License-Identifier: GPL-2.0
Grant Likely6afc0dc2014-06-26 15:40:48 +01002/*
3 * Support for dynamic device trees.
4 *
5 * On some platforms, the device tree can be manipulated at runtime.
6 * The routines in this section support adding, removing and changing
7 * device tree nodes.
8 */
9
Rob Herring606ad422016-06-15 08:32:18 -050010#define pr_fmt(fmt) "OF: " fmt
11
Grant Likely6afc0dc2014-06-26 15:40:48 +010012#include <linux/of.h>
13#include <linux/spinlock.h>
14#include <linux/slab.h>
15#include <linux/string.h>
16#include <linux/proc_fs.h>
17
18#include "of_private.h"
19
Rob Herring4c2bb572017-10-04 19:30:53 -050020static struct device_node *kobj_to_device_node(struct kobject *kobj)
21{
22 return container_of(kobj, struct device_node, kobj);
23}
24
Grant Likely6afc0dc2014-06-26 15:40:48 +010025/**
26 * of_node_get() - Increment refcount of a node
27 * @node: Node to inc refcount, NULL is supported to simplify writing of
28 * callers
29 *
30 * Returns node.
31 */
32struct device_node *of_node_get(struct device_node *node)
33{
34 if (node)
35 kobject_get(&node->kobj);
36 return node;
37}
38EXPORT_SYMBOL(of_node_get);
39
40/**
41 * of_node_put() - Decrement refcount of a node
42 * @node: Node to dec refcount, NULL is supported to simplify writing of
43 * callers
44 */
45void of_node_put(struct device_node *node)
46{
47 if (node)
48 kobject_put(&node->kobj);
49}
50EXPORT_SYMBOL(of_node_put);
51
Grant Likely6afc0dc2014-06-26 15:40:48 +010052static BLOCKING_NOTIFIER_HEAD(of_reconfig_chain);
53
54int of_reconfig_notifier_register(struct notifier_block *nb)
55{
56 return blocking_notifier_chain_register(&of_reconfig_chain, nb);
57}
58EXPORT_SYMBOL_GPL(of_reconfig_notifier_register);
59
60int of_reconfig_notifier_unregister(struct notifier_block *nb)
61{
62 return blocking_notifier_chain_unregister(&of_reconfig_chain, nb);
63}
64EXPORT_SYMBOL_GPL(of_reconfig_notifier_unregister);
65
Grant Likely00aa3722014-11-14 14:34:55 +000066#ifdef DEBUG
67const char *action_names[] = {
68 [OF_RECONFIG_ATTACH_NODE] = "ATTACH_NODE",
69 [OF_RECONFIG_DETACH_NODE] = "DETACH_NODE",
70 [OF_RECONFIG_ADD_PROPERTY] = "ADD_PROPERTY",
71 [OF_RECONFIG_REMOVE_PROPERTY] = "REMOVE_PROPERTY",
72 [OF_RECONFIG_UPDATE_PROPERTY] = "UPDATE_PROPERTY",
73};
74#endif
75
Grant Likelyf5242e52014-11-24 17:58:01 +000076int of_reconfig_notify(unsigned long action, struct of_reconfig_data *p)
Grant Likely6afc0dc2014-06-26 15:40:48 +010077{
78 int rc;
Grant Likely00aa3722014-11-14 14:34:55 +000079#ifdef DEBUG
Grant Likelyf5242e52014-11-24 17:58:01 +000080 struct of_reconfig_data *pr = p;
Grant Likely6afc0dc2014-06-26 15:40:48 +010081
Grant Likely00aa3722014-11-14 14:34:55 +000082 switch (action) {
83 case OF_RECONFIG_ATTACH_NODE:
84 case OF_RECONFIG_DETACH_NODE:
Rob Herring0d638a02017-06-01 15:50:55 -050085 pr_debug("notify %-15s %pOF\n", action_names[action],
86 pr->dn);
Grant Likely00aa3722014-11-14 14:34:55 +000087 break;
88 case OF_RECONFIG_ADD_PROPERTY:
89 case OF_RECONFIG_REMOVE_PROPERTY:
90 case OF_RECONFIG_UPDATE_PROPERTY:
Rob Herring0d638a02017-06-01 15:50:55 -050091 pr_debug("notify %-15s %pOF:%s\n", action_names[action],
92 pr->dn, pr->prop->name);
Grant Likely00aa3722014-11-14 14:34:55 +000093 break;
94
95 }
96#endif
Grant Likely6afc0dc2014-06-26 15:40:48 +010097 rc = blocking_notifier_call_chain(&of_reconfig_chain, action, p);
98 return notifier_to_errno(rc);
99}
100
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200101/*
102 * of_reconfig_get_state_change() - Returns new state of device
103 * @action - action of the of notifier
104 * @arg - argument of the of notifier
105 *
106 * Returns the new state of a device based on the notifier used.
107 * Returns 0 on device going from enabled to disabled, 1 on device
108 * going from disabled to enabled and -1 on no change.
109 */
Grant Likelyf5242e52014-11-24 17:58:01 +0000110int of_reconfig_get_state_change(unsigned long action, struct of_reconfig_data *pr)
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200111{
Grant Likelyf5242e52014-11-24 17:58:01 +0000112 struct property *prop, *old_prop = NULL;
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200113 int is_status, status_state, old_status_state, prev_state, new_state;
114
115 /* figure out if a device should be created or destroyed */
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200116 switch (action) {
117 case OF_RECONFIG_ATTACH_NODE:
118 case OF_RECONFIG_DETACH_NODE:
Grant Likelyf5242e52014-11-24 17:58:01 +0000119 prop = of_find_property(pr->dn, "status", NULL);
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200120 break;
121 case OF_RECONFIG_ADD_PROPERTY:
122 case OF_RECONFIG_REMOVE_PROPERTY:
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200123 prop = pr->prop;
124 break;
125 case OF_RECONFIG_UPDATE_PROPERTY:
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200126 prop = pr->prop;
127 old_prop = pr->old_prop;
128 break;
129 default:
130 return OF_RECONFIG_NO_CHANGE;
131 }
132
133 is_status = 0;
134 status_state = -1;
135 old_status_state = -1;
136 prev_state = -1;
137 new_state = -1;
138
139 if (prop && !strcmp(prop->name, "status")) {
140 is_status = 1;
141 status_state = !strcmp(prop->value, "okay") ||
142 !strcmp(prop->value, "ok");
143 if (old_prop)
144 old_status_state = !strcmp(old_prop->value, "okay") ||
145 !strcmp(old_prop->value, "ok");
146 }
147
148 switch (action) {
149 case OF_RECONFIG_ATTACH_NODE:
150 prev_state = 0;
151 /* -1 & 0 status either missing or okay */
152 new_state = status_state != 0;
153 break;
154 case OF_RECONFIG_DETACH_NODE:
155 /* -1 & 0 status either missing or okay */
156 prev_state = status_state != 0;
157 new_state = 0;
158 break;
159 case OF_RECONFIG_ADD_PROPERTY:
160 if (is_status) {
161 /* no status property -> enabled (legacy) */
162 prev_state = 1;
163 new_state = status_state;
164 }
165 break;
166 case OF_RECONFIG_REMOVE_PROPERTY:
167 if (is_status) {
168 prev_state = status_state;
169 /* no status property -> enabled (legacy) */
170 new_state = 1;
171 }
172 break;
173 case OF_RECONFIG_UPDATE_PROPERTY:
174 if (is_status) {
175 prev_state = old_status_state != 0;
176 new_state = status_state != 0;
177 }
178 break;
179 }
180
181 if (prev_state == new_state)
182 return OF_RECONFIG_NO_CHANGE;
183
184 return new_state ? OF_RECONFIG_CHANGE_ADD : OF_RECONFIG_CHANGE_REMOVE;
185}
186EXPORT_SYMBOL_GPL(of_reconfig_get_state_change);
187
Grant Likely6afc0dc2014-06-26 15:40:48 +0100188int of_property_notify(int action, struct device_node *np,
Grant Likely259092a2014-07-16 12:48:23 -0600189 struct property *prop, struct property *oldprop)
Grant Likely6afc0dc2014-06-26 15:40:48 +0100190{
Grant Likelyf5242e52014-11-24 17:58:01 +0000191 struct of_reconfig_data pr;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100192
193 /* only call notifiers if the node is attached */
194 if (!of_node_is_attached(np))
195 return 0;
196
197 pr.dn = np;
198 pr.prop = prop;
Grant Likely259092a2014-07-16 12:48:23 -0600199 pr.old_prop = oldprop;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100200 return of_reconfig_notify(action, &pr);
201}
202
Frank Rowand249969512017-06-21 12:16:38 -0700203static void __of_attach_node(struct device_node *np)
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300204{
Grant Likelya25095d2014-07-15 23:25:43 -0600205 const __be32 *phandle;
206 int sz;
207
208 np->name = __of_get_property(np, "name", NULL) ? : "<NULL>";
209 np->type = __of_get_property(np, "device_type", NULL) ? : "<NULL>";
210
211 phandle = __of_get_property(np, "phandle", &sz);
212 if (!phandle)
213 phandle = __of_get_property(np, "linux,phandle", &sz);
Geert Uytterhoevenf76502a2015-06-04 11:34:41 +0200214 if (IS_ENABLED(CONFIG_PPC_PSERIES) && !phandle)
Grant Likelya25095d2014-07-15 23:25:43 -0600215 phandle = __of_get_property(np, "ibm,phandle", &sz);
216 np->phandle = (phandle && (sz >= 4)) ? be32_to_cpup(phandle) : 0;
217
Grant Likely6162dbe2014-07-16 08:48:46 -0600218 np->child = NULL;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300219 np->sibling = np->parent->child;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300220 np->parent->child = np;
221 of_node_clear_flag(np, OF_DETACHED);
222}
223
Grant Likely6afc0dc2014-06-26 15:40:48 +0100224/**
225 * of_attach_node() - Plug a device node into the tree and global list.
226 */
227int of_attach_node(struct device_node *np)
228{
Grant Likelyf5242e52014-11-24 17:58:01 +0000229 struct of_reconfig_data rd;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100230 unsigned long flags;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100231
Grant Likelyf5242e52014-11-24 17:58:01 +0000232 memset(&rd, 0, sizeof(rd));
233 rd.dn = np;
234
Grant Likely8a2b22a22014-07-23 17:05:06 -0600235 mutex_lock(&of_mutex);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100236 raw_spin_lock_irqsave(&devtree_lock, flags);
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300237 __of_attach_node(np);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100238 raw_spin_unlock_irqrestore(&devtree_lock, flags);
239
Grant Likely8a2b22a22014-07-23 17:05:06 -0600240 __of_attach_node_sysfs(np);
241 mutex_unlock(&of_mutex);
Grant Likely259092a2014-07-16 12:48:23 -0600242
Grant Likelyf5242e52014-11-24 17:58:01 +0000243 of_reconfig_notify(OF_RECONFIG_ATTACH_NODE, &rd);
Grant Likely259092a2014-07-16 12:48:23 -0600244
Grant Likely6afc0dc2014-06-26 15:40:48 +0100245 return 0;
246}
247
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300248void __of_detach_node(struct device_node *np)
Grant Likely6afc0dc2014-06-26 15:40:48 +0100249{
250 struct device_node *parent;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100251
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300252 if (WARN_ON(of_node_check_flag(np, OF_DETACHED)))
253 return;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100254
255 parent = np->parent;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300256 if (WARN_ON(!parent))
257 return;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100258
Grant Likely6afc0dc2014-06-26 15:40:48 +0100259 if (parent->child == np)
260 parent->child = np->sibling;
261 else {
262 struct device_node *prevsib;
263 for (prevsib = np->parent->child;
264 prevsib->sibling != np;
265 prevsib = prevsib->sibling)
266 ;
267 prevsib->sibling = np->sibling;
268 }
269
270 of_node_set_flag(np, OF_DETACHED);
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300271}
272
273/**
274 * of_detach_node() - "Unplug" a node from the device tree.
275 *
276 * The caller must hold a reference to the node. The memory associated with
277 * the node is not freed until its refcount goes to zero.
278 */
279int of_detach_node(struct device_node *np)
280{
Grant Likelyf5242e52014-11-24 17:58:01 +0000281 struct of_reconfig_data rd;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300282 unsigned long flags;
283 int rc = 0;
284
Grant Likelyf5242e52014-11-24 17:58:01 +0000285 memset(&rd, 0, sizeof(rd));
286 rd.dn = np;
287
Grant Likely8a2b22a22014-07-23 17:05:06 -0600288 mutex_lock(&of_mutex);
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300289 raw_spin_lock_irqsave(&devtree_lock, flags);
290 __of_detach_node(np);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100291 raw_spin_unlock_irqrestore(&devtree_lock, flags);
292
Grant Likely8a2b22a22014-07-23 17:05:06 -0600293 __of_detach_node_sysfs(np);
294 mutex_unlock(&of_mutex);
Grant Likely259092a2014-07-16 12:48:23 -0600295
Grant Likelyf5242e52014-11-24 17:58:01 +0000296 of_reconfig_notify(OF_RECONFIG_DETACH_NODE, &rd);
Grant Likely259092a2014-07-16 12:48:23 -0600297
Grant Likely6afc0dc2014-06-26 15:40:48 +0100298 return rc;
299}
Gavin Shanbb91f922016-05-03 23:22:52 +1000300EXPORT_SYMBOL_GPL(of_detach_node);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100301
Lixin Wang070ea012017-10-23 11:19:53 +0800302static void property_list_free(struct property *prop_list)
303{
304 struct property *prop, *next;
305
306 for (prop = prop_list; prop != NULL; prop = next) {
307 next = prop->next;
308 kfree(prop->name);
309 kfree(prop->value);
310 kfree(prop);
311 }
312}
313
Grant Likely6afc0dc2014-06-26 15:40:48 +0100314/**
315 * of_node_release() - release a dynamically allocated node
316 * @kref: kref element of the node to be released
317 *
318 * In of_node_put() this function is passed to kref_put() as the destructor.
319 */
320void of_node_release(struct kobject *kobj)
321{
322 struct device_node *node = kobj_to_device_node(kobj);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100323
324 /* We should never be releasing nodes that haven't been detached. */
325 if (!of_node_check_flag(node, OF_DETACHED)) {
Rob Herring0d638a02017-06-01 15:50:55 -0500326 pr_err("ERROR: Bad of_node_put() on %pOF\n", node);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100327 dump_stack();
328 return;
329 }
Grant Likely6afc0dc2014-06-26 15:40:48 +0100330 if (!of_node_check_flag(node, OF_DYNAMIC))
331 return;
332
Lixin Wang070ea012017-10-23 11:19:53 +0800333 property_list_free(node->properties);
334 property_list_free(node->deadprops);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100335
Grant Likely6afc0dc2014-06-26 15:40:48 +0100336 kfree(node->full_name);
337 kfree(node->data);
338 kfree(node);
339}
Pantelis Antoniou69843392014-07-04 19:58:47 +0300340
341/**
342 * __of_prop_dup - Copy a property dynamically.
343 * @prop: Property to copy
344 * @allocflags: Allocation flags (typically pass GFP_KERNEL)
345 *
346 * Copy a property by dynamically allocating the memory of both the
Geert Uytterhoeven27b33832014-10-22 11:49:01 +0200347 * property structure and the property name & contents. The property's
Pantelis Antoniou69843392014-07-04 19:58:47 +0300348 * flags have the OF_DYNAMIC bit set so that we can differentiate between
349 * dynamically allocated properties and not.
350 * Returns the newly allocated property or NULL on out of memory error.
351 */
352struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags)
353{
354 struct property *new;
355
356 new = kzalloc(sizeof(*new), allocflags);
357 if (!new)
358 return NULL;
359
360 /*
361 * NOTE: There is no check for zero length value.
Grant Likelyb6ae5dc2014-07-26 10:58:43 -0600362 * In case of a boolean property, this will allocate a value
Pantelis Antoniou69843392014-07-04 19:58:47 +0300363 * of zero bytes. We do this to work around the use
364 * of of_get_property() calls on boolean values.
365 */
366 new->name = kstrdup(prop->name, allocflags);
367 new->value = kmemdup(prop->value, prop->length, allocflags);
368 new->length = prop->length;
369 if (!new->name || !new->value)
370 goto err_free;
371
372 /* mark the property as dynamic */
373 of_property_set_flag(new, OF_DYNAMIC);
374
375 return new;
376
377 err_free:
378 kfree(new->name);
379 kfree(new->value);
380 kfree(new);
381 return NULL;
382}
383
384/**
Grant Likelye5179582014-11-17 22:31:32 +0000385 * __of_node_dup() - Duplicate or create an empty device node dynamically.
386 * @fmt: Format string (plus vargs) for new full name of the device node
Pantelis Antoniou69843392014-07-04 19:58:47 +0300387 *
Grant Likelye5179582014-11-17 22:31:32 +0000388 * Create an device tree node, either by duplicating an empty node or by allocating
389 * an empty one suitable for further modification. The node data are
390 * dynamically allocated and all the node flags have the OF_DYNAMIC &
391 * OF_DETACHED bits set. Returns the newly allocated node or NULL on out of
392 * memory error.
Pantelis Antoniou69843392014-07-04 19:58:47 +0300393 */
Grant Likelye5179582014-11-17 22:31:32 +0000394struct device_node *__of_node_dup(const struct device_node *np, const char *fmt, ...)
Pantelis Antoniou69843392014-07-04 19:58:47 +0300395{
Grant Likelyef8bbd72014-11-14 15:33:07 +0000396 va_list vargs;
Pantelis Antoniou69843392014-07-04 19:58:47 +0300397 struct device_node *node;
398
Grant Likelyef8bbd72014-11-14 15:33:07 +0000399 node = kzalloc(sizeof(*node), GFP_KERNEL);
Pantelis Antoniou69843392014-07-04 19:58:47 +0300400 if (!node)
401 return NULL;
Grant Likelyef8bbd72014-11-14 15:33:07 +0000402 va_start(vargs, fmt);
403 node->full_name = kvasprintf(GFP_KERNEL, fmt, vargs);
404 va_end(vargs);
Grant Likelye5179582014-11-17 22:31:32 +0000405 if (!node->full_name) {
406 kfree(node);
407 return NULL;
408 }
Pantelis Antoniou69843392014-07-04 19:58:47 +0300409
Grant Likelyef8bbd72014-11-14 15:33:07 +0000410 of_node_set_flag(node, OF_DYNAMIC);
411 of_node_set_flag(node, OF_DETACHED);
Pantelis Antoniou69843392014-07-04 19:58:47 +0300412 of_node_init(node);
413
Grant Likelye5179582014-11-17 22:31:32 +0000414 /* Iterate over and duplicate all properties */
415 if (np) {
416 struct property *pp, *new_pp;
417 for_each_property_of_node(np, pp) {
418 new_pp = __of_prop_dup(pp, GFP_KERNEL);
419 if (!new_pp)
420 goto err_prop;
421 if (__of_add_property(node, new_pp)) {
422 kfree(new_pp->name);
423 kfree(new_pp->value);
424 kfree(new_pp);
425 goto err_prop;
426 }
427 }
428 }
Pantelis Antoniou69843392014-07-04 19:58:47 +0300429 return node;
430
Grant Likelye5179582014-11-17 22:31:32 +0000431 err_prop:
432 of_node_put(node); /* Frees the node and properties */
Pantelis Antoniou69843392014-07-04 19:58:47 +0300433 return NULL;
434}
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300435
436static void __of_changeset_entry_destroy(struct of_changeset_entry *ce)
437{
438 of_node_put(ce->np);
439 list_del(&ce->node);
440 kfree(ce);
441}
442
443#ifdef DEBUG
444static void __of_changeset_entry_dump(struct of_changeset_entry *ce)
445{
446 switch (ce->action) {
447 case OF_RECONFIG_ADD_PROPERTY:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300448 case OF_RECONFIG_REMOVE_PROPERTY:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300449 case OF_RECONFIG_UPDATE_PROPERTY:
Rob Herring0d638a02017-06-01 15:50:55 -0500450 pr_debug("cset<%p> %-15s %pOF/%s\n", ce, action_names[ce->action],
451 ce->np, ce->prop->name);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300452 break;
453 case OF_RECONFIG_ATTACH_NODE:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300454 case OF_RECONFIG_DETACH_NODE:
Rob Herring0d638a02017-06-01 15:50:55 -0500455 pr_debug("cset<%p> %-15s %pOF\n", ce, action_names[ce->action],
456 ce->np);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300457 break;
458 }
459}
460#else
461static inline void __of_changeset_entry_dump(struct of_changeset_entry *ce)
462{
463 /* empty */
464}
465#endif
466
467static void __of_changeset_entry_invert(struct of_changeset_entry *ce,
468 struct of_changeset_entry *rce)
469{
470 memcpy(rce, ce, sizeof(*rce));
471
472 switch (ce->action) {
473 case OF_RECONFIG_ATTACH_NODE:
474 rce->action = OF_RECONFIG_DETACH_NODE;
475 break;
476 case OF_RECONFIG_DETACH_NODE:
477 rce->action = OF_RECONFIG_ATTACH_NODE;
478 break;
479 case OF_RECONFIG_ADD_PROPERTY:
480 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
481 break;
482 case OF_RECONFIG_REMOVE_PROPERTY:
483 rce->action = OF_RECONFIG_ADD_PROPERTY;
484 break;
485 case OF_RECONFIG_UPDATE_PROPERTY:
486 rce->old_prop = ce->prop;
487 rce->prop = ce->old_prop;
Pantelis Antonioub9c43852016-05-09 16:20:42 +0300488 /* update was used but original property did not exist */
489 if (!rce->prop) {
490 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
491 rce->prop = ce->prop;
492 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300493 break;
494 }
495}
496
Frank Rowand24789c52017-10-17 16:36:26 -0700497static int __of_changeset_entry_notify(struct of_changeset_entry *ce,
498 bool revert)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300499{
Grant Likelyf5242e52014-11-24 17:58:01 +0000500 struct of_reconfig_data rd;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300501 struct of_changeset_entry ce_inverted;
Frank Rowand24789c52017-10-17 16:36:26 -0700502 int ret = 0;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300503
504 if (revert) {
505 __of_changeset_entry_invert(ce, &ce_inverted);
506 ce = &ce_inverted;
507 }
508
509 switch (ce->action) {
510 case OF_RECONFIG_ATTACH_NODE:
511 case OF_RECONFIG_DETACH_NODE:
Grant Likelyf5242e52014-11-24 17:58:01 +0000512 memset(&rd, 0, sizeof(rd));
513 rd.dn = ce->np;
514 ret = of_reconfig_notify(ce->action, &rd);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300515 break;
516 case OF_RECONFIG_ADD_PROPERTY:
517 case OF_RECONFIG_REMOVE_PROPERTY:
518 case OF_RECONFIG_UPDATE_PROPERTY:
519 ret = of_property_notify(ce->action, ce->np, ce->prop, ce->old_prop);
520 break;
521 default:
Rob Herring606ad422016-06-15 08:32:18 -0500522 pr_err("invalid devicetree changeset action: %i\n",
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300523 (int)ce->action);
Frank Rowand24789c52017-10-17 16:36:26 -0700524 ret = -EINVAL;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300525 }
526
527 if (ret)
Rob Herring0d638a02017-06-01 15:50:55 -0500528 pr_err("changeset notifier error @%pOF\n", ce->np);
Frank Rowand24789c52017-10-17 16:36:26 -0700529 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300530}
531
532static int __of_changeset_entry_apply(struct of_changeset_entry *ce)
533{
534 struct property *old_prop, **propp;
535 unsigned long flags;
536 int ret = 0;
537
538 __of_changeset_entry_dump(ce);
539
540 raw_spin_lock_irqsave(&devtree_lock, flags);
541 switch (ce->action) {
542 case OF_RECONFIG_ATTACH_NODE:
543 __of_attach_node(ce->np);
544 break;
545 case OF_RECONFIG_DETACH_NODE:
546 __of_detach_node(ce->np);
547 break;
548 case OF_RECONFIG_ADD_PROPERTY:
549 /* If the property is in deadprops then it must be removed */
550 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
551 if (*propp == ce->prop) {
552 *propp = ce->prop->next;
553 ce->prop->next = NULL;
554 break;
555 }
556 }
557
558 ret = __of_add_property(ce->np, ce->prop);
559 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500560 pr_err("changeset: add_property failed @%pOF/%s\n",
561 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300562 ce->prop->name);
563 break;
564 }
565 break;
566 case OF_RECONFIG_REMOVE_PROPERTY:
567 ret = __of_remove_property(ce->np, ce->prop);
568 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500569 pr_err("changeset: remove_property failed @%pOF/%s\n",
570 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300571 ce->prop->name);
572 break;
573 }
574 break;
575
576 case OF_RECONFIG_UPDATE_PROPERTY:
577 /* If the property is in deadprops then it must be removed */
578 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
579 if (*propp == ce->prop) {
580 *propp = ce->prop->next;
581 ce->prop->next = NULL;
582 break;
583 }
584 }
585
586 ret = __of_update_property(ce->np, ce->prop, &old_prop);
587 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500588 pr_err("changeset: update_property failed @%pOF/%s\n",
589 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300590 ce->prop->name);
591 break;
592 }
593 break;
594 default:
595 ret = -EINVAL;
596 }
597 raw_spin_unlock_irqrestore(&devtree_lock, flags);
598
599 if (ret)
600 return ret;
601
602 switch (ce->action) {
603 case OF_RECONFIG_ATTACH_NODE:
604 __of_attach_node_sysfs(ce->np);
605 break;
606 case OF_RECONFIG_DETACH_NODE:
607 __of_detach_node_sysfs(ce->np);
608 break;
609 case OF_RECONFIG_ADD_PROPERTY:
610 /* ignore duplicate names */
611 __of_add_property_sysfs(ce->np, ce->prop);
612 break;
613 case OF_RECONFIG_REMOVE_PROPERTY:
614 __of_remove_property_sysfs(ce->np, ce->prop);
615 break;
616 case OF_RECONFIG_UPDATE_PROPERTY:
617 __of_update_property_sysfs(ce->np, ce->prop, ce->old_prop);
618 break;
619 }
620
621 return 0;
622}
623
624static inline int __of_changeset_entry_revert(struct of_changeset_entry *ce)
625{
626 struct of_changeset_entry ce_inverted;
627
628 __of_changeset_entry_invert(ce, &ce_inverted);
629 return __of_changeset_entry_apply(&ce_inverted);
630}
631
632/**
633 * of_changeset_init - Initialize a changeset for use
634 *
635 * @ocs: changeset pointer
636 *
637 * Initialize a changeset structure
638 */
639void of_changeset_init(struct of_changeset *ocs)
640{
641 memset(ocs, 0, sizeof(*ocs));
642 INIT_LIST_HEAD(&ocs->entries);
643}
Gavin Shan18322372015-11-05 00:12:49 +1100644EXPORT_SYMBOL_GPL(of_changeset_init);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300645
646/**
647 * of_changeset_destroy - Destroy a changeset
648 *
649 * @ocs: changeset pointer
650 *
651 * Destroys a changeset. Note that if a changeset is applied,
652 * its changes to the tree cannot be reverted.
653 */
654void of_changeset_destroy(struct of_changeset *ocs)
655{
656 struct of_changeset_entry *ce, *cen;
657
658 list_for_each_entry_safe_reverse(ce, cen, &ocs->entries, node)
659 __of_changeset_entry_destroy(ce);
660}
Gavin Shan18322372015-11-05 00:12:49 +1100661EXPORT_SYMBOL_GPL(of_changeset_destroy);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300662
Frank Rowand24789c52017-10-17 16:36:26 -0700663/*
664 * Apply the changeset entries in @ocs.
665 * If apply fails, an attempt is made to revert the entries that were
666 * successfully applied.
667 *
668 * If multiple revert errors occur then only the final revert error is reported.
669 *
670 * Returns 0 on success, a negative error value in case of an error.
671 * If a revert error occurs, it is returned in *ret_revert.
672 */
673int __of_changeset_apply_entries(struct of_changeset *ocs, int *ret_revert)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300674{
675 struct of_changeset_entry *ce;
Frank Rowand24789c52017-10-17 16:36:26 -0700676 int ret, ret_tmp;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300677
Rob Herring606ad422016-06-15 08:32:18 -0500678 pr_debug("changeset: applying...\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300679 list_for_each_entry(ce, &ocs->entries, node) {
680 ret = __of_changeset_entry_apply(ce);
681 if (ret) {
Rob Herring606ad422016-06-15 08:32:18 -0500682 pr_err("Error applying changeset (%d)\n", ret);
Frank Rowand24789c52017-10-17 16:36:26 -0700683 list_for_each_entry_continue_reverse(ce, &ocs->entries,
684 node) {
685 ret_tmp = __of_changeset_entry_revert(ce);
686 if (ret_tmp)
687 *ret_revert = ret_tmp;
688 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300689 return ret;
690 }
691 }
Frank Rowand24789c52017-10-17 16:36:26 -0700692
693 return 0;
694}
695
696/*
697 * Returns 0 on success, a negative error value in case of an error.
698 *
Geert Uytterhoevene9d92e42017-11-28 09:25:23 +0100699 * If multiple changeset entry notification errors occur then only the
Frank Rowand24789c52017-10-17 16:36:26 -0700700 * final notification error is reported.
701 */
702int __of_changeset_apply_notify(struct of_changeset *ocs)
703{
704 struct of_changeset_entry *ce;
705 int ret = 0, ret_tmp;
706
707 pr_debug("changeset: emitting notifiers.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300708
709 /* drop the global lock while emitting notifiers */
710 mutex_unlock(&of_mutex);
Frank Rowand24789c52017-10-17 16:36:26 -0700711 list_for_each_entry(ce, &ocs->entries, node) {
712 ret_tmp = __of_changeset_entry_notify(ce, 0);
713 if (ret_tmp)
714 ret = ret_tmp;
715 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300716 mutex_lock(&of_mutex);
Rob Herring606ad422016-06-15 08:32:18 -0500717 pr_debug("changeset: notifiers sent.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300718
Frank Rowand24789c52017-10-17 16:36:26 -0700719 return ret;
720}
721
722/*
723 * Returns 0 on success, a negative error value in case of an error.
724 *
725 * If a changeset entry apply fails, an attempt is made to revert any
726 * previous entries in the changeset. If any of the reverts fails,
727 * that failure is not reported. Thus the state of the device tree
728 * is unknown if an apply error occurs.
729 */
730static int __of_changeset_apply(struct of_changeset *ocs)
731{
732 int ret, ret_revert = 0;
733
734 ret = __of_changeset_apply_entries(ocs, &ret_revert);
735 if (!ret)
736 ret = __of_changeset_apply_notify(ocs);
737
738 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300739}
740
741/**
Gavin Shan18322372015-11-05 00:12:49 +1100742 * of_changeset_apply - Applies a changeset
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300743 *
744 * @ocs: changeset pointer
745 *
Gavin Shan18322372015-11-05 00:12:49 +1100746 * Applies a changeset to the live tree.
747 * Any side-effects of live tree state changes are applied here on
748 * success, like creation/destruction of devices and side-effects
749 * like creation of sysfs properties and directories.
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300750 * Returns 0 on success, a negative error value in case of an error.
Gavin Shan18322372015-11-05 00:12:49 +1100751 * On error the partially applied effects are reverted.
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300752 */
Gavin Shan18322372015-11-05 00:12:49 +1100753int of_changeset_apply(struct of_changeset *ocs)
754{
755 int ret;
756
757 mutex_lock(&of_mutex);
758 ret = __of_changeset_apply(ocs);
759 mutex_unlock(&of_mutex);
760
761 return ret;
762}
763EXPORT_SYMBOL_GPL(of_changeset_apply);
764
Frank Rowand24789c52017-10-17 16:36:26 -0700765/*
766 * Revert the changeset entries in @ocs.
767 * If revert fails, an attempt is made to re-apply the entries that were
768 * successfully removed.
769 *
770 * If multiple re-apply errors occur then only the final apply error is
771 * reported.
772 *
773 * Returns 0 on success, a negative error value in case of an error.
774 * If an apply error occurs, it is returned in *ret_apply.
775 */
776int __of_changeset_revert_entries(struct of_changeset *ocs, int *ret_apply)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300777{
778 struct of_changeset_entry *ce;
Frank Rowand24789c52017-10-17 16:36:26 -0700779 int ret, ret_tmp;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300780
Rob Herring606ad422016-06-15 08:32:18 -0500781 pr_debug("changeset: reverting...\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300782 list_for_each_entry_reverse(ce, &ocs->entries, node) {
783 ret = __of_changeset_entry_revert(ce);
784 if (ret) {
Rob Herring606ad422016-06-15 08:32:18 -0500785 pr_err("Error reverting changeset (%d)\n", ret);
Frank Rowand24789c52017-10-17 16:36:26 -0700786 list_for_each_entry_continue(ce, &ocs->entries, node) {
787 ret_tmp = __of_changeset_entry_apply(ce);
788 if (ret_tmp)
789 *ret_apply = ret_tmp;
790 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300791 return ret;
792 }
793 }
Frank Rowand24789c52017-10-17 16:36:26 -0700794
795 return 0;
796}
797
798/*
Geert Uytterhoevene9d92e42017-11-28 09:25:23 +0100799 * If multiple changeset entry notification errors occur then only the
Frank Rowand24789c52017-10-17 16:36:26 -0700800 * final notification error is reported.
801 */
802int __of_changeset_revert_notify(struct of_changeset *ocs)
803{
804 struct of_changeset_entry *ce;
805 int ret = 0, ret_tmp;
806
807 pr_debug("changeset: emitting notifiers.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300808
809 /* drop the global lock while emitting notifiers */
810 mutex_unlock(&of_mutex);
Frank Rowand24789c52017-10-17 16:36:26 -0700811 list_for_each_entry_reverse(ce, &ocs->entries, node) {
812 ret_tmp = __of_changeset_entry_notify(ce, 1);
813 if (ret_tmp)
814 ret = ret_tmp;
815 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300816 mutex_lock(&of_mutex);
Rob Herring606ad422016-06-15 08:32:18 -0500817 pr_debug("changeset: notifiers sent.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300818
Frank Rowand24789c52017-10-17 16:36:26 -0700819 return ret;
820}
821
822static int __of_changeset_revert(struct of_changeset *ocs)
823{
824 int ret, ret_reply;
825
826 ret_reply = 0;
827 ret = __of_changeset_revert_entries(ocs, &ret_reply);
828
829 if (!ret)
830 ret = __of_changeset_revert_notify(ocs);
831
832 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300833}
834
835/**
Gavin Shan18322372015-11-05 00:12:49 +1100836 * of_changeset_revert - Reverts an applied changeset
837 *
838 * @ocs: changeset pointer
839 *
840 * Reverts a changeset returning the state of the tree to what it
841 * was before the application.
842 * Any side-effects like creation/destruction of devices and
843 * removal of sysfs properties and directories are applied.
844 * Returns 0 on success, a negative error value in case of an error.
845 */
846int of_changeset_revert(struct of_changeset *ocs)
847{
848 int ret;
849
850 mutex_lock(&of_mutex);
851 ret = __of_changeset_revert(ocs);
852 mutex_unlock(&of_mutex);
853
854 return ret;
855}
856EXPORT_SYMBOL_GPL(of_changeset_revert);
857
858/**
Frank Rowand0290c4c2017-10-17 16:36:23 -0700859 * of_changeset_action - Add an action to the tail of the changeset list
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300860 *
861 * @ocs: changeset pointer
862 * @action: action to perform
863 * @np: Pointer to device node
864 * @prop: Pointer to property
865 *
866 * On action being one of:
867 * + OF_RECONFIG_ATTACH_NODE
868 * + OF_RECONFIG_DETACH_NODE,
869 * + OF_RECONFIG_ADD_PROPERTY
870 * + OF_RECONFIG_REMOVE_PROPERTY,
871 * + OF_RECONFIG_UPDATE_PROPERTY
872 * Returns 0 on success, a negative error value in case of an error.
873 */
874int of_changeset_action(struct of_changeset *ocs, unsigned long action,
875 struct device_node *np, struct property *prop)
876{
877 struct of_changeset_entry *ce;
878
879 ce = kzalloc(sizeof(*ce), GFP_KERNEL);
Rob Herring606ad422016-06-15 08:32:18 -0500880 if (!ce)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300881 return -ENOMEM;
Rob Herring606ad422016-06-15 08:32:18 -0500882
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300883 /* get a reference to the node */
884 ce->action = action;
885 ce->np = of_node_get(np);
886 ce->prop = prop;
887
888 if (action == OF_RECONFIG_UPDATE_PROPERTY && prop)
889 ce->old_prop = of_find_property(np, prop->name, NULL);
890
891 /* add it to the list */
892 list_add_tail(&ce->node, &ocs->entries);
893 return 0;
894}
Gavin Shan18322372015-11-05 00:12:49 +1100895EXPORT_SYMBOL_GPL(of_changeset_action);