Philipp Tomsich | b357fe4 | 2017-03-01 21:10:40 +0100 | [diff] [blame] | 1 | The /config node (Configuration Options) |
| 2 | ---------------------------------------- |
| 3 | |
| 4 | A number of run-time configuration options are provided in the /config node |
Simon Glass | 0034d96 | 2021-08-07 07:24:01 -0600 | [diff] [blame] | 5 | of the control device tree. You can access these using ofnode_conf_read_int(), |
| 6 | ofnode_conf_read_bool() and ofnode_conf_read_str(). |
Philipp Tomsich | b357fe4 | 2017-03-01 21:10:40 +0100 | [diff] [blame] | 7 | |
Simon Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 8 | These options are designed to affect the operation of U-Boot at runtime. |
| 9 | Runtime-configuration items can help avoid proliferation of different builds |
| 10 | with only minor changes, e.g. enabling and disabling console output. Items |
| 11 | here should be those that can usefully be set by the build system after U-Boot |
| 12 | is built. |
Philipp Tomsich | b357fe4 | 2017-03-01 21:10:40 +0100 | [diff] [blame] | 13 | |
Simon Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 14 | Available options are: |
Philipp Tomsich | 842ac3f | 2017-03-01 21:10:41 +0100 | [diff] [blame] | 15 | |
Simon Glass | eee20bf | 2021-09-09 14:10:32 -0600 | [diff] [blame] | 16 | bootcmd (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 | |
| 22 | bootdelay (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 | |
| 29 | u-boot,boot-led (string) |
| 30 | u-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 | |
| 34 | bootsecure (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 Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 40 | u-boot,efi-partition-entries-offset (int) |
Philipp Tomsich | 842ac3f | 2017-03-01 21:10:41 +0100 | [diff] [blame] | 41 | 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 Tomsich | cbcf3a2 | 2017-04-17 17:45:12 +0200 | [diff] [blame] | 47 | |
Simon Glass | eee20bf | 2021-09-09 14:10:32 -0600 | [diff] [blame] | 48 | kernel-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 | |
| 54 | load-environment (int) |
| 55 | Allows control over whether U-Boot loads its environment after |
| 56 | relocation (0=no, 1 or not present=yes). |
| 57 | |
Simon Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 58 | u-boot,mmc-env-offset (int) |
| 59 | u-boot,mmc-env-offset-redundant (int) |
Philipp Tomsich | a7bdaf7 | 2017-05-16 00:16:32 +0200 | [diff] [blame] | 60 | 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 Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 70 | u-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 | |
Emmanuel Di Fede | b6601dd | 2023-06-14 12:05:28 +0200 | [diff] [blame] | 79 | Note that CONFIG_ENV_MMC_PARTITION overrides this device-tree setting. |
| 80 | |
Simon Glass | eee20bf | 2021-09-09 14:10:32 -0600 | [diff] [blame] | 81 | u-boot,no-apm-finalize (bool) |
| 82 | For x86 devices running on coreboot, this tells U-Boot not to lock |
| 83 | down the Intel Management Engine (ME) registers. This allows U-Boot to |
| 84 | access the hardware more fully for platforms that need it. |
| 85 | |
Simon Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 86 | u-boot,no-keyboard (bool) |
| 87 | Tells U-Boot not to expect an attached keyboard with a VGA console. |
| 88 | |
Simon Glass | eee20bf | 2021-09-09 14:10:32 -0600 | [diff] [blame] | 89 | rootdisk-offset (int) |
| 90 | This allows setting the 'rootdisk' environment variable, used to select |
| 91 | the address to load the rootdisk. It is useful for systems that use |
| 92 | U-Boot to flash a device, so the scripts that do this know where to put |
| 93 | the root disk to be flashed. |
| 94 | |
Simon Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 95 | silent-console (int) |
| 96 | If present and non-zero, the console is silenced by default on boot. |
| 97 | |
| 98 | u-boot,spl-payload-offset (int) |
Philipp Tomsich | cbcf3a2 | 2017-04-17 17:45:12 +0200 | [diff] [blame] | 99 | If present (and SPL is controlled by the device-tree), this allows |
| 100 | to override the CONFIG_SYS_SPI_U_BOOT_OFFS setting using a value |
| 101 | from the device-tree. |
Philipp Tomsich | 145638f | 2017-11-28 17:56:11 +0100 | [diff] [blame] | 102 | |
Simon Glass | 1bd4453 | 2021-09-09 14:10:31 -0600 | [diff] [blame] | 103 | sysreset-gpio (string) |
Philipp Tomsich | 145638f | 2017-11-28 17:56:11 +0100 | [diff] [blame] | 104 | If present (and supported by the specific board), indicates a |
| 105 | GPIO that can be set to trigger a system reset. It is assumed |
| 106 | that such a system reset will effect a complete platform reset, |
| 107 | being roughly equivalent to a power-on reset. |