]> Git Repo - linux.git/blame - drivers/of/dynamic.c
Merge branch 'dt/linus' into dt/next
[linux.git] / drivers / of / dynamic.c
CommitLineData
af6074fc 1// SPDX-License-Identifier: GPL-2.0
6afc0dc3
GL
2/*
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
606ad42a
RH
10#define pr_fmt(fmt) "OF: " fmt
11
6afc0dc3
GL
12#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
4c2bb574
RH
20static struct device_node *kobj_to_device_node(struct kobject *kobj)
21{
22 return container_of(kobj, struct device_node, kobj);
23}
24
6afc0dc3
GL
25/**
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 *
8c8239c2 30 * Return: The node with refcount incremented.
6afc0dc3
GL
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
6afc0dc3
GL
52static 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
914d9d83
RH
66static const char *action_names[] = {
67 [0] = "INVALID",
00aa3720
GL
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};
00aa3720 74
f5242e5a 75int of_reconfig_notify(unsigned long action, struct of_reconfig_data *p)
6afc0dc3
GL
76{
77 int rc;
00aa3720 78#ifdef DEBUG
f5242e5a 79 struct of_reconfig_data *pr = p;
00aa3720
GL
80
81 switch (action) {
82 case OF_RECONFIG_ATTACH_NODE:
83 case OF_RECONFIG_DETACH_NODE:
0d638a07
RH
84 pr_debug("notify %-15s %pOF\n", action_names[action],
85 pr->dn);
00aa3720
GL
86 break;
87 case OF_RECONFIG_ADD_PROPERTY:
88 case OF_RECONFIG_REMOVE_PROPERTY:
89 case OF_RECONFIG_UPDATE_PROPERTY:
0d638a07
RH
90 pr_debug("notify %-15s %pOF:%s\n", action_names[action],
91 pr->dn, pr->prop->name);
00aa3720 92 break;
6afc0dc3 93
00aa3720
GL
94 }
95#endif
6afc0dc3
GL
96 rc = blocking_notifier_call_chain(&of_reconfig_chain, action, p);
97 return notifier_to_errno(rc);
98}
99
b53a2340
PA
100/*
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.
8c8239c2
RH
106 *
107 * Return: 0 on device going from enabled to disabled, 1 on device
b53a2340
PA
108 * going from disabled to enabled and -1 on no change.
109 */
f5242e5a 110int of_reconfig_get_state_change(unsigned long action, struct of_reconfig_data *pr)
b53a2340 111{
f5242e5a 112 struct property *prop, *old_prop = NULL;
b53a2340
PA
113 int is_status, status_state, old_status_state, prev_state, new_state;
114
115 /* figure out if a device should be created or destroyed */
b53a2340
PA
116 switch (action) {
117 case OF_RECONFIG_ATTACH_NODE:
118 case OF_RECONFIG_DETACH_NODE:
f5242e5a 119 prop = of_find_property(pr->dn, "status", NULL);
b53a2340
PA
120 break;
121 case OF_RECONFIG_ADD_PROPERTY:
122 case OF_RECONFIG_REMOVE_PROPERTY:
b53a2340
PA
123 prop = pr->prop;
124 break;
125 case OF_RECONFIG_UPDATE_PROPERTY:
b53a2340
PA
126 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
6afc0dc3 188int of_property_notify(int action, struct device_node *np,
259092a3 189 struct property *prop, struct property *oldprop)
6afc0dc3 190{
f5242e5a 191 struct of_reconfig_data pr;
6afc0dc3
GL
192
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;
259092a3 199 pr.old_prop = oldprop;
6afc0dc3
GL
200 return of_reconfig_notify(action, &pr);
201}
202
24996951 203static void __of_attach_node(struct device_node *np)
d8c50088 204{
a25095d4
GL
205 const __be32 *phandle;
206 int sz;
207
f9627881
FR
208 if (!of_node_check_flag(np, OF_OVERLAY)) {
209 np->name = __of_get_property(np, "name", NULL);
f9627881
FR
210 if (!np->name)
211 np->name = "<NULL>";
f9627881
FR
212
213 phandle = __of_get_property(np, "phandle", &sz);
214 if (!phandle)
215 phandle = __of_get_property(np, "linux,phandle", &sz);
216 if (IS_ENABLED(CONFIG_PPC_PSERIES) && !phandle)
217 phandle = __of_get_property(np, "ibm,phandle", &sz);
218 if (phandle && (sz >= 4))
219 np->phandle = be32_to_cpup(phandle);
220 else
221 np->phandle = 0;
222 }
a25095d4 223
6162dbe4 224 np->child = NULL;
d8c50088 225 np->sibling = np->parent->child;
d8c50088
PA
226 np->parent->child = np;
227 of_node_clear_flag(np, OF_DETACHED);
1a50d940 228 np->fwnode.flags |= FWNODE_FLAG_NOT_DEVICE;
d8c50088
PA
229}
230
6afc0dc3
GL
231/**
232 * of_attach_node() - Plug a device node into the tree and global list.
3cb025d9 233 * @np: Pointer to the caller's Device Node
6afc0dc3
GL
234 */
235int of_attach_node(struct device_node *np)
236{
f5242e5a 237 struct of_reconfig_data rd;
6afc0dc3 238 unsigned long flags;
6afc0dc3 239
f5242e5a
GL
240 memset(&rd, 0, sizeof(rd));
241 rd.dn = np;
242
8a2b22a2 243 mutex_lock(&of_mutex);
6afc0dc3 244 raw_spin_lock_irqsave(&devtree_lock, flags);
d8c50088 245 __of_attach_node(np);
6afc0dc3
GL
246 raw_spin_unlock_irqrestore(&devtree_lock, flags);
247
8a2b22a2
GL
248 __of_attach_node_sysfs(np);
249 mutex_unlock(&of_mutex);
259092a3 250
f5242e5a 251 of_reconfig_notify(OF_RECONFIG_ATTACH_NODE, &rd);
259092a3 252
6afc0dc3
GL
253 return 0;
254}
255
d8c50088 256void __of_detach_node(struct device_node *np)
6afc0dc3
GL
257{
258 struct device_node *parent;
6afc0dc3 259
d8c50088
PA
260 if (WARN_ON(of_node_check_flag(np, OF_DETACHED)))
261 return;
6afc0dc3
GL
262
263 parent = np->parent;
d8c50088
PA
264 if (WARN_ON(!parent))
265 return;
6afc0dc3 266
6afc0dc3
GL
267 if (parent->child == np)
268 parent->child = np->sibling;
269 else {
270 struct device_node *prevsib;
271 for (prevsib = np->parent->child;
272 prevsib->sibling != np;
273 prevsib = prevsib->sibling)
274 ;
275 prevsib->sibling = np->sibling;
276 }
277
278 of_node_set_flag(np, OF_DETACHED);
5801169a
FR
279
280 /* race with of_find_node_by_phandle() prevented by devtree_lock */
90dc0d1c 281 __of_phandle_cache_inv_entry(np->phandle);
d8c50088
PA
282}
283
284/**
285 * of_detach_node() - "Unplug" a node from the device tree.
3cb025d9 286 * @np: Pointer to the caller's Device Node
d8c50088
PA
287 */
288int of_detach_node(struct device_node *np)
289{
f5242e5a 290 struct of_reconfig_data rd;
d8c50088 291 unsigned long flags;
d8c50088 292
f5242e5a
GL
293 memset(&rd, 0, sizeof(rd));
294 rd.dn = np;
295
8a2b22a2 296 mutex_lock(&of_mutex);
d8c50088
PA
297 raw_spin_lock_irqsave(&devtree_lock, flags);
298 __of_detach_node(np);
6afc0dc3
GL
299 raw_spin_unlock_irqrestore(&devtree_lock, flags);
300
8a2b22a2
GL
301 __of_detach_node_sysfs(np);
302 mutex_unlock(&of_mutex);
259092a3 303
f5242e5a 304 of_reconfig_notify(OF_RECONFIG_DETACH_NODE, &rd);
259092a3 305
58fb82cc 306 return 0;
6afc0dc3 307}
bb91f923 308EXPORT_SYMBOL_GPL(of_detach_node);
6afc0dc3 309
070ea018
LW
310static void property_list_free(struct property *prop_list)
311{
312 struct property *prop, *next;
313
314 for (prop = prop_list; prop != NULL; prop = next) {
315 next = prop->next;
316 kfree(prop->name);
317 kfree(prop->value);
318 kfree(prop);
319 }
320}
321
6afc0dc3
GL
322/**
323 * of_node_release() - release a dynamically allocated node
3cb025d9 324 * @kobj: kernel object of the node to be released
6afc0dc3
GL
325 *
326 * In of_node_put() this function is passed to kref_put() as the destructor.
327 */
328void of_node_release(struct kobject *kobj)
329{
330 struct device_node *node = kobj_to_device_node(kobj);
6afc0dc3 331
23522dd7
FR
332 /*
333 * can not use '"%pOF", node' in pr_err() calls from this function
334 * because an of_node_get(node) when refcount is already zero
335 * will result in an error and a stack dump
336 */
337
6afc0dc3
GL
338 /* We should never be releasing nodes that haven't been detached. */
339 if (!of_node_check_flag(node, OF_DETACHED)) {
23522dd7
FR
340
341 pr_err("ERROR: %s() detected bad of_node_put() on %pOF/%s\n",
342 __func__, node->parent, node->full_name);
74df14cd
FR
343
344 /*
345 * of unittests will test this path. Do not print the stack
346 * trace when the error is caused by unittest so that we do
347 * not display what a normal developer might reasonably
348 * consider a real bug.
349 */
350 if (!IS_ENABLED(CONFIG_OF_UNITTEST) ||
351 strcmp(node->parent->full_name, "testcase-data")) {
352 dump_stack();
b4858dc6 353 pr_err("ERROR: next of_node_put() on this node will result in a kobject warning 'refcount_t: underflow; use-after-free.'\n");
74df14cd
FR
354 }
355
6afc0dc3
GL
356 return;
357 }
6afc0dc3
GL
358 if (!of_node_check_flag(node, OF_DYNAMIC))
359 return;
360
144552c7
FR
361 if (of_node_check_flag(node, OF_OVERLAY)) {
362
363 if (!of_node_check_flag(node, OF_OVERLAY_FREE_CSET)) {
364 /* premature refcount of zero, do not free memory */
365 pr_err("ERROR: memory leak before free overlay changeset, %pOF\n",
366 node);
367 return;
368 }
369
370 /*
371 * If node->properties non-empty then properties were added
372 * to this node either by different overlay that has not
373 * yet been removed, or by a non-overlay mechanism.
374 */
375 if (node->properties)
376 pr_err("ERROR: %s(), unexpected properties in %pOF\n",
377 __func__, node);
378 }
379
ec0b7e24
FR
380 if (node->child)
381 pr_err("ERROR: %s() unexpected children for %pOF/%s\n",
382 __func__, node->parent, node->full_name);
383
070ea018
LW
384 property_list_free(node->properties);
385 property_list_free(node->deadprops);
7b337cb3 386 fwnode_links_purge(of_fwnode_handle(node));
6afc0dc3 387
6afc0dc3
GL
388 kfree(node->full_name);
389 kfree(node->data);
390 kfree(node);
391}
69843396
PA
392
393/**
394 * __of_prop_dup - Copy a property dynamically.
395 * @prop: Property to copy
396 * @allocflags: Allocation flags (typically pass GFP_KERNEL)
397 *
398 * Copy a property by dynamically allocating the memory of both the
27b3383a 399 * property structure and the property name & contents. The property's
69843396
PA
400 * flags have the OF_DYNAMIC bit set so that we can differentiate between
401 * dynamically allocated properties and not.
8c8239c2
RH
402 *
403 * Return: The newly allocated property or NULL on out of memory error.
69843396
PA
404 */
405struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags)
406{
407 struct property *new;
408
409 new = kzalloc(sizeof(*new), allocflags);
410 if (!new)
411 return NULL;
412
413 /*
414 * NOTE: There is no check for zero length value.
b6ae5dc5 415 * In case of a boolean property, this will allocate a value
69843396
PA
416 * of zero bytes. We do this to work around the use
417 * of of_get_property() calls on boolean values.
418 */
419 new->name = kstrdup(prop->name, allocflags);
420 new->value = kmemdup(prop->value, prop->length, allocflags);
421 new->length = prop->length;
422 if (!new->name || !new->value)
423 goto err_free;
424
425 /* mark the property as dynamic */
426 of_property_set_flag(new, OF_DYNAMIC);
427
428 return new;
429
430 err_free:
431 kfree(new->name);
432 kfree(new->value);
433 kfree(new);
434 return NULL;
435}
436
437/**
e5179581 438 * __of_node_dup() - Duplicate or create an empty device node dynamically.
b89dae18
FR
439 * @np: if not NULL, contains properties to be duplicated in new node
440 * @full_name: string value to be duplicated into new node's full_name field
69843396 441 *
b89dae18
FR
442 * Create a device tree node, optionally duplicating the properties of
443 * another node. The node data are dynamically allocated and all the node
444 * flags have the OF_DYNAMIC & OF_DETACHED bits set.
445 *
d9194e00
FR
446 * Return: The newly allocated node or NULL on out of memory error. Use
447 * of_node_put() on it when done to free the memory allocated for it.
69843396 448 */
b89dae18
FR
449struct device_node *__of_node_dup(const struct device_node *np,
450 const char *full_name)
69843396
PA
451{
452 struct device_node *node;
453
ef8bbd73 454 node = kzalloc(sizeof(*node), GFP_KERNEL);
69843396
PA
455 if (!node)
456 return NULL;
b89dae18 457 node->full_name = kstrdup(full_name, GFP_KERNEL);
e5179581
GL
458 if (!node->full_name) {
459 kfree(node);
460 return NULL;
461 }
69843396 462
ef8bbd73
GL
463 of_node_set_flag(node, OF_DYNAMIC);
464 of_node_set_flag(node, OF_DETACHED);
69843396
PA
465 of_node_init(node);
466
e5179581
GL
467 /* Iterate over and duplicate all properties */
468 if (np) {
469 struct property *pp, *new_pp;
470 for_each_property_of_node(np, pp) {
471 new_pp = __of_prop_dup(pp, GFP_KERNEL);
472 if (!new_pp)
473 goto err_prop;
474 if (__of_add_property(node, new_pp)) {
475 kfree(new_pp->name);
476 kfree(new_pp->value);
477 kfree(new_pp);
478 goto err_prop;
479 }
480 }
481 }
69843396
PA
482 return node;
483
e5179581
GL
484 err_prop:
485 of_node_put(node); /* Frees the node and properties */
69843396
PA
486 return NULL;
487}
201c910b
PA
488
489static void __of_changeset_entry_destroy(struct of_changeset_entry *ce)
490{
144552c7
FR
491 if (ce->action == OF_RECONFIG_ATTACH_NODE &&
492 of_node_check_flag(ce->np, OF_OVERLAY)) {
493 if (kref_read(&ce->np->kobj.kref) > 1) {
494 pr_err("ERROR: memory leak, expected refcount 1 instead of %d, of_node_get()/of_node_put() unbalanced - destroy cset entry: attach overlay node %pOF\n",
495 kref_read(&ce->np->kobj.kref), ce->np);
496 } else {
497 of_node_set_flag(ce->np, OF_OVERLAY_FREE_CSET);
498 }
499 }
500
201c910b
PA
501 of_node_put(ce->np);
502 list_del(&ce->node);
503 kfree(ce);
504}
505
506#ifdef DEBUG
507static void __of_changeset_entry_dump(struct of_changeset_entry *ce)
508{
509 switch (ce->action) {
510 case OF_RECONFIG_ADD_PROPERTY:
201c910b 511 case OF_RECONFIG_REMOVE_PROPERTY:
201c910b 512 case OF_RECONFIG_UPDATE_PROPERTY:
0d638a07
RH
513 pr_debug("cset<%p> %-15s %pOF/%s\n", ce, action_names[ce->action],
514 ce->np, ce->prop->name);
201c910b
PA
515 break;
516 case OF_RECONFIG_ATTACH_NODE:
201c910b 517 case OF_RECONFIG_DETACH_NODE:
0d638a07
RH
518 pr_debug("cset<%p> %-15s %pOF\n", ce, action_names[ce->action],
519 ce->np);
201c910b
PA
520 break;
521 }
522}
523#else
524static inline void __of_changeset_entry_dump(struct of_changeset_entry *ce)
525{
526 /* empty */
527}
528#endif
529
530static void __of_changeset_entry_invert(struct of_changeset_entry *ce,
531 struct of_changeset_entry *rce)
532{
533 memcpy(rce, ce, sizeof(*rce));
534
535 switch (ce->action) {
536 case OF_RECONFIG_ATTACH_NODE:
537 rce->action = OF_RECONFIG_DETACH_NODE;
538 break;
539 case OF_RECONFIG_DETACH_NODE:
540 rce->action = OF_RECONFIG_ATTACH_NODE;
541 break;
542 case OF_RECONFIG_ADD_PROPERTY:
543 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
544 break;
545 case OF_RECONFIG_REMOVE_PROPERTY:
546 rce->action = OF_RECONFIG_ADD_PROPERTY;
547 break;
548 case OF_RECONFIG_UPDATE_PROPERTY:
549 rce->old_prop = ce->prop;
550 rce->prop = ce->old_prop;
b9c43856
PA
551 /* update was used but original property did not exist */
552 if (!rce->prop) {
553 rce->action = OF_RECONFIG_REMOVE_PROPERTY;
554 rce->prop = ce->prop;
555 }
201c910b
PA
556 break;
557 }
558}
559
24789c5c
FR
560static int __of_changeset_entry_notify(struct of_changeset_entry *ce,
561 bool revert)
201c910b 562{
f5242e5a 563 struct of_reconfig_data rd;
201c910b 564 struct of_changeset_entry ce_inverted;
24789c5c 565 int ret = 0;
201c910b
PA
566
567 if (revert) {
568 __of_changeset_entry_invert(ce, &ce_inverted);
569 ce = &ce_inverted;
570 }
571
572 switch (ce->action) {
573 case OF_RECONFIG_ATTACH_NODE:
574 case OF_RECONFIG_DETACH_NODE:
f5242e5a
GL
575 memset(&rd, 0, sizeof(rd));
576 rd.dn = ce->np;
577 ret = of_reconfig_notify(ce->action, &rd);
201c910b
PA
578 break;
579 case OF_RECONFIG_ADD_PROPERTY:
580 case OF_RECONFIG_REMOVE_PROPERTY:
581 case OF_RECONFIG_UPDATE_PROPERTY:
582 ret = of_property_notify(ce->action, ce->np, ce->prop, ce->old_prop);
583 break;
584 default:
606ad42a 585 pr_err("invalid devicetree changeset action: %i\n",
201c910b 586 (int)ce->action);
24789c5c 587 ret = -EINVAL;
201c910b
PA
588 }
589
590 if (ret)
0d638a07 591 pr_err("changeset notifier error @%pOF\n", ce->np);
24789c5c 592 return ret;
201c910b
PA
593}
594
595static int __of_changeset_entry_apply(struct of_changeset_entry *ce)
596{
597 struct property *old_prop, **propp;
598 unsigned long flags;
599 int ret = 0;
600
601 __of_changeset_entry_dump(ce);
602
603 raw_spin_lock_irqsave(&devtree_lock, flags);
604 switch (ce->action) {
605 case OF_RECONFIG_ATTACH_NODE:
606 __of_attach_node(ce->np);
607 break;
608 case OF_RECONFIG_DETACH_NODE:
609 __of_detach_node(ce->np);
610 break;
611 case OF_RECONFIG_ADD_PROPERTY:
612 /* If the property is in deadprops then it must be removed */
613 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
614 if (*propp == ce->prop) {
615 *propp = ce->prop->next;
616 ce->prop->next = NULL;
617 break;
618 }
619 }
620
621 ret = __of_add_property(ce->np, ce->prop);
201c910b
PA
622 break;
623 case OF_RECONFIG_REMOVE_PROPERTY:
624 ret = __of_remove_property(ce->np, ce->prop);
201c910b
PA
625 break;
626
627 case OF_RECONFIG_UPDATE_PROPERTY:
628 /* If the property is in deadprops then it must be removed */
629 for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
630 if (*propp == ce->prop) {
631 *propp = ce->prop->next;
632 ce->prop->next = NULL;
633 break;
634 }
635 }
636
637 ret = __of_update_property(ce->np, ce->prop, &old_prop);
201c910b
PA
638 break;
639 default:
640 ret = -EINVAL;
641 }
642 raw_spin_unlock_irqrestore(&devtree_lock, flags);
643
914d9d83
RH
644 if (ret) {
645 pr_err("changeset: apply failed: %-15s %pOF:%s\n",
646 action_names[ce->action], ce->np, ce->prop->name);
201c910b 647 return ret;
914d9d83 648 }
201c910b
PA
649
650 switch (ce->action) {
651 case OF_RECONFIG_ATTACH_NODE:
652 __of_attach_node_sysfs(ce->np);
653 break;
654 case OF_RECONFIG_DETACH_NODE:
655 __of_detach_node_sysfs(ce->np);
656 break;
657 case OF_RECONFIG_ADD_PROPERTY:
658 /* ignore duplicate names */
659 __of_add_property_sysfs(ce->np, ce->prop);
660 break;
661 case OF_RECONFIG_REMOVE_PROPERTY:
662 __of_remove_property_sysfs(ce->np, ce->prop);
663 break;
664 case OF_RECONFIG_UPDATE_PROPERTY:
665 __of_update_property_sysfs(ce->np, ce->prop, ce->old_prop);
666 break;
667 }
668
669 return 0;
670}
671
672static inline int __of_changeset_entry_revert(struct of_changeset_entry *ce)
673{
674 struct of_changeset_entry ce_inverted;
675
676 __of_changeset_entry_invert(ce, &ce_inverted);
677 return __of_changeset_entry_apply(&ce_inverted);
678}
679
680/**
681 * of_changeset_init - Initialize a changeset for use
682 *
683 * @ocs: changeset pointer
684 *
685 * Initialize a changeset structure
686 */
687void of_changeset_init(struct of_changeset *ocs)
688{
689 memset(ocs, 0, sizeof(*ocs));
690 INIT_LIST_HEAD(&ocs->entries);
691}
18322377 692EXPORT_SYMBOL_GPL(of_changeset_init);
201c910b
PA
693
694/**
695 * of_changeset_destroy - Destroy a changeset
696 *
697 * @ocs: changeset pointer
698 *
699 * Destroys a changeset. Note that if a changeset is applied,
700 * its changes to the tree cannot be reverted.
701 */
702void of_changeset_destroy(struct of_changeset *ocs)
703{
704 struct of_changeset_entry *ce, *cen;
705
706 list_for_each_entry_safe_reverse(ce, cen, &ocs->entries, node)
707 __of_changeset_entry_destroy(ce);
708}
18322377 709EXPORT_SYMBOL_GPL(of_changeset_destroy);
201c910b 710
24789c5c
FR
711/*
712 * Apply the changeset entries in @ocs.
713 * If apply fails, an attempt is made to revert the entries that were
714 * successfully applied.
715 *
716 * If multiple revert errors occur then only the final revert error is reported.
717 *
718 * Returns 0 on success, a negative error value in case of an error.
719 * If a revert error occurs, it is returned in *ret_revert.
720 */
721int __of_changeset_apply_entries(struct of_changeset *ocs, int *ret_revert)
201c910b
PA
722{
723 struct of_changeset_entry *ce;
24789c5c 724 int ret, ret_tmp;
201c910b 725
606ad42a 726 pr_debug("changeset: applying...\n");
201c910b
PA
727 list_for_each_entry(ce, &ocs->entries, node) {
728 ret = __of_changeset_entry_apply(ce);
729 if (ret) {
606ad42a 730 pr_err("Error applying changeset (%d)\n", ret);
24789c5c
FR
731 list_for_each_entry_continue_reverse(ce, &ocs->entries,
732 node) {
733 ret_tmp = __of_changeset_entry_revert(ce);
734 if (ret_tmp)
735 *ret_revert = ret_tmp;
736 }
201c910b
PA
737 return ret;
738 }
739 }
24789c5c
FR
740
741 return 0;
742}
743
744/*
745 * Returns 0 on success, a negative error value in case of an error.
746 *
e9d92e40 747 * If multiple changeset entry notification errors occur then only the
24789c5c
FR
748 * final notification error is reported.
749 */
750int __of_changeset_apply_notify(struct of_changeset *ocs)
751{
752 struct of_changeset_entry *ce;
753 int ret = 0, ret_tmp;
754
755 pr_debug("changeset: emitting notifiers.\n");
201c910b
PA
756
757 /* drop the global lock while emitting notifiers */
758 mutex_unlock(&of_mutex);
24789c5c
FR
759 list_for_each_entry(ce, &ocs->entries, node) {
760 ret_tmp = __of_changeset_entry_notify(ce, 0);
761 if (ret_tmp)
762 ret = ret_tmp;
763 }
201c910b 764 mutex_lock(&of_mutex);
606ad42a 765 pr_debug("changeset: notifiers sent.\n");
201c910b 766
24789c5c
FR
767 return ret;
768}
769
770/*
771 * Returns 0 on success, a negative error value in case of an error.
772 *
773 * If a changeset entry apply fails, an attempt is made to revert any
774 * previous entries in the changeset. If any of the reverts fails,
775 * that failure is not reported. Thus the state of the device tree
776 * is unknown if an apply error occurs.
777 */
778static int __of_changeset_apply(struct of_changeset *ocs)
779{
780 int ret, ret_revert = 0;
781
782 ret = __of_changeset_apply_entries(ocs, &ret_revert);
783 if (!ret)
784 ret = __of_changeset_apply_notify(ocs);
785
786 return ret;
201c910b
PA
787}
788
789/**
18322377 790 * of_changeset_apply - Applies a changeset
201c910b
PA
791 *
792 * @ocs: changeset pointer
793 *
18322377
GS
794 * Applies a changeset to the live tree.
795 * Any side-effects of live tree state changes are applied here on
796 * success, like creation/destruction of devices and side-effects
797 * like creation of sysfs properties and directories.
8c8239c2
RH
798 *
799 * Return: 0 on success, a negative error value in case of an error.
18322377 800 * On error the partially applied effects are reverted.
201c910b 801 */
18322377
GS
802int of_changeset_apply(struct of_changeset *ocs)
803{
804 int ret;
805
806 mutex_lock(&of_mutex);
807 ret = __of_changeset_apply(ocs);
808 mutex_unlock(&of_mutex);
809
810 return ret;
811}
812EXPORT_SYMBOL_GPL(of_changeset_apply);
813
24789c5c
FR
814/*
815 * Revert the changeset entries in @ocs.
816 * If revert fails, an attempt is made to re-apply the entries that were
817 * successfully removed.
818 *
819 * If multiple re-apply errors occur then only the final apply error is
820 * reported.
821 *
822 * Returns 0 on success, a negative error value in case of an error.
823 * If an apply error occurs, it is returned in *ret_apply.
824 */
825int __of_changeset_revert_entries(struct of_changeset *ocs, int *ret_apply)
201c910b
PA
826{
827 struct of_changeset_entry *ce;
24789c5c 828 int ret, ret_tmp;
201c910b 829
606ad42a 830 pr_debug("changeset: reverting...\n");
201c910b
PA
831 list_for_each_entry_reverse(ce, &ocs->entries, node) {
832 ret = __of_changeset_entry_revert(ce);
833 if (ret) {
606ad42a 834 pr_err("Error reverting changeset (%d)\n", ret);
24789c5c
FR
835 list_for_each_entry_continue(ce, &ocs->entries, node) {
836 ret_tmp = __of_changeset_entry_apply(ce);
837 if (ret_tmp)
838 *ret_apply = ret_tmp;
839 }
201c910b
PA
840 return ret;
841 }
842 }
24789c5c
FR
843
844 return 0;
845}
846
847/*
e9d92e40 848 * If multiple changeset entry notification errors occur then only the
24789c5c
FR
849 * final notification error is reported.
850 */
851int __of_changeset_revert_notify(struct of_changeset *ocs)
852{
853 struct of_changeset_entry *ce;
854 int ret = 0, ret_tmp;
855
856 pr_debug("changeset: emitting notifiers.\n");
201c910b
PA
857
858 /* drop the global lock while emitting notifiers */
859 mutex_unlock(&of_mutex);
24789c5c
FR
860 list_for_each_entry_reverse(ce, &ocs->entries, node) {
861 ret_tmp = __of_changeset_entry_notify(ce, 1);
862 if (ret_tmp)
863 ret = ret_tmp;
864 }
201c910b 865 mutex_lock(&of_mutex);
606ad42a 866 pr_debug("changeset: notifiers sent.\n");
201c910b 867
24789c5c
FR
868 return ret;
869}
870
871static int __of_changeset_revert(struct of_changeset *ocs)
872{
873 int ret, ret_reply;
874
875 ret_reply = 0;
876 ret = __of_changeset_revert_entries(ocs, &ret_reply);
877
878 if (!ret)
879 ret = __of_changeset_revert_notify(ocs);
880
881 return ret;
201c910b
PA
882}
883
18322377
GS
884/**
885 * of_changeset_revert - Reverts an applied changeset
886 *
887 * @ocs: changeset pointer
888 *
889 * Reverts a changeset returning the state of the tree to what it
890 * was before the application.
891 * Any side-effects like creation/destruction of devices and
892 * removal of sysfs properties and directories are applied.
8c8239c2
RH
893 *
894 * Return: 0 on success, a negative error value in case of an error.
18322377
GS
895 */
896int of_changeset_revert(struct of_changeset *ocs)
897{
898 int ret;
899
900 mutex_lock(&of_mutex);
901 ret = __of_changeset_revert(ocs);
902 mutex_unlock(&of_mutex);
903
904 return ret;
905}
906EXPORT_SYMBOL_GPL(of_changeset_revert);
907
201c910b 908/**
0290c4ca 909 * of_changeset_action - Add an action to the tail of the changeset list
201c910b
PA
910 *
911 * @ocs: changeset pointer
912 * @action: action to perform
913 * @np: Pointer to device node
914 * @prop: Pointer to property
915 *
916 * On action being one of:
917 * + OF_RECONFIG_ATTACH_NODE
918 * + OF_RECONFIG_DETACH_NODE,
919 * + OF_RECONFIG_ADD_PROPERTY
920 * + OF_RECONFIG_REMOVE_PROPERTY,
921 * + OF_RECONFIG_UPDATE_PROPERTY
8c8239c2
RH
922 *
923 * Return: 0 on success, a negative error value in case of an error.
201c910b
PA
924 */
925int of_changeset_action(struct of_changeset *ocs, unsigned long action,
926 struct device_node *np, struct property *prop)
927{
928 struct of_changeset_entry *ce;
929
930 ce = kzalloc(sizeof(*ce), GFP_KERNEL);
606ad42a 931 if (!ce)
201c910b 932 return -ENOMEM;
606ad42a 933
914d9d83
RH
934 if (WARN_ON(action >= ARRAY_SIZE(action_names)))
935 return -EINVAL;
936
201c910b
PA
937 /* get a reference to the node */
938 ce->action = action;
939 ce->np = of_node_get(np);
940 ce->prop = prop;
941
942 if (action == OF_RECONFIG_UPDATE_PROPERTY && prop)
943 ce->old_prop = of_find_property(np, prop->name, NULL);
944
945 /* add it to the list */
946 list_add_tail(&ce->node, &ocs->entries);
947 return 0;
948}
18322377 949EXPORT_SYMBOL_GPL(of_changeset_action);
This page took 0.624889 seconds and 4 git commands to generate.