u-boot/doc/develop/bootstd/sandbox.rst
Simon Glass 95403023cf 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 <sjg@chromium.org>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
2024-07-19 13:57:44 +02:00

17 lines
611 B
ReStructuredText

.. 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.