aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <trini@konsulko.com>2021-09-12 20:33:21 -0400
committerTom Rini <trini@konsulko.com>2021-09-12 20:33:21 -0400
commit56a85b831ffe30425645172395c4704caba38bf9 (patch)
tree74b365ee38f3387960d6ba8d15ea855271e8200c /doc
parent78528b3e7ee70c798cb25cac8d1450582fe8606f (diff)
parentaec7c0925c8e9dc8b1475f3dfec6b54573a8ab17 (diff)
downloadu-boot-56a85b831ffe30425645172395c4704caba38bf9.zip
u-boot-56a85b831ffe30425645172395c4704caba38bf9.tar.gz
u-boot-56a85b831ffe30425645172395c4704caba38bf9.tar.bz2
Merge tag 'efi-2021-10-rc4-2' of https://source.denx.de/u-boot/custodians/u-boot-efiWIP/12Sep2021
Pull request for efi-2021-10-rc4-2 Documentation: * improve documentation of U-Boot for /config DT node * integrate bloblist documentation UEFI: * correct usage of EFI_CALL() * code tidy up
Diffstat (limited to 'doc')
-rw-r--r--doc/board/toradex/apalis-imx8.rst (renamed from doc/board/toradex/apalix-imx8.rst)0
-rw-r--r--doc/board/toradex/apalis-imx8x.rst (renamed from doc/board/toradex/apalix-imx8x.rst)0
-rw-r--r--doc/board/toradex/index.rst4
-rw-r--r--doc/develop/bloblist.rst (renamed from doc/README.bloblist)4
-rw-r--r--doc/develop/index.rst1
-rw-r--r--doc/device-tree-bindings/config.txt83
6 files changed, 72 insertions, 20 deletions
diff --git a/doc/board/toradex/apalix-imx8.rst b/doc/board/toradex/apalis-imx8.rst
index 29593fa..29593fa 100644
--- a/doc/board/toradex/apalix-imx8.rst
+++ b/doc/board/toradex/apalis-imx8.rst
diff --git a/doc/board/toradex/apalix-imx8x.rst b/doc/board/toradex/apalis-imx8x.rst
index e62578b..e62578b 100644
--- a/doc/board/toradex/apalix-imx8x.rst
+++ b/doc/board/toradex/apalis-imx8x.rst
diff --git a/doc/board/toradex/index.rst b/doc/board/toradex/index.rst
index abba648..5652848 100644
--- a/doc/board/toradex/index.rst
+++ b/doc/board/toradex/index.rst
@@ -6,8 +6,8 @@ Toradex
.. toctree::
:maxdepth: 2
- apalix-imx8
- apalix-imx8x
+ apalis-imx8
+ apalis-imx8x
colibri_imx7
colibri-imx8x
verdin-imx8mm
diff --git a/doc/README.bloblist b/doc/develop/bloblist.rst
index 274c460..317ebc4 100644
--- a/doc/README.bloblist
+++ b/doc/develop/bloblist.rst
@@ -1,4 +1,4 @@
-# SPDX-License-Identifier: GPL-2.0+
+.. SPDX-License-Identifier: GPL-2.0+
Blob Lists - bloblist
=====================
@@ -39,7 +39,7 @@ Blob tags
Each blob has a tag which is a 32-bit number. This uniquely identifies the
owner of the blob. Blob tags are listed in enum blob_tag_t and are named
-with a BLOBT_ prefix.
+with a `BLOBT_` prefix.
Single structure
diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 83c929b..2a32645 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -9,6 +9,7 @@ Implementation
.. toctree::
:maxdepth: 1
+ bloblist
ci_testing
commands
devicetree/index
diff --git a/doc/device-tree-bindings/config.txt b/doc/device-tree-bindings/config.txt
index 6cdc16d..85379fb 100644
--- a/doc/device-tree-bindings/config.txt
+++ b/doc/device-tree-bindings/config.txt
@@ -5,15 +5,39 @@ 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().
+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.
+
Available options are:
-silent-console
- If present and non-zero, the console is silenced by default on boot.
+bootcmd (string)
+ Allows overwriting of the boot command used by U-Boot on startup. If
+ present, U-Boot uses this command instead. Note that this feature can
+ work even if loading the environment is disabled, e.g. for security
+ reasons. See also bootsecure.
+
+bootdelay (int)
+ This allows selecting of the U-Boot bootdelay, to control whether U-Boot
+ waits on boot or for how long. This allows this option to be configured
+ by the build system or by a previous-stage binary. For example, if the
+ images is being packed for testing or a user holds down a button, it may
+ allow a delay, but disable it for production.
-no-keyboard
- Tells U-Boot not to expect an attached keyboard with a VGA console
+u-boot,boot-led (string)
+u-boot,error-led (string)
+ This is used to specify the label for an LED to indicate an error and
+ a successful boot, on supported hardware.
-u-boot,efi-partition-entries-offset
+bootsecure (int)
+ Indicates that U-Boot should use secure_boot_cmd() to run commands,
+ rather than the normal CLI. This can be used in production images, to
+ restrict the amount of parsing done or the options available, to cut
+ back on the available surface for security attacks.
+
+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 +45,18 @@ 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.
+kernel-offset (int)
+ This allows setting the 'kernaddr' environment variable, used to select
+ the address to load the kernel. It is useful for systems that use U-Boot
+ to flash a device, so the scripts that do this know where to put the
+ kernel to be flashed.
- 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.
+load-environment (int)
+ Allows control over whether U-Boot loads its environment after
+ relocation (0=no, 1 or not present=yes).
-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 +67,38 @@ 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-apm-finalize (bool)
+ For x86 devices running on coreboot, this tells U-Boot not to lock
+ down the Intel Management Engine (ME) registers. This allows U-Boot to
+ access the hardware more fully for platforms that need it.
+
+u-boot,no-keyboard (bool)
+ Tells U-Boot not to expect an attached keyboard with a VGA console.
+
+rootdisk-offset (int)
+ This allows setting the 'rootdisk' environment variable, used to select
+ the address to load the rootdisk. It is useful for systems that use
+ U-Boot to flash a device, so the scripts that do this know where to put
+ the root disk to be flashed.
+
+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,