• 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 }
230 
231 /**
232  * of_attach_node() - Plug a device node into the tree and global list.
233  */
of_attach_node(struct device_node * np)234 int of_attach_node(struct device_node *np)
235 {
236 	struct of_reconfig_data rd;
237 	unsigned long flags;
238 
239 	memset(&rd, 0, sizeof(rd));
240 	rd.dn = np;
241 
242 	mutex_lock(&of_mutex);
243 	raw_spin_lock_irqsave(&devtree_lock, flags);
244 	__of_attach_node(np);
245 	raw_spin_unlock_irqrestore(&devtree_lock, flags);
246 
247 	__of_attach_node_sysfs(np);
248 	mutex_unlock(&of_mutex);
249 
250 	of_reconfig_notify(OF_RECONFIG_ATTACH_NODE, &rd);
251 
252 	return 0;
253 }
254 
__of_detach_node(struct device_node * np)255 void __of_detach_node(struct device_node *np)
256 {
257 	struct device_node *parent;
258 
259 	if (WARN_ON(of_node_check_flag(np, OF_DETACHED)))
260 		return;
261 
262 	parent = np->parent;
263 	if (WARN_ON(!parent))
264 		return;
265 
266 	if (parent->child == np)
267 		parent->child = np->sibling;
268 	else {
269 		struct device_node *prevsib;
270 		for (prevsib = np->parent->child;
271 		     prevsib->sibling != np;
272 		     prevsib = prevsib->sibling)
273 			;
274 		prevsib->sibling = np->sibling;
275 	}
276 
277 	of_node_set_flag(np, OF_DETACHED);
278 
279 	/* race with of_find_node_by_phandle() prevented by devtree_lock */
280 	__of_phandle_cache_inv_entry(np->phandle);
281 }
282 
283 /**
284  * of_detach_node() - "Unplug" a node from the device tree.
285  */
of_detach_node(struct device_node * np)286 int of_detach_node(struct device_node *np)
287 {
288 	struct of_reconfig_data rd;
289 	unsigned long flags;
290 
291 	memset(&rd, 0, sizeof(rd));
292 	rd.dn = np;
293 
294 	mutex_lock(&of_mutex);
295 	raw_spin_lock_irqsave(&devtree_lock, flags);
296 	__of_detach_node(np);
297 	raw_spin_unlock_irqrestore(&devtree_lock, flags);
298 
299 	__of_detach_node_sysfs(np);
300 	mutex_unlock(&of_mutex);
301 
302 	of_reconfig_notify(OF_RECONFIG_DETACH_NODE, &rd);
303 
304 	return 0;
305 }
306 EXPORT_SYMBOL_GPL(of_detach_node);
307 
property_list_free(struct property * prop_list)308 static void property_list_free(struct property *prop_list)
309 {
310 	struct property *prop, *next;
311 
312 	for (prop = prop_list; prop != NULL; prop = next) {
313 		next = prop->next;
314 		kfree(prop->name);
315 		kfree(prop->value);
316 		kfree(prop);
317 	}
318 }
319 
320 /**
321  * of_node_release() - release a dynamically allocated node
322  * @kref: kref element of the node to be released
323  *
324  * In of_node_put() this function is passed to kref_put() as the destructor.
325  */
of_node_release(struct kobject * kobj)326 void of_node_release(struct kobject *kobj)
327 {
328 	struct device_node *node = kobj_to_device_node(kobj);
329 
330 	/* We should never be releasing nodes that haven't been detached. */
331 	if (!of_node_check_flag(node, OF_DETACHED)) {
332 		pr_err("ERROR: Bad of_node_put() on %pOF\n", node);
333 		dump_stack();
334 		return;
335 	}
336 	if (!of_node_check_flag(node, OF_DYNAMIC))
337 		return;
338 
339 	if (of_node_check_flag(node, OF_OVERLAY)) {
340 
341 		if (!of_node_check_flag(node, OF_OVERLAY_FREE_CSET)) {
342 			/* premature refcount of zero, do not free memory */
343 			pr_err("ERROR: memory leak before free overlay changeset,  %pOF\n",
344 			       node);
345 			return;
346 		}
347 
348 		/*
349 		 * If node->properties non-empty then properties were added
350 		 * to this node either by different overlay that has not
351 		 * yet been removed, or by a non-overlay mechanism.
352 		 */
353 		if (node->properties)
354 			pr_err("ERROR: %s(), unexpected properties in %pOF\n",
355 			       __func__, node);
356 	}
357 
358 	property_list_free(node->properties);
359 	property_list_free(node->deadprops);
360 	fwnode_links_purge(of_fwnode_handle(node));
361 
362 	kfree(node->full_name);
363 	kfree(node->data);
364 	kfree(node);
365 }
366 
367 /**
368  * __of_prop_dup - Copy a property dynamically.
369  * @prop:	Property to copy
370  * @allocflags:	Allocation flags (typically pass GFP_KERNEL)
371  *
372  * Copy a property by dynamically allocating the memory of both the
373  * property structure and the property name & contents. The property's
374  * flags have the OF_DYNAMIC bit set so that we can differentiate between
375  * dynamically allocated properties and not.
376  *
377  * Return: The newly allocated property or NULL on out of memory error.
378  */
__of_prop_dup(const struct property * prop,gfp_t allocflags)379 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags)
380 {
381 	struct property *new;
382 
383 	new = kzalloc(sizeof(*new), allocflags);
384 	if (!new)
385 		return NULL;
386 
387 	/*
388 	 * NOTE: There is no check for zero length value.
389 	 * In case of a boolean property, this will allocate a value
390 	 * of zero bytes. We do this to work around the use
391 	 * of of_get_property() calls on boolean values.
392 	 */
393 	new->name = kstrdup(prop->name, allocflags);
394 	new->value = kmemdup(prop->value, prop->length, allocflags);
395 	new->length = prop->length;
396 	if (!new->name || !new->value)
397 		goto err_free;
398 
399 	/* mark the property as dynamic */
400 	of_property_set_flag(new, OF_DYNAMIC);
401 
402 	return new;
403 
404  err_free:
405 	kfree(new->name);
406 	kfree(new->value);
407 	kfree(new);
408 	return NULL;
409 }
410 
411 /**
412  * __of_node_dup() - Duplicate or create an empty device node dynamically.
413  * @np:		if not NULL, contains properties to be duplicated in new node
414  * @full_name:	string value to be duplicated into new node's full_name field
415  *
416  * Create a device tree node, optionally duplicating the properties of
417  * another node.  The node data are dynamically allocated and all the node
418  * flags have the OF_DYNAMIC & OF_DETACHED bits set.
419  *
420  * Return: The newly allocated node or NULL on out of memory error.
421  */
__of_node_dup(const struct device_node * np,const char * full_name)422 struct device_node *__of_node_dup(const struct device_node *np,
423 				  const char *full_name)
424 {
425 	struct device_node *node;
426 
427 	node = kzalloc(sizeof(*node), GFP_KERNEL);
428 	if (!node)
429 		return NULL;
430 	node->full_name = kstrdup(full_name, GFP_KERNEL);
431 	if (!node->full_name) {
432 		kfree(node);
433 		return NULL;
434 	}
435 
436 	of_node_set_flag(node, OF_DYNAMIC);
437 	of_node_set_flag(node, OF_DETACHED);
438 	of_node_init(node);
439 
440 	/* Iterate over and duplicate all properties */
441 	if (np) {
442 		struct property *pp, *new_pp;
443 		for_each_property_of_node(np, pp) {
444 			new_pp = __of_prop_dup(pp, GFP_KERNEL);
445 			if (!new_pp)
446 				goto err_prop;
447 			if (__of_add_property(node, new_pp)) {
448 				kfree(new_pp->name);
449 				kfree(new_pp->value);
450 				kfree(new_pp);
451 				goto err_prop;
452 			}
453 		}
454 	}
455 	return node;
456 
457  err_prop:
458 	of_node_put(node); /* Frees the node and properties */
459 	return NULL;
460 }
461 
__of_changeset_entry_destroy(struct of_changeset_entry * ce)462 static void __of_changeset_entry_destroy(struct of_changeset_entry *ce)
463 {
464 	if (ce->action == OF_RECONFIG_ATTACH_NODE &&
465 	    of_node_check_flag(ce->np, OF_OVERLAY)) {
466 		if (kref_read(&ce->np->kobj.kref) > 1) {
467 			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",
468 			       kref_read(&ce->np->kobj.kref), ce->np);
469 		} else {
470 			of_node_set_flag(ce->np, OF_OVERLAY_FREE_CSET);
471 		}
472 	}
473 
474 	of_node_put(ce->np);
475 	list_del(&ce->node);
476 	kfree(ce);
477 }
478 
479 #ifdef DEBUG
__of_changeset_entry_dump(struct of_changeset_entry * ce)480 static void __of_changeset_entry_dump(struct of_changeset_entry *ce)
481 {
482 	switch (ce->action) {
483 	case OF_RECONFIG_ADD_PROPERTY:
484 	case OF_RECONFIG_REMOVE_PROPERTY:
485 	case OF_RECONFIG_UPDATE_PROPERTY:
486 		pr_debug("cset<%p> %-15s %pOF/%s\n", ce, action_names[ce->action],
487 			ce->np, ce->prop->name);
488 		break;
489 	case OF_RECONFIG_ATTACH_NODE:
490 	case OF_RECONFIG_DETACH_NODE:
491 		pr_debug("cset<%p> %-15s %pOF\n", ce, action_names[ce->action],
492 			ce->np);
493 		break;
494 	}
495 }
496 #else
__of_changeset_entry_dump(struct of_changeset_entry * ce)497 static inline void __of_changeset_entry_dump(struct of_changeset_entry *ce)
498 {
499 	/* empty */
500 }
501 #endif
502 
__of_changeset_entry_invert(struct of_changeset_entry * ce,struct of_changeset_entry * rce)503 static void __of_changeset_entry_invert(struct of_changeset_entry *ce,
504 					  struct of_changeset_entry *rce)
505 {
506 	memcpy(rce, ce, sizeof(*rce));
507 
508 	switch (ce->action) {
509 	case OF_RECONFIG_ATTACH_NODE:
510 		rce->action = OF_RECONFIG_DETACH_NODE;
511 		break;
512 	case OF_RECONFIG_DETACH_NODE:
513 		rce->action = OF_RECONFIG_ATTACH_NODE;
514 		break;
515 	case OF_RECONFIG_ADD_PROPERTY:
516 		rce->action = OF_RECONFIG_REMOVE_PROPERTY;
517 		break;
518 	case OF_RECONFIG_REMOVE_PROPERTY:
519 		rce->action = OF_RECONFIG_ADD_PROPERTY;
520 		break;
521 	case OF_RECONFIG_UPDATE_PROPERTY:
522 		rce->old_prop = ce->prop;
523 		rce->prop = ce->old_prop;
524 		/* update was used but original property did not exist */
525 		if (!rce->prop) {
526 			rce->action = OF_RECONFIG_REMOVE_PROPERTY;
527 			rce->prop = ce->prop;
528 		}
529 		break;
530 	}
531 }
532 
__of_changeset_entry_notify(struct of_changeset_entry * ce,bool revert)533 static int __of_changeset_entry_notify(struct of_changeset_entry *ce,
534 		bool revert)
535 {
536 	struct of_reconfig_data rd;
537 	struct of_changeset_entry ce_inverted;
538 	int ret = 0;
539 
540 	if (revert) {
541 		__of_changeset_entry_invert(ce, &ce_inverted);
542 		ce = &ce_inverted;
543 	}
544 
545 	switch (ce->action) {
546 	case OF_RECONFIG_ATTACH_NODE:
547 	case OF_RECONFIG_DETACH_NODE:
548 		memset(&rd, 0, sizeof(rd));
549 		rd.dn = ce->np;
550 		ret = of_reconfig_notify(ce->action, &rd);
551 		break;
552 	case OF_RECONFIG_ADD_PROPERTY:
553 	case OF_RECONFIG_REMOVE_PROPERTY:
554 	case OF_RECONFIG_UPDATE_PROPERTY:
555 		ret = of_property_notify(ce->action, ce->np, ce->prop, ce->old_prop);
556 		break;
557 	default:
558 		pr_err("invalid devicetree changeset action: %i\n",
559 			(int)ce->action);
560 		ret = -EINVAL;
561 	}
562 
563 	if (ret)
564 		pr_err("changeset notifier error @%pOF\n", ce->np);
565 	return ret;
566 }
567 
__of_changeset_entry_apply(struct of_changeset_entry * ce)568 static int __of_changeset_entry_apply(struct of_changeset_entry *ce)
569 {
570 	struct property *old_prop, **propp;
571 	unsigned long flags;
572 	int ret = 0;
573 
574 	__of_changeset_entry_dump(ce);
575 
576 	raw_spin_lock_irqsave(&devtree_lock, flags);
577 	switch (ce->action) {
578 	case OF_RECONFIG_ATTACH_NODE:
579 		__of_attach_node(ce->np);
580 		break;
581 	case OF_RECONFIG_DETACH_NODE:
582 		__of_detach_node(ce->np);
583 		break;
584 	case OF_RECONFIG_ADD_PROPERTY:
585 		/* If the property is in deadprops then it must be removed */
586 		for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
587 			if (*propp == ce->prop) {
588 				*propp = ce->prop->next;
589 				ce->prop->next = NULL;
590 				break;
591 			}
592 		}
593 
594 		ret = __of_add_property(ce->np, ce->prop);
595 		break;
596 	case OF_RECONFIG_REMOVE_PROPERTY:
597 		ret = __of_remove_property(ce->np, ce->prop);
598 		break;
599 
600 	case OF_RECONFIG_UPDATE_PROPERTY:
601 		/* If the property is in deadprops then it must be removed */
602 		for (propp = &ce->np->deadprops; *propp; propp = &(*propp)->next) {
603 			if (*propp == ce->prop) {
604 				*propp = ce->prop->next;
605 				ce->prop->next = NULL;
606 				break;
607 			}
608 		}
609 
610 		ret = __of_update_property(ce->np, ce->prop, &old_prop);
611 		break;
612 	default:
613 		ret = -EINVAL;
614 	}
615 	raw_spin_unlock_irqrestore(&devtree_lock, flags);
616 
617 	if (ret) {
618 		pr_err("changeset: apply failed: %-15s %pOF:%s\n",
619 		       action_names[ce->action], ce->np, ce->prop->name);
620 		return ret;
621 	}
622 
623 	switch (ce->action) {
624 	case OF_RECONFIG_ATTACH_NODE:
625 		__of_attach_node_sysfs(ce->np);
626 		break;
627 	case OF_RECONFIG_DETACH_NODE:
628 		__of_detach_node_sysfs(ce->np);
629 		break;
630 	case OF_RECONFIG_ADD_PROPERTY:
631 		/* ignore duplicate names */
632 		__of_add_property_sysfs(ce->np, ce->prop);
633 		break;
634 	case OF_RECONFIG_REMOVE_PROPERTY:
635 		__of_remove_property_sysfs(ce->np, ce->prop);
636 		break;
637 	case OF_RECONFIG_UPDATE_PROPERTY:
638 		__of_update_property_sysfs(ce->np, ce->prop, ce->old_prop);
639 		break;
640 	}
641 
642 	return 0;
643 }
644 
__of_changeset_entry_revert(struct of_changeset_entry * ce)645 static inline int __of_changeset_entry_revert(struct of_changeset_entry *ce)
646 {
647 	struct of_changeset_entry ce_inverted;
648 
649 	__of_changeset_entry_invert(ce, &ce_inverted);
650 	return __of_changeset_entry_apply(&ce_inverted);
651 }
652 
653 /**
654  * of_changeset_init - Initialize a changeset for use
655  *
656  * @ocs:	changeset pointer
657  *
658  * Initialize a changeset structure
659  */
of_changeset_init(struct of_changeset * ocs)660 void of_changeset_init(struct of_changeset *ocs)
661 {
662 	memset(ocs, 0, sizeof(*ocs));
663 	INIT_LIST_HEAD(&ocs->entries);
664 }
665 EXPORT_SYMBOL_GPL(of_changeset_init);
666 
667 /**
668  * of_changeset_destroy - Destroy a changeset
669  *
670  * @ocs:	changeset pointer
671  *
672  * Destroys a changeset. Note that if a changeset is applied,
673  * its changes to the tree cannot be reverted.
674  */
of_changeset_destroy(struct of_changeset * ocs)675 void of_changeset_destroy(struct of_changeset *ocs)
676 {
677 	struct of_changeset_entry *ce, *cen;
678 
679 	list_for_each_entry_safe_reverse(ce, cen, &ocs->entries, node)
680 		__of_changeset_entry_destroy(ce);
681 }
682 EXPORT_SYMBOL_GPL(of_changeset_destroy);
683 
684 /*
685  * Apply the changeset entries in @ocs.
686  * If apply fails, an attempt is made to revert the entries that were
687  * successfully applied.
688  *
689  * If multiple revert errors occur then only the final revert error is reported.
690  *
691  * Returns 0 on success, a negative error value in case of an error.
692  * If a revert error occurs, it is returned in *ret_revert.
693  */
__of_changeset_apply_entries(struct of_changeset * ocs,int * ret_revert)694 int __of_changeset_apply_entries(struct of_changeset *ocs, int *ret_revert)
695 {
696 	struct of_changeset_entry *ce;
697 	int ret, ret_tmp;
698 
699 	pr_debug("changeset: applying...\n");
700 	list_for_each_entry(ce, &ocs->entries, node) {
701 		ret = __of_changeset_entry_apply(ce);
702 		if (ret) {
703 			pr_err("Error applying changeset (%d)\n", ret);
704 			list_for_each_entry_continue_reverse(ce, &ocs->entries,
705 							     node) {
706 				ret_tmp = __of_changeset_entry_revert(ce);
707 				if (ret_tmp)
708 					*ret_revert = ret_tmp;
709 			}
710 			return ret;
711 		}
712 	}
713 
714 	return 0;
715 }
716 
717 /*
718  * Returns 0 on success, a negative error value in case of an error.
719  *
720  * If multiple changeset entry notification errors occur then only the
721  * final notification error is reported.
722  */
__of_changeset_apply_notify(struct of_changeset * ocs)723 int __of_changeset_apply_notify(struct of_changeset *ocs)
724 {
725 	struct of_changeset_entry *ce;
726 	int ret = 0, ret_tmp;
727 
728 	pr_debug("changeset: emitting notifiers.\n");
729 
730 	/* drop the global lock while emitting notifiers */
731 	mutex_unlock(&of_mutex);
732 	list_for_each_entry(ce, &ocs->entries, node) {
733 		ret_tmp = __of_changeset_entry_notify(ce, 0);
734 		if (ret_tmp)
735 			ret = ret_tmp;
736 	}
737 	mutex_lock(&of_mutex);
738 	pr_debug("changeset: notifiers sent.\n");
739 
740 	return ret;
741 }
742 
743 /*
744  * Returns 0 on success, a negative error value in case of an error.
745  *
746  * If a changeset entry apply fails, an attempt is made to revert any
747  * previous entries in the changeset.  If any of the reverts fails,
748  * that failure is not reported.  Thus the state of the device tree
749  * is unknown if an apply error occurs.
750  */
__of_changeset_apply(struct of_changeset * ocs)751 static int __of_changeset_apply(struct of_changeset *ocs)
752 {
753 	int ret, ret_revert = 0;
754 
755 	ret = __of_changeset_apply_entries(ocs, &ret_revert);
756 	if (!ret)
757 		ret = __of_changeset_apply_notify(ocs);
758 
759 	return ret;
760 }
761 
762 /**
763  * of_changeset_apply - Applies a changeset
764  *
765  * @ocs:	changeset pointer
766  *
767  * Applies a changeset to the live tree.
768  * Any side-effects of live tree state changes are applied here on
769  * success, like creation/destruction of devices and side-effects
770  * like creation of sysfs properties and directories.
771  *
772  * Return: 0 on success, a negative error value in case of an error.
773  * On error the partially applied effects are reverted.
774  */
of_changeset_apply(struct of_changeset * ocs)775 int of_changeset_apply(struct of_changeset *ocs)
776 {
777 	int ret;
778 
779 	mutex_lock(&of_mutex);
780 	ret = __of_changeset_apply(ocs);
781 	mutex_unlock(&of_mutex);
782 
783 	return ret;
784 }
785 EXPORT_SYMBOL_GPL(of_changeset_apply);
786 
787 /*
788  * Revert the changeset entries in @ocs.
789  * If revert fails, an attempt is made to re-apply the entries that were
790  * successfully removed.
791  *
792  * If multiple re-apply errors occur then only the final apply error is
793  * reported.
794  *
795  * Returns 0 on success, a negative error value in case of an error.
796  * If an apply error occurs, it is returned in *ret_apply.
797  */
__of_changeset_revert_entries(struct of_changeset * ocs,int * ret_apply)798 int __of_changeset_revert_entries(struct of_changeset *ocs, int *ret_apply)
799 {
800 	struct of_changeset_entry *ce;
801 	int ret, ret_tmp;
802 
803 	pr_debug("changeset: reverting...\n");
804 	list_for_each_entry_reverse(ce, &ocs->entries, node) {
805 		ret = __of_changeset_entry_revert(ce);
806 		if (ret) {
807 			pr_err("Error reverting changeset (%d)\n", ret);
808 			list_for_each_entry_continue(ce, &ocs->entries, node) {
809 				ret_tmp = __of_changeset_entry_apply(ce);
810 				if (ret_tmp)
811 					*ret_apply = ret_tmp;
812 			}
813 			return ret;
814 		}
815 	}
816 
817 	return 0;
818 }
819 
820 /*
821  * If multiple changeset entry notification errors occur then only the
822  * final notification error is reported.
823  */
__of_changeset_revert_notify(struct of_changeset * ocs)824 int __of_changeset_revert_notify(struct of_changeset *ocs)
825 {
826 	struct of_changeset_entry *ce;
827 	int ret = 0, ret_tmp;
828 
829 	pr_debug("changeset: emitting notifiers.\n");
830 
831 	/* drop the global lock while emitting notifiers */
832 	mutex_unlock(&of_mutex);
833 	list_for_each_entry_reverse(ce, &ocs->entries, node) {
834 		ret_tmp = __of_changeset_entry_notify(ce, 1);
835 		if (ret_tmp)
836 			ret = ret_tmp;
837 	}
838 	mutex_lock(&of_mutex);
839 	pr_debug("changeset: notifiers sent.\n");
840 
841 	return ret;
842 }
843 
__of_changeset_revert(struct of_changeset * ocs)844 static int __of_changeset_revert(struct of_changeset *ocs)
845 {
846 	int ret, ret_reply;
847 
848 	ret_reply = 0;
849 	ret = __of_changeset_revert_entries(ocs, &ret_reply);
850 
851 	if (!ret)
852 		ret = __of_changeset_revert_notify(ocs);
853 
854 	return ret;
855 }
856 
857 /**
858  * of_changeset_revert - Reverts an applied changeset
859  *
860  * @ocs:	changeset pointer
861  *
862  * Reverts a changeset returning the state of the tree to what it
863  * was before the application.
864  * Any side-effects like creation/destruction of devices and
865  * removal of sysfs properties and directories are applied.
866  *
867  * Return: 0 on success, a negative error value in case of an error.
868  */
of_changeset_revert(struct of_changeset * ocs)869 int of_changeset_revert(struct of_changeset *ocs)
870 {
871 	int ret;
872 
873 	mutex_lock(&of_mutex);
874 	ret = __of_changeset_revert(ocs);
875 	mutex_unlock(&of_mutex);
876 
877 	return ret;
878 }
879 EXPORT_SYMBOL_GPL(of_changeset_revert);
880 
881 /**
882  * of_changeset_action - Add an action to the tail of the changeset list
883  *
884  * @ocs:	changeset pointer
885  * @action:	action to perform
886  * @np:		Pointer to device node
887  * @prop:	Pointer to property
888  *
889  * On action being one of:
890  * + OF_RECONFIG_ATTACH_NODE
891  * + OF_RECONFIG_DETACH_NODE,
892  * + OF_RECONFIG_ADD_PROPERTY
893  * + OF_RECONFIG_REMOVE_PROPERTY,
894  * + OF_RECONFIG_UPDATE_PROPERTY
895  *
896  * Return: 0 on success, a negative error value in case of an error.
897  */
of_changeset_action(struct of_changeset * ocs,unsigned long action,struct device_node * np,struct property * prop)898 int of_changeset_action(struct of_changeset *ocs, unsigned long action,
899 		struct device_node *np, struct property *prop)
900 {
901 	struct of_changeset_entry *ce;
902 
903 	if (WARN_ON(action >= ARRAY_SIZE(action_names)))
904 		return -EINVAL;
905 
906 	ce = kzalloc(sizeof(*ce), GFP_KERNEL);
907 	if (!ce)
908 		return -ENOMEM;
909 
910 	/* get a reference to the node */
911 	ce->action = action;
912 	ce->np = of_node_get(np);
913 	ce->prop = prop;
914 
915 	if (action == OF_RECONFIG_UPDATE_PROPERTY && prop)
916 		ce->old_prop = of_find_property(np, prop->name, NULL);
917 
918 	/* add it to the list */
919 	list_add_tail(&ce->node, &ocs->entries);
920 	return 0;
921 }
922 EXPORT_SYMBOL_GPL(of_changeset_action);
923