]> git.ipfire.org Git - thirdparty/u-boot.git/blame - dts/Kconfig
fdt: Avoid emitting an device tree when not needed
[thirdparty/u-boot.git] / dts / Kconfig
CommitLineData
783e6a72
MY
1#
2# Device Tree Control
3#
783e6a72
MY
4
5config SUPPORT_OF_CONTROL
6 bool
7
d6a0c78a
MY
8config PYLIBFDT
9 bool
10
11config DTOC
12 bool
13 select PYLIBFDT
14
15config BINMAN
16 bool
17 select DTOC
18
783e6a72 19menu "Device Tree Control"
783e6a72
MY
20 depends on SUPPORT_OF_CONTROL
21
22config OF_CONTROL
23 bool "Run-time configuration via Device Tree"
327bb3bc 24 select OF_LIBFDT if !OF_PLATDATA
414cc151 25 select OF_REAL if !OF_PLATDATA
783e6a72
MY
26 help
27 This feature provides for run-time configuration of U-Boot
28 via a flattened device tree.
29
eaad01a3 30config OF_REAL
414cc151 31 bool
eaad01a3
SG
32 help
33 Indicates that a real devicetree is available which can be accessed
34 at runtime. This means that dev_read_...() functions can be used to
35 read data from the devicetree for each device. This is true if
36 OF_CONTROL is enabled in U-Boot proper.
37
2a792753 38config OF_BOARD_FIXUP
39 bool "Board-specific manipulation of Device Tree"
40 help
41 In certain circumstances it is necessary to be able to modify
42 U-Boot's device tree (e.g. to delete device from it). This option
43 make the Device Tree writeable and provides a board-specific
44 "board_fix_fdt" callback (called during pre-relocation time), which
45 enables the board initialization to modifiy the Device Tree. The
46 modified copy is subsequently used by U-Boot after relocation.
47
dffb86e4
MY
48config SPL_OF_CONTROL
49 bool "Enable run-time configuration via Device Tree in SPL"
50 depends on SPL && OF_CONTROL
327bb3bc 51 select SPL_OF_LIBFDT if !SPL_OF_PLATDATA
eaad01a3 52 select SPL_OF_REAL if !SPL_OF_PLATDATA
2860f03b
SG
53 help
54 Some boards use device tree in U-Boot but only have 4KB of SRAM
c9acae33 55 which is not enough to support device tree. Disable this option to
2860f03b
SG
56 allow such boards to be supported by U-Boot SPL.
57
f291ce12
PT
58config TPL_OF_CONTROL
59 bool "Enable run-time configuration via Device Tree in TPL"
60 depends on TPL && OF_CONTROL
327bb3bc 61 select TPL_OF_LIBFDT if !TPL_OF_PLATDATA
eaad01a3 62 select TPL_OF_REAL if !TPL_OF_PLATDATA
f291ce12
PT
63 help
64 Some boards use device tree in U-Boot but only have 4KB of SRAM
65 which is not enough to support device tree. Enable this option to
66 allow such boards to be supported by U-Boot TPL.
67
5e060d8b
SG
68config OF_LIVE
69 bool "Enable use of a live tree"
ced4c31e 70 depends on DM && OF_CONTROL
5e060d8b
SG
71 help
72 Normally U-Boot uses a flat device tree which saves space and
73 avoids the need to unpack the tree before use. However a flat
4adc6605 74 tree does not support modification from within U-Boot since it
5e060d8b
SG
75 can invalidate driver-model device tree offsets. This option
76 enables a live tree which is available after relocation,
77 and can be adjusted as needed.
78
783e6a72
MY
79choice
80 prompt "Provider of DTB for DT control"
81 depends on OF_CONTROL
82
83config OF_SEPARATE
84 bool "Separate DTB for DT control"
783e6a72
MY
85 help
86 If this option is enabled, the device tree will be built and
87 placed as a separate u-boot.dtb file alongside the U-Boot image.
88
89config OF_EMBED
90 bool "Embedded DTB for DT control"
91 help
92 If this option is enabled, the device tree will be picked up and
3d3f60cb
SG
93 built into the U-Boot image. This is suitable for local debugging
94 and development only and is not recommended for production devices.
95 Boards in the mainline U-Boot tree should not use it.
783e6a72 96
836eac7c
SG
97endchoice
98
82f766d1 99config OF_BOARD
2e8d2f88 100 bool "Provided by the board (e.g a previous loader) at runtime"
275b4832 101 default y if SANDBOX || OF_HAS_PRIOR_STAGE
82f766d1 102 help
275b4832
SG
103 If this option is enabled, the device tree is provided at runtime by
104 a custom function called board_fdt_blob_setup(). The board must
105 implement this function if it wishes to provide special behaviour.
82f766d1 106
275b4832
SG
107 With this option, the device tree build by U-Boot may be overridden or
108 ignored. See OF_HAS_PRIOR_STAGE.
109
110 Note: Boards which use this to handle a device tree passed from an
111 earlier stage should enable OF_HAS_PRIOR_STAGE.
112
113config OF_HAS_PRIOR_STAGE
114 bool
115 help
116 Indicates that a prior stage of the firmware (before U-Boot proper)
117 makes use of device tree and this board normally boots with that prior
118 stage, that provides a devicetree to U-Boot.
119
120 This means that the device tree built in U-Boot should not be packaged
121 in the firmware image. Instead, the prior stage's device tree should
122 be so packaged. At runtime, the prior stage reads this, does any
123 necessary fix-ups, then passes it to U-Boot. See OF_BOARD.
124
125 This option does not preclude using the U-Boot device tree, e.g. for
126 development purposes, but it is not recommended, and likely will not
127 even work, for production systems.
128
129 Note: This option must be set in Kconfig and cannot be enabled or
130 disabled in the board's defconfig file.
783e6a72 131
b7d8e85b
SG
132config OF_OMIT_DTB
133 bool "Omit the device tree output when building"
134 default y if OF_HAS_PRIOR_STAGE && !BINMAN
135 help
136 As a special case, avoid writing a device tree file u-boot.dtb when
137 building. Also don't include that file in u-boot.bin
138
139 This is used for boards which normally provide a devicetree via a
140 runtime mechanism (such as OF_BOARD), to avoid confusion.
141
f1ef2b62
MY
142config DEFAULT_DEVICE_TREE
143 string "Default Device Tree for DT control"
70d41093 144 depends on OF_CONTROL
f1ef2b62
MY
145 help
146 This option specifies the default Device Tree used for DT control.
5699ea6d 147 It can be overridden from the command line:
f1ef2b62
MY
148 $ make DEVICE_TREE=<device-tree-name>
149
cdf17246
SG
150config OF_LIST
151 string "List of device tree files to include for DT control"
11955590 152 depends on SPL_LOAD_FIT || MULTI_DTB_FIT
c409bd01 153 default DEFAULT_DEVICE_TREE
cdf17246
SG
154 help
155 This option specifies a list of device tree files to use for DT
d9797409
CJF
156 control. These will be packaged into a FIT. At run-time, U-boot
157 or SPL will select the correct DT to use by examining the
158 hardware (e.g. reading a board ID value). This is a list of
159 device tree files (without the directory or .dtb suffix)
160 separated by <space>.
cdf17246 161
557bc97f
JJH
162config OF_OVERLAY_LIST
163 string "List of device tree overlays to include for DT control"
164 depends on SPL_LOAD_FIT_APPLY_OVERLAY
165 help
166 This option specifies a list of device tree overlays to use for DT
167 control. This option can then be used by a FIT generator to include
168 the overlays in the FIT image.
169
95f4bbd5 170choice
574e3861 171 prompt "OF LIST compression"
95f4bbd5
MV
172 depends on MULTI_DTB_FIT
173 default MULTI_DTB_FIT_NO_COMPRESSION
174
175config MULTI_DTB_FIT_LZO
176 bool "LZO"
177 depends on SYS_MALLOC_F
178 select LZO
179 help
180 Compress the FIT image containing the DTBs available for the SPL
181 using LZO compression. (requires lzop on host).
182
183config MULTI_DTB_FIT_GZIP
184 bool "GZIP"
185 depends on SYS_MALLOC_F
186 select GZIP
187 help
188 Compress the FIT image containing the DTBs available for the SPL
189 using GZIP compression. (requires gzip on host)
190
191config MULTI_DTB_FIT_NO_COMPRESSION
192 bool "No compression"
193 help
194 Do not compress the FIT image containing the DTBs available for the SPL.
195 Use this options only if LZO is not available and the DTBs are very small.
196endchoice
197
198choice
199 prompt "Location of uncompressed DTBs"
200 depends on (MULTI_DTB_FIT_GZIP || MULTI_DTB_FIT_LZO)
201 default MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F
202
203config MULTI_DTB_FIT_DYN_ALLOC
204 bool "Dynamically allocate the memory"
205 depends on SYS_MALLOC_F
206
207config MULTI_DTB_FIT_USER_DEFINED_AREA
208 bool "User-defined location"
209endchoice
210
211config MULTI_DTB_FIT_UNCOMPRESS_SZ
212 hex "Size of memory reserved to uncompress the DTBs"
95f4bbd5
MV
213 default 0x8000
214 help
215 This is the size of this area where the DTBs are uncompressed.
216 If this area is dynamically allocated, make sure that
217 SYS_MALLOC_F_LEN is big enough to contain it.
218
219config MULTI_DTB_FIT_USER_DEF_ADDR
220 hex "Address of memory where dtbs are uncompressed"
221 depends on MULTI_DTB_FIT_USER_DEFINED_AREA
222 help
223 the FIT image containing the DTBs is uncompressed in an area defined
224 at compilation time. This is the address of this area. It must be
225 aligned on 2-byte boundary.
11955590
JJH
226
227config DTB_RESELECT
228 bool "Support swapping dtbs at a later point in boot"
229 depends on MULTI_DTB_FIT
230 help
231 It is possible during initial boot you may need to use a generic
232 dtb until you can fully determine the board your running on. This
233 config allows boards to implement a function at a later point
234 during boot to switch to the "correct" dtb.
235
236config MULTI_DTB_FIT
237 bool "Support embedding several DTBs in a FIT image for u-boot"
238 help
239 This option provides hooks to allow U-boot to parse an
240 appended FIT image and enable board specific code to then select
241 the correct DTB to be used. Use this if you need to support
242 multiple DTBs but don't use the SPL.
243
2f57c951
JJH
244
245config SPL_MULTI_DTB_FIT
eaad01a3 246 depends on SPL_LOAD_FIT && SPL_OF_REAL
2f57c951
JJH
247 bool "Support embedding several DTBs in a FIT image for the SPL"
248 help
249 This option provides the SPL with the ability to select its own
250 DTB at runtime from an appended FIT image containing several DTBs.
251 This allows using the same SPL binary on multiple platforms.
252 The primary purpose is to handle different versions of
253 the same platform without tweaking the platform code if the
254 differences can be expressed in the DTBs (common examples are: bus
255 capabilities, pad configurations).
256
257config SPL_OF_LIST
258 string "List of device tree files to include for DT control in SPL"
259 depends on SPL_MULTI_DTB_FIT
260 default OF_LIST
261 help
262 This option specifies a list of device tree files to use for DT
263 control in the SPL. These will be packaged into a FIT. At run-time,
264 the SPL will select the correct DT to use by examining the
265 hardware (e.g. reading a board ID value). This is a list of
266 device tree files (without the directory or .dtb suffix)
267 separated by <space>.
268
269choice
270 prompt "SPL OF LIST compression"
271 depends on SPL_MULTI_DTB_FIT
272 default SPL_MULTI_DTB_FIT_LZO
273
274config SPL_MULTI_DTB_FIT_LZO
275 bool "LZO"
276 depends on SYS_MALLOC_F
277 select SPL_LZO
278 help
279 Compress the FIT image containing the DTBs available for the SPL
280 using LZO compression. (requires lzop on host).
281
282config SPL_MULTI_DTB_FIT_GZIP
283 bool "GZIP"
284 depends on SYS_MALLOC_F
285 select SPL_GZIP
286 help
287 Compress the FIT image containing the DTBs available for the SPL
288 using GZIP compression. (requires gzip on host)
289
290config SPL_MULTI_DTB_FIT_NO_COMPRESSION
291 bool "No compression"
292 help
293 Do not compress the FIT image containing the DTBs available for the SPL.
294 Use this options only if LZO is not available and the DTBs are very small.
295endchoice
296
297choice
b8448051 298 prompt "Location of uncompressed DTBs"
2f57c951
JJH
299 depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO)
300 default SPL_MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F
301
302config SPL_MULTI_DTB_FIT_DYN_ALLOC
303 bool "Dynamically allocate the memory"
304 depends on SYS_MALLOC_F
305
306config SPL_MULTI_DTB_FIT_USER_DEFINED_AREA
307 bool "User-defined location"
308endchoice
309
310config SPL_MULTI_DTB_FIT_UNCOMPRESS_SZ
311 hex "Size of memory reserved to uncompress the DTBs"
312 depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO)
313 default 0x8000
314 help
315 This is the size of this area where the DTBs are uncompressed.
316 If this area is dynamically allocated, make sure that
317 SPL_SYS_MALLOC_F_LEN is big enough to contain it.
318
319config SPL_MULTI_DTB_FIT_USER_DEF_ADDR
320 hex "Address of memory where dtbs are uncompressed"
321 depends on SPL_MULTI_DTB_FIT_USER_DEFINED_AREA
322 help
323 the FIT image containing the DTBs is uncompressed in an area defined
324 at compilation time. This is the address of this area. It must be
325 aligned on 2-byte boundary.
326
fa78e0a3
SG
327config OF_SPL_REMOVE_PROPS
328 string "List of device tree properties to drop for SPL"
897705ec 329 depends on SPL_OF_CONTROL
f00d89fd
MS
330 default "interrupt-parent interrupts" if SPL_PINCTRL && SPL_CLK
331 default "clocks clock-names interrupt-parent interrupts" if SPL_PINCTRL
332 default "pinctrl-0 pinctrl-names interrupt-parent interrupts" if SPL_CLK
333 default "pinctrl-0 pinctrl-names clocks clock-names interrupt-parent interrupts"
fa78e0a3
SG
334 help
335 Since SPL normally runs in a reduced memory space, the device tree
336 is cut down to only what is needed to load and start U-Boot. Only
337 nodes marked with the property "u-boot,dm-pre-reloc" will be
338 included. In addition, some properties are not used by U-Boot and
339 can be discarded. This option defines the list of properties to
340 discard.
341
43b6e38b
AG
342config OF_DTB_PROPS_REMOVE
343 bool "Enable removal of device tree properties"
344 depends on OF_CONTROL
345 help
346 Some boards have restricted amount of storage for U-Boot image.
347 If the generated binary doesn't fit into available image storage,
348 the built-in device tree could probably be cut down by removing
349 some not required device tree properties to reduce the image size.
350 Enable this option and define the properties to be removed in the
351 CONFIG_OF_REMOVE_PROPS list. Do not enable this option if you must
352 pass the built-in DTB directly to the kernel!
353
354config OF_REMOVE_PROPS
355 string "List of device tree properties to drop"
356 depends on OF_DTB_PROPS_REMOVE
357 default "interrupt-parent interrupts" if PINCTRL
358 help
359 Some properties are not used by U-Boot and can be discarded.
360 This option defines the list of properties to discard.
361
2789ddb9
SG
362config SPL_OF_PLATDATA
363 bool "Generate platform data for use in SPL"
364 depends on SPL_OF_CONTROL
d6a0c78a 365 select DTOC
ab933d80 366 select SPL_OF_PLATDATA_DRIVER_RT if !SPL_OF_PLATDATA_INST
2789ddb9
SG
367 help
368 For very constrained SPL environments the overhead of decoding
369 device tree nodes and converting their contents into platform data
370 is too large. This overhead includes libfdt code as well as the
371 device tree contents itself. The latter is fairly compact, but the
372 former can add 3KB or more to a Thumb 2 Image.
373
374 This option enables generation of platform data from the device
20e442ab 375 tree as C code. This code creates devices using U_BOOT_DRVINFO()
2789ddb9
SG
376 declarations. The benefit is that it allows driver code to access
377 the platform data directly in C structures, avoidin the libfdt
378 overhead.
379
380 This option works by generating C structure declarations for each
20e442ab 381 compatible string, then adding platform data and U_BOOT_DRVINFO
3600b461 382 declarations for each node. See of-plat.txt for more information.
2789ddb9 383
eaad01a3
SG
384config SPL_OF_REAL
385 bool
386 help
387 Indicates that a real devicetree is available which can be accessed
388 at runtime. This means that dev_read_...() functions can be used to
389 read data from the devicetree for each device. This is true if
390 SPL_OF_CONTROL is enabled and not SPL_OF_PLATDATA
391
5a1b25c2
SG
392if SPL_OF_PLATDATA
393
e41651ff
SG
394config SPL_OF_PLATDATA_PARENT
395 bool "Support parent information in devices"
e41651ff
SG
396 default y
397 help
398 Generally it is useful to be able to access the parent of a device
399 with of-platdata. To save space this can be disabled, but in that
400 case dev_get_parent() will always return NULL;
401
5a1b25c2
SG
402config SPL_OF_PLATDATA_INST
403 bool "Declare devices at build time"
404 help
405 Declare devices as udevice instances so that they do not need to be
406 bound when U-Boot starts. This can save time and code space.
407
1ef3af3b
SG
408config SPL_OF_PLATDATA_NO_BIND
409 bool "Don't allow run-time binding of devices"
410 depends on SPL_OF_PLATDATA_INST
411 default y
412 help
413 This removes the ability to bind devices at run time, thus saving
414 some code space in U-Boot. This can be disabled if binding is needed,
415 at the code of some code size increase.
416
95a5825f
SG
417config SPL_OF_PLATDATA_RT
418 bool "Use a separate struct for device runtime data"
419 depends on SPL_OF_PLATDATA_INST
420 default y
421 help
422 For systems running SPL from read-only memory it is convenient to
423 separate out the runtime information, so that the devices don't need
424 to be copied before being used. This moves the read-write parts of
425 struct udevice (at present just the flags) into a separate struct,
426 which is allocated at runtime.
427
ab933d80
SG
428config SPL_OF_PLATDATA_DRIVER_RT
429 bool
430 help
431 Use a separate struct for driver runtime data.
432
433 This enables the driver_rt information, used with of-platdata when
434 of-platdata-inst is not used. It allows finding devices by their
435 driver data.
436
5a1b25c2
SG
437endif
438
eaad01a3
SG
439config TPL_OF_REAL
440 bool
441 help
442 Indicates that a real devicetree is available which can be accessed
443 at runtime. This means that dev_read_...() functions can be used to
444 read data from the devicetree for each device. This is true if
445 TPL_OF_CONTROL is enabled and not TPL_OF_PLATDATA
446
f291ce12
PT
447config TPL_OF_PLATDATA
448 bool "Generate platform data for use in TPL"
449 depends on TPL_OF_CONTROL
d6a0c78a 450 select DTOC
ab933d80 451 select TPL_OF_PLATDATA_DRIVER_RT if !TPL_OF_PLATDATA_INST
f291ce12
PT
452 help
453 For very constrained SPL environments the overhead of decoding
454 device tree nodes and converting their contents into platform data
455 is too large. This overhead includes libfdt code as well as the
456 device tree contents itself. The latter is fairly compact, but the
457 former can add 3KB or more to a Thumb 2 Image.
458
459 This option enables generation of platform data from the device
20e442ab 460 tree as C code. This code creates devices using U_BOOT_DRVINFO()
f291ce12
PT
461 declarations. The benefit is that it allows driver code to access
462 the platform data directly in C structures, avoidin the libfdt
463 overhead.
464
465 This option works by generating C structure declarations for each
20e442ab 466 compatible string, then adding platform data and U_BOOT_DRVINFO
3600b461 467 declarations for each node. See of-plat.txt for more information.
f291ce12 468
5a1b25c2
SG
469if TPL_OF_PLATDATA
470
e41651ff
SG
471config TPL_OF_PLATDATA_PARENT
472 bool "Support parent information in devices"
e41651ff
SG
473 default y
474 help
475 Generally it is useful to be able to access the parent of a device
476 with of-platdata. To save space this can be disabled, but in that
477 case dev_get_parent() will always return NULL;
478
5a1b25c2
SG
479config TPL_OF_PLATDATA_INST
480 bool "Declare devices at build time"
481
482 help
483 Declare devices as udevice instances so that they do not need to be
484 bound when U-Boot starts. This can save time and code space.
485
1ef3af3b
SG
486config TPL_OF_PLATDATA_NO_BIND
487 bool "Don't allow run-time binding of devices"
488 depends on TPL_OF_PLATDATA_INST
489 default y
490 help
491 This removes the ability to bind devices at run time, thus saving
492 some code space in U-Boot. This can be disabled if binding is needed,
493 at the code of some code size increase.
494
95a5825f
SG
495config TPL_OF_PLATDATA_RT
496 bool "Use a separate struct for device runtime data"
497 depends on TPL_OF_PLATDATA_INST
498 default y
499 help
500 For systems running TPL from read-only memory it is convenient to
501 separate out the runtime information, so that the devices don't need
502 to be copied before being used. This moves the read-write parts of
503 struct udevice (at present just the flags) into a separate struct,
504 which is allocated at runtime.
505
ab933d80
SG
506config TPL_OF_PLATDATA_DRIVER_RT
507 bool
508 help
509 Use a separate struct for driver runtime data.
510
511 This enables the driver_rt information, used with of-platdata when
512 of-platdata-inst is not used. It allows finding devices by their
513 driver data.
514
5a1b25c2
SG
515endif
516
783e6a72 517endmenu