blob: 3151778b2c9ce9e1894c05b387d20d99717debe6 [file] [log] [blame]
Philipp Tomsich399f3af2017-03-01 21:10:40 +01001The /config node (Configuration Options)
2----------------------------------------
3
4A number of run-time configuration options are provided in the /config node
Simon Glass7de8bd02021-08-07 07:24:01 -06005of the control device tree. You can access these using ofnode_conf_read_int(),
6ofnode_conf_read_bool() and ofnode_conf_read_str().
Philipp Tomsich399f3af2017-03-01 21:10:40 +01007
Simon Glass8eb4a762021-09-09 14:10:31 -06008These options are designed to affect the operation of U-Boot at runtime.
9Runtime-configuration items can help avoid proliferation of different builds
10with only minor changes, e.g. enabling and disabling console output. Items
11here should be those that can usefully be set by the build system after U-Boot
12is built.
13
Philipp Tomsich399f3af2017-03-01 21:10:40 +010014Available options are:
15
Simon Glass19e699f2021-09-09 14:10:32 -060016bootcmd (string)
17 Allows overwriting of the boot command used by U-Boot on startup. If
18 present, U-Boot uses this command instead. Note that this feature can
19 work even if loading the environment is disabled, e.g. for security
20 reasons. See also bootsecure.
21
22bootdelay (int)
23 This allows selecting of the U-Boot bootdelay, to control whether U-Boot
24 waits on boot or for how long. This allows this option to be configured
25 by the build system or by a previous-stage binary. For example, if the
26 images is being packed for testing or a user holds down a button, it may
27 allow a delay, but disable it for production.
28
29u-boot,boot-led (string)
30u-boot,error-led (string)
31 This is used to specify the label for an LED to indicate an error and
32 a successful boot, on supported hardware.
33
34bootsecure (int)
35 Indicates that U-Boot should use secure_boot_cmd() to run commands,
36 rather than the normal CLI. This can be used in production images, to
37 restrict the amount of parsing done or the options available, to cut
38 back on the available surface for security attacks.
39
Simon Glass8eb4a762021-09-09 14:10:31 -060040u-boot,efi-partition-entries-offset (int)
Philipp Tomsiche7dd02e2017-03-01 21:10:41 +010041 If present, this provides an offset (in bytes, from the start of a
42 device) that should be skipped over before the partition entries.
43 This is used by the EFI/GPT partition implementation when a device
44 is formatted.
45
46 This setting will override any values configured via Kconfig.
Philipp Tomsichf222b362017-04-17 17:45:12 +020047
Simon Glass19e699f2021-09-09 14:10:32 -060048kernel-offset (int)
49 This allows setting the 'kernaddr' environment variable, used to select
50 the address to load the kernel. It is useful for systems that use U-Boot
51 to flash a device, so the scripts that do this know where to put the
52 kernel to be flashed.
53
54load-environment (int)
55 Allows control over whether U-Boot loads its environment after
56 relocation (0=no, 1 or not present=yes).
57
Simon Glass8eb4a762021-09-09 14:10:31 -060058u-boot,mmc-env-offset (int)
59u-boot,mmc-env-offset-redundant (int)
Philipp Tomsichde59d102017-05-16 00:16:32 +020060 If present, the values of the 'u-boot,mmc-env-offset' and/or
61 of the u-boot,mmc-env-offset-redundant' properties overrides
62 CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND, respectively,
63 for SD/MMC devices.
64
65 Values are interpreted as the offset from the start of the
66 device, specified in bytes. It is assumed that the setting
67 will point at the beginning of a LBA and values that are not
68 LBA-aligned will be rounded up to the next LBA address.
69
Simon Glass8eb4a762021-09-09 14:10:31 -060070u-boot,mmc-env-partition (int)
71 if present, the environment shall be placed at the last
72 CONFIG_ENV_SIZE blocks of the partition on the
73 CONFIG_SYS_MMC_ENV_DEV.
74
75 if u-boot,mmc-env-offset* is present, this setting will take
76 precedence. In that case, only if the partition is not found,
77 mmc-env-offset* will be tried.
78
Simon Glass19e699f2021-09-09 14:10:32 -060079u-boot,no-apm-finalize (bool)
80 For x86 devices running on coreboot, this tells U-Boot not to lock
81 down the Intel Management Engine (ME) registers. This allows U-Boot to
82 access the hardware more fully for platforms that need it.
83
Simon Glass8eb4a762021-09-09 14:10:31 -060084u-boot,no-keyboard (bool)
85 Tells U-Boot not to expect an attached keyboard with a VGA console.
86
Simon Glass19e699f2021-09-09 14:10:32 -060087rootdisk-offset (int)
88 This allows setting the 'rootdisk' environment variable, used to select
89 the address to load the rootdisk. It is useful for systems that use
90 U-Boot to flash a device, so the scripts that do this know where to put
91 the root disk to be flashed.
92
Simon Glass8eb4a762021-09-09 14:10:31 -060093silent-console (int)
94 If present and non-zero, the console is silenced by default on boot.
95
96u-boot,spl-payload-offset (int)
Philipp Tomsichf222b362017-04-17 17:45:12 +020097 If present (and SPL is controlled by the device-tree), this allows
98 to override the CONFIG_SYS_SPI_U_BOOT_OFFS setting using a value
99 from the device-tree.
Philipp Tomsichae0d33a2017-11-28 17:56:11 +0100100
Simon Glass8eb4a762021-09-09 14:10:31 -0600101sysreset-gpio (string)
Philipp Tomsichae0d33a2017-11-28 17:56:11 +0100102 If present (and supported by the specific board), indicates a
103 GPIO that can be set to trigger a system reset. It is assumed
104 that such a system reset will effect a complete platform reset,
105 being roughly equivalent to a power-on reset.