Add a description of the target root overlay method to the overlay documention file.
Signed-off-by: Pantelis Antoniou <pantelis.anton...@konsulko.com> --- Documentation/devicetree/overlay-notes.txt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation/devicetree/overlay-notes.txt b/Documentation/devicetree/overlay-notes.txt index 6995fc1..3e8df30 100644 --- a/Documentation/devicetree/overlay-notes.txt +++ b/Documentation/devicetree/overlay-notes.txt @@ -104,6 +104,10 @@ If your board has multiple slots/places where a single overlay can work and each slot is defined by a node, you can use the of_overlay_create_target_index() method to select the target. +For overlays on probeable busses, use the of_overlay_create_target_root() method +in which you supply a device node as a target root, and which all target +references in the overlay are performed relative to that node. + Overlay DTS Format ------------------ @@ -141,3 +145,7 @@ contains the information required to map from a phandle to a tree location. Using a target index requires the use of a selector target on the call to of_overlay_create_target_index(). I.e. passing an index of 0 will select the target in the foo node, an index of 1 the bar node, etc. + +Note that when using the target root create method all target references must +lie under the target root node. I.e. the overlay is not allowed to 'break' out +of the root. -- 1.7.12
