doc/README.fdt-control

   1 # SPDX-License-Identifier: GPL-2.0+
   2 #
   3 # Copyright (c) 2011 The Chromium OS Authors.
   4
   5 Device Tree Control in U-Boot
   6 =============================
   7
   8 This feature provides for run-time configuration of U-Boot via a flat
   9 device tree (fdt). U-Boot configuration has traditionally been done
  10 using CONFIG options in the board config file. This feature aims to
  11 make it possible for a single U-Boot binary to support multiple boards,
  12 with the exact configuration of each board controlled by a flat device
  13 tree (fdt). This is the approach recently taken by the ARM Linux kernel
  14 and has been used by PowerPC for some time.
  15
  16 The fdt is a convenient vehicle for implementing run-time configuration
  17 for three reasons. Firstly it is easy to use, being a simple text file.
  18 It is extensible since it consists of nodes and properties in a nice
  19 hierarchical format.
  20
  21 Finally, there is already excellent infrastructure for the fdt: a
  22 compiler checks the text file and converts it to a compact binary
  23 format, and a library is already available in U-Boot (libfdt) for
  24 handling this format.
  25
  26 The dts directory contains a Makefile for building the device tree blob
  27 and embedding it in your U-Boot image. This is useful since it allows
  28 U-Boot to configure itself according to what it finds there. If you have
  29 a number of similar boards with different peripherals, you can describe
  30 the features of each board in the device tree file, and have a single
  31 generic source base.
  32
  33 To enable this feature, add CONFIG_OF_CONTROL to your board config file.
  34
  35
  36 What is a Flat Device Tree?
  37 ---------------------------
  38
  39 An fdt can be specified in source format as a text file. To read about
  40 the fdt syntax, take a look at the specification here:
  41
  42 https://www.power.org/resources/downloads/Power_ePAPR_APPROVED_v1.0.pdf
  43
  44 You also might find this section of the Linux kernel documentation
  45 useful: (access this in the Linux kernel source code)
  46
  47         Documentation/devicetree/booting-without-of.txt
  48
  49 There is also a mailing list:
  50
  51         http://lists.ozlabs.org/listinfo/devicetree-discuss
  52
  53 In case you are wondering, OF stands for Open Firmware.
  54
  55
  56 Tools
  57 -----
  58
  59 To use this feature you will need to get the device tree compiler. This is
  60 provided by U-Boot automatically. If you have a system version of dtc
  61 (typically in the 'device-tree-compiler' package), it is currently not used.
  62
  63 If you want to build your own dtc, it is kept here:
  64
  65         git://git.kernel.org/pub/scm/utils/dtc/dtc.git
  66
  67 For example:
  68
  69         $ git clone git://git.kernel.org/pub/scm/utils/dtc/dtc.git
  70         $ cd dtc
  71         $ make
  72         $ sudo make install
  73
  74 Then run the compiler (your version will vary):
  75
  76         $ dtc -v
  77         Version: DTC 1.2.0-g2cb4b51f
  78         $ make tests
  79         $ cd tests
  80         $ ./run_tests.sh
  81         ********** TEST SUMMARY
  82         *     Total testcases:  1371
  83         *                PASS:  1371
  84         *                FAIL:  0
  85         *   Bad configuration:  0
  86         * Strange test result:  0
  87
  88 You will also find a useful fdtdump utility for decoding a binary file, as
  89 well as fdtget/fdtput for reading and writing properties in a binary file.
  90
  91
  92 Where do I get an fdt file for my board?
  93 ----------------------------------------
  94
  95 You may find that the Linux kernel has a suitable file. Look in the
  96 kernel source in arch/<arch>/boot/dts.
  97
  98 If not you might find other boards with suitable files that you can
  99 modify to your needs. Look in the board directories for files with a
 100 .dts extension.
 101
 102 Failing that, you could write one from scratch yourself!
 103
 104
 105 Configuration
 106 -------------
 107
 108 Use:
 109
 110 #define CONFIG_DEFAULT_DEVICE_TREE      "<name>"
 111
 112 to set the filename of the device tree source. Then put your device tree
 113 file into
 114
 115         board/<vendor>/dts/<name>.dts
 116
 117 This should include your CPU or SOC's device tree file, placed in
 118 arch/<arch>/dts, and then make any adjustments required.
 119
 120 If CONFIG_OF_EMBED is defined, then it will be picked up and built into
 121 the U-Boot image (including u-boot.bin). This is suitable for debugging
 122 and development only and is not recommended for production devices.
 123
 124 If CONFIG_OF_SEPARATE is defined, then it will be built and placed in
 125 a u-boot.dtb file alongside u-boot.bin. A common approach is then to
 126 join the two:
 127
 128         cat u-boot.bin u-boot.dtb >image.bin
 129
 130 and then flash image.bin onto your board. Note that U-Boot creates
 131 u-boot-dtb.bin which does the above step for you also. If you are using
 132 CONFIG_SPL_FRAMEWORK, then u-boot.img will be built to include the device
 133 tree binary.
 134
 135 If CONFIG_OF_BOARD is defined, a board-specific routine will provide the
 136 device tree at runtime, for example if an earlier bootloader stage creates
 137 it and passes it to U-Boot.
 138
 139 If CONFIG_OF_HOSTFILE is defined, then it will be read from a file on
 140 startup. This is only useful for sandbox. Use the -d flag to U-Boot to
 141 specify the file to read.
 142
 143 You cannot use more than one of these options at the same time.
 144
 145 To use a device tree file that you have compiled yourself, pass
 146 EXT_DTB=<filename> to 'make', as in:
 147
 148         make EXT_DTB=boot/am335x-boneblack-pubkey.dtb
 149
 150 Then U-Boot will copy that file to u-boot.dtb, put it in the .img file
 151 if used, and u-boot-dtb.bin.
 152
 153 If you wish to put the fdt at a different address in memory, you can
 154 define the "fdtcontroladdr" environment variable. This is the hex
 155 address of the fdt binary blob, and will override either of the options.
 156 Be aware that this environment variable is checked prior to relocation,
 157 when only the compiled-in environment is available. Therefore it is not
 158 possible to define this variable in the saved SPI/NAND flash
 159 environment, for example (it will be ignored). After relocation, this
 160 variable will be set to the address of the newly relocated fdt blob.
 161 It is read-only and cannot be changed. It can optionally be used to
 162 control the boot process of Linux with bootm/bootz commands.
 163
 164 To use this, put something like this in your board header file:
 165
 166 #define CONFIG_EXTRA_ENV_SETTINGS       "fdtcontroladdr=10000\0"
 167
 168 Build:
 169
 170 After board configuration is done, fdt supported u-boot can be build in two ways:
 171 1)  build the default dts which is defined from CONFIG_DEFAULT_DEVICE_TREE
 172     $ make
 173 2)  build the user specified dts file
 174     $ make DEVICE_TREE=<dts-file-name>
 175
 176
 177 Relocation, SPL and TPL
 178 -----------------------
 179
 180 U-Boot can be divided into three phases: TPL, SPL and U-Boot proper.
 181
 182 The full device tree is available to U-Boot proper, but normally only a subset
 183 (or none at all) is available to TPL and SPL. See 'Pre-Relocation Support' and
 184 'SPL Support' in doc/driver-model/README.txt for more details.
 185
 186
 187 Using several DTBs in the SPL (CONFIG_SPL_MULTI_DTB)
 188 ----------------------------------------------------
 189 In some rare cases it is desirable to let SPL be able to select one DTB among
 190 many. This usually not very useful as the DTB for the SPL is small and usually
 191 fits several platforms. However the DTB sometimes include information that do
 192 work on several platforms (like IO tuning parameters).
 193 In this case it is possible to use CONFIG_SPL_MULTI_DTB. This option appends to
 194 the SPL a FIT image containing several DTBs listed in SPL_OF_LIST.
 195 board_fit_config_name_match() is called to select the right DTB.
 196
 197 If board_fit_config_name_match() relies on DM (DM driver to access an EEPROM
 198 containing the board ID for example), it possible to start with a generic DTB
 199 and then switch over to the right DTB after the detection. For this purpose,
 200 the platform code must call fdtdec_resetup(). Based on the returned flag, the
 201 platform may have to re-initiliaze the DM subusystem using dm_uninit() and
 202 dm_init_and_scan().
 203
 204
 205 Limitations
 206 -----------
 207
 208 U-Boot is designed to build with a single architecture type and CPU
 209 type. So for example it is not possible to build a single ARM binary
 210 which runs on your AT91 and OMAP boards, relying on an fdt to configure
 211 the various features. This is because you must select one of
 212 the CPU families within arch/arm/cpu/arm926ejs (omap or at91) at build
 213 time. Similarly you cannot build for multiple cpu types or
 214 architectures.
 215
 216 That said the complexity reduction by using fdt to support variants of
 217 boards which use the same SOC / CPU can be substantial.
 218
 219 It is important to understand that the fdt only selects options
 220 available in the platform / drivers. It cannot add new drivers (yet). So
 221 you must still have the CONFIG option to enable the driver. For example,
 222 you need to define CONFIG_SYS_NS16550 to bring in the NS16550 driver,
 223 but can use the fdt to specific the UART clock, peripheral address, etc.
 224 In very broad terms, the CONFIG options in general control *what* driver
 225 files are pulled in, and the fdt controls *how* those files work.
 226
 227 --
 228 Simon Glass <sjg@chromium.org>
 229 1-Sep-11