[u-boot.git] / dts / Kconfig

#
# Device Tree Control
#

config SUPPORT_OF_CONTROL
	bool

config DTC
	bool

config PYLIBFDT
	bool

config DTOC
	bool
	select PYLIBFDT

config BINMAN
	bool
	select DTOC

menu "Device Tree Control"
	depends on SUPPORT_OF_CONTROL

config OF_CONTROL
	bool "Run-time configuration via Device Tree"
	select DTC
	help
	  This feature provides for run-time configuration of U-Boot
	  via a flattened device tree.

config OF_BOARD_FIXUP
	bool "Board-specific manipulation of Device Tree"
	help
	  In certain circumstances it is necessary to be able to modify
	  U-Boot's device tree (e.g. to delete device from it). This option
	  make the Device Tree writeable and provides a board-specific
	  "board_fix_fdt" callback (called during pre-relocation time), which
	  enables the board initialization to modifiy the Device Tree. The
	  modified copy is subsequently used by U-Boot after relocation.

config SPL_OF_CONTROL
	bool "Enable run-time configuration via Device Tree in SPL"
	depends on SPL && OF_CONTROL
	help
	  Some boards use device tree in U-Boot but only have 4KB of SRAM
	  which is not enough to support device tree. Enable this option to
	  allow such boards to be supported by U-Boot SPL.

config TPL_OF_CONTROL
	bool "Enable run-time configuration via Device Tree in TPL"
	depends on TPL && OF_CONTROL
	help
	  Some boards use device tree in U-Boot but only have 4KB of SRAM
	  which is not enough to support device tree. Enable this option to
	  allow such boards to be supported by U-Boot TPL.

config OF_LIVE
	bool "Enable use of a live tree"
	depends on OF_CONTROL
	help
	  Normally U-Boot uses a flat device tree which saves space and
	  avoids the need to unpack the tree before use. However a flat
	  tree does not support modifcation from within U-Boot since it
	  can invalidate driver-model device tree offsets. This option
	  enables a live tree which is available after relocation,
	  and can be adjusted as needed.

choice
	prompt "Provider of DTB for DT control"
	depends on OF_CONTROL

config OF_SEPARATE
	bool "Separate DTB for DT control"
	depends on !SANDBOX
	help
	  If this option is enabled, the device tree will be built and
	  placed as a separate u-boot.dtb file alongside the U-Boot image.

config OF_EMBED
	bool "Embedded DTB for DT control"
	help
	  If this option is enabled, the device tree will be picked up and
	  built into the U-Boot image. This is suitable for local debugging
	  and development only and is not recommended for production devices.
	  Boards in the mainline U-Boot tree should not use it.

config OF_BOARD
	bool "Provided by the board at runtime"
	depends on !SANDBOX
	help
	  If this option is enabled, the device tree will be provided by
	  the board at runtime if the board supports it, instead of being
	  bundled with the image.

config OF_HOSTFILE
	bool "Host filed DTB for DT control"
	depends on SANDBOX
	help
	  If this option is enabled, DTB will be read from a file on startup.
	  This is only useful for Sandbox.  Use the -d flag to U-Boot to
	  specify the file to read.

endchoice

config DEFAULT_DEVICE_TREE
	string "Default Device Tree for DT control"
	depends on OF_CONTROL
	help
	  This option specifies the default Device Tree used for DT control.
	  It can be overridden from the command line:
	  $ make DEVICE_TREE=<device-tree-name>

config OF_LIST
	string "List of device tree files to include for DT control"
	depends on SPL_LOAD_FIT || MULTI_DTB_FIT
	default DEFAULT_DEVICE_TREE
	help
	  This option specifies a list of device tree files to use for DT
	  control. These will be packaged into a FIT. At run-time, U-boot
	  or SPL will select the correct DT to use by examining the
	  hardware (e.g. reading a board ID value). This is a list of
	  device tree files (without the directory or .dtb suffix)
	  separated by <space>.


config DTB_RESELECT
	bool "Support swapping dtbs at a later point in boot"
	depends on MULTI_DTB_FIT
	help
	  It is possible during initial boot you may need to use a generic
	  dtb until you can fully determine the board your running on. This
	  config allows boards to implement a function at a later point
	  during boot to switch to the "correct" dtb.

