Skip to contentSkip to conversation

dm: Update README.txt to clarify device tree usage

PATCH In review Tom Rini 2 participants 4 messages Aug 31, 2018 – Sep 26, 2018

lore
Share & tools
lore

Tom Rini

author
#0 lore raw

PATCH 1/1 dm: Update README.txt to clarify device tree usage

In the section about Device Trees add a paragraph at the end that clarifies how we decide of a tree is valid or not. We say that all bindings must either be in the specification (link provided) or in our device-tree-bindings directory. We say that most of these come from the Linux Kernel and as such some design decisions are made for us already, but that in most cases we wish to retain compatibility.

Cc Simon Glass <[email protected]>
Cc Bin Meng <[email protected]>
---
 doc/driver-model/README.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
doc/driver-model/README.txt +9 -0
index d6fa5c485793..e949ff63bae4 100644
@@ -449,6 +449,15 @@ The driver model tree is intended to mirror that of the device tree. The
 root driver is at device tree offset 0 (the root node, '/'), and its
 children are the children of the root node.
 
+In order for a device tree to be valid, the content must be correct with
+respect to either device tree specification
+(https://www.devicetree.org/specifications/) or the device tree bindings that
+are found in the doc/device-tree-bindings directory.  When not U-Boot specific
+the bindings in this directory tend to come from the Linux Kernel.  As such
+certain design decisions may have been made already for us in terms of how
+specific devices are described and bound.  In most circumstances we wish to
+retain compatibility without additional changes being made to the device tree
+source files.
 
 Declaring Uclasses
 ------------------
Signature · 1 line
2.7.4
#1 lore raw

PATCH 1/1 dm: Update README.txt to clarify device tree usage

Hi Tom,

Quoted 7 lines · Tom Rini

In the section about Device Trees add a paragraph at the end that clarifies how we decide of a tree is valid or not. We say that all bindings must either be in the specification (link provided) or in our device-tree-bindings directory. We say that most of these come from the Linux Kernel and as such some design decisions are made for us already, but that in most cases we wish to retain compatibility.

Quoted 7 lines
Cc Simon Glass <[email protected]>
Cc Bin Meng <[email protected]>
---
 doc/driver-model/README.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

nits below

doc/driver-model/README.txt The driver model tree is intended to mirror that of the device tree. The · line 455

Quoted 12 lines
doc/driver-model/README.txt +4 -0
index d6fa5c485793..e949ff63bae4 100644
@@ -449,6 +449,15 @@ The driver model tree is intended to mirror that of the device tree. The
 root driver is at device tree offset 0 (the root node, '/'), and its
 children are the children of the root node.
 
+In order for a device tree to be valid, the content must be correct with
+respect to either device tree specification
+(https://www.devicetree.org/specifications/) or the device tree bindings that
+are found in the doc/device-tree-bindings directory.  When not U-Boot specific

When not U-Boot-specific,

Quoted 11 lines
doc/driver-model/README.txt +5 -1
+the bindings in this directory tend to come from the Linux Kernel.  As such
+certain design decisions may have been made already for us in terms of how
+specific devices are described and bound.  In most circumstances we wish to
+retain compatibility without additional changes being made to the device tree
+source files.
 
 Declaring Uclasses
 ------------------
--

2.7.4

Regards,
Simon

author
#2 lore raw

PATCH 1/1 dm: Update README.txt to clarify device tree usage

Quoted 37 lines · Simon Glass

Hi Tom,

Quoted 7 lines · Tom Rini

In the section about Device Trees add a paragraph at the end that clarifies how we decide of a tree is valid or not. We say that all bindings must either be in the specification (link provided) or in our device-tree-bindings directory. We say that most of these come from the Linux Kernel and as such some design decisions are made for us already, but that in most cases we wish to retain compatibility.

Quoted 7 lines
Cc Simon Glass <[email protected]>
Cc Bin Meng <[email protected]>
---
 doc/driver-model/README.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

nits below

doc/driver-model/README.txt The driver model tree is intended to mirror that of the device tree. The · line 455

Quoted 12 lines
doc/driver-model/README.txt +4 -0
index d6fa5c485793..e949ff63bae4 100644
@@ -449,6 +449,15 @@ The driver model tree is intended to mirror that of the device tree. The
 root driver is at device tree offset 0 (the root node, '/'), and its
 children are the children of the root node.
 
+In order for a device tree to be valid, the content must be correct with
+respect to either device tree specification
+(https://www.devicetree.org/specifications/) or the device tree bindings that
+are found in the doc/device-tree-bindings directory.  When not U-Boot specific

When not U-Boot-specific,

Quoted 8 lines

doc/driver-model/README.txt The driver model tree is intended to mirror that of the device tree. The · line 463

Quoted 8 lines
doc/driver-model/README.txt +5 -0
+the bindings in this directory tend to come from the Linux Kernel.  As such
+certain design decisions may have been made already for us in terms of how
+specific devices are described and bound.  In most circumstances we wish to
+retain compatibility without additional changes being made to the device tree
+source files.
 
 Declaring Uclasses
 ------------------

Thanks, I'll add the comma when I commit, barring further comments from people.

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180905/fc71d114/attachment.sig>
author
#3 lore raw
In reply to Tom Rini
Quoted 11 lines · Tom Rini

In the section about Device Trees add a paragraph at the end that clarifies how we decide of a tree is valid or not. We say that all bindings must either be in the specification (link provided) or in our device-tree-bindings directory. We say that most of these come from the Linux Kernel and as such some design decisions are made for us already, but that in most cases we wish to retain compatibility.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180926/2e8bd26e/attachment.sig>