blob: 747d87619faf36e60213b29d8cc0f68ed75d8999 [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
301/**
302 * of_node_release() - release a dynamically allocated node
303 * @kref: kref element of the node to be released
304 *
305 * In of_node_put() this function is passed to kref_put() as the destructor.
306 */
307void of_node_release(struct kobject *kobj)
308{
309 struct device_node *node = kobj_to_device_node(kobj);
310 struct property *prop = node->properties;
311
312 /* We should never be releasing nodes that haven't been detached. */
313 if (!of_node_check_flag(node, OF_DETACHED)) {
Rob Herring0d638a02017-06-01 15:50:55 -0500314 pr_err("ERROR: Bad of_node_put() on %pOF\n", node);
Grant Likely6afc0dc2014-06-26 15:40:48 +0100315 dump_stack();
316 return;
317 }
Grant Likely6afc0dc2014-06-26 15:40:48 +0100318 if (!of_node_check_flag(node, OF_DYNAMIC))
319 return;
320
321 while (prop) {
322 struct property *next = prop->next;
323 kfree(prop->name);
324 kfree(prop->value);
325 kfree(prop);
326 prop = next;
327
328 if (!prop) {
329 prop = node->deadprops;
330 node->deadprops = NULL;
331 }
332 }
333 kfree(node->full_name);
334 kfree(node->data);
335 kfree(node);
336}
Pantelis Antoniou69843392014-07-04 19:58:47 +0300337
338/**
339 * __of_prop_dup - Copy a property dynamically.
340 * @prop: Property to copy
341 * @allocflags: Allocation flags (typically pass GFP_KERNEL)
342 *
343 * Copy a property by dynamically allocating the memory of both the
Geert Uytterhoeven27b33832014-10-22 11:49:01 +0200344 * property structure and the property name & contents. The property's
Pantelis Antoniou69843392014-07-04 19:58:47 +0300345 * flags have the OF_DYNAMIC bit set so that we can differentiate between
346 * dynamically allocated properties and not.
347 * Returns the newly allocated property or NULL on out of memory error.
348 */
349struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags)
350{
351 struct property *new;
352
353 new = kzalloc(sizeof(*new), allocflags);
354 if (!new)
355 return NULL;
356
357 /*
358 * NOTE: There is no check for zero length value.
Grant Likelyb6ae5dc2014-07-26 10:58:43 -0600359 * In case of a boolean property, this will allocate a value
Pantelis Antoniou69843392014-07-04 19:58:47 +0300360 * of zero bytes. We do this to work around the use
361 * of of_get_property() calls on boolean values.
362 */
363 new->name = kstrdup(prop->name, allocflags);
364 new->value = kmemdup(prop->value, prop->length, allocflags);
365 new->length = prop->length;
366 if (!new->name || !new->value)
367 goto err_free;
368
369 /* mark the property as dynamic */
370 of_property_set_flag(new, OF_DYNAMIC);
371
372 return new;
373
374 err_free:
375 kfree(new->name);
376 kfree(new->value);
377 kfree(new);
378 return NULL;
379}
380
381/**
Grant Likelye5179582014-11-17 22:31:32 +0000382 * __of_node_dup() - Duplicate or create an empty device node dynamically.
383 * @fmt: Format string (plus vargs) for new full name of the device node
Pantelis Antoniou69843392014-07-04 19:58:47 +0300384 *
Grant Likelye5179582014-11-17 22:31:32 +0000385 * Create an device tree node, either by duplicating an empty node or by allocating
386 * an empty one suitable for further modification. The node data are
387 * dynamically allocated and all the node flags have the OF_DYNAMIC &
388 * OF_DETACHED bits set. Returns the newly allocated node or NULL on out of
389 * memory error.
Pantelis Antoniou69843392014-07-04 19:58:47 +0300390 */
Grant Likelye5179582014-11-17 22:31:32 +0000391struct device_node *__of_node_dup(const struct device_node *np, const char *fmt, ...)
Pantelis Antoniou69843392014-07-04 19:58:47 +0300392{
Grant Likelyef8bbd72014-11-14 15:33:07 +0000393 va_list vargs;
Pantelis Antoniou69843392014-07-04 19:58:47 +0300394 struct device_node *node;
395
Grant Likelyef8bbd72014-11-14 15:33:07 +0000396 node = kzalloc(sizeof(*node), GFP_KERNEL);
Pantelis Antoniou69843392014-07-04 19:58:47 +0300397 if (!node)
398 return NULL;
Grant Likelyef8bbd72014-11-14 15:33:07 +0000399 va_start(vargs, fmt);
400 node->full_name = kvasprintf(GFP_KERNEL, fmt, vargs);
401 va_end(vargs);
Grant Likelye5179582014-11-17 22:31:32 +0000402 if (!node->full_name) {
403 kfree(node);
404 return NULL;
405 }
Pantelis Antoniou69843392014-07-04 19:58:47 +0300406
Grant Likelyef8bbd72014-11-14 15:33:07 +0000407 of_node_set_flag(node, OF_DYNAMIC);
408 of_node_set_flag(node, OF_DETACHED);
Pantelis Antoniou69843392014-07-04 19:58:47 +0300409 of_node_init(node);
410
Grant Likelye5179582014-11-17 22:31:32 +0000411 /* Iterate over and duplicate all properties */
412 if (np) {
413 struct property *pp, *new_pp;
414 for_each_property_of_node(np, pp) {
415 new_pp = __of_prop_dup(pp, GFP_KERNEL);
416 if (!new_pp)
417 goto err_prop;
418 if (__of_add_property(node, new_pp)) {
419 kfree(new_pp->name);
420 kfree(new_pp->value);
421 kfree(new_pp);
422 goto err_prop;
423 }
424 }
425 }
Pantelis Antoniou69843392014-07-04 19:58:47 +0300426 return node;
427
Grant Likelye5179582014-11-17 22:31:32 +0000428 err_prop:
429 of_node_put(node); /* Frees the node and properties */
Pantelis Antoniou69843392014-07-04 19:58:47 +0300430 return NULL;
431}
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300432
433static void __of_changeset_entry_destroy(struct of_changeset_entry *ce)
434{
435 of_node_put(ce->np);
436 list_del(&ce->node);
437 kfree(ce);
438}
439
440#ifdef DEBUG
441static void __of_changeset_entry_dump(struct of_changeset_entry *ce)
442{
443 switch (ce->action) {
444 case OF_RECONFIG_ADD_PROPERTY:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300445 case OF_RECONFIG_REMOVE_PROPERTY:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300446 case OF_RECONFIG_UPDATE_PROPERTY:
Rob Herring0d638a02017-06-01 15:50:55 -0500447 pr_debug("cset<%p> %-15s %pOF/%s\n", ce, action_names[ce->action],
448 ce->np, ce->prop->name);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300449 break;
450 case OF_RECONFIG_ATTACH_NODE:
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300451 case OF_RECONFIG_DETACH_NODE:
Rob Herring0d638a02017-06-01 15:50:55 -0500452 pr_debug("cset<%p> %-15s %pOF\n", ce, action_names[ce->action],
453 ce->np);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300454 break;
455 }
456}
457#else
458static inline void __of_changeset_entry_dump(struct of_changeset_entry *ce)
459{
460 /* empty */
461}
462#endif
463
464static void __of_changeset_entry_invert(struct of_changeset_entry *ce,
465 struct of_changeset_entry *rce)
466{
467 memcpy(rce, ce, sizeof(*rce));
468
469 switch (ce->action) {
470 case OF_RECONFIG_ATTACH_NODE:
471 rce->action = OF_RECONFIG_DETACH_NODE;
472 break;
473 case OF_RECONFIG_DETACH_NODE:
474 rce->action = OF_RECONFIG_ATTACH_NODE;
475 break;
476 case OF_RECONFIG_ADD_PROPERTY:
477 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
478 break;
479 case OF_RECONFIG_REMOVE_PROPERTY:
480 rce->action = OF_RECONFIG_ADD_PROPERTY;
481 break;
482 case OF_RECONFIG_UPDATE_PROPERTY:
483 rce->old_prop = ce->prop;
484 rce->prop = ce->old_prop;
Pantelis Antonioub9c43852016-05-09 16:20:42 +0300485 /* update was used but original property did not exist */
486 if (!rce->prop) {
487 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
488 rce->prop = ce->prop;
489 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300490 break;
491 }
492}
493
Frank Rowand24789c52017-10-17 16:36:26 -0700494static int __of_changeset_entry_notify(struct of_changeset_entry *ce,
495 bool revert)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300496{
Grant Likelyf5242e52014-11-24 17:58:01 +0000497 struct of_reconfig_data rd;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300498 struct of_changeset_entry ce_inverted;
Frank Rowand24789c52017-10-17 16:36:26 -0700499 int ret = 0;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300500
501 if (revert) {
502 __of_changeset_entry_invert(ce, &ce_inverted);
503 ce = &ce_inverted;
504 }
505
506 switch (ce->action) {
507 case OF_RECONFIG_ATTACH_NODE:
508 case OF_RECONFIG_DETACH_NODE:
Grant Likelyf5242e52014-11-24 17:58:01 +0000509 memset(&rd, 0, sizeof(rd));
510 rd.dn = ce->np;
511 ret = of_reconfig_notify(ce->action, &rd);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300512 break;
513 case OF_RECONFIG_ADD_PROPERTY:
514 case OF_RECONFIG_REMOVE_PROPERTY:
515 case OF_RECONFIG_UPDATE_PROPERTY:
516 ret = of_property_notify(ce->action, ce->np, ce->prop, ce->old_prop);
517 break;
518 default:
Rob Herring606ad422016-06-15 08:32:18 -0500519 pr_err("invalid devicetree changeset action: %i\n",
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300520 (int)ce->action);
Frank Rowand24789c52017-10-17 16:36:26 -0700521 ret = -EINVAL;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300522 }
523
524 if (ret)
Rob Herring0d638a02017-06-01 15:50:55 -0500525 pr_err("changeset notifier error @%pOF\n", ce->np);
Frank Rowand24789c52017-10-17 16:36:26 -0700526 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300527}
528
529static int __of_changeset_entry_apply(struct of_changeset_entry *ce)
530{
531 struct property *old_prop, **propp;
532 unsigned long flags;
533 int ret = 0;
534
535 __of_changeset_entry_dump(ce);
536
537 raw_spin_lock_irqsave(&devtree_lock, flags);
538 switch (ce->action) {
539 case OF_RECONFIG_ATTACH_NODE:
540 __of_attach_node(ce->np);
541 break;
542 case OF_RECONFIG_DETACH_NODE:
543 __of_detach_node(ce->np);
544 break;
545 case OF_RECONFIG_ADD_PROPERTY:
546 /* If the property is in deadprops then it must be removed */
547 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
548 if (*propp == ce->prop) {
549 *propp = ce->prop->next;
550 ce->prop->next = NULL;
551 break;
552 }
553 }
554
555 ret = __of_add_property(ce->np, ce->prop);
556 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500557 pr_err("changeset: add_property failed @%pOF/%s\n",
558 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300559 ce->prop->name);
560 break;
561 }
562 break;
563 case OF_RECONFIG_REMOVE_PROPERTY:
564 ret = __of_remove_property(ce->np, ce->prop);
565 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500566 pr_err("changeset: remove_property failed @%pOF/%s\n",
567 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300568 ce->prop->name);
569 break;
570 }
571 break;
572
573 case OF_RECONFIG_UPDATE_PROPERTY:
574 /* If the property is in deadprops then it must be removed */
575 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
576 if (*propp == ce->prop) {
577 *propp = ce->prop->next;
578 ce->prop->next = NULL;
579 break;
580 }
581 }
582
583 ret = __of_update_property(ce->np, ce->prop, &old_prop);
584 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500585 pr_err("changeset: update_property failed @%pOF/%s\n",
586 ce->np,
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300587 ce->prop->name);
588 break;
589 }
590 break;
591 default:
592 ret = -EINVAL;
593 }
594 raw_spin_unlock_irqrestore(&devtree_lock, flags);
595
596 if (ret)
597 return ret;
598
599 switch (ce->action) {
600 case OF_RECONFIG_ATTACH_NODE:
601 __of_attach_node_sysfs(ce->np);
602 break;
603 case OF_RECONFIG_DETACH_NODE:
604 __of_detach_node_sysfs(ce->np);
605 break;
606 case OF_RECONFIG_ADD_PROPERTY:
607 /* ignore duplicate names */
608 __of_add_property_sysfs(ce->np, ce->prop);
609 break;
610 case OF_RECONFIG_REMOVE_PROPERTY:
611 __of_remove_property_sysfs(ce->np, ce->prop);
612 break;
613 case OF_RECONFIG_UPDATE_PROPERTY:
614 __of_update_property_sysfs(ce->np, ce->prop, ce->old_prop);
615 break;
616 }
617
618 return 0;
619}
620
621static inline int __of_changeset_entry_revert(struct of_changeset_entry *ce)
622{
623 struct of_changeset_entry ce_inverted;
624
625 __of_changeset_entry_invert(ce, &ce_inverted);
626 return __of_changeset_entry_apply(&ce_inverted);
627}
628
629/**
630 * of_changeset_init - Initialize a changeset for use
631 *
632 * @ocs: changeset pointer
633 *
634 * Initialize a changeset structure
635 */
636void of_changeset_init(struct of_changeset *ocs)
637{
638 memset(ocs, 0, sizeof(*ocs));
639 INIT_LIST_HEAD(&ocs->entries);
640}
Gavin Shan18322372015-11-05 00:12:49 +1100641EXPORT_SYMBOL_GPL(of_changeset_init);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300642
643/**
644 * of_changeset_destroy - Destroy a changeset
645 *
646 * @ocs: changeset pointer
647 *
648 * Destroys a changeset. Note that if a changeset is applied,
649 * its changes to the tree cannot be reverted.
650 */
651void of_changeset_destroy(struct of_changeset *ocs)
652{
653 struct of_changeset_entry *ce, *cen;
654
655 list_for_each_entry_safe_reverse(ce, cen, &ocs->entries, node)
656 __of_changeset_entry_destroy(ce);
657}
Gavin Shan18322372015-11-05 00:12:49 +1100658EXPORT_SYMBOL_GPL(of_changeset_destroy);
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300659
Frank Rowand24789c52017-10-17 16:36:26 -0700660/*
661 * Apply the changeset entries in @ocs.
662 * If apply fails, an attempt is made to revert the entries that were
663 * successfully applied.
664 *
665 * If multiple revert errors occur then only the final revert error is reported.
666 *
667 * Returns 0 on success, a negative error value in case of an error.
668 * If a revert error occurs, it is returned in *ret_revert.
669 */
670int __of_changeset_apply_entries(struct of_changeset *ocs, int *ret_revert)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300671{
672 struct of_changeset_entry *ce;
Frank Rowand24789c52017-10-17 16:36:26 -0700673 int ret, ret_tmp;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300674
Rob Herring606ad422016-06-15 08:32:18 -0500675 pr_debug("changeset: applying...\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300676 list_for_each_entry(ce, &ocs->entries, node) {
677 ret = __of_changeset_entry_apply(ce);
678 if (ret) {
Rob Herring606ad422016-06-15 08:32:18 -0500679 pr_err("Error applying changeset (%d)\n", ret);
Frank Rowand24789c52017-10-17 16:36:26 -0700680 list_for_each_entry_continue_reverse(ce, &ocs->entries,
681 node) {
682 ret_tmp = __of_changeset_entry_revert(ce);
683 if (ret_tmp)
684 *ret_revert = ret_tmp;
685 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300686 return ret;
687 }
688 }
Frank Rowand24789c52017-10-17 16:36:26 -0700689
690 return 0;
691}
692
693/*
694 * Returns 0 on success, a negative error value in case of an error.
695 *
696 * If multiple changset entry notification errors occur then only the
697 * final notification error is reported.
698 */
699int __of_changeset_apply_notify(struct of_changeset *ocs)
700{
701 struct of_changeset_entry *ce;
702 int ret = 0, ret_tmp;
703
704 pr_debug("changeset: emitting notifiers.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300705
706 /* drop the global lock while emitting notifiers */
707 mutex_unlock(&of_mutex);
Frank Rowand24789c52017-10-17 16:36:26 -0700708 list_for_each_entry(ce, &ocs->entries, node) {
709 ret_tmp = __of_changeset_entry_notify(ce, 0);
710 if (ret_tmp)
711 ret = ret_tmp;
712 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300713 mutex_lock(&of_mutex);
Rob Herring606ad422016-06-15 08:32:18 -0500714 pr_debug("changeset: notifiers sent.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300715
Frank Rowand24789c52017-10-17 16:36:26 -0700716 return ret;
717}
718
719/*
720 * Returns 0 on success, a negative error value in case of an error.
721 *
722 * If a changeset entry apply fails, an attempt is made to revert any
723 * previous entries in the changeset. If any of the reverts fails,
724 * that failure is not reported. Thus the state of the device tree
725 * is unknown if an apply error occurs.
726 */
727static int __of_changeset_apply(struct of_changeset *ocs)
728{
729 int ret, ret_revert = 0;
730
731 ret = __of_changeset_apply_entries(ocs, &ret_revert);
732 if (!ret)
733 ret = __of_changeset_apply_notify(ocs);
734
735 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300736}
737
738/**
Gavin Shan18322372015-11-05 00:12:49 +1100739 * of_changeset_apply - Applies a changeset
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300740 *
741 * @ocs: changeset pointer
742 *
Gavin Shan18322372015-11-05 00:12:49 +1100743 * Applies a changeset to the live tree.
744 * Any side-effects of live tree state changes are applied here on
745 * success, like creation/destruction of devices and side-effects
746 * like creation of sysfs properties and directories.
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300747 * Returns 0 on success, a negative error value in case of an error.
Gavin Shan18322372015-11-05 00:12:49 +1100748 * On error the partially applied effects are reverted.
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300749 */
Gavin Shan18322372015-11-05 00:12:49 +1100750int of_changeset_apply(struct of_changeset *ocs)
751{
752 int ret;
753
754 mutex_lock(&of_mutex);
755 ret = __of_changeset_apply(ocs);
756 mutex_unlock(&of_mutex);
757
758 return ret;
759}
760EXPORT_SYMBOL_GPL(of_changeset_apply);
761
Frank Rowand24789c52017-10-17 16:36:26 -0700762/*
763 * Revert the changeset entries in @ocs.
764 * If revert fails, an attempt is made to re-apply the entries that were
765 * successfully removed.
766 *
767 * If multiple re-apply errors occur then only the final apply error is
768 * reported.
769 *
770 * Returns 0 on success, a negative error value in case of an error.
771 * If an apply error occurs, it is returned in *ret_apply.
772 */
773int __of_changeset_revert_entries(struct of_changeset *ocs, int *ret_apply)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300774{
775 struct of_changeset_entry *ce;
Frank Rowand24789c52017-10-17 16:36:26 -0700776 int ret, ret_tmp;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300777
Rob Herring606ad422016-06-15 08:32:18 -0500778 pr_debug("changeset: reverting...\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300779 list_for_each_entry_reverse(ce, &ocs->entries, node) {
780 ret = __of_changeset_entry_revert(ce);
781 if (ret) {
Rob Herring606ad422016-06-15 08:32:18 -0500782 pr_err("Error reverting changeset (%d)\n", ret);
Frank Rowand24789c52017-10-17 16:36:26 -0700783 list_for_each_entry_continue(ce, &ocs->entries, node) {
784 ret_tmp = __of_changeset_entry_apply(ce);
785 if (ret_tmp)
786 *ret_apply = ret_tmp;
787 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300788 return ret;
789 }
790 }
Frank Rowand24789c52017-10-17 16:36:26 -0700791
792 return 0;
793}
794
795/*
796 * If multiple changset entry notification errors occur then only the
797 * final notification error is reported.
798 */
799int __of_changeset_revert_notify(struct of_changeset *ocs)
800{
801 struct of_changeset_entry *ce;
802 int ret = 0, ret_tmp;
803
804 pr_debug("changeset: emitting notifiers.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300805
806 /* drop the global lock while emitting notifiers */
807 mutex_unlock(&of_mutex);
Frank Rowand24789c52017-10-17 16:36:26 -0700808 list_for_each_entry_reverse(ce, &ocs->entries, node) {
809 ret_tmp = __of_changeset_entry_notify(ce, 1);
810 if (ret_tmp)
811 ret = ret_tmp;
812 }
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300813 mutex_lock(&of_mutex);
Rob Herring606ad422016-06-15 08:32:18 -0500814 pr_debug("changeset: notifiers sent.\n");
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300815
Frank Rowand24789c52017-10-17 16:36:26 -0700816 return ret;
817}
818
819static int __of_changeset_revert(struct of_changeset *ocs)
820{
821 int ret, ret_reply;
822
823 ret_reply = 0;
824 ret = __of_changeset_revert_entries(ocs, &ret_reply);
825
826 if (!ret)
827 ret = __of_changeset_revert_notify(ocs);
828
829 return ret;
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300830}
831
832/**
Gavin Shan18322372015-11-05 00:12:49 +1100833 * of_changeset_revert - Reverts an applied changeset
834 *
835 * @ocs: changeset pointer
836 *
837 * Reverts a changeset returning the state of the tree to what it
838 * was before the application.
839 * Any side-effects like creation/destruction of devices and
840 * removal of sysfs properties and directories are applied.
841 * Returns 0 on success, a negative error value in case of an error.
842 */
843int of_changeset_revert(struct of_changeset *ocs)
844{
845 int ret;
846
847 mutex_lock(&of_mutex);
848 ret = __of_changeset_revert(ocs);
849 mutex_unlock(&of_mutex);
850
851 return ret;
852}
853EXPORT_SYMBOL_GPL(of_changeset_revert);
854
855/**
Frank Rowand0290c4c2017-10-17 16:36:23 -0700856 * of_changeset_action - Add an action to the tail of the changeset list
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300857 *
858 * @ocs: changeset pointer
859 * @action: action to perform
860 * @np: Pointer to device node
861 * @prop: Pointer to property
862 *
863 * On action being one of:
864 * + OF_RECONFIG_ATTACH_NODE
865 * + OF_RECONFIG_DETACH_NODE,
866 * + OF_RECONFIG_ADD_PROPERTY
867 * + OF_RECONFIG_REMOVE_PROPERTY,
868 * + OF_RECONFIG_UPDATE_PROPERTY
869 * Returns 0 on success, a negative error value in case of an error.
870 */
871int of_changeset_action(struct of_changeset *ocs, unsigned long action,
872 struct device_node *np, struct property *prop)
873{
874 struct of_changeset_entry *ce;
875
876 ce = kzalloc(sizeof(*ce), GFP_KERNEL);
Rob Herring606ad422016-06-15 08:32:18 -0500877 if (!ce)
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300878 return -ENOMEM;
Rob Herring606ad422016-06-15 08:32:18 -0500879
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300880 /* get a reference to the node */
881 ce->action = action;
882 ce->np = of_node_get(np);
883 ce->prop = prop;
884
885 if (action == OF_RECONFIG_UPDATE_PROPERTY && prop)
886 ce->old_prop = of_find_property(np, prop->name, NULL);
887
888 /* add it to the list */
889 list_add_tail(&ce->node, &ocs->entries);
890 return 0;
891}
Gavin Shan18322372015-11-05 00:12:49 +1100892EXPORT_SYMBOL_GPL(of_changeset_action);