Skip to content

Commit 416031c

Browse files
committed
Clarify DTB section preable
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 <[email protected]>
1 parent 1613f17 commit 416031c

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

source/flattened-format.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
.. _chapter-fdt-structure:
22

3-
Flat Devicetree Physical Structure
3+
Flattened Devicetree (DTB) Format
44
==================================
55

6-
With the exception of platforms using IEEE1275 Open Firmware [IEEE1275], the
7-
devicetree data is contained within a single, linear, pointerless data structure
8-
known as the flattened devicetree or devicetree blob.
6+
The Devicetree Blob (DTB) format is a flat binary encoding of devicetree data.
7+
It used to exchange devicetree data between software programs.
8+
For example, when booting an operating system, firmware will pass a DTB to the OS kernel.
99

10-
This data structure consists of a small header
10+
.. note::
11+
12+
IEEE1275 Open Firmware [IEEE1275] does not define the DTB format.
13+
On most Open Firmware compliant platforms the devicetree is extracted by calling firmware methods
14+
to walk through the tree structure.
15+
16+
The DTB format encodes the devicetree data within a single, linear, pointerless data structure.
17+
It consists of a small header
1118
(see section :ref:`sect-fdt-header`),
1219
followed by three variable sized sections:
1320
the memory reservation block (see section :ref:`sect-fdt-memory-reservation-block`),

source/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ may include:
5555
devicetrees.
5656
* Chapter :ref:`chapter-device-bindings` describes device bindings for
5757
certain classes of devices and specific device types.
58-
* Chapter :ref:`chapter-fdt-structure` specifies the physical structure
59-
of devicetrees.
58+
* Chapter :ref:`chapter-fdt-structure` specifies the DTB encoding of devicetrees.
59+
* Chapter :ref:`chapter-devicetree-source-format` specifies the DTS source language.
6060

6161
**Conventions Used in this Document**
6262

source/source-language.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _chapter-devicetree-source-format:
22

3-
Devicetree Source Format (version 1)
3+
Devicetree Source (DTS) Format (version 1)
44
================================================
55

66
The Devicetree Source (DTS) format is a textual representation of a

0 commit comments

Comments
 (0)