Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 1 | # |
| 2 | # Device Tree Control |
| 3 | # |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 4 | |
| 5 | config SUPPORT_OF_CONTROL |
| 6 | bool |
| 7 | |
Tom Rini | 36dd5f1 | 2017-09-23 13:00:57 -0400 | [diff] [blame] | 8 | config DTC |
| 9 | bool |
| 10 | |
Masahiro Yamada | d6a0c78 | 2017-10-17 13:42:44 +0900 | [diff] [blame] | 11 | config PYLIBFDT |
| 12 | bool |
| 13 | |
| 14 | config DTOC |
| 15 | bool |
| 16 | select PYLIBFDT |
| 17 | |
| 18 | config BINMAN |
| 19 | bool |
| 20 | select DTOC |
| 21 | |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 22 | menu "Device Tree Control" |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 23 | depends on SUPPORT_OF_CONTROL |
| 24 | |
| 25 | config OF_CONTROL |
| 26 | bool "Run-time configuration via Device Tree" |
Tom Rini | 36dd5f1 | 2017-09-23 13:00:57 -0400 | [diff] [blame] | 27 | select DTC |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 28 | help |
| 29 | This feature provides for run-time configuration of U-Boot |
| 30 | via a flattened device tree. |
| 31 | |
mario.six@gdsys.cc | 2a79275 | 2017-02-22 16:07:22 +0100 | [diff] [blame] | 32 | config OF_BOARD_FIXUP |
| 33 | bool "Board-specific manipulation of Device Tree" |
| 34 | help |
| 35 | In certain circumstances it is necessary to be able to modify |
| 36 | U-Boot's device tree (e.g. to delete device from it). This option |
| 37 | make the Device Tree writeable and provides a board-specific |
| 38 | "board_fix_fdt" callback (called during pre-relocation time), which |
| 39 | enables the board initialization to modifiy the Device Tree. The |
| 40 | modified copy is subsequently used by U-Boot after relocation. |
| 41 | |
Masahiro Yamada | dffb86e | 2015-08-12 07:31:54 +0900 | [diff] [blame] | 42 | config SPL_OF_CONTROL |
| 43 | bool "Enable run-time configuration via Device Tree in SPL" |
| 44 | depends on SPL && OF_CONTROL |
Simon Glass | 2860f03 | 2015-02-27 22:06:38 -0700 | [diff] [blame] | 45 | help |
| 46 | Some boards use device tree in U-Boot but only have 4KB of SRAM |
Walter Lozano | c9acae3 | 2019-10-22 11:50:19 -0300 | [diff] [blame^] | 47 | which is not enough to support device tree. Disable this option to |
Simon Glass | 2860f03 | 2015-02-27 22:06:38 -0700 | [diff] [blame] | 48 | allow such boards to be supported by U-Boot SPL. |
| 49 | |
Philipp Tomsich | f291ce1 | 2017-06-29 11:11:21 +0200 | [diff] [blame] | 50 | config TPL_OF_CONTROL |
| 51 | bool "Enable run-time configuration via Device Tree in TPL" |
| 52 | depends on TPL && OF_CONTROL |
| 53 | help |
| 54 | Some boards use device tree in U-Boot but only have 4KB of SRAM |
| 55 | which is not enough to support device tree. Enable this option to |
| 56 | allow such boards to be supported by U-Boot TPL. |
| 57 | |
Simon Glass | 5e060d8 | 2017-05-18 20:08:53 -0600 | [diff] [blame] | 58 | config OF_LIVE |
| 59 | bool "Enable use of a live tree" |
| 60 | depends on OF_CONTROL |
| 61 | help |
| 62 | Normally U-Boot uses a flat device tree which saves space and |
| 63 | avoids the need to unpack the tree before use. However a flat |
Michal Simek | 4adc660 | 2018-08-17 10:16:36 +0200 | [diff] [blame] | 64 | tree does not support modification from within U-Boot since it |
Simon Glass | 5e060d8 | 2017-05-18 20:08:53 -0600 | [diff] [blame] | 65 | can invalidate driver-model device tree offsets. This option |
| 66 | enables a live tree which is available after relocation, |
| 67 | and can be adjusted as needed. |
| 68 | |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 69 | choice |
| 70 | prompt "Provider of DTB for DT control" |
| 71 | depends on OF_CONTROL |
| 72 | |
| 73 | config OF_SEPARATE |
| 74 | bool "Separate DTB for DT control" |
| 75 | depends on !SANDBOX |
| 76 | help |
| 77 | If this option is enabled, the device tree will be built and |
| 78 | placed as a separate u-boot.dtb file alongside the U-Boot image. |
| 79 | |
| 80 | config OF_EMBED |
| 81 | bool "Embedded DTB for DT control" |
| 82 | help |
| 83 | If this option is enabled, the device tree will be picked up and |
Simon Glass | 3d3f60c | 2015-08-31 18:47:52 -0600 | [diff] [blame] | 84 | built into the U-Boot image. This is suitable for local debugging |
| 85 | and development only and is not recommended for production devices. |
| 86 | Boards in the mainline U-Boot tree should not use it. |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 87 | |
Alex Deymo | 82f766d | 2017-04-02 01:25:20 -0700 | [diff] [blame] | 88 | config OF_BOARD |
| 89 | bool "Provided by the board at runtime" |
| 90 | depends on !SANDBOX |
| 91 | help |
| 92 | If this option is enabled, the device tree will be provided by |
| 93 | the board at runtime if the board supports it, instead of being |
| 94 | bundled with the image. |
| 95 | |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 96 | config OF_HOSTFILE |
| 97 | bool "Host filed DTB for DT control" |
| 98 | depends on SANDBOX |
| 99 | help |
| 100 | If this option is enabled, DTB will be read from a file on startup. |
| 101 | This is only useful for Sandbox. Use the -d flag to U-Boot to |
| 102 | specify the file to read. |
| 103 | |
Thomas Fitzsimmons | 894c3ad | 2018-06-08 17:59:45 -0400 | [diff] [blame] | 104 | config OF_PRIOR_STAGE |
| 105 | bool "Prior stage bootloader DTB for DT control" |
| 106 | help |
| 107 | If this option is enabled, the device tree used for DT |
| 108 | control will be read from a device tree binary, at a memory |
| 109 | location passed to U-Boot by the prior stage bootloader. |
| 110 | |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 111 | endchoice |
| 112 | |
Masahiro Yamada | f1ef2b6 | 2014-09-22 19:59:06 +0900 | [diff] [blame] | 113 | config DEFAULT_DEVICE_TREE |
| 114 | string "Default Device Tree for DT control" |
Simon Glass | 70d4109 | 2016-02-22 22:55:44 -0700 | [diff] [blame] | 115 | depends on OF_CONTROL |
Masahiro Yamada | f1ef2b6 | 2014-09-22 19:59:06 +0900 | [diff] [blame] | 116 | help |
| 117 | This option specifies the default Device Tree used for DT control. |
Robert P. J. Day | 5699ea6 | 2014-10-21 16:44:32 -0400 | [diff] [blame] | 118 | It can be overridden from the command line: |
Masahiro Yamada | f1ef2b6 | 2014-09-22 19:59:06 +0900 | [diff] [blame] | 119 | $ make DEVICE_TREE=<device-tree-name> |
| 120 | |
Simon Glass | cdf1724 | 2016-02-22 22:55:57 -0700 | [diff] [blame] | 121 | config OF_LIST |
| 122 | string "List of device tree files to include for DT control" |
Jean-Jacques Hiblot | 1195559 | 2017-09-15 12:57:24 +0200 | [diff] [blame] | 123 | depends on SPL_LOAD_FIT || MULTI_DTB_FIT |
Michal Simek | c409bd0 | 2016-05-04 15:14:11 +0200 | [diff] [blame] | 124 | default DEFAULT_DEVICE_TREE |
Simon Glass | cdf1724 | 2016-02-22 22:55:57 -0700 | [diff] [blame] | 125 | help |
| 126 | This option specifies a list of device tree files to use for DT |
Cooper Jr., Franklin | d979740 | 2017-06-16 17:25:09 -0500 | [diff] [blame] | 127 | control. These will be packaged into a FIT. At run-time, U-boot |
| 128 | or SPL will select the correct DT to use by examining the |
| 129 | hardware (e.g. reading a board ID value). This is a list of |
| 130 | device tree files (without the directory or .dtb suffix) |
| 131 | separated by <space>. |
Simon Glass | cdf1724 | 2016-02-22 22:55:57 -0700 | [diff] [blame] | 132 | |
Marek Vasut | 95f4bbd | 2019-03-08 16:06:55 +0100 | [diff] [blame] | 133 | choice |
| 134 | prompt "SPL OF LIST compression" |
| 135 | depends on MULTI_DTB_FIT |
| 136 | default MULTI_DTB_FIT_NO_COMPRESSION |
| 137 | |
| 138 | config MULTI_DTB_FIT_LZO |
| 139 | bool "LZO" |
| 140 | depends on SYS_MALLOC_F |
| 141 | select LZO |
| 142 | help |
| 143 | Compress the FIT image containing the DTBs available for the SPL |
| 144 | using LZO compression. (requires lzop on host). |
| 145 | |
| 146 | config MULTI_DTB_FIT_GZIP |
| 147 | bool "GZIP" |
| 148 | depends on SYS_MALLOC_F |
| 149 | select GZIP |
| 150 | help |
| 151 | Compress the FIT image containing the DTBs available for the SPL |
| 152 | using GZIP compression. (requires gzip on host) |
| 153 | |
| 154 | config MULTI_DTB_FIT_NO_COMPRESSION |
| 155 | bool "No compression" |
| 156 | help |
| 157 | Do not compress the FIT image containing the DTBs available for the SPL. |
| 158 | Use this options only if LZO is not available and the DTBs are very small. |
| 159 | endchoice |
| 160 | |
| 161 | choice |
| 162 | prompt "Location of uncompressed DTBs" |
| 163 | depends on (MULTI_DTB_FIT_GZIP || MULTI_DTB_FIT_LZO) |
| 164 | default MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F |
| 165 | |
| 166 | config MULTI_DTB_FIT_DYN_ALLOC |
| 167 | bool "Dynamically allocate the memory" |
| 168 | depends on SYS_MALLOC_F |
| 169 | |
| 170 | config MULTI_DTB_FIT_USER_DEFINED_AREA |
| 171 | bool "User-defined location" |
| 172 | endchoice |
| 173 | |
| 174 | config MULTI_DTB_FIT_UNCOMPRESS_SZ |
| 175 | hex "Size of memory reserved to uncompress the DTBs" |
| 176 | depends on (MULTI_DTB_FIT_GZIP || MULTI_DTB_FIT_LZO) |
| 177 | default 0x8000 |
| 178 | help |
| 179 | This is the size of this area where the DTBs are uncompressed. |
| 180 | If this area is dynamically allocated, make sure that |
| 181 | SYS_MALLOC_F_LEN is big enough to contain it. |
| 182 | |
| 183 | config MULTI_DTB_FIT_USER_DEF_ADDR |
| 184 | hex "Address of memory where dtbs are uncompressed" |
| 185 | depends on MULTI_DTB_FIT_USER_DEFINED_AREA |
| 186 | help |
| 187 | the FIT image containing the DTBs is uncompressed in an area defined |
| 188 | at compilation time. This is the address of this area. It must be |
| 189 | aligned on 2-byte boundary. |
Jean-Jacques Hiblot | 1195559 | 2017-09-15 12:57:24 +0200 | [diff] [blame] | 190 | |
| 191 | config DTB_RESELECT |
| 192 | bool "Support swapping dtbs at a later point in boot" |
| 193 | depends on MULTI_DTB_FIT |
| 194 | help |
| 195 | It is possible during initial boot you may need to use a generic |
| 196 | dtb until you can fully determine the board your running on. This |
| 197 | config allows boards to implement a function at a later point |
| 198 | during boot to switch to the "correct" dtb. |
| 199 | |
| 200 | config MULTI_DTB_FIT |
| 201 | bool "Support embedding several DTBs in a FIT image for u-boot" |
| 202 | help |
| 203 | This option provides hooks to allow U-boot to parse an |
| 204 | appended FIT image and enable board specific code to then select |
| 205 | the correct DTB to be used. Use this if you need to support |
| 206 | multiple DTBs but don't use the SPL. |
| 207 | |
Jean-Jacques Hiblot | 2f57c95 | 2017-09-15 12:57:32 +0200 | [diff] [blame] | 208 | |
| 209 | config SPL_MULTI_DTB_FIT |
| 210 | depends on SPL_LOAD_FIT && SPL_OF_CONTROL && !SPL_OF_PLATDATA |
| 211 | bool "Support embedding several DTBs in a FIT image for the SPL" |
| 212 | help |
| 213 | This option provides the SPL with the ability to select its own |
| 214 | DTB at runtime from an appended FIT image containing several DTBs. |
| 215 | This allows using the same SPL binary on multiple platforms. |
| 216 | The primary purpose is to handle different versions of |
| 217 | the same platform without tweaking the platform code if the |
| 218 | differences can be expressed in the DTBs (common examples are: bus |
| 219 | capabilities, pad configurations). |
| 220 | |
| 221 | config SPL_OF_LIST |
| 222 | string "List of device tree files to include for DT control in SPL" |
| 223 | depends on SPL_MULTI_DTB_FIT |
| 224 | default OF_LIST |
| 225 | help |
| 226 | This option specifies a list of device tree files to use for DT |
| 227 | control in the SPL. These will be packaged into a FIT. At run-time, |
| 228 | the SPL will select the correct DT to use by examining the |
| 229 | hardware (e.g. reading a board ID value). This is a list of |
| 230 | device tree files (without the directory or .dtb suffix) |
| 231 | separated by <space>. |
| 232 | |
| 233 | choice |
| 234 | prompt "SPL OF LIST compression" |
| 235 | depends on SPL_MULTI_DTB_FIT |
| 236 | default SPL_MULTI_DTB_FIT_LZO |
| 237 | |
| 238 | config SPL_MULTI_DTB_FIT_LZO |
| 239 | bool "LZO" |
| 240 | depends on SYS_MALLOC_F |
| 241 | select SPL_LZO |
| 242 | help |
| 243 | Compress the FIT image containing the DTBs available for the SPL |
| 244 | using LZO compression. (requires lzop on host). |
| 245 | |
| 246 | config SPL_MULTI_DTB_FIT_GZIP |
| 247 | bool "GZIP" |
| 248 | depends on SYS_MALLOC_F |
| 249 | select SPL_GZIP |
| 250 | help |
| 251 | Compress the FIT image containing the DTBs available for the SPL |
| 252 | using GZIP compression. (requires gzip on host) |
| 253 | |
| 254 | config SPL_MULTI_DTB_FIT_NO_COMPRESSION |
| 255 | bool "No compression" |
| 256 | help |
| 257 | Do not compress the FIT image containing the DTBs available for the SPL. |
| 258 | Use this options only if LZO is not available and the DTBs are very small. |
| 259 | endchoice |
| 260 | |
| 261 | choice |
Michal Simek | b844805 | 2018-07-23 08:38:56 +0200 | [diff] [blame] | 262 | prompt "Location of uncompressed DTBs" |
Jean-Jacques Hiblot | 2f57c95 | 2017-09-15 12:57:32 +0200 | [diff] [blame] | 263 | depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO) |
| 264 | default SPL_MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F |
| 265 | |
| 266 | config SPL_MULTI_DTB_FIT_DYN_ALLOC |
| 267 | bool "Dynamically allocate the memory" |
| 268 | depends on SYS_MALLOC_F |
| 269 | |
| 270 | config SPL_MULTI_DTB_FIT_USER_DEFINED_AREA |
| 271 | bool "User-defined location" |
| 272 | endchoice |
| 273 | |
| 274 | config SPL_MULTI_DTB_FIT_UNCOMPRESS_SZ |
| 275 | hex "Size of memory reserved to uncompress the DTBs" |
| 276 | depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO) |
| 277 | default 0x8000 |
| 278 | help |
| 279 | This is the size of this area where the DTBs are uncompressed. |
| 280 | If this area is dynamically allocated, make sure that |
| 281 | SPL_SYS_MALLOC_F_LEN is big enough to contain it. |
| 282 | |
| 283 | config SPL_MULTI_DTB_FIT_USER_DEF_ADDR |
| 284 | hex "Address of memory where dtbs are uncompressed" |
| 285 | depends on SPL_MULTI_DTB_FIT_USER_DEFINED_AREA |
| 286 | help |
| 287 | the FIT image containing the DTBs is uncompressed in an area defined |
| 288 | at compilation time. This is the address of this area. It must be |
| 289 | aligned on 2-byte boundary. |
| 290 | |
Simon Glass | fa78e0a | 2015-06-23 15:38:29 -0600 | [diff] [blame] | 291 | config OF_SPL_REMOVE_PROPS |
| 292 | string "List of device tree properties to drop for SPL" |
Masahiro Yamada | 897705e | 2015-08-28 20:28:42 +0900 | [diff] [blame] | 293 | depends on SPL_OF_CONTROL |
Michal Simek | f00d89f | 2019-02-22 10:50:23 +0100 | [diff] [blame] | 294 | default "interrupt-parent interrupts" if SPL_PINCTRL && SPL_CLK |
| 295 | default "clocks clock-names interrupt-parent interrupts" if SPL_PINCTRL |
| 296 | default "pinctrl-0 pinctrl-names interrupt-parent interrupts" if SPL_CLK |
| 297 | default "pinctrl-0 pinctrl-names clocks clock-names interrupt-parent interrupts" |
Simon Glass | fa78e0a | 2015-06-23 15:38:29 -0600 | [diff] [blame] | 298 | help |
| 299 | Since SPL normally runs in a reduced memory space, the device tree |
| 300 | is cut down to only what is needed to load and start U-Boot. Only |
| 301 | nodes marked with the property "u-boot,dm-pre-reloc" will be |
| 302 | included. In addition, some properties are not used by U-Boot and |
| 303 | can be discarded. This option defines the list of properties to |
| 304 | discard. |
| 305 | |
Simon Glass | 2789ddb | 2016-07-04 11:58:06 -0600 | [diff] [blame] | 306 | config SPL_OF_PLATDATA |
| 307 | bool "Generate platform data for use in SPL" |
| 308 | depends on SPL_OF_CONTROL |
Masahiro Yamada | d6a0c78 | 2017-10-17 13:42:44 +0900 | [diff] [blame] | 309 | select DTOC |
Simon Glass | 2789ddb | 2016-07-04 11:58:06 -0600 | [diff] [blame] | 310 | help |
| 311 | For very constrained SPL environments the overhead of decoding |
| 312 | device tree nodes and converting their contents into platform data |
| 313 | is too large. This overhead includes libfdt code as well as the |
| 314 | device tree contents itself. The latter is fairly compact, but the |
| 315 | former can add 3KB or more to a Thumb 2 Image. |
| 316 | |
| 317 | This option enables generation of platform data from the device |
| 318 | tree as C code. This code creates devices using U_BOOT_DEVICE() |
| 319 | declarations. The benefit is that it allows driver code to access |
| 320 | the platform data directly in C structures, avoidin the libfdt |
| 321 | overhead. |
| 322 | |
| 323 | This option works by generating C structure declarations for each |
| 324 | compatible string, then adding platform data and U_BOOT_DEVICE |
Simon Goldschmidt | 3600b46 | 2019-01-16 20:40:18 +0100 | [diff] [blame] | 325 | declarations for each node. See of-plat.txt for more information. |
Simon Glass | 2789ddb | 2016-07-04 11:58:06 -0600 | [diff] [blame] | 326 | |
Philipp Tomsich | f291ce1 | 2017-06-29 11:11:21 +0200 | [diff] [blame] | 327 | config TPL_OF_PLATDATA |
| 328 | bool "Generate platform data for use in TPL" |
| 329 | depends on TPL_OF_CONTROL |
Masahiro Yamada | d6a0c78 | 2017-10-17 13:42:44 +0900 | [diff] [blame] | 330 | select DTOC |
Philipp Tomsich | f291ce1 | 2017-06-29 11:11:21 +0200 | [diff] [blame] | 331 | help |
| 332 | For very constrained SPL environments the overhead of decoding |
| 333 | device tree nodes and converting their contents into platform data |
| 334 | is too large. This overhead includes libfdt code as well as the |
| 335 | device tree contents itself. The latter is fairly compact, but the |
| 336 | former can add 3KB or more to a Thumb 2 Image. |
| 337 | |
| 338 | This option enables generation of platform data from the device |
| 339 | tree as C code. This code creates devices using U_BOOT_DEVICE() |
| 340 | declarations. The benefit is that it allows driver code to access |
| 341 | the platform data directly in C structures, avoidin the libfdt |
| 342 | overhead. |
| 343 | |
| 344 | This option works by generating C structure declarations for each |
| 345 | compatible string, then adding platform data and U_BOOT_DEVICE |
Simon Goldschmidt | 3600b46 | 2019-01-16 20:40:18 +0100 | [diff] [blame] | 346 | declarations for each node. See of-plat.txt for more information. |
Philipp Tomsich | f291ce1 | 2017-06-29 11:11:21 +0200 | [diff] [blame] | 347 | |
Masahiro Yamada | 783e6a7 | 2014-09-22 19:59:05 +0900 | [diff] [blame] | 348 | endmenu |
Tom Rini | 1f6049e | 2017-09-23 23:14:33 -0400 | [diff] [blame] | 349 | |
| 350 | config MKIMAGE_DTC_PATH |
| 351 | string "Path to dtc binary for use within mkimage" |
| 352 | default "dtc" |
| 353 | help |
| 354 | The mkimage host tool will, in order to generate FIT images make |
| 355 | calls to the dtc application in order to create the output. In |
| 356 | some cases the system dtc may not support all required features |
| 357 | and the path to a different version should be given here. |