config MULTI_DTB_FIT
	bool "Support embedding several DTBs in a FIT image for u-boot"
	help
	  This option provides hooks to allow U-boot to parse an
	  appended FIT image and enable board specific code to then select
	  the correct DTB to be used. Use this if you need to support
	  multiple DTBs but don't use the SPL.


config SPL_MULTI_DTB_FIT
	depends on SPL_LOAD_FIT && SPL_OF_CONTROL && !SPL_OF_PLATDATA
	bool "Support embedding several DTBs in a FIT image for the SPL"
	help
	  This option provides the SPL with the ability to select its own
	  DTB at runtime from an appended FIT image containing several DTBs.
	  This allows using the same SPL binary on multiple platforms.
	  The primary purpose is to handle different versions of
	  the same platform without tweaking the platform code if the
	  differences can be expressed in the DTBs (common examples are: bus
	  capabilities, pad configurations).

config SPL_OF_LIST
	string "List of device tree files to include for DT control in SPL"
	depends on SPL_MULTI_DTB_FIT
	default OF_LIST
	help
	  This option specifies a list of device tree files to use for DT
	  control in the SPL. These will be packaged into a FIT. At run-time,
	  the SPL will select the correct DT to use by examining the
	  hardware (e.g. reading a board ID value). This is a list of
	  device tree files (without the directory or .dtb suffix)
	  separated by <space>.

choice
	prompt "SPL OF LIST compression"
	depends on SPL_MULTI_DTB_FIT
	default SPL_MULTI_DTB_FIT_LZO

config SPL_MULTI_DTB_FIT_LZO
	bool "LZO"
	depends on SYS_MALLOC_F
	select SPL_LZO
	help
	  Compress the FIT image containing the DTBs available for the SPL
	  using LZO compression. (requires lzop on host).

config SPL_MULTI_DTB_FIT_GZIP
	bool "GZIP"
	depends on SYS_MALLOC_F
	select SPL_GZIP
	help
	  Compress the FIT image containing the DTBs available for the SPL
	  using GZIP compression. (requires gzip on host)

config SPL_MULTI_DTB_FIT_NO_COMPRESSION
	bool "No compression"
	help
	  Do not compress the FIT image containing the DTBs available for the SPL.
	  Use this options only if LZO is not available and the DTBs are very small.
endchoice

choice
	prompt "Location of uncompressed DTBs "
	depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO)
	default SPL_MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F

config SPL_MULTI_DTB_FIT_DYN_ALLOC
	bool "Dynamically allocate the memory"
	depends on SYS_MALLOC_F

config SPL_MULTI_DTB_FIT_USER_DEFINED_AREA
	bool "User-defined location"
endchoice

config SPL_MULTI_DTB_FIT_UNCOMPRESS_SZ
	hex "Size of memory reserved to uncompress the DTBs"
	depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO)
	default 0x8000
	help
	   This is the size of this area where the DTBs are uncompressed.
	   If this area is dynamically allocated, make sure that
	   SPL_SYS_MALLOC_F_LEN is big enough to contain it.

config SPL_MULTI_DTB_FIT_USER_DEF_ADDR
	hex "Address of memory where dtbs are uncompressed"
	depends on SPL_MULTI_DTB_FIT_USER_DEFINED_AREA
	help
	   the FIT image containing the DTBs is uncompressed in an area defined
	   at compilation time. This is the address of this area. It must be
	   aligned on 2-byte boundary.

config OF_SPL_REMOVE_PROPS
	string "List of device tree properties to drop for SPL"
	depends on SPL_OF_CONTROL
	default "interrupt-parent" if SPL_PINCTRL && SPL_CLK
	default "clocks clock-names interrupt-parent" if SPL_PINCTRL
	default "pinctrl-0 pinctrl-names interrupt-parent" if SPL_CLK
	default "pinctrl-0 pinctrl-names clocks clock-names interrupt-parent"
	help
	  Since SPL normally runs in a reduced memory space, the device tree
	  is cut down to only what is needed to load and start U-Boot. Only
	  nodes marked with the property "u-boot,dm-pre-reloc" will be
	  included. In addition, some properties are not used by U-Boot and
	  can be discarded. This option defines the list of properties to
	  discard.

