summaryrefslogtreecommitdiffstats
path: root/share/man/man4/fdt.4
diff options
context:
space:
mode:
authorRenato Botelho <renato@netgate.com>2016-06-14 14:40:19 -0500
committerRenato Botelho <renato@netgate.com>2016-06-14 14:40:19 -0500
commit20a32898b6944f9ebcdbb846253d812943036066 (patch)
tree2d3bb1c4acf6d65a66c132d4c59643a3e99dfe34 /share/man/man4/fdt.4
parent4fdb7654ef71cc3e4f0353cc46f28f652cd35605 (diff)
parenta048478c507785f68e86db1a32431aa36773ee06 (diff)
downloadFreeBSD-src-20a32898b6944f9ebcdbb846253d812943036066.zip
FreeBSD-src-20a32898b6944f9ebcdbb846253d812943036066.tar.gz
Merge remote-tracking branch 'origin/master' into devel-11
Diffstat (limited to 'share/man/man4/fdt.4')
-rw-r--r--share/man/man4/fdt.434
1 files changed, 20 insertions, 14 deletions
diff --git a/share/man/man4/fdt.4 b/share/man/man4/fdt.4
index 12542d0..6b371a5 100644
--- a/share/man/man4/fdt.4
+++ b/share/man/man4/fdt.4
@@ -41,19 +41,20 @@
.Sh DESCRIPTION
.Em Flattened Device Tree
is a mechanism for describing computer hardware resources, which cannot be
-probed or self enumerated, in a uniform and portable way. The primary
-consumers of this technology are
+probed or self enumerated, in a uniform and portable way.
+The primary consumers of this technology are
.Em embedded systems,
where a lot of designs are based on similar chips, but have different
assignment of pins, memory layout, addresses bindings, interrupts routing and
other resources.
.Pp
Configuration data, which cannot be self discovered in run-time, has to be
-supplied from external source. The concept of a flattened device tree is a
+supplied from external source.
+The concept of a flattened device tree is a
platform and architecture independent approach for resolving such problems.
The idea is inherited from Open Firmware IEEE 1275 device-tree notion, and has
-been successfully adopted by the embedded industry. The scheme works in the
-following way:
+been successfully adopted by the embedded industry.
+The scheme works in the following way:
.Bl -bullet
.It
Hardware platform resources are
@@ -72,7 +73,8 @@ from this [externally supplied] blob, which eliminates the need for embedding
any information about the underlying platform hardware resources in the kernel.
.It
The flattened device tree mechanism in principle does not depend on any
-particular first-stage bootloader or firmware features. The only overall
+particular first-stage bootloader or firmware features.
+The only overall
requirement for the environment is to provide a complete device tree
description to the kernel.
.El
@@ -89,8 +91,8 @@ maintenance.
.It Va Device tree source (DTS)
The device tree source is a text file which describes hardware resources of a
computer system in a human-readable form, with certain hierarchical structure
-(a tree). The default location for DTS files
-in the
+(a tree).
+The default location for DTS files in the
.Fx
source repository is
.Pa sys/boot/fdt/dts
@@ -140,7 +142,8 @@ kernel level.
.It Va options FDT
The primary option for enabling
.Nm
-support in the kernel. It covers all low-level and infrastructure parts of
+support in the kernel.
+It covers all low-level and infrastructure parts of
.Nm
kernel support, which primarily are the
.Xr fdtbus 4
@@ -149,16 +152,18 @@ and
drivers, as well as helper routines and libraries.
.It Va makeoptions FDT_DTS_FILE=<board name>.dts
Specifies a preferred (default) device tree source (DTS) file for a given
-kernel. The indicated DTS file will be converted (compiled) into a binary form
-along with building the kernel itself. The DTS file name is relative
-to the default location of DTS sources i.e.
+kernel.
+The indicated DTS file will be converted (compiled) into a binary form
+along with building the kernel itself.
+The DTS file name is relative to the default location of DTS sources i.e.
.Pa sys/boot/fdt/dts .
This makeoption is not mandatory unless FDT_DTB_STATIC is also defined (see
below).
.It Va options FDT_DTB_STATIC
Typically, the device tree blob (DTB) is a stand-alone file, physically
separate from the kernel, but this option lets statically embed a
-DTB file into a kernel image. Note that when this is specified the
+DTB file into a kernel image.
+Note that when this is specified the
FDT_DTS_FILE makeoption becomes mandatory (as there needs to be a DTS file
specified in order to embed it into the kernel image).
.El
@@ -182,5 +187,6 @@ support first appeared in
The
.Nm
support was developed by Semihalf under sponsorship from the FreeBSD
-Foundation. This manual page was written by
+Foundation.
+This manual page was written by
.An Rafal Jaworowski .
OpenPOWER on IntegriCloud