From: Grant Likely <grant.likely-s3s/WqlpOiPyB63q8FvJNQ@public.gmane.org>
To: devicetree-spec-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Cc: Grant Likely <grant.likely-5wv7dgnIgG8@public.gmane.org>
Subject: [PATCH] Clarify DTB section preable
Date: Tue, 12 Dec 2017 11:08:36 +0000 [thread overview]
Message-ID: <20171212110836.31537-1-grant.likely@arm.com> (raw)
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-5wv7dgnIgG8@public.gmane.org>
---
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
next reply other threads:[~2017-12-12 11:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-12 11:08 Grant Likely [this message]
[not found] ` <20171212110836.31537-1-grant.likely-5wv7dgnIgG8@public.gmane.org>
2017-12-12 11:21 ` [PATCH] Clarify DTB section preable Grant Likely
[not found] ` <CACxGe6v5uFLM5eAnFrRTP1z2+BaUHKaa98y29nZJTyP=Mw4OFg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2017-12-12 13:26 ` Rob Herring
2017-12-16 1:12 ` Frank Rowand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171212110836.31537-1-grant.likely@arm.com \
--to=grant.likely-s3s/wqlpoipyb63q8fvjnq@public.gmane.org \
--cc=devicetree-spec-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
--cc=grant.likely-5wv7dgnIgG8@public.gmane.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).