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