[PATCH] Clarify DTB section preable

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]



The DTB chapter used to be titled the "Flattened Devicetree Structure"
chapter, but that seems to be unclear when it is talking about a
specific encoding of devicetree. In this case, the encoding is 'dtb'.
The source format chapter specifies "DTS", so change the start of this
chapter to line up with the DTS chapter.

At the same time, update the introduction to include the source format
chapter.

Signed-off-by: Grant Likely <grant.likely@xxxxxxx>
---
 source/flattened-format.rst | 17 ++++++++++++-----
 source/source-language.rst  |  2 +-
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/source/flattened-format.rst b/source/flattened-format.rst
index a1c358e..bd98891 100644
--- a/source/flattened-format.rst
+++ b/source/flattened-format.rst
@@ -1,13 +1,20 @@
 .. _chapter-fdt-structure:
 
-Flat Devicetree Physical Structure
+Flattened Devicetree (DTB) Format
 ==================================
 
-With the exception of platforms using IEEE1275 Open Firmware [IEEE1275], the
-devicetree data is contained within a single, linear, pointerless data structure
-known as the flattened devicetree or devicetree blob.
+The Devicetree Blob (DTB) format is a flat binary encoding of devicetree data.
+It used to exchange devicetree data between software programs.
+For example, when booting an operating system, firmware will pass a DTB to the OS kernel.
 
-This data structure consists of a small header
+.. note::
+
+   IEEE1275 Open Firmware [IEEE1275] does not define the DTB format.
+   On most Open Firmware compliant platforms the devicetree is extracted by calling firmware methods
+   to walk through the tree structure.
+
+The DTB format encodes the devicetree data within a single, linear, pointerless data structure.
+It consists of a small header
 (see section :ref:`sect-fdt-header`),
 followed by three variable sized sections:
 the memory reservation block (see section :ref:`sect-fdt-memory-reservation-block`),
diff --git a/source/source-language.rst b/source/source-language.rst
index fd6f8af..8dd9710 100755
--- a/source/source-language.rst
+++ b/source/source-language.rst
@@ -1,6 +1,6 @@
 .. _chapter-devicetree-source-format:
 
-Devicetree Source Format (version 1)
+Devicetree Source (DTS) Format (version 1)
 ================================================
 
 The Devicetree Source (DTS) format is a textual representation of a
-- 
2.11.0

--
To unsubscribe from this list: send the line "unsubscribe devicetree-spec" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Device Tree]     [Linux Driver Backports]     [Video for Linux]     [Linux USB Devel]     [Linux Audio Users]     [Photos]     [Yosemite Photos]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Yosemite Backpacking]

  Powered by Linux