[GitHub/moto-9609/android_kernel_motorola_exynos9610.git] / Documentation / devicetree / changesets.txt

A DT changeset is a method which allows one to apply changes
in the live tree in such a way that either the full set of changes
will be applied, or none of them will be. If an error occurs partway
through applying the changeset, then the tree will be rolled back to the
previous state. A changeset can also be removed after it has been
applied.

When a changeset is applied, all of the changes get applied to the tree
at once before emitting OF_RECONFIG notifiers. This is so that the
receiver sees a complete and consistent state of the tree when it
receives the notifier.

The sequence of a changeset is as follows.

1. of_changeset_init() - initializes a changeset

2. A number of DT tree change calls, of_changeset_attach_node(),
of_changeset_detach_node(), of_changeset_add_property(),
of_changeset_remove_property, of_changeset_update_property() to prepare
a set of changes. No changes to the active tree are made at this point.
All the change operations are recorded in the of_changeset 'entries'
list.

3. of_changeset_apply() - Apply the changes to the tree. Either the
entire changeset will get applied, or if there is an error the tree will
be restored to the previous state. The core ensures proper serialization
through locking. An unlocked version __of_changeset_apply is available,
if needed.

If a successfully applied changeset needs to be removed, it can be done
with of_changeset_revert().
Commit	Line	Data
201c910b PA	1	A DT changeset is a method which allows one to apply changes
	2	in the live tree in such a way that either the full set of changes
	3	will be applied, or none of them will be. If an error occurs partway
	4	through applying the changeset, then the tree will be rolled back to the
	5	previous state. A changeset can also be removed after it has been
	6	applied.
	7
	8	When a changeset is applied, all of the changes get applied to the tree
	9	at once before emitting OF_RECONFIG notifiers. This is so that the
	10	receiver sees a complete and consistent state of the tree when it
	11	receives the notifier.
	12
	13	The sequence of a changeset is as follows.
	14
	15	1. of_changeset_init() - initializes a changeset
	16
	17	2. A number of DT tree change calls, of_changeset_attach_node(),
	18	of_changeset_detach_node(), of_changeset_add_property(),
	19	of_changeset_remove_property, of_changeset_update_property() to prepare
	20	a set of changes. No changes to the active tree are made at this point.
	21	All the change operations are recorded in the of_changeset 'entries'
	22	list.
	23
63b77d6d	24	3. of_changeset_apply() - Apply the changes to the tree. Either the
201c910b	25	entire changeset will get applied, or if there is an error the tree will
63b77d6d WS	26	be restored to the previous state. The core ensures proper serialization
	27	through locking. An unlocked version __of_changeset_apply is available,
	28	if needed.
201c910b PA	29
201c910b PA	30	If a successfully applied changeset needs to be removed, it can be done
63b77d6d	31	with of_changeset_revert().