config SPL_OF_PLATDATA
	bool "Generate platform data for use in SPL"
	depends on SPL_OF_CONTROL
	select DTOC
	help
	  For very constrained SPL environments the overhead of decoding
	  device tree nodes and converting their contents into platform data
	  is too large. This overhead includes libfdt code as well as the
	  device tree contents itself. The latter is fairly compact, but the
	  former can add 3KB or more to a Thumb 2 Image.

	  This option enables generation of platform data from the device
	  tree as C code. This code creates devices using U_BOOT_DEVICE()
	  declarations. The benefit is that it allows driver code to access
	  the platform data directly in C structures, avoidin the libfdt
	  overhead.

	  This option works by generating C structure declarations for each
	  compatible string, then adding platform data and U_BOOT_DEVICE
	  declarations for each node. See README.platdata for more
	  information.

config TPL_OF_PLATDATA
	bool "Generate platform data for use in TPL"
	depends on TPL_OF_CONTROL
	select DTOC
	help
	  For very constrained SPL environments the overhead of decoding
	  device tree nodes and converting their contents into platform data
	  is too large. This overhead includes libfdt code as well as the
	  device tree contents itself. The latter is fairly compact, but the
	  former can add 3KB or more to a Thumb 2 Image.

	  This option enables generation of platform data from the device
	  tree as C code. This code creates devices using U_BOOT_DEVICE()
	  declarations. The benefit is that it allows driver code to access
	  the platform data directly in C structures, avoidin the libfdt
	  overhead.

	  This option works by generating C structure declarations for each
	  compatible string, then adding platform data and U_BOOT_DEVICE
	  declarations for each node. See README.platdata for more
	  information.

endmenu

config MKIMAGE_DTC_PATH
	string "Path to dtc binary for use within mkimage"
	default "dtc"
	help
	  The mkimage host tool will, in order to generate FIT images make
	  calls to the dtc application in order to create the output.  In
	  some cases the system dtc may not support all required features
	  and the path to a different version should be given here.
Commit	Line	Data
783e6a72 MY	1	#
	2	# Device Tree Control
	3	#
783e6a72 MY	4
	5	config SUPPORT_OF_CONTROL
	6	bool
	7
36dd5f1b TR	8	config DTC
	9	bool
	10
d6a0c78a MY	11	config PYLIBFDT
	12	bool
	13
	14	config DTOC
	15	bool
	16	select PYLIBFDT
	17
	18	config BINMAN
	19	bool
	20	select DTOC
	21
783e6a72	22	menu "Device Tree Control"
783e6a72 MY	23	depends on SUPPORT_OF_CONTROL
	24
	25	config OF_CONTROL
	26	bool "Run-time configuration via Device Tree"
36dd5f1b	27	select DTC
783e6a72 MY	28	help
	29	This feature provides for run-time configuration of U-Boot
	30	via a flattened device tree.
	31
2a792753	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
dffb86e4 MY	42	config SPL_OF_CONTROL
	43	bool "Enable run-time configuration via Device Tree in SPL"
	44	depends on SPL && OF_CONTROL
2860f03b SG	45	help
	46	Some boards use device tree in U-Boot but only have 4KB of SRAM
	47	which is not enough to support device tree. Enable this option to
	48	allow such boards to be supported by U-Boot SPL.
	49
f291ce12 PT	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
5e060d8b SG	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
	64	tree does not support modifcation from within U-Boot since it
	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
783e6a72 MY	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
3d3f60cb SG	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.
783e6a72	87
82f766d1 AD	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
783e6a72 MY	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
	104	endchoice
	105
