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