[PATCH v2 08/14] doc: Add a description for bootmeth_sandbox
Mattijs Korpershoek
mkorpershoek at baylibre.com
Tue Jul 16 09:41:51 CEST 2024
Hi Simon,
Thank you for the patch.
On mar., juil. 16, 2024 at 08:04, Simon Glass <sjg at chromium.org> wrote:
> 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 at chromium.org>
> Reviewed-by: Quentin Schulz <quentin.schulz at cherry.de>
Reviewed-by: Mattijs Korpershoek <mkorpershoek at baylibre.com>
> ---
>
> Changes in v2:
> - Adjustments from Heinrich's comments
>
> boot/bootmeth_sandbox.c | 2 +-
> doc/develop/bootstd/index.rst | 1 +
> doc/develop/bootstd/overview.rst | 1 +
> doc/develop/bootstd/sandbox.rst | 17 +++++++++++++++++
> 4 files changed, 20 insertions(+), 1 deletion(-)
> create mode 100644 doc/develop/bootstd/sandbox.rst
>
> diff --git a/boot/bootmeth_sandbox.c b/boot/bootmeth_sandbox.c
> index 0bc8f688e30..26c713bb5f3 100644
> --- a/boot/bootmeth_sandbox.c
> +++ b/boot/bootmeth_sandbox.c
> @@ -55,7 +55,7 @@ static struct bootmeth_ops sandbox_bootmeth_ops = {
> };
>
> static const struct udevice_id sandbox_bootmeth_ids[] = {
> - { .compatible = "u-boot,sandbox-extlinux" },
> + { .compatible = "u-boot,sandbox-bootmeth" },
> { }
> };
>
> 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 9b50b5593c4..add054f3088 100644
> --- a/doc/develop/bootstd/overview.rst
> +++ b/doc/develop/bootstd/overview.rst
> @@ -420,6 +420,7 @@ Bootmeth drivers are provided for booting from various media:
> - :doc:`ChromiumOS <cros>` ChromiumOS boot from a disk
> - EFI boot using boot manager
> - :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..a90c1accc84
> --- /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 -EENOTSUPP 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.
> --
> 2.34.1
More information about the U-Boot
mailing list