[Concept,18/18] efi: doc: Add documentation for efidebug command in the app
Commit Message
From: Simon Glass <sjg@chromium.org>
Mention the efidebug command specifically the EFI-app documentaion, to
highlight its usefulness.
Signed-off-by: Simon Glass <sjg@chromium.org>
---
doc/develop/uefi/u-boot_on_efi.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
Comments
On 20.08.25 02:40, Simon Glass wrote:
> From: Simon Glass <sjg@chromium.org>
>
> Mention the efidebug command specifically the EFI-app documentaion, to
> highlight its usefulness.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
> doc/develop/uefi/u-boot_on_efi.rst | 21 +++++++++++++++++++++
> 1 file changed, 21 insertions(+)
>
> diff --git a/doc/develop/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst
> index d20d5b00ec6..387ace48f5b 100644
> --- a/doc/develop/uefi/u-boot_on_efi.rst
> +++ b/doc/develop/uefi/u-boot_on_efi.rst
> @@ -143,6 +143,27 @@ enough) should be straightforward.
>
> Use the 'reset' command to get back to EFI.
>
> +EFI Debugging Commands
> +~~~~~~~~~~~~~~~~~~~~~~
> +When running as an EFI application, U-Boot provides access to the 'efidebug'
> +command, which offers a subset of functionality useful for debugging and
> +inspecting the UEFI environment. This command allows you to:
> +
> +* Display memory maps with 'efidebug memmap'
> +* Show EFI system tables with 'efidebug show tables'
Displaying handles and installed protocols via 'dh' is mentionable.
> +* Manage boot options with 'efidebug boot' subcommands:
> +
> + - dump - Display current boot options
> + - add - Add new boot options
> + - rm - Remove boot options
> + - order - Display boot order
'order' also allows to modify the boot order.
Why wouldn't you use either of
* the underlying UEFI firmware's boot option management
* the eficonfig command
for managing boot options?
Best regards
Heinrich
> +
> +This command uses the EFI system table and runtime services to provide this
> +functionality, so it can help with understanding and debugging UEFI
> +environments.
> +
> +See the :doc:`/usage/cmd/efidebug` for more information.
> +
> EFI Payload
> ~~~~~~~~~~~
> The payload approach is a different kettle of fish. It works by building
@@ -143,6 +143,27 @@ enough) should be straightforward.
Use the 'reset' command to get back to EFI.
+EFI Debugging Commands
+~~~~~~~~~~~~~~~~~~~~~~
+When running as an EFI application, U-Boot provides access to the 'efidebug'
+command, which offers a subset of functionality useful for debugging and
+inspecting the UEFI environment. This command allows you to:
+
+* Display memory maps with 'efidebug memmap'
+* Show EFI system tables with 'efidebug show tables'
+* Manage boot options with 'efidebug boot' subcommands:
+
+ - dump - Display current boot options
+ - add - Add new boot options
+ - rm - Remove boot options
+ - order - Display boot order
+
+This command uses the EFI system table and runtime services to provide this
+functionality, so it can help with understanding and debugging UEFI
+environments.
+
+See the :doc:`/usage/cmd/efidebug` for more information.
+
EFI Payload
~~~~~~~~~~~
The payload approach is a different kettle of fish. It works by building