diff options
| author | Grant Likely <grant.likely@linaro.org> | 2014-08-11 09:06:23 -0400 |
|---|---|---|
| committer | Grant Likely <grant.likely@linaro.org> | 2014-08-11 09:06:23 -0400 |
| commit | 663d3f7c2e5e1b018a4c53277ccfde40329d98ca (patch) | |
| tree | a3afcc2d8fe682bdcc4c2e39b47ab3987b38c69a /Documentation/devicetree | |
| parent | b775e642bf958a02210ac4d4edd1a1b7067c49fa (diff) | |
| parent | b6ae5dc54b0a5c542d06d46b9083ceb70bf7e083 (diff) | |
Merge branch 'devicetree/next-overlay' into devicetree/next
Conflicts:
drivers/of/testcase-data/testcases.dts
Diffstat (limited to 'Documentation/devicetree')
| -rw-r--r-- | Documentation/devicetree/changesets.txt | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation/devicetree/changesets.txt b/Documentation/devicetree/changesets.txt new file mode 100644 index 000000000000..935ba5acc34e --- /dev/null +++ b/Documentation/devicetree/changesets.txt | |||
| @@ -0,0 +1,40 @@ | |||
| 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 | |||
| 24 | 3. mutex_lock(of_mutex) - starts a changeset; The global of_mutex | ||
| 25 | ensures there can only be one editor at a time. | ||
| 26 | |||
| 27 | 4. of_changeset_apply() - Apply the changes to the tree. Either the | ||
| 28 | entire changeset will get applied, or if there is an error the tree will | ||
| 29 | be restored to the previous state | ||
| 30 | |||
| 31 | 5. mutex_unlock(of_mutex) - All operations complete, release the mutex | ||
| 32 | |||
| 33 | If a successfully applied changeset needs to be removed, it can be done | ||
| 34 | with the following sequence. | ||
| 35 | |||
| 36 | 1. mutex_lock(of_mutex) | ||
| 37 | |||
| 38 | 2. of_changeset_revert() | ||
| 39 | |||
| 40 | 3. mutex_unlock(of_mutex) | ||
