diff options
| author | Simon Glass <[email protected]> | 2024-07-17 09:30:58 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <[email protected]> | 2024-07-19 13:57:44 +0200 |
| commit | 95403023cfa890b4e5e7ce7040227e518b2da288 (patch) | |
| tree | d5ef280000354a8143ce6ce43b30d88580a1319a /doc | |
| parent | 56418511e9fd5ca34c38c896a364ea0249c53610 (diff) | |
doc: Add a description for bootmeth_sandbox
Add documentation for the sandbox bootmeth.
Fix up the compatible string to drop the 'extlinux' part, which is not
relevant to this bootmeth.
Signed-off-by: Simon Glass <[email protected]>
Reviewed-by: Quentin Schulz <[email protected]>
Reviewed-by: Mattijs Korpershoek <[email protected]>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/develop/bootstd/index.rst | 1 | ||||
| -rw-r--r-- | doc/develop/bootstd/overview.rst | 1 | ||||
| -rw-r--r-- | doc/develop/bootstd/sandbox.rst | 17 |
3 files changed, 19 insertions, 0 deletions
diff --git a/doc/develop/bootstd/index.rst b/doc/develop/bootstd/index.rst index 69fd3c2d2eb..2c5d2d3fade 100644 --- a/doc/develop/bootstd/index.rst +++ b/doc/develop/bootstd/index.rst @@ -11,3 +11,4 @@ Standard Boot pxelinux qfw cros + sandbox diff --git a/doc/develop/bootstd/overview.rst b/doc/develop/bootstd/overview.rst index de15fa41a1d..20c5d56aad2 100644 --- a/doc/develop/bootstd/overview.rst +++ b/doc/develop/bootstd/overview.rst @@ -425,6 +425,7 @@ Bootmeth drivers are provided for booting from various media: - EFI boot using boot manager - Android bootflow (boot image v4) - :doc:`QFW <qfw>`: QEMU firmware interface + - :doc:`sandbox <sandbox>` used only for testing Each driver is controlled by a Kconfig option. If no bootmeth driver is selected by a compatible string in the devicetree, all available bootmeth diff --git a/doc/develop/bootstd/sandbox.rst b/doc/develop/bootstd/sandbox.rst new file mode 100644 index 00000000000..d501518c39a --- /dev/null +++ b/doc/develop/bootstd/sandbox.rst @@ -0,0 +1,17 @@ +.. SPDX-License-Identifier: GPL-2.0+: + +Sandbox Bootmeth +================ + +The sandbox bootmeth is only used for testing. It does not provide any facility +for booting an OS. While sandbox can do all the processing before the actual +boot, it is not connected in this bootmeth. + +When invoked on a bootdev, this bootmeth pretends to find a bootflow and creates +the associated structure. + +When the bootflow is booted, the bootmeth returns `-ENOTSUPP` indicating that it +is not supported. + +The compatible string "u-boot,sandbox-bootmeth" is used for the driver. It is present +if `CONFIG_BOOTMETH_SANDBOX` is enabled. |