f1ef2b62 MY	106	config DEFAULT_DEVICE_TREE
f1ef2b62 MY	107	string "Default Device Tree for DT control"
70d41093	108	depends on OF_CONTROL
f1ef2b62 MY	109	help
f1ef2b62 MY	110	This option specifies the default Device Tree used for DT control.
5699ea6d	111	It can be overridden from the command line:
f1ef2b62 MY	112	$ make DEVICE_TREE=<device-tree-name>
f1ef2b62 MY	113
cdf17246 SG	114	config OF_LIST
cdf17246 SG	115	string "List of device tree files to include for DT control"
11955590	116	depends on SPL_LOAD_FIT \|\| MULTI_DTB_FIT
c409bd01	117	default DEFAULT_DEVICE_TREE
cdf17246 SG	118	help
cdf17246 SG	119	This option specifies a list of device tree files to use for DT
d9797409 CJF	120	control. These will be packaged into a FIT. At run-time, U-boot
	121	or SPL will select the correct DT to use by examining the
	122	hardware (e.g. reading a board ID value). This is a list of
	123	device tree files (without the directory or .dtb suffix)
	124	separated by <space>.
cdf17246	125
11955590 JJH	126
	127	config DTB_RESELECT
	128	bool "Support swapping dtbs at a later point in boot"
	129	depends on MULTI_DTB_FIT
	130	help
	131	It is possible during initial boot you may need to use a generic
	132	dtb until you can fully determine the board your running on. This
	133	config allows boards to implement a function at a later point
	134	during boot to switch to the "correct" dtb.
	135
	136	config MULTI_DTB_FIT
	137	bool "Support embedding several DTBs in a FIT image for u-boot"
	138	help
	139	This option provides hooks to allow U-boot to parse an
	140	appended FIT image and enable board specific code to then select
	141	the correct DTB to be used. Use this if you need to support
	142	multiple DTBs but don't use the SPL.
	143
2f57c951 JJH	144
	145	config SPL_MULTI_DTB_FIT
	146	depends on SPL_LOAD_FIT && SPL_OF_CONTROL && !SPL_OF_PLATDATA
	147	bool "Support embedding several DTBs in a FIT image for the SPL"
	148	help
	149	This option provides the SPL with the ability to select its own
	150	DTB at runtime from an appended FIT image containing several DTBs.
	151	This allows using the same SPL binary on multiple platforms.
	152	The primary purpose is to handle different versions of
	153	the same platform without tweaking the platform code if the
	154	differences can be expressed in the DTBs (common examples are: bus
	155	capabilities, pad configurations).
	156
	157	config SPL_OF_LIST
	158	string "List of device tree files to include for DT control in SPL"
	159	depends on SPL_MULTI_DTB_FIT
	160	default OF_LIST
	161	help
	162	This option specifies a list of device tree files to use for DT
	163	control in the SPL. These will be packaged into a FIT. At run-time,
	164	the SPL will select the correct DT to use by examining the
	165	hardware (e.g. reading a board ID value). This is a list of
	166	device tree files (without the directory or .dtb suffix)
	167	separated by <space>.
	168
	169	choice
	170	prompt "SPL OF LIST compression"
	171	depends on SPL_MULTI_DTB_FIT
	172	default SPL_MULTI_DTB_FIT_LZO
	173
	174	config SPL_MULTI_DTB_FIT_LZO
	175	bool "LZO"
	176	depends on SYS_MALLOC_F
	177	select SPL_LZO
	178	help
	179	Compress the FIT image containing the DTBs available for the SPL
	180	using LZO compression. (requires lzop on host).
	181
	182	config SPL_MULTI_DTB_FIT_GZIP
	183	bool "GZIP"
	184	depends on SYS_MALLOC_F
	185	select SPL_GZIP
	186	help
	187	Compress the FIT image containing the DTBs available for the SPL
	188	using GZIP compression. (requires gzip on host)
	189
	190	config SPL_MULTI_DTB_FIT_NO_COMPRESSION
	191	bool "No compression"
	192	help
	193	Do not compress the FIT image containing the DTBs available for the SPL.
	194	Use this options only if LZO is not available and the DTBs are very small.
	195	endchoice
	196
	197	choice
	198	prompt "Location of uncompressed DTBs "
	199	depends on (SPL_MULTI_DTB_FIT_GZIP \|\| SPL_MULTI_DTB_FIT_LZO)
	200	default SPL_MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F
	201
	202	config SPL_MULTI_DTB_FIT_DYN_ALLOC
	203	bool "Dynamically allocate the memory"
	204	depends on SYS_MALLOC_F
	205
	206	config SPL_MULTI_DTB_FIT_USER_DEFINED_AREA
	207	bool "User-defined location"
208	endchoice
209
210	config SPL_MULTI_DTB_FIT_UNCOMPRESS_SZ
211	hex "Size of memory reserved to uncompress the DTBs"
212	depends on (SPL_MULTI_DTB_FIT_GZIP \|\| SPL_MULTI_DTB_FIT_LZO)
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	SPL_SYS_MALLOC_F_LEN is big enough to contain it.
218
219	config SPL_MULTI_DTB_FIT_USER_DEF_ADDR
220	hex "Address of memory where dtbs are uncompressed"
221	depends on SPL_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.
226
fa78e0a3 SG	227	config OF_SPL_REMOVE_PROPS
fa78e0a3 SG	228	string "List of device tree properties to drop for SPL"
897705ec	229	depends on SPL_OF_CONTROL
239ae4a9 VM	230	default "interrupt-parent" if SPL_PINCTRL && SPL_CLK
239ae4a9 VM	231	default "clocks clock-names interrupt-parent" if SPL_PINCTRL
5f3f7b79	232	default "pinctrl-0 pinctrl-names interrupt-parent" if SPL_CLK
fa78e0a3 SG	233	default "pinctrl-0 pinctrl-names clocks clock-names interrupt-parent"
	234	help
	235	Since SPL normally runs in a reduced memory space, the device tree
	236	is cut down to only what is needed to load and start U-Boot. Only
	237	nodes marked with the property "u-boot,dm-pre-reloc" will be
	238	included. In addition, some properties are not used by U-Boot and
	239	can be discarded. This option defines the list of properties to
	240	discard.
	241
2789ddb9 SG	242	config SPL_OF_PLATDATA
	243	bool "Generate platform data for use in SPL"
	244	depends on SPL_OF_CONTROL
d6a0c78a	245	select DTOC
2789ddb9 SG	246	help
	247	For very constrained SPL environments the overhead of decoding
	248	device tree nodes and converting their contents into platform data
	249	is too large. This overhead includes libfdt code as well as the
	250	device tree contents itself. The latter is fairly compact, but the
	251	former can add 3KB or more to a Thumb 2 Image.
	252
	253	This option enables generation of platform data from the device
	254	tree as C code. This code creates devices using U_BOOT_DEVICE()
	255	declarations. The benefit is that it allows driver code to access
	256	the platform data directly in C structures, avoidin the libfdt
	257	overhead.
	258
	259	This option works by generating C structure declarations for each
	260	compatible string, then adding platform data and U_BOOT_DEVICE
	261	declarations for each node. See README.platdata for more
	262	information.
	263
f291ce12 PT	264	config TPL_OF_PLATDATA
	265	bool "Generate platform data for use in TPL"
	266	depends on TPL_OF_CONTROL
d6a0c78a	267	select DTOC
f291ce12 PT	268	help
	269	For very constrained SPL environments the overhead of decoding
	270	device tree nodes and converting their contents into platform data
	271	is too large. This overhead includes libfdt code as well as the
	272	device tree contents itself. The latter is fairly compact, but the
	273	former can add 3KB or more to a Thumb 2 Image.
	274
	275	This option enables generation of platform data from the device
	276	tree as C code. This code creates devices using U_BOOT_DEVICE()
	277	declarations. The benefit is that it allows driver code to access
	278	the platform data directly in C structures, avoidin the libfdt
	279	overhead.
	280
	281	This option works by generating C structure declarations for each
	282	compatible string, then adding platform data and U_BOOT_DEVICE
	283	declarations for each node. See README.platdata for more
	284	information.
	285
783e6a72	286	endmenu
1f6049e2 TR	287
	288	config MKIMAGE_DTC_PATH
	289	string "Path to dtc binary for use within mkimage"
	290	default "dtc"
	291	help
	292	The mkimage host tool will, in order to generate FIT images make
	293	calls to the dtc application in order to create the output. In
	294	some cases the system dtc may not support all required features
	295	and the path to a different version should be given here.