2 * Support for dynamic device trees.
4 * On some platforms, the device tree can be manipulated at runtime.
5 * The routines in this section support adding, removing and changing
10 #include <linux/spinlock.h>
11 #include <linux/slab.h>
12 #include <linux/string.h>
13 #include <linux/proc_fs.h>
15 #include "of_private.h"
18 * of_node_get() - Increment refcount of a node
19 * @node: Node to inc refcount, NULL is supported to simplify writing of
24 struct device_node
*of_node_get(struct device_node
*node
)
27 kobject_get(&node
->kobj
);
30 EXPORT_SYMBOL(of_node_get
);
33 * of_node_put() - Decrement refcount of a node
34 * @node: Node to dec refcount, NULL is supported to simplify writing of
37 void of_node_put(struct device_node
*node
)
40 kobject_put(&node
->kobj
);
42 EXPORT_SYMBOL(of_node_put
);
44 void __of_detach_node_sysfs(struct device_node
*np
)
48 if (!IS_ENABLED(CONFIG_SYSFS
))
51 BUG_ON(!of_node_is_initialized(np
));
55 /* only remove properties if on sysfs */
56 if (of_node_is_attached(np
)) {
57 for_each_property_of_node(np
, pp
)
58 sysfs_remove_bin_file(&np
->kobj
, &pp
->attr
);
59 kobject_del(&np
->kobj
);
62 /* finally remove the kobj_init ref */
66 static BLOCKING_NOTIFIER_HEAD(of_reconfig_chain
);
68 int of_reconfig_notifier_register(struct notifier_block
*nb
)
70 return blocking_notifier_chain_register(&of_reconfig_chain
, nb
);
72 EXPORT_SYMBOL_GPL(of_reconfig_notifier_register
);
74 int of_reconfig_notifier_unregister(struct notifier_block
*nb
)
76 return blocking_notifier_chain_unregister(&of_reconfig_chain
, nb
);
78 EXPORT_SYMBOL_GPL(of_reconfig_notifier_unregister
);
81 const char *action_names
[] = {
82 [OF_RECONFIG_ATTACH_NODE
] = "ATTACH_NODE",
83 [OF_RECONFIG_DETACH_NODE
] = "DETACH_NODE",
84 [OF_RECONFIG_ADD_PROPERTY
] = "ADD_PROPERTY",
85 [OF_RECONFIG_REMOVE_PROPERTY
] = "REMOVE_PROPERTY",
86 [OF_RECONFIG_UPDATE_PROPERTY
] = "UPDATE_PROPERTY",
90 int of_reconfig_notify(unsigned long action
, struct of_reconfig_data
*p
)
94 struct of_reconfig_data
*pr
= p
;
97 case OF_RECONFIG_ATTACH_NODE
:
98 case OF_RECONFIG_DETACH_NODE
:
99 pr_debug("of/notify %-15s %s\n", action_names
[action
],
102 case OF_RECONFIG_ADD_PROPERTY
:
103 case OF_RECONFIG_REMOVE_PROPERTY
:
104 case OF_RECONFIG_UPDATE_PROPERTY
:
105 pr_debug("of/notify %-15s %s:%s\n", action_names
[action
],
106 pr
->dn
->full_name
, pr
->prop
->name
);
111 rc
= blocking_notifier_call_chain(&of_reconfig_chain
, action
, p
);
112 return notifier_to_errno(rc
);
116 * of_reconfig_get_state_change() - Returns new state of device
117 * @action - action of the of notifier
118 * @arg - argument of the of notifier
120 * Returns the new state of a device based on the notifier used.
121 * Returns 0 on device going from enabled to disabled, 1 on device
122 * going from disabled to enabled and -1 on no change.
124 int of_reconfig_get_state_change(unsigned long action
, struct of_reconfig_data
*pr
)
126 struct property
*prop
, *old_prop
= NULL
;
127 int is_status
, status_state
, old_status_state
, prev_state
, new_state
;
129 /* figure out if a device should be created or destroyed */
131 case OF_RECONFIG_ATTACH_NODE
:
132 case OF_RECONFIG_DETACH_NODE
:
133 prop
= of_find_property(pr
->dn
, "status", NULL
);
135 case OF_RECONFIG_ADD_PROPERTY
:
136 case OF_RECONFIG_REMOVE_PROPERTY
:
139 case OF_RECONFIG_UPDATE_PROPERTY
:
141 old_prop
= pr
->old_prop
;
144 return OF_RECONFIG_NO_CHANGE
;
149 old_status_state
= -1;
153 if (prop
&& !strcmp(prop
->name
, "status")) {
155 status_state
= !strcmp(prop
->value
, "okay") ||
156 !strcmp(prop
->value
, "ok");
158 old_status_state
= !strcmp(old_prop
->value
, "okay") ||
159 !strcmp(old_prop
->value
, "ok");
163 case OF_RECONFIG_ATTACH_NODE
:
165 /* -1 & 0 status either missing or okay */
166 new_state
= status_state
!= 0;
168 case OF_RECONFIG_DETACH_NODE
:
169 /* -1 & 0 status either missing or okay */
170 prev_state
= status_state
!= 0;
173 case OF_RECONFIG_ADD_PROPERTY
:
175 /* no status property -> enabled (legacy) */
177 new_state
= status_state
;
180 case OF_RECONFIG_REMOVE_PROPERTY
:
182 prev_state
= status_state
;
183 /* no status property -> enabled (legacy) */
187 case OF_RECONFIG_UPDATE_PROPERTY
:
189 prev_state
= old_status_state
!= 0;
190 new_state
= status_state
!= 0;
195 if (prev_state
== new_state
)
196 return OF_RECONFIG_NO_CHANGE
;
198 return new_state
? OF_RECONFIG_CHANGE_ADD
: OF_RECONFIG_CHANGE_REMOVE
;
200 EXPORT_SYMBOL_GPL(of_reconfig_get_state_change
);
202 int of_property_notify(int action
, struct device_node
*np
,
203 struct property
*prop
, struct property
*oldprop
)
205 struct of_reconfig_data pr
;
207 /* only call notifiers if the node is attached */
208 if (!of_node_is_attached(np
))
213 pr
.old_prop
= oldprop
;
214 return of_reconfig_notify(action
, &pr
);
217 void __of_attach_node(struct device_node
*np
)
219 const __be32
*phandle
;
222 np
->name
= __of_get_property(np
, "name", NULL
) ? : "<NULL>";
223 np
->type
= __of_get_property(np
, "device_type", NULL
) ? : "<NULL>";
225 phandle
= __of_get_property(np
, "phandle", &sz
);
227 phandle
= __of_get_property(np
, "linux,phandle", &sz
);
228 if (IS_ENABLED(CONFIG_PPC_PSERIES
) && !phandle
)
229 phandle
= __of_get_property(np
, "ibm,phandle", &sz
);
230 np
->phandle
= (phandle
&& (sz
>= 4)) ? be32_to_cpup(phandle
) : 0;
233 np
->sibling
= np
->parent
->child
;
234 np
->parent
->child
= np
;
235 of_node_clear_flag(np
, OF_DETACHED
);
239 * of_attach_node() - Plug a device node into the tree and global list.
241 int of_attach_node(struct device_node
*np
)
243 struct of_reconfig_data rd
;
246 memset(&rd
, 0, sizeof(rd
));
249 mutex_lock(&of_mutex
);
250 raw_spin_lock_irqsave(&devtree_lock
, flags
);
251 __of_attach_node(np
);
252 raw_spin_unlock_irqrestore(&devtree_lock
, flags
);
254 __of_attach_node_sysfs(np
);
255 mutex_unlock(&of_mutex
);
257 of_reconfig_notify(OF_RECONFIG_ATTACH_NODE
, &rd
);
262 void __of_detach_node(struct device_node
*np
)
264 struct device_node
*parent
;
266 if (WARN_ON(of_node_check_flag(np
, OF_DETACHED
)))
270 if (WARN_ON(!parent
))
273 if (parent
->child
== np
)
274 parent
->child
= np
->sibling
;
276 struct device_node
*prevsib
;
277 for (prevsib
= np
->parent
->child
;
278 prevsib
->sibling
!= np
;
279 prevsib
= prevsib
->sibling
)
281 prevsib
->sibling
= np
->sibling
;
284 of_node_set_flag(np
, OF_DETACHED
);
288 * of_detach_node() - "Unplug" a node from the device tree.
290 * The caller must hold a reference to the node. The memory associated with
291 * the node is not freed until its refcount goes to zero.
293 int of_detach_node(struct device_node
*np
)
295 struct of_reconfig_data rd
;
299 memset(&rd
, 0, sizeof(rd
));
302 mutex_lock(&of_mutex
);
303 raw_spin_lock_irqsave(&devtree_lock
, flags
);
304 __of_detach_node(np
);
305 raw_spin_unlock_irqrestore(&devtree_lock
, flags
);
307 __of_detach_node_sysfs(np
);
308 mutex_unlock(&of_mutex
);
310 of_reconfig_notify(OF_RECONFIG_DETACH_NODE
, &rd
);
314 EXPORT_SYMBOL_GPL(of_detach_node
);
317 * of_node_release() - release a dynamically allocated node
318 * @kref: kref element of the node to be released
320 * In of_node_put() this function is passed to kref_put() as the destructor.
322 void of_node_release(struct kobject
*kobj
)
324 struct device_node
*node
= kobj_to_device_node(kobj
);
325 struct property
*prop
= node
->properties
;
327 /* We should never be releasing nodes that haven't been detached. */
328 if (!of_node_check_flag(node
, OF_DETACHED
)) {
329 pr_err("ERROR: Bad of_node_put() on %s\n", node
->full_name
);
334 if (!of_node_check_flag(node
, OF_DYNAMIC
))
338 struct property
*next
= prop
->next
;
345 prop
= node
->deadprops
;
346 node
->deadprops
= NULL
;
349 kfree(node
->full_name
);
355 * __of_prop_dup - Copy a property dynamically.
356 * @prop: Property to copy
357 * @allocflags: Allocation flags (typically pass GFP_KERNEL)
359 * Copy a property by dynamically allocating the memory of both the
360 * property structure and the property name & contents. The property's
361 * flags have the OF_DYNAMIC bit set so that we can differentiate between
362 * dynamically allocated properties and not.
363 * Returns the newly allocated property or NULL on out of memory error.
365 struct property
*__of_prop_dup(const struct property
*prop
, gfp_t allocflags
)
367 struct property
*new;
369 new = kzalloc(sizeof(*new), allocflags
);
374 * NOTE: There is no check for zero length value.
375 * In case of a boolean property, this will allocate a value
376 * of zero bytes. We do this to work around the use
377 * of of_get_property() calls on boolean values.
379 new->name
= kstrdup(prop
->name
, allocflags
);
380 new->value
= kmemdup(prop
->value
, prop
->length
, allocflags
);
381 new->length
= prop
->length
;
382 if (!new->name
|| !new->value
)
385 /* mark the property as dynamic */
386 of_property_set_flag(new, OF_DYNAMIC
);
398 * __of_node_dup() - Duplicate or create an empty device node dynamically.
399 * @fmt: Format string (plus vargs) for new full name of the device node
401 * Create an device tree node, either by duplicating an empty node or by allocating
402 * an empty one suitable for further modification. The node data are
403 * dynamically allocated and all the node flags have the OF_DYNAMIC &
404 * OF_DETACHED bits set. Returns the newly allocated node or NULL on out of
407 struct device_node
*__of_node_dup(const struct device_node
*np
, const char *fmt
, ...)
410 struct device_node
*node
;
412 node
= kzalloc(sizeof(*node
), GFP_KERNEL
);
415 va_start(vargs
, fmt
);
416 node
->full_name
= kvasprintf(GFP_KERNEL
, fmt
, vargs
);
418 if (!node
->full_name
) {
423 of_node_set_flag(node
, OF_DYNAMIC
);
424 of_node_set_flag(node
, OF_DETACHED
);
427 /* Iterate over and duplicate all properties */
429 struct property
*pp
, *new_pp
;
430 for_each_property_of_node(np
, pp
) {
431 new_pp
= __of_prop_dup(pp
, GFP_KERNEL
);
434 if (__of_add_property(node
, new_pp
)) {
436 kfree(new_pp
->value
);
445 of_node_put(node
); /* Frees the node and properties */
449 static void __of_changeset_entry_destroy(struct of_changeset_entry
*ce
)
457 static void __of_changeset_entry_dump(struct of_changeset_entry
*ce
)
459 switch (ce
->action
) {
460 case OF_RECONFIG_ADD_PROPERTY
:
461 case OF_RECONFIG_REMOVE_PROPERTY
:
462 case OF_RECONFIG_UPDATE_PROPERTY
:
463 pr_debug("of/cset<%p> %-15s %s/%s\n", ce
, action_names
[ce
->action
],
464 ce
->np
->full_name
, ce
->prop
->name
);
466 case OF_RECONFIG_ATTACH_NODE
:
467 case OF_RECONFIG_DETACH_NODE
:
468 pr_debug("of/cset<%p> %-15s %s\n", ce
, action_names
[ce
->action
],
474 static inline void __of_changeset_entry_dump(struct of_changeset_entry
*ce
)
480 static void __of_changeset_entry_invert(struct of_changeset_entry
*ce
,
481 struct of_changeset_entry
*rce
)
483 memcpy(rce
, ce
, sizeof(*rce
));
485 switch (ce
->action
) {
486 case OF_RECONFIG_ATTACH_NODE
:
487 rce
->action
= OF_RECONFIG_DETACH_NODE
;
489 case OF_RECONFIG_DETACH_NODE
:
490 rce
->action
= OF_RECONFIG_ATTACH_NODE
;
492 case OF_RECONFIG_ADD_PROPERTY
:
493 rce
->action
= OF_RECONFIG_REMOVE_PROPERTY
;
495 case OF_RECONFIG_REMOVE_PROPERTY
:
496 rce
->action
= OF_RECONFIG_ADD_PROPERTY
;
498 case OF_RECONFIG_UPDATE_PROPERTY
:
499 rce
->old_prop
= ce
->prop
;
500 rce
->prop
= ce
->old_prop
;
501 /* update was used but original property did not exist */
503 rce
->action
= OF_RECONFIG_REMOVE_PROPERTY
;
504 rce
->prop
= ce
->prop
;
510 static void __of_changeset_entry_notify(struct of_changeset_entry
*ce
, bool revert
)
512 struct of_reconfig_data rd
;
513 struct of_changeset_entry ce_inverted
;
517 __of_changeset_entry_invert(ce
, &ce_inverted
);
521 switch (ce
->action
) {
522 case OF_RECONFIG_ATTACH_NODE
:
523 case OF_RECONFIG_DETACH_NODE
:
524 memset(&rd
, 0, sizeof(rd
));
526 ret
= of_reconfig_notify(ce
->action
, &rd
);
528 case OF_RECONFIG_ADD_PROPERTY
:
529 case OF_RECONFIG_REMOVE_PROPERTY
:
530 case OF_RECONFIG_UPDATE_PROPERTY
:
531 ret
= of_property_notify(ce
->action
, ce
->np
, ce
->prop
, ce
->old_prop
);
534 pr_err("%s: invalid devicetree changeset action: %i\n", __func__
,
540 pr_err("%s: notifier error @%s\n", __func__
, ce
->np
->full_name
);
543 static int __of_changeset_entry_apply(struct of_changeset_entry
*ce
)
545 struct property
*old_prop
, **propp
;
549 __of_changeset_entry_dump(ce
);
551 raw_spin_lock_irqsave(&devtree_lock
, flags
);
552 switch (ce
->action
) {
553 case OF_RECONFIG_ATTACH_NODE
:
554 __of_attach_node(ce
->np
);
556 case OF_RECONFIG_DETACH_NODE
:
557 __of_detach_node(ce
->np
);
559 case OF_RECONFIG_ADD_PROPERTY
:
560 /* If the property is in deadprops then it must be removed */
561 for (propp
= &ce
->np
->deadprops
; *propp
; propp
= &(*propp
)->next
) {
562 if (*propp
== ce
->prop
) {
563 *propp
= ce
->prop
->next
;
564 ce
->prop
->next
= NULL
;
569 ret
= __of_add_property(ce
->np
, ce
->prop
);
571 pr_err("%s: add_property failed @%s/%s\n",
572 __func__
, ce
->np
->full_name
,
577 case OF_RECONFIG_REMOVE_PROPERTY
:
578 ret
= __of_remove_property(ce
->np
, ce
->prop
);
580 pr_err("%s: remove_property failed @%s/%s\n",
581 __func__
, ce
->np
->full_name
,
587 case OF_RECONFIG_UPDATE_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
;
597 ret
= __of_update_property(ce
->np
, ce
->prop
, &old_prop
);
599 pr_err("%s: update_property failed @%s/%s\n",
600 __func__
, ce
->np
->full_name
,
608 raw_spin_unlock_irqrestore(&devtree_lock
, flags
);
613 switch (ce
->action
) {
614 case OF_RECONFIG_ATTACH_NODE
:
615 __of_attach_node_sysfs(ce
->np
);
617 case OF_RECONFIG_DETACH_NODE
:
618 __of_detach_node_sysfs(ce
->np
);
620 case OF_RECONFIG_ADD_PROPERTY
:
621 /* ignore duplicate names */
622 __of_add_property_sysfs(ce
->np
, ce
->prop
);
624 case OF_RECONFIG_REMOVE_PROPERTY
:
625 __of_remove_property_sysfs(ce
->np
, ce
->prop
);
627 case OF_RECONFIG_UPDATE_PROPERTY
:
628 __of_update_property_sysfs(ce
->np
, ce
->prop
, ce
->old_prop
);
635 static inline int __of_changeset_entry_revert(struct of_changeset_entry
*ce
)
637 struct of_changeset_entry ce_inverted
;
639 __of_changeset_entry_invert(ce
, &ce_inverted
);
640 return __of_changeset_entry_apply(&ce_inverted
);
644 * of_changeset_init - Initialize a changeset for use
646 * @ocs: changeset pointer
648 * Initialize a changeset structure
650 void of_changeset_init(struct of_changeset
*ocs
)
652 memset(ocs
, 0, sizeof(*ocs
));
653 INIT_LIST_HEAD(&ocs
->entries
);
655 EXPORT_SYMBOL_GPL(of_changeset_init
);
658 * of_changeset_destroy - Destroy a changeset
660 * @ocs: changeset pointer
662 * Destroys a changeset. Note that if a changeset is applied,
663 * its changes to the tree cannot be reverted.
665 void of_changeset_destroy(struct of_changeset
*ocs
)
667 struct of_changeset_entry
*ce
, *cen
;
669 list_for_each_entry_safe_reverse(ce
, cen
, &ocs
->entries
, node
)
670 __of_changeset_entry_destroy(ce
);
672 EXPORT_SYMBOL_GPL(of_changeset_destroy
);
674 int __of_changeset_apply(struct of_changeset
*ocs
)
676 struct of_changeset_entry
*ce
;
679 /* perform the rest of the work */
680 pr_debug("of_changeset: applying...\n");
681 list_for_each_entry(ce
, &ocs
->entries
, node
) {
682 ret
= __of_changeset_entry_apply(ce
);
684 pr_err("%s: Error applying changeset (%d)\n", __func__
, ret
);
685 list_for_each_entry_continue_reverse(ce
, &ocs
->entries
, node
)
686 __of_changeset_entry_revert(ce
);
690 pr_debug("of_changeset: applied, emitting notifiers.\n");
692 /* drop the global lock while emitting notifiers */
693 mutex_unlock(&of_mutex
);
694 list_for_each_entry(ce
, &ocs
->entries
, node
)
695 __of_changeset_entry_notify(ce
, 0);
696 mutex_lock(&of_mutex
);
697 pr_debug("of_changeset: notifiers sent.\n");
703 * of_changeset_apply - Applies a changeset
705 * @ocs: changeset pointer
707 * Applies a changeset to the live tree.
708 * Any side-effects of live tree state changes are applied here on
709 * success, like creation/destruction of devices and side-effects
710 * like creation of sysfs properties and directories.
711 * Returns 0 on success, a negative error value in case of an error.
712 * On error the partially applied effects are reverted.
714 int of_changeset_apply(struct of_changeset
*ocs
)
718 mutex_lock(&of_mutex
);
719 ret
= __of_changeset_apply(ocs
);
720 mutex_unlock(&of_mutex
);
724 EXPORT_SYMBOL_GPL(of_changeset_apply
);
726 int __of_changeset_revert(struct of_changeset
*ocs
)
728 struct of_changeset_entry
*ce
;
731 pr_debug("of_changeset: reverting...\n");
732 list_for_each_entry_reverse(ce
, &ocs
->entries
, node
) {
733 ret
= __of_changeset_entry_revert(ce
);
735 pr_err("%s: Error reverting changeset (%d)\n", __func__
, ret
);
736 list_for_each_entry_continue(ce
, &ocs
->entries
, node
)
737 __of_changeset_entry_apply(ce
);
741 pr_debug("of_changeset: reverted, emitting notifiers.\n");
743 /* drop the global lock while emitting notifiers */
744 mutex_unlock(&of_mutex
);
745 list_for_each_entry_reverse(ce
, &ocs
->entries
, node
)
746 __of_changeset_entry_notify(ce
, 1);
747 mutex_lock(&of_mutex
);
748 pr_debug("of_changeset: notifiers sent.\n");
754 * of_changeset_revert - Reverts an applied changeset
756 * @ocs: changeset pointer
758 * Reverts a changeset returning the state of the tree to what it
759 * was before the application.
760 * Any side-effects like creation/destruction of devices and
761 * removal of sysfs properties and directories are applied.
762 * Returns 0 on success, a negative error value in case of an error.
764 int of_changeset_revert(struct of_changeset
*ocs
)
768 mutex_lock(&of_mutex
);
769 ret
= __of_changeset_revert(ocs
);
770 mutex_unlock(&of_mutex
);
774 EXPORT_SYMBOL_GPL(of_changeset_revert
);
777 * of_changeset_action - Perform a changeset action
779 * @ocs: changeset pointer
780 * @action: action to perform
781 * @np: Pointer to device node
782 * @prop: Pointer to property
784 * On action being one of:
785 * + OF_RECONFIG_ATTACH_NODE
786 * + OF_RECONFIG_DETACH_NODE,
787 * + OF_RECONFIG_ADD_PROPERTY
788 * + OF_RECONFIG_REMOVE_PROPERTY,
789 * + OF_RECONFIG_UPDATE_PROPERTY
790 * Returns 0 on success, a negative error value in case of an error.
792 int of_changeset_action(struct of_changeset
*ocs
, unsigned long action
,
793 struct device_node
*np
, struct property
*prop
)
795 struct of_changeset_entry
*ce
;
797 ce
= kzalloc(sizeof(*ce
), GFP_KERNEL
);
799 pr_err("%s: Failed to allocate\n", __func__
);
802 /* get a reference to the node */
804 ce
->np
= of_node_get(np
);
807 if (action
== OF_RECONFIG_UPDATE_PROPERTY
&& prop
)
808 ce
->old_prop
= of_find_property(np
, prop
->name
, NULL
);
810 /* add it to the list */
811 list_add_tail(&ce
->node
, &ocs
->entries
);
814 EXPORT_SYMBOL_GPL(of_changeset_action
);