[u-boot.git] / dts / Kconfig

#
# Device Tree Control
#

config SUPPORT_OF_CONTROL
	bool

menu "Device Tree Control"
	depends on SUPPORT_OF_CONTROL

config OF_CONTROL
	bool "Run-time configuration via Device Tree"
	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 || FIT_EMBED
	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 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
	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
	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
Commit	Line	Data
783e6a72 MY	1	#
	2	# Device Tree Control
	3	#
783e6a72 MY	4
	5	config SUPPORT_OF_CONTROL
	6	bool
	7
	8	menu "Device Tree Control"
783e6a72 MY	9	depends on SUPPORT_OF_CONTROL
	10
	11	config OF_CONTROL
	12	bool "Run-time configuration via Device Tree"
	13	help
	14	This feature provides for run-time configuration of U-Boot
	15	via a flattened device tree.
	16
2a792753	17	config OF_BOARD_FIXUP
	18	bool "Board-specific manipulation of Device Tree"
	19	help
	20	In certain circumstances it is necessary to be able to modify
	21	U-Boot's device tree (e.g. to delete device from it). This option
	22	make the Device Tree writeable and provides a board-specific
	23	"board_fix_fdt" callback (called during pre-relocation time), which
	24	enables the board initialization to modifiy the Device Tree. The
	25	modified copy is subsequently used by U-Boot after relocation.
	26
dffb86e4 MY	27	config SPL_OF_CONTROL
	28	bool "Enable run-time configuration via Device Tree in SPL"
	29	depends on SPL && OF_CONTROL
2860f03b SG	30	help
	31	Some boards use device tree in U-Boot but only have 4KB of SRAM
	32	which is not enough to support device tree. Enable this option to
	33	allow such boards to be supported by U-Boot SPL.
	34
f291ce12 PT	35	config TPL_OF_CONTROL
	36	bool "Enable run-time configuration via Device Tree in TPL"
	37	depends on TPL && OF_CONTROL
	38	help
	39	Some boards use device tree in U-Boot but only have 4KB of SRAM
	40	which is not enough to support device tree. Enable this option to
	41	allow such boards to be supported by U-Boot TPL.
	42
5e060d8b SG	43	config OF_LIVE
	44	bool "Enable use of a live tree"
	45	depends on OF_CONTROL
	46	help
	47	Normally U-Boot uses a flat device tree which saves space and
	48	avoids the need to unpack the tree before use. However a flat
	49	tree does not support modifcation from within U-Boot since it
	50	can invalidate driver-model device tree offsets. This option
	51	enables a live tree which is available after relocation,
	52	and can be adjusted as needed.
	53
783e6a72 MY	54	choice
	55	prompt "Provider of DTB for DT control"
	56	depends on OF_CONTROL
	57
	58	config OF_SEPARATE
	59	bool "Separate DTB for DT control"
	60	depends on !SANDBOX
	61	help
	62	If this option is enabled, the device tree will be built and
	63	placed as a separate u-boot.dtb file alongside the U-Boot image.
	64
	65	config OF_EMBED
	66	bool "Embedded DTB for DT control"
	67	help
	68	If this option is enabled, the device tree will be picked up and
3d3f60cb SG	69	built into the U-Boot image. This is suitable for local debugging
	70	and development only and is not recommended for production devices.
	71	Boards in the mainline U-Boot tree should not use it.
783e6a72	72
82f766d1 AD	73	config OF_BOARD
	74	bool "Provided by the board at runtime"
	75	depends on !SANDBOX
	76	help
	77	If this option is enabled, the device tree will be provided by
	78	the board at runtime if the board supports it, instead of being
	79	bundled with the image.
	80
783e6a72 MY	81	config OF_HOSTFILE
	82	bool "Host filed DTB for DT control"
	83	depends on SANDBOX
	84	help
	85	If this option is enabled, DTB will be read from a file on startup.
	86	This is only useful for Sandbox. Use the -d flag to U-Boot to
	87	specify the file to read.
	88
	89	endchoice
	90
f1ef2b62 MY	91	config DEFAULT_DEVICE_TREE
f1ef2b62 MY	92	string "Default Device Tree for DT control"
70d41093	93	depends on OF_CONTROL
f1ef2b62 MY	94	help
f1ef2b62 MY	95	This option specifies the default Device Tree used for DT control.
5699ea6d	96	It can be overridden from the command line:
f1ef2b62 MY	97	$ make DEVICE_TREE=<device-tree-name>
f1ef2b62 MY	98
cdf17246 SG	99	config OF_LIST
cdf17246 SG	100	string "List of device tree files to include for DT control"
d9797409	101	depends on SPL_LOAD_FIT \|\| FIT_EMBED
c409bd01	102	default DEFAULT_DEVICE_TREE
cdf17246 SG	103	help
cdf17246 SG	104	This option specifies a list of device tree files to use for DT
d9797409 CJF	105	control. These will be packaged into a FIT. At run-time, U-boot
	106	or SPL will select the correct DT to use by examining the
	107	hardware (e.g. reading a board ID value). This is a list of
	108	device tree files (without the directory or .dtb suffix)
	109	separated by <space>.
cdf17246	110
fa78e0a3 SG	111	config OF_SPL_REMOVE_PROPS
fa78e0a3 SG	112	string "List of device tree properties to drop for SPL"
897705ec	113	depends on SPL_OF_CONTROL
239ae4a9 VM	114	default "interrupt-parent" if SPL_PINCTRL && SPL_CLK
239ae4a9 VM	115	default "clocks clock-names interrupt-parent" if SPL_PINCTRL
5f3f7b79	116	default "pinctrl-0 pinctrl-names interrupt-parent" if SPL_CLK
fa78e0a3 SG	117	default "pinctrl-0 pinctrl-names clocks clock-names interrupt-parent"
	118	help
	119	Since SPL normally runs in a reduced memory space, the device tree
	120	is cut down to only what is needed to load and start U-Boot. Only
	121	nodes marked with the property "u-boot,dm-pre-reloc" will be
	122	included. In addition, some properties are not used by U-Boot and
	123	can be discarded. This option defines the list of properties to
	124	discard.
	125
2789ddb9 SG	126	config SPL_OF_PLATDATA
	127	bool "Generate platform data for use in SPL"
	128	depends on SPL_OF_CONTROL
	129	help
	130	For very constrained SPL environments the overhead of decoding
	131	device tree nodes and converting their contents into platform data
	132	is too large. This overhead includes libfdt code as well as the
	133	device tree contents itself. The latter is fairly compact, but the
	134	former can add 3KB or more to a Thumb 2 Image.
	135
	136	This option enables generation of platform data from the device
	137	tree as C code. This code creates devices using U_BOOT_DEVICE()
	138	declarations. The benefit is that it allows driver code to access
	139	the platform data directly in C structures, avoidin the libfdt
	140	overhead.
	141
	142	This option works by generating C structure declarations for each
	143	compatible string, then adding platform data and U_BOOT_DEVICE
	144	declarations for each node. See README.platdata for more
	145	information.
	146
f291ce12 PT	147	config TPL_OF_PLATDATA
	148	bool "Generate platform data for use in TPL"
	149	depends on TPL_OF_CONTROL
	150	help
	151	For very constrained SPL environments the overhead of decoding
	152	device tree nodes and converting their contents into platform data
	153	is too large. This overhead includes libfdt code as well as the
	154	device tree contents itself. The latter is fairly compact, but the
	155	former can add 3KB or more to a Thumb 2 Image.
	156
	157	This option enables generation of platform data from the device
	158	tree as C code. This code creates devices using U_BOOT_DEVICE()
	159	declarations. The benefit is that it allows driver code to access
	160	the platform data directly in C structures, avoidin the libfdt
	161	overhead.
	162
	163	This option works by generating C structure declarations for each
	164	compatible string, then adding platform data and U_BOOT_DEVICE
	165	declarations for each node. See README.platdata for more
	166	information.
	167
783e6a72	168	endmenu