diff mbox series

[v5,17/28] efi: Mention that efi_info_get() is only used in the stub

Message ID 20211204155657.2913911-14-sjg@chromium.org
State Changes Requested, archived
Delegated to: Heinrich Schuchardt
Headers show
Series efi: Improvements to U-Boot running on top of UEFI | expand

Commit Message

Simon Glass Dec. 4, 2021, 3:56 p.m. UTC
This provides access to EFI tables after U-Boot has exited boot services.
It is not needed in the app since boot services remain alive and we can
just call them whenever needed.

Add a comment to explain this.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

(no changes since v2)

Changes in v2:
- Fix 'as' typo

 include/efi.h | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Heinrich Schuchardt Dec. 9, 2021, 8:20 p.m. UTC | #1
On 12/4/21 07:56, Simon Glass wrote:
> This provides access to EFI tables after U-Boot has exited boot services.
> It is not needed in the app since boot services remain alive and we can
> just call them whenever needed.
>
> Add a comment to explain this.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
> (no changes since v2)
>
> Changes in v2:
> - Fix 'as' typo
>
>   include/efi.h | 4 ++++
>   1 file changed, 4 insertions(+)
>
> diff --git a/include/efi.h b/include/efi.h
> index ed28c204140..69321cc5cc4 100644
> --- a/include/efi.h
> +++ b/include/efi.h
> @@ -578,6 +578,10 @@ void efi_putc(struct efi_priv *priv, const char ch);
>   /**
>    * efi_info_get() - get an entry from an EFI table
>    *
> + * This is called from U-Boot proper to read information set up by the EFI stub.

%s/This/This function/

> + * It can only be used when running from the EFI stuff, not when U-Boot is

'stuff' is very unspecific and colloquial.

Best regards

Heinrich

> + * running as an app.
> + *
>    * @type:	Entry type to search for
>    * @datap:	Returns pointer to entry data
>    * @sizep:	Returns pointer to entry size
>
diff mbox series

Patch

diff --git a/include/efi.h b/include/efi.h
index ed28c204140..69321cc5cc4 100644
--- a/include/efi.h
+++ b/include/efi.h
@@ -578,6 +578,10 @@  void efi_putc(struct efi_priv *priv, const char ch);
 /**
  * efi_info_get() - get an entry from an EFI table
  *
+ * This is called from U-Boot proper to read information set up by the EFI stub.
+ * It can only be used when running from the EFI stuff, not when U-Boot is
+ * running as an app.
+ *
  * @type:	Entry type to search for
  * @datap:	Returns pointer to entry data
  * @sizep:	Returns pointer to entry size