]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
doc: Tidy up the bindings for the config/ node
authorSimon Glass <sjg@chromium.org>
Thu, 9 Sep 2021 20:10:31 +0000 (14:10 -0600)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Sat, 11 Sep 2021 09:02:02 +0000 (11:02 +0200)
Sort these and add a type so it is clear how to set the value. Add a note
about usage to the top. Correct the 'no-keyboard' binding which is missing
a prefix.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
doc/device-tree-bindings/config.txt

index 6cdc16da5b51ee3cc8f2bcf873543227b4098921..f704eb695f5a4852ec8da8dc74f35390227b10a4 100644 (file)
@@ -5,15 +5,15 @@ A number of run-time configuration options are provided in the /config node
 of the control device tree. You can access these using fdtdec_get_config_int(),
 fdtdec_get_config_bool() and fdtdec_get_config_string().
 
-Available options are:
-
-silent-console
-       If present and non-zero, the console is silenced by default on boot.
+These options are designed to affect the operation of U-Boot at runtime.
+Runtime-configuration items can help avoid proliferation of different builds
+with only minor changes, e.g. enabling and disabling console output. Items
+here should be those that can usefully be set by the build system after U-Boot
+is built.
 
-no-keyboard
-       Tells U-Boot not to expect an attached keyboard with a VGA console
+Available options are:
 
-u-boot,efi-partition-entries-offset
+u-boot,efi-partition-entries-offset (int)
        If present, this provides an offset (in bytes, from the start of a
        device) that should be skipped over before the partition entries.
        This is used by the EFI/GPT partition implementation when a device
@@ -21,17 +21,8 @@ u-boot,efi-partition-entries-offset
 
        This setting will override any values configured via Kconfig.
 
-u-boot,mmc-env-partition
-       if present, the environment shall be placed at the last
-       CONFIG_ENV_SIZE blocks of the partition on the
-       CONFIG_SYS_MMC_ENV_DEV.
-
-       if u-boot,mmc-env-offset* is present, this setting will take
-       precedence. In that case, only if the partition is not found,
-       mmc-env-offset* will be tried.
-
-u-boot,mmc-env-offset
-u-boot,mmc-env-offset-redundant
+u-boot,mmc-env-offset (int)
+u-boot,mmc-env-offset-redundant (int)
        If present, the values of the 'u-boot,mmc-env-offset' and/or
        of the u-boot,mmc-env-offset-redundant' properties overrides
        CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND, respectively,
@@ -42,12 +33,27 @@ u-boot,mmc-env-offset-redundant
        will point at the beginning of a LBA and values that are not
        LBA-aligned will be rounded up to the next LBA address.
 
-u-boot,spl-payload-offset
+u-boot,mmc-env-partition (int)
+       if present, the environment shall be placed at the last
+       CONFIG_ENV_SIZE blocks of the partition on the
+       CONFIG_SYS_MMC_ENV_DEV.
+
+       if u-boot,mmc-env-offset* is present, this setting will take
+       precedence. In that case, only if the partition is not found,
+       mmc-env-offset* will be tried.
+
+u-boot,no-keyboard (bool)
+       Tells U-Boot not to expect an attached keyboard with a VGA console.
+
+silent-console (int)
+       If present and non-zero, the console is silenced by default on boot.
+
+u-boot,spl-payload-offset (int)
        If present (and SPL is controlled by the device-tree), this allows
        to override the CONFIG_SYS_SPI_U_BOOT_OFFS setting using a value
        from the device-tree.
 
-sysreset-gpio
+sysreset-gpio (string)
        If present (and supported by the specific board), indicates a
        GPIO that can be set to trigger a system reset.  It is assumed
        that such a system reset will effect a complete platform reset,