blob: ab988d88704da0d2d583a9280dba31d671a5fa14 [file] [log] [blame]
Grant Likely6afc0dc2014-06-26 15:40:48 +01001/*
2 * Support for dynamic device trees.
3 *
4 * On some platforms, the device tree can be manipulated at runtime.
5 * The routines in this section support adding, removing and changing
6 * device tree nodes.
7 */
8
Rob Herring606ad422016-06-15 08:32:18 -05009#define pr_fmt(fmt) "OF: " fmt
10
Grant Likely6afc0dc2014-06-26 15:40:48 +010011#include <linux/of.h>
12#include <linux/spinlock.h>
13#include <linux/slab.h>
14#include <linux/string.h>
15#include <linux/proc_fs.h>
16
17#include "of_private.h"
18
Rob Herring4c2bb572017-10-04 19:30:53 -050019static struct device_node *kobj_to_device_node(struct kobject *kobj)
20{
21 return container_of(kobj, struct device_node, kobj);
22}
23
Grant Likely6afc0dc2014-06-26 15:40:48 +010024/**
25 * of_node_get() - Increment refcount of a node
26 * @node: Node to inc refcount, NULL is supported to simplify writing of
27 * callers
28 *
29 * Returns node.
30 */
31struct device_node *of_node_get(struct device_node *node)
32{
33 if (node)
34 kobject_get(&node->kobj);
35 return node;
36}
37EXPORT_SYMBOL(of_node_get);
38
39/**
40 * of_node_put() - Decrement refcount of a node
41 * @node: Node to dec refcount, NULL is supported to simplify writing of
42 * callers
43 */
44void of_node_put(struct device_node *node)
45{
46 if (node)
47 kobject_put(&node->kobj);
48}
49EXPORT_SYMBOL(of_node_put);
50
Grant Likely6afc0dc2014-06-26 15:40:48 +010051static BLOCKING_NOTIFIER_HEAD(of_reconfig_chain);
52
53int of_reconfig_notifier_register(struct notifier_block *nb)
54{
55 return blocking_notifier_chain_register(&of_reconfig_chain, nb);
56}
57EXPORT_SYMBOL_GPL(of_reconfig_notifier_register);
58
59int of_reconfig_notifier_unregister(struct notifier_block *nb)
60{
61 return blocking_notifier_chain_unregister(&of_reconfig_chain, nb);
62}
63EXPORT_SYMBOL_GPL(of_reconfig_notifier_unregister);
64
Grant Likely00aa3722014-11-14 14:34:55 +000065#ifdef DEBUG
66const char *action_names[] = {
67 [OF_RECONFIG_ATTACH_NODE] = "ATTACH_NODE",
68 [OF_RECONFIG_DETACH_NODE] = "DETACH_NODE",
69 [OF_RECONFIG_ADD_PROPERTY] = "ADD_PROPERTY",
70 [OF_RECONFIG_REMOVE_PROPERTY] = "REMOVE_PROPERTY",
71 [OF_RECONFIG_UPDATE_PROPERTY] = "UPDATE_PROPERTY",
72};
73#endif
74
Grant Likelyf5242e52014-11-24 17:58:01 +000075int of_reconfig_notify(unsigned long action, struct of_reconfig_data *p)
Grant Likely6afc0dc2014-06-26 15:40:48 +010076{
77 int rc;
Grant Likely00aa3722014-11-14 14:34:55 +000078#ifdef DEBUG
Grant Likelyf5242e52014-11-24 17:58:01 +000079 struct of_reconfig_data *pr = p;
Grant Likely6afc0dc2014-06-26 15:40:48 +010080
Grant Likely00aa3722014-11-14 14:34:55 +000081 switch (action) {
82 case OF_RECONFIG_ATTACH_NODE:
83 case OF_RECONFIG_DETACH_NODE:
Rob Herring0d638a02017-06-01 15:50:55 -050084 pr_debug("notify %-15s %pOF\n", action_names[action],
85 pr->dn);
Grant Likely00aa3722014-11-14 14:34:55 +000086 break;
87 case OF_RECONFIG_ADD_PROPERTY:
88 case OF_RECONFIG_REMOVE_PROPERTY:
89 case OF_RECONFIG_UPDATE_PROPERTY:
Rob Herring0d638a02017-06-01 15:50:55 -050090 pr_debug("notify %-15s %pOF:%s\n", action_names[action],
91 pr->dn, pr->prop->name);
Grant Likely00aa3722014-11-14 14:34:55 +000092 break;
93
94 }
95#endif
Grant Likely6afc0dc2014-06-26 15:40:48 +010096 rc = blocking_notifier_call_chain(&of_reconfig_chain, action, p);
97 return notifier_to_errno(rc);
98}
99
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200100/*
101 * of_reconfig_get_state_change() - Returns new state of device
102 * @action - action of the of notifier
103 * @arg - argument of the of notifier
104 *
105 * Returns the new state of a device based on the notifier used.
106 * Returns 0 on device going from enabled to disabled, 1 on device
107 * going from disabled to enabled and -1 on no change.
108 */
Grant Likelyf5242e52014-11-24 17:58:01 +0000109int of_reconfig_get_state_change(unsigned long action, struct of_reconfig_data *pr)
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200110{
Grant Likelyf5242e52014-11-24 17:58:01 +0000111 struct property *prop, *old_prop = NULL;
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200112 int is_status, status_state, old_status_state, prev_state, new_state;
113
114 /* figure out if a device should be created or destroyed */
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200115 switch (action) {
116 case OF_RECONFIG_ATTACH_NODE:
117 case OF_RECONFIG_DETACH_NODE:
Grant Likelyf5242e52014-11-24 17:58:01 +0000118 prop = of_find_property(pr->dn, "status", NULL);
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200119 break;
120 case OF_RECONFIG_ADD_PROPERTY:
121 case OF_RECONFIG_REMOVE_PROPERTY:
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200122 prop = pr->prop;
123 break;
124 case OF_RECONFIG_UPDATE_PROPERTY:
Pantelis Antonioub53a2342014-10-28 22:33:53 +0200125 prop = pr->prop;
126 old_prop = pr->old_prop;
127 break;
128 default:
129 return OF_RECONFIG_NO_CHANGE;
130 }
131
132 is_status = 0;
133 status_state = -1;
134 old_status_state = -1;
135 prev_state = -1;
136 new_state = -1;
137
138 if (prop && !strcmp(prop->name, "status")) {
139 is_status = 1;
140 status_state = !strcmp(prop->value, "okay") ||
141 !strcmp(prop->value, "ok");
142 if (old_prop)
143 old_status_state = !strcmp(old_prop->value, "okay") ||
144 !strcmp(old_prop->value, "ok");
145 }
146
147 switch (action) {
148 case OF_RECONFIG_ATTACH_NODE:
149 prev_state = 0;
150 /* -1 & 0 status either missing or okay */
151 new_state = status_state != 0;
152 break;
153 case OF_RECONFIG_DETACH_NODE:
154 /* -1 & 0 status either missing or okay */
155 prev_state = status_state != 0;
156 new_state = 0;
157 break;
158 case OF_RECONFIG_ADD_PROPERTY:
159 if (is_status) {
160 /* no status property -> enabled (legacy) */
161 prev_state = 1;
162 new_state = status_state;
163 }
164 break;
165 case OF_RECONFIG_REMOVE_PROPERTY:
166 if (is_status) {
167 prev_state = status_state;
168 /* no status property -> enabled (legacy) */
169 new_state = 1;
170 }
171 break;
172 case OF_RECONFIG_UPDATE_PROPERTY:
173 if (is_status) {
174 prev_state = old_status_state != 0;
175 new_state = status_state != 0;
176 }
177 break;
178 }
179
180 if (prev_state == new_state)
181 return OF_RECONFIG_NO_CHANGE;
182
183 return new_state ? OF_RECONFIG_CHANGE_ADD : OF_RECONFIG_CHANGE_REMOVE;
184}
185EXPORT_SYMBOL_GPL(of_reconfig_get_state_change);
186
Grant Likely6afc0dc2014-06-26 15:40:48 +0100187int of_property_notify(int action, struct device_node *np,
Grant Likely259092a2014-07-16 12:48:23 -0600188 struct property *prop, struct property *oldprop)
Grant Likely6afc0dc2014-06-26 15:40:48 +0100189{
Grant Likelyf5242e52014-11-24 17:58:01 +0000190 struct of_reconfig_data pr;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100191
192 /* only call notifiers if the node is attached */
193 if (!of_node_is_attached(np))
194 return 0;
195
196 pr.dn = np;
197 pr.prop = prop;
Grant Likely259092a2014-07-16 12:48:23 -0600198 pr.old_prop = oldprop;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100199 return of_reconfig_notify(action, &pr);
200}
201
Frank Rowand249969512017-06-21 12:16:38 -0700202static void __of_attach_node(struct device_node *np)
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300203{
Grant Likelya25095d2014-07-15 23:25:43 -0600204 const __be32 *phandle;
205 int sz;
206
207 np->name = __of_get_property(np, "name", NULL) ? : "<NULL>";
208 np->type = __of_get_property(np, "device_type", NULL) ? : "<NULL>";
209
210 phandle = __of_get_property(np, "phandle", &sz);
211 if (!phandle)
212 phandle = __of_get_property(np, "linux,phandle", &sz);
Geert Uytterhoevenf76502a2015-06-04 11:34:41 +0200213 if (IS_ENABLED(CONFIG_PPC_PSERIES) && !phandle)
Grant Likelya25095d2014-07-15 23:25:43 -0600214 phandle = __of_get_property(np, "ibm,phandle", &sz);
215 np->phandle = (phandle && (sz >= 4)) ? be32_to_cpup(phandle) : 0;
216
Grant Likely6162dbe2014-07-16 08:48:46 -0600217 np->child = NULL;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300218 np->sibling = np->parent->child;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300219 np->parent->child = np;
220 of_node_clear_flag(np, OF_DETACHED);
221}
222
Grant Likely6afc0dc2014-06-26 15:40:48 +0100223/**
224 * of_attach_node() - Plug a device node into the tree and global list.
225 */
226int of_attach_node(struct device_node *np)
227{
Grant Likelyf5242e52014-11-24 17:58:01 +0000228 struct of_reconfig_data rd;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100229 unsigned long flags;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100230
Grant Likelyf5242e52014-11-24 17:58:01 +0000231 memset(&rd, 0, sizeof(rd));
232 rd.dn = np;
233
Grant Likely8a2b22a2014-07-23 17:05:06 -0600234 mutex_lock(&of_mutex);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100235 raw_spin_lock_irqsave(&devtree_lock, flags);
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300236 __of_attach_node(np);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100237 raw_spin_unlock_irqrestore(&devtree_lock, flags);
238
Grant Likely8a2b22a2014-07-23 17:05:06 -0600239 __of_attach_node_sysfs(np);
240 mutex_unlock(&of_mutex);
Grant Likely259092a2014-07-16 12:48:23 -0600241
Grant Likelyf5242e52014-11-24 17:58:01 +0000242 of_reconfig_notify(OF_RECONFIG_ATTACH_NODE, &rd);
Grant Likely259092a2014-07-16 12:48:23 -0600243
Grant Likely6afc0dc2014-06-26 15:40:48 +0100244 return 0;
245}
246
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300247void __of_detach_node(struct device_node *np)
Grant Likely6afc0dc2014-06-26 15:40:48 +0100248{
249 struct device_node *parent;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100250
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300251 if (WARN_ON(of_node_check_flag(np, OF_DETACHED)))
252 return;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100253
254 parent = np->parent;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300255 if (WARN_ON(!parent))
256 return;
Grant Likely6afc0dc2014-06-26 15:40:48 +0100257
Grant Likely6afc0dc2014-06-26 15:40:48 +0100258 if (parent->child == np)
259 parent->child = np->sibling;
260 else {
261 struct device_node *prevsib;
262 for (prevsib = np->parent->child;
263 prevsib->sibling != np;
264 prevsib = prevsib->sibling)
265 ;
266 prevsib->sibling = np->sibling;
267 }
268
269 of_node_set_flag(np, OF_DETACHED);
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300270}
271
272/**
273 * of_detach_node() - "Unplug" a node from the device tree.
274 *
275 * The caller must hold a reference to the node. The memory associated with
276 * the node is not freed until its refcount goes to zero.
277 */
278int of_detach_node(struct device_node *np)
279{
Grant Likelyf5242e52014-11-24 17:58:01 +0000280 struct of_reconfig_data rd;
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300281 unsigned long flags;
282 int rc = 0;
283
Grant Likelyf5242e52014-11-24 17:58:01 +0000284 memset(&rd, 0, sizeof(rd));
285 rd.dn = np;
286
Grant Likely8a2b22a2014-07-23 17:05:06 -0600287 mutex_lock(&of_mutex);
Pantelis Antonioud8c50082014-07-04 19:58:46 +0300288 raw_spin_lock_irqsave(&devtree_lock, flags);
289 __of_detach_node(np);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100290 raw_spin_unlock_irqrestore(&devtree_lock, flags);
291
Grant Likely8a2b22a2014-07-23 17:05:06 -0600292 __of_detach_node_sysfs(np);
293 mutex_unlock(&of_mutex);
Grant Likely259092a2014-07-16 12:48:23 -0600294
Grant Likelyf5242e52014-11-24 17:58:01 +0000295 of_reconfig_notify(OF_RECONFIG_DETACH_NODE, &rd);
Grant Likely259092a2014-07-16 12:48:23 -0600296
Grant Likely6afc0dc2014-06-26 15:40:48 +0100297 return rc;
298}
Gavin Shanbb91f922016-05-03 23:22:52 +1000299EXPORT_SYMBOL_GPL(of_detach_node);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100300
Lixin Wang070ea012017-10-23 11:19:53 +0800301static void property_list_free(struct property *prop_list)
302{
303 struct property *prop, *next;
304
305 for (prop = prop_list; prop != NULL; prop = next) {
306 next = prop->next;
307 kfree(prop->name);
308 kfree(prop->value);
309 kfree(prop);
310 }
311}
312
Grant Likely6afc0dc2014-06-26 15:40:48 +0100313/**
314 * of_node_release() - release a dynamically allocated node
315 * @kref: kref element of the node to be released
316 *
317 * In of_node_put() this function is passed to kref_put() as the destructor.
318 */
319void of_node_release(struct kobject *kobj)
320{
321 struct device_node *node = kobj_to_device_node(kobj);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100322
323 /* We should never be releasing nodes that haven't been detached. */
324 if (!of_node_check_flag(node, OF_DETACHED)) {
Rob Herring0d638a02017-06-01 15:50:55 -0500325 pr_err("ERROR: Bad of_node_put() on %pOF\n", node);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100326 dump_stack();
327 return;
328 }
Grant Likely6afc0dc2014-06-26 15:40:48 +0100329 if (!of_node_check_flag(node, OF_DYNAMIC))
330 return;
331
Lixin Wang070ea012017-10-23 11:19:53 +0800332 property_list_free(node->properties);
333 property_list_free(node->deadprops);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100334
Grant Likely6afc0dc2014-06-26 15:40:48 +0100335 kfree(node->full_name);
336 kfree(node->data);
337 kfree(node);
338}
Pantelis Antoniou69843392014-07-04 19:58:47 +0300339
340/**
341 * __of_prop_dup - Copy a property dynamically.
342 * @prop: Property to copy
343 * @allocflags: Allocation flags (typically pass GFP_KERNEL)
344 *
345 * Copy a property by dynamically allocating the memory of both the
Geert Uytterhoeven27b33832014-10-22 11:49:01 +0200346 * property structure and the property name & contents. The property's
Pantelis Antoniou69843392014-07-04 19:58:47 +0300347 * flags have the OF_DYNAMIC bit set so that we can differentiate between
348 * dynamically allocated properties and not.
349 * Returns the newly allocated property or NULL on out of memory error.
350 */
351struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags)
352{
353 struct property *new;
354
355 new = kzalloc(sizeof(*new), allocflags);
356 if (!new)
357 return NULL;
358
359 /*
360 * NOTE: There is no check for zero length value.
Grant Likelyb6ae5dc2014-07-26 10:58:43 -0600361 * In case of a boolean property, this will allocate a value
Pantelis Antoniou69843392014-07-04 19:58:47 +0300362 * of zero bytes. We do this to work around the use
363 * of of_get_property() calls on boolean values.
364 */
365 new->name = kstrdup(prop->name, allocflags);
366 new->value = kmemdup(prop->value, prop->length, allocflags);
367 new->length = prop->length;
368 if (!new->name || !new->value)
369 goto err_free;
370
371 /* mark the property as dynamic */
372 of_property_set_flag(new, OF_DYNAMIC);
373
374 return new;
375
376 err_free:
377 kfree(new->name);
378 kfree(new->value);
379 kfree(new);
380 return NULL;
381}
382
383/**
Grant Likelye5179582014-11-17 22:31:32 +0000384 * __of_node_dup() - Duplicate or create an empty device node dynamically.
385 * @fmt: Format string (plus vargs) for new full name of the device node
Pantelis Antoniou69843392014-07-04 19:58:47 +0300386 *
Grant Likelye5179582014-11-17 22:31:32 +0000387 * Create an device tree node, either by duplicating an empty node or by allocating
388 * an empty one suitable for further modification. The node data are
389 * dynamically allocated and all the node flags have the OF_DYNAMIC &
390 * OF_DETACHED bits set. Returns the newly allocated node or NULL on out of
391 * memory error.
Pantelis Antoniou69843392014-07-04 19:58:47 +0300392 */
Grant Likelye5179582014-11-17 22:31:32 +0000393struct device_node *__of_node_dup(const struct device_node *np, const char *fmt, ...)
Pantelis Antoniou69843392014-07-04 19:58:47 +0300394{
Grant Likelyef8bbd72014-11-14 15:33:07 +0000395 va_list vargs;
Pantelis Antoniou69843392014-07-04 19:58:47 +0300396 struct device_node *node;
397
Grant Likelyef8bbd72014-11-14 15:33:07 +0000398 node = kzalloc(sizeof(*node), GFP_KERNEL);
Pantelis Antoniou69843392014-07-04 19:58:47 +0300399 if (!node)
400 return NULL;
Grant Likelyef8bbd72014-11-14 15:33:07 +0000401 va_start(vargs, fmt);
402 node->full_name = kvasprintf(GFP_KERNEL, fmt, vargs);
403 va_end(vargs);
Grant Likelye5179582014-11-17 22:31:32 +0000404 if (!node->full_name) {
405 kfree(node);
406 return NULL;
407 }
Pantelis Antoniou69843392014-07-04 19:58:47 +0300408
Grant Likelyef8bbd72014-11-14 15:33:07 +0000409 of_node_set_flag(node, OF_DYNAMIC);
410 of_node_set_flag(node, OF_DETACHED);
Pantelis Antoniou69843392014-07-04 19:58:47 +0300411 of_node_init(node);
412
Grant Likelye5179582014-11-17 22:31:32 +0000413 /* Iterate over and duplicate all properties */
414 if (np) {
415 struct property *pp, *new_pp;
416 for_each_property_of_node(np, pp) {
417 new_pp = __of_prop_dup(pp, GFP_KERNEL);
418 if (!new_pp)
419 goto err_prop;
420 if (__of_add_property(node, new_pp)) {
421 kfree(new_pp->name);
422 kfree(new_pp->value);
423 kfree(new_pp);
424 goto err_prop;
425 }
426 }
427 }
Pantelis Antoniou69843392014-07-04 19:58:47 +0300428 return node;
429
Grant Likelye5179582014-11-17 22:31:32 +0000430 err_prop:
431 of_node_put(node); /* Frees the node and properties */
Pantelis Antoniou69843392014-07-04 19:58:47 +0300432 return NULL;
433}
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300434
435static void __of_changeset_entry_destroy(struct of_changeset_entry *ce)
436{
437 of_node_put(ce->np);
438 list_del(&ce->node);
439 kfree(ce);
440}
441
442#ifdef DEBUG
443static void __of_changeset_entry_dump(struct of_changeset_entry *ce)
444{
445 switch (ce->action) {
446 case OF_RECONFIG_ADD_PROPERTY:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300447 case OF_RECONFIG_REMOVE_PROPERTY:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300448 case OF_RECONFIG_UPDATE_PROPERTY:
Rob Herring0d638a02017-06-01 15:50:55 -0500449 pr_debug("cset<%p> %-15s %pOF/%s\n", ce, action_names[ce->action],
450 ce->np, ce->prop->name);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300451 break;
452 case OF_RECONFIG_ATTACH_NODE:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300453 case OF_RECONFIG_DETACH_NODE:
Rob Herring0d638a02017-06-01 15:50:55 -0500454 pr_debug("cset<%p> %-15s %pOF\n", ce, action_names[ce->action],
455 ce->np);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300456 break;
457 }
458}
459#else
460static inline void __of_changeset_entry_dump(struct of_changeset_entry *ce)
461{
462 /* empty */
463}
464#endif
465
466static void __of_changeset_entry_invert(struct of_changeset_entry *ce,
467 struct of_changeset_entry *rce)
468{
469 memcpy(rce, ce, sizeof(*rce));
470
471 switch (ce->action) {
472 case OF_RECONFIG_ATTACH_NODE:
473 rce->action = OF_RECONFIG_DETACH_NODE;
474 break;
475 case OF_RECONFIG_DETACH_NODE:
476 rce->action = OF_RECONFIG_ATTACH_NODE;
477 break;
478 case OF_RECONFIG_ADD_PROPERTY:
479 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
480 break;
481 case OF_RECONFIG_REMOVE_PROPERTY:
482 rce->action = OF_RECONFIG_ADD_PROPERTY;
483 break;
484 case OF_RECONFIG_UPDATE_PROPERTY:
485 rce->old_prop = ce->prop;
486 rce->prop = ce->old_prop;
Pantelis Antonioub9c43852016-05-09 16:20:42 +0300487 /* update was used but original property did not exist */
488 if (!rce->prop) {
489 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
490 rce->prop = ce->prop;
491 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300492 break;
493 }
494}
495
Frank Rowand24789c52017-10-17 16:36:26 -0700496static int __of_changeset_entry_notify(struct of_changeset_entry *ce,
497 bool revert)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300498{
Grant Likelyf5242e52014-11-24 17:58:01 +0000499 struct of_reconfig_data rd;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300500 struct of_changeset_entry ce_inverted;
Frank Rowand24789c52017-10-17 16:36:26 -0700501 int ret = 0;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300502
503 if (revert) {
504 __of_changeset_entry_invert(ce, &ce_inverted);
505 ce = &ce_inverted;
506 }
507
508 switch (ce->action) {
509 case OF_RECONFIG_ATTACH_NODE:
510 case OF_RECONFIG_DETACH_NODE:
Grant Likelyf5242e52014-11-24 17:58:01 +0000511 memset(&rd, 0, sizeof(rd));
512 rd.dn = ce->np;
513 ret = of_reconfig_notify(ce->action, &rd);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300514 break;
515 case OF_RECONFIG_ADD_PROPERTY:
516 case OF_RECONFIG_REMOVE_PROPERTY:
517 case OF_RECONFIG_UPDATE_PROPERTY:
518 ret = of_property_notify(ce->action, ce->np, ce->prop, ce->old_prop);
519 break;
520 default:
Rob Herring606ad422016-06-15 08:32:18 -0500521 pr_err("invalid devicetree changeset action: %i\n",
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300522 (int)ce->action);
Frank Rowand24789c52017-10-17 16:36:26 -0700523 ret = -EINVAL;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300524 }
525
526 if (ret)
Rob Herring0d638a02017-06-01 15:50:55 -0500527 pr_err("changeset notifier error @%pOF\n", ce->np);
Frank Rowand24789c52017-10-17 16:36:26 -0700528 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300529}
530
531static int __of_changeset_entry_apply(struct of_changeset_entry *ce)
532{
533 struct property *old_prop, **propp;
534 unsigned long flags;
535 int ret = 0;
536
537 __of_changeset_entry_dump(ce);
538
539 raw_spin_lock_irqsave(&devtree_lock, flags);
540 switch (ce->action) {
541 case OF_RECONFIG_ATTACH_NODE:
542 __of_attach_node(ce->np);
543 break;
544 case OF_RECONFIG_DETACH_NODE:
545 __of_detach_node(ce->np);
546 break;
547 case OF_RECONFIG_ADD_PROPERTY:
548 /* If the property is in deadprops then it must be removed */
549 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
550 if (*propp == ce->prop) {
551 *propp = ce->prop->next;
552 ce->prop->next = NULL;
553 break;
554 }
555 }
556
557 ret = __of_add_property(ce->np, ce->prop);
558 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500559 pr_err("changeset: add_property failed @%pOF/%s\n",
560 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300561 ce->prop->name);
562 break;
563 }
564 break;
565 case OF_RECONFIG_REMOVE_PROPERTY:
566 ret = __of_remove_property(ce->np, ce->prop);
567 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500568 pr_err("changeset: remove_property failed @%pOF/%s\n",
569 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300570 ce->prop->name);
571 break;
572 }
573 break;
574
575 case OF_RECONFIG_UPDATE_PROPERTY:
576 /* If the property is in deadprops then it must be removed */
577 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
578 if (*propp == ce->prop) {
579 *propp = ce->prop->next;
580 ce->prop->next = NULL;
581 break;
582 }
583 }
584
585 ret = __of_update_property(ce->np, ce->prop, &old_prop);
586 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500587 pr_err("changeset: update_property failed @%pOF/%s\n",
588 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300589 ce->prop->name);
590 break;
591 }
592 break;
593 default:
594 ret = -EINVAL;
595 }
596 raw_spin_unlock_irqrestore(&devtree_lock, flags);
597
598 if (ret)
599 return ret;
600
601 switch (ce->action) {
602 case OF_RECONFIG_ATTACH_NODE:
603 __of_attach_node_sysfs(ce->np);
604 break;
605 case OF_RECONFIG_DETACH_NODE:
606 __of_detach_node_sysfs(ce->np);
607 break;
608 case OF_RECONFIG_ADD_PROPERTY:
609 /* ignore duplicate names */
610 __of_add_property_sysfs(ce->np, ce->prop);
611 break;
612 case OF_RECONFIG_REMOVE_PROPERTY:
613 __of_remove_property_sysfs(ce->np, ce->prop);
614 break;
615 case OF_RECONFIG_UPDATE_PROPERTY:
616 __of_update_property_sysfs(ce->np, ce->prop, ce->old_prop);
617 break;
618 }
619
620 return 0;
621}
622
623static inline int __of_changeset_entry_revert(struct of_changeset_entry *ce)
624{
625 struct of_changeset_entry ce_inverted;
626
627 __of_changeset_entry_invert(ce, &ce_inverted);
628 return __of_changeset_entry_apply(&ce_inverted);
629}
630
631/**
632 * of_changeset_init - Initialize a changeset for use
633 *
634 * @ocs: changeset pointer
635 *
636 * Initialize a changeset structure
637 */
638void of_changeset_init(struct of_changeset *ocs)
639{
640 memset(ocs, 0, sizeof(*ocs));
641 INIT_LIST_HEAD(&ocs->entries);
642}
Gavin Shan18322372015-11-05 00:12:49 +1100643EXPORT_SYMBOL_GPL(of_changeset_init);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300644
645/**
646 * of_changeset_destroy - Destroy a changeset
647 *
648 * @ocs: changeset pointer
649 *
650 * Destroys a changeset. Note that if a changeset is applied,
651 * its changes to the tree cannot be reverted.
652 */
653void of_changeset_destroy(struct of_changeset *ocs)
654{
655 struct of_changeset_entry *ce, *cen;
656
657 list_for_each_entry_safe_reverse(ce, cen, &ocs->entries, node)
658 __of_changeset_entry_destroy(ce);
659}
Gavin Shan18322372015-11-05 00:12:49 +1100660EXPORT_SYMBOL_GPL(of_changeset_destroy);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300661
Frank Rowand24789c52017-10-17 16:36:26 -0700662/*
663 * Apply the changeset entries in @ocs.
664 * If apply fails, an attempt is made to revert the entries that were
665 * successfully applied.
666 *
667 * If multiple revert errors occur then only the final revert error is reported.
668 *
669 * Returns 0 on success, a negative error value in case of an error.
670 * If a revert error occurs, it is returned in *ret_revert.
671 */
672int __of_changeset_apply_entries(struct of_changeset *ocs, int *ret_revert)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300673{
674 struct of_changeset_entry *ce;
Frank Rowand24789c52017-10-17 16:36:26 -0700675 int ret, ret_tmp;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300676
Rob Herring606ad422016-06-15 08:32:18 -0500677 pr_debug("changeset: applying...\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300678 list_for_each_entry(ce, &ocs->entries, node) {
679 ret = __of_changeset_entry_apply(ce);
680 if (ret) {
Rob Herring606ad422016-06-15 08:32:18 -0500681 pr_err("Error applying changeset (%d)\n", ret);
Frank Rowand24789c52017-10-17 16:36:26 -0700682 list_for_each_entry_continue_reverse(ce, &ocs->entries,
683 node) {
684 ret_tmp = __of_changeset_entry_revert(ce);
685 if (ret_tmp)
686 *ret_revert = ret_tmp;
687 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300688 return ret;
689 }
690 }
Frank Rowand24789c52017-10-17 16:36:26 -0700691
692 return 0;
693}
694
695/*
696 * Returns 0 on success, a negative error value in case of an error.
697 *
Geert Uytterhoevene9d92e42017-11-28 09:25:23 +0100698 * If multiple changeset entry notification errors occur then only the
Frank Rowand24789c52017-10-17 16:36:26 -0700699 * final notification error is reported.
700 */
701int __of_changeset_apply_notify(struct of_changeset *ocs)
702{
703 struct of_changeset_entry *ce;
704 int ret = 0, ret_tmp;
705
706 pr_debug("changeset: emitting notifiers.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300707
708 /* drop the global lock while emitting notifiers */
709 mutex_unlock(&of_mutex);
Frank Rowand24789c52017-10-17 16:36:26 -0700710 list_for_each_entry(ce, &ocs->entries, node) {
711 ret_tmp = __of_changeset_entry_notify(ce, 0);
712 if (ret_tmp)
713 ret = ret_tmp;
714 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300715 mutex_lock(&of_mutex);
Rob Herring606ad422016-06-15 08:32:18 -0500716 pr_debug("changeset: notifiers sent.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300717
Frank Rowand24789c52017-10-17 16:36:26 -0700718 return ret;
719}
720
721/*
722 * Returns 0 on success, a negative error value in case of an error.
723 *
724 * If a changeset entry apply fails, an attempt is made to revert any
725 * previous entries in the changeset. If any of the reverts fails,
726 * that failure is not reported. Thus the state of the device tree
727 * is unknown if an apply error occurs.
728 */
729static int __of_changeset_apply(struct of_changeset *ocs)
730{
731 int ret, ret_revert = 0;
732
733 ret = __of_changeset_apply_entries(ocs, &ret_revert);
734 if (!ret)
735 ret = __of_changeset_apply_notify(ocs);
736
737 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300738}
739
740/**
Gavin Shan18322372015-11-05 00:12:49 +1100741 * of_changeset_apply - Applies a changeset
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300742 *
743 * @ocs: changeset pointer
744 *
Gavin Shan18322372015-11-05 00:12:49 +1100745 * Applies a changeset to the live tree.
746 * Any side-effects of live tree state changes are applied here on
747 * success, like creation/destruction of devices and side-effects
748 * like creation of sysfs properties and directories.
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300749 * Returns 0 on success, a negative error value in case of an error.
Gavin Shan18322372015-11-05 00:12:49 +1100750 * On error the partially applied effects are reverted.
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300751 */
Gavin Shan18322372015-11-05 00:12:49 +1100752int of_changeset_apply(struct of_changeset *ocs)
753{
754 int ret;
755
756 mutex_lock(&of_mutex);
757 ret = __of_changeset_apply(ocs);
758 mutex_unlock(&of_mutex);
759
760 return ret;
761}
762EXPORT_SYMBOL_GPL(of_changeset_apply);
763
Frank Rowand24789c52017-10-17 16:36:26 -0700764/*
765 * Revert the changeset entries in @ocs.
766 * If revert fails, an attempt is made to re-apply the entries that were
767 * successfully removed.
768 *
769 * If multiple re-apply errors occur then only the final apply error is
770 * reported.
771 *
772 * Returns 0 on success, a negative error value in case of an error.
773 * If an apply error occurs, it is returned in *ret_apply.
774 */
775int __of_changeset_revert_entries(struct of_changeset *ocs, int *ret_apply)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300776{
777 struct of_changeset_entry *ce;
Frank Rowand24789c52017-10-17 16:36:26 -0700778 int ret, ret_tmp;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300779
Rob Herring606ad422016-06-15 08:32:18 -0500780 pr_debug("changeset: reverting...\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300781 list_for_each_entry_reverse(ce, &ocs->entries, node) {
782 ret = __of_changeset_entry_revert(ce);
783 if (ret) {
Rob Herring606ad422016-06-15 08:32:18 -0500784 pr_err("Error reverting changeset (%d)\n", ret);
Frank Rowand24789c52017-10-17 16:36:26 -0700785 list_for_each_entry_continue(ce, &ocs->entries, node) {
786 ret_tmp = __of_changeset_entry_apply(ce);
787 if (ret_tmp)
788 *ret_apply = ret_tmp;
789 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300790 return ret;
791 }
792 }
Frank Rowand24789c52017-10-17 16:36:26 -0700793
794 return 0;
795}
796
797/*
Geert Uytterhoevene9d92e42017-11-28 09:25:23 +0100798 * If multiple changeset entry notification errors occur then only the
Frank Rowand24789c52017-10-17 16:36:26 -0700799 * final notification error is reported.
800 */
801int __of_changeset_revert_notify(struct of_changeset *ocs)
802{
803 struct of_changeset_entry *ce;
804 int ret = 0, ret_tmp;
805
806 pr_debug("changeset: emitting notifiers.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300807
808 /* drop the global lock while emitting notifiers */
809 mutex_unlock(&of_mutex);
Frank Rowand24789c52017-10-17 16:36:26 -0700810 list_for_each_entry_reverse(ce, &ocs->entries, node) {
811 ret_tmp = __of_changeset_entry_notify(ce, 1);
812 if (ret_tmp)
813 ret = ret_tmp;
814 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300815 mutex_lock(&of_mutex);
Rob Herring606ad422016-06-15 08:32:18 -0500816 pr_debug("changeset: notifiers sent.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300817
Frank Rowand24789c52017-10-17 16:36:26 -0700818 return ret;
819}
820
821static int __of_changeset_revert(struct of_changeset *ocs)
822{
823 int ret, ret_reply;
824
825 ret_reply = 0;
826 ret = __of_changeset_revert_entries(ocs, &ret_reply);
827
828 if (!ret)
829 ret = __of_changeset_revert_notify(ocs);
830
831 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300832}
833
834/**
Gavin Shan18322372015-11-05 00:12:49 +1100835 * of_changeset_revert - Reverts an applied changeset
836 *
837 * @ocs: changeset pointer
838 *
839 * Reverts a changeset returning the state of the tree to what it
840 * was before the application.
841 * Any side-effects like creation/destruction of devices and
842 * removal of sysfs properties and directories are applied.
843 * Returns 0 on success, a negative error value in case of an error.
844 */
845int of_changeset_revert(struct of_changeset *ocs)
846{
847 int ret;
848
849 mutex_lock(&of_mutex);
850 ret = __of_changeset_revert(ocs);
851 mutex_unlock(&of_mutex);
852
853 return ret;
854}
855EXPORT_SYMBOL_GPL(of_changeset_revert);
856
857/**
Frank Rowand0290c4c2017-10-17 16:36:23 -0700858 * of_changeset_action - Add an action to the tail of the changeset list
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300859 *
860 * @ocs: changeset pointer
861 * @action: action to perform
862 * @np: Pointer to device node
863 * @prop: Pointer to property
864 *
865 * On action being one of:
866 * + OF_RECONFIG_ATTACH_NODE
867 * + OF_RECONFIG_DETACH_NODE,
868 * + OF_RECONFIG_ADD_PROPERTY
869 * + OF_RECONFIG_REMOVE_PROPERTY,
870 * + OF_RECONFIG_UPDATE_PROPERTY
871 * Returns 0 on success, a negative error value in case of an error.
872 */
873int of_changeset_action(struct of_changeset *ocs, unsigned long action,
874 struct device_node *np, struct property *prop)
875{
876 struct of_changeset_entry *ce;
877
878 ce = kzalloc(sizeof(*ce), GFP_KERNEL);
Rob Herring606ad422016-06-15 08:32:18 -0500879 if (!ce)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300880 return -ENOMEM;
Rob Herring606ad422016-06-15 08:32:18 -0500881
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300882 /* get a reference to the node */
883 ce->action = action;
884 ce->np = of_node_get(np);
885 ce->prop = prop;
886
887 if (action == OF_RECONFIG_UPDATE_PROPERTY && prop)
888 ce->old_prop = of_find_property(np, prop->name, NULL);
889
890 /* add it to the list */
891 list_add_tail(&ce->node, &ocs->entries);
892 return 0;
893}
Gavin Shan18322372015-11-05 00:12:49 +1100894EXPORT_SYMBOL_GPL(of_changeset